notification.c 6.68 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
	assert_spin_locked(&group->notification_lock);
67 68
	return list_empty(&group->notification_list) ? true : false;
}
69

70 71
void fsnotify_destroy_event(struct fsnotify_group *group,
			    struct fsnotify_event *event)
72
{
73 74
	/* Overflow events are per-group and we don't want to free them */
	if (!event || event->mask == FS_Q_OVERFLOW)
75
		return;
76 77 78 79 80 81 82 83 84 85 86
	/*
	 * If the event is still queued, we have a problem... Do an unreliable
	 * lockless check first to avoid locking in the common case. The
	 * locking may be necessary for permission events which got removed
	 * from the list by a different CPU than the one freeing the event.
	 */
	if (!list_empty(&event->list)) {
		spin_lock(&group->notification_lock);
		WARN_ON(!list_empty(&event->list));
		spin_unlock(&group->notification_lock);
	}
87
	group->ops->free_event(event);
88 89
}

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

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

107
	spin_lock(&group->notification_lock);
108

109
	if (group->shutdown) {
110
		spin_unlock(&group->notification_lock);
111 112 113
		return 2;
	}

114
	if (group->q_len >= group->max_events) {
115
		ret = 2;
116
		/* Queue overflow event only if it isn't already queued */
117
		if (!list_empty(&group->overflow_event->list)) {
118
			spin_unlock(&group->notification_lock);
119 120
			return ret;
		}
121
		event = group->overflow_event;
122
		goto queue;
123
	}
124

125
	if (!list_empty(list) && merge) {
126 127
		ret = merge(list, event);
		if (ret) {
128
			spin_unlock(&group->notification_lock);
129
			return ret;
130
		}
131 132
	}

133
queue:
134
	group->q_len++;
135
	list_add_tail(&event->list, list);
136
	spin_unlock(&group->notification_lock);
137 138

	wake_up(&group->notification_waitq);
139
	kill_fasync(&group->fsn_fa, SIGIO, POLL_IN);
140
	return ret;
141 142 143
}

/*
144 145
 * Remove and return the first event from the notification list.  It is the
 * responsibility of the caller to destroy the obtained event
146
 */
147
struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group)
148 149 150
{
	struct fsnotify_event *event;

151
	assert_spin_locked(&group->notification_lock);
152

153 154
	pr_debug("%s: group=%p\n", __func__, group);

155 156
	event = list_first_entry(&group->notification_list,
				 struct fsnotify_event, list);
157 158
	/*
	 * We need to init list head for the case of overflow event so that
159
	 * check in fsnotify_add_event() works
160 161
	 */
	list_del_init(&event->list);
162 163 164 165 166 167
	group->q_len--;

	return event;
}

/*
168 169
 * This will not remove the event, that must be done with
 * fsnotify_remove_first_event()
170
 */
171
struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group)
172
{
173
	assert_spin_locked(&group->notification_lock);
174

175 176
	return list_first_entry(&group->notification_list,
				struct fsnotify_event, list);
177 178 179 180 181 182 183 184 185 186
}

/*
 * 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;

187
	spin_lock(&group->notification_lock);
188
	while (!fsnotify_notify_queue_is_empty(group)) {
189
		event = fsnotify_remove_first_event(group);
190
		spin_unlock(&group->notification_lock);
191
		fsnotify_destroy_event(group, event);
192
		spin_lock(&group->notification_lock);
193
	}
194
	spin_unlock(&group->notification_lock);
195 196 197 198 199 200 201
}

/*
 * 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.
 *
202
 * @inode the inode which is supposed to receive the event (sometimes a
203 204 205 206
 *	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...
207
 * @name the filename, if available
208
 */
209 210
void fsnotify_init_event(struct fsnotify_event *event, struct inode *inode,
			 u32 mask)
211
{
212 213
	INIT_LIST_HEAD(&event->list);
	event->inode = inode;
214 215
	event->mask = mask;
}