Add bindings for the pinned metrics

Author: aumetra

go.mod

@@ -12,6 +12,8 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/kr/pretty v0.1.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
+	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -17,6 +17,10 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/vmihailenco/msgpack/v5 v5.4.1 h1:cQriyiUvjTwOHg8QZaPihLWeRAAVoCpE00IUPn0Bjt8=
+github.com/vmihailenco/msgpack/v5 v5.4.1/go.mod h1:GaZTsDaehaPpQVyxrf5mtQlH+pc21PIudVV/E3rRQok=
+github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
+github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds=
 golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
 golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

internal/api/bindings.h

@@ -441,6 +441,8 @@ struct AnalysisReport analyze_code(struct cache_t *cache,
 
 struct Metrics get_metrics(struct cache_t *cache, struct UnmanagedVector *error_msg);
 
+struct UnmanagedVector get_pinned_metrics(struct cache_t *cache, struct UnmanagedVector *error_msg);
+
 /**
  * frees a cache reference
  *

internal/api/lib.go

@@ -14,6 +14,7 @@ import (
 	"golang.org/x/sys/unix"
 
 	"github.com/CosmWasm/wasmvm/v2/types"
+	"github.com/vmihailenco/msgpack/v5"
 )
 
 // Value types
@@ -190,6 +191,21 @@ func GetMetrics(cache Cache) (*types.Metrics, error) {
 	}, nil
 }
 
+func GetPinnedMetrics(cache Cache) (*types.PinnedMetrics, error) {
+	errmsg := uninitializedUnmanagedVector()
+	metrics, err := C.get_pinned_metrics(cache.ptr, &errmsg)
+	if err != nil {
+		return nil, errorWithMessage(err, errmsg)
+	}
+
+	var pinnedMetrics types.PinnedMetrics
+	if err := msgpack.Unmarshal(copyAndDestroyUnmanagedVector(metrics), &pinnedMetrics); err != nil {
+		return nil, err
+	}
+
+	return &pinnedMetrics, nil
+}
+
 func Instantiate(
 	cache Cache,
 	checksum []byte,

libwasmvm/Cargo.lock

@@ -29,6 +29,8 @@ backtraces = []
 cosmwasm-std = { git = "https://github.com/CosmWasm/cosmwasm.git", rev = "v2.1.0-rc.1", features = ["staking", "stargate", "iterator"] }
 cosmwasm-vm = { git = "https://github.com/CosmWasm/cosmwasm.git", rev = "v2.1.0-rc.1", features = ["staking", "stargate", "iterator"] }
 errno = "0.3.8"
+rmp-serde = "1.1.2"
+serde = { version = "1.0.103", features = ["derive"] }
 serde_json = "1.0.91"
 thiserror = "1.0.38"
 hex = "0.4.3"

libwasmvm/Cargo.toml

@@ -441,6 +441,8 @@ struct AnalysisReport analyze_code(struct cache_t *cache,
 
 struct Metrics get_metrics(struct cache_t *cache, struct UnmanagedVector *error_msg);
 
+struct UnmanagedVector get_pinned_metrics(struct cache_t *cache, struct UnmanagedVector *error_msg);
+
 /**
  * frees a cache reference
  *

libwasmvm/bindings.h

@@ -5,6 +5,7 @@ use std::str::from_utf8;
 
 use cosmwasm_std::Checksum;
 use cosmwasm_vm::{capabilities_from_csv, Cache, CacheOptions, Size};
+use serde::Serialize;
 
 use crate::api::GoApi;
 use crate::args::{AVAILABLE_CAPABILITIES_ARG, CACHE_ARG, CHECKSUM_ARG, DATA_DIR_ARG, WASM_ARG};
@@ -415,6 +416,64 @@ fn do_get_metrics(cache: &mut Cache<GoApi, GoStorage, GoQuerier>) -> Result<Metr
     Ok(cache.metrics().into())
 }
 
+#[derive(Serialize)]
+struct PerModuleMetrics {
+    hits: u32,
+    size: usize,
+}
+
+impl From<cosmwasm_vm::PerModuleMetrics> for PerModuleMetrics {
+    fn from(value: cosmwasm_vm::PerModuleMetrics) -> Self {
+        Self {
+            hits: value.hits,
+            size: value.size,
+        }
+    }
+}
+
+#[derive(Serialize)]
+struct PinnedMetrics {
+    per_module: Vec<(Checksum, PerModuleMetrics)>,
+}
+
+impl From<cosmwasm_vm::PinnedMetrics> for PinnedMetrics {
+    fn from(value: cosmwasm_vm::PinnedMetrics) -> Self {
+        Self {
+            per_module: value
+                .per_module
+                .iter()
+                .cloned()
+                .map(|(checksum, metrics)| (checksum, metrics.into()))
+                .collect(),
+        }
+    }
+}
+
+#[no_mangle]
+pub extern "C" fn get_pinned_metrics(
+    cache: *mut cache_t,
+    error_msg: Option<&mut UnmanagedVector>,
+) -> UnmanagedVector {
+    let r = match to_cache(cache) {
+        Some(c) => {
+            catch_unwind(AssertUnwindSafe(move || do_get_pinned_metrics(c))).unwrap_or_else(|err| {
+                eprintln!("Panic in do_get_pinned_metrics: {err:?}");
+                Err(Error::panic())
+            })
+        }
+        None => Err(Error::unset_arg(CACHE_ARG)),
+    };
+    handle_c_error_default(r, error_msg)
+}
+
+fn do_get_pinned_metrics(
+    cache: &mut Cache<GoApi, GoStorage, GoQuerier>,
+) -> Result<UnmanagedVector, Error> {
+    let pinned_metrics = PinnedMetrics::from(cache.pinned_metrics());
+    let edgerunner = rmp_serde::to_vec_named(&pinned_metrics)?;
+    Ok(UnmanagedVector::new(Some(edgerunner)))
+}
+
 /// frees a cache reference
 ///
 /// # Safety

libwasmvm/src/cache.rs

@@ -22,6 +22,12 @@ pub enum RustError {
         #[cfg(feature = "backtraces")]
         backtrace: Backtrace,
     },
+    #[error("Cannot serialize to MessagePack: {msg}")]
+    MessagePack {
+        msg: String,
+        #[cfg(feature = "backtraces")]
+        backtrace: Backtrace,
+    },
     #[error("Ran out of gas")]
     OutOfGas {
         #[cfg(feature = "backtraces")]
@@ -68,6 +74,14 @@ impl RustError {
         }
     }
 
+    pub fn message_pack<S: ToString>(msg: S) -> Self {
+        RustError::MessagePack {
+            msg: msg.to_string(),
+            #[cfg(feature = "backtraces")]
+            backtrace: Backtrace::capture(),
+        }
+    }
+
     pub fn panic() -> Self {
         RustError::Panic {
             #[cfg(feature = "backtraces")]
@@ -121,6 +135,12 @@ impl From<ChecksumError> for RustError {
     }
 }
 
+impl From<rmp_serde::encode::Error> for RustError {
+    fn from(source: rmp_serde::encode::Error) -> Self {
+        RustError::message_pack(source)
+    }
+}
+
 impl From<std::str::Utf8Error> for RustError {
     fn from(source: std::str::Utf8Error) -> Self {
         RustError::invalid_utf8(source)

libwasmvm/src/error/rust.rs

@@ -189,6 +189,15 @@ type Metrics struct {
 	SizeMemoryCache uint64
 }
 
+type PerModuleMetrics struct {
+	Hits uint32
+	Size uint64
+}
+
+type PinnedMetrics struct {
+	PerModule PerModuleMetrics `json:"per_module"`
+}
+
 // Array is a wrapper around a slice that ensures that we get "[]" JSON for nil values.
 // When unmarshaling, we get an empty slice for "[]" and "null".
 //