7e8ca2836452a5053c4695691ceba78a9d4605d1
[linux-2.6.git] / net / can / af_can.c
1 /*
2  * af_can.c - Protocol family CAN core module
3  *            (used by different CAN protocol modules)
4  *
5  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
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, in which case the provisions of the
23  * GPL apply INSTEAD OF those given above.
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/init.h>
47 #include <linux/kmod.h>
48 #include <linux/slab.h>
49 #include <linux/list.h>
50 #include <linux/spinlock.h>
51 #include <linux/rcupdate.h>
52 #include <linux/uaccess.h>
53 #include <linux/net.h>
54 #include <linux/netdevice.h>
55 #include <linux/socket.h>
56 #include <linux/if_ether.h>
57 #include <linux/if_arp.h>
58 #include <linux/skbuff.h>
59 #include <linux/can.h>
60 #include <linux/can/core.h>
61 #include <net/net_namespace.h>
62 #include <net/sock.h>
63
64 #include "af_can.h"
65
66 static __initdata const char banner[] = KERN_INFO
67         "can: controller area network core (" CAN_VERSION_STRING ")\n";
68
69 MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
70 MODULE_LICENSE("Dual BSD/GPL");
71 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
72               "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
73
74 MODULE_ALIAS_NETPROTO(PF_CAN);
75
76 static int stats_timer __read_mostly = 1;
77 module_param(stats_timer, int, S_IRUGO);
78 MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
79
80 HLIST_HEAD(can_rx_dev_list);
81 static struct dev_rcv_lists can_rx_alldev_list;
82 static DEFINE_SPINLOCK(can_rcvlists_lock);
83
84 static struct kmem_cache *rcv_cache __read_mostly;
85
86 /* table of registered CAN protocols */
87 static struct can_proto *proto_tab[CAN_NPROTO] __read_mostly;
88 static DEFINE_SPINLOCK(proto_tab_lock);
89
90 struct timer_list can_stattimer;   /* timer for statistics update */
91 struct s_stats    can_stats;       /* packet statistics */
92 struct s_pstats   can_pstats;      /* receive list statistics */
93
94 /*
95  * af_can socket functions
96  */
97
98 static int can_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
99 {
100         struct sock *sk = sock->sk;
101
102         switch (cmd) {
103
104         case SIOCGSTAMP:
105                 return sock_get_timestamp(sk, (struct timeval __user *)arg);
106
107         default:
108                 return -ENOIOCTLCMD;
109         }
110 }
111
112 static void can_sock_destruct(struct sock *sk)
113 {
114         skb_queue_purge(&sk->sk_receive_queue);
115 }
116
117 static int can_create(struct net *net, struct socket *sock, int protocol)
118 {
119         struct sock *sk;
120         struct can_proto *cp;
121         int err = 0;
122
123         sock->state = SS_UNCONNECTED;
124
125         if (protocol < 0 || protocol >= CAN_NPROTO)
126                 return -EINVAL;
127
128         if (net != &init_net)
129                 return -EAFNOSUPPORT;
130
131 #ifdef CONFIG_KMOD
132         /* try to load protocol module, when CONFIG_KMOD is defined */
133         if (!proto_tab[protocol]) {
134                 err = request_module("can-proto-%d", protocol);
135
136                 /*
137                  * In case of error we only print a message but don't
138                  * return the error code immediately.  Below we will
139                  * return -EPROTONOSUPPORT
140                  */
141                 if (err && printk_ratelimit())
142                         printk(KERN_ERR "can: request_module "
143                                "(can-proto-%d) failed.\n", protocol);
144         }
145 #endif
146
147         spin_lock(&proto_tab_lock);
148         cp = proto_tab[protocol];
149         if (cp && !try_module_get(cp->prot->owner))
150                 cp = NULL;
151         spin_unlock(&proto_tab_lock);
152
153         /* check for available protocol and correct usage */
154
155         if (!cp)
156                 return -EPROTONOSUPPORT;
157
158         if (cp->type != sock->type) {
159                 err = -EPROTONOSUPPORT;
160                 goto errout;
161         }
162
163         if (cp->capability >= 0 && !capable(cp->capability)) {
164                 err = -EPERM;
165                 goto errout;
166         }
167
168         sock->ops = cp->ops;
169
170         sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot);
171         if (!sk) {
172                 err = -ENOMEM;
173                 goto errout;
174         }
175
176         sock_init_data(sock, sk);
177         sk->sk_destruct = can_sock_destruct;
178
179         if (sk->sk_prot->init)
180                 err = sk->sk_prot->init(sk);
181
182         if (err) {
183                 /* release sk on errors */
184                 sock_orphan(sk);
185                 sock_put(sk);
186         }
187
188  errout:
189         module_put(cp->prot->owner);
190         return err;
191 }
192
193 /*
194  * af_can tx path
195  */
196
197 /**
198  * can_send - transmit a CAN frame (optional with local loopback)
199  * @skb: pointer to socket buffer with CAN frame in data section
200  * @loop: loopback for listeners on local CAN sockets (recommended default!)
201  *
202  * Return:
203  *  0 on success
204  *  -ENETDOWN when the selected interface is down
205  *  -ENOBUFS on full driver queue (see net_xmit_errno())
206  *  -ENOMEM when local loopback failed at calling skb_clone()
207  *  -EPERM when trying to send on a non-CAN interface
208  */
209 int can_send(struct sk_buff *skb, int loop)
210 {
211         struct sk_buff *newskb = NULL;
212         int err;
213
214         if (skb->dev->type != ARPHRD_CAN) {
215                 kfree_skb(skb);
216                 return -EPERM;
217         }
218
219         if (!(skb->dev->flags & IFF_UP)) {
220                 kfree_skb(skb);
221                 return -ENETDOWN;
222         }
223
224         skb->protocol = htons(ETH_P_CAN);
225         skb_reset_network_header(skb);
226         skb_reset_transport_header(skb);
227
228         if (loop) {
229                 /* local loopback of sent CAN frames */
230
231                 /* indication for the CAN driver: do loopback */
232                 skb->pkt_type = PACKET_LOOPBACK;
233
234                 /*
235                  * The reference to the originating sock may be required
236                  * by the receiving socket to check whether the frame is
237                  * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
238                  * Therefore we have to ensure that skb->sk remains the
239                  * reference to the originating sock by restoring skb->sk
240                  * after each skb_clone() or skb_orphan() usage.
241                  */
242
243                 if (!(skb->dev->flags & IFF_ECHO)) {
244                         /*
245                          * If the interface is not capable to do loopback
246                          * itself, we do it here.
247                          */
248                         newskb = skb_clone(skb, GFP_ATOMIC);
249                         if (!newskb) {
250                                 kfree_skb(skb);
251                                 return -ENOMEM;
252                         }
253
254                         newskb->sk = skb->sk;
255                         newskb->ip_summed = CHECKSUM_UNNECESSARY;
256                         newskb->pkt_type = PACKET_BROADCAST;
257                 }
258         } else {
259                 /* indication for the CAN driver: no loopback required */
260                 skb->pkt_type = PACKET_HOST;
261         }
262
263         /* send to netdevice */
264         err = dev_queue_xmit(skb);
265         if (err > 0)
266                 err = net_xmit_errno(err);
267
268         if (err) {
269                 if (newskb)
270                         kfree_skb(newskb);
271                 return err;
272         }
273
274         if (newskb)
275                 netif_rx(newskb);
276
277         /* update statistics */
278         can_stats.tx_frames++;
279         can_stats.tx_frames_delta++;
280
281         return 0;
282 }
283 EXPORT_SYMBOL(can_send);
284
285 /*
286  * af_can rx path
287  */
288
289 static struct dev_rcv_lists *find_dev_rcv_lists(struct net_device *dev)
290 {
291         struct dev_rcv_lists *d = NULL;
292         struct hlist_node *n;
293
294         /*
295          * find receive list for this device
296          *
297          * The hlist_for_each_entry*() macros curse through the list
298          * using the pointer variable n and set d to the containing
299          * struct in each list iteration.  Therefore, after list
300          * iteration, d is unmodified when the list is empty, and it
301          * points to last list element, when the list is non-empty
302          * but no match in the loop body is found.  I.e. d is *not*
303          * NULL when no match is found.  We can, however, use the
304          * cursor variable n to decide if a match was found.
305          */
306
307         hlist_for_each_entry_rcu(d, n, &can_rx_dev_list, list) {
308                 if (d->dev == dev)
309                         break;
310         }
311
312         return n ? d : NULL;
313 }
314
315 static struct hlist_head *find_rcv_list(canid_t *can_id, canid_t *mask,
316                                         struct dev_rcv_lists *d)
317 {
318         canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
319
320         /* filter error frames */
321         if (*mask & CAN_ERR_FLAG) {
322                 /* clear CAN_ERR_FLAG in list entry */
323                 *mask &= CAN_ERR_MASK;
324                 return &d->rx[RX_ERR];
325         }
326
327         /* ensure valid values in can_mask */
328         if (*mask & CAN_EFF_FLAG)
329                 *mask &= (CAN_EFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG);
330         else
331                 *mask &= (CAN_SFF_MASK | CAN_RTR_FLAG);
332
333         /* reduce condition testing at receive time */
334         *can_id &= *mask;
335
336         /* inverse can_id/can_mask filter */
337         if (inv)
338                 return &d->rx[RX_INV];
339
340         /* mask == 0 => no condition testing at receive time */
341         if (!(*mask))
342                 return &d->rx[RX_ALL];
343
344         /* use extra filterset for the subscription of exactly *ONE* can_id */
345         if (*can_id & CAN_EFF_FLAG) {
346                 if (*mask == (CAN_EFF_MASK | CAN_EFF_FLAG)) {
347                         /* RFC: a use-case for hash-tables in the future? */
348                         return &d->rx[RX_EFF];
349                 }
350         } else {
351                 if (*mask == CAN_SFF_MASK)
352                         return &d->rx_sff[*can_id];
353         }
354
355         /* default: filter via can_id/can_mask */
356         return &d->rx[RX_FIL];
357 }
358
359 /**
360  * can_rx_register - subscribe CAN frames from a specific interface
361  * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
362  * @can_id: CAN identifier (see description)
363  * @mask: CAN mask (see description)
364  * @func: callback function on filter match
365  * @data: returned parameter for callback function
366  * @ident: string for calling module indentification
367  *
368  * Description:
369  *  Invokes the callback function with the received sk_buff and the given
370  *  parameter 'data' on a matching receive filter. A filter matches, when
371  *
372  *          <received_can_id> & mask == can_id & mask
373  *
374  *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
375  *  filter for error frames (CAN_ERR_FLAG bit set in mask).
376  *
377  * Return:
378  *  0 on success
379  *  -ENOMEM on missing cache mem to create subscription entry
380  *  -ENODEV unknown device
381  */
382 int can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
383                     void (*func)(struct sk_buff *, void *), void *data,
384                     char *ident)
385 {
386         struct receiver *r;
387         struct hlist_head *rl;
388         struct dev_rcv_lists *d;
389         int err = 0;
390
391         /* insert new receiver  (dev,canid,mask) -> (func,data) */
392
393         r = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
394         if (!r)
395                 return -ENOMEM;
396
397         spin_lock(&can_rcvlists_lock);
398
399         d = find_dev_rcv_lists(dev);
400         if (d) {
401                 rl = find_rcv_list(&can_id, &mask, d);
402
403                 r->can_id  = can_id;
404                 r->mask    = mask;
405                 r->matches = 0;
406                 r->func    = func;
407                 r->data    = data;
408                 r->ident   = ident;
409
410                 hlist_add_head_rcu(&r->list, rl);
411                 d->entries++;
412
413                 can_pstats.rcv_entries++;
414                 if (can_pstats.rcv_entries_max < can_pstats.rcv_entries)
415                         can_pstats.rcv_entries_max = can_pstats.rcv_entries;
416         } else {
417                 kmem_cache_free(rcv_cache, r);
418                 err = -ENODEV;
419         }
420
421         spin_unlock(&can_rcvlists_lock);
422
423         return err;
424 }
425 EXPORT_SYMBOL(can_rx_register);
426
427 /*
428  * can_rx_delete_device - rcu callback for dev_rcv_lists structure removal
429  */
430 static void can_rx_delete_device(struct rcu_head *rp)
431 {
432         struct dev_rcv_lists *d = container_of(rp, struct dev_rcv_lists, rcu);
433
434         kfree(d);
435 }
436
437 /*
438  * can_rx_delete_receiver - rcu callback for single receiver entry removal
439  */
440 static void can_rx_delete_receiver(struct rcu_head *rp)
441 {
442         struct receiver *r = container_of(rp, struct receiver, rcu);
443
444         kmem_cache_free(rcv_cache, r);
445 }
446
447 /**
448  * can_rx_unregister - unsubscribe CAN frames from a specific interface
449  * @dev: pointer to netdevice (NULL => unsubcribe from 'all' CAN devices list)
450  * @can_id: CAN identifier
451  * @mask: CAN mask
452  * @func: callback function on filter match
453  * @data: returned parameter for callback function
454  *
455  * Description:
456  *  Removes subscription entry depending on given (subscription) values.
457  */
458 void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
459                        void (*func)(struct sk_buff *, void *), void *data)
460 {
461         struct receiver *r = NULL;
462         struct hlist_head *rl;
463         struct hlist_node *next;
464         struct dev_rcv_lists *d;
465
466         spin_lock(&can_rcvlists_lock);
467
468         d = find_dev_rcv_lists(dev);
469         if (!d) {
470                 printk(KERN_ERR "BUG: receive list not found for "
471                        "dev %s, id %03X, mask %03X\n",
472                        DNAME(dev), can_id, mask);
473                 goto out;
474         }
475
476         rl = find_rcv_list(&can_id, &mask, d);
477
478         /*
479          * Search the receiver list for the item to delete.  This should
480          * exist, since no receiver may be unregistered that hasn't
481          * been registered before.
482          */
483
484         hlist_for_each_entry_rcu(r, next, rl, list) {
485                 if (r->can_id == can_id && r->mask == mask
486                     && r->func == func && r->data == data)
487                         break;
488         }
489
490         /*
491          * Check for bugs in CAN protocol implementations:
492          * If no matching list item was found, the list cursor variable next
493          * will be NULL, while r will point to the last item of the list.
494          */
495
496         if (!next) {
497                 printk(KERN_ERR "BUG: receive list entry not found for "
498                        "dev %s, id %03X, mask %03X\n",
499                        DNAME(dev), can_id, mask);
500                 r = NULL;
501                 d = NULL;
502                 goto out;
503         }
504
505         hlist_del_rcu(&r->list);
506         d->entries--;
507
508         if (can_pstats.rcv_entries > 0)
509                 can_pstats.rcv_entries--;
510
511         /* remove device structure requested by NETDEV_UNREGISTER */
512         if (d->remove_on_zero_entries && !d->entries)
513                 hlist_del_rcu(&d->list);
514         else
515                 d = NULL;
516
517  out:
518         spin_unlock(&can_rcvlists_lock);
519
520         /* schedule the receiver item for deletion */
521         if (r)
522                 call_rcu(&r->rcu, can_rx_delete_receiver);
523
524         /* schedule the device structure for deletion */
525         if (d)
526                 call_rcu(&d->rcu, can_rx_delete_device);
527 }
528 EXPORT_SYMBOL(can_rx_unregister);
529
530 static inline void deliver(struct sk_buff *skb, struct receiver *r)
531 {
532         struct sk_buff *clone = skb_clone(skb, GFP_ATOMIC);
533
534         if (clone) {
535                 clone->sk = skb->sk;
536                 r->func(clone, r->data);
537                 r->matches++;
538         }
539 }
540
541 static int can_rcv_filter(struct dev_rcv_lists *d, struct sk_buff *skb)
542 {
543         struct receiver *r;
544         struct hlist_node *n;
545         int matches = 0;
546         struct can_frame *cf = (struct can_frame *)skb->data;
547         canid_t can_id = cf->can_id;
548
549         if (d->entries == 0)
550                 return 0;
551
552         if (can_id & CAN_ERR_FLAG) {
553                 /* check for error frame entries only */
554                 hlist_for_each_entry_rcu(r, n, &d->rx[RX_ERR], list) {
555                         if (can_id & r->mask) {
556                                 deliver(skb, r);
557                                 matches++;
558                         }
559                 }
560                 return matches;
561         }
562
563         /* check for unfiltered entries */
564         hlist_for_each_entry_rcu(r, n, &d->rx[RX_ALL], list) {
565                 deliver(skb, r);
566                 matches++;
567         }
568
569         /* check for can_id/mask entries */
570         hlist_for_each_entry_rcu(r, n, &d->rx[RX_FIL], list) {
571                 if ((can_id & r->mask) == r->can_id) {
572                         deliver(skb, r);
573                         matches++;
574                 }
575         }
576
577         /* check for inverted can_id/mask entries */
578         hlist_for_each_entry_rcu(r, n, &d->rx[RX_INV], list) {
579                 if ((can_id & r->mask) != r->can_id) {
580                         deliver(skb, r);
581                         matches++;
582                 }
583         }
584
585         /* check CAN_ID specific entries */
586         if (can_id & CAN_EFF_FLAG) {
587                 hlist_for_each_entry_rcu(r, n, &d->rx[RX_EFF], list) {
588                         if (r->can_id == can_id) {
589                                 deliver(skb, r);
590                                 matches++;
591                         }
592                 }
593         } else {
594                 can_id &= CAN_SFF_MASK;
595                 hlist_for_each_entry_rcu(r, n, &d->rx_sff[can_id], list) {
596                         deliver(skb, r);
597                         matches++;
598                 }
599         }
600
601         return matches;
602 }
603
604 static int can_rcv(struct sk_buff *skb, struct net_device *dev,
605                    struct packet_type *pt, struct net_device *orig_dev)
606 {
607         struct dev_rcv_lists *d;
608         int matches;
609
610         if (dev->type != ARPHRD_CAN || dev_net(dev) != &init_net) {
611                 kfree_skb(skb);
612                 return 0;
613         }
614
615         /* update statistics */
616         can_stats.rx_frames++;
617         can_stats.rx_frames_delta++;
618
619         rcu_read_lock();
620
621         /* deliver the packet to sockets listening on all devices */
622         matches = can_rcv_filter(&can_rx_alldev_list, skb);
623
624         /* find receive list for this device */
625         d = find_dev_rcv_lists(dev);
626         if (d)
627                 matches += can_rcv_filter(d, skb);
628
629         rcu_read_unlock();
630
631         /* free the skbuff allocated by the netdevice driver */
632         kfree_skb(skb);
633
634         if (matches > 0) {
635                 can_stats.matches++;
636                 can_stats.matches_delta++;
637         }
638
639         return 0;
640 }
641
642 /*
643  * af_can protocol functions
644  */
645
646 /**
647  * can_proto_register - register CAN transport protocol
648  * @cp: pointer to CAN protocol structure
649  *
650  * Return:
651  *  0 on success
652  *  -EINVAL invalid (out of range) protocol number
653  *  -EBUSY  protocol already in use
654  *  -ENOBUF if proto_register() fails
655  */
656 int can_proto_register(struct can_proto *cp)
657 {
658         int proto = cp->protocol;
659         int err = 0;
660
661         if (proto < 0 || proto >= CAN_NPROTO) {
662                 printk(KERN_ERR "can: protocol number %d out of range\n",
663                        proto);
664                 return -EINVAL;
665         }
666
667         err = proto_register(cp->prot, 0);
668         if (err < 0)
669                 return err;
670
671         spin_lock(&proto_tab_lock);
672         if (proto_tab[proto]) {
673                 printk(KERN_ERR "can: protocol %d already registered\n",
674                        proto);
675                 err = -EBUSY;
676         } else {
677                 proto_tab[proto] = cp;
678
679                 /* use generic ioctl function if not defined by module */
680                 if (!cp->ops->ioctl)
681                         cp->ops->ioctl = can_ioctl;
682         }
683         spin_unlock(&proto_tab_lock);
684
685         if (err < 0)
686                 proto_unregister(cp->prot);
687
688         return err;
689 }
690 EXPORT_SYMBOL(can_proto_register);
691
692 /**
693  * can_proto_unregister - unregister CAN transport protocol
694  * @cp: pointer to CAN protocol structure
695  */
696 void can_proto_unregister(struct can_proto *cp)
697 {
698         int proto = cp->protocol;
699
700         spin_lock(&proto_tab_lock);
701         if (!proto_tab[proto]) {
702                 printk(KERN_ERR "BUG: can: protocol %d is not registered\n",
703                        proto);
704         }
705         proto_tab[proto] = NULL;
706         spin_unlock(&proto_tab_lock);
707
708         proto_unregister(cp->prot);
709 }
710 EXPORT_SYMBOL(can_proto_unregister);
711
712 /*
713  * af_can notifier to create/remove CAN netdevice specific structs
714  */
715 static int can_notifier(struct notifier_block *nb, unsigned long msg,
716                         void *data)
717 {
718         struct net_device *dev = (struct net_device *)data;
719         struct dev_rcv_lists *d;
720
721         if (dev_net(dev) != &init_net)
722                 return NOTIFY_DONE;
723
724         if (dev->type != ARPHRD_CAN)
725                 return NOTIFY_DONE;
726
727         switch (msg) {
728
729         case NETDEV_REGISTER:
730
731                 /*
732                  * create new dev_rcv_lists for this device
733                  *
734                  * N.B. zeroing the struct is the correct initialization
735                  * for the embedded hlist_head structs.
736                  * Another list type, e.g. list_head, would require
737                  * explicit initialization.
738                  */
739
740                 d = kzalloc(sizeof(*d), GFP_KERNEL);
741                 if (!d) {
742                         printk(KERN_ERR
743                                "can: allocation of receive list failed\n");
744                         return NOTIFY_DONE;
745                 }
746                 d->dev = dev;
747
748                 spin_lock(&can_rcvlists_lock);
749                 hlist_add_head_rcu(&d->list, &can_rx_dev_list);
750                 spin_unlock(&can_rcvlists_lock);
751
752                 break;
753
754         case NETDEV_UNREGISTER:
755                 spin_lock(&can_rcvlists_lock);
756
757                 d = find_dev_rcv_lists(dev);
758                 if (d) {
759                         if (d->entries) {
760                                 d->remove_on_zero_entries = 1;
761                                 d = NULL;
762                         } else
763                                 hlist_del_rcu(&d->list);
764                 } else
765                         printk(KERN_ERR "can: notifier: receive list not "
766                                "found for dev %s\n", dev->name);
767
768                 spin_unlock(&can_rcvlists_lock);
769
770                 if (d)
771                         call_rcu(&d->rcu, can_rx_delete_device);
772
773                 break;
774         }
775
776         return NOTIFY_DONE;
777 }
778
779 /*
780  * af_can module init/exit functions
781  */
782
783 static struct packet_type can_packet __read_mostly = {
784         .type = __constant_htons(ETH_P_CAN),
785         .dev  = NULL,
786         .func = can_rcv,
787 };
788
789 static struct net_proto_family can_family_ops __read_mostly = {
790         .family = PF_CAN,
791         .create = can_create,
792         .owner  = THIS_MODULE,
793 };
794
795 /* notifier block for netdevice event */
796 static struct notifier_block can_netdev_notifier __read_mostly = {
797         .notifier_call = can_notifier,
798 };
799
800 static __init int can_init(void)
801 {
802         printk(banner);
803
804         rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
805                                       0, 0, NULL);
806         if (!rcv_cache)
807                 return -ENOMEM;
808
809         /*
810          * Insert can_rx_alldev_list for reception on all devices.
811          * This struct is zero initialized which is correct for the
812          * embedded hlist heads, the dev pointer, and the entries counter.
813          */
814
815         spin_lock(&can_rcvlists_lock);
816         hlist_add_head_rcu(&can_rx_alldev_list.list, &can_rx_dev_list);
817         spin_unlock(&can_rcvlists_lock);
818
819         if (stats_timer) {
820                 /* the statistics are updated every second (timer triggered) */
821                 setup_timer(&can_stattimer, can_stat_update, 0);
822                 mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
823         } else
824                 can_stattimer.function = NULL;
825
826         can_init_proc();
827
828         /* protocol register */
829         sock_register(&can_family_ops);
830         register_netdevice_notifier(&can_netdev_notifier);
831         dev_add_pack(&can_packet);
832
833         return 0;
834 }
835
836 static __exit void can_exit(void)
837 {
838         struct dev_rcv_lists *d;
839         struct hlist_node *n, *next;
840
841         if (stats_timer)
842                 del_timer(&can_stattimer);
843
844         can_remove_proc();
845
846         /* protocol unregister */
847         dev_remove_pack(&can_packet);
848         unregister_netdevice_notifier(&can_netdev_notifier);
849         sock_unregister(PF_CAN);
850
851         /* remove can_rx_dev_list */
852         spin_lock(&can_rcvlists_lock);
853         hlist_del(&can_rx_alldev_list.list);
854         hlist_for_each_entry_safe(d, n, next, &can_rx_dev_list, list) {
855                 hlist_del(&d->list);
856                 kfree(d);
857         }
858         spin_unlock(&can_rcvlists_lock);
859
860         kmem_cache_destroy(rcv_cache);
861 }
862
863 module_init(can_init);
864 module_exit(can_exit);