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