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 "jul.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         int start_trace;
  81         struct ltt_ust_domain_global domain_global;
  82         struct jul_domain domain_jul;
  83         /* UID/GID of the user owning the session */
  84         uid_t uid;
  85         gid_t gid;
  86         /*
  87          * Two consumer_output object are needed where one is for the current
  88          * output object and the second one is the temporary object used to store
  89          * URI being set by the lttng_set_consumer_uri call. Once
  90          * lttng_enable_consumer is called, the two pointers are swapped.
  91          */
  92         struct consumer_output *consumer;
  93         struct consumer_output *tmp_consumer;
  94         /* Sequence number for filters so the tracer knows the ordering. */
  95         uint64_t filter_seq_num;
  96         /* This indicates which type of buffer this session is set for. */
  97         enum lttng_buffer_type buffer_type;
  98         /* If set to 1, the buffer_type can not be changed anymore. */
  99         int buffer_type_changed;
 100         /* For per UID buffer, every buffer reg object is kept of this session */
 101         struct cds_list_head buffer_reg_uid_list;
 102         /* Next channel ID available for a newly registered channel. */
 103         uint64_t next_channel_id;
 104         /* Once this value reaches UINT32_MAX, no more id can be allocated. */
 105         uint64_t used_channel_id;
 106         /* Tell or not if the session has to output the traces. */
 107         unsigned int output_traces;
 108         unsigned int snapshot_mode;
 109         unsigned int has_non_default_channel;
 110         unsigned int live_timer_interval;       /* usec */
 111
 112         /* Metadata channel attributes. */
 113         struct lttng_ust_channel_attr metadata_attr;
 114 };
 115
 116 /*
 117  * Validate that the id has reached the maximum allowed or not.
 118  *
 119  * Return 0 if NOT else 1.
 120  */
 121 static inline int trace_ust_is_max_id(uint64_t id)
 122 {
 123         return (id == UINT64_MAX) ? 1 : 0;
 124 }
 125
 126 /*
 127  * Return next available channel id and increment the used counter. The
 128  * trace_ust_is_max_id function MUST be called before in order to validate if
 129  * the maximum number of IDs have been reached. If not, it is safe to call this
 130  * function.
 131  *
 132  * Return a unique channel ID. If max is reached, the used_channel_id counter
 133  * is returned.
 134  */
 135 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
 136 {
 137         if (trace_ust_is_max_id(s->used_channel_id)) {
 138                 return s->used_channel_id;
 139         }
 140
 141         s->used_channel_id++;
 142         return s->next_channel_id++;
 143 }
 144
 145 #ifdef HAVE_LIBLTTNG_UST_CTL
 146
 147 int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
 148 int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
 149                 const void *_key);
 150
 151 /*
 152  * Lookup functions. NULL is returned if not found.
 153  */
 154 struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
 155                 char *name, struct lttng_filter_bytecode *filter, int loglevel,
 156                 struct lttng_event_exclusion *exclusion);
 157 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
 158                 char *name);
 159
 160 /*
 161  * Create functions malloc() the data structure.
 162  */
 163 struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
 164 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr);
 165 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
 166                 char *filter_expression,
 167                 struct lttng_filter_bytecode *filter,
 168                 struct lttng_event_exclusion *exclusion);
 169 struct ltt_ust_context *trace_ust_create_context(
 170                 struct lttng_event_context *ctx);
 171 void trace_ust_delete_channel(struct lttng_ht *ht,
 172                 struct ltt_ust_channel *channel);
 173
 174 /*
 175  * Destroy functions free() the data structure and remove from linked list if
 176  * it's applies.
 177  */
 178 void trace_ust_destroy_session(struct ltt_ust_session *session);
 179 void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
 180 void trace_ust_destroy_event(struct ltt_ust_event *event);
 181
 182 #else /* HAVE_LIBLTTNG_UST_CTL */
 183
 184 static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
 185                 const void *_key)
 186 {
 187         return 0;
 188 }
 189 static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
 190                 const void *_key)
 191 {
 192         return 0;
 193 }
 194 static inline
 195 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
 196                 char *name)
 197 {
 198         return NULL;
 199 }
 200
 201 static inline
 202 struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
 203 {
 204         return NULL;
 205 }
 206 static inline
 207 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr)
 208 {
 209         return NULL;
 210 }
 211 static inline
 212 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
 213                 const char *filter_expression,
 214                 struct lttng_filter_bytecode *filter,
 215                 struct lttng_event_exclusion *exclusion)
 216 {
 217         return NULL;
 218 }
 219 static inline
 220 void trace_ust_destroy_session(struct ltt_ust_session *session)
 221 {
 222 }
 223
 224 static inline
 225 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 226 {
 227 }
 228
 229 static inline
 230 void trace_ust_destroy_event(struct ltt_ust_event *event)
 231 {
 232 }
 233 static inline
 234 struct ltt_ust_context *trace_ust_create_context(
 235                 struct lttng_event_context *ctx)
 236 {
 237         return NULL;
 238 }
 239 static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
 240                 char *name, struct lttng_filter_bytecode *filter, int loglevel,
 241                 struct lttng_event_exclusion *exclusion)
 242 {
 243         return NULL;
 244 }
 245 static inline
 246 void trace_ust_delete_channel(struct lttng_ht *ht,
 247                 struct ltt_ust_channel *channel)
 248 {
 249         return;
 250 }
 251
 252 #endif /* HAVE_LIBLTTNG_UST_CTL */
 253
 254 #endif /* _LTT_TRACE_UST_H */