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