blob: 0fbfb4646d1b0e98542908415eef69205e554642 [file] [log] [blame]
Robert Love0eeca282005-07-12 17:06:03 -04001#ifndef _LINUX_FS_NOTIFY_H
2#define _LINUX_FS_NOTIFY_H
3
4/*
5 * include/linux/fsnotify.h - generic hooks for filesystem notification, to
6 * reduce in-source duplication from both dnotify and inotify.
7 *
8 * We don't compile any of this away in some complicated menagerie of ifdefs.
9 * Instead, we rely on the code inside to optimize away as needed.
10 *
11 * (C) Copyright 2005 Robert Love
12 */
13
Eric Paris90586522009-05-21 17:01:20 -040014#include <linux/fsnotify_backend.h>
Amy Griffis73241cc2005-11-03 16:00:25 +000015#include <linux/audit.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090016#include <linux/slab.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050017#include <linux/bug.h>
Robert Love0eeca282005-07-12 17:06:03 -040018
19/*
Nick Pigginc32ccd82006-03-25 03:07:09 -080020 * fsnotify_d_instantiate - instantiate a dentry for inode
Nick Pigginc32ccd82006-03-25 03:07:09 -080021 */
Eric Parise61ce862009-12-17 21:24:24 -050022static inline void fsnotify_d_instantiate(struct dentry *dentry,
23 struct inode *inode)
Nick Pigginc32ccd82006-03-25 03:07:09 -080024{
Eric Parise61ce862009-12-17 21:24:24 -050025 __fsnotify_d_instantiate(dentry, inode);
Nick Pigginc32ccd82006-03-25 03:07:09 -080026}
27
Eric Parisc28f7e52009-05-21 17:01:29 -040028/* Notify this dentry's parent about a child's events. */
Eric Paris52420392010-10-28 17:21:56 -040029static inline int fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask)
Eric Parisc28f7e52009-05-21 17:01:29 -040030{
Andreas Gruenbacher72acc852009-12-17 21:24:24 -050031 if (!dentry)
Linus Torvalds20696012010-08-12 14:23:04 -070032 dentry = path->dentry;
Eric Paris28c60e32009-12-17 21:24:21 -050033
Eric Paris52420392010-10-28 17:21:56 -040034 return __fsnotify_parent(path, dentry, mask);
Eric Parisc28f7e52009-05-21 17:01:29 -040035}
36
Eric Parisc4ec54b2009-12-17 21:24:34 -050037/* simple call site for access decisions */
38static inline int fsnotify_perm(struct file *file, int mask)
39{
Linus Torvalds20696012010-08-12 14:23:04 -070040 struct path *path = &file->f_path;
41 struct inode *inode = path->dentry->d_inode;
Eric Parisfb1cfb82010-05-12 11:42:29 -040042 __u32 fsnotify_mask = 0;
Eric Paris52420392010-10-28 17:21:56 -040043 int ret;
Eric Parisc4ec54b2009-12-17 21:24:34 -050044
45 if (file->f_mode & FMODE_NONOTIFY)
46 return 0;
47 if (!(mask & (MAY_READ | MAY_OPEN)))
48 return 0;
Eric Parisc4ec54b2009-12-17 21:24:34 -050049 if (mask & MAY_OPEN)
50 fsnotify_mask = FS_OPEN_PERM;
Eric Parisfb1cfb82010-05-12 11:42:29 -040051 else if (mask & MAY_READ)
52 fsnotify_mask = FS_ACCESS_PERM;
53 else
54 BUG();
Eric Parisc4ec54b2009-12-17 21:24:34 -050055
Eric Paris52420392010-10-28 17:21:56 -040056 ret = fsnotify_parent(path, NULL, fsnotify_mask);
57 if (ret)
58 return ret;
59
Linus Torvalds20696012010-08-12 14:23:04 -070060 return fsnotify(inode, fsnotify_mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
Eric Parisc4ec54b2009-12-17 21:24:34 -050061}
62
Nick Pigginc32ccd82006-03-25 03:07:09 -080063/*
Eric Parise61ce862009-12-17 21:24:24 -050064 * fsnotify_d_move - dentry has been moved
Nick Pigginc32ccd82006-03-25 03:07:09 -080065 */
Eric Parise61ce862009-12-17 21:24:24 -050066static inline void fsnotify_d_move(struct dentry *dentry)
Nick Pigginc32ccd82006-03-25 03:07:09 -080067{
Eric Parisc28f7e52009-05-21 17:01:29 -040068 /*
Eric Parise61ce862009-12-17 21:24:24 -050069 * On move we need to update dentry->d_flags to indicate if the new parent
70 * cares about events from this dentry.
Eric Parisc28f7e52009-05-21 17:01:29 -040071 */
Eric Parise61ce862009-12-17 21:24:24 -050072 __fsnotify_update_dcache_flags(dentry);
Nick Pigginc32ccd82006-03-25 03:07:09 -080073}
74
75/*
Eric Paris90586522009-05-21 17:01:20 -040076 * fsnotify_link_count - inode's link count changed
77 */
78static inline void fsnotify_link_count(struct inode *inode)
79{
Eric Paris47882c62009-05-21 17:01:47 -040080 fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
Eric Paris90586522009-05-21 17:01:20 -040081}
82
83/*
Robert Love0eeca282005-07-12 17:06:03 -040084 * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
85 */
86static inline void fsnotify_move(struct inode *old_dir, struct inode *new_dir,
Eric Paris59b0df22010-02-08 12:53:52 -050087 const unsigned char *old_name,
Al Viro5a190ae2007-06-07 12:19:32 -040088 int isdir, struct inode *target, struct dentry *moved)
Robert Love0eeca282005-07-12 17:06:03 -040089{
Al Viro5a190ae2007-06-07 12:19:32 -040090 struct inode *source = moved->d_inode;
Eric Paris47882c62009-05-21 17:01:47 -040091 u32 fs_cookie = fsnotify_get_cookie();
Eric Parisff52cc22009-06-11 11:09:47 -040092 __u32 old_dir_mask = (FS_EVENT_ON_CHILD | FS_MOVED_FROM);
93 __u32 new_dir_mask = (FS_EVENT_ON_CHILD | FS_MOVED_TO);
Eric Paris59b0df22010-02-08 12:53:52 -050094 const unsigned char *new_name = moved->d_name.name;
Robert Love0eeca282005-07-12 17:06:03 -040095
Eric Parisff52cc22009-06-11 11:09:47 -040096 if (old_dir == new_dir)
97 old_dir_mask |= FS_DN_RENAME;
Robert Love0eeca282005-07-12 17:06:03 -040098
Eric Paris90586522009-05-21 17:01:20 -040099 if (isdir) {
Eric Parisb29866a2010-10-28 17:21:58 -0400100 old_dir_mask |= FS_ISDIR;
101 new_dir_mask |= FS_ISDIR;
Eric Paris90586522009-05-21 17:01:20 -0400102 }
103
Eric Paris47882c62009-05-21 17:01:47 -0400104 fsnotify(old_dir, old_dir_mask, old_dir, FSNOTIFY_EVENT_INODE, old_name, fs_cookie);
105 fsnotify(new_dir, new_dir_mask, new_dir, FSNOTIFY_EVENT_INODE, new_name, fs_cookie);
Eric Paris90586522009-05-21 17:01:20 -0400106
Eric Paris2dfc1ca2009-12-17 20:30:52 -0500107 if (target)
Eric Paris90586522009-05-21 17:01:20 -0400108 fsnotify_link_count(target);
John McCutchan89204c42005-08-15 12:13:28 -0400109
Eric Paris2dfc1ca2009-12-17 20:30:52 -0500110 if (source)
Eric Paris47882c62009-05-21 17:01:47 -0400111 fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE, NULL, 0);
Jeff Layton4fa6b5e2012-10-10 15:25:25 -0400112 audit_inode_child(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
Robert Love0eeca282005-07-12 17:06:03 -0400113}
114
115/*
Eric Paris3be25f42009-05-21 17:01:26 -0400116 * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
117 */
118static inline void fsnotify_inode_delete(struct inode *inode)
119{
120 __fsnotify_inode_delete(inode);
121}
122
123/*
Andreas Gruenbacherca9c7262009-12-17 21:24:27 -0500124 * fsnotify_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
125 */
126static inline void fsnotify_vfsmount_delete(struct vfsmount *mnt)
127{
128 __fsnotify_vfsmount_delete(mnt);
129}
130
131/*
John McCutchan7a91bf72005-08-08 13:52:16 -0400132 * fsnotify_nameremove - a filename was removed from a directory
133 */
134static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
135{
Eric Paris90586522009-05-21 17:01:20 -0400136 __u32 mask = FS_DELETE;
137
John McCutchan7a91bf72005-08-08 13:52:16 -0400138 if (isdir)
Eric Parisb29866a2010-10-28 17:21:58 -0400139 mask |= FS_ISDIR;
Eric Parisc28f7e52009-05-21 17:01:29 -0400140
Eric Paris28c60e32009-12-17 21:24:21 -0500141 fsnotify_parent(NULL, dentry, mask);
John McCutchan7a91bf72005-08-08 13:52:16 -0400142}
143
144/*
145 * fsnotify_inoderemove - an inode is going away
146 */
147static inline void fsnotify_inoderemove(struct inode *inode)
148{
Eric Paris47882c62009-05-21 17:01:47 -0400149 fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
Eric Paris3be25f42009-05-21 17:01:26 -0400150 __fsnotify_inode_delete(inode);
Jan Karaece95912008-02-06 01:37:13 -0800151}
152
153/*
Robert Love0eeca282005-07-12 17:06:03 -0400154 * fsnotify_create - 'name' was linked in
155 */
Amy Griffisf38aa942005-11-03 15:57:06 +0000156static inline void fsnotify_create(struct inode *inode, struct dentry *dentry)
Robert Love0eeca282005-07-12 17:06:03 -0400157{
Jeff Layton4fa6b5e2012-10-10 15:25:25 -0400158 audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
Eric Paris90586522009-05-21 17:01:20 -0400159
Eric Paris47882c62009-05-21 17:01:47 -0400160 fsnotify(inode, FS_CREATE, dentry->d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
Robert Love0eeca282005-07-12 17:06:03 -0400161}
162
163/*
Jan Karaece95912008-02-06 01:37:13 -0800164 * fsnotify_link - new hardlink in 'inode' directory
165 * Note: We have to pass also the linked inode ptr as some filesystems leave
166 * new_dentry->d_inode NULL and instantiate inode pointer later
167 */
168static inline void fsnotify_link(struct inode *dir, struct inode *inode, struct dentry *new_dentry)
169{
Jan Karaece95912008-02-06 01:37:13 -0800170 fsnotify_link_count(inode);
Jeff Layton4fa6b5e2012-10-10 15:25:25 -0400171 audit_inode_child(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);
Eric Paris90586522009-05-21 17:01:20 -0400172
Eric Paris47882c62009-05-21 17:01:47 -0400173 fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE, new_dentry->d_name.name, 0);
Jan Karaece95912008-02-06 01:37:13 -0800174}
175
176/*
Robert Love0eeca282005-07-12 17:06:03 -0400177 * fsnotify_mkdir - directory 'name' was created
178 */
Amy Griffisf38aa942005-11-03 15:57:06 +0000179static inline void fsnotify_mkdir(struct inode *inode, struct dentry *dentry)
Robert Love0eeca282005-07-12 17:06:03 -0400180{
Eric Parisb29866a2010-10-28 17:21:58 -0400181 __u32 mask = (FS_CREATE | FS_ISDIR);
Eric Paris90586522009-05-21 17:01:20 -0400182 struct inode *d_inode = dentry->d_inode;
183
Jeff Layton4fa6b5e2012-10-10 15:25:25 -0400184 audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
Eric Paris90586522009-05-21 17:01:20 -0400185
Eric Paris47882c62009-05-21 17:01:47 -0400186 fsnotify(inode, mask, d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
Robert Love0eeca282005-07-12 17:06:03 -0400187}
188
189/*
190 * fsnotify_access - file was read
191 */
Eric Paris2a12a9d2009-12-17 21:24:21 -0500192static inline void fsnotify_access(struct file *file)
Robert Love0eeca282005-07-12 17:06:03 -0400193{
Linus Torvalds20696012010-08-12 14:23:04 -0700194 struct path *path = &file->f_path;
195 struct inode *inode = path->dentry->d_inode;
Eric Paris90586522009-05-21 17:01:20 -0400196 __u32 mask = FS_ACCESS;
Robert Love0eeca282005-07-12 17:06:03 -0400197
198 if (S_ISDIR(inode->i_mode))
Eric Parisb29866a2010-10-28 17:21:58 -0400199 mask |= FS_ISDIR;
Robert Love0eeca282005-07-12 17:06:03 -0400200
Eric Parisecf081d2009-12-17 21:24:25 -0500201 if (!(file->f_mode & FMODE_NONOTIFY)) {
Linus Torvalds20696012010-08-12 14:23:04 -0700202 fsnotify_parent(path, NULL, mask);
203 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
Eric Parisecf081d2009-12-17 21:24:25 -0500204 }
Robert Love0eeca282005-07-12 17:06:03 -0400205}
206
207/*
208 * fsnotify_modify - file was modified
209 */
Eric Paris2a12a9d2009-12-17 21:24:21 -0500210static inline void fsnotify_modify(struct file *file)
Robert Love0eeca282005-07-12 17:06:03 -0400211{
Linus Torvalds20696012010-08-12 14:23:04 -0700212 struct path *path = &file->f_path;
213 struct inode *inode = path->dentry->d_inode;
Eric Paris90586522009-05-21 17:01:20 -0400214 __u32 mask = FS_MODIFY;
Robert Love0eeca282005-07-12 17:06:03 -0400215
216 if (S_ISDIR(inode->i_mode))
Eric Parisb29866a2010-10-28 17:21:58 -0400217 mask |= FS_ISDIR;
Robert Love0eeca282005-07-12 17:06:03 -0400218
Eric Parisecf081d2009-12-17 21:24:25 -0500219 if (!(file->f_mode & FMODE_NONOTIFY)) {
Linus Torvalds20696012010-08-12 14:23:04 -0700220 fsnotify_parent(path, NULL, mask);
221 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
Eric Parisecf081d2009-12-17 21:24:25 -0500222 }
Robert Love0eeca282005-07-12 17:06:03 -0400223}
224
225/*
226 * fsnotify_open - file was opened
227 */
Eric Paris2a12a9d2009-12-17 21:24:21 -0500228static inline void fsnotify_open(struct file *file)
Robert Love0eeca282005-07-12 17:06:03 -0400229{
Linus Torvalds20696012010-08-12 14:23:04 -0700230 struct path *path = &file->f_path;
231 struct inode *inode = path->dentry->d_inode;
Eric Paris90586522009-05-21 17:01:20 -0400232 __u32 mask = FS_OPEN;
Robert Love0eeca282005-07-12 17:06:03 -0400233
234 if (S_ISDIR(inode->i_mode))
Eric Parisb29866a2010-10-28 17:21:58 -0400235 mask |= FS_ISDIR;
Robert Love0eeca282005-07-12 17:06:03 -0400236
Lino Sanfilippo6bff7ec2010-10-29 12:02:17 +0200237 fsnotify_parent(path, NULL, mask);
238 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
Robert Love0eeca282005-07-12 17:06:03 -0400239}
240
241/*
242 * fsnotify_close - file was closed
243 */
244static inline void fsnotify_close(struct file *file)
245{
Linus Torvalds20696012010-08-12 14:23:04 -0700246 struct path *path = &file->f_path;
Eric Paris28c60e32009-12-17 21:24:21 -0500247 struct inode *inode = file->f_path.dentry->d_inode;
Al Viroaeb5d722008-09-02 15:28:45 -0400248 fmode_t mode = file->f_mode;
Eric Paris90586522009-05-21 17:01:20 -0400249 __u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;
Robert Love0eeca282005-07-12 17:06:03 -0400250
251 if (S_ISDIR(inode->i_mode))
Eric Parisb29866a2010-10-28 17:21:58 -0400252 mask |= FS_ISDIR;
Robert Love0eeca282005-07-12 17:06:03 -0400253
Eric Parisecf081d2009-12-17 21:24:25 -0500254 if (!(file->f_mode & FMODE_NONOTIFY)) {
Linus Torvalds20696012010-08-12 14:23:04 -0700255 fsnotify_parent(path, NULL, mask);
256 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
Eric Parisecf081d2009-12-17 21:24:25 -0500257 }
Robert Love0eeca282005-07-12 17:06:03 -0400258}
259
260/*
261 * fsnotify_xattr - extended attributes were changed
262 */
263static inline void fsnotify_xattr(struct dentry *dentry)
264{
265 struct inode *inode = dentry->d_inode;
Eric Paris90586522009-05-21 17:01:20 -0400266 __u32 mask = FS_ATTRIB;
Robert Love0eeca282005-07-12 17:06:03 -0400267
268 if (S_ISDIR(inode->i_mode))
Eric Parisb29866a2010-10-28 17:21:58 -0400269 mask |= FS_ISDIR;
Robert Love0eeca282005-07-12 17:06:03 -0400270
Eric Paris28c60e32009-12-17 21:24:21 -0500271 fsnotify_parent(NULL, dentry, mask);
Eric Paris47882c62009-05-21 17:01:47 -0400272 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
Robert Love0eeca282005-07-12 17:06:03 -0400273}
274
275/*
276 * fsnotify_change - notify_change event. file was modified and/or metadata
277 * was changed.
278 */
279static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
280{
281 struct inode *inode = dentry->d_inode;
Eric Paris3c5119c2009-05-21 17:01:33 -0400282 __u32 mask = 0;
Robert Love0eeca282005-07-12 17:06:03 -0400283
Eric Paris3c5119c2009-05-21 17:01:33 -0400284 if (ia_valid & ATTR_UID)
285 mask |= FS_ATTRIB;
286 if (ia_valid & ATTR_GID)
287 mask |= FS_ATTRIB;
288 if (ia_valid & ATTR_SIZE)
289 mask |= FS_MODIFY;
290
Robert Love0eeca282005-07-12 17:06:03 -0400291 /* both times implies a utime(s) call */
292 if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
Eric Paris3c5119c2009-05-21 17:01:33 -0400293 mask |= FS_ATTRIB;
294 else if (ia_valid & ATTR_ATIME)
295 mask |= FS_ACCESS;
296 else if (ia_valid & ATTR_MTIME)
297 mask |= FS_MODIFY;
Robert Love0eeca282005-07-12 17:06:03 -0400298
Eric Paris3c5119c2009-05-21 17:01:33 -0400299 if (ia_valid & ATTR_MODE)
300 mask |= FS_ATTRIB;
301
302 if (mask) {
Robert Love0eeca282005-07-12 17:06:03 -0400303 if (S_ISDIR(inode->i_mode))
Eric Parisb29866a2010-10-28 17:21:58 -0400304 mask |= FS_ISDIR;
Eric Paris28c60e32009-12-17 21:24:21 -0500305
306 fsnotify_parent(NULL, dentry, mask);
Eric Paris47882c62009-05-21 17:01:47 -0400307 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
Robert Love0eeca282005-07-12 17:06:03 -0400308 }
309}
310
Eric Paris2dfc1ca2009-12-17 20:30:52 -0500311#if defined(CONFIG_FSNOTIFY) /* notify helpers */
Robert Love0eeca282005-07-12 17:06:03 -0400312
313/*
314 * fsnotify_oldname_init - save off the old filename before we change it
315 */
Eric Paris59b0df22010-02-08 12:53:52 -0500316static inline const unsigned char *fsnotify_oldname_init(const unsigned char *name)
Robert Love0eeca282005-07-12 17:06:03 -0400317{
318 return kstrdup(name, GFP_KERNEL);
319}
320
321/*
322 * fsnotify_oldname_free - free the name we got from fsnotify_oldname_init
323 */
Eric Paris59b0df22010-02-08 12:53:52 -0500324static inline void fsnotify_oldname_free(const unsigned char *old_name)
Robert Love0eeca282005-07-12 17:06:03 -0400325{
326 kfree(old_name);
327}
328
Eric Paris28c60e32009-12-17 21:24:21 -0500329#else /* CONFIG_FSNOTIFY */
Robert Love0eeca282005-07-12 17:06:03 -0400330
Eric Paris59b0df22010-02-08 12:53:52 -0500331static inline const char *fsnotify_oldname_init(const unsigned char *name)
Robert Love0eeca282005-07-12 17:06:03 -0400332{
333 return NULL;
334}
335
Eric Paris59b0df22010-02-08 12:53:52 -0500336static inline void fsnotify_oldname_free(const unsigned char *old_name)
Robert Love0eeca282005-07-12 17:06:03 -0400337{
338}
339
Eric Paris28c60e32009-12-17 21:24:21 -0500340#endif /* CONFIG_FSNOTIFY */
Robert Love0eeca282005-07-12 17:06:03 -0400341
Robert Love0eeca282005-07-12 17:06:03 -0400342#endif /* _LINUX_FS_NOTIFY_H */