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