1 // SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) 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 #define CAN_RAW_VERSION CAN_VERSION
60 MODULE_DESCRIPTION("PF_CAN raw protocol");
61 MODULE_LICENSE("Dual BSD/GPL");
62 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>");
63 MODULE_ALIAS("can-proto-1");
67 /* A raw socket has a list of can_filters attached to it, each receiving
68 * the CAN frames matching that filter. If the filter list is empty,
69 * no CAN frames will be received by the socket. The default after
70 * opening the socket, is to have one filter which receives all frames.
71 * The filter list is allocated dynamically with the exception of the
72 * list containing only one item. This common case is optimized by
73 * storing the single filter in dfilter, to avoid using dynamic memory.
78 const struct sk_buff
*skb
;
79 unsigned int join_rx_count
;
86 struct notifier_block notifier
;
91 int count
; /* number of active filters */
92 struct can_filter dfilter
; /* default/single filter */
93 struct can_filter
*filter
; /* pointer to filter(s) */
94 can_err_mask_t err_mask
;
95 struct uniqframe __percpu
*uniq
;
98 /* Return pointer to store the extra msg flags for raw_recvmsg().
99 * We use the space of one unsigned int beyond the 'struct sockaddr_can'
102 static inline unsigned int *raw_flags(struct sk_buff
*skb
)
104 sock_skb_cb_check_size(sizeof(struct sockaddr_can
) +
105 sizeof(unsigned int));
107 /* return pointer after struct sockaddr_can */
108 return (unsigned int *)(&((struct sockaddr_can
*)skb
->cb
)[1]);
111 static inline struct raw_sock
*raw_sk(const struct sock
*sk
)
113 return (struct raw_sock
*)sk
;
116 static void raw_rcv(struct sk_buff
*oskb
, void *data
)
118 struct sock
*sk
= (struct sock
*)data
;
119 struct raw_sock
*ro
= raw_sk(sk
);
120 struct sockaddr_can
*addr
;
122 unsigned int *pflags
;
124 /* check the received tx sock reference */
125 if (!ro
->recv_own_msgs
&& oskb
->sk
== sk
)
128 /* do not pass non-CAN2.0 frames to a legacy socket */
129 if (!ro
->fd_frames
&& oskb
->len
!= CAN_MTU
)
132 /* eliminate multiple filter matches for the same skb */
133 if (this_cpu_ptr(ro
->uniq
)->skb
== oskb
&&
134 this_cpu_ptr(ro
->uniq
)->skbcnt
== can_skb_prv(oskb
)->skbcnt
) {
135 if (ro
->join_filters
) {
136 this_cpu_inc(ro
->uniq
->join_rx_count
);
137 /* drop frame until all enabled filters matched */
138 if (this_cpu_ptr(ro
->uniq
)->join_rx_count
< ro
->count
)
144 this_cpu_ptr(ro
->uniq
)->skb
= oskb
;
145 this_cpu_ptr(ro
->uniq
)->skbcnt
= can_skb_prv(oskb
)->skbcnt
;
146 this_cpu_ptr(ro
->uniq
)->join_rx_count
= 1;
147 /* drop first frame to check all enabled filters? */
148 if (ro
->join_filters
&& ro
->count
> 1)
152 /* clone the given skb to be able to enqueue it into the rcv queue */
153 skb
= skb_clone(oskb
, GFP_ATOMIC
);
157 /* Put the datagram to the queue so that raw_recvmsg() can
158 * get it from there. We need to pass the interface index to
159 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
160 * containing the interface index.
163 sock_skb_cb_check_size(sizeof(struct sockaddr_can
));
164 addr
= (struct sockaddr_can
*)skb
->cb
;
165 memset(addr
, 0, sizeof(*addr
));
166 addr
->can_family
= AF_CAN
;
167 addr
->can_ifindex
= skb
->dev
->ifindex
;
169 /* add CAN specific message flags for raw_recvmsg() */
170 pflags
= raw_flags(skb
);
173 *pflags
|= MSG_DONTROUTE
;
175 *pflags
|= MSG_CONFIRM
;
177 if (sock_queue_rcv_skb(sk
, skb
) < 0)
181 static int raw_enable_filters(struct net
*net
, struct net_device
*dev
,
182 struct sock
*sk
, struct can_filter
*filter
,
188 for (i
= 0; i
< count
; i
++) {
189 err
= can_rx_register(net
, dev
, filter
[i
].can_id
,
191 raw_rcv
, sk
, "raw", sk
);
193 /* clean up successfully registered filters */
195 can_rx_unregister(net
, dev
, filter
[i
].can_id
,
205 static int raw_enable_errfilter(struct net
*net
, struct net_device
*dev
,
206 struct sock
*sk
, can_err_mask_t err_mask
)
211 err
= can_rx_register(net
, dev
, 0, err_mask
| CAN_ERR_FLAG
,
212 raw_rcv
, sk
, "raw", sk
);
217 static void raw_disable_filters(struct net
*net
, struct net_device
*dev
,
218 struct sock
*sk
, struct can_filter
*filter
,
223 for (i
= 0; i
< count
; i
++)
224 can_rx_unregister(net
, dev
, filter
[i
].can_id
,
225 filter
[i
].can_mask
, raw_rcv
, sk
);
228 static inline void raw_disable_errfilter(struct net
*net
,
229 struct net_device
*dev
,
231 can_err_mask_t err_mask
)
235 can_rx_unregister(net
, dev
, 0, err_mask
| CAN_ERR_FLAG
,
239 static inline void raw_disable_allfilters(struct net
*net
,
240 struct net_device
*dev
,
243 struct raw_sock
*ro
= raw_sk(sk
);
245 raw_disable_filters(net
, dev
, sk
, ro
->filter
, ro
->count
);
246 raw_disable_errfilter(net
, dev
, sk
, ro
->err_mask
);
249 static int raw_enable_allfilters(struct net
*net
, struct net_device
*dev
,
252 struct raw_sock
*ro
= raw_sk(sk
);
255 err
= raw_enable_filters(net
, dev
, sk
, ro
->filter
, ro
->count
);
257 err
= raw_enable_errfilter(net
, dev
, sk
, ro
->err_mask
);
259 raw_disable_filters(net
, dev
, sk
, ro
->filter
,
266 static int raw_notifier(struct notifier_block
*nb
,
267 unsigned long msg
, void *ptr
)
269 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
270 struct raw_sock
*ro
= container_of(nb
, struct raw_sock
, notifier
);
271 struct sock
*sk
= &ro
->sk
;
273 if (!net_eq(dev_net(dev
), sock_net(sk
)))
276 if (dev
->type
!= ARPHRD_CAN
)
279 if (ro
->ifindex
!= dev
->ifindex
)
283 case NETDEV_UNREGISTER
:
285 /* remove current filters & unregister */
287 raw_disable_allfilters(dev_net(dev
), 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
);
319 /* set default filter to single entry dfilter */
320 ro
->dfilter
.can_id
= 0;
321 ro
->dfilter
.can_mask
= MASK_ALL
;
322 ro
->filter
= &ro
->dfilter
;
325 /* set default loopback behaviour */
327 ro
->recv_own_msgs
= 0;
329 ro
->join_filters
= 0;
331 /* alloc_percpu provides zero'ed memory */
332 ro
->uniq
= alloc_percpu(struct uniqframe
);
333 if (unlikely(!ro
->uniq
))
337 ro
->notifier
.notifier_call
= raw_notifier
;
339 register_netdevice_notifier(&ro
->notifier
);
344 static int raw_release(struct socket
*sock
)
346 struct sock
*sk
= sock
->sk
;
354 unregister_netdevice_notifier(&ro
->notifier
);
358 /* remove current filters & unregister */
361 struct net_device
*dev
;
363 dev
= dev_get_by_index(sock_net(sk
), ro
->ifindex
);
365 raw_disable_allfilters(dev_net(dev
), dev
, sk
);
369 raw_disable_allfilters(sock_net(sk
), NULL
, sk
);
379 free_percpu(ro
->uniq
);
390 static int raw_bind(struct socket
*sock
, struct sockaddr
*uaddr
, int len
)
392 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
393 struct sock
*sk
= sock
->sk
;
394 struct raw_sock
*ro
= raw_sk(sk
);
397 int notify_enetdown
= 0;
399 if (len
< CAN_REQUIRED_SIZE(*addr
, can_ifindex
))
401 if (addr
->can_family
!= AF_CAN
)
406 if (ro
->bound
&& addr
->can_ifindex
== ro
->ifindex
)
409 if (addr
->can_ifindex
) {
410 struct net_device
*dev
;
412 dev
= dev_get_by_index(sock_net(sk
), addr
->can_ifindex
);
417 if (dev
->type
!= ARPHRD_CAN
) {
422 if (!(dev
->flags
& IFF_UP
))
425 ifindex
= dev
->ifindex
;
427 /* filters set by default/setsockopt */
428 err
= raw_enable_allfilters(sock_net(sk
), dev
, sk
);
433 /* filters set by default/setsockopt */
434 err
= raw_enable_allfilters(sock_net(sk
), NULL
, sk
);
439 /* unregister old filters */
441 struct net_device
*dev
;
443 dev
= dev_get_by_index(sock_net(sk
),
446 raw_disable_allfilters(dev_net(dev
),
451 raw_disable_allfilters(sock_net(sk
), NULL
, sk
);
454 ro
->ifindex
= ifindex
;
461 if (notify_enetdown
) {
462 sk
->sk_err
= ENETDOWN
;
463 if (!sock_flag(sk
, SOCK_DEAD
))
464 sk
->sk_error_report(sk
);
470 static int raw_getname(struct socket
*sock
, struct sockaddr
*uaddr
,
473 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
474 struct sock
*sk
= sock
->sk
;
475 struct raw_sock
*ro
= raw_sk(sk
);
480 memset(addr
, 0, sizeof(*addr
));
481 addr
->can_family
= AF_CAN
;
482 addr
->can_ifindex
= ro
->ifindex
;
484 return sizeof(*addr
);
487 static int raw_setsockopt(struct socket
*sock
, int level
, int optname
,
488 char __user
*optval
, unsigned int optlen
)
490 struct sock
*sk
= sock
->sk
;
491 struct raw_sock
*ro
= raw_sk(sk
);
492 struct can_filter
*filter
= NULL
; /* dyn. alloc'ed filters */
493 struct can_filter sfilter
; /* single filter */
494 struct net_device
*dev
= NULL
;
495 can_err_mask_t err_mask
= 0;
499 if (level
!= SOL_CAN_RAW
)
504 if (optlen
% sizeof(struct can_filter
) != 0)
507 if (optlen
> CAN_RAW_FILTER_MAX
* sizeof(struct can_filter
))
510 count
= optlen
/ sizeof(struct can_filter
);
513 /* filter does not fit into dfilter => alloc space */
514 filter
= memdup_user(optval
, optlen
);
516 return PTR_ERR(filter
);
517 } else if (count
== 1) {
518 if (copy_from_user(&sfilter
, optval
, sizeof(sfilter
)))
524 if (ro
->bound
&& ro
->ifindex
)
525 dev
= dev_get_by_index(sock_net(sk
), ro
->ifindex
);
528 /* (try to) register the new filters */
530 err
= raw_enable_filters(sock_net(sk
), dev
, sk
,
533 err
= raw_enable_filters(sock_net(sk
), dev
, sk
,
541 /* remove old filter registrations */
542 raw_disable_filters(sock_net(sk
), dev
, sk
, ro
->filter
,
546 /* remove old filter space */
550 /* link new filters to the socket */
552 /* copy filter data for single filter */
553 ro
->dfilter
= sfilter
;
554 filter
= &ro
->dfilter
;
567 case CAN_RAW_ERR_FILTER
:
568 if (optlen
!= sizeof(err_mask
))
571 if (copy_from_user(&err_mask
, optval
, optlen
))
574 err_mask
&= CAN_ERR_MASK
;
578 if (ro
->bound
&& ro
->ifindex
)
579 dev
= dev_get_by_index(sock_net(sk
), ro
->ifindex
);
581 /* remove current error mask */
583 /* (try to) register the new err_mask */
584 err
= raw_enable_errfilter(sock_net(sk
), dev
, sk
,
590 /* remove old err_mask registration */
591 raw_disable_errfilter(sock_net(sk
), dev
, sk
,
595 /* link new err_mask to the socket */
596 ro
->err_mask
= err_mask
;
606 case CAN_RAW_LOOPBACK
:
607 if (optlen
!= sizeof(ro
->loopback
))
610 if (copy_from_user(&ro
->loopback
, optval
, optlen
))
615 case CAN_RAW_RECV_OWN_MSGS
:
616 if (optlen
!= sizeof(ro
->recv_own_msgs
))
619 if (copy_from_user(&ro
->recv_own_msgs
, optval
, optlen
))
624 case CAN_RAW_FD_FRAMES
:
625 if (optlen
!= sizeof(ro
->fd_frames
))
628 if (copy_from_user(&ro
->fd_frames
, optval
, optlen
))
633 case CAN_RAW_JOIN_FILTERS
:
634 if (optlen
!= sizeof(ro
->join_filters
))
637 if (copy_from_user(&ro
->join_filters
, optval
, optlen
))
648 static int raw_getsockopt(struct socket
*sock
, int level
, int optname
,
649 char __user
*optval
, int __user
*optlen
)
651 struct sock
*sk
= sock
->sk
;
652 struct raw_sock
*ro
= raw_sk(sk
);
657 if (level
!= SOL_CAN_RAW
)
659 if (get_user(len
, optlen
))
668 int fsize
= ro
->count
* sizeof(struct can_filter
);
672 if (copy_to_user(optval
, ro
->filter
, len
))
680 err
= put_user(len
, optlen
);
683 case CAN_RAW_ERR_FILTER
:
684 if (len
> sizeof(can_err_mask_t
))
685 len
= sizeof(can_err_mask_t
);
689 case CAN_RAW_LOOPBACK
:
690 if (len
> sizeof(int))
695 case CAN_RAW_RECV_OWN_MSGS
:
696 if (len
> sizeof(int))
698 val
= &ro
->recv_own_msgs
;
701 case CAN_RAW_FD_FRAMES
:
702 if (len
> sizeof(int))
704 val
= &ro
->fd_frames
;
707 case CAN_RAW_JOIN_FILTERS
:
708 if (len
> sizeof(int))
710 val
= &ro
->join_filters
;
717 if (put_user(len
, optlen
))
719 if (copy_to_user(optval
, val
, len
))
724 static int raw_sendmsg(struct socket
*sock
, struct msghdr
*msg
, size_t size
)
726 struct sock
*sk
= sock
->sk
;
727 struct raw_sock
*ro
= raw_sk(sk
);
729 struct net_device
*dev
;
734 DECLARE_SOCKADDR(struct sockaddr_can
*, addr
, msg
->msg_name
);
736 if (msg
->msg_namelen
< CAN_REQUIRED_SIZE(*addr
, can_ifindex
))
739 if (addr
->can_family
!= AF_CAN
)
742 ifindex
= addr
->can_ifindex
;
744 ifindex
= ro
->ifindex
;
747 dev
= dev_get_by_index(sock_net(sk
), ifindex
);
752 if (ro
->fd_frames
&& dev
->mtu
== CANFD_MTU
) {
753 if (unlikely(size
!= CANFD_MTU
&& size
!= CAN_MTU
))
756 if (unlikely(size
!= CAN_MTU
))
760 skb
= sock_alloc_send_skb(sk
, size
+ sizeof(struct can_skb_priv
),
761 msg
->msg_flags
& MSG_DONTWAIT
, &err
);
765 can_skb_reserve(skb
);
766 can_skb_prv(skb
)->ifindex
= dev
->ifindex
;
767 can_skb_prv(skb
)->skbcnt
= 0;
769 err
= memcpy_from_msg(skb_put(skb
, size
), msg
, size
);
773 skb_setup_tx_timestamp(skb
, sk
->sk_tsflags
);
777 skb
->priority
= sk
->sk_priority
;
779 err
= can_send(skb
, ro
->loopback
);
796 static int raw_recvmsg(struct socket
*sock
, struct msghdr
*msg
, size_t size
,
799 struct sock
*sk
= sock
->sk
;
804 noblock
= flags
& MSG_DONTWAIT
;
805 flags
&= ~MSG_DONTWAIT
;
807 skb
= skb_recv_datagram(sk
, flags
, noblock
, &err
);
812 msg
->msg_flags
|= MSG_TRUNC
;
816 err
= memcpy_to_msg(msg
, skb
->data
, size
);
818 skb_free_datagram(sk
, skb
);
822 sock_recv_ts_and_drops(msg
, sk
, skb
);
825 __sockaddr_check_size(sizeof(struct sockaddr_can
));
826 msg
->msg_namelen
= sizeof(struct sockaddr_can
);
827 memcpy(msg
->msg_name
, skb
->cb
, msg
->msg_namelen
);
830 /* assign the flags that have been recorded in raw_rcv() */
831 msg
->msg_flags
|= *(raw_flags(skb
));
833 skb_free_datagram(sk
, skb
);
838 static int raw_sock_no_ioctlcmd(struct socket
*sock
, unsigned int cmd
,
841 /* no ioctls for socket layer -> hand it down to NIC layer */
845 static const struct proto_ops raw_ops
= {
847 .release
= raw_release
,
849 .connect
= sock_no_connect
,
850 .socketpair
= sock_no_socketpair
,
851 .accept
= sock_no_accept
,
852 .getname
= raw_getname
,
853 .poll
= datagram_poll
,
854 .ioctl
= raw_sock_no_ioctlcmd
,
855 .gettstamp
= sock_gettstamp
,
856 .listen
= sock_no_listen
,
857 .shutdown
= sock_no_shutdown
,
858 .setsockopt
= raw_setsockopt
,
859 .getsockopt
= raw_getsockopt
,
860 .sendmsg
= raw_sendmsg
,
861 .recvmsg
= raw_recvmsg
,
862 .mmap
= sock_no_mmap
,
863 .sendpage
= sock_no_sendpage
,
866 static struct proto raw_proto __read_mostly
= {
868 .owner
= THIS_MODULE
,
869 .obj_size
= sizeof(struct raw_sock
),
873 static const struct can_proto raw_can_proto
= {
880 static __init
int raw_module_init(void)
884 pr_info("can: raw protocol (rev " CAN_RAW_VERSION
")\n");
886 err
= can_proto_register(&raw_can_proto
);
888 pr_err("can: registration of raw protocol failed\n");
893 static __exit
void raw_module_exit(void)
895 can_proto_unregister(&raw_can_proto
);
898 module_init(raw_module_init
);
899 module_exit(raw_module_exit
);