src/bin/lttng-sessiond/ust-app.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_UST_APP_H
  19 #define _LTT_UST_APP_H
  20
  21 #include <stdint.h>
  22
  23 #include "trace-ust.h"
  24
  25 /* lttng-ust supported version. */
  26 #define LTTNG_UST_COMM_MAJOR          2 /* comm protocol major version */
  27 #define UST_APP_MAJOR_VERSION         2 /* UST version supported */
  28
  29 #define UST_APP_EVENT_LIST_SIZE 32
  30
  31 struct lttng_filter_bytecode;
  32 struct lttng_ust_filter_bytecode;
  33
  34 extern int ust_consumerd64_fd, ust_consumerd32_fd;
  35
  36 /*
  37  * Application registration data structure.
  38  */
  39 struct ust_register_msg {
  40         uint32_t major;
  41         uint32_t minor;
  42         pid_t pid;
  43         pid_t ppid;
  44         uid_t uid;
  45         gid_t gid;
  46         uint32_t bits_per_long;
  47         char name[16];
  48 };
  49
  50 /*
  51  * Global applications HT used by the session daemon. This table is indexed by
  52  * PID using the pid_n node and pid value of an ust_app.
  53  */
  54 struct lttng_ht *ust_app_ht;
  55
  56 /*
  57  * Global applications HT used by the session daemon. This table is indexed by
  58  * socket using the sock_n node and sock value of an ust_app.
  59  */
  60 struct lttng_ht *ust_app_ht_by_sock;
  61
  62 struct ust_app_ctx {
  63         int handle;
  64         struct lttng_ust_context ctx;
  65         struct lttng_ust_object_data *obj;
  66         struct lttng_ht_node_ulong node;
  67 };
  68
  69 struct ust_app_event {
  70         int enabled;
  71         int handle;
  72         struct lttng_ust_object_data *obj;
  73         struct lttng_ust_event attr;
  74         char name[LTTNG_UST_SYM_NAME_LEN];
  75         struct lttng_ht *ctx;
  76         struct lttng_ht_node_str node;
  77         struct lttng_ust_filter_bytecode *filter;
  78 };
  79
  80 struct ust_app_channel {
  81         int enabled;
  82         int handle;
  83         char name[LTTNG_UST_SYM_NAME_LEN];
  84         struct lttng_ust_channel attr;
  85         struct lttng_ust_object_data *obj;
  86         struct ltt_ust_stream_list streams;
  87         struct lttng_ht *ctx;
  88         struct lttng_ht *events;
  89         struct lttng_ht_node_str node;
  90 };
  91
  92 struct ust_app_session {
  93         int enabled;
  94         /* started: has the session been in started state at any time ? */
  95         int started;  /* allows detection of start vs restart. */
  96         int handle;   /* used has unique identifier for app session */
  97         int id;       /* session unique identifier */
  98         struct ltt_ust_metadata *metadata;
  99         struct lttng_ht *channels; /* Registered channels */
 100         struct lttng_ht_node_ulong node;
 101         char path[PATH_MAX];
 102         /* UID/GID of the user owning the session */
 103         uid_t uid;
 104         gid_t gid;
 105 };
 106
 107 /*
 108  * Registered traceable applications. Libust registers to the session daemon
 109  * and a linked list is kept of all running traceable app.
 110  */
 111 struct ust_app {
 112         int sock;
 113         pid_t pid;
 114         pid_t ppid;
 115         uid_t uid;           /* User ID that owns the apps */
 116         gid_t gid;           /* Group ID that owns the apps */
 117         int bits_per_long;
 118         int compatible; /* If the lttng-ust tracer version does not match the
 119                                            supported version of the session daemon, this flag is
 120                                            set to 0 (NOT compatible) else 1. */
 121         struct lttng_ust_tracer_version version;
 122         uint32_t v_major;    /* Verion major number */
 123         uint32_t v_minor;    /* Verion minor number */
 124         char name[17];       /* Process name (short) */
 125         struct lttng_ht *sessions;
 126         struct lttng_ht_node_ulong pid_n;
 127         struct lttng_ht_node_ulong sock_n;
 128 };
 129
 130 #ifdef HAVE_LIBLTTNG_UST_CTL
 131
 132 int ust_app_register(struct ust_register_msg *msg, int sock);
 133 static inline
 134 int ust_app_register_done(int sock)
 135 {
 136         return ustctl_register_done(sock);
 137 }
 138 void ust_app_unregister(int sock);
 139 unsigned long ust_app_list_count(void);
 140 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
 141 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
 142 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 143 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 144 int ust_app_destroy_trace(struct ltt_ust_session *usess, struct ust_app *app);
 145 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 146 int ust_app_list_events(struct lttng_event **events);
 147 int ust_app_list_event_fields(struct lttng_event_field **fields);
 148 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 149                 struct ltt_ust_channel *uchan);
 150 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 151                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 152 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 153                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 154                 pid_t pid);
 155 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 156                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 157                 pid_t pid);
 158 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 159                 struct ltt_ust_channel *uchan);
 160 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 161                 struct ltt_ust_channel *uchan);
 162 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 163                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 164 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 165                 struct ltt_ust_channel *uchan);
 166 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 167                 struct ltt_ust_channel *uchan);
 168 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 169                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 170 int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
 171                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 172                 struct ltt_ust_context *uctx);
 173 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 174                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 175 int ust_app_set_filter_event_glb(struct ltt_ust_session *usess,
 176                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 177                 struct lttng_filter_bytecode *bytecode);
 178 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
 179
 180 void ust_app_clean_list(void);
 181 void ust_app_ht_alloc(void);
 182 struct lttng_ht *ust_app_get_ht(void);
 183 struct ust_app *ust_app_find_by_pid(pid_t pid);
 184 int ust_app_validate_version(int sock);
 185 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 186
 187 #else /* HAVE_LIBLTTNG_UST_CTL */
 188
 189 static inline
 190 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
 191 {
 192         return 0;
 193 }
 194 static inline
 195 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
 196 {
 197         return 0;
 198 }
 199 static inline
 200 int ust_app_start_trace_all(struct ltt_ust_session *usess)
 201 {
 202         return 0;
 203 }
 204 static inline
 205 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
 206 {
 207         return 0;
 208 }
 209 static inline
 210 int ust_app_list_events(struct lttng_event **events)
 211 {
 212         return -ENOSYS;
 213 }
 214 static inline
 215 int ust_app_list_event_fields(struct lttng_event_field **fields)
 216 {
 217         return -ENOSYS;
 218 }
 219 static inline
 220 int ust_app_register(struct ust_register_msg *msg, int sock)
 221 {
 222         return -ENOSYS;
 223 }
 224 static inline
 225 int ust_app_register_done(int sock)
 226 {
 227         return -ENOSYS;
 228 }
 229 static inline
 230 void ust_app_unregister(int sock)
 231 {
 232 }
 233 static inline
 234 unsigned int ust_app_list_count(void)
 235 {
 236         return 0;
 237 }
 238 static inline
 239 void ust_app_lock_list(void)
 240 {
 241 }
 242 static inline
 243 void ust_app_unlock_list(void)
 244 {
 245 }
 246 static inline
 247 void ust_app_clean_list(void)
 248 {
 249 }
 250 static inline
 251 struct ust_app_list *ust_app_get_list(void)
 252 {
 253         return NULL;
 254 }
 255 static inline
 256 struct ust_app *ust_app_get_by_pid(pid_t pid)
 257 {
 258         return NULL;
 259 }
 260 static inline
 261 struct lttng_ht *ust_app_get_ht(void)
 262 {
 263         return NULL;
 264 }
 265 static inline
 266 void ust_app_ht_alloc(void)
 267 {}
 268 static inline
 269 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
 270 {}
 271 static inline
 272 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 273                 struct ltt_ust_channel *uchan)
 274 {
 275         return 0;
 276 }
 277 static inline
 278 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 279                 struct ltt_ust_channel *uchan)
 280 {
 281         return 0;
 282 }
 283 static inline
 284 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 285                 struct ltt_ust_channel *uchan)
 286 {
 287         return 0;
 288 }
 289 static inline
 290 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 291                 struct ltt_ust_channel *uchan)
 292 {
 293         return 0;
 294 }
 295 static inline
 296 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 297                 struct ltt_ust_channel *uchan)
 298 {
 299         return 0;
 300 }
 301 static inline
 302 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 303                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 304 {
 305         return 0;
 306 }
 307 static inline
 308 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 309                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 310 {
 311         return 0;
 312 }
 313 static inline
 314 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 315                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 316 {
 317         return 0;
 318 }
 319 static inline
 320 int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
 321                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 322                 struct ltt_ust_context *uctx)
 323 {
 324         return 0;
 325 }
 326 static inline
 327 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 328                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 329 {
 330         return 0;
 331 }
 332 static inline
 333 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 334                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 335                 pid_t pid)
 336 {
 337         return 0;
 338 }
 339 static inline
 340 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 341                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 342                 pid_t pid)
 343 {
 344         return 0;
 345 }
 346 static inline
 347 int ust_app_validate_version(int sock)
 348 {
 349         return 0;
 350 }
 351 static inline
 352 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
 353 {
 354         return 0;
 355 }
 356 static inline
 357 int ust_app_set_filter_event_glb(struct ltt_ust_session *usess,
 358                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 359                 struct lttng_filter_bytecode *bytecode)
 360 {
 361         return 0;
 362 }
 363
 364 #endif /* HAVE_LIBLTTNG_UST_CTL */
 365
 366 #endif /* _LTT_UST_APP_H */