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