1 // SPDX-License-Identifier: GPL-2.0
2 /* Watch queue and general notification mechanism, built on pipes
4 * Copyright (C) 2020 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
7 * See Documentation/core-api/watch_queue.rst
10 #define pr_fmt(fmt) "watchq: " fmt
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/sched.h>
14 #include <linux/slab.h>
15 #include <linux/printk.h>
16 #include <linux/miscdevice.h>
19 #include <linux/pagemap.h>
20 #include <linux/poll.h>
21 #include <linux/uaccess.h>
22 #include <linux/vmalloc.h>
23 #include <linux/file.h>
24 #include <linux/security.h>
25 #include <linux/cred.h>
26 #include <linux/sched/signal.h>
27 #include <linux/watch_queue.h>
28 #include <linux/pipe_fs_i.h>
30 MODULE_DESCRIPTION("Watch queue");
31 MODULE_AUTHOR("Red Hat, Inc.");
32 MODULE_LICENSE("GPL");
34 #define WATCH_QUEUE_NOTE_SIZE 128
35 #define WATCH_QUEUE_NOTES_PER_PAGE (PAGE_SIZE / WATCH_QUEUE_NOTE_SIZE)
38 * This must be called under the RCU read-lock, which makes
39 * sure that the wqueue still exists. It can then take the lock,
40 * and check that the wqueue hasn't been destroyed, which in
41 * turn makes sure that the notification pipe still exists.
43 static inline bool lock_wqueue(struct watch_queue *wqueue)
45 spin_lock_bh(&wqueue->lock);
46 if (unlikely(!wqueue->pipe)) {
47 spin_unlock_bh(&wqueue->lock);
53 static inline void unlock_wqueue(struct watch_queue *wqueue)
55 spin_unlock_bh(&wqueue->lock);
58 static void watch_queue_pipe_buf_release(struct pipe_inode_info *pipe,
59 struct pipe_buffer *buf)
61 struct watch_queue *wqueue = (struct watch_queue *)buf->private;
65 /* We need to work out which note within the page this refers to, but
66 * the note might have been maximum size, so merely ANDing the offset
67 * off doesn't work. OTOH, the note must've been more than zero size.
69 bit = buf->offset + buf->len;
70 if ((bit & (WATCH_QUEUE_NOTE_SIZE - 1)) == 0)
71 bit -= WATCH_QUEUE_NOTE_SIZE;
72 bit /= WATCH_QUEUE_NOTE_SIZE;
77 set_bit(bit, wqueue->notes_bitmap);
78 generic_pipe_buf_release(pipe, buf);
81 // No try_steal function => no stealing
82 #define watch_queue_pipe_buf_try_steal NULL
84 /* New data written to a pipe may be appended to a buffer with this type. */
85 static const struct pipe_buf_operations watch_queue_pipe_buf_ops = {
86 .release = watch_queue_pipe_buf_release,
87 .try_steal = watch_queue_pipe_buf_try_steal,
88 .get = generic_pipe_buf_get,
92 * Post a notification to a watch queue.
94 * Must be called with the RCU lock for reading, and the
95 * watch_queue lock held, which guarantees that the pipe
96 * hasn't been released.
98 static bool post_one_notification(struct watch_queue *wqueue,
99 struct watch_notification *n)
102 struct pipe_inode_info *pipe = wqueue->pipe;
103 struct pipe_buffer *buf;
105 unsigned int head, tail, mask, note, offset, len;
108 spin_lock_irq(&pipe->rd_wait.lock);
110 mask = pipe->ring_size - 1;
113 if (pipe_full(head, tail, pipe->ring_size))
116 note = find_first_bit(wqueue->notes_bitmap, wqueue->nr_notes);
117 if (note >= wqueue->nr_notes)
120 page = wqueue->notes[note / WATCH_QUEUE_NOTES_PER_PAGE];
121 offset = note % WATCH_QUEUE_NOTES_PER_PAGE * WATCH_QUEUE_NOTE_SIZE;
123 len = n->info & WATCH_INFO_LENGTH;
124 p = kmap_atomic(page);
125 memcpy(p + offset, n, len);
128 buf = &pipe->bufs[head & mask];
130 buf->private = (unsigned long)wqueue;
131 buf->ops = &watch_queue_pipe_buf_ops;
132 buf->offset = offset;
134 buf->flags = PIPE_BUF_FLAG_WHOLE;
135 smp_store_release(&pipe->head, head + 1); /* vs pipe_read() */
137 if (!test_and_clear_bit(note, wqueue->notes_bitmap)) {
138 spin_unlock_irq(&pipe->rd_wait.lock);
141 wake_up_interruptible_sync_poll_locked(&pipe->rd_wait, EPOLLIN | EPOLLRDNORM);
145 spin_unlock_irq(&pipe->rd_wait.lock);
147 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
151 buf = &pipe->bufs[(head - 1) & mask];
152 buf->flags |= PIPE_BUF_FLAG_LOSS;
157 * Apply filter rules to a notification.
159 static bool filter_watch_notification(const struct watch_filter *wf,
160 const struct watch_notification *n)
162 const struct watch_type_filter *wt;
163 unsigned int st_bits = sizeof(wt->subtype_filter[0]) * 8;
164 unsigned int st_index = n->subtype / st_bits;
165 unsigned int st_bit = 1U << (n->subtype % st_bits);
168 if (!test_bit(n->type, wf->type_filter))
171 for (i = 0; i < wf->nr_filters; i++) {
172 wt = &wf->filters[i];
173 if (n->type == wt->type &&
174 (wt->subtype_filter[st_index] & st_bit) &&
175 (n->info & wt->info_mask) == wt->info_filter)
179 return false; /* If there is a filter, the default is to reject. */
183 * __post_watch_notification - Post an event notification
184 * @wlist: The watch list to post the event to.
185 * @n: The notification record to post.
186 * @cred: The creds of the process that triggered the notification.
187 * @id: The ID to match on the watch.
189 * Post a notification of an event into a set of watch queues and let the users
192 * The size of the notification should be set in n->info & WATCH_INFO_LENGTH and
193 * should be in units of sizeof(*n).
195 void __post_watch_notification(struct watch_list *wlist,
196 struct watch_notification *n,
197 const struct cred *cred,
200 const struct watch_filter *wf;
201 struct watch_queue *wqueue;
204 if (((n->info & WATCH_INFO_LENGTH) >> WATCH_INFO_LENGTH__SHIFT) == 0) {
211 hlist_for_each_entry_rcu(watch, &wlist->watchers, list_node) {
214 n->info &= ~WATCH_INFO_ID;
215 n->info |= watch->info_id;
217 wqueue = rcu_dereference(watch->queue);
218 wf = rcu_dereference(wqueue->filter);
219 if (wf && !filter_watch_notification(wf, n))
222 if (security_post_notification(watch->cred, cred, n) < 0)
225 if (lock_wqueue(wqueue)) {
226 post_one_notification(wqueue, n);
227 unlock_wqueue(wqueue);
233 EXPORT_SYMBOL(__post_watch_notification);
236 * Allocate sufficient pages to preallocation for the requested number of
239 long watch_queue_set_size(struct pipe_inode_info *pipe, unsigned int nr_notes)
241 struct watch_queue *wqueue = pipe->watch_queue;
243 unsigned long *bitmap;
244 unsigned long user_bufs;
245 int ret, i, nr_pages;
253 nr_notes > 512) /* TODO: choose a better hard limit */
256 nr_pages = (nr_notes + WATCH_QUEUE_NOTES_PER_PAGE - 1);
257 nr_pages /= WATCH_QUEUE_NOTES_PER_PAGE;
258 user_bufs = account_pipe_buffers(pipe->user, pipe->nr_accounted, nr_pages);
260 if (nr_pages > pipe->max_usage &&
261 (too_many_pipe_buffers_hard(user_bufs) ||
262 too_many_pipe_buffers_soft(user_bufs)) &&
263 pipe_is_unprivileged_user()) {
268 nr_notes = nr_pages * WATCH_QUEUE_NOTES_PER_PAGE;
269 ret = pipe_resize_ring(pipe, roundup_pow_of_two(nr_notes));
274 pages = kcalloc(sizeof(struct page *), nr_pages, GFP_KERNEL);
278 for (i = 0; i < nr_pages; i++) {
279 pages[i] = alloc_page(GFP_KERNEL);
282 pages[i]->index = i * WATCH_QUEUE_NOTES_PER_PAGE;
285 bitmap = bitmap_alloc(nr_notes, GFP_KERNEL);
289 bitmap_fill(bitmap, nr_notes);
290 wqueue->notes = pages;
291 wqueue->notes_bitmap = bitmap;
292 wqueue->nr_pages = nr_pages;
293 wqueue->nr_notes = nr_notes;
298 __free_page(pages[i]);
301 (void) account_pipe_buffers(pipe->user, nr_pages, pipe->nr_accounted);
306 * Set the filter on a watch queue.
308 long watch_queue_set_filter(struct pipe_inode_info *pipe,
309 struct watch_notification_filter __user *_filter)
311 struct watch_notification_type_filter *tf;
312 struct watch_notification_filter filter;
313 struct watch_type_filter *q;
314 struct watch_filter *wfilter;
315 struct watch_queue *wqueue = pipe->watch_queue;
316 int ret, nr_filter = 0, i;
322 /* Remove the old filter */
327 /* Grab the user's filter specification */
328 if (copy_from_user(&filter, _filter, sizeof(filter)) != 0)
330 if (filter.nr_filters == 0 ||
331 filter.nr_filters > 16 ||
332 filter.__reserved != 0)
335 tf = memdup_user(_filter->filters, filter.nr_filters * sizeof(*tf));
340 for (i = 0; i < filter.nr_filters; i++) {
341 if ((tf[i].info_filter & ~tf[i].info_mask) ||
342 tf[i].info_mask & WATCH_INFO_LENGTH)
344 /* Ignore any unknown types */
345 if (tf[i].type >= WATCH_TYPE__NR)
350 /* Now we need to build the internal filter from only the relevant
351 * user-specified filters.
354 wfilter = kzalloc(struct_size(wfilter, filters, nr_filter), GFP_KERNEL);
357 wfilter->nr_filters = nr_filter;
359 q = wfilter->filters;
360 for (i = 0; i < filter.nr_filters; i++) {
361 if (tf[i].type >= WATCH_TYPE__NR)
364 q->type = tf[i].type;
365 q->info_filter = tf[i].info_filter;
366 q->info_mask = tf[i].info_mask;
367 q->subtype_filter[0] = tf[i].subtype_filter[0];
368 __set_bit(q->type, wfilter->type_filter);
375 wfilter = rcu_replace_pointer(wqueue->filter, wfilter,
376 lockdep_is_held(&pipe->mutex));
379 kfree_rcu(wfilter, rcu);
387 static void __put_watch_queue(struct kref *kref)
389 struct watch_queue *wqueue =
390 container_of(kref, struct watch_queue, usage);
391 struct watch_filter *wfilter;
394 for (i = 0; i < wqueue->nr_pages; i++)
395 __free_page(wqueue->notes[i]);
396 kfree(wqueue->notes);
397 bitmap_free(wqueue->notes_bitmap);
399 wfilter = rcu_access_pointer(wqueue->filter);
401 kfree_rcu(wfilter, rcu);
402 kfree_rcu(wqueue, rcu);
406 * put_watch_queue - Dispose of a ref on a watchqueue.
407 * @wqueue: The watch queue to unref.
409 void put_watch_queue(struct watch_queue *wqueue)
411 kref_put(&wqueue->usage, __put_watch_queue);
413 EXPORT_SYMBOL(put_watch_queue);
415 static void free_watch(struct rcu_head *rcu)
417 struct watch *watch = container_of(rcu, struct watch, rcu);
419 put_watch_queue(rcu_access_pointer(watch->queue));
420 atomic_dec(&watch->cred->user->nr_watches);
421 put_cred(watch->cred);
425 static void __put_watch(struct kref *kref)
427 struct watch *watch = container_of(kref, struct watch, usage);
429 call_rcu(&watch->rcu, free_watch);
435 static void put_watch(struct watch *watch)
437 kref_put(&watch->usage, __put_watch);
441 * init_watch - Initialise a watch
442 * @watch: The watch to initialise.
443 * @wqueue: The queue to assign.
445 * Initialise a watch and set the watch queue.
447 void init_watch(struct watch *watch, struct watch_queue *wqueue)
449 kref_init(&watch->usage);
450 INIT_HLIST_NODE(&watch->list_node);
451 INIT_HLIST_NODE(&watch->queue_node);
452 rcu_assign_pointer(watch->queue, wqueue);
455 static int add_one_watch(struct watch *watch, struct watch_list *wlist, struct watch_queue *wqueue)
457 const struct cred *cred;
460 hlist_for_each_entry(w, &wlist->watchers, list_node) {
461 struct watch_queue *wq = rcu_access_pointer(w->queue);
462 if (wqueue == wq && watch->id == w->id)
466 cred = current_cred();
467 if (atomic_inc_return(&cred->user->nr_watches) > task_rlimit(current, RLIMIT_NOFILE)) {
468 atomic_dec(&cred->user->nr_watches);
472 watch->cred = get_cred(cred);
473 rcu_assign_pointer(watch->watch_list, wlist);
475 kref_get(&wqueue->usage);
476 kref_get(&watch->usage);
477 hlist_add_head(&watch->queue_node, &wqueue->watches);
478 hlist_add_head_rcu(&watch->list_node, &wlist->watchers);
483 * add_watch_to_object - Add a watch on an object to a watch list
484 * @watch: The watch to add
485 * @wlist: The watch list to add to
487 * @watch->queue must have been set to point to the queue to post notifications
488 * to and the watch list of the object to be watched. @watch->cred must also
489 * have been set to the appropriate credentials and a ref taken on them.
491 * The caller must pin the queue and the list both and must hold the list
492 * locked against racing watch additions/removals.
494 int add_watch_to_object(struct watch *watch, struct watch_list *wlist)
496 struct watch_queue *wqueue;
501 wqueue = rcu_access_pointer(watch->queue);
502 if (lock_wqueue(wqueue)) {
503 spin_lock(&wlist->lock);
504 ret = add_one_watch(watch, wlist, wqueue);
505 spin_unlock(&wlist->lock);
506 unlock_wqueue(wqueue);
512 EXPORT_SYMBOL(add_watch_to_object);
515 * remove_watch_from_object - Remove a watch or all watches from an object.
516 * @wlist: The watch list to remove from
517 * @wq: The watch queue of interest (ignored if @all is true)
518 * @id: The ID of the watch to remove (ignored if @all is true)
519 * @all: True to remove all objects
521 * Remove a specific watch or all watches from an object. A notification is
522 * sent to the watcher to tell them that this happened.
524 int remove_watch_from_object(struct watch_list *wlist, struct watch_queue *wq,
527 struct watch_notification_removal n;
528 struct watch_queue *wqueue;
535 spin_lock(&wlist->lock);
536 hlist_for_each_entry(watch, &wlist->watchers, list_node) {
538 (watch->id == id && rcu_access_pointer(watch->queue) == wq))
541 spin_unlock(&wlist->lock);
546 hlist_del_init_rcu(&watch->list_node);
547 rcu_assign_pointer(watch->watch_list, NULL);
548 spin_unlock(&wlist->lock);
550 /* We now own the reference on watch that used to belong to wlist. */
552 n.watch.type = WATCH_TYPE_META;
553 n.watch.subtype = WATCH_META_REMOVAL_NOTIFICATION;
554 n.watch.info = watch->info_id | watch_sizeof(n.watch);
557 n.watch.info = watch->info_id | watch_sizeof(n);
559 wqueue = rcu_dereference(watch->queue);
561 if (lock_wqueue(wqueue)) {
562 post_one_notification(wqueue, &n.watch);
564 if (!hlist_unhashed(&watch->queue_node)) {
565 hlist_del_init_rcu(&watch->queue_node);
569 unlock_wqueue(wqueue);
572 if (wlist->release_watch) {
573 void (*release_watch)(struct watch *);
575 release_watch = wlist->release_watch;
577 (*release_watch)(watch);
582 if (all && !hlist_empty(&wlist->watchers))
588 EXPORT_SYMBOL(remove_watch_from_object);
591 * Remove all the watches that are contributory to a queue. This has the
592 * potential to race with removal of the watches by the destruction of the
593 * objects being watched or with the distribution of notifications.
595 void watch_queue_clear(struct watch_queue *wqueue)
597 struct watch_list *wlist;
602 spin_lock_bh(&wqueue->lock);
605 * This pipe can be freed by callers like free_pipe_info().
606 * Removing this reference also prevents new notifications.
610 while (!hlist_empty(&wqueue->watches)) {
611 watch = hlist_entry(wqueue->watches.first, struct watch, queue_node);
612 hlist_del_init_rcu(&watch->queue_node);
613 /* We now own a ref on the watch. */
614 spin_unlock_bh(&wqueue->lock);
616 /* We can't do the next bit under the queue lock as we need to
617 * get the list lock - which would cause a deadlock if someone
618 * was removing from the opposite direction at the same time or
619 * posting a notification.
621 wlist = rcu_dereference(watch->watch_list);
623 void (*release_watch)(struct watch *);
625 spin_lock(&wlist->lock);
627 release = !hlist_unhashed(&watch->list_node);
629 hlist_del_init_rcu(&watch->list_node);
630 rcu_assign_pointer(watch->watch_list, NULL);
632 /* We now own a second ref on the watch. */
635 release_watch = wlist->release_watch;
636 spin_unlock(&wlist->lock);
641 /* This might need to call dput(), so
642 * we have to drop all the locks.
644 (*release_watch)(watch);
652 spin_lock_bh(&wqueue->lock);
655 spin_unlock_bh(&wqueue->lock);
660 * get_watch_queue - Get a watch queue from its file descriptor.
661 * @fd: The fd to query.
663 struct watch_queue *get_watch_queue(int fd)
665 struct pipe_inode_info *pipe;
666 struct watch_queue *wqueue = ERR_PTR(-EINVAL);
671 pipe = get_pipe_info(f.file, false);
672 if (pipe && pipe->watch_queue) {
673 wqueue = pipe->watch_queue;
674 kref_get(&wqueue->usage);
681 EXPORT_SYMBOL(get_watch_queue);
684 * Initialise a watch queue
686 int watch_queue_init(struct pipe_inode_info *pipe)
688 struct watch_queue *wqueue;
690 wqueue = kzalloc(sizeof(*wqueue), GFP_KERNEL);
695 kref_init(&wqueue->usage);
696 spin_lock_init(&wqueue->lock);
697 INIT_HLIST_HEAD(&wqueue->watches);
699 pipe->watch_queue = wqueue;