src/bin/lttng-sessiond/trace-kernel.h

   1 /*
   2  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #ifndef _LTT_TRACE_KERNEL_H
   9 #define _LTT_TRACE_KERNEL_H
  10
  11 #include <urcu/list.h>
  12
  13 #include <lttng/lttng.h>
  14 #include <common/lttng-kernel.h>
  15 #include <common/lttng-kernel-old.h>
  16 #include <common/defaults.h>
  17
  18 #include "consumer.h"
  19 #include "tracker.h"
  20
  21 /* Kernel event list */
  22 struct ltt_kernel_event_list {
  23         struct cds_list_head head;
  24 };
  25
  26 /* Kernel event rule token list */
  27 struct ltt_kernel_token_event_rule_list {
  28         struct cds_list_head head;
  29 };
  30
  31 /* Channel stream list */
  32 struct ltt_kernel_stream_list {
  33         struct cds_list_head head;
  34 };
  35
  36 /* Channel list */
  37 struct ltt_kernel_channel_list {
  38         struct cds_list_head head;
  39 };
  40
  41 struct ltt_kernel_context {
  42         struct lttng_kernel_context ctx;
  43         struct cds_list_head list;
  44         /* Indicates whether or not the context is in a list. */
  45         bool in_list;
  46 };
  47
  48 /* Kernel event */
  49 struct ltt_kernel_event {
  50         int fd;
  51         int enabled;
  52         enum lttng_event_type type;
  53         struct lttng_kernel_event *event;
  54         struct cds_list_head list;
  55         char *filter_expression;
  56         struct lttng_filter_bytecode *filter;
  57         struct lttng_userspace_probe_location *userspace_probe_location;
  58 };
  59
  60 /* Kernel event */
  61 struct ltt_kernel_token_event_rule {
  62         int fd;
  63         int enabled;
  64         enum lttng_event_type type;
  65         struct lttng_event_rule *event_rule;
  66         struct cds_list_head list;
  67         uint64_t token;
  68         const struct lttng_filter_bytecode *filter;
  69         struct lttng_userspace_probe_location *userspace_probe_location;
  70 };
  71
  72 /* Kernel channel */
  73 struct ltt_kernel_channel {
  74         int fd;
  75         uint64_t key; /* Key to reference this channel with the consumer. */
  76         int enabled;
  77         unsigned int stream_count;
  78         unsigned int event_count;
  79         bool published_to_notification_thread;
  80         struct cds_list_head ctx_list;
  81         struct lttng_channel *channel;
  82         struct ltt_kernel_event_list events_list;
  83         struct ltt_kernel_stream_list stream_list;
  84         struct cds_list_head list;
  85         /* Session pointer which has a reference to this object. */
  86         struct ltt_kernel_session *session;
  87         bool sent_to_consumer;
  88 };
  89
  90 /* Metadata */
  91 struct ltt_kernel_metadata {
  92         int fd;
  93         uint64_t key; /* Key to reference this channel with the consumer. */
  94         struct lttng_channel *conf;
  95 };
  96
  97 /* Channel stream */
  98 struct ltt_kernel_stream {
  99         int fd;
 100         int state;
 101         int cpu;
 102         bool sent_to_consumer;
 103         /* Format is %s_%d respectively channel name and CPU number. */
 104         char name[DEFAULT_STREAM_NAME_LEN];
 105         uint64_t tracefile_size;
 106         uint64_t tracefile_count;
 107         struct cds_list_head list;
 108 };
 109
 110 /* Kernel session */
 111 struct ltt_kernel_session {
 112         int fd;
 113         int metadata_stream_fd;
 114         int consumer_fds_sent;
 115         unsigned int channel_count;
 116         unsigned int stream_count_global;
 117         struct ltt_kernel_metadata *metadata;
 118         struct ltt_kernel_channel_list channel_list;
 119         /* UID/GID of the user owning the session */
 120         uid_t uid;
 121         gid_t gid;
 122         struct consumer_output *consumer;
 123         /* Tracing session id */
 124         uint64_t id;
 125         /* Session is active or not meaning it has been started or stopped. */
 126         unsigned int active:1;
 127         /* Tell or not if the session has to output the traces. */
 128         unsigned int output_traces;
 129         unsigned int snapshot_mode;
 130         unsigned int has_non_default_channel;
 131         /* Current trace chunk of the ltt_session. */
 132         struct lttng_trace_chunk *current_trace_chunk;
 133         /* Tracker lists */
 134         struct lttng_tracker_list *tracker_list_pid;
 135         struct lttng_tracker_list *tracker_list_vpid;
 136         struct lttng_tracker_list *tracker_list_uid;
 137         struct lttng_tracker_list *tracker_list_vuid;
 138         struct lttng_tracker_list *tracker_list_gid;
 139         struct lttng_tracker_list *tracker_list_vgid;
 140 };
 141
 142 /*
 143  * Lookup functions. NULL is returned if not found.
 144  */
 145 struct ltt_kernel_event *trace_kernel_get_event_by_name(
 146                 char *name, struct ltt_kernel_channel *channel,
 147                 enum lttng_event_type type);
 148 struct ltt_kernel_event *trace_kernel_find_event(
 149                 char *name, struct ltt_kernel_channel *channel,
 150                 enum lttng_event_type type,
 151                 struct lttng_filter_bytecode *filter);
 152 struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
 153                 const char *name, struct ltt_kernel_session *session);
 154
 155 struct ltt_kernel_token_event_rule *trace_kernel_find_trigger_by_token(
 156                 struct ltt_kernel_token_event_rule_list *list,
 157                 uint64_t token);
 158
 159 /*
 160  * Create functions malloc() the data structure.
 161  */
 162 struct ltt_kernel_session *trace_kernel_create_session(void);
 163 struct ltt_kernel_channel *trace_kernel_create_channel(
 164                 struct lttng_channel *chan);
 165 enum lttng_error_code trace_kernel_create_event(struct lttng_event *ev,
 166                 char *filter_expression, struct lttng_filter_bytecode *filter,
 167                 struct ltt_kernel_event **kernel_event);
 168 struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
 169 struct ltt_kernel_stream *trace_kernel_create_stream(const char *name,
 170                 unsigned int count);
 171 struct ltt_kernel_context *trace_kernel_create_context(
 172                 struct lttng_kernel_context *ctx);
 173 enum lttng_error_code trace_kernel_create_token_event_rule(
 174                 struct lttng_event_rule *event_rule,
 175                 uint64_t token,
 176                 struct ltt_kernel_token_event_rule **kernel_token_event_rule);
 177 struct ltt_kernel_context *trace_kernel_copy_context(
 178                 struct ltt_kernel_context *ctx);
 179 enum lttng_error_code trace_kernel_init_trigger_from_event_rule(const struct lttng_event_rule *rule,
 180                 struct lttng_kernel_trigger *kernel_trigger);
 181
 182 /*
 183  * Destroy functions free() the data structure and remove from linked list if
 184  * it's applies.
 185  */
 186 void trace_kernel_destroy_session(struct ltt_kernel_session *session);
 187 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
 188 void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
 189 void trace_kernel_destroy_event(struct ltt_kernel_event *event);
 190 void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
 191 void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
 192 void trace_kernel_destroy_token_event_rule(struct ltt_kernel_token_event_rule *rule);
 193 void trace_kernel_free_session(struct ltt_kernel_session *session);
 194
 195 #endif /* _LTT_TRACE_KERNEL_H */