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 /* Kernel event */
  46 struct ltt_kernel_event {
  47         int fd;
  48         int enabled;
  49         struct lttng_kernel_event *event;
  50         struct cds_list_head list;
  51 };
  52
  53 /* Kernel channel */
  54 struct ltt_kernel_channel {
  55         int fd;
  56         int enabled;
  57         unsigned int stream_count;
  58         unsigned int event_count;
  59         /*
  60          * TODO: need internal representation to support more than a
  61          * single context.
  62          */
  63         struct lttng_kernel_context *ctx;
  64         struct lttng_channel *channel;
  65         struct ltt_kernel_event_list events_list;
  66         struct ltt_kernel_stream_list stream_list;
  67         struct cds_list_head list;
  68         /* Session pointer which has a reference to this object. */
  69         struct ltt_kernel_session *session;
  70 };
  71
  72 /* Metadata */
  73 struct ltt_kernel_metadata {
  74         int fd;
  75         struct lttng_channel *conf;
  76 };
  77
  78 /* Channel stream */
  79 struct ltt_kernel_stream {
  80         int fd;
  81         int state;
  82         /* Format is %s_%d respectively channel name and CPU number. */
  83         char name[DEFAULT_STREAM_NAME_LEN];
  84         struct cds_list_head list;
  85 };
  86
  87 /* Kernel session */
  88 struct ltt_kernel_session {
  89         int fd;
  90         int metadata_stream_fd;
  91         int consumer_fds_sent;
  92         unsigned int channel_count;
  93         unsigned int stream_count_global;
  94         char *trace_path;
  95         struct ltt_kernel_metadata *metadata;
  96         struct ltt_kernel_channel_list channel_list;
  97         /* UID/GID of the user owning the session */
  98         uid_t uid;
  99         gid_t gid;
 100         /*
 101          * Two consumer_output object are needed where one is needed for the
 102          * current output object and the second one is the temporary object used to
 103          * store URI being set by the lttng_set_consumer_uri call. Once
 104          * lttng_enable_consumer is called, the two pointers are swapped.
 105          */
 106         struct consumer_output *consumer;
 107         struct consumer_output *tmp_consumer;
 108         /* Tracing session id */
 109         unsigned int id;
 110         /* Session is started and active */
 111         unsigned int started;
 112 };
 113
 114 /*
 115  * Lookup functions. NULL is returned if not found.
 116  */
 117 struct ltt_kernel_event *trace_kernel_get_event_by_name(
 118                 char *name, struct ltt_kernel_channel *channel);
 119 struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
 120                 char *name, struct ltt_kernel_session *session);
 121
 122 /*
 123  * Create functions malloc() the data structure.
 124  */
 125 struct ltt_kernel_session *trace_kernel_create_session(char *path);
 126 struct ltt_kernel_channel *trace_kernel_create_channel(
 127                 struct lttng_channel *chan);
 128 struct ltt_kernel_event *trace_kernel_create_event(struct lttng_event *ev);
 129 struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
 130 struct ltt_kernel_stream *trace_kernel_create_stream(const char *name,
 131                 unsigned int count);
 132
 133 /*
 134  * Destroy functions free() the data structure and remove from linked list if
 135  * it's applies.
 136  */
 137 void trace_kernel_destroy_session(struct ltt_kernel_session *session);
 138 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
 139 void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
 140 void trace_kernel_destroy_event(struct ltt_kernel_event *event);
 141 void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
 142
 143 #endif /* _LTT_TRACE_KERNEL_H */