Statistics
| Branch: | Revision:

iof-bird / bird-2.0.1 / proto / rip / rip.c @ 6b3f1a54

History | View | Annotate | Download (32.2 KB)

1
/*
2
 *        BIRD -- Routing Information Protocol (RIP)
3
 *
4
 *        (c) 1998--1999 Pavel Machek <pavel@ucw.cz>
5
 *        (c) 2004--2013 Ondrej Filip <feela@network.cz>
6
 *        (c) 2009--2015 Ondrej Zajicek <santiago@crfreenet.org>
7
 *        (c) 2009--2015 CZ.NIC z.s.p.o.
8
 *
9
 *        Can be freely distributed and used under the terms of the GNU GPL.
10
 */
11

    
12
/**
13
 * DOC: Routing Information Protocol (RIP)
14
 *
15
 * The RIP protocol is implemented in two files: |rip.c| containing the protocol
16
 * logic, route management and the protocol glue with BIRD core, and |packets.c|
17
 * handling RIP packet processing, RX, TX and protocol sockets.
18
 *
19
 * Each instance of RIP is described by a structure &rip_proto, which contains
20
 * an internal RIP routing table, a list of protocol interfaces and the main
21
 * timer responsible for RIP routing table cleanup.
22
 *
23
 * RIP internal routing table contains incoming and outgoing routes. For each
24
 * network (represented by structure &rip_entry) there is one outgoing route
25
 * stored directly in &rip_entry and an one-way linked list of incoming routes
26
 * (structures &rip_rte). The list contains incoming routes from different RIP
27
 * neighbors, but only routes with the lowest metric are stored (i.e., all
28
 * stored incoming routes have the same metric).
29
 *
30
 * Note that RIP itself does not select outgoing route, that is done by the core
31
 * routing table. When a new incoming route is received, it is propagated to the
32
 * RIP table by rip_update_rte() and possibly stored in the list of incoming
33
 * routes. Then the change may be propagated to the core by rip_announce_rte().
34
 * The core selects the best route and propagate it to RIP by rip_rt_notify(),
35
 * which updates outgoing route part of &rip_entry and possibly triggers route
36
 * propagation by rip_trigger_update().
37
 *
38
 * RIP interfaces are represented by structures &rip_iface. A RIP interface
39
 * contains a per-interface socket, a list of associated neighbors, interface
40
 * configuration, and state information related to scheduled interface events
41
 * and running update sessions. RIP interfaces are added and removed based on
42
 * core interface notifications.
43
 *
44
 * There are two RIP interface events - regular updates and triggered updates.
45
 * Both are managed from the RIP interface timer (rip_iface_timer()). Regular
46
 * updates are called at fixed interval and propagate the whole routing table,
47
 * while triggered updates are scheduled by rip_trigger_update() due to some
48
 * routing table change and propagate only the routes modified since the time
49
 * they were scheduled. There are also unicast-destined requested updates, but
50
 * these are sent directly as a reaction to received RIP request message. The
51
 * update session is started by rip_send_table(). There may be at most one
52
 * active update session per interface, as the associated state (including the
53
 * fib iterator) is stored directly in &rip_iface structure.
54
 *
55
 * RIP neighbors are represented by structures &rip_neighbor. Compared to
56
 * neighbor handling in other routing protocols, RIP does not have explicit
57
 * neighbor discovery and adjacency maintenance, which makes the &rip_neighbor
58
 * related code a bit peculiar. RIP neighbors are interlinked with core neighbor
59
 * structures (&neighbor) and use core neighbor notifications to ensure that RIP
60
 * neighbors are timely removed. RIP neighbors are added based on received route
61
 * notifications and removed based on core neighbor and RIP interface events.
62
 *
63
 * RIP neighbors are linked by RIP routes and use counter to track the number of
64
 * associated routes, but when these RIP routes timeout, associated RIP neighbor
65
 * is still alive (with zero counter). When RIP neighbor is removed but still
66
 * has some associated routes, it is not freed, just changed to detached state
67
 * (core neighbors and RIP ifaces are unlinked), then during the main timer
68
 * cleanup phase the associated routes are removed and the &rip_neighbor
69
 * structure is finally freed.
70
 *
71
 * Supported standards:
72
 * - RFC 1058 - RIPv1
73
 * - RFC 2453 - RIPv2
74
 * - RFC 2080 - RIPng
75
 * - RFC 4822 - RIP cryptographic authentication
76
 */
77

    
78
#include <stdlib.h>
79
#include "rip.h"
80

    
81

    
82
static inline void rip_lock_neighbor(struct rip_neighbor *n);
83
static inline void rip_unlock_neighbor(struct rip_neighbor *n);
84
static inline int rip_iface_link_up(struct rip_iface *ifa);
85
static inline void rip_kick_timer(struct rip_proto *p);
86
static inline void rip_iface_kick_timer(struct rip_iface *ifa);
87
static void rip_iface_timer(timer *timer);
88
static void rip_trigger_update(struct rip_proto *p);
89

    
90

    
91
/*
92
 *        RIP routes
93
 */
94

    
95
static struct rip_rte *
96
rip_add_rte(struct rip_proto *p, struct rip_rte **rp, struct rip_rte *src)
97
{
98
  struct rip_rte *rt = sl_alloc(p->rte_slab);
99

    
100
  memcpy(rt, src, sizeof(struct rip_rte));
101
  rt->next = *rp;
102
  *rp = rt;
103

    
104
  rip_lock_neighbor(rt->from);
105

    
106
  return rt;
107
}
108

    
109
static inline void
110
rip_remove_rte(struct rip_proto *p, struct rip_rte **rp)
111
{
112
  struct rip_rte *rt = *rp;
113

    
114
  rip_unlock_neighbor(rt->from);
115

    
116
  *rp = rt->next;
117
  sl_free(p->rte_slab, rt);
118
}
119

    
120
static inline int rip_same_rte(struct rip_rte *a, struct rip_rte *b)
121
{ return a->metric == b->metric && a->tag == b->tag && ipa_equal(a->next_hop, b->next_hop); }
122

    
123
static inline int rip_valid_rte(struct rip_rte *rt)
124
{ return rt->from->ifa != NULL; }
125

    
126
/**
127
 * rip_announce_rte - announce route from RIP routing table to the core
128
 * @p: RIP instance
129
 * @en: related network
130
 *
131
 * The function takes a list of incoming routes from @en, prepare appropriate
132
 * &rte for the core and propagate it by rte_update().
133
 */
134
static void
135
rip_announce_rte(struct rip_proto *p, struct rip_entry *en)
136
{
137
  struct rip_rte *rt = en->routes;
138

    
139
  /* Find first valid rte */
140
  while (rt && !rip_valid_rte(rt))
141
    rt = rt->next;
142

    
143
  if (rt)
144
  {
145
    /* Update */
146
    rta a0 = {
147
      .src = p->p.main_source,
148
      .source = RTS_RIP,
149
      .scope = SCOPE_UNIVERSE,
150
      .dest = RTD_UNICAST,
151
    };
152

    
153
    u8 rt_metric = rt->metric;
154
    u16 rt_tag = rt->tag;
155

    
156
    if (p->ecmp)
157
    {
158
      /* ECMP route */
159
      struct nexthop *nhs = NULL;
160
      int num = 0;
161

    
162
      for (rt = en->routes; rt && (num < p->ecmp); rt = rt->next)
163
      {
164
        if (!rip_valid_rte(rt))
165
            continue;
166

    
167
        struct nexthop *nh = allocz(sizeof(struct nexthop));
168

    
169
        nh->gw = rt->next_hop;
170
        nh->iface = rt->from->nbr->iface;
171
        nh->weight = rt->from->ifa->cf->ecmp_weight;
172

    
173
        nexthop_insert(&nhs, nh);
174
        num++;
175

    
176
        if (rt->tag != rt_tag)
177
          rt_tag = 0;
178
      }
179

    
180
      a0.nh = *nhs;
181
    }
182
    else
183
    {
184
      /* Unipath route */
185
      a0.from = rt->from->nbr->addr;
186
      a0.nh.gw = rt->next_hop;
187
      a0.nh.iface = rt->from->nbr->iface;
188
    }
189

    
190
    rta *a = rta_lookup(&a0);
191
    rte *e = rte_get_temp(a);
192

    
193
    e->u.rip.from = a0.nh.iface;
194
    e->u.rip.metric = rt_metric;
195
    e->u.rip.tag = rt_tag;
196

    
197
    e->pflags = 0;
198

    
199
    rte_update(&p->p, en->n.addr, e);
200
  }
201
  else
202
  {
203
    /* Withdraw */
204
    rte_update(&p->p, en->n.addr, NULL);
205
  }
206
}
207

    
208
/**
209
 * rip_update_rte - enter a route update to RIP routing table
210
 * @p: RIP instance
211
 * @addr: network address
212
 * @new: a &rip_rte representing the new route
213
 *
214
 * The function is called by the RIP packet processing code whenever it receives
215
 * a reachable route. The appropriate routing table entry is found and the list
216
 * of incoming routes is updated. Eventually, the change is also propagated to
217
 * the core by rip_announce_rte(). Note that for unreachable routes,
218
 * rip_withdraw_rte() should be called instead of rip_update_rte().
219
 */
220
void
221
rip_update_rte(struct rip_proto *p, net_addr *n, struct rip_rte *new)
222
{
223
  struct rip_entry *en = fib_get(&p->rtable, n);
224
  struct rip_rte *rt, **rp;
225
  int changed = 0;
226

    
227
  /* If the new route is better, remove all current routes */
228
  if (en->routes && new->metric < en->routes->metric)
229
    while (en->routes)
230
      rip_remove_rte(p, &en->routes);
231

    
232
  /* Find the old route (also set rp for later) */
233
  for (rp = &en->routes; rt = *rp; rp = &rt->next)
234
    if (rt->from == new->from)
235
    {
236
      if (rip_same_rte(rt, new))
237
      {
238
        rt->expires = new->expires;
239
        return;
240
      }
241

    
242
      /* Remove the old route */
243
      rip_remove_rte(p, rp);
244
      changed = 1;
245
      break;
246
    }
247

    
248
  /* If the new route is optimal, add it to the list */
249
  if (!en->routes || new->metric == en->routes->metric)
250
  {
251
    rt = rip_add_rte(p, rp, new);
252
    changed = 1;
253
  }
254

    
255
  /* Announce change if on relevant position (the first or any for ECMP) */
256
  if (changed && (rp == &en->routes || p->ecmp))
257
    rip_announce_rte(p, en);
258
}
259

    
260
/**
261
 * rip_withdraw_rte - enter a route withdraw to RIP routing table
262
 * @p: RIP instance
263
 * @addr: network address
264
 * @from: a &rip_neighbor propagating the withdraw
265
 *
266
 * The function is called by the RIP packet processing code whenever it receives
267
 * an unreachable route. The incoming route for given network from nbr @from is
268
 * removed. Eventually, the change is also propagated by rip_announce_rte().
269
 */
270
void
271
rip_withdraw_rte(struct rip_proto *p, net_addr *n, struct rip_neighbor *from)
272
{
273
  struct rip_entry *en = fib_find(&p->rtable, n);
274
  struct rip_rte *rt, **rp;
275

    
276
  if (!en)
277
    return;
278

    
279
  /* Find the old route */
280
  for (rp = &en->routes; rt = *rp; rp = &rt->next)
281
    if (rt->from == from)
282
      break;
283

    
284
  if (!rt)
285
    return;
286

    
287
  /* Remove the old route */
288
  rip_remove_rte(p, rp);
289

    
290
  /* Announce change if on relevant position */
291
  if (rp == &en->routes || p->ecmp)
292
    rip_announce_rte(p, en);
293
}
294

    
295
/*
296
 * rip_rt_notify - core tells us about new route, so store
297
 * it into our data structures.
298
 */
299
static void
300
rip_rt_notify(struct proto *P, struct channel *ch UNUSED, struct network *net, struct rte *new,
301
              struct rte *old UNUSED, struct ea_list *attrs)
302
{
303
  struct rip_proto *p = (struct rip_proto *) P;
304
  struct rip_entry *en;
305
  int old_metric;
306

    
307
  if (new)
308
  {
309
    /* Update */
310
    u32 rt_metric = ea_get_int(attrs, EA_RIP_METRIC, 1);
311
    u32 rt_tag = ea_get_int(attrs, EA_RIP_TAG, 0);
312

    
313
    if (rt_metric > p->infinity)
314
    {
315
      log(L_WARN "%s: Invalid rip_metric value %u for route %N",
316
          p->p.name, rt_metric, net->n.addr);
317
      rt_metric = p->infinity;
318
    }
319

    
320
    if (rt_tag > 0xffff)
321
    {
322
      log(L_WARN "%s: Invalid rip_tag value %u for route %N",
323
          p->p.name, rt_tag, net->n.addr);
324
      rt_metric = p->infinity;
325
      rt_tag = 0;
326
    }
327

    
328
    /*
329
     * Note that we accept exported routes with infinity metric (this could
330
     * happen if rip_metric is modified in filters). Such entry has infinity
331
     * metric but is RIP_ENTRY_VALID and therefore is not subject to garbage
332
     * collection.
333
     */
334

    
335
    en = fib_get(&p->rtable, net->n.addr);
336

    
337
    old_metric = en->valid ? en->metric : -1;
338

    
339
    en->valid = RIP_ENTRY_VALID;
340
    en->metric = rt_metric;
341
    en->tag = rt_tag;
342
    en->from = (new->attrs->src->proto == P) ? new->u.rip.from : NULL;
343
    en->iface = new->attrs->nh.iface;
344
    en->next_hop = new->attrs->nh.gw;
345
  }
346
  else
347
  {
348
    /* Withdraw */
349
    en = fib_find(&p->rtable, net->n.addr);
350

    
351
    if (!en || en->valid != RIP_ENTRY_VALID)
352
      return;
353

    
354
    old_metric = en->metric;
355

    
356
    en->valid = RIP_ENTRY_STALE;
357
    en->metric = p->infinity;
358
    en->tag = 0;
359
    en->from = NULL;
360
    en->iface = NULL;
361
    en->next_hop = IPA_NONE;
362
  }
363

    
364
  /* Activate triggered updates */
365
  if (en->metric != old_metric)
366
  {
367
    en->changed = current_time();
368
    rip_trigger_update(p);
369
  }
370
}
371

    
372

    
373
/*
374
 *        RIP neighbors
375
 */
376

    
377
struct rip_neighbor *
378
rip_get_neighbor(struct rip_proto *p, ip_addr *a, struct rip_iface *ifa)
379
{
380
  neighbor *nbr = neigh_find2(&p->p, a, ifa->iface, 0);
381

    
382
  if (!nbr || (nbr->scope == SCOPE_HOST) || !rip_iface_link_up(ifa))
383
    return NULL;
384

    
385
  if (nbr->data)
386
    return nbr->data;
387

    
388
  TRACE(D_EVENTS, "New neighbor %I on %s", *a, ifa->iface->name);
389

    
390
  struct rip_neighbor *n = mb_allocz(p->p.pool, sizeof(struct rip_neighbor));
391
  n->ifa = ifa;
392
  n->nbr = nbr;
393
  nbr->data = n;
394
  n->csn = nbr->aux;
395

    
396
  add_tail(&ifa->neigh_list, NODE n);
397

    
398
  return n;
399
}
400

    
401
static void
402
rip_remove_neighbor(struct rip_proto *p, struct rip_neighbor *n)
403
{
404
  neighbor *nbr = n->nbr;
405

    
406
  TRACE(D_EVENTS, "Removing neighbor %I on %s", nbr->addr, nbr->iface->name);
407

    
408
  rem_node(NODE n);
409
  n->ifa = NULL;
410
  n->nbr = NULL;
411
  nbr->data = NULL;
412
  nbr->aux = n->csn;
413

    
414
  rfree(n->bfd_req);
415
  n->bfd_req = NULL;
416
  n->last_seen = 0;
417

    
418
  if (!n->uc)
419
    mb_free(n);
420

    
421
  /* Related routes are removed in rip_timer() */
422
  rip_kick_timer(p);
423
}
424

    
425
static inline void
426
rip_lock_neighbor(struct rip_neighbor *n)
427
{
428
  n->uc++;
429
}
430

    
431
static inline void
432
rip_unlock_neighbor(struct rip_neighbor *n)
433
{
434
  n->uc--;
435

    
436
  if (!n->nbr && !n->uc)
437
    mb_free(n);
438
}
439

    
440
static void
441
rip_neigh_notify(struct neighbor *nbr)
442
{
443
  struct rip_proto *p = (struct rip_proto *) nbr->proto;
444
  struct rip_neighbor *n = nbr->data;
445

    
446
  if (!n)
447
    return;
448

    
449
  /*
450
   * We assume that rip_neigh_notify() is called before rip_if_notify() for
451
   * IF_CHANGE_DOWN and therefore n->ifa is still valid. We have no such
452
   * ordering assumption for IF_CHANGE_LINK, so we test link state of the
453
   * underlying iface instead of just rip_iface state.
454
   */
455
  if ((nbr->scope <= 0) || !rip_iface_link_up(n->ifa))
456
    rip_remove_neighbor(p, n);
457
}
458

    
459
static void
460
rip_bfd_notify(struct bfd_request *req)
461
{
462
  struct rip_neighbor *n = req->data;
463
  struct rip_proto *p = n->ifa->rip;
464

    
465
  if (req->down)
466
  {
467
    TRACE(D_EVENTS, "BFD session down for nbr %I on %s",
468
          n->nbr->addr, n->ifa->iface->name);
469
    rip_remove_neighbor(p, n);
470
  }
471
}
472

    
473
void
474
rip_update_bfd(struct rip_proto *p, struct rip_neighbor *n)
475
{
476
  int use_bfd = n->ifa->cf->bfd && n->last_seen;
477

    
478
  if (use_bfd && !n->bfd_req)
479
  {
480
    /*
481
     * For RIPv2, use the same address as rip_open_socket(). For RIPng, neighbor
482
     * should contain an address from the same prefix, thus also link-local. It
483
     * may cause problems if two link-local addresses are assigned to one iface.
484
     */
485
    ip_addr saddr = rip_is_v2(p) ? n->ifa->sk->saddr : n->nbr->ifa->ip;
486
    n->bfd_req = bfd_request_session(p->p.pool, n->nbr->addr, saddr,
487
                                     n->nbr->iface, rip_bfd_notify, n);
488
  }
489

    
490
  if (!use_bfd && n->bfd_req)
491
  {
492
    rfree(n->bfd_req);
493
    n->bfd_req = NULL;
494
  }
495
}
496

    
497

    
498
/*
499
 *        RIP interfaces
500
 */
501

    
502
static void
503
rip_iface_start(struct rip_iface *ifa)
504
{
505
  struct rip_proto *p = ifa->rip;
506

    
507
  TRACE(D_EVENTS, "Starting interface %s", ifa->iface->name);
508

    
509
  ifa->next_regular = current_time() + (random() % ifa->cf->update_time) + 100 MS;
510
  ifa->next_triggered = current_time();        /* Available immediately */
511
  ifa->want_triggered = 1;                /* All routes in triggered update */
512
  tm_start(ifa->timer, 100 MS);
513
  ifa->up = 1;
514

    
515
  if (!ifa->cf->passive)
516
    rip_send_request(ifa->rip, ifa);
517
}
518

    
519
static void
520
rip_iface_stop(struct rip_iface *ifa)
521
{
522
  struct rip_proto *p = ifa->rip;
523
  struct rip_neighbor *n;
524

    
525
  TRACE(D_EVENTS, "Stopping interface %s", ifa->iface->name);
526

    
527
  rip_reset_tx_session(p, ifa);
528

    
529
  WALK_LIST_FIRST(n, ifa->neigh_list)
530
    rip_remove_neighbor(p, n);
531

    
532
  tm_stop(ifa->timer);
533
  ifa->up = 0;
534
}
535

    
536
static inline int
537
rip_iface_link_up(struct rip_iface *ifa)
538
{
539
  return !ifa->cf->check_link || (ifa->iface->flags & IF_LINK_UP);
540
}
541

    
542
static void
543
rip_iface_update_state(struct rip_iface *ifa)
544
{
545
  int up = ifa->sk && rip_iface_link_up(ifa);
546

    
547
  if (up == ifa->up)
548
    return;
549

    
550
  if (up)
551
    rip_iface_start(ifa);
552
  else
553
    rip_iface_stop(ifa);
554
}
555

    
556
static void
557
rip_iface_update_buffers(struct rip_iface *ifa)
558
{
559
  if (!ifa->sk)
560
    return;
561

    
562
  uint rbsize = ifa->cf->rx_buffer ?: ifa->iface->mtu;
563
  uint tbsize = ifa->cf->tx_length ?: ifa->iface->mtu;
564
  rbsize = MAX(rbsize, tbsize);
565

    
566
  sk_set_rbsize(ifa->sk, rbsize);
567
  sk_set_tbsize(ifa->sk, tbsize);
568

    
569
  uint headers = (rip_is_v2(ifa->rip) ? IP4_HEADER_LENGTH : IP6_HEADER_LENGTH) + UDP_HEADER_LENGTH;
570
  ifa->tx_plen = tbsize - headers;
571

    
572
  if (ifa->cf->auth_type == RIP_AUTH_CRYPTO)
573
    ifa->tx_plen -= RIP_AUTH_TAIL_LENGTH + max_mac_length(ifa->cf->passwords);
574
}
575

    
576
static inline void
577
rip_iface_update_bfd(struct rip_iface *ifa)
578
{
579
  struct rip_proto *p = ifa->rip;
580
  struct rip_neighbor *n;
581

    
582
  WALK_LIST(n, ifa->neigh_list)
583
    rip_update_bfd(p, n);
584
}
585

    
586

    
587
static void
588
rip_iface_locked(struct object_lock *lock)
589
{
590
  struct rip_iface *ifa = lock->data;
591
  struct rip_proto *p = ifa->rip;
592

    
593
  if (!rip_open_socket(ifa))
594
  {
595
    log(L_ERR "%s: Cannot open socket for %s", p->p.name, ifa->iface->name);
596
    return;
597
  }
598

    
599
  rip_iface_update_buffers(ifa);
600
  rip_iface_update_state(ifa);
601
}
602

    
603

    
604
static struct rip_iface *
605
rip_find_iface(struct rip_proto *p, struct iface *what)
606
{
607
  struct rip_iface *ifa;
608

    
609
  WALK_LIST(ifa, p->iface_list)
610
    if (ifa->iface == what)
611
      return ifa;
612

    
613
  return NULL;
614
}
615

    
616
static void
617
rip_add_iface(struct rip_proto *p, struct iface *iface, struct rip_iface_config *ic)
618
{
619
  struct rip_iface *ifa;
620

    
621
  TRACE(D_EVENTS, "Adding interface %s", iface->name);
622

    
623
  ifa = mb_allocz(p->p.pool, sizeof(struct rip_iface));
624
  ifa->rip = p;
625
  ifa->iface = iface;
626
  ifa->cf = ic;
627

    
628
  if (ipa_nonzero(ic->address))
629
    ifa->addr = ic->address;
630
  else if (ic->mode == RIP_IM_MULTICAST)
631
    ifa->addr = rip_is_v2(p) ? IP4_RIP_ROUTERS : IP6_RIP_ROUTERS;
632
  else /* Broadcast */
633
    ifa->addr = iface->addr4->brd;
634
  /*
635
   * The above is just a workaround for BSD as it can't send broadcasts
636
   * to 255.255.255.255. BSD systems need the network broadcast address instead.
637
   *
638
   * TODO: move this to sysdep code
639
   */
640

    
641
  init_list(&ifa->neigh_list);
642

    
643
  add_tail(&p->iface_list, NODE ifa);
644

    
645
  ifa->timer = tm_new_init(p->p.pool, rip_iface_timer, ifa, 0, 0);
646

    
647
  struct object_lock *lock = olock_new(p->p.pool);
648
  lock->type = OBJLOCK_UDP;
649
  lock->port = ic->port;
650
  lock->iface = iface;
651
  lock->data = ifa;
652
  lock->hook = rip_iface_locked;
653
  ifa->lock = lock;
654

    
655
  olock_acquire(lock);
656
}
657

    
658
static void
659
rip_remove_iface(struct rip_proto *p, struct rip_iface *ifa)
660
{
661
  rip_iface_stop(ifa);
662

    
663
  TRACE(D_EVENTS, "Removing interface %s", ifa->iface->name);
664

    
665
  rem_node(NODE ifa);
666

    
667
  rfree(ifa->sk);
668
  rfree(ifa->lock);
669
  rfree(ifa->timer);
670

    
671
  mb_free(ifa);
672
}
673

    
674
static int
675
rip_reconfigure_iface(struct rip_proto *p, struct rip_iface *ifa, struct rip_iface_config *new)
676
{
677
  struct rip_iface_config *old = ifa->cf;
678

    
679
  /* Change of these options would require to reset the iface socket */
680
  if ((new->mode != old->mode) ||
681
      (new->port != old->port) ||
682
      (new->tx_tos != old->tx_tos) ||
683
      (new->tx_priority != old->tx_priority) ||
684
      (new->ttl_security != old->ttl_security))
685
    return 0;
686

    
687
  TRACE(D_EVENTS, "Reconfiguring interface %s", ifa->iface->name);
688

    
689
  ifa->cf = new;
690

    
691
  rip_iface_update_buffers(ifa);
692

    
693
  if (ifa->next_regular > (current_time() + new->update_time))
694
    ifa->next_regular = current_time() + (random() % new->update_time) + 100 MS;
695

    
696
  if (new->check_link != old->check_link)
697
    rip_iface_update_state(ifa);
698

    
699
  if (new->bfd != old->bfd)
700
    rip_iface_update_bfd(ifa);
701

    
702
  if (ifa->up)
703
    rip_iface_kick_timer(ifa);
704

    
705
  return 1;
706
}
707

    
708
static void
709
rip_reconfigure_ifaces(struct rip_proto *p, struct rip_config *cf)
710
{
711
  struct iface *iface;
712

    
713
  WALK_LIST(iface, iface_list)
714
  {
715
    if (!(iface->flags & IF_UP))
716
      continue;
717

    
718
    /* Ignore ifaces without appropriate address */
719
    if (rip_is_v2(p) ? !iface->addr4 : !iface->llv6)
720
      continue;
721

    
722
    struct rip_iface *ifa = rip_find_iface(p, iface);
723
    struct rip_iface_config *ic = (void *) iface_patt_find(&cf->patt_list, iface, NULL);
724

    
725
    if (ifa && ic)
726
    {
727
      if (rip_reconfigure_iface(p, ifa, ic))
728
        continue;
729

    
730
      /* Hard restart */
731
      log(L_INFO "%s: Restarting interface %s", p->p.name, ifa->iface->name);
732
      rip_remove_iface(p, ifa);
733
      rip_add_iface(p, iface, ic);
734
    }
735

    
736
    if (ifa && !ic)
737
      rip_remove_iface(p, ifa);
738

    
739
    if (!ifa && ic)
740
      rip_add_iface(p, iface, ic);
741
  }
742
}
743

    
744
static void
745
rip_if_notify(struct proto *P, unsigned flags, struct iface *iface)
746
{
747
  struct rip_proto *p = (void *) P;
748
  struct rip_config *cf = (void *) P->cf;
749

    
750
  if (iface->flags & IF_IGNORE)
751
    return;
752

    
753
  if (flags & IF_CHANGE_UP)
754
  {
755
    struct rip_iface_config *ic = (void *) iface_patt_find(&cf->patt_list, iface, NULL);
756

    
757
    /* Ignore ifaces without appropriate address */
758
    if (rip_is_v2(p) ? !iface->addr4 : !iface->llv6)
759
      return;
760

    
761
    if (ic)
762
      rip_add_iface(p, iface, ic);
763

    
764
    return;
765
  }
766

    
767
  struct rip_iface *ifa = rip_find_iface(p, iface);
768

    
769
  if (!ifa)
770
    return;
771

    
772
  if (flags & IF_CHANGE_DOWN)
773
  {
774
    rip_remove_iface(p, ifa);
775
    return;
776
  }
777

    
778
  if (flags & IF_CHANGE_MTU)
779
    rip_iface_update_buffers(ifa);
780

    
781
  if (flags & IF_CHANGE_LINK)
782
    rip_iface_update_state(ifa);
783
}
784

    
785

    
786
/*
787
 *        RIP timer events
788
 */
789

    
790
/**
791
 * rip_timer - RIP main timer hook
792
 * @t: timer
793
 *
794
 * The RIP main timer is responsible for routing table maintenance. Invalid or
795
 * expired routes (&rip_rte) are removed and garbage collection of stale routing
796
 * table entries (&rip_entry) is done. Changes are propagated to core tables,
797
 * route reload is also done here. Note that garbage collection uses a maximal
798
 * GC time, while interfaces maintain an illusion of per-interface GC times in
799
 * rip_send_response().
800
 *
801
 * Keeping incoming routes and the selected outgoing route are two independent
802
 * functions, therefore after garbage collection some entries now considered
803
 * invalid (RIP_ENTRY_DUMMY) still may have non-empty list of incoming routes,
804
 * while some valid entries (representing an outgoing route) may have that list
805
 * empty.
806
 *
807
 * The main timer is not scheduled periodically but it uses the time of the
808
 * current next event and the minimal interval of any possible event to compute
809
 * the time of the next run.
810
 */
811
static void
812
rip_timer(timer *t)
813
{
814
  struct rip_proto *p = t->data;
815
  struct rip_config *cf = (void *) (p->p.cf);
816
  struct rip_iface *ifa;
817
  struct rip_neighbor *n, *nn;
818
  struct fib_iterator fit;
819
  btime now_ = current_time();
820
  btime next = now_ + MIN(cf->min_timeout_time, cf->max_garbage_time);
821
  btime expires = 0;
822

    
823
  TRACE(D_EVENTS, "Main timer fired");
824

    
825
  FIB_ITERATE_INIT(&fit, &p->rtable);
826

    
827
  loop:
828
  FIB_ITERATE_START(&p->rtable, &fit, struct rip_entry, en)
829
  {
830
    struct rip_rte *rt, **rp;
831
    int changed = 0;
832

    
833
    /* Checking received routes for timeout and for dead neighbors */
834
    for (rp = &en->routes; rt = *rp; /* rp = &rt->next */)
835
    {
836
      if (!rip_valid_rte(rt) || (rt->expires <= now_))
837
      {
838
        rip_remove_rte(p, rp);
839
        changed = 1;
840
        continue;
841
      }
842

    
843
      next = MIN(next, rt->expires);
844
      rp = &rt->next;
845
    }
846

    
847
    /* Propagating eventual change */
848
    if (changed || p->rt_reload)
849
    {
850
      /*
851
       * We have to restart the iteration because there may be a cascade of
852
       * synchronous events rip_announce_rte() -> nest table change ->
853
       * rip_rt_notify() -> p->rtable change, invalidating hidden variables.
854
       */
855

    
856
      FIB_ITERATE_PUT_NEXT(&fit, &p->rtable);
857
      rip_announce_rte(p, en);
858
      goto loop;
859
    }
860

    
861
    /* Checking stale entries for garbage collection timeout */
862
    if (en->valid == RIP_ENTRY_STALE)
863
    {
864
      expires = en->changed + cf->max_garbage_time;
865

    
866
      if (expires <= now_)
867
      {
868
        // TRACE(D_EVENTS, "entry is too old: %N", en->n.addr);
869
        en->valid = 0;
870
      }
871
      else
872
        next = MIN(next, expires);
873
    }
874

    
875
    /* Remove empty nodes */
876
    if (!en->valid && !en->routes)
877
    {
878
      FIB_ITERATE_PUT(&fit);
879
      fib_delete(&p->rtable, en);
880
      goto loop;
881
    }
882
  }
883
  FIB_ITERATE_END;
884

    
885
  p->rt_reload = 0;
886

    
887
  /* Handling neighbor expiration */
888
  WALK_LIST(ifa, p->iface_list)
889
    WALK_LIST_DELSAFE(n, nn, ifa->neigh_list)
890
      if (n->last_seen)
891
      {
892
        expires = n->last_seen + n->ifa->cf->timeout_time;
893

    
894
        if (expires <= now_)
895
          rip_remove_neighbor(p, n);
896
        else
897
          next = MIN(next, expires);
898
      }
899

    
900
  tm_start(p->timer, MAX(next - now_, 100 MS));
901
}
902

    
903
static inline void
904
rip_kick_timer(struct rip_proto *p)
905
{
906
  if (p->timer->expires > (current_time() + 100 MS))
907
    tm_start(p->timer, 100 MS);
908
}
909

    
910
/**
911
 * rip_iface_timer - RIP interface timer hook
912
 * @t: timer
913
 *
914
 * RIP interface timers are responsible for scheduling both regular and
915
 * triggered updates. Fixed, delay-independent period is used for regular
916
 * updates, while minimal separating interval is enforced for triggered updates.
917
 * The function also ensures that a new update is not started when the old one
918
 * is still running.
919
 */
920
static void
921
rip_iface_timer(timer *t)
922
{
923
  struct rip_iface *ifa = t->data;
924
  struct rip_proto *p = ifa->rip;
925
  btime now_ = current_time();
926
  btime period = ifa->cf->update_time;
927

    
928
  if (ifa->cf->passive)
929
    return;
930

    
931
  TRACE(D_EVENTS, "Interface timer fired for %s", ifa->iface->name);
932

    
933
  if (ifa->tx_active)
934
  {
935
    if (now_ < (ifa->next_regular + period))
936
    { tm_start(ifa->timer, 100 MS); return; }
937

    
938
    /* We are too late, reset is done by rip_send_table() */
939
    log(L_WARN "%s: Too slow update on %s, resetting", p->p.name, ifa->iface->name);
940
  }
941

    
942
  if (now_ >= ifa->next_regular)
943
  {
944
    /* Send regular update, set timer for next period (or following one if necessay) */
945
    TRACE(D_EVENTS, "Sending regular updates for %s", ifa->iface->name);
946
    rip_send_table(p, ifa, ifa->addr, 0);
947
    ifa->next_regular += period * (1 + ((now_ - ifa->next_regular) / period));
948
    ifa->want_triggered = 0;
949
    p->triggered = 0;
950
  }
951
  else if (ifa->want_triggered && (now_ >= ifa->next_triggered))
952
  {
953
    /* Send triggered update, enforce interval between triggered updates */
954
    TRACE(D_EVENTS, "Sending triggered updates for %s", ifa->iface->name);
955
    rip_send_table(p, ifa, ifa->addr, ifa->want_triggered);
956
    ifa->next_triggered = now_ + MIN(5 S, period / 2);
957
    ifa->want_triggered = 0;
958
    p->triggered = 0;
959
  }
960

    
961
  tm_start(ifa->timer, ifa->want_triggered ? (1 S) : (ifa->next_regular - now_));
962
}
963

    
964
static inline void
965
rip_iface_kick_timer(struct rip_iface *ifa)
966
{
967
  if (ifa->timer->expires > (current_time() + 100 MS))
968
    tm_start(ifa->timer, 100 MS);
969
}
970

    
971
static void
972
rip_trigger_update(struct rip_proto *p)
973
{
974
  if (p->triggered)
975
    return;
976

    
977
  struct rip_iface *ifa;
978
  WALK_LIST(ifa, p->iface_list)
979
  {
980
    /* Interface not active */
981
    if (! ifa->up)
982
      continue;
983

    
984
    /* Already scheduled */
985
    if (ifa->want_triggered)
986
      continue;
987

    
988
    TRACE(D_EVENTS, "Scheduling triggered updates for %s", ifa->iface->name);
989
    ifa->want_triggered = current_time();
990
    rip_iface_kick_timer(ifa);
991
  }
992

    
993
  p->triggered = 1;
994
}
995

    
996

    
997
/*
998
 *        RIP protocol glue
999
 */
1000

    
1001
static struct ea_list *
1002
rip_prepare_attrs(struct linpool *pool, ea_list *next, u8 metric, u16 tag)
1003
{
1004
  struct ea_list *l = lp_alloc(pool, sizeof(struct ea_list) + 2 * sizeof(eattr));
1005

    
1006
  l->next = next;
1007
  l->flags = EALF_SORTED;
1008
  l->count = 2;
1009

    
1010
  l->attrs[0].id = EA_RIP_METRIC;
1011
  l->attrs[0].flags = 0;
1012
  l->attrs[0].type = EAF_TYPE_INT | EAF_TEMP;
1013
  l->attrs[0].u.data = metric;
1014

    
1015
  l->attrs[1].id = EA_RIP_TAG;
1016
  l->attrs[1].flags = 0;
1017
  l->attrs[1].type = EAF_TYPE_INT | EAF_TEMP;
1018
  l->attrs[1].u.data = tag;
1019

    
1020
  return l;
1021
}
1022

    
1023
static int
1024
rip_import_control(struct proto *P UNUSED, struct rte **rt, struct ea_list **attrs, struct linpool *pool)
1025
{
1026
  /* Prepare attributes with initial values */
1027
  if ((*rt)->attrs->source != RTS_RIP)
1028
    *attrs = rip_prepare_attrs(pool, *attrs, 1, 0);
1029

    
1030
  return 0;
1031
}
1032

    
1033
static void
1034
rip_reload_routes(struct channel *C)
1035
{
1036
  struct rip_proto *p = (struct rip_proto *) C->proto;
1037

    
1038
  if (p->rt_reload)
1039
    return;
1040

    
1041
  TRACE(D_EVENTS, "Scheduling route reload");
1042
  p->rt_reload = 1;
1043
  rip_kick_timer(p);
1044
}
1045

    
1046
static struct ea_list *
1047
rip_make_tmp_attrs(struct rte *rt, struct linpool *pool)
1048
{
1049
  return rip_prepare_attrs(pool, NULL, rt->u.rip.metric, rt->u.rip.tag);
1050
}
1051

    
1052
static void
1053
rip_store_tmp_attrs(struct rte *rt, struct ea_list *attrs)
1054
{
1055
  rt->u.rip.metric = ea_get_int(attrs, EA_RIP_METRIC, 1);
1056
  rt->u.rip.tag = ea_get_int(attrs, EA_RIP_TAG, 0);
1057
}
1058

    
1059
static int
1060
rip_rte_better(struct rte *new, struct rte *old)
1061
{
1062
  return new->u.rip.metric < old->u.rip.metric;
1063
}
1064

    
1065
static int
1066
rip_rte_same(struct rte *new, struct rte *old)
1067
{
1068
  return ((new->u.rip.metric == old->u.rip.metric) &&
1069
          (new->u.rip.tag == old->u.rip.tag) &&
1070
          (new->u.rip.from == old->u.rip.from));
1071
}
1072

    
1073

    
1074
static void
1075
rip_postconfig(struct proto_config *CF)
1076
{
1077
  // struct rip_config *cf = (void *) CF;
1078

    
1079
  /* Define default channel */
1080
  if (EMPTY_LIST(CF->channels))
1081
    channel_config_new(NULL, net_label[CF->net_type], CF->net_type, CF);
1082
}
1083

    
1084
static struct proto *
1085
rip_init(struct proto_config *CF)
1086
{
1087
  struct proto *P = proto_new(CF);
1088

    
1089
  P->main_channel = proto_add_channel(P, proto_cf_main_channel(CF));
1090

    
1091
  P->if_notify = rip_if_notify;
1092
  P->rt_notify = rip_rt_notify;
1093
  P->neigh_notify = rip_neigh_notify;
1094
  P->import_control = rip_import_control;
1095
  P->reload_routes = rip_reload_routes;
1096
  P->make_tmp_attrs = rip_make_tmp_attrs;
1097
  P->store_tmp_attrs = rip_store_tmp_attrs;
1098
  P->rte_better = rip_rte_better;
1099
  P->rte_same = rip_rte_same;
1100

    
1101
  return P;
1102
}
1103

    
1104
static int
1105
rip_start(struct proto *P)
1106
{
1107
  struct rip_proto *p = (void *) P;
1108
  struct rip_config *cf = (void *) (P->cf);
1109

    
1110
  init_list(&p->iface_list);
1111
  fib_init(&p->rtable, P->pool, cf->rip2 ? NET_IP4 : NET_IP6,
1112
           sizeof(struct rip_entry), OFFSETOF(struct rip_entry, n), 0, NULL);
1113
  p->rte_slab = sl_new(P->pool, sizeof(struct rip_rte));
1114
  p->timer = tm_new_init(P->pool, rip_timer, p, 0, 0);
1115

    
1116
  p->rip2 = cf->rip2;
1117
  p->ecmp = cf->ecmp;
1118
  p->infinity = cf->infinity;
1119
  p->triggered = 0;
1120

    
1121
  p->log_pkt_tbf = (struct tbf){ .rate = 1, .burst = 5 };
1122
  p->log_rte_tbf = (struct tbf){ .rate = 4, .burst = 20 };
1123

    
1124
  tm_start(p->timer, MIN(cf->min_timeout_time, cf->max_garbage_time));
1125

    
1126
  return PS_UP;
1127
}
1128

    
1129
static int
1130
rip_reconfigure(struct proto *P, struct proto_config *CF)
1131
{
1132
  struct rip_proto *p = (void *) P;
1133
  struct rip_config *new = (void *) CF;
1134
  // struct rip_config *old = (void *) (P->cf);
1135

    
1136
  if (new->rip2 != p->rip2)
1137
    return 0;
1138

    
1139
  if (new->infinity != p->infinity)
1140
    return 0;
1141

    
1142
  if (!proto_configure_channel(P, &P->main_channel, proto_cf_main_channel(CF)))
1143
    return 0;
1144

    
1145
  TRACE(D_EVENTS, "Reconfiguring");
1146

    
1147
  p->p.cf = CF;
1148
  p->ecmp = new->ecmp;
1149
  rip_reconfigure_ifaces(p, new);
1150

    
1151
  p->rt_reload = 1;
1152
  rip_kick_timer(p);
1153

    
1154
  return 1;
1155
}
1156

    
1157
static void
1158
rip_get_route_info(rte *rte, byte *buf, ea_list *attrs UNUSED)
1159
{
1160
  buf += bsprintf(buf, " (%d/%d)", rte->pref, rte->u.rip.metric);
1161

    
1162
  if (rte->u.rip.tag)
1163
    bsprintf(buf, " [%04x]", rte->u.rip.tag);
1164
}
1165

    
1166
static int
1167
rip_get_attr(eattr *a, byte *buf, int buflen UNUSED)
1168
{
1169
  switch (a->id)
1170
  {
1171
  case EA_RIP_METRIC:
1172
    bsprintf(buf, "metric: %d", a->u.data);
1173
    return GA_FULL;
1174

    
1175
  case EA_RIP_TAG:
1176
    bsprintf(buf, "tag: %04x", a->u.data);
1177
    return GA_FULL;
1178

    
1179
  default:
1180
    return GA_UNKNOWN;
1181
  }
1182
}
1183

    
1184
void
1185
rip_show_interfaces(struct proto *P, char *iff)
1186
{
1187
  struct rip_proto *p = (void *) P;
1188
  struct rip_iface *ifa = NULL;
1189
  struct rip_neighbor *n = NULL;
1190

    
1191
  if (p->p.proto_state != PS_UP)
1192
  {
1193
    cli_msg(-1021, "%s: is not up", p->p.name);
1194
    cli_msg(0, "");
1195
    return;
1196
  }
1197

    
1198
  cli_msg(-1021, "%s:", p->p.name);
1199
  cli_msg(-1021, "%-10s %-6s %6s %6s %7s",
1200
          "Interface", "State", "Metric", "Nbrs", "Timer");
1201

    
1202
  WALK_LIST(ifa, p->iface_list)
1203
  {
1204
    if (iff && !patmatch(iff, ifa->iface->name))
1205
      continue;
1206

    
1207
    int nbrs = 0;
1208
    WALK_LIST(n, ifa->neigh_list)
1209
      if (n->last_seen)
1210
        nbrs++;
1211

    
1212
    btime now_ = current_time();
1213
    btime timer = (ifa->next_regular > now_) ? (ifa->next_regular - now_) : 0;
1214
    cli_msg(-1021, "%-10s %-6s %6u %6u %7t",
1215
            ifa->iface->name, (ifa->up ? "Up" : "Down"), ifa->cf->metric, nbrs, timer);
1216
  }
1217

    
1218
  cli_msg(0, "");
1219
}
1220

    
1221
void
1222
rip_show_neighbors(struct proto *P, char *iff)
1223
{
1224
  struct rip_proto *p = (void *) P;
1225
  struct rip_iface *ifa = NULL;
1226
  struct rip_neighbor *n = NULL;
1227

    
1228
  if (p->p.proto_state != PS_UP)
1229
  {
1230
    cli_msg(-1022, "%s: is not up", p->p.name);
1231
    cli_msg(0, "");
1232
    return;
1233
  }
1234

    
1235
  cli_msg(-1022, "%s:", p->p.name);
1236
  cli_msg(-1022, "%-25s %-10s %6s %6s %7s",
1237
          "IP address", "Interface", "Metric", "Routes", "Seen");
1238

    
1239
  WALK_LIST(ifa, p->iface_list)
1240
  {
1241
    if (iff && !patmatch(iff, ifa->iface->name))
1242
      continue;
1243

    
1244
    WALK_LIST(n, ifa->neigh_list)
1245
    {
1246
      if (!n->last_seen)
1247
        continue;
1248

    
1249
      btime timer = current_time() - n->last_seen;
1250
      cli_msg(-1022, "%-25I %-10s %6u %6u %7t",
1251
              n->nbr->addr, ifa->iface->name, ifa->cf->metric, n->uc, timer);
1252
    }
1253
  }
1254

    
1255
  cli_msg(0, "");
1256
}
1257

    
1258
static void
1259
rip_dump(struct proto *P)
1260
{
1261
  struct rip_proto *p = (struct rip_proto *) P;
1262
  struct rip_iface *ifa;
1263
  int i;
1264

    
1265
  i = 0;
1266
  FIB_WALK(&p->rtable, struct rip_entry, en)
1267
  {
1268
    debug("RIP: entry #%d: %N via %I dev %s valid %d metric %d age %t\n",
1269
          i++, en->n.addr, en->next_hop, en->iface->name,
1270
          en->valid, en->metric, current_time() - en->changed);
1271
  }
1272
  FIB_WALK_END;
1273

    
1274
  i = 0;
1275
  WALK_LIST(ifa, p->iface_list)
1276
  {
1277
    debug("RIP: interface #%d: %s, %I, up = %d, busy = %d\n",
1278
          i++, ifa->iface->name, ifa->sk ? ifa->sk->daddr : IPA_NONE,
1279
          ifa->up, ifa->tx_active);
1280
  }
1281
}
1282

    
1283

    
1284
struct protocol proto_rip = {
1285
  .name =                "RIP",
1286
  .template =                "rip%d",
1287
  .attr_class =                EAP_RIP,
1288
  .preference =                DEF_PREF_RIP,
1289
  .channel_mask =        NB_IP,
1290
  .proto_size =                sizeof(struct rip_proto),
1291
  .config_size =        sizeof(struct rip_config),
1292
  .postconfig =                rip_postconfig,
1293
  .init =                rip_init,
1294
  .dump =                rip_dump,
1295
  .start =                rip_start,
1296
  .reconfigure =        rip_reconfigure,
1297
  .get_route_info =        rip_get_route_info,
1298
  .get_attr =                rip_get_attr
1299
};