2 * POSIX message queues filesystem for Linux.
4 * Copyright (C) 2003,2004 Krzysztof Benedyczak (golbi@mat.uni.torun.pl)
5 * Michal Wronski (michal.wronski@gmail.com)
7 * Spinlocks: Mohamed Abbas (abbas.mohamed@intel.com)
8 * Lockless receive & send, fd based notify:
9 * Manfred Spraul (manfred@colorfullife.com)
11 * Audit: George Wilson (ltcgcw@us.ibm.com)
13 * This file is released under the GPL.
16 #include <linux/capability.h>
17 #include <linux/init.h>
18 #include <linux/pagemap.h>
19 #include <linux/file.h>
20 #include <linux/mount.h>
21 #include <linux/namei.h>
22 #include <linux/sysctl.h>
23 #include <linux/poll.h>
24 #include <linux/mqueue.h>
25 #include <linux/msg.h>
26 #include <linux/skbuff.h>
27 #include <linux/vmalloc.h>
28 #include <linux/netlink.h>
29 #include <linux/syscalls.h>
30 #include <linux/audit.h>
31 #include <linux/signal.h>
32 #include <linux/mutex.h>
33 #include <linux/nsproxy.h>
34 #include <linux/pid.h>
35 #include <linux/ipc_namespace.h>
36 #include <linux/user_namespace.h>
37 #include <linux/slab.h>
42 #define MQUEUE_MAGIC 0x19800202
43 #define DIRENT_SIZE 20
44 #define FILENT_SIZE 80
52 struct posix_msg_tree_node {
53 struct rb_node rb_node;
54 struct list_head msg_list;
58 struct ext_wait_queue { /* queue of sleeping tasks */
59 struct task_struct *task;
60 struct list_head list;
61 struct msg_msg *msg; /* ptr of loaded message */
62 int state; /* one of STATE_* values */
65 struct mqueue_inode_info {
67 struct inode vfs_inode;
68 wait_queue_head_t wait_q;
70 struct rb_root msg_tree;
71 struct posix_msg_tree_node *node_cache;
74 struct sigevent notify;
75 struct pid *notify_owner;
76 struct user_namespace *notify_user_ns;
77 struct user_struct *user; /* user who created, for accounting */
78 struct sock *notify_sock;
79 struct sk_buff *notify_cookie;
81 /* for tasks waiting for free space and messages, respectively */
82 struct ext_wait_queue e_wait_q[2];
84 unsigned long qsize; /* size of queue in memory (sum of all msgs) */
87 static const struct inode_operations mqueue_dir_inode_operations;
88 static const struct file_operations mqueue_file_operations;
89 static const struct super_operations mqueue_super_ops;
90 static void remove_notification(struct mqueue_inode_info *info);
92 static struct kmem_cache *mqueue_inode_cachep;
94 static struct ctl_table_header *mq_sysctl_table;
96 static inline struct mqueue_inode_info *MQUEUE_I(struct inode *inode)
98 return container_of(inode, struct mqueue_inode_info, vfs_inode);
102 * This routine should be called with the mq_lock held.
104 static inline struct ipc_namespace *__get_ns_from_inode(struct inode *inode)
106 return get_ipc_ns(inode->i_sb->s_fs_info);
109 static struct ipc_namespace *get_ns_from_inode(struct inode *inode)
111 struct ipc_namespace *ns;
114 ns = __get_ns_from_inode(inode);
115 spin_unlock(&mq_lock);
119 /* Auxiliary functions to manipulate messages' list */
120 static int msg_insert(struct msg_msg *msg, struct mqueue_inode_info *info)
122 struct rb_node **p, *parent = NULL;
123 struct posix_msg_tree_node *leaf;
125 p = &info->msg_tree.rb_node;
128 leaf = rb_entry(parent, struct posix_msg_tree_node, rb_node);
130 if (likely(leaf->priority == msg->m_type))
132 else if (msg->m_type < leaf->priority)
137 if (info->node_cache) {
138 leaf = info->node_cache;
139 info->node_cache = NULL;
141 leaf = kmalloc(sizeof(*leaf), GFP_ATOMIC);
144 INIT_LIST_HEAD(&leaf->msg_list);
146 leaf->priority = msg->m_type;
147 rb_link_node(&leaf->rb_node, parent, p);
148 rb_insert_color(&leaf->rb_node, &info->msg_tree);
150 info->attr.mq_curmsgs++;
151 info->qsize += msg->m_ts;
152 list_add_tail(&msg->m_list, &leaf->msg_list);
156 static inline struct msg_msg *msg_get(struct mqueue_inode_info *info)
158 struct rb_node **p, *parent = NULL;
159 struct posix_msg_tree_node *leaf;
163 p = &info->msg_tree.rb_node;
167 * During insert, low priorities go to the left and high to the
168 * right. On receive, we want the highest priorities first, so
169 * walk all the way to the right.
174 if (info->attr.mq_curmsgs) {
175 pr_warn_once("Inconsistency in POSIX message queue, "
176 "no tree element, but supposedly messages "
178 info->attr.mq_curmsgs = 0;
182 leaf = rb_entry(parent, struct posix_msg_tree_node, rb_node);
183 if (unlikely(list_empty(&leaf->msg_list))) {
184 pr_warn_once("Inconsistency in POSIX message queue, "
185 "empty leaf node but we haven't implemented "
186 "lazy leaf delete!\n");
187 rb_erase(&leaf->rb_node, &info->msg_tree);
188 if (info->node_cache) {
191 info->node_cache = leaf;
195 msg = list_first_entry(&leaf->msg_list,
196 struct msg_msg, m_list);
197 list_del(&msg->m_list);
198 if (list_empty(&leaf->msg_list)) {
199 rb_erase(&leaf->rb_node, &info->msg_tree);
200 if (info->node_cache) {
203 info->node_cache = leaf;
207 info->attr.mq_curmsgs--;
208 info->qsize -= msg->m_ts;
212 static struct inode *mqueue_get_inode(struct super_block *sb,
213 struct ipc_namespace *ipc_ns, umode_t mode,
214 struct mq_attr *attr)
216 struct user_struct *u = current_user();
220 inode = new_inode(sb);
224 inode->i_ino = get_next_ino();
225 inode->i_mode = mode;
226 inode->i_uid = current_fsuid();
227 inode->i_gid = current_fsgid();
228 inode->i_mtime = inode->i_ctime = inode->i_atime = current_time(inode);
231 struct mqueue_inode_info *info;
232 unsigned long mq_bytes, mq_treesize;
234 inode->i_fop = &mqueue_file_operations;
235 inode->i_size = FILENT_SIZE;
236 /* mqueue specific info */
237 info = MQUEUE_I(inode);
238 spin_lock_init(&info->lock);
239 init_waitqueue_head(&info->wait_q);
240 INIT_LIST_HEAD(&info->e_wait_q[0].list);
241 INIT_LIST_HEAD(&info->e_wait_q[1].list);
242 info->notify_owner = NULL;
243 info->notify_user_ns = NULL;
245 info->user = NULL; /* set when all is ok */
246 info->msg_tree = RB_ROOT;
247 info->node_cache = NULL;
248 memset(&info->attr, 0, sizeof(info->attr));
249 info->attr.mq_maxmsg = min(ipc_ns->mq_msg_max,
250 ipc_ns->mq_msg_default);
251 info->attr.mq_msgsize = min(ipc_ns->mq_msgsize_max,
252 ipc_ns->mq_msgsize_default);
254 info->attr.mq_maxmsg = attr->mq_maxmsg;
255 info->attr.mq_msgsize = attr->mq_msgsize;
258 * We used to allocate a static array of pointers and account
259 * the size of that array as well as one msg_msg struct per
260 * possible message into the queue size. That's no longer
261 * accurate as the queue is now an rbtree and will grow and
262 * shrink depending on usage patterns. We can, however, still
263 * account one msg_msg struct per message, but the nodes are
264 * allocated depending on priority usage, and most programs
265 * only use one, or a handful, of priorities. However, since
266 * this is pinned memory, we need to assume worst case, so
267 * that means the min(mq_maxmsg, max_priorities) * struct
268 * posix_msg_tree_node.
270 mq_treesize = info->attr.mq_maxmsg * sizeof(struct msg_msg) +
271 min_t(unsigned int, info->attr.mq_maxmsg, MQ_PRIO_MAX) *
272 sizeof(struct posix_msg_tree_node);
274 mq_bytes = mq_treesize + (info->attr.mq_maxmsg *
275 info->attr.mq_msgsize);
278 if (u->mq_bytes + mq_bytes < u->mq_bytes ||
279 u->mq_bytes + mq_bytes > rlimit(RLIMIT_MSGQUEUE)) {
280 spin_unlock(&mq_lock);
281 /* mqueue_evict_inode() releases info->messages */
285 u->mq_bytes += mq_bytes;
286 spin_unlock(&mq_lock);
289 info->user = get_uid(u);
290 } else if (S_ISDIR(mode)) {
292 /* Some things misbehave if size == 0 on a directory */
293 inode->i_size = 2 * DIRENT_SIZE;
294 inode->i_op = &mqueue_dir_inode_operations;
295 inode->i_fop = &simple_dir_operations;
305 static int mqueue_fill_super(struct super_block *sb, void *data, int silent)
308 struct ipc_namespace *ns = sb->s_fs_info;
310 sb->s_iflags |= SB_I_NOEXEC | SB_I_NODEV;
311 sb->s_blocksize = PAGE_SIZE;
312 sb->s_blocksize_bits = PAGE_SHIFT;
313 sb->s_magic = MQUEUE_MAGIC;
314 sb->s_op = &mqueue_super_ops;
316 inode = mqueue_get_inode(sb, ns, S_IFDIR | S_ISVTX | S_IRWXUGO, NULL);
318 return PTR_ERR(inode);
320 sb->s_root = d_make_root(inode);
326 static struct dentry *mqueue_mount(struct file_system_type *fs_type,
327 int flags, const char *dev_name,
330 struct ipc_namespace *ns;
331 if (flags & MS_KERNMOUNT) {
335 ns = current->nsproxy->ipc_ns;
337 return mount_ns(fs_type, flags, data, ns, ns->user_ns, mqueue_fill_super);
340 static void init_once(void *foo)
342 struct mqueue_inode_info *p = (struct mqueue_inode_info *) foo;
344 inode_init_once(&p->vfs_inode);
347 static struct inode *mqueue_alloc_inode(struct super_block *sb)
349 struct mqueue_inode_info *ei;
351 ei = kmem_cache_alloc(mqueue_inode_cachep, GFP_KERNEL);
354 return &ei->vfs_inode;
357 static void mqueue_i_callback(struct rcu_head *head)
359 struct inode *inode = container_of(head, struct inode, i_rcu);
360 kmem_cache_free(mqueue_inode_cachep, MQUEUE_I(inode));
363 static void mqueue_destroy_inode(struct inode *inode)
365 call_rcu(&inode->i_rcu, mqueue_i_callback);
368 static void mqueue_evict_inode(struct inode *inode)
370 struct mqueue_inode_info *info;
371 struct user_struct *user;
372 struct ipc_namespace *ipc_ns;
373 struct msg_msg *msg, *nmsg;
378 if (S_ISDIR(inode->i_mode))
381 ipc_ns = get_ns_from_inode(inode);
382 info = MQUEUE_I(inode);
383 spin_lock(&info->lock);
384 while ((msg = msg_get(info)) != NULL)
385 list_add_tail(&msg->m_list, &tmp_msg);
386 kfree(info->node_cache);
387 spin_unlock(&info->lock);
389 list_for_each_entry_safe(msg, nmsg, &tmp_msg, m_list) {
390 list_del(&msg->m_list);
396 unsigned long mq_bytes, mq_treesize;
398 /* Total amount of bytes accounted for the mqueue */
399 mq_treesize = info->attr.mq_maxmsg * sizeof(struct msg_msg) +
400 min_t(unsigned int, info->attr.mq_maxmsg, MQ_PRIO_MAX) *
401 sizeof(struct posix_msg_tree_node);
403 mq_bytes = mq_treesize + (info->attr.mq_maxmsg *
404 info->attr.mq_msgsize);
407 user->mq_bytes -= mq_bytes;
409 * get_ns_from_inode() ensures that the
410 * (ipc_ns = sb->s_fs_info) is either a valid ipc_ns
411 * to which we now hold a reference, or it is NULL.
412 * We can't put it here under mq_lock, though.
415 ipc_ns->mq_queues_count--;
416 spin_unlock(&mq_lock);
423 static int mqueue_create(struct inode *dir, struct dentry *dentry,
424 umode_t mode, bool excl)
427 struct mq_attr *attr = dentry->d_fsdata;
429 struct ipc_namespace *ipc_ns;
432 ipc_ns = __get_ns_from_inode(dir);
438 if (ipc_ns->mq_queues_count >= ipc_ns->mq_queues_max &&
439 !capable(CAP_SYS_RESOURCE)) {
443 ipc_ns->mq_queues_count++;
444 spin_unlock(&mq_lock);
446 inode = mqueue_get_inode(dir->i_sb, ipc_ns, mode, attr);
448 error = PTR_ERR(inode);
450 ipc_ns->mq_queues_count--;
455 dir->i_size += DIRENT_SIZE;
456 dir->i_ctime = dir->i_mtime = dir->i_atime = current_time(dir);
458 d_instantiate(dentry, inode);
462 spin_unlock(&mq_lock);
468 static int mqueue_unlink(struct inode *dir, struct dentry *dentry)
470 struct inode *inode = d_inode(dentry);
472 dir->i_ctime = dir->i_mtime = dir->i_atime = current_time(dir);
473 dir->i_size -= DIRENT_SIZE;
480 * This is routine for system read from queue file.
481 * To avoid mess with doing here some sort of mq_receive we allow
482 * to read only queue size & notification info (the only values
483 * that are interesting from user point of view and aren't accessible
484 * through std routines)
486 static ssize_t mqueue_read_file(struct file *filp, char __user *u_data,
487 size_t count, loff_t *off)
489 struct mqueue_inode_info *info = MQUEUE_I(file_inode(filp));
490 char buffer[FILENT_SIZE];
493 spin_lock(&info->lock);
494 snprintf(buffer, sizeof(buffer),
495 "QSIZE:%-10lu NOTIFY:%-5d SIGNO:%-5d NOTIFY_PID:%-6d\n",
497 info->notify_owner ? info->notify.sigev_notify : 0,
498 (info->notify_owner &&
499 info->notify.sigev_notify == SIGEV_SIGNAL) ?
500 info->notify.sigev_signo : 0,
501 pid_vnr(info->notify_owner));
502 spin_unlock(&info->lock);
503 buffer[sizeof(buffer)-1] = '\0';
505 ret = simple_read_from_buffer(u_data, count, off, buffer,
510 file_inode(filp)->i_atime = file_inode(filp)->i_ctime = current_time(file_inode(filp));
514 static int mqueue_flush_file(struct file *filp, fl_owner_t id)
516 struct mqueue_inode_info *info = MQUEUE_I(file_inode(filp));
518 spin_lock(&info->lock);
519 if (task_tgid(current) == info->notify_owner)
520 remove_notification(info);
522 spin_unlock(&info->lock);
526 static unsigned int mqueue_poll_file(struct file *filp, struct poll_table_struct *poll_tab)
528 struct mqueue_inode_info *info = MQUEUE_I(file_inode(filp));
531 poll_wait(filp, &info->wait_q, poll_tab);
533 spin_lock(&info->lock);
534 if (info->attr.mq_curmsgs)
535 retval = POLLIN | POLLRDNORM;
537 if (info->attr.mq_curmsgs < info->attr.mq_maxmsg)
538 retval |= POLLOUT | POLLWRNORM;
539 spin_unlock(&info->lock);
544 /* Adds current to info->e_wait_q[sr] before element with smaller prio */
545 static void wq_add(struct mqueue_inode_info *info, int sr,
546 struct ext_wait_queue *ewp)
548 struct ext_wait_queue *walk;
552 list_for_each_entry(walk, &info->e_wait_q[sr].list, list) {
553 if (walk->task->static_prio <= current->static_prio) {
554 list_add_tail(&ewp->list, &walk->list);
558 list_add_tail(&ewp->list, &info->e_wait_q[sr].list);
562 * Puts current task to sleep. Caller must hold queue lock. After return
566 static int wq_sleep(struct mqueue_inode_info *info, int sr,
567 ktime_t *timeout, struct ext_wait_queue *ewp)
572 wq_add(info, sr, ewp);
575 __set_current_state(TASK_INTERRUPTIBLE);
577 spin_unlock(&info->lock);
578 time = schedule_hrtimeout_range_clock(timeout, 0,
579 HRTIMER_MODE_ABS, CLOCK_REALTIME);
581 if (ewp->state == STATE_READY) {
585 spin_lock(&info->lock);
586 if (ewp->state == STATE_READY) {
590 if (signal_pending(current)) {
591 retval = -ERESTARTSYS;
599 list_del(&ewp->list);
601 spin_unlock(&info->lock);
607 * Returns waiting task that should be serviced first or NULL if none exists
609 static struct ext_wait_queue *wq_get_first_waiter(
610 struct mqueue_inode_info *info, int sr)
612 struct list_head *ptr;
614 ptr = info->e_wait_q[sr].list.prev;
615 if (ptr == &info->e_wait_q[sr].list)
617 return list_entry(ptr, struct ext_wait_queue, list);
621 static inline void set_cookie(struct sk_buff *skb, char code)
623 ((char *)skb->data)[NOTIFY_COOKIE_LEN-1] = code;
627 * The next function is only to split too long sys_mq_timedsend
629 static void __do_notify(struct mqueue_inode_info *info)
632 * invoked when there is registered process and there isn't process
633 * waiting synchronously for message AND state of queue changed from
634 * empty to not empty. Here we are sure that no one is waiting
636 if (info->notify_owner &&
637 info->attr.mq_curmsgs == 1) {
638 struct siginfo sig_i;
639 switch (info->notify.sigev_notify) {
645 sig_i.si_signo = info->notify.sigev_signo;
647 sig_i.si_code = SI_MESGQ;
648 sig_i.si_value = info->notify.sigev_value;
649 /* map current pid/uid into info->owner's namespaces */
651 sig_i.si_pid = task_tgid_nr_ns(current,
652 ns_of_pid(info->notify_owner));
653 sig_i.si_uid = from_kuid_munged(info->notify_user_ns, current_uid());
656 kill_pid_info(info->notify.sigev_signo,
657 &sig_i, info->notify_owner);
660 set_cookie(info->notify_cookie, NOTIFY_WOKENUP);
661 netlink_sendskb(info->notify_sock, info->notify_cookie);
664 /* after notification unregisters process */
665 put_pid(info->notify_owner);
666 put_user_ns(info->notify_user_ns);
667 info->notify_owner = NULL;
668 info->notify_user_ns = NULL;
670 wake_up(&info->wait_q);
673 static int prepare_timeout(const struct timespec __user *u_abs_timeout,
674 ktime_t *expires, struct timespec *ts)
676 if (copy_from_user(ts, u_abs_timeout, sizeof(struct timespec)))
678 if (!timespec_valid(ts))
681 *expires = timespec_to_ktime(*ts);
685 static void remove_notification(struct mqueue_inode_info *info)
687 if (info->notify_owner != NULL &&
688 info->notify.sigev_notify == SIGEV_THREAD) {
689 set_cookie(info->notify_cookie, NOTIFY_REMOVED);
690 netlink_sendskb(info->notify_sock, info->notify_cookie);
692 put_pid(info->notify_owner);
693 put_user_ns(info->notify_user_ns);
694 info->notify_owner = NULL;
695 info->notify_user_ns = NULL;
698 static int mq_attr_ok(struct ipc_namespace *ipc_ns, struct mq_attr *attr)
701 unsigned long total_size;
703 if (attr->mq_maxmsg <= 0 || attr->mq_msgsize <= 0)
705 if (capable(CAP_SYS_RESOURCE)) {
706 if (attr->mq_maxmsg > HARD_MSGMAX ||
707 attr->mq_msgsize > HARD_MSGSIZEMAX)
710 if (attr->mq_maxmsg > ipc_ns->mq_msg_max ||
711 attr->mq_msgsize > ipc_ns->mq_msgsize_max)
714 /* check for overflow */
715 if (attr->mq_msgsize > ULONG_MAX/attr->mq_maxmsg)
717 mq_treesize = attr->mq_maxmsg * sizeof(struct msg_msg) +
718 min_t(unsigned int, attr->mq_maxmsg, MQ_PRIO_MAX) *
719 sizeof(struct posix_msg_tree_node);
720 total_size = attr->mq_maxmsg * attr->mq_msgsize;
721 if (total_size + mq_treesize < total_size)
727 * Invoked when creating a new queue via sys_mq_open
729 static struct file *do_create(struct ipc_namespace *ipc_ns, struct inode *dir,
730 struct path *path, int oflag, umode_t mode,
731 struct mq_attr *attr)
733 const struct cred *cred = current_cred();
737 ret = mq_attr_ok(ipc_ns, attr);
740 /* store for use during create */
741 path->dentry->d_fsdata = attr;
743 struct mq_attr def_attr;
745 def_attr.mq_maxmsg = min(ipc_ns->mq_msg_max,
746 ipc_ns->mq_msg_default);
747 def_attr.mq_msgsize = min(ipc_ns->mq_msgsize_max,
748 ipc_ns->mq_msgsize_default);
749 ret = mq_attr_ok(ipc_ns, &def_attr);
754 mode &= ~current_umask();
755 ret = vfs_create(dir, path->dentry, mode, true);
756 path->dentry->d_fsdata = NULL;
759 return dentry_open(path, oflag, cred);
762 /* Opens existing queue */
763 static struct file *do_open(struct path *path, int oflag)
765 static const int oflag2acc[O_ACCMODE] = { MAY_READ, MAY_WRITE,
766 MAY_READ | MAY_WRITE };
768 if ((oflag & O_ACCMODE) == (O_RDWR | O_WRONLY))
769 return ERR_PTR(-EINVAL);
770 acc = oflag2acc[oflag & O_ACCMODE];
771 if (inode_permission(d_inode(path->dentry), acc))
772 return ERR_PTR(-EACCES);
773 return dentry_open(path, oflag, current_cred());
776 SYSCALL_DEFINE4(mq_open, const char __user *, u_name, int, oflag, umode_t, mode,
777 struct mq_attr __user *, u_attr)
781 struct filename *name;
784 struct ipc_namespace *ipc_ns = current->nsproxy->ipc_ns;
785 struct vfsmount *mnt = ipc_ns->mq_mnt;
786 struct dentry *root = mnt->mnt_root;
789 if (u_attr && copy_from_user(&attr, u_attr, sizeof(struct mq_attr)))
792 audit_mq_open(oflag, mode, u_attr ? &attr : NULL);
794 if (IS_ERR(name = getname(u_name)))
795 return PTR_ERR(name);
797 fd = get_unused_fd_flags(O_CLOEXEC);
801 ro = mnt_want_write(mnt); /* we'll drop it in any case */
803 inode_lock(d_inode(root));
804 path.dentry = lookup_one_len(name->name, root, strlen(name->name));
805 if (IS_ERR(path.dentry)) {
806 error = PTR_ERR(path.dentry);
809 path.mnt = mntget(mnt);
811 if (oflag & O_CREAT) {
812 if (d_really_is_positive(path.dentry)) { /* entry already exists */
813 audit_inode(name, path.dentry, 0);
814 if (oflag & O_EXCL) {
818 filp = do_open(&path, oflag);
824 audit_inode_parent_hidden(name, root);
825 filp = do_create(ipc_ns, d_inode(root),
827 u_attr ? &attr : NULL);
830 if (d_really_is_negative(path.dentry)) {
834 audit_inode(name, path.dentry, 0);
835 filp = do_open(&path, oflag);
839 fd_install(fd, filp);
841 error = PTR_ERR(filp);
849 inode_unlock(d_inode(root));
857 SYSCALL_DEFINE1(mq_unlink, const char __user *, u_name)
860 struct filename *name;
861 struct dentry *dentry;
862 struct inode *inode = NULL;
863 struct ipc_namespace *ipc_ns = current->nsproxy->ipc_ns;
864 struct vfsmount *mnt = ipc_ns->mq_mnt;
866 name = getname(u_name);
868 return PTR_ERR(name);
870 audit_inode_parent_hidden(name, mnt->mnt_root);
871 err = mnt_want_write(mnt);
874 inode_lock_nested(d_inode(mnt->mnt_root), I_MUTEX_PARENT);
875 dentry = lookup_one_len(name->name, mnt->mnt_root,
877 if (IS_ERR(dentry)) {
878 err = PTR_ERR(dentry);
882 inode = d_inode(dentry);
887 err = vfs_unlink(d_inode(dentry->d_parent), dentry, NULL);
892 inode_unlock(d_inode(mnt->mnt_root));
902 /* Pipelined send and receive functions.
904 * If a receiver finds no waiting message, then it registers itself in the
905 * list of waiting receivers. A sender checks that list before adding the new
906 * message into the message array. If there is a waiting receiver, then it
907 * bypasses the message array and directly hands the message over to the
908 * receiver. The receiver accepts the message and returns without grabbing the
911 * - Set pointer to message.
912 * - Queue the receiver task for later wakeup (without the info->lock).
913 * - Update its state to STATE_READY. Now the receiver can continue.
914 * - Wake up the process after the lock is dropped. Should the process wake up
915 * before this wakeup (due to a timeout or a signal) it will either see
916 * STATE_READY and continue or acquire the lock to check the state again.
918 * The same algorithm is used for senders.
921 /* pipelined_send() - send a message directly to the task waiting in
922 * sys_mq_timedreceive() (without inserting message into a queue).
924 static inline void pipelined_send(struct wake_q_head *wake_q,
925 struct mqueue_inode_info *info,
926 struct msg_msg *message,
927 struct ext_wait_queue *receiver)
929 receiver->msg = message;
930 list_del(&receiver->list);
931 wake_q_add(wake_q, receiver->task);
933 * Rely on the implicit cmpxchg barrier from wake_q_add such
934 * that we can ensure that updating receiver->state is the last
935 * write operation: As once set, the receiver can continue,
936 * and if we don't have the reference count from the wake_q,
937 * yet, at that point we can later have a use-after-free
938 * condition and bogus wakeup.
940 receiver->state = STATE_READY;
943 /* pipelined_receive() - if there is task waiting in sys_mq_timedsend()
944 * gets its message and put to the queue (we have one free place for sure). */
945 static inline void pipelined_receive(struct wake_q_head *wake_q,
946 struct mqueue_inode_info *info)
948 struct ext_wait_queue *sender = wq_get_first_waiter(info, SEND);
952 wake_up_interruptible(&info->wait_q);
955 if (msg_insert(sender->msg, info))
958 list_del(&sender->list);
959 wake_q_add(wake_q, sender->task);
960 sender->state = STATE_READY;
963 SYSCALL_DEFINE5(mq_timedsend, mqd_t, mqdes, const char __user *, u_msg_ptr,
964 size_t, msg_len, unsigned int, msg_prio,
965 const struct timespec __user *, u_abs_timeout)
969 struct ext_wait_queue wait;
970 struct ext_wait_queue *receiver;
971 struct msg_msg *msg_ptr;
972 struct mqueue_inode_info *info;
973 ktime_t expires, *timeout = NULL;
975 struct posix_msg_tree_node *new_leaf = NULL;
980 int res = prepare_timeout(u_abs_timeout, &expires, &ts);
986 if (unlikely(msg_prio >= (unsigned long) MQ_PRIO_MAX))
989 audit_mq_sendrecv(mqdes, msg_len, msg_prio, timeout ? &ts : NULL);
992 if (unlikely(!f.file)) {
997 inode = file_inode(f.file);
998 if (unlikely(f.file->f_op != &mqueue_file_operations)) {
1002 info = MQUEUE_I(inode);
1005 if (unlikely(!(f.file->f_mode & FMODE_WRITE))) {
1010 if (unlikely(msg_len > info->attr.mq_msgsize)) {
1015 /* First try to allocate memory, before doing anything with
1016 * existing queues. */
1017 msg_ptr = load_msg(u_msg_ptr, msg_len);
1018 if (IS_ERR(msg_ptr)) {
1019 ret = PTR_ERR(msg_ptr);
1022 msg_ptr->m_ts = msg_len;
1023 msg_ptr->m_type = msg_prio;
1026 * msg_insert really wants us to have a valid, spare node struct so
1027 * it doesn't have to kmalloc a GFP_ATOMIC allocation, but it will
1028 * fall back to that if necessary.
1030 if (!info->node_cache)
1031 new_leaf = kmalloc(sizeof(*new_leaf), GFP_KERNEL);
1033 spin_lock(&info->lock);
1035 if (!info->node_cache && new_leaf) {
1036 /* Save our speculative allocation into the cache */
1037 INIT_LIST_HEAD(&new_leaf->msg_list);
1038 info->node_cache = new_leaf;
1044 if (info->attr.mq_curmsgs == info->attr.mq_maxmsg) {
1045 if (f.file->f_flags & O_NONBLOCK) {
1048 wait.task = current;
1049 wait.msg = (void *) msg_ptr;
1050 wait.state = STATE_NONE;
1051 ret = wq_sleep(info, SEND, timeout, &wait);
1053 * wq_sleep must be called with info->lock held, and
1054 * returns with the lock released
1059 receiver = wq_get_first_waiter(info, RECV);
1061 pipelined_send(&wake_q, info, msg_ptr, receiver);
1063 /* adds message to the queue */
1064 ret = msg_insert(msg_ptr, info);
1069 inode->i_atime = inode->i_mtime = inode->i_ctime =
1070 current_time(inode);
1073 spin_unlock(&info->lock);
1084 SYSCALL_DEFINE5(mq_timedreceive, mqd_t, mqdes, char __user *, u_msg_ptr,
1085 size_t, msg_len, unsigned int __user *, u_msg_prio,
1086 const struct timespec __user *, u_abs_timeout)
1089 struct msg_msg *msg_ptr;
1091 struct inode *inode;
1092 struct mqueue_inode_info *info;
1093 struct ext_wait_queue wait;
1094 ktime_t expires, *timeout = NULL;
1096 struct posix_msg_tree_node *new_leaf = NULL;
1098 if (u_abs_timeout) {
1099 int res = prepare_timeout(u_abs_timeout, &expires, &ts);
1105 audit_mq_sendrecv(mqdes, msg_len, 0, timeout ? &ts : NULL);
1108 if (unlikely(!f.file)) {
1113 inode = file_inode(f.file);
1114 if (unlikely(f.file->f_op != &mqueue_file_operations)) {
1118 info = MQUEUE_I(inode);
1121 if (unlikely(!(f.file->f_mode & FMODE_READ))) {
1126 /* checks if buffer is big enough */
1127 if (unlikely(msg_len < info->attr.mq_msgsize)) {
1133 * msg_insert really wants us to have a valid, spare node struct so
1134 * it doesn't have to kmalloc a GFP_ATOMIC allocation, but it will
1135 * fall back to that if necessary.
1137 if (!info->node_cache)
1138 new_leaf = kmalloc(sizeof(*new_leaf), GFP_KERNEL);
1140 spin_lock(&info->lock);
1142 if (!info->node_cache && new_leaf) {
1143 /* Save our speculative allocation into the cache */
1144 INIT_LIST_HEAD(&new_leaf->msg_list);
1145 info->node_cache = new_leaf;
1150 if (info->attr.mq_curmsgs == 0) {
1151 if (f.file->f_flags & O_NONBLOCK) {
1152 spin_unlock(&info->lock);
1155 wait.task = current;
1156 wait.state = STATE_NONE;
1157 ret = wq_sleep(info, RECV, timeout, &wait);
1163 msg_ptr = msg_get(info);
1165 inode->i_atime = inode->i_mtime = inode->i_ctime =
1166 current_time(inode);
1168 /* There is now free space in queue. */
1169 pipelined_receive(&wake_q, info);
1170 spin_unlock(&info->lock);
1175 ret = msg_ptr->m_ts;
1177 if ((u_msg_prio && put_user(msg_ptr->m_type, u_msg_prio)) ||
1178 store_msg(u_msg_ptr, msg_ptr, msg_ptr->m_ts)) {
1190 * Notes: the case when user wants us to deregister (with NULL as pointer)
1191 * and he isn't currently owner of notification, will be silently discarded.
1192 * It isn't explicitly defined in the POSIX.
1194 SYSCALL_DEFINE2(mq_notify, mqd_t, mqdes,
1195 const struct sigevent __user *, u_notification)
1200 struct inode *inode;
1201 struct sigevent notification;
1202 struct mqueue_inode_info *info;
1205 if (u_notification) {
1206 if (copy_from_user(¬ification, u_notification,
1207 sizeof(struct sigevent)))
1211 audit_mq_notify(mqdes, u_notification ? ¬ification : NULL);
1215 if (u_notification != NULL) {
1216 if (unlikely(notification.sigev_notify != SIGEV_NONE &&
1217 notification.sigev_notify != SIGEV_SIGNAL &&
1218 notification.sigev_notify != SIGEV_THREAD))
1220 if (notification.sigev_notify == SIGEV_SIGNAL &&
1221 !valid_signal(notification.sigev_signo)) {
1224 if (notification.sigev_notify == SIGEV_THREAD) {
1227 /* create the notify skb */
1228 nc = alloc_skb(NOTIFY_COOKIE_LEN, GFP_KERNEL);
1233 if (copy_from_user(nc->data,
1234 notification.sigev_value.sival_ptr,
1235 NOTIFY_COOKIE_LEN)) {
1240 /* TODO: add a header? */
1241 skb_put(nc, NOTIFY_COOKIE_LEN);
1242 /* and attach it to the socket */
1244 f = fdget(notification.sigev_signo);
1249 sock = netlink_getsockbyfilp(f.file);
1252 ret = PTR_ERR(sock);
1257 timeo = MAX_SCHEDULE_TIMEOUT;
1258 ret = netlink_attachskb(sock, nc, &timeo, NULL);
1277 inode = file_inode(f.file);
1278 if (unlikely(f.file->f_op != &mqueue_file_operations)) {
1282 info = MQUEUE_I(inode);
1285 spin_lock(&info->lock);
1286 if (u_notification == NULL) {
1287 if (info->notify_owner == task_tgid(current)) {
1288 remove_notification(info);
1289 inode->i_atime = inode->i_ctime = current_time(inode);
1291 } else if (info->notify_owner != NULL) {
1294 switch (notification.sigev_notify) {
1296 info->notify.sigev_notify = SIGEV_NONE;
1299 info->notify_sock = sock;
1300 info->notify_cookie = nc;
1303 info->notify.sigev_notify = SIGEV_THREAD;
1306 info->notify.sigev_signo = notification.sigev_signo;
1307 info->notify.sigev_value = notification.sigev_value;
1308 info->notify.sigev_notify = SIGEV_SIGNAL;
1312 info->notify_owner = get_pid(task_tgid(current));
1313 info->notify_user_ns = get_user_ns(current_user_ns());
1314 inode->i_atime = inode->i_ctime = current_time(inode);
1316 spin_unlock(&info->lock);
1321 netlink_detachskb(sock, nc);
1328 SYSCALL_DEFINE3(mq_getsetattr, mqd_t, mqdes,
1329 const struct mq_attr __user *, u_mqstat,
1330 struct mq_attr __user *, u_omqstat)
1333 struct mq_attr mqstat, omqstat;
1335 struct inode *inode;
1336 struct mqueue_inode_info *info;
1338 if (u_mqstat != NULL) {
1339 if (copy_from_user(&mqstat, u_mqstat, sizeof(struct mq_attr)))
1341 if (mqstat.mq_flags & (~O_NONBLOCK))
1351 inode = file_inode(f.file);
1352 if (unlikely(f.file->f_op != &mqueue_file_operations)) {
1356 info = MQUEUE_I(inode);
1358 spin_lock(&info->lock);
1360 omqstat = info->attr;
1361 omqstat.mq_flags = f.file->f_flags & O_NONBLOCK;
1363 audit_mq_getsetattr(mqdes, &mqstat);
1364 spin_lock(&f.file->f_lock);
1365 if (mqstat.mq_flags & O_NONBLOCK)
1366 f.file->f_flags |= O_NONBLOCK;
1368 f.file->f_flags &= ~O_NONBLOCK;
1369 spin_unlock(&f.file->f_lock);
1371 inode->i_atime = inode->i_ctime = current_time(inode);
1374 spin_unlock(&info->lock);
1377 if (u_omqstat != NULL && copy_to_user(u_omqstat, &omqstat,
1378 sizeof(struct mq_attr)))
1387 static const struct inode_operations mqueue_dir_inode_operations = {
1388 .lookup = simple_lookup,
1389 .create = mqueue_create,
1390 .unlink = mqueue_unlink,
1393 static const struct file_operations mqueue_file_operations = {
1394 .flush = mqueue_flush_file,
1395 .poll = mqueue_poll_file,
1396 .read = mqueue_read_file,
1397 .llseek = default_llseek,
1400 static const struct super_operations mqueue_super_ops = {
1401 .alloc_inode = mqueue_alloc_inode,
1402 .destroy_inode = mqueue_destroy_inode,
1403 .evict_inode = mqueue_evict_inode,
1404 .statfs = simple_statfs,
1407 static struct file_system_type mqueue_fs_type = {
1409 .mount = mqueue_mount,
1410 .kill_sb = kill_litter_super,
1411 .fs_flags = FS_USERNS_MOUNT,
1414 int mq_init_ns(struct ipc_namespace *ns)
1416 ns->mq_queues_count = 0;
1417 ns->mq_queues_max = DFLT_QUEUESMAX;
1418 ns->mq_msg_max = DFLT_MSGMAX;
1419 ns->mq_msgsize_max = DFLT_MSGSIZEMAX;
1420 ns->mq_msg_default = DFLT_MSG;
1421 ns->mq_msgsize_default = DFLT_MSGSIZE;
1423 ns->mq_mnt = kern_mount_data(&mqueue_fs_type, ns);
1424 if (IS_ERR(ns->mq_mnt)) {
1425 int err = PTR_ERR(ns->mq_mnt);
1432 void mq_clear_sbinfo(struct ipc_namespace *ns)
1434 ns->mq_mnt->mnt_sb->s_fs_info = NULL;
1437 void mq_put_mnt(struct ipc_namespace *ns)
1439 kern_unmount(ns->mq_mnt);
1442 static int __init init_mqueue_fs(void)
1446 mqueue_inode_cachep = kmem_cache_create("mqueue_inode_cache",
1447 sizeof(struct mqueue_inode_info), 0,
1448 SLAB_HWCACHE_ALIGN|SLAB_ACCOUNT, init_once);
1449 if (mqueue_inode_cachep == NULL)
1452 /* ignore failures - they are not fatal */
1453 mq_sysctl_table = mq_register_sysctl_table();
1455 error = register_filesystem(&mqueue_fs_type);
1459 spin_lock_init(&mq_lock);
1461 error = mq_init_ns(&init_ipc_ns);
1463 goto out_filesystem;
1468 unregister_filesystem(&mqueue_fs_type);
1470 if (mq_sysctl_table)
1471 unregister_sysctl_table(mq_sysctl_table);
1472 kmem_cache_destroy(mqueue_inode_cachep);
1476 device_initcall(init_mqueue_fs);