SoW-2020-0003: Trace Hit Counters

[lttng-tools.git] / include / lttng / kernel-function-internal.h

diff --git a/include/lttng/kernel-function-internal.h b/include/lttng/kernel-function-internal.h
new file mode 100644 (file)
index 0000000..f0b412a
--- /dev/null
+++ b/include/lttng/kernel-function-internal.h
@@ -0,0 +1,106 @@
+/*
+ * Copyright (C) 2021 Francis Deslauriers <francis.deslauriers@efficios.com>
+ *
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ */
+
+#ifndef LTTNG_KERNEL_FUNCTION_INTERNAL_H
+#define LTTNG_KERNEL_FUNCTION_INTERNAL_H
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <sys/types.h>
+
+#include <common/fd-handle.h>
+#include <common/macros.h>
+#include <lttng/kernel-function.h>
+
+struct lttng_payload;
+struct lttng_payload_view;
+struct lttng_dynamic_buffer;
+
+typedef bool (*kernel_function_location_equal_cb)(
+               const struct lttng_kernel_function_location *a,
+               const struct lttng_kernel_function_location *b);
+typedef int (*kernel_function_location_serialize_cb)(
+               const struct lttng_kernel_function_location *kernel_function_location,
+               struct lttng_payload *payload);
+typedef bool (*kernel_function_location_equal_cb)(
+               const struct lttng_kernel_function_location *a,
+               const struct lttng_kernel_function_location *b);
+typedef ssize_t (*kernel_function_location_create_from_payload_cb)(
+               struct lttng_payload_view *view,
+               struct lttng_kernel_function_location **kernel_function_location);
+typedef unsigned long (*kernel_function_location_hash_cb)(
+               const struct lttng_kernel_function_location *location);
+
+struct lttng_kernel_function_location_comm {
+       /* enum lttng_kernel_function_location_type */
+       int8_t type;
+       /*
+        * Payload is composed of, in that order,
+        *   - type-specific payload
+        */
+       char payload[];
+} LTTNG_PACKED;
+
+struct lttng_kernel_function_location_symbol_comm {
+       /* Includes the trailing \0. */
+       uint32_t symbol_len;
+       /* The offset from the symbol. */
+       uint64_t offset;
+       /*
+        * Payload is composed of, in that order,
+        *   - symbol name (with trailing \0).
+        */
+       char payload[];
+} LTTNG_PACKED;
+
+struct lttng_kernel_function_location_address_comm {
+       uint64_t address;
+} LTTNG_PACKED;
+
+/* Common ancestor of all kernel function locations. */
+struct lttng_kernel_function_location {
+       enum lttng_kernel_function_location_type type;
+       kernel_function_location_equal_cb equal;
+       kernel_function_location_serialize_cb serialize;
+       kernel_function_location_hash_cb hash;
+};
+
+struct lttng_kernel_function_location_symbol {
+       struct lttng_kernel_function_location parent;
+       char *symbol_name;
+       uint64_t offset;
+};
+
+struct lttng_kernel_function_location_address {
+       struct lttng_kernel_function_location parent;
+       uint64_t address;
+};
+
+LTTNG_HIDDEN
+int lttng_kernel_function_location_serialize(
+               const struct lttng_kernel_function_location *location,
+               struct lttng_payload *payload);
+
+LTTNG_HIDDEN
+ssize_t lttng_kernel_function_location_create_from_payload(
+               struct lttng_payload_view *view,
+               struct lttng_kernel_function_location **function_location);
+
+LTTNG_HIDDEN
+bool lttng_kernel_function_location_is_equal(
+               const struct lttng_kernel_function_location *a,
+               const struct lttng_kernel_function_location *b);
+
+LTTNG_HIDDEN
+struct lttng_kernel_function_location *lttng_kernel_function_location_copy(
+               const struct lttng_kernel_function_location *location);
+
+LTTNG_HIDDEN
+unsigned long lttng_kernel_function_location_hash(
+               const struct lttng_kernel_function_location *location);
+
+#endif /* LTTNG_KERNEL_FUNCTION_INTERNAL_H */