include/linux/fsnotify.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_FS_NOTIFY_H
   3 #define _LINUX_FS_NOTIFY_H
   4
   5 /*
   6  * include/linux/fsnotify.h - generic hooks for filesystem notification, to
   7  * reduce in-source duplication from both dnotify and inotify.
   8  *
   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.
  11  *
  12  * (C) Copyright 2005 Robert Love
  13  */
  14
  15 #include <linux/fsnotify_backend.h>
  16 #include <linux/audit.h>
  17 #include <linux/slab.h>
  18 #include <linux/bug.h>
  19
  20 /*
  21  * Notify this @dir inode about a change in the directory entry @dentry.
  22  *
  23  * Unlike fsnotify_parent(), the event will be reported regardless of the
  24  * FS_EVENT_ON_CHILD mask on the parent inode.
  25  */
  26 static inline int fsnotify_dirent(struct inode *dir, struct dentry *dentry,
  27                                   __u32 mask)
  28 {
  29         return fsnotify(dir, mask, d_inode(dentry), FSNOTIFY_EVENT_INODE,
  30                         dentry->d_name.name, 0);
  31 }
  32
  33 /* Notify this dentry's parent about a child's events. */
  34 static inline int fsnotify_parent(const struct path *path,
  35                                   struct dentry *dentry, __u32 mask)
  36 {
  37         if (!dentry)
  38                 dentry = path->dentry;
  39
  40         return __fsnotify_parent(path, dentry, mask);
  41 }
  42
  43 /*
  44  * Simple wrapper to consolidate calls fsnotify_parent()/fsnotify() when
  45  * an event is on a path.
  46  */
  47 static inline int fsnotify_path(struct inode *inode, const struct path *path,
  48                                 __u32 mask)
  49 {
  50         int ret = fsnotify_parent(path, NULL, mask);
  51
  52         if (ret)
  53                 return ret;
  54         return fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
  55 }
  56
  57 /* Simple call site for access decisions */
  58 static inline int fsnotify_perm(struct file *file, int mask)
  59 {
  60         int ret;
  61         const struct path *path = &file->f_path;
  62         struct inode *inode = file_inode(file);
  63         __u32 fsnotify_mask = 0;
  64
  65         if (file->f_mode & FMODE_NONOTIFY)
  66                 return 0;
  67         if (!(mask & (MAY_READ | MAY_OPEN)))
  68                 return 0;
  69         if (mask & MAY_OPEN) {
  70                 fsnotify_mask = FS_OPEN_PERM;
  71
  72                 if (file->f_flags & __FMODE_EXEC) {
  73                         ret = fsnotify_path(inode, path, FS_OPEN_EXEC_PERM);
  74
  75                         if (ret)
  76                                 return ret;
  77                 }
  78         } else if (mask & MAY_READ) {
  79                 fsnotify_mask = FS_ACCESS_PERM;
  80         }
  81
  82         return fsnotify_path(inode, path, fsnotify_mask);
  83 }
  84
  85 /*
  86  * fsnotify_link_count - inode's link count changed
  87  */
  88 static inline void fsnotify_link_count(struct inode *inode)
  89 {
  90         fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
  91 }
  92
  93 /*
  94  * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
  95  */
  96 static inline void fsnotify_move(struct inode *old_dir, struct inode *new_dir,
  97                                  const unsigned char *old_name,
  98                                  int isdir, struct inode *target, struct dentry *moved)
  99 {
 100         struct inode *source = moved->d_inode;
 101         u32 fs_cookie = fsnotify_get_cookie();
 102         __u32 old_dir_mask = FS_MOVED_FROM;
 103         __u32 new_dir_mask = FS_MOVED_TO;
 104         const unsigned char *new_name = moved->d_name.name;
 105
 106         if (old_dir == new_dir)
 107                 old_dir_mask |= FS_DN_RENAME;
 108
 109         if (isdir) {
 110                 old_dir_mask |= FS_ISDIR;
 111                 new_dir_mask |= FS_ISDIR;
 112         }
 113
 114         fsnotify(old_dir, old_dir_mask, source, FSNOTIFY_EVENT_INODE, old_name,
 115                  fs_cookie);
 116         fsnotify(new_dir, new_dir_mask, source, FSNOTIFY_EVENT_INODE, new_name,
 117                  fs_cookie);
 118
 119         if (target)
 120                 fsnotify_link_count(target);
 121
 122         if (source)
 123                 fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE, NULL, 0);
 124         audit_inode_child(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
 125 }
 126
 127 /*
 128  * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
 129  */
 130 static inline void fsnotify_inode_delete(struct inode *inode)
 131 {
 132         __fsnotify_inode_delete(inode);
 133 }
 134
 135 /*
 136  * fsnotify_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
 137  */
 138 static inline void fsnotify_vfsmount_delete(struct vfsmount *mnt)
 139 {
 140         __fsnotify_vfsmount_delete(mnt);
 141 }
 142
 143 /*
 144  * fsnotify_nameremove - a filename was removed from a directory
 145  *
 146  * This is mostly called under parent vfs inode lock so name and
 147  * dentry->d_parent should be stable. However there are some corner cases where
 148  * inode lock is not held. So to be on the safe side and be reselient to future
 149  * callers and out of tree users of d_delete(), we do not assume that d_parent
 150  * and d_name are stable and we use dget_parent() and
 151  * take_dentry_name_snapshot() to grab stable references.
 152  */
 153 static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
 154 {
 155         struct dentry *parent;
 156         struct name_snapshot name;
 157         __u32 mask = FS_DELETE;
 158
 159         /* d_delete() of pseudo inode? (e.g. __ns_get_path() playing tricks) */
 160         if (IS_ROOT(dentry))
 161                 return;
 162
 163         if (isdir)
 164                 mask |= FS_ISDIR;
 165
 166         parent = dget_parent(dentry);
 167         take_dentry_name_snapshot(&name, dentry);
 168
 169         fsnotify(d_inode(parent), mask, d_inode(dentry), FSNOTIFY_EVENT_INODE,
 170                  name.name, 0);
 171
 172         release_dentry_name_snapshot(&name);
 173         dput(parent);
 174 }
 175
 176 /*
 177  * fsnotify_inoderemove - an inode is going away
 178  */
 179 static inline void fsnotify_inoderemove(struct inode *inode)
 180 {
 181         fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
 182         __fsnotify_inode_delete(inode);
 183 }
 184
 185 /*
 186  * fsnotify_create - 'name' was linked in
 187  */
 188 static inline void fsnotify_create(struct inode *inode, struct dentry *dentry)
 189 {
 190         audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
 191
 192         fsnotify_dirent(inode, dentry, FS_CREATE);
 193 }
 194
 195 /*
 196  * fsnotify_link - new hardlink in 'inode' directory
 197  * Note: We have to pass also the linked inode ptr as some filesystems leave
 198  *   new_dentry->d_inode NULL and instantiate inode pointer later
 199  */
 200 static inline void fsnotify_link(struct inode *dir, struct inode *inode, struct dentry *new_dentry)
 201 {
 202         fsnotify_link_count(inode);
 203         audit_inode_child(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);
 204
 205         fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE, new_dentry->d_name.name, 0);
 206 }
 207
 208 /*
 209  * fsnotify_mkdir - directory 'name' was created
 210  */
 211 static inline void fsnotify_mkdir(struct inode *inode, struct dentry *dentry)
 212 {
 213         audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
 214
 215         fsnotify_dirent(inode, dentry, FS_CREATE | FS_ISDIR);
 216 }
 217
 218 /*
 219  * fsnotify_access - file was read
 220  */
 221 static inline void fsnotify_access(struct file *file)
 222 {
 223         const struct path *path = &file->f_path;
 224         struct inode *inode = file_inode(file);
 225         __u32 mask = FS_ACCESS;
 226
 227         if (S_ISDIR(inode->i_mode))
 228                 mask |= FS_ISDIR;
 229
 230         if (!(file->f_mode & FMODE_NONOTIFY))
 231                 fsnotify_path(inode, path, mask);
 232 }
 233
 234 /*
 235  * fsnotify_modify - file was modified
 236  */
 237 static inline void fsnotify_modify(struct file *file)
 238 {
 239         const struct path *path = &file->f_path;
 240         struct inode *inode = file_inode(file);
 241         __u32 mask = FS_MODIFY;
 242
 243         if (S_ISDIR(inode->i_mode))
 244                 mask |= FS_ISDIR;
 245
 246         if (!(file->f_mode & FMODE_NONOTIFY))
 247                 fsnotify_path(inode, path, mask);
 248 }
 249
 250 /*
 251  * fsnotify_open - file was opened
 252  */
 253 static inline void fsnotify_open(struct file *file)
 254 {
 255         const struct path *path = &file->f_path;
 256         struct inode *inode = file_inode(file);
 257         __u32 mask = FS_OPEN;
 258
 259         if (S_ISDIR(inode->i_mode))
 260                 mask |= FS_ISDIR;
 261         if (file->f_flags & __FMODE_EXEC)
 262                 mask |= FS_OPEN_EXEC;
 263
 264         fsnotify_path(inode, path, mask);
 265 }
 266
 267 /*
 268  * fsnotify_close - file was closed
 269  */
 270 static inline void fsnotify_close(struct file *file)
 271 {
 272         const struct path *path = &file->f_path;
 273         struct inode *inode = file_inode(file);
 274         fmode_t mode = file->f_mode;
 275         __u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;
 276
 277         if (S_ISDIR(inode->i_mode))
 278                 mask |= FS_ISDIR;
 279
 280         if (!(file->f_mode & FMODE_NONOTIFY))
 281                 fsnotify_path(inode, path, mask);
 282 }
 283
 284 /*
 285  * fsnotify_xattr - extended attributes were changed
 286  */
 287 static inline void fsnotify_xattr(struct dentry *dentry)
 288 {
 289         struct inode *inode = dentry->d_inode;
 290         __u32 mask = FS_ATTRIB;
 291
 292         if (S_ISDIR(inode->i_mode))
 293                 mask |= FS_ISDIR;
 294
 295         fsnotify_parent(NULL, dentry, mask);
 296         fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
 297 }
 298
 299 /*
 300  * fsnotify_change - notify_change event.  file was modified and/or metadata
 301  * was changed.
 302  */
 303 static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
 304 {
 305         struct inode *inode = dentry->d_inode;
 306         __u32 mask = 0;
 307
 308         if (ia_valid & ATTR_UID)
 309                 mask |= FS_ATTRIB;
 310         if (ia_valid & ATTR_GID)
 311                 mask |= FS_ATTRIB;
 312         if (ia_valid & ATTR_SIZE)
 313                 mask |= FS_MODIFY;
 314
 315         /* both times implies a utime(s) call */
 316         if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
 317                 mask |= FS_ATTRIB;
 318         else if (ia_valid & ATTR_ATIME)
 319                 mask |= FS_ACCESS;
 320         else if (ia_valid & ATTR_MTIME)
 321                 mask |= FS_MODIFY;
 322
 323         if (ia_valid & ATTR_MODE)
 324                 mask |= FS_ATTRIB;
 325
 326         if (mask) {
 327                 if (S_ISDIR(inode->i_mode))
 328                         mask |= FS_ISDIR;
 329
 330                 fsnotify_parent(NULL, dentry, mask);
 331                 fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
 332         }
 333 }
 334
 335 #endif  /* _LINUX_FS_NOTIFY_H */