2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (C) 2000-2001 Qualcomm Incorporated
5 Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License version 2 as
9 published by the Free Software Foundation;
11 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
12 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
14 IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
15 CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
16 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
21 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
22 SOFTWARE IS DISCLAIMED.
25 /* Bluetooth address family and sockets. */
27 #include <linux/module.h>
28 #include <linux/debugfs.h>
29 #include <linux/stringify.h>
30 #include <linux/sched/signal.h>
32 #include <asm/ioctls.h>
34 #include <net/bluetooth/bluetooth.h>
35 #include <linux/proc_fs.h>
40 /* Bluetooth sockets */
41 #define BT_MAX_PROTO (BTPROTO_LAST + 1)
42 static const struct net_proto_family *bt_proto[BT_MAX_PROTO];
43 static DEFINE_RWLOCK(bt_proto_lock);
45 static struct lock_class_key bt_lock_key[BT_MAX_PROTO];
46 static const char *const bt_key_strings[BT_MAX_PROTO] = {
47 "sk_lock-AF_BLUETOOTH-BTPROTO_L2CAP",
48 "sk_lock-AF_BLUETOOTH-BTPROTO_HCI",
49 "sk_lock-AF_BLUETOOTH-BTPROTO_SCO",
50 "sk_lock-AF_BLUETOOTH-BTPROTO_RFCOMM",
51 "sk_lock-AF_BLUETOOTH-BTPROTO_BNEP",
52 "sk_lock-AF_BLUETOOTH-BTPROTO_CMTP",
53 "sk_lock-AF_BLUETOOTH-BTPROTO_HIDP",
54 "sk_lock-AF_BLUETOOTH-BTPROTO_AVDTP",
55 "sk_lock-AF_BLUETOOTH-BTPROTO_ISO",
58 static struct lock_class_key bt_slock_key[BT_MAX_PROTO];
59 static const char *const bt_slock_key_strings[BT_MAX_PROTO] = {
60 "slock-AF_BLUETOOTH-BTPROTO_L2CAP",
61 "slock-AF_BLUETOOTH-BTPROTO_HCI",
62 "slock-AF_BLUETOOTH-BTPROTO_SCO",
63 "slock-AF_BLUETOOTH-BTPROTO_RFCOMM",
64 "slock-AF_BLUETOOTH-BTPROTO_BNEP",
65 "slock-AF_BLUETOOTH-BTPROTO_CMTP",
66 "slock-AF_BLUETOOTH-BTPROTO_HIDP",
67 "slock-AF_BLUETOOTH-BTPROTO_AVDTP",
68 "slock-AF_BLUETOOTH-BTPROTO_ISO",
71 void bt_sock_reclassify_lock(struct sock *sk, int proto)
74 BUG_ON(!sock_allow_reclassification(sk));
76 sock_lock_init_class_and_name(sk,
77 bt_slock_key_strings[proto], &bt_slock_key[proto],
78 bt_key_strings[proto], &bt_lock_key[proto]);
80 EXPORT_SYMBOL(bt_sock_reclassify_lock);
82 int bt_sock_register(int proto, const struct net_proto_family *ops)
86 if (proto < 0 || proto >= BT_MAX_PROTO)
89 write_lock(&bt_proto_lock);
94 bt_proto[proto] = ops;
96 write_unlock(&bt_proto_lock);
100 EXPORT_SYMBOL(bt_sock_register);
102 void bt_sock_unregister(int proto)
104 if (proto < 0 || proto >= BT_MAX_PROTO)
107 write_lock(&bt_proto_lock);
108 bt_proto[proto] = NULL;
109 write_unlock(&bt_proto_lock);
111 EXPORT_SYMBOL(bt_sock_unregister);
113 static int bt_sock_create(struct net *net, struct socket *sock, int proto,
118 if (net != &init_net)
119 return -EAFNOSUPPORT;
121 if (proto < 0 || proto >= BT_MAX_PROTO)
124 if (!bt_proto[proto])
125 request_module("bt-proto-%d", proto);
127 err = -EPROTONOSUPPORT;
129 read_lock(&bt_proto_lock);
131 if (bt_proto[proto] && try_module_get(bt_proto[proto]->owner)) {
132 err = bt_proto[proto]->create(net, sock, proto, kern);
134 bt_sock_reclassify_lock(sock->sk, proto);
135 module_put(bt_proto[proto]->owner);
138 read_unlock(&bt_proto_lock);
143 struct sock *bt_sock_alloc(struct net *net, struct socket *sock,
144 struct proto *prot, int proto, gfp_t prio, int kern)
148 sk = sk_alloc(net, PF_BLUETOOTH, prio, prot, kern);
152 sock_init_data(sock, sk);
153 INIT_LIST_HEAD(&bt_sk(sk)->accept_q);
155 sock_reset_flag(sk, SOCK_ZAPPED);
157 sk->sk_protocol = proto;
158 sk->sk_state = BT_OPEN;
160 /* Init peer information so it can be properly monitored */
162 spin_lock(&sk->sk_peer_lock);
163 sk->sk_peer_pid = get_pid(task_tgid(current));
164 sk->sk_peer_cred = get_current_cred();
165 spin_unlock(&sk->sk_peer_lock);
170 EXPORT_SYMBOL(bt_sock_alloc);
172 void bt_sock_link(struct bt_sock_list *l, struct sock *sk)
174 write_lock(&l->lock);
175 sk_add_node(sk, &l->head);
176 write_unlock(&l->lock);
178 EXPORT_SYMBOL(bt_sock_link);
180 void bt_sock_unlink(struct bt_sock_list *l, struct sock *sk)
182 write_lock(&l->lock);
183 sk_del_node_init(sk);
184 write_unlock(&l->lock);
186 EXPORT_SYMBOL(bt_sock_unlink);
188 void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh)
190 const struct cred *old_cred;
193 BT_DBG("parent %p, sk %p", parent, sk);
198 bh_lock_sock_nested(sk);
200 lock_sock_nested(sk, SINGLE_DEPTH_NESTING);
202 list_add_tail(&bt_sk(sk)->accept_q, &bt_sk(parent)->accept_q);
203 bt_sk(sk)->parent = parent;
205 /* Copy credentials from parent since for incoming connections the
206 * socket is allocated by the kernel.
208 spin_lock(&sk->sk_peer_lock);
209 old_pid = sk->sk_peer_pid;
210 old_cred = sk->sk_peer_cred;
211 sk->sk_peer_pid = get_pid(parent->sk_peer_pid);
212 sk->sk_peer_cred = get_cred(parent->sk_peer_cred);
213 spin_unlock(&sk->sk_peer_lock);
223 sk_acceptq_added(parent);
225 EXPORT_SYMBOL(bt_accept_enqueue);
227 /* Calling function must hold the sk lock.
228 * bt_sk(sk)->parent must be non-NULL meaning sk is in the parent list.
230 void bt_accept_unlink(struct sock *sk)
232 BT_DBG("sk %p state %d", sk, sk->sk_state);
234 list_del_init(&bt_sk(sk)->accept_q);
235 sk_acceptq_removed(bt_sk(sk)->parent);
236 bt_sk(sk)->parent = NULL;
239 EXPORT_SYMBOL(bt_accept_unlink);
241 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock)
243 struct bt_sock *s, *n;
246 BT_DBG("parent %p", parent);
249 list_for_each_entry_safe(s, n, &bt_sk(parent)->accept_q, accept_q) {
250 sk = (struct sock *)s;
252 /* Prevent early freeing of sk due to unlink and sock_kill */
256 /* Check sk has not already been unlinked via
257 * bt_accept_unlink() due to serialisation caused by sk locking
259 if (!bt_sk(sk)->parent) {
260 BT_DBG("sk %p, already unlinked", sk);
264 /* Restart the loop as sk is no longer in the list
265 * and also avoid a potential infinite loop because
266 * list_for_each_entry_safe() is not thread safe.
271 /* sk is safely in the parent list so reduce reference count */
274 /* FIXME: Is this check still needed */
275 if (sk->sk_state == BT_CLOSED) {
276 bt_accept_unlink(sk);
281 if (sk->sk_state == BT_CONNECTED || !newsock ||
282 test_bit(BT_SK_DEFER_SETUP, &bt_sk(parent)->flags)) {
283 bt_accept_unlink(sk);
285 sock_graft(sk, newsock);
296 EXPORT_SYMBOL(bt_accept_dequeue);
298 int bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
301 struct sock *sk = sock->sk;
307 BT_DBG("sock %p sk %p len %zu", sock, sk, len);
312 skb = skb_recv_datagram(sk, flags, &err);
314 if (sk->sk_shutdown & RCV_SHUTDOWN)
323 msg->msg_flags |= MSG_TRUNC;
327 skb_reset_transport_header(skb);
328 err = skb_copy_datagram_msg(skb, 0, msg, copied);
330 sock_recv_cmsgs(msg, sk, skb);
332 if (msg->msg_name && bt_sk(sk)->skb_msg_name)
333 bt_sk(sk)->skb_msg_name(skb, msg->msg_name,
336 if (test_bit(BT_SK_PKT_STATUS, &bt_sk(sk)->flags)) {
337 u8 pkt_status = hci_skb_pkt_status(skb);
339 put_cmsg(msg, SOL_BLUETOOTH, BT_SCM_PKT_STATUS,
340 sizeof(pkt_status), &pkt_status);
344 skb_free_datagram(sk, skb);
346 if (flags & MSG_TRUNC)
349 return err ? : copied;
351 EXPORT_SYMBOL(bt_sock_recvmsg);
353 static long bt_sock_data_wait(struct sock *sk, long timeo)
355 DECLARE_WAITQUEUE(wait, current);
357 add_wait_queue(sk_sleep(sk), &wait);
359 set_current_state(TASK_INTERRUPTIBLE);
361 if (!skb_queue_empty(&sk->sk_receive_queue))
364 if (sk->sk_err || (sk->sk_shutdown & RCV_SHUTDOWN))
367 if (signal_pending(current) || !timeo)
370 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
372 timeo = schedule_timeout(timeo);
374 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
377 __set_current_state(TASK_RUNNING);
378 remove_wait_queue(sk_sleep(sk), &wait);
382 int bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
383 size_t size, int flags)
385 struct sock *sk = sock->sk;
387 size_t target, copied = 0;
393 BT_DBG("sk %p size %zu", sk, size);
397 target = sock_rcvlowat(sk, flags & MSG_WAITALL, size);
398 timeo = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
404 skb = skb_dequeue(&sk->sk_receive_queue);
406 if (copied >= target)
409 err = sock_error(sk);
412 if (sk->sk_shutdown & RCV_SHUTDOWN)
419 timeo = bt_sock_data_wait(sk, timeo);
421 if (signal_pending(current)) {
422 err = sock_intr_errno(timeo);
428 chunk = min_t(unsigned int, skb->len, size);
429 if (skb_copy_datagram_msg(skb, 0, msg, chunk)) {
430 skb_queue_head(&sk->sk_receive_queue, skb);
438 sock_recv_cmsgs(msg, sk, skb);
440 if (!(flags & MSG_PEEK)) {
441 int skb_len = skb_headlen(skb);
443 if (chunk <= skb_len) {
444 __skb_pull(skb, chunk);
446 struct sk_buff *frag;
448 __skb_pull(skb, skb_len);
451 skb_walk_frags(skb, frag) {
452 if (chunk <= frag->len) {
453 /* Pulling partial data */
455 skb->data_len -= chunk;
456 __skb_pull(frag, chunk);
458 } else if (frag->len) {
459 /* Pulling all frag data */
461 skb->len -= frag->len;
462 skb->data_len -= frag->len;
463 __skb_pull(frag, frag->len);
469 skb_queue_head(&sk->sk_receive_queue, skb);
475 /* put message back and return */
476 skb_queue_head(&sk->sk_receive_queue, skb);
483 return copied ? : err;
485 EXPORT_SYMBOL(bt_sock_stream_recvmsg);
487 static inline __poll_t bt_accept_poll(struct sock *parent)
489 struct bt_sock *s, *n;
492 list_for_each_entry_safe(s, n, &bt_sk(parent)->accept_q, accept_q) {
493 sk = (struct sock *)s;
494 if (sk->sk_state == BT_CONNECTED ||
495 (test_bit(BT_SK_DEFER_SETUP, &bt_sk(parent)->flags) &&
496 sk->sk_state == BT_CONNECT2))
497 return EPOLLIN | EPOLLRDNORM;
503 __poll_t bt_sock_poll(struct file *file, struct socket *sock,
506 struct sock *sk = sock->sk;
509 poll_wait(file, sk_sleep(sk), wait);
511 if (sk->sk_state == BT_LISTEN)
512 return bt_accept_poll(sk);
514 if (sk->sk_err || !skb_queue_empty_lockless(&sk->sk_error_queue))
516 (sock_flag(sk, SOCK_SELECT_ERR_QUEUE) ? EPOLLPRI : 0);
518 if (sk->sk_shutdown & RCV_SHUTDOWN)
519 mask |= EPOLLRDHUP | EPOLLIN | EPOLLRDNORM;
521 if (sk->sk_shutdown == SHUTDOWN_MASK)
524 if (!skb_queue_empty_lockless(&sk->sk_receive_queue))
525 mask |= EPOLLIN | EPOLLRDNORM;
527 if (sk->sk_state == BT_CLOSED)
530 if (sk->sk_state == BT_CONNECT ||
531 sk->sk_state == BT_CONNECT2 ||
532 sk->sk_state == BT_CONFIG)
535 if (!test_bit(BT_SK_SUSPEND, &bt_sk(sk)->flags) && sock_writeable(sk))
536 mask |= EPOLLOUT | EPOLLWRNORM | EPOLLWRBAND;
538 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
542 EXPORT_SYMBOL(bt_sock_poll);
544 int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
546 struct sock *sk = sock->sk;
551 BT_DBG("sk %p cmd %x arg %lx", sk, cmd, arg);
555 if (sk->sk_state == BT_LISTEN)
558 amount = sk->sk_sndbuf - sk_wmem_alloc_get(sk);
561 err = put_user(amount, (int __user *)arg);
565 if (sk->sk_state == BT_LISTEN)
569 skb = skb_peek(&sk->sk_receive_queue);
570 amount = skb ? skb->len : 0;
572 err = put_user(amount, (int __user *)arg);
582 EXPORT_SYMBOL(bt_sock_ioctl);
584 /* This function expects the sk lock to be held when called */
585 int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo)
587 DECLARE_WAITQUEUE(wait, current);
592 add_wait_queue(sk_sleep(sk), &wait);
593 set_current_state(TASK_INTERRUPTIBLE);
594 while (sk->sk_state != state) {
600 if (signal_pending(current)) {
601 err = sock_intr_errno(timeo);
606 timeo = schedule_timeout(timeo);
608 set_current_state(TASK_INTERRUPTIBLE);
610 err = sock_error(sk);
614 __set_current_state(TASK_RUNNING);
615 remove_wait_queue(sk_sleep(sk), &wait);
618 EXPORT_SYMBOL(bt_sock_wait_state);
620 /* This function expects the sk lock to be held when called */
621 int bt_sock_wait_ready(struct sock *sk, unsigned int msg_flags)
623 DECLARE_WAITQUEUE(wait, current);
629 timeo = sock_sndtimeo(sk, !!(msg_flags & MSG_DONTWAIT));
631 add_wait_queue(sk_sleep(sk), &wait);
632 set_current_state(TASK_INTERRUPTIBLE);
633 while (test_bit(BT_SK_SUSPEND, &bt_sk(sk)->flags)) {
639 if (signal_pending(current)) {
640 err = sock_intr_errno(timeo);
645 timeo = schedule_timeout(timeo);
647 set_current_state(TASK_INTERRUPTIBLE);
649 err = sock_error(sk);
653 __set_current_state(TASK_RUNNING);
654 remove_wait_queue(sk_sleep(sk), &wait);
658 EXPORT_SYMBOL(bt_sock_wait_ready);
660 #ifdef CONFIG_PROC_FS
661 static void *bt_seq_start(struct seq_file *seq, loff_t *pos)
662 __acquires(seq->private->l->lock)
664 struct bt_sock_list *l = pde_data(file_inode(seq->file));
667 return seq_hlist_start_head(&l->head, *pos);
670 static void *bt_seq_next(struct seq_file *seq, void *v, loff_t *pos)
672 struct bt_sock_list *l = pde_data(file_inode(seq->file));
674 return seq_hlist_next(v, &l->head, pos);
677 static void bt_seq_stop(struct seq_file *seq, void *v)
678 __releases(seq->private->l->lock)
680 struct bt_sock_list *l = pde_data(file_inode(seq->file));
682 read_unlock(&l->lock);
685 static int bt_seq_show(struct seq_file *seq, void *v)
687 struct bt_sock_list *l = pde_data(file_inode(seq->file));
689 if (v == SEQ_START_TOKEN) {
690 seq_puts(seq, "sk RefCnt Rmem Wmem User Inode Parent");
692 if (l->custom_seq_show) {
694 l->custom_seq_show(seq, v);
699 struct sock *sk = sk_entry(v);
700 struct bt_sock *bt = bt_sk(sk);
703 "%pK %-6d %-6u %-6u %-6u %-6lu %-6lu",
705 refcount_read(&sk->sk_refcnt),
706 sk_rmem_alloc_get(sk),
707 sk_wmem_alloc_get(sk),
708 from_kuid(seq_user_ns(seq), sock_i_uid(sk)),
710 bt->parent ? sock_i_ino(bt->parent) : 0LU);
712 if (l->custom_seq_show) {
714 l->custom_seq_show(seq, v);
722 static const struct seq_operations bt_seq_ops = {
723 .start = bt_seq_start,
729 int bt_procfs_init(struct net *net, const char *name,
730 struct bt_sock_list *sk_list,
731 int (*seq_show)(struct seq_file *, void *))
733 sk_list->custom_seq_show = seq_show;
735 if (!proc_create_seq_data(name, 0, net->proc_net, &bt_seq_ops, sk_list))
740 void bt_procfs_cleanup(struct net *net, const char *name)
742 remove_proc_entry(name, net->proc_net);
745 int bt_procfs_init(struct net *net, const char *name,
746 struct bt_sock_list *sk_list,
747 int (*seq_show)(struct seq_file *, void *))
752 void bt_procfs_cleanup(struct net *net, const char *name)
756 EXPORT_SYMBOL(bt_procfs_init);
757 EXPORT_SYMBOL(bt_procfs_cleanup);
759 static const struct net_proto_family bt_sock_family_ops = {
760 .owner = THIS_MODULE,
761 .family = PF_BLUETOOTH,
762 .create = bt_sock_create,
765 struct dentry *bt_debugfs;
766 EXPORT_SYMBOL_GPL(bt_debugfs);
768 #define VERSION __stringify(BT_SUBSYS_VERSION) "." \
769 __stringify(BT_SUBSYS_REVISION)
771 static int __init bt_init(void)
775 sock_skb_cb_check_size(sizeof(struct bt_skb_cb));
777 BT_INFO("Core ver %s", VERSION);
783 bt_debugfs = debugfs_create_dir("bluetooth", NULL);
787 err = bt_sysfs_init();
791 err = sock_register(&bt_sock_family_ops);
795 BT_INFO("HCI device and connection manager initialized");
797 err = hci_sock_init();
799 goto unregister_socket;
822 sock_unregister(PF_BLUETOOTH);
830 static void __exit bt_exit(void)
840 sock_unregister(PF_BLUETOOTH);
846 debugfs_remove_recursive(bt_debugfs);
849 subsys_initcall(bt_init);
850 module_exit(bt_exit);
852 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
853 MODULE_DESCRIPTION("Bluetooth Core ver " VERSION);
854 MODULE_VERSION(VERSION);
855 MODULE_LICENSE("GPL");
856 MODULE_ALIAS_NETPROTO(PF_BLUETOOTH);