ip/ipneigh.c

   1 /*
   2  * ipneigh.c            "ip neigh".
   3  *
   4  *              This program is free software; you can redistribute it and/or
   5  *              modify it under the terms of the GNU General Public License
   6  *              as published by the Free Software Foundation; either version
   7  *              2 of the License, or (at your option) any later version.
   8  *
   9  * Authors:     Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
  10  *
  11  */
  12
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <unistd.h>
  16 #include <fcntl.h>
  17 #include <string.h>
  18 #include <sys/time.h>
  19 #include <sys/socket.h>
  20 #include <netinet/in.h>
  21 #include <netinet/ip.h>
  22
  23 #include "rt_names.h"
  24 #include "utils.h"
  25 #include "ip_common.h"
  26 #include "json_print.h"
  27
  28 #define NUD_VALID       (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
  29 #define MAX_ROUNDS      10
  30
  31 static struct
  32 {
  33         int family;
  34         int index;
  35         int state;
  36         int unused_only;
  37         inet_prefix pfx;
  38         int flushed;
  39         char *flushb;
  40         int flushp;
  41         int flushe;
  42         int master;
  43 } filter;
  44
  45 static void usage(void) __attribute__((noreturn));
  46
  47 static void usage(void)
  48 {
  49         fprintf(stderr, "Usage: ip neigh { add | del | change | replace }\n"
  50                         "                { ADDR [ lladdr LLADDR ] [ nud STATE ] | proxy ADDR } [ dev DEV ]\n");
  51         fprintf(stderr, "       ip neigh { show | flush } [ proxy ] [ to PREFIX ] [ dev DEV ] [ nud STATE ]\n");
  52         fprintf(stderr, "                                 [ vrf NAME ]\n\n");
  53         fprintf(stderr, "STATE := { permanent | noarp | stale | reachable | none |\n"
  54                         "           incomplete | delay | probe | failed }\n");
  55         exit(-1);
  56 }
  57
  58 static int nud_state_a2n(unsigned int *state, const char *arg)
  59 {
  60         if (matches(arg, "permanent") == 0)
  61                 *state = NUD_PERMANENT;
  62         else if (matches(arg, "reachable") == 0)
  63                 *state = NUD_REACHABLE;
  64         else if (strcmp(arg, "noarp") == 0)
  65                 *state = NUD_NOARP;
  66         else if (strcmp(arg, "none") == 0)
  67                 *state = NUD_NONE;
  68         else if (strcmp(arg, "stale") == 0)
  69                 *state = NUD_STALE;
  70         else if (strcmp(arg, "incomplete") == 0)
  71                 *state = NUD_INCOMPLETE;
  72         else if (strcmp(arg, "delay") == 0)
  73                 *state = NUD_DELAY;
  74         else if (strcmp(arg, "probe") == 0)
  75                 *state = NUD_PROBE;
  76         else if (matches(arg, "failed") == 0)
  77                 *state = NUD_FAILED;
  78         else {
  79                 if (get_unsigned(state, arg, 0))
  80                         return -1;
  81                 if (*state >= 0x100 || (*state&((*state)-1)))
  82                         return -1;
  83         }
  84         return 0;
  85 }
  86
  87 static int flush_update(void)
  88 {
  89         if (rtnl_send_check(&rth, filter.flushb, filter.flushp) < 0) {
  90                 perror("Failed to send flush request");
  91                 return -1;
  92         }
  93         filter.flushp = 0;
  94         return 0;
  95 }
  96
  97
  98 static int ipneigh_modify(int cmd, int flags, int argc, char **argv)
  99 {
 100         struct {
 101                 struct nlmsghdr n;
 102                 struct ndmsg            ndm;
 103                 char                    buf[256];
 104         } req = {
 105                 .n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ndmsg)),
 106                 .n.nlmsg_flags = NLM_F_REQUEST | flags,
 107                 .n.nlmsg_type = cmd,
 108                 .ndm.ndm_family = preferred_family,
 109                 .ndm.ndm_state = NUD_PERMANENT,
 110         };
 111         char  *dev = NULL;
 112         int dst_ok = 0;
 113         int dev_ok = 0;
 114         int lladdr_ok = 0;
 115         char *lla = NULL;
 116         inet_prefix dst;
 117
 118         while (argc > 0) {
 119                 if (matches(*argv, "lladdr") == 0) {
 120                         NEXT_ARG();
 121                         if (lladdr_ok)
 122                                 duparg("lladdr", *argv);
 123                         lla = *argv;
 124                         lladdr_ok = 1;
 125                 } else if (strcmp(*argv, "nud") == 0) {
 126                         unsigned int state;
 127
 128                         NEXT_ARG();
 129                         if (nud_state_a2n(&state, *argv))
 130                                 invarg("nud state is bad", *argv);
 131                         req.ndm.ndm_state = state;
 132                 } else if (matches(*argv, "proxy") == 0) {
 133                         NEXT_ARG();
 134                         if (matches(*argv, "help") == 0)
 135                                 usage();
 136                         if (dst_ok)
 137                                 duparg("address", *argv);
 138                         get_addr(&dst, *argv, preferred_family);
 139                         dst_ok = 1;
 140                         dev_ok = 1;
 141                         req.ndm.ndm_flags |= NTF_PROXY;
 142                 } else if (strcmp(*argv, "dev") == 0) {
 143                         NEXT_ARG();
 144                         dev = *argv;
 145                         dev_ok = 1;
 146                 } else {
 147                         if (strcmp(*argv, "to") == 0) {
 148                                 NEXT_ARG();
 149                         }
 150                         if (matches(*argv, "help") == 0) {
 151                                 NEXT_ARG();
 152                         }
 153                         if (dst_ok)
 154                                 duparg2("to", *argv);
 155                         get_addr(&dst, *argv, preferred_family);
 156                         dst_ok = 1;
 157                 }
 158                 argc--; argv++;
 159         }
 160         if (!dev_ok || !dst_ok || dst.family == AF_UNSPEC) {
 161                 fprintf(stderr, "Device and destination are required arguments.\n");
 162                 exit(-1);
 163         }
 164         req.ndm.ndm_family = dst.family;
 165         if (addattr_l(&req.n, sizeof(req), NDA_DST, &dst.data, dst.bytelen) < 0)
 166                 return -1;
 167
 168         if (lla && strcmp(lla, "null")) {
 169                 char llabuf[20];
 170                 int l;
 171
 172                 l = ll_addr_a2n(llabuf, sizeof(llabuf), lla);
 173                 if (l < 0)
 174                         return -1;
 175
 176                 if (addattr_l(&req.n, sizeof(req), NDA_LLADDR, llabuf, l) < 0)
 177                         return -1;
 178         }
 179
 180         ll_init_map(&rth);
 181
 182         if (dev) {
 183                 req.ndm.ndm_ifindex = ll_name_to_index(dev);
 184                 if (!req.ndm.ndm_ifindex)
 185                         return nodev(dev);
 186         }
 187
 188         if (rtnl_talk(&rth, &req.n, NULL) < 0)
 189                 exit(2);
 190
 191         return 0;
 192 }
 193
 194 static void print_cacheinfo(const struct nda_cacheinfo *ci)
 195 {
 196         static int hz;
 197
 198         if (!hz)
 199                 hz = get_user_hz();
 200
 201         if (ci->ndm_refcnt)
 202                 print_uint(PRINT_ANY, "refcnt",
 203                                 " ref %u", ci->ndm_refcnt);
 204
 205         print_uint(PRINT_ANY, "used", " used %u", ci->ndm_used / hz);
 206         print_uint(PRINT_ANY, "confirmed", "/%u", ci->ndm_confirmed / hz);
 207         print_uint(PRINT_ANY, "updated", "/%u", ci->ndm_updated / hz);
 208 }
 209
 210 static void print_neigh_state(unsigned int nud)
 211 {
 212
 213         open_json_array(PRINT_JSON,
 214                         is_json_context() ?  "state" : "");
 215
 216 #define PRINT_FLAG(f)                                           \
 217         if (nud & NUD_##f) {                                    \
 218                 nud &= ~NUD_##f;                                \
 219                 print_string(PRINT_ANY, NULL, " %s", #f);       \
 220         }
 221
 222         PRINT_FLAG(INCOMPLETE);
 223         PRINT_FLAG(REACHABLE);
 224         PRINT_FLAG(STALE);
 225         PRINT_FLAG(DELAY);
 226         PRINT_FLAG(PROBE);
 227         PRINT_FLAG(FAILED);
 228         PRINT_FLAG(NOARP);
 229         PRINT_FLAG(PERMANENT);
 230 #undef PRINT_FLAG
 231
 232         close_json_array(PRINT_JSON, NULL);
 233 }
 234
 235 int print_neigh(const struct sockaddr_nl *who, struct nlmsghdr *n, void *arg)
 236 {
 237         FILE *fp = (FILE *)arg;
 238         struct ndmsg *r = NLMSG_DATA(n);
 239         int len = n->nlmsg_len;
 240         struct rtattr *tb[NDA_MAX+1];
 241         static int logit = 1;
 242
 243         if (n->nlmsg_type != RTM_NEWNEIGH && n->nlmsg_type != RTM_DELNEIGH &&
 244             n->nlmsg_type != RTM_GETNEIGH) {
 245                 fprintf(stderr, "Not RTM_NEWNEIGH: %08x %08x %08x\n",
 246                         n->nlmsg_len, n->nlmsg_type, n->nlmsg_flags);
 247
 248                 return 0;
 249         }
 250         len -= NLMSG_LENGTH(sizeof(*r));
 251         if (len < 0) {
 252                 fprintf(stderr, "BUG: wrong nlmsg len %d\n", len);
 253                 return -1;
 254         }
 255
 256         if (filter.flushb && n->nlmsg_type != RTM_NEWNEIGH)
 257                 return 0;
 258
 259         if (filter.family && filter.family != r->ndm_family)
 260                 return 0;
 261         if (filter.index && filter.index != r->ndm_ifindex)
 262                 return 0;
 263         if (!(filter.state&r->ndm_state) &&
 264             !(r->ndm_flags & NTF_PROXY) &&
 265             (r->ndm_state || !(filter.state&0x100)) &&
 266             (r->ndm_family != AF_DECnet))
 267                 return 0;
 268
 269         if (filter.master && !(n->nlmsg_flags & NLM_F_DUMP_FILTERED)) {
 270                 if (logit) {
 271                         logit = 0;
 272                         fprintf(fp,
 273                                 "\nWARNING: Kernel does not support filtering by master device\n\n");
 274                 }
 275         }
 276
 277         parse_rtattr(tb, NDA_MAX, NDA_RTA(r), n->nlmsg_len - NLMSG_LENGTH(sizeof(*r)));
 278
 279         if (inet_addr_match_rta(&filter.pfx, tb[NDA_DST]))
 280                 return 0;
 281
 282         if (filter.unused_only && tb[NDA_CACHEINFO]) {
 283                 struct nda_cacheinfo *ci = RTA_DATA(tb[NDA_CACHEINFO]);
 284
 285                 if (ci->ndm_refcnt)
 286                         return 0;
 287         }
 288
 289         if (filter.flushb) {
 290                 struct nlmsghdr *fn;
 291
 292                 if (NLMSG_ALIGN(filter.flushp) + n->nlmsg_len > filter.flushe) {
 293                         if (flush_update())
 294                                 return -1;
 295                 }
 296                 fn = (struct nlmsghdr *)(filter.flushb + NLMSG_ALIGN(filter.flushp));
 297                 memcpy(fn, n, n->nlmsg_len);
 298                 fn->nlmsg_type = RTM_DELNEIGH;
 299                 fn->nlmsg_flags = NLM_F_REQUEST;
 300                 fn->nlmsg_seq = ++rth.seq;
 301                 filter.flushp = (((char *)fn) + n->nlmsg_len) - filter.flushb;
 302                 filter.flushed++;
 303                 if (show_stats < 2)
 304                         return 0;
 305         }
 306
 307         open_json_object(NULL);
 308         if (n->nlmsg_type == RTM_DELNEIGH)
 309                 print_bool(PRINT_ANY, "deleted", "Deleted ", true);
 310         else if (n->nlmsg_type == RTM_GETNEIGH)
 311                 print_null(PRINT_ANY, "miss", "%s ", "miss");
 312
 313         if (tb[NDA_DST]) {
 314                 const char *dst;
 315
 316                 dst = format_host_rta(r->ndm_family, tb[NDA_DST]);
 317                 print_color_string(PRINT_ANY,
 318                                    ifa_family_color(r->ndm_family),
 319                                    "dst", "%s ", dst);
 320         }
 321
 322         if (!filter.index && r->ndm_ifindex) {
 323                 if (!is_json_context())
 324                         fprintf(fp, "dev ");
 325
 326                 print_color_string(PRINT_ANY, COLOR_IFNAME,
 327                                    "dev", "%s ",
 328                                    ll_index_to_name(r->ndm_ifindex));
 329         }
 330
 331         if (tb[NDA_LLADDR]) {
 332                 const char *lladdr;
 333                 SPRINT_BUF(b1);
 334
 335                 lladdr = ll_addr_n2a(RTA_DATA(tb[NDA_LLADDR]),
 336                                      RTA_PAYLOAD(tb[NDA_LLADDR]),
 337                                      ll_index_to_type(r->ndm_ifindex),
 338                                      b1, sizeof(b1));
 339
 340                 if (!is_json_context())
 341                         fprintf(fp, "lladdr ");
 342
 343                 print_color_string(PRINT_ANY, COLOR_MAC,
 344                                    "lladdr", "%s", lladdr);
 345         }
 346
 347         if (r->ndm_flags & NTF_ROUTER)
 348                 print_null(PRINT_ANY, "router", " %s", "router");
 349
 350         if (r->ndm_flags & NTF_PROXY)
 351                 print_null(PRINT_ANY, "proxy", " %s", "proxy");
 352
 353         if (show_stats) {
 354                 if (tb[NDA_CACHEINFO])
 355                         print_cacheinfo(RTA_DATA(tb[NDA_CACHEINFO]));
 356
 357                 if (tb[NDA_PROBES])
 358                         print_uint(PRINT_ANY, "probes", " probes %u",
 359                                    rta_getattr_u32(tb[NDA_PROBES]));
 360         }
 361
 362         if (r->ndm_state)
 363                 print_neigh_state(r->ndm_state);
 364
 365         print_string(PRINT_FP, NULL, "\n", "");
 366         close_json_object();
 367         fflush(stdout);
 368
 369         return 0;
 370 }
 371
 372 void ipneigh_reset_filter(int ifindex)
 373 {
 374         memset(&filter, 0, sizeof(filter));
 375         filter.state = ~0;
 376         filter.index = ifindex;
 377 }
 378
 379 static int do_show_or_flush(int argc, char **argv, int flush)
 380 {
 381         struct {
 382                 struct nlmsghdr n;
 383                 struct ndmsg            ndm;
 384                 char                    buf[256];
 385         } req = {
 386                 .n.nlmsg_type = RTM_GETNEIGH,
 387                 .n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ndmsg)),
 388         };
 389         char *filter_dev = NULL;
 390         int state_given = 0;
 391
 392         ipneigh_reset_filter(0);
 393
 394         if (!filter.family)
 395                 filter.family = preferred_family;
 396
 397         if (flush) {
 398                 if (argc <= 0) {
 399                         fprintf(stderr, "Flush requires arguments.\n");
 400                         return -1;
 401                 }
 402                 filter.state = ~(NUD_PERMANENT|NUD_NOARP);
 403         } else
 404                 filter.state = 0xFF & ~NUD_NOARP;
 405
 406         while (argc > 0) {
 407                 if (strcmp(*argv, "dev") == 0) {
 408                         NEXT_ARG();
 409                         if (filter_dev)
 410                                 duparg("dev", *argv);
 411                         filter_dev = *argv;
 412                 } else if (strcmp(*argv, "master") == 0) {
 413                         int ifindex;
 414
 415                         NEXT_ARG();
 416                         ifindex = ll_name_to_index(*argv);
 417                         if (!ifindex)
 418                                 invarg("Device does not exist\n", *argv);
 419                         addattr32(&req.n, sizeof(req), NDA_MASTER, ifindex);
 420                         filter.master = ifindex;
 421                 } else if (strcmp(*argv, "vrf") == 0) {
 422                         int ifindex;
 423
 424                         NEXT_ARG();
 425                         ifindex = ll_name_to_index(*argv);
 426                         if (!ifindex)
 427                                 invarg("Not a valid VRF name\n", *argv);
 428                         if (!name_is_vrf(*argv))
 429                                 invarg("Not a valid VRF name\n", *argv);
 430                         addattr32(&req.n, sizeof(req), NDA_MASTER, ifindex);
 431                         filter.master = ifindex;
 432                 } else if (strcmp(*argv, "unused") == 0) {
 433                         filter.unused_only = 1;
 434                 } else if (strcmp(*argv, "nud") == 0) {
 435                         unsigned int state;
 436
 437                         NEXT_ARG();
 438                         if (!state_given) {
 439                                 state_given = 1;
 440                                 filter.state = 0;
 441                         }
 442                         if (nud_state_a2n(&state, *argv)) {
 443                                 if (strcmp(*argv, "all") != 0)
 444                                         invarg("nud state is bad", *argv);
 445                                 state = ~0;
 446                                 if (flush)
 447                                         state &= ~NUD_NOARP;
 448                         }
 449                         if (state == 0)
 450                                 state = 0x100;
 451                         filter.state |= state;
 452                 } else if (strcmp(*argv, "proxy") == 0)
 453                         req.ndm.ndm_flags = NTF_PROXY;
 454                 else {
 455                         if (strcmp(*argv, "to") == 0) {
 456                                 NEXT_ARG();
 457                         }
 458                         if (matches(*argv, "help") == 0)
 459                                 usage();
 460                         if (get_prefix(&filter.pfx, *argv, filter.family))
 461                                 invarg("to value is invalid\n", *argv);
 462                         if (filter.family == AF_UNSPEC)
 463                                 filter.family = filter.pfx.family;
 464                 }
 465                 argc--; argv++;
 466         }
 467
 468         ll_init_map(&rth);
 469
 470         if (filter_dev) {
 471                 filter.index = ll_name_to_index(filter_dev);
 472                 if (!filter.index)
 473                         return nodev(filter_dev);
 474                 addattr32(&req.n, sizeof(req), NDA_IFINDEX, filter.index);
 475         }
 476
 477         req.ndm.ndm_family = filter.family;
 478
 479         if (flush) {
 480                 int round = 0;
 481                 char flushb[4096-512];
 482
 483                 filter.flushb = flushb;
 484                 filter.flushp = 0;
 485                 filter.flushe = sizeof(flushb);
 486
 487                 while (round < MAX_ROUNDS) {
 488                         if (rtnl_dump_request_n(&rth, &req.n) < 0) {
 489                                 perror("Cannot send dump request");
 490                                 exit(1);
 491                         }
 492                         filter.flushed = 0;
 493                         if (rtnl_dump_filter(&rth, print_neigh, stdout) < 0) {
 494                                 fprintf(stderr, "Flush terminated\n");
 495                                 exit(1);
 496                         }
 497                         if (filter.flushed == 0) {
 498                                 if (show_stats) {
 499                                         if (round == 0)
 500                                                 printf("Nothing to flush.\n");
 501                                         else
 502                                                 printf("*** Flush is complete after %d round%s ***\n", round, round > 1?"s":"");
 503                                 }
 504                                 fflush(stdout);
 505                                 return 0;
 506                         }
 507                         round++;
 508                         if (flush_update() < 0)
 509                                 exit(1);
 510                         if (show_stats) {
 511                                 printf("\n*** Round %d, deleting %d entries ***\n", round, filter.flushed);
 512                                 fflush(stdout);
 513                         }
 514                         filter.state &= ~NUD_FAILED;
 515                 }
 516                 printf("*** Flush not complete bailing out after %d rounds\n",
 517                         MAX_ROUNDS);
 518                 return 1;
 519         }
 520
 521         if (rtnl_dump_request_n(&rth, &req.n) < 0) {
 522                 perror("Cannot send dump request");
 523                 exit(1);
 524         }
 525
 526         new_json_obj(json);
 527         if (rtnl_dump_filter(&rth, print_neigh, stdout) < 0) {
 528                 fprintf(stderr, "Dump terminated\n");
 529                 exit(1);
 530         }
 531         delete_json_obj();
 532
 533         return 0;
 534 }
 535
 536 int do_ipneigh(int argc, char **argv)
 537 {
 538         if (argc > 0) {
 539                 if (matches(*argv, "add") == 0)
 540                         return ipneigh_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_EXCL, argc-1, argv+1);
 541                 if (matches(*argv, "change") == 0 ||
 542                     strcmp(*argv, "chg") == 0)
 543                         return ipneigh_modify(RTM_NEWNEIGH, NLM_F_REPLACE, argc-1, argv+1);
 544                 if (matches(*argv, "replace") == 0)
 545                         return ipneigh_modify(RTM_NEWNEIGH, NLM_F_CREATE|NLM_F_REPLACE, argc-1, argv+1);
 546                 if (matches(*argv, "delete") == 0)
 547                         return ipneigh_modify(RTM_DELNEIGH, 0, argc-1, argv+1);
 548                 if (matches(*argv, "get") == 0) {
 549                         fprintf(stderr, "Sorry, \"neigh get\" is not implemented :-(\n");
 550                         return -1;
 551                 }
 552                 if (matches(*argv, "show") == 0 ||
 553                     matches(*argv, "lst") == 0 ||
 554                     matches(*argv, "list") == 0)
 555                         return do_show_or_flush(argc-1, argv+1, 0);
 556                 if (matches(*argv, "flush") == 0)
 557                         return do_show_or_flush(argc-1, argv+1, 1);
 558                 if (matches(*argv, "help") == 0)
 559                         usage();
 560         } else
 561                 return do_show_or_flush(0, NULL, 0);
 562
 563         fprintf(stderr, "Command \"%s\" is unknown, try \"ip neigh help\".\n", *argv);
 564         exit(-1);
 565 }