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
23 #ifndef _ZEBRA_ZSERV_H
24 #define _ZEBRA_ZSERV_H
26 /* clang-format off */
27 #include <stdint.h> /* for uint32_t, uint8_t */
28 #include <time.h> /* for time_t */
30 #include "lib/route_types.h" /* for ZEBRA_ROUTE_MAX */
31 #include "lib/zebra.h" /* for AFI_MAX */
32 #include "lib/vrf.h" /* for vrf_bitmap_t */
33 #include "lib/zclient.h" /* for redist_proto */
34 #include "lib/stream.h" /* for stream, stream_fifo */
35 #include "lib/thread.h" /* for thread, thread_master */
36 #include "lib/linklist.h" /* for list */
37 #include "lib/workqueue.h" /* for work_queue */
38 #include "lib/hook.h" /* for DECLARE_HOOK, DECLARE_KOOH */
47 /* Default port information. */
48 #define ZEBRA_VTY_PORT 2601
50 /* Default configuration filename. */
51 #define DEFAULT_CONFIG_FILE "zebra.conf"
53 #define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
56 /* Stale route marker timer */
57 #define ZEBRA_DEFAULT_STALE_UPDATE_DELAY 1
59 /* Count of stale routes processed in timer context */
60 #define ZEBRA_MAX_STALE_ROUTE_COUNT 50000
62 /* Graceful Restart information */
63 struct client_gr_info
{
64 /* VRF for which GR enabled */
70 /* Stale time and GR cap */
71 uint32_t stale_removal_time
;
72 enum zserv_client_capabilities capabilities
;
79 /* Route sync and enable flags for AFI/SAFI */
80 bool af_enabled
[AFI_MAX
][SAFI_MAX
];
81 bool route_sync
[AFI_MAX
][SAFI_MAX
];
84 struct prefix
*current_prefix
;
85 void *stale_client_ptr
;
86 struct thread
*t_stale_removal
;
88 TAILQ_ENTRY(client_gr_info
) gr_info
;
91 /* Client structure. */
94 struct frr_pthread
*pthread
;
96 /* Client file descriptor. */
99 /* Attributes used to permit access to zapi clients from
100 * other pthreads: the client has a busy counter, and a
101 * 'closed' flag. These attributes are managed using a
102 * lock, via the acquire_client() and release_client() apis.
107 /* Input/output buffer to the client. */
108 pthread_mutex_t ibuf_mtx
;
109 struct stream_fifo
*ibuf_fifo
;
110 pthread_mutex_t obuf_mtx
;
111 struct stream_fifo
*obuf_fifo
;
113 /* Private I/O buffers */
114 struct stream
*ibuf_work
;
115 struct stream
*obuf_work
;
117 /* Buffer of data waiting to be written to client. */
120 /* Threads for read/write. */
121 struct thread
*t_read
;
122 struct thread
*t_write
;
124 /* Event for message processing, for the main pthread */
125 struct thread
*t_process
;
127 /* Event for the main pthread */
128 struct thread
*t_cleanup
;
130 /* This client's redistribute flag. */
131 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
132 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
134 /* Redistribute default route flag. */
135 vrf_bitmap_t redist_default
[AFI_MAX
];
137 /* Router-id information. */
138 vrf_bitmap_t ridinfo
[AFI_MAX
];
140 /* Router-id information. */
141 vrf_bitmap_t nhrp_neighinfo
[AFI_MAX
];
145 /* Indicates if client is synchronous. */
148 /* client's protocol and session info */
154 * Interested for MLAG Updates, and also stores the client
155 * interested message mask
157 bool mlag_updates_interested
;
158 uint32_t mlag_reg_mask1
;
161 uint32_t redist_v4_add_cnt
;
162 uint32_t redist_v4_del_cnt
;
163 uint32_t redist_v6_add_cnt
;
164 uint32_t redist_v6_del_cnt
;
165 uint32_t v4_route_add_cnt
;
166 uint32_t v4_route_upd8_cnt
;
167 uint32_t v4_route_del_cnt
;
168 uint32_t v6_route_add_cnt
;
169 uint32_t v6_route_del_cnt
;
170 uint32_t v6_route_upd8_cnt
;
171 uint32_t connected_rt_add_cnt
;
172 uint32_t connected_rt_del_cnt
;
178 uint32_t bfd_peer_add_cnt
;
179 uint32_t bfd_peer_upd8_cnt
;
180 uint32_t bfd_peer_del_cnt
;
181 uint32_t bfd_peer_replay_cnt
;
184 uint32_t if_vrfchg_cnt
;
185 uint32_t bfd_client_reg_cnt
;
188 uint32_t l3vniadd_cnt
;
189 uint32_t l3vnidel_cnt
;
190 uint32_t macipadd_cnt
;
191 uint32_t macipdel_cnt
;
192 uint32_t prefixadd_cnt
;
193 uint32_t prefixdel_cnt
;
194 uint32_t v4_nh_watch_add_cnt
;
195 uint32_t v4_nh_watch_rem_cnt
;
196 uint32_t v6_nh_watch_add_cnt
;
197 uint32_t v6_nh_watch_rem_cnt
;
198 uint32_t vxlan_sg_add_cnt
;
199 uint32_t vxlan_sg_del_cnt
;
200 uint32_t local_es_add_cnt
;
201 uint32_t local_es_del_cnt
;
202 uint32_t local_es_evi_add_cnt
;
203 uint32_t local_es_evi_del_cnt
;
207 time_t nh_dereg_time
;
208 time_t nh_last_upd_time
;
211 * Session information.
213 * These are not synchronous with respect to each other. For instance,
214 * last_read_cmd may contain a value that has been read in the future
215 * relative to last_read_time.
218 pthread_mutex_t stats_mtx
;
219 /* BEGIN covered by stats_mtx */
221 /* monotime of client creation */
222 uint64_t connect_time
;
223 /* monotime of last message received */
224 uint64_t last_read_time
;
225 /* monotime of last message sent */
226 uint64_t last_write_time
;
227 /* command code of last message read */
228 uint64_t last_read_cmd
;
229 /* command code of last message written */
230 uint64_t last_write_cmd
;
232 /* END covered by stats_mtx */
235 * Number of instances configured with
238 uint32_t gr_instance_count
;
242 * Graceful restart information for
245 TAILQ_HEAD(info_list
, client_gr_info
) gr_info_queue
;
248 #define ZAPI_HANDLER_ARGS \
249 struct zserv *client, struct zmsghdr *hdr, struct stream *msg, \
250 struct zebra_vrf *zvrf
252 /* Hooks for client connect / disconnect */
253 DECLARE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
254 DECLARE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
256 #define DYNAMIC_CLIENT_GR_DISABLED(_client) \
257 ((_client->proto <= ZEBRA_ROUTE_CONNECT) \
258 || !(_client->gr_instance_count))
261 * Initialize Zebra API server.
263 * Installs CLI commands and creates the client list.
265 extern void zserv_init(void);
268 * Stop the Zebra API server.
272 extern void zserv_close(void);
275 * Start Zebra API server.
277 * Allocates resources, creates the server socket and begins listening on the
281 * where to place the Unix domain socket
283 extern void zserv_start(char *path
);
286 * Send a message to a connected Zebra API client.
289 * the client to send to
292 * the message to send
294 extern int zserv_send_message(struct zserv
*client
, struct stream
*msg
);
297 * Send a batch of messages to a connected Zebra API client.
300 * the client to send to
303 * the list of messages to send
305 extern int zserv_send_batch(struct zserv
*client
, struct stream_fifo
*fifo
);
308 * Retrieve a client by its protocol and instance number.
317 * The Zebra API client.
319 extern struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
);
322 * Retrieve a client by its protocol, instance number, and session id.
334 * The Zebra API client.
336 struct zserv
*zserv_find_client_session(uint8_t proto
, unsigned short instance
,
337 uint32_t session_id
);
340 * Retrieve a client object by the complete tuple of
341 * {protocol, instance, session}. This version supports use
342 * from a different pthread: the object will be returned marked
343 * in-use. The caller *must* release the client object with the
344 * release_client() api, to ensure that the in-use marker is cleared properly.
347 * The Zebra API client.
349 extern struct zserv
*zserv_acquire_client(uint8_t proto
,
350 unsigned short instance
,
351 uint32_t session_id
);
354 * Release a client object that was acquired with the acquire_client() api.
355 * After this has been called, the pointer must not be used - it may be freed
356 * in another pthread if the client has closed.
358 extern void zserv_release_client(struct zserv
*client
);
363 * Kills a client's thread, removes the client from the client list and cleans
367 * the client to close
369 extern void zserv_close_client(struct zserv
*client
);
372 * Free memory for a zserv client object - note that this does not
373 * clean up the internal allocations associated with the zserv client,
374 * this just free the struct's memory.
376 void zserv_client_delete(struct zserv
*client
);
379 * Log a ZAPI message hexdump.
382 * Error message to include with packet hexdump
390 void zserv_log_message(const char *errmsg
, struct stream
*msg
,
391 struct zmsghdr
*hdr
);
394 __attribute__((__noreturn__
)) void zebra_finalize(struct thread
*event
);
397 * Graceful restart functions.
399 extern int zebra_gr_client_disconnect(struct zserv
*client
);
400 extern void zebra_gr_client_reconnect(struct zserv
*client
);
401 extern void zebra_gr_stale_client_cleanup(struct list
*client_list
);
402 extern void zread_client_capabilities(struct zserv
*client
, struct zmsghdr
*hdr
,
404 struct zebra_vrf
*zvrf
);
410 #endif /* _ZEBRA_ZEBRA_H */