src.ctf.fs: make ctf_visitor_generate_ir::trace_class a bt2::TraceClass::Shared
[babeltrace.git] / src / plugins / ctf / common / src / metadata / tsdl / decoder.hpp
index 7bb650ca80f7bd33db23956247b9ea13dffe982f..b4dbce875dcb0d33a772eb2fb075ee1ae3338696 100644 (file)
@@ -7,12 +7,19 @@
 #ifndef _METADATA_DECODER_H
 #define _METADATA_DECODER_H
 
-#include <stdint.h>
 #include <stdio.h>
 
 #include <babeltrace2/babeltrace.h>
 
 #include "common/uuid.h"
+#include "cpp-common/bt2/trace-ir.hpp"
+#include "cpp-common/bt2c/logging.hpp"
+#include "cpp-common/vendor/fmt/format.h" /* IWYU pragma: keep */
+
+#include "../../../src/clk-cls-cfg.hpp"
+
+/* A CTF metadata decoder object */
+struct ctf_metadata_decoder;
 
 /* CTF metadata decoder status */
 enum ctf_metadata_decoder_status
@@ -25,23 +32,45 @@ enum ctf_metadata_decoder_status
     CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR = -4,
 };
 
+inline const char *format_as(ctf_metadata_decoder_status status) noexcept
+{
+    switch (status) {
+    case CTF_METADATA_DECODER_STATUS_OK:
+        return "CTF_METADATA_DECODER_STATUS_OK";
+
+    case CTF_METADATA_DECODER_STATUS_NONE:
+        return "CTF_METADATA_DECODER_STATUS_NONE";
+
+    case CTF_METADATA_DECODER_STATUS_ERROR:
+        return "CTF_METADATA_DECODER_STATUS_ERROR";
+
+    case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
+        return "CTF_METADATA_DECODER_STATUS_INCOMPLETE";
+
+    case CTF_METADATA_DECODER_STATUS_INVAL_VERSION:
+        return "CTF_METADATA_DECODER_STATUS_INVAL_VERSION";
+
+    case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR:
+        return "CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR";
+    }
+
+    bt_common_abort();
+}
+
 /* Decoding configuration */
 struct ctf_metadata_decoder_config
 {
-    /* Active log level to use */
-    bt_logging_level log_level = (bt_logging_level) 0;
+    explicit ctf_metadata_decoder_config(const bt2c::Logger& parentLogger) :
+        logger {parentLogger, "PLUGIN/CTF/META/DECODER-CONFIG"}
+    {
+    }
 
-    /*
-     * Component or component class to use for logging (exactly one of
-     * them must be non-`NULL`); weak
-     */
+    bt2c::Logger logger;
+
+    /* Weak, used to create a bt_trace_class, if not nullptr. */
     bt_self_component *self_comp = nullptr;
-    bt_self_component_class *self_comp_class = nullptr;
 
-    /* Additional clock class offset to apply */
-    int64_t clock_class_offset_s = 0;
-    int64_t clock_class_offset_ns = 0;
-    bool force_clock_class_origin_unix_epoch = false;
+    ctf::src::ClkClsCfg clkClsCfg;
 
     /* True to create trace class objects */
     bool create_trace_class = false;
@@ -53,12 +82,19 @@ struct ctf_metadata_decoder_config
     bool keep_plain_text = false;
 };
 
+struct ctf_metadata_decoder_deleter
+{
+    void operator()(struct ctf_metadata_decoder *decoder);
+};
+
+using ctf_metadata_decoder_up = std::unique_ptr<ctf_metadata_decoder, ctf_metadata_decoder_deleter>;
+
 /*
  * Creates a CTF metadata decoder.
  *
  * Returns `NULL` on error.
  */
-struct ctf_metadata_decoder *
+ctf_metadata_decoder_up
 ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config *config);
 
 /*
@@ -98,7 +134,7 @@ ctf_metadata_decoder_append_content(struct ctf_metadata_decoder *metadata_decode
  * Returns `NULL` if there's none yet or if the metadata decoder is not
  * configured to create trace classes.
  */
-bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec);
+bt2::TraceClass::Shared ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec);
 
 /*
  * Returns the CTF IR trace class of this metadata decoder.
@@ -114,12 +150,9 @@ ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder *mdec);
  * packetized, setting `is_packetized` accordingly on success. On
  * success, also sets `*byte_order` to the byte order of the first
  * packet.
- *
- * This function uses `log_level` and `self_comp` for logging purposes.
- * `self_comp` can be `NULL` if not available.
  */
 int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, int *byte_order,
-                                       bt_logging_level log_level, bt_self_component *self_comp);
+                                       const bt2c::Logger& logger);
 
 /*
  * Returns the byte order of the decoder's metadata stream as set by the
This page took 0.024369 seconds and 4 git commands to generate.