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