Merge branch 'rcu/urgent' of git://git.kernel.org/pub/scm/linux/kernel/git/paulmck...
[linux-block.git] / include / linux / fsnotify_backend.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
90586523
EP
2/*
3 * Filesystem access notification for Linux
4 *
5 * Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
6 */
7
8#ifndef __LINUX_FSNOTIFY_BACKEND_H
9#define __LINUX_FSNOTIFY_BACKEND_H
10
11#ifdef __KERNEL__
12
63c882a0 13#include <linux/idr.h> /* inotify uses this */
90586523
EP
14#include <linux/fs.h> /* struct inode */
15#include <linux/list.h>
16#include <linux/path.h> /* struct path */
17#include <linux/spinlock.h>
18#include <linux/types.h>
60063497 19#include <linux/atomic.h>
1cce1eea 20#include <linux/user_namespace.h>
7761daa6 21#include <linux/refcount.h>
90586523
EP
22
23/*
24 * IN_* from inotfy.h lines up EXACTLY with FS_*, this is so we can easily
25 * convert between them. dnotify only needs conversion at watch creation
26 * so no perf loss there. fanotify isn't defined yet, so it can use the
27 * wholes if it needs more events.
28 */
29#define FS_ACCESS 0x00000001 /* File was accessed */
30#define FS_MODIFY 0x00000002 /* File was modified */
31#define FS_ATTRIB 0x00000004 /* Metadata changed */
32#define FS_CLOSE_WRITE 0x00000008 /* Writtable file was closed */
33#define FS_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */
34#define FS_OPEN 0x00000020 /* File was opened */
35#define FS_MOVED_FROM 0x00000040 /* File was moved from X */
36#define FS_MOVED_TO 0x00000080 /* File was moved to Y */
37#define FS_CREATE 0x00000100 /* Subfile was created */
38#define FS_DELETE 0x00000200 /* Subfile was deleted */
39#define FS_DELETE_SELF 0x00000400 /* Self was deleted */
40#define FS_MOVE_SELF 0x00000800 /* Self was moved */
9b076f1c 41#define FS_OPEN_EXEC 0x00001000 /* File was opened for exec */
90586523
EP
42
43#define FS_UNMOUNT 0x00002000 /* inode on umount fs */
44#define FS_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
45#define FS_IN_IGNORED 0x00008000 /* last inotify event here */
46
c4ec54b4
EP
47#define FS_OPEN_PERM 0x00010000 /* open event in an permission hook */
48#define FS_ACCESS_PERM 0x00020000 /* access event in a permissions hook */
66917a31 49#define FS_OPEN_EXEC_PERM 0x00040000 /* open/exec event in a permission hook */
c4ec54b4 50
8c1934c8 51#define FS_EXCL_UNLINK 0x04000000 /* do not send events if object is unlinked */
9b93f331
AG
52/*
53 * Set on inode mark that cares about things that happen to its children.
54 * Always set for dnotify and inotify.
55 * Set on inode/sb/mount marks that care about parent/name info.
56 */
c28f7e56
EP
57#define FS_EVENT_ON_CHILD 0x08000000
58
6473ea76
AG
59#define FS_DN_RENAME 0x10000000 /* file renamed */
60#define FS_DN_MULTISHOT 0x20000000 /* dnotify multishot */
61#define FS_ISDIR 0x40000000 /* event occurred against dir */
62#define FS_IN_ONESHOT 0x80000000 /* only send event once */
63
e9fd702a
EP
64#define FS_MOVE (FS_MOVED_FROM | FS_MOVED_TO)
65
e220140f
AG
66/*
67 * Directory entry modification events - reported only to directory
68 * where entry is modified and not to a watching parent.
69 * The watching parent may get an FS_ATTRIB|FS_EVENT_ON_CHILD event
70 * when a directory entry inside a child subdir changes.
71 */
08b95c33 72#define ALL_FSNOTIFY_DIRENT_EVENTS (FS_CREATE | FS_DELETE | FS_MOVE)
e220140f 73
66917a31
MB
74#define ALL_FSNOTIFY_PERM_EVENTS (FS_OPEN_PERM | FS_ACCESS_PERM | \
75 FS_OPEN_EXEC_PERM)
ff8bcbd0 76
e220140f 77/*
9b93f331
AG
78 * This is a list of all events that may get sent to a parent that is watching
79 * with flag FS_EVENT_ON_CHILD based on fs event on a child of that directory.
e220140f
AG
80 */
81#define FS_EVENTS_POSS_ON_CHILD (ALL_FSNOTIFY_PERM_EVENTS | \
82 FS_ACCESS | FS_MODIFY | FS_ATTRIB | \
83 FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | \
84 FS_OPEN | FS_OPEN_EXEC)
85
9b93f331
AG
86/*
87 * This is a list of all events that may get sent with the parent inode as the
88 * @to_tell argument of fsnotify().
89 * It may include events that can be sent to an inode/sb/mount mark, but cannot
90 * be sent to a parent watching children.
91 */
92#define FS_EVENTS_POSS_TO_PARENT (FS_EVENTS_POSS_ON_CHILD)
93
007d1e83 94/* Events that can be reported to backends */
e220140f
AG
95#define ALL_FSNOTIFY_EVENTS (ALL_FSNOTIFY_DIRENT_EVENTS | \
96 FS_EVENTS_POSS_ON_CHILD | \
97 FS_DELETE_SELF | FS_MOVE_SELF | FS_DN_RENAME | \
98 FS_UNMOUNT | FS_Q_OVERFLOW | FS_IN_IGNORED)
007d1e83
AG
99
100/* Extra flags that may be reported with event or control handling of events */
101#define ALL_FSNOTIFY_FLAGS (FS_EXCL_UNLINK | FS_ISDIR | FS_IN_ONESHOT | \
20dee624
EP
102 FS_DN_MULTISHOT | FS_EVENT_ON_CHILD)
103
007d1e83
AG
104#define ALL_FSNOTIFY_BITS (ALL_FSNOTIFY_EVENTS | ALL_FSNOTIFY_FLAGS)
105
90586523
EP
106struct fsnotify_group;
107struct fsnotify_event;
e61ce867 108struct fsnotify_mark;
e4aff117 109struct fsnotify_event_private_data;
7053aee2 110struct fsnotify_fname;
abc77577 111struct fsnotify_iter_info;
90586523 112
d46eb14b
SB
113struct mem_cgroup;
114
90586523
EP
115/*
116 * Each group much define these ops. The fsnotify infrastructure will call
117 * these operations for each relevant group.
118 *
119 * handle_event - main call for a group to handle an fs event
b54cecf5
AG
120 * @group: group to notify
121 * @mask: event type and flags
122 * @data: object that event happened on
123 * @data_type: type of object for fanotify_data_XXX() accessors
124 * @dir: optional directory associated with event -
125 * if @file_name is not NULL, this is the directory that
126 * @file_name is relative to
127 * @file_name: optional file name associated with event
128 * @cookie: inotify rename cookie
129 * @iter_info: array of marks from this group that are interested in the event
130 *
b9a1b977
AG
131 * handle_inode_event - simple variant of handle_event() for groups that only
132 * have inode marks and don't have ignore mask
133 * @mark: mark to notify
134 * @mask: event type and flags
135 * @inode: inode that event happened on
136 * @dir: optional directory associated with event -
137 * if @file_name is not NULL, this is the directory that
138 * @file_name is relative to.
139 * @file_name: optional file name associated with event
950cc0d2 140 * @cookie: inotify rename cookie
b9a1b977 141 *
90586523 142 * free_group_priv - called when a group refcnt hits 0 to clean up the private union
6960b0d9 143 * freeing_mark - called when a mark is being destroyed for some reason. The group
b9a1b977
AG
144 * MUST be holding a reference on each mark and that reference must be
145 * dropped in this function. inotify uses this function to send
146 * userspace messages that marks have been removed.
90586523
EP
147 */
148struct fsnotify_ops {
b54cecf5
AG
149 int (*handle_event)(struct fsnotify_group *group, u32 mask,
150 const void *data, int data_type, struct inode *dir,
e43e9c33 151 const struct qstr *file_name, u32 cookie,
9385a84d 152 struct fsnotify_iter_info *iter_info);
b9a1b977
AG
153 int (*handle_inode_event)(struct fsnotify_mark *mark, u32 mask,
154 struct inode *inode, struct inode *dir,
950cc0d2 155 const struct qstr *file_name, u32 cookie);
90586523 156 void (*free_group_priv)(struct fsnotify_group *group);
841bdc10 157 void (*freeing_mark)(struct fsnotify_mark *mark, struct fsnotify_group *group);
7053aee2 158 void (*free_event)(struct fsnotify_event *event);
054c636e
JK
159 /* called on final put+free to free memory */
160 void (*free_mark)(struct fsnotify_mark *mark);
7053aee2
JK
161};
162
163/*
164 * all of the information about the original object we want to now send to
165 * a group. If you want to carry more info from the accessing task to the
166 * listener this structure is where you need to be adding fields.
167 */
168struct fsnotify_event {
169 struct list_head list;
dfc2d259 170 unsigned long objectid; /* identifier for queue merges */
90586523
EP
171};
172
173/*
174 * A group is a "thing" that wants to receive notification about filesystem
175 * events. The mask holds the subset of event types this group cares about.
176 * refcnt on a group is up to the implementor and at any moment if it goes 0
177 * everything will be cleaned up.
178 */
179struct fsnotify_group {
d46eb14b
SB
180 const struct fsnotify_ops *ops; /* how this group handles things */
181
90586523
EP
182 /*
183 * How the refcnt is used is up to each group. When the refcnt hits 0
184 * fsnotify will clean up all of the resources associated with this group.
185 * As an example, the dnotify group will always have a refcnt=1 and that
186 * will never change. Inotify, on the other hand, has a group per
187 * inotify_init() and the refcnt will hit 0 only when that fd has been
188 * closed.
189 */
7761daa6 190 refcount_t refcnt; /* things with interest in this group */
90586523 191
a2d8bc6c 192 /* needed to send notification to userspace */
c21dbe20 193 spinlock_t notification_lock; /* protect the notification_list */
a2d8bc6c
EP
194 struct list_head notification_list; /* list of event_holder this group needs to send to userspace */
195 wait_queue_head_t notification_waitq; /* read() on the notification file blocks on this waitq */
196 unsigned int q_len; /* events on the queue */
197 unsigned int max_events; /* maximum events allowed on the list */
6ad2d4e3
EP
198 /*
199 * Valid fsnotify group priorities. Events are send in order from highest
200 * priority to lowest priority. We default to the lowest priority.
201 */
202 #define FS_PRIO_0 0 /* normal notifiers, no permissions */
203 #define FS_PRIO_1 1 /* fanotify content based access control */
204 #define FS_PRIO_2 2 /* fanotify pre-content access */
205 unsigned int priority;
12703dbf 206 bool shutdown; /* group is being shut down, don't queue more events */
a2d8bc6c 207
e61ce867 208 /* stores all fastpath marks assoc with this group so they can be cleaned on unregister */
986ab098 209 struct mutex mark_mutex; /* protect marks_list */
841bdc10 210 atomic_t num_marks; /* 1 for each mark and 1 for not being
3be25f49
EP
211 * past the point of no return when freeing
212 * a group */
d46eb14b
SB
213 atomic_t user_waits; /* Number of tasks waiting for user
214 * response */
e61ce867 215 struct list_head marks_list; /* all inode marks for this group */
3be25f49 216
7053aee2
JK
217 struct fasync_struct *fsn_fa; /* async notification */
218
ff57cd58 219 struct fsnotify_event *overflow_event; /* Event we queue when the
7053aee2
JK
220 * notification list is too
221 * full */
d46eb14b
SB
222
223 struct mem_cgroup *memcg; /* memcg to charge allocations */
0a6b6bd5 224
90586523
EP
225 /* groups can define private fields here or use the void *private */
226 union {
227 void *private;
63c882a0
EP
228#ifdef CONFIG_INOTIFY_USER
229 struct inotify_group_private_data {
230 spinlock_t idr_lock;
231 struct idr idr;
1cce1eea 232 struct ucounts *ucounts;
63c882a0 233 } inotify_data;
9e66e423 234#endif
80af2588 235#ifdef CONFIG_FANOTIFY
9e66e423
EP
236 struct fanotify_group_private_data {
237 /* allows a group to block waiting for a userspace response */
9e66e423
EP
238 struct list_head access_list;
239 wait_queue_head_t access_waitq;
96a71f21
AG
240 int flags; /* flags from fanotify_init() */
241 int f_flags; /* event_f_flags from fanotify_init() */
e7099d8a 242 unsigned int max_marks;
4afeff85 243 struct user_struct *user;
9e66e423 244 } fanotify_data;
80af2588 245#endif /* CONFIG_FANOTIFY */
90586523
EP
246 };
247};
248
aa93bdc5
AG
249/* When calling fsnotify tell it if the data is a path or inode */
250enum fsnotify_data_type {
251 FSNOTIFY_EVENT_NONE,
252 FSNOTIFY_EVENT_PATH,
253 FSNOTIFY_EVENT_INODE,
254};
255
cbcf47ad 256static inline struct inode *fsnotify_data_inode(const void *data, int data_type)
aa93bdc5
AG
257{
258 switch (data_type) {
259 case FSNOTIFY_EVENT_INODE:
cbcf47ad 260 return (struct inode *)data;
aa93bdc5
AG
261 case FSNOTIFY_EVENT_PATH:
262 return d_inode(((const struct path *)data)->dentry);
263 default:
264 return NULL;
265 }
266}
267
268static inline const struct path *fsnotify_data_path(const void *data,
269 int data_type)
270{
271 switch (data_type) {
272 case FSNOTIFY_EVENT_PATH:
273 return data;
274 default:
275 return NULL;
276 }
277}
90586523 278
d6f7b98b
AG
279enum fsnotify_obj_type {
280 FSNOTIFY_OBJ_TYPE_INODE,
fecc4559 281 FSNOTIFY_OBJ_TYPE_PARENT,
d6f7b98b 282 FSNOTIFY_OBJ_TYPE_VFSMOUNT,
1e6cb723 283 FSNOTIFY_OBJ_TYPE_SB,
d6f7b98b
AG
284 FSNOTIFY_OBJ_TYPE_COUNT,
285 FSNOTIFY_OBJ_TYPE_DETACHED = FSNOTIFY_OBJ_TYPE_COUNT
286};
287
288#define FSNOTIFY_OBJ_TYPE_INODE_FL (1U << FSNOTIFY_OBJ_TYPE_INODE)
fecc4559 289#define FSNOTIFY_OBJ_TYPE_PARENT_FL (1U << FSNOTIFY_OBJ_TYPE_PARENT)
d6f7b98b 290#define FSNOTIFY_OBJ_TYPE_VFSMOUNT_FL (1U << FSNOTIFY_OBJ_TYPE_VFSMOUNT)
1e6cb723 291#define FSNOTIFY_OBJ_TYPE_SB_FL (1U << FSNOTIFY_OBJ_TYPE_SB)
d6f7b98b
AG
292#define FSNOTIFY_OBJ_ALL_TYPES_MASK ((1U << FSNOTIFY_OBJ_TYPE_COUNT) - 1)
293
b812a9f5
AG
294static inline bool fsnotify_valid_obj_type(unsigned int type)
295{
296 return (type < FSNOTIFY_OBJ_TYPE_COUNT);
297}
298
5b0457ad 299struct fsnotify_iter_info {
47d9c7cc 300 struct fsnotify_mark *marks[FSNOTIFY_OBJ_TYPE_COUNT];
5b0457ad
AG
301 unsigned int report_mask;
302 int srcu_idx;
303};
304
47d9c7cc
AG
305static inline bool fsnotify_iter_should_report_type(
306 struct fsnotify_iter_info *iter_info, int type)
307{
308 return (iter_info->report_mask & (1U << type));
309}
310
311static inline void fsnotify_iter_set_report_type(
312 struct fsnotify_iter_info *iter_info, int type)
313{
314 iter_info->report_mask |= (1U << type);
315}
316
317static inline void fsnotify_iter_set_report_type_mark(
318 struct fsnotify_iter_info *iter_info, int type,
319 struct fsnotify_mark *mark)
320{
321 iter_info->marks[type] = mark;
322 iter_info->report_mask |= (1U << type);
323}
324
5b0457ad
AG
325#define FSNOTIFY_ITER_FUNCS(name, NAME) \
326static inline struct fsnotify_mark *fsnotify_iter_##name##_mark( \
327 struct fsnotify_iter_info *iter_info) \
328{ \
329 return (iter_info->report_mask & FSNOTIFY_OBJ_TYPE_##NAME##_FL) ? \
47d9c7cc 330 iter_info->marks[FSNOTIFY_OBJ_TYPE_##NAME] : NULL; \
5b0457ad
AG
331}
332
333FSNOTIFY_ITER_FUNCS(inode, INODE)
fecc4559 334FSNOTIFY_ITER_FUNCS(parent, PARENT)
5b0457ad 335FSNOTIFY_ITER_FUNCS(vfsmount, VFSMOUNT)
1e6cb723 336FSNOTIFY_ITER_FUNCS(sb, SB)
5b0457ad 337
47d9c7cc
AG
338#define fsnotify_foreach_obj_type(type) \
339 for (type = 0; type < FSNOTIFY_OBJ_TYPE_COUNT; type++)
340
36f10f55
AG
341/*
342 * fsnotify_connp_t is what we embed in objects which connector can be attached
343 * to. fsnotify_connp_t * is how we refer from connector back to object.
344 */
345struct fsnotify_mark_connector;
346typedef struct fsnotify_mark_connector __rcu *fsnotify_connp_t;
347
9dd813c1 348/*
1e6cb723
AG
349 * Inode/vfsmount/sb point to this structure which tracks all marks attached to
350 * the inode/vfsmount/sb. The reference to inode/vfsmount/sb is held by this
08991e83
JK
351 * structure. We destroy this structure when there are no more marks attached
352 * to it. The structure is protected by fsnotify_mark_srcu.
9dd813c1
JK
353 */
354struct fsnotify_mark_connector {
04662cab 355 spinlock_t lock;
c285a2f0
AG
356 unsigned short type; /* Type of object [lock] */
357#define FSNOTIFY_CONN_FLAG_HAS_FSID 0x01
358 unsigned short flags; /* flags [lock] */
77115225 359 __kernel_fsid_t fsid; /* fsid of filesystem containing object */
36f10f55
AG
360 union {
361 /* Object pointer [lock] */
362 fsnotify_connp_t *obj;
08991e83
JK
363 /* Used listing heads to free after srcu period expires */
364 struct fsnotify_mark_connector *destroy_next;
365 };
d90a10e2 366 struct hlist_head list;
9dd813c1
JK
367};
368
3be25f49 369/*
1e39fc01 370 * A mark is simply an object attached to an in core inode which allows an
3be25f49
EP
371 * fsnotify listener to indicate they are either no longer interested in events
372 * of a type matching mask or only interested in those events.
373 *
1e39fc01
JK
374 * These are flushed when an inode is evicted from core and may be flushed
375 * when the inode is modified (as seen by fsnotify_access). Some fsnotify
376 * users (such as dnotify) will flush these when the open fd is closed and not
377 * at inode eviction or modification.
378 *
379 * Text in brackets is showing the lock(s) protecting modifications of a
380 * particular entry. obj_lock means either inode->i_lock or
381 * mnt->mnt_root->d_lock depending on the mark type.
3be25f49 382 */
e61ce867 383struct fsnotify_mark {
1e39fc01
JK
384 /* Mask this mark is for [mark->lock, group->mark_mutex] */
385 __u32 mask;
386 /* We hold one for presence in g_list. Also one ref for each 'thing'
3be25f49 387 * in kernel that found and may be using this mark. */
ab97f873 388 refcount_t refcnt;
1e39fc01
JK
389 /* Group this mark is for. Set on mark creation, stable until last ref
390 * is dropped */
391 struct fsnotify_group *group;
8e984f86 392 /* List of marks by group->marks_list. Also reused for queueing
1e39fc01
JK
393 * mark into destroy_list when it's waiting for the end of SRCU period
394 * before it can be freed. [group->mark_mutex] */
13d34ac6 395 struct list_head g_list;
1e39fc01
JK
396 /* Protects inode / mnt pointers, flags, masks */
397 spinlock_t lock;
6b3f05d2 398 /* List of marks for inode / vfsmount [connector->lock, mark ref] */
1e39fc01 399 struct hlist_node obj_list;
6b3f05d2 400 /* Head of list of marks for an object [mark ref] */
86ffe245 401 struct fsnotify_mark_connector *connector;
1e39fc01
JK
402 /* Events types to ignore [mark->lock, group->mark_mutex] */
403 __u32 ignored_mask;
e911d8af
JK
404#define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY 0x01
405#define FSNOTIFY_MARK_FLAG_ALIVE 0x02
406#define FSNOTIFY_MARK_FLAG_ATTACHED 0x04
1e39fc01 407 unsigned int flags; /* flags [mark->lock] */
3be25f49
EP
408};
409
90586523
EP
410#ifdef CONFIG_FSNOTIFY
411
412/* called from the vfs helpers */
413
414/* main fsnotify call to send events */
40a100d3
AG
415extern int fsnotify(__u32 mask, const void *data, int data_type,
416 struct inode *dir, const struct qstr *name,
417 struct inode *inode, u32 cookie);
71d73410 418extern int __fsnotify_parent(struct dentry *dentry, __u32 mask, const void *data,
017de65f 419 int data_type);
3be25f49 420extern void __fsnotify_inode_delete(struct inode *inode);
ca9c726e 421extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
1e6cb723 422extern void fsnotify_sb_delete(struct super_block *sb);
47882c6f 423extern u32 fsnotify_get_cookie(void);
90586523 424
9b93f331
AG
425static inline __u32 fsnotify_parent_needed_mask(__u32 mask)
426{
427 /* FS_EVENT_ON_CHILD is set on marks that want parent/name info */
428 if (!(mask & FS_EVENT_ON_CHILD))
429 return 0;
430 /*
431 * This object might be watched by a mark that cares about parent/name
432 * info, does it care about the specific set of events that can be
433 * reported with parent/name info?
434 */
435 return mask & FS_EVENTS_POSS_TO_PARENT;
436}
437
c28f7e56
EP
438static inline int fsnotify_inode_watches_children(struct inode *inode)
439{
440 /* FS_EVENT_ON_CHILD is set if the inode may care */
441 if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
442 return 0;
443 /* this inode might care about child events, does it care about the
444 * specific set of events that can happen on a child? */
445 return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
446}
447
448/*
449 * Update the dentry with a flag indicating the interest of its parent to receive
450 * filesystem events when those events happens to this dentry->d_inode.
451 */
affda484 452static inline void fsnotify_update_flags(struct dentry *dentry)
c28f7e56 453{
c28f7e56
EP
454 assert_spin_locked(&dentry->d_lock);
455
b5c84bf6
NP
456 /*
457 * Serialisation of setting PARENT_WATCHED on the dentries is provided
458 * by d_lock. If inotify_inode_watched changes after we have taken
459 * d_lock, the following __fsnotify_update_child_dentry_flags call will
460 * find our entry, so it will spin until we complete here, and update
461 * us with the new state.
462 */
affda484 463 if (fsnotify_inode_watches_children(dentry->d_parent->d_inode))
c28f7e56
EP
464 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
465 else
466 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
467}
468
90586523
EP
469/* called from fsnotify listeners, such as fanotify or dnotify */
470
98612952 471/* create a new group */
0d2e2a1d 472extern struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops);
98612952
LS
473/* get reference to a group */
474extern void fsnotify_get_group(struct fsnotify_group *group);
ffab8340 475/* drop reference on a group from fsnotify_alloc_group */
90586523 476extern void fsnotify_put_group(struct fsnotify_group *group);
12703dbf
JK
477/* group destruction begins, stop queuing new events */
478extern void fsnotify_group_stop_queueing(struct fsnotify_group *group);
d8153d4d
LS
479/* destroy group */
480extern void fsnotify_destroy_group(struct fsnotify_group *group);
0a6b6bd5
EP
481/* fasync handler function */
482extern int fsnotify_fasync(int fd, struct file *file, int on);
7053aee2
JK
483/* Free event from memory */
484extern void fsnotify_destroy_event(struct fsnotify_group *group,
485 struct fsnotify_event *event);
a2d8bc6c 486/* attach the event to the group notification queue */
8ba8fa91
JK
487extern int fsnotify_add_event(struct fsnotify_group *group,
488 struct fsnotify_event *event,
489 int (*merge)(struct list_head *,
490 struct fsnotify_event *));
7b1f6417
JK
491/* Queue overflow event to a notification group */
492static inline void fsnotify_queue_overflow(struct fsnotify_group *group)
493{
494 fsnotify_add_event(group, group->overflow_event, NULL);
495}
496
a2d8bc6c
EP
497/* true if the group notification queue is empty */
498extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
499/* return, but do not dequeue the first event on the notification queue */
8ba8fa91 500extern struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group);
e4aff117 501/* return AND dequeue the first event on the notification queue */
8ba8fa91 502extern struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group);
f7db89ac
JK
503/* Remove event queued in the notification list */
504extern void fsnotify_remove_queued_event(struct fsnotify_group *group,
505 struct fsnotify_event *event);
a2d8bc6c 506
3be25f49
EP
507/* functions used to manipulate the marks attached to inodes */
508
3ac70bfc
AG
509/* Get mask of events for a list of marks */
510extern __u32 fsnotify_conn_mask(struct fsnotify_mark_connector *conn);
a242677b
JK
511/* Calculate mask of events for a list of marks */
512extern void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn);
7b129323 513extern void fsnotify_init_mark(struct fsnotify_mark *mark,
054c636e 514 struct fsnotify_group *group);
b1362edf 515/* Find mark belonging to given group in the list of marks */
9b6e5434
AG
516extern struct fsnotify_mark *fsnotify_find_mark(fsnotify_connp_t *connp,
517 struct fsnotify_group *group);
77115225
AG
518/* Get cached fsid of filesystem containing object */
519extern int fsnotify_get_conn_fsid(const struct fsnotify_mark_connector *conn,
520 __kernel_fsid_t *fsid);
b812a9f5
AG
521/* attach the mark to the object */
522extern int fsnotify_add_mark(struct fsnotify_mark *mark,
523 fsnotify_connp_t *connp, unsigned int type,
77115225 524 int allow_dups, __kernel_fsid_t *fsid);
7b129323 525extern int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
77115225
AG
526 fsnotify_connp_t *connp,
527 unsigned int type, int allow_dups,
528 __kernel_fsid_t *fsid);
529
b249f5be
AG
530/* attach the mark to the inode */
531static inline int fsnotify_add_inode_mark(struct fsnotify_mark *mark,
532 struct inode *inode,
533 int allow_dups)
534{
b812a9f5 535 return fsnotify_add_mark(mark, &inode->i_fsnotify_marks,
77115225 536 FSNOTIFY_OBJ_TYPE_INODE, allow_dups, NULL);
b249f5be
AG
537}
538static inline int fsnotify_add_inode_mark_locked(struct fsnotify_mark *mark,
539 struct inode *inode,
540 int allow_dups)
541{
b812a9f5 542 return fsnotify_add_mark_locked(mark, &inode->i_fsnotify_marks,
77115225
AG
543 FSNOTIFY_OBJ_TYPE_INODE, allow_dups,
544 NULL);
b249f5be 545}
77115225 546
e2a29943
LS
547/* given a group and a mark, flag mark to be freed when all references are dropped */
548extern void fsnotify_destroy_mark(struct fsnotify_mark *mark,
549 struct fsnotify_group *group);
4712e722
JK
550/* detach mark from inode / mount list, group list, drop inode reference */
551extern void fsnotify_detach_mark(struct fsnotify_mark *mark);
552/* free mark */
553extern void fsnotify_free_mark(struct fsnotify_mark *mark);
b72679ee
TM
554/* Wait until all marks queued for destruction are destroyed */
555extern void fsnotify_wait_marks_destroyed(void);
86ffe245 556/* run all the marks in a group, and clear all of the marks attached to given object type */
18f2e0d3 557extern void fsnotify_clear_marks_by_group(struct fsnotify_group *group, unsigned int type);
416bcdbc
JK
558/* run all the marks in a group, and clear all of the vfsmount marks */
559static inline void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group)
560{
d6f7b98b 561 fsnotify_clear_marks_by_group(group, FSNOTIFY_OBJ_TYPE_VFSMOUNT_FL);
416bcdbc
JK
562}
563/* run all the marks in a group, and clear all of the inode marks */
564static inline void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group)
565{
d6f7b98b 566 fsnotify_clear_marks_by_group(group, FSNOTIFY_OBJ_TYPE_INODE_FL);
416bcdbc 567}
1e6cb723
AG
568/* run all the marks in a group, and clear all of the sn marks */
569static inline void fsnotify_clear_sb_marks_by_group(struct fsnotify_group *group)
570{
571 fsnotify_clear_marks_by_group(group, FSNOTIFY_OBJ_TYPE_SB_FL);
572}
841bdc10
EP
573extern void fsnotify_get_mark(struct fsnotify_mark *mark);
574extern void fsnotify_put_mark(struct fsnotify_mark *mark);
abc77577
JK
575extern void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info);
576extern bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info);
3be25f49 577
a0a92d26 578static inline void fsnotify_init_event(struct fsnotify_event *event,
dfc2d259 579 unsigned long objectid)
a0a92d26
AG
580{
581 INIT_LIST_HEAD(&event->list);
dfc2d259 582 event->objectid = objectid;
a0a92d26 583}
b4e4e140 584
90586523
EP
585#else
586
40a100d3
AG
587static inline int fsnotify(__u32 mask, const void *data, int data_type,
588 struct inode *dir, const struct qstr *name,
589 struct inode *inode, u32 cookie)
c4ec54b4
EP
590{
591 return 0;
592}
3be25f49 593
71d73410 594static inline int __fsnotify_parent(struct dentry *dentry, __u32 mask,
017de65f 595 const void *data, int data_type)
52420392
EP
596{
597 return 0;
598}
c28f7e56 599
3be25f49
EP
600static inline void __fsnotify_inode_delete(struct inode *inode)
601{}
602
ca9c726e
AG
603static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
604{}
605
1e6cb723
AG
606static inline void fsnotify_sb_delete(struct super_block *sb)
607{}
608
affda484 609static inline void fsnotify_update_flags(struct dentry *dentry)
c28f7e56
EP
610{}
611
47882c6f
EP
612static inline u32 fsnotify_get_cookie(void)
613{
614 return 0;
615}
616
74278da9 617static inline void fsnotify_unmount_inodes(struct super_block *sb)
164bc619
EP
618{}
619
90586523
EP
620#endif /* CONFIG_FSNOTIFY */
621
622#endif /* __KERNEL __ */
623
624#endif /* __LINUX_FSNOTIFY_BACKEND_H */