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