src/bin/lttng-sessiond/trace-ust.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_UST_H
  19 #define _LTT_TRACE_UST_H
  20
  21 #include <config.h>
  22 #include <limits.h>
  23 #include <urcu/list.h>
  24
  25 #include <lttng/lttng.h>
  26 #include <common/hashtable/hashtable.h>
  27 #include <common/defaults.h>
  28
  29 #include "consumer.h"
  30 #include "agent.h"
  31 #include "ust-ctl.h"
  32
  33 struct ltt_ust_ht_key {
  34         const char *name;
  35         const struct lttng_filter_bytecode *filter;
  36         enum lttng_ust_loglevel_type loglevel;
  37         const struct lttng_event_exclusion *exclusion;
  38 };
  39
  40 /* Context hash table nodes */
  41 struct ltt_ust_context {
  42         struct lttng_ust_context ctx;
  43         struct lttng_ht_node_ulong node;
  44         struct cds_list_head list;
  45 };
  46
  47 /* UST event */
  48 struct ltt_ust_event {
  49         unsigned int enabled;
  50         struct lttng_ust_event attr;
  51         struct lttng_ht_node_str node;
  52         char *filter_expression;
  53         struct lttng_ust_filter_bytecode *filter;
  54         struct lttng_event_exclusion *exclusion;
  55 };
  56
  57 /* UST channel */
  58 struct ltt_ust_channel {
  59         uint64_t id;    /* unique id per session. */
  60         unsigned int enabled;
  61         char name[LTTNG_UST_SYM_NAME_LEN];
  62         struct lttng_ust_channel_attr attr;
  63         struct lttng_ht *ctx;
  64         struct cds_list_head ctx_list;
  65         struct lttng_ht *events;
  66         struct lttng_ht_node_str node;
  67         uint64_t tracefile_size;
  68         uint64_t tracefile_count;
  69 };
  70
  71 /* UST domain global (LTTNG_DOMAIN_UST) */
  72 struct ltt_ust_domain_global {
  73         struct lttng_ht *channels;
  74         struct cds_list_head registry_buffer_uid_list;
  75 };
  76
  77 /* UST session */
  78 struct ltt_ust_session {
  79         uint64_t id;    /* Unique identifier of session */
  80         struct ltt_ust_domain_global domain_global;
  81         /* Hash table of agent indexed by agent domain. */
  82         struct lttng_ht *agents;
  83         /* UID/GID of the user owning the session */
  84         uid_t uid;
  85         gid_t gid;
  86         /* Is the session active meaning has is been started or stopped. */
  87         unsigned int active:1;
  88         /*
  89          * Two consumer_output object are needed where one is for the current
  90          * output object and the second one is the temporary object used to store
  91          * URI being set by the lttng_set_consumer_uri call. Once
  92          * lttng_enable_consumer is called, the two pointers are swapped.
  93          */
  94         struct consumer_output *consumer;
  95         struct consumer_output *tmp_consumer;
  96         /* Sequence number for filters so the tracer knows the ordering. */
  97         uint64_t filter_seq_num;
  98         /* This indicates which type of buffer this session is set for. */
  99         enum lttng_buffer_type buffer_type;
 100         /* If set to 1, the buffer_type can not be changed anymore. */
 101         int buffer_type_changed;
 102         /* For per UID buffer, every buffer reg object is kept of this session */
 103         struct cds_list_head buffer_reg_uid_list;
 104         /* Next channel ID available for a newly registered channel. */
 105         uint64_t next_channel_id;
 106         /* Once this value reaches UINT32_MAX, no more id can be allocated. */
 107         uint64_t used_channel_id;
 108         /* Tell or not if the session has to output the traces. */
 109         unsigned int output_traces;
 110         unsigned int snapshot_mode;
 111         unsigned int has_non_default_channel;
 112         unsigned int live_timer_interval;       /* usec */
 113
 114         /* Metadata channel attributes. */
 115         struct lttng_ust_channel_attr metadata_attr;
 116
 117         /*
 118          * Path where to keep the shared memory files.
 119          */
 120         char shm_path[PATH_MAX];
 121 };
 122
 123 /*
 124  * Validate that the id has reached the maximum allowed or not.
 125  *
 126  * Return 0 if NOT else 1.
 127  */
 128 static inline int trace_ust_is_max_id(uint64_t id)
 129 {
 130         return (id == UINT64_MAX) ? 1 : 0;
 131 }
 132
 133 /*
 134  * Return next available channel id and increment the used counter. The
 135  * trace_ust_is_max_id function MUST be called before in order to validate if
 136  * the maximum number of IDs have been reached. If not, it is safe to call this
 137  * function.
 138  *
 139  * Return a unique channel ID. If max is reached, the used_channel_id counter
 140  * is returned.
 141  */
 142 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
 143 {
 144         if (trace_ust_is_max_id(s->used_channel_id)) {
 145                 return s->used_channel_id;
 146         }
 147
 148         s->used_channel_id++;
 149         return s->next_channel_id++;
 150 }
 151
 152 #ifdef HAVE_LIBLTTNG_UST_CTL
 153
 154 int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
 155 int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
 156                 const void *_key);
 157
 158 /*
 159  * Lookup functions. NULL is returned if not found.
 160  */
 161 struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
 162                 char *name, struct lttng_filter_bytecode *filter, int loglevel,
 163                 struct lttng_event_exclusion *exclusion);
 164 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
 165                 char *name);
 166 struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
 167                 enum lttng_domain_type domain_type);
 168
 169 /*
 170  * Create functions malloc() the data structure.
 171  */
 172 struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
 173 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr);
 174 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
 175                 char *filter_expression,
 176                 struct lttng_filter_bytecode *filter,
 177                 struct lttng_event_exclusion *exclusion);
 178 struct ltt_ust_context *trace_ust_create_context(
 179                 struct lttng_event_context *ctx);
 180 int trace_ust_match_context(struct ltt_ust_context *uctx,
 181                 struct lttng_event_context *ctx);
 182 void trace_ust_delete_channel(struct lttng_ht *ht,
 183                 struct ltt_ust_channel *channel);
 184
 185 /*
 186  * Destroy functions free() the data structure and remove from linked list if
 187  * it's applies.
 188  */
 189 void trace_ust_destroy_session(struct ltt_ust_session *session);
 190 void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
 191 void trace_ust_destroy_event(struct ltt_ust_event *event);
 192
 193 #else /* HAVE_LIBLTTNG_UST_CTL */
 194
 195 static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
 196                 const void *_key)
 197 {
 198         return 0;
 199 }
 200 static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
 201                 const void *_key)
 202 {
 203         return 0;
 204 }
 205 static inline
 206 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
 207                 char *name)
 208 {
 209         return NULL;
 210 }
 211
 212 static inline
 213 struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
 214 {
 215         return NULL;
 216 }
 217 static inline
 218 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr)
 219 {
 220         return NULL;
 221 }
 222 static inline
 223 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
 224                 const char *filter_expression,
 225                 struct lttng_filter_bytecode *filter,
 226                 struct lttng_event_exclusion *exclusion)
 227 {
 228         return NULL;
 229 }
 230 static inline
 231 void trace_ust_destroy_session(struct ltt_ust_session *session)
 232 {
 233 }
 234
 235 static inline
 236 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 237 {
 238 }
 239
 240 static inline
 241 void trace_ust_destroy_event(struct ltt_ust_event *event)
 242 {
 243 }
 244 static inline
 245 struct ltt_ust_context *trace_ust_create_context(
 246                 struct lttng_event_context *ctx)
 247 {
 248         return NULL;
 249 }
 250 static inline
 251 int trace_ust_match_context(struct ltt_ust_context *uctx,
 252                 struct lttng_event_context *ctx)
 253 {
 254         return 0;
 255 }
 256 static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
 257                 char *name, struct lttng_filter_bytecode *filter, int loglevel,
 258                 struct lttng_event_exclusion *exclusion)
 259 {
 260         return NULL;
 261 }
 262 static inline
 263 void trace_ust_delete_channel(struct lttng_ht *ht,
 264                 struct ltt_ust_channel *channel)
 265 {
 266         return;
 267 }
 268 static inline
 269 struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
 270                 enum lttng_domain_type domain_type)
 271 {
 272         return NULL;
 273 }
 274
 275 #endif /* HAVE_LIBLTTNG_UST_CTL */
 276
 277 #endif /* _LTT_TRACE_UST_H */