feat(io-engine/api/cksum): add wipe checksum

Checksums a replica which can be used to verify data between volume replicas. For speed sake we're reusing the existing wipe replicas as it's a very good fit for this and we can reuse the entire infra around it. todo: consider renaming wipe etc Signed-off-by: Tiago Castro <[email protected]>
openebs · Dec 7, 2023 · 2757a85 · 2757a85
1 parent b591fb0
commit 2757a85
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 7 deletions.
diff --git a/apis/io-engine/protobuf/v1/test.proto b/apis/io-engine/protobuf/v1/test.proto
@@ -43,19 +43,28 @@ message WipeReplicaRequest {
 message WipeOptions {
   enum WipeMethod {
     // Don't actually wipe, just pretend.
-    NONE                        = 0;
+    NONE          = 0;
     // Wipe by writing zeroes.
-    WRITE_ZEROES                = 1;
+    WRITE_ZEROES  = 1;
     // Wipe by sending unmap/trim.
-    UNMAP                       = 2;
+    UNMAP         = 2;
     // Wipe by writing a given patter (see write_pattern(6) field).
-    WRITE_PATTERN               = 3;
+    WRITE_PATTERN = 3;
+    // Checksum the bdev.
+    CHECKSUM      = 4;
   }
   // Method used to wipe the bdev.
   WipeMethod        wipe_method = 1;
   // When using WRITE_PATTERN, wipe using this 32bit write pattern
   // Default: 0xDEADBEEF.
   optional uint32 write_pattern = 2;
+
+  enum CheckSumAlgorithm {
+    // The CRC32C is a variant of CRC32.
+    Crc32c = 0;
+  }
+  // When using CHECKSUM, use the following algorithm.
+  CheckSumAlgorithm   cksum_alg = 3;
 }
 
 message StreamWipeOptions {
@@ -88,6 +97,11 @@ message WipeReplicaResponse {
   uint64         remaining_bytes = 8;
   // Duration since the start of the wipe.
   google.protobuf.Duration since = 9;
+  // When using CHECKSUM, output of the algorithm.
+  oneof checksum {
+    // 32bit CRC.
+    uint32 crc32                = 10;
+  }
 }
 
 message FaultInjection {

diff --git a/apis/io-engine/src/v1.rs b/apis/io-engine/src/v1.rs
@@ -109,9 +109,10 @@ pub mod test {
     pub use super::pb::{
         test_rpc_client::TestRpcClient,
         test_rpc_server::{TestRpc, TestRpcServer},
-        wipe_options, wipe_replica_request, AddFaultInjectionRequest, FaultInjection,
-        ListFaultInjectionsReply, ListFaultInjectionsRequest, RemoveFaultInjectionRequest,
-        StreamWipeOptions, WipeOptions, WipeReplicaRequest, WipeReplicaResponse,
+        wipe_options, wipe_replica_request, wipe_replica_response, AddFaultInjectionRequest,
+        FaultInjection, ListFaultInjectionsReply, ListFaultInjectionsRequest,
+        RemoveFaultInjectionRequest, StreamWipeOptions, WipeOptions, WipeReplicaRequest,
+        WipeReplicaResponse,
     };
 }