See: tor#40048.

David Goulet authored 4 years ago and Alexander Hansen Færøy committed 4 years ago

Create a doc/tracing/ directory to contain a top level README.md which is the
previously named Tracing.md and add the EventsCircuit.md which describes the
circuit subsystem tracing events in depth.

Closes #40036

Signed-off-by: David Goulet <dgoulet@torproject.org>

Only log the 'real_addr' when it is set to something.

Only log the ID when it is set.

When scrubbing the address, don't include a canonical address.
(There should never be a canonical address for a connection with no
ID set.)

Closes #40041.

Since we can list the real address and the canonical one in a
human-readable format we don't need to pick.

Now that we've clarified that these functions only need to describe
the peer in a human-readable way, we can have them delegate to
connection_describe_peer().

This mode was only used in one place, and it caused a dangerous
mingling of functionality.  The method is supposed to _describe_ the
peer's address, not give its actual address.  We already had a
function to get the actual address.

* We no longer call this an optional method
* We document that it returns the real address, not a canonical one.
* We have it try harder if the real address hasn't been set yet.

These will let us refactor away a lot of code that currently uses
"addr" and "address" for logging purposes.

See: https://bugs.torproject.org/tpo/core/tor/33781

This patch ensures that we strip "\r" characters on both Windows as well
as Unix when we read text files. This should prevent the issue where
some Tor state files have been moved from a Windows machine, and thus
contains CRLF line ending, to a Unix machine where only \n is needed.

We add a test-case to ensure that we handle this properly on all our
platforms.

See: https://bugs.torproject.org/tpo/core/tor/33781

David Goulet authored 4 years ago and Nick Mathewson committed 4 years ago

Closes #40033

Signed-off-by: David Goulet <dgoulet@torproject.org>

Pass the IPv4 before the IPv6 like all our other interfaces.

Changes unreleased code related to #40043.

Closes #40045

Signed-off-by: David Goulet <dgoulet@torproject.org>

This changes a LOT of code but in the end, behavior is the same.
Unfortunately, many functions had to be changed to accomodate but in majority
of cases, to become simpler.

Functions are also removed specifically those that were there to convert an
IPv4 as a host format to a tor_addr_t. Those are not needed anymore.

The IPv4 address field has been standardized to "ipv4_addr", the ORPort to
"ipv4_orport" (currently IPv6 uses ipv6_orport) and DirPort to "ipv4_dirport".

This is related to Sponsor 55 work that adds IPv6 support for relays and this
work is needed in order to have a common interface between IPv4 and IPv6.

Closes #40043.

Signed-off-by: David Goulet <dgoulet@torproject.org>

Remove all the escape character "\" which is not needed for Markdown files.
This also fixes the tracing event include to the correct path.

Signed-off-by: David Goulet <dgoulet@torproject.org>

Issue found by our CI:
https://travis-ci.org/github/torproject/tor/jobs/707731598#L6059



Signed-off-by: David Goulet <dgoulet@torproject.org>

Closes #40044

Signed-off-by: David Goulet <dgoulet@torproject.org>

These fields have a complicated history, some slightly complicated
behavior, and some definitely inadequate documentation.  Before we
go fixing them up, let's document how they work now.

MrSquanchee authored 4 years ago and Nick Mathewson committed 4 years ago

Added tests for channel_matches_target_addr_for_extend().
Ticket #33919.