Metadata memory layout refactor

CMakeLists.txt

@@ -81,6 +81,7 @@ if(${CMAKE_PROJECT_NAME} STREQUAL ${PROJECT_NAME})
   # Build executables
   add_executable(metrics_simple examples/metrics_simple.cpp)
   target_link_libraries(metrics_simple abacus)
+  target_link_libraries(metrics_simple steinwurf::endian)
   target_link_libraries(metrics_simple steinwurf::protobuf)
 
   enable_testing()
@@ -107,4 +108,23 @@ if(${CMAKE_PROJECT_NAME} STREQUAL ${PROJECT_NAME})
     steinwurf::protobuf)
 
   add_test(abacus_tests abacus_tests)
+
+  # Google Benchmark dependency
+  set(BENCHMARK_ENABLE_TESTING
+    OFF
+    CACHE INTERNAL "Disable gbenchmark test" FORCE)
+
+  if(NOT TARGET benchmark)
+    add_subdirectory("${STEINWURF_RESOLVE}/gbenchmark-source")
+  endif()
+
+  # Build benchmark executable
+  file(GLOB_RECURSE abacus_benchmark_sources ./benchmark/main.cpp)
+  add_executable(abacus_benchmark ${abacus_benchmark_sources})
+  target_link_libraries(abacus_benchmark benchmark)
+  target_link_libraries(abacus_benchmark
+    steinwurf::abacus
+    steinwurf::endian
+    steinwurf::bourne
+    steinwurf::protobuf)
 endif()

NEWS.rst

@@ -6,7 +6,14 @@ every change, see the Git log.
 
 Latest
 ------
-* tbd
+* Major: Changed protocol format to version 2.
+* Minor: Added benchmark.
+* Major: Changed the metadata to be specified using protobuf.
+* Major: Changed API of how metrics are specified. All attributes are now
+  strongly typed, and specified using a std::map of abacus::name to abacus::info.
+* Minor: Added support for enums.
+* Minor: Added support for constants.
+* Minor: Added support for more metric types: int32, uint32, float32, and enum8.
 
 6.0.1
 -----

benchmark/main.cpp

@@ -0,0 +1,142 @@
+#include <abacus/metrics.hpp>
+#include <benchmark/benchmark.h>
+#include <map>
+#include <string>
+
+enum class test_enum
+{
+    value0 = 0,
+    value1 = 1,
+    value2 = 2,
+    value3 = 3
+};
+
+// Helper function to create metric definitions
+std::map<abacus::name, abacus::info> create_metric_infos()
+{
+    return {
+        {abacus::name{"0"}, abacus::boolean{abacus::description{""}}},
+        {abacus::name{"1"},
+         abacus::uint64{abacus::kind::gauge, abacus::description{""}}},
+        {abacus::name{"2"},
+         abacus::int64{abacus::kind::gauge, abacus::description{""}}},
+        {abacus::name{"3"},
+         abacus::float64{abacus::kind::gauge, abacus::description{""}}},
+        {abacus::name{"4"}, abacus::boolean{abacus::description{""}}},
+        {abacus::name{"5"},
+         abacus::float64{abacus::kind::gauge, abacus::description{""}}},
+        {abacus::name{"6"}, abacus::enum8{abacus::description{""},
+                                          {{test_enum::value0, {"", ""}},
+                                           {test_enum::value1, {"", ""}},
+                                           {test_enum::value2, {"", ""}},
+                                           {test_enum::value3, {"", ""}}}}}};
+}
+
+// Benchmark for metric initialization
+static void BM_MetricInitialization(benchmark::State& state)
+{
+    state.SetLabel("Metric Initialization");
+    for (auto _ : state)
+    {
+        abacus::metrics metrics(create_metric_infos());
+        auto m0 = metrics.initialize<abacus::boolean>("0").set_value(false);
+        auto m1 = metrics.initialize<abacus::uint64>("1").set_value(0);
+        auto m2 = metrics.initialize<abacus::int64>("2").set_value(0);
+        auto m3 = metrics.initialize<abacus::float64>("3").set_value(0.0);
+        auto m4 = metrics.initialize<abacus::boolean>("4").set_value(true);
+        auto m5 = metrics.initialize<abacus::float64>("5").set_value(3.14);
+        auto m6 =
+            metrics.initialize<abacus::enum8>("6").set_value(test_enum::value1);
+
+        (void)m0;
+        (void)m1;
+        (void)m2;
+        (void)m3;
+        (void)m4;
+        (void)m5;
+        (void)m6;
+    }
+    state.SetItemsProcessed(state.iterations());
+}
+
+// Benchmark for assignment operations
+static void BM_AssignMetrics(benchmark::State& state)
+{
+    state.SetLabel("Assign Metrics");
+    abacus::metrics metrics(create_metric_infos());
+    auto m0 = metrics.initialize<abacus::boolean>("0").set_value(false);
+    auto m1 = metrics.initialize<abacus::uint64>("1").set_value(0);
+    auto m2 = metrics.initialize<abacus::int64>("2").set_value(0);
+    auto m3 = metrics.initialize<abacus::float64>("3").set_value(0.0);
+    auto m4 = metrics.initialize<abacus::boolean>("4").set_value(true);
+    auto m5 = metrics.initialize<abacus::float64>("5").set_value(3.14);
+    auto m6 =
+        metrics.initialize<abacus::enum8>("6").set_value(test_enum::value1);
+
+    for (auto _ : state)
+    {
+        m0 = true;
+        m1 += 1;
+        m2 -= 1;
+        ++m3;
+        m4 = false;
+        --m5;
+        m6 = 4;
+    }
+
+    state.SetItemsProcessed(state.iterations());
+}
+
+// Benchmark for accessing metrics
+static void BM_AccessMetrics(benchmark::State& state)
+{
+    state.SetLabel("Access Metrics");
+    abacus::metrics metrics(create_metric_infos());
+    auto m0 = metrics.initialize<abacus::boolean>("0").set_value(false);
+    auto m1 = metrics.initialize<abacus::uint64>("1").set_value(0);
+    auto m2 = metrics.initialize<abacus::int64>("2").set_value(0);
+    auto m3 = metrics.initialize<abacus::float64>("3").set_value(0.0);
+
+    for (auto _ : state)
+    {
+        bool val0 = m0.value();
+        uint64_t val1 = m1.value();
+        int64_t val2 = m2.value();
+        double val3 = m3.value();
+
+        benchmark::DoNotOptimize(val0);
+        benchmark::DoNotOptimize(val1);
+        benchmark::DoNotOptimize(val2);
+        benchmark::DoNotOptimize(val3);
+    }
+
+    state.SetItemsProcessed(state.iterations());
+}
+
+// Benchmark for incrementing uint64 metric
+static void BM_IncrementUint64(benchmark::State& state)
+{
+    state.SetLabel("Increment Uint64 Metric");
+    abacus::metrics metrics(create_metric_infos());
+    auto m1 = metrics.initialize<abacus::uint64>("1").set_value(0);
+
+    for (auto _ : state)
+    {
+        m1 += 1;
+    }
+
+    state.SetItemsProcessed(state.iterations());
+}
+
+// Apply custom arguments to all benchmarks
+static void CustomArguments(benchmark::internal::Benchmark* b)
+{
+    b->Unit(benchmark::kMicrosecond);
+}
+
+BENCHMARK(BM_MetricInitialization)->Apply(CustomArguments);
+BENCHMARK(BM_AssignMetrics)->Apply(CustomArguments);
+BENCHMARK(BM_AccessMetrics)->Apply(CustomArguments);
+BENCHMARK(BM_IncrementUint64)->Apply(CustomArguments);
+
+BENCHMARK_MAIN();

docs/conf.py

@@ -22,14 +22,29 @@
 wurfapi = {
     "source_paths": [
         # API
-        "../src/abacus/type.hpp",
-        "../src/abacus/metric.hpp",
-        "../src/abacus/metric_info.hpp",
+        "../src/abacus/boolean.hpp",
+        "../src/abacus/constant.hpp",
+        "../src/abacus/description.hpp",
+        "../src/abacus/enum8.hpp",
+        "../src/abacus/float32.hpp",
+        "../src/abacus/float64.hpp",
+        "../src/abacus/info.hpp",
+        "../src/abacus/int32.hpp",
+        "../src/abacus/int64.hpp",
         "../src/abacus/kind.hpp",
-        "../src/abacus/unit.hpp",
+        "../src/abacus/max.hpp",
+        "../src/abacus/metric.hpp",
         "../src/abacus/metrics.hpp",
-        "../src/abacus/view.hpp",
+        "../src/abacus/min.hpp",
+        "../src/abacus/name.hpp",
+        "../src/abacus/parse_metadata.hpp",
+        "../src/abacus/protocol_version.hpp",
         "../src/abacus/to_json.hpp",
+        "../src/abacus/uint32.hpp",
+        "../src/abacus/uint64.hpp",
+        "../src/abacus/unit.hpp",
+        "../src/abacus/version.hpp",
+        "../src/abacus/view.hpp",
     ],
     "recursive": False,
     "include_paths": ["../src"],

docs/requirements.txt

@@ -115,5 +115,5 @@ versjon==2.3.0
     # via -r docs/requirements.in
 virtualenv==20.17.1
     # via giit
-wurfapi==9.0.0
+wurfapi==9.1.1
     # via -r docs/requirements.in

docs/user_api/description.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::description

docs/user_api/metrics.rst → docs/user_api/max.rst

@@ -1,3 +1,2 @@
 .. wurfapi:: class_synopsis.rst
-    :selector: abacus::metrics
-
+    :selector: abacus::max

docs/user_api/metric_info/boolean.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::boolean

docs/user_api/metric_info/constant.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::constant

docs/user_api/metric_info/enum8.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::enum8

docs/user_api/metric_info/float32.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::float32

docs/user_api/metric_info/float64.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::float64

docs/user_api/metric_info/int32.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::int32

docs/user_api/metric_info/int64.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::int64

docs/user_api/metric_info/metric_info.rst

@@ -0,0 +1,20 @@
+
+.. _metric_specializations:
+
+===========
+Metric Info
+===========
+
+Overview of the metric info types.
+
+.. toctree::
+   :maxdepth: 2
+
+   constant
+   uint64
+   uint32
+   int64
+   int32
+   float64
+   boolean
+   enum8

docs/user_api/metric_info/uint32.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::uint32

docs/user_api/metric_info/uint64.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::uint64

docs/user_api/min.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::min

docs/user_api/name.rst

@@ -0,0 +1,2 @@
+.. wurfapi:: class_synopsis.rst
+    :selector: abacus::name

docs/user_api/user_api.rst

@@ -10,12 +10,13 @@ Overview of the public API.
 .. toctree::
    :maxdepth: 3
 
-   metric
-   metric_specializations/metric_specializations
-   metric_info
-   type
+   metrics
+   name
+   metric_info/metric_info
    kind
+   description
    unit
-   metrics
+   min
+   max
    view
    functions