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/uio.h>
49 #include <linux/poll.h>
50 #include <linux/net.h>
51 #include <linux/netdevice.h>
52 #include <linux/socket.h>
53 #include <linux/if_arp.h>
54 #include <linux/skbuff.h>
55 #include <linux/can.h>
56 #include <linux/can/core.h>
57 #include <linux/can/raw.h>
59 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
60 #include <net/net_namespace.h>
63 #include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
67 #define CAN_RAW_VERSION CAN_VERSION
68 static __initdata const char banner[] =
69 KERN_INFO "can: raw protocol (rev " CAN_RAW_VERSION ")\n";
71 MODULE_DESCRIPTION("PF_CAN raw protocol");
72 MODULE_LICENSE("Dual BSD/GPL");
73 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>");
75 #ifdef CONFIG_CAN_DEBUG_CORE
77 module_param(debug, int, S_IRUGO);
78 MODULE_PARM_DESC(debug, "debug print mask: 1:debug, 2:frames, 4:skbs");
81 #ifdef CONFIG_CAN_RAW_USER
84 #define RAW_CAP CAP_NET_RAW
90 * A raw socket has a list of can_filters attached to it, each receiving
91 * the CAN frames matching that filter. If the filter list is empty,
92 * no CAN frames will be received by the socket. The default after
93 * opening the socket, is to have one filter which receives all frames.
94 * The filter list is allocated dynamically with the exception of the
95 * list containing only one item. This common case is optimized by
96 * storing the single filter in dfilter, to avoid using dynamic memory.
100 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
107 struct notifier_block notifier;
110 int count; /* number of active filters */
111 struct can_filter dfilter; /* default/single filter */
112 struct can_filter *filter; /* pointer to filter(s) */
113 can_err_mask_t err_mask;
116 static inline struct raw_sock *raw_sk(const struct sock *sk)
118 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
119 return (struct raw_sock *)sk;
121 return (struct raw_sock *)sk->sk_protinfo;
125 static void raw_rcv(struct sk_buff *skb, void *data)
127 struct sock *sk = (struct sock *)data;
128 struct raw_sock *ro = raw_sk(sk);
129 struct sockaddr_can *addr;
132 DBG("received skbuff %p, sk %p\n", skb, sk);
135 if (!ro->recv_own_msgs) {
136 /* check the received tx sock reference */
138 DBG("trashed own tx msg\n");
145 * Put the datagram to the queue so that raw_recvmsg() can
146 * get it from there. We need to pass the interface index to
147 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
148 * containing the interface index.
151 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
152 addr = (struct sockaddr_can *)skb->cb;
153 memset(addr, 0, sizeof(*addr));
154 addr->can_family = AF_CAN;
155 addr->can_ifindex = skb->dev->ifindex;
157 error = sock_queue_rcv_skb(sk, skb);
159 DBG("sock_queue_rcv_skb failed: %d\n", error);
160 DBG("freeing skbuff %p\n", skb);
165 static int raw_enable_filters(struct net_device *dev, struct sock *sk,
166 struct can_filter *filter,
172 for (i = 0; i < count; i++) {
173 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
174 filter[i].can_id, filter[i].can_mask,
175 filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
177 err = can_rx_register(dev, filter[i].can_id,
182 /* clean up successfully registered filters */
184 can_rx_unregister(dev, filter[i].can_id,
194 static int raw_enable_errfilter(struct net_device *dev, struct sock *sk,
195 can_err_mask_t err_mask)
200 err = can_rx_register(dev, 0, err_mask | CAN_ERR_FLAG,
206 static void raw_disable_filters(struct net_device *dev, struct sock *sk,
207 struct can_filter *filter,
212 for (i = 0; i < count; i++) {
213 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
214 filter[i].can_id, filter[i].can_mask,
215 filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
217 can_rx_unregister(dev, filter[i].can_id, filter[i].can_mask,
222 static inline void raw_disable_errfilter(struct net_device *dev,
224 can_err_mask_t err_mask)
228 can_rx_unregister(dev, 0, err_mask | CAN_ERR_FLAG,
232 static inline void raw_disable_allfilters(struct net_device *dev,
235 struct raw_sock *ro = raw_sk(sk);
237 raw_disable_filters(dev, sk, ro->filter, ro->count);
238 raw_disable_errfilter(dev, sk, ro->err_mask);
241 static int raw_enable_allfilters(struct net_device *dev, struct sock *sk)
243 struct raw_sock *ro = raw_sk(sk);
246 err = raw_enable_filters(dev, sk, ro->filter, ro->count);
248 err = raw_enable_errfilter(dev, sk, ro->err_mask);
250 raw_disable_filters(dev, sk, ro->filter, ro->count);
256 static int raw_notifier(struct notifier_block *nb,
257 unsigned long msg, void *data)
259 struct net_device *dev = (struct net_device *)data;
260 struct raw_sock *ro = container_of(nb, struct raw_sock, notifier);
261 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
262 struct sock *sk = &ro->sk;
264 struct sock *sk = ro->sk;
267 DBG("msg %ld for dev %p (%s idx %d) sk %p ro->ifindex %d\n",
268 msg, dev, dev->name, dev->ifindex, sk, ro->ifindex);
270 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
271 if (dev->nd_net != &init_net)
275 if (dev->type != ARPHRD_CAN)
278 if (ro->ifindex != dev->ifindex)
283 case NETDEV_UNREGISTER:
285 /* remove current filters & unregister */
287 raw_disable_allfilters(dev, sk);
298 if (!sock_flag(sk, SOCK_DEAD))
299 sk->sk_error_report(sk);
303 sk->sk_err = ENETDOWN;
304 if (!sock_flag(sk, SOCK_DEAD))
305 sk->sk_error_report(sk);
312 static int raw_init(struct sock *sk)
314 struct raw_sock *ro = raw_sk(sk);
316 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
322 /* set default filter to single entry dfilter */
323 ro->dfilter.can_id = 0;
324 ro->dfilter.can_mask = MASK_ALL;
325 ro->filter = &ro->dfilter;
328 /* set default loopback behaviour */
330 ro->recv_own_msgs = 0;
333 ro->notifier.notifier_call = raw_notifier;
335 register_netdevice_notifier(&ro->notifier);
340 static int raw_release(struct socket *sock)
342 struct sock *sk = sock->sk;
343 struct raw_sock *ro = raw_sk(sk);
345 DBG("socket %p, sk %p, refcnt %d\n", sock, sk,
346 atomic_read(&sk->sk_refcnt));
348 unregister_netdevice_notifier(&ro->notifier);
352 /* remove current filters & unregister */
355 struct net_device *dev;
357 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
358 dev = dev_get_by_index(&init_net, ro->ifindex);
360 dev = dev_get_by_index(ro->ifindex);
363 raw_disable_allfilters(dev, sk);
367 raw_disable_allfilters(NULL, sk);
383 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
385 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
386 struct sock *sk = sock->sk;
387 struct raw_sock *ro = raw_sk(sk);
390 int notify_enetdown = 0;
392 DBG("socket %p to device %d\n", sock, addr->can_ifindex);
394 if (len < sizeof(*addr))
399 if (ro->bound && addr->can_ifindex == ro->ifindex)
402 if (addr->can_ifindex) {
403 struct net_device *dev;
405 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
406 dev = dev_get_by_index(&init_net, addr->can_ifindex);
408 dev = dev_get_by_index(addr->can_ifindex);
411 DBG("could not find device %d\n", addr->can_ifindex);
415 if (dev->type != ARPHRD_CAN) {
416 DBG("device %d no CAN device\n", addr->can_ifindex);
421 if (!(dev->flags & IFF_UP))
424 ifindex = dev->ifindex;
426 /* filters set by default/setsockopt */
427 err = raw_enable_allfilters(dev, sk);
433 /* filters set by default/setsockopt */
434 err = raw_enable_allfilters(NULL, sk);
439 /* unregister old filters */
441 struct net_device *dev;
443 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
444 dev = dev_get_by_index(&init_net, ro->ifindex);
446 dev = dev_get_by_index(ro->ifindex);
449 raw_disable_allfilters(dev, sk);
453 raw_disable_allfilters(NULL, sk);
455 ro->ifindex = ifindex;
462 if (notify_enetdown) {
463 sk->sk_err = ENETDOWN;
464 if (!sock_flag(sk, SOCK_DEAD))
465 sk->sk_error_report(sk);
471 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
474 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
475 struct sock *sk = sock->sk;
476 struct raw_sock *ro = raw_sk(sk);
481 addr->can_family = AF_CAN;
482 addr->can_ifindex = ro->ifindex;
484 *len = sizeof(*addr);
489 static unsigned int raw_poll(struct file *file, struct socket *sock,
492 unsigned int mask = 0;
494 DBG("socket %p\n", sock);
496 mask = datagram_poll(file, sock, wait);
500 static int raw_setsockopt(struct socket *sock, int level, int optname,
501 char __user *optval, int optlen)
503 struct sock *sk = sock->sk;
504 struct raw_sock *ro = raw_sk(sk);
505 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
506 struct can_filter sfilter; /* single filter */
507 struct net_device *dev = NULL;
508 can_err_mask_t err_mask = 0;
512 if (level != SOL_CAN_RAW)
520 if (optlen % sizeof(struct can_filter) != 0)
523 count = optlen / sizeof(struct can_filter);
526 /* filter does not fit into dfilter => alloc space */
527 filter = kmalloc(optlen, GFP_KERNEL);
531 err = copy_from_user(filter, optval, optlen);
536 } else if (count == 1) {
537 err = copy_from_user(&sfilter, optval, optlen);
544 if (ro->bound && ro->ifindex)
545 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
546 dev = dev_get_by_index(&init_net, ro->ifindex);
548 dev = dev_get_by_index(ro->ifindex);
552 /* (try to) register the new filters */
554 err = raw_enable_filters(dev, sk, &sfilter, 1);
556 err = raw_enable_filters(dev, sk, filter,
565 /* remove old filter registrations */
566 raw_disable_filters(dev, sk, ro->filter, ro->count);
569 /* remove old filter space */
573 /* link new filters to the socket */
575 /* copy filter data for single filter */
576 ro->dfilter = sfilter;
577 filter = &ro->dfilter;
590 case CAN_RAW_ERR_FILTER:
591 if (optlen != sizeof(err_mask))
594 err = copy_from_user(&err_mask, optval, optlen);
598 err_mask &= CAN_ERR_MASK;
602 if (ro->bound && ro->ifindex)
603 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
604 dev = dev_get_by_index(&init_net, ro->ifindex);
606 dev = dev_get_by_index(ro->ifindex);
609 /* remove current error mask */
611 /* (try to) register the new err_mask */
612 err = raw_enable_errfilter(dev, sk, err_mask);
617 /* remove old err_mask registration */
618 raw_disable_errfilter(dev, sk, ro->err_mask);
621 /* link new err_mask to the socket */
622 ro->err_mask = err_mask;
632 case CAN_RAW_LOOPBACK:
633 if (optlen != sizeof(ro->loopback))
636 err = copy_from_user(&ro->loopback, optval, optlen);
640 case CAN_RAW_RECV_OWN_MSGS:
641 if (optlen != sizeof(ro->recv_own_msgs))
644 err = copy_from_user(&ro->recv_own_msgs, optval, optlen);
654 static int raw_getsockopt(struct socket *sock, int level, int optname,
655 char __user *optval, int __user *optlen)
657 struct sock *sk = sock->sk;
658 struct raw_sock *ro = raw_sk(sk);
663 if (level != SOL_CAN_RAW)
665 if (get_user(len, optlen))
675 int fsize = ro->count * sizeof(struct can_filter);
678 err = copy_to_user(optval, ro->filter, len);
684 err = put_user(len, optlen);
687 case CAN_RAW_ERR_FILTER:
688 if (len > sizeof(can_err_mask_t))
689 len = sizeof(can_err_mask_t);
693 case CAN_RAW_LOOPBACK:
694 if (len > sizeof(int))
699 case CAN_RAW_RECV_OWN_MSGS:
700 if (len > sizeof(int))
702 val = &ro->recv_own_msgs;
709 if (put_user(len, optlen))
711 if (copy_to_user(optval, val, len))
716 static int raw_sendmsg(struct kiocb *iocb, struct socket *sock,
717 struct msghdr *msg, size_t size)
719 struct sock *sk = sock->sk;
720 struct raw_sock *ro = raw_sk(sk);
722 struct net_device *dev;
726 DBG("socket %p, sk %p\n", sock, sk);
729 struct sockaddr_can *addr =
730 (struct sockaddr_can *)msg->msg_name;
732 if (addr->can_family != AF_CAN)
735 ifindex = addr->can_ifindex;
737 ifindex = ro->ifindex;
739 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
740 dev = dev_get_by_index(&init_net, ifindex);
742 dev = dev_get_by_index(ifindex);
745 DBG("device %d not found\n", ifindex);
749 skb = alloc_skb(size, GFP_KERNEL);
755 err = memcpy_fromiovec(skb_put(skb, size), msg->msg_iov, size);
764 DBG("sending skbuff to interface %d\n", ifindex);
767 err = can_send(skb, ro->loopback);
777 static int raw_recvmsg(struct kiocb *iocb, struct socket *sock,
778 struct msghdr *msg, size_t size, int flags)
780 struct sock *sk = sock->sk;
785 DBG("socket %p, sk %p\n", sock, sk);
787 noblock = flags & MSG_DONTWAIT;
788 flags &= ~MSG_DONTWAIT;
790 skb = skb_recv_datagram(sk, flags, noblock, &error);
794 DBG("delivering skbuff %p\n", skb);
798 msg->msg_flags |= MSG_TRUNC;
802 error = memcpy_toiovec(msg->msg_iov, skb->data, size);
804 skb_free_datagram(sk, skb);
808 sock_recv_timestamp(msg, sk, skb);
811 msg->msg_namelen = sizeof(struct sockaddr_can);
812 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
815 DBG("freeing sock %p, skbuff %p\n", sk, skb);
816 skb_free_datagram(sk, skb);
821 static struct proto_ops raw_ops __read_mostly = {
823 .release = raw_release,
825 .connect = sock_no_connect,
826 .socketpair = sock_no_socketpair,
827 .accept = sock_no_accept,
828 .getname = raw_getname,
830 .ioctl = NULL, /* use can_ioctl() from af_can.c */
831 .listen = sock_no_listen,
832 .shutdown = sock_no_shutdown,
833 .setsockopt = raw_setsockopt,
834 .getsockopt = raw_getsockopt,
835 .sendmsg = raw_sendmsg,
836 .recvmsg = raw_recvmsg,
837 .mmap = sock_no_mmap,
838 .sendpage = sock_no_sendpage,
841 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
842 static struct proto raw_proto __read_mostly = {
844 .owner = THIS_MODULE,
845 .obj_size = sizeof(struct raw_sock),
849 static struct can_proto raw_can_proto __read_mostly = {
852 .capability = RAW_CAP,
857 static struct can_proto raw_can_proto __read_mostly = {
860 .capability = RAW_CAP,
862 .owner = THIS_MODULE,
863 .obj_size = sizeof(struct raw_sock),
868 static __init int raw_module_init(void)
874 err = can_proto_register(&raw_can_proto);
876 printk(KERN_ERR "can: registration of raw protocol failed\n");
881 static __exit void raw_module_exit(void)
883 can_proto_unregister(&raw_can_proto);
886 module_init(raw_module_init);
887 module_exit(raw_module_exit);