src/bin/lttng-sessiond/ust-app.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _LTT_UST_APP_H
  19 #define _LTT_UST_APP_H
  20
  21 #include <stdint.h>
  22
  23 #include <common/compat/uuid.h>
  24
  25 #include "jul.h"
  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_ust_filter_bytecode *filter;
  52         enum lttng_ust_loglevel_type loglevel;
  53         const struct lttng_ust_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 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_ust_filter_bytecode *filter;
 119         struct lttng_ust_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         /*
 187          * Tracing session ID. Multiple ust app session can have the same tracing
 188          * session id making this value NOT unique to the object.
 189          */
 190         uint64_t tracing_id;
 191         uint64_t id;    /* Unique session identifier */
 192         struct lttng_ht *channels; /* Registered channels */
 193         struct lttng_ht_node_u64 node;
 194         char path[PATH_MAX];
 195         /* UID/GID of the application owning the session */
 196         uid_t uid;
 197         gid_t gid;
 198         /* Effective UID and GID. Same as the tracing session. */
 199         uid_t euid;
 200         gid_t egid;
 201         struct cds_list_head teardown_node;
 202         /*
 203          * Once at least *one* session is created onto the application, the
 204          * corresponding consumer is set so we can use it on unregistration.
 205          */
 206         struct consumer_output *consumer;
 207         enum lttng_buffer_type buffer_type;
 208         /* ABI of the session. Same value as the application. */
 209         uint32_t bits_per_long;
 210         /* For delayed reclaim */
 211         struct rcu_head rcu_head;
 212         /* If the channel's streams have to be outputed or not. */
 213         unsigned int output_traces;
 214         unsigned int live_timer_interval;       /* usec */
 215
 216         /* Metadata channel attributes. */
 217         struct ustctl_consumer_channel_attr metadata_attr;
 218 };
 219
 220 /*
 221  * Registered traceable applications. Libust registers to the session daemon
 222  * and a linked list is kept of all running traceable app.
 223  */
 224 struct ust_app {
 225         int sock;
 226         int notify_sock;
 227         pid_t pid;
 228         pid_t ppid;
 229         uid_t uid;           /* User ID that owns the apps */
 230         gid_t gid;           /* Group ID that owns the apps */
 231
 232         /* App ABI */
 233         uint32_t bits_per_long;
 234         uint32_t uint8_t_alignment;
 235         uint32_t uint16_t_alignment;
 236         uint32_t uint32_t_alignment;
 237         uint32_t uint64_t_alignment;
 238         uint32_t long_alignment;
 239         int byte_order;         /* BIG_ENDIAN or LITTLE_ENDIAN */
 240
 241         int compatible; /* If the lttng-ust tracer version does not match the
 242                                            supported version of the session daemon, this flag is
 243                                            set to 0 (NOT compatible) else 1. */
 244         struct lttng_ust_tracer_version version;
 245         uint32_t v_major;    /* Version major number */
 246         uint32_t v_minor;    /* Version minor number */
 247         /* Extra for the NULL byte. */
 248         char name[UST_APP_PROCNAME_LEN + 1];
 249         /* Type of buffer this application uses. */
 250         enum lttng_buffer_type buffer_type;
 251         struct lttng_ht *sessions;
 252         struct lttng_ht_node_ulong pid_n;
 253         struct lttng_ht_node_ulong sock_n;
 254         struct lttng_ht_node_ulong notify_sock_n;
 255         /*
 256          * This is a list of ust app session that, once the app is going into
 257          * teardown mode, in the RCU call, each node in this list is removed and
 258          * deleted.
 259          *
 260          * Element of the list are added when an application unregisters after each
 261          * ht_del of ust_app_session associated to this app. This list is NOT used
 262          * when a session is destroyed.
 263          */
 264         struct cds_list_head teardown_head;
 265         /*
 266          * Hash table containing ust_app_channel indexed by channel objd.
 267          */
 268         struct lttng_ht *ust_objd;
 269         /*
 270          * If this application is of the JUL domain and this is non negative then a
 271          * lookup MUST be done to acquire a read side reference to the
 272          * corresponding JUL app object. If the lookup fails, this should be set to
 273          * a negative value indicating that the JUL application is gone.
 274          */
 275         int jul_app_sock;
 276 };
 277
 278 #ifdef HAVE_LIBLTTNG_UST_CTL
 279
 280 int ust_app_register(struct ust_register_msg *msg, int sock);
 281 static inline
 282 int ust_app_register_done(int sock)
 283 {
 284         return ustctl_register_done(sock);
 285 }
 286 int ust_app_version(struct ust_app *app);
 287 void ust_app_unregister(int sock);
 288 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 289 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 290 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 291 int ust_app_list_events(struct lttng_event **events);
 292 int ust_app_list_event_fields(struct lttng_event_field **fields);
 293 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 294                 struct ltt_ust_channel *uchan);
 295 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 296                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 297 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 298                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 299                 pid_t pid);
 300 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 301                 struct ltt_ust_channel *uchan);
 302 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 303                 struct ltt_ust_channel *uchan);
 304 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 305                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 306 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 307                 struct ltt_ust_channel *uchan);
 308 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 309                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 310 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 311                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 312 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
 313
 314 void ust_app_clean_list(void);
 315 void ust_app_ht_alloc(void);
 316 struct ust_app *ust_app_find_by_pid(pid_t pid);
 317 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 318 struct ust_app_stream *ust_app_alloc_stream(void);
 319 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 320 int ust_app_recv_notify(int sock);
 321 void ust_app_add(struct ust_app *app);
 322 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
 323 void ust_app_notify_sock_unregister(int sock);
 324 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
 325                 struct consumer_socket *socket, int send_zero_data);
 326 void ust_app_destroy(struct ust_app *app);
 327 int ust_app_snapshot_record(struct ltt_ust_session *usess,
 328                 struct snapshot_output *output, int wait, uint64_t max_stream_size);
 329 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess);
 330 struct ust_app *ust_app_find_by_sock(int sock);
 331
 332 static inline
 333 int ust_app_supported(void)
 334 {
 335         return 1;
 336 }
 337
 338 #else /* HAVE_LIBLTTNG_UST_CTL */
 339
 340 static inline
 341 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
 342 {
 343         return 0;
 344 }
 345 static inline
 346 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
 347 {
 348         return 0;
 349 }
 350 static inline
 351 int ust_app_start_trace_all(struct ltt_ust_session *usess)
 352 {
 353         return 0;
 354 }
 355 static inline
 356 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
 357 {
 358         return 0;
 359 }
 360 static inline
 361 int ust_app_list_events(struct lttng_event **events)
 362 {
 363         return -ENOSYS;
 364 }
 365 static inline
 366 int ust_app_list_event_fields(struct lttng_event_field **fields)
 367 {
 368         return -ENOSYS;
 369 }
 370 static inline
 371 int ust_app_register(struct ust_register_msg *msg, int sock)
 372 {
 373         return -ENOSYS;
 374 }
 375 static inline
 376 int ust_app_register_done(int sock)
 377 {
 378         return -ENOSYS;
 379 }
 380 static inline
 381 int ust_app_version(struct ust_app *app)
 382 {
 383         return -ENOSYS;
 384 }
 385 static inline
 386 void ust_app_unregister(int sock)
 387 {
 388 }
 389 static inline
 390 void ust_app_lock_list(void)
 391 {
 392 }
 393 static inline
 394 void ust_app_unlock_list(void)
 395 {
 396 }
 397 static inline
 398 void ust_app_clean_list(void)
 399 {
 400 }
 401 static inline
 402 struct ust_app_list *ust_app_get_list(void)
 403 {
 404         return NULL;
 405 }
 406 static inline
 407 struct ust_app *ust_app_get_by_pid(pid_t pid)
 408 {
 409         return NULL;
 410 }
 411 static inline
 412 void ust_app_ht_alloc(void)
 413 {}
 414 static inline
 415 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
 416 {}
 417 static inline
 418 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 419                 struct ltt_ust_channel *uchan)
 420 {
 421         return 0;
 422 }
 423 static inline
 424 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 425                 struct ltt_ust_channel *uchan)
 426 {
 427         return 0;
 428 }
 429 static inline
 430 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 431                 struct ltt_ust_channel *uchan)
 432 {
 433         return 0;
 434 }
 435 static inline
 436 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 437                 struct ltt_ust_channel *uchan)
 438 {
 439         return 0;
 440 }
 441 static inline
 442 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 443                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 444 {
 445         return 0;
 446 }
 447 static inline
 448 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 449                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 450 {
 451         return 0;
 452 }
 453 static inline
 454 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 455                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 456 {
 457         return 0;
 458 }
 459 static inline
 460 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 461                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 462 {
 463         return 0;
 464 }
 465 static inline
 466 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 467                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 468                 pid_t pid)
 469 {
 470         return 0;
 471 }
 472 static inline
 473 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
 474 {
 475         return 0;
 476 }
 477 static inline
 478 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
 479 {
 480         return 0;
 481 }
 482 static inline
 483 int ust_app_recv_notify(int sock)
 484 {
 485         return 0;
 486 }
 487 static inline
 488 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
 489 {
 490         return NULL;
 491 }
 492 static inline
 493 void ust_app_add(struct ust_app *app)
 494 {
 495 }
 496 static inline
 497 void ust_app_notify_sock_unregister(int sock)
 498 {
 499 }
 500 static inline
 501 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
 502                 struct consumer_socket *socket, int send_zero_data)
 503 {
 504         return 0;
 505 }
 506 static inline
 507 void ust_app_destroy(struct ust_app *app)
 508 {
 509         return;
 510 }
 511 static inline
 512 int ust_app_snapshot_record(struct ltt_ust_session *usess,
 513                 struct snapshot_output *output, int wait, uint64_t max_stream_size)
 514 {
 515         return 0;
 516 }
 517 static inline
 518 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
 519 {
 520         return 0;
 521 }
 522
 523 static inline
 524 int ust_app_supported(void)
 525 {
 526         return 0;
 527 }
 528 static inline
 529 struct ust_app *ust_app_find_by_sock(int sock)
 530 {
 531         return NULL;
 532 }
 533 static inline
 534 struct ust_app *ust_app_find_by_pid(pid_t pid)
 535 {
 536         return NULL;
 537 }
 538
 539 #endif /* HAVE_LIBLTTNG_UST_CTL */
 540
 541 #endif /* _LTT_UST_APP_H */