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