blob: 29f917517299fd0d4a61615d17a5045ce9826135 [file] [log] [blame]
Eric Paris90586522009-05-21 17:01:20 -04001/*
2 * Filesystem access notification for Linux
3 *
4 * Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
5 */
6
7#ifndef __LINUX_FSNOTIFY_BACKEND_H
8#define __LINUX_FSNOTIFY_BACKEND_H
9
10#ifdef __KERNEL__
11
Eric Paris63c882a2009-05-21 17:02:01 -040012#include <linux/idr.h> /* inotify uses this */
Eric Paris90586522009-05-21 17:01:20 -040013#include <linux/fs.h> /* struct inode */
14#include <linux/list.h>
15#include <linux/path.h> /* struct path */
16#include <linux/spinlock.h>
17#include <linux/types.h>
Arun Sharma600634972011-07-26 16:09:06 -070018#include <linux/atomic.h>
Eric Paris90586522009-05-21 17:01:20 -040019
20/*
21 * IN_* from inotfy.h lines up EXACTLY with FS_*, this is so we can easily
22 * convert between them. dnotify only needs conversion at watch creation
23 * so no perf loss there. fanotify isn't defined yet, so it can use the
24 * wholes if it needs more events.
25 */
26#define FS_ACCESS 0x00000001 /* File was accessed */
27#define FS_MODIFY 0x00000002 /* File was modified */
28#define FS_ATTRIB 0x00000004 /* Metadata changed */
29#define FS_CLOSE_WRITE 0x00000008 /* Writtable file was closed */
30#define FS_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */
31#define FS_OPEN 0x00000020 /* File was opened */
32#define FS_MOVED_FROM 0x00000040 /* File was moved from X */
33#define FS_MOVED_TO 0x00000080 /* File was moved to Y */
34#define FS_CREATE 0x00000100 /* Subfile was created */
35#define FS_DELETE 0x00000200 /* Subfile was deleted */
36#define FS_DELETE_SELF 0x00000400 /* Self was deleted */
37#define FS_MOVE_SELF 0x00000800 /* Self was moved */
38
39#define FS_UNMOUNT 0x00002000 /* inode on umount fs */
40#define FS_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
41#define FS_IN_IGNORED 0x00008000 /* last inotify event here */
42
Eric Parisc4ec54b2009-12-17 21:24:34 -050043#define FS_OPEN_PERM 0x00010000 /* open event in an permission hook */
44#define FS_ACCESS_PERM 0x00020000 /* access event in a permissions hook */
45
Eric Paris8c1934c2010-07-28 10:18:37 -040046#define FS_EXCL_UNLINK 0x04000000 /* do not send events if object is unlinked */
Eric Parisb29866a2010-10-28 17:21:58 -040047#define FS_ISDIR 0x40000000 /* event occurred against dir */
Eric Paris90586522009-05-21 17:01:20 -040048#define FS_IN_ONESHOT 0x80000000 /* only send event once */
49
50#define FS_DN_RENAME 0x10000000 /* file renamed */
51#define FS_DN_MULTISHOT 0x20000000 /* dnotify multishot */
52
Eric Parisc28f7e52009-05-21 17:01:29 -040053/* This inode cares about things that happen to its children. Always set for
54 * dnotify and inotify. */
55#define FS_EVENT_ON_CHILD 0x08000000
56
57/* This is a list of all events that may get sent to a parernt based on fs event
58 * happening to inodes inside that directory */
59#define FS_EVENTS_POSS_ON_CHILD (FS_ACCESS | FS_MODIFY | FS_ATTRIB |\
60 FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN |\
61 FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE |\
Naohiro Aotaa4f9a9a2012-05-29 11:02:24 -070062 FS_DELETE | FS_OPEN_PERM | FS_ACCESS_PERM)
Eric Parisc28f7e52009-05-21 17:01:29 -040063
Eric Parise9fd7022009-12-17 20:12:04 -050064#define FS_MOVE (FS_MOVED_FROM | FS_MOVED_TO)
65
Eric Parisff8bcbd2010-10-28 17:21:56 -040066#define ALL_FSNOTIFY_PERM_EVENTS (FS_OPEN_PERM | FS_ACCESS_PERM)
67
Eric Paris20dee622010-07-28 10:18:37 -040068#define ALL_FSNOTIFY_EVENTS (FS_ACCESS | FS_MODIFY | FS_ATTRIB | \
69 FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN | \
70 FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE | \
71 FS_DELETE | FS_DELETE_SELF | FS_MOVE_SELF | \
72 FS_UNMOUNT | FS_Q_OVERFLOW | FS_IN_IGNORED | \
73 FS_OPEN_PERM | FS_ACCESS_PERM | FS_EXCL_UNLINK | \
Eric Parisb29866a2010-10-28 17:21:58 -040074 FS_ISDIR | FS_IN_ONESHOT | FS_DN_RENAME | \
Eric Paris20dee622010-07-28 10:18:37 -040075 FS_DN_MULTISHOT | FS_EVENT_ON_CHILD)
76
Eric Paris90586522009-05-21 17:01:20 -040077struct fsnotify_group;
78struct fsnotify_event;
Eric Parise61ce862009-12-17 21:24:24 -050079struct fsnotify_mark;
Eric Parise4aff112009-05-21 17:01:50 -040080struct fsnotify_event_private_data;
Jan Kara7053aee2014-01-21 15:48:14 -080081struct fsnotify_fname;
Eric Paris90586522009-05-21 17:01:20 -040082
83/*
84 * Each group much define these ops. The fsnotify infrastructure will call
85 * these operations for each relevant group.
86 *
87 * handle_event - main call for a group to handle an fs event
88 * free_group_priv - called when a group refcnt hits 0 to clean up the private union
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +020089 * freeing_mark - called when a mark is being destroyed for some reason. The group
90 * MUST be holding a reference on each mark and that reference must be
91 * dropped in this function. inotify uses this function to send
92 * userspace messages that marks have been removed.
Eric Paris90586522009-05-21 17:01:20 -040093 */
94struct fsnotify_ops {
Eric Parisce8f76f2010-07-28 10:18:39 -040095 int (*handle_event)(struct fsnotify_group *group,
Jan Kara7053aee2014-01-21 15:48:14 -080096 struct inode *inode,
Eric Parisce8f76f2010-07-28 10:18:39 -040097 struct fsnotify_mark *inode_mark,
98 struct fsnotify_mark *vfsmount_mark,
Jan Kara7053aee2014-01-21 15:48:14 -080099 u32 mask, void *data, int data_type,
Jan Kara45a22f42014-02-17 13:09:50 +0100100 const unsigned char *file_name, u32 cookie);
Eric Paris90586522009-05-21 17:01:20 -0400101 void (*free_group_priv)(struct fsnotify_group *group);
Eric Paris841bdc12009-12-17 21:24:24 -0500102 void (*freeing_mark)(struct fsnotify_mark *mark, struct fsnotify_group *group);
Jan Kara7053aee2014-01-21 15:48:14 -0800103 void (*free_event)(struct fsnotify_event *event);
104};
105
106/*
107 * all of the information about the original object we want to now send to
108 * a group. If you want to carry more info from the accessing task to the
109 * listener this structure is where you need to be adding fields.
110 */
111struct fsnotify_event {
112 struct list_head list;
113 /* inode may ONLY be dereferenced during handle_event(). */
114 struct inode *inode; /* either the inode the event happened to or its parent */
115 u32 mask; /* the type of access, bitwise OR for FS_* event types */
Eric Paris90586522009-05-21 17:01:20 -0400116};
117
118/*
119 * A group is a "thing" that wants to receive notification about filesystem
120 * events. The mask holds the subset of event types this group cares about.
121 * refcnt on a group is up to the implementor and at any moment if it goes 0
122 * everything will be cleaned up.
123 */
124struct fsnotify_group {
125 /*
Eric Paris90586522009-05-21 17:01:20 -0400126 * How the refcnt is used is up to each group. When the refcnt hits 0
127 * fsnotify will clean up all of the resources associated with this group.
128 * As an example, the dnotify group will always have a refcnt=1 and that
129 * will never change. Inotify, on the other hand, has a group per
130 * inotify_init() and the refcnt will hit 0 only when that fd has been
131 * closed.
132 */
133 atomic_t refcnt; /* things with interest in this group */
Eric Paris90586522009-05-21 17:01:20 -0400134
135 const struct fsnotify_ops *ops; /* how this group handles things */
136
Eric Parisa2d8bc62009-05-21 17:01:37 -0400137 /* needed to send notification to userspace */
138 struct mutex notification_mutex; /* protect the notification_list */
139 struct list_head notification_list; /* list of event_holder this group needs to send to userspace */
140 wait_queue_head_t notification_waitq; /* read() on the notification file blocks on this waitq */
141 unsigned int q_len; /* events on the queue */
142 unsigned int max_events; /* maximum events allowed on the list */
Eric Paris6ad2d4e2010-10-28 17:21:56 -0400143 /*
144 * Valid fsnotify group priorities. Events are send in order from highest
145 * priority to lowest priority. We default to the lowest priority.
146 */
147 #define FS_PRIO_0 0 /* normal notifiers, no permissions */
148 #define FS_PRIO_1 1 /* fanotify content based access control */
149 #define FS_PRIO_2 2 /* fanotify pre-content access */
150 unsigned int priority;
Eric Parisa2d8bc62009-05-21 17:01:37 -0400151
Eric Parise61ce862009-12-17 21:24:24 -0500152 /* stores all fastpath marks assoc with this group so they can be cleaned on unregister */
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200153 struct mutex mark_mutex; /* protect marks_list */
Eric Paris841bdc12009-12-17 21:24:24 -0500154 atomic_t num_marks; /* 1 for each mark and 1 for not being
Eric Paris3be25f42009-05-21 17:01:26 -0400155 * past the point of no return when freeing
156 * a group */
Eric Parise61ce862009-12-17 21:24:24 -0500157 struct list_head marks_list; /* all inode marks for this group */
Eric Paris3be25f42009-05-21 17:01:26 -0400158
Jan Kara7053aee2014-01-21 15:48:14 -0800159 struct fasync_struct *fsn_fa; /* async notification */
160
Jan Karaff57cd52014-02-21 19:14:11 +0100161 struct fsnotify_event *overflow_event; /* Event we queue when the
Jan Kara7053aee2014-01-21 15:48:14 -0800162 * notification list is too
163 * full */
Eric Paris0a6b6bd2011-10-14 17:43:39 -0400164
Eric Paris90586522009-05-21 17:01:20 -0400165 /* groups can define private fields here or use the void *private */
166 union {
167 void *private;
Eric Paris63c882a2009-05-21 17:02:01 -0400168#ifdef CONFIG_INOTIFY_USER
169 struct inotify_group_private_data {
170 spinlock_t idr_lock;
171 struct idr idr;
Eric Paris63c882a2009-05-21 17:02:01 -0400172 struct user_struct *user;
173 } inotify_data;
174#endif
Eric Paris80af2582010-07-28 10:18:37 -0400175#ifdef CONFIG_FANOTIFY
Eric Paris9e66e422009-12-17 21:24:34 -0500176 struct fanotify_group_private_data {
Eric Paris80af2582010-07-28 10:18:37 -0400177#ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
Eric Paris9e66e422009-12-17 21:24:34 -0500178 /* allows a group to block waiting for a userspace response */
Jan Kara9573f792014-04-03 14:46:34 -0700179 spinlock_t access_lock;
Eric Paris9e66e422009-12-17 21:24:34 -0500180 struct list_head access_list;
181 wait_queue_head_t access_waitq;
Lino Sanfilippo09e5f142010-11-19 10:58:07 +0100182 atomic_t bypass_perm;
Eric Paris80af2582010-07-28 10:18:37 -0400183#endif /* CONFIG_FANOTIFY_ACCESS_PERMISSIONS */
184 int f_flags;
Eric Parise7099d82010-10-28 17:21:57 -0400185 unsigned int max_marks;
Eric Paris4afeff82010-10-28 17:21:58 -0400186 struct user_struct *user;
Eric Paris9e66e422009-12-17 21:24:34 -0500187 } fanotify_data;
Eric Paris80af2582010-07-28 10:18:37 -0400188#endif /* CONFIG_FANOTIFY */
Eric Paris90586522009-05-21 17:01:20 -0400189 };
190};
191
Eric Paris90586522009-05-21 17:01:20 -0400192/* when calling fsnotify tell it if the data is a path or inode */
193#define FSNOTIFY_EVENT_NONE 0
Linus Torvalds20696012010-08-12 14:23:04 -0700194#define FSNOTIFY_EVENT_PATH 1
Eric Paris90586522009-05-21 17:01:20 -0400195#define FSNOTIFY_EVENT_INODE 2
Eric Paris90586522009-05-21 17:01:20 -0400196
Eric Paris3be25f42009-05-21 17:01:26 -0400197/*
Jan Kara1e39fc02015-09-04 15:43:06 -0700198 * A mark is simply an object attached to an in core inode which allows an
Eric Paris3be25f42009-05-21 17:01:26 -0400199 * fsnotify listener to indicate they are either no longer interested in events
200 * of a type matching mask or only interested in those events.
201 *
Jan Kara1e39fc02015-09-04 15:43:06 -0700202 * These are flushed when an inode is evicted from core and may be flushed
203 * when the inode is modified (as seen by fsnotify_access). Some fsnotify
204 * users (such as dnotify) will flush these when the open fd is closed and not
205 * at inode eviction or modification.
206 *
207 * Text in brackets is showing the lock(s) protecting modifications of a
208 * particular entry. obj_lock means either inode->i_lock or
209 * mnt->mnt_root->d_lock depending on the mark type.
Eric Paris3be25f42009-05-21 17:01:26 -0400210 */
Eric Parise61ce862009-12-17 21:24:24 -0500211struct fsnotify_mark {
Jan Kara1e39fc02015-09-04 15:43:06 -0700212 /* Mask this mark is for [mark->lock, group->mark_mutex] */
213 __u32 mask;
214 /* We hold one for presence in g_list. Also one ref for each 'thing'
Eric Paris3be25f42009-05-21 17:01:26 -0400215 * in kernel that found and may be using this mark. */
Jan Kara1e39fc02015-09-04 15:43:06 -0700216 atomic_t refcnt;
217 /* Group this mark is for. Set on mark creation, stable until last ref
218 * is dropped */
219 struct fsnotify_group *group;
220 /* List of marks by group->i_fsnotify_marks. Also reused for queueing
221 * mark into destroy_list when it's waiting for the end of SRCU period
222 * before it can be freed. [group->mark_mutex] */
Jeff Layton13d34ac2016-02-17 13:11:18 -0800223 struct list_head g_list;
Jan Kara1e39fc02015-09-04 15:43:06 -0700224 /* Protects inode / mnt pointers, flags, masks */
225 spinlock_t lock;
226 /* List of marks for inode / vfsmount [obj_lock] */
227 struct hlist_node obj_list;
Jan Kara1e39fc02015-09-04 15:43:06 -0700228 union { /* Object pointer [mark->lock, group->mark_mutex] */
Jan Kara0809ab62014-12-12 16:58:36 -0800229 struct inode *inode; /* inode this mark is associated with */
230 struct vfsmount *mnt; /* vfsmount this mark is associated with */
Eric Paris2823e042009-12-17 21:24:23 -0500231 };
Jan Kara1e39fc02015-09-04 15:43:06 -0700232 /* Events types to ignore [mark->lock, group->mark_mutex] */
233 __u32 ignored_mask;
Eric Paris90b1e7a2009-12-17 21:24:33 -0500234#define FSNOTIFY_MARK_FLAG_INODE 0x01
235#define FSNOTIFY_MARK_FLAG_VFSMOUNT 0x02
236#define FSNOTIFY_MARK_FLAG_OBJECT_PINNED 0x04
Eric Parisc9083702009-12-17 21:24:33 -0500237#define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY 0x08
Eric Paris700307a2010-07-28 10:18:38 -0400238#define FSNOTIFY_MARK_FLAG_ALIVE 0x10
Jan Kara4712e7222015-09-04 15:43:12 -0700239#define FSNOTIFY_MARK_FLAG_ATTACHED 0x20
Jan Kara1e39fc02015-09-04 15:43:06 -0700240 unsigned int flags; /* flags [mark->lock] */
Eric Paris841bdc12009-12-17 21:24:24 -0500241 void (*free_mark)(struct fsnotify_mark *mark); /* called on final put+free */
Eric Paris3be25f42009-05-21 17:01:26 -0400242};
243
Eric Paris90586522009-05-21 17:01:20 -0400244#ifdef CONFIG_FSNOTIFY
245
246/* called from the vfs helpers */
247
248/* main fsnotify call to send events */
Eric Parisc4ec54b2009-12-17 21:24:34 -0500249extern int fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
250 const unsigned char *name, u32 cookie);
Eric Paris52420392010-10-28 17:21:56 -0400251extern int __fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask);
Eric Paris3be25f42009-05-21 17:01:26 -0400252extern void __fsnotify_inode_delete(struct inode *inode);
Andreas Gruenbacherca9c7262009-12-17 21:24:27 -0500253extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
Eric Paris47882c62009-05-21 17:01:47 -0400254extern u32 fsnotify_get_cookie(void);
Eric Paris90586522009-05-21 17:01:20 -0400255
Eric Parisc28f7e52009-05-21 17:01:29 -0400256static inline int fsnotify_inode_watches_children(struct inode *inode)
257{
258 /* FS_EVENT_ON_CHILD is set if the inode may care */
259 if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
260 return 0;
261 /* this inode might care about child events, does it care about the
262 * specific set of events that can happen on a child? */
263 return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
264}
265
266/*
267 * Update the dentry with a flag indicating the interest of its parent to receive
268 * filesystem events when those events happens to this dentry->d_inode.
269 */
270static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
271{
272 struct dentry *parent;
273
Eric Parisc28f7e52009-05-21 17:01:29 -0400274 assert_spin_locked(&dentry->d_lock);
275
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100276 /*
277 * Serialisation of setting PARENT_WATCHED on the dentries is provided
278 * by d_lock. If inotify_inode_watched changes after we have taken
279 * d_lock, the following __fsnotify_update_child_dentry_flags call will
280 * find our entry, so it will spin until we complete here, and update
281 * us with the new state.
282 */
Eric Parisc28f7e52009-05-21 17:01:29 -0400283 parent = dentry->d_parent;
Jeremy Kerre6ce3062009-06-29 14:31:58 +0800284 if (parent->d_inode && fsnotify_inode_watches_children(parent->d_inode))
Eric Parisc28f7e52009-05-21 17:01:29 -0400285 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
286 else
287 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
288}
289
290/*
291 * fsnotify_d_instantiate - instantiate a dentry for inode
Eric Parisc28f7e52009-05-21 17:01:29 -0400292 */
Al Viro27f203f2016-03-09 17:58:49 -0500293static inline void __fsnotify_d_instantiate(struct dentry *dentry)
Eric Parisc28f7e52009-05-21 17:01:29 -0400294{
Eric Parisc28f7e52009-05-21 17:01:29 -0400295 __fsnotify_update_dcache_flags(dentry);
Eric Parisc28f7e52009-05-21 17:01:29 -0400296}
Eric Paris90586522009-05-21 17:01:20 -0400297
298/* called from fsnotify listeners, such as fanotify or dnotify */
299
Lino Sanfilippo98612952011-06-14 17:29:46 +0200300/* create a new group */
Eric Paris0d2e2a12009-12-17 21:24:22 -0500301extern struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops);
Lino Sanfilippo98612952011-06-14 17:29:46 +0200302/* get reference to a group */
303extern void fsnotify_get_group(struct fsnotify_group *group);
Eric Parisffab8342009-12-17 21:24:22 -0500304/* drop reference on a group from fsnotify_alloc_group */
Eric Paris90586522009-05-21 17:01:20 -0400305extern void fsnotify_put_group(struct fsnotify_group *group);
Lino Sanfilippod8153d42011-06-14 17:29:45 +0200306/* destroy group */
307extern void fsnotify_destroy_group(struct fsnotify_group *group);
Eric Paris0a6b6bd2011-10-14 17:43:39 -0400308/* fasync handler function */
309extern int fsnotify_fasync(int fd, struct file *file, int on);
Jan Kara7053aee2014-01-21 15:48:14 -0800310/* Free event from memory */
311extern void fsnotify_destroy_event(struct fsnotify_group *group,
312 struct fsnotify_event *event);
Eric Parisa2d8bc62009-05-21 17:01:37 -0400313/* attach the event to the group notification queue */
Jan Kara8ba8fa912014-08-06 16:03:26 -0700314extern int fsnotify_add_event(struct fsnotify_group *group,
315 struct fsnotify_event *event,
316 int (*merge)(struct list_head *,
317 struct fsnotify_event *));
Jan Kara5838d442014-08-06 16:03:28 -0700318/* Remove passed event from groups notification queue */
319extern void fsnotify_remove_event(struct fsnotify_group *group, struct fsnotify_event *event);
Eric Parisa2d8bc62009-05-21 17:01:37 -0400320/* true if the group notification queue is empty */
321extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
322/* return, but do not dequeue the first event on the notification queue */
Jan Kara8ba8fa912014-08-06 16:03:26 -0700323extern struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group);
Eric Parise4aff112009-05-21 17:01:50 -0400324/* return AND dequeue the first event on the notification queue */
Jan Kara8ba8fa912014-08-06 16:03:26 -0700325extern struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group);
Eric Parisa2d8bc62009-05-21 17:01:37 -0400326
Eric Paris3be25f42009-05-21 17:01:26 -0400327/* functions used to manipulate the marks attached to inodes */
328
Eric Paris0d48b7f2009-12-17 21:24:27 -0500329/* run all marks associated with a vfsmount and update mnt->mnt_fsnotify_mask */
330extern void fsnotify_recalc_vfsmount_mask(struct vfsmount *mnt);
Eric Paris3be25f42009-05-21 17:01:26 -0400331/* run all marks associated with an inode and update inode->i_fsnotify_mask */
332extern void fsnotify_recalc_inode_mask(struct inode *inode);
Eric Paris841bdc12009-12-17 21:24:24 -0500333extern void fsnotify_init_mark(struct fsnotify_mark *mark, void (*free_mark)(struct fsnotify_mark *mark));
Eric Paris3be25f42009-05-21 17:01:26 -0400334/* find (and take a reference) to a mark associated with group and inode */
Eric Paris5444e292009-12-17 21:24:27 -0500335extern struct fsnotify_mark *fsnotify_find_inode_mark(struct fsnotify_group *group, struct inode *inode);
Eric Paris1c529062009-12-17 21:24:28 -0500336/* find (and take a reference) to a mark associated with group and vfsmount */
337extern struct fsnotify_mark *fsnotify_find_vfsmount_mark(struct fsnotify_group *group, struct vfsmount *mnt);
Eric Paris9e1c7432009-12-17 20:12:05 -0500338/* copy the values from old into new */
Eric Parise61ce862009-12-17 21:24:24 -0500339extern void fsnotify_duplicate_mark(struct fsnotify_mark *new, struct fsnotify_mark *old);
Eric Paris33af5e32009-12-17 21:24:33 -0500340/* set the ignored_mask of a mark */
341extern void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask);
Eric Paris90b1e7a2009-12-17 21:24:33 -0500342/* set the mask of a mark (might pin the object into memory */
343extern void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask);
Eric Paris3be25f42009-05-21 17:01:26 -0400344/* attach the mark to both the group and the inode */
Eric Paris5444e292009-12-17 21:24:27 -0500345extern int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
346 struct inode *inode, struct vfsmount *mnt, int allow_dups);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200347extern int fsnotify_add_mark_locked(struct fsnotify_mark *mark, struct fsnotify_group *group,
348 struct inode *inode, struct vfsmount *mnt, int allow_dups);
Lino Sanfilippoe2a29942011-06-14 17:29:51 +0200349/* given a group and a mark, flag mark to be freed when all references are dropped */
350extern void fsnotify_destroy_mark(struct fsnotify_mark *mark,
351 struct fsnotify_group *group);
Jan Kara4712e7222015-09-04 15:43:12 -0700352/* detach mark from inode / mount list, group list, drop inode reference */
353extern void fsnotify_detach_mark(struct fsnotify_mark *mark);
354/* free mark */
355extern void fsnotify_free_mark(struct fsnotify_mark *mark);
Eric Paris4d926042009-12-17 21:24:34 -0500356/* run all the marks in a group, and clear all of the vfsmount marks */
357extern void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group);
358/* run all the marks in a group, and clear all of the inode marks */
359extern void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group);
360/* run all the marks in a group, and clear all of the marks where mark->flags & flags is true*/
361extern void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group, unsigned int flags);
Eric Paris841bdc12009-12-17 21:24:24 -0500362extern void fsnotify_get_mark(struct fsnotify_mark *mark);
363extern void fsnotify_put_mark(struct fsnotify_mark *mark);
Dave Chinner74278da2015-03-04 12:37:22 -0500364extern void fsnotify_unmount_inodes(struct super_block *sb);
Eric Paris3be25f42009-05-21 17:01:26 -0400365
Eric Paris90586522009-05-21 17:01:20 -0400366/* put here because inotify does some weird stuff when destroying watches */
Jan Kara7053aee2014-01-21 15:48:14 -0800367extern void fsnotify_init_event(struct fsnotify_event *event,
368 struct inode *to_tell, u32 mask);
Eric Parisb4e4e142009-12-17 21:24:21 -0500369
Eric Paris90586522009-05-21 17:01:20 -0400370#else
371
Eric Parisc4ec54b2009-12-17 21:24:34 -0500372static inline int fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
373 const unsigned char *name, u32 cookie)
374{
375 return 0;
376}
Eric Paris3be25f42009-05-21 17:01:26 -0400377
Eric Paris52420392010-10-28 17:21:56 -0400378static inline int __fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask)
379{
380 return 0;
381}
Eric Parisc28f7e52009-05-21 17:01:29 -0400382
Eric Paris3be25f42009-05-21 17:01:26 -0400383static inline void __fsnotify_inode_delete(struct inode *inode)
384{}
385
Andreas Gruenbacherca9c7262009-12-17 21:24:27 -0500386static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
387{}
388
Eric Parisc28f7e52009-05-21 17:01:29 -0400389static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
390{}
391
Al Viro27f203f2016-03-09 17:58:49 -0500392static inline void __fsnotify_d_instantiate(struct dentry *dentry)
Eric Parisc28f7e52009-05-21 17:01:29 -0400393{}
394
Eric Paris47882c62009-05-21 17:01:47 -0400395static inline u32 fsnotify_get_cookie(void)
396{
397 return 0;
398}
399
Dave Chinner74278da2015-03-04 12:37:22 -0500400static inline void fsnotify_unmount_inodes(struct super_block *sb)
Eric Paris164bc612009-05-21 17:01:58 -0400401{}
402
Eric Paris90586522009-05-21 17:01:20 -0400403#endif /* CONFIG_FSNOTIFY */
404
405#endif /* __KERNEL __ */
406
407#endif /* __LINUX_FSNOTIFY_BACKEND_H */