]>
git.proxmox.com Git - mirror_frr.git/blob - lib/libfrr.c
2 * libfrr overall management functions
4 * Copyright (C) 2016 David Lamparter for NetDEF, Inc.
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)
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
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
24 #include <sys/types.h>
33 #include "memory_vty.h"
39 DEFINE_HOOK(frr_late_init
, (struct thread_master
* tm
), (tm
))
40 DEFINE_KOOH(frr_early_fini
, (), ())
41 DEFINE_KOOH(frr_fini
, (), ())
43 const char frr_sysconfdir
[] = SYSCONFDIR
;
44 const char frr_vtydir
[] = DAEMON_VTY_DIR
;
45 const char frr_moduledir
[] = MODULE_PATH
;
47 char frr_protoname
[256] = "NONE";
48 char frr_protonameinst
[256] = "NONE";
50 char config_default
[512];
51 char frr_zclientpath
[256];
52 static char pidfile_default
[512];
53 static char vtypath_default
[256];
55 bool debug_memstats_at_exit
= 0;
57 static char comb_optstr
[256];
58 static struct option comb_lo
[64];
59 static struct option
*comb_next_lo
= &comb_lo
[0];
60 static char comb_helpstr
[4096];
65 const struct option
*longopts
;
68 static void opt_extend(const struct optspec
*os
)
70 const struct option
*lo
;
72 strcat(comb_optstr
, os
->optstr
);
73 strcat(comb_helpstr
, os
->helpstr
);
74 for (lo
= os
->longopts
; lo
->name
; lo
++)
75 memcpy(comb_next_lo
++, lo
, sizeof(*lo
));
79 #define OPTION_VTYSOCK 1000
80 #define OPTION_MODULEDIR 1002
81 #define OPTION_LOG 1003
82 #define OPTION_LOGLEVEL 1004
84 static const struct option lo_always
[] = {
85 {"help", no_argument
, NULL
, 'h'},
86 {"version", no_argument
, NULL
, 'v'},
87 {"daemon", no_argument
, NULL
, 'd'},
88 {"module", no_argument
, NULL
, 'M'},
89 {"vty_socket", required_argument
, NULL
, OPTION_VTYSOCK
},
90 {"moduledir", required_argument
, NULL
, OPTION_MODULEDIR
},
91 {"log", required_argument
, NULL
, OPTION_LOG
},
92 {"log-level", required_argument
, NULL
, OPTION_LOGLEVEL
},
94 static const struct optspec os_always
= {
96 " -h, --help Display this help and exit\n"
97 " -v, --version Print program version\n"
98 " -d, --daemon Runs in daemon mode\n"
99 " -M, --module Load specified module\n"
100 " --vty_socket Override vty socket path\n"
101 " --moduledir Override modules directory\n"
102 " --log Set Logging to stdout, syslog, or file:<name>\n"
103 " --log-level Set Logging Level to use, debug, info, warn, etc\n",
107 static const struct option lo_cfg_pid_dry
[] = {
108 {"pid_file", required_argument
, NULL
, 'i'},
109 {"config_file", required_argument
, NULL
, 'f'},
110 {"pathspace", required_argument
, NULL
, 'N'},
111 {"dryrun", no_argument
, NULL
, 'C'},
112 {"terminal", no_argument
, NULL
, 't'},
114 static const struct optspec os_cfg_pid_dry
= {
116 " -f, --config_file Set configuration file name\n"
117 " -i, --pid_file Set process identifier file name\n"
118 " -N, --pathspace Insert prefix into config & socket paths\n"
119 " -C, --dryrun Check configuration for validity and exit\n"
120 " -t, --terminal Open terminal session on stdio\n"
121 " -d -t Daemonize after terminal session ends\n",
125 static const struct option lo_zclient
[] = {
126 {"socket", required_argument
, NULL
, 'z'},
128 static const struct optspec os_zclient
= {
129 "z:", " -z, --socket Set path of zebra socket\n", lo_zclient
};
132 static const struct option lo_vty
[] = {
133 {"vty_addr", required_argument
, NULL
, 'A'},
134 {"vty_port", required_argument
, NULL
, 'P'},
136 static const struct optspec os_vty
= {
138 " -A, --vty_addr Set vty's bind address\n"
139 " -P, --vty_port Set vty's port number\n",
143 static const struct option lo_user
[] = {{"user", required_argument
, NULL
, 'u'},
144 {"group", required_argument
, NULL
, 'g'},
146 static const struct optspec os_user
= {"u:g:",
147 " -u, --user User to run as\n"
148 " -g, --group Group to run as\n",
152 bool frr_zclient_addr(struct sockaddr_storage
*sa
, socklen_t
*sa_len
,
155 memset(sa
, 0, sizeof(*sa
));
158 path
= ZEBRA_SERV_PATH
;
160 if (!strncmp(path
, ZAPI_TCP_PATHNAME
, strlen(ZAPI_TCP_PATHNAME
))) {
161 /* note: this functionality is disabled at bottom */
163 int port
= ZEBRA_PORT
;
165 struct sockaddr_in
*sin
= NULL
;
166 struct sockaddr_in6
*sin6
= NULL
;
168 path
+= strlen(ZAPI_TCP_PATHNAME
);
188 port
= strtoul(path
, &err
, 10);
199 sin
= (struct sockaddr_in
*)sa
;
200 sin
->sin_port
= htons(port
);
201 sin
->sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
202 *sa_len
= sizeof(struct sockaddr_in
);
203 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
204 sin
->sin_len
= *sa_len
;
208 sin6
= (struct sockaddr_in6
*)sa
;
209 sin6
->sin6_port
= htons(port
);
210 inet_pton(AF_INET6
, "::1", &sin6
->sin6_addr
);
211 *sa_len
= sizeof(struct sockaddr_in6
);
213 sin6
->sin6_len
= *sa_len
;
219 /* force-disable this path, because tcp-zebra is a
220 * SECURITY ISSUE. there are no checks at all against
221 * untrusted users on the local system connecting on TCP
222 * and injecting bogus routing data into the entire routing
225 * The functionality is only left here because it may be
226 * useful during development, in order to be able to get
227 * tcpdump or wireshark watching ZAPI as TCP. If you want
228 * to do that, flip the #if 1 above to #if 0. */
229 memset(sa
, 0, sizeof(*sa
));
233 /* "sun" is a #define on solaris */
234 struct sockaddr_un
*suna
= (struct sockaddr_un
*)sa
;
236 suna
->sun_family
= AF_UNIX
;
237 strlcpy(suna
->sun_path
, path
, sizeof(suna
->sun_path
));
238 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
239 *sa_len
= suna
->sun_len
= SUN_LEN(suna
);
241 *sa_len
= sizeof(suna
->sun_family
) + strlen(suna
->sun_path
);
242 #endif /* HAVE_STRUCT_SOCKADDR_UN_SUN_LEN */
244 /* this is left here for future reference; Linux abstract
245 * socket namespace support can be enabled by replacing
246 * above #if 0 with #ifdef GNU_LINUX.
248 * THIS IS A SECURITY ISSUE, the abstract socket namespace
249 * does not have user/group permission control on sockets.
250 * we'd need to implement SCM_CREDENTIALS support first to
251 * check that only proper users can connect to abstract
252 * sockets. (same problem as tcp-zebra, except there is a
253 * fix with SCM_CREDENTIALS. tcp-zebra has no such fix.)
255 if (suna
->sun_path
[0] == '@')
256 suna
->sun_path
[0] = '\0';
262 static struct frr_daemon_info
*di
= NULL
;
264 void frr_preinit(struct frr_daemon_info
*daemon
, int argc
, char **argv
)
268 /* basename(), opencoded. */
269 char *p
= strrchr(argv
[0], '/');
270 di
->progname
= p
? p
+ 1 : argv
[0];
274 opt_extend(&os_always
);
275 if (!(di
->flags
& FRR_NO_CFG_PID_DRY
))
276 opt_extend(&os_cfg_pid_dry
);
277 if (!(di
->flags
& FRR_NO_PRIVSEP
))
278 opt_extend(&os_user
);
279 if (!(di
->flags
& FRR_NO_ZCLIENT
))
280 opt_extend(&os_zclient
);
281 if (!(di
->flags
& FRR_NO_TCPVTY
))
284 snprintf(config_default
, sizeof(config_default
), "%s/%s.conf",
285 frr_sysconfdir
, di
->name
);
286 snprintf(pidfile_default
, sizeof(pidfile_default
), "%s/%s.pid",
287 frr_vtydir
, di
->name
);
289 strlcpy(frr_protoname
, di
->logname
, sizeof(frr_protoname
));
290 strlcpy(frr_protonameinst
, di
->logname
, sizeof(frr_protonameinst
));
292 strlcpy(frr_zclientpath
, ZEBRA_SERV_PATH
, sizeof(frr_zclientpath
));
295 void frr_opt_add(const char *optstr
, const struct option
*longopts
,
298 const struct optspec main_opts
= {optstr
, helpstr
, longopts
};
299 opt_extend(&main_opts
);
302 void frr_help_exit(int status
)
304 FILE *target
= status
? stderr
: stdout
;
307 fprintf(stderr
, "Invalid options.\n\n");
310 di
->printhelp(target
);
312 fprintf(target
, "Usage: %s [OPTION...]\n\n%s%s%s\n\n%s",
313 di
->progname
, di
->proghelp
, di
->copyright
? "\n\n" : "",
314 di
->copyright
? di
->copyright
: "", comb_helpstr
);
315 fprintf(target
, "\nReport bugs to %s\n", FRR_BUG_ADDRESS
);
319 struct option_chain
{
320 struct option_chain
*next
;
324 static struct option_chain
*modules
= NULL
, **modnext
= &modules
;
325 static int errors
= 0;
327 static int frr_opt(int opt
)
329 static int vty_port_set
= 0;
330 static int vty_addr_set
= 0;
331 struct option_chain
*oc
;
339 print_version(di
->progname
);
346 oc
= XMALLOC(MTYPE_TMP
, sizeof(*oc
));
353 if (di
->flags
& FRR_NO_CFG_PID_DRY
)
355 di
->pid_file
= optarg
;
358 if (di
->flags
& FRR_NO_CFG_PID_DRY
)
360 di
->config_file
= optarg
;
363 if (di
->flags
& FRR_NO_CFG_PID_DRY
)
367 "-N/--pathspace option specified more than once!\n");
371 if (strchr(optarg
, '/') || strchr(optarg
, '.')) {
373 "slashes or dots are not permitted in the --pathspace option.\n");
377 di
->pathspace
= optarg
;
380 if (di
->flags
& FRR_NO_CFG_PID_DRY
)
385 if (di
->flags
& FRR_NO_CFG_PID_DRY
)
390 if (di
->flags
& FRR_NO_ZCLIENT
)
392 strlcpy(frr_zclientpath
, optarg
, sizeof(frr_zclientpath
));
395 if (di
->flags
& FRR_NO_TCPVTY
)
399 "-A option specified more than once!\n");
404 di
->vty_addr
= optarg
;
407 if (di
->flags
& FRR_NO_TCPVTY
)
411 "-P option specified more than once!\n");
416 di
->vty_port
= strtoul(optarg
, &err
, 0);
417 if (*err
|| !*optarg
) {
419 "invalid port number \"%s\" for -P option\n",
426 if (di
->vty_sock_path
) {
428 "--vty_socket option specified more than once!\n");
432 di
->vty_sock_path
= optarg
;
434 case OPTION_MODULEDIR
:
435 if (di
->module_path
) {
437 "----moduledir option specified more than once!\n");
441 di
->module_path
= optarg
;
444 if (di
->flags
& FRR_NO_PRIVSEP
)
446 di
->privs
->user
= optarg
;
449 if (di
->flags
& FRR_NO_PRIVSEP
)
451 di
->privs
->group
= optarg
;
454 di
->early_logging
= optarg
;
456 case OPTION_LOGLEVEL
:
457 di
->early_loglevel
= optarg
;
465 int frr_getopt(int argc
, char *const argv
[], int *longindex
)
470 comb_next_lo
->name
= NULL
;
473 opt
= getopt_long(argc
, argv
, comb_optstr
, comb_lo
, &lidx
);
478 if (opt
== -1 && errors
)
485 static void frr_mkdir(const char *path
, bool strip
)
490 struct zprivs_ids_t ids
;
493 char *slash
= strrchr(path
, '/');
498 if (plen
> sizeof(buf
) - 1)
500 memcpy(buf
, path
, plen
);
505 /* o+rx (..5) is needed for the frrvty group to work properly;
506 * without it, users in the frrvty group can't access the vty sockets.
509 ret
= mkdir(path
, 0755);
513 /* if EEXIST, return without touching the permissions,
514 * so user-set custom permissions are left in place
519 zlog_warn("failed to mkdir \"%s\": %s", path
, strerror(errno
));
523 zprivs_get_ids(&ids
);
524 if (chown(path
, ids
.uid_normal
, ids
.gid_normal
))
525 zlog_warn("failed to chown \"%s\": %s", path
, strerror(errno
));
528 static struct thread_master
*master
;
529 struct thread_master
*frr_init(void)
531 struct option_chain
*oc
;
532 struct frrmod_runtime
*module
;
534 char p_instance
[16] = "", p_pathspace
[256] = "";
536 dir
= di
->module_path
? di
->module_path
: frr_moduledir
;
541 snprintf(frr_protonameinst
, sizeof(frr_protonameinst
), "%s[%u]",
542 di
->logname
, di
->instance
);
543 snprintf(p_instance
, sizeof(p_instance
), "-%d", di
->instance
);
546 snprintf(p_pathspace
, sizeof(p_pathspace
), "%s/",
549 snprintf(config_default
, sizeof(config_default
), "%s%s%s%s.conf",
550 frr_sysconfdir
, p_pathspace
, di
->name
, p_instance
);
551 snprintf(pidfile_default
, sizeof(pidfile_default
), "%s/%s%s%s.pid",
552 frr_vtydir
, p_pathspace
, di
->name
, p_instance
);
554 zprivs_preinit(di
->privs
);
556 openzlog(di
->progname
, di
->logname
, di
->instance
,
557 LOG_CONS
| LOG_NDELAY
| LOG_PID
, LOG_DAEMON
);
559 command_setup_early_logging(di
->early_logging
, di
->early_loglevel
);
561 if (!frr_zclient_addr(&zclient_addr
, &zclient_addr_len
,
563 fprintf(stderr
, "Invalid zserv socket path: %s\n",
568 /* don't mkdir these as root... */
569 if (!(di
->flags
& FRR_NO_PRIVSEP
)) {
570 if (!di
->pid_file
|| !di
->vty_path
)
571 frr_mkdir(frr_vtydir
, false);
573 frr_mkdir(di
->pid_file
, true);
575 frr_mkdir(di
->vty_path
, true);
578 frrmod_init(di
->module
);
580 modules
= (oc
= modules
)->next
;
581 module
= frrmod_load(oc
->arg
, dir
, moderr
, sizeof(moderr
));
583 fprintf(stderr
, "%s\n", moderr
);
586 XFREE(MTYPE_TMP
, oc
);
589 zprivs_init(di
->privs
);
591 master
= thread_master_create(NULL
);
592 signal_init(master
, di
->n_signals
, di
->signals
);
594 if (di
->flags
& FRR_LIMITED_CLI
)
604 static int rcvd_signal
= 0;
606 static void rcv_signal(int signum
)
608 rcvd_signal
= signum
;
609 /* poll() is interrupted by the signal; handled below */
612 static void frr_daemon_wait(int fd
)
614 struct pollfd pfd
[1];
618 sigset_t sigs
, prevsigs
;
621 sigaddset(&sigs
, SIGTSTP
);
622 sigaddset(&sigs
, SIGQUIT
);
623 sigaddset(&sigs
, SIGINT
);
624 sigprocmask(SIG_BLOCK
, &sigs
, &prevsigs
);
626 struct sigaction sa
= {
627 .sa_handler
= rcv_signal
, .sa_flags
= SA_RESETHAND
,
629 sigemptyset(&sa
.sa_mask
);
630 sigaction(SIGTSTP
, &sa
, NULL
);
631 sigaction(SIGQUIT
, &sa
, NULL
);
632 sigaction(SIGINT
, &sa
, NULL
);
639 pfd
[0].events
= POLLIN
;
643 #if defined(HAVE_PPOLL)
644 ret
= ppoll(pfd
, 1, NULL
, &prevsigs
);
645 #elif defined(HAVE_POLLTS)
646 ret
= pollts(pfd
, 1, NULL
, &prevsigs
);
648 /* racy -- only used on FreeBSD 9 */
650 sigprocmask(SIG_SETMASK
, &prevsigs
, &tmpsigs
);
651 ret
= poll(pfd
, 1, -1);
652 sigprocmask(SIG_SETMASK
, &tmpsigs
, NULL
);
654 if (ret
< 0 && errno
!= EINTR
&& errno
!= EAGAIN
) {
658 switch (rcvd_signal
) {
662 nrecv
= recv(fd
, buf
, sizeof(buf
), 0);
664 && (errno
== EINTR
|| errno
== EAGAIN
));
667 sigaction(SIGTSTP
, &sa
, NULL
);
679 exitpid
= waitpid(-1, &exitstat
, WNOHANG
);
681 /* child successfully went to main loop & closed socket */
684 /* child failed one way or another ... */
685 if (WIFEXITED(exitstat
) && WEXITSTATUS(exitstat
) == 0)
686 /* can happen in --terminal case if exit is fast enough */
688 else if (WIFEXITED(exitstat
))
689 fprintf(stderr
, "%s failed to start, exited %d\n", di
->name
,
690 WEXITSTATUS(exitstat
));
691 else if (WIFSIGNALED(exitstat
))
692 fprintf(stderr
, "%s crashed in startup, signal %d\n", di
->name
,
695 fprintf(stderr
, "%s failed to start, unknown problem\n",
700 static int daemon_ctl_sock
= -1;
702 static void frr_daemonize(void)
707 if (socketpair(AF_UNIX
, SOCK_STREAM
, 0, fds
)) {
708 perror("socketpair() for daemon control");
727 daemon_ctl_sock
= fds
[1];
732 frr_daemon_wait(fds
[0]);
736 * Why is this a thread?
738 * The read in of config for integrated config happens *after*
739 * thread execution starts( because it is passed in via a vtysh -b -n )
740 * While if you are not using integrated config we want the ability
741 * to read the config in after thread execution starts, so that
742 * we can match this behavior.
744 static int frr_config_read_in(struct thread
*t
)
746 if (!vty_read_config(di
->config_file
, config_default
) &&
747 di
->backup_config_file
) {
748 zlog_info("Attempting to read backup config file: %s specified",
749 di
->backup_config_file
);
750 vty_read_config(di
->backup_config_file
, config_default
);
755 void frr_config_fork(void)
757 hook_call(frr_late_init
, master
);
759 /* Don't start execution if we are in dry-run mode */
761 frr_config_read_in(NULL
);
765 thread_add_event(master
, frr_config_read_in
, NULL
, 0, &di
->read_in
);
767 if (di
->daemon_mode
|| di
->terminal
)
771 di
->pid_file
= pidfile_default
;
772 pid_output(di
->pid_file
);
775 void frr_vty_serv(void)
777 /* allow explicit override of vty_path in the future
778 * (not currently set anywhere) */
783 snprintf(defvtydir
, sizeof(defvtydir
), "%s%s%s", frr_vtydir
,
784 di
->pathspace
? "/" : "",
785 di
->pathspace
? di
->pathspace
: "");
787 dir
= di
->vty_sock_path
? di
->vty_sock_path
: defvtydir
;
790 snprintf(vtypath_default
, sizeof(vtypath_default
),
791 "%s/%s-%d.vty", dir
, di
->name
, di
->instance
);
793 snprintf(vtypath_default
, sizeof(vtypath_default
),
794 "%s/%s.vty", dir
, di
->name
);
796 di
->vty_path
= vtypath_default
;
799 vty_serv_sock(di
->vty_addr
, di
->vty_port
, di
->vty_path
);
802 static void frr_terminal_close(int isexit
)
806 if (daemon_ctl_sock
!= -1) {
807 close(daemon_ctl_sock
);
808 daemon_ctl_sock
= -1;
811 if (!di
->daemon_mode
|| isexit
) {
812 printf("\n%s exiting\n", di
->name
);
817 printf("\n%s daemonizing\n", di
->name
);
821 nullfd
= open("/dev/null", O_RDONLY
| O_NOCTTY
);
823 zlog_err("%s: failed to open /dev/null: %s", __func__
,
824 safe_strerror(errno
));
833 static struct thread
*daemon_ctl_thread
= NULL
;
835 static int frr_daemon_ctl(struct thread
*t
)
840 nr
= recv(daemon_ctl_sock
, buf
, sizeof(buf
), 0);
841 if (nr
< 0 && (errno
== EINTR
|| errno
== EAGAIN
))
847 case 'S': /* SIGTSTP */
849 send(daemon_ctl_sock
, "s", 1, 0);
851 case 'R': /* SIGTCNT [implicit] */
854 case 'I': /* SIGINT */
855 di
->daemon_mode
= false;
858 case 'Q': /* SIGQUIT */
859 di
->daemon_mode
= true;
865 thread_add_read(master
, frr_daemon_ctl
, NULL
, daemon_ctl_sock
,
870 void frr_run(struct thread_master
*master
)
872 char instanceinfo
[64] = "";
877 snprintf(instanceinfo
, sizeof(instanceinfo
), "instance %u ",
880 zlog_notice("%s %s starting: %svty@%d%s", di
->name
, FRR_VERSION
,
881 instanceinfo
, di
->vty_port
, di
->startinfo
);
884 vty_stdio(frr_terminal_close
);
885 if (daemon_ctl_sock
!= -1) {
886 set_nonblocking(daemon_ctl_sock
);
887 thread_add_read(master
, frr_daemon_ctl
, NULL
,
888 daemon_ctl_sock
, &daemon_ctl_thread
);
890 } else if (di
->daemon_mode
) {
891 int nullfd
= open("/dev/null", O_RDONLY
| O_NOCTTY
);
893 zlog_err("%s: failed to open /dev/null: %s", __func__
,
894 safe_strerror(errno
));
902 if (daemon_ctl_sock
!= -1)
903 close(daemon_ctl_sock
);
904 daemon_ctl_sock
= -1;
907 /* end fixed stderr startup logging */
908 zlog_startup_stderr
= false;
910 struct thread thread
;
911 while (thread_fetch(master
, &thread
))
912 thread_call(&thread
);
915 void frr_early_fini(void)
917 hook_call(frr_early_fini
);
928 /* memory_init -> nothing needed */
931 zprivs_terminate(di
->privs
);
932 /* signal_init -> nothing needed */
933 thread_master_free(master
);
936 /* frrmod_init -> nothing needed / hooks */
938 if (!debug_memstats_at_exit
)
941 have_leftovers
= log_memstats(stderr
, di
->name
);
943 /* in case we decide at runtime that we want exit-memstats for
944 * a daemon, but it has no stderr because it's daemonized
945 * (only do this if we actually have something to print though)
950 snprintf(filename
, sizeof(filename
), "/tmp/frr-memstats-%s-%llu-%llu",
951 di
->name
, (unsigned long long)getpid(),
952 (unsigned long long)time(NULL
));
954 fp
= fopen(filename
, "w");
956 log_memstats(fp
, di
->name
);