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
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; only version 2
   7  * of the License.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17  */
  18
  19 #ifndef _LTT_TRACE_UST_H
  20 #define _LTT_TRACE_UST_H
  21
  22 #include <config.h>
  23 #include <limits.h>
  24 #include <urcu.h>
  25 #include <urcu/list.h>
  26 #include <lttng/lttng.h>
  27
  28 #include "ust-ctl.h"
  29
  30 #include "../hashtable/rculfhash.h"
  31
  32 /* UST Stream list */
  33 struct ltt_ust_stream_list {
  34         unsigned int count;
  35         struct cds_list_head head;
  36 };
  37
  38 /* Context hash table nodes */
  39 struct ltt_ust_context {
  40         struct lttng_ust_context ctx;
  41         struct cds_lfht_node node;
  42 };
  43
  44 /* UST event */
  45 struct ltt_ust_event {
  46         struct lttng_ust_event attr;
  47         struct cds_lfht *ctx;
  48         struct cds_lfht_node node;
  49 };
  50
  51 /* UST stream */
  52 struct ltt_ust_stream {
  53         int handle;
  54         char pathname[PATH_MAX];
  55         struct lttng_ust_object_data *obj;
  56         struct cds_lfht_node node;
  57 };
  58
  59 /* UST channel */
  60 struct ltt_ust_channel {
  61         char name[LTTNG_UST_SYM_NAME_LEN];
  62         char pathname[PATH_MAX];
  63         struct lttng_ust_channel attr;
  64         struct cds_lfht *ctx;
  65         struct cds_lfht *events;
  66         struct cds_lfht_node node;
  67 };
  68
  69 /* UST Metadata */
  70 struct ltt_ust_metadata {
  71         int handle;
  72         struct lttng_ust_object_data *obj;
  73         char pathname[PATH_MAX];              /* Trace file path name */
  74         struct lttng_ust_channel attr;
  75         struct lttng_ust_object_data *stream_obj;
  76 };
  77
  78 /* UST domain global (LTTNG_DOMAIN_UST) */
  79 struct ltt_ust_domain_global {
  80         struct cds_lfht *channels;
  81 };
  82
  83 /* UST domain pid (LTTNG_DOMAIN_UST_PID) */
  84 struct ltt_ust_domain_pid {
  85         pid_t pid;
  86         struct cds_lfht *channels;
  87         struct cds_lfht_node node;
  88 };
  89
  90 /* UST domain exec name (LTTNG_DOMAIN_UST_EXEC_NAME) */
  91 struct ltt_ust_domain_exec {
  92         char exec_name[LTTNG_UST_SYM_NAME_LEN];
  93         struct cds_lfht *channels;
  94         struct cds_lfht_node node;
  95 };
  96
  97 /* UST session */
  98 struct ltt_ust_session {
  99         int uid;   /* Unique identifier of session */
 100         int consumer_fds_sent;
 101         int consumer_fd;
 102         char pathname[PATH_MAX];
 103         struct ltt_ust_domain_global domain_global;
 104         /*
 105          * Those two hash tables contains data for a specific UST domain and each
 106          * contains a HT of channels. See ltt_ust_domain_exec and
 107          * ltt_ust_domain_pid data structures.
 108          */
 109         struct cds_lfht *domain_pid;
 110         struct cds_lfht *domain_exec;
 111 };
 112
 113 #ifdef HAVE_LIBLTTNG_UST_CTL
 114
 115 /*
 116  * Lookup functions. NULL is returned if not found.
 117  */
 118 struct ltt_ust_event *trace_ust_find_event_by_name(struct cds_lfht *ht,
 119                 char *name);
 120 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct cds_lfht *ht,
 121                 char *name);
 122
 123 /*
 124  * Create functions malloc() the data structure.
 125  */
 126 struct ltt_ust_session *trace_ust_create_session(char *path, unsigned int uid,
 127                 struct lttng_domain *domain);
 128 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
 129                 char *path);
 130 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev);
 131 struct ltt_ust_metadata *trace_ust_create_metadata(char *path);
 132
 133 /*
 134  * Destroy functions free() the data structure and remove from linked list if
 135  * it's applies.
 136  */
 137 void trace_ust_destroy_session(struct ltt_ust_session *session);
 138 void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata);
 139 void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
 140 void trace_ust_destroy_event(struct ltt_ust_event *event);
 141
 142 #else /* HAVE_LIBLTTNG_UST_CTL */
 143
 144 static inline
 145 struct ltt_ust_event *trace_ust_find_event_by_name(struct cds_lfht *ht,
 146                 char *name)
 147 {
 148         return NULL;
 149 }
 150
 151 static inline
 152 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct cds_lfht *ht,
 153                 char *name)
 154 {
 155         return NULL;
 156 }
 157
 158 static inline
 159 struct ltt_ust_session *trace_ust_create_session(char *path, pid_t pid,
 160                 struct lttng_domain *domain)
 161 {
 162         return NULL;
 163 }
 164 static inline
 165 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
 166                 char *path)
 167 {
 168         return NULL;
 169 }
 170 static inline
 171 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev)
 172 {
 173         return NULL;
 174 }
 175 static inline
 176 struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
 177 {
 178         return NULL;
 179 }
 180
 181 static inline
 182 void trace_ust_destroy_session(struct ltt_ust_session *session)
 183 {
 184 }
 185
 186 static inline
 187 void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
 188 {
 189 }
 190
 191 static inline
 192 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 193 {
 194 }
 195
 196 static inline
 197 void trace_ust_destroy_event(struct ltt_ust_event *event)
 198 {
 199 }
 200
 201 #endif /* HAVE_LIBLTTNG_UST_CTL */
 202
 203 #endif /* _LTT_TRACE_UST_H */