]>
Commit | Line | Data |
---|---|---|
4f04a76b DL |
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 | * | |
896014f4 DL |
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 | |
4f04a76b DL |
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" | |
30771d65 | 29 | #include "module.h" |
a5b38c5b | 30 | #include "hook.h" |
1c2facd1 | 31 | #include "northbound.h" |
4f04a76b | 32 | |
5e244469 RW |
33 | #ifdef __cplusplus |
34 | extern "C" { | |
35 | #endif | |
36 | ||
0a7c7856 DL |
37 | /* The following options disable specific command line options that |
38 | * are not applicable for a particular daemon. | |
39 | */ | |
4f04a76b DL |
40 | #define FRR_NO_PRIVSEP (1 << 0) |
41 | #define FRR_NO_TCPVTY (1 << 1) | |
857b5446 | 42 | #define FRR_LIMITED_CLI (1 << 2) |
0a7c7856 | 43 | #define FRR_NO_CFG_PID_DRY (1 << 3) |
eb05883f | 44 | #define FRR_NO_ZCLIENT (1 << 4) |
0a7c7856 DL |
45 | /* If FRR_DETACH_LATER is used, the daemon will keep its parent running |
46 | * until frr_detach() is called. Normally "somedaemon -d" returns once the | |
47 | * main event loop is reached in the daemon; use this for extra startup bits. | |
48 | * | |
49 | * Does nothing if -d isn't used. | |
50 | */ | |
51 | #define FRR_DETACH_LATER (1 << 5) | |
4f04a76b | 52 | |
1c2facd1 RW |
53 | enum frr_cli_mode { |
54 | FRR_CLI_CLASSIC = 0, | |
55 | FRR_CLI_TRANSACTIONAL, | |
56 | }; | |
57 | ||
4f04a76b DL |
58 | struct frr_daemon_info { |
59 | unsigned flags; | |
60 | ||
61 | const char *progname; | |
eb05883f | 62 | const char *name; |
bf1013e6 | 63 | const char *logname; |
4f04a76b | 64 | unsigned short instance; |
30771d65 | 65 | struct frrmod_runtime *module; |
4f04a76b DL |
66 | |
67 | char *vty_addr; | |
68 | int vty_port; | |
69 | char *vty_sock_path; | |
eb05883f DL |
70 | bool dryrun; |
71 | bool daemon_mode; | |
cff2b211 | 72 | bool terminal; |
1c2facd1 | 73 | enum frr_cli_mode cli_mode; |
9e224e60 DS |
74 | |
75 | struct thread *read_in; | |
eb05883f | 76 | const char *config_file; |
573de11f | 77 | const char *backup_config_file; |
eb05883f | 78 | const char *pid_file; |
1c2facd1 RW |
79 | #ifdef HAVE_SQLITE3 |
80 | const char *db_file; | |
81 | #endif | |
eb05883f | 82 | const char *vty_path; |
80b4df3b | 83 | const char *module_path; |
43e587c1 | 84 | |
d1b4fc1f | 85 | const char *pathspace; |
43e587c1 DS |
86 | bool zpathspace; |
87 | ||
f8507817 | 88 | const char *early_logging; |
e9b4e74a | 89 | const char *early_loglevel; |
4f04a76b DL |
90 | |
91 | const char *proghelp; | |
92 | void (*printhelp)(FILE *target); | |
93 | const char *copyright; | |
16077f2f | 94 | char startinfo[128]; |
4f04a76b DL |
95 | |
96 | struct quagga_signal_t *signals; | |
97 | size_t n_signals; | |
98 | ||
99 | struct zebra_privs_t *privs; | |
1c2facd1 | 100 | |
0d8c7a26 | 101 | const struct frr_yang_module_info *const *yang_modules; |
1c2facd1 | 102 | size_t n_yang_modules; |
2950f5da DS |
103 | |
104 | bool log_always; | |
4f04a76b DL |
105 | }; |
106 | ||
107 | /* execname is the daemon's executable (and pidfile and configfile) name, | |
108 | * i.e. "zebra" or "bgpd" | |
109 | * constname is the daemons source-level name, primarily for the logging ID, | |
110 | * i.e. "ZEBRA" or "BGP" | |
111 | * | |
112 | * note that this macro is also a latch-on point for other changes (e.g. | |
30771d65 | 113 | * upcoming module support) that need to place some per-daemon things. Each |
4f04a76b DL |
114 | * daemon should have one of these. |
115 | */ | |
d62a17ae | 116 | #define FRR_DAEMON_INFO(execname, constname, ...) \ |
117 | static struct frr_daemon_info execname##_di = {.name = #execname, \ | |
118 | .logname = #constname, \ | |
119 | .module = THIS_MODULE, \ | |
120 | __VA_ARGS__}; \ | |
121 | FRR_COREMOD_SETUP(.name = #execname, \ | |
122 | .description = #execname " daemon", \ | |
123 | .version = FRR_VERSION, ) \ | |
124 | /* end */ | |
125 | ||
43e587c1 | 126 | extern void frr_init_vtydir(void); |
d62a17ae | 127 | extern void frr_preinit(struct frr_daemon_info *daemon, int argc, char **argv); |
128 | extern void frr_opt_add(const char *optstr, const struct option *longopts, | |
129 | const char *helpstr); | |
130 | extern int frr_getopt(int argc, char *const argv[], int *longindex); | |
4f04a76b DL |
131 | extern void frr_help_exit(int status); |
132 | ||
133 | extern struct thread_master *frr_init(void); | |
1c2facd1 RW |
134 | extern const char *frr_get_progname(void); |
135 | extern enum frr_cli_mode frr_get_cli_mode(void); | |
4f04a76b | 136 | |
d62a17ae | 137 | DECLARE_HOOK(frr_late_init, (struct thread_master * tm), (tm)) |
eb05883f DL |
138 | extern void frr_config_fork(void); |
139 | ||
16077f2f | 140 | extern void frr_run(struct thread_master *master); |
0a7c7856 | 141 | extern void frr_detach(void); |
16077f2f | 142 | |
689f5a8c DL |
143 | extern bool frr_zclient_addr(struct sockaddr_storage *sa, socklen_t *sa_len, |
144 | const char *path); | |
145 | ||
03951374 DL |
146 | /* these two are before the protocol daemon does its own shutdown |
147 | * it's named this way being the counterpart to frr_late_init */ | |
148 | DECLARE_KOOH(frr_early_fini, (), ()) | |
149 | extern void frr_early_fini(void); | |
150 | /* and these two are after the daemon did its own cleanup */ | |
151 | DECLARE_KOOH(frr_fini, (), ()) | |
152 | extern void frr_fini(void); | |
153 | ||
ff44f570 | 154 | extern char config_default[512]; |
689f5a8c | 155 | extern char frr_zclientpath[256]; |
eb05883f | 156 | extern const char frr_sysconfdir[]; |
43e587c1 | 157 | extern char frr_vtydir[256]; |
80b4df3b | 158 | extern const char frr_moduledir[]; |
4f04a76b | 159 | |
b85120bc DL |
160 | extern char frr_protoname[]; |
161 | extern char frr_protonameinst[]; | |
162 | ||
9eed278b DL |
163 | extern bool debug_memstats_at_exit; |
164 | ||
5e244469 RW |
165 | #ifdef __cplusplus |
166 | } | |
167 | #endif | |
168 | ||
4f04a76b | 169 | #endif /* _ZEBRA_FRR_H */ |