src/bin/lttng-sessiond/ust-app.h

   1 /*
   2  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
   3  * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-only
   6  *
   7  */
   8
   9 #ifndef _LTT_UST_APP_H
  10 #define _LTT_UST_APP_H
  11
  12 #include <stdint.h>
  13
  14 #include <common/index-allocator.h>
  15 #include <common/uuid.h>
  16
  17 #include "trace-ust.h"
  18 #include "ust-registry.h"
  19 #include "session.h"
  20
  21 #define UST_APP_EVENT_LIST_SIZE 32
  22
  23 /* Process name (short). */
  24 #define UST_APP_PROCNAME_LEN    16
  25
  26 struct lttng_bytecode;
  27 struct lttng_ust_filter_bytecode;
  28
  29 extern int the_ust_consumerd64_fd, the_ust_consumerd32_fd;
  30
  31 /*
  32  * Object used to close the notify socket in a call_rcu(). Since the
  33  * application might not be found, we need an independant object containing the
  34  * notify socket fd.
  35  */
  36 struct ust_app_notify_sock_obj {
  37         int fd;
  38         struct rcu_head head;
  39 };
  40
  41 struct ust_app_ht_key {
  42         const char *name;
  43         const struct lttng_bytecode *filter;
  44         enum lttng_ust_abi_loglevel_type loglevel_type;
  45         const struct lttng_event_exclusion *exclusion;
  46 };
  47
  48 /*
  49  * Application registration data structure.
  50  */
  51 struct ust_register_msg {
  52         enum ustctl_socket_type type;
  53         uint32_t major;
  54         uint32_t minor;
  55         uint32_t abi_major;
  56         uint32_t abi_minor;
  57         pid_t pid;
  58         pid_t ppid;
  59         uid_t uid;
  60         gid_t gid;
  61         uint32_t bits_per_long;
  62         uint32_t uint8_t_alignment;
  63         uint32_t uint16_t_alignment;
  64         uint32_t uint32_t_alignment;
  65         uint32_t uint64_t_alignment;
  66         uint32_t long_alignment;
  67         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
  68         char name[LTTNG_UST_ABI_PROCNAME_LEN];
  69 };
  70
  71 /*
  72  * Global applications HT used by the session daemon. This table is indexed by
  73  * PID using the pid_n node and pid value of an ust_app.
  74  */
  75 extern struct lttng_ht *ust_app_ht;
  76
  77 /*
  78  * Global applications HT used by the session daemon. This table is indexed by
  79  * socket using the sock_n node and sock value of an ust_app.
  80  *
  81  * The 'sock' in question here is the 'command' socket.
  82  */
  83 extern struct lttng_ht *ust_app_ht_by_sock;
  84
  85 /*
  86  * Global applications HT used by the session daemon. This table is indexed by
  87  * socket using the notify_sock_n node and notify_sock value of an ust_app.
  88  */
  89 extern struct lttng_ht *ust_app_ht_by_notify_sock;
  90
  91 /* Stream list containing ust_app_stream. */
  92 struct ust_app_stream_list {
  93         unsigned int count;
  94         struct cds_list_head head;
  95 };
  96
  97 struct ust_app_ctx {
  98         int handle;
  99         struct lttng_ust_context_attr ctx;
 100         struct lttng_ust_abi_object_data *obj;
 101         struct lttng_ht_node_ulong node;
 102         struct cds_list_head list;
 103 };
 104
 105 struct ust_app_event {
 106         int enabled;
 107         int handle;
 108         struct lttng_ust_abi_object_data *obj;
 109         struct lttng_ust_abi_event attr;
 110         char name[LTTNG_UST_ABI_SYM_NAME_LEN];
 111         struct lttng_ht_node_str node;
 112         struct lttng_bytecode *filter;
 113         struct lttng_event_exclusion *exclusion;
 114 };
 115
 116 struct ust_app_event_notifier_rule {
 117         int enabled;
 118         uint64_t error_counter_index;
 119         int handle;
 120         struct lttng_ust_abi_object_data *obj;
 121         /* Holds a strong reference. */
 122         struct lttng_trigger *trigger;
 123         /* Unique ID returned by the tracer to identify this event notifier. */
 124         uint64_t token;
 125         struct lttng_ht_node_u64 node;
 126         /* The trigger object owns the filter. */
 127         const struct lttng_bytecode *filter;
 128         /* Owned by this. */
 129         struct lttng_event_exclusion *exclusion;
 130         /* For delayed reclaim. */
 131         struct rcu_head rcu_head;
 132 };
 133
 134 struct ust_app_stream {
 135         int handle;
 136         char pathname[PATH_MAX];
 137         /* Format is %s_%d respectively channel name and CPU number. */
 138         char name[DEFAULT_STREAM_NAME_LEN];
 139         struct lttng_ust_abi_object_data *obj;
 140         /* Using a list of streams to keep order. */
 141         struct cds_list_head list;
 142 };
 143
 144 struct ust_app_channel {
 145         int enabled;
 146         int handle;
 147         /* Channel and streams were sent to the UST tracer. */
 148         int is_sent;
 149         /*
 150          * Unique key used to identify the channel on the consumer side.
 151          * 0 is a reserved 'invalid' value used to indicate that the consumer
 152          * does not know about this channel (i.e. an error occurred).
 153          */
 154         uint64_t key;
 155         /* Id of the tracing channel set on creation. */
 156         uint64_t tracing_channel_id;
 157         /* Number of stream that this channel is expected to receive. */
 158         unsigned int expected_stream_count;
 159         char name[LTTNG_UST_ABI_SYM_NAME_LEN];
 160         struct lttng_ust_abi_object_data *obj;
 161         struct ustctl_consumer_channel_attr attr;
 162         struct ust_app_stream_list streams;
 163         /* Session pointer that owns this object. */
 164         struct ust_app_session *session;
 165         /*
 166          * Contexts are kept in a hash table for fast lookup and in an ordered list
 167          * so we are able to enable them on the tracer side in the same order the
 168          * user added them.
 169          */
 170         struct lttng_ht *ctx;
 171         struct cds_list_head ctx_list;
 172
 173         struct lttng_ht *events;
 174         uint64_t tracefile_size;
 175         uint64_t tracefile_count;
 176         uint64_t monitor_timer_interval;
 177         /*
 178          * Node indexed by channel name in the channels' hash table of a session.
 179          */
 180         struct lttng_ht_node_str node;
 181         /*
 182          * Node indexed by UST channel object descriptor (handle). Stored in the
 183          * ust_objd hash table in the ust_app object.
 184          */
 185         struct lttng_ht_node_ulong ust_objd_node;
 186         /* For delayed reclaim */
 187         struct rcu_head rcu_head;
 188 };
 189
 190 struct ust_app_session {
 191         /*
 192          * Lock protecting this session's ust app interaction. Held
 193          * across command send/recv to/from app. Never nests within the
 194          * session registry lock.
 195          */
 196         pthread_mutex_t lock;
 197
 198         int enabled;
 199         /* started: has the session been in started state at any time ? */
 200         int started;  /* allows detection of start vs restart. */
 201         int handle;   /* used has unique identifier for app session */
 202
 203         bool deleted;   /* Session deleted flag. Check with lock held. */
 204
 205         /*
 206          * Tracing session ID. Multiple ust app session can have the same tracing
 207          * session id making this value NOT unique to the object.
 208          */
 209         uint64_t tracing_id;
 210         uint64_t id;    /* Unique session identifier */
 211         struct lttng_ht *channels; /* Registered channels */
 212         struct lttng_ht_node_u64 node;
 213         /*
 214          * Node indexed by UST session object descriptor (handle). Stored in the
 215          * ust_sessions_objd hash table in the ust_app object.
 216          */
 217         struct lttng_ht_node_ulong ust_objd_node;
 218         /* Starts with 'ust'; no leading slash. */
 219         char path[PATH_MAX];
 220         /* UID/GID of the application owning the session */
 221         struct lttng_credentials real_credentials;
 222         /* Effective UID and GID. Same as the tracing session. */
 223         struct lttng_credentials effective_credentials;
 224         struct cds_list_head teardown_node;
 225         /*
 226          * Once at least *one* session is created onto the application, the
 227          * corresponding consumer is set so we can use it on unregistration.
 228          */
 229         struct consumer_output *consumer;
 230         enum lttng_buffer_type buffer_type;
 231         /* ABI of the session. Same value as the application. */
 232         uint32_t bits_per_long;
 233         /* For delayed reclaim */
 234         struct rcu_head rcu_head;
 235         /* If the channel's streams have to be outputed or not. */
 236         unsigned int output_traces;
 237         unsigned int live_timer_interval;       /* usec */
 238
 239         /* Metadata channel attributes. */
 240         struct ustctl_consumer_channel_attr metadata_attr;
 241
 242         char root_shm_path[PATH_MAX];
 243         char shm_path[PATH_MAX];
 244 };
 245
 246 /*
 247  * Registered traceable applications. Libust registers to the session daemon
 248  * and a linked list is kept of all running traceable app.
 249  */
 250 struct ust_app {
 251         int sock;
 252         pthread_mutex_t sock_lock;      /* Protects sock protocol. */
 253
 254         int notify_sock;
 255         pid_t pid;
 256         pid_t ppid;
 257         uid_t uid;           /* User ID that owns the apps */
 258         gid_t gid;           /* Group ID that owns the apps */
 259
 260         /* App ABI */
 261         uint32_t bits_per_long;
 262         uint32_t uint8_t_alignment;
 263         uint32_t uint16_t_alignment;
 264         uint32_t uint32_t_alignment;
 265         uint32_t uint64_t_alignment;
 266         uint32_t long_alignment;
 267         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
 268
 269         int compatible; /* If the lttng-ust tracer version does not match the
 270                                            supported version of the session daemon, this flag is
 271                                            set to 0 (NOT compatible) else 1. */
 272         struct lttng_ust_abi_tracer_version version;
 273         uint32_t v_major;    /* Version major number */
 274         uint32_t v_minor;    /* Version minor number */
 275         /* Extra for the NULL byte. */
 276         char name[UST_APP_PROCNAME_LEN + 1];
 277         /* Type of buffer this application uses. */
 278         enum lttng_buffer_type buffer_type;
 279         struct lttng_ht *sessions;
 280         struct lttng_ht_node_ulong pid_n;
 281         struct lttng_ht_node_ulong sock_n;
 282         struct lttng_ht_node_ulong notify_sock_n;
 283         /*
 284          * This is a list of ust app session that, once the app is going into
 285          * teardown mode, in the RCU call, each node in this list is removed and
 286          * deleted.
 287          *
 288          * Element of the list are added when an application unregisters after each
 289          * ht_del of ust_app_session associated to this app. This list is NOT used
 290          * when a session is destroyed.
 291          */
 292         struct cds_list_head teardown_head;
 293         /*
 294          * Hash table containing ust_app_channel indexed by channel objd.
 295          */
 296         struct lttng_ht *ust_objd;
 297         /*
 298          * Hash table containing ust_app_session indexed by objd.
 299          */
 300         struct lttng_ht *ust_sessions_objd;
 301
 302         /*
 303          * If this application is of the agent domain and this is non negative then
 304          * a lookup MUST be done to acquire a read side reference to the
 305          * corresponding agent app object. If the lookup fails, this should be set
 306          * to a negative value indicating that the agent application is gone.
 307          */
 308         int agent_app_sock;
 309         /*
 310          * Time at which the app is registred.
 311          * Used for path creation
 312          */
 313         time_t registration_time;
 314         /*
 315          * Event notifier
 316          */
 317         struct {
 318                 /*
 319                  * Handle to the lttng_ust object representing the event
 320                  * notifier group.
 321                  */
 322                 struct lttng_ust_abi_object_data *object;
 323                 struct lttng_pipe *event_pipe;
 324                 struct lttng_ust_abi_object_data *counter;
 325                 struct lttng_ust_abi_object_data **counter_cpu;
 326                 int nr_counter_cpu;
 327         } event_notifier_group;
 328         /*
 329          * Hashtable indexing the application's event notifier rule's
 330          * (ust_app_event_notifier_rule) by their token's value.
 331          */
 332         struct lttng_ht *token_to_event_notifier_rule_ht;
 333 };
 334
 335 #ifdef HAVE_LIBLTTNG_UST_CTL
 336
 337 int ust_app_register(struct ust_register_msg *msg, int sock);
 338 int ust_app_register_done(struct ust_app *app);
 339 int ust_app_version(struct ust_app *app);
 340 void ust_app_unregister(int sock);
 341 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 342 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 343 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 344 int ust_app_list_events(struct lttng_event **events);
 345 int ust_app_list_event_fields(struct lttng_event_field **fields);
 346 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 347                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 348 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 349                 struct ltt_ust_channel *uchan);
 350 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 351                 struct ltt_ust_channel *uchan);
 352 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 353                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 354 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 355                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 356 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 357                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 358 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
 359 void ust_app_global_update_all(struct ltt_ust_session *usess);
 360 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
 361 void ust_app_global_update_all_event_notifier_rules(void);
 362
 363 void ust_app_update_event_notifier_error_count(struct lttng_trigger *trigger);
 364
 365 void ust_app_clean_list(void);
 366 int ust_app_ht_alloc(void);
 367 struct ust_app *ust_app_find_by_pid(pid_t pid);
 368 struct ust_app_stream *ust_app_alloc_stream(void);
 369 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 370 int ust_app_recv_notify(int sock);
 371 void ust_app_add(struct ust_app *app);
 372 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
 373 void ust_app_notify_sock_unregister(int sock);
 374 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
 375                 struct consumer_socket *socket, int send_zero_data);
 376 void ust_app_destroy(struct ust_app *app);
 377 enum lttng_error_code ust_app_snapshot_record(
 378                 const struct ltt_ust_session *usess,
 379                 const struct consumer_output *output, int wait,
 380                 uint64_t nb_packets_per_stream);
 381 uint64_t ust_app_get_size_one_more_packet_per_stream(
 382                 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
 383 struct ust_app *ust_app_find_by_sock(int sock);
 384 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
 385                 struct cds_list_head *buffer_reg_uid_list,
 386                 struct consumer_output *consumer, uint64_t uchan_id,
 387                 int overwrite, uint64_t *discarded, uint64_t *lost);
 388 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
 389                 struct ltt_ust_channel *uchan,
 390                 struct consumer_output *consumer,
 391                 int overwrite, uint64_t *discarded, uint64_t *lost);
 392 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
 393 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
 394 enum lttng_error_code ust_app_create_channel_subdirectories(
 395                 const struct ltt_ust_session *session);
 396 int ust_app_release_object(struct ust_app *app,
 397                 struct lttng_ust_abi_object_data *data);
 398 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
 399 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
 400
 401 int ust_app_setup_event_notifier_group(struct ust_app *app);
 402
 403 static inline
 404 int ust_app_supported(void)
 405 {
 406         return 1;
 407 }
 408
 409 #else /* HAVE_LIBLTTNG_UST_CTL */
 410
 411 static inline
 412 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
 413 {
 414         return 0;
 415 }
 416 static inline
 417 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
 418 {
 419         return 0;
 420 }
 421 static inline
 422 int ust_app_start_trace_all(struct ltt_ust_session *usess)
 423 {
 424         return 0;
 425 }
 426 static inline
 427 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
 428 {
 429         return 0;
 430 }
 431 static inline
 432 int ust_app_list_events(struct lttng_event **events)
 433 {
 434         return -ENOSYS;
 435 }
 436 static inline
 437 int ust_app_list_event_fields(struct lttng_event_field **fields)
 438 {
 439         return -ENOSYS;
 440 }
 441 static inline
 442 int ust_app_register(struct ust_register_msg *msg, int sock)
 443 {
 444         return -ENOSYS;
 445 }
 446 static inline
 447 int ust_app_register_done(struct ust_app *app)
 448 {
 449         return -ENOSYS;
 450 }
 451 static inline
 452 int ust_app_version(struct ust_app *app)
 453 {
 454         return -ENOSYS;
 455 }
 456 static inline
 457 void ust_app_unregister(int sock)
 458 {
 459 }
 460 static inline
 461 void ust_app_lock_list(void)
 462 {
 463 }
 464 static inline
 465 void ust_app_unlock_list(void)
 466 {
 467 }
 468 static inline
 469 void ust_app_clean_list(void)
 470 {
 471 }
 472 static inline
 473 struct ust_app_list *ust_app_get_list(void)
 474 {
 475         return NULL;
 476 }
 477 static inline
 478 struct ust_app *ust_app_get_by_pid(pid_t pid)
 479 {
 480         return NULL;
 481 }
 482 static inline
 483 int ust_app_ht_alloc(void)
 484 {
 485         return 0;
 486 }
 487 static inline
 488 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
 489 {}
 490 static inline
 491 void ust_app_global_update_event_notifier_rules(struct ust_app *app)
 492 {}
 493 static inline
 494 void ust_app_global_update_all_event_notifier_rules(void)
 495 {}
 496 static inline
 497 int ust_app_setup_event_notifier_group(struct ust_app *app)
 498 {
 499         return 0;
 500 }
 501 static inline
 502 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 503                 struct ltt_ust_channel *uchan)
 504 {
 505         return 0;
 506 }
 507 static inline
 508 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 509                 struct ltt_ust_channel *uchan)
 510 {
 511         return 0;
 512 }
 513 static inline
 514 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 515                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 516 {
 517         return 0;
 518 }
 519 static inline
 520 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 521                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 522 {
 523         return 0;
 524 }
 525 static inline
 526 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 527                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 528 {
 529         return 0;
 530 }
 531 static inline
 532 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 533                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 534 {
 535         return 0;
 536 }
 537 static inline
 538 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 539                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 540                 pid_t pid)
 541 {
 542         return 0;
 543 }
 544 static inline
 545 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
 546 {
 547         return 0;
 548 }
 549 static inline
 550 int ust_app_recv_notify(int sock)
 551 {
 552         return 0;
 553 }
 554 static inline
 555 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
 556 {
 557         return NULL;
 558 }
 559 static inline
 560 void ust_app_add(struct ust_app *app)
 561 {
 562 }
 563 static inline
 564 void ust_app_notify_sock_unregister(int sock)
 565 {
 566 }
 567 static inline
 568 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
 569                 struct consumer_socket *socket, int send_zero_data)
 570 {
 571         return 0;
 572 }
 573 static inline
 574 void ust_app_destroy(struct ust_app *app)
 575 {
 576         return;
 577 }
 578 static inline
 579 enum lttng_error_code ust_app_snapshot_record(struct ltt_ust_session *usess,
 580                 const struct consumer_output *output, int wait, uint64_t max_stream_size)
 581 {
 582         return 0;
 583 }
 584 static inline
 585 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
 586 {
 587         return 0;
 588 }
 589 static inline
 590 void ust_app_update_event_notifier_error_count(
 591                 struct lttng_trigger *lttng_trigger)
 592 {
 593         return;
 594 }
 595 static inline
 596 int ust_app_supported(void)
 597 {
 598         return 0;
 599 }
 600 static inline
 601 struct ust_app *ust_app_find_by_sock(int sock)
 602 {
 603         return NULL;
 604 }
 605 static inline
 606 struct ust_app *ust_app_find_by_pid(pid_t pid)
 607 {
 608         return NULL;
 609 }
 610 static inline
 611 uint64_t ust_app_get_size_one_more_packet_per_stream(
 612                 const struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
 613         return 0;
 614 }
 615 static inline
 616 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
 617                 struct cds_list_head *buffer_reg_uid_list,
 618                 struct consumer_output *consumer, int overwrite,
 619                 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
 620 {
 621         return 0;
 622 }
 623
 624 static inline
 625 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
 626                 struct ltt_ust_channel *uchan,
 627                 struct consumer_output *consumer,
 628                 int overwrite, uint64_t *discarded, uint64_t *lost)
 629 {
 630         return 0;
 631 }
 632
 633 static inline
 634 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
 635 {
 636         return 0;
 637 }
 638
 639 static inline
 640 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session)
 641 {
 642         return 0;
 643 }
 644
 645 static inline
 646 enum lttng_error_code ust_app_create_channel_subdirectories(
 647                 const struct ltt_ust_session *session)
 648 {
 649         return 0;
 650 }
 651
 652 static inline
 653 int ust_app_release_object(struct ust_app *app, struct lttng_ust_abi_object_data *data)
 654 {
 655         return 0;
 656 }
 657
 658 static inline
 659 enum lttng_error_code ust_app_clear_session(struct ltt_session *session)
 660 {
 661         return 0;
 662 }
 663
 664 static inline
 665 enum lttng_error_code ust_app_open_packets(struct ltt_session *session)
 666 {
 667         return 0;
 668 }
 669
 670 #endif /* HAVE_LIBLTTNG_UST_CTL */
 671
 672 #endif /* _LTT_UST_APP_H */