include/lttng/event-internal.h

   1 /*
   2  * event-internal.h
   3  *
   4  * Linux Trace Toolkit Control Library
   5  *
   6  * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * SPDX-License-Identifier: LGPL-2.1-only
   9  *
  10  */
  11
  12 #ifndef LTTNG_EVENT_INTERNAL_H
  13 #define LTTNG_EVENT_INTERNAL_H
  14
  15 #include <common/macros.h>
  16 #include <lttng/event.h>
  17 #include <lttng/lttng-error.h>
  18
  19 struct lttng_event_exclusion;
  20 struct lttng_userspace_probe_location;
  21 struct lttng_dynamic_buffer;
  22 struct lttng_buffer_view;
  23
  24 struct lttng_event_comm {
  25         int8_t event_type;
  26         int8_t loglevel_type;
  27         int32_t loglevel;
  28         int8_t enabled;
  29         int32_t pid;
  30         uint32_t flags;
  31
  32         /* Payload. */
  33         /* Includes terminator `\0`. */
  34         uint32_t name_len;
  35         uint32_t exclusion_count;
  36         /* Includes terminator `\0`. */
  37         uint32_t filter_expression_len;
  38         uint32_t bytecode_len;
  39
  40         /* Type specific payload. */
  41         uint32_t userspace_probe_location_len;
  42         uint32_t lttng_event_probe_attr_len;
  43         uint32_t lttng_event_function_attr_len;
  44
  45         /*
  46          * Contain:
  47          * - name [name_len],
  48          * - exclusions if any
  49          * - char filter_expression[filter_expression_len],
  50          * - unsigned char filter_bytecode[bytecode_len],
  51          * - userspace probe location [userspace_probe_location_len],
  52          * - probe or ftrace based on event type.
  53          */
  54
  55         char payload[];
  56 } LTTNG_PACKED;
  57
  58 struct lttng_event_exclusion_comm {
  59         /* Includes terminator `\0`. */
  60         uint32_t len;
  61         char payload [];
  62 } LTTNG_PACKED;
  63
  64 struct lttng_event_probe_attr_comm {
  65         uint64_t addr;
  66         uint64_t offset;
  67         /* Includes terminator `\0`. */
  68         uint32_t symbol_name_len;
  69
  70         char payload[];
  71 } LTTNG_PACKED;
  72
  73 struct lttng_event_function_attr_comm {
  74         /* Includes terminator `\0`. */
  75         uint32_t symbol_name_len;
  76
  77         char payload[];
  78 } LTTNG_PACKED;
  79
  80 struct lttng_event_context_comm {
  81         uint32_t type;
  82         /*
  83          * Depending on the type.
  84          * For:
  85          *  - LTTNG_EVENT_CONTEXT_APP_CONTEXT.
  86          *
  87          *  -> struct lttng_event_context_app_comm
  88          *
  89          * For
  90          *  - LTTNG_EVENT_CONTEXT_PERF_COUNTER,
  91          *  - LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER,
  92          *  - LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER.
  93          *
  94          *  -> struct lttng_event_context_perf_counter_comm
  95          *
  96          *  Other type -> no payload.
  97          */
  98         char payload[];
  99 } LTTNG_PACKED;
 100
 101 struct lttng_event_context_perf_counter_comm {
 102         uint32_t type;
 103         uint64_t config;
 104         /* Includes terminator `\0`. */
 105         uint32_t name_len;
 106         /*
 107          * char name [name_len]
 108          */
 109         char payload[];
 110 } LTTNG_PACKED;
 111
 112 struct lttng_event_context_app_comm {
 113         /* Includes terminator `\0`. */
 114         uint32_t provider_name_len;
 115         /* Includes terminator `\0`. */
 116         uint32_t ctx_name_len;
 117         /*
 118          * provider name [provider_name_len]
 119          * ctx name [ctx_name_len]
 120          */
 121         char payload[];
 122 } LTTNG_PACKED;
 123
 124 struct lttng_event_field_comm {
 125         uint8_t type;
 126         uint8_t nowrite;
 127         /* Includes terminator `\0`. */
 128         uint32_t name_len;
 129         uint32_t event_len;
 130
 131         /*
 132          * - name [name_len]
 133          * - lttng_event object
 134          */
 135         char payload[];
 136 } LTTNG_PACKED;
 137
 138 struct lttng_event_extended {
 139         /*
 140          * exclusions and filter_expression are only set when the lttng_event
 141          * was created/allocated by a list operation. These two elements must
 142          * not be free'd as they are part of the same contiguous buffer that
 143          * contains all events returned by the listing.
 144          */
 145         char *filter_expression;
 146         struct {
 147                 unsigned int count;
 148                 /* Array of strings of fixed LTTNG_SYMBOL_NAME_LEN length. */
 149                 char *strings;
 150         } exclusions;
 151         struct lttng_userspace_probe_location *probe_location;
 152 };
 153
 154 struct lttng_event *lttng_event_copy(const struct lttng_event *event);
 155
 156 ssize_t lttng_event_create_from_payload(struct lttng_payload_view *view,
 157                 struct lttng_event **out_event,
 158                 struct lttng_event_exclusion **out_exclusion,
 159                 char **out_filter_expression,
 160                 struct lttng_bytecode **out_bytecode);
 161
 162 int lttng_event_serialize(const struct lttng_event *event,
 163                 unsigned int exclusion_count,
 164                 char **exclusion_list,
 165                 char *filter_expression,
 166                 size_t bytecode_len,
 167                 struct lttng_bytecode *bytecode,
 168                 struct lttng_payload *payload);
 169
 170 ssize_t lttng_event_context_create_from_payload(
 171                 struct lttng_payload_view *view,
 172                 struct lttng_event_context **event_ctx);
 173
 174 int lttng_event_context_serialize(struct lttng_event_context *context,
 175                 struct lttng_payload *payload);
 176
 177 void lttng_event_context_destroy(struct lttng_event_context *context);
 178
 179 enum lttng_error_code lttng_events_create_and_flatten_from_payload(
 180                 struct lttng_payload_view *view,
 181                 unsigned int count,
 182                 struct lttng_event **events);
 183
 184 ssize_t lttng_event_field_create_from_payload(
 185                 struct lttng_payload_view *view,
 186                 struct lttng_event_field **field);
 187
 188 int lttng_event_field_serialize(const struct lttng_event_field *field,
 189                 struct lttng_payload *payload);
 190
 191 enum lttng_error_code lttng_event_fields_create_and_flatten_from_payload(
 192                 struct lttng_payload_view *view,
 193                 unsigned int count,
 194                 struct lttng_event_field **fields);
 195
 196 #endif /* LTTNG_EVENT_INTERNAL_H */