2 * raw.c - Raw sockets for protocol family CAN
4 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, the following disclaimer and
12 * the referenced file 'COPYING'.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of Volkswagen nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * Alternatively, provided that this notice is retained in full, this
21 * software may be distributed under the terms of the GNU General
22 * Public License ("GPL") version 2 as distributed in the 'COPYING'
23 * file from the main directory of the linux kernel source.
25 * The provided data structures and external interfaces from this code
26 * are not restricted to be used by modules with a GPL compatible license.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
41 * Send feedback to <socketcan-users@lists.berlios.de>
45 #include <linux/module.h>
46 #include <linux/version.h>
47 #include <linux/init.h>
48 #include <linux/net.h>
49 #include <linux/netdevice.h>
50 #include <linux/uio.h>
51 #include <linux/poll.h>
52 #include <linux/can.h>
53 #include <linux/can/core.h>
54 #include <linux/can/raw.h>
57 #include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
61 #define CAN_RAW_VERSION CAN_VERSION
62 static __initdata const char banner[] =
63 KERN_INFO "can: raw protocol # rev " CAN_RAW_VERSION "\n";
65 MODULE_DESCRIPTION("PF_CAN raw protocol");
66 MODULE_LICENSE("Dual BSD/GPL");
67 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>");
69 #ifdef CONFIG_CAN_DEBUG_CORE
71 module_param(debug, int, S_IRUGO);
72 MODULE_PARM_DESC(debug, "debug print mask: 1:debug, 2:frames, 4:skbs");
75 #ifdef CONFIG_CAN_RAW_USER
78 #define RAW_CAP CAP_NET_RAW
84 * A raw socket has a list of can_filters attached to it, each receiving
85 * the CAN frames matching that filter. If the filter list is empty,
86 * no CAN frames will be received by the socket. The default after
87 * opening the socket, is to have one filter which receives all frames.
88 * The filter list is allocated dynamically with the exception of the
89 * list containing only one item. This common case is optimized by
90 * storing the single filter in dfilter, to avoid using dynamic memory.
98 int count; /* number of active filters */
99 struct can_filter dfilter; /* default/single filter */
100 struct can_filter *filter; /* pointer to filter(s) */
101 can_err_mask_t err_mask;
105 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
111 static inline struct raw_opt *raw_sk(const struct sock *sk)
113 return &((struct raw_sock *)sk)->opt;
116 static inline struct raw_opt *raw_sk(const struct sock *sk)
118 return (struct raw_opt *)sk->sk_protinfo;
122 static void raw_notifier(unsigned long msg, void *data)
124 struct sock *sk = (struct sock *)data;
125 struct raw_opt *ro = raw_sk(sk);
127 DBG("called for sock %p\n", sk);
131 case NETDEV_UNREGISTER:
132 spin_lock(&ro->lock);
135 spin_unlock(&ro->lock);
138 sk->sk_err = ENETDOWN;
139 if (!sock_flag(sk, SOCK_DEAD))
140 sk->sk_error_report(sk);
145 static void raw_rcv(struct sk_buff *skb, void *data)
147 struct sock *sk = (struct sock*)data;
148 struct raw_opt *ro = raw_sk(sk);
149 struct sockaddr_can *addr;
152 DBG("received skbuff %p, sk %p\n", skb, sk);
155 if (!ro->recv_own_msgs) {
156 /* check the received tx sock reference */
157 if (*(struct sock **)skb->cb == sk) {
158 DBG("trashed own tx msg\n");
164 addr = (struct sockaddr_can *)skb->cb;
165 memset(addr, 0, sizeof(*addr));
166 addr->can_family = AF_CAN;
167 addr->can_ifindex = skb->dev->ifindex;
169 error = sock_queue_rcv_skb(sk, skb);
171 DBG("sock_queue_rcv_skb failed: %d\n", error);
172 DBG("freeing skbuff %p\n", skb);
177 static void raw_add_filters(struct net_device *dev, struct sock *sk)
179 struct raw_opt *ro = raw_sk(sk);
180 struct can_filter *filter = ro->filter;
183 for (i = 0; i < ro->count; i++) {
184 can_rx_register(dev, filter[i].can_id, filter[i].can_mask,
186 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
187 filter[i].can_id, filter[i].can_mask,
188 filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
192 static void raw_remove_filters(struct net_device *dev, struct sock *sk)
194 struct raw_opt *ro = raw_sk(sk);
195 struct can_filter *filter = ro->filter;
198 for (i = 0; i < ro->count; i++) {
199 can_rx_unregister(dev, filter[i].can_id, filter[i].can_mask,
201 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
202 filter[i].can_id, filter[i].can_mask,
203 filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
207 static int raw_init(struct sock *sk)
209 struct raw_opt *ro = raw_sk(sk);
213 /* set default filter to single entry dfilter */
214 ro->dfilter.can_id = 0;
215 ro->dfilter.can_mask = MASK_ALL;
216 ro->filter = &ro->dfilter;
219 /* set default loopback behaviour */
221 ro->recv_own_msgs = 0;
223 spin_lock_init(&ro->lock);
228 static int raw_release(struct socket *sock)
230 struct sock *sk = sock->sk;
231 struct raw_opt *ro = raw_sk(sk);
232 struct net_device *dev = NULL;
234 DBG("socket %p, sk %p, refcnt %d\n", sock, sk,
235 atomic_read(&sk->sk_refcnt));
237 spin_lock(&ro->lock);
238 if (ro->bound && ro->ifindex)
239 dev = dev_get_by_index(ro->ifindex);
240 spin_unlock(&ro->lock);
242 /* remove current filters & unregister */
244 raw_remove_filters(dev, sk);
249 /* remove current error mask */
250 if (ro->err_mask && ro->bound)
251 can_rx_unregister(dev, 0, ro->err_mask | CAN_ERR_FLAG,
255 can_dev_unregister(dev, raw_notifier, sk);
264 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
266 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
267 struct sock *sk = sock->sk;
268 struct raw_opt *ro = raw_sk(sk);
269 struct net_device *dev;
272 DBG("socket %p to device %d\n", sock, addr->can_ifindex);
274 if (len < sizeof(*addr))
278 spin_lock(&ro->lock);
281 /* remove current bindings / notifier */
283 dev = dev_get_by_index(ro->ifindex);
285 DBG("could not find device %d\n",
290 if (!(dev->flags & IFF_UP)) {
291 sk->sk_err = ENETDOWN;
292 if (!sock_flag(sk, SOCK_DEAD))
293 sk->sk_error_report(sk);
296 can_dev_unregister(dev, raw_notifier, sk);
300 /* unregister current filters for this device */
301 raw_remove_filters(dev, sk);
309 if (addr->can_ifindex) {
310 dev = dev_get_by_index(addr->can_ifindex);
312 DBG("could not find device %d\n", addr->can_ifindex);
316 if (!(dev->flags & IFF_UP)) {
317 sk->sk_err = ENETDOWN;
318 if (!sock_flag(sk, SOCK_DEAD))
319 sk->sk_error_report(sk);
322 can_dev_register(dev, raw_notifier, sk);
326 ro->ifindex = addr->can_ifindex;
328 /* filters set by default/setsockopt */
329 raw_add_filters(dev, sk);
331 /* error frame filter set by setsockopt */
333 can_rx_register(dev, 0, ro->err_mask | CAN_ERR_FLAG,
339 spin_unlock(&ro->lock);
348 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
351 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
352 struct sock *sk = sock->sk;
353 struct raw_opt *ro = raw_sk(sk);
358 addr->can_family = AF_CAN;
359 addr->can_ifindex = ro->ifindex;
360 *len = sizeof(*addr);
365 static unsigned int raw_poll(struct file *file, struct socket *sock,
368 unsigned int mask = 0;
370 DBG("socket %p\n", sock);
372 mask = datagram_poll(file, sock, wait);
376 static int raw_setsockopt(struct socket *sock, int level, int optname,
377 char __user *optval, int optlen)
379 struct sock *sk = sock->sk;
380 struct raw_opt *ro = raw_sk(sk);
381 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
382 struct can_filter sfilter; /* single filter */
383 struct net_device *dev = NULL;
384 can_err_mask_t err_mask = 0;
388 if (level != SOL_CAN_RAW)
396 if (optlen % sizeof(struct can_filter) != 0)
399 count = optlen / sizeof(struct can_filter);
402 /* filter does not fit into dfilter => alloc space */
403 filter = kmalloc(optlen, GFP_KERNEL);
407 err = copy_from_user(filter, optval, optlen);
412 } else if (count == 1) {
413 err = copy_from_user(&sfilter, optval, optlen);
420 spin_lock(&ro->lock);
421 if (ro->bound && ro->ifindex)
422 dev = dev_get_by_index(ro->ifindex);
423 spin_unlock(&ro->lock);
425 /* remove current filters & unregister */
427 raw_remove_filters(dev, sk);
433 /* copy filter data for single filter */
434 ro->dfilter = sfilter;
435 filter = &ro->dfilter;
438 /* add new filters & register */
442 raw_add_filters(dev, sk);
451 case CAN_RAW_ERR_FILTER:
452 if (optlen != sizeof(err_mask))
455 err = copy_from_user(&err_mask, optval, optlen);
459 err_mask &= CAN_ERR_MASK;
461 if (ro->bound && ro->ifindex)
462 dev = dev_get_by_index(ro->ifindex);
464 /* remove current error mask */
465 if (ro->err_mask && ro->bound)
466 can_rx_unregister(dev, 0, ro->err_mask | CAN_ERR_FLAG,
469 /* add new error mask */
470 ro->err_mask = err_mask;
471 if (ro->err_mask && ro->bound)
472 can_rx_register(dev, 0, ro->err_mask | CAN_ERR_FLAG,
480 case CAN_RAW_LOOPBACK:
481 if (optlen != sizeof(ro->loopback))
484 err = copy_from_user(&ro->loopback, optval, optlen);
490 case CAN_RAW_RECV_OWN_MSGS:
491 if (optlen != sizeof(ro->recv_own_msgs))
494 err = copy_from_user(&ro->recv_own_msgs, optval, optlen);
506 static int raw_getsockopt(struct socket *sock, int level, int optname,
507 char __user *optval, int __user *optlen)
509 struct sock *sk = sock->sk;
510 struct raw_opt *ro = raw_sk(sk);
511 struct can_filter *filter = ro->filter;
512 int count = ro->count;
516 if (level != SOL_CAN_RAW)
518 if (get_user(len, optlen))
526 if (count && filter) {
527 int filter_size = count * sizeof(struct can_filter);
528 if (len > filter_size)
535 case CAN_RAW_ERR_FILTER:
536 if (len > sizeof(can_err_mask_t))
537 len = sizeof(can_err_mask_t);
541 case CAN_RAW_LOOPBACK:
542 if (len > sizeof(int))
547 case CAN_RAW_RECV_OWN_MSGS:
548 if (len > sizeof(int))
550 val = &ro->recv_own_msgs;
557 if (put_user(len, optlen))
559 if (copy_to_user(optval, val, len))
564 static int raw_sendmsg(struct kiocb *iocb, struct socket *sock,
565 struct msghdr *msg, size_t size)
567 struct sock *sk = sock->sk;
568 struct raw_opt *ro = raw_sk(sk);
570 struct net_device *dev;
574 DBG("socket %p, sk %p\n", sock, sk);
577 struct sockaddr_can *addr =
578 (struct sockaddr_can *)msg->msg_name;
580 if (addr->can_family != AF_CAN)
583 ifindex = addr->can_ifindex;
585 ifindex = ro->ifindex;
587 dev = dev_get_by_index(ifindex);
589 DBG("device %d not found\n", ifindex);
593 skb = alloc_skb(size, GFP_KERNEL);
599 err = memcpy_fromiovec(skb_put(skb, size), msg->msg_iov, size);
608 DBG("sending skbuff to interface %d\n", ifindex);
611 err = can_send(skb, ro->loopback);
621 static int raw_recvmsg(struct kiocb *iocb, struct socket *sock,
622 struct msghdr *msg, size_t size, int flags)
624 struct sock *sk = sock->sk;
629 DBG("socket %p, sk %p\n", sock, sk);
631 noblock = flags & MSG_DONTWAIT;
632 flags &= ~MSG_DONTWAIT;
634 skb = skb_recv_datagram(sk, flags, noblock, &error);
638 DBG("delivering skbuff %p\n", skb);
642 msg->msg_flags |= MSG_TRUNC;
646 error = memcpy_toiovec(msg->msg_iov, skb->data, size);
648 skb_free_datagram(sk, skb);
652 sock_recv_timestamp(msg, sk, skb);
655 msg->msg_namelen = sizeof(struct sockaddr_can);
656 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
659 DBG("freeing sock %p, skbuff %p\n", sk, skb);
660 skb_free_datagram(sk, skb);
665 static struct proto_ops raw_ops = {
667 .release = raw_release,
669 .connect = sock_no_connect,
670 .socketpair = sock_no_socketpair,
671 .accept = sock_no_accept,
672 .getname = raw_getname,
674 .ioctl = NULL, /* use can_ioctl() from af_can.c */
675 .listen = sock_no_listen,
676 .shutdown = sock_no_shutdown,
677 .setsockopt = raw_setsockopt,
678 .getsockopt = raw_getsockopt,
679 .sendmsg = raw_sendmsg,
680 .recvmsg = raw_recvmsg,
681 .mmap = sock_no_mmap,
682 .sendpage = sock_no_sendpage,
685 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
686 static struct proto raw_proto = {
688 .owner = THIS_MODULE,
689 .obj_size = sizeof(struct raw_sock),
693 static struct can_proto raw_can_proto = {
696 .capability = RAW_CAP,
701 static struct can_proto raw_can_proto = {
704 .capability = RAW_CAP,
706 .owner = THIS_MODULE,
707 .obj_size = sizeof(struct raw_opt),
712 static __init int raw_module_init(void)
716 can_proto_register(&raw_can_proto);
720 static __exit void raw_module_exit(void)
722 can_proto_unregister(&raw_can_proto);
725 module_init(raw_module_init);
726 module_exit(raw_module_exit);