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/dev.h> /* for can_is_canxl_dev_mtu() */
54 #include <linux/can/skb.h>
55 #include <linux/can/raw.h>
57 #include <net/net_namespace.h>
59 MODULE_DESCRIPTION("PF_CAN raw protocol");
60 MODULE_LICENSE("Dual BSD/GPL");
62 MODULE_ALIAS("can-proto-1");
64 #define RAW_MIN_NAMELEN CAN_REQUIRED_SIZE(struct sockaddr_can, can_ifindex)
68 /* A raw socket has a list of can_filters attached to it, each receiving
69 * the CAN frames matching that filter. If the filter list is empty,
70 * no CAN frames will be received by the socket. The default after
71 * opening the socket, is to have one filter which receives all frames.
72 * The filter list is allocated dynamically with the exception of the
73 * list containing only one item. This common case is optimized by
74 * storing the single filter in dfilter, to avoid using dynamic memory.
79 const struct sk_buff *skb;
80 unsigned int join_rx_count;
87 struct net_device *dev;
88 netdevice_tracker dev_tracker;
89 struct list_head notifier;
95 int count; /* number of active filters */
96 struct can_filter dfilter; /* default/single filter */
97 struct can_filter *filter; /* pointer to filter(s) */
98 can_err_mask_t err_mask;
99 struct uniqframe __percpu *uniq;
102 static LIST_HEAD(raw_notifier_list);
103 static DEFINE_SPINLOCK(raw_notifier_lock);
104 static struct raw_sock *raw_busy_notifier;
106 /* Return pointer to store the extra msg flags for raw_recvmsg().
107 * We use the space of one unsigned int beyond the 'struct sockaddr_can'
110 static inline unsigned int *raw_flags(struct sk_buff *skb)
112 sock_skb_cb_check_size(sizeof(struct sockaddr_can) +
113 sizeof(unsigned int));
115 /* return pointer after struct sockaddr_can */
116 return (unsigned int *)(&((struct sockaddr_can *)skb->cb)[1]);
119 static inline struct raw_sock *raw_sk(const struct sock *sk)
121 return (struct raw_sock *)sk;
124 static void raw_rcv(struct sk_buff *oskb, void *data)
126 struct sock *sk = (struct sock *)data;
127 struct raw_sock *ro = raw_sk(sk);
128 struct sockaddr_can *addr;
130 unsigned int *pflags;
132 /* check the received tx sock reference */
133 if (!ro->recv_own_msgs && oskb->sk == sk)
136 /* make sure to not pass oversized frames to the socket */
137 if ((!ro->fd_frames && can_is_canfd_skb(oskb)) ||
138 (!ro->xl_frames && can_is_canxl_skb(oskb)))
141 /* eliminate multiple filter matches for the same skb */
142 if (this_cpu_ptr(ro->uniq)->skb == oskb &&
143 this_cpu_ptr(ro->uniq)->skbcnt == can_skb_prv(oskb)->skbcnt) {
144 if (!ro->join_filters)
147 this_cpu_inc(ro->uniq->join_rx_count);
148 /* drop frame until all enabled filters matched */
149 if (this_cpu_ptr(ro->uniq)->join_rx_count < ro->count)
152 this_cpu_ptr(ro->uniq)->skb = oskb;
153 this_cpu_ptr(ro->uniq)->skbcnt = can_skb_prv(oskb)->skbcnt;
154 this_cpu_ptr(ro->uniq)->join_rx_count = 1;
155 /* drop first frame to check all enabled filters? */
156 if (ro->join_filters && ro->count > 1)
160 /* clone the given skb to be able to enqueue it into the rcv queue */
161 skb = skb_clone(oskb, GFP_ATOMIC);
165 /* Put the datagram to the queue so that raw_recvmsg() can get
166 * it from there. We need to pass the interface index to
167 * raw_recvmsg(). We pass a whole struct sockaddr_can in
168 * skb->cb containing the interface index.
171 sock_skb_cb_check_size(sizeof(struct sockaddr_can));
172 addr = (struct sockaddr_can *)skb->cb;
173 memset(addr, 0, sizeof(*addr));
174 addr->can_family = AF_CAN;
175 addr->can_ifindex = skb->dev->ifindex;
177 /* add CAN specific message flags for raw_recvmsg() */
178 pflags = raw_flags(skb);
181 *pflags |= MSG_DONTROUTE;
183 *pflags |= MSG_CONFIRM;
185 if (sock_queue_rcv_skb(sk, skb) < 0)
189 static int raw_enable_filters(struct net *net, struct net_device *dev,
190 struct sock *sk, struct can_filter *filter,
196 for (i = 0; i < count; i++) {
197 err = can_rx_register(net, dev, filter[i].can_id,
199 raw_rcv, sk, "raw", sk);
201 /* clean up successfully registered filters */
203 can_rx_unregister(net, dev, filter[i].can_id,
213 static int raw_enable_errfilter(struct net *net, struct net_device *dev,
214 struct sock *sk, can_err_mask_t err_mask)
219 err = can_rx_register(net, dev, 0, err_mask | CAN_ERR_FLAG,
220 raw_rcv, sk, "raw", sk);
225 static void raw_disable_filters(struct net *net, struct net_device *dev,
226 struct sock *sk, struct can_filter *filter,
231 for (i = 0; i < count; i++)
232 can_rx_unregister(net, dev, filter[i].can_id,
233 filter[i].can_mask, raw_rcv, sk);
236 static inline void raw_disable_errfilter(struct net *net,
237 struct net_device *dev,
239 can_err_mask_t err_mask)
243 can_rx_unregister(net, dev, 0, err_mask | CAN_ERR_FLAG,
247 static inline void raw_disable_allfilters(struct net *net,
248 struct net_device *dev,
251 struct raw_sock *ro = raw_sk(sk);
253 raw_disable_filters(net, dev, sk, ro->filter, ro->count);
254 raw_disable_errfilter(net, dev, sk, ro->err_mask);
257 static int raw_enable_allfilters(struct net *net, struct net_device *dev,
260 struct raw_sock *ro = raw_sk(sk);
263 err = raw_enable_filters(net, dev, sk, ro->filter, ro->count);
265 err = raw_enable_errfilter(net, dev, sk, ro->err_mask);
267 raw_disable_filters(net, dev, sk, ro->filter,
274 static void raw_notify(struct raw_sock *ro, unsigned long msg,
275 struct net_device *dev)
277 struct sock *sk = &ro->sk;
279 if (!net_eq(dev_net(dev), sock_net(sk)))
286 case NETDEV_UNREGISTER:
288 /* remove current filters & unregister */
290 raw_disable_allfilters(dev_net(dev), dev, sk);
291 netdev_put(dev, &ro->dev_tracker);
304 if (!sock_flag(sk, SOCK_DEAD))
309 sk->sk_err = ENETDOWN;
310 if (!sock_flag(sk, SOCK_DEAD))
316 static int raw_notifier(struct notifier_block *nb, unsigned long msg,
319 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
321 if (dev->type != ARPHRD_CAN)
323 if (msg != NETDEV_UNREGISTER && msg != NETDEV_DOWN)
325 if (unlikely(raw_busy_notifier)) /* Check for reentrant bug. */
328 spin_lock(&raw_notifier_lock);
329 list_for_each_entry(raw_busy_notifier, &raw_notifier_list, notifier) {
330 spin_unlock(&raw_notifier_lock);
331 raw_notify(raw_busy_notifier, msg, dev);
332 spin_lock(&raw_notifier_lock);
334 raw_busy_notifier = NULL;
335 spin_unlock(&raw_notifier_lock);
339 static int raw_init(struct sock *sk)
341 struct raw_sock *ro = raw_sk(sk);
347 /* set default filter to single entry dfilter */
348 ro->dfilter.can_id = 0;
349 ro->dfilter.can_mask = MASK_ALL;
350 ro->filter = &ro->dfilter;
353 /* set default loopback behaviour */
355 ro->recv_own_msgs = 0;
358 ro->join_filters = 0;
360 /* alloc_percpu provides zero'ed memory */
361 ro->uniq = alloc_percpu(struct uniqframe);
362 if (unlikely(!ro->uniq))
366 spin_lock(&raw_notifier_lock);
367 list_add_tail(&ro->notifier, &raw_notifier_list);
368 spin_unlock(&raw_notifier_lock);
373 static int raw_release(struct socket *sock)
375 struct sock *sk = sock->sk;
383 spin_lock(&raw_notifier_lock);
384 while (raw_busy_notifier == ro) {
385 spin_unlock(&raw_notifier_lock);
386 schedule_timeout_uninterruptible(1);
387 spin_lock(&raw_notifier_lock);
389 list_del(&ro->notifier);
390 spin_unlock(&raw_notifier_lock);
395 /* remove current filters & unregister */
398 raw_disable_allfilters(dev_net(ro->dev), ro->dev, sk);
399 netdev_put(ro->dev, &ro->dev_tracker);
401 raw_disable_allfilters(sock_net(sk), NULL, sk);
412 free_percpu(ro->uniq);
425 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
427 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
428 struct sock *sk = sock->sk;
429 struct raw_sock *ro = raw_sk(sk);
430 struct net_device *dev = NULL;
433 int notify_enetdown = 0;
435 if (len < RAW_MIN_NAMELEN)
437 if (addr->can_family != AF_CAN)
443 if (ro->bound && addr->can_ifindex == ro->ifindex)
446 if (addr->can_ifindex) {
447 dev = dev_get_by_index(sock_net(sk), addr->can_ifindex);
452 if (dev->type != ARPHRD_CAN) {
457 if (!(dev->flags & IFF_UP))
460 ifindex = dev->ifindex;
462 /* filters set by default/setsockopt */
463 err = raw_enable_allfilters(sock_net(sk), dev, sk);
470 /* filters set by default/setsockopt */
471 err = raw_enable_allfilters(sock_net(sk), NULL, sk);
476 /* unregister old filters */
478 raw_disable_allfilters(dev_net(ro->dev),
480 /* drop reference to old ro->dev */
481 netdev_put(ro->dev, &ro->dev_tracker);
483 raw_disable_allfilters(sock_net(sk), NULL, sk);
486 ro->ifindex = ifindex;
488 /* bind() ok -> hold a reference for new ro->dev */
491 netdev_hold(ro->dev, &ro->dev_tracker, GFP_KERNEL);
495 /* remove potential reference from dev_get_by_index() */
502 if (notify_enetdown) {
503 sk->sk_err = ENETDOWN;
504 if (!sock_flag(sk, SOCK_DEAD))
511 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
514 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
515 struct sock *sk = sock->sk;
516 struct raw_sock *ro = raw_sk(sk);
521 memset(addr, 0, RAW_MIN_NAMELEN);
522 addr->can_family = AF_CAN;
523 addr->can_ifindex = ro->ifindex;
525 return RAW_MIN_NAMELEN;
528 static int raw_setsockopt(struct socket *sock, int level, int optname,
529 sockptr_t optval, unsigned int optlen)
531 struct sock *sk = sock->sk;
532 struct raw_sock *ro = raw_sk(sk);
533 struct can_filter *filter = NULL; /* dyn. alloc'ed filters */
534 struct can_filter sfilter; /* single filter */
535 struct net_device *dev = NULL;
536 can_err_mask_t err_mask = 0;
541 if (level != SOL_CAN_RAW)
546 if (optlen % sizeof(struct can_filter) != 0)
549 if (optlen > CAN_RAW_FILTER_MAX * sizeof(struct can_filter))
552 count = optlen / sizeof(struct can_filter);
555 /* filter does not fit into dfilter => alloc space */
556 filter = memdup_sockptr(optval, optlen);
558 return PTR_ERR(filter);
559 } else if (count == 1) {
560 if (copy_from_sockptr(&sfilter, optval, sizeof(sfilter)))
568 if (ro->bound && dev) {
569 if (dev->reg_state != NETREG_REGISTERED) {
578 /* (try to) register the new filters */
580 err = raw_enable_filters(sock_net(sk), dev, sk,
583 err = raw_enable_filters(sock_net(sk), dev, sk,
591 /* remove old filter registrations */
592 raw_disable_filters(sock_net(sk), dev, sk, ro->filter,
596 /* remove old filter space */
600 /* link new filters to the socket */
602 /* copy filter data for single filter */
603 ro->dfilter = sfilter;
604 filter = &ro->dfilter;
615 case CAN_RAW_ERR_FILTER:
616 if (optlen != sizeof(err_mask))
619 if (copy_from_sockptr(&err_mask, optval, optlen))
622 err_mask &= CAN_ERR_MASK;
628 if (ro->bound && dev) {
629 if (dev->reg_state != NETREG_REGISTERED) {
635 /* remove current error mask */
637 /* (try to) register the new err_mask */
638 err = raw_enable_errfilter(sock_net(sk), dev, sk,
644 /* remove old err_mask registration */
645 raw_disable_errfilter(sock_net(sk), dev, sk,
649 /* link new err_mask to the socket */
650 ro->err_mask = err_mask;
658 case CAN_RAW_LOOPBACK:
659 if (optlen != sizeof(ro->loopback))
662 if (copy_from_sockptr(&ro->loopback, optval, optlen))
667 case CAN_RAW_RECV_OWN_MSGS:
668 if (optlen != sizeof(ro->recv_own_msgs))
671 if (copy_from_sockptr(&ro->recv_own_msgs, optval, optlen))
676 case CAN_RAW_FD_FRAMES:
677 if (optlen != sizeof(fd_frames))
680 if (copy_from_sockptr(&fd_frames, optval, optlen))
683 /* Enabling CAN XL includes CAN FD */
684 if (ro->xl_frames && !fd_frames)
687 ro->fd_frames = fd_frames;
690 case CAN_RAW_XL_FRAMES:
691 if (optlen != sizeof(ro->xl_frames))
694 if (copy_from_sockptr(&ro->xl_frames, optval, optlen))
697 /* Enabling CAN XL includes CAN FD */
699 ro->fd_frames = ro->xl_frames;
702 case CAN_RAW_JOIN_FILTERS:
703 if (optlen != sizeof(ro->join_filters))
706 if (copy_from_sockptr(&ro->join_filters, optval, optlen))
717 static int raw_getsockopt(struct socket *sock, int level, int optname,
718 char __user *optval, int __user *optlen)
720 struct sock *sk = sock->sk;
721 struct raw_sock *ro = raw_sk(sk);
726 if (level != SOL_CAN_RAW)
728 if (get_user(len, optlen))
737 int fsize = ro->count * sizeof(struct can_filter);
739 /* user space buffer to small for filter list? */
741 /* return -ERANGE and needed space in optlen */
743 if (put_user(fsize, optlen))
748 if (copy_to_user(optval, ro->filter, len))
757 err = put_user(len, optlen);
760 case CAN_RAW_ERR_FILTER:
761 if (len > sizeof(can_err_mask_t))
762 len = sizeof(can_err_mask_t);
766 case CAN_RAW_LOOPBACK:
767 if (len > sizeof(int))
772 case CAN_RAW_RECV_OWN_MSGS:
773 if (len > sizeof(int))
775 val = &ro->recv_own_msgs;
778 case CAN_RAW_FD_FRAMES:
779 if (len > sizeof(int))
781 val = &ro->fd_frames;
784 case CAN_RAW_XL_FRAMES:
785 if (len > sizeof(int))
787 val = &ro->xl_frames;
790 case CAN_RAW_JOIN_FILTERS:
791 if (len > sizeof(int))
793 val = &ro->join_filters;
800 if (put_user(len, optlen))
802 if (copy_to_user(optval, val, len))
807 static bool raw_bad_txframe(struct raw_sock *ro, struct sk_buff *skb, int mtu)
809 /* Classical CAN -> no checks for flags and device capabilities */
810 if (can_is_can_skb(skb))
813 /* CAN FD -> needs to be enabled and a CAN FD or CAN XL device */
814 if (ro->fd_frames && can_is_canfd_skb(skb) &&
815 (mtu == CANFD_MTU || can_is_canxl_dev_mtu(mtu)))
818 /* CAN XL -> needs to be enabled and a CAN XL device */
819 if (ro->xl_frames && can_is_canxl_skb(skb) &&
820 can_is_canxl_dev_mtu(mtu))
826 static int raw_sendmsg(struct socket *sock, struct msghdr *msg, size_t size)
828 struct sock *sk = sock->sk;
829 struct raw_sock *ro = raw_sk(sk);
830 struct sockcm_cookie sockc;
832 struct net_device *dev;
836 /* check for valid CAN frame sizes */
837 if (size < CANXL_HDR_SIZE + CANXL_MIN_DLEN || size > CANXL_MTU)
841 DECLARE_SOCKADDR(struct sockaddr_can *, addr, msg->msg_name);
843 if (msg->msg_namelen < RAW_MIN_NAMELEN)
846 if (addr->can_family != AF_CAN)
849 ifindex = addr->can_ifindex;
851 ifindex = ro->ifindex;
854 dev = dev_get_by_index(sock_net(sk), ifindex);
858 skb = sock_alloc_send_skb(sk, size + sizeof(struct can_skb_priv),
859 msg->msg_flags & MSG_DONTWAIT, &err);
863 can_skb_reserve(skb);
864 can_skb_prv(skb)->ifindex = dev->ifindex;
865 can_skb_prv(skb)->skbcnt = 0;
867 /* fill the skb before testing for valid CAN frames */
868 err = memcpy_from_msg(skb_put(skb, size), msg, size);
873 if (raw_bad_txframe(ro, skb, dev->mtu))
876 sockcm_init(&sockc, sk);
877 if (msg->msg_controllen) {
878 err = sock_cmsg_send(sk, msg, &sockc);
884 skb->priority = sk->sk_priority;
885 skb->mark = READ_ONCE(sk->sk_mark);
886 skb->tstamp = sockc.transmit_time;
888 skb_setup_tx_timestamp(skb, sockc.tsflags);
890 err = can_send(skb, ro->loopback);
907 static int raw_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
910 struct sock *sk = sock->sk;
914 if (flags & MSG_ERRQUEUE)
915 return sock_recv_errqueue(sk, msg, size,
916 SOL_CAN_RAW, SCM_CAN_RAW_ERRQUEUE);
918 skb = skb_recv_datagram(sk, flags, &err);
923 msg->msg_flags |= MSG_TRUNC;
927 err = memcpy_to_msg(msg, skb->data, size);
929 skb_free_datagram(sk, skb);
933 sock_recv_cmsgs(msg, sk, skb);
936 __sockaddr_check_size(RAW_MIN_NAMELEN);
937 msg->msg_namelen = RAW_MIN_NAMELEN;
938 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
941 /* assign the flags that have been recorded in raw_rcv() */
942 msg->msg_flags |= *(raw_flags(skb));
944 skb_free_datagram(sk, skb);
949 static int raw_sock_no_ioctlcmd(struct socket *sock, unsigned int cmd,
952 /* no ioctls for socket layer -> hand it down to NIC layer */
956 static const struct proto_ops raw_ops = {
958 .release = raw_release,
960 .connect = sock_no_connect,
961 .socketpair = sock_no_socketpair,
962 .accept = sock_no_accept,
963 .getname = raw_getname,
964 .poll = datagram_poll,
965 .ioctl = raw_sock_no_ioctlcmd,
966 .gettstamp = sock_gettstamp,
967 .listen = sock_no_listen,
968 .shutdown = sock_no_shutdown,
969 .setsockopt = raw_setsockopt,
970 .getsockopt = raw_getsockopt,
971 .sendmsg = raw_sendmsg,
972 .recvmsg = raw_recvmsg,
973 .mmap = sock_no_mmap,
976 static struct proto raw_proto __read_mostly = {
978 .owner = THIS_MODULE,
979 .obj_size = sizeof(struct raw_sock),
983 static const struct can_proto raw_can_proto = {
990 static struct notifier_block canraw_notifier = {
991 .notifier_call = raw_notifier
994 static __init int raw_module_init(void)
998 pr_info("can: raw protocol\n");
1000 err = register_netdevice_notifier(&canraw_notifier);
1004 err = can_proto_register(&raw_can_proto);
1006 pr_err("can: registration of raw protocol failed\n");
1007 goto register_proto_failed;
1012 register_proto_failed:
1013 unregister_netdevice_notifier(&canraw_notifier);
1017 static __exit void raw_module_exit(void)
1019 can_proto_unregister(&raw_can_proto);
1020 unregister_netdevice_notifier(&canraw_notifier);
1023 module_init(raw_module_init);
1024 module_exit(raw_module_exit);