[lttng-tools.git] / include / lttng / userspace-probe.h

/*
 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, version 2.1 only,
 * as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef LTTNG_USERSPACE_PROBE_H
#define LTTNG_USERSPACE_PROBE_H

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Userspace probe lookup methods specifies how the userspace probe location
 * specified by the user should be interpreted.
 */
struct lttng_userspace_probe_location_lookup_method;

enum lttng_userspace_probe_location_lookup_method_type {
	LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_UNKNOWN	    = -1,
	LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT  = 0,
	LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF	    = 1,
};

/*
 * Get the type of a lookup method.
 */
extern enum lttng_userspace_probe_location_lookup_method_type
lttng_userspace_probe_location_lookup_method_get_type(
		const struct lttng_userspace_probe_location_lookup_method *lookup_method);

/*
 * Destroy a lookup method.
 */
extern void lttng_userspace_probe_location_lookup_method_destroy(
		struct lttng_userspace_probe_location_lookup_method *lookup_method);

/*
 * Create a tracepoint ELF function lookup method struct.
 * Return NULL on failure.
 */
extern struct lttng_userspace_probe_location_lookup_method *
lttng_userspace_probe_location_lookup_method_function_elf_create(void);


/*
 * Contains all the information needed to compute the instrumentation point in
 * the binary. It is used in conjonction with a lookup method.
 */
struct lttng_userspace_probe_location;

enum lttng_userspace_probe_location_type {
	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN	= -1,
	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION	= 0,
};

/*
 * Get the type of the userspace probe location.
 */
extern enum lttng_userspace_probe_location_type
lttng_userspace_probe_location_get_type(
		const struct lttng_userspace_probe_location *location);

/*
 * Destroy the userspace probe location.
 */
extern void lttng_userspace_probe_location_destroy(
		struct lttng_userspace_probe_location *location);

/*
 * Create a probe location of the function type.
 * Receives the target binary file path and function to instrument.
 * On failure, NULL is returned.
 *
 * The ownership of the lookup method is transferred to the created probe
 * location.
 */
extern struct lttng_userspace_probe_location *
lttng_userspace_probe_location_function_create(const char *binary_path,
		const char *function_name,
		struct lttng_userspace_probe_location_lookup_method *lookup_method);

/*
 * Get the target binary path of the probe location of the function type.
 */
extern const char *lttng_userspace_probe_location_function_get_binary_path(
		const struct lttng_userspace_probe_location *location);

/*
 * Get the target function type of the probe location of the function type.
 */
extern const char *lttng_userspace_probe_location_function_get_function_name(
		const struct lttng_userspace_probe_location *location);

/*
 * Get the lookup method of the given userspace probe location.
 * Returns NULL if the probe location type is unsupported.
 *
 * The ownership of the lookup method is NOT transferred to the caller.
 */
extern struct lttng_userspace_probe_location_lookup_method *
lttng_userspace_probe_location_get_lookup_method(
		const struct lttng_userspace_probe_location *location);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_USERSPACE_PROBE_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
	3	*
	4	* This library is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU Lesser General Public License, version 2.1 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This library is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
	11	* for more details.
	12	*
	13	* You should have received a copy of the GNU Lesser General Public License
	14	* along with this library; if not, write to the Free Software Foundation,
	15	* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16	*/
	17
	18	#ifndef LTTNG_USERSPACE_PROBE_H
	19	#define LTTNG_USERSPACE_PROBE_H
	20
	21	#ifdef __cplusplus
	22	extern "C" {
	23	#endif
	24
	25	/*
	26	* Userspace probe lookup methods specifies how the userspace probe location
	27	* specified by the user should be interpreted.
	28	*/
	29	struct lttng_userspace_probe_location_lookup_method;
	30
	31	enum lttng_userspace_probe_location_lookup_method_type {
	32	LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_UNKNOWN = -1,
	33	LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT = 0,
	34	LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF = 1,
	35	};
	36
	37	/*
	38	* Get the type of a lookup method.
	39	*/
	40	extern enum lttng_userspace_probe_location_lookup_method_type
	41	lttng_userspace_probe_location_lookup_method_get_type(
	42	const struct lttng_userspace_probe_location_lookup_method *lookup_method);
	43
	44	/*
	45	* Destroy a lookup method.
	46	*/
	47	extern void lttng_userspace_probe_location_lookup_method_destroy(
	48	struct lttng_userspace_probe_location_lookup_method *lookup_method);
	49
	50	/*
	51	* Create a tracepoint ELF function lookup method struct.
	52	* Return NULL on failure.
	53	*/
	54	extern struct lttng_userspace_probe_location_lookup_method *
	55	lttng_userspace_probe_location_lookup_method_function_elf_create(void);
	56
	57
	58	/*
	59	* Contains all the information needed to compute the instrumentation point in
	60	* the binary. It is used in conjonction with a lookup method.
	61	*/
	62	struct lttng_userspace_probe_location;
	63
	64	enum lttng_userspace_probe_location_type {
	65	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN = -1,
	66	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION = 0,
	67	};
	68
	69	/*
	70	* Get the type of the userspace probe location.
	71	*/
	72	extern enum lttng_userspace_probe_location_type
	73	lttng_userspace_probe_location_get_type(
	74	const struct lttng_userspace_probe_location *location);
	75
	76	/*
	77	* Destroy the userspace probe location.
	78	*/
	79	extern void lttng_userspace_probe_location_destroy(
	80	struct lttng_userspace_probe_location *location);
	81
	82	/*
	83	* Create a probe location of the function type.
	84	* Receives the target binary file path and function to instrument.
	85	* On failure, NULL is returned.
	86	*
	87	* The ownership of the lookup method is transferred to the created probe
	88	* location.
	89	*/
	90	extern struct lttng_userspace_probe_location *
	91	lttng_userspace_probe_location_function_create(const char *binary_path,
	92	const char *function_name,
	93	struct lttng_userspace_probe_location_lookup_method *lookup_method);
	94
	95	/*
	96	* Get the target binary path of the probe location of the function type.
	97	*/
	98	extern const char *lttng_userspace_probe_location_function_get_binary_path(
	99	const struct lttng_userspace_probe_location *location);
	100
	101	/*
	102	* Get the target function type of the probe location of the function type.
	103	*/
	104	extern const char *lttng_userspace_probe_location_function_get_function_name(
	105	const struct lttng_userspace_probe_location *location);
	106
	107	/*
	108	* Get the lookup method of the given userspace probe location.
	109	* Returns NULL if the probe location type is unsupported.
	110	*
	111	* The ownership of the lookup method is NOT transferred to the caller.
	112	*/
	113	extern struct lttng_userspace_probe_location_lookup_method *
	114	lttng_userspace_probe_location_get_lookup_method(
	115	const struct lttng_userspace_probe_location *location);
	116
	117	#ifdef __cplusplus
	118	}
	119	#endif
	120
	121	#endif /* LTTNG_USERSPACE_PROBE_H */