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/zassert.h" /* for assert */
54 #include "lib/zclient.h" /* for zmsghdr, ZEBRA_HEADER_SIZE, ZEBRA... */
55 #include "lib/frr_pthread.h" /* for frr_pthread_new, frr_pthread_stop... */
56 #include "lib/frratomic.h" /* for atomic_load_explicit, atomic_stor... */
57 #include "lib/lib_errors.h" /* for generic ferr ids */
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
;
72 * Client thread events.
74 * These are used almost exclusively by client threads to drive their own event
75 * loops. The only exception is in zserv_client_create(), which pushes an
76 * initial ZSERV_CLIENT_READ event to start the API handler loop.
78 enum zserv_client_event
{
79 /* Schedule a socket read */
81 /* Schedule a buffer write */
88 * These are used by client threads to notify the main thread about various
89 * events and to make processing requests.
92 /* Schedule listen job on Zebra API socket */
94 /* The calling client has packets on its input buffer */
95 ZSERV_PROCESS_MESSAGES
,
96 /* The calling client wishes to be killed */
97 ZSERV_HANDLE_CLIENT_FAIL
,
101 * Zebra server event driver for all client threads.
103 * This is essentially a wrapper around thread_add_event() that centralizes
104 * those scheduling calls into one place.
106 * All calls to this function schedule an event on the pthread running the
110 * the client in question, and thread target
113 * the event to notify them about
115 static void zserv_client_event(struct zserv
*client
,
116 enum zserv_client_event event
);
119 * Zebra server event driver for the main thread.
121 * This is essentially a wrapper around thread_add_event() that centralizes
122 * those scheduling calls into one place.
124 * All calls to this function schedule an event on Zebra's main pthread.
127 * the client in question
130 * the event to notify the main thread about
132 static void zserv_event(struct zserv
*client
, enum zserv_event event
);
135 /* Client thread lifecycle -------------------------------------------------- */
138 * Log zapi message to zlog.
149 static void zserv_log_message(const char *errmsg
, struct stream
*msg
,
152 zlog_debug("Rx'd ZAPI message");
154 zlog_debug("%s", errmsg
);
156 zlog_debug(" Length: %d", hdr
->length
);
157 zlog_debug("Command: %s", zserv_command_string(hdr
->command
));
158 zlog_debug(" VRF: %u", hdr
->vrf_id
);
160 zlog_hexdump(msg
->data
, STREAM_READABLE(msg
));
164 * Gracefully shut down a client connection.
166 * Cancel any pending tasks for the client's thread. Then schedule a task on
167 * the main thread to shut down the calling thread.
169 * It is not safe to close the client socket in this function. The socket is
170 * owned by the main thread.
172 * Must be called from the client pthread, never the main thread.
174 static void zserv_client_fail(struct zserv
*client
)
176 flog_warn(EC_ZEBRA_CLIENT_IO_ERROR
,
177 "Client '%s' encountered an error and is shutting down.",
178 zebra_route_string(client
->proto
));
180 atomic_store_explicit(&client
->pthread
->running
, false,
181 memory_order_relaxed
);
183 THREAD_OFF(client
->t_read
);
184 THREAD_OFF(client
->t_write
);
185 zserv_event(client
, ZSERV_HANDLE_CLIENT_FAIL
);
189 * Write all pending messages to client socket.
191 * This function first attempts to flush any buffered data. If unsuccessful,
192 * the function reschedules itself and returns. If successful, it pops all
193 * available messages from the output queue and continues to write data
194 * directly to the socket until the socket would block. If the socket never
195 * blocks and all data is written, the function returns without rescheduling
196 * itself. If the socket ends up throwing EWOULDBLOCK, the remaining data is
197 * buffered and the function reschedules itself.
199 * The utility of the buffer is that it allows us to vastly reduce lock
200 * contention by allowing us to pop *all* messages off the output queue at once
201 * instead of locking and unlocking each time we want to pop a single message
202 * off the queue. The same thing could arguably be accomplished faster by
203 * allowing the main thread to write directly into the buffer instead of
204 * enqueuing packets onto an intermediary queue, but the intermediary queue
205 * allows us to expose information about input and output queues to the user in
206 * terms of number of packets rather than size of data.
208 static int zserv_write(struct thread
*thread
)
210 struct zserv
*client
= THREAD_ARG(thread
);
213 struct stream_fifo
*cache
;
215 /* If we have any data pending, try to flush it first */
216 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
220 atomic_store_explicit(&client
->last_write_time
,
221 (uint32_t)monotime(NULL
),
222 memory_order_relaxed
);
223 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
229 cache
= stream_fifo_new();
231 pthread_mutex_lock(&client
->obuf_mtx
);
233 while (stream_fifo_head(client
->obuf_fifo
))
234 stream_fifo_push(cache
,
235 stream_fifo_pop(client
->obuf_fifo
));
237 pthread_mutex_unlock(&client
->obuf_mtx
);
241 stream_set_getp(msg
, 0);
242 wcmd
= stream_getw_from(msg
, 6);
245 while (stream_fifo_head(cache
)) {
246 msg
= stream_fifo_pop(cache
);
247 buffer_put(client
->wb
, STREAM_DATA(msg
), stream_get_endp(msg
));
251 stream_fifo_free(cache
);
253 /* If we have any data pending, try to flush it first */
254 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
258 atomic_store_explicit(&client
->last_write_time
,
259 (uint32_t)monotime(NULL
),
260 memory_order_relaxed
);
261 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
267 atomic_store_explicit(&client
->last_write_cmd
, wcmd
,
268 memory_order_relaxed
);
270 atomic_store_explicit(&client
->last_write_time
,
271 (uint32_t)monotime(NULL
), memory_order_relaxed
);
276 flog_warn(EC_ZEBRA_CLIENT_WRITE_FAILED
,
277 "%s: could not write to %s [fd = %d], closing.", __func__
,
278 zebra_route_string(client
->proto
), client
->sock
);
279 zserv_client_fail(client
);
284 * Read and process data from a client socket.
286 * The responsibilities here are to read raw data from the client socket,
287 * validate the header, encapsulate it into a single stream object, push it
288 * onto the input queue and then notify the main thread that there is new data
291 * This function first looks for any data in the client structure's working
292 * input buffer. If data is present, it is assumed that reading stopped in a
293 * previous invocation of this task and needs to be resumed to finish a message.
294 * Otherwise, the socket data stream is assumed to be at the beginning of a new
295 * ZAPI message (specifically at the header). The header is read and validated.
296 * If the header passed validation then the length field found in the header is
297 * used to compute the total length of the message. That much data is read (but
298 * not inspected), appended to the header, placed into a stream and pushed onto
299 * the client's input queue. A task is then scheduled on the main thread to
300 * process the client's input queue. Finally, if all of this was successful,
301 * this task reschedules itself.
303 * Any failure in any of these actions is handled by terminating the client.
305 static int zserv_read(struct thread
*thread
)
307 struct zserv
*client
= THREAD_ARG(thread
);
310 struct stream_fifo
*cache
;
316 p2p_orig
= atomic_load_explicit(&zebrad
.packets_to_process
,
317 memory_order_relaxed
);
318 cache
= stream_fifo_new();
320 sock
= THREAD_FD(thread
);
327 already
= stream_get_endp(client
->ibuf_work
);
329 /* Read length and command (if we don't have it already). */
330 if (already
< ZEBRA_HEADER_SIZE
) {
331 nb
= stream_read_try(client
->ibuf_work
, sock
,
332 ZEBRA_HEADER_SIZE
- already
);
333 if ((nb
== 0 || nb
== -1)) {
334 if (IS_ZEBRA_DEBUG_EVENT
)
335 zlog_debug("connection closed socket [%d]",
339 if (nb
!= (ssize_t
)(ZEBRA_HEADER_SIZE
- already
)) {
340 /* Try again later. */
343 already
= ZEBRA_HEADER_SIZE
;
346 /* Reset to read from the beginning of the incoming packet. */
347 stream_set_getp(client
->ibuf_work
, 0);
349 /* Fetch header values */
350 hdrvalid
= zapi_parse_header(client
->ibuf_work
, &hdr
);
353 snprintf(errmsg
, sizeof(errmsg
),
354 "%s: Message has corrupt header", __func__
);
355 zserv_log_message(errmsg
, client
->ibuf_work
, NULL
);
359 /* Validate header */
360 if (hdr
.marker
!= ZEBRA_HEADER_MARKER
361 || hdr
.version
!= ZSERV_VERSION
) {
363 errmsg
, sizeof(errmsg
),
364 "Message has corrupt header\n%s: socket %d version mismatch, marker %d, version %d",
365 __func__
, sock
, hdr
.marker
, hdr
.version
);
366 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
369 if (hdr
.length
< ZEBRA_HEADER_SIZE
) {
371 errmsg
, sizeof(errmsg
),
372 "Message has corrupt header\n%s: socket %d message length %u is less than header size %d",
373 __func__
, sock
, hdr
.length
, ZEBRA_HEADER_SIZE
);
374 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
377 if (hdr
.length
> STREAM_SIZE(client
->ibuf_work
)) {
379 errmsg
, sizeof(errmsg
),
380 "Message has corrupt header\n%s: socket %d message length %u exceeds buffer size %lu",
381 __func__
, sock
, hdr
.length
,
382 (unsigned long)STREAM_SIZE(client
->ibuf_work
));
383 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
387 /* Read rest of data. */
388 if (already
< hdr
.length
) {
389 nb
= stream_read_try(client
->ibuf_work
, sock
,
390 hdr
.length
- already
);
391 if ((nb
== 0 || nb
== -1)) {
392 if (IS_ZEBRA_DEBUG_EVENT
)
394 "connection closed [%d] when reading zebra data",
398 if (nb
!= (ssize_t
)(hdr
.length
- already
)) {
399 /* Try again later. */
404 /* Debug packet information. */
405 if (IS_ZEBRA_DEBUG_EVENT
)
406 zlog_debug("zebra message comes from socket [%d]",
409 if (IS_ZEBRA_DEBUG_PACKET
&& IS_ZEBRA_DEBUG_RECV
)
410 zserv_log_message(NULL
, client
->ibuf_work
, &hdr
);
412 stream_set_getp(client
->ibuf_work
, 0);
413 struct stream
*msg
= stream_dup(client
->ibuf_work
);
415 stream_fifo_push(cache
, msg
);
416 stream_reset(client
->ibuf_work
);
420 if (p2p
< p2p_orig
) {
421 /* update session statistics */
422 atomic_store_explicit(&client
->last_read_time
, monotime(NULL
),
423 memory_order_relaxed
);
424 atomic_store_explicit(&client
->last_read_cmd
, hdr
.command
,
425 memory_order_relaxed
);
427 /* publish read packets on client's input queue */
428 pthread_mutex_lock(&client
->ibuf_mtx
);
431 stream_fifo_push(client
->ibuf_fifo
,
432 stream_fifo_pop(cache
));
434 pthread_mutex_unlock(&client
->ibuf_mtx
);
436 /* Schedule job to process those packets */
437 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
441 if (IS_ZEBRA_DEBUG_PACKET
)
442 zlog_debug("Read %d packets", p2p_orig
- p2p
);
444 /* Reschedule ourselves */
445 zserv_client_event(client
, ZSERV_CLIENT_READ
);
447 stream_fifo_free(cache
);
452 stream_fifo_free(cache
);
453 zserv_client_fail(client
);
457 static void zserv_client_event(struct zserv
*client
,
458 enum zserv_client_event event
)
461 case ZSERV_CLIENT_READ
:
462 thread_add_read(client
->pthread
->master
, zserv_read
, client
,
463 client
->sock
, &client
->t_read
);
465 case ZSERV_CLIENT_WRITE
:
466 thread_add_write(client
->pthread
->master
, zserv_write
, client
,
467 client
->sock
, &client
->t_write
);
472 /* Main thread lifecycle ---------------------------------------------------- */
475 * Read and process messages from a client.
477 * This task runs on the main pthread. It is scheduled by client pthreads when
478 * they have new messages available on their input queues. The client is passed
479 * as the task argument.
481 * Each message is popped off the client's input queue and the action associated
482 * with the message is executed. This proceeds until there are no more messages,
483 * an error occurs, or the processing limit is reached.
485 * The client's I/O thread can push at most zebrad.packets_to_process messages
486 * onto the input buffer before notifying us there are packets to read. As long
487 * as we always process zebrad.packets_to_process messages here, then we can
488 * rely on the read thread to handle queuing this task enough times to process
489 * everything on the input queue.
491 static int zserv_process_messages(struct thread
*thread
)
493 struct zserv
*client
= THREAD_ARG(thread
);
495 struct stream_fifo
*cache
= stream_fifo_new();
496 uint32_t p2p
= zebrad
.packets_to_process
;
497 bool need_resched
= false;
499 pthread_mutex_lock(&client
->ibuf_mtx
);
502 for (i
= 0; i
< p2p
&& stream_fifo_head(client
->ibuf_fifo
);
504 msg
= stream_fifo_pop(client
->ibuf_fifo
);
505 stream_fifo_push(cache
, msg
);
510 /* Need to reschedule processing work if there are still
511 * packets in the fifo.
513 if (stream_fifo_head(client
->ibuf_fifo
))
516 pthread_mutex_unlock(&client
->ibuf_mtx
);
518 while (stream_fifo_head(cache
)) {
519 msg
= stream_fifo_pop(cache
);
520 zserv_handle_commands(client
, msg
);
524 stream_fifo_free(cache
);
526 /* Reschedule ourselves if necessary */
528 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
533 int zserv_send_message(struct zserv
*client
, struct stream
*msg
)
536 * This is a somewhat poorly named variable added with Zebra's portion
537 * of the label manager. That component does not use the regular
538 * zserv/zapi_msg interface for handling its messages, as the client
539 * itself runs in-process. Instead it uses synchronous writes on the
540 * zserv client's socket directly in the zread* handlers for its
541 * message types. Furthermore, it cannot handle the usual messages
542 * Zebra sends (such as those for interface changes) and so has added
543 * this flag and check here as a hack to suppress all messages that it
544 * does not explicitly know about.
546 * In any case this needs to be cleaned up at some point.
549 * zread_label_manager_request
550 * zsend_label_manager_connect_response
551 * zsend_assign_label_chunk_response
554 if (client
->is_synchronous
)
557 pthread_mutex_lock(&client
->obuf_mtx
);
559 stream_fifo_push(client
->obuf_fifo
, msg
);
561 pthread_mutex_unlock(&client
->obuf_mtx
);
563 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
569 /* Hooks for client connect / disconnect */
570 DEFINE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
571 DEFINE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
574 * Deinitialize zebra client.
576 * - Deregister and deinitialize related internal resources
577 * - Gracefully close socket
578 * - Free associated resources
579 * - Free client structure
581 * This does *not* take any action on the struct thread * fields. These are
582 * managed by the owning pthread and any tasks associated with them must have
583 * been stopped prior to invoking this function.
585 static void zserv_client_free(struct zserv
*client
)
587 hook_call(zserv_client_close
, client
);
589 /* Close file descriptor. */
591 unsigned long nroutes
;
595 nroutes
= rib_score_proto(client
->proto
, client
->instance
);
597 "client %d disconnected. %lu %s routes removed from the rib",
598 client
->sock
, nroutes
,
599 zebra_route_string(client
->proto
));
603 /* Free stream buffers. */
604 if (client
->ibuf_work
)
605 stream_free(client
->ibuf_work
);
606 if (client
->obuf_work
)
607 stream_free(client
->obuf_work
);
608 if (client
->ibuf_fifo
)
609 stream_fifo_free(client
->ibuf_fifo
);
610 if (client
->obuf_fifo
)
611 stream_fifo_free(client
->obuf_fifo
);
613 buffer_free(client
->wb
);
615 /* Free buffer mutexes */
616 pthread_mutex_destroy(&client
->obuf_mtx
);
617 pthread_mutex_destroy(&client
->ibuf_mtx
);
620 for (afi_t afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
621 for (int i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
622 vrf_bitmap_free(client
->redist
[afi
][i
]);
624 vrf_bitmap_free(client
->redist_default
[afi
]);
626 vrf_bitmap_free(client
->ifinfo
);
627 vrf_bitmap_free(client
->ridinfo
);
629 XFREE(MTYPE_TMP
, client
);
632 void zserv_close_client(struct zserv
*client
)
634 /* synchronously stop and join pthread */
635 frr_pthread_stop(client
->pthread
, NULL
);
637 if (IS_ZEBRA_DEBUG_EVENT
)
638 zlog_debug("Closing client '%s'",
639 zebra_route_string(client
->proto
));
641 thread_cancel_event(zrouter
.master
, client
);
642 THREAD_OFF(client
->t_cleanup
);
643 THREAD_OFF(client
->t_process
);
645 /* destroy pthread */
646 frr_pthread_destroy(client
->pthread
);
647 client
->pthread
= NULL
;
649 /* remove from client list */
650 listnode_delete(zebrad
.client_list
, client
);
653 zserv_client_free(client
);
657 * This task is scheduled by a ZAPI client pthread on the main pthread when it
658 * wants to stop itself. When this executes, the client connection should
659 * already have been closed and the thread will most likely have died, but its
660 * resources still need to be cleaned up.
662 static int zserv_handle_client_fail(struct thread
*thread
)
664 struct zserv
*client
= THREAD_ARG(thread
);
666 zserv_close_client(client
);
671 * Create a new client.
673 * This is called when a new connection is accept()'d on the ZAPI socket. It
674 * initializes new client structure, notifies any subscribers of the connection
675 * event and spawns the client's thread.
678 * client's socket file descriptor
680 static struct zserv
*zserv_client_create(int sock
)
682 struct zserv
*client
;
686 client
= XCALLOC(MTYPE_TMP
, sizeof(struct zserv
));
688 /* Make client input/output buffer. */
690 client
->ibuf_fifo
= stream_fifo_new();
691 client
->obuf_fifo
= stream_fifo_new();
692 client
->ibuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
693 client
->obuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
694 pthread_mutex_init(&client
->ibuf_mtx
, NULL
);
695 pthread_mutex_init(&client
->obuf_mtx
, NULL
);
696 client
->wb
= buffer_new(0);
698 /* Set table number. */
699 client
->rtm_table
= zebrad
.rtm_table_default
;
701 atomic_store_explicit(&client
->connect_time
, (uint32_t) monotime(NULL
),
702 memory_order_relaxed
);
704 /* Initialize flags */
705 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
706 for (i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
707 client
->redist
[afi
][i
] = vrf_bitmap_init();
708 client
->redist_default
[afi
] = vrf_bitmap_init();
710 client
->ifinfo
= vrf_bitmap_init();
711 client
->ridinfo
= vrf_bitmap_init();
713 /* by default, it's not a synchronous client */
714 client
->is_synchronous
= 0;
716 /* Add this client to linked list. */
717 listnode_add(zebrad
.client_list
, client
);
719 struct frr_pthread_attr zclient_pthr_attrs
= {
720 .start
= frr_pthread_attr_default
.start
,
721 .stop
= frr_pthread_attr_default
.stop
724 frr_pthread_new(&zclient_pthr_attrs
, "Zebra API client thread",
727 /* start read loop */
728 zserv_client_event(client
, ZSERV_CLIENT_READ
);
731 hook_call(zserv_client_connect
, client
);
734 frr_pthread_run(client
->pthread
, NULL
);
740 * Accept socket connection.
742 static int zserv_accept(struct thread
*thread
)
746 struct sockaddr_in client
;
749 accept_sock
= THREAD_FD(thread
);
751 /* Reregister myself. */
752 zserv_event(NULL
, ZSERV_ACCEPT
);
754 len
= sizeof(struct sockaddr_in
);
755 client_sock
= accept(accept_sock
, (struct sockaddr
*)&client
, &len
);
757 if (client_sock
< 0) {
758 flog_err_sys(EC_LIB_SOCKET
, "Can't accept zebra socket: %s",
759 safe_strerror(errno
));
763 /* Make client socket non-blocking. */
764 set_nonblocking(client_sock
);
766 /* Create new zebra client. */
767 zserv_client_create(client_sock
);
772 void zserv_start(char *path
)
776 struct sockaddr_storage sa
;
779 if (!frr_zclient_addr(&sa
, &sa_len
, path
))
780 /* should be caught in zebra main() */
784 old_mask
= umask(0077);
786 /* Make UNIX domain socket. */
787 zebrad
.sock
= socket(sa
.ss_family
, SOCK_STREAM
, 0);
788 if (zebrad
.sock
< 0) {
789 flog_err_sys(EC_LIB_SOCKET
, "Can't create zserv socket: %s",
790 safe_strerror(errno
));
794 if (sa
.ss_family
!= AF_UNIX
) {
795 sockopt_reuseaddr(zebrad
.sock
);
796 sockopt_reuseport(zebrad
.sock
);
798 struct sockaddr_un
*suna
= (struct sockaddr_un
*)&sa
;
799 if (suna
->sun_path
[0])
800 unlink(suna
->sun_path
);
803 frr_elevate_privs(&zserv_privs
) {
804 setsockopt_so_recvbuf(zebrad
.sock
, 1048576);
805 setsockopt_so_sendbuf(zebrad
.sock
, 1048576);
808 frr_elevate_privs((sa
.ss_family
!= AF_UNIX
) ? &zserv_privs
: NULL
) {
809 ret
= bind(zebrad
.sock
, (struct sockaddr
*)&sa
, sa_len
);
812 flog_err_sys(EC_LIB_SOCKET
, "Can't bind zserv socket on %s: %s",
813 path
, safe_strerror(errno
));
819 ret
= listen(zebrad
.sock
, 5);
821 flog_err_sys(EC_LIB_SOCKET
,
822 "Can't listen to zserv socket %s: %s", path
,
823 safe_strerror(errno
));
831 zserv_event(NULL
, ZSERV_ACCEPT
);
834 void zserv_event(struct zserv
*client
, enum zserv_event event
)
838 thread_add_read(zrouter
.master
, zserv_accept
, NULL
, zebrad
.sock
,
841 case ZSERV_PROCESS_MESSAGES
:
842 thread_add_event(zrouter
.master
, zserv_process_messages
, client
,
843 0, &client
->t_process
);
845 case ZSERV_HANDLE_CLIENT_FAIL
:
846 thread_add_event(zrouter
.master
, zserv_handle_client_fail
,
847 client
, 0, &client
->t_cleanup
);
852 /* General purpose ---------------------------------------------------------- */
854 #define ZEBRA_TIME_BUF 32
855 static char *zserv_time_buf(time_t *time1
, char *buf
, int buflen
)
861 assert(buflen
>= ZEBRA_TIME_BUF
);
862 assert(time1
!= NULL
);
865 snprintf(buf
, buflen
, "never ");
869 now
= monotime(NULL
);
873 if (now
< ONE_DAY_SECOND
)
874 snprintf(buf
, buflen
, "%02d:%02d:%02d", tm
->tm_hour
, tm
->tm_min
,
876 else if (now
< ONE_WEEK_SECOND
)
877 snprintf(buf
, buflen
, "%dd%02dh%02dm", tm
->tm_yday
, tm
->tm_hour
,
880 snprintf(buf
, buflen
, "%02dw%dd%02dh", tm
->tm_yday
/ 7,
881 tm
->tm_yday
- ((tm
->tm_yday
/ 7) * 7), tm
->tm_hour
);
885 static void zebra_show_client_detail(struct vty
*vty
, struct zserv
*client
)
887 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
888 char wbuf
[ZEBRA_TIME_BUF
], nhbuf
[ZEBRA_TIME_BUF
], mbuf
[ZEBRA_TIME_BUF
];
889 time_t connect_time
, last_read_time
, last_write_time
;
890 uint32_t last_read_cmd
, last_write_cmd
;
892 vty_out(vty
, "Client: %s", zebra_route_string(client
->proto
));
893 if (client
->instance
)
894 vty_out(vty
, " Instance: %d", client
->instance
);
897 vty_out(vty
, "------------------------ \n");
898 vty_out(vty
, "FD: %d \n", client
->sock
);
899 vty_out(vty
, "Route Table ID: %d \n", client
->rtm_table
);
901 connect_time
= (time_t) atomic_load_explicit(&client
->connect_time
,
902 memory_order_relaxed
);
904 vty_out(vty
, "Connect Time: %s \n",
905 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
));
906 if (client
->nh_reg_time
) {
907 vty_out(vty
, "Nexthop Registry Time: %s \n",
908 zserv_time_buf(&client
->nh_reg_time
, nhbuf
,
910 if (client
->nh_last_upd_time
)
911 vty_out(vty
, "Nexthop Last Update Time: %s \n",
912 zserv_time_buf(&client
->nh_last_upd_time
, mbuf
,
915 vty_out(vty
, "No Nexthop Update sent\n");
917 vty_out(vty
, "Not registered for Nexthop Updates\n");
919 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
920 memory_order_relaxed
);
921 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
922 memory_order_relaxed
);
924 last_read_cmd
= atomic_load_explicit(&client
->last_read_cmd
,
925 memory_order_relaxed
);
926 last_write_cmd
= atomic_load_explicit(&client
->last_write_cmd
,
927 memory_order_relaxed
);
929 vty_out(vty
, "Last Msg Rx Time: %s \n",
930 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
));
931 vty_out(vty
, "Last Msg Tx Time: %s \n",
932 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
));
934 vty_out(vty
, "Last Rcvd Cmd: %s \n",
935 zserv_command_string(last_read_cmd
));
937 vty_out(vty
, "Last Sent Cmd: %s \n",
938 zserv_command_string(last_write_cmd
));
941 vty_out(vty
, "Type Add Update Del \n");
942 vty_out(vty
, "================================================== \n");
943 vty_out(vty
, "IPv4 %-12d%-12d%-12d\n", client
->v4_route_add_cnt
,
944 client
->v4_route_upd8_cnt
, client
->v4_route_del_cnt
);
945 vty_out(vty
, "IPv6 %-12d%-12d%-12d\n", client
->v6_route_add_cnt
,
946 client
->v6_route_upd8_cnt
, client
->v6_route_del_cnt
);
947 vty_out(vty
, "Redist:v4 %-12d%-12d%-12d\n", client
->redist_v4_add_cnt
,
948 0, client
->redist_v4_del_cnt
);
949 vty_out(vty
, "Redist:v6 %-12d%-12d%-12d\n", client
->redist_v6_add_cnt
,
950 0, client
->redist_v6_del_cnt
);
951 vty_out(vty
, "Connected %-12d%-12d%-12d\n", client
->ifadd_cnt
, 0,
953 vty_out(vty
, "BFD peer %-12d%-12d%-12d\n", client
->bfd_peer_add_cnt
,
954 client
->bfd_peer_upd8_cnt
, client
->bfd_peer_del_cnt
);
955 vty_out(vty
, "NHT v4 %-12d%-12d%-12d\n",
956 client
->v4_nh_watch_add_cnt
, 0, client
->v4_nh_watch_rem_cnt
);
957 vty_out(vty
, "NHT v6 %-12d%-12d%-12d\n",
958 client
->v6_nh_watch_add_cnt
, 0, client
->v6_nh_watch_rem_cnt
);
959 vty_out(vty
, "Interface Up Notifications: %d\n", client
->ifup_cnt
);
960 vty_out(vty
, "Interface Down Notifications: %d\n", client
->ifdown_cnt
);
961 vty_out(vty
, "VNI add notifications: %d\n", client
->vniadd_cnt
);
962 vty_out(vty
, "VNI delete notifications: %d\n", client
->vnidel_cnt
);
963 vty_out(vty
, "L3-VNI add notifications: %d\n", client
->l3vniadd_cnt
);
964 vty_out(vty
, "L3-VNI delete notifications: %d\n", client
->l3vnidel_cnt
);
965 vty_out(vty
, "MAC-IP add notifications: %d\n", client
->macipadd_cnt
);
966 vty_out(vty
, "MAC-IP delete notifications: %d\n", client
->macipdel_cnt
);
968 #if defined DEV_BUILD
969 vty_out(vty
, "Input Fifo: %zu:%zu Output Fifo: %zu:%zu\n",
970 client
->ibuf_fifo
->count
, client
->ibuf_fifo
->max_count
,
971 client
->obuf_fifo
->count
, client
->obuf_fifo
->max_count
);
977 static void zebra_show_client_brief(struct vty
*vty
, struct zserv
*client
)
979 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
980 char wbuf
[ZEBRA_TIME_BUF
];
981 time_t connect_time
, last_read_time
, last_write_time
;
983 connect_time
= (time_t)atomic_load_explicit(&client
->connect_time
,
984 memory_order_relaxed
);
985 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
986 memory_order_relaxed
);
987 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
988 memory_order_relaxed
);
990 vty_out(vty
, "%-8s%12s %12s%12s%8d/%-8d%8d/%-8d\n",
991 zebra_route_string(client
->proto
),
992 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
),
993 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
),
994 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
),
995 client
->v4_route_add_cnt
+ client
->v4_route_upd8_cnt
,
996 client
->v4_route_del_cnt
,
997 client
->v6_route_add_cnt
+ client
->v6_route_upd8_cnt
,
998 client
->v6_route_del_cnt
);
1001 struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
)
1003 struct listnode
*node
, *nnode
;
1004 struct zserv
*client
;
1006 for (ALL_LIST_ELEMENTS(zebrad
.client_list
, node
, nnode
, client
)) {
1007 if (client
->proto
== proto
&& client
->instance
== instance
)
1014 /* This command is for debugging purpose. */
1015 DEFUN (show_zebra_client
,
1016 show_zebra_client_cmd
,
1017 "show zebra client",
1020 "Client information\n")
1022 struct listnode
*node
;
1023 struct zserv
*client
;
1025 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1026 zebra_show_client_detail(vty
, client
);
1031 /* This command is for debugging purpose. */
1032 DEFUN (show_zebra_client_summary
,
1033 show_zebra_client_summary_cmd
,
1034 "show zebra client summary",
1037 "Client information brief\n"
1040 struct listnode
*node
;
1041 struct zserv
*client
;
1044 "Name Connect Time Last Read Last Write IPv4 Routes IPv6 Routes \n");
1046 "--------------------------------------------------------------------------------\n");
1048 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1049 zebra_show_client_brief(vty
, client
);
1051 vty_out(vty
, "Routes column shows (added+updated)/deleted\n");
1055 #if defined(HANDLE_ZAPI_FUZZING)
1056 void zserv_read_file(char *input
)
1061 fd
= open(input
, O_RDONLY
| O_NONBLOCK
);
1064 zserv_client_create(fd
);
1068 void zserv_init(void)
1070 /* Client list init. */
1071 zebrad
.client_list
= list_new();
1076 install_element(ENABLE_NODE
, &show_zebra_client_cmd
);
1077 install_element(ENABLE_NODE
, &show_zebra_client_summary_cmd
);