net/can/gw.c

   1 // SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
   2 /* gw.c - CAN frame Gateway/Router/Bridge with netlink interface
   3  *
   4  * Copyright (c) 2017 Volkswagen Group Electronic Research
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  18  *
  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.
  23  *
  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.
  26  *
  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
  38  * DAMAGE.
  39  *
  40  */
  41
  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>
  60 #include <net/sock.h>
  61
  62 #define CAN_GW_VERSION "20170425"
  63 #define CAN_GW_NAME "can-gw"
  64
  65 MODULE_DESCRIPTION("PF_CAN netlink gateway");
  66 MODULE_LICENSE("Dual BSD/GPL");
  67 MODULE_AUTHOR("Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
  68 MODULE_ALIAS(CAN_GW_NAME);
  69
  70 #define CGW_MIN_HOPS 1
  71 #define CGW_MAX_HOPS 6
  72 #define CGW_DEFAULT_HOPS 1
  73
  74 static unsigned int max_hops __read_mostly = CGW_DEFAULT_HOPS;
  75 module_param(max_hops, uint, 0444);
  76 MODULE_PARM_DESC(max_hops,
  77                  "maximum " CAN_GW_NAME " routing hops for CAN frames "
  78                  "(valid values: " __stringify(CGW_MIN_HOPS) "-"
  79                  __stringify(CGW_MAX_HOPS) " hops, "
  80                  "default: " __stringify(CGW_DEFAULT_HOPS) ")");
  81
  82 static struct notifier_block notifier;
  83 static struct kmem_cache *cgw_cache __read_mostly;
  84
  85 /* structure that contains the (on-the-fly) CAN frame modifications */
  86 struct cf_mod {
  87         struct {
  88                 struct can_frame and;
  89                 struct can_frame or;
  90                 struct can_frame xor;
  91                 struct can_frame set;
  92         } modframe;
  93         struct {
  94                 u8 and;
  95                 u8 or;
  96                 u8 xor;
  97                 u8 set;
  98         } modtype;
  99         void (*modfunc[MAX_MODFUNCTIONS])(struct can_frame *cf,
 100                                           struct cf_mod *mod);
 101
 102         /* CAN frame checksum calculation after CAN frame modifications */
 103         struct {
 104                 struct cgw_csum_xor xor;
 105                 struct cgw_csum_crc8 crc8;
 106         } csum;
 107         struct {
 108                 void (*xor)(struct can_frame *cf, struct cgw_csum_xor *xor);
 109                 void (*crc8)(struct can_frame *cf, struct cgw_csum_crc8 *crc8);
 110         } csumfunc;
 111         u32 uid;
 112 };
 113
 114 /* So far we just support CAN -> CAN routing and frame modifications.
 115  *
 116  * The internal can_can_gw structure contains data and attributes for
 117  * a CAN -> CAN gateway job.
 118  */
 119 struct can_can_gw {
 120         struct can_filter filter;
 121         int src_idx;
 122         int dst_idx;
 123 };
 124
 125 /* list entry for CAN gateways jobs */
 126 struct cgw_job {
 127         struct hlist_node list;
 128         struct rcu_head rcu;
 129         u32 handled_frames;
 130         u32 dropped_frames;
 131         u32 deleted_frames;
 132         struct cf_mod mod;
 133         union {
 134                 /* CAN frame data source */
 135                 struct net_device *dev;
 136         } src;
 137         union {
 138                 /* CAN frame data destination */
 139                 struct net_device *dev;
 140         } dst;
 141         union {
 142                 struct can_can_gw ccgw;
 143                 /* tbc */
 144         };
 145         u8 gwtype;
 146         u8 limit_hops;
 147         u16 flags;
 148 };
 149
 150 /* modification functions that are invoked in the hot path in can_can_gw_rcv */
 151
 152 #define MODFUNC(func, op) static void func(struct can_frame *cf, \
 153                                            struct cf_mod *mod) { op ; }
 154
 155 MODFUNC(mod_and_id, cf->can_id &= mod->modframe.and.can_id)
 156 MODFUNC(mod_and_dlc, cf->can_dlc &= mod->modframe.and.can_dlc)
 157 MODFUNC(mod_and_data, *(u64 *)cf->data &= *(u64 *)mod->modframe.and.data)
 158 MODFUNC(mod_or_id, cf->can_id |= mod->modframe.or.can_id)
 159 MODFUNC(mod_or_dlc, cf->can_dlc |= mod->modframe.or.can_dlc)
 160 MODFUNC(mod_or_data, *(u64 *)cf->data |= *(u64 *)mod->modframe.or.data)
 161 MODFUNC(mod_xor_id, cf->can_id ^= mod->modframe.xor.can_id)
 162 MODFUNC(mod_xor_dlc, cf->can_dlc ^= mod->modframe.xor.can_dlc)
 163 MODFUNC(mod_xor_data, *(u64 *)cf->data ^= *(u64 *)mod->modframe.xor.data)
 164 MODFUNC(mod_set_id, cf->can_id = mod->modframe.set.can_id)
 165 MODFUNC(mod_set_dlc, cf->can_dlc = mod->modframe.set.can_dlc)
 166 MODFUNC(mod_set_data, *(u64 *)cf->data = *(u64 *)mod->modframe.set.data)
 167
 168 static inline void canframecpy(struct can_frame *dst, struct can_frame *src)
 169 {
 170         /* Copy the struct members separately to ensure that no uninitialized
 171          * data are copied in the 3 bytes hole of the struct. This is needed
 172          * to make easy compares of the data in the struct cf_mod.
 173          */
 174
 175         dst->can_id = src->can_id;
 176         dst->can_dlc = src->can_dlc;
 177         *(u64 *)dst->data = *(u64 *)src->data;
 178 }
 179
 180 static int cgw_chk_csum_parms(s8 fr, s8 to, s8 re)
 181 {
 182         /* absolute dlc values 0 .. 7 => 0 .. 7, e.g. data [0]
 183          * relative to received dlc -1 .. -8 :
 184          * e.g. for received dlc = 8
 185          * -1 => index = 7 (data[7])
 186          * -3 => index = 5 (data[5])
 187          * -8 => index = 0 (data[0])
 188          */
 189
 190         if (fr > -9 && fr < 8 &&
 191             to > -9 && to < 8 &&
 192             re > -9 && re < 8)
 193                 return 0;
 194         else
 195                 return -EINVAL;
 196 }
 197
 198 static inline int calc_idx(int idx, int rx_dlc)
 199 {
 200         if (idx < 0)
 201                 return rx_dlc + idx;
 202         else
 203                 return idx;
 204 }
 205
 206 static void cgw_csum_xor_rel(struct can_frame *cf, struct cgw_csum_xor *xor)
 207 {
 208         int from = calc_idx(xor->from_idx, cf->can_dlc);
 209         int to = calc_idx(xor->to_idx, cf->can_dlc);
 210         int res = calc_idx(xor->result_idx, cf->can_dlc);
 211         u8 val = xor->init_xor_val;
 212         int i;
 213
 214         if (from < 0 || to < 0 || res < 0)
 215                 return;
 216
 217         if (from <= to) {
 218                 for (i = from; i <= to; i++)
 219                         val ^= cf->data[i];
 220         } else {
 221                 for (i = from; i >= to; i--)
 222                         val ^= cf->data[i];
 223         }
 224
 225         cf->data[res] = val;
 226 }
 227
 228 static void cgw_csum_xor_pos(struct can_frame *cf, struct cgw_csum_xor *xor)
 229 {
 230         u8 val = xor->init_xor_val;
 231         int i;
 232
 233         for (i = xor->from_idx; i <= xor->to_idx; i++)
 234                 val ^= cf->data[i];
 235
 236         cf->data[xor->result_idx] = val;
 237 }
 238
 239 static void cgw_csum_xor_neg(struct can_frame *cf, struct cgw_csum_xor *xor)
 240 {
 241         u8 val = xor->init_xor_val;
 242         int i;
 243
 244         for (i = xor->from_idx; i >= xor->to_idx; i--)
 245                 val ^= cf->data[i];
 246
 247         cf->data[xor->result_idx] = val;
 248 }
 249
 250 static void cgw_csum_crc8_rel(struct can_frame *cf, struct cgw_csum_crc8 *crc8)
 251 {
 252         int from = calc_idx(crc8->from_idx, cf->can_dlc);
 253         int to = calc_idx(crc8->to_idx, cf->can_dlc);
 254         int res = calc_idx(crc8->result_idx, cf->can_dlc);
 255         u8 crc = crc8->init_crc_val;
 256         int i;
 257
 258         if (from < 0 || to < 0 || res < 0)
 259                 return;
 260
 261         if (from <= to) {
 262                 for (i = crc8->from_idx; i <= crc8->to_idx; i++)
 263                         crc = crc8->crctab[crc ^ cf->data[i]];
 264         } else {
 265                 for (i = crc8->from_idx; i >= crc8->to_idx; i--)
 266                         crc = crc8->crctab[crc ^ cf->data[i]];
 267         }
 268
 269         switch (crc8->profile) {
 270         case CGW_CRC8PRF_1U8:
 271                 crc = crc8->crctab[crc ^ crc8->profile_data[0]];
 272                 break;
 273
 274         case  CGW_CRC8PRF_16U8:
 275                 crc = crc8->crctab[crc ^ crc8->profile_data[cf->data[1] & 0xF]];
 276                 break;
 277
 278         case CGW_CRC8PRF_SFFID_XOR:
 279                 crc = crc8->crctab[crc ^ (cf->can_id & 0xFF) ^
 280                                    (cf->can_id >> 8 & 0xFF)];
 281                 break;
 282         }
 283
 284         cf->data[crc8->result_idx] = crc ^ crc8->final_xor_val;
 285 }
 286
 287 static void cgw_csum_crc8_pos(struct can_frame *cf, struct cgw_csum_crc8 *crc8)
 288 {
 289         u8 crc = crc8->init_crc_val;
 290         int i;
 291
 292         for (i = crc8->from_idx; i <= crc8->to_idx; i++)
 293                 crc = crc8->crctab[crc ^ cf->data[i]];
 294
 295         switch (crc8->profile) {
 296         case CGW_CRC8PRF_1U8:
 297                 crc = crc8->crctab[crc ^ crc8->profile_data[0]];
 298                 break;
 299
 300         case  CGW_CRC8PRF_16U8:
 301                 crc = crc8->crctab[crc ^ crc8->profile_data[cf->data[1] & 0xF]];
 302                 break;
 303
 304         case CGW_CRC8PRF_SFFID_XOR:
 305                 crc = crc8->crctab[crc ^ (cf->can_id & 0xFF) ^
 306                                    (cf->can_id >> 8 & 0xFF)];
 307                 break;
 308         }
 309
 310         cf->data[crc8->result_idx] = crc ^ crc8->final_xor_val;
 311 }
 312
 313 static void cgw_csum_crc8_neg(struct can_frame *cf, struct cgw_csum_crc8 *crc8)
 314 {
 315         u8 crc = crc8->init_crc_val;
 316         int i;
 317
 318         for (i = crc8->from_idx; i >= crc8->to_idx; i--)
 319                 crc = crc8->crctab[crc ^ cf->data[i]];
 320
 321         switch (crc8->profile) {
 322         case CGW_CRC8PRF_1U8:
 323                 crc = crc8->crctab[crc ^ crc8->profile_data[0]];
 324                 break;
 325
 326         case  CGW_CRC8PRF_16U8:
 327                 crc = crc8->crctab[crc ^ crc8->profile_data[cf->data[1] & 0xF]];
 328                 break;
 329
 330         case CGW_CRC8PRF_SFFID_XOR:
 331                 crc = crc8->crctab[crc ^ (cf->can_id & 0xFF) ^
 332                                    (cf->can_id >> 8 & 0xFF)];
 333                 break;
 334         }
 335
 336         cf->data[crc8->result_idx] = crc ^ crc8->final_xor_val;
 337 }
 338
 339 /* the receive & process & send function */
 340 static void can_can_gw_rcv(struct sk_buff *skb, void *data)
 341 {
 342         struct cgw_job *gwj = (struct cgw_job *)data;
 343         struct can_frame *cf;
 344         struct sk_buff *nskb;
 345         int modidx = 0;
 346
 347         /* Do not handle CAN frames routed more than 'max_hops' times.
 348          * In general we should never catch this delimiter which is intended
 349          * to cover a misconfiguration protection (e.g. circular CAN routes).
 350          *
 351          * The Controller Area Network controllers only accept CAN frames with
 352          * correct CRCs - which are not visible in the controller registers.
 353          * According to skbuff.h documentation the csum_start element for IP
 354          * checksums is undefined/unused when ip_summed == CHECKSUM_UNNECESSARY.
 355          * Only CAN skbs can be processed here which already have this property.
 356          */
 357
 358 #define cgw_hops(skb) ((skb)->csum_start)
 359
 360         BUG_ON(skb->ip_summed != CHECKSUM_UNNECESSARY);
 361
 362         if (cgw_hops(skb) >= max_hops) {
 363                 /* indicate deleted frames due to misconfiguration */
 364                 gwj->deleted_frames++;
 365                 return;
 366         }
 367
 368         if (!(gwj->dst.dev->flags & IFF_UP)) {
 369                 gwj->dropped_frames++;
 370                 return;
 371         }
 372
 373         /* is sending the skb back to the incoming interface not allowed? */
 374         if (!(gwj->flags & CGW_FLAGS_CAN_IIF_TX_OK) &&
 375             can_skb_prv(skb)->ifindex == gwj->dst.dev->ifindex)
 376                 return;
 377
 378         /* clone the given skb, which has not been done in can_rcv()
 379          *
 380          * When there is at least one modification function activated,
 381          * we need to copy the skb as we want to modify skb->data.
 382          */
 383         if (gwj->mod.modfunc[0])
 384                 nskb = skb_copy(skb, GFP_ATOMIC);
 385         else
 386                 nskb = skb_clone(skb, GFP_ATOMIC);
 387
 388         if (!nskb) {
 389                 gwj->dropped_frames++;
 390                 return;
 391         }
 392
 393         /* put the incremented hop counter in the cloned skb */
 394         cgw_hops(nskb) = cgw_hops(skb) + 1;
 395
 396         /* first processing of this CAN frame -> adjust to private hop limit */
 397         if (gwj->limit_hops && cgw_hops(nskb) == 1)
 398                 cgw_hops(nskb) = max_hops - gwj->limit_hops + 1;
 399
 400         nskb->dev = gwj->dst.dev;
 401
 402         /* pointer to modifiable CAN frame */
 403         cf = (struct can_frame *)nskb->data;
 404
 405         /* perform preprocessed modification functions if there are any */
 406         while (modidx < MAX_MODFUNCTIONS && gwj->mod.modfunc[modidx])
 407                 (*gwj->mod.modfunc[modidx++])(cf, &gwj->mod);
 408
 409         /* Has the CAN frame been modified? */
 410         if (modidx) {
 411                 /* get available space for the processed CAN frame type */
 412                 int max_len = nskb->len - offsetof(struct can_frame, data);
 413
 414                 /* dlc may have changed, make sure it fits to the CAN frame */
 415                 if (cf->can_dlc > max_len)
 416                         goto out_delete;
 417
 418                 /* check for checksum updates in classic CAN length only */
 419                 if (gwj->mod.csumfunc.crc8) {
 420                         if (cf->can_dlc > 8)
 421                                 goto out_delete;
 422
 423                         (*gwj->mod.csumfunc.crc8)(cf, &gwj->mod.csum.crc8);
 424                 }
 425
 426                 if (gwj->mod.csumfunc.xor) {
 427                         if (cf->can_dlc > 8)
 428                                 goto out_delete;
 429
 430                         (*gwj->mod.csumfunc.xor)(cf, &gwj->mod.csum.xor);
 431                 }
 432         }
 433
 434         /* clear the skb timestamp if not configured the other way */
 435         if (!(gwj->flags & CGW_FLAGS_CAN_SRC_TSTAMP))
 436                 nskb->tstamp = 0;
 437
 438         /* send to netdevice */
 439         if (can_send(nskb, gwj->flags & CGW_FLAGS_CAN_ECHO))
 440                 gwj->dropped_frames++;
 441         else
 442                 gwj->handled_frames++;
 443
 444         return;
 445
 446  out_delete:
 447         /* delete frame due to misconfiguration */
 448         gwj->deleted_frames++;
 449         kfree_skb(nskb);
 450 }
 451
 452 static inline int cgw_register_filter(struct net *net, struct cgw_job *gwj)
 453 {
 454         return can_rx_register(net, gwj->src.dev, gwj->ccgw.filter.can_id,
 455                                gwj->ccgw.filter.can_mask, can_can_gw_rcv,
 456                                gwj, "gw", NULL);
 457 }
 458
 459 static inline void cgw_unregister_filter(struct net *net, struct cgw_job *gwj)
 460 {
 461         can_rx_unregister(net, gwj->src.dev, gwj->ccgw.filter.can_id,
 462                           gwj->ccgw.filter.can_mask, can_can_gw_rcv, gwj);
 463 }
 464
 465 static int cgw_notifier(struct notifier_block *nb,
 466                         unsigned long msg, void *ptr)
 467 {
 468         struct net_device *dev = netdev_notifier_info_to_dev(ptr);
 469         struct net *net = dev_net(dev);
 470
 471         if (dev->type != ARPHRD_CAN)
 472                 return NOTIFY_DONE;
 473
 474         if (msg == NETDEV_UNREGISTER) {
 475                 struct cgw_job *gwj = NULL;
 476                 struct hlist_node *nx;
 477
 478                 ASSERT_RTNL();
 479
 480                 hlist_for_each_entry_safe(gwj, nx, &net->can.cgw_list, list) {
 481                         if (gwj->src.dev == dev || gwj->dst.dev == dev) {
 482                                 hlist_del(&gwj->list);
 483                                 cgw_unregister_filter(net, gwj);
 484                                 kmem_cache_free(cgw_cache, gwj);
 485                         }
 486                 }
 487         }
 488
 489         return NOTIFY_DONE;
 490 }
 491
 492 static int cgw_put_job(struct sk_buff *skb, struct cgw_job *gwj, int type,
 493                        u32 pid, u32 seq, int flags)
 494 {
 495         struct cgw_frame_mod mb;
 496         struct rtcanmsg *rtcan;
 497         struct nlmsghdr *nlh;
 498
 499         nlh = nlmsg_put(skb, pid, seq, type, sizeof(*rtcan), flags);
 500         if (!nlh)
 501                 return -EMSGSIZE;
 502
 503         rtcan = nlmsg_data(nlh);
 504         rtcan->can_family = AF_CAN;
 505         rtcan->gwtype = gwj->gwtype;
 506         rtcan->flags = gwj->flags;
 507
 508         /* add statistics if available */
 509
 510         if (gwj->handled_frames) {
 511                 if (nla_put_u32(skb, CGW_HANDLED, gwj->handled_frames) < 0)
 512                         goto cancel;
 513         }
 514
 515         if (gwj->dropped_frames) {
 516                 if (nla_put_u32(skb, CGW_DROPPED, gwj->dropped_frames) < 0)
 517                         goto cancel;
 518         }
 519
 520         if (gwj->deleted_frames) {
 521                 if (nla_put_u32(skb, CGW_DELETED, gwj->deleted_frames) < 0)
 522                         goto cancel;
 523         }
 524
 525         /* check non default settings of attributes */
 526
 527         if (gwj->limit_hops) {
 528                 if (nla_put_u8(skb, CGW_LIM_HOPS, gwj->limit_hops) < 0)
 529                         goto cancel;
 530         }
 531
 532         if (gwj->mod.modtype.and) {
 533                 memcpy(&mb.cf, &gwj->mod.modframe.and, sizeof(mb.cf));
 534                 mb.modtype = gwj->mod.modtype.and;
 535                 if (nla_put(skb, CGW_MOD_AND, sizeof(mb), &mb) < 0)
 536                         goto cancel;
 537         }
 538
 539         if (gwj->mod.modtype.or) {
 540                 memcpy(&mb.cf, &gwj->mod.modframe.or, sizeof(mb.cf));
 541                 mb.modtype = gwj->mod.modtype.or;
 542                 if (nla_put(skb, CGW_MOD_OR, sizeof(mb), &mb) < 0)
 543                         goto cancel;
 544         }
 545
 546         if (gwj->mod.modtype.xor) {
 547                 memcpy(&mb.cf, &gwj->mod.modframe.xor, sizeof(mb.cf));
 548                 mb.modtype = gwj->mod.modtype.xor;
 549                 if (nla_put(skb, CGW_MOD_XOR, sizeof(mb), &mb) < 0)
 550                         goto cancel;
 551         }
 552
 553         if (gwj->mod.modtype.set) {
 554                 memcpy(&mb.cf, &gwj->mod.modframe.set, sizeof(mb.cf));
 555                 mb.modtype = gwj->mod.modtype.set;
 556                 if (nla_put(skb, CGW_MOD_SET, sizeof(mb), &mb) < 0)
 557                         goto cancel;
 558         }
 559
 560         if (gwj->mod.uid) {
 561                 if (nla_put_u32(skb, CGW_MOD_UID, gwj->mod.uid) < 0)
 562                         goto cancel;
 563         }
 564
 565         if (gwj->mod.csumfunc.crc8) {
 566                 if (nla_put(skb, CGW_CS_CRC8, CGW_CS_CRC8_LEN,
 567                             &gwj->mod.csum.crc8) < 0)
 568                         goto cancel;
 569         }
 570
 571         if (gwj->mod.csumfunc.xor) {
 572                 if (nla_put(skb, CGW_CS_XOR, CGW_CS_XOR_LEN,
 573                             &gwj->mod.csum.xor) < 0)
 574                         goto cancel;
 575         }
 576
 577         if (gwj->gwtype == CGW_TYPE_CAN_CAN) {
 578                 if (gwj->ccgw.filter.can_id || gwj->ccgw.filter.can_mask) {
 579                         if (nla_put(skb, CGW_FILTER, sizeof(struct can_filter),
 580                                     &gwj->ccgw.filter) < 0)
 581                                 goto cancel;
 582                 }
 583
 584                 if (nla_put_u32(skb, CGW_SRC_IF, gwj->ccgw.src_idx) < 0)
 585                         goto cancel;
 586
 587                 if (nla_put_u32(skb, CGW_DST_IF, gwj->ccgw.dst_idx) < 0)
 588                         goto cancel;
 589         }
 590
 591         nlmsg_end(skb, nlh);
 592         return 0;
 593
 594 cancel:
 595         nlmsg_cancel(skb, nlh);
 596         return -EMSGSIZE;
 597 }
 598
 599 /* Dump information about all CAN gateway jobs, in response to RTM_GETROUTE */
 600 static int cgw_dump_jobs(struct sk_buff *skb, struct netlink_callback *cb)
 601 {
 602         struct net *net = sock_net(skb->sk);
 603         struct cgw_job *gwj = NULL;
 604         int idx = 0;
 605         int s_idx = cb->args[0];
 606
 607         rcu_read_lock();
 608         hlist_for_each_entry_rcu(gwj, &net->can.cgw_list, list) {
 609                 if (idx < s_idx)
 610                         goto cont;
 611
 612                 if (cgw_put_job(skb, gwj, RTM_NEWROUTE,
 613                                 NETLINK_CB(cb->skb).portid,
 614                                 cb->nlh->nlmsg_seq, NLM_F_MULTI) < 0)
 615                         break;
 616 cont:
 617                 idx++;
 618         }
 619         rcu_read_unlock();
 620
 621         cb->args[0] = idx;
 622
 623         return skb->len;
 624 }
 625
 626 static const struct nla_policy cgw_policy[CGW_MAX + 1] = {
 627         [CGW_MOD_AND]   = { .len = sizeof(struct cgw_frame_mod) },
 628         [CGW_MOD_OR]    = { .len = sizeof(struct cgw_frame_mod) },
 629         [CGW_MOD_XOR]   = { .len = sizeof(struct cgw_frame_mod) },
 630         [CGW_MOD_SET]   = { .len = sizeof(struct cgw_frame_mod) },
 631         [CGW_CS_XOR]    = { .len = sizeof(struct cgw_csum_xor) },
 632         [CGW_CS_CRC8]   = { .len = sizeof(struct cgw_csum_crc8) },
 633         [CGW_SRC_IF]    = { .type = NLA_U32 },
 634         [CGW_DST_IF]    = { .type = NLA_U32 },
 635         [CGW_FILTER]    = { .len = sizeof(struct can_filter) },
 636         [CGW_LIM_HOPS]  = { .type = NLA_U8 },
 637         [CGW_MOD_UID]   = { .type = NLA_U32 },
 638 };
 639
 640 /* check for common and gwtype specific attributes */
 641 static int cgw_parse_attr(struct nlmsghdr *nlh, struct cf_mod *mod,
 642                           u8 gwtype, void *gwtypeattr, u8 *limhops)
 643 {
 644         struct nlattr *tb[CGW_MAX + 1];
 645         struct cgw_frame_mod mb;
 646         int modidx = 0;
 647         int err = 0;
 648
 649         /* initialize modification & checksum data space */
 650         memset(mod, 0, sizeof(*mod));
 651
 652         err = nlmsg_parse_deprecated(nlh, sizeof(struct rtcanmsg), tb,
 653                                      CGW_MAX, cgw_policy, NULL);
 654         if (err < 0)
 655                 return err;
 656
 657         if (tb[CGW_LIM_HOPS]) {
 658                 *limhops = nla_get_u8(tb[CGW_LIM_HOPS]);
 659
 660                 if (*limhops < 1 || *limhops > max_hops)
 661                         return -EINVAL;
 662         }
 663
 664         /* check for AND/OR/XOR/SET modifications */
 665
 666         if (tb[CGW_MOD_AND]) {
 667                 nla_memcpy(&mb, tb[CGW_MOD_AND], CGW_MODATTR_LEN);
 668
 669                 canframecpy(&mod->modframe.and, &mb.cf);
 670                 mod->modtype.and = mb.modtype;
 671
 672                 if (mb.modtype & CGW_MOD_ID)
 673                         mod->modfunc[modidx++] = mod_and_id;
 674
 675                 if (mb.modtype & CGW_MOD_DLC)
 676                         mod->modfunc[modidx++] = mod_and_dlc;
 677
 678                 if (mb.modtype & CGW_MOD_DATA)
 679                         mod->modfunc[modidx++] = mod_and_data;
 680         }
 681
 682         if (tb[CGW_MOD_OR]) {
 683                 nla_memcpy(&mb, tb[CGW_MOD_OR], CGW_MODATTR_LEN);
 684
 685                 canframecpy(&mod->modframe.or, &mb.cf);
 686                 mod->modtype.or = mb.modtype;
 687
 688                 if (mb.modtype & CGW_MOD_ID)
 689                         mod->modfunc[modidx++] = mod_or_id;
 690
 691                 if (mb.modtype & CGW_MOD_DLC)
 692                         mod->modfunc[modidx++] = mod_or_dlc;
 693
 694                 if (mb.modtype & CGW_MOD_DATA)
 695                         mod->modfunc[modidx++] = mod_or_data;
 696         }
 697
 698         if (tb[CGW_MOD_XOR]) {
 699                 nla_memcpy(&mb, tb[CGW_MOD_XOR], CGW_MODATTR_LEN);
 700
 701                 canframecpy(&mod->modframe.xor, &mb.cf);
 702                 mod->modtype.xor = mb.modtype;
 703
 704                 if (mb.modtype & CGW_MOD_ID)
 705                         mod->modfunc[modidx++] = mod_xor_id;
 706
 707                 if (mb.modtype & CGW_MOD_DLC)
 708                         mod->modfunc[modidx++] = mod_xor_dlc;
 709
 710                 if (mb.modtype & CGW_MOD_DATA)
 711                         mod->modfunc[modidx++] = mod_xor_data;
 712         }
 713
 714         if (tb[CGW_MOD_SET]) {
 715                 nla_memcpy(&mb, tb[CGW_MOD_SET], CGW_MODATTR_LEN);
 716
 717                 canframecpy(&mod->modframe.set, &mb.cf);
 718                 mod->modtype.set = mb.modtype;
 719
 720                 if (mb.modtype & CGW_MOD_ID)
 721                         mod->modfunc[modidx++] = mod_set_id;
 722
 723                 if (mb.modtype & CGW_MOD_DLC)
 724                         mod->modfunc[modidx++] = mod_set_dlc;
 725
 726                 if (mb.modtype & CGW_MOD_DATA)
 727                         mod->modfunc[modidx++] = mod_set_data;
 728         }
 729
 730         /* check for checksum operations after CAN frame modifications */
 731         if (modidx) {
 732                 if (tb[CGW_CS_CRC8]) {
 733                         struct cgw_csum_crc8 *c = nla_data(tb[CGW_CS_CRC8]);
 734
 735                         err = cgw_chk_csum_parms(c->from_idx, c->to_idx,
 736                                                  c->result_idx);
 737                         if (err)
 738                                 return err;
 739
 740                         nla_memcpy(&mod->csum.crc8, tb[CGW_CS_CRC8],
 741                                    CGW_CS_CRC8_LEN);
 742
 743                         /* select dedicated processing function to reduce
 744                          * runtime operations in receive hot path.
 745                          */
 746                         if (c->from_idx < 0 || c->to_idx < 0 ||
 747                             c->result_idx < 0)
 748                                 mod->csumfunc.crc8 = cgw_csum_crc8_rel;
 749                         else if (c->from_idx <= c->to_idx)
 750                                 mod->csumfunc.crc8 = cgw_csum_crc8_pos;
 751                         else
 752                                 mod->csumfunc.crc8 = cgw_csum_crc8_neg;
 753                 }
 754
 755                 if (tb[CGW_CS_XOR]) {
 756                         struct cgw_csum_xor *c = nla_data(tb[CGW_CS_XOR]);
 757
 758                         err = cgw_chk_csum_parms(c->from_idx, c->to_idx,
 759                                                  c->result_idx);
 760                         if (err)
 761                                 return err;
 762
 763                         nla_memcpy(&mod->csum.xor, tb[CGW_CS_XOR],
 764                                    CGW_CS_XOR_LEN);
 765
 766                         /* select dedicated processing function to reduce
 767                          * runtime operations in receive hot path.
 768                          */
 769                         if (c->from_idx < 0 || c->to_idx < 0 ||
 770                             c->result_idx < 0)
 771                                 mod->csumfunc.xor = cgw_csum_xor_rel;
 772                         else if (c->from_idx <= c->to_idx)
 773                                 mod->csumfunc.xor = cgw_csum_xor_pos;
 774                         else
 775                                 mod->csumfunc.xor = cgw_csum_xor_neg;
 776                 }
 777
 778                 if (tb[CGW_MOD_UID])
 779                         nla_memcpy(&mod->uid, tb[CGW_MOD_UID], sizeof(u32));
 780         }
 781
 782         if (gwtype == CGW_TYPE_CAN_CAN) {
 783                 /* check CGW_TYPE_CAN_CAN specific attributes */
 784                 struct can_can_gw *ccgw = (struct can_can_gw *)gwtypeattr;
 785
 786                 memset(ccgw, 0, sizeof(*ccgw));
 787
 788                 /* check for can_filter in attributes */
 789                 if (tb[CGW_FILTER])
 790                         nla_memcpy(&ccgw->filter, tb[CGW_FILTER],
 791                                    sizeof(struct can_filter));
 792
 793                 err = -ENODEV;
 794
 795                 /* specifying two interfaces is mandatory */
 796                 if (!tb[CGW_SRC_IF] || !tb[CGW_DST_IF])
 797                         return err;
 798
 799                 ccgw->src_idx = nla_get_u32(tb[CGW_SRC_IF]);
 800                 ccgw->dst_idx = nla_get_u32(tb[CGW_DST_IF]);
 801
 802                 /* both indices set to 0 for flushing all routing entries */
 803                 if (!ccgw->src_idx && !ccgw->dst_idx)
 804                         return 0;
 805
 806                 /* only one index set to 0 is an error */
 807                 if (!ccgw->src_idx || !ccgw->dst_idx)
 808                         return err;
 809         }
 810
 811         /* add the checks for other gwtypes here */
 812
 813         return 0;
 814 }
 815
 816 static int cgw_create_job(struct sk_buff *skb,  struct nlmsghdr *nlh,
 817                           struct netlink_ext_ack *extack)
 818 {
 819         struct net *net = sock_net(skb->sk);
 820         struct rtcanmsg *r;
 821         struct cgw_job *gwj;
 822         struct cf_mod mod;
 823         struct can_can_gw ccgw;
 824         u8 limhops = 0;
 825         int err = 0;
 826
 827         if (!netlink_capable(skb, CAP_NET_ADMIN))
 828                 return -EPERM;
 829
 830         if (nlmsg_len(nlh) < sizeof(*r))
 831                 return -EINVAL;
 832
 833         r = nlmsg_data(nlh);
 834         if (r->can_family != AF_CAN)
 835                 return -EPFNOSUPPORT;
 836
 837         /* so far we only support CAN -> CAN routings */
 838         if (r->gwtype != CGW_TYPE_CAN_CAN)
 839                 return -EINVAL;
 840
 841         err = cgw_parse_attr(nlh, &mod, CGW_TYPE_CAN_CAN, &ccgw, &limhops);
 842         if (err < 0)
 843                 return err;
 844
 845         if (mod.uid) {
 846                 ASSERT_RTNL();
 847
 848                 /* check for updating an existing job with identical uid */
 849                 hlist_for_each_entry(gwj, &net->can.cgw_list, list) {
 850                         if (gwj->mod.uid != mod.uid)
 851                                 continue;
 852
 853                         /* interfaces & filters must be identical */
 854                         if (memcmp(&gwj->ccgw, &ccgw, sizeof(ccgw)))
 855                                 return -EINVAL;
 856
 857                         /* update modifications with disabled softirq & quit */
 858                         local_bh_disable();
 859                         memcpy(&gwj->mod, &mod, sizeof(mod));
 860                         local_bh_enable();
 861                         return 0;
 862                 }
 863         }
 864
 865         /* ifindex == 0 is not allowed for job creation */
 866         if (!ccgw.src_idx || !ccgw.dst_idx)
 867                 return -ENODEV;
 868
 869         gwj = kmem_cache_alloc(cgw_cache, GFP_KERNEL);
 870         if (!gwj)
 871                 return -ENOMEM;
 872
 873         gwj->handled_frames = 0;
 874         gwj->dropped_frames = 0;
 875         gwj->deleted_frames = 0;
 876         gwj->flags = r->flags;
 877         gwj->gwtype = r->gwtype;
 878         gwj->limit_hops = limhops;
 879
 880         /* insert already parsed information */
 881         memcpy(&gwj->mod, &mod, sizeof(mod));
 882         memcpy(&gwj->ccgw, &ccgw, sizeof(ccgw));
 883
 884         err = -ENODEV;
 885
 886         gwj->src.dev = __dev_get_by_index(net, gwj->ccgw.src_idx);
 887
 888         if (!gwj->src.dev)
 889                 goto out;
 890
 891         if (gwj->src.dev->type != ARPHRD_CAN)
 892                 goto out;
 893
 894         gwj->dst.dev = __dev_get_by_index(net, gwj->ccgw.dst_idx);
 895
 896         if (!gwj->dst.dev)
 897                 goto out;
 898
 899         if (gwj->dst.dev->type != ARPHRD_CAN)
 900                 goto out;
 901
 902         ASSERT_RTNL();
 903
 904         err = cgw_register_filter(net, gwj);
 905         if (!err)
 906                 hlist_add_head_rcu(&gwj->list, &net->can.cgw_list);
 907 out:
 908         if (err)
 909                 kmem_cache_free(cgw_cache, gwj);
 910
 911         return err;
 912 }
 913
 914 static void cgw_remove_all_jobs(struct net *net)
 915 {
 916         struct cgw_job *gwj = NULL;
 917         struct hlist_node *nx;
 918
 919         ASSERT_RTNL();
 920
 921         hlist_for_each_entry_safe(gwj, nx, &net->can.cgw_list, list) {
 922                 hlist_del(&gwj->list);
 923                 cgw_unregister_filter(net, gwj);
 924                 kmem_cache_free(cgw_cache, gwj);
 925         }
 926 }
 927
 928 static int cgw_remove_job(struct sk_buff *skb, struct nlmsghdr *nlh,
 929                           struct netlink_ext_ack *extack)
 930 {
 931         struct net *net = sock_net(skb->sk);
 932         struct cgw_job *gwj = NULL;
 933         struct hlist_node *nx;
 934         struct rtcanmsg *r;
 935         struct cf_mod mod;
 936         struct can_can_gw ccgw;
 937         u8 limhops = 0;
 938         int err = 0;
 939
 940         if (!netlink_capable(skb, CAP_NET_ADMIN))
 941                 return -EPERM;
 942
 943         if (nlmsg_len(nlh) < sizeof(*r))
 944                 return -EINVAL;
 945
 946         r = nlmsg_data(nlh);
 947         if (r->can_family != AF_CAN)
 948                 return -EPFNOSUPPORT;
 949
 950         /* so far we only support CAN -> CAN routings */
 951         if (r->gwtype != CGW_TYPE_CAN_CAN)
 952                 return -EINVAL;
 953
 954         err = cgw_parse_attr(nlh, &mod, CGW_TYPE_CAN_CAN, &ccgw, &limhops);
 955         if (err < 0)
 956                 return err;
 957
 958         /* two interface indices both set to 0 => remove all entries */
 959         if (!ccgw.src_idx && !ccgw.dst_idx) {
 960                 cgw_remove_all_jobs(net);
 961                 return 0;
 962         }
 963
 964         err = -EINVAL;
 965
 966         ASSERT_RTNL();
 967
 968         /* remove only the first matching entry */
 969         hlist_for_each_entry_safe(gwj, nx, &net->can.cgw_list, list) {
 970                 if (gwj->flags != r->flags)
 971                         continue;
 972
 973                 if (gwj->limit_hops != limhops)
 974                         continue;
 975
 976                 /* we have a match when uid is enabled and identical */
 977                 if (gwj->mod.uid || mod.uid) {
 978                         if (gwj->mod.uid != mod.uid)
 979                                 continue;
 980                 } else {
 981                         /* no uid => check for identical modifications */
 982                         if (memcmp(&gwj->mod, &mod, sizeof(mod)))
 983                                 continue;
 984                 }
 985
 986                 /* if (r->gwtype == CGW_TYPE_CAN_CAN) - is made sure here */
 987                 if (memcmp(&gwj->ccgw, &ccgw, sizeof(ccgw)))
 988                         continue;
 989
 990                 hlist_del(&gwj->list);
 991                 cgw_unregister_filter(net, gwj);
 992                 kmem_cache_free(cgw_cache, gwj);
 993                 err = 0;
 994                 break;
 995         }
 996
 997         return err;
 998 }
 999
1000 static int __net_init cangw_pernet_init(struct net *net)
1001 {
1002         INIT_HLIST_HEAD(&net->can.cgw_list);
1003         return 0;
1004 }
1005
1006 static void __net_exit cangw_pernet_exit(struct net *net)
1007 {
1008         rtnl_lock();
1009         cgw_remove_all_jobs(net);
1010         rtnl_unlock();
1011 }
1012
1013 static struct pernet_operations cangw_pernet_ops = {
1014         .init = cangw_pernet_init,
1015         .exit = cangw_pernet_exit,
1016 };
1017
1018 static __init int cgw_module_init(void)
1019 {
1020         int ret;
1021
1022         /* sanitize given module parameter */
1023         max_hops = clamp_t(unsigned int, max_hops, CGW_MIN_HOPS, CGW_MAX_HOPS);
1024
1025         pr_info("can: netlink gateway (rev " CAN_GW_VERSION ") max_hops=%d\n",
1026                 max_hops);
1027
1028         ret = register_pernet_subsys(&cangw_pernet_ops);
1029         if (ret)
1030                 return ret;
1031
1032         ret = -ENOMEM;
1033         cgw_cache = kmem_cache_create("can_gw", sizeof(struct cgw_job),
1034                                       0, 0, NULL);
1035         if (!cgw_cache)
1036                 goto out_cache_create;
1037
1038         /* set notifier */
1039         notifier.notifier_call = cgw_notifier;
1040         ret = register_netdevice_notifier(&notifier);
1041         if (ret)
1042                 goto out_register_notifier;
1043
1044         ret = rtnl_register_module(THIS_MODULE, PF_CAN, RTM_GETROUTE,
1045                                    NULL, cgw_dump_jobs, 0);
1046         if (ret)
1047                 goto out_rtnl_register1;
1048
1049         ret = rtnl_register_module(THIS_MODULE, PF_CAN, RTM_NEWROUTE,
1050                                    cgw_create_job, NULL, 0);
1051         if (ret)
1052                 goto out_rtnl_register2;
1053         ret = rtnl_register_module(THIS_MODULE, PF_CAN, RTM_DELROUTE,
1054                                    cgw_remove_job, NULL, 0);
1055         if (ret)
1056                 goto out_rtnl_register3;
1057
1058         return 0;
1059
1060 out_rtnl_register3:
1061         rtnl_unregister(PF_CAN, RTM_NEWROUTE);
1062 out_rtnl_register2:
1063         rtnl_unregister(PF_CAN, RTM_GETROUTE);
1064 out_rtnl_register1:
1065         unregister_netdevice_notifier(&notifier);
1066 out_register_notifier:
1067         kmem_cache_destroy(cgw_cache);
1068 out_cache_create:
1069         unregister_pernet_subsys(&cangw_pernet_ops);
1070
1071         return ret;
1072 }
1073
1074 static __exit void cgw_module_exit(void)
1075 {
1076         rtnl_unregister_all(PF_CAN);
1077
1078         unregister_netdevice_notifier(&notifier);
1079
1080         unregister_pernet_subsys(&cangw_pernet_ops);
1081         rcu_barrier(); /* Wait for completion of call_rcu()'s */
1082
1083         kmem_cache_destroy(cgw_cache);
1084 }
1085
1086 module_init(cgw_module_init);
1087 module_exit(cgw_module_exit);