mirror of
https://git.proxmox.com/git/mirror_frr
synced 2025-11-04 06:38:04 +00:00
9ab0b2a37a
Add error handling for top level failures (not able to execute command, unable to find vrf for command, etc.) With this error handling we add a new zapi message type of ZEBRA_ERROR used when we are unable to properly handle a zapi command and pass it down into the lower level code. In the event of this, we reply with a message of type enum zebra_error_types containing the error type. The sent packet will look like so: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Length | Marker | Version | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | VRF ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Command | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ERROR TYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Also add appropriate hooks for clients to subscribe to for handling these types of errors. Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
273 lines
6.6 KiB
C
273 lines
6.6 KiB
C
/*
|
|
* Zebra API server.
|
|
* Portions:
|
|
* Copyright (C) 1997-1999 Kunihiro Ishiguro
|
|
* Copyright (C) 2015-2018 Cumulus Networks, Inc.
|
|
* et al.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the Free
|
|
* Software Foundation; either version 2 of the License, or (at your option)
|
|
* any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
* more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; see the file COPYING; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _ZEBRA_ZSERV_H
|
|
#define _ZEBRA_ZSERV_H
|
|
|
|
/* clang-format off */
|
|
#include <stdint.h> /* for uint32_t, uint8_t */
|
|
#include <time.h> /* for time_t */
|
|
|
|
#include "lib/route_types.h" /* for ZEBRA_ROUTE_MAX */
|
|
#include "lib/zebra.h" /* for AFI_MAX */
|
|
#include "lib/vrf.h" /* for vrf_bitmap_t */
|
|
#include "lib/zclient.h" /* for redist_proto */
|
|
#include "lib/stream.h" /* for stream, stream_fifo */
|
|
#include "lib/thread.h" /* for thread, thread_master */
|
|
#include "lib/linklist.h" /* for list */
|
|
#include "lib/workqueue.h" /* for work_queue */
|
|
#include "lib/hook.h" /* for DECLARE_HOOK, DECLARE_KOOH */
|
|
|
|
#include "zebra/zebra_vrf.h" /* for zebra_vrf */
|
|
/* clang-format on */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Default port information. */
|
|
#define ZEBRA_VTY_PORT 2601
|
|
|
|
/* Default configuration filename. */
|
|
#define DEFAULT_CONFIG_FILE "zebra.conf"
|
|
|
|
#define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
|
|
|
|
/* Client structure. */
|
|
struct zserv {
|
|
/* Client pthread */
|
|
struct frr_pthread *pthread;
|
|
|
|
/* Client file descriptor. */
|
|
int sock;
|
|
|
|
/* Input/output buffer to the client. */
|
|
pthread_mutex_t ibuf_mtx;
|
|
struct stream_fifo *ibuf_fifo;
|
|
pthread_mutex_t obuf_mtx;
|
|
struct stream_fifo *obuf_fifo;
|
|
|
|
/* Private I/O buffers */
|
|
struct stream *ibuf_work;
|
|
struct stream *obuf_work;
|
|
|
|
/* Buffer of data waiting to be written to client. */
|
|
struct buffer *wb;
|
|
|
|
/* Threads for read/write. */
|
|
struct thread *t_read;
|
|
struct thread *t_write;
|
|
|
|
/* Event for message processing, for the main pthread */
|
|
struct thread *t_process;
|
|
|
|
/* Threads for the main pthread */
|
|
struct thread *t_cleanup;
|
|
|
|
/* This client's redistribute flag. */
|
|
struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
|
|
vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
|
|
|
|
/* Redistribute default route flag. */
|
|
vrf_bitmap_t redist_default[AFI_MAX];
|
|
|
|
/* Router-id information. */
|
|
vrf_bitmap_t ridinfo;
|
|
|
|
bool notify_owner;
|
|
|
|
/* client's protocol */
|
|
uint8_t proto;
|
|
uint16_t instance;
|
|
|
|
/*
|
|
* Interested for MLAG Updates, and also stores the client
|
|
* interested message mask
|
|
*/
|
|
bool mlag_updates_interested;
|
|
uint32_t mlag_reg_mask1;
|
|
|
|
/* Statistics */
|
|
uint32_t redist_v4_add_cnt;
|
|
uint32_t redist_v4_del_cnt;
|
|
uint32_t redist_v6_add_cnt;
|
|
uint32_t redist_v6_del_cnt;
|
|
uint32_t v4_route_add_cnt;
|
|
uint32_t v4_route_upd8_cnt;
|
|
uint32_t v4_route_del_cnt;
|
|
uint32_t v6_route_add_cnt;
|
|
uint32_t v6_route_del_cnt;
|
|
uint32_t v6_route_upd8_cnt;
|
|
uint32_t connected_rt_add_cnt;
|
|
uint32_t connected_rt_del_cnt;
|
|
uint32_t ifup_cnt;
|
|
uint32_t ifdown_cnt;
|
|
uint32_t ifadd_cnt;
|
|
uint32_t ifdel_cnt;
|
|
uint32_t if_bfd_cnt;
|
|
uint32_t bfd_peer_add_cnt;
|
|
uint32_t bfd_peer_upd8_cnt;
|
|
uint32_t bfd_peer_del_cnt;
|
|
uint32_t bfd_peer_replay_cnt;
|
|
uint32_t vrfadd_cnt;
|
|
uint32_t vrfdel_cnt;
|
|
uint32_t if_vrfchg_cnt;
|
|
uint32_t bfd_client_reg_cnt;
|
|
uint32_t vniadd_cnt;
|
|
uint32_t vnidel_cnt;
|
|
uint32_t l3vniadd_cnt;
|
|
uint32_t l3vnidel_cnt;
|
|
uint32_t macipadd_cnt;
|
|
uint32_t macipdel_cnt;
|
|
uint32_t prefixadd_cnt;
|
|
uint32_t prefixdel_cnt;
|
|
uint32_t v4_nh_watch_add_cnt;
|
|
uint32_t v4_nh_watch_rem_cnt;
|
|
uint32_t v6_nh_watch_add_cnt;
|
|
uint32_t v6_nh_watch_rem_cnt;
|
|
uint32_t vxlan_sg_add_cnt;
|
|
uint32_t vxlan_sg_del_cnt;
|
|
uint32_t error_cnt;
|
|
|
|
time_t nh_reg_time;
|
|
time_t nh_dereg_time;
|
|
time_t nh_last_upd_time;
|
|
|
|
/*
|
|
* Session information.
|
|
*
|
|
* These are not synchronous with respect to each other. For instance,
|
|
* last_read_cmd may contain a value that has been read in the future
|
|
* relative to last_read_time.
|
|
*/
|
|
|
|
/* monotime of client creation */
|
|
_Atomic uint32_t connect_time;
|
|
/* monotime of last message received */
|
|
_Atomic uint32_t last_read_time;
|
|
/* monotime of last message sent */
|
|
_Atomic uint32_t last_write_time;
|
|
/* command code of last message read */
|
|
_Atomic uint32_t last_read_cmd;
|
|
/* command code of last message written */
|
|
_Atomic uint32_t last_write_cmd;
|
|
};
|
|
|
|
#define ZAPI_HANDLER_ARGS \
|
|
struct zserv *client, struct zmsghdr *hdr, struct stream *msg, \
|
|
struct zebra_vrf *zvrf
|
|
|
|
/* Hooks for client connect / disconnect */
|
|
DECLARE_HOOK(zserv_client_connect, (struct zserv *client), (client));
|
|
DECLARE_KOOH(zserv_client_close, (struct zserv *client), (client));
|
|
|
|
/*
|
|
* Initialize Zebra API server.
|
|
*
|
|
* Installs CLI commands and creates the client list.
|
|
*/
|
|
extern void zserv_init(void);
|
|
|
|
/*
|
|
* Stop the Zebra API server.
|
|
*
|
|
* closes the socket
|
|
*/
|
|
extern void zserv_close(void);
|
|
|
|
/*
|
|
* Start Zebra API server.
|
|
*
|
|
* Allocates resources, creates the server socket and begins listening on the
|
|
* socket.
|
|
*
|
|
* path
|
|
* where to place the Unix domain socket
|
|
*/
|
|
extern void zserv_start(char *path);
|
|
|
|
/*
|
|
* Send a message to a connected Zebra API client.
|
|
*
|
|
* client
|
|
* the client to send to
|
|
*
|
|
* msg
|
|
* the message to send
|
|
*/
|
|
extern int zserv_send_message(struct zserv *client, struct stream *msg);
|
|
|
|
/*
|
|
* Retrieve a client by its protocol and instance number.
|
|
*
|
|
* proto
|
|
* protocol number
|
|
*
|
|
* instance
|
|
* instance number
|
|
*
|
|
* Returns:
|
|
* The Zebra API client.
|
|
*/
|
|
extern struct zserv *zserv_find_client(uint8_t proto, unsigned short instance);
|
|
|
|
|
|
/*
|
|
* Close a client.
|
|
*
|
|
* Kills a client's thread, removes the client from the client list and cleans
|
|
* up its resources.
|
|
*
|
|
* client
|
|
* the client to close
|
|
*/
|
|
extern void zserv_close_client(struct zserv *client);
|
|
|
|
|
|
/*
|
|
* Log a ZAPI message hexdump.
|
|
*
|
|
* errmsg
|
|
* Error message to include with packet hexdump
|
|
*
|
|
* msg
|
|
* Message to log
|
|
*
|
|
* hdr
|
|
* Message header
|
|
*/
|
|
void zserv_log_message(const char *errmsg, struct stream *msg,
|
|
struct zmsghdr *hdr);
|
|
|
|
#if defined(HANDLE_ZAPI_FUZZING)
|
|
extern void zserv_read_file(char *input);
|
|
#endif
|
|
|
|
/* TODO */
|
|
int zebra_finalize(struct thread *event);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ZEBRA_ZEBRA_H */
|