]>
git.proxmox.com Git - mirror_frr.git/blob - lib/libfrr.h
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
32 #define FRR_NO_PRIVSEP (1 << 0)
33 #define FRR_NO_TCPVTY (1 << 1)
34 #define FRR_LIMITED_CLI (1 << 2)
35 #define FRR_NO_CFG_PID_DRY (1 << 3)
36 #define FRR_NO_ZCLIENT (1 << 4)
38 struct frr_daemon_info
{
44 unsigned short instance
;
45 struct frrmod_runtime
*module
;
53 const char *config_file
;
56 const char *module_path
;
59 void (*printhelp
)(FILE *target
);
60 const char *copyright
;
63 struct quagga_signal_t
*signals
;
66 struct zebra_privs_t
*privs
;
69 /* execname is the daemon's executable (and pidfile and configfile) name,
70 * i.e. "zebra" or "bgpd"
71 * constname is the daemons source-level name, primarily for the logging ID,
72 * i.e. "ZEBRA" or "BGP"
74 * note that this macro is also a latch-on point for other changes (e.g.
75 * upcoming module support) that need to place some per-daemon things. Each
76 * daemon should have one of these.
78 #define FRR_DAEMON_INFO(execname, constname, ...) \
79 static struct frr_daemon_info execname##_di = {.name = #execname, \
80 .logname = #constname, \
81 .module = THIS_MODULE, \
83 FRR_COREMOD_SETUP(.name = #execname, \
84 .description = #execname " daemon", \
85 .version = FRR_VERSION, ) \
88 extern void frr_preinit(struct frr_daemon_info
*daemon
, int argc
, char **argv
);
89 extern void frr_opt_add(const char *optstr
, const struct option
*longopts
,
91 extern int frr_getopt(int argc
, char *const argv
[], int *longindex
);
92 extern void frr_help_exit(int status
);
94 extern struct thread_master
*frr_init(void);
96 DECLARE_HOOK(frr_late_init
, (struct thread_master
* tm
), (tm
))
97 extern void frr_config_fork(void);
99 extern void frr_vty_serv(void);
101 /* note: contains call to frr_vty_serv() */
102 extern void frr_run(struct thread_master
*master
);
104 extern bool frr_zclient_addr(struct sockaddr_storage
*sa
, socklen_t
*sa_len
,
107 /* these two are before the protocol daemon does its own shutdown
108 * it's named this way being the counterpart to frr_late_init */
109 DECLARE_KOOH(frr_early_fini
, (), ())
110 extern void frr_early_fini(void);
111 /* and these two are after the daemon did its own cleanup */
112 DECLARE_KOOH(frr_fini
, (), ())
113 extern void frr_fini(void);
115 extern char config_default
[256];
116 extern char frr_zclientpath
[256];
117 extern const char frr_sysconfdir
[];
118 extern const char frr_vtydir
[];
119 extern const char frr_moduledir
[];
121 extern char frr_protoname
[];
122 extern char frr_protonameinst
[];
124 #endif /* _ZEBRA_FRR_H */