From 414988087168a1404e035c000d498f08a903f66a Mon Sep 17 00:00:00 2001
From: Simon Marchi <simon.marchi@efficios.com>
Date: Fri, 27 Sep 2024 16:10:34 -0400
Subject: [PATCH] ctf: make parseMetadataStream() output the metadata version

Add a `metadataVersion` field to `ParseRet`, allowing users of this
class to know the metadata version, after successfully parsing a
metadata file.

Change-Id: I5fdeab715d8146744b743c4be1dc9d44ac1a70e6
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/13295
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
---
 .../src/metadata/json/ctf-2-metadata-stream-parser.cpp     | 2 +-
 .../common/src/metadata/metadata-stream-parser-utils.hpp   | 6 ------
 .../ctf/common/src/metadata/metadata-stream-parser.hpp     | 7 +++++++
 .../src/metadata/tsdl/ctf-1-metadata-stream-parser.cpp     | 2 +-
 4 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/src/plugins/ctf/common/src/metadata/json/ctf-2-metadata-stream-parser.cpp b/src/plugins/ctf/common/src/metadata/json/ctf-2-metadata-stream-parser.cpp
index c1e6d8df..1a6a0a0c 100644
--- a/src/plugins/ctf/common/src/metadata/json/ctf-2-metadata-stream-parser.cpp
+++ b/src/plugins/ctf/common/src/metadata/json/ctf-2-metadata-stream-parser.cpp
@@ -66,7 +66,7 @@ Ctf2MetadataStreamParser::parse(const bt2::OptionalBorrowedObject<bt2::SelfCompo
             parser._mLogger, bt2::Error, "Missing data stream class fragment in metadata stream.");
     }
 
-    return {parser.releaseTraceCls(), parser.metadataStreamUuid()};
+    return {parser.releaseTraceCls(), parser.metadataStreamUuid(), MetadataStreamMajorVersion::V2};
 }
 
 void Ctf2MetadataStreamParser::_parseSection(const bt2c::ConstBytes buffer)
diff --git a/src/plugins/ctf/common/src/metadata/metadata-stream-parser-utils.hpp b/src/plugins/ctf/common/src/metadata/metadata-stream-parser-utils.hpp
index 41816338..0981c209 100644
--- a/src/plugins/ctf/common/src/metadata/metadata-stream-parser-utils.hpp
+++ b/src/plugins/ctf/common/src/metadata/metadata-stream-parser-utils.hpp
@@ -18,12 +18,6 @@
 namespace ctf {
 namespace src {
 
-enum class MetadataStreamMajorVersion
-{
-    V1 = 1,
-    V2,
-};
-
 /*
  * Returns the major CTF version (1 or 2) of the metadata stream
  * in `buffer`.
diff --git a/src/plugins/ctf/common/src/metadata/metadata-stream-parser.hpp b/src/plugins/ctf/common/src/metadata/metadata-stream-parser.hpp
index 7ea2f73c..97834d04 100644
--- a/src/plugins/ctf/common/src/metadata/metadata-stream-parser.hpp
+++ b/src/plugins/ctf/common/src/metadata/metadata-stream-parser.hpp
@@ -21,6 +21,12 @@
 namespace ctf {
 namespace src {
 
+enum class MetadataStreamMajorVersion
+{
+    V1 = 1,
+    V2,
+};
+
 /*
  * Abstract base CTF metadata stream parser class.
  */
@@ -36,6 +42,7 @@ public:
     {
         std::unique_ptr<TraceCls> traceCls;
         bt2s::optional<bt2c::Uuid> uuid;
+        MetadataStreamMajorVersion metadataVersion;
     };
 
 protected:
diff --git a/src/plugins/ctf/common/src/metadata/tsdl/ctf-1-metadata-stream-parser.cpp b/src/plugins/ctf/common/src/metadata/tsdl/ctf-1-metadata-stream-parser.cpp
index 7500fad1..121d6fb0 100644
--- a/src/plugins/ctf/common/src/metadata/tsdl/ctf-1-metadata-stream-parser.cpp
+++ b/src/plugins/ctf/common/src/metadata/tsdl/ctf-1-metadata-stream-parser.cpp
@@ -707,7 +707,7 @@ Ctf1MetadataStreamParser::parse(const bt2::OptionalBorrowedObject<bt2::SelfCompo
     Ctf1MetadataStreamParser parser {selfComp, clkClsCfg, parentLogger};
 
     parser.parseSection(buffer);
-    return {parser.releaseTraceCls(), parser.metadataStreamUuid()};
+    return {parser.releaseTraceCls(), parser.metadataStreamUuid(), MetadataStreamMajorVersion::V1};
 }
 
 } /* namespace src */
-- 
2.34.1