iface.c 15.2 KB
Newer Older
1
/*
2
 *	BIRD -- Management of Interfaces and Neighbor Cache
3
 *
4
 *	(c) 1998--2000 Martin Mares <mj@ucw.cz>
5 6 7 8
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

Martin Mareš's avatar
Martin Mareš committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/**
 * DOC: Interfaces
 *
 * The interface module keeps track of all network interfaces in the
 * system and their addresses.
 *
 * Each interface is represented by an &iface structure which carries
 * interface capability flags (%IF_MULTIACCESS, %IF_BROADCAST etc.),
 * MTU, interface name and index and finally a linked list of network
 * prefixes assigned to the interface, each one represented by
 * struct &ifa.
 *
 * The interface module keeps a `soft-up' state for each &iface which
 * is a conjunction of link being up, the interface being of a `sane'
 * type and at least one IP address assigned to it.
 */

26
#undef LOCAL_DEBUG
27

28 29
#include "nest/bird.h"
#include "nest/iface.h"
30
#include "nest/protocol.h"
31
#include "nest/cli.h"
32
#include "lib/resource.h"
33
#include "lib/string.h"
34
#include "conf/conf.h"
35 36 37

static pool *if_pool;

38 39
static void auto_router_id(void);

40 41
list iface_list;

Martin Mareš's avatar
Martin Mareš committed
42 43 44 45 46 47
/**
 * ifa_dump - dump interface address
 * @a: interface address descriptor
 *
 * This function dumps contents of an &ifa to the debug output.
 */
48 49 50
void
ifa_dump(struct ifa *a)
{
51
  debug("\t%I, net %I/%-2d bc %I -> %I%s%s%s\n", a->ip, a->prefix, a->pxlen, a->brd, a->opposite,
52
	(a->flags & IF_UP) ? "" : " DOWN",
53 54
	(a->flags & IA_PRIMARY) ? "" : " SEC",
	(a->flags & IA_UNNUMBERED) ? " UNNUM" : "");
55 56
}

Martin Mareš's avatar
Martin Mareš committed
57 58 59 60 61 62 63
/**
 * if_dump - dump interface
 * @i: interface to dump
 *
 * This function dumps all information associated with a given
 * network interface to the debug output.
 */
64 65 66
void
if_dump(struct iface *i)
{
67 68
  struct ifa *a;

69 70 71 72 73
  debug("IF%d: %s", i->index, i->name);
  if (i->flags & IF_ADMIN_DOWN)
    debug(" ADMIN-DOWN");
  if (i->flags & IF_UP)
    debug(" UP");
Martin Mareš's avatar
Martin Mareš committed
74 75 76 77
  else
    debug(" DOWN");
  if (i->flags & IF_LINK_UP)
    debug(" LINK-UP");
78 79 80 81 82 83 84 85 86 87
  if (i->flags & IF_MULTIACCESS)
    debug(" MA");
  if (i->flags & IF_BROADCAST)
    debug(" BC");
  if (i->flags & IF_MULTICAST)
    debug(" MC");
  if (i->flags & IF_LOOPBACK)
    debug(" LOOP");
  if (i->flags & IF_IGNORE)
    debug(" IGN");
88 89
  if (i->flags & IF_TMP_DOWN)
    debug(" TDOWN");
90
  debug(" MTU=%d\n", i->mtu);
91 92 93 94 95
  WALK_LIST(a, i->addrs)
    {
      ifa_dump(a);
      ASSERT((a != i->addr) == !(a->flags & IA_PRIMARY));
    }
96 97
}

Martin Mareš's avatar
Martin Mareš committed
98 99 100 101 102 103
/**
 * if_dump_all - dump all interfaces
 *
 * This function dumps information about all known network
 * interfaces to the debug output.
 */
104 105 106 107 108
void
if_dump_all(void)
{
  struct iface *i;

109
  debug("Known network interfaces:\n");
110 111
  WALK_LIST(i, iface_list)
    if_dump(i);
112
  debug("Router ID: %08x\n", config->router_id);
113 114
}

115 116
static inline unsigned
if_what_changed(struct iface *i, struct iface *j)
117
{
118 119 120 121 122 123 124 125 126 127 128
  unsigned c;

  if (((i->flags ^ j->flags) & ~(IF_UP | IF_ADMIN_DOWN | IF_UPDATED | IF_LINK_UP | IF_TMP_DOWN | IF_JUST_CREATED))
      || i->index != j->index)
    return IF_CHANGE_TOO_MUCH;
  c = 0;
  if ((i->flags ^ j->flags) & IF_UP)
    c |= (i->flags & IF_UP) ? IF_CHANGE_DOWN : IF_CHANGE_UP;
  if (i->mtu != j->mtu)
    c |= IF_CHANGE_MTU;
  return c;
129 130 131
}

static inline void
132
if_copy(struct iface *to, struct iface *from)
133
{
134
  to->flags = from->flags | (to->flags & IF_TMP_DOWN);
135
  to->mtu = from->mtu;
136 137
}

138 139 140 141 142 143 144 145 146 147 148 149 150 151
static inline void
ifa_send_notify(struct proto *p, unsigned c, struct ifa *a)
{
  if (p->ifa_notify)
    {
      if (p->debug & D_IFACES)
	log(L_TRACE "%s < %s address %I/%d on interface %s %s",
	    p->name, (a->flags & IA_PRIMARY) ? "primary" : "secondary",
	    a->prefix, a->pxlen, a->iface->name,
	    (c & IF_CHANGE_UP) ? "added" : "removed");
      p->ifa_notify(p, c, a);
    }
}

152 153
static void
ifa_notify_change(unsigned c, struct ifa *a)
154
{
155
  struct proto *p;
156

157
  DBG("IFA change notification (%x) for %s:%I\n", c, a->iface->name, a->ip);
158
  WALK_LIST(p, active_proto_list)
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    ifa_send_notify(p, c, a);
}

static inline void
if_send_notify(struct proto *p, unsigned c, struct iface *i)
{
  if (p->if_notify)
    {
      if (p->debug & D_IFACES)
	log(L_TRACE "%s < interface %s %s", p->name, i->name,
	    (c & IF_CHANGE_UP) ? "goes up" :
	    (c & IF_CHANGE_DOWN) ? "goes down" :
	    (c & IF_CHANGE_MTU) ? "changes MTU" :
	    (c & IF_CHANGE_CREATE) ? "created" :
	    "sends unknown event");
      p->if_notify(p, c, i);
    }
176 177 178
}

static void
179
if_notify_change(unsigned c, struct iface *i)
180
{
181
  struct proto *p;
182
  struct ifa *a;
183

184 185 186 187 188 189
  if (i->flags & IF_JUST_CREATED)
    {
      i->flags &= ~IF_JUST_CREATED;
      c |= IF_CHANGE_CREATE | IF_CHANGE_MTU;
    }

190
  DBG("Interface change notification (%x) for %s\n", c, i->name);
191
#ifdef LOCAL_DEBUG
192
  if_dump(i);
193
#endif
194 195

  if (c & IF_CHANGE_UP)
196 197 198 199 200 201 202
    neigh_if_up(i);
  if (c & IF_CHANGE_DOWN)
    WALK_LIST(a, i->addrs)
      {
	a->flags = (i->flags & ~IA_FLAGS) | (a->flags & IA_FLAGS);
	ifa_notify_change(IF_CHANGE_DOWN, a);
      }
203

204
  WALK_LIST(p, active_proto_list)
205
    if_send_notify(p, c, i);
206

207 208 209 210 211 212
  if (c & IF_CHANGE_UP)
    WALK_LIST(a, i->addrs)
      {
	a->flags = (i->flags & ~IA_FLAGS) | (a->flags & IA_FLAGS);
	ifa_notify_change(IF_CHANGE_UP, a);
      }
213
  if (c & IF_CHANGE_DOWN)
214
    neigh_if_down(i);
215 216
}

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
static unsigned
if_recalc_flags(struct iface *i, unsigned flags)
{
  if ((flags & (IF_ADMIN_DOWN | IF_TMP_DOWN)) ||
      !(flags & IF_LINK_UP) ||
      !i->addr)
    flags &= ~IF_UP;
  else
    flags |= IF_UP;
  return flags;
}

static void
if_change_flags(struct iface *i, unsigned flags)
{
  unsigned of = i->flags;

  i->flags = if_recalc_flags(i, flags);
  if ((i->flags ^ of) & IF_UP)
    if_notify_change((i->flags & IF_UP) ? IF_CHANGE_UP : IF_CHANGE_DOWN, i);
}

Martin Mareš's avatar
Martin Mareš committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
/**
 * if_update - update interface status
 * @new: new interface status
 *
 * if_update() is called by the low-level platform dependent code
 * whenever it notices an interface change.
 *
 * There exist two types of interface updates: synchronous and asynchronous
 * ones. In the synchronous case, the low-level code calls if_start_update(),
 * scans all interfaces reported by the OS, uses if_update() and ifa_update()
 * to pass them to the core and then it finishes the update sequence by
 * calling if_end_update(). When working asynchronously, the sysdep code
 * calls if_update() and ifa_update() whenever it notices a change.
 *
 * if_update() will automatically notify all other modules about the change.
 */
255
struct iface *
256 257 258
if_update(struct iface *new)
{
  struct iface *i;
259
  unsigned c;
260 261 262 263

  WALK_LIST(i, iface_list)
    if (!strcmp(new->name, i->name))
      {
264 265 266 267
	new->addr = i->addr;
	new->flags = if_recalc_flags(new, new->flags);
	c = if_what_changed(i, new);
	if (c & IF_CHANGE_TOO_MUCH)	/* Changed a lot, convert it to down/up */
268
	  {
269
	    DBG("Interface %s changed too much -- forcing down/up transition\n", i->name);
270
	    if_change_flags(i, i->flags | IF_TMP_DOWN);
271
	    rem_node(&i->n);
272 273 274
	    new->addr = i->addr;
	    memcpy(&new->addrs, &i->addrs, sizeof(i->addrs));
	    memcpy(i, new, sizeof(*i));
275
	    goto newif;
276
	  }
277 278 279 280 281
	else if (c)
	  {
	    if_copy(i, new);
	    if_notify_change(c, i);
	  }
282
	i->flags |= IF_UPDATED;
283
	return i;
284
      }
285 286
  i = mb_alloc(if_pool, sizeof(struct iface));
  memcpy(i, new, sizeof(*i));
287
  init_list(&i->addrs);
288
newif:
289
  init_list(&i->neighbors);
290
  i->flags |= IF_UPDATED | IF_TMP_DOWN;		/* Tmp down as we don't have addresses yet */
291
  add_tail(&iface_list, &i->n);
292
  return i;
293 294
}

295 296 297 298
void
if_start_update(void)
{
  struct iface *i;
299
  struct ifa *a;
300 301

  WALK_LIST(i, iface_list)
302 303 304 305 306 307 308 309 310 311 312 313
    {
      i->flags &= ~IF_UPDATED;
      WALK_LIST(a, i->addrs)
	a->flags &= ~IF_UPDATED;
    }
}

void
if_end_partial_update(struct iface *i)
{
  if (i->flags & IF_TMP_DOWN)
    if_change_flags(i, i->flags & ~IF_TMP_DOWN);
314 315
}

316 317 318
void
if_end_update(void)
{
319
  struct iface *i;
320
  struct ifa *a, *b;
321

322 323 324
  if (!config->router_id)
    auto_router_id();

325
  WALK_LIST(i, iface_list)
326 327 328 329 330 331 332 333 334 335 336
    {
      if (!(i->flags & IF_UPDATED))
	if_change_flags(i, (i->flags & ~IF_LINK_UP) | IF_ADMIN_DOWN);
      else
	{
	  WALK_LIST_DELSAFE(a, b, i->addrs)
	    if (!(a->flags & IF_UPDATED))
	      ifa_delete(a);
	  if_end_partial_update(i);
	}
    }
337 338
}

Martin Mareš's avatar
Martin Mareš committed
339 340 341 342 343 344 345
/**
 * if_feed_baby - advertise interfaces to a new protocol
 * @p: protocol to feed
 *
 * When a new protocol starts, this function sends it a series
 * of notifications about all existing interfaces.
 */
346 347 348 349
void
if_feed_baby(struct proto *p)
{
  struct iface *i;
350
  struct ifa *a;
351

352
  if (!p->if_notify && !p->ifa_notify)	/* shortcut */
353
    return;
354
  DBG("Announcing interfaces to new protocol %s\n", p->name);
355
  WALK_LIST(i, iface_list)
356
    {
357 358
      if_send_notify(p, IF_CHANGE_CREATE | ((i->flags & IF_UP) ? IF_CHANGE_UP : 0), i);
      if (i->flags & IF_UP)
359
	WALK_LIST(a, i->addrs)
360
	  ifa_send_notify(p, IF_CHANGE_CREATE | IF_CHANGE_UP, a);
361
    }
362 363
}

Martin Mareš's avatar
Martin Mareš committed
364 365 366 367 368 369 370 371
/**
 * if_find_by_index - find interface by ifindex
 * @idx: ifindex
 *
 * This function finds an &iface structure corresponding to an interface
 * of the given index @idx. Returns a pointer to the structure or %NULL
 * if no such structure exists.
 */
372 373 374 375 376 377 378 379 380 381 382
struct iface *
if_find_by_index(unsigned idx)
{
  struct iface *i;

  WALK_LIST(i, iface_list)
    if (i->index == idx)
      return i;
  return NULL;
}

Martin Mareš's avatar
Martin Mareš committed
383 384 385 386 387 388 389 390
/**
 * if_find_by_name - find interface by name
 * @name: interface name
 *
 * This function finds an &iface structure corresponding to an interface
 * of the given name @name. Returns a pointer to the structure or %NULL
 * if no such structure exists.
 */
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
struct iface *
if_find_by_name(char *name)
{
  struct iface *i;

  WALK_LIST(i, iface_list)
    if (!strcmp(i->name, name))
      return i;
  return NULL;
}

static int
ifa_recalc_primary(struct iface *i)
{
  struct ifa *a, *b = NULL;
  int res;

  WALK_LIST(a, i->addrs)
    {
      if (!(a->flags & IA_SECONDARY) && (!b || a->scope > b->scope))
	b = a;
      a->flags &= ~IA_PRIMARY;
    }
  res = (b != i->addr);
  i->addr = b;
  if (b)
    {
      b->flags |= IA_PRIMARY;
      rem_node(&b->n);
      add_head(&i->addrs, &b->n);
    }
  return res;
}

Martin Mareš's avatar
Martin Mareš committed
425 426 427 428 429 430 431 432
/**
 * ifa_update - update interface address
 * @a: new interface address
 *
 * This function adds address information to a network
 * interface. It's called by the platform dependent code during
 * the interface update process described under if_update().
 */
433 434 435 436 437 438 439 440 441 442 443 444 445
struct ifa *
ifa_update(struct ifa *a)
{
  struct iface *i = a->iface;
  struct ifa *b;

  WALK_LIST(b, i->addrs)
    if (ipa_equal(b->ip, a->ip))
      {
	if (ipa_equal(b->prefix, a->prefix) &&
	    b->pxlen == a->pxlen &&
	    ipa_equal(b->brd, a->brd) &&
	    ipa_equal(b->opposite, a->opposite) &&
446 447
	    b->scope == a->scope &&
	    !((b->flags ^ a->flags) & IA_UNNUMBERED))
448 449 450 451 452 453 454
	  {
	    b->flags |= IF_UPDATED;
	    return b;
	  }
	ifa_delete(b);
	break;
      }
455 456 457

  if (!(i->flags & IF_MULTIACCESS) && a->pxlen < BITS_PER_IP_ADDRESS - 2)
    log(L_WARN "Strange prefix length %d for point-to-point interface %s", a->pxlen, i->name);
458
#ifndef IPV6
459 460
  if ((i->flags & IF_BROADCAST) && !ipa_nonzero(a->brd))
    log(L_ERR "Missing broadcast address for interface %s", i->name);
461
#endif
462

463 464 465 466 467 468 469 470 471 472 473
  b = mb_alloc(if_pool, sizeof(struct ifa));
  memcpy(b, a, sizeof(struct ifa));
  add_tail(&i->addrs, &b->n);
  b->flags = (i->flags & ~IA_FLAGS) | (a->flags & IA_FLAGS);
  if ((!i->addr || i->addr->scope < b->scope) && ifa_recalc_primary(i))
    if_change_flags(i, i->flags | IF_TMP_DOWN);
  if (b->flags & IF_UP)
    ifa_notify_change(IF_CHANGE_CREATE | IF_CHANGE_UP, b);
  return b;
}

Martin Mareš's avatar
Martin Mareš committed
474 475 476 477 478 479 480 481
/**
 * ifa_delete - remove interface address
 * @a: interface address
 *
 * This function removes address information from a network
 * interface. It's called by the platform dependent code during
 * the interface update process described under if_update().
 */
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
void
ifa_delete(struct ifa *a)
{
  struct iface *i = a->iface;
  struct ifa *b;

  WALK_LIST(b, i->addrs)
    if (ipa_equal(b->ip, a->ip))
      {
	rem_node(&b->n);
	if (b->flags & IF_UP)
	  {
	    b->flags &= ~IF_UP;
	    ifa_notify_change(IF_CHANGE_DOWN, b);
	  }
	if (b->flags & IA_PRIMARY)
	  {
	    if_change_flags(i, i->flags | IF_TMP_DOWN);
	    ifa_recalc_primary(i);
	  }
	mb_free(b);
503
	return;
504 505 506
      }
}

507
static void
508
auto_router_id(void)
509
{
510
#ifndef IPV6
511 512 513 514
  struct iface *i, *j;

  j = NULL;
  WALK_LIST(i, iface_list)
515
    if ((i->flags & IF_LINK_UP) &&
516
	!(i->flags & (IF_IGNORE | IF_ADMIN_DOWN)) &&
517
	i->addr &&
518
	!(i->addr->flags & IA_UNNUMBERED) &&
519
	(!j || ipa_to_u32(i->addr->ip) < ipa_to_u32(j->addr->ip)))
520
      j = i;
521
  if (!j)
522
    die("Cannot determine router ID (no suitable network interface found), please configure it manually");
523
  log(L_INFO "Guessed router ID %I according to interface %s", j->addr->ip, j->name);
524
  config->router_id = ipa_to_u32(j->addr->ip);
525
#endif
526 527
}

Martin Mareš's avatar
Martin Mareš committed
528 529 530 531 532 533
/**
 * if_init - initialize interface module
 *
 * This function is called during BIRD startup to initialize
 * all data structures of the interface module.
 */
534 535 536 537 538
void
if_init(void)
{
  if_pool = rp_new(&root_pool, "Interfaces");
  init_list(&iface_list);
539
  neigh_init(if_pool);
540
}
541 542 543 544 545 546 547 548 549 550 551 552 553 554

/*
 *	Interface Pattern Lists
 */

struct iface_patt *
iface_patt_match(list *l, struct iface *i)
{
  struct iface_patt *p;

  WALK_LIST(p, *l)
    {
      char *t = p->pattern;
      int ok = 1;
555
      if (t)
556
	{
557 558 559 560 561 562 563
	  if (*t == '-')
	    {
	      t++;
	      ok = 0;
	    }
	  if (!patmatch(t, i->name))
	    continue;
564
	}
565 566 567
      if (!i->addr || !ipa_in_net(i->addr->ip, p->prefix, p->pxlen))
	continue;
      return ok ? p : NULL;
568 569 570 571 572 573 574 575 576 577 578 579 580
    }
  return NULL;
}

int
iface_patts_equal(list *a, list *b, int (*comp)(struct iface_patt *, struct iface_patt *))
{
  struct iface_patt *x, *y;

  x = HEAD(*a);
  y = HEAD(*b);
  while (x->n.next && y->n.next)
    {
581 582 583 584
      if (strcmp(x->pattern, y->pattern) ||
	  !ipa_equal(x->prefix, y->prefix) ||
	  x->pxlen != y->pxlen ||
	  comp && !comp(x, y))
585 586 587 588 589 590
	return 0;
      x = (void *) x->n.next;
      y = (void *) y->n.next;
    }
  return (!x->n.next && !y->n.next);
}
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609

/*
 *  CLI commands.
 */

static void
if_show_addr(struct ifa *a)
{
  byte broad[STD_ADDRESS_P_LENGTH + 16];
  byte opp[STD_ADDRESS_P_LENGTH + 16];

  if (ipa_nonzero(a->brd))
    bsprintf(broad, ", broadcast %I", a->brd);
  else
    broad[0] = 0;
  if (ipa_nonzero(a->opposite))
    bsprintf(opp, ", opposite %I", a->opposite);
  else
    opp[0] = 0;
610
  cli_msg(-1003, "\t%I/%d (%s%s%s, scope %s%s)",
611 612 613
	  a->ip, a->pxlen,
	  (a->flags & IA_PRIMARY) ? "Primary" : (a->flags & IA_SECONDARY) ? "Secondary" : "???",
	  broad, opp,
614 615
	  ip_scope_text(a->scope),
	  (a->flags & IA_UNNUMBERED) ? ", unnumbered" : "");
616 617 618 619 620 621 622 623 624 625 626
}

void
if_show(void)
{
  struct iface *i;
  struct ifa *a;
  char *type;

  WALK_LIST(i, iface_list)
    {
627
      cli_msg(-1001, "%s %s (index=%d)", i->name, (i->flags & IF_UP) ? "up" : "DOWN", i->index);
628
      if (!(i->flags & IF_MULTIACCESS))
629 630 631
	type = "PtP";
      else
	type = "MultiAccess";
632
      cli_msg(-1004, "\t%s%s%s Admin%s Link%s%s%s MTU=%d",
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
	      type,
	      (i->flags & IF_BROADCAST) ? " Broadcast" : "",
	      (i->flags & IF_MULTICAST) ? " Multicast" : "",
	      (i->flags & IF_ADMIN_DOWN) ? "Down" : "Up",
	      (i->flags & IF_LINK_UP) ? "Up" : "Down",
	      (i->flags & IF_LOOPBACK) ? " Loopback" : "",
	      (i->flags & IF_IGNORE) ? " Ignored" : "",
	      i->mtu);
      if (i->addr)
	if_show_addr(i->addr);
      WALK_LIST(a, i->addrs)
	if (a != i->addr)
	  if_show_addr(a);
    }
  cli_msg(0, "");
}

void
if_show_summary(void)
{
  struct iface *i;
  byte addr[STD_ADDRESS_P_LENGTH + 16];

656
  cli_msg(-2005, "interface state address");
657 658 659 660 661 662
  WALK_LIST(i, iface_list)
    {
      if (i->addr)
	bsprintf(addr, "%I/%d", i->addr->ip, i->addr->pxlen);
      else
	addr[0] = 0;
663
      cli_msg(-1005, "%-9s %-5s %s", i->name, (i->flags & IF_UP) ? "up" : "DOWN", addr);
664 665 666
    }
  cli_msg(0, "");
}