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
  30 /* Kernel event list */
  31 struct ltt_kernel_event_list {
  32         struct cds_list_head head;
  33 };
  34
  35 /* Channel stream list */
  36 struct ltt_kernel_stream_list {
  37         struct cds_list_head head;
  38 };
  39
  40 /* Channel list */
  41 struct ltt_kernel_channel_list {
  42         struct cds_list_head head;
  43 };
  44
  45 struct ltt_kernel_context {
  46         struct lttng_kernel_context ctx;
  47         struct cds_list_head list;
  48         /* Indicates whether or not the context is in a list. */
  49         bool in_list;
  50 };
  51
  52 /* Kernel event */
  53 struct ltt_kernel_event {
  54         int fd;
  55         int enabled;
  56         enum lttng_event_type type;
  57         struct lttng_kernel_event *event;
  58         struct cds_list_head list;
  59         char *filter_expression;
  60         struct lttng_filter_bytecode *filter;
  61         struct lttng_userspace_probe_location *userspace_probe_location;
  62 };
  63
  64 /* Kernel channel */
  65 struct ltt_kernel_channel {
  66         int fd;
  67         uint64_t key; /* Key to reference this channel with the consumer. */
  68         int enabled;
  69         unsigned int stream_count;
  70         unsigned int event_count;
  71         bool published_to_notification_thread;
  72         struct cds_list_head ctx_list;
  73         struct lttng_channel *channel;
  74         struct ltt_kernel_event_list events_list;
  75         struct ltt_kernel_stream_list stream_list;
  76         struct cds_list_head list;
  77         /* Session pointer which has a reference to this object. */
  78         struct ltt_kernel_session *session;
  79         bool sent_to_consumer;
  80 };
  81
  82 /* Metadata */
  83 struct ltt_kernel_metadata {
  84         int fd;
  85         uint64_t key; /* Key to reference this channel with the consumer. */
  86         struct lttng_channel *conf;
  87 };
  88
  89 /* Channel stream */
  90 struct ltt_kernel_stream {
  91         int fd;
  92         int state;
  93         int cpu;
  94         bool sent_to_consumer;
  95         /* Format is %s_%d respectively channel name and CPU number. */
  96         char name[DEFAULT_STREAM_NAME_LEN];
  97         uint64_t tracefile_size;
  98         uint64_t tracefile_count;
  99         struct cds_list_head list;
 100 };
 101
 102 /* Kernel session */
 103 struct ltt_kernel_session {
 104         int fd;
 105         int metadata_stream_fd;
 106         int consumer_fds_sent;
 107         unsigned int channel_count;
 108         unsigned int stream_count_global;
 109         struct ltt_kernel_metadata *metadata;
 110         struct ltt_kernel_channel_list channel_list;
 111         /* UID/GID of the user owning the session */
 112         uid_t uid;
 113         gid_t gid;
 114         struct consumer_output *consumer;
 115         /* Tracing session id */
 116         uint64_t id;
 117         /* Session is active or not meaning it has been started or stopped. */
 118         unsigned int active:1;
 119         /* Tell or not if the session has to output the traces. */
 120         unsigned int output_traces;
 121         unsigned int snapshot_mode;
 122         unsigned int has_non_default_channel;
 123 };
 124
 125 /*
 126  * Lookup functions. NULL is returned if not found.
 127  */
 128 struct ltt_kernel_event *trace_kernel_get_event_by_name(
 129                 char *name, struct ltt_kernel_channel *channel,
 130                 enum lttng_event_type type);
 131 struct ltt_kernel_event *trace_kernel_find_event(
 132                 char *name, struct ltt_kernel_channel *channel,
 133                 enum lttng_event_type type,
 134                 struct lttng_filter_bytecode *filter);
 135 struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
 136                 char *name, struct ltt_kernel_session *session);
 137
 138 /*
 139  * Create functions malloc() the data structure.
 140  */
 141 struct ltt_kernel_session *trace_kernel_create_session(void);
 142 struct ltt_kernel_channel *trace_kernel_create_channel(
 143                 struct lttng_channel *chan);
 144 enum lttng_error_code trace_kernel_create_event(struct lttng_event *ev,
 145                 char *filter_expression, struct lttng_filter_bytecode *filter,
 146                 struct ltt_kernel_event **kernel_event);
 147 struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
 148 struct ltt_kernel_stream *trace_kernel_create_stream(const char *name,
 149                 unsigned int count);
 150 struct ltt_kernel_context *trace_kernel_create_context(
 151                 struct lttng_kernel_context *ctx);
 152 struct ltt_kernel_context *trace_kernel_copy_context(
 153                 struct ltt_kernel_context *ctx);
 154
 155 /*
 156  * Destroy functions free() the data structure and remove from linked list if
 157  * it's applies.
 158  */
 159 void trace_kernel_destroy_session(struct ltt_kernel_session *session);
 160 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
 161 void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
 162 void trace_kernel_destroy_event(struct ltt_kernel_event *event);
 163 void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
 164 void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
 165
 166 #endif /* _LTT_TRACE_KERNEL_H */