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 and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of Volkswagen nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * Alternatively, provided that this notice is retained in full, this
20 * software may be distributed under the terms of the GNU General
21 * Public License ("GPL") version 2, in which case the provisions of the
22 * GPL apply INSTEAD OF those given above.
24 * The provided data structures and external interfaces from this code
25 * are not restricted to be used by modules with a GPL compatible license.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
40 * Send feedback to <socketcan-users@lists.berlios.de>
44 #include <linux/module.h>
45 #include <linux/version.h>
46 #include <linux/init.h>
47 #include <linux/uio.h>
48 #include <linux/net.h>
49 #include <linux/netdevice.h>
50 #include <linux/socket.h>
51 #include <linux/if_arp.h>
52 #include <linux/skbuff.h>
53 #include <linux/can.h>
54 #include <linux/can/core.h>
55 #include <linux/can/raw.h>
57 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
58 #include <net/net_namespace.h>
61 #include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
64 #define CAN_RAW_VERSION CAN_VERSION
65 static __initdata const char banner[] =
66 KERN_INFO "can: raw protocol (rev " CAN_RAW_VERSION ")\n";
68 MODULE_DESCRIPTION("PF_CAN raw protocol");
69 MODULE_LICENSE("Dual BSD/GPL");
70 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>");
72 #ifdef CONFIG_CAN_DEBUG_CORE
73 #define DBG_PREFIX "can-raw"
74 #define DBG_VAR raw_debug
76 module_param_named(debug, raw_debug, int, S_IRUGO);
77 MODULE_PARM_DESC(debug, "debug print mask: 1:debug, 2:frames, 4:skbs");
83 * A raw socket has a list of can_filters attached to it, each receiving
84 * the CAN frames matching that filter. If the filter list is empty,
85 * no CAN frames will be received by the socket. The default after
86 * opening the socket, is to have one filter which receives all frames.
87 * The filter list is allocated dynamically with the exception of the
88 * list containing only one item. This common case is optimized by
89 * storing the single filter in dfilter, to avoid using dynamic memory.
93 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
100 struct notifier_block notifier;
103 int count; /* number of active filters */
104 struct can_filter dfilter; /* default/single filter */
105 struct can_filter *filter; /* pointer to filter(s) */
106 can_err_mask_t err_mask;
109 static inline struct raw_sock *raw_sk(const struct sock *sk)
111 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
112 return (struct raw_sock *)sk;
114 return (struct raw_sock *)sk->sk_protinfo;
118 static void raw_rcv(struct sk_buff *skb, void *data)
120 struct sock *sk = (struct sock *)data;
121 struct raw_sock *ro = raw_sk(sk);
122 struct sockaddr_can *addr;
125 DBG("received skbuff %p, sk %p\n", skb, sk);
128 if (!ro->recv_own_msgs) {
129 /* check the received tx sock reference */
131 DBG("trashed own tx msg\n");
138 * Put the datagram to the queue so that raw_recvmsg() can
139 * get it from there. We need to pass the interface index to
140 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
141 * containing the interface index.
144 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
145 addr = (struct sockaddr_can *)skb->cb;
146 memset(addr, 0, sizeof(*addr));
147 addr->can_family = AF_CAN;
148 addr->can_ifindex = skb->dev->ifindex;
150 error = sock_queue_rcv_skb(sk, skb);
152 DBG("sock_queue_rcv_skb failed: %d\n", error);
153 DBG("freeing skbuff %p\n", skb);
158 static int raw_enable_filters(struct net_device *dev, struct sock *sk,
159 struct can_filter *filter,
165 for (i = 0; i < count; i++) {
166 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
167 filter[i].can_id, filter[i].can_mask,
168 filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
170 err = can_rx_register(dev, filter[i].can_id,
175 /* clean up successfully registered filters */
177 can_rx_unregister(dev, filter[i].can_id,
187 static int raw_enable_errfilter(struct net_device *dev, struct sock *sk,
188 can_err_mask_t err_mask)
193 err = can_rx_register(dev, 0, err_mask | CAN_ERR_FLAG,
199 static void raw_disable_filters(struct net_device *dev, struct sock *sk,
200 struct can_filter *filter,
205 for (i = 0; i < count; i++) {
206 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
207 filter[i].can_id, filter[i].can_mask,
208 filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
210 can_rx_unregister(dev, filter[i].can_id, filter[i].can_mask,
215 static inline void raw_disable_errfilter(struct net_device *dev,
217 can_err_mask_t err_mask)
221 can_rx_unregister(dev, 0, err_mask | CAN_ERR_FLAG,
225 static inline void raw_disable_allfilters(struct net_device *dev,
228 struct raw_sock *ro = raw_sk(sk);
230 raw_disable_filters(dev, sk, ro->filter, ro->count);
231 raw_disable_errfilter(dev, sk, ro->err_mask);
234 static int raw_enable_allfilters(struct net_device *dev, struct sock *sk)
236 struct raw_sock *ro = raw_sk(sk);
239 err = raw_enable_filters(dev, sk, ro->filter, ro->count);
241 err = raw_enable_errfilter(dev, sk, ro->err_mask);
243 raw_disable_filters(dev, sk, ro->filter, ro->count);
249 static int raw_notifier(struct notifier_block *nb,
250 unsigned long msg, void *data)
252 struct net_device *dev = (struct net_device *)data;
253 struct raw_sock *ro = container_of(nb, struct raw_sock, notifier);
254 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
255 struct sock *sk = &ro->sk;
257 struct sock *sk = ro->sk;
260 DBG("msg %ld for dev %p (%s idx %d) sk %p ro->ifindex %d\n",
261 msg, dev, dev->name, dev->ifindex, sk, ro->ifindex);
263 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
264 if (dev->nd_net != &init_net)
268 if (dev->type != ARPHRD_CAN)
271 if (ro->ifindex != dev->ifindex)
276 case NETDEV_UNREGISTER:
278 /* remove current filters & unregister */
280 raw_disable_allfilters(dev, sk);
291 if (!sock_flag(sk, SOCK_DEAD))
292 sk->sk_error_report(sk);
296 sk->sk_err = ENETDOWN;
297 if (!sock_flag(sk, SOCK_DEAD))
298 sk->sk_error_report(sk);
305 static int raw_init(struct sock *sk)
307 struct raw_sock *ro = raw_sk(sk);
309 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
315 /* set default filter to single entry dfilter */
316 ro->dfilter.can_id = 0;
317 ro->dfilter.can_mask = MASK_ALL;
318 ro->filter = &ro->dfilter;
321 /* set default loopback behaviour */
323 ro->recv_own_msgs = 0;
326 ro->notifier.notifier_call = raw_notifier;
328 register_netdevice_notifier(&ro->notifier);
333 static int raw_release(struct socket *sock)
335 struct sock *sk = sock->sk;
336 struct raw_sock *ro = raw_sk(sk);
338 DBG("socket %p, sk %p, refcnt %d\n", sock, sk,
339 atomic_read(&sk->sk_refcnt));
341 unregister_netdevice_notifier(&ro->notifier);
345 /* remove current filters & unregister */
348 struct net_device *dev;
350 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
351 dev = dev_get_by_index(&init_net, ro->ifindex);
353 dev = dev_get_by_index(ro->ifindex);
356 raw_disable_allfilters(dev, sk);
360 raw_disable_allfilters(NULL, sk);
376 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
378 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
379 struct sock *sk = sock->sk;
380 struct raw_sock *ro = raw_sk(sk);
383 int notify_enetdown = 0;
385 DBG("socket %p to device %d\n", sock, addr->can_ifindex);
387 if (len < sizeof(*addr))
392 if (ro->bound && addr->can_ifindex == ro->ifindex)
395 if (addr->can_ifindex) {
396 struct net_device *dev;
398 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
399 dev = dev_get_by_index(&init_net, addr->can_ifindex);
401 dev = dev_get_by_index(addr->can_ifindex);
404 DBG("could not find device %d\n", addr->can_ifindex);
408 if (dev->type != ARPHRD_CAN) {
409 DBG("device %d no CAN device\n", addr->can_ifindex);
414 if (!(dev->flags & IFF_UP))
417 ifindex = dev->ifindex;
419 /* filters set by default/setsockopt */
420 err = raw_enable_allfilters(dev, sk);
426 /* filters set by default/setsockopt */
427 err = raw_enable_allfilters(NULL, sk);
432 /* unregister old filters */
434 struct net_device *dev;
436 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
437 dev = dev_get_by_index(&init_net, ro->ifindex);
439 dev = dev_get_by_index(ro->ifindex);
442 raw_disable_allfilters(dev, sk);
446 raw_disable_allfilters(NULL, sk);
448 ro->ifindex = ifindex;
455 if (notify_enetdown) {
456 sk->sk_err = ENETDOWN;
457 if (!sock_flag(sk, SOCK_DEAD))
458 sk->sk_error_report(sk);
464 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
467 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
468 struct sock *sk = sock->sk;
469 struct raw_sock *ro = raw_sk(sk);
474 addr->can_family = AF_CAN;
475 addr->can_ifindex = ro->ifindex;
477 *len = sizeof(*addr);
482 static int raw_setsockopt(struct socket *sock, int level, int optname,
483 char __user *optval, int optlen)
485 struct sock *sk = sock->sk;
486 struct raw_sock *ro = raw_sk(sk);
487 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
488 struct can_filter sfilter; /* single filter */
489 struct net_device *dev = NULL;
490 can_err_mask_t err_mask = 0;
494 if (level != SOL_CAN_RAW)
502 if (optlen % sizeof(struct can_filter) != 0)
505 count = optlen / sizeof(struct can_filter);
508 /* filter does not fit into dfilter => alloc space */
509 filter = kmalloc(optlen, GFP_KERNEL);
513 err = copy_from_user(filter, optval, optlen);
518 } else if (count == 1) {
519 err = copy_from_user(&sfilter, optval, optlen);
526 if (ro->bound && ro->ifindex)
527 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
528 dev = dev_get_by_index(&init_net, ro->ifindex);
530 dev = dev_get_by_index(ro->ifindex);
534 /* (try to) register the new filters */
536 err = raw_enable_filters(dev, sk, &sfilter, 1);
538 err = raw_enable_filters(dev, sk, filter,
547 /* remove old filter registrations */
548 raw_disable_filters(dev, sk, ro->filter, ro->count);
551 /* remove old filter space */
555 /* link new filters to the socket */
557 /* copy filter data for single filter */
558 ro->dfilter = sfilter;
559 filter = &ro->dfilter;
572 case CAN_RAW_ERR_FILTER:
573 if (optlen != sizeof(err_mask))
576 err = copy_from_user(&err_mask, optval, optlen);
580 err_mask &= CAN_ERR_MASK;
584 if (ro->bound && ro->ifindex)
585 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
586 dev = dev_get_by_index(&init_net, ro->ifindex);
588 dev = dev_get_by_index(ro->ifindex);
591 /* remove current error mask */
593 /* (try to) register the new err_mask */
594 err = raw_enable_errfilter(dev, sk, err_mask);
599 /* remove old err_mask registration */
600 raw_disable_errfilter(dev, sk, ro->err_mask);
603 /* link new err_mask to the socket */
604 ro->err_mask = err_mask;
614 case CAN_RAW_LOOPBACK:
615 if (optlen != sizeof(ro->loopback))
618 err = copy_from_user(&ro->loopback, optval, optlen);
622 case CAN_RAW_RECV_OWN_MSGS:
623 if (optlen != sizeof(ro->recv_own_msgs))
626 err = copy_from_user(&ro->recv_own_msgs, optval, optlen);
636 static int raw_getsockopt(struct socket *sock, int level, int optname,
637 char __user *optval, int __user *optlen)
639 struct sock *sk = sock->sk;
640 struct raw_sock *ro = raw_sk(sk);
645 if (level != SOL_CAN_RAW)
647 if (get_user(len, optlen))
657 int fsize = ro->count * sizeof(struct can_filter);
660 err = copy_to_user(optval, ro->filter, len);
666 err = put_user(len, optlen);
669 case CAN_RAW_ERR_FILTER:
670 if (len > sizeof(can_err_mask_t))
671 len = sizeof(can_err_mask_t);
675 case CAN_RAW_LOOPBACK:
676 if (len > sizeof(int))
681 case CAN_RAW_RECV_OWN_MSGS:
682 if (len > sizeof(int))
684 val = &ro->recv_own_msgs;
691 if (put_user(len, optlen))
693 if (copy_to_user(optval, val, len))
698 static int raw_sendmsg(struct kiocb *iocb, struct socket *sock,
699 struct msghdr *msg, size_t size)
701 struct sock *sk = sock->sk;
702 struct raw_sock *ro = raw_sk(sk);
704 struct net_device *dev;
708 DBG("socket %p, sk %p\n", sock, sk);
711 struct sockaddr_can *addr =
712 (struct sockaddr_can *)msg->msg_name;
714 if (addr->can_family != AF_CAN)
717 ifindex = addr->can_ifindex;
719 ifindex = ro->ifindex;
721 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
722 dev = dev_get_by_index(&init_net, ifindex);
724 dev = dev_get_by_index(ifindex);
727 DBG("device %d not found\n", ifindex);
731 skb = alloc_skb(size, GFP_KERNEL);
737 err = memcpy_fromiovec(skb_put(skb, size), msg->msg_iov, size);
746 DBG("sending skbuff to interface %d\n", ifindex);
749 err = can_send(skb, ro->loopback);
759 static int raw_recvmsg(struct kiocb *iocb, struct socket *sock,
760 struct msghdr *msg, size_t size, int flags)
762 struct sock *sk = sock->sk;
767 DBG("socket %p, sk %p\n", sock, sk);
769 noblock = flags & MSG_DONTWAIT;
770 flags &= ~MSG_DONTWAIT;
772 skb = skb_recv_datagram(sk, flags, noblock, &error);
776 DBG("delivering skbuff %p\n", skb);
780 msg->msg_flags |= MSG_TRUNC;
784 error = memcpy_toiovec(msg->msg_iov, skb->data, size);
786 skb_free_datagram(sk, skb);
790 sock_recv_timestamp(msg, sk, skb);
793 msg->msg_namelen = sizeof(struct sockaddr_can);
794 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
797 DBG("freeing sock %p, skbuff %p\n", sk, skb);
798 skb_free_datagram(sk, skb);
803 static struct proto_ops raw_ops __read_mostly = {
805 .release = raw_release,
807 .connect = sock_no_connect,
808 .socketpair = sock_no_socketpair,
809 .accept = sock_no_accept,
810 .getname = raw_getname,
811 .poll = datagram_poll,
812 .ioctl = NULL, /* use can_ioctl() from af_can.c */
813 .listen = sock_no_listen,
814 .shutdown = sock_no_shutdown,
815 .setsockopt = raw_setsockopt,
816 .getsockopt = raw_getsockopt,
817 .sendmsg = raw_sendmsg,
818 .recvmsg = raw_recvmsg,
819 .mmap = sock_no_mmap,
820 .sendpage = sock_no_sendpage,
823 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
824 static struct proto raw_proto __read_mostly = {
826 .owner = THIS_MODULE,
827 .obj_size = sizeof(struct raw_sock),
831 static struct can_proto raw_can_proto __read_mostly = {
839 static struct can_proto raw_can_proto __read_mostly = {
844 .owner = THIS_MODULE,
845 .obj_size = sizeof(struct raw_sock),
850 static __init int raw_module_init(void)
856 err = can_proto_register(&raw_can_proto);
858 printk(KERN_ERR "can: registration of raw protocol failed\n");
863 static __exit void raw_module_exit(void)
865 can_proto_unregister(&raw_can_proto);
868 module_init(raw_module_init);
869 module_exit(raw_module_exit);