include/lttng/lttng.h

   1 /*
   2  * lttng.h
   3  *
   4  * Linux Trace Toolkit Control Library Header File
   5  *
   6  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   7  *
   8  * This library is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License, version 2.1 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This library is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  15  * for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with this library; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef LTTNG_H
  23 #define LTTNG_H
  24
  25 #include <limits.h>
  26 /*
  27  * Necessary to include the fixed width type limits on glibc versions older
  28  * than 2.18 when building with a C++ compiler.
  29  */
  30 #ifndef __STDC_LIMIT_MACROS
  31 #define __STDC_LIMIT_MACROS
  32 #include <stdint.h>
  33 #undef __STDC_LIMIT_MACROS
  34 #else /* #ifndef __STDC_LIMIT_MACROS */
  35 #include <stdint.h>
  36 #endif /* #else #ifndef __STDC_LIMIT_MACROS */
  37 #include <sys/types.h>
  38
  39 /* Error codes that can be returned by API calls */
  40 #include <lttng/lttng-error.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /*
  47  * Event symbol length. Copied from LTTng kernel ABI.
  48  */
  49 #define LTTNG_SYMBOL_NAME_LEN             256
  50
  51 /*
  52  * Every lttng_event_* structure both apply to kernel event and user-space
  53  * event.
  54  */
  55
  56 /*
  57  * Domain types: the different possible tracers.
  58  */
  59 enum lttng_domain_type {
  60         LTTNG_DOMAIN_KERNEL                   = 1,      /* Linux Kernel tracer. */
  61         LTTNG_DOMAIN_UST                      = 2,      /* Global Userspace tracer. */
  62         LTTNG_DOMAIN_JUL                      = 3,      /* Java Util Logging. */
  63 };
  64
  65 /*
  66  * Instrumentation type of tracing event.
  67  */
  68 enum lttng_event_type {
  69         LTTNG_EVENT_ALL                       = -1,
  70         LTTNG_EVENT_TRACEPOINT                = 0,
  71         LTTNG_EVENT_PROBE                     = 1,
  72         LTTNG_EVENT_FUNCTION                  = 2,
  73         LTTNG_EVENT_FUNCTION_ENTRY            = 3,
  74         LTTNG_EVENT_NOOP                      = 4,
  75         LTTNG_EVENT_SYSCALL                   = 5,
  76 };
  77
  78 /*
  79  * Loglevel information.
  80  */
  81 enum lttng_loglevel_type {
  82         LTTNG_EVENT_LOGLEVEL_ALL              = 0,
  83         LTTNG_EVENT_LOGLEVEL_RANGE            = 1,
  84         LTTNG_EVENT_LOGLEVEL_SINGLE           = 2,
  85 };
  86
  87 /*
  88  * Available loglevels.
  89  */
  90 enum lttng_loglevel {
  91         LTTNG_LOGLEVEL_EMERG                  = 0,
  92         LTTNG_LOGLEVEL_ALERT                  = 1,
  93         LTTNG_LOGLEVEL_CRIT                   = 2,
  94         LTTNG_LOGLEVEL_ERR                    = 3,
  95         LTTNG_LOGLEVEL_WARNING                = 4,
  96         LTTNG_LOGLEVEL_NOTICE                 = 5,
  97         LTTNG_LOGLEVEL_INFO                   = 6,
  98         LTTNG_LOGLEVEL_DEBUG_SYSTEM           = 7,
  99         LTTNG_LOGLEVEL_DEBUG_PROGRAM          = 8,
 100         LTTNG_LOGLEVEL_DEBUG_PROCESS          = 9,
 101         LTTNG_LOGLEVEL_DEBUG_MODULE           = 10,
 102         LTTNG_LOGLEVEL_DEBUG_UNIT             = 11,
 103         LTTNG_LOGLEVEL_DEBUG_FUNCTION         = 12,
 104         LTTNG_LOGLEVEL_DEBUG_LINE             = 13,
 105         LTTNG_LOGLEVEL_DEBUG                  = 14,
 106 };
 107
 108 /*
 109  * Available loglevels for the JUL domain. Those are an exact map from the
 110  * class java.util.logging.Level.
 111  */
 112 enum lttng_loglevel_jul {
 113         LTTNG_LOGLEVEL_JUL_OFF                = INT32_MAX,
 114         LTTNG_LOGLEVEL_JUL_SEVERE             = 1000,
 115         LTTNG_LOGLEVEL_JUL_WARNING            = 900,
 116         LTTNG_LOGLEVEL_JUL_INFO               = 800,
 117         LTTNG_LOGLEVEL_JUL_CONFIG             = 700,
 118         LTTNG_LOGLEVEL_JUL_FINE               = 500,
 119         LTTNG_LOGLEVEL_JUL_FINER              = 400,
 120         LTTNG_LOGLEVEL_JUL_FINEST             = 300,
 121         LTTNG_LOGLEVEL_JUL_ALL                = INT32_MIN,
 122 };
 123
 124 /*
 125  * LTTng consumer mode
 126  */
 127 enum lttng_event_output {
 128         LTTNG_EVENT_SPLICE                    = 0,
 129         LTTNG_EVENT_MMAP                      = 1,
 130 };
 131
 132 /* Event context possible type */
 133 enum lttng_event_context_type {
 134         LTTNG_EVENT_CONTEXT_PID               = 0,
 135         LTTNG_EVENT_CONTEXT_PERF_COUNTER      = 1,
 136         LTTNG_EVENT_CONTEXT_PROCNAME          = 2,
 137         LTTNG_EVENT_CONTEXT_PRIO              = 3,
 138         LTTNG_EVENT_CONTEXT_NICE              = 4,
 139         LTTNG_EVENT_CONTEXT_VPID              = 5,
 140         LTTNG_EVENT_CONTEXT_TID               = 6,
 141         LTTNG_EVENT_CONTEXT_VTID              = 7,
 142         LTTNG_EVENT_CONTEXT_PPID              = 8,
 143         LTTNG_EVENT_CONTEXT_VPPID             = 9,
 144         LTTNG_EVENT_CONTEXT_PTHREAD_ID        = 10,
 145         LTTNG_EVENT_CONTEXT_HOSTNAME          = 11,
 146         LTTNG_EVENT_CONTEXT_IP                = 12,
 147 };
 148
 149 enum lttng_calibrate_type {
 150         LTTNG_CALIBRATE_FUNCTION              = 0,
 151 };
 152
 153 /* Health component for the health check function. */
 154 enum lttng_health_component {
 155         LTTNG_HEALTH_CMD,
 156         LTTNG_HEALTH_APP_MANAGE,
 157         LTTNG_HEALTH_APP_REG,
 158         LTTNG_HEALTH_KERNEL,
 159         LTTNG_HEALTH_CONSUMER,
 160         LTTNG_HEALTH_HT_CLEANUP,
 161         LTTNG_HEALTH_APP_MANAGE_NOTIFY,
 162         LTTNG_HEALTH_APP_REG_DISPATCH,
 163         LTTNG_HEALTH_ALL,
 164 };
 165
 166 /* Buffer type for a specific domain. */
 167 enum lttng_buffer_type {
 168         LTTNG_BUFFER_PER_PID,   /* Only supported by UST being the default. */
 169         LTTNG_BUFFER_PER_UID,   /* Only supported by UST. */
 170         LTTNG_BUFFER_GLOBAL,    /* Only supported by the Kernel. */
 171 };
 172
 173 /*
 174  * The structures should be initialized to zero before use.
 175  */
 176 #define LTTNG_DOMAIN_PADDING1              12
 177 #define LTTNG_DOMAIN_PADDING2              LTTNG_SYMBOL_NAME_LEN + 32
 178 struct lttng_domain {
 179         enum lttng_domain_type type;
 180         enum lttng_buffer_type buf_type;
 181         char padding[LTTNG_DOMAIN_PADDING1];
 182
 183         union {
 184                 pid_t pid;
 185                 char exec_name[NAME_MAX];
 186                 char padding[LTTNG_DOMAIN_PADDING2];
 187         } attr;
 188 };
 189
 190 /*
 191  * Perf counter attributes
 192  *
 193  * The structures should be initialized to zero before use.
 194  */
 195 #define LTTNG_PERF_EVENT_PADDING1          16
 196 struct lttng_event_perf_counter_ctx {
 197         uint32_t type;
 198         uint64_t config;
 199         char name[LTTNG_SYMBOL_NAME_LEN];
 200
 201         char padding[LTTNG_PERF_EVENT_PADDING1];
 202 };
 203
 204 /*
 205  * Event/channel context
 206  *
 207  * The structures should be initialized to zero before use.
 208  */
 209 #define LTTNG_EVENT_CONTEXT_PADDING1       16
 210 #define LTTNG_EVENT_CONTEXT_PADDING2       LTTNG_SYMBOL_NAME_LEN + 32
 211 struct lttng_event_context {
 212         enum lttng_event_context_type ctx;
 213         char padding[LTTNG_EVENT_CONTEXT_PADDING1];
 214
 215         union {
 216                 struct lttng_event_perf_counter_ctx perf_counter;
 217                 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
 218         } u;
 219 };
 220
 221 /*
 222  * Event probe.
 223  *
 224  * Either addr is used or symbol_name and offset.
 225  *
 226  * The structures should be initialized to zero before use.
 227  */
 228 #define LTTNG_EVENT_PROBE_PADDING1         16
 229 struct lttng_event_probe_attr {
 230         uint64_t addr;
 231
 232         uint64_t offset;
 233         char symbol_name[LTTNG_SYMBOL_NAME_LEN];
 234
 235         char padding[LTTNG_EVENT_PROBE_PADDING1];
 236 };
 237
 238 /*
 239  * Function tracer
 240  *
 241  * The structures should be initialized to zero before use.
 242  */
 243 #define LTTNG_EVENT_FUNCTION_PADDING1      16
 244 struct lttng_event_function_attr {
 245         char symbol_name[LTTNG_SYMBOL_NAME_LEN];
 246
 247         char padding[LTTNG_EVENT_FUNCTION_PADDING1];
 248 };
 249
 250 /*
 251  * Generic lttng event
 252  *
 253  * The structures should be initialized to zero before use.
 254  */
 255 #define LTTNG_EVENT_PADDING1               14
 256 #define LTTNG_EVENT_PADDING2               LTTNG_SYMBOL_NAME_LEN + 32
 257 struct lttng_event {
 258         enum lttng_event_type type;
 259         char name[LTTNG_SYMBOL_NAME_LEN];
 260
 261         enum lttng_loglevel_type loglevel_type;
 262         int loglevel;
 263
 264         int32_t enabled;        /* Does not apply: -1 */
 265         pid_t pid;
 266         unsigned char filter;   /* filter enabled ? */
 267         unsigned char exclusion; /* exclusions added ? */
 268
 269         char padding[LTTNG_EVENT_PADDING1];
 270
 271         /* Per event type configuration */
 272         union {
 273                 struct lttng_event_probe_attr probe;
 274                 struct lttng_event_function_attr ftrace;
 275
 276                 char padding[LTTNG_EVENT_PADDING2];
 277         } attr;
 278 };
 279
 280 enum lttng_event_field_type {
 281         LTTNG_EVENT_FIELD_OTHER                 = 0,
 282         LTTNG_EVENT_FIELD_INTEGER               = 1,
 283         LTTNG_EVENT_FIELD_ENUM                  = 2,
 284         LTTNG_EVENT_FIELD_FLOAT                 = 3,
 285         LTTNG_EVENT_FIELD_STRING                = 4,
 286 };
 287
 288 #define LTTNG_EVENT_FIELD_PADDING       LTTNG_SYMBOL_NAME_LEN + 32
 289 struct lttng_event_field {
 290         char field_name[LTTNG_SYMBOL_NAME_LEN];
 291         enum lttng_event_field_type type;
 292         char padding[LTTNG_EVENT_FIELD_PADDING];
 293         struct lttng_event event;
 294         int nowrite;
 295 };
 296
 297 /*
 298  * Tracer channel attributes. For both kernel and user-space.
 299  *
 300  * The structures should be initialized to zero before use.
 301  */
 302 #define LTTNG_CHANNEL_ATTR_PADDING1        LTTNG_SYMBOL_NAME_LEN + 12
 303 struct lttng_channel_attr {
 304         int overwrite;                      /* 1: overwrite, 0: discard */
 305         uint64_t subbuf_size;               /* bytes */
 306         uint64_t num_subbuf;                /* power of 2 */
 307         unsigned int switch_timer_interval; /* usec */
 308         unsigned int read_timer_interval;   /* usec */
 309         enum lttng_event_output output;     /* splice, mmap */
 310         /* LTTng 2.1 padding limit */
 311         uint64_t tracefile_size;            /* bytes */
 312         uint64_t tracefile_count;           /* number of tracefiles */
 313         /* LTTng 2.3 padding limit */
 314         unsigned int live_timer_interval;   /* usec */
 315
 316         char padding[LTTNG_CHANNEL_ATTR_PADDING1];
 317 };
 318
 319 /*
 320  * Channel information structure. For both kernel and user-space.
 321  *
 322  * The structures should be initialized to zero before use.
 323  */
 324 #define LTTNG_CHANNEL_PADDING1             16
 325 struct lttng_channel {
 326         char name[LTTNG_SYMBOL_NAME_LEN];
 327         uint32_t enabled;
 328         struct lttng_channel_attr attr;
 329
 330         char padding[LTTNG_CHANNEL_PADDING1];
 331 };
 332
 333 #define LTTNG_CALIBRATE_PADDING1           16
 334 struct lttng_calibrate {
 335         enum lttng_calibrate_type type;
 336
 337         char padding[LTTNG_CALIBRATE_PADDING1];
 338 };
 339
 340 /*
 341  * Basic session information.
 342  *
 343  * This is an 'output data' meaning that it only comes *from* the session
 344  * daemon *to* the lttng client. It's basically a 'human' representation of
 345  * tracing entities (here a session).
 346  *
 347  * The structures should be initialized to zero before use.
 348  */
 349 #define LTTNG_SESSION_PADDING1             12
 350 struct lttng_session {
 351         char name[NAME_MAX];
 352         /* The path where traces are written */
 353         char path[PATH_MAX];
 354         uint32_t enabled;       /* enabled/started: 1, disabled/stopped: 0 */
 355         uint32_t snapshot_mode;
 356         unsigned int live_timer_interval;       /* usec */
 357
 358         char padding[LTTNG_SESSION_PADDING1];
 359 };
 360
 361 /*
 362  * Handle used as a context for commands.
 363  *
 364  * The structures should be initialized to zero before use.
 365  */
 366 #define LTTNG_HANDLE_PADDING1              16
 367 struct lttng_handle {
 368         char session_name[NAME_MAX];
 369         struct lttng_domain domain;
 370
 371         char padding[LTTNG_HANDLE_PADDING1];
 372 };
 373
 374 /*
 375  * Public LTTng control API
 376  */
 377
 378 /*
 379  * Create a tracing session using a name and an optional URL.
 380  *
 381  * If _url_ is NULL, no consumer is created for the session. The name can't be
 382  * NULL here.
 383  *
 384  * Return 0 on success else a negative LTTng error code.
 385  */
 386 extern int lttng_create_session(const char *name, const char *url);
 387
 388 /*
 389  * Create a tracing session that will exclusively be used for snapshot meaning
 390  * the session will be in no output mode and every channel enabled for that
 391  * session will be set in overwrite mode and in mmap output since splice is not
 392  * supported.
 393  *
 394  * Name can't be NULL. If an url is given, it will be used to create a default
 395  * snapshot output using it as a destination. If NULL, no output will be
 396  * defined and an add-output call will be needed.
 397  *
 398  * Return 0 on success else a negative LTTng error code.
 399  */
 400 extern int lttng_create_session_snapshot(const char *name,
 401                 const char *snapshot_url);
 402
 403 /*
 404  * Create a session exclusively used for live reading.
 405  *
 406  * In this mode, the switch-timer parameter is forced for each UST channel, a
 407  * live-switch-timer is enabled for kernel channels, manually setting
 408  * switch-timer is forbidden. Synchronization beacons are sent to the relayd,
 409  * indexes are sent and metadata is checked for each packet.
 410  *
 411  * Name can't be NULL. If no URL is given, the default is to send the data to
 412  * net://127.0.0.1. The timer_interval is in usec and by default set to 1000000
 413  * (1 second).
 414  *
 415  * Return 0 on success else a negative LTTng error code.
 416  */
 417 extern int lttng_create_session_live(const char *name, const char *url,
 418                 unsigned int timer_interval);
 419
 420 /*
 421  * Create an handle used as a context for every request made to the library.
 422  *
 423  * This handle contains the session name and domain on which the command will
 424  * be executed. A domain is basically a tracer like the kernel or user space.
 425  *
 426  * Return an newly allocated handle that should be freed using
 427  * lttng_destroy_handle. On error, NULL is returned.
 428  */
 429 extern struct lttng_handle *lttng_create_handle(const char *session_name,
 430                 struct lttng_domain *domain);
 431
 432 /*
 433  * Destroy an handle that has been previously created with lttng_create_handle.
 434  *
 435  * It free the given pointer making it unusable.
 436  */
 437 extern void lttng_destroy_handle(struct lttng_handle *handle);
 438
 439 /*
 440  * Destroy a tracing session.
 441  *
 442  * The session will not be usable, tracing will be stopped thus buffers will be
 443  * flushed.
 444  *
 445  * The name can't be NULL here.
 446  *
 447  * Return 0 on success else a negative LTTng error code.
 448  */
 449 extern int lttng_destroy_session(const char *name);
 450
 451 /*
 452  * List all the tracing sessions.
 453  *
 454  * Return the size (number of entries) of the "lttng_session" array. Caller
 455  * must free sessions. On error, a negative LTTng error code is returned.
 456  */
 457 extern int lttng_list_sessions(struct lttng_session **sessions);
 458
 459 /*
 460  * List the registered domain(s) of a session.
 461  *
 462  * Session name CAN NOT be NULL.
 463  *
 464  * Return the size (number of entries) of the "lttng_domain" array. Caller
 465  * must free domains. On error, a negative LTTng error code is returned.
 466  */
 467 extern int lttng_list_domains(const char *session_name,
 468                 struct lttng_domain **domains);
 469
 470 /*
 471  * List the channel(s) of a session.
 472  *
 473  * The handle CAN NOT be NULL.
 474  *
 475  * Return the size (number of entries) of the "lttng_channel" array. Caller
 476  * must free channels. On error, a negative LTTng error code is returned.
 477  */
 478 extern int lttng_list_channels(struct lttng_handle *handle,
 479                 struct lttng_channel **channels);
 480
 481 /*
 482  * List the event(s) of a session channel.
 483  *
 484  * Both handle and channel_name CAN NOT be NULL.
 485  *
 486  * Return the size (number of entries) of the "lttng_event" array. Caller must
 487  * free events. On error a negative LTTng error code is returned.
 488  */
 489 extern int lttng_list_events(struct lttng_handle *handle,
 490                 const char *channel_name, struct lttng_event **events);
 491
 492 /*
 493  * List the available tracepoints of a specific lttng domain.
 494  *
 495  * The handle CAN NOT be NULL.
 496  *
 497  * Return the size (number of entries) of the "lttng_event" array.  Caller must
 498  * free events. On error a negative LTTng error code is returned.
 499  */
 500 extern int lttng_list_tracepoints(struct lttng_handle *handle,
 501                 struct lttng_event **events);
 502
 503 /*
 504  * List the available tracepoints fields of a specific lttng domain.
 505  *
 506  * The handle CAN NOT be NULL.
 507  *
 508  * Return the size (number of entries) of the "lttng_event_field" array.
 509  * Caller must free fields. On error a negative LTTng error code is
 510  * returned.
 511  */
 512 extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
 513                 struct lttng_event_field **fields);
 514
 515 /*
 516  * Check if a session daemon is alive.
 517  *
 518  * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
 519  * error code.
 520  */
 521 extern int lttng_session_daemon_alive(void);
 522
 523 /*
 524  * Set the tracing group for the *current* flow of execution.
 525  *
 526  * On success, returns 0 else a negative LTTng error code.
 527  */
 528 extern int lttng_set_tracing_group(const char *name);
 529
 530 /*
 531  * Return a human-readable error message for a LTTng error code.
 532  *
 533  * Parameter MUST be a negative value or else you'll get a generic message.
 534  */
 535 extern const char *lttng_strerror(int code);
 536
 537 /*
 538  * This call registers an "outside consumer" for a session and an lttng domain.
 539  * No consumer will be spawned and all fds/commands will go through the socket
 540  * path given (socket_path).
 541  *
 542  * NOTE that this is not recommended unless you absolutely know what you are
 543  * doing.
 544  *
 545  * Return 0 on success else a negative LTTng error code.
 546  */
 547 extern int lttng_register_consumer(struct lttng_handle *handle,
 548                 const char *socket_path);
 549
 550 /*
 551  * Start tracing for *all* domain(s) in the session.
 552  *
 553  * Return 0 on success else a negative LTTng error code.
 554  */
 555 extern int lttng_start_tracing(const char *session_name);
 556
 557 /*
 558  * Stop tracing for *all* domain(s) in the session.
 559  *
 560  * This call will wait for data availability for each domain of the session so
 561  * this can take an abritrary amount of time. However, when returning you have
 562  * the guarantee that the data is ready to be read and analyze. Use the
 563  * _no_wait call below to avoid this behavior.
 564  *
 565  * The session_name can't be NULL.
 566  *
 567  * Return 0 on success else a negative LTTng error code.
 568  */
 569 extern int lttng_stop_tracing(const char *session_name);
 570
 571 /*
 572  * Behave exactly like lttng_stop_tracing but does not wait for data
 573  * availability.
 574  */
 575 extern int lttng_stop_tracing_no_wait(const char *session_name);
 576
 577 /*
 578  * Add context to event(s) for a specific channel (or for all).
 579  *
 580  * If the channel_name is NULL and they are no channel for the domain, the
 581  * default channel is created (channel0). The context is then added on ALL
 582  * channels since no name was specified.
 583  *
 584  * The event_name is ignored since adding a context to an event is not possible
 585  * for now.
 586  *
 587  * Return 0 on success else a negative LTTng error code.
 588  */
 589 extern int lttng_add_context(struct lttng_handle *handle,
 590                 struct lttng_event_context *ctx, const char *event_name,
 591                 const char *channel_name);
 592
 593 /*
 594  * Create or enable an event (or events) for a channel.
 595  *
 596  * If the event you are trying to enable does not exist, it will be created,
 597  * else it is enabled. If channel_name is NULL, the default channel is used
 598  * (channel0).
 599  *
 600  * The handle and ev params can not be NULL.
 601  *
 602  * Return 0 on success else a negative LTTng error code.
 603  */
 604 extern int lttng_enable_event(struct lttng_handle *handle,
 605                 struct lttng_event *ev, const char *channel_name);
 606
 607 /*
 608  * Create or enable an event with a specific filter.
 609  *
 610  * If the event you are trying to enable does not exist, it will be created,
 611  * else it is enabled.
 612  * If ev is NULL, all events are enabled with that filter.
 613  * If channel_name is NULL, the default channel is used (channel0) and created
 614  * if not found.
 615  * If filter_expression is NULL, an event without associated filter is
 616  * created.
 617  *
 618  * Return 0 on success else a negative LTTng error code.
 619  */
 620 extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
 621                 struct lttng_event *event, const char *channel_name,
 622                 const char *filter_expression);
 623
 624 /*
 625  * Create or enable an event with a filter and/or exclusions.
 626  *
 627  * If the event you are trying to enable does not exist, it will be created,
 628  * else it is enabled.
 629  * If ev is NULL, all events are enabled with the filter and exclusion options.
 630  * If channel_name is NULL, the default channel is used (channel0) and created
 631  * if not found.
 632  * If filter_expression is NULL, an event without associated filter is
 633  * created.
 634  * If exclusion count is zero, the event will be created without exclusions.
 635  *
 636  * Return 0 on success else a negative LTTng error code.
 637  */
 638 extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
 639                 struct lttng_event *event, const char *channel_name,
 640                 const char *filter_expression,
 641                 int exclusion_count, char **exclusion_names);
 642
 643 /*
 644  * Create or enable a channel.
 645  *
 646  * The chan and handle params can not be NULL.
 647  *
 648  * Return 0 on success else a negative LTTng error code.
 649  */
 650 extern int lttng_enable_channel(struct lttng_handle *handle,
 651                 struct lttng_channel *chan);
 652
 653 /*
 654  * Disable event(s) of a channel and domain.
 655  *
 656  * If name is NULL, all events are disabled.
 657  * If channel_name is NULL, the default channel is used (channel0).
 658  *
 659  * Return 0 on success else a negative LTTng error code.
 660  */
 661 extern int lttng_disable_event(struct lttng_handle *handle,
 662                 const char *name, const char *channel_name);
 663
 664 /*
 665  * Disable channel.
 666  *
 667  * Name and handle CAN NOT be NULL.
 668  *
 669  * Return 0 on success else a negative LTTng error code.
 670  */
 671 extern int lttng_disable_channel(struct lttng_handle *handle,
 672                 const char *name);
 673
 674 /*
 675  * Calibrate LTTng overhead.
 676  *
 677  * The chan and handle params can not be NULL.
 678  *
 679  * Return 0 on success else a negative LTTng error code.
 680  */
 681 extern int lttng_calibrate(struct lttng_handle *handle,
 682                 struct lttng_calibrate *calibrate);
 683
 684 /*
 685  * Set the default channel attributes for a specific domain and an allocated
 686  * lttng_channel_attr pointer.
 687  *
 688  * If one or both arguments are NULL, nothing happens.
 689  */
 690 extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
 691                 struct lttng_channel_attr *attr);
 692
 693 /*
 694  * Set URL for a consumer for a session and domain.
 695  *
 696  * Both data and control URL must be defined. If both URLs are the same, only
 697  * the control URL is used even for network streaming.
 698  *
 699  * Default port are 5342 and 5343 respectively for control and data which uses
 700  * the TCP protocol.
 701  *
 702  * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
 703  *
 704  * Possible protocols are:
 705  * > file://...
 706  *   Local filesystem full path.
 707  *
 708  * > net[6]://...
 709  *   This will use the default network transport layer which is TCP for both
 710  *   control (PORT1) and data port (PORT2).
 711  *
 712  * > tcp[6]://...
 713  *   TCP only streaming. For this one, both data and control URL must be given.
 714  *
 715  * Return 0 on success else a negative LTTng error code.
 716  */
 717 extern int lttng_set_consumer_url(struct lttng_handle *handle,
 718                 const char *control_url, const char *data_url);
 719
 720 /*
 721  * Enable the consumer for a session and domain.
 722  */
 723 extern LTTNG_DEPRECATED("This call is now obsolete.")
 724 int lttng_enable_consumer(struct lttng_handle *handle);
 725
 726 /*
 727  * Disable consumer for a session and domain.
 728  */
 729 extern LTTNG_DEPRECATED("This call is now obsolete.")
 730 int lttng_disable_consumer(struct lttng_handle *handle);
 731
 732 /*
 733  * Check session daemon health for a specific component.
 734  *
 735  * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
 736  * the control library was not able to connect to the session daemon health
 737  * socket.
 738  *
 739  * Any other positive value is an lttcomm error which can be translate with
 740  * lttng_strerror().
 741  *
 742  * Please see lttng-health-check(3) man page for more information.
 743  */
 744 extern LTTNG_DEPRECATED("This call is now obsolete.")
 745 int lttng_health_check(enum lttng_health_component c);
 746
 747 /*
 748  * For a given session name, this call checks if the data is ready to be read
 749  * or is still being extracted by the consumer(s) (pending) hence not ready to
 750  * be used by any readers.
 751  *
 752  * Return 0 if there is _no_ data pending in the buffers thus having a
 753  * guarantee that the data can be read safely. Else, return 1 if there is still
 754  * traced data is pending. On error, a negative value is returned and readable
 755  * by lttng_strerror().
 756  */
 757 extern int lttng_data_pending(const char *session_name);
 758
 759 #ifdef __cplusplus
 760 }
 761 #endif
 762
 763 #endif /* LTTNG_H */