-#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
-#define _LTTNG_UST_EVENTS_INTERNAL_H
-
/*
- * ust-events-internal.h
- *
- * Copyright 2019 (c) - Francis Deslauriers <francis.deslauriers@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * SPDX-License-Identifier: MIT
*
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
*/
+#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
+#define _LTTNG_UST_EVENTS_INTERNAL_H
+
#include <stdint.h>
#include <urcu/list.h>
#include <urcu/hlist.h>
-#include <helper.h>
#include <lttng/ust-events.h>
+#include "ust-context-provider.h"
+
+struct lttng_ust_abi_obj;
+
+union lttng_ust_abi_args {
+ struct {
+ void *chan_data;
+ int wakeup_fd;
+ } channel;
+ struct {
+ int shm_fd;
+ int wakeup_fd;
+ } stream;
+ struct {
+ struct lttng_ust_abi_field_iter entry;
+ } field_list;
+ struct {
+ char *ctxname;
+ } app_context;
+ struct {
+ int event_notifier_notif_fd;
+ } event_notifier_handle;
+ struct {
+ void *counter_data;
+ } counter;
+ struct {
+ int shm_fd;
+ } counter_shm;
+};
+
+struct lttng_ust_abi_objd_ops {
+ long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
+ union lttng_ust_abi_args *args, void *owner);
+ int (*release)(int objd);
+};
+
+enum lttng_enabler_format_type {
+ LTTNG_ENABLER_FORMAT_STAR_GLOB,
+ LTTNG_ENABLER_FORMAT_EVENT,
+};
+
+/*
+ * Enabler field, within whatever object is enabling an event. Target of
+ * backward reference.
+ */
+struct lttng_enabler {
+ enum lttng_enabler_format_type format_type;
+
+ /* head list of struct lttng_ust_filter_bytecode_node */
+ struct cds_list_head filter_bytecode_head;
+ /* head list of struct lttng_ust_excluder_node */
+ struct cds_list_head excluder_head;
+
+ struct lttng_ust_abi_event event_param;
+ unsigned int enabled:1;
+};
+
struct lttng_event_enabler {
struct lttng_enabler base;
struct cds_list_head node; /* per-session list of enablers */
struct lttng_ctx *ctx;
};
+struct lttng_event_notifier_enabler {
+ struct lttng_enabler base;
+ uint64_t error_counter_index;
+ struct cds_list_head node; /* per-app list of event_notifier enablers */
+ struct cds_list_head capture_bytecode_head;
+ struct lttng_event_notifier_group *group; /* weak ref */
+ uint64_t user_token; /* User-provided token */
+ uint64_t num_captures;
+};
+
+enum lttng_ust_bytecode_node_type {
+ LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
+ LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
+};
+
+struct lttng_ust_bytecode_node {
+ enum lttng_ust_bytecode_node_type type;
+ struct cds_list_head node;
+ struct lttng_enabler *enabler;
+ struct {
+ uint32_t len;
+ uint32_t reloc_offset;
+ uint64_t seqnum;
+ char data[];
+ } bc;
+};
+
+struct lttng_ust_excluder_node {
+ struct cds_list_head node;
+ struct lttng_enabler *enabler;
+ /*
+ * struct lttng_ust_event_exclusion had variable sized array,
+ * must be last field.
+ */
+ struct lttng_ust_abi_event_exclusion excluder;
+};
+
+/* Data structures used by the tracer. */
+
+struct tp_list_entry {
+ struct lttng_ust_abi_tracepoint_iter tp;
+ struct cds_list_head head;
+};
+
+struct lttng_ust_tracepoint_list {
+ struct tp_list_entry *iter;
+ struct cds_list_head head;
+};
+
+struct tp_field_list_entry {
+ struct lttng_ust_abi_field_iter field;
+ struct cds_list_head head;
+};
+
+struct lttng_ust_field_list {
+ struct tp_field_list_entry *iter;
+ struct cds_list_head head;
+};
+
+/*
+ * Objects in a linked-list of enablers, owned by an event or event_notifier.
+ * This is used because an event (or a event_notifier) can be enabled by more
+ * than one enabler and we want a quick way to iterate over all enablers of an
+ * object.
+ *
+ * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
+ * event with the name "my_app:abc".
+ */
+struct lttng_enabler_ref {
+ struct cds_list_head node; /* enabler ref list */
+ struct lttng_enabler *ref; /* backward ref */
+};
+
+#define LTTNG_COUNTER_DIMENSION_MAX 8
+struct lttng_counter_dimension {
+ uint64_t size;
+ uint64_t underflow_index;
+ uint64_t overflow_index;
+ uint8_t has_underflow;
+ uint8_t has_overflow;
+};
+
+struct lttng_counter_ops {
+ struct lib_counter *(*counter_create)(size_t nr_dimensions,
+ const struct lttng_counter_dimension *dimensions,
+ int64_t global_sum_step,
+ int global_counter_fd,
+ int nr_counter_cpu_fds,
+ const int *counter_cpu_fds,
+ bool is_daemon);
+ void (*counter_destroy)(struct lib_counter *counter);
+ int (*counter_add)(struct lib_counter *counter,
+ const size_t *dimension_indexes, int64_t v);
+ int (*counter_read)(struct lib_counter *counter,
+ const size_t *dimension_indexes, int cpu,
+ int64_t *value, bool *overflow, bool *underflow);
+ int (*counter_aggregate)(struct lib_counter *counter,
+ const size_t *dimension_indexes, int64_t *value,
+ bool *overflow, bool *underflow);
+ int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
+};
+
+struct lttng_counter {
+ int objd;
+ struct lttng_event_notifier_group *event_notifier_group; /* owner */
+ struct lttng_counter_transport *transport;
+ struct lib_counter *counter;
+ struct lttng_counter_ops *ops;
+};
+
+#define LTTNG_UST_EVENT_HT_BITS 12
+#define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
+
+struct lttng_ust_event_ht {
+ struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
+};
+
+#define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
+#define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
+struct lttng_ust_event_notifier_ht {
+ struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE];
+};
+
+#define LTTNG_UST_ENUM_HT_BITS 12
+#define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
+
+struct lttng_ust_enum_ht {
+ struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
+};
+
+struct lttng_event_notifier_group {
+ int objd;
+ void *owner;
+ int notification_fd;
+ struct cds_list_head node; /* Event notifier group handle list */
+ struct cds_list_head enablers_head;
+ struct cds_list_head event_notifiers_head; /* list of event_notifiers */
+ struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
+ struct lttng_ctx *ctx; /* contexts for filters. */
+
+ struct lttng_counter *error_counter;
+ size_t error_counter_len;
+};
+
+struct lttng_transport {
+ char *name;
+ struct cds_list_head node;
+ struct lttng_ust_channel_ops ops;
+ const struct lttng_ust_lib_ring_buffer_config *client_config;
+};
+
+struct lttng_counter_transport {
+ char *name;
+ struct cds_list_head node;
+ struct lttng_counter_ops ops;
+ const struct lib_counter_config *client_config;
+};
+
+struct lttng_ust_event_common_private {
+ struct lttng_ust_event_common *pub; /* Public event interface */
+
+ const struct lttng_ust_event_desc *desc;
+ /* Backward references: list of lttng_enabler_ref (ref to enablers) */
+ struct cds_list_head enablers_ref_head;
+ int registered; /* has reg'd tracepoint probe */
+ uint64_t user_token;
+};
+
+struct lttng_ust_event_recorder_private {
+ struct lttng_ust_event_common_private parent;
+
+ struct lttng_ust_event_recorder *pub; /* Public event interface */
+ struct cds_list_head node; /* Event recorder list */
+ struct cds_hlist_node hlist; /* Hash table of event recorders */
+};
+
+struct lttng_ust_event_notifier_private {
+ struct lttng_ust_event_common_private parent;
+
+ struct lttng_ust_event_notifier *pub; /* Public event notifier interface */
+ struct lttng_event_notifier_group *group; /* weak ref */
+ size_t num_captures; /* Needed to allocate the msgpack array. */
+ uint64_t error_counter_index;
+ struct cds_list_head node; /* Event notifier list */
+ struct cds_hlist_node hlist; /* Hash table of event notifiers */
+};
+
+struct lttng_ust_bytecode_runtime_private {
+ struct bytecode_runtime *pub; /* Public bytecode runtime interface */
+
+ struct lttng_ust_bytecode_node *bc;
+ int link_failed;
+ /*
+ * Pointer to a URCU-protected pointer owned by an `struct
+ * lttng_session`or `struct lttng_event_notifier_group`.
+ */
+ struct lttng_ctx **pctx;
+};
+
+struct lttng_ust_session_private {
+ struct lttng_session *pub; /* Public session interface */
+
+ int been_active; /* Been active ? */
+ int objd; /* Object associated */
+ struct cds_list_head chan_head; /* Channel list head */
+ struct cds_list_head events_head; /* list of events */
+ struct cds_list_head node; /* Session list */
+
+ /* New UST 2.1 */
+ /* List of enablers */
+ struct cds_list_head enablers_head;
+ struct lttng_ust_event_ht events_ht; /* ht of events */
+ void *owner; /* object owner */
+ int tstate:1; /* Transient enable state */
+
+ /* New UST 2.4 */
+ int statedump_pending:1;
+
+ /* New UST 2.8 */
+ struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */
+ struct cds_list_head enums_head;
+ struct lttng_ctx *ctx; /* contexts for filters. */
+};
+
+struct lttng_enum {
+ const struct lttng_ust_enum_desc *desc;
+ struct lttng_session *session;
+ struct cds_list_head node; /* Enum list in session */
+ struct cds_hlist_node hlist; /* Session ht of enums */
+ uint64_t id; /* Enumeration ID in sessiond */
+};
+
static inline
struct lttng_enabler *lttng_event_enabler_as_enabler(
struct lttng_event_enabler *event_enabler)
return &event_enabler->base;
}
+static inline
+struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
+ struct lttng_event_notifier_enabler *event_notifier_enabler)
+{
+ return &event_notifier_enabler->base;
+}
/*
* Allocate and initialize a `struct lttng_event_enabler` object.
* On success, returns a `struct lttng_event_enabler`,
* On memory error, returns NULL.
*/
-LTTNG_HIDDEN
+__attribute__((visibility("hidden")))
struct lttng_event_enabler *lttng_event_enabler_create(
enum lttng_enabler_format_type format_type,
- struct lttng_ust_event *event_param,
+ struct lttng_ust_abi_event *event_param,
struct lttng_channel *chan);
/*
* Destroy a `struct lttng_event_enabler` object.
*/
-LTTNG_HIDDEN
+__attribute__((visibility("hidden")))
void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
/*
* Enable a `struct lttng_event_enabler` object and all events related to this
* enabler.
*/
-LTTNG_HIDDEN
+__attribute__((visibility("hidden")))
int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
/*
* Disable a `struct lttng_event_enabler` object and all events related to this
* enabler.
*/
-LTTNG_HIDDEN
+__attribute__((visibility("hidden")))
int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
/*
* Attach filter bytecode program to `struct lttng_event_enabler` and all
* events related to this enabler.
*/
-LTTNG_HIDDEN
-int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler *enabler,
- struct lttng_ust_filter_bytecode_node *bytecode);
+__attribute__((visibility("hidden")))
+int lttng_event_enabler_attach_filter_bytecode(
+ struct lttng_event_enabler *enabler,
+ struct lttng_ust_bytecode_node **bytecode);
/*
* Attach an application context to an event enabler.
*
* Not implemented.
*/
-LTTNG_HIDDEN
+__attribute__((visibility("hidden")))
int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
- struct lttng_ust_context *ctx);
+ struct lttng_ust_abi_context *ctx);
/*
* Attach exclusion list to `struct lttng_event_enabler` and all
* events related to this enabler.
*/
-LTTNG_HIDDEN
+__attribute__((visibility("hidden")))
int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
- struct lttng_ust_excluder_node *excluder);
+ struct lttng_ust_excluder_node **excluder);
+
+/*
+ * Synchronize bytecodes for the enabler and the instance (event or
+ * event_notifier).
+ *
+ * This function goes over all bytecode programs of the enabler (event or
+ * event_notifier enabler) to ensure each is linked to the provided instance.
+ */
+__attribute__((visibility("hidden")))
+void lttng_enabler_link_bytecode(const struct lttng_ust_event_desc *event_desc,
+ struct lttng_ctx **ctx,
+ struct cds_list_head *instance_bytecode_runtime_head,
+ struct cds_list_head *enabler_bytecode_runtime_head);
/*
- * Synchronize bytecodes for the enabler and the event.
+ * Allocate and initialize a `struct lttng_event_notifier_group` object.
*
- * This function goes over all bytecode programs of the event enabler to ensure
- * each is linked to the provided event.
+ * On success, returns a `struct lttng_triggre_group`,
+ * on memory error, returns NULL.
+ */
+__attribute__((visibility("hidden")))
+struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
+
+/*
+ * Destroy a `struct lttng_event_notifier_group` object.
*/
-LTTNG_HIDDEN
-void lttng_event_enabler_link_bytecode(struct lttng_event *event,
- struct lttng_event_enabler *enabler);
+__attribute__((visibility("hidden")))
+void lttng_event_notifier_group_destroy(
+ struct lttng_event_notifier_group *event_notifier_group);
+
+/*
+ * Allocate and initialize a `struct lttng_event_notifier_enabler` object.
+ *
+ * On success, returns a `struct lttng_event_notifier_enabler`,
+ * On memory error, returns NULL.
+ */
+__attribute__((visibility("hidden")))
+struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
+ struct lttng_event_notifier_group *event_notifier_group,
+ enum lttng_enabler_format_type format_type,
+ struct lttng_ust_abi_event_notifier *event_notifier_param);
+
+/*
+ * Destroy a `struct lttng_event_notifier_enabler` object.
+ */
+__attribute__((visibility("hidden")))
+void lttng_event_notifier_enabler_destroy(
+ struct lttng_event_notifier_enabler *event_notifier_enabler);
+
+/*
+ * Enable a `struct lttng_event_notifier_enabler` object and all event
+ * notifiers related to this enabler.
+ */
+__attribute__((visibility("hidden")))
+int lttng_event_notifier_enabler_enable(
+ struct lttng_event_notifier_enabler *event_notifier_enabler);
+
+/*
+ * Disable a `struct lttng_event_notifier_enabler` object and all event
+ * notifiers related to this enabler.
+ */
+__attribute__((visibility("hidden")))
+int lttng_event_notifier_enabler_disable(
+ struct lttng_event_notifier_enabler *event_notifier_enabler);
+
+/*
+ * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
+ * all event notifiers related to this enabler.
+ */
+__attribute__((visibility("hidden")))
+int lttng_event_notifier_enabler_attach_filter_bytecode(
+ struct lttng_event_notifier_enabler *event_notifier_enabler,
+ struct lttng_ust_bytecode_node **bytecode);
+
+/*
+ * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
+ * all event_notifiers related to this enabler.
+ */
+__attribute__((visibility("hidden")))
+int lttng_event_notifier_enabler_attach_capture_bytecode(
+ struct lttng_event_notifier_enabler *event_notifier_enabler,
+ struct lttng_ust_bytecode_node **bytecode);
+
+/*
+ * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
+ * event notifiers related to this enabler.
+ */
+__attribute__((visibility("hidden")))
+int lttng_event_notifier_enabler_attach_exclusion(
+ struct lttng_event_notifier_enabler *event_notifier_enabler,
+ struct lttng_ust_excluder_node **excluder);
+
+__attribute__((visibility("hidden")))
+void lttng_free_event_filter_runtime(struct lttng_ust_event_common *event);
+
+/*
+ * Connect the probe on all enablers matching this event description.
+ * Called on library load.
+ */
+__attribute__((visibility("hidden")))
+int lttng_fix_pending_event_notifiers(void);
+
+__attribute__((visibility("hidden")))
+struct lttng_counter *lttng_ust_counter_create(
+ const char *counter_transport_name,
+ size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
+
+#ifdef HAVE_PERF_EVENT
+
+__attribute__((visibility("hidden")))
+int lttng_add_perf_counter_to_ctx(uint32_t type,
+ uint64_t config,
+ const char *name,
+ struct lttng_ctx **ctx);
+
+__attribute__((visibility("hidden")))
+int lttng_perf_counter_init(void);
+
+__attribute__((visibility("hidden")))
+void lttng_perf_counter_exit(void);
+
+#else /* #ifdef HAVE_PERF_EVENT */
+
+static inline
+int lttng_add_perf_counter_to_ctx(uint32_t type,
+ uint64_t config,
+ const char *name,
+ struct lttng_ctx **ctx)
+{
+ return -ENOSYS;
+}
+static inline
+int lttng_perf_counter_init(void)
+{
+ return 0;
+}
+static inline
+void lttng_perf_counter_exit(void)
+{
+}
+#endif /* #else #ifdef HAVE_PERF_EVENT */
+
+__attribute__((visibility("hidden")))
+int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
+
+__attribute__((visibility("hidden")))
+void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
+
+__attribute__((visibility("hidden")))
+int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
+
+__attribute__((visibility("hidden")))
+void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
+
+__attribute__((visibility("hidden")))
+struct lttng_ust_abi_tracepoint_iter *
+ lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
+
+__attribute__((visibility("hidden")))
+struct lttng_ust_abi_field_iter *
+ lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
+
+__attribute__((visibility("hidden")))
+struct lttng_session *lttng_session_create(void);
+
+__attribute__((visibility("hidden")))
+int lttng_session_enable(struct lttng_session *session);
+
+__attribute__((visibility("hidden")))
+int lttng_session_disable(struct lttng_session *session);
+
+__attribute__((visibility("hidden")))
+int lttng_session_statedump(struct lttng_session *session);
+
+__attribute__((visibility("hidden")))
+void lttng_session_destroy(struct lttng_session *session);
+
+/*
+ * Called with ust lock held.
+ */
+__attribute__((visibility("hidden")))
+int lttng_session_active(void);
+
+__attribute__((visibility("hidden")))
+struct cds_list_head *lttng_get_sessions(void);
+
+__attribute__((visibility("hidden")))
+void lttng_handle_pending_statedump(void *owner);
+
+__attribute__((visibility("hidden")))
+struct lttng_channel *lttng_channel_create(struct lttng_session *session,
+ const char *transport_name,
+ void *buf_addr,
+ size_t subbuf_size, size_t num_subbuf,
+ unsigned int switch_timer_interval,
+ unsigned int read_timer_interval,
+ int **shm_fd, int **wait_fd,
+ uint64_t **memory_map_size,
+ struct lttng_channel *chan_priv_init);
+
+__attribute__((visibility("hidden")))
+int lttng_channel_enable(struct lttng_channel *channel);
+
+__attribute__((visibility("hidden")))
+int lttng_channel_disable(struct lttng_channel *channel);
+
+__attribute__((visibility("hidden")))
+void lttng_transport_register(struct lttng_transport *transport);
+
+__attribute__((visibility("hidden")))
+void lttng_transport_unregister(struct lttng_transport *transport);
+
+/* This is ABI between liblttng-ust and liblttng-ust-ctl */
+struct lttng_transport *lttng_ust_transport_find(const char *name);
+
+/* This is ABI between liblttng-ust and liblttng-ust-dl */
+void lttng_ust_dl_update(void *ip);
+
+__attribute__((visibility("hidden")))
+void lttng_probe_provider_unregister_events(struct lttng_ust_probe_desc *desc);
+
+__attribute__((visibility("hidden")))
+int lttng_fix_pending_events(void);
+
+__attribute__((visibility("hidden")))
+struct cds_list_head *lttng_get_probe_list_head(void);
+
+__attribute__((visibility("hidden")))
+struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
+ const struct lttng_ust_enum_desc *enum_desc);
+
+__attribute__((visibility("hidden")))
+int lttng_abi_create_root_handle(void);
+
+__attribute__((visibility("hidden")))
+const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id);
+
+__attribute__((visibility("hidden")))
+int lttng_ust_abi_objd_unref(int id, int is_owner);
+
+__attribute__((visibility("hidden")))
+void lttng_ust_abi_exit(void);
+
+__attribute__((visibility("hidden")))
+void lttng_ust_abi_events_exit(void);
+
+__attribute__((visibility("hidden")))
+void lttng_ust_abi_objd_table_owner_cleanup(void *owner);
#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
projects / lttng-ust.git / blobdiff