1 .\" Copyright (C) 2013, Heinrich Schuchardt <xypron.glpk@gmx.de>
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of
9 .\" this manual under the conditions for verbatim copying, provided that
10 .\" the entire resulting derived work is distributed under the terms of
11 .\" a permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume.
15 .\" no responsibility for errors or omissions, or for damages resulting.
16 .\" from the use of the information contained herein. The author(s) may.
17 .\" not have taken the same level of care in the production of this.
18 .\" manual, which is licensed free of charge, as they might when working.
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
24 .TH FANOTIFY_MARK 2 2014-10-02 "Linux" "Linux Programmer's Manual"
26 fanotify_mark \- add, remove, or modify an fanotify mark on a filesystem
30 .B #include <sys/fanotify.h>
32 .BI "int fanotify_mark(int " fanotify_fd ", unsigned int " flags ,
33 .BI " uint64_t " mask ", int " dirfd \
34 ", const char *" pathname );
37 For an overview of the fanotify API, see
41 adds, removes, or modifies an fanotify mark on a filesystem object.
42 The caller must have read permission on the filesystem object that
47 argument is a file descriptor returned by
48 .BR fanotify_init (2).
51 is a bit mask describing the modification to perform.
52 It must include exactly one of the following values:
57 will be added to the mark mask (or to the ignore mask).
59 must be nonempty or the error
64 The events in argument
66 will be removed from the mark mask (or from the ignore mask).
68 must be nonempty or the error
73 Remove either all mount or all non-mount marks from the fanotify group.
78 all marks for mounts are removed from the group.
79 Otherwise, all marks for directories and files are removed.
82 can be used in conjunction with
87 If none of the values above is specified, or more than one is specified,
88 the call fails with the error
92 zero or more of the following values may be ORed into
95 .B FAN_MARK_DONT_FOLLOW
98 is a symbolic link, mark the link itself, rather than the file to which it
104 if it is a symbolic link.)
107 If the filesystem object to be marked is not a directory, the error
112 Mark the mount point specified by
116 is not itself a mount point, the mount point containing
119 All directories, subdirectories, and the contained files of the mount point
122 .B FAN_MARK_IGNORED_MASK
125 shall be added to or removed from the ignore mask.
127 .B FAN_MARK_IGNORED_SURV_MODIFY
128 The ignore mask shall survive modify events.
129 If this flag is not set,
130 the ignore mask is cleared when a modify event occurs
131 for the ignored file or directory.
134 defines which events shall be listened for (or which shall be ignored).
135 It is a bit mask composed of the following values:
138 Create an event when a file or directory (but see BUGS) is accessed (read).
141 Create an event when a file is modified (write).
144 Create an event when a writable file is closed.
147 Create an event when a read-only file or directory is closed.
150 Create an event when a file or directory is opened.
153 Create an event when a permission to open a file or directory is requested.
154 An fanotify file descriptor created with
155 .B FAN_CLASS_PRE_CONTENT
161 Create an event when a permission to read a file or directory is requested.
162 An fanotify file descriptor created with
163 .B FAN_CLASS_PRE_CONTENT
169 Create events for directories\(emfor example, when
175 Without this flag, only events for files are created.
177 .B FAN_EVENT_ON_CHILD
178 Events for the immediate children of marked directories shall be created.
179 The flag has no effect when marking mounts.
180 Note that events are not generated for children of the subdirectories
181 of marked directories.
182 To monitor complete directory trees it is necessary to mark the relevant
185 The following composed value is defined:
189 .RB ( FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE ).
191 The filesystem object to be marked is determined by the file descriptor
193 and the pathname specified in
200 defines the filesystem object to be marked.
206 takes the special value
208 the current working directory is to be marked.
212 is absolute, it defines the filesystem object to be marked, and
220 does not have the value
222 then the filesystem object to be marked is determined by interpreting
224 relative the directory referred to by
233 then the filesystem object to be marked is determined by interpreting
235 relative the current working directory.
240 On error, \-1 is returned, and
242 is set to indicate the error.
246 An invalid file descriptor was passed in
250 An invalid value was passed in
256 was not an fanotify file descriptor.
259 The fanotify file descriptor was opened with
261 and mask contains a flag for permission events
264 .BR FAN_ACCESS_PERM ).
267 The filesystem object indicated by
272 This error also occurs when trying to remove a mark from an object
276 The necessary memory could not be allocated.
279 The number of marks exceeds the limit of 8192 and the
280 .B FAN_UNLIMITED_MARKS
281 flag was not specified when the fanotify file descriptor was created with
282 .BR fanotify_init (2).
285 This kernel does not implement
286 .BR fanotify_mark ().
287 The fanotify API is available only if the kernel was configured with
288 .BR CONFIG_FANOTIFY .
293 .BR FAN_MARK_ONLYDIR ,
298 do not specify a directory.
301 was introduced in version 2.6.36 of the Linux kernel and enabled in version
304 This system call is Linux-specific.
306 The following bugs were present in Linux kernels before version 3.16:
308 .\" Fixed by commit 0a8dd2db579f7a0ac7033d6b857c3d5dbaa77563
316 must specify a valid filesystem object, even though this object is not used.
318 .\" Fixed by commit d4c7cf6cffb1bc711a833b5e304ba5bcfe76398b
324 .\" Fixed by commit cc299a98eb13a9853675a9cbb90b30b4011e1406
326 .BR fanotify_mark (2)
330 is not checked for invalid values.
332 .BR fanotify_init (2),