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