libdatadog 2.0.0.1.0 → 7.0.0.1.0

data/vendor/{libdatadog-2.0.0/x86_64-linux/libdatadog-x86_64-unknown-linux-gnu → libdatadog-7.0.0/x86_64-linux-musl/libdatadog-x86_64-alpine-linux-musl}/include/datadog/common.h

@@ -1,5 +1,6 @@
-// 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 2021-Present Datadog, Inc.
+// Copyright 2021-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+
 
 #ifndef DDOG_COMMON_H
 #define DDOG_COMMON_H
@@ -10,13 +11,11 @@
 #include <stddef.h>
 #include <stdint.h>
 
-#if defined(_MSC_VER)
-#define DDOG_CHARSLICE_C(string) \
-/* NOTE: Compilation fails if you pass in a char* instead of a literal */ {.ptr = "" string, .len = sizeof(string) - 1}
-#else
 #define DDOG_CHARSLICE_C(string) \
 /* NOTE: Compilation fails if you pass in a char* instead of a literal */ ((ddog_CharSlice){ .ptr = "" string, .len = sizeof(string) - 1 })
-#endif
+
+#define DDOG_CHARSLICE_C_BARE(string) \
+/* NOTE: Compilation fails if you pass in a char* instead of a literal */ { .ptr = "" string, .len = sizeof(string) - 1 }
 
 #if defined __GNUC__
 #  define DDOG_GNUC_VERSION(major) __GNUC__ >= major
@@ -40,6 +39,8 @@
 #  define DDOG_CHECK_RETURN
 #endif
 
+typedef struct ddog_Endpoint ddog_Endpoint;
+
 typedef struct ddog_Tag ddog_Tag;
 
 /**
@@ -65,15 +66,21 @@ typedef struct ddog_Error {
   struct ddog_Vec_U8 message;
 } ddog_Error;
 
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
 typedef struct ddog_Slice_CChar {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
   const char *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
   uintptr_t len;
 } ddog_Slice_CChar;
 
+/**
+ * Use to represent strings -- should be valid UTF-8.
+ */
 typedef struct ddog_Slice_CChar ddog_CharSlice;
 
 /**
@@ -105,9 +112,38 @@ typedef struct ddog_Vec_Tag_ParseResult {
   struct ddog_Error *error_message;
 } ddog_Vec_Tag_ParseResult;
 
-typedef struct ddog_CancellationToken ddog_CancellationToken;
+typedef enum ddog_prof_CrashtrackerResolveFrames {
+  DDOG_PROF_CRASHTRACKER_RESOLVE_FRAMES_NEVER,
+  /**
+   * Resolving frames in process is experimental, and can fail/crash
+   */
+  DDOG_PROF_CRASHTRACKER_RESOLVE_FRAMES_EXPERIMENTAL_IN_PROCESS,
+  DDOG_PROF_CRASHTRACKER_RESOLVE_FRAMES_IN_RECEIVER,
+} ddog_prof_CrashtrackerResolveFrames;
+
+/**
+ * This enum represents operations a profiler might be engaged in.
+ * The idea is that if a crash consistently occurs while a particular operation
+ * is ongoing, its likely related.
+ *
+ * In the future, we might also track wall-clock time of operations
+ * (or some statistical sampling thereof) using the same enum.
+ *
+ * NOTE: This enum is known to be non-exhaustive.  Feel free to add new types
+ *       as needed.
+ */
+typedef enum ddog_prof_ProfilingOpTypes {
+  DDOG_PROF_PROFILING_OP_TYPES_NOT_PROFILING = 0,
+  DDOG_PROF_PROFILING_OP_TYPES_COLLECTING_SAMPLE,
+  DDOG_PROF_PROFILING_OP_TYPES_UNWINDING,
+  DDOG_PROF_PROFILING_OP_TYPES_SERIALIZING,
+  /**
+   * Dummy value to allow easier iteration
+   */
+  DDOG_PROF_PROFILING_OP_TYPES_SIZE,
+} ddog_prof_ProfilingOpTypes;
 
-typedef struct ddog_prof_Profile ddog_prof_Profile;
+typedef struct ddog_CancellationToken ddog_CancellationToken;
 
 typedef struct ddog_prof_Exporter ddog_prof_Exporter;
 
@@ -115,25 +151,119 @@ typedef struct ddog_prof_ProfiledEndpointsStats ddog_prof_ProfiledEndpointsStats
 
 typedef struct ddog_prof_Exporter_Request ddog_prof_Exporter_Request;
 
-typedef enum ddog_Endpoint_Tag {
-  DDOG_ENDPOINT_AGENT,
-  DDOG_ENDPOINT_AGENTLESS,
-} ddog_Endpoint_Tag;
+/**
+ * A generic result type for when a profiling operation may fail, but there's
+ * nothing to return in the case of success.
+ */
+typedef enum ddog_prof_Profile_Result_Tag {
+  DDOG_PROF_PROFILE_RESULT_OK,
+  DDOG_PROF_PROFILE_RESULT_ERR,
+} ddog_prof_Profile_Result_Tag;
 
-typedef struct ddog_Endpoint_ddog_prof_Agentless_Body {
+typedef struct ddog_prof_Profile_Result {
+  ddog_prof_Profile_Result_Tag tag;
+  union {
+    struct {
+      /**
+       * Do not use the value of Ok. This value only exists to overcome
+       * Rust -> C code generation.
+       */
+      bool ok;
+    };
+    struct {
+      struct ddog_Error err;
+    };
+  };
+} ddog_prof_Profile_Result;
+
+typedef enum ddog_prof_Endpoint_Tag {
+  DDOG_PROF_ENDPOINT_AGENT,
+  DDOG_PROF_ENDPOINT_AGENTLESS,
+} ddog_prof_Endpoint_Tag;
+
+typedef struct ddog_prof_Endpoint_ddog_prof_Agentless_Body {
   ddog_CharSlice _0;
   ddog_CharSlice _1;
-} ddog_Endpoint_ddog_prof_Agentless_Body;
+} ddog_prof_Endpoint_ddog_prof_Agentless_Body;
 
-typedef struct ddog_Endpoint {
-  ddog_Endpoint_Tag tag;
+typedef struct ddog_prof_Endpoint {
+  ddog_prof_Endpoint_Tag tag;
   union {
     struct {
       ddog_CharSlice agent;
     };
-    ddog_Endpoint_ddog_prof_Agentless_Body AGENTLESS;
+    ddog_prof_Endpoint_ddog_prof_Agentless_Body AGENTLESS;
   };
-} ddog_Endpoint;
+} ddog_prof_Endpoint;
+
+typedef struct ddog_prof_CrashtrackerConfiguration {
+  /**
+   * Should the crashtracker attempt to collect a stacktrace for the crash
+   */
+  bool collect_stacktrace;
+  bool create_alt_stack;
+  /**
+   * The endpoint to send the crash repor to (can be a file://)
+   */
+  struct ddog_prof_Endpoint endpoint;
+  /**
+   * Optional filename to forward stderr to (useful for logging/debugging)
+   */
+  ddog_CharSlice optional_stderr_filename;
+  /**
+   * Optional filename to forward stdout to (useful for logging/debugging)
+   */
+  ddog_CharSlice optional_stdout_filename;
+  ddog_CharSlice path_to_receiver_binary;
+  /**
+   * Whether/when we should attempt to resolve frames
+   */
+  enum ddog_prof_CrashtrackerResolveFrames resolve_frames;
+} ddog_prof_CrashtrackerConfiguration;
+
+typedef struct ddog_prof_CrashtrackerMetadata {
+  ddog_CharSlice profiling_library_name;
+  ddog_CharSlice profiling_library_version;
+  ddog_CharSlice family;
+  /**
+   * Should include "service", "environment", etc
+   */
+  const struct ddog_Vec_Tag *tags;
+} ddog_prof_CrashtrackerMetadata;
+
+typedef struct ddog_Slice_U8 {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
+  const uint8_t *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
+  uintptr_t len;
+} ddog_Slice_U8;
+
+/**
+ * Use to represent bytes -- does not need to be valid UTF-8.
+ */
+typedef struct ddog_Slice_U8 ddog_ByteSlice;
+
+typedef struct ddog_prof_Exporter_File {
+  ddog_CharSlice name;
+  ddog_ByteSlice file;
+} ddog_prof_Exporter_File;
+
+typedef struct ddog_prof_Exporter_Slice_File {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
+  const struct ddog_prof_Exporter_File *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
+  uintptr_t len;
+} ddog_prof_Exporter_Slice_File;
 
 typedef enum ddog_prof_Exporter_NewResult_Tag {
   DDOG_PROF_EXPORTER_NEW_RESULT_OK,
@@ -177,34 +307,6 @@ typedef struct ddog_Timespec {
   uint32_t nanoseconds;
 } ddog_Timespec;
 
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
-typedef struct ddog_Slice_U8 {
-  const uint8_t *ptr;
-  uintptr_t len;
-} ddog_Slice_U8;
-
-/**
- * Use to represent bytes -- does not need to be valid UTF-8.
- */
-typedef struct ddog_Slice_U8 ddog_ByteSlice;
-
-typedef struct ddog_prof_Exporter_File {
-  ddog_CharSlice name;
-  ddog_ByteSlice file;
-} ddog_prof_Exporter_File;
-
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
-typedef struct ddog_prof_Exporter_Slice_File {
-  const struct ddog_prof_Exporter_File *ptr;
-  uintptr_t len;
-} ddog_prof_Exporter_Slice_File;
-
 typedef struct ddog_HttpStatus {
   uint16_t code;
 } ddog_HttpStatus;
@@ -226,17 +328,48 @@ typedef struct ddog_prof_Exporter_SendResult {
   };
 } ddog_prof_Exporter_SendResult;
 
+/**
+ * Represents a profile. Do not access its member for any reason, only use
+ * the C API functions on this struct.
+ */
+typedef struct ddog_prof_Profile {
+  struct ddog_prof_Profile *inner;
+} ddog_prof_Profile;
+
+/**
+ * Returned by [ddog_prof_Profile_new].
+ */
+typedef enum ddog_prof_Profile_NewResult_Tag {
+  DDOG_PROF_PROFILE_NEW_RESULT_OK,
+  DDOG_PROF_PROFILE_NEW_RESULT_ERR,
+} ddog_prof_Profile_NewResult_Tag;
+
+typedef struct ddog_prof_Profile_NewResult {
+  ddog_prof_Profile_NewResult_Tag tag;
+  union {
+    struct {
+      struct ddog_prof_Profile ok;
+    };
+    struct {
+      struct ddog_Error err;
+    };
+  };
+} ddog_prof_Profile_NewResult;
+
 typedef struct ddog_prof_ValueType {
   ddog_CharSlice type_;
   ddog_CharSlice unit;
 } ddog_prof_ValueType;
 
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
 typedef struct ddog_prof_Slice_ValueType {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
   const struct ddog_prof_ValueType *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
   uintptr_t len;
 } ddog_prof_Slice_ValueType;
 
@@ -245,23 +378,6 @@ typedef struct ddog_prof_Period {
   int64_t value;
 } ddog_prof_Period;
 
-typedef enum ddog_prof_Profile_AddResult_Tag {
-  DDOG_PROF_PROFILE_ADD_RESULT_OK,
-  DDOG_PROF_PROFILE_ADD_RESULT_ERR,
-} ddog_prof_Profile_AddResult_Tag;
-
-typedef struct ddog_prof_Profile_AddResult {
-  ddog_prof_Profile_AddResult_Tag tag;
-  union {
-    struct {
-      uint64_t ok;
-    };
-    struct {
-      struct ddog_Error err;
-    };
-  };
-} ddog_prof_Profile_AddResult;
-
 typedef struct ddog_prof_Mapping {
   /**
    * Address at which the binary (or DLL) is loaded into memory.
@@ -309,31 +425,12 @@ typedef struct ddog_prof_Function {
   int64_t start_line;
 } ddog_prof_Function;
 
-typedef struct ddog_prof_Line {
-  /**
-   * The corresponding profile.Function for this line.
-   */
-  struct ddog_prof_Function function;
-  /**
-   * Line number in source code.
-   */
-  int64_t line;
-} ddog_prof_Line;
-
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
-typedef struct ddog_prof_Slice_Line {
-  const struct ddog_prof_Line *ptr;
-  uintptr_t len;
-} ddog_prof_Slice_Line;
-
 typedef struct ddog_prof_Location {
   /**
    * todo: how to handle unknown mapping?
    */
   struct ddog_prof_Mapping mapping;
+  struct ddog_prof_Function function;
   /**
    * The instruction address for this location, if available.  It
    * should be within [Mapping.memory_start...Mapping.memory_limit]
@@ -342,41 +439,30 @@ typedef struct ddog_prof_Location {
    * the beginning of the instruction if necessary.
    */
   uint64_t address;
-  /**
-   * Multiple line indicates this location has inlined functions,
-   * where the last entry represents the caller into which the
-   * preceding entries were inlined.
-   *
-   * E.g., if memcpy() is inlined into printf:
-   *    line[0].function_name == "memcpy"
-   *    line[1].function_name == "printf"
-   */
-  struct ddog_prof_Slice_Line lines;
-  /**
-   * Provides an indication that multiple symbols map to this location's
-   * address, for example due to identical code folding by the linker. In that
-   * case the line information above represents one of the multiple
-   * symbols. This field must be recomputed when the symbolization state of the
-   * profile changes.
-   */
-  bool is_folded;
+  int64_t line;
 } ddog_prof_Location;
 
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
 typedef struct ddog_prof_Slice_Location {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
   const struct ddog_prof_Location *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
   uintptr_t len;
 } ddog_prof_Slice_Location;
 
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
 typedef struct ddog_Slice_I64 {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
   const int64_t *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
   uintptr_t len;
 } ddog_Slice_I64;
 
@@ -399,12 +485,15 @@ typedef struct ddog_prof_Label {
   ddog_CharSlice num_unit;
 } ddog_prof_Label;
 
-/**
- * Remember, the data inside of each member is potentially coming from FFI,
- * so every operation on it is unsafe!
- */
 typedef struct ddog_prof_Slice_Label {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
   const struct ddog_prof_Label *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
   uintptr_t len;
 } ddog_prof_Slice_Label;
 
@@ -429,6 +518,18 @@ typedef struct ddog_prof_Sample {
   struct ddog_prof_Slice_Label labels;
 } ddog_prof_Sample;
 
+typedef struct ddog_prof_Slice_Usize {
+  /**
+   * Must be non-null and suitably aligned for the underlying type.
+   */
+  const uintptr_t *ptr;
+  /**
+   * The number of elements (not bytes) that `.ptr` points to. Must be less
+   * than or equal to [isize::MAX].
+   */
+  uintptr_t len;
+} ddog_prof_Slice_Usize;
+
 typedef struct ddog_prof_EncodedProfile {
   struct ddog_Timespec start;
   struct ddog_Timespec end;
@@ -453,6 +554,114 @@ typedef struct ddog_prof_Profile_SerializeResult {
   };
 } ddog_prof_Profile_SerializeResult;
 
+typedef enum ddog_ConfigurationOrigin {
+  DDOG_CONFIGURATION_ORIGIN_ENV_VAR,
+  DDOG_CONFIGURATION_ORIGIN_CODE,
+  DDOG_CONFIGURATION_ORIGIN_DD_CONFIG,
+  DDOG_CONFIGURATION_ORIGIN_REMOTE_CONFIG,
+  DDOG_CONFIGURATION_ORIGIN_DEFAULT,
+} ddog_ConfigurationOrigin;
+
+typedef enum ddog_LogLevel {
+  DDOG_LOG_LEVEL_ERROR,
+  DDOG_LOG_LEVEL_WARN,
+  DDOG_LOG_LEVEL_DEBUG,
+} ddog_LogLevel;
+
+typedef enum ddog_MetricNamespace {
+  DDOG_METRIC_NAMESPACE_TRACERS,
+  DDOG_METRIC_NAMESPACE_PROFILERS,
+  DDOG_METRIC_NAMESPACE_RUM,
+  DDOG_METRIC_NAMESPACE_APPSEC,
+  DDOG_METRIC_NAMESPACE_IDE_PLUGINS,
+  DDOG_METRIC_NAMESPACE_LIVE_DEBUGGER,
+  DDOG_METRIC_NAMESPACE_IAST,
+  DDOG_METRIC_NAMESPACE_GENERAL,
+  DDOG_METRIC_NAMESPACE_TELEMETRY,
+  DDOG_METRIC_NAMESPACE_APM,
+  DDOG_METRIC_NAMESPACE_SIDECAR,
+} ddog_MetricNamespace;
+
+typedef enum ddog_MetricType {
+  DDOG_METRIC_TYPE_GAUGE,
+  DDOG_METRIC_TYPE_COUNT,
+  DDOG_METRIC_TYPE_DISTRIBUTION,
+} ddog_MetricType;
+
+typedef enum ddog_TelemetryWorkerBuilderBoolProperty {
+  DDOG_TELEMETRY_WORKER_BUILDER_BOOL_PROPERTY_CONFIG_TELEMETRY_DEBUG_LOGGING_ENABLED,
+} ddog_TelemetryWorkerBuilderBoolProperty;
+
+typedef enum ddog_TelemetryWorkerBuilderEndpointProperty {
+  DDOG_TELEMETRY_WORKER_BUILDER_ENDPOINT_PROPERTY_CONFIG_ENDPOINT,
+} ddog_TelemetryWorkerBuilderEndpointProperty;
+
+typedef enum ddog_TelemetryWorkerBuilderStrProperty {
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_APPLICATION_SERVICE_VERSION,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_APPLICATION_ENV,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_APPLICATION_RUNTIME_NAME,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_APPLICATION_RUNTIME_VERSION,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_APPLICATION_RUNTIME_PATCHES,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_HOST_CONTAINER_ID,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_HOST_OS,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_HOST_KERNEL_NAME,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_HOST_KERNEL_RELEASE,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_HOST_KERNEL_VERSION,
+  DDOG_TELEMETRY_WORKER_BUILDER_STR_PROPERTY_RUNTIME_ID,
+} ddog_TelemetryWorkerBuilderStrProperty;
+
+typedef struct ddog_TelemetryWorkerBuilder ddog_TelemetryWorkerBuilder;
+
+/**
+ * TelemetryWorkerHandle is a handle which allows interactions with the telemetry worker.
+ * The handle is safe to use across threads.
+ *
+ * The worker won't send data to the agent until you call `TelemetryWorkerHandle::send_start`
+ *
+ * To stop the worker, call `TelemetryWorkerHandle::send_stop` which trigger flush aynchronously
+ * then `TelemetryWorkerHandle::wait_for_shutdown`
+ */
+typedef struct ddog_TelemetryWorkerHandle ddog_TelemetryWorkerHandle;
+
+typedef enum ddog_Option_VecU8_Tag {
+  DDOG_OPTION_VEC_U8_SOME_VEC_U8,
+  DDOG_OPTION_VEC_U8_NONE_VEC_U8,
+} ddog_Option_VecU8_Tag;
+
+typedef struct ddog_Option_VecU8 {
+  ddog_Option_VecU8_Tag tag;
+  union {
+    struct {
+      struct ddog_Vec_U8 some;
+    };
+  };
+} ddog_Option_VecU8;
+
+typedef struct ddog_Option_VecU8 ddog_MaybeError;
+
+typedef enum ddog_Option_Bool_Tag {
+  DDOG_OPTION_BOOL_SOME_BOOL,
+  DDOG_OPTION_BOOL_NONE_BOOL,
+} ddog_Option_Bool_Tag;
+
+typedef struct ddog_Option_Bool {
+  ddog_Option_Bool_Tag tag;
+  union {
+    struct {
+      bool some;
+    };
+  };
+} ddog_Option_Bool;
+
+typedef struct ddog_ContextKey {
+  uint32_t _0;
+  enum ddog_MetricType _1;
+} ddog_ContextKey;
+
+#ifdef __cplusplus
+extern "C" {
+#endif // __cplusplus
+
 /**
  * # Safety
  * Only pass null or a valid reference to a `ddog_Error`.
@@ -467,6 +676,17 @@ void ddog_Error_drop(struct ddog_Error *error);
  */
 ddog_CharSlice ddog_Error_message(const struct ddog_Error *error);
 
+DDOG_CHECK_RETURN struct ddog_Endpoint *ddog_endpoint_from_url(ddog_CharSlice url);
+
+DDOG_CHECK_RETURN struct ddog_Endpoint *ddog_endpoint_from_api_key(ddog_CharSlice api_key);
+
+DDOG_CHECK_RETURN
+struct ddog_Error *ddog_endpoint_from_api_key_and_site(ddog_CharSlice api_key,
+                                                       ddog_CharSlice site,
+                                                       struct ddog_Endpoint **endpoint);
+
+void ddog_endpoint_drop(struct ddog_Endpoint*);
+
 DDOG_CHECK_RETURN struct ddog_Vec_Tag ddog_Vec_Tag_new(void);
 
 void ddog_Vec_Tag_drop(struct ddog_Vec_Tag);
@@ -493,4 +713,8 @@ struct ddog_Vec_Tag_PushResult ddog_Vec_Tag_push(struct ddog_Vec_Tag *vec,
  */
 DDOG_CHECK_RETURN struct ddog_Vec_Tag_ParseResult ddog_Vec_Tag_parse(ddog_CharSlice string);
 
+#ifdef __cplusplus
+} // extern "C"
+#endif // __cplusplus
+
 #endif /* DDOG_COMMON_H */