1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 /* gw.c - CAN frame Gateway/Router/Bridge with netlink interface
4 * Copyright (c) 2019 Volkswagen Group Electronic Research
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of Volkswagen nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * Alternatively, provided that this notice is retained in full, this
20 * software may be distributed under the terms of the GNU General
21 * Public License ("GPL") version 2, in which case the provisions of the
22 * GPL apply INSTEAD OF those given above.
24 * The provided data structures and external interfaces from this code
25 * are not restricted to be used by modules with a GPL compatible license.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
42 #include <linux/module.h>
43 #include <linux/init.h>
44 #include <linux/types.h>
45 #include <linux/kernel.h>
46 #include <linux/list.h>
47 #include <linux/spinlock.h>
48 #include <linux/rcupdate.h>
49 #include <linux/rculist.h>
50 #include <linux/net.h>
51 #include <linux/netdevice.h>
52 #include <linux/if_arp.h>
53 #include <linux/skbuff.h>
54 #include <linux/can.h>
55 #include <linux/can/core.h>
56 #include <linux/can/skb.h>
57 #include <linux/can/gw.h>
58 #include <net/rtnetlink.h>
59 #include <net/net_namespace.h>
62 #define CAN_GW_NAME "can-gw"
64 MODULE_DESCRIPTION("PF_CAN netlink gateway");
65 MODULE_LICENSE("Dual BSD/GPL");
67 MODULE_ALIAS(CAN_GW_NAME);
69 #define CGW_MIN_HOPS 1
70 #define CGW_MAX_HOPS 6
71 #define CGW_DEFAULT_HOPS 1
73 static unsigned int max_hops __read_mostly = CGW_DEFAULT_HOPS;
74 module_param(max_hops, uint, 0444);
75 MODULE_PARM_DESC(max_hops,
76 "maximum " CAN_GW_NAME " routing hops for CAN frames "
77 "(valid values: " __stringify(CGW_MIN_HOPS) "-"
78 __stringify(CGW_MAX_HOPS) " hops, "
79 "default: " __stringify(CGW_DEFAULT_HOPS) ")");
81 static struct notifier_block notifier;
82 static struct kmem_cache *cgw_cache __read_mostly;
84 /* structure that contains the (on-the-fly) CAN frame modifications */
87 struct canfd_frame and;
88 struct canfd_frame or;
89 struct canfd_frame xor;
90 struct canfd_frame set;
98 void (*modfunc[MAX_MODFUNCTIONS])(struct canfd_frame *cf,
101 /* CAN frame checksum calculation after CAN frame modifications */
103 struct cgw_csum_xor xor;
104 struct cgw_csum_crc8 crc8;
107 void (*xor)(struct canfd_frame *cf,
108 struct cgw_csum_xor *xor);
109 void (*crc8)(struct canfd_frame *cf,
110 struct cgw_csum_crc8 *crc8);
115 /* So far we just support CAN -> CAN routing and frame modifications.
117 * The internal can_can_gw structure contains data and attributes for
118 * a CAN -> CAN gateway job.
121 struct can_filter filter;
126 /* list entry for CAN gateways jobs */
128 struct hlist_node list;
135 /* CAN frame data source */
136 struct net_device *dev;
139 /* CAN frame data destination */
140 struct net_device *dev;
143 struct can_can_gw ccgw;
151 /* modification functions that are invoked in the hot path in can_can_gw_rcv */
153 #define MODFUNC(func, op) static void func(struct canfd_frame *cf, \
154 struct cf_mod *mod) { op ; }
156 MODFUNC(mod_and_id, cf->can_id &= mod->modframe.and.can_id)
157 MODFUNC(mod_and_len, cf->len &= mod->modframe.and.len)
158 MODFUNC(mod_and_flags, cf->flags &= mod->modframe.and.flags)
159 MODFUNC(mod_and_data, *(u64 *)cf->data &= *(u64 *)mod->modframe.and.data)
160 MODFUNC(mod_or_id, cf->can_id |= mod->modframe.or.can_id)
161 MODFUNC(mod_or_len, cf->len |= mod->modframe.or.len)
162 MODFUNC(mod_or_flags, cf->flags |= mod->modframe.or.flags)
163 MODFUNC(mod_or_data, *(u64 *)cf->data |= *(u64 *)mod->modframe.or.data)
164 MODFUNC(mod_xor_id, cf->can_id ^= mod->modframe.xor.can_id)
165 MODFUNC(mod_xor_len, cf->len ^= mod->modframe.xor.len)
166 MODFUNC(mod_xor_flags, cf->flags ^= mod->modframe.xor.flags)
167 MODFUNC(mod_xor_data, *(u64 *)cf->data ^= *(u64 *)mod->modframe.xor.data)
168 MODFUNC(mod_set_id, cf->can_id = mod->modframe.set.can_id)
169 MODFUNC(mod_set_len, cf->len = mod->modframe.set.len)
170 MODFUNC(mod_set_flags, cf->flags = mod->modframe.set.flags)
171 MODFUNC(mod_set_data, *(u64 *)cf->data = *(u64 *)mod->modframe.set.data)
173 static void mod_and_fddata(struct canfd_frame *cf, struct cf_mod *mod)
177 for (i = 0; i < CANFD_MAX_DLEN; i += 8)
178 *(u64 *)(cf->data + i) &= *(u64 *)(mod->modframe.and.data + i);
181 static void mod_or_fddata(struct canfd_frame *cf, struct cf_mod *mod)
185 for (i = 0; i < CANFD_MAX_DLEN; i += 8)
186 *(u64 *)(cf->data + i) |= *(u64 *)(mod->modframe.or.data + i);
189 static void mod_xor_fddata(struct canfd_frame *cf, struct cf_mod *mod)
193 for (i = 0; i < CANFD_MAX_DLEN; i += 8)
194 *(u64 *)(cf->data + i) ^= *(u64 *)(mod->modframe.xor.data + i);
197 static void mod_set_fddata(struct canfd_frame *cf, struct cf_mod *mod)
199 memcpy(cf->data, mod->modframe.set.data, CANFD_MAX_DLEN);
202 static void canframecpy(struct canfd_frame *dst, struct can_frame *src)
204 /* Copy the struct members separately to ensure that no uninitialized
205 * data are copied in the 3 bytes hole of the struct. This is needed
206 * to make easy compares of the data in the struct cf_mod.
209 dst->can_id = src->can_id;
210 dst->len = src->can_dlc;
211 *(u64 *)dst->data = *(u64 *)src->data;
214 static void canfdframecpy(struct canfd_frame *dst, struct canfd_frame *src)
216 /* Copy the struct members separately to ensure that no uninitialized
217 * data are copied in the 2 bytes hole of the struct. This is needed
218 * to make easy compares of the data in the struct cf_mod.
221 dst->can_id = src->can_id;
222 dst->flags = src->flags;
224 memcpy(dst->data, src->data, CANFD_MAX_DLEN);
227 static int cgw_chk_csum_parms(s8 fr, s8 to, s8 re, struct rtcanmsg *r)
229 s8 dlen = CAN_MAX_DLEN;
231 if (r->flags & CGW_FLAGS_CAN_FD)
232 dlen = CANFD_MAX_DLEN;
234 /* absolute dlc values 0 .. 7 => 0 .. 7, e.g. data [0]
235 * relative to received dlc -1 .. -8 :
236 * e.g. for received dlc = 8
237 * -1 => index = 7 (data[7])
238 * -3 => index = 5 (data[5])
239 * -8 => index = 0 (data[0])
242 if (fr >= -dlen && fr < dlen &&
243 to >= -dlen && to < dlen &&
244 re >= -dlen && re < dlen)
250 static inline int calc_idx(int idx, int rx_len)
258 static void cgw_csum_xor_rel(struct canfd_frame *cf, struct cgw_csum_xor *xor)
260 int from = calc_idx(xor->from_idx, cf->len);
261 int to = calc_idx(xor->to_idx, cf->len);
262 int res = calc_idx(xor->result_idx, cf->len);
263 u8 val = xor->init_xor_val;
266 if (from < 0 || to < 0 || res < 0)
270 for (i = from; i <= to; i++)
273 for (i = from; i >= to; i--)
280 static void cgw_csum_xor_pos(struct canfd_frame *cf, struct cgw_csum_xor *xor)
282 u8 val = xor->init_xor_val;
285 for (i = xor->from_idx; i <= xor->to_idx; i++)
288 cf->data[xor->result_idx] = val;
291 static void cgw_csum_xor_neg(struct canfd_frame *cf, struct cgw_csum_xor *xor)
293 u8 val = xor->init_xor_val;
296 for (i = xor->from_idx; i >= xor->to_idx; i--)
299 cf->data[xor->result_idx] = val;
302 static void cgw_csum_crc8_rel(struct canfd_frame *cf,
303 struct cgw_csum_crc8 *crc8)
305 int from = calc_idx(crc8->from_idx, cf->len);
306 int to = calc_idx(crc8->to_idx, cf->len);
307 int res = calc_idx(crc8->result_idx, cf->len);
308 u8 crc = crc8->init_crc_val;
311 if (from < 0 || to < 0 || res < 0)
315 for (i = crc8->from_idx; i <= crc8->to_idx; i++)
316 crc = crc8->crctab[crc ^ cf->data[i]];
318 for (i = crc8->from_idx; i >= crc8->to_idx; i--)
319 crc = crc8->crctab[crc ^ cf->data[i]];
322 switch (crc8->profile) {
323 case CGW_CRC8PRF_1U8:
324 crc = crc8->crctab[crc ^ crc8->profile_data[0]];
327 case CGW_CRC8PRF_16U8:
328 crc = crc8->crctab[crc ^ crc8->profile_data[cf->data[1] & 0xF]];
331 case CGW_CRC8PRF_SFFID_XOR:
332 crc = crc8->crctab[crc ^ (cf->can_id & 0xFF) ^
333 (cf->can_id >> 8 & 0xFF)];
337 cf->data[crc8->result_idx] = crc ^ crc8->final_xor_val;
340 static void cgw_csum_crc8_pos(struct canfd_frame *cf,
341 struct cgw_csum_crc8 *crc8)
343 u8 crc = crc8->init_crc_val;
346 for (i = crc8->from_idx; i <= crc8->to_idx; i++)
347 crc = crc8->crctab[crc ^ cf->data[i]];
349 switch (crc8->profile) {
350 case CGW_CRC8PRF_1U8:
351 crc = crc8->crctab[crc ^ crc8->profile_data[0]];
354 case CGW_CRC8PRF_16U8:
355 crc = crc8->crctab[crc ^ crc8->profile_data[cf->data[1] & 0xF]];
358 case CGW_CRC8PRF_SFFID_XOR:
359 crc = crc8->crctab[crc ^ (cf->can_id & 0xFF) ^
360 (cf->can_id >> 8 & 0xFF)];
364 cf->data[crc8->result_idx] = crc ^ crc8->final_xor_val;
367 static void cgw_csum_crc8_neg(struct canfd_frame *cf,
368 struct cgw_csum_crc8 *crc8)
370 u8 crc = crc8->init_crc_val;
373 for (i = crc8->from_idx; i >= crc8->to_idx; i--)
374 crc = crc8->crctab[crc ^ cf->data[i]];
376 switch (crc8->profile) {
377 case CGW_CRC8PRF_1U8:
378 crc = crc8->crctab[crc ^ crc8->profile_data[0]];
381 case CGW_CRC8PRF_16U8:
382 crc = crc8->crctab[crc ^ crc8->profile_data[cf->data[1] & 0xF]];
385 case CGW_CRC8PRF_SFFID_XOR:
386 crc = crc8->crctab[crc ^ (cf->can_id & 0xFF) ^
387 (cf->can_id >> 8 & 0xFF)];
391 cf->data[crc8->result_idx] = crc ^ crc8->final_xor_val;
394 /* the receive & process & send function */
395 static void can_can_gw_rcv(struct sk_buff *skb, void *data)
397 struct cgw_job *gwj = (struct cgw_job *)data;
398 struct canfd_frame *cf;
399 struct sk_buff *nskb;
402 /* process strictly Classic CAN or CAN FD frames */
403 if (gwj->flags & CGW_FLAGS_CAN_FD) {
404 if (skb->len != CANFD_MTU)
407 if (skb->len != CAN_MTU)
411 /* Do not handle CAN frames routed more than 'max_hops' times.
412 * In general we should never catch this delimiter which is intended
413 * to cover a misconfiguration protection (e.g. circular CAN routes).
415 * The Controller Area Network controllers only accept CAN frames with
416 * correct CRCs - which are not visible in the controller registers.
417 * According to skbuff.h documentation the csum_start element for IP
418 * checksums is undefined/unused when ip_summed == CHECKSUM_UNNECESSARY.
419 * Only CAN skbs can be processed here which already have this property.
422 #define cgw_hops(skb) ((skb)->csum_start)
424 BUG_ON(skb->ip_summed != CHECKSUM_UNNECESSARY);
426 if (cgw_hops(skb) >= max_hops) {
427 /* indicate deleted frames due to misconfiguration */
428 gwj->deleted_frames++;
432 if (!(gwj->dst.dev->flags & IFF_UP)) {
433 gwj->dropped_frames++;
437 /* is sending the skb back to the incoming interface not allowed? */
438 if (!(gwj->flags & CGW_FLAGS_CAN_IIF_TX_OK) &&
439 can_skb_prv(skb)->ifindex == gwj->dst.dev->ifindex)
442 /* clone the given skb, which has not been done in can_rcv()
444 * When there is at least one modification function activated,
445 * we need to copy the skb as we want to modify skb->data.
447 if (gwj->mod.modfunc[0])
448 nskb = skb_copy(skb, GFP_ATOMIC);
450 nskb = skb_clone(skb, GFP_ATOMIC);
453 gwj->dropped_frames++;
457 /* put the incremented hop counter in the cloned skb */
458 cgw_hops(nskb) = cgw_hops(skb) + 1;
460 /* first processing of this CAN frame -> adjust to private hop limit */
461 if (gwj->limit_hops && cgw_hops(nskb) == 1)
462 cgw_hops(nskb) = max_hops - gwj->limit_hops + 1;
464 nskb->dev = gwj->dst.dev;
466 /* pointer to modifiable CAN frame */
467 cf = (struct canfd_frame *)nskb->data;
469 /* perform preprocessed modification functions if there are any */
470 while (modidx < MAX_MODFUNCTIONS && gwj->mod.modfunc[modidx])
471 (*gwj->mod.modfunc[modidx++])(cf, &gwj->mod);
473 /* Has the CAN frame been modified? */
475 /* get available space for the processed CAN frame type */
476 int max_len = nskb->len - offsetof(struct canfd_frame, data);
478 /* dlc may have changed, make sure it fits to the CAN frame */
479 if (cf->len > max_len) {
480 /* delete frame due to misconfiguration */
481 gwj->deleted_frames++;
486 /* check for checksum updates */
487 if (gwj->mod.csumfunc.crc8)
488 (*gwj->mod.csumfunc.crc8)(cf, &gwj->mod.csum.crc8);
490 if (gwj->mod.csumfunc.xor)
491 (*gwj->mod.csumfunc.xor)(cf, &gwj->mod.csum.xor);
494 /* clear the skb timestamp if not configured the other way */
495 if (!(gwj->flags & CGW_FLAGS_CAN_SRC_TSTAMP))
498 /* send to netdevice */
499 if (can_send(nskb, gwj->flags & CGW_FLAGS_CAN_ECHO))
500 gwj->dropped_frames++;
502 gwj->handled_frames++;
505 static inline int cgw_register_filter(struct net *net, struct cgw_job *gwj)
507 return can_rx_register(net, gwj->src.dev, gwj->ccgw.filter.can_id,
508 gwj->ccgw.filter.can_mask, can_can_gw_rcv,
512 static inline void cgw_unregister_filter(struct net *net, struct cgw_job *gwj)
514 can_rx_unregister(net, gwj->src.dev, gwj->ccgw.filter.can_id,
515 gwj->ccgw.filter.can_mask, can_can_gw_rcv, gwj);
518 static int cgw_notifier(struct notifier_block *nb,
519 unsigned long msg, void *ptr)
521 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
522 struct net *net = dev_net(dev);
524 if (dev->type != ARPHRD_CAN)
527 if (msg == NETDEV_UNREGISTER) {
528 struct cgw_job *gwj = NULL;
529 struct hlist_node *nx;
533 hlist_for_each_entry_safe(gwj, nx, &net->can.cgw_list, list) {
534 if (gwj->src.dev == dev || gwj->dst.dev == dev) {
535 hlist_del(&gwj->list);
536 cgw_unregister_filter(net, gwj);
537 kmem_cache_free(cgw_cache, gwj);
545 static int cgw_put_job(struct sk_buff *skb, struct cgw_job *gwj, int type,
546 u32 pid, u32 seq, int flags)
548 struct rtcanmsg *rtcan;
549 struct nlmsghdr *nlh;
551 nlh = nlmsg_put(skb, pid, seq, type, sizeof(*rtcan), flags);
555 rtcan = nlmsg_data(nlh);
556 rtcan->can_family = AF_CAN;
557 rtcan->gwtype = gwj->gwtype;
558 rtcan->flags = gwj->flags;
560 /* add statistics if available */
562 if (gwj->handled_frames) {
563 if (nla_put_u32(skb, CGW_HANDLED, gwj->handled_frames) < 0)
567 if (gwj->dropped_frames) {
568 if (nla_put_u32(skb, CGW_DROPPED, gwj->dropped_frames) < 0)
572 if (gwj->deleted_frames) {
573 if (nla_put_u32(skb, CGW_DELETED, gwj->deleted_frames) < 0)
577 /* check non default settings of attributes */
579 if (gwj->limit_hops) {
580 if (nla_put_u8(skb, CGW_LIM_HOPS, gwj->limit_hops) < 0)
584 if (gwj->flags & CGW_FLAGS_CAN_FD) {
585 struct cgw_fdframe_mod mb;
587 if (gwj->mod.modtype.and) {
588 memcpy(&mb.cf, &gwj->mod.modframe.and, sizeof(mb.cf));
589 mb.modtype = gwj->mod.modtype.and;
590 if (nla_put(skb, CGW_FDMOD_AND, sizeof(mb), &mb) < 0)
594 if (gwj->mod.modtype.or) {
595 memcpy(&mb.cf, &gwj->mod.modframe.or, sizeof(mb.cf));
596 mb.modtype = gwj->mod.modtype.or;
597 if (nla_put(skb, CGW_FDMOD_OR, sizeof(mb), &mb) < 0)
601 if (gwj->mod.modtype.xor) {
602 memcpy(&mb.cf, &gwj->mod.modframe.xor, sizeof(mb.cf));
603 mb.modtype = gwj->mod.modtype.xor;
604 if (nla_put(skb, CGW_FDMOD_XOR, sizeof(mb), &mb) < 0)
608 if (gwj->mod.modtype.set) {
609 memcpy(&mb.cf, &gwj->mod.modframe.set, sizeof(mb.cf));
610 mb.modtype = gwj->mod.modtype.set;
611 if (nla_put(skb, CGW_FDMOD_SET, sizeof(mb), &mb) < 0)
615 struct cgw_frame_mod mb;
617 if (gwj->mod.modtype.and) {
618 memcpy(&mb.cf, &gwj->mod.modframe.and, sizeof(mb.cf));
619 mb.modtype = gwj->mod.modtype.and;
620 if (nla_put(skb, CGW_MOD_AND, sizeof(mb), &mb) < 0)
624 if (gwj->mod.modtype.or) {
625 memcpy(&mb.cf, &gwj->mod.modframe.or, sizeof(mb.cf));
626 mb.modtype = gwj->mod.modtype.or;
627 if (nla_put(skb, CGW_MOD_OR, sizeof(mb), &mb) < 0)
631 if (gwj->mod.modtype.xor) {
632 memcpy(&mb.cf, &gwj->mod.modframe.xor, sizeof(mb.cf));
633 mb.modtype = gwj->mod.modtype.xor;
634 if (nla_put(skb, CGW_MOD_XOR, sizeof(mb), &mb) < 0)
638 if (gwj->mod.modtype.set) {
639 memcpy(&mb.cf, &gwj->mod.modframe.set, sizeof(mb.cf));
640 mb.modtype = gwj->mod.modtype.set;
641 if (nla_put(skb, CGW_MOD_SET, sizeof(mb), &mb) < 0)
647 if (nla_put_u32(skb, CGW_MOD_UID, gwj->mod.uid) < 0)
651 if (gwj->mod.csumfunc.crc8) {
652 if (nla_put(skb, CGW_CS_CRC8, CGW_CS_CRC8_LEN,
653 &gwj->mod.csum.crc8) < 0)
657 if (gwj->mod.csumfunc.xor) {
658 if (nla_put(skb, CGW_CS_XOR, CGW_CS_XOR_LEN,
659 &gwj->mod.csum.xor) < 0)
663 if (gwj->gwtype == CGW_TYPE_CAN_CAN) {
664 if (gwj->ccgw.filter.can_id || gwj->ccgw.filter.can_mask) {
665 if (nla_put(skb, CGW_FILTER, sizeof(struct can_filter),
666 &gwj->ccgw.filter) < 0)
670 if (nla_put_u32(skb, CGW_SRC_IF, gwj->ccgw.src_idx) < 0)
673 if (nla_put_u32(skb, CGW_DST_IF, gwj->ccgw.dst_idx) < 0)
681 nlmsg_cancel(skb, nlh);
685 /* Dump information about all CAN gateway jobs, in response to RTM_GETROUTE */
686 static int cgw_dump_jobs(struct sk_buff *skb, struct netlink_callback *cb)
688 struct net *net = sock_net(skb->sk);
689 struct cgw_job *gwj = NULL;
691 int s_idx = cb->args[0];
694 hlist_for_each_entry_rcu(gwj, &net->can.cgw_list, list) {
698 if (cgw_put_job(skb, gwj, RTM_NEWROUTE,
699 NETLINK_CB(cb->skb).portid,
700 cb->nlh->nlmsg_seq, NLM_F_MULTI) < 0)
712 static const struct nla_policy cgw_policy[CGW_MAX + 1] = {
713 [CGW_MOD_AND] = { .len = sizeof(struct cgw_frame_mod) },
714 [CGW_MOD_OR] = { .len = sizeof(struct cgw_frame_mod) },
715 [CGW_MOD_XOR] = { .len = sizeof(struct cgw_frame_mod) },
716 [CGW_MOD_SET] = { .len = sizeof(struct cgw_frame_mod) },
717 [CGW_CS_XOR] = { .len = sizeof(struct cgw_csum_xor) },
718 [CGW_CS_CRC8] = { .len = sizeof(struct cgw_csum_crc8) },
719 [CGW_SRC_IF] = { .type = NLA_U32 },
720 [CGW_DST_IF] = { .type = NLA_U32 },
721 [CGW_FILTER] = { .len = sizeof(struct can_filter) },
722 [CGW_LIM_HOPS] = { .type = NLA_U8 },
723 [CGW_MOD_UID] = { .type = NLA_U32 },
724 [CGW_FDMOD_AND] = { .len = sizeof(struct cgw_fdframe_mod) },
725 [CGW_FDMOD_OR] = { .len = sizeof(struct cgw_fdframe_mod) },
726 [CGW_FDMOD_XOR] = { .len = sizeof(struct cgw_fdframe_mod) },
727 [CGW_FDMOD_SET] = { .len = sizeof(struct cgw_fdframe_mod) },
730 /* check for common and gwtype specific attributes */
731 static int cgw_parse_attr(struct nlmsghdr *nlh, struct cf_mod *mod,
732 u8 gwtype, void *gwtypeattr, u8 *limhops)
734 struct nlattr *tb[CGW_MAX + 1];
735 struct rtcanmsg *r = nlmsg_data(nlh);
739 /* initialize modification & checksum data space */
740 memset(mod, 0, sizeof(*mod));
742 err = nlmsg_parse_deprecated(nlh, sizeof(struct rtcanmsg), tb,
743 CGW_MAX, cgw_policy, NULL);
747 if (tb[CGW_LIM_HOPS]) {
748 *limhops = nla_get_u8(tb[CGW_LIM_HOPS]);
750 if (*limhops < 1 || *limhops > max_hops)
754 /* check for AND/OR/XOR/SET modifications */
755 if (r->flags & CGW_FLAGS_CAN_FD) {
756 struct cgw_fdframe_mod mb;
758 if (tb[CGW_FDMOD_AND]) {
759 nla_memcpy(&mb, tb[CGW_FDMOD_AND], CGW_FDMODATTR_LEN);
761 canfdframecpy(&mod->modframe.and, &mb.cf);
762 mod->modtype.and = mb.modtype;
764 if (mb.modtype & CGW_MOD_ID)
765 mod->modfunc[modidx++] = mod_and_id;
767 if (mb.modtype & CGW_MOD_LEN)
768 mod->modfunc[modidx++] = mod_and_len;
770 if (mb.modtype & CGW_MOD_FLAGS)
771 mod->modfunc[modidx++] = mod_and_flags;
773 if (mb.modtype & CGW_MOD_DATA)
774 mod->modfunc[modidx++] = mod_and_fddata;
777 if (tb[CGW_FDMOD_OR]) {
778 nla_memcpy(&mb, tb[CGW_FDMOD_OR], CGW_FDMODATTR_LEN);
780 canfdframecpy(&mod->modframe.or, &mb.cf);
781 mod->modtype.or = mb.modtype;
783 if (mb.modtype & CGW_MOD_ID)
784 mod->modfunc[modidx++] = mod_or_id;
786 if (mb.modtype & CGW_MOD_LEN)
787 mod->modfunc[modidx++] = mod_or_len;
789 if (mb.modtype & CGW_MOD_FLAGS)
790 mod->modfunc[modidx++] = mod_or_flags;
792 if (mb.modtype & CGW_MOD_DATA)
793 mod->modfunc[modidx++] = mod_or_fddata;
796 if (tb[CGW_FDMOD_XOR]) {
797 nla_memcpy(&mb, tb[CGW_FDMOD_XOR], CGW_FDMODATTR_LEN);
799 canfdframecpy(&mod->modframe.xor, &mb.cf);
800 mod->modtype.xor = mb.modtype;
802 if (mb.modtype & CGW_MOD_ID)
803 mod->modfunc[modidx++] = mod_xor_id;
805 if (mb.modtype & CGW_MOD_LEN)
806 mod->modfunc[modidx++] = mod_xor_len;
808 if (mb.modtype & CGW_MOD_FLAGS)
809 mod->modfunc[modidx++] = mod_xor_flags;
811 if (mb.modtype & CGW_MOD_DATA)
812 mod->modfunc[modidx++] = mod_xor_fddata;
815 if (tb[CGW_FDMOD_SET]) {
816 nla_memcpy(&mb, tb[CGW_FDMOD_SET], CGW_FDMODATTR_LEN);
818 canfdframecpy(&mod->modframe.set, &mb.cf);
819 mod->modtype.set = mb.modtype;
821 if (mb.modtype & CGW_MOD_ID)
822 mod->modfunc[modidx++] = mod_set_id;
824 if (mb.modtype & CGW_MOD_LEN)
825 mod->modfunc[modidx++] = mod_set_len;
827 if (mb.modtype & CGW_MOD_FLAGS)
828 mod->modfunc[modidx++] = mod_set_flags;
830 if (mb.modtype & CGW_MOD_DATA)
831 mod->modfunc[modidx++] = mod_set_fddata;
834 struct cgw_frame_mod mb;
836 if (tb[CGW_MOD_AND]) {
837 nla_memcpy(&mb, tb[CGW_MOD_AND], CGW_MODATTR_LEN);
839 canframecpy(&mod->modframe.and, &mb.cf);
840 mod->modtype.and = mb.modtype;
842 if (mb.modtype & CGW_MOD_ID)
843 mod->modfunc[modidx++] = mod_and_id;
845 if (mb.modtype & CGW_MOD_LEN)
846 mod->modfunc[modidx++] = mod_and_len;
848 if (mb.modtype & CGW_MOD_DATA)
849 mod->modfunc[modidx++] = mod_and_data;
852 if (tb[CGW_MOD_OR]) {
853 nla_memcpy(&mb, tb[CGW_MOD_OR], CGW_MODATTR_LEN);
855 canframecpy(&mod->modframe.or, &mb.cf);
856 mod->modtype.or = mb.modtype;
858 if (mb.modtype & CGW_MOD_ID)
859 mod->modfunc[modidx++] = mod_or_id;
861 if (mb.modtype & CGW_MOD_LEN)
862 mod->modfunc[modidx++] = mod_or_len;
864 if (mb.modtype & CGW_MOD_DATA)
865 mod->modfunc[modidx++] = mod_or_data;
868 if (tb[CGW_MOD_XOR]) {
869 nla_memcpy(&mb, tb[CGW_MOD_XOR], CGW_MODATTR_LEN);
871 canframecpy(&mod->modframe.xor, &mb.cf);
872 mod->modtype.xor = mb.modtype;
874 if (mb.modtype & CGW_MOD_ID)
875 mod->modfunc[modidx++] = mod_xor_id;
877 if (mb.modtype & CGW_MOD_LEN)
878 mod->modfunc[modidx++] = mod_xor_len;
880 if (mb.modtype & CGW_MOD_DATA)
881 mod->modfunc[modidx++] = mod_xor_data;
884 if (tb[CGW_MOD_SET]) {
885 nla_memcpy(&mb, tb[CGW_MOD_SET], CGW_MODATTR_LEN);
887 canframecpy(&mod->modframe.set, &mb.cf);
888 mod->modtype.set = mb.modtype;
890 if (mb.modtype & CGW_MOD_ID)
891 mod->modfunc[modidx++] = mod_set_id;
893 if (mb.modtype & CGW_MOD_LEN)
894 mod->modfunc[modidx++] = mod_set_len;
896 if (mb.modtype & CGW_MOD_DATA)
897 mod->modfunc[modidx++] = mod_set_data;
901 /* check for checksum operations after CAN frame modifications */
903 if (tb[CGW_CS_CRC8]) {
904 struct cgw_csum_crc8 *c = nla_data(tb[CGW_CS_CRC8]);
906 err = cgw_chk_csum_parms(c->from_idx, c->to_idx,
911 nla_memcpy(&mod->csum.crc8, tb[CGW_CS_CRC8],
914 /* select dedicated processing function to reduce
915 * runtime operations in receive hot path.
917 if (c->from_idx < 0 || c->to_idx < 0 ||
919 mod->csumfunc.crc8 = cgw_csum_crc8_rel;
920 else if (c->from_idx <= c->to_idx)
921 mod->csumfunc.crc8 = cgw_csum_crc8_pos;
923 mod->csumfunc.crc8 = cgw_csum_crc8_neg;
926 if (tb[CGW_CS_XOR]) {
927 struct cgw_csum_xor *c = nla_data(tb[CGW_CS_XOR]);
929 err = cgw_chk_csum_parms(c->from_idx, c->to_idx,
934 nla_memcpy(&mod->csum.xor, tb[CGW_CS_XOR],
937 /* select dedicated processing function to reduce
938 * runtime operations in receive hot path.
940 if (c->from_idx < 0 || c->to_idx < 0 ||
942 mod->csumfunc.xor = cgw_csum_xor_rel;
943 else if (c->from_idx <= c->to_idx)
944 mod->csumfunc.xor = cgw_csum_xor_pos;
946 mod->csumfunc.xor = cgw_csum_xor_neg;
950 nla_memcpy(&mod->uid, tb[CGW_MOD_UID], sizeof(u32));
953 if (gwtype == CGW_TYPE_CAN_CAN) {
954 /* check CGW_TYPE_CAN_CAN specific attributes */
955 struct can_can_gw *ccgw = (struct can_can_gw *)gwtypeattr;
957 memset(ccgw, 0, sizeof(*ccgw));
959 /* check for can_filter in attributes */
961 nla_memcpy(&ccgw->filter, tb[CGW_FILTER],
962 sizeof(struct can_filter));
966 /* specifying two interfaces is mandatory */
967 if (!tb[CGW_SRC_IF] || !tb[CGW_DST_IF])
970 ccgw->src_idx = nla_get_u32(tb[CGW_SRC_IF]);
971 ccgw->dst_idx = nla_get_u32(tb[CGW_DST_IF]);
973 /* both indices set to 0 for flushing all routing entries */
974 if (!ccgw->src_idx && !ccgw->dst_idx)
977 /* only one index set to 0 is an error */
978 if (!ccgw->src_idx || !ccgw->dst_idx)
982 /* add the checks for other gwtypes here */
987 static int cgw_create_job(struct sk_buff *skb, struct nlmsghdr *nlh,
988 struct netlink_ext_ack *extack)
990 struct net *net = sock_net(skb->sk);
994 struct can_can_gw ccgw;
998 if (!netlink_capable(skb, CAP_NET_ADMIN))
1001 if (nlmsg_len(nlh) < sizeof(*r))
1004 r = nlmsg_data(nlh);
1005 if (r->can_family != AF_CAN)
1006 return -EPFNOSUPPORT;
1008 /* so far we only support CAN -> CAN routings */
1009 if (r->gwtype != CGW_TYPE_CAN_CAN)
1012 err = cgw_parse_attr(nlh, &mod, CGW_TYPE_CAN_CAN, &ccgw, &limhops);
1019 /* check for updating an existing job with identical uid */
1020 hlist_for_each_entry(gwj, &net->can.cgw_list, list) {
1021 if (gwj->mod.uid != mod.uid)
1024 /* interfaces & filters must be identical */
1025 if (memcmp(&gwj->ccgw, &ccgw, sizeof(ccgw)))
1028 /* update modifications with disabled softirq & quit */
1030 memcpy(&gwj->mod, &mod, sizeof(mod));
1036 /* ifindex == 0 is not allowed for job creation */
1037 if (!ccgw.src_idx || !ccgw.dst_idx)
1040 gwj = kmem_cache_alloc(cgw_cache, GFP_KERNEL);
1044 gwj->handled_frames = 0;
1045 gwj->dropped_frames = 0;
1046 gwj->deleted_frames = 0;
1047 gwj->flags = r->flags;
1048 gwj->gwtype = r->gwtype;
1049 gwj->limit_hops = limhops;
1051 /* insert already parsed information */
1052 memcpy(&gwj->mod, &mod, sizeof(mod));
1053 memcpy(&gwj->ccgw, &ccgw, sizeof(ccgw));
1057 gwj->src.dev = __dev_get_by_index(net, gwj->ccgw.src_idx);
1062 if (gwj->src.dev->type != ARPHRD_CAN)
1065 gwj->dst.dev = __dev_get_by_index(net, gwj->ccgw.dst_idx);
1070 if (gwj->dst.dev->type != ARPHRD_CAN)
1075 err = cgw_register_filter(net, gwj);
1077 hlist_add_head_rcu(&gwj->list, &net->can.cgw_list);
1080 kmem_cache_free(cgw_cache, gwj);
1085 static void cgw_remove_all_jobs(struct net *net)
1087 struct cgw_job *gwj = NULL;
1088 struct hlist_node *nx;
1092 hlist_for_each_entry_safe(gwj, nx, &net->can.cgw_list, list) {
1093 hlist_del(&gwj->list);
1094 cgw_unregister_filter(net, gwj);
1095 kmem_cache_free(cgw_cache, gwj);
1099 static int cgw_remove_job(struct sk_buff *skb, struct nlmsghdr *nlh,
1100 struct netlink_ext_ack *extack)
1102 struct net *net = sock_net(skb->sk);
1103 struct cgw_job *gwj = NULL;
1104 struct hlist_node *nx;
1107 struct can_can_gw ccgw;
1111 if (!netlink_capable(skb, CAP_NET_ADMIN))
1114 if (nlmsg_len(nlh) < sizeof(*r))
1117 r = nlmsg_data(nlh);
1118 if (r->can_family != AF_CAN)
1119 return -EPFNOSUPPORT;
1121 /* so far we only support CAN -> CAN routings */
1122 if (r->gwtype != CGW_TYPE_CAN_CAN)
1125 err = cgw_parse_attr(nlh, &mod, CGW_TYPE_CAN_CAN, &ccgw, &limhops);
1129 /* two interface indices both set to 0 => remove all entries */
1130 if (!ccgw.src_idx && !ccgw.dst_idx) {
1131 cgw_remove_all_jobs(net);
1139 /* remove only the first matching entry */
1140 hlist_for_each_entry_safe(gwj, nx, &net->can.cgw_list, list) {
1141 if (gwj->flags != r->flags)
1144 if (gwj->limit_hops != limhops)
1147 /* we have a match when uid is enabled and identical */
1148 if (gwj->mod.uid || mod.uid) {
1149 if (gwj->mod.uid != mod.uid)
1152 /* no uid => check for identical modifications */
1153 if (memcmp(&gwj->mod, &mod, sizeof(mod)))
1157 /* if (r->gwtype == CGW_TYPE_CAN_CAN) - is made sure here */
1158 if (memcmp(&gwj->ccgw, &ccgw, sizeof(ccgw)))
1161 hlist_del(&gwj->list);
1162 cgw_unregister_filter(net, gwj);
1163 kmem_cache_free(cgw_cache, gwj);
1171 static int __net_init cangw_pernet_init(struct net *net)
1173 INIT_HLIST_HEAD(&net->can.cgw_list);
1177 static void __net_exit cangw_pernet_exit(struct net *net)
1180 cgw_remove_all_jobs(net);
1184 static struct pernet_operations cangw_pernet_ops = {
1185 .init = cangw_pernet_init,
1186 .exit = cangw_pernet_exit,
1189 static __init int cgw_module_init(void)
1193 /* sanitize given module parameter */
1194 max_hops = clamp_t(unsigned int, max_hops, CGW_MIN_HOPS, CGW_MAX_HOPS);
1196 pr_info("can: netlink gateway - max_hops=%d\n", max_hops);
1198 ret = register_pernet_subsys(&cangw_pernet_ops);
1203 cgw_cache = kmem_cache_create("can_gw", sizeof(struct cgw_job),
1206 goto out_cache_create;
1209 notifier.notifier_call = cgw_notifier;
1210 ret = register_netdevice_notifier(¬ifier);
1212 goto out_register_notifier;
1214 ret = rtnl_register_module(THIS_MODULE, PF_CAN, RTM_GETROUTE,
1215 NULL, cgw_dump_jobs, 0);
1217 goto out_rtnl_register1;
1219 ret = rtnl_register_module(THIS_MODULE, PF_CAN, RTM_NEWROUTE,
1220 cgw_create_job, NULL, 0);
1222 goto out_rtnl_register2;
1223 ret = rtnl_register_module(THIS_MODULE, PF_CAN, RTM_DELROUTE,
1224 cgw_remove_job, NULL, 0);
1226 goto out_rtnl_register3;
1231 rtnl_unregister(PF_CAN, RTM_NEWROUTE);
1233 rtnl_unregister(PF_CAN, RTM_GETROUTE);
1235 unregister_netdevice_notifier(¬ifier);
1236 out_register_notifier:
1237 kmem_cache_destroy(cgw_cache);
1239 unregister_pernet_subsys(&cangw_pernet_ops);
1244 static __exit void cgw_module_exit(void)
1246 rtnl_unregister_all(PF_CAN);
1248 unregister_netdevice_notifier(¬ifier);
1250 unregister_pernet_subsys(&cangw_pernet_ops);
1251 rcu_barrier(); /* Wait for completion of call_rcu()'s */
1253 kmem_cache_destroy(cgw_cache);
1256 module_init(cgw_module_init);
1257 module_exit(cgw_module_exit);