Merge tag 'soundwire-6.8-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/vkoul...
[linux-2.6-block.git] / include / linux / fsnotify.h
... / ...
CommitLineData
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_FS_NOTIFY_H
3#define _LINUX_FS_NOTIFY_H
4
5/*
6 * include/linux/fsnotify.h - generic hooks for filesystem notification, to
7 * reduce in-source duplication from both dnotify and inotify.
8 *
9 * We don't compile any of this away in some complicated menagerie of ifdefs.
10 * Instead, we rely on the code inside to optimize away as needed.
11 *
12 * (C) Copyright 2005 Robert Love
13 */
14
15#include <linux/fsnotify_backend.h>
16#include <linux/audit.h>
17#include <linux/slab.h>
18#include <linux/bug.h>
19
20/*
21 * Notify this @dir inode about a change in a child directory entry.
22 * The directory entry may have turned positive or negative or its inode may
23 * have changed (i.e. renamed over).
24 *
25 * Unlike fsnotify_parent(), the event will be reported regardless of the
26 * FS_EVENT_ON_CHILD mask on the parent inode and will not be reported if only
27 * the child is interested and not the parent.
28 */
29static inline int fsnotify_name(__u32 mask, const void *data, int data_type,
30 struct inode *dir, const struct qstr *name,
31 u32 cookie)
32{
33 if (atomic_long_read(&dir->i_sb->s_fsnotify_connectors) == 0)
34 return 0;
35
36 return fsnotify(mask, data, data_type, dir, name, NULL, cookie);
37}
38
39static inline void fsnotify_dirent(struct inode *dir, struct dentry *dentry,
40 __u32 mask)
41{
42 fsnotify_name(mask, dentry, FSNOTIFY_EVENT_DENTRY, dir, &dentry->d_name, 0);
43}
44
45static inline void fsnotify_inode(struct inode *inode, __u32 mask)
46{
47 if (atomic_long_read(&inode->i_sb->s_fsnotify_connectors) == 0)
48 return;
49
50 if (S_ISDIR(inode->i_mode))
51 mask |= FS_ISDIR;
52
53 fsnotify(mask, inode, FSNOTIFY_EVENT_INODE, NULL, NULL, inode, 0);
54}
55
56/* Notify this dentry's parent about a child's events. */
57static inline int fsnotify_parent(struct dentry *dentry, __u32 mask,
58 const void *data, int data_type)
59{
60 struct inode *inode = d_inode(dentry);
61
62 if (atomic_long_read(&inode->i_sb->s_fsnotify_connectors) == 0)
63 return 0;
64
65 if (S_ISDIR(inode->i_mode)) {
66 mask |= FS_ISDIR;
67
68 /* sb/mount marks are not interested in name of directory */
69 if (!(dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED))
70 goto notify_child;
71 }
72
73 /* disconnected dentry cannot notify parent */
74 if (IS_ROOT(dentry))
75 goto notify_child;
76
77 return __fsnotify_parent(dentry, mask, data, data_type);
78
79notify_child:
80 return fsnotify(mask, data, data_type, NULL, NULL, inode, 0);
81}
82
83/*
84 * Simple wrappers to consolidate calls to fsnotify_parent() when an event
85 * is on a file/dentry.
86 */
87static inline void fsnotify_dentry(struct dentry *dentry, __u32 mask)
88{
89 fsnotify_parent(dentry, mask, dentry, FSNOTIFY_EVENT_DENTRY);
90}
91
92static inline int fsnotify_file(struct file *file, __u32 mask)
93{
94 const struct path *path;
95
96 if (file->f_mode & FMODE_NONOTIFY)
97 return 0;
98
99 path = &file->f_path;
100 return fsnotify_parent(path->dentry, mask, path, FSNOTIFY_EVENT_PATH);
101}
102
103#ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
104/*
105 * fsnotify_file_area_perm - permission hook before access to file range
106 */
107static inline int fsnotify_file_area_perm(struct file *file, int perm_mask,
108 const loff_t *ppos, size_t count)
109{
110 __u32 fsnotify_mask = FS_ACCESS_PERM;
111
112 /*
113 * filesystem may be modified in the context of permission events
114 * (e.g. by HSM filling a file on access), so sb freeze protection
115 * must not be held.
116 */
117 lockdep_assert_once(file_write_not_started(file));
118
119 if (!(perm_mask & MAY_READ))
120 return 0;
121
122 return fsnotify_file(file, fsnotify_mask);
123}
124
125/*
126 * fsnotify_file_perm - permission hook before file access
127 */
128static inline int fsnotify_file_perm(struct file *file, int perm_mask)
129{
130 return fsnotify_file_area_perm(file, perm_mask, NULL, 0);
131}
132
133/*
134 * fsnotify_open_perm - permission hook before file open
135 */
136static inline int fsnotify_open_perm(struct file *file)
137{
138 int ret;
139
140 if (file->f_flags & __FMODE_EXEC) {
141 ret = fsnotify_file(file, FS_OPEN_EXEC_PERM);
142 if (ret)
143 return ret;
144 }
145
146 return fsnotify_file(file, FS_OPEN_PERM);
147}
148
149#else
150static inline int fsnotify_file_area_perm(struct file *file, int perm_mask,
151 const loff_t *ppos, size_t count)
152{
153 return 0;
154}
155
156static inline int fsnotify_file_perm(struct file *file, int perm_mask)
157{
158 return 0;
159}
160
161static inline int fsnotify_open_perm(struct file *file)
162{
163 return 0;
164}
165#endif
166
167/*
168 * fsnotify_link_count - inode's link count changed
169 */
170static inline void fsnotify_link_count(struct inode *inode)
171{
172 fsnotify_inode(inode, FS_ATTRIB);
173}
174
175/*
176 * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
177 */
178static inline void fsnotify_move(struct inode *old_dir, struct inode *new_dir,
179 const struct qstr *old_name,
180 int isdir, struct inode *target,
181 struct dentry *moved)
182{
183 struct inode *source = moved->d_inode;
184 u32 fs_cookie = fsnotify_get_cookie();
185 __u32 old_dir_mask = FS_MOVED_FROM;
186 __u32 new_dir_mask = FS_MOVED_TO;
187 __u32 rename_mask = FS_RENAME;
188 const struct qstr *new_name = &moved->d_name;
189
190 if (isdir) {
191 old_dir_mask |= FS_ISDIR;
192 new_dir_mask |= FS_ISDIR;
193 rename_mask |= FS_ISDIR;
194 }
195
196 /* Event with information about both old and new parent+name */
197 fsnotify_name(rename_mask, moved, FSNOTIFY_EVENT_DENTRY,
198 old_dir, old_name, 0);
199
200 fsnotify_name(old_dir_mask, source, FSNOTIFY_EVENT_INODE,
201 old_dir, old_name, fs_cookie);
202 fsnotify_name(new_dir_mask, source, FSNOTIFY_EVENT_INODE,
203 new_dir, new_name, fs_cookie);
204
205 if (target)
206 fsnotify_link_count(target);
207 fsnotify_inode(source, FS_MOVE_SELF);
208 audit_inode_child(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
209}
210
211/*
212 * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
213 */
214static inline void fsnotify_inode_delete(struct inode *inode)
215{
216 __fsnotify_inode_delete(inode);
217}
218
219/*
220 * fsnotify_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
221 */
222static inline void fsnotify_vfsmount_delete(struct vfsmount *mnt)
223{
224 __fsnotify_vfsmount_delete(mnt);
225}
226
227/*
228 * fsnotify_inoderemove - an inode is going away
229 */
230static inline void fsnotify_inoderemove(struct inode *inode)
231{
232 fsnotify_inode(inode, FS_DELETE_SELF);
233 __fsnotify_inode_delete(inode);
234}
235
236/*
237 * fsnotify_create - 'name' was linked in
238 *
239 * Caller must make sure that dentry->d_name is stable.
240 * Note: some filesystems (e.g. kernfs) leave @dentry negative and instantiate
241 * ->d_inode later
242 */
243static inline void fsnotify_create(struct inode *dir, struct dentry *dentry)
244{
245 audit_inode_child(dir, dentry, AUDIT_TYPE_CHILD_CREATE);
246
247 fsnotify_dirent(dir, dentry, FS_CREATE);
248}
249
250/*
251 * fsnotify_link - new hardlink in 'inode' directory
252 *
253 * Caller must make sure that new_dentry->d_name is stable.
254 * Note: We have to pass also the linked inode ptr as some filesystems leave
255 * new_dentry->d_inode NULL and instantiate inode pointer later
256 */
257static inline void fsnotify_link(struct inode *dir, struct inode *inode,
258 struct dentry *new_dentry)
259{
260 fsnotify_link_count(inode);
261 audit_inode_child(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);
262
263 fsnotify_name(FS_CREATE, inode, FSNOTIFY_EVENT_INODE,
264 dir, &new_dentry->d_name, 0);
265}
266
267/*
268 * fsnotify_delete - @dentry was unlinked and unhashed
269 *
270 * Caller must make sure that dentry->d_name is stable.
271 *
272 * Note: unlike fsnotify_unlink(), we have to pass also the unlinked inode
273 * as this may be called after d_delete() and old_dentry may be negative.
274 */
275static inline void fsnotify_delete(struct inode *dir, struct inode *inode,
276 struct dentry *dentry)
277{
278 __u32 mask = FS_DELETE;
279
280 if (S_ISDIR(inode->i_mode))
281 mask |= FS_ISDIR;
282
283 fsnotify_name(mask, inode, FSNOTIFY_EVENT_INODE, dir, &dentry->d_name,
284 0);
285}
286
287/**
288 * d_delete_notify - delete a dentry and call fsnotify_delete()
289 * @dentry: The dentry to delete
290 *
291 * This helper is used to guaranty that the unlinked inode cannot be found
292 * by lookup of this name after fsnotify_delete() event has been delivered.
293 */
294static inline void d_delete_notify(struct inode *dir, struct dentry *dentry)
295{
296 struct inode *inode = d_inode(dentry);
297
298 ihold(inode);
299 d_delete(dentry);
300 fsnotify_delete(dir, inode, dentry);
301 iput(inode);
302}
303
304/*
305 * fsnotify_unlink - 'name' was unlinked
306 *
307 * Caller must make sure that dentry->d_name is stable.
308 */
309static inline void fsnotify_unlink(struct inode *dir, struct dentry *dentry)
310{
311 if (WARN_ON_ONCE(d_is_negative(dentry)))
312 return;
313
314 fsnotify_delete(dir, d_inode(dentry), dentry);
315}
316
317/*
318 * fsnotify_mkdir - directory 'name' was created
319 *
320 * Caller must make sure that dentry->d_name is stable.
321 * Note: some filesystems (e.g. kernfs) leave @dentry negative and instantiate
322 * ->d_inode later
323 */
324static inline void fsnotify_mkdir(struct inode *dir, struct dentry *dentry)
325{
326 audit_inode_child(dir, dentry, AUDIT_TYPE_CHILD_CREATE);
327
328 fsnotify_dirent(dir, dentry, FS_CREATE | FS_ISDIR);
329}
330
331/*
332 * fsnotify_rmdir - directory 'name' was removed
333 *
334 * Caller must make sure that dentry->d_name is stable.
335 */
336static inline void fsnotify_rmdir(struct inode *dir, struct dentry *dentry)
337{
338 if (WARN_ON_ONCE(d_is_negative(dentry)))
339 return;
340
341 fsnotify_delete(dir, d_inode(dentry), dentry);
342}
343
344/*
345 * fsnotify_access - file was read
346 */
347static inline void fsnotify_access(struct file *file)
348{
349 fsnotify_file(file, FS_ACCESS);
350}
351
352/*
353 * fsnotify_modify - file was modified
354 */
355static inline void fsnotify_modify(struct file *file)
356{
357 fsnotify_file(file, FS_MODIFY);
358}
359
360/*
361 * fsnotify_open - file was opened
362 */
363static inline void fsnotify_open(struct file *file)
364{
365 __u32 mask = FS_OPEN;
366
367 if (file->f_flags & __FMODE_EXEC)
368 mask |= FS_OPEN_EXEC;
369
370 fsnotify_file(file, mask);
371}
372
373/*
374 * fsnotify_close - file was closed
375 */
376static inline void fsnotify_close(struct file *file)
377{
378 __u32 mask = (file->f_mode & FMODE_WRITE) ? FS_CLOSE_WRITE :
379 FS_CLOSE_NOWRITE;
380
381 fsnotify_file(file, mask);
382}
383
384/*
385 * fsnotify_xattr - extended attributes were changed
386 */
387static inline void fsnotify_xattr(struct dentry *dentry)
388{
389 fsnotify_dentry(dentry, FS_ATTRIB);
390}
391
392/*
393 * fsnotify_change - notify_change event. file was modified and/or metadata
394 * was changed.
395 */
396static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
397{
398 __u32 mask = 0;
399
400 if (ia_valid & ATTR_UID)
401 mask |= FS_ATTRIB;
402 if (ia_valid & ATTR_GID)
403 mask |= FS_ATTRIB;
404 if (ia_valid & ATTR_SIZE)
405 mask |= FS_MODIFY;
406
407 /* both times implies a utime(s) call */
408 if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
409 mask |= FS_ATTRIB;
410 else if (ia_valid & ATTR_ATIME)
411 mask |= FS_ACCESS;
412 else if (ia_valid & ATTR_MTIME)
413 mask |= FS_MODIFY;
414
415 if (ia_valid & ATTR_MODE)
416 mask |= FS_ATTRIB;
417
418 if (mask)
419 fsnotify_dentry(dentry, mask);
420}
421
422static inline int fsnotify_sb_error(struct super_block *sb, struct inode *inode,
423 int error)
424{
425 struct fs_error_report report = {
426 .error = error,
427 .inode = inode,
428 .sb = sb,
429 };
430
431 return fsnotify(FS_ERROR, &report, FSNOTIFY_EVENT_ERROR,
432 NULL, NULL, NULL, 0);
433}
434
435#endif /* _LINUX_FS_NOTIFY_H */