1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4 * Copyright (c) 2007-2010, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Header file for config.c.
15 const char *get_dirportfrontpage(void);
16 or_options_t
*get_options(void);
17 int set_options(or_options_t
*new_val
, char **msg
);
18 void config_free_all(void);
19 const char *safe_str_client(const char *address
);
20 const char *safe_str(const char *address
);
21 const char *escaped_safe_str_client(const char *address
);
22 const char *escaped_safe_str(const char *address
);
23 const char *get_version(void);
25 int config_get_lines(const char *string
, config_line_t
**result
);
26 void config_free_lines(config_line_t
*front
);
27 setopt_err_t
options_trial_assign(config_line_t
*list
, int use_defaults
,
28 int clear_first
, char **msg
);
29 int resolve_my_address(int warn_severity
, or_options_t
*options
,
30 uint32_t *addr
, char **hostname_out
);
31 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
32 void options_init(or_options_t
*options
);
33 char *options_dump(or_options_t
*options
, int minimal
);
34 int options_init_from_torrc(int argc
, char **argv
);
35 setopt_err_t
options_init_from_string(const char *cf
,
36 int command
, const char *command_arg
, char **msg
);
37 int option_is_recognized(const char *key
);
38 const char *option_get_canonical_name(const char *key
);
39 config_line_t
*option_get_assignment(or_options_t
*options
,
41 int options_save_current(void);
42 const char *get_torrc_fname(void);
43 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
44 const char *sub1
, const char *sub2
,
46 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
47 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
48 /** Return a newly allocated string containing datadir/sub1. See
49 * get_datadir_fname2_suffix. */
50 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
51 /** Return a newly allocated string containing datadir/sub1/sub2. See
52 * get_datadir_fname2_suffix. */
53 #define get_datadir_fname2(sub1,sub2) \
54 get_datadir_fname2_suffix((sub1), (sub2), NULL)
55 /** Return a newly allocated string containing datadir/sub1suffix. See
56 * get_datadir_fname2_suffix. */
57 #define get_datadir_fname_suffix(sub1, suffix) \
58 get_datadir_fname2_suffix((sub1), NULL, (suffix))
60 or_state_t
*get_or_state(void);
61 int or_state_save(time_t now
);
63 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
64 int getinfo_helper_config(control_connection_t
*conn
,
65 const char *question
, char **answer
,
68 const char *tor_get_digests(void);
69 uint32_t get_effective_bwrate(or_options_t
*options
);
70 uint32_t get_effective_bwburst(or_options_t
*options
);
73 /* Used only by config.c and test.c */
74 or_options_t
*options_new(void);