July 2020 - tor-commits - lists.torproject.org

[tor/master] trace: Add two circuit tracepoints for new circuits
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit c8f632784bfd9db91fb644fbf6729177b3518d63 Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Jan 15 12:50:20 2020 -0500 trace: Add two circuit tracepoints for new circuits Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- src/core/or/circuitlist.c | 2 ++ src/core/or/trace_probes_circuit.c | 1 + src/core/or/trace_probes_circuit.h | 20 ++++++++++++++++++++ 3 files changed, 23 insertions(+) diff --git a/src/core/or/circuitlist.c b/src/core/or/circuitlist.c index 10fba498a..b3cc67e9d 100644 --- a/src/core/or/circuitlist.c +++ b/src/core/or/circuitlist.c @@ -1083,6 +1083,7 @@ origin_circuit_new(void) prediction_time_remaining); } + tor_trace(circuit, new_origin, circ); return circ; } @@ -1105,6 +1106,7 @@ or_circuit_new(circid_t p_circ_id, channel_t *p_chan) init_circuit_base(TO_CIRCUIT(circ)); + tor_trace(circuit, new_or, circ); return circ; } diff --git a/src/core/or/trace_probes_circuit.c b/src/core/or/trace_probes_circuit.c index 36af6fe79..b186ffda7 100644 --- a/src/core/or/trace_probes_circuit.c +++ b/src/core/or/trace_probes_circuit.c @@ -19,6 +19,7 @@ #include "core/or/crypt_path_st.h" #include "core/or/extend_info_st.h" #include "core/or/or.h" +#include "core/or/or_circuit_st.h" #include "core/or/origin_circuit_st.h" #define TRACEPOINT_DEFINE diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index 36bfb1563..d2d70686f 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -139,10 +139,22 @@ TRACEPOINT_EVENT_CLASS(tor_circuit, origin_circuit_t_class, ) ) +TRACEPOINT_EVENT_CLASS(tor_circuit, or_circuit_t_class, + TP_ARGS(const or_circuit_t *, circ), + TP_FIELDS( + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ) +) + /* * Origin circuit events. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, new_origin, + TP_ARGS(const origin_circuit_t *, circ) +) + TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, opened, TP_ARGS(const origin_circuit_t *, circ) ) @@ -185,6 +197,14 @@ TRACEPOINT_EVENT(tor_circuit, intermediate_onion_skin, ) ) +/* + * OR circuit events. + */ + +TRACEPOINT_EVENT_INSTANCE(tor_circuit, or_circuit_t_class, new_or, + TP_ARGS(const or_circuit_t *, circ) +) + /* * General circuit events. */

1 0

[tor/master] trace: Add single tracepoint in circuit subsystem
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit bf0e2ae0d0e8608277f53e0cd687a419bf99de85 Author: David Goulet <dgoulet(a)torproject.org> Date: Tue Feb 11 11:46:34 2020 -0500 trace: Add single tracepoint in circuit subsystem This is the very first tracepoint in tor. It is in the circuit subsystem for when a new circuit opens. LTTng instrumentation requires lot more around a tracepoint than USDT thus this commit only adds one tracepoint in order to outline a base to add more tracepoints later. The idea is that we separate subsystem into what LTTng defines as "providers" so the circuit provider contains the tracepoint definitions for the circuit subsystem. Signed-off-by: David Goulet <dgoulet(a)torproject.org> Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- scripts/maint/practracker/exceptions.txt | 1 + src/core/or/circuituse.c | 3 + src/core/or/include.am | 2 + src/core/or/trace_probes_circuit.c | 27 ++++++ src/core/or/trace_probes_circuit.h | 155 +++++++++++++++++++++++++++++++ 5 files changed, 188 insertions(+) diff --git a/scripts/maint/practracker/exceptions.txt b/scripts/maint/practracker/exceptions.txt index 25568f03f..8b4ffccec 100644 --- a/scripts/maint/practracker/exceptions.txt +++ b/scripts/maint/practracker/exceptions.txt @@ -324,3 +324,4 @@ problem function-size /src/tools/tor-gencert.c:parse_commandline() 111 problem function-size /src/tools/tor-resolve.c:build_socks5_resolve_request() 102 problem function-size /src/tools/tor-resolve.c:do_resolve() 171 problem function-size /src/tools/tor-resolve.c:main() 112 +problem dependency-violation /src/core/or/trace_probes_circuit.c 1 diff --git a/src/core/or/circuituse.c b/src/core/or/circuituse.c index 6ff308dae..0e54c28e7 100644 --- a/src/core/or/circuituse.c +++ b/src/core/or/circuituse.c @@ -39,6 +39,7 @@ #include "core/or/connection_edge.h" #include "core/or/extendinfo.h" #include "core/or/policies.h" +#include "core/or/trace_probes_circuit.h" #include "feature/client/addressmap.h" #include "feature/client/bridges.h" #include "feature/client/circpathbias.h" @@ -63,6 +64,7 @@ #include "feature/stats/predict_ports.h" #include "lib/math/fp.h" #include "lib/time/tvdiff.h" +#include "lib/trace/events.h" #include "core/or/cpath_build_state_st.h" #include "feature/dircommon/dir_connection_st.h" @@ -1683,6 +1685,7 @@ circuit_testing_failed(origin_circuit_t *circ, int at_last_hop) void circuit_has_opened(origin_circuit_t *circ) { + tor_trace(circuit, opened, circ); circuit_event_status(circ, CIRC_EVENT_BUILT, 0); /* Remember that this circuit has finished building. Now if we start diff --git a/src/core/or/include.am b/src/core/or/include.am index af7c5a6f5..819b8ab60 100644 --- a/src/core/or/include.am +++ b/src/core/or/include.am @@ -34,6 +34,7 @@ LIBTOR_APP_A_SOURCES += \ src/core/or/scheduler_vanilla.c \ src/core/or/sendme.c \ src/core/or/status.c \ + src/core/or/trace_probes_circuit.c \ src/core/or/versions.c # ADD_C_FILE: INSERT HEADERS HERE. @@ -94,5 +95,6 @@ noinst_HEADERS += \ src/core/or/socks_request_st.h \ src/core/or/status.h \ src/core/or/tor_version_st.h \ + src/core/or/trace_probes_circuit.h \ src/core/or/var_cell_st.h \ src/core/or/versions.h diff --git a/src/core/or/trace_probes_circuit.c b/src/core/or/trace_probes_circuit.c new file mode 100644 index 000000000..f2594f522 --- /dev/null +++ b/src/core/or/trace_probes_circuit.c @@ -0,0 +1,27 @@ +/* Copyright (c) 2020, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file trace_probes_circuit.c + * \brief Tracepoint provider source file for the circuit subsystem. Probes + * are generated within this C file for LTTng-UST + **/ + +#include "orconfig.h" + +/* + * Following section is specific to LTTng-UST. + */ +#ifdef USE_TRACING_INSTRUMENTATION_LTTNG + +/* Header files that the probes need. */ +#include "core/or/circuitlist.h" +#include "core/or/or.h" +#include "core/or/origin_circuit_st.h" + +#define TRACEPOINT_DEFINE +#define TRACEPOINT_CREATE_PROBES + +#include "trace_probes_circuit.h" + +#endif /* USE_TRACING_INSTRUMENTATION_LTTNG */ diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h new file mode 100644 index 000000000..5fc8f01e9 --- /dev/null +++ b/src/core/or/trace_probes_circuit.h @@ -0,0 +1,155 @@ +/* Copyright (c) 2020, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file trace_probes_circuit.c + * \brief The tracing probes for the circuit subsystem. Currently, only + * LTTng-UST probes are available. + **/ + +#include "orconfig.h" + +/* We only build the following if LTTng instrumentation has been enabled. */ +#ifdef USE_TRACING_INSTRUMENTATION_LTTNG + +/* The following defines are LTTng-UST specific. */ +#undef TRACEPOINT_PROVIDER +#define TRACEPOINT_PROVIDER tor_circuit + +#undef TRACEPOINT_INCLUDE +#define TRACEPOINT_INCLUDE "./src/core/or/trace_probes_circuit.h" + +#if !defined(TOR_TRACE_PROBES_CIRCUIT_H) || defined(TRACEPOINT_HEADER_MULTI_READ) +#define TOR_TRACE_PROBES_CIRCUIT_H + +#include <lttng/tracepoint.h> + +TRACEPOINT_ENUM(tor_circuit, purpose, + TP_ENUM_VALUES( + /* Initializing. */ + ctf_enum_value("<UNSET>", 0) + + /* OR Side. */ + ctf_enum_value("OR", CIRCUIT_PURPOSE_OR) + ctf_enum_value("OR_INTRO_POINT", CIRCUIT_PURPOSE_INTRO_POINT) + ctf_enum_value("OR_REND_POINT_WAITING", + CIRCUIT_PURPOSE_REND_POINT_WAITING) + ctf_enum_value("OR_REND_ESTABLISHED", CIRCUIT_PURPOSE_REND_ESTABLISHED) + + /* Client Side. */ + ctf_enum_value("C_GENERAL", CIRCUIT_PURPOSE_C_GENERAL) + ctf_enum_value("C_INTRODUCING", CIRCUIT_PURPOSE_C_INTRODUCING) + ctf_enum_value("C_INTRODUCE_ACK_WAIT", + CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT) + ctf_enum_value("C_INTRODUCE_ACKED", CIRCUIT_PURPOSE_C_INTRODUCE_ACKED) + ctf_enum_value("C_ESTABLISH_REND", CIRCUIT_PURPOSE_C_ESTABLISH_REND) + ctf_enum_value("C_REND_READY", CIRCUIT_PURPOSE_C_REND_READY) + ctf_enum_value("C_REND_READY_INTRO_ACKED", + CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED) + ctf_enum_value("C_REND_JOINED", CIRCUIT_PURPOSE_C_REND_JOINED) + ctf_enum_value("C_HSDIR_GET", CIRCUIT_PURPOSE_C_HSDIR_GET) + + /* CBT and Padding. */ + ctf_enum_value("C_MEASURE_TIMEOUT", CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT) + ctf_enum_value("C_CIRCUIT_PADDING", CIRCUIT_PURPOSE_C_CIRCUIT_PADDING) + + /* Service Side. */ + ctf_enum_value("S_ESTABLISH_INTRO", CIRCUIT_PURPOSE_S_ESTABLISH_INTRO) + ctf_enum_value("S_INTRO", CIRCUIT_PURPOSE_S_INTRO) + ctf_enum_value("S_CONNECT_REND", CIRCUIT_PURPOSE_S_CONNECT_REND) + ctf_enum_value("S_REND_JOINED", CIRCUIT_PURPOSE_S_REND_JOINED) + ctf_enum_value("S_HSDIR_POST", CIRCUIT_PURPOSE_S_HSDIR_POST) + + /* Misc. */ + ctf_enum_value("TESTING", CIRCUIT_PURPOSE_TESTING) + ctf_enum_value("CONTROLER", CIRCUIT_PURPOSE_CONTROLLER) + ctf_enum_value("PATH_BIAS_TESTING", CIRCUIT_PURPOSE_PATH_BIAS_TESTING) + + /* VanGuard */ + ctf_enum_value("HS_VANGUARDS", CIRCUIT_PURPOSE_HS_VANGUARDS) + ) +) + +TRACEPOINT_ENUM(tor_circuit, end_reason, + TP_ENUM_VALUES( + /* Local reasons. */ + ctf_enum_value("IP_NOW_REDUNDANT", END_CIRC_REASON_IP_NOW_REDUNDANT) + ctf_enum_value("MEASUREMENT_EXPIRED", END_CIRC_REASON_MEASUREMENT_EXPIRED) + ctf_enum_value("REASON_NOPATH", END_CIRC_REASON_NOPATH) + ctf_enum_value("AT_ORIGIN", END_CIRC_AT_ORIGIN) + ctf_enum_value("NONE", END_CIRC_REASON_NONE) + ctf_enum_value("TORPROTOCOL", END_CIRC_REASON_TORPROTOCOL) + ctf_enum_value("INTERNAL", END_CIRC_REASON_INTERNAL) + ctf_enum_value("REQUESTED", END_CIRC_REASON_REQUESTED) + ctf_enum_value("HIBERNATING", END_CIRC_REASON_HIBERNATING) + ctf_enum_value("RESOURCELIMIT", END_CIRC_REASON_RESOURCELIMIT) + ctf_enum_value("CONNECTFAILED", END_CIRC_REASON_CONNECTFAILED) + ctf_enum_value("OR_IDENTITY", END_CIRC_REASON_OR_IDENTITY) + ctf_enum_value("CHANNEL_CLOSED", END_CIRC_REASON_CHANNEL_CLOSED) + ctf_enum_value("FINISHED", END_CIRC_REASON_FINISHED) + ctf_enum_value("TIMEOUT", END_CIRC_REASON_TIMEOUT) + ctf_enum_value("DESTROYED", END_CIRC_REASON_DESTROYED) + ctf_enum_value("NOSUCHSERVICE", END_CIRC_REASON_NOSUCHSERVICE) + + /* Remote reasons. */ + ctf_enum_value("FLAG_REMOTE", END_CIRC_REASON_FLAG_REMOTE) + ctf_enum_value("REMOTE_TORPROTOCOL", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_TORPROTOCOL) + ctf_enum_value("REMOTE_INTERNAL", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_INTERNAL) + ctf_enum_value("REMOTE_REQUESTED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_REQUESTED) + ctf_enum_value("REMOTE_HIBERNATING", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_HIBERNATING) + ctf_enum_value("REMOTE_RESOURCELIMIT", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_RESOURCELIMIT) + ctf_enum_value("REMOTE_CONNECTFAILED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_CONNECTFAILED) + ctf_enum_value("REMOTE_OR_IDENTITY", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_OR_IDENTITY) + ctf_enum_value("REMOTE_CHANNEL_CLOSED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_CHANNEL_CLOSED) + ctf_enum_value("REMOTE_FINISHED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_FINISHED) + ctf_enum_value("REMOTE_TIMEOUT", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_TIMEOUT) + ctf_enum_value("REMOTE_DESTROYED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_DESTROYED) + ctf_enum_value("REMOTE_NOSUCHSERVICE", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_NOSUCHSERVICE) + ) +) + +TRACEPOINT_ENUM(tor_circuit, state, + TP_ENUM_VALUES( + ctf_enum_value("BUILDING", CIRCUIT_STATE_BUILDING) + ctf_enum_value("ONIONSKIN_PENDING", CIRCUIT_STATE_ONIONSKIN_PENDING) + ctf_enum_value("CHAN_WAIT", CIRCUIT_STATE_CHAN_WAIT) + ctf_enum_value("GUARD_WAIT", CIRCUIT_STATE_GUARD_WAIT) + ctf_enum_value("OPEN", CIRCUIT_STATE_OPEN) + ) +) + +TRACEPOINT_EVENT_CLASS(tor_circuit, origin_circuit_t_class, + TP_ARGS(const origin_circuit_t *, circ), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, circ->global_identifier) + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ) +) + +/* + * Origin circuit events. + */ + +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, opened, + TP_ARGS(const origin_circuit_t *, circ) +) + +#endif /* TOR_TRACE_PROBES_CIRCUIT_H */ + +/* Must be include after the probes declaration. */ +#include <lttng/tracepoint-event.h> + +#endif /* USE_TRACING_INSTRUMENTATION_LTTNG */

1 0

[tor/master] trace: Add two origin circuit specific tracepoints
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit 4cb6887471caa7687b5fd26a357e60e6cafbd326 Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Jan 15 12:42:58 2020 -0500 trace: Add two origin circuit specific tracepoints Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- src/core/or/circuitbuild.c | 2 ++ src/core/or/trace_probes_circuit.c | 2 ++ src/core/or/trace_probes_circuit.h | 22 ++++++++++++++++++++++ 3 files changed, 26 insertions(+) diff --git a/src/core/or/circuitbuild.c b/src/core/or/circuitbuild.c index edbce8a2d..034a0dc77 100644 --- a/src/core/or/circuitbuild.c +++ b/src/core/or/circuitbuild.c @@ -983,6 +983,7 @@ circuit_send_first_onion_skin(origin_circuit_t *circ) if (circuit_deliver_create_cell(TO_CIRCUIT(circ), &cc, 0) < 0) return - END_CIRC_REASON_RESOURCELIMIT; + tor_trace(circuit, first_onion_skin, circ, circ->cpath); circ->cpath->state = CPATH_STATE_AWAITING_KEYS; circuit_set_state(TO_CIRCUIT(circ), CIRCUIT_STATE_BUILDING); @@ -1146,6 +1147,7 @@ circuit_send_intermediate_onion_skin(origin_circuit_t *circ, return 0; /* circuit is closed */ } hop->state = CPATH_STATE_AWAITING_KEYS; + tor_trace(circuit, intermediate_onion_skin, circ, hop); return 0; } diff --git a/src/core/or/trace_probes_circuit.c b/src/core/or/trace_probes_circuit.c index f2594f522..36af6fe79 100644 --- a/src/core/or/trace_probes_circuit.c +++ b/src/core/or/trace_probes_circuit.c @@ -16,6 +16,8 @@ /* Header files that the probes need. */ #include "core/or/circuitlist.h" +#include "core/or/crypt_path_st.h" +#include "core/or/extend_info_st.h" #include "core/or/or.h" #include "core/or/origin_circuit_st.h" diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index e306a7886..36bfb1563 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -163,6 +163,28 @@ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, idle_timeout, TP_ARGS(const origin_circuit_t *, circ) ) +TRACEPOINT_EVENT(tor_circuit, first_onion_skin, + TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, circ->global_identifier) + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ctf_array_hex(char, fingerprint, hop->extend_info->identity_digest, + DIGEST_LEN) + ) +) + +TRACEPOINT_EVENT(tor_circuit, intermediate_onion_skin, + TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, circ->global_identifier) + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ctf_array_hex(char, fingerprint, hop->extend_info->identity_digest, + DIGEST_LEN) + ) +) + /* * General circuit events. */

1 0

[tor/master] trace: Comments and improve doc/HACKING/Tracing.md
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit 79d6127a4733cd01cece0c7bdf07d277fe8a08e3 Author: David Goulet <dgoulet(a)torproject.org> Date: Tue Feb 11 15:06:50 2020 -0500 trace: Comments and improve doc/HACKING/Tracing.md Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- doc/HACKING/Tracing.md | 130 +++++++++++++++++++++++++------------ src/core/or/trace_probes_circuit.h | 56 +++++++++++++++- 2 files changed, 142 insertions(+), 44 deletions(-) diff --git a/doc/HACKING/Tracing.md b/doc/HACKING/Tracing.md index e1e97abe6..8cf68321a 100644 --- a/doc/HACKING/Tracing.md +++ b/doc/HACKING/Tracing.md @@ -2,19 +2,26 @@ This document describes how the event tracing subsystem works in tor so developers can add events to the code base but also hook them to an event -tracing framework. +tracing framework (i.e. tracer). ## Basics -Event tracing is separated in two concepts, trace events and a tracer. The -tracing subsystem can be found in `src/trace`. The `events.h` header file is -the main file that maps the different tracers to trace events. +Tracing is separated in two different concepts. The tracing API and the +tracing probes. + +The API is in `src/lib/trace/` which defines how to call tracepoints in the +tor code. Every C files should include `src/lib/trace/events.h" if they want +to call a tracepoint. + +The probes are what actually record the tracepoint data. Because they often +need to access specific subsystem objects, the probes are within each +subsystem. They are defined in the `trace-probes-<subsystem>.c` files. ### Events -A trace event is basically a function from which we can pass any data that -we want to collect. In addition, we specify a context for the event such as -a subsystem and an event name. +A trace event is basically a function from which we can pass any data that we +want to collect. In addition, we specify a context for the event such as the +subsystem and an event name. A trace event in tor has the following standard format: @@ -23,69 +30,106 @@ A trace event in tor has the following standard format: The `subsystem` parameter is the name of the subsytem the trace event is in. For example that could be "scheduler" or "vote" or "hs". The idea is to add some context to the event so when we collect them we know where it's coming -from. The `event_name` is the name of the event which helps a lot with -adding some semantic to the event. Finally, `args` is any number of -arguments we want to collect. +from. + +The `event\_name` is the name of the event which adds better semantic to the +event. + +The `args` can be any number of arguments we want to collect. Here is an example of a possible tracepoint in main(): tor_trace(main, init_phase, argc) -The above is a tracepoint in the `main` subsystem with `init_phase` as the -event name and the `int argc` is passed to the event as well. +The above is a tracepoint in the `main` subsystem with `init\_phase` as the +event name and the `int argc` is passed to the event as one argument. How `argc` is collected or used has nothing to do with the instrumentation (adding trace events to the code). It is the work of the tracer so this is why the trace events and collection framework (tracer) are decoupled. You _can_ have trace events without a tracer. -### Tracer +### Instrumentation ### + +In `src/lib/trace/events.h`, we map the high level `tor\_trace()` macro to one +or many enabled instrumentation. + +Currently, we have 3 types of possible instrumentation: + +1. Debug + + This will map every tracepoint to `log\_debug()`. However, none of the + arguments will be passed on because we don't know their type nor the string + format of the debug log. The output is standardized like this: + + [debug] __FUNC__: Tracepoint <event_name> from subsystem <subsystem> hit. -In `src/trace/events.h`, we map the `tor_trace()` function to the right -tracer. A tracer support is only enabled at compile time. For instance, the -file `src/trace/debug.h` contains the mapping of the generic tracing function -`tor_trace()` to the `log_debug()` function. More specialized function can be -mapped depending on the tracepoint. +2. USDT + + User Statically-Defined Tracing (USDT) is a kind of probe which can be + handled by a variety of tracers such as SystemTap, DTrace, perf, eBPF and + ftrace. + + For each tracer, one will need to define the ABI in order for the tracer to + be able to extract the data from the tracepoint objects. For instance, the + tracer needs to know how to print the circuit state of a `circuit\_t` + object. + +3. LTTng-UST + + LTTng Userspace is a tracer that has it own type of instrumentation. The + probe definitions are created within the C code and is strongly typed. + + For more information, see https://lttng.org/docs. ## Build System -This section describes how it is integrated into the build system of tor. +This section describes how the instrumentation is integrated into the build +system of tor. -By default, every tracing events are disabled in tor that is `tor_trace()` -is a NOP. +By default, every tracing events are disabled in tor that is `tor\_trace()` is +a NOP thus has no execution cost time. -To enable a tracer, there is a configure option on the form of: +To enable a specific instrumentation, there are configure options: - --enable-tracing-<tracer> +1. Debug: `--enable-tracing-instrumentation-debug` -We have an option that will send every trace events to a `log_debug()` (as -mentionned above) which will print you the subsystem and name of the event but -not the arguments for technical reasons. This is useful if you want to quickly -see if your trace event is being hit or well written. To do so, use this -configure option: +2. USDT: `--enable-tracing-instrumentation-usdt` - --enable-tracing-debug +3. LTTng: `--enable-tracing-instrumentation-lttng` -## Instrument Tor +They can all be used together or independently. If one of them is set, +`HAVE\_TRACING` define is set. And for each instrumentation, a +`USE\_TRACING\_INSTRUMENTATION\_<type>` is set. + +## Adding a Tracepoint ## This is pretty easy. Let's say you want to add a trace event in -`src/feature/rend/rendcache.c`, you only have to add this include statement: +`src/feature/rend/rendcache.c`, you first need to include this file: - #include "trace/events.h" + #include "lib/trace/events.h" -Once done, you can add as many as you want `tor_trace()` that you need. -Please use the right subsystem (here it would be `hs`) and a unique name that -tells what the event is for. For example: +Then, the `tor\_trace()` macro can be used with the specific format detailled +before in a previous section. As an example: tor_trace(hs, store_desc_as_client, desc, desc_id); -If you look in `src/trace/events.h`, you'll see that if tracing is enabled it -will be mapped to a function called: +For `Debug` instrumentation, you have nothing else to do. + +For `USDT`, instrumentation, you will need to define the probes in a way the +specific tracer can understand. For instance, SystemTap requires you to define +a `tapset` for each tracepoints. + +For `LTTng`, you will need to define the probes in the +`trace-probes-<subsystem>.{c|h}` file. See the `trace-probes-circuit.{c|h}` +file as an example and https://lttng.org/docs/v2.11/#doc-instrumenting. + +## Performance ## - tor_trace_hs_store_desc_as_client(desc, desc_id) +A word about performance when a tracepoint is enabled. One of the goal of a +tracepoint (USDT, LTTng-UST, ...) is that they can be enabled or disabled. By +default, they are disabled which means the tracer will not record the data but +it has to do a check thus the cost is basically the one of a `branch`. -And the point of all this is for that function to be defined in a new file -that you might want to add named `src/trace/hs.{c|h}` which would defined how -to collect the data for the `tor_trace_hs_store_desc_as_client()` function -like for instance sending it to a `log_debug()` or do more complex operations -or use a userspace tracer like LTTng (https://lttng.org) +If enabled, then the performance depends on the tracer. In the case of +LTTng-UST, the event costs around 110nsec. diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index d2d70686f..44842efb0 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -24,6 +24,13 @@ #include <lttng/tracepoint.h> +/* + * Circuit Purposes + * + * The following defines an enumeration of all possible circuit purpose so + * they appear in the trace with the define name (first parameter of + * ctf_enum_value) instead of the numerical value. + */ TRACEPOINT_ENUM(tor_circuit, purpose, TP_ENUM_VALUES( /* Initializing. */ @@ -70,6 +77,13 @@ TRACEPOINT_ENUM(tor_circuit, purpose, ) ) +/* + * Circuit End Reasons + * + * The following defines an enumeration of all possible circuit end reasons so + * they appear in the trace with the define name (first parameter of + * ctf_enum_value) instead of the numerical value. + */ TRACEPOINT_ENUM(tor_circuit, end_reason, TP_ENUM_VALUES( /* Local reasons. */ @@ -120,6 +134,13 @@ TRACEPOINT_ENUM(tor_circuit, end_reason, ) ) +/* + * Circuit State + * + * The following defines an enumeration of all possible circuit state so they + * appear in the trace with the define name (first parameter of + * ctf_enum_value) instead of the numerical value. + */ TRACEPOINT_ENUM(tor_circuit, state, TP_ENUM_VALUES( ctf_enum_value("BUILDING", CIRCUIT_STATE_BUILDING) @@ -130,6 +151,15 @@ TRACEPOINT_ENUM(tor_circuit, state, ) ) +/* + * Event Class + * + * A tracepoint class is a class of tracepoints which share the same output + * event field definitions. They are then used by the + * TRACEPOINT_EVENT_INSTANCE() macro as a base field definition. + */ + +/* Class for origin circuit. */ TRACEPOINT_EVENT_CLASS(tor_circuit, origin_circuit_t_class, TP_ARGS(const origin_circuit_t *, circ), TP_FIELDS( @@ -139,6 +169,7 @@ TRACEPOINT_EVENT_CLASS(tor_circuit, origin_circuit_t_class, ) ) +/* Class for or circuit. */ TRACEPOINT_EVENT_CLASS(tor_circuit, or_circuit_t_class, TP_ARGS(const or_circuit_t *, circ), TP_FIELDS( @@ -149,32 +180,44 @@ TRACEPOINT_EVENT_CLASS(tor_circuit, or_circuit_t_class, /* * Origin circuit events. + * + * Tracepoint use the origin_circuit_t object. */ +/* Tracepoint emitted when a new origin circuit has been created. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, new_origin, TP_ARGS(const origin_circuit_t *, circ) ) +/* Tracepoint emitted when an origin circuit has opened. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, opened, TP_ARGS(const origin_circuit_t *, circ) ) +/* Tracepoint emitted when an origin circuit has established. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, establish, TP_ARGS(const origin_circuit_t *, circ) ) +/* Tracepoint emitted when an origin circuit has been cannibalized. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, cannibalized, TP_ARGS(const origin_circuit_t *, circ) ) +/* Tracepoint emitted when an origin circuit has timed out. This is called + * when circuit_expire_building() as selected the circuit and is about to + * close it for timeout. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, timeout, TP_ARGS(const origin_circuit_t *, circ) ) +/* Tracepoint emitted when an origin circuit has timed out due to idleness. + * This is when the circuit is closed after MaxCircuitDirtiness. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, idle_timeout, TP_ARGS(const origin_circuit_t *, circ) ) +/* Tracepoint emitted when an origin circuit sends out its first onion skin. */ TRACEPOINT_EVENT(tor_circuit, first_onion_skin, TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), TP_FIELDS( @@ -186,6 +229,8 @@ TRACEPOINT_EVENT(tor_circuit, first_onion_skin, ) ) +/* Tracepoint emitted when an origin circuit sends out an intermediate onion + * skin. */ TRACEPOINT_EVENT(tor_circuit, intermediate_onion_skin, TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), TP_FIELDS( @@ -199,16 +244,22 @@ TRACEPOINT_EVENT(tor_circuit, intermediate_onion_skin, /* * OR circuit events. + * + * Tracepoint use the or_circuit_t object. */ +/* Tracepoint emitted when a new or circuit has been created. */ TRACEPOINT_EVENT_INSTANCE(tor_circuit, or_circuit_t_class, new_or, TP_ARGS(const or_circuit_t *, circ) ) /* * General circuit events. + * + * Tracepoint use the circuit_t object. */ +/* Tracepoint emitted when a circuit is freed. */ TRACEPOINT_EVENT(tor_circuit, free, TP_ARGS(const circuit_t *, circ), TP_FIELDS( @@ -220,6 +271,7 @@ TRACEPOINT_EVENT(tor_circuit, free, ) ) +/* Tracepoint emitted when a circuit is marked for close. */ TRACEPOINT_EVENT(tor_circuit, mark_for_close, TP_ARGS(const circuit_t *, circ), TP_FIELDS( @@ -235,6 +287,7 @@ TRACEPOINT_EVENT(tor_circuit, mark_for_close, ) ) +/* Tracepoint emitted when a circuit changes purpose. */ TRACEPOINT_EVENT(tor_circuit, change_purpose, TP_ARGS(const circuit_t *, circ, int, old_purpose, int, new_purpose), TP_FIELDS( @@ -247,6 +300,7 @@ TRACEPOINT_EVENT(tor_circuit, change_purpose, ) ) +/* Tracepoint emitted when a circuit changes state. */ TRACEPOINT_EVENT(tor_circuit, change_state, TP_ARGS(const circuit_t *, circ, int, old_state, int, new_state), TP_FIELDS( @@ -261,7 +315,7 @@ TRACEPOINT_EVENT(tor_circuit, change_state, #endif /* TOR_TRACE_PROBES_CIRCUIT_H */ -/* Must be include after the probes declaration. */ +/* Must be included after the probes declaration. */ #include <lttng/tracepoint-event.h> #endif /* USE_TRACING_INSTRUMENTATION_LTTNG */

1 0

[tor/master] trace: Add four more circuit subsystem tracepoints
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit a7063345770002082c2334f290f662c8d4ce644b Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Jan 15 12:26:54 2020 -0500 trace: Add four more circuit subsystem tracepoints Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- src/core/or/circuitbuild.c | 4 ++++ src/core/or/circuituse.c | 8 +++++++- src/core/or/trace_probes_circuit.h | 16 ++++++++++++++++ 3 files changed, 27 insertions(+), 1 deletion(-) diff --git a/src/core/or/circuitbuild.c b/src/core/or/circuitbuild.c index cef70e3e7..edbce8a2d 100644 --- a/src/core/or/circuitbuild.c +++ b/src/core/or/circuitbuild.c @@ -50,6 +50,7 @@ #include "core/or/ocirc_event.h" #include "core/or/policies.h" #include "core/or/relay.h" +#include "core/or/trace_probes_circuit.h" #include "core/or/crypt_path.h" #include "feature/client/bridges.h" #include "feature/client/circpathbias.h" @@ -71,6 +72,7 @@ #include "feature/rend/rendcommon.h" #include "feature/stats/predict_ports.h" #include "lib/crypt_ops/crypto_rand.h" +#include "lib/trace/events.h" #include "core/or/cell_st.h" #include "core/or/cpath_build_state_st.h" @@ -497,6 +499,8 @@ circuit_establish_circuit(uint8_t purpose, extend_info_t *exit_ei, int flags) circuit_mark_for_close(TO_CIRCUIT(circ), -err_reason); return NULL; } + + tor_trace(circuit, establish, circ); return circ; } diff --git a/src/core/or/circuituse.c b/src/core/or/circuituse.c index 0e54c28e7..b9c15c155 100644 --- a/src/core/or/circuituse.c +++ b/src/core/or/circuituse.c @@ -840,6 +840,7 @@ circuit_expire_building(void) -1); circuit_log_path(LOG_INFO,LD_CIRC,TO_ORIGIN_CIRCUIT(victim)); + tor_trace(circuit, timeout, TO_ORIGIN_CIRCUIT(victim)); if (victim->purpose == CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT) circuit_mark_for_close(victim, END_CIRC_REASON_MEASUREMENT_EXPIRED); else @@ -1503,8 +1504,10 @@ circuit_expire_old_circuits_clientside(void) circ->purpose); /* Don't do this magic for testing circuits. Their death is governed * by circuit_expire_building */ - if (circ->purpose != CIRCUIT_PURPOSE_PATH_BIAS_TESTING) + if (circ->purpose != CIRCUIT_PURPOSE_PATH_BIAS_TESTING) { + tor_trace(circuit, idle_timeout, TO_ORIGIN_CIRCUIT(circ)); circuit_mark_for_close(circ, END_CIRC_REASON_FINISHED); + } } else if (!circ->timestamp_dirty && circ->state == CIRCUIT_STATE_OPEN) { if (timercmp(&circ->timestamp_began, &cutoff, OP_LT)) { if (circ->purpose == CIRCUIT_PURPOSE_C_GENERAL || @@ -1523,6 +1526,7 @@ circuit_expire_old_circuits_clientside(void) " that has been unused for %ld msec.", TO_ORIGIN_CIRCUIT(circ)->global_identifier, tv_mdiff(&circ->timestamp_began, &now)); + tor_trace(circuit, idle_timeout, TO_ORIGIN_CIRCUIT(circ)); circuit_mark_for_close(circ, END_CIRC_REASON_FINISHED); } else if (!TO_ORIGIN_CIRCUIT(circ)->is_ancient) { /* Server-side rend joined circuits can end up really old, because @@ -2207,6 +2211,8 @@ circuit_launch_by_extend_info(uint8_t purpose, tor_fragile_assert(); return NULL; } + + tor_trace(circuit, cannibalized, circ); return circ; } } diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index 5fc8f01e9..c0dbd1a50 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -147,6 +147,22 @@ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, opened, TP_ARGS(const origin_circuit_t *, circ) ) +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, establish, + TP_ARGS(const origin_circuit_t *, circ) +) + +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, cannibalized, + TP_ARGS(const origin_circuit_t *, circ) +) + +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, timeout, + TP_ARGS(const origin_circuit_t *, circ) +) + +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, idle_timeout, + TP_ARGS(const origin_circuit_t *, circ) +) + #endif /* TOR_TRACE_PROBES_CIRCUIT_H */ /* Must be include after the probes declaration. */

1 0

[tor/master] trace: Move LTTng specific declartion to .inc file
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit d80c34d214f88c0831ce7cf7595c5e6e8b6fa168 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 13 13:25:42 2020 -0500 trace: Move LTTng specific declartion to .inc file LTTng tracepoint probe declaration is not really following a C standard that coccinelle and checkSpace.pl likes. Move everything to a .inc file and standardize the trace_probes_circuit.h header to include that LTTng specific file if the instrumentation was enabled at configure time. Part of #32910 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- scripts/maint/practracker/exceptions.txt | 1 + src/core/or/lttng_circuit.inc | 322 +++++++++++++++++++++++++++++++ src/core/or/trace_probes_circuit.h | 312 +----------------------------- 3 files changed, 327 insertions(+), 308 deletions(-) diff --git a/scripts/maint/practracker/exceptions.txt b/scripts/maint/practracker/exceptions.txt index 8b4ffccec..87581b6c8 100644 --- a/scripts/maint/practracker/exceptions.txt +++ b/scripts/maint/practracker/exceptions.txt @@ -325,3 +325,4 @@ problem function-size /src/tools/tor-resolve.c:build_socks5_resolve_request() 10 problem function-size /src/tools/tor-resolve.c:do_resolve() 171 problem function-size /src/tools/tor-resolve.c:main() 112 problem dependency-violation /src/core/or/trace_probes_circuit.c 1 +problem dependency-violation /src/core/or/trace_probes_circuit.h 1 diff --git a/src/core/or/lttng_circuit.inc b/src/core/or/lttng_circuit.inc new file mode 100644 index 000000000..fc3e175c8 --- /dev/null +++ b/src/core/or/lttng_circuit.inc @@ -0,0 +1,322 @@ +/* Copyright (c) 2020, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file lttng_circuit.inc + * \brief LTTng tracing probe declaration for the circuit subsystem. It is in +* this .inc file due to the non C standard syntax and the way we guard +* the header with the LTTng specific TRACEPOINT_HEADER_MULTI_READ. + **/ + +#include "orconfig.h" + +/* We only build the following if LTTng instrumentation has been enabled. */ +#ifdef USE_TRACING_INSTRUMENTATION_LTTNG + +/* The following defines are LTTng-UST specific. */ +#undef TRACEPOINT_PROVIDER +#define TRACEPOINT_PROVIDER tor_circuit + +#undef TRACEPOINT_INCLUDE +#define TRACEPOINT_INCLUDE "./src/core/or/lttng_circuit.inc" + +#if !defined(LTTNG_CIRCUIT_INC) || defined(TRACEPOINT_HEADER_MULTI_READ) +#define LTTNG_CIRCUIT_INC + +#include <lttng/tracepoint.h> + +/* + * Circuit Purposes + * + * The following defines an enumeration of all possible circuit purpose so + * they appear in the trace with the define name (first parameter of + * ctf_enum_value) instead of the numerical value. + */ +TRACEPOINT_ENUM(tor_circuit, purpose, + TP_ENUM_VALUES( + /* Initializing. */ + ctf_enum_value("<UNSET>", 0) + + /* OR Side. */ + ctf_enum_value("OR", CIRCUIT_PURPOSE_OR) + ctf_enum_value("OR_INTRO_POINT", CIRCUIT_PURPOSE_INTRO_POINT) + ctf_enum_value("OR_REND_POINT_WAITING", + CIRCUIT_PURPOSE_REND_POINT_WAITING) + ctf_enum_value("OR_REND_ESTABLISHED", CIRCUIT_PURPOSE_REND_ESTABLISHED) + + /* Client Side. */ + ctf_enum_value("C_GENERAL", CIRCUIT_PURPOSE_C_GENERAL) + ctf_enum_value("C_INTRODUCING", CIRCUIT_PURPOSE_C_INTRODUCING) + ctf_enum_value("C_INTRODUCE_ACK_WAIT", + CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT) + ctf_enum_value("C_INTRODUCE_ACKED", CIRCUIT_PURPOSE_C_INTRODUCE_ACKED) + ctf_enum_value("C_ESTABLISH_REND", CIRCUIT_PURPOSE_C_ESTABLISH_REND) + ctf_enum_value("C_REND_READY", CIRCUIT_PURPOSE_C_REND_READY) + ctf_enum_value("C_REND_READY_INTRO_ACKED", + CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED) + ctf_enum_value("C_REND_JOINED", CIRCUIT_PURPOSE_C_REND_JOINED) + ctf_enum_value("C_HSDIR_GET", CIRCUIT_PURPOSE_C_HSDIR_GET) + + /* CBT and Padding. */ + ctf_enum_value("C_MEASURE_TIMEOUT", CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT) + ctf_enum_value("C_CIRCUIT_PADDING", CIRCUIT_PURPOSE_C_CIRCUIT_PADDING) + + /* Service Side. */ + ctf_enum_value("S_ESTABLISH_INTRO", CIRCUIT_PURPOSE_S_ESTABLISH_INTRO) + ctf_enum_value("S_INTRO", CIRCUIT_PURPOSE_S_INTRO) + ctf_enum_value("S_CONNECT_REND", CIRCUIT_PURPOSE_S_CONNECT_REND) + ctf_enum_value("S_REND_JOINED", CIRCUIT_PURPOSE_S_REND_JOINED) + ctf_enum_value("S_HSDIR_POST", CIRCUIT_PURPOSE_S_HSDIR_POST) + + /* Misc. */ + ctf_enum_value("TESTING", CIRCUIT_PURPOSE_TESTING) + ctf_enum_value("CONTROLER", CIRCUIT_PURPOSE_CONTROLLER) + ctf_enum_value("PATH_BIAS_TESTING", CIRCUIT_PURPOSE_PATH_BIAS_TESTING) + + /* VanGuard */ + ctf_enum_value("HS_VANGUARDS", CIRCUIT_PURPOSE_HS_VANGUARDS) + ) +) + +/* + * Circuit End Reasons + * + * The following defines an enumeration of all possible circuit end reasons so + * they appear in the trace with the define name (first parameter of + * ctf_enum_value) instead of the numerical value. + */ +TRACEPOINT_ENUM(tor_circuit, end_reason, + TP_ENUM_VALUES( + /* Local reasons. */ + ctf_enum_value("IP_NOW_REDUNDANT", END_CIRC_REASON_IP_NOW_REDUNDANT) + ctf_enum_value("MEASUREMENT_EXPIRED", END_CIRC_REASON_MEASUREMENT_EXPIRED) + ctf_enum_value("REASON_NOPATH", END_CIRC_REASON_NOPATH) + ctf_enum_value("AT_ORIGIN", END_CIRC_AT_ORIGIN) + ctf_enum_value("NONE", END_CIRC_REASON_NONE) + ctf_enum_value("TORPROTOCOL", END_CIRC_REASON_TORPROTOCOL) + ctf_enum_value("INTERNAL", END_CIRC_REASON_INTERNAL) + ctf_enum_value("REQUESTED", END_CIRC_REASON_REQUESTED) + ctf_enum_value("HIBERNATING", END_CIRC_REASON_HIBERNATING) + ctf_enum_value("RESOURCELIMIT", END_CIRC_REASON_RESOURCELIMIT) + ctf_enum_value("CONNECTFAILED", END_CIRC_REASON_CONNECTFAILED) + ctf_enum_value("OR_IDENTITY", END_CIRC_REASON_OR_IDENTITY) + ctf_enum_value("CHANNEL_CLOSED", END_CIRC_REASON_CHANNEL_CLOSED) + ctf_enum_value("FINISHED", END_CIRC_REASON_FINISHED) + ctf_enum_value("TIMEOUT", END_CIRC_REASON_TIMEOUT) + ctf_enum_value("DESTROYED", END_CIRC_REASON_DESTROYED) + ctf_enum_value("NOSUCHSERVICE", END_CIRC_REASON_NOSUCHSERVICE) + + /* Remote reasons. */ + ctf_enum_value("FLAG_REMOTE", END_CIRC_REASON_FLAG_REMOTE) + ctf_enum_value("REMOTE_TORPROTOCOL", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_TORPROTOCOL) + ctf_enum_value("REMOTE_INTERNAL", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_INTERNAL) + ctf_enum_value("REMOTE_REQUESTED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_REQUESTED) + ctf_enum_value("REMOTE_HIBERNATING", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_HIBERNATING) + ctf_enum_value("REMOTE_RESOURCELIMIT", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_RESOURCELIMIT) + ctf_enum_value("REMOTE_CONNECTFAILED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_CONNECTFAILED) + ctf_enum_value("REMOTE_OR_IDENTITY", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_OR_IDENTITY) + ctf_enum_value("REMOTE_CHANNEL_CLOSED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_CHANNEL_CLOSED) + ctf_enum_value("REMOTE_FINISHED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_FINISHED) + ctf_enum_value("REMOTE_TIMEOUT", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_TIMEOUT) + ctf_enum_value("REMOTE_DESTROYED", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_DESTROYED) + ctf_enum_value("REMOTE_NOSUCHSERVICE", + END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_NOSUCHSERVICE) + ) +) + +/* + * Circuit State + * + * The following defines an enumeration of all possible circuit state so they + * appear in the trace with the define name (first parameter of + * ctf_enum_value) instead of the numerical value. + */ +TRACEPOINT_ENUM(tor_circuit, state, + TP_ENUM_VALUES( + ctf_enum_value("BUILDING", CIRCUIT_STATE_BUILDING) + ctf_enum_value("ONIONSKIN_PENDING", CIRCUIT_STATE_ONIONSKIN_PENDING) + ctf_enum_value("CHAN_WAIT", CIRCUIT_STATE_CHAN_WAIT) + ctf_enum_value("GUARD_WAIT", CIRCUIT_STATE_GUARD_WAIT) + ctf_enum_value("OPEN", CIRCUIT_STATE_OPEN) + ) +) + +/* + * Event Class + * + * A tracepoint class is a class of tracepoints which share the same output + * event field definitions. They are then used by the + * TRACEPOINT_EVENT_INSTANCE() macro as a base field definition. + */ + +/* Class for origin circuit. */ +TRACEPOINT_EVENT_CLASS(tor_circuit, origin_circuit_t_class, + TP_ARGS(const origin_circuit_t *, circ), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, circ->global_identifier) + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ) +) + +/* Class for or circuit. */ +TRACEPOINT_EVENT_CLASS(tor_circuit, or_circuit_t_class, + TP_ARGS(const or_circuit_t *, circ), + TP_FIELDS( + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ) +) + +/* + * Origin circuit events. + * + * Tracepoint use the origin_circuit_t object. + */ + +/* Tracepoint emitted when a new origin circuit has been created. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, new_origin, + TP_ARGS(const origin_circuit_t *, circ) +) + +/* Tracepoint emitted when an origin circuit has opened. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, opened, + TP_ARGS(const origin_circuit_t *, circ) +) + +/* Tracepoint emitted when an origin circuit has established. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, establish, + TP_ARGS(const origin_circuit_t *, circ) +) + +/* Tracepoint emitted when an origin circuit has been cannibalized. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, cannibalized, + TP_ARGS(const origin_circuit_t *, circ) +) + +/* Tracepoint emitted when an origin circuit has timed out. This is called + * when circuit_expire_building() as selected the circuit and is about to + * close it for timeout. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, timeout, + TP_ARGS(const origin_circuit_t *, circ) +) + +/* Tracepoint emitted when an origin circuit has timed out due to idleness. + * This is when the circuit is closed after MaxCircuitDirtiness. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, idle_timeout, + TP_ARGS(const origin_circuit_t *, circ) +) + +/* Tracepoint emitted when an origin circuit sends out its first onion skin. */ +TRACEPOINT_EVENT(tor_circuit, first_onion_skin, + TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, circ->global_identifier) + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ctf_array_hex(char, fingerprint, hop->extend_info->identity_digest, + DIGEST_LEN) + ) +) + +/* Tracepoint emitted when an origin circuit sends out an intermediate onion + * skin. */ +TRACEPOINT_EVENT(tor_circuit, intermediate_onion_skin, + TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, circ->global_identifier) + ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) + ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) + ctf_array_hex(char, fingerprint, hop->extend_info->identity_digest, + DIGEST_LEN) + ) +) + +/* + * OR circuit events. + * + * Tracepoint use the or_circuit_t object. + */ + +/* Tracepoint emitted when a new or circuit has been created. */ +TRACEPOINT_EVENT_INSTANCE(tor_circuit, or_circuit_t_class, new_or, + TP_ARGS(const or_circuit_t *, circ) +) + +/* + * General circuit events. + * + * Tracepoint use the circuit_t object. + */ + +/* Tracepoint emitted when a circuit is freed. */ +TRACEPOINT_EVENT(tor_circuit, free, + TP_ARGS(const circuit_t *, circ), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) + ctf_enum(tor_circuit, state, int, state, circ->state) + ) +) + +/* Tracepoint emitted when a circuit is marked for close. */ +TRACEPOINT_EVENT(tor_circuit, mark_for_close, + TP_ARGS(const circuit_t *, circ), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) + ctf_enum(tor_circuit, state, int, state, circ->state) + ctf_enum(tor_circuit, end_reason, int, close_reason, + circ->marked_for_close_reason) + ctf_enum(tor_circuit, end_reason, int, orig_close_reason, + circ->marked_for_close_orig_reason) + ) +) + +/* Tracepoint emitted when a circuit changes purpose. */ +TRACEPOINT_EVENT(tor_circuit, change_purpose, + TP_ARGS(const circuit_t *, circ, int, old_purpose, int, new_purpose), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, state, int, state, circ->state) + ctf_enum(tor_circuit, purpose, int, purpose, old_purpose) + ctf_enum(tor_circuit, purpose, int, new, new_purpose) + ) +) + +/* Tracepoint emitted when a circuit changes state. */ +TRACEPOINT_EVENT(tor_circuit, change_state, + TP_ARGS(const circuit_t *, circ, int, old_state, int, new_state), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) + ctf_enum(tor_circuit, state, int, old, old_state) + ctf_enum(tor_circuit, state, int, new, new_state) + ) +) + +#endif /* LTTNG_CIRCUIT_INC || TRACEPOINT_HEADER_MULTI_READ */ + +/* Must be included after the probes declaration. */ +#include <lttng/tracepoint-event.h> + +#endif /* USE_TRACING_INSTRUMENTATION_LTTNG */ diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index a85ed089a..81bf761df 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -7,320 +7,16 @@ * LTTng-UST probes are available. **/ -#ifndef COCCI +#ifndef TOR_TRACE_PROBES_CIRCUIT_H +#define TOR_TRACE_PROBES_CIRCUIT_H #include "orconfig.h" /* We only build the following if LTTng instrumentation has been enabled. */ #ifdef USE_TRACING_INSTRUMENTATION_LTTNG -/* The following defines are LTTng-UST specific. */ -#undef TRACEPOINT_PROVIDER -#define TRACEPOINT_PROVIDER tor_circuit - -#undef TRACEPOINT_INCLUDE -#define TRACEPOINT_INCLUDE "./src/core/or/trace_probes_circuit.h" - -#if !defined(TOR_TRACE_PROBES_CIRCUIT_H) || \ - defined(TRACEPOINT_HEADER_MULTI_READ) -#define TOR_TRACE_PROBES_CIRCUIT_H - -#include <lttng/tracepoint.h> - -/* - * Circuit Purposes - * - * The following defines an enumeration of all possible circuit purpose so - * they appear in the trace with the define name (first parameter of - * ctf_enum_value) instead of the numerical value. - */ -TRACEPOINT_ENUM(tor_circuit, purpose, - TP_ENUM_VALUES( - /* Initializing. */ - ctf_enum_value("<UNSET>", 0) - - /* OR Side. */ - ctf_enum_value("OR", CIRCUIT_PURPOSE_OR) - ctf_enum_value("OR_INTRO_POINT", CIRCUIT_PURPOSE_INTRO_POINT) - ctf_enum_value("OR_REND_POINT_WAITING", - CIRCUIT_PURPOSE_REND_POINT_WAITING) - ctf_enum_value("OR_REND_ESTABLISHED", CIRCUIT_PURPOSE_REND_ESTABLISHED) - - /* Client Side. */ - ctf_enum_value("C_GENERAL", CIRCUIT_PURPOSE_C_GENERAL) - ctf_enum_value("C_INTRODUCING", CIRCUIT_PURPOSE_C_INTRODUCING) - ctf_enum_value("C_INTRODUCE_ACK_WAIT", - CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT) - ctf_enum_value("C_INTRODUCE_ACKED", CIRCUIT_PURPOSE_C_INTRODUCE_ACKED) - ctf_enum_value("C_ESTABLISH_REND", CIRCUIT_PURPOSE_C_ESTABLISH_REND) - ctf_enum_value("C_REND_READY", CIRCUIT_PURPOSE_C_REND_READY) - ctf_enum_value("C_REND_READY_INTRO_ACKED", - CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED) - ctf_enum_value("C_REND_JOINED", CIRCUIT_PURPOSE_C_REND_JOINED) - ctf_enum_value("C_HSDIR_GET", CIRCUIT_PURPOSE_C_HSDIR_GET) - - /* CBT and Padding. */ - ctf_enum_value("C_MEASURE_TIMEOUT", CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT) - ctf_enum_value("C_CIRCUIT_PADDING", CIRCUIT_PURPOSE_C_CIRCUIT_PADDING) - - /* Service Side. */ - ctf_enum_value("S_ESTABLISH_INTRO", CIRCUIT_PURPOSE_S_ESTABLISH_INTRO) - ctf_enum_value("S_INTRO", CIRCUIT_PURPOSE_S_INTRO) - ctf_enum_value("S_CONNECT_REND", CIRCUIT_PURPOSE_S_CONNECT_REND) - ctf_enum_value("S_REND_JOINED", CIRCUIT_PURPOSE_S_REND_JOINED) - ctf_enum_value("S_HSDIR_POST", CIRCUIT_PURPOSE_S_HSDIR_POST) - - /* Misc. */ - ctf_enum_value("TESTING", CIRCUIT_PURPOSE_TESTING) - ctf_enum_value("CONTROLER", CIRCUIT_PURPOSE_CONTROLLER) - ctf_enum_value("PATH_BIAS_TESTING", CIRCUIT_PURPOSE_PATH_BIAS_TESTING) - - /* VanGuard */ - ctf_enum_value("HS_VANGUARDS", CIRCUIT_PURPOSE_HS_VANGUARDS) - ) -) - -/* - * Circuit End Reasons - * - * The following defines an enumeration of all possible circuit end reasons so - * they appear in the trace with the define name (first parameter of - * ctf_enum_value) instead of the numerical value. - */ -TRACEPOINT_ENUM(tor_circuit, end_reason, - TP_ENUM_VALUES( - /* Local reasons. */ - ctf_enum_value("IP_NOW_REDUNDANT", END_CIRC_REASON_IP_NOW_REDUNDANT) - ctf_enum_value("MEASUREMENT_EXPIRED", END_CIRC_REASON_MEASUREMENT_EXPIRED) - ctf_enum_value("REASON_NOPATH", END_CIRC_REASON_NOPATH) - ctf_enum_value("AT_ORIGIN", END_CIRC_AT_ORIGIN) - ctf_enum_value("NONE", END_CIRC_REASON_NONE) - ctf_enum_value("TORPROTOCOL", END_CIRC_REASON_TORPROTOCOL) - ctf_enum_value("INTERNAL", END_CIRC_REASON_INTERNAL) - ctf_enum_value("REQUESTED", END_CIRC_REASON_REQUESTED) - ctf_enum_value("HIBERNATING", END_CIRC_REASON_HIBERNATING) - ctf_enum_value("RESOURCELIMIT", END_CIRC_REASON_RESOURCELIMIT) - ctf_enum_value("CONNECTFAILED", END_CIRC_REASON_CONNECTFAILED) - ctf_enum_value("OR_IDENTITY", END_CIRC_REASON_OR_IDENTITY) - ctf_enum_value("CHANNEL_CLOSED", END_CIRC_REASON_CHANNEL_CLOSED) - ctf_enum_value("FINISHED", END_CIRC_REASON_FINISHED) - ctf_enum_value("TIMEOUT", END_CIRC_REASON_TIMEOUT) - ctf_enum_value("DESTROYED", END_CIRC_REASON_DESTROYED) - ctf_enum_value("NOSUCHSERVICE", END_CIRC_REASON_NOSUCHSERVICE) - - /* Remote reasons. */ - ctf_enum_value("FLAG_REMOTE", END_CIRC_REASON_FLAG_REMOTE) - ctf_enum_value("REMOTE_TORPROTOCOL", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_TORPROTOCOL) - ctf_enum_value("REMOTE_INTERNAL", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_INTERNAL) - ctf_enum_value("REMOTE_REQUESTED", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_REQUESTED) - ctf_enum_value("REMOTE_HIBERNATING", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_HIBERNATING) - ctf_enum_value("REMOTE_RESOURCELIMIT", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_RESOURCELIMIT) - ctf_enum_value("REMOTE_CONNECTFAILED", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_CONNECTFAILED) - ctf_enum_value("REMOTE_OR_IDENTITY", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_OR_IDENTITY) - ctf_enum_value("REMOTE_CHANNEL_CLOSED", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_CHANNEL_CLOSED) - ctf_enum_value("REMOTE_FINISHED", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_FINISHED) - ctf_enum_value("REMOTE_TIMEOUT", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_TIMEOUT) - ctf_enum_value("REMOTE_DESTROYED", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_DESTROYED) - ctf_enum_value("REMOTE_NOSUCHSERVICE", - END_CIRC_REASON_FLAG_REMOTE | END_CIRC_REASON_NOSUCHSERVICE) - ) -) - -/* - * Circuit State - * - * The following defines an enumeration of all possible circuit state so they - * appear in the trace with the define name (first parameter of - * ctf_enum_value) instead of the numerical value. - */ -TRACEPOINT_ENUM(tor_circuit, state, - TP_ENUM_VALUES( - ctf_enum_value("BUILDING", CIRCUIT_STATE_BUILDING) - ctf_enum_value("ONIONSKIN_PENDING", CIRCUIT_STATE_ONIONSKIN_PENDING) - ctf_enum_value("CHAN_WAIT", CIRCUIT_STATE_CHAN_WAIT) - ctf_enum_value("GUARD_WAIT", CIRCUIT_STATE_GUARD_WAIT) - ctf_enum_value("OPEN", CIRCUIT_STATE_OPEN) - ) -) - -/* - * Event Class - * - * A tracepoint class is a class of tracepoints which share the same output - * event field definitions. They are then used by the - * TRACEPOINT_EVENT_INSTANCE() macro as a base field definition. - */ - -/* Class for origin circuit. */ -TRACEPOINT_EVENT_CLASS(tor_circuit, origin_circuit_t_class, - TP_ARGS(const origin_circuit_t *, circ), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, circ->global_identifier) - ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) - ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) - ) -) - -/* Class for or circuit. */ -TRACEPOINT_EVENT_CLASS(tor_circuit, or_circuit_t_class, - TP_ARGS(const or_circuit_t *, circ), - TP_FIELDS( - ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) - ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) - ) -) - -/* - * Origin circuit events. - * - * Tracepoint use the origin_circuit_t object. - */ - -/* Tracepoint emitted when a new origin circuit has been created. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, new_origin, - TP_ARGS(const origin_circuit_t *, circ) -) - -/* Tracepoint emitted when an origin circuit has opened. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, opened, - TP_ARGS(const origin_circuit_t *, circ) -) - -/* Tracepoint emitted when an origin circuit has established. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, establish, - TP_ARGS(const origin_circuit_t *, circ) -) - -/* Tracepoint emitted when an origin circuit has been cannibalized. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, cannibalized, - TP_ARGS(const origin_circuit_t *, circ) -) - -/* Tracepoint emitted when an origin circuit has timed out. This is called - * when circuit_expire_building() as selected the circuit and is about to - * close it for timeout. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, timeout, - TP_ARGS(const origin_circuit_t *, circ) -) - -/* Tracepoint emitted when an origin circuit has timed out due to idleness. - * This is when the circuit is closed after MaxCircuitDirtiness. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, idle_timeout, - TP_ARGS(const origin_circuit_t *, circ) -) - -/* Tracepoint emitted when an origin circuit sends out its first onion skin. */ -TRACEPOINT_EVENT(tor_circuit, first_onion_skin, - TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, circ->global_identifier) - ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) - ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) - ctf_array_hex(char, fingerprint, hop->extend_info->identity_digest, - DIGEST_LEN) - ) -) - -/* Tracepoint emitted when an origin circuit sends out an intermediate onion - * skin. */ -TRACEPOINT_EVENT(tor_circuit, intermediate_onion_skin, - TP_ARGS(const origin_circuit_t *, circ, const crypt_path_t *, hop), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, circ->global_identifier) - ctf_enum(tor_circuit, purpose, int, purpose, TO_CIRCUIT(circ)->purpose) - ctf_enum(tor_circuit, state, int, state, TO_CIRCUIT(circ)->state) - ctf_array_hex(char, fingerprint, hop->extend_info->identity_digest, - DIGEST_LEN) - ) -) - -/* - * OR circuit events. - * - * Tracepoint use the or_circuit_t object. - */ - -/* Tracepoint emitted when a new or circuit has been created. */ -TRACEPOINT_EVENT_INSTANCE(tor_circuit, or_circuit_t_class, new_or, - TP_ARGS(const or_circuit_t *, circ) -) - -/* - * General circuit events. - * - * Tracepoint use the circuit_t object. - */ - -/* Tracepoint emitted when a circuit is freed. */ -TRACEPOINT_EVENT(tor_circuit, free, - TP_ARGS(const circuit_t *, circ), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, - (CIRCUIT_IS_ORIGIN(circ) ? - TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) - ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) - ctf_enum(tor_circuit, state, int, state, circ->state) - ) -) - -/* Tracepoint emitted when a circuit is marked for close. */ -TRACEPOINT_EVENT(tor_circuit, mark_for_close, - TP_ARGS(const circuit_t *, circ), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, - (CIRCUIT_IS_ORIGIN(circ) ? - TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) - ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) - ctf_enum(tor_circuit, state, int, state, circ->state) - ctf_enum(tor_circuit, end_reason, int, close_reason, - circ->marked_for_close_reason) - ctf_enum(tor_circuit, end_reason, int, orig_close_reason, - circ->marked_for_close_orig_reason) - ) -) - -/* Tracepoint emitted when a circuit changes purpose. */ -TRACEPOINT_EVENT(tor_circuit, change_purpose, - TP_ARGS(const circuit_t *, circ, int, old_purpose, int, new_purpose), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, - (CIRCUIT_IS_ORIGIN(circ) ? - TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) - ctf_enum(tor_circuit, state, int, state, circ->state) - ctf_enum(tor_circuit, purpose, int, purpose, old_purpose) - ctf_enum(tor_circuit, purpose, int, new, new_purpose) - ) -) - -/* Tracepoint emitted when a circuit changes state. */ -TRACEPOINT_EVENT(tor_circuit, change_state, - TP_ARGS(const circuit_t *, circ, int, old_state, int, new_state), - TP_FIELDS( - ctf_integer(uint32_t, circ_id, - (CIRCUIT_IS_ORIGIN(circ) ? - TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) - ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) - ctf_enum(tor_circuit, state, int, old, old_state) - ctf_enum(tor_circuit, state, int, new, new_state) - ) -) - -#endif /* TOR_TRACE_PROBES_CIRCUIT_H */ - -/* Must be included after the probes declaration. */ -#include <lttng/tracepoint-event.h> +#include "core/or/lttng_circuit.inc" #endif /* USE_TRACING_INSTRUMENTATION_LTTNG */ -#endif /* COCCI */ +#endif /* TOR_TRACE_PROBES_CIRCUIT_H */

1 0

[tor/master] trace: Helper macro to disambiguate identifiers
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit 3604d86a016b6202a5864a81f46addc087658b8c Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Mar 11 10:54:47 2020 -0400 trace: Helper macro to disambiguate identifiers In order to disambiguate the subsystem and event_name identifiers in the tor_trace() macro, add TR_SUBSYS() and TR_EV() which help to identify the parameters of tor_trace() explicitly. Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- src/core/or/circuitbuild.c | 6 +++--- src/core/or/circuitlist.c | 11 +++++------ src/core/or/circuituse.c | 15 +++++++++------ src/core/or/trace_probes_circuit.h | 2 +- src/lib/trace/events.h | 17 ++++++++++++++--- 5 files changed, 32 insertions(+), 19 deletions(-) diff --git a/src/core/or/circuitbuild.c b/src/core/or/circuitbuild.c index 034a0dc77..24543d3ac 100644 --- a/src/core/or/circuitbuild.c +++ b/src/core/or/circuitbuild.c @@ -500,7 +500,7 @@ circuit_establish_circuit(uint8_t purpose, extend_info_t *exit_ei, int flags) return NULL; } - tor_trace(circuit, establish, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(establish), circ); return circ; } @@ -983,7 +983,7 @@ circuit_send_first_onion_skin(origin_circuit_t *circ) if (circuit_deliver_create_cell(TO_CIRCUIT(circ), &cc, 0) < 0) return - END_CIRC_REASON_RESOURCELIMIT; - tor_trace(circuit, first_onion_skin, circ, circ->cpath); + tor_trace(TR_SUBSYS(circuit), TR_EV(first_onion_skin), circ, circ->cpath); circ->cpath->state = CPATH_STATE_AWAITING_KEYS; circuit_set_state(TO_CIRCUIT(circ), CIRCUIT_STATE_BUILDING); @@ -1147,7 +1147,7 @@ circuit_send_intermediate_onion_skin(origin_circuit_t *circ, return 0; /* circuit is closed */ } hop->state = CPATH_STATE_AWAITING_KEYS; - tor_trace(circuit, intermediate_onion_skin, circ, hop); + tor_trace(TR_SUBSYS(circuit), TR_EV(intermediate_onion_skin), circ, hop); return 0; } diff --git a/src/core/or/circuitlist.c b/src/core/or/circuitlist.c index b3cc67e9d..fef13fa3f 100644 --- a/src/core/or/circuitlist.c +++ b/src/core/or/circuitlist.c @@ -100,7 +100,6 @@ #include "lib/compress/compress_zlib.h" #include "lib/compress/compress_zstd.h" #include "lib/buf/buffers.h" -#include "lib/trace/events.h" #include "core/or/ocirc_event.h" @@ -568,7 +567,7 @@ circuit_set_state(circuit_t *circ, uint8_t state) if (state == CIRCUIT_STATE_GUARD_WAIT || state == CIRCUIT_STATE_OPEN) tor_assert(!circ->n_chan_create_cell); - tor_trace(circuit, change_state, circ, circ->state, state); + tor_trace(TR_SUBSYS(circuit), TR_EV(change_state), circ, circ->state, state); circ->state = state; if (CIRCUIT_IS_ORIGIN(circ)) circuit_state_publish(circ); @@ -1083,7 +1082,7 @@ origin_circuit_new(void) prediction_time_remaining); } - tor_trace(circuit, new_origin, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(new_origin), circ); return circ; } @@ -1106,7 +1105,7 @@ or_circuit_new(circid_t p_circ_id, channel_t *p_chan) init_circuit_base(TO_CIRCUIT(circ)); - tor_trace(circuit, new_or, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(new_or), circ); return circ; } @@ -1261,7 +1260,7 @@ circuit_free_(circuit_t *circ) /* Tracepoint. Data within the circuit object is recorded so do this before * the actual memory free. */ - tor_trace(circuit, free, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(free), circ); if (should_free) { memwipe(mem, 0xAA, memlen); /* poison memory */ @@ -2285,7 +2284,7 @@ circuit_mark_for_close_, (circuit_t *circ, int reason, int line, CIRCUIT_IS_ORIGIN(circ) ? TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0, file, line, orig_reason, reason); - tor_trace(circuit, mark_for_close, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(mark_for_close), circ); } /** Called immediately before freeing a marked circuit <b>circ</b> from diff --git a/src/core/or/circuituse.c b/src/core/or/circuituse.c index ac03b76d5..d2bdf77d8 100644 --- a/src/core/or/circuituse.c +++ b/src/core/or/circuituse.c @@ -840,7 +840,7 @@ circuit_expire_building(void) -1); circuit_log_path(LOG_INFO,LD_CIRC,TO_ORIGIN_CIRCUIT(victim)); - tor_trace(circuit, timeout, TO_ORIGIN_CIRCUIT(victim)); + tor_trace(TR_SUBSYS(circuit), TR_EV(timeout), TO_ORIGIN_CIRCUIT(victim)); if (victim->purpose == CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT) circuit_mark_for_close(victim, END_CIRC_REASON_MEASUREMENT_EXPIRED); else @@ -1505,7 +1505,8 @@ circuit_expire_old_circuits_clientside(void) /* Don't do this magic for testing circuits. Their death is governed * by circuit_expire_building */ if (circ->purpose != CIRCUIT_PURPOSE_PATH_BIAS_TESTING) { - tor_trace(circuit, idle_timeout, TO_ORIGIN_CIRCUIT(circ)); + tor_trace(TR_SUBSYS(circuit), TR_EV(idle_timeout), + TO_ORIGIN_CIRCUIT(circ)); circuit_mark_for_close(circ, END_CIRC_REASON_FINISHED); } } else if (!circ->timestamp_dirty && circ->state == CIRCUIT_STATE_OPEN) { @@ -1526,7 +1527,8 @@ circuit_expire_old_circuits_clientside(void) " that has been unused for %ld msec.", TO_ORIGIN_CIRCUIT(circ)->global_identifier, tv_mdiff(&circ->timestamp_began, &now)); - tor_trace(circuit, idle_timeout, TO_ORIGIN_CIRCUIT(circ)); + tor_trace(TR_SUBSYS(circuit), TR_EV(idle_timeout), + TO_ORIGIN_CIRCUIT(circ)); circuit_mark_for_close(circ, END_CIRC_REASON_FINISHED); } else if (!TO_ORIGIN_CIRCUIT(circ)->is_ancient) { /* Server-side rend joined circuits can end up really old, because @@ -1689,7 +1691,7 @@ circuit_testing_failed(origin_circuit_t *circ, int at_last_hop) void circuit_has_opened(origin_circuit_t *circ) { - tor_trace(circuit, opened, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(opened), circ); circuit_event_status(circ, CIRC_EVENT_BUILT, 0); /* Remember that this circuit has finished building. Now if we start @@ -2212,7 +2214,7 @@ circuit_launch_by_extend_info(uint8_t purpose, return NULL; } - tor_trace(circuit, cannibalized, circ); + tor_trace(TR_SUBSYS(circuit), TR_EV(cannibalized), circ); return circ; } } @@ -3144,7 +3146,8 @@ circuit_change_purpose(circuit_t *circ, uint8_t new_purpose) old_purpose = circ->purpose; circ->purpose = new_purpose; - tor_trace(circuit, change_purpose, circ, old_purpose, new_purpose); + tor_trace(TR_SUBSYS(circuit), TR_EV(change_purpose), circ, old_purpose, + new_purpose); if (CIRCUIT_IS_ORIGIN(circ)) { control_event_circuit_purpose_changed(TO_ORIGIN_CIRCUIT(circ), diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index 81bf761df..59f53c324 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -10,7 +10,7 @@ #ifndef TOR_TRACE_PROBES_CIRCUIT_H #define TOR_TRACE_PROBES_CIRCUIT_H -#include "orconfig.h" +#include "lib/trace/events.h" /* We only build the following if LTTng instrumentation has been enabled. */ #ifdef USE_TRACING_INSTRUMENTATION_LTTNG diff --git a/src/lib/trace/events.h b/src/lib/trace/events.h index 4a8078bf3..ce1604de2 100644 --- a/src/lib/trace/events.h +++ b/src/lib/trace/events.h @@ -9,6 +9,8 @@ #ifndef TOR_LIB_TRACE_EVENTS_H #define TOR_LIB_TRACE_EVENTS_H +#include "orconfig.h" + /* * A tracepoint signature is defined as follow: * @@ -34,13 +36,22 @@ * enabling this instrumentation provides both probes. */ +/** Helper to disambiguate these identifiers in the code base. They should + * only be used with tor_trace() like so: + * + * tor_trace(TR_SUBSYS(circuit), TR_EV(opened), ...); + */ + +#define TR_SUBSYS(name) tor_ ## name +#define TR_EV(name) name + #ifdef HAVE_TRACING #define tor_trace(subsystem, event_name, ...) \ do { \ - TOR_TRACE_LOG_DEBUG(tor_ ## subsystem, event_name); \ - TOR_TRACE_USDT(tor_ ## subsystem, event_name, ## __VA_ARGS__); \ - TOR_TRACE_LTTNG(tor_ ## subsystem, event_name, ## __VA_ARGS__); \ + TOR_TRACE_LOG_DEBUG(subsystem, event_name); \ + TOR_TRACE_USDT(subsystem, event_name, ## __VA_ARGS__); \ + TOR_TRACE_LTTNG(subsystem, event_name, ## __VA_ARGS__); \ } while (0) /* This corresponds to the --enable-tracing-instrumentation-log-debug

1 0

[tor/master] trace: Only build probes if instrumentation is enabled
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit 24a5983d84a99dc10c0b8fe961af03135960085b Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 13 10:44:00 2020 -0500 trace: Only build probes if instrumentation is enabled For now, trace_probes_circuit.c only contains LTTng probes so build it only if enabled within in the build system _and_ the code. Also, ignore trace_probes_circuit.h for coccinelle parsing. Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- src/core/or/include.am | 9 +++++++-- src/core/or/trace_probes_circuit.h | 7 ++++++- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/core/or/include.am b/src/core/or/include.am index 819b8ab60..9ff92adbd 100644 --- a/src/core/or/include.am +++ b/src/core/or/include.am @@ -34,7 +34,6 @@ LIBTOR_APP_A_SOURCES += \ src/core/or/scheduler_vanilla.c \ src/core/or/sendme.c \ src/core/or/status.c \ - src/core/or/trace_probes_circuit.c \ src/core/or/versions.c # ADD_C_FILE: INSERT HEADERS HERE. @@ -95,6 +94,12 @@ noinst_HEADERS += \ src/core/or/socks_request_st.h \ src/core/or/status.h \ src/core/or/tor_version_st.h \ - src/core/or/trace_probes_circuit.h \ src/core/or/var_cell_st.h \ src/core/or/versions.h + +if USE_TRACING_INSTRUMENTATION_LTTNG +LIBTOR_APP_A_SOURCES += \ + src/core/or/trace_probes_circuit.c +noinst_HEADERS += \ + src/core/or/trace_probes_circuit.h +endif diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index 44842efb0..a85ed089a 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -7,6 +7,8 @@ * LTTng-UST probes are available. **/ +#ifndef COCCI + #include "orconfig.h" /* We only build the following if LTTng instrumentation has been enabled. */ @@ -19,7 +21,8 @@ #undef TRACEPOINT_INCLUDE #define TRACEPOINT_INCLUDE "./src/core/or/trace_probes_circuit.h" -#if !defined(TOR_TRACE_PROBES_CIRCUIT_H) || defined(TRACEPOINT_HEADER_MULTI_READ) +#if !defined(TOR_TRACE_PROBES_CIRCUIT_H) || \ + defined(TRACEPOINT_HEADER_MULTI_READ) #define TOR_TRACE_PROBES_CIRCUIT_H #include <lttng/tracepoint.h> @@ -319,3 +322,5 @@ TRACEPOINT_EVENT(tor_circuit, change_state, #include <lttng/tracepoint-event.h> #endif /* USE_TRACING_INSTRUMENTATION_LTTNG */ + +#endif /* COCCI */

1 0

[tor/master] trace: Emit a warning if tracing is built in
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit b049cc3ace18dd42493ca768cf4636dfd89569fc Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Mar 11 12:12:28 2020 -0400 trace: Emit a warning if tracing is built in Built in tracing should _not_ be run if it was not set on purpose. Warn as loud as we can in order to inform the user that they are running a version with tracing capabilities built in. This commit also adds a subsys stub because utlimately the logging will happen in the init phase but because the default log file is not set in the sys_logging init function, the stub is not useful for now. Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- configure.ac | 7 ++++++- src/app/main/main.c | 4 ++++ src/lib/trace/include.am | 4 ++++ src/lib/trace/trace.h | 21 +++++++++++++++++++++ src/lib/trace/trace_stub.c | 19 +++++++++++++++++++ src/lib/trace/trace_sys.c | 5 ++++- src/lib/trace/trace_sys.h | 8 ++++++++ 7 files changed, 66 insertions(+), 2 deletions(-) diff --git a/configure.ac b/configure.ac index cd014268b..75fd709f9 100644 --- a/configure.ac +++ b/configure.ac @@ -273,9 +273,9 @@ if test "x$enable_tracing_instrumentation_lttng" = "xyes"; then On Debian, apt install liblttng-ust-dev"])], []) AC_DEFINE([USE_TRACING_INSTRUMENTATION_LTTNG], [1], [Using LTTng instrumentation]) TOR_TRACE_LIBS="-llttng-ust -ldl" + have_tracing=1 fi - dnl USDT instrumentation option. AC_ARG_ENABLE(tracing-instrumentation-usdt, AS_HELP_STRING([--enable-tracing-instrumentation-usdt], @@ -291,6 +291,7 @@ if test "x$enable_tracing_instrumentation_usdt" = "xyes"; then dnl --with-sdt. There is unfortunately no way to check that so we always dnl build the USDT probes even though LTTng instrumentation was requested. AC_DEFINE([USE_TRACING_INSTRUMENTATION_USDT], [1], [Using USDT instrumentation]) + have_tracing=1 fi dnl Tracepoints event to debug logs. @@ -301,6 +302,9 @@ AC_ARG_ENABLE(tracing-instrumentation-log-debug, [Tracepoints to log debug]), []) AM_CONDITIONAL([USE_TRACING_INSTRUMENTATION_LOG_DEBUG], [test "x$enable_tracing_instrumentation_log_debug" = "xyes"]) +if test "x$enable_tracing_instrumentation_log_debug" = "xyes"; then + have_tracing=1 +fi dnl Define that tracing is supported if any instrumentation is used. AM_COND_IF([USE_TRACING_INSTRUMENTATION_LOG_DEBUG], @@ -309,6 +313,7 @@ AM_COND_IF([USE_TRACING_INSTRUMENTATION_USDT], AC_DEFINE([HAVE_TRACING], [1], [Compiled with tracing support])) AM_COND_IF([USE_TRACING_INSTRUMENTATION_LTTNG], AC_DEFINE([HAVE_TRACING], [1], [Compiled with tracing support])) +AM_CONDITIONAL([USE_TRACING], [test "x$have_tracing" = x1 ]) dnl Finally, define the trace libs. AC_SUBST([TOR_TRACE_LIBS]) diff --git a/src/app/main/main.c b/src/app/main/main.c index 89ba78742..e1d5772e3 100644 --- a/src/app/main/main.c +++ b/src/app/main/main.c @@ -59,6 +59,7 @@ #include "lib/crypt_ops/crypto_rand.h" #include "lib/crypt_ops/crypto_s2k.h" #include "lib/net/resolve.h" +#include "lib/trace/trace.h" #include "lib/process/waitpid.h" #include "lib/pubsub/pubsub_build.h" @@ -602,6 +603,9 @@ tor_init(int argc, char *argv[]) rust_log_welcome_string(); #endif /* defined(HAVE_RUST) */ + /* Warn _if_ the tracing subsystem is built in. */ + tracing_log_warning(); + int init_rv = options_init_from_torrc(argc,argv); if (init_rv < 0) { log_err(LD_CONFIG,"Reading config failed--see warnings above."); diff --git a/src/lib/trace/include.am b/src/lib/trace/include.am index 844033132..6fe136565 100644 --- a/src/lib/trace/include.am +++ b/src/lib/trace/include.am @@ -26,6 +26,10 @@ if USE_TRACING_INSTRUMENTATION_LTTNG include src/lib/trace/lttng/include.am endif +if USE_TRACING src_lib_libtor_trace_a_SOURCES = $(LIBTOR_TRACE_A_SOURCES) +else +src_lib_libtor_trace_a_SOURCES = src/lib/trace/trace_stub.c +endif noinst_HEADERS+= $(TRACEHEADERS) diff --git a/src/lib/trace/trace.h b/src/lib/trace/trace.h index 94cbbc1e4..22589dbe9 100644 --- a/src/lib/trace/trace.h +++ b/src/lib/trace/trace.h @@ -9,7 +9,28 @@ #ifndef TOR_LIB_TRACE_TRACE_H #define TOR_LIB_TRACE_TRACE_H +#include "orconfig.h" + void tor_trace_init(void); void tor_trace_free_all(void); +#ifdef HAVE_TRACING + +#include "lib/log/log.h" + +static inline void +tracing_log_warning(void) +{ + log_warn(LD_GENERAL, + "Tracing capabilities have been built in. If this is NOT on " + "purpose, your tor is NOT safe to run."); +} + +#else + +/* NOP it. */ +#define tracing_log_warning() + +#endif /* defined(HAVE_TRACING) */ + #endif /* !defined(TOR_LIB_TRACE_TRACE_H) */ diff --git a/src/lib/trace/trace_stub.c b/src/lib/trace/trace_stub.c new file mode 100644 index 000000000..9043efe36 --- /dev/null +++ b/src/lib/trace/trace_stub.c @@ -0,0 +1,19 @@ +/* Copyright (c) 2020, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file trace_stub.c + * \brief Stub declaratinos for use when trace library is disabled. + **/ + +#include "lib/subsys/subsys.h" + +#include "lib/trace/trace_sys.h" + +const subsys_fns_t sys_tracing = { + SUBSYS_DECLARE_LOCATION(), + + .name = "tracing", + .supported = false, + .level = TRACE_SUBSYS_LEVEL, +}; diff --git a/src/lib/trace/trace_sys.c b/src/lib/trace/trace_sys.c index d6e59f4c3..2ba025840 100644 --- a/src/lib/trace/trace_sys.c +++ b/src/lib/trace/trace_sys.c @@ -25,9 +25,12 @@ subsys_tracing_shutdown(void) } const subsys_fns_t sys_tracing = { + SUBSYS_DECLARE_LOCATION(), + .name = "tracing", .supported = true, - .level = -85, + .level = TRACE_SUBSYS_LEVEL, + .initialize = subsys_tracing_initialize, .shutdown = subsys_tracing_shutdown, }; diff --git a/src/lib/trace/trace_sys.h b/src/lib/trace/trace_sys.h index e9c97c08f..d4da5a970 100644 --- a/src/lib/trace/trace_sys.h +++ b/src/lib/trace/trace_sys.h @@ -11,4 +11,12 @@ extern const struct subsys_fns_t sys_tracing; +/** + * Subsystem level for the tracing system. + * + * Defined here so that it can be shared between the real and stub + * definitions. + **/ +#define TRACE_SUBSYS_LEVEL (-85) + #endif /* !defined(TOR_TRACE_SYS_H) */

1 0

[tor/master] trace: Add four generic circuit tracepoints
by nickm＠torproject.org 10 Jul '20

10 Jul '20

commit d36a44ffa965e69a943068ab457a6528ef204b00 Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Jan 15 12:36:18 2020 -0500 trace: Add four generic circuit tracepoints Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- src/core/or/circuitlist.c | 9 +++++++ src/core/or/circuituse.c | 1 + src/core/or/trace_probes_circuit.h | 54 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+) diff --git a/src/core/or/circuitlist.c b/src/core/or/circuitlist.c index f4d6cd3c1..10fba498a 100644 --- a/src/core/or/circuitlist.c +++ b/src/core/or/circuitlist.c @@ -65,6 +65,7 @@ #include "core/or/circuitpadding.h" #include "core/or/crypt_path.h" #include "core/or/extendinfo.h" +#include "core/or/trace_probes_circuit.h" #include "core/mainloop/connection.h" #include "app/config/config.h" #include "core/or/connection_edge.h" @@ -99,6 +100,7 @@ #include "lib/compress/compress_zlib.h" #include "lib/compress/compress_zstd.h" #include "lib/buf/buffers.h" +#include "lib/trace/events.h" #include "core/or/ocirc_event.h" @@ -565,6 +567,8 @@ circuit_set_state(circuit_t *circ, uint8_t state) } if (state == CIRCUIT_STATE_GUARD_WAIT || state == CIRCUIT_STATE_OPEN) tor_assert(!circ->n_chan_create_cell); + + tor_trace(circuit, change_state, circ, circ->state, state); circ->state = state; if (CIRCUIT_IS_ORIGIN(circ)) circuit_state_publish(circ); @@ -1253,6 +1257,10 @@ circuit_free_(circuit_t *circ) /* Clear all dangling handle references. */ circuit_handles_clear(circ); + /* Tracepoint. Data within the circuit object is recorded so do this before + * the actual memory free. */ + tor_trace(circuit, free, circ); + if (should_free) { memwipe(mem, 0xAA, memlen); /* poison memory */ tor_free(mem); @@ -2275,6 +2283,7 @@ circuit_mark_for_close_, (circuit_t *circ, int reason, int line, CIRCUIT_IS_ORIGIN(circ) ? TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0, file, line, orig_reason, reason); + tor_trace(circuit, mark_for_close, circ); } /** Called immediately before freeing a marked circuit <b>circ</b> from diff --git a/src/core/or/circuituse.c b/src/core/or/circuituse.c index b9c15c155..ac03b76d5 100644 --- a/src/core/or/circuituse.c +++ b/src/core/or/circuituse.c @@ -3144,6 +3144,7 @@ circuit_change_purpose(circuit_t *circ, uint8_t new_purpose) old_purpose = circ->purpose; circ->purpose = new_purpose; + tor_trace(circuit, change_purpose, circ, old_purpose, new_purpose); if (CIRCUIT_IS_ORIGIN(circ)) { control_event_circuit_purpose_changed(TO_ORIGIN_CIRCUIT(circ), diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h index c0dbd1a50..e306a7886 100644 --- a/src/core/or/trace_probes_circuit.h +++ b/src/core/or/trace_probes_circuit.h @@ -163,6 +163,60 @@ TRACEPOINT_EVENT_INSTANCE(tor_circuit, origin_circuit_t_class, idle_timeout, TP_ARGS(const origin_circuit_t *, circ) ) +/* + * General circuit events. + */ + +TRACEPOINT_EVENT(tor_circuit, free, + TP_ARGS(const circuit_t *, circ), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) + ctf_enum(tor_circuit, state, int, state, circ->state) + ) +) + +TRACEPOINT_EVENT(tor_circuit, mark_for_close, + TP_ARGS(const circuit_t *, circ), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) + ctf_enum(tor_circuit, state, int, state, circ->state) + ctf_enum(tor_circuit, end_reason, int, close_reason, + circ->marked_for_close_reason) + ctf_enum(tor_circuit, end_reason, int, orig_close_reason, + circ->marked_for_close_orig_reason) + ) +) + +TRACEPOINT_EVENT(tor_circuit, change_purpose, + TP_ARGS(const circuit_t *, circ, int, old_purpose, int, new_purpose), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, state, int, state, circ->state) + ctf_enum(tor_circuit, purpose, int, purpose, old_purpose) + ctf_enum(tor_circuit, purpose, int, new, new_purpose) + ) +) + +TRACEPOINT_EVENT(tor_circuit, change_state, + TP_ARGS(const circuit_t *, circ, int, old_state, int, new_state), + TP_FIELDS( + ctf_integer(uint32_t, circ_id, + (CIRCUIT_IS_ORIGIN(circ) ? + TO_ORIGIN_CIRCUIT(circ)->global_identifier : 0)) + ctf_enum(tor_circuit, purpose, int, purpose, circ->purpose) + ctf_enum(tor_circuit, state, int, old, old_state) + ctf_enum(tor_circuit, state, int, new, new_state) + ) +) + #endif /* TOR_TRACE_PROBES_CIRCUIT_H */ /* Must be include after the probes declaration. */

1 0