protocol.h 7.91 KB
Newer Older
1 2 3
/*
 *	BIRD Internet Routing Daemon -- Protocols
 *
4
 *	(c) 1998--1999 Martin Mares <mj@ucw.cz>
5 6 7 8 9 10 11
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_PROTOCOL_H_
#define _BIRD_PROTOCOL_H_

12
#include "lib/lists.h"
13
#include "lib/resource.h"
14

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

28 29 30 31 32
/*
 *	Routing Protocol
 */

struct protocol {
33
  node n;
34 35
  char *name;
  unsigned debug;			/* Default debugging flags */
36
  int priority;				/* Protocol priority (usually 0) */
37
  int name_counter;			/* Counter for automatic name generation */
Martin Mareš's avatar
Martin Mareš committed
38
  int startup_counter;			/* Number of instances waiting for initialization */
39

40 41 42 43 44
  void (*preconfig)(struct protocol *, struct config *);	/* Just before configuring */
  void (*postconfig)(struct proto_config *);			/* After configuring each instance */
  struct proto * (*init)(struct proto_config *);		/* Create new instance */
  int (*reconfigure)(struct proto *, struct proto_config *);	/* Try to reconfigure instance */
  void (*dump)(struct proto *);			/* Debugging dump */
45
  void (*dump_attrs)(struct rte *);		/* Dump protocol-dependent attributes */
46 47
  int (*start)(struct proto *);			/* Start the instance */
  int (*shutdown)(struct proto *);		/* Stop the instance */
48 49
};

50
void protos_build(void);
51 52 53
void protos_preconfig(struct config *);
void protos_postconfig(struct config *);
void protos_commit(struct config *);
54
void protos_start(void);
55
void protos_dump_all(void);
56
void protos_shutdown(void);
57 58

extern list protocol_list;
59 60 61 62 63

/*
 *	Known protocols
 */

64
extern struct protocol proto_device;
65
extern struct protocol proto_rip;
66
extern struct protocol proto_static;
Ondřej Filip's avatar
 
Ondřej Filip committed
67
extern struct protocol proto_ospf;
68
extern struct protocol proto_pipe;
69 70 71 72 73

/*
 *	Routing Protocol Instance
 */

74 75 76
struct proto_config {
  node n;
  struct config *global;		/* Global configuration data */
77 78
  struct protocol *protocol;		/* Protocol */
  struct proto *proto;			/* Instance we've created */
79 80
  char *name;
  unsigned debug, preference, disabled;	/* Generic parameters */
81
  struct rtable_config *table;		/* Table we're attached to */
82
  struct filter *in_filter, *out_filter; /* Attached filters */
83 84 85 86

  /* Protocol-specific data follow... */
};

87
struct proto {
88
  node n;
89
  struct protocol *proto;		/* Protocol */
90 91
  struct proto_config *cf;		/* Configuration data */
  pool *pool;				/* Pool containing local objects */
92
  struct event *attn;			/* "Pay attention" event */
93

94
  char *name;				/* Name of this instance (== cf->name) */
95 96
  unsigned debug;			/* Debugging flags */
  unsigned preference;			/* Default route preference */
97
  unsigned disabled;			/* Manually disabled */
98 99
  unsigned proto_state;			/* Protocol state machine (see below) */
  unsigned core_state;			/* Core state machine (see below) */
100
  unsigned core_goal;			/* State we want to reach (see below) */
101

102 103 104 105
  /*
   *	General protocol hooks:
   *
   *	   if_notify	Notify protocol about interface state changes.
106
   *	   ifa_notify	Notify protocol about interface address changes.
107 108 109 110 111 112 113 114 115 116
   *	   rt_notify	Notify protocol about routing table updates.
   *	   neigh_notify	Notify protocol about neighbor cache events.
   *	   make_tmp_attrs  Construct ea_list from private attrs stored in rte.
   *	   store_tmp_attrs Store private attrs back to the rte.
   *	   import_control  Called as the first step of the route importing process.
   *			It can construct a new rte, add private attributes and
   *			decide whether the route shall be imported: 1=yes, -1=no,
   *			0=process it through the import filter set by the user.
   */

117 118
  void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
  void (*ifa_notify)(struct proto *, unsigned flags, struct ifa *a);
119
  void (*rt_notify)(struct proto *, struct network *net, struct rte *new, struct rte *old, struct ea_list *tmpa);
120
  void (*neigh_notify)(struct neighbor *neigh);
121 122 123 124 125 126 127 128 129 130 131
  struct ea_list *(*make_tmp_attrs)(struct rte *rt, struct linpool *pool);
  void (*store_tmp_attrs)(struct rte *rt, struct ea_list *attrs);
  int (*import_control)(struct proto *, struct rte **rt, struct ea_list **attrs, struct linpool *pool);

  /*
   *	Routing entry hooks (called only for rte's belonging to this protocol):
   *
   *	   rte_better	Compare two rte's and decide which one is better (1=first, 0=second).
   *	   rte_insert	Called whenever a rte is inserted to a routing table.
   *	   rte_remove	Called whenever a rte is removed from the routing table.
   */
132

133
  int (*rte_better)(struct rte *, struct rte *);
134 135
  void (*rte_insert)(struct network *, struct rte *);
  void (*rte_remove)(struct network *, struct rte *);
136

137
  struct rtable *table;			/* Our primary routing table */
138 139
  struct filter *in_filter;		/* Input filter */
  struct filter *out_filter;		/* Output filter */
140
  struct announce_hook *ahooks;		/* Announcement hooks for this protocol */
141

142 143 144
  /* Hic sunt protocol-specific data */
};

145 146 147
void proto_build(struct proto_config *);
void *proto_new(struct proto_config *, unsigned size);
void *proto_config_new(struct protocol *, unsigned size);
148
void proto_show(struct symbol *, int);
149

150
extern list proto_list;
151

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
/*
 *  Each protocol instance runs two different state machines:
 *
 *  [P] The protocol machine: (implemented inside protocol)
 *
 *		DOWN    ---->    START
 *		  ^		   |
 *		  |		   V
 *		STOP    <----     UP
 *
 *	States:	DOWN	Protocol is down and it's waiting for the core
 *			requesting protocol start.
 *		START	Protocol is waiting for connection with the rest
 *			of the network and it's not willing to accept
 *			packets. When it connects, it goes to UP state.
 *		UP	Protocol is up and running. When the network
 *			connection breaks down or the core requests
 *			protocol to be terminated, it goes to STOP state.
 *		STOP	Protocol is disconnecting from the network.
 *			After it disconnects, it returns to DOWN state.
 *
 *	In:	start()	Called in DOWN state to request protocol startup.
 *			Returns new state: either UP or START (in this
 *			case, the protocol will notify the core when it
 *			finally comes UP).
 *		stop()	Called in START, UP or STOP state to request
 *			protocol shutdown. Returns new state: either
 *			DOWN or STOP (in this case, the protocol will
 *			notify the core when it finally comes DOWN).
 *
 *	Out:	proto_notify_state() -- called by protocol instance when
 *			it does any state transition not covered by
 *			return values of start() and stop(). This includes
 *			START->UP (delayed protocol startup), UP->STOP
 *			(spontaneous shutdown) and STOP->DOWN (delayed
 *			shutdown).
 */

#define PS_DOWN 0
#define PS_START 1
#define PS_UP 2
#define PS_STOP 3

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

/*
 *  [F] The feeder machine: (implemented in core routines)
 *
 *		HUNGRY    ---->   FEEDING
 *		 ^		     |
 *		 | 		     V
 *		FLUSHING  <----   HAPPY
 *
 *	States:	HUNGRY	Protocol either administratively down (i.e.,
 *			disabled by the user) or temporarily down
 *			(i.e., [P] is not UP)
 *		FEEDING	The protocol came up and we're feeding it
 *			initial routes. [P] is UP.
 *		HAPPY	The protocol is up and it's receiving normal
 *			routing updates. [P] is UP.
 *		FLUSHING The protocol is down and we're removing its
 *			routes from the table. [P] is STOP or DOWN.
 *
 *	Normal lifecycle of a protocol looks like:
 *
 *		HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
 *		FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
 *		HUNGRY/STOP|DOWN --> HUNGRY/DOWN
 */

#define FS_HUNGRY 0
#define FS_FEEDING 1
#define FS_HAPPY 2
#define FS_FLUSHING 3

227 228 229 230
/*
 *	Known unique protocol instances as referenced by config routines
 */

231
extern struct proto_config *cf_dev_proto;
232

233 234 235 236 237 238 239 240 241 242 243 244 245
/*
 *	Route Announcement Hook
 */

struct announce_hook {
  node n;
  struct rtable *table;
  struct proto *proto;
  struct announce_hook *next;		/* Next hook for the same protocol */
};

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

246 247 248 249 250 251
/*
 *	Callback to sysdep code when shutdown is finished
 */

void protos_shutdown_notify(void);

252
#endif