.\" -*- coding: UTF-8 -*- .\" Copyright (C) 2013, Heinrich Schuchardt .\" and Copyright (C) 2014, Michael Kerrisk .\" .\" %%%LICENSE_START(VERBATIM) .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of .\" this manual under the conditions for verbatim copying, provided that .\" the entire resulting derived work is distributed under the terms of .\" a permission notice identical to this one. .\" .\" Since the Linux kernel and libraries are constantly changing, this .\" manual page may be incorrect or out-of-date. The author(s) assume. .\" no responsibility for errors or omissions, or for damages resulting. .\" from the use of the information contained herein. The author(s) may. .\" not have taken the same level of care in the production of this. .\" manual, which is licensed free of charge, as they might when working. .\" professionally. .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" %%%LICENSE_END .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .TH FANOTIFY 7 "1 ноября 2020 г." Linux "Руководство программиста Linux" .SH ИМЯ fanotify \- отслеживание событий в файловой системе .SH ОПИСАНИЕ The fanotify API provides notification and interception of filesystem events. Use cases include virus scanning and hierarchical storage management. In the original fanotify API, only a limited set of events was supported. In particular, there was no support for create, delete, and move events. The support for those events was added in Linux 5.1. (See \fBinotify\fP(7) for details of an API that did notify those events pre Linux 5.1.) .PP Дополнительные возможности по сравнению с программным интерфейсом \fBinotify\fP(7): способность отслеживать все объекты в смонтированной файловой системе, давать права на доступ и читать или изменять файлы перед тем как доступ получат другие приложения. .PP В программный интерфейс входят следующие системные вызовы: \fBfanotify_init\fP(2), \fBfanotify_mark\fP(2), \fBread\fP(2), \fBwrite\fP(2) и \fBclose\fP(2). .SS "Вызовы fanotify_init(), fanotify_mark() и группы уведомлений" Системный вызов \fBfanotify_init\fP(2) создаёт и инициализирует группу уведомления fanotify и возвращает указывающий на неё файловый дескриптор. .PP Группа уведомления fanotify — это внутренний объект ядра, в котором хранится список файлов, каталогов, файловых систем и точек монтирования, для которых должны создаваться события. .PP У каждой записи в группе уведомления fanotify есть две битовые маски: \fIметок\fP и \fIигнорирования\fP. В маске меток указывается для каких действий на файлами должны создаваться события. В маске игнорирования указывается для каких действий не должны создаваться события. Имея маски таких типов можно пометить файловую систему, точку монтирования или каталог для получения событий, и в тоже время игнорировать события для определённых объектов в этой точке монтирования или каталоге. .PP Системный вызов \fBfanotify_mark\fP(2) добавляет файл, каталог, файловую систему или точку монтирования в группу уведомления и задаёт какие события должны отслеживаться (или игнорироваться), или удаляет или изменяет нужную запись. .PP Возможное применение маски игнорирования — кэш файлов. Интересующие события для файлового кэша — изменение файла и закрытие. Для этого добавляем кэшируемый каталог или точку монтирования для приёма этих событий. После получения первого события об изменении файла, соответствующая запись кэша помечается как недействительная. Дальнейшие события об изменении файла нас не интересуют, пока файл не будет закрыт. Для этого событие об изменении можно добавить в маску игнорирования. При получении события о закрытии, событие об изменении можно удалить из маски игнорирования и запись файлового кэша можно обновить. .PP Записи в группе уведомления fanotify ссылаются на файл и каталог по номеру иноды (inode), а на точку монтирования — через ID монтирования. При переименовании или перемещении файла или каталога внутри той же точки монтирования соответствующая запись остаётся. Если файл или каталог удаляется или перемещается в другую точку монтирования, или если файловая система или точка монтирования размонтируется, то соответствующая запись удаляется. .SS "Очередь событий" Для возникающих событий с объектами файловой системы, которые отслеживаются группой уведомления, система fanotify генерирует события и помещает их в очередь. После этого события можно прочитать (с помощью \fBread\fP(2) и подобных) из файлового дескриптора fanotify, возвращённого \fBfanotify_init\fP(2). .PP Two types of events are generated: \fInotification\fP events and \fIpermission\fP events. Notification events are merely informative and require no action to be taken by the receiving application with one exception: if a valid file descriptor is provided within a generic event, the file descriptor must be closed. Permission events are requests to the receiving application to decide whether permission for a file access shall be granted. For these events, the recipient must write a response which decides whether access is granted or not. .PP Событие удаляется из очереди событий группы fanotify после прочтения. События доступа, которые были прочитаны, остаются во внутреннем списке группы fanotify до тех пор, пока решение о доступе не будет записано в файловый дескриптор fanotify, или файловый дескриптор fanotify не будет закрыт. .SS "Чтение событий fanotify" Вызов \fBread\fP(2) с файловым дескриптором, полученным от \fBfanotify_init\fP(2), блокирует выполнение (если не указан флаг \fBFAN_NONBLOCK\fP в вызове \fBfanotify_init\fP(2)) до тех пор, пока не произойдёт файловое событие или вызов не будет прерван сигналом (смотрите \fBsignal\fP(7)). .PP The use of one of the flags \fBFAN_REPORT_FID\fP, \fBFAN_REPORT_DIR_FID\fP in \fBfanotify_init\fP(2) influences what data structures are returned to the event listener for each event. Events reported to a group initialized with one of these flags will use file handles to identify filesystem objects instead of file descriptors. .TP After a successful \fBread\fP(2), the read buffer contains one or more of the following structures: .PP .in +4n .EX struct fanotify_event_metadata { __u32 event_len; __u8 vers; __u8 reserved; __u16 metadata_len; __aligned_u64 mask; __s32 fd; __s32 pid; }; .EE .in .PP In case of an fanotify group that identifies filesystem objects by file handles, you should also expect to receive one or more additional information records of the structure detailed below following the generic \fIfanotify_event_metadata\fP structure within the read buffer: .PP .in +4n .EX struct fanotify_event_info_header { __u8 info_type; __u8 pad; __u16 len; }; struct fanotify_event_info_fid { struct fanotify_event_info_header hdr; __kernel_fsid_t fsid; unsigned char file_handle[0]; }; .EE .in .PP Для увеличения производительности рекомендуется использовать буфер большого размера (например, 4096 байт) для того, чтобы получить несколько событий за один вызов \fBread\fP(2). .PP Возвращаемое \fBread\fP(2) значение — количество байт помещённых в буфер, или \-1 в случае ошибки (но смотрите ДЕФЕКТЫ). .PP Поля структуры \fIfanotify_event_metadata\fP: .TP \fIevent_len\fP This is the length of the data for the current event and the offset to the next event in the buffer. Unless the group identifies filesystem objects by file handles, the value of \fIevent_len\fP is always \fBFAN_EVENT_METADATA_LEN\fP. For a group that identifies filesystem objects by file handles, \fIevent_len\fP also includes the variable length file identifier records. .TP \fIvers\fP Номер версии структуры. Он должен сравниваться с \fBFANOTIFY_METADATA_VERSION\fP для проверки того, что структуры, возвращаемые во время выполнения, соответствуют структурам, определённым во время компиляция. В случае несоответствия приложение должно прекратить попытки использовать файловый дескриптор fanotify. .TP \fIreserved\fP Не используется. .TP \fImetadata_len\fP Длина структуры. Это поле было добавлено для облегчения реализации необязательных заголовков разных типов событий. В текущей реализации такие необязательные заголовки отсутствуют. .TP \fImask\fP Битовая маска, описывающая событие (смотрите далее). .TP \fIfd\fP This is an open file descriptor for the object being accessed, or \fBFAN_NOFD\fP if a queue overflow occurred. With an fanotify group that identifies filesystem objects by file handles, applications should expect this value to be set to \fBFAN_NOFD\fP for each event that is received. The file descriptor can be used to access the contents of the monitored file or directory. The reading application is responsible for closing this file descriptor. .IP Когда вызывается \fBfanotify_init\fP(2) вызывающий может указать (в аргументе \fIevent_f_flags\fP) различные флаги состояния файла, которые будут установлены на открытом файловом дескрипторе, соответствующем этому файловому дескриптору. Также, на отрываемом файловом дескрипторе устанавливается (внутри ядра) флаг состояния файла \fBFMODE_NONOTIFY\fP. Этот флаг подавляет генерацию событий fanotify. Таким образом, когда получатель события fanotify обратится к отслеживаемому файлу или каталогу через этот файловый дескриптор, дополнительных событий создано не будет. .TP \fIpid\fP Если в \fBfanotify_init\fP(2) установлен флаг \fBFAN_REPORT_TID\fP, то это TID нити, из\-за которой возникло событие. В противном случае это PID процесса, из\-за которой возникло событие. .PP Программа, слушающая события fanotify, может сравнить этот PID с PID, возвращаемым \fBgetpid\fP(2), для проверки, что событие не возникло из\-за самого слушающего, а из\-за доступа к файлу другого процесса. .PP В битовой маске \fImask\fP указывают события, произошедшие с одиночным объектом файловой системы. В маске может быть установлено несколько бит, если было более одного события с отслеживаемым объектом файловой системы. В частности, возникшие друг за другом события с одним объектом файловой системы и произошедшие из\-за одного процесса могут быть объединены в одно событие, за исключением того, что два события доступа никогда не объединяются в одном элементе очереди. .PP Биты маски \fImask\fP: .TP \fBFAN_ACCESS\fP Доступ (на чтение) к файлу или каталогу (но смотрите ДЕФЕКТЫ). .TP \fBFAN_OPEN\fP Файл или каталог открыт. .TP \fBFAN_OPEN_EXEC\fP Файл открыт для выполнения. Смотрите ЗАМЕЧАНИЯ в \fBfanotify_mark\fP(2). .TP \fBFAN_ATTRIB\fP Метаданные файла или каталога изменены. .TP \fBFAN_CREATE\fP Создан дочерний файл или каталог в отслеживаемом родителе. .TP \fBFAN_DELETE\fP Удалён дочерний файл или каталог в отслеживаемом родителе. .TP \fBFAN_DELETE_SELF\fP Отслеживаемый файл или каталог был удалён. .TP \fBFAN_MOVED_FROM\fP Дочерний файл или каталог был перемещён из отслеживаемого родительского каталога. .TP \fBFAN_MOVED_TO\fP Дочерний файл или каталог был помещён в отслеживаемый родительский каталог. .TP \fBFAN_MOVE_SELF\fP Отслеживаемый файл или каталог был перемещён. .TP \fBFAN_MODIFY\fP Файл изменён. .TP \fBFAN_CLOSE_WRITE\fP Файл, открытый на запись (\fBO_WRONLY\fP или \fBO_RDWR\fP), закрыт. .TP \fBFAN_CLOSE_NOWRITE\fP Файл или каталог, открытый только для чтения (\fBO_RDONLY\fP), закрыт. .TP \fBFAN_Q_OVERFLOW\fP Очередь событий превысила ограничение в 16384 записи. Это ограничение можно изменить, указав флаг \fBFAN_UNLIMITED_QUEUE\fP при вызове \fBfanotify_init\fP(2). .TP \fBFAN_ACCESS_PERM\fP Приложение хочет прочитать файл или каталог, например, с помощью \fBread\fP(2) или \fBreaddir\fP(2). Читатель события должен написать ответ (описано далее) о разрешении доступа к объекту файловой системы. .TP \fBFAN_OPEN_PERM\fP Приложение хочет открыть файл или каталог. Читатель события должен написать ответ о разрешении открытия объекта файловой системы. .TP \fBFAN_OPEN_EXEC_PERM\fP Приложение хочет открыть файл для выполнения. Читатель должен написать ответ о разрешении открытия объекта файловой системы для выполнения. Смотрите ЗАМЕЧАНИЯ в \fBfanotify_mark\fP(2). .PP Для проверки любого события закрытия может использоваться следующая битовая маска: .TP \fBFAN_CLOSE\fP Файл закрыт. Это синоним: .IP FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE .PP Для проверки любого события перемещения может использоваться следующая битовая маска: .TP \fBFAN_MOVE\fP Файл или каталог был перемещён. Это синоним для: .IP FAN_MOVED_FROM | FAN_MOVED_TO .PP The following bits may appear in \fImask\fP only in conjunction with other event type bits: .TP \fBFAN_ONDIR\fP The events described in the \fImask\fP have occurred on a directory object. Reporting events on directories requires setting this flag in the mark mask. See \fBfanotify_mark\fP(2) for additional details. The \fBFAN_ONDIR\fP flag is reported in an event mask only if the fanotify group identifies filesystem objects by file handles. .PP Поля структуры \fIfanotify_event_info_fid\fP: .TP \fIhdr\fP This is a structure of type \fIfanotify_event_info_header\fP. It is a generic header that contains information used to describe an additional information record attached to the event. For example, when an fanotify file descriptor is created using \fBFAN_REPORT_FID\fP, a single information record is expected to be attached to the event with \fIinfo_type\fP field value of \fBFAN_EVENT_INFO_TYPE_FID\fP. When an fanotify file descriptor is created using the combination of \fBFAN_REPORT_FID\fP and \fBFAN_REPORT_DIR_FID\fP, there may be two information records attached to the event: one with \fIinfo_type\fP field value of \fBFAN_EVENT_INFO_TYPE_DFID\fP, identifying a parent directory object, and one with \fIinfo_type\fP field value of \fBFAN_EVENT_INFO_TYPE_FID\fP, identifying a non\-directory object. The \fIfanotify_event_info_header\fP contains a \fIlen\fP field. The value of \fIlen\fP is the size of the additional information record including the \fIfanotify_event_info_header\fP itself. The total size of all additional information records is not expected to be bigger than ( \fIevent_len\fP \- \fImetadata_len\fP ). .TP \fIfsid\fP Уникальный идентификатор файловой системы, содержащей объект, связанный с событием. Это структура имеет тип \fI__kernel_fsid_t\fP и содержит те же значения что и \fIf_fsid\fP при вызове \fBstatfs\fP(2). .TP \fIfile_handle\fP This is a variable length structure of type struct file_handle. It is an opaque handle that corresponds to a specified object on a filesystem as returned by \fBname_to_handle_at\fP(2). It can be used to uniquely identify a file on a filesystem and can be passed as an argument to \fBopen_by_handle_at\fP(2). Note that for the directory entry modification events \fBFAN_CREATE\fP, \fBFAN_DELETE\fP, and \fBFAN_MOVE\fP, the \fIfile_handle\fP identifies the modified directory and not the created/deleted/moved child object. If the value of \fIinfo_type\fP field is \fBFAN_EVENT_INFO_TYPE_DFID_NAME\fP, the file handle is followed by a null terminated string that identifies the created/deleted/moved directory entry name. For other events such as \fBFAN_OPEN\fP, \fBFAN_ATTRIB\fP, \fBFAN_DELETE_SELF\fP, and \fBFAN_MOVE_SELF\fP, if the value of \fIinfo_type\fP field is \fBFAN_EVENT_INFO_TYPE_FID\fP, the \fIfile_handle\fP identifies the object correlated to the event. If the value of \fIinfo_type\fP field is \fBFAN_EVENT_INFO_TYPE_DFID\fP, the \fIfile_handle\fP identifies the directory object correlated to the event or the parent directory of a non\-directory object correlated to the event. If the value of \fIinfo_type\fP field is \fBFAN_EVENT_INFO_TYPE_DFID_NAME\fP, the \fIfile_handle\fP identifies the same directory object that would be reported with \fBFAN_EVENT_INFO_TYPE_DFID\fP and the file handle is followed by a null terminated string that identifies the name of a directory entry in that directory, or '.' to identify the directory object itself. .PP Следующие макросы позволяют обходить буфер с метаданными событий fanotify, возвращаемый \fBread\fP(2) из файлового дескриптора fanotify: .TP \fBFAN_EVENT_OK(meta, len)\fP Этот макрос сверяет оставшуюся длину \fIlen\fP буфера \fImeta\fP с длиной структуры метаданных и полем \fIevent_len\fP из первой структуры метаданных в буфере. .TP \fBFAN_EVENT_NEXT(meta, len)\fP Этот макрос использует длину из поля \fIevent_len\fP структуры метаданных, на которую указывает \fImeta\fP, для вычисления адреса следующей структуры метаданных, которая находится после \fImeta\fP. В поле \fIlen\fP указано количество байт метаданных, оставшихся в буфере. Макрос возвращает указатель на следующую структуру метаданных после \fImeta\fP и уменьшает \fIlen\fP на количество байт в структуре метаданных, которая была пропущена (т. е., вычитает \fImeta\->event_len\fP из \fIlen\fP). .PP Дополнительно есть: .TP \fBFAN_EVENT_METADATA_LEN\fP .\" Этот макрос возвращает размер (в байтах) структуры \fIfanotify_event_metadata\fP. Это минимальный размер (и, в настоящее время, единственный) метаданных любого события. .SS "Отслеживание событий через файловый дескриптор fanotify" Когда возникает событие fanotify файловый дескриптор fanotify помечается как доступный для чтения при его передаче в \fBepoll\fP(7), \fBpoll\fP(2) или \fBselect\fP(2). .SS "Работа с событиями доступа" Для событий доступа приложение должно записать (\fBwrite\fP(2)) в файловый дескриптор fanotify следующую структуру: .PP .in +4n .EX struct fanotify_response { __s32 fd; __u32 response; }; .EE .in .PP Поля этой структуры имеют следующее назначение: .TP \fIfd\fP Файловый дескриптор из структуры \fIfanotify_event_metadata\fP. .TP \fIresponse\fP В этом поле указывает о разрешении доступа или запрещении. Данное значение должно быть равно \fBFAN_ALLOW\fP, чтобы разрешить операцию с файлом, или \fBFAN_DENY\fP для запрета. .PP .\" Если доступ запрещается, то запрашивающее приложение получит ошибку \fBEPERM\fP. .SS "Закрытие файлового дескриптора fanotify" Когда все файловые дескрипторы, указывающие на группу уведомления fanotify, закрыты, группа fanotify освобождается и её ресурсы становятся доступны ядру для повторного использования. После \fBclose\fP(2) все оставшиеся непросмотренные события доступа будут разрешены. .SS /proc/[pid]/fdinfo Файл \fI/proc/[pid]/fdinfo/[fd]\fP содержит информацию о метках fanotify для файлового дескриптора \fIfd\fP процесса \fIpid\fP Подробности смотрите в \fBproc\fP(5). .SH ОШИБКИ Кроме обычных ошибок \fBread\fP(2) при чтении из файлового дескриптора fanotify могут возникать следующие ошибки: .TP \fBEINVAL\fP Буфер слишком мал для хранения события. .TP \fBEMFILE\fP Достигнуто максимальное попроцессное количество открытых файлов. Смотрите описание \fBRLIMIT_NOFILE\fP в \fBgetrlimit\fP(2). .TP \fBENFILE\fP Достигнут предел на общее количество открытых файлов в системе. Смотрите \fI/proc/sys/fs/file\-max\fP в \fBproc\fP(5). .TP \fBETXTBSY\fP Эта ошибка возвращается \fBread\fP(2), если при вызове \fBfanotify_init\fP(2) в аргументе \fIevent_f_flags\fP был указан \fBO_RDWR\fP или \fBO_WRONLY\fP и произошло событие с отслеживаемым файлом, который в данный момент выполняется. .PP Кроме обычных ошибок \fBwrite\fP(2) при записи в файловый дескриптор fanotify могут возникать следующие ошибки: .TP \fBEINVAL\fP Свойство для проверки прав доступа fanotify не включено в настройках ядра или некорректное значение \fIresponse\fP в структуре ответа. .TP \fBENOENT\fP Некорректный файловый дескриптор \fIfd\fP в структуре ответа. Это может происходить, когда ответ на право доступа уже был записан. .SH ВЕРСИИ Программный интерфейс fanotify представлен в версии 2.6.36 ядра Linux и включён в версии 2.6.37. Поддержка fdinfo была добавлена в версии 3.8. .SH "СООТВЕТСТВИЕ СТАНДАРТАМ" Программный интерфейс fanotify есть только в Linux. .SH ЗАМЕЧАНИЯ Программный интерфейс fanotify доступен только, если ядро собрано с включённым параметром настройки \fBCONFIG_FANOTIFY\fP. Также, работа с доступом в fanotify доступна только, если включён параметр настройки \fBCONFIG_FANOTIFY_ACCESS_PERMISSIONS\fP. .SS "Ограничения и подводные камни" Fanotify сообщает только о событиях, которые возникли при использовании пользовательскими программами программного интерфейса файловой системы. Поэтому события об обращении к файлам в сетевых файловых системах не отлавливаются. .PP Программный интерфейс fanotify не сообщает о доступе и изменениях, которые могут произойти из\-за \fBmmap\fP(2), \fBmsync\fP(2) и \fBmunmap\fP(2). .PP События для каталогов создаются только, если сам каталог открывается, читается и закрывается. Добавление, удаление и изменение потомков отслеживаемого каталога не приводит к возникновению событий. .PP Fanotify monitoring of directories is not recursive: to monitor subdirectories under a directory, additional marks must be created. The \fBFAN_CREATE\fP event can be used for detecting when a subdirectory has been created under a marked directory. An additional mark must then be set on the newly created subdirectory. This approach is racy, because it can lose events that occurred inside the newly created subdirectory, before a mark is added on that subdirectory. Monitoring mounts offers the capability to monitor a whole directory tree in a race\-free manner. Monitoring filesystems offers the capability to monitor changes made from any mount of a filesystem instance in a race\-free manner. .PP Очередь событий может переполниться. В этом случае события теряются. .SH ДЕФЕКТЫ .\" commit 820c12d5d6c0890bc93dd63893924a13041fdc35 До Linux 3.19, \fBfallocate\fP(2) не генерировал событий fanotify. Начиная с Linux 3.19, вызовы \fBfallocate\fP(2) генерируют событие \fBFAN_MODIFY\fP. .PP В Linux 3.17 существуют следующие дефекты: .IP * 3 В Linux объект файловой системы может быть доступен через несколько путей, например, часть файловой системы может быть перемонтирована \fBmount\fP(8) с использованием параметра \fI\-\-bind\fP. Ожидающий слушатель получит уведомления об объекте файловой системы только из запрошенной точки монтирования. О событиях из других точек уведомлений не поступит. .IP * .\" FIXME . A patch was proposed. При генерации события не делается проверка, что пользовательскому ID получающего процесса разрешено читать или писать в файл перед передачей файлового дескриптора на этот файл. Это представляет некоторый риск безопасности, когда у программ, выполняющихся непривилегированными пользователями, есть мандат \fBCAP_SYS_ADMIN\fP. .IP * Если вызов \fBread\fP(2) получает несколько событий из очереди fanotify и возникает ошибка, будет возвращена полная длина событий, которые были успешно скопированы в буфер пользовательского пространства до ошибки. Возвращаемое значение не будет равно \-1, и в \fIerrno\fP не записывается код ошибки. То есть читающее приложение не может обнаружить ошибку. .SH ПРИМЕРЫ Далее показано два примера программы, в которых продемонстрированоиспользование программного интерфейса fanotify. .SS "Программа\-пример: fanotify_example.c" В первой программе показано как использовать fanotify с информацией об событийном объекте, передаваемом в виде файлового дескриптора. Программа помечает точку монтирования, переданную в аргументе командной строки, и ждёт событий с типом \fBFAN_OPEN_PERM\fP и \fBFAN_CLOSE_WRITE\fP. При возникновении событий доступа выдаёт ответ \fBFAN_ALLOW\fP. .PP В сеансе оболочки далее показан пример запуска программы. В сеансе выполняется редактирование файла \fI/home/user/temp/notes\fP. Перед открытием файла возникает событие \fBFAN_OPEN_PERM\fP. После закрытия файла возникает событие \fBFAN_CLOSE_WRITE\fP. Выполнение программы заканчивается после нажатия пользователем клавиши ENTER. .PP .in +4n .EX # \fB./fanotify_example /home\fP Нажмите enter для завершения работы. Ожидание событий. FAN_OPEN_PERM: Файл /home/user/temp/notes FAN_CLOSE_WRITE: Файл /home/user/temp/notes Ожидание событий прекращено. .EE .in .SS "Исходный код программы: fanotify_example.c" \& .EX #define _GNU_SOURCE /* для получения определения O_LARGEFILE */ #include #include #include #include #include #include #include #include /* читаем все доступные события 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, 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 не совпадает.\en"); 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(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] = \(aq\e0\(aq; printf("Файл %s\en", 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 ТОЧКА_МОНТИРОВАНИЯ\en", argv[0]); exit(EXIT_FAILURE); } printf("Нажмите enter для завершения работы.\en"); /* Создаём файловый дескриптор для доступа к 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("Ожидание событий.\en"); 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 != \(aq\en\(aq) continue; break; } if (fds[1].revents & POLLIN) { /* доступны события fanotify */ handle_events(fd); } } } printf("Ожидание событий прекращено.\en"); exit(EXIT_SUCCESS); } .EE .\" .SS "Программа\-пример: fanotify_fid.c" The second program is an example of fanotify being used with a group that identifies objects by file handles. The program marks the filesystem object that is passed as a command\-line argument and waits until an event of type \fBFAN_CREATE\fP has occurred. The event mask indicates which type of filesystem object\(emeither a file or a directory\(emwas created. Once all events have been read from the buffer and processed accordingly, the program simply terminates. .PP В следующих сеансах показано два разных запуска программы с разными выполняемыми действиями над наблюдаемым объектом. .PP The first session shows a mark being placed on \fI/home/user\fP. This is followed by the creation of a regular file, \fI/home/user/testfile.txt\fP. This results in a \fBFAN_CREATE\fP event being generated and reported against the file's parent watched directory object and with the created file name. Program execution ends once all events captured within the buffer have been processed. .PP .in +4n .EX # \fB./fanotify_fid /home/user\fP Listening for events. FAN_CREATE (file created): Directory /home/user has been modified. Entry \(aqtestfile.txt\(aq is not a subdirectory. All events processed successfully. Program exiting. $ \fBtouch /home/user/testfile.txt\fP # в другом терминале .EE .in .PP The second session shows a mark being placed on \fI/home/user\fP. This is followed by the creation of a directory, \fI/home/user/testdir\fP. This specific action results in a \fBFAN_CREATE\fP event being generated and is reported with the \fBFAN_ONDIR\fP flag set and with the created directory name. .PP .in +4n .EX # \fB./fanotify_fid /home/user\fP Listening for events. FAN_CREATE | FAN_ONDIR (subdirectory created): Directory /home/user has been modified. Entry \(aqtestdir\(aq is a subdirectory. All events processed successfully. Program exiting. $ \fBmkdir \-p /home/user/testdir\fP # в другом терминале .EE .in .SS "Исходный код программы: fanotify_fid.c" \& .EX #define _GNU_SOURCE #include #include #include #include #include #include #include #include #include #define BUF_SIZE 256 int main(int argc, char **argv) { int fd, ret, event_fd, mount_fd; ssize_t len, path_len; char path[PATH_MAX]; char procfd_path[PATH_MAX]; char events_buf[BUF_SIZE]; struct file_handle *file_handle; struct fanotify_event_metadata *metadata; struct fanotify_event_info_fid *fid; const char *file_name; struct stat sb; if (argc != 2) { fprintf(stderr, "Некорректное количество аргументов в командной строке.\en"); exit(EXIT_FAILURE); } mount_fd = open(argv[1], O_DIRECTORY | O_RDONLY); if (mount_fd == \-1) { perror(argv[1]); exit(EXIT_FAILURE); } /* Create an fanotify file descriptor with FAN_REPORT_DFID_NAME as a flag so that program can receive fid events with directory entry name. */ fd = fanotify_init(FAN_CLASS_NOTIF | FAN_REPORT_DFID_NAME, 0); if (fd == \-1) { perror("fanotify_init"); exit(EXIT_FAILURE); } /* ставим метку на объект файловой системы, заданный в argv[1]. */ ret = fanotify_mark(fd, FAN_MARK_ADD | FAN_MARK_ONLYDIR, FAN_CREATE | FAN_ONDIR, AT_FDCWD, argv[1]); if (ret == \-1) { perror("fanotify_mark"); exit(EXIT_FAILURE); } printf("Ожидание событий.\en"); /* читаем события из очереди событий в буфер */ len = read(fd, events_buf, sizeof(events_buf)); if (len == \-1 && errno != EAGAIN) { perror("read"); exit(EXIT_FAILURE); } /* обрабатываем все события в буфере */ for (metadata = (struct fanotify_event_metadata *) events_buf; FAN_EVENT_OK(metadata, len); metadata = FAN_EVENT_NEXT(metadata, len)) { fid = (struct fanotify_event_info_fid *) (metadata + 1); file_handle = (struct file_handle *) fid\->handle; /* проверим, что информация о событии правильного типа */ if (fid\->hdr.info_type == FAN_EVENT_INFO_TYPE_FID || fid\->hdr.info_type == FAN_EVENT_INFO_TYPE_DFID) { file_name = NULL; } else if (fid\->hdr.info_type == FAN_EVENT_INFO_TYPE_DFID_NAME) { file_name = file_handle\->f_handle + file_handle\->handle_bytes; } else { fprintf(stderr, "Received unexpected event info type.\en"); exit(EXIT_FAILURE); } if (metadata\->mask == FAN_CREATE) printf("FAN_CREATE (создан файл):\en"); if (metadata\->mask == (FAN_CREATE | FAN_ONDIR)) printf("FAN_CREATE | FAN_ONDIR (создан подкаталог):\en"); /* metadata\->fd is set to FAN_NOFD when the group identifies objects by file handles. To obtain a file descriptor for the file object corresponding to an event you can use the struct file_handle that\(aqs provided within the fanotify_event_info_fid in conjunction with the open_by_handle_at(2) system call. A check for ESTALE is done to accommodate for the situation where the file handle for the object was deleted prior to this system call. */ event_fd = open_by_handle_at(mount_fd, file_handle, O_RDONLY); if (event_fd == \-1) { if (errno == ESTALE) { printf("Обработчик файл более недействителен. " "Файл был удалён\en"); continue; } else { perror("open_by_handle_at"); exit(EXIT_FAILURE); } } snprintf(procfd_path, sizeof(procfd_path), "/proc/self/fd/%d", event_fd); /* получаем и выводим путь изменённой dentry */ path_len = readlink(procfd_path, path, sizeof(path) \- 1); if (path_len == \-1) { perror("readlink"); exit(EXIT_FAILURE); } path[path_len] = \(aq\e0\(aq; printf("\etКаталог \(aq%s\(aq изменён.\en", path); if (file_name) { ret = fstatat(event_fd, file_name, &sb, 0); if (ret == \-1) { if (errno != ENOENT) { perror("fstatat"); exit(EXIT_FAILURE); } printf("\etEntry \(aq%s\(aq does not exist.\en", file_name); } else if ((sb.st_mode & S_IFMT) == S_IFDIR) { printf("\etEntry \(aq%s\(aq is a subdirectory.\en", file_name); } else { printf("\etEntry \(aq%s\(aq is not a subdirectory.\en", file_name); } } /* закрываем связанный файловый дескриптор этого события */ close(event_fd); } printf("Все события успешно обработаны. Завершение программы.\en"); exit(EXIT_SUCCESS); } .EE .SH "СМ. ТАКЖЕ" .ad l \fBfanotify_init\fP(2), \fBfanotify_mark\fP(2), \fBinotify\fP(7) .SH ЗАМЕЧАНИЯ Эта страница является частью проекта Linux \fIman\-pages\fP версии 5.10. Описание проекта, информацию об ошибках и последнюю версию этой страницы можно найти по адресу \%https://www.kernel.org/doc/man\-pages/. .PP .SH ПЕРЕВОД Русский перевод этой страницы руководства был сделан Azamat Hackimov , Dmitry Bolkhovskikh , Yuri Kozlov и Иван Павлов . .PP Этот перевод является бесплатной документацией; прочитайте .UR https://www.gnu.org/licenses/gpl-3.0.html Стандартную общественную лицензию GNU версии 3 .UE или более позднюю, чтобы узнать об условиях авторского права. Мы не несем НИКАКОЙ ОТВЕТСТВЕННОСТИ. .PP Если вы обнаружите ошибки в переводе этой страницы руководства, пожалуйста, отправьте электронное письмо на .MT man-pages-ru-talks@lists.sourceforge.net .ME .