mirror of
https://git.proxmox.com/git/mirror_frr
synced 2025-05-28 10:50:18 +00:00
7d65b7b7f4
This commit introduces the MGMT Backend Interface which can be used
by back-end management client daemons like BGPd, Staticd, Zebra to
connect with new FRR Management daemon (MGMTd) and utilize the new
FRR Management Framework to let any Frontend clients to retrieve any
operational data or manipulate any configuration data owned by the
individual Backend daemon component.
This commit includes the following functionalities in the changeset:
1. Add new Backend server for Backend daemons connect to.
2. Add a C-based Backend client library which can be used by daemons
to communicate with MGMTd via the Backend interface.
3. Maintain a backend adapter for each connection from an appropriate
Backend client to facilitate client requests and track one or more
transactions initiated from Frontend client sessions that involves
the backend client component.
4. Add the following commands to inspect various Backend client
related information
a. show mgmt backend-adapter all
b. show mgmt backend-yang-xpath-registry
c. show mgmt yang-xpath-subscription
Co-authored-by: Pushpasis Sarkar <pushpasis@gmail.com>
Co-authored-by: Abhinay Ramesh <rabhinay@vmware.com>
Co-authored-by: Ujwal P <ujwalp@vmware.com>
Signed-off-by: Yash Ranjan <ranjany@vmware.com>
274 lines
7.1 KiB
C
274 lines
7.1 KiB
C
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
/*
|
|
* MGMTD Backend Client Library api interfaces
|
|
* Copyright (C) 2021 Vmware, Inc.
|
|
* Pushpasis Sarkar <spushpasis@vmware.com>
|
|
*/
|
|
|
|
#ifndef _FRR_MGMTD_BE_CLIENT_H_
|
|
#define _FRR_MGMTD_BE_CLIENT_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "mgmtd/mgmt_defines.h"
|
|
|
|
/***************************************************************
|
|
* Client IDs
|
|
***************************************************************/
|
|
|
|
/*
|
|
* Add enum value for each supported component, wrap with
|
|
* #ifdef HAVE_COMPONENT
|
|
*/
|
|
enum mgmt_be_client_id {
|
|
MGMTD_BE_CLIENT_ID_MIN = 0,
|
|
MGMTD_BE_CLIENT_ID_INIT = -1,
|
|
#if 0 /* example */
|
|
#ifdef HAVE_STATICD
|
|
MGMTD_BE_CLIENT_ID_STATICD,
|
|
#endif
|
|
#endif
|
|
MGMTD_BE_CLIENT_ID_MAX
|
|
};
|
|
|
|
#define FOREACH_MGMTD_BE_CLIENT_ID(id) \
|
|
for ((id) = MGMTD_BE_CLIENT_ID_MIN; \
|
|
(id) < MGMTD_BE_CLIENT_ID_MAX; (id)++)
|
|
|
|
/***************************************************************
|
|
* Constants
|
|
***************************************************************/
|
|
|
|
#define MGMTD_BE_CLIENT_ERROR_STRING_MAX_LEN 32
|
|
|
|
#define MGMTD_BE_DEFAULT_CONN_RETRY_INTVL_SEC 5
|
|
|
|
#define MGMTD_BE_MSG_PROC_DELAY_USEC 10
|
|
#define MGMTD_BE_MAX_NUM_MSG_PROC 500
|
|
|
|
#define MGMTD_BE_MSG_WRITE_DELAY_MSEC 1
|
|
#define MGMTD_BE_MAX_NUM_MSG_WRITE 1000
|
|
|
|
#define GMGD_BE_MAX_NUM_REQ_ITEMS 64
|
|
|
|
#define MGMTD_BE_MSG_MAX_LEN 16384
|
|
|
|
#define MGMTD_SOCKET_BE_SEND_BUF_SIZE 65535
|
|
#define MGMTD_SOCKET_BE_RECV_BUF_SIZE MGMTD_SOCKET_BE_SEND_BUF_SIZE
|
|
|
|
#define MGMTD_MAX_CFG_CHANGES_IN_BATCH \
|
|
((10 * MGMTD_BE_MSG_MAX_LEN) / \
|
|
(MGMTD_MAX_XPATH_LEN + MGMTD_MAX_YANG_VALUE_LEN))
|
|
|
|
/*
|
|
* MGMTD_BE_MSG_MAX_LEN must be used 80%
|
|
* since there is overhead of google protobuf
|
|
* that gets added to sent message
|
|
*/
|
|
#define MGMTD_BE_CFGDATA_PACKING_EFFICIENCY 0.8
|
|
#define MGMTD_BE_CFGDATA_MAX_MSG_LEN \
|
|
(MGMTD_BE_MSG_MAX_LEN * MGMTD_BE_CFGDATA_PACKING_EFFICIENCY)
|
|
|
|
#define MGMTD_BE_MAX_BATCH_IDS_IN_REQ \
|
|
(MGMTD_BE_MSG_MAX_LEN - 128) / sizeof(uint64_t)
|
|
|
|
#define MGMTD_BE_CONTAINER_NODE_VAL "<<container>>"
|
|
|
|
/***************************************************************
|
|
* Data-structures
|
|
***************************************************************/
|
|
|
|
#define MGMTD_BE_MAX_CLIENTS_PER_XPATH_REG 32
|
|
|
|
struct mgmt_be_msg_hdr {
|
|
uint16_t marker;
|
|
uint16_t len; /* Includes header */
|
|
};
|
|
#define MGMTD_BE_MSG_HDR_LEN sizeof(struct mgmt_be_msg_hdr)
|
|
#define MGMTD_BE_MSG_MARKER 0xfeed
|
|
|
|
struct mgmt_be_msg {
|
|
struct mgmt_be_msg_hdr hdr;
|
|
uint8_t payload[];
|
|
};
|
|
|
|
struct mgmt_be_client_txn_ctx {
|
|
uintptr_t *user_ctx;
|
|
};
|
|
|
|
/*
|
|
* All the client-specific information this library needs to
|
|
* initialize itself, setup connection with MGMTD BackEnd interface
|
|
* and carry on all required procedures appropriately.
|
|
*
|
|
* BackEnd clients need to initialise a instance of this structure
|
|
* with appropriate data and pass it while calling the API
|
|
* to initialize the library (See mgmt_be_client_lib_init for
|
|
* more details).
|
|
*/
|
|
struct mgmt_be_client_params {
|
|
char name[MGMTD_CLIENT_NAME_MAX_LEN];
|
|
uintptr_t user_data;
|
|
unsigned long conn_retry_intvl_sec;
|
|
|
|
void (*client_connect_notify)(uintptr_t lib_hndl,
|
|
uintptr_t usr_data,
|
|
bool connected);
|
|
|
|
void (*client_subscribe_notify)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct nb_yang_xpath **xpath,
|
|
enum mgmt_result subscribe_result[], int num_paths);
|
|
|
|
void (*txn_notify)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct mgmt_be_client_txn_ctx *txn_ctx, bool destroyed);
|
|
|
|
enum mgmt_result (*data_validate)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct mgmt_be_client_txn_ctx *txn_ctx,
|
|
struct nb_yang_xpath *xpath, struct nb_yang_value *data,
|
|
bool delete, char *error_if_any);
|
|
|
|
enum mgmt_result (*data_apply)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct mgmt_be_client_txn_ctx *txn_ctx,
|
|
struct nb_yang_xpath *xpath, struct nb_yang_value *data,
|
|
bool delete);
|
|
|
|
enum mgmt_result (*get_data_elem)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct mgmt_be_client_txn_ctx *txn_ctx,
|
|
struct nb_yang_xpath *xpath, struct nb_yang_xpath_elem *elem);
|
|
|
|
enum mgmt_result (*get_data)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct mgmt_be_client_txn_ctx *txn_ctx,
|
|
struct nb_yang_xpath *xpath, bool keys_only,
|
|
struct nb_yang_xpath_elem **elems, int *num_elems,
|
|
int *next_key);
|
|
|
|
enum mgmt_result (*get_next_data)(
|
|
uintptr_t lib_hndl, uintptr_t usr_data,
|
|
struct mgmt_be_client_txn_ctx *txn_ctx,
|
|
struct nb_yang_xpath *xpath, bool keys_only,
|
|
struct nb_yang_xpath_elem **elems, int *num_elems);
|
|
};
|
|
|
|
/***************************************************************
|
|
* Global data exported
|
|
***************************************************************/
|
|
|
|
extern const char *mgmt_be_client_names[MGMTD_BE_CLIENT_ID_MAX + 1];
|
|
|
|
static inline const char *mgmt_be_client_id2name(enum mgmt_be_client_id id)
|
|
{
|
|
if (id > MGMTD_BE_CLIENT_ID_MAX)
|
|
id = MGMTD_BE_CLIENT_ID_MAX;
|
|
return mgmt_be_client_names[id];
|
|
}
|
|
|
|
static inline enum mgmt_be_client_id
|
|
mgmt_be_client_name2id(const char *name)
|
|
{
|
|
enum mgmt_be_client_id id;
|
|
|
|
FOREACH_MGMTD_BE_CLIENT_ID (id) {
|
|
if (!strncmp(mgmt_be_client_names[id], name,
|
|
MGMTD_CLIENT_NAME_MAX_LEN))
|
|
return id;
|
|
}
|
|
|
|
return MGMTD_BE_CLIENT_ID_MAX;
|
|
}
|
|
|
|
/***************************************************************
|
|
* API prototypes
|
|
***************************************************************/
|
|
|
|
/*
|
|
* Initialize library and try connecting with MGMTD.
|
|
*
|
|
* params
|
|
* Backend client parameters.
|
|
*
|
|
* master_thread
|
|
* Thread master.
|
|
*
|
|
* Returns:
|
|
* Backend client lib handler (nothing but address of mgmt_be_client_ctx)
|
|
*/
|
|
extern uintptr_t
|
|
mgmt_be_client_lib_init(struct mgmt_be_client_params *params,
|
|
struct thread_master *master_thread);
|
|
|
|
/*
|
|
* Subscribe with MGMTD for one or more YANG subtree(s).
|
|
*
|
|
* lib_hndl
|
|
* Client library handler.
|
|
*
|
|
* reg_yang_xpaths
|
|
* Yang xpath(s) that needs to be subscribed to.
|
|
*
|
|
* num_xpaths
|
|
* Number of xpaths
|
|
*
|
|
* Returns:
|
|
* MGMTD_SUCCESS on success, MGMTD_* otherwise.
|
|
*/
|
|
extern enum mgmt_result mgmt_be_subscribe_yang_data(uintptr_t lib_hndl,
|
|
char **reg_yang_xpaths,
|
|
int num_xpaths);
|
|
|
|
/*
|
|
* Send one or more YANG notifications to MGMTD daemon.
|
|
*
|
|
* lib_hndl
|
|
* Client library handler.
|
|
*
|
|
* data_elems
|
|
* Yang data elements from data tree.
|
|
*
|
|
* num_elems
|
|
* Number of data elements.
|
|
*
|
|
* Returns:
|
|
* MGMTD_SUCCESS on success, MGMTD_* otherwise.
|
|
*/
|
|
extern enum mgmt_result
|
|
mgmt_be_send_yang_notify(uintptr_t lib_hndl, Mgmtd__YangData **data_elems,
|
|
int num_elems);
|
|
|
|
/*
|
|
* Un-subscribe with MGMTD for one or more YANG subtree(s).
|
|
*
|
|
* lib_hndl
|
|
* Client library handler.
|
|
*
|
|
* reg_yang_xpaths
|
|
* Yang xpath(s) that needs to be un-subscribed from.
|
|
*
|
|
* num_reg_xpaths
|
|
* Number of subscribed xpaths
|
|
*
|
|
* Returns:
|
|
* MGMTD_SUCCESS on success, MGMTD_* otherwise.
|
|
*/
|
|
enum mgmt_result mgmt_be_unsubscribe_yang_data(uintptr_t lib_hndl,
|
|
char **reg_yang_xpaths,
|
|
int num_reg_xpaths);
|
|
|
|
/*
|
|
* Destroy library and cleanup everything.
|
|
*/
|
|
extern void mgmt_be_client_lib_destroy(uintptr_t lib_hndl);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _FRR_MGMTD_BE_CLIENT_H_ */
|