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  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License, version 2 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef _LTT_UST_APP_H
  20 #define _LTT_UST_APP_H
  21
  22 #include <stdint.h>
  23
  24 #include <common/compat/uuid.h>
  25
  26 #include "trace-ust.h"
  27 #include "ust-registry.h"
  28
  29 #define UST_APP_EVENT_LIST_SIZE 32
  30
  31 /* Process name (short). */
  32 #define UST_APP_PROCNAME_LEN    16
  33
  34 struct lttng_filter_bytecode;
  35 struct lttng_ust_filter_bytecode;
  36
  37 extern int ust_consumerd64_fd, ust_consumerd32_fd;
  38
  39 /*
  40  * Object used to close the notify socket in a call_rcu(). Since the
  41  * application might not be found, we need an independant object containing the
  42  * notify socket fd.
  43  */
  44 struct ust_app_notify_sock_obj {
  45         int fd;
  46         struct rcu_head head;
  47 };
  48
  49 struct ust_app_ht_key {
  50         const char *name;
  51         const struct lttng_filter_bytecode *filter;
  52         enum lttng_ust_loglevel_type loglevel_type;
  53         const struct lttng_event_exclusion *exclusion;
  54 };
  55
  56 /*
  57  * Application registration data structure.
  58  */
  59 struct ust_register_msg {
  60         enum ustctl_socket_type type;
  61         uint32_t major;
  62         uint32_t minor;
  63         uint32_t abi_major;
  64         uint32_t abi_minor;
  65         pid_t pid;
  66         pid_t ppid;
  67         uid_t uid;
  68         gid_t gid;
  69         uint32_t bits_per_long;
  70         uint32_t uint8_t_alignment;
  71         uint32_t uint16_t_alignment;
  72         uint32_t uint32_t_alignment;
  73         uint32_t uint64_t_alignment;
  74         uint32_t long_alignment;
  75         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
  76         char name[LTTNG_UST_ABI_PROCNAME_LEN];
  77 };
  78
  79 /*
  80  * Global applications HT used by the session daemon. This table is indexed by
  81  * PID using the pid_n node and pid value of an ust_app.
  82  */
  83 struct lttng_ht *ust_app_ht;
  84
  85 /*
  86  * Global applications HT used by the session daemon. This table is indexed by
  87  * socket using the sock_n node and sock value of an ust_app.
  88  */
  89 struct lttng_ht *ust_app_ht_by_sock;
  90
  91 /*
  92  * Global applications HT used by the session daemon. This table is indexed by
  93  * socket using the notify_sock_n node and notify_sock value of an ust_app.
  94  */
  95 struct lttng_ht *ust_app_ht_by_notify_sock;
  96
  97 /* Stream list containing ust_app_stream. */
  98 struct ust_app_stream_list {
  99         unsigned int count;
 100         struct cds_list_head head;
 101 };
 102
 103 struct ust_app_ctx {
 104         int handle;
 105         struct lttng_ust_context_attr ctx;
 106         struct lttng_ust_object_data *obj;
 107         struct lttng_ht_node_ulong node;
 108         struct cds_list_head list;
 109 };
 110
 111 struct ust_app_event {
 112         int enabled;
 113         int handle;
 114         struct lttng_ust_object_data *obj;
 115         struct lttng_ust_event attr;
 116         char name[LTTNG_UST_SYM_NAME_LEN];
 117         struct lttng_ht_node_str node;
 118         struct lttng_filter_bytecode *filter;
 119         struct lttng_event_exclusion *exclusion;
 120 };
 121
 122 struct ust_app_stream {
 123         int handle;
 124         char pathname[PATH_MAX];
 125         /* Format is %s_%d respectively channel name and CPU number. */
 126         char name[DEFAULT_STREAM_NAME_LEN];
 127         struct lttng_ust_object_data *obj;
 128         /* Using a list of streams to keep order. */
 129         struct cds_list_head list;
 130 };
 131
 132 struct ust_app_channel {
 133         int enabled;
 134         int handle;
 135         /* Channel and streams were sent to the UST tracer. */
 136         int is_sent;
 137         /* Unique key used to identify the channel on the consumer side. */
 138         uint64_t key;
 139         /* Id of the tracing channel set on creation. */
 140         uint64_t tracing_channel_id;
 141         /* Number of stream that this channel is expected to receive. */
 142         unsigned int expected_stream_count;
 143         char name[LTTNG_UST_SYM_NAME_LEN];
 144         struct lttng_ust_object_data *obj;
 145         struct ustctl_consumer_channel_attr attr;
 146         struct ust_app_stream_list streams;
 147         /* Session pointer that owns this object. */
 148         struct ust_app_session *session;
 149         /*
 150          * Contexts are kept in a hash table for fast lookup and in an ordered list
 151          * so we are able to enable them on the tracer side in the same order the
 152          * user added them.
 153          */
 154         struct lttng_ht *ctx;
 155         struct cds_list_head ctx_list;
 156
 157         struct lttng_ht *events;
 158         uint64_t tracefile_size;
 159         uint64_t tracefile_count;
 160         /*
 161          * Node indexed by channel name in the channels' hash table of a session.
 162          */
 163         struct lttng_ht_node_str node;
 164         /*
 165          * Node indexed by UST channel object descriptor (handle). Stored in the
 166          * ust_objd hash table in the ust_app object.
 167          */
 168         struct lttng_ht_node_ulong ust_objd_node;
 169         /* For delayed reclaim */
 170         struct rcu_head rcu_head;
 171 };
 172
 173 struct ust_app_session {
 174         /*
 175          * Lock protecting this session's ust app interaction. Held
 176          * across command send/recv to/from app. Never nests within the
 177          * session registry lock.
 178          */
 179         pthread_mutex_t lock;
 180
 181         int enabled;
 182         /* started: has the session been in started state at any time ? */
 183         int started;  /* allows detection of start vs restart. */
 184         int handle;   /* used has unique identifier for app session */
 185
 186         bool deleted;   /* Session deleted flag. Check with lock held. */
 187
 188         /*
 189          * Tracing session ID. Multiple ust app session can have the same tracing
 190          * session id making this value NOT unique to the object.
 191          */
 192         uint64_t tracing_id;
 193         uint64_t id;    /* Unique session identifier */
 194         struct lttng_ht *channels; /* Registered channels */
 195         struct lttng_ht_node_u64 node;
 196         /*
 197          * Node indexed by UST session object descriptor (handle). Stored in the
 198          * ust_sessions_objd hash table in the ust_app object.
 199          */
 200         struct lttng_ht_node_ulong ust_objd_node;
 201         char path[PATH_MAX];
 202         /* UID/GID of the application owning the session */
 203         uid_t uid;
 204         gid_t gid;
 205         /* Effective UID and GID. Same as the tracing session. */
 206         uid_t euid;
 207         gid_t egid;
 208         struct cds_list_head teardown_node;
 209         /*
 210          * Once at least *one* session is created onto the application, the
 211          * corresponding consumer is set so we can use it on unregistration.
 212          */
 213         struct consumer_output *consumer;
 214         enum lttng_buffer_type buffer_type;
 215         /* ABI of the session. Same value as the application. */
 216         uint32_t bits_per_long;
 217         /* For delayed reclaim */
 218         struct rcu_head rcu_head;
 219         /* If the channel's streams have to be outputed or not. */
 220         unsigned int output_traces;
 221         unsigned int live_timer_interval;       /* usec */
 222
 223         /* Metadata channel attributes. */
 224         struct ustctl_consumer_channel_attr metadata_attr;
 225
 226         char root_shm_path[PATH_MAX];
 227         char shm_path[PATH_MAX];
 228 };
 229
 230 /*
 231  * Registered traceable applications. Libust registers to the session daemon
 232  * and a linked list is kept of all running traceable app.
 233  */
 234 struct ust_app {
 235         int sock;
 236         pthread_mutex_t sock_lock;      /* Protects sock protocol. */
 237
 238         int notify_sock;
 239         pid_t pid;
 240         pid_t ppid;
 241         uid_t uid;           /* User ID that owns the apps */
 242         gid_t gid;           /* Group ID that owns the apps */
 243
 244         /* App ABI */
 245         uint32_t bits_per_long;
 246         uint32_t uint8_t_alignment;
 247         uint32_t uint16_t_alignment;
 248         uint32_t uint32_t_alignment;
 249         uint32_t uint64_t_alignment;
 250         uint32_t long_alignment;
 251         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
 252
 253         int compatible; /* If the lttng-ust tracer version does not match the
 254                                            supported version of the session daemon, this flag is
 255                                            set to 0 (NOT compatible) else 1. */
 256         struct lttng_ust_tracer_version version;
 257         uint32_t v_major;    /* Version major number */
 258         uint32_t v_minor;    /* Version minor number */
 259         /* Extra for the NULL byte. */
 260         char name[UST_APP_PROCNAME_LEN + 1];
 261         /* Type of buffer this application uses. */
 262         enum lttng_buffer_type buffer_type;
 263         struct lttng_ht *sessions;
 264         struct lttng_ht_node_ulong pid_n;
 265         struct lttng_ht_node_ulong sock_n;
 266         struct lttng_ht_node_ulong notify_sock_n;
 267         /*
 268          * This is a list of ust app session that, once the app is going into
 269          * teardown mode, in the RCU call, each node in this list is removed and
 270          * deleted.
 271          *
 272          * Element of the list are added when an application unregisters after each
 273          * ht_del of ust_app_session associated to this app. This list is NOT used
 274          * when a session is destroyed.
 275          */
 276         struct cds_list_head teardown_head;
 277         /*
 278          * Hash table containing ust_app_channel indexed by channel objd.
 279          */
 280         struct lttng_ht *ust_objd;
 281         /*
 282          * Hash table containing ust_app_session indexed by objd.
 283          */
 284         struct lttng_ht *ust_sessions_objd;
 285
 286         /*
 287          * If this application is of the agent domain and this is non negative then
 288          * a lookup MUST be done to acquire a read side reference to the
 289          * corresponding agent app object. If the lookup fails, this should be set
 290          * to a negative value indicating that the agent application is gone.
 291          */
 292         int agent_app_sock;
 293 };
 294
 295 #ifdef HAVE_LIBLTTNG_UST_CTL
 296
 297 int ust_app_register(struct ust_register_msg *msg, int sock);
 298 int ust_app_register_done(struct ust_app *app);
 299 int ust_app_version(struct ust_app *app);
 300 void ust_app_unregister(int sock);
 301 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 302 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 303 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 304 int ust_app_list_events(struct lttng_event **events);
 305 int ust_app_list_event_fields(struct lttng_event_field **fields);
 306 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 307                 struct ltt_ust_channel *uchan);
 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_enable_event_pid(struct ltt_ust_session *usess,
 311                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 312                 pid_t pid);
 313 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 314                 struct ltt_ust_channel *uchan);
 315 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 316                 struct ltt_ust_channel *uchan);
 317 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 318                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 319 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 320                 struct ltt_ust_channel *uchan);
 321 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 322                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 323 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 324                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 325 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
 326 void ust_app_global_update_all(struct ltt_ust_session *usess);
 327
 328 void ust_app_clean_list(void);
 329 int ust_app_ht_alloc(void);
 330 struct ust_app *ust_app_find_by_pid(pid_t pid);
 331 struct ust_app_stream *ust_app_alloc_stream(void);
 332 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 333 int ust_app_recv_notify(int sock);
 334 void ust_app_add(struct ust_app *app);
 335 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
 336 void ust_app_notify_sock_unregister(int sock);
 337 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
 338                 struct consumer_socket *socket, int send_zero_data);
 339 void ust_app_destroy(struct ust_app *app);
 340 int ust_app_snapshot_record(struct ltt_ust_session *usess,
 341                 struct snapshot_output *output, int wait,
 342                 uint64_t nb_packets_per_stream);
 343 uint64_t ust_app_get_size_one_more_packet_per_stream(
 344                 struct ltt_ust_session *usess, uint64_t cur_nr_packets);
 345 struct ust_app *ust_app_find_by_sock(int sock);
 346 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
 347                 struct cds_list_head *buffer_reg_uid_list,
 348                 struct consumer_output *consumer, uint64_t uchan_id,
 349                 int overwrite, uint64_t *discarded, uint64_t *lost);
 350 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
 351                 struct ltt_ust_channel *uchan,
 352                 struct consumer_output *consumer,
 353                 int overwrite, uint64_t *discarded, uint64_t *lost);
 354 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
 355
 356 int ust_force_stop_live_timer(struct ltt_ust_session *usess);
 357 int ust_force_start_live_timer(struct ltt_ust_session *usess);
 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_channel_glb(struct ltt_ust_session *usess,
 460                 struct ltt_ust_channel *uchan)
 461 {
 462         return 0;
 463 }
 464 static inline
 465 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 466                 struct ltt_ust_channel *uchan)
 467 {
 468         return 0;
 469 }
 470 static inline
 471 int ust_app_create_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_disable_event_glb(struct ltt_ust_session *usess,
 478                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 479 {
 480         return 0;
 481 }
 482 static inline
 483 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 484                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 485 {
 486         return 0;
 487 }
 488 static inline
 489 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 490                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 491 {
 492         return 0;
 493 }
 494 static inline
 495 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 496                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 497                 pid_t pid)
 498 {
 499         return 0;
 500 }
 501 static inline
 502 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
 503 {
 504         return 0;
 505 }
 506 static inline
 507 int ust_app_recv_notify(int sock)
 508 {
 509         return 0;
 510 }
 511 static inline
 512 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
 513 {
 514         return NULL;
 515 }
 516 static inline
 517 void ust_app_add(struct ust_app *app)
 518 {
 519 }
 520 static inline
 521 void ust_app_notify_sock_unregister(int sock)
 522 {
 523 }
 524 static inline
 525 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
 526                 struct consumer_socket *socket, int send_zero_data)
 527 {
 528         return 0;
 529 }
 530 static inline
 531 void ust_app_destroy(struct ust_app *app)
 532 {
 533         return;
 534 }
 535 static inline
 536 int ust_app_snapshot_record(struct ltt_ust_session *usess,
 537                 struct snapshot_output *output, int wait, uint64_t max_stream_size)
 538 {
 539         return 0;
 540 }
 541 static inline
 542 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
 543 {
 544         return 0;
 545 }
 546
 547 static inline
 548 int ust_app_supported(void)
 549 {
 550         return 0;
 551 }
 552 static inline
 553 struct ust_app *ust_app_find_by_sock(int sock)
 554 {
 555         return NULL;
 556 }
 557 static inline
 558 struct ust_app *ust_app_find_by_pid(pid_t pid)
 559 {
 560         return NULL;
 561 }
 562 static inline
 563 uint64_t ust_app_get_size_one_more_packet_per_stream(
 564                 struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
 565         return 0;
 566 }
 567 static inline
 568 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
 569                 struct cds_list_head *buffer_reg_uid_list,
 570                 struct consumer_output *consumer, int overwrite,
 571                 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
 572 {
 573         return 0;
 574 }
 575
 576 static inline
 577 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
 578                 struct ltt_ust_channel *uchan,
 579                 struct consumer_output *consumer,
 580                 int overwrite, uint64_t *discarded, uint64_t *lost)
 581 {
 582         return 0;
 583 }
 584
 585 static inline
 586 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
 587 {
 588         return 0;
 589 }
 590
 591 static inline
 592 int ust_force_stop_live_timer(struct ltt_ust_session *usess)
 593 {
 594         return 0;
 595 }
 596
 597 static inline
 598 int ust_force_start_live_timer(struct ltt_ust_session *usess)
 599 {
 600         return 0;
 601 }
 602
 603 #endif /* HAVE_LIBLTTNG_UST_CTL */
 604
 605 #endif /* _LTT_UST_APP_H */