xref: /linux/fs/notify/fsnotify.h (revision 24bce201d79807b668bf9d9e0aca801c5c0d5f78)
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 static inline struct super_block *fsnotify_connector_sb(
31 				struct fsnotify_mark_connector *conn)
32 {
33 	switch (conn->type) {
34 	case FSNOTIFY_OBJ_TYPE_INODE:
35 		return fsnotify_conn_inode(conn)->i_sb;
36 	case FSNOTIFY_OBJ_TYPE_VFSMOUNT:
37 		return fsnotify_conn_mount(conn)->mnt.mnt_sb;
38 	case FSNOTIFY_OBJ_TYPE_SB:
39 		return fsnotify_conn_sb(conn);
40 	default:
41 		return NULL;
42 	}
43 }
44 
45 /* destroy all events sitting in this groups notification queue */
46 extern void fsnotify_flush_notify(struct fsnotify_group *group);
47 
48 /* protects reads of inode and vfsmount marks list */
49 extern struct srcu_struct fsnotify_mark_srcu;
50 
51 /* compare two groups for sorting of marks lists */
52 extern int fsnotify_compare_groups(struct fsnotify_group *a,
53 				   struct fsnotify_group *b);
54 
55 /* Destroy all marks attached to an object via connector */
56 extern void fsnotify_destroy_marks(fsnotify_connp_t *connp);
57 /* run the list of all marks associated with inode and destroy them */
58 static inline void fsnotify_clear_marks_by_inode(struct inode *inode)
59 {
60 	fsnotify_destroy_marks(&inode->i_fsnotify_marks);
61 }
62 /* run the list of all marks associated with vfsmount and destroy them */
63 static inline void fsnotify_clear_marks_by_mount(struct vfsmount *mnt)
64 {
65 	fsnotify_destroy_marks(&real_mount(mnt)->mnt_fsnotify_marks);
66 }
67 /* run the list of all marks associated with sb and destroy them */
68 static inline void fsnotify_clear_marks_by_sb(struct super_block *sb)
69 {
70 	fsnotify_destroy_marks(&sb->s_fsnotify_marks);
71 }
72 
73 /*
74  * update the dentry->d_flags of all of inode's children to indicate if inode cares
75  * about events that happen to its children.
76  */
77 extern void __fsnotify_update_child_dentry_flags(struct inode *inode);
78 
79 /* allocate and destroy and event holder to attach events to notification/access queues */
80 extern struct fsnotify_event_holder *fsnotify_alloc_event_holder(void);
81 extern void fsnotify_destroy_event_holder(struct fsnotify_event_holder *holder);
82 
83 extern struct kmem_cache *fsnotify_mark_connector_cachep;
84 
85 #endif	/* __FS_NOTIFY_FSNOTIFY_H_ */
86