[vminitd]: api for trim filesystem operations (#700)

Addition of `vminitd` API for trim filesystem operations

Closes #773

Depends on #685

Author: saehejkang

Sources/Containerization/SandboxContext/SandboxContext.pb.swift

@@ -1054,6 +1054,41 @@ public struct Com_Apple_Containerization_Sandbox_V3_StatResponse: @unchecked Sen
   fileprivate var _storage = _StorageClass.defaultInstance
 }
 
+public struct Com_Apple_Containerization_Sandbox_V3_FiTrimParams: Sendable {
+  // SwiftProtobuf.Message conformance is added in an extension below. See the
+  // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
+  // methods supported on all messages.
+
+  public var schedule: Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneOf_Schedule? = nil
+
+  public var oneShot: Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot {
+    get {
+      if case .oneShot(let v)? = schedule {return v}
+      return Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot()
+    }
+    set {schedule = .oneShot(newValue)}
+  }
+
+  public var unknownFields = SwiftProtobuf.UnknownStorage()
+
+  public enum OneOf_Schedule: Equatable, Sendable {
+    case oneShot(Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot)
+
+  }
+
+  public struct OneShot: Sendable {
+    // SwiftProtobuf.Message conformance is added in an extension below. See the
+    // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
+    // methods supported on all messages.
+
+    public var unknownFields = SwiftProtobuf.UnknownStorage()
+
+    public init() {}
+  }
+
+  public init() {}
+}
+
 public struct Com_Apple_Containerization_Sandbox_V3_FiFreezeParams: Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
@@ -1074,6 +1109,18 @@ public struct Com_Apple_Containerization_Sandbox_V3_FiThawParams: Sendable {
   public init() {}
 }
 
+public struct Com_Apple_Containerization_Sandbox_V3_FiTrimResult: Sendable {
+  // SwiftProtobuf.Message conformance is added in an extension below. See the
+  // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
+  // methods supported on all messages.
+
+  public var trimmedBytes: UInt64 = 0
+
+  public var unknownFields = SwiftProtobuf.UnknownStorage()
+
+  public init() {}
+}
+
 public struct Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest: Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
@@ -1083,6 +1130,14 @@ public struct Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest:
 
   public var operation: Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest.OneOf_Operation? = nil
 
+  public var trim: Com_Apple_Containerization_Sandbox_V3_FiTrimParams {
+    get {
+      if case .trim(let v)? = operation {return v}
+      return Com_Apple_Containerization_Sandbox_V3_FiTrimParams()
+    }
+    set {operation = .trim(newValue)}
+  }
+
   public var freeze: Com_Apple_Containerization_Sandbox_V3_FiFreezeParams {
     get {
       if case .freeze(let v)? = operation {return v}
@@ -1102,6 +1157,7 @@ public struct Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest:
   public var unknownFields = SwiftProtobuf.UnknownStorage()
 
   public enum OneOf_Operation: Equatable, Sendable {
+    case trim(Com_Apple_Containerization_Sandbox_V3_FiTrimParams)
     case freeze(Com_Apple_Containerization_Sandbox_V3_FiFreezeParams)
     case thaw(Com_Apple_Containerization_Sandbox_V3_FiThawParams)
 
@@ -1115,8 +1171,23 @@ public struct Com_Apple_Containerization_Sandbox_V3_FilesystemOperationResponse:
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
   // methods supported on all messages.
 
+  public var result: Com_Apple_Containerization_Sandbox_V3_FilesystemOperationResponse.OneOf_Result? = nil
+
+  public var trim: Com_Apple_Containerization_Sandbox_V3_FiTrimResult {
+    get {
+      if case .trim(let v)? = result {return v}
+      return Com_Apple_Containerization_Sandbox_V3_FiTrimResult()
+    }
+    set {result = .trim(newValue)}
+  }
+
   public var unknownFields = SwiftProtobuf.UnknownStorage()
 
+  public enum OneOf_Result: Equatable, Sendable {
+    case trim(Com_Apple_Containerization_Sandbox_V3_FiTrimResult)
+
+  }
+
   public init() {}
 }
 
@@ -3247,6 +3318,71 @@ extension Com_Apple_Containerization_Sandbox_V3_StatResponse: SwiftProtobuf.Mess
   }
 }
 
+extension Com_Apple_Containerization_Sandbox_V3_FiTrimParams: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
+  public static let protoMessageName: String = _protobuf_package + ".FiTrimParams"
+  public static let _protobuf_nameMap = SwiftProtobuf._NameMap(bytecode: "\0\u{3}one_shot\0")
+
+  public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
+    while let fieldNumber = try decoder.nextFieldNumber() {
+      // The use of inline closures is to circumvent an issue where the compiler
+      // allocates stack space for every case branch when no optimizations are
+      // enabled. https://github.com/apple/swift-protobuf/issues/1034
+      switch fieldNumber {
+      case 1: try {
+        var v: Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot?
+        var hadOneofValue = false
+        if let current = self.schedule {
+          hadOneofValue = true
+          if case .oneShot(let m) = current {v = m}
+        }
+        try decoder.decodeSingularMessageField(value: &v)
+        if let v = v {
+          if hadOneofValue {try decoder.handleConflictingOneOf()}
+          self.schedule = .oneShot(v)
+        }
+      }()
+      default: break
+      }
+    }
+  }
+
+  public func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
+    // The use of inline closures is to circumvent an issue where the compiler
+    // allocates stack space for every if/case branch local when no optimizations
+    // are enabled. https://github.com/apple/swift-protobuf/issues/1034 and
+    // https://github.com/apple/swift-protobuf/issues/1182
+    try { if case .oneShot(let v)? = self.schedule {
+      try visitor.visitSingularMessageField(value: v, fieldNumber: 1)
+    } }()
+    try unknownFields.traverse(visitor: &visitor)
+  }
+
+  public static func ==(lhs: Com_Apple_Containerization_Sandbox_V3_FiTrimParams, rhs: Com_Apple_Containerization_Sandbox_V3_FiTrimParams) -> Bool {
+    if lhs.schedule != rhs.schedule {return false}
+    if lhs.unknownFields != rhs.unknownFields {return false}
+    return true
+  }
+}
+
+extension Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
+  public static let protoMessageName: String = Com_Apple_Containerization_Sandbox_V3_FiTrimParams.protoMessageName + ".OneShot"
+  public static let _protobuf_nameMap = SwiftProtobuf._NameMap()
+
+  public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
+    // Load everything into unknown fields
+    while try decoder.nextFieldNumber() != nil {}
+  }
+
+  public func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
+    try unknownFields.traverse(visitor: &visitor)
+  }
+
+  public static func ==(lhs: Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot, rhs: Com_Apple_Containerization_Sandbox_V3_FiTrimParams.OneShot) -> Bool {
+    if lhs.unknownFields != rhs.unknownFields {return false}
+    return true
+  }
+}
+
 extension Com_Apple_Containerization_Sandbox_V3_FiFreezeParams: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
   public static let protoMessageName: String = _protobuf_package + ".FiFreezeParams"
   public static let _protobuf_nameMap = SwiftProtobuf._NameMap()
@@ -3285,9 +3421,39 @@ extension Com_Apple_Containerization_Sandbox_V3_FiThawParams: SwiftProtobuf.Mess
   }
 }
 
+extension Com_Apple_Containerization_Sandbox_V3_FiTrimResult: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
+  public static let protoMessageName: String = _protobuf_package + ".FiTrimResult"
+  public static let _protobuf_nameMap = SwiftProtobuf._NameMap(bytecode: "\0\u{3}trimmed_bytes\0")
+
+  public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
+    while let fieldNumber = try decoder.nextFieldNumber() {
+      // The use of inline closures is to circumvent an issue where the compiler
+      // allocates stack space for every case branch when no optimizations are
+      // enabled. https://github.com/apple/swift-protobuf/issues/1034
+      switch fieldNumber {
+      case 1: try { try decoder.decodeSingularUInt64Field(value: &self.trimmedBytes) }()
+      default: break
+      }
+    }
+  }
+
+  public func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
+    if self.trimmedBytes != 0 {
+      try visitor.visitSingularUInt64Field(value: self.trimmedBytes, fieldNumber: 1)
+    }
+    try unknownFields.traverse(visitor: &visitor)
+  }
+
+  public static func ==(lhs: Com_Apple_Containerization_Sandbox_V3_FiTrimResult, rhs: Com_Apple_Containerization_Sandbox_V3_FiTrimResult) -> Bool {
+    if lhs.trimmedBytes != rhs.trimmedBytes {return false}
+    if lhs.unknownFields != rhs.unknownFields {return false}
+    return true
+  }
+}
+
 extension Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
   public static let protoMessageName: String = _protobuf_package + ".FilesystemOperationRequest"
-  public static let _protobuf_nameMap = SwiftProtobuf._NameMap(bytecode: "\0\u{1}path\0\u{1}freeze\0\u{1}thaw\0")
+  public static let _protobuf_nameMap = SwiftProtobuf._NameMap(bytecode: "\0\u{1}path\0\u{1}trim\0\u{1}freeze\0\u{1}thaw\0")
 
   public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
     while let fieldNumber = try decoder.nextFieldNumber() {
@@ -3297,6 +3463,19 @@ extension Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest: Swif
       switch fieldNumber {
       case 1: try { try decoder.decodeSingularStringField(value: &self.path) }()
       case 2: try {
+        var v: Com_Apple_Containerization_Sandbox_V3_FiTrimParams?
+        var hadOneofValue = false
+        if let current = self.operation {
+          hadOneofValue = true
+          if case .trim(let m) = current {v = m}
+        }
+        try decoder.decodeSingularMessageField(value: &v)
+        if let v = v {
+          if hadOneofValue {try decoder.handleConflictingOneOf()}
+          self.operation = .trim(v)
+        }
+      }()
+      case 3: try {
         var v: Com_Apple_Containerization_Sandbox_V3_FiFreezeParams?
         var hadOneofValue = false
         if let current = self.operation {
@@ -3309,7 +3488,7 @@ extension Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest: Swif
           self.operation = .freeze(v)
         }
       }()
-      case 3: try {
+      case 4: try {
         var v: Com_Apple_Containerization_Sandbox_V3_FiThawParams?
         var hadOneofValue = false
         if let current = self.operation {
@@ -3336,13 +3515,17 @@ extension Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest: Swif
       try visitor.visitSingularStringField(value: self.path, fieldNumber: 1)
     }
     switch self.operation {
+    case .trim?: try {
+      guard case .trim(let v)? = self.operation else { preconditionFailure() }
+      try visitor.visitSingularMessageField(value: v, fieldNumber: 2)
+    }()
     case .freeze?: try {
       guard case .freeze(let v)? = self.operation else { preconditionFailure() }
-      try visitor.visitSingularMessageField(value: v, fieldNumber: 2)
+      try visitor.visitSingularMessageField(value: v, fieldNumber: 3)
     }()
     case .thaw?: try {
       guard case .thaw(let v)? = self.operation else { preconditionFailure() }
-      try visitor.visitSingularMessageField(value: v, fieldNumber: 3)
+      try visitor.visitSingularMessageField(value: v, fieldNumber: 4)
     }()
     case nil: break
     }
@@ -3359,18 +3542,45 @@ extension Com_Apple_Containerization_Sandbox_V3_FilesystemOperationRequest: Swif
 
 extension Com_Apple_Containerization_Sandbox_V3_FilesystemOperationResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
   public static let protoMessageName: String = _protobuf_package + ".FilesystemOperationResponse"
-  public static let _protobuf_nameMap = SwiftProtobuf._NameMap()
+  public static let _protobuf_nameMap = SwiftProtobuf._NameMap(bytecode: "\0\u{1}trim\0")
 
   public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
-    // Load everything into unknown fields
-    while try decoder.nextFieldNumber() != nil {}
+    while let fieldNumber = try decoder.nextFieldNumber() {
+      // The use of inline closures is to circumvent an issue where the compiler
+      // allocates stack space for every case branch when no optimizations are
+      // enabled. https://github.com/apple/swift-protobuf/issues/1034
+      switch fieldNumber {
+      case 1: try {
+        var v: Com_Apple_Containerization_Sandbox_V3_FiTrimResult?
+        var hadOneofValue = false
+        if let current = self.result {
+          hadOneofValue = true
+          if case .trim(let m) = current {v = m}
+        }
+        try decoder.decodeSingularMessageField(value: &v)
+        if let v = v {
+          if hadOneofValue {try decoder.handleConflictingOneOf()}
+          self.result = .trim(v)
+        }
+      }()
+      default: break
+      }
+    }
   }
 
   public func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
+    // The use of inline closures is to circumvent an issue where the compiler
+    // allocates stack space for every if/case branch local when no optimizations
+    // are enabled. https://github.com/apple/swift-protobuf/issues/1034 and
+    // https://github.com/apple/swift-protobuf/issues/1182
+    try { if case .trim(let v)? = self.result {
+      try visitor.visitSingularMessageField(value: v, fieldNumber: 1)
+    } }()
     try unknownFields.traverse(visitor: &visitor)
   }
 
   public static func ==(lhs: Com_Apple_Containerization_Sandbox_V3_FilesystemOperationResponse, rhs: Com_Apple_Containerization_Sandbox_V3_FilesystemOperationResponse) -> Bool {
+    if lhs.result != rhs.result {return false}
     if lhs.unknownFields != rhs.unknownFields {return false}
     return true
   }

Sources/Containerization/SandboxContext/SandboxContext.proto

@@ -294,18 +294,34 @@ message StatResponse {
   string error = 2; // Non-empty if stat failed.
 }
 
+message FiTrimParams {
+  oneof schedule {
+    OneShot one_shot = 1;
+  }
+
+  message OneShot {}
+}
 message FiFreezeParams {}
 message FiThawParams {}
 
+message FiTrimResult {
+  uint64 trimmed_bytes = 1;
+}
+
 message FilesystemOperationRequest {
   string path = 1;
   oneof operation {
-    FiFreezeParams freeze = 2;
-    FiThawParams thaw = 3;
+    FiTrimParams trim = 2;
+    FiFreezeParams freeze = 3;
+    FiThawParams thaw = 4;
   }
 }
 
-message FilesystemOperationResponse {}
+message FilesystemOperationResponse {
+  oneof result {
+    FiTrimResult trim = 1;
+  }
+}
 
 message IpLinkSetRequest {
   string interface = 1;

Sources/Containerization/VirtualMachineAgent.swift

@@ -28,6 +28,7 @@ public struct WriteFileFlags {
 public enum FilesystemOperation: Sendable {
     case freeze
     case thaw
+    case trim
 }
 
 /// A protocol for the agent running inside a virtual machine. If an operation isn't

Sources/Containerization/Vminitd.swift

@@ -631,6 +631,11 @@ extension FilesystemOperation {
             return .freeze(.init())
         case .thaw:
             return .thaw(.init())
+        case .trim:
+            return .trim(
+                .with {
+                    $0.oneShot = .init()
+                })
         }
     }
 }