xref: /linux/fs/notify/fsnotify.h (revision ca220141fa8ebae09765a242076b2b77338106b0)
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 /*
13  * fsnotify_connp_t is what we embed in objects which connector can be attached
14  * to.
15  */
16 typedef struct fsnotify_mark_connector __rcu *fsnotify_connp_t;
17 
18 static inline struct inode *fsnotify_conn_inode(
19 				struct fsnotify_mark_connector *conn)
20 {
21 	return conn->obj;
22 }
23 
24 static inline struct mount *fsnotify_conn_mount(
25 				struct fsnotify_mark_connector *conn)
26 {
27 	return real_mount(conn->obj);
28 }
29 
30 static inline struct super_block *fsnotify_conn_sb(
31 				struct fsnotify_mark_connector *conn)
32 {
33 	return conn->obj;
34 }
35 
36 static inline struct mnt_namespace *fsnotify_conn_mntns(
37 				struct fsnotify_mark_connector *conn)
38 {
39 	return conn->obj;
40 }
41 
42 static inline struct super_block *fsnotify_object_sb(void *obj,
43 			enum fsnotify_obj_type obj_type)
44 {
45 	switch (obj_type) {
46 	case FSNOTIFY_OBJ_TYPE_INODE:
47 		return ((struct inode *)obj)->i_sb;
48 	case FSNOTIFY_OBJ_TYPE_VFSMOUNT:
49 		return ((struct vfsmount *)obj)->mnt_sb;
50 	case FSNOTIFY_OBJ_TYPE_SB:
51 		return (struct super_block *)obj;
52 	default:
53 		return NULL;
54 	}
55 }
56 
57 static inline struct super_block *fsnotify_connector_sb(
58 				struct fsnotify_mark_connector *conn)
59 {
60 	return fsnotify_object_sb(conn->obj, conn->type);
61 }
62 
63 static inline fsnotify_connp_t *fsnotify_sb_marks(struct super_block *sb)
64 {
65 	struct fsnotify_sb_info *sbinfo = fsnotify_sb_info(sb);
66 
67 	return sbinfo ? &sbinfo->sb_marks : NULL;
68 }
69 
70 /* destroy all events sitting in this groups notification queue */
71 extern void fsnotify_flush_notify(struct fsnotify_group *group);
72 
73 /* protects reads of inode and vfsmount marks list */
74 extern struct srcu_struct fsnotify_mark_srcu;
75 
76 /* compare two groups for sorting of marks lists */
77 extern int fsnotify_compare_groups(struct fsnotify_group *a,
78 				   struct fsnotify_group *b);
79 
80 /* Destroy all inode marks for given superblock */
81 void fsnotify_unmount_inodes(struct fsnotify_sb_info *sbinfo);
82 
83 /* Destroy all marks attached to an object via connector */
84 extern void fsnotify_destroy_marks(fsnotify_connp_t *connp);
85 /* run the list of all marks associated with inode and destroy them */
86 static inline void fsnotify_clear_marks_by_inode(struct inode *inode)
87 {
88 	fsnotify_destroy_marks(&inode->i_fsnotify_marks);
89 }
90 /* run the list of all marks associated with vfsmount and destroy them */
91 static inline void fsnotify_clear_marks_by_mount(struct vfsmount *mnt)
92 {
93 	fsnotify_destroy_marks(&real_mount(mnt)->mnt_fsnotify_marks);
94 }
95 /* run the list of all marks associated with sb and destroy them */
96 static inline void fsnotify_clear_marks_by_sb(struct super_block *sb)
97 {
98 	fsnotify_destroy_marks(fsnotify_sb_marks(sb));
99 }
100 
101 static inline void fsnotify_clear_marks_by_mntns(struct mnt_namespace *mntns)
102 {
103 	fsnotify_destroy_marks(&mntns->n_fsnotify_marks);
104 }
105 
106 /*
107  * update the dentry->d_flags of all of inode's children to indicate if inode cares
108  * about events that happen to its children.
109  */
110 extern void fsnotify_set_children_dentry_flags(struct inode *inode);
111 
112 void fsnotify_init_connector_caches(void);
113 
114 #endif	/* __FS_NOTIFY_FSNOTIFY_H_ */
115