[PATCH proxmox v2 02/14] pbs-api-types: add types for fine-grained datastore usage statistics

[Christian Ebner <c.ebner@proxmox.com>]

Defines the api types for chunk data usage statistics to be used on
datastore, namespace, group and snapshot hierarchy levels, as well
as the list type to fetch these per-level usage statistics via the
api.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 pbs-api-types/src/datastore.rs | 97 ++++++++++++++++++++++++++++++++++
 1 file changed, 97 insertions(+)

diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
index 93ccaf07..05baa1b3 100644
--- a/pbs-api-types/src/datastore.rs
+++ b/pbs-api-types/src/datastore.rs
@@ -1582,6 +1582,103 @@ pub struct NamespaceListItem {
     pub comment: Option<String>,
 }
 
+#[api(
+    properties: {
+        "raw-size": {
+            type: Integer,
+        },
+        "logical-size": {
+            type: Integer,
+        },
+        "unique-raw-size": {
+            type: Integer,
+        },
+        "reference-count": {
+            type: Integer,
+        },
+        "unique-count": {
+            type: Integer,
+        },
+        "dedup-count": {
+            type: Integer,
+        },
+    }
+)]
+#[derive(Default, Serialize, Deserialize, Clone, PartialEq)]
+#[serde(rename_all = "kebab-case")]
+/// Usage statistics for datastores, namespaces, groups and snapshots.
+pub struct StoreUsageStatistics {
+    /// On disk size of all referenced chunks
+    pub raw_size: u64,
+    /// Logical size of all referenced chunks
+    pub logical_size: u64,
+    /// On disk size of all unique chunks
+    pub unique_raw_size: u64,
+    /// Count of all chunks being referenced
+    pub reference_count: u64,
+    /// Count of unique chunks being referenced
+    pub unique_count: u64,
+    /// Count of chunks with multiple references
+    pub dedup_count: u64,
+}
+
+impl StoreUsageStatistics {
+    /// Account for storage usage by chunk
+    pub fn add(&mut self, raw: u64, logical: u64, unique: bool) {
+        self.raw_size += raw;
+        self.logical_size += logical;
+        self.reference_count += 1;
+        if unique {
+            self.unique_count += 1;
+            self.unique_raw_size += raw;
+        } else {
+            self.dedup_count += 1;
+        }
+    }
+}
+
+#[api(
+    properties: {
+        "ns": {
+            type: BackupNamespace,
+            optional: true,
+        },
+        "backup-type": {
+            type: BackupType,
+            optional: true,
+        },
+        "backup-id": {
+            schema: BACKUP_ID_SCHEMA,
+            optional: true,
+        },
+        "backup-time": {
+            schema: BACKUP_TIME_SCHEMA,
+            optional: true,
+        },
+        "stats": {
+            type: StoreUsageStatistics
+        },
+    },
+)]
+#[derive(Serialize, Deserialize, Clone, PartialEq)]
+#[serde(rename_all = "kebab-case")]
+/// Basic information about a backup group.
+pub struct StatisticsListItem {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ns: Option<BackupNamespace>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[serde(rename = "backup-type")]
+    pub ty: Option<BackupType>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[serde(rename = "backup-id")]
+    pub id: Option<String>,
+    #[serde(rename = "backup-time")]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub time: Option<i64>,
+    #[serde(flatten)]
+    pub stats: StoreUsageStatistics,
+}
+
 #[api(
     properties: {
         "backup": { type: BackupDir },
-- 
2.47.3