September 2019 - tor-commits - lists.torproject.org

[tor/master] Re-number VTFLAG_* values so they don't conflict with CVFLAG_*
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 4b92f4c83a27149696e148412e09ae814f96b2eb Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 11:48:42 2019 -0400 Re-number VTFLAG_* values so they don't conflict with CVFLAG_* --- src/lib/conf/conftypes.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index 6d1ce967a..290b5831e 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -153,20 +153,20 @@ typedef struct struct_magic_decl_t { * Flag for var_type_def_t. * Set iff a variable of this type can never be set directly by name. **/ -#define VTFLAG_UNSETTABLE (1u<<0) +#define VTFLAG_UNSETTABLE (1u<<3) /** * Flag for var_type_def_t. * Set iff a variable of this type is always contained in another * variable, and as such doesn't need to be dumped or copied * independently. **/ -#define VTFLAG_CONTAINED (1u<<1) +#define VTFLAG_CONTAINED (1u<<4) /** * Flag for var_type_def_t. * Set iff a variable of this type can be set more than once without * destroying older values. Such variables should implement "mark_fragile". */ -#define VTFLAG_CUMULATIVE (1u<<2) +#define VTFLAG_CUMULATIVE (1u<<5) /** A variable allowed in the configuration file or on the command line. */ typedef struct config_var_t {

1 0

[tor/master] Remove all CVFLAG_* usage.
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 0d6d96396cf4b56bb99b96d39d1c7366792cdbb6 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 11:48:50 2019 -0400 Remove all CVFLAG_* usage. --- src/app/config/config.c | 4 ++-- src/lib/conf/confmacros.h | 3 ++- src/lib/conf/conftypes.h | 12 ------------ 3 files changed, 4 insertions(+), 15 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index 9c93198a4..55e82934e 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -267,10 +267,10 @@ DUMMY_TYPECHECK_INSTANCE(or_options_t); #define VAR_NODUMP(varname,conftype,member,initvalue) \ CONFIG_VAR_ETYPE(or_options_t, varname, conftype, member, \ - CVFLAG_NODUMP, initvalue) + CFLG_NODUMP, initvalue) #define VAR_INVIS(varname,conftype,member,initvalue) \ CONFIG_VAR_ETYPE(or_options_t, varname, conftype, member, \ - CVFLAG_NODUMP|CVFLAG_INVISIBLE, initvalue) + CFLG_NODUMP | CFLG_NOSET | CFLG_NOLIST, initvalue) #define V(member,conftype,initvalue) \ VAR(#member, conftype, member, initvalue) diff --git a/src/lib/conf/confmacros.h b/src/lib/conf/confmacros.h index 2a15f09aa..a32667e1a 100644 --- a/src/lib/conf/confmacros.h +++ b/src/lib/conf/confmacros.h @@ -61,7 +61,8 @@ #define CONFIG_VAR_OBSOLETE(varname) \ { .member = { .name = varname, .type = CONFIG_TYPE_OBSOLETE }, \ - .flags = CVFLAG_OBSOLETE \ + .flags = CFLG_NOSET | CFLG_NOLIST | CFLG_NODUMP | CFLG_NOCOPY | \ + CFLG_NOCMP \ } #endif /* !defined(TOR_LIB_CONF_CONFMACROS_H) */ diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index d8575f364..1f6120670 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -169,18 +169,6 @@ typedef struct struct_magic_decl_t { */ #define CFLG_NOREPLACE (1u<<5) -/* Aliases for old individual options. These will get removed soon. */ -#define CVFLAG_NODUMP CFLG_NODUMP - -/** Set of options to make a flag invisible. */ -#define CVFLAG_INVISIBLE \ - (CFLG_NODUMP | CFLG_NOSET | CFLG_NOLIST) -/** - * Set of flags to indicate that a configuration option is obsolete. - **/ -#define CVFLAG_OBSOLETE \ - (CFLG_NOSET | CFLG_NOLIST | CFLG_NODUMP | CFLG_NOCOPY | CFLG_NOCMP) - /** A variable allowed in the configuration file or on the command line. */ typedef struct config_var_t { struct_member_t member; /** A struct member corresponding to this

1 0

[tor/master] Remove all VTFLAG_* usage.
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 5ca5d196acb4b2b237b9ed4bc38fff8b6dbf2bfd Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 11:48:48 2019 -0400 Remove all VTFLAG_* usage. --- src/lib/conf/conftypes.h | 16 ---------------- src/lib/confmgt/type_defs.c | 19 ++++++++++++++----- 2 files changed, 14 insertions(+), 21 deletions(-) diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index d5ab4e51c..d8575f364 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -171,22 +171,6 @@ typedef struct struct_magic_decl_t { /* Aliases for old individual options. These will get removed soon. */ #define CVFLAG_NODUMP CFLG_NODUMP -#define VTFLAG_CUMULATIVE CFLG_NOREPLACE -#define VTFLAG_UNSETTABLE CFLG_NOSET - -/** - * Set of flags to make a variable "derived" -- so that inspecting this - * variable inspects part of another, and changing this variable changes part - * of another. - * - * Derived variables require special handling in several ways: they do not - * need to be copied independently when we are copying a config object, since - * copying the variable they are derived from copies them too. Similarly, - * they do not need to be compared independently when listing changes, since - * comparing the variable that they are derived from compares them too. - **/ -#define VTFLAG_CONTAINED \ - (CFLG_NOCOPY | CFLG_NOCMP | CFLG_NODUMP) /** Set of options to make a flag invisible. */ #define CVFLAG_INVISIBLE \ diff --git a/src/lib/confmgt/type_defs.c b/src/lib/confmgt/type_defs.c index e311319c0..a0431e4f8 100644 --- a/src/lib/confmgt/type_defs.c +++ b/src/lib/confmgt/type_defs.c @@ -725,13 +725,22 @@ static const var_type_def_t type_definitions_table[] = { [CONFIG_TYPE_CSV_INTERVAL] = { .name="TimeInterval", .fns=&legacy_csv_interval_fns, }, [CONFIG_TYPE_LINELIST] = { .name="LineList", .fns=&linelist_fns, - .flags=VTFLAG_CUMULATIVE }, + .flags=CFLG_NOREPLACE }, + /* + * A "linelist_s" is a derived view of a linelist_v: inspecting + * it gets part of a linelist_v, and setting it adds to the linelist_v. + */ [CONFIG_TYPE_LINELIST_S] = { .name="Dependent", .fns=&linelist_s_fns, - .flags=VTFLAG_CUMULATIVE|VTFLAG_CONTAINED }, + .flags=CFLG_NOREPLACE| + /* The operations we disable here are + * handled by the linelist_v. */ + CFLG_NOCOPY|CFLG_NOCMP|CFLG_NODUMP }, [CONFIG_TYPE_LINELIST_V] = { .name="Virtual", .fns=&linelist_v_fns, - .flags=VTFLAG_CUMULATIVE|VTFLAG_UNSETTABLE }, - [CONFIG_TYPE_OBSOLETE] = { .name="Obsolete", .fns=&ignore_fns, - .flags=VTFLAG_CONTAINED|VTFLAG_UNSETTABLE } + .flags=CFLG_NOREPLACE|CFLG_NOSET }, + [CONFIG_TYPE_OBSOLETE] = { + .name="Obsolete", .fns=&ignore_fns, + .flags=CFLG_NOCOPY|CFLG_NOCMP|CFLG_NODUMP|CFLG_NOSET|CFLG_NOLIST + } }; /**

1 0

[tor/master] confparse, conftypes: Replace flags with their new names.
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 9b571d4729f0a6a6c1040ad9cb3e452ff0a5cee6 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 11:48:46 2019 -0400 confparse, conftypes: Replace flags with their new names. The old names remain as #defines that cause variables to get one or more flags. Now every flag-testing function in confparse.c tests exactly one flag. --- src/app/config/confparse.c | 29 +++++------------------ src/lib/conf/conftypes.h | 59 ++++++++++++++++++++++++++++++++++------------ 2 files changed, 50 insertions(+), 38 deletions(-) diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c index 7579d9ef8..dcbad0b90 100644 --- a/src/app/config/confparse.c +++ b/src/app/config/confparse.c @@ -531,7 +531,7 @@ config_var_has_flag(const config_var_t *var, uint32_t flag) static bool config_var_is_replaced_on_set(const config_var_t *var) { - return ! config_var_has_flag(var, VTFLAG_CUMULATIVE); + return ! config_var_has_flag(var, CFLG_NOREPLACE); } /** @@ -541,7 +541,7 @@ config_var_is_replaced_on_set(const config_var_t *var) bool config_var_is_settable(const config_var_t *var) { - return ! config_var_has_flag(var, CVFLAG_OBSOLETE | VTFLAG_UNSETTABLE); + return ! config_var_has_flag(var, CFLG_NOSET); } /** @@ -562,23 +562,6 @@ config_var_is_gettable(const config_var_t *var) } /** - * Return true iff this is variable is "derived" from another -- that is, - * inspecting this variable inspects part of another, and changing this - * variable changes part of another. - * - * Derived variables require special handling in several ways: they do not - * need to be copied independently when we are copying a config object, since - * copying the variable they are derived from copies them too. Similarly, - * they do not need to be compared independently when listing changes, since - * comparing the variable that they are derived from compares them too. - **/ -static bool -config_var_is_derived(const config_var_t *var) -{ - return config_var_has_flag(var, VTFLAG_CONTAINED); -} - -/** * Return true iff we need to check var for changes when we are * comparing config options for changes. * @@ -589,7 +572,7 @@ config_var_is_derived(const config_var_t *var) static bool config_var_should_list_changes(const config_var_t *var) { - return ! config_var_is_derived(var); + return ! config_var_has_flag(var, CFLG_NOCMP); } /** @@ -603,7 +586,7 @@ config_var_should_list_changes(const config_var_t *var) static bool config_var_needs_copy(const config_var_t *var) { - return ! config_var_is_derived(var); + return ! config_var_has_flag(var, CFLG_NOCOPY); } /**h @@ -613,7 +596,7 @@ config_var_needs_copy(const config_var_t *var) bool config_var_is_listable(const config_var_t *var) { - return ! config_var_has_flag(var, CVFLAG_INVISIBLE); + return ! config_var_has_flag(var, CFLG_NOLIST); } /** @@ -627,7 +610,7 @@ config_var_is_listable(const config_var_t *var) static bool config_var_is_dumpable(const config_var_t *var) { - return ! config_var_has_flag(var, VTFLAG_CONTAINED | CVFLAG_NODUMP); + return ! config_var_has_flag(var, CFLG_NODUMP); } /* diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index 290b5831e..d5ab4e51c 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -132,41 +132,70 @@ typedef struct struct_magic_decl_t { } struct_magic_decl_t; /** - * Flag to indicate that an option is obsolete. Any attempt to set or - * fetch this option should produce a warning. - **/ -#define CVFLAG_OBSOLETE (1u<<0) -/** * Flag to indicate that an option is undumpable. An undumpable option is - * never saved to disk. For historical reasons it is prefixed with __ but - * not with ___. + * never saved to disk. + * + * For historical reasons it is prefixed with __ but not with ___. **/ -#define CVFLAG_NODUMP (1u<<1) +#define CFLG_NODUMP (1u<<0) /** * Flag to indicate that an option is "invisible". An invisible option * is always undumpable, and we don't tell the controller about it. * For historical reasons it is prefixed with ___. **/ -#define CVFLAG_INVISIBLE (1u<<2) +#define CFLG_NOLIST (1u<<1) /** * Flag for var_type_def_t. * Set iff a variable of this type can never be set directly by name. **/ -#define VTFLAG_UNSETTABLE (1u<<3) +#define CFLG_NOSET (1u<<2) /** * Flag for var_type_def_t. - * Set iff a variable of this type is always contained in another - * variable, and as such doesn't need to be dumped or copied - * independently. + * Set iff a variable of this type is does not need to be copied when copying + * the structure that contains it. **/ -#define VTFLAG_CONTAINED (1u<<4) +#define CFLG_NOCOPY (1u<<3) +/** + * Flag for var_type_def_t. + * Set iff a variable of this type does not need to be compared when comparing + * two objects that contain it. + **/ +#define CFLG_NOCMP (1u<<4) /** * Flag for var_type_def_t. * Set iff a variable of this type can be set more than once without * destroying older values. Such variables should implement "mark_fragile". */ -#define VTFLAG_CUMULATIVE (1u<<5) +#define CFLG_NOREPLACE (1u<<5) + +/* Aliases for old individual options. These will get removed soon. */ +#define CVFLAG_NODUMP CFLG_NODUMP +#define VTFLAG_CUMULATIVE CFLG_NOREPLACE +#define VTFLAG_UNSETTABLE CFLG_NOSET + +/** + * Set of flags to make a variable "derived" -- so that inspecting this + * variable inspects part of another, and changing this variable changes part + * of another. + * + * Derived variables require special handling in several ways: they do not + * need to be copied independently when we are copying a config object, since + * copying the variable they are derived from copies them too. Similarly, + * they do not need to be compared independently when listing changes, since + * comparing the variable that they are derived from compares them too. + **/ +#define VTFLAG_CONTAINED \ + (CFLG_NOCOPY | CFLG_NOCMP | CFLG_NODUMP) + +/** Set of options to make a flag invisible. */ +#define CVFLAG_INVISIBLE \ + (CFLG_NODUMP | CFLG_NOSET | CFLG_NOLIST) +/** + * Set of flags to indicate that a configuration option is obsolete. + **/ +#define CVFLAG_OBSOLETE \ + (CFLG_NOSET | CFLG_NOLIST | CFLG_NODUMP | CFLG_NOCOPY | CFLG_NOCMP) /** A variable allowed in the configuration file or on the command line. */ typedef struct config_var_t {

1 0

[tor/master] Revise documentation on CFLG_* flags
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit bbd40e690ee596af60fb38c5e89dec92f6091b1d Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 11:48:52 2019 -0400 Revise documentation on CFLG_* flags --- src/lib/conf/conftypes.h | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index 1f6120670..aabdfdce7 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -132,40 +132,50 @@ typedef struct struct_magic_decl_t { } struct_magic_decl_t; /** - * Flag to indicate that an option is undumpable. An undumpable option is - * never saved to disk. + * Flag to indicate that an option or type is "undumpable". An + * undumpable option is never saved to disk. * - * For historical reasons it is prefixed with __ but not with ___. + * For historical reasons its name is usually is prefixed with __. **/ #define CFLG_NODUMP (1u<<0) /** - * Flag to indicate that an option is "invisible". An invisible option - * is always undumpable, and we don't tell the controller about it. - * For historical reasons it is prefixed with ___. + * Flag to indicate that an option or type is "unlisted". + * + * We don't tell the controller about unlisted options when it asks for a + * list of them. **/ #define CFLG_NOLIST (1u<<1) - /** - * Flag for var_type_def_t. - * Set iff a variable of this type can never be set directly by name. + * Flag to indicate that an option or type is "unsettable". + * + * An unsettable option can never be set directly by name. **/ #define CFLG_NOSET (1u<<2) /** - * Flag for var_type_def_t. - * Set iff a variable of this type is does not need to be copied when copying - * the structure that contains it. + * Flag to indicate that an option or type does not need to be copied when + * copying the structure that contains it. + * + * (Usually, if an option does not need to be copied, then either it contains + * no data, or the data that it does contain is completely contained within + * another option.) **/ #define CFLG_NOCOPY (1u<<3) /** - * Flag for var_type_def_t. - * Set iff a variable of this type does not need to be compared when comparing - * two objects that contain it. + * Flag to indicate that an option or type does not need to be compared + * when telling the controller about the differences between two + * configurations. + * + * (Usually, if an option does not need to be compared, then either it + * contains no data, or the data that it does contain is completely contained + * within another option.) **/ #define CFLG_NOCMP (1u<<4) /** - * Flag for var_type_def_t. - * Set iff a variable of this type can be set more than once without - * destroying older values. Such variables should implement "mark_fragile". + * Flag to indicate that an option or type should not be replaced when setting + * it. + * + * For most options, setting them replaces their old value. For some options, + * however, setting them appends to their old value. */ #define CFLG_NOREPLACE (1u<<5)

1 0

[tor/master] Replace low-level {var_type, struct_var}_is_*() with flag inspection
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 1b3b6d9f2d94e659375257a5c439d250ce0075fd Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 11:48:44 2019 -0400 Replace low-level {var_type,struct_var}_is_*() with flag inspection Since the flags are now stored with compatible numbering, we can just OR them together and see whether the flag we want is in the result. (Net code removal!) --- src/app/config/confparse.c | 29 ++++++++++++++++++----------- src/lib/confmgt/structvar.c | 23 ++++------------------- src/lib/confmgt/structvar.h | 5 ++--- src/lib/confmgt/typedvar.c | 29 ----------------------------- src/lib/confmgt/typedvar.h | 4 ---- 5 files changed, 24 insertions(+), 66 deletions(-) diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c index 2c8779bbe..7579d9ef8 100644 --- a/src/app/config/confparse.c +++ b/src/app/config/confparse.c @@ -512,6 +512,18 @@ config_count_options(const config_mgr_t *mgr) } /** + * Return true iff at least one bit from flag is set on var, + * either in var's flags, or on the flags of its type. + **/ +static bool +config_var_has_flag(const config_var_t *var, uint32_t flag) +{ + uint32_t have_flags = var->flags | struct_var_get_flags(&var->member); + + return (have_flags & flag) != 0; +} + +/** * Return true if assigning a value to var replaces the previous * value. Return false if assigning a value to var appends * to the previous value. @@ -519,7 +531,7 @@ config_count_options(const config_mgr_t *mgr) static bool config_var_is_replaced_on_set(const config_var_t *var) { - return ! struct_var_is_cumulative(&var->member); + return ! config_var_has_flag(var, VTFLAG_CUMULATIVE); } /** @@ -529,9 +541,7 @@ config_var_is_replaced_on_set(const config_var_t *var) bool config_var_is_settable(const config_var_t *var) { - if (var->flags & CVFLAG_OBSOLETE) - return false; - return struct_var_is_settable(&var->member); + return ! config_var_has_flag(var, CVFLAG_OBSOLETE | VTFLAG_UNSETTABLE); } /** @@ -546,7 +556,7 @@ config_var_is_gettable(const config_var_t *var) * have compatibility effects. For now, let's leave them alone. */ - // return (var->flags & (CVFLAG_OBSOLETE|CFGLAGS_INVISIBLE)) == 0; + // return ! config_var_has_flag(var, CVFLAG_OBSOLETE|CFGLAGS_INVISIBLE); (void)var; return true; } @@ -565,7 +575,7 @@ config_var_is_gettable(const config_var_t *var) static bool config_var_is_derived(const config_var_t *var) { - return struct_var_is_contained(&var->member); + return config_var_has_flag(var, VTFLAG_CONTAINED); } /** @@ -603,7 +613,7 @@ config_var_needs_copy(const config_var_t *var) bool config_var_is_listable(const config_var_t *var) { - return (var->flags & CVFLAG_INVISIBLE) == 0; + return ! config_var_has_flag(var, CVFLAG_INVISIBLE); } /** @@ -617,10 +627,7 @@ config_var_is_listable(const config_var_t *var) static bool config_var_is_dumpable(const config_var_t *var) { - if (config_var_is_derived(var)) { - return false; - } - return (var->flags & CVFLAG_NODUMP) == 0; + return ! config_var_has_flag(var, VTFLAG_CONTAINED | CVFLAG_NODUMP); } /* diff --git a/src/lib/confmgt/structvar.c b/src/lib/confmgt/structvar.c index 6b725f613..cb37f540b 100644 --- a/src/lib/confmgt/structvar.c +++ b/src/lib/confmgt/structvar.c @@ -238,26 +238,11 @@ struct_var_get_typename(const struct_member_t *member) return def ? def->name : NULL; } -bool -struct_var_is_cumulative(const struct_member_t *member) -{ - const var_type_def_t *def = get_type_def(member); - - return def ? var_type_is_cumulative(def) : false; -} - -bool -struct_var_is_settable(const struct_member_t *member) -{ - const var_type_def_t *def = get_type_def(member); - - return def ? var_type_is_settable(def) : true; -} - -bool -struct_var_is_contained(const struct_member_t *member) +/** Return all of the flags set for this struct member. */ +uint32_t +struct_var_get_flags(const struct_member_t *member) { const var_type_def_t *def = get_type_def(member); - return def ? var_type_is_contained(def) : false; + return def ? def->flags : 0; } diff --git a/src/lib/confmgt/structvar.h b/src/lib/confmgt/structvar.h index e6dbc6d6e..201211f79 100644 --- a/src/lib/confmgt/structvar.h +++ b/src/lib/confmgt/structvar.h @@ -17,6 +17,7 @@ struct struct_member_t; struct config_line_t; #include <stdbool.h> +#include "lib/cc/torint.h" void struct_set_magic(void *object, const struct struct_magic_decl_t *decl); @@ -45,9 +46,7 @@ void struct_var_mark_fragile(void *object, const char *struct_var_get_name(const struct struct_member_t *member); const char *struct_var_get_typename(const struct struct_member_t *member); -bool struct_var_is_cumulative(const struct struct_member_t *member); -bool struct_var_is_settable(const struct struct_member_t *member); -bool struct_var_is_contained(const struct struct_member_t *member); +uint32_t struct_var_get_flags(const struct struct_member_t *member); int struct_var_kvassign(void *object, const struct config_line_t *line, char **errmsg, diff --git a/src/lib/confmgt/typedvar.c b/src/lib/confmgt/typedvar.c index 751d15827..219a2d15b 100644 --- a/src/lib/confmgt/typedvar.c +++ b/src/lib/confmgt/typedvar.c @@ -225,32 +225,3 @@ typed_var_mark_fragile(void *value, const var_type_def_t *def) if (def->fns->mark_fragile) def->fns->mark_fragile(value, def->params); } - -/** - * Return true iff multiple assignments to a variable will extend its - * value, rather than replacing it. - **/ -bool -var_type_is_cumulative(const var_type_def_t *def) -{ - return (def->flags & VTFLAG_CUMULATIVE) != 0; -} - -/** - * Return true iff this variable type is always contained in another variable, - * and as such doesn't need to be dumped or copied independently. - **/ -bool -var_type_is_contained(const var_type_def_t *def) -{ - return (def->flags & VTFLAG_CONTAINED) != 0; -} - -/** - * Return true iff this type can not be assigned directly by the user. - **/ -bool -var_type_is_settable(const var_type_def_t *def) -{ - return (def->flags & VTFLAG_UNSETTABLE) == 0; -} diff --git a/src/lib/confmgt/typedvar.h b/src/lib/confmgt/typedvar.h index 23fd8c13e..22f2e3c58 100644 --- a/src/lib/confmgt/typedvar.h +++ b/src/lib/confmgt/typedvar.h @@ -35,8 +35,4 @@ struct config_line_t *typed_var_kvencode(const char *key, const void *value, void typed_var_mark_fragile(void *value, const var_type_def_t *def); -bool var_type_is_cumulative(const var_type_def_t *def); -bool var_type_is_contained(const var_type_def_t *def); -bool var_type_is_settable(const var_type_def_t *def); - #endif /* !defined(TOR_LIB_CONFMGT_TYPEDVAR_H) */

1 0

[tor/master] Test: Make sure NOLIST options are not listed.
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 5ffe6ec0e34fdddbc56d7699ce21c3a763f22198 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Sep 5 12:29:24 2019 -0400 Test: Make sure NOLIST options are not listed. --- src/test/test_config.c | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/test/test_config.c b/src/test/test_config.c index 58e05e509..9b715b2ec 100644 --- a/src/test/test_config.c +++ b/src/test/test_config.c @@ -5983,6 +5983,31 @@ test_config_kvline_parse(void *arg) tor_free(enc); } +static void +test_config_getinfo_config_names(void *arg) +{ + (void)arg; + char *answer = NULL; + const char *error = NULL; + int rv; + + rv = getinfo_helper_config(NULL, "config/names", &answer, &error); + tt_int_op(rv, OP_EQ, 0); + tt_ptr_op(error, OP_EQ, NULL); + + // ContactInfo should be listed. + tt_assert(strstr(answer, "\nContactInfo String\n")); + + // V1AuthoritativeDirectory should not be listed, since it is obsolete. + tt_assert(! strstr(answer, "V1AuthoritativeDirectory")); + + // ___UsingTestNetworkDefaults should not be listed, since it is invisible. + tt_assert(! strstr(answer, "UsingTestNetworkDefaults")); + + done: + tor_free(answer); +} + #define CONFIG_TEST(name, flags) \ { #name, test_config_ ## name, flags, NULL, NULL } @@ -6035,5 +6060,6 @@ struct testcase_t config_tests[] = { CONFIG_TEST(compute_max_mem_in_queues, 0), CONFIG_TEST(extended_fmt, 0), CONFIG_TEST(kvline_parse, 0), + CONFIG_TEST(getinfo_config_names, 0), END_OF_TESTCASES };

1 0

[tor/master] Document inconsistent usage of config_var_is_listable()
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit 478141e617a333ac4d998e3747c073246e04b5ae Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Sep 10 10:29:34 2019 -0400 Document inconsistent usage of config_var_is_listable() See also ticket 31654. --- src/app/config/config.c | 7 +++++++ src/app/config/confparse.c | 6 ++++++ 2 files changed, 13 insertions(+) diff --git a/src/app/config/config.c b/src/app/config/config.c index 55e82934e..72a1190b5 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2666,6 +2666,9 @@ list_torrc_options(void) { smartlist_t *vars = config_mgr_list_vars(get_options_mgr()); SMARTLIST_FOREACH_BEGIN(vars, const config_var_t *, var) { + /* Possibly this should check listable, rather than (or in addition to) + * settable. See ticket 31654. + */ if (! config_var_is_settable(var)) { /* This variable cannot be set, or cannot be set by this name. */ continue; @@ -2680,6 +2683,8 @@ static void list_deprecated_options(void) { smartlist_t *deps = config_mgr_list_deprecated_vars(get_options_mgr()); + /* Possibly this should check whether the variables are listable, + * but currently it does not. See ticket 31654. */ SMARTLIST_FOREACH(deps, const char *, name, printf("%s\n", name)); smartlist_free(deps); @@ -8142,6 +8147,8 @@ getinfo_helper_config(control_connection_t *conn, } else if (!strcmp(question, "config/defaults")) { smartlist_t *sl = smartlist_new(); int dirauth_lines_seen = 0, fallback_lines_seen = 0; + /* Possibly this should check whether the variables are listable, + * but currently it does not. See ticket 31654. */ smartlist_t *vars = config_mgr_list_vars(get_options_mgr()); SMARTLIST_FOREACH_BEGIN(vars, const config_var_t *, var) { if (var->initvalue != NULL) { diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c index 930484620..9f7fdc5c3 100644 --- a/src/app/config/confparse.c +++ b/src/app/config/confparse.c @@ -592,6 +592,12 @@ config_var_needs_copy(const config_var_t *var) /** * Return true iff variable var should appear on list of variable * names given to the controller or the CLI. + * + * (Note that this option is imperfectly obeyed. The + * --list-torrc-options command looks at the "settable" flag, whereas + * "GETINFO config/defaults" and "list_deprecated_*()" do not filter + * their results. It would be good for consistency to try to converge + * these behaviors in the future.) **/ bool config_var_is_listable(const config_var_t *var)

1 0

[tor/master] Extract common list of flags to use for obsolete variables.
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit e61bfd0bfd1acfdd4f5d5912c5cc2c0e8ec61b75 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Sep 10 09:51:07 2019 -0400 Extract common list of flags to use for obsolete variables. --- src/lib/conf/confmacros.h | 3 +-- src/lib/conf/conftypes.h | 6 ++++++ src/lib/confmgt/type_defs.c | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/src/lib/conf/confmacros.h b/src/lib/conf/confmacros.h index a32667e1a..68121891f 100644 --- a/src/lib/conf/confmacros.h +++ b/src/lib/conf/confmacros.h @@ -61,8 +61,7 @@ #define CONFIG_VAR_OBSOLETE(varname) \ { .member = { .name = varname, .type = CONFIG_TYPE_OBSOLETE }, \ - .flags = CFLG_NOSET | CFLG_NOLIST | CFLG_NODUMP | CFLG_NOCOPY | \ - CFLG_NOCMP \ + .flags = CFLG_GROUP_OBSOLETE \ } #endif /* !defined(TOR_LIB_CONF_CONFMACROS_H) */ diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index aabdfdce7..274065cff 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -179,6 +179,12 @@ typedef struct struct_magic_decl_t { */ #define CFLG_NOREPLACE (1u<<5) +/** + * A group of flags that should be set on all obsolete options and types. + **/ +#define CFLG_GROUP_OBSOLETE \ + (CFLG_NOCOPY|CFLG_NOCMP|CFLG_NODUMP|CFLG_NOSET|CFLG_NOLIST) + /** A variable allowed in the configuration file or on the command line. */ typedef struct config_var_t { struct_member_t member; /** A struct member corresponding to this diff --git a/src/lib/confmgt/type_defs.c b/src/lib/confmgt/type_defs.c index a0431e4f8..324b62e56 100644 --- a/src/lib/confmgt/type_defs.c +++ b/src/lib/confmgt/type_defs.c @@ -739,7 +739,7 @@ static const var_type_def_t type_definitions_table[] = { .flags=CFLG_NOREPLACE|CFLG_NOSET }, [CONFIG_TYPE_OBSOLETE] = { .name="Obsolete", .fns=&ignore_fns, - .flags=CFLG_NOCOPY|CFLG_NOCMP|CFLG_NODUMP|CFLG_NOSET|CFLG_NOLIST + .flags=CFLG_GROUP_OBSOLETE, } };

1 0

[tor/master] Clarify documentation on config_var_is_listable()
by dgoulet＠torproject.org 11 Sep '19

11 Sep '19

commit fe5033d3b0f618493ec8ffd4274352ed42835bdb Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Sep 10 09:39:09 2019 -0400 Clarify documentation on config_var_is_listable() Here we make it clear we're only looking at listable variable names, not at whether the variables themselves are gettable. Also, remove an extraneous h. (This commit is not a fixup, because of rebase conflicts.) --- src/app/config/confparse.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c index dcbad0b90..930484620 100644 --- a/src/app/config/confparse.c +++ b/src/app/config/confparse.c @@ -589,9 +589,9 @@ config_var_needs_copy(const config_var_t *var) return ! config_var_has_flag(var, CFLG_NOCOPY); } -/**h - * Return true iff variable var should appear on list of variables - * given to the controller or the CLI. +/** + * Return true iff variable var should appear on list of variable + * names given to the controller or the CLI. **/ bool config_var_is_listable(const config_var_t *var)

1 0