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