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 */
40 #include "zebra/zebra_vrf.h" /* for zebra_vrf */
43 /* Default port information. */
44 #define ZEBRA_VTY_PORT 2601
46 /* Default configuration filename. */
47 #define DEFAULT_CONFIG_FILE "zebra.conf"
49 #define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
51 /* Client structure. */
54 struct frr_pthread
*pthread
;
56 /* Client file descriptor. */
59 /* Input/output buffer to the client. */
60 pthread_mutex_t ibuf_mtx
;
61 struct stream_fifo
*ibuf_fifo
;
62 pthread_mutex_t obuf_mtx
;
63 struct stream_fifo
*obuf_fifo
;
65 /* Private I/O buffers */
66 struct stream
*ibuf_work
;
67 struct stream
*obuf_work
;
69 /* Buffer of data waiting to be written to client. */
72 /* Threads for read/write. */
73 struct thread
*t_read
;
74 struct thread
*t_write
;
76 /* Threads for the main pthread */
77 struct thread
*t_cleanup
;
79 /* default routing table this client munges */
82 /* This client's redistribute flag. */
83 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
84 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
86 /* Redistribute default route flag. */
87 vrf_bitmap_t redist_default
;
89 /* Interface information. */
92 /* Router-id information. */
97 /* client's protocol */
100 uint8_t is_synchronous
;
103 uint32_t redist_v4_add_cnt
;
104 uint32_t redist_v4_del_cnt
;
105 uint32_t redist_v6_add_cnt
;
106 uint32_t redist_v6_del_cnt
;
107 uint32_t v4_route_add_cnt
;
108 uint32_t v4_route_upd8_cnt
;
109 uint32_t v4_route_del_cnt
;
110 uint32_t v6_route_add_cnt
;
111 uint32_t v6_route_del_cnt
;
112 uint32_t v6_route_upd8_cnt
;
113 uint32_t connected_rt_add_cnt
;
114 uint32_t connected_rt_del_cnt
;
120 uint32_t bfd_peer_add_cnt
;
121 uint32_t bfd_peer_upd8_cnt
;
122 uint32_t bfd_peer_del_cnt
;
123 uint32_t bfd_peer_replay_cnt
;
126 uint32_t if_vrfchg_cnt
;
127 uint32_t bfd_client_reg_cnt
;
130 uint32_t l3vniadd_cnt
;
131 uint32_t l3vnidel_cnt
;
132 uint32_t macipadd_cnt
;
133 uint32_t macipdel_cnt
;
134 uint32_t prefixadd_cnt
;
135 uint32_t prefixdel_cnt
;
138 time_t nh_dereg_time
;
139 time_t nh_last_upd_time
;
142 * Session information.
144 * These are not synchronous with respect to each other. For instance,
145 * last_read_cmd may contain a value that has been read in the future
146 * relative to last_read_time.
149 /* monotime of client creation */
150 _Atomic
uint32_t connect_time
;
151 /* monotime of last message received */
152 _Atomic
uint32_t last_read_time
;
153 /* monotime of last message sent */
154 _Atomic
uint32_t last_write_time
;
155 /* command code of last message read */
156 _Atomic
uint16_t last_read_cmd
;
157 /* command code of last message written */
158 _Atomic
uint16_t last_write_cmd
;
161 #define ZAPI_HANDLER_ARGS \
162 struct zserv *client, struct zmsghdr *hdr, struct stream *msg, \
163 struct zebra_vrf *zvrf
165 /* Hooks for client connect / disconnect */
166 DECLARE_HOOK(zserv_client_connect
, (struct zserv
*client
), (client
));
167 DECLARE_KOOH(zserv_client_close
, (struct zserv
*client
), (client
));
172 struct thread_master
*master
;
173 struct list
*client_list
;
179 uint32_t rtm_table_default
;
182 #define ZEBRA_RIB_PROCESS_HOLD_TIME 10
183 struct work_queue
*ribq
;
184 struct meta_queue
*mq
;
187 struct work_queue
*lsp_process_q
;
189 #define ZEBRA_ZAPI_PACKETS_TO_PROCESS 1000
190 _Atomic
uint32_t packets_to_process
;
192 extern struct zebra_t zebrad
;
193 extern unsigned int multipath_num
;
196 * Initialize Zebra API server.
198 * Installs CLI commands and creates the client list.
200 extern void zserv_init(void);
203 * Start Zebra API server.
205 * Allocates resources, creates the server socket and begins listening on the
209 * where to place the Unix domain socket
211 extern void zserv_start(char *path
);
214 * Send a message to a connected Zebra API client.
217 * the client to send to
220 * the message to send
222 extern int zserv_send_message(struct zserv
*client
, struct stream
*msg
);
225 * Retrieve a client by its protocol and instance number.
234 * The Zebra API client.
236 extern struct zserv
*zserv_find_client(uint8_t proto
, unsigned short instance
);
242 * Kills a client's thread, removes the client from the client list and cleans
246 * the client to close
248 extern void zserv_close_client(struct zserv
*client
);
250 #if defined(HANDLE_ZAPI_FUZZING)
251 extern void zserv_read_file(char *input
);
254 #endif /* _ZEBRA_ZEBRA_H */