xref: /OK3568_Linux_fs/kernel/net/can/af_can.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2*4882a593Smuzhiyun /* af_can.c - Protocol family CAN core module
3*4882a593Smuzhiyun  *            (used by different CAN protocol modules)
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (c) 2002-2017 Volkswagen Group Electronic Research
6*4882a593Smuzhiyun  * All rights reserved.
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * Redistribution and use in source and binary forms, with or without
9*4882a593Smuzhiyun  * modification, are permitted provided that the following conditions
10*4882a593Smuzhiyun  * are met:
11*4882a593Smuzhiyun  * 1. Redistributions of source code must retain the above copyright
12*4882a593Smuzhiyun  *    notice, this list of conditions and the following disclaimer.
13*4882a593Smuzhiyun  * 2. Redistributions in binary form must reproduce the above copyright
14*4882a593Smuzhiyun  *    notice, this list of conditions and the following disclaimer in the
15*4882a593Smuzhiyun  *    documentation and/or other materials provided with the distribution.
16*4882a593Smuzhiyun  * 3. Neither the name of Volkswagen nor the names of its contributors
17*4882a593Smuzhiyun  *    may be used to endorse or promote products derived from this software
18*4882a593Smuzhiyun  *    without specific prior written permission.
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * Alternatively, provided that this notice is retained in full, this
21*4882a593Smuzhiyun  * software may be distributed under the terms of the GNU General
22*4882a593Smuzhiyun  * Public License ("GPL") version 2, in which case the provisions of the
23*4882a593Smuzhiyun  * GPL apply INSTEAD OF those given above.
24*4882a593Smuzhiyun  *
25*4882a593Smuzhiyun  * The provided data structures and external interfaces from this code
26*4882a593Smuzhiyun  * are not restricted to be used by modules with a GPL compatible license.
27*4882a593Smuzhiyun  *
28*4882a593Smuzhiyun  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29*4882a593Smuzhiyun  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30*4882a593Smuzhiyun  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31*4882a593Smuzhiyun  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32*4882a593Smuzhiyun  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33*4882a593Smuzhiyun  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34*4882a593Smuzhiyun  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35*4882a593Smuzhiyun  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36*4882a593Smuzhiyun  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37*4882a593Smuzhiyun  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38*4882a593Smuzhiyun  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
39*4882a593Smuzhiyun  * DAMAGE.
40*4882a593Smuzhiyun  *
41*4882a593Smuzhiyun  */
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun #include <linux/module.h>
44*4882a593Smuzhiyun #include <linux/stddef.h>
45*4882a593Smuzhiyun #include <linux/init.h>
46*4882a593Smuzhiyun #include <linux/kmod.h>
47*4882a593Smuzhiyun #include <linux/slab.h>
48*4882a593Smuzhiyun #include <linux/list.h>
49*4882a593Smuzhiyun #include <linux/spinlock.h>
50*4882a593Smuzhiyun #include <linux/rcupdate.h>
51*4882a593Smuzhiyun #include <linux/uaccess.h>
52*4882a593Smuzhiyun #include <linux/net.h>
53*4882a593Smuzhiyun #include <linux/netdevice.h>
54*4882a593Smuzhiyun #include <linux/socket.h>
55*4882a593Smuzhiyun #include <linux/if_ether.h>
56*4882a593Smuzhiyun #include <linux/if_arp.h>
57*4882a593Smuzhiyun #include <linux/skbuff.h>
58*4882a593Smuzhiyun #include <linux/can.h>
59*4882a593Smuzhiyun #include <linux/can/core.h>
60*4882a593Smuzhiyun #include <linux/can/skb.h>
61*4882a593Smuzhiyun #include <linux/can/can-ml.h>
62*4882a593Smuzhiyun #include <linux/ratelimit.h>
63*4882a593Smuzhiyun #include <net/net_namespace.h>
64*4882a593Smuzhiyun #include <net/sock.h>
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun #include "af_can.h"
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
69*4882a593Smuzhiyun MODULE_LICENSE("Dual BSD/GPL");
70*4882a593Smuzhiyun MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
71*4882a593Smuzhiyun 	      "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun MODULE_ALIAS_NETPROTO(PF_CAN);
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun static int stats_timer __read_mostly = 1;
76*4882a593Smuzhiyun module_param(stats_timer, int, 0444);
77*4882a593Smuzhiyun MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun static struct kmem_cache *rcv_cache __read_mostly;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun /* table of registered CAN protocols */
82*4882a593Smuzhiyun static const struct can_proto __rcu *proto_tab[CAN_NPROTO] __read_mostly;
83*4882a593Smuzhiyun static DEFINE_MUTEX(proto_tab_lock);
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun static atomic_t skbcounter = ATOMIC_INIT(0);
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun /* af_can socket functions */
88*4882a593Smuzhiyun 
can_sock_destruct(struct sock * sk)89*4882a593Smuzhiyun void can_sock_destruct(struct sock *sk)
90*4882a593Smuzhiyun {
91*4882a593Smuzhiyun 	skb_queue_purge(&sk->sk_receive_queue);
92*4882a593Smuzhiyun 	skb_queue_purge(&sk->sk_error_queue);
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun EXPORT_SYMBOL(can_sock_destruct);
95*4882a593Smuzhiyun 
can_get_proto(int protocol)96*4882a593Smuzhiyun static const struct can_proto *can_get_proto(int protocol)
97*4882a593Smuzhiyun {
98*4882a593Smuzhiyun 	const struct can_proto *cp;
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	rcu_read_lock();
101*4882a593Smuzhiyun 	cp = rcu_dereference(proto_tab[protocol]);
102*4882a593Smuzhiyun 	if (cp && !try_module_get(cp->prot->owner))
103*4882a593Smuzhiyun 		cp = NULL;
104*4882a593Smuzhiyun 	rcu_read_unlock();
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	return cp;
107*4882a593Smuzhiyun }
108*4882a593Smuzhiyun 
can_put_proto(const struct can_proto * cp)109*4882a593Smuzhiyun static inline void can_put_proto(const struct can_proto *cp)
110*4882a593Smuzhiyun {
111*4882a593Smuzhiyun 	module_put(cp->prot->owner);
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun 
can_create(struct net * net,struct socket * sock,int protocol,int kern)114*4882a593Smuzhiyun static int can_create(struct net *net, struct socket *sock, int protocol,
115*4882a593Smuzhiyun 		      int kern)
116*4882a593Smuzhiyun {
117*4882a593Smuzhiyun 	struct sock *sk;
118*4882a593Smuzhiyun 	const struct can_proto *cp;
119*4882a593Smuzhiyun 	int err = 0;
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	sock->state = SS_UNCONNECTED;
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	if (protocol < 0 || protocol >= CAN_NPROTO)
124*4882a593Smuzhiyun 		return -EINVAL;
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	cp = can_get_proto(protocol);
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun #ifdef CONFIG_MODULES
129*4882a593Smuzhiyun 	if (!cp) {
130*4882a593Smuzhiyun 		/* try to load protocol module if kernel is modular */
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 		err = request_module("can-proto-%d", protocol);
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 		/* In case of error we only print a message but don't
135*4882a593Smuzhiyun 		 * return the error code immediately.  Below we will
136*4882a593Smuzhiyun 		 * return -EPROTONOSUPPORT
137*4882a593Smuzhiyun 		 */
138*4882a593Smuzhiyun 		if (err)
139*4882a593Smuzhiyun 			pr_err_ratelimited("can: request_module (can-proto-%d) failed.\n",
140*4882a593Smuzhiyun 					   protocol);
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 		cp = can_get_proto(protocol);
143*4882a593Smuzhiyun 	}
144*4882a593Smuzhiyun #endif
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	/* check for available protocol and correct usage */
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 	if (!cp)
149*4882a593Smuzhiyun 		return -EPROTONOSUPPORT;
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	if (cp->type != sock->type) {
152*4882a593Smuzhiyun 		err = -EPROTOTYPE;
153*4882a593Smuzhiyun 		goto errout;
154*4882a593Smuzhiyun 	}
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	sock->ops = cp->ops;
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 	sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot, kern);
159*4882a593Smuzhiyun 	if (!sk) {
160*4882a593Smuzhiyun 		err = -ENOMEM;
161*4882a593Smuzhiyun 		goto errout;
162*4882a593Smuzhiyun 	}
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	sock_init_data(sock, sk);
165*4882a593Smuzhiyun 	sk->sk_destruct = can_sock_destruct;
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 	if (sk->sk_prot->init)
168*4882a593Smuzhiyun 		err = sk->sk_prot->init(sk);
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	if (err) {
171*4882a593Smuzhiyun 		/* release sk on errors */
172*4882a593Smuzhiyun 		sock_orphan(sk);
173*4882a593Smuzhiyun 		sock_put(sk);
174*4882a593Smuzhiyun 	}
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun  errout:
177*4882a593Smuzhiyun 	can_put_proto(cp);
178*4882a593Smuzhiyun 	return err;
179*4882a593Smuzhiyun }
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun /* af_can tx path */
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun /**
184*4882a593Smuzhiyun  * can_send - transmit a CAN frame (optional with local loopback)
185*4882a593Smuzhiyun  * @skb: pointer to socket buffer with CAN frame in data section
186*4882a593Smuzhiyun  * @loop: loopback for listeners on local CAN sockets (recommended default!)
187*4882a593Smuzhiyun  *
188*4882a593Smuzhiyun  * Due to the loopback this routine must not be called from hardirq context.
189*4882a593Smuzhiyun  *
190*4882a593Smuzhiyun  * Return:
191*4882a593Smuzhiyun  *  0 on success
192*4882a593Smuzhiyun  *  -ENETDOWN when the selected interface is down
193*4882a593Smuzhiyun  *  -ENOBUFS on full driver queue (see net_xmit_errno())
194*4882a593Smuzhiyun  *  -ENOMEM when local loopback failed at calling skb_clone()
195*4882a593Smuzhiyun  *  -EPERM when trying to send on a non-CAN interface
196*4882a593Smuzhiyun  *  -EMSGSIZE CAN frame size is bigger than CAN interface MTU
197*4882a593Smuzhiyun  *  -EINVAL when the skb->data does not contain a valid CAN frame
198*4882a593Smuzhiyun  */
can_send(struct sk_buff * skb,int loop)199*4882a593Smuzhiyun int can_send(struct sk_buff *skb, int loop)
200*4882a593Smuzhiyun {
201*4882a593Smuzhiyun 	struct sk_buff *newskb = NULL;
202*4882a593Smuzhiyun 	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
203*4882a593Smuzhiyun 	struct can_pkg_stats *pkg_stats = dev_net(skb->dev)->can.pkg_stats;
204*4882a593Smuzhiyun 	int err = -EINVAL;
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	if (skb->len == CAN_MTU) {
207*4882a593Smuzhiyun 		skb->protocol = htons(ETH_P_CAN);
208*4882a593Smuzhiyun 		if (unlikely(cfd->len > CAN_MAX_DLEN))
209*4882a593Smuzhiyun 			goto inval_skb;
210*4882a593Smuzhiyun 	} else if (skb->len == CANFD_MTU) {
211*4882a593Smuzhiyun 		skb->protocol = htons(ETH_P_CANFD);
212*4882a593Smuzhiyun 		if (unlikely(cfd->len > CANFD_MAX_DLEN))
213*4882a593Smuzhiyun 			goto inval_skb;
214*4882a593Smuzhiyun 	} else {
215*4882a593Smuzhiyun 		goto inval_skb;
216*4882a593Smuzhiyun 	}
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun 	/* Make sure the CAN frame can pass the selected CAN netdevice.
219*4882a593Smuzhiyun 	 * As structs can_frame and canfd_frame are similar, we can provide
220*4882a593Smuzhiyun 	 * CAN FD frames to legacy CAN drivers as long as the length is <= 8
221*4882a593Smuzhiyun 	 */
222*4882a593Smuzhiyun 	if (unlikely(skb->len > skb->dev->mtu && cfd->len > CAN_MAX_DLEN)) {
223*4882a593Smuzhiyun 		err = -EMSGSIZE;
224*4882a593Smuzhiyun 		goto inval_skb;
225*4882a593Smuzhiyun 	}
226*4882a593Smuzhiyun 
227*4882a593Smuzhiyun 	if (unlikely(skb->dev->type != ARPHRD_CAN)) {
228*4882a593Smuzhiyun 		err = -EPERM;
229*4882a593Smuzhiyun 		goto inval_skb;
230*4882a593Smuzhiyun 	}
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 	if (unlikely(!(skb->dev->flags & IFF_UP))) {
233*4882a593Smuzhiyun 		err = -ENETDOWN;
234*4882a593Smuzhiyun 		goto inval_skb;
235*4882a593Smuzhiyun 	}
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun 	skb->ip_summed = CHECKSUM_UNNECESSARY;
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	skb_reset_mac_header(skb);
240*4882a593Smuzhiyun 	skb_reset_network_header(skb);
241*4882a593Smuzhiyun 	skb_reset_transport_header(skb);
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun 	if (loop) {
244*4882a593Smuzhiyun 		/* local loopback of sent CAN frames */
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun 		/* indication for the CAN driver: do loopback */
247*4882a593Smuzhiyun 		skb->pkt_type = PACKET_LOOPBACK;
248*4882a593Smuzhiyun 
249*4882a593Smuzhiyun 		/* The reference to the originating sock may be required
250*4882a593Smuzhiyun 		 * by the receiving socket to check whether the frame is
251*4882a593Smuzhiyun 		 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
252*4882a593Smuzhiyun 		 * Therefore we have to ensure that skb->sk remains the
253*4882a593Smuzhiyun 		 * reference to the originating sock by restoring skb->sk
254*4882a593Smuzhiyun 		 * after each skb_clone() or skb_orphan() usage.
255*4882a593Smuzhiyun 		 */
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun 		if (!(skb->dev->flags & IFF_ECHO)) {
258*4882a593Smuzhiyun 			/* If the interface is not capable to do loopback
259*4882a593Smuzhiyun 			 * itself, we do it here.
260*4882a593Smuzhiyun 			 */
261*4882a593Smuzhiyun 			newskb = skb_clone(skb, GFP_ATOMIC);
262*4882a593Smuzhiyun 			if (!newskb) {
263*4882a593Smuzhiyun 				kfree_skb(skb);
264*4882a593Smuzhiyun 				return -ENOMEM;
265*4882a593Smuzhiyun 			}
266*4882a593Smuzhiyun 
267*4882a593Smuzhiyun 			can_skb_set_owner(newskb, skb->sk);
268*4882a593Smuzhiyun 			newskb->ip_summed = CHECKSUM_UNNECESSARY;
269*4882a593Smuzhiyun 			newskb->pkt_type = PACKET_BROADCAST;
270*4882a593Smuzhiyun 		}
271*4882a593Smuzhiyun 	} else {
272*4882a593Smuzhiyun 		/* indication for the CAN driver: no loopback required */
273*4882a593Smuzhiyun 		skb->pkt_type = PACKET_HOST;
274*4882a593Smuzhiyun 	}
275*4882a593Smuzhiyun 
276*4882a593Smuzhiyun 	/* send to netdevice */
277*4882a593Smuzhiyun 	err = dev_queue_xmit(skb);
278*4882a593Smuzhiyun 	if (err > 0)
279*4882a593Smuzhiyun 		err = net_xmit_errno(err);
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun 	if (err) {
282*4882a593Smuzhiyun 		kfree_skb(newskb);
283*4882a593Smuzhiyun 		return err;
284*4882a593Smuzhiyun 	}
285*4882a593Smuzhiyun 
286*4882a593Smuzhiyun 	if (newskb)
287*4882a593Smuzhiyun 		netif_rx_ni(newskb);
288*4882a593Smuzhiyun 
289*4882a593Smuzhiyun 	/* update statistics */
290*4882a593Smuzhiyun 	pkg_stats->tx_frames++;
291*4882a593Smuzhiyun 	pkg_stats->tx_frames_delta++;
292*4882a593Smuzhiyun 
293*4882a593Smuzhiyun 	return 0;
294*4882a593Smuzhiyun 
295*4882a593Smuzhiyun inval_skb:
296*4882a593Smuzhiyun 	kfree_skb(skb);
297*4882a593Smuzhiyun 	return err;
298*4882a593Smuzhiyun }
299*4882a593Smuzhiyun EXPORT_SYMBOL(can_send);
300*4882a593Smuzhiyun 
301*4882a593Smuzhiyun /* af_can rx path */
302*4882a593Smuzhiyun 
can_dev_rcv_lists_find(struct net * net,struct net_device * dev)303*4882a593Smuzhiyun static struct can_dev_rcv_lists *can_dev_rcv_lists_find(struct net *net,
304*4882a593Smuzhiyun 							struct net_device *dev)
305*4882a593Smuzhiyun {
306*4882a593Smuzhiyun 	if (dev) {
307*4882a593Smuzhiyun 		struct can_ml_priv *can_ml = can_get_ml_priv(dev);
308*4882a593Smuzhiyun 		return &can_ml->dev_rcv_lists;
309*4882a593Smuzhiyun 	} else {
310*4882a593Smuzhiyun 		return net->can.rx_alldev_list;
311*4882a593Smuzhiyun 	}
312*4882a593Smuzhiyun }
313*4882a593Smuzhiyun 
314*4882a593Smuzhiyun /**
315*4882a593Smuzhiyun  * effhash - hash function for 29 bit CAN identifier reduction
316*4882a593Smuzhiyun  * @can_id: 29 bit CAN identifier
317*4882a593Smuzhiyun  *
318*4882a593Smuzhiyun  * Description:
319*4882a593Smuzhiyun  *  To reduce the linear traversal in one linked list of _single_ EFF CAN
320*4882a593Smuzhiyun  *  frame subscriptions the 29 bit identifier is mapped to 10 bits.
321*4882a593Smuzhiyun  *  (see CAN_EFF_RCV_HASH_BITS definition)
322*4882a593Smuzhiyun  *
323*4882a593Smuzhiyun  * Return:
324*4882a593Smuzhiyun  *  Hash value from 0x000 - 0x3FF ( enforced by CAN_EFF_RCV_HASH_BITS mask )
325*4882a593Smuzhiyun  */
effhash(canid_t can_id)326*4882a593Smuzhiyun static unsigned int effhash(canid_t can_id)
327*4882a593Smuzhiyun {
328*4882a593Smuzhiyun 	unsigned int hash;
329*4882a593Smuzhiyun 
330*4882a593Smuzhiyun 	hash = can_id;
331*4882a593Smuzhiyun 	hash ^= can_id >> CAN_EFF_RCV_HASH_BITS;
332*4882a593Smuzhiyun 	hash ^= can_id >> (2 * CAN_EFF_RCV_HASH_BITS);
333*4882a593Smuzhiyun 
334*4882a593Smuzhiyun 	return hash & ((1 << CAN_EFF_RCV_HASH_BITS) - 1);
335*4882a593Smuzhiyun }
336*4882a593Smuzhiyun 
337*4882a593Smuzhiyun /**
338*4882a593Smuzhiyun  * can_rcv_list_find - determine optimal filterlist inside device filter struct
339*4882a593Smuzhiyun  * @can_id: pointer to CAN identifier of a given can_filter
340*4882a593Smuzhiyun  * @mask: pointer to CAN mask of a given can_filter
341*4882a593Smuzhiyun  * @dev_rcv_lists: pointer to the device filter struct
342*4882a593Smuzhiyun  *
343*4882a593Smuzhiyun  * Description:
344*4882a593Smuzhiyun  *  Returns the optimal filterlist to reduce the filter handling in the
345*4882a593Smuzhiyun  *  receive path. This function is called by service functions that need
346*4882a593Smuzhiyun  *  to register or unregister a can_filter in the filter lists.
347*4882a593Smuzhiyun  *
348*4882a593Smuzhiyun  *  A filter matches in general, when
349*4882a593Smuzhiyun  *
350*4882a593Smuzhiyun  *          <received_can_id> & mask == can_id & mask
351*4882a593Smuzhiyun  *
352*4882a593Smuzhiyun  *  so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
353*4882a593Smuzhiyun  *  relevant bits for the filter.
354*4882a593Smuzhiyun  *
355*4882a593Smuzhiyun  *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
356*4882a593Smuzhiyun  *  filter for error messages (CAN_ERR_FLAG bit set in mask). For error msg
357*4882a593Smuzhiyun  *  frames there is a special filterlist and a special rx path filter handling.
358*4882a593Smuzhiyun  *
359*4882a593Smuzhiyun  * Return:
360*4882a593Smuzhiyun  *  Pointer to optimal filterlist for the given can_id/mask pair.
361*4882a593Smuzhiyun  *  Consistency checked mask.
362*4882a593Smuzhiyun  *  Reduced can_id to have a preprocessed filter compare value.
363*4882a593Smuzhiyun  */
can_rcv_list_find(canid_t * can_id,canid_t * mask,struct can_dev_rcv_lists * dev_rcv_lists)364*4882a593Smuzhiyun static struct hlist_head *can_rcv_list_find(canid_t *can_id, canid_t *mask,
365*4882a593Smuzhiyun 					    struct can_dev_rcv_lists *dev_rcv_lists)
366*4882a593Smuzhiyun {
367*4882a593Smuzhiyun 	canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
368*4882a593Smuzhiyun 
369*4882a593Smuzhiyun 	/* filter for error message frames in extra filterlist */
370*4882a593Smuzhiyun 	if (*mask & CAN_ERR_FLAG) {
371*4882a593Smuzhiyun 		/* clear CAN_ERR_FLAG in filter entry */
372*4882a593Smuzhiyun 		*mask &= CAN_ERR_MASK;
373*4882a593Smuzhiyun 		return &dev_rcv_lists->rx[RX_ERR];
374*4882a593Smuzhiyun 	}
375*4882a593Smuzhiyun 
376*4882a593Smuzhiyun 	/* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */
377*4882a593Smuzhiyun 
378*4882a593Smuzhiyun #define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)
379*4882a593Smuzhiyun 
380*4882a593Smuzhiyun 	/* ensure valid values in can_mask for 'SFF only' frame filtering */
381*4882a593Smuzhiyun 	if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
382*4882a593Smuzhiyun 		*mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
383*4882a593Smuzhiyun 
384*4882a593Smuzhiyun 	/* reduce condition testing at receive time */
385*4882a593Smuzhiyun 	*can_id &= *mask;
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun 	/* inverse can_id/can_mask filter */
388*4882a593Smuzhiyun 	if (inv)
389*4882a593Smuzhiyun 		return &dev_rcv_lists->rx[RX_INV];
390*4882a593Smuzhiyun 
391*4882a593Smuzhiyun 	/* mask == 0 => no condition testing at receive time */
392*4882a593Smuzhiyun 	if (!(*mask))
393*4882a593Smuzhiyun 		return &dev_rcv_lists->rx[RX_ALL];
394*4882a593Smuzhiyun 
395*4882a593Smuzhiyun 	/* extra filterlists for the subscription of a single non-RTR can_id */
396*4882a593Smuzhiyun 	if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS) &&
397*4882a593Smuzhiyun 	    !(*can_id & CAN_RTR_FLAG)) {
398*4882a593Smuzhiyun 		if (*can_id & CAN_EFF_FLAG) {
399*4882a593Smuzhiyun 			if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS))
400*4882a593Smuzhiyun 				return &dev_rcv_lists->rx_eff[effhash(*can_id)];
401*4882a593Smuzhiyun 		} else {
402*4882a593Smuzhiyun 			if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
403*4882a593Smuzhiyun 				return &dev_rcv_lists->rx_sff[*can_id];
404*4882a593Smuzhiyun 		}
405*4882a593Smuzhiyun 	}
406*4882a593Smuzhiyun 
407*4882a593Smuzhiyun 	/* default: filter via can_id/can_mask */
408*4882a593Smuzhiyun 	return &dev_rcv_lists->rx[RX_FIL];
409*4882a593Smuzhiyun }
410*4882a593Smuzhiyun 
411*4882a593Smuzhiyun /**
412*4882a593Smuzhiyun  * can_rx_register - subscribe CAN frames from a specific interface
413*4882a593Smuzhiyun  * @net: the applicable net namespace
414*4882a593Smuzhiyun  * @dev: pointer to netdevice (NULL => subscribe from 'all' CAN devices list)
415*4882a593Smuzhiyun  * @can_id: CAN identifier (see description)
416*4882a593Smuzhiyun  * @mask: CAN mask (see description)
417*4882a593Smuzhiyun  * @func: callback function on filter match
418*4882a593Smuzhiyun  * @data: returned parameter for callback function
419*4882a593Smuzhiyun  * @ident: string for calling module identification
420*4882a593Smuzhiyun  * @sk: socket pointer (might be NULL)
421*4882a593Smuzhiyun  *
422*4882a593Smuzhiyun  * Description:
423*4882a593Smuzhiyun  *  Invokes the callback function with the received sk_buff and the given
424*4882a593Smuzhiyun  *  parameter 'data' on a matching receive filter. A filter matches, when
425*4882a593Smuzhiyun  *
426*4882a593Smuzhiyun  *          <received_can_id> & mask == can_id & mask
427*4882a593Smuzhiyun  *
428*4882a593Smuzhiyun  *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
429*4882a593Smuzhiyun  *  filter for error message frames (CAN_ERR_FLAG bit set in mask).
430*4882a593Smuzhiyun  *
431*4882a593Smuzhiyun  *  The provided pointer to the sk_buff is guaranteed to be valid as long as
432*4882a593Smuzhiyun  *  the callback function is running. The callback function must *not* free
433*4882a593Smuzhiyun  *  the given sk_buff while processing it's task. When the given sk_buff is
434*4882a593Smuzhiyun  *  needed after the end of the callback function it must be cloned inside
435*4882a593Smuzhiyun  *  the callback function with skb_clone().
436*4882a593Smuzhiyun  *
437*4882a593Smuzhiyun  * Return:
438*4882a593Smuzhiyun  *  0 on success
439*4882a593Smuzhiyun  *  -ENOMEM on missing cache mem to create subscription entry
440*4882a593Smuzhiyun  *  -ENODEV unknown device
441*4882a593Smuzhiyun  */
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)442*4882a593Smuzhiyun int can_rx_register(struct net *net, struct net_device *dev, canid_t can_id,
443*4882a593Smuzhiyun 		    canid_t mask, void (*func)(struct sk_buff *, void *),
444*4882a593Smuzhiyun 		    void *data, char *ident, struct sock *sk)
445*4882a593Smuzhiyun {
446*4882a593Smuzhiyun 	struct receiver *rcv;
447*4882a593Smuzhiyun 	struct hlist_head *rcv_list;
448*4882a593Smuzhiyun 	struct can_dev_rcv_lists *dev_rcv_lists;
449*4882a593Smuzhiyun 	struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
450*4882a593Smuzhiyun 	int err = 0;
451*4882a593Smuzhiyun 
452*4882a593Smuzhiyun 	/* insert new receiver  (dev,canid,mask) -> (func,data) */
453*4882a593Smuzhiyun 
454*4882a593Smuzhiyun 	if (dev && (dev->type != ARPHRD_CAN || !can_get_ml_priv(dev)))
455*4882a593Smuzhiyun 		return -ENODEV;
456*4882a593Smuzhiyun 
457*4882a593Smuzhiyun 	if (dev && !net_eq(net, dev_net(dev)))
458*4882a593Smuzhiyun 		return -ENODEV;
459*4882a593Smuzhiyun 
460*4882a593Smuzhiyun 	rcv = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
461*4882a593Smuzhiyun 	if (!rcv)
462*4882a593Smuzhiyun 		return -ENOMEM;
463*4882a593Smuzhiyun 
464*4882a593Smuzhiyun 	spin_lock_bh(&net->can.rcvlists_lock);
465*4882a593Smuzhiyun 
466*4882a593Smuzhiyun 	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
467*4882a593Smuzhiyun 	rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
468*4882a593Smuzhiyun 
469*4882a593Smuzhiyun 	rcv->can_id = can_id;
470*4882a593Smuzhiyun 	rcv->mask = mask;
471*4882a593Smuzhiyun 	rcv->matches = 0;
472*4882a593Smuzhiyun 	rcv->func = func;
473*4882a593Smuzhiyun 	rcv->data = data;
474*4882a593Smuzhiyun 	rcv->ident = ident;
475*4882a593Smuzhiyun 	rcv->sk = sk;
476*4882a593Smuzhiyun 
477*4882a593Smuzhiyun 	hlist_add_head_rcu(&rcv->list, rcv_list);
478*4882a593Smuzhiyun 	dev_rcv_lists->entries++;
479*4882a593Smuzhiyun 
480*4882a593Smuzhiyun 	rcv_lists_stats->rcv_entries++;
481*4882a593Smuzhiyun 	rcv_lists_stats->rcv_entries_max = max(rcv_lists_stats->rcv_entries_max,
482*4882a593Smuzhiyun 					       rcv_lists_stats->rcv_entries);
483*4882a593Smuzhiyun 	spin_unlock_bh(&net->can.rcvlists_lock);
484*4882a593Smuzhiyun 
485*4882a593Smuzhiyun 	return err;
486*4882a593Smuzhiyun }
487*4882a593Smuzhiyun EXPORT_SYMBOL(can_rx_register);
488*4882a593Smuzhiyun 
489*4882a593Smuzhiyun /* can_rx_delete_receiver - rcu callback for single receiver entry removal */
can_rx_delete_receiver(struct rcu_head * rp)490*4882a593Smuzhiyun static void can_rx_delete_receiver(struct rcu_head *rp)
491*4882a593Smuzhiyun {
492*4882a593Smuzhiyun 	struct receiver *rcv = container_of(rp, struct receiver, rcu);
493*4882a593Smuzhiyun 	struct sock *sk = rcv->sk;
494*4882a593Smuzhiyun 
495*4882a593Smuzhiyun 	kmem_cache_free(rcv_cache, rcv);
496*4882a593Smuzhiyun 	if (sk)
497*4882a593Smuzhiyun 		sock_put(sk);
498*4882a593Smuzhiyun }
499*4882a593Smuzhiyun 
500*4882a593Smuzhiyun /**
501*4882a593Smuzhiyun  * can_rx_unregister - unsubscribe CAN frames from a specific interface
502*4882a593Smuzhiyun  * @net: the applicable net namespace
503*4882a593Smuzhiyun  * @dev: pointer to netdevice (NULL => unsubscribe from 'all' CAN devices list)
504*4882a593Smuzhiyun  * @can_id: CAN identifier
505*4882a593Smuzhiyun  * @mask: CAN mask
506*4882a593Smuzhiyun  * @func: callback function on filter match
507*4882a593Smuzhiyun  * @data: returned parameter for callback function
508*4882a593Smuzhiyun  *
509*4882a593Smuzhiyun  * Description:
510*4882a593Smuzhiyun  *  Removes subscription entry depending on given (subscription) values.
511*4882a593Smuzhiyun  */
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)512*4882a593Smuzhiyun void can_rx_unregister(struct net *net, struct net_device *dev, canid_t can_id,
513*4882a593Smuzhiyun 		       canid_t mask, void (*func)(struct sk_buff *, void *),
514*4882a593Smuzhiyun 		       void *data)
515*4882a593Smuzhiyun {
516*4882a593Smuzhiyun 	struct receiver *rcv = NULL;
517*4882a593Smuzhiyun 	struct hlist_head *rcv_list;
518*4882a593Smuzhiyun 	struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
519*4882a593Smuzhiyun 	struct can_dev_rcv_lists *dev_rcv_lists;
520*4882a593Smuzhiyun 
521*4882a593Smuzhiyun 	if (dev && dev->type != ARPHRD_CAN)
522*4882a593Smuzhiyun 		return;
523*4882a593Smuzhiyun 
524*4882a593Smuzhiyun 	if (dev && !net_eq(net, dev_net(dev)))
525*4882a593Smuzhiyun 		return;
526*4882a593Smuzhiyun 
527*4882a593Smuzhiyun 	spin_lock_bh(&net->can.rcvlists_lock);
528*4882a593Smuzhiyun 
529*4882a593Smuzhiyun 	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
530*4882a593Smuzhiyun 	rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
531*4882a593Smuzhiyun 
532*4882a593Smuzhiyun 	/* Search the receiver list for the item to delete.  This should
533*4882a593Smuzhiyun 	 * exist, since no receiver may be unregistered that hasn't
534*4882a593Smuzhiyun 	 * been registered before.
535*4882a593Smuzhiyun 	 */
536*4882a593Smuzhiyun 	hlist_for_each_entry_rcu(rcv, rcv_list, list) {
537*4882a593Smuzhiyun 		if (rcv->can_id == can_id && rcv->mask == mask &&
538*4882a593Smuzhiyun 		    rcv->func == func && rcv->data == data)
539*4882a593Smuzhiyun 			break;
540*4882a593Smuzhiyun 	}
541*4882a593Smuzhiyun 
542*4882a593Smuzhiyun 	/* Check for bugs in CAN protocol implementations using af_can.c:
543*4882a593Smuzhiyun 	 * 'rcv' will be NULL if no matching list item was found for removal.
544*4882a593Smuzhiyun 	 * As this case may potentially happen when closing a socket while
545*4882a593Smuzhiyun 	 * the notifier for removing the CAN netdev is running we just print
546*4882a593Smuzhiyun 	 * a warning here.
547*4882a593Smuzhiyun 	 */
548*4882a593Smuzhiyun 	if (!rcv) {
549*4882a593Smuzhiyun 		pr_warn("can: receive list entry not found for dev %s, id %03X, mask %03X\n",
550*4882a593Smuzhiyun 			DNAME(dev), can_id, mask);
551*4882a593Smuzhiyun 		goto out;
552*4882a593Smuzhiyun 	}
553*4882a593Smuzhiyun 
554*4882a593Smuzhiyun 	hlist_del_rcu(&rcv->list);
555*4882a593Smuzhiyun 	dev_rcv_lists->entries--;
556*4882a593Smuzhiyun 
557*4882a593Smuzhiyun 	if (rcv_lists_stats->rcv_entries > 0)
558*4882a593Smuzhiyun 		rcv_lists_stats->rcv_entries--;
559*4882a593Smuzhiyun 
560*4882a593Smuzhiyun  out:
561*4882a593Smuzhiyun 	spin_unlock_bh(&net->can.rcvlists_lock);
562*4882a593Smuzhiyun 
563*4882a593Smuzhiyun 	/* schedule the receiver item for deletion */
564*4882a593Smuzhiyun 	if (rcv) {
565*4882a593Smuzhiyun 		if (rcv->sk)
566*4882a593Smuzhiyun 			sock_hold(rcv->sk);
567*4882a593Smuzhiyun 		call_rcu(&rcv->rcu, can_rx_delete_receiver);
568*4882a593Smuzhiyun 	}
569*4882a593Smuzhiyun }
570*4882a593Smuzhiyun EXPORT_SYMBOL(can_rx_unregister);
571*4882a593Smuzhiyun 
deliver(struct sk_buff * skb,struct receiver * rcv)572*4882a593Smuzhiyun static inline void deliver(struct sk_buff *skb, struct receiver *rcv)
573*4882a593Smuzhiyun {
574*4882a593Smuzhiyun 	rcv->func(skb, rcv->data);
575*4882a593Smuzhiyun 	rcv->matches++;
576*4882a593Smuzhiyun }
577*4882a593Smuzhiyun 
can_rcv_filter(struct can_dev_rcv_lists * dev_rcv_lists,struct sk_buff * skb)578*4882a593Smuzhiyun static int can_rcv_filter(struct can_dev_rcv_lists *dev_rcv_lists, struct sk_buff *skb)
579*4882a593Smuzhiyun {
580*4882a593Smuzhiyun 	struct receiver *rcv;
581*4882a593Smuzhiyun 	int matches = 0;
582*4882a593Smuzhiyun 	struct can_frame *cf = (struct can_frame *)skb->data;
583*4882a593Smuzhiyun 	canid_t can_id = cf->can_id;
584*4882a593Smuzhiyun 
585*4882a593Smuzhiyun 	if (dev_rcv_lists->entries == 0)
586*4882a593Smuzhiyun 		return 0;
587*4882a593Smuzhiyun 
588*4882a593Smuzhiyun 	if (can_id & CAN_ERR_FLAG) {
589*4882a593Smuzhiyun 		/* check for error message frame entries only */
590*4882a593Smuzhiyun 		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ERR], list) {
591*4882a593Smuzhiyun 			if (can_id & rcv->mask) {
592*4882a593Smuzhiyun 				deliver(skb, rcv);
593*4882a593Smuzhiyun 				matches++;
594*4882a593Smuzhiyun 			}
595*4882a593Smuzhiyun 		}
596*4882a593Smuzhiyun 		return matches;
597*4882a593Smuzhiyun 	}
598*4882a593Smuzhiyun 
599*4882a593Smuzhiyun 	/* check for unfiltered entries */
600*4882a593Smuzhiyun 	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ALL], list) {
601*4882a593Smuzhiyun 		deliver(skb, rcv);
602*4882a593Smuzhiyun 		matches++;
603*4882a593Smuzhiyun 	}
604*4882a593Smuzhiyun 
605*4882a593Smuzhiyun 	/* check for can_id/mask entries */
606*4882a593Smuzhiyun 	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_FIL], list) {
607*4882a593Smuzhiyun 		if ((can_id & rcv->mask) == rcv->can_id) {
608*4882a593Smuzhiyun 			deliver(skb, rcv);
609*4882a593Smuzhiyun 			matches++;
610*4882a593Smuzhiyun 		}
611*4882a593Smuzhiyun 	}
612*4882a593Smuzhiyun 
613*4882a593Smuzhiyun 	/* check for inverted can_id/mask entries */
614*4882a593Smuzhiyun 	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_INV], list) {
615*4882a593Smuzhiyun 		if ((can_id & rcv->mask) != rcv->can_id) {
616*4882a593Smuzhiyun 			deliver(skb, rcv);
617*4882a593Smuzhiyun 			matches++;
618*4882a593Smuzhiyun 		}
619*4882a593Smuzhiyun 	}
620*4882a593Smuzhiyun 
621*4882a593Smuzhiyun 	/* check filterlists for single non-RTR can_ids */
622*4882a593Smuzhiyun 	if (can_id & CAN_RTR_FLAG)
623*4882a593Smuzhiyun 		return matches;
624*4882a593Smuzhiyun 
625*4882a593Smuzhiyun 	if (can_id & CAN_EFF_FLAG) {
626*4882a593Smuzhiyun 		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_eff[effhash(can_id)], list) {
627*4882a593Smuzhiyun 			if (rcv->can_id == can_id) {
628*4882a593Smuzhiyun 				deliver(skb, rcv);
629*4882a593Smuzhiyun 				matches++;
630*4882a593Smuzhiyun 			}
631*4882a593Smuzhiyun 		}
632*4882a593Smuzhiyun 	} else {
633*4882a593Smuzhiyun 		can_id &= CAN_SFF_MASK;
634*4882a593Smuzhiyun 		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_sff[can_id], list) {
635*4882a593Smuzhiyun 			deliver(skb, rcv);
636*4882a593Smuzhiyun 			matches++;
637*4882a593Smuzhiyun 		}
638*4882a593Smuzhiyun 	}
639*4882a593Smuzhiyun 
640*4882a593Smuzhiyun 	return matches;
641*4882a593Smuzhiyun }
642*4882a593Smuzhiyun 
can_receive(struct sk_buff * skb,struct net_device * dev)643*4882a593Smuzhiyun static void can_receive(struct sk_buff *skb, struct net_device *dev)
644*4882a593Smuzhiyun {
645*4882a593Smuzhiyun 	struct can_dev_rcv_lists *dev_rcv_lists;
646*4882a593Smuzhiyun 	struct net *net = dev_net(dev);
647*4882a593Smuzhiyun 	struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
648*4882a593Smuzhiyun 	int matches;
649*4882a593Smuzhiyun 
650*4882a593Smuzhiyun 	/* update statistics */
651*4882a593Smuzhiyun 	pkg_stats->rx_frames++;
652*4882a593Smuzhiyun 	pkg_stats->rx_frames_delta++;
653*4882a593Smuzhiyun 
654*4882a593Smuzhiyun 	/* create non-zero unique skb identifier together with *skb */
655*4882a593Smuzhiyun 	while (!(can_skb_prv(skb)->skbcnt))
656*4882a593Smuzhiyun 		can_skb_prv(skb)->skbcnt = atomic_inc_return(&skbcounter);
657*4882a593Smuzhiyun 
658*4882a593Smuzhiyun 	rcu_read_lock();
659*4882a593Smuzhiyun 
660*4882a593Smuzhiyun 	/* deliver the packet to sockets listening on all devices */
661*4882a593Smuzhiyun 	matches = can_rcv_filter(net->can.rx_alldev_list, skb);
662*4882a593Smuzhiyun 
663*4882a593Smuzhiyun 	/* find receive list for this device */
664*4882a593Smuzhiyun 	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
665*4882a593Smuzhiyun 	matches += can_rcv_filter(dev_rcv_lists, skb);
666*4882a593Smuzhiyun 
667*4882a593Smuzhiyun 	rcu_read_unlock();
668*4882a593Smuzhiyun 
669*4882a593Smuzhiyun 	/* consume the skbuff allocated by the netdevice driver */
670*4882a593Smuzhiyun 	consume_skb(skb);
671*4882a593Smuzhiyun 
672*4882a593Smuzhiyun 	if (matches > 0) {
673*4882a593Smuzhiyun 		pkg_stats->matches++;
674*4882a593Smuzhiyun 		pkg_stats->matches_delta++;
675*4882a593Smuzhiyun 	}
676*4882a593Smuzhiyun }
677*4882a593Smuzhiyun 
can_rcv(struct sk_buff * skb,struct net_device * dev,struct packet_type * pt,struct net_device * orig_dev)678*4882a593Smuzhiyun static int can_rcv(struct sk_buff *skb, struct net_device *dev,
679*4882a593Smuzhiyun 		   struct packet_type *pt, struct net_device *orig_dev)
680*4882a593Smuzhiyun {
681*4882a593Smuzhiyun 	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
682*4882a593Smuzhiyun 
683*4882a593Smuzhiyun 	if (unlikely(dev->type != ARPHRD_CAN || !can_get_ml_priv(dev) || skb->len != CAN_MTU)) {
684*4882a593Smuzhiyun 		pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d\n",
685*4882a593Smuzhiyun 			     dev->type, skb->len);
686*4882a593Smuzhiyun 		goto free_skb;
687*4882a593Smuzhiyun 	}
688*4882a593Smuzhiyun 
689*4882a593Smuzhiyun 	/* This check is made separately since cfd->len would be uninitialized if skb->len = 0. */
690*4882a593Smuzhiyun 	if (unlikely(cfd->len > CAN_MAX_DLEN)) {
691*4882a593Smuzhiyun 		pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d, datalen %d\n",
692*4882a593Smuzhiyun 			     dev->type, skb->len, cfd->len);
693*4882a593Smuzhiyun 		goto free_skb;
694*4882a593Smuzhiyun 	}
695*4882a593Smuzhiyun 
696*4882a593Smuzhiyun 	can_receive(skb, dev);
697*4882a593Smuzhiyun 	return NET_RX_SUCCESS;
698*4882a593Smuzhiyun 
699*4882a593Smuzhiyun free_skb:
700*4882a593Smuzhiyun 	kfree_skb(skb);
701*4882a593Smuzhiyun 	return NET_RX_DROP;
702*4882a593Smuzhiyun }
703*4882a593Smuzhiyun 
canfd_rcv(struct sk_buff * skb,struct net_device * dev,struct packet_type * pt,struct net_device * orig_dev)704*4882a593Smuzhiyun static int canfd_rcv(struct sk_buff *skb, struct net_device *dev,
705*4882a593Smuzhiyun 		     struct packet_type *pt, struct net_device *orig_dev)
706*4882a593Smuzhiyun {
707*4882a593Smuzhiyun 	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
708*4882a593Smuzhiyun 
709*4882a593Smuzhiyun 	if (unlikely(dev->type != ARPHRD_CAN || !can_get_ml_priv(dev) || skb->len != CANFD_MTU)) {
710*4882a593Smuzhiyun 		pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d\n",
711*4882a593Smuzhiyun 			     dev->type, skb->len);
712*4882a593Smuzhiyun 		goto free_skb;
713*4882a593Smuzhiyun 	}
714*4882a593Smuzhiyun 
715*4882a593Smuzhiyun 	/* This check is made separately since cfd->len would be uninitialized if skb->len = 0. */
716*4882a593Smuzhiyun 	if (unlikely(cfd->len > CANFD_MAX_DLEN)) {
717*4882a593Smuzhiyun 		pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d, datalen %d\n",
718*4882a593Smuzhiyun 			     dev->type, skb->len, cfd->len);
719*4882a593Smuzhiyun 		goto free_skb;
720*4882a593Smuzhiyun 	}
721*4882a593Smuzhiyun 
722*4882a593Smuzhiyun 	can_receive(skb, dev);
723*4882a593Smuzhiyun 	return NET_RX_SUCCESS;
724*4882a593Smuzhiyun 
725*4882a593Smuzhiyun free_skb:
726*4882a593Smuzhiyun 	kfree_skb(skb);
727*4882a593Smuzhiyun 	return NET_RX_DROP;
728*4882a593Smuzhiyun }
729*4882a593Smuzhiyun 
730*4882a593Smuzhiyun /* af_can protocol functions */
731*4882a593Smuzhiyun 
732*4882a593Smuzhiyun /**
733*4882a593Smuzhiyun  * can_proto_register - register CAN transport protocol
734*4882a593Smuzhiyun  * @cp: pointer to CAN protocol structure
735*4882a593Smuzhiyun  *
736*4882a593Smuzhiyun  * Return:
737*4882a593Smuzhiyun  *  0 on success
738*4882a593Smuzhiyun  *  -EINVAL invalid (out of range) protocol number
739*4882a593Smuzhiyun  *  -EBUSY  protocol already in use
740*4882a593Smuzhiyun  *  -ENOBUF if proto_register() fails
741*4882a593Smuzhiyun  */
can_proto_register(const struct can_proto * cp)742*4882a593Smuzhiyun int can_proto_register(const struct can_proto *cp)
743*4882a593Smuzhiyun {
744*4882a593Smuzhiyun 	int proto = cp->protocol;
745*4882a593Smuzhiyun 	int err = 0;
746*4882a593Smuzhiyun 
747*4882a593Smuzhiyun 	if (proto < 0 || proto >= CAN_NPROTO) {
748*4882a593Smuzhiyun 		pr_err("can: protocol number %d out of range\n", proto);
749*4882a593Smuzhiyun 		return -EINVAL;
750*4882a593Smuzhiyun 	}
751*4882a593Smuzhiyun 
752*4882a593Smuzhiyun 	err = proto_register(cp->prot, 0);
753*4882a593Smuzhiyun 	if (err < 0)
754*4882a593Smuzhiyun 		return err;
755*4882a593Smuzhiyun 
756*4882a593Smuzhiyun 	mutex_lock(&proto_tab_lock);
757*4882a593Smuzhiyun 
758*4882a593Smuzhiyun 	if (rcu_access_pointer(proto_tab[proto])) {
759*4882a593Smuzhiyun 		pr_err("can: protocol %d already registered\n", proto);
760*4882a593Smuzhiyun 		err = -EBUSY;
761*4882a593Smuzhiyun 	} else {
762*4882a593Smuzhiyun 		RCU_INIT_POINTER(proto_tab[proto], cp);
763*4882a593Smuzhiyun 	}
764*4882a593Smuzhiyun 
765*4882a593Smuzhiyun 	mutex_unlock(&proto_tab_lock);
766*4882a593Smuzhiyun 
767*4882a593Smuzhiyun 	if (err < 0)
768*4882a593Smuzhiyun 		proto_unregister(cp->prot);
769*4882a593Smuzhiyun 
770*4882a593Smuzhiyun 	return err;
771*4882a593Smuzhiyun }
772*4882a593Smuzhiyun EXPORT_SYMBOL(can_proto_register);
773*4882a593Smuzhiyun 
774*4882a593Smuzhiyun /**
775*4882a593Smuzhiyun  * can_proto_unregister - unregister CAN transport protocol
776*4882a593Smuzhiyun  * @cp: pointer to CAN protocol structure
777*4882a593Smuzhiyun  */
can_proto_unregister(const struct can_proto * cp)778*4882a593Smuzhiyun void can_proto_unregister(const struct can_proto *cp)
779*4882a593Smuzhiyun {
780*4882a593Smuzhiyun 	int proto = cp->protocol;
781*4882a593Smuzhiyun 
782*4882a593Smuzhiyun 	mutex_lock(&proto_tab_lock);
783*4882a593Smuzhiyun 	BUG_ON(rcu_access_pointer(proto_tab[proto]) != cp);
784*4882a593Smuzhiyun 	RCU_INIT_POINTER(proto_tab[proto], NULL);
785*4882a593Smuzhiyun 	mutex_unlock(&proto_tab_lock);
786*4882a593Smuzhiyun 
787*4882a593Smuzhiyun 	synchronize_rcu();
788*4882a593Smuzhiyun 
789*4882a593Smuzhiyun 	proto_unregister(cp->prot);
790*4882a593Smuzhiyun }
791*4882a593Smuzhiyun EXPORT_SYMBOL(can_proto_unregister);
792*4882a593Smuzhiyun 
can_pernet_init(struct net * net)793*4882a593Smuzhiyun static int can_pernet_init(struct net *net)
794*4882a593Smuzhiyun {
795*4882a593Smuzhiyun 	spin_lock_init(&net->can.rcvlists_lock);
796*4882a593Smuzhiyun 	net->can.rx_alldev_list =
797*4882a593Smuzhiyun 		kzalloc(sizeof(*net->can.rx_alldev_list), GFP_KERNEL);
798*4882a593Smuzhiyun 	if (!net->can.rx_alldev_list)
799*4882a593Smuzhiyun 		goto out;
800*4882a593Smuzhiyun 	net->can.pkg_stats = kzalloc(sizeof(*net->can.pkg_stats), GFP_KERNEL);
801*4882a593Smuzhiyun 	if (!net->can.pkg_stats)
802*4882a593Smuzhiyun 		goto out_free_rx_alldev_list;
803*4882a593Smuzhiyun 	net->can.rcv_lists_stats = kzalloc(sizeof(*net->can.rcv_lists_stats), GFP_KERNEL);
804*4882a593Smuzhiyun 	if (!net->can.rcv_lists_stats)
805*4882a593Smuzhiyun 		goto out_free_pkg_stats;
806*4882a593Smuzhiyun 
807*4882a593Smuzhiyun 	if (IS_ENABLED(CONFIG_PROC_FS)) {
808*4882a593Smuzhiyun 		/* the statistics are updated every second (timer triggered) */
809*4882a593Smuzhiyun 		if (stats_timer) {
810*4882a593Smuzhiyun 			timer_setup(&net->can.stattimer, can_stat_update,
811*4882a593Smuzhiyun 				    0);
812*4882a593Smuzhiyun 			mod_timer(&net->can.stattimer,
813*4882a593Smuzhiyun 				  round_jiffies(jiffies + HZ));
814*4882a593Smuzhiyun 		}
815*4882a593Smuzhiyun 		net->can.pkg_stats->jiffies_init = jiffies;
816*4882a593Smuzhiyun 		can_init_proc(net);
817*4882a593Smuzhiyun 	}
818*4882a593Smuzhiyun 
819*4882a593Smuzhiyun 	return 0;
820*4882a593Smuzhiyun 
821*4882a593Smuzhiyun  out_free_pkg_stats:
822*4882a593Smuzhiyun 	kfree(net->can.pkg_stats);
823*4882a593Smuzhiyun  out_free_rx_alldev_list:
824*4882a593Smuzhiyun 	kfree(net->can.rx_alldev_list);
825*4882a593Smuzhiyun  out:
826*4882a593Smuzhiyun 	return -ENOMEM;
827*4882a593Smuzhiyun }
828*4882a593Smuzhiyun 
can_pernet_exit(struct net * net)829*4882a593Smuzhiyun static void can_pernet_exit(struct net *net)
830*4882a593Smuzhiyun {
831*4882a593Smuzhiyun 	if (IS_ENABLED(CONFIG_PROC_FS)) {
832*4882a593Smuzhiyun 		can_remove_proc(net);
833*4882a593Smuzhiyun 		if (stats_timer)
834*4882a593Smuzhiyun 			del_timer_sync(&net->can.stattimer);
835*4882a593Smuzhiyun 	}
836*4882a593Smuzhiyun 
837*4882a593Smuzhiyun 	kfree(net->can.rx_alldev_list);
838*4882a593Smuzhiyun 	kfree(net->can.pkg_stats);
839*4882a593Smuzhiyun 	kfree(net->can.rcv_lists_stats);
840*4882a593Smuzhiyun }
841*4882a593Smuzhiyun 
842*4882a593Smuzhiyun /* af_can module init/exit functions */
843*4882a593Smuzhiyun 
844*4882a593Smuzhiyun static struct packet_type can_packet __read_mostly = {
845*4882a593Smuzhiyun 	.type = cpu_to_be16(ETH_P_CAN),
846*4882a593Smuzhiyun 	.func = can_rcv,
847*4882a593Smuzhiyun };
848*4882a593Smuzhiyun 
849*4882a593Smuzhiyun static struct packet_type canfd_packet __read_mostly = {
850*4882a593Smuzhiyun 	.type = cpu_to_be16(ETH_P_CANFD),
851*4882a593Smuzhiyun 	.func = canfd_rcv,
852*4882a593Smuzhiyun };
853*4882a593Smuzhiyun 
854*4882a593Smuzhiyun static const struct net_proto_family can_family_ops = {
855*4882a593Smuzhiyun 	.family = PF_CAN,
856*4882a593Smuzhiyun 	.create = can_create,
857*4882a593Smuzhiyun 	.owner  = THIS_MODULE,
858*4882a593Smuzhiyun };
859*4882a593Smuzhiyun 
860*4882a593Smuzhiyun static struct pernet_operations can_pernet_ops __read_mostly = {
861*4882a593Smuzhiyun 	.init = can_pernet_init,
862*4882a593Smuzhiyun 	.exit = can_pernet_exit,
863*4882a593Smuzhiyun };
864*4882a593Smuzhiyun 
can_init(void)865*4882a593Smuzhiyun static __init int can_init(void)
866*4882a593Smuzhiyun {
867*4882a593Smuzhiyun 	int err;
868*4882a593Smuzhiyun 
869*4882a593Smuzhiyun 	/* check for correct padding to be able to use the structs similarly */
870*4882a593Smuzhiyun 	BUILD_BUG_ON(offsetof(struct can_frame, can_dlc) !=
871*4882a593Smuzhiyun 		     offsetof(struct canfd_frame, len) ||
872*4882a593Smuzhiyun 		     offsetof(struct can_frame, data) !=
873*4882a593Smuzhiyun 		     offsetof(struct canfd_frame, data));
874*4882a593Smuzhiyun 
875*4882a593Smuzhiyun 	pr_info("can: controller area network core\n");
876*4882a593Smuzhiyun 
877*4882a593Smuzhiyun 	rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
878*4882a593Smuzhiyun 				      0, 0, NULL);
879*4882a593Smuzhiyun 	if (!rcv_cache)
880*4882a593Smuzhiyun 		return -ENOMEM;
881*4882a593Smuzhiyun 
882*4882a593Smuzhiyun 	err = register_pernet_subsys(&can_pernet_ops);
883*4882a593Smuzhiyun 	if (err)
884*4882a593Smuzhiyun 		goto out_pernet;
885*4882a593Smuzhiyun 
886*4882a593Smuzhiyun 	/* protocol register */
887*4882a593Smuzhiyun 	err = sock_register(&can_family_ops);
888*4882a593Smuzhiyun 	if (err)
889*4882a593Smuzhiyun 		goto out_sock;
890*4882a593Smuzhiyun 
891*4882a593Smuzhiyun 	dev_add_pack(&can_packet);
892*4882a593Smuzhiyun 	dev_add_pack(&canfd_packet);
893*4882a593Smuzhiyun 
894*4882a593Smuzhiyun 	return 0;
895*4882a593Smuzhiyun 
896*4882a593Smuzhiyun out_sock:
897*4882a593Smuzhiyun 	unregister_pernet_subsys(&can_pernet_ops);
898*4882a593Smuzhiyun out_pernet:
899*4882a593Smuzhiyun 	kmem_cache_destroy(rcv_cache);
900*4882a593Smuzhiyun 
901*4882a593Smuzhiyun 	return err;
902*4882a593Smuzhiyun }
903*4882a593Smuzhiyun 
can_exit(void)904*4882a593Smuzhiyun static __exit void can_exit(void)
905*4882a593Smuzhiyun {
906*4882a593Smuzhiyun 	/* protocol unregister */
907*4882a593Smuzhiyun 	dev_remove_pack(&canfd_packet);
908*4882a593Smuzhiyun 	dev_remove_pack(&can_packet);
909*4882a593Smuzhiyun 	sock_unregister(PF_CAN);
910*4882a593Smuzhiyun 
911*4882a593Smuzhiyun 	unregister_pernet_subsys(&can_pernet_ops);
912*4882a593Smuzhiyun 
913*4882a593Smuzhiyun 	rcu_barrier(); /* Wait for completion of call_rcu()'s */
914*4882a593Smuzhiyun 
915*4882a593Smuzhiyun 	kmem_cache_destroy(rcv_cache);
916*4882a593Smuzhiyun }
917*4882a593Smuzhiyun 
918*4882a593Smuzhiyun module_init(can_init);
919*4882a593Smuzhiyun module_exit(can_exit);
920