xref: /linux/fs/notify/fsnotify.h (revision 1a59d1b8e05ea6ab45f7e18897de1ef0e6bc3da6)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __FS_NOTIFY_FSNOTIFY_H_
3 #define __FS_NOTIFY_FSNOTIFY_H_
4 
5 #include <linux/list.h>
6 #include <linux/fsnotify.h>
7 #include <linux/srcu.h>
8 #include <linux/types.h>
9 
10 #include "../mount.h"
11 
12 static inline struct inode *fsnotify_conn_inode(
13 				struct fsnotify_mark_connector *conn)
14 {
15 	return container_of(conn->obj, struct inode, i_fsnotify_marks);
16 }
17 
18 static inline struct mount *fsnotify_conn_mount(
19 				struct fsnotify_mark_connector *conn)
20 {
21 	return container_of(conn->obj, struct mount, mnt_fsnotify_marks);
22 }
23 
24 static inline struct super_block *fsnotify_conn_sb(
25 				struct fsnotify_mark_connector *conn)
26 {
27 	return container_of(conn->obj, struct super_block, s_fsnotify_marks);
28 }
29 
30 /* destroy all events sitting in this groups notification queue */
31 extern void fsnotify_flush_notify(struct fsnotify_group *group);
32 
33 /* protects reads of inode and vfsmount marks list */
34 extern struct srcu_struct fsnotify_mark_srcu;
35 
36 /* compare two groups for sorting of marks lists */
37 extern int fsnotify_compare_groups(struct fsnotify_group *a,
38 				   struct fsnotify_group *b);
39 
40 /* Destroy all marks attached to an object via connector */
41 extern void fsnotify_destroy_marks(fsnotify_connp_t *connp);
42 /* run the list of all marks associated with inode and destroy them */
43 static inline void fsnotify_clear_marks_by_inode(struct inode *inode)
44 {
45 	fsnotify_destroy_marks(&inode->i_fsnotify_marks);
46 }
47 /* run the list of all marks associated with vfsmount and destroy them */
48 static inline void fsnotify_clear_marks_by_mount(struct vfsmount *mnt)
49 {
50 	fsnotify_destroy_marks(&real_mount(mnt)->mnt_fsnotify_marks);
51 }
52 /* run the list of all marks associated with sb and destroy them */
53 static inline void fsnotify_clear_marks_by_sb(struct super_block *sb)
54 {
55 	fsnotify_destroy_marks(&sb->s_fsnotify_marks);
56 }
57 /* Wait until all marks queued for destruction are destroyed */
58 extern void fsnotify_wait_marks_destroyed(void);
59 
60 /*
61  * update the dentry->d_flags of all of inode's children to indicate if inode cares
62  * about events that happen to its children.
63  */
64 extern void __fsnotify_update_child_dentry_flags(struct inode *inode);
65 
66 /* allocate and destroy and event holder to attach events to notification/access queues */
67 extern struct fsnotify_event_holder *fsnotify_alloc_event_holder(void);
68 extern void fsnotify_destroy_event_holder(struct fsnotify_event_holder *holder);
69 
70 #endif	/* __FS_NOTIFY_FSNOTIFY_H_ */
71