Commit Graph

30 Commits

Author SHA1 Message Date
Jason Rhinelander
af6caf776a
Config file improvements (#1397)
* Config file API/comment improvements

API improvements:
=================

Make the config API use position-independent tag parameters (Required,
Default{123}, MultiValue) rather than a sequence of bools with
overloads.  For example, instead of:

    conf.defineOption<int>("a", "b", false, true, 123, [] { ... });

you now write:

    conf.defineOption<int>("a", "b", MultiValue, Default{123}, [] { ... });

The tags are:
- Required
- MultiValue
- Default{value}
plus new abilities (see below):
- Hidden
- RelayOnly
- ClientOnly
- Comment{"line1", "line2", "line3"}

Made option definition more powerful:
=====================================

- `Hidden` allows you to define an option that won't show up in the
  generated config file if it isn't set.

- `RelayOnly`/`ClientOnly` sets up an option that is only accepted and
  only shows up for relay or client configs.  (If neither is specified
  the option shows up in both modes).

- `Comment{...}` lets the option comments be specified as part of the
  defineOption.

Comment improvements
====================

- Rewrote comments for various options to expand on details.
- Inlined all the comments with the option definitions.
- Several options that were missing comments got comments added.
- Made various options for deprecated and or internal options hidden by
  default so that they don't show up in a default config file.
- show the section comment (but not option comments) *after* the
  [section] tag instead of before it as it makes more sense that way
  (particularly for the [bind] section which has a new long comment to
  describe how it works).

Disable profiling by default
============================

We had this weird state where we use and store profiling by default but
never *load* it when starting up.  This commit makes us just not use
profiling at all unless explicitly enabled.

Other misc changes:
===================

- change default worker threads to 0 (= num cpus) instead of 1, and fix
  it to allow 0.
- Actually apply worker-threads option
- fixed default data-dir value erroneously having quotes around it
- reordered ifname/ifaddr/mapaddr (was previously mapaddr/ifaddr/ifname)
  as mapaddr is a sort of specialization of ifaddr and so makes more
  sense to come after it (particularly because it now references ifaddr
  in its help message).
- removed peer-stats option (since we always require it for relays and
  never use it for clients)
- removed router profiles filename option (this doesn't need to be
  configurable)
- removed defunct `service-node-seed` option
- Change default logging output file to "" (which means stdout), and
  also made "-" work for stdout.

* Router hive compilation fixes

* Comments for SNApp SRV settings in ini file

* Add extra blank line after section comments

* Better deprecated option handling

Allow {client,relay}-only options in {relay,client} configs to be
specified as implicitly deprecated options: they warn, and don't set
anything.

Add an explicit `Deprecated` tag and move deprecated option handling
into definition.cpp.

* Move backwards compat options into section definitions

Keep the "addBackwardsCompatibleConfigOptions" only for options in
sections that no longer exist.

* Fix INI parsing issues & C++17-ify

- don't allow inline comments because it seems they aren't allowed in
ini formats in general, and is going to cause problems if there is a
comment character in a value (e.g. an exit auth string).  Additionally
it was breaking on a line such as:

    # some comment; see?

because it was treating only `; see?` as the comment and then producing
an error message about the rest of the line being invalid.

- make section parsing stricter: the `[` and `]` have to be at the
beginning at end of the line now (after stripping whitespace).

- Move whitespace stripping to the top since everything in here does it.

- chop off string_view suffix/prefix rather than maintaining position
values

- fix potential infinite loop/segfault when given a line such as `]foo[`

* Make config parsing failure fatal

Load() LogError's and returns false on failure, so we weren't aborting
on config file errors.

* Formatting: allow `{}` for empty functions/structs

Instead of using two lines when empty:

    {
    }

* Make default dns bind 127.0.0.1 on non-Linux

* Don't show empty section; fix tests

We can conceivably have sections that only make sense for clients or
relays, and so want to completely omit that section if we have no
options for the type of config being generated.

Also fixes missing empty lines between tests.

Co-authored-by: Thomas Winget <tewinget@gmail.com>
2020-10-07 18:22:58 -04:00
Jeff
78b40d6725 wire up lns gotnamemessage handler to kitchen sink 2020-09-19 09:29:36 -04:00
Thomas Winget
b1c14af938
SRV Record handling for introsets (#1331)
* update loki-mq submodule for tuple support

* srv record reply implementation

still need to encode srv records into intro sets / router contacts
as well as decode from them and match against queried service.proto

* inverted condition fix in config code

* SRV record struct (de-)serialization for intro sets

* parsing and using srv records from config (for/in introsets)

* adopt str utils from core and use for srv parsing

* changes to repeat requests

no longer drop repeat requests on the floor, but do not make
an *actual* request for them if one is in progress.

do not call reply hook for each reply for a request, as
each userland request is actually made into several lokinet
requests and this would result in duplicate replies.

* fetch SRVs from introsets for .loki

* make format

* dns and srv fixes, srv appears to be working
2020-08-31 16:07:17 -04:00
Jason Rhinelander
ebd2142114 Don't use std::optional::value() because f u macos
This replaces all use of std::optional's `opt.value()` with `*opt`
because macOS is great and the ghost of Steve Jobs says that actually
supporting std::optional's value() method is not for chumps before macOS
10.14.  So don't use it because Apple is great.

Pretty much all of our use of it actually is done better with operator*
anyway (since operator* doesn't do a check that the optional has a
value).

Also replaced *most* of the `has_value()` calls with direct bool
context, except for one in the config section which looked really
confusing at a glance without a has_value().
2020-05-20 19:18:28 -03:00
Stephen Shelton
78eb0d976d
nonstd::optional -> std::optional 2020-05-04 09:21:26 -06:00
Stephen Shelton
15918ff1c9
log-- 2020-05-04 11:07:21 -04:00
Stephen Shelton
559610ec94
Properly handle empty config default values 2020-05-04 11:07:21 -04:00
Jason Rhinelander
1697bf90fe C++17
Compiles with C++17, replaces ghc::filesystem with std::filesystem,
nonstd::optional with std::optional, and llarp::string_view with
std::string_view.
2020-05-01 17:43:27 -03:00
Stephen Shelton
320564d792
Specialize ConfigOption for bool to accept "truthy" / "falsy" values 2020-04-29 12:32:07 -06:00
Stephen Shelton
de8e44ba21
Re-apply clang-format rules after rebasing 2020-04-07 14:41:11 -06:00
Stephen Shelton
0a9515a94a
Proper support for multiple values @ ConfigDefinition 2020-04-07 14:25:20 -06:00
Stephen Shelton
3739fc1d70
Reinstate multi-valued option 2020-04-07 14:24:50 -06:00
Stephen Shelton
a6787657be
Refactor config comments to take list of strings 2020-04-07 14:24:49 -06:00
Stephen Shelton
a8671cf9c7
Rename config classes for clarity
ConfigDefinition -> OptionDefiniton
Configuration -> ConfigDefinition
2020-04-07 14:24:49 -06:00
Stephen Shelton
9e850705b4
Add 'AssignmentAcceptor' convenience for simple config acceptors 2020-04-07 14:20:59 -06:00
Stephen Shelton
18ee23c2a3
Support for comments in config definition 2020-04-07 14:11:58 -06:00
Stephen Shelton
9a1b7b20de
Add "undeclared value" handler to Configuration 2020-04-07 14:09:14 -06:00
Stephen Shelton
69331f1571
Remove multiValued as an argument to ConfigDefinition 2020-04-07 14:01:45 -06:00
Stephen Shelton
f6d000838f
Clarity and convenience for defining config options 2020-04-07 14:01:45 -06:00
Stephen Shelton
02e31f3867
Introduce acceptor function in ConfigDefinition 2020-04-07 14:01:44 -06:00
Stephen Shelton
60d0bf2a9b
Rename function for clarity 2020-04-07 14:01:44 -06:00
Stephen Shelton
8160c13458
More documentation around Configuration/ConfigDefinition 2020-04-07 14:01:44 -06:00
Stephen Shelton
8352de7bd4
Config documentation, clarity 2020-04-07 14:01:43 -06:00
Stephen Shelton
d9340a873e
Consolidate Configuration generate INI functions 2020-04-07 14:01:43 -06:00
Stephen Shelton
1b19314278
Implement Configuration::generateDefaultConfig(), maintain insertion order 2020-04-07 14:01:43 -06:00
Stephen Shelton
7dacc30862
Conveience and clarity around config definiton maps 2020-04-07 14:01:42 -06:00
Stephen Shelton
105dd30fd9
More ConfigDefinition unit tests, fixes, support std::string as type 2020-04-07 14:01:42 -06:00
Stephen Shelton
25212b929c
Add ConfigDefinition unit tests, fixes 2020-04-07 14:01:41 -06:00
Stephen Shelton
a856e772c8
Stylistic clean up 2020-04-07 14:01:41 -06:00
Stephen Shelton
0fb888890f
First pass at Configuration definition classes 2020-04-07 14:01:41 -06:00