Statistics
| Branch: | Revision:

iof-bird-daemon / nest / protocol.h @ bf47fe4b

History | View | Annotate | Download (11.9 KB)

1
/*
2
 *        BIRD Internet Routing Daemon -- Protocols
3
 *
4
 *        (c) 1998--2000 Martin Mares <mj@ucw.cz>
5
 *
6
 *        Can be freely distributed and used under the terms of the GNU GPL.
7
 */
8

    
9
#ifndef _BIRD_PROTOCOL_H_
10
#define _BIRD_PROTOCOL_H_
11

    
12
#include "lib/lists.h"
13
#include "lib/resource.h"
14
#include "lib/timer.h"
15
#include "conf/conf.h"
16

    
17
struct iface;
18
struct ifa;
19
struct rte;
20
struct neighbor;
21
struct rta;
22
struct network;
23
struct proto_config;
24
struct config;
25
struct proto;
26
struct event;
27
struct ea_list;
28
struct eattr;
29
struct symbol;
30

    
31
/*
32
 *        Routing Protocol
33
 */
34

    
35
struct protocol {
36
  node n;
37
  char *name;
38
  char *template;                        /* Template for automatic generation of names */
39
  int name_counter;                        /* Counter for automatic name generation */
40
  int attr_class;                        /* Attribute class known to this protocol */
41

    
42
  void (*preconfig)(struct protocol *, struct config *);        /* Just before configuring */
43
  void (*postconfig)(struct proto_config *);                        /* After configuring each instance */
44
  struct proto * (*init)(struct proto_config *);                /* Create new instance */
45
  int (*reconfigure)(struct proto *, struct proto_config *);        /* Try to reconfigure instance, returns success */
46
  void (*dump)(struct proto *);                        /* Debugging dump */
47
  void (*dump_attrs)(struct rte *);                /* Dump protocol-dependent attributes */
48
  int (*start)(struct proto *);                        /* Start the instance */
49
  int (*shutdown)(struct proto *);                /* Stop the instance */
50
  void (*get_status)(struct proto *, byte *buf); /* Get instance status (for `show protocols' command) */
51
  void (*get_route_info)(struct rte *, byte *buf, struct ea_list *attrs); /* Get route information (for `show route' command) */
52
  int (*get_attr)(struct eattr *, byte *buf, int buflen);        /* ASCIIfy dynamic attribute (returns GA_*) */
53
};
54

    
55
void protos_build(void);
56
void proto_build(struct protocol *);
57
void protos_preconfig(struct config *);
58
void protos_postconfig(struct config *);
59
void protos_commit(struct config *new, struct config *old, int force_restart, int type);
60
void protos_dump_all(void);
61

    
62
#define GA_UNKNOWN        0                /* Attribute not recognized */
63
#define GA_NAME                1                /* Result = name */
64
#define GA_FULL                2                /* Result = both name and value */
65

    
66
/*
67
 *        Known protocols
68
 */
69

    
70
extern struct protocol
71
  proto_device, proto_rip, proto_static,
72
  proto_ospf, proto_pipe, proto_bgp;
73

    
74
/*
75
 *        Routing Protocol Instance
76
 */
77

    
78
struct proto_config {
79
  node n;
80
  struct config *global;                /* Global configuration data */
81
  struct protocol *protocol;                /* Protocol */
82
  struct proto *proto;                        /* Instance we've created */
83
  char *name;
84
  char *dsc;
85
  unsigned debug, preference, disabled;        /* Generic parameters */
86
  u32 router_id;                        /* Protocol specific router ID */
87
  struct rtable_config *table;                /* Table we're attached to */
88
  struct filter *in_filter, *out_filter; /* Attached filters */
89

    
90
  /* Protocol-specific data follow... */
91
};
92

    
93
  /* Protocol statistics */
94
struct proto_stats {
95
  /* Import - from protocol to core */
96
  u32 imp_routes;                /* Number of routes successfully imported to the (adjacent) routing table */
97
  u32 pref_routes;                /* Number of routes that are preferred, sum over all routing table */
98
  u32 imp_updates_received;        /* Number of route updates received */
99
  u32 imp_updates_invalid;        /* Number of route updates rejected as invalid */
100
  u32 imp_updates_filtered;        /* Number of route updates rejected by filters */
101
  u32 imp_updates_ignored;        /* Number of route updates rejected as already in route table */
102
  u32 imp_updates_accepted;        /* Number of route updates accepted and imported */
103
  u32 imp_withdraws_received;        /* Number of route withdraws received */
104
  u32 imp_withdraws_invalid;        /* Number of route withdraws rejected as invalid */
105
  u32 imp_withdraws_ignored;        /* Number of route withdraws rejected as already not in route table */
106
  u32 imp_withdraws_accepted;        /* Number of route withdraws accepted and processed */
107

    
108
  /* Export - from core to protocol */
109
  u32 exp_routes;                /* Number of routes successfully exported to the protocol */
110
  u32 exp_updates_received;        /* Number of route updates received */
111
  u32 exp_updates_rejected;        /* Number of route updates rejected by protocol */
112
  u32 exp_updates_filtered;        /* Number of route updates rejected by filters */
113
  u32 exp_updates_accepted;        /* Number of route updates accepted and exported */ 
114
  u32 exp_withdraws_received;        /* Number of route withdraws received */
115
  u32 exp_withdraws_accepted;        /* Number of route withdraws accepted and processed */
116
};
117

    
118
struct proto {
119
  node n;                                /* Node in *_proto_list */
120
  node glob_node;                        /* Node in global proto_list */
121
  struct protocol *proto;                /* Protocol */
122
  struct proto_config *cf;                /* Configuration data */
123
  struct proto_config *cf_new;                /* Configuration we want to switch to after shutdown (NULL=delete) */
124
  pool *pool;                                /* Pool containing local objects */
125
  struct event *attn;                        /* "Pay attention" event */
126

    
127
  char *name;                                /* Name of this instance (== cf->name) */
128
  unsigned debug;                        /* Debugging flags */
129
  unsigned preference;                        /* Default route preference */
130
  int min_scope;                        /* Minimal route scope accepted */
131
  unsigned accept_ra_types;                /* Which types of route announcements are accepted (RA_OPTIMAL or RA_ANY) */
132
  unsigned disabled;                        /* Manually disabled */
133
  unsigned proto_state;                        /* Protocol state machine (see below) */
134
  unsigned core_state;                        /* Core state machine (see below) */
135
  unsigned core_goal;                        /* State we want to reach (see below) */
136
  unsigned reconfiguring;                /* We're shutting down due to reconfiguration */
137
  u32 hash_key;                                /* Random key used for hashing of neighbors */
138
  bird_clock_t last_state_change;        /* Time of last state transition */
139
  char *last_state_name_announced;        /* Last state name we've announced to the user */
140
  struct proto_stats stats;                /* Current protocol statistics */
141

    
142
  /*
143
   *        General protocol hooks:
144
   *
145
   *           if_notify        Notify protocol about interface state changes.
146
   *           ifa_notify        Notify protocol about interface address changes.
147
   *           rt_notify        Notify protocol about routing table updates.
148
   *           neigh_notify        Notify protocol about neighbor cache events.
149
   *           make_tmp_attrs  Construct ea_list from private attrs stored in rte.
150
   *           store_tmp_attrs Store private attrs back to the rte.
151
   *           import_control  Called as the first step of the route importing process.
152
   *                        It can construct a new rte, add private attributes and
153
   *                        decide whether the route shall be imported: 1=yes, -1=no,
154
   *                        0=process it through the import filter set by the user.
155
   *           reload_routes   Request protocol to reload all its routes to the core
156
   *                        (using rte_update()). Returns: 0=reload cannot be done,
157
   *                        1= reload is scheduled and will happen (asynchronously).
158
   */
159

    
160
  void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
161
  void (*ifa_notify)(struct proto *, unsigned flags, struct ifa *a);
162
  void (*rt_notify)(struct proto *, struct network *net, struct rte *new, struct rte *old, struct ea_list *attrs);
163
  void (*neigh_notify)(struct neighbor *neigh);
164
  struct ea_list *(*make_tmp_attrs)(struct rte *rt, struct linpool *pool);
165
  void (*store_tmp_attrs)(struct rte *rt, struct ea_list *attrs);
166
  int (*import_control)(struct proto *, struct rte **rt, struct ea_list **attrs, struct linpool *pool);
167
  int (*reload_routes)(struct proto *);
168

    
169
  /*
170
   *        Routing entry hooks (called only for rte's belonging to this protocol):
171
   *
172
   *           rte_better        Compare two rte's and decide which one is better (1=first, 0=second).
173
   *       rte_same        Compare two rte's and decide whether they are identical (1=yes, 0=no).
174
   *           rte_insert        Called whenever a rte is inserted to a routing table.
175
   *           rte_remove        Called whenever a rte is removed from the routing table.
176
   */
177

    
178
  int (*rte_better)(struct rte *, struct rte *);
179
  int (*rte_same)(struct rte *, struct rte *);
180
  void (*rte_insert)(struct network *, struct rte *);
181
  void (*rte_remove)(struct network *, struct rte *);
182

    
183
  struct rtable *table;                        /* Our primary routing table */
184
  struct filter *in_filter;                /* Input filter */
185
  struct filter *out_filter;                /* Output filter */
186
  struct announce_hook *ahooks;                /* Announcement hooks for this protocol */
187

    
188
  struct fib_iterator *feed_iterator;        /* Routing table iterator used during protocol feeding */
189
  struct announce_hook *feed_ahook;        /* Announce hook we currently feed */
190

    
191
  /* Hic sunt protocol-specific data */
192
};
193

    
194
void *proto_new(struct proto_config *, unsigned size);
195
void *proto_config_new(struct protocol *, unsigned size);
196

    
197
void proto_request_feeding(struct proto *p);
198
void proto_show(struct symbol *, int);
199
struct proto *proto_get_named(struct symbol *, struct protocol *);
200
void proto_xxable(char *, int);
201
void proto_debug(char *, unsigned int);
202

    
203
static inline u32
204
proto_get_router_id(struct proto_config *pc)
205
{
206
  return pc->router_id ? pc->router_id : pc->global->router_id;
207
}
208

    
209
extern list active_proto_list;
210

    
211
/*
212
 *  Each protocol instance runs two different state machines:
213
 *
214
 *  [P] The protocol machine: (implemented inside protocol)
215
 *
216
 *                DOWN    ---->    START
217
 *                  ^                   |
218
 *                  |                   V
219
 *                STOP    <----     UP
220
 *
221
 *        States:        DOWN        Protocol is down and it's waiting for the core
222
 *                        requesting protocol start.
223
 *                START        Protocol is waiting for connection with the rest
224
 *                        of the network and it's not willing to accept
225
 *                        packets. When it connects, it goes to UP state.
226
 *                UP        Protocol is up and running. When the network
227
 *                        connection breaks down or the core requests
228
 *                        protocol to be terminated, it goes to STOP state.
229
 *                STOP        Protocol is disconnecting from the network.
230
 *                        After it disconnects, it returns to DOWN state.
231
 *
232
 *        In:        start()        Called in DOWN state to request protocol startup.
233
 *                        Returns new state: either UP or START (in this
234
 *                        case, the protocol will notify the core when it
235
 *                        finally comes UP).
236
 *                stop()        Called in START, UP or STOP state to request
237
 *                        protocol shutdown. Returns new state: either
238
 *                        DOWN or STOP (in this case, the protocol will
239
 *                        notify the core when it finally comes DOWN).
240
 *
241
 *        Out:        proto_notify_state() -- called by protocol instance when
242
 *                        it does any state transition not covered by
243
 *                        return values of start() and stop(). This includes
244
 *                        START->UP (delayed protocol startup), UP->STOP
245
 *                        (spontaneous shutdown) and STOP->DOWN (delayed
246
 *                        shutdown).
247
 */
248

    
249
#define PS_DOWN 0
250
#define PS_START 1
251
#define PS_UP 2
252
#define PS_STOP 3
253

    
254
void proto_notify_state(struct proto *p, unsigned state);
255

    
256
/*
257
 *  [F] The feeder machine: (implemented in core routines)
258
 *
259
 *                HUNGRY    ---->   FEEDING
260
 *                 ^                     |
261
 *                 |                      V
262
 *                FLUSHING  <----   HAPPY
263
 *
264
 *        States:        HUNGRY        Protocol either administratively down (i.e.,
265
 *                        disabled by the user) or temporarily down
266
 *                        (i.e., [P] is not UP)
267
 *                FEEDING        The protocol came up and we're feeding it
268
 *                        initial routes. [P] is UP.
269
 *                HAPPY        The protocol is up and it's receiving normal
270
 *                        routing updates. [P] is UP.
271
 *                FLUSHING The protocol is down and we're removing its
272
 *                        routes from the table. [P] is STOP or DOWN.
273
 *
274
 *        Normal lifecycle of a protocol looks like:
275
 *
276
 *                HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
277
 *                FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
278
 *                HUNGRY/STOP|DOWN --> HUNGRY/DOWN
279
 *
280
 *        Sometimes, protocol might switch from HAPPY/UP to FEEDING/UP 
281
 *        if it wants to refeed the routes (for example BGP does so
282
 *        as a result of received ROUTE-REFRESH request).
283
 */
284

    
285
#define FS_HUNGRY 0
286
#define FS_FEEDING 1
287
#define FS_HAPPY 2
288
#define FS_FLUSHING 3
289

    
290
/*
291
 *        Debugging flags
292
 */
293

    
294
#define D_STATES 1                /* [core] State transitions */
295
#define D_ROUTES 2                /* [core] Routes passed by the filters */
296
#define D_FILTERS 4                /* [core] Routes rejected by the filters */
297
#define D_IFACES 8                /* [core] Interface events */
298
#define D_EVENTS 16                /* Protocol events */
299
#define D_PACKETS 32                /* Packets sent/received */
300

    
301
/*
302
 *        Known unique protocol instances as referenced by config routines
303
 */
304

    
305
extern struct proto_config *cf_dev_proto;
306

    
307
/*
308
 *        Route Announcement Hook
309
 */
310

    
311
struct announce_hook {
312
  node n;
313
  struct rtable *table;
314
  struct proto *proto;
315
  struct announce_hook *next;                /* Next hook for the same protocol */
316
};
317

    
318
struct announce_hook *proto_add_announce_hook(struct proto *, struct rtable *);
319

    
320
#endif