kernel/2.6/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/version.h>
  47 #include <linux/init.h>
  48 #include <linux/kmod.h>
  49 #include <linux/slab.h>
  50 #include <linux/list.h>
  51 #include <linux/spinlock.h>
  52 #include <linux/rcupdate.h>
  53 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,18)
  54 #include <linux/uaccess.h>
  55 #else
  56 #include <asm/uaccess.h>
  57 #endif
  58 #include <linux/net.h>
  59 #include <linux/netdevice.h>
  60 #include <linux/socket.h>
  61 #include <linux/if_ether.h>
  62 #include <linux/if_arp.h>
  63 #include <linux/skbuff.h>
  64 #include <socketcan/can.h>
  65 #include <socketcan/can/core.h>
  66 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
  67 #include <net/net_namespace.h>
  68 #endif
  69 #include <net/sock.h>
  70
  71 #include "af_can.h"
  72 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
  73 #include "compat.h"
  74 #endif
  75
  76 #include <socketcan/can/version.h> /* for RCSID. Removed by mkpatch script */
  77 RCSID("$Id$");
  78
  79 static __initdata const char banner[] = KERN_INFO
  80         "can: controller area network core (" CAN_VERSION_STRING ")\n";
  81
  82 MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
  83 MODULE_LICENSE("Dual BSD/GPL");
  84 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
  85               "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
  86
  87 MODULE_ALIAS_NETPROTO(PF_CAN);
  88
  89 static int stats_timer __read_mostly = 1;
  90 module_param(stats_timer, int, S_IRUGO);
  91 MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
  92
  93 HLIST_HEAD(can_rx_dev_list);
  94 static struct dev_rcv_lists can_rx_alldev_list;
  95 static DEFINE_SPINLOCK(can_rcvlists_lock);
  96
  97 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,20)
  98 static struct kmem_cache *rcv_cache __read_mostly;
  99 #else
 100 static kmem_cache_t *rcv_cache;
 101 #endif
 102
 103 /* table of registered CAN protocols */
 104 static struct can_proto *proto_tab[CAN_NPROTO] __read_mostly;
 105 static DEFINE_SPINLOCK(proto_tab_lock);
 106
 107 struct timer_list can_stattimer;   /* timer for statistics update */
 108 struct s_stats    can_stats;       /* packet statistics */
 109 struct s_pstats   can_pstats;      /* receive list statistics */
 110
 111 /*
 112  * af_can socket functions
 113  */
 114
 115 static int can_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
 116 {
 117         struct sock *sk = sock->sk;
 118
 119         switch (cmd) {
 120
 121         case SIOCGSTAMP:
 122                 return sock_get_timestamp(sk, (struct timeval __user *)arg);
 123
 124         default:
 125 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
 126                 return -ENOIOCTLCMD;
 127 #else
 128                 return dev_ioctl(cmd, (void __user *)arg);
 129 #endif
 130         }
 131 }
 132
 133 static void can_sock_destruct(struct sock *sk)
 134 {
 135         skb_queue_purge(&sk->sk_receive_queue);
 136 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
 137         if (sk->sk_protinfo)
 138                 kfree(sk->sk_protinfo);
 139 #endif
 140 }
 141
 142 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33)
 143 static int can_create(struct net *net, struct socket *sock, int protocol, int kern)
 144 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 145 static int can_create(struct net *net, struct socket *sock, int protocol)
 146 #else
 147 static int can_create(struct socket *sock, int protocol)
 148 #endif
 149 {
 150         struct sock *sk;
 151         struct can_proto *cp;
 152         int err = 0;
 153
 154         sock->state = SS_UNCONNECTED;
 155
 156         if (protocol < 0 || protocol >= CAN_NPROTO)
 157                 return -EINVAL;
 158
 159 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 160         if (net != &init_net)
 161                 return -EAFNOSUPPORT;
 162 #endif
 163
 164 #ifdef CONFIG_MODULES
 165         /* try to load protocol module kernel is modular */
 166         if (!proto_tab[protocol]) {
 167                 err = request_module("can-proto-%d", protocol);
 168
 169                 /*
 170                  * In case of error we only print a message but don't
 171                  * return the error code immediately.  Below we will
 172                  * return -EPROTONOSUPPORT
 173                  */
 174                 if (err && printk_ratelimit())
 175                         printk(KERN_ERR "can: request_module "
 176                                "(can-proto-%d) failed.\n", protocol);
 177         }
 178 #endif
 179
 180         spin_lock(&proto_tab_lock);
 181         cp = proto_tab[protocol];
 182 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 183         if (cp && !try_module_get(cp->prot->owner))
 184                 cp = NULL;
 185 #else
 186         if (cp && !try_module_get(cp->owner))
 187                 cp = NULL;
 188 #endif
 189         spin_unlock(&proto_tab_lock);
 190
 191         /* check for available protocol and correct usage */
 192
 193         if (!cp)
 194                 return -EPROTONOSUPPORT;
 195
 196         if (cp->type != sock->type) {
 197                 err = -EPROTONOSUPPORT;
 198                 goto errout;
 199         }
 200
 201         if (cp->capability >= 0 && !capable(cp->capability)) {
 202                 err = -EPERM;
 203                 goto errout;
 204         }
 205
 206         sock->ops = cp->ops;
 207
 208 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 209         sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot);
 210 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 211         sk = sk_alloc(PF_CAN, GFP_KERNEL, cp->prot, 1);
 212 #else
 213         sk = sk_alloc(PF_CAN, GFP_KERNEL, 1, 0);
 214 #endif
 215         if (!sk) {
 216                 err = -ENOMEM;
 217                 goto errout;
 218         }
 219
 220 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
 221         if (cp->obj_size) {
 222                 sk->sk_protinfo = kmalloc(cp->obj_size, GFP_KERNEL);
 223                 if (!sk->sk_protinfo) {
 224                         sk_free(sk);
 225                         err = -ENOMEM;
 226                         goto errout;
 227                 }
 228         }
 229         sk_set_owner(sk, proto_tab[protocol]->owner);
 230 #endif
 231
 232         sock_init_data(sock, sk);
 233         sk->sk_destruct = can_sock_destruct;
 234
 235 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 236         if (sk->sk_prot->init)
 237                 err = sk->sk_prot->init(sk);
 238 #else
 239         if (cp->init)
 240                 err = cp->init(sk);
 241 #endif
 242
 243         if (err) {
 244                 /* release sk on errors */
 245                 sock_orphan(sk);
 246                 sock_put(sk);
 247         }
 248
 249  errout:
 250 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 251         module_put(cp->prot->owner);
 252 #else
 253         module_put(cp->owner);
 254 #endif
 255         return err;
 256 }
 257
 258 /*
 259  * af_can tx path
 260  */
 261
 262 /**
 263  * can_send - transmit a CAN frame (optional with local loopback)
 264  * @skb: pointer to socket buffer with CAN frame in data section
 265  * @loop: loopback for listeners on local CAN sockets (recommended default!)
 266  *
 267  * Due to the loopback this routine must not be called from hardirq context.
 268  *
 269  * Return:
 270  *  0 on success
 271  *  -ENETDOWN when the selected interface is down
 272  *  -ENOBUFS on full driver queue (see net_xmit_errno())
 273  *  -ENOMEM when local loopback failed at calling skb_clone()
 274  *  -EPERM when trying to send on a non-CAN interface
 275  *  -EINVAL when the skb->data does not contain a valid CAN frame
 276  */
 277 int can_send(struct sk_buff *skb, int loop)
 278 {
 279         struct sk_buff *newskb = NULL;
 280         struct can_frame *cf = (struct can_frame *)skb->data;
 281         int err;
 282
 283         if (skb->len != sizeof(struct can_frame) || cf->can_dlc > 8) {
 284                 kfree_skb(skb);
 285                 return -EINVAL;
 286         }
 287
 288         if (skb->dev->type != ARPHRD_CAN) {
 289                 kfree_skb(skb);
 290                 return -EPERM;
 291         }
 292
 293         if (!(skb->dev->flags & IFF_UP)) {
 294                 kfree_skb(skb);
 295                 return -ENETDOWN;
 296         }
 297
 298         skb->protocol = htons(ETH_P_CAN);
 299 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
 300         skb_reset_network_header(skb);
 301         skb_reset_transport_header(skb);
 302 #else
 303         skb->nh.raw = skb->data;
 304         skb->h.raw  = skb->data;
 305 #endif
 306
 307         if (loop) {
 308                 /* local loopback of sent CAN frames */
 309
 310                 /* indication for the CAN driver: do loopback */
 311                 skb->pkt_type = PACKET_LOOPBACK;
 312
 313                 /*
 314                  * The reference to the originating sock may be required
 315                  * by the receiving socket to check whether the frame is
 316                  * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
 317                  * Therefore we have to ensure that skb->sk remains the
 318                  * reference to the originating sock by restoring skb->sk
 319                  * after each skb_clone() or skb_orphan() usage.
 320                  */
 321
 322 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
 323 #define IFF_ECHO IFF_LOOPBACK
 324 #endif
 325                 if (!(skb->dev->flags & IFF_ECHO)) {
 326                         /*
 327                          * If the interface is not capable to do loopback
 328                          * itself, we do it here.
 329                          */
 330                         newskb = skb_clone(skb, GFP_ATOMIC);
 331                         if (!newskb) {
 332                                 kfree_skb(skb);
 333                                 return -ENOMEM;
 334                         }
 335
 336                         newskb->sk = skb->sk;
 337                         newskb->ip_summed = CHECKSUM_UNNECESSARY;
 338                         newskb->pkt_type = PACKET_BROADCAST;
 339                 }
 340         } else {
 341                 /* indication for the CAN driver: no loopback required */
 342                 skb->pkt_type = PACKET_HOST;
 343         }
 344
 345         /* send to netdevice */
 346         err = dev_queue_xmit(skb);
 347         if (err > 0)
 348                 err = net_xmit_errno(err);
 349
 350         if (err) {
 351 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,17)
 352                 /* kfree_skb() does not check for !NULL on older kernels */
 353                 if (newskb)
 354                         kfree_skb(newskb);
 355 #else
 356                 kfree_skb(newskb);
 357 #endif
 358                 return err;
 359         }
 360
 361         if (newskb)
 362                 netif_rx_ni(newskb);
 363
 364         /* update statistics */
 365         can_stats.tx_frames++;
 366         can_stats.tx_frames_delta++;
 367
 368         return 0;
 369 }
 370 EXPORT_SYMBOL(can_send);
 371
 372 /*
 373  * af_can rx path
 374  */
 375
 376 static struct dev_rcv_lists *find_dev_rcv_lists(struct net_device *dev)
 377 {
 378         struct dev_rcv_lists *d = NULL;
 379         struct hlist_node *n;
 380
 381         /* find receive list for this device */
 382
 383 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
 384         /*
 385          * Since 2.6.26 a new "midlevel private" ml_priv pointer has been
 386          * introduced in struct net_device. We use this pointer to omit the
 387          * linear walk through the can_rx_dev_list. A similar speedup has been
 388          * queued for 2.6.34 mainline but using the new netdev_rcu lists.
 389          */
 390
 391         /* dev == NULL is the indicator for the 'all' filterlist */
 392         if (!dev)
 393                 return &can_rx_alldev_list;
 394
 395         /* do not search in rcu list when we have a direct reference */
 396         if (dev->ml_priv)
 397                 return (struct dev_rcv_lists *)dev->ml_priv;
 398
 399         /* fall back to standard behaviour */
 400 #endif
 401
 402         /*
 403          * The hlist_for_each_entry*() macros curse through the list
 404          * using the pointer variable n and set d to the containing
 405          * struct in each list iteration.  Therefore, after list
 406          * iteration, d is unmodified when the list is empty, and it
 407          * points to last list element, when the list is non-empty
 408          * but no match in the loop body is found.  I.e. d is *not*
 409          * NULL when no match is found.  We can, however, use the
 410          * cursor variable n to decide if a match was found.
 411          */
 412
 413         hlist_for_each_entry_rcu(d, n, &can_rx_dev_list, list) {
 414                 if (d->dev == dev)
 415                         break;
 416         }
 417
 418         return n ? d : NULL;
 419 }
 420
 421 /**
 422  * find_rcv_list - determine optimal filterlist inside device filter struct
 423  * @can_id: pointer to CAN identifier of a given can_filter
 424  * @mask: pointer to CAN mask of a given can_filter
 425  * @d: pointer to the device filter struct
 426  *
 427  * Description:
 428  *  Returns the optimal filterlist to reduce the filter handling in the
 429  *  receive path. This function is called by service functions that need
 430  *  to register or unregister a can_filter in the filter lists.
 431  *
 432  *  A filter matches in general, when
 433  *
 434  *          <received_can_id> & mask == can_id & mask
 435  *
 436  *  so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
 437  *  relevant bits for the filter.
 438  *
 439  *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
 440  *  filter for error frames (CAN_ERR_FLAG bit set in mask). For error frames
 441  *  there is a special filterlist and a special rx path filter handling.
 442  *
 443  * Return:
 444  *  Pointer to optimal filterlist for the given can_id/mask pair.
 445  *  Constistency checked mask.
 446  *  Reduced can_id to have a preprocessed filter compare value.
 447  */
 448 static struct hlist_head *find_rcv_list(canid_t *can_id, canid_t *mask,
 449                                         struct dev_rcv_lists *d)
 450 {
 451         canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
 452
 453         /* filter for error frames in extra filterlist */
 454         if (*mask & CAN_ERR_FLAG) {
 455                 /* clear CAN_ERR_FLAG in filter entry */
 456                 *mask &= CAN_ERR_MASK;
 457                 return &d->rx[RX_ERR];
 458         }
 459
 460         /* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */
 461
 462 #define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)
 463
 464         /* ensure valid values in can_mask for 'SFF only' frame filtering */
 465         if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
 466                 *mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
 467
 468         /* reduce condition testing at receive time */
 469         *can_id &= *mask;
 470
 471         /* inverse can_id/can_mask filter */
 472         if (inv)
 473                 return &d->rx[RX_INV];
 474
 475         /* mask == 0 => no condition testing at receive time */
 476         if (!(*mask))
 477                 return &d->rx[RX_ALL];
 478
 479         /* extra filterlists for the subscription of a single non-RTR can_id */
 480         if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS)
 481             && !(*can_id & CAN_RTR_FLAG)) {
 482
 483                 if (*can_id & CAN_EFF_FLAG) {
 484                         if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS)) {
 485                                 /* RFC: a future use-case for hash-tables? */
 486                                 return &d->rx[RX_EFF];
 487                         }
 488                 } else {
 489                         if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
 490                                 return &d->rx_sff[*can_id];
 491                 }
 492         }
 493
 494         /* default: filter via can_id/can_mask */
 495         return &d->rx[RX_FIL];
 496 }
 497
 498 /**
 499  * can_rx_register - subscribe CAN frames from a specific interface
 500  * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
 501  * @can_id: CAN identifier (see description)
 502  * @mask: CAN mask (see description)
 503  * @func: callback function on filter match
 504  * @data: returned parameter for callback function
 505  * @ident: string for calling module indentification
 506  *
 507  * Description:
 508  *  Invokes the callback function with the received sk_buff and the given
 509  *  parameter 'data' on a matching receive filter. A filter matches, when
 510  *
 511  *          <received_can_id> & mask == can_id & mask
 512  *
 513  *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
 514  *  filter for error frames (CAN_ERR_FLAG bit set in mask).
 515  *
 516  *  The provided pointer to the sk_buff is guaranteed to be valid as long as
 517  *  the callback function is running. The callback function must *not* free
 518  *  the given sk_buff while processing it's task. When the given sk_buff is
 519  *  needed after the end of the callback function it must be cloned inside
 520  *  the callback function with skb_clone().
 521  *
 522  * Return:
 523  *  0 on success
 524  *  -ENOMEM on missing cache mem to create subscription entry
 525  *  -ENODEV unknown device
 526  */
 527 int can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
 528                     void (*func)(struct sk_buff *, void *), void *data,
 529                     char *ident)
 530 {
 531         struct receiver *r;
 532         struct hlist_head *rl;
 533         struct dev_rcv_lists *d;
 534         int err = 0;
 535
 536         /* insert new receiver  (dev,canid,mask) -> (func,data) */
 537
 538         r = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
 539         if (!r)
 540                 return -ENOMEM;
 541
 542         spin_lock(&can_rcvlists_lock);
 543
 544         d = find_dev_rcv_lists(dev);
 545         if (d) {
 546                 rl = find_rcv_list(&can_id, &mask, d);
 547
 548                 r->can_id  = can_id;
 549                 r->mask    = mask;
 550                 r->matches = 0;
 551                 r->func    = func;
 552                 r->data    = data;
 553                 r->ident   = ident;
 554
 555                 hlist_add_head_rcu(&r->list, rl);
 556                 d->entries++;
 557
 558                 can_pstats.rcv_entries++;
 559                 if (can_pstats.rcv_entries_max < can_pstats.rcv_entries)
 560                         can_pstats.rcv_entries_max = can_pstats.rcv_entries;
 561         } else {
 562                 kmem_cache_free(rcv_cache, r);
 563                 err = -ENODEV;
 564         }
 565
 566         spin_unlock(&can_rcvlists_lock);
 567
 568         return err;
 569 }
 570 EXPORT_SYMBOL(can_rx_register);
 571
 572 /*
 573  * can_rx_delete_device - rcu callback for dev_rcv_lists structure removal
 574  */
 575 static void can_rx_delete_device(struct rcu_head *rp)
 576 {
 577         struct dev_rcv_lists *d = container_of(rp, struct dev_rcv_lists, rcu);
 578
 579         kfree(d);
 580 }
 581
 582 /*
 583  * can_rx_delete_receiver - rcu callback for single receiver entry removal
 584  */
 585 static void can_rx_delete_receiver(struct rcu_head *rp)
 586 {
 587         struct receiver *r = container_of(rp, struct receiver, rcu);
 588
 589         kmem_cache_free(rcv_cache, r);
 590 }
 591
 592 /**
 593  * can_rx_unregister - unsubscribe CAN frames from a specific interface
 594  * @dev: pointer to netdevice (NULL => unsubcribe from 'all' CAN devices list)
 595  * @can_id: CAN identifier
 596  * @mask: CAN mask
 597  * @func: callback function on filter match
 598  * @data: returned parameter for callback function
 599  *
 600  * Description:
 601  *  Removes subscription entry depending on given (subscription) values.
 602  */
 603 void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
 604                        void (*func)(struct sk_buff *, void *), void *data)
 605 {
 606         struct receiver *r = NULL;
 607         struct hlist_head *rl;
 608         struct hlist_node *next;
 609         struct dev_rcv_lists *d;
 610
 611         spin_lock(&can_rcvlists_lock);
 612
 613         d = find_dev_rcv_lists(dev);
 614         if (!d) {
 615                 printk(KERN_ERR "BUG: receive list not found for "
 616                        "dev %s, id %03X, mask %03X\n",
 617                        DNAME(dev), can_id, mask);
 618                 goto out;
 619         }
 620
 621         rl = find_rcv_list(&can_id, &mask, d);
 622
 623         /*
 624          * Search the receiver list for the item to delete.  This should
 625          * exist, since no receiver may be unregistered that hasn't
 626          * been registered before.
 627          */
 628
 629         hlist_for_each_entry_rcu(r, next, rl, list) {
 630                 if (r->can_id == can_id && r->mask == mask
 631                     && r->func == func && r->data == data)
 632                         break;
 633         }
 634
 635         /*
 636          * Check for bugs in CAN protocol implementations:
 637          * If no matching list item was found, the list cursor variable next
 638          * will be NULL, while r will point to the last item of the list.
 639          */
 640
 641         if (!next) {
 642                 printk(KERN_ERR "BUG: receive list entry not found for "
 643                        "dev %s, id %03X, mask %03X\n",
 644                        DNAME(dev), can_id, mask);
 645                 r = NULL;
 646                 d = NULL;
 647                 goto out;
 648         }
 649
 650         hlist_del_rcu(&r->list);
 651         d->entries--;
 652
 653         if (can_pstats.rcv_entries > 0)
 654                 can_pstats.rcv_entries--;
 655
 656         /* remove device structure requested by NETDEV_UNREGISTER */
 657         if (d->remove_on_zero_entries && !d->entries)
 658                 hlist_del_rcu(&d->list);
 659         else
 660                 d = NULL;
 661
 662  out:
 663         spin_unlock(&can_rcvlists_lock);
 664
 665         /* schedule the receiver item for deletion */
 666         if (r)
 667                 call_rcu(&r->rcu, can_rx_delete_receiver);
 668
 669         /* schedule the device structure for deletion */
 670         if (d)
 671                 call_rcu(&d->rcu, can_rx_delete_device);
 672 }
 673 EXPORT_SYMBOL(can_rx_unregister);
 674
 675 static inline void deliver(struct sk_buff *skb, struct receiver *r)
 676 {
 677         r->func(skb, r->data);
 678         r->matches++;
 679 }
 680
 681 static int can_rcv_filter(struct dev_rcv_lists *d, struct sk_buff *skb)
 682 {
 683         struct receiver *r;
 684         struct hlist_node *n;
 685         int matches = 0;
 686         struct can_frame *cf = (struct can_frame *)skb->data;
 687         canid_t can_id = cf->can_id;
 688
 689         if (d->entries == 0)
 690                 return 0;
 691
 692         if (can_id & CAN_ERR_FLAG) {
 693                 /* check for error frame entries only */
 694                 hlist_for_each_entry_rcu(r, n, &d->rx[RX_ERR], list) {
 695                         if (can_id & r->mask) {
 696                                 deliver(skb, r);
 697                                 matches++;
 698                         }
 699                 }
 700                 return matches;
 701         }
 702
 703         /* check for unfiltered entries */
 704         hlist_for_each_entry_rcu(r, n, &d->rx[RX_ALL], list) {
 705                 deliver(skb, r);
 706                 matches++;
 707         }
 708
 709         /* check for can_id/mask entries */
 710         hlist_for_each_entry_rcu(r, n, &d->rx[RX_FIL], list) {
 711                 if ((can_id & r->mask) == r->can_id) {
 712                         deliver(skb, r);
 713                         matches++;
 714                 }
 715         }
 716
 717         /* check for inverted can_id/mask entries */
 718         hlist_for_each_entry_rcu(r, n, &d->rx[RX_INV], list) {
 719                 if ((can_id & r->mask) != r->can_id) {
 720                         deliver(skb, r);
 721                         matches++;
 722                 }
 723         }
 724
 725         /* check filterlists for single non-RTR can_ids */
 726         if (can_id & CAN_RTR_FLAG)
 727                 return matches;
 728
 729         if (can_id & CAN_EFF_FLAG) {
 730                 hlist_for_each_entry_rcu(r, n, &d->rx[RX_EFF], list) {
 731                         if (r->can_id == can_id) {
 732                                 deliver(skb, r);
 733                                 matches++;
 734                         }
 735                 }
 736         } else {
 737                 can_id &= CAN_SFF_MASK;
 738                 hlist_for_each_entry_rcu(r, n, &d->rx_sff[can_id], list) {
 739                         deliver(skb, r);
 740                         matches++;
 741                 }
 742         }
 743
 744         return matches;
 745 }
 746
 747 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,14)
 748 static int can_rcv(struct sk_buff *skb, struct net_device *dev,
 749                    struct packet_type *pt, struct net_device *orig_dev)
 750 #else
 751 static int can_rcv(struct sk_buff *skb, struct net_device *dev,
 752                    struct packet_type *pt)
 753 #endif
 754 {
 755         struct dev_rcv_lists *d;
 756         struct can_frame *cf = (struct can_frame *)skb->data;
 757         int matches;
 758
 759 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
 760         if (!net_eq(dev_net(dev), &init_net))
 761                 goto drop;
 762 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 763         if (dev->nd_net != &init_net)
 764                 goto drop;
 765 #endif
 766
 767 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,27)
 768         if (WARN_ONCE(dev->type != ARPHRD_CAN ||
 769                       skb->len != sizeof(struct can_frame) ||
 770                       cf->can_dlc > 8,
 771                       "PF_CAN: dropped non conform skbuf: "
 772                       "dev type %d, len %d, can_dlc %d\n",
 773                       dev->type, skb->len, cf->can_dlc))
 774                 goto drop;
 775 #else
 776         BUG_ON(dev->type != ARPHRD_CAN ||
 777                skb->len != sizeof(struct can_frame) ||
 778                cf->can_dlc > 8);
 779 #endif
 780
 781         /* update statistics */
 782         can_stats.rx_frames++;
 783         can_stats.rx_frames_delta++;
 784
 785         rcu_read_lock();
 786
 787         /* deliver the packet to sockets listening on all devices */
 788         matches = can_rcv_filter(&can_rx_alldev_list, skb);
 789
 790         /* find receive list for this device */
 791         d = find_dev_rcv_lists(dev);
 792         if (d)
 793                 matches += can_rcv_filter(d, skb);
 794
 795         rcu_read_unlock();
 796
 797         /* consume the skbuff allocated by the netdevice driver */
 798 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,30)
 799         consume_skb(skb);
 800 #else
 801         kfree_skb(skb);
 802 #endif
 803
 804         if (matches > 0) {
 805                 can_stats.matches++;
 806                 can_stats.matches_delta++;
 807         }
 808
 809         return NET_RX_SUCCESS;
 810
 811 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 812 drop:
 813         kfree_skb(skb);
 814         return NET_RX_DROP;
 815 #endif
 816 }
 817
 818 /*
 819  * af_can protocol functions
 820  */
 821
 822 /**
 823  * can_proto_register - register CAN transport protocol
 824  * @cp: pointer to CAN protocol structure
 825  *
 826  * Return:
 827  *  0 on success
 828  *  -EINVAL invalid (out of range) protocol number
 829  *  -EBUSY  protocol already in use
 830  *  -ENOBUF if proto_register() fails
 831  */
 832 int can_proto_register(struct can_proto *cp)
 833 {
 834         int proto = cp->protocol;
 835         int err = 0;
 836
 837         if (proto < 0 || proto >= CAN_NPROTO) {
 838                 printk(KERN_ERR "can: protocol number %d out of range\n",
 839                        proto);
 840                 return -EINVAL;
 841         }
 842
 843 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 844         err = proto_register(cp->prot, 0);
 845         if (err < 0)
 846                 return err;
 847 #endif
 848
 849         spin_lock(&proto_tab_lock);
 850         if (proto_tab[proto]) {
 851                 printk(KERN_ERR "can: protocol %d already registered\n",
 852                        proto);
 853                 err = -EBUSY;
 854         } else {
 855                 proto_tab[proto] = cp;
 856
 857                 /* use generic ioctl function if not defined by module */
 858                 if (!cp->ops->ioctl)
 859                         cp->ops->ioctl = can_ioctl;
 860         }
 861         spin_unlock(&proto_tab_lock);
 862
 863 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 864         if (err < 0)
 865                 proto_unregister(cp->prot);
 866 #endif
 867
 868         return err;
 869 }
 870 EXPORT_SYMBOL(can_proto_register);
 871
 872 /**
 873  * can_proto_unregister - unregister CAN transport protocol
 874  * @cp: pointer to CAN protocol structure
 875  */
 876 void can_proto_unregister(struct can_proto *cp)
 877 {
 878         int proto = cp->protocol;
 879
 880         spin_lock(&proto_tab_lock);
 881         if (!proto_tab[proto]) {
 882                 printk(KERN_ERR "BUG: can: protocol %d is not registered\n",
 883                        proto);
 884         }
 885         proto_tab[proto] = NULL;
 886         spin_unlock(&proto_tab_lock);
 887
 888 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
 889         proto_unregister(cp->prot);
 890 #endif
 891 }
 892 EXPORT_SYMBOL(can_proto_unregister);
 893
 894 /*
 895  * af_can notifier to create/remove CAN netdevice specific structs
 896  */
 897 static int can_notifier(struct notifier_block *nb, unsigned long msg,
 898                         void *data)
 899 {
 900         struct net_device *dev = (struct net_device *)data;
 901         struct dev_rcv_lists *d;
 902
 903 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
 904         if (!net_eq(dev_net(dev), &init_net))
 905                 return NOTIFY_DONE;
 906 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 907         if (dev->nd_net != &init_net)
 908                 return NOTIFY_DONE;
 909 #endif
 910
 911         if (dev->type != ARPHRD_CAN)
 912                 return NOTIFY_DONE;
 913
 914         switch (msg) {
 915
 916         case NETDEV_REGISTER:
 917
 918                 /*
 919                  * create new dev_rcv_lists for this device
 920                  *
 921                  * N.B. zeroing the struct is the correct initialization
 922                  * for the embedded hlist_head structs.
 923                  * Another list type, e.g. list_head, would require
 924                  * explicit initialization.
 925                  */
 926
 927                 d = kzalloc(sizeof(*d), GFP_KERNEL);
 928                 if (!d) {
 929                         printk(KERN_ERR
 930                                "can: allocation of receive list failed\n");
 931                         return NOTIFY_DONE;
 932                 }
 933                 d->dev = dev;
 934
 935                 spin_lock(&can_rcvlists_lock);
 936 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
 937                 dev->ml_priv = d;
 938 #endif
 939                 hlist_add_head_rcu(&d->list, &can_rx_dev_list);
 940                 spin_unlock(&can_rcvlists_lock);
 941
 942                 break;
 943
 944         case NETDEV_UNREGISTER:
 945                 spin_lock(&can_rcvlists_lock);
 946
 947                 d = find_dev_rcv_lists(dev);
 948                 if (d) {
 949                         if (d->entries) {
 950                                 d->remove_on_zero_entries = 1;
 951                                 d = NULL;
 952                         } else {
 953 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
 954                                 dev->ml_priv = NULL;
 955 #endif
 956                                 hlist_del_rcu(&d->list);
 957                         }
 958                 } else
 959                         printk(KERN_ERR "can: notifier: receive list not "
 960                                "found for dev %s\n", dev->name);
 961
 962                 spin_unlock(&can_rcvlists_lock);
 963
 964                 if (d)
 965                         call_rcu(&d->rcu, can_rx_delete_device);
 966
 967                 break;
 968         }
 969
 970         return NOTIFY_DONE;
 971 }
 972
 973 /*
 974  * af_can module init/exit functions
 975  */
 976
 977 static struct packet_type can_packet __read_mostly = {
 978 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,30)
 979         .type = cpu_to_be16(ETH_P_CAN),
 980 #else
 981         .type = __constant_htons(ETH_P_CAN),
 982 #endif
 983         .dev  = NULL,
 984         .func = can_rcv,
 985 };
 986
 987 static struct net_proto_family can_family_ops __read_mostly = {
 988         .family = PF_CAN,
 989         .create = can_create,
 990         .owner  = THIS_MODULE,
 991 };
 992
 993 /* notifier block for netdevice event */
 994 static struct notifier_block can_netdev_notifier __read_mostly = {
 995         .notifier_call = can_notifier,
 996 };
 997
 998 static __init int can_init(void)
 999 {
1000         printk(banner);
1001
1002 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,23)
1003         rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
1004                                       0, 0, NULL);
1005 #else
1006         rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
1007                                       0, 0, NULL, NULL);
1008 #endif
1009         if (!rcv_cache)
1010                 return -ENOMEM;
1011
1012         /*
1013          * Insert can_rx_alldev_list for reception on all devices.
1014          * This struct is zero initialized which is correct for the
1015          * embedded hlist heads, the dev pointer, and the entries counter.
1016          */
1017
1018         spin_lock(&can_rcvlists_lock);
1019         hlist_add_head_rcu(&can_rx_alldev_list.list, &can_rx_dev_list);
1020         spin_unlock(&can_rcvlists_lock);
1021
1022         if (stats_timer) {
1023                 /* the statistics are updated every second (timer triggered) */
1024                 setup_timer(&can_stattimer, can_stat_update, 0);
1025                 mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
1026         } else
1027                 can_stattimer.function = NULL;
1028
1029         can_init_proc();
1030
1031         /* protocol register */
1032         sock_register(&can_family_ops);
1033         register_netdevice_notifier(&can_netdev_notifier);
1034         dev_add_pack(&can_packet);
1035
1036         return 0;
1037 }
1038
1039 static __exit void can_exit(void)
1040 {
1041         struct dev_rcv_lists *d;
1042         struct hlist_node *n, *next;
1043
1044         if (stats_timer)
1045                 del_timer(&can_stattimer);
1046
1047         can_remove_proc();
1048
1049         /* protocol unregister */
1050         dev_remove_pack(&can_packet);
1051         unregister_netdevice_notifier(&can_netdev_notifier);
1052         sock_unregister(PF_CAN);
1053
1054         /* remove can_rx_dev_list */
1055         spin_lock(&can_rcvlists_lock);
1056         hlist_del(&can_rx_alldev_list.list);
1057         hlist_for_each_entry_safe(d, n, next, &can_rx_dev_list, list) {
1058                 hlist_del(&d->list);
1059                 kfree(d);
1060         }
1061         spin_unlock(&can_rcvlists_lock);
1062
1063 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,15)
1064         rcu_barrier(); /* Wait for completion of call_rcu()'s */
1065 #endif
1066
1067         kmem_cache_destroy(rcv_cache);
1068 }
1069
1070 module_init(can_init);
1071 module_exit(can_exit);