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