Merge pull request #261 from opensourcerouting/lib_cleanup

startup, option parsing & logging refactor

1 files changed, 392 insertions, 0 deletions

diff --git a/lib/libfrr.c b/lib/libfrr.c
new file mode 100644
index 0000000000..f9ac3158a3
--- /dev/null
+++ b/lib/libfrr.c
@@ -0,0 +1,392 @@
+/*
+ * libfrr overall management functions
+ *
+ * Copyright (C) 2016  David Lamparter for NetDEF, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <zebra.h>
+
+#include "libfrr.h"
+#include "getopt.h"
+#include "vty.h"
+#include "command.h"
+#include "version.h"
+#include "memory_vty.h"
+#include "zclient.h"
+
+const char frr_sysconfdir[] = SYSCONFDIR;
+const char frr_vtydir[] = DAEMON_VTY_DIR;
+
+char config_default[256];
+static char pidfile_default[256];
+static char vtypath_default[256];
+
+static char comb_optstr[256];
+static struct option comb_lo[64];
+static struct option *comb_next_lo = &comb_lo[0];
+static char comb_helpstr[4096];
+
+struct optspec {
+	const char *optstr;
+	const char *helpstr;
+	const struct option *longopts;
+};
+
+static void opt_extend(const struct optspec *os)
+{
+	const struct option *lo;
+
+	strcat(comb_optstr, os->optstr);
+	strcat(comb_helpstr, os->helpstr);
+	for (lo = os->longopts; lo->name; lo++)
+		memcpy(comb_next_lo++, lo, sizeof(*lo));
+}
+
+
+#define OPTION_VTYSOCK 1000
+
+static const struct option lo_always[] = {
+	{ "help",        no_argument,       NULL, 'h' },
+	{ "version",     no_argument,       NULL, 'v' },
+	{ "daemon",      no_argument,       NULL, 'd' },
+	{ "vty_socket",  required_argument, NULL, OPTION_VTYSOCK },
+	{ NULL }
+};
+static const struct optspec os_always = {
+	"hvdi:",
+	"  -h, --help         Display this help and exit\n"
+	"  -v, --version      Print program version\n"
+	"  -d, --daemon       Runs in daemon mode\n"
+	"      --vty_socket   Override vty socket path\n",
+	lo_always
+};
+
+
+static const struct option lo_cfg_pid_dry[] = {
+	{ "pid_file",    required_argument, NULL, 'i' },
+	{ "config_file", required_argument, NULL, 'f' },
+	{ "dryrun",      no_argument,       NULL, 'C' },
+	{ NULL }
+};
+static const struct optspec os_cfg_pid_dry = {
+	"f:i:C",
+	"  -f, --config_file  Set configuration file name\n"
+	"  -i, --pid_file     Set process identifier file name\n"
+	"  -C, --dryrun       Check configuration for validity and exit\n",
+	lo_cfg_pid_dry
+};
+
+
+static const struct option lo_zclient[] = {
+	{ "socket", required_argument, NULL, 'z' },
+	{ NULL }
+};
+static const struct optspec os_zclient = {
+	"z:",
+	"  -z, --socket       Set path of zebra socket\n",
+	lo_zclient
+};
+
+
+static const struct option lo_vty[] = {
+	{ "vty_addr",   required_argument, NULL, 'A'},
+	{ "vty_port",   required_argument, NULL, 'P'},
+	{ NULL }
+};
+static const struct optspec os_vty = {
+	"A:P:",
+	"  -A, --vty_addr     Set vty's bind address\n"
+	"  -P, --vty_port     Set vty's port number\n",
+	lo_vty
+};
+
+
+static const struct option lo_user[] = {
+	{ "user",  required_argument, NULL, 'u'},
+	{ "group", required_argument, NULL, 'g'},
+	{ NULL }
+};
+static const struct optspec os_user = {
+	"u:g:",
+	"  -u, --user         User to run as\n"
+	"  -g, --group        Group to run as\n",
+	lo_user
+};
+
+
+static struct frr_daemon_info *di = NULL;
+
+void frr_preinit(struct frr_daemon_info *daemon, int argc, char **argv)
+{
+	di = daemon;
+
+	/* basename(), opencoded. */
+	char *p = strrchr(argv[0], '/');
+	di->progname = p ? p + 1 : argv[0];
+
+	umask(0027);
+
+	opt_extend(&os_always);
+	if (!(di->flags & FRR_NO_CFG_PID_DRY))
+		opt_extend(&os_cfg_pid_dry);
+	if (!(di->flags & FRR_NO_PRIVSEP))
+		opt_extend(&os_user);
+	if (!(di->flags & FRR_NO_ZCLIENT))
+		opt_extend(&os_zclient);
+	if (!(di->flags & FRR_NO_TCPVTY))
+		opt_extend(&os_vty);
+
+	snprintf(config_default, sizeof(config_default), "%s/%s.conf",
+			frr_sysconfdir, di->name);
+	snprintf(pidfile_default, sizeof(pidfile_default), "%s/%s.pid",
+			frr_vtydir, di->name);
+}
+
+void frr_opt_add(const char *optstr, const struct option *longopts,
+		const char *helpstr)
+{
+	const struct optspec main_opts = { optstr, helpstr, longopts };
+	opt_extend(&main_opts);
+}
+
+void frr_help_exit(int status)
+{
+	FILE *target = status ? stderr : stdout;
+
+	if (status != 0)
+		fprintf(stderr, "Invalid options.\n\n");
+
+	if (di->printhelp)
+		di->printhelp(target);
+	else
+		fprintf(target, "Usage: %s [OPTION...]\n\n%s%s%s\n\n%s",
+				di->progname,
+				di->proghelp,
+				di->copyright ? "\n\n" : "",
+				di->copyright ? di->copyright : "",
+				comb_helpstr);
+	fprintf(target, "\nReport bugs to %s\n", FRR_BUG_ADDRESS);
+	exit(status);
+}
+
+static int errors = 0;
+
+static int frr_opt(int opt)
+{
+	static int vty_port_set = 0;
+	static int vty_addr_set = 0;
+	char *err;
+
+	switch (opt) {
+	case 'h':
+		frr_help_exit(0);
+		break;
+	case 'v':
+		print_version(di->progname);
+		exit(0);
+		break;
+	case 'd':
+		di->daemon_mode = 1;
+		break;
+	case 'i':
+		if (di->flags & FRR_NO_CFG_PID_DRY)
+			return 1;
+		di->pid_file = optarg;
+		break;
+	case 'f':
+		if (di->flags & FRR_NO_CFG_PID_DRY)
+			return 1;
+		di->config_file = optarg;
+		break;
+	case 'C':
+		if (di->flags & FRR_NO_CFG_PID_DRY)
+			return 1;
+		di->dryrun = 1;
+		break;
+	case 'z':
+		if (di->flags & FRR_NO_ZCLIENT)
+			return 1;
+		zclient_serv_path_set(optarg);
+		break;
+	case 'A':
+		if (di->flags & FRR_NO_TCPVTY)
+			return 1;
+		if (vty_addr_set) {
+			fprintf(stderr, "-A option specified more than once!\n");
+			errors++;
+			break;
+		}
+		vty_addr_set = 1;
+		di->vty_addr = optarg;
+		break;
+	case 'P':
+		if (di->flags & FRR_NO_TCPVTY)
+			return 1;
+		if (vty_port_set) {
+			fprintf(stderr, "-P option specified more than once!\n");
+			errors++;
+			break;
+		}
+		vty_port_set = 1;
+		di->vty_port = strtoul(optarg, &err, 0);
+		if (*err || !*optarg) {
+			fprintf(stderr, "invalid port number \"%s\" for -P option\n",
+					optarg);
+			errors++;
+			break;
+		}
+		break;
+	case OPTION_VTYSOCK:
+		if (di->vty_sock_path) {
+			fprintf(stderr, "--vty_socket option specified more than once!\n");
+			errors++;
+			break;
+		}
+		di->vty_sock_path = optarg;
+		break;
+	case 'u':
+		if (di->flags & FRR_NO_PRIVSEP)
+			return 1;
+		di->privs->user = optarg;
+		break;
+	case 'g':
+		if (di->flags & FRR_NO_PRIVSEP)
+			return 1;
+		di->privs->group = optarg;
+		break;
+	default:
+		return 1;
+	}
+	return 0;
+}
+
+int frr_getopt(int argc, char * const argv[], int *longindex)
+{
+	int opt;
+	int lidx;
+
+	comb_next_lo->name = NULL;
+
+	do {
+		opt = getopt_long(argc, argv, comb_optstr, comb_lo, &lidx);
+		if (frr_opt(opt))
+			break;
+	} while (opt != -1);
+
+	if (opt == -1 && errors)
+		frr_help_exit(1);
+	if (longindex)
+		*longindex = lidx;
+	return opt;
+}
+
+struct thread_master *frr_init(void)
+{
+	struct thread_master *master;
+
+	srandom(time(NULL));
+
+	openzlog (di->progname, di->logname, di->instance,
+			LOG_CONS|LOG_NDELAY|LOG_PID, LOG_DAEMON);
+#if defined(HAVE_CUMULUS)
+	zlog_set_level (NULL, ZLOG_DEST_SYSLOG, zlog_default->default_lvl);
+#endif
+
+	zprivs_init(di->privs);
+
+	master = thread_master_create();
+	signal_init(master, di->n_signals, di->signals);
+
+	if (di->flags & FRR_LIMITED_CLI)
+		cmd_init(-1);
+	else
+		cmd_init(1);
+	vty_init(master);
+	memory_init();
+
+	return master;
+}
+
+void frr_config_fork(void)
+{
+	if (di->instance) {
+		snprintf(config_default, sizeof(config_default), "%s/%s-%d.conf",
+				frr_sysconfdir, di->name, di->instance);
+		snprintf(pidfile_default, sizeof(pidfile_default), "%s/%s-%d.pid",
+				frr_vtydir, di->name, di->instance);
+	}
+
+	vty_read_config(di->config_file, config_default);
+
+	/* Don't start execution if we are in dry-run mode */
+	if (di->dryrun)
+		exit(0);
+
+	/* Daemonize. */
+	if (di->daemon_mode && daemon (0, 0) < 0) {
+		zlog_err("Zebra daemon failed: %s", strerror(errno));
+		exit(1);
+	}
+
+	if (!di->pid_file)
+		di->pid_file = pidfile_default;
+	pid_output (di->pid_file);
+}
+
+void frr_vty_serv(void)
+{
+	/* allow explicit override of vty_path in the future 
+	 * (not currently set anywhere) */
+	if (!di->vty_path) {
+		const char *dir;
+		dir = di->vty_sock_path ? di->vty_sock_path : frr_vtydir;
+
+		if (di->instance)
+			snprintf(vtypath_default, sizeof(vtypath_default),
+					"%s/%s-%d.vty",
+					dir, di->name, di->instance);
+		else
+			snprintf(vtypath_default, sizeof(vtypath_default),
+					"%s/%s.vty", dir, di->name);
+
+		di->vty_path = vtypath_default;
+	}
+
+	vty_serv_sock(di->vty_addr, di->vty_port, di->vty_path);
+}
+
+void frr_run(struct thread_master *master)
+{
+	char instanceinfo[64] = "";
+
+	frr_vty_serv();
+
+	if (di->instance)
+		snprintf(instanceinfo, sizeof(instanceinfo), "instance %u ",
+				di->instance);
+
+	zlog_notice("%s %s starting: %svty@%d%s",
+			di->name,
+			FRR_VERSION,
+			instanceinfo,
+			di->vty_port,
+			di->startinfo);
+
+	struct thread thread;
+	while (thread_fetch(master, &thread))
+		thread_call(&thread);
+}