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

/*
 * Copyright (C) 2020 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_KERNEL_PROBE_INTERNAL_H
#define LTTNG_KERNEL_PROBE_INTERNAL_H

#include <common/fd-handle.h>
#include <common/macros.h>
#include <lttng/lttng-error.h>
#include <lttng/kernel-probe.h>
#include <lttng/lttng-error.h>
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>

#ifdef __cplusplus
extern "C" {
#endif

struct lttng_payload;
struct lttng_payload_view;
struct lttng_dynamic_buffer;
struct mi_writer;

typedef bool (*kernel_probe_location_equal_cb)(
		const struct lttng_kernel_probe_location *a,
		const struct lttng_kernel_probe_location *b);
typedef int (*kernel_probe_location_serialize_cb)(
		const struct lttng_kernel_probe_location *kernel_probe_location,
		struct lttng_payload *payload);
typedef bool (*kernel_probe_location_equal_cb)(
		const struct lttng_kernel_probe_location *a,
		const struct lttng_kernel_probe_location *b);
typedef ssize_t (*kernel_probe_location_create_from_payload_cb)(
		struct lttng_payload_view *view,
		struct lttng_kernel_probe_location **kernel_probe_location);
typedef unsigned long (*kernel_probe_location_hash_cb)(
		const struct lttng_kernel_probe_location *location);
typedef enum lttng_error_code (*kernel_probe_location_mi_serialize_cb)(
		const struct lttng_kernel_probe_location *location,
		struct mi_writer *writer);

struct lttng_kernel_probe_location_comm {
	/* enum lttng_kernel_probe_location_type */
	int8_t type;
	/*
	 * Payload is composed of, in that order,
	 *   - type-specific payload
	 */
	char payload[];
} LTTNG_PACKED;

struct lttng_kernel_probe_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_probe_location_address_comm {
	uint64_t address;
} LTTNG_PACKED;

/* Common ancestor of all kernel probe locations. */
struct lttng_kernel_probe_location {
	enum lttng_kernel_probe_location_type type;
	kernel_probe_location_equal_cb equal;
	kernel_probe_location_serialize_cb serialize;
	kernel_probe_location_hash_cb hash;
	kernel_probe_location_mi_serialize_cb mi_serialize;
};

struct lttng_kernel_probe_location_symbol {
	struct lttng_kernel_probe_location parent;
	char *symbol_name;
	uint64_t offset;
};

struct lttng_kernel_probe_location_address {
	struct lttng_kernel_probe_location parent;
	uint64_t address;
};

int lttng_kernel_probe_location_serialize(
		const struct lttng_kernel_probe_location *location,
		struct lttng_payload *payload);

ssize_t lttng_kernel_probe_location_create_from_payload(
		struct lttng_payload_view *view,
		struct lttng_kernel_probe_location **probe_location);

bool lttng_kernel_probe_location_is_equal(
		const struct lttng_kernel_probe_location *a,
		const struct lttng_kernel_probe_location *b);

struct lttng_kernel_probe_location *lttng_kernel_probe_location_copy(
		const struct lttng_kernel_probe_location *location);

unsigned long lttng_kernel_probe_location_hash(
		const struct lttng_kernel_probe_location *location);

enum lttng_error_code lttng_kernel_probe_location_mi_serialize(
		const struct lttng_kernel_probe_location *location,
		struct mi_writer *writer);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_KERNEL_PROBE_INTERNAL_H */
Commit	Line	Data
808cb744 JR	1	/*
	2	* Copyright (C) 2020 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_KERNEL_PROBE_INTERNAL_H
	9	#define LTTNG_KERNEL_PROBE_INTERNAL_H
	10
	11	#include <common/fd-handle.h>
	12	#include <common/macros.h>
488dbb60	13	#include <lttng/lttng-error.h>
808cb744	14	#include <lttng/kernel-probe.h>
740da7d5	15	#include <lttng/lttng-error.h>
808cb744 JR	16	#include <stdbool.h>
	17	#include <stdint.h>
	18	#include <sys/types.h>
	19
740da7d5 SM	20	#ifdef __cplusplus
	21	extern "C" {
	22	#endif
	23
808cb744 JR	24	struct lttng_payload;
	25	struct lttng_payload_view;
	26	struct lttng_dynamic_buffer;
6a751b95	27	struct mi_writer;
808cb744 JR	28
	29	typedef bool (*kernel_probe_location_equal_cb)(
	30	const struct lttng_kernel_probe_location *a,
	31	const struct lttng_kernel_probe_location *b);
	32	typedef int (*kernel_probe_location_serialize_cb)(
	33	const struct lttng_kernel_probe_location *kernel_probe_location,
	34	struct lttng_payload *payload);
	35	typedef bool (*kernel_probe_location_equal_cb)(
	36	const struct lttng_kernel_probe_location *a,
	37	const struct lttng_kernel_probe_location *b);
	38	typedef ssize_t (*kernel_probe_location_create_from_payload_cb)(
	39	struct lttng_payload_view *view,
	40	struct lttng_kernel_probe_location **kernel_probe_location);
959e3c66 JR	41	typedef unsigned long (*kernel_probe_location_hash_cb)(
959e3c66 JR	42	const struct lttng_kernel_probe_location *location);
6a751b95 JR	43	typedef enum lttng_error_code (*kernel_probe_location_mi_serialize_cb)(
	44	const struct lttng_kernel_probe_location *location,
	45	struct mi_writer *writer);
808cb744 JR	46
	47	struct lttng_kernel_probe_location_comm {
	48	/* enum lttng_kernel_probe_location_type */
	49	int8_t type;
	50	/*
	51	* Payload is composed of, in that order,
	52	* - type-specific payload
	53	*/
	54	char payload[];
	55	} LTTNG_PACKED;
	56
	57	struct lttng_kernel_probe_location_symbol_comm {
	58	/* Includes the trailing \0. */
	59	uint32_t symbol_len;
	60	/* The offset from the symbol. */
	61	uint64_t offset;
	62	/*
	63	* Payload is composed of, in that order,
	64	* - symbol name (with trailing \0).
	65	*/
	66	char payload[];
	67	} LTTNG_PACKED;
	68
	69	struct lttng_kernel_probe_location_address_comm {
	70	uint64_t address;
	71	} LTTNG_PACKED;
	72
	73	/* Common ancestor of all kernel probe locations. */
	74	struct lttng_kernel_probe_location {
	75	enum lttng_kernel_probe_location_type type;
	76	kernel_probe_location_equal_cb equal;
	77	kernel_probe_location_serialize_cb serialize;
959e3c66	78	kernel_probe_location_hash_cb hash;
6a751b95	79	kernel_probe_location_mi_serialize_cb mi_serialize;
808cb744 JR	80	};
	81
	82	struct lttng_kernel_probe_location_symbol {
	83	struct lttng_kernel_probe_location parent;
	84	char *symbol_name;
	85	uint64_t offset;
	86	};
	87
	88	struct lttng_kernel_probe_location_address {
	89	struct lttng_kernel_probe_location parent;
	90	uint64_t address;
	91	};
	92
808cb744 JR	93	int lttng_kernel_probe_location_serialize(
	94	const struct lttng_kernel_probe_location *location,
	95	struct lttng_payload *payload);
	96
808cb744 JR	97	ssize_t lttng_kernel_probe_location_create_from_payload(
	98	struct lttng_payload_view *view,
	99	struct lttng_kernel_probe_location **probe_location);
	100
808cb744 JR	101	bool lttng_kernel_probe_location_is_equal(
	102	const struct lttng_kernel_probe_location *a,
	103	const struct lttng_kernel_probe_location *b);
	104
077192fd JR	105	struct lttng_kernel_probe_location *lttng_kernel_probe_location_copy(
	106	const struct lttng_kernel_probe_location *location);
	107
959e3c66 JR	108	unsigned long lttng_kernel_probe_location_hash(
	109	const struct lttng_kernel_probe_location *location);
	110
6a751b95 JR	111	enum lttng_error_code lttng_kernel_probe_location_mi_serialize(
	112	const struct lttng_kernel_probe_location *location,
	113	struct mi_writer *writer);
	114
740da7d5 SM	115	#ifdef __cplusplus
	116	}
	117	#endif
	118
808cb744	119	#endif /* LTTNG_KERNEL_PROBE_INTERNAL_H */