blob: 1c95ede2c9a6e4101f6840ae914bff156c9a1d1e [file] [log] [blame]
Oliver Hartkoppfba76a52019-07-23 15:17:55 +02001// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +02002/* af_can.c - Protocol family CAN core module
Oliver Hartkopp0d665482007-11-16 15:52:17 -08003 * (used by different CAN protocol modules)
4 *
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +02005 * Copyright (c) 2002-2017 Volkswagen Group Electronic Research
Oliver Hartkopp0d665482007-11-16 15:52:17 -08006 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of Volkswagen nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * Alternatively, provided that this notice is retained in full, this
21 * software may be distributed under the terms of the GNU General
22 * Public License ("GPL") version 2, in which case the provisions of the
23 * GPL apply INSTEAD OF those given above.
24 *
25 * The provided data structures and external interfaces from this code
26 * are not restricted to be used by modules with a GPL compatible license.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
39 * DAMAGE.
40 *
Oliver Hartkopp0d665482007-11-16 15:52:17 -080041 */
42
43#include <linux/module.h>
Oliver Hartkopp7c941632012-06-13 20:04:33 +020044#include <linux/stddef.h>
Oliver Hartkopp0d665482007-11-16 15:52:17 -080045#include <linux/init.h>
46#include <linux/kmod.h>
47#include <linux/slab.h>
48#include <linux/list.h>
49#include <linux/spinlock.h>
50#include <linux/rcupdate.h>
51#include <linux/uaccess.h>
52#include <linux/net.h>
53#include <linux/netdevice.h>
54#include <linux/socket.h>
55#include <linux/if_ether.h>
56#include <linux/if_arp.h>
57#include <linux/skbuff.h>
58#include <linux/can.h>
59#include <linux/can/core.h>
Oliver Hartkopp0ae89be2014-01-30 10:11:28 +010060#include <linux/can/skb.h>
Marc Kleine-Buddeffd956e2018-10-08 09:02:38 +020061#include <linux/can/can-ml.h>
Manuel Zerpiesd751e622011-06-16 02:08:01 +000062#include <linux/ratelimit.h>
Oliver Hartkopp0d665482007-11-16 15:52:17 -080063#include <net/net_namespace.h>
64#include <net/sock.h>
65
66#include "af_can.h"
67
Oliver Hartkopp0d665482007-11-16 15:52:17 -080068MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
69MODULE_LICENSE("Dual BSD/GPL");
70MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
71 "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
72
73MODULE_ALIAS_NETPROTO(PF_CAN);
74
75static int stats_timer __read_mostly = 1;
Joe Perchesd6444062018-03-23 15:54:38 -070076module_param(stats_timer, int, 0444);
Oliver Hartkopp0d665482007-11-16 15:52:17 -080077MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
78
Oliver Hartkopp0d665482007-11-16 15:52:17 -080079static struct kmem_cache *rcv_cache __read_mostly;
80
81/* table of registered CAN protocols */
Marc Kleine-Buddecae1d5b2017-10-17 07:18:35 +020082static const struct can_proto __rcu *proto_tab[CAN_NPROTO] __read_mostly;
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +000083static DEFINE_MUTEX(proto_tab_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -080084
Oliver Hartkoppd3b58c42015-06-26 11:58:19 +020085static atomic_t skbcounter = ATOMIC_INIT(0);
86
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +020087/* af_can socket functions */
Oliver Hartkopp0d665482007-11-16 15:52:17 -080088
Oleksij Rempel975987e2019-11-07 11:55:42 +010089void can_sock_destruct(struct sock *sk)
Oliver Hartkopp0d665482007-11-16 15:52:17 -080090{
91 skb_queue_purge(&sk->sk_receive_queue);
Willem de Bruijnfd704bd2019-06-07 16:46:07 -040092 skb_queue_purge(&sk->sk_error_queue);
Oliver Hartkopp0d665482007-11-16 15:52:17 -080093}
Oleksij Rempel975987e2019-11-07 11:55:42 +010094EXPORT_SYMBOL(can_sock_destruct);
Oliver Hartkopp0d665482007-11-16 15:52:17 -080095
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +000096static const struct can_proto *can_get_proto(int protocol)
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +000097{
Kurt Van Dijck16506292011-05-03 18:40:57 +000098 const struct can_proto *cp;
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +000099
100 rcu_read_lock();
101 cp = rcu_dereference(proto_tab[protocol]);
102 if (cp && !try_module_get(cp->prot->owner))
103 cp = NULL;
104 rcu_read_unlock();
105
106 return cp;
107}
108
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000109static inline void can_put_proto(const struct can_proto *cp)
110{
111 module_put(cp->prot->owner);
112}
113
Eric Paris3f378b62009-11-05 22:18:14 -0800114static int can_create(struct net *net, struct socket *sock, int protocol,
115 int kern)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800116{
117 struct sock *sk;
Kurt Van Dijck16506292011-05-03 18:40:57 +0000118 const struct can_proto *cp;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800119 int err = 0;
120
121 sock->state = SS_UNCONNECTED;
122
123 if (protocol < 0 || protocol >= CAN_NPROTO)
124 return -EINVAL;
125
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000126 cp = can_get_proto(protocol);
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000127
Johannes Berg95a5afc2008-10-16 15:24:51 -0700128#ifdef CONFIG_MODULES
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000129 if (!cp) {
130 /* try to load protocol module if kernel is modular */
131
Urs Thuermann5423dd62008-02-07 18:04:21 -0800132 err = request_module("can-proto-%d", protocol);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800133
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200134 /* In case of error we only print a message but don't
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800135 * return the error code immediately. Below we will
136 * return -EPROTONOSUPPORT
137 */
Manuel Zerpiesd751e622011-06-16 02:08:01 +0000138 if (err)
Marc Kleine-Budde1cf571e2019-08-13 09:29:10 +0200139 pr_err_ratelimited("can: request_module (can-proto-%d) failed.\n",
140 protocol);
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000141
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000142 cp = can_get_proto(protocol);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800143 }
Urs Thuermann5423dd62008-02-07 18:04:21 -0800144#endif
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800145
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800146 /* check for available protocol and correct usage */
147
148 if (!cp)
149 return -EPROTONOSUPPORT;
150
151 if (cp->type != sock->type) {
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000152 err = -EPROTOTYPE;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800153 goto errout;
154 }
155
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800156 sock->ops = cp->ops;
157
Eric W. Biederman11aa9c22015-05-08 21:09:13 -0500158 sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot, kern);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800159 if (!sk) {
160 err = -ENOMEM;
161 goto errout;
162 }
163
164 sock_init_data(sock, sk);
165 sk->sk_destruct = can_sock_destruct;
166
167 if (sk->sk_prot->init)
168 err = sk->sk_prot->init(sk);
169
170 if (err) {
171 /* release sk on errors */
172 sock_orphan(sk);
173 sock_put(sk);
174 }
175
176 errout:
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000177 can_put_proto(cp);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800178 return err;
179}
180
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200181/* af_can tx path */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800182
183/**
184 * can_send - transmit a CAN frame (optional with local loopback)
185 * @skb: pointer to socket buffer with CAN frame in data section
186 * @loop: loopback for listeners on local CAN sockets (recommended default!)
187 *
Oliver Hartkopp481a8192009-09-15 01:31:34 -0700188 * Due to the loopback this routine must not be called from hardirq context.
189 *
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800190 * Return:
191 * 0 on success
192 * -ENETDOWN when the selected interface is down
193 * -ENOBUFS on full driver queue (see net_xmit_errno())
194 * -ENOMEM when local loopback failed at calling skb_clone()
195 * -EPERM when trying to send on a non-CAN interface
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200196 * -EMSGSIZE CAN frame size is bigger than CAN interface MTU
Oliver Hartkopp7f2d38e2008-07-05 23:38:43 -0700197 * -EINVAL when the skb->data does not contain a valid CAN frame
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800198 */
199int can_send(struct sk_buff *skb, int loop)
200{
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700201 struct sk_buff *newskb = NULL;
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200202 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200203 struct can_pkg_stats *pkg_stats = dev_net(skb->dev)->can.pkg_stats;
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200204 int err = -EINVAL;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800205
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200206 if (skb->len == CAN_MTU) {
207 skb->protocol = htons(ETH_P_CAN);
208 if (unlikely(cfd->len > CAN_MAX_DLEN))
209 goto inval_skb;
210 } else if (skb->len == CANFD_MTU) {
211 skb->protocol = htons(ETH_P_CANFD);
212 if (unlikely(cfd->len > CANFD_MAX_DLEN))
213 goto inval_skb;
Marc Kleine-Budde8325ce92019-08-13 09:03:55 +0200214 } else {
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200215 goto inval_skb;
Marc Kleine-Budde8325ce92019-08-13 09:03:55 +0200216 }
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200217
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200218 /* Make sure the CAN frame can pass the selected CAN netdevice.
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200219 * As structs can_frame and canfd_frame are similar, we can provide
220 * CAN FD frames to legacy CAN drivers as long as the length is <= 8
221 */
222 if (unlikely(skb->len > skb->dev->mtu && cfd->len > CAN_MAX_DLEN)) {
223 err = -EMSGSIZE;
224 goto inval_skb;
Oliver Hartkopp7f2d38e2008-07-05 23:38:43 -0700225 }
226
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200227 if (unlikely(skb->dev->type != ARPHRD_CAN)) {
228 err = -EPERM;
229 goto inval_skb;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800230 }
231
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200232 if (unlikely(!(skb->dev->flags & IFF_UP))) {
233 err = -ENETDOWN;
234 goto inval_skb;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800235 }
236
Oliver Hartkopp9694390162015-02-23 20:37:54 +0100237 skb->ip_summed = CHECKSUM_UNNECESSARY;
238
239 skb_reset_mac_header(skb);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800240 skb_reset_network_header(skb);
241 skb_reset_transport_header(skb);
242
243 if (loop) {
244 /* local loopback of sent CAN frames */
245
246 /* indication for the CAN driver: do loopback */
247 skb->pkt_type = PACKET_LOOPBACK;
248
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200249 /* The reference to the originating sock may be required
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800250 * by the receiving socket to check whether the frame is
251 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
252 * Therefore we have to ensure that skb->sk remains the
253 * reference to the originating sock by restoring skb->sk
254 * after each skb_clone() or skb_orphan() usage.
255 */
256
257 if (!(skb->dev->flags & IFF_ECHO)) {
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200258 /* If the interface is not capable to do loopback
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800259 * itself, we do it here.
260 */
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700261 newskb = skb_clone(skb, GFP_ATOMIC);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800262 if (!newskb) {
263 kfree_skb(skb);
264 return -ENOMEM;
265 }
266
Oliver Hartkopp0ae89be2014-01-30 10:11:28 +0100267 can_skb_set_owner(newskb, skb->sk);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800268 newskb->ip_summed = CHECKSUM_UNNECESSARY;
269 newskb->pkt_type = PACKET_BROADCAST;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800270 }
271 } else {
272 /* indication for the CAN driver: no loopback required */
273 skb->pkt_type = PACKET_HOST;
274 }
275
276 /* send to netdevice */
277 err = dev_queue_xmit(skb);
278 if (err > 0)
279 err = net_xmit_errno(err);
280
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700281 if (err) {
Wei Yongjunce030ed2009-02-25 00:35:44 +0000282 kfree_skb(newskb);
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700283 return err;
284 }
285
Oliver Hartkoppd3b58c42015-06-26 11:58:19 +0200286 if (newskb)
Oliver Hartkopp481a8192009-09-15 01:31:34 -0700287 netif_rx_ni(newskb);
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700288
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800289 /* update statistics */
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200290 pkg_stats->tx_frames++;
291 pkg_stats->tx_frames_delta++;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800292
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700293 return 0;
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200294
295inval_skb:
296 kfree_skb(skb);
297 return err;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800298}
299EXPORT_SYMBOL(can_send);
300
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200301/* af_can rx path */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800302
Marc Kleine-Buddefac78502018-10-08 09:02:34 +0200303static struct can_dev_rcv_lists *can_dev_rcv_lists_find(struct net *net,
304 struct net_device *dev)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800305{
Marc Kleine-Budde8df9ffb2018-10-08 09:02:39 +0200306 if (dev) {
Oleksij Rempel1a5751d2021-02-23 08:01:26 +0100307 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
308 return &can_ml->dev_rcv_lists;
Marc Kleine-Budde8df9ffb2018-10-08 09:02:39 +0200309 } else {
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200310 return net->can.rx_alldev_list;
Marc Kleine-Budde8df9ffb2018-10-08 09:02:39 +0200311 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800312}
313
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800314/**
Oliver Hartkopp45c70022014-04-02 20:25:26 +0200315 * effhash - hash function for 29 bit CAN identifier reduction
316 * @can_id: 29 bit CAN identifier
317 *
318 * Description:
319 * To reduce the linear traversal in one linked list of _single_ EFF CAN
320 * frame subscriptions the 29 bit identifier is mapped to 10 bits.
321 * (see CAN_EFF_RCV_HASH_BITS definition)
322 *
323 * Return:
324 * Hash value from 0x000 - 0x3FF ( enforced by CAN_EFF_RCV_HASH_BITS mask )
325 */
326static unsigned int effhash(canid_t can_id)
327{
328 unsigned int hash;
329
330 hash = can_id;
331 hash ^= can_id >> CAN_EFF_RCV_HASH_BITS;
332 hash ^= can_id >> (2 * CAN_EFF_RCV_HASH_BITS);
333
334 return hash & ((1 << CAN_EFF_RCV_HASH_BITS) - 1);
335}
336
337/**
Marc Kleine-Budde3ee6d2b2018-10-08 09:02:33 +0200338 * can_rcv_list_find - determine optimal filterlist inside device filter struct
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800339 * @can_id: pointer to CAN identifier of a given can_filter
340 * @mask: pointer to CAN mask of a given can_filter
Marc Kleine-Budde80ede642020-10-04 14:09:48 +0200341 * @dev_rcv_lists: pointer to the device filter struct
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800342 *
343 * Description:
344 * Returns the optimal filterlist to reduce the filter handling in the
345 * receive path. This function is called by service functions that need
346 * to register or unregister a can_filter in the filter lists.
347 *
348 * A filter matches in general, when
349 *
350 * <received_can_id> & mask == can_id & mask
351 *
352 * so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
353 * relevant bits for the filter.
354 *
355 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200356 * filter for error messages (CAN_ERR_FLAG bit set in mask). For error msg
357 * frames there is a special filterlist and a special rx path filter handling.
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800358 *
359 * Return:
360 * Pointer to optimal filterlist for the given can_id/mask pair.
Marc Kleine-Budde0436ea32020-09-16 00:34:54 +0200361 * Consistency checked mask.
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800362 * Reduced can_id to have a preprocessed filter compare value.
363 */
Marc Kleine-Budde3ee6d2b2018-10-08 09:02:33 +0200364static struct hlist_head *can_rcv_list_find(canid_t *can_id, canid_t *mask,
365 struct can_dev_rcv_lists *dev_rcv_lists)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800366{
367 canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
368
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200369 /* filter for error message frames in extra filterlist */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800370 if (*mask & CAN_ERR_FLAG) {
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800371 /* clear CAN_ERR_FLAG in filter entry */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800372 *mask &= CAN_ERR_MASK;
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200373 return &dev_rcv_lists->rx[RX_ERR];
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800374 }
375
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800376 /* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */
377
378#define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)
379
380 /* ensure valid values in can_mask for 'SFF only' frame filtering */
381 if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
382 *mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800383
384 /* reduce condition testing at receive time */
385 *can_id &= *mask;
386
387 /* inverse can_id/can_mask filter */
388 if (inv)
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200389 return &dev_rcv_lists->rx[RX_INV];
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800390
391 /* mask == 0 => no condition testing at receive time */
392 if (!(*mask))
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200393 return &dev_rcv_lists->rx[RX_ALL];
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800394
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800395 /* extra filterlists for the subscription of a single non-RTR can_id */
Joe Perchesf64f9e72009-11-29 16:55:45 -0800396 if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS) &&
397 !(*can_id & CAN_RTR_FLAG)) {
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800398 if (*can_id & CAN_EFF_FLAG) {
Oliver Hartkopp45c70022014-04-02 20:25:26 +0200399 if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS))
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200400 return &dev_rcv_lists->rx_eff[effhash(*can_id)];
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800401 } else {
402 if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200403 return &dev_rcv_lists->rx_sff[*can_id];
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800404 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800405 }
406
407 /* default: filter via can_id/can_mask */
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200408 return &dev_rcv_lists->rx[RX_FIL];
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800409}
410
411/**
412 * can_rx_register - subscribe CAN frames from a specific interface
Andrew Lunne0a7f1fe2020-07-13 01:14:58 +0200413 * @net: the applicable net namespace
Marc Kleine-Budde0436ea32020-09-16 00:34:54 +0200414 * @dev: pointer to netdevice (NULL => subscribe from 'all' CAN devices list)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800415 * @can_id: CAN identifier (see description)
416 * @mask: CAN mask (see description)
417 * @func: callback function on filter match
418 * @data: returned parameter for callback function
Maxime Jayat3f794102013-10-12 01:29:46 +0200419 * @ident: string for calling module identification
Eric Dumazetf1712c72017-01-27 08:11:44 -0800420 * @sk: socket pointer (might be NULL)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800421 *
422 * Description:
423 * Invokes the callback function with the received sk_buff and the given
424 * parameter 'data' on a matching receive filter. A filter matches, when
425 *
426 * <received_can_id> & mask == can_id & mask
427 *
428 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200429 * filter for error message frames (CAN_ERR_FLAG bit set in mask).
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800430 *
Oliver Hartkopp1fa17d42009-01-06 11:07:54 -0800431 * The provided pointer to the sk_buff is guaranteed to be valid as long as
432 * the callback function is running. The callback function must *not* free
433 * the given sk_buff while processing it's task. When the given sk_buff is
434 * needed after the end of the callback function it must be cloned inside
435 * the callback function with skb_clone().
436 *
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800437 * Return:
438 * 0 on success
439 * -ENOMEM on missing cache mem to create subscription entry
440 * -ENODEV unknown device
441 */
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100442int can_rx_register(struct net *net, struct net_device *dev, canid_t can_id,
443 canid_t mask, void (*func)(struct sk_buff *, void *),
444 void *data, char *ident, struct sock *sk)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800445{
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200446 struct receiver *rcv;
447 struct hlist_head *rcv_list;
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200448 struct can_dev_rcv_lists *dev_rcv_lists;
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200449 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800450 int err = 0;
451
452 /* insert new receiver (dev,canid,mask) -> (func,data) */
453
Oliver Hartkopp8b640562010-02-02 07:21:34 -0800454 if (dev && dev->type != ARPHRD_CAN)
455 return -ENODEV;
456
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100457 if (dev && !net_eq(net, dev_net(dev)))
458 return -ENODEV;
459
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200460 rcv = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
461 if (!rcv)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800462 return -ENOMEM;
463
Oleksij Rempel24efc6d2018-10-30 09:00:34 +0100464 spin_lock_bh(&net->can.rcvlists_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800465
Marc Kleine-Buddefac78502018-10-08 09:02:34 +0200466 dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
Marc Kleine-Buddebdfb5762018-10-08 09:02:40 +0200467 rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800468
Marc Kleine-Buddebdfb5762018-10-08 09:02:40 +0200469 rcv->can_id = can_id;
470 rcv->mask = mask;
471 rcv->matches = 0;
472 rcv->func = func;
473 rcv->data = data;
474 rcv->ident = ident;
475 rcv->sk = sk;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800476
Marc Kleine-Buddebdfb5762018-10-08 09:02:40 +0200477 hlist_add_head_rcu(&rcv->list, rcv_list);
478 dev_rcv_lists->entries++;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800479
Marc Kleine-Buddebdfb5762018-10-08 09:02:40 +0200480 rcv_lists_stats->rcv_entries++;
481 rcv_lists_stats->rcv_entries_max = max(rcv_lists_stats->rcv_entries_max,
482 rcv_lists_stats->rcv_entries);
Oleksij Rempel24efc6d2018-10-30 09:00:34 +0100483 spin_unlock_bh(&net->can.rcvlists_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800484
485 return err;
486}
487EXPORT_SYMBOL(can_rx_register);
488
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200489/* can_rx_delete_receiver - rcu callback for single receiver entry removal */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800490static void can_rx_delete_receiver(struct rcu_head *rp)
491{
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200492 struct receiver *rcv = container_of(rp, struct receiver, rcu);
493 struct sock *sk = rcv->sk;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800494
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200495 kmem_cache_free(rcv_cache, rcv);
Eric Dumazetf1712c72017-01-27 08:11:44 -0800496 if (sk)
497 sock_put(sk);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800498}
499
500/**
501 * can_rx_unregister - unsubscribe CAN frames from a specific interface
Andrew Lunne0a7f1fe2020-07-13 01:14:58 +0200502 * @net: the applicable net namespace
Jeremiah Mahler069f8452014-12-05 09:54:38 -0800503 * @dev: pointer to netdevice (NULL => unsubscribe from 'all' CAN devices list)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800504 * @can_id: CAN identifier
505 * @mask: CAN mask
506 * @func: callback function on filter match
507 * @data: returned parameter for callback function
508 *
509 * Description:
510 * Removes subscription entry depending on given (subscription) values.
511 */
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100512void can_rx_unregister(struct net *net, struct net_device *dev, canid_t can_id,
513 canid_t mask, void (*func)(struct sk_buff *, void *),
514 void *data)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800515{
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200516 struct receiver *rcv = NULL;
517 struct hlist_head *rcv_list;
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200518 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200519 struct can_dev_rcv_lists *dev_rcv_lists;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800520
Oliver Hartkopp8b640562010-02-02 07:21:34 -0800521 if (dev && dev->type != ARPHRD_CAN)
522 return;
523
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100524 if (dev && !net_eq(net, dev_net(dev)))
525 return;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800526
Oleksij Rempel24efc6d2018-10-30 09:00:34 +0100527 spin_lock_bh(&net->can.rcvlists_lock);
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100528
Marc Kleine-Buddefac78502018-10-08 09:02:34 +0200529 dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200530 rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800531
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200532 /* Search the receiver list for the item to delete. This should
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800533 * exist, since no receiver may be unregistered that hasn't
534 * been registered before.
535 */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200536 hlist_for_each_entry_rcu(rcv, rcv_list, list) {
537 if (rcv->can_id == can_id && rcv->mask == mask &&
538 rcv->func == func && rcv->data == data)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800539 break;
540 }
541
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200542 /* Check for bugs in CAN protocol implementations using af_can.c:
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200543 * 'rcv' will be NULL if no matching list item was found for removal.
Oliver Hartkoppd73ff9b2020-11-26 20:21:40 +0100544 * As this case may potentially happen when closing a socket while
545 * the notifier for removing the CAN netdev is running we just print
546 * a warning here.
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800547 */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200548 if (!rcv) {
Oliver Hartkoppd73ff9b2020-11-26 20:21:40 +0100549 pr_warn("can: receive list entry not found for dev %s, id %03X, mask %03X\n",
550 DNAME(dev), can_id, mask);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800551 goto out;
552 }
553
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200554 hlist_del_rcu(&rcv->list);
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200555 dev_rcv_lists->entries--;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800556
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200557 if (rcv_lists_stats->rcv_entries > 0)
558 rcv_lists_stats->rcv_entries--;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800559
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800560 out:
Oleksij Rempel24efc6d2018-10-30 09:00:34 +0100561 spin_unlock_bh(&net->can.rcvlists_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800562
563 /* schedule the receiver item for deletion */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200564 if (rcv) {
565 if (rcv->sk)
566 sock_hold(rcv->sk);
567 call_rcu(&rcv->rcu, can_rx_delete_receiver);
Eric Dumazetf1712c72017-01-27 08:11:44 -0800568 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800569}
570EXPORT_SYMBOL(can_rx_unregister);
571
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200572static inline void deliver(struct sk_buff *skb, struct receiver *rcv)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800573{
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200574 rcv->func(skb, rcv->data);
575 rcv->matches++;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800576}
577
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200578static int can_rcv_filter(struct can_dev_rcv_lists *dev_rcv_lists, struct sk_buff *skb)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800579{
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200580 struct receiver *rcv;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800581 int matches = 0;
582 struct can_frame *cf = (struct can_frame *)skb->data;
583 canid_t can_id = cf->can_id;
584
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200585 if (dev_rcv_lists->entries == 0)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800586 return 0;
587
588 if (can_id & CAN_ERR_FLAG) {
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200589 /* check for error message frame entries only */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200590 hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ERR], list) {
591 if (can_id & rcv->mask) {
592 deliver(skb, rcv);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800593 matches++;
594 }
595 }
596 return matches;
597 }
598
599 /* check for unfiltered entries */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200600 hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ALL], list) {
601 deliver(skb, rcv);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800602 matches++;
603 }
604
605 /* check for can_id/mask entries */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200606 hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_FIL], list) {
607 if ((can_id & rcv->mask) == rcv->can_id) {
608 deliver(skb, rcv);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800609 matches++;
610 }
611 }
612
613 /* check for inverted can_id/mask entries */
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200614 hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_INV], list) {
615 if ((can_id & rcv->mask) != rcv->can_id) {
616 deliver(skb, rcv);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800617 matches++;
618 }
619 }
620
Oliver Hartkoppf706644d2008-12-04 15:01:08 -0800621 /* check filterlists for single non-RTR can_ids */
622 if (can_id & CAN_RTR_FLAG)
623 return matches;
624
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800625 if (can_id & CAN_EFF_FLAG) {
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200626 hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_eff[effhash(can_id)], list) {
627 if (rcv->can_id == can_id) {
628 deliver(skb, rcv);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800629 matches++;
630 }
631 }
632 } else {
633 can_id &= CAN_SFF_MASK;
Marc Kleine-Budde6625a182018-10-08 09:02:35 +0200634 hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_sff[can_id], list) {
635 deliver(skb, rcv);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800636 matches++;
637 }
638 }
639
640 return matches;
641}
642
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200643static void can_receive(struct sk_buff *skb, struct net_device *dev)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800644{
Marc Kleine-Budde56be1d52018-10-08 09:02:31 +0200645 struct can_dev_rcv_lists *dev_rcv_lists;
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200646 struct net *net = dev_net(dev);
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200647 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800648 int matches;
649
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800650 /* update statistics */
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200651 pkg_stats->rx_frames++;
652 pkg_stats->rx_frames_delta++;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800653
Oliver Hartkoppd3b58c42015-06-26 11:58:19 +0200654 /* create non-zero unique skb identifier together with *skb */
655 while (!(can_skb_prv(skb)->skbcnt))
656 can_skb_prv(skb)->skbcnt = atomic_inc_return(&skbcounter);
657
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800658 rcu_read_lock();
659
660 /* deliver the packet to sockets listening on all devices */
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200661 matches = can_rcv_filter(net->can.rx_alldev_list, skb);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800662
663 /* find receive list for this device */
Marc Kleine-Buddefac78502018-10-08 09:02:34 +0200664 dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
Marc Kleine-Buddebdfb5762018-10-08 09:02:40 +0200665 matches += can_rcv_filter(dev_rcv_lists, skb);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800666
667 rcu_read_unlock();
668
Oliver Hartkopp62bcaa12009-04-17 01:38:46 -0700669 /* consume the skbuff allocated by the netdevice driver */
670 consume_skb(skb);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800671
672 if (matches > 0) {
Marc Kleine-Buddee2c1f5c2018-10-08 09:02:28 +0200673 pkg_stats->matches++;
674 pkg_stats->matches_delta++;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800675 }
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200676}
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800677
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200678static int can_rcv(struct sk_buff *skb, struct net_device *dev,
679 struct packet_type *pt, struct net_device *orig_dev)
680{
681 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
682
Anant Thazhemadamc8c958a2020-11-04 03:09:05 +0530683 if (unlikely(dev->type != ARPHRD_CAN || skb->len != CAN_MTU)) {
684 pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d\n",
685 dev->type, skb->len);
686 goto free_skb;
687 }
688
689 /* This check is made separately since cfd->len would be uninitialized if skb->len = 0. */
690 if (unlikely(cfd->len > CAN_MAX_DLEN)) {
691 pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d, datalen %d\n",
Marc Kleine-Budde8cb68752018-01-16 19:30:14 +0100692 dev->type, skb->len, cfd->len);
Anant Thazhemadamc8c958a2020-11-04 03:09:05 +0530693 goto free_skb;
Marc Kleine-Budde8cb68752018-01-16 19:30:14 +0100694 }
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200695
696 can_receive(skb, dev);
697 return NET_RX_SUCCESS;
Anant Thazhemadamc8c958a2020-11-04 03:09:05 +0530698
699free_skb:
700 kfree_skb(skb);
701 return NET_RX_DROP;
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200702}
703
704static int canfd_rcv(struct sk_buff *skb, struct net_device *dev,
Marc Kleine-Buddeb11844b2019-08-13 09:06:17 +0200705 struct packet_type *pt, struct net_device *orig_dev)
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200706{
707 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
708
Anant Thazhemadam9aa93792020-11-04 03:09:06 +0530709 if (unlikely(dev->type != ARPHRD_CAN || skb->len != CANFD_MTU)) {
710 pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d\n",
711 dev->type, skb->len);
712 goto free_skb;
713 }
714
715 /* This check is made separately since cfd->len would be uninitialized if skb->len = 0. */
716 if (unlikely(cfd->len > CANFD_MAX_DLEN)) {
717 pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d, datalen %d\n",
Marc Kleine-Budded4689842018-01-16 19:30:14 +0100718 dev->type, skb->len, cfd->len);
Anant Thazhemadam9aa93792020-11-04 03:09:06 +0530719 goto free_skb;
Marc Kleine-Budded4689842018-01-16 19:30:14 +0100720 }
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200721
722 can_receive(skb, dev);
Oliver Hartkopp6ca8b992009-08-29 06:45:09 +0000723 return NET_RX_SUCCESS;
Anant Thazhemadam9aa93792020-11-04 03:09:06 +0530724
725free_skb:
726 kfree_skb(skb);
727 return NET_RX_DROP;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800728}
729
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200730/* af_can protocol functions */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800731
732/**
733 * can_proto_register - register CAN transport protocol
734 * @cp: pointer to CAN protocol structure
735 *
736 * Return:
737 * 0 on success
738 * -EINVAL invalid (out of range) protocol number
739 * -EBUSY protocol already in use
740 * -ENOBUF if proto_register() fails
741 */
Kurt Van Dijck16506292011-05-03 18:40:57 +0000742int can_proto_register(const struct can_proto *cp)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800743{
744 int proto = cp->protocol;
745 int err = 0;
746
747 if (proto < 0 || proto >= CAN_NPROTO) {
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000748 pr_err("can: protocol number %d out of range\n", proto);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800749 return -EINVAL;
750 }
751
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800752 err = proto_register(cp->prot, 0);
753 if (err < 0)
754 return err;
755
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000756 mutex_lock(&proto_tab_lock);
757
Marc Kleine-Buddecae1d5b2017-10-17 07:18:35 +0200758 if (rcu_access_pointer(proto_tab[proto])) {
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000759 pr_err("can: protocol %d already registered\n", proto);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800760 err = -EBUSY;
Marc Kleine-Budde8325ce92019-08-13 09:03:55 +0200761 } else {
Stephen Hemmingera9b3cd72011-08-01 16:19:00 +0000762 RCU_INIT_POINTER(proto_tab[proto], cp);
Marc Kleine-Budde8325ce92019-08-13 09:03:55 +0200763 }
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800764
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000765 mutex_unlock(&proto_tab_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800766
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800767 if (err < 0)
768 proto_unregister(cp->prot);
769
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800770 return err;
771}
772EXPORT_SYMBOL(can_proto_register);
773
774/**
775 * can_proto_unregister - unregister CAN transport protocol
776 * @cp: pointer to CAN protocol structure
777 */
Kurt Van Dijck16506292011-05-03 18:40:57 +0000778void can_proto_unregister(const struct can_proto *cp)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800779{
780 int proto = cp->protocol;
781
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000782 mutex_lock(&proto_tab_lock);
Marc Kleine-Buddecae1d5b2017-10-17 07:18:35 +0200783 BUG_ON(rcu_access_pointer(proto_tab[proto]) != cp);
Stephen Hemmingera9b3cd72011-08-01 16:19:00 +0000784 RCU_INIT_POINTER(proto_tab[proto], NULL);
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000785 mutex_unlock(&proto_tab_lock);
786
787 synchronize_rcu();
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800788
789 proto_unregister(cp->prot);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800790}
791EXPORT_SYMBOL(can_proto_unregister);
792
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100793static int can_pernet_init(struct net *net)
794{
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200795 spin_lock_init(&net->can.rcvlists_lock);
796 net->can.rx_alldev_list =
797 kzalloc(sizeof(*net->can.rx_alldev_list), GFP_KERNEL);
798 if (!net->can.rx_alldev_list)
Marc Kleine-Budde5a606222017-07-29 11:51:01 +0200799 goto out;
Marc Kleine-Budde23410862018-10-08 09:02:27 +0200800 net->can.pkg_stats = kzalloc(sizeof(*net->can.pkg_stats), GFP_KERNEL);
801 if (!net->can.pkg_stats)
802 goto out_free_rx_alldev_list;
803 net->can.rcv_lists_stats = kzalloc(sizeof(*net->can.rcv_lists_stats), GFP_KERNEL);
804 if (!net->can.rcv_lists_stats)
805 goto out_free_pkg_stats;
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200806
807 if (IS_ENABLED(CONFIG_PROC_FS)) {
808 /* the statistics are updated every second (timer triggered) */
809 if (stats_timer) {
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200810 timer_setup(&net->can.stattimer, can_stat_update,
Kees Cook1fccb562017-10-16 17:29:06 -0700811 0);
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200812 mod_timer(&net->can.stattimer,
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200813 round_jiffies(jiffies + HZ));
814 }
Marc Kleine-Budde23410862018-10-08 09:02:27 +0200815 net->can.pkg_stats->jiffies_init = jiffies;
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100816 can_init_proc(net);
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200817 }
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100818
819 return 0;
Marc Kleine-Budde5a606222017-07-29 11:51:01 +0200820
Marc Kleine-Budde23410862018-10-08 09:02:27 +0200821 out_free_pkg_stats:
822 kfree(net->can.pkg_stats);
823 out_free_rx_alldev_list:
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200824 kfree(net->can.rx_alldev_list);
Marc Kleine-Budde5a606222017-07-29 11:51:01 +0200825 out:
826 return -ENOMEM;
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100827}
828
829static void can_pernet_exit(struct net *net)
830{
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200831 if (IS_ENABLED(CONFIG_PROC_FS)) {
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100832 can_remove_proc(net);
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200833 if (stats_timer)
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200834 del_timer_sync(&net->can.stattimer);
Oliver Hartkoppcb5635a2017-04-25 08:19:41 +0200835 }
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100836
Marc Kleine-Budde564577d2018-10-08 09:02:30 +0200837 kfree(net->can.rx_alldev_list);
Marc Kleine-Budde23410862018-10-08 09:02:27 +0200838 kfree(net->can.pkg_stats);
839 kfree(net->can.rcv_lists_stats);
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100840}
841
Marc Kleine-Budde147d9e92019-07-24 14:16:29 +0200842/* af_can module init/exit functions */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800843
844static struct packet_type can_packet __read_mostly = {
Harvey Harrison09640e632009-02-01 00:45:17 -0800845 .type = cpu_to_be16(ETH_P_CAN),
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800846 .func = can_rcv,
847};
848
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200849static struct packet_type canfd_packet __read_mostly = {
850 .type = cpu_to_be16(ETH_P_CANFD),
851 .func = canfd_rcv,
852};
853
Stephen Hemmingerec1b4cf2009-10-05 05:58:39 +0000854static const struct net_proto_family can_family_ops = {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800855 .family = PF_CAN,
856 .create = can_create,
857 .owner = THIS_MODULE,
858};
859
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100860static struct pernet_operations can_pernet_ops __read_mostly = {
861 .init = can_pernet_init,
862 .exit = can_pernet_exit,
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100863};
864
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800865static __init int can_init(void)
866{
YueHaibingc5a3aed2019-05-16 22:36:26 +0800867 int err;
868
Oliver Hartkopp7c941632012-06-13 20:04:33 +0200869 /* check for correct padding to be able to use the structs similarly */
870 BUILD_BUG_ON(offsetof(struct can_frame, can_dlc) !=
871 offsetof(struct canfd_frame, len) ||
872 offsetof(struct can_frame, data) !=
873 offsetof(struct canfd_frame, data));
874
Oliver Hartkoppf726f3d2020-10-12 09:43:54 +0200875 pr_info("can: controller area network core\n");
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800876
877 rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
878 0, 0, NULL);
879 if (!rcv_cache)
880 return -ENOMEM;
881
YueHaibingc5a3aed2019-05-16 22:36:26 +0800882 err = register_pernet_subsys(&can_pernet_ops);
883 if (err)
884 goto out_pernet;
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100885
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800886 /* protocol register */
YueHaibingc5a3aed2019-05-16 22:36:26 +0800887 err = sock_register(&can_family_ops);
888 if (err)
889 goto out_sock;
YueHaibingc5a3aed2019-05-16 22:36:26 +0800890
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800891 dev_add_pack(&can_packet);
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200892 dev_add_pack(&canfd_packet);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800893
894 return 0;
YueHaibingc5a3aed2019-05-16 22:36:26 +0800895
YueHaibingc5a3aed2019-05-16 22:36:26 +0800896out_sock:
897 unregister_pernet_subsys(&can_pernet_ops);
898out_pernet:
899 kmem_cache_destroy(rcv_cache);
900
901 return err;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800902}
903
904static __exit void can_exit(void)
905{
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800906 /* protocol unregister */
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200907 dev_remove_pack(&canfd_packet);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800908 dev_remove_pack(&can_packet);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800909 sock_unregister(PF_CAN);
910
Mario Kicherer8e8cda62017-02-21 12:19:47 +0100911 unregister_pernet_subsys(&can_pernet_ops);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800912
Jesper Dangaard Brouer382bfee2009-06-08 03:11:38 +0000913 rcu_barrier(); /* Wait for completion of call_rcu()'s */
914
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800915 kmem_cache_destroy(rcv_cache);
916}
917
918module_init(can_init);
919module_exit(can_exit);