2 * Main implementation file for interface to Forwarding Plane Manager.
4 * Copyright (C) 2012 by Open Source Routing.
5 * Copyright (C) 2012 by Internet Systems Consortium, Inc. ("ISC")
7 * This file is part of GNU Zebra.
9 * GNU Zebra is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2, or (at your option) any
14 * GNU Zebra is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; see the file COPYING; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
32 #include "lib/version.h"
35 #include "zebra/rib.h"
36 #include "zebra/zserv.h"
37 #include "zebra/zebra_ns.h"
38 #include "zebra/zebra_vrf.h"
39 #include "zebra/zebra_errors.h"
42 #include "zebra_fpm_private.h"
43 #include "zebra/zebra_router.h"
44 #include "zebra_vxlan_private.h"
46 DEFINE_MTYPE_STATIC(ZEBRA
, FPM_MAC_INFO
, "FPM_MAC_INFO");
49 * Interval at which we attempt to connect to the FPM.
51 #define ZFPM_CONNECT_RETRY_IVL 5
54 * Sizes of outgoing and incoming stream buffers for writing/reading
57 #define ZFPM_OBUF_SIZE (2 * FPM_MAX_MSG_LEN)
58 #define ZFPM_IBUF_SIZE (FPM_MAX_MSG_LEN)
61 * The maximum number of times the FPM socket write callback can call
62 * 'write' before it yields.
64 #define ZFPM_MAX_WRITES_PER_RUN 10
67 * Interval over which we collect statistics.
69 #define ZFPM_STATS_IVL_SECS 10
70 #define FPM_MAX_MAC_MSG_LEN 512
72 static void zfpm_iterate_rmac_table(struct hash_bucket
*bucket
, void *args
);
75 * Structure that holds state for iterating over all route_node
76 * structures that are candidates for being communicated to the FPM.
78 struct zfpm_rnodes_iter
{
79 rib_tables_iter_t tables_iter
;
80 route_table_iter_t iter
;
87 unsigned long connect_calls
;
88 unsigned long connect_no_sock
;
90 unsigned long read_cb_calls
;
92 unsigned long write_cb_calls
;
93 unsigned long write_calls
;
94 unsigned long partial_writes
;
95 unsigned long max_writes_hit
;
96 unsigned long t_write_yields
;
98 unsigned long nop_deletes_skipped
;
99 unsigned long route_adds
;
100 unsigned long route_dels
;
102 unsigned long updates_triggered
;
103 unsigned long redundant_triggers
;
105 unsigned long dests_del_after_update
;
107 unsigned long t_conn_down_starts
;
108 unsigned long t_conn_down_dests_processed
;
109 unsigned long t_conn_down_yields
;
110 unsigned long t_conn_down_finishes
;
112 unsigned long t_conn_up_starts
;
113 unsigned long t_conn_up_dests_processed
;
114 unsigned long t_conn_up_yields
;
115 unsigned long t_conn_up_aborts
;
116 unsigned long t_conn_up_finishes
;
120 * States for the FPM state machine.
125 * In this state we are not yet ready to connect to the FPM. This
126 * can happen when this module is disabled, or if we're cleaning up
127 * after a connection has gone down.
132 * Ready to talk to the FPM and periodically trying to connect to
138 * In the middle of bringing up a TCP connection. Specifically,
139 * waiting for a connect() call to complete asynchronously.
141 ZFPM_STATE_CONNECTING
,
144 * TCP connection to the FPM is up.
146 ZFPM_STATE_ESTABLISHED
151 * Message format to be used to communicate with the FPM.
153 enum zfpm_msg_format
{
154 ZFPM_MSG_FORMAT_NONE
,
155 ZFPM_MSG_FORMAT_NETLINK
,
156 ZFPM_MSG_FORMAT_PROTOBUF
,
165 * True if the FPM module has been enabled.
170 * Message format to be used to communicate with the fpm.
172 enum zfpm_msg_format message_format
;
174 struct thread_master
*master
;
176 enum zfpm_state state
;
178 in_addr_t fpm_server
;
180 * Port on which the FPM is running.
185 * List of rib_dest_t structures to be processed
187 TAILQ_HEAD(zfpm_dest_q
, rib_dest_t_
) dest_q
;
190 * List of fpm_mac_info structures to be processed
192 TAILQ_HEAD(zfpm_mac_q
, fpm_mac_info_t
) mac_q
;
195 * Hash table of fpm_mac_info_t entries
197 * While adding fpm_mac_info_t for a MAC to the mac_q,
198 * it is possible that another fpm_mac_info_t node for the this MAC
199 * is already present in the queue.
200 * This is possible in the case of consecutive add->delete operations.
201 * To avoid such duplicate insertions in the mac_q,
202 * define a hash table for fpm_mac_info_t which can be looked up
203 * to see if an fpm_mac_info_t node for a MAC is already present
206 struct hash
*fpm_mac_info_table
;
209 * Stream socket to the FPM.
214 * Buffers for messages to/from the FPM.
222 struct thread
*t_connect
;
223 struct thread
*t_write
;
224 struct thread
*t_read
;
227 * Thread to clean up after the TCP connection to the FPM goes down
228 * and the state that belongs to it.
230 struct thread
*t_conn_down
;
233 struct zfpm_rnodes_iter iter
;
237 * Thread to take actions once the TCP conn to the FPM comes up, and
238 * the state that belongs to it.
240 struct thread
*t_conn_up
;
243 struct zfpm_rnodes_iter iter
;
246 unsigned long connect_calls
;
247 time_t last_connect_call_time
;
250 * Stats from the start of the current statistics interval up to
251 * now. These are the counters we typically update in the code.
253 struct zfpm_stats stats
;
256 * Statistics that were gathered in the last collection interval.
258 struct zfpm_stats last_ivl_stats
;
261 * Cumulative stats from the last clear to the start of the current
262 * statistics interval.
264 struct zfpm_stats cumulative_stats
;
267 * Stats interval timer.
269 struct thread
*t_stats
;
272 * If non-zero, the last time when statistics were cleared.
274 time_t last_stats_clear_time
;
277 * Flag to track the MAC dump status to FPM
279 bool fpm_mac_dump_done
;
282 static struct zfpm_glob zfpm_glob_space
;
283 static struct zfpm_glob
*zfpm_g
= &zfpm_glob_space
;
285 static int zfpm_trigger_update(struct route_node
*rn
, const char *reason
);
287 static int zfpm_read_cb(struct thread
*thread
);
288 static int zfpm_write_cb(struct thread
*thread
);
290 static void zfpm_set_state(enum zfpm_state state
, const char *reason
);
291 static void zfpm_start_connect_timer(const char *reason
);
292 static void zfpm_start_stats_timer(void);
293 static void zfpm_mac_info_del(struct fpm_mac_info_t
*fpm_mac
);
296 * zfpm_thread_should_yield
298 static inline int zfpm_thread_should_yield(struct thread
*t
)
300 return thread_should_yield(t
);
306 static const char *zfpm_state_to_str(enum zfpm_state state
)
310 case ZFPM_STATE_IDLE
:
313 case ZFPM_STATE_ACTIVE
:
316 case ZFPM_STATE_CONNECTING
:
319 case ZFPM_STATE_ESTABLISHED
:
320 return "established";
328 * zfpm_get_elapsed_time
330 * Returns the time elapsed (in seconds) since the given time.
332 static time_t zfpm_get_elapsed_time(time_t reference
)
336 now
= monotime(NULL
);
338 if (now
< reference
) {
343 return now
- reference
;
347 * zfpm_rnodes_iter_init
349 static inline void zfpm_rnodes_iter_init(struct zfpm_rnodes_iter
*iter
)
351 memset(iter
, 0, sizeof(*iter
));
352 rib_tables_iter_init(&iter
->tables_iter
);
355 * This is a hack, but it makes implementing 'next' easier by
356 * ensuring that route_table_iter_next() will return NULL the first
359 route_table_iter_init(&iter
->iter
, NULL
);
360 route_table_iter_cleanup(&iter
->iter
);
364 * zfpm_rnodes_iter_next
366 static inline struct route_node
*
367 zfpm_rnodes_iter_next(struct zfpm_rnodes_iter
*iter
)
369 struct route_node
*rn
;
370 struct route_table
*table
;
373 rn
= route_table_iter_next(&iter
->iter
);
378 * We've made our way through this table, go to the next one.
380 route_table_iter_cleanup(&iter
->iter
);
382 table
= rib_tables_iter_next(&iter
->tables_iter
);
387 route_table_iter_init(&iter
->iter
, table
);
394 * zfpm_rnodes_iter_pause
396 static inline void zfpm_rnodes_iter_pause(struct zfpm_rnodes_iter
*iter
)
398 route_table_iter_pause(&iter
->iter
);
402 * zfpm_rnodes_iter_cleanup
404 static inline void zfpm_rnodes_iter_cleanup(struct zfpm_rnodes_iter
*iter
)
406 route_table_iter_cleanup(&iter
->iter
);
407 rib_tables_iter_cleanup(&iter
->tables_iter
);
413 * Initialize a statistics block.
415 static inline void zfpm_stats_init(struct zfpm_stats
*stats
)
417 memset(stats
, 0, sizeof(*stats
));
423 static inline void zfpm_stats_reset(struct zfpm_stats
*stats
)
425 zfpm_stats_init(stats
);
431 static inline void zfpm_stats_copy(const struct zfpm_stats
*src
,
432 struct zfpm_stats
*dest
)
434 memcpy(dest
, src
, sizeof(*dest
));
440 * Total up the statistics in two stats structures ('s1 and 's2') and
441 * return the result in the third argument, 'result'. Note that the
442 * pointer 'result' may be the same as 's1' or 's2'.
444 * For simplicity, the implementation below assumes that the stats
445 * structure is composed entirely of counters. This can easily be
446 * changed when necessary.
448 static void zfpm_stats_compose(const struct zfpm_stats
*s1
,
449 const struct zfpm_stats
*s2
,
450 struct zfpm_stats
*result
)
452 const unsigned long *p1
, *p2
;
453 unsigned long *result_p
;
456 p1
= (const unsigned long *)s1
;
457 p2
= (const unsigned long *)s2
;
458 result_p
= (unsigned long *)result
;
460 num_counters
= (sizeof(struct zfpm_stats
) / sizeof(unsigned long));
462 for (i
= 0; i
< num_counters
; i
++) {
463 result_p
[i
] = p1
[i
] + p2
[i
];
470 static inline void zfpm_read_on(void)
472 assert(!zfpm_g
->t_read
);
473 assert(zfpm_g
->sock
>= 0);
475 thread_add_read(zfpm_g
->master
, zfpm_read_cb
, 0, zfpm_g
->sock
,
482 static inline void zfpm_write_on(void)
484 assert(!zfpm_g
->t_write
);
485 assert(zfpm_g
->sock
>= 0);
487 thread_add_write(zfpm_g
->master
, zfpm_write_cb
, 0, zfpm_g
->sock
,
494 static inline void zfpm_read_off(void)
496 thread_cancel(&zfpm_g
->t_read
);
502 static inline void zfpm_write_off(void)
504 thread_cancel(&zfpm_g
->t_write
);
507 static inline void zfpm_connect_off(void)
509 thread_cancel(&zfpm_g
->t_connect
);
513 * zfpm_conn_up_thread_cb
515 * Callback for actions to be taken when the connection to the FPM
518 static int zfpm_conn_up_thread_cb(struct thread
*thread
)
520 struct route_node
*rnode
;
521 struct zfpm_rnodes_iter
*iter
;
524 iter
= &zfpm_g
->t_conn_up_state
.iter
;
526 if (zfpm_g
->state
!= ZFPM_STATE_ESTABLISHED
) {
528 "Connection not up anymore, conn_up thread aborting");
529 zfpm_g
->stats
.t_conn_up_aborts
++;
533 if (!zfpm_g
->fpm_mac_dump_done
) {
534 /* Enqueue FPM updates for all the RMAC entries */
535 hash_iterate(zrouter
.l3vni_table
, zfpm_iterate_rmac_table
,
537 /* mark dump done so that its not repeated after yield */
538 zfpm_g
->fpm_mac_dump_done
= true;
541 while ((rnode
= zfpm_rnodes_iter_next(iter
))) {
542 dest
= rib_dest_from_rnode(rnode
);
545 zfpm_g
->stats
.t_conn_up_dests_processed
++;
546 zfpm_trigger_update(rnode
, NULL
);
552 if (!zfpm_thread_should_yield(thread
))
555 zfpm_g
->stats
.t_conn_up_yields
++;
556 zfpm_rnodes_iter_pause(iter
);
557 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_up_thread_cb
,
558 NULL
, 0, &zfpm_g
->t_conn_up
);
562 zfpm_g
->stats
.t_conn_up_finishes
++;
565 zfpm_rnodes_iter_cleanup(iter
);
572 * Called when the connection to the FPM comes up.
574 static void zfpm_connection_up(const char *detail
)
576 assert(zfpm_g
->sock
>= 0);
579 zfpm_set_state(ZFPM_STATE_ESTABLISHED
, detail
);
582 * Start thread to push existing routes to the FPM.
584 thread_cancel(&zfpm_g
->t_conn_up
);
586 zfpm_rnodes_iter_init(&zfpm_g
->t_conn_up_state
.iter
);
587 zfpm_g
->fpm_mac_dump_done
= false;
589 zfpm_debug("Starting conn_up thread");
591 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_up_thread_cb
, NULL
, 0,
593 zfpm_g
->stats
.t_conn_up_starts
++;
599 * Check if an asynchronous connect() to the FPM is complete.
601 static void zfpm_connect_check(void)
610 slen
= sizeof(status
);
611 ret
= getsockopt(zfpm_g
->sock
, SOL_SOCKET
, SO_ERROR
, (void *)&status
,
614 if (ret
>= 0 && status
== 0) {
615 zfpm_connection_up("async connect complete");
620 * getsockopt() failed or indicated an error on the socket.
625 zfpm_start_connect_timer("getsockopt() after async connect failed");
630 * zfpm_conn_down_thread_cb
632 * Callback that is invoked to clean up state after the TCP connection
633 * to the FPM goes down.
635 static int zfpm_conn_down_thread_cb(struct thread
*thread
)
637 struct route_node
*rnode
;
638 struct zfpm_rnodes_iter
*iter
;
640 struct fpm_mac_info_t
*mac
= NULL
;
642 assert(zfpm_g
->state
== ZFPM_STATE_IDLE
);
645 * Delink and free all fpm_mac_info_t nodes
646 * in the mac_q and fpm_mac_info_hash
648 while ((mac
= TAILQ_FIRST(&zfpm_g
->mac_q
)) != NULL
)
649 zfpm_mac_info_del(mac
);
651 zfpm_g
->t_conn_down
= NULL
;
653 iter
= &zfpm_g
->t_conn_down_state
.iter
;
655 while ((rnode
= zfpm_rnodes_iter_next(iter
))) {
656 dest
= rib_dest_from_rnode(rnode
);
659 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)) {
660 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
,
664 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
665 UNSET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
667 zfpm_g
->stats
.t_conn_down_dests_processed
++;
670 * Check if the dest should be deleted.
678 if (!zfpm_thread_should_yield(thread
))
681 zfpm_g
->stats
.t_conn_down_yields
++;
682 zfpm_rnodes_iter_pause(iter
);
683 zfpm_g
->t_conn_down
= NULL
;
684 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_down_thread_cb
,
685 NULL
, 0, &zfpm_g
->t_conn_down
);
689 zfpm_g
->stats
.t_conn_down_finishes
++;
690 zfpm_rnodes_iter_cleanup(iter
);
693 * Start the process of connecting to the FPM again.
695 zfpm_start_connect_timer("cleanup complete");
700 * zfpm_connection_down
702 * Called when the connection to the FPM has gone down.
704 static void zfpm_connection_down(const char *detail
)
709 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
711 zlog_info("connection to the FPM has gone down: %s", detail
);
716 stream_reset(zfpm_g
->ibuf
);
717 stream_reset(zfpm_g
->obuf
);
719 if (zfpm_g
->sock
>= 0) {
725 * Start thread to clean up state after the connection goes down.
727 assert(!zfpm_g
->t_conn_down
);
728 zfpm_rnodes_iter_init(&zfpm_g
->t_conn_down_state
.iter
);
729 zfpm_g
->t_conn_down
= NULL
;
730 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_down_thread_cb
, NULL
, 0,
731 &zfpm_g
->t_conn_down
);
732 zfpm_g
->stats
.t_conn_down_starts
++;
734 zfpm_set_state(ZFPM_STATE_IDLE
, detail
);
740 static int zfpm_read_cb(struct thread
*thread
)
747 zfpm_g
->stats
.read_cb_calls
++;
750 * Check if async connect is now done.
752 if (zfpm_g
->state
== ZFPM_STATE_CONNECTING
) {
753 zfpm_connect_check();
757 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
758 assert(zfpm_g
->sock
>= 0);
762 already
= stream_get_endp(ibuf
);
763 if (already
< FPM_MSG_HDR_LEN
) {
766 nbyte
= stream_read_try(ibuf
, zfpm_g
->sock
,
767 FPM_MSG_HDR_LEN
- already
);
768 if (nbyte
== 0 || nbyte
== -1) {
772 snprintf(buffer
, sizeof(buffer
),
773 "closed socket in read(%d): %s", errno
,
774 safe_strerror(errno
));
775 zfpm_connection_down(buffer
);
777 zfpm_connection_down("closed socket in read");
781 if (nbyte
!= (ssize_t
)(FPM_MSG_HDR_LEN
- already
))
784 already
= FPM_MSG_HDR_LEN
;
787 stream_set_getp(ibuf
, 0);
789 hdr
= (fpm_msg_hdr_t
*)stream_pnt(ibuf
);
791 if (!fpm_msg_hdr_ok(hdr
)) {
792 zfpm_connection_down("invalid message header");
796 msg_len
= fpm_msg_len(hdr
);
799 * Read out the rest of the packet.
801 if (already
< msg_len
) {
804 nbyte
= stream_read_try(ibuf
, zfpm_g
->sock
, msg_len
- already
);
806 if (nbyte
== 0 || nbyte
== -1) {
810 snprintf(buffer
, sizeof(buffer
),
811 "failed to read message(%d) %s", errno
,
812 safe_strerror(errno
));
813 zfpm_connection_down(buffer
);
815 zfpm_connection_down("failed to read message");
819 if (nbyte
!= (ssize_t
)(msg_len
- already
))
824 * Just throw it away for now.
833 static bool zfpm_updates_pending(void)
835 if (!(TAILQ_EMPTY(&zfpm_g
->dest_q
)) || !(TAILQ_EMPTY(&zfpm_g
->mac_q
)))
842 * zfpm_writes_pending
844 * Returns true if we may have something to write to the FPM.
846 static int zfpm_writes_pending(void)
850 * Check if there is any data in the outbound buffer that has not
851 * been written to the socket yet.
853 if (stream_get_endp(zfpm_g
->obuf
) - stream_get_getp(zfpm_g
->obuf
))
857 * Check if there are any updates scheduled on the outbound queues.
859 if (zfpm_updates_pending())
868 * Encode a message to the FPM with information about the given route.
870 * Returns the number of bytes written to the buffer. 0 or a negative
871 * value indicates an error.
873 static inline int zfpm_encode_route(rib_dest_t
*dest
, struct route_entry
*re
,
874 char *in_buf
, size_t in_buf_len
,
875 fpm_msg_type_e
*msg_type
)
883 *msg_type
= FPM_MSG_TYPE_NONE
;
885 switch (zfpm_g
->message_format
) {
887 case ZFPM_MSG_FORMAT_PROTOBUF
:
889 len
= zfpm_protobuf_encode_route(dest
, re
, (uint8_t *)in_buf
,
891 *msg_type
= FPM_MSG_TYPE_PROTOBUF
;
895 case ZFPM_MSG_FORMAT_NETLINK
:
897 *msg_type
= FPM_MSG_TYPE_NETLINK
;
898 cmd
= re
? RTM_NEWROUTE
: RTM_DELROUTE
;
899 len
= zfpm_netlink_encode_route(cmd
, dest
, re
, in_buf
,
901 assert(fpm_msg_align(len
) == len
);
902 *msg_type
= FPM_MSG_TYPE_NETLINK
;
903 #endif /* HAVE_NETLINK */
914 * zfpm_route_for_update
916 * Returns the re that is to be sent to the FPM for a given dest.
918 struct route_entry
*zfpm_route_for_update(rib_dest_t
*dest
)
920 return dest
->selected_fib
;
924 * Define an enum for return codes for queue processing functions
926 * FPM_WRITE_STOP: This return code indicates that the write buffer is full.
927 * Stop processing all the queues and empty the buffer by writing its content
930 * FPM_GOTO_NEXT_Q: This return code indicates that either this queue is
931 * empty or we have processed enough updates from this queue.
932 * So, move on to the next queue.
939 #define FPM_QUEUE_PROCESS_LIMIT 10000
942 * zfpm_build_route_updates
944 * Process the dest_q queue and write FPM messages to the outbound buffer.
946 static int zfpm_build_route_updates(void)
950 unsigned char *buf
, *data
, *buf_end
;
954 struct route_entry
*re
;
955 int is_add
, write_msg
;
956 fpm_msg_type_e msg_type
;
959 if (TAILQ_EMPTY(&zfpm_g
->dest_q
))
960 return FPM_GOTO_NEXT_Q
;
963 q_limit
= FPM_QUEUE_PROCESS_LIMIT
;
967 * Make sure there is enough space to write another message.
969 if (STREAM_WRITEABLE(s
) < FPM_MAX_MSG_LEN
)
970 return FPM_WRITE_STOP
;
972 buf
= STREAM_DATA(s
) + stream_get_endp(s
);
973 buf_end
= buf
+ STREAM_WRITEABLE(s
);
975 dest
= TAILQ_FIRST(&zfpm_g
->dest_q
);
977 return FPM_GOTO_NEXT_Q
;
979 assert(CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
));
981 hdr
= (fpm_msg_hdr_t
*)buf
;
982 hdr
->version
= FPM_PROTO_VERSION
;
984 data
= fpm_msg_data(hdr
);
986 re
= zfpm_route_for_update(dest
);
992 * If this is a route deletion, and we have not sent the route
994 * the FPM previously, skip it.
996 if (!is_add
&& !CHECK_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
)) {
998 zfpm_g
->stats
.nop_deletes_skipped
++;
1002 data_len
= zfpm_encode_route(dest
, re
, (char *)data
,
1003 buf_end
- data
, &msg_type
);
1006 hdr
->msg_type
= msg_type
;
1007 msg_len
= fpm_data_len_to_msg_len(data_len
);
1008 hdr
->msg_len
= htons(msg_len
);
1009 stream_forward_endp(s
, msg_len
);
1012 zfpm_g
->stats
.route_adds
++;
1014 zfpm_g
->stats
.route_dels
++;
1016 zlog_err("%s: Encoding Prefix: %pRN No valid nexthops",
1017 __func__
, dest
->rnode
);
1022 * Remove the dest from the queue, and reset the flag.
1024 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1025 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1028 SET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
1030 UNSET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
1034 * Delete the destination if necessary.
1036 if (rib_gc_dest(dest
->rnode
))
1037 zfpm_g
->stats
.dests_del_after_update
++;
1042 * We have processed enough updates in this queue.
1043 * Now yield for other queues.
1045 return FPM_GOTO_NEXT_Q
;
1053 * Encode a message to FPM with information about the given MAC.
1055 * Returns the number of bytes written to the buffer.
1057 static inline int zfpm_encode_mac(struct fpm_mac_info_t
*mac
, char *in_buf
,
1058 size_t in_buf_len
, fpm_msg_type_e
*msg_type
)
1062 *msg_type
= FPM_MSG_TYPE_NONE
;
1064 switch (zfpm_g
->message_format
) {
1066 case ZFPM_MSG_FORMAT_NONE
:
1068 case ZFPM_MSG_FORMAT_NETLINK
:
1070 len
= zfpm_netlink_encode_mac(mac
, in_buf
, in_buf_len
);
1071 assert(fpm_msg_align(len
) == len
);
1072 *msg_type
= FPM_MSG_TYPE_NETLINK
;
1073 #endif /* HAVE_NETLINK */
1075 case ZFPM_MSG_FORMAT_PROTOBUF
:
1081 static int zfpm_build_mac_updates(void)
1084 struct fpm_mac_info_t
*mac
;
1085 unsigned char *buf
, *data
, *buf_end
;
1087 size_t data_len
, msg_len
;
1088 fpm_msg_type_e msg_type
;
1091 if (TAILQ_EMPTY(&zfpm_g
->mac_q
))
1092 return FPM_GOTO_NEXT_Q
;
1095 q_limit
= FPM_QUEUE_PROCESS_LIMIT
;
1098 /* Make sure there is enough space to write another message. */
1099 if (STREAM_WRITEABLE(s
) < FPM_MAX_MAC_MSG_LEN
)
1100 return FPM_WRITE_STOP
;
1102 buf
= STREAM_DATA(s
) + stream_get_endp(s
);
1103 buf_end
= buf
+ STREAM_WRITEABLE(s
);
1105 mac
= TAILQ_FIRST(&zfpm_g
->mac_q
);
1107 return FPM_GOTO_NEXT_Q
;
1109 /* Check for no-op */
1110 if (!CHECK_FLAG(mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
)) {
1111 zfpm_g
->stats
.nop_deletes_skipped
++;
1112 zfpm_mac_info_del(mac
);
1116 hdr
= (fpm_msg_hdr_t
*)buf
;
1117 hdr
->version
= FPM_PROTO_VERSION
;
1119 data
= fpm_msg_data(hdr
);
1120 data_len
= zfpm_encode_mac(mac
, (char *)data
, buf_end
- data
,
1124 hdr
->msg_type
= msg_type
;
1125 msg_len
= fpm_data_len_to_msg_len(data_len
);
1126 hdr
->msg_len
= htons(msg_len
);
1127 stream_forward_endp(s
, msg_len
);
1129 /* Remove the MAC from the queue, and delete it. */
1130 zfpm_mac_info_del(mac
);
1135 * We have processed enough updates in this queue.
1136 * Now yield for other queues.
1138 return FPM_GOTO_NEXT_Q
;
1144 * zfpm_build_updates
1146 * Process the outgoing queues and write messages to the outbound
1149 static void zfpm_build_updates(void)
1154 assert(stream_empty(s
));
1158 * Stop processing the queues if zfpm_g->obuf is full
1159 * or we do not have more updates to process
1161 if (zfpm_build_mac_updates() == FPM_WRITE_STOP
)
1163 if (zfpm_build_route_updates() == FPM_WRITE_STOP
)
1165 } while (zfpm_updates_pending());
1171 static int zfpm_write_cb(struct thread
*thread
)
1176 zfpm_g
->stats
.write_cb_calls
++;
1179 * Check if async connect is now done.
1181 if (zfpm_g
->state
== ZFPM_STATE_CONNECTING
) {
1182 zfpm_connect_check();
1186 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
1187 assert(zfpm_g
->sock
>= 0);
1192 int bytes_to_write
, bytes_written
;
1197 * If the stream is empty, try fill it up with data.
1199 if (stream_empty(s
)) {
1200 zfpm_build_updates();
1203 bytes_to_write
= stream_get_endp(s
) - stream_get_getp(s
);
1204 if (!bytes_to_write
)
1208 write(zfpm_g
->sock
, stream_pnt(s
), bytes_to_write
);
1209 zfpm_g
->stats
.write_calls
++;
1212 if (bytes_written
< 0) {
1213 if (ERRNO_IO_RETRY(errno
))
1216 zfpm_connection_down("failed to write to socket");
1220 if (bytes_written
!= bytes_to_write
) {
1225 stream_forward_getp(s
, bytes_written
);
1226 zfpm_g
->stats
.partial_writes
++;
1231 * We've written out the entire contents of the stream.
1235 if (num_writes
>= ZFPM_MAX_WRITES_PER_RUN
) {
1236 zfpm_g
->stats
.max_writes_hit
++;
1240 if (zfpm_thread_should_yield(thread
)) {
1241 zfpm_g
->stats
.t_write_yields
++;
1246 if (zfpm_writes_pending())
1255 static int zfpm_connect_cb(struct thread
*t
)
1258 struct sockaddr_in serv
;
1260 assert(zfpm_g
->state
== ZFPM_STATE_ACTIVE
);
1262 sock
= socket(AF_INET
, SOCK_STREAM
, 0);
1264 zlog_err("Failed to create socket for connect(): %s",
1266 zfpm_g
->stats
.connect_no_sock
++;
1270 set_nonblocking(sock
);
1272 /* Make server socket. */
1273 memset(&serv
, 0, sizeof(serv
));
1274 serv
.sin_family
= AF_INET
;
1275 serv
.sin_port
= htons(zfpm_g
->fpm_port
);
1276 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
1277 serv
.sin_len
= sizeof(struct sockaddr_in
);
1278 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
1279 if (!zfpm_g
->fpm_server
)
1280 serv
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
1282 serv
.sin_addr
.s_addr
= (zfpm_g
->fpm_server
);
1285 * Connect to the FPM.
1287 zfpm_g
->connect_calls
++;
1288 zfpm_g
->stats
.connect_calls
++;
1289 zfpm_g
->last_connect_call_time
= monotime(NULL
);
1291 ret
= connect(sock
, (struct sockaddr
*)&serv
, sizeof(serv
));
1293 zfpm_g
->sock
= sock
;
1294 zfpm_connection_up("connect succeeded");
1298 if (errno
== EINPROGRESS
) {
1299 zfpm_g
->sock
= sock
;
1302 zfpm_set_state(ZFPM_STATE_CONNECTING
,
1303 "async connect in progress");
1307 zlog_info("can't connect to FPM %d: %s", sock
, safe_strerror(errno
));
1311 * Restart timer for retrying connection.
1313 zfpm_start_connect_timer("connect() failed");
1320 * Move state machine into the given state.
1322 static void zfpm_set_state(enum zfpm_state state
, const char *reason
)
1324 enum zfpm_state cur_state
= zfpm_g
->state
;
1329 if (state
== cur_state
)
1332 zfpm_debug("beginning state transition %s -> %s. Reason: %s",
1333 zfpm_state_to_str(cur_state
), zfpm_state_to_str(state
),
1338 case ZFPM_STATE_IDLE
:
1339 assert(cur_state
== ZFPM_STATE_ESTABLISHED
);
1342 case ZFPM_STATE_ACTIVE
:
1343 assert(cur_state
== ZFPM_STATE_IDLE
1344 || cur_state
== ZFPM_STATE_CONNECTING
);
1345 assert(zfpm_g
->t_connect
);
1348 case ZFPM_STATE_CONNECTING
:
1349 assert(zfpm_g
->sock
);
1350 assert(cur_state
== ZFPM_STATE_ACTIVE
);
1351 assert(zfpm_g
->t_read
);
1352 assert(zfpm_g
->t_write
);
1355 case ZFPM_STATE_ESTABLISHED
:
1356 assert(cur_state
== ZFPM_STATE_ACTIVE
1357 || cur_state
== ZFPM_STATE_CONNECTING
);
1358 assert(zfpm_g
->sock
);
1359 assert(zfpm_g
->t_read
);
1360 assert(zfpm_g
->t_write
);
1364 zfpm_g
->state
= state
;
1368 * zfpm_calc_connect_delay
1370 * Returns the number of seconds after which we should attempt to
1371 * reconnect to the FPM.
1373 static long zfpm_calc_connect_delay(void)
1378 * Return 0 if this is our first attempt to connect.
1380 if (zfpm_g
->connect_calls
== 0) {
1384 elapsed
= zfpm_get_elapsed_time(zfpm_g
->last_connect_call_time
);
1386 if (elapsed
> ZFPM_CONNECT_RETRY_IVL
) {
1390 return ZFPM_CONNECT_RETRY_IVL
- elapsed
;
1394 * zfpm_start_connect_timer
1396 static void zfpm_start_connect_timer(const char *reason
)
1400 assert(!zfpm_g
->t_connect
);
1401 assert(zfpm_g
->sock
< 0);
1403 assert(zfpm_g
->state
== ZFPM_STATE_IDLE
1404 || zfpm_g
->state
== ZFPM_STATE_ACTIVE
1405 || zfpm_g
->state
== ZFPM_STATE_CONNECTING
);
1407 delay_secs
= zfpm_calc_connect_delay();
1408 zfpm_debug("scheduling connect in %ld seconds", delay_secs
);
1410 thread_add_timer(zfpm_g
->master
, zfpm_connect_cb
, 0, delay_secs
,
1411 &zfpm_g
->t_connect
);
1412 zfpm_set_state(ZFPM_STATE_ACTIVE
, reason
);
1418 * Returns true if the zebra FPM module has been enabled.
1420 static inline int zfpm_is_enabled(void)
1422 return zfpm_g
->enabled
;
1428 * Returns true if the connection to the FPM is up.
1430 static inline int zfpm_conn_is_up(void)
1432 if (zfpm_g
->state
!= ZFPM_STATE_ESTABLISHED
)
1435 assert(zfpm_g
->sock
>= 0);
1441 * zfpm_trigger_update
1443 * The zebra code invokes this function to indicate that we should
1444 * send an update to the FPM about the given route_node.
1446 static int zfpm_trigger_update(struct route_node
*rn
, const char *reason
)
1451 * Ignore if the connection is down. We will update the FPM about
1452 * all destinations once the connection comes up.
1454 if (!zfpm_conn_is_up())
1457 dest
= rib_dest_from_rnode(rn
);
1459 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)) {
1460 zfpm_g
->stats
.redundant_triggers
++;
1465 zfpm_debug("%pFX triggering update to FPM - Reason: %s", &rn
->p
,
1469 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1470 TAILQ_INSERT_TAIL(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1471 zfpm_g
->stats
.updates_triggered
++;
1474 * Make sure that writes are enabled.
1476 if (zfpm_g
->t_write
)
1484 * Generate Key for FPM MAC info hash entry
1486 static unsigned int zfpm_mac_info_hash_keymake(const void *p
)
1488 struct fpm_mac_info_t
*fpm_mac
= (struct fpm_mac_info_t
*)p
;
1491 mac_key
= jhash(fpm_mac
->macaddr
.octet
, ETH_ALEN
, 0xa5a5a55a);
1493 return jhash_2words(mac_key
, fpm_mac
->vni
, 0);
1497 * Compare function for FPM MAC info hash lookup
1499 static bool zfpm_mac_info_cmp(const void *p1
, const void *p2
)
1501 const struct fpm_mac_info_t
*fpm_mac1
= p1
;
1502 const struct fpm_mac_info_t
*fpm_mac2
= p2
;
1504 if (memcmp(fpm_mac1
->macaddr
.octet
, fpm_mac2
->macaddr
.octet
, ETH_ALEN
)
1507 if (fpm_mac1
->vni
!= fpm_mac2
->vni
)
1514 * Lookup FPM MAC info hash entry.
1516 static struct fpm_mac_info_t
*zfpm_mac_info_lookup(struct fpm_mac_info_t
*key
)
1518 return hash_lookup(zfpm_g
->fpm_mac_info_table
, key
);
1522 * Callback to allocate fpm_mac_info_t structure.
1524 static void *zfpm_mac_info_alloc(void *p
)
1526 const struct fpm_mac_info_t
*key
= p
;
1527 struct fpm_mac_info_t
*fpm_mac
;
1529 fpm_mac
= XCALLOC(MTYPE_FPM_MAC_INFO
, sizeof(struct fpm_mac_info_t
));
1531 memcpy(&fpm_mac
->macaddr
, &key
->macaddr
, ETH_ALEN
);
1532 fpm_mac
->vni
= key
->vni
;
1534 return (void *)fpm_mac
;
1538 * Delink and free fpm_mac_info_t.
1540 static void zfpm_mac_info_del(struct fpm_mac_info_t
*fpm_mac
)
1542 hash_release(zfpm_g
->fpm_mac_info_table
, fpm_mac
);
1543 TAILQ_REMOVE(&zfpm_g
->mac_q
, fpm_mac
, fpm_mac_q_entries
);
1544 XFREE(MTYPE_FPM_MAC_INFO
, fpm_mac
);
1548 * zfpm_trigger_rmac_update
1550 * Zebra code invokes this function to indicate that we should
1551 * send an update to FPM for given MAC entry.
1553 * This function checks if we already have enqueued an update for this RMAC,
1554 * If yes, update the same fpm_mac_info_t. Else, create and enqueue an update.
1556 static int zfpm_trigger_rmac_update(zebra_mac_t
*rmac
, zebra_l3vni_t
*zl3vni
,
1557 bool delete, const char *reason
)
1559 struct fpm_mac_info_t
*fpm_mac
, key
;
1560 struct interface
*vxlan_if
, *svi_if
;
1561 bool mac_found
= false;
1564 * Ignore if the connection is down. We will update the FPM about
1565 * all destinations once the connection comes up.
1567 if (!zfpm_conn_is_up())
1571 zfpm_debug("triggering update to FPM - Reason: %s - %pEA",
1572 reason
, &rmac
->macaddr
);
1575 vxlan_if
= zl3vni_map_to_vxlan_if(zl3vni
);
1576 svi_if
= zl3vni_map_to_svi_if(zl3vni
);
1578 memset(&key
, 0, sizeof(struct fpm_mac_info_t
));
1580 memcpy(&key
.macaddr
, &rmac
->macaddr
, ETH_ALEN
);
1581 key
.vni
= zl3vni
->vni
;
1583 /* Check if this MAC is already present in the queue. */
1584 fpm_mac
= zfpm_mac_info_lookup(&key
);
1590 * If the enqueued op is "add" and current op is "delete",
1591 * this is a noop. So, Unset ZEBRA_MAC_UPDATE_FPM flag.
1592 * While processing FPM queue, we will silently delete this
1593 * MAC entry without sending any update for this MAC.
1595 if (!CHECK_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
) &&
1597 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1598 UNSET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
);
1602 fpm_mac
= hash_get(zfpm_g
->fpm_mac_info_table
, &key
,
1603 zfpm_mac_info_alloc
);
1608 fpm_mac
->r_vtep_ip
.s_addr
= rmac
->fwd_info
.r_vtep_ip
.s_addr
;
1609 fpm_mac
->zebra_flags
= rmac
->flags
;
1610 fpm_mac
->vxlan_if
= vxlan_if
? vxlan_if
->ifindex
: 0;
1611 fpm_mac
->svi_if
= svi_if
? svi_if
->ifindex
: 0;
1613 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
);
1615 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1617 UNSET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1620 TAILQ_INSERT_TAIL(&zfpm_g
->mac_q
, fpm_mac
, fpm_mac_q_entries
);
1622 zfpm_g
->stats
.updates_triggered
++;
1624 /* If writes are already enabled, return. */
1625 if (zfpm_g
->t_write
)
1633 * This function is called when the FPM connections is established.
1634 * Iterate over all the RMAC entries for the given L3VNI
1635 * and enqueue the RMAC for FPM processing.
1637 static void zfpm_trigger_rmac_update_wrapper(struct hash_bucket
*bucket
,
1640 zebra_mac_t
*zrmac
= (zebra_mac_t
*)bucket
->data
;
1641 zebra_l3vni_t
*zl3vni
= (zebra_l3vni_t
*)args
;
1643 zfpm_trigger_rmac_update(zrmac
, zl3vni
, false, "RMAC added");
1647 * This function is called when the FPM connections is established.
1648 * This function iterates over all the L3VNIs to trigger
1649 * FPM updates for RMACs currently available.
1651 static void zfpm_iterate_rmac_table(struct hash_bucket
*bucket
, void *args
)
1653 zebra_l3vni_t
*zl3vni
= (zebra_l3vni_t
*)bucket
->data
;
1655 hash_iterate(zl3vni
->rmac_table
, zfpm_trigger_rmac_update_wrapper
,
1660 * struct zfpm_statsimer_cb
1662 static int zfpm_stats_timer_cb(struct thread
*t
)
1664 zfpm_g
->t_stats
= NULL
;
1667 * Remember the stats collected in the last interval for display
1670 zfpm_stats_copy(&zfpm_g
->stats
, &zfpm_g
->last_ivl_stats
);
1673 * Add the current set of stats into the cumulative statistics.
1675 zfpm_stats_compose(&zfpm_g
->cumulative_stats
, &zfpm_g
->stats
,
1676 &zfpm_g
->cumulative_stats
);
1679 * Start collecting stats afresh over the next interval.
1681 zfpm_stats_reset(&zfpm_g
->stats
);
1683 zfpm_start_stats_timer();
1689 * zfpm_stop_stats_timer
1691 static void zfpm_stop_stats_timer(void)
1693 if (!zfpm_g
->t_stats
)
1696 zfpm_debug("Stopping existing stats timer");
1697 thread_cancel(&zfpm_g
->t_stats
);
1701 * zfpm_start_stats_timer
1703 void zfpm_start_stats_timer(void)
1705 assert(!zfpm_g
->t_stats
);
1707 thread_add_timer(zfpm_g
->master
, zfpm_stats_timer_cb
, 0,
1708 ZFPM_STATS_IVL_SECS
, &zfpm_g
->t_stats
);
1712 * Helper macro for zfpm_show_stats() below.
1714 #define ZFPM_SHOW_STAT(counter) \
1716 vty_out(vty, "%-40s %10lu %16lu\n", #counter, \
1717 total_stats.counter, zfpm_g->last_ivl_stats.counter); \
1723 static void zfpm_show_stats(struct vty
*vty
)
1725 struct zfpm_stats total_stats
;
1728 vty_out(vty
, "\n%-40s %10s Last %2d secs\n\n", "Counter", "Total",
1729 ZFPM_STATS_IVL_SECS
);
1732 * Compute the total stats up to this instant.
1734 zfpm_stats_compose(&zfpm_g
->cumulative_stats
, &zfpm_g
->stats
,
1737 ZFPM_SHOW_STAT(connect_calls
);
1738 ZFPM_SHOW_STAT(connect_no_sock
);
1739 ZFPM_SHOW_STAT(read_cb_calls
);
1740 ZFPM_SHOW_STAT(write_cb_calls
);
1741 ZFPM_SHOW_STAT(write_calls
);
1742 ZFPM_SHOW_STAT(partial_writes
);
1743 ZFPM_SHOW_STAT(max_writes_hit
);
1744 ZFPM_SHOW_STAT(t_write_yields
);
1745 ZFPM_SHOW_STAT(nop_deletes_skipped
);
1746 ZFPM_SHOW_STAT(route_adds
);
1747 ZFPM_SHOW_STAT(route_dels
);
1748 ZFPM_SHOW_STAT(updates_triggered
);
1749 ZFPM_SHOW_STAT(redundant_triggers
);
1750 ZFPM_SHOW_STAT(dests_del_after_update
);
1751 ZFPM_SHOW_STAT(t_conn_down_starts
);
1752 ZFPM_SHOW_STAT(t_conn_down_dests_processed
);
1753 ZFPM_SHOW_STAT(t_conn_down_yields
);
1754 ZFPM_SHOW_STAT(t_conn_down_finishes
);
1755 ZFPM_SHOW_STAT(t_conn_up_starts
);
1756 ZFPM_SHOW_STAT(t_conn_up_dests_processed
);
1757 ZFPM_SHOW_STAT(t_conn_up_yields
);
1758 ZFPM_SHOW_STAT(t_conn_up_aborts
);
1759 ZFPM_SHOW_STAT(t_conn_up_finishes
);
1761 if (!zfpm_g
->last_stats_clear_time
)
1764 elapsed
= zfpm_get_elapsed_time(zfpm_g
->last_stats_clear_time
);
1766 vty_out(vty
, "\nStats were cleared %lu seconds ago\n",
1767 (unsigned long)elapsed
);
1773 static void zfpm_clear_stats(struct vty
*vty
)
1775 if (!zfpm_is_enabled()) {
1776 vty_out(vty
, "The FPM module is not enabled...\n");
1780 zfpm_stats_reset(&zfpm_g
->stats
);
1781 zfpm_stats_reset(&zfpm_g
->last_ivl_stats
);
1782 zfpm_stats_reset(&zfpm_g
->cumulative_stats
);
1784 zfpm_stop_stats_timer();
1785 zfpm_start_stats_timer();
1787 zfpm_g
->last_stats_clear_time
= monotime(NULL
);
1789 vty_out(vty
, "Cleared FPM stats\n");
1793 * show_zebra_fpm_stats
1795 DEFUN (show_zebra_fpm_stats
,
1796 show_zebra_fpm_stats_cmd
,
1797 "show zebra fpm stats",
1800 "Forwarding Path Manager information\n"
1803 zfpm_show_stats(vty
);
1808 * clear_zebra_fpm_stats
1810 DEFUN (clear_zebra_fpm_stats
,
1811 clear_zebra_fpm_stats_cmd
,
1812 "clear zebra fpm stats",
1815 "Clear Forwarding Path Manager information\n"
1818 zfpm_clear_stats(vty
);
1823 * update fpm connection information
1825 DEFUN ( fpm_remote_ip
,
1827 "fpm connection ip A.B.C.D port (1-65535)",
1828 "fpm connection remote ip and port\n"
1829 "Remote fpm server ip A.B.C.D\n"
1833 in_addr_t fpm_server
;
1836 fpm_server
= inet_addr(argv
[3]->arg
);
1837 if (fpm_server
== INADDR_NONE
)
1838 return CMD_ERR_INCOMPLETE
;
1840 port_no
= atoi(argv
[5]->arg
);
1841 if (port_no
< TCP_MIN_PORT
|| port_no
> TCP_MAX_PORT
)
1842 return CMD_ERR_INCOMPLETE
;
1844 zfpm_g
->fpm_server
= fpm_server
;
1845 zfpm_g
->fpm_port
= port_no
;
1851 DEFUN ( no_fpm_remote_ip
,
1852 no_fpm_remote_ip_cmd
,
1853 "no fpm connection ip A.B.C.D port (1-65535)",
1854 "fpm connection remote ip and port\n"
1856 "Remote fpm server ip A.B.C.D\n"
1859 if (zfpm_g
->fpm_server
!= inet_addr(argv
[4]->arg
)
1860 || zfpm_g
->fpm_port
!= atoi(argv
[6]->arg
))
1861 return CMD_ERR_NO_MATCH
;
1863 zfpm_g
->fpm_server
= FPM_DEFAULT_IP
;
1864 zfpm_g
->fpm_port
= FPM_DEFAULT_PORT
;
1870 * zfpm_init_message_format
1872 static inline void zfpm_init_message_format(const char *format
)
1874 int have_netlink
, have_protobuf
;
1882 #ifdef HAVE_PROTOBUF
1888 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NONE
;
1892 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NETLINK
;
1893 } else if (have_protobuf
) {
1894 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_PROTOBUF
;
1899 if (!strcmp("netlink", format
)) {
1900 if (!have_netlink
) {
1901 flog_err(EC_ZEBRA_NETLINK_NOT_AVAILABLE
,
1902 "FPM netlink message format is not available");
1905 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NETLINK
;
1909 if (!strcmp("protobuf", format
)) {
1910 if (!have_protobuf
) {
1912 EC_ZEBRA_PROTOBUF_NOT_AVAILABLE
,
1913 "FPM protobuf message format is not available");
1916 flog_warn(EC_ZEBRA_PROTOBUF_NOT_AVAILABLE
,
1917 "FPM protobuf message format is deprecated and scheduled to be removed. Please convert to using netlink format or contact dev@lists.frrouting.org with your use case.");
1918 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_PROTOBUF
;
1922 flog_warn(EC_ZEBRA_FPM_FORMAT_UNKNOWN
, "Unknown fpm format '%s'",
1927 * fpm_remote_srv_write
1929 * Module to write remote fpm connection
1931 * Returns ZERO on success.
1934 static int fpm_remote_srv_write(struct vty
*vty
)
1938 in
.s_addr
= zfpm_g
->fpm_server
;
1940 if ((zfpm_g
->fpm_server
!= FPM_DEFAULT_IP
1941 && zfpm_g
->fpm_server
!= INADDR_ANY
)
1942 || (zfpm_g
->fpm_port
!= FPM_DEFAULT_PORT
&& zfpm_g
->fpm_port
!= 0))
1943 vty_out(vty
, "fpm connection ip %pI4 port %d\n", &in
,
1950 static int fpm_remote_srv_write(struct vty
*vty
);
1952 static struct cmd_node zebra_node
= {
1955 .parent_node
= CONFIG_NODE
,
1957 .config_write
= fpm_remote_srv_write
,
1964 * One-time initialization of the Zebra FPM module.
1966 * @param[in] port port at which FPM is running.
1967 * @param[in] enable true if the zebra FPM module should be enabled
1968 * @param[in] format to use to talk to the FPM. Can be 'netink' or 'protobuf'.
1970 * Returns true on success.
1972 static int zfpm_init(struct thread_master
*master
)
1976 const char *format
= THIS_MODULE
->load_args
;
1978 memset(zfpm_g
, 0, sizeof(*zfpm_g
));
1979 zfpm_g
->master
= master
;
1980 TAILQ_INIT(&zfpm_g
->dest_q
);
1981 TAILQ_INIT(&zfpm_g
->mac_q
);
1983 /* Create hash table for fpm_mac_info_t enties */
1984 zfpm_g
->fpm_mac_info_table
= hash_create(zfpm_mac_info_hash_keymake
,
1986 "FPM MAC info hash table");
1989 zfpm_g
->state
= ZFPM_STATE_IDLE
;
1991 zfpm_stats_init(&zfpm_g
->stats
);
1992 zfpm_stats_init(&zfpm_g
->last_ivl_stats
);
1993 zfpm_stats_init(&zfpm_g
->cumulative_stats
);
1995 install_node(&zebra_node
);
1996 install_element(ENABLE_NODE
, &show_zebra_fpm_stats_cmd
);
1997 install_element(ENABLE_NODE
, &clear_zebra_fpm_stats_cmd
);
1998 install_element(CONFIG_NODE
, &fpm_remote_ip_cmd
);
1999 install_element(CONFIG_NODE
, &no_fpm_remote_ip_cmd
);
2001 zfpm_init_message_format(format
);
2004 * Disable FPM interface if no suitable format is available.
2006 if (zfpm_g
->message_format
== ZFPM_MSG_FORMAT_NONE
)
2009 zfpm_g
->enabled
= enable
;
2011 if (!zfpm_g
->fpm_server
)
2012 zfpm_g
->fpm_server
= FPM_DEFAULT_IP
;
2015 port
= FPM_DEFAULT_PORT
;
2017 zfpm_g
->fpm_port
= port
;
2019 zfpm_g
->obuf
= stream_new(ZFPM_OBUF_SIZE
);
2020 zfpm_g
->ibuf
= stream_new(ZFPM_IBUF_SIZE
);
2022 zfpm_start_stats_timer();
2023 zfpm_start_connect_timer("initialized");
2027 static int zfpm_fini(void)
2033 zfpm_stop_stats_timer();
2035 hook_unregister(rib_update
, zfpm_trigger_update
);
2039 static int zebra_fpm_module_init(void)
2041 hook_register(rib_update
, zfpm_trigger_update
);
2042 hook_register(zebra_rmac_update
, zfpm_trigger_rmac_update
);
2043 hook_register(frr_late_init
, zfpm_init
);
2044 hook_register(frr_early_fini
, zfpm_fini
);
2048 FRR_MODULE_SETUP(.name
= "zebra_fpm", .version
= FRR_VERSION
,
2049 .description
= "zebra FPM (Forwarding Plane Manager) module",
2050 .init
= zebra_fpm_module_init
,