1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Main implementation file for interface to Forwarding Plane Manager.
5 * Copyright (C) 2012 by Open Source Routing.
6 * Copyright (C) 2012 by Internet Systems Consortium, Inc. ("ISC")
17 #include "lib/version.h"
20 #include "zebra/rib.h"
21 #include "zebra/zserv.h"
22 #include "zebra/zebra_ns.h"
23 #include "zebra/zebra_vrf.h"
24 #include "zebra/zebra_errors.h"
27 #include "zebra_fpm_private.h"
28 #include "zebra/zebra_router.h"
29 #include "zebra_vxlan_private.h"
31 DEFINE_MTYPE_STATIC(ZEBRA
, FPM_MAC_INFO
, "FPM_MAC_INFO");
34 * Interval at which we attempt to connect to the FPM.
36 #define ZFPM_CONNECT_RETRY_IVL 5
39 * Sizes of outgoing and incoming stream buffers for writing/reading
42 #define ZFPM_OBUF_SIZE (2 * FPM_MAX_MSG_LEN)
43 #define ZFPM_IBUF_SIZE (FPM_MAX_MSG_LEN)
46 * The maximum number of times the FPM socket write callback can call
47 * 'write' before it yields.
49 #define ZFPM_MAX_WRITES_PER_RUN 10
52 * Interval over which we collect statistics.
54 #define ZFPM_STATS_IVL_SECS 10
55 #define FPM_MAX_MAC_MSG_LEN 512
57 static void zfpm_iterate_rmac_table(struct hash_bucket
*bucket
, void *args
);
60 * Structure that holds state for iterating over all route_node
61 * structures that are candidates for being communicated to the FPM.
63 struct zfpm_rnodes_iter
{
64 rib_tables_iter_t tables_iter
;
65 route_table_iter_t iter
;
72 unsigned long connect_calls
;
73 unsigned long connect_no_sock
;
75 unsigned long read_cb_calls
;
77 unsigned long write_cb_calls
;
78 unsigned long write_calls
;
79 unsigned long partial_writes
;
80 unsigned long max_writes_hit
;
81 unsigned long t_write_yields
;
83 unsigned long nop_deletes_skipped
;
84 unsigned long route_adds
;
85 unsigned long route_dels
;
87 unsigned long updates_triggered
;
88 unsigned long redundant_triggers
;
90 unsigned long dests_del_after_update
;
92 unsigned long t_conn_down_starts
;
93 unsigned long t_conn_down_dests_processed
;
94 unsigned long t_conn_down_yields
;
95 unsigned long t_conn_down_finishes
;
97 unsigned long t_conn_up_starts
;
98 unsigned long t_conn_up_dests_processed
;
99 unsigned long t_conn_up_yields
;
100 unsigned long t_conn_up_aborts
;
101 unsigned long t_conn_up_finishes
;
105 * States for the FPM state machine.
110 * In this state we are not yet ready to connect to the FPM. This
111 * can happen when this module is disabled, or if we're cleaning up
112 * after a connection has gone down.
117 * Ready to talk to the FPM and periodically trying to connect to
123 * In the middle of bringing up a TCP connection. Specifically,
124 * waiting for a connect() call to complete asynchronously.
126 ZFPM_STATE_CONNECTING
,
129 * TCP connection to the FPM is up.
131 ZFPM_STATE_ESTABLISHED
136 * Message format to be used to communicate with the FPM.
138 enum zfpm_msg_format
{
139 ZFPM_MSG_FORMAT_NONE
,
140 ZFPM_MSG_FORMAT_NETLINK
,
141 ZFPM_MSG_FORMAT_PROTOBUF
,
150 * True if the FPM module has been enabled.
155 * Message format to be used to communicate with the fpm.
157 enum zfpm_msg_format message_format
;
159 struct thread_master
*master
;
161 enum zfpm_state state
;
163 in_addr_t fpm_server
;
165 * Port on which the FPM is running.
170 * List of rib_dest_t structures to be processed
172 TAILQ_HEAD(zfpm_dest_q
, rib_dest_t_
) dest_q
;
175 * List of fpm_mac_info structures to be processed
177 TAILQ_HEAD(zfpm_mac_q
, fpm_mac_info_t
) mac_q
;
180 * Hash table of fpm_mac_info_t entries
182 * While adding fpm_mac_info_t for a MAC to the mac_q,
183 * it is possible that another fpm_mac_info_t node for the this MAC
184 * is already present in the queue.
185 * This is possible in the case of consecutive add->delete operations.
186 * To avoid such duplicate insertions in the mac_q,
187 * define a hash table for fpm_mac_info_t which can be looked up
188 * to see if an fpm_mac_info_t node for a MAC is already present
191 struct hash
*fpm_mac_info_table
;
194 * Stream socket to the FPM.
199 * Buffers for messages to/from the FPM.
207 struct thread
*t_connect
;
208 struct thread
*t_write
;
209 struct thread
*t_read
;
212 * Thread to clean up after the TCP connection to the FPM goes down
213 * and the state that belongs to it.
215 struct thread
*t_conn_down
;
218 struct zfpm_rnodes_iter iter
;
222 * Thread to take actions once the TCP conn to the FPM comes up, and
223 * the state that belongs to it.
225 struct thread
*t_conn_up
;
228 struct zfpm_rnodes_iter iter
;
231 unsigned long connect_calls
;
232 time_t last_connect_call_time
;
235 * Stats from the start of the current statistics interval up to
236 * now. These are the counters we typically update in the code.
238 struct zfpm_stats stats
;
241 * Statistics that were gathered in the last collection interval.
243 struct zfpm_stats last_ivl_stats
;
246 * Cumulative stats from the last clear to the start of the current
247 * statistics interval.
249 struct zfpm_stats cumulative_stats
;
252 * Stats interval timer.
254 struct thread
*t_stats
;
257 * If non-zero, the last time when statistics were cleared.
259 time_t last_stats_clear_time
;
262 * Flag to track the MAC dump status to FPM
264 bool fpm_mac_dump_done
;
267 static struct zfpm_glob zfpm_glob_space
;
268 static struct zfpm_glob
*zfpm_g
= &zfpm_glob_space
;
270 static int zfpm_trigger_update(struct route_node
*rn
, const char *reason
);
272 static void zfpm_read_cb(struct thread
*thread
);
273 static void zfpm_write_cb(struct thread
*thread
);
275 static void zfpm_set_state(enum zfpm_state state
, const char *reason
);
276 static void zfpm_start_connect_timer(const char *reason
);
277 static void zfpm_start_stats_timer(void);
278 static void zfpm_mac_info_del(struct fpm_mac_info_t
*fpm_mac
);
280 static const char ipv4_ll_buf
[16] = "169.254.0.1";
281 union g_addr ipv4ll_gateway
;
284 * zfpm_thread_should_yield
286 static inline int zfpm_thread_should_yield(struct thread
*t
)
288 return thread_should_yield(t
);
294 static const char *zfpm_state_to_str(enum zfpm_state state
)
298 case ZFPM_STATE_IDLE
:
301 case ZFPM_STATE_ACTIVE
:
304 case ZFPM_STATE_CONNECTING
:
307 case ZFPM_STATE_ESTABLISHED
:
308 return "established";
316 * zfpm_get_elapsed_time
318 * Returns the time elapsed (in seconds) since the given time.
320 static time_t zfpm_get_elapsed_time(time_t reference
)
324 now
= monotime(NULL
);
326 if (now
< reference
) {
331 return now
- reference
;
335 * zfpm_rnodes_iter_init
337 static inline void zfpm_rnodes_iter_init(struct zfpm_rnodes_iter
*iter
)
339 memset(iter
, 0, sizeof(*iter
));
340 rib_tables_iter_init(&iter
->tables_iter
);
343 * This is a hack, but it makes implementing 'next' easier by
344 * ensuring that route_table_iter_next() will return NULL the first
347 route_table_iter_init(&iter
->iter
, NULL
);
348 route_table_iter_cleanup(&iter
->iter
);
352 * zfpm_rnodes_iter_next
354 static inline struct route_node
*
355 zfpm_rnodes_iter_next(struct zfpm_rnodes_iter
*iter
)
357 struct route_node
*rn
;
358 struct route_table
*table
;
361 rn
= route_table_iter_next(&iter
->iter
);
366 * We've made our way through this table, go to the next one.
368 route_table_iter_cleanup(&iter
->iter
);
370 table
= rib_tables_iter_next(&iter
->tables_iter
);
375 route_table_iter_init(&iter
->iter
, table
);
382 * zfpm_rnodes_iter_pause
384 static inline void zfpm_rnodes_iter_pause(struct zfpm_rnodes_iter
*iter
)
386 route_table_iter_pause(&iter
->iter
);
390 * zfpm_rnodes_iter_cleanup
392 static inline void zfpm_rnodes_iter_cleanup(struct zfpm_rnodes_iter
*iter
)
394 route_table_iter_cleanup(&iter
->iter
);
395 rib_tables_iter_cleanup(&iter
->tables_iter
);
401 * Initialize a statistics block.
403 static inline void zfpm_stats_init(struct zfpm_stats
*stats
)
405 memset(stats
, 0, sizeof(*stats
));
411 static inline void zfpm_stats_reset(struct zfpm_stats
*stats
)
413 zfpm_stats_init(stats
);
419 static inline void zfpm_stats_copy(const struct zfpm_stats
*src
,
420 struct zfpm_stats
*dest
)
422 memcpy(dest
, src
, sizeof(*dest
));
428 * Total up the statistics in two stats structures ('s1 and 's2') and
429 * return the result in the third argument, 'result'. Note that the
430 * pointer 'result' may be the same as 's1' or 's2'.
432 * For simplicity, the implementation below assumes that the stats
433 * structure is composed entirely of counters. This can easily be
434 * changed when necessary.
436 static void zfpm_stats_compose(const struct zfpm_stats
*s1
,
437 const struct zfpm_stats
*s2
,
438 struct zfpm_stats
*result
)
440 const unsigned long *p1
, *p2
;
441 unsigned long *result_p
;
444 p1
= (const unsigned long *)s1
;
445 p2
= (const unsigned long *)s2
;
446 result_p
= (unsigned long *)result
;
448 num_counters
= (sizeof(struct zfpm_stats
) / sizeof(unsigned long));
450 for (i
= 0; i
< num_counters
; i
++) {
451 result_p
[i
] = p1
[i
] + p2
[i
];
458 static inline void zfpm_read_on(void)
460 assert(!zfpm_g
->t_read
);
461 assert(zfpm_g
->sock
>= 0);
463 thread_add_read(zfpm_g
->master
, zfpm_read_cb
, 0, zfpm_g
->sock
,
470 static inline void zfpm_write_on(void)
472 assert(!zfpm_g
->t_write
);
473 assert(zfpm_g
->sock
>= 0);
475 thread_add_write(zfpm_g
->master
, zfpm_write_cb
, 0, zfpm_g
->sock
,
482 static inline void zfpm_read_off(void)
484 THREAD_OFF(zfpm_g
->t_read
);
490 static inline void zfpm_write_off(void)
492 THREAD_OFF(zfpm_g
->t_write
);
495 static inline void zfpm_connect_off(void)
497 THREAD_OFF(zfpm_g
->t_connect
);
501 * zfpm_conn_up_thread_cb
503 * Callback for actions to be taken when the connection to the FPM
506 static void zfpm_conn_up_thread_cb(struct thread
*thread
)
508 struct route_node
*rnode
;
509 struct zfpm_rnodes_iter
*iter
;
512 iter
= &zfpm_g
->t_conn_up_state
.iter
;
514 if (zfpm_g
->state
!= ZFPM_STATE_ESTABLISHED
) {
516 "Connection not up anymore, conn_up thread aborting");
517 zfpm_g
->stats
.t_conn_up_aborts
++;
521 if (!zfpm_g
->fpm_mac_dump_done
) {
522 /* Enqueue FPM updates for all the RMAC entries */
523 hash_iterate(zrouter
.l3vni_table
, zfpm_iterate_rmac_table
,
525 /* mark dump done so that its not repeated after yield */
526 zfpm_g
->fpm_mac_dump_done
= true;
529 while ((rnode
= zfpm_rnodes_iter_next(iter
))) {
530 dest
= rib_dest_from_rnode(rnode
);
533 zfpm_g
->stats
.t_conn_up_dests_processed
++;
534 zfpm_trigger_update(rnode
, NULL
);
540 if (!zfpm_thread_should_yield(thread
))
543 zfpm_g
->stats
.t_conn_up_yields
++;
544 zfpm_rnodes_iter_pause(iter
);
545 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_up_thread_cb
,
546 NULL
, 0, &zfpm_g
->t_conn_up
);
550 zfpm_g
->stats
.t_conn_up_finishes
++;
553 zfpm_rnodes_iter_cleanup(iter
);
559 * Called when the connection to the FPM comes up.
561 static void zfpm_connection_up(const char *detail
)
563 assert(zfpm_g
->sock
>= 0);
566 zfpm_set_state(ZFPM_STATE_ESTABLISHED
, detail
);
569 * Start thread to push existing routes to the FPM.
571 THREAD_OFF(zfpm_g
->t_conn_up
);
573 zfpm_rnodes_iter_init(&zfpm_g
->t_conn_up_state
.iter
);
574 zfpm_g
->fpm_mac_dump_done
= false;
576 zfpm_debug("Starting conn_up thread");
578 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_up_thread_cb
, NULL
, 0,
580 zfpm_g
->stats
.t_conn_up_starts
++;
586 * Check if an asynchronous connect() to the FPM is complete.
588 static void zfpm_connect_check(void)
597 slen
= sizeof(status
);
598 ret
= getsockopt(zfpm_g
->sock
, SOL_SOCKET
, SO_ERROR
, (void *)&status
,
601 if (ret
>= 0 && status
== 0) {
602 zfpm_connection_up("async connect complete");
607 * getsockopt() failed or indicated an error on the socket.
612 zfpm_start_connect_timer("getsockopt() after async connect failed");
617 * zfpm_conn_down_thread_cb
619 * Callback that is invoked to clean up state after the TCP connection
620 * to the FPM goes down.
622 static void zfpm_conn_down_thread_cb(struct thread
*thread
)
624 struct route_node
*rnode
;
625 struct zfpm_rnodes_iter
*iter
;
627 struct fpm_mac_info_t
*mac
= NULL
;
629 assert(zfpm_g
->state
== ZFPM_STATE_IDLE
);
632 * Delink and free all fpm_mac_info_t nodes
633 * in the mac_q and fpm_mac_info_hash
635 while ((mac
= TAILQ_FIRST(&zfpm_g
->mac_q
)) != NULL
)
636 zfpm_mac_info_del(mac
);
638 zfpm_g
->t_conn_down
= NULL
;
640 iter
= &zfpm_g
->t_conn_down_state
.iter
;
642 while ((rnode
= zfpm_rnodes_iter_next(iter
))) {
643 dest
= rib_dest_from_rnode(rnode
);
646 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)) {
647 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
,
651 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
652 UNSET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
654 zfpm_g
->stats
.t_conn_down_dests_processed
++;
657 * Check if the dest should be deleted.
665 if (!zfpm_thread_should_yield(thread
))
668 zfpm_g
->stats
.t_conn_down_yields
++;
669 zfpm_rnodes_iter_pause(iter
);
670 zfpm_g
->t_conn_down
= NULL
;
671 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_down_thread_cb
,
672 NULL
, 0, &zfpm_g
->t_conn_down
);
676 zfpm_g
->stats
.t_conn_down_finishes
++;
677 zfpm_rnodes_iter_cleanup(iter
);
680 * Start the process of connecting to the FPM again.
682 zfpm_start_connect_timer("cleanup complete");
686 * zfpm_connection_down
688 * Called when the connection to the FPM has gone down.
690 static void zfpm_connection_down(const char *detail
)
695 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
697 zlog_info("connection to the FPM has gone down: %s", detail
);
702 stream_reset(zfpm_g
->ibuf
);
703 stream_reset(zfpm_g
->obuf
);
705 if (zfpm_g
->sock
>= 0) {
711 * Start thread to clean up state after the connection goes down.
713 assert(!zfpm_g
->t_conn_down
);
714 zfpm_rnodes_iter_init(&zfpm_g
->t_conn_down_state
.iter
);
715 zfpm_g
->t_conn_down
= NULL
;
716 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_down_thread_cb
, NULL
, 0,
717 &zfpm_g
->t_conn_down
);
718 zfpm_g
->stats
.t_conn_down_starts
++;
720 zfpm_set_state(ZFPM_STATE_IDLE
, detail
);
726 static void zfpm_read_cb(struct thread
*thread
)
733 zfpm_g
->stats
.read_cb_calls
++;
736 * Check if async connect is now done.
738 if (zfpm_g
->state
== ZFPM_STATE_CONNECTING
) {
739 zfpm_connect_check();
743 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
744 assert(zfpm_g
->sock
>= 0);
748 already
= stream_get_endp(ibuf
);
749 if (already
< FPM_MSG_HDR_LEN
) {
752 nbyte
= stream_read_try(ibuf
, zfpm_g
->sock
,
753 FPM_MSG_HDR_LEN
- already
);
754 if (nbyte
== 0 || nbyte
== -1) {
758 snprintf(buffer
, sizeof(buffer
),
759 "closed socket in read(%d): %s", errno
,
760 safe_strerror(errno
));
761 zfpm_connection_down(buffer
);
763 zfpm_connection_down("closed socket in read");
767 if (nbyte
!= (ssize_t
)(FPM_MSG_HDR_LEN
- already
))
770 already
= FPM_MSG_HDR_LEN
;
773 stream_set_getp(ibuf
, 0);
775 hdr
= (fpm_msg_hdr_t
*)stream_pnt(ibuf
);
777 if (!fpm_msg_hdr_ok(hdr
)) {
778 zfpm_connection_down("invalid message header");
782 msg_len
= fpm_msg_len(hdr
);
785 * Read out the rest of the packet.
787 if (already
< msg_len
) {
790 nbyte
= stream_read_try(ibuf
, zfpm_g
->sock
, msg_len
- already
);
792 if (nbyte
== 0 || nbyte
== -1) {
796 snprintf(buffer
, sizeof(buffer
),
797 "failed to read message(%d) %s", errno
,
798 safe_strerror(errno
));
799 zfpm_connection_down(buffer
);
801 zfpm_connection_down("failed to read message");
805 if (nbyte
!= (ssize_t
)(msg_len
- already
))
810 * Just throw it away for now.
818 static bool zfpm_updates_pending(void)
820 if (!(TAILQ_EMPTY(&zfpm_g
->dest_q
)) || !(TAILQ_EMPTY(&zfpm_g
->mac_q
)))
827 * zfpm_writes_pending
829 * Returns true if we may have something to write to the FPM.
831 static int zfpm_writes_pending(void)
835 * Check if there is any data in the outbound buffer that has not
836 * been written to the socket yet.
838 if (stream_get_endp(zfpm_g
->obuf
) - stream_get_getp(zfpm_g
->obuf
))
842 * Check if there are any updates scheduled on the outbound queues.
844 if (zfpm_updates_pending())
853 * Encode a message to the FPM with information about the given route.
855 * Returns the number of bytes written to the buffer. 0 or a negative
856 * value indicates an error.
858 static inline int zfpm_encode_route(rib_dest_t
*dest
, struct route_entry
*re
,
859 char *in_buf
, size_t in_buf_len
,
860 fpm_msg_type_e
*msg_type
)
868 *msg_type
= FPM_MSG_TYPE_NONE
;
870 switch (zfpm_g
->message_format
) {
872 case ZFPM_MSG_FORMAT_PROTOBUF
:
874 len
= zfpm_protobuf_encode_route(dest
, re
, (uint8_t *)in_buf
,
876 *msg_type
= FPM_MSG_TYPE_PROTOBUF
;
880 case ZFPM_MSG_FORMAT_NETLINK
:
882 *msg_type
= FPM_MSG_TYPE_NETLINK
;
883 cmd
= re
? RTM_NEWROUTE
: RTM_DELROUTE
;
884 len
= zfpm_netlink_encode_route(cmd
, dest
, re
, in_buf
,
886 assert(fpm_msg_align(len
) == len
);
887 #endif /* HAVE_NETLINK */
890 case ZFPM_MSG_FORMAT_NONE
:
898 * zfpm_route_for_update
900 * Returns the re that is to be sent to the FPM for a given dest.
902 struct route_entry
*zfpm_route_for_update(rib_dest_t
*dest
)
904 return dest
->selected_fib
;
908 * Define an enum for return codes for queue processing functions
910 * FPM_WRITE_STOP: This return code indicates that the write buffer is full.
911 * Stop processing all the queues and empty the buffer by writing its content
914 * FPM_GOTO_NEXT_Q: This return code indicates that either this queue is
915 * empty or we have processed enough updates from this queue.
916 * So, move on to the next queue.
923 #define FPM_QUEUE_PROCESS_LIMIT 10000
926 * zfpm_build_route_updates
928 * Process the dest_q queue and write FPM messages to the outbound buffer.
930 static int zfpm_build_route_updates(void)
934 unsigned char *buf
, *data
, *buf_end
;
938 struct route_entry
*re
;
939 int is_add
, write_msg
;
940 fpm_msg_type_e msg_type
;
943 if (TAILQ_EMPTY(&zfpm_g
->dest_q
))
944 return FPM_GOTO_NEXT_Q
;
947 q_limit
= FPM_QUEUE_PROCESS_LIMIT
;
951 * Make sure there is enough space to write another message.
953 if (STREAM_WRITEABLE(s
) < FPM_MAX_MSG_LEN
)
954 return FPM_WRITE_STOP
;
956 buf
= STREAM_DATA(s
) + stream_get_endp(s
);
957 buf_end
= buf
+ STREAM_WRITEABLE(s
);
959 dest
= TAILQ_FIRST(&zfpm_g
->dest_q
);
961 return FPM_GOTO_NEXT_Q
;
963 assert(CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
));
965 hdr
= (fpm_msg_hdr_t
*)buf
;
966 hdr
->version
= FPM_PROTO_VERSION
;
968 data
= fpm_msg_data(hdr
);
970 re
= zfpm_route_for_update(dest
);
976 * If this is a route deletion, and we have not sent the route
978 * the FPM previously, skip it.
980 if (!is_add
&& !CHECK_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
)) {
982 zfpm_g
->stats
.nop_deletes_skipped
++;
986 data_len
= zfpm_encode_route(dest
, re
, (char *)data
,
987 buf_end
- data
, &msg_type
);
990 hdr
->msg_type
= msg_type
;
991 msg_len
= fpm_data_len_to_msg_len(data_len
);
992 hdr
->msg_len
= htons(msg_len
);
993 stream_forward_endp(s
, msg_len
);
996 zfpm_g
->stats
.route_adds
++;
998 zfpm_g
->stats
.route_dels
++;
1000 zlog_err("%s: Encoding Prefix: %pRN No valid nexthops",
1001 __func__
, dest
->rnode
);
1006 * Remove the dest from the queue, and reset the flag.
1008 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1009 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1012 SET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
1014 UNSET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
1018 * Delete the destination if necessary.
1020 if (rib_gc_dest(dest
->rnode
))
1021 zfpm_g
->stats
.dests_del_after_update
++;
1026 * We have processed enough updates in this queue.
1027 * Now yield for other queues.
1029 return FPM_GOTO_NEXT_Q
;
1037 * Encode a message to FPM with information about the given MAC.
1039 * Returns the number of bytes written to the buffer.
1041 static inline int zfpm_encode_mac(struct fpm_mac_info_t
*mac
, char *in_buf
,
1042 size_t in_buf_len
, fpm_msg_type_e
*msg_type
)
1046 *msg_type
= FPM_MSG_TYPE_NONE
;
1048 switch (zfpm_g
->message_format
) {
1050 case ZFPM_MSG_FORMAT_NONE
:
1052 case ZFPM_MSG_FORMAT_NETLINK
:
1054 len
= zfpm_netlink_encode_mac(mac
, in_buf
, in_buf_len
);
1055 assert(fpm_msg_align(len
) == len
);
1056 *msg_type
= FPM_MSG_TYPE_NETLINK
;
1057 #endif /* HAVE_NETLINK */
1059 case ZFPM_MSG_FORMAT_PROTOBUF
:
1065 static int zfpm_build_mac_updates(void)
1068 struct fpm_mac_info_t
*mac
;
1069 unsigned char *buf
, *data
, *buf_end
;
1071 size_t data_len
, msg_len
;
1072 fpm_msg_type_e msg_type
;
1075 if (TAILQ_EMPTY(&zfpm_g
->mac_q
))
1076 return FPM_GOTO_NEXT_Q
;
1079 q_limit
= FPM_QUEUE_PROCESS_LIMIT
;
1082 /* Make sure there is enough space to write another message. */
1083 if (STREAM_WRITEABLE(s
) < FPM_MAX_MAC_MSG_LEN
)
1084 return FPM_WRITE_STOP
;
1086 buf
= STREAM_DATA(s
) + stream_get_endp(s
);
1087 buf_end
= buf
+ STREAM_WRITEABLE(s
);
1089 mac
= TAILQ_FIRST(&zfpm_g
->mac_q
);
1091 return FPM_GOTO_NEXT_Q
;
1093 /* Check for no-op */
1094 if (!CHECK_FLAG(mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
)) {
1095 zfpm_g
->stats
.nop_deletes_skipped
++;
1096 zfpm_mac_info_del(mac
);
1100 hdr
= (fpm_msg_hdr_t
*)buf
;
1101 hdr
->version
= FPM_PROTO_VERSION
;
1103 data
= fpm_msg_data(hdr
);
1104 data_len
= zfpm_encode_mac(mac
, (char *)data
, buf_end
- data
,
1108 hdr
->msg_type
= msg_type
;
1109 msg_len
= fpm_data_len_to_msg_len(data_len
);
1110 hdr
->msg_len
= htons(msg_len
);
1111 stream_forward_endp(s
, msg_len
);
1113 /* Remove the MAC from the queue, and delete it. */
1114 zfpm_mac_info_del(mac
);
1119 * We have processed enough updates in this queue.
1120 * Now yield for other queues.
1122 return FPM_GOTO_NEXT_Q
;
1128 * zfpm_build_updates
1130 * Process the outgoing queues and write messages to the outbound
1133 static void zfpm_build_updates(void)
1138 assert(stream_empty(s
));
1142 * Stop processing the queues if zfpm_g->obuf is full
1143 * or we do not have more updates to process
1145 if (zfpm_build_mac_updates() == FPM_WRITE_STOP
)
1147 if (zfpm_build_route_updates() == FPM_WRITE_STOP
)
1149 } while (zfpm_updates_pending());
1155 static void zfpm_write_cb(struct thread
*thread
)
1160 zfpm_g
->stats
.write_cb_calls
++;
1163 * Check if async connect is now done.
1165 if (zfpm_g
->state
== ZFPM_STATE_CONNECTING
) {
1166 zfpm_connect_check();
1170 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
1171 assert(zfpm_g
->sock
>= 0);
1176 int bytes_to_write
, bytes_written
;
1181 * If the stream is empty, try fill it up with data.
1183 if (stream_empty(s
)) {
1184 zfpm_build_updates();
1187 bytes_to_write
= stream_get_endp(s
) - stream_get_getp(s
);
1188 if (!bytes_to_write
)
1192 write(zfpm_g
->sock
, stream_pnt(s
), bytes_to_write
);
1193 zfpm_g
->stats
.write_calls
++;
1196 if (bytes_written
< 0) {
1197 if (ERRNO_IO_RETRY(errno
))
1200 zfpm_connection_down("failed to write to socket");
1204 if (bytes_written
!= bytes_to_write
) {
1209 stream_forward_getp(s
, bytes_written
);
1210 zfpm_g
->stats
.partial_writes
++;
1215 * We've written out the entire contents of the stream.
1219 if (num_writes
>= ZFPM_MAX_WRITES_PER_RUN
) {
1220 zfpm_g
->stats
.max_writes_hit
++;
1224 if (zfpm_thread_should_yield(thread
)) {
1225 zfpm_g
->stats
.t_write_yields
++;
1230 if (zfpm_writes_pending())
1237 static void zfpm_connect_cb(struct thread
*t
)
1240 struct sockaddr_in serv
;
1242 assert(zfpm_g
->state
== ZFPM_STATE_ACTIVE
);
1244 sock
= socket(AF_INET
, SOCK_STREAM
, 0);
1246 zlog_err("Failed to create socket for connect(): %s",
1248 zfpm_g
->stats
.connect_no_sock
++;
1252 set_nonblocking(sock
);
1254 /* Make server socket. */
1255 memset(&serv
, 0, sizeof(serv
));
1256 serv
.sin_family
= AF_INET
;
1257 serv
.sin_port
= htons(zfpm_g
->fpm_port
);
1258 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
1259 serv
.sin_len
= sizeof(struct sockaddr_in
);
1260 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
1261 if (!zfpm_g
->fpm_server
)
1262 serv
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
1264 serv
.sin_addr
.s_addr
= (zfpm_g
->fpm_server
);
1267 * Connect to the FPM.
1269 zfpm_g
->connect_calls
++;
1270 zfpm_g
->stats
.connect_calls
++;
1271 zfpm_g
->last_connect_call_time
= monotime(NULL
);
1273 ret
= connect(sock
, (struct sockaddr
*)&serv
, sizeof(serv
));
1275 zfpm_g
->sock
= sock
;
1276 zfpm_connection_up("connect succeeded");
1280 if (errno
== EINPROGRESS
) {
1281 zfpm_g
->sock
= sock
;
1284 zfpm_set_state(ZFPM_STATE_CONNECTING
,
1285 "async connect in progress");
1289 zlog_info("can't connect to FPM %d: %s", sock
, safe_strerror(errno
));
1293 * Restart timer for retrying connection.
1295 zfpm_start_connect_timer("connect() failed");
1301 * Move state machine into the given state.
1303 static void zfpm_set_state(enum zfpm_state state
, const char *reason
)
1305 enum zfpm_state cur_state
= zfpm_g
->state
;
1310 if (state
== cur_state
)
1313 zfpm_debug("beginning state transition %s -> %s. Reason: %s",
1314 zfpm_state_to_str(cur_state
), zfpm_state_to_str(state
),
1319 case ZFPM_STATE_IDLE
:
1320 assert(cur_state
== ZFPM_STATE_ESTABLISHED
);
1323 case ZFPM_STATE_ACTIVE
:
1324 assert(cur_state
== ZFPM_STATE_IDLE
1325 || cur_state
== ZFPM_STATE_CONNECTING
);
1326 assert(zfpm_g
->t_connect
);
1329 case ZFPM_STATE_CONNECTING
:
1330 assert(zfpm_g
->sock
);
1331 assert(cur_state
== ZFPM_STATE_ACTIVE
);
1332 assert(zfpm_g
->t_read
);
1333 assert(zfpm_g
->t_write
);
1336 case ZFPM_STATE_ESTABLISHED
:
1337 assert(cur_state
== ZFPM_STATE_ACTIVE
1338 || cur_state
== ZFPM_STATE_CONNECTING
);
1339 assert(zfpm_g
->sock
);
1340 assert(zfpm_g
->t_read
);
1341 assert(zfpm_g
->t_write
);
1345 zfpm_g
->state
= state
;
1349 * zfpm_calc_connect_delay
1351 * Returns the number of seconds after which we should attempt to
1352 * reconnect to the FPM.
1354 static long zfpm_calc_connect_delay(void)
1359 * Return 0 if this is our first attempt to connect.
1361 if (zfpm_g
->connect_calls
== 0) {
1365 elapsed
= zfpm_get_elapsed_time(zfpm_g
->last_connect_call_time
);
1367 if (elapsed
> ZFPM_CONNECT_RETRY_IVL
) {
1371 return ZFPM_CONNECT_RETRY_IVL
- elapsed
;
1375 * zfpm_start_connect_timer
1377 static void zfpm_start_connect_timer(const char *reason
)
1381 assert(!zfpm_g
->t_connect
);
1382 assert(zfpm_g
->sock
< 0);
1384 assert(zfpm_g
->state
== ZFPM_STATE_IDLE
1385 || zfpm_g
->state
== ZFPM_STATE_ACTIVE
1386 || zfpm_g
->state
== ZFPM_STATE_CONNECTING
);
1388 delay_secs
= zfpm_calc_connect_delay();
1389 zfpm_debug("scheduling connect in %ld seconds", delay_secs
);
1391 thread_add_timer(zfpm_g
->master
, zfpm_connect_cb
, 0, delay_secs
,
1392 &zfpm_g
->t_connect
);
1393 zfpm_set_state(ZFPM_STATE_ACTIVE
, reason
);
1399 * Returns true if the zebra FPM module has been enabled.
1401 static inline int zfpm_is_enabled(void)
1403 return zfpm_g
->enabled
;
1409 * Returns true if the connection to the FPM is up.
1411 static inline int zfpm_conn_is_up(void)
1413 if (zfpm_g
->state
!= ZFPM_STATE_ESTABLISHED
)
1416 assert(zfpm_g
->sock
>= 0);
1422 * zfpm_trigger_update
1424 * The zebra code invokes this function to indicate that we should
1425 * send an update to the FPM about the given route_node.
1427 static int zfpm_trigger_update(struct route_node
*rn
, const char *reason
)
1432 * Ignore if the connection is down. We will update the FPM about
1433 * all destinations once the connection comes up.
1435 if (!zfpm_conn_is_up())
1438 dest
= rib_dest_from_rnode(rn
);
1440 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)) {
1441 zfpm_g
->stats
.redundant_triggers
++;
1446 zfpm_debug("%pFX triggering update to FPM - Reason: %s", &rn
->p
,
1450 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1451 TAILQ_INSERT_TAIL(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1452 zfpm_g
->stats
.updates_triggered
++;
1455 * Make sure that writes are enabled.
1457 if (zfpm_g
->t_write
)
1465 * zfpm_trigger_remove
1467 * The zebra code invokes this function to indicate that we should
1468 * send an remove to the FPM about the given route_node.
1471 static int zfpm_trigger_remove(struct route_node
*rn
)
1475 if (!zfpm_conn_is_up())
1478 dest
= rib_dest_from_rnode(rn
);
1479 if (!CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
))
1482 zfpm_debug("%pRN Removing from update queue shutting down", rn
);
1484 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1485 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1491 * Generate Key for FPM MAC info hash entry
1493 static unsigned int zfpm_mac_info_hash_keymake(const void *p
)
1495 struct fpm_mac_info_t
*fpm_mac
= (struct fpm_mac_info_t
*)p
;
1498 mac_key
= jhash(fpm_mac
->macaddr
.octet
, ETH_ALEN
, 0xa5a5a55a);
1500 return jhash_2words(mac_key
, fpm_mac
->vni
, 0);
1504 * Compare function for FPM MAC info hash lookup
1506 static bool zfpm_mac_info_cmp(const void *p1
, const void *p2
)
1508 const struct fpm_mac_info_t
*fpm_mac1
= p1
;
1509 const struct fpm_mac_info_t
*fpm_mac2
= p2
;
1511 if (memcmp(fpm_mac1
->macaddr
.octet
, fpm_mac2
->macaddr
.octet
, ETH_ALEN
)
1514 if (fpm_mac1
->vni
!= fpm_mac2
->vni
)
1521 * Lookup FPM MAC info hash entry.
1523 static struct fpm_mac_info_t
*zfpm_mac_info_lookup(struct fpm_mac_info_t
*key
)
1525 return hash_lookup(zfpm_g
->fpm_mac_info_table
, key
);
1529 * Callback to allocate fpm_mac_info_t structure.
1531 static void *zfpm_mac_info_alloc(void *p
)
1533 const struct fpm_mac_info_t
*key
= p
;
1534 struct fpm_mac_info_t
*fpm_mac
;
1536 fpm_mac
= XCALLOC(MTYPE_FPM_MAC_INFO
, sizeof(struct fpm_mac_info_t
));
1538 memcpy(&fpm_mac
->macaddr
, &key
->macaddr
, ETH_ALEN
);
1539 fpm_mac
->vni
= key
->vni
;
1541 return (void *)fpm_mac
;
1545 * Delink and free fpm_mac_info_t.
1547 static void zfpm_mac_info_del(struct fpm_mac_info_t
*fpm_mac
)
1549 hash_release(zfpm_g
->fpm_mac_info_table
, fpm_mac
);
1550 TAILQ_REMOVE(&zfpm_g
->mac_q
, fpm_mac
, fpm_mac_q_entries
);
1551 XFREE(MTYPE_FPM_MAC_INFO
, fpm_mac
);
1555 * zfpm_trigger_rmac_update
1557 * Zebra code invokes this function to indicate that we should
1558 * send an update to FPM for given MAC entry.
1560 * This function checks if we already have enqueued an update for this RMAC,
1561 * If yes, update the same fpm_mac_info_t. Else, create and enqueue an update.
1563 static int zfpm_trigger_rmac_update(struct zebra_mac
*rmac
,
1564 struct zebra_l3vni
*zl3vni
, bool delete,
1567 struct fpm_mac_info_t
*fpm_mac
, key
;
1568 struct interface
*vxlan_if
, *svi_if
;
1569 bool mac_found
= false;
1572 * Ignore if the connection is down. We will update the FPM about
1573 * all destinations once the connection comes up.
1575 if (!zfpm_conn_is_up())
1579 zfpm_debug("triggering update to FPM - Reason: %s - %pEA",
1580 reason
, &rmac
->macaddr
);
1583 vxlan_if
= zl3vni_map_to_vxlan_if(zl3vni
);
1584 svi_if
= zl3vni_map_to_svi_if(zl3vni
);
1586 memset(&key
, 0, sizeof(key
));
1588 memcpy(&key
.macaddr
, &rmac
->macaddr
, ETH_ALEN
);
1589 key
.vni
= zl3vni
->vni
;
1591 /* Check if this MAC is already present in the queue. */
1592 fpm_mac
= zfpm_mac_info_lookup(&key
);
1598 * If the enqueued op is "add" and current op is "delete",
1599 * this is a noop. So, Unset ZEBRA_MAC_UPDATE_FPM flag.
1600 * While processing FPM queue, we will silently delete this
1601 * MAC entry without sending any update for this MAC.
1603 if (!CHECK_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
) &&
1605 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1606 UNSET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
);
1610 fpm_mac
= hash_get(zfpm_g
->fpm_mac_info_table
, &key
,
1611 zfpm_mac_info_alloc
);
1613 fpm_mac
->r_vtep_ip
.s_addr
= rmac
->fwd_info
.r_vtep_ip
.s_addr
;
1614 fpm_mac
->zebra_flags
= rmac
->flags
;
1615 fpm_mac
->vxlan_if
= vxlan_if
? vxlan_if
->ifindex
: 0;
1616 fpm_mac
->svi_if
= svi_if
? svi_if
->ifindex
: 0;
1618 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
);
1620 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1622 UNSET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1625 TAILQ_INSERT_TAIL(&zfpm_g
->mac_q
, fpm_mac
, fpm_mac_q_entries
);
1627 zfpm_g
->stats
.updates_triggered
++;
1629 /* If writes are already enabled, return. */
1630 if (zfpm_g
->t_write
)
1638 * This function is called when the FPM connections is established.
1639 * Iterate over all the RMAC entries for the given L3VNI
1640 * and enqueue the RMAC for FPM processing.
1642 static void zfpm_trigger_rmac_update_wrapper(struct hash_bucket
*bucket
,
1645 struct zebra_mac
*zrmac
= (struct zebra_mac
*)bucket
->data
;
1646 struct zebra_l3vni
*zl3vni
= (struct zebra_l3vni
*)args
;
1648 zfpm_trigger_rmac_update(zrmac
, zl3vni
, false, "RMAC added");
1652 * This function is called when the FPM connections is established.
1653 * This function iterates over all the L3VNIs to trigger
1654 * FPM updates for RMACs currently available.
1656 static void zfpm_iterate_rmac_table(struct hash_bucket
*bucket
, void *args
)
1658 struct zebra_l3vni
*zl3vni
= (struct zebra_l3vni
*)bucket
->data
;
1660 hash_iterate(zl3vni
->rmac_table
, zfpm_trigger_rmac_update_wrapper
,
1665 * struct zfpm_statsimer_cb
1667 static void zfpm_stats_timer_cb(struct thread
*t
)
1669 zfpm_g
->t_stats
= NULL
;
1672 * Remember the stats collected in the last interval for display
1675 zfpm_stats_copy(&zfpm_g
->stats
, &zfpm_g
->last_ivl_stats
);
1678 * Add the current set of stats into the cumulative statistics.
1680 zfpm_stats_compose(&zfpm_g
->cumulative_stats
, &zfpm_g
->stats
,
1681 &zfpm_g
->cumulative_stats
);
1684 * Start collecting stats afresh over the next interval.
1686 zfpm_stats_reset(&zfpm_g
->stats
);
1688 zfpm_start_stats_timer();
1692 * zfpm_stop_stats_timer
1694 static void zfpm_stop_stats_timer(void)
1696 if (!zfpm_g
->t_stats
)
1699 zfpm_debug("Stopping existing stats timer");
1700 THREAD_OFF(zfpm_g
->t_stats
);
1704 * zfpm_start_stats_timer
1706 void zfpm_start_stats_timer(void)
1708 assert(!zfpm_g
->t_stats
);
1710 thread_add_timer(zfpm_g
->master
, zfpm_stats_timer_cb
, 0,
1711 ZFPM_STATS_IVL_SECS
, &zfpm_g
->t_stats
);
1715 * Helper macro for zfpm_show_stats() below.
1717 #define ZFPM_SHOW_STAT(counter) \
1719 vty_out(vty, "%-40s %10lu %16lu\n", #counter, \
1720 total_stats.counter, zfpm_g->last_ivl_stats.counter); \
1726 static void zfpm_show_stats(struct vty
*vty
)
1728 struct zfpm_stats total_stats
;
1731 vty_out(vty
, "\n%-40s %10s Last %2d secs\n\n", "Counter", "Total",
1732 ZFPM_STATS_IVL_SECS
);
1735 * Compute the total stats up to this instant.
1737 zfpm_stats_compose(&zfpm_g
->cumulative_stats
, &zfpm_g
->stats
,
1740 ZFPM_SHOW_STAT(connect_calls
);
1741 ZFPM_SHOW_STAT(connect_no_sock
);
1742 ZFPM_SHOW_STAT(read_cb_calls
);
1743 ZFPM_SHOW_STAT(write_cb_calls
);
1744 ZFPM_SHOW_STAT(write_calls
);
1745 ZFPM_SHOW_STAT(partial_writes
);
1746 ZFPM_SHOW_STAT(max_writes_hit
);
1747 ZFPM_SHOW_STAT(t_write_yields
);
1748 ZFPM_SHOW_STAT(nop_deletes_skipped
);
1749 ZFPM_SHOW_STAT(route_adds
);
1750 ZFPM_SHOW_STAT(route_dels
);
1751 ZFPM_SHOW_STAT(updates_triggered
);
1752 ZFPM_SHOW_STAT(redundant_triggers
);
1753 ZFPM_SHOW_STAT(dests_del_after_update
);
1754 ZFPM_SHOW_STAT(t_conn_down_starts
);
1755 ZFPM_SHOW_STAT(t_conn_down_dests_processed
);
1756 ZFPM_SHOW_STAT(t_conn_down_yields
);
1757 ZFPM_SHOW_STAT(t_conn_down_finishes
);
1758 ZFPM_SHOW_STAT(t_conn_up_starts
);
1759 ZFPM_SHOW_STAT(t_conn_up_dests_processed
);
1760 ZFPM_SHOW_STAT(t_conn_up_yields
);
1761 ZFPM_SHOW_STAT(t_conn_up_aborts
);
1762 ZFPM_SHOW_STAT(t_conn_up_finishes
);
1764 if (!zfpm_g
->last_stats_clear_time
)
1767 elapsed
= zfpm_get_elapsed_time(zfpm_g
->last_stats_clear_time
);
1769 vty_out(vty
, "\nStats were cleared %lu seconds ago\n",
1770 (unsigned long)elapsed
);
1776 static void zfpm_clear_stats(struct vty
*vty
)
1778 if (!zfpm_is_enabled()) {
1779 vty_out(vty
, "The FPM module is not enabled...\n");
1783 zfpm_stats_reset(&zfpm_g
->stats
);
1784 zfpm_stats_reset(&zfpm_g
->last_ivl_stats
);
1785 zfpm_stats_reset(&zfpm_g
->cumulative_stats
);
1787 zfpm_stop_stats_timer();
1788 zfpm_start_stats_timer();
1790 zfpm_g
->last_stats_clear_time
= monotime(NULL
);
1792 vty_out(vty
, "Cleared FPM stats\n");
1796 * show_zebra_fpm_stats
1798 DEFUN (show_zebra_fpm_stats
,
1799 show_zebra_fpm_stats_cmd
,
1800 "show zebra fpm stats",
1803 "Forwarding Path Manager information\n"
1806 zfpm_show_stats(vty
);
1811 * clear_zebra_fpm_stats
1813 DEFUN (clear_zebra_fpm_stats
,
1814 clear_zebra_fpm_stats_cmd
,
1815 "clear zebra fpm stats",
1818 "Clear Forwarding Path Manager information\n"
1821 zfpm_clear_stats(vty
);
1826 * update fpm connection information
1828 DEFUN (fpm_remote_ip
,
1830 "fpm connection ip A.B.C.D port (1-65535)",
1831 "Forwarding Path Manager\n"
1832 "Configure FPM connection\n"
1833 "Connect to IPv4 address\n"
1834 "Connect to IPv4 address\n"
1836 "TCP port number\n")
1839 in_addr_t fpm_server
;
1842 fpm_server
= inet_addr(argv
[3]->arg
);
1843 if (fpm_server
== INADDR_NONE
)
1844 return CMD_ERR_INCOMPLETE
;
1846 port_no
= atoi(argv
[5]->arg
);
1847 if (port_no
< TCP_MIN_PORT
|| port_no
> TCP_MAX_PORT
)
1848 return CMD_ERR_INCOMPLETE
;
1850 zfpm_g
->fpm_server
= fpm_server
;
1851 zfpm_g
->fpm_port
= port_no
;
1857 DEFUN (no_fpm_remote_ip
,
1858 no_fpm_remote_ip_cmd
,
1859 "no fpm connection ip A.B.C.D port (1-65535)",
1861 "Forwarding Path Manager\n"
1862 "Remove configured FPM connection\n"
1863 "Connect to IPv4 address\n"
1864 "Connect to IPv4 address\n"
1866 "TCP port number\n")
1868 if (zfpm_g
->fpm_server
!= inet_addr(argv
[4]->arg
)
1869 || zfpm_g
->fpm_port
!= atoi(argv
[6]->arg
))
1870 return CMD_ERR_NO_MATCH
;
1872 zfpm_g
->fpm_server
= FPM_DEFAULT_IP
;
1873 zfpm_g
->fpm_port
= FPM_DEFAULT_PORT
;
1879 * zfpm_init_message_format
1881 static inline void zfpm_init_message_format(const char *format
)
1883 int have_netlink
, have_protobuf
;
1891 #ifdef HAVE_PROTOBUF
1897 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NONE
;
1901 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NETLINK
;
1902 } else if (have_protobuf
) {
1903 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_PROTOBUF
;
1908 if (!strcmp("netlink", format
)) {
1909 if (!have_netlink
) {
1910 flog_err(EC_ZEBRA_NETLINK_NOT_AVAILABLE
,
1911 "FPM netlink message format is not available");
1914 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NETLINK
;
1918 if (!strcmp("protobuf", format
)) {
1919 if (!have_protobuf
) {
1921 EC_ZEBRA_PROTOBUF_NOT_AVAILABLE
,
1922 "FPM protobuf message format is not available");
1925 flog_warn(EC_ZEBRA_PROTOBUF_NOT_AVAILABLE
,
1926 "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.");
1927 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_PROTOBUF
;
1931 flog_warn(EC_ZEBRA_FPM_FORMAT_UNKNOWN
, "Unknown fpm format '%s'",
1936 * fpm_remote_srv_write
1938 * Module to write remote fpm connection
1940 * Returns ZERO on success.
1943 static int fpm_remote_srv_write(struct vty
*vty
)
1947 in
.s_addr
= zfpm_g
->fpm_server
;
1949 if ((zfpm_g
->fpm_server
!= FPM_DEFAULT_IP
1950 && zfpm_g
->fpm_server
!= INADDR_ANY
)
1951 || (zfpm_g
->fpm_port
!= FPM_DEFAULT_PORT
&& zfpm_g
->fpm_port
!= 0))
1952 vty_out(vty
, "fpm connection ip %pI4 port %d\n", &in
,
1959 static int fpm_remote_srv_write(struct vty
*vty
);
1961 static struct cmd_node zebra_node
= {
1964 .parent_node
= CONFIG_NODE
,
1966 .config_write
= fpm_remote_srv_write
,
1973 * One-time initialization of the Zebra FPM module.
1975 * @param[in] port port at which FPM is running.
1976 * @param[in] enable true if the zebra FPM module should be enabled
1977 * @param[in] format to use to talk to the FPM. Can be 'netink' or 'protobuf'.
1979 * Returns true on success.
1981 static int zfpm_init(struct thread_master
*master
)
1985 const char *format
= THIS_MODULE
->load_args
;
1987 memset(zfpm_g
, 0, sizeof(*zfpm_g
));
1988 zfpm_g
->master
= master
;
1989 TAILQ_INIT(&zfpm_g
->dest_q
);
1990 TAILQ_INIT(&zfpm_g
->mac_q
);
1992 /* Create hash table for fpm_mac_info_t enties */
1993 zfpm_g
->fpm_mac_info_table
= hash_create(zfpm_mac_info_hash_keymake
,
1995 "FPM MAC info hash table");
1998 zfpm_g
->state
= ZFPM_STATE_IDLE
;
2000 zfpm_stats_init(&zfpm_g
->stats
);
2001 zfpm_stats_init(&zfpm_g
->last_ivl_stats
);
2002 zfpm_stats_init(&zfpm_g
->cumulative_stats
);
2004 memset(&ipv4ll_gateway
, 0, sizeof(ipv4ll_gateway
));
2005 if (inet_pton(AF_INET
, ipv4_ll_buf
, &ipv4ll_gateway
.ipv4
) != 1)
2006 zlog_warn("inet_pton failed for %s", ipv4_ll_buf
);
2008 install_node(&zebra_node
);
2009 install_element(ENABLE_NODE
, &show_zebra_fpm_stats_cmd
);
2010 install_element(ENABLE_NODE
, &clear_zebra_fpm_stats_cmd
);
2011 install_element(CONFIG_NODE
, &fpm_remote_ip_cmd
);
2012 install_element(CONFIG_NODE
, &no_fpm_remote_ip_cmd
);
2014 zfpm_init_message_format(format
);
2017 * Disable FPM interface if no suitable format is available.
2019 if (zfpm_g
->message_format
== ZFPM_MSG_FORMAT_NONE
)
2022 zfpm_g
->enabled
= enable
;
2024 if (!zfpm_g
->fpm_server
)
2025 zfpm_g
->fpm_server
= FPM_DEFAULT_IP
;
2028 port
= FPM_DEFAULT_PORT
;
2030 zfpm_g
->fpm_port
= port
;
2032 zfpm_g
->obuf
= stream_new(ZFPM_OBUF_SIZE
);
2033 zfpm_g
->ibuf
= stream_new(ZFPM_IBUF_SIZE
);
2035 zfpm_start_stats_timer();
2036 zfpm_start_connect_timer("initialized");
2040 static int zfpm_fini(void)
2046 zfpm_stop_stats_timer();
2048 hook_unregister(rib_update
, zfpm_trigger_update
);
2052 static int zebra_fpm_module_init(void)
2054 hook_register(rib_update
, zfpm_trigger_update
);
2055 hook_register(rib_shutdown
, zfpm_trigger_remove
);
2056 hook_register(zebra_rmac_update
, zfpm_trigger_rmac_update
);
2057 hook_register(frr_late_init
, zfpm_init
);
2058 hook_register(frr_early_fini
, zfpm_fini
);
2062 FRR_MODULE_SETUP(.name
= "zebra_fpm", .version
= FRR_VERSION
,
2063 .description
= "zebra FPM (Forwarding Plane Manager) module",
2064 .init
= zebra_fpm_module_init
,