fs/notify/group.c

   1 /*
   2  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2, or (at your option)
   7  *  any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; see the file COPYING.  If not, write to
  16  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <linux/list.h>
  20 #include <linux/mutex.h>
  21 #include <linux/slab.h>
  22 #include <linux/srcu.h>
  23 #include <linux/rculist.h>
  24 #include <linux/wait.h>
  25 #include <linux/module.h>
  26
  27 #include <linux/fsnotify_backend.h>
  28 #include "fsnotify.h"
  29
  30 #include <linux/atomic.h>
  31
  32 /*
  33  * Final freeing of a group
  34  */
  35 void fsnotify_final_destroy_group(struct fsnotify_group *group)
  36 {
  37         /* clear the notification queue of all events */
  38         fsnotify_flush_notify(group);
  39
  40         if (group->ops->free_group_priv)
  41                 group->ops->free_group_priv(group);
  42
  43         kfree(group);
  44 }
  45
  46 /*
  47  * Trying to get rid of a group.  We need to first get rid of any outstanding
  48  * allocations and then free the group.  Remember that fsnotify_clear_marks_by_group
  49  * could miss marks that are being freed by inode and those marks could still
  50  * hold a reference to this group (via group->num_marks)  If we get into that
  51  * situtation, the fsnotify_final_destroy_group will get called when that final
  52  * mark is freed.
  53  */
  54 static void fsnotify_destroy_group(struct fsnotify_group *group)
  55 {
  56         /* clear all inode marks for this group */
  57         fsnotify_clear_marks_by_group(group);
  58
  59         synchronize_srcu(&fsnotify_mark_srcu);
  60
  61         /* past the point of no return, matches the initial value of 1 */
  62         if (atomic_dec_and_test(&group->num_marks))
  63                 fsnotify_final_destroy_group(group);
  64 }
  65
  66 /*
  67  * Drop a reference to a group.  Free it if it's through.
  68  */
  69 void fsnotify_put_group(struct fsnotify_group *group)
  70 {
  71         if (atomic_dec_and_test(&group->refcnt))
  72                 fsnotify_destroy_group(group);
  73 }
  74 EXPORT_SYMBOL(fsnotify_put_group);
  75
  76 /*
  77  * Create a new fsnotify_group and hold a reference for the group returned.
  78  */
  79 struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops)
  80 {
  81         struct fsnotify_group *group;
  82
  83         group = kzalloc(sizeof(struct fsnotify_group), GFP_KERNEL);
  84         if (!group)
  85                 return ERR_PTR(-ENOMEM);
  86
  87         /* set to 0 when there a no external references to this group */
  88         atomic_set(&group->refcnt, 1);
  89         /*
  90          * hits 0 when there are no external references AND no marks for
  91          * this group
  92          */
  93         atomic_set(&group->num_marks, 1);
  94
  95         mutex_init(&group->notification_mutex);
  96         INIT_LIST_HEAD(&group->notification_list);
  97         init_waitqueue_head(&group->notification_waitq);
  98         group->max_events = UINT_MAX;
  99
 100         spin_lock_init(&group->mark_lock);
 101         INIT_LIST_HEAD(&group->marks_list);
 102
 103         group->ops = ops;
 104
 105         return group;
 106 }
 107 EXPORT_SYMBOL(fsnotify_alloc_group);