Наши партнеры

Библиотека сайта rus-linux.net

Начинаем работать с Inotify

Оригинал: Getting Started with Inotify
Автор: Amit Saha
Дата публикации: 1 Апреля 2011 г.
Перевод: А.Панин
Дата перевода: 9 октября 2012 г.

Inotify является функцией ядра Linux, предоставляющей интерфейс для отслеживания изменений файловой системы пользовательским приложениям. Эта статья демонстрирует примеры использования API Inotify для отслеживания интересующих событий и выполнения различных действий при наступлении этих событий.

Изменения файловой системы, которые можно отследить при помощи Inotify включают в себя создание, удаление или изменение директорий и файлов. Для того, чтобы начать использовать API Inotify в своих программах на языке C, вам необходимо подключить заголовочный файл sys/inotify.h.

Наблюдения (Watches)

Наблюдение лежит в основе Inotify. Вы можете использовать наблюдение для указания директории или файла, а также событий, за которыми вы хотите следить. Например, функция создания наблюдения inotify_add_watch(fd, root, IN_CREATE | IN_MODIFY | IN_DELETE) позволяет указать, что вы хотите следить за директорией, заданной переменной root, наблюдая за событиями создания, изменения и удаления файлов и директорий внутри нее, что можно понять по маске событий IN_CREATE | IN_MODIFY | IN_DELETE. Значения констант для задания маски событий находятся в в файле linux/inotify.h.

Приведенная выше функция возвращает целочисленное значение, являющееся уникальным идентификатором наблюдения, или -1 в случае ошибки. Аргумент fd является файловым дескриптором, связанным с конкретным наблюдением. Наблюдение идентифицируется при помощи пути, поэтому если вам необходимо создать другое наблюдение с таким же путем, необходимо вызвать inotify_add_watch() с тем же путем, но с другой маской событий.

Простая демонстрационная программа

Данная демонстрационная программа на языке C позволяет следить за созданием, изменением и удалением файлов и директорий внутри заданной директории:

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/inotify.h>
#include <limits.h>

#define MAX_EVENTS 1024 /*Максимальное кличество событий для обработки за один раз*/
#define LEN_NAME 16 /*Будем считать, что длина имени файла не превышает 16 символов*/
#define EVENT_SIZE  ( sizeof (struct inotify_event) ) /*размер структуры события*/
#define BUF_LEN     ( MAX_EVENTS * ( EVENT_SIZE + LEN_NAME )) /*буфер для хранения данных о событиях*/

int main( int argc, char **argv ) 
{
	int length, i = 0, wd;
	int fd;
	char buffer[BUF_LEN];

/* Инициализация Inotify*/
	fd = inotify_init();
	if ( fd < 0 ) {
		perror( "Couldn't initialize inotify");
	}

/* добавим наблюдение для директории, заданной первым параметром командной строки */
	wd = inotify_add_watch(fd, argv[1], IN_CREATE | IN_MODIFY | IN_DELETE);

if (wd == -1)
	{
		printf("Couldn't add watch to %s\n",argv[1]);
	}
	else
	{
		printf("Watching:: %s\n",argv[1]);
	}

/* бесконечный цикл*/
	while(1)
	{
		i = 0;
		length = read( fd, buffer, BUF_LEN );

if ( length < 0 ) {
			perror( "read" );
		}

while ( i < length ) {
		struct inotify_event *event = ( struct inotify_event * ) &buffer[ i ];
		if ( event->len ) {
			if ( event->mask & IN_CREATE) {
				if (event->mask & IN_ISDIR)
					printf( "The directory %s was Created.\n", event->name );       
				else
					printf( "The file %s was Created with WD %d\n", event->name, event->wd );       
			}

if ( event->mask & IN_MODIFY) {
				if (event->mask & IN_ISDIR)
					printf( "The directory %s was modified.\n", event->name );       
				else
					printf( "The file %s was modified with WD %d\n", event->name, event->wd );       
			}
          
			if ( event->mask & IN_DELETE) {
				if (event->mask & IN_ISDIR)
					printf( "The directory %s was deleted.\n", event->name );       
				else
					printf( "The file %s was deleted with WD %d\n", event->name, event->wd );       
			}

i += EVENT_SIZE + event->len;
			}
		}
	}

/* Освобождение ресурсов*/
inotify_rm_watch( fd, wd );
close( fd );

return 0;
}

Ниже показан пример вывода после компиляции программы и ее запуска:

$ gcc listing1.c
$ ./a,.out /home/gene/
Watching:: /home/gene/ 
.
.
The file .xsession-errors was modified with WD 1 
The file .xsession-errors was modified with WD 1 
The file .xsession-errors was modified with WD 1 
The directory foobar was Created.

Первым шагом при использовании Inotify должна быть инициализация этой системы при помощи функции inotify_init(), возвращающей файловый дескрипор, который может быть использован для добавления наблюдений и чтения данных событий впоследствии в приложении.

Данные событий возвращаются в виде структуры struct inotify_event (определенной в файле linux/inotify.h), которую можно получить при помощи системного вызова read().

Наконец, наблюдение удаляется и ресурсы, связанные с Inotify, освобождается при помощи вызовов функций inotify_rm_watch () и close() соответственно.

Наблюдение за поддиректориями

К сожалению, не существует метода для указания того, что вы хотите наблюдать за изменениями во всех поддиректориях заданной директории. Следовательно, для решения этой задачи необходимо обойти все поддиректории и создать наблюдения для каждой из них.

Следующая программа на языке C выполняет указанные действия, обходя только поддиректории заданной директории при помощи функций из заголовочного файла dirent.h и добавляет по наблюдению для каждой из них. Впоследствии, вместо того, чтобы выводить сообщения напрямую в стандартный вывод программы stdout, сообщения записываются в файл журнала с именем inotify_logger.log.

/* Inotify используется для наблюдения за поддиректориями выбранной директории*/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/inotify.h>
#include <dirent.h>
#include <limits.h>

#define MAX_LEN 1024 /*длина пути для директории*/
#define MAX_EVENTS 1024 /*максимальное количество событий для обработки за один раз*/
#define LEN_NAME 16 /*предположим, что длина имени файла не превышает 16 байт*/
#define EVENT_SIZE  ( sizeof (struct inotify_event) ) /*размер структуры события*/
#define BUF_LEN     ( MAX_EVENTS * ( EVENT_SIZE + LEN_NAME )) /*буфер для хранения данных события*/

/* Файл журнала*/
FILE *fp_log;

/* Добавим наблюдения inotify для поддиректорий сразу после добавления корневой директории */

void add_watches(int fd, char *root)
{
	int wd;
	char *abs_dir;
	struct dirent *entry;
	DIR *dp;

dp = opendir(root);
	if (dp == NULL)
	{
		perror("Error opening the starting directory");
		exit(0);
	}

/* добавление наблюдения для корневой директории */
	wd = inotify_add_watch(fd, root, IN_CREATE | IN_MODIFY | IN_DELETE); 
	if (wd == -1)
	{
		fprintf(fp_log,"Couldn't add watch to %s\n",root);
	}
	else
	{
		printf("Watching:: %s\n",root);
	}

/* добавление наблюдений для поддиректорий первого уровня*/
	abs_dir = (char *)malloc(MAX_LEN);
	while((entry = readdir(dp)))
	{ 
		/* if its a directory, add a watch*/
		if (entry->d_type == DT_DIR)
		{
			strcpy(abs_dir,root);
			strcat(abs_dir,entry->d_name);

wd = inotify_add_watch(fd, abs_dir, IN_CREATE | IN_MODIFY | IN_DELETE); 
			if (wd == -1)
				printf("Couldn't add watch to the directory %s\n",abs_dir);
			else
				printf("Watching:: %s\n",abs_dir);
		}
	}
  
	closedir(dp);
	free(abs_dir);
}

/* Функция main*/
int main( int argc, char **argv ) 
{
	int length, i = 0;
	int fd;
	char buffer[BUF_LEN], root[MAX_LEN];

/*Проверка наличия параметра командной строки*/
	switch(argc)
	{
		case 1: printf("No directory specified. Will monitor the entire filesystem...\n\n");
			strcpy(root,"/");
			break;

case 2: strcpy(root,argv[1]);
			if(root[strlen(root)-1]!='/')
				strcat(root,"/");
			puts(root);

break;
 
		default: printf("Ignoring all other arguments after the first\n");
	}

/* Открытие файла журнала*/
	fp_log = fopen("inotify_logger.log","a");
	if (fp_log == NULL)
	{
		printf("Error opening logger. All output will be redirected to the stdout\n");
		fp_log = stdout;
	}

fd = inotify_init();
	if ( fd < 0 ) {
		perror( "Couldn't initialize inotify");
	}

/* обход поддиректорий первого уровня и добавление наблюдений */
	add_watches(fd,root);

/* бесконечный цикл*/
	while(1)
	{
		i = 0;
		length = read( fd, buffer, BUF_LEN );

if ( length < 0 ) {
			perror( "read" );
		}

/* чтентие событий*/
		while ( i < length ) {
			struct inotify_event *event = ( struct inotify_event * ) &buffer[ i ];
			if ( event->len ) {
				if ( event->mask & IN_CREATE) {
					if (event->mask & IN_ISDIR)
						fprintf(fp_log,"%d DIR::%s CREATED\n", event->wd,event->name );
					else
						fprintf(fp_log, "%d FILE::%s CREATED\n", event->wd, event->name);
				}

if ( event->mask & IN_MODIFY) {
					if (event->mask & IN_ISDIR)
						fprintf(fp_log,"%d DIR::%s MODIFIED\n", event->wd,event->name );
					else
						fprintf(fp_log,"%d FILE::%s MODIFIED\n", event->wd,event->name );

}
          
				if ( event->mask & IN_DELETE) {
					if (event->mask & IN_ISDIR)
						fprintf(fp_log,"%d DIR::%s DELETED\n", event->wd,event->name );       
					else
						fprintf(fp_log,"%d FILE::%s DELETED\n", event->wd,event->name );       
				}

i += EVENT_SIZE + event->len;
			}
		}
	}
	/* освобождение ресурсов*/
	( void ) close( fd );
  
	return 0;
}

Автоматическая компиляция файлов

Теперь, когда вы имеете представление о том, как использовать Inotify в приложениях, которым требуется контролировать изменения файловой системы, давайте займемся интересным и, возможно, очень полезным делом. Используя Inotify, будем следить за изменениями директории, и в том случае, если файл исходного кода создается или изменяется, будем вызывать gcc для компиляции файла и перемещения программы в отдельную директорию /bin внутри нашей директории. Исходный код программы, который мы сохраним в файле auto_compile.c, представлен ниже:

/* auto_compile.c*/

/* Автоматическая компиляция файлов исходного кода C с использованием Inotify
 * Предположения:
 * argv[1]: директория для файлов с исходным кодом
 * bin/ поддиректория: в которой будут находиться скомпилированные программы
 * 
*/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/inotify.h>
#include <limits.h>

#define MAX_EVENTS 1024 /*максимальное количество событий, обрабатываемое за один раз*/
#define LEN_NAME 16 /*Предположение, что длина имени файла не превышает 16 байт*/
#define EVENT_SIZE  ( sizeof (struct inotify_event) ) /*размер структуры события*/
#define BUF_LEN     ( MAX_EVENTS * ( EVENT_SIZE + LEN_NAME )) /*буфер для хранения данных событий*/

int main( int argc, char **argv ) 
{
	int length, i = 0, wd;
	int fd;
	char buffer[BUF_LEN],cur_dir[BUF_LEN];

char command[100],copy_cmd[100];
	strcpy(command,"gcc -o ");

/* Инициализация Inotify*/
	fd = inotify_init();
	if ( fd < 0 ) {
		perror( "Couldn't initialize inotify");
	}

/* добавление наблюдения за директорией */
	wd = inotify_add_watch(fd, argv[1], IN_CREATE | IN_MODIFY);

if (wd == -1)
	{
		printf("Couldn't add watch to %s\n",argv[1]);
	}
	else
	{
		printf("Watching:: %s\n",argv[1]);
	}

/* бесконечный цикл*/
	while(1)
	{
		i = 0;
		length = read( fd, buffer, BUF_LEN );

if ( length < 0 ) {
			perror( "read" );
		}

while ( i < length ) {
			struct inotify_event *event = ( struct inotify_event * ) &buffer[ i ];
			if ( event->len ) {
				if ( event->mask & IN_CREATE) {
					if (event->mask & IN_ISDIR)
						printf( "The directory %s was Created.\n", event->name );       
					else
					{
						printf( "Compiling::  %s \n", event->name);

/*сохранение рабочей директории*/
						getcwd(cur_dir,BUF_LEN);
						chdir(argv[1]);

/* формирование строки команды для gcc*/
						strcat(command,"bin/"); 
						strcat(command,event->name);
						strcat(command,".out ");
						strcat(command,event->name);

/* запуск gcc*/
						system(command);

/*возвращение рабочей директории*/
						chdir(cur_dir);
						strcpy(command,"gcc -o ");
					}
                
				}
          
				if ( event->mask & IN_MODIFY) {
					if (event->mask & IN_ISDIR)
						printf( "The directory %s was modified.\n", event->name );       
					else
					{
						printf( "Compiling:: %s \n", event->name);

/*сохранение рабочей директории*/
						getcwd(cur_dir,BUF_LEN);
						chdir(argv[1]);

/* формирование строки команды для gcc*/
						strcat(command,"bin/");
						strcat(command,event->name);
						strcat(command,".out ");
						strcat(command,event->name);

/* запуск gcc*/
						system(command);

/*возвращение рабочей директории*/
						chdir(cur_dir);
						strcpy(command,"gcc -o ");
					}

}       
				 i += EVENT_SIZE + event->len;
			}
		}
	}

/* Освобождение ресурсов*/
	inotify_rm_watch( fd, wd );
	close( fd );

return 0;
}

Ниже приведен вывод при компиляции и запуске этой программы на языке C:

$ gcc auto_compile.c 
$ ./a.out /home/gene/codes/ 
Watching:: /home/gene/codes/ 
Compiling:: hello1.c 
Compiling:: hello2.c

Конечно же, вы можете легко изменить программу для компиляции и выполнения программ на других языках программирования.

Inotify-tools

Inotify-tools - это библиотека на языке C и набор программ с интерфейсом командной строки, предоставляющих доступ к функциям системы Inotify. Одним из наиболее полезных инструментов данного пакета является программа inotifywatch, которая может использоваться для наблюдения за изменениями директории и обладает большим набором функций, чем наша вторая программа.

dnotify, inotify и fanotify

Технология inotify, впервые представленная в ядре версии 2.6.36, заменила собой технологии dnotify и fanotify за короткий промежуток времени. Обратитесь к статье в LWN, чтобы узнать подробнее об этих технологиях.

Если вы посмотрите исходные коды ядра в поддиректории fs/notify, вы можете обнаружить реализации всех трех технологий, гармонично сосуществующих друг с другом.

В данной статье мы кратко рассмотрели очень полезную функцию ядра Linux, доступную в пространстве пользователя. Хотя идея данной функции не нова (используется с 2005 года), теперь вы знаете, как разрабатывать приложения, которые выполняют действия в зависимости от изменений файловой системы. Если вы используете язык программирования, отличный от C, помните о существовании API для C++, Java, Python, Ruby и даже модуля для node.js! Несколько советов по разработке программ на базе рассмотренных функций:

Расширьте функции программы auto_compile.c до плагина файлового менеджера, такого как Nautilus, чтобы при создании или изменении файлов исходного кода в заданной директории, происходила компиляция.
Программы, работающие с Inotify, будут наиболее удобны в том случае, если они будут реализованы в виде служб, работающих как фоновые процессы без вмешательства пользователя. Следовательно, цикл while(1) может быть реализован лучшим образом как функция пробуждения, в остальное время процесс будет находиться в спящем состоянии.