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 */
67 extern struct zebra_privs_t zserv_privs
;
70 * Client thread events.
72 * These are used almost exclusively by client threads to drive their own event
73 * loops. The only exception is in zserv_client_create(), which pushes an
74 * initial ZSERV_CLIENT_READ event to start the API handler loop.
76 enum zserv_client_event
{
77 /* Schedule a socket read */
79 /* Schedule a buffer write */
86 * These are used by client threads to notify the main thread about various
87 * events and to make processing requests.
90 /* Schedule listen job on Zebra API socket */
92 /* The calling client has packets on its input buffer */
93 ZSERV_PROCESS_MESSAGES
,
94 /* The calling client wishes to be killed */
95 ZSERV_HANDLE_CLIENT_FAIL
,
99 * Zebra server event driver for all client threads.
101 * This is essentially a wrapper around thread_add_event() that centralizes
102 * those scheduling calls into one place.
104 * All calls to this function schedule an event on the pthread running the
108 * the client in question, and thread target
111 * the event to notify them about
113 static void zserv_client_event(struct zserv
*client
,
114 enum zserv_client_event event
);
117 * Zebra server event driver for the main thread.
119 * This is essentially a wrapper around thread_add_event() that centralizes
120 * those scheduling calls into one place.
122 * All calls to this function schedule an event on Zebra's main pthread.
125 * the client in question
128 * the event to notify the main thread about
130 static void zserv_event(struct zserv
*client
, enum zserv_event event
);
133 /* Client thread lifecycle -------------------------------------------------- */
136 * Log zapi message to zlog.
147 static void zserv_log_message(const char *errmsg
, struct stream
*msg
,
150 zlog_debug("Rx'd ZAPI message");
152 zlog_debug("%s", errmsg
);
154 zlog_debug(" Length: %d", hdr
->length
);
155 zlog_debug("Command: %s", zserv_command_string(hdr
->command
));
156 zlog_debug(" VRF: %u", hdr
->vrf_id
);
158 zlog_hexdump(msg
->data
, STREAM_READABLE(msg
));
162 * Gracefully shut down a client connection.
164 * Cancel any pending tasks for the client's thread. Then schedule a task on
165 * the main thread to shut down the calling thread.
167 * It is not safe to close the client socket in this function. The socket is
168 * owned by the main thread.
170 * Must be called from the client pthread, never the main thread.
172 static void zserv_client_fail(struct zserv
*client
)
174 zlog_warn("Client '%s' encountered an error and is shutting down.",
175 zebra_route_string(client
->proto
));
177 atomic_store_explicit(&client
->pthread
->running
, false,
178 memory_order_relaxed
);
180 THREAD_OFF(client
->t_read
);
181 THREAD_OFF(client
->t_write
);
182 zserv_event(client
, ZSERV_HANDLE_CLIENT_FAIL
);
186 * Write all pending messages to client socket.
188 * This function first attempts to flush any buffered data. If unsuccessful,
189 * the function reschedules itself and returns. If successful, it pops all
190 * available messages from the output queue and continues to write data
191 * directly to the socket until the socket would block. If the socket never
192 * blocks and all data is written, the function returns without rescheduling
193 * itself. If the socket ends up throwing EWOULDBLOCK, the remaining data is
194 * buffered and the function reschedules itself.
196 * The utility of the buffer is that it allows us to vastly reduce lock
197 * contention by allowing us to pop *all* messages off the output queue at once
198 * instead of locking and unlocking each time we want to pop a single message
199 * off the queue. The same thing could arguably be accomplished faster by
200 * allowing the main thread to write directly into the buffer instead of
201 * enqueuing packets onto an intermediary queue, but the intermediary queue
202 * allows us to expose information about input and output queues to the user in
203 * terms of number of packets rather than size of data.
205 static int zserv_write(struct thread
*thread
)
207 struct zserv
*client
= THREAD_ARG(thread
);
210 struct stream_fifo
*cache
;
212 /* If we have any data pending, try to flush it first */
213 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
217 atomic_store_explicit(&client
->last_write_time
,
218 (uint32_t)monotime(NULL
),
219 memory_order_relaxed
);
220 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
226 cache
= stream_fifo_new();
228 pthread_mutex_lock(&client
->obuf_mtx
);
230 while (stream_fifo_head(client
->obuf_fifo
))
231 stream_fifo_push(cache
,
232 stream_fifo_pop(client
->obuf_fifo
));
234 pthread_mutex_unlock(&client
->obuf_mtx
);
238 stream_set_getp(msg
, 0);
239 wcmd
= stream_getw_from(msg
, 6);
242 while (stream_fifo_head(cache
)) {
243 msg
= stream_fifo_pop(cache
);
244 buffer_put(client
->wb
, STREAM_DATA(msg
), stream_get_endp(msg
));
248 stream_fifo_free(cache
);
250 /* If we have any data pending, try to flush it first */
251 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
255 atomic_store_explicit(&client
->last_write_time
,
256 (uint32_t)monotime(NULL
),
257 memory_order_relaxed
);
258 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
264 atomic_store_explicit(&client
->last_write_cmd
, wcmd
,
265 memory_order_relaxed
);
267 atomic_store_explicit(&client
->last_write_time
,
268 (uint32_t)monotime(NULL
), memory_order_relaxed
);
273 zlog_warn("%s: could not write to %s [fd = %d], closing.", __func__
,
274 zebra_route_string(client
->proto
), client
->sock
);
275 zserv_client_fail(client
);
280 * Read and process data from a client socket.
282 * The responsibilities here are to read raw data from the client socket,
283 * validate the header, encapsulate it into a single stream object, push it
284 * onto the input queue and then notify the main thread that there is new data
287 * This function first looks for any data in the client structure's working
288 * input buffer. If data is present, it is assumed that reading stopped in a
289 * previous invocation of this task and needs to be resumed to finish a message.
290 * Otherwise, the socket data stream is assumed to be at the beginning of a new
291 * ZAPI message (specifically at the header). The header is read and validated.
292 * If the header passed validation then the length field found in the header is
293 * used to compute the total length of the message. That much data is read (but
294 * not inspected), appended to the header, placed into a stream and pushed onto
295 * the client's input queue. A task is then scheduled on the main thread to
296 * process the client's input queue. Finally, if all of this was successful,
297 * this task reschedules itself.
299 * Any failure in any of these actions is handled by terminating the client.
301 static int zserv_read(struct thread
*thread
)
303 struct zserv
*client
= THREAD_ARG(thread
);
306 struct stream_fifo
*cache
;
312 p2p_orig
= atomic_load_explicit(&zebrad
.packets_to_process
,
313 memory_order_relaxed
);
314 cache
= stream_fifo_new();
316 sock
= THREAD_FD(thread
);
323 already
= stream_get_endp(client
->ibuf_work
);
325 /* Read length and command (if we don't have it already). */
326 if (already
< ZEBRA_HEADER_SIZE
) {
327 nb
= stream_read_try(client
->ibuf_work
, sock
,
328 ZEBRA_HEADER_SIZE
- already
);
329 if ((nb
== 0 || nb
== -1)) {
330 if (IS_ZEBRA_DEBUG_EVENT
)
331 zlog_debug("connection closed socket [%d]",
335 if (nb
!= (ssize_t
)(ZEBRA_HEADER_SIZE
- already
)) {
336 /* Try again later. */
339 already
= ZEBRA_HEADER_SIZE
;
342 /* Reset to read from the beginning of the incoming packet. */
343 stream_set_getp(client
->ibuf_work
, 0);
345 /* Fetch header values */
346 hdrvalid
= zapi_parse_header(client
->ibuf_work
, &hdr
);
349 snprintf(errmsg
, sizeof(errmsg
),
350 "%s: Message has corrupt header", __func__
);
351 zserv_log_message(errmsg
, client
->ibuf_work
, NULL
);
355 /* Validate header */
356 if (hdr
.marker
!= ZEBRA_HEADER_MARKER
357 || hdr
.version
!= ZSERV_VERSION
) {
359 errmsg
, sizeof(errmsg
),
360 "Message has corrupt header\n%s: socket %d version mismatch, marker %d, version %d",
361 __func__
, sock
, hdr
.marker
, hdr
.version
);
362 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
365 if (hdr
.length
< ZEBRA_HEADER_SIZE
) {
367 errmsg
, sizeof(errmsg
),
368 "Message has corrupt header\n%s: socket %d message length %u is less than header size %d",
369 __func__
, sock
, hdr
.length
, ZEBRA_HEADER_SIZE
);
370 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
373 if (hdr
.length
> STREAM_SIZE(client
->ibuf_work
)) {
375 errmsg
, sizeof(errmsg
),
376 "Message has corrupt header\n%s: socket %d message length %u exceeds buffer size %lu",
377 __func__
, sock
, hdr
.length
,
378 (unsigned long)STREAM_SIZE(client
->ibuf_work
));
379 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
383 /* Read rest of data. */
384 if (already
< hdr
.length
) {
385 nb
= stream_read_try(client
->ibuf_work
, sock
,
386 hdr
.length
- already
);
387 if ((nb
== 0 || nb
== -1)) {
388 if (IS_ZEBRA_DEBUG_EVENT
)
390 "connection closed [%d] when reading zebra data",
394 if (nb
!= (ssize_t
)(hdr
.length
- already
)) {
395 /* Try again later. */
400 /* Debug packet information. */
401 if (IS_ZEBRA_DEBUG_EVENT
)
402 zlog_debug("zebra message comes from socket [%d]",
405 if (IS_ZEBRA_DEBUG_PACKET
&& IS_ZEBRA_DEBUG_RECV
)
406 zserv_log_message(NULL
, client
->ibuf_work
, &hdr
);
408 stream_set_getp(client
->ibuf_work
, 0);
409 struct stream
*msg
= stream_dup(client
->ibuf_work
);
411 stream_fifo_push(cache
, msg
);
412 stream_reset(client
->ibuf_work
);
416 if (p2p
< p2p_orig
) {
417 /* update session statistics */
418 atomic_store_explicit(&client
->last_read_time
, monotime(NULL
),
419 memory_order_relaxed
);
420 atomic_store_explicit(&client
->last_read_cmd
, hdr
.command
,
421 memory_order_relaxed
);
423 /* publish read packets on client's input queue */
424 pthread_mutex_lock(&client
->ibuf_mtx
);
427 stream_fifo_push(client
->ibuf_fifo
,
428 stream_fifo_pop(cache
));
430 pthread_mutex_unlock(&client
->ibuf_mtx
);
432 /* Schedule job to process those packets */
433 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
437 if (IS_ZEBRA_DEBUG_PACKET
)
438 zlog_debug("Read %d packets", p2p_orig
- p2p
);
440 /* Reschedule ourselves */
441 zserv_client_event(client
, ZSERV_CLIENT_READ
);
443 stream_fifo_free(cache
);
448 stream_fifo_free(cache
);
449 zserv_client_fail(client
);
453 static void zserv_client_event(struct zserv
*client
,
454 enum zserv_client_event event
)
457 case ZSERV_CLIENT_READ
:
458 thread_add_read(client
->pthread
->master
, zserv_read
, client
,
459 client
->sock
, &client
->t_read
);
461 case ZSERV_CLIENT_WRITE
:
462 thread_add_write(client
->pthread
->master
, zserv_write
, client
,
463 client
->sock
, &client
->t_write
);
468 /* Main thread lifecycle ---------------------------------------------------- */
471 * Read and process messages from a client.
473 * This task runs on the main pthread. It is scheduled by client pthreads when
474 * they have new messages available on their input queues. The client is passed
475 * as the task argument.
477 * Each message is popped off the client's input queue and the action associated
478 * with the message is executed. This proceeds until there are no more messages,
479 * an error occurs, or the processing limit is reached.
481 * The client's I/O thread can push at most zebrad.packets_to_process messages
482 * onto the input buffer before notifying us there are packets to read. As long
483 * as we always process zebrad.packets_to_process messages here, then we can
484 * rely on the read thread to handle queuing this task enough times to process
485 * everything on the input queue.
487 static int zserv_process_messages(struct thread
*thread
)
489 struct zserv
*client
= THREAD_ARG(thread
);
491 struct stream_fifo
*cache
= stream_fifo_new();
493 uint32_t p2p
= zebrad
.packets_to_process
;
495 pthread_mutex_lock(&client
->ibuf_mtx
);
498 for (i
= 0; i
< p2p
&& stream_fifo_head(client
->ibuf_fifo
);
500 msg
= stream_fifo_pop(client
->ibuf_fifo
);
501 stream_fifo_push(cache
, msg
);
506 pthread_mutex_unlock(&client
->ibuf_mtx
);
508 while (stream_fifo_head(cache
)) {
509 msg
= stream_fifo_pop(cache
);
510 zserv_handle_commands(client
, msg
);
514 stream_fifo_free(cache
);
519 int zserv_send_message(struct zserv
*client
, struct stream
*msg
)
522 * This is a somewhat poorly named variable added with Zebra's portion
523 * of the label manager. That component does not use the regular
524 * zserv/zapi_msg interface for handling its messages, as the client
525 * itself runs in-process. Instead it uses synchronous writes on the
526 * zserv client's socket directly in the zread* handlers for its
527 * message types. Furthermore, it cannot handle the usual messages
528 * Zebra sends (such as those for interface changes) and so has added
529 * this flag and check here as a hack to suppress all messages that it
530 * does not explicitly know about.
532 * In any case this needs to be cleaned up at some point.
535 * zread_label_manager_request
536 * zsend_label_manager_connect_response
537 * zsend_assign_label_chunk_response
540 if (client
->is_synchronous
)
543 pthread_mutex_lock(&client
->obuf_mtx
);
545 stream_fifo_push(client
->obuf_fifo
, msg
);
547 pthread_mutex_unlock(&client
->obuf_mtx
);
549 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
555 /* Hooks for client connect / disconnect */
556 DEFINE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
557 DEFINE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
560 * Deinitialize zebra client.
562 * - Deregister and deinitialize related internal resources
563 * - Gracefully close socket
564 * - Free associated resources
565 * - Free client structure
567 * This does *not* take any action on the struct thread * fields. These are
568 * managed by the owning pthread and any tasks associated with them must have
569 * been stopped prior to invoking this function.
571 static void zserv_client_free(struct zserv
*client
)
573 hook_call(zserv_client_close
, client
);
575 /* Close file descriptor. */
577 unsigned long nroutes
;
581 nroutes
= rib_score_proto(client
->proto
, client
->instance
);
583 "client %d disconnected. %lu %s routes removed from the rib",
584 client
->sock
, nroutes
,
585 zebra_route_string(client
->proto
));
589 /* Free stream buffers. */
590 if (client
->ibuf_work
)
591 stream_free(client
->ibuf_work
);
592 if (client
->obuf_work
)
593 stream_free(client
->obuf_work
);
594 if (client
->ibuf_fifo
)
595 stream_fifo_free(client
->ibuf_fifo
);
596 if (client
->obuf_fifo
)
597 stream_fifo_free(client
->obuf_fifo
);
599 buffer_free(client
->wb
);
601 /* Free buffer mutexes */
602 pthread_mutex_destroy(&client
->obuf_mtx
);
603 pthread_mutex_destroy(&client
->ibuf_mtx
);
606 for (afi_t afi
= AFI_IP
; afi
< AFI_MAX
; afi
++)
607 for (int i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
608 vrf_bitmap_free(client
->redist
[afi
][i
]);
610 vrf_bitmap_free(client
->redist_default
);
611 vrf_bitmap_free(client
->ifinfo
);
612 vrf_bitmap_free(client
->ridinfo
);
614 XFREE(MTYPE_TMP
, client
);
617 void zserv_close_client(struct zserv
*client
)
619 /* synchronously stop and join pthread */
620 frr_pthread_stop(client
->pthread
, NULL
);
622 if (IS_ZEBRA_DEBUG_EVENT
)
623 zlog_debug("Closing client '%s'",
624 zebra_route_string(client
->proto
));
626 thread_cancel_event(zebrad
.master
, client
);
627 THREAD_OFF(client
->t_cleanup
);
629 /* destroy pthread */
630 frr_pthread_destroy(client
->pthread
);
631 client
->pthread
= NULL
;
633 /* remove from client list */
634 listnode_delete(zebrad
.client_list
, client
);
637 zserv_client_free(client
);
641 * This task is scheduled by a ZAPI client pthread on the main pthread when it
642 * wants to stop itself. When this executes, the client connection should
643 * already have been closed and the thread will most likely have died, but its
644 * resources still need to be cleaned up.
646 static int zserv_handle_client_fail(struct thread
*thread
)
648 struct zserv
*client
= THREAD_ARG(thread
);
650 zserv_close_client(client
);
655 * Create a new client.
657 * This is called when a new connection is accept()'d on the ZAPI socket. It
658 * initializes new client structure, notifies any subscribers of the connection
659 * event and spawns the client's thread.
662 * client's socket file descriptor
664 static struct zserv
*zserv_client_create(int sock
)
666 struct zserv
*client
;
670 client
= XCALLOC(MTYPE_TMP
, sizeof(struct zserv
));
672 /* Make client input/output buffer. */
674 client
->ibuf_fifo
= stream_fifo_new();
675 client
->obuf_fifo
= stream_fifo_new();
676 client
->ibuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
677 client
->obuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
678 pthread_mutex_init(&client
->ibuf_mtx
, NULL
);
679 pthread_mutex_init(&client
->obuf_mtx
, NULL
);
680 client
->wb
= buffer_new(0);
682 /* Set table number. */
683 client
->rtm_table
= zebrad
.rtm_table_default
;
685 atomic_store_explicit(&client
->connect_time
, (uint32_t) monotime(NULL
),
686 memory_order_relaxed
);
688 /* Initialize flags */
689 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++)
690 for (i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
691 client
->redist
[afi
][i
] = vrf_bitmap_init();
692 client
->redist_default
= vrf_bitmap_init();
693 client
->ifinfo
= vrf_bitmap_init();
694 client
->ridinfo
= vrf_bitmap_init();
696 /* by default, it's not a synchronous client */
697 client
->is_synchronous
= 0;
699 /* Add this client to linked list. */
700 listnode_add(zebrad
.client_list
, client
);
702 struct frr_pthread_attr zclient_pthr_attrs
= {
703 .id
= frr_pthread_get_id(),
704 .start
= frr_pthread_attr_default
.start
,
705 .stop
= frr_pthread_attr_default
.stop
708 frr_pthread_new(&zclient_pthr_attrs
, "Zebra API client thread");
710 zebra_vrf_update_all(client
);
712 /* start read loop */
713 zserv_client_event(client
, ZSERV_CLIENT_READ
);
716 hook_call(zserv_client_connect
, client
);
719 frr_pthread_run(client
->pthread
, NULL
);
725 * Accept socket connection.
727 static int zserv_accept(struct thread
*thread
)
731 struct sockaddr_in client
;
734 accept_sock
= THREAD_FD(thread
);
736 /* Reregister myself. */
737 zserv_event(NULL
, ZSERV_ACCEPT
);
739 len
= sizeof(struct sockaddr_in
);
740 client_sock
= accept(accept_sock
, (struct sockaddr
*)&client
, &len
);
742 if (client_sock
< 0) {
743 zlog_warn("Can't accept zebra socket: %s",
744 safe_strerror(errno
));
748 /* Make client socket non-blocking. */
749 set_nonblocking(client_sock
);
751 /* Create new zebra client. */
752 zserv_client_create(client_sock
);
757 void zserv_start(char *path
)
761 struct sockaddr_storage sa
;
764 if (!frr_zclient_addr(&sa
, &sa_len
, path
))
765 /* should be caught in zebra main() */
769 old_mask
= umask(0077);
771 /* Make UNIX domain socket. */
772 zebrad
.sock
= socket(sa
.ss_family
, SOCK_STREAM
, 0);
773 if (zebrad
.sock
< 0) {
774 zlog_warn("Can't create zserv socket: %s",
775 safe_strerror(errno
));
777 "zebra can't provide full functionality due to above error");
781 if (sa
.ss_family
!= AF_UNIX
) {
782 sockopt_reuseaddr(zebrad
.sock
);
783 sockopt_reuseport(zebrad
.sock
);
785 struct sockaddr_un
*suna
= (struct sockaddr_un
*)&sa
;
786 if (suna
->sun_path
[0])
787 unlink(suna
->sun_path
);
790 zserv_privs
.change(ZPRIVS_RAISE
);
791 setsockopt_so_recvbuf(zebrad
.sock
, 1048576);
792 setsockopt_so_sendbuf(zebrad
.sock
, 1048576);
793 zserv_privs
.change(ZPRIVS_LOWER
);
795 if (sa
.ss_family
!= AF_UNIX
&& zserv_privs
.change(ZPRIVS_RAISE
))
796 flog_err(LIB_ERR_PRIVILEGES
, "Can't raise privileges");
798 ret
= bind(zebrad
.sock
, (struct sockaddr
*)&sa
, sa_len
);
800 zlog_warn("Can't bind zserv socket on %s: %s", path
,
801 safe_strerror(errno
));
803 "zebra can't provide full functionality due to above error");
808 if (sa
.ss_family
!= AF_UNIX
&& zserv_privs
.change(ZPRIVS_LOWER
))
809 flog_err(LIB_ERR_PRIVILEGES
, "Can't lower privileges");
811 ret
= listen(zebrad
.sock
, 5);
813 zlog_warn("Can't listen to zserv socket %s: %s", path
,
814 safe_strerror(errno
));
816 "zebra can't provide full functionality due to above error");
824 zserv_event(NULL
, ZSERV_ACCEPT
);
827 void zserv_event(struct zserv
*client
, enum zserv_event event
)
831 thread_add_read(zebrad
.master
, zserv_accept
, NULL
, zebrad
.sock
,
834 case ZSERV_PROCESS_MESSAGES
:
835 thread_add_event(zebrad
.master
, zserv_process_messages
, client
,
838 case ZSERV_HANDLE_CLIENT_FAIL
:
839 thread_add_event(zebrad
.master
, zserv_handle_client_fail
,
840 client
, 0, &client
->t_cleanup
);
845 /* General purpose ---------------------------------------------------------- */
847 #define ZEBRA_TIME_BUF 32
848 static char *zserv_time_buf(time_t *time1
, char *buf
, int buflen
)
854 assert(buflen
>= ZEBRA_TIME_BUF
);
855 assert(time1
!= NULL
);
858 snprintf(buf
, buflen
, "never ");
862 now
= monotime(NULL
);
866 if (now
< ONE_DAY_SECOND
)
867 snprintf(buf
, buflen
, "%02d:%02d:%02d", tm
->tm_hour
, tm
->tm_min
,
869 else if (now
< ONE_WEEK_SECOND
)
870 snprintf(buf
, buflen
, "%dd%02dh%02dm", tm
->tm_yday
, tm
->tm_hour
,
873 snprintf(buf
, buflen
, "%02dw%dd%02dh", tm
->tm_yday
/ 7,
874 tm
->tm_yday
- ((tm
->tm_yday
/ 7) * 7), tm
->tm_hour
);
878 static void zebra_show_client_detail(struct vty
*vty
, struct zserv
*client
)
880 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
881 char wbuf
[ZEBRA_TIME_BUF
], nhbuf
[ZEBRA_TIME_BUF
], mbuf
[ZEBRA_TIME_BUF
];
882 time_t connect_time
, last_read_time
, last_write_time
;
883 uint16_t last_read_cmd
, last_write_cmd
;
885 vty_out(vty
, "Client: %s", zebra_route_string(client
->proto
));
886 if (client
->instance
)
887 vty_out(vty
, " Instance: %d", client
->instance
);
890 vty_out(vty
, "------------------------ \n");
891 vty_out(vty
, "FD: %d \n", client
->sock
);
892 vty_out(vty
, "Route Table ID: %d \n", client
->rtm_table
);
894 connect_time
= (time_t) atomic_load_explicit(&client
->connect_time
,
895 memory_order_relaxed
);
897 vty_out(vty
, "Connect Time: %s \n",
898 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
));
899 if (client
->nh_reg_time
) {
900 vty_out(vty
, "Nexthop Registry Time: %s \n",
901 zserv_time_buf(&client
->nh_reg_time
, nhbuf
,
903 if (client
->nh_last_upd_time
)
904 vty_out(vty
, "Nexthop Last Update Time: %s \n",
905 zserv_time_buf(&client
->nh_last_upd_time
, mbuf
,
908 vty_out(vty
, "No Nexthop Update sent\n");
910 vty_out(vty
, "Not registered for Nexthop Updates\n");
912 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
913 memory_order_relaxed
);
914 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
915 memory_order_relaxed
);
917 last_read_cmd
= atomic_load_explicit(&client
->last_read_cmd
,
918 memory_order_relaxed
);
919 last_write_cmd
= atomic_load_explicit(&client
->last_write_cmd
,
920 memory_order_relaxed
);
922 vty_out(vty
, "Last Msg Rx Time: %s \n",
923 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
));
924 vty_out(vty
, "Last Msg Tx Time: %s \n",
925 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
));
927 vty_out(vty
, "Last Rcvd Cmd: %s \n",
928 zserv_command_string(last_read_cmd
));
930 vty_out(vty
, "Last Sent Cmd: %s \n",
931 zserv_command_string(last_write_cmd
));
934 vty_out(vty
, "Type Add Update Del \n");
935 vty_out(vty
, "================================================== \n");
936 vty_out(vty
, "IPv4 %-12d%-12d%-12d\n", client
->v4_route_add_cnt
,
937 client
->v4_route_upd8_cnt
, client
->v4_route_del_cnt
);
938 vty_out(vty
, "IPv6 %-12d%-12d%-12d\n", client
->v6_route_add_cnt
,
939 client
->v6_route_upd8_cnt
, client
->v6_route_del_cnt
);
940 vty_out(vty
, "Redist:v4 %-12d%-12d%-12d\n", client
->redist_v4_add_cnt
,
941 0, client
->redist_v4_del_cnt
);
942 vty_out(vty
, "Redist:v6 %-12d%-12d%-12d\n", client
->redist_v6_add_cnt
,
943 0, client
->redist_v6_del_cnt
);
944 vty_out(vty
, "Connected %-12d%-12d%-12d\n", client
->ifadd_cnt
, 0,
946 vty_out(vty
, "BFD peer %-12d%-12d%-12d\n", client
->bfd_peer_add_cnt
,
947 client
->bfd_peer_upd8_cnt
, client
->bfd_peer_del_cnt
);
948 vty_out(vty
, "Interface Up Notifications: %d\n", client
->ifup_cnt
);
949 vty_out(vty
, "Interface Down Notifications: %d\n", client
->ifdown_cnt
);
950 vty_out(vty
, "VNI add notifications: %d\n", client
->vniadd_cnt
);
951 vty_out(vty
, "VNI delete notifications: %d\n", client
->vnidel_cnt
);
952 vty_out(vty
, "L3-VNI add notifications: %d\n", client
->l3vniadd_cnt
);
953 vty_out(vty
, "L3-VNI delete notifications: %d\n", client
->l3vnidel_cnt
);
954 vty_out(vty
, "MAC-IP add notifications: %d\n", client
->macipadd_cnt
);
955 vty_out(vty
, "MAC-IP delete notifications: %d\n", client
->macipdel_cnt
);
957 #if defined DEV_BUILD
958 vty_out(vty
, "Input Fifo: %zu:%zu Output Fifo: %zu:%zu\n",
959 client
->ibuf_fifo
->count
, client
->ibuf_fifo
->max_count
,
960 client
->obuf_fifo
->count
, client
->obuf_fifo
->max_count
);
966 static void zebra_show_client_brief(struct vty
*vty
, struct zserv
*client
)
968 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
969 char wbuf
[ZEBRA_TIME_BUF
];
970 time_t connect_time
, last_read_time
, last_write_time
;
972 connect_time
= (time_t)atomic_load_explicit(&client
->connect_time
,
973 memory_order_relaxed
);
974 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
975 memory_order_relaxed
);
976 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
977 memory_order_relaxed
);
979 vty_out(vty
, "%-8s%12s %12s%12s%8d/%-8d%8d/%-8d\n",
980 zebra_route_string(client
->proto
),
981 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
),
982 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
),
983 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
),
984 client
->v4_route_add_cnt
+ client
->v4_route_upd8_cnt
,
985 client
->v4_route_del_cnt
,
986 client
->v6_route_add_cnt
+ client
->v6_route_upd8_cnt
,
987 client
->v6_route_del_cnt
);
990 struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
)
992 struct listnode
*node
, *nnode
;
993 struct zserv
*client
;
995 for (ALL_LIST_ELEMENTS(zebrad
.client_list
, node
, nnode
, client
)) {
996 if (client
->proto
== proto
&& client
->instance
== instance
)
1003 /* This command is for debugging purpose. */
1004 DEFUN (show_zebra_client
,
1005 show_zebra_client_cmd
,
1006 "show zebra client",
1009 "Client information\n")
1011 struct listnode
*node
;
1012 struct zserv
*client
;
1014 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1015 zebra_show_client_detail(vty
, client
);
1020 /* This command is for debugging purpose. */
1021 DEFUN (show_zebra_client_summary
,
1022 show_zebra_client_summary_cmd
,
1023 "show zebra client summary",
1026 "Client information brief\n"
1029 struct listnode
*node
;
1030 struct zserv
*client
;
1033 "Name Connect Time Last Read Last Write IPv4 Routes IPv6 Routes \n");
1035 "--------------------------------------------------------------------------------\n");
1037 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1038 zebra_show_client_brief(vty
, client
);
1040 vty_out(vty
, "Routes column shows (added+updated)/deleted\n");
1044 #if defined(HANDLE_ZAPI_FUZZING)
1045 void zserv_read_file(char *input
)
1050 fd
= open(input
, O_RDONLY
| O_NONBLOCK
);
1053 zserv_client_create(fd
);
1057 void zserv_init(void)
1059 /* Client list init. */
1060 zebrad
.client_list
= list_new();
1065 install_element(ENABLE_NODE
, &show_zebra_client_cmd
);
1066 install_element(ENABLE_NODE
, &show_zebra_client_summary_cmd
);