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.
28 static inline void fsnotify_name(struct inode *dir, __u32 mask,
30 const struct qstr *name, u32 cookie)
32 fsnotify(dir, mask, child, FSNOTIFY_EVENT_INODE, name, cookie);
34 * Send another flavor of the event without child inode data and
35 * without the specific event type (e.g. FS_CREATE|FS_IS_DIR).
36 * The name is relative to the dir inode the event is reported to.
38 fsnotify(dir, FS_DIR_MODIFY, dir, FSNOTIFY_EVENT_INODE, name, 0);
41 static inline void fsnotify_dirent(struct inode *dir, struct dentry *dentry,
44 fsnotify_name(dir, mask, d_inode(dentry), &dentry->d_name, 0);
48 * Simple wrappers to consolidate calls fsnotify_parent()/fsnotify() when
49 * an event is on a file/dentry.
51 static inline void fsnotify_dentry(struct dentry *dentry, __u32 mask)
53 struct inode *inode = d_inode(dentry);
55 if (S_ISDIR(inode->i_mode))
58 fsnotify_parent(dentry, mask, inode, FSNOTIFY_EVENT_INODE);
59 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
62 static inline int fsnotify_file(struct file *file, __u32 mask)
64 const struct path *path = &file->f_path;
65 struct inode *inode = file_inode(file);
68 if (file->f_mode & FMODE_NONOTIFY)
71 if (S_ISDIR(inode->i_mode))
74 ret = fsnotify_parent(path->dentry, mask, path, FSNOTIFY_EVENT_PATH);
78 return fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
81 /* Simple call site for access decisions */
82 static inline int fsnotify_perm(struct file *file, int mask)
85 __u32 fsnotify_mask = 0;
87 if (!(mask & (MAY_READ | MAY_OPEN)))
90 if (mask & MAY_OPEN) {
91 fsnotify_mask = FS_OPEN_PERM;
93 if (file->f_flags & __FMODE_EXEC) {
94 ret = fsnotify_file(file, FS_OPEN_EXEC_PERM);
99 } else if (mask & MAY_READ) {
100 fsnotify_mask = FS_ACCESS_PERM;
103 return fsnotify_file(file, fsnotify_mask);
107 * fsnotify_link_count - inode's link count changed
109 static inline void fsnotify_link_count(struct inode *inode)
111 __u32 mask = FS_ATTRIB;
113 if (S_ISDIR(inode->i_mode))
116 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
120 * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
122 static inline void fsnotify_move(struct inode *old_dir, struct inode *new_dir,
123 const struct qstr *old_name,
124 int isdir, struct inode *target,
125 struct dentry *moved)
127 struct inode *source = moved->d_inode;
128 u32 fs_cookie = fsnotify_get_cookie();
129 __u32 old_dir_mask = FS_MOVED_FROM;
130 __u32 new_dir_mask = FS_MOVED_TO;
131 __u32 mask = FS_MOVE_SELF;
132 const struct qstr *new_name = &moved->d_name;
134 if (old_dir == new_dir)
135 old_dir_mask |= FS_DN_RENAME;
138 old_dir_mask |= FS_ISDIR;
139 new_dir_mask |= FS_ISDIR;
143 fsnotify_name(old_dir, old_dir_mask, source, old_name, fs_cookie);
144 fsnotify_name(new_dir, new_dir_mask, source, new_name, fs_cookie);
147 fsnotify_link_count(target);
150 fsnotify(source, mask, source, FSNOTIFY_EVENT_INODE, NULL, 0);
151 audit_inode_child(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
155 * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
157 static inline void fsnotify_inode_delete(struct inode *inode)
159 __fsnotify_inode_delete(inode);
163 * fsnotify_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
165 static inline void fsnotify_vfsmount_delete(struct vfsmount *mnt)
167 __fsnotify_vfsmount_delete(mnt);
171 * fsnotify_inoderemove - an inode is going away
173 static inline void fsnotify_inoderemove(struct inode *inode)
175 __u32 mask = FS_DELETE_SELF;
177 if (S_ISDIR(inode->i_mode))
180 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
181 __fsnotify_inode_delete(inode);
185 * fsnotify_create - 'name' was linked in
187 static inline void fsnotify_create(struct inode *inode, struct dentry *dentry)
189 audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
191 fsnotify_dirent(inode, dentry, FS_CREATE);
195 * fsnotify_link - new hardlink in 'inode' directory
196 * Note: We have to pass also the linked inode ptr as some filesystems leave
197 * new_dentry->d_inode NULL and instantiate inode pointer later
199 static inline void fsnotify_link(struct inode *dir, struct inode *inode,
200 struct dentry *new_dentry)
202 fsnotify_link_count(inode);
203 audit_inode_child(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);
205 fsnotify_name(dir, FS_CREATE, inode, &new_dentry->d_name, 0);
209 * fsnotify_unlink - 'name' was unlinked
211 * Caller must make sure that dentry->d_name is stable.
213 static inline void fsnotify_unlink(struct inode *dir, struct dentry *dentry)
215 /* Expected to be called before d_delete() */
216 WARN_ON_ONCE(d_is_negative(dentry));
218 fsnotify_dirent(dir, dentry, FS_DELETE);
222 * fsnotify_mkdir - directory 'name' was created
224 static inline void fsnotify_mkdir(struct inode *inode, struct dentry *dentry)
226 audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
228 fsnotify_dirent(inode, dentry, FS_CREATE | FS_ISDIR);
232 * fsnotify_rmdir - directory 'name' was removed
234 * Caller must make sure that dentry->d_name is stable.
236 static inline void fsnotify_rmdir(struct inode *dir, struct dentry *dentry)
238 /* Expected to be called before d_delete() */
239 WARN_ON_ONCE(d_is_negative(dentry));
241 fsnotify_dirent(dir, dentry, FS_DELETE | FS_ISDIR);
245 * fsnotify_access - file was read
247 static inline void fsnotify_access(struct file *file)
249 fsnotify_file(file, FS_ACCESS);
253 * fsnotify_modify - file was modified
255 static inline void fsnotify_modify(struct file *file)
257 fsnotify_file(file, FS_MODIFY);
261 * fsnotify_open - file was opened
263 static inline void fsnotify_open(struct file *file)
265 __u32 mask = FS_OPEN;
267 if (file->f_flags & __FMODE_EXEC)
268 mask |= FS_OPEN_EXEC;
270 fsnotify_file(file, mask);
274 * fsnotify_close - file was closed
276 static inline void fsnotify_close(struct file *file)
278 __u32 mask = (file->f_mode & FMODE_WRITE) ? FS_CLOSE_WRITE :
281 fsnotify_file(file, mask);
285 * fsnotify_xattr - extended attributes were changed
287 static inline void fsnotify_xattr(struct dentry *dentry)
289 fsnotify_dentry(dentry, FS_ATTRIB);
293 * fsnotify_change - notify_change event. file was modified and/or metadata
296 static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
300 if (ia_valid & ATTR_UID)
302 if (ia_valid & ATTR_GID)
304 if (ia_valid & ATTR_SIZE)
307 /* both times implies a utime(s) call */
308 if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
310 else if (ia_valid & ATTR_ATIME)
312 else if (ia_valid & ATTR_MTIME)
315 if (ia_valid & ATTR_MODE)
319 fsnotify_dentry(dentry, mask);
322 #endif /* _LINUX_FS_NOTIFY_H */