fs/notify/inotify/inotify_fsnotify.c

   1 /*
   2  * fs/inotify_user.c - inotify support for userspace
   3  *
   4  * Authors:
   5  *      John McCutchan  <ttb@tentacle.dhs.org>
   6  *      Robert Love     <rml@novell.com>
   7  *
   8  * Copyright (C) 2005 John McCutchan
   9  * Copyright 2006 Hewlett-Packard Development Company, L.P.
  10  *
  11  * Copyright (C) 2009 Eric Paris <Red Hat Inc>
  12  * inotify was largely rewriten to make use of the fsnotify infrastructure
  13  *
  14  * This program is free software; you can redistribute it and/or modify it
  15  * under the terms of the GNU General Public License as published by the
  16  * Free Software Foundation; either version 2, or (at your option) any
  17  * later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22  * General Public License for more details.
  23  */
  24
  25 #include <linux/fs.h> /* struct inode */
  26 #include <linux/fsnotify_backend.h>
  27 #include <linux/inotify.h>
  28 #include <linux/path.h> /* struct path */
  29 #include <linux/slab.h> /* kmem_* */
  30 #include <linux/types.h>
  31 #include <linux/sched.h>
  32
  33 #include "inotify.h"
  34
  35 /*
  36  * Check if 2 events contain the same information.  We do not compare private data
  37  * but at this moment that isn't a problem for any know fsnotify listeners.
  38  */
  39 static bool event_compare(struct fsnotify_event *old, struct fsnotify_event *new)
  40 {
  41         if ((old->mask == new->mask) &&
  42             (old->to_tell == new->to_tell) &&
  43             (old->data_type == new->data_type) &&
  44             (old->name_len == new->name_len)) {
  45                 switch (old->data_type) {
  46                 case (FSNOTIFY_EVENT_INODE):
  47                         /* remember, after old was put on the wait_q we aren't
  48                          * allowed to look at the inode any more, only thing
  49                          * left to check was if the file_name is the same */
  50                         if (!old->name_len ||
  51                             !strcmp(old->file_name, new->file_name))
  52                                 return true;
  53                         break;
  54                 case (FSNOTIFY_EVENT_PATH):
  55                         if ((old->path.mnt == new->path.mnt) &&
  56                             (old->path.dentry == new->path.dentry))
  57                                 return true;
  58                         break;
  59                 case (FSNOTIFY_EVENT_NONE):
  60                         if (old->mask & FS_Q_OVERFLOW)
  61                                 return true;
  62                         else if (old->mask & FS_IN_IGNORED)
  63                                 return false;
  64                         return true;
  65                 };
  66         }
  67         return false;
  68 }
  69
  70 static int inotify_merge(struct list_head *list,
  71                          struct fsnotify_event *event,
  72                          void **arg)
  73 {
  74         struct fsnotify_event_holder *last_holder;
  75         struct fsnotify_event *last_event;
  76         int ret = 0;
  77
  78         /* and the list better be locked by something too */
  79         spin_lock(&event->lock);
  80
  81         last_holder = list_entry(list->prev, struct fsnotify_event_holder, event_list);
  82         last_event = last_holder->event;
  83         if (event_compare(last_event, event))
  84                 ret = -EEXIST;
  85
  86         spin_unlock(&event->lock);
  87
  88         return ret;
  89 }
  90
  91 static int inotify_handle_event(struct fsnotify_group *group, struct fsnotify_event *event)
  92 {
  93         struct fsnotify_mark *fsn_mark;
  94         struct inotify_inode_mark *i_mark;
  95         struct inode *to_tell;
  96         struct inotify_event_private_data *event_priv;
  97         struct fsnotify_event_private_data *fsn_event_priv;
  98         int wd, ret;
  99
 100         to_tell = event->to_tell;
 101
 102         fsn_mark = fsnotify_find_inode_mark(group, to_tell);
 103         /* race with watch removal?  We already passes should_send */
 104         if (unlikely(!fsn_mark))
 105                 return 0;
 106         i_mark = container_of(fsn_mark, struct inotify_inode_mark,
 107                               fsn_mark);
 108         wd = i_mark->wd;
 109
 110         event_priv = kmem_cache_alloc(event_priv_cachep, GFP_KERNEL);
 111         if (unlikely(!event_priv))
 112                 return -ENOMEM;
 113
 114         fsn_event_priv = &event_priv->fsnotify_event_priv_data;
 115
 116         fsn_event_priv->group = group;
 117         event_priv->wd = wd;
 118
 119         ret = fsnotify_add_notify_event(group, event, fsn_event_priv, inotify_merge, NULL);
 120         if (ret) {
 121                 inotify_free_event_priv(fsn_event_priv);
 122                 /* EEXIST says we tail matched, EOVERFLOW isn't something
 123                  * to report up the stack. */
 124                 if ((ret == -EEXIST) ||
 125                     (ret == -EOVERFLOW))
 126                         ret = 0;
 127         }
 128
 129         if (fsn_mark->mask & IN_ONESHOT)
 130                 fsnotify_destroy_mark(fsn_mark);
 131
 132         /*
 133          * If we hold the fsn_mark until after the event is on the queue
 134          * IN_IGNORED won't be able to pass this event in the queue
 135          */
 136         fsnotify_put_mark(fsn_mark);
 137
 138         return ret;
 139 }
 140
 141 static void inotify_freeing_mark(struct fsnotify_mark *fsn_mark, struct fsnotify_group *group)
 142 {
 143         inotify_ignored_and_remove_idr(fsn_mark, group);
 144 }
 145
 146 static bool inotify_should_send_event(struct fsnotify_group *group, struct inode *inode,
 147                                       struct vfsmount *mnt, __u32 mask, void *data,
 148                                       int data_type)
 149 {
 150         struct fsnotify_mark *fsn_mark;
 151         bool send;
 152
 153         fsn_mark = fsnotify_find_inode_mark(group, inode);
 154         if (!fsn_mark)
 155                 return false;
 156
 157         mask = (mask & ~FS_EVENT_ON_CHILD);
 158         send = (fsn_mark->mask & mask);
 159
 160         /* find took a reference */
 161         fsnotify_put_mark(fsn_mark);
 162
 163         return send;
 164 }
 165
 166 /*
 167  * This is NEVER supposed to be called.  Inotify marks should either have been
 168  * removed from the idr when the watch was removed or in the
 169  * fsnotify_destroy_mark_by_group() call when the inotify instance was being
 170  * torn down.  This is only called if the idr is about to be freed but there
 171  * are still marks in it.
 172  */
 173 static int idr_callback(int id, void *p, void *data)
 174 {
 175         struct fsnotify_mark *fsn_mark;
 176         struct inotify_inode_mark *i_mark;
 177         static bool warned = false;
 178
 179         if (warned)
 180                 return 0;
 181
 182         warned = true;
 183         fsn_mark = p;
 184         i_mark = container_of(fsn_mark, struct inotify_inode_mark, fsn_mark);
 185
 186         WARN(1, "inotify closing but id=%d for fsn_mark=%p in group=%p still in "
 187                 "idr.  Probably leaking memory\n", id, p, data);
 188
 189         /*
 190          * I'm taking the liberty of assuming that the mark in question is a
 191          * valid address and I'm dereferencing it.  This might help to figure
 192          * out why we got here and the panic is no worse than the original
 193          * BUG() that was here.
 194          */
 195         if (fsn_mark)
 196                 printk(KERN_WARNING "fsn_mark->group=%p inode=%p wd=%d\n",
 197                         fsn_mark->group, fsn_mark->i.inode, i_mark->wd);
 198         return 0;
 199 }
 200
 201 static void inotify_free_group_priv(struct fsnotify_group *group)
 202 {
 203         /* ideally the idr is empty and we won't hit the BUG in teh callback */
 204         idr_for_each(&group->inotify_data.idr, idr_callback, group);
 205         idr_remove_all(&group->inotify_data.idr);
 206         idr_destroy(&group->inotify_data.idr);
 207         free_uid(group->inotify_data.user);
 208 }
 209
 210 void inotify_free_event_priv(struct fsnotify_event_private_data *fsn_event_priv)
 211 {
 212         struct inotify_event_private_data *event_priv;
 213
 214
 215         event_priv = container_of(fsn_event_priv, struct inotify_event_private_data,
 216                                   fsnotify_event_priv_data);
 217
 218         kmem_cache_free(event_priv_cachep, event_priv);
 219 }
 220
 221 const struct fsnotify_ops inotify_fsnotify_ops = {
 222         .handle_event = inotify_handle_event,
 223         .should_send_event = inotify_should_send_event,
 224         .free_group_priv = inotify_free_group_priv,
 225         .free_event_priv = inotify_free_event_priv,
 226         .freeing_mark = inotify_freeing_mark,
 227 };