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