Add function instrumentation type accessors to function location type

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

diff --git a/include/lttng/userspace-probe.h b/include/lttng/userspace-probe.h
index 0168ac2fd7382e903882a2dbd0fbaeaecdfe4012..cedb7d8b8fc7e260f85350592a0cc3599295ac82 100644 (file)
--- a/include/lttng/userspace-probe.h
+++ b/include/lttng/userspace-probe.h
@@ -32,6 +32,7 @@ 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,
+       LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT    = 2,
 };
 
 /*
@@ -54,6 +55,13 @@ extern void lttng_userspace_probe_location_lookup_method_destroy(
 extern struct lttng_userspace_probe_location_lookup_method *
 lttng_userspace_probe_location_lookup_method_function_elf_create(void);
 
+/*
+ * Create a tracepoint SDT tracepoint lookup method struct.
+ * Return NULL on failure.
+ */
+extern struct lttng_userspace_probe_location_lookup_method *
+lttng_userspace_probe_location_lookup_method_tracepoint_sdt_create(void);
+
 
 /*
  * Contains all the information needed to compute the instrumentation point in
@@ -61,9 +69,18 @@ lttng_userspace_probe_location_lookup_method_function_elf_create(void);
  */
 struct lttng_userspace_probe_location;
 
+enum lttng_userspace_probe_location_status {
+       LTTNG_USERSPACE_PROBE_LOCATION_STATUS_OK        = 0,
+       /* Invalid parameters provided. */
+       LTTNG_USERSPACE_PROBE_LOCATION_STATUS_INVALID   = -1,
+};
+
 enum lttng_userspace_probe_location_type {
        LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN     = -1,
+       /* Function. */
        LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION    = 0,
+       /* SDT probe's callsites. */
+       LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT  = 1,
 };
 
 /*
@@ -79,6 +96,13 @@ lttng_userspace_probe_location_get_type(
 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,
+};
+
 /*
  * Create a probe location of the function type.
  * Receives the target binary file path and function to instrument.
@@ -104,16 +128,84 @@ extern const char *lttng_userspace_probe_location_function_get_binary_path(
 extern const char *lttng_userspace_probe_location_function_get_function_name(
                const struct lttng_userspace_probe_location *location);
 
+/*
+ * Get the FD to the target binary file to the probe location of the function
+ * type.
+ */
+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.
+ */
+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.
+ */
+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);
+
 /*
  * 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 *
+extern const struct lttng_userspace_probe_location_lookup_method *
 lttng_userspace_probe_location_get_lookup_method(
                const struct lttng_userspace_probe_location *location);
 
+/*
+ * Create a probe location of the tracepoint type.
+ * Receives the target binary file path, probename and probe provider 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_tracepoint_create(const char *binary_path,
+               const char *probe_name, const char *provider_name,
+               struct lttng_userspace_probe_location_lookup_method *lookup_method);
+
+/*
+ * Get the target binary path of the probe location of the tracepoint type.
+ */
+extern const char *lttng_userspace_probe_location_tracepoint_get_binary_path(
+               const struct lttng_userspace_probe_location *location);
+
+/*
+ * Get the target probe name of the probe location of the tracepoint type.
+ */
+extern const char *lttng_userspace_probe_location_tracepoint_get_probe_name(
+               const struct lttng_userspace_probe_location *location);
+
+/*
+ * Get the target probe provider name of the probe location of the tracepoint
+ * type.
+ */
+extern const char *lttng_userspace_probe_location_tracepoint_get_provider_name(
+               const struct lttng_userspace_probe_location *location);
+
+/*
+ * Get the FD to the target binary file to the probe location of the tracepoint
+ * type.
+ */
+extern int lttng_userspace_probe_location_tracepoint_get_binary_fd(
+               const struct lttng_userspace_probe_location *location);
+
 #ifdef __cplusplus
 }
 #endif