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/init.h>
46 #include <linux/uio.h>
47 #include <linux/net.h>
48 #include <linux/netdevice.h>
49 #include <linux/socket.h>
50 #include <linux/if_arp.h>
51 #include <linux/skbuff.h>
52 #include <linux/can.h>
53 #include <linux/can/core.h>
54 #include <linux/can/raw.h>
56 #include <net/net_namespace.h>
58 #define CAN_RAW_VERSION CAN_VERSION
59 static __initdata
const char banner
[] =
60 KERN_INFO
"can: raw protocol (rev " CAN_RAW_VERSION
")\n";
62 MODULE_DESCRIPTION("PF_CAN raw protocol");
63 MODULE_LICENSE("Dual BSD/GPL");
64 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>");
69 * A raw socket has a list of can_filters attached to it, each receiving
70 * the CAN frames matching that filter. If the filter list is empty,
71 * no CAN frames will be received by the socket. The default after
72 * opening the socket, is to have one filter which receives all frames.
73 * The filter list is allocated dynamically with the exception of the
74 * list containing only one item. This common case is optimized by
75 * storing the single filter in dfilter, to avoid using dynamic memory.
82 struct notifier_block notifier
;
85 int count
; /* number of active filters */
86 struct can_filter dfilter
; /* default/single filter */
87 struct can_filter
*filter
; /* pointer to filter(s) */
88 can_err_mask_t err_mask
;
91 static inline struct raw_sock
*raw_sk(const struct sock
*sk
)
93 return (struct raw_sock
*)sk
;
96 static void raw_rcv(struct sk_buff
*skb
, void *data
)
98 struct sock
*sk
= (struct sock
*)data
;
99 struct raw_sock
*ro
= raw_sk(sk
);
100 struct sockaddr_can
*addr
;
103 if (!ro
->recv_own_msgs
) {
104 /* check the received tx sock reference */
112 * Put the datagram to the queue so that raw_recvmsg() can
113 * get it from there. We need to pass the interface index to
114 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
115 * containing the interface index.
118 BUILD_BUG_ON(sizeof(skb
->cb
) < sizeof(struct sockaddr_can
));
119 addr
= (struct sockaddr_can
*)skb
->cb
;
120 memset(addr
, 0, sizeof(*addr
));
121 addr
->can_family
= AF_CAN
;
122 addr
->can_ifindex
= skb
->dev
->ifindex
;
124 error
= sock_queue_rcv_skb(sk
, skb
);
129 static int raw_enable_filters(struct net_device
*dev
, struct sock
*sk
,
130 struct can_filter
*filter
,
136 for (i
= 0; i
< count
; i
++) {
137 err
= can_rx_register(dev
, filter
[i
].can_id
,
141 /* clean up successfully registered filters */
143 can_rx_unregister(dev
, filter
[i
].can_id
,
153 static int raw_enable_errfilter(struct net_device
*dev
, struct sock
*sk
,
154 can_err_mask_t err_mask
)
159 err
= can_rx_register(dev
, 0, err_mask
| CAN_ERR_FLAG
,
165 static void raw_disable_filters(struct net_device
*dev
, struct sock
*sk
,
166 struct can_filter
*filter
,
171 for (i
= 0; i
< count
; i
++)
172 can_rx_unregister(dev
, filter
[i
].can_id
, filter
[i
].can_mask
,
176 static inline void raw_disable_errfilter(struct net_device
*dev
,
178 can_err_mask_t err_mask
)
182 can_rx_unregister(dev
, 0, err_mask
| CAN_ERR_FLAG
,
186 static inline void raw_disable_allfilters(struct net_device
*dev
,
189 struct raw_sock
*ro
= raw_sk(sk
);
191 raw_disable_filters(dev
, sk
, ro
->filter
, ro
->count
);
192 raw_disable_errfilter(dev
, sk
, ro
->err_mask
);
195 static int raw_enable_allfilters(struct net_device
*dev
, struct sock
*sk
)
197 struct raw_sock
*ro
= raw_sk(sk
);
200 err
= raw_enable_filters(dev
, sk
, ro
->filter
, ro
->count
);
202 err
= raw_enable_errfilter(dev
, sk
, ro
->err_mask
);
204 raw_disable_filters(dev
, sk
, ro
->filter
, ro
->count
);
210 static int raw_notifier(struct notifier_block
*nb
,
211 unsigned long msg
, void *data
)
213 struct net_device
*dev
= (struct net_device
*)data
;
214 struct raw_sock
*ro
= container_of(nb
, struct raw_sock
, notifier
);
215 struct sock
*sk
= &ro
->sk
;
217 if (dev
->nd_net
!= &init_net
)
220 if (dev
->type
!= ARPHRD_CAN
)
223 if (ro
->ifindex
!= dev
->ifindex
)
228 case NETDEV_UNREGISTER
:
230 /* remove current filters & unregister */
232 raw_disable_allfilters(dev
, sk
);
243 if (!sock_flag(sk
, SOCK_DEAD
))
244 sk
->sk_error_report(sk
);
248 sk
->sk_err
= ENETDOWN
;
249 if (!sock_flag(sk
, SOCK_DEAD
))
250 sk
->sk_error_report(sk
);
257 static int raw_init(struct sock
*sk
)
259 struct raw_sock
*ro
= raw_sk(sk
);
264 /* set default filter to single entry dfilter */
265 ro
->dfilter
.can_id
= 0;
266 ro
->dfilter
.can_mask
= MASK_ALL
;
267 ro
->filter
= &ro
->dfilter
;
270 /* set default loopback behaviour */
272 ro
->recv_own_msgs
= 0;
275 ro
->notifier
.notifier_call
= raw_notifier
;
277 register_netdevice_notifier(&ro
->notifier
);
282 static int raw_release(struct socket
*sock
)
284 struct sock
*sk
= sock
->sk
;
285 struct raw_sock
*ro
= raw_sk(sk
);
287 unregister_netdevice_notifier(&ro
->notifier
);
291 /* remove current filters & unregister */
294 struct net_device
*dev
;
296 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
298 raw_disable_allfilters(dev
, sk
);
302 raw_disable_allfilters(NULL
, sk
);
318 static int raw_bind(struct socket
*sock
, struct sockaddr
*uaddr
, int len
)
320 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
321 struct sock
*sk
= sock
->sk
;
322 struct raw_sock
*ro
= raw_sk(sk
);
325 int notify_enetdown
= 0;
327 if (len
< sizeof(*addr
))
332 if (ro
->bound
&& addr
->can_ifindex
== ro
->ifindex
)
335 if (addr
->can_ifindex
) {
336 struct net_device
*dev
;
338 dev
= dev_get_by_index(&init_net
, addr
->can_ifindex
);
343 if (dev
->type
!= ARPHRD_CAN
) {
348 if (!(dev
->flags
& IFF_UP
))
351 ifindex
= dev
->ifindex
;
353 /* filters set by default/setsockopt */
354 err
= raw_enable_allfilters(dev
, sk
);
360 /* filters set by default/setsockopt */
361 err
= raw_enable_allfilters(NULL
, sk
);
366 /* unregister old filters */
368 struct net_device
*dev
;
370 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
372 raw_disable_allfilters(dev
, sk
);
376 raw_disable_allfilters(NULL
, sk
);
378 ro
->ifindex
= ifindex
;
385 if (notify_enetdown
) {
386 sk
->sk_err
= ENETDOWN
;
387 if (!sock_flag(sk
, SOCK_DEAD
))
388 sk
->sk_error_report(sk
);
394 static int raw_getname(struct socket
*sock
, struct sockaddr
*uaddr
,
397 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
398 struct sock
*sk
= sock
->sk
;
399 struct raw_sock
*ro
= raw_sk(sk
);
404 addr
->can_family
= AF_CAN
;
405 addr
->can_ifindex
= ro
->ifindex
;
407 *len
= sizeof(*addr
);
412 static int raw_setsockopt(struct socket
*sock
, int level
, int optname
,
413 char __user
*optval
, int optlen
)
415 struct sock
*sk
= sock
->sk
;
416 struct raw_sock
*ro
= raw_sk(sk
);
417 struct can_filter
*filter
= NULL
; /* dyn. alloc'ed filters */
418 struct can_filter sfilter
; /* single filter */
419 struct net_device
*dev
= NULL
;
420 can_err_mask_t err_mask
= 0;
424 if (level
!= SOL_CAN_RAW
)
432 if (optlen
% sizeof(struct can_filter
) != 0)
435 count
= optlen
/ sizeof(struct can_filter
);
438 /* filter does not fit into dfilter => alloc space */
439 filter
= kmalloc(optlen
, GFP_KERNEL
);
443 err
= copy_from_user(filter
, optval
, optlen
);
448 } else if (count
== 1) {
449 err
= copy_from_user(&sfilter
, optval
, optlen
);
456 if (ro
->bound
&& ro
->ifindex
)
457 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
460 /* (try to) register the new filters */
462 err
= raw_enable_filters(dev
, sk
, &sfilter
, 1);
464 err
= raw_enable_filters(dev
, sk
, filter
,
473 /* remove old filter registrations */
474 raw_disable_filters(dev
, sk
, ro
->filter
, ro
->count
);
477 /* remove old filter space */
481 /* link new filters to the socket */
483 /* copy filter data for single filter */
484 ro
->dfilter
= sfilter
;
485 filter
= &ro
->dfilter
;
498 case CAN_RAW_ERR_FILTER
:
499 if (optlen
!= sizeof(err_mask
))
502 err
= copy_from_user(&err_mask
, optval
, optlen
);
506 err_mask
&= CAN_ERR_MASK
;
510 if (ro
->bound
&& ro
->ifindex
)
511 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
513 /* remove current error mask */
515 /* (try to) register the new err_mask */
516 err
= raw_enable_errfilter(dev
, sk
, err_mask
);
521 /* remove old err_mask registration */
522 raw_disable_errfilter(dev
, sk
, ro
->err_mask
);
525 /* link new err_mask to the socket */
526 ro
->err_mask
= err_mask
;
536 case CAN_RAW_LOOPBACK
:
537 if (optlen
!= sizeof(ro
->loopback
))
540 err
= copy_from_user(&ro
->loopback
, optval
, optlen
);
544 case CAN_RAW_RECV_OWN_MSGS
:
545 if (optlen
!= sizeof(ro
->recv_own_msgs
))
548 err
= copy_from_user(&ro
->recv_own_msgs
, optval
, optlen
);
558 static int raw_getsockopt(struct socket
*sock
, int level
, int optname
,
559 char __user
*optval
, int __user
*optlen
)
561 struct sock
*sk
= sock
->sk
;
562 struct raw_sock
*ro
= raw_sk(sk
);
567 if (level
!= SOL_CAN_RAW
)
569 if (get_user(len
, optlen
))
579 int fsize
= ro
->count
* sizeof(struct can_filter
);
582 err
= copy_to_user(optval
, ro
->filter
, len
);
588 err
= put_user(len
, optlen
);
591 case CAN_RAW_ERR_FILTER
:
592 if (len
> sizeof(can_err_mask_t
))
593 len
= sizeof(can_err_mask_t
);
597 case CAN_RAW_LOOPBACK
:
598 if (len
> sizeof(int))
603 case CAN_RAW_RECV_OWN_MSGS
:
604 if (len
> sizeof(int))
606 val
= &ro
->recv_own_msgs
;
613 if (put_user(len
, optlen
))
615 if (copy_to_user(optval
, val
, len
))
620 static int raw_sendmsg(struct kiocb
*iocb
, struct socket
*sock
,
621 struct msghdr
*msg
, size_t size
)
623 struct sock
*sk
= sock
->sk
;
624 struct raw_sock
*ro
= raw_sk(sk
);
626 struct net_device
*dev
;
631 struct sockaddr_can
*addr
=
632 (struct sockaddr_can
*)msg
->msg_name
;
634 if (addr
->can_family
!= AF_CAN
)
637 ifindex
= addr
->can_ifindex
;
639 ifindex
= ro
->ifindex
;
641 dev
= dev_get_by_index(&init_net
, ifindex
);
645 skb
= sock_alloc_send_skb(sk
, size
, msg
->msg_flags
& MSG_DONTWAIT
,
652 err
= memcpy_fromiovec(skb_put(skb
, size
), msg
->msg_iov
, size
);
661 err
= can_send(skb
, ro
->loopback
);
671 static int raw_recvmsg(struct kiocb
*iocb
, struct socket
*sock
,
672 struct msghdr
*msg
, size_t size
, int flags
)
674 struct sock
*sk
= sock
->sk
;
679 noblock
= flags
& MSG_DONTWAIT
;
680 flags
&= ~MSG_DONTWAIT
;
682 skb
= skb_recv_datagram(sk
, flags
, noblock
, &error
);
687 msg
->msg_flags
|= MSG_TRUNC
;
691 error
= memcpy_toiovec(msg
->msg_iov
, skb
->data
, size
);
693 skb_free_datagram(sk
, skb
);
697 sock_recv_timestamp(msg
, sk
, skb
);
700 msg
->msg_namelen
= sizeof(struct sockaddr_can
);
701 memcpy(msg
->msg_name
, skb
->cb
, msg
->msg_namelen
);
704 skb_free_datagram(sk
, skb
);
709 static struct proto_ops raw_ops __read_mostly
= {
711 .release
= raw_release
,
713 .connect
= sock_no_connect
,
714 .socketpair
= sock_no_socketpair
,
715 .accept
= sock_no_accept
,
716 .getname
= raw_getname
,
717 .poll
= datagram_poll
,
718 .ioctl
= NULL
, /* use can_ioctl() from af_can.c */
719 .listen
= sock_no_listen
,
720 .shutdown
= sock_no_shutdown
,
721 .setsockopt
= raw_setsockopt
,
722 .getsockopt
= raw_getsockopt
,
723 .sendmsg
= raw_sendmsg
,
724 .recvmsg
= raw_recvmsg
,
725 .mmap
= sock_no_mmap
,
726 .sendpage
= sock_no_sendpage
,
729 static struct proto raw_proto __read_mostly
= {
731 .owner
= THIS_MODULE
,
732 .obj_size
= sizeof(struct raw_sock
),
736 static struct can_proto raw_can_proto __read_mostly
= {
744 static __init
int raw_module_init(void)
750 err
= can_proto_register(&raw_can_proto
);
752 printk(KERN_ERR
"can: registration of raw protocol failed\n");
757 static __exit
void raw_module_exit(void)
759 can_proto_unregister(&raw_can_proto
);
762 module_init(raw_module_init
);
763 module_exit(raw_module_exit
);