1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_FS_NOTIFY_H
3 #define _LINUX_FS_NOTIFY_H
6 * include/linux/fsnotify.h - generic hooks for filesystem notification, to
7 * reduce in-source duplication from both dnotify and inotify.
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.
12 * (C) Copyright 2005 Robert Love
15 #include <linux/fsnotify_backend.h>
16 #include <linux/audit.h>
17 #include <linux/slab.h>
18 #include <linux/bug.h>
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).
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.
29 static inline int fsnotify_name(__u32 mask
, const void *data
, int data_type
,
30 struct inode
*dir
, const struct qstr
*name
,
33 if (atomic_long_read(&dir
->i_sb
->s_fsnotify_connectors
) == 0)
36 return fsnotify(mask
, data
, data_type
, dir
, name
, NULL
, cookie
);
39 static inline void fsnotify_dirent(struct inode
*dir
, struct dentry
*dentry
,
42 fsnotify_name(mask
, dentry
, FSNOTIFY_EVENT_DENTRY
, dir
, &dentry
->d_name
, 0);
45 static inline void fsnotify_inode(struct inode
*inode
, __u32 mask
)
47 if (atomic_long_read(&inode
->i_sb
->s_fsnotify_connectors
) == 0)
50 if (S_ISDIR(inode
->i_mode
))
53 fsnotify(mask
, inode
, FSNOTIFY_EVENT_INODE
, NULL
, NULL
, inode
, 0);
56 /* Notify this dentry's parent about a child's events. */
57 static inline int fsnotify_parent(struct dentry
*dentry
, __u32 mask
,
58 const void *data
, int data_type
)
60 struct inode
*inode
= d_inode(dentry
);
62 if (atomic_long_read(&inode
->i_sb
->s_fsnotify_connectors
) == 0)
65 if (S_ISDIR(inode
->i_mode
)) {
68 /* sb/mount marks are not interested in name of directory */
69 if (!(dentry
->d_flags
& DCACHE_FSNOTIFY_PARENT_WATCHED
))
73 /* disconnected dentry cannot notify parent */
77 return __fsnotify_parent(dentry
, mask
, data
, data_type
);
80 return fsnotify(mask
, data
, data_type
, NULL
, NULL
, inode
, 0);
84 * Simple wrappers to consolidate calls to fsnotify_parent() when an event
85 * is on a file/dentry.
87 static inline void fsnotify_dentry(struct dentry
*dentry
, __u32 mask
)
89 fsnotify_parent(dentry
, mask
, dentry
, FSNOTIFY_EVENT_DENTRY
);
92 static inline int fsnotify_file(struct file
*file
, __u32 mask
)
94 const struct path
*path
;
96 if (file
->f_mode
& FMODE_NONOTIFY
)
100 return fsnotify_parent(path
->dentry
, mask
, path
, FSNOTIFY_EVENT_PATH
);
103 /* Simple call site for access decisions */
104 static inline int fsnotify_perm(struct file
*file
, int mask
)
107 __u32 fsnotify_mask
= 0;
109 if (!(mask
& (MAY_READ
| MAY_OPEN
)))
112 if (mask
& MAY_OPEN
) {
113 fsnotify_mask
= FS_OPEN_PERM
;
115 if (file
->f_flags
& __FMODE_EXEC
) {
116 ret
= fsnotify_file(file
, FS_OPEN_EXEC_PERM
);
121 } else if (mask
& MAY_READ
) {
122 fsnotify_mask
= FS_ACCESS_PERM
;
125 return fsnotify_file(file
, fsnotify_mask
);
129 * fsnotify_link_count - inode's link count changed
131 static inline void fsnotify_link_count(struct inode
*inode
)
133 fsnotify_inode(inode
, FS_ATTRIB
);
137 * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
139 static inline void fsnotify_move(struct inode
*old_dir
, struct inode
*new_dir
,
140 const struct qstr
*old_name
,
141 int isdir
, struct inode
*target
,
142 struct dentry
*moved
)
144 struct inode
*source
= moved
->d_inode
;
145 u32 fs_cookie
= fsnotify_get_cookie();
146 __u32 old_dir_mask
= FS_MOVED_FROM
;
147 __u32 new_dir_mask
= FS_MOVED_TO
;
148 __u32 rename_mask
= FS_RENAME
;
149 const struct qstr
*new_name
= &moved
->d_name
;
152 old_dir_mask
|= FS_ISDIR
;
153 new_dir_mask
|= FS_ISDIR
;
154 rename_mask
|= FS_ISDIR
;
157 /* Event with information about both old and new parent+name */
158 fsnotify_name(rename_mask
, moved
, FSNOTIFY_EVENT_DENTRY
,
159 old_dir
, old_name
, 0);
161 fsnotify_name(old_dir_mask
, source
, FSNOTIFY_EVENT_INODE
,
162 old_dir
, old_name
, fs_cookie
);
163 fsnotify_name(new_dir_mask
, source
, FSNOTIFY_EVENT_INODE
,
164 new_dir
, new_name
, fs_cookie
);
167 fsnotify_link_count(target
);
168 fsnotify_inode(source
, FS_MOVE_SELF
);
169 audit_inode_child(new_dir
, moved
, AUDIT_TYPE_CHILD_CREATE
);
173 * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
175 static inline void fsnotify_inode_delete(struct inode
*inode
)
177 __fsnotify_inode_delete(inode
);
181 * fsnotify_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
183 static inline void fsnotify_vfsmount_delete(struct vfsmount
*mnt
)
185 __fsnotify_vfsmount_delete(mnt
);
189 * fsnotify_inoderemove - an inode is going away
191 static inline void fsnotify_inoderemove(struct inode
*inode
)
193 fsnotify_inode(inode
, FS_DELETE_SELF
);
194 __fsnotify_inode_delete(inode
);
198 * fsnotify_create - 'name' was linked in
200 * Caller must make sure that dentry->d_name is stable.
201 * Note: some filesystems (e.g. kernfs) leave @dentry negative and instantiate
204 static inline void fsnotify_create(struct inode
*dir
, struct dentry
*dentry
)
206 audit_inode_child(dir
, dentry
, AUDIT_TYPE_CHILD_CREATE
);
208 fsnotify_dirent(dir
, dentry
, FS_CREATE
);
212 * fsnotify_link - new hardlink in 'inode' directory
214 * Caller must make sure that new_dentry->d_name is stable.
215 * Note: We have to pass also the linked inode ptr as some filesystems leave
216 * new_dentry->d_inode NULL and instantiate inode pointer later
218 static inline void fsnotify_link(struct inode
*dir
, struct inode
*inode
,
219 struct dentry
*new_dentry
)
221 fsnotify_link_count(inode
);
222 audit_inode_child(dir
, new_dentry
, AUDIT_TYPE_CHILD_CREATE
);
224 fsnotify_name(FS_CREATE
, inode
, FSNOTIFY_EVENT_INODE
,
225 dir
, &new_dentry
->d_name
, 0);
229 * fsnotify_delete - @dentry was unlinked and unhashed
231 * Caller must make sure that dentry->d_name is stable.
233 * Note: unlike fsnotify_unlink(), we have to pass also the unlinked inode
234 * as this may be called after d_delete() and old_dentry may be negative.
236 static inline void fsnotify_delete(struct inode
*dir
, struct inode
*inode
,
237 struct dentry
*dentry
)
239 __u32 mask
= FS_DELETE
;
241 if (S_ISDIR(inode
->i_mode
))
244 fsnotify_name(mask
, inode
, FSNOTIFY_EVENT_INODE
, dir
, &dentry
->d_name
,
249 * d_delete_notify - delete a dentry and call fsnotify_delete()
250 * @dentry: The dentry to delete
252 * This helper is used to guaranty that the unlinked inode cannot be found
253 * by lookup of this name after fsnotify_delete() event has been delivered.
255 static inline void d_delete_notify(struct inode
*dir
, struct dentry
*dentry
)
257 struct inode
*inode
= d_inode(dentry
);
261 fsnotify_delete(dir
, inode
, dentry
);
266 * fsnotify_unlink - 'name' was unlinked
268 * Caller must make sure that dentry->d_name is stable.
270 static inline void fsnotify_unlink(struct inode
*dir
, struct dentry
*dentry
)
272 if (WARN_ON_ONCE(d_is_negative(dentry
)))
275 fsnotify_delete(dir
, d_inode(dentry
), dentry
);
279 * fsnotify_mkdir - directory 'name' was created
281 * Caller must make sure that dentry->d_name is stable.
282 * Note: some filesystems (e.g. kernfs) leave @dentry negative and instantiate
285 static inline void fsnotify_mkdir(struct inode
*dir
, struct dentry
*dentry
)
287 audit_inode_child(dir
, dentry
, AUDIT_TYPE_CHILD_CREATE
);
289 fsnotify_dirent(dir
, dentry
, FS_CREATE
| FS_ISDIR
);
293 * fsnotify_rmdir - directory 'name' was removed
295 * Caller must make sure that dentry->d_name is stable.
297 static inline void fsnotify_rmdir(struct inode
*dir
, struct dentry
*dentry
)
299 if (WARN_ON_ONCE(d_is_negative(dentry
)))
302 fsnotify_delete(dir
, d_inode(dentry
), dentry
);
306 * fsnotify_access - file was read
308 static inline void fsnotify_access(struct file
*file
)
310 fsnotify_file(file
, FS_ACCESS
);
314 * fsnotify_modify - file was modified
316 static inline void fsnotify_modify(struct file
*file
)
318 fsnotify_file(file
, FS_MODIFY
);
322 * fsnotify_open - file was opened
324 static inline void fsnotify_open(struct file
*file
)
326 __u32 mask
= FS_OPEN
;
328 if (file
->f_flags
& __FMODE_EXEC
)
329 mask
|= FS_OPEN_EXEC
;
331 fsnotify_file(file
, mask
);
335 * fsnotify_close - file was closed
337 static inline void fsnotify_close(struct file
*file
)
339 __u32 mask
= (file
->f_mode
& FMODE_WRITE
) ? FS_CLOSE_WRITE
:
342 fsnotify_file(file
, mask
);
346 * fsnotify_xattr - extended attributes were changed
348 static inline void fsnotify_xattr(struct dentry
*dentry
)
350 fsnotify_dentry(dentry
, FS_ATTRIB
);
354 * fsnotify_change - notify_change event. file was modified and/or metadata
357 static inline void fsnotify_change(struct dentry
*dentry
, unsigned int ia_valid
)
361 if (ia_valid
& ATTR_UID
)
363 if (ia_valid
& ATTR_GID
)
365 if (ia_valid
& ATTR_SIZE
)
368 /* both times implies a utime(s) call */
369 if ((ia_valid
& (ATTR_ATIME
| ATTR_MTIME
)) == (ATTR_ATIME
| ATTR_MTIME
))
371 else if (ia_valid
& ATTR_ATIME
)
373 else if (ia_valid
& ATTR_MTIME
)
376 if (ia_valid
& ATTR_MODE
)
380 fsnotify_dentry(dentry
, mask
);
383 static inline int fsnotify_sb_error(struct super_block
*sb
, struct inode
*inode
,
386 struct fs_error_report report
= {
392 return fsnotify(FS_ERROR
, &report
, FSNOTIFY_EVENT_ERROR
,
393 NULL
, NULL
, NULL
, 0);
396 #endif /* _LINUX_FS_NOTIFY_H */