notification.c 6.46 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 */

19 20
/*
 * Basic idea behind the notification queue: An fsnotify group (like inotify)
21
 * sends the userspace notification about events asynchronously some time after
22 23 24 25 26 27 28 29 30 31 32 33
 * the event happened.  When inotify gets an event it will need to add that
 * event to the group notify queue.  Since a single event might need to be on
 * multiple group's notification queues we can't add the event directly to each
 * queue and instead add a small "event_holder" to each queue.  This event_holder
 * has a pointer back to the original event.  Since the majority of events are
 * going to end up on one, and only one, notification queue we embed one
 * event_holder into each event.  This means we have a single allocation instead
 * of always needing two.  If the embedded event_holder is already in use by
 * another group a new event_holder (from fsnotify_event_holder_cachep) will be
 * allocated and used.
 */

34 35 36 37
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/list.h>
38
#include <linux/module.h>
39 40 41 42 43 44 45
#include <linux/mount.h>
#include <linux/mutex.h>
#include <linux/namei.h>
#include <linux/path.h>
#include <linux/slab.h>
#include <linux/spinlock.h>

Arun Sharma's avatar
Arun Sharma committed
46
#include <linux/atomic.h>
47 48 49 50

#include <linux/fsnotify_backend.h>
#include "fsnotify.h"

51 52 53 54 55 56 57 58 59 60 61
static atomic_t fsnotify_sync_cookie = ATOMIC_INIT(0);

/**
 * fsnotify_get_cookie - return a unique cookie for use in synchronizing events.
 * Called from fsnotify_move, which is inlined into filesystem modules.
 */
u32 fsnotify_get_cookie(void)
{
	return atomic_inc_return(&fsnotify_sync_cookie);
}
EXPORT_SYMBOL_GPL(fsnotify_get_cookie);
62 63 64 65

/* return true if the notify queue is empty, false otherwise */
bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group)
{
66 67
	BUG_ON(IS_ENABLED(CONFIG_SMP) &&
	       !spin_is_locked(&group->notification_lock));
68 69
	return list_empty(&group->notification_list) ? true : false;
}
70

71 72
void fsnotify_destroy_event(struct fsnotify_group *group,
			    struct fsnotify_event *event)
73
{
74 75
	/* Overflow events are per-group and we don't want to free them */
	if (!event || event->mask == FS_Q_OVERFLOW)
76
		return;
77 78
	/* If the event is still queued, we have a problem... */
	WARN_ON(!list_empty(&event->list));
79
	group->ops->free_event(event);
80 81
}

82
/*
83
 * Add an event to the group notification queue.  The group can later pull this
84
 * event off the queue to deal with.  The function returns 0 if the event was
85
 * added to the queue, 1 if the event was merged with some other queued event,
86 87
 * 2 if the event was not queued - either the queue of events has overflown
 * or the group is shutting down.
88
 */
89 90 91 92
int fsnotify_add_event(struct fsnotify_group *group,
		       struct fsnotify_event *event,
		       int (*merge)(struct list_head *,
				    struct fsnotify_event *))
93
{
94
	int ret = 0;
95
	struct list_head *list = &group->notification_list;
96

97
	pr_debug("%s: group=%p event=%p\n", __func__, group, event);
98

99
	spin_lock(&group->notification_lock);
100

101
	if (group->shutdown) {
102
		spin_unlock(&group->notification_lock);
103 104 105
		return 2;
	}

106
	if (group->q_len >= group->max_events) {
107
		ret = 2;
108
		/* Queue overflow event only if it isn't already queued */
109
		if (!list_empty(&group->overflow_event->list)) {
110
			spin_unlock(&group->notification_lock);
111 112
			return ret;
		}
113
		event = group->overflow_event;
114
		goto queue;
115
	}
116

117
	if (!list_empty(list) && merge) {
118 119
		ret = merge(list, event);
		if (ret) {
120
			spin_unlock(&group->notification_lock);
121
			return ret;
122
		}
123 124
	}

125
queue:
126
	group->q_len++;
127
	list_add_tail(&event->list, list);
128
	spin_unlock(&group->notification_lock);
129 130

	wake_up(&group->notification_waitq);
131
	kill_fasync(&group->fsn_fa, SIGIO, POLL_IN);
132
	return ret;
133 134 135
}

/*
136 137
 * Remove and return the first event from the notification list.  It is the
 * responsibility of the caller to destroy the obtained event
138
 */
139
struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group)
140 141 142
{
	struct fsnotify_event *event;

143 144
	BUG_ON(IS_ENABLED(CONFIG_SMP) &&
	       !spin_is_locked(&group->notification_lock));
145

Eric Paris's avatar
Eric Paris committed
146 147
	pr_debug("%s: group=%p\n", __func__, group);

148 149
	event = list_first_entry(&group->notification_list,
				 struct fsnotify_event, list);
150 151
	/*
	 * We need to init list head for the case of overflow event so that
152
	 * check in fsnotify_add_event() works
153 154
	 */
	list_del_init(&event->list);
155 156 157 158 159 160
	group->q_len--;

	return event;
}

/*
161 162
 * This will not remove the event, that must be done with
 * fsnotify_remove_first_event()
163
 */
164
struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group)
165
{
166 167
	BUG_ON(IS_ENABLED(CONFIG_SMP) &&
	       !spin_is_locked(&group->notification_lock));
168

169 170
	return list_first_entry(&group->notification_list,
				struct fsnotify_event, list);
171 172 173 174 175 176 177 178 179 180
}

/*
 * Called when a group is being torn down to clean up any outstanding
 * event notifications.
 */
void fsnotify_flush_notify(struct fsnotify_group *group)
{
	struct fsnotify_event *event;

181
	spin_lock(&group->notification_lock);
182
	while (!fsnotify_notify_queue_is_empty(group)) {
183
		event = fsnotify_remove_first_event(group);
184
		spin_unlock(&group->notification_lock);
185
		fsnotify_destroy_event(group, event);
186
		spin_lock(&group->notification_lock);
187
	}
188
	spin_unlock(&group->notification_lock);
189 190 191 192 193 194 195
}

/*
 * fsnotify_create_event - Allocate a new event which will be sent to each
 * group's handle_event function if the group was interested in this
 * particular event.
 *
196
 * @inode the inode which is supposed to receive the event (sometimes a
197 198 199 200
 *	parent of the inode to which the event happened.
 * @mask what actually happened.
 * @data pointer to the object which was actually affected
 * @data_type flag indication if the data is a file, path, inode, nothing...
201
 * @name the filename, if available
202
 */
203 204
void fsnotify_init_event(struct fsnotify_event *event, struct inode *inode,
			 u32 mask)
205
{
206 207
	INIT_LIST_HEAD(&event->list);
	event->inode = inode;
208 209
	event->mask = mask;
}