FANOTIFY_MARK(2)

NOM
fanotify_mark - Ajouter, supprimer ou modifier une marque fanotify sur un objet de système de fichiers

BIBLIOTHÈQUE
Bibliothèque C standard (libc, -lc)

SYNOPSIS
#include <sys/fanotify.h>

int fanotify_mark(int fanotify_fd, unsigned int flags,
                  uint64_t mask, int dirfd, const char *pathname);

DESCRIPTION
Pour un aperçu de l’interface de programmation fanotify, consultez fanotify(7).

fanotify_mark() ajoute, supprime ou modifie une marque fanotify sur un objet de système de fichiers. L’appelant doit avoir le droit de lecture sur l’objet de système de fichiers à marquer.

L’argument fanotify_fd est un descripteur de fichier renvoyé par fanotify_init(2).

flags est un masque de bits décrivant la modification à réaliser. Il doit contenir exactement une des valeurs suivantes.

FAN_MARK_ADD
    Les événements dans mask seront ajoutés au masque de marque (ou au masque ignore). mask doit être non vide sinon l’erreur EINVAL surviendra.

FAN_MARK_REMOVE
    Les événements dans l’argument mask seront supprimés du masque de marque (ou du masque ignore). mask doit être non vide sinon l’erreur EINVAL surviendra.

FAN_MARK_FLUSH
    Remove either all marks for filesystems, all marks for mounts, or all marks for directories and files from the fanotify group. If flags contains FAN_MARK_MOUNT, all marks for mounts are removed from the group. If flags contains FAN_MARK_FILESYSTEM, all marks for filesystems are removed from the group. Otherwise, all marks for directories and files are removed. No flag other than, and at most one of, the flags FAN_MARK_MOUNT or FAN_MARK_FILESYSTEM can be used in conjunction with FAN_MARK_FLUSH. mask is ignored.

Si aucune des valeurs précédentes n’est indiquée, ou si plus d’une est indiquée, l’appel échoue avec l'erreur EINVAL.

De plus, zéro ou plus des valeurs suivantes peuvent être incluses dans flags (avec une opération OU bit à bit).

FAN_MARK_DONT_FOLLOW
    Si pathname est un lien symbolique, marquer le lien lui-même, plutôt que le fichier pointé (par défaut, fanotify_mark() déréférence pathname si c’est un lien symbolique).

FAN_MARK_ONLYDIR
    Si l’objet de système de fichiers à marquer n’est pas un répertoire, l’erreur ENOTDIR surviendra.

FAN_MARK_MOUNT
    Mark the mount specified by pathname. If pathname is not itself a mount point, the mount containing pathname will be marked. All directories, subdirectories, and the contained files of the mount will be monitored. The events which require that filesystem objects are identified by file handles, such as FAN_CREATE, FAN_ATTRIB, FAN_MOVE, and FAN_DELETE_SELF, cannot be provided as a mask when flags contains FAN_MARK_MOUNT. Attempting to do so will result in the error EINVAL being returned. Use of this flag requires the CAP_SYS_ADMIN capability.

FAN_MARK_FILESYSTEM (depuis Linux 4.20)
    Mark the filesystem specified by pathname. The filesystem containing pathname will be marked. All the contained files and directories of the filesystem from any mount point will be monitored. Use of this flag requires the CAP_SYS_ADMIN capability.

FAN_MARK_IGNORED_MASK
    The events in mask shall be added to or removed from the ignore mask. Note that the flags FAN_ONDIR, and FAN_EVENT_ON_CHILD have no effect when provided with this flag. The effect of setting the flags FAN_ONDIR, and FAN_EVENT_ON_CHILD in the mark mask on the events that are set in the ignore mask is undefined and depends on the Linux kernel version. Specifically, prior to Linux 5.9, setting a mark mask on a file and a mark with ignore mask on its parent directory would not result in ignoring events on the file, regardless of the FAN_EVENT_ON_CHILD flag in the parent directory's mark mask. When the ignore mask is updated with the FAN_MARK_IGNORED_MASK flag on a mark that was previously updated with the FAN_MARK_IGNORE flag, the update fails with EEXIST error.

FAN_MARK_IGNORE (since Linux 6.0)
    This flag has a similar effect as setting the FAN_MARK_IGNORED_MASK flag. The events in mask shall be added to or removed from the ignore mask. Unlike the FAN_MARK_IGNORED_MASK flag, this flag also has the effect that the FAN_ONDIR, and FAN_EVENT_ON_CHILD flags take effect on the ignore mask. Specifically, unless the FAN_ONDIR flag is set with FAN_MARK_IGNORE, events on directories will not be ignored. If the flag FAN_EVENT_ON_CHILD is set with FAN_MARK_IGNORE, events on children will be ignored. For example, a mark on a directory with combination of a mask with FAN_CREATE event and FAN_ONDIR flag and an ignore mask with FAN_CREATE event and without FAN_ONDIR flag, will result in getting only the events for creation of sub-directories. When using the FAN_MARK_IGNORE flag to add to an ignore mask of a mount, filesystem, or directory inode mark, the FAN_MARK_IGNORED_SURV_MODIFY flag must be specified. Failure to do so will results with EINVAL or EISDIR error.

FAN_MARK_IGNORED_SURV_MODIFY
    The ignore mask shall survive modify events. If this flag is not set, the ignore mask is cleared when a modify event occurs on the marked object. Omitting this flag is typically used to suppress events (e.g., FAN_OPEN) for a specific file, until that specific file's content has been modified. It is far less useful to suppress events on an entire filesystem, or mount, or on all files inside a directory, until some file's content has been modified. For this reason, the FAN_MARK_IGNORE flag requires the FAN_MARK_IGNORED_SURV_MODIFY flag on a mount, filesystem, or directory inode mark. This flag cannot be removed from a mark once set. When the ignore mask is updated without this flag on a mark that was previously updated with the FAN_MARK_IGNORE and FAN_MARK_IGNORED_SURV_MODIFY flags, the update fails with EEXIST error.

FAN_MARK_IGNORE_SURV
    This is a synonym for (FAN_MARK_IGNORE|FAN_MARK_IGNORED_SURV_MODIFY).

FAN_MARK_EVICTABLE (since Linux 5.19)
    When an inode mark is created with this flag, the inode object will not be pinned to the inode cache, therefore, allowing the inode object to be evicted from the inode cache when the memory pressure on the system is high. The eviction of the inode object results in the evictable mark also being lost. When the mask of an evictable inode mark is updated without using the FAN_MARK_EVICATBLE flag, the marked inode is pinned to inode cache and the mark is no longer evictable. When the mask of a non-evictable inode mark is updated with the FAN_MARK_EVICTABLE flag, the inode mark remains non-evictable and the update fails with EEXIST error. Mounts and filesystems are not evictable objects, therefore, an attempt to create a mount mark or a filesystem mark with the FAN_MARK_EVICTABLE flag, will result in the error EINVAL. For example, inode marks can be used in combination with mount marks to reduce the amount of events from noninteresting paths. The event listener reads events, checks if the path reported in the event is of interest, and if it is not, the listener sets a mark with an ignore mask on the directory. Evictable inode marks allow using this method for a large number of directories without the concern of pinning all inodes and exhausting the system's memory.

mask définit les événements à écouter (ou à ignorer). C’est un masque de bits constitué par les valeurs suivantes :

FAN_ACCESS
    Créer un événement quand un fichier ou un répertoire (mais consultez BOGUES) est accédé (en lecture).

FAN_MODIFY
    Créer un événement quand un fichier est modifié (en écriture).

FAN_CLOSE_WRITE
    Créer un événement quand un fichier modifiable en écriture est fermé.

FAN_CLOSE_NOWRITE
    Créer un événement quand soit un fichier, soit un répertoire, en lecture seule, est fermé.

FAN_OPEN
    Créer un événement quand soit un fichier, soit un répertoire est ouvert.

FAN_OPEN_EXEC (depuis Linux 5.0)
    Créer un événement quand un fichier est ouvert pour être exécuté. Voir les NOTES pour plus de détails.

FAN_ATTRIB (depuis Linux 5.1)
    Créer un événement quand les métadonnées d'un fichier ou d'un répertoire ont changé. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_CREATE (depuis Linux 5.1)
    Créer un événement quand un fichier ou un répertoire a été créé dans un répertoire parent marqué. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_DELETE (depuis Linux 5.1)
    Créer un événement quand un fichier ou un répertoire a été effacé d'un répertoire parent marqué. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_DELETE_SELF (depuis Linux 5.1)
    Créer un événement quand un fichier, ou même un répertoire, marqué est effacé. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_FS_ERROR (since Linux 5.16)
    Create an event when a filesystem error leading to inconsistent filesystem metadata is detected. An additional information record of type FAN_EVENT_INFO_TYPE_ERROR is returned for each event in the read buffer. An fanotify group that identifies filesystem objects by file handles is required.

    Events of such type are dependent on support from the underlying filesystem. At the time of writing, only the ext4 filesystem reports FAN_FS_ERROR events.

    See fanotify(7) for additional details.

FAN_MOVED_FROM (depuis Linux 5.1)
    Créer un événement quand un fichier ou un répertoire a été déplacé depuis un répertoire parent marqué. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_MOVED_TO (depuis Linux 5.1)
    Créer un événement quand un fichier ou un répertoire est déplacé vers un répertoire parent marqué. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_RENAME (since Linux 5.17)
    This event contains the same information provided by events FAN_MOVED_FROM and FAN_MOVED_TO, however is represented by a single event with up to two information records. An fanotify group that identifies filesystem objects by file handles is required. If the filesystem object to be marked is not a directory, the error ENOTDIR shall be raised.

FAN_MOVE_SELF (depuis Linux 5.1)
    Créer un événement quand un fichier, ou même un répertoire, marqué a été déplacé. Un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier est nécessaire.

FAN_OPEN_PERM
    Créer un événement quand une permission d’ouvrir un fichier ou un répertoire est demandée. Un descripteur de fichier fanotify créé avec FAN_CLASS_PRE_CONTENT ou FAN_CLASS_CONTENT est nécessaire.

FAN_OPEN_EXEC_PERM (depuis Linux 5.0)
    Créer un événement quand une permission d’ouvrir un fichier en exécution est demandée. Un descripteur de fichier fanotify créé avec FAN_CLASS_PRE_CONTENT ou FAN_CLASS_CONTENT est nécessaire. Voir les NOTES pour des détails supplémentaires.

FAN_ACCESS_PERM
    Créer un événement quand une permission de lire un fichier ou un répertoire est demandée. Un descripteur de fichier fanotify créé avec FAN_CLASS_PRE_CONTENT ou FAN_CLASS_CONTENT est nécessaire.

FAN_ONDIR
    Créer des événements pour les répertoires — par exemple quand opendir(3), readdir(3) (mais voir BOGUES) et closedir(3) sont appelés. Sans cet attribut, les événements ne sont créés que pour les fichiers. Dans le contexte des événements d’entrée de répertoire tels que FAN_CREATE, FAN_DELETE, FAN_MOVED_FROM et FAN_MOVED_TO, il est nécessaire d'indiquer le drapeau FAN_ONDIR afin de créer des événements quand des entrées de sous-répertoire sont modifiées (à savoir mkdir(2) ou rmdir(2)).

FAN_EVENT_ON_CHILD
    Des événements pour les enfants directs des répertoires marqués seront créés. L’attribut n’a pas d’effet lors du marquage de montages ou de systèmes de fichiers. Remarquez qu’aucun événement n’est créé pour les enfants des sous-répertoires des répertoires marqués. De manière plus spécifique, les événements de modification d’entrée d'un répertoire FAN_CREATE, FAN_DELETE, FAN_MOVED_FROM et FAN_MOVED_TO ne sont pas générés pour des modifications effectuées dans les sous-répertoires de répertoires marqués. Remarquez que les événements FAN_DELETE_SELF et FAN_MOVE_SELF ne sont pas générés pour les enfants de répertoires marqués. Pour surveiller des arborescences complètes de répertoires, le montage ou le système de fichiers adéquat doit être marqué.

Les valeurs composées suivantes sont définies :

FAN_CLOSE
    Un fichier est fermé (FAN_CLOSE_WRITE|FAN_CLOSE_NOWRITE).

FAN_MOVE
    Un fichier ou un répertoire a été déplacé (FAN_MOVED_FROM|FAN_MOVED_TO).

L’objet de système de fichiers à marquer est déterminé par le descripteur de fichier dirfd et le chemin indiqué dans pathname :

–   si pathname est NULL, dirfd définit l’objet de système de fichiers à marquer ;

–   si pathname est NULL et que dirfd prend la valeur spéciale AT_FDCWD, le répertoire de travail actuel est à marquer ;

–   si pathname est absolu, il définit l’objet de système de fichiers à marquer et dirfd est ignoré ;

–   si pathname est relatif et que dirfd n’a pas la valeur AT_FDCWD, alors l’objet de système de fichiers à marquer est déterminé en interprétant pathname comme relatif au répertoire référencé par dirfd ;

–   If pathname is relative, and dirfd has the value AT_FDCWD, then the filesystem object to be marked is determined by interpreting pathname relative to the current working directory. (See openat(2) for an explanation of why the dirfd argument is useful.)

VALEUR RENVOYÉE
S'il réussit, fanotify_mark() renvoie 0. En cas d'erreur, il renvoie -1 et remplit errno avec la valeur d'erreur.

ERREURS

EBADF
    Un descripteur de fichier incorrect a été passé dans fanotify_fd.

EBADF
    pathname est relatif mais dirfd n'est ni AT_FDWCD ni un descripteur de fichier valable.

EEXIST
    The filesystem object indicated by dirfd and pathname has a mark that was updated without the FAN_MARK_EVICTABLE flag, and the user attempted to update the mark with FAN_MARK_EVICTABLE flag.

EEXIST
    The filesystem object indicated by dirfd and pathname has a mark that was updated with the FAN_MARK_IGNORE flag, and the user attempted to update the mark with FAN_MARK_IGNORED_MASK flag.

EEXIST
    The filesystem object indicated by dirfd and pathname has a mark that was updated with the FAN_MARK_IGNORE and FAN_MARK_IGNORED_SURV_MODIFY flags, and the user attempted to update the mark only with FAN_MARK_IGNORE flag.

EINVAL
    Une valeur incorrecte a été passée dans flags ou mask, ou fanotify_fd n'était pas un descripteur de fichier fanotify.

EINVAL
    Le descripteur de fichier fanotify a été ouvert avec FAN_CLASS_NOTIF ou le groupe fanotify identifie des systèmes de fichiers par des identificateurs de fichier et le masque contient un attribut pour des événements de permission (FAN_OPEN_PERM ou FAN_ACCESS_PERM).

EINVAL
    The group was initialized without FAN_REPORT_FID but one or more event types specified in the mask require it.

EINVAL
    flags contains FAN_MARK_IGNORE, and either FAN_MARK_MOUNT or FAN_MARK_FILESYSTEM, but does not contain FAN_MARK_IGNORED_SURV_MODIFY.

EISDIR
    flags contains FAN_MARK_IGNORE, but does not contain FAN_MARK_IGNORED_SURV_MODIFY, and dirfd and pathname specify a directory.

ENODEV
    The filesystem object indicated by dirfd and pathname is not associated with a filesystem that supports fsid (e.g., fuse(4)). tmpfs(5) did not support fsid prior to Linux 5.13. This error can be returned only with an fanotify group that identifies filesystem objects by file handles.

ENOENT
    L’objet de système de fichiers indiqué par dirfd et pathname n’existe pas. Cette erreur survient aussi lors d’une tentative de supprimer une marque d’un objet qui n’est pas marqué.

ENOMEM
    La mémoire nécessaire n’a pas pu être allouée.

ENOSPC
    The number of marks for this user exceeds the limit and the FAN_UNLIMITED_MARKS flag was not specified when the fanotify file descriptor was created with fanotify_init(2). See fanotify(7) for details about this limit.

ENOSYS
    Ce noyau n’implémente pas fanotify_mark(). L’interface de programmation fanotify n'est disponible que si le noyau a été configuré avec CONFIG_FANOTIFY.

ENOTDIR
    flags contient FAN_MARK_ONLYDIR, et dirfd et pathname n’indiquent pas de répertoire.

ENOTDIR
    mask contains FAN_RENAME, and dirfd and pathname do not specify a directory.

ENOTDIR
    flags contains FAN_MARK_IGNORE, or the fanotify group was initialized with flag FAN_REPORT_TARGET_FID, and mask contains directory entry modification events (e.g., FAN_CREATE, FAN_DELETE), or directory event flags (e.g., FAN_ONDIR, FAN_EVENT_ON_CHILD), and dirfd and pathname do not specify a directory.

EOPNOTSUPP
    L'objet indiqué par pathname est associé à un système de fichiers qui ne gère pas l'encodage d’identificateurs de fichier. Cette erreur ne peut être renvoyée que lorsqu'un groupe fanotify identifie les systèmes de fichiers par des identificateurs de fichier.

EPERM
    The operation is not permitted because the caller lacks a required capability.

EXDEV
    Le système de fichiers indiqué par pathname se trouve dans un sous-volume de système de fichiers (comme btrfs(5)) qui utilise un fsid différent de son superbloc racine. Cette erreur ne peut être renvoyée que par un groupe fanotify qui identifie les systèmes de fichiers par des identificateurs de fichier.

VERSIONS
fanotify_mark() a été introduit dans la version 2.6.36 du noyau Linux et activé dans la version 2.6.37.

STANDARDS
Cet appel système est spécifique à Linux.

NOTES

  FAN_OPEN_EXEC et FAN_OPEN_EXEC_PERM
Quand on utilise FAN_OPEN_EXEC ou FAN_OPEN_EXEC_PERM dans le mask, des événements de ces types ne seront renvoyés que lorsque l'exécution directe d'un programme se produit. Plus particulièrement, cela signifie que les événements de ces types seront créés pour les fichiers ouverts en utilisant execve(2), execveat(2) ou uselib(2). Les événements de ces types n'apparaîtront pas quand un interpréteur est passé pour interprétation d'un fichier (ou s'il est en cours de lecture).

De plus, si une marque a aussi été placée sur l'éditeur de liens dynamiques de Linux, un utilisateur doit s'attendre aussi à recevoir un événement associé quand un objet ELF a été ouvert avec succès en utilisant execve(2) ou execveat(2).

Par exemple, si le binaire ELF suivant devait être appelé et si une marque FAN_OPEN_EXEC a été placée sur / :

    $ /bin/echo toto

Dans ce cas, l'application à l'écoute devrait recevoir des événements FAN_OPEN_EXEC, respectivement pour le binaire ELF et pour l'interpréteur :

    /bin/echo
    /lib64/ld-linux-x86-64.so.2

BOGUES
Les bogues suivants étaient présents dans les noyaux Linux avant la version 3.16 :

–   Si flags contient FAN_MARK_FLUSH, dirfd et pathname doivent indiquer un objet de système de fichiers valable, même si cet objet n’est pas utilisé.

–   readdir(2) ne crée pas d’événement FAN_ACCESS ;

–   si fanotify_mark() est appelé avec FAN_MARK_FLUSH, les valeurs incorrectes de flags ne sont pas vérifiées.

VOIR AUSSI
fanotify_init(2), fanotify(7)

TRADUCTION
La traduction française de cette page de manuel a été créée par Christophe Blaess <https://www.blaess.fr/christophe/>, Stéphan Rafin <stephan.rafin@laposte.net>, Thierry Vignaud <tvignaud@mandriva.com>, François Micaux, Alain Portal <aportal@univ-montp2.fr>, Jean-Philippe Guérard <fevrier@tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-luc.coulon@wanadoo.fr>, Julien Cristau <jcristau@debian.org>, Thomas Huriaux <thomas.huriaux@gmail.com>, Nicolas François <nicolas.francois@centraliens.net>, Florentin Duneau <fduneau@gmail.com>, Simon Paillard <simon.paillard@resel.enst-bretagne.fr>, Denis Barbier <barbier@debian.org>, David Prévot <david@tilapin.org> et Jean-Philippe MENGUAL <jpmengual@debian.org>

Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 (https://www.gnu.org/licenses/gpl-3.0.html) concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.

Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à debian-l10n-french@lists.debian.org.