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