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 <socketcan/can.h>
54 #include <socketcan/can/core.h>
55 #include <socketcan/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 <socketcan/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>");
74 MODULE_ALIAS("can-proto-1");
79 * A raw socket has a list of can_filters attached to it, each receiving
80 * the CAN frames matching that filter. If the filter list is empty,
81 * no CAN frames will be received by the socket. The default after
82 * opening the socket, is to have one filter which receives all frames.
83 * The filter list is allocated dynamically with the exception of the
84 * list containing only one item. This common case is optimized by
85 * storing the single filter in dfilter, to avoid using dynamic memory.
89 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
96 struct notifier_block notifier;
99 int count; /* number of active filters */
100 struct can_filter dfilter; /* default/single filter */
101 struct can_filter *filter; /* pointer to filter(s) */
102 can_err_mask_t err_mask;
105 static inline struct raw_sock *raw_sk(const struct sock *sk)
107 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
108 return (struct raw_sock *)sk;
110 return (struct raw_sock *)sk->sk_protinfo;
114 static void raw_rcv(struct sk_buff *skb, void *data)
116 struct sock *sk = (struct sock *)data;
117 struct raw_sock *ro = raw_sk(sk);
118 struct sockaddr_can *addr;
120 /* check the received tx sock reference */
121 if (!ro->recv_own_msgs && skb->sk == sk)
124 /* clone the given skb to be able to enqueue it into the rcv queue */
125 skb = skb_clone(skb, GFP_ATOMIC);
130 * Put the datagram to the queue so that raw_recvmsg() can
131 * get it from there. We need to pass the interface index to
132 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
133 * containing the interface index.
136 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
137 addr = (struct sockaddr_can *)skb->cb;
138 memset(addr, 0, sizeof(*addr));
139 addr->can_family = AF_CAN;
140 addr->can_ifindex = skb->dev->ifindex;
142 if (sock_queue_rcv_skb(sk, skb) < 0)
146 static int raw_enable_filters(struct net_device *dev, struct sock *sk,
147 struct can_filter *filter, int count)
152 for (i = 0; i < count; i++) {
153 err = can_rx_register(dev, filter[i].can_id,
157 /* clean up successfully registered filters */
159 can_rx_unregister(dev, filter[i].can_id,
169 static int raw_enable_errfilter(struct net_device *dev, struct sock *sk,
170 can_err_mask_t err_mask)
175 err = can_rx_register(dev, 0, err_mask | CAN_ERR_FLAG,
181 static void raw_disable_filters(struct net_device *dev, struct sock *sk,
182 struct can_filter *filter, int count)
186 for (i = 0; i < count; i++)
187 can_rx_unregister(dev, filter[i].can_id, filter[i].can_mask,
191 static inline void raw_disable_errfilter(struct net_device *dev,
193 can_err_mask_t err_mask)
197 can_rx_unregister(dev, 0, err_mask | CAN_ERR_FLAG,
201 static inline void raw_disable_allfilters(struct net_device *dev,
204 struct raw_sock *ro = raw_sk(sk);
206 raw_disable_filters(dev, sk, ro->filter, ro->count);
207 raw_disable_errfilter(dev, sk, ro->err_mask);
210 static int raw_enable_allfilters(struct net_device *dev, struct sock *sk)
212 struct raw_sock *ro = raw_sk(sk);
215 err = raw_enable_filters(dev, sk, ro->filter, ro->count);
217 err = raw_enable_errfilter(dev, sk, ro->err_mask);
219 raw_disable_filters(dev, sk, ro->filter, ro->count);
225 static int raw_notifier(struct notifier_block *nb,
226 unsigned long msg, void *data)
228 struct net_device *dev = (struct net_device *)data;
229 struct raw_sock *ro = container_of(nb, struct raw_sock, notifier);
230 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
231 struct sock *sk = &ro->sk;
233 struct sock *sk = ro->sk;
236 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
237 if (!net_eq(dev_net(dev), &init_net))
239 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
240 if (dev->nd_net != &init_net)
244 if (dev->type != ARPHRD_CAN)
247 if (ro->ifindex != dev->ifindex)
252 case NETDEV_UNREGISTER:
254 /* remove current filters & unregister */
256 raw_disable_allfilters(dev, sk);
267 if (!sock_flag(sk, SOCK_DEAD))
268 sk->sk_error_report(sk);
272 sk->sk_err = ENETDOWN;
273 if (!sock_flag(sk, SOCK_DEAD))
274 sk->sk_error_report(sk);
281 static int raw_init(struct sock *sk)
283 struct raw_sock *ro = raw_sk(sk);
285 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
291 /* set default filter to single entry dfilter */
292 ro->dfilter.can_id = 0;
293 ro->dfilter.can_mask = MASK_ALL;
294 ro->filter = &ro->dfilter;
297 /* set default loopback behaviour */
299 ro->recv_own_msgs = 0;
302 ro->notifier.notifier_call = raw_notifier;
304 register_netdevice_notifier(&ro->notifier);
309 static int raw_release(struct socket *sock)
311 struct sock *sk = sock->sk;
312 struct raw_sock *ro = raw_sk(sk);
314 unregister_netdevice_notifier(&ro->notifier);
318 /* remove current filters & unregister */
321 struct net_device *dev;
323 dev = dev_get_by_index(&init_net, ro->ifindex);
325 raw_disable_allfilters(dev, sk);
329 raw_disable_allfilters(NULL, sk);
348 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
350 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
351 struct sock *sk = sock->sk;
352 struct raw_sock *ro = raw_sk(sk);
355 int notify_enetdown = 0;
357 if (len < sizeof(*addr))
362 if (ro->bound && addr->can_ifindex == ro->ifindex)
365 if (addr->can_ifindex) {
366 struct net_device *dev;
368 dev = dev_get_by_index(&init_net, addr->can_ifindex);
373 if (dev->type != ARPHRD_CAN) {
378 if (!(dev->flags & IFF_UP))
381 ifindex = dev->ifindex;
383 /* filters set by default/setsockopt */
384 err = raw_enable_allfilters(dev, sk);
389 /* filters set by default/setsockopt */
390 err = raw_enable_allfilters(NULL, sk);
395 /* unregister old filters */
397 struct net_device *dev;
399 dev = dev_get_by_index(&init_net, ro->ifindex);
401 raw_disable_allfilters(dev, sk);
405 raw_disable_allfilters(NULL, sk);
407 ro->ifindex = ifindex;
414 if (notify_enetdown) {
415 sk->sk_err = ENETDOWN;
416 if (!sock_flag(sk, SOCK_DEAD))
417 sk->sk_error_report(sk);
423 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
426 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
427 struct sock *sk = sock->sk;
428 struct raw_sock *ro = raw_sk(sk);
433 addr->can_family = AF_CAN;
434 addr->can_ifindex = ro->ifindex;
436 *len = sizeof(*addr);
441 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,32)
442 static int raw_setsockopt(struct socket *sock, int level, int optname,
443 char __user *optval, unsigned int optlen)
445 static int raw_setsockopt(struct socket *sock, int level, int optname,
446 char __user *optval, int optlen)
449 struct sock *sk = sock->sk;
450 struct raw_sock *ro = raw_sk(sk);
451 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
452 struct can_filter sfilter; /* single filter */
453 struct net_device *dev = NULL;
454 can_err_mask_t err_mask = 0;
458 if (level != SOL_CAN_RAW)
466 if (optlen % sizeof(struct can_filter) != 0)
469 count = optlen / sizeof(struct can_filter);
472 /* filter does not fit into dfilter => alloc space */
473 filter = kmalloc(optlen, GFP_KERNEL);
477 if (copy_from_user(filter, optval, optlen)) {
481 } else if (count == 1) {
482 if (copy_from_user(&sfilter, optval, optlen))
488 if (ro->bound && ro->ifindex)
489 dev = dev_get_by_index(&init_net, ro->ifindex);
492 /* (try to) register the new filters */
494 err = raw_enable_filters(dev, sk, &sfilter, 1);
496 err = raw_enable_filters(dev, sk, filter,
504 /* remove old filter registrations */
505 raw_disable_filters(dev, sk, ro->filter, ro->count);
508 /* remove old filter space */
512 /* link new filters to the socket */
514 /* copy filter data for single filter */
515 ro->dfilter = sfilter;
516 filter = &ro->dfilter;
529 case CAN_RAW_ERR_FILTER:
530 if (optlen != sizeof(err_mask))
533 if (copy_from_user(&err_mask, optval, optlen))
536 err_mask &= CAN_ERR_MASK;
540 if (ro->bound && ro->ifindex)
541 dev = dev_get_by_index(&init_net, ro->ifindex);
543 /* remove current error mask */
545 /* (try to) register the new err_mask */
546 err = raw_enable_errfilter(dev, sk, err_mask);
551 /* remove old err_mask registration */
552 raw_disable_errfilter(dev, sk, ro->err_mask);
555 /* link new err_mask to the socket */
556 ro->err_mask = err_mask;
566 case CAN_RAW_LOOPBACK:
567 if (optlen != sizeof(ro->loopback))
570 if (copy_from_user(&ro->loopback, optval, optlen))
575 case CAN_RAW_RECV_OWN_MSGS:
576 if (optlen != sizeof(ro->recv_own_msgs))
579 if (copy_from_user(&ro->recv_own_msgs, optval, optlen))
590 static int raw_getsockopt(struct socket *sock, int level, int optname,
591 char __user *optval, int __user *optlen)
593 struct sock *sk = sock->sk;
594 struct raw_sock *ro = raw_sk(sk);
599 if (level != SOL_CAN_RAW)
601 if (get_user(len, optlen))
611 int fsize = ro->count * sizeof(struct can_filter);
614 if (copy_to_user(optval, ro->filter, len))
621 err = put_user(len, optlen);
624 case CAN_RAW_ERR_FILTER:
625 if (len > sizeof(can_err_mask_t))
626 len = sizeof(can_err_mask_t);
630 case CAN_RAW_LOOPBACK:
631 if (len > sizeof(int))
636 case CAN_RAW_RECV_OWN_MSGS:
637 if (len > sizeof(int))
639 val = &ro->recv_own_msgs;
646 if (put_user(len, optlen))
648 if (copy_to_user(optval, val, len))
653 static int raw_sendmsg(struct kiocb *iocb, struct socket *sock,
654 struct msghdr *msg, size_t size)
656 struct sock *sk = sock->sk;
657 struct raw_sock *ro = raw_sk(sk);
659 struct net_device *dev;
664 struct sockaddr_can *addr =
665 (struct sockaddr_can *)msg->msg_name;
667 if (addr->can_family != AF_CAN)
670 ifindex = addr->can_ifindex;
672 ifindex = ro->ifindex;
674 if (size != sizeof(struct can_frame))
677 dev = dev_get_by_index(&init_net, ifindex);
681 skb = sock_alloc_send_skb(sk, size, msg->msg_flags & MSG_DONTWAIT,
686 err = memcpy_fromiovec(skb_put(skb, size), msg->msg_iov, size);
692 err = can_send(skb, ro->loopback);
709 static int raw_recvmsg(struct kiocb *iocb, struct socket *sock,
710 struct msghdr *msg, size_t size, int flags)
712 struct sock *sk = sock->sk;
717 noblock = flags & MSG_DONTWAIT;
718 flags &= ~MSG_DONTWAIT;
720 skb = skb_recv_datagram(sk, flags, noblock, &err);
725 msg->msg_flags |= MSG_TRUNC;
729 err = memcpy_toiovec(msg->msg_iov, skb->data, size);
731 skb_free_datagram(sk, skb);
735 sock_recv_timestamp(msg, sk, skb);
738 msg->msg_namelen = sizeof(struct sockaddr_can);
739 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
742 skb_free_datagram(sk, skb);
747 static struct proto_ops raw_ops __read_mostly = {
749 .release = raw_release,
751 .connect = sock_no_connect,
752 .socketpair = sock_no_socketpair,
753 .accept = sock_no_accept,
754 .getname = raw_getname,
755 .poll = datagram_poll,
756 .ioctl = NULL, /* use can_ioctl() from af_can.c */
757 .listen = sock_no_listen,
758 .shutdown = sock_no_shutdown,
759 .setsockopt = raw_setsockopt,
760 .getsockopt = raw_getsockopt,
761 .sendmsg = raw_sendmsg,
762 .recvmsg = raw_recvmsg,
763 .mmap = sock_no_mmap,
764 .sendpage = sock_no_sendpage,
767 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
768 static struct proto raw_proto __read_mostly = {
770 .owner = THIS_MODULE,
771 .obj_size = sizeof(struct raw_sock),
775 static struct can_proto raw_can_proto __read_mostly = {
783 static struct can_proto raw_can_proto __read_mostly = {
788 .owner = THIS_MODULE,
789 .obj_size = sizeof(struct raw_sock),
794 static __init int raw_module_init(void)
800 err = can_proto_register(&raw_can_proto);
802 printk(KERN_ERR "can: registration of raw protocol failed\n");
807 static __exit void raw_module_exit(void)
809 can_proto_unregister(&raw_can_proto);
812 module_init(raw_module_init);
813 module_exit(raw_module_exit);