4 * Copyright (C) 1997-1999 Kunihiro Ishiguro
5 * Copyright (C) 2015-2018 Cumulus Networks, Inc.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along
19 * with this program; see the file COPYING; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 /* clang-format off */
26 #include <errno.h> /* for errno */
27 #include <netinet/in.h> /* for sockaddr_in */
28 #include <stdint.h> /* for uint8_t */
29 #include <stdio.h> /* for snprintf */
30 #include <sys/socket.h> /* for sockaddr_storage, AF_UNIX, accept... */
31 #include <sys/stat.h> /* for umask, mode_t */
32 #include <sys/un.h> /* for sockaddr_un */
33 #include <time.h> /* for NULL, tm, gmtime, time_t */
34 #include <unistd.h> /* for close, unlink, ssize_t */
36 #include "lib/buffer.h" /* for BUFFER_EMPTY, BUFFER_ERROR, BUFFE... */
37 #include "lib/command.h" /* for vty, install_element, CMD_SUCCESS... */
38 #include "lib/hook.h" /* for DEFINE_HOOK, DEFINE_KOOH, hook_call */
39 #include "lib/linklist.h" /* for ALL_LIST_ELEMENTS_RO, ALL_LIST_EL... */
40 #include "lib/libfrr.h" /* for frr_zclient_addr */
41 #include "lib/log.h" /* for zlog_warn, zlog_debug, safe_strerror */
42 #include "lib/memory.h" /* for MTYPE_TMP, XCALLOC, XFREE */
43 #include "lib/monotime.h" /* for monotime, ONE_DAY_SECOND, ONE_WEE... */
44 #include "lib/network.h" /* for set_nonblocking */
45 #include "lib/privs.h" /* for zebra_privs_t, ZPRIVS_LOWER, ZPRI... */
46 #include "lib/route_types.h" /* for ZEBRA_ROUTE_MAX */
47 #include "lib/sockopt.h" /* for setsockopt_so_recvbuf, setsockopt... */
48 #include "lib/sockunion.h" /* for sockopt_reuseaddr, sockopt_reuseport */
49 #include "lib/stream.h" /* for STREAM_SIZE, stream (ptr only), ... */
50 #include "lib/thread.h" /* for thread (ptr only), THREAD_ARG, ... */
51 #include "lib/vrf.h" /* for vrf_info_lookup, VRF_DEFAULT */
52 #include "lib/vty.h" /* for vty_out, vty (ptr only) */
53 #include "lib/zclient.h" /* for zmsghdr, ZEBRA_HEADER_SIZE, ZEBRA... */
54 #include "lib/frr_pthread.h" /* for frr_pthread_new, frr_pthread_stop... */
55 #include "lib/frratomic.h" /* for atomic_load_explicit, atomic_stor... */
56 #include "lib/lib_errors.h" /* for generic ferr ids */
57 #include "lib/printfrr.h" /* for string functions */
59 #include "zebra/debug.h" /* for various debugging macros */
60 #include "zebra/rib.h" /* for rib_score_proto */
61 #include "zebra/zapi_msg.h" /* for zserv_handle_commands */
62 #include "zebra/zebra_vrf.h" /* for zebra_vrf_lookup_by_id, zvrf */
63 #include "zebra/zserv.h" /* for zserv */
64 #include "zebra/zebra_router.h"
65 #include "zebra/zebra_errors.h" /* for error messages */
69 extern struct zebra_privs_t zserv_privs
;
71 /* The listener socket for clients connecting to us */
74 /* The lock that protects access to zapi client objects */
75 static pthread_mutex_t client_mutex
;
77 static struct zserv
*find_client_internal(uint8_t proto
,
78 unsigned short instance
,
81 /* Mem type for zclients. */
82 DEFINE_MTYPE_STATIC(ZEBRA
, ZSERV_CLIENT
, "ZClients");
85 * Client thread events.
87 * These are used almost exclusively by client threads to drive their own event
88 * loops. The only exception is in zserv_client_create(), which pushes an
89 * initial ZSERV_CLIENT_READ event to start the API handler loop.
91 enum zserv_client_event
{
92 /* Schedule a socket read */
94 /* Schedule a buffer write */
101 * These are used by client threads to notify the main thread about various
102 * events and to make processing requests.
105 /* Schedule listen job on Zebra API socket */
107 /* The calling client has packets on its input buffer */
108 ZSERV_PROCESS_MESSAGES
,
109 /* The calling client wishes to be killed */
110 ZSERV_HANDLE_CLIENT_FAIL
,
114 * Zebra server event driver for all client threads.
116 * This is essentially a wrapper around thread_add_event() that centralizes
117 * those scheduling calls into one place.
119 * All calls to this function schedule an event on the pthread running the
123 * the client in question, and thread target
126 * the event to notify them about
128 static void zserv_client_event(struct zserv
*client
,
129 enum zserv_client_event event
);
132 * Zebra server event driver for the main thread.
134 * This is essentially a wrapper around thread_add_event() that centralizes
135 * those scheduling calls into one place.
137 * All calls to this function schedule an event on Zebra's main pthread.
140 * the client in question
143 * the event to notify the main thread about
145 static void zserv_event(struct zserv
*client
, enum zserv_event event
);
148 /* Client thread lifecycle -------------------------------------------------- */
151 * Free a zserv client object.
153 void zserv_client_delete(struct zserv
*client
)
155 XFREE(MTYPE_ZSERV_CLIENT
, client
);
159 * Log zapi message to zlog.
170 void zserv_log_message(const char *errmsg
, struct stream
*msg
,
173 zlog_debug("Rx'd ZAPI message");
175 zlog_debug("%s", errmsg
);
177 zlog_debug(" Length: %d", hdr
->length
);
178 zlog_debug("Command: %s", zserv_command_string(hdr
->command
));
179 zlog_debug(" VRF: %u", hdr
->vrf_id
);
185 * Gracefuly shut down a client connection.
187 * Cancel any pending tasks for the client's thread. Then schedule a task on
188 * the main thread to shut down the calling thread.
190 * It is not safe to close the client socket in this function. The socket is
191 * owned by the main thread.
193 * Must be called from the client pthread, never the main thread.
195 static void zserv_client_fail(struct zserv
*client
)
197 flog_warn(EC_ZEBRA_CLIENT_IO_ERROR
,
198 "Client '%s' encountered an error and is shutting down.",
199 zebra_route_string(client
->proto
));
201 atomic_store_explicit(&client
->pthread
->running
, false,
202 memory_order_relaxed
);
204 THREAD_OFF(client
->t_read
);
205 THREAD_OFF(client
->t_write
);
206 zserv_event(client
, ZSERV_HANDLE_CLIENT_FAIL
);
210 * Write all pending messages to client socket.
212 * This function first attempts to flush any buffered data. If unsuccessful,
213 * the function reschedules itself and returns. If successful, it pops all
214 * available messages from the output queue and continues to write data
215 * directly to the socket until the socket would block. If the socket never
216 * blocks and all data is written, the function returns without rescheduling
217 * itself. If the socket ends up throwing EWOULDBLOCK, the remaining data is
218 * buffered and the function reschedules itself.
220 * The utility of the buffer is that it allows us to vastly reduce lock
221 * contention by allowing us to pop *all* messages off the output queue at once
222 * instead of locking and unlocking each time we want to pop a single message
223 * off the queue. The same thing could arguably be accomplished faster by
224 * allowing the main thread to write directly into the buffer instead of
225 * enqueuing packets onto an intermediary queue, but the intermediary queue
226 * allows us to expose information about input and output queues to the user in
227 * terms of number of packets rather than size of data.
229 static void zserv_write(struct thread
*thread
)
231 struct zserv
*client
= THREAD_ARG(thread
);
234 struct stream_fifo
*cache
;
235 uint64_t time_now
= monotime(NULL
);
237 /* If we have any data pending, try to flush it first */
238 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
242 frr_with_mutex (&client
->stats_mtx
) {
243 client
->last_write_time
= time_now
;
245 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
251 cache
= stream_fifo_new();
253 frr_with_mutex (&client
->obuf_mtx
) {
254 while (stream_fifo_head(client
->obuf_fifo
))
255 stream_fifo_push(cache
,
256 stream_fifo_pop(client
->obuf_fifo
));
261 stream_set_getp(msg
, 0);
262 wcmd
= stream_getw_from(msg
, ZAPI_HEADER_CMD_LOCATION
);
265 while (stream_fifo_head(cache
)) {
266 msg
= stream_fifo_pop(cache
);
267 buffer_put(client
->wb
, STREAM_DATA(msg
), stream_get_endp(msg
));
271 stream_fifo_free(cache
);
273 /* If we have any data pending, try to flush it first */
274 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
278 frr_with_mutex (&client
->stats_mtx
) {
279 client
->last_write_time
= time_now
;
281 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
287 frr_with_mutex (&client
->stats_mtx
) {
288 client
->last_write_cmd
= wcmd
;
289 client
->last_write_time
= time_now
;
294 flog_warn(EC_ZEBRA_CLIENT_WRITE_FAILED
,
295 "%s: could not write to %s [fd = %d], closing.", __func__
,
296 zebra_route_string(client
->proto
), client
->sock
);
297 zserv_client_fail(client
);
301 * Read and process data from a client socket.
303 * The responsibilities here are to read raw data from the client socket,
304 * validate the header, encapsulate it into a single stream object, push it
305 * onto the input queue and then notify the main thread that there is new data
308 * This function first looks for any data in the client structure's working
309 * input buffer. If data is present, it is assumed that reading stopped in a
310 * previous invocation of this task and needs to be resumed to finish a message.
311 * Otherwise, the socket data stream is assumed to be at the beginning of a new
312 * ZAPI message (specifically at the header). The header is read and validated.
313 * If the header passed validation then the length field found in the header is
314 * used to compute the total length of the message. That much data is read (but
315 * not inspected), appended to the header, placed into a stream and pushed onto
316 * the client's input queue. A task is then scheduled on the main thread to
317 * process the client's input queue. Finally, if all of this was successful,
318 * this task reschedules itself.
320 * Any failure in any of these actions is handled by terminating the client.
322 static void zserv_read(struct thread
*thread
)
324 struct zserv
*client
= THREAD_ARG(thread
);
327 struct stream_fifo
*cache
;
333 p2p_orig
= atomic_load_explicit(&zrouter
.packets_to_process
,
334 memory_order_relaxed
);
335 cache
= stream_fifo_new();
337 sock
= THREAD_FD(thread
);
344 already
= stream_get_endp(client
->ibuf_work
);
346 /* Read length and command (if we don't have it already). */
347 if (already
< ZEBRA_HEADER_SIZE
) {
348 nb
= stream_read_try(client
->ibuf_work
, sock
,
349 ZEBRA_HEADER_SIZE
- already
);
350 if ((nb
== 0 || nb
== -1)) {
351 if (IS_ZEBRA_DEBUG_EVENT
)
352 zlog_debug("connection closed socket [%d]",
356 if (nb
!= (ssize_t
)(ZEBRA_HEADER_SIZE
- already
)) {
357 /* Try again later. */
360 already
= ZEBRA_HEADER_SIZE
;
363 /* Reset to read from the beginning of the incoming packet. */
364 stream_set_getp(client
->ibuf_work
, 0);
366 /* Fetch header values */
367 hdrvalid
= zapi_parse_header(client
->ibuf_work
, &hdr
);
370 snprintf(errmsg
, sizeof(errmsg
),
371 "%s: Message has corrupt header", __func__
);
372 zserv_log_message(errmsg
, client
->ibuf_work
, NULL
);
376 /* Validate header */
377 if (hdr
.marker
!= ZEBRA_HEADER_MARKER
378 || hdr
.version
!= ZSERV_VERSION
) {
380 errmsg
, sizeof(errmsg
),
381 "Message has corrupt header\n%s: socket %d version mismatch, marker %d, version %d",
382 __func__
, sock
, hdr
.marker
, hdr
.version
);
383 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
386 if (hdr
.length
< ZEBRA_HEADER_SIZE
) {
388 errmsg
, sizeof(errmsg
),
389 "Message has corrupt header\n%s: socket %d message length %u is less than header size %d",
390 __func__
, sock
, hdr
.length
, ZEBRA_HEADER_SIZE
);
391 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
394 if (hdr
.length
> STREAM_SIZE(client
->ibuf_work
)) {
396 errmsg
, sizeof(errmsg
),
397 "Message has corrupt header\n%s: socket %d message length %u exceeds buffer size %lu",
398 __func__
, sock
, hdr
.length
,
399 (unsigned long)STREAM_SIZE(client
->ibuf_work
));
400 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
404 /* Read rest of data. */
405 if (already
< hdr
.length
) {
406 nb
= stream_read_try(client
->ibuf_work
, sock
,
407 hdr
.length
- already
);
408 if ((nb
== 0 || nb
== -1)) {
409 if (IS_ZEBRA_DEBUG_EVENT
)
411 "connection closed [%d] when reading zebra data",
415 if (nb
!= (ssize_t
)(hdr
.length
- already
)) {
416 /* Try again later. */
421 /* Debug packet information. */
422 if (IS_ZEBRA_DEBUG_PACKET
)
423 zlog_debug("zebra message[%s:%u:%u] comes from socket [%d]",
424 zserv_command_string(hdr
.command
),
425 hdr
.vrf_id
, hdr
.length
,
428 stream_set_getp(client
->ibuf_work
, 0);
429 struct stream
*msg
= stream_dup(client
->ibuf_work
);
431 stream_fifo_push(cache
, msg
);
432 stream_reset(client
->ibuf_work
);
436 if (p2p
< p2p_orig
) {
437 uint64_t time_now
= monotime(NULL
);
439 /* update session statistics */
440 frr_with_mutex (&client
->stats_mtx
) {
441 client
->last_read_time
= time_now
;
442 client
->last_read_cmd
= hdr
.command
;
445 /* publish read packets on client's input queue */
446 frr_with_mutex (&client
->ibuf_mtx
) {
448 stream_fifo_push(client
->ibuf_fifo
,
449 stream_fifo_pop(cache
));
452 /* Schedule job to process those packets */
453 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
457 if (IS_ZEBRA_DEBUG_PACKET
)
458 zlog_debug("Read %d packets from client: %s", p2p_orig
- p2p
,
459 zebra_route_string(client
->proto
));
461 /* Reschedule ourselves */
462 zserv_client_event(client
, ZSERV_CLIENT_READ
);
464 stream_fifo_free(cache
);
469 stream_fifo_free(cache
);
470 zserv_client_fail(client
);
473 static void zserv_client_event(struct zserv
*client
,
474 enum zserv_client_event event
)
477 case ZSERV_CLIENT_READ
:
478 thread_add_read(client
->pthread
->master
, zserv_read
, client
,
479 client
->sock
, &client
->t_read
);
481 case ZSERV_CLIENT_WRITE
:
482 thread_add_write(client
->pthread
->master
, zserv_write
, client
,
483 client
->sock
, &client
->t_write
);
488 /* Main thread lifecycle ---------------------------------------------------- */
491 * Read and process messages from a client.
493 * This task runs on the main pthread. It is scheduled by client pthreads when
494 * they have new messages available on their input queues. The client is passed
495 * as the task argument.
497 * Each message is popped off the client's input queue and the action associated
498 * with the message is executed. This proceeds until there are no more messages,
499 * an error occurs, or the processing limit is reached.
501 * The client's I/O thread can push at most zrouter.packets_to_process messages
502 * onto the input buffer before notifying us there are packets to read. As long
503 * as we always process zrouter.packets_to_process messages here, then we can
504 * rely on the read thread to handle queuing this task enough times to process
505 * everything on the input queue.
507 static void zserv_process_messages(struct thread
*thread
)
509 struct zserv
*client
= THREAD_ARG(thread
);
511 struct stream_fifo
*cache
= stream_fifo_new();
512 uint32_t p2p
= zrouter
.packets_to_process
;
513 bool need_resched
= false;
515 frr_with_mutex (&client
->ibuf_mtx
) {
517 for (i
= 0; i
< p2p
&& stream_fifo_head(client
->ibuf_fifo
);
519 msg
= stream_fifo_pop(client
->ibuf_fifo
);
520 stream_fifo_push(cache
, msg
);
525 /* Need to reschedule processing work if there are still
526 * packets in the fifo.
528 if (stream_fifo_head(client
->ibuf_fifo
))
532 /* Process the batch of messages */
533 if (stream_fifo_head(cache
))
534 zserv_handle_commands(client
, cache
);
536 stream_fifo_free(cache
);
538 /* Reschedule ourselves if necessary */
540 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
543 int zserv_send_message(struct zserv
*client
, struct stream
*msg
)
545 frr_with_mutex (&client
->obuf_mtx
) {
546 stream_fifo_push(client
->obuf_fifo
, msg
);
549 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
555 * Send a batch of messages to a connected Zebra API client.
557 int zserv_send_batch(struct zserv
*client
, struct stream_fifo
*fifo
)
561 frr_with_mutex (&client
->obuf_mtx
) {
562 msg
= stream_fifo_pop(fifo
);
564 stream_fifo_push(client
->obuf_fifo
, msg
);
565 msg
= stream_fifo_pop(fifo
);
569 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
574 /* Hooks for client connect / disconnect */
575 DEFINE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
576 DEFINE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
579 * Deinitialize zebra client.
581 * - Deregister and deinitialize related internal resources
582 * - Gracefuly close socket
583 * - Free associated resources
584 * - Free client structure
586 * This does *not* take any action on the struct thread * fields. These are
587 * managed by the owning pthread and any tasks associated with them must have
588 * been stopped prior to invoking this function.
590 static void zserv_client_free(struct zserv
*client
)
595 hook_call(zserv_client_close
, client
);
597 /* Close file descriptor. */
599 unsigned long nroutes
;
604 if (DYNAMIC_CLIENT_GR_DISABLED(client
)) {
605 zebra_mpls_client_cleanup_vrf_label(client
->proto
);
607 nroutes
= rib_score_proto(client
->proto
,
610 "client %d disconnected %lu %s routes removed from the rib",
611 client
->sock
, nroutes
,
612 zebra_route_string(client
->proto
));
614 /* Not worrying about instance for now */
615 nnhgs
= zebra_nhg_score_proto(client
->proto
);
617 "client %d disconnected %lu %s nhgs removed from the rib",
619 zebra_route_string(client
->proto
));
624 /* Free stream buffers. */
625 if (client
->ibuf_work
)
626 stream_free(client
->ibuf_work
);
627 if (client
->obuf_work
)
628 stream_free(client
->obuf_work
);
629 if (client
->ibuf_fifo
)
630 stream_fifo_free(client
->ibuf_fifo
);
631 if (client
->obuf_fifo
)
632 stream_fifo_free(client
->obuf_fifo
);
634 buffer_free(client
->wb
);
636 /* Free buffer mutexes */
637 pthread_mutex_destroy(&client
->stats_mtx
);
638 pthread_mutex_destroy(&client
->obuf_mtx
);
639 pthread_mutex_destroy(&client
->ibuf_mtx
);
642 for (afi_t afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
643 for (int i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++) {
644 vrf_bitmap_free(client
->redist
[afi
][i
]);
645 redist_del_all_instances(&client
->mi_redist
[afi
][i
]);
648 vrf_bitmap_free(client
->redist_default
[afi
]);
649 vrf_bitmap_free(client
->ridinfo
[afi
]);
650 vrf_bitmap_free(client
->nhrp_neighinfo
[afi
]);
654 * If any instance are graceful restart enabled,
655 * client is not deleted
657 if (DYNAMIC_CLIENT_GR_DISABLED(client
)) {
658 if (IS_ZEBRA_DEBUG_EVENT
)
659 zlog_debug("%s: Deleting client %s", __func__
,
660 zebra_route_string(client
->proto
));
661 zserv_client_delete(client
);
663 /* Handle cases where client has GR instance. */
664 if (IS_ZEBRA_DEBUG_EVENT
)
665 zlog_debug("%s: client %s restart enabled", __func__
,
666 zebra_route_string(client
->proto
));
667 if (zebra_gr_client_disconnect(client
) < 0)
669 "%s: GR enabled but could not handle disconnect event",
674 void zserv_close_client(struct zserv
*client
)
678 if (client
->pthread
) {
679 /* synchronously stop and join pthread */
680 frr_pthread_stop(client
->pthread
, NULL
);
682 if (IS_ZEBRA_DEBUG_EVENT
)
683 zlog_debug("Closing client '%s'",
684 zebra_route_string(client
->proto
));
686 thread_cancel_event(zrouter
.master
, client
);
687 THREAD_OFF(client
->t_cleanup
);
688 THREAD_OFF(client
->t_process
);
690 /* destroy pthread */
691 frr_pthread_destroy(client
->pthread
);
692 client
->pthread
= NULL
;
696 * Final check in case the client struct is in use in another
697 * pthread: if not in-use, continue and free the client
699 frr_with_mutex (&client_mutex
) {
700 if (client
->busy_count
<= 0) {
701 /* remove from client list */
702 listnode_delete(zrouter
.client_list
, client
);
705 * The client session object may be in use, although
706 * the associated pthread is gone. Defer final
709 client
->is_closed
= true;
716 zserv_client_free(client
);
720 * This task is scheduled by a ZAPI client pthread on the main pthread when it
721 * wants to stop itself. When this executes, the client connection should
722 * already have been closed and the thread will most likely have died, but its
723 * resources still need to be cleaned up.
725 static void zserv_handle_client_fail(struct thread
*thread
)
727 struct zserv
*client
= THREAD_ARG(thread
);
729 zserv_close_client(client
);
733 * Create a new client.
735 * This is called when a new connection is accept()'d on the ZAPI socket. It
736 * initializes new client structure, notifies any subscribers of the connection
737 * event and spawns the client's thread.
740 * client's socket file descriptor
742 static struct zserv
*zserv_client_create(int sock
)
744 struct zserv
*client
;
746 MAX(ZEBRA_MAX_PACKET_SIZ
, sizeof(struct zapi_route
));
750 client
= XCALLOC(MTYPE_ZSERV_CLIENT
, sizeof(struct zserv
));
752 /* Make client input/output buffer. */
754 client
->ibuf_fifo
= stream_fifo_new();
755 client
->obuf_fifo
= stream_fifo_new();
756 client
->ibuf_work
= stream_new(stream_size
);
757 client
->obuf_work
= stream_new(stream_size
);
758 client
->connect_time
= monotime(NULL
);
759 pthread_mutex_init(&client
->ibuf_mtx
, NULL
);
760 pthread_mutex_init(&client
->obuf_mtx
, NULL
);
761 pthread_mutex_init(&client
->stats_mtx
, NULL
);
762 client
->wb
= buffer_new(0);
763 TAILQ_INIT(&(client
->gr_info_queue
));
765 /* Initialize flags */
766 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
767 for (i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
768 client
->redist
[afi
][i
] = vrf_bitmap_init();
769 client
->redist_default
[afi
] = vrf_bitmap_init();
770 client
->ridinfo
[afi
] = vrf_bitmap_init();
771 client
->nhrp_neighinfo
[afi
] = vrf_bitmap_init();
774 /* Add this client to linked list. */
775 frr_with_mutex (&client_mutex
) {
776 listnode_add(zrouter
.client_list
, client
);
779 struct frr_pthread_attr zclient_pthr_attrs
= {
780 .start
= frr_pthread_attr_default
.start
,
781 .stop
= frr_pthread_attr_default
.stop
784 frr_pthread_new(&zclient_pthr_attrs
, "Zebra API client thread",
787 /* start read loop */
788 zserv_client_event(client
, ZSERV_CLIENT_READ
);
791 hook_call(zserv_client_connect
, client
);
794 frr_pthread_run(client
->pthread
, NULL
);
800 * Retrieve a client object by the complete tuple of
801 * {protocol, instance, session}. This version supports use
802 * from a different pthread: the object will be returned marked
803 * in-use. The caller *must* release the client object with the
804 * release_client() api, to ensure that the in-use marker is cleared properly.
806 struct zserv
*zserv_acquire_client(uint8_t proto
, unsigned short instance
,
809 struct zserv
*client
= NULL
;
811 frr_with_mutex (&client_mutex
) {
812 client
= find_client_internal(proto
, instance
, session_id
);
814 /* Don't return a dead/closed client object */
815 if (client
->is_closed
)
818 client
->busy_count
++;
826 * Release a client object that was acquired with the acquire_client() api.
827 * After this has been called, the caller must not use the client pointer -
828 * it may be freed if the client has closed.
830 void zserv_release_client(struct zserv
*client
)
833 * Once we've decremented the client object's refcount, it's possible
834 * for it to be deleted as soon as we release the lock, so we won't
835 * touch the object again.
837 frr_with_mutex (&client_mutex
) {
838 client
->busy_count
--;
840 if (client
->busy_count
<= 0) {
842 * No more users of the client object. If the client
843 * session is closed, schedule cleanup on the zebra
846 if (client
->is_closed
)
847 thread_add_event(zrouter
.master
,
848 zserv_handle_client_fail
,
849 client
, 0, &client
->t_cleanup
);
854 * Cleanup must take place on the zebra main pthread, so we've
855 * scheduled an event.
860 * Accept socket connection.
862 static void zserv_accept(struct thread
*thread
)
866 struct sockaddr_in client
;
869 accept_sock
= THREAD_FD(thread
);
871 /* Reregister myself. */
872 zserv_event(NULL
, ZSERV_ACCEPT
);
874 len
= sizeof(struct sockaddr_in
);
875 client_sock
= accept(accept_sock
, (struct sockaddr
*)&client
, &len
);
877 if (client_sock
< 0) {
878 flog_err_sys(EC_LIB_SOCKET
, "Can't accept zebra socket: %s",
879 safe_strerror(errno
));
883 /* Make client socket non-blocking. */
884 set_nonblocking(client_sock
);
886 /* Create new zebra client. */
887 zserv_client_create(client_sock
);
890 void zserv_close(void)
893 * On shutdown, let's close the socket down
894 * so that long running processes of killing the
895 * routing table doesn't leave us in a bad
896 * state where a client tries to reconnect
901 /* Free client list's mutex */
902 pthread_mutex_destroy(&client_mutex
);
905 void zserv_start(char *path
)
909 struct sockaddr_storage sa
;
912 if (!frr_zclient_addr(&sa
, &sa_len
, path
))
913 /* should be caught in zebra main() */
917 old_mask
= umask(0077);
919 /* Make UNIX domain socket. */
920 zsock
= socket(sa
.ss_family
, SOCK_STREAM
, 0);
922 flog_err_sys(EC_LIB_SOCKET
, "Can't create zserv socket: %s",
923 safe_strerror(errno
));
927 if (sa
.ss_family
!= AF_UNIX
) {
928 sockopt_reuseaddr(zsock
);
929 sockopt_reuseport(zsock
);
931 struct sockaddr_un
*suna
= (struct sockaddr_un
*)&sa
;
932 if (suna
->sun_path
[0])
933 unlink(suna
->sun_path
);
936 setsockopt_so_recvbuf(zsock
, 1048576);
937 setsockopt_so_sendbuf(zsock
, 1048576);
939 frr_with_privs((sa
.ss_family
!= AF_UNIX
) ? &zserv_privs
: NULL
) {
940 ret
= bind(zsock
, (struct sockaddr
*)&sa
, sa_len
);
943 flog_err_sys(EC_LIB_SOCKET
, "Can't bind zserv socket on %s: %s",
944 path
, safe_strerror(errno
));
950 ret
= listen(zsock
, 5);
952 flog_err_sys(EC_LIB_SOCKET
,
953 "Can't listen to zserv socket %s: %s", path
,
954 safe_strerror(errno
));
962 zserv_event(NULL
, ZSERV_ACCEPT
);
965 void zserv_event(struct zserv
*client
, enum zserv_event event
)
969 thread_add_read(zrouter
.master
, zserv_accept
, NULL
, zsock
,
972 case ZSERV_PROCESS_MESSAGES
:
973 thread_add_event(zrouter
.master
, zserv_process_messages
, client
,
974 0, &client
->t_process
);
976 case ZSERV_HANDLE_CLIENT_FAIL
:
977 thread_add_event(zrouter
.master
, zserv_handle_client_fail
,
978 client
, 0, &client
->t_cleanup
);
983 /* General purpose ---------------------------------------------------------- */
985 #define ZEBRA_TIME_BUF 32
986 static char *zserv_time_buf(time_t *time1
, char *buf
, int buflen
)
991 assert(buflen
>= ZEBRA_TIME_BUF
);
992 assert(time1
!= NULL
);
995 snprintf(buf
, buflen
, "never ");
999 now
= monotime(NULL
);
1002 frrtime_to_interval(now
, buf
, buflen
);
1007 /* Display client info details */
1008 static void zebra_show_client_detail(struct vty
*vty
, struct zserv
*client
)
1010 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
1011 char wbuf
[ZEBRA_TIME_BUF
], nhbuf
[ZEBRA_TIME_BUF
], mbuf
[ZEBRA_TIME_BUF
];
1012 time_t connect_time
, last_read_time
, last_write_time
;
1013 uint32_t last_read_cmd
, last_write_cmd
;
1015 vty_out(vty
, "Client: %s", zebra_route_string(client
->proto
));
1016 if (client
->instance
)
1017 vty_out(vty
, " Instance: %u", client
->instance
);
1018 if (client
->session_id
)
1019 vty_out(vty
, " [%u]", client
->session_id
);
1022 vty_out(vty
, "------------------------ \n");
1023 vty_out(vty
, "FD: %d \n", client
->sock
);
1025 frr_with_mutex (&client
->stats_mtx
) {
1026 connect_time
= client
->connect_time
;
1027 last_read_time
= client
->last_read_time
;
1028 last_write_time
= client
->last_write_time
;
1030 last_read_cmd
= client
->last_read_cmd
;
1031 last_write_cmd
= client
->last_write_cmd
;
1034 vty_out(vty
, "Connect Time: %s \n",
1035 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
));
1036 if (client
->nh_reg_time
) {
1037 vty_out(vty
, "Nexthop Registry Time: %s \n",
1038 zserv_time_buf(&client
->nh_reg_time
, nhbuf
,
1040 if (client
->nh_last_upd_time
)
1041 vty_out(vty
, "Nexthop Last Update Time: %s \n",
1042 zserv_time_buf(&client
->nh_last_upd_time
, mbuf
,
1045 vty_out(vty
, "No Nexthop Update sent\n");
1047 vty_out(vty
, "Not registered for Nexthop Updates\n");
1050 "Client will %sbe notified about the status of its routes.\n",
1051 client
->notify_owner
? "" : "Not ");
1053 vty_out(vty
, "Last Msg Rx Time: %s \n",
1054 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
));
1055 vty_out(vty
, "Last Msg Tx Time: %s \n",
1056 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
));
1058 vty_out(vty
, "Last Rcvd Cmd: %s \n",
1059 zserv_command_string(last_read_cmd
));
1061 vty_out(vty
, "Last Sent Cmd: %s \n",
1062 zserv_command_string(last_write_cmd
));
1065 vty_out(vty
, "Type Add Update Del \n");
1066 vty_out(vty
, "================================================== \n");
1067 vty_out(vty
, "IPv4 %-12u%-12u%-12u\n", client
->v4_route_add_cnt
,
1068 client
->v4_route_upd8_cnt
, client
->v4_route_del_cnt
);
1069 vty_out(vty
, "IPv6 %-12u%-12u%-12u\n", client
->v6_route_add_cnt
,
1070 client
->v6_route_upd8_cnt
, client
->v6_route_del_cnt
);
1071 vty_out(vty
, "Redist:v4 %-12u%-12u%-12u\n", client
->redist_v4_add_cnt
,
1072 0, client
->redist_v4_del_cnt
);
1073 vty_out(vty
, "Redist:v6 %-12u%-12u%-12u\n", client
->redist_v6_add_cnt
,
1074 0, client
->redist_v6_del_cnt
);
1075 vty_out(vty
, "VRF %-12u%-12u%-12u\n", client
->vrfadd_cnt
, 0,
1076 client
->vrfdel_cnt
);
1077 vty_out(vty
, "Connected %-12u%-12u%-12u\n", client
->ifadd_cnt
, 0,
1079 vty_out(vty
, "Interface %-12u%-12u%-12u\n", client
->ifup_cnt
, 0,
1080 client
->ifdown_cnt
);
1081 vty_out(vty
, "Intf Addr %-12u%-12u%-12u\n",
1082 client
->connected_rt_add_cnt
, 0, client
->connected_rt_del_cnt
);
1083 vty_out(vty
, "BFD peer %-12u%-12u%-12u\n", client
->bfd_peer_add_cnt
,
1084 client
->bfd_peer_upd8_cnt
, client
->bfd_peer_del_cnt
);
1085 vty_out(vty
, "NHT v4 %-12u%-12u%-12u\n",
1086 client
->v4_nh_watch_add_cnt
, 0, client
->v4_nh_watch_rem_cnt
);
1087 vty_out(vty
, "NHT v6 %-12u%-12u%-12u\n",
1088 client
->v6_nh_watch_add_cnt
, 0, client
->v6_nh_watch_rem_cnt
);
1089 vty_out(vty
, "VxLAN SG %-12u%-12u%-12u\n", client
->vxlan_sg_add_cnt
,
1090 0, client
->vxlan_sg_del_cnt
);
1091 vty_out(vty
, "VNI %-12u%-12u%-12u\n", client
->vniadd_cnt
, 0,
1092 client
->vnidel_cnt
);
1093 vty_out(vty
, "L3-VNI %-12u%-12u%-12u\n", client
->l3vniadd_cnt
, 0,
1094 client
->l3vnidel_cnt
);
1095 vty_out(vty
, "MAC-IP %-12u%-12u%-12u\n", client
->macipadd_cnt
, 0,
1096 client
->macipdel_cnt
);
1097 vty_out(vty
, "ES %-12u%-12u%-12u\n", client
->local_es_add_cnt
,
1098 0, client
->local_es_del_cnt
);
1099 vty_out(vty
, "ES-EVI %-12u%-12u%-12u\n",
1100 client
->local_es_evi_add_cnt
, 0, client
->local_es_evi_del_cnt
);
1101 vty_out(vty
, "Errors: %u\n", client
->error_cnt
);
1103 #if defined DEV_BUILD
1104 vty_out(vty
, "Input Fifo: %zu:%zu Output Fifo: %zu:%zu\n",
1105 client
->ibuf_fifo
->count
, client
->ibuf_fifo
->max_count
,
1106 client
->obuf_fifo
->count
, client
->obuf_fifo
->max_count
);
1111 /* Display stale client information */
1112 static void zebra_show_stale_client_detail(struct vty
*vty
,
1113 struct zserv
*client
)
1115 char buf
[PREFIX2STR_BUFFER
];
1117 struct client_gr_info
*info
= NULL
;
1118 struct zserv
*s
= NULL
;
1119 bool first_p
= true;
1121 TAILQ_FOREACH (info
, &client
->gr_info_queue
, gr_info
) {
1123 vty_out(vty
, "Stale Client Information\n");
1124 vty_out(vty
, "------------------------\n");
1126 if (client
->instance
)
1127 vty_out(vty
, " Instance: %u", client
->instance
);
1128 if (client
->session_id
)
1129 vty_out(vty
, " [%u]", client
->session_id
);
1134 vty_out(vty
, "VRF : %s\n", vrf_id_to_name(info
->vrf_id
));
1135 vty_out(vty
, "Capabilities : ");
1136 switch (info
->capabilities
) {
1137 case ZEBRA_CLIENT_GR_CAPABILITIES
:
1138 vty_out(vty
, "Graceful Restart(%u seconds)\n",
1139 info
->stale_removal_time
);
1141 case ZEBRA_CLIENT_ROUTE_UPDATE_COMPLETE
:
1142 case ZEBRA_CLIENT_ROUTE_UPDATE_PENDING
:
1143 case ZEBRA_CLIENT_GR_DISABLE
:
1144 case ZEBRA_CLIENT_RIB_STALE_TIME
:
1145 vty_out(vty
, "None\n");
1149 if (ZEBRA_CLIENT_GR_ENABLED(info
->capabilities
)) {
1150 if (info
->stale_client_ptr
) {
1151 s
= (struct zserv
*)(info
->stale_client_ptr
);
1152 uptime
= monotime(NULL
);
1153 uptime
-= s
->restart_time
;
1155 frrtime_to_interval(uptime
, buf
, sizeof(buf
));
1157 vty_out(vty
, "Last restart time : %s ago\n",
1160 vty_out(vty
, "Stalepath removal time: %d sec\n",
1161 info
->stale_removal_time
);
1162 if (info
->t_stale_removal
) {
1164 "Stale delete timer: %ld sec\n",
1165 thread_timer_remain_second(
1166 info
->t_stale_removal
));
1169 vty_out(vty
, "Current AFI : %d\n", info
->current_afi
);
1170 if (info
->current_prefix
)
1171 vty_out(vty
, "Current prefix : %pFX\n",
1172 info
->current_prefix
);
1179 static void zebra_show_client_brief(struct vty
*vty
, struct zserv
*client
)
1181 char client_string
[80];
1182 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
1183 char wbuf
[ZEBRA_TIME_BUF
];
1184 time_t connect_time
, last_read_time
, last_write_time
;
1186 frr_with_mutex (&client
->stats_mtx
) {
1187 connect_time
= client
->connect_time
;
1188 last_read_time
= client
->last_read_time
;
1189 last_write_time
= client
->last_write_time
;
1192 if (client
->instance
|| client
->session_id
)
1193 snprintfrr(client_string
, sizeof(client_string
), "%s[%u:%u]",
1194 zebra_route_string(client
->proto
), client
->instance
,
1195 client
->session_id
);
1197 snprintfrr(client_string
, sizeof(client_string
), "%s",
1198 zebra_route_string(client
->proto
));
1200 vty_out(vty
, "%-10s%12s %12s%12s %10d/%-10d %10d/%-10d\n",
1202 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
),
1203 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
),
1204 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
),
1205 client
->v4_route_add_cnt
+ client
->v4_route_upd8_cnt
,
1206 client
->v4_route_del_cnt
,
1207 client
->v6_route_add_cnt
+ client
->v6_route_upd8_cnt
,
1208 client
->v6_route_del_cnt
);
1212 * Common logic that searches the client list for a zapi client; this
1213 * MUST be called holding the client list mutex.
1215 static struct zserv
*find_client_internal(uint8_t proto
,
1216 unsigned short instance
,
1217 uint32_t session_id
)
1219 struct listnode
*node
, *nnode
;
1220 struct zserv
*client
= NULL
;
1222 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, node
, nnode
, client
)) {
1223 if (client
->proto
== proto
&& client
->instance
== instance
&&
1224 client
->session_id
== session_id
)
1232 * Public api that searches for a client session; this version is
1233 * used from the zebra main pthread.
1235 struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
)
1237 struct zserv
*client
;
1239 frr_with_mutex (&client_mutex
) {
1240 client
= find_client_internal(proto
, instance
, 0);
1247 * Retrieve a client by its protocol, instance number, and session id.
1249 struct zserv
*zserv_find_client_session(uint8_t proto
, unsigned short instance
,
1250 uint32_t session_id
)
1252 struct zserv
*client
;
1254 frr_with_mutex (&client_mutex
) {
1255 client
= find_client_internal(proto
, instance
, session_id
);
1262 /* This command is for debugging purpose. */
1263 DEFUN (show_zebra_client
,
1264 show_zebra_client_cmd
,
1265 "show zebra client",
1268 "Client information\n")
1270 struct listnode
*node
;
1271 struct zserv
*client
;
1273 for (ALL_LIST_ELEMENTS_RO(zrouter
.client_list
, node
, client
)) {
1274 zebra_show_client_detail(vty
, client
);
1275 /* Show GR info if present */
1276 zebra_show_stale_client_detail(vty
, client
);
1282 /* This command is for debugging purpose. */
1283 DEFUN (show_zebra_client_summary
,
1284 show_zebra_client_summary_cmd
,
1285 "show zebra client summary",
1288 "Client information brief\n"
1291 struct listnode
*node
;
1292 struct zserv
*client
;
1295 "Name Connect Time Last Read Last Write IPv4 Routes IPv6 Routes\n");
1297 "------------------------------------------------------------------------------------------\n");
1299 for (ALL_LIST_ELEMENTS_RO(zrouter
.client_list
, node
, client
))
1300 zebra_show_client_brief(vty
, client
);
1302 vty_out(vty
, "Routes column shows (added+updated)/deleted\n");
1306 static int zserv_client_close_cb(struct zserv
*closed_client
)
1308 struct listnode
*node
, *nnode
;
1309 struct zserv
*client
= NULL
;
1311 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, node
, nnode
, client
)) {
1312 if (client
->proto
== closed_client
->proto
)
1315 zsend_client_close_notify(client
, closed_client
);
1321 void zserv_init(void)
1323 /* Client list init. */
1324 zrouter
.client_list
= list_new();
1325 zrouter
.stale_client_list
= list_new();
1329 pthread_mutex_init(&client_mutex
, NULL
);
1331 install_element(ENABLE_NODE
, &show_zebra_client_cmd
);
1332 install_element(ENABLE_NODE
, &show_zebra_client_summary_cmd
);
1334 hook_register(zserv_client_close
, zserv_client_close_cb
);