datadog_agent_rtloader.h

// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog
// (https://www.datadoghq.com/).
// Copyright 2019-present Datadog, Inc.
#ifndef DATADOG_AGENT_RTLOADER_H_INCLUDED
#define DATADOG_AGENT_RTLOADER_H_INCLUDED

/*! \file datadog_agent_rtloader.h
    \brief Datadog Agent RtLoader interface header file.

    The prototypes here defined provide a set of functions which either
    present the API to the datadog-agent to call via CGO, or helpers
    relevant to that API. The goal of this interface is to provide a
    simple, basic set of calls to enable any backend to run checks for
    the agent.
*/

#include <rtloader_types.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rtloader_s;
typedef struct rtloader_s rtloader_t;

struct rtloader_pyobject_s;
typedef struct rtloader_pyobject_s rtloader_pyobject_t;

// FACTORIES
/*! \fn rtloader_t *make2(const char *python_home, const char *python_exe, char **error)
    \brief Factory function to load the python2 backend DLL and create its relevant RtLoader
    instance.
    \param python_home A C-string with the path to the PYTHONHOME for said DLL.
    \param python_exe A C-string with the path to the python interpreter.
    \param error A C-string pointer output parameter to return error messages.
    \return A rtloader_t * pointer to the RtLoader instance.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API rtloader_t *make2(const char *python_home, const char *python_exe, char **error);
/*! \fn rtloader_t *make3(const char *python_home, const char *python_exe, char **error)
    \brief Factory function to load the python3 backend DLL and create its relevant RtLoader
    instance.
    \param python_home A C-string with the path to the PYTHONHOME for said DLL.
    \param python_exe A C-string with the path to the python interpreter.
    \param error A C-string pointer output parameter to return error messages.
    \return A rtloader_t * pointer to the RtLoader instance.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API rtloader_t *make3(const char *python_home, const char *python_exe, char **error);

// HELPERS
/*! \fn void set_memory_tracker_cb(cb_memory_tracker_t)
    \brief Sets a callback to be used by rtloader for some memory allocation book-keeping.
    \param object A function pointer to the callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_memory_tracker_cb(cb_memory_tracker_t);

// API
/*! \fn void destroy(rtloader_t *rtloader)
    \brief Destructor function for the provided rtloader backend.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance we wish to destroy.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void destroy(rtloader_t *);

/*! \fn int init(rtloader_t *rtloader)
    \brief Initializing function for the supplied RtLoader instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance we wish to initialize.
    \return An integer with the success of the operation. Zero for success,
    non-zero for failure.
    \sa rtloader_t

    This function should be called prior to any further interaction with the
    RtLoader.
*/
DATADOG_AGENT_RTLOADER_API int init(rtloader_t *);

/*! \fn int add_python_path(rtloader_t *, const char *path)
    \brief Adds a path to the list of python paths.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param path A C-string containing the path we wish to add to `sys.paths`.
    \return An integer with the success of the operation. Zero for success,
    non-zero for failure.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API int add_python_path(rtloader_t *, const char *path);

/*! \fn void clear_error(rtloader_t *)
    \brief Clears any error set in the RtLoader instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void clear_error(rtloader_t *);

/*! \fn rtloader_gilstate_t ensure_gil(rtloader_t *)
    \brief Ensures we have the python GIL lock and returns the GIL lock state.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \return A rtloader_gilstate_t type with the GIL state.
    \sa rtloader_gilstate_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API rtloader_gilstate_t ensure_gil(rtloader_t *);

/*! \fn void release_gil(rtloader_t *, rtloader_gilstate_t)
    \brief Releases the current python GIL lock being held.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param rtloader_gilstate_t A rtloader_gilstate_t type with the current GIL state.
    \sa rtloader_gilstate_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void release_gil(rtloader_t *, rtloader_gilstate_t);

/*! \fn int get_class(rtloader_t *rtloader, const char *name, rtloader_pyobject_t **py_module,
                                    rtloader_pyobject_t **py_class)
    \brief Attempts to get a python class by name from a specified python module.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param name A constant C-string with the name of the class to get.
    \param py_module A rtloader_pyobject_t ** pointer to the module we wish to get the
    class from.
    \param py_class A rtloader_pyobject_t ** pointer output parameter with a reference to
    the class, or NULL if none-found.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API int get_class(rtloader_t *rtloader, const char *name, rtloader_pyobject_t **py_module,
                                         rtloader_pyobject_t **py_class);

/*! \fn int get_attr_string(rtloader_t *rtloader, rtloader_pyobject_t *py_class, const char *attr_name, char **value)
    \brief Attempts to get a string attribute from the supplied python class, by name.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param py_class A rtloader_pyobject_t ** pointer to the class we wish to get the
    attribute from.
    \param attr_name A constant C-string with the name of the attribute to get.
    \param value A char ** pointer C-string output parameter with the attribute value.
    \return An integer with the success of the operation. Zero for success, non-zero for failure.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API int get_attr_string(rtloader_t *rtloader, rtloader_pyobject_t *py_class,
                                               const char *attr_name, char **value);

/*! \fn int get_check(rtloader_t *rtloader, rtloader_pyobject_t *py_class, const char *init_config, const char
   *instance, const char *check_id, const char *check_name, rtloader_pyobject_t **check) \brief Attempts to instantiate
   a datadog python check with the supplied configuration parameters. \param rtloader_t A rtloader_t * pointer to the
   RtLoader instance. \param py_class A rtloader_pyobject_t * pointer to the python check class we wish to instantiate.
    \param init_config A constant C-string with the init config for the check instance.
    \param instance A constant C-string with the instance-specific config for the check instance.
    \param check_id A constant C-string unique identifier for the check instance.
    \param check_name A constant C-string with the check name.
    \param check A rtloader_pyobject_t ** pointer to the check instantiated if successful or NULL otherwise.
    \return An integer with the success of the operation. Zero for success, non-zero for failure.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API int get_check(rtloader_t *rtloader, rtloader_pyobject_t *py_class, const char *init_config,
                                         const char *instance, const char *check_id, const char *check_name,
                                         rtloader_pyobject_t **check);

/*! \fn int get_check_deprecated(rtloader_t *rtloader, rtloader_pyobject_t *py_class, const char *init_config,
                                               const char *instance, const char *check_id, const char *check_name,
                                               const char *agent_config, rtloader_pyobject_t **check)
    \brief Attempts to instantiate a datadog python check with the supplied configuration
    parameters.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param py_class A rtloader_pyobject_t * pointer to the python check class we wish to instantiate.
    \param init_config A constant C-string with the init config for the check instance.
    \param instance A constant C-string with the instance-specific config for the check instance.
    \param check_id A constant C-string unique identifier for the check instance.
    \param check_name A constant C-string with the check name.
    \param agent_config A constant C-string with the agent_config.
    \param check A rtloader_pyobject_t ** pointer to the check instantiated if successful or NULL otherwise.
    \return An integer with the success of the operation. Zero for success, non-zero for failure.
    \sa rtloader_pyobject_t, rtloader_t, get_check

    This function is deprecated in favor of `get_check()`.
*/
DATADOG_AGENT_RTLOADER_API int get_check_deprecated(rtloader_t *rtloader, rtloader_pyobject_t *py_class,
                                                    const char *init_config, const char *instance, const char *check_id,
                                                    const char *check_name, const char *agent_config,
                                                    rtloader_pyobject_t **check);

/*! \fn char *run_check(rtloader_t *, rtloader_pyobject_t *check)
    \brief Runs a check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param check A rtloader_pyobject_t * pointer to the check instance we wish to run.
    \return A C-string with the check summary.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API char *run_check(rtloader_t *, rtloader_pyobject_t *check);

/*! \fn char *cancel_check(rtloader_t *, rtloader_pyobject_t *check)
    \brief Cancels a check instance. This allow check to be notified when
    they're unscheduled and can free any remaining resources.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param check A rtloader_pyobject_t * pointer to the check instance we wish to cancel.
    \return A C-string with the check summary.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void cancel_check(rtloader_t *, rtloader_pyobject_t *check);

/*! \fn char **get_checks_warnings(rtloader_t *, rtloader_pyobject_t *check)
    \brief Get all warnings, if any, for a check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param check A rtloader_pyobject_t * pointer to the check instance we wish to collect the
    warnings for.
    \return An array of C-strings with found warnings for the instance, or NULL if none or
    an error occurred.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API char **get_checks_warnings(rtloader_t *, rtloader_pyobject_t *check);

/*! \fn void rtloader_free(rtloader_t *, void *ptr)
    \brief Routine to free heap memory in RtLoader.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param ptr A void * pointer to the region of memory we wish to free.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void rtloader_free(rtloader_t *, void *ptr);

/*! \fn void rtloader_decref(rtloader_t *, rtloader_pyobject_t *)
    \brief Routine to decrease the python reference count for the supplied python
    object.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param pyobject A rtloader_pyobject_t * pointer to the python object we wish to decrease the
    reference for.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void rtloader_decref(rtloader_t *, rtloader_pyobject_t *);

/*! \fn void rtloader_incref(rtloader_t *, rtloader_pyobject_t *)
    \brief Routine to increase the python reference count for the supplied python
    object.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param pyobject A rtloader_pyobject_t * pointer to the python object we wish to increase the
    reference for.
    \sa rtloader_pyobject_t, rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void rtloader_incref(rtloader_t *, rtloader_pyobject_t *);

/*! \fn void set_module_attr_string(rtloader_t *, char *, char *, char *)
    \brief Routine to set a string attribute on a given module.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param char * A C-string pointer containing the python module name we wish to add the
    attribute to.
    \param char * A C-string pointer with the attribute name we wish to add.
    \param char * A C-string pointer with the attribute string value.
    \sa rtloader_t
*/
DATADOG_AGENT_RTLOADER_API void set_module_attr_string(rtloader_t *, char *, char *, char *);

// CONST API
/*! \fn rtloader_pyobject_t *get_none(const rtloader_t *)
    \brief Routine to set a string attribute on a given module.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \return A rtloader_pyobject_t * pointer to the python `None` object.
    \sa rtloader_pyobject_t, rtloader_t

    Returns a new reference, and thus increases the reference count to `None`.
*/
DATADOG_AGENT_RTLOADER_API rtloader_pyobject_t *get_none(const rtloader_t *);

/*! \fn py_info_t *get_py_info(rtloader_t *)
    \brief Routine to collect python runtime information details from the RtLoader instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \return A py_info_t * pointer with the relevant python information or NULL in case of
    error.
    \sa py_info_t, rtloader_t

    Allocates memory for the returned `py_info_t` structure and should be freed by calling free_py_info()
*/
DATADOG_AGENT_RTLOADER_API py_info_t *get_py_info(rtloader_t *);

/*! \fn py_info_t *free_py_info(rtloader_t *)
    \brief Routine to free structure returned from get_py_info
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param A py_info_t * pointer previously returned form get_py_info

    Frees the structure and appropriate structure memebers.
*/
DATADOG_AGENT_RTLOADER_API void free_py_info(rtloader_t *, py_info_t *);
/*! \fn int run_simple_string(const rtloader_t *, const char *code)
    \brief Routine to execute a simple piece of python code on the RtLoader python runtime
    implementation.
    \param rtloader_t A const rtloader_t * pointer to the RtLoader instance.
    \param code A const C-string pointer to the simple python code to run on the interpreter.
    \return An integer reflecting whether the code executed successfully on RtLoader. Zero for false,
    non-zero for true.
    \sa rtloader_t

    Allocates memory for the returned `py_info_t` structure and should be freed accordingly.
*/
DATADOG_AGENT_RTLOADER_API int run_simple_string(const rtloader_t *, const char *code);

/*! \fn int has_error(rtloader_t *)
    \brief Routine indicating whether any error is set on the provided RtLoader instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \return An integer reflecting if an error is set on RtLoader. Zero for false, non-zero for
    true.
    \sa rtloader_t

    No memory is allocated by this function, the returned pointer points to the internal
    array employed by the underlying RtLoader implementation.
*/
DATADOG_AGENT_RTLOADER_API int has_error(const rtloader_t *);

/*! \fn const char *get_error(rtloader_t *)
    \brief Routine to grab any set error on the provided RtLoader instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \return A constant C-string pointer to the error C-string representation.
    \sa rtloader_t

    No memory is allocated by this function, the returned pointer points to the internal
    array employed by the underlying RtLoader implementation.
*/
DATADOG_AGENT_RTLOADER_API const char *get_error(const rtloader_t *);
#ifndef _WIN32

/*! \fn int handle_crashes(const int, char** error)
    \brief Routine to install a crash handler in C-land to better debug crashes on RtLoader.
    \param int A const integer boolean flag indicating whether dumps should be created
    on crashes or not.
    \param error A C-string pointer output parameter to return error messages.
    \return An integer reflecting if the handler was correctly installed on RtLoader. Zero for
    false, non-zero for true.
    \sa rtloader_t

    If core dumps are enabled, you will NOT get the go-routine dump in the event of a crash.
    Core dumps generated from go-land are not as useful as C-stack has unwound, and so we
    get no real visibility into how rtloader may have crashed. On the counterpart, when generating
    the core dumps from C-land, we terminate early, and miss the Go panic handler that would
    provide the go-routine dump. If you need both, just crash twice trying both options :)

    Currently only SEGFAULT is handled.

    The returned error C-string must be freed by the caller.
*/
DATADOG_AGENT_RTLOADER_API int handle_crashes(const int, char **error);
#endif

// PYTHON HELPERS
/*! \fn char *get_integration_list(rtloader_t *)
    \brief Routine to build a list of every datadog wheel installed.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \return A C-string with the list of every datadog integration wheel installed.
    \sa rtloader_t

    The returned list must be freed by the caller.
*/
DATADOG_AGENT_RTLOADER_API char *get_integration_list(rtloader_t *);

/*! \fn char *get_interpreter_memory_usage(rtloader_t *)
    \brief Routine to get python interpreter memory usage (pympler).
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \sa rtloader_t

    TODO.
*/
DATADOG_AGENT_RTLOADER_API char *get_interpreter_memory_usage(rtloader_t *);

// AGGREGATOR API
/*! \fn void set_submit_metric_cb(rtloader_t *, cb_submit_metric_t)
    \brief Sets the submit metric callback to be used by rtloader for metric submission.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param cb A function pointer with cb_submit_metric_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_submit_metric_cb(rtloader_t *, cb_submit_metric_t);

/*! \fn void set_submit_service_check_cb(rtloader_t *, cb_submit_service_check_t)
    \brief Sets the submit service_check callback to be used by rtloader for service_check
    submission.
    \param cb A function pointer with cb_submit_service_check_t prototype to the
    callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_submit_service_check_cb(rtloader_t *, cb_submit_service_check_t);

/*! \fn void set_submit_event_cb(rtloader_t *, cb_submit_event_t)
    \brief Sets the submit event callback to be used by rtloader for event submission.
    \param cb A function pointer with cb_submit_event_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_submit_event_cb(rtloader_t *, cb_submit_event_t);

/*! \fn void set_submit_histogram_bucket_cb(rtloader_t *, cb_submit_histogram_bucket_t)
    \brief Sets the submit event callback to be used by rtloader for histogram bucket submission.
    \param cb A function pointer with cb_submit_histogram_bucket_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_submit_histogram_bucket_cb(rtloader_t *, cb_submit_histogram_bucket_t);

/*! \fn void set_submit_event_platform_event_cb(rtloader_t *, cb_submit_event_platform_event_t)
    \brief Sets the submit event callback to be used by rtloader for event-platform event.
    \param cb A function pointer with cb_submit_event_platform_event_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_submit_event_platform_event_cb(rtloader_t *, cb_submit_event_platform_event_t);

// DATADOG_AGENT API
/*! \fn void set_get_version_cb(rtloader_t *, cb_get_version_t)
    \brief Sets a callback to be used by rtloader to collect the agent version.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_version_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_version_cb(rtloader_t *, cb_get_version_t);

/*! \fn void set_get_config_cb(crtloader_t *, b_get_config_t)
    \brief Sets a callback to be used by rtloader to collect the agent configuration.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_config_t prototype to the
    callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_config_cb(rtloader_t *, cb_get_config_t);

/*! \fn void set_headers_cb(rtloader_t *, cb_headers_t)
    \brief Sets a callback to be used by rtloader to collect the typical HTTP headers for
    agent requests.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_headers_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_headers_cb(rtloader_t *, cb_headers_t);

/*! \fn void set_get_hostname_cb(rtloader_t *, cb_get_hostname_t)
    \brief Sets a callback to be used by rtloader to collect the canonical hostname from the
    agent.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_hostname_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_hostname_cb(rtloader_t *, cb_get_hostname_t);

/*! \fn void set_get_clustername_cb(rtloader_t *, cb_get_clustername_t)
    \brief Sets a callback to be used by rtloader to collect the K8s clustername from the
    agent.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_clustername_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_clustername_cb(rtloader_t *, cb_get_clustername_t);

/*! \fn void set_tracemalloc_enabled_cb(rtloader_t *, cb_tracemalloc_enabled_t)
    \brief Sets a callback to be used by rtloader to collect whether tracemalloc is enabled
    or not.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_tracemalloc_enabled_t prototype to the
    callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_tracemalloc_enabled_cb(rtloader_t *, cb_tracemalloc_enabled_t);

/*! \fn void set_log_cb(rtloader_t *, cb_log_t)
    \brief Sets a callback to be used by rtloader to allow using the agent's go-native
    logging facilities to log messages.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_log_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_log_cb(rtloader_t *, cb_log_t);

/*! \fn void set_set_check_metadata_cb(rtloader_t *, cb_set_check_metadata_t)
    \brief Sets a callback to be used by rtloader to allow setting metadata for a given
    check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_set_check_metadata_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_set_check_metadata_cb(rtloader_t *, cb_set_check_metadata_t);

/*! \fn void set_set_external_tags_cb(rtloader_t *, cb_set_external_tags_t)
    \brief Sets a callback to be used by rtloader to allow setting external tags for a given
    hostname.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_set_external_tags_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_set_external_tags_cb(rtloader_t *, cb_set_external_tags_t);

// _UTIL API
/*! \fn void set_get_subprocess_output_cb(rtloader_t *rtloader, cb_get_subprocess_output_t)
    \brief Sets a callback to be used by rtloader to run subprocess commands and collect their
    output.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_subprocess_output_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_subprocess_output_cb(rtloader_t *rtloader, cb_get_subprocess_output_t cb);

// CGO API
/*! \fn void set_cgo_free_cb(rtloader_t *rtloader, cb_cgo_free_t cb)
    \brief Sets a callback to be used by rtloader to free memory allocated by the
    rtloader's caller and passed into rtloader.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer to the callback function.

    On Windows we cannot free a memory block from another DLL. This is why we
    need to call back to the allocating DLL if it wishes to release allocated memory.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_cgo_free_cb(rtloader_t *, cb_cgo_free_t);

// TAGGER API
/*! \fn void set_tags_cb(rtloader_t *, cb_tags_t)
    \brief Sets a callback to be used by rtloader for setting the relevant tags.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with the cb_tags_t prototype to the
    callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
    The callback in turn will call the pertinent internal go-land tagger logic.
    The callback logic will allocate a C(go) pointer array, and the C strings for the
    tagger generate tags. This memory should be freed with the cgo_free helper
    available when done.
*/
DATADOG_AGENT_RTLOADER_API void set_tags_cb(rtloader_t *, cb_tags_t);

// KUBEUTIL API
/*! \fn void set_get_connection_info_cb(rtloader_t *, cb_get_connection_info_t)
    \brief Sets a callback to be used by rtloader for kubernetes connection information
    retrieval.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_connection_info_t prototype to the
    callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_connection_info_cb(rtloader_t *, cb_get_connection_info_t);

// CONTAINERS
/*! \fn void set_is_excluded_cb(rtloader_t *, cb_is_excluded_t)
    \brief Sets a callback to be used by rtloader to determine if a container is excluded
    from metric collection.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_is_excluded_t function prototype to the
    callback function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_is_excluded_cb(rtloader_t *, cb_is_excluded_t);

/*! \fn void set_write_persistent_cache_cb(rtloader_t *, cb_write_persistent_cache_t)
    \brief Sets a callback to be used by rtloader to allow storing a value for a given
    check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_write_persistent_cache_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_write_persistent_cache_cb(rtloader_t *, cb_write_persistent_cache_t);

/*! \fn void set_read_persistent_cache_cb(rtloader_t *, cb_read_persistent_cache_t)
    \brief Sets a callback to be used by rtloader to allow retrieving a value for a given
    check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_read_persistent_cache_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_read_persistent_cache_cb(rtloader_t *, cb_read_persistent_cache_t);

/*! \fn void set_obfuscate_sql_cb(rtloader_t *, cb_obfuscate_sql_t)
    \brief Sets a callback to be used by rtloader to allow retrieving a value for a given
    check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_obfuscate_sql_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_obfuscate_sql_cb(rtloader_t *, cb_obfuscate_sql_t);

/*! \fn void set_obfuscate_sql_exec_plan_cb(rtloader_t *, cb_obfuscate_sql_exec_plan_t)
    \brief Sets a callback to be used by rtloader to allow retrieving a value for a given
    check instance.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_obfuscate_sql_exec_plan_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_obfuscate_sql_exec_plan_cb(rtloader_t *, cb_obfuscate_sql_exec_plan_t);

/*! \fn void set_get_process_start_time_cb(rtloader_t *, cb_get_process_start_time_t)
    \brief Sets a callback to be used by rtloader to retrieve agent process start time.
    \param rtloader_t A rtloader_t * pointer to the RtLoader instance.
    \param object A function pointer with cb_get_process_start_time_t prototype to the callback
    function.

    The callback is expected to be provided by the rtloader caller - in go-context: CGO.
*/
DATADOG_AGENT_RTLOADER_API void set_get_process_start_time_cb(rtloader_t *, cb_get_process_start_time_t);

#ifdef __cplusplus
}
#endif
#endif