containerization-framework 0.4.0

Rust bindings for Apple's Containerization framework: Linux containers in lightweight VMs, in-process and without a daemon.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
//===----------------------------------------------------------------------===//
// `ImageStore`, `Image`, `InitImage` and `KernelImage`, from Containerization.
//===----------------------------------------------------------------------===//

import Containerization
import Foundation

import struct ContainerizationOCI.Platform

func openImageStore(path: RustStr) -> CzOutcome {
  let path = URL(filePath: path.toString())

  return CzOutcome { CzImageStore(try ImageStore(path: path)) }
}

func defaultImageStore() -> CzOutcome {
  CzOutcome { CzImageStore(ImageStore.default) }
}

// Made from the content store they take, which swift-bridge can't pass as an
// argument.
extension CzLocalContentStore {
  func imageStore(path: RustStr) -> CzOutcome {
    let path = URL(filePath: path.toString())
    let store = store

    return CzOutcome { CzImageStore(try ImageStore(path: path, contentStore: store)) }
  }

  func image(description: RustImageDescription) -> CzImage {
    CzImage(Image(description: Image.Description(description), contentStore: store))
  }
}

final class CzImageStore: Sendable {
  let store: ImageStore

  init(_ store: ImageStore) {
    self.store = store
  }

  func path() -> String {
    store.path.path(percentEncoded: false)
  }

  func get(reference: RustStr, pull: Bool) -> CzOutcome {
    let reference = reference.toString()
    let store = store

    return CzOutcome { CzImage(try blocking { try await store.get(reference: reference, pull: pull) }) }
  }

  func list() -> CzOutcome {
    let store = store

    return CzOutcome { CzImages(try blocking { try await store.list() }) }
  }

  func delete(reference: RustStr, performCleanup: Bool) -> CzOutcome {
    let reference = reference.toString()
    let store = store

    return CzOutcome { try blocking { try await store.delete(reference: reference, performCleanup: performCleanup) } }
  }

  func tag(existing: RustStr, new: RustStr) -> CzOutcome {
    let existing = existing.toString()
    let new = new.toString()
    let store = store

    return CzOutcome { CzImage(try blocking { try await store.tag(existing: existing, new: new) }) }
  }

  func pull(
    reference: RustStr,
    hasPlatform: Bool,
    platform: RustPlatform,
    insecure: Bool,
    auth: CzAuthentication,
    progress: RustProgressHandler,
    maxConcurrentDownloads: UInt
  ) -> CzOutcome {
    let reference = reference.toString()
    let platform = hasPlatform ? Platform(platform) : nil
    let auth = auth.authentication
    let progress = progressHandler(progress)
    let store = store

    return CzOutcome {
      CzImage(
        try blocking {
          try await store.pull(
            reference: reference,
            platform: platform,
            insecure: insecure,
            auth: auth,
            progress: progress,
            maxConcurrentDownloads: Int(maxConcurrentDownloads)
          )
        })
    }
  }

  func push(
    reference: RustStr,
    hasPlatform: Bool,
    platform: RustPlatform,
    insecure: Bool,
    auth: CzAuthentication,
    progress: RustProgressHandler
  ) -> CzOutcome {
    let reference = reference.toString()
    let platform = hasPlatform ? Platform(platform) : nil
    let auth = auth.authentication
    let progress = progressHandler(progress)
    let store = store

    return CzOutcome {
      try blocking {
        try await store.push(
          reference: reference, platform: platform, insecure: insecure, auth: auth, progress: progress)
      }
    }
  }

  func pushAll(
    references: RustVec<RustString>,
    hasPlatform: Bool,
    platform: RustPlatform,
    insecure: Bool,
    auth: CzAuthentication,
    maxConcurrentUploads: UInt,
    progress: RustProgressHandler
  ) -> CzOutcome {
    let references = strings(references)
    let platform = hasPlatform ? Platform(platform) : nil
    let auth = auth.authentication
    let progress = progressHandler(progress)
    let store = store

    return CzOutcome {
      try blocking {
        try await store.push(
          references: references,
          platform: platform,
          insecure: insecure,
          auth: auth,
          maxConcurrentUploads: Int(maxConcurrentUploads),
          progress: progress
        )
      }
    }
  }

  func getInitImage(reference: RustStr, auth: CzAuthentication, progress: RustProgressHandler) -> CzOutcome {
    let reference = reference.toString()
    let auth = auth.authentication
    let progress = progressHandler(progress)
    let store = store

    return CzOutcome {
      CzInitImage(try blocking { try await store.getInitImage(reference: reference, auth: auth, progress: progress) })
    }
  }

  func save(references: RustVec<RustString>, out: RustStr, hasPlatform: Bool, platform: RustPlatform) -> CzOutcome {
    let references = strings(references)
    let out = URL(filePath: out.toString())
    let platform = hasPlatform ? Platform(platform) : nil
    let store = store

    return CzOutcome { try blocking { try await store.save(references: references, out: out, platform: platform) } }
  }

  func cleanUpOrphanedBlobs() -> CzOutcome {
    let store = store

    return CzOutcome {
      let (deleted, freed) = try blocking { try await store.cleanUpOrphanedBlobs() }
      return (deleted, freed)
    }
  }

  func calculateOrphanedBlobsSize() -> CzOutcome {
    let store = store

    return CzOutcome { try blocking { try await store.calculateOrphanedBlobsSize() } }
  }

  func create(description: RustImageDescription) -> CzOutcome {
    let description = Image.Description(description)
    let store = store

    return CzOutcome { CzImage(try blocking { try await store.create(description: description) }) }
  }

  func load(from: RustStr, progress: RustProgressHandler) -> CzOutcome {
    let directory = URL(filePath: from.toString())
    let progress = progressHandler(progress)
    let store = store

    return CzOutcome { CzImages(try blocking { try await store.load(from: directory, progress: progress) }) }
  }

  func createInitImage(
    reference: RustStr,
    rootfs: RustStr,
    platform: RustPlatform,
    labelKeys: RustVec<RustString>,
    labelValues: RustVec<RustString>,
    contentStore: CzLocalContentStore
  ) -> CzOutcome {
    let reference = reference.toString()
    let rootfs = URL(filePath: rootfs.toString())
    let platform = Platform(platform)
    let labels = dictionary(labelKeys, labelValues)
    let contentStore = contentStore.store
    let store = store

    return CzOutcome {
      CzInitImage(
        try blocking {
          try await InitImage.create(
            reference: reference,
            rootfs: rootfs,
            platform: platform,
            labels: labels,
            imageStore: store,
            contentStore: contentStore
          )
        })
    }
  }

  func createKernelImage(
    reference: RustStr,
    binaries: RustVec<RustKernel>,
    labelKeys: RustVec<RustString>,
    labelValues: RustVec<RustString>,
    contentStore: CzLocalContentStore
  ) -> CzOutcome {
    let reference = reference.toString()
    let labels = dictionary(labelKeys, labelValues)
    let contentStore = contentStore.store
    let store = store

    return CzOutcome {
      let binaries = try binaries.map { try Kernel($0) }

      return CzKernelImage(
        try blocking {
          try await KernelImage.create(
            reference: reference,
            binaries: binaries,
            labels: labels,
            imageStore: store,
            contentStore: contentStore
          )
        })
    }
  }
}

/// An `[Image]`, by index.
final class CzImages {
  let images: [Image]

  init(_ images: [Image]) {
    self.images = images
  }

  func len() -> UInt {
    UInt(images.count)
  }

  func at(index: UInt) -> CzImage {
    CzImage(images[Int(index)])
  }
}

final class CzImage: Sendable {
  let image: Image

  init(_ image: Image) {
    self.image = image
  }

  /// Another handle on the same image, to pass where Rust would lend one.
  func duplicate() -> CzImage {
    CzImage(image)
  }

  func reference() -> String {
    image.reference
  }

  func digest() -> String {
    image.digest
  }

  func mediaType() -> String {
    image.mediaType
  }

  /// `descriptor`, which doesn't throw: Rust reads it without asking `error`.
  func descriptor() -> CzOutcome {
    CzOutcome.holding(image.descriptor)
  }

  func index() -> CzOutcome {
    let image = image

    return CzOutcome { try blocking { try await image.index() } }
  }

  func manifest(platform: RustPlatform) -> CzOutcome {
    let platform = Platform(platform)
    let image = image

    return CzOutcome { try blocking { try await image.manifest(for: platform) } }
  }

  func descriptorFor(platform: RustPlatform) -> CzOutcome {
    let platform = Platform(platform)
    let image = image

    return CzOutcome { try blocking { try await image.descriptor(for: platform) } }
  }

  func config(platform: RustPlatform) -> CzOutcome {
    let platform = Platform(platform)
    let image = image

    return CzOutcome { try blocking { try await image.config(for: platform) } }
  }

  func referencedDigests() -> CzOutcome {
    let image = image

    return CzOutcome { try blocking { try await image.referencedDigests() } }
  }

  func getContent(digest: RustStr) -> CzOutcome {
    let digest = digest.toString()
    let image = image

    return CzOutcome { CzContent(try blocking { try await image.getContent(digest: digest) }) }
  }

  func initImage() -> CzInitImage {
    CzInitImage(InitImage(image: image))
  }

  func kernelImage() -> CzKernelImage {
    CzKernelImage(KernelImage(image: image))
  }
}

final class CzKernelImage: Sendable {
  let image: KernelImage

  init(_ image: KernelImage) {
    self.image = image
  }

  func name() -> String {
    image.name
  }

  func kernel(platform: RustSystemPlatform) -> CzOutcome {
    let image = image

    return CzOutcome {
      let platform = try SystemPlatform(platform)

      return try blocking { try await image.kernel(for: platform) }
    }
  }
}

func kernelImageMediaType() -> String {
  KernelImage.mediaType
}

extension CzOutcome {
  func kernelImage() -> CzKernelImage { taken() }

  // A `Kernel`, field by field: Rust builds its own.

  func kernelPath() -> String {
    (taken() as Kernel).path.path(percentEncoded: false)
  }

  func kernelPlatformOs() -> PlatformOs {
    switch (taken() as Kernel).platform.os {
    case .linux: .Linux
    case .darwin: .Darwin
    }
  }

  func kernelPlatformArchitecture() -> PlatformArchitecture {
    switch (taken() as Kernel).platform.architecture {
    case .arm64: .Arm64
    case .amd64: .Amd64
    }
  }

  func kernelKernelArgs() -> RustVec<RustString> {
    rustStrings((taken() as Kernel).commandLine.kernelArgs)
  }

  func kernelInitArgs() -> RustVec<RustString> {
    rustStrings((taken() as Kernel).commandLine.initArgs)
  }
}

final class CzInitImage: Sendable {
  let image: InitImage

  init(_ image: InitImage) {
    self.image = image
  }

  func name() -> String {
    image.name
  }

  func initBlock(at: RustStr, platform: RustSystemPlatform) -> CzOutcome {
    let at = URL(filePath: at.toString())
    let image = image

    return CzOutcome {
      let platform = try SystemPlatform(platform)

      return try blocking { try await image.initBlock(at: at, for: platform) }
    }
  }
}