]>
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 | #include <zebra.h> | |
689f5a8c | 22 | #include <sys/un.h> |
4f04a76b | 23 | |
f43fbf83 DL |
24 | #include <sys/types.h> |
25 | #include <sys/wait.h> | |
26 | ||
4f04a76b DL |
27 | #include "libfrr.h" |
28 | #include "getopt.h" | |
beaa5470 | 29 | #include "privs.h" |
4f04a76b DL |
30 | #include "vty.h" |
31 | #include "command.h" | |
32 | #include "version.h" | |
857b5446 | 33 | #include "memory_vty.h" |
eb05883f | 34 | #include "zclient.h" |
cf7466ac | 35 | #include "log_int.h" |
30771d65 | 36 | #include "module.h" |
f43fbf83 | 37 | #include "network.h" |
b66d022e | 38 | #include "lib_errors.h" |
eb05883f | 39 | |
d62a17ae | 40 | DEFINE_HOOK(frr_late_init, (struct thread_master * tm), (tm)) |
03951374 DL |
41 | DEFINE_KOOH(frr_early_fini, (), ()) |
42 | DEFINE_KOOH(frr_fini, (), ()) | |
a5b38c5b | 43 | |
eb05883f DL |
44 | const char frr_sysconfdir[] = SYSCONFDIR; |
45 | const char frr_vtydir[] = DAEMON_VTY_DIR; | |
80b4df3b | 46 | const char frr_moduledir[] = MODULE_PATH; |
eb05883f | 47 | |
4f138a3e DL |
48 | char frr_protoname[256] = "NONE"; |
49 | char frr_protonameinst[256] = "NONE"; | |
b85120bc | 50 | |
ff44f570 | 51 | char config_default[512]; |
689f5a8c | 52 | char frr_zclientpath[256]; |
ff44f570 | 53 | static char pidfile_default[512]; |
eb05883f | 54 | static char vtypath_default[256]; |
4f04a76b | 55 | |
9eed278b DL |
56 | bool debug_memstats_at_exit = 0; |
57 | ||
4f04a76b DL |
58 | static char comb_optstr[256]; |
59 | static struct option comb_lo[64]; | |
60 | static struct option *comb_next_lo = &comb_lo[0]; | |
61 | static char comb_helpstr[4096]; | |
62 | ||
63 | struct optspec { | |
64 | const char *optstr; | |
65 | const char *helpstr; | |
66 | const struct option *longopts; | |
67 | }; | |
68 | ||
69 | static void opt_extend(const struct optspec *os) | |
70 | { | |
71 | const struct option *lo; | |
72 | ||
73 | strcat(comb_optstr, os->optstr); | |
74 | strcat(comb_helpstr, os->helpstr); | |
75 | for (lo = os->longopts; lo->name; lo++) | |
76 | memcpy(comb_next_lo++, lo, sizeof(*lo)); | |
77 | } | |
78 | ||
79 | ||
80b4df3b MW |
80 | #define OPTION_VTYSOCK 1000 |
81 | #define OPTION_MODULEDIR 1002 | |
e9b4e74a DS |
82 | #define OPTION_LOG 1003 |
83 | #define OPTION_LOGLEVEL 1004 | |
4f04a76b DL |
84 | |
85 | static const struct option lo_always[] = { | |
d62a17ae | 86 | {"help", no_argument, NULL, 'h'}, |
87 | {"version", no_argument, NULL, 'v'}, | |
88 | {"daemon", no_argument, NULL, 'd'}, | |
89 | {"module", no_argument, NULL, 'M'}, | |
90 | {"vty_socket", required_argument, NULL, OPTION_VTYSOCK}, | |
91 | {"moduledir", required_argument, NULL, OPTION_MODULEDIR}, | |
f8507817 | 92 | {"log", required_argument, NULL, OPTION_LOG}, |
e9b4e74a | 93 | {"log-level", required_argument, NULL, OPTION_LOGLEVEL}, |
d62a17ae | 94 | {NULL}}; |
4f04a76b | 95 | static const struct optspec os_always = { |
30771d65 | 96 | "hvdM:", |
4f04a76b DL |
97 | " -h, --help Display this help and exit\n" |
98 | " -v, --version Print program version\n" | |
eb05883f | 99 | " -d, --daemon Runs in daemon mode\n" |
30771d65 | 100 | " -M, --module Load specified module\n" |
80b4df3b | 101 | " --vty_socket Override vty socket path\n" |
f8507817 | 102 | " --moduledir Override modules directory\n" |
e9b4e74a DS |
103 | " --log Set Logging to stdout, syslog, or file:<name>\n" |
104 | " --log-level Set Logging Level to use, debug, info, warn, etc\n", | |
d62a17ae | 105 | lo_always}; |
4f04a76b DL |
106 | |
107 | ||
eb05883f | 108 | static const struct option lo_cfg_pid_dry[] = { |
d62a17ae | 109 | {"pid_file", required_argument, NULL, 'i'}, |
110 | {"config_file", required_argument, NULL, 'f'}, | |
d1b4fc1f | 111 | {"pathspace", required_argument, NULL, 'N'}, |
d62a17ae | 112 | {"dryrun", no_argument, NULL, 'C'}, |
cff2b211 | 113 | {"terminal", no_argument, NULL, 't'}, |
d62a17ae | 114 | {NULL}}; |
eb05883f | 115 | static const struct optspec os_cfg_pid_dry = { |
d1b4fc1f | 116 | "f:i:CtN:", |
eb05883f DL |
117 | " -f, --config_file Set configuration file name\n" |
118 | " -i, --pid_file Set process identifier file name\n" | |
d1b4fc1f | 119 | " -N, --pathspace Insert prefix into config & socket paths\n" |
cff2b211 DL |
120 | " -C, --dryrun Check configuration for validity and exit\n" |
121 | " -t, --terminal Open terminal session on stdio\n" | |
122 | " -d -t Daemonize after terminal session ends\n", | |
d62a17ae | 123 | lo_cfg_pid_dry}; |
eb05883f DL |
124 | |
125 | ||
126 | static const struct option lo_zclient[] = { | |
d62a17ae | 127 | {"socket", required_argument, NULL, 'z'}, |
128 | {NULL}}; | |
eb05883f | 129 | static const struct optspec os_zclient = { |
d62a17ae | 130 | "z:", " -z, --socket Set path of zebra socket\n", lo_zclient}; |
eb05883f DL |
131 | |
132 | ||
4f04a76b | 133 | static const struct option lo_vty[] = { |
d62a17ae | 134 | {"vty_addr", required_argument, NULL, 'A'}, |
135 | {"vty_port", required_argument, NULL, 'P'}, | |
136 | {NULL}}; | |
4f04a76b DL |
137 | static const struct optspec os_vty = { |
138 | "A:P:", | |
139 | " -A, --vty_addr Set vty's bind address\n" | |
140 | " -P, --vty_port Set vty's port number\n", | |
d62a17ae | 141 | lo_vty}; |
4f04a76b DL |
142 | |
143 | ||
d62a17ae | 144 | static const struct option lo_user[] = {{"user", required_argument, NULL, 'u'}, |
145 | {"group", required_argument, NULL, 'g'}, | |
146 | {NULL}}; | |
147 | static const struct optspec os_user = {"u:g:", | |
148 | " -u, --user User to run as\n" | |
149 | " -g, --group Group to run as\n", | |
150 | lo_user}; | |
4f04a76b DL |
151 | |
152 | ||
689f5a8c DL |
153 | bool frr_zclient_addr(struct sockaddr_storage *sa, socklen_t *sa_len, |
154 | const char *path) | |
155 | { | |
156 | memset(sa, 0, sizeof(*sa)); | |
157 | ||
158 | if (!path) | |
159 | path = ZEBRA_SERV_PATH; | |
160 | ||
161 | if (!strncmp(path, ZAPI_TCP_PATHNAME, strlen(ZAPI_TCP_PATHNAME))) { | |
5d13cd09 | 162 | /* note: this functionality is disabled at bottom */ |
689f5a8c DL |
163 | int af; |
164 | int port = ZEBRA_PORT; | |
165 | char *err = NULL; | |
166 | struct sockaddr_in *sin = NULL; | |
167 | struct sockaddr_in6 *sin6 = NULL; | |
168 | ||
169 | path += strlen(ZAPI_TCP_PATHNAME); | |
170 | ||
171 | switch (path[0]) { | |
172 | case '4': | |
173 | path++; | |
174 | af = AF_INET; | |
175 | break; | |
176 | case '6': | |
177 | path++; | |
996c9314 | 178 | /* fallthrough */ |
689f5a8c DL |
179 | default: |
180 | af = AF_INET6; | |
181 | break; | |
182 | } | |
183 | ||
184 | switch (path[0]) { | |
185 | case '\0': | |
186 | break; | |
187 | case ':': | |
188 | path++; | |
189 | port = strtoul(path, &err, 10); | |
190 | if (*err || !*path) | |
191 | return false; | |
192 | break; | |
193 | default: | |
194 | return false; | |
195 | } | |
196 | ||
197 | sa->ss_family = af; | |
198 | switch (af) { | |
199 | case AF_INET: | |
200 | sin = (struct sockaddr_in *)sa; | |
201 | sin->sin_port = htons(port); | |
202 | sin->sin_addr.s_addr = htonl(INADDR_LOOPBACK); | |
203 | *sa_len = sizeof(struct sockaddr_in); | |
204 | #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN | |
205 | sin->sin_len = *sa_len; | |
206 | #endif | |
207 | break; | |
208 | case AF_INET6: | |
209 | sin6 = (struct sockaddr_in6 *)sa; | |
210 | sin6->sin6_port = htons(port); | |
211 | inet_pton(AF_INET6, "::1", &sin6->sin6_addr); | |
212 | *sa_len = sizeof(struct sockaddr_in6); | |
213 | #ifdef SIN6_LEN | |
214 | sin6->sin6_len = *sa_len; | |
215 | #endif | |
216 | break; | |
217 | } | |
5d13cd09 DL |
218 | |
219 | #if 1 | |
220 | /* force-disable this path, because tcp-zebra is a | |
221 | * SECURITY ISSUE. there are no checks at all against | |
222 | * untrusted users on the local system connecting on TCP | |
223 | * and injecting bogus routing data into the entire routing | |
224 | * domain. | |
225 | * | |
226 | * The functionality is only left here because it may be | |
227 | * useful during development, in order to be able to get | |
228 | * tcpdump or wireshark watching ZAPI as TCP. If you want | |
229 | * to do that, flip the #if 1 above to #if 0. */ | |
230 | memset(sa, 0, sizeof(*sa)); | |
231 | return false; | |
232 | #endif | |
689f5a8c DL |
233 | } else { |
234 | /* "sun" is a #define on solaris */ | |
235 | struct sockaddr_un *suna = (struct sockaddr_un *)sa; | |
236 | ||
237 | suna->sun_family = AF_UNIX; | |
238 | strlcpy(suna->sun_path, path, sizeof(suna->sun_path)); | |
239 | #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN | |
240 | *sa_len = suna->sun_len = SUN_LEN(suna); | |
241 | #else | |
242 | *sa_len = sizeof(suna->sun_family) + strlen(suna->sun_path); | |
243 | #endif /* HAVE_STRUCT_SOCKADDR_UN_SUN_LEN */ | |
244 | #if 0 | |
245 | /* this is left here for future reference; Linux abstract | |
246 | * socket namespace support can be enabled by replacing | |
247 | * above #if 0 with #ifdef GNU_LINUX. | |
248 | * | |
249 | * THIS IS A SECURITY ISSUE, the abstract socket namespace | |
250 | * does not have user/group permission control on sockets. | |
251 | * we'd need to implement SCM_CREDENTIALS support first to | |
252 | * check that only proper users can connect to abstract | |
253 | * sockets. (same problem as tcp-zebra, except there is a | |
254 | * fix with SCM_CREDENTIALS. tcp-zebra has no such fix.) | |
255 | */ | |
256 | if (suna->sun_path[0] == '@') | |
257 | suna->sun_path[0] = '\0'; | |
258 | #endif | |
259 | } | |
260 | return true; | |
261 | } | |
262 | ||
4f04a76b DL |
263 | static struct frr_daemon_info *di = NULL; |
264 | ||
265 | void frr_preinit(struct frr_daemon_info *daemon, int argc, char **argv) | |
266 | { | |
267 | di = daemon; | |
268 | ||
269 | /* basename(), opencoded. */ | |
270 | char *p = strrchr(argv[0], '/'); | |
271 | di->progname = p ? p + 1 : argv[0]; | |
272 | ||
273 | umask(0027); | |
274 | ||
275 | opt_extend(&os_always); | |
eb05883f DL |
276 | if (!(di->flags & FRR_NO_CFG_PID_DRY)) |
277 | opt_extend(&os_cfg_pid_dry); | |
4f04a76b DL |
278 | if (!(di->flags & FRR_NO_PRIVSEP)) |
279 | opt_extend(&os_user); | |
eb05883f DL |
280 | if (!(di->flags & FRR_NO_ZCLIENT)) |
281 | opt_extend(&os_zclient); | |
4f04a76b DL |
282 | if (!(di->flags & FRR_NO_TCPVTY)) |
283 | opt_extend(&os_vty); | |
eb05883f DL |
284 | |
285 | snprintf(config_default, sizeof(config_default), "%s/%s.conf", | |
d62a17ae | 286 | frr_sysconfdir, di->name); |
eb05883f | 287 | snprintf(pidfile_default, sizeof(pidfile_default), "%s/%s.pid", |
d62a17ae | 288 | frr_vtydir, di->name); |
b85120bc DL |
289 | |
290 | strlcpy(frr_protoname, di->logname, sizeof(frr_protoname)); | |
291 | strlcpy(frr_protonameinst, di->logname, sizeof(frr_protonameinst)); | |
689f5a8c DL |
292 | |
293 | strlcpy(frr_zclientpath, ZEBRA_SERV_PATH, sizeof(frr_zclientpath)); | |
4f04a76b DL |
294 | } |
295 | ||
296 | void frr_opt_add(const char *optstr, const struct option *longopts, | |
d62a17ae | 297 | const char *helpstr) |
4f04a76b | 298 | { |
d62a17ae | 299 | const struct optspec main_opts = {optstr, helpstr, longopts}; |
4f04a76b DL |
300 | opt_extend(&main_opts); |
301 | } | |
302 | ||
303 | void frr_help_exit(int status) | |
304 | { | |
305 | FILE *target = status ? stderr : stdout; | |
306 | ||
307 | if (status != 0) | |
308 | fprintf(stderr, "Invalid options.\n\n"); | |
309 | ||
310 | if (di->printhelp) | |
311 | di->printhelp(target); | |
312 | else | |
313 | fprintf(target, "Usage: %s [OPTION...]\n\n%s%s%s\n\n%s", | |
d62a17ae | 314 | di->progname, di->proghelp, di->copyright ? "\n\n" : "", |
315 | di->copyright ? di->copyright : "", comb_helpstr); | |
4f04a76b DL |
316 | fprintf(target, "\nReport bugs to %s\n", FRR_BUG_ADDRESS); |
317 | exit(status); | |
318 | } | |
319 | ||
30771d65 DL |
320 | struct option_chain { |
321 | struct option_chain *next; | |
322 | const char *arg; | |
323 | }; | |
80b4df3b | 324 | |
30771d65 | 325 | static struct option_chain *modules = NULL, **modnext = &modules; |
4f04a76b DL |
326 | static int errors = 0; |
327 | ||
328 | static int frr_opt(int opt) | |
329 | { | |
330 | static int vty_port_set = 0; | |
331 | static int vty_addr_set = 0; | |
30771d65 | 332 | struct option_chain *oc; |
4f04a76b DL |
333 | char *err; |
334 | ||
335 | switch (opt) { | |
336 | case 'h': | |
337 | frr_help_exit(0); | |
338 | break; | |
339 | case 'v': | |
340 | print_version(di->progname); | |
341 | exit(0); | |
342 | break; | |
eb05883f DL |
343 | case 'd': |
344 | di->daemon_mode = 1; | |
345 | break; | |
30771d65 DL |
346 | case 'M': |
347 | oc = XMALLOC(MTYPE_TMP, sizeof(*oc)); | |
348 | oc->arg = optarg; | |
349 | oc->next = NULL; | |
350 | *modnext = oc; | |
351 | modnext = &oc->next; | |
352 | break; | |
eb05883f DL |
353 | case 'i': |
354 | if (di->flags & FRR_NO_CFG_PID_DRY) | |
355 | return 1; | |
356 | di->pid_file = optarg; | |
357 | break; | |
358 | case 'f': | |
359 | if (di->flags & FRR_NO_CFG_PID_DRY) | |
360 | return 1; | |
361 | di->config_file = optarg; | |
362 | break; | |
d1b4fc1f DL |
363 | case 'N': |
364 | if (di->flags & FRR_NO_CFG_PID_DRY) | |
365 | return 1; | |
366 | if (di->pathspace) { | |
367 | fprintf(stderr, | |
368 | "-N/--pathspace option specified more than once!\n"); | |
369 | errors++; | |
370 | break; | |
371 | } | |
372 | if (strchr(optarg, '/') || strchr(optarg, '.')) { | |
373 | fprintf(stderr, | |
374 | "slashes or dots are not permitted in the --pathspace option.\n"); | |
375 | errors++; | |
376 | break; | |
377 | } | |
378 | di->pathspace = optarg; | |
379 | break; | |
eb05883f DL |
380 | case 'C': |
381 | if (di->flags & FRR_NO_CFG_PID_DRY) | |
382 | return 1; | |
383 | di->dryrun = 1; | |
384 | break; | |
cff2b211 DL |
385 | case 't': |
386 | if (di->flags & FRR_NO_CFG_PID_DRY) | |
387 | return 1; | |
388 | di->terminal = 1; | |
389 | break; | |
eb05883f DL |
390 | case 'z': |
391 | if (di->flags & FRR_NO_ZCLIENT) | |
392 | return 1; | |
689f5a8c | 393 | strlcpy(frr_zclientpath, optarg, sizeof(frr_zclientpath)); |
eb05883f | 394 | break; |
4f04a76b DL |
395 | case 'A': |
396 | if (di->flags & FRR_NO_TCPVTY) | |
397 | return 1; | |
398 | if (vty_addr_set) { | |
d62a17ae | 399 | fprintf(stderr, |
400 | "-A option specified more than once!\n"); | |
4f04a76b DL |
401 | errors++; |
402 | break; | |
403 | } | |
404 | vty_addr_set = 1; | |
405 | di->vty_addr = optarg; | |
406 | break; | |
407 | case 'P': | |
408 | if (di->flags & FRR_NO_TCPVTY) | |
409 | return 1; | |
410 | if (vty_port_set) { | |
d62a17ae | 411 | fprintf(stderr, |
412 | "-P option specified more than once!\n"); | |
4f04a76b DL |
413 | errors++; |
414 | break; | |
415 | } | |
416 | vty_port_set = 1; | |
417 | di->vty_port = strtoul(optarg, &err, 0); | |
418 | if (*err || !*optarg) { | |
d62a17ae | 419 | fprintf(stderr, |
420 | "invalid port number \"%s\" for -P option\n", | |
421 | optarg); | |
4f04a76b DL |
422 | errors++; |
423 | break; | |
424 | } | |
425 | break; | |
426 | case OPTION_VTYSOCK: | |
427 | if (di->vty_sock_path) { | |
d62a17ae | 428 | fprintf(stderr, |
429 | "--vty_socket option specified more than once!\n"); | |
4f04a76b DL |
430 | errors++; |
431 | break; | |
432 | } | |
433 | di->vty_sock_path = optarg; | |
434 | break; | |
80b4df3b MW |
435 | case OPTION_MODULEDIR: |
436 | if (di->module_path) { | |
d62a17ae | 437 | fprintf(stderr, |
438 | "----moduledir option specified more than once!\n"); | |
80b4df3b MW |
439 | errors++; |
440 | break; | |
441 | } | |
442 | di->module_path = optarg; | |
443 | break; | |
4f04a76b DL |
444 | case 'u': |
445 | if (di->flags & FRR_NO_PRIVSEP) | |
446 | return 1; | |
447 | di->privs->user = optarg; | |
448 | break; | |
449 | case 'g': | |
450 | if (di->flags & FRR_NO_PRIVSEP) | |
451 | return 1; | |
452 | di->privs->group = optarg; | |
453 | break; | |
f8507817 DS |
454 | case OPTION_LOG: |
455 | di->early_logging = optarg; | |
456 | break; | |
e9b4e74a DS |
457 | case OPTION_LOGLEVEL: |
458 | di->early_loglevel = optarg; | |
459 | break; | |
4f04a76b DL |
460 | default: |
461 | return 1; | |
462 | } | |
463 | return 0; | |
464 | } | |
465 | ||
d62a17ae | 466 | int frr_getopt(int argc, char *const argv[], int *longindex) |
4f04a76b DL |
467 | { |
468 | int opt; | |
469 | int lidx; | |
470 | ||
471 | comb_next_lo->name = NULL; | |
472 | ||
473 | do { | |
474 | opt = getopt_long(argc, argv, comb_optstr, comb_lo, &lidx); | |
475 | if (frr_opt(opt)) | |
476 | break; | |
477 | } while (opt != -1); | |
478 | ||
479 | if (opt == -1 && errors) | |
480 | frr_help_exit(1); | |
481 | if (longindex) | |
482 | *longindex = lidx; | |
483 | return opt; | |
484 | } | |
485 | ||
beaa5470 DL |
486 | static void frr_mkdir(const char *path, bool strip) |
487 | { | |
488 | char buf[256]; | |
489 | mode_t prev; | |
490 | int ret; | |
491 | struct zprivs_ids_t ids; | |
492 | ||
493 | if (strip) { | |
494 | char *slash = strrchr(path, '/'); | |
495 | size_t plen; | |
496 | if (!slash) | |
497 | return; | |
498 | plen = slash - path; | |
499 | if (plen > sizeof(buf) - 1) | |
500 | return; | |
501 | memcpy(buf, path, plen); | |
502 | buf[plen] = '\0'; | |
503 | path = buf; | |
504 | } | |
505 | ||
506 | /* o+rx (..5) is needed for the frrvty group to work properly; | |
507 | * without it, users in the frrvty group can't access the vty sockets. | |
508 | */ | |
509 | prev = umask(0022); | |
510 | ret = mkdir(path, 0755); | |
511 | umask(prev); | |
512 | ||
513 | if (ret != 0) { | |
514 | /* if EEXIST, return without touching the permissions, | |
515 | * so user-set custom permissions are left in place | |
516 | */ | |
517 | if (errno == EEXIST) | |
518 | return; | |
519 | ||
1c50c1c0 QY |
520 | flog_err(EC_LIB_SYSTEM_CALL, "failed to mkdir \"%s\": %s", path, |
521 | strerror(errno)); | |
beaa5470 DL |
522 | return; |
523 | } | |
524 | ||
525 | zprivs_get_ids(&ids); | |
526 | if (chown(path, ids.uid_normal, ids.gid_normal)) | |
1c50c1c0 QY |
527 | flog_err(EC_LIB_SYSTEM_CALL, "failed to chown \"%s\": %s", path, |
528 | strerror(errno)); | |
beaa5470 DL |
529 | } |
530 | ||
a5b38c5b | 531 | static struct thread_master *master; |
4f04a76b DL |
532 | struct thread_master *frr_init(void) |
533 | { | |
30771d65 DL |
534 | struct option_chain *oc; |
535 | struct frrmod_runtime *module; | |
536 | char moderr[256]; | |
d1b4fc1f | 537 | char p_instance[16] = "", p_pathspace[256] = ""; |
80b4df3b MW |
538 | const char *dir; |
539 | dir = di->module_path ? di->module_path : frr_moduledir; | |
4f04a76b DL |
540 | |
541 | srandom(time(NULL)); | |
542 | ||
d1b4fc1f | 543 | if (di->instance) { |
d62a17ae | 544 | snprintf(frr_protonameinst, sizeof(frr_protonameinst), "%s[%u]", |
545 | di->logname, di->instance); | |
d1b4fc1f DL |
546 | snprintf(p_instance, sizeof(p_instance), "-%d", di->instance); |
547 | } | |
548 | if (di->pathspace) | |
b39404c1 | 549 | snprintf(p_pathspace, sizeof(p_pathspace), "%s/", |
d1b4fc1f DL |
550 | di->pathspace); |
551 | ||
36077833 | 552 | snprintf(config_default, sizeof(config_default), "%s%s%s%s.conf", |
d1b4fc1f | 553 | frr_sysconfdir, p_pathspace, di->name, p_instance); |
b39404c1 | 554 | snprintf(pidfile_default, sizeof(pidfile_default), "%s/%s%s%s.pid", |
d1b4fc1f | 555 | frr_vtydir, p_pathspace, di->name, p_instance); |
b85120bc | 556 | |
37a1f2fb DL |
557 | zprivs_preinit(di->privs); |
558 | ||
d62a17ae | 559 | openzlog(di->progname, di->logname, di->instance, |
560 | LOG_CONS | LOG_NDELAY | LOG_PID, LOG_DAEMON); | |
f8507817 | 561 | |
e9b4e74a | 562 | command_setup_early_logging(di->early_logging, di->early_loglevel); |
4f04a76b | 563 | |
689f5a8c DL |
564 | if (!frr_zclient_addr(&zclient_addr, &zclient_addr_len, |
565 | frr_zclientpath)) { | |
566 | fprintf(stderr, "Invalid zserv socket path: %s\n", | |
567 | frr_zclientpath); | |
568 | exit(1); | |
569 | } | |
570 | ||
b8c1fde3 DL |
571 | /* don't mkdir these as root... */ |
572 | if (!(di->flags & FRR_NO_PRIVSEP)) { | |
573 | if (!di->pid_file || !di->vty_path) | |
574 | frr_mkdir(frr_vtydir, false); | |
575 | if (di->pid_file) | |
576 | frr_mkdir(di->pid_file, true); | |
577 | if (di->vty_path) | |
578 | frr_mkdir(di->vty_path, true); | |
579 | } | |
beaa5470 | 580 | |
30771d65 DL |
581 | frrmod_init(di->module); |
582 | while (modules) { | |
583 | modules = (oc = modules)->next; | |
80b4df3b | 584 | module = frrmod_load(oc->arg, dir, moderr, sizeof(moderr)); |
30771d65 DL |
585 | if (!module) { |
586 | fprintf(stderr, "%s\n", moderr); | |
587 | exit(1); | |
588 | } | |
589 | XFREE(MTYPE_TMP, oc); | |
590 | } | |
591 | ||
4f04a76b DL |
592 | zprivs_init(di->privs); |
593 | ||
972a411c | 594 | master = thread_master_create(NULL); |
4f04a76b DL |
595 | signal_init(master, di->n_signals, di->signals); |
596 | ||
857b5446 DL |
597 | if (di->flags & FRR_LIMITED_CLI) |
598 | cmd_init(-1); | |
599 | else | |
600 | cmd_init(1); | |
601 | vty_init(master); | |
602 | memory_init(); | |
603 | ||
85cd2f9f | 604 | log_ref_init(); |
b66d022e DS |
605 | lib_error_init(); |
606 | ||
4f04a76b DL |
607 | return master; |
608 | } | |
609 | ||
154b9e8f DL |
610 | static int rcvd_signal = 0; |
611 | ||
612 | static void rcv_signal(int signum) | |
613 | { | |
614 | rcvd_signal = signum; | |
615 | /* poll() is interrupted by the signal; handled below */ | |
616 | } | |
617 | ||
f43fbf83 DL |
618 | static void frr_daemon_wait(int fd) |
619 | { | |
620 | struct pollfd pfd[1]; | |
621 | int ret; | |
622 | pid_t exitpid; | |
623 | int exitstat; | |
154b9e8f DL |
624 | sigset_t sigs, prevsigs; |
625 | ||
626 | sigemptyset(&sigs); | |
627 | sigaddset(&sigs, SIGTSTP); | |
628 | sigaddset(&sigs, SIGQUIT); | |
629 | sigaddset(&sigs, SIGINT); | |
630 | sigprocmask(SIG_BLOCK, &sigs, &prevsigs); | |
631 | ||
632 | struct sigaction sa = { | |
633 | .sa_handler = rcv_signal, .sa_flags = SA_RESETHAND, | |
634 | }; | |
635 | sigemptyset(&sa.sa_mask); | |
636 | sigaction(SIGTSTP, &sa, NULL); | |
637 | sigaction(SIGQUIT, &sa, NULL); | |
638 | sigaction(SIGINT, &sa, NULL); | |
f43fbf83 DL |
639 | |
640 | do { | |
154b9e8f DL |
641 | char buf[1]; |
642 | ssize_t nrecv; | |
643 | ||
f43fbf83 DL |
644 | pfd[0].fd = fd; |
645 | pfd[0].events = POLLIN; | |
646 | ||
154b9e8f DL |
647 | rcvd_signal = 0; |
648 | ||
996c9314 | 649 | #if defined(HAVE_PPOLL) |
154b9e8f DL |
650 | ret = ppoll(pfd, 1, NULL, &prevsigs); |
651 | #elif defined(HAVE_POLLTS) | |
652 | ret = pollts(pfd, 1, NULL, &prevsigs); | |
653 | #else | |
654 | /* racy -- only used on FreeBSD 9 */ | |
655 | sigset_t tmpsigs; | |
656 | sigprocmask(SIG_SETMASK, &prevsigs, &tmpsigs); | |
f43fbf83 | 657 | ret = poll(pfd, 1, -1); |
154b9e8f DL |
658 | sigprocmask(SIG_SETMASK, &tmpsigs, NULL); |
659 | #endif | |
f43fbf83 DL |
660 | if (ret < 0 && errno != EINTR && errno != EAGAIN) { |
661 | perror("poll()"); | |
662 | exit(1); | |
663 | } | |
154b9e8f DL |
664 | switch (rcvd_signal) { |
665 | case SIGTSTP: | |
666 | send(fd, "S", 1, 0); | |
667 | do { | |
668 | nrecv = recv(fd, buf, sizeof(buf), 0); | |
669 | } while (nrecv == -1 | |
670 | && (errno == EINTR || errno == EAGAIN)); | |
671 | ||
672 | raise(SIGTSTP); | |
673 | sigaction(SIGTSTP, &sa, NULL); | |
674 | send(fd, "R", 1, 0); | |
675 | break; | |
676 | case SIGINT: | |
677 | send(fd, "I", 1, 0); | |
678 | break; | |
679 | case SIGQUIT: | |
680 | send(fd, "Q", 1, 0); | |
681 | break; | |
682 | } | |
f43fbf83 DL |
683 | } while (ret <= 0); |
684 | ||
685 | exitpid = waitpid(-1, &exitstat, WNOHANG); | |
686 | if (exitpid == 0) | |
687 | /* child successfully went to main loop & closed socket */ | |
688 | exit(0); | |
689 | ||
690 | /* child failed one way or another ... */ | |
6bd2b360 DL |
691 | if (WIFEXITED(exitstat) && WEXITSTATUS(exitstat) == 0) |
692 | /* can happen in --terminal case if exit is fast enough */ | |
693 | (void)0; | |
694 | else if (WIFEXITED(exitstat)) | |
f43fbf83 DL |
695 | fprintf(stderr, "%s failed to start, exited %d\n", di->name, |
696 | WEXITSTATUS(exitstat)); | |
697 | else if (WIFSIGNALED(exitstat)) | |
698 | fprintf(stderr, "%s crashed in startup, signal %d\n", di->name, | |
699 | WTERMSIG(exitstat)); | |
700 | else | |
701 | fprintf(stderr, "%s failed to start, unknown problem\n", | |
702 | di->name); | |
703 | exit(1); | |
704 | } | |
705 | ||
706 | static int daemon_ctl_sock = -1; | |
707 | ||
708 | static void frr_daemonize(void) | |
709 | { | |
710 | int fds[2]; | |
711 | pid_t pid; | |
712 | ||
713 | if (socketpair(AF_UNIX, SOCK_STREAM, 0, fds)) { | |
714 | perror("socketpair() for daemon control"); | |
715 | exit(1); | |
716 | } | |
717 | set_cloexec(fds[0]); | |
718 | set_cloexec(fds[1]); | |
719 | ||
720 | pid = fork(); | |
721 | if (pid < 0) { | |
722 | perror("fork()"); | |
723 | exit(1); | |
724 | } | |
725 | if (pid == 0) { | |
726 | /* child */ | |
727 | close(fds[0]); | |
728 | if (setsid() < 0) { | |
729 | perror("setsid()"); | |
730 | exit(1); | |
731 | } | |
732 | ||
733 | daemon_ctl_sock = fds[1]; | |
734 | return; | |
735 | } | |
736 | ||
737 | close(fds[1]); | |
738 | frr_daemon_wait(fds[0]); | |
739 | } | |
740 | ||
9e224e60 DS |
741 | /* |
742 | * Why is this a thread? | |
743 | * | |
744 | * The read in of config for integrated config happens *after* | |
745 | * thread execution starts( because it is passed in via a vtysh -b -n ) | |
746 | * While if you are not using integrated config we want the ability | |
747 | * to read the config in after thread execution starts, so that | |
748 | * we can match this behavior. | |
749 | */ | |
750 | static int frr_config_read_in(struct thread *t) | |
4f04a76b | 751 | { |
573de11f DS |
752 | if (!vty_read_config(di->config_file, config_default) && |
753 | di->backup_config_file) { | |
fe64533a DS |
754 | char *orig = XSTRDUP(MTYPE_TMP, host_config_get()); |
755 | ||
573de11f DS |
756 | zlog_info("Attempting to read backup config file: %s specified", |
757 | di->backup_config_file); | |
758 | vty_read_config(di->backup_config_file, config_default); | |
fe64533a DS |
759 | |
760 | host_config_set(orig); | |
761 | XFREE(MTYPE_TMP, orig); | |
573de11f | 762 | } |
9e224e60 DS |
763 | return 0; |
764 | } | |
765 | ||
766 | void frr_config_fork(void) | |
767 | { | |
768 | hook_call(frr_late_init, master); | |
eb05883f DL |
769 | |
770 | /* Don't start execution if we are in dry-run mode */ | |
9e224e60 DS |
771 | if (di->dryrun) { |
772 | frr_config_read_in(NULL); | |
eb05883f | 773 | exit(0); |
9e224e60 DS |
774 | } |
775 | ||
776 | thread_add_event(master, frr_config_read_in, NULL, 0, &di->read_in); | |
eb05883f | 777 | |
154b9e8f | 778 | if (di->daemon_mode || di->terminal) |
f43fbf83 | 779 | frr_daemonize(); |
eb05883f DL |
780 | |
781 | if (!di->pid_file) | |
782 | di->pid_file = pidfile_default; | |
d62a17ae | 783 | pid_output(di->pid_file); |
eb05883f DL |
784 | } |
785 | ||
786 | void frr_vty_serv(void) | |
787 | { | |
d62a17ae | 788 | /* allow explicit override of vty_path in the future |
eb05883f DL |
789 | * (not currently set anywhere) */ |
790 | if (!di->vty_path) { | |
791 | const char *dir; | |
d1b4fc1f DL |
792 | char defvtydir[256]; |
793 | ||
794 | snprintf(defvtydir, sizeof(defvtydir), "%s%s%s", frr_vtydir, | |
795 | di->pathspace ? "/" : "", | |
796 | di->pathspace ? di->pathspace : ""); | |
797 | ||
798 | dir = di->vty_sock_path ? di->vty_sock_path : defvtydir; | |
eb05883f DL |
799 | |
800 | if (di->instance) | |
801 | snprintf(vtypath_default, sizeof(vtypath_default), | |
d62a17ae | 802 | "%s/%s-%d.vty", dir, di->name, di->instance); |
eb05883f DL |
803 | else |
804 | snprintf(vtypath_default, sizeof(vtypath_default), | |
d62a17ae | 805 | "%s/%s.vty", dir, di->name); |
eb05883f DL |
806 | |
807 | di->vty_path = vtypath_default; | |
808 | } | |
809 | ||
810 | vty_serv_sock(di->vty_addr, di->vty_port, di->vty_path); | |
4f04a76b DL |
811 | } |
812 | ||
154b9e8f | 813 | static void frr_terminal_close(int isexit) |
cff2b211 | 814 | { |
993bab89 RW |
815 | int nullfd; |
816 | ||
154b9e8f DL |
817 | if (daemon_ctl_sock != -1) { |
818 | close(daemon_ctl_sock); | |
819 | daemon_ctl_sock = -1; | |
820 | } | |
821 | ||
822 | if (!di->daemon_mode || isexit) { | |
cff2b211 | 823 | printf("\n%s exiting\n", di->name); |
154b9e8f DL |
824 | if (!isexit) |
825 | raise(SIGINT); | |
826 | return; | |
cff2b211 DL |
827 | } else { |
828 | printf("\n%s daemonizing\n", di->name); | |
829 | fflush(stdout); | |
830 | } | |
831 | ||
993bab89 RW |
832 | nullfd = open("/dev/null", O_RDONLY | O_NOCTTY); |
833 | if (nullfd == -1) { | |
450971aa | 834 | flog_err_sys(EC_LIB_SYSTEM_CALL, |
09c866e3 QY |
835 | "%s: failed to open /dev/null: %s", __func__, |
836 | safe_strerror(errno)); | |
993bab89 RW |
837 | } else { |
838 | dup2(nullfd, 0); | |
839 | dup2(nullfd, 1); | |
840 | dup2(nullfd, 2); | |
841 | close(nullfd); | |
842 | } | |
154b9e8f | 843 | } |
cff2b211 | 844 | |
154b9e8f DL |
845 | static struct thread *daemon_ctl_thread = NULL; |
846 | ||
847 | static int frr_daemon_ctl(struct thread *t) | |
848 | { | |
849 | char buf[1]; | |
850 | ssize_t nr; | |
851 | ||
852 | nr = recv(daemon_ctl_sock, buf, sizeof(buf), 0); | |
853 | if (nr < 0 && (errno == EINTR || errno == EAGAIN)) | |
854 | goto out; | |
855 | if (nr <= 0) | |
856 | return 0; | |
857 | ||
858 | switch (buf[0]) { | |
996c9314 | 859 | case 'S': /* SIGTSTP */ |
154b9e8f | 860 | vty_stdio_suspend(); |
e339d7c0 | 861 | if (send(daemon_ctl_sock, "s", 1, 0) < 0) |
862 | zlog_err("%s send(\"s\") error (SIGTSTP propagation)", | |
863 | (di && di->name ? di->name : "")); | |
154b9e8f | 864 | break; |
996c9314 | 865 | case 'R': /* SIGTCNT [implicit] */ |
154b9e8f DL |
866 | vty_stdio_resume(); |
867 | break; | |
996c9314 | 868 | case 'I': /* SIGINT */ |
154b9e8f DL |
869 | di->daemon_mode = false; |
870 | raise(SIGINT); | |
871 | break; | |
996c9314 | 872 | case 'Q': /* SIGQUIT */ |
154b9e8f DL |
873 | di->daemon_mode = true; |
874 | vty_stdio_close(); | |
875 | break; | |
cff2b211 | 876 | } |
154b9e8f DL |
877 | |
878 | out: | |
879 | thread_add_read(master, frr_daemon_ctl, NULL, daemon_ctl_sock, | |
880 | &daemon_ctl_thread); | |
881 | return 0; | |
cff2b211 DL |
882 | } |
883 | ||
16077f2f DL |
884 | void frr_run(struct thread_master *master) |
885 | { | |
886 | char instanceinfo[64] = ""; | |
887 | ||
888 | frr_vty_serv(); | |
889 | ||
890 | if (di->instance) | |
891 | snprintf(instanceinfo, sizeof(instanceinfo), "instance %u ", | |
d62a17ae | 892 | di->instance); |
893 | ||
894 | zlog_notice("%s %s starting: %svty@%d%s", di->name, FRR_VERSION, | |
895 | instanceinfo, di->vty_port, di->startinfo); | |
16077f2f | 896 | |
cff2b211 DL |
897 | if (di->terminal) { |
898 | vty_stdio(frr_terminal_close); | |
154b9e8f DL |
899 | if (daemon_ctl_sock != -1) { |
900 | set_nonblocking(daemon_ctl_sock); | |
901 | thread_add_read(master, frr_daemon_ctl, NULL, | |
902 | daemon_ctl_sock, &daemon_ctl_thread); | |
903 | } | |
eef3d030 | 904 | } else if (di->daemon_mode) { |
c9c8d0d1 | 905 | int nullfd = open("/dev/null", O_RDONLY | O_NOCTTY); |
993bab89 | 906 | if (nullfd == -1) { |
450971aa | 907 | flog_err_sys(EC_LIB_SYSTEM_CALL, |
09c866e3 QY |
908 | "%s: failed to open /dev/null: %s", |
909 | __func__, safe_strerror(errno)); | |
993bab89 RW |
910 | } else { |
911 | dup2(nullfd, 0); | |
912 | dup2(nullfd, 1); | |
913 | dup2(nullfd, 2); | |
914 | close(nullfd); | |
915 | } | |
c9c8d0d1 DL |
916 | |
917 | if (daemon_ctl_sock != -1) | |
918 | close(daemon_ctl_sock); | |
f43fbf83 DL |
919 | daemon_ctl_sock = -1; |
920 | } | |
921 | ||
d34cb7f0 DL |
922 | /* end fixed stderr startup logging */ |
923 | zlog_startup_stderr = false; | |
924 | ||
16077f2f DL |
925 | struct thread thread; |
926 | while (thread_fetch(master, &thread)) | |
927 | thread_call(&thread); | |
928 | } | |
03951374 DL |
929 | |
930 | void frr_early_fini(void) | |
931 | { | |
932 | hook_call(frr_early_fini); | |
933 | } | |
934 | ||
935 | void frr_fini(void) | |
936 | { | |
9eed278b DL |
937 | FILE *fp; |
938 | char filename[128]; | |
939 | int have_leftovers; | |
940 | ||
03951374 DL |
941 | hook_call(frr_fini); |
942 | ||
943 | /* memory_init -> nothing needed */ | |
944 | vty_terminate(); | |
945 | cmd_terminate(); | |
85cd2f9f | 946 | log_ref_fini(); |
03951374 DL |
947 | zprivs_terminate(di->privs); |
948 | /* signal_init -> nothing needed */ | |
949 | thread_master_free(master); | |
e5716b16 | 950 | master = NULL; |
03951374 DL |
951 | closezlog(); |
952 | /* frrmod_init -> nothing needed / hooks */ | |
9eed278b DL |
953 | |
954 | if (!debug_memstats_at_exit) | |
955 | return; | |
956 | ||
957 | have_leftovers = log_memstats(stderr, di->name); | |
958 | ||
959 | /* in case we decide at runtime that we want exit-memstats for | |
960 | * a daemon, but it has no stderr because it's daemonized | |
961 | * (only do this if we actually have something to print though) | |
962 | */ | |
963 | if (!have_leftovers) | |
964 | return; | |
965 | ||
996c9314 LB |
966 | snprintf(filename, sizeof(filename), "/tmp/frr-memstats-%s-%llu-%llu", |
967 | di->name, (unsigned long long)getpid(), | |
9eed278b DL |
968 | (unsigned long long)time(NULL)); |
969 | ||
970 | fp = fopen(filename, "w"); | |
971 | if (fp) { | |
972 | log_memstats(fp, di->name); | |
973 | fclose(fp); | |
974 | } | |
03951374 | 975 | } |