bridge/fdb.c

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Get/set/delete fdb table with netlink
   4  *
   5  * TODO: merge/replace this with ip neighbour
   6  *
   7  * Authors:     Stephen Hemminger <shemminger@vyatta.com>
   8  */
   9
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <unistd.h>
  13 #include <netdb.h>
  14 #include <time.h>
  15 #include <fcntl.h>
  16 #include <sys/socket.h>
  17 #include <sys/time.h>
  18 #include <net/if.h>
  19 #include <netinet/in.h>
  20 #include <linux/if_bridge.h>
  21 #include <linux/if_ether.h>
  22 #include <linux/neighbour.h>
  23 #include <string.h>
  24 #include <limits.h>
  25 #include <json_writer.h>
  26 #include <stdbool.h>
  27
  28 #include "libnetlink.h"
  29 #include "br_common.h"
  30 #include "rt_names.h"
  31 #include "utils.h"
  32
  33 static unsigned int filter_index, filter_vlan, filter_state;
  34
  35 json_writer_t *jw_global;
  36
  37 static void usage(void)
  38 {
  39         fprintf(stderr,
  40                 "Usage: bridge fdb { add | append | del | replace } ADDR dev DEV\n"
  41                 "              [ self ] [ master ] [ use ] [ router ]\n"
  42                 "              [ local | static | dynamic ] [ dst IPADDR ] [ vlan VID ]\n"
  43                 "              [ port PORT] [ vni VNI ] [ via DEV ]\n"
  44                 "       bridge fdb [ show [ br BRDEV ] [ brport DEV ] [ vlan VID ] [ state STATE ] ]\n");
  45         exit(-1);
  46 }
  47
  48 static const char *state_n2a(unsigned int s)
  49 {
  50         static char buf[32];
  51
  52         if (s & NUD_PERMANENT)
  53                 return "permanent";
  54
  55         if (s & NUD_NOARP)
  56                 return "static";
  57
  58         if (s & NUD_STALE)
  59                 return "stale";
  60
  61         if (s & NUD_REACHABLE)
  62                 return "";
  63
  64         sprintf(buf, "state=%#x", s);
  65         return buf;
  66 }
  67
  68 static int state_a2n(unsigned int *s, const char *arg)
  69 {
  70         if (matches(arg, "permanent") == 0)
  71                 *s = NUD_PERMANENT;
  72         else if (matches(arg, "static") == 0 || matches(arg, "temp") == 0)
  73                 *s = NUD_NOARP;
  74         else if (matches(arg, "stale") == 0)
  75                 *s = NUD_STALE;
  76         else if (matches(arg, "reachable") == 0 || matches(arg, "dynamic") == 0)
  77                 *s = NUD_REACHABLE;
  78         else if (strcmp(arg, "all") == 0)
  79                 *s = ~0;
  80         else if (get_unsigned(s, arg, 0))
  81                 return -1;
  82
  83         return 0;
  84 }
  85
  86 static void start_json_fdb_flags_array(bool *fdb_flags)
  87 {
  88         if (*fdb_flags)
  89                 return;
  90         jsonw_name(jw_global, "flags");
  91         jsonw_start_array(jw_global);
  92         *fdb_flags = true;
  93 }
  94
  95 int print_fdb(const struct sockaddr_nl *who, struct nlmsghdr *n, void *arg)
  96 {
  97         FILE *fp = arg;
  98         struct ndmsg *r = NLMSG_DATA(n);
  99         int len = n->nlmsg_len;
 100         struct rtattr *tb[NDA_MAX+1];
 101         __u16 vid = 0;
 102         bool fdb_flags = false;
 103         const char *state_s;
 104
 105         if (n->nlmsg_type != RTM_NEWNEIGH && n->nlmsg_type != RTM_DELNEIGH) {
 106                 fprintf(stderr, "Not RTM_NEWNEIGH: %08x %08x %08x\n",
 107                         n->nlmsg_len, n->nlmsg_type, n->nlmsg_flags);
 108                 return 0;
 109         }
 110
 111         len -= NLMSG_LENGTH(sizeof(*r));
 112         if (len < 0) {
 113                 fprintf(stderr, "BUG: wrong nlmsg len %d\n", len);
 114                 return -1;
 115         }
 116
 117         if (r->ndm_family != AF_BRIDGE)
 118                 return 0;
 119
 120         if (filter_index && filter_index != r->ndm_ifindex)
 121                 return 0;
 122
 123         if (filter_state && !(r->ndm_state & filter_state))
 124                 return 0;
 125
 126         parse_rtattr(tb, NDA_MAX, NDA_RTA(r),
 127                      n->nlmsg_len - NLMSG_LENGTH(sizeof(*r)));
 128
 129         if (tb[NDA_VLAN])
 130                 vid = rta_getattr_u16(tb[NDA_VLAN]);
 131
 132         if (filter_vlan && filter_vlan != vid)
 133                 return 0;
 134
 135         if (jw_global) {
 136                 jsonw_pretty(jw_global, 1);
 137                 jsonw_start_object(jw_global);
 138         }
 139
 140         if (n->nlmsg_type == RTM_DELNEIGH) {
 141                 if (jw_global)
 142                         jsonw_string_field(jw_global, "opCode", "deleted");
 143                 else
 144                         fprintf(fp, "Deleted ");
 145         }
 146
 147         if (tb[NDA_LLADDR]) {
 148                 SPRINT_BUF(b1);
 149                 ll_addr_n2a(RTA_DATA(tb[NDA_LLADDR]),
 150                             RTA_PAYLOAD(tb[NDA_LLADDR]),
 151                             ll_index_to_type(r->ndm_ifindex),
 152                             b1, sizeof(b1));
 153                 if (jw_global)
 154                         jsonw_string_field(jw_global, "mac", b1);
 155                 else
 156                         fprintf(fp, "%s ", b1);
 157         }
 158
 159         if (!filter_index && r->ndm_ifindex) {
 160                 if (jw_global)
 161                         jsonw_string_field(jw_global, "dev",
 162                                            ll_index_to_name(r->ndm_ifindex));
 163                 else
 164                         fprintf(fp, "dev %s ",
 165                                 ll_index_to_name(r->ndm_ifindex));
 166         }
 167
 168         if (tb[NDA_DST]) {
 169                 int family = AF_INET;
 170                 const char *abuf_s;
 171
 172                 if (RTA_PAYLOAD(tb[NDA_DST]) == sizeof(struct in6_addr))
 173                         family = AF_INET6;
 174
 175                 abuf_s = format_host(family,
 176                                      RTA_PAYLOAD(tb[NDA_DST]),
 177                                      RTA_DATA(tb[NDA_DST]));
 178                 if (jw_global)
 179                         jsonw_string_field(jw_global, "dst", abuf_s);
 180                 else
 181                         fprintf(fp, "dst %s ", abuf_s);
 182         }
 183
 184         if (vid) {
 185                 if (jw_global)
 186                         jsonw_uint_field(jw_global, "vlan", vid);
 187                 else
 188                         fprintf(fp, "vlan %hu ", vid);
 189         }
 190
 191         if (tb[NDA_PORT]) {
 192                 if (jw_global)
 193                         jsonw_uint_field(jw_global, "port",
 194                                          rta_getattr_be16(tb[NDA_PORT]));
 195                 else
 196                         fprintf(fp, "port %d ",
 197                                 rta_getattr_be16(tb[NDA_PORT]));
 198         }
 199
 200         if (tb[NDA_VNI]) {
 201                 if (jw_global)
 202                         jsonw_uint_field(jw_global, "vni",
 203                                          rta_getattr_u32(tb[NDA_VNI]));
 204                 else
 205                         fprintf(fp, "vni %d ",
 206                                 rta_getattr_u32(tb[NDA_VNI]));
 207         }
 208
 209         if (tb[NDA_SRC_VNI]) {
 210                 if (jw_global)
 211                         jsonw_uint_field(jw_global, "src_vni",
 212                                          rta_getattr_u32(tb[NDA_SRC_VNI]));
 213                 else
 214                         fprintf(fp, "src_vni %d ",
 215                                 rta_getattr_u32(tb[NDA_SRC_VNI]));
 216         }
 217
 218         if (tb[NDA_IFINDEX]) {
 219                 unsigned int ifindex = rta_getattr_u32(tb[NDA_IFINDEX]);
 220
 221                 if (ifindex) {
 222                         if (!tb[NDA_LINK_NETNSID]) {
 223                                 const char *ifname = ll_index_to_name(ifindex);
 224
 225                                 if (jw_global)
 226                                         jsonw_string_field(jw_global, "viaIf",
 227                                                            ifname);
 228                                 else
 229                                         fprintf(fp, "via %s ", ifname);
 230                         } else {
 231                                 if (jw_global)
 232                                         jsonw_uint_field(jw_global, "viaIfIndex",
 233                                                          ifindex);
 234                                 else
 235                                         fprintf(fp, "via ifindex %u ", ifindex);
 236                         }
 237                 }
 238         }
 239
 240         if (tb[NDA_LINK_NETNSID]) {
 241                 if (jw_global)
 242                         jsonw_uint_field(jw_global, "linkNetNsId",
 243                                          rta_getattr_u32(tb[NDA_LINK_NETNSID]));
 244                 else
 245                         fprintf(fp, "link-netnsid %d ",
 246                                 rta_getattr_u32(tb[NDA_LINK_NETNSID]));
 247         }
 248
 249         if (show_stats && tb[NDA_CACHEINFO]) {
 250                 struct nda_cacheinfo *ci = RTA_DATA(tb[NDA_CACHEINFO]);
 251                 int hz = get_user_hz();
 252
 253                 if (jw_global) {
 254                         jsonw_uint_field(jw_global, "used",
 255                                 ci->ndm_used/hz);
 256                         jsonw_uint_field(jw_global, "updated",
 257                                 ci->ndm_updated/hz);
 258                 } else {
 259                         fprintf(fp, "used %d/%d ", ci->ndm_used/hz,
 260                                         ci->ndm_updated/hz);
 261                 }
 262         }
 263
 264         if (jw_global) {
 265                 if (r->ndm_flags & NTF_SELF) {
 266                         start_json_fdb_flags_array(&fdb_flags);
 267                         jsonw_string(jw_global, "self");
 268                 }
 269                 if (r->ndm_flags & NTF_ROUTER) {
 270                         start_json_fdb_flags_array(&fdb_flags);
 271                         jsonw_string(jw_global, "router");
 272                 }
 273                 if (r->ndm_flags & NTF_EXT_LEARNED) {
 274                         start_json_fdb_flags_array(&fdb_flags);
 275                         jsonw_string(jw_global, "extern_learn");
 276                 }
 277                 if (r->ndm_flags & NTF_OFFLOADED) {
 278                         start_json_fdb_flags_array(&fdb_flags);
 279                         jsonw_string(jw_global, "offload");
 280                 }
 281                 if (r->ndm_flags & NTF_MASTER)
 282                         jsonw_string(jw_global, "master");
 283                 if (fdb_flags)
 284                         jsonw_end_array(jw_global);
 285
 286                 if (tb[NDA_MASTER])
 287                         jsonw_string_field(jw_global,
 288                                            "master",
 289                                            ll_index_to_name(rta_getattr_u32(tb[NDA_MASTER])));
 290
 291         } else {
 292                 if (r->ndm_flags & NTF_SELF)
 293                         fprintf(fp, "self ");
 294                 if (r->ndm_flags & NTF_ROUTER)
 295                         fprintf(fp, "router ");
 296                 if (r->ndm_flags & NTF_EXT_LEARNED)
 297                         fprintf(fp, "extern_learn ");
 298                 if (r->ndm_flags & NTF_OFFLOADED)
 299                         fprintf(fp, "offload ");
 300                 if (tb[NDA_MASTER]) {
 301                         fprintf(fp, "master %s ",
 302                                 ll_index_to_name(rta_getattr_u32(tb[NDA_MASTER])));
 303                 } else if (r->ndm_flags & NTF_MASTER) {
 304                         fprintf(fp, "master ");
 305                 }
 306         }
 307
 308         state_s = state_n2a(r->ndm_state);
 309         if (jw_global) {
 310                 if (state_s[0])
 311                         jsonw_string_field(jw_global, "state", state_s);
 312
 313                 jsonw_end_object(jw_global);
 314         } else {
 315                 fprintf(fp, "%s\n", state_s);
 316
 317                 fflush(fp);
 318         }
 319
 320         return 0;
 321 }
 322
 323 static int fdb_show(int argc, char **argv)
 324 {
 325         struct {
 326                 struct nlmsghdr n;
 327                 struct ifinfomsg        ifm;
 328                 char                    buf[256];
 329         } req = {
 330                 .n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ifinfomsg)),
 331                 .ifm.ifi_family = PF_BRIDGE,
 332         };
 333
 334         char *filter_dev = NULL;
 335         char *br = NULL;
 336         int msg_size = sizeof(struct ifinfomsg);
 337
 338         while (argc > 0) {
 339                 if ((strcmp(*argv, "brport") == 0) || strcmp(*argv, "dev") == 0) {
 340                         NEXT_ARG();
 341                         filter_dev = *argv;
 342                 } else if (strcmp(*argv, "br") == 0) {
 343                         NEXT_ARG();
 344                         br = *argv;
 345                 } else if (strcmp(*argv, "vlan") == 0) {
 346                         NEXT_ARG();
 347                         if (filter_vlan)
 348                                 duparg("vlan", *argv);
 349                         filter_vlan = atoi(*argv);
 350                 } else if (strcmp(*argv, "state") == 0) {
 351                         unsigned int state;
 352
 353                         NEXT_ARG();
 354                         if (state_a2n(&state, *argv))
 355                                 invarg("invalid state", *argv);
 356                         filter_state |= state;
 357                 } else {
 358                         if (matches(*argv, "help") == 0)
 359                                 usage();
 360                 }
 361                 argc--; argv++;
 362         }
 363
 364         if (br) {
 365                 int br_ifindex = ll_name_to_index(br);
 366
 367                 if (br_ifindex == 0) {
 368                         fprintf(stderr, "Cannot find bridge device \"%s\"\n", br);
 369                         return -1;
 370                 }
 371                 addattr32(&req.n, sizeof(req), IFLA_MASTER, br_ifindex);
 372                 msg_size += RTA_LENGTH(4);
 373         }
 374
 375         /*we'll keep around filter_dev for older kernels */
 376         if (filter_dev) {
 377                 filter_index = ll_name_to_index(filter_dev);
 378                 if (filter_index == 0) {
 379                         fprintf(stderr, "Cannot find device \"%s\"\n",
 380                                 filter_dev);
 381                         return -1;
 382                 }
 383                 req.ifm.ifi_index = filter_index;
 384         }
 385
 386         if (rtnl_dump_request(&rth, RTM_GETNEIGH, &req.ifm, msg_size) < 0) {
 387                 perror("Cannot send dump request");
 388                 exit(1);
 389         }
 390
 391         if (json_output) {
 392                 jw_global = jsonw_new(stdout);
 393                 if (!jw_global) {
 394                         fprintf(stderr, "Error allocation json object\n");
 395                         exit(1);
 396                 }
 397                 jsonw_start_array(jw_global);
 398         }
 399         if (rtnl_dump_filter(&rth, print_fdb, stdout) < 0) {
 400                 fprintf(stderr, "Dump terminated\n");
 401                 exit(1);
 402         }
 403         if (jw_global) {
 404                 jsonw_end_array(jw_global);
 405                 jsonw_destroy(&jw_global);
 406         }
 407
 408         return 0;
 409 }
 410
 411 static int fdb_modify(int cmd, int flags, int argc, char **argv)
 412 {
 413         struct {
 414                 struct nlmsghdr n;
 415                 struct ndmsg            ndm;
 416                 char                    buf[256];
 417         } req = {
 418                 .n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ndmsg)),
 419                 .n.nlmsg_flags = NLM_F_REQUEST | flags,
 420                 .n.nlmsg_type = cmd,
 421                 .ndm.ndm_family = PF_BRIDGE,
 422                 .ndm.ndm_state = NUD_NOARP,
 423         };
 424         char *addr = NULL;
 425         char *d = NULL;
 426         char abuf[ETH_ALEN];
 427         int dst_ok = 0;
 428         inet_prefix dst;
 429         unsigned long port = 0;
 430         unsigned long vni = ~0;
 431         unsigned int via = 0;
 432         char *endptr;
 433         short vid = -1;
 434
 435         while (argc > 0) {
 436                 if (strcmp(*argv, "dev") == 0) {
 437                         NEXT_ARG();
 438                         d = *argv;
 439                 } else if (strcmp(*argv, "dst") == 0) {
 440                         NEXT_ARG();
 441                         if (dst_ok)
 442                                 duparg2("dst", *argv);
 443                         get_addr(&dst, *argv, preferred_family);
 444                         dst_ok = 1;
 445                 } else if (strcmp(*argv, "port") == 0) {
 446
 447                         NEXT_ARG();
 448                         port = strtoul(*argv, &endptr, 0);
 449                         if (endptr && *endptr) {
 450                                 struct servent *pse;
 451
 452                                 pse = getservbyname(*argv, "udp");
 453                                 if (!pse)
 454                                         invarg("invalid port\n", *argv);
 455                                 port = ntohs(pse->s_port);
 456                         } else if (port > 0xffff)
 457                                 invarg("invalid port\n", *argv);
 458                 } else if (strcmp(*argv, "vni") == 0) {
 459                         NEXT_ARG();
 460                         vni = strtoul(*argv, &endptr, 0);
 461                         if ((endptr && *endptr) ||
 462                             (vni >> 24) || vni == ULONG_MAX)
 463                                 invarg("invalid VNI\n", *argv);
 464                 } else if (strcmp(*argv, "via") == 0) {
 465                         NEXT_ARG();
 466                         via = ll_name_to_index(*argv);
 467                         if (via == 0)
 468                                 invarg("invalid device\n", *argv);
 469                 } else if (strcmp(*argv, "self") == 0) {
 470                         req.ndm.ndm_flags |= NTF_SELF;
 471                 } else if (matches(*argv, "master") == 0) {
 472                         req.ndm.ndm_flags |= NTF_MASTER;
 473                 } else if (matches(*argv, "router") == 0) {
 474                         req.ndm.ndm_flags |= NTF_ROUTER;
 475                 } else if (matches(*argv, "local") == 0 ||
 476                            matches(*argv, "permanent") == 0) {
 477                         req.ndm.ndm_state |= NUD_PERMANENT;
 478                 } else if (matches(*argv, "temp") == 0 ||
 479                            matches(*argv, "static") == 0) {
 480                         req.ndm.ndm_state |= NUD_REACHABLE;
 481                 } else if (matches(*argv, "dynamic") == 0) {
 482                         req.ndm.ndm_state |= NUD_REACHABLE;
 483                         req.ndm.ndm_state &= ~NUD_NOARP;
 484                 } else if (matches(*argv, "vlan") == 0) {
 485                         if (vid >= 0)
 486                                 duparg2("vlan", *argv);
 487                         NEXT_ARG();
 488                         vid = atoi(*argv);
 489                 } else if (matches(*argv, "use") == 0) {
 490                         req.ndm.ndm_flags |= NTF_USE;
 491                 } else {
 492                         if (strcmp(*argv, "to") == 0)
 493                                 NEXT_ARG();
 494
 495                         if (matches(*argv, "help") == 0)
 496                                 usage();
 497                         if (addr)
 498                                 duparg2("to", *argv);
 499                         addr = *argv;
 500                 }
 501                 argc--; argv++;
 502         }
 503
 504         if (d == NULL || addr == NULL) {
 505                 fprintf(stderr, "Device and address are required arguments.\n");
 506                 return -1;
 507         }
 508
 509         /* Assume self */
 510         if (!(req.ndm.ndm_flags&(NTF_SELF|NTF_MASTER)))
 511                 req.ndm.ndm_flags |= NTF_SELF;
 512
 513         /* Assume permanent */
 514         if (!(req.ndm.ndm_state&(NUD_PERMANENT|NUD_REACHABLE)))
 515                 req.ndm.ndm_state |= NUD_PERMANENT;
 516
 517         if (sscanf(addr, "%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
 518                    abuf, abuf+1, abuf+2,
 519                    abuf+3, abuf+4, abuf+5) != 6) {
 520                 fprintf(stderr, "Invalid mac address %s\n", addr);
 521                 return -1;
 522         }
 523
 524         addattr_l(&req.n, sizeof(req), NDA_LLADDR, abuf, ETH_ALEN);
 525         if (dst_ok)
 526                 addattr_l(&req.n, sizeof(req), NDA_DST, &dst.data, dst.bytelen);
 527
 528         if (vid >= 0)
 529                 addattr16(&req.n, sizeof(req), NDA_VLAN, vid);
 530
 531         if (port) {
 532                 unsigned short dport;
 533
 534                 dport = htons((unsigned short)port);
 535                 addattr16(&req.n, sizeof(req), NDA_PORT, dport);
 536         }
 537         if (vni != ~0)
 538                 addattr32(&req.n, sizeof(req), NDA_VNI, vni);
 539         if (via)
 540                 addattr32(&req.n, sizeof(req), NDA_IFINDEX, via);
 541
 542         req.ndm.ndm_ifindex = ll_name_to_index(d);
 543         if (req.ndm.ndm_ifindex == 0) {
 544                 fprintf(stderr, "Cannot find device \"%s\"\n", d);
 545                 return -1;
 546         }
 547
 548         if (rtnl_talk(&rth, &req.n, NULL) < 0)
 549                 return -1;
 550
 551         return 0;
 552 }
 553
 554 int do_fdb(int argc, char **argv)
 555 {
 556         ll_init_map(&rth);
 557
 558         if (argc > 0) {
 559                 if (matches(*argv, "add") == 0)
 560                         return fdb_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_EXCL, argc-1, argv+1);
 561                 if (matches(*argv, "append") == 0)
 562                         return fdb_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_APPEND, argc-1, argv+1);
 563                 if (matches(*argv, "replace") == 0)
 564                         return fdb_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_REPLACE, argc-1, argv+1);
 565                 if (matches(*argv, "delete") == 0)
 566                         return fdb_modify(RTM_DELNEIGH, 0, argc-1, argv+1);
 567                 if (matches(*argv, "show") == 0 ||
 568                     matches(*argv, "lst") == 0 ||
 569                     matches(*argv, "list") == 0)
 570                         return fdb_show(argc-1, argv+1);
 571                 if (matches(*argv, "help") == 0)
 572                         usage();
 573         } else
 574                 return fdb_show(0, NULL);
 575
 576         fprintf(stderr, "Command \"%s\" is unknown, try \"bridge fdb help\".\n", *argv);
 577         exit(-1);
 578 }