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 unsigned int 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 POLLIN | POLLRDNORM;
440 unsigned int bt_sock_poll(struct file *file, struct socket *sock,
443 struct sock *sk = sock->sk;
444 unsigned int mask = 0;
446 BT_DBG("sock %p, sk %p", sock, sk);
448 poll_wait(file, sk_sleep(sk), wait);
450 if (sk->sk_state == BT_LISTEN)
451 return bt_accept_poll(sk);
453 if (sk->sk_err || !skb_queue_empty(&sk->sk_error_queue))
455 (sock_flag(sk, SOCK_SELECT_ERR_QUEUE) ? POLLPRI : 0);
457 if (sk->sk_shutdown & RCV_SHUTDOWN)
458 mask |= POLLRDHUP | POLLIN | POLLRDNORM;
460 if (sk->sk_shutdown == SHUTDOWN_MASK)
463 if (!skb_queue_empty(&sk->sk_receive_queue))
464 mask |= POLLIN | POLLRDNORM;
466 if (sk->sk_state == BT_CLOSED)
469 if (sk->sk_state == BT_CONNECT ||
470 sk->sk_state == BT_CONNECT2 ||
471 sk->sk_state == BT_CONFIG)
474 if (!test_bit(BT_SK_SUSPEND, &bt_sk(sk)->flags) && sock_writeable(sk))
475 mask |= POLLOUT | POLLWRNORM | POLLWRBAND;
477 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
481 EXPORT_SYMBOL(bt_sock_poll);
483 int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
485 struct sock *sk = sock->sk;
490 BT_DBG("sk %p cmd %x arg %lx", sk, cmd, arg);
494 if (sk->sk_state == BT_LISTEN)
497 amount = sk->sk_sndbuf - sk_wmem_alloc_get(sk);
500 err = put_user(amount, (int __user *) arg);
504 if (sk->sk_state == BT_LISTEN)
508 skb = skb_peek(&sk->sk_receive_queue);
509 amount = skb ? skb->len : 0;
511 err = put_user(amount, (int __user *) arg);
515 err = sock_get_timestamp(sk, (struct timeval __user *) arg);
519 err = sock_get_timestampns(sk, (struct timespec __user *) arg);
529 EXPORT_SYMBOL(bt_sock_ioctl);
531 /* This function expects the sk lock to be held when called */
532 int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo)
534 DECLARE_WAITQUEUE(wait, current);
539 add_wait_queue(sk_sleep(sk), &wait);
540 set_current_state(TASK_INTERRUPTIBLE);
541 while (sk->sk_state != state) {
547 if (signal_pending(current)) {
548 err = sock_intr_errno(timeo);
553 timeo = schedule_timeout(timeo);
555 set_current_state(TASK_INTERRUPTIBLE);
557 err = sock_error(sk);
561 __set_current_state(TASK_RUNNING);
562 remove_wait_queue(sk_sleep(sk), &wait);
565 EXPORT_SYMBOL(bt_sock_wait_state);
567 /* This function expects the sk lock to be held when called */
568 int bt_sock_wait_ready(struct sock *sk, unsigned long flags)
570 DECLARE_WAITQUEUE(wait, current);
576 timeo = sock_sndtimeo(sk, flags & O_NONBLOCK);
578 add_wait_queue(sk_sleep(sk), &wait);
579 set_current_state(TASK_INTERRUPTIBLE);
580 while (test_bit(BT_SK_SUSPEND, &bt_sk(sk)->flags)) {
586 if (signal_pending(current)) {
587 err = sock_intr_errno(timeo);
592 timeo = schedule_timeout(timeo);
594 set_current_state(TASK_INTERRUPTIBLE);
596 err = sock_error(sk);
600 __set_current_state(TASK_RUNNING);
601 remove_wait_queue(sk_sleep(sk), &wait);
605 EXPORT_SYMBOL(bt_sock_wait_ready);
607 #ifdef CONFIG_PROC_FS
608 struct bt_seq_state {
609 struct bt_sock_list *l;
612 static void *bt_seq_start(struct seq_file *seq, loff_t *pos)
613 __acquires(seq->private->l->lock)
615 struct bt_seq_state *s = seq->private;
616 struct bt_sock_list *l = s->l;
619 return seq_hlist_start_head(&l->head, *pos);
622 static void *bt_seq_next(struct seq_file *seq, void *v, loff_t *pos)
624 struct bt_seq_state *s = seq->private;
625 struct bt_sock_list *l = s->l;
627 return seq_hlist_next(v, &l->head, pos);
630 static void bt_seq_stop(struct seq_file *seq, void *v)
631 __releases(seq->private->l->lock)
633 struct bt_seq_state *s = seq->private;
634 struct bt_sock_list *l = s->l;
636 read_unlock(&l->lock);
639 static int bt_seq_show(struct seq_file *seq, void *v)
641 struct bt_seq_state *s = seq->private;
642 struct bt_sock_list *l = s->l;
644 if (v == SEQ_START_TOKEN) {
645 seq_puts(seq ,"sk RefCnt Rmem Wmem User Inode Parent");
647 if (l->custom_seq_show) {
649 l->custom_seq_show(seq, v);
654 struct sock *sk = sk_entry(v);
655 struct bt_sock *bt = bt_sk(sk);
658 "%pK %-6d %-6u %-6u %-6u %-6lu %-6lu",
660 refcount_read(&sk->sk_refcnt),
661 sk_rmem_alloc_get(sk),
662 sk_wmem_alloc_get(sk),
663 from_kuid(seq_user_ns(seq), sock_i_uid(sk)),
665 bt->parent? sock_i_ino(bt->parent): 0LU);
667 if (l->custom_seq_show) {
669 l->custom_seq_show(seq, v);
677 static const struct seq_operations bt_seq_ops = {
678 .start = bt_seq_start,
684 static int bt_seq_open(struct inode *inode, struct file *file)
686 struct bt_sock_list *sk_list;
687 struct bt_seq_state *s;
689 sk_list = PDE_DATA(inode);
690 s = __seq_open_private(file, &bt_seq_ops,
691 sizeof(struct bt_seq_state));
699 static const struct file_operations bt_fops = {
703 .release = seq_release_private
706 int bt_procfs_init(struct net *net, const char *name,
707 struct bt_sock_list *sk_list,
708 int (* seq_show)(struct seq_file *, void *))
710 sk_list->custom_seq_show = seq_show;
712 if (!proc_create_data(name, 0, net->proc_net, &bt_fops, sk_list))
717 void bt_procfs_cleanup(struct net *net, const char *name)
719 remove_proc_entry(name, net->proc_net);
722 int bt_procfs_init(struct net *net, const char *name,
723 struct bt_sock_list *sk_list,
724 int (* seq_show)(struct seq_file *, void *))
729 void bt_procfs_cleanup(struct net *net, const char *name)
733 EXPORT_SYMBOL(bt_procfs_init);
734 EXPORT_SYMBOL(bt_procfs_cleanup);
736 static const struct net_proto_family bt_sock_family_ops = {
737 .owner = THIS_MODULE,
738 .family = PF_BLUETOOTH,
739 .create = bt_sock_create,
742 struct dentry *bt_debugfs;
743 EXPORT_SYMBOL_GPL(bt_debugfs);
745 #define VERSION __stringify(BT_SUBSYS_VERSION) "." \
746 __stringify(BT_SUBSYS_REVISION)
748 static int __init bt_init(void)
752 sock_skb_cb_check_size(sizeof(struct bt_skb_cb));
754 BT_INFO("Core ver %s", VERSION);
760 bt_debugfs = debugfs_create_dir("bluetooth", NULL);
764 err = bt_sysfs_init();
768 err = sock_register(&bt_sock_family_ops);
774 BT_INFO("HCI device and connection manager initialized");
776 err = hci_sock_init();
803 sock_unregister(PF_BLUETOOTH);
809 static void __exit bt_exit(void)
819 sock_unregister(PF_BLUETOOTH);
825 debugfs_remove_recursive(bt_debugfs);
828 subsys_initcall(bt_init);
829 module_exit(bt_exit);
831 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
832 MODULE_DESCRIPTION("Bluetooth Core ver " VERSION);
833 MODULE_VERSION(VERSION);
834 MODULE_LICENSE("GPL");
835 MODULE_ALIAS_NETPROTO(PF_BLUETOOTH);