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 <common/compat/uuid.h>
  24 #include "trace-ust.h"
  25 #include "ust-registry.h"
  26
  27 #define UST_APP_EVENT_LIST_SIZE 32
  28
  29 /* Process name (short). */
  30 #define UST_APP_PROCNAME_LEN    16
  31
  32 struct lttng_filter_bytecode;
  33 struct lttng_ust_filter_bytecode;
  34
  35 extern int ust_consumerd64_fd, ust_consumerd32_fd;
  36
  37 /*
  38  * Object used to close the notify socket in a call_rcu(). Since the
  39  * application might not be found, we need an independant object containing the
  40  * notify socket fd.
  41  */
  42 struct ust_app_notify_sock_obj {
  43         int fd;
  44         struct rcu_head head;
  45 };
  46
  47 struct ust_app_ht_key {
  48         const char *name;
  49         const struct lttng_ust_filter_bytecode *filter;
  50         enum lttng_ust_loglevel_type loglevel;
  51 };
  52
  53 /*
  54  * Application registration data structure.
  55  */
  56 struct ust_register_msg {
  57         enum ustctl_socket_type type;
  58         uint32_t major;
  59         uint32_t minor;
  60         uint32_t abi_major;
  61         uint32_t abi_minor;
  62         pid_t pid;
  63         pid_t ppid;
  64         uid_t uid;
  65         gid_t gid;
  66         uint32_t bits_per_long;
  67         uint32_t uint8_t_alignment;
  68         uint32_t uint16_t_alignment;
  69         uint32_t uint32_t_alignment;
  70         uint32_t uint64_t_alignment;
  71         uint32_t long_alignment;
  72         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
  73         char name[LTTNG_UST_ABI_PROCNAME_LEN];
  74 };
  75
  76 /*
  77  * Global applications HT used by the session daemon. This table is indexed by
  78  * PID using the pid_n node and pid value of an ust_app.
  79  */
  80 struct lttng_ht *ust_app_ht;
  81
  82 /*
  83  * Global applications HT used by the session daemon. This table is indexed by
  84  * socket using the sock_n node and sock value of an ust_app.
  85  */
  86 struct lttng_ht *ust_app_ht_by_sock;
  87
  88 /*
  89  * Global applications HT used by the session daemon. This table is indexed by
  90  * socket using the notify_sock_n node and notify_sock value of an ust_app.
  91  */
  92 struct lttng_ht *ust_app_ht_by_notify_sock;
  93
  94 /* Stream list containing ust_app_stream. */
  95 struct ust_app_stream_list {
  96         unsigned int count;
  97         struct cds_list_head head;
  98 };
  99
 100 struct ust_app_ctx {
 101         int handle;
 102         struct lttng_ust_context ctx;
 103         struct lttng_ust_object_data *obj;
 104         struct lttng_ht_node_ulong node;
 105 };
 106
 107 struct ust_app_event {
 108         int enabled;
 109         int handle;
 110         struct lttng_ust_object_data *obj;
 111         struct lttng_ust_event attr;
 112         char name[LTTNG_UST_SYM_NAME_LEN];
 113         struct lttng_ht_node_str node;
 114         struct lttng_ust_filter_bytecode *filter;
 115 };
 116
 117 struct ust_app_stream {
 118         int handle;
 119         char pathname[PATH_MAX];
 120         /* Format is %s_%d respectively channel name and CPU number. */
 121         char name[DEFAULT_STREAM_NAME_LEN];
 122         struct lttng_ust_object_data *obj;
 123         /* Using a list of streams to keep order. */
 124         struct cds_list_head list;
 125 };
 126
 127 struct ust_app_channel {
 128         int enabled;
 129         int handle;
 130         /* Channel and streams were sent to the UST tracer. */
 131         int is_sent;
 132         /* Unique key used to identify the channel on the consumer side. */
 133         uint64_t key;
 134         /* Number of stream that this channel is expected to receive. */
 135         unsigned int expected_stream_count;
 136         char name[LTTNG_UST_SYM_NAME_LEN];
 137         struct lttng_ust_object_data *obj;
 138         struct ustctl_consumer_channel_attr attr;
 139         struct ust_app_stream_list streams;
 140         /* Session pointer that owns this object. */
 141         struct ust_app_session *session;
 142         struct lttng_ht *ctx;
 143         struct lttng_ht *events;
 144         /*
 145          * UST event registry. The ONLY writer is the application thread.
 146          */
 147         struct ust_registry_channel registry;
 148         /*
 149          * Node indexed by channel name in the channels' hash table of a session.
 150          */
 151         struct lttng_ht_node_str node;
 152         /*
 153          * Node indexed by UST channel object descriptor (handle). Stored in the
 154          * ust_objd hash table in the ust_app object.
 155          */
 156         struct lttng_ht_node_ulong ust_objd_node;
 157 };
 158
 159 struct ust_app_session {
 160         /*
 161          * Lock protecting this session's ust app interaction. Held
 162          * across command send/recv to/from app. Never nests within the
 163          * session registry lock.
 164          */
 165         pthread_mutex_t lock;
 166
 167         int enabled;
 168         /* started: has the session been in started state at any time ? */
 169         int started;  /* allows detection of start vs restart. */
 170         int handle;   /* used has unique identifier for app session */
 171         int id;       /* session unique identifier */
 172         struct ust_app_channel *metadata;
 173         struct ust_registry_session registry;
 174         struct lttng_ht *channels; /* Registered channels */
 175         struct lttng_ht_node_ulong node;
 176         char path[PATH_MAX];
 177         /* UID/GID of the user owning the session */
 178         uid_t uid;
 179         gid_t gid;
 180         struct cds_list_head teardown_node;
 181         /*
 182          * Once at least *one* session is created onto the application, the
 183          * corresponding consumer is set so we can use it on unregistration.
 184          */
 185         struct consumer_output *consumer;
 186 };
 187
 188 /*
 189  * Registered traceable applications. Libust registers to the session daemon
 190  * and a linked list is kept of all running traceable app.
 191  */
 192 struct ust_app {
 193         int sock;
 194         int notify_sock;
 195         pid_t pid;
 196         pid_t ppid;
 197         uid_t uid;           /* User ID that owns the apps */
 198         gid_t gid;           /* Group ID that owns the apps */
 199
 200         /* App ABI */
 201         uint32_t bits_per_long;
 202         uint32_t uint8_t_alignment;
 203         uint32_t uint16_t_alignment;
 204         uint32_t uint32_t_alignment;
 205         uint32_t uint64_t_alignment;
 206         uint32_t long_alignment;
 207         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
 208
 209         int compatible; /* If the lttng-ust tracer version does not match the
 210                                            supported version of the session daemon, this flag is
 211                                            set to 0 (NOT compatible) else 1. */
 212         struct lttng_ust_tracer_version version;
 213         uint32_t v_major;    /* Version major number */
 214         uint32_t v_minor;    /* Version minor number */
 215         /* Extra for the NULL byte. */
 216         char name[UST_APP_PROCNAME_LEN + 1];
 217         struct lttng_ht *sessions;
 218         struct lttng_ht_node_ulong pid_n;
 219         struct lttng_ht_node_ulong sock_n;
 220         struct lttng_ht_node_ulong notify_sock_n;
 221         /*
 222          * This is a list of ust app session that, once the app is going into
 223          * teardown mode, in the RCU call, each node in this list is removed and
 224          * deleted.
 225          *
 226          * Element of the list are added when an application unregisters after each
 227          * ht_del of ust_app_session associated to this app. This list is NOT used
 228          * when a session is destroyed.
 229          */
 230         struct cds_list_head teardown_head;
 231         /*
 232          * Hash table containing ust_app_channel indexed by channel objd.
 233          */
 234         struct lttng_ht *ust_objd;
 235 };
 236
 237 #ifdef HAVE_LIBLTTNG_UST_CTL
 238
 239 int ust_app_register(struct ust_register_msg *msg, int sock);
 240 static inline
 241 int ust_app_register_done(int sock)
 242 {
 243         return ustctl_register_done(sock);
 244 }
 245 int ust_app_version(struct ust_app *app);
 246 void ust_app_unregister(int sock);
 247 unsigned long ust_app_list_count(void);
 248 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
 249 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
 250 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 251 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 252 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 253 int ust_app_list_events(struct lttng_event **events);
 254 int ust_app_list_event_fields(struct lttng_event_field **fields);
 255 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 256                 struct ltt_ust_channel *uchan);
 257 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 258                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 259 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 260                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 261                 pid_t pid);
 262 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 263                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 264                 pid_t pid);
 265 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 266                 struct ltt_ust_channel *uchan);
 267 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 268                 struct ltt_ust_channel *uchan);
 269 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 270                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 271 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 272                 struct ltt_ust_channel *uchan);
 273 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 274                 struct ltt_ust_channel *uchan);
 275 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 276                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 277 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 278                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 279 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
 280
 281 void ust_app_clean_list(void);
 282 void ust_app_ht_alloc(void);
 283 struct lttng_ht *ust_app_get_ht(void);
 284 struct ust_app *ust_app_find_by_pid(pid_t pid);
 285 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 286 struct ust_app_stream *ust_app_alloc_stream(void);
 287 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 288 int ust_app_recv_notify(int sock);
 289 void ust_app_add(struct ust_app *app);
 290 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
 291 void ust_app_notify_sock_unregister(int sock);
 292
 293 #else /* HAVE_LIBLTTNG_UST_CTL */
 294
 295 static inline
 296 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
 297 {
 298         return 0;
 299 }
 300 static inline
 301 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
 302 {
 303         return 0;
 304 }
 305 static inline
 306 int ust_app_start_trace_all(struct ltt_ust_session *usess)
 307 {
 308         return 0;
 309 }
 310 static inline
 311 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
 312 {
 313         return 0;
 314 }
 315 static inline
 316 int ust_app_list_events(struct lttng_event **events)
 317 {
 318         return -ENOSYS;
 319 }
 320 static inline
 321 int ust_app_list_event_fields(struct lttng_event_field **fields)
 322 {
 323         return -ENOSYS;
 324 }
 325 static inline
 326 int ust_app_register(struct ust_register_msg *msg, int sock)
 327 {
 328         return -ENOSYS;
 329 }
 330 static inline
 331 int ust_app_register_done(int sock)
 332 {
 333         return -ENOSYS;
 334 }
 335 static inline
 336 int ust_app_version(struct ust_app *app)
 337 {
 338         return -ENOSYS;
 339 }
 340 static inline
 341 void ust_app_unregister(int sock)
 342 {
 343 }
 344 static inline
 345 unsigned int ust_app_list_count(void)
 346 {
 347         return 0;
 348 }
 349 static inline
 350 void ust_app_lock_list(void)
 351 {
 352 }
 353 static inline
 354 void ust_app_unlock_list(void)
 355 {
 356 }
 357 static inline
 358 void ust_app_clean_list(void)
 359 {
 360 }
 361 static inline
 362 struct ust_app_list *ust_app_get_list(void)
 363 {
 364         return NULL;
 365 }
 366 static inline
 367 struct ust_app *ust_app_get_by_pid(pid_t pid)
 368 {
 369         return NULL;
 370 }
 371 static inline
 372 struct lttng_ht *ust_app_get_ht(void)
 373 {
 374         return NULL;
 375 }
 376 static inline
 377 void ust_app_ht_alloc(void)
 378 {}
 379 static inline
 380 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
 381 {}
 382 static inline
 383 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 384                 struct ltt_ust_channel *uchan)
 385 {
 386         return 0;
 387 }
 388 static inline
 389 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 390                 struct ltt_ust_channel *uchan)
 391 {
 392         return 0;
 393 }
 394 static inline
 395 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 396                 struct ltt_ust_channel *uchan)
 397 {
 398         return 0;
 399 }
 400 static inline
 401 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 402                 struct ltt_ust_channel *uchan)
 403 {
 404         return 0;
 405 }
 406 static inline
 407 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 408                 struct ltt_ust_channel *uchan)
 409 {
 410         return 0;
 411 }
 412 static inline
 413 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 414                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 415 {
 416         return 0;
 417 }
 418 static inline
 419 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 420                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 421 {
 422         return 0;
 423 }
 424 static inline
 425 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 426                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 427 {
 428         return 0;
 429 }
 430 static inline
 431 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 432                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 433 {
 434         return 0;
 435 }
 436 static inline
 437 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 438                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 439                 pid_t pid)
 440 {
 441         return 0;
 442 }
 443 static inline
 444 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 445                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 446                 pid_t pid)
 447 {
 448         return 0;
 449 }
 450 static inline
 451 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
 452 {
 453         return 0;
 454 }
 455 static inline
 456 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
 457 {
 458         return 0;
 459 }
 460 static inline
 461 int ust_app_recv_notify(int sock)
 462 {
 463         return 0;
 464 }
 465 static inline
 466 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
 467 {
 468         return NULL;
 469 }
 470 static inline
 471 void ust_app_add(struct ust_app *app)
 472 {
 473 }
 474 static inline
 475 void ust_app_notify_sock_unregister(int sock)
 476 {
 477 }
 478
 479 #endif /* HAVE_LIBLTTNG_UST_CTL */
 480
 481 #endif /* _LTT_UST_APP_H */