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
;
102 if (!ro
->recv_own_msgs
) {
103 /* check the received tx sock reference */
111 * Put the datagram to the queue so that raw_recvmsg() can
112 * get it from there. We need to pass the interface index to
113 * raw_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
114 * containing the interface index.
117 BUILD_BUG_ON(sizeof(skb
->cb
) < sizeof(struct sockaddr_can
));
118 addr
= (struct sockaddr_can
*)skb
->cb
;
119 memset(addr
, 0, sizeof(*addr
));
120 addr
->can_family
= AF_CAN
;
121 addr
->can_ifindex
= skb
->dev
->ifindex
;
123 if (sock_queue_rcv_skb(sk
, skb
) < 0)
127 static int raw_enable_filters(struct net_device
*dev
, struct sock
*sk
,
128 struct can_filter
*filter
, int count
)
133 for (i
= 0; i
< count
; i
++) {
134 err
= can_rx_register(dev
, filter
[i
].can_id
,
138 /* clean up successfully registered filters */
140 can_rx_unregister(dev
, filter
[i
].can_id
,
150 static int raw_enable_errfilter(struct net_device
*dev
, struct sock
*sk
,
151 can_err_mask_t err_mask
)
156 err
= can_rx_register(dev
, 0, err_mask
| CAN_ERR_FLAG
,
162 static void raw_disable_filters(struct net_device
*dev
, struct sock
*sk
,
163 struct can_filter
*filter
, int count
)
167 for (i
= 0; i
< count
; i
++)
168 can_rx_unregister(dev
, filter
[i
].can_id
, filter
[i
].can_mask
,
172 static inline void raw_disable_errfilter(struct net_device
*dev
,
174 can_err_mask_t err_mask
)
178 can_rx_unregister(dev
, 0, err_mask
| CAN_ERR_FLAG
,
182 static inline void raw_disable_allfilters(struct net_device
*dev
,
185 struct raw_sock
*ro
= raw_sk(sk
);
187 raw_disable_filters(dev
, sk
, ro
->filter
, ro
->count
);
188 raw_disable_errfilter(dev
, sk
, ro
->err_mask
);
191 static int raw_enable_allfilters(struct net_device
*dev
, struct sock
*sk
)
193 struct raw_sock
*ro
= raw_sk(sk
);
196 err
= raw_enable_filters(dev
, sk
, ro
->filter
, ro
->count
);
198 err
= raw_enable_errfilter(dev
, sk
, ro
->err_mask
);
200 raw_disable_filters(dev
, sk
, ro
->filter
, ro
->count
);
206 static int raw_notifier(struct notifier_block
*nb
,
207 unsigned long msg
, void *data
)
209 struct net_device
*dev
= (struct net_device
*)data
;
210 struct raw_sock
*ro
= container_of(nb
, struct raw_sock
, notifier
);
211 struct sock
*sk
= &ro
->sk
;
213 if (dev
->nd_net
!= &init_net
)
216 if (dev
->type
!= ARPHRD_CAN
)
219 if (ro
->ifindex
!= dev
->ifindex
)
224 case NETDEV_UNREGISTER
:
226 /* remove current filters & unregister */
228 raw_disable_allfilters(dev
, sk
);
239 if (!sock_flag(sk
, SOCK_DEAD
))
240 sk
->sk_error_report(sk
);
244 sk
->sk_err
= ENETDOWN
;
245 if (!sock_flag(sk
, SOCK_DEAD
))
246 sk
->sk_error_report(sk
);
253 static int raw_init(struct sock
*sk
)
255 struct raw_sock
*ro
= raw_sk(sk
);
260 /* set default filter to single entry dfilter */
261 ro
->dfilter
.can_id
= 0;
262 ro
->dfilter
.can_mask
= MASK_ALL
;
263 ro
->filter
= &ro
->dfilter
;
266 /* set default loopback behaviour */
268 ro
->recv_own_msgs
= 0;
271 ro
->notifier
.notifier_call
= raw_notifier
;
273 register_netdevice_notifier(&ro
->notifier
);
278 static int raw_release(struct socket
*sock
)
280 struct sock
*sk
= sock
->sk
;
281 struct raw_sock
*ro
= raw_sk(sk
);
283 unregister_netdevice_notifier(&ro
->notifier
);
287 /* remove current filters & unregister */
290 struct net_device
*dev
;
292 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
294 raw_disable_allfilters(dev
, sk
);
298 raw_disable_allfilters(NULL
, sk
);
314 static int raw_bind(struct socket
*sock
, struct sockaddr
*uaddr
, int len
)
316 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
317 struct sock
*sk
= sock
->sk
;
318 struct raw_sock
*ro
= raw_sk(sk
);
321 int notify_enetdown
= 0;
323 if (len
< sizeof(*addr
))
328 if (ro
->bound
&& addr
->can_ifindex
== ro
->ifindex
)
331 if (addr
->can_ifindex
) {
332 struct net_device
*dev
;
334 dev
= dev_get_by_index(&init_net
, addr
->can_ifindex
);
339 if (dev
->type
!= ARPHRD_CAN
) {
344 if (!(dev
->flags
& IFF_UP
))
347 ifindex
= dev
->ifindex
;
349 /* filters set by default/setsockopt */
350 err
= raw_enable_allfilters(dev
, sk
);
355 /* filters set by default/setsockopt */
356 err
= raw_enable_allfilters(NULL
, sk
);
361 /* unregister old filters */
363 struct net_device
*dev
;
365 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
367 raw_disable_allfilters(dev
, sk
);
371 raw_disable_allfilters(NULL
, sk
);
373 ro
->ifindex
= ifindex
;
380 if (notify_enetdown
) {
381 sk
->sk_err
= ENETDOWN
;
382 if (!sock_flag(sk
, SOCK_DEAD
))
383 sk
->sk_error_report(sk
);
389 static int raw_getname(struct socket
*sock
, struct sockaddr
*uaddr
,
392 struct sockaddr_can
*addr
= (struct sockaddr_can
*)uaddr
;
393 struct sock
*sk
= sock
->sk
;
394 struct raw_sock
*ro
= raw_sk(sk
);
399 addr
->can_family
= AF_CAN
;
400 addr
->can_ifindex
= ro
->ifindex
;
402 *len
= sizeof(*addr
);
407 static int raw_setsockopt(struct socket
*sock
, int level
, int optname
,
408 char __user
*optval
, int optlen
)
410 struct sock
*sk
= sock
->sk
;
411 struct raw_sock
*ro
= raw_sk(sk
);
412 struct can_filter
*filter
= NULL
; /* dyn. alloc'ed filters */
413 struct can_filter sfilter
; /* single filter */
414 struct net_device
*dev
= NULL
;
415 can_err_mask_t err_mask
= 0;
419 if (level
!= SOL_CAN_RAW
)
427 if (optlen
% sizeof(struct can_filter
) != 0)
430 count
= optlen
/ sizeof(struct can_filter
);
433 /* filter does not fit into dfilter => alloc space */
434 filter
= kmalloc(optlen
, GFP_KERNEL
);
438 err
= copy_from_user(filter
, optval
, optlen
);
443 } else if (count
== 1) {
444 err
= copy_from_user(&sfilter
, optval
, optlen
);
451 if (ro
->bound
&& ro
->ifindex
)
452 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
455 /* (try to) register the new filters */
457 err
= raw_enable_filters(dev
, sk
, &sfilter
, 1);
459 err
= raw_enable_filters(dev
, sk
, filter
,
467 /* remove old filter registrations */
468 raw_disable_filters(dev
, sk
, ro
->filter
, ro
->count
);
471 /* remove old filter space */
475 /* link new filters to the socket */
477 /* copy filter data for single filter */
478 ro
->dfilter
= sfilter
;
479 filter
= &ro
->dfilter
;
492 case CAN_RAW_ERR_FILTER
:
493 if (optlen
!= sizeof(err_mask
))
496 err
= copy_from_user(&err_mask
, optval
, optlen
);
500 err_mask
&= CAN_ERR_MASK
;
504 if (ro
->bound
&& ro
->ifindex
)
505 dev
= dev_get_by_index(&init_net
, ro
->ifindex
);
507 /* remove current error mask */
509 /* (try to) register the new err_mask */
510 err
= raw_enable_errfilter(dev
, sk
, err_mask
);
515 /* remove old err_mask registration */
516 raw_disable_errfilter(dev
, sk
, ro
->err_mask
);
519 /* link new err_mask to the socket */
520 ro
->err_mask
= err_mask
;
530 case CAN_RAW_LOOPBACK
:
531 if (optlen
!= sizeof(ro
->loopback
))
534 err
= copy_from_user(&ro
->loopback
, optval
, optlen
);
538 case CAN_RAW_RECV_OWN_MSGS
:
539 if (optlen
!= sizeof(ro
->recv_own_msgs
))
542 err
= copy_from_user(&ro
->recv_own_msgs
, optval
, optlen
);
552 static int raw_getsockopt(struct socket
*sock
, int level
, int optname
,
553 char __user
*optval
, int __user
*optlen
)
555 struct sock
*sk
= sock
->sk
;
556 struct raw_sock
*ro
= raw_sk(sk
);
561 if (level
!= SOL_CAN_RAW
)
563 if (get_user(len
, optlen
))
573 int fsize
= ro
->count
* sizeof(struct can_filter
);
576 err
= copy_to_user(optval
, ro
->filter
, len
);
582 err
= put_user(len
, optlen
);
585 case CAN_RAW_ERR_FILTER
:
586 if (len
> sizeof(can_err_mask_t
))
587 len
= sizeof(can_err_mask_t
);
591 case CAN_RAW_LOOPBACK
:
592 if (len
> sizeof(int))
597 case CAN_RAW_RECV_OWN_MSGS
:
598 if (len
> sizeof(int))
600 val
= &ro
->recv_own_msgs
;
607 if (put_user(len
, optlen
))
609 if (copy_to_user(optval
, val
, len
))
614 static int raw_sendmsg(struct kiocb
*iocb
, struct socket
*sock
,
615 struct msghdr
*msg
, size_t size
)
617 struct sock
*sk
= sock
->sk
;
618 struct raw_sock
*ro
= raw_sk(sk
);
620 struct net_device
*dev
;
625 struct sockaddr_can
*addr
=
626 (struct sockaddr_can
*)msg
->msg_name
;
628 if (addr
->can_family
!= AF_CAN
)
631 ifindex
= addr
->can_ifindex
;
633 ifindex
= ro
->ifindex
;
635 dev
= dev_get_by_index(&init_net
, ifindex
);
639 skb
= sock_alloc_send_skb(sk
, size
, msg
->msg_flags
& MSG_DONTWAIT
,
646 err
= memcpy_fromiovec(skb_put(skb
, size
), msg
->msg_iov
, size
);
655 err
= can_send(skb
, ro
->loopback
);
665 static int raw_recvmsg(struct kiocb
*iocb
, struct socket
*sock
,
666 struct msghdr
*msg
, size_t size
, int flags
)
668 struct sock
*sk
= sock
->sk
;
673 noblock
= flags
& MSG_DONTWAIT
;
674 flags
&= ~MSG_DONTWAIT
;
676 skb
= skb_recv_datagram(sk
, flags
, noblock
, &err
);
681 msg
->msg_flags
|= MSG_TRUNC
;
685 err
= memcpy_toiovec(msg
->msg_iov
, skb
->data
, size
);
687 skb_free_datagram(sk
, skb
);
691 sock_recv_timestamp(msg
, sk
, skb
);
694 msg
->msg_namelen
= sizeof(struct sockaddr_can
);
695 memcpy(msg
->msg_name
, skb
->cb
, msg
->msg_namelen
);
698 skb_free_datagram(sk
, skb
);
703 static struct proto_ops raw_ops __read_mostly
= {
705 .release
= raw_release
,
707 .connect
= sock_no_connect
,
708 .socketpair
= sock_no_socketpair
,
709 .accept
= sock_no_accept
,
710 .getname
= raw_getname
,
711 .poll
= datagram_poll
,
712 .ioctl
= NULL
, /* use can_ioctl() from af_can.c */
713 .listen
= sock_no_listen
,
714 .shutdown
= sock_no_shutdown
,
715 .setsockopt
= raw_setsockopt
,
716 .getsockopt
= raw_getsockopt
,
717 .sendmsg
= raw_sendmsg
,
718 .recvmsg
= raw_recvmsg
,
719 .mmap
= sock_no_mmap
,
720 .sendpage
= sock_no_sendpage
,
723 static struct proto raw_proto __read_mostly
= {
725 .owner
= THIS_MODULE
,
726 .obj_size
= sizeof(struct raw_sock
),
730 static struct can_proto raw_can_proto __read_mostly
= {
738 static __init
int raw_module_init(void)
744 err
= can_proto_register(&raw_can_proto
);
746 printk(KERN_ERR
"can: registration of raw protocol failed\n");
751 static __exit
void raw_module_exit(void)
753 can_proto_unregister(&raw_can_proto
);
756 module_init(raw_module_init
);
757 module_exit(raw_module_exit
);