| FANOTIFY(7) | Руководство программиста Linux | FANOTIFY(7) |
fanotify - отслеживание событий в файловой системе
Программный интерфейс fanotify уведомляет о событиях в файловой системе и перехватывает их. Например, его можно использовать для сканирования файлов на вирусы и управления иерархическим хранилищем. В настоящее время, поддерживается только ограниченный набор событий. В частности, не поддерживаются события создания, удаления и перемещения (о программном интерфейсе для этих событий смотрите в inotify(7)).
Дополнительные возможности по сравнению с программным интерфейсом inotify(7): способность отслеживать все объекты в смонтированной файловой системе, давать права на доступ и читать или изменять файлы перед тем как доступ получат другие приложения.
В программный интерфейс входят следующие системные вызовы: fanotify_init(2), fanotify_mark(2), read(2), write(2) и close(2).
Системный вызов fanotify_init(2) создаёт и инициализирует группу уведомления fanotify и возвращает указывающий на неё файловый дескриптор.
Группа уведомления fanotify — это внутренний объект ядра, в котором хранится список файлов, каталогов, файловых систем и точек монтирования, для которых должны создаваться события.
У каждой записи в группе уведомления fanotify есть две битовые маски: меток и игнорирования. В маске меток указывается для каких действий на файлами должны создаваться события. В маске игнорирования указывается для каких действий не должны создаваться события. Имея маски таких типов можно пометить файловую систему, точку монтирования или каталог для получения событий, и в тоже время игнорировать события для определённых объектов в этой точке монтирования или каталоге.
Системный вызов fanotify_mark(2) добавляет файл, каталог, файловую систему или точку монтирования в группу уведомления и задаёт какие события должны отслеживаться (или игнорироваться), или удаляет или изменяет нужную запись.
Возможное применение маски игнорирования — кэш файлов. Интересующие события для файлового кэша — изменение файла и закрытие. Для этого добавляем кэшируемый каталог или точку монтирования для приёма этих событий. После получения первого события об изменении файла, соответствующая запись кэша помечается как недействительная. Дальнейшие события об изменении файла нас не интересуют, пока файл не будет закрыт. Для этого событие об изменении можно добавить в маску игнорирования. При получении события о закрытии, событие об изменении можно удалить из маски игнорирования и запись файлового кэша можно обновить.
Записи в группе уведомления fanotify ссылаются на файл и каталог по номеру иноды (inode), а на точку монтирования — через ID монтирования. При переименовании или перемещении файла или каталога внутри той же точки монтирования соответствующая запись остаётся. Если файл или каталог удаляется или перемещается в другую точку монтирования, или если файловая система или точка монтирования размонтируется, то соответствующая запись удаляется.
Для возникающих событий с объектами файловой системы, которые отслеживаются группой уведомления, система fanotify генерирует события и помещает их в очередь. После этого события можно прочитать (с помощью read(2) и подобных) из файлового дескриптора fanotify, возвращённого fanotify_init(2).
Генерируется два типа событий: события уведомления и события доступа. Уведомляющие события просто информируют и не требуют действия от принявшего приложения, за исключением закрытия файлового дескриптора, передаваемого в событии (смотрите далее). События доступа запрашивают получившее приложение о разрешении доступа к файлу. Для этих событий получатель должен написать ответ, давать ли доступ или нет.
Событие удаляется из очереди событий группы fanotify после прочтения. События доступа, которые были прочитаны, остаются во внутреннем списке группы fanotify до тех пор, пока решение о доступе не будет записано в файловый дескриптор fanotify, или файловый дескриптор fanotify не будет закрыт.
Вызов read(2) с файловым дескриптором, полученным от fanotify_init(2), блокирует выполнение (если не указан флаг FAN_NONBLOCK в вызове fanotify_init(2)) до тех пор, пока не произойдёт файловое событие или вызов не будет прерван сигналом (смотрите signal(7)).
После успешного выполнения read(2) буфер чтения содержит одну или более следующих структур:
struct fanotify_event_metadata {
__u32 event_len;
__u8 vers;
__u8 reserved;
__u16 metadata_len;
__aligned_u64 mask;
__s32 fd;
__s32 pid;
};
Для увеличения производительности рекомендуется использовать буфер большого размера (например, 4096 байт) для того, чтобы получить несколько событий за один вызов read(2).
Возвращаемое read(2) значение — количество байт помещённых в буфер, или -1 в случае ошибки (но смотрите ДЕФЕКТЫ).
Поля структуры fanotify_event_metadata:
Программа, слушающая события fanotify, может сравнить этот PID с PID, возвращаемым getpid(2), для проверки, что событие не возникло из-за самого слушающего, а из-за доступа к файлу другого процесса.
В битовой маске mask указывают события, произошедшие с одиночным объектом файловой системы. В маске может быть установлено несколько бит, если было более одного события с отслеживаемым объектом файловой системы. В частности, возникшие друг за другом события с одним объектом файловой системы и произошедшие из-за одного процесса могут быть объединены в одно событие, за исключением того, что два события доступа никогда не объединяются в одном элементе очереди.
Биты маски mask:
Для проверки любого события закрытия может использоваться следующая битовая маска:
Следующие макросы позволяют обходить буфер с метаданными событий fanotify, возвращаемый read(2) из файлового дескриптора fanotify:
Дополнительно есть:
Когда возникает событие fanotify файловый дескриптор fanotify помечается как доступный для чтения при его передаче в epoll(7), poll(2) или select(2).
Для событий доступа приложение должно записать (write(2)) в файловый дескриптор fanotify следующую структуру:
struct fanotify_response {
__s32 fd;
__u32 response;
};
Поля этой структуры имеют следующее назначение:
Если доступ запрещается, то запрашивающее приложение получит ошибку EPERM.
Когда все файловые дескрипторы, указывающие на группу уведомления fanotify, закрыты, группа fanotify освобождается и её ресурсы становятся доступны ядру для повторного использования. После close(2) все оставшиеся непросмотренные события доступа будут разрешены.
Файл /proc/[pid]/fdinfo/[fd] содержит информацию о метках fanotify для файлового дескриптора fd процесса pid Подробности смотрите в proc(5).
Кроме обычных ошибок read(2) при чтении из файлового дескриптора fanotify могут возникать следующие ошибки:
Кроме обычных ошибок write(2) при записи в файловый дескриптор fanotify могут возникать следующие ошибки:
Программный интерфейс fanotify представлен в версии 2.6.36 ядра Linux и включён в версии 2.6.37. Поддержка fdinfo была добавлена в версии 3.8.
Программный интерфейс fanotify есть только в Linux.
Программный интерфейс fanotify доступен только, если ядро собрано с включённым параметром настройки CONFIG_FANOTIFY. Также, работа с доступом в fanotify доступна только, если включён параметр настройки CONFIG_FANOTIFY_ACCESS_PERMISSIONS.
Fanotify сообщает только о событиях, которые возникли при использовании пользовательскими программами программного интерфейса файловой системы. Поэтому события об обращении к файлам в сетевых файловых системах не отлавливаются.
Программный интерфейс fanotify не сообщает о доступе и изменениях, которые могут произойти из-за mmap(2), msync(2) и munmap(2).
События для каталогов создаются только, если сам каталог открывается, читается и закрывается. Добавление, удаление и изменение потомков отслеживаемого каталога не приводит к возникновению событий.
Fanotify не следит за каталогами рекурсивно: чтобы следить за подкаталогами каталога, нужно их явно пометить (и, заметим, что программный интерфейс fanotify не позволяет отслеживать создание подкаталога, что затрудняет рекурсивное слежение). Отслеживание точек монтирования позволяет следить за всем деревом каталогов. Отслеживание файловых систем позволяет следить за изменениями, сделанными в любом смонтированном экземпляре файловой системы.
Очередь событий может переполниться. В этом случае события теряются.
До Linux 3.19, fallocate(2) не генерировал событий fanotify. Начиная с Linux 3.19, вызовы fallocate(2) генерируют событие FAN_MODIFY.
В Linux 3.17 существуют следующие дефекты:
Следующая программа демонстрирует использование программного интерфейса fanotify. Она следит за точкой монтирования, переданной в аргументе командной строки, и ждёт событий с типом FAN_OPEN_PERM и FAN_CLOSE_WRITE. При возникновении событий доступа выдаёт ответ FAN_ALLOW.
Следующий вывод записан при редактировании файла /home/user/temp/notes. Перед открытием файла произошло событие FAN_OPEN_PERM. После закрытия файла произошло событие FAN_CLOSE_WRITE. Выполнение программы закончилось после нажатия пользователем клавиши ENTER.
# ./fanotify_example /home Нажмите enter для завершения работы. Ожидание событий. FAN_OPEN_PERM: файл /home/user/temp/notes FAN_CLOSE_WRITE: файл /home/user/temp/notes Ожидание событий прекращено.
#define _GNU_SOURCE /* требуется для получения O_LARGEFILE */
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <poll.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/fanotify.h>
#include <unistd.h>
/* читаем все доступные события fanotify из файлового дескриптора «fd» */
static void
handle_events(int fd)
{
const struct fanotify_event_metadata *metadata;
struct fanotify_event_metadata buf[200];
ssize_t len;
char path[PATH_MAX];
ssize_t path_len;
char procfd_path[PATH_MAX];
struct fanotify_response response;
/* проходим по всем событиям, которые можем прочитать
из файлового дескриптора fanotify */
for(;;) {
/* читаем несколько событий */
len = read(fd, (void *) &buf, sizeof(buf));
if (len == -1 && errno != EAGAIN) {
perror("read");
exit(EXIT_FAILURE);
}
/* проверяем, достигнут ли конец доступных данных */
if (len <= 0)
break;
/* выбираем первое событие в буфере */
metadata = buf;
/* проходим по всем событиям в буфере */
while (FAN_EVENT_OK(metadata, len)) {
/* проверяем, что структуры, использовавшиеся при сборке,
идентичны структурам при выполнении */
if (metadata->vers != FANOTIFY_METADATA_VERSION) {
fprintf(stderr,
"Версия метаданных fanotify не совпадает.\n");
exit(EXIT_FAILURE);
}
/* metadata->fd содержит или FAN_NOFD, указывающее
на переполнение очереди, или файловый дескриптор
(неотрицательное целое). Здесь мы просто игнорируем
переполнение очереди. */
if (metadata->fd >= 0) {
/* обрабатываем событие на право открытия */
if (metadata->mask & FAN_OPEN_PERM) {
printf("FAN_OPEN_PERM: ");
/* разрешаем открыть файл */
response.fd = metadata->fd;
response.response = FAN_ALLOW;
write(fd, &response,
sizeof(struct fanotify_response));
}
/* обрабатываем событие закрытия записываемого файла */
if (metadata->mask & FAN_CLOSE_WRITE)
printf("FAN_CLOSE_WRITE: ");
/* получаем и выводим имя файла, к которому
отслеживается доступ */
snprintf(procfd_path, sizeof(procfd_path),
"/proc/self/fd/%d", metadata->fd);
path_len = readlink(procfd_path, path,
sizeof(path) - 1);
if (path_len == -1) {
perror("readlink");
exit(EXIT_FAILURE);
}
path[path_len] = '\0';
printf("файл %s\n", path);
/* закрываем файловый дескриптор из события */
close(metadata->fd);
}
/* переходим на следующее событие */
metadata = FAN_EVENT_NEXT(metadata, len);
}
}
}
int
main(int argc, char *argv[])
{
char buf;
int fd, poll_num;
nfds_t nfds;
struct pollfd fds[2];
/* проверяем заданную точку монтирования */
if (argc != 2) {
fprintf(stderr, "Использование: %s ТОЧКА_МОНТИРОВАНИЯ\n",
argv[0]);
exit(EXIT_FAILURE);
}
printf("Нажмите enter для завершения работы.\n");
/* Создаём файловый дескриптор для доступа к fanotify API */
fd = fanotify_init(FAN_CLOEXEC | FAN_CLASS_CONTENT | FAN_NONBLOCK,
O_RDONLY | O_LARGEFILE);
if (fd == -1) {
perror("fanotify_init");
exit(EXIT_FAILURE);
}
/* Помечаем точку монтирования для:
- событий доступа перед открытием файлов
- событий уведомления после закрытия файлового дескриптора
для файла открытого для записи */
if (fanotify_mark(fd, FAN_MARK_ADD | FAN_MARK_MOUNT,
FAN_OPEN_PERM | FAN_CLOSE_WRITE, AT_FDCWD,
argv[1]) == -1) {
perror("fanotify_mark");
exit(EXIT_FAILURE);
}
/* подготовка к опросу */
nfds = 2;
/* ввод с консоли */
fds[0].fd = STDIN_FILENO;
fds[0].events = POLLIN;
/* ввод из fanotify */
fds[1].fd = fd;
fds[1].events = POLLIN;
/* цикл ожидания входящих событий */
printf("Ожидание событий.\n");
while (1) {
poll_num = poll(fds, nfds, -1);
if (poll_num == -1) {
if (errno == EINTR) /* прервано сигналом */
continue; /* перезапуск poll() */
perror("poll"); /* неожиданная ошибка */
exit(EXIT_FAILURE);
}
if (poll_num > 0) {
if (fds[0].revents & POLLIN) {
/* доступен ввод с консоли: опустошаем stdin и выходим */
while (read(STDIN_FILENO, &buf, 1) > 0 && buf != '\n')
continue;
break;
}
if (fds[1].revents & POLLIN) {
/* доступны события fanotify */
handle_events(fd);
}
}
}
printf("Ожидание событий прекращено.\n");
exit(EXIT_SUCCESS);
}
| 2019-03-06 | Linux |