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