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

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