1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* MGMTD Backend Client Connection Adapter
*
* Copyright (C) 2021 Vmware, Inc.
* Pushpasis Sarkar <spushpasis@vmware.com>
* Copyright (c) 2023, LabN Consulting, L.L.C.
*/
#ifndef _FRR_MGMTD_BE_ADAPTER_H_
#define _FRR_MGMTD_BE_ADAPTER_H_
#include "mgmt_be_client.h"
#include "mgmt_msg.h"
#include "mgmtd/mgmt_defines.h"
#include "mgmtd/mgmt_ds.h"
#define MGMTD_BE_CONN_INIT_DELAY_MSEC 50
#define MGMTD_FIND_ADAPTER_BY_INDEX(adapter_index) \
mgmt_adaptr_ref[adapter_index]
enum mgmt_be_req_type {
MGMTD_BE_REQ_NONE = 0,
MGMTD_BE_REQ_CFG_VALIDATE,
MGMTD_BE_REQ_CFG_APPLY,
MGMTD_BE_REQ_DATA_GET_ELEM,
MGMTD_BE_REQ_DATA_GET_NEXT
};
struct mgmt_be_cfgreq {
Mgmtd__YangCfgDataReq **cfgdata_reqs;
size_t num_reqs;
};
struct mgmt_be_datareq {
Mgmtd__YangGetDataReq **getdata_reqs;
size_t num_reqs;
};
PREDECL_LIST(mgmt_be_adapters);
PREDECL_LIST(mgmt_txn_badapters);
struct mgmt_be_client_adapter {
struct msg_conn *conn;
struct event *conn_init_ev;
enum mgmt_be_client_id id;
uint32_t flags;
char name[MGMTD_CLIENT_NAME_MAX_LEN];
uint8_t num_xpath_reg;
char xpath_reg[MGMTD_MAX_NUM_XPATH_REG][MGMTD_MAX_XPATH_LEN];
int refcount;
/*
* List of config items that should be sent to the
* backend during re/connect. This is temporarily
* created and then freed-up as soon as the initial
* config items has been applied onto the backend.
*/
struct nb_config_cbs cfg_chgs;
struct mgmt_be_adapters_item list_linkage;
};
#define MGMTD_BE_ADAPTER_FLAGS_CFG_SYNCED (1U << 0)
DECLARE_LIST(mgmt_be_adapters, struct mgmt_be_client_adapter, list_linkage);
/*
* MGMT_SUBSCR_xxx - flags for subscription types for xpaths registrations
*
* MGMT_SUBSCR_VALIDATE_CFG :: the client should be asked to validate config
* MGMT_SUBSCR_NOTIFY_CFG :: the client should be notified of config changes
* MGMT_SUBSCR_OPER_OWN :: the client owns the given oeprational state
*/
#define MGMT_SUBSCR_VALIDATE_CFG 0x1
#define MGMT_SUBSCR_NOTIFY_CFG 0x2
#define MGMT_SUBSCR_OPER_OWN 0x4
#define MGMT_SUBSCR_ALL 0x7
struct mgmt_be_client_subscr_info {
uint xpath_subscr[MGMTD_BE_CLIENT_ID_MAX];
};
/* Initialise backend adapter module. */
extern void mgmt_be_adapter_init(struct event_loop *tm);
/* Destroy the backend adapter module. */
extern void mgmt_be_adapter_destroy(void);
/* Acquire lock for backend adapter. */
extern void mgmt_be_adapter_lock(struct mgmt_be_client_adapter *adapter);
/* Remove lock from backend adapter. */
extern void mgmt_be_adapter_unlock(struct mgmt_be_client_adapter **adapter);
/* Create backend adapter. */
extern struct msg_conn *mgmt_be_create_adapter(int conn_fd,
union sockunion *su);
/* Fetch backend adapter given an adapter name. */
extern struct mgmt_be_client_adapter *
mgmt_be_get_adapter_by_name(const char *name);
/* Fetch backend adapter given an client ID. */
extern struct mgmt_be_client_adapter *
mgmt_be_get_adapter_by_id(enum mgmt_be_client_id id);
/* Fetch backend adapter config. */
extern int
mgmt_be_get_adapter_config(struct mgmt_be_client_adapter *adapter,
struct mgmt_ds_ctx *ds_ctx,
struct nb_config_cbs **cfg_chgs);
/* Create/destroy a transaction. */
extern int mgmt_be_send_txn_req(struct mgmt_be_client_adapter *adapter,
uint64_t txn_id, bool create);
/*
* Send config data create request to backend client.
*
* adaptr
* Backend adapter information.
*
* txn_id
* Unique transaction identifier.
*
* batch_id
* Request batch ID.
*
* cfgdata_reqs
* An array of pointer to Mgmtd__YangCfgDataReq.
*
* num_reqs
* Length of the cfgdata_reqs array.
*
* end_of_data
* TRUE if the data from last batch, FALSE otherwise.
*
* Returns:
* 0 on success, -1 on failure.
*/
extern int mgmt_be_send_cfgdata_req(struct mgmt_be_client_adapter *adapter,
uint64_t txn_id, uint64_t batch_id,
Mgmtd__YangCfgDataReq **cfgdata_reqs,
size_t num_reqs, bool end_of_data);
/*
* Send config apply request to backend client.
*
* adapter
* Backend adapter information.
*
* txn_id
* Unique transaction identifier.
*
* Returns:
* 0 on success, -1 on failure.
*/
extern int mgmt_be_send_cfgapply_req(struct mgmt_be_client_adapter *adapter,
uint64_t txn_id);
/*
* Dump backend adapter status to vty.
*/
extern void mgmt_be_adapter_status_write(struct vty *vty);
/*
* Dump xpath registry for each backend client to vty.
*/
extern void mgmt_be_xpath_register_write(struct vty *vty);
/**
* Lookup the clients which are subscribed to a given `xpath`
* and the way they are subscribed.
*
* Args:
* xpath - the xpath to check for subscription information.
* subscr_info - An array of uint indexed by client id
* each eleemnt holds the subscription info
* for that client.
*/
extern void mgmt_be_get_subscr_info_for_xpath(
const char *xpath, struct mgmt_be_client_subscr_info *subscr_info);
/*
* Dump backend client information for a given xpath to vty.
*/
extern void mgmt_be_xpath_subscr_info_write(struct vty *vty,
const char *xpath);
#endif /* _FRR_MGMTD_BE_ADAPTER_H_ */
|
