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 <stdbool.h>
  26
  27 #include "json_print.h"
  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 static void usage(void)
  36 {
  37         fprintf(stderr,
  38                 "Usage: bridge fdb { add | append | del | replace } ADDR dev DEV\n"
  39                 "              [ self ] [ master ] [ use ] [ router ] [ extern_learn ]\n"
  40                 "              [ sticky ] [ local | static | dynamic ] [ dst IPADDR ]\n"
  41                 "              [ vlan VID ] [ port PORT] [ vni VNI ] [ via DEV ]\n"
  42                 "       bridge fdb [ show [ br BRDEV ] [ brport DEV ] [ vlan VID ] [ state STATE ] ]\n");
  43         exit(-1);
  44 }
  45
  46 static const char *state_n2a(unsigned int s)
  47 {
  48         static char buf[32];
  49
  50         if (s & NUD_PERMANENT)
  51                 return "permanent";
  52
  53         if (s & NUD_NOARP)
  54                 return "static";
  55
  56         if (s & NUD_STALE)
  57                 return "stale";
  58
  59         if (s & NUD_REACHABLE)
  60                 return "";
  61
  62         sprintf(buf, "state=%#x", s);
  63         return buf;
  64 }
  65
  66 static int state_a2n(unsigned int *s, const char *arg)
  67 {
  68         if (matches(arg, "permanent") == 0)
  69                 *s = NUD_PERMANENT;
  70         else if (matches(arg, "static") == 0 || matches(arg, "temp") == 0)
  71                 *s = NUD_NOARP;
  72         else if (matches(arg, "stale") == 0)
  73                 *s = NUD_STALE;
  74         else if (matches(arg, "reachable") == 0 || matches(arg, "dynamic") == 0)
  75                 *s = NUD_REACHABLE;
  76         else if (strcmp(arg, "all") == 0)
  77                 *s = ~0;
  78         else if (get_unsigned(s, arg, 0))
  79                 return -1;
  80
  81         return 0;
  82 }
  83
  84 static void fdb_print_flags(FILE *fp, unsigned int flags)
  85 {
  86         open_json_array(PRINT_JSON,
  87                         is_json_context() ?  "flags" : "");
  88
  89         if (flags & NTF_SELF)
  90                 print_string(PRINT_ANY, NULL, "%s ", "self");
  91
  92         if (flags & NTF_ROUTER)
  93                 print_string(PRINT_ANY, NULL, "%s ", "router");
  94
  95         if (flags & NTF_EXT_LEARNED)
  96                 print_string(PRINT_ANY, NULL, "%s ", "extern_learn");
  97
  98         if (flags & NTF_OFFLOADED)
  99                 print_string(PRINT_ANY, NULL, "%s ", "offload");
 100
 101         if (flags & NTF_MASTER)
 102                 print_string(PRINT_ANY, NULL, "%s ", "master");
 103
 104         if (flags & NTF_STICKY)
 105                 print_string(PRINT_ANY, NULL, "%s ", "sticky");
 106
 107         close_json_array(PRINT_JSON, NULL);
 108 }
 109
 110 static void fdb_print_stats(FILE *fp, const struct nda_cacheinfo *ci)
 111 {
 112         static int hz;
 113
 114         if (!hz)
 115                 hz = get_user_hz();
 116
 117         if (is_json_context()) {
 118                 print_uint(PRINT_JSON, "used", NULL,
 119                                  ci->ndm_used / hz);
 120                 print_uint(PRINT_JSON, "updated", NULL,
 121                                 ci->ndm_updated / hz);
 122         } else {
 123                 fprintf(fp, "used %d/%d ", ci->ndm_used / hz,
 124                                         ci->ndm_updated / hz);
 125
 126         }
 127 }
 128
 129 int print_fdb(struct nlmsghdr *n, void *arg)
 130 {
 131         FILE *fp = arg;
 132         struct ndmsg *r = NLMSG_DATA(n);
 133         int len = n->nlmsg_len;
 134         struct rtattr *tb[NDA_MAX+1];
 135         __u16 vid = 0;
 136
 137         if (n->nlmsg_type != RTM_NEWNEIGH && n->nlmsg_type != RTM_DELNEIGH) {
 138                 fprintf(stderr, "Not RTM_NEWNEIGH: %08x %08x %08x\n",
 139                         n->nlmsg_len, n->nlmsg_type, n->nlmsg_flags);
 140                 return 0;
 141         }
 142
 143         len -= NLMSG_LENGTH(sizeof(*r));
 144         if (len < 0) {
 145                 fprintf(stderr, "BUG: wrong nlmsg len %d\n", len);
 146                 return -1;
 147         }
 148
 149         if (r->ndm_family != AF_BRIDGE)
 150                 return 0;
 151
 152         if (filter_index && filter_index != r->ndm_ifindex)
 153                 return 0;
 154
 155         if (filter_state && !(r->ndm_state & filter_state))
 156                 return 0;
 157
 158         parse_rtattr(tb, NDA_MAX, NDA_RTA(r),
 159                      n->nlmsg_len - NLMSG_LENGTH(sizeof(*r)));
 160
 161         if (tb[NDA_VLAN])
 162                 vid = rta_getattr_u16(tb[NDA_VLAN]);
 163
 164         if (filter_vlan && filter_vlan != vid)
 165                 return 0;
 166
 167         open_json_object(NULL);
 168         if (n->nlmsg_type == RTM_DELNEIGH)
 169                 print_bool(PRINT_ANY, "deleted", "Deleted ", true);
 170
 171         if (tb[NDA_LLADDR]) {
 172                 const char *lladdr;
 173                 SPRINT_BUF(b1);
 174
 175                 lladdr = ll_addr_n2a(RTA_DATA(tb[NDA_LLADDR]),
 176                                      RTA_PAYLOAD(tb[NDA_LLADDR]),
 177                                      ll_index_to_type(r->ndm_ifindex),
 178                                      b1, sizeof(b1));
 179
 180                 print_color_string(PRINT_ANY, COLOR_MAC,
 181                                    "mac", "%s ", lladdr);
 182         }
 183
 184         if (!filter_index && r->ndm_ifindex)
 185                 print_color_string(PRINT_ANY, COLOR_IFNAME,
 186                                    "ifname", "dev %s ",
 187                                    ll_index_to_name(r->ndm_ifindex));
 188
 189         if (tb[NDA_DST]) {
 190                 int family = AF_INET;
 191                 const char *dst;
 192
 193                 if (RTA_PAYLOAD(tb[NDA_DST]) == sizeof(struct in6_addr))
 194                         family = AF_INET6;
 195
 196                 dst = format_host(family,
 197                                   RTA_PAYLOAD(tb[NDA_DST]),
 198                                   RTA_DATA(tb[NDA_DST]));
 199
 200                 print_color_string(PRINT_ANY,
 201                                    ifa_family_color(family),
 202                                     "dst", "dst %s ", dst);
 203         }
 204
 205         if (vid)
 206                 print_uint(PRINT_ANY,
 207                                  "vlan", "vlan %hu ", vid);
 208
 209         if (tb[NDA_PORT])
 210                 print_uint(PRINT_ANY,
 211                                  "port", "port %u ",
 212                                  rta_getattr_be16(tb[NDA_PORT]));
 213
 214         if (tb[NDA_VNI])
 215                 print_uint(PRINT_ANY,
 216                                  "vni", "vni %u ",
 217                                  rta_getattr_u32(tb[NDA_VNI]));
 218
 219         if (tb[NDA_SRC_VNI])
 220                 print_uint(PRINT_ANY,
 221                                  "src_vni", "src_vni %u ",
 222                                 rta_getattr_u32(tb[NDA_SRC_VNI]));
 223
 224         if (tb[NDA_IFINDEX]) {
 225                 unsigned int ifindex = rta_getattr_u32(tb[NDA_IFINDEX]);
 226
 227                 if (tb[NDA_LINK_NETNSID])
 228                         print_uint(PRINT_ANY,
 229                                          "viaIfIndex", "via ifindex %u ",
 230                                          ifindex);
 231                 else
 232                         print_string(PRINT_ANY,
 233                                            "viaIf", "via %s ",
 234                                            ll_index_to_name(ifindex));
 235         }
 236
 237         if (tb[NDA_LINK_NETNSID])
 238                 print_uint(PRINT_ANY,
 239                                  "linkNetNsId", "link-netnsid %d ",
 240                                  rta_getattr_u32(tb[NDA_LINK_NETNSID]));
 241
 242         if (show_stats && tb[NDA_CACHEINFO])
 243                 fdb_print_stats(fp, RTA_DATA(tb[NDA_CACHEINFO]));
 244
 245         fdb_print_flags(fp, r->ndm_flags);
 246
 247
 248         if (tb[NDA_MASTER])
 249                 print_string(PRINT_ANY, "master", "master %s ",
 250                              ll_index_to_name(rta_getattr_u32(tb[NDA_MASTER])));
 251
 252         print_string(PRINT_ANY, "state", "%s\n",
 253                            state_n2a(r->ndm_state));
 254         close_json_object();
 255         fflush(fp);
 256         return 0;
 257 }
 258
 259 static int fdb_show(int argc, char **argv)
 260 {
 261         struct {
 262                 struct nlmsghdr n;
 263                 struct ifinfomsg        ifm;
 264                 char                    buf[256];
 265         } req = {
 266                 .n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ifinfomsg)),
 267                 .ifm.ifi_family = PF_BRIDGE,
 268         };
 269
 270         char *filter_dev = NULL;
 271         char *br = NULL;
 272         int msg_size = sizeof(struct ifinfomsg);
 273
 274         while (argc > 0) {
 275                 if ((strcmp(*argv, "brport") == 0) || strcmp(*argv, "dev") == 0) {
 276                         NEXT_ARG();
 277                         filter_dev = *argv;
 278                 } else if (strcmp(*argv, "br") == 0) {
 279                         NEXT_ARG();
 280                         br = *argv;
 281                 } else if (strcmp(*argv, "vlan") == 0) {
 282                         NEXT_ARG();
 283                         if (filter_vlan)
 284                                 duparg("vlan", *argv);
 285                         filter_vlan = atoi(*argv);
 286                 } else if (strcmp(*argv, "state") == 0) {
 287                         unsigned int state;
 288
 289                         NEXT_ARG();
 290                         if (state_a2n(&state, *argv))
 291                                 invarg("invalid state", *argv);
 292                         filter_state |= state;
 293                 } else {
 294                         if (matches(*argv, "help") == 0)
 295                                 usage();
 296                 }
 297                 argc--; argv++;
 298         }
 299
 300         if (br) {
 301                 int br_ifindex = ll_name_to_index(br);
 302
 303                 if (br_ifindex == 0) {
 304                         fprintf(stderr, "Cannot find bridge device \"%s\"\n", br);
 305                         return -1;
 306                 }
 307                 addattr32(&req.n, sizeof(req), IFLA_MASTER, br_ifindex);
 308                 msg_size += RTA_LENGTH(4);
 309         }
 310
 311         /*we'll keep around filter_dev for older kernels */
 312         if (filter_dev) {
 313                 filter_index = ll_name_to_index(filter_dev);
 314                 if (!filter_index)
 315                         return nodev(filter_dev);
 316                 req.ifm.ifi_index = filter_index;
 317         }
 318
 319         if (rtnl_dump_request(&rth, RTM_GETNEIGH, &req.ifm, msg_size) < 0) {
 320                 perror("Cannot send dump request");
 321                 exit(1);
 322         }
 323
 324         new_json_obj(json);
 325         if (rtnl_dump_filter(&rth, print_fdb, stdout) < 0) {
 326                 fprintf(stderr, "Dump terminated\n");
 327                 exit(1);
 328         }
 329         delete_json_obj();
 330         fflush(stdout);
 331
 332         return 0;
 333 }
 334
 335 static int fdb_modify(int cmd, int flags, int argc, char **argv)
 336 {
 337         struct {
 338                 struct nlmsghdr n;
 339                 struct ndmsg            ndm;
 340                 char                    buf[256];
 341         } req = {
 342                 .n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ndmsg)),
 343                 .n.nlmsg_flags = NLM_F_REQUEST | flags,
 344                 .n.nlmsg_type = cmd,
 345                 .ndm.ndm_family = PF_BRIDGE,
 346                 .ndm.ndm_state = NUD_NOARP,
 347         };
 348         char *addr = NULL;
 349         char *d = NULL;
 350         char abuf[ETH_ALEN];
 351         int dst_ok = 0;
 352         inet_prefix dst;
 353         unsigned long port = 0;
 354         unsigned long vni = ~0;
 355         unsigned int via = 0;
 356         char *endptr;
 357         short vid = -1;
 358
 359         while (argc > 0) {
 360                 if (strcmp(*argv, "dev") == 0) {
 361                         NEXT_ARG();
 362                         d = *argv;
 363                 } else if (strcmp(*argv, "dst") == 0) {
 364                         NEXT_ARG();
 365                         if (dst_ok)
 366                                 duparg2("dst", *argv);
 367                         get_addr(&dst, *argv, preferred_family);
 368                         dst_ok = 1;
 369                 } else if (strcmp(*argv, "port") == 0) {
 370
 371                         NEXT_ARG();
 372                         port = strtoul(*argv, &endptr, 0);
 373                         if (endptr && *endptr) {
 374                                 struct servent *pse;
 375
 376                                 pse = getservbyname(*argv, "udp");
 377                                 if (!pse)
 378                                         invarg("invalid port\n", *argv);
 379                                 port = ntohs(pse->s_port);
 380                         } else if (port > 0xffff)
 381                                 invarg("invalid port\n", *argv);
 382                 } else if (strcmp(*argv, "vni") == 0) {
 383                         NEXT_ARG();
 384                         vni = strtoul(*argv, &endptr, 0);
 385                         if ((endptr && *endptr) ||
 386                             (vni >> 24) || vni == ULONG_MAX)
 387                                 invarg("invalid VNI\n", *argv);
 388                 } else if (strcmp(*argv, "via") == 0) {
 389                         NEXT_ARG();
 390                         via = ll_name_to_index(*argv);
 391                         if (!via)
 392                                 exit(nodev(*argv));
 393                 } else if (strcmp(*argv, "self") == 0) {
 394                         req.ndm.ndm_flags |= NTF_SELF;
 395                 } else if (matches(*argv, "master") == 0) {
 396                         req.ndm.ndm_flags |= NTF_MASTER;
 397                 } else if (matches(*argv, "router") == 0) {
 398                         req.ndm.ndm_flags |= NTF_ROUTER;
 399                 } else if (matches(*argv, "local") == 0 ||
 400                            matches(*argv, "permanent") == 0) {
 401                         req.ndm.ndm_state |= NUD_PERMANENT;
 402                 } else if (matches(*argv, "temp") == 0 ||
 403                            matches(*argv, "static") == 0) {
 404                         req.ndm.ndm_state |= NUD_REACHABLE;
 405                 } else if (matches(*argv, "dynamic") == 0) {
 406                         req.ndm.ndm_state |= NUD_REACHABLE;
 407                         req.ndm.ndm_state &= ~NUD_NOARP;
 408                 } else if (matches(*argv, "vlan") == 0) {
 409                         if (vid >= 0)
 410                                 duparg2("vlan", *argv);
 411                         NEXT_ARG();
 412                         vid = atoi(*argv);
 413                 } else if (matches(*argv, "use") == 0) {
 414                         req.ndm.ndm_flags |= NTF_USE;
 415                 } else if (matches(*argv, "extern_learn") == 0) {
 416                         req.ndm.ndm_flags |= NTF_EXT_LEARNED;
 417                 } else if (matches(*argv, "sticky") == 0) {
 418                         req.ndm.ndm_flags |= NTF_STICKY;
 419                 } else {
 420                         if (strcmp(*argv, "to") == 0)
 421                                 NEXT_ARG();
 422
 423                         if (matches(*argv, "help") == 0)
 424                                 usage();
 425                         if (addr)
 426                                 duparg2("to", *argv);
 427                         addr = *argv;
 428                 }
 429                 argc--; argv++;
 430         }
 431
 432         if (d == NULL || addr == NULL) {
 433                 fprintf(stderr, "Device and address are required arguments.\n");
 434                 return -1;
 435         }
 436
 437         /* Assume self */
 438         if (!(req.ndm.ndm_flags&(NTF_SELF|NTF_MASTER)))
 439                 req.ndm.ndm_flags |= NTF_SELF;
 440
 441         /* Assume permanent */
 442         if (!(req.ndm.ndm_state&(NUD_PERMANENT|NUD_REACHABLE)))
 443                 req.ndm.ndm_state |= NUD_PERMANENT;
 444
 445         if (sscanf(addr, "%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
 446                    abuf, abuf+1, abuf+2,
 447                    abuf+3, abuf+4, abuf+5) != 6) {
 448                 fprintf(stderr, "Invalid mac address %s\n", addr);
 449                 return -1;
 450         }
 451
 452         addattr_l(&req.n, sizeof(req), NDA_LLADDR, abuf, ETH_ALEN);
 453         if (dst_ok)
 454                 addattr_l(&req.n, sizeof(req), NDA_DST, &dst.data, dst.bytelen);
 455
 456         if (vid >= 0)
 457                 addattr16(&req.n, sizeof(req), NDA_VLAN, vid);
 458
 459         if (port) {
 460                 unsigned short dport;
 461
 462                 dport = htons((unsigned short)port);
 463                 addattr16(&req.n, sizeof(req), NDA_PORT, dport);
 464         }
 465         if (vni != ~0)
 466                 addattr32(&req.n, sizeof(req), NDA_VNI, vni);
 467         if (via)
 468                 addattr32(&req.n, sizeof(req), NDA_IFINDEX, via);
 469
 470         req.ndm.ndm_ifindex = ll_name_to_index(d);
 471         if (!req.ndm.ndm_ifindex)
 472                 return nodev(d);
 473
 474         if (rtnl_talk(&rth, &req.n, NULL) < 0)
 475                 return -1;
 476
 477         return 0;
 478 }
 479
 480 int do_fdb(int argc, char **argv)
 481 {
 482         ll_init_map(&rth);
 483
 484         if (argc > 0) {
 485                 if (matches(*argv, "add") == 0)
 486                         return fdb_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_EXCL, argc-1, argv+1);
 487                 if (matches(*argv, "append") == 0)
 488                         return fdb_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_APPEND, argc-1, argv+1);
 489                 if (matches(*argv, "replace") == 0)
 490                         return fdb_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_REPLACE, argc-1, argv+1);
 491                 if (matches(*argv, "delete") == 0)
 492                         return fdb_modify(RTM_DELNEIGH, 0, argc-1, argv+1);
 493                 if (matches(*argv, "show") == 0 ||
 494                     matches(*argv, "lst") == 0 ||
 495                     matches(*argv, "list") == 0)
 496                         return fdb_show(argc-1, argv+1);
 497                 if (matches(*argv, "help") == 0)
 498                         usage();
 499         } else
 500                 return fdb_show(0, NULL);
 501
 502         fprintf(stderr, "Command \"%s\" is unknown, try \"bridge fdb help\".\n", *argv);
 503         exit(-1);
 504 }