]> rtime.felk.cvut.cz Git - socketcan-devel.git/blob - kernel/2.6/net/can/raw.c
Removed linux/autoconf.h which is not needed, when compiling inside the
[socketcan-devel.git] / kernel / 2.6 / net / can / raw.c
1 /*
2  * raw.c - Raw sockets for protocol family CAN
3  *
4  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, the following disclaimer and
12  *    the referenced file 'COPYING'.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of Volkswagen nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * Alternatively, provided that this notice is retained in full, this
21  * software may be distributed under the terms of the GNU General
22  * Public License ("GPL") version 2 as distributed in the 'COPYING'
23  * file from the main directory of the linux kernel source.
24  *
25  * The provided data structures and external interfaces from this code
26  * are not restricted to be used by modules with a GPL compatible license.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
39  * DAMAGE.
40  *
41  * Send feedback to <socketcan-users@lists.berlios.de>
42  *
43  */
44
45 #include <linux/module.h>
46 #include <linux/version.h>
47 #include <linux/init.h>
48 #include <linux/net.h>
49 #include <linux/netdevice.h>
50 #include <linux/uio.h>
51 #include <linux/poll.h>
52 #include <net/sock.h>
53
54 #include <linux/can.h>
55 #include <linux/can/core.h>
56 #include <linux/can/raw.h>
57
58 #include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
59 RCSID("$Id$");
60
61 #define IDENT "raw"
62 #define CAN_RAW_VERSION CAN_VERSION
63 static __initdata const char banner[] =
64         KERN_INFO "can: raw protocol # rev " CAN_RAW_VERSION "\n";
65
66 MODULE_DESCRIPTION("PF_CAN raw protocol");
67 MODULE_LICENSE("Dual BSD/GPL");
68 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>");
69
70 #ifdef CONFIG_CAN_DEBUG_CORE
71 static int debug = 0;
72 module_param(debug, int, S_IRUGO);
73 MODULE_PARM_DESC(debug, "debug print mask: 1:debug, 2:frames, 4:skbs");
74 #endif
75
76 #ifdef CONFIG_CAN_RAW_USER
77 #define RAW_CAP (-1)
78 #else
79 #define RAW_CAP CAP_NET_RAW
80 #endif
81
82 #undef CAN_RAW_SUPPORT_REBIND /* allow bind on already bound socket */
83
84 #define MASK_ALL 0
85
86 /*
87  * A raw socket has a list of can_filters attached to it, each receiving
88  * the CAN frames matching that filter.  If the filter list is empty,
89  * no CAN frames will be received by the socket.  The default after
90  * opening the socket, is to have one filter which receives all frames.
91  * The filter list is allocated dynamically with the exception of the
92  * list containing only one item.  This common case is optimized by
93  * storing the single filter in dfilter, to avoid using dynamic memory.
94  */
95
96 struct raw_opt {
97         int bound;
98         int ifindex;
99         int loopback;
100         int recv_own_msgs;
101         int count;                 /* number of active filters */
102         struct can_filter dfilter; /* default/single filter */
103         struct can_filter *filter; /* pointer to filter(s) */
104         can_err_mask_t err_mask;
105 };
106
107 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
108 struct raw_sock {
109         struct sock    sk;
110         struct raw_opt opt;
111 };
112
113 static inline struct raw_opt *raw_sk(const struct sock *sk)
114 {
115         return &((struct raw_sock *)sk)->opt;
116 }
117 #else
118 static inline struct raw_opt *raw_sk(const struct sock *sk)
119 {
120         return (struct raw_opt *)sk->sk_protinfo;
121 }
122 #endif
123
124 static void raw_notifier(unsigned long msg, void *data)
125 {
126         struct sock *sk = (struct sock *)data;
127         struct raw_opt *ro = raw_sk(sk);
128
129         DBG("called for sock %p\n", sk);
130
131         switch (msg) {
132
133         case NETDEV_UNREGISTER:
134                 ro->ifindex = 0;
135                 ro->bound   = 0;
136                 /* fallthrough */
137         case NETDEV_DOWN:
138                 sk->sk_err = ENETDOWN;
139                 if (!sock_flag(sk, SOCK_DEAD))
140                         sk->sk_error_report(sk);
141                 break;
142         }
143 }
144
145 static void raw_rcv(struct sk_buff *skb, void *data)
146 {
147         struct sock *sk = (struct sock*)data;
148         struct raw_opt *ro = raw_sk(sk);
149         struct sockaddr_can *addr;
150         int error;
151
152         DBG("received skbuff %p, sk %p\n", skb, sk);
153         DBG_SKB(skb);
154
155         if (!ro->recv_own_msgs) {
156                 /* check the received tx sock reference */
157                 if (*(struct sock **)skb->cb == sk) {
158                         DBG("trashed own tx msg\n");
159                         kfree_skb(skb);
160                         return;
161                 }
162         }
163
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;
168
169         error = sock_queue_rcv_skb(sk, skb);
170         if (error < 0) {
171                 DBG("sock_queue_rcv_skb failed: %d\n", error);
172                 DBG("freeing skbuff %p\n", skb);
173                 kfree_skb(skb);
174         }
175 }
176
177 static void raw_add_filters(struct net_device *dev, struct sock *sk)
178 {
179         struct raw_opt *ro = raw_sk(sk);
180         struct can_filter *filter = ro->filter;
181         int i;
182
183         for (i = 0; i < ro->count; i++) {
184                 can_rx_register(dev, filter[i].can_id, filter[i].can_mask,
185                                 raw_rcv, sk, IDENT);
186                 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
187                     filter[i].can_id, filter[i].can_mask,
188                     filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
189         }
190 }
191
192 static void raw_remove_filters(struct net_device *dev, struct sock *sk)
193 {
194         struct raw_opt *ro = raw_sk(sk);
195         struct can_filter *filter = ro->filter;
196         int i;
197
198         for (i = 0; i < ro->count; i++) {
199                 can_rx_unregister(dev, filter[i].can_id, filter[i].can_mask,
200                                   raw_rcv, sk);
201                 DBG("filter can_id %08X, can_mask %08X%s, sk %p\n",
202                     filter[i].can_id, filter[i].can_mask,
203                     filter[i].can_id & CAN_INV_FILTER ? " (inv)" : "", sk);
204         }
205 }
206
207 static int raw_init(struct sock *sk)
208 {
209         struct raw_opt *ro = raw_sk(sk);
210
211         ro->bound            = 0;
212
213         /* set default filter to single entry dfilter */
214         ro->dfilter.can_id   = 0;
215         ro->dfilter.can_mask = MASK_ALL;
216         ro->filter           = &ro->dfilter;
217         ro->count            = 1;
218
219         /* set default loopback behaviour */
220         ro->loopback         = 1;
221         ro->recv_own_msgs    = 0;
222
223         return 0;
224 }
225
226 static int raw_release(struct socket *sock)
227 {
228         struct sock *sk = sock->sk;
229         struct raw_opt *ro = raw_sk(sk);
230         struct net_device *dev = NULL;
231
232         DBG("socket %p, sk %p, refcnt %d\n", sock, sk,
233             atomic_read(&sk->sk_refcnt));
234
235         if (ro->bound && ro->ifindex)
236                 dev = dev_get_by_index(ro->ifindex);
237
238         /* remove current filters & unregister */
239         if (ro->bound)
240                 raw_remove_filters(dev, sk);
241
242         if (ro->count > 1)
243                 kfree(ro->filter);
244
245         /* remove current error mask */
246         if (ro->err_mask && ro->bound)
247                 can_rx_unregister(dev, 0, ro->err_mask | CAN_ERR_FLAG,
248                                   raw_rcv, sk);
249
250         if (dev) {
251                 can_dev_unregister(dev, raw_notifier, sk);
252                 dev_put(dev);
253         }
254
255         sock_put(sk);
256
257         return 0;
258 }
259
260 static int raw_bind(struct socket *sock, struct sockaddr *uaddr, int len)
261 {
262         struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
263         struct sock *sk = sock->sk;
264         struct raw_opt *ro = raw_sk(sk);
265         struct net_device *dev;
266
267         DBG("socket %p to device %d\n", sock, addr->can_ifindex);
268
269         if (len < sizeof(*addr))
270                 return -EINVAL;
271
272         if (ro->bound) {
273 #ifdef CAN_RAW_SUPPORT_REBIND
274                 /* remove current bindings / notifier */
275                 if (ro->ifindex) {
276                         dev = dev_get_by_index(ro->ifindex);
277                         if (!dev) {
278                                 DBG("could not find device %d\n",
279                                     addr->can_ifindex);
280                                 return -ENODEV;
281                         }
282                         if (!(dev->flags & IFF_UP)) {
283                                 sk->sk_err = ENETDOWN;
284                                 if (!sock_flag(sk, SOCK_DEAD))
285                                         sk->sk_error_report(sk);
286                                 goto out;
287                         }
288                         can_dev_unregister(dev, raw_notifier, sk);
289                 } else
290                         dev = NULL;
291
292                 /* unregister current filters for this device */
293                 raw_remove_filters(dev, sk);
294
295                 if (dev)
296                         dev_put(dev);
297
298                 ro->bound = 0;
299 #else
300                 return -EINVAL;
301 #endif
302         }
303
304         if (addr->can_ifindex) {
305                 dev = dev_get_by_index(addr->can_ifindex);
306                 if (!dev) {
307                         DBG("could not find device %d\n", addr->can_ifindex);
308                         return -ENODEV;
309                 }
310                 if (!(dev->flags & IFF_UP)) {
311                         sk->sk_err = ENETDOWN;
312                         if (!sock_flag(sk, SOCK_DEAD))
313                                 sk->sk_error_report(sk);
314                         goto out;
315                 }
316                 can_dev_register(dev, raw_notifier, sk);
317         } else
318                 dev = NULL;
319
320         ro->ifindex = addr->can_ifindex;
321
322         /* filters set by default/setsockopt */
323         raw_add_filters(dev, sk);
324
325         /* error frame filter set by setsockopt */
326         if (ro->err_mask)
327                 can_rx_register(dev, 0, ro->err_mask | CAN_ERR_FLAG,
328                                 raw_rcv, sk, IDENT);
329
330         ro->bound = 1;
331
332  out:
333         if (dev)
334                 dev_put(dev);
335
336         return 0;
337 }
338
339 static int raw_getname(struct socket *sock, struct sockaddr *uaddr,
340                        int *len, int peer)
341 {
342         struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
343         struct sock *sk = sock->sk;
344         struct raw_opt *ro = raw_sk(sk);
345
346         if (peer)
347                 return -EOPNOTSUPP;
348
349         addr->can_family  = AF_CAN;
350         addr->can_ifindex = ro->ifindex;
351         *len = sizeof(*addr);
352
353         return 0;
354 }
355
356 static unsigned int raw_poll(struct file *file, struct socket *sock,
357                              poll_table *wait)
358 {
359         unsigned int mask = 0;
360
361         DBG("socket %p\n", sock);
362
363         mask = datagram_poll(file, sock, wait);
364         return mask;
365 }
366
367 static int raw_setsockopt(struct socket *sock, int level, int optname,
368                           char __user *optval, int optlen)
369 {
370         struct sock *sk = sock->sk;
371         struct raw_opt *ro = raw_sk(sk);
372         struct can_filter *filter = NULL;  /* dyn. alloc'ed filters */
373         struct can_filter sfilter;         /* single filter */
374         struct net_device *dev = NULL;
375         can_err_mask_t err_mask = 0;
376         int count = 0;
377         int err;
378
379         if (level != SOL_CAN_RAW)
380                 return -EINVAL;
381         if (optlen < 0)
382                 return -EINVAL;
383
384         switch (optname) {
385
386         case CAN_RAW_FILTER:
387                 if (optlen % sizeof(struct can_filter) != 0)
388                         return -EINVAL;
389
390                 count = optlen / sizeof(struct can_filter);
391
392                 if (count > 1) {
393                         /* filter does not fit into dfilter => alloc space */
394                         filter = kmalloc(optlen, GFP_KERNEL);
395                         if (!filter)
396                                 return -ENOMEM;
397
398                         err = copy_from_user(filter, optval, optlen);
399                         if (err) {
400                                 kfree(filter);
401                                 return err;
402                         }
403                 } else if (count == 1) {
404                         err = copy_from_user(&sfilter, optval, optlen);
405                         if (err)
406                                 return err;
407                 }
408
409                 if (ro->bound && ro->ifindex)
410                         dev = dev_get_by_index(ro->ifindex);
411
412                 /* remove current filters & unregister */
413                 if (ro->bound)
414                         raw_remove_filters(dev, sk);
415
416                 if (ro->count > 1)
417                         kfree(ro->filter);
418
419                 if (count == 1) {
420                         /* copy filter data for single filter */
421                         ro->dfilter = sfilter;
422                         filter = &ro->dfilter;
423                 }
424
425                 /* add new filters & register */
426                 ro->filter = filter;
427                 ro->count  = count;
428                 if (ro->bound)
429                         raw_add_filters(dev, sk);
430
431                 if (dev)
432                         dev_put(dev);
433
434                 break;
435
436         case CAN_RAW_ERR_FILTER:
437                 if (optlen != sizeof(err_mask))
438                         return -EINVAL;
439
440                 err = copy_from_user(&err_mask, optval, optlen);
441                 if (err)
442                         return err;
443
444                 err_mask &= CAN_ERR_MASK;
445
446                 if (ro->bound && ro->ifindex)
447                         dev = dev_get_by_index(ro->ifindex);
448
449                 /* remove current error mask */
450                 if (ro->err_mask && ro->bound)
451                         can_rx_unregister(dev, 0, ro->err_mask | CAN_ERR_FLAG,
452                                           raw_rcv, sk);
453
454                 /* add new error mask */
455                 ro->err_mask = err_mask;
456                 if (ro->err_mask && ro->bound)
457                         can_rx_register(dev, 0, ro->err_mask | CAN_ERR_FLAG,
458                                         raw_rcv, sk, IDENT);
459
460                 if (dev)
461                         dev_put(dev);
462
463                 break;
464
465         case CAN_RAW_LOOPBACK:
466                 if (optlen != sizeof(ro->loopback))
467                         return -EINVAL;
468
469                 err = copy_from_user(&ro->loopback, optval, optlen);
470                 if (err)
471                         return err;
472
473                 break;
474
475         case CAN_RAW_RECV_OWN_MSGS:
476                 if (optlen != sizeof(ro->recv_own_msgs))
477                         return -EINVAL;
478
479                 err = copy_from_user(&ro->recv_own_msgs, optval, optlen);
480                 if (err)
481                         return err;
482
483                 break;
484
485         default:
486                 return -ENOPROTOOPT;
487         }
488         return 0;
489 }
490
491 static int raw_getsockopt(struct socket *sock, int level, int optname,
492                           char __user *optval, int __user *optlen)
493 {
494         struct sock *sk = sock->sk;
495         struct raw_opt *ro = raw_sk(sk);
496         struct can_filter *filter = ro->filter;
497         int count = ro->count;
498         int len;
499         void *val;
500
501         if (level != SOL_CAN_RAW)
502                 return -EINVAL;
503         if (get_user(len, optlen))
504                 return -EFAULT;
505         if (len < 0)
506                 return -EINVAL;
507
508         switch (optname) {
509
510         case CAN_RAW_FILTER:
511                 if (count && filter) {
512                         int filter_size = count * sizeof(struct can_filter);
513                         if (len > filter_size)
514                                 len = filter_size;
515                         val = filter;
516                 } else
517                         len = 0;
518                 break;
519
520         case CAN_RAW_ERR_FILTER:
521                 if (len > sizeof(can_err_mask_t))
522                         len = sizeof(can_err_mask_t);
523                 val = &ro->err_mask;
524                 break;
525
526         case CAN_RAW_LOOPBACK:
527                 if (len > sizeof(int))
528                         len = sizeof(int);
529                 val = &ro->loopback;
530                 break;
531
532         case CAN_RAW_RECV_OWN_MSGS:
533                 if (len > sizeof(int))
534                         len = sizeof(int);
535                 val = &ro->recv_own_msgs;
536                 break;
537
538         default:
539                 return -ENOPROTOOPT;
540         }
541
542         if (put_user(len, optlen))
543                 return -EFAULT;
544         if (copy_to_user(optval, val, len))
545                 return -EFAULT;
546         return 0;
547 }
548
549 static int raw_sendmsg(struct kiocb *iocb, struct socket *sock,
550                        struct msghdr *msg, size_t size)
551 {
552         struct sock *sk = sock->sk;
553         struct raw_opt *ro = raw_sk(sk);
554         struct sk_buff *skb;
555         struct net_device *dev;
556         int ifindex;
557         int err;
558
559         DBG("socket %p, sk %p\n", sock, sk);
560
561         if (msg->msg_name) {
562                 struct sockaddr_can *addr =
563                         (struct sockaddr_can *)msg->msg_name;
564
565                 if (addr->can_family != AF_CAN)
566                         return -EINVAL;
567
568                 ifindex = addr->can_ifindex;
569         } else
570                 ifindex = ro->ifindex;
571
572         dev = dev_get_by_index(ifindex);
573         if (!dev) {
574                 DBG("device %d not found\n", ifindex);
575                 return -ENXIO;
576         }
577
578         skb = alloc_skb(size, GFP_KERNEL);
579         if (!skb) {
580                 dev_put(dev);
581                 return -ENOMEM;
582         }
583
584         err = memcpy_fromiovec(skb_put(skb, size), msg->msg_iov, size);
585         if (err < 0) {
586                 kfree_skb(skb);
587                 dev_put(dev);
588                 return err;
589         }
590         skb->dev = dev;
591         skb->sk  = sk;
592
593         DBG("sending skbuff to interface %d\n", ifindex);
594         DBG_SKB(skb);
595
596         err = can_send(skb, ro->loopback);
597
598         dev_put(dev);
599
600         if (err)
601                 return err;
602
603         return size;
604 }
605
606 static int raw_recvmsg(struct kiocb *iocb, struct socket *sock,
607                        struct msghdr *msg, size_t size, int flags)
608 {
609         struct sock *sk = sock->sk;
610         struct sk_buff *skb;
611         int error = 0;
612         int noblock;
613
614         DBG("socket %p, sk %p\n", sock, sk);
615
616         noblock =  flags & MSG_DONTWAIT;
617         flags   &= ~MSG_DONTWAIT;
618
619         skb = skb_recv_datagram(sk, flags, noblock, &error);
620         if (!skb)
621                 return error;
622
623         DBG("delivering skbuff %p\n", skb);
624         DBG_SKB(skb);
625
626         if (size < skb->len)
627                 msg->msg_flags |= MSG_TRUNC;
628         else
629                 size = skb->len;
630
631         error = memcpy_toiovec(msg->msg_iov, skb->data, size);
632         if (error < 0) {
633                 skb_free_datagram(sk, skb);
634                 return error;
635         }
636
637         sock_recv_timestamp(msg, sk, skb);
638
639         if (msg->msg_name) {
640                 msg->msg_namelen = sizeof(struct sockaddr_can);
641                 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
642         }
643
644         DBG("freeing sock %p, skbuff %p\n", sk, skb);
645         skb_free_datagram(sk, skb);
646
647         return size;
648 }
649
650 static struct proto_ops raw_ops = {
651         .family        = PF_CAN,
652         .release       = raw_release,
653         .bind          = raw_bind,
654         .connect       = sock_no_connect,
655         .socketpair    = sock_no_socketpair,
656         .accept        = sock_no_accept,
657         .getname       = raw_getname,
658         .poll          = raw_poll,
659         .ioctl         = NULL,          /* use can_ioctl() from af_can.c */
660         .listen        = sock_no_listen,
661         .shutdown      = sock_no_shutdown,
662         .setsockopt    = raw_setsockopt,
663         .getsockopt    = raw_getsockopt,
664         .sendmsg       = raw_sendmsg,
665         .recvmsg       = raw_recvmsg,
666         .mmap          = sock_no_mmap,
667         .sendpage      = sock_no_sendpage,
668 };
669
670 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
671 static struct proto raw_proto = {
672         .name       = "CAN_RAW",
673         .owner      = THIS_MODULE,
674         .obj_size   = sizeof(struct raw_sock),
675         .init       = raw_init,
676 };
677
678 static struct can_proto raw_can_proto = {
679         .type       = SOCK_RAW,
680         .protocol   = CAN_RAW,
681         .capability = RAW_CAP,
682         .ops        = &raw_ops,
683         .prot       = &raw_proto,
684 };
685 #else
686 static struct can_proto raw_can_proto = {
687         .type       = SOCK_RAW,
688         .protocol   = CAN_RAW,
689         .capability = RAW_CAP,
690         .ops        = &raw_ops,
691         .owner      = THIS_MODULE,
692         .obj_size   = sizeof(struct raw_opt),
693         .init       = raw_init,
694 };
695 #endif
696
697 static __init int raw_module_init(void)
698 {
699         printk(banner);
700
701         can_proto_register(&raw_can_proto);
702         return 0;
703 }
704
705 static __exit void raw_module_exit(void)
706 {
707         can_proto_unregister(&raw_can_proto);
708 }
709
710 module_init(raw_module_init);
711 module_exit(raw_module_exit);