event.h

/*
 * SPDX-FileCopyrightText: 2014 David Goulet <dgoulet@efficios.com>
 * SPDX-FileCopyrightText: 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_EVENT_H
#define LTTNG_EVENT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <lttng/handle.h>
#include <lttng/lttng-export.h>
#include <lttng/userspace-probe.h>
 
enum lttng_event_type {
    LTTNG_EVENT_ALL = -1,
 
    LTTNG_EVENT_TRACEPOINT = 0,
 
    LTTNG_EVENT_PROBE = 1,
 
    LTTNG_EVENT_FUNCTION = 2,
 
    LTTNG_EVENT_FUNCTION_ENTRY = 3,
    LTTNG_EVENT_NOOP = 4,
 
    LTTNG_EVENT_SYSCALL = 5,
 
    LTTNG_EVENT_USERSPACE_PROBE = 6,
};
 
enum lttng_loglevel_type {
    LTTNG_EVENT_LOGLEVEL_ALL = 0,
 
    LTTNG_EVENT_LOGLEVEL_RANGE = 1,
 
    LTTNG_EVENT_LOGLEVEL_SINGLE = 2,
};
 
enum lttng_loglevel {
    LTTNG_LOGLEVEL_EMERG = 0,
 
    LTTNG_LOGLEVEL_ALERT = 1,
 
    LTTNG_LOGLEVEL_CRIT = 2,
 
    LTTNG_LOGLEVEL_ERR = 3,
 
    LTTNG_LOGLEVEL_WARNING = 4,
 
    LTTNG_LOGLEVEL_NOTICE = 5,
 
    LTTNG_LOGLEVEL_INFO = 6,
 
    LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7,
 
    LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8,
 
    LTTNG_LOGLEVEL_DEBUG_PROCESS = 9,
 
    LTTNG_LOGLEVEL_DEBUG_MODULE = 10,
 
    LTTNG_LOGLEVEL_DEBUG_UNIT = 11,
 
    LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12,
 
    LTTNG_LOGLEVEL_DEBUG_LINE = 13,
 
    LTTNG_LOGLEVEL_DEBUG = 14,
};
 
enum lttng_loglevel_jul {
    LTTNG_LOGLEVEL_JUL_OFF = INT32_MAX,
 
    LTTNG_LOGLEVEL_JUL_SEVERE = 1000,
 
    LTTNG_LOGLEVEL_JUL_WARNING = 900,
 
    LTTNG_LOGLEVEL_JUL_INFO = 800,
 
    LTTNG_LOGLEVEL_JUL_CONFIG = 700,
 
    LTTNG_LOGLEVEL_JUL_FINE = 500,
 
    LTTNG_LOGLEVEL_JUL_FINER = 400,
 
    LTTNG_LOGLEVEL_JUL_FINEST = 300,
 
    LTTNG_LOGLEVEL_JUL_ALL = INT32_MIN,
};
 
enum lttng_loglevel_log4j {
    LTTNG_LOGLEVEL_LOG4J_OFF = INT32_MAX,
 
    LTTNG_LOGLEVEL_LOG4J_FATAL = 50000,
 
    LTTNG_LOGLEVEL_LOG4J_ERROR = 40000,
 
    LTTNG_LOGLEVEL_LOG4J_WARN = 30000,
 
    LTTNG_LOGLEVEL_LOG4J_INFO = 20000,
 
    LTTNG_LOGLEVEL_LOG4J_DEBUG = 10000,
 
    LTTNG_LOGLEVEL_LOG4J_TRACE = 5000,
 
    LTTNG_LOGLEVEL_LOG4J_ALL = INT32_MIN,
};
 
enum lttng_loglevel_log4j2 {
    LTTNG_LOGLEVEL_LOG4J2_OFF = 0,
 
    LTTNG_LOGLEVEL_LOG4J2_FATAL = 100,
 
    LTTNG_LOGLEVEL_LOG4J2_ERROR = 200,
 
    LTTNG_LOGLEVEL_LOG4J2_WARN = 300,
 
    LTTNG_LOGLEVEL_LOG4J2_INFO = 400,
 
    LTTNG_LOGLEVEL_LOG4J2_DEBUG = 500,
 
    LTTNG_LOGLEVEL_LOG4J2_TRACE = 600,
 
    LTTNG_LOGLEVEL_LOG4J2_ALL = INT32_MAX,
};
 
enum lttng_loglevel_python {
    LTTNG_LOGLEVEL_PYTHON_CRITICAL = 50,
 
    LTTNG_LOGLEVEL_PYTHON_ERROR = 40,
 
    LTTNG_LOGLEVEL_PYTHON_WARNING = 30,
 
    LTTNG_LOGLEVEL_PYTHON_INFO = 20,
 
    LTTNG_LOGLEVEL_PYTHON_DEBUG = 10,
 
    LTTNG_LOGLEVEL_PYTHON_NOTSET = 0,
};
 
enum lttng_event_output {
    LTTNG_EVENT_SPLICE = 0,
 
    LTTNG_EVENT_MMAP = 1,
};
 
enum lttng_event_context_type {
    LTTNG_EVENT_CONTEXT_PID = 0,
 
    LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, /* Backward compat. */
 
    LTTNG_EVENT_CONTEXT_PROCNAME = 2,
 
    LTTNG_EVENT_CONTEXT_PRIO = 3,
 
    LTTNG_EVENT_CONTEXT_NICE = 4,
 
    LTTNG_EVENT_CONTEXT_VPID = 5,
 
    LTTNG_EVENT_CONTEXT_TID = 6,
 
    LTTNG_EVENT_CONTEXT_VTID = 7,
 
    LTTNG_EVENT_CONTEXT_PPID = 8,
 
    LTTNG_EVENT_CONTEXT_VPPID = 9,
 
    LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
 
    LTTNG_EVENT_CONTEXT_HOSTNAME = 11,
 
    LTTNG_EVENT_CONTEXT_IP = 12,
 
    LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER = 13,
 
    LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14,
 
    LTTNG_EVENT_CONTEXT_APP_CONTEXT = 15,
 
    LTTNG_EVENT_CONTEXT_INTERRUPTIBLE = 16,
 
    LTTNG_EVENT_CONTEXT_PREEMPTIBLE = 17,
 
    LTTNG_EVENT_CONTEXT_NEED_RESCHEDULE = 18,
 
    LTTNG_EVENT_CONTEXT_MIGRATABLE = 19,
 
    LTTNG_EVENT_CONTEXT_CALLSTACK_KERNEL = 20,
 
    LTTNG_EVENT_CONTEXT_CALLSTACK_USER = 21,
 
    LTTNG_EVENT_CONTEXT_CGROUP_NS = 22,
 
    LTTNG_EVENT_CONTEXT_IPC_NS = 23,
 
    LTTNG_EVENT_CONTEXT_MNT_NS = 24,
 
    LTTNG_EVENT_CONTEXT_NET_NS = 25,
 
    LTTNG_EVENT_CONTEXT_PID_NS = 26,
 
    LTTNG_EVENT_CONTEXT_USER_NS = 27,
 
    LTTNG_EVENT_CONTEXT_UTS_NS = 28,
 
    LTTNG_EVENT_CONTEXT_UID = 29,
 
    LTTNG_EVENT_CONTEXT_EUID = 30,
 
    LTTNG_EVENT_CONTEXT_SUID = 31,
 
    LTTNG_EVENT_CONTEXT_GID = 32,
 
    LTTNG_EVENT_CONTEXT_EGID = 33,
 
    LTTNG_EVENT_CONTEXT_SGID = 34,
 
    LTTNG_EVENT_CONTEXT_VUID = 35,
 
    LTTNG_EVENT_CONTEXT_VEUID = 36,
 
    LTTNG_EVENT_CONTEXT_VSUID = 37,
 
    LTTNG_EVENT_CONTEXT_VGID = 38,
 
    LTTNG_EVENT_CONTEXT_VEGID = 39,
 
    LTTNG_EVENT_CONTEXT_VSGID = 40,
 
    LTTNG_EVENT_CONTEXT_TIME_NS = 41,
 
    LTTNG_EVENT_CONTEXT_CPU_ID = 42,
};
 
enum lttng_event_field_type {
    LTTNG_EVENT_FIELD_OTHER = 0,
 
    LTTNG_EVENT_FIELD_INTEGER = 1,
 
    LTTNG_EVENT_FIELD_ENUM = 2,
 
    LTTNG_EVENT_FIELD_FLOAT = 3,
 
    LTTNG_EVENT_FIELD_STRING = 4,
};
 
enum lttng_event_flag {
    LTTNG_EVENT_FLAG_SYSCALL_32 = (1U << 0),
 
    LTTNG_EVENT_FLAG_SYSCALL_64 = (1U << 1),
};
 
#define LTTNG_PERF_EVENT_PADDING1 16
 
struct lttng_event_perf_counter_ctx {
    uint32_t type;
 
    uint64_t config;
 
    char name[LTTNG_SYMBOL_NAME_LEN];
 
    char padding[LTTNG_PERF_EVENT_PADDING1];
};
 
#define LTTNG_EVENT_CONTEXT_PADDING1 16
#define LTTNG_EVENT_CONTEXT_PADDING2 (LTTNG_SYMBOL_NAME_LEN + 32)
 
union lttng_event_context_u {
    struct lttng_event_perf_counter_ctx perf_counter;
 
    struct {
        char *provider_name;
 
        char *ctx_name;
    }
 
    app_ctx;
 
    char padding[LTTNG_EVENT_CONTEXT_PADDING2];
};
 
struct lttng_event_context {
    enum lttng_event_context_type ctx;
 
    char padding[LTTNG_EVENT_CONTEXT_PADDING1];
 
    union lttng_event_context_u u;
};
 
#define LTTNG_EVENT_PROBE_PADDING1 16
 
struct lttng_event_probe_attr {
    uint64_t addr;
 
    uint64_t offset;
 
    char symbol_name[LTTNG_SYMBOL_NAME_LEN];
 
    char padding[LTTNG_EVENT_PROBE_PADDING1];
};
 
/*
 * Function tracer
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_EVENT_FUNCTION_PADDING1 16
struct lttng_event_function_attr {
    char symbol_name[LTTNG_SYMBOL_NAME_LEN];
 
    char padding[LTTNG_EVENT_FUNCTION_PADDING1];
};
 
/*
 * Generic lttng event
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_EVENT_PADDING1 12
#define LTTNG_EVENT_PADDING2 (LTTNG_SYMBOL_NAME_LEN + 32)
 
union lttng_event_attr_u {
    struct lttng_event_probe_attr probe;
 
    struct lttng_event_function_attr ftrace;
 
    char padding[LTTNG_EVENT_PADDING2];
};
 
/* clang-format off */
struct lttng_event {
    /* Offset 0 */
    enum lttng_event_type type;
 
    /* Offset 4 */
    char name[LTTNG_SYMBOL_NAME_LEN];
 
    /* Offset 260 */
    enum lttng_loglevel_type loglevel_type;
 
    /* Offset 264 */
    int loglevel;
 
    /* Offset 268 */
    int32_t enabled; /* Does not apply: -1 */
 
    /* Offset 272 */
    pid_t pid;
 
    /* Offset 276 */
    unsigned char filter;
 
    /* Offset 277 */
    unsigned char exclusion;
 
    /* Offset 278 */
    char padding2[2];
 
    /* Offset 280 */
    enum lttng_event_flag flags;
 
    /* Offset 284 */
    char padding[4];
 
    /* Offset 288 */
    union {
        uint64_t padding;
        void *ptr;
    } extended;
 
    /* Offset 296 */
    union lttng_event_attr_u attr;
};
/* clang-format on */
 
#define LTTNG_EVENT_FIELD_PADDING (LTTNG_SYMBOL_NAME_LEN + 32)
 
struct lttng_event_field {
    char field_name[LTTNG_SYMBOL_NAME_LEN];
 
    enum lttng_event_field_type type;
 
    char padding[LTTNG_EVENT_FIELD_PADDING];
 
    struct lttng_event event;
 
    int nowrite;
};
 
LTTNG_EXPORT extern int lttng_list_events(const struct lttng_handle *handle,
                      const char *channel_name,
                      struct lttng_event **event_rules);
 
LTTNG_EXPORT extern struct lttng_event *lttng_event_create(void);
 
LTTNG_EXPORT extern void lttng_event_destroy(struct lttng_event *event_rule);
 
LTTNG_EXPORT extern int lttng_event_get_filter_expression(const struct lttng_event *event_rule,
                              const char **filter_expr);
 
LTTNG_EXPORT extern int lttng_event_get_exclusion_name_count(const struct lttng_event *event_rule);
 
LTTNG_EXPORT extern int lttng_event_get_exclusion_name(const struct lttng_event *event_rule,
                               size_t index,
                               const char **event_name_exclusion);
 
LTTNG_EXPORT extern const struct lttng_userspace_probe_location *
lttng_event_get_userspace_probe_location(const struct lttng_event *event_rule);
 
LTTNG_EXPORT extern int
lttng_event_set_userspace_probe_location(struct lttng_event *event_rule,
                     struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern int lttng_list_tracepoints(struct lttng_handle *handle,
                           struct lttng_event **descrs);
 
LTTNG_EXPORT extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
                             struct lttng_event_field **fields);
 
LTTNG_EXPORT extern int lttng_list_syscalls(struct lttng_event **descrs);
 
LTTNG_EXPORT extern int lttng_add_context(struct lttng_handle *handle,
                      struct lttng_event_context *context_field_descriptor,
                      const char *event_name,
                      const char *channel_name);
 
/* clang-format off */
/* clang-format on */
LTTNG_EXPORT extern int lttng_enable_event(struct lttng_handle *handle,
                       struct lttng_event *event_rule,
                       const char *channel_name);
 
/* clang-format off */
/* clang-format on */
LTTNG_EXPORT extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
                               struct lttng_event *event_rule,
                               const char *channel_name,
                               const char *filter_expr);
 
LTTNG_EXPORT extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
                               struct lttng_event *event_rule,
                               const char *channel_name,
                               const char *filter_expr,
                               int event_name_exclusion_count,
                               char **event_name_exclusions);
 
/* clang-format off */
/* clang-format on */
LTTNG_EXPORT extern int lttng_disable_event(struct lttng_handle *handle,
                        const char *event_rule_name,
                        const char *channel_name);
 
LTTNG_EXPORT extern int lttng_disable_event_ext(struct lttng_handle *handle,
                        struct lttng_event *event_rule,
                        const char *channel_name,
                        const char *filter_expr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_EVENT_H */