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