blob: 64a4c1bd0ba57bc1091bb784018d17f410c39b62 [file] [log] [blame]
paul718e3742002-12-13 20:15:29 +00001/* BGP-4 Finite State Machine
2 From RFC1771 [A Border Gateway Protocol 4 (BGP-4)]
3 Copyright (C) 1996, 97, 98 Kunihiro Ishiguro
4
5This file is part of GNU Zebra.
6
7GNU Zebra is free software; you can redistribute it and/or modify it
8under the terms of the GNU General Public License as published by the
9Free Software Foundation; either version 2, or (at your option) any
10later version.
11
12GNU Zebra is distributed in the hope that it will be useful, but
13WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Zebra; see the file COPYING. If not, write to the Free
19Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
2002111-1307, USA. */
21
22#include <zebra.h>
23
24#include "linklist.h"
25#include "prefix.h"
26#include "vty.h"
27#include "sockunion.h"
28#include "thread.h"
29#include "log.h"
30#include "stream.h"
31#include "memory.h"
32#include "plist.h"
33
34#include "bgpd/bgpd.h"
35#include "bgpd/bgp_attr.h"
36#include "bgpd/bgp_debug.h"
37#include "bgpd/bgp_fsm.h"
38#include "bgpd/bgp_packet.h"
39#include "bgpd/bgp_network.h"
40#include "bgpd/bgp_route.h"
41#include "bgpd/bgp_dump.h"
42#include "bgpd/bgp_open.h"
43#ifdef HAVE_SNMP
44#include "bgpd/bgp_snmp.h"
45#endif /* HAVE_SNMP */
46
47/* BGP FSM (finite state machine) has three types of functions. Type
48 one is thread functions. Type two is event functions. Type three
49 is FSM functions. Timer functions are set by bgp_timer_set
50 function. */
51
52/* BGP event function. */
53int bgp_event (struct thread *);
54
55/* BGP thread functions. */
56static int bgp_start_timer (struct thread *);
57static int bgp_connect_timer (struct thread *);
58static int bgp_holdtime_timer (struct thread *);
59static int bgp_keepalive_timer (struct thread *);
60
61/* BGP FSM functions. */
62static int bgp_start (struct peer *);
63
64/* BGP start timer jitter. */
65int
66bgp_start_jitter (int time)
67{
68 return ((rand () % (time + 1)) - (time / 2));
69}
70
71/* Hook function called after bgp event is occered. And vty's
72 neighbor command invoke this function after making neighbor
73 structure. */
74void
75bgp_timer_set (struct peer *peer)
76{
77 int jitter = 0;
78
79 switch (peer->status)
80 {
81 case Idle:
82 /* First entry point of peer's finite state machine. In Idle
83 status start timer is on unless peer is shutdown or peer is
84 inactive. All other timer must be turned off */
85 if (CHECK_FLAG (peer->flags, PEER_FLAG_SHUTDOWN)
86 || CHECK_FLAG (peer->sflags, PEER_STATUS_PREFIX_OVERFLOW)
87 || ! peer_active (peer))
88 {
89 BGP_TIMER_OFF (peer->t_start);
90 }
91 else
92 {
93 jitter = bgp_start_jitter (peer->v_start);
94 BGP_TIMER_ON (peer->t_start, bgp_start_timer,
95 peer->v_start + jitter);
96 }
97 BGP_TIMER_OFF (peer->t_connect);
98 BGP_TIMER_OFF (peer->t_holdtime);
99 BGP_TIMER_OFF (peer->t_keepalive);
100 BGP_TIMER_OFF (peer->t_asorig);
101 BGP_TIMER_OFF (peer->t_routeadv);
102 break;
103
104 case Connect:
105 /* After start timer is expired, the peer moves to Connnect
106 status. Make sure start timer is off and connect timer is
107 on. */
108 BGP_TIMER_OFF (peer->t_start);
109 BGP_TIMER_ON (peer->t_connect, bgp_connect_timer, peer->v_connect);
110 BGP_TIMER_OFF (peer->t_holdtime);
111 BGP_TIMER_OFF (peer->t_keepalive);
112 BGP_TIMER_OFF (peer->t_asorig);
113 BGP_TIMER_OFF (peer->t_routeadv);
114 break;
115
116 case Active:
117 /* Active is waiting connection from remote peer. And if
118 connect timer is expired, change status to Connect. */
119 BGP_TIMER_OFF (peer->t_start);
120 /* If peer is passive mode, do not set connect timer. */
121 if (CHECK_FLAG (peer->flags, PEER_FLAG_PASSIVE))
122 {
123 BGP_TIMER_OFF (peer->t_connect);
124 }
125 else
126 {
127 BGP_TIMER_ON (peer->t_connect, bgp_connect_timer, peer->v_connect);
128 }
129 BGP_TIMER_OFF (peer->t_holdtime);
130 BGP_TIMER_OFF (peer->t_keepalive);
131 BGP_TIMER_OFF (peer->t_asorig);
132 BGP_TIMER_OFF (peer->t_routeadv);
133 break;
134
135 case OpenSent:
136 /* OpenSent status. */
137 BGP_TIMER_OFF (peer->t_start);
138 BGP_TIMER_OFF (peer->t_connect);
139 if (peer->v_holdtime != 0)
140 {
141 BGP_TIMER_ON (peer->t_holdtime, bgp_holdtime_timer,
142 peer->v_holdtime);
143 }
144 else
145 {
146 BGP_TIMER_OFF (peer->t_holdtime);
147 }
148 BGP_TIMER_OFF (peer->t_keepalive);
149 BGP_TIMER_OFF (peer->t_asorig);
150 BGP_TIMER_OFF (peer->t_routeadv);
151 break;
152
153 case OpenConfirm:
154 /* OpenConfirm status. */
155 BGP_TIMER_OFF (peer->t_start);
156 BGP_TIMER_OFF (peer->t_connect);
157
158 /* If the negotiated Hold Time value is zero, then the Hold Time
159 timer and KeepAlive timers are not started. */
160 if (peer->v_holdtime == 0)
161 {
162 BGP_TIMER_OFF (peer->t_holdtime);
163 BGP_TIMER_OFF (peer->t_keepalive);
164 }
165 else
166 {
167 BGP_TIMER_ON (peer->t_holdtime, bgp_holdtime_timer,
168 peer->v_holdtime);
169 BGP_TIMER_ON (peer->t_keepalive, bgp_keepalive_timer,
170 peer->v_keepalive);
171 }
172 BGP_TIMER_OFF (peer->t_asorig);
173 BGP_TIMER_OFF (peer->t_routeadv);
174 break;
175
176 case Established:
177 /* In Established status start and connect timer is turned
178 off. */
179 BGP_TIMER_OFF (peer->t_start);
180 BGP_TIMER_OFF (peer->t_connect);
181
182 /* Same as OpenConfirm, if holdtime is zero then both holdtime
183 and keepalive must be turned off. */
184 if (peer->v_holdtime == 0)
185 {
186 BGP_TIMER_OFF (peer->t_holdtime);
187 BGP_TIMER_OFF (peer->t_keepalive);
188 }
189 else
190 {
191 BGP_TIMER_ON (peer->t_holdtime, bgp_holdtime_timer,
192 peer->v_holdtime);
193 BGP_TIMER_ON (peer->t_keepalive, bgp_keepalive_timer,
194 peer->v_keepalive);
195 }
196 BGP_TIMER_OFF (peer->t_asorig);
197 break;
198 }
199}
200
201/* BGP start timer. This function set BGP_Start event to thread value
202 and process event. */
203static int
204bgp_start_timer (struct thread *thread)
205{
206 struct peer *peer;
207
208 peer = THREAD_ARG (thread);
209 peer->t_start = NULL;
210
211 if (BGP_DEBUG (fsm, FSM))
212 zlog (peer->log, LOG_DEBUG,
213 "%s [FSM] Timer (start timer expire).", peer->host);
214
215 THREAD_VAL (thread) = BGP_Start;
216 bgp_event (thread);
217
218 return 0;
219}
220
221/* BGP connect retry timer. */
222static int
223bgp_connect_timer (struct thread *thread)
224{
225 struct peer *peer;
226
227 peer = THREAD_ARG (thread);
228 peer->t_connect = NULL;
229
230 if (BGP_DEBUG (fsm, FSM))
231 zlog (peer->log, LOG_DEBUG, "%s [FSM] Timer (connect timer expire)",
232 peer->host);
233
234 THREAD_VAL (thread) = ConnectRetry_timer_expired;
235 bgp_event (thread);
236
237 return 0;
238}
239
240/* BGP holdtime timer. */
241static int
242bgp_holdtime_timer (struct thread *thread)
243{
244 struct peer *peer;
245
246 peer = THREAD_ARG (thread);
247 peer->t_holdtime = NULL;
248
249 if (BGP_DEBUG (fsm, FSM))
250 zlog (peer->log, LOG_DEBUG,
251 "%s [FSM] Timer (holdtime timer expire)",
252 peer->host);
253
254 THREAD_VAL (thread) = Hold_Timer_expired;
255 bgp_event (thread);
256
257 return 0;
258}
259
260/* BGP keepalive fire ! */
261static int
262bgp_keepalive_timer (struct thread *thread)
263{
264 struct peer *peer;
265
266 peer = THREAD_ARG (thread);
267 peer->t_keepalive = NULL;
268
269 if (BGP_DEBUG (fsm, FSM))
270 zlog (peer->log, LOG_DEBUG,
271 "%s [FSM] Timer (keepalive timer expire)",
272 peer->host);
273
274 THREAD_VAL (thread) = KeepAlive_timer_expired;
275 bgp_event (thread);
276
277 return 0;
278}
279
280int
281bgp_routeadv_timer (struct thread *thread)
282{
283 struct peer *peer;
284
285 peer = THREAD_ARG (thread);
286 peer->t_routeadv = NULL;
287
288 if (BGP_DEBUG (fsm, FSM))
289 zlog (peer->log, LOG_DEBUG,
290 "%s [FSM] Timer (routeadv timer expire)",
291 peer->host);
292
293 peer->synctime = time (NULL);
294
295 BGP_WRITE_ON (peer->t_write, bgp_write, peer->fd);
296
297 BGP_TIMER_ON (peer->t_routeadv, bgp_routeadv_timer,
298 peer->v_routeadv);
299
300 return 0;
301}
302
303/* Reset bgp update timer */
304static void
305bgp_uptime_reset (struct peer *peer)
306{
307 peer->uptime = time (NULL);
308}
309
310/* Administrative BGP peer stop event. */
311int
312bgp_stop (struct peer *peer)
313{
314 int established = 0;
315 afi_t afi;
316 safi_t safi;
317 char orf_name[BUFSIZ];
318
319 /* Increment Dropped count. */
320 if (peer->status == Established)
321 {
322 established = 1;
323 peer->dropped++;
324 bgp_fsm_change_status (peer, Idle);
325#ifdef HAVE_SNMP
326 bgpTrapBackwardTransition (peer);
327#endif /* HAVE_SNMP */
328 }
329
330 /* Reset uptime. */
331 bgp_uptime_reset (peer);
332
333 /* Need of clear of peer. */
334 if (established)
335 bgp_clear_route_all (peer);
336
337 /* Stop read and write threads when exists. */
338 BGP_READ_OFF (peer->t_read);
339 BGP_WRITE_OFF (peer->t_write);
340
341 /* Stop all timers. */
342 BGP_TIMER_OFF (peer->t_start);
343 BGP_TIMER_OFF (peer->t_connect);
344 BGP_TIMER_OFF (peer->t_holdtime);
345 BGP_TIMER_OFF (peer->t_keepalive);
346 BGP_TIMER_OFF (peer->t_asorig);
347 BGP_TIMER_OFF (peer->t_routeadv);
348
349 /* Delete all existing events of the peer. */
350 BGP_EVENT_DELETE (peer);
351
352 /* Stream reset. */
353 peer->packet_size = 0;
354
355 /* Clear input and output buffer. */
356 if (peer->ibuf)
357 stream_reset (peer->ibuf);
358 if (peer->work)
359 stream_reset (peer->work);
360 stream_fifo_clean (peer->obuf);
361
362 /* Close of file descriptor. */
363 if (peer->fd >= 0)
364 {
365 close (peer->fd);
366 peer->fd = -1;
367 }
368
369 /* Connection information. */
370 if (peer->su_local)
371 {
372 XFREE (MTYPE_SOCKUNION, peer->su_local);
373 peer->su_local = NULL;
374 }
375
376 if (peer->su_remote)
377 {
378 XFREE (MTYPE_SOCKUNION, peer->su_remote);
379 peer->su_remote = NULL;
380 }
381
382 /* Clear remote router-id. */
383 peer->remote_id.s_addr = 0;
384
385 /* Reset all negotiated variables */
386 peer->afc_nego[AFI_IP][SAFI_UNICAST] = 0;
387 peer->afc_nego[AFI_IP][SAFI_MULTICAST] = 0;
388 peer->afc_nego[AFI_IP][SAFI_MPLS_VPN] = 0;
389 peer->afc_nego[AFI_IP6][SAFI_UNICAST] = 0;
390 peer->afc_nego[AFI_IP6][SAFI_MULTICAST] = 0;
391 peer->afc_adv[AFI_IP][SAFI_UNICAST] = 0;
392 peer->afc_adv[AFI_IP][SAFI_MULTICAST] = 0;
393 peer->afc_adv[AFI_IP][SAFI_MPLS_VPN] = 0;
394 peer->afc_adv[AFI_IP6][SAFI_UNICAST] = 0;
395 peer->afc_adv[AFI_IP6][SAFI_MULTICAST] = 0;
396 peer->afc_recv[AFI_IP][SAFI_UNICAST] = 0;
397 peer->afc_recv[AFI_IP][SAFI_MULTICAST] = 0;
398 peer->afc_recv[AFI_IP][SAFI_MPLS_VPN] = 0;
399 peer->afc_recv[AFI_IP6][SAFI_UNICAST] = 0;
400 peer->afc_recv[AFI_IP6][SAFI_MULTICAST] = 0;
401
402 /* Reset route refresh flag. */
403 UNSET_FLAG (peer->cap, PEER_CAP_REFRESH_ADV);
404 UNSET_FLAG (peer->cap, PEER_CAP_REFRESH_OLD_RCV);
405 UNSET_FLAG (peer->cap, PEER_CAP_REFRESH_NEW_RCV);
406 UNSET_FLAG (peer->cap, PEER_CAP_DYNAMIC_ADV);
407 UNSET_FLAG (peer->cap, PEER_CAP_DYNAMIC_RCV);
408
409 for (afi = AFI_IP ; afi < AFI_MAX ; afi++)
410 for (safi = SAFI_UNICAST ; safi < SAFI_MAX ; safi++)
411 {
412 /* peer address family capability flags*/
413 peer->af_cap[afi][safi] = 0;
414 /* peer address family status flags*/
415 peer->af_sflags[afi][safi] = 0;
416 /* Received ORF prefix-filter */
417 peer->orf_plist[afi][safi] = NULL;
418 /* ORF received prefix-filter pnt */
419 sprintf (orf_name, "%s.%d.%d", peer->host, afi, safi);
420 prefix_bgp_orf_remove_all (orf_name);
421 }
422
423 /* Reset keepalive and holdtime */
424 if (CHECK_FLAG (peer->config, PEER_CONFIG_TIMER))
425 {
426 peer->v_keepalive = peer->keepalive;
427 peer->v_holdtime = peer->holdtime;
428 }
429 else
430 {
431 peer->v_keepalive = peer->bgp->default_keepalive;
432 peer->v_holdtime = peer->bgp->default_holdtime;
433 }
434
435 peer->update_time = 0;
436
437 /* Until we are sure that there is no problem about prefix count
438 this should be commented out.*/
439#if 0
440 /* Reset prefix count */
441 peer->pcount[AFI_IP][SAFI_UNICAST] = 0;
442 peer->pcount[AFI_IP][SAFI_MULTICAST] = 0;
443 peer->pcount[AFI_IP][SAFI_MPLS_VPN] = 0;
444 peer->pcount[AFI_IP6][SAFI_UNICAST] = 0;
445 peer->pcount[AFI_IP6][SAFI_MULTICAST] = 0;
446#endif /* 0 */
447
448 return 0;
449}
450
451/* BGP peer is stoped by the error. */
452int
453bgp_stop_with_error (struct peer *peer)
454{
455 /* Double start timer. */
456 peer->v_start *= 2;
457
458 /* Overflow check. */
459 if (peer->v_start >= (60 * 2))
460 peer->v_start = (60 * 2);
461
462 bgp_stop (peer);
463
464 return 0;
465}
466
467/* TCP connection open. Next we send open message to remote peer. And
468 add read thread for reading open message. */
469int
470bgp_connect_success (struct peer *peer)
471{
472 if (peer->fd < 0)
473 {
474 zlog_err ("bgp_connect_success peer's fd is negative value %d",
475 peer->fd);
476 return -1;
477 }
478 BGP_READ_ON (peer->t_read, bgp_read, peer->fd);
479
480 /* bgp_getsockname (peer); */
481
482 if (! CHECK_FLAG (peer->sflags, PEER_STATUS_ACCEPT_PEER))
483 bgp_open_send (peer);
484
485 return 0;
486}
487
488/* TCP connect fail */
489int
490bgp_connect_fail (struct peer *peer)
491{
492 bgp_stop (peer);
493 return 0;
494}
495
496/* This function is the first starting point of all BGP connection. It
497 try to connect to remote peer with non-blocking IO. */
498int
499bgp_start (struct peer *peer)
500{
501 int status;
502
503 /* If the peer is passive mode, force to move to Active mode. */
504 if (CHECK_FLAG (peer->flags, PEER_FLAG_PASSIVE))
505 {
506 BGP_EVENT_ADD (peer, TCP_connection_open_failed);
507 return 0;
508 }
509
510 status = bgp_connect (peer);
511
512 switch (status)
513 {
514 case connect_error:
515 if (BGP_DEBUG (fsm, FSM))
516 plog_info (peer->log, "%s [FSM] Connect error", peer->host);
517 BGP_EVENT_ADD (peer, TCP_connection_open_failed);
518 break;
519 case connect_success:
520 if (BGP_DEBUG (fsm, FSM))
521 plog_info (peer->log, "%s [FSM] Connect immediately success",
522 peer->host);
523 BGP_EVENT_ADD (peer, TCP_connection_open);
524 break;
525 case connect_in_progress:
526 /* To check nonblocking connect, we wait until socket is
527 readable or writable. */
528 if (BGP_DEBUG (fsm, FSM))
529 plog_info (peer->log, "%s [FSM] Non blocking connect waiting result",
530 peer->host);
531 if (peer->fd < 0)
532 {
533 zlog_err ("bgp_start peer's fd is negative value %d",
534 peer->fd);
535 return -1;
536 }
537 BGP_READ_ON (peer->t_read, bgp_read, peer->fd);
538 BGP_WRITE_ON (peer->t_write, bgp_write, peer->fd);
539 break;
540 }
541 return 0;
542}
543
544/* Connect retry timer is expired when the peer status is Connect. */
545int
546bgp_reconnect (struct peer *peer)
547{
548 bgp_stop (peer);
549 bgp_start (peer);
550 return 0;
551}
552
553int
554bgp_fsm_open (struct peer *peer)
555{
556 /* Send keepalive and make keepalive timer */
557 bgp_keepalive_send (peer);
558
559 /* Reset holdtimer value. */
560 BGP_TIMER_OFF (peer->t_holdtime);
561
562 return 0;
563}
564
565/* Called after event occured, this function change status and reset
566 read/write and timer thread. */
567void
568bgp_fsm_change_status (struct peer *peer, int status)
569{
570 bgp_dump_state (peer, peer->status, status);
571
572 /* Preserve old status and change into new status. */
573 peer->ostatus = peer->status;
574 peer->status = status;
575}
576
577/* Keepalive send to peer. */
578int
579bgp_fsm_keepalive_expire (struct peer *peer)
580{
581 bgp_keepalive_send (peer);
582 return 0;
583}
584
585/* Hold timer expire. This is error of BGP connection. So cut the
586 peer and change to Idle status. */
587int
588bgp_fsm_holdtime_expire (struct peer *peer)
589{
590 if (BGP_DEBUG (fsm, FSM))
591 zlog (peer->log, LOG_DEBUG, "%s [FSM] Hold timer expire", peer->host);
592
593 /* Send notify to remote peer. */
594 bgp_notify_send (peer, BGP_NOTIFY_HOLD_ERR, 0);
595
596 /* Sweep if it is temporary peer. */
597 if (CHECK_FLAG (peer->sflags, PEER_STATUS_ACCEPT_PEER))
598 {
599 zlog_info ("%s [Event] Accepting BGP peer is deleted", peer->host);
600 peer_delete (peer);
601 return -1;
602 }
603
604 return 0;
605}
606
607/* Status goes to Established. Send keepalive packet then make first
608 update information. */
609int
610bgp_establish (struct peer *peer)
611{
612 struct bgp_notify *notify;
613 afi_t afi;
614 safi_t safi;
615
616 /* Reset capability open status flag. */
617 if (! CHECK_FLAG (peer->sflags, PEER_STATUS_CAPABILITY_OPEN))
618 SET_FLAG (peer->sflags, PEER_STATUS_CAPABILITY_OPEN);
619
620 /* Clear last notification data. */
621 notify = &peer->notify;
622 if (notify->data)
623 XFREE (MTYPE_TMP, notify->data);
624 memset (notify, 0, sizeof (struct bgp_notify));
625
626 /* Clear start timer value to default. */
627 peer->v_start = BGP_INIT_START_TIMER;
628
629 /* Increment established count. */
630 peer->established++;
631 bgp_fsm_change_status (peer, Established);
632#ifdef HAVE_SNMP
633 bgpTrapEstablished (peer);
634#endif /* HAVE_SNMP */
635
636 /* Reset uptime, send keepalive, send current table. */
637 bgp_uptime_reset (peer);
638
639 /* Send route-refresh when ORF is enabled */
640 for (afi = AFI_IP ; afi < AFI_MAX ; afi++)
641 for (safi = SAFI_UNICAST ; safi < SAFI_MAX ; safi++)
642 if (CHECK_FLAG (peer->af_cap[afi][safi], PEER_CAP_ORF_PREFIX_SM_ADV))
643 {
644 if (CHECK_FLAG (peer->af_cap[afi][safi], PEER_CAP_ORF_PREFIX_RM_RCV))
645 bgp_route_refresh_send (peer, afi, safi, ORF_TYPE_PREFIX,
646 REFRESH_IMMEDIATE, 0);
647 else if (CHECK_FLAG (peer->af_cap[afi][safi], PEER_CAP_ORF_PREFIX_RM_OLD_RCV))
648 bgp_route_refresh_send (peer, afi, safi, ORF_TYPE_PREFIX_OLD,
649 REFRESH_IMMEDIATE, 0);
650 }
651
652 if (peer->v_keepalive)
653 bgp_keepalive_send (peer);
654
655 /* First update is deferred until ORF or ROUTE-REFRESH is received */
656 for (afi = AFI_IP ; afi < AFI_MAX ; afi++)
657 for (safi = SAFI_UNICAST ; safi < SAFI_MAX ; safi++)
658 if (CHECK_FLAG (peer->af_cap[afi][safi], PEER_CAP_ORF_PREFIX_RM_ADV))
659 if (CHECK_FLAG (peer->af_cap[afi][safi], PEER_CAP_ORF_PREFIX_SM_RCV)
660 || CHECK_FLAG (peer->af_cap[afi][safi], PEER_CAP_ORF_PREFIX_SM_OLD_RCV))
661 SET_FLAG (peer->af_sflags[afi][safi], PEER_STATUS_ORF_WAIT_REFRESH);
662
663 bgp_announce_route_all (peer);
664
665 BGP_TIMER_ON (peer->t_routeadv, bgp_routeadv_timer, 1);
666
667 return 0;
668}
669
670/* Keepalive packet is received. */
671int
672bgp_fsm_keepalive (struct peer *peer)
673{
674 /* peer count update */
675 peer->keepalive_in++;
676
677 BGP_TIMER_OFF (peer->t_holdtime);
678 return 0;
679}
680
681/* Update packet is received. */
682int
683bgp_fsm_update (struct peer *peer)
684{
685 BGP_TIMER_OFF (peer->t_holdtime);
686 return 0;
687}
688
689/* This is empty event. */
690int
691bgp_ignore (struct peer *peer)
692{
693 if (BGP_DEBUG (fsm, FSM))
694 zlog (peer->log, LOG_DEBUG, "%s [FSM] bgp_ignore called", peer->host);
695 return 0;
696}
697
698/* Finite State Machine structure */
699struct {
700 int (*func) ();
701 int next_state;
702} FSM [BGP_STATUS_MAX - 1][BGP_EVENTS_MAX - 1] =
703{
704 {
705 /* Idle state: In Idle state, all events other than BGP_Start is
706 ignored. With BGP_Start event, finite state machine calls
707 bgp_start(). */
708 {bgp_start, Connect}, /* BGP_Start */
709 {bgp_stop, Idle}, /* BGP_Stop */
710 {bgp_stop, Idle}, /* TCP_connection_open */
711 {bgp_stop, Idle}, /* TCP_connection_closed */
712 {bgp_ignore, Idle}, /* TCP_connection_open_failed */
713 {bgp_stop, Idle}, /* TCP_fatal_error */
714 {bgp_ignore, Idle}, /* ConnectRetry_timer_expired */
715 {bgp_ignore, Idle}, /* Hold_Timer_expired */
716 {bgp_ignore, Idle}, /* KeepAlive_timer_expired */
717 {bgp_ignore, Idle}, /* Receive_OPEN_message */
718 {bgp_ignore, Idle}, /* Receive_KEEPALIVE_message */
719 {bgp_ignore, Idle}, /* Receive_UPDATE_message */
720 {bgp_ignore, Idle}, /* Receive_NOTIFICATION_message */
721 },
722 {
723 /* Connect */
724 {bgp_ignore, Connect}, /* BGP_Start */
725 {bgp_stop, Idle}, /* BGP_Stop */
726 {bgp_connect_success, OpenSent}, /* TCP_connection_open */
727 {bgp_stop, Idle}, /* TCP_connection_closed */
728 {bgp_connect_fail, Active}, /* TCP_connection_open_failed */
729 {bgp_connect_fail, Idle}, /* TCP_fatal_error */
730 {bgp_reconnect, Connect}, /* ConnectRetry_timer_expired */
731 {bgp_ignore, Idle}, /* Hold_Timer_expired */
732 {bgp_ignore, Idle}, /* KeepAlive_timer_expired */
733 {bgp_ignore, Idle}, /* Receive_OPEN_message */
734 {bgp_ignore, Idle}, /* Receive_KEEPALIVE_message */
735 {bgp_ignore, Idle}, /* Receive_UPDATE_message */
736 {bgp_stop, Idle}, /* Receive_NOTIFICATION_message */
737 },
738 {
739 /* Active, */
740 {bgp_ignore, Active}, /* BGP_Start */
741 {bgp_stop, Idle}, /* BGP_Stop */
742 {bgp_connect_success, OpenSent}, /* TCP_connection_open */
743 {bgp_stop, Idle}, /* TCP_connection_closed */
744 {bgp_ignore, Active}, /* TCP_connection_open_failed */
745 {bgp_ignore, Idle}, /* TCP_fatal_error */
746 {bgp_start, Connect}, /* ConnectRetry_timer_expired */
747 {bgp_ignore, Idle}, /* Hold_Timer_expired */
748 {bgp_ignore, Idle}, /* KeepAlive_timer_expired */
749 {bgp_ignore, Idle}, /* Receive_OPEN_message */
750 {bgp_ignore, Idle}, /* Receive_KEEPALIVE_message */
751 {bgp_ignore, Idle}, /* Receive_UPDATE_message */
752 {bgp_stop_with_error, Idle}, /* Receive_NOTIFICATION_message */
753 },
754 {
755 /* OpenSent, */
756 {bgp_ignore, OpenSent}, /* BGP_Start */
757 {bgp_stop, Idle}, /* BGP_Stop */
758 {bgp_stop, Idle}, /* TCP_connection_open */
759 {bgp_stop, Active}, /* TCP_connection_closed */
760 {bgp_ignore, Idle}, /* TCP_connection_open_failed */
761 {bgp_stop, Idle}, /* TCP_fatal_error */
762 {bgp_ignore, Idle}, /* ConnectRetry_timer_expired */
763 {bgp_fsm_holdtime_expire, Idle}, /* Hold_Timer_expired */
764 {bgp_ignore, Idle}, /* KeepAlive_timer_expired */
765 {bgp_fsm_open, OpenConfirm}, /* Receive_OPEN_message */
766 {bgp_ignore, Idle}, /* Receive_KEEPALIVE_message */
767 {bgp_ignore, Idle}, /* Receive_UPDATE_message */
768 {bgp_stop_with_error, Idle}, /* Receive_NOTIFICATION_message */
769 },
770 {
771 /* OpenConfirm, */
772 {bgp_ignore, OpenConfirm}, /* BGP_Start */
773 {bgp_stop, Idle}, /* BGP_Stop */
774 {bgp_stop, Idle}, /* TCP_connection_open */
775 {bgp_stop, Idle}, /* TCP_connection_closed */
776 {bgp_stop, Idle}, /* TCP_connection_open_failed */
777 {bgp_stop, Idle}, /* TCP_fatal_error */
778 {bgp_ignore, Idle}, /* ConnectRetry_timer_expired */
779 {bgp_fsm_holdtime_expire, Idle}, /* Hold_Timer_expired */
780 {bgp_ignore, OpenConfirm}, /* KeepAlive_timer_expired */
781 {bgp_ignore, Idle}, /* Receive_OPEN_message */
782 {bgp_establish, Established}, /* Receive_KEEPALIVE_message */
783 {bgp_ignore, Idle}, /* Receive_UPDATE_message */
784 {bgp_stop_with_error, Idle}, /* Receive_NOTIFICATION_message */
785 },
786 {
787 /* Established, */
788 {bgp_ignore, Established}, /* BGP_Start */
789 {bgp_stop, Idle}, /* BGP_Stop */
790 {bgp_stop, Idle}, /* TCP_connection_open */
791 {bgp_stop, Idle}, /* TCP_connection_closed */
792 {bgp_ignore, Idle}, /* TCP_connection_open_failed */
793 {bgp_stop, Idle}, /* TCP_fatal_error */
794 {bgp_ignore, Idle}, /* ConnectRetry_timer_expired */
795 {bgp_fsm_holdtime_expire, Idle}, /* Hold_Timer_expired */
796 {bgp_fsm_keepalive_expire, Established}, /* KeepAlive_timer_expired */
797 {bgp_stop, Idle}, /* Receive_OPEN_message */
798 {bgp_fsm_keepalive, Established}, /* Receive_KEEPALIVE_message */
799 {bgp_fsm_update, Established}, /* Receive_UPDATE_message */
800 {bgp_stop_with_error, Idle}, /* Receive_NOTIFICATION_message */
801 },
802};
803
804static char *bgp_event_str[] =
805{
806 NULL,
807 "BGP_Start",
808 "BGP_Stop",
809 "TCP_connection_open",
810 "TCP_connection_closed",
811 "TCP_connection_open_failed",
812 "TCP_fatal_error",
813 "ConnectRetry_timer_expired",
814 "Hold_Timer_expired",
815 "KeepAlive_timer_expired",
816 "Receive_OPEN_message",
817 "Receive_KEEPALIVE_message",
818 "Receive_UPDATE_message",
819 "Receive_NOTIFICATION_message"
820};
821
822/* Execute event process. */
823int
824bgp_event (struct thread *thread)
825{
826 int ret;
827 int event;
828 int next;
829 struct peer *peer;
830
831 peer = THREAD_ARG (thread);
832 event = THREAD_VAL (thread);
833
834 /* Logging this event. */
835 next = FSM [peer->status -1][event - 1].next_state;
836
837 if (BGP_DEBUG (fsm, FSM))
838 plog_info (peer->log, "%s [FSM] %s (%s->%s)", peer->host,
839 bgp_event_str[event],
840 LOOKUP (bgp_status_msg, peer->status),
841 LOOKUP (bgp_status_msg, next));
842 if (BGP_DEBUG (normal, NORMAL)
843 && strcmp (LOOKUP (bgp_status_msg, peer->status), LOOKUP (bgp_status_msg, next)))
844 zlog_info ("%s went from %s to %s",
845 peer->host,
846 LOOKUP (bgp_status_msg, peer->status),
847 LOOKUP (bgp_status_msg, next));
848
849 /* Call function. */
850 ret = (*(FSM [peer->status - 1][event - 1].func))(peer);
851
852 /* When function do not want proceed next job return -1. */
853 if (ret < 0)
854 return ret;
855
856 /* If status is changed. */
857 if (next != peer->status)
858 bgp_fsm_change_status (peer, next);
859
860 /* Make sure timer is set. */
861 bgp_timer_set (peer);
862
863 return 0;
864}