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