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
  40 #include "zebra/zebra_vrf.h"  /* for zebra_vrf */
  41 /* clang-format on */
  42
  43 /* Default port information. */
  44 #define ZEBRA_VTY_PORT                2601
  45
  46 /* Default configuration filename. */
  47 #define DEFAULT_CONFIG_FILE "zebra.conf"
  48
  49 #define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
  50
  51 /* Client structure. */
  52 struct zserv {
  53         /* Client pthread */
  54         struct frr_pthread *pthread;
  55
  56         /* Client file descriptor. */
  57         int sock;
  58
  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;
  64
  65         /* Private I/O buffers */
  66         struct stream *ibuf_work;
  67         struct stream *obuf_work;
  68
  69         /* Buffer of data waiting to be written to client. */
  70         struct buffer *wb;
  71
  72         /* Threads for read/write. */
  73         struct thread *t_read;
  74         struct thread *t_write;
  75
  76         /* Event for message processing, for the main pthread */
  77         struct thread *t_process;
  78
  79         /* Threads for the main pthread */
  80         struct thread *t_cleanup;
  81
  82         /* default routing table this client munges */
  83         int rtm_table;
  84
  85         /* This client's redistribute flag. */
  86         struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
  87         vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
  88
  89         /* Redistribute default route flag. */
  90         vrf_bitmap_t redist_default;
  91
  92         /* Interface information. */
  93         vrf_bitmap_t ifinfo;
  94
  95         /* Router-id information. */
  96         vrf_bitmap_t ridinfo;
  97
  98         bool notify_owner;
  99
 100         /* client's protocol */
 101         uint8_t proto;
 102         uint16_t instance;
 103         uint8_t is_synchronous;
 104
 105         /* Statistics */
 106         uint32_t redist_v4_add_cnt;
 107         uint32_t redist_v4_del_cnt;
 108         uint32_t redist_v6_add_cnt;
 109         uint32_t redist_v6_del_cnt;
 110         uint32_t v4_route_add_cnt;
 111         uint32_t v4_route_upd8_cnt;
 112         uint32_t v4_route_del_cnt;
 113         uint32_t v6_route_add_cnt;
 114         uint32_t v6_route_del_cnt;
 115         uint32_t v6_route_upd8_cnt;
 116         uint32_t connected_rt_add_cnt;
 117         uint32_t connected_rt_del_cnt;
 118         uint32_t ifup_cnt;
 119         uint32_t ifdown_cnt;
 120         uint32_t ifadd_cnt;
 121         uint32_t ifdel_cnt;
 122         uint32_t if_bfd_cnt;
 123         uint32_t bfd_peer_add_cnt;
 124         uint32_t bfd_peer_upd8_cnt;
 125         uint32_t bfd_peer_del_cnt;
 126         uint32_t bfd_peer_replay_cnt;
 127         uint32_t vrfadd_cnt;
 128         uint32_t vrfdel_cnt;
 129         uint32_t if_vrfchg_cnt;
 130         uint32_t bfd_client_reg_cnt;
 131         uint32_t vniadd_cnt;
 132         uint32_t vnidel_cnt;
 133         uint32_t l3vniadd_cnt;
 134         uint32_t l3vnidel_cnt;
 135         uint32_t macipadd_cnt;
 136         uint32_t macipdel_cnt;
 137         uint32_t prefixadd_cnt;
 138         uint32_t prefixdel_cnt;
 139         uint32_t v4_nh_watch_add_cnt;
 140         uint32_t v4_nh_watch_rem_cnt;
 141         uint32_t v6_nh_watch_add_cnt;
 142         uint32_t v6_nh_watch_rem_cnt;
 143
 144         time_t nh_reg_time;
 145         time_t nh_dereg_time;
 146         time_t nh_last_upd_time;
 147
 148         /*
 149          * Session information.
 150          *
 151          * These are not synchronous with respect to each other. For instance,
 152          * last_read_cmd may contain a value that has been read in the future
 153          * relative to last_read_time.
 154          */
 155
 156         /* monotime of client creation */
 157         _Atomic uint32_t connect_time;
 158         /* monotime of last message received */
 159         _Atomic uint32_t last_read_time;
 160         /* monotime of last message sent */
 161         _Atomic uint32_t last_write_time;
 162         /* command code of last message read */
 163         _Atomic uint32_t last_read_cmd;
 164         /* command code of last message written */
 165         _Atomic uint32_t last_write_cmd;
 166 };
 167
 168 #define ZAPI_HANDLER_ARGS                                                      \
 169         struct zserv *client, struct zmsghdr *hdr, struct stream *msg,         \
 170                 struct zebra_vrf *zvrf
 171
 172 /* Hooks for client connect / disconnect */
 173 DECLARE_HOOK(zserv_client_connect, (struct zserv *client), (client));
 174 DECLARE_KOOH(zserv_client_close, (struct zserv *client), (client));
 175
 176 /* Zebra instance */
 177 struct zebra_t {
 178         /* Thread master */
 179         struct thread_master *master;
 180         struct list *client_list;
 181
 182         /* Socket */
 183         int sock;
 184
 185         /* default table */
 186         uint32_t rtm_table_default;
 187
 188 /* rib work queue */
 189 #define ZEBRA_RIB_PROCESS_HOLD_TIME 10
 190 #define ZEBRA_RIB_PROCESS_RETRY_TIME 5
 191         struct work_queue *ribq;
 192         struct meta_queue *mq;
 193
 194         /* LSP work queue */
 195         struct work_queue *lsp_process_q;
 196
 197 #define ZEBRA_ZAPI_PACKETS_TO_PROCESS 1000
 198         _Atomic uint32_t packets_to_process;
 199 };
 200 extern struct zebra_t zebrad;
 201 extern unsigned int multipath_num;
 202
 203 /*
 204  * Initialize Zebra API server.
 205  *
 206  * Installs CLI commands and creates the client list.
 207  */
 208 extern void zserv_init(void);
 209
 210 /*
 211  * Start Zebra API server.
 212  *
 213  * Allocates resources, creates the server socket and begins listening on the
 214  * socket.
 215  *
 216  * path
 217  *    where to place the Unix domain socket
 218  */
 219 extern void zserv_start(char *path);
 220
 221 /*
 222  * Send a message to a connected Zebra API client.
 223  *
 224  * client
 225  *    the client to send to
 226  *
 227  * msg
 228  *    the message to send
 229  */
 230 extern int zserv_send_message(struct zserv *client, struct stream *msg);
 231
 232 /*
 233  * Retrieve a client by its protocol and instance number.
 234  *
 235  * proto
 236  *    protocol number
 237  *
 238  * instance
 239  *    instance number
 240  *
 241  * Returns:
 242  *    The Zebra API client.
 243  */
 244 extern struct zserv *zserv_find_client(uint8_t proto, unsigned short instance);
 245
 246
 247 /*
 248  * Close a client.
 249  *
 250  * Kills a client's thread, removes the client from the client list and cleans
 251  * up its resources.
 252  *
 253  * client
 254  *    the client to close
 255  */
 256 extern void zserv_close_client(struct zserv *client);
 257
 258 #if defined(HANDLE_ZAPI_FUZZING)
 259 extern void zserv_read_file(char *input);
 260 #endif
 261
 262 /* TODO */
 263 int zebra_finalize(struct thread *event);
 264
 265 #endif /* _ZEBRA_ZEBRA_H */