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>
60 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
64 #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>");
78 * A raw socket has a list of can_filters attached to it, each receiving
79 * the CAN frames matching that filter. If the filter list is empty,
80 * no CAN frames will be received by the socket. The default after
81 * opening the socket, is to have one filter which receives all frames.
82 * The filter list is allocated dynamically with the exception of the
83 * list containing only one item. This common case is optimized by
84 * storing the single filter in dfilter, to avoid using dynamic memory.
88 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
95 struct notifier_block notifier;
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;
104 static inline struct raw_sock *raw_sk(const struct sock *sk)
106 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
107 return (struct raw_sock *)sk;
109 return (struct raw_sock *)sk->sk_protinfo;
113 static void raw_rcv(struct sk_buff *skb, void *data)
115 struct sock *sk = (struct sock *)data;
116 struct raw_sock *ro = raw_sk(sk);
117 struct sockaddr_can *addr;
119 if (!ro->recv_own_msgs) {
120 /* check the received tx sock reference */
128 * Put the datagram to the queue so that raw_recvmsg() can
129 * get it from there. We need to pass the interface index to
130 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
131 * containing the interface index.
134 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
135 addr = (struct sockaddr_can *)skb->cb;
136 memset(addr, 0, sizeof(*addr));
137 addr->can_family = AF_CAN;
138 addr->can_ifindex = skb->dev->ifindex;
140 if (sock_queue_rcv_skb(sk, skb) < 0)
144 static int raw_enable_filters(struct net_device *dev, struct sock *sk,
145 struct can_filter *filter, int count)
150 for (i = 0; i < count; i++) {
151 err = can_rx_register(dev, filter[i].can_id,
155 /* clean up successfully registered filters */
157 can_rx_unregister(dev, filter[i].can_id,
167 static int raw_enable_errfilter(struct net_device *dev, struct sock *sk,
168 can_err_mask_t err_mask)
173 err = can_rx_register(dev, 0, err_mask | CAN_ERR_FLAG,
179 static void raw_disable_filters(struct net_device *dev, struct sock *sk,
180 struct can_filter *filter, int count)
184 for (i = 0; i < count; i++)
185 can_rx_unregister(dev, filter[i].can_id, filter[i].can_mask,
189 static inline void raw_disable_errfilter(struct net_device *dev,
191 can_err_mask_t err_mask)
195 can_rx_unregister(dev, 0, err_mask | CAN_ERR_FLAG,
199 static inline void raw_disable_allfilters(struct net_device *dev,
202 struct raw_sock *ro = raw_sk(sk);
204 raw_disable_filters(dev, sk, ro->filter, ro->count);
205 raw_disable_errfilter(dev, sk, ro->err_mask);
208 static int raw_enable_allfilters(struct net_device *dev, struct sock *sk)
210 struct raw_sock *ro = raw_sk(sk);
213 err = raw_enable_filters(dev, sk, ro->filter, ro->count);
215 err = raw_enable_errfilter(dev, sk, ro->err_mask);
217 raw_disable_filters(dev, sk, ro->filter, ro->count);
223 static int raw_notifier(struct notifier_block *nb,
224 unsigned long msg, void *data)
226 struct net_device *dev = (struct net_device *)data;
227 struct raw_sock *ro = container_of(nb, struct raw_sock, notifier);
228 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
229 struct sock *sk = &ro->sk;
231 struct sock *sk = ro->sk;
234 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
235 if (dev->nd_net != &init_net)
239 if (dev->type != ARPHRD_CAN)
242 if (ro->ifindex != dev->ifindex)
247 case NETDEV_UNREGISTER:
249 /* remove current filters & unregister */
251 raw_disable_allfilters(dev, sk);
262 if (!sock_flag(sk, SOCK_DEAD))
263 sk->sk_error_report(sk);
267 sk->sk_err = ENETDOWN;
268 if (!sock_flag(sk, SOCK_DEAD))
269 sk->sk_error_report(sk);
276 static int raw_init(struct sock *sk)
278 struct raw_sock *ro = raw_sk(sk);
280 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
286 /* set default filter to single entry dfilter */
287 ro->dfilter.can_id = 0;
288 ro->dfilter.can_mask = MASK_ALL;
289 ro->filter = &ro->dfilter;
292 /* set default loopback behaviour */
294 ro->recv_own_msgs = 0;
297 ro->notifier.notifier_call = raw_notifier;
299 register_netdevice_notifier(&ro->notifier);
304 static int raw_release(struct socket *sock)
306 struct sock *sk = sock->sk;
307 struct raw_sock *ro = raw_sk(sk);
309 unregister_netdevice_notifier(&ro->notifier);
313 /* remove current filters & unregister */
316 struct net_device *dev;
318 dev = dev_get_by_index(&init_net, ro->ifindex);
320 raw_disable_allfilters(dev, sk);
324 raw_disable_allfilters(NULL, sk);
340 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
342 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
343 struct sock *sk = sock->sk;
344 struct raw_sock *ro = raw_sk(sk);
347 int notify_enetdown = 0;
349 if (len < sizeof(*addr))
354 if (ro->bound && addr->can_ifindex == ro->ifindex)
357 if (addr->can_ifindex) {
358 struct net_device *dev;
360 dev = dev_get_by_index(&init_net, addr->can_ifindex);
365 if (dev->type != ARPHRD_CAN) {
370 if (!(dev->flags & IFF_UP))
373 ifindex = dev->ifindex;
375 /* filters set by default/setsockopt */
376 err = raw_enable_allfilters(dev, sk);
381 /* filters set by default/setsockopt */
382 err = raw_enable_allfilters(NULL, sk);
387 /* unregister old filters */
389 struct net_device *dev;
391 dev = dev_get_by_index(&init_net, ro->ifindex);
393 raw_disable_allfilters(dev, sk);
397 raw_disable_allfilters(NULL, sk);
399 ro->ifindex = ifindex;
406 if (notify_enetdown) {
407 sk->sk_err = ENETDOWN;
408 if (!sock_flag(sk, SOCK_DEAD))
409 sk->sk_error_report(sk);
415 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
418 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
419 struct sock *sk = sock->sk;
420 struct raw_sock *ro = raw_sk(sk);
425 addr->can_family = AF_CAN;
426 addr->can_ifindex = ro->ifindex;
428 *len = sizeof(*addr);
433 static int raw_setsockopt(struct socket *sock, int level, int optname,
434 char __user *optval, int optlen)
436 struct sock *sk = sock->sk;
437 struct raw_sock *ro = raw_sk(sk);
438 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
439 struct can_filter sfilter; /* single filter */
440 struct net_device *dev = NULL;
441 can_err_mask_t err_mask = 0;
445 if (level != SOL_CAN_RAW)
453 if (optlen % sizeof(struct can_filter) != 0)
456 count = optlen / sizeof(struct can_filter);
459 /* filter does not fit into dfilter => alloc space */
460 filter = kmalloc(optlen, GFP_KERNEL);
464 if (copy_from_user(filter, optval, optlen)) {
468 } else if (count == 1) {
469 if (copy_from_user(&sfilter, optval, optlen))
475 if (ro->bound && ro->ifindex)
476 dev = dev_get_by_index(&init_net, ro->ifindex);
479 /* (try to) register the new filters */
481 err = raw_enable_filters(dev, sk, &sfilter, 1);
483 err = raw_enable_filters(dev, sk, filter,
491 /* remove old filter registrations */
492 raw_disable_filters(dev, sk, ro->filter, ro->count);
495 /* remove old filter space */
499 /* link new filters to the socket */
501 /* copy filter data for single filter */
502 ro->dfilter = sfilter;
503 filter = &ro->dfilter;
516 case CAN_RAW_ERR_FILTER:
517 if (optlen != sizeof(err_mask))
520 if (copy_from_user(&err_mask, optval, optlen))
523 err_mask &= CAN_ERR_MASK;
527 if (ro->bound && ro->ifindex)
528 dev = dev_get_by_index(&init_net, ro->ifindex);
530 /* remove current error mask */
532 /* (try to) register the new err_mask */
533 err = raw_enable_errfilter(dev, sk, err_mask);
538 /* remove old err_mask registration */
539 raw_disable_errfilter(dev, sk, ro->err_mask);
542 /* link new err_mask to the socket */
543 ro->err_mask = err_mask;
553 case CAN_RAW_LOOPBACK:
554 if (optlen != sizeof(ro->loopback))
557 if (copy_from_user(&ro->loopback, optval, optlen))
562 case CAN_RAW_RECV_OWN_MSGS:
563 if (optlen != sizeof(ro->recv_own_msgs))
566 if (copy_from_user(&ro->recv_own_msgs, optval, optlen))
577 static int raw_getsockopt(struct socket *sock, int level, int optname,
578 char __user *optval, int __user *optlen)
580 struct sock *sk = sock->sk;
581 struct raw_sock *ro = raw_sk(sk);
586 if (level != SOL_CAN_RAW)
588 if (get_user(len, optlen))
598 int fsize = ro->count * sizeof(struct can_filter);
601 if (copy_to_user(optval, ro->filter, len))
608 err = put_user(len, optlen);
611 case CAN_RAW_ERR_FILTER:
612 if (len > sizeof(can_err_mask_t))
613 len = sizeof(can_err_mask_t);
617 case CAN_RAW_LOOPBACK:
618 if (len > sizeof(int))
623 case CAN_RAW_RECV_OWN_MSGS:
624 if (len > sizeof(int))
626 val = &ro->recv_own_msgs;
633 if (put_user(len, optlen))
635 if (copy_to_user(optval, val, len))
640 static int raw_sendmsg(struct kiocb *iocb, struct socket *sock,
641 struct msghdr *msg, size_t size)
643 struct sock *sk = sock->sk;
644 struct raw_sock *ro = raw_sk(sk);
646 struct net_device *dev;
651 struct sockaddr_can *addr =
652 (struct sockaddr_can *)msg->msg_name;
654 if (addr->can_family != AF_CAN)
657 ifindex = addr->can_ifindex;
659 ifindex = ro->ifindex;
661 dev = dev_get_by_index(&init_net, ifindex);
665 skb = sock_alloc_send_skb(sk, size, msg->msg_flags & MSG_DONTWAIT,
672 err = memcpy_fromiovec(skb_put(skb, size), msg->msg_iov, size);
681 err = can_send(skb, ro->loopback);
691 static int raw_recvmsg(struct kiocb *iocb, struct socket *sock,
692 struct msghdr *msg, size_t size, int flags)
694 struct sock *sk = sock->sk;
699 noblock = flags & MSG_DONTWAIT;
700 flags &= ~MSG_DONTWAIT;
702 skb = skb_recv_datagram(sk, flags, noblock, &err);
707 msg->msg_flags |= MSG_TRUNC;
711 err = memcpy_toiovec(msg->msg_iov, skb->data, size);
713 skb_free_datagram(sk, skb);
717 sock_recv_timestamp(msg, sk, skb);
720 msg->msg_namelen = sizeof(struct sockaddr_can);
721 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
724 skb_free_datagram(sk, skb);
729 static struct proto_ops raw_ops __read_mostly = {
731 .release = raw_release,
733 .connect = sock_no_connect,
734 .socketpair = sock_no_socketpair,
735 .accept = sock_no_accept,
736 .getname = raw_getname,
737 .poll = datagram_poll,
738 .ioctl = NULL, /* use can_ioctl() from af_can.c */
739 .listen = sock_no_listen,
740 .shutdown = sock_no_shutdown,
741 .setsockopt = raw_setsockopt,
742 .getsockopt = raw_getsockopt,
743 .sendmsg = raw_sendmsg,
744 .recvmsg = raw_recvmsg,
745 .mmap = sock_no_mmap,
746 .sendpage = sock_no_sendpage,
749 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
750 static struct proto raw_proto __read_mostly = {
752 .owner = THIS_MODULE,
753 .obj_size = sizeof(struct raw_sock),
757 static struct can_proto raw_can_proto __read_mostly = {
765 static struct can_proto raw_can_proto __read_mostly = {
770 .owner = THIS_MODULE,
771 .obj_size = sizeof(struct raw_sock),
776 static __init int raw_module_init(void)
782 err = can_proto_register(&raw_can_proto);
784 printk(KERN_ERR "can: registration of raw protocol failed\n");
789 static __exit void raw_module_exit(void)
791 can_proto_unregister(&raw_can_proto);
794 module_init(raw_module_init);
795 module_exit(raw_module_exit);