dnotify: reimplement dnotify using fsnotify
[linux-2.6.git] / include / linux / fsnotify.h
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
14 #include <linux/dnotify.h>
15 #include <linux/inotify.h>
16 #include <linux/fsnotify_backend.h>
17 #include <linux/audit.h>
18
19 /*
20  * fsnotify_d_instantiate - instantiate a dentry for inode
21  * Called with dcache_lock held.
22  */
23 static inline void fsnotify_d_instantiate(struct dentry *entry,
24                                                 struct inode *inode)
25 {
26         __fsnotify_d_instantiate(entry, inode);
27
28         inotify_d_instantiate(entry, inode);
29 }
30
31 /* Notify this dentry's parent about a child's events. */
32 static inline void fsnotify_parent(struct dentry *dentry, __u32 mask)
33 {
34         __fsnotify_parent(dentry, mask);
35
36         inotify_dentry_parent_queue_event(dentry, mask, 0, dentry->d_name.name);
37 }
38
39 /*
40  * fsnotify_d_move - entry has been moved
41  * Called with dcache_lock and entry->d_lock held.
42  */
43 static inline void fsnotify_d_move(struct dentry *entry)
44 {
45         /*
46          * On move we need to update entry->d_flags to indicate if the new parent
47          * cares about events from this entry.
48          */
49         __fsnotify_update_dcache_flags(entry);
50
51         inotify_d_move(entry);
52 }
53
54 /*
55  * fsnotify_link_count - inode's link count changed
56  */
57 static inline void fsnotify_link_count(struct inode *inode)
58 {
59         inotify_inode_queue_event(inode, IN_ATTRIB, 0, NULL, NULL);
60
61         fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE);
62 }
63
64 /*
65  * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
66  */
67 static inline void fsnotify_move(struct inode *old_dir, struct inode *new_dir,
68                                  const char *old_name, const char *new_name,
69                                  int isdir, struct inode *target, struct dentry *moved)
70 {
71         struct inode *source = moved->d_inode;
72         u32 cookie = inotify_get_cookie();
73         __u32 old_dir_mask = 0;
74         __u32 new_dir_mask = 0;
75
76         if (old_dir == new_dir) {
77                 old_dir_mask = FS_DN_RENAME;
78         }
79
80         if (isdir) {
81                 isdir = IN_ISDIR;
82                 old_dir_mask |= FS_IN_ISDIR;
83                 new_dir_mask |= FS_IN_ISDIR;
84         }
85
86         old_dir_mask |= FS_MOVED_FROM;
87         new_dir_mask |= FS_MOVED_TO;
88
89         inotify_inode_queue_event(old_dir, IN_MOVED_FROM|isdir,cookie,old_name,
90                                   source);
91         inotify_inode_queue_event(new_dir, IN_MOVED_TO|isdir, cookie, new_name,
92                                   source);
93
94         fsnotify(old_dir, old_dir_mask, old_dir, FSNOTIFY_EVENT_INODE);
95         fsnotify(new_dir, new_dir_mask, new_dir, FSNOTIFY_EVENT_INODE);
96
97         if (target) {
98                 inotify_inode_queue_event(target, IN_DELETE_SELF, 0, NULL, NULL);
99                 inotify_inode_is_dead(target);
100
101                 /* this is really a link_count change not a removal */
102                 fsnotify_link_count(target);
103         }
104
105         if (source) {
106                 inotify_inode_queue_event(source, IN_MOVE_SELF, 0, NULL, NULL);
107                 fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE);
108         }
109         audit_inode_child(new_name, moved, new_dir);
110 }
111
112 /*
113  * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
114  */
115 static inline void fsnotify_inode_delete(struct inode *inode)
116 {
117         __fsnotify_inode_delete(inode);
118 }
119
120 /*
121  * fsnotify_nameremove - a filename was removed from a directory
122  */
123 static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
124 {
125         __u32 mask = FS_DELETE;
126
127         if (isdir)
128                 mask |= FS_IN_ISDIR;
129
130         fsnotify_parent(dentry, mask);
131 }
132
133 /*
134  * fsnotify_inoderemove - an inode is going away
135  */
136 static inline void fsnotify_inoderemove(struct inode *inode)
137 {
138         inotify_inode_queue_event(inode, IN_DELETE_SELF, 0, NULL, NULL);
139         inotify_inode_is_dead(inode);
140
141         fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE);
142         __fsnotify_inode_delete(inode);
143 }
144
145 /*
146  * fsnotify_create - 'name' was linked in
147  */
148 static inline void fsnotify_create(struct inode *inode, struct dentry *dentry)
149 {
150         inotify_inode_queue_event(inode, IN_CREATE, 0, dentry->d_name.name,
151                                   dentry->d_inode);
152         audit_inode_child(dentry->d_name.name, dentry, inode);
153
154         fsnotify(inode, FS_CREATE, dentry->d_inode, FSNOTIFY_EVENT_INODE);
155 }
156
157 /*
158  * fsnotify_link - new hardlink in 'inode' directory
159  * Note: We have to pass also the linked inode ptr as some filesystems leave
160  *   new_dentry->d_inode NULL and instantiate inode pointer later
161  */
162 static inline void fsnotify_link(struct inode *dir, struct inode *inode, struct dentry *new_dentry)
163 {
164         inotify_inode_queue_event(dir, IN_CREATE, 0, new_dentry->d_name.name,
165                                   inode);
166         fsnotify_link_count(inode);
167         audit_inode_child(new_dentry->d_name.name, new_dentry, dir);
168
169         fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE);
170 }
171
172 /*
173  * fsnotify_mkdir - directory 'name' was created
174  */
175 static inline void fsnotify_mkdir(struct inode *inode, struct dentry *dentry)
176 {
177         __u32 mask = (FS_CREATE | FS_IN_ISDIR);
178         struct inode *d_inode = dentry->d_inode;
179
180         inotify_inode_queue_event(inode, mask, 0, dentry->d_name.name, d_inode);
181         audit_inode_child(dentry->d_name.name, dentry, inode);
182
183         fsnotify(inode, mask, d_inode, FSNOTIFY_EVENT_INODE);
184 }
185
186 /*
187  * fsnotify_access - file was read
188  */
189 static inline void fsnotify_access(struct dentry *dentry)
190 {
191         struct inode *inode = dentry->d_inode;
192         __u32 mask = FS_ACCESS;
193
194         if (S_ISDIR(inode->i_mode))
195                 mask |= FS_IN_ISDIR;
196
197         inotify_inode_queue_event(inode, mask, 0, NULL, NULL);
198
199         fsnotify_parent(dentry, mask);
200         fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE);
201 }
202
203 /*
204  * fsnotify_modify - file was modified
205  */
206 static inline void fsnotify_modify(struct dentry *dentry)
207 {
208         struct inode *inode = dentry->d_inode;
209         __u32 mask = FS_MODIFY;
210
211         if (S_ISDIR(inode->i_mode))
212                 mask |= FS_IN_ISDIR;
213
214         inotify_inode_queue_event(inode, mask, 0, NULL, NULL);
215
216         fsnotify_parent(dentry, mask);
217         fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE);
218 }
219
220 /*
221  * fsnotify_open - file was opened
222  */
223 static inline void fsnotify_open(struct dentry *dentry)
224 {
225         struct inode *inode = dentry->d_inode;
226         __u32 mask = FS_OPEN;
227
228         if (S_ISDIR(inode->i_mode))
229                 mask |= FS_IN_ISDIR;
230
231         inotify_inode_queue_event(inode, mask, 0, NULL, NULL);
232
233         fsnotify_parent(dentry, mask);
234         fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE);
235 }
236
237 /*
238  * fsnotify_close - file was closed
239  */
240 static inline void fsnotify_close(struct file *file)
241 {
242         struct dentry *dentry = file->f_path.dentry;
243         struct inode *inode = dentry->d_inode;
244         fmode_t mode = file->f_mode;
245         __u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;
246
247         if (S_ISDIR(inode->i_mode))
248                 mask |= FS_IN_ISDIR;
249
250         inotify_inode_queue_event(inode, mask, 0, NULL, NULL);
251
252         fsnotify_parent(dentry, mask);
253         fsnotify(inode, mask, file, FSNOTIFY_EVENT_FILE);
254 }
255
256 /*
257  * fsnotify_xattr - extended attributes were changed
258  */
259 static inline void fsnotify_xattr(struct dentry *dentry)
260 {
261         struct inode *inode = dentry->d_inode;
262         __u32 mask = FS_ATTRIB;
263
264         if (S_ISDIR(inode->i_mode))
265                 mask |= FS_IN_ISDIR;
266
267         inotify_inode_queue_event(inode, mask, 0, NULL, NULL);
268
269         fsnotify_parent(dentry, mask);
270         fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE);
271 }
272
273 /*
274  * fsnotify_change - notify_change event.  file was modified and/or metadata
275  * was changed.
276  */
277 static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
278 {
279         struct inode *inode = dentry->d_inode;
280         __u32 mask = 0;
281
282         if (ia_valid & ATTR_UID)
283                 mask |= FS_ATTRIB;
284         if (ia_valid & ATTR_GID)
285                 mask |= FS_ATTRIB;
286         if (ia_valid & ATTR_SIZE)
287                 mask |= FS_MODIFY;
288
289         /* both times implies a utime(s) call */
290         if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
291                 mask |= FS_ATTRIB;
292         else if (ia_valid & ATTR_ATIME)
293                 mask |= FS_ACCESS;
294         else if (ia_valid & ATTR_MTIME)
295                 mask |= FS_MODIFY;
296
297         if (ia_valid & ATTR_MODE)
298                 mask |= FS_ATTRIB;
299
300         if (mask) {
301                 if (S_ISDIR(inode->i_mode))
302                         mask |= FS_IN_ISDIR;
303                 inotify_inode_queue_event(inode, mask, 0, NULL, NULL);
304
305                 fsnotify_parent(dentry, mask);
306                 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE);
307         }
308 }
309
310 #if defined(CONFIG_INOTIFY) || defined(CONFIG_FSNOTIFY) /* notify helpers */
311
312 /*
313  * fsnotify_oldname_init - save off the old filename before we change it
314  */
315 static inline const char *fsnotify_oldname_init(const char *name)
316 {
317         return kstrdup(name, GFP_KERNEL);
318 }
319
320 /*
321  * fsnotify_oldname_free - free the name we got from fsnotify_oldname_init
322  */
323 static inline void fsnotify_oldname_free(const char *old_name)
324 {
325         kfree(old_name);
326 }
327
328 #else   /* CONFIG_INOTIFY || CONFIG_FSNOTIFY */
329
330 static inline const char *fsnotify_oldname_init(const char *name)
331 {
332         return NULL;
333 }
334
335 static inline void fsnotify_oldname_free(const char *old_name)
336 {
337 }
338
339 #endif  /* ! CONFIG_INOTIFY */
340
341 #endif  /* _LINUX_FS_NOTIFY_H */