Statistics
| Branch: | Revision:

iof-bird-daemon / proto / ospf / ospf.h @ fe9f1a6d

History | View | Annotate | Download (27.5 KB)

1
/*
2
 *        BIRD -- OSPF
3
 *
4
 *        (c) 1999--2005 Ondrej Filip <feela@network.cz>
5
 *        (c) 2009--2014 Ondrej Zajicek <santiago@crfreenet.org>
6
 *        (c) 2009--2014 CZ.NIC z.s.p.o.
7
 *
8
 *        Can be freely distributed and used under the terms of the GNU GPL.
9
 */
10

    
11
#ifndef _BIRD_OSPF_H_
12
#define _BIRD_OSPF_H_
13

    
14
#include "nest/bird.h"
15

    
16
#include "lib/checksum.h"
17
#include "lib/ip.h"
18
#include "lib/lists.h"
19
#include "lib/slists.h"
20
#include "lib/socket.h"
21
#include "lib/timer.h"
22
#include "lib/resource.h"
23
#include "nest/protocol.h"
24
#include "nest/iface.h"
25
#include "nest/route.h"
26
#include "nest/cli.h"
27
#include "nest/locks.h"
28
#include "nest/bfd.h"
29
#include "conf/conf.h"
30
#include "lib/string.h"
31

    
32

    
33
#ifdef LOCAL_DEBUG
34
#define OSPF_FORCE_DEBUG 1
35
#else
36
#define OSPF_FORCE_DEBUG 0
37
#endif
38

    
39

    
40
#ifdef IPV6
41
#define OSPF_IS_V2 0
42
#else
43
#define OSPF_IS_V2 1
44
#endif
45

    
46
// FIXME: MAX_PREFIX_LENGTH
47

    
48
#define OSPF_TRACE(flags, msg, args...) \
49
  do { if ((p->p.debug & flags) || OSPF_FORCE_DEBUG) \
50
    log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
51

    
52
#define OSPF_PACKET(dumpfn, buffer, msg, args...) \
53
  do { if ((p->p.debug & D_PACKETS) || OSPF_FORCE_DEBUG)                \
54
    { log(L_TRACE "%s: " msg, p->p.name, ## args ); dumpfn(p, buffer); } } while(0)
55

    
56
#define LOG_PKT(msg, args...) \
57
  log_rl(&p->log_pkt_tbf, L_REMOTE "%s: " msg, p->p.name, args)
58

    
59
#define LOG_PKT_AUTH(msg, args...) \
60
  log_rl(&p->log_pkt_tbf, L_AUTH "%s: " msg, p->p.name, args)
61

    
62
#define LOG_PKT_WARN(msg, args...) \
63
  log_rl(&p->log_pkt_tbf, L_WARN "%s: " msg, p->p.name, args)
64

    
65
#define LOG_LSA1(msg, args...) \
66
  log_rl(&p->log_lsa_tbf, L_REMOTE "%s: " msg, p->p.name, args)
67

    
68
#define LOG_LSA2(msg, args...) \
69
  do { if (! p->log_lsa_tbf.mark) \
70
    log(L_REMOTE "%s: " msg, p->p.name, args); } while(0)
71

    
72

    
73
#define OSPF_PROTO 89
74

    
75
#define LSREFRESHTIME 1800        /* 30 minutes */
76
#define MINLSINTERVAL 5
77
#define MINLSARRIVAL 1
78
#define LSINFINITY 0xffffff
79

    
80
#define OSPF_DEFAULT_TICK 1
81
#define OSPF_DEFAULT_STUB_COST 1000
82
#define OSPF_DEFAULT_ECMP_LIMIT 16
83
#define OSPF_DEFAULT_TRANSINT 40
84

    
85
#define OSPF_MIN_PKT_SIZE 256
86
#define OSPF_MAX_PKT_SIZE 65535
87

    
88
#define OSPF_VLINK_ID_OFFSET 0x80000000
89

    
90

    
91
struct ospf_config
92
{
93
  struct proto_config c;
94
  uint tick;
95
  u8 ospf2;
96
  u8 rfc1583;
97
  u8 stub_router;
98
  u8 merge_external;
99
  u8 instance_id;
100
  u8 abr;
101
  u8 asbr;
102
  int ecmp;
103
  list area_list;                /* list of area configs (struct ospf_area_config) */
104
  list vlink_list;                /* list of configured vlinks (struct ospf_iface_patt) */
105
};
106

    
107
struct ospf_area_config
108
{
109
  node n;
110
  u32 areaid;
111
  u32 default_cost;                /* Cost of default route for stub areas
112
                                   (With possible LSA_EXT3_EBIT for NSSA areas) */
113
  u8 type;                        /* Area type (standard, stub, NSSA), represented
114
                                   by option flags (OPT_E, OPT_N) */
115
  u8 summary;                        /* Import summaries to this stub/NSSA area, valid for ABR */
116
  u8 default_nssa;                /* Generate default NSSA route for NSSA+summary area */
117
  u8 translator;                /* Translator role, for NSSA ABR */
118
  u32 transint;                        /* Translator stability interval */
119
  list patt_list;                /* List of iface configs (struct ospf_iface_patt) */
120
  list net_list;                /* List of aggregate networks for that area */
121
  list enet_list;                /* List of aggregate external (NSSA) networks */
122
  list stubnet_list;                /* List of stub networks added to Router LSA */
123
};
124

    
125
struct area_net_config
126
{
127
  node n;
128
  struct prefix px;
129
  u32 tag;
130
  u8 hidden;
131
};
132

    
133
struct area_net
134
{
135
  u32 metric;                        /* With possible LSA_EXT3_EBIT for NSSA area nets */
136
  u32 tag;
137
  u8 hidden;
138
  u8 active;
139
  struct fib_node fn;
140
};
141

    
142
struct ospf_stubnet_config
143
{
144
  node n;
145
  struct prefix px;
146
  u32 cost;
147
  u8 hidden;
148
  u8 summary;
149
};
150

    
151
struct nbma_node
152
{
153
  node n;
154
  ip_addr ip;
155
  byte eligible;
156
  byte found;
157
};
158

    
159
struct ospf_iface_patt
160
{
161
  struct iface_patt i;
162
  u32 type;
163
  u32 stub;
164
  u32 cost;
165
  u32 helloint;
166
  u32 rxmtint;
167
  u32 pollint;
168
  u32 waitint;
169
  u32 deadc;
170
  u32 deadint;
171
  u32 inftransdelay;
172
  list nbma_list;
173
  u32 priority;
174
  u32 voa;
175
  u32 vid;
176
  int tx_tos;
177
  int tx_priority;
178
  u16 tx_length;
179
  u16 rx_buffer;
180

    
181
#define OSPF_RXBUF_MINSIZE 256        /* Minimal allowed size */
182
  u8 instance_id;
183
  u8 autype;                        /* Not really used in OSPFv3 */
184
#define OSPF_AUTH_NONE 0
185
#define OSPF_AUTH_SIMPLE 1
186
#define OSPF_AUTH_CRYPT 2
187
#define OSPF_AUTH_CRYPT_SIZE 16
188
  u8 strictnbma;
189
  u8 check_link;
190
  u8 ecmp_weight;
191
  u8 link_lsa_suppression;
192
  u8 real_bcast;                /* Not really used in OSPFv3 */
193
  u8 ptp_netmask;                /* bool + 2 for unspecified */
194
  u8 ttl_security;                /* bool + 2 for TX only */
195
  u8 bfd;
196
  u8 bsd_secondary;
197
  list *passwords;
198
};
199

    
200
/* Default values for interface parameters */
201
#define COST_D 10
202
#define RXMTINT_D 5
203
#define INFTRANSDELAY_D 1
204
#define PRIORITY_D 1
205
#define HELLOINT_D 10
206
#define POLLINT_D 20
207
#define DEADC_D 4
208
#define WAIT_DMH 4
209
  /* Value of Wait timer - not found it in RFC * - using 4*HELLO */
210

    
211

    
212

    
213
struct ospf_proto
214
{
215
  struct proto p;
216
  timer *disp_timer;                /* OSPF proto dispatcher */
217
  uint tick;
218
  struct top_graph *gr;                /* LSA graph */
219
  slist lsal;                        /* List of all LSA's */
220
  int calcrt;                        /* Routing table calculation scheduled?
221
                                   0=no, 1=normal, 2=forced reload */
222
  list iface_list;                /* List of OSPF interfaces (struct ospf_iface) */
223
  list area_list;                /* List of OSPF areas (struct ospf_area) */
224
  int areano;                        /* Number of area I belong to */
225
  int padj;                        /* Number of neighbors in Exchange or Loading state */
226
  struct fib rtf;                /* Routing table */
227
  byte ospf2;                        /* OSPF v2 or v3 */
228
  byte rfc1583;                        /* RFC1583 compatibility */
229
  byte stub_router;                /* Do not forward transit traffic */
230
  byte merge_external;                /* Should i merge external routes? */
231
  byte asbr;                        /* May i originate any ext/NSSA lsa? */
232
  byte ecmp;                        /* Maximal number of nexthops in ECMP route, or 0 */
233
  struct ospf_area *backbone;        /* If exists */
234
  event *flood_event;                /* Event for flooding LS updates */
235
  void *lsab;                        /* LSA buffer used when originating router LSAs */
236
  int lsab_size, lsab_used;
237
  linpool *nhpool;                /* Linpool used for next hops computed in SPF */
238
  sock *vlink_sk;                /* IP socket used for vlink TX */
239
  u32 router_id;
240
  u32 last_vlink_id;                /* Interface IDs for vlinks (starts at 0x80000000) */
241
  struct tbf log_pkt_tbf;        /* TBF for packet messages */
242
  struct tbf log_lsa_tbf;        /* TBF for LSA messages */
243
};
244

    
245
struct ospf_area
246
{
247
  node n;
248
  u32 areaid;
249
  struct ospf_area_config *ac;        /* Related area config */
250
  struct top_hash_entry *rt;        /* My own router LSA */
251
  struct top_hash_entry *pxr_lsa; /* Originated prefix LSA */
252
  list cand;                        /* List of candidates for RT calc. */
253
  struct fib net_fib;                /* Networks to advertise or not */
254
  struct fib enet_fib;                /* External networks for NSSAs */
255
  u32 options;                        /* Optional features */
256
  u8 update_rt_lsa;                /* Rt lsa origination scheduled? */
257
  u8 trcap;                        /* Transit capability? */
258
  u8 marked;                        /* Used in OSPF reconfigure */
259
  u8 translate;                        /* Translator state (TRANS_*), for NSSA ABR  */
260
  timer *translator_timer;        /* For NSSA translator switch */
261
  struct ospf_proto *po;
262
  struct fib rtr;                /* Routing tables for routers */
263
};
264

    
265

    
266

    
267
struct ospf_iface
268
{
269
  node n;
270
  struct iface *iface;                /* Nest's iface (NULL for vlinks) */
271
  struct ifa *addr;                /* IP prefix associated with that OSPF iface */
272
  struct ospf_area *oa;
273
  struct ospf_iface_patt *cf;
274
  char *ifname;                        /* Interface name (iface->name), new one for vlinks */
275

    
276
  pool *pool;
277
  sock *sk;                        /* IP socket */
278
  list neigh_list;                /* List of neighbors (struct ospf_neighbor) */
279
  u32 cost;                        /* Cost of iface */
280
  u32 waitint;                        /* number of sec before changing state from wait */
281
  u32 rxmtint;                        /* number of seconds between LSA retransmissions */
282
  u32 pollint;                        /* Poll interval */
283
  u32 deadint;                        /* after "deadint" missing hellos is router dead */
284
  u32 iface_id;                        /* Interface ID (iface->index or new value for vlinks) */
285
  u32 vid;                        /* ID of peer of virtual link */
286
  ip_addr vip;                        /* IP of peer of virtual link */
287
  struct ospf_iface *vifa;        /* OSPF iface which the vlink goes through */
288
  struct ospf_area *voa;        /* OSPF area which the vlink goes through */
289
  u16 inftransdelay;                /* The estimated number of seconds it takes to
290
                                   transmit a Link State Update Packet over this
291
                                   interface.  LSAs contained in the update */
292
  u16 helloint;                        /* number of seconds between hello sending */
293
  list *passwords;
294
  u32 csn;                      /* Last used crypt seq number */
295
  bird_clock_t csn_use;         /* Last time when packet with that CSN was sent */
296
  ip_addr all_routers;                /* Multicast (or broadcast) address for all routers */
297
  ip_addr des_routers;                /* Multicast (or NULL) address for designated routers */
298
  ip_addr drip;                        /* Designated router IP */
299
  ip_addr bdrip;                /* Backup DR IP */
300
  u32 drid;                        /* DR Router ID */
301
  u32 bdrid;                        /* BDR Router ID */
302
  s16 rt_pos_beg;                /* Position of iface in Router-LSA, begin, inclusive */
303
  s16 rt_pos_end;                /* Position of iface in Router-LSA, end, exclusive */
304
  s16 px_pos_beg;                /* Position of iface in Rt Prefix-LSA, begin, inclusive */
305
  s16 px_pos_end;                /* Position of iface in Rt Prefix-LSA, end, exclusive */
306
  u32 dr_iface_id;                /* if drid is valid, this is iface_id of DR (for connecting network) */
307
  u8 instance_id;                /* Used to differentiate between more OSPF
308
                                   instances on one interface */
309
  u8 autype;                        /* Authentication type (OSPF_AUTH_*) */
310
  u8 type;                        /* OSPF view of type (OSPF_IT_*) */
311
  u8 strictnbma;                /* Can I talk with unknown neighbors? */
312
  u8 stub;                        /* Inactive interface */
313
  u8 state;                        /* Interface state machine (OSPF_IS_*) */
314
  timer *wait_timer;                /* WAIT timer */
315
  timer *hello_timer;                /* HELLOINT timer */
316
  timer *poll_timer;                /* Poll Interval - for NBMA */
317

    
318
  struct top_hash_entry *link_lsa;        /* Originated link LSA */
319
  struct top_hash_entry *net_lsa;        /* Originated network LSA */
320
  struct top_hash_entry *pxn_lsa;        /* Originated prefix LSA */
321
  struct top_hash_entry **flood_queue;        /* LSAs queued for LSUPD */
322
  u8 update_link_lsa;
323
  u8 update_net_lsa;
324
  u16 flood_queue_used;                /* The current number of LSAs in flood_queue */
325
  u16 flood_queue_size;                /* The maximum number of LSAs in flood_queue */
326
  int fadj;                        /* Number of fully adjacent neighbors */
327
  list nbma_list;
328
  u8 priority;                        /* A router priority for DR election */
329
  u8 ioprob;
330
#define OSPF_I_OK 0                /* Everything OK */
331
#define OSPF_I_SK 1                /* Socket open failed */
332
#define OSPF_I_LL 2                /* Missing link-local address (OSPFv3) */
333
  u8 sk_dr;                        /* Socket is a member of designated routers group */
334
  u8 marked;                        /* Used in OSPF reconfigure, 2 for force restart */
335
  u16 rxbuf;                        /* Buffer size */
336
  u16 tx_length;                /* Soft TX packet length limit, usually MTU */
337
  u8 check_link;                /* Whether iface link change is used */
338
  u8 ecmp_weight;                /* Weight used for ECMP */
339
  u8 link_lsa_suppression;        /* Suppression of Link-LSA origination */
340
  u8 ptp_netmask;                /* Send real netmask for P2P */
341
  u8 check_ttl;                        /* Check incoming packets for TTL 255 */
342
  u8 bfd;                        /* Use BFD on iface */
343
};
344

    
345
struct ospf_neighbor
346
{
347
  node n;
348
  pool *pool;
349
  struct ospf_iface *ifa;
350
  u8 state;
351
  timer *inactim;                /* Inactivity timer */
352
  u8 imms;                        /* I, M, Master/slave received */
353
  u8 myimms;                        /* I, M Master/slave */
354
  u32 dds;                        /* DD Sequence number being sent */
355
  u32 ddr;                        /* last Dat Des packet received */
356

    
357
  u32 rid;                        /* Router ID */
358
  ip_addr ip;                        /* IP of it's interface */
359
  u8 priority;                        /* Priority */
360
  u8 adj;                        /* built adjacency? */
361
  u32 options;                        /* Options received */
362

    
363
  /* Entries dr and bdr store IP addresses in OSPFv2 and router IDs in
364
     OSPFv3, we use the same type to simplify handling */
365
  u32 dr;                        /* Neighbor's idea of DR */
366
  u32 bdr;                        /* Neighbor's idea of BDR */
367
  u32 iface_id;                        /* ID of Neighbour's iface connected to common network */
368

    
369
  /* Database summary list iterator, controls initial dbdes exchange.
370
   * Advances in the LSA list as dbdes packets are sent.
371
   */
372
  siterator dbsi;                /* iterator of po->lsal */
373

    
374
  /* Link state request list, controls initial LSA exchange.
375
   * Entries added when received in dbdes packets, removed as sent in lsreq packets.
376
   */
377
  slist lsrql;                        /* slist of struct top_hash_entry from n->lsrqh */
378
  struct top_graph *lsrqh;
379
  struct top_hash_entry *lsrqi;        /* Pointer to the first unsent node in lsrql */
380

    
381
  /* Link state retransmission list, controls LSA retransmission during flood.
382
   * Entries added as sent in lsupd packets, removed when received in lsack packets.
383
   * These entries hold ret_count in appropriate LSA entries.
384
   */
385
  slist lsrtl;                        /* slist of struct top_hash_entry from n->lsrth */
386
  struct top_graph *lsrth;
387
  timer *dbdes_timer;                /* DBDES exchange timer */
388
  timer *lsrq_timer;                /* LSA request timer */
389
  timer *lsrt_timer;                /* LSA retransmission timer */
390
  list ackl[2];
391
#define ACKL_DIRECT 0
392
#define ACKL_DELAY 1
393
  timer *ackd_timer;                /* Delayed ack timer */
394
  struct bfd_request *bfd_req;        /* BFD request, if BFD is used */
395
  void *ldd_buffer;                /* Last database description packet */
396
  u32 ldd_bsize;                /* Buffer size for ldd_buffer */
397
  u32 csn;                      /* Last received crypt seq number (for MD5) */
398
};
399

    
400

    
401
/* OSPF interface types */
402
#define OSPF_IT_BCAST        0
403
#define OSPF_IT_NBMA        1
404
#define OSPF_IT_PTP        2
405
#define OSPF_IT_PTMP        3
406
#define OSPF_IT_VLINK        4
407
#define OSPF_IT_UNDEF        5
408

    
409
/* OSPF interface states */
410
#define OSPF_IS_DOWN        0        /* Not active */
411
#define OSPF_IS_LOOP        1        /* Iface with no link */
412
#define OSPF_IS_WAITING        2        /* Waiting for Wait timer */
413
#define OSPF_IS_PTP        3        /* PTP operational */
414
#define OSPF_IS_DROTHER        4        /* I'm on BCAST or NBMA and I'm not DR */
415
#define OSPF_IS_BACKUP        5        /* I'm BDR */
416
#define OSPF_IS_DR        6        /* I'm DR */
417

    
418
/* Definitions for interface state machine */
419
#define ISM_UP                0        /* Interface Up */
420
#define ISM_WAITF        1        /* Wait timer fired */
421
#define ISM_BACKS        2        /* Backup seen */
422
#define ISM_NEICH        3        /* Neighbor change */
423
#define ISM_LOOP        4        /* Link down */
424
#define ISM_UNLOOP        5        /* Link up */
425
#define ISM_DOWN        6        /* Interface down */
426

    
427

    
428
/* OSPF neighbor states */
429
#define NEIGHBOR_DOWN        0
430
#define NEIGHBOR_ATTEMPT 1
431
#define NEIGHBOR_INIT        2
432
#define NEIGHBOR_2WAY        3
433
#define NEIGHBOR_EXSTART 4
434
#define NEIGHBOR_EXCHANGE 5
435
#define NEIGHBOR_LOADING 6
436
#define NEIGHBOR_FULL        7
437

    
438
/* Definitions for neighbor state machine */
439
#define INM_HELLOREC        0        /* Hello Received */
440
#define INM_START        1        /* Neighbor start - for NBMA */
441
#define INM_2WAYREC        2        /* 2-Way received */
442
#define INM_NEGDONE        3        /* Negotiation done */
443
#define INM_EXDONE        4        /* Exchange done */
444
#define INM_BADLSREQ        5        /* Bad LS Request */
445
#define INM_LOADDONE        6        /* Load done */
446
#define INM_ADJOK        7        /* AdjOK? */
447
#define INM_SEQMIS        8        /* Sequence number mismatch */
448
#define INM_1WAYREC        9        /* 1-Way */
449
#define INM_KILLNBR        10        /* Kill Neighbor */
450
#define INM_INACTTIM        11        /* Inactivity timer */
451
#define INM_LLDOWN        12        /* Line down */
452

    
453
#define TRANS_OFF        0
454
#define TRANS_ON        1
455
#define TRANS_WAIT        2        /* Waiting before the end of translation */
456

    
457

    
458

    
459
/* Generic option flags */
460
#define OPT_V6                0x01        /* OSPFv3, LSA relevant for IPv6 routing calculation */
461
#define OPT_E                0x02        /* Related to AS-external LSAs */
462
#define OPT_MC                0x04        /* Related to MOSPF, not used and obsolete */
463
#define OPT_N                0x08        /* Related to NSSA */
464
#define OPT_P                0x08        /* OSPFv2, flags P and N share position, see NSSA RFC */
465
#define OPT_EA                0x10        /* OSPFv2, external attributes, not used and obsolete */
466
#define OPT_R                0x10        /* OSPFv3, originator is active router */
467
#define OPT_DC                0x20        /* Related to demand circuits, not used */
468

    
469
/* Router-LSA VEB flags are are stored together with links (OSPFv2) or options (OSPFv3) */
470
#define OPT_RT_B        (0x01 << 24)
471
#define OPT_RT_E        (0x02 << 24)
472
#define OPT_RT_V        (0x04 << 24)
473
#define OPT_RT_NT        (0x10 << 24)
474

    
475
/* Prefix flags, specific for OSPFv3 */
476
#define OPT_PX_NU        0x01
477
#define OPT_PX_LA        0x02
478
#define OPT_PX_P        0x08
479
#define OPT_PX_DN        0x10
480

    
481

    
482
struct ospf_packet
483
{
484
  u8 version;
485
  u8 type;
486
  u16 length;
487
  u32 routerid;
488
  u32 areaid;
489
  u16 checksum;
490
  u8 instance_id;                /* See RFC 6549 */
491
  u8 autype;                        /* Undefined for OSPFv3 */
492
};
493

    
494
struct ospf_md5
495
{
496
  u16 zero;
497
  u8 keyid;
498
  u8 len;
499
  u32 csn;
500
};
501

    
502
union ospf_auth
503
{
504
  u8 password[8];
505
  struct ospf_md5 md5;
506
};
507

    
508
/* Packet types */
509
#define HELLO_P                1        /* Hello */
510
#define DBDES_P                2        /* Database description */
511
#define LSREQ_P                3        /* Link state request */
512
#define LSUPD_P                4        /* Link state update */
513
#define LSACK_P                5        /* Link state acknowledgement */
514

    
515

    
516
#define DBDES_I                4        /* Init bit */
517
#define DBDES_M                2        /* More bit */
518
#define DBDES_MS        1        /* Master/Slave bit */
519
#define DBDES_IMMS        (DBDES_I | DBDES_M | DBDES_MS)
520

    
521

    
522
#define LSA_T_RT        0x2001
523
#define LSA_T_NET        0x2002
524
#define LSA_T_SUM_NET        0x2003
525
#define LSA_T_SUM_RT        0x2004
526
#define LSA_T_EXT        0x4005
527
#define LSA_T_NSSA        0x2007
528
#define LSA_T_LINK        0x0008
529
#define LSA_T_PREFIX        0x2009
530

    
531
#define LSA_T_V2_MASK        0x00ff
532

    
533
#define LSA_UBIT        0x8000
534

    
535
#define LSA_SCOPE_LINK        0x0000
536
#define LSA_SCOPE_AREA        0x2000
537
#define LSA_SCOPE_AS        0x4000
538
#define LSA_SCOPE_RES        0x6000
539
#define LSA_SCOPE_MASK        0x6000
540
#define LSA_SCOPE(type)        ((type) & LSA_SCOPE_MASK)
541

    
542

    
543
#define LSA_MAXAGE        3600        /* 1 hour */
544
#define LSA_CHECKAGE        300        /* 5 minutes */
545
#define LSA_MAXAGEDIFF        900        /* 15 minutes */
546

    
547
#define LSA_ZEROSEQNO        ((s32) 0x80000000)
548
#define LSA_INITSEQNO        ((s32) 0x80000001)
549
#define LSA_MAXSEQNO        ((s32) 0x7fffffff)
550

    
551
#define LSA_METRIC_MASK  0x00FFFFFF
552
#define LSA_OPTIONS_MASK 0x00FFFFFF
553

    
554

    
555
#define LSART_PTP        1
556
#define LSART_NET        2
557
#define LSART_STUB        3
558
#define LSART_VLNK        4
559

    
560
#define LSA_RT2_LINKS        0x0000FFFF
561

    
562
#define LSA_SUM2_TOS        0xFF000000
563

    
564
#define LSA_EXT2_TOS        0x7F000000
565
#define LSA_EXT2_EBIT        0x80000000
566

    
567
#define LSA_EXT3_EBIT        0x4000000
568
#define LSA_EXT3_FBIT        0x2000000
569
#define LSA_EXT3_TBIT        0x1000000
570

    
571

    
572
struct ospf_lsa_header
573
{
574
  u16 age;                        /* LS Age */
575
  u16 type_raw;                        /* Type, mixed with options on OSPFv2 */
576

    
577
  u32 id;
578
  u32 rt;                        /* Advertising router */
579
  s32 sn;                        /* LS Sequence number */
580
  u16 checksum;
581
  u16 length;
582
};
583

    
584

    
585
/* In OSPFv2, options are embedded in higher half of type_raw */
586
static inline u8 lsa_get_options(struct ospf_lsa_header *lsa)
587
{ return lsa->type_raw >> 8; }
588

    
589
static inline void lsa_set_options(struct ospf_lsa_header *lsa, u16 options)
590
{ lsa->type_raw = (lsa->type_raw & 0xff) | (options << 8); }
591

    
592

    
593
struct ospf_lsa_rt
594
{
595
  u32 options;        /* VEB flags, mixed with link count for OSPFv2 and options for OSPFv3 */
596
};
597

    
598
struct ospf_lsa_rt2_link
599
{
600
  u32 id;
601
  u32 data;
602
#ifdef CPU_BIG_ENDIAN
603
  u8 type;
604
  u8 no_tos;
605
  u16 metric;
606
#else
607
  u16 metric;
608
  u8 no_tos;
609
  u8 type;
610
#endif
611
};
612

    
613
struct ospf_lsa_rt2_tos
614
{
615
#ifdef CPU_BIG_ENDIAN
616
  u8 tos;
617
  u8 padding;
618
  u16 metric;
619
#else
620
  u16 metric;
621
  u8 padding;
622
  u8 tos;
623
#endif
624
};
625

    
626
struct ospf_lsa_rt3_link
627
{
628
#ifdef CPU_BIG_ENDIAN
629
  u8 type;
630
  u8 padding;
631
  u16 metric;
632
#else
633
  u16 metric;
634
  u8 padding;
635
  u8 type;
636
#endif
637
  u32 lif;        /* Local interface ID */
638
  u32 nif;        /* Neighbor interface ID */
639
  u32 id;        /* Neighbor router ID */
640
};
641

    
642

    
643
struct ospf_lsa_net
644
{
645
  u32 optx;        /* Netmask for OSPFv2, options for OSPFv3 */
646
  u32 routers[];
647
};
648

    
649
struct ospf_lsa_sum2
650
{
651
  u32 netmask;
652
  u32 metric;
653
};
654

    
655
struct ospf_lsa_sum3_net
656
{
657
  u32 metric;
658
  u32 prefix[];
659
};
660

    
661
struct ospf_lsa_sum3_rt
662
{
663
  u32 options;
664
  u32 metric;
665
  u32 drid;
666
};
667

    
668
struct ospf_lsa_ext2
669
{
670
  u32 netmask;
671
  u32 metric;
672
  u32 fwaddr;
673
  u32 tag;
674
};
675

    
676
struct ospf_lsa_ext3
677
{
678
  u32 metric;
679
  u32 rest[];
680
};
681

    
682
struct ospf_lsa_ext_local
683
{
684
  net_addr net;
685
  ip_addr fwaddr;
686
  u32 metric, ebit, fbit, tag, propagate;
687
  u8 pxopts;
688
};
689

    
690
struct ospf_lsa_link
691
{
692
  u32 options;
693
  ip6_addr lladdr;
694
  u32 pxcount;
695
  u32 rest[];
696
};
697

    
698
struct ospf_lsa_prefix
699
{
700
#ifdef CPU_BIG_ENDIAN
701
  u16 pxcount;
702
  u16 ref_type;
703
#else
704
  u16 ref_type;
705
  u16 pxcount;
706
#endif
707
  u32 ref_id;
708
  u32 ref_rt;
709
  u32 rest[];
710
};
711

    
712

    
713
static inline uint
714
lsa_net_count(struct ospf_lsa_header *lsa)
715
{
716
  return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_net))
717
    / sizeof(u32);
718
}
719

    
720
/* In ospf_area->rtr we store paths to routers, but we use RID (and not IP address)
721
   as index, so we need to encapsulate RID to IP address */
722

    
723
#define net_from_rid(x) NET_ADDR_IP4(ip4_from_u32(x), IP4_MAX_PREFIX_LENGTH)
724
#define rid_from_net(x) ip4_to_u32(((net_addr_ip4 *) x)->prefix)
725

    
726
#define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
727
#define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)
728

    
729
/* FIXME: these four functions should be significantly redesigned w.r.t. integration,
730
   also should be named as ospf3_* instead of *_ipv6_* */
731

    
732
static inline u32 *
733
ospf_get_ipv6_prefix(u32 *buf, net_addr *N, u8 *pxopts, u16 *rest)
734
{
735
  net_addr_ip6 *net = (void *) N;
736
  u8 pxlen = (*buf >> 24);
737
  *pxopts = (*buf >> 16) & 0xff;
738
  if (rest) *rest = *buf & 0xffff;
739
  buf++;
740

    
741
  *net = NET_ADDR_IP6(IP6_NONE, pxlen);
742

    
743
  if (pxlen > 0)
744
    _I0(net->prefix) = *buf++;
745
  if (pxlen > 32)
746
    _I1(net->prefix) = *buf++;
747
  if (pxlen > 64)
748
    _I2(net->prefix) = *buf++;
749
  if (pxlen > 96)
750
    _I3(net->prefix) = *buf++;
751

    
752
  /* Clean up remaining bits */
753
  if (pxlen < 128)
754
    net->prefix.addr[pxlen / 32] &= u32_mkmask(pxlen % 32);
755

    
756
  return buf;
757
}
758

    
759
static inline u32 *
760
ospf_get_ipv6_addr(u32 *buf, ip_addr *addr)
761
{
762
  *addr = ipa_from_ip6(*(ip6_addr *) buf);
763
  return buf + 4;
764
}
765

    
766
static inline u32 *
767
ospf_put_ipv6_prefix(u32 *buf, net_addr *N, u8 pxopts, u16 rest)
768
{
769
  net_addr_ip6 *net = (void *) N;
770
  u32 pxlen = net->pxlen;
771

    
772
  *buf++ = ((pxlen << 24) | (pxopts << 16) | rest);
773

    
774
  if (pxlen > 0)
775
    *buf++ = _I0(net->prefix);
776
  if (pxlen > 32)
777
    *buf++ = _I1(net->prefix);
778
  if (pxlen > 64)
779
    *buf++ = _I2(net->prefix);
780
  if (pxlen > 96)
781
    *buf++ = _I3(net->prefix);
782

    
783
  return buf;
784
}
785

    
786
static inline u32 *
787
ospf_put_ipv6_addr(u32 *buf, ip_addr addr)
788
{
789
  *(ip6_addr *) buf = ipa_to_ip6(addr);
790
  return buf + 4;
791
}
792

    
793

    
794
struct ospf_lsreq_header
795
{
796
  u32 type;
797
  u32 id;
798
  u32 rt;
799
};
800

    
801

    
802

    
803
#define SH_ROUTER_SELF 0xffffffff
804

    
805
struct lsadb_show_data {
806
  struct symbol *name;        /* Protocol to request data from */
807
  u16 type;                /* LSA Type, 0 -> all */
808
  u16 scope;                /* Scope, 0 -> all, hack to handle link scope as 1 */
809
  u32 area;                /* Specified for area scope */
810
  u32 lsid;                /* LSA ID, 0 -> all */
811
  u32 router;                /* Advertising router, 0 -> all */
812
};
813

    
814

    
815
#define EA_OSPF_METRIC1        EA_CODE(EAP_OSPF, 0)
816
#define EA_OSPF_METRIC2        EA_CODE(EAP_OSPF, 1)
817
#define EA_OSPF_TAG        EA_CODE(EAP_OSPF, 2)
818
#define EA_OSPF_ROUTER_ID EA_CODE(EAP_OSPF, 3)
819

    
820

    
821
/* ospf.c */
822
void ospf_schedule_rtcalc(struct ospf_proto *p);
823

    
824
static inline void ospf_notify_rt_lsa(struct ospf_area *oa)
825
{ oa->update_rt_lsa = 1; }
826

    
827
static inline void ospf_notify_net_lsa(struct ospf_iface *ifa)
828
{ ifa->update_net_lsa = 1; }
829

    
830
static inline void ospf_notify_link_lsa(struct ospf_iface *ifa)
831
{ ifa->update_link_lsa = 1; }
832

    
833

    
834
#define ospf_is_v2(X) OSPF_IS_V2
835
#define ospf_is_v3(X) (!OSPF_IS_V2)
836
/*
837
static inline int ospf_is_v2(struct ospf_proto *p)
838
{ return p->ospf2; }
839

840
static inline int ospf_is_v3(struct ospf_proto *p)
841
{ return ! p->ospf2; }
842
*/
843
static inline int ospf_get_version(struct ospf_proto *p)
844
{ return ospf_is_v2(p) ? 2 : 3; }
845

    
846
struct ospf_area *ospf_find_area(struct ospf_proto *p, u32 aid);
847

    
848
static inline struct ospf_area *ospf_main_area(struct ospf_proto *p)
849
{ return (p->areano == 1) ? HEAD(p->area_list) : p->backbone; }
850

    
851
static inline int oa_is_stub(struct ospf_area *oa)
852
{ return (oa->options & (OPT_E | OPT_N)) == 0; }
853

    
854
static inline int oa_is_ext(struct ospf_area *oa)
855
{ return oa->options & OPT_E; }
856

    
857
static inline int oa_is_nssa(struct ospf_area *oa)
858
{ return oa->options & OPT_N; }
859

    
860
void ospf_sh_neigh(struct proto *P, char *iff);
861
void ospf_sh(struct proto *P);
862
void ospf_sh_iface(struct proto *P, char *iff);
863
void ospf_sh_state(struct proto *P, int verbose, int reachable);
864

    
865
void ospf_sh_lsadb(struct lsadb_show_data *ld);
866

    
867
/* iface.c */
868
void ospf_iface_chstate(struct ospf_iface *ifa, u8 state);
869
void ospf_iface_sm(struct ospf_iface *ifa, int event);
870
struct ospf_iface *ospf_iface_find(struct ospf_proto *p, struct iface *what);
871
void ospf_if_notify(struct proto *P, uint flags, struct iface *iface);
872
void ospf_ifa_notify2(struct proto *P, uint flags, struct ifa *a);
873
void ospf_ifa_notify3(struct proto *P, uint flags, struct ifa *a);
874
void ospf_iface_info(struct ospf_iface *ifa);
875
void ospf_iface_new(struct ospf_area *oa, struct ifa *addr, struct ospf_iface_patt *ip);
876
void ospf_iface_new_vlink(struct ospf_proto *p, struct ospf_iface_patt *ip);
877
void ospf_iface_remove(struct ospf_iface *ifa);
878
void ospf_iface_shutdown(struct ospf_iface *ifa);
879
int ospf_iface_assure_bufsize(struct ospf_iface *ifa, uint plen);
880
int ospf_iface_reconfigure(struct ospf_iface *ifa, struct ospf_iface_patt *new);
881
void ospf_reconfigure_ifaces(struct ospf_proto *p);
882
void ospf_open_vlink_sk(struct ospf_proto *p);
883
struct nbma_node *find_nbma_node_(list *nnl, ip_addr ip);
884

    
885
static inline struct nbma_node * find_nbma_node(struct ospf_iface *ifa, ip_addr ip)
886
{ return find_nbma_node_(&ifa->nbma_list, ip); }
887

    
888
/* neighbor.c */
889
struct ospf_neighbor *ospf_neighbor_new(struct ospf_iface *ifa);
890
void ospf_neigh_sm(struct ospf_neighbor *n, int event);
891
void ospf_dr_election(struct ospf_iface *ifa);
892
struct ospf_neighbor *find_neigh(struct ospf_iface *ifa, u32 rid);
893
struct ospf_neighbor *find_neigh_by_ip(struct ospf_iface *ifa, ip_addr ip);
894
void ospf_neigh_update_bfd(struct ospf_neighbor *n, int use_bfd);
895
void ospf_sh_neigh_info(struct ospf_neighbor *n);
896

    
897
/* packet.c */
898
void ospf_pkt_fill_hdr(struct ospf_iface *ifa, void *buf, u8 h_type);
899
uint ospf_pkt_maxsize(struct ospf_proto *p, struct ospf_iface *ifa);
900
int ospf_rx_hook(sock * sk, int size);
901
// void ospf_tx_hook(sock * sk);
902
void ospf_err_hook(sock * sk, int err);
903
void ospf_verr_hook(sock *sk, int err);
904
void ospf_send_to(struct ospf_iface *ifa, ip_addr ip);
905
void ospf_send_to_agt(struct ospf_iface *ifa, u8 state);
906
void ospf_send_to_bdr(struct ospf_iface *ifa);
907

    
908
static inline void ospf_send_to_all(struct ospf_iface *ifa)
909
{ ospf_send_to(ifa, ifa->all_routers); }
910

    
911
static inline void ospf_send_to_des(struct ospf_iface *ifa)
912
{
913
  if (ipa_nonzero(ifa->des_routers))
914
    ospf_send_to(ifa, ifa->des_routers);
915
  else
916
    ospf_send_to_bdr(ifa);
917
}
918

    
919
#ifndef PARSER
920
#define DROP(DSC,VAL) do { err_dsc = DSC; err_val = VAL; goto drop; } while(0)
921
#define DROP1(DSC) do { err_dsc = DSC; goto drop; } while(0)
922
#define SKIP(DSC) do { err_dsc = DSC; goto skip; } while(0)
923
#endif
924

    
925
static inline uint ospf_pkt_hdrlen(struct ospf_proto *p)
926
{ return ospf_is_v2(p) ? (sizeof(struct ospf_packet) + sizeof(union ospf_auth)) : sizeof(struct ospf_packet); }
927

    
928
static inline void * ospf_tx_buffer(struct ospf_iface *ifa)
929
{ return ifa->sk->tbuf; }
930

    
931
/* hello.c */
932
#define OHS_HELLO    0
933
#define OHS_POLL     1
934
#define OHS_SHUTDOWN 2
935

    
936
void ospf_send_hello(struct ospf_iface *ifa, int kind, struct ospf_neighbor *dirn);
937
void ospf_receive_hello(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n, ip_addr faddr);
938

    
939
/* dbdes.c */
940
void ospf_send_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
941
void ospf_rxmt_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
942
void ospf_receive_dbdes(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
943

    
944
/* lsreq.c */
945
void ospf_send_lsreq(struct ospf_proto *p, struct ospf_neighbor *n);
946
void ospf_receive_lsreq(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
947

    
948
/* lsupd.c */
949
void ospf_dump_lsahdr(struct ospf_proto *p, struct ospf_lsa_header *lsa_n);
950
void ospf_dump_common(struct ospf_proto *p, struct ospf_packet *pkt);
951
void ospf_lsa_lsrt_down_(struct top_hash_entry *en, struct ospf_neighbor *n, struct top_hash_entry *ret);
952
void ospf_add_flushed_to_lsrt(struct ospf_proto *p, struct ospf_neighbor *n);
953
void ospf_flood_event(void *ptr);
954
int ospf_flood_lsa(struct ospf_proto *p, struct top_hash_entry *en, struct ospf_neighbor *from);
955
int ospf_send_lsupd(struct ospf_proto *p, struct top_hash_entry **lsa_list, uint lsa_count, struct ospf_neighbor *n);
956
void ospf_rxmt_lsupd(struct ospf_proto *p, struct ospf_neighbor *n);
957
void ospf_receive_lsupd(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
958

    
959
/* lsack.c */
960
void ospf_enqueue_lsack(struct ospf_neighbor *n, struct ospf_lsa_header *h_n, int queue);
961
void ospf_reset_lsack_queue(struct ospf_neighbor *n);
962
void ospf_send_lsack(struct ospf_proto *p, struct ospf_neighbor *n, int queue);
963
void ospf_receive_lsack(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
964

    
965

    
966
#include "proto/ospf/rt.h"
967
#include "proto/ospf/topology.h"
968
#include "proto/ospf/lsalib.h"
969

    
970
#endif /* _BIRD_OSPF_H_ */