af_can.c 24.3 KB
Newer Older
1
// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2
/* af_can.c - Protocol family CAN core module
O
Oliver Hartkopp 已提交
3 4
 *            (used by different CAN protocol modules)
 *
5
 * Copyright (c) 2002-2017 Volkswagen Group Electronic Research
O
Oliver Hartkopp 已提交
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
 * 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>
O
Oliver Hartkopp 已提交
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/can/can-ml.h>
62
#include <linux/ratelimit.h>
O
Oliver Hartkopp 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75
#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;
76
module_param(stats_timer, int, 0444);
O
Oliver Hartkopp 已提交
77 78 79 80 81
MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");

static struct kmem_cache *rcv_cache __read_mostly;

/* table of registered CAN protocols */
82
static const struct can_proto __rcu *proto_tab[CAN_NPROTO] __read_mostly;
83
static DEFINE_MUTEX(proto_tab_lock);
O
Oliver Hartkopp 已提交
84

85 86
static atomic_t skbcounter = ATOMIC_INIT(0);

87
/* af_can socket functions */
O
Oliver Hartkopp 已提交
88

89
void can_sock_destruct(struct sock *sk)
O
Oliver Hartkopp 已提交
90 91
{
	skb_queue_purge(&sk->sk_receive_queue);
92
	skb_queue_purge(&sk->sk_error_queue);
O
Oliver Hartkopp 已提交
93
}
94
EXPORT_SYMBOL(can_sock_destruct);
O
Oliver Hartkopp 已提交
95

96
static const struct can_proto *can_get_proto(int protocol)
97
{
98
	const struct can_proto *cp;
99 100 101 102 103 104 105 106 107 108

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

	return cp;
}

109 110 111 112 113
static inline void can_put_proto(const struct can_proto *cp)
{
	module_put(cp->prot->owner);
}

114 115
static int can_create(struct net *net, struct socket *sock, int protocol,
		      int kern)
O
Oliver Hartkopp 已提交
116 117
{
	struct sock *sk;
118
	const struct can_proto *cp;
O
Oliver Hartkopp 已提交
119 120 121 122 123 124 125
	int err = 0;

	sock->state = SS_UNCONNECTED;

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

126
	cp = can_get_proto(protocol);
127

128
#ifdef CONFIG_MODULES
129 130 131
	if (!cp) {
		/* try to load protocol module if kernel is modular */

132
		err = request_module("can-proto-%d", protocol);
O
Oliver Hartkopp 已提交
133

134
		/* In case of error we only print a message but don't
O
Oliver Hartkopp 已提交
135 136 137
		 * return the error code immediately.  Below we will
		 * return -EPROTONOSUPPORT
		 */
138
		if (err)
139 140
			pr_err_ratelimited("can: request_module (can-proto-%d) failed.\n",
					   protocol);
141

142
		cp = can_get_proto(protocol);
O
Oliver Hartkopp 已提交
143
	}
144
#endif
O
Oliver Hartkopp 已提交
145 146 147 148 149 150 151

	/* check for available protocol and correct usage */

	if (!cp)
		return -EPROTONOSUPPORT;

	if (cp->type != sock->type) {
152
		err = -EPROTOTYPE;
O
Oliver Hartkopp 已提交
153 154 155 156 157
		goto errout;
	}

	sock->ops = cp->ops;

158
	sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot, kern);
O
Oliver Hartkopp 已提交
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
	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:
177
	can_put_proto(cp);
O
Oliver Hartkopp 已提交
178 179 180
	return err;
}

181
/* af_can tx path */
O
Oliver Hartkopp 已提交
182 183 184 185 186 187

/**
 * 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!)
 *
188 189
 * Due to the loopback this routine must not be called from hardirq context.
 *
O
Oliver Hartkopp 已提交
190 191 192 193 194 195
 * 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
196
 *  -EMSGSIZE CAN frame size is bigger than CAN interface MTU
O
Oliver Hartkopp 已提交
197
 *  -EINVAL when the skb->data does not contain a valid CAN frame
O
Oliver Hartkopp 已提交
198 199 200
 */
int can_send(struct sk_buff *skb, int loop)
{
201
	struct sk_buff *newskb = NULL;
202
	struct can_pkg_stats *pkg_stats = dev_net(skb->dev)->can.pkg_stats;
203 204
	int err = -EINVAL;

205 206 207
	if (can_is_canxl_skb(skb)) {
		skb->protocol = htons(ETH_P_CANXL);
	} else if (can_is_can_skb(skb)) {
208
		skb->protocol = htons(ETH_P_CAN);
209
	} else if (can_is_canfd_skb(skb)) {
210 211
		struct canfd_frame *cfd = (struct canfd_frame *)skb->data;

212
		skb->protocol = htons(ETH_P_CANFD);
213 214 215

		/* set CAN FD flag for CAN FD frames by default */
		cfd->flags |= CANFD_FDF;
216
	} else {
217
		goto inval_skb;
218
	}
O
Oliver Hartkopp 已提交
219

220 221
	/* Make sure the CAN frame can pass the selected CAN netdevice. */
	if (unlikely(skb->len > skb->dev->mtu)) {
222 223
		err = -EMSGSIZE;
		goto inval_skb;
O
Oliver Hartkopp 已提交
224 225
	}

226 227 228
	if (unlikely(skb->dev->type != ARPHRD_CAN)) {
		err = -EPERM;
		goto inval_skb;
O
Oliver Hartkopp 已提交
229 230
	}

231 232 233
	if (unlikely(!(skb->dev->flags & IFF_UP))) {
		err = -ENETDOWN;
		goto inval_skb;
O
Oliver Hartkopp 已提交
234 235
	}

236 237 238
	skb->ip_summed = CHECKSUM_UNNECESSARY;

	skb_reset_mac_header(skb);
O
Oliver Hartkopp 已提交
239 240 241 242 243 244 245 246 247
	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;

248
		/* The reference to the originating sock may be required
O
Oliver Hartkopp 已提交
249 250 251 252 253 254 255 256
		 * 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)) {
257
			/* If the interface is not capable to do loopback
O
Oliver Hartkopp 已提交
258 259
			 * itself, we do it here.
			 */
260
			newskb = skb_clone(skb, GFP_ATOMIC);
O
Oliver Hartkopp 已提交
261 262 263 264 265
			if (!newskb) {
				kfree_skb(skb);
				return -ENOMEM;
			}

266
			can_skb_set_owner(newskb, skb->sk);
O
Oliver Hartkopp 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279
			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);

280
	if (err) {
281
		kfree_skb(newskb);
282 283 284
		return err;
	}

285
	if (newskb)
S
Sebastian Andrzej Siewior 已提交
286
		netif_rx(newskb);
287

O
Oliver Hartkopp 已提交
288
	/* update statistics */
289 290
	pkg_stats->tx_frames++;
	pkg_stats->tx_frames_delta++;
O
Oliver Hartkopp 已提交
291

292
	return 0;
293 294 295 296

inval_skb:
	kfree_skb(skb);
	return err;
O
Oliver Hartkopp 已提交
297 298 299
}
EXPORT_SYMBOL(can_send);

300
/* af_can rx path */
O
Oliver Hartkopp 已提交
301

302 303
static struct can_dev_rcv_lists *can_dev_rcv_lists_find(struct net *net,
							struct net_device *dev)
O
Oliver Hartkopp 已提交
304
{
305
	if (dev) {
306 307
		struct can_ml_priv *can_ml = can_get_ml_priv(dev);
		return &can_ml->dev_rcv_lists;
308
	} else {
309
		return net->can.rx_alldev_list;
310
	}
O
Oliver Hartkopp 已提交
311 312
}

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
/**
 * 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);
}

336
/**
337
 * can_rcv_list_find - determine optimal filterlist inside device filter struct
338 339
 * @can_id: pointer to CAN identifier of a given can_filter
 * @mask: pointer to CAN mask of a given can_filter
340
 * @dev_rcv_lists: pointer to the device filter struct
341 342 343 344 345 346 347 348 349 350 351 352 353 354
 *
 * 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
355 356
 *  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.
357 358 359
 *
 * Return:
 *  Pointer to optimal filterlist for the given can_id/mask pair.
360
 *  Consistency checked mask.
361 362
 *  Reduced can_id to have a preprocessed filter compare value.
 */
363 364
static struct hlist_head *can_rcv_list_find(canid_t *can_id, canid_t *mask,
					    struct can_dev_rcv_lists *dev_rcv_lists)
O
Oliver Hartkopp 已提交
365 366 367
{
	canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */

368
	/* filter for error message frames in extra filterlist */
O
Oliver Hartkopp 已提交
369
	if (*mask & CAN_ERR_FLAG) {
370
		/* clear CAN_ERR_FLAG in filter entry */
O
Oliver Hartkopp 已提交
371
		*mask &= CAN_ERR_MASK;
372
		return &dev_rcv_lists->rx[RX_ERR];
O
Oliver Hartkopp 已提交
373 374
	}

375 376 377 378 379 380 381
	/* 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);
O
Oliver Hartkopp 已提交
382 383 384 385 386 387

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

	/* inverse can_id/can_mask filter */
	if (inv)
388
		return &dev_rcv_lists->rx[RX_INV];
O
Oliver Hartkopp 已提交
389 390 391

	/* mask == 0 => no condition testing at receive time */
	if (!(*mask))
392
		return &dev_rcv_lists->rx[RX_ALL];
O
Oliver Hartkopp 已提交
393

394
	/* extra filterlists for the subscription of a single non-RTR can_id */
395 396
	if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS) &&
	    !(*can_id & CAN_RTR_FLAG)) {
397
		if (*can_id & CAN_EFF_FLAG) {
398
			if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS))
399
				return &dev_rcv_lists->rx_eff[effhash(*can_id)];
400 401
		} else {
			if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
402
				return &dev_rcv_lists->rx_sff[*can_id];
O
Oliver Hartkopp 已提交
403 404 405 406
		}
	}

	/* default: filter via can_id/can_mask */
407
	return &dev_rcv_lists->rx[RX_FIL];
O
Oliver Hartkopp 已提交
408 409 410 411
}

/**
 * can_rx_register - subscribe CAN frames from a specific interface
A
Andrew Lunn 已提交
412
 * @net: the applicable net namespace
413
 * @dev: pointer to netdevice (NULL => subscribe from 'all' CAN devices list)
O
Oliver Hartkopp 已提交
414 415 416 417
 * @can_id: CAN identifier (see description)
 * @mask: CAN mask (see description)
 * @func: callback function on filter match
 * @data: returned parameter for callback function
418
 * @ident: string for calling module identification
419
 * @sk: socket pointer (might be NULL)
O
Oliver Hartkopp 已提交
420 421 422 423 424 425 426 427
 *
 * 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
428
 *  filter for error message frames (CAN_ERR_FLAG bit set in mask).
O
Oliver Hartkopp 已提交
429
 *
430 431 432 433 434 435
 *  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().
 *
O
Oliver Hartkopp 已提交
436 437 438 439 440
 * Return:
 *  0 on success
 *  -ENOMEM on missing cache mem to create subscription entry
 *  -ENODEV unknown device
 */
441 442 443
int can_rx_register(struct net *net, struct net_device *dev, canid_t can_id,
		    canid_t mask, void (*func)(struct sk_buff *, void *),
		    void *data, char *ident, struct sock *sk)
O
Oliver Hartkopp 已提交
444
{
445 446
	struct receiver *rcv;
	struct hlist_head *rcv_list;
447
	struct can_dev_rcv_lists *dev_rcv_lists;
448
	struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
O
Oliver Hartkopp 已提交
449 450 451 452
	int err = 0;

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

453 454 455
	if (dev && dev->type != ARPHRD_CAN)
		return -ENODEV;

456 457 458
	if (dev && !net_eq(net, dev_net(dev)))
		return -ENODEV;

459 460
	rcv = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
	if (!rcv)
O
Oliver Hartkopp 已提交
461 462
		return -ENOMEM;

463
	spin_lock_bh(&net->can.rcvlists_lock);
O
Oliver Hartkopp 已提交
464

465
	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
466 467 468 469 470 471 472 473 474
	rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);

	rcv->can_id = can_id;
	rcv->mask = mask;
	rcv->matches = 0;
	rcv->func = func;
	rcv->data = data;
	rcv->ident = ident;
	rcv->sk = sk;
O
Oliver Hartkopp 已提交
475

476 477 478 479 480 481
	hlist_add_head_rcu(&rcv->list, rcv_list);
	dev_rcv_lists->entries++;

	rcv_lists_stats->rcv_entries++;
	rcv_lists_stats->rcv_entries_max = max(rcv_lists_stats->rcv_entries_max,
					       rcv_lists_stats->rcv_entries);
482
	spin_unlock_bh(&net->can.rcvlists_lock);
O
Oliver Hartkopp 已提交
483 484 485 486 487

	return err;
}
EXPORT_SYMBOL(can_rx_register);

488
/* can_rx_delete_receiver - rcu callback for single receiver entry removal */
O
Oliver Hartkopp 已提交
489 490
static void can_rx_delete_receiver(struct rcu_head *rp)
{
491 492
	struct receiver *rcv = container_of(rp, struct receiver, rcu);
	struct sock *sk = rcv->sk;
O
Oliver Hartkopp 已提交
493

494
	kmem_cache_free(rcv_cache, rcv);
495 496
	if (sk)
		sock_put(sk);
O
Oliver Hartkopp 已提交
497 498 499 500
}

/**
 * can_rx_unregister - unsubscribe CAN frames from a specific interface
A
Andrew Lunn 已提交
501
 * @net: the applicable net namespace
J
Jeremiah Mahler 已提交
502
 * @dev: pointer to netdevice (NULL => unsubscribe from 'all' CAN devices list)
O
Oliver Hartkopp 已提交
503 504 505 506 507 508 509 510
 * @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.
 */
511 512 513
void can_rx_unregister(struct net *net, struct net_device *dev, canid_t can_id,
		       canid_t mask, void (*func)(struct sk_buff *, void *),
		       void *data)
O
Oliver Hartkopp 已提交
514
{
515 516
	struct receiver *rcv = NULL;
	struct hlist_head *rcv_list;
517
	struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
518
	struct can_dev_rcv_lists *dev_rcv_lists;
O
Oliver Hartkopp 已提交
519

520 521 522
	if (dev && dev->type != ARPHRD_CAN)
		return;

523 524
	if (dev && !net_eq(net, dev_net(dev)))
		return;
O
Oliver Hartkopp 已提交
525

526
	spin_lock_bh(&net->can.rcvlists_lock);
527

528
	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
529
	rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
O
Oliver Hartkopp 已提交
530

531
	/* Search the receiver list for the item to delete.  This should
O
Oliver Hartkopp 已提交
532 533 534
	 * exist, since no receiver may be unregistered that hasn't
	 * been registered before.
	 */
535 536 537
	hlist_for_each_entry_rcu(rcv, rcv_list, list) {
		if (rcv->can_id == can_id && rcv->mask == mask &&
		    rcv->func == func && rcv->data == data)
O
Oliver Hartkopp 已提交
538 539 540
			break;
	}

541
	/* Check for bugs in CAN protocol implementations using af_can.c:
542
	 * 'rcv' will be NULL if no matching list item was found for removal.
543 544 545
	 * As this case may potentially happen when closing a socket while
	 * the notifier for removing the CAN netdev is running we just print
	 * a warning here.
O
Oliver Hartkopp 已提交
546
	 */
547
	if (!rcv) {
548 549
		pr_warn("can: receive list entry not found for dev %s, id %03X, mask %03X\n",
			DNAME(dev), can_id, mask);
O
Oliver Hartkopp 已提交
550 551 552
		goto out;
	}

553
	hlist_del_rcu(&rcv->list);
554
	dev_rcv_lists->entries--;
O
Oliver Hartkopp 已提交
555

556 557
	if (rcv_lists_stats->rcv_entries > 0)
		rcv_lists_stats->rcv_entries--;
O
Oliver Hartkopp 已提交
558 559

 out:
560
	spin_unlock_bh(&net->can.rcvlists_lock);
O
Oliver Hartkopp 已提交
561 562

	/* schedule the receiver item for deletion */
563 564 565 566
	if (rcv) {
		if (rcv->sk)
			sock_hold(rcv->sk);
		call_rcu(&rcv->rcu, can_rx_delete_receiver);
567
	}
O
Oliver Hartkopp 已提交
568 569 570
}
EXPORT_SYMBOL(can_rx_unregister);

571
static inline void deliver(struct sk_buff *skb, struct receiver *rcv)
O
Oliver Hartkopp 已提交
572
{
573 574
	rcv->func(skb, rcv->data);
	rcv->matches++;
O
Oliver Hartkopp 已提交
575 576
}

577
static int can_rcv_filter(struct can_dev_rcv_lists *dev_rcv_lists, struct sk_buff *skb)
O
Oliver Hartkopp 已提交
578
{
579
	struct receiver *rcv;
O
Oliver Hartkopp 已提交
580 581 582 583
	int matches = 0;
	struct can_frame *cf = (struct can_frame *)skb->data;
	canid_t can_id = cf->can_id;

584
	if (dev_rcv_lists->entries == 0)
O
Oliver Hartkopp 已提交
585 586 587
		return 0;

	if (can_id & CAN_ERR_FLAG) {
588
		/* check for error message frame entries only */
589 590 591
		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ERR], list) {
			if (can_id & rcv->mask) {
				deliver(skb, rcv);
O
Oliver Hartkopp 已提交
592 593 594 595 596 597 598
				matches++;
			}
		}
		return matches;
	}

	/* check for unfiltered entries */
599 600
	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ALL], list) {
		deliver(skb, rcv);
O
Oliver Hartkopp 已提交
601 602 603 604
		matches++;
	}

	/* check for can_id/mask entries */
605 606 607
	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_FIL], list) {
		if ((can_id & rcv->mask) == rcv->can_id) {
			deliver(skb, rcv);
O
Oliver Hartkopp 已提交
608 609 610 611 612
			matches++;
		}
	}

	/* check for inverted can_id/mask entries */
613 614 615
	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_INV], list) {
		if ((can_id & rcv->mask) != rcv->can_id) {
			deliver(skb, rcv);
O
Oliver Hartkopp 已提交
616 617 618 619
			matches++;
		}
	}

620 621 622 623
	/* check filterlists for single non-RTR can_ids */
	if (can_id & CAN_RTR_FLAG)
		return matches;

O
Oliver Hartkopp 已提交
624
	if (can_id & CAN_EFF_FLAG) {
625 626 627
		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_eff[effhash(can_id)], list) {
			if (rcv->can_id == can_id) {
				deliver(skb, rcv);
O
Oliver Hartkopp 已提交
628 629 630 631 632
				matches++;
			}
		}
	} else {
		can_id &= CAN_SFF_MASK;
633 634
		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_sff[can_id], list) {
			deliver(skb, rcv);
O
Oliver Hartkopp 已提交
635 636 637 638 639 640 641
			matches++;
		}
	}

	return matches;
}

642
static void can_receive(struct sk_buff *skb, struct net_device *dev)
O
Oliver Hartkopp 已提交
643
{
644
	struct can_dev_rcv_lists *dev_rcv_lists;
645
	struct net *net = dev_net(dev);
646
	struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
O
Oliver Hartkopp 已提交
647 648 649
	int matches;

	/* update statistics */
650 651
	pkg_stats->rx_frames++;
	pkg_stats->rx_frames_delta++;
O
Oliver Hartkopp 已提交
652

653 654 655 656
	/* create non-zero unique skb identifier together with *skb */
	while (!(can_skb_prv(skb)->skbcnt))
		can_skb_prv(skb)->skbcnt = atomic_inc_return(&skbcounter);

O
Oliver Hartkopp 已提交
657 658 659
	rcu_read_lock();

	/* deliver the packet to sockets listening on all devices */
660
	matches = can_rcv_filter(net->can.rx_alldev_list, skb);
O
Oliver Hartkopp 已提交
661 662

	/* find receive list for this device */
663
	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
664
	matches += can_rcv_filter(dev_rcv_lists, skb);
O
Oliver Hartkopp 已提交
665 666 667

	rcu_read_unlock();

668 669
	/* consume the skbuff allocated by the netdevice driver */
	consume_skb(skb);
O
Oliver Hartkopp 已提交
670 671

	if (matches > 0) {
672 673
		pkg_stats->matches++;
		pkg_stats->matches_delta++;
O
Oliver Hartkopp 已提交
674
	}
675 676 677 678 679
}

static int can_rcv(struct sk_buff *skb, struct net_device *dev,
		   struct packet_type *pt, struct net_device *orig_dev)
{
680
	if (unlikely(dev->type != ARPHRD_CAN || (!can_is_can_skb(skb)))) {
681 682 683
		pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d\n",
			     dev->type, skb->len);

684 685
		kfree_skb(skb);
		return NET_RX_DROP;
686
	}
687 688 689 690 691 692

	can_receive(skb, dev);
	return NET_RX_SUCCESS;
}

static int canfd_rcv(struct sk_buff *skb, struct net_device *dev,
M
Marc Kleine-Budde 已提交
693
		     struct packet_type *pt, struct net_device *orig_dev)
694
{
695
	if (unlikely(dev->type != ARPHRD_CAN || (!can_is_canfd_skb(skb)))) {
696 697 698
		pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d\n",
			     dev->type, skb->len);

699 700
		kfree_skb(skb);
		return NET_RX_DROP;
701
	}
702 703

	can_receive(skb, dev);
704
	return NET_RX_SUCCESS;
O
Oliver Hartkopp 已提交
705 706
}

707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
static int canxl_rcv(struct sk_buff *skb, struct net_device *dev,
		     struct packet_type *pt, struct net_device *orig_dev)
{
	if (unlikely(dev->type != ARPHRD_CAN || (!can_is_canxl_skb(skb)))) {
		pr_warn_once("PF_CAN: dropped non conform CAN XL skbuff: dev type %d, len %d\n",
			     dev->type, skb->len);

		kfree_skb(skb);
		return NET_RX_DROP;
	}

	can_receive(skb, dev);
	return NET_RX_SUCCESS;
}

722
/* af_can protocol functions */
O
Oliver Hartkopp 已提交
723 724 725 726 727 728 729 730 731 732 733

/**
 * 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
 */
734
int can_proto_register(const struct can_proto *cp)
O
Oliver Hartkopp 已提交
735 736 737 738 739
{
	int proto = cp->protocol;
	int err = 0;

	if (proto < 0 || proto >= CAN_NPROTO) {
740
		pr_err("can: protocol number %d out of range\n", proto);
O
Oliver Hartkopp 已提交
741 742 743
		return -EINVAL;
	}

744 745 746 747
	err = proto_register(cp->prot, 0);
	if (err < 0)
		return err;

748 749
	mutex_lock(&proto_tab_lock);

750
	if (rcu_access_pointer(proto_tab[proto])) {
751
		pr_err("can: protocol %d already registered\n", proto);
O
Oliver Hartkopp 已提交
752
		err = -EBUSY;
753
	} else {
754
		RCU_INIT_POINTER(proto_tab[proto], cp);
755
	}
756

757
	mutex_unlock(&proto_tab_lock);
O
Oliver Hartkopp 已提交
758 759

	if (err < 0)
760
		proto_unregister(cp->prot);
O
Oliver Hartkopp 已提交
761 762 763 764 765 766 767 768 769

	return err;
}
EXPORT_SYMBOL(can_proto_register);

/**
 * can_proto_unregister - unregister CAN transport protocol
 * @cp: pointer to CAN protocol structure
 */
770
void can_proto_unregister(const struct can_proto *cp)
O
Oliver Hartkopp 已提交
771 772 773
{
	int proto = cp->protocol;

774
	mutex_lock(&proto_tab_lock);
775
	BUG_ON(rcu_access_pointer(proto_tab[proto]) != cp);
776
	RCU_INIT_POINTER(proto_tab[proto], NULL);
777 778 779
	mutex_unlock(&proto_tab_lock);

	synchronize_rcu();
780 781

	proto_unregister(cp->prot);
O
Oliver Hartkopp 已提交
782 783 784
}
EXPORT_SYMBOL(can_proto_unregister);

785 786
static int can_pernet_init(struct net *net)
{
787 788 789 790
	spin_lock_init(&net->can.rcvlists_lock);
	net->can.rx_alldev_list =
		kzalloc(sizeof(*net->can.rx_alldev_list), GFP_KERNEL);
	if (!net->can.rx_alldev_list)
791
		goto out;
792 793 794 795 796 797
	net->can.pkg_stats = kzalloc(sizeof(*net->can.pkg_stats), GFP_KERNEL);
	if (!net->can.pkg_stats)
		goto out_free_rx_alldev_list;
	net->can.rcv_lists_stats = kzalloc(sizeof(*net->can.rcv_lists_stats), GFP_KERNEL);
	if (!net->can.rcv_lists_stats)
		goto out_free_pkg_stats;
798 799 800 801

	if (IS_ENABLED(CONFIG_PROC_FS)) {
		/* the statistics are updated every second (timer triggered) */
		if (stats_timer) {
802
			timer_setup(&net->can.stattimer, can_stat_update,
803
				    0);
804
			mod_timer(&net->can.stattimer,
805 806
				  round_jiffies(jiffies + HZ));
		}
807
		net->can.pkg_stats->jiffies_init = jiffies;
808
		can_init_proc(net);
809
	}
810 811

	return 0;
812

813 814 815
 out_free_pkg_stats:
	kfree(net->can.pkg_stats);
 out_free_rx_alldev_list:
816
	kfree(net->can.rx_alldev_list);
817 818
 out:
	return -ENOMEM;
819 820 821 822
}

static void can_pernet_exit(struct net *net)
{
823
	if (IS_ENABLED(CONFIG_PROC_FS)) {
824
		can_remove_proc(net);
825
		if (stats_timer)
826
			del_timer_sync(&net->can.stattimer);
827
	}
828

829
	kfree(net->can.rx_alldev_list);
830 831
	kfree(net->can.pkg_stats);
	kfree(net->can.rcv_lists_stats);
832 833
}

834
/* af_can module init/exit functions */
O
Oliver Hartkopp 已提交
835 836

static struct packet_type can_packet __read_mostly = {
837
	.type = cpu_to_be16(ETH_P_CAN),
O
Oliver Hartkopp 已提交
838 839 840
	.func = can_rcv,
};

841 842 843 844 845
static struct packet_type canfd_packet __read_mostly = {
	.type = cpu_to_be16(ETH_P_CANFD),
	.func = canfd_rcv,
};

846 847 848 849 850
static struct packet_type canxl_packet __read_mostly = {
	.type = cpu_to_be16(ETH_P_CANXL),
	.func = canxl_rcv,
};

851
static const struct net_proto_family can_family_ops = {
O
Oliver Hartkopp 已提交
852 853 854 855 856
	.family = PF_CAN,
	.create = can_create,
	.owner  = THIS_MODULE,
};

857 858 859 860 861
static struct pernet_operations can_pernet_ops __read_mostly = {
	.init = can_pernet_init,
	.exit = can_pernet_exit,
};

O
Oliver Hartkopp 已提交
862 863
static __init int can_init(void)
{
864 865
	int err;

866
	/* check for correct padding to be able to use the structs similarly */
867
	BUILD_BUG_ON(offsetof(struct can_frame, len) !=
868 869 870 871
		     offsetof(struct canfd_frame, len) ||
		     offsetof(struct can_frame, data) !=
		     offsetof(struct canfd_frame, data));

872
	pr_info("can: controller area network core\n");
O
Oliver Hartkopp 已提交
873 874 875 876 877 878

	rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
				      0, 0, NULL);
	if (!rcv_cache)
		return -ENOMEM;

879 880 881
	err = register_pernet_subsys(&can_pernet_ops);
	if (err)
		goto out_pernet;
882

O
Oliver Hartkopp 已提交
883
	/* protocol register */
884 885 886 887
	err = sock_register(&can_family_ops);
	if (err)
		goto out_sock;

O
Oliver Hartkopp 已提交
888
	dev_add_pack(&can_packet);
889
	dev_add_pack(&canfd_packet);
890
	dev_add_pack(&canxl_packet);
O
Oliver Hartkopp 已提交
891 892

	return 0;
893 894 895 896 897 898 899

out_sock:
	unregister_pernet_subsys(&can_pernet_ops);
out_pernet:
	kmem_cache_destroy(rcv_cache);

	return err;
O
Oliver Hartkopp 已提交
900 901 902 903 904
}

static __exit void can_exit(void)
{
	/* protocol unregister */
905
	dev_remove_pack(&canfd_packet);
O
Oliver Hartkopp 已提交
906 907 908
	dev_remove_pack(&can_packet);
	sock_unregister(PF_CAN);

909
	unregister_pernet_subsys(&can_pernet_ops);
O
Oliver Hartkopp 已提交
910

911 912
	rcu_barrier(); /* Wait for completion of call_rcu()'s */

O
Oliver Hartkopp 已提交
913 914 915 916 917
	kmem_cache_destroy(rcv_cache);
}

module_init(can_init);
module_exit(can_exit);