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");
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 notifier_block notifier
;
92 int count
; /* number of active filters */
93 struct can_filter dfilter
; /* default/single filter */
94 struct can_filter
*filter
; /* pointer to filter(s) */
95 can_err_mask_t err_mask
;
96 struct uniqframe __percpu
*uniq
;
100 * Return pointer to store the extra msg flags for raw_recvmsg().
101 * We use the space of one unsigned int beyond the 'struct sockaddr_can'
104 static inline unsigned int *raw_flags(struct sk_buff
*skb
)
106 sock_skb_cb_check_size(sizeof(struct sockaddr_can
) +
107 sizeof(unsigned int));
109 /* return pointer after struct sockaddr_can */
110 return (unsigned int *)(&((struct sockaddr_can
*)skb
->cb
)[1]);
113 static inline struct raw_sock
*raw_sk(const struct sock
*sk
)
115 return (struct raw_sock
*)sk
;
118 static void raw_rcv(struct sk_buff
*oskb
, void *data
)
120 struct sock
*sk
= (struct sock
*)data
;
121 struct raw_sock
*ro
= raw_sk(sk
);
122 struct sockaddr_can
*addr
;
124 unsigned int *pflags
;
126 /* check the received tx sock reference */
127 if (!ro
->recv_own_msgs
&& oskb
->sk
== sk
)
130 /* do not pass non-CAN2.0 frames to a legacy socket */
131 if (!ro
->fd_frames
&& oskb
->len
!= CAN_MTU
)
134 /* eliminate multiple filter matches for the same skb */
135 if (this_cpu_ptr(ro
->uniq
)->skb
== oskb
&&
136 this_cpu_ptr(ro
->uniq
)->skbcnt
== can_skb_prv(oskb
)->skbcnt
) {
137 if (ro
->join_filters
) {
138 this_cpu_inc(ro
->uniq
->join_rx_count
);
139 /* drop frame until all enabled filters matched */
140 if (this_cpu_ptr(ro
->uniq
)->join_rx_count
< ro
->count
)
146 this_cpu_ptr(ro
->uniq
)->skb
= oskb
;
147 this_cpu_ptr(ro
->uniq
)->skbcnt
= can_skb_prv(oskb
)->skbcnt
;
148 this_cpu_ptr(ro
->uniq
)->join_rx_count
= 1;
149 /* drop first frame to check all enabled filters? */
150 if (ro
->join_filters
&& ro
->count
> 1)
154 /* clone the given skb to be able to enqueue it into the rcv queue */
155 skb
= skb_clone(oskb
, GFP_ATOMIC
);
160 * Put the datagram to the queue so that raw_recvmsg() can
161 * get it from there. We need to pass the interface index to
162 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
163 * containing the interface index.
166 sock_skb_cb_check_size(sizeof(struct sockaddr_can
));
167 addr
= (struct sockaddr_can
*)skb
->cb
;
168 memset(addr
, 0, sizeof(*addr
));
169 addr
->can_family
= AF_CAN
;
170 addr
->can_ifindex
= skb
->dev
->ifindex
;
172 /* add CAN specific message flags for raw_recvmsg() */
173 pflags
= raw_flags(skb
);
176 *pflags
|= MSG_DONTROUTE
;
178 *pflags
|= MSG_CONFIRM
;
180 if (sock_queue_rcv_skb(sk
, skb
) < 0)
184 static int raw_enable_filters(struct net
*net
, struct net_device
*dev
,
185 struct sock
*sk
, struct can_filter
*filter
,
191 for (i
= 0; i
< count
; i
++) {
192 err
= can_rx_register(net
, dev
, filter
[i
].can_id
,
194 raw_rcv
, sk
, "raw", sk
);
196 /* clean up successfully registered filters */
198 can_rx_unregister(net
, dev
, filter
[i
].can_id
,
208 static int raw_enable_errfilter(struct net
*net
, struct net_device
*dev
,
209 struct sock
*sk
, can_err_mask_t err_mask
)
214 err
= can_rx_register(net
, dev
, 0, err_mask
| CAN_ERR_FLAG
,
215 raw_rcv
, sk
, "raw", sk
);
220 static void raw_disable_filters(struct net
*net
, struct net_device
*dev
,
221 struct sock
*sk
, struct can_filter
*filter
,
226 for (i
= 0; i
< count
; i
++)
227 can_rx_unregister(net
, dev
, filter
[i
].can_id
,
228 filter
[i
].can_mask
, raw_rcv
, sk
);
231 static inline void raw_disable_errfilter(struct net
*net
,
232 struct net_device
*dev
,
234 can_err_mask_t err_mask
)
238 can_rx_unregister(net
, dev
, 0, err_mask
| CAN_ERR_FLAG
,
242 static inline void raw_disable_allfilters(struct net
*net
,
243 struct net_device
*dev
,
246 struct raw_sock
*ro
= raw_sk(sk
);
248 raw_disable_filters(net
, dev
, sk
, ro
->filter
, ro
->count
);
249 raw_disable_errfilter(net
, dev
, sk
, ro
->err_mask
);
252 static int raw_enable_allfilters(struct net
*net
, struct net_device
*dev
,
255 struct raw_sock
*ro
= raw_sk(sk
);
258 err
= raw_enable_filters(net
, dev
, sk
, ro
->filter
, ro
->count
);
260 err
= raw_enable_errfilter(net
, dev
, sk
, ro
->err_mask
);
262 raw_disable_filters(net
, dev
, sk
, ro
->filter
,
269 static int raw_notifier(struct notifier_block
*nb
,
270 unsigned long msg
, void *ptr
)
272 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
273 struct raw_sock
*ro
= container_of(nb
, struct raw_sock
, notifier
);
274 struct sock
*sk
= &ro
->sk
;
276 if (!net_eq(dev_net(dev
), sock_net(sk
)))
279 if (dev
->type
!= ARPHRD_CAN
)
282 if (ro
->ifindex
!= dev
->ifindex
)
287 case NETDEV_UNREGISTER
:
289 /* remove current filters & unregister */
291 raw_disable_allfilters(dev_net(dev
), dev
, sk
);
302 if (!sock_flag(sk
, SOCK_DEAD
))
303 sk
->sk_error_report(sk
);
307 sk
->sk_err
= ENETDOWN
;
308 if (!sock_flag(sk
, SOCK_DEAD
))
309 sk
->sk_error_report(sk
);
316 static int raw_init(struct sock
*sk
)
318 struct raw_sock
*ro
= raw_sk(sk
);
323 /* set default filter to single entry dfilter */
324 ro
->dfilter
.can_id
= 0;
325 ro
->dfilter
.can_mask
= MASK_ALL
;
326 ro
->filter
= &ro
->dfilter
;
329 /* set default loopback behaviour */
331 ro
->recv_own_msgs
= 0;
333 ro
->join_filters
= 0;
335 /* alloc_percpu provides zero'ed memory */
336 ro
->uniq
= alloc_percpu(struct uniqframe
);
337 if (unlikely(!ro
->uniq
))
341 ro
->notifier
.notifier_call
= raw_notifier
;
343 register_netdevice_notifier(&ro
->notifier
);
348 static int raw_release(struct socket
*sock
)
350 struct sock
*sk
= sock
->sk
;
358 unregister_netdevice_notifier(&ro
->notifier
);
362 /* remove current filters & unregister */
365 struct net_device
*dev
;
367 dev
= dev_get_by_index(sock_net(sk
), ro
->ifindex
);
369 raw_disable_allfilters(dev_net(dev
), dev
, sk
);
373 raw_disable_allfilters(sock_net(sk
), NULL
, sk
);
382 free_percpu(ro
->uniq
);
393 static int raw_bind(struct socket
*sock
, struct sockaddr
*uaddr
, int len
)
395 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
396 struct sock
*sk
= sock
->sk
;
397 struct raw_sock
*ro
= raw_sk(sk
);
400 int notify_enetdown
= 0;
402 if (len
< sizeof(*addr
))
407 if (ro
->bound
&& addr
->can_ifindex
== ro
->ifindex
)
410 if (addr
->can_ifindex
) {
411 struct net_device
*dev
;
413 dev
= dev_get_by_index(sock_net(sk
), addr
->can_ifindex
);
418 if (dev
->type
!= ARPHRD_CAN
) {
423 if (!(dev
->flags
& IFF_UP
))
426 ifindex
= dev
->ifindex
;
428 /* filters set by default/setsockopt */
429 err
= raw_enable_allfilters(sock_net(sk
), dev
, sk
);
434 /* filters set by default/setsockopt */
435 err
= raw_enable_allfilters(sock_net(sk
), NULL
, sk
);
440 /* unregister old filters */
442 struct net_device
*dev
;
444 dev
= dev_get_by_index(sock_net(sk
),
447 raw_disable_allfilters(dev_net(dev
),
452 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 *len
= sizeof(*addr
);
489 static int raw_setsockopt(struct socket
*sock
, int level
, int optname
,
490 char __user
*optval
, unsigned int optlen
)
492 struct sock
*sk
= sock
->sk
;
493 struct raw_sock
*ro
= raw_sk(sk
);
494 struct can_filter
*filter
= NULL
; /* dyn. alloc'ed filters */
495 struct can_filter sfilter
; /* single filter */
496 struct net_device
*dev
= NULL
;
497 can_err_mask_t err_mask
= 0;
501 if (level
!= SOL_CAN_RAW
)
507 if (optlen
% sizeof(struct can_filter
) != 0)
510 if (optlen
> CAN_RAW_FILTER_MAX
* sizeof(struct can_filter
))
513 count
= optlen
/ sizeof(struct can_filter
);
516 /* filter does not fit into dfilter => alloc space */
517 filter
= memdup_user(optval
, optlen
);
519 return PTR_ERR(filter
);
520 } else if (count
== 1) {
521 if (copy_from_user(&sfilter
, optval
, sizeof(sfilter
)))
527 if (ro
->bound
&& ro
->ifindex
)
528 dev
= dev_get_by_index(sock_net(sk
), ro
->ifindex
);
531 /* (try to) register the new filters */
533 err
= raw_enable_filters(sock_net(sk
), dev
, sk
,
536 err
= raw_enable_filters(sock_net(sk
), dev
, sk
,
544 /* remove old filter registrations */
545 raw_disable_filters(sock_net(sk
), dev
, sk
, ro
->filter
,
549 /* remove old filter space */
553 /* link new filters to the socket */
555 /* copy filter data for single filter */
556 ro
->dfilter
= sfilter
;
557 filter
= &ro
->dfilter
;
570 case CAN_RAW_ERR_FILTER
:
571 if (optlen
!= sizeof(err_mask
))
574 if (copy_from_user(&err_mask
, optval
, optlen
))
577 err_mask
&= CAN_ERR_MASK
;
581 if (ro
->bound
&& ro
->ifindex
)
582 dev
= dev_get_by_index(sock_net(sk
), ro
->ifindex
);
584 /* remove current error mask */
586 /* (try to) register the new err_mask */
587 err
= raw_enable_errfilter(sock_net(sk
), dev
, sk
,
593 /* remove old err_mask registration */
594 raw_disable_errfilter(sock_net(sk
), dev
, sk
,
598 /* link new err_mask to the socket */
599 ro
->err_mask
= err_mask
;
609 case CAN_RAW_LOOPBACK
:
610 if (optlen
!= sizeof(ro
->loopback
))
613 if (copy_from_user(&ro
->loopback
, optval
, optlen
))
618 case CAN_RAW_RECV_OWN_MSGS
:
619 if (optlen
!= sizeof(ro
->recv_own_msgs
))
622 if (copy_from_user(&ro
->recv_own_msgs
, optval
, optlen
))
627 case CAN_RAW_FD_FRAMES
:
628 if (optlen
!= sizeof(ro
->fd_frames
))
631 if (copy_from_user(&ro
->fd_frames
, optval
, optlen
))
636 case CAN_RAW_JOIN_FILTERS
:
637 if (optlen
!= sizeof(ro
->join_filters
))
640 if (copy_from_user(&ro
->join_filters
, optval
, optlen
))
651 static int raw_getsockopt(struct socket
*sock
, int level
, int optname
,
652 char __user
*optval
, int __user
*optlen
)
654 struct sock
*sk
= sock
->sk
;
655 struct raw_sock
*ro
= raw_sk(sk
);
660 if (level
!= SOL_CAN_RAW
)
662 if (get_user(len
, optlen
))
672 int fsize
= ro
->count
* sizeof(struct can_filter
);
675 if (copy_to_user(optval
, ro
->filter
, len
))
682 err
= put_user(len
, optlen
);
685 case CAN_RAW_ERR_FILTER
:
686 if (len
> sizeof(can_err_mask_t
))
687 len
= sizeof(can_err_mask_t
);
691 case CAN_RAW_LOOPBACK
:
692 if (len
> sizeof(int))
697 case CAN_RAW_RECV_OWN_MSGS
:
698 if (len
> sizeof(int))
700 val
= &ro
->recv_own_msgs
;
703 case CAN_RAW_FD_FRAMES
:
704 if (len
> sizeof(int))
706 val
= &ro
->fd_frames
;
709 case CAN_RAW_JOIN_FILTERS
:
710 if (len
> sizeof(int))
712 val
= &ro
->join_filters
;
719 if (put_user(len
, optlen
))
721 if (copy_to_user(optval
, val
, len
))
726 static int raw_sendmsg(struct socket
*sock
, struct msghdr
*msg
, size_t size
)
728 struct sock
*sk
= sock
->sk
;
729 struct raw_sock
*ro
= raw_sk(sk
);
731 struct net_device
*dev
;
736 DECLARE_SOCKADDR(struct sockaddr_can
*, addr
, msg
->msg_name
);
738 if (msg
->msg_namelen
< sizeof(*addr
))
741 if (addr
->can_family
!= AF_CAN
)
744 ifindex
= addr
->can_ifindex
;
746 ifindex
= ro
->ifindex
;
749 if (unlikely(size
!= CANFD_MTU
&& size
!= CAN_MTU
))
752 if (unlikely(size
!= CAN_MTU
))
756 dev
= dev_get_by_index(sock_net(sk
), ifindex
);
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 sock_tx_timestamp(sk
, sk
->sk_tsflags
, &skb_shinfo(skb
)->tx_flags
);
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 const struct proto_ops raw_ops
= {
840 .release
= raw_release
,
842 .connect
= sock_no_connect
,
843 .socketpair
= sock_no_socketpair
,
844 .accept
= sock_no_accept
,
845 .getname
= raw_getname
,
846 .poll
= datagram_poll
,
847 .ioctl
= can_ioctl
, /* use can_ioctl() from af_can.c */
848 .listen
= sock_no_listen
,
849 .shutdown
= sock_no_shutdown
,
850 .setsockopt
= raw_setsockopt
,
851 .getsockopt
= raw_getsockopt
,
852 .sendmsg
= raw_sendmsg
,
853 .recvmsg
= raw_recvmsg
,
854 .mmap
= sock_no_mmap
,
855 .sendpage
= sock_no_sendpage
,
858 static struct proto raw_proto __read_mostly
= {
860 .owner
= THIS_MODULE
,
861 .obj_size
= sizeof(struct raw_sock
),
865 static const struct can_proto raw_can_proto
= {
872 static __init
int raw_module_init(void)
876 pr_info("can: raw protocol (rev " CAN_RAW_VERSION
")\n");
878 err
= can_proto_register(&raw_can_proto
);
880 printk(KERN_ERR
"can: registration of raw protocol failed\n");
885 static __exit
void raw_module_exit(void)
887 can_proto_unregister(&raw_can_proto
);
890 module_init(raw_module_init
);
891 module_exit(raw_module_exit
);