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
);
295 static const char ipv4_ll_buf
[16] = "169.254.0.1";
296 union g_addr ipv4ll_gateway
;
299 * zfpm_thread_should_yield
301 static inline int zfpm_thread_should_yield(struct thread
*t
)
303 return thread_should_yield(t
);
309 static const char *zfpm_state_to_str(enum zfpm_state state
)
313 case ZFPM_STATE_IDLE
:
316 case ZFPM_STATE_ACTIVE
:
319 case ZFPM_STATE_CONNECTING
:
322 case ZFPM_STATE_ESTABLISHED
:
323 return "established";
331 * zfpm_get_elapsed_time
333 * Returns the time elapsed (in seconds) since the given time.
335 static time_t zfpm_get_elapsed_time(time_t reference
)
339 now
= monotime(NULL
);
341 if (now
< reference
) {
346 return now
- reference
;
350 * zfpm_rnodes_iter_init
352 static inline void zfpm_rnodes_iter_init(struct zfpm_rnodes_iter
*iter
)
354 memset(iter
, 0, sizeof(*iter
));
355 rib_tables_iter_init(&iter
->tables_iter
);
358 * This is a hack, but it makes implementing 'next' easier by
359 * ensuring that route_table_iter_next() will return NULL the first
362 route_table_iter_init(&iter
->iter
, NULL
);
363 route_table_iter_cleanup(&iter
->iter
);
367 * zfpm_rnodes_iter_next
369 static inline struct route_node
*
370 zfpm_rnodes_iter_next(struct zfpm_rnodes_iter
*iter
)
372 struct route_node
*rn
;
373 struct route_table
*table
;
376 rn
= route_table_iter_next(&iter
->iter
);
381 * We've made our way through this table, go to the next one.
383 route_table_iter_cleanup(&iter
->iter
);
385 table
= rib_tables_iter_next(&iter
->tables_iter
);
390 route_table_iter_init(&iter
->iter
, table
);
397 * zfpm_rnodes_iter_pause
399 static inline void zfpm_rnodes_iter_pause(struct zfpm_rnodes_iter
*iter
)
401 route_table_iter_pause(&iter
->iter
);
405 * zfpm_rnodes_iter_cleanup
407 static inline void zfpm_rnodes_iter_cleanup(struct zfpm_rnodes_iter
*iter
)
409 route_table_iter_cleanup(&iter
->iter
);
410 rib_tables_iter_cleanup(&iter
->tables_iter
);
416 * Initialize a statistics block.
418 static inline void zfpm_stats_init(struct zfpm_stats
*stats
)
420 memset(stats
, 0, sizeof(*stats
));
426 static inline void zfpm_stats_reset(struct zfpm_stats
*stats
)
428 zfpm_stats_init(stats
);
434 static inline void zfpm_stats_copy(const struct zfpm_stats
*src
,
435 struct zfpm_stats
*dest
)
437 memcpy(dest
, src
, sizeof(*dest
));
443 * Total up the statistics in two stats structures ('s1 and 's2') and
444 * return the result in the third argument, 'result'. Note that the
445 * pointer 'result' may be the same as 's1' or 's2'.
447 * For simplicity, the implementation below assumes that the stats
448 * structure is composed entirely of counters. This can easily be
449 * changed when necessary.
451 static void zfpm_stats_compose(const struct zfpm_stats
*s1
,
452 const struct zfpm_stats
*s2
,
453 struct zfpm_stats
*result
)
455 const unsigned long *p1
, *p2
;
456 unsigned long *result_p
;
459 p1
= (const unsigned long *)s1
;
460 p2
= (const unsigned long *)s2
;
461 result_p
= (unsigned long *)result
;
463 num_counters
= (sizeof(struct zfpm_stats
) / sizeof(unsigned long));
465 for (i
= 0; i
< num_counters
; i
++) {
466 result_p
[i
] = p1
[i
] + p2
[i
];
473 static inline void zfpm_read_on(void)
475 assert(!zfpm_g
->t_read
);
476 assert(zfpm_g
->sock
>= 0);
478 thread_add_read(zfpm_g
->master
, zfpm_read_cb
, 0, zfpm_g
->sock
,
485 static inline void zfpm_write_on(void)
487 assert(!zfpm_g
->t_write
);
488 assert(zfpm_g
->sock
>= 0);
490 thread_add_write(zfpm_g
->master
, zfpm_write_cb
, 0, zfpm_g
->sock
,
497 static inline void zfpm_read_off(void)
499 thread_cancel(&zfpm_g
->t_read
);
505 static inline void zfpm_write_off(void)
507 thread_cancel(&zfpm_g
->t_write
);
510 static inline void zfpm_connect_off(void)
512 thread_cancel(&zfpm_g
->t_connect
);
516 * zfpm_conn_up_thread_cb
518 * Callback for actions to be taken when the connection to the FPM
521 static int zfpm_conn_up_thread_cb(struct thread
*thread
)
523 struct route_node
*rnode
;
524 struct zfpm_rnodes_iter
*iter
;
527 iter
= &zfpm_g
->t_conn_up_state
.iter
;
529 if (zfpm_g
->state
!= ZFPM_STATE_ESTABLISHED
) {
531 "Connection not up anymore, conn_up thread aborting");
532 zfpm_g
->stats
.t_conn_up_aborts
++;
536 if (!zfpm_g
->fpm_mac_dump_done
) {
537 /* Enqueue FPM updates for all the RMAC entries */
538 hash_iterate(zrouter
.l3vni_table
, zfpm_iterate_rmac_table
,
540 /* mark dump done so that its not repeated after yield */
541 zfpm_g
->fpm_mac_dump_done
= true;
544 while ((rnode
= zfpm_rnodes_iter_next(iter
))) {
545 dest
= rib_dest_from_rnode(rnode
);
548 zfpm_g
->stats
.t_conn_up_dests_processed
++;
549 zfpm_trigger_update(rnode
, NULL
);
555 if (!zfpm_thread_should_yield(thread
))
558 zfpm_g
->stats
.t_conn_up_yields
++;
559 zfpm_rnodes_iter_pause(iter
);
560 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_up_thread_cb
,
561 NULL
, 0, &zfpm_g
->t_conn_up
);
565 zfpm_g
->stats
.t_conn_up_finishes
++;
568 zfpm_rnodes_iter_cleanup(iter
);
575 * Called when the connection to the FPM comes up.
577 static void zfpm_connection_up(const char *detail
)
579 assert(zfpm_g
->sock
>= 0);
582 zfpm_set_state(ZFPM_STATE_ESTABLISHED
, detail
);
585 * Start thread to push existing routes to the FPM.
587 thread_cancel(&zfpm_g
->t_conn_up
);
589 zfpm_rnodes_iter_init(&zfpm_g
->t_conn_up_state
.iter
);
590 zfpm_g
->fpm_mac_dump_done
= false;
592 zfpm_debug("Starting conn_up thread");
594 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_up_thread_cb
, NULL
, 0,
596 zfpm_g
->stats
.t_conn_up_starts
++;
602 * Check if an asynchronous connect() to the FPM is complete.
604 static void zfpm_connect_check(void)
613 slen
= sizeof(status
);
614 ret
= getsockopt(zfpm_g
->sock
, SOL_SOCKET
, SO_ERROR
, (void *)&status
,
617 if (ret
>= 0 && status
== 0) {
618 zfpm_connection_up("async connect complete");
623 * getsockopt() failed or indicated an error on the socket.
628 zfpm_start_connect_timer("getsockopt() after async connect failed");
633 * zfpm_conn_down_thread_cb
635 * Callback that is invoked to clean up state after the TCP connection
636 * to the FPM goes down.
638 static int zfpm_conn_down_thread_cb(struct thread
*thread
)
640 struct route_node
*rnode
;
641 struct zfpm_rnodes_iter
*iter
;
643 struct fpm_mac_info_t
*mac
= NULL
;
645 assert(zfpm_g
->state
== ZFPM_STATE_IDLE
);
648 * Delink and free all fpm_mac_info_t nodes
649 * in the mac_q and fpm_mac_info_hash
651 while ((mac
= TAILQ_FIRST(&zfpm_g
->mac_q
)) != NULL
)
652 zfpm_mac_info_del(mac
);
654 zfpm_g
->t_conn_down
= NULL
;
656 iter
= &zfpm_g
->t_conn_down_state
.iter
;
658 while ((rnode
= zfpm_rnodes_iter_next(iter
))) {
659 dest
= rib_dest_from_rnode(rnode
);
662 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)) {
663 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
,
667 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
668 UNSET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
670 zfpm_g
->stats
.t_conn_down_dests_processed
++;
673 * Check if the dest should be deleted.
681 if (!zfpm_thread_should_yield(thread
))
684 zfpm_g
->stats
.t_conn_down_yields
++;
685 zfpm_rnodes_iter_pause(iter
);
686 zfpm_g
->t_conn_down
= NULL
;
687 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_down_thread_cb
,
688 NULL
, 0, &zfpm_g
->t_conn_down
);
692 zfpm_g
->stats
.t_conn_down_finishes
++;
693 zfpm_rnodes_iter_cleanup(iter
);
696 * Start the process of connecting to the FPM again.
698 zfpm_start_connect_timer("cleanup complete");
703 * zfpm_connection_down
705 * Called when the connection to the FPM has gone down.
707 static void zfpm_connection_down(const char *detail
)
712 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
714 zlog_info("connection to the FPM has gone down: %s", detail
);
719 stream_reset(zfpm_g
->ibuf
);
720 stream_reset(zfpm_g
->obuf
);
722 if (zfpm_g
->sock
>= 0) {
728 * Start thread to clean up state after the connection goes down.
730 assert(!zfpm_g
->t_conn_down
);
731 zfpm_rnodes_iter_init(&zfpm_g
->t_conn_down_state
.iter
);
732 zfpm_g
->t_conn_down
= NULL
;
733 thread_add_timer_msec(zfpm_g
->master
, zfpm_conn_down_thread_cb
, NULL
, 0,
734 &zfpm_g
->t_conn_down
);
735 zfpm_g
->stats
.t_conn_down_starts
++;
737 zfpm_set_state(ZFPM_STATE_IDLE
, detail
);
743 static int zfpm_read_cb(struct thread
*thread
)
750 zfpm_g
->stats
.read_cb_calls
++;
753 * Check if async connect is now done.
755 if (zfpm_g
->state
== ZFPM_STATE_CONNECTING
) {
756 zfpm_connect_check();
760 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
761 assert(zfpm_g
->sock
>= 0);
765 already
= stream_get_endp(ibuf
);
766 if (already
< FPM_MSG_HDR_LEN
) {
769 nbyte
= stream_read_try(ibuf
, zfpm_g
->sock
,
770 FPM_MSG_HDR_LEN
- already
);
771 if (nbyte
== 0 || nbyte
== -1) {
775 snprintf(buffer
, sizeof(buffer
),
776 "closed socket in read(%d): %s", errno
,
777 safe_strerror(errno
));
778 zfpm_connection_down(buffer
);
780 zfpm_connection_down("closed socket in read");
784 if (nbyte
!= (ssize_t
)(FPM_MSG_HDR_LEN
- already
))
787 already
= FPM_MSG_HDR_LEN
;
790 stream_set_getp(ibuf
, 0);
792 hdr
= (fpm_msg_hdr_t
*)stream_pnt(ibuf
);
794 if (!fpm_msg_hdr_ok(hdr
)) {
795 zfpm_connection_down("invalid message header");
799 msg_len
= fpm_msg_len(hdr
);
802 * Read out the rest of the packet.
804 if (already
< msg_len
) {
807 nbyte
= stream_read_try(ibuf
, zfpm_g
->sock
, msg_len
- already
);
809 if (nbyte
== 0 || nbyte
== -1) {
813 snprintf(buffer
, sizeof(buffer
),
814 "failed to read message(%d) %s", errno
,
815 safe_strerror(errno
));
816 zfpm_connection_down(buffer
);
818 zfpm_connection_down("failed to read message");
822 if (nbyte
!= (ssize_t
)(msg_len
- already
))
827 * Just throw it away for now.
836 static bool zfpm_updates_pending(void)
838 if (!(TAILQ_EMPTY(&zfpm_g
->dest_q
)) || !(TAILQ_EMPTY(&zfpm_g
->mac_q
)))
845 * zfpm_writes_pending
847 * Returns true if we may have something to write to the FPM.
849 static int zfpm_writes_pending(void)
853 * Check if there is any data in the outbound buffer that has not
854 * been written to the socket yet.
856 if (stream_get_endp(zfpm_g
->obuf
) - stream_get_getp(zfpm_g
->obuf
))
860 * Check if there are any updates scheduled on the outbound queues.
862 if (zfpm_updates_pending())
871 * Encode a message to the FPM with information about the given route.
873 * Returns the number of bytes written to the buffer. 0 or a negative
874 * value indicates an error.
876 static inline int zfpm_encode_route(rib_dest_t
*dest
, struct route_entry
*re
,
877 char *in_buf
, size_t in_buf_len
,
878 fpm_msg_type_e
*msg_type
)
886 *msg_type
= FPM_MSG_TYPE_NONE
;
888 switch (zfpm_g
->message_format
) {
890 case ZFPM_MSG_FORMAT_PROTOBUF
:
892 len
= zfpm_protobuf_encode_route(dest
, re
, (uint8_t *)in_buf
,
894 *msg_type
= FPM_MSG_TYPE_PROTOBUF
;
898 case ZFPM_MSG_FORMAT_NETLINK
:
900 *msg_type
= FPM_MSG_TYPE_NETLINK
;
901 cmd
= re
? RTM_NEWROUTE
: RTM_DELROUTE
;
902 len
= zfpm_netlink_encode_route(cmd
, dest
, re
, in_buf
,
904 assert(fpm_msg_align(len
) == len
);
905 *msg_type
= FPM_MSG_TYPE_NETLINK
;
906 #endif /* HAVE_NETLINK */
917 * zfpm_route_for_update
919 * Returns the re that is to be sent to the FPM for a given dest.
921 struct route_entry
*zfpm_route_for_update(rib_dest_t
*dest
)
923 return dest
->selected_fib
;
927 * Define an enum for return codes for queue processing functions
929 * FPM_WRITE_STOP: This return code indicates that the write buffer is full.
930 * Stop processing all the queues and empty the buffer by writing its content
933 * FPM_GOTO_NEXT_Q: This return code indicates that either this queue is
934 * empty or we have processed enough updates from this queue.
935 * So, move on to the next queue.
942 #define FPM_QUEUE_PROCESS_LIMIT 10000
945 * zfpm_build_route_updates
947 * Process the dest_q queue and write FPM messages to the outbound buffer.
949 static int zfpm_build_route_updates(void)
953 unsigned char *buf
, *data
, *buf_end
;
957 struct route_entry
*re
;
958 int is_add
, write_msg
;
959 fpm_msg_type_e msg_type
;
962 if (TAILQ_EMPTY(&zfpm_g
->dest_q
))
963 return FPM_GOTO_NEXT_Q
;
966 q_limit
= FPM_QUEUE_PROCESS_LIMIT
;
970 * Make sure there is enough space to write another message.
972 if (STREAM_WRITEABLE(s
) < FPM_MAX_MSG_LEN
)
973 return FPM_WRITE_STOP
;
975 buf
= STREAM_DATA(s
) + stream_get_endp(s
);
976 buf_end
= buf
+ STREAM_WRITEABLE(s
);
978 dest
= TAILQ_FIRST(&zfpm_g
->dest_q
);
980 return FPM_GOTO_NEXT_Q
;
982 assert(CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
));
984 hdr
= (fpm_msg_hdr_t
*)buf
;
985 hdr
->version
= FPM_PROTO_VERSION
;
987 data
= fpm_msg_data(hdr
);
989 re
= zfpm_route_for_update(dest
);
995 * If this is a route deletion, and we have not sent the route
997 * the FPM previously, skip it.
999 if (!is_add
&& !CHECK_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
)) {
1001 zfpm_g
->stats
.nop_deletes_skipped
++;
1005 data_len
= zfpm_encode_route(dest
, re
, (char *)data
,
1006 buf_end
- data
, &msg_type
);
1009 hdr
->msg_type
= msg_type
;
1010 msg_len
= fpm_data_len_to_msg_len(data_len
);
1011 hdr
->msg_len
= htons(msg_len
);
1012 stream_forward_endp(s
, msg_len
);
1015 zfpm_g
->stats
.route_adds
++;
1017 zfpm_g
->stats
.route_dels
++;
1019 zlog_err("%s: Encoding Prefix: %pRN No valid nexthops",
1020 __func__
, dest
->rnode
);
1025 * Remove the dest from the queue, and reset the flag.
1027 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1028 TAILQ_REMOVE(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1031 SET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
1033 UNSET_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
);
1037 * Delete the destination if necessary.
1039 if (rib_gc_dest(dest
->rnode
))
1040 zfpm_g
->stats
.dests_del_after_update
++;
1045 * We have processed enough updates in this queue.
1046 * Now yield for other queues.
1048 return FPM_GOTO_NEXT_Q
;
1056 * Encode a message to FPM with information about the given MAC.
1058 * Returns the number of bytes written to the buffer.
1060 static inline int zfpm_encode_mac(struct fpm_mac_info_t
*mac
, char *in_buf
,
1061 size_t in_buf_len
, fpm_msg_type_e
*msg_type
)
1065 *msg_type
= FPM_MSG_TYPE_NONE
;
1067 switch (zfpm_g
->message_format
) {
1069 case ZFPM_MSG_FORMAT_NONE
:
1071 case ZFPM_MSG_FORMAT_NETLINK
:
1073 len
= zfpm_netlink_encode_mac(mac
, in_buf
, in_buf_len
);
1074 assert(fpm_msg_align(len
) == len
);
1075 *msg_type
= FPM_MSG_TYPE_NETLINK
;
1076 #endif /* HAVE_NETLINK */
1078 case ZFPM_MSG_FORMAT_PROTOBUF
:
1084 static int zfpm_build_mac_updates(void)
1087 struct fpm_mac_info_t
*mac
;
1088 unsigned char *buf
, *data
, *buf_end
;
1090 size_t data_len
, msg_len
;
1091 fpm_msg_type_e msg_type
;
1094 if (TAILQ_EMPTY(&zfpm_g
->mac_q
))
1095 return FPM_GOTO_NEXT_Q
;
1098 q_limit
= FPM_QUEUE_PROCESS_LIMIT
;
1101 /* Make sure there is enough space to write another message. */
1102 if (STREAM_WRITEABLE(s
) < FPM_MAX_MAC_MSG_LEN
)
1103 return FPM_WRITE_STOP
;
1105 buf
= STREAM_DATA(s
) + stream_get_endp(s
);
1106 buf_end
= buf
+ STREAM_WRITEABLE(s
);
1108 mac
= TAILQ_FIRST(&zfpm_g
->mac_q
);
1110 return FPM_GOTO_NEXT_Q
;
1112 /* Check for no-op */
1113 if (!CHECK_FLAG(mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
)) {
1114 zfpm_g
->stats
.nop_deletes_skipped
++;
1115 zfpm_mac_info_del(mac
);
1119 hdr
= (fpm_msg_hdr_t
*)buf
;
1120 hdr
->version
= FPM_PROTO_VERSION
;
1122 data
= fpm_msg_data(hdr
);
1123 data_len
= zfpm_encode_mac(mac
, (char *)data
, buf_end
- data
,
1127 hdr
->msg_type
= msg_type
;
1128 msg_len
= fpm_data_len_to_msg_len(data_len
);
1129 hdr
->msg_len
= htons(msg_len
);
1130 stream_forward_endp(s
, msg_len
);
1132 /* Remove the MAC from the queue, and delete it. */
1133 zfpm_mac_info_del(mac
);
1138 * We have processed enough updates in this queue.
1139 * Now yield for other queues.
1141 return FPM_GOTO_NEXT_Q
;
1147 * zfpm_build_updates
1149 * Process the outgoing queues and write messages to the outbound
1152 static void zfpm_build_updates(void)
1157 assert(stream_empty(s
));
1161 * Stop processing the queues if zfpm_g->obuf is full
1162 * or we do not have more updates to process
1164 if (zfpm_build_mac_updates() == FPM_WRITE_STOP
)
1166 if (zfpm_build_route_updates() == FPM_WRITE_STOP
)
1168 } while (zfpm_updates_pending());
1174 static int zfpm_write_cb(struct thread
*thread
)
1179 zfpm_g
->stats
.write_cb_calls
++;
1182 * Check if async connect is now done.
1184 if (zfpm_g
->state
== ZFPM_STATE_CONNECTING
) {
1185 zfpm_connect_check();
1189 assert(zfpm_g
->state
== ZFPM_STATE_ESTABLISHED
);
1190 assert(zfpm_g
->sock
>= 0);
1195 int bytes_to_write
, bytes_written
;
1200 * If the stream is empty, try fill it up with data.
1202 if (stream_empty(s
)) {
1203 zfpm_build_updates();
1206 bytes_to_write
= stream_get_endp(s
) - stream_get_getp(s
);
1207 if (!bytes_to_write
)
1211 write(zfpm_g
->sock
, stream_pnt(s
), bytes_to_write
);
1212 zfpm_g
->stats
.write_calls
++;
1215 if (bytes_written
< 0) {
1216 if (ERRNO_IO_RETRY(errno
))
1219 zfpm_connection_down("failed to write to socket");
1223 if (bytes_written
!= bytes_to_write
) {
1228 stream_forward_getp(s
, bytes_written
);
1229 zfpm_g
->stats
.partial_writes
++;
1234 * We've written out the entire contents of the stream.
1238 if (num_writes
>= ZFPM_MAX_WRITES_PER_RUN
) {
1239 zfpm_g
->stats
.max_writes_hit
++;
1243 if (zfpm_thread_should_yield(thread
)) {
1244 zfpm_g
->stats
.t_write_yields
++;
1249 if (zfpm_writes_pending())
1258 static int zfpm_connect_cb(struct thread
*t
)
1261 struct sockaddr_in serv
;
1263 assert(zfpm_g
->state
== ZFPM_STATE_ACTIVE
);
1265 sock
= socket(AF_INET
, SOCK_STREAM
, 0);
1267 zlog_err("Failed to create socket for connect(): %s",
1269 zfpm_g
->stats
.connect_no_sock
++;
1273 set_nonblocking(sock
);
1275 /* Make server socket. */
1276 memset(&serv
, 0, sizeof(serv
));
1277 serv
.sin_family
= AF_INET
;
1278 serv
.sin_port
= htons(zfpm_g
->fpm_port
);
1279 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
1280 serv
.sin_len
= sizeof(struct sockaddr_in
);
1281 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
1282 if (!zfpm_g
->fpm_server
)
1283 serv
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
1285 serv
.sin_addr
.s_addr
= (zfpm_g
->fpm_server
);
1288 * Connect to the FPM.
1290 zfpm_g
->connect_calls
++;
1291 zfpm_g
->stats
.connect_calls
++;
1292 zfpm_g
->last_connect_call_time
= monotime(NULL
);
1294 ret
= connect(sock
, (struct sockaddr
*)&serv
, sizeof(serv
));
1296 zfpm_g
->sock
= sock
;
1297 zfpm_connection_up("connect succeeded");
1301 if (errno
== EINPROGRESS
) {
1302 zfpm_g
->sock
= sock
;
1305 zfpm_set_state(ZFPM_STATE_CONNECTING
,
1306 "async connect in progress");
1310 zlog_info("can't connect to FPM %d: %s", sock
, safe_strerror(errno
));
1314 * Restart timer for retrying connection.
1316 zfpm_start_connect_timer("connect() failed");
1323 * Move state machine into the given state.
1325 static void zfpm_set_state(enum zfpm_state state
, const char *reason
)
1327 enum zfpm_state cur_state
= zfpm_g
->state
;
1332 if (state
== cur_state
)
1335 zfpm_debug("beginning state transition %s -> %s. Reason: %s",
1336 zfpm_state_to_str(cur_state
), zfpm_state_to_str(state
),
1341 case ZFPM_STATE_IDLE
:
1342 assert(cur_state
== ZFPM_STATE_ESTABLISHED
);
1345 case ZFPM_STATE_ACTIVE
:
1346 assert(cur_state
== ZFPM_STATE_IDLE
1347 || cur_state
== ZFPM_STATE_CONNECTING
);
1348 assert(zfpm_g
->t_connect
);
1351 case ZFPM_STATE_CONNECTING
:
1352 assert(zfpm_g
->sock
);
1353 assert(cur_state
== ZFPM_STATE_ACTIVE
);
1354 assert(zfpm_g
->t_read
);
1355 assert(zfpm_g
->t_write
);
1358 case ZFPM_STATE_ESTABLISHED
:
1359 assert(cur_state
== ZFPM_STATE_ACTIVE
1360 || cur_state
== ZFPM_STATE_CONNECTING
);
1361 assert(zfpm_g
->sock
);
1362 assert(zfpm_g
->t_read
);
1363 assert(zfpm_g
->t_write
);
1367 zfpm_g
->state
= state
;
1371 * zfpm_calc_connect_delay
1373 * Returns the number of seconds after which we should attempt to
1374 * reconnect to the FPM.
1376 static long zfpm_calc_connect_delay(void)
1381 * Return 0 if this is our first attempt to connect.
1383 if (zfpm_g
->connect_calls
== 0) {
1387 elapsed
= zfpm_get_elapsed_time(zfpm_g
->last_connect_call_time
);
1389 if (elapsed
> ZFPM_CONNECT_RETRY_IVL
) {
1393 return ZFPM_CONNECT_RETRY_IVL
- elapsed
;
1397 * zfpm_start_connect_timer
1399 static void zfpm_start_connect_timer(const char *reason
)
1403 assert(!zfpm_g
->t_connect
);
1404 assert(zfpm_g
->sock
< 0);
1406 assert(zfpm_g
->state
== ZFPM_STATE_IDLE
1407 || zfpm_g
->state
== ZFPM_STATE_ACTIVE
1408 || zfpm_g
->state
== ZFPM_STATE_CONNECTING
);
1410 delay_secs
= zfpm_calc_connect_delay();
1411 zfpm_debug("scheduling connect in %ld seconds", delay_secs
);
1413 thread_add_timer(zfpm_g
->master
, zfpm_connect_cb
, 0, delay_secs
,
1414 &zfpm_g
->t_connect
);
1415 zfpm_set_state(ZFPM_STATE_ACTIVE
, reason
);
1421 * Returns true if the zebra FPM module has been enabled.
1423 static inline int zfpm_is_enabled(void)
1425 return zfpm_g
->enabled
;
1431 * Returns true if the connection to the FPM is up.
1433 static inline int zfpm_conn_is_up(void)
1435 if (zfpm_g
->state
!= ZFPM_STATE_ESTABLISHED
)
1438 assert(zfpm_g
->sock
>= 0);
1444 * zfpm_trigger_update
1446 * The zebra code invokes this function to indicate that we should
1447 * send an update to the FPM about the given route_node.
1449 static int zfpm_trigger_update(struct route_node
*rn
, const char *reason
)
1454 * Ignore if the connection is down. We will update the FPM about
1455 * all destinations once the connection comes up.
1457 if (!zfpm_conn_is_up())
1460 dest
= rib_dest_from_rnode(rn
);
1462 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)) {
1463 zfpm_g
->stats
.redundant_triggers
++;
1468 zfpm_debug("%pFX triggering update to FPM - Reason: %s", &rn
->p
,
1472 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
);
1473 TAILQ_INSERT_TAIL(&zfpm_g
->dest_q
, dest
, fpm_q_entries
);
1474 zfpm_g
->stats
.updates_triggered
++;
1477 * Make sure that writes are enabled.
1479 if (zfpm_g
->t_write
)
1487 * Generate Key for FPM MAC info hash entry
1489 static unsigned int zfpm_mac_info_hash_keymake(const void *p
)
1491 struct fpm_mac_info_t
*fpm_mac
= (struct fpm_mac_info_t
*)p
;
1494 mac_key
= jhash(fpm_mac
->macaddr
.octet
, ETH_ALEN
, 0xa5a5a55a);
1496 return jhash_2words(mac_key
, fpm_mac
->vni
, 0);
1500 * Compare function for FPM MAC info hash lookup
1502 static bool zfpm_mac_info_cmp(const void *p1
, const void *p2
)
1504 const struct fpm_mac_info_t
*fpm_mac1
= p1
;
1505 const struct fpm_mac_info_t
*fpm_mac2
= p2
;
1507 if (memcmp(fpm_mac1
->macaddr
.octet
, fpm_mac2
->macaddr
.octet
, ETH_ALEN
)
1510 if (fpm_mac1
->vni
!= fpm_mac2
->vni
)
1517 * Lookup FPM MAC info hash entry.
1519 static struct fpm_mac_info_t
*zfpm_mac_info_lookup(struct fpm_mac_info_t
*key
)
1521 return hash_lookup(zfpm_g
->fpm_mac_info_table
, key
);
1525 * Callback to allocate fpm_mac_info_t structure.
1527 static void *zfpm_mac_info_alloc(void *p
)
1529 const struct fpm_mac_info_t
*key
= p
;
1530 struct fpm_mac_info_t
*fpm_mac
;
1532 fpm_mac
= XCALLOC(MTYPE_FPM_MAC_INFO
, sizeof(struct fpm_mac_info_t
));
1534 memcpy(&fpm_mac
->macaddr
, &key
->macaddr
, ETH_ALEN
);
1535 fpm_mac
->vni
= key
->vni
;
1537 return (void *)fpm_mac
;
1541 * Delink and free fpm_mac_info_t.
1543 static void zfpm_mac_info_del(struct fpm_mac_info_t
*fpm_mac
)
1545 hash_release(zfpm_g
->fpm_mac_info_table
, fpm_mac
);
1546 TAILQ_REMOVE(&zfpm_g
->mac_q
, fpm_mac
, fpm_mac_q_entries
);
1547 XFREE(MTYPE_FPM_MAC_INFO
, fpm_mac
);
1551 * zfpm_trigger_rmac_update
1553 * Zebra code invokes this function to indicate that we should
1554 * send an update to FPM for given MAC entry.
1556 * This function checks if we already have enqueued an update for this RMAC,
1557 * If yes, update the same fpm_mac_info_t. Else, create and enqueue an update.
1559 static int zfpm_trigger_rmac_update(struct zebra_mac
*rmac
,
1560 struct zebra_l3vni
*zl3vni
, bool delete,
1563 struct fpm_mac_info_t
*fpm_mac
, key
;
1564 struct interface
*vxlan_if
, *svi_if
;
1565 bool mac_found
= false;
1568 * Ignore if the connection is down. We will update the FPM about
1569 * all destinations once the connection comes up.
1571 if (!zfpm_conn_is_up())
1575 zfpm_debug("triggering update to FPM - Reason: %s - %pEA",
1576 reason
, &rmac
->macaddr
);
1579 vxlan_if
= zl3vni_map_to_vxlan_if(zl3vni
);
1580 svi_if
= zl3vni_map_to_svi_if(zl3vni
);
1582 memset(&key
, 0, sizeof(struct fpm_mac_info_t
));
1584 memcpy(&key
.macaddr
, &rmac
->macaddr
, ETH_ALEN
);
1585 key
.vni
= zl3vni
->vni
;
1587 /* Check if this MAC is already present in the queue. */
1588 fpm_mac
= zfpm_mac_info_lookup(&key
);
1594 * If the enqueued op is "add" and current op is "delete",
1595 * this is a noop. So, Unset ZEBRA_MAC_UPDATE_FPM flag.
1596 * While processing FPM queue, we will silently delete this
1597 * MAC entry without sending any update for this MAC.
1599 if (!CHECK_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
) &&
1601 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1602 UNSET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
);
1606 fpm_mac
= hash_get(zfpm_g
->fpm_mac_info_table
, &key
,
1607 zfpm_mac_info_alloc
);
1612 fpm_mac
->r_vtep_ip
.s_addr
= rmac
->fwd_info
.r_vtep_ip
.s_addr
;
1613 fpm_mac
->zebra_flags
= rmac
->flags
;
1614 fpm_mac
->vxlan_if
= vxlan_if
? vxlan_if
->ifindex
: 0;
1615 fpm_mac
->svi_if
= svi_if
? svi_if
->ifindex
: 0;
1617 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_UPDATE_FPM
);
1619 SET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1621 UNSET_FLAG(fpm_mac
->fpm_flags
, ZEBRA_MAC_DELETE_FPM
);
1624 TAILQ_INSERT_TAIL(&zfpm_g
->mac_q
, fpm_mac
, fpm_mac_q_entries
);
1626 zfpm_g
->stats
.updates_triggered
++;
1628 /* If writes are already enabled, return. */
1629 if (zfpm_g
->t_write
)
1637 * This function is called when the FPM connections is established.
1638 * Iterate over all the RMAC entries for the given L3VNI
1639 * and enqueue the RMAC for FPM processing.
1641 static void zfpm_trigger_rmac_update_wrapper(struct hash_bucket
*bucket
,
1644 struct zebra_mac
*zrmac
= (struct zebra_mac
*)bucket
->data
;
1645 struct zebra_l3vni
*zl3vni
= (struct zebra_l3vni
*)args
;
1647 zfpm_trigger_rmac_update(zrmac
, zl3vni
, false, "RMAC added");
1651 * This function is called when the FPM connections is established.
1652 * This function iterates over all the L3VNIs to trigger
1653 * FPM updates for RMACs currently available.
1655 static void zfpm_iterate_rmac_table(struct hash_bucket
*bucket
, void *args
)
1657 struct zebra_l3vni
*zl3vni
= (struct zebra_l3vni
*)bucket
->data
;
1659 hash_iterate(zl3vni
->rmac_table
, zfpm_trigger_rmac_update_wrapper
,
1664 * struct zfpm_statsimer_cb
1666 static int zfpm_stats_timer_cb(struct thread
*t
)
1668 zfpm_g
->t_stats
= NULL
;
1671 * Remember the stats collected in the last interval for display
1674 zfpm_stats_copy(&zfpm_g
->stats
, &zfpm_g
->last_ivl_stats
);
1677 * Add the current set of stats into the cumulative statistics.
1679 zfpm_stats_compose(&zfpm_g
->cumulative_stats
, &zfpm_g
->stats
,
1680 &zfpm_g
->cumulative_stats
);
1683 * Start collecting stats afresh over the next interval.
1685 zfpm_stats_reset(&zfpm_g
->stats
);
1687 zfpm_start_stats_timer();
1693 * zfpm_stop_stats_timer
1695 static void zfpm_stop_stats_timer(void)
1697 if (!zfpm_g
->t_stats
)
1700 zfpm_debug("Stopping existing stats timer");
1701 thread_cancel(&zfpm_g
->t_stats
);
1705 * zfpm_start_stats_timer
1707 void zfpm_start_stats_timer(void)
1709 assert(!zfpm_g
->t_stats
);
1711 thread_add_timer(zfpm_g
->master
, zfpm_stats_timer_cb
, 0,
1712 ZFPM_STATS_IVL_SECS
, &zfpm_g
->t_stats
);
1716 * Helper macro for zfpm_show_stats() below.
1718 #define ZFPM_SHOW_STAT(counter) \
1720 vty_out(vty, "%-40s %10lu %16lu\n", #counter, \
1721 total_stats.counter, zfpm_g->last_ivl_stats.counter); \
1727 static void zfpm_show_stats(struct vty
*vty
)
1729 struct zfpm_stats total_stats
;
1732 vty_out(vty
, "\n%-40s %10s Last %2d secs\n\n", "Counter", "Total",
1733 ZFPM_STATS_IVL_SECS
);
1736 * Compute the total stats up to this instant.
1738 zfpm_stats_compose(&zfpm_g
->cumulative_stats
, &zfpm_g
->stats
,
1741 ZFPM_SHOW_STAT(connect_calls
);
1742 ZFPM_SHOW_STAT(connect_no_sock
);
1743 ZFPM_SHOW_STAT(read_cb_calls
);
1744 ZFPM_SHOW_STAT(write_cb_calls
);
1745 ZFPM_SHOW_STAT(write_calls
);
1746 ZFPM_SHOW_STAT(partial_writes
);
1747 ZFPM_SHOW_STAT(max_writes_hit
);
1748 ZFPM_SHOW_STAT(t_write_yields
);
1749 ZFPM_SHOW_STAT(nop_deletes_skipped
);
1750 ZFPM_SHOW_STAT(route_adds
);
1751 ZFPM_SHOW_STAT(route_dels
);
1752 ZFPM_SHOW_STAT(updates_triggered
);
1753 ZFPM_SHOW_STAT(redundant_triggers
);
1754 ZFPM_SHOW_STAT(dests_del_after_update
);
1755 ZFPM_SHOW_STAT(t_conn_down_starts
);
1756 ZFPM_SHOW_STAT(t_conn_down_dests_processed
);
1757 ZFPM_SHOW_STAT(t_conn_down_yields
);
1758 ZFPM_SHOW_STAT(t_conn_down_finishes
);
1759 ZFPM_SHOW_STAT(t_conn_up_starts
);
1760 ZFPM_SHOW_STAT(t_conn_up_dests_processed
);
1761 ZFPM_SHOW_STAT(t_conn_up_yields
);
1762 ZFPM_SHOW_STAT(t_conn_up_aborts
);
1763 ZFPM_SHOW_STAT(t_conn_up_finishes
);
1765 if (!zfpm_g
->last_stats_clear_time
)
1768 elapsed
= zfpm_get_elapsed_time(zfpm_g
->last_stats_clear_time
);
1770 vty_out(vty
, "\nStats were cleared %lu seconds ago\n",
1771 (unsigned long)elapsed
);
1777 static void zfpm_clear_stats(struct vty
*vty
)
1779 if (!zfpm_is_enabled()) {
1780 vty_out(vty
, "The FPM module is not enabled...\n");
1784 zfpm_stats_reset(&zfpm_g
->stats
);
1785 zfpm_stats_reset(&zfpm_g
->last_ivl_stats
);
1786 zfpm_stats_reset(&zfpm_g
->cumulative_stats
);
1788 zfpm_stop_stats_timer();
1789 zfpm_start_stats_timer();
1791 zfpm_g
->last_stats_clear_time
= monotime(NULL
);
1793 vty_out(vty
, "Cleared FPM stats\n");
1797 * show_zebra_fpm_stats
1799 DEFUN (show_zebra_fpm_stats
,
1800 show_zebra_fpm_stats_cmd
,
1801 "show zebra fpm stats",
1804 "Forwarding Path Manager information\n"
1807 zfpm_show_stats(vty
);
1812 * clear_zebra_fpm_stats
1814 DEFUN (clear_zebra_fpm_stats
,
1815 clear_zebra_fpm_stats_cmd
,
1816 "clear zebra fpm stats",
1819 "Clear Forwarding Path Manager information\n"
1822 zfpm_clear_stats(vty
);
1827 * update fpm connection information
1829 DEFUN ( fpm_remote_ip
,
1831 "fpm connection ip A.B.C.D port (1-65535)",
1832 "fpm connection remote ip and port\n"
1833 "Remote fpm server ip A.B.C.D\n"
1837 in_addr_t fpm_server
;
1840 fpm_server
= inet_addr(argv
[3]->arg
);
1841 if (fpm_server
== INADDR_NONE
)
1842 return CMD_ERR_INCOMPLETE
;
1844 port_no
= atoi(argv
[5]->arg
);
1845 if (port_no
< TCP_MIN_PORT
|| port_no
> TCP_MAX_PORT
)
1846 return CMD_ERR_INCOMPLETE
;
1848 zfpm_g
->fpm_server
= fpm_server
;
1849 zfpm_g
->fpm_port
= port_no
;
1855 DEFUN ( no_fpm_remote_ip
,
1856 no_fpm_remote_ip_cmd
,
1857 "no fpm connection ip A.B.C.D port (1-65535)",
1858 "fpm connection remote ip and port\n"
1860 "Remote fpm server ip A.B.C.D\n"
1863 if (zfpm_g
->fpm_server
!= inet_addr(argv
[4]->arg
)
1864 || zfpm_g
->fpm_port
!= atoi(argv
[6]->arg
))
1865 return CMD_ERR_NO_MATCH
;
1867 zfpm_g
->fpm_server
= FPM_DEFAULT_IP
;
1868 zfpm_g
->fpm_port
= FPM_DEFAULT_PORT
;
1874 * zfpm_init_message_format
1876 static inline void zfpm_init_message_format(const char *format
)
1878 int have_netlink
, have_protobuf
;
1886 #ifdef HAVE_PROTOBUF
1892 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NONE
;
1896 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NETLINK
;
1897 } else if (have_protobuf
) {
1898 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_PROTOBUF
;
1903 if (!strcmp("netlink", format
)) {
1904 if (!have_netlink
) {
1905 flog_err(EC_ZEBRA_NETLINK_NOT_AVAILABLE
,
1906 "FPM netlink message format is not available");
1909 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_NETLINK
;
1913 if (!strcmp("protobuf", format
)) {
1914 if (!have_protobuf
) {
1916 EC_ZEBRA_PROTOBUF_NOT_AVAILABLE
,
1917 "FPM protobuf message format is not available");
1920 flog_warn(EC_ZEBRA_PROTOBUF_NOT_AVAILABLE
,
1921 "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.");
1922 zfpm_g
->message_format
= ZFPM_MSG_FORMAT_PROTOBUF
;
1926 flog_warn(EC_ZEBRA_FPM_FORMAT_UNKNOWN
, "Unknown fpm format '%s'",
1931 * fpm_remote_srv_write
1933 * Module to write remote fpm connection
1935 * Returns ZERO on success.
1938 static int fpm_remote_srv_write(struct vty
*vty
)
1942 in
.s_addr
= zfpm_g
->fpm_server
;
1944 if ((zfpm_g
->fpm_server
!= FPM_DEFAULT_IP
1945 && zfpm_g
->fpm_server
!= INADDR_ANY
)
1946 || (zfpm_g
->fpm_port
!= FPM_DEFAULT_PORT
&& zfpm_g
->fpm_port
!= 0))
1947 vty_out(vty
, "fpm connection ip %pI4 port %d\n", &in
,
1954 static int fpm_remote_srv_write(struct vty
*vty
);
1956 static struct cmd_node zebra_node
= {
1959 .parent_node
= CONFIG_NODE
,
1961 .config_write
= fpm_remote_srv_write
,
1968 * One-time initialization of the Zebra FPM module.
1970 * @param[in] port port at which FPM is running.
1971 * @param[in] enable true if the zebra FPM module should be enabled
1972 * @param[in] format to use to talk to the FPM. Can be 'netink' or 'protobuf'.
1974 * Returns true on success.
1976 static int zfpm_init(struct thread_master
*master
)
1980 const char *format
= THIS_MODULE
->load_args
;
1982 memset(zfpm_g
, 0, sizeof(*zfpm_g
));
1983 zfpm_g
->master
= master
;
1984 TAILQ_INIT(&zfpm_g
->dest_q
);
1985 TAILQ_INIT(&zfpm_g
->mac_q
);
1987 /* Create hash table for fpm_mac_info_t enties */
1988 zfpm_g
->fpm_mac_info_table
= hash_create(zfpm_mac_info_hash_keymake
,
1990 "FPM MAC info hash table");
1993 zfpm_g
->state
= ZFPM_STATE_IDLE
;
1995 zfpm_stats_init(&zfpm_g
->stats
);
1996 zfpm_stats_init(&zfpm_g
->last_ivl_stats
);
1997 zfpm_stats_init(&zfpm_g
->cumulative_stats
);
1999 memset(&ipv4ll_gateway
, 0, sizeof(ipv4ll_gateway
));
2000 if (inet_pton(AF_INET
, ipv4_ll_buf
, &ipv4ll_gateway
.ipv4
) != 1)
2001 zlog_warn("inet_pton failed for %s", ipv4_ll_buf
);
2003 install_node(&zebra_node
);
2004 install_element(ENABLE_NODE
, &show_zebra_fpm_stats_cmd
);
2005 install_element(ENABLE_NODE
, &clear_zebra_fpm_stats_cmd
);
2006 install_element(CONFIG_NODE
, &fpm_remote_ip_cmd
);
2007 install_element(CONFIG_NODE
, &no_fpm_remote_ip_cmd
);
2009 zfpm_init_message_format(format
);
2012 * Disable FPM interface if no suitable format is available.
2014 if (zfpm_g
->message_format
== ZFPM_MSG_FORMAT_NONE
)
2017 zfpm_g
->enabled
= enable
;
2019 if (!zfpm_g
->fpm_server
)
2020 zfpm_g
->fpm_server
= FPM_DEFAULT_IP
;
2023 port
= FPM_DEFAULT_PORT
;
2025 zfpm_g
->fpm_port
= port
;
2027 zfpm_g
->obuf
= stream_new(ZFPM_OBUF_SIZE
);
2028 zfpm_g
->ibuf
= stream_new(ZFPM_IBUF_SIZE
);
2030 zfpm_start_stats_timer();
2031 zfpm_start_connect_timer("initialized");
2035 static int zfpm_fini(void)
2041 zfpm_stop_stats_timer();
2043 hook_unregister(rib_update
, zfpm_trigger_update
);
2047 static int zebra_fpm_module_init(void)
2049 hook_register(rib_update
, zfpm_trigger_update
);
2050 hook_register(zebra_rmac_update
, zfpm_trigger_rmac_update
);
2051 hook_register(frr_late_init
, zfpm_init
);
2052 hook_register(frr_early_fini
, zfpm_fini
);
2056 FRR_MODULE_SETUP(.name
= "zebra_fpm", .version
= FRR_VERSION
,
2057 .description
= "zebra FPM (Forwarding Plane Manager) module",
2058 .init
= zebra_fpm_module_init
,