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... */
58 #include "zebra/debug.h" /* for various debugging macros */
59 #include "zebra/rib.h" /* for rib_score_proto */
60 #include "zebra/zapi_msg.h" /* for zserv_handle_commands */
61 #include "zebra/zebra_vrf.h" /* for zebra_vrf_lookup_by_id, zvrf */
62 #include "zebra/zserv.h" /* for zserv */
66 extern struct zebra_privs_t zserv_privs
;
69 * Client thread events.
71 * These are used almost exclusively by client threads to drive their own event
72 * loops. The only exception is in zserv_client_create(), which pushes an
73 * initial ZSERV_CLIENT_READ event to start the API handler loop.
75 enum zserv_client_event
{
76 /* Schedule a socket read */
78 /* Schedule a buffer write */
85 * These are used by client threads to notify the main thread about various
86 * events and to make processing requests.
89 /* Schedule listen job on Zebra API socket */
91 /* The calling client has packets on its input buffer */
92 ZSERV_PROCESS_MESSAGES
,
93 /* The calling client wishes to be killed */
94 ZSERV_HANDLE_CLIENT_FAIL
,
98 * Zebra server event driver for all client threads.
100 * This is essentially a wrapper around thread_add_event() that centralizes
101 * those scheduling calls into one place.
103 * All calls to this function schedule an event on the pthread running the
107 * the client in question, and thread target
110 * the event to notify them about
112 static void zserv_client_event(struct zserv
*client
,
113 enum zserv_client_event event
);
116 * Zebra server event driver for the main thread.
118 * This is essentially a wrapper around thread_add_event() that centralizes
119 * those scheduling calls into one place.
121 * All calls to this function schedule an event on Zebra's main pthread.
124 * the client in question
127 * the event to notify the main thread about
129 static void zserv_event(struct zserv
*client
, enum zserv_event event
);
132 /* Client thread lifecycle -------------------------------------------------- */
135 * Log zapi message to zlog.
146 static void zserv_log_message(const char *errmsg
, struct stream
*msg
,
149 zlog_debug("Rx'd ZAPI message");
151 zlog_debug("%s", errmsg
);
153 zlog_debug(" Length: %d", hdr
->length
);
154 zlog_debug("Command: %s", zserv_command_string(hdr
->command
));
155 zlog_debug(" VRF: %u", hdr
->vrf_id
);
157 zlog_hexdump(msg
->data
, STREAM_READABLE(msg
));
161 * Gracefully shut down a client connection.
163 * Cancel any pending tasks for the client's thread. Then schedule a task on
164 * the main thread to shut down the calling thread.
166 * Must be called from the client pthread, never the main thread.
168 static void zserv_client_fail(struct zserv
*client
)
170 zlog_warn("Client '%s' encountered an error and is shutting down.",
171 zebra_route_string(client
->proto
));
173 atomic_store_explicit(&client
->pthread
->running
, false,
174 memory_order_relaxed
);
175 if (client
->sock
> 0) {
179 THREAD_OFF(client
->t_read
);
180 THREAD_OFF(client
->t_write
);
181 zserv_event(client
, ZSERV_HANDLE_CLIENT_FAIL
);
185 * Write all pending messages to client socket.
187 * This function first attempts to flush any buffered data. If unsuccessful,
188 * the function reschedules itself and returns. If successful, it pops all
189 * available messages from the output queue and continues to write data
190 * directly to the socket until the socket would block. If the socket never
191 * blocks and all data is written, the function returns without rescheduling
192 * itself. If the socket ends up throwing EWOULDBLOCK, the remaining data is
193 * buffered and the function reschedules itself.
195 * The utility of the buffer is that it allows us to vastly reduce lock
196 * contention by allowing us to pop *all* messages off the output queue at once
197 * instead of locking and unlocking each time we want to pop a single message
198 * off the queue. The same thing could arguably be accomplished faster by
199 * allowing the main thread to write directly into the buffer instead of
200 * enqueuing packets onto an intermediary queue, but the intermediary queue
201 * allows us to expose information about input and output queues to the user in
202 * terms of number of packets rather than size of data.
204 static int zserv_write(struct thread
*thread
)
206 struct zserv
*client
= THREAD_ARG(thread
);
209 struct stream_fifo
*cache
;
211 /* If we have any data pending, try to flush it first */
212 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
216 atomic_store_explicit(&client
->last_write_time
,
217 (uint32_t)monotime(NULL
),
218 memory_order_relaxed
);
219 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
225 cache
= stream_fifo_new();
227 pthread_mutex_lock(&client
->obuf_mtx
);
229 while (stream_fifo_head(client
->obuf_fifo
))
230 stream_fifo_push(cache
,
231 stream_fifo_pop(client
->obuf_fifo
));
233 pthread_mutex_unlock(&client
->obuf_mtx
);
237 stream_set_getp(msg
, 0);
238 wcmd
= stream_getw_from(msg
, 6);
241 while (stream_fifo_head(cache
)) {
242 msg
= stream_fifo_pop(cache
);
243 buffer_put(client
->wb
, STREAM_DATA(msg
), stream_get_endp(msg
));
247 stream_fifo_free(cache
);
249 /* If we have any data pending, try to flush it first */
250 switch (buffer_flush_all(client
->wb
, client
->sock
)) {
254 atomic_store_explicit(&client
->last_write_time
,
255 (uint32_t)monotime(NULL
),
256 memory_order_relaxed
);
257 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
263 atomic_store_explicit(&client
->last_write_cmd
, wcmd
,
264 memory_order_relaxed
);
266 atomic_store_explicit(&client
->last_write_time
,
267 (uint32_t)monotime(NULL
), memory_order_relaxed
);
272 zlog_warn("%s: could not write to %s [fd = %d], closing.", __func__
,
273 zebra_route_string(client
->proto
), client
->sock
);
274 zserv_client_fail(client
);
279 * Read and process data from a client socket.
281 * The responsibilities here are to read raw data from the client socket,
282 * validate the header, encapsulate it into a single stream object, push it
283 * onto the input queue and then notify the main thread that there is new data
286 * This function first looks for any data in the client structure's working
287 * input buffer. If data is present, it is assumed that reading stopped in a
288 * previous invocation of this task and needs to be resumed to finish a message.
289 * Otherwise, the socket data stream is assumed to be at the beginning of a new
290 * ZAPI message (specifically at the header). The header is read and validated.
291 * If the header passed validation then the length field found in the header is
292 * used to compute the total length of the message. That much data is read (but
293 * not inspected), appended to the header, placed into a stream and pushed onto
294 * the client's input queue. A task is then scheduled on the main thread to
295 * process the client's input queue. Finally, if all of this was successful,
296 * this task reschedules itself.
298 * Any failure in any of these actions is handled by terminating the client.
300 static int zserv_read(struct thread
*thread
)
302 struct zserv
*client
= THREAD_ARG(thread
);
305 struct stream_fifo
*cache
;
311 p2p_orig
= atomic_load_explicit(&zebrad
.packets_to_process
,
312 memory_order_relaxed
);
313 cache
= stream_fifo_new();
315 sock
= THREAD_FD(thread
);
322 already
= stream_get_endp(client
->ibuf_work
);
324 /* Read length and command (if we don't have it already). */
325 if (already
< ZEBRA_HEADER_SIZE
) {
326 nb
= stream_read_try(client
->ibuf_work
, sock
,
327 ZEBRA_HEADER_SIZE
- already
);
328 if ((nb
== 0 || nb
== -1)) {
329 if (IS_ZEBRA_DEBUG_EVENT
)
330 zlog_debug("connection closed socket [%d]",
334 if (nb
!= (ssize_t
)(ZEBRA_HEADER_SIZE
- already
)) {
335 /* Try again later. */
338 already
= ZEBRA_HEADER_SIZE
;
341 /* Reset to read from the beginning of the incoming packet. */
342 stream_set_getp(client
->ibuf_work
, 0);
344 /* Fetch header values */
345 hdrvalid
= zapi_parse_header(client
->ibuf_work
, &hdr
);
348 snprintf(errmsg
, sizeof(errmsg
),
349 "%s: Message has corrupt header", __func__
);
350 zserv_log_message(errmsg
, client
->ibuf_work
, NULL
);
354 /* Validate header */
355 if (hdr
.marker
!= ZEBRA_HEADER_MARKER
356 || hdr
.version
!= ZSERV_VERSION
) {
358 errmsg
, sizeof(errmsg
),
359 "Message has corrupt header\n%s: socket %d version mismatch, marker %d, version %d",
360 __func__
, sock
, hdr
.marker
, hdr
.version
);
361 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
364 if (hdr
.length
< ZEBRA_HEADER_SIZE
) {
366 errmsg
, sizeof(errmsg
),
367 "Message has corrupt header\n%s: socket %d message length %u is less than header size %d",
368 __func__
, sock
, hdr
.length
, ZEBRA_HEADER_SIZE
);
369 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
372 if (hdr
.length
> STREAM_SIZE(client
->ibuf_work
)) {
374 errmsg
, sizeof(errmsg
),
375 "Message has corrupt header\n%s: socket %d message length %u exceeds buffer size %lu",
376 __func__
, sock
, hdr
.length
,
377 (unsigned long)STREAM_SIZE(client
->ibuf_work
));
378 zserv_log_message(errmsg
, client
->ibuf_work
, &hdr
);
382 /* Read rest of data. */
383 if (already
< hdr
.length
) {
384 nb
= stream_read_try(client
->ibuf_work
, sock
,
385 hdr
.length
- already
);
386 if ((nb
== 0 || nb
== -1)) {
387 if (IS_ZEBRA_DEBUG_EVENT
)
389 "connection closed [%d] when reading zebra data",
393 if (nb
!= (ssize_t
)(hdr
.length
- already
)) {
394 /* Try again later. */
399 /* Debug packet information. */
400 if (IS_ZEBRA_DEBUG_EVENT
)
401 zlog_debug("zebra message comes from socket [%d]",
404 if (IS_ZEBRA_DEBUG_PACKET
&& IS_ZEBRA_DEBUG_RECV
)
405 zserv_log_message(NULL
, client
->ibuf_work
, &hdr
);
407 stream_set_getp(client
->ibuf_work
, 0);
408 struct stream
*msg
= stream_dup(client
->ibuf_work
);
410 stream_fifo_push(cache
, msg
);
411 stream_reset(client
->ibuf_work
);
415 if (p2p
< p2p_orig
) {
416 /* update session statistics */
417 atomic_store_explicit(&client
->last_read_time
, monotime(NULL
),
418 memory_order_relaxed
);
419 atomic_store_explicit(&client
->last_read_cmd
, hdr
.command
,
420 memory_order_relaxed
);
422 /* publish read packets on client's input queue */
423 pthread_mutex_lock(&client
->ibuf_mtx
);
426 stream_fifo_push(client
->ibuf_fifo
,
427 stream_fifo_pop(cache
));
429 pthread_mutex_unlock(&client
->ibuf_mtx
);
431 /* Schedule job to process those packets */
432 zserv_event(client
, ZSERV_PROCESS_MESSAGES
);
436 if (IS_ZEBRA_DEBUG_PACKET
)
437 zlog_debug("Read %d packets", p2p_orig
- p2p
);
439 /* Reschedule ourselves */
440 zserv_client_event(client
, ZSERV_CLIENT_READ
);
442 stream_fifo_free(cache
);
447 stream_fifo_free(cache
);
448 zserv_client_fail(client
);
452 static void zserv_client_event(struct zserv
*client
,
453 enum zserv_client_event event
)
456 case ZSERV_CLIENT_READ
:
457 thread_add_read(client
->pthread
->master
, zserv_read
, client
,
458 client
->sock
, &client
->t_read
);
460 case ZSERV_CLIENT_WRITE
:
461 thread_add_write(client
->pthread
->master
, zserv_write
, client
,
462 client
->sock
, &client
->t_write
);
467 /* Main thread lifecycle ---------------------------------------------------- */
470 * Read and process messages from a client.
472 * This task runs on the main pthread. It is scheduled by client pthreads when
473 * they have new messages available on their input queues. The client is passed
474 * as the task argument.
476 * Each message is popped off the client's input queue and the action associated
477 * with the message is executed. This proceeds until there are no more messages,
478 * an error occurs, or the processing limit is reached.
480 * The client's I/O thread can push at most zebrad.packets_to_process messages
481 * onto the input buffer before notifying us there are packets to read. As long
482 * as we always process zebrad.packets_to_process messages here, then we can
483 * rely on the read thread to handle queuing this task enough times to process
484 * everything on the input queue.
486 static int zserv_process_messages(struct thread
*thread
)
488 struct zserv
*client
= THREAD_ARG(thread
);
490 struct stream_fifo
*cache
= stream_fifo_new();
492 uint32_t p2p
= zebrad
.packets_to_process
;
494 pthread_mutex_lock(&client
->ibuf_mtx
);
497 for (i
= 0; i
< p2p
&& stream_fifo_head(client
->ibuf_fifo
);
499 msg
= stream_fifo_pop(client
->ibuf_fifo
);
500 stream_fifo_push(cache
, msg
);
505 pthread_mutex_unlock(&client
->ibuf_mtx
);
507 while (stream_fifo_head(cache
)) {
508 msg
= stream_fifo_pop(cache
);
509 zserv_handle_commands(client
, msg
);
513 stream_fifo_free(cache
);
518 int zserv_send_message(struct zserv
*client
, struct stream
*msg
)
521 * This is a somewhat poorly named variable added with Zebra's portion
522 * of the label manager. That component does not use the regular
523 * zserv/zapi_msg interface for handling its messages, as the client
524 * itself runs in-process. Instead it uses synchronous writes on the
525 * zserv client's socket directly in the zread* handlers for its
526 * message types. Furthermore, it cannot handle the usual messages
527 * Zebra sends (such as those for interface changes) and so has added
528 * this flag and check here as a hack to suppress all messages that it
529 * does not explicitly know about.
531 * In any case this needs to be cleaned up at some point.
534 * zread_label_manager_request
535 * zsend_label_manager_connect_response
536 * zsend_assign_label_chunk_response
539 if (client
->is_synchronous
)
542 pthread_mutex_lock(&client
->obuf_mtx
);
544 stream_fifo_push(client
->obuf_fifo
, msg
);
546 pthread_mutex_unlock(&client
->obuf_mtx
);
548 zserv_client_event(client
, ZSERV_CLIENT_WRITE
);
554 /* Hooks for client connect / disconnect */
555 DEFINE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
556 DEFINE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
559 * Deinitialize zebra client.
561 * - Deregister and deinitialize related internal resources
562 * - Gracefully close socket
563 * - Free associated resources
564 * - Free client structure
566 * This does *not* take any action on the struct thread * fields. These are
567 * managed by the owning pthread and any tasks associated with them must have
568 * been stopped prior to invoking this function.
570 static void zserv_client_free(struct zserv
*client
)
572 hook_call(zserv_client_close
, client
);
574 /* Close file descriptor. */
576 unsigned long nroutes
;
579 nroutes
= rib_score_proto(client
->proto
, client
->instance
);
581 "client %d disconnected. %lu %s routes removed from the rib",
582 client
->sock
, nroutes
,
583 zebra_route_string(client
->proto
));
587 /* Free stream buffers. */
588 if (client
->ibuf_work
)
589 stream_free(client
->ibuf_work
);
590 if (client
->obuf_work
)
591 stream_free(client
->obuf_work
);
592 if (client
->ibuf_fifo
)
593 stream_fifo_free(client
->ibuf_fifo
);
594 if (client
->obuf_fifo
)
595 stream_fifo_free(client
->obuf_fifo
);
597 buffer_free(client
->wb
);
599 /* Free buffer mutexes */
600 pthread_mutex_destroy(&client
->obuf_mtx
);
601 pthread_mutex_destroy(&client
->ibuf_mtx
);
604 for (afi_t afi
= AFI_IP
; afi
< AFI_MAX
; afi
++)
605 for (int i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
606 vrf_bitmap_free(client
->redist
[afi
][i
]);
608 vrf_bitmap_free(client
->redist_default
);
609 vrf_bitmap_free(client
->ifinfo
);
610 vrf_bitmap_free(client
->ridinfo
);
612 XFREE(MTYPE_TMP
, client
);
615 void zserv_close_client(struct zserv
*client
)
617 /* synchronously stop and join pthread */
618 frr_pthread_stop(client
->pthread
, NULL
);
620 if (IS_ZEBRA_DEBUG_EVENT
)
621 zlog_debug("Closing client '%s'",
622 zebra_route_string(client
->proto
));
624 /* if file descriptor is still open, close it */
625 if (client
->sock
> 0) {
630 thread_cancel_event(zebrad
.master
, client
);
631 THREAD_OFF(client
->t_cleanup
);
633 /* destroy pthread */
634 frr_pthread_destroy(client
->pthread
);
635 client
->pthread
= NULL
;
637 /* remove from client list */
638 listnode_delete(zebrad
.client_list
, client
);
641 zserv_client_free(client
);
645 * This task is scheduled by a ZAPI client pthread on the main pthread when it
646 * wants to stop itself. When this executes, the client connection should
647 * already have been closed and the thread will most likely have died, but its
648 * resources still need to be cleaned up.
650 static int zserv_handle_client_fail(struct thread
*thread
)
652 struct zserv
*client
= THREAD_ARG(thread
);
654 zserv_close_client(client
);
659 * Create a new client.
661 * This is called when a new connection is accept()'d on the ZAPI socket. It
662 * initializes new client structure, notifies any subscribers of the connection
663 * event and spawns the client's thread.
666 * client's socket file descriptor
668 static struct zserv
*zserv_client_create(int sock
)
670 struct zserv
*client
;
674 client
= XCALLOC(MTYPE_TMP
, sizeof(struct zserv
));
676 /* Make client input/output buffer. */
678 client
->ibuf_fifo
= stream_fifo_new();
679 client
->obuf_fifo
= stream_fifo_new();
680 client
->ibuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
681 client
->obuf_work
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
682 pthread_mutex_init(&client
->ibuf_mtx
, NULL
);
683 pthread_mutex_init(&client
->obuf_mtx
, NULL
);
684 client
->wb
= buffer_new(0);
686 /* Set table number. */
687 client
->rtm_table
= zebrad
.rtm_table_default
;
689 atomic_store_explicit(&client
->connect_time
, (uint32_t) monotime(NULL
),
690 memory_order_relaxed
);
692 /* Initialize flags */
693 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++)
694 for (i
= 0; i
< ZEBRA_ROUTE_MAX
; i
++)
695 client
->redist
[afi
][i
] = vrf_bitmap_init();
696 client
->redist_default
= vrf_bitmap_init();
697 client
->ifinfo
= vrf_bitmap_init();
698 client
->ridinfo
= vrf_bitmap_init();
700 /* by default, it's not a synchronous client */
701 client
->is_synchronous
= 0;
703 /* Add this client to linked list. */
704 listnode_add(zebrad
.client_list
, client
);
706 struct frr_pthread_attr zclient_pthr_attrs
= {
707 .id
= frr_pthread_get_id(),
708 .start
= frr_pthread_attr_default
.start
,
709 .stop
= frr_pthread_attr_default
.stop
712 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 zlog_warn("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 zlog_warn("Can't create zserv socket: %s",
779 safe_strerror(errno
));
781 "zebra can't provide full functionality due to above error");
785 if (sa
.ss_family
!= AF_UNIX
) {
786 sockopt_reuseaddr(zebrad
.sock
);
787 sockopt_reuseport(zebrad
.sock
);
789 struct sockaddr_un
*suna
= (struct sockaddr_un
*)&sa
;
790 if (suna
->sun_path
[0])
791 unlink(suna
->sun_path
);
794 zserv_privs
.change(ZPRIVS_RAISE
);
795 setsockopt_so_recvbuf(zebrad
.sock
, 1048576);
796 setsockopt_so_sendbuf(zebrad
.sock
, 1048576);
797 zserv_privs
.change(ZPRIVS_LOWER
);
799 if (sa
.ss_family
!= AF_UNIX
&& zserv_privs
.change(ZPRIVS_RAISE
))
800 zlog_err("Can't raise privileges");
802 ret
= bind(zebrad
.sock
, (struct sockaddr
*)&sa
, sa_len
);
804 zlog_warn("Can't bind zserv socket on %s: %s", path
,
805 safe_strerror(errno
));
807 "zebra can't provide full functionality due to above error");
812 if (sa
.ss_family
!= AF_UNIX
&& zserv_privs
.change(ZPRIVS_LOWER
))
813 zlog_err("Can't lower privileges");
815 ret
= listen(zebrad
.sock
, 5);
817 zlog_warn("Can't listen to zserv socket %s: %s", path
,
818 safe_strerror(errno
));
820 "zebra can't provide full functionality due to above error");
828 zserv_event(NULL
, ZSERV_ACCEPT
);
831 void zserv_event(struct zserv
*client
, enum zserv_event event
)
835 thread_add_read(zebrad
.master
, zserv_accept
, NULL
, zebrad
.sock
,
838 case ZSERV_PROCESS_MESSAGES
:
839 thread_add_event(zebrad
.master
, zserv_process_messages
, client
,
842 case ZSERV_HANDLE_CLIENT_FAIL
:
843 thread_add_event(zebrad
.master
, zserv_handle_client_fail
,
844 client
, 0, &client
->t_cleanup
);
849 /* General purpose ---------------------------------------------------------- */
851 #define ZEBRA_TIME_BUF 32
852 static char *zserv_time_buf(time_t *time1
, char *buf
, int buflen
)
858 assert(buflen
>= ZEBRA_TIME_BUF
);
859 assert(time1
!= NULL
);
862 snprintf(buf
, buflen
, "never ");
866 now
= monotime(NULL
);
870 if (now
< ONE_DAY_SECOND
)
871 snprintf(buf
, buflen
, "%02d:%02d:%02d", tm
->tm_hour
, tm
->tm_min
,
873 else if (now
< ONE_WEEK_SECOND
)
874 snprintf(buf
, buflen
, "%dd%02dh%02dm", tm
->tm_yday
, tm
->tm_hour
,
877 snprintf(buf
, buflen
, "%02dw%dd%02dh", tm
->tm_yday
/ 7,
878 tm
->tm_yday
- ((tm
->tm_yday
/ 7) * 7), tm
->tm_hour
);
882 static void zebra_show_client_detail(struct vty
*vty
, struct zserv
*client
)
884 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
885 char wbuf
[ZEBRA_TIME_BUF
], nhbuf
[ZEBRA_TIME_BUF
], mbuf
[ZEBRA_TIME_BUF
];
886 time_t connect_time
, last_read_time
, last_write_time
;
887 uint16_t last_read_cmd
, last_write_cmd
;
889 vty_out(vty
, "Client: %s", zebra_route_string(client
->proto
));
890 if (client
->instance
)
891 vty_out(vty
, " Instance: %d", client
->instance
);
894 vty_out(vty
, "------------------------ \n");
895 vty_out(vty
, "FD: %d \n", client
->sock
);
896 vty_out(vty
, "Route Table ID: %d \n", client
->rtm_table
);
898 connect_time
= (time_t) atomic_load_explicit(&client
->connect_time
,
899 memory_order_relaxed
);
901 vty_out(vty
, "Connect Time: %s \n",
902 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
));
903 if (client
->nh_reg_time
) {
904 vty_out(vty
, "Nexthop Registry Time: %s \n",
905 zserv_time_buf(&client
->nh_reg_time
, nhbuf
,
907 if (client
->nh_last_upd_time
)
908 vty_out(vty
, "Nexthop Last Update Time: %s \n",
909 zserv_time_buf(&client
->nh_last_upd_time
, mbuf
,
912 vty_out(vty
, "No Nexthop Update sent\n");
914 vty_out(vty
, "Not registered for Nexthop Updates\n");
916 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
917 memory_order_relaxed
);
918 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
919 memory_order_relaxed
);
921 last_read_cmd
= atomic_load_explicit(&client
->last_read_cmd
,
922 memory_order_relaxed
);
923 last_write_cmd
= atomic_load_explicit(&client
->last_write_cmd
,
924 memory_order_relaxed
);
926 vty_out(vty
, "Last Msg Rx Time: %s \n",
927 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
));
928 vty_out(vty
, "Last Msg Tx Time: %s \n",
929 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
));
931 vty_out(vty
, "Last Rcvd Cmd: %s \n",
932 zserv_command_string(last_read_cmd
));
934 vty_out(vty
, "Last Sent Cmd: %s \n",
935 zserv_command_string(last_write_cmd
));
938 vty_out(vty
, "Type Add Update Del \n");
939 vty_out(vty
, "================================================== \n");
940 vty_out(vty
, "IPv4 %-12d%-12d%-12d\n", client
->v4_route_add_cnt
,
941 client
->v4_route_upd8_cnt
, client
->v4_route_del_cnt
);
942 vty_out(vty
, "IPv6 %-12d%-12d%-12d\n", client
->v6_route_add_cnt
,
943 client
->v6_route_upd8_cnt
, client
->v6_route_del_cnt
);
944 vty_out(vty
, "Redist:v4 %-12d%-12d%-12d\n", client
->redist_v4_add_cnt
,
945 0, client
->redist_v4_del_cnt
);
946 vty_out(vty
, "Redist:v6 %-12d%-12d%-12d\n", client
->redist_v6_add_cnt
,
947 0, client
->redist_v6_del_cnt
);
948 vty_out(vty
, "Connected %-12d%-12d%-12d\n", client
->ifadd_cnt
, 0,
950 vty_out(vty
, "BFD peer %-12d%-12d%-12d\n", client
->bfd_peer_add_cnt
,
951 client
->bfd_peer_upd8_cnt
, client
->bfd_peer_del_cnt
);
952 vty_out(vty
, "Interface Up Notifications: %d\n", client
->ifup_cnt
);
953 vty_out(vty
, "Interface Down Notifications: %d\n", client
->ifdown_cnt
);
954 vty_out(vty
, "VNI add notifications: %d\n", client
->vniadd_cnt
);
955 vty_out(vty
, "VNI delete notifications: %d\n", client
->vnidel_cnt
);
956 vty_out(vty
, "L3-VNI add notifications: %d\n", client
->l3vniadd_cnt
);
957 vty_out(vty
, "L3-VNI delete notifications: %d\n", client
->l3vnidel_cnt
);
958 vty_out(vty
, "MAC-IP add notifications: %d\n", client
->macipadd_cnt
);
959 vty_out(vty
, "MAC-IP delete notifications: %d\n", client
->macipdel_cnt
);
961 #if defined DEV_BUILD
962 vty_out(vty
, "Input Fifo: %zu:%zu Output Fifo: %zu:%zu\n",
963 client
->ibuf_fifo
->count
, client
->ibuf_fifo
->max_count
,
964 client
->obuf_fifo
->count
, client
->obuf_fifo
->max_count
);
970 static void zebra_show_client_brief(struct vty
*vty
, struct zserv
*client
)
972 char cbuf
[ZEBRA_TIME_BUF
], rbuf
[ZEBRA_TIME_BUF
];
973 char wbuf
[ZEBRA_TIME_BUF
];
974 time_t connect_time
, last_read_time
, last_write_time
;
976 connect_time
= (time_t)atomic_load_explicit(&client
->connect_time
,
977 memory_order_relaxed
);
978 last_read_time
= (time_t)atomic_load_explicit(&client
->last_read_time
,
979 memory_order_relaxed
);
980 last_write_time
= (time_t)atomic_load_explicit(&client
->last_write_time
,
981 memory_order_relaxed
);
983 vty_out(vty
, "%-8s%12s %12s%12s%8d/%-8d%8d/%-8d\n",
984 zebra_route_string(client
->proto
),
985 zserv_time_buf(&connect_time
, cbuf
, ZEBRA_TIME_BUF
),
986 zserv_time_buf(&last_read_time
, rbuf
, ZEBRA_TIME_BUF
),
987 zserv_time_buf(&last_write_time
, wbuf
, ZEBRA_TIME_BUF
),
988 client
->v4_route_add_cnt
+ client
->v4_route_upd8_cnt
,
989 client
->v4_route_del_cnt
,
990 client
->v6_route_add_cnt
+ client
->v6_route_upd8_cnt
,
991 client
->v6_route_del_cnt
);
994 struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
)
996 struct listnode
*node
, *nnode
;
997 struct zserv
*client
;
999 for (ALL_LIST_ELEMENTS(zebrad
.client_list
, node
, nnode
, client
)) {
1000 if (client
->proto
== proto
&& client
->instance
== instance
)
1007 /* This command is for debugging purpose. */
1008 DEFUN (show_zebra_client
,
1009 show_zebra_client_cmd
,
1010 "show zebra client",
1013 "Client information\n")
1015 struct listnode
*node
;
1016 struct zserv
*client
;
1018 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1019 zebra_show_client_detail(vty
, client
);
1024 /* This command is for debugging purpose. */
1025 DEFUN (show_zebra_client_summary
,
1026 show_zebra_client_summary_cmd
,
1027 "show zebra client summary",
1030 "Client information brief\n"
1033 struct listnode
*node
;
1034 struct zserv
*client
;
1037 "Name Connect Time Last Read Last Write IPv4 Routes IPv6 Routes \n");
1039 "--------------------------------------------------------------------------------\n");
1041 for (ALL_LIST_ELEMENTS_RO(zebrad
.client_list
, node
, client
))
1042 zebra_show_client_brief(vty
, client
);
1044 vty_out(vty
, "Routes column shows (added+updated)/deleted\n");
1048 #if defined(HANDLE_ZAPI_FUZZING)
1049 void zserv_read_file(char *input
)
1054 fd
= open(input
, O_RDONLY
| O_NONBLOCK
);
1057 zserv_client_create(fd
);
1061 void zserv_init(void)
1063 /* Client list init. */
1064 zebrad
.client_list
= list_new();
1069 install_element(ENABLE_NODE
, &show_zebra_client_cmd
);
1070 install_element(ENABLE_NODE
, &show_zebra_client_summary_cmd
);