new helper: file_inode(file)
[linux-2.6-block.git] / include / linux / fsnotify.h
CommitLineData
0eeca283
RL
1#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
90586523 14#include <linux/fsnotify_backend.h>
73241ccc 15#include <linux/audit.h>
5a0e3ad6 16#include <linux/slab.h>
187f1882 17#include <linux/bug.h>
0eeca283 18
c32ccd87
NP
19/*
20 * fsnotify_d_instantiate - instantiate a dentry for inode
c32ccd87 21 */
e61ce867
EP
22static inline void fsnotify_d_instantiate(struct dentry *dentry,
23 struct inode *inode)
c32ccd87 24{
e61ce867 25 __fsnotify_d_instantiate(dentry, inode);
c32ccd87
NP
26}
27
c28f7e56 28/* Notify this dentry's parent about a child's events. */
52420392 29static inline int fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask)
c28f7e56 30{
72acc854 31 if (!dentry)
2069601b 32 dentry = path->dentry;
28c60e37 33
52420392 34 return __fsnotify_parent(path, dentry, mask);
c28f7e56
EP
35}
36
c4ec54b4
EP
37/* simple call site for access decisions */
38static inline int fsnotify_perm(struct file *file, int mask)
39{
2069601b
LT
40 struct path *path = &file->f_path;
41 struct inode *inode = path->dentry->d_inode;
fb1cfb88 42 __u32 fsnotify_mask = 0;
52420392 43 int ret;
c4ec54b4
EP
44
45 if (file->f_mode & FMODE_NONOTIFY)
46 return 0;
47 if (!(mask & (MAY_READ | MAY_OPEN)))
48 return 0;
c4ec54b4
EP
49 if (mask & MAY_OPEN)
50 fsnotify_mask = FS_OPEN_PERM;
fb1cfb88
EP
51 else if (mask & MAY_READ)
52 fsnotify_mask = FS_ACCESS_PERM;
53 else
54 BUG();
c4ec54b4 55
52420392
EP
56 ret = fsnotify_parent(path, NULL, fsnotify_mask);
57 if (ret)
58 return ret;
59
2069601b 60 return fsnotify(inode, fsnotify_mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
c4ec54b4
EP
61}
62
c32ccd87 63/*
e61ce867 64 * fsnotify_d_move - dentry has been moved
c32ccd87 65 */
e61ce867 66static inline void fsnotify_d_move(struct dentry *dentry)
c32ccd87 67{
c28f7e56 68 /*
e61ce867
EP
69 * On move we need to update dentry->d_flags to indicate if the new parent
70 * cares about events from this dentry.
c28f7e56 71 */
e61ce867 72 __fsnotify_update_dcache_flags(dentry);
c32ccd87
NP
73}
74
90586523
EP
75/*
76 * fsnotify_link_count - inode's link count changed
77 */
78static inline void fsnotify_link_count(struct inode *inode)
79{
47882c6f 80 fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
90586523
EP
81}
82
0eeca283
RL
83/*
84 * 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,
59b0df21 87 const unsigned char *old_name,
5a190ae6 88 int isdir, struct inode *target, struct dentry *moved)
0eeca283 89{
5a190ae6 90 struct inode *source = moved->d_inode;
47882c6f 91 u32 fs_cookie = fsnotify_get_cookie();
ff52cc21
EP
92 __u32 old_dir_mask = (FS_EVENT_ON_CHILD | FS_MOVED_FROM);
93 __u32 new_dir_mask = (FS_EVENT_ON_CHILD | FS_MOVED_TO);
59b0df21 94 const unsigned char *new_name = moved->d_name.name;
0eeca283 95
ff52cc21
EP
96 if (old_dir == new_dir)
97 old_dir_mask |= FS_DN_RENAME;
0eeca283 98
90586523 99 if (isdir) {
b29866aa
EP
100 old_dir_mask |= FS_ISDIR;
101 new_dir_mask |= FS_ISDIR;
90586523
EP
102 }
103
47882c6f
EP
104 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);
90586523 106
2dfc1cae 107 if (target)
90586523 108 fsnotify_link_count(target);
89204c40 109
2dfc1cae 110 if (source)
47882c6f 111 fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE, NULL, 0);
4fa6b5ec 112 audit_inode_child(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
0eeca283
RL
113}
114
3be25f49
EP
115/*
116 * 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
ca9c726e
AG
123/*
124 * 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
7a91bf7f
JM
131/*
132 * fsnotify_nameremove - a filename was removed from a directory
133 */
134static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
135{
90586523
EP
136 __u32 mask = FS_DELETE;
137
7a91bf7f 138 if (isdir)
b29866aa 139 mask |= FS_ISDIR;
c28f7e56 140
28c60e37 141 fsnotify_parent(NULL, dentry, mask);
7a91bf7f
JM
142}
143
144/*
145 * fsnotify_inoderemove - an inode is going away
146 */
147static inline void fsnotify_inoderemove(struct inode *inode)
148{
47882c6f 149 fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
3be25f49 150 __fsnotify_inode_delete(inode);
ece95912
JK
151}
152
0eeca283
RL
153/*
154 * fsnotify_create - 'name' was linked in
155 */
f38aa942 156static inline void fsnotify_create(struct inode *inode, struct dentry *dentry)
0eeca283 157{
4fa6b5ec 158 audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
90586523 159
47882c6f 160 fsnotify(inode, FS_CREATE, dentry->d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
0eeca283
RL
161}
162
ece95912
JK
163/*
164 * 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{
ece95912 170 fsnotify_link_count(inode);
4fa6b5ec 171 audit_inode_child(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);
90586523 172
47882c6f 173 fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE, new_dentry->d_name.name, 0);
ece95912
JK
174}
175
0eeca283
RL
176/*
177 * fsnotify_mkdir - directory 'name' was created
178 */
f38aa942 179static inline void fsnotify_mkdir(struct inode *inode, struct dentry *dentry)
0eeca283 180{
b29866aa 181 __u32 mask = (FS_CREATE | FS_ISDIR);
90586523
EP
182 struct inode *d_inode = dentry->d_inode;
183
4fa6b5ec 184 audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
90586523 185
47882c6f 186 fsnotify(inode, mask, d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
0eeca283
RL
187}
188
189/*
190 * fsnotify_access - file was read
191 */
2a12a9d7 192static inline void fsnotify_access(struct file *file)
0eeca283 193{
2069601b
LT
194 struct path *path = &file->f_path;
195 struct inode *inode = path->dentry->d_inode;
90586523 196 __u32 mask = FS_ACCESS;
0eeca283
RL
197
198 if (S_ISDIR(inode->i_mode))
b29866aa 199 mask |= FS_ISDIR;
0eeca283 200
ecf081d1 201 if (!(file->f_mode & FMODE_NONOTIFY)) {
2069601b
LT
202 fsnotify_parent(path, NULL, mask);
203 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
ecf081d1 204 }
0eeca283
RL
205}
206
207/*
208 * fsnotify_modify - file was modified
209 */
2a12a9d7 210static inline void fsnotify_modify(struct file *file)
0eeca283 211{
2069601b
LT
212 struct path *path = &file->f_path;
213 struct inode *inode = path->dentry->d_inode;
90586523 214 __u32 mask = FS_MODIFY;
0eeca283
RL
215
216 if (S_ISDIR(inode->i_mode))
b29866aa 217 mask |= FS_ISDIR;
0eeca283 218
ecf081d1 219 if (!(file->f_mode & FMODE_NONOTIFY)) {
2069601b
LT
220 fsnotify_parent(path, NULL, mask);
221 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
ecf081d1 222 }
0eeca283
RL
223}
224
225/*
226 * fsnotify_open - file was opened
227 */
2a12a9d7 228static inline void fsnotify_open(struct file *file)
0eeca283 229{
2069601b
LT
230 struct path *path = &file->f_path;
231 struct inode *inode = path->dentry->d_inode;
90586523 232 __u32 mask = FS_OPEN;
0eeca283
RL
233
234 if (S_ISDIR(inode->i_mode))
b29866aa 235 mask |= FS_ISDIR;
0eeca283 236
6bff7ecc
LS
237 fsnotify_parent(path, NULL, mask);
238 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
0eeca283
RL
239}
240
241/*
242 * fsnotify_close - file was closed
243 */
244static inline void fsnotify_close(struct file *file)
245{
2069601b 246 struct path *path = &file->f_path;
496ad9aa 247 struct inode *inode = file_inode(file);
aeb5d727 248 fmode_t mode = file->f_mode;
90586523 249 __u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;
0eeca283
RL
250
251 if (S_ISDIR(inode->i_mode))
b29866aa 252 mask |= FS_ISDIR;
0eeca283 253
ecf081d1 254 if (!(file->f_mode & FMODE_NONOTIFY)) {
2069601b
LT
255 fsnotify_parent(path, NULL, mask);
256 fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
ecf081d1 257 }
0eeca283
RL
258}
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;
90586523 266 __u32 mask = FS_ATTRIB;
0eeca283
RL
267
268 if (S_ISDIR(inode->i_mode))
b29866aa 269 mask |= FS_ISDIR;
0eeca283 270
28c60e37 271 fsnotify_parent(NULL, dentry, mask);
47882c6f 272 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
0eeca283
RL
273}
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;
3c5119c0
EP
282 __u32 mask = 0;
283
284 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;
0eeca283 290
0eeca283
RL
291 /* both times implies a utime(s) call */
292 if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
3c5119c0
EP
293 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;
298
299 if (ia_valid & ATTR_MODE)
300 mask |= FS_ATTRIB;
0eeca283 301
3c5119c0 302 if (mask) {
0eeca283 303 if (S_ISDIR(inode->i_mode))
b29866aa 304 mask |= FS_ISDIR;
28c60e37
EP
305
306 fsnotify_parent(NULL, dentry, mask);
47882c6f 307 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
0eeca283
RL
308 }
309}
310
2dfc1cae 311#if defined(CONFIG_FSNOTIFY) /* notify helpers */
0eeca283
RL
312
313/*
314 * fsnotify_oldname_init - save off the old filename before we change it
315 */
59b0df21 316static inline const unsigned char *fsnotify_oldname_init(const unsigned char *name)
0eeca283
RL
317{
318 return kstrdup(name, GFP_KERNEL);
319}
320
321/*
322 * fsnotify_oldname_free - free the name we got from fsnotify_oldname_init
323 */
59b0df21 324static inline void fsnotify_oldname_free(const unsigned char *old_name)
0eeca283
RL
325{
326 kfree(old_name);
327}
328
28c60e37 329#else /* CONFIG_FSNOTIFY */
0eeca283 330
59b0df21 331static inline const char *fsnotify_oldname_init(const unsigned char *name)
0eeca283
RL
332{
333 return NULL;
334}
335
59b0df21 336static inline void fsnotify_oldname_free(const unsigned char *old_name)
0eeca283
RL
337{
338}
339
28c60e37 340#endif /* CONFIG_FSNOTIFY */
0eeca283 341
0eeca283 342#endif /* _LINUX_FS_NOTIFY_H */