af_can.c 24.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/*
 * af_can.c - Protocol family CAN core module
 *            (used by different CAN protocol modules)
 *
 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Volkswagen nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * Alternatively, provided that this notice is retained in full, this
 * software may be distributed under the terms of the GNU General
 * Public License ("GPL") version 2, in which case the provisions of the
 * GPL apply INSTEAD OF those given above.
 *
 * The provided data structures and external interfaces from this code
 * are not restricted to be used by modules with a GPL compatible license.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 */

#include <linux/module.h>
44
#include <linux/stddef.h>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
#include <linux/init.h>
#include <linux/kmod.h>
#include <linux/slab.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/rcupdate.h>
#include <linux/uaccess.h>
#include <linux/net.h>
#include <linux/netdevice.h>
#include <linux/socket.h>
#include <linux/if_ether.h>
#include <linux/if_arp.h>
#include <linux/skbuff.h>
#include <linux/can.h>
#include <linux/can/core.h>
60
#include <linux/can/skb.h>
61
#include <linux/ratelimit.h>
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
#include <net/net_namespace.h>
#include <net/sock.h>

#include "af_can.h"

MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
MODULE_LICENSE("Dual BSD/GPL");
MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
	      "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");

MODULE_ALIAS_NETPROTO(PF_CAN);

static int stats_timer __read_mostly = 1;
module_param(stats_timer, int, S_IRUGO);
MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");

78 79
/* receive filters subscribed for 'all' CAN devices */
struct dev_rcv_lists can_rx_alldev_list;
80 81 82 83 84
static DEFINE_SPINLOCK(can_rcvlists_lock);

static struct kmem_cache *rcv_cache __read_mostly;

/* table of registered CAN protocols */
85
static const struct can_proto *proto_tab[CAN_NPROTO] __read_mostly;
86
static DEFINE_MUTEX(proto_tab_lock);
87 88 89 90 91

struct timer_list can_stattimer;   /* timer for statistics update */
struct s_stats    can_stats;       /* packet statistics */
struct s_pstats   can_pstats;      /* receive list statistics */

92 93
static atomic_t skbcounter = ATOMIC_INIT(0);

94 95 96 97
/*
 * af_can socket functions
 */

Oliver Hartkopp's avatar
Oliver Hartkopp committed
98
int can_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
99 100 101 102 103 104 105 106 107 108 109 110
{
	struct sock *sk = sock->sk;

	switch (cmd) {

	case SIOCGSTAMP:
		return sock_get_timestamp(sk, (struct timeval __user *)arg);

	default:
		return -ENOIOCTLCMD;
	}
}
Oliver Hartkopp's avatar
Oliver Hartkopp committed
111
EXPORT_SYMBOL(can_ioctl);
112 113 114 115 116 117

static void can_sock_destruct(struct sock *sk)
{
	skb_queue_purge(&sk->sk_receive_queue);
}

118
static const struct can_proto *can_get_proto(int protocol)
119
{
120
	const struct can_proto *cp;
121 122 123 124 125 126 127 128 129 130

	rcu_read_lock();
	cp = rcu_dereference(proto_tab[protocol]);
	if (cp && !try_module_get(cp->prot->owner))
		cp = NULL;
	rcu_read_unlock();

	return cp;
}

131 132 133 134 135
static inline void can_put_proto(const struct can_proto *cp)
{
	module_put(cp->prot->owner);
}

136 137
static int can_create(struct net *net, struct socket *sock, int protocol,
		      int kern)
138 139
{
	struct sock *sk;
140
	const struct can_proto *cp;
141 142 143 144 145 146 147
	int err = 0;

	sock->state = SS_UNCONNECTED;

	if (protocol < 0 || protocol >= CAN_NPROTO)
		return -EINVAL;

148
	if (!net_eq(net, &init_net))
149 150
		return -EAFNOSUPPORT;

151
	cp = can_get_proto(protocol);
152

153
#ifdef CONFIG_MODULES
154 155 156
	if (!cp) {
		/* try to load protocol module if kernel is modular */

157
		err = request_module("can-proto-%d", protocol);
158 159 160 161 162 163

		/*
		 * In case of error we only print a message but don't
		 * return the error code immediately.  Below we will
		 * return -EPROTONOSUPPORT
		 */
164 165
		if (err)
			printk_ratelimited(KERN_ERR "can: request_module "
166
			       "(can-proto-%d) failed.\n", protocol);
167

168
		cp = can_get_proto(protocol);
169
	}
170
#endif
171 172 173 174 175 176 177

	/* check for available protocol and correct usage */

	if (!cp)
		return -EPROTONOSUPPORT;

	if (cp->type != sock->type) {
178
		err = -EPROTOTYPE;
179 180 181 182 183
		goto errout;
	}

	sock->ops = cp->ops;

184
	sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot, kern);
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
	if (!sk) {
		err = -ENOMEM;
		goto errout;
	}

	sock_init_data(sock, sk);
	sk->sk_destruct = can_sock_destruct;

	if (sk->sk_prot->init)
		err = sk->sk_prot->init(sk);

	if (err) {
		/* release sk on errors */
		sock_orphan(sk);
		sock_put(sk);
	}

 errout:
203
	can_put_proto(cp);
204 205 206 207 208 209 210 211 212 213 214 215
	return err;
}

/*
 * af_can tx path
 */

/**
 * can_send - transmit a CAN frame (optional with local loopback)
 * @skb: pointer to socket buffer with CAN frame in data section
 * @loop: loopback for listeners on local CAN sockets (recommended default!)
 *
216 217
 * Due to the loopback this routine must not be called from hardirq context.
 *
218 219 220 221 222 223
 * Return:
 *  0 on success
 *  -ENETDOWN when the selected interface is down
 *  -ENOBUFS on full driver queue (see net_xmit_errno())
 *  -ENOMEM when local loopback failed at calling skb_clone()
 *  -EPERM when trying to send on a non-CAN interface
224
 *  -EMSGSIZE CAN frame size is bigger than CAN interface MTU
Oliver Hartkopp's avatar
Oliver Hartkopp committed
225
 *  -EINVAL when the skb->data does not contain a valid CAN frame
226 227 228
 */
int can_send(struct sk_buff *skb, int loop)
{
229
	struct sk_buff *newskb = NULL;
230 231 232 233 234 235 236 237 238 239 240 241 242
	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
	int err = -EINVAL;

	if (skb->len == CAN_MTU) {
		skb->protocol = htons(ETH_P_CAN);
		if (unlikely(cfd->len > CAN_MAX_DLEN))
			goto inval_skb;
	} else if (skb->len == CANFD_MTU) {
		skb->protocol = htons(ETH_P_CANFD);
		if (unlikely(cfd->len > CANFD_MAX_DLEN))
			goto inval_skb;
	} else
		goto inval_skb;
243

244 245 246 247 248 249 250 251
	/*
	 * Make sure the CAN frame can pass the selected CAN netdevice.
	 * As structs can_frame and canfd_frame are similar, we can provide
	 * CAN FD frames to legacy CAN drivers as long as the length is <= 8
	 */
	if (unlikely(skb->len > skb->dev->mtu && cfd->len > CAN_MAX_DLEN)) {
		err = -EMSGSIZE;
		goto inval_skb;
Oliver Hartkopp's avatar
Oliver Hartkopp committed
252 253
	}

254 255 256
	if (unlikely(skb->dev->type != ARPHRD_CAN)) {
		err = -EPERM;
		goto inval_skb;
257 258
	}

259 260 261
	if (unlikely(!(skb->dev->flags & IFF_UP))) {
		err = -ENETDOWN;
		goto inval_skb;
262 263
	}

264 265 266
	skb->ip_summed = CHECKSUM_UNNECESSARY;

	skb_reset_mac_header(skb);
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
	skb_reset_network_header(skb);
	skb_reset_transport_header(skb);

	if (loop) {
		/* local loopback of sent CAN frames */

		/* indication for the CAN driver: do loopback */
		skb->pkt_type = PACKET_LOOPBACK;

		/*
		 * The reference to the originating sock may be required
		 * by the receiving socket to check whether the frame is
		 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
		 * Therefore we have to ensure that skb->sk remains the
		 * reference to the originating sock by restoring skb->sk
		 * after each skb_clone() or skb_orphan() usage.
		 */

		if (!(skb->dev->flags & IFF_ECHO)) {
			/*
			 * If the interface is not capable to do loopback
			 * itself, we do it here.
			 */
290
			newskb = skb_clone(skb, GFP_ATOMIC);
291 292 293 294 295
			if (!newskb) {
				kfree_skb(skb);
				return -ENOMEM;
			}

296
			can_skb_set_owner(newskb, skb->sk);
297 298 299 300 301 302 303 304 305 306 307 308 309
			newskb->ip_summed = CHECKSUM_UNNECESSARY;
			newskb->pkt_type = PACKET_BROADCAST;
		}
	} else {
		/* indication for the CAN driver: no loopback required */
		skb->pkt_type = PACKET_HOST;
	}

	/* send to netdevice */
	err = dev_queue_xmit(skb);
	if (err > 0)
		err = net_xmit_errno(err);

310
	if (err) {
311
		kfree_skb(newskb);
312 313 314
		return err;
	}

315
	if (newskb)
316
		netif_rx_ni(newskb);
317

318 319 320 321
	/* update statistics */
	can_stats.tx_frames++;
	can_stats.tx_frames_delta++;

322
	return 0;
323 324 325 326

inval_skb:
	kfree_skb(skb);
	return err;
327 328 329 330 331 332 333 334 335
}
EXPORT_SYMBOL(can_send);

/*
 * af_can rx path
 */

static struct dev_rcv_lists *find_dev_rcv_lists(struct net_device *dev)
{
336 337 338 339
	if (!dev)
		return &can_rx_alldev_list;
	else
		return (struct dev_rcv_lists *)dev->ml_priv;
340 341
}

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/**
 * effhash - hash function for 29 bit CAN identifier reduction
 * @can_id: 29 bit CAN identifier
 *
 * Description:
 *  To reduce the linear traversal in one linked list of _single_ EFF CAN
 *  frame subscriptions the 29 bit identifier is mapped to 10 bits.
 *  (see CAN_EFF_RCV_HASH_BITS definition)
 *
 * Return:
 *  Hash value from 0x000 - 0x3FF ( enforced by CAN_EFF_RCV_HASH_BITS mask )
 */
static unsigned int effhash(canid_t can_id)
{
	unsigned int hash;

	hash = can_id;
	hash ^= can_id >> CAN_EFF_RCV_HASH_BITS;
	hash ^= can_id >> (2 * CAN_EFF_RCV_HASH_BITS);

	return hash & ((1 << CAN_EFF_RCV_HASH_BITS) - 1);
}

365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
/**
 * find_rcv_list - determine optimal filterlist inside device filter struct
 * @can_id: pointer to CAN identifier of a given can_filter
 * @mask: pointer to CAN mask of a given can_filter
 * @d: pointer to the device filter struct
 *
 * Description:
 *  Returns the optimal filterlist to reduce the filter handling in the
 *  receive path. This function is called by service functions that need
 *  to register or unregister a can_filter in the filter lists.
 *
 *  A filter matches in general, when
 *
 *          <received_can_id> & mask == can_id & mask
 *
 *  so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
 *  relevant bits for the filter.
 *
 *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
384 385
 *  filter for error messages (CAN_ERR_FLAG bit set in mask). For error msg
 *  frames there is a special filterlist and a special rx path filter handling.
386 387 388 389 390 391
 *
 * Return:
 *  Pointer to optimal filterlist for the given can_id/mask pair.
 *  Constistency checked mask.
 *  Reduced can_id to have a preprocessed filter compare value.
 */
392 393 394 395 396
static struct hlist_head *find_rcv_list(canid_t *can_id, canid_t *mask,
					struct dev_rcv_lists *d)
{
	canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */

397
	/* filter for error message frames in extra filterlist */
398
	if (*mask & CAN_ERR_FLAG) {
399
		/* clear CAN_ERR_FLAG in filter entry */
400 401 402 403
		*mask &= CAN_ERR_MASK;
		return &d->rx[RX_ERR];
	}

404 405 406 407 408 409 410
	/* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */

#define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)

	/* ensure valid values in can_mask for 'SFF only' frame filtering */
	if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
		*mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
411 412 413 414 415 416 417 418 419 420 421 422

	/* reduce condition testing at receive time */
	*can_id &= *mask;

	/* inverse can_id/can_mask filter */
	if (inv)
		return &d->rx[RX_INV];

	/* mask == 0 => no condition testing at receive time */
	if (!(*mask))
		return &d->rx[RX_ALL];

423
	/* extra filterlists for the subscription of a single non-RTR can_id */
424 425
	if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS) &&
	    !(*can_id & CAN_RTR_FLAG)) {
426 427

		if (*can_id & CAN_EFF_FLAG) {
428 429
			if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS))
				return &d->rx_eff[effhash(*can_id)];
430 431 432
		} else {
			if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
				return &d->rx_sff[*can_id];
433 434 435 436 437 438 439 440 441 442 443 444 445 446
		}
	}

	/* default: filter via can_id/can_mask */
	return &d->rx[RX_FIL];
}

/**
 * can_rx_register - subscribe CAN frames from a specific interface
 * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
 * @can_id: CAN identifier (see description)
 * @mask: CAN mask (see description)
 * @func: callback function on filter match
 * @data: returned parameter for callback function
447
 * @ident: string for calling module identification
448
 * @sk: socket pointer (might be NULL)
449 450 451 452 453 454 455 456
 *
 * Description:
 *  Invokes the callback function with the received sk_buff and the given
 *  parameter 'data' on a matching receive filter. A filter matches, when
 *
 *          <received_can_id> & mask == can_id & mask
 *
 *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
457
 *  filter for error message frames (CAN_ERR_FLAG bit set in mask).
458
 *
459 460 461 462 463 464
 *  The provided pointer to the sk_buff is guaranteed to be valid as long as
 *  the callback function is running. The callback function must *not* free
 *  the given sk_buff while processing it's task. When the given sk_buff is
 *  needed after the end of the callback function it must be cloned inside
 *  the callback function with skb_clone().
 *
465 466 467 468 469 470 471
 * Return:
 *  0 on success
 *  -ENOMEM on missing cache mem to create subscription entry
 *  -ENODEV unknown device
 */
int can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
		    void (*func)(struct sk_buff *, void *), void *data,
472
		    char *ident, struct sock *sk)
473 474 475 476 477 478 479 480
{
	struct receiver *r;
	struct hlist_head *rl;
	struct dev_rcv_lists *d;
	int err = 0;

	/* insert new receiver  (dev,canid,mask) -> (func,data) */

481 482 483
	if (dev && dev->type != ARPHRD_CAN)
		return -ENODEV;

484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
	r = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
	if (!r)
		return -ENOMEM;

	spin_lock(&can_rcvlists_lock);

	d = find_dev_rcv_lists(dev);
	if (d) {
		rl = find_rcv_list(&can_id, &mask, d);

		r->can_id  = can_id;
		r->mask    = mask;
		r->matches = 0;
		r->func    = func;
		r->data    = data;
		r->ident   = ident;
500
		r->sk      = sk;
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524

		hlist_add_head_rcu(&r->list, rl);
		d->entries++;

		can_pstats.rcv_entries++;
		if (can_pstats.rcv_entries_max < can_pstats.rcv_entries)
			can_pstats.rcv_entries_max = can_pstats.rcv_entries;
	} else {
		kmem_cache_free(rcv_cache, r);
		err = -ENODEV;
	}

	spin_unlock(&can_rcvlists_lock);

	return err;
}
EXPORT_SYMBOL(can_rx_register);

/*
 * can_rx_delete_receiver - rcu callback for single receiver entry removal
 */
static void can_rx_delete_receiver(struct rcu_head *rp)
{
	struct receiver *r = container_of(rp, struct receiver, rcu);
525
	struct sock *sk = r->sk;
526 527

	kmem_cache_free(rcv_cache, r);
528 529
	if (sk)
		sock_put(sk);
530 531 532 533
}

/**
 * can_rx_unregister - unsubscribe CAN frames from a specific interface
Jeremiah Mahler's avatar
Jeremiah Mahler committed
534
 * @dev: pointer to netdevice (NULL => unsubscribe from 'all' CAN devices list)
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
 * @can_id: CAN identifier
 * @mask: CAN mask
 * @func: callback function on filter match
 * @data: returned parameter for callback function
 *
 * Description:
 *  Removes subscription entry depending on given (subscription) values.
 */
void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
		       void (*func)(struct sk_buff *, void *), void *data)
{
	struct receiver *r = NULL;
	struct hlist_head *rl;
	struct dev_rcv_lists *d;

550 551 552
	if (dev && dev->type != ARPHRD_CAN)
		return;

553 554 555 556
	spin_lock(&can_rcvlists_lock);

	d = find_dev_rcv_lists(dev);
	if (!d) {
557
		pr_err("BUG: receive list not found for "
558 559 560 561 562 563 564 565 566 567 568 569 570
		       "dev %s, id %03X, mask %03X\n",
		       DNAME(dev), can_id, mask);
		goto out;
	}

	rl = find_rcv_list(&can_id, &mask, d);

	/*
	 * Search the receiver list for the item to delete.  This should
	 * exist, since no receiver may be unregistered that hasn't
	 * been registered before.
	 */

571
	hlist_for_each_entry_rcu(r, rl, list) {
572 573
		if (r->can_id == can_id && r->mask == mask &&
		    r->func == func && r->data == data)
574 575 576 577
			break;
	}

	/*
578 579
	 * Check for bugs in CAN protocol implementations using af_can.c:
	 * 'r' will be NULL if no matching list item was found for removal.
580 581
	 */

582
	if (!r) {
583 584
		WARN(1, "BUG: receive list entry not found for dev %s, "
		     "id %03X, mask %03X\n", DNAME(dev), can_id, mask);
585 586 587 588 589 590 591 592 593 594
		goto out;
	}

	hlist_del_rcu(&r->list);
	d->entries--;

	if (can_pstats.rcv_entries > 0)
		can_pstats.rcv_entries--;

	/* remove device structure requested by NETDEV_UNREGISTER */
595 596 597 598
	if (d->remove_on_zero_entries && !d->entries) {
		kfree(d);
		dev->ml_priv = NULL;
	}
599 600 601 602 603

 out:
	spin_unlock(&can_rcvlists_lock);

	/* schedule the receiver item for deletion */
604 605 606
	if (r) {
		if (r->sk)
			sock_hold(r->sk);
607
		call_rcu(&r->rcu, can_rx_delete_receiver);
608
	}
609 610 611 612 613
}
EXPORT_SYMBOL(can_rx_unregister);

static inline void deliver(struct sk_buff *skb, struct receiver *r)
{
614 615
	r->func(skb, r->data);
	r->matches++;
616 617 618 619 620 621 622 623 624 625 626 627 628
}

static int can_rcv_filter(struct dev_rcv_lists *d, struct sk_buff *skb)
{
	struct receiver *r;
	int matches = 0;
	struct can_frame *cf = (struct can_frame *)skb->data;
	canid_t can_id = cf->can_id;

	if (d->entries == 0)
		return 0;

	if (can_id & CAN_ERR_FLAG) {
629
		/* check for error message frame entries only */
630
		hlist_for_each_entry_rcu(r, &d->rx[RX_ERR], list) {
631 632 633 634 635 636 637 638 639
			if (can_id & r->mask) {
				deliver(skb, r);
				matches++;
			}
		}
		return matches;
	}

	/* check for unfiltered entries */
640
	hlist_for_each_entry_rcu(r, &d->rx[RX_ALL], list) {
641 642 643 644 645
		deliver(skb, r);
		matches++;
	}

	/* check for can_id/mask entries */
646
	hlist_for_each_entry_rcu(r, &d->rx[RX_FIL], list) {
647 648 649 650 651 652 653
		if ((can_id & r->mask) == r->can_id) {
			deliver(skb, r);
			matches++;
		}
	}

	/* check for inverted can_id/mask entries */
654
	hlist_for_each_entry_rcu(r, &d->rx[RX_INV], list) {
655 656 657 658 659 660
		if ((can_id & r->mask) != r->can_id) {
			deliver(skb, r);
			matches++;
		}
	}

661 662 663 664
	/* check filterlists for single non-RTR can_ids */
	if (can_id & CAN_RTR_FLAG)
		return matches;

665
	if (can_id & CAN_EFF_FLAG) {
666
		hlist_for_each_entry_rcu(r, &d->rx_eff[effhash(can_id)], list) {
667 668 669 670 671 672 673
			if (r->can_id == can_id) {
				deliver(skb, r);
				matches++;
			}
		}
	} else {
		can_id &= CAN_SFF_MASK;
674
		hlist_for_each_entry_rcu(r, &d->rx_sff[can_id], list) {
675 676 677 678 679 680 681 682
			deliver(skb, r);
			matches++;
		}
	}

	return matches;
}

683
static void can_receive(struct sk_buff *skb, struct net_device *dev)
684 685 686 687 688 689 690 691
{
	struct dev_rcv_lists *d;
	int matches;

	/* update statistics */
	can_stats.rx_frames++;
	can_stats.rx_frames_delta++;

692 693 694 695
	/* create non-zero unique skb identifier together with *skb */
	while (!(can_skb_prv(skb)->skbcnt))
		can_skb_prv(skb)->skbcnt = atomic_inc_return(&skbcounter);

696 697 698 699 700 701 702 703 704 705 706 707
	rcu_read_lock();

	/* deliver the packet to sockets listening on all devices */
	matches = can_rcv_filter(&can_rx_alldev_list, skb);

	/* find receive list for this device */
	d = find_dev_rcv_lists(dev);
	if (d)
		matches += can_rcv_filter(d, skb);

	rcu_read_unlock();

708 709
	/* consume the skbuff allocated by the netdevice driver */
	consume_skb(skb);
710 711 712 713 714

	if (matches > 0) {
		can_stats.matches++;
		can_stats.matches_delta++;
	}
715 716 717 718 719 720
}

static int can_rcv(struct sk_buff *skb, struct net_device *dev,
		   struct packet_type *pt, struct net_device *orig_dev)
{
	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
	if (unlikely(!net_eq(dev_net(dev), &init_net)))
		goto drop;

	if (WARN_ONCE(dev->type != ARPHRD_CAN ||
		      skb->len != CAN_MTU ||
		      cfd->len > CAN_MAX_DLEN,
		      "PF_CAN: dropped non conform CAN skbuf: "
		      "dev type %d, len %d, datalen %d\n",
		      dev->type, skb->len, cfd->len))
		goto drop;

	can_receive(skb, dev);
	return NET_RX_SUCCESS;

drop:
	kfree_skb(skb);
	return NET_RX_DROP;
}

static int canfd_rcv(struct sk_buff *skb, struct net_device *dev,
		   struct packet_type *pt, struct net_device *orig_dev)
{
	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;

	if (unlikely(!net_eq(dev_net(dev), &init_net)))
		goto drop;

	if (WARN_ONCE(dev->type != ARPHRD_CAN ||
		      skb->len != CANFD_MTU ||
		      cfd->len > CANFD_MAX_DLEN,
		      "PF_CAN: dropped non conform CAN FD skbuf: "
		      "dev type %d, len %d, datalen %d\n",
		      dev->type, skb->len, cfd->len))
		goto drop;

	can_receive(skb, dev);
758
	return NET_RX_SUCCESS;
759 760 761

drop:
	kfree_skb(skb);
762
	return NET_RX_DROP;
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
}

/*
 * af_can protocol functions
 */

/**
 * can_proto_register - register CAN transport protocol
 * @cp: pointer to CAN protocol structure
 *
 * Return:
 *  0 on success
 *  -EINVAL invalid (out of range) protocol number
 *  -EBUSY  protocol already in use
 *  -ENOBUF if proto_register() fails
 */
779
int can_proto_register(const struct can_proto *cp)
780 781 782 783 784
{
	int proto = cp->protocol;
	int err = 0;

	if (proto < 0 || proto >= CAN_NPROTO) {
785
		pr_err("can: protocol number %d out of range\n", proto);
786 787 788
		return -EINVAL;
	}

789 790 791 792
	err = proto_register(cp->prot, 0);
	if (err < 0)
		return err;

793 794
	mutex_lock(&proto_tab_lock);

795
	if (proto_tab[proto]) {
796
		pr_err("can: protocol %d already registered\n", proto);
797
		err = -EBUSY;
Oliver Hartkopp's avatar
Oliver Hartkopp committed
798
	} else
799
		RCU_INIT_POINTER(proto_tab[proto], cp);
800

801
	mutex_unlock(&proto_tab_lock);
802 803

	if (err < 0)
804
		proto_unregister(cp->prot);
805 806 807 808 809 810 811 812 813

	return err;
}
EXPORT_SYMBOL(can_proto_register);

/**
 * can_proto_unregister - unregister CAN transport protocol
 * @cp: pointer to CAN protocol structure
 */
814
void can_proto_unregister(const struct can_proto *cp)
815 816 817
{
	int proto = cp->protocol;

818 819
	mutex_lock(&proto_tab_lock);
	BUG_ON(proto_tab[proto] != cp);
820
	RCU_INIT_POINTER(proto_tab[proto], NULL);
821 822 823
	mutex_unlock(&proto_tab_lock);

	synchronize_rcu();
824 825

	proto_unregister(cp->prot);
826 827 828 829 830 831 832
}
EXPORT_SYMBOL(can_proto_unregister);

/*
 * af_can notifier to create/remove CAN netdevice specific structs
 */
static int can_notifier(struct notifier_block *nb, unsigned long msg,
833
			void *ptr)
834
{
835
	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
836 837
	struct dev_rcv_lists *d;

838
	if (!net_eq(dev_net(dev), &init_net))
839 840 841 842 843 844 845 846 847
		return NOTIFY_DONE;

	if (dev->type != ARPHRD_CAN)
		return NOTIFY_DONE;

	switch (msg) {

	case NETDEV_REGISTER:

848
		/* create new dev_rcv_lists for this device */
849
		d = kzalloc(sizeof(*d), GFP_KERNEL);
850
		if (!d)
851
			return NOTIFY_DONE;
852 853
		BUG_ON(dev->ml_priv);
		dev->ml_priv = d;
854 855 856 857 858 859

		break;

	case NETDEV_UNREGISTER:
		spin_lock(&can_rcvlists_lock);

860
		d = dev->ml_priv;
861
		if (d) {
862
			if (d->entries)
863
				d->remove_on_zero_entries = 1;
864 865 866 867
			else {
				kfree(d);
				dev->ml_priv = NULL;
			}
868
		} else
869 870
			pr_err("can: notifier: receive list not found for dev "
			       "%s\n", dev->name);
871 872 873 874 875 876 877 878 879 880 881 882 883 884

		spin_unlock(&can_rcvlists_lock);

		break;
	}

	return NOTIFY_DONE;
}

/*
 * af_can module init/exit functions
 */

static struct packet_type can_packet __read_mostly = {
885
	.type = cpu_to_be16(ETH_P_CAN),
886 887 888
	.func = can_rcv,
};

889 890 891 892 893
static struct packet_type canfd_packet __read_mostly = {
	.type = cpu_to_be16(ETH_P_CANFD),
	.func = canfd_rcv,
};

894
static const struct net_proto_family can_family_ops = {
895 896 897 898 899 900 901 902 903 904 905 906
	.family = PF_CAN,
	.create = can_create,
	.owner  = THIS_MODULE,
};

/* notifier block for netdevice event */
static struct notifier_block can_netdev_notifier __read_mostly = {
	.notifier_call = can_notifier,
};

static __init int can_init(void)
{
907 908 909 910 911 912
	/* check for correct padding to be able to use the structs similarly */
	BUILD_BUG_ON(offsetof(struct can_frame, can_dlc) !=
		     offsetof(struct canfd_frame, len) ||
		     offsetof(struct can_frame, data) !=
		     offsetof(struct canfd_frame, data));

913
	pr_info("can: controller area network core (" CAN_VERSION_STRING ")\n");
914

915 916
	memset(&can_rx_alldev_list, 0, sizeof(can_rx_alldev_list));

917 918 919 920 921
	rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
				      0, 0, NULL);
	if (!rcv_cache)
		return -ENOMEM;

922 923
	if (IS_ENABLED(CONFIG_PROC_FS)) {
		if (stats_timer) {
924
		/* the statistics are updated every second (timer triggered) */
925 926 927 928 929
			setup_timer(&can_stattimer, can_stat_update, 0);
			mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
		}
		can_init_proc();
	}
930 931 932 933 934

	/* protocol register */
	sock_register(&can_family_ops);
	register_netdevice_notifier(&can_netdev_notifier);
	dev_add_pack(&can_packet);
935
	dev_add_pack(&canfd_packet);
936 937 938 939 940 941

	return 0;
}

static __exit void can_exit(void)
{
942
	struct net_device *dev;
943

944 945 946
	if (IS_ENABLED(CONFIG_PROC_FS)) {
		if (stats_timer)
			del_timer_sync(&can_stattimer);
947

948 949
		can_remove_proc();
	}
950 951

	/* protocol unregister */
952
	dev_remove_pack(&canfd_packet);
953 954 955 956
	dev_remove_pack(&can_packet);
	unregister_netdevice_notifier(&can_netdev_notifier);
	sock_unregister(PF_CAN);

957 958 959
	/* remove created dev_rcv_lists from still registered CAN devices */
	rcu_read_lock();
	for_each_netdev_rcu(&init_net, dev) {
960
		if (dev->type == ARPHRD_CAN && dev->ml_priv) {
961 962 963 964 965 966 967

			struct dev_rcv_lists *d = dev->ml_priv;

			BUG_ON(d->entries);
			kfree(d);
			dev->ml_priv = NULL;
		}
968
	}
969
	rcu_read_unlock();
970

971 972
	rcu_barrier(); /* Wait for completion of call_rcu()'s */

973 974 975 976 977
	kmem_cache_destroy(rcv_cache);
}

module_init(can_init);
module_exit(can_exit);