Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (11.4 KB)

1 58ef912c Martin Mares
/*
2
 *        BIRD Internet Routing Daemon -- Protocols
3
 *
4 7293c5dd Martin Mares
 *        (c) 1998--2000 Martin Mares <mj@ucw.cz>
5 58ef912c Martin Mares
 *
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 2326b001 Martin Mares
#include "lib/lists.h"
13 1feea03e Martin Mares
#include "lib/resource.h"
14 9685deb9 Martin Mares
#include "lib/timer.h"
15 4cdd0784 Ondrej Zajicek
#include "conf/conf.h"
16 58ef912c Martin Mares
17 2326b001 Martin Mares
struct iface;
18 9a158361 Martin Mares
struct ifa;
19 2326b001 Martin Mares
struct rte;
20
struct neighbor;
21 1b769b08 Martin Mares
struct rta;
22 8c43696d Martin Mares
struct network;
23 31b3e1bb Martin Mares
struct proto_config;
24
struct config;
25
struct proto;
26 64011f89 Martin Mares
struct event;
27 bb027be1 Martin Mares
struct ea_list;
28 3991d84e Martin Mares
struct eattr;
29 ae97b946 Martin Mares
struct symbol;
30 2326b001 Martin Mares
31 58ef912c Martin Mares
/*
32
 *        Routing Protocol
33
 */
34
35
struct protocol {
36 a5f1a60e Martin Mares
  node n;
37 58ef912c Martin Mares
  char *name;
38 d272fe22 Martin Mares
  char *template;                        /* Template for automatic generation of names */
39 4ba84ebc Martin Mares
  int name_counter;                        /* Counter for automatic name generation */
40 3991d84e Martin Mares
  int attr_class;                        /* Attribute class known to this protocol */
41 58ef912c Martin Mares
42 31b3e1bb Martin Mares
  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 50fe90ed Martin Mares
  int (*reconfigure)(struct proto *, struct proto_config *);        /* Try to reconfigure instance, returns success */
46 31b3e1bb Martin Mares
  void (*dump)(struct proto *);                        /* Debugging dump */
47 69ec9087 Martin Mares
  void (*dump_attrs)(struct rte *);                /* Dump protocol-dependent attributes */
48 31b3e1bb Martin Mares
  int (*start)(struct proto *);                        /* Start the instance */
49
  int (*shutdown)(struct proto *);                /* Stop the instance */
50 9685deb9 Martin Mares
  void (*get_status)(struct proto *, byte *buf); /* Get instance status (for `show protocols' command) */
51 ce1da96e Martin Mares
  void (*get_route_info)(struct rte *, byte *buf, struct ea_list *attrs); /* Get route information (for `show route' command) */
52 aebe06b4 Ondrej Zajicek
  int (*get_attr)(struct eattr *, byte *buf, int buflen);        /* ASCIIfy dynamic attribute (returns GA_*) */
53 58ef912c Martin Mares
};
54
55 0432c017 Martin Mares
void protos_build(void);
56 3991d84e Martin Mares
void proto_build(struct protocol *);
57 31b3e1bb Martin Mares
void protos_preconfig(struct config *);
58
void protos_postconfig(struct config *);
59 bf1aec97 Ondrej Zajicek
void protos_commit(struct config *new, struct config *old, int force_restart, int type);
60 87d2be86 Pavel Machek
void protos_dump_all(void);
61 a5f1a60e Martin Mares
62 3991d84e Martin Mares
#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 58ef912c Martin Mares
66
/*
67
 *        Known protocols
68
 */
69
70 2638249d Martin Mares
extern struct protocol
71
  proto_device, proto_rip, proto_static,
72
  proto_ospf, proto_pipe, proto_bgp;
73 58ef912c Martin Mares
74
/*
75
 *        Routing Protocol Instance
76
 */
77
78 31b3e1bb Martin Mares
struct proto_config {
79
  node n;
80
  struct config *global;                /* Global configuration data */
81 1d2664a4 Martin Mares
  struct protocol *protocol;                /* Protocol */
82
  struct proto *proto;                        /* Instance we've created */
83 31b3e1bb Martin Mares
  char *name;
84 e04555c0 Ondrej Zajicek
  char *dsc;
85 31b3e1bb Martin Mares
  unsigned debug, preference, disabled;        /* Generic parameters */
86 4cdd0784 Ondrej Zajicek
  u32 router_id;                        /* Protocol specific router ID */
87 0e02abfd Martin Mares
  struct rtable_config *table;                /* Table we're attached to */
88 529c4149 Martin Mares
  struct filter *in_filter, *out_filter; /* Attached filters */
89 31b3e1bb Martin Mares
90
  /* Protocol-specific data follow... */
91
};
92
93 925fe2d3 Ondrej Zajicek
  /* 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 58ef912c Martin Mares
struct proto {
119 f14a4bec Martin Mares
  node n;                                /* Node in *_proto_list */
120
  node glob_node;                        /* Node in global proto_list */
121 58ef912c Martin Mares
  struct protocol *proto;                /* Protocol */
122 31b3e1bb Martin Mares
  struct proto_config *cf;                /* Configuration data */
123 50fe90ed Martin Mares
  struct proto_config *cf_new;                /* Configuration we want to switch to after shutdown (NULL=delete) */
124 31b3e1bb Martin Mares
  pool *pool;                                /* Pool containing local objects */
125 64011f89 Martin Mares
  struct event *attn;                        /* "Pay attention" event */
126 31b3e1bb Martin Mares
127 64011f89 Martin Mares
  char *name;                                /* Name of this instance (== cf->name) */
128 58ef912c Martin Mares
  unsigned debug;                        /* Debugging flags */
129
  unsigned preference;                        /* Default route preference */
130 0da472d7 Martin Mares
  int min_scope;                        /* Minimal route scope accepted */
131 23ac9e9a Ondrej Zajicek
  unsigned accept_ra_types;                /* Which types of route announcements are accepted (RA_OPTIMAL or RA_ANY) */
132 bd5d0d62 Martin Mares
  unsigned disabled;                        /* Manually disabled */
133 31b3e1bb Martin Mares
  unsigned proto_state;                        /* Protocol state machine (see below) */
134
  unsigned core_state;                        /* Core state machine (see below) */
135 64011f89 Martin Mares
  unsigned core_goal;                        /* State we want to reach (see below) */
136 50fe90ed Martin Mares
  unsigned reconfiguring;                /* We're shutting down due to reconfiguration */
137 7293c5dd Martin Mares
  u32 hash_key;                                /* Random key used for hashing of neighbors */
138 9685deb9 Martin Mares
  bird_clock_t last_state_change;        /* Time of last state transition */
139 df9f0fb3 Martin Mares
  char *last_state_name_announced;        /* Last state name we've announced to the user */
140 925fe2d3 Ondrej Zajicek
  struct proto_stats stats;                /* Current protocol statistics */
141 58ef912c Martin Mares
142 9e0e485e Martin Mares
  /*
143
   *        General protocol hooks:
144
   *
145
   *           if_notify        Notify protocol about interface state changes.
146 9a158361 Martin Mares
   *           ifa_notify        Notify protocol about interface address changes.
147 9e0e485e Martin Mares
   *           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
   */
156
157 9a158361 Martin Mares
  void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
158
  void (*ifa_notify)(struct proto *, unsigned flags, struct ifa *a);
159 08f0290a Martin Mares
  void (*rt_notify)(struct proto *, struct network *net, struct rte *new, struct rte *old, struct ea_list *attrs);
160 4cc78c50 Martin Mares
  void (*neigh_notify)(struct neighbor *neigh);
161 9e0e485e Martin Mares
  struct ea_list *(*make_tmp_attrs)(struct rte *rt, struct linpool *pool);
162
  void (*store_tmp_attrs)(struct rte *rt, struct ea_list *attrs);
163
  int (*import_control)(struct proto *, struct rte **rt, struct ea_list **attrs, struct linpool *pool);
164
165
  /*
166
   *        Routing entry hooks (called only for rte's belonging to this protocol):
167
   *
168
   *           rte_better        Compare two rte's and decide which one is better (1=first, 0=second).
169 67be5b23 Martin Mares
   *       rte_same        Compare two rte's and decide whether they are identical (1=yes, 0=no).
170 9e0e485e Martin Mares
   *           rte_insert        Called whenever a rte is inserted to a routing table.
171
   *           rte_remove        Called whenever a rte is removed from the routing table.
172
   */
173 58ef912c Martin Mares
174 2326b001 Martin Mares
  int (*rte_better)(struct rte *, struct rte *);
175 67be5b23 Martin Mares
  int (*rte_same)(struct rte *, struct rte *);
176 acc62f5e Martin Mares
  void (*rte_insert)(struct network *, struct rte *);
177
  void (*rte_remove)(struct network *, struct rte *);
178 2326b001 Martin Mares
179 0e02abfd Martin Mares
  struct rtable *table;                        /* Our primary routing table */
180 529c4149 Martin Mares
  struct filter *in_filter;                /* Input filter */
181
  struct filter *out_filter;                /* Output filter */
182 0e02abfd Martin Mares
  struct announce_hook *ahooks;                /* Announcement hooks for this protocol */
183 529c4149 Martin Mares
184 ac5d8012 Martin Mares
  struct fib_iterator *feed_iterator;        /* Routing table iterator used during protocol feeding */
185
  struct announce_hook *feed_ahook;        /* Announce hook we currently feed */
186
187 58ef912c Martin Mares
  /* Hic sunt protocol-specific data */
188
};
189
190 31b3e1bb Martin Mares
void *proto_new(struct proto_config *, unsigned size);
191
void *proto_config_new(struct protocol *, unsigned size);
192 f14a4bec Martin Mares
193 0d3e6bce Martin Mares
void proto_show(struct symbol *, int);
194 02c1fbdd Martin Mares
struct proto *proto_get_named(struct symbol *, struct protocol *);
195 f14a4bec Martin Mares
void proto_xxable(char *, int);
196 96d8e3bf Martin Mares
void proto_debug(char *, unsigned int);
197 58ef912c Martin Mares
198 4cdd0784 Ondrej Zajicek
static inline u32
199
proto_get_router_id(struct proto_config *pc)
200
{
201
  return pc->router_id ? pc->router_id : pc->global->router_id;
202
}
203
204 f14a4bec Martin Mares
extern list active_proto_list;
205 2326b001 Martin Mares
206 50d8424a Martin Mares
/*
207 31b3e1bb Martin Mares
 *  Each protocol instance runs two different state machines:
208
 *
209
 *  [P] The protocol machine: (implemented inside protocol)
210
 *
211
 *                DOWN    ---->    START
212
 *                  ^                   |
213
 *                  |                   V
214
 *                STOP    <----     UP
215
 *
216
 *        States:        DOWN        Protocol is down and it's waiting for the core
217
 *                        requesting protocol start.
218
 *                START        Protocol is waiting for connection with the rest
219
 *                        of the network and it's not willing to accept
220
 *                        packets. When it connects, it goes to UP state.
221
 *                UP        Protocol is up and running. When the network
222
 *                        connection breaks down or the core requests
223
 *                        protocol to be terminated, it goes to STOP state.
224
 *                STOP        Protocol is disconnecting from the network.
225
 *                        After it disconnects, it returns to DOWN state.
226
 *
227
 *        In:        start()        Called in DOWN state to request protocol startup.
228
 *                        Returns new state: either UP or START (in this
229
 *                        case, the protocol will notify the core when it
230
 *                        finally comes UP).
231
 *                stop()        Called in START, UP or STOP state to request
232
 *                        protocol shutdown. Returns new state: either
233
 *                        DOWN or STOP (in this case, the protocol will
234
 *                        notify the core when it finally comes DOWN).
235
 *
236
 *        Out:        proto_notify_state() -- called by protocol instance when
237
 *                        it does any state transition not covered by
238
 *                        return values of start() and stop(). This includes
239
 *                        START->UP (delayed protocol startup), UP->STOP
240
 *                        (spontaneous shutdown) and STOP->DOWN (delayed
241
 *                        shutdown).
242
 */
243
244
#define PS_DOWN 0
245
#define PS_START 1
246
#define PS_UP 2
247
#define PS_STOP 3
248
249
void proto_notify_state(struct proto *p, unsigned state);
250
251
/*
252
 *  [F] The feeder machine: (implemented in core routines)
253
 *
254
 *                HUNGRY    ---->   FEEDING
255
 *                 ^                     |
256
 *                 |                      V
257
 *                FLUSHING  <----   HAPPY
258
 *
259
 *        States:        HUNGRY        Protocol either administratively down (i.e.,
260
 *                        disabled by the user) or temporarily down
261
 *                        (i.e., [P] is not UP)
262
 *                FEEDING        The protocol came up and we're feeding it
263
 *                        initial routes. [P] is UP.
264
 *                HAPPY        The protocol is up and it's receiving normal
265
 *                        routing updates. [P] is UP.
266
 *                FLUSHING The protocol is down and we're removing its
267
 *                        routes from the table. [P] is STOP or DOWN.
268
 *
269
 *        Normal lifecycle of a protocol looks like:
270
 *
271
 *                HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
272
 *                FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
273
 *                HUNGRY/STOP|DOWN --> HUNGRY/DOWN
274
 */
275
276
#define FS_HUNGRY 0
277
#define FS_FEEDING 1
278
#define FS_HAPPY 2
279
#define FS_FLUSHING 3
280
281
/*
282 96d8e3bf Martin Mares
 *        Debugging flags
283
 */
284
285
#define D_STATES 1                /* [core] State transitions */
286
#define D_ROUTES 2                /* [core] Routes passed by the filters */
287 6a9f28b0 Martin Mares
#define D_FILTERS 4                /* [core] Routes rejected by the filters */
288
#define D_IFACES 8                /* [core] Interface events */
289
#define D_EVENTS 16                /* Protocol events */
290
#define D_PACKETS 32                /* Packets sent/received */
291 96d8e3bf Martin Mares
292
/*
293 50d8424a Martin Mares
 *        Known unique protocol instances as referenced by config routines
294
 */
295
296 31b3e1bb Martin Mares
extern struct proto_config *cf_dev_proto;
297 50d8424a Martin Mares
298 f4aabcee Martin Mares
/*
299 0e02abfd Martin Mares
 *        Route Announcement Hook
300
 */
301
302
struct announce_hook {
303
  node n;
304
  struct rtable *table;
305
  struct proto *proto;
306
  struct announce_hook *next;                /* Next hook for the same protocol */
307
};
308
309
struct announce_hook *proto_add_announce_hook(struct proto *, struct rtable *);
310
311 58ef912c Martin Mares
#endif