1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
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
42 #include <linux/module.h>
43 #include <linux/init.h>
44 #include <linux/uio.h>
45 #include <linux/net.h>
46 #include <linux/slab.h>
47 #include <linux/netdevice.h>
48 #include <linux/socket.h>
49 #include <linux/if_arp.h>
50 #include <linux/skbuff.h>
51 #include <linux/can.h>
52 #include <linux/can/core.h>
53 #include <linux/can/skb.h>
54 #include <linux/can/raw.h>
56 #include <net/net_namespace.h>
58 MODULE_DESCRIPTION("PF_CAN raw protocol");
59 MODULE_LICENSE("Dual BSD/GPL");
61 MODULE_ALIAS("can-proto-1");
65 /* A raw socket has a list of can_filters attached to it, each receiving
66 * the CAN frames matching that filter. If the filter list is empty,
67 * no CAN frames will be received by the socket. The default after
68 * opening the socket, is to have one filter which receives all frames.
69 * The filter list is allocated dynamically with the exception of the
70 * list containing only one item. This common case is optimized by
71 * storing the single filter in dfilter, to avoid using dynamic memory.
76 const struct sk_buff *skb;
77 unsigned int join_rx_count;
84 struct notifier_block notifier;
89 int count; /* number of active filters */
90 struct can_filter dfilter; /* default/single filter */
91 struct can_filter *filter; /* pointer to filter(s) */
92 can_err_mask_t err_mask;
93 struct uniqframe __percpu *uniq;
96 /* Return pointer to store the extra msg flags for raw_recvmsg().
97 * We use the space of one unsigned int beyond the 'struct sockaddr_can'
100 static inline unsigned int *raw_flags(struct sk_buff *skb)
102 sock_skb_cb_check_size(sizeof(struct sockaddr_can) +
103 sizeof(unsigned int));
105 /* return pointer after struct sockaddr_can */
106 return (unsigned int *)(&((struct sockaddr_can *)skb->cb)[1]);
109 static inline struct raw_sock *raw_sk(const struct sock *sk)
111 return (struct raw_sock *)sk;
114 static void raw_rcv(struct sk_buff *oskb, void *data)
116 struct sock *sk = (struct sock *)data;
117 struct raw_sock *ro = raw_sk(sk);
118 struct sockaddr_can *addr;
120 unsigned int *pflags;
122 /* check the received tx sock reference */
123 if (!ro->recv_own_msgs && oskb->sk == sk)
126 /* do not pass non-CAN2.0 frames to a legacy socket */
127 if (!ro->fd_frames && oskb->len != CAN_MTU)
130 /* eliminate multiple filter matches for the same skb */
131 if (this_cpu_ptr(ro->uniq)->skb == oskb &&
132 this_cpu_ptr(ro->uniq)->skbcnt == can_skb_prv(oskb)->skbcnt) {
133 if (ro->join_filters) {
134 this_cpu_inc(ro->uniq->join_rx_count);
135 /* drop frame until all enabled filters matched */
136 if (this_cpu_ptr(ro->uniq)->join_rx_count < ro->count)
142 this_cpu_ptr(ro->uniq)->skb = oskb;
143 this_cpu_ptr(ro->uniq)->skbcnt = can_skb_prv(oskb)->skbcnt;
144 this_cpu_ptr(ro->uniq)->join_rx_count = 1;
145 /* drop first frame to check all enabled filters? */
146 if (ro->join_filters && ro->count > 1)
150 /* clone the given skb to be able to enqueue it into the rcv queue */
151 skb = skb_clone(oskb, GFP_ATOMIC);
155 /* Put the datagram to the queue so that raw_recvmsg() can get
156 * it from there. We need to pass the interface index to
157 * raw_recvmsg(). We pass a whole struct sockaddr_can in
158 * skb->cb containing the interface index.
161 sock_skb_cb_check_size(sizeof(struct sockaddr_can));
162 addr = (struct sockaddr_can *)skb->cb;
163 memset(addr, 0, sizeof(*addr));
164 addr->can_family = AF_CAN;
165 addr->can_ifindex = skb->dev->ifindex;
167 /* add CAN specific message flags for raw_recvmsg() */
168 pflags = raw_flags(skb);
171 *pflags |= MSG_DONTROUTE;
173 *pflags |= MSG_CONFIRM;
175 if (sock_queue_rcv_skb(sk, skb) < 0)
179 static int raw_enable_filters(struct net *net, struct net_device *dev,
180 struct sock *sk, struct can_filter *filter,
186 for (i = 0; i < count; i++) {
187 err = can_rx_register(net, dev, filter[i].can_id,
189 raw_rcv, sk, "raw", sk);
191 /* clean up successfully registered filters */
193 can_rx_unregister(net, dev, filter[i].can_id,
203 static int raw_enable_errfilter(struct net *net, struct net_device *dev,
204 struct sock *sk, can_err_mask_t err_mask)
209 err = can_rx_register(net, dev, 0, err_mask | CAN_ERR_FLAG,
210 raw_rcv, sk, "raw", sk);
215 static void raw_disable_filters(struct net *net, struct net_device *dev,
216 struct sock *sk, struct can_filter *filter,
221 for (i = 0; i < count; i++)
222 can_rx_unregister(net, dev, filter[i].can_id,
223 filter[i].can_mask, raw_rcv, sk);
226 static inline void raw_disable_errfilter(struct net *net,
227 struct net_device *dev,
229 can_err_mask_t err_mask)
233 can_rx_unregister(net, dev, 0, err_mask | CAN_ERR_FLAG,
237 static inline void raw_disable_allfilters(struct net *net,
238 struct net_device *dev,
241 struct raw_sock *ro = raw_sk(sk);
243 raw_disable_filters(net, dev, sk, ro->filter, ro->count);
244 raw_disable_errfilter(net, dev, sk, ro->err_mask);
247 static int raw_enable_allfilters(struct net *net, struct net_device *dev,
250 struct raw_sock *ro = raw_sk(sk);
253 err = raw_enable_filters(net, dev, sk, ro->filter, ro->count);
255 err = raw_enable_errfilter(net, dev, sk, ro->err_mask);
257 raw_disable_filters(net, dev, sk, ro->filter,
264 static int raw_notifier(struct notifier_block *nb,
265 unsigned long msg, void *ptr)
267 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
268 struct raw_sock *ro = container_of(nb, struct raw_sock, notifier);
269 struct sock *sk = &ro->sk;
271 if (!net_eq(dev_net(dev), sock_net(sk)))
274 if (dev->type != ARPHRD_CAN)
277 if (ro->ifindex != dev->ifindex)
281 case NETDEV_UNREGISTER:
283 /* remove current filters & unregister */
285 raw_disable_allfilters(dev_net(dev), dev, sk);
296 if (!sock_flag(sk, SOCK_DEAD))
297 sk->sk_error_report(sk);
301 sk->sk_err = ENETDOWN;
302 if (!sock_flag(sk, SOCK_DEAD))
303 sk->sk_error_report(sk);
310 static int raw_init(struct sock *sk)
312 struct raw_sock *ro = raw_sk(sk);
317 /* set default filter to single entry dfilter */
318 ro->dfilter.can_id = 0;
319 ro->dfilter.can_mask = MASK_ALL;
320 ro->filter = &ro->dfilter;
323 /* set default loopback behaviour */
325 ro->recv_own_msgs = 0;
327 ro->join_filters = 0;
329 /* alloc_percpu provides zero'ed memory */
330 ro->uniq = alloc_percpu(struct uniqframe);
331 if (unlikely(!ro->uniq))
335 ro->notifier.notifier_call = raw_notifier;
337 register_netdevice_notifier(&ro->notifier);
342 static int raw_release(struct socket *sock)
344 struct sock *sk = sock->sk;
352 unregister_netdevice_notifier(&ro->notifier);
356 /* remove current filters & unregister */
359 struct net_device *dev;
361 dev = dev_get_by_index(sock_net(sk), ro->ifindex);
363 raw_disable_allfilters(dev_net(dev), dev, sk);
367 raw_disable_allfilters(sock_net(sk), NULL, sk);
377 free_percpu(ro->uniq);
388 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
390 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
391 struct sock *sk = sock->sk;
392 struct raw_sock *ro = raw_sk(sk);
395 int notify_enetdown = 0;
397 if (len < CAN_REQUIRED_SIZE(*addr, can_ifindex))
399 if (addr->can_family != AF_CAN)
404 if (ro->bound && addr->can_ifindex == ro->ifindex)
407 if (addr->can_ifindex) {
408 struct net_device *dev;
410 dev = dev_get_by_index(sock_net(sk), addr->can_ifindex);
415 if (dev->type != ARPHRD_CAN) {
420 if (!(dev->flags & IFF_UP))
423 ifindex = dev->ifindex;
425 /* filters set by default/setsockopt */
426 err = raw_enable_allfilters(sock_net(sk), dev, sk);
431 /* filters set by default/setsockopt */
432 err = raw_enable_allfilters(sock_net(sk), NULL, sk);
437 /* unregister old filters */
439 struct net_device *dev;
441 dev = dev_get_by_index(sock_net(sk),
444 raw_disable_allfilters(dev_net(dev),
449 raw_disable_allfilters(sock_net(sk), NULL, sk);
452 ro->ifindex = ifindex;
459 if (notify_enetdown) {
460 sk->sk_err = ENETDOWN;
461 if (!sock_flag(sk, SOCK_DEAD))
462 sk->sk_error_report(sk);
468 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
471 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
472 struct sock *sk = sock->sk;
473 struct raw_sock *ro = raw_sk(sk);
478 memset(addr, 0, sizeof(*addr));
479 addr->can_family = AF_CAN;
480 addr->can_ifindex = ro->ifindex;
482 return sizeof(*addr);
485 static int raw_setsockopt(struct socket *sock, int level, int optname,
486 sockptr_t optval, unsigned int optlen)
488 struct sock *sk = sock->sk;
489 struct raw_sock *ro = raw_sk(sk);
490 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
491 struct can_filter sfilter; /* single filter */
492 struct net_device *dev = NULL;
493 can_err_mask_t err_mask = 0;
497 if (level != SOL_CAN_RAW)
502 if (optlen % sizeof(struct can_filter) != 0)
505 if (optlen > CAN_RAW_FILTER_MAX * sizeof(struct can_filter))
508 count = optlen / sizeof(struct can_filter);
511 /* filter does not fit into dfilter => alloc space */
512 filter = memdup_sockptr(optval, optlen);
514 return PTR_ERR(filter);
515 } else if (count == 1) {
516 if (copy_from_sockptr(&sfilter, optval, sizeof(sfilter)))
522 if (ro->bound && ro->ifindex)
523 dev = dev_get_by_index(sock_net(sk), ro->ifindex);
526 /* (try to) register the new filters */
528 err = raw_enable_filters(sock_net(sk), dev, sk,
531 err = raw_enable_filters(sock_net(sk), dev, sk,
539 /* remove old filter registrations */
540 raw_disable_filters(sock_net(sk), dev, sk, ro->filter,
544 /* remove old filter space */
548 /* link new filters to the socket */
550 /* copy filter data for single filter */
551 ro->dfilter = sfilter;
552 filter = &ro->dfilter;
565 case CAN_RAW_ERR_FILTER:
566 if (optlen != sizeof(err_mask))
569 if (copy_from_sockptr(&err_mask, optval, optlen))
572 err_mask &= CAN_ERR_MASK;
576 if (ro->bound && ro->ifindex)
577 dev = dev_get_by_index(sock_net(sk), ro->ifindex);
579 /* remove current error mask */
581 /* (try to) register the new err_mask */
582 err = raw_enable_errfilter(sock_net(sk), dev, sk,
588 /* remove old err_mask registration */
589 raw_disable_errfilter(sock_net(sk), dev, sk,
593 /* link new err_mask to the socket */
594 ro->err_mask = err_mask;
604 case CAN_RAW_LOOPBACK:
605 if (optlen != sizeof(ro->loopback))
608 if (copy_from_sockptr(&ro->loopback, optval, optlen))
613 case CAN_RAW_RECV_OWN_MSGS:
614 if (optlen != sizeof(ro->recv_own_msgs))
617 if (copy_from_sockptr(&ro->recv_own_msgs, optval, optlen))
622 case CAN_RAW_FD_FRAMES:
623 if (optlen != sizeof(ro->fd_frames))
626 if (copy_from_sockptr(&ro->fd_frames, optval, optlen))
631 case CAN_RAW_JOIN_FILTERS:
632 if (optlen != sizeof(ro->join_filters))
635 if (copy_from_sockptr(&ro->join_filters, optval, optlen))
646 static int raw_getsockopt(struct socket *sock, int level, int optname,
647 char __user *optval, int __user *optlen)
649 struct sock *sk = sock->sk;
650 struct raw_sock *ro = raw_sk(sk);
655 if (level != SOL_CAN_RAW)
657 if (get_user(len, optlen))
666 int fsize = ro->count * sizeof(struct can_filter);
670 if (copy_to_user(optval, ro->filter, len))
678 err = put_user(len, optlen);
681 case CAN_RAW_ERR_FILTER:
682 if (len > sizeof(can_err_mask_t))
683 len = sizeof(can_err_mask_t);
687 case CAN_RAW_LOOPBACK:
688 if (len > sizeof(int))
693 case CAN_RAW_RECV_OWN_MSGS:
694 if (len > sizeof(int))
696 val = &ro->recv_own_msgs;
699 case CAN_RAW_FD_FRAMES:
700 if (len > sizeof(int))
702 val = &ro->fd_frames;
705 case CAN_RAW_JOIN_FILTERS:
706 if (len > sizeof(int))
708 val = &ro->join_filters;
715 if (put_user(len, optlen))
717 if (copy_to_user(optval, val, len))
722 static int raw_sendmsg(struct socket *sock, struct msghdr *msg, size_t size)
724 struct sock *sk = sock->sk;
725 struct raw_sock *ro = raw_sk(sk);
727 struct net_device *dev;
732 DECLARE_SOCKADDR(struct sockaddr_can *, addr, msg->msg_name);
734 if (msg->msg_namelen < CAN_REQUIRED_SIZE(*addr, can_ifindex))
737 if (addr->can_family != AF_CAN)
740 ifindex = addr->can_ifindex;
742 ifindex = ro->ifindex;
745 dev = dev_get_by_index(sock_net(sk), ifindex);
750 if (ro->fd_frames && dev->mtu == CANFD_MTU) {
751 if (unlikely(size != CANFD_MTU && size != CAN_MTU))
754 if (unlikely(size != CAN_MTU))
758 skb = sock_alloc_send_skb(sk, size + sizeof(struct can_skb_priv),
759 msg->msg_flags & MSG_DONTWAIT, &err);
763 can_skb_reserve(skb);
764 can_skb_prv(skb)->ifindex = dev->ifindex;
765 can_skb_prv(skb)->skbcnt = 0;
767 err = memcpy_from_msg(skb_put(skb, size), msg, size);
771 skb_setup_tx_timestamp(skb, sk->sk_tsflags);
775 skb->priority = sk->sk_priority;
777 err = can_send(skb, ro->loopback);
794 static int raw_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
797 struct sock *sk = sock->sk;
802 noblock = flags & MSG_DONTWAIT;
803 flags &= ~MSG_DONTWAIT;
805 if (flags & MSG_ERRQUEUE)
806 return sock_recv_errqueue(sk, msg, size,
807 SOL_CAN_RAW, SCM_CAN_RAW_ERRQUEUE);
809 skb = skb_recv_datagram(sk, flags, noblock, &err);
814 msg->msg_flags |= MSG_TRUNC;
818 err = memcpy_to_msg(msg, skb->data, size);
820 skb_free_datagram(sk, skb);
824 sock_recv_ts_and_drops(msg, sk, skb);
827 __sockaddr_check_size(sizeof(struct sockaddr_can));
828 msg->msg_namelen = sizeof(struct sockaddr_can);
829 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
832 /* assign the flags that have been recorded in raw_rcv() */
833 msg->msg_flags |= *(raw_flags(skb));
835 skb_free_datagram(sk, skb);
840 static int raw_sock_no_ioctlcmd(struct socket *sock, unsigned int cmd,
843 /* no ioctls for socket layer -> hand it down to NIC layer */
847 static const struct proto_ops raw_ops = {
849 .release = raw_release,
851 .connect = sock_no_connect,
852 .socketpair = sock_no_socketpair,
853 .accept = sock_no_accept,
854 .getname = raw_getname,
855 .poll = datagram_poll,
856 .ioctl = raw_sock_no_ioctlcmd,
857 .gettstamp = sock_gettstamp,
858 .listen = sock_no_listen,
859 .shutdown = sock_no_shutdown,
860 .setsockopt = raw_setsockopt,
861 .getsockopt = raw_getsockopt,
862 .sendmsg = raw_sendmsg,
863 .recvmsg = raw_recvmsg,
864 .mmap = sock_no_mmap,
865 .sendpage = sock_no_sendpage,
868 static struct proto raw_proto __read_mostly = {
870 .owner = THIS_MODULE,
871 .obj_size = sizeof(struct raw_sock),
875 static const struct can_proto raw_can_proto = {
882 static __init int raw_module_init(void)
886 pr_info("can: raw protocol\n");
888 err = can_proto_register(&raw_can_proto);
890 pr_err("can: registration of raw protocol failed\n");
895 static __exit void raw_module_exit(void)
897 can_proto_unregister(&raw_can_proto);
900 module_init(raw_module_init);
901 module_exit(raw_module_exit);