main_config.h File Reference

Structures and prototypes for map functions. More...

#include <freeradius-devel/server/cf_util.h>
#include <freeradius-devel/server/tmpl.h>
#include <freeradius-devel/util/dict.h>
#include <freeradius-devel/io/worker.h>

Include dependency graph for main_config.h:

Go to the source code of this file.

Data Structures
struct	main_config_s
	Main server configuration. More...

Macros
#define	MAX_REQUEST_TIME   30
	Default maximum request time.

Typedefs
typedef struct main_config_s	main_config_t

Functions
void	hup_logfile (main_config_t *config)
main_config_t *	main_config_alloc (TALLOC_CTX *ctx)
	Allocate a main_config_t struct, setting defaults.
void	main_config_dict_dir_set (main_config_t *config, char const *path)
	Set the global dictionary directory.
int	main_config_exclusive_proc (main_config_t *config)
	Check to see if we're the only process using this configuration file (or PID file if specified)
int	main_config_exclusive_proc_child (main_config_t const *config)
void	main_config_exclusive_proc_done (main_config_t const *config)
int	main_config_free (main_config_t **config)
void	main_config_hup (main_config_t *config)
int	main_config_init (main_config_t *config)
bool	main_config_migrate_option_get (char const *name)
void	main_config_name_set_default (main_config_t *config, char const *name, bool overwrite_config)
	Set the server name.
int	main_config_parse_option (char const *value)
void	main_config_raddb_dir_set (main_config_t *config, char const *path)
	Set the global radius config directory.

Variables
main_config_t const *	main_config
	Global configuration singleton.

Detailed Description

Structures and prototypes for map functions.

Id

73be934fa2d79e352537b3cac1f32fc6e9c749fc

Copyright

2018 The FreeRADIUS server project

Definition in file main_config.h.

---

Data Structure Documentation

main_config_s

struct main_config_s

Main server configuration.

The parsed version of the main server config.

Definition at line 51 of file main_config.h.

Collaboration diagram for main_config_s:

Data Fields
bool	allow_core_dumps	Whether the server is allowed to drop a core when receiving a fatal signal.
bool	allow_multiple_procs	Allow multiple instances of radiusd to run with the same config file.
char const *	chdir	where to chdir() to when we start.
bool	chdir_is_set
bool	daemonize	Should the server daemonize on startup.
uint32_t	debug_level	The base log level for the server.
fr_dict_t *	dict	Main dictionary.
char const *	dict_dir	Where to load dictionaries from.
bool	do_colourise
bool	drop_requests	Administratively disable request processing.
bool	hostname_lookups
bool	ins_countup	count up to "max"
uint32_t	ins_max	max instruction count
char const *	lib_dir
char const *	local_state_dir
bool	log_dates_utc
char const *	log_dest
char const *	log_dir
char const *	log_file
bool	log_line_number	Log src file/line the message was generated on.
bool	log_timestamp
bool	log_timestamp_is_set
uint32_t	max_networks	for the scheduler
uint32_t	max_workers	for the scheduler
int	multi_proc_sem_id	Semaphore we use to prevent multiple processes running.
char *	multi_proc_sem_path	Semaphore path.
char const *	name	Name of the daemon, usually 'radiusd'.
bool	overwrite_config_name	Overwrite the configured name, as this was specified by the user on the command line.
char const *	panic_action	Command to execute if the server receives a fatal signal.
char const *	pid_file	Path to write out PID file.
char const *	prefix
char const *	radacct_dir
char const *	raddb_dir	Path to raddb directory.
bool	reverse_lookups
CONF_SECTION *	root_cs	Root of the server config.
char const *	run_dir
char const *	sbin_dir
bool	spawn_workers	Should the server spawn threads.
fr_time_delta_t	stats_interval	for the scheduler
bool	suppress_secrets	suppress secrets (or not)
int32_t	syslog_facility
bool	talloc_memory_report	Print a memory report on what's left unfreed. Can only be used when the server is running in single threaded mode.
fr_worker_config_t	worker	Worker thread configuration.
bool	write_pid	write the PID file

Macro Definition Documentation

MAX_REQUEST_TIME

#define MAX_REQUEST_TIME   30

Default maximum request time.

Definition at line 35 of file main_config.h.

Typedef Documentation

main_config_t

typedef struct main_config_s main_config_t

Definition at line 37 of file main_config.h.

Function Documentation

hup_logfile()

void hup_logfile

(

main_config_t *

config

)

Definition at line 1395 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_alloc()

main_config_t * main_config_alloc

(

TALLOC_CTX *

ctx

)

Allocate a main_config_t struct, setting defaults.

Definition at line 973 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_dict_dir_set()

void main_config_dict_dir_set	(	main_config_t *	config,
		char const *	name
	)

Set the global dictionary directory.

Parameters

[in]	config	to alter.
[in]	name	to set as dict dir root e.g. /usr/local/share/freeradius.

Definition at line 961 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_exclusive_proc()

int main_config_exclusive_proc

(

main_config_t *

config

)

Check to see if we're the only process using this configuration file (or PID file if specified)

Parameters

[in]

config

specifying the path to the main config file.

Returns

• 1 if another process is running with this config file
• 0 if no other process is running with this config file.
• -1 on error.

Definition at line 886 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_exclusive_proc_child()

int main_config_exclusive_proc_child

(

main_config_t const *

config

)

main_config_exclusive_proc_done()

void main_config_exclusive_proc_done

(

main_config_t const *

config

)

main_config_free()

int main_config_free

(

main_config_t **

config

)

Definition at line 1371 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_hup()

void main_config_hup

(

main_config_t *

config

)

Definition at line 1417 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_init()

int main_config_init

(

main_config_t *

config

)

Definition at line 1006 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_migrate_option_get()

bool main_config_migrate_option_get

(

char const *

name

)

Definition at line 1491 of file main_config.c.

Here is the caller graph for this function:

main_config_name_set_default()

void main_config_name_set_default	(	main_config_t *	config,
		char const *	name,
		bool	overwrite_config
	)

Set the server name.

Note

Will only add pair if one does not already exist

Parameters

[in]	config	to alter.
[in]	name	to set e.g. "radiusd".
[in]	overwrite_config	replace any CONF_PAIRs with this value.

Definition at line 813 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_parse_option()

int main_config_parse_option

(

char const *

value

)

Definition at line 1456 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

main_config_raddb_dir_set()

void main_config_raddb_dir_set	(	main_config_t *	config,
		char const *	name
	)

Set the global radius config directory.

Parameters

[in]	config	to alter.
[in]	name	to set as dir root e.g. /usr/local/etc/raddb.

Definition at line 832 of file main_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

main_config

main_config_t const* main_config

extern

Global configuration singleton.

Global configuration singleton.

Definition at line 58 of file main_config.c.