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