Import Upstream version 1.2.2
[quagga-debian.git] / bgpd / bgpd.h
1 /* BGP message definition header.
2    Copyright (C) 1996, 97, 98, 99, 2000 Kunihiro Ishiguro
3
4 This file is part of GNU Zebra.
5
6 GNU Zebra is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 GNU Zebra is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Zebra; see the file COPYING.  If not, write to the Free
18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
19 02111-1307, USA.  */
20
21 #ifndef _QUAGGA_BGPD_H
22 #define _QUAGGA_BGPD_H
23
24 /* For union sockunion.  */
25 #include "sockunion.h"
26
27 /* Typedef BGP specific types.  */
28 typedef u_int32_t as_t;
29 typedef u_int16_t as16_t; /* we may still encounter 16 Bit asnums */
30 typedef u_int16_t bgp_size_t;
31
32 /* BGP master for system wide configurations and variables.  */
33 struct bgp_master
34 {
35   /* BGP instance list.  */
36   struct list *bgp;
37
38   /* BGP thread master.  */
39   struct thread_master *master;
40
41   /* work queues */
42   struct work_queue *process_main_queue;
43   struct work_queue *process_rsclient_queue;
44   
45   /* Listening sockets */
46   struct list *listen_sockets;
47   
48   /* BGP port number.  */
49   u_int16_t port;
50
51   /* Listener address */
52   char *address;
53
54   /* BGP start time.  */
55   time_t start_time;
56
57   /* Various BGP global configuration.  */
58   u_char options;
59 #define BGP_OPT_NO_FIB                   (1 << 0)
60 #define BGP_OPT_MULTIPLE_INSTANCE        (1 << 1)
61 #define BGP_OPT_CONFIG_CISCO             (1 << 2)
62 #define BGP_OPT_NO_LISTEN                (1 << 3)
63 };
64
65 /* BGP instance structure.  */
66 struct bgp 
67 {
68   /* AS number of this BGP instance.  */
69   as_t as;
70
71   /* Name of this BGP instance.  */
72   char *name;
73   
74   /* Reference count to allow peer_delete to finish after bgp_delete */
75   int lock;
76
77   /* Self peer.  */
78   struct peer *peer_self;
79
80   /* BGP peer. */
81   struct list *peer;
82
83   /* BGP peer group.  */
84   struct list *group;
85
86   /* BGP route-server-clients. */
87   struct list *rsclient;
88
89   /* BGP configuration.  */
90   u_int16_t config;
91 #define BGP_CONFIG_ROUTER_ID              (1 << 0)
92 #define BGP_CONFIG_CLUSTER_ID             (1 << 1)
93 #define BGP_CONFIG_CONFEDERATION          (1 << 2)
94
95   /* BGP router identifier.  */
96   struct in_addr router_id;
97   struct in_addr router_id_static;
98
99   /* BGP route reflector cluster ID.  */
100   struct in_addr cluster_id;
101
102   /* BGP confederation information.  */
103   as_t confed_id;
104   as_t *confed_peers;
105   int confed_peers_cnt;
106
107   struct thread *t_startup;
108
109   /* BGP flags. */
110   u_int32_t flags;
111 #define BGP_FLAG_ALWAYS_COMPARE_MED       (1 << 0)
112 #define BGP_FLAG_DETERMINISTIC_MED        (1 << 1)
113 #define BGP_FLAG_MED_MISSING_AS_WORST     (1 << 2)
114 #define BGP_FLAG_MED_CONFED               (1 << 3)
115 #define BGP_FLAG_NO_DEFAULT_IPV4          (1 << 4)
116 #define BGP_FLAG_NO_CLIENT_TO_CLIENT      (1 << 5)
117 #define BGP_FLAG_ENFORCE_FIRST_AS         (1 << 6)
118 #define BGP_FLAG_COMPARE_ROUTER_ID        (1 << 7)
119 #define BGP_FLAG_ASPATH_IGNORE            (1 << 8)
120 #define BGP_FLAG_IMPORT_CHECK             (1 << 9)
121 #define BGP_FLAG_NO_FAST_EXT_FAILOVER     (1 << 10)
122 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES     (1 << 11)
123 #define BGP_FLAG_GRACEFUL_RESTART         (1 << 12)
124 #define BGP_FLAG_ASPATH_CONFED            (1 << 13)
125 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX   (1 << 14)
126 #define BGP_FLAG_DELETING                 (1 << 15)
127 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 16)
128
129   /* BGP Per AF flags */
130   u_int16_t af_flags[AFI_MAX][SAFI_MAX];
131 #define BGP_CONFIG_DAMPENING              (1 << 0)
132
133   /* Static route configuration.  */
134   struct bgp_table *route[AFI_MAX][SAFI_MAX];
135
136   /* Aggregate address configuration.  */
137   struct bgp_table *aggregate[AFI_MAX][SAFI_MAX];
138
139   /* BGP routing information base.  */
140   struct bgp_table *rib[AFI_MAX][SAFI_MAX];
141
142   /* BGP redistribute configuration. */
143   u_char redist[AFI_MAX][ZEBRA_ROUTE_MAX];
144
145   /* BGP redistribute metric configuration. */
146   u_char redist_metric_flag[AFI_MAX][ZEBRA_ROUTE_MAX];
147   u_int32_t redist_metric[AFI_MAX][ZEBRA_ROUTE_MAX];
148
149   /* BGP redistribute route-map.  */
150   struct
151   {
152     char *name;
153     struct route_map *map;
154   } rmap[AFI_MAX][ZEBRA_ROUTE_MAX];
155
156   /* BGP distance configuration.  */
157   u_char distance_ebgp;
158   u_char distance_ibgp;
159   u_char distance_local;
160
161   /* BGP ipv6 distance configuration.  */
162   u_char ipv6_distance_ebgp;
163   u_char ipv6_distance_ibgp;
164   u_char ipv6_distance_local;
165   
166   /* BGP default local-preference.  */
167   u_int32_t default_local_pref;
168
169   /* BGP default timer.  */
170   u_int32_t default_holdtime;
171   u_int32_t default_keepalive;
172
173   /* BGP graceful restart */
174   u_int32_t restart_time;
175   u_int32_t stalepath_time;
176
177   /* Maximum-paths configuration */
178   struct bgp_maxpaths_cfg {
179     u_int16_t maxpaths_ebgp;
180     u_int16_t maxpaths_ibgp;
181   } maxpaths[AFI_MAX][SAFI_MAX];
182 };
183
184 /* BGP peer-group support. */
185 struct peer_group
186 {
187   /* Name of the peer-group. */
188   char *name;
189
190   /* Pointer to BGP.  */
191   struct bgp *bgp;
192   
193   /* Peer-group client list. */
194   struct list *peer;
195
196   /* Peer-group config */
197   struct peer *conf;
198 };
199
200 /* BGP Notify message format. */
201 struct bgp_notify 
202 {
203   u_char code;
204   u_char subcode;
205   char *data;
206   bgp_size_t length;
207 };
208
209 /* Next hop self address. */
210 struct bgp_nexthop
211 {
212   struct interface *ifp;
213   struct in_addr v4;
214   struct in6_addr v6_global;
215   struct in6_addr v6_local;
216 };
217
218 /* BGP router distinguisher value.  */
219 #define BGP_RD_SIZE                8
220
221 struct bgp_rd
222 {
223   u_char val[BGP_RD_SIZE];
224 };
225
226 #define RMAP_IN           0
227 #define RMAP_OUT        1
228 #define RMAP_IMPORT   2
229 #define RMAP_EXPORT   3
230 #define RMAP_MAX        4
231
232 /* BGP filter structure. */
233 struct bgp_filter
234 {
235   /* Distribute-list.  */
236   struct 
237   {
238     char *name;
239     struct access_list *alist;
240   } dlist[FILTER_MAX];
241
242   /* Prefix-list.  */
243   struct
244   {
245     char *name;
246     struct prefix_list *plist;
247   } plist[FILTER_MAX];
248
249   /* Filter-list.  */
250   struct
251   {
252     char *name;
253     struct as_list *aslist;
254   } aslist[FILTER_MAX];
255
256   /* Route-map.  */
257   struct
258   {
259     char *name;
260     struct route_map *map;
261   } map[RMAP_MAX];
262
263   /* Unsuppress-map.  */
264   struct
265   {
266     char *name;
267     struct route_map *map;
268   } usmap;
269 };
270
271 /* IBGP/EBGP identifier.  We also have a CONFED peer, which is to say,
272    a peer who's AS is part of our Confederation.  */
273 typedef enum
274 {
275   BGP_PEER_IBGP = 1,
276   BGP_PEER_EBGP,
277   BGP_PEER_INTERNAL,
278   BGP_PEER_CONFED,
279 } bgp_peer_sort_t;
280
281 #define BGP_MAX_PACKET_SIZE_OVERFLOW          1024
282
283 /* BGP neighbor structure. */
284 struct peer
285 {
286   /* BGP structure.  */
287   struct bgp *bgp;
288
289   /* reference count, primarily to allow bgp_process'ing of route_node's
290    * to be done after a struct peer is deleted.
291    *
292    * named 'lock' for hysterical reasons within Quagga.
293    */
294   int lock;
295
296   /* BGP peer group.  */
297   struct peer_group *group;
298   u_char af_group[AFI_MAX][SAFI_MAX];
299
300   /* Peer's remote AS number. */
301   as_t as;                      
302
303   /* Peer's local AS number. */
304   as_t local_as;
305
306   bgp_peer_sort_t sort;
307
308   /* Peer's Change local AS number. */
309   as_t change_local_as;
310
311   /* Remote router ID. */
312   struct in_addr remote_id;
313
314   /* Local router ID. */
315   struct in_addr local_id;
316
317   /* Peer specific RIB when configured as route-server-client. */
318   struct bgp_table *rib[AFI_MAX][SAFI_MAX];
319
320   /* Packet receive and send buffer. */
321   struct stream *ibuf;
322   struct stream_fifo *obuf;
323   struct stream *work;
324
325   /* We use a separate stream to encode MP_REACH_NLRI for efficient
326    * NLRI packing. peer->work stores all the other attributes. The
327    * actual packet is then constructed by concatenating the two.
328    */
329   struct stream *scratch;
330
331   /* Status of the peer. */
332   int status;
333   int ostatus;
334
335   /* Peer index, used for dumping TABLE_DUMP_V2 format */
336   uint16_t table_dump_index;
337
338   /* Peer information */
339   int fd;                       /* File descriptor */
340   int ttl;                      /* TTL of TCP connection to the peer. */
341   int rtt;                      /* Estimated round-trip-time from TCP_INFO */
342   int gtsm_hops;                /* minimum hopcount to peer */
343   char *desc;                   /* Description of the peer. */
344   unsigned short port;          /* Destination port for peer */
345   char *host;                   /* Printable address of the peer. */
346   union sockunion su;           /* Sockunion address of the peer. */
347   time_t uptime;                /* Last Up/Down time */
348   time_t readtime;              /* Last read time */
349   time_t resettime;             /* Last reset time */
350   
351   ifindex_t ifindex;            /* ifindex of the BGP connection. */
352   char *ifname;                 /* bind interface name. */
353   char *update_if;
354   union sockunion *update_source;
355   struct zlog *log;
356
357   union sockunion *su_local;    /* Sockunion of local address.  */
358   union sockunion *su_remote;   /* Sockunion of remote address.  */
359   int shared_network;           /* Is this peer shared same network. */
360   struct bgp_nexthop nexthop;   /* Nexthop */
361
362   /* Peer address family configuration. */
363   u_char afc[AFI_MAX][SAFI_MAX];
364   u_char afc_nego[AFI_MAX][SAFI_MAX];
365   u_char afc_adv[AFI_MAX][SAFI_MAX];
366   u_char afc_recv[AFI_MAX][SAFI_MAX];
367
368   /* Capability flags (reset in bgp_stop) */
369   u_int16_t cap;
370 #define PEER_CAP_REFRESH_ADV                (1 << 0) /* refresh advertised */
371 #define PEER_CAP_REFRESH_OLD_RCV            (1 << 1) /* refresh old received */
372 #define PEER_CAP_REFRESH_NEW_RCV            (1 << 2) /* refresh rfc received */
373 #define PEER_CAP_DYNAMIC_ADV                (1 << 3) /* dynamic advertised */
374 #define PEER_CAP_DYNAMIC_RCV                (1 << 4) /* dynamic received */
375 #define PEER_CAP_RESTART_ADV                (1 << 5) /* restart advertised */
376 #define PEER_CAP_RESTART_RCV                (1 << 6) /* restart received */
377 #define PEER_CAP_AS4_ADV                    (1 << 7) /* as4 advertised */
378 #define PEER_CAP_AS4_RCV                    (1 << 8) /* as4 received */
379 #define PEER_CAP_RESTART_BIT_ADV            (1 << 9) /* sent restart state */
380 #define PEER_CAP_RESTART_BIT_RCV            (1 << 10) /* peer restart state */
381
382   /* Capability flags (reset in bgp_stop) */
383   u_int16_t af_cap[AFI_MAX][SAFI_MAX];
384 #define PEER_CAP_ORF_PREFIX_SM_ADV          (1 << 0) /* send-mode advertised */
385 #define PEER_CAP_ORF_PREFIX_RM_ADV          (1 << 1) /* receive-mode advertised */
386 #define PEER_CAP_ORF_PREFIX_SM_RCV          (1 << 2) /* send-mode received */
387 #define PEER_CAP_ORF_PREFIX_RM_RCV          (1 << 3) /* receive-mode received */
388 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV      (1 << 4) /* send-mode received */
389 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV      (1 << 5) /* receive-mode received */
390 #define PEER_CAP_RESTART_AF_RCV             (1 << 6) /* graceful restart afi/safi received */
391 #define PEER_CAP_RESTART_AF_PRESERVE_RCV    (1 << 7) /* graceful restart afi/safi F-bit received */
392
393   /* Global configuration flags. */
394   u_int32_t flags;
395 #define PEER_FLAG_PASSIVE                   (1 << 0) /* passive mode */
396 #define PEER_FLAG_SHUTDOWN                  (1 << 1) /* shutdown */
397 #define PEER_FLAG_DONT_CAPABILITY           (1 << 2) /* dont-capability */
398 #define PEER_FLAG_OVERRIDE_CAPABILITY       (1 << 3) /* override-capability */
399 #define PEER_FLAG_STRICT_CAP_MATCH          (1 << 4) /* strict-match */
400 #define PEER_FLAG_DYNAMIC_CAPABILITY        (1 << 5) /* dynamic capability */
401 #define PEER_FLAG_DISABLE_CONNECTED_CHECK   (1 << 6) /* disable-connected-check */
402 #define PEER_FLAG_LOCAL_AS_NO_PREPEND       (1 << 7) /* local-as no-prepend */
403 #define PEER_FLAG_LOCAL_AS_REPLACE_AS       (1 << 8) /* local-as no-prepend replace-as */
404
405   /* NSF mode (graceful restart) */
406   u_char nsf[AFI_MAX][SAFI_MAX];
407
408   /* Per AF configuration flags. */
409   u_int32_t af_flags[AFI_MAX][SAFI_MAX];
410 #define PEER_FLAG_SEND_COMMUNITY            (1 << 0) /* send-community */
411 #define PEER_FLAG_SEND_EXT_COMMUNITY        (1 << 1) /* send-community ext. */
412 #define PEER_FLAG_NEXTHOP_SELF              (1 << 2) /* next-hop-self */
413 #define PEER_FLAG_REFLECTOR_CLIENT          (1 << 3) /* reflector-client */
414 #define PEER_FLAG_RSERVER_CLIENT            (1 << 4) /* route-server-client */
415 #define PEER_FLAG_SOFT_RECONFIG             (1 << 5) /* soft-reconfiguration */
416 #define PEER_FLAG_AS_PATH_UNCHANGED         (1 << 6) /* transparent-as */
417 #define PEER_FLAG_NEXTHOP_UNCHANGED         (1 << 7) /* transparent-next-hop */
418 #define PEER_FLAG_MED_UNCHANGED             (1 << 8) /* transparent-next-hop */
419 #define PEER_FLAG_DEFAULT_ORIGINATE         (1 << 9) /* default-originate */
420 #define PEER_FLAG_REMOVE_PRIVATE_AS         (1 << 10) /* remove-private-as */
421 #define PEER_FLAG_ALLOWAS_IN                (1 << 11) /* set allowas-in */
422 #define PEER_FLAG_ORF_PREFIX_SM             (1 << 12) /* orf capability send-mode */
423 #define PEER_FLAG_ORF_PREFIX_RM             (1 << 13) /* orf capability receive-mode */
424 #define PEER_FLAG_MAX_PREFIX                (1 << 14) /* maximum prefix */
425 #define PEER_FLAG_MAX_PREFIX_WARNING        (1 << 15) /* maximum prefix warning-only */
426 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED   (1 << 16) /* leave link-local nexthop unchanged */
427 #define PEER_FLAG_NEXTHOP_SELF_ALL          (1 << 17) /* next-hop-self all */
428 #define PEER_FLAG_SEND_LARGE_COMMUNITY      (1 << 18) /* Send large Communities */
429
430   /* MD5 password */
431   char *password;
432
433   /* default-originate route-map.  */
434   struct
435   {
436     char *name;
437     struct route_map *map;
438   } default_rmap[AFI_MAX][SAFI_MAX];
439
440   /* Peer status flags. */
441   u_int16_t sflags;
442 #define PEER_STATUS_ACCEPT_PEER       (1 << 0) /* accept peer */
443 #define PEER_STATUS_PREFIX_OVERFLOW   (1 << 1) /* prefix-overflow */
444 #define PEER_STATUS_CAPABILITY_OPEN   (1 << 2) /* capability open send */
445 #define PEER_STATUS_OPEN_DEFERRED     (1 << 3) /* deferred to open_receive */
446 #define PEER_STATUS_GROUP             (1 << 4) /* peer-group conf */
447 #define PEER_STATUS_NSF_MODE          (1 << 5) /* NSF aware peer */
448 #define PEER_STATUS_NSF_WAIT          (1 << 6) /* wait comeback peer */
449
450   /* Peer status af flags (reset in bgp_stop) */
451   u_int16_t af_sflags[AFI_MAX][SAFI_MAX];
452 #define PEER_STATUS_ORF_PREFIX_SEND   (1 << 0) /* prefix-list send peer */
453 #define PEER_STATUS_ORF_WAIT_REFRESH  (1 << 1) /* wait refresh received peer */
454 #define PEER_STATUS_DEFAULT_ORIGINATE (1 << 2) /* default-originate peer */
455 #define PEER_STATUS_PREFIX_THRESHOLD  (1 << 3) /* exceed prefix-threshold */
456 #define PEER_STATUS_PREFIX_LIMIT      (1 << 4) /* exceed prefix-limit */
457 #define PEER_STATUS_EOR_SEND          (1 << 5) /* end-of-rib send to peer */
458 #define PEER_STATUS_EOR_RECEIVED      (1 << 6) /* end-of-rib received from peer */
459
460   /* Default attribute value for the peer. */
461   u_int32_t config;
462 #define PEER_CONFIG_WEIGHT            (1 << 0) /* Default weight. */
463 #define PEER_CONFIG_TIMER             (1 << 1) /* keepalive & holdtime */
464 #define PEER_CONFIG_CONNECT           (1 << 2) /* connect */
465 #define PEER_CONFIG_ROUTEADV          (1 << 3) /* route advertise */
466   u_int32_t weight;
467   u_int32_t holdtime;
468   u_int32_t keepalive;
469   u_int32_t connect;
470   u_int32_t routeadv;
471
472   /* Timer values. */
473   u_int32_t v_start;
474   u_int32_t v_connect;
475   u_int32_t v_holdtime;
476   u_int32_t v_keepalive;
477   u_int32_t v_routeadv;
478   u_int32_t v_pmax_restart;
479   u_int32_t v_gr_restart;
480
481   /* Threads. */
482   struct thread *t_read;
483   struct thread *t_write;
484   struct thread *t_start;
485   struct thread *t_connect;
486   struct thread *t_holdtime;
487   struct thread *t_keepalive;
488   struct thread *t_routeadv;
489   struct thread *t_pmax_restart;
490   struct thread *t_gr_restart;
491   struct thread *t_gr_stale;
492   
493   /* workqueues */
494   struct work_queue *clear_node_queue;
495   
496   /* Statistics field */
497   u_int32_t open_in;            /* Open message input count */
498   u_int32_t open_out;           /* Open message output count */
499   u_int32_t update_in;          /* Update message input count */
500   u_int32_t update_out;         /* Update message ouput count */
501   time_t update_time;           /* Update message received time. */
502   u_int32_t keepalive_in;       /* Keepalive input count */
503   u_int32_t keepalive_out;      /* Keepalive output count */
504   u_int32_t notify_in;          /* Notify input count */
505   u_int32_t notify_out;         /* Notify output count */
506   u_int32_t refresh_in;         /* Route Refresh input count */
507   u_int32_t refresh_out;        /* Route Refresh output count */
508   u_int32_t dynamic_cap_in;     /* Dynamic Capability input count.  */
509   u_int32_t dynamic_cap_out;    /* Dynamic Capability output count.  */
510
511   /* BGP state count */
512   u_int32_t established;        /* Established */
513   u_int32_t dropped;            /* Dropped */
514
515   /* Syncronization list and time.  */
516   struct bgp_synchronize *sync[AFI_MAX][SAFI_MAX];
517   time_t synctime;
518
519   /* Send prefix count. */
520   unsigned long scount[AFI_MAX][SAFI_MAX];
521
522   /* Announcement attribute hash.  */
523   struct hash *hash[AFI_MAX][SAFI_MAX];
524
525   /* Notify data. */
526   struct bgp_notify notify;
527
528   /* Whole packet size to be read. */
529   unsigned long packet_size;
530
531   /* Filter structure. */
532   struct bgp_filter filter[AFI_MAX][SAFI_MAX];
533
534   /* ORF Prefix-list */
535   struct prefix_list *orf_plist[AFI_MAX][SAFI_MAX];
536
537   /* Prefix count. */
538   unsigned long pcount[AFI_MAX][SAFI_MAX];
539
540   /* Max prefix count. */
541   unsigned long pmax[AFI_MAX][SAFI_MAX];
542   u_char pmax_threshold[AFI_MAX][SAFI_MAX];
543   u_int16_t pmax_restart[AFI_MAX][SAFI_MAX];
544 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
545
546   /* allowas-in. */
547   char allowas_in[AFI_MAX][SAFI_MAX];
548
549   /* peer reset cause */
550   char last_reset;
551 #define PEER_DOWN_RID_CHANGE             1 /* bgp router-id command */
552 #define PEER_DOWN_REMOTE_AS_CHANGE       2 /* neighbor remote-as command */
553 #define PEER_DOWN_LOCAL_AS_CHANGE        3 /* neighbor local-as command */
554 #define PEER_DOWN_CLID_CHANGE            4 /* bgp cluster-id command */
555 #define PEER_DOWN_CONFED_ID_CHANGE       5 /* bgp confederation identifier command */
556 #define PEER_DOWN_CONFED_PEER_CHANGE     6 /* bgp confederation peer command */
557 #define PEER_DOWN_RR_CLIENT_CHANGE       7 /* neighbor route-reflector-client command */
558 #define PEER_DOWN_RS_CLIENT_CHANGE       8 /* neighbor route-server-client command */
559 #define PEER_DOWN_UPDATE_SOURCE_CHANGE   9 /* neighbor update-source command */
560 #define PEER_DOWN_AF_ACTIVATE           10 /* neighbor activate command */
561 #define PEER_DOWN_USER_SHUTDOWN         11 /* neighbor shutdown command */
562 #define PEER_DOWN_USER_RESET            12 /* clear ip bgp command */
563 #define PEER_DOWN_NOTIFY_RECEIVED       13 /* notification received */
564 #define PEER_DOWN_NOTIFY_SEND           14 /* notification send */
565 #define PEER_DOWN_CLOSE_SESSION         15 /* tcp session close */
566 #define PEER_DOWN_NEIGHBOR_DELETE       16 /* neghbor delete */
567 #define PEER_DOWN_RMAP_BIND             17 /* neghbor peer-group command */
568 #define PEER_DOWN_RMAP_UNBIND           18 /* no neighbor peer-group command */
569 #define PEER_DOWN_CAPABILITY_CHANGE     19 /* neighbor capability command */
570 #define PEER_DOWN_PASSIVE_CHANGE        20 /* neighbor passive command */
571 #define PEER_DOWN_MULTIHOP_CHANGE       21 /* neighbor multihop command */
572 #define PEER_DOWN_NSF_CLOSE_SESSION     22 /* NSF tcp session close */
573
574   /* The kind of route-map Flags.*/
575   u_char rmap_type;
576 #define PEER_RMAP_TYPE_IN             (1 << 0) /* neighbor route-map in */
577 #define PEER_RMAP_TYPE_OUT            (1 << 1) /* neighbor route-map out */
578 #define PEER_RMAP_TYPE_NETWORK        (1 << 2) /* network route-map */
579 #define PEER_RMAP_TYPE_REDISTRIBUTE   (1 << 3) /* redistribute route-map */
580 #define PEER_RMAP_TYPE_DEFAULT        (1 << 4) /* default-originate route-map */
581 #define PEER_RMAP_TYPE_NOSET          (1 << 5) /* not allow to set commands */
582 #define PEER_RMAP_TYPE_IMPORT         (1 << 6) /* neighbor route-map import */
583 #define PEER_RMAP_TYPE_EXPORT         (1 << 7) /* neighbor route-map export */
584 };
585
586 #define PEER_PASSWORD_MINLEN    (1)
587 #define PEER_PASSWORD_MAXLEN    (80)
588
589 /* This structure's member directly points incoming packet data
590    stream. */
591 struct bgp_nlri
592 {
593   /* AFI.  */
594   afi_t afi;
595
596   /* SAFI.  */
597   safi_t safi;
598
599   /* Pointer to NLRI byte stream.  */
600   u_char *nlri;
601
602   /* Length of whole NLRI.  */
603   bgp_size_t length;
604 };
605
606 /* BGP versions.  */
607 #define BGP_VERSION_4                            4
608
609 /* Default BGP port number.  */
610 #define BGP_PORT_DEFAULT                       179
611
612 /* BGP message header and packet size.  */
613 #define BGP_MARKER_SIZE                         16
614 #define BGP_HEADER_SIZE                         19
615 #define BGP_MAX_PACKET_SIZE                   4096
616
617 /* BGP minimum message size.  */
618 #define BGP_MSG_OPEN_MIN_SIZE                   (BGP_HEADER_SIZE + 10)
619 #define BGP_MSG_UPDATE_MIN_SIZE                 (BGP_HEADER_SIZE + 4)
620 #define BGP_MSG_NOTIFY_MIN_SIZE                 (BGP_HEADER_SIZE + 2)
621 #define BGP_MSG_KEEPALIVE_MIN_SIZE              (BGP_HEADER_SIZE + 0)
622 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE          (BGP_HEADER_SIZE + 4)
623 #define BGP_MSG_CAPABILITY_MIN_SIZE             (BGP_HEADER_SIZE + 3)
624
625 /* BGP message types.  */
626 #define BGP_MSG_OPEN                             1
627 #define BGP_MSG_UPDATE                           2
628 #define BGP_MSG_NOTIFY                           3
629 #define BGP_MSG_KEEPALIVE                        4
630 #define BGP_MSG_ROUTE_REFRESH_NEW                5
631 #define BGP_MSG_CAPABILITY                       6
632 #define BGP_MSG_ROUTE_REFRESH_OLD              128
633
634 /* BGP open optional parameter.  */
635 #define BGP_OPEN_OPT_AUTH                        1
636 #define BGP_OPEN_OPT_CAP                         2
637
638 /* BGP4 attribute type codes.  */
639 #define BGP_ATTR_ORIGIN                          1
640 #define BGP_ATTR_AS_PATH                         2
641 #define BGP_ATTR_NEXT_HOP                        3
642 #define BGP_ATTR_MULTI_EXIT_DISC                 4
643 #define BGP_ATTR_LOCAL_PREF                      5
644 #define BGP_ATTR_ATOMIC_AGGREGATE                6
645 #define BGP_ATTR_AGGREGATOR                      7
646 #define BGP_ATTR_COMMUNITIES                     8
647 #define BGP_ATTR_ORIGINATOR_ID                   9
648 #define BGP_ATTR_CLUSTER_LIST                   10
649 #define BGP_ATTR_DPA                            11
650 #define BGP_ATTR_ADVERTISER                     12
651 #define BGP_ATTR_RCID_PATH                      13
652 #define BGP_ATTR_MP_REACH_NLRI                  14
653 #define BGP_ATTR_MP_UNREACH_NLRI                15
654 #define BGP_ATTR_EXT_COMMUNITIES                16
655 #define BGP_ATTR_AS4_PATH                       17
656 #define BGP_ATTR_AS4_AGGREGATOR                 18
657 #define BGP_ATTR_AS_PATHLIMIT                   21
658 #define BGP_ATTR_ENCAP                          23
659 #define BGP_ATTR_LARGE_COMMUNITIES              32
660
661 /* BGP update origin.  */
662 #define BGP_ORIGIN_IGP                           0
663 #define BGP_ORIGIN_EGP                           1
664 #define BGP_ORIGIN_INCOMPLETE                    2
665
666 /* BGP notify message codes.  */
667 #define BGP_NOTIFY_HEADER_ERR                    1
668 #define BGP_NOTIFY_OPEN_ERR                      2
669 #define BGP_NOTIFY_UPDATE_ERR                    3
670 #define BGP_NOTIFY_HOLD_ERR                      4
671 #define BGP_NOTIFY_FSM_ERR                       5
672 #define BGP_NOTIFY_CEASE                         6
673 #define BGP_NOTIFY_CAPABILITY_ERR                7
674 #define BGP_NOTIFY_MAX                           8
675
676 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC            0
677
678 /* BGP_NOTIFY_HEADER_ERR sub codes.  */
679 #define BGP_NOTIFY_HEADER_NOT_SYNC               1
680 #define BGP_NOTIFY_HEADER_BAD_MESLEN             2
681 #define BGP_NOTIFY_HEADER_BAD_MESTYPE            3
682 #define BGP_NOTIFY_HEADER_MAX                    4
683
684 /* BGP_NOTIFY_OPEN_ERR sub codes.  */
685 #define BGP_NOTIFY_OPEN_UNSPECIFIC               0
686 #define BGP_NOTIFY_OPEN_UNSUP_VERSION            1
687 #define BGP_NOTIFY_OPEN_BAD_PEER_AS              2
688 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT            3
689 #define BGP_NOTIFY_OPEN_UNSUP_PARAM              4
690 #define BGP_NOTIFY_OPEN_AUTH_FAILURE             5
691 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME          6
692 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL              7
693 #define BGP_NOTIFY_OPEN_MAX                      8
694
695 /* BGP_NOTIFY_UPDATE_ERR sub codes.  */
696 #define BGP_NOTIFY_UPDATE_MAL_ATTR               1
697 #define BGP_NOTIFY_UPDATE_UNREC_ATTR             2
698 #define BGP_NOTIFY_UPDATE_MISS_ATTR              3
699 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR          4
700 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR          5
701 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN           6
702 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP          7
703 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP         8
704 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR           9
705 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK         10
706 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH           11
707 #define BGP_NOTIFY_UPDATE_MAX                   12
708
709 /* BGP_NOTIFY_CEASE sub codes (RFC 4486).  */
710 #define BGP_NOTIFY_CEASE_MAX_PREFIX              1
711 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN          2
712 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG           3
713 #define BGP_NOTIFY_CEASE_ADMIN_RESET             4
714 #define BGP_NOTIFY_CEASE_CONNECT_REJECT          5
715 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE           6
716 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION    7
717 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE         8
718 #define BGP_NOTIFY_CEASE_MAX                     9
719
720 /* BGP_NOTIFY_CAPABILITY_ERR sub codes (draft-ietf-idr-dynamic-cap-02). */
721 #define BGP_NOTIFY_CAPABILITY_INVALID_ACTION     1
722 #define BGP_NOTIFY_CAPABILITY_INVALID_LENGTH     2
723 #define BGP_NOTIFY_CAPABILITY_MALFORMED_CODE     3
724 #define BGP_NOTIFY_CAPABILITY_MAX                4
725
726 /* BGP finite state machine status.  */
727 #define Idle                                     1
728 #define Connect                                  2
729 #define Active                                   3
730 #define OpenSent                                 4
731 #define OpenConfirm                              5
732 #define Established                              6
733 #define Clearing                                 7
734 #define Deleted                                  8
735 #define BGP_STATUS_MAX                           9
736
737 /* BGP finite state machine events.  */
738 #define BGP_Start                                1
739 #define BGP_Stop                                 2
740 #define TCP_connection_open                      3
741 #define TCP_connection_closed                    4
742 #define TCP_connection_open_failed               5
743 #define TCP_fatal_error                          6
744 #define ConnectRetry_timer_expired               7
745 #define Hold_Timer_expired                       8
746 #define KeepAlive_timer_expired                  9
747 #define Receive_OPEN_message                    10
748 #define Receive_KEEPALIVE_message               11
749 #define Receive_UPDATE_message                  12
750 #define Receive_NOTIFICATION_message            13
751 #define Clearing_Completed                      14
752 #define BGP_Stop_with_error                     15
753 #define BGP_EVENTS_MAX                          16
754
755 /* BGP timers default value.  */
756 #define BGP_INIT_START_TIMER                     1
757 #define BGP_DEFAULT_HOLDTIME                   180
758 #define BGP_DEFAULT_KEEPALIVE                   60 
759 #define BGP_DEFAULT_EBGP_ROUTEADV                3
760 #define BGP_DEFAULT_IBGP_ROUTEADV                1
761 #define BGP_DEFAULT_CONNECT_RETRY                5
762
763 /* BGP default local preference.  */
764 #define BGP_DEFAULT_LOCAL_PREF                 100
765
766 /* BGP graceful restart  */
767 #define BGP_DEFAULT_RESTART_TIME               120
768 #define BGP_DEFAULT_STALEPATH_TIME             360
769
770 /* RFC4364 */
771 #define SAFI_MPLS_LABELED_VPN                  128
772
773 /* Max TTL value.  */
774 #define TTL_MAX                                255
775
776 /* BGP uptime string length.  */
777 #define BGP_UPTIME_LEN 25
778
779 /* Default configuration settings for bgpd.  */
780 #define BGP_VTY_PORT                          2605
781 #define BGP_DEFAULT_CONFIG             "bgpd.conf"
782
783 /* Check AS path loop when we send NLRI.  */
784 /* #define BGP_SEND_ASPATH_CHECK */
785
786 /* Flag for peer_clear_soft().  */
787 enum bgp_clear_type
788 {
789   BGP_CLEAR_SOFT_NONE,
790   BGP_CLEAR_SOFT_OUT,
791   BGP_CLEAR_SOFT_IN,
792   BGP_CLEAR_SOFT_BOTH,
793   BGP_CLEAR_SOFT_IN_ORF_PREFIX,
794   BGP_CLEAR_SOFT_RSCLIENT
795 };
796
797 /* Macros. */
798 #define BGP_INPUT(P)         ((P)->ibuf)
799 #define BGP_INPUT_PNT(P)     (STREAM_PNT(BGP_INPUT(P)))
800 #define BGP_IS_VALID_STATE_FOR_NOTIF(S)\
801         (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
802
803 /* BGP error codes.  */
804 #define BGP_SUCCESS                               0
805 #define BGP_ERR_INVALID_VALUE                    -1
806 #define BGP_ERR_INVALID_FLAG                     -2
807 #define BGP_ERR_INVALID_AS                       -3
808 #define BGP_ERR_INVALID_BGP                      -4
809 #define BGP_ERR_PEER_GROUP_MEMBER                -5
810 #define BGP_ERR_MULTIPLE_INSTANCE_USED           -6
811 #define BGP_ERR_PEER_GROUP_MEMBER_EXISTS         -7
812 #define BGP_ERR_PEER_BELONGS_TO_GROUP            -8
813 #define BGP_ERR_PEER_GROUP_AF_UNCONFIGURED       -9
814 #define BGP_ERR_PEER_GROUP_NO_REMOTE_AS         -10
815 #define BGP_ERR_PEER_GROUP_CANT_CHANGE          -11
816 #define BGP_ERR_PEER_GROUP_MISMATCH             -12
817 #define BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT  -13
818 #define BGP_ERR_MULTIPLE_INSTANCE_NOT_SET       -14
819 #define BGP_ERR_AS_MISMATCH                     -15
820 #define BGP_ERR_PEER_INACTIVE                   -16
821 #define BGP_ERR_INVALID_FOR_PEER_GROUP_MEMBER   -17
822 #define BGP_ERR_PEER_GROUP_HAS_THE_FLAG         -18
823 #define BGP_ERR_PEER_FLAG_CONFLICT              -19
824 #define BGP_ERR_PEER_GROUP_SHUTDOWN             -20
825 #define BGP_ERR_PEER_FILTER_CONFLICT            -21
826 #define BGP_ERR_NOT_INTERNAL_PEER               -22
827 #define BGP_ERR_REMOVE_PRIVATE_AS               -23
828 #define BGP_ERR_AF_UNCONFIGURED                 -24
829 #define BGP_ERR_SOFT_RECONFIG_UNCONFIGURED      -25
830 #define BGP_ERR_INSTANCE_MISMATCH               -26
831 #define BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP  -27
832 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS    -28
833 #define BGP_ERR_TCPSIG_FAILED                   -29
834 #define BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK   -30
835 #define BGP_ERR_NO_IBGP_WITH_TTLHACK            -31
836 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS    -32
837 #define BGP_ERR_MAX                             -33
838
839 extern struct bgp_master *bm;
840
841 /* Prototypes. */
842 extern void bgp_terminate (void);
843 extern void bgp_reset (void);
844 extern time_t bgp_clock (void);
845 extern void bgp_zclient_reset (void);
846 extern int bgp_nexthop_set (union sockunion *, union sockunion *, 
847                      struct bgp_nexthop *, struct peer *);
848 extern struct bgp *bgp_get_default (void);
849 extern struct bgp *bgp_lookup (as_t, const char *);
850 extern struct bgp *bgp_lookup_by_name (const char *);
851 extern struct peer *peer_lookup (struct bgp *, union sockunion *);
852 extern struct peer_group *peer_group_lookup (struct bgp *, const char *);
853 extern struct peer_group *peer_group_get (struct bgp *, const char *);
854 extern struct peer *peer_lookup_with_open (union sockunion *, as_t, struct in_addr *,
855                                     int *);
856
857 /*
858  * Peers are incredibly easy to memory leak
859  * due to the various ways that they are actually used
860  * Provide some functionality to debug locks and unlocks
861  */
862 extern struct peer *peer_lock_with_caller(const char *, struct peer *);
863 extern struct peer *peer_unlock_with_caller(const char *, struct peer *);
864 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
865 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
866
867 extern bgp_peer_sort_t peer_sort (struct peer *peer);
868 extern int peer_active (struct peer *);
869 extern int peer_active_nego (struct peer *);
870 extern struct peer *peer_create_accept (struct bgp *);
871 extern char *peer_uptime (time_t, char *, size_t);
872 extern int bgp_config_write (struct vty *);
873 extern void bgp_config_write_family_header (struct vty *, afi_t, safi_t, int *);
874
875 extern void bgp_master_init (void);
876
877 extern void bgp_init (void);
878 extern void bgp_route_map_init (void);
879
880 extern int bgp_option_set (int);
881 extern int bgp_option_unset (int);
882 extern int bgp_option_check (int);
883
884 extern int bgp_get (struct bgp **, as_t *, const char *);
885 extern int bgp_delete (struct bgp *);
886
887 extern int bgp_flag_set (struct bgp *, int);
888 extern int bgp_flag_unset (struct bgp *, int);
889 extern int bgp_flag_check (struct bgp *, int);
890
891 extern void bgp_lock (struct bgp *);
892 extern void bgp_unlock (struct bgp *);
893
894 extern void bgp_router_id_zebra_bump (void);
895 extern int bgp_router_id_static_set (struct bgp *, struct in_addr);
896
897 extern int bgp_cluster_id_set (struct bgp *, struct in_addr *);
898 extern int bgp_cluster_id_unset (struct bgp *);
899
900 extern int bgp_confederation_id_set (struct bgp *, as_t);
901 extern int bgp_confederation_id_unset (struct bgp *);
902 extern int bgp_confederation_peers_check (struct bgp *, as_t);
903
904 extern int bgp_confederation_peers_add (struct bgp *, as_t);
905 extern int bgp_confederation_peers_remove (struct bgp *, as_t);
906
907 extern int bgp_timers_set (struct bgp *, u_int32_t keepalive, u_int32_t holdtime);
908 extern int bgp_timers_unset (struct bgp *);
909
910 extern int bgp_default_local_preference_set (struct bgp *, u_int32_t);
911 extern int bgp_default_local_preference_unset (struct bgp *);
912
913 extern int peer_rsclient_active (struct peer *);
914
915 extern int peer_remote_as (struct bgp *, union sockunion *, as_t *, afi_t, safi_t);
916 extern int peer_group_remote_as (struct bgp *, const char *, as_t *);
917 extern int peer_ttl (struct peer *peer);
918 extern int peer_delete (struct peer *peer);
919 extern int peer_group_delete (struct peer_group *);
920 extern int peer_group_remote_as_delete (struct peer_group *);
921
922 extern int peer_activate (struct peer *, afi_t, safi_t);
923 extern int peer_deactivate (struct peer *, afi_t, safi_t);
924 extern int peer_afc_set (struct peer *, afi_t, safi_t, int);
925
926 extern int peer_group_bind (struct bgp *, union sockunion *, struct peer_group *,
927                      afi_t, safi_t, as_t *);
928 extern int peer_group_unbind (struct bgp *, struct peer *, struct peer_group *,
929                        afi_t, safi_t);
930
931 extern int peer_flag_set (struct peer *, u_int32_t);
932 extern int peer_flag_unset (struct peer *, u_int32_t);
933
934 extern int peer_af_flag_set (struct peer *, afi_t, safi_t, u_int32_t);
935 extern int peer_af_flag_unset (struct peer *, afi_t, safi_t, u_int32_t);
936 extern int peer_af_flag_check (struct peer *, afi_t, safi_t, u_int32_t);
937
938 extern int peer_ebgp_multihop_set (struct peer *, int);
939
940 extern int peer_description_set (struct peer *, const char *);
941 extern int peer_description_unset (struct peer *);
942
943 extern int peer_update_source_if_set (struct peer *, const char *);
944 extern int peer_update_source_addr_set (struct peer *, const union sockunion *);
945 extern int peer_update_source_unset (struct peer *);
946
947 extern int peer_default_originate_set (struct peer *, afi_t, safi_t, const char *);
948 extern int peer_default_originate_unset (struct peer *, afi_t, safi_t);
949
950 extern int peer_port_set (struct peer *, u_int16_t);
951 extern int peer_port_unset (struct peer *);
952
953 extern int peer_weight_set (struct peer *, u_int16_t);
954 extern int peer_weight_unset (struct peer *);
955
956 extern int peer_timers_set (struct peer *, u_int32_t keepalive, u_int32_t holdtime);
957 extern int peer_timers_unset (struct peer *);
958
959 extern int peer_timers_connect_set (struct peer *, u_int32_t);
960 extern int peer_timers_connect_unset (struct peer *);
961
962 extern int peer_advertise_interval_set (struct peer *, u_int32_t);
963 extern int peer_advertise_interval_unset (struct peer *);
964
965 extern int peer_interface_set (struct peer *, const char *);
966 extern int peer_interface_unset (struct peer *);
967
968 extern int peer_distribute_set (struct peer *, afi_t, safi_t, int, const char *);
969 extern int peer_distribute_unset (struct peer *, afi_t, safi_t, int);
970
971 extern int peer_allowas_in_set (struct peer *, afi_t, safi_t, int);
972 extern int peer_allowas_in_unset (struct peer *, afi_t, safi_t);
973
974 extern int peer_local_as_set (struct peer *, as_t, int, int);
975 extern int peer_local_as_unset (struct peer *);
976
977 extern int peer_prefix_list_set (struct peer *, afi_t, safi_t, int, const char *);
978 extern int peer_prefix_list_unset (struct peer *, afi_t, safi_t, int);
979
980 extern int peer_aslist_set (struct peer *, afi_t, safi_t, int, const char *);
981 extern int peer_aslist_unset (struct peer *,afi_t, safi_t, int);
982
983 extern int peer_route_map_set (struct peer *, afi_t, safi_t, int, const char *);
984 extern int peer_route_map_unset (struct peer *, afi_t, safi_t, int);
985
986 extern int peer_unsuppress_map_set (struct peer *, afi_t, safi_t, const char *);
987
988 extern int peer_password_set (struct peer *, const char *);
989 extern int peer_password_unset (struct peer *);
990
991 extern int peer_unsuppress_map_unset (struct peer *, afi_t, safi_t);
992
993 extern int peer_maximum_prefix_set (struct peer *, afi_t, safi_t, u_int32_t, u_char, int, u_int16_t);
994 extern int peer_maximum_prefix_unset (struct peer *, afi_t, safi_t);
995
996 extern int peer_clear (struct peer *);
997 extern int peer_clear_soft (struct peer *, afi_t, safi_t, enum bgp_clear_type);
998
999 extern int peer_ttl_security_hops_set (struct peer *, int);
1000
1001 extern void bgp_scan_finish (void);
1002 #endif /* _QUAGGA_BGPD_H */