zebra/zserv.h

   1 /*
   2  * Zebra API server.
   3  * Portions:
   4  *   Copyright (C) 1997-1999  Kunihiro Ishiguro
   5  *   Copyright (C) 2015-2018  Cumulus Networks, Inc.
   6  *   et al.
   7  *
   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)
  11  * any later version.
  12  *
  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
  16  * more details.
  17  *
  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
  21  */
  22
  23 #ifndef _ZEBRA_ZSERV_H
  24 #define _ZEBRA_ZSERV_H
  25
  26 /* clang-format off */
  27 #include <stdint.h>           /* for uint32_t, uint8_t */
  28 #include <time.h>             /* for time_t */
  29
  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 */
  39 /* clang-format on */
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 struct zebra_vrf;
  46
  47 /* Default port information. */
  48 #define ZEBRA_VTY_PORT                2601
  49
  50 /* Default configuration filename. */
  51 #define DEFAULT_CONFIG_FILE "zebra.conf"
  52
  53 #define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
  54
  55
  56 /* Stale route marker timer */
  57 #define ZEBRA_DEFAULT_STALE_UPDATE_DELAY 1
  58
  59 /* Count of stale routes processed in timer context */
  60 #define ZEBRA_MAX_STALE_ROUTE_COUNT 50000
  61
  62 /* Graceful Restart information */
  63 struct client_gr_info {
  64         /* VRF for which GR enabled */
  65         vrf_id_t vrf_id;
  66
  67         /* AFI */
  68         afi_t current_afi;
  69
  70         /* Stale time and GR cap */
  71         uint32_t stale_removal_time;
  72         enum zserv_client_capabilities capabilities;
  73
  74         /* GR commands */
  75         bool do_delete;
  76         bool gr_enable;
  77         bool stale_client;
  78
  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];
  82
  83         /* Book keeping */
  84         struct prefix *current_prefix;
  85         void *stale_client_ptr;
  86         struct thread *t_stale_removal;
  87
  88         TAILQ_ENTRY(client_gr_info) gr_info;
  89 };
  90
  91 /* Client structure. */
  92 struct zserv {
  93         /* Client pthread */
  94         struct frr_pthread *pthread;
  95
  96         /* Client file descriptor. */
  97         int sock;
  98
  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.
 103          */
 104         int busy_count;
 105         bool is_closed;
 106
 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;
 112
 113         /* Private I/O buffers */
 114         struct stream *ibuf_work;
 115         struct stream *obuf_work;
 116
 117         /* Buffer of data waiting to be written to client. */
 118         struct buffer *wb;
 119
 120         /* Threads for read/write. */
 121         struct thread *t_read;
 122         struct thread *t_write;
 123
 124         /* Event for message processing, for the main pthread */
 125         struct thread *t_process;
 126
 127         /* Event for the main pthread */
 128         struct thread *t_cleanup;
 129
 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];
 133
 134         /* Redistribute default route flag. */
 135         vrf_bitmap_t redist_default[AFI_MAX];
 136
 137         /* Router-id information. */
 138         vrf_bitmap_t ridinfo[AFI_MAX];
 139
 140         /* Router-id information. */
 141         vrf_bitmap_t nhrp_neighinfo[AFI_MAX];
 142
 143         bool notify_owner;
 144
 145         /* Indicates if client is synchronous. */
 146         bool synchronous;
 147
 148         /* client's protocol and session info */
 149         uint8_t proto;
 150         uint16_t instance;
 151         uint32_t session_id;
 152
 153         /*
 154          * Interested for MLAG Updates, and also stores the client
 155          * interested message mask
 156          */
 157         bool mlag_updates_interested;
 158         uint32_t mlag_reg_mask1;
 159
 160         /* Statistics */
 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;
 173         uint32_t ifup_cnt;
 174         uint32_t ifdown_cnt;
 175         uint32_t ifadd_cnt;
 176         uint32_t ifdel_cnt;
 177         uint32_t if_bfd_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;
 182         uint32_t vrfadd_cnt;
 183         uint32_t vrfdel_cnt;
 184         uint32_t if_vrfchg_cnt;
 185         uint32_t bfd_client_reg_cnt;
 186         uint32_t vniadd_cnt;
 187         uint32_t vnidel_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;
 204         uint32_t error_cnt;
 205
 206         time_t nh_reg_time;
 207         time_t nh_dereg_time;
 208         time_t nh_last_upd_time;
 209
 210         /*
 211          * Session information.
 212          *
 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.
 216          */
 217
 218         /* monotime of client creation */
 219         _Atomic uint64_t connect_time;
 220         /* monotime of last message received */
 221         _Atomic uint64_t last_read_time;
 222         /* monotime of last message sent */
 223         _Atomic uint64_t last_write_time;
 224         /* command code of last message read */
 225         _Atomic uint64_t last_read_cmd;
 226         /* command code of last message written */
 227         _Atomic uint64_t last_write_cmd;
 228
 229         /*
 230          * Number of instances configured with
 231          * graceful restart
 232          */
 233         uint32_t gr_instance_count;
 234         time_t restart_time;
 235
 236         /*
 237          * Graceful restart information for
 238          * each instance
 239          */
 240         TAILQ_HEAD(info_list, client_gr_info) gr_info_queue;
 241 };
 242
 243 #define ZAPI_HANDLER_ARGS                                                      \
 244         struct zserv *client, struct zmsghdr *hdr, struct stream *msg,         \
 245                 struct zebra_vrf *zvrf
 246
 247 /* Hooks for client connect / disconnect */
 248 DECLARE_HOOK(zserv_client_connect, (struct zserv *client), (client));
 249 DECLARE_KOOH(zserv_client_close, (struct zserv *client), (client));
 250
 251 #define DYNAMIC_CLIENT_GR_DISABLED(_client)                                    \
 252         ((_client->proto <= ZEBRA_ROUTE_CONNECT)                               \
 253          || !(_client->gr_instance_count))
 254
 255 /*
 256  * Initialize Zebra API server.
 257  *
 258  * Installs CLI commands and creates the client list.
 259  */
 260 extern void zserv_init(void);
 261
 262 /*
 263  * Stop the Zebra API server.
 264  *
 265  * closes the socket
 266  */
 267 extern void zserv_close(void);
 268
 269 /*
 270  * Start Zebra API server.
 271  *
 272  * Allocates resources, creates the server socket and begins listening on the
 273  * socket.
 274  *
 275  * path
 276  *    where to place the Unix domain socket
 277  */
 278 extern void zserv_start(char *path);
 279
 280 /*
 281  * Send a message to a connected Zebra API client.
 282  *
 283  * client
 284  *    the client to send to
 285  *
 286  * msg
 287  *    the message to send
 288  */
 289 extern int zserv_send_message(struct zserv *client, struct stream *msg);
 290
 291 /*
 292  * Send a batch of messages to a connected Zebra API client.
 293  *
 294  * client
 295  *    the client to send to
 296  *
 297  * fifo
 298  *    the list of messages to send
 299  */
 300 extern int zserv_send_batch(struct zserv *client, struct stream_fifo *fifo);
 301
 302 /*
 303  * Retrieve a client by its protocol and instance number.
 304  *
 305  * proto
 306  *    protocol number
 307  *
 308  * instance
 309  *    instance number
 310  *
 311  * Returns:
 312  *    The Zebra API client.
 313  */
 314 extern struct zserv *zserv_find_client(uint8_t proto, unsigned short instance);
 315
 316 /*
 317  * Retrieve a client by its protocol, instance number, and session id.
 318  *
 319  * proto
 320  *    protocol number
 321  *
 322  * instance
 323  *    instance number
 324  *
 325  * session_id
 326  *    session id
 327  *
 328  * Returns:
 329  *    The Zebra API client.
 330  */
 331 struct zserv *zserv_find_client_session(uint8_t proto, unsigned short instance,
 332                                         uint32_t session_id);
 333
 334 /*
 335  * Retrieve a client object by the complete tuple of
 336  * {protocol, instance, session}. This version supports use
 337  * from a different pthread: the object will be returned marked
 338  * in-use. The caller *must* release the client object with the
 339  * release_client() api, to ensure that the in-use marker is cleared properly.
 340  *
 341  * Returns:
 342  *    The Zebra API client.
 343  */
 344 extern struct zserv *zserv_acquire_client(uint8_t proto,
 345                                           unsigned short instance,
 346                                           uint32_t session_id);
 347
 348 /*
 349  * Release a client object that was acquired with the acquire_client() api.
 350  * After this has been called, the pointer must not be used - it may be freed
 351  * in another pthread if the client has closed.
 352  */
 353 extern void zserv_release_client(struct zserv *client);
 354
 355 /*
 356  * Close a client.
 357  *
 358  * Kills a client's thread, removes the client from the client list and cleans
 359  * up its resources.
 360  *
 361  * client
 362  *    the client to close
 363  */
 364 extern void zserv_close_client(struct zserv *client);
 365
 366 /*
 367  * Log a ZAPI message hexdump.
 368  *
 369  * errmsg
 370  *    Error message to include with packet hexdump
 371  *
 372  * msg
 373  *    Message to log
 374  *
 375  * hdr
 376  *    Message header
 377  */
 378 void zserv_log_message(const char *errmsg, struct stream *msg,
 379                        struct zmsghdr *hdr);
 380
 381 /* TODO */
 382 __attribute__((__noreturn__)) void zebra_finalize(struct thread *event);
 383
 384 /*
 385  * Graceful restart functions.
 386  */
 387 extern int zebra_gr_client_disconnect(struct zserv *client);
 388 extern void zebra_gr_client_reconnect(struct zserv *client);
 389 extern void zebra_gr_stale_client_cleanup(struct list *client_list);
 390 extern void zread_client_capabilities(struct zserv *client, struct zmsghdr *hdr,
 391                                       struct stream *msg,
 392                                       struct zebra_vrf *zvrf);
 393
 394 #ifdef __cplusplus
 395 }
 396 #endif
 397
 398 #endif /* _ZEBRA_ZEBRA_H */