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, struct fsnotify_event *event)
  71 {
  72         struct fsnotify_event_holder *last_holder;
  73         struct fsnotify_event *last_event;
  74         int ret = 0;
  75
  76         /* and the list better be locked by something too */
  77         spin_lock(&event->lock);
  78
  79         last_holder = list_entry(list->prev, struct fsnotify_event_holder, event_list);
  80         last_event = last_holder->event;
  81         if (event_compare(last_event, event))
  82                 ret = -EEXIST;
  83
  84         spin_unlock(&event->lock);
  85
  86         return ret;
  87 }
  88
  89 static int inotify_handle_event(struct fsnotify_group *group, struct fsnotify_event *event)
  90 {
  91         struct fsnotify_mark *fsn_mark;
  92         struct inotify_inode_mark *i_mark;
  93         struct inode *to_tell;
  94         struct inotify_event_private_data *event_priv;
  95         struct fsnotify_event_private_data *fsn_event_priv;
  96         int wd, ret;
  97
  98         to_tell = event->to_tell;
  99
 100         fsn_mark = fsnotify_find_mark(group, to_tell);
 101         /* race with watch removal?  We already passes should_send */
 102         if (unlikely(!fsn_mark))
 103                 return 0;
 104         i_mark = container_of(fsn_mark, struct inotify_inode_mark,
 105                               fsn_mark);
 106         wd = i_mark->wd;
 107
 108         event_priv = kmem_cache_alloc(event_priv_cachep, GFP_KERNEL);
 109         if (unlikely(!event_priv))
 110                 return -ENOMEM;
 111
 112         fsn_event_priv = &event_priv->fsnotify_event_priv_data;
 113
 114         fsn_event_priv->group = group;
 115         event_priv->wd = wd;
 116
 117         ret = fsnotify_add_notify_event(group, event, fsn_event_priv, inotify_merge);
 118         if (ret) {
 119                 inotify_free_event_priv(fsn_event_priv);
 120                 /* EEXIST says we tail matched, EOVERFLOW isn't something
 121                  * to report up the stack. */
 122                 if ((ret == -EEXIST) ||
 123                     (ret == -EOVERFLOW))
 124                         ret = 0;
 125         }
 126
 127         /*
 128          * If we hold the fsn_mark until after the event is on the queue
 129          * IN_IGNORED won't be able to pass this event in the queue
 130          */
 131         fsnotify_put_mark(fsn_mark);
 132
 133         return ret;
 134 }
 135
 136 static void inotify_freeing_mark(struct fsnotify_mark *fsn_mark, struct fsnotify_group *group)
 137 {
 138         inotify_ignored_and_remove_idr(fsn_mark, group);
 139 }
 140
 141 static bool inotify_should_send_event(struct fsnotify_group *group, struct inode *inode,
 142                                       struct vfsmount *mnt, __u32 mask, void *data,
 143                                       int data_type)
 144 {
 145         struct fsnotify_mark *fsn_mark;
 146         bool send;
 147
 148         fsn_mark = fsnotify_find_mark(group, inode);
 149         if (!fsn_mark)
 150                 return false;
 151
 152         mask = (mask & ~FS_EVENT_ON_CHILD);
 153         send = (fsn_mark->mask & mask);
 154
 155         /* find took a reference */
 156         fsnotify_put_mark(fsn_mark);
 157
 158         return send;
 159 }
 160
 161 /*
 162  * This is NEVER supposed to be called.  Inotify marks should either have been
 163  * removed from the idr when the watch was removed or in the
 164  * fsnotify_destroy_mark_by_group() call when the inotify instance was being
 165  * torn down.  This is only called if the idr is about to be freed but there
 166  * are still marks in it.
 167  */
 168 static int idr_callback(int id, void *p, void *data)
 169 {
 170         struct fsnotify_mark *fsn_mark;
 171         struct inotify_inode_mark *i_mark;
 172         static bool warned = false;
 173
 174         if (warned)
 175                 return 0;
 176
 177         warned = true;
 178         fsn_mark = p;
 179         i_mark = container_of(fsn_mark, struct inotify_inode_mark, fsn_mark);
 180
 181         WARN(1, "inotify closing but id=%d for fsn_mark=%p in group=%p still in "
 182                 "idr.  Probably leaking memory\n", id, p, data);
 183
 184         /*
 185          * I'm taking the liberty of assuming that the mark in question is a
 186          * valid address and I'm dereferencing it.  This might help to figure
 187          * out why we got here and the panic is no worse than the original
 188          * BUG() that was here.
 189          */
 190         if (fsn_mark)
 191                 printk(KERN_WARNING "fsn_mark->group=%p inode=%p wd=%d\n",
 192                         fsn_mark->group, fsn_mark->i.inode, i_mark->wd);
 193         return 0;
 194 }
 195
 196 static void inotify_free_group_priv(struct fsnotify_group *group)
 197 {
 198         /* ideally the idr is empty and we won't hit the BUG in teh callback */
 199         idr_for_each(&group->inotify_data.idr, idr_callback, group);
 200         idr_remove_all(&group->inotify_data.idr);
 201         idr_destroy(&group->inotify_data.idr);
 202         free_uid(group->inotify_data.user);
 203 }
 204
 205 void inotify_free_event_priv(struct fsnotify_event_private_data *fsn_event_priv)
 206 {
 207         struct inotify_event_private_data *event_priv;
 208
 209
 210         event_priv = container_of(fsn_event_priv, struct inotify_event_private_data,
 211                                   fsnotify_event_priv_data);
 212
 213         kmem_cache_free(event_priv_cachep, event_priv);
 214 }
 215
 216 const struct fsnotify_ops inotify_fsnotify_ops = {
 217         .handle_event = inotify_handle_event,
 218         .should_send_event = inotify_should_send_event,
 219         .free_group_priv = inotify_free_group_priv,
 220         .free_event_priv = inotify_free_event_priv,
 221         .freeing_mark = inotify_freeing_mark,
 222 };