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@torproject.org>

1 files changed, 4 insertions, 308 deletions

diff --git a/src/core/or/trace_probes_circuit.h b/src/core/or/trace_probes_circuit.h
index a85ed089ad..81bf761df9 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 */