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