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_errors.h" /* for error messages */
68 extern struct zebra_privs_t zserv_privs
;
71 * Client thread events.
73 * These are used almost exclusively by client threads to drive their own event
74 * loops. The only exception is in zserv_client_create(), which pushes an
75 * initial ZSERV_CLIENT_READ event to start the API handler loop.
77 enum zserv_client_event
{
78 /* Schedule a socket read */
80 /* Schedule a buffer write */
87 * These are used by client threads to notify the main thread about various
88 * events and to make processing requests.
91 /* Schedule listen job on Zebra API socket */
93 /* The calling client has packets on its input buffer */
94 ZSERV_PROCESS_MESSAGES
,
95 /* The calling client wishes to be killed */
96 ZSERV_HANDLE_CLIENT_FAIL
,
100 * Zebra server event driver for all client threads.
102 * This is essentially a wrapper around thread_add_event() that centralizes
103 * those scheduling calls into one place.
105 * All calls to this function schedule an event on the pthread running the
109 * the client in question, and thread target
112 * the event to notify them about
114 static void zserv_client_event(struct zserv
*client
,
115 enum zserv_client_event event
);
118 * Zebra server event driver for the main thread.
120 * This is essentially a wrapper around thread_add_event() that centralizes
121 * those scheduling calls into one place.
123 * All calls to this function schedule an event on Zebra's main pthread.
126 * the client in question
129 * the event to notify the main thread about
131 static void zserv_event(struct zserv
*client
, enum zserv_event event
);
134 /* Client thread lifecycle -------------------------------------------------- */
137 * Log zapi message to zlog.
148 static void zserv_log_message(const char *errmsg
, struct stream
*msg
,
151 zlog_debug("Rx'd ZAPI message");
153 zlog_debug("%s", errmsg
);
155 zlog_debug(" Length: %d", hdr
->length
);
156 zlog_debug("Command: %s", zserv_command_string(hdr
->command
));
157 zlog_debug(" VRF: %u", hdr
->vrf_id
);
159 zlog_hexdump(msg
->data
, STREAM_READABLE(msg
));
163 * Gracefully shut down a client connection.
165 * Cancel any pending tasks for the client's thread. Then schedule a task on
166 * the main thread to shut down the calling thread.
168 * It is not safe to close the client socket in this function. The socket is
169 * owned by the main thread.
171 * Must be called from the client pthread, never the main thread.
173 static void zserv_client_fail(struct zserv
*client
)
175 flog_warn(EC_ZEBRA_CLIENT_IO_ERROR
,
176 "Client '%s' encountered an error and is shutting down.",
177 zebra_route_string(client
->proto
));
179 atomic_store_explicit(&client
->pthread
->running
, false,
180 memory_order_relaxed
);
182 THREAD_OFF(client
->t_read
);
183 THREAD_OFF(client
->t_write
);
184 zserv_event(client
, ZSERV_HANDLE_CLIENT_FAIL
);
188 * Write all pending messages to client socket.
190 * This function first attempts to flush any buffered data. If unsuccessful,
191 * the function reschedules itself and returns. If successful, it pops all
192 * available messages from the output queue and continues to write data
193 * directly to the socket until the socket would block. If the socket never
194 * blocks and all data is written, the function returns without rescheduling
195 * itself. If the socket ends up throwing EWOULDBLOCK, the remaining data is
196 * buffered and the function reschedules itself.
198 * The utility of the buffer is that it allows us to vastly reduce lock
199 * contention by allowing us to pop *all* messages off the output queue at once
200 * instead of locking and unlocking each time we want to pop a single message
201 * off the queue. The same thing could arguably be accomplished faster by
202 * allowing the main thread to write directly into the buffer instead of
203 * enqueuing packets onto an intermediary queue, but the intermediary queue
204 * allows us to expose information about input and output queues to the user in
205 * terms of number of packets rather than size of data.
207 static int zserv_write(struct thread
*thread
)
209 struct zserv
*client
= THREAD_ARG(thread
);
212 struct stream_fifo
*cache
;
214 /* If we have any data pending, try to flush it first */
215 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
219 atomic_store_explicit(&client
->last_write_time
,
220 (uint32_t)monotime(NULL
),
221 memory_order_relaxed
);
222 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
228 cache
= stream_fifo_new();
230 pthread_mutex_lock(&client
->obuf_mtx
);
232 while (stream_fifo_head(client
->obuf_fifo
))
233 stream_fifo_push(cache
,
234 stream_fifo_pop(client
->obuf_fifo
));
236 pthread_mutex_unlock(&client
->obuf_mtx
);
240 stream_set_getp(msg
, 0);
241 wcmd
= stream_getw_from(msg
, 6);
244 while (stream_fifo_head(cache
)) {
245 msg
= stream_fifo_pop(cache
);
246 buffer_put(client
->wb
, STREAM_DATA(msg
), stream_get_endp(msg
));
250 stream_fifo_free(cache
);
252 /* If we have any data pending, try to flush it first */
253 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
257 atomic_store_explicit(&client
->last_write_time
,
258 (uint32_t)monotime(NULL
),
259 memory_order_relaxed
);
260 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
266 atomic_store_explicit(&client
->last_write_cmd
, wcmd
,
267 memory_order_relaxed
);
269 atomic_store_explicit(&client
->last_write_time
,
270 (uint32_t)monotime(NULL
), memory_order_relaxed
);
275 flog_warn(EC_ZEBRA_CLIENT_WRITE_FAILED
,
276 "%s: could not write to %s [fd = %d], closing.", __func__
,
277 zebra_route_string(client
->proto
), client
->sock
);
278 zserv_client_fail(client
);
283 * Read and process data from a client socket.
285 * The responsibilities here are to read raw data from the client socket,
286 * validate the header, encapsulate it into a single stream object, push it
287 * onto the input queue and then notify the main thread that there is new data
290 * This function first looks for any data in the client structure's working
291 * input buffer. If data is present, it is assumed that reading stopped in a
292 * previous invocation of this task and needs to be resumed to finish a message.
293 * Otherwise, the socket data stream is assumed to be at the beginning of a new
294 * ZAPI message (specifically at the header). The header is read and validated.
295 * If the header passed validation then the length field found in the header is
296 * used to compute the total length of the message. That much data is read (but
297 * not inspected), appended to the header, placed into a stream and pushed onto
298 * the client's input queue. A task is then scheduled on the main thread to
299 * process the client's input queue. Finally, if all of this was successful,
300 * this task reschedules itself.
302 * Any failure in any of these actions is handled by terminating the client.
304 static int zserv_read(struct thread
*thread
)
306 struct zserv
*client
= THREAD_ARG(thread
);
309 struct stream_fifo
*cache
;
315 p2p_orig
= atomic_load_explicit(&zebrad
.packets_to_process
,
316 memory_order_relaxed
);
317 cache
= stream_fifo_new();
319 sock
= THREAD_FD(thread
);
326 already
= stream_get_endp(client
->ibuf_work
);
328 /* Read length and command (if we don't have it already). */
329 if (already
< ZEBRA_HEADER_SIZE
) {
330 nb
= stream_read_try(client
->ibuf_work
, sock
,
331 ZEBRA_HEADER_SIZE
- already
);
332 if ((nb
== 0 || nb
== -1)) {
333 if (IS_ZEBRA_DEBUG_EVENT
)
334 zlog_debug("connection closed socket [%d]",
338 if (nb
!= (ssize_t
)(ZEBRA_HEADER_SIZE
- already
)) {
339 /* Try again later. */
342 already
= ZEBRA_HEADER_SIZE
;
345 /* Reset to read from the beginning of the incoming packet. */
346 stream_set_getp(client
->ibuf_work
, 0);
348 /* Fetch header values */
349 hdrvalid
= zapi_parse_header(client
->ibuf_work
, &hdr
);
352 snprintf(errmsg
, sizeof(errmsg
),
353 "%s: Message has corrupt header", __func__
);
354 zserv_log_message(errmsg
, client
->ibuf_work
, NULL
);
358 /* Validate header */
359 if (hdr
.marker
!= ZEBRA_HEADER_MARKER
360 || hdr
.version
!= ZSERV_VERSION
) {
362 errmsg
, sizeof(errmsg
),
363 "Message has corrupt header\n%s: socket %d version mismatch, marker %d, version %d",
364 __func__
, sock
, hdr
.marker
, hdr
.version
);
365 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
368 if (hdr
.length
< ZEBRA_HEADER_SIZE
) {
370 errmsg
, sizeof(errmsg
),
371 "Message has corrupt header\n%s: socket %d message length %u is less than header size %d",
372 __func__
, sock
, hdr
.length
, ZEBRA_HEADER_SIZE
);
373 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
376 if (hdr
.length
> STREAM_SIZE(client
->ibuf_work
)) {
378 errmsg
, sizeof(errmsg
),
379 "Message has corrupt header\n%s: socket %d message length %u exceeds buffer size %lu",
380 __func__
, sock
, hdr
.length
,
381 (unsigned long)STREAM_SIZE(client
->ibuf_work
));
382 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
386 /* Read rest of data. */
387 if (already
< hdr
.length
) {
388 nb
= stream_read_try(client
->ibuf_work
, sock
,
389 hdr
.length
- already
);
390 if ((nb
== 0 || nb
== -1)) {
391 if (IS_ZEBRA_DEBUG_EVENT
)
393 "connection closed [%d] when reading zebra data",
397 if (nb
!= (ssize_t
)(hdr
.length
- already
)) {
398 /* Try again later. */
403 /* Debug packet information. */
404 if (IS_ZEBRA_DEBUG_EVENT
)
405 zlog_debug("zebra message comes from socket [%d]",
408 if (IS_ZEBRA_DEBUG_PACKET
&& IS_ZEBRA_DEBUG_RECV
)
409 zserv_log_message(NULL
, client
->ibuf_work
, &hdr
);
411 stream_set_getp(client
->ibuf_work
, 0);
412 struct stream
*msg
= stream_dup(client
->ibuf_work
);
414 stream_fifo_push(cache
, msg
);
415 stream_reset(client
->ibuf_work
);
419 if (p2p
< p2p_orig
) {
420 /* update session statistics */
421 atomic_store_explicit(&client
->last_read_time
, monotime(NULL
),
422 memory_order_relaxed
);
423 atomic_store_explicit(&client
->last_read_cmd
, hdr
.command
,
424 memory_order_relaxed
);
426 /* publish read packets on client's input queue */
427 pthread_mutex_lock(&client
->ibuf_mtx
);
430 stream_fifo_push(client
->ibuf_fifo
,
431 stream_fifo_pop(cache
));
433 pthread_mutex_unlock(&client
->ibuf_mtx
);
435 /* Schedule job to process those packets */
436 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
440 if (IS_ZEBRA_DEBUG_PACKET
)
441 zlog_debug("Read %d packets", p2p_orig
- p2p
);
443 /* Reschedule ourselves */
444 zserv_client_event(client
, ZSERV_CLIENT_READ
);
446 stream_fifo_free(cache
);
451 stream_fifo_free(cache
);
452 zserv_client_fail(client
);
456 static void zserv_client_event(struct zserv
*client
,
457 enum zserv_client_event event
)
460 case ZSERV_CLIENT_READ
:
461 thread_add_read(client
->pthread
->master
, zserv_read
, client
,
462 client
->sock
, &client
->t_read
);
464 case ZSERV_CLIENT_WRITE
:
465 thread_add_write(client
->pthread
->master
, zserv_write
, client
,
466 client
->sock
, &client
->t_write
);
471 /* Main thread lifecycle ---------------------------------------------------- */
474 * Read and process messages from a client.
476 * This task runs on the main pthread. It is scheduled by client pthreads when
477 * they have new messages available on their input queues. The client is passed
478 * as the task argument.
480 * Each message is popped off the client's input queue and the action associated
481 * with the message is executed. This proceeds until there are no more messages,
482 * an error occurs, or the processing limit is reached.
484 * The client's I/O thread can push at most zebrad.packets_to_process messages
485 * onto the input buffer before notifying us there are packets to read. As long
486 * as we always process zebrad.packets_to_process messages here, then we can
487 * rely on the read thread to handle queuing this task enough times to process
488 * everything on the input queue.
490 static int zserv_process_messages(struct thread
*thread
)
492 struct zserv
*client
= THREAD_ARG(thread
);
494 struct stream_fifo
*cache
= stream_fifo_new();
496 uint32_t p2p
= zebrad
.packets_to_process
;
498 pthread_mutex_lock(&client
->ibuf_mtx
);
501 for (i
= 0; i
< p2p
&& stream_fifo_head(client
->ibuf_fifo
);
503 msg
= stream_fifo_pop(client
->ibuf_fifo
);
504 stream_fifo_push(cache
, msg
);
509 pthread_mutex_unlock(&client
->ibuf_mtx
);
511 while (stream_fifo_head(cache
)) {
512 msg
= stream_fifo_pop(cache
);
513 zserv_handle_commands(client
, msg
);
517 stream_fifo_free(cache
);
522 int zserv_send_message(struct zserv
*client
, struct stream
*msg
)
525 * This is a somewhat poorly named variable added with Zebra's portion
526 * of the label manager. That component does not use the regular
527 * zserv/zapi_msg interface for handling its messages, as the client
528 * itself runs in-process. Instead it uses synchronous writes on the
529 * zserv client's socket directly in the zread* handlers for its
530 * message types. Furthermore, it cannot handle the usual messages
531 * Zebra sends (such as those for interface changes) and so has added
532 * this flag and check here as a hack to suppress all messages that it
533 * does not explicitly know about.
535 * In any case this needs to be cleaned up at some point.
538 * zread_label_manager_request
539 * zsend_label_manager_connect_response
540 * zsend_assign_label_chunk_response
543 if (client
->is_synchronous
)
546 pthread_mutex_lock(&client
->obuf_mtx
);
548 stream_fifo_push(client
->obuf_fifo
, msg
);
550 pthread_mutex_unlock(&client
->obuf_mtx
);
552 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
558 /* Hooks for client connect / disconnect */
559 DEFINE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
560 DEFINE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
563 * Deinitialize zebra client.
565 * - Deregister and deinitialize related internal resources
566 * - Gracefully close socket
567 * - Free associated resources
568 * - Free client structure
570 * This does *not* take any action on the struct thread * fields. These are
571 * managed by the owning pthread and any tasks associated with them must have
572 * been stopped prior to invoking this function.
574 static void zserv_client_free(struct zserv
*client
)
576 hook_call(zserv_client_close
, client
);
578 /* Close file descriptor. */
580 unsigned long nroutes
;
584 nroutes
= rib_score_proto(client
->proto
, client
->instance
);
586 "client %d disconnected. %lu %s routes removed from the rib",
587 client
->sock
, nroutes
,
588 zebra_route_string(client
->proto
));
592 /* Free stream buffers. */
593 if (client
->ibuf_work
)
594 stream_free(client
->ibuf_work
);
595 if (client
->obuf_work
)
596 stream_free(client
->obuf_work
);
597 if (client
->ibuf_fifo
)
598 stream_fifo_free(client
->ibuf_fifo
);
599 if (client
->obuf_fifo
)
600 stream_fifo_free(client
->obuf_fifo
);
602 buffer_free(client
->wb
);
604 /* Free buffer mutexes */
605 pthread_mutex_destroy(&client
->obuf_mtx
);
606 pthread_mutex_destroy(&client
->ibuf_mtx
);
609 for (afi_t afi
= AFI_IP
; afi
< AFI_MAX
; afi
++)
610 for (int i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
611 vrf_bitmap_free(client
->redist
[afi
][i
]);
613 vrf_bitmap_free(client
->redist_default
);
614 vrf_bitmap_free(client
->ifinfo
);
615 vrf_bitmap_free(client
->ridinfo
);
617 XFREE(MTYPE_TMP
, client
);
620 void zserv_close_client(struct zserv
*client
)
622 /* synchronously stop and join pthread */
623 frr_pthread_stop(client
->pthread
, NULL
);
625 if (IS_ZEBRA_DEBUG_EVENT
)
626 zlog_debug("Closing client '%s'",
627 zebra_route_string(client
->proto
));
629 thread_cancel_event(zebrad
.master
, client
);
630 THREAD_OFF(client
->t_cleanup
);
632 /* destroy pthread */
633 frr_pthread_destroy(client
->pthread
);
634 client
->pthread
= NULL
;
636 /* remove from client list */
637 listnode_delete(zebrad
.client_list
, client
);
640 zserv_client_free(client
);
644 * This task is scheduled by a ZAPI client pthread on the main pthread when it
645 * wants to stop itself. When this executes, the client connection should
646 * already have been closed and the thread will most likely have died, but its
647 * resources still need to be cleaned up.
649 static int zserv_handle_client_fail(struct thread
*thread
)
651 struct zserv
*client
= THREAD_ARG(thread
);
653 zserv_close_client(client
);
658 * Create a new client.
660 * This is called when a new connection is accept()'d on the ZAPI socket. It
661 * initializes new client structure, notifies any subscribers of the connection
662 * event and spawns the client's thread.
665 * client's socket file descriptor
667 static struct zserv
*zserv_client_create(int sock
)
669 struct zserv
*client
;
673 client
= XCALLOC(MTYPE_TMP
, sizeof(struct zserv
));
675 /* Make client input/output buffer. */
677 client
->ibuf_fifo
= stream_fifo_new();
678 client
->obuf_fifo
= stream_fifo_new();
679 client
->ibuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
680 client
->obuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
681 pthread_mutex_init(&client
->ibuf_mtx
, NULL
);
682 pthread_mutex_init(&client
->obuf_mtx
, NULL
);
683 client
->wb
= buffer_new(0);
685 /* Set table number. */
686 client
->rtm_table
= zebrad
.rtm_table_default
;
688 atomic_store_explicit(&client
->connect_time
, (uint32_t) monotime(NULL
),
689 memory_order_relaxed
);
691 /* Initialize flags */
692 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++)
693 for (i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
694 client
->redist
[afi
][i
] = vrf_bitmap_init();
695 client
->redist_default
= vrf_bitmap_init();
696 client
->ifinfo
= vrf_bitmap_init();
697 client
->ridinfo
= vrf_bitmap_init();
699 /* by default, it's not a synchronous client */
700 client
->is_synchronous
= 0;
702 /* Add this client to linked list. */
703 listnode_add(zebrad
.client_list
, client
);
705 struct frr_pthread_attr zclient_pthr_attrs
= {
706 .id
= frr_pthread_get_id(),
707 .start
= frr_pthread_attr_default
.start
,
708 .stop
= frr_pthread_attr_default
.stop
711 frr_pthread_new(&zclient_pthr_attrs
, "Zebra API client thread",
714 zebra_vrf_update_all(client
);
716 /* start read loop */
717 zserv_client_event(client
, ZSERV_CLIENT_READ
);
720 hook_call(zserv_client_connect
, client
);
723 frr_pthread_run(client
->pthread
, NULL
);
729 * Accept socket connection.
731 static int zserv_accept(struct thread
*thread
)
735 struct sockaddr_in client
;
738 accept_sock
= THREAD_FD(thread
);
740 /* Reregister myself. */
741 zserv_event(NULL
, ZSERV_ACCEPT
);
743 len
= sizeof(struct sockaddr_in
);
744 client_sock
= accept(accept_sock
, (struct sockaddr
*)&client
, &len
);
746 if (client_sock
< 0) {
747 flog_err_sys(EC_LIB_SOCKET
, "Can't accept zebra socket: %s",
748 safe_strerror(errno
));
752 /* Make client socket non-blocking. */
753 set_nonblocking(client_sock
);
755 /* Create new zebra client. */
756 zserv_client_create(client_sock
);
761 void zserv_start(char *path
)
765 struct sockaddr_storage sa
;
768 if (!frr_zclient_addr(&sa
, &sa_len
, path
))
769 /* should be caught in zebra main() */
773 old_mask
= umask(0077);
775 /* Make UNIX domain socket. */
776 zebrad
.sock
= socket(sa
.ss_family
, SOCK_STREAM
, 0);
777 if (zebrad
.sock
< 0) {
778 flog_err_sys(EC_LIB_SOCKET
, "Can't create zserv socket: %s",
779 safe_strerror(errno
));
783 if (sa
.ss_family
!= AF_UNIX
) {
784 sockopt_reuseaddr(zebrad
.sock
);
785 sockopt_reuseport(zebrad
.sock
);
787 struct sockaddr_un
*suna
= (struct sockaddr_un
*)&sa
;
788 if (suna
->sun_path
[0])
789 unlink(suna
->sun_path
);
792 frr_elevate_privs(&zserv_privs
) {
793 setsockopt_so_recvbuf(zebrad
.sock
, 1048576);
794 setsockopt_so_sendbuf(zebrad
.sock
, 1048576);
797 frr_elevate_privs((sa
.ss_family
!= AF_UNIX
) ? &zserv_privs
: NULL
) {
798 ret
= bind(zebrad
.sock
, (struct sockaddr
*)&sa
, sa_len
);
801 flog_err_sys(EC_LIB_SOCKET
, "Can't bind zserv socket on %s: %s",
802 path
, safe_strerror(errno
));
808 ret
= listen(zebrad
.sock
, 5);
810 flog_err_sys(EC_LIB_SOCKET
,
811 "Can't listen to zserv socket %s: %s", path
,
812 safe_strerror(errno
));
820 zserv_event(NULL
, ZSERV_ACCEPT
);
823 void zserv_event(struct zserv
*client
, enum zserv_event event
)
827 thread_add_read(zebrad
.master
, zserv_accept
, NULL
, zebrad
.sock
,
830 case ZSERV_PROCESS_MESSAGES
:
831 thread_add_event(zebrad
.master
, zserv_process_messages
, client
,
834 case ZSERV_HANDLE_CLIENT_FAIL
:
835 thread_add_event(zebrad
.master
, zserv_handle_client_fail
,
836 client
, 0, &client
->t_cleanup
);
841 /* General purpose ---------------------------------------------------------- */
843 #define ZEBRA_TIME_BUF 32
844 static char *zserv_time_buf(time_t *time1
, char *buf
, int buflen
)
850 assert(buflen
>= ZEBRA_TIME_BUF
);
851 assert(time1
!= NULL
);
854 snprintf(buf
, buflen
, "never ");
858 now
= monotime(NULL
);
862 if (now
< ONE_DAY_SECOND
)
863 snprintf(buf
, buflen
, "%02d:%02d:%02d", tm
->tm_hour
, tm
->tm_min
,
865 else if (now
< ONE_WEEK_SECOND
)
866 snprintf(buf
, buflen
, "%dd%02dh%02dm", tm
->tm_yday
, tm
->tm_hour
,
869 snprintf(buf
, buflen
, "%02dw%dd%02dh", tm
->tm_yday
/ 7,
870 tm
->tm_yday
- ((tm
->tm_yday
/ 7) * 7), tm
->tm_hour
);
874 static void zebra_show_client_detail(struct vty
*vty
, struct zserv
*client
)
876 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
877 char wbuf
[ZEBRA_TIME_BUF
], nhbuf
[ZEBRA_TIME_BUF
], mbuf
[ZEBRA_TIME_BUF
];
878 time_t connect_time
, last_read_time
, last_write_time
;
879 uint16_t last_read_cmd
, last_write_cmd
;
881 vty_out(vty
, "Client: %s", zebra_route_string(client
->proto
));
882 if (client
->instance
)
883 vty_out(vty
, " Instance: %d", client
->instance
);
886 vty_out(vty
, "------------------------ \n");
887 vty_out(vty
, "FD: %d \n", client
->sock
);
888 vty_out(vty
, "Route Table ID: %d \n", client
->rtm_table
);
890 connect_time
= (time_t) atomic_load_explicit(&client
->connect_time
,
891 memory_order_relaxed
);
893 vty_out(vty
, "Connect Time: %s \n",
894 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
));
895 if (client
->nh_reg_time
) {
896 vty_out(vty
, "Nexthop Registry Time: %s \n",
897 zserv_time_buf(&client
->nh_reg_time
, nhbuf
,
899 if (client
->nh_last_upd_time
)
900 vty_out(vty
, "Nexthop Last Update Time: %s \n",
901 zserv_time_buf(&client
->nh_last_upd_time
, mbuf
,
904 vty_out(vty
, "No Nexthop Update sent\n");
906 vty_out(vty
, "Not registered for Nexthop Updates\n");
908 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
909 memory_order_relaxed
);
910 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
911 memory_order_relaxed
);
913 last_read_cmd
= atomic_load_explicit(&client
->last_read_cmd
,
914 memory_order_relaxed
);
915 last_write_cmd
= atomic_load_explicit(&client
->last_write_cmd
,
916 memory_order_relaxed
);
918 vty_out(vty
, "Last Msg Rx Time: %s \n",
919 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
));
920 vty_out(vty
, "Last Msg Tx Time: %s \n",
921 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
));
923 vty_out(vty
, "Last Rcvd Cmd: %s \n",
924 zserv_command_string(last_read_cmd
));
926 vty_out(vty
, "Last Sent Cmd: %s \n",
927 zserv_command_string(last_write_cmd
));
930 vty_out(vty
, "Type Add Update Del \n");
931 vty_out(vty
, "================================================== \n");
932 vty_out(vty
, "IPv4 %-12d%-12d%-12d\n", client
->v4_route_add_cnt
,
933 client
->v4_route_upd8_cnt
, client
->v4_route_del_cnt
);
934 vty_out(vty
, "IPv6 %-12d%-12d%-12d\n", client
->v6_route_add_cnt
,
935 client
->v6_route_upd8_cnt
, client
->v6_route_del_cnt
);
936 vty_out(vty
, "Redist:v4 %-12d%-12d%-12d\n", client
->redist_v4_add_cnt
,
937 0, client
->redist_v4_del_cnt
);
938 vty_out(vty
, "Redist:v6 %-12d%-12d%-12d\n", client
->redist_v6_add_cnt
,
939 0, client
->redist_v6_del_cnt
);
940 vty_out(vty
, "Connected %-12d%-12d%-12d\n", client
->ifadd_cnt
, 0,
942 vty_out(vty
, "BFD peer %-12d%-12d%-12d\n", client
->bfd_peer_add_cnt
,
943 client
->bfd_peer_upd8_cnt
, client
->bfd_peer_del_cnt
);
944 vty_out(vty
, "Interface Up Notifications: %d\n", client
->ifup_cnt
);
945 vty_out(vty
, "Interface Down Notifications: %d\n", client
->ifdown_cnt
);
946 vty_out(vty
, "VNI add notifications: %d\n", client
->vniadd_cnt
);
947 vty_out(vty
, "VNI delete notifications: %d\n", client
->vnidel_cnt
);
948 vty_out(vty
, "L3-VNI add notifications: %d\n", client
->l3vniadd_cnt
);
949 vty_out(vty
, "L3-VNI delete notifications: %d\n", client
->l3vnidel_cnt
);
950 vty_out(vty
, "MAC-IP add notifications: %d\n", client
->macipadd_cnt
);
951 vty_out(vty
, "MAC-IP delete notifications: %d\n", client
->macipdel_cnt
);
953 #if defined DEV_BUILD
954 vty_out(vty
, "Input Fifo: %zu:%zu Output Fifo: %zu:%zu\n",
955 client
->ibuf_fifo
->count
, client
->ibuf_fifo
->max_count
,
956 client
->obuf_fifo
->count
, client
->obuf_fifo
->max_count
);
962 static void zebra_show_client_brief(struct vty
*vty
, struct zserv
*client
)
964 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
965 char wbuf
[ZEBRA_TIME_BUF
];
966 time_t connect_time
, last_read_time
, last_write_time
;
968 connect_time
= (time_t)atomic_load_explicit(&client
->connect_time
,
969 memory_order_relaxed
);
970 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
971 memory_order_relaxed
);
972 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
973 memory_order_relaxed
);
975 vty_out(vty
, "%-8s%12s %12s%12s%8d/%-8d%8d/%-8d\n",
976 zebra_route_string(client
->proto
),
977 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
),
978 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
),
979 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
),
980 client
->v4_route_add_cnt
+ client
->v4_route_upd8_cnt
,
981 client
->v4_route_del_cnt
,
982 client
->v6_route_add_cnt
+ client
->v6_route_upd8_cnt
,
983 client
->v6_route_del_cnt
);
986 struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
)
988 struct listnode
*node
, *nnode
;
989 struct zserv
*client
;
991 for (ALL_LIST_ELEMENTS(zebrad
.client_list
, node
, nnode
, client
)) {
992 if (client
->proto
== proto
&& client
->instance
== instance
)
999 /* This command is for debugging purpose. */
1000 DEFUN (show_zebra_client
,
1001 show_zebra_client_cmd
,
1002 "show zebra client",
1005 "Client information\n")
1007 struct listnode
*node
;
1008 struct zserv
*client
;
1010 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1011 zebra_show_client_detail(vty
, client
);
1016 /* This command is for debugging purpose. */
1017 DEFUN (show_zebra_client_summary
,
1018 show_zebra_client_summary_cmd
,
1019 "show zebra client summary",
1022 "Client information brief\n"
1025 struct listnode
*node
;
1026 struct zserv
*client
;
1029 "Name Connect Time Last Read Last Write IPv4 Routes IPv6 Routes \n");
1031 "--------------------------------------------------------------------------------\n");
1033 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1034 zebra_show_client_brief(vty
, client
);
1036 vty_out(vty
, "Routes column shows (added+updated)/deleted\n");
1040 #if defined(HANDLE_ZAPI_FUZZING)
1041 void zserv_read_file(char *input
)
1046 fd
= open(input
, O_RDONLY
| O_NONBLOCK
);
1049 zserv_client_create(fd
);
1053 void zserv_init(void)
1055 /* Client list init. */
1056 zebrad
.client_list
= list_new();
1061 install_element(ENABLE_NODE
, &show_zebra_client_cmd
);
1062 install_element(ENABLE_NODE
, &show_zebra_client_summary_cmd
);