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 8
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",
57 static struct lock_class_key bt_slock_key[BT_MAX_PROTO];
58 static const char *const bt_slock_key_strings[BT_MAX_PROTO] = {
59 "slock-AF_BLUETOOTH-BTPROTO_L2CAP",
60 "slock-AF_BLUETOOTH-BTPROTO_HCI",
61 "slock-AF_BLUETOOTH-BTPROTO_SCO",
62 "slock-AF_BLUETOOTH-BTPROTO_RFCOMM",
63 "slock-AF_BLUETOOTH-BTPROTO_BNEP",
64 "slock-AF_BLUETOOTH-BTPROTO_CMTP",
65 "slock-AF_BLUETOOTH-BTPROTO_HIDP",
66 "slock-AF_BLUETOOTH-BTPROTO_AVDTP",
69 void bt_sock_reclassify_lock(struct sock *sk, int proto)
72 BUG_ON(!sock_allow_reclassification(sk));
74 sock_lock_init_class_and_name(sk,
75 bt_slock_key_strings[proto], &bt_slock_key[proto],
76 bt_key_strings[proto], &bt_lock_key[proto]);
78 EXPORT_SYMBOL(bt_sock_reclassify_lock);
80 int bt_sock_register(int proto, const struct net_proto_family *ops)
84 if (proto < 0 || proto >= BT_MAX_PROTO)
87 write_lock(&bt_proto_lock);
92 bt_proto[proto] = ops;
94 write_unlock(&bt_proto_lock);
98 EXPORT_SYMBOL(bt_sock_register);
100 void bt_sock_unregister(int proto)
102 if (proto < 0 || proto >= BT_MAX_PROTO)
105 write_lock(&bt_proto_lock);
106 bt_proto[proto] = NULL;
107 write_unlock(&bt_proto_lock);
109 EXPORT_SYMBOL(bt_sock_unregister);
111 static int bt_sock_create(struct net *net, struct socket *sock, int proto,
116 if (net != &init_net)
117 return -EAFNOSUPPORT;
119 if (proto < 0 || proto >= BT_MAX_PROTO)
122 if (!bt_proto[proto])
123 request_module("bt-proto-%d", proto);
125 err = -EPROTONOSUPPORT;
127 read_lock(&bt_proto_lock);
129 if (bt_proto[proto] && try_module_get(bt_proto[proto]->owner)) {
130 err = bt_proto[proto]->create(net, sock, proto, kern);
132 bt_sock_reclassify_lock(sock->sk, proto);
133 module_put(bt_proto[proto]->owner);
136 read_unlock(&bt_proto_lock);
141 void bt_sock_link(struct bt_sock_list *l, struct sock *sk)
143 write_lock(&l->lock);
144 sk_add_node(sk, &l->head);
145 write_unlock(&l->lock);
147 EXPORT_SYMBOL(bt_sock_link);
149 void bt_sock_unlink(struct bt_sock_list *l, struct sock *sk)
151 write_lock(&l->lock);
152 sk_del_node_init(sk);
153 write_unlock(&l->lock);
155 EXPORT_SYMBOL(bt_sock_unlink);
157 void bt_accept_enqueue(struct sock *parent, struct sock *sk)
159 BT_DBG("parent %p, sk %p", parent, sk);
163 list_add_tail(&bt_sk(sk)->accept_q, &bt_sk(parent)->accept_q);
164 bt_sk(sk)->parent = parent;
166 parent->sk_ack_backlog++;
168 EXPORT_SYMBOL(bt_accept_enqueue);
170 /* Calling function must hold the sk lock.
171 * bt_sk(sk)->parent must be non-NULL meaning sk is in the parent list.
173 void bt_accept_unlink(struct sock *sk)
175 BT_DBG("sk %p state %d", sk, sk->sk_state);
177 list_del_init(&bt_sk(sk)->accept_q);
178 bt_sk(sk)->parent->sk_ack_backlog--;
179 bt_sk(sk)->parent = NULL;
182 EXPORT_SYMBOL(bt_accept_unlink);
184 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock)
186 struct bt_sock *s, *n;
189 BT_DBG("parent %p", parent);
192 list_for_each_entry_safe(s, n, &bt_sk(parent)->accept_q, accept_q) {
193 sk = (struct sock *)s;
195 /* Prevent early freeing of sk due to unlink and sock_kill */
199 /* Check sk has not already been unlinked via
200 * bt_accept_unlink() due to serialisation caused by sk locking
202 if (!bt_sk(sk)->parent) {
203 BT_DBG("sk %p, already unlinked", sk);
207 /* Restart the loop as sk is no longer in the list
208 * and also avoid a potential infinite loop because
209 * list_for_each_entry_safe() is not thread safe.
214 /* sk is safely in the parent list so reduce reference count */
217 /* FIXME: Is this check still needed */
218 if (sk->sk_state == BT_CLOSED) {
219 bt_accept_unlink(sk);
224 if (sk->sk_state == BT_CONNECTED || !newsock ||
225 test_bit(BT_SK_DEFER_SETUP, &bt_sk(parent)->flags)) {
226 bt_accept_unlink(sk);
228 sock_graft(sk, newsock);
239 EXPORT_SYMBOL(bt_accept_dequeue);
241 int bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
244 int noblock = flags & MSG_DONTWAIT;
245 struct sock *sk = sock->sk;
251 BT_DBG("sock %p sk %p len %zu", sock, sk, len);
256 skb = skb_recv_datagram(sk, flags, noblock, &err);
258 if (sk->sk_shutdown & RCV_SHUTDOWN)
267 msg->msg_flags |= MSG_TRUNC;
271 skb_reset_transport_header(skb);
272 err = skb_copy_datagram_msg(skb, 0, msg, copied);
274 sock_recv_ts_and_drops(msg, sk, skb);
276 if (msg->msg_name && bt_sk(sk)->skb_msg_name)
277 bt_sk(sk)->skb_msg_name(skb, msg->msg_name,
281 skb_free_datagram(sk, skb);
283 if (flags & MSG_TRUNC)
286 return err ? : copied;
288 EXPORT_SYMBOL(bt_sock_recvmsg);
290 static long bt_sock_data_wait(struct sock *sk, long timeo)
292 DECLARE_WAITQUEUE(wait, current);
294 add_wait_queue(sk_sleep(sk), &wait);
296 set_current_state(TASK_INTERRUPTIBLE);
298 if (!skb_queue_empty(&sk->sk_receive_queue))
301 if (sk->sk_err || (sk->sk_shutdown & RCV_SHUTDOWN))
304 if (signal_pending(current) || !timeo)
307 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
309 timeo = schedule_timeout(timeo);
311 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
314 __set_current_state(TASK_RUNNING);
315 remove_wait_queue(sk_sleep(sk), &wait);
319 int bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
320 size_t size, int flags)
322 struct sock *sk = sock->sk;
324 size_t target, copied = 0;
330 BT_DBG("sk %p size %zu", sk, size);
334 target = sock_rcvlowat(sk, flags & MSG_WAITALL, size);
335 timeo = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
341 skb = skb_dequeue(&sk->sk_receive_queue);
343 if (copied >= target)
346 err = sock_error(sk);
349 if (sk->sk_shutdown & RCV_SHUTDOWN)
356 timeo = bt_sock_data_wait(sk, timeo);
358 if (signal_pending(current)) {
359 err = sock_intr_errno(timeo);
365 chunk = min_t(unsigned int, skb->len, size);
366 if (skb_copy_datagram_msg(skb, 0, msg, chunk)) {
367 skb_queue_head(&sk->sk_receive_queue, skb);
375 sock_recv_ts_and_drops(msg, sk, skb);
377 if (!(flags & MSG_PEEK)) {
378 int skb_len = skb_headlen(skb);
380 if (chunk <= skb_len) {
381 __skb_pull(skb, chunk);
383 struct sk_buff *frag;
385 __skb_pull(skb, skb_len);
388 skb_walk_frags(skb, frag) {
389 if (chunk <= frag->len) {
390 /* Pulling partial data */
392 skb->data_len -= chunk;
393 __skb_pull(frag, chunk);
395 } else if (frag->len) {
396 /* Pulling all frag data */
398 skb->len -= frag->len;
399 skb->data_len -= frag->len;
400 __skb_pull(frag, frag->len);
406 skb_queue_head(&sk->sk_receive_queue, skb);
412 /* put message back and return */
413 skb_queue_head(&sk->sk_receive_queue, skb);
420 return copied ? : err;
422 EXPORT_SYMBOL(bt_sock_stream_recvmsg);
424 static inline __poll_t bt_accept_poll(struct sock *parent)
426 struct bt_sock *s, *n;
429 list_for_each_entry_safe(s, n, &bt_sk(parent)->accept_q, accept_q) {
430 sk = (struct sock *)s;
431 if (sk->sk_state == BT_CONNECTED ||
432 (test_bit(BT_SK_DEFER_SETUP, &bt_sk(parent)->flags) &&
433 sk->sk_state == BT_CONNECT2))
434 return EPOLLIN | EPOLLRDNORM;
440 __poll_t bt_sock_poll_mask(struct socket *sock, __poll_t events)
442 struct sock *sk = sock->sk;
445 BT_DBG("sock %p, sk %p", sock, sk);
447 if (sk->sk_state == BT_LISTEN)
448 return bt_accept_poll(sk);
450 if (sk->sk_err || !skb_queue_empty(&sk->sk_error_queue))
452 (sock_flag(sk, SOCK_SELECT_ERR_QUEUE) ? EPOLLPRI : 0);
454 if (sk->sk_shutdown & RCV_SHUTDOWN)
455 mask |= EPOLLRDHUP | EPOLLIN | EPOLLRDNORM;
457 if (sk->sk_shutdown == SHUTDOWN_MASK)
460 if (!skb_queue_empty(&sk->sk_receive_queue))
461 mask |= EPOLLIN | EPOLLRDNORM;
463 if (sk->sk_state == BT_CLOSED)
466 if (sk->sk_state == BT_CONNECT ||
467 sk->sk_state == BT_CONNECT2 ||
468 sk->sk_state == BT_CONFIG)
471 if (!test_bit(BT_SK_SUSPEND, &bt_sk(sk)->flags) && sock_writeable(sk))
472 mask |= EPOLLOUT | EPOLLWRNORM | EPOLLWRBAND;
474 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
478 EXPORT_SYMBOL(bt_sock_poll_mask);
480 int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
482 struct sock *sk = sock->sk;
487 BT_DBG("sk %p cmd %x arg %lx", sk, cmd, arg);
491 if (sk->sk_state == BT_LISTEN)
494 amount = sk->sk_sndbuf - sk_wmem_alloc_get(sk);
497 err = put_user(amount, (int __user *) arg);
501 if (sk->sk_state == BT_LISTEN)
505 skb = skb_peek(&sk->sk_receive_queue);
506 amount = skb ? skb->len : 0;
508 err = put_user(amount, (int __user *) arg);
512 err = sock_get_timestamp(sk, (struct timeval __user *) arg);
516 err = sock_get_timestampns(sk, (struct timespec __user *) arg);
526 EXPORT_SYMBOL(bt_sock_ioctl);
528 /* This function expects the sk lock to be held when called */
529 int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo)
531 DECLARE_WAITQUEUE(wait, current);
536 add_wait_queue(sk_sleep(sk), &wait);
537 set_current_state(TASK_INTERRUPTIBLE);
538 while (sk->sk_state != state) {
544 if (signal_pending(current)) {
545 err = sock_intr_errno(timeo);
550 timeo = schedule_timeout(timeo);
552 set_current_state(TASK_INTERRUPTIBLE);
554 err = sock_error(sk);
558 __set_current_state(TASK_RUNNING);
559 remove_wait_queue(sk_sleep(sk), &wait);
562 EXPORT_SYMBOL(bt_sock_wait_state);
564 /* This function expects the sk lock to be held when called */
565 int bt_sock_wait_ready(struct sock *sk, unsigned long flags)
567 DECLARE_WAITQUEUE(wait, current);
573 timeo = sock_sndtimeo(sk, flags & O_NONBLOCK);
575 add_wait_queue(sk_sleep(sk), &wait);
576 set_current_state(TASK_INTERRUPTIBLE);
577 while (test_bit(BT_SK_SUSPEND, &bt_sk(sk)->flags)) {
583 if (signal_pending(current)) {
584 err = sock_intr_errno(timeo);
589 timeo = schedule_timeout(timeo);
591 set_current_state(TASK_INTERRUPTIBLE);
593 err = sock_error(sk);
597 __set_current_state(TASK_RUNNING);
598 remove_wait_queue(sk_sleep(sk), &wait);
602 EXPORT_SYMBOL(bt_sock_wait_ready);
604 #ifdef CONFIG_PROC_FS
605 static void *bt_seq_start(struct seq_file *seq, loff_t *pos)
606 __acquires(seq->private->l->lock)
608 struct bt_sock_list *l = PDE_DATA(file_inode(seq->file));
611 return seq_hlist_start_head(&l->head, *pos);
614 static void *bt_seq_next(struct seq_file *seq, void *v, loff_t *pos)
616 struct bt_sock_list *l = PDE_DATA(file_inode(seq->file));
618 return seq_hlist_next(v, &l->head, pos);
621 static void bt_seq_stop(struct seq_file *seq, void *v)
622 __releases(seq->private->l->lock)
624 struct bt_sock_list *l = PDE_DATA(file_inode(seq->file));
626 read_unlock(&l->lock);
629 static int bt_seq_show(struct seq_file *seq, void *v)
631 struct bt_sock_list *l = PDE_DATA(file_inode(seq->file));
633 if (v == SEQ_START_TOKEN) {
634 seq_puts(seq ,"sk RefCnt Rmem Wmem User Inode Parent");
636 if (l->custom_seq_show) {
638 l->custom_seq_show(seq, v);
643 struct sock *sk = sk_entry(v);
644 struct bt_sock *bt = bt_sk(sk);
647 "%pK %-6d %-6u %-6u %-6u %-6lu %-6lu",
649 refcount_read(&sk->sk_refcnt),
650 sk_rmem_alloc_get(sk),
651 sk_wmem_alloc_get(sk),
652 from_kuid(seq_user_ns(seq), sock_i_uid(sk)),
654 bt->parent? sock_i_ino(bt->parent): 0LU);
656 if (l->custom_seq_show) {
658 l->custom_seq_show(seq, v);
666 static const struct seq_operations bt_seq_ops = {
667 .start = bt_seq_start,
673 int bt_procfs_init(struct net *net, const char *name,
674 struct bt_sock_list *sk_list,
675 int (* seq_show)(struct seq_file *, void *))
677 sk_list->custom_seq_show = seq_show;
679 if (!proc_create_seq_data(name, 0, net->proc_net, &bt_seq_ops, sk_list))
684 void bt_procfs_cleanup(struct net *net, const char *name)
686 remove_proc_entry(name, net->proc_net);
689 int bt_procfs_init(struct net *net, const char *name,
690 struct bt_sock_list *sk_list,
691 int (* seq_show)(struct seq_file *, void *))
696 void bt_procfs_cleanup(struct net *net, const char *name)
700 EXPORT_SYMBOL(bt_procfs_init);
701 EXPORT_SYMBOL(bt_procfs_cleanup);
703 static const struct net_proto_family bt_sock_family_ops = {
704 .owner = THIS_MODULE,
705 .family = PF_BLUETOOTH,
706 .create = bt_sock_create,
709 struct dentry *bt_debugfs;
710 EXPORT_SYMBOL_GPL(bt_debugfs);
712 #define VERSION __stringify(BT_SUBSYS_VERSION) "." \
713 __stringify(BT_SUBSYS_REVISION)
715 static int __init bt_init(void)
719 sock_skb_cb_check_size(sizeof(struct bt_skb_cb));
721 BT_INFO("Core ver %s", VERSION);
727 bt_debugfs = debugfs_create_dir("bluetooth", NULL);
731 err = bt_sysfs_init();
735 err = sock_register(&bt_sock_family_ops);
739 BT_INFO("HCI device and connection manager initialized");
741 err = hci_sock_init();
743 goto unregister_socket;
766 sock_unregister(PF_BLUETOOTH);
772 static void __exit bt_exit(void)
782 sock_unregister(PF_BLUETOOTH);
788 debugfs_remove_recursive(bt_debugfs);
791 subsys_initcall(bt_init);
792 module_exit(bt_exit);
794 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
795 MODULE_DESCRIPTION("Bluetooth Core ver " VERSION);
796 MODULE_VERSION(VERSION);
797 MODULE_LICENSE("GPL");
798 MODULE_ALIAS_NETPROTO(PF_BLUETOOTH);