include/linux/fsnotify.h

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