Create unpacker protocol + ext4 unpacker #151
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // Copyright © 2025 Apple Inc. and the Containerization project authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import ContainerizationError | ||
| import ContainerizationExtras | ||
| import ContainerizationOCI | ||
| import Foundation | ||
|
|
||
| #if os(macOS) | ||
| import ContainerizationArchive | ||
| import ContainerizationEXT4 | ||
| import SystemPackage | ||
| #endif | ||
|
|
||
| public struct EXT4Unpacker: Unpacker { | ||
| let blockSizeInBytes: UInt64 | ||
|
|
||
| public init(blockSizeInBytes: UInt64) { | ||
| self.blockSizeInBytes = blockSizeInBytes | ||
| } | ||
|
|
||
| public func unpack(_ image: Image, for platform: Platform, at path: URL, progress: ProgressHandler? = nil) async throws -> Mount { | ||
| #if !os(macOS) | ||
| throw ContainerizationError(.unsupported, message: "Cannot unpack an image on current platform") | ||
| #else | ||
| let blockPath = try prepareUnpackPath(path: path) | ||
| let manifest = try await image.manifest(for: platform) | ||
| let filesystem = try EXT4.Formatter(FilePath(path), minDiskSize: blockSizeInBytes) | ||
| defer { try? filesystem.close() } | ||
|
|
||
| for layer in manifest.layers { | ||
| try Task.checkCancellation() | ||
| let content = try await image.getContent(digest: layer.digest) | ||
|
|
||
| switch layer.mediaType { | ||
| case MediaTypes.imageLayer, MediaTypes.dockerImageLayer: | ||
| try filesystem.unpack( | ||
| source: content.path, | ||
| format: .paxRestricted, | ||
| compression: .none, | ||
| progress: progress | ||
| ) | ||
| case MediaTypes.imageLayerGzip, MediaTypes.dockerImageLayerGzip: | ||
| try filesystem.unpack( | ||
| source: content.path, | ||
| format: .paxRestricted, | ||
| compression: .gzip, | ||
| progress: progress | ||
| ) | ||
| default: | ||
| throw ContainerizationError(.unsupported, message: "Media type \(layer.mediaType) not supported.") | ||
| } | ||
| } | ||
|
|
||
| return .block( | ||
| format: "ext4", | ||
| source: blockPath, | ||
| destination: "/", | ||
| options: [] | ||
| ) | ||
| #endif | ||
| } | ||
|
|
||
| private func prepareUnpackPath(path: URL) throws -> String { | ||
| let blockPath = path.absolutePath() | ||
| guard !FileManager.default.fileExists(atPath: blockPath) else { | ||
| throw ContainerizationError(.exists, message: "block device already exists at \(blockPath)") | ||
| } | ||
| return blockPath | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // Copyright © 2025 Apple Inc. and the Containerization project authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import ContainerizationExtras | ||
| import ContainerizationOCI | ||
| import Foundation | ||
|
|
||
| /// The `Unpacker` protocol defines a standardized interface that involves | ||
| /// decompressing, extracting image layers and preparing it for use. | ||
| /// | ||
| /// The `Unpacker` is responsible for managing the lifecycle of the | ||
| /// unpacking process, including any temporary files or resources, until the | ||
| /// `Mount` object is produced. | ||
| protocol Unpacker { | ||
|
|
||
| /// Unpacks the provided image to a specified path for a given platform. | ||
| /// | ||
| /// This asynchronous method should handle the entire unpacking process, from reading | ||
| /// the `Image` layers for the given `Platform` via its `Manifest`, | ||
| /// to making the extracted contents available as a `Mount`. | ||
| /// Implementations of this method may apply platform-specific optimizations | ||
| /// or transformations during the unpacking. | ||
| /// | ||
| /// Progress updates can be observed via the optional `progress` handler. | ||
| func unpack(_ image: Image, for platform: Platform, at path: URL, progress: ProgressHandler?) async throws -> Mount | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Given both the unpacks are the exact same besides whether they supply compression or not, can we just assign a compression variable in the switch cases and then do the unpack outside of it?