userspace-probe.h

/*
 * SPDX-FileCopyrightText: 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_USERSPACE_PROBE_H
#define LTTNG_USERSPACE_PROBE_H
 
#include <lttng/lttng-export.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct lttng_userspace_probe_location_lookup_method;
 
enum lttng_userspace_probe_location_lookup_method_type {
    LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT = 0,
 
    LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF = 1,
 
    LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT = 2,
 
    LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_UNKNOWN = -1,
};
 
LTTNG_EXPORT 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);
 
LTTNG_EXPORT extern void lttng_userspace_probe_location_lookup_method_destroy(
    struct lttng_userspace_probe_location_lookup_method *lookup_method);
 
LTTNG_EXPORT extern struct lttng_userspace_probe_location_lookup_method *
lttng_userspace_probe_location_lookup_method_function_elf_create(void);
 
LTTNG_EXPORT extern struct lttng_userspace_probe_location_lookup_method *
lttng_userspace_probe_location_lookup_method_tracepoint_sdt_create(void);
 
struct lttng_userspace_probe_location;
 
enum lttng_userspace_probe_location_status {
    LTTNG_USERSPACE_PROBE_LOCATION_STATUS_OK = 0,
 
    LTTNG_USERSPACE_PROBE_LOCATION_STATUS_INVALID = -1,
};
 
enum lttng_userspace_probe_location_type {
    LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION = 0,
 
    LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT = 1,
 
    LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN = -1,
};
 
LTTNG_EXPORT extern enum lttng_userspace_probe_location_type
lttng_userspace_probe_location_get_type(const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern void
lttng_userspace_probe_location_destroy(struct lttng_userspace_probe_location *location);
 
enum lttng_userspace_probe_location_function_instrumentation_type {
    LTTNG_USERSPACE_PROBE_LOCATION_FUNCTION_INSTRUMENTATION_TYPE_UNKNOWN = -1,
    /* Only instrument the function's entry. */
    LTTNG_USERSPACE_PROBE_LOCATION_FUNCTION_INSTRUMENTATION_TYPE_ENTRY = 0,
};
 
LTTNG_EXPORT 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);
 
LTTNG_EXPORT extern const char *lttng_userspace_probe_location_function_get_binary_path(
    const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern const char *lttng_userspace_probe_location_function_get_function_name(
    const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern int lttng_userspace_probe_location_function_get_binary_fd(
    const struct lttng_userspace_probe_location *location);
 
/*
 * Get the instrumentation type of the function probe location.
 */
LTTNG_EXPORT extern enum lttng_userspace_probe_location_function_instrumentation_type
lttng_userspace_probe_location_function_get_instrumentation_type(
    const struct lttng_userspace_probe_location *location);
 
/*
 * Get the instrumentation type of the function probe location.
 * Defaults to
 * LTTNG_USERSPACE_PROBE_LOCATION_FUNCTION_INSTRUMENTATION_TYPE_ENTRY.
 *
 * Returns LTTNG_USERSPACE_PROBE_LOCATION_STATUS_OK on success,
 * LTTNG_USERSPACE_PROBE_LOCATION_STATUS_INVALID if invalid parameters
 * are provided.
 */
LTTNG_EXPORT extern enum lttng_userspace_probe_location_status
lttng_userspace_probe_location_function_set_instrumentation_type(
    const struct lttng_userspace_probe_location *location,
    enum lttng_userspace_probe_location_function_instrumentation_type instrumentation_type);
 
LTTNG_EXPORT extern const struct lttng_userspace_probe_location_lookup_method *
lttng_userspace_probe_location_get_lookup_method(
    const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern struct lttng_userspace_probe_location *
lttng_userspace_probe_location_tracepoint_create(
    const char *binary_path,
    const char *probe_name,
    const char *provider_name,
    struct lttng_userspace_probe_location_lookup_method *lookup_method);
 
LTTNG_EXPORT extern const char *lttng_userspace_probe_location_tracepoint_get_binary_path(
    const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern const char *lttng_userspace_probe_location_tracepoint_get_probe_name(
    const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern const char *lttng_userspace_probe_location_tracepoint_get_provider_name(
    const struct lttng_userspace_probe_location *location);
 
LTTNG_EXPORT extern int lttng_userspace_probe_location_tracepoint_get_binary_fd(
    const struct lttng_userspace_probe_location *location);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_USERSPACE_PROBE_H */