lib/libfrr.h

   1 /*
   2  * libfrr overall management functions
   3  *
   4  * Copyright (C) 2016  David Lamparter for NetDEF, Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; either version 2 of the License, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _ZEBRA_FRR_H
  22 #define _ZEBRA_FRR_H
  23
  24 #include "sigevent.h"
  25 #include "privs.h"
  26 #include "thread.h"
  27 #include "log.h"
  28 #include "getopt.h"
  29 #include "module.h"
  30 #include "hook.h"
  31 #include "northbound.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /* The following options disable specific command line options that
  38  * are not applicable for a particular daemon.
  39  */
  40 #define FRR_NO_PRIVSEP          (1 << 0)
  41 #define FRR_NO_TCPVTY           (1 << 1)
  42 #define FRR_LIMITED_CLI         (1 << 2)
  43 #define FRR_NO_SPLIT_CONFIG     (1 << 3)
  44 #define FRR_NO_PID              (1 << 4)
  45 #define FRR_NO_CFG_PID_DRY      (FRR_NO_PID | FRR_NO_SPLIT_CONFIG)
  46 #define FRR_NO_ZCLIENT          (1 << 5)
  47 /* If FRR_DETACH_LATER is used, the daemon will keep its parent running
  48  * until frr_detach() is called.  Normally "somedaemon -d" returns once the
  49  * main event loop is reached in the daemon;  use this for extra startup bits.
  50  *
  51  * Does nothing if -d isn't used.
  52  */
  53 #define FRR_DETACH_LATER        (1 << 6)
  54
  55 enum frr_cli_mode {
  56         FRR_CLI_CLASSIC = 0,
  57         FRR_CLI_TRANSACTIONAL,
  58 };
  59
  60 struct frr_daemon_info {
  61         unsigned flags;
  62
  63         const char *progname;
  64         const char *name;
  65         const char *logname;
  66         unsigned short instance;
  67         struct frrmod_runtime *module;
  68
  69         char *vty_addr;
  70         int vty_port;
  71         char *vty_sock_path;
  72         bool dryrun;
  73         bool daemon_mode;
  74         bool terminal;
  75         enum frr_cli_mode cli_mode;
  76
  77         struct thread *read_in;
  78         const char *config_file;
  79         const char *backup_config_file;
  80         const char *pid_file;
  81 #ifdef HAVE_SQLITE3
  82         const char *db_file;
  83 #endif
  84         const char *vty_path;
  85         const char *module_path;
  86         const char *script_path;
  87
  88         const char *pathspace;
  89         bool zpathspace;
  90
  91         const char *early_logging;
  92         const char *early_loglevel;
  93
  94         const char *proghelp;
  95         void (*printhelp)(FILE *target);
  96         const char *copyright;
  97         char startinfo[128];
  98
  99         struct frr_signal_t *signals;
 100         size_t n_signals;
 101
 102         struct zebra_privs_t *privs;
 103
 104         const struct frr_yang_module_info *const *yang_modules;
 105         size_t n_yang_modules;
 106
 107         bool log_always;
 108
 109         /* Optional upper limit on the number of fds used in select/poll */
 110         uint32_t limit_fds;
 111 };
 112
 113 /* execname is the daemon's executable (and pidfile and configfile) name,
 114  * i.e. "zebra" or "bgpd"
 115  * constname is the daemons source-level name, primarily for the logging ID,
 116  * i.e. "ZEBRA" or "BGP"
 117  *
 118  * note that this macro is also a latch-on point for other changes (e.g.
 119  * upcoming module support) that need to place some per-daemon things.  Each
 120  * daemon should have one of these.
 121  */
 122 #define FRR_DAEMON_INFO(execname, constname, ...)                              \
 123         static struct frr_daemon_info execname##_di = {.name = #execname,      \
 124                                                        .logname = #constname,  \
 125                                                        .module = THIS_MODULE,  \
 126                                                        __VA_ARGS__};           \
 127         FRR_COREMOD_SETUP(.name = #execname,                                   \
 128                           .description = #execname " daemon",                  \
 129                           .version = FRR_VERSION, );                           \
 130         MACRO_REQUIRE_SEMICOLON() /* end */
 131
 132 extern void frr_init_vtydir(void);
 133 extern void frr_preinit(struct frr_daemon_info *daemon, int argc, char **argv);
 134 extern void frr_opt_add(const char *optstr, const struct option *longopts,
 135                         const char *helpstr);
 136 extern int frr_getopt(int argc, char *const argv[], int *longindex);
 137
 138 extern __attribute__((__noreturn__)) void frr_help_exit(int status);
 139
 140 extern struct thread_master *frr_init(void);
 141 extern const char *frr_get_progname(void);
 142 extern enum frr_cli_mode frr_get_cli_mode(void);
 143 extern uint32_t frr_get_fd_limit(void);
 144 extern bool frr_is_startup_fd(int fd);
 145
 146 /* call order of these hooks is as ordered here */
 147 DECLARE_HOOK(frr_late_init, (struct thread_master * tm), (tm));
 148 /* fork() happens between late_init and config_pre */
 149 DECLARE_HOOK(frr_config_pre, (struct thread_master * tm), (tm));
 150 DECLARE_HOOK(frr_config_post, (struct thread_master * tm), (tm));
 151
 152 extern void frr_config_fork(void);
 153
 154 extern void frr_run(struct thread_master *master);
 155 extern void frr_detach(void);
 156
 157 extern bool frr_zclient_addr(struct sockaddr_storage *sa, socklen_t *sa_len,
 158                              const char *path);
 159
 160 /* these two are before the protocol daemon does its own shutdown
 161  * it's named this way being the counterpart to frr_late_init */
 162 DECLARE_KOOH(frr_early_fini, (), ());
 163 extern void frr_early_fini(void);
 164 /* and these two are after the daemon did its own cleanup */
 165 DECLARE_KOOH(frr_fini, (), ());
 166 extern void frr_fini(void);
 167
 168 extern char config_default[512];
 169 extern char frr_zclientpath[256];
 170 extern const char frr_sysconfdir[];
 171 extern char frr_vtydir[256];
 172 extern const char frr_moduledir[];
 173 extern const char frr_scriptdir[];
 174
 175 extern char frr_protoname[];
 176 extern char frr_protonameinst[];
 177 /* always set in the spot where we *would* fork even if we don't do so */
 178 extern bool frr_is_after_fork;
 179
 180 extern bool debug_memstats_at_exit;
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185
 186 #endif /* _ZEBRA_FRR_H */