Loading...
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/*
20 * Basic idea behind the notification queue: An fsnotify group (like inotify)
21 * sends the userspace notification about events asynchronously some time after
22 * the event happened. When inotify gets an event it will need to add that
23 * event to the group notify queue. Since a single event might need to be on
24 * multiple group's notification queues we can't add the event directly to each
25 * queue and instead add a small "event_holder" to each queue. This event_holder
26 * has a pointer back to the original event. Since the majority of events are
27 * going to end up on one, and only one, notification queue we embed one
28 * event_holder into each event. This means we have a single allocation instead
29 * of always needing two. If the embedded event_holder is already in use by
30 * another group a new event_holder (from fsnotify_event_holder_cachep) will be
31 * allocated and used.
32 */
33
34#include <linux/fs.h>
35#include <linux/init.h>
36#include <linux/kernel.h>
37#include <linux/list.h>
38#include <linux/module.h>
39#include <linux/mount.h>
40#include <linux/mutex.h>
41#include <linux/namei.h>
42#include <linux/path.h>
43#include <linux/slab.h>
44#include <linux/spinlock.h>
45
46#include <linux/atomic.h>
47
48#include <linux/fsnotify_backend.h>
49#include "fsnotify.h"
50
51static atomic_t fsnotify_sync_cookie = ATOMIC_INIT(0);
52
53/**
54 * fsnotify_get_cookie - return a unique cookie for use in synchronizing events.
55 * Called from fsnotify_move, which is inlined into filesystem modules.
56 */
57u32 fsnotify_get_cookie(void)
58{
59 return atomic_inc_return(&fsnotify_sync_cookie);
60}
61EXPORT_SYMBOL_GPL(fsnotify_get_cookie);
62
63/* return true if the notify queue is empty, false otherwise */
64bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group)
65{
66 BUG_ON(!mutex_is_locked(&group->notification_mutex));
67 return list_empty(&group->notification_list) ? true : false;
68}
69
70void fsnotify_destroy_event(struct fsnotify_group *group,
71 struct fsnotify_event *event)
72{
73 /* Overflow events are per-group and we don't want to free them */
74 if (!event || event->mask == FS_Q_OVERFLOW)
75 return;
76
77 group->ops->free_event(event);
78}
79
80/*
81 * Add an event to the group notification queue. The group can later pull this
82 * event off the queue to deal with. The function returns 0 if the event was
83 * added to the queue, 1 if the event was merged with some other queued event,
84 * 2 if the queue of events has overflown.
85 */
86int fsnotify_add_notify_event(struct fsnotify_group *group,
87 struct fsnotify_event *event,
88 int (*merge)(struct list_head *,
89 struct fsnotify_event *))
90{
91 int ret = 0;
92 struct list_head *list = &group->notification_list;
93
94 pr_debug("%s: group=%p event=%p\n", __func__, group, event);
95
96 mutex_lock(&group->notification_mutex);
97
98 if (group->q_len >= group->max_events) {
99 ret = 2;
100 /* Queue overflow event only if it isn't already queued */
101 if (!list_empty(&group->overflow_event->list)) {
102 mutex_unlock(&group->notification_mutex);
103 return ret;
104 }
105 event = group->overflow_event;
106 goto queue;
107 }
108
109 if (!list_empty(list) && merge) {
110 ret = merge(list, event);
111 if (ret) {
112 mutex_unlock(&group->notification_mutex);
113 return ret;
114 }
115 }
116
117queue:
118 group->q_len++;
119 list_add_tail(&event->list, list);
120 mutex_unlock(&group->notification_mutex);
121
122 wake_up(&group->notification_waitq);
123 kill_fasync(&group->fsn_fa, SIGIO, POLL_IN);
124 return ret;
125}
126
127/*
128 * Remove and return the first event from the notification list. It is the
129 * responsibility of the caller to destroy the obtained event
130 */
131struct fsnotify_event *fsnotify_remove_notify_event(struct fsnotify_group *group)
132{
133 struct fsnotify_event *event;
134
135 BUG_ON(!mutex_is_locked(&group->notification_mutex));
136
137 pr_debug("%s: group=%p\n", __func__, group);
138
139 event = list_first_entry(&group->notification_list,
140 struct fsnotify_event, list);
141 /*
142 * We need to init list head for the case of overflow event so that
143 * check in fsnotify_add_notify_events() works
144 */
145 list_del_init(&event->list);
146 group->q_len--;
147
148 return event;
149}
150
151/*
152 * This will not remove the event, that must be done with fsnotify_remove_notify_event()
153 */
154struct fsnotify_event *fsnotify_peek_notify_event(struct fsnotify_group *group)
155{
156 BUG_ON(!mutex_is_locked(&group->notification_mutex));
157
158 return list_first_entry(&group->notification_list,
159 struct fsnotify_event, list);
160}
161
162/*
163 * Called when a group is being torn down to clean up any outstanding
164 * event notifications.
165 */
166void fsnotify_flush_notify(struct fsnotify_group *group)
167{
168 struct fsnotify_event *event;
169
170 mutex_lock(&group->notification_mutex);
171 while (!fsnotify_notify_queue_is_empty(group)) {
172 event = fsnotify_remove_notify_event(group);
173 fsnotify_destroy_event(group, event);
174 }
175 mutex_unlock(&group->notification_mutex);
176}
177
178/*
179 * fsnotify_create_event - Allocate a new event which will be sent to each
180 * group's handle_event function if the group was interested in this
181 * particular event.
182 *
183 * @inode the inode which is supposed to receive the event (sometimes a
184 * parent of the inode to which the event happened.
185 * @mask what actually happened.
186 * @data pointer to the object which was actually affected
187 * @data_type flag indication if the data is a file, path, inode, nothing...
188 * @name the filename, if available
189 */
190void fsnotify_init_event(struct fsnotify_event *event, struct inode *inode,
191 u32 mask)
192{
193 INIT_LIST_HEAD(&event->list);
194 event->inode = inode;
195 event->mask = mask;
196}
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
4 */
5
6/*
7 * Basic idea behind the notification queue: An fsnotify group (like inotify)
8 * sends the userspace notification about events asynchronously some time after
9 * the event happened. When inotify gets an event it will need to add that
10 * event to the group notify queue. Since a single event might need to be on
11 * multiple group's notification queues we can't add the event directly to each
12 * queue and instead add a small "event_holder" to each queue. This event_holder
13 * has a pointer back to the original event. Since the majority of events are
14 * going to end up on one, and only one, notification queue we embed one
15 * event_holder into each event. This means we have a single allocation instead
16 * of always needing two. If the embedded event_holder is already in use by
17 * another group a new event_holder (from fsnotify_event_holder_cachep) will be
18 * allocated and used.
19 */
20
21#include <linux/fs.h>
22#include <linux/init.h>
23#include <linux/kernel.h>
24#include <linux/list.h>
25#include <linux/module.h>
26#include <linux/mount.h>
27#include <linux/mutex.h>
28#include <linux/namei.h>
29#include <linux/path.h>
30#include <linux/slab.h>
31#include <linux/spinlock.h>
32
33#include <linux/atomic.h>
34
35#include <linux/fsnotify_backend.h>
36#include "fsnotify.h"
37
38static atomic_t fsnotify_sync_cookie = ATOMIC_INIT(0);
39
40/**
41 * fsnotify_get_cookie - return a unique cookie for use in synchronizing events.
42 * Called from fsnotify_move, which is inlined into filesystem modules.
43 */
44u32 fsnotify_get_cookie(void)
45{
46 return atomic_inc_return(&fsnotify_sync_cookie);
47}
48EXPORT_SYMBOL_GPL(fsnotify_get_cookie);
49
50/* return true if the notify queue is empty, false otherwise */
51bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group)
52{
53 assert_spin_locked(&group->notification_lock);
54 return list_empty(&group->notification_list) ? true : false;
55}
56
57void fsnotify_destroy_event(struct fsnotify_group *group,
58 struct fsnotify_event *event)
59{
60 /* Overflow events are per-group and we don't want to free them */
61 if (!event || event == group->overflow_event)
62 return;
63 /*
64 * If the event is still queued, we have a problem... Do an unreliable
65 * lockless check first to avoid locking in the common case. The
66 * locking may be necessary for permission events which got removed
67 * from the list by a different CPU than the one freeing the event.
68 */
69 if (!list_empty(&event->list)) {
70 spin_lock(&group->notification_lock);
71 WARN_ON(!list_empty(&event->list));
72 spin_unlock(&group->notification_lock);
73 }
74 group->ops->free_event(event);
75}
76
77/*
78 * Add an event to the group notification queue. The group can later pull this
79 * event off the queue to deal with. The function returns 0 if the event was
80 * added to the queue, 1 if the event was merged with some other queued event,
81 * 2 if the event was not queued - either the queue of events has overflown
82 * or the group is shutting down.
83 */
84int fsnotify_add_event(struct fsnotify_group *group,
85 struct fsnotify_event *event,
86 int (*merge)(struct list_head *,
87 struct fsnotify_event *))
88{
89 int ret = 0;
90 struct list_head *list = &group->notification_list;
91
92 pr_debug("%s: group=%p event=%p\n", __func__, group, event);
93
94 spin_lock(&group->notification_lock);
95
96 if (group->shutdown) {
97 spin_unlock(&group->notification_lock);
98 return 2;
99 }
100
101 if (event == group->overflow_event ||
102 group->q_len >= group->max_events) {
103 ret = 2;
104 /* Queue overflow event only if it isn't already queued */
105 if (!list_empty(&group->overflow_event->list)) {
106 spin_unlock(&group->notification_lock);
107 return ret;
108 }
109 event = group->overflow_event;
110 goto queue;
111 }
112
113 if (!list_empty(list) && merge) {
114 ret = merge(list, event);
115 if (ret) {
116 spin_unlock(&group->notification_lock);
117 return ret;
118 }
119 }
120
121queue:
122 group->q_len++;
123 list_add_tail(&event->list, list);
124 spin_unlock(&group->notification_lock);
125
126 wake_up(&group->notification_waitq);
127 kill_fasync(&group->fsn_fa, SIGIO, POLL_IN);
128 return ret;
129}
130
131void fsnotify_remove_queued_event(struct fsnotify_group *group,
132 struct fsnotify_event *event)
133{
134 assert_spin_locked(&group->notification_lock);
135 /*
136 * We need to init list head for the case of overflow event so that
137 * check in fsnotify_add_event() works
138 */
139 list_del_init(&event->list);
140 group->q_len--;
141}
142
143/*
144 * Remove and return the first event from the notification list. It is the
145 * responsibility of the caller to destroy the obtained event
146 */
147struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group)
148{
149 struct fsnotify_event *event;
150
151 assert_spin_locked(&group->notification_lock);
152
153 pr_debug("%s: group=%p\n", __func__, group);
154
155 event = list_first_entry(&group->notification_list,
156 struct fsnotify_event, list);
157 fsnotify_remove_queued_event(group, event);
158 return event;
159}
160
161/*
162 * This will not remove the event, that must be done with
163 * fsnotify_remove_first_event()
164 */
165struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group)
166{
167 assert_spin_locked(&group->notification_lock);
168
169 return list_first_entry(&group->notification_list,
170 struct fsnotify_event, list);
171}
172
173/*
174 * Called when a group is being torn down to clean up any outstanding
175 * event notifications.
176 */
177void fsnotify_flush_notify(struct fsnotify_group *group)
178{
179 struct fsnotify_event *event;
180
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}