rt-attr.c 28.1 KB
Newer Older
1 2 3
/*
 *	BIRD -- Route Attribute Cache
 *
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.
 */

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/**
 * DOC: Route attribute cache
 *
 * Each route entry carries a set of route attributes. Several of them
 * vary from route to route, but most attributes are usually common
 * for a large number of routes. To conserve memory, we've decided to
 * store only the varying ones directly in the &rte and hold the rest
 * in a special structure called &rta which is shared among all the
 * &rte's with these attributes.
 *
 * Each &rta contains all the static attributes of the route (i.e.,
 * those which are always present) as structure members and a list of
 * dynamic attributes represented by a linked list of &ea_list
 * structures, each of them consisting of an array of &eattr's containing
 * the individual attributes. An attribute can be specified more than once
Martin Mareš's avatar
Martin Mareš committed
24
 * in the &ea_list chain and in such case the first occurrence overrides
25 26 27 28 29 30 31 32 33 34 35
 * the others. This semantics is used especially when someone (for example
 * a filter) wishes to alter values of several dynamic attributes, but
 * it wants to preserve the original attribute lists maintained by
 * another module.
 *
 * Each &eattr contains an attribute identifier (split to protocol ID and
 * per-protocol attribute ID), protocol dependent flags, a type code (consisting
 * of several bit fields describing attribute characteristics) and either an
 * embedded 32-bit value or a pointer to a &adata structure holding attribute
 * contents.
 *
Martin Mareš's avatar
Martin Mareš committed
36
 * There exist two variants of &rta's -- cached and un-cached ones. Un-cached
37 38 39 40 41 42 43 44 45 46
 * &rta's can have arbitrarily complex structure of &ea_list's and they
 * can be modified by any module in the route processing chain. Cached
 * &rta's have their attribute lists normalized (that means at most one
 * &ea_list is present and its values are sorted in order to speed up
 * searching), they are stored in a hash table to make fast lookup possible
 * and they are provided with a use count to allow sharing.
 *
 * Routing tables always contain only cached &rta's.
 */

47 48 49
#include "nest/bird.h"
#include "nest/route.h"
#include "nest/protocol.h"
50
#include "nest/iface.h"
51
#include "nest/cli.h"
52
#include "nest/attrs.h"
Ondřej Filip's avatar
Ondřej Filip committed
53
#include "lib/alloca.h"
Ondřej Zajíček's avatar
Ondřej Zajíček committed
54
#include "lib/hash.h"
55
#include "lib/resource.h"
56
#include "lib/string.h"
57

58 59
pool *rta_pool;

60
static slab *rta_slab;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
61
static slab *mpnh_slab;
62 63 64 65 66
static slab *rte_src_slab;

/* rte source ID bitmap */
static u32 *src_ids;
static u32 src_id_size, src_id_used, src_id_pos;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
67
#define SRC_ID_INIT_SIZE 4
68 69

/* rte source hash */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
70 71 72 73 74 75 76 77 78 79 80

#define RSH_KEY(n)		n->proto, n->private_id
#define RSH_NEXT(n)		n->next
#define RSH_EQ(p1,n1,p2,n2)	p1 == p2 && n1 == n2
#define RSH_FN(p,n)		p->hash_key ^ u32_hash(n)

#define RSH_REHASH		rte_src_rehash
#define RSH_PARAMS		/2, *2, 1, 1, 8, 20
#define RSH_INIT_ORDER		6

static HASH(struct rte_src) src_hash;
81

82 83
struct protocol *attr_class_to_protocol[EAP_MAX];

84 85 86 87 88 89 90

static void
rte_src_init(void)
{
  rte_src_slab = sl_new(rta_pool, sizeof(struct rte_src));

  src_id_pos = 0;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
91
  src_id_size = SRC_ID_INIT_SIZE;
92 93 94 95 96 97
  src_ids = mb_allocz(rta_pool, src_id_size * sizeof(u32));

 /* ID 0 is reserved */
  src_ids[0] = 1;
  src_id_used = 1;

Ondřej Zajíček's avatar
Ondřej Zajíček committed
98
  HASH_INIT(src_hash, rta_pool, RSH_INIT_ORDER);
99 100
}

Pavel Tvrdík's avatar
Pavel Tvrdík committed
101
static inline int u32_cto(uint x) { return ffs(~x) - 1; }
102 103 104 105

static inline u32
rte_src_alloc_id(void)
{
106
  uint i, j;
107 108 109 110 111 112 113 114
  for (i = src_id_pos; i < src_id_size; i++)
    if (src_ids[i] != 0xffffffff)
      goto found;

  /* If we are at least 7/8 full, expand */
  if (src_id_used > (src_id_size * 28))
    {
      src_id_size *= 2;
115
      src_ids = mb_realloc(src_ids, src_id_size * sizeof(u32));
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
      bzero(src_ids + i, (src_id_size - i) * sizeof(u32));
      goto found;
    }

  for (i = 0; i < src_id_pos; i++)
    if (src_ids[i] != 0xffffffff)
      goto found;

  ASSERT(0);

 found:
  ASSERT(i < 0x8000000);

  src_id_pos = i;
  j = u32_cto(src_ids[i]);

  src_ids[i] |= (1 << j);
  src_id_used++;
  return 32 * i + j;
}

static inline void
rte_src_free_id(u32 id)
{
  int i = id / 32;
  int j = id % 32;

  ASSERT((i < src_id_size) && (src_ids[i] & (1 << j)));
  src_ids[i] &= ~(1 << j);
  src_id_used--;
}


Ondřej Zajíček's avatar
Ondřej Zajíček committed
149
HASH_DEFINE_REHASH_FN(RSH, struct rte_src)
150 151 152 153

struct rte_src *
rt_find_source(struct proto *p, u32 id)
{
Ondřej Zajíček's avatar
Ondřej Zajíček committed
154
  return HASH_FIND(src_hash, RSH, p, id);
155 156 157 158 159
}

struct rte_src *
rt_get_source(struct proto *p, u32 id)
{
Ondřej Zajíček's avatar
Ondřej Zajíček committed
160
  struct rte_src *src = rt_find_source(p, id);
161

Ondřej Zajíček's avatar
Ondřej Zajíček committed
162 163
  if (src)
    return src;
164 165 166 167 168 169

  src = sl_alloc(rte_src_slab);
  src->proto = p;
  src->private_id = id;
  src->global_id = rte_src_alloc_id();
  src->uc = 0;
170

Ondřej Zajíček's avatar
Ondřej Zajíček committed
171
  HASH_INSERT2(src_hash, RSH, rta_pool, src);
172 173 174 175 176 177 178

  return src;
}

void
rt_prune_sources(void)
{
Ondřej Zajíček's avatar
Ondřej Zajíček committed
179 180 181
  HASH_WALK_FILTER(src_hash, next, src, sp)
  {
    if (src->uc == 0)
182
    {
Ondřej Zajíček's avatar
Ondřej Zajíček committed
183 184 185
      HASH_DO_REMOVE(src_hash, RSH, sp);
      rte_src_free_id(src->global_id);
      sl_free(rte_src_slab, src);
186
    }
Ondřej Zajíček's avatar
Ondřej Zajíček committed
187 188
  }
  HASH_WALK_FILTER_END;
189

Ondřej Zajíček's avatar
Ondřej Zajíček committed
190
  HASH_MAY_RESIZE_DOWN(src_hash, RSH, rta_pool);
191 192 193 194 195 196 197
}


/*
 *	Multipath Next Hop
 */

Pavel Tvrdík's avatar
Pavel Tvrdík committed
198
static inline uint
Ondřej Zajíček's avatar
Ondřej Zajíček committed
199 200
mpnh_hash(struct mpnh *x)
{
Pavel Tvrdík's avatar
Pavel Tvrdík committed
201
  uint h = 0;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
  for (; x; x = x->next)
    h ^= ipa_hash(x->gw);

  return h;
}

int
mpnh__same(struct mpnh *x, struct mpnh *y)
{
  for (; x && y; x = x->next, y = y->next)
    if (!ipa_equal(x->gw, y->gw) || (x->iface != y->iface) || (x->weight != y->weight))
      return 0;

  return x == y;
}

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
static int
mpnh_compare_node(struct mpnh *x, struct mpnh *y)
{
  int r;

  if (!x)
    return 1;

  if (!y)
    return -1;

  r = ((int) y->weight) - ((int) x->weight);
  if (r)
    return r;

  r = ipa_compare(x->gw, y->gw);
  if (r)
    return r;

  return ((int) x->iface->index) - ((int) y->iface->index);
}

static inline struct mpnh *
mpnh_copy_node(const struct mpnh *src, linpool *lp)
{
  struct mpnh *n = lp_alloc(lp, sizeof(struct mpnh));
  n->gw = src->gw;
  n->iface = src->iface;
  n->next = NULL;
  n->weight = src->weight;
  return n;
}

/**
 * mpnh_merge - merge nexthop lists
 * @x: list 1
 * @y: list 2
 * @rx: reusability of list @x
 * @ry: reusability of list @y
 * @max: max number of nexthops
 * @lp: linpool for allocating nexthops
 *
 * The mpnh_merge() function takes two nexthop lists @x and @y and merges them,
 * eliminating possible duplicates. The input lists must be sorted and the
 * result is sorted too. The number of nexthops in result is limited by @max.
 * New nodes are allocated from linpool @lp.
 *
 * The arguments @rx and @ry specify whether corresponding input lists may be
 * consumed by the function (i.e. their nodes reused in the resulting list), in
 * that case the caller should not access these lists after that. To eliminate
 * issues with deallocation of these lists, the caller should use some form of
 * bulk deallocation (e.g. stack or linpool) to free these nodes when the
 * resulting list is no longer needed. When reusability is not set, the
 * corresponding lists are not modified nor linked from the resulting list.
 */
struct mpnh *
mpnh_merge(struct mpnh *x, struct mpnh *y, int rx, int ry, int max, linpool *lp)
{
  struct mpnh *root = NULL;
  struct mpnh **n = &root;

  while ((x || y) && max--)
  {
    int cmp = mpnh_compare_node(x, y);
    if (cmp < 0)
    {
      *n = rx ? x : mpnh_copy_node(x, lp);
      x = x->next;
    }
    else if (cmp > 0)
    {
      *n = ry ? y : mpnh_copy_node(y, lp);
      y = y->next;
    }
    else
    {
      *n = rx ? x : (ry ? y : mpnh_copy_node(x, lp));
      x = x->next;
      y = y->next;
    }
    n = &((*n)->next);
  }
  *n = NULL;

  return root;
}

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
void
mpnh_insert(struct mpnh **n, struct mpnh *x)
{
  for (; *n; n = &((*n)->next))
  {
    int cmp = mpnh_compare_node(*n, x);

    if (cmp < 0)
      continue;
    else if (cmp > 0)
      break;
    else
      return;
  }

  x->next = *n;
  *n = x;
}

int
mpnh_is_sorted(struct mpnh *x)
{
  for (; x && x->next; x = x->next)
    if (mpnh_compare_node(x, x->next) >= 0)
      return 0;

  return 1;
}
333

Ondřej Zajíček's avatar
Ondřej Zajíček committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
static struct mpnh *
mpnh_copy(struct mpnh *o)
{
  struct mpnh *first = NULL;
  struct mpnh **last = &first;

  for (; o; o = o->next)
    {
      struct mpnh *n = sl_alloc(mpnh_slab);
      n->gw = o->gw;
      n->iface = o->iface;
      n->next = NULL;
      n->weight = o->weight;

      *last = n;
      last = &(n->next);
    }

  return first;
}

static void
mpnh_free(struct mpnh *o)
{
  struct mpnh *n;

  while (o)
    {
      n = o->next;
      sl_free(mpnh_slab, o);
      o = n;
    }
}


369 370 371 372
/*
 *	Extended Attributes
 */

373 374
static inline eattr *
ea__find(ea_list *e, unsigned id)
375 376 377 378 379 380 381 382 383
{
  eattr *a;
  int l, r, m;

  while (e)
    {
      if (e->flags & EALF_BISECT)
	{
	  l = 0;
384
	  r = e->count - 1;
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
	  while (l <= r)
	    {
	      m = (l+r) / 2;
	      a = &e->attrs[m];
	      if (a->id == id)
		return a;
	      else if (a->id < id)
		l = m+1;
	      else
		r = m-1;
	    }
	}
      else
	for(m=0; m<e->count; m++)
	  if (e->attrs[m].id == id)
	    return &e->attrs[m];
      e = e->next;
    }
  return NULL;
}

406 407 408 409 410 411
/**
 * ea_find - find an extended attribute
 * @e: attribute list to search in
 * @id: attribute ID to search for
 *
 * Given an extended attribute list, ea_find() searches for a first
Martin Mareš's avatar
Martin Mareš committed
412
 * occurrence of an attribute with specified ID, returning either a pointer
413 414
 * to its &eattr structure or %NULL if no such attribute exists.
 */
415 416 417 418 419 420 421 422 423 424 425
eattr *
ea_find(ea_list *e, unsigned id)
{
  eattr *a = ea__find(e, id & EA_CODE_MASK);

  if (a && (a->type & EAF_TYPE_MASK) == EAF_TYPE_UNDEF &&
      !(id & EA_ALLOW_UNDEF))
    return NULL;
  return a;
}

426 427 428 429 430 431 432 433 434 435
/**
 * ea_walk - walk through extended attributes
 * @s: walk state structure
 * @id: start of attribute ID interval
 * @max: length of attribute ID interval
 *
 * Given an extended attribute list, ea_walk() walks through the list looking
 * for first occurrences of attributes with ID in specified interval from @id to
 * (@id + @max - 1), returning pointers to found &eattr structures, storing its
 * walk state in @s for subsequent calls.
436
 *
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
 * The function ea_walk() is supposed to be called in a loop, with initially
 * zeroed walk state structure @s with filled the initial extended attribute
 * list, returning one found attribute in each call or %NULL when no other
 * attribute exists. The extended attribute list or the arguments should not be
 * modified between calls. The maximum value of @max is 128.
 */
eattr *
ea_walk(struct ea_walk_state *s, uint id, uint max)
{
  ea_list *e = s->eattrs;
  eattr *a = s->ea;
  eattr *a_max;

  max = id + max;

  if (a)
    goto step;

  for (; e; e = e->next)
  {
    if (e->flags & EALF_BISECT)
    {
      int l, r, m;

      l = 0;
      r = e->count - 1;
      while (l < r)
      {
	m = (l+r) / 2;
	if (e->attrs[m].id < id)
	  l = m + 1;
	else
	  r = m;
      }
      a = e->attrs + l;
    }
    else
      a = e->attrs;

  step:
    a_max = e->attrs + e->count;
    for (; a < a_max; a++)
      if ((a->id >= id) && (a->id < max))
      {
	int n = a->id - id;

	if (BIT32_TEST(s->visited, n))
	  continue;

	BIT32_SET(s->visited, n);

	if ((a->type & EAF_TYPE_MASK) == EAF_TYPE_UNDEF)
	  continue;

	s->eattrs = e;
	s->ea = a;
	return a;
      }
      else if (e->flags & EALF_BISECT)
	break;
  }

  return NULL;
}

502 503 504 505 506 507 508 509 510 511
/**
 * ea_get_int - fetch an integer attribute
 * @e: attribute list
 * @id: attribute ID
 * @def: default value
 *
 * This function is a shortcut for retrieving a value of an integer attribute
 * by calling ea_find() to find the attribute, extracting its value or returning
 * a provided default if no such attribute is present.
 */
512 513 514 515 516 517 518 519 520
int
ea_get_int(ea_list *e, unsigned id, int def)
{
  eattr *a = ea_find(e, id);
  if (!a)
    return def;
  return a->u.data;
}

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
static inline void
ea_do_sort(ea_list *e)
{
  unsigned n = e->count;
  eattr *a = e->attrs;
  eattr *b = alloca(n * sizeof(eattr));
  unsigned s, ss;

  /* We need to use a stable sorting algorithm, hence mergesort */
  do
    {
      s = ss = 0;
      while (s < n)
	{
	  eattr *p, *q, *lo, *hi;
	  p = b;
	  ss = s;
	  *p++ = a[s++];
	  while (s < n && p[-1].id <= a[s].id)
	    *p++ = a[s++];
	  if (s < n)
	    {
	      q = p;
	      *p++ = a[s++];
	      while (s < n && p[-1].id <= a[s].id)
		*p++ = a[s++];
	      lo = b;
	      hi = q;
	      s = ss;
	      while (lo < q && hi < p)
		if (lo->id <= hi->id)
		  a[s++] = *lo++;
		else
		  a[s++] = *hi++;
	      while (lo < q)
		a[s++] = *lo++;
	      while (hi < p)
		a[s++] = *hi++;
	    }
	}
    }
  while (ss);
}

static inline void
ea_do_prune(ea_list *e)
{
568
  eattr *s, *d, *l, *s0;
569 570 571 572 573 574 575
  int i = 0;

  /* Discard duplicates and undefs. Do you remember sorting was stable? */
  s = d = e->attrs;
  l = e->attrs + e->count;
  while (s < l)
    {
576 577 578 579 580
      s0 = s++;
      while (s < l && s->id == s[-1].id)
	s++;
      /* s0 is the most recent version, s[-1] the oldest one */
      if ((s0->type & EAF_TYPE_MASK) != EAF_TYPE_UNDEF)
581
	{
582 583 584
	  *d = *s0;
	  d->type = (d->type & ~EAF_ORIGINATED) | (s[-1].type & EAF_ORIGINATED);
	  d++;
585 586 587 588
	  i++;
	}
    }
  e->count = i;
589 590
}

591 592 593 594 595 596 597 598
/**
 * ea_sort - sort an attribute list
 * @e: list to be sorted
 *
 * This function takes a &ea_list chain and sorts the attributes
 * within each of its entries.
 *
 * If an attribute occurs multiple times in a single &ea_list,
Martin Mareš's avatar
Martin Mareš committed
599
 * ea_sort() leaves only the first (the only significant) occurrence.
600
 */
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
void
ea_sort(ea_list *e)
{
  while (e)
    {
      if (!(e->flags & EALF_SORTED))
	{
	  ea_do_sort(e);
	  ea_do_prune(e);
	  e->flags |= EALF_SORTED;
	}
      if (e->count > 5)
	e->flags |= EALF_BISECT;
      e = e->next;
    }
}

618 619 620 621 622 623 624
/**
 * ea_scan - estimate attribute list size
 * @e: attribute list
 *
 * This function calculates an upper bound of the size of
 * a given &ea_list after merging with ea_merge().
 */
625 626 627 628 629 630 631 632 633 634 635 636 637
unsigned
ea_scan(ea_list *e)
{
  unsigned cnt = 0;

  while (e)
    {
      cnt += e->count;
      e = e->next;
    }
  return sizeof(ea_list) + sizeof(eattr)*cnt;
}

638 639 640 641 642 643 644 645 646 647 648 649 650 651
/**
 * ea_merge - merge segments of an attribute list
 * @e: attribute list
 * @t: buffer to store the result to
 *
 * This function takes a possibly multi-segment attribute list
 * and merges all of its segments to one.
 *
 * The primary use of this function is for &ea_list normalization:
 * first call ea_scan() to determine how much memory will the result
 * take, then allocate a buffer (usually using alloca()), merge the
 * segments with ea_merge() and finally sort and prune the result
 * by calling ea_sort().
 */
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
void
ea_merge(ea_list *e, ea_list *t)
{
  eattr *d = t->attrs;

  t->flags = 0;
  t->count = 0;
  t->next = NULL;
  while (e)
    {
      memcpy(d, e->attrs, sizeof(eattr)*e->count);
      t->count += e->count;
      d += e->count;
      e = e->next;
    }
}

669 670 671 672 673 674 675 676
/**
 * ea_same - compare two &ea_list's
 * @x: attribute list
 * @y: attribute list
 *
 * ea_same() compares two normalized attribute lists @x and @y and returns
 * 1 if they contain the same attributes, 0 otherwise.
 */
677
int
678 679 680 681
ea_same(ea_list *x, ea_list *y)
{
  int c;

682 683 684 685 686 687
  if (!x || !y)
    return x == y;
  ASSERT(!x->next && !y->next);
  if (x->count != y->count)
    return 0;
  for(c=0; c<x->count; c++)
688
    {
689 690 691 692 693 694
      eattr *a = &x->attrs[c];
      eattr *b = &y->attrs[c];

      if (a->id != b->id ||
	  a->flags != b->flags ||
	  a->type != b->type ||
Ondřej Zajíček's avatar
Ondřej Zajíček committed
695
	  ((a->type & EAF_EMBEDDED) ? a->u.data != b->u.data : !adata_same(a->u.ptr, b->u.ptr)))
696
	return 0;
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
    }
  return 1;
}

static inline ea_list *
ea_list_copy(ea_list *o)
{
  ea_list *n;
  unsigned i, len;

  if (!o)
    return NULL;
  ASSERT(!o->next);
  len = sizeof(ea_list) + sizeof(eattr) * o->count;
  n = mb_alloc(rta_pool, len);
  memcpy(n, o, len);
  n->flags |= EALF_CACHED;
  for(i=0; i<o->count; i++)
    {
      eattr *a = &n->attrs[i];
717
      if (!(a->type & EAF_EMBEDDED))
718 719 720 721 722 723 724 725 726 727
	{
	  unsigned size = sizeof(struct adata) + a->u.ptr->length;
	  struct adata *d = mb_alloc(rta_pool, size);
	  memcpy(d, a->u.ptr, size);
	  a->u.ptr = d;
	}
    }
  return n;
}

Martin Mareš's avatar
Martin Mareš committed
728 729 730
static inline void
ea_free(ea_list *o)
{
731 732
  int i;

Martin Mareš's avatar
Martin Mareš committed
733 734 735
  if (o)
    {
      ASSERT(!o->next);
736 737 738 739 740 741
      for(i=0; i<o->count; i++)
	{
	  eattr *a = &o->attrs[i];
	  if (!(a->type & EAF_EMBEDDED))
	    mb_free(a->u.ptr);
	}
Martin Mareš's avatar
Martin Mareš committed
742 743 744 745
      mb_free(o);
    }
}

Ondřej Zajíček's avatar
Ondřej Zajíček committed
746 747 748 749 750 751 752 753
static int
get_generic_attr(eattr *a, byte **buf, int buflen UNUSED)
{
  if (a->id == EA_GEN_IGP_METRIC)
    {
      *buf += bsprintf(*buf, "igp_metric");
      return GA_NAME;
    }
754

Ondřej Zajíček's avatar
Ondřej Zajíček committed
755 756 757
  return GA_UNKNOWN;
}

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
void
ea_format_bitfield(struct eattr *a, byte *buf, int bufsize, const char **names, int min, int max)
{
  byte *bound = buf + bufsize - 32;
  u32 data = a->u.data;
  int i;

  for (i = min; i < max; i++)
    if ((data & (1u << i)) && names[i])
    {
      if (buf > bound)
      {
	strcpy(buf, " ...");
	return;
      }

      buf += bsprintf(buf, " %s", names[i]);
      data &= ~(1u << i);
    }

  if (data)
    bsprintf(buf, " %08x", data);

  return;
}

784
static inline void
Pavel Tvrdík's avatar
Pavel Tvrdík committed
785
opaque_format(struct adata *ad, byte *buf, uint size)
786 787
{
  byte *bound = buf + size - 10;
788
  uint i;
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810

  for(i = 0; i < ad->length; i++)
    {
      if (buf > bound)
	{
	  strcpy(buf, " ...");
	  return;
	}
      if (i)
	*buf++ = ' ';

      buf += bsprintf(buf, "%02x", ad->data[i]);
    }

  *buf = 0;
  return;
}

static inline void
ea_show_int_set(struct cli *c, struct adata *ad, int way, byte *pos, byte *buf, byte *end)
{
  int i = int_set_format(ad, way, 0, pos, end - pos);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
811
  cli_printf(c, -1012, "\t%s", buf);
812 813 814
  while (i)
    {
      i = int_set_format(ad, way, i, buf, end - buf - 1);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
815
      cli_printf(c, -1012, "\t\t%s", buf);
816 817 818
    }
}

Ondřej Zajíček's avatar
Ondřej Zajíček committed
819 820 821 822
static inline void
ea_show_ec_set(struct cli *c, struct adata *ad, byte *pos, byte *buf, byte *end)
{
  int i = ec_set_format(ad, 0, pos, end - pos);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
823
  cli_printf(c, -1012, "\t%s", buf);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
824 825 826
  while (i)
    {
      i = ec_set_format(ad, i, buf, end - buf - 1);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
827
      cli_printf(c, -1012, "\t\t%s", buf);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
828 829 830
    }
}

831 832 833 834 835 836 837 838 839 840 841 842
static inline void
ea_show_lc_set(struct cli *c, struct adata *ad, byte *pos, byte *buf, byte *end)
{
  int i = lc_set_format(ad, 0, pos, end - pos);
  cli_printf(c, -1012, "\t%s", buf);
  while (i)
    {
      i = lc_set_format(ad, i, buf, end - buf - 1);
      cli_printf(c, -1012, "\t\t%s", buf);
    }
}

843
/**
844 845 846
 * ea_show - print an &eattr to CLI
 * @c: destination CLI
 * @e: attribute to be printed
847
 *
848 849
 * This function takes an extended attribute represented by its &eattr
 * structure and prints it to the CLI according to the type information.
850 851 852 853
 *
 * If the protocol defining the attribute provides its own
 * get_attr() hook, it's consulted first.
 */
854
void
855
ea_show(struct cli *c, eattr *e)
856 857 858 859
{
  struct protocol *p;
  int status = GA_UNKNOWN;
  struct adata *ad = (e->type & EAF_EMBEDDED) ? NULL : e->u.ptr;
860 861
  byte buf[CLI_MSG_SIZE];
  byte *pos = buf, *end = buf + sizeof(buf);
862 863 864

  if (p = attr_class_to_protocol[EA_PROTO(e->id)])
    {
865
      pos += bsprintf(pos, "%s.", p->name);
866
      if (p->get_attr)
867 868
	status = p->get_attr(e, pos, end - pos);
      pos += strlen(pos);
869 870
    }
  else if (EA_PROTO(e->id))
871
    pos += bsprintf(pos, "%02x.", EA_PROTO(e->id));
872
  else
873
    status = get_generic_attr(e, &pos, end - pos);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
874

875
  if (status < GA_NAME)
876
    pos += bsprintf(pos, "%02x", EA_ID(e->id));
877 878
  if (status < GA_FULL)
    {
879 880
      *pos++ = ':';
      *pos++ = ' ';
881 882 883
      switch (e->type & EAF_TYPE_MASK)
	{
	case EAF_TYPE_INT:
884
	  bsprintf(pos, "%u", e->u.data);
885 886
	  break;
	case EAF_TYPE_OPAQUE:
887
	  opaque_format(ad, pos, end - pos);
888 889
	  break;
	case EAF_TYPE_IP_ADDRESS:
890
	  bsprintf(pos, "%I", *(ip_addr *) ad->data);
891 892
	  break;
	case EAF_TYPE_ROUTER_ID:
893
	  bsprintf(pos, "%R", e->u.data);
894
	  break;
895
	case EAF_TYPE_AS_PATH:
896
	  as_path_format(ad, pos, end - pos);
897
	  break;
898 899 900
	case EAF_TYPE_BITFIELD:
	  bsprintf(pos, "%08x", e->u.data);
	  break;
901
	case EAF_TYPE_INT_SET:
902 903
	  ea_show_int_set(c, ad, 1, pos, buf, end);
	  return;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
904 905 906
	case EAF_TYPE_EC_SET:
	  ea_show_ec_set(c, ad, pos, buf, end);
	  return;
907 908 909
	case EAF_TYPE_LC_SET:
	  ea_show_lc_set(c, ad, pos, buf, end);
	  return;
910 911
	case EAF_TYPE_UNDEF:
	default:
912
	  bsprintf(pos, "<type %02x>", e->type);
913 914
	}
    }
Ondřej Zajíček's avatar
Ondřej Zajíček committed
915
  cli_printf(c, -1012, "\t%s", buf);
916 917
}

918 919 920 921 922 923 924
/**
 * ea_dump - dump an extended attribute
 * @e: attribute to be dumped
 *
 * ea_dump() dumps contents of the extended attribute given to
 * the debug output.
 */
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
void
ea_dump(ea_list *e)
{
  int i;

  if (!e)
    {
      debug("NONE");
      return;
    }
  while (e)
    {
      debug("[%c%c%c]",
	    (e->flags & EALF_SORTED) ? 'S' : 's',
	    (e->flags & EALF_BISECT) ? 'B' : 'b',
	    (e->flags & EALF_CACHED) ? 'C' : 'c');
      for(i=0; i<e->count; i++)
942
	{
943 944
	  eattr *a = &e->attrs[i];
	  debug(" %02x:%02x.%02x", EA_PROTO(a->id), EA_ID(a->id), a->flags);
945 946
	  if (a->type & EAF_TEMP)
	    debug("T");
947
	  debug("=%c", "?iO?I?P???S?????" [a->type & EAF_TYPE_MASK]);
948 949
	  if (a->type & EAF_ORIGINATED)
	    debug("o");
950 951 952 953 954 955 956 957 958
	  if (a->type & EAF_EMBEDDED)
	    debug(":%08x", a->u.data);
	  else
	    {
	      int j, len = a->u.ptr->length;
	      debug("[%d]:", len);
	      for(j=0; j<len; j++)
		debug("%02x", a->u.ptr->data[j]);
	    }
959
	}
960 961
      if (e = e->next)
	debug(" | ");
962 963 964
    }
}

965 966 967 968 969 970 971
/**
 * ea_hash - calculate an &ea_list hash key
 * @e: attribute list
 *
 * ea_hash() takes an extended attribute list and calculated a hopefully
 * uniformly distributed hash value from its contents.
 */
Pavel Tvrdík's avatar
Pavel Tvrdík committed
972
inline uint
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
ea_hash(ea_list *e)
{
  u32 h = 0;
  int i;

  if (e)			/* Assuming chain of length 1 */
    {
      for(i=0; i<e->count; i++)
	{
	  struct eattr *a = &e->attrs[i];
	  h ^= a->id;
	  if (a->type & EAF_EMBEDDED)
	    h ^= a->u.data;
	  else
	    {
	      struct adata *d = a->u.ptr;
	      int size = d->length;
	      byte *z = d->data;
	      while (size >= 4)
		{
		  h ^= *(u32 *)z;
		  z += 4;
		  size -= 4;
		}
	      while (size--)
		h = (h >> 24) ^ (h << 8) ^ *z++;
	    }
	}
      h ^= h >> 16;
      h ^= h >> 6;
      h &= 0xffff;
    }
  return h;
}

1008 1009 1010 1011 1012 1013 1014 1015
/**
 * ea_append - concatenate &ea_list's
 * @to: destination list (can be %NULL)
 * @what: list to be appended (can be %NULL)
 *
 * This function appends the &ea_list @what at the end of
 * &ea_list @to and returns a pointer to the resulting list.
 */
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
ea_list *
ea_append(ea_list *to, ea_list *what)
{
  ea_list *res;

  if (!to)
    return what;
  res = to;
  while (to->next)
    to = to->next;
  to->next = what;
  return res;
}

1030 1031 1032 1033
/*
 *	rta's
 */

Pavel Tvrdík's avatar
Pavel Tvrdík committed
1034 1035 1036 1037
static uint rta_cache_count;
static uint rta_cache_size = 32;
static uint rta_cache_limit;
static uint rta_cache_mask;
1038 1039 1040 1041 1042
static rta **rta_hash_table;

static void
rta_alloc_hash(void)
{
Martin Mareš's avatar
Martin Mareš committed
1043
  rta_hash_table = mb_allocz(rta_pool, sizeof(rta *) * rta_cache_size);
1044 1045 1046 1047 1048 1049 1050
  if (rta_cache_size < 32768)
    rta_cache_limit = rta_cache_size * 2;
  else
    rta_cache_limit = ~0;
  rta_cache_mask = rta_cache_size - 1;
}

Pavel Tvrdík's avatar
Pavel Tvrdík committed
1051
static inline uint
1052 1053
rta_hash(rta *a)
{
Ondřej Zajíček's avatar
Ondřej Zajíček committed
1054
  return (((uint) (uintptr_t) a->src) ^ ipa_hash(a->gw) ^
Ondřej Zajíček's avatar
Ondřej Zajíček committed
1055
	  mpnh_hash(a->nexthops) ^ ea_hash(a->eattrs)) & 0xffff;
1056 1057
}

1058 1059 1060
static inline int
rta_same(rta *x, rta *y)
{
1061
  return (x->src == y->src &&
1062 1063 1064 1065 1066
	  x->source == y->source &&
	  x->scope == y->scope &&
	  x->cast == y->cast &&
	  x->dest == y->dest &&
	  x->flags == y->flags &&
1067
	  x->igp_metric == y->igp_metric &&
1068 1069 1070
	  ipa_equal(x->gw, y->gw) &&
	  ipa_equal(x->from, y->from) &&
	  x->iface == y->iface &&
1071
	  x->hostentry == y->hostentry &&
Ondřej Zajíček's avatar
Ondřej Zajíček committed
1072
	  mpnh_same(x->nexthops, y->nexthops) &&
1073
	  ea_same(x->eattrs, y->eattrs));
1074 1075 1076 1077 1078 1079 1080 1081 1082
}

static rta *
rta_copy(rta *o)
{
  rta *r = sl_alloc(rta_slab);

  memcpy(r, o, sizeof(rta));
  r->uc = 1;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
1083
  r->nexthops = mpnh_copy(o->nexthops);
1084
  r->eattrs = ea_list_copy(o->eattrs);
1085 1086 1087
  return r;
}

1088 1089 1090
static inline void
rta_insert(rta *r)
{
Pavel Tvrdík's avatar
Pavel Tvrdík committed
1091
  uint h = r->hash_key & rta_cache_mask;
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
  r->next = rta_hash_table[h];
  if (r->next)
    r->next->pprev = &r->next;
  r->pprev = &rta_hash_table[h];
  rta_hash_table[h] = r;
}

static void
rta_rehash(void)
{
Pavel Tvrdík's avatar
Pavel Tvrdík committed
1102 1103
  uint ohs = rta_cache_size;
  uint h;
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
  rta *r, *n;
  rta **oht = rta_hash_table;

  rta_cache_size = 2*rta_cache_size;
  DBG("Rehashing rta cache from %d to %d entries.\n", ohs, rta_cache_size);
  rta_alloc_hash();
  for(h=0; h<ohs; h++)
    for(r=oht[h]; r; r=n)
      {
	n = r->next;
	rta_insert(r);
      }
  mb_free(oht);
}

1119 1120
/**
 * rta_lookup - look up a &rta in attribute cache
Martin Mareš's avatar
Martin Mareš committed
1121
 * @o: a un-cached &rta
1122
 *
Martin Mareš's avatar
Martin Mareš committed
1123
 * rta_lookup() gets an un-cached &rta structure and returns its cached
1124 1125 1126 1127 1128 1129 1130 1131
 * counterpart. It starts with examining the attribute cache to see whether
 * there exists a matching entry. If such an entry exists, it's returned and
 * its use count is incremented, else a new entry is created with use count
 * set to 1.
 *
 * The extended attribute lists attached to the &rta are automatically
 * converted to the normalized form.
 */
1132 1133 1134 1135
rta *
rta_lookup(rta *o)
{
  rta *r;
Pavel Tvrdík's avatar
Pavel Tvrdík committed
1136
  uint h;
1137

1138
  ASSERT(!(o->aflags & RTAF_CACHED));
1139
  if (o->eattrs)
1140
    {
1141
      if (o->eattrs->next)	/* Multiple ea_list's, need to merge them */
1142
	{
1143 1144 1145
	  ea_list *ml = alloca(ea_scan(o->eattrs));
	  ea_merge(o->eattrs, ml);
	  o->eattrs = ml;
1146
	}
1147
      ea_sort(o->eattrs);
1148 1149
    }

1150 1151 1152
  h = rta_hash(o);
  for(r=rta_hash_table[h & rta_cache_mask]; r; r=r->next)
    if (r->hash_key == h && rta_same(r, o))
1153
      return rta_clone(r);
1154

1155
  r = rta_copy(o);
1156
  r->hash_key = h;
1157
  r->aflags = RTAF_CACHED;
1158
  rt_lock_source(r->src);
1159
  rt_lock_hostentry(r->hostentry);
1160 1161 1162 1163 1164
  rta_insert(r);

  if (++rta_cache_count > rta_cache_limit)
    rta_rehash();

1165 1166 1167 1168
  return r;
}

void
1169
rta__free(rta *a)
1170
{
1171 1172
  ASSERT(rta_cache_count && (a->aflags & RTAF_CACHED));
  rta_cache_count--;
Martin Mareš's avatar
Martin Mareš committed
1173 1174 1175 1176
  *a->pprev = a->next;
  if (a->next)
    a->next->pprev = a->pprev;
  a->aflags = 0;		/* Poison the entry */
1177
  rt_unlock_hostentry(a->hostentry);
1178
  rt_unlock_source(a->src);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
1179
  mpnh_free(a->nexthops);
Martin Mareš's avatar
Martin Mareš committed
1180 1181
  ea_free(a->eattrs);
  sl_free(rta_slab, a);
1182 1183
}

Ondřej Zajíček's avatar
Ondřej Zajíček committed
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
rta *
rta_do_cow(rta *o, linpool *lp)
{
  rta *r = lp_alloc(lp, sizeof(rta));
  memcpy(r, o, sizeof(rta));
  r->aflags = 0;
  r->uc = 0;
  return r;
}

1194 1195 1196 1197 1198 1199
/**
 * rta_dump - dump route attributes
 * @a: attribute structure to dump
 *
 * This function takes a &rta and dumps its contents to the debug output.
 */
1200
void
1201
rta_dump(rta *a)
1202
{
1203
  static char *rts[] = { "RTS_DUMMY", "RTS_STATIC", "RTS_INHERIT", "RTS_DEVICE",
Martin Mareš's avatar
Martin Mareš committed
1204
			 "RTS_STAT_DEV", "RTS_REDIR", "RTS_RIP",
Ondřej Filip's avatar
Ondřej Filip committed
1205
			 "RTS_OSPF", "RTS_OSPF_IA", "RTS_OSPF_EXT1",
1206
                         "RTS_OSPF_EXT2", "RTS_BGP", "RTS_PIPE", "RTS_BABEL" };
1207 1208 1209
  static char *rtc[] = { "", " BC", " MC", " AC" };
  static char *rtd[] = { "", " DEV", " HOLE", " UNREACH", " PROHIBIT" };

1210
  debug("p=%s uc=%d %s %s%s%s h=%04x",
1211
	a->src->proto->name, a->uc, rts[a->source], ip_scope_text(a->scope), rtc[a->cast],
1212
	rtd[a->dest], a->hash_key);
1213 1214
  if (!(a->aflags & RTAF_CACHED))
    debug(" !CACHED");
1215
  debug(" <-%I", a->from);
1216
  if (a->dest == RTD_ROUTER)
1217
    debug(" ->%I", a->gw);
1218
  if (a->dest == RTD_DEVICE || a->dest == RTD_ROUTER)
1219
    debug(" [%s]", a->iface ? a->iface->name : "???" );
1220
  if (a->eattrs)
1221 1222
    {
      debug(" EA: ");
1223
      ea_dump(a->eattrs);
1224
    }
1225 1226
}

1227 1228 1229 1230 1231 1232
/**
 * rta_dump_all - dump attribute cache
 *
 * This function dumps the whole contents of route attribute cache
 * to the debug output.
 */
1233 1234 1235
void
rta_dump_all(void)
{
1236
  rta *a;
Pavel Tvrdík's avatar
Pavel Tvrdík committed
1237
  uint h;
1238 1239 1240 1241 1242 1243 1244 1245 1246

  debug("Route attribute cache (%d entries, rehash at %d):\n", rta_cache_count, rta_cache_limit);
  for(h=0; h<rta_cache_size; h++)
    for(a=rta_hash_table[h]; a; a=a->next)
      {
	debug("%p ", a);
	rta_dump(a);
	debug("\n");
      }
1247
  debug("\n");
1248 1249
}

1250
void
1251
rta_show(struct cli *c, rta *a, ea_list *eal)
1252 1253
{
  static char *src_names[] = { "dummy", "static", "inherit", "device", "static-device", "redirect",
1254
			       "RIP", "OSPF", "OSPF-IA", "OSPF-E1", "OSPF-E2", "BGP", "pipe" };
1255
  static char *cast_names[] = { "unicast", "broadcast", "multicast", "anycast" };
1256
  int i;
1257 1258

  cli_printf(c, -1008, "\tType: %s %s %s", src_names[a->source], cast_names[a->cast], ip_scope_text(a->scope));
1259 1260 1261
  if (!eal)
    eal = a->eattrs;
  for(; eal; eal=eal->next)
1262
    for(i=0; i<eal->count; i++)
1263
      ea_show(c, &eal->attrs[i]);
1264 1265
}

1266 1267 1268 1269 1270 1271
/**
 * rta_init - initialize route attribute cache
 *
 * This function is called during initialization of the routing
 * table module to set up the internals of the attribute cache.
 */
1272 1273 1274
void
rta_init(void)
{
Martin Mareš's avatar
Martin Mareš committed
1275
  rta_pool = rp_new(&root_pool, "Attributes");
1276
  rta_slab = sl_new(rta_pool, sizeof(rta));
Ondřej Zajíček's avatar
Ondřej Zajíček committed
1277
  mpnh_slab = sl_new(rta_pool, sizeof(struct mpnh));
1278
  rta_alloc_hash();
1279
  rte_src_init();
1280
}
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310

/*
 *  Documentation for functions declared inline in route.h
 */
#if 0

/**
 * rta_clone - clone route attributes
 * @r: a &rta to be cloned
 *
 * rta_clone() takes a cached &rta and returns its identical cached
 * copy. Currently it works by just returning the original &rta with
 * its use count incremented.
 */
static inline rta *rta_clone(rta *r)
{ DUMMY; }

/**
 * rta_free - free route attributes
 * @r: a &rta to be freed
 *
 * If you stop using a &rta (for example when deleting a route which uses
 * it), you need to call rta_free() to notify the attribute cache the
 * attribute is no longer in use and can be freed if you were the last
 * user (which rta_free() tests by inspecting the use count).
 */
static inline void rta_free(rta *r)
{ DUMMY; }

#endif