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