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