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