Compare commits

..
Author SHA1 Message Date
12 4e58a2a0b9 Fix export overwrite confirmation on EOF (#1342) 2026-09-23 15:10:01 -07:00
Yibo Zhuang f8ce0f9acb Add an option to disable USB accessories (#1338)
* Add an option to disable USB accessories

* Select USB accessories in platform input factories
2026-09-23 12:14:39 -07:00
Yibo Zhuang 6fff37f0e0 Wait for collector in OpenTelemetry integration test (#1335) 2026-09-21 09:10:53 -07:00
Brendan Shanks 89017ff0b3 VMConfig: Save JSON with sorted keys (#1326) 2026-09-16 16:24:50 -07:00
edi-oai acaf3ca7ef ControlSocket: duplicate VirtIO socket connection's file descriptor (#1333) 2026-09-16 11:37:56 +01:00
Sam EstepandClaude Opus 5 9bb2af2434 Run ErrorReportingTask operations on the caller's actor (#1324)
VZVirtualMachine asserts that it is used on the queue it was created with,
which for tart is the main queue. Since #1262 replaced the unstructured Task
in "tart run"'s SIGUSR2 handler with ErrorReportingTask, that assertion fails:
Task.init carries @_inheritActorContext, but ErrorReportingTask.init did not,
so an operation written inside MainActor-isolated Run.runOnMainThread() is formed
in a nonisolated init and runs on the cooperative pool, not the main queue.

The result is that asking a VM to stop gracefully kills it instead. Sending
SIGUSR2, which #842 hooked to requestStop() for exactly this purpose, crashes
the process:

    Thread 1  queue: com.apple.root.default-qos.cooperative
      _dispatch_assert_queue_fail
      dispatch_assert_queue
      -[VZVirtualMachine requestStopWithError:]
      closure in Run.runOnMainThread()
      closure in ErrorReportingTask.init(_:operation:)

The guest then loses power without a chance to flush, and on a Linux guest
with ext4's default delayed allocation that discards whatever had not been
written back yet. The same applies to the requestStop() in
applicationShouldTerminate(), i.e. closing the window of a VM run with a GUI.

Give the operation the same @_inheritActorContext that Task.init has, so that
wrapping a call in ErrorReportingTask no longer changes where it runs.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-09 15:05:42 -07:00
Yibo Zhuang cdb3579c79 Fix control socket paths with special characters (#1328) 2026-09-07 10:40:58 -07:00
Yibo Zhuang 3f15df9e3c Preserve stdout when running Softnet without a control FD (#1329) 2026-09-07 09:37:51 -07:00
Yibo Zhuang 1b4813f210 Preserve running VM directories during replacement (#1321) 2026-09-01 18:20:18 -07:00
Yibo Zhuang c4cf73a819 Pin CI and build actions to full commit SHAs (#1325) 2026-09-02 00:41:44 +00:00
Yibo Zhuang 16d186c253 Add stacked disk integration coverage and documentation (#1316) 2026-08-18 07:16:00 -07:00
Yibo Zhuang 5f8795bd4e Complete stacked disk command support (#1315) 2026-08-17 15:20:50 -07:00
Yibo Zhuang f83cba84af Support stacked VM archive import and export (#1314) 2026-08-17 14:22:18 -07:00
Yibo Zhuang 32a627c8c5 Make stacked content pruning reference-aware (#1313) 2026-08-17 13:05:07 -07:00
Yibo Zhuang 4162ca1831 Fail VM startup when its control socket cannot bind (#1311) 2026-08-17 11:59:39 +01:00
Yibo Zhuang 4ce8a115f7 Add OCI transport and base clone with DiskImageKit (#1304)
* Add OCI transport and base clone with DiskImageKit

* Address stacked OCI pull review feedback

* Stream file digest hashing

* Lock frozen overlays during push
2026-08-12 12:10:28 -07:00
Yibo Zhuang f87b57bbc5 Begin work on adding DiskImageKit to tart (#1303)
This is first of several changes to add support for the new
DiskImageKit ASIF layers to tart VM images.

This change is focused on laying down the OCI media type for
ASIF layers, content addressable store structure, as well
as the VMDirectory structure for supporting layers.

Add DiskImageStack type to model VM image using DiskImage APIs.
2026-08-11 09:13:25 -07:00
edi-oai a438e2d031 tart {list,get}: display humanized byte units (#1301) 2026-08-05 22:11:37 +01:00
Tor Arne Vestbø 160b7cd692 Build Tart on macOS 26 with Xcode 27 (#1294)
So that we can take advantage of the new provisioning
options (VZMacGuestProvisioningOptions) for macOS 27.
2026-08-04 15:52:45 +01:00
Fedor Kororkov cbc160a592 Pass Softnet policy control FD through Tart (#1287)
* Pass Softnet policy control FD through Tart

* Update Softnet control test for policy set
2026-07-21 22:23:08 +01:00
Fedor Kororkov b9ed1a98f0 Fix Tart release signing (#1286) 2026-07-21 10:12:17 -04:00
Fedor Kororkov 057646cf89 Fix Tart release code signing (#1284) 2026-07-17 14:47:15 -04:00
Nikolai TillmannandClaude Fable 5 512c1c3630 Fix busy loop in tart exec -i after piped stdin reaches EOF (#1281)
Unregister the stdin readabilityHandler when availableData returns empty:
a closed pipe fd stays permanently readable, so Foundation re-invokes the
handler in a tight loop (fstat + zero-byte read) at 100% of one core for
the rest of the command's lifetime.

Fixes #1280

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 08:56:27 -04:00
Fedor Kororkov 9e6e59b379 [codex] Publish Tart to openai/homebrew-tools (#1277)
* Publish Tart to openai/homebrew-tools

* Write Tart formula under Formula directory

* Use macOS 26 runners

* docs: install Tart tools from OpenAI tap

* Add required GitHub Actions test check

* Fix hosted tests and notarization credentials
2026-07-16 21:32:18 -04:00
Greg Hurrell 32d084e9ed fix(homebrew): wrap macOS version dependency in on_macos block (#1264)
GoReleaser's Homebrew template always emits a bare `depends_on :macos`
for macOS-only formulae. Combining that with the `depends_on :macos =>
:ventura` line injected via custom_block triggers a Homebrew deprecation
warning on `brew upgrade`:

  Warning: Calling `depends_on :macos` with `depends_on macos:` is deprecated! Use `depends_on :macos` with `depends_on macos:` inside an `on_macos` block instead.
  Please report this issue to the cirruslabs/homebrew-cli tap (not Homebrew/* repositories), or even better, submit a PR to fix it:
    /opt/homebrew/Library/Taps/cirruslabs/homebrew-cli/tart.rb:22

Declaring the version constraint inside an `on_macos` block is the form
Homebrew recommends and silences the warning without changing behavior
(still macOS-only, Ventura or newer).
2026-06-15 18:25:38 -04:00
Tor Arne Vestbø 0a01a4430c Fix build warnings (#1262)
* Use let for the immutable disk image storage attachment

* Don't bind the unused error when catching connection-pool failures

* Report errors thrown inside tart run's fire-and-forget tasks

We were discarding any error thrown inside these unstructured tasks,
which silently hid failures to run the control socket or to start and
stop the VM, and which the compiler now warns about.

Wrap them in an ErrorReportingTask, which spawns the task and reports
any thrown error to stderr, rather than repeating a do/catch at every
call site. An unstructured task spawned from a synchronous context (a
signal handler or SwiftUI action) has no parent to propagate the error
to, so reporting it is the best we can do.

* Avoid blocking SwiftNIO calls in async guest agent connections

The gRPC channel setup in "tart exec" and the MAC address resolver
created a dedicated event loop group and tore both it and the channel
down with the blocking syncShutdownGracefully() and wait(), which are
unavailable from async contexts (the former is an error in the Swift 6
language mode).

Factor the connection out into a withGuestAgentChannel() helper that
uses the process-wide singleton event loop group, so there is no group
to shut down, and closes the channel with the async close().get().
2026-06-09 15:29:19 -07:00
Tor Arne Vestbø d1bfda63fc Add --provisioning-opts flag to provision macOS guests on first boot (#1263)
Exposes Apple's macOS 27 guest provisioning API
(VZMacGuestProvisioningOptions) so a macOS guest can be set up
automatically on the first boot after restore.

The flag takes a comma-separated list of key=value pairs mapping 1:1 to
the API properties (fullName, username, password, logsInAutomatically,
enablesRemoteLogin). It is validated to require a macOS 27+ host and a
macOS VM.

The entire user-facing surface is gated behind
'#if arch(arm64) && compiler(>=6.4)' so the flag doesn't appear in help
on toolchains that lack the macOS 27 SDK, while the runtime
'#available(macOS 27, *)' check gates actual use against the host OS.
2026-06-09 15:18:57 -07:00
Tor Arne Vestbø 2e63759c1b Don't run the AppKit run loop nested in Swift's async main (#1260)
When built against the macOS 27 (Xcode 27, Swift 6.4) SDK, "tart run"
brings up the VM window but the guest never boots.

Swift's asynchronous main() entry point implicitly starts an executor
that owns the main thread, and as of Swift 6.4 that executor is no
longer backed by the Dispatch main queue. Running an AppKit/SwiftUI
run loop nested inside it via MainApp.main() leaves the main run loop
unable to drain Swift tasks or DispatchQueue.main, so the task that
starts the VM is never scheduled, even though the window itself
(driven directly by AppKit during launch) still appears.

We now keep Root.main() synchronous, so that a command driving a run
loop can own the main thread at the top level, exactly like a plain
SwiftUI app. With AppKit owning the loop again, MainActor tasks and
the Dispatch main queue drain as before. Such commands opt in through
a new MainThreadCommand protocol; everything else keeps running
asynchronously via a detached task and dispatchMain().

Verified that the guest boots again, and that Ctrl+C still stops the
VM gracefully.
2026-06-09 09:53:06 -07:00
Fedor Kororkov 6ada2b955d Update README.md 2026-06-05 17:07:07 -07:00
Fedor Kororkov 1ea60ef420 Update docs after OpenAI move (#1240) 2026-06-05 17:05:23 -07:00
Fedor Kororkov 5ad172e7f0 Relicense under FSL-1.1-ALv2 (#1238)
* Relicense under FSL-1.1-ALv2

* Use project lifetime in copyright notice
2026-06-05 15:37:02 -07:00
102 changed files with 6652 additions and 1226 deletions
+24
View File
@@ -0,0 +1,24 @@
#!/bin/sh
set -eu
ARCH="$1"
SCRATCH_PATH=".build/$ARCH"
OUTPUT_PATH=".build/prebuilt/$ARCH"
swift build \
--build-system swiftbuild \
--scratch-path "$SCRATCH_PATH" \
--arch "$ARCH" \
--configuration release \
--product tart
BIN_PATH=$(swift build \
--build-system swiftbuild \
--scratch-path "$SCRATCH_PATH" \
--arch "$ARCH" \
--configuration release \
--show-bin-path)
mkdir -p "$OUTPUT_PATH"
cp "$BIN_PATH/tart" "$OUTPUT_PATH/tart"
+1 -1
View File
@@ -2,7 +2,7 @@
set -e
export VERSION="${CIRRUS_TAG:-0}"
export VERSION="${VERSION:-0}"
mkdir -p .ci/pkg/
cp .build/arm64-apple-macosx/release/tart .ci/pkg/tart
+8 -4
View File
@@ -1,7 +1,11 @@
#!/bin/sh
TMPFILE=$(mktemp)
envsubst < Sources/tart/CI/CI.swift > $TMPFILE
mv $TMPFILE Sources/tart/CI/CI.swift
set -e
/usr/libexec/PlistBuddy -c "Add :CFBundleShortVersionString string ${CIRRUS_TAG}" Resources/Info.plist
: "${VERSION:?VERSION must be set}"
TMPFILE=$(mktemp)
perl -pe 's/\$\{VERSION\}/$ENV{VERSION}/g' Sources/tart/CI/CI.swift > "$TMPFILE"
mv "$TMPFILE" Sources/tart/CI/CI.swift
/usr/libexec/PlistBuddy -c "Add :CFBundleShortVersionString string ${VERSION}" Resources/Info.plist
+41
View File
@@ -0,0 +1,41 @@
#!/bin/sh
set -eu
APP_PATH="dist/tart_darwin_all/tart.app"
if [ "${TART_RELEASE_SNAPSHOT:-false}" = "true" ]; then
codesign \
--force \
--deep \
--sign - \
--entitlements Resources/tart-dev.entitlements \
"$APP_PATH"
else
codesign \
--force \
--verbose \
--sign "Developer ID Application: Cirrus Labs, Inc. (9M2P8L4D89)" \
--timestamp \
--options runtime \
--keychain "$RUNNER_TEMP/build.keychain" \
--entitlements Resources/tart-prod.entitlements \
"$APP_PATH"
fi
codesign --verify --strict --verbose=2 "$APP_PATH"
"$APP_PATH/Contents/MacOS/tart" --version
if [ "${TART_RELEASE_SNAPSHOT:-false}" != "true" ]; then
NOTARIZATION_ARCHIVE="$RUNNER_TEMP/tart-notarization.zip"
ditto -c -k --keepParent "$APP_PATH" "$NOTARIZATION_ARCHIVE"
xcrun notarytool submit "$NOTARIZATION_ARCHIVE" \
--keychain-profile "notarytool" \
--keychain "$RUNNER_TEMP/build.keychain" \
--wait \
--timeout 20m
xcrun stapler staple "$APP_PATH"
xcrun stapler validate "$APP_PATH"
spctl --assess --type execute --verbose=4 "$APP_PATH"
fi
-85
View File
@@ -63,91 +63,6 @@ task:
binary_artifacts:
path: .build/$BUILD_ARCH-apple-macosx/debug/tart
task:
only_if: $CIRRUS_TAG == '' && ($CIRRUS_USER_PERMISSION == 'write' || $CIRRUS_USER_PERMISSION == 'admin')
name: Release (Dry Run)
depends_on:
- lint
- build
macos_instance:
image: ghcr.io/cirruslabs/macos-runner:tahoe
env:
MACOS_CERTIFICATE: ENCRYPTED[552b9d275d1c2bdbc1bff778b104a8f9a53cbd0d59344d4b7f6d0ca3c811a5cefb97bef9ba0ef31c219cb07bdacdd2c2]
AC_PASSWORD: ENCRYPTED[4a761023e7e06fe2eb350c8b6e8e7ca961af193cb9ba47605f25f1d353abc3142606f412e405be48fd897a78787ea8c2]
GITHUB_TOKEN: ENCRYPTED[!98ace8259c6024da912c14d5a3c5c6aac186890a8d4819fad78f3e0c41a4e0cd3a2537dd6e91493952fb056fa434be7c!]
GORELEASER_KEY: ENCRYPTED[!9b80b6ef684ceaf40edd4c7af93014ee156c8aba7e6e5795f41c482729887b5c31f36b651491d790f1f668670888d9fd!]
setup_script:
- cd $HOME
- echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
- security create-keychain -p password101 build.keychain
- security default-keychain -s build.keychain
- security unlock-keychain -p password101 build.keychain
- security import certificate.p12 -k build.keychain -P password101 -T /usr/bin/codesign -T /usr/bin/pkgbuild
- security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k password101 build.keychain
- xcrun notarytool store-credentials "notarytool" --apple-id "hello@cirruslabs.org" --team-id "9M2P8L4D89" --password $AC_PASSWORD
install_script:
- brew install go
- brew install mitchellh/gon/gon
- brew install --cask goreleaser/tap/goreleaser-pro
info_script:
- security find-identity -v
- xcodebuild -version
- swift -version
goreleaser_script: goreleaser release --skip=publish --snapshot --clean
always:
dist_artifacts:
path: "dist/*"
task:
name: Release
only_if: $CIRRUS_TAG != ''
depends_on:
- lint
- build
macos_instance:
image: ghcr.io/cirruslabs/macos-runner:tahoe
env:
MACOS_CERTIFICATE: ENCRYPTED[552b9d275d1c2bdbc1bff778b104a8f9a53cbd0d59344d4b7f6d0ca3c811a5cefb97bef9ba0ef31c219cb07bdacdd2c2]
AC_PASSWORD: ENCRYPTED[4a761023e7e06fe2eb350c8b6e8e7ca961af193cb9ba47605f25f1d353abc3142606f412e405be48fd897a78787ea8c2]
GITHUB_TOKEN: ENCRYPTED[!98ace8259c6024da912c14d5a3c5c6aac186890a8d4819fad78f3e0c41a4e0cd3a2537dd6e91493952fb056fa434be7c!]
GORELEASER_KEY: ENCRYPTED[!9b80b6ef684ceaf40edd4c7af93014ee156c8aba7e6e5795f41c482729887b5c31f36b651491d790f1f668670888d9fd!]
SENTRY_ORG: cirrus-labs
SENTRY_PROJECT: persistent-workers
SENTRY_AUTH_TOKEN: ENCRYPTED[!9eaf2875d51b113e2f68598441ff8e6b2e53242e48fcb93633bd75a373fbe2e7caa900d837cc92f0b142b65579731644!]
setup_script:
- cd $HOME
- echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
- security create-keychain -p password101 build.keychain
- security default-keychain -s build.keychain
- security unlock-keychain -p password101 build.keychain
- security import certificate.p12 -k build.keychain -P password101 -T /usr/bin/codesign -T /usr/bin/pkgbuild
- security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k password101 build.keychain
- xcrun notarytool store-credentials "notarytool" --apple-id "hello@cirruslabs.org" --team-id "9M2P8L4D89" --password $AC_PASSWORD
install_script:
- brew install go getsentry/tools/sentry-cli
- brew install mitchellh/gon/gon
- brew install --cask goreleaser/tap/goreleaser-pro
info_script:
- security find-identity -v
- xcodebuild -version
- swift -version
release_script: goreleaser
upload_sentry_debug_files_script:
- cd .build/arm64-apple-macosx/release/
# Generate and upload symbols
- dsymutil tart
- sentry-cli debug-files upload tart.dSYM/
- SENTRY_PROJECT=tart sentry-cli debug-files upload tart.dSYM/
# Bundle and upload sources
- sentry-cli debug-files bundle-sources tart.dSYM
- sentry-cli debug-files upload tart.src.zip
- SENTRY_PROJECT=tart sentry-cli debug-files upload tart.src.zip
create_sentry_release_script:
- export SENTRY_RELEASE="tart@$CIRRUS_TAG"
- sentry-cli releases new $SENTRY_RELEASE
- sentry-cli releases set-commits $SENTRY_RELEASE --auto
- sentry-cli releases finalize $SENTRY_RELEASE
task:
name: Deploy Documentation
only_if: $CIRRUS_BRANCH == 'main'
+4 -4
View File
@@ -9,10 +9,10 @@ permissions:
jobs:
build_cached:
name: Build tart (cached)
runs-on: ghcr.io/cirruslabs/macos-runner:tahoe
runs-on: xcode-27
timeout-minutes: 30
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5.1.0
- name: Build
run: |
export COMPILATION_CACHE_ENABLE_CACHING=YES
@@ -29,9 +29,9 @@ jobs:
build_no_cache:
name: Build tart (no cache)
runs-on: ghcr.io/cirruslabs/macos-runner:tahoe
runs-on: xcode-27
timeout-minutes: 30
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5.1.0
- name: Build
run: swift build --build-system swiftbuild --product tart
+37
View File
@@ -0,0 +1,37 @@
name: CI
on:
merge_group:
pull_request:
push:
branches:
- main
workflow_dispatch:
permissions:
contents: read
jobs:
test:
name: Test
runs-on: xcode-27
timeout-minutes: 60
steps:
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0
with:
go-version-file: integration-tests/go.mod
cache-dependency-path: integration-tests/go.sum
- name: Build
run: swift build --build-system swiftbuild
- name: Run unit tests
run: |
export PATH="$PATH:/usr/sbin"
swift test --build-system swiftbuild
# The Python suite boots Tart VMs, but hosted ARM macOS runners do not support nested virtualization.
- name: Run OpenTelemetry integration tests
run: |
bin_path="$(swift build --build-system swiftbuild --show-bin-path)"
codesign --sign - --entitlements Resources/tart-dev.entitlements --force "$bin_path/tart"
cd integration-tests
PATH="$bin_path:$PATH" go test -v ./...
+111
View File
@@ -0,0 +1,111 @@
name: Release
on:
push:
tags:
- "*"
workflow_dispatch:
permissions:
contents: read
jobs:
release:
if: github.event_name == 'push' && github.repository == 'openai/tart'
name: Release
runs-on: xcode-27
environment: publish
timeout-minutes: 90
permissions:
contents: read
env:
VERSION: ${{ github.ref_name }}
steps:
- name: Checkout
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
with:
fetch-depth: 0
persist-credentials: false
- name: Import signing certificate
env:
AC_PASSWORD: ${{ secrets.AC_PASSWORD }}
KEYCHAIN_PASSWORD: temporary-password
MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
P12_PASSWORD: password101
run: |
echo "$MACOS_CERTIFICATE" | base64 --decode > "$RUNNER_TEMP/certificate.p12"
security create-keychain -p "$KEYCHAIN_PASSWORD" "$RUNNER_TEMP/build.keychain"
security set-keychain-settings -lut 21600 "$RUNNER_TEMP/build.keychain"
security default-keychain -s "$RUNNER_TEMP/build.keychain"
security unlock-keychain -p "$KEYCHAIN_PASSWORD" "$RUNNER_TEMP/build.keychain"
security import "$RUNNER_TEMP/certificate.p12" \
-k "$RUNNER_TEMP/build.keychain" \
-P "$P12_PASSWORD" \
-T /usr/bin/codesign \
-T /usr/bin/pkgbuild
security set-key-partition-list \
-S apple-tool:,apple:,codesign: \
-s \
-k "$KEYCHAIN_PASSWORD" \
"$RUNNER_TEMP/build.keychain"
security list-keychain -d user -s "$RUNNER_TEMP/build.keychain"
xcrun notarytool store-credentials "notarytool" \
--apple-id "hello@cirruslabs.org" \
--team-id "9M2P8L4D89" \
--password "$AC_PASSWORD" \
--keychain "$RUNNER_TEMP/build.keychain"
- name: Create release app token for this repo
id: app-token
uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
with:
app-id: ${{ secrets.RELEASE_APP_ID }}
private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
permission-contents: write
- name: Create release app token for homebrew-tools
id: tap-token
uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
with:
app-id: ${{ secrets.RELEASE_APP_ID }}
private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
owner: openai
repositories: homebrew-tools
permission-contents: write
permission-pull-requests: write
- name: Release
uses: goreleaser/goreleaser-action@f06c13b6b1a9625abc9e6e439d9c05a8f2190e94 # v7
with:
distribution: goreleaser-pro
version: "~> v2"
args: release --clean
env:
GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
HOMEBREW_TAP_GITHUB_TOKEN: ${{ steps.tap-token.outputs.token }}
snapshot:
if: github.event_name == 'workflow_dispatch'
name: Release (Dry Run)
runs-on: xcode-27
timeout-minutes: 90
permissions:
contents: read
env:
TART_RELEASE_SNAPSHOT: "true"
VERSION: snapshot
steps:
- name: Checkout
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
with:
fetch-depth: 0
persist-credentials: false
- name: Build snapshot
uses: goreleaser/goreleaser-action@f06c13b6b1a9625abc9e6e439d9c05a8f2190e94 # v7
with:
distribution: goreleaser-pro
version: "~> v2"
args: release --skip=publish --snapshot --clean
- name: Upload snapshot artifacts
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
name: tart-snapshot
path: dist/*
+18 -10
View File
@@ -5,8 +5,8 @@ project_name: tart
before:
hooks:
- .ci/set-version.sh
- swift build --arch arm64 --configuration release --product tart
- swift build --arch x86_64 --configuration release --product tart
- sh .ci/build-release.sh arm64
- sh .ci/build-release.sh x86_64
builds:
- id: tart
@@ -19,7 +19,7 @@ builds:
- amd64
binary: tart.app/Contents/MacOS/tart
prebuilt:
path: '.build/{{- if eq .Arch "arm64" }}arm64{{- else }}x86_64{{ end }}-apple-macosx/release/tart'
path: '.build/prebuilt/{{- if eq .Arch "arm64" }}arm64{{- else }}x86_64{{ end }}/tart'
universal_binaries:
- name_template: tart.app/Contents/MacOS/tart
@@ -30,7 +30,8 @@ universal_binaries:
- cp Resources/embedded.provisionprofile dist/tart_darwin_all/tart.app/Contents/
- cp Resources/Info.plist dist/tart_darwin_all/tart.app/Contents/
- cp "Resources/actool/UPW Tart.icns" "Resources/actool/Assets.car" dist/tart_darwin_all/tart.app/Contents/Resources/
- gon gon.hcl
- cmd: .ci/sign-release.sh
output: true
archives:
- name_template: "{{ .ProjectName }}"
@@ -52,9 +53,14 @@ release:
brews:
- name: tart
directory: Formula
repository:
owner: cirruslabs
name: homebrew-cli
owner: openai
name: homebrew-tools
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
branch: "tart-{{ .Version }}"
pull_request:
enabled: true
caveats: |
Tart has been installed. You might want to reduce the default DHCP lease time
from 86,400 to 600 seconds to avoid DHCP shortage when running lots of VMs daily:
@@ -62,17 +68,19 @@ brews:
sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.InternetSharing.default.plist bootpd -dict DHCPLeaseTimeSecs -int 600
See https://tart.run/faq/#changing-the-default-dhcp-lease-time for more details.
homepage: https://github.com/cirruslabs/tart
license: "Fair Source"
homepage: https://github.com/openai/tart
license: FSL-1.1-ALv2
description: Run macOS and Linux VMs on Apple Hardware
skip_upload: auto
dependencies:
- "cirruslabs/cli/softnet"
- "openai/tools/softnet"
install: |
libexec.install Dir["*"]
bin.write_exec_script "#{libexec}/tart.app/Contents/MacOS/tart"
custom_block: |
depends_on :macos => :ventura
on_macos do
depends_on :macos => :ventura
end
def post_install
generate_completions_from_executable(libexec/"tart.app/Contents/MacOS/tart", "--generate-completion-script")
end
+1 -1
View File
@@ -20,7 +20,7 @@ Table of Contents
```
## How to Create an Issue/Enhancement
1. Go to the [Issue page](https://github.com/cirruslabs/tart/issues) of the repository
1. Go to the [Issue page](https://github.com/openai/tart/issues) of the repository
2. Click on the "New Issue" button
3. Provide a descriptive title and detailed description of the issue or enhancement you're suggesting
4. Submit the issue
+95 -35
View File
@@ -1,45 +1,105 @@
Fair Source License, version 0.9
# Functional Source License, Version 1.1, ALv2 Future License
Copyright (C) 2023 Cirrus Labs, Inc.
## Abbreviation
Licensor: Cirrus Labs, Inc.
FSL-1.1-ALv2
Software: Tart
## Notice
Use Limitation: 100 users. User is defined as a single core of a central processing unit (CPU) used by the product.
The Use Limitation does not apply to CPUs installed in devices used by a single individual.
Copyright 2022-2026 OpenAI
License Grant. Licensor hereby grants to each recipient of the
Software ("you") a non-exclusive, non-transferable, royalty-free and
fully-paid-up license, under all of the Licensor's copyright and
patent rights, to use, copy, distribute, prepare derivative works of,
publicly perform and display the Software, subject to the Use
Limitation and the conditions set forth below.
## Terms and Conditions
Use Limitation. The license granted above allows use by up to the
number of users per entity set forth above (the "Use Limitation"). For
determining the number of users, "you" includes all affiliates,
meaning legal entities controlling, controlled by, or under common
control with you. If you exceed the Use Limitation, your use is
subject to payment of Licensor's then-current list price for licenses.
### Licensor ("We")
Conditions. Redistribution in source code or other forms must include
a copy of this license document to be provided in a reasonable
manner. Any redistribution of the Software is only allowed subject to
this license.
The party offering the Software under these Terms and Conditions.
Trademarks. This license does not grant you any right in the
trademarks, service marks, brand names or logos of Licensor.
### The Software
DISCLAIMER. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OR
CONDITION, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. LICENSORS HEREBY DISCLAIM ALL LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE.
The "Software" is each version of the software that we make available under
these Terms and Conditions, as indicated by our inclusion of these Terms and
Conditions with the Software.
Termination. If you violate the terms of this license, your rights
will terminate automatically and will not be reinstated without the
prior written consent of Licensor. Any such termination will not
affect the right of others who may have received copies of the
Software from you.
### License Grant
Subject to your compliance with this License Grant and the Patents,
Redistribution and Trademark clauses below, we hereby grant you the right to
use, copy, modify, create derivative works, publicly perform, publicly display
and redistribute the Software for any Permitted Purpose identified below.
### Permitted Purpose
A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
means making the Software available to others in a commercial product or
service that:
1. substitutes for the Software;
2. substitutes for any other product or service we offer using the Software
that exists as of the date we make the Software available; or
3. offers the same or substantially similar functionality as the Software.
Permitted Purposes specifically include using the Software:
1. for your internal use and access;
2. for non-commercial education;
3. for non-commercial research; and
4. in connection with professional services that you provide to a licensee
using the Software in accordance with these Terms and Conditions.
### Patents
To the extent your use for a Permitted Purpose would necessarily infringe our
patents, the license grant above includes a license under our patents. If you
make a claim against any party that the Software infringes or contributes to
the infringement of any patent, then your patent license to the Software ends
immediately.
### Redistribution
The Terms and Conditions apply to all copies, modifications and derivatives of
the Software.
If you redistribute any copies, modifications or derivatives of the Software,
you must include a copy of or a link to these Terms and Conditions and not
remove any copyright notices provided in or with the Software.
### Disclaimer
THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
### Trademarks
Except for displaying the License Details and identifying us as the origin of
the Software, you have no right under these Terms and Conditions to use our
trademarks, trade names, service marks or product names.
## Grant of Future License
We hereby irrevocably grant you an additional license to use the Software under
the Apache License, Version 2.0 that is effective on the second anniversary of
the date we make the Software available. On or after that date, you may use the
Software under the Apache License, Version 2.0, in which case the following
will apply:
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
http://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.
+14 -29
View File
@@ -1,4 +1,4 @@
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/TartSocial.png"/>
<img src="https://github.com/openai/tart/raw/main/Resources/TartSocial.png"/>
*Tart* is a virtualization toolset to build, run and manage macOS and Linux virtual machines (VMs) on Apple Silicon.
Built by CI engineers for your automation needs. Here are some highlights of Tart:
@@ -8,67 +8,52 @@ Built by CI engineers for your automation needs. Here are some highlights of Tar
* Use Tart Packer Plugin to automate VM creation.
* Easily integrates with any CI system.
Tart powers [Cirrus Runners](https://cirrus-runners.app/)
service — a drop-in replacement for the standard GitHub-hosted runners, offering 2-3 times better performance for a fraction of the price.
<p align="center">
<a href="https://cirrus-runners.app/?utm_source=github&utm_medium=referral" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/CirrusRunnersForGHA.png" height="65"/>
</a>
</p>
Many companies are using Tart in their internal setups. Here are just a few of them:
<p align="center">
<a href="https://atlassian.com/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Atlassian.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Atlassian.png" height="65"/>
</a>
<a href="https://www.figma.com/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Figma.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Figma.png" height="65"/>
</a>
<a href="https://mullvad.net/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Mullvad.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Mullvad.png" height="65"/>
</a>
<a href="https://krisp.ai/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Krisp.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Krisp.png" height="65"/>
</a>
<a href="https://testingbot.com/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/TestingBot.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/TestingBot.png" height="65"/>
</a>
<a href="https://symflower.com/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Symflower.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Symflower.png" height="65"/>
</a>
<a href="https://transloadit.com/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Transloadit.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Transloadit.png" height="65"/>
</a>
<a href="https://cirrus-ci.org/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/CirrusCI.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/CirrusCI.png" height="65"/>
</a>
<a href="https://www.pitsdatarecovery.net/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/PITSGlobalDataRecoveryServices.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/PITSGlobalDataRecoveryServices.png" height="65"/>
</a>
<a href="https://expo.dev/" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Expo.png" height="65"/>
<img src="https://github.com/openai/tart/raw/main/Resources/Users/Expo.png" height="65"/>
</a>
</p>
**Note:** If your company or project is using Tart please consider [sharing with the community](https://github.com/cirruslabs/tart/discussions/857).
<p align="center">
<a href="https://aws.amazon.com/marketplace/pp/prodview-qczco34wlkdws?utm_source=github&utm_medium=referral" target=_blank>
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/AWSMarkeplaceLogo.png" height="90"/>
</a>
</p>
**Note:** If your company or project is using Tart please consider [sharing with the community](https://github.com/openai/tart/discussions/857).
## Usage
Try running a Tart VM on your Apple Silicon device running macOS 13.0 (Ventura) or later (will download a 25 GB image):
```bash
brew install cirruslabs/cli/tart
brew install openai/tools/tart
tart clone ghcr.io/cirruslabs/macos-tahoe-base:latest tahoe-base
tart run tahoe-base
```
Please check the [official documentation](https://tart.run) for more information and/or feel free to use [discussions](https://github.com/cirruslabs/tart/discussions)
Please check the [official documentation](https://tart.run) for more information and/or feel free to use [discussions](https://github.com/openai/tart/discussions)
for remaining questions.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.
+1 -1
View File
@@ -1,5 +1,5 @@
struct CI {
private static let rawVersion = "${CIRRUS_TAG}"
private static let rawVersion = "${VERSION}"
static var version: String {
rawVersion.expanded() ? rawVersion : "SNAPSHOT"
+73 -10
View File
@@ -31,6 +31,9 @@ struct Clone: AsyncParsableCommand {
@Flag(help: .hidden)
var deduplicate: Bool = false
@Flag(help: "create a stacked disk that uses the source image as an immutable base")
var stacked: Bool = false
@Option(help: ArgumentHelp("limit automatic pruning to n gigabytes", valueName: "n"))
var pruneLimit: UInt = 100
@@ -47,14 +50,43 @@ struct Clone: AsyncParsableCommand {
func run() async throws {
let ociStorage = try VMStorageOCI()
let localStorage = try VMStorageLocal()
let remoteName = try? RemoteName(sourceName)
if let remoteName = try? RemoteName(sourceName), !ociStorage.exists(remoteName) {
if stacked {
guard remoteName != nil else {
throw ValidationError("--stacked requires a remote image")
}
try DiskImageStack.requireSupport()
}
if let remoteName, try !ociStorage.hasUsableCachedImageForClone(remoteName, requireManifest: stacked) {
// Pull the VM in case it's OCI-based and doesn't exist locally yet
let registry = try Registry(host: remoteName.host, namespace: remoteName.namespace, insecure: insecure)
try await ociStorage.pull(remoteName, registry: registry, concurrency: concurrency, deduplicate: deduplicate)
var resolvedManifest: (manifest: OCIManifest, data: Data)?
// Fail before pulling disk content when this host cannot create a writable stacked disk.
if !stacked {
let (manifest, manifestData) = try await registry.pullManifest(reference: remoteName.reference.value)
if manifest.layers.contains(where: { $0.mediaType == asifOverlayMediaType }) {
try DiskImageStack.requireSupport()
}
resolvedManifest = (manifest, manifestData)
}
try await ociStorage.pull(
remoteName,
registry: registry,
concurrency: concurrency,
deduplicate: deduplicate,
requireManifest: stacked,
resolvedManifest: resolvedManifest
)
}
let sourceVM = try VMStorageHelper.open(sourceName)
if sourceVM.isStackedVM || sourceVM.isStackedCachedImage {
try DiskImageStack.requireSupport()
}
let tmpVMDir = try VMDirectory.temporary()
// Lock the temporary VM directory to prevent it's garbage collection
@@ -66,9 +98,28 @@ struct Clone: AsyncParsableCommand {
let lock = try FileLock(lockURL: Config().tartHomeDir)
try lock.lock()
let sourceState = try sourceVM.state()
let generateMAC = try localStorage.hasVMsWithMACAddress(macAddress: sourceVM.macAddress())
&& sourceVM.state() != .Suspended
try sourceVM.clone(to: tmpVMDir, generateMAC: generateMAC)
&& sourceState != .Suspended
if stacked {
guard sourceVM.isStandalone else {
throw ValidationError("--stacked cannot use an image that already has a stacked disk")
}
guard try VMConfig(fromURL: sourceVM.configURL).os == .darwin else {
throw ValidationError("--stacked currently supports only macOS images")
}
try sourceVM.cloneAsStackedBase(to: tmpVMDir, generateMAC: generateMAC)
} else if sourceVM.isStackedCachedImage {
try sourceVM.cloneStacked(to: tmpVMDir, copyWritableOverlay: false, generateMAC: generateMAC)
} else if sourceVM.isStackedVM {
guard sourceState == .Stopped else {
throw RuntimeError.VMConfigurationError("VM \"\(sourceName)\" must be stopped before cloning")
}
try sourceVM.cloneStacked(to: tmpVMDir, copyWritableOverlay: true, generateMAC: generateMAC)
} else {
try sourceVM.clone(to: tmpVMDir, generateMAC: generateMAC)
}
try localStorage.move(newName, from: tmpVMDir)
@@ -78,14 +129,26 @@ struct Clone: AsyncParsableCommand {
// is not actually claiming new space until the VM is started and it writes something to disk.
//
// So, once we clone the VM let's try to claim the rest of space for the VM to run without errors.
let unallocatedBytes = try sourceVM.sizeBytes() - sourceVM.allocatedSizeBytes()
// Avoid reclaiming an excessive amount of disk space.
let reclaimBytes = min(unallocatedBytes, Int(pruneLimit) * 1024 * 1024 * 1024)
if reclaimBytes > 0 {
try Prune.reclaimIfNeeded(UInt64(reclaimBytes), sourceVM)
if sourceVM.isStandalone {
let unallocatedBytes = try sourceVM.sizeBytes() - sourceVM.allocatedSizeBytes()
// Avoid reclaiming an excessive amount of disk space.
let reclaimBytes = min(unallocatedBytes, Int(pruneLimit) * 1024 * 1024 * 1024)
if reclaimBytes > 0 {
try Prune.reclaimIfNeeded(UInt64(reclaimBytes), sourceVM)
}
} else if sourceVM.isStackedVM || sourceVM.isStackedCachedImage {
let clonedVM = try localStorage.open(newName)
// A stacked clone owns only its writable overlay locally, but that
// overlay may grow to the full guest-visible disk block layout at
// runtime. Reclaim against the clone so it is not pruned itself.
let unallocatedBytes = try clonedVM.diskSizeBytes() - clonedVM.allocatedSizeBytes()
let reclaimBytes = min(unallocatedBytes, Int(pruneLimit) * 1024 * 1024 * 1024)
if reclaimBytes > 0 {
try Prune.reclaimIfNeeded(UInt64(reclaimBytes), clonedVM)
}
}
}, onCancel: {
try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
try? tmpVMDir.removeFromDisk()
})
}
}
+4
View File
@@ -74,6 +74,10 @@ struct Create: AsyncParsableCommand {
_ = try await VM.linux(vmDir: tmpVMDir, diskSizeGB: diskSize, diskFormat: diskFormat)
}
// Publish under the same lock that run holds while opening VM files.
let storageLock = try FileLock(lockURL: Config().tartHomeDir)
try storageLock.lock()
defer { withExtendedLifetime(storageLock) {} }
try VMStorageLocal().move(name, from: tmpVMDir)
}, onCancel: {
try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
+10 -18
View File
@@ -1,6 +1,5 @@
import ArgumentParser
import Foundation
import NIOPosix
import GRPC
import Cirruslabs_TartGuestAgent_Grpc_Swift
@@ -41,27 +40,12 @@ struct Exec: AsyncParsableCommand {
throw RuntimeError.VMNotRunning(name)
}
// Create a gRPC channel connected to the VM's control socket
let group = MultiThreadedEventLoopGroup(numberOfThreads: 1)
defer {
try! group.syncShutdownGracefully()
}
// Change the current working directory to a VM's base directory
// to work around Unix domain socket 104 byte limitation [1]
//
// [1]: https://blog.8-p.info/en/2020/06/11/unix-domain-socket-length/
if let baseURL = vmDir.controlSocketURL.baseURL {
FileManager.default.changeCurrentDirectoryPath(baseURL.path())
}
let channel = try GRPCChannelPool.with(
target: .unixDomainSocket(vmDir.controlSocketURL.relativePath),
transportSecurity: .plaintext,
eventLoopGroup: group,
)
defer {
try! channel.close().wait()
FileManager.default.changeCurrentDirectoryPath(baseURL.absoluteURL.path(percentEncoded: false))
}
// Switch controlling terminal into raw mode when remote pseudo-terminal is requested
@@ -79,7 +63,10 @@ struct Exec: AsyncParsableCommand {
// Execute a command in a running VM
do {
try await execute(channel)
let controlSocketPath = vmDir.controlSocketURL.relativePath
try await withGuestAgentChannel(unixDomainSocketPath: controlSocketPath) { channel in
try await execute(channel)
}
} catch let error as GRPCConnectionPoolError {
throw RuntimeError.Generic("Failed to connect to the VM using its control socket: \(error.localizedDescription), is the Tart Guest Agent running?")
}
@@ -142,6 +129,11 @@ struct Exec: AsyncParsableCommand {
let data = handle.availableData
if data.isEmpty {
// EOF: unregister the handler, otherwise the fd stays permanently
// "readable" and Foundation re-invokes us in a tight loop, burning
// 100% of a core for the rest of the command's lifetime
handle.readabilityHandler = nil
continuation.finish()
} else {
continuation.yield(data)
+1 -1
View File
@@ -37,7 +37,7 @@ struct Export: AsyncParsableCommand {
func userWantsOverwrite(_ filename: String) -> Bool {
print("file \(filename) already exists, are you sure you want to overwrite it? (yes, [no])? ", terminator: "")
let answer = readLine()!
let answer = readLine()
return answer == "yes"
}
+15 -3
View File
@@ -5,9 +5,9 @@ fileprivate struct VMInfo: Encodable {
let OS: OS
let CPU: Int
let Memory: UInt64
let Disk: Int
let Disk: HumanReadableByteCount
let DiskFormat: String
let Size: String
let Size: HumanReadableByteCount
let Display: String
let Running: Bool
let State: String
@@ -27,7 +27,19 @@ struct Get: AsyncParsableCommand {
let vmConfig = try VMConfig(fromURL: vmDir.configURL)
let memorySizeInMb = vmConfig.memorySize / 1024 / 1024
let info = VMInfo(OS: vmConfig.os, CPU: vmConfig.cpuCount, Memory: memorySizeInMb, Disk: try vmDir.sizeGB(), DiskFormat: vmConfig.diskFormat.rawValue, Size: String(format: "%.3f", Float(try vmDir.allocatedSizeBytes()) / 1000 / 1000 / 1000), Display: vmConfig.display.description, Running: try vmDir.running(), State: try vmDir.state().rawValue)
let info = VMInfo(
OS: vmConfig.os,
CPU: vmConfig.cpuCount,
Memory: memorySizeInMb,
Disk: HumanReadableByteCount(try vmDir.diskSizeBytes()) { $0 / 1000 / 1000 / 1000 },
DiskFormat: vmConfig.diskFormat.rawValue,
Size: HumanReadableByteCount(try vmDir.allocatedSizeBytes()) {
String(format: "%.3f", Float($0) / 1000 / 1000 / 1000)
},
Display: vmConfig.display.description,
Running: try vmDir.running(),
State: try vmDir.state().rawValue
)
print(format.renderSingle(info))
}
}
+1 -1
View File
@@ -73,7 +73,7 @@ struct IP: AsyncParsableCommand {
//
// [1]: https://blog.8-p.info/en/2020/06/11/unix-domain-socket-length/
if let baseURL = controlSocketURL.baseURL {
FileManager.default.changeCurrentDirectoryPath(baseURL.path())
FileManager.default.changeCurrentDirectoryPath(baseURL.absoluteURL.path(percentEncoded: false))
}
if let ip = try await AgentResolver.ResolveIP(controlSocketURL.relativePath) {
+7 -1
View File
@@ -21,6 +21,9 @@ struct Import: AsyncParsableCommand {
// Create a temporary VM directory to which we will load the export file
let tmpVMDir = try VMDirectory.temporary()
defer {
try? tmpVMDir.removeFromDisk()
}
// Lock the temporary VM directory to prevent it's garbage collection
// while we're running
@@ -30,6 +33,9 @@ struct Import: AsyncParsableCommand {
// Populate the temporary VM directory with the export file contents
print("importing...")
try tmpVMDir.importFromArchive(path: path)
guard tmpVMDir.initialized else {
throw RuntimeError.ImportFailed("archive does not contain a runnable VM")
}
try await withTaskCancellationHandler(operation: {
// Acquire a global lock
@@ -45,7 +51,7 @@ struct Import: AsyncParsableCommand {
try lock.unlock()
}, onCancel: {
try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
try? tmpVMDir.removeFromDisk()
})
}
}
+6 -6
View File
@@ -5,8 +5,8 @@ import SwiftUI
fileprivate struct VMInfo: Encodable {
let Source: String
let Name: String
let Disk: Int
let Size: Int
let Disk: HumanReadableByteCount
let Size: HumanReadableByteCount
let Accessed: String
let Running: Bool
let State: String
@@ -42,8 +42,8 @@ struct List: AsyncParsableCommand {
try VMInfo(
Source: "local",
Name: name,
Disk: vmDir.sizeGB(),
Size: vmDir.allocatedSizeGB(),
Disk: HumanReadableByteCount(try vmDir.diskSizeBytes()) { $0 / 1000 / 1000 / 1000 },
Size: HumanReadableByteCount(try vmDir.allocatedSizeBytes()) { $0 / 1000 / 1000 / 1000 },
Accessed: formatAccessDate(try vmDir.accessDate()),
Running: vmDir.running(),
State: vmDir.state().rawValue
@@ -56,8 +56,8 @@ struct List: AsyncParsableCommand {
try VMInfo(
Source: "OCI",
Name: name,
Disk: vmDir.sizeGB(),
Size: vmDir.allocatedSizeGB(),
Disk: HumanReadableByteCount(try vmDir.diskSizeBytes()) { $0 / 1000 / 1000 / 1000 },
Size: HumanReadableByteCount(try vmDir.allocatedSizeBytes()) { $0 / 1000 / 1000 / 1000 },
Accessed: formatAccessDate(try vmDir.accessDate()),
Running: vmDir.running(),
State: vmDir.state().rawValue
+47 -35
View File
@@ -81,27 +81,34 @@ struct Prune: AsyncParsableCommand {
}
static func pruneSpaceBudget(prunableStorages: [PrunableStorage], spaceBudgetBytes: UInt64) throws {
let prunables: [Prunable] = try prunableStorages
.flatMap { try $0.prunables() }
.sorted { try $0.accessDate() > $1.accessDate() }
while true {
let prunables: [Prunable] = try prunableStorages
.flatMap { try $0.prunables() }
.sorted { try $0.accessDate() > $1.accessDate() }
var spaceBudgetBytes = spaceBudgetBytes
var prunablesToDelete: [Prunable] = []
var remainingBudgetBytes = spaceBudgetBytes
var prunableToDelete: Prunable?
for prunable in prunables {
let prunableSizeBytes = UInt64(try prunable.allocatedSizeBytes())
for prunable in prunables {
let prunableSizeBytes = UInt64(try prunable.allocatedSizeBytes())
if prunableSizeBytes <= spaceBudgetBytes {
// Don't mark for deletion as
// there's a budget available
spaceBudgetBytes -= prunableSizeBytes
} else {
// Mark for deletion
prunablesToDelete.append(prunable)
if prunableSizeBytes <= remainingBudgetBytes {
// Don't mark for deletion as there is budget available
remainingBudgetBytes -= prunableSizeBytes
} else {
prunableToDelete = prunable
break
}
}
}
try prunablesToDelete.forEach { try $0.delete() }
guard let prunableToDelete else {
return
}
// Deleting one cached stacked image can change which remaining image
// owns shared immutable content. Rebuild before choosing another.
try prunableToDelete.delete()
}
}
static func reclaimIfNeeded(_ requiredBytes: UInt64, _ initiator: Prunable? = nil) throws {
@@ -145,46 +152,51 @@ struct Prune: AsyncParsableCommand {
try Prune.reclaimIfPossible(requiredBytes - volumeAvailableCapacityCalculated, initiator)
}
private static func reclaimIfPossible(_ reclaimBytes: UInt64, _ initiator: Prunable? = nil) throws {
static func reclaimIfPossible(_ reclaimBytes: UInt64, _ initiator: Prunable? = nil) throws {
let span = OTel.shared.tracer.spanBuilder(spanName: "prune").startSpan()
defer { span.end() }
let prunableStorages: [PrunableStorage] = [try VMStorageOCI(), try IPSWCache()]
let prunables: [Prunable] = try prunableStorages
.flatMap { try $0.prunables() }
.sorted { try $0.accessDate() < $1.accessDate() }
let prunables = {
try prunableStorages
.flatMap { try $0.prunables() }
.sorted { try $0.accessDate() < $1.accessDate() }
}
// Does it even make sense to start?
let cacheUsedBytes = try prunables.map { try $0.allocatedSizeBytes() }.reduce(0, +)
if cacheUsedBytes < reclaimBytes {
let initialPrunables = try prunables()
let initialCacheUsedBytes = try initialPrunables.map { try $0.allocatedSizeBytes() }.reduce(0, +)
guard let reclaimBytes = Int(exactly: reclaimBytes), initialCacheUsedBytes >= reclaimBytes else {
return
}
var cacheReclaimedBytes: Int = 0
let targetCacheUsedBytes = initialCacheUsedBytes - reclaimBytes
var currentCacheUsedBytes = initialCacheUsedBytes
let initiatorPath = initiator.map {
$0.url.resolvingSymlinksInPath().standardizedFileURL.path
}
var it = prunables.makeIterator()
while cacheReclaimedBytes <= reclaimBytes {
guard let prunable = it.next() else {
while currentCacheUsedBytes > targetCacheUsedBytes {
// Deleting one cached stacked image can transfer ownership of shared
// immutable content to another record without reclaiming those bytes.
// Rebuild the candidates after every deletion so automatic pruning
// measures the cache that remains rather than a stale ownership snapshot.
guard let prunable = try prunables().first(where: {
$0.url.resolvingSymlinksInPath().standardizedFileURL.path != initiatorPath
}) else {
break
}
if prunable.url == initiator?.url.resolvingSymlinksInPath() {
// do not prune the initiator
continue
}
let allocatedSizeBytes = try prunable.allocatedSizeBytes()
OpenTelemetry.instance.contextProvider.activeSpan?
.addEvent(name: "Pruned \(allocatedSizeBytes) bytes for \(prunable.url.path)")
cacheReclaimedBytes += allocatedSizeBytes
try prunable.delete()
currentCacheUsedBytes = try prunables().map { try $0.allocatedSizeBytes() }.reduce(0, +)
}
OpenTelemetry.instance.contextProvider.activeSpan?
.addEvent(name: "Reclaimed \(cacheReclaimedBytes) bytes")
.addEvent(name: "Reclaimed \(initialCacheUsedBytes - currentCacheUsedBytes) bytes")
}
}
+6 -5
View File
@@ -69,7 +69,7 @@ struct Push: AsyncParsableCommand {
let references = remoteNamesForRegistry.map{ $0.reference.value }
let pushedRemoteName: RemoteName
// If we're pushing a local OCI VM, check if points to an already existing registry manifest
// If we're pushing a cached remote image, check if it points to an existing registry manifest
// and if so, only upload manifests (without config, disk and NVRAM) to the user-specified references
if let remoteName = try? RemoteName(localName) {
pushedRemoteName = try await lightweightPushToRegistry(
@@ -78,17 +78,18 @@ struct Push: AsyncParsableCommand {
references: references
)
} else {
pushedRemoteName = try await localVMDir.pushToRegistry(
let pushedImage = try await localVMDir.pushToRegistry(
registry: registry,
references: references,
chunkSizeMb: chunkSize,
concurrency: concurrency,
labels: parseLabels()
)
pushedRemoteName = pushedImage.name
// Populate the local cache (if requested)
if populateCache {
let expectedPushedVMDir = try ociStorage.create(pushedRemoteName)
try localVMDir.clone(to: expectedPushedVMDir, generateMAC: false)
try ociStorage.populate(pushedImage.name, from: localVMDir, manifest: pushedImage.manifest)
}
}
@@ -102,7 +103,7 @@ struct Push: AsyncParsableCommand {
}
func lightweightPushToRegistry(registry: Registry, remoteName: RemoteName, references: [String]) async throws -> RemoteName {
// Is the local OCI VM already present in the registry?
// Is the cached remote image already present in the registry?
let digest = try VMStorageOCI().digest(remoteName)
let (remoteManifest, _) = try await registry.pullManifest(reference: digest)
+3
View File
@@ -18,6 +18,9 @@ struct Rename: AsyncParsableCommand {
func run() async throws {
let localStorage = try VMStorageLocal()
let lock = try FileLock(lockURL: Config().tartHomeDir)
try lock.lock()
defer { withExtendedLifetime(lock) {} }
if !localStorage.exists(name) {
throw ValidationError("failed to rename a non-existent local VM: \(name)")
+204 -20
View File
@@ -90,6 +90,9 @@ struct Run: AsyncParsableCommand {
@Flag(help: "Disable audio pass-through to host.")
var noAudio: Bool = false
@Flag(help: "Disable USB accessories.")
var noUSBAccessories: Bool = false
@Flag(help: ArgumentHelp(
"Disable clipboard sharing between host and guest.",
discussion: "Clipboard sharing requires spice-vdagent package on Linux and https://github.com/cirruslabs/tart-guest-agent on macOS."))
@@ -224,6 +227,13 @@ struct Run: AsyncParsableCommand {
""", valueName: "comma-separated CIDRs"))
var netSoftnetBlock: String?
@Option(help: ArgumentHelp("Connected Unix stream socket file descriptor to use for the Softnet control channel (e.g. --net-softnet-control-fd=3)", discussion: """
This option enables the Softnet control channel on an inherited Unix stream socket. It can be used to dynamically replace Softnet allow and block lists while the VM is running.
The file descriptor must be greater than 2. Implies --net-softnet.
""", valueName: "file descriptor"))
var netSoftnetControlFd: Int32?
@Option(help: ArgumentHelp("Comma-separated list of TCP ports to expose (e.g. --net-softnet-expose 2222:22,8080:80)", discussion: """
Options are comma-separated and are as follows:
@@ -285,13 +295,35 @@ struct Run: AsyncParsableCommand {
@Flag(help: ArgumentHelp("Disable the keyboard"))
var noKeyboard: Bool = false
#if arch(arm64) && compiler(>=6.4)
@Option(help: ArgumentHelp("Provision a macOS guest on first boot using the guest provisioning API", discussion: """
Takes a comma-separated list of key=value pairs that configure the initial setup of a macOS guest
Requires the host to be running macOS 27 (or newer) and only takes effect on the first boot after
creation of a macOS 27 (or newer) guest VM.
Supported keys (matching VZMacGuestProvisioningOptions):
* fullName=<NAME> — the person's full name to configure
* username=<USERNAME> — the username for logging into the guest
* password=<PASSWORD> — the password to configure for the guest
* logsInAutomatically=true|false — whether to automatically log the person in at startup
* enablesRemoteLogin=true|false — whether to enable Remote Login (SSH) in the guest
""", valueName: "key=value,..."))
var provisioningOpts: String?
#endif
mutating func validate() throws {
if vnc && vncExperimental {
throw ValidationError("--vnc and --vnc-experimental are mutually exclusive")
}
// Automatically enable --net-softnet when any of its related options are specified
if netSoftnetAllow != nil || netSoftnetBlock != nil || netSoftnetExpose != nil {
if netSoftnetAllow != nil || netSoftnetBlock != nil || netSoftnetExpose != nil || netSoftnetControlFd != nil {
netSoftnet = true
}
@@ -352,6 +384,19 @@ struct Run: AsyncParsableCommand {
}
}
#if arch(arm64) && compiler(>=6.4)
if provisioningOpts != nil {
if #unavailable(macOS 27) {
throw ValidationError("--provisioning-opts requires the host to be running macOS 27 (or newer)")
}
let config = try VMConfig.init(fromURL: vmDir.configURL)
if config.os != .darwin {
throw ValidationError("--provisioning-opts can only be used with macOS VMs")
}
}
#endif
for disk in disk {
if disk.hasSuffix("-amd64.iso") {
throw ValidationError("Seems you have a disk targeting x86 architecture (hence amd64 in the name). Please use an 'arm64' version of the disk.")
@@ -360,7 +405,7 @@ struct Run: AsyncParsableCommand {
}
@MainActor
func run() async throws {
func runOnMainThread() throws {
let localStorage = try VMStorageLocal()
let vmDir = try localStorage.open(name)
@@ -408,16 +453,27 @@ struct Run: AsyncParsableCommand {
// Parse root disk options
let diskOptions = DiskOptions(rootDiskOpts)
// Parse guest provisioning options
#if arch(arm64) && compiler(>=6.4)
let provisioning = try provisioningOpts.map { try GuestProvisioningOptions($0) }
#endif
// Keep these values alive while the VM runs. Some additional disks own a
// lock that protects their temporary backing files from Config.gc().
let additionalDisks = try additionalDisks()
defer { withExtendedLifetime(additionalDisks) {} }
vm = try VM(
vmDir: vmDir,
network: userSpecifiedNetwork(vmDir: vmDir) ?? NetworkShared(),
additionalStorageDevices: try additionalDiskAttachments(),
additionalStorageDevices: additionalDisks.map(\.configuration),
directorySharingDevices: directoryShares() + rosettaDirectoryShare(),
serialPorts: serialPorts,
suspendable: suspendable,
nested: nested,
audio: !noAudio,
clipboard: !noClipboard,
noUSBAccessories: noUSBAccessories,
sync: VZDiskImageSynchronizationMode(diskOptions.syncModeRaw),
caching: VZDiskImageCachingMode(diskOptions.cachingModeRaw),
noTrackpad: noTrackpad,
@@ -473,7 +529,11 @@ struct Run: AsyncParsableCommand {
#endif
do {
try await vm!.start(recovery: recovery, resume: resume)
#if arch(arm64) && compiler(>=6.4)
try await vm!.start(recovery: recovery, resume: resume, provisioning: provisioning)
#else
try await vm!.start(recovery: recovery, resume: resume)
#endif
} catch let error as VZError {
if error.code == .virtualMachineLimitExceeded {
var hint = ""
@@ -514,8 +574,10 @@ struct Run: AsyncParsableCommand {
}
if #available(macOS 14, *) {
Task {
try await ControlSocket(vmDir.controlSocketURL).run()
let controlSocket = try await ControlSocket(vmDir.controlSocketURL)
ErrorReportingTask("Failed to run control socket") {
try await controlSocket.run()
}
}
@@ -586,7 +648,7 @@ struct Run: AsyncParsableCommand {
signal(SIGUSR2, SIG_IGN)
let sigusr2Src = DispatchSource.makeSignalSource(signal: SIGUSR2)
sigusr2Src.setEventHandler {
Task {
ErrorReportingTask("Failed to request guest OS to stop") {
print("Requesting guest OS to stop...")
try vm!.virtualMachine.requestStop()
}
@@ -637,13 +699,13 @@ struct Run: AsyncParsableCommand {
if netSoftnet {
let config = try VMConfig.init(fromURL: vmDir.configURL)
return try Softnet(vmMACAddress: config.macAddress.string, extraArguments: softnetExtraArguments)
return try Softnet(vmMACAddress: config.macAddress.string, extraArguments: softnetExtraArguments, controlFD: netSoftnetControlFd)
}
if netHost {
let config = try VMConfig.init(fromURL: vmDir.configURL)
return try Softnet(vmMACAddress: config.macAddress.string, extraArguments: ["--vm-net-type", "host"] + softnetExtraArguments)
return try Softnet(vmMACAddress: config.macAddress.string, extraArguments: ["--vm-net-type", "host"] + softnetExtraArguments, controlFD: netSoftnetControlFd)
}
if netBridged.count > 0 {
@@ -676,9 +738,9 @@ struct Run: AsyncParsableCommand {
}
}
func additionalDiskAttachments() throws -> [VZStorageDeviceConfiguration] {
func additionalDisks() throws -> [AdditionalDisk] {
try disk.map {
try AdditionalDisk(parseFrom: $0).configuration
try AdditionalDisk(parseFrom: $0)
}
}
@@ -758,6 +820,11 @@ struct Run: AsyncParsableCommand {
}
}
// "tart run" drives an AppKit/SwiftUI run loop and therefore must own the main
// thread at the top level, so it opts out of Root's asynchronous command path.
// See Root.main() for the rationale.
extension Run: MainThreadCommand {}
struct MainApp: App {
static var suspendable: Bool = false
static var capturesSystemKeys: Bool = false
@@ -798,13 +865,13 @@ struct MainApp: App {
CommandGroup(replacing: .appInfo) { AboutTart(config: vm!.config) }
CommandMenu("Control") {
Button("Start") {
Task { try await vm!.virtualMachine.start() }
ErrorReportingTask("Failed to start VM") { try await vm!.virtualMachine.start() }
}
Button("Stop") {
Task { try await vm!.virtualMachine.stop() }
ErrorReportingTask("Failed to stop VM") { try await vm!.virtualMachine.stop() }
}
Button("Request Stop") {
Task { try vm!.virtualMachine.requestStop() }
ErrorReportingTask("Failed to request VM stop") { try vm!.virtualMachine.requestStop() }
}
if #available(macOS 14, *) {
if (MainApp.suspendable) {
@@ -896,14 +963,32 @@ struct VMView: NSViewRepresentable {
struct AdditionalDisk {
let configuration: VZStorageDeviceConfiguration
// Retained for as long as the additional disk is attached, so Config.gc()
// cannot remove a temporary backing file or stacked-disk directory.
private let temporaryDiskLock: FileLock?
init(parseFrom: String) throws {
let (diskPath, readOnly, syncModeRaw, cachingModeRaw) = Self.parseOptions(parseFrom)
self.configuration = try Self.craft(diskPath, readOnly: readOnly, syncModeRaw: syncModeRaw, cachingModeRaw: cachingModeRaw)
self = try Self.craft(
diskPath,
readOnly: readOnly,
syncModeRaw: syncModeRaw,
cachingModeRaw: cachingModeRaw
)
}
static func craft(_ diskPath: String, readOnly diskReadOnly: Bool, syncModeRaw: String, cachingModeRaw: String) throws -> VZStorageDeviceConfiguration {
private init(configuration: VZStorageDeviceConfiguration, temporaryDiskLock: FileLock? = nil) {
self.configuration = configuration
self.temporaryDiskLock = temporaryDiskLock
}
private static func craft(
_ diskPath: String,
readOnly diskReadOnly: Bool,
syncModeRaw: String,
cachingModeRaw: String
) throws -> AdditionalDisk {
let diskURL = URL(string: diskPath)
if (["nbd", "nbds", "nbd+unix", "nbds+unix"].contains(diskURL?.scheme)) {
@@ -918,7 +1003,7 @@ struct AdditionalDisk {
synchronizationMode: try VZDiskSynchronizationMode(syncModeRaw)
)
return VZVirtioBlockDeviceConfiguration(attachment: nbdAttachment)
return AdditionalDisk(configuration: VZVirtioBlockDeviceConfiguration(attachment: nbdAttachment))
}
// Expand the tilde (~) since at this point we're dealing with a local path,
@@ -949,13 +1034,37 @@ struct AdditionalDisk {
let blockAttachment = try VZDiskBlockDeviceStorageDeviceAttachment(fileHandle: FileHandle(fileDescriptor: fd, closeOnDealloc: true),
readOnly: diskReadOnly, synchronizationMode: try VZDiskSynchronizationMode(syncModeRaw))
return VZVirtioBlockDeviceConfiguration(attachment: blockAttachment)
return AdditionalDisk(configuration: VZVirtioBlockDeviceConfiguration(attachment: blockAttachment))
}
// Support remote VM names in --disk command-line argument
if let remoteName = try? RemoteName(diskPath) {
let vmDir = try VMStorageOCI().open(remoteName)
if vmDir.isStackedCachedImage {
// A cached stacked image has no writable top overlay. Create one in a
// disposable directory for this additional-disk attachment.
let temporaryVMDir = try VMDirectory.temporary()
let temporaryVMDirLock = try FileLock(lockURL: temporaryVMDir.baseURL)
try temporaryVMDirLock.lock()
try vmDir.cloneStacked(
to: temporaryVMDir,
copyWritableOverlay: false,
generateMAC: false
)
let stack = try temporaryVMDir.diskImageStack()
let attachment = try stack.makeAttachment(
readOnly: diskReadOnly,
cachingMode: try VZDiskImageCachingMode(cachingModeRaw) ?? .automatic,
synchronizationMode: try VZDiskImageSynchronizationMode(syncModeRaw)
)
return AdditionalDisk(
configuration: VZVirtioBlockDeviceConfiguration(attachment: attachment),
temporaryDiskLock: temporaryVMDirLock
)
}
// Unfortunately, VZDiskImageStorageDeviceAttachment does not support
// FileHandle, so we can't easily clone the disk, open it and unlink(2)
// to simplify the garbage collection, so use an intermediate directory.
@@ -968,7 +1077,7 @@ struct AdditionalDisk {
let diskImageAttachment = try VZDiskImageStorageDeviceAttachment(url: clonedDiskURL, readOnly: diskReadOnly)
return VZVirtioBlockDeviceConfiguration(attachment: diskImageAttachment)
return AdditionalDisk(configuration: VZVirtioBlockDeviceConfiguration(attachment: diskImageAttachment), temporaryDiskLock: lock)
}
// Error out if the disk is locked by the host (e.g. it was mounted in Finder),
@@ -984,7 +1093,7 @@ struct AdditionalDisk {
synchronizationMode: try VZDiskImageSynchronizationMode(syncModeRaw)
)
return VZVirtioBlockDeviceConfiguration(attachment: diskImageAttachment)
return AdditionalDisk(configuration: VZVirtioBlockDeviceConfiguration(attachment: diskImageAttachment))
}
static func parseOptions(_ parseFrom: String) -> (String, Bool, String, String) {
@@ -1026,6 +1135,81 @@ struct DiskOptions {
}
}
struct GuestProvisioningOptions {
var fullName: String?
var username: String?
var password: String?
var logsInAutomatically: Bool?
var enablesRemoteLogin: Bool?
init(_ parseFrom: String) throws {
for pair in parseFrom.split(separator: ",") {
let keyValue = pair.split(separator: "=", maxSplits: 1)
guard keyValue.count == 2 else {
throw RuntimeError.VMConfigurationError("invalid provisioning option \"\(pair)\", expected key=value")
}
let key = String(keyValue[0])
let value = String(keyValue[1])
switch key {
case "fullName":
self.fullName = value
case "username":
self.username = value
case "password":
self.password = value
case "logsInAutomatically":
self.logsInAutomatically = try Self.parseBool(key, value)
case "enablesRemoteLogin":
self.enablesRemoteLogin = try Self.parseBool(key, value)
default:
throw RuntimeError.VMConfigurationError("unsupported provisioning option \"\(key)\"")
}
}
}
private static func parseBool(_ key: String, _ value: String) throws -> Bool {
switch value {
case "true":
return true
case "false":
return false
default:
throw RuntimeError.VMConfigurationError("invalid value \"\(value)\" for provisioning option \"\(key)\", expected \"true\" or \"false\"")
}
}
}
#if arch(arm64) && compiler(>=6.4)
@available(macOS 27, *)
extension GuestProvisioningOptions {
func toVZMacGuestProvisioningOptions() throws -> VZMacGuestProvisioningOptions {
let options = VZMacGuestProvisioningOptions()
if let fullName = fullName {
options.fullName = fullName
}
if let username = username {
options.username = username
}
if let password = password {
options.password = password
}
if let logsInAutomatically = logsInAutomatically {
options.logsInAutomatically = logsInAutomatically
}
if let enablesRemoteLogin = enablesRemoteLogin {
options.enablesRemoteLogin = enablesRemoteLogin
}
try options.validate()
return options
}
}
#endif
struct DirectoryShare {
let name: String?
let path: URL
+8
View File
@@ -39,6 +39,14 @@ struct Set: AsyncParsableCommand {
func run() async throws {
let vmDir = try VMStorageLocal().open(name)
// Replacing disk.img would leave a stacked VM with both disk.img and
// overlay.asif, which is not a supported local layout. Reject before
// saving any other requested configuration changes.
if disk != nil, vmDir.isStackedVM {
throw ValidationError("--disk is not supported for VMs with a stacked disk")
}
var vmConfig = try VMConfig(fromURL: vmDir.configURL)
if let cpu = cpu {
+1 -1
View File
@@ -33,7 +33,7 @@ struct Config {
continue
}
try FileManager.default.removeItem(at: entry)
try VMDirectory(baseURL: entry).removeFromDisk()
try lock.unlock()
}
+192
View File
@@ -0,0 +1,192 @@
import Foundation
enum ContentStoreError: Error, Equatable {
case invalidContentDigest(String)
case contentDigestMismatch(expected: String, actual: String)
}
/// Opaque content-addressed storage for immutable reconstructed files.
///
/// Stacked disks currently use it for complete base disks and published ASIF
/// overlays reconstructed from Tart disk chunks. OCI blob digests may differ
/// across registries, so the key is the full reconstructed-file digest.
struct ContentStore {
private static let digestAlgorithm = "sha256"
private static let digestPrefix = "\(digestAlgorithm):"
let baseURL: URL
private let digestDirectoryURL: URL
private let pruneLockURL: URL
init() throws {
try self.init(baseURL: Config().tartCacheDir.appendingPathComponent("content", isDirectory: true))
}
init(baseURL: URL) throws {
self.baseURL = baseURL
self.digestDirectoryURL = baseURL.appendingPathComponent(Self.digestAlgorithm, isDirectory: true)
self.pruneLockURL = baseURL.appendingPathComponent(".gc.lock")
try FileManager.default.createDirectory(at: digestDirectoryURL, withIntermediateDirectories: true)
if !FileManager.default.fileExists(atPath: pruneLockURL.path) {
_ = FileManager.default.createFile(atPath: pruneLockURL.path, contents: Data())
}
}
/// Serializes reference publication with the final reference check and
/// deletion of immutable cache entries across Tart processes.
func withPruneLock<T>(_ body: () throws -> T) throws -> T {
let lock = try FileLock(lockURL: pruneLockURL)
try lock.lock()
defer { try? lock.unlock() }
return try body()
}
/// Waits for any prune already scanning references to finish. After this
/// returns, later prune runs can see a reference the caller already wrote.
func synchronizePublishedReferences() throws {
try withPruneLock {}
}
func contentURL(for contentDigest: String) throws -> URL {
try contentURL(for: contentDigest, under: baseURL)
}
/// Returns the canonical path for a digest under an arbitrary content-store
/// root without creating directories or lock files.
func contentURL(for contentDigest: String, under baseURL: URL) throws -> URL {
let digestHex = try validatedDigestHex(contentDigest)
return baseURL
.appendingPathComponent(Self.digestAlgorithm, isDirectory: true)
.appendingPathComponent(digestHex)
}
func temporaryContentURL(for contentDigest: String) throws -> URL {
let targetURL = try contentURL(for: contentDigest)
return targetURL.deletingLastPathComponent().appendingPathComponent(".\(UUID().uuidString).tmp")
}
/// Returns a stable staging path so an interrupted registry pull can resume
/// reconstructing this content entry on a later attempt.
func resumableContentURL(for contentDigest: String) throws -> URL {
let targetURL = try contentURL(for: contentDigest)
return targetURL.deletingLastPathComponent().appendingPathComponent(".\(targetURL.lastPathComponent).partial")
}
/// Returns a stable lock file for serializing reconstruction of one content
/// entry. The file is intentionally retained; flock state lives on the file
/// descriptor and disappears when the owning process exits.
func lockURL(for contentDigest: String) throws -> URL {
let targetURL = try contentURL(for: contentDigest)
let lockURL = targetURL.deletingLastPathComponent().appendingPathComponent(".\(targetURL.lastPathComponent).lock")
if !FileManager.default.fileExists(atPath: lockURL.path) {
_ = FileManager.default.createFile(atPath: lockURL.path, contents: nil)
}
return lockURL
}
/// Returns an immutable digest-addressed entry without rereading it. Files
/// are verified when installed and when deciding whether a pull is a cache
/// hit; normal clone/run/push paths trust the store like Tart's disk.img.
func contentURLIfPresent(for contentDigest: String) throws -> URL? {
let url = try contentURL(for: contentDigest)
guard FileManager.default.fileExists(atPath: url.path) else {
return nil
}
try url.updateAccessDate()
return url
}
/// Returns a validated cache hit. Corrupt files are treated as misses so a
/// later pull can safely rebuild them.
func existingContentURL(for contentDigest: String) throws -> URL? {
guard let url = try contentURLIfPresent(for: contentDigest) else {
return nil
}
guard try Digest.hash(url) == contentDigest else {
return nil
}
return url
}
/// Returns immutable content files that no retained cached image or local VM
/// references. Callers may prune these like other cache entries.
func prunables(excluding referencedContentDigests: Swift.Set<String>) throws -> [URL] {
guard let enumerator = FileManager.default.enumerator(
at: digestDirectoryURL,
includingPropertiesForKeys: [.isRegularFileKey],
options: [.skipsSubdirectoryDescendants]
) else {
return []
}
return try enumerator.compactMap { element in
guard let url = element as? URL,
try url.resourceValues(forKeys: [.isRegularFileKey]).isRegularFile == true else {
return nil
}
let contentDigest = "\(Self.digestPrefix)\(url.lastPathComponent)"
guard (try? validatedDigestHex(contentDigest)) != nil,
!referencedContentDigests.contains(contentDigest) else {
return nil
}
return url
}
}
/// Move a fully reconstructed temporary file into the cache after verifying
/// its semantic identity. The caller should create the temporary file with
/// temporaryContentURL(for:) or resumableContentURL(for:) so rename stays on
/// the same filesystem.
func install(_ temporaryURL: URL, contentDigest: String) throws -> URL {
let actualDigest = try Digest.hash(temporaryURL)
guard actualDigest == contentDigest else {
throw ContentStoreError.contentDigestMismatch(expected: contentDigest, actual: actualDigest)
}
let targetURL = try contentURL(for: contentDigest)
let lock = try FileLock(lockURL: baseURL)
try lock.lock()
defer { try? lock.unlock() }
if let existingURL = try existingContentURL(for: contentDigest) {
try? FileManager.default.removeItem(at: temporaryURL)
return existingURL
}
if FileManager.default.fileExists(atPath: targetURL.path) {
_ = try FileManager.default.replaceItemAt(targetURL, withItemAt: temporaryURL)
} else {
try FileManager.default.moveItem(at: temporaryURL, to: targetURL)
}
return targetURL
}
private func validatedDigestHex(_ contentDigest: String) throws -> String {
guard contentDigest.hasPrefix(Self.digestPrefix) else {
throw ContentStoreError.invalidContentDigest(contentDigest)
}
let digestHex = String(contentDigest.dropFirst(Self.digestPrefix.count))
let isHex = digestHex.allSatisfy { $0.isHexDigit && !$0.isUppercase }
guard digestHex.count == 64, isHex else {
throw ContentStoreError.invalidContentDigest(contentDigest)
}
return digestHex
}
}
+44 -14
View File
@@ -1,4 +1,7 @@
import Foundation
import Darwin
import System
import Virtualization
import Network
import os.log
import NIO
@@ -6,38 +9,48 @@ import NIOPosix
@available(macOS 14, *)
class ControlSocket {
typealias ServerChannel = NIOAsyncChannel<NIOAsyncChannel<ByteBuffer, ByteBuffer>, Never>
let controlSocketURL: URL
let vmPort: UInt32
let eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
let eventLoopGroup: MultiThreadedEventLoopGroup
let serverChannel: ServerChannel
let logger: os.Logger = os.Logger(subsystem: "org.cirruslabs.tart.control-socket", category: "network")
init(_ controlSocketURL: URL, vmPort: UInt32 = 8080) {
init(_ controlSocketURL: URL, vmPort: UInt32 = 8080) async throws {
self.controlSocketURL = controlSocketURL
self.vmPort = vmPort
}
let eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
self.eventLoopGroup = eventLoopGroup
func run() async throws {
// Remove control socket file from previous "tart run" invocations,
// if any, otherwise we may get the "address already in use" error
try? FileManager.default.removeItem(atPath: controlSocketURL.path)
try? FileManager.default.removeItem(at: controlSocketURL)
// Change the current working directory to a VM's base directory
// to work around Unix domain socket 104 byte limitation [1]
//
// [1]: https://blog.8-p.info/en/2020/06/11/unix-domain-socket-length/
if let baseURL = controlSocketURL.baseURL {
FileManager.default.changeCurrentDirectoryPath(baseURL.path())
FileManager.default.changeCurrentDirectoryPath(baseURL.absoluteURL.path(percentEncoded: false))
}
let serverChannel = try await ServerBootstrap(group: eventLoopGroup)
.bind(unixDomainSocketPath: controlSocketURL.relativePath) { childChannel in
childChannel.eventLoop.makeCompletedFuture {
return try NIOAsyncChannel<ByteBuffer, ByteBuffer>(
wrappingChannelSynchronously: childChannel
)
do {
self.serverChannel = try await ServerBootstrap(group: eventLoopGroup)
.bind(unixDomainSocketPath: controlSocketURL.relativePath) { childChannel in
childChannel.eventLoop.makeCompletedFuture {
return try NIOAsyncChannel<ByteBuffer, ByteBuffer>(
wrappingChannelSynchronously: childChannel
)
}
}
}
} catch {
try? await eventLoopGroup.shutdownGracefully()
throw error
}
}
func run() async throws {
try await withThrowingDiscardingTaskGroup { group in
try await serverChannel.executeThenClose { serverInbound in
for try await clientChannel in serverInbound {
@@ -62,7 +75,13 @@ class ControlSocket {
self.logger.info("running control socket proxy")
let vmChannel = try await ClientBootstrap(group: eventLoopGroup).withConnectedSocket(vmConnection.fileDescriptor) { childChannel in
// Duplicate the connection's file descriptor
//
// This way VZVirtioSocketConnection and NIO won't race to close the same descriptor,
// which may result in "tart run" crashing because of NIO's fatal assertion on EBADF.
let vmSocket = try duplicateAndCloseConnection(vmConnection)
let vmChannel = try await ClientBootstrap(group: eventLoopGroup).withConnectedSocket(vmSocket) { childChannel in
childChannel.eventLoop.makeCompletedFuture {
try NIOAsyncChannel<ByteBuffer, ByteBuffer>(
wrappingChannelSynchronously: childChannel
@@ -94,4 +113,15 @@ class ControlSocket {
}
}
}
private func duplicateAndCloseConnection(_ connection: VZVirtioSocketConnection) throws -> CInt {
defer { connection.close() }
let fd = fcntl(connection.fileDescriptor, F_DUPFD_CLOEXEC, 0)
guard fd >= 0 else {
throw Errno(rawValue: errno)
}
return fd
}
}
+304
View File
@@ -0,0 +1,304 @@
import Foundation
import Virtualization
#if canImport(DiskImageKit)
import DiskImageKit
#endif
/// The logical block layout exposed by a disk image.
struct DiskImageBlockLayout {
let blockSize: UInt64
let blockCount: UInt64
}
enum DiskImageStackError: Error, Equatable, CustomStringConvertible {
case unavailable
case writableOverlayAlreadyExists(URL)
case writableOverlayMissing(URL)
case invalidBlockLayout(String)
case invalidDiskImage(URL, String)
var description: String {
switch self {
case .unavailable:
"stacked disks require DiskImageKit on macOS 27 or newer"
case .writableOverlayAlreadyExists(let url):
"writable overlay already exists: \(url.path)"
case .writableOverlayMissing(let url):
"writable overlay is missing: \(url.path)"
case .invalidBlockLayout(let reason):
reason
case .invalidDiskImage(let url, let reason):
"\(reason): \(url.path)"
}
}
}
struct DiskImageStack {
/// DiskImageKit-ready paths and block layout after Tart disk chunks have been
/// reconstructed into complete immutable files. The writable overlay stays
/// private to one VM.
let baseURL: URL
let baseFormat: DiskImageFormat
let immutableOverlayURLs: [URL]
let writableOverlayURL: URL
let blockSize: UInt64
let blockCount: UInt64
static var isSupported: Bool {
#if canImport(DiskImageKit)
if #available(macOS 27.0, *) {
return true
}
#endif
return false
}
static func requireSupport() throws {
guard isSupported else {
throw DiskImageStackError.unavailable
}
}
/// Reads a disk image's current block layout without resolving or validating a
/// whole stack. This is used for the VM's private writable overlay, whose
/// size may be newer than the pinned immutable parent manifest.
static func diskImageBlockLayout(at url: URL) throws -> DiskImageBlockLayout {
#if canImport(DiskImageKit)
if #available(macOS 27.0, *) {
let image = try DiskImage(opening: .open(url: url, mode: .readOnly))
return DiskImageBlockLayout(
blockSize: UInt64(image.blockSize.rawValue),
blockCount: UInt64(image.blockCount)
)
}
#endif
throw DiskImageStackError.unavailable
}
static func baseBlockLayout(
at url: URL,
expectedFormat: DiskImageFormat
) throws -> DiskImageBlockLayout {
#if canImport(DiskImageKit)
if #available(macOS 27.0, *) {
let image = try DiskImage(opening: .open(url: url, mode: .readOnly))
try validateBase(image, at: url, expectedFormat: expectedFormat)
return DiskImageBlockLayout(
blockSize: UInt64(image.blockSize.rawValue),
blockCount: UInt64(image.blockCount)
)
}
#endif
throw DiskImageStackError.unavailable
}
func createWritableOverlay() throws {
#if canImport(DiskImageKit)
if #available(macOS 27.0, *) {
try createWritableOverlayWithDiskImageKit()
return
}
#endif
throw DiskImageStackError.unavailable
}
func copyWritableOverlay(to destinationURL: URL) throws {
guard !FileManager.default.fileExists(atPath: destinationURL.path) else {
throw DiskImageStackError.writableOverlayAlreadyExists(destinationURL)
}
try FileManager.default.copyItem(at: writableOverlayURL, to: destinationURL)
}
func makeAttachment(
readOnly: Bool = false,
cachingMode: VZDiskImageCachingMode = .automatic,
synchronizationMode: VZDiskImageSynchronizationMode = .full
) throws -> VZStorageDeviceAttachment {
#if canImport(DiskImageKit)
if #available(macOS 27.0, *) {
return try attachmentWithDiskImageKit(
readOnly: readOnly,
cachingMode: cachingMode,
synchronizationMode: synchronizationMode
)
}
#endif
throw DiskImageStackError.unavailable
}
func growWritableOverlay(toBlockCount blockCount: UInt64) throws {
#if canImport(DiskImageKit)
if #available(macOS 27.0, *) {
try growWritableOverlayWithDiskImageKit(toBlockCount: blockCount)
return
}
#endif
throw DiskImageStackError.unavailable
}
#if canImport(DiskImageKit)
@available(macOS 27.0, *)
private func createWritableOverlayWithDiskImageKit() throws {
guard !FileManager.default.fileExists(atPath: writableOverlayURL.path) else {
throw DiskImageStackError.writableOverlayAlreadyExists(writableOverlayURL)
}
let parent = try validatedParentImage()
let stackedImage = try parent.appending(.asifLayer(url: writableOverlayURL, type: .overlay))
try validateAppendedOverlay(stackedImage, at: writableOverlayURL)
}
@available(macOS 27.0, *)
private func attachmentWithDiskImageKit(
readOnly: Bool,
cachingMode: VZDiskImageCachingMode,
synchronizationMode: VZDiskImageSynchronizationMode
) throws -> VZDiskImageStorageDeviceAttachment {
guard FileManager.default.fileExists(atPath: writableOverlayURL.path) else {
throw DiskImageStackError.writableOverlayMissing(writableOverlayURL)
}
let parent = try validatedParentImage()
let writableOverlay = try openOverlay(
at: writableOverlayURL,
mode: readOnly ? .readOnly : .readWrite
)
let stackedImage = try append(writableOverlay, to: parent, at: writableOverlayURL)
try validateAppendedOverlay(stackedImage, at: writableOverlayURL)
return try VZDiskImageStorageDeviceAttachment(
diskImage: stackedImage,
cachingMode: cachingMode,
synchronizationMode: synchronizationMode
)
}
@available(macOS 27.0, *)
private func growWritableOverlayWithDiskImageKit(toBlockCount blockCount: UInt64) throws {
guard blockCount > 0, let desiredBlockCount = Int(exactly: blockCount) else {
throw DiskImageStackError.invalidBlockLayout("invalid stacked disk block count \(blockCount)")
}
let parent = try validatedParentImage()
let overlay = try openOverlay(
at: writableOverlayURL,
mode: .readWrite
)
let currentBlockCount = overlay.blockCount
let stackedImage = try append(overlay, to: parent, at: writableOverlayURL)
try validateAppendedOverlay(stackedImage, at: writableOverlayURL)
guard desiredBlockCount >= currentBlockCount else {
throw DiskImageStackError.invalidDiskImage(writableOverlayURL, "ASIF overlay block count shrinks the stacked disk")
}
guard let writableOverlay = stackedImage.layers.last else {
throw DiskImageStackError.invalidDiskImage(writableOverlayURL, "disk image must be an ASIF overlay")
}
if desiredBlockCount > currentBlockCount {
try writableOverlay.truncate(blockCount: desiredBlockCount)
}
}
@available(macOS 27.0, *)
private func validatedParentImage() throws -> DiskImage {
let expectedBlockSize = try diskImageBlockSize(blockSize)
guard blockCount > 0, let expectedBlockCount = Int(exactly: blockCount) else {
throw DiskImageStackError.invalidBlockLayout("invalid stacked disk block count \(blockCount)")
}
let baseImage = try DiskImage(opening: .open(url: baseURL, mode: .readOnly))
try Self.validateBase(baseImage, at: baseURL, expectedFormat: baseFormat)
var image = baseImage
for overlayURL in immutableOverlayURLs {
let openedOverlay = try openOverlay(
at: overlayURL,
mode: .readOnly
)
let stackedImage = try append(openedOverlay, to: image, at: overlayURL)
try validateAppendedOverlay(stackedImage, at: overlayURL)
image = stackedImage
}
guard image.blockSize == expectedBlockSize else {
throw DiskImageStackError.invalidBlockLayout("immutable disk stack does not match manifest block size")
}
guard image.blockCount == expectedBlockCount else {
throw DiskImageStackError.invalidBlockLayout("immutable disk stack does not match manifest block count")
}
return image
}
@available(macOS 27.0, *)
private static func validateBase(
_ image: DiskImage,
at url: URL,
expectedFormat: DiskImageFormat
) throws {
let matchesFormat = switch expectedFormat {
case .raw:
image.format == .raw
case .asif:
image.format == .asif
}
guard matchesFormat else {
throw DiskImageStackError.invalidDiskImage(url, "base disk format does not match")
}
guard image.layerType == nil, image.parentUUID == nil else {
throw DiskImageStackError.invalidDiskImage(url, "base disk must not be an overlay")
}
if expectedFormat == .asif && image.layerUUID == nil {
throw DiskImageStackError.invalidDiskImage(url, "ASIF base disk is missing a UUID")
}
}
@available(macOS 27.0, *)
private func openOverlay(
at url: URL,
mode: OpenConfiguration.Mode
) throws -> DiskImage {
let image = try DiskImage(opening: .open(url: url, mode: mode))
guard image.format == .asif else {
throw DiskImageStackError.invalidDiskImage(url, "overlay must use ASIF format")
}
return image
}
@available(macOS 27.0, *)
private func append(_ overlay: DiskImage, to parent: DiskImage, at url: URL) throws -> any StackedImage {
do {
return try parent.appending(overlay)
} catch is IncompatibleStackingError {
throw DiskImageStackError.invalidDiskImage(url, "ASIF overlay is incompatible with its parent")
}
}
@available(macOS 27.0, *)
private func validateAppendedOverlay(_ image: any StackedImage, at url: URL) throws {
guard image.layers.last?.layerType == .overlay else {
throw DiskImageStackError.invalidDiskImage(url, "disk image must be an ASIF overlay")
}
}
@available(macOS 27.0, *)
private func diskImageBlockSize(_ value: UInt64) throws -> DiskImage.BlockSize {
guard let intValue = Int(exactly: value), let blockSize = DiskImage.BlockSize(rawValue: intValue) else {
throw DiskImageStackError.invalidBlockLayout("unsupported stacked disk block size \(value)")
}
return blockSize
}
#endif
}
@@ -0,0 +1,26 @@
import Foundation
struct HumanReadableByteCount: Encodable, CustomStringConvertible {
private let byteCount: Int
private let jsonValue: any Encodable
init<JSONValue: Encodable>(_ byteCount: Int, encodedAs: (Int) -> JSONValue) {
self.byteCount = byteCount
self.jsonValue = encodedAs(byteCount)
}
var description: String {
let formatter = MeasurementFormatter()
formatter.unitOptions = .naturalScale
formatter.unitStyle = .medium
formatter.numberFormatter.maximumFractionDigits = 0
return formatter.string(
from: Measurement(value: Double(byteCount), unit: UnitInformationStorage.bytes)
)
}
func encode(to encoder: Encoder) throws {
try jsonValue.encode(to: encoder)
}
}
+28
View File
@@ -0,0 +1,28 @@
import GRPC
import NIOPosix
/// Connects to a guest agent's gRPC endpoint over a VM's control socket, runs
/// `body` with the resulting channel, and closes the channel afterwards on both
/// the success and error paths.
///
/// The connection uses the process-wide singleton event loop group, which must
/// not be shut down, so there is no group lifecycle to manage here.
func withGuestAgentChannel<T>(
unixDomainSocketPath socketPath: String,
_ body: (GRPCChannel) async throws -> T
) async throws -> T {
let channel = try GRPCChannelPool.with(
target: .unixDomainSocket(socketPath),
transportSecurity: .plaintext,
eventLoopGroup: .singletonMultiThreadedEventLoopGroup,
)
do {
let result = try await body(channel)
try await channel.close().get()
return result
} catch {
try? await channel.close().get()
throw error
}
}
@@ -1,6 +1,5 @@
import Foundation
import Network
import NIOPosix
import GRPC
import Cirruslabs_TartGuestAgent_Apple_Swift
import Cirruslabs_TartGuestAgent_Grpc_Swift
@@ -9,34 +8,21 @@ class AgentResolver {
static func ResolveIP(_ controlSocketPath: String) async throws -> IPv4Address? {
do {
return try await resolveIP(controlSocketPath)
} catch let error as GRPCConnectionPoolError {
} catch is GRPCConnectionPoolError {
return nil
}
}
private static func resolveIP(_ controlSocketPath: String) async throws -> IPv4Address? {
// Create a gRPC channel connected to the VM's control socket
let group = MultiThreadedEventLoopGroup(numberOfThreads: 1)
defer {
try! group.syncShutdownGracefully()
try await withGuestAgentChannel(unixDomainSocketPath: controlSocketPath) { channel in
// Invoke ResolveIP() gRPC method
let callOptions = CallOptions(timeLimit: .timeout(.seconds(1)))
let agentAsyncClient = AgentAsyncClient(channel: channel)
let resolveIPCall = agentAsyncClient.makeResolveIpCall(ResolveIPRequest(), callOptions: callOptions)
let response = try await resolveIPCall.response
return IPv4Address(response.ip)
}
let channel = try GRPCChannelPool.with(
target: .unixDomainSocket(controlSocketPath),
transportSecurity: .plaintext,
eventLoopGroup: group,
)
defer {
try! channel.close().wait()
}
// Invoke ResolveIP() gRPC method
let callOptions = CallOptions(timeLimit: .timeout(.seconds(1)))
let agentAsyncClient = AgentAsyncClient(channel: channel)
let resolveIPCall = agentAsyncClient.makeResolveIpCall(ResolveIPRequest(), callOptions: callOptions)
let response = try await resolveIPCall.response
return IPv4Address(response.ip)
}
}
+51 -1
View File
@@ -11,12 +11,22 @@ enum SoftnetError: Error {
class Softnet: Network {
private let process = Process()
private var controlFileHandle: FileHandle?
private var monitorTask: Task<Void, Error>? = nil
private let monitorTaskFinished = ManagedAtomic<Bool>(false)
let vmFD: Int32
init(vmMACAddress: String, extraArguments: [String] = []) throws {
init(vmMACAddress: String, extraArguments: [String] = [], controlFD: Int32? = nil) throws {
if let controlFD = controlFD {
guard controlFD > STDERR_FILENO else {
throw SoftnetError.InitializationFailed(why: "Softnet control file descriptor must be greater than 2")
}
controlFileHandle = FileHandle(fileDescriptor: controlFD, closeOnDealloc: true)
try Self.validateControlFD(controlFD)
}
let fds = UnsafeMutablePointer<Int32>.allocate(capacity: MemoryLayout<Int>.stride * 2)
let ret = socketpair(AF_UNIX, SOCK_DGRAM, 0, fds)
@@ -33,6 +43,44 @@ class Softnet: Network {
process.executableURL = try Self.softnetExecutableURL()
process.arguments = ["--vm-fd", String(STDIN_FILENO), "--vm-mac-address", vmMACAddress] + extraArguments
process.standardInput = FileHandle(fileDescriptor: softnetFD, closeOnDealloc: false)
if let controlFileHandle = controlFileHandle {
process.arguments! += ["--control-fd", String(STDOUT_FILENO)]
process.standardOutput = controlFileHandle
}
}
static func validateControlFD(_ fd: Int32) throws {
guard fd > STDERR_FILENO else {
throw SoftnetError.InitializationFailed(why: "Softnet control file descriptor must be greater than 2")
}
var socketType: Int32 = 0
var socketTypeLength = socklen_t(MemoryLayout<Int32>.size)
guard getsockopt(fd, SOL_SOCKET, SO_TYPE, &socketType, &socketTypeLength) == 0 else {
let details = Errno(rawValue: CInt(errno))
throw SoftnetError.InitializationFailed(why: "Softnet control file descriptor is not a socket: \(details)")
}
guard socketType == SOCK_STREAM else {
throw SoftnetError.InitializationFailed(why: "Softnet control file descriptor must be a Unix stream socket")
}
var peerAddress = sockaddr_storage()
var peerAddressLength = socklen_t(MemoryLayout<sockaddr_storage>.size)
let result = withUnsafeMutablePointer(to: &peerAddress) { pointer in
pointer.withMemoryRebound(to: sockaddr.self, capacity: 1) {
getpeername(fd, $0, &peerAddressLength)
}
}
guard result == 0 else {
let details = Errno(rawValue: CInt(errno))
throw SoftnetError.InitializationFailed(why: "Softnet control file descriptor is not connected: \(details)")
}
guard peerAddress.ss_family == sa_family_t(AF_UNIX) else {
throw SoftnetError.InitializationFailed(why: "Softnet control file descriptor must be a Unix stream socket")
}
}
static func softnetExecutableURL() throws -> URL {
@@ -46,6 +94,8 @@ class Softnet: Network {
}
func run(_ sema: AsyncSemaphore) throws {
defer { try? controlFileHandle?.close() }
try process.run()
monitorTask = Task {
+45 -7
View File
@@ -7,6 +7,8 @@ enum DigestError: Error {
}
class Digest {
private static let fileBufferSize = 4 * 1024 * 1024
var hash: SHA256 = SHA256()
func update(_ data: Data) {
@@ -22,7 +24,10 @@ class Digest {
}
static func hash(_ url: URL) throws -> String {
hash(try Data(contentsOf: url))
let file = try FileHandle(forReadingFrom: url)
defer { try? file.close() }
return try hashContents(from: file)
}
static func hash(_ url: URL, offset: UInt64, size: UInt64) throws -> String {
@@ -36,20 +41,53 @@ class Digest {
throw DigestError.InvalidOffset
}
if (offset + size) > fileSize {
if size > fileSize - offset {
throw DigestError.InvalidSize
}
// Read a chunk of size ``size`` at offset ``offset``
// and calculate it's digest
// Read the requested range incrementally and calculate its digest.
let fh = try FileHandle(forReadingFrom: url)
defer { try! fh.close() }
defer { try? fh.close() }
try fh.seek(toOffset: offset)
let data = try fh.read(upToCount: Int(size))!
return try hashContents(from: fh, size: size)
}
return hash(data)
/// Streams a file into SHA-256 while keeping Foundation's temporary read
/// buffers scoped to one chunk.
private static func hashContents(from file: FileHandle, size: UInt64? = nil) throws -> String {
let digest = Digest()
var remaining = size
while remaining.map({ $0 > 0 }) ?? true {
let didRead = try autoreleasepool { () throws -> Bool in
let count = remaining.map {
Int(min(UInt64(fileBufferSize), $0))
} ?? fileBufferSize
guard let data = try file.read(upToCount: count), !data.isEmpty else {
if remaining != nil {
throw DigestError.InvalidSize
}
return false
}
digest.update(data)
if let bytesRemaining = remaining {
remaining = bytesRemaining - UInt64(data.count)
}
return true
}
if !didRead {
break
}
}
return digest.finalize()
}
}
+1 -1
View File
@@ -1,6 +1,6 @@
import Foundation
protocol Disk {
static func push(diskURL: URL, registry: Registry, chunkSizeMb: Int, concurrency: UInt, progress: Progress) async throws -> [OCIManifestLayer]
static func push(diskURL: URL, mediaType: String, registry: Registry, chunkSizeMb: Int, concurrency: UInt, progress: Progress) async throws -> [OCIManifestLayer]
static func pull(registry: Registry, diskLayers: [OCIManifestLayer], diskURL: URL, concurrency: UInt, progress: Progress, localLayerCache: LocalLayerCache?, deduplicate: Bool) async throws
}
+9 -2
View File
@@ -22,7 +22,14 @@ class DiskV2: Disk {
private static let holeGranularityBytes = 4 * 1024 * 1024
private static let zeroChunk = Data(count: holeGranularityBytes)
static func push(diskURL: URL, registry: Registry, chunkSizeMb: Int, concurrency: UInt, progress: Progress) async throws -> [OCIManifestLayer] {
static func push(
diskURL: URL,
mediaType: String,
registry: Registry,
chunkSizeMb: Int,
concurrency: UInt,
progress: Progress
) async throws -> [OCIManifestLayer] {
var pushedLayers: [(index: Int, pushedLayer: OCIManifestLayer)] = []
// Open the disk file
@@ -63,7 +70,7 @@ class DiskV2: Disk {
progress.completedUnitCount += Int64(data.count)
return (index, OCIManifestLayer(
mediaType: diskV2MediaType,
mediaType: mediaType,
size: compressedData.count,
digest: compressedDataDigest,
uncompressedSize: UInt64(data.count),
+165
View File
@@ -7,11 +7,13 @@ let ociConfigMediaType = "application/vnd.oci.image.config.v1+json"
// Layer media types
let configMediaType = "application/vnd.cirruslabs.tart.config.v1"
let diskV2MediaType = "application/vnd.cirruslabs.tart.disk.v2"
let asifOverlayMediaType = "application/vnd.cirruslabs.tart.disk.asif.overlay.v1"
let nvramMediaType = "application/vnd.cirruslabs.tart.nvram.v1"
// Manifest annotations
let uncompressedDiskSizeAnnotation = "org.cirruslabs.tart.uncompressed-disk-size"
let uploadTimeAnnotation = "org.cirruslabs.tart.upload-time"
let diskBlockSizeAnnotation = "org.cirruslabs.tart.disk.block-size"
// Manifest labels
let diskFormatLabel = "org.cirruslabs.tart.disk.format"
@@ -19,6 +21,51 @@ let diskFormatLabel = "org.cirruslabs.tart.disk.format"
// Layer annotations
let uncompressedSizeAnnotation = "org.cirruslabs.tart.uncompressed-size"
let uncompressedContentDigestAnnotation = "org.cirruslabs.tart.uncompressed-content-digest"
let diskFileContentDigestAnnotation = "org.cirruslabs.tart.disk-file-content-digest"
let diskFileChunkCountAnnotation = "org.cirruslabs.tart.disk-file-chunk-count"
/// The OCI-layer descriptors whose Tart disk chunks reconstruct one complete
/// base disk or ASIF overlay.
struct TartDiskFileGroup: Equatable {
enum Kind: Equatable {
case base
case asifOverlay
}
var kind: Kind
var chunks: [OCIManifestLayer]
/// Whole reconstructed-file digest. Existing flat manifests do not have
/// this until a macOS 27 clone normalizes its local manifest copy.
var contentDigest: String?
/// Expected size of the complete disk file reconstructed from these chunks.
func uncompressedSize() -> UInt64? {
var result: UInt64 = 0
for chunk in chunks {
guard let size = chunk.uncompressedSize() else {
return nil
}
let addition = result.addingReportingOverflow(size)
guard !addition.overflow else {
return nil
}
result = addition.partialValue
}
return result
}
}
enum TartDiskRepresentation: Equatable {
case flat(base: TartDiskFileGroup)
case stacked(base: TartDiskFileGroup, overlays: [TartDiskFileGroup])
}
enum OCIManifestValidationError: Error, Equatable {
case invalidLayout(String)
case invalidDiskMetadata(String)
}
struct OCIManifest: Codable, Equatable {
var schemaVersion: Int = 2
@@ -63,6 +110,116 @@ struct OCIManifest: Codable, Equatable {
return UInt64(value)
}
/// Parse Tart's canonical `config -> disk descriptors -> NVRAM` order.
/// A stacked image has a leading `disk.v2` base run followed by one or more
/// contiguous ASIF overlay chunk groups.
func tartDiskRepresentation() throws -> TartDiskRepresentation {
guard layers.filter({ $0.mediaType == configMediaType }).count == 1 else {
throw OCIManifestValidationError.invalidLayout("manifest must contain exactly one Tart config descriptor")
}
guard layers.filter({ $0.mediaType == nvramMediaType }).count == 1 else {
throw OCIManifestValidationError.invalidLayout("manifest must contain exactly one NVRAM descriptor")
}
guard layers.first?.mediaType == configMediaType,
layers.last?.mediaType == nvramMediaType else {
throw OCIManifestValidationError.invalidLayout("descriptors must be ordered as config, disk chunks, then NVRAM")
}
let diskDescriptors = Array(layers.dropFirst().dropLast())
guard !diskDescriptors.isEmpty else {
throw OCIManifestValidationError.invalidLayout("manifest has no disk chunks")
}
let baseChunkCount = diskDescriptors.prefix { $0.mediaType == diskV2MediaType }.count
guard baseChunkCount > 0 else {
throw OCIManifestValidationError.invalidLayout("disk chunks must start with a disk.v2 base")
}
let baseChunks = Array(diskDescriptors.prefix(baseChunkCount))
try validateChunkMetadata(baseChunks)
guard baseChunks.first?.diskFileChunkCount() == nil,
baseChunks.dropFirst().allSatisfy({
$0.diskFileContentDigest() == nil && $0.diskFileChunkCount() == nil
}) else {
throw OCIManifestValidationError.invalidDiskMetadata("base disk metadata must appear only on its first chunk")
}
let base = TartDiskFileGroup(
kind: .base,
chunks: baseChunks,
contentDigest: baseChunks.first?.diskFileContentDigest()
)
guard baseChunkCount < diskDescriptors.count else {
return .flat(base: base)
}
guard base.contentDigest != nil else {
throw OCIManifestValidationError.invalidDiskMetadata("a stacked base disk needs a whole-file content digest")
}
var overlays: [TartDiskFileGroup] = []
var index = baseChunkCount
while index < diskDescriptors.count {
let first = diskDescriptors[index]
guard first.mediaType == asifOverlayMediaType else {
throw OCIManifestValidationError.invalidLayout("unsupported disk chunk media type: \(first.mediaType)")
}
guard let contentDigest = first.diskFileContentDigest(),
let chunkCount = first.diskFileChunkCount() else {
throw OCIManifestValidationError.invalidDiskMetadata("an ASIF overlay needs a content digest and chunk count")
}
guard chunkCount > 0, index + chunkCount <= diskDescriptors.count else {
throw OCIManifestValidationError.invalidDiskMetadata("ASIF overlay chunk count is invalid")
}
let chunks = Array(diskDescriptors[index..<(index + chunkCount)])
guard chunks.allSatisfy({ $0.mediaType == asifOverlayMediaType }) else {
throw OCIManifestValidationError.invalidLayout("ASIF overlay chunks must be contiguous")
}
guard chunks.dropFirst().allSatisfy({ $0.diskFileContentDigest() == nil && $0.diskFileChunkCount() == nil }) else {
throw OCIManifestValidationError.invalidDiskMetadata("ASIF overlay metadata must appear only on its first chunk")
}
try validateChunkMetadata(chunks)
overlays.append(TartDiskFileGroup(kind: .asifOverlay, chunks: chunks, contentDigest: contentDigest))
index += chunkCount
}
return .stacked(base: base, overlays: overlays)
}
/// Returns content-store digests needed to reconstruct this disk stack.
func diskContentDigests() throws -> [String] {
switch try tartDiskRepresentation() {
case .flat(let base):
return base.contentDigest.map { [$0] } ?? []
case .stacked(let base, let overlays):
return ([base] + overlays).compactMap(\.contentDigest)
}
}
private func validateChunkMetadata(_ chunks: [OCIManifestLayer]) throws {
guard chunks.allSatisfy({ $0.uncompressedSize() != nil && $0.uncompressedContentDigest() != nil }) else {
throw OCIManifestValidationError.invalidDiskMetadata("disk chunks need uncompressed size and content digest")
}
}
func diskBlockSize() -> UInt64? {
annotations?[diskBlockSizeAnnotation].flatMap(UInt64.init)
}
func diskBlockCount() -> UInt64? {
guard let diskSize = uncompressedDiskSize(),
let blockSize = diskBlockSize(),
blockSize > 0,
diskSize.isMultiple(of: blockSize) else {
return nil
}
return diskSize / blockSize
}
}
struct OCIConfig: Codable {
@@ -121,6 +278,14 @@ struct OCIManifestLayer: Codable, Equatable, Hashable {
annotations?[uncompressedContentDigestAnnotation]
}
func diskFileContentDigest() -> String? {
annotations?[diskFileContentDigestAnnotation]
}
func diskFileChunkCount() -> Int? {
annotations?[diskFileChunkCountAnnotation].flatMap(Int.init)
}
static func == (lhs: Self, rhs: Self) -> Bool {
return lhs.digest == rhs.digest
}
+14 -12
View File
@@ -104,40 +104,42 @@ struct UnsupportedHostOSError: Error, CustomStringConvertible {
return result
}
func keyboards() -> [VZKeyboardConfiguration] {
func keyboards(noUSB: Bool) -> [VZKeyboardConfiguration] {
var devices: [VZKeyboardConfiguration] = noUSB ? [] : [VZUSBKeyboardConfiguration()]
if #available(macOS 14, *) {
// Mac keyboard is only supported by guests starting with macOS Ventura
return [VZUSBKeyboardConfiguration(), VZMacKeyboardConfiguration()]
} else {
return [VZUSBKeyboardConfiguration()]
devices.append(VZMacKeyboardConfiguration())
}
return devices
}
func keyboardsSuspendable() -> [VZKeyboardConfiguration] {
func keyboardsSuspendable(noUSB: Bool) -> [VZKeyboardConfiguration] {
if #available(macOS 14, *) {
return [VZMacKeyboardConfiguration()]
} else {
// fallback to the regular configuration
return keyboards()
return keyboards(noUSB: noUSB)
}
}
func pointingDevices() -> [VZPointingDeviceConfiguration] {
func pointingDevices(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
// Trackpad is only supported by guests starting with macOS Ventura
[VZUSBScreenCoordinatePointingDeviceConfiguration(), VZMacTrackpadConfiguration()]
var devices: [VZPointingDeviceConfiguration] = noUSB ? [] : [VZUSBScreenCoordinatePointingDeviceConfiguration()]
devices.append(VZMacTrackpadConfiguration())
return devices
}
func pointingDevicesSimplified() -> [VZPointingDeviceConfiguration] {
func pointingDevicesSimplified(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
// Only include the USB pointing device, not the trackpad
return [VZUSBScreenCoordinatePointingDeviceConfiguration()]
return noUSB ? [] : [VZUSBScreenCoordinatePointingDeviceConfiguration()]
}
func pointingDevicesSuspendable() -> [VZPointingDeviceConfiguration] {
func pointingDevicesSuspendable(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
if #available(macOS 14, *) {
return [VZMacTrackpadConfiguration()]
} else {
// fallback to the regular configuration
return pointingDevices()
return pointingDevices(noUSB: noUSB)
}
}
}
+6 -6
View File
@@ -35,16 +35,16 @@ struct Linux: Platform {
return result
}
func keyboards() -> [VZKeyboardConfiguration] {
[VZUSBKeyboardConfiguration()]
func keyboards(noUSB: Bool) -> [VZKeyboardConfiguration] {
noUSB ? [] : [VZUSBKeyboardConfiguration()]
}
func pointingDevices() -> [VZPointingDeviceConfiguration] {
[VZUSBScreenCoordinatePointingDeviceConfiguration()]
func pointingDevices(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
noUSB ? [] : [VZUSBScreenCoordinatePointingDeviceConfiguration()]
}
func pointingDevicesSimplified() -> [VZPointingDeviceConfiguration] {
func pointingDevicesSimplified(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
// Linux doesn't support trackpad, so just return the regular pointing devices
return pointingDevices()
return pointingDevices(noUSB: noUSB)
}
}
+5 -5
View File
@@ -5,12 +5,12 @@ protocol Platform: Codable {
func bootLoader(nvramURL: URL) throws -> VZBootLoader
func platform(nvramURL: URL, needsNestedVirtualization: Bool) throws -> VZPlatformConfiguration
func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration
func keyboards() -> [VZKeyboardConfiguration]
func pointingDevices() -> [VZPointingDeviceConfiguration]
func pointingDevicesSimplified() -> [VZPointingDeviceConfiguration]
func keyboards(noUSB: Bool) -> [VZKeyboardConfiguration]
func pointingDevices(noUSB: Bool) -> [VZPointingDeviceConfiguration]
func pointingDevicesSimplified(noUSB: Bool) -> [VZPointingDeviceConfiguration]
}
protocol PlatformSuspendable: Platform {
func pointingDevicesSuspendable() -> [VZPointingDeviceConfiguration]
func keyboardsSuspendable() -> [VZKeyboardConfiguration]
func pointingDevicesSuspendable(noUSB: Bool) -> [VZPointingDeviceConfiguration]
func keyboardsSuspendable(noUSB: Bool) -> [VZKeyboardConfiguration]
}
+137 -59
View File
@@ -32,86 +32,157 @@ struct Root: AsyncParsableCommand {
FQN.self,
])
public static func main() async throws {
// Note: main() is intentionally synchronous. Swift's asynchronous main() entry
// point implicitly starts an executor that owns the main thread — and since
// Swift 6.4 that executor is no longer backed by the Dispatch main queue — so
// running an AppKit/SwiftUI run loop nested inside it leaves the main run loop
// unable to drain Tasks or DispatchQueue.main, and a VM started via "tart run"
// never boots. Keeping main() synchronous lets a command that needs the main
// run loop own it at the top level, exactly like a plain SwiftUI app.
public static func main() {
// Add commands that are only available on specific macOS versions
if #available(macOS 14, *) {
configuration.subcommands.append(Suspend.self)
}
// Ensure the default SIGINT handled is disabled,
// otherwise there's a race between two handlers
signal(SIGINT, SIG_IGN);
// Handle cancellation by Ctrl+C ourselves
let task = withUnsafeCurrentTask { $0 }!
let sigintSrc = DispatchSource.makeSignalSource(signal: SIGINT)
sigintSrc.setEventHandler {
task.cancel()
}
sigintSrc.activate()
// Ensure the default SIGINT handler is disabled, otherwise there's a race
// between two handlers. We handle cancellation by Ctrl+C ourselves below.
signal(SIGINT, SIG_IGN)
// Set line-buffered output for stdout
setlinebuf(stdout)
defer { OTel.shared.flush() }
// Parse the command up-front, synchronously, so we can decide who gets to own
// the main thread before any concurrency is involved.
//
// ParsableCommand isn't Sendable, but we only ever hand it to the single task
// spawned below and never touch it again afterwards, so transferring it into
// that task is safe.
nonisolated(unsafe) let command: ParsableCommand
do {
command = try parseAsRoot()
} catch {
exit(withError: error)
}
if let mainThreadCommand = command as? MainThreadCommand {
// This command drives a run loop on the main thread, so run it right here,
// letting it own the main thread at the top level.
MainActor.assumeIsolated {
runOnMainThread(mainThreadCommand)
}
} else {
// Every other command is asynchronous and doesn't touch the main thread, so
// drive it from a detached task and let the Dispatch main queue keep the
// process alive until the command exits.
let task = Task.detached {
await runInBackground(command)
}
// Handle cancellation by Ctrl+C ourselves
let sigintSrc = DispatchSource.makeSignalSource(signal: SIGINT)
sigintSrc.setEventHandler {
task.cancel()
}
sigintSrc.activate()
dispatchMain()
}
}
@MainActor
private static func runOnMainThread(_ command: MainThreadCommand) {
let span = startCommandSpan(for: command)
runGarbageCollection(for: command)
do {
// Parse command
var command = try parseAsRoot()
// Enters the run loop and only returns once the command exits via
// Foundation.exit(), so the lines below are a best-effort fallback.
try command.runOnMainThread()
} catch {
handleError(error, span: span)
}
// Create a root span for the command we're about to run
let span = OTel.shared.tracer.spanBuilder(spanName: type(of: command)._commandName).startSpan()
defer { span.end() }
OpenTelemetry.instance.contextProvider.setActiveSpan(span)
span.end()
OTel.shared.flush()
Foundation.exit(0)
}
// Enrich root command span with command's arguments
let commandLineArguments = ProcessInfo.processInfo.arguments.map { argument in
AttributeValue.string(argument)
}
span.setAttribute(key: "Command-line arguments", value: .array(AttributeArray(values: commandLineArguments)))
private static func runInBackground(_ command: ParsableCommand) async {
let span = startCommandSpan(for: command)
runGarbageCollection(for: command)
// Enrich root command span with Cirrus CI-specific tags
if let tags = ProcessInfo.processInfo.environment["CIRRUS_SENTRY_TAGS"] {
for (key, value) in tags.split(separator: ",").compactMap(splitEnvironmentVariable) {
span.setAttribute(key: key, value: .string(value))
}
}
// Run garbage-collection before each command (shouldn't take too long)
if type(of: command) != type(of: Pull()) && type(of: command) != type(of: Clone()){
do {
try Config().gc()
} catch {
fputs("Failed to perform garbage collection: \(error)\n", stderr)
}
}
// Run command
do {
if var asyncCommand = command as? AsyncParsableCommand {
try await asyncCommand.run()
} else {
var command = command
try command.run()
}
} catch {
// Not an error, just a custom exit code from "tart exec"
if let execCustomExitCodeError = error as? ExecCustomExitCodeError {
OTel.shared.flush()
Foundation.exit(execCustomExitCodeError.exitCode)
}
// Capture the error into OpenTelemetry
OpenTelemetry.instance.contextProvider.activeSpan?.recordException(error)
// Handle a non-ArgumentParser's exception that requires a specific exit code to be set
if let errorWithExitCode = error as? HasExitCode {
fputs("\(error)\n", stderr)
OTel.shared.flush()
Foundation.exit(errorWithExitCode.exitCode)
}
// Handle any other exception, including ArgumentParser's ones
exit(withError: error)
handleError(error, span: span)
}
span.end()
OTel.shared.flush()
Foundation.exit(0)
}
// Create a root span for the command we're about to run.
private static func startCommandSpan(for command: ParsableCommand) -> Span {
let span = OTel.shared.tracer.spanBuilder(spanName: type(of: command)._commandName).startSpan()
OpenTelemetry.instance.contextProvider.setActiveSpan(span)
// Enrich root command span with command's arguments
let commandLineArguments = ProcessInfo.processInfo.arguments.map { argument in
AttributeValue.string(argument)
}
span.setAttribute(key: "Command-line arguments", value: .array(AttributeArray(values: commandLineArguments)))
// Enrich root command span with Cirrus CI-specific tags
if let tags = ProcessInfo.processInfo.environment["CIRRUS_SENTRY_TAGS"] {
for (key, value) in tags.split(separator: ",").compactMap(splitEnvironmentVariable) {
span.setAttribute(key: key, value: .string(value))
}
}
return span
}
// Run garbage-collection before each command (shouldn't take too long).
private static func runGarbageCollection(for command: ParsableCommand) {
if type(of: command) != type(of: Pull()) && type(of: command) != type(of: Clone()) {
do {
try Config().gc()
} catch {
fputs("Failed to perform garbage collection: \(error)\n", stderr)
}
}
}
private static func handleError(_ error: Error, span: Span) -> Never {
// Not an error, just a custom exit code from "tart exec"
if let execCustomExitCodeError = error as? ExecCustomExitCodeError {
span.end()
OTel.shared.flush()
Foundation.exit(execCustomExitCodeError.exitCode)
}
// Capture the error into OpenTelemetry
OpenTelemetry.instance.contextProvider.activeSpan?.recordException(error)
span.end()
// Handle a non-ArgumentParser's exception that requires a specific exit code to be set
if let errorWithExitCode = error as? HasExitCode {
fputs("\(error)\n", stderr)
OTel.shared.flush()
Foundation.exit(errorWithExitCode.exitCode)
}
// Handle any other exception, including ArgumentParser's ones
OTel.shared.flush()
exit(withError: error)
}
private static func splitEnvironmentVariable(_ tag: String.SubSequence) -> (String, String)? {
@@ -123,3 +194,10 @@ struct Root: AsyncParsableCommand {
return (String(splits[0]), String(splits[1]))
}
}
// A command that drives an AppKit/SwiftUI run loop and therefore has to own the
// main thread at the top level, rather than running inside Swift's asynchronous
// main() executor. See Root.main() for the rationale.
protocol MainThreadCommand: ParsableCommand {
@MainActor func runOnMainThread() throws
}
+21
View File
@@ -1,5 +1,26 @@
import Foundation
// A fire-and-forget task that reports any thrown error to stderr. An unstructured
// Task spawned from a synchronous context (a signal handler, a SwiftUI action) has
// no parent to propagate its error to, so we report it here instead of dropping it.
struct ErrorReportingTask {
let task: Task<Void, Never>
// Inherit the caller's actor context, exactly as Task.init does. Without this, an
// operation written inside a @MainActor function runs on the cooperative pool
// rather than the main queue, trapping in callees that assert their queue.
@discardableResult
init(_ context: String, @_inheritActorContext operation: @escaping @Sendable () async throws -> Void) {
task = Task {
do {
try await operation()
} catch {
fputs("\(context): \(error)\n", stderr)
}
}
}
}
extension Collection {
subscript (safe index: Index) -> Element? {
indices.contains(index) ? self[index] : nil
+68 -34
View File
@@ -49,6 +49,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
nested: Bool = false,
audio: Bool = true,
clipboard: Bool = true,
noUSBAccessories: Bool = false,
sync: VZDiskImageSynchronizationMode = .full,
caching: VZDiskImageCachingMode? = nil,
noTrackpad: Bool = false,
@@ -64,7 +65,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
// Initialize the virtual machine and its configuration
self.network = network
configuration = try Self.craftConfiguration(diskURL: vmDir.diskURL,
configuration = try Self.craftConfiguration(vmDir: vmDir,
nvramURL: vmDir.nvramURL, vmConfig: config,
network: network, additionalStorageDevices: additionalStorageDevices,
directorySharingDevices: directorySharingDevices,
@@ -73,6 +74,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
nested: nested,
audio: audio,
clipboard: clipboard,
noUSBAccessories: noUSBAccessories,
sync: sync,
caching: caching,
noTrackpad: noTrackpad,
@@ -196,7 +198,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
// Initialize the virtual machine and its configuration
self.network = network
configuration = try Self.craftConfiguration(diskURL: vmDir.diskURL, nvramURL: vmDir.nvramURL,
configuration = try Self.craftConfiguration(vmDir: vmDir,
nvramURL: vmDir.nvramURL,
vmConfig: config, network: network,
additionalStorageDevices: additionalStorageDevices,
directorySharingDevices: directorySharingDevices,
@@ -244,13 +247,13 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
return try VM(vmDir: vmDir)
}
func start(recovery: Bool, resume shouldResume: Bool) async throws {
func start(recovery: Bool, resume shouldResume: Bool, provisioning: GuestProvisioningOptions? = nil) async throws {
try network.run(sema)
if shouldResume {
try await resume()
} else {
try await start(recovery)
try await start(recovery, provisioning: provisioning)
}
}
@@ -286,10 +289,15 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
}
@MainActor
private func start(_ recovery: Bool) async throws {
private func start(_ recovery: Bool, provisioning: GuestProvisioningOptions? = nil) async throws {
#if arch(arm64)
let startOptions = VZMacOSVirtualMachineStartOptions()
startOptions.startUpFromMacOSRecovery = recovery
#if compiler(>=6.4)
if let provisioning = provisioning, #available(macOS 27, *) {
try startOptions.setGuestProvisioning(provisioning.toVZMacGuestProvisioningOptions())
}
#endif
try await virtualMachine.start(options: startOptions)
#else
try await virtualMachine.start()
@@ -307,7 +315,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
}
static func craftConfiguration(
diskURL: URL,
vmDir: VMDirectory,
nvramURL: URL,
vmConfig: VMConfig,
network: Network = NetworkShared(),
@@ -318,6 +326,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
nested: Bool = false,
audio: Bool = true,
clipboard: Bool = true,
noUSBAccessories: Bool = false,
sync: VZDiskImageSynchronizationMode = .full,
caching: VZDiskImageCachingMode? = nil,
noTrackpad: Bool = false,
@@ -358,25 +367,15 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
configuration.audioDevices = [soundDeviceConfiguration]
// Keyboard and mouse
if suspendable, let platformSuspendable = vmConfig.platform.self as? PlatformSuspendable {
configuration.keyboards = platformSuspendable.keyboardsSuspendable()
configuration.pointingDevices = platformSuspendable.pointingDevicesSuspendable()
} else {
if noKeyboard {
configuration.keyboards = []
} else {
configuration.keyboards = vmConfig.platform.keyboards()
}
if noPointer {
configuration.pointingDevices = []
} else if noTrackpad {
configuration.pointingDevices = vmConfig.platform.pointingDevicesSimplified()
} else {
configuration.pointingDevices = vmConfig.platform.pointingDevices()
}
}
configureInputDevices(
configuration,
platform: vmConfig.platform,
suspendable: suspendable,
noUSBAccessories: noUSBAccessories,
noTrackpad: noTrackpad,
noPointer: noPointer,
noKeyboard: noKeyboard
)
// Networking
configuration.networkDevices = network.attachments().map {
@@ -399,15 +398,25 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
}
// Storage
var attachment = try VZDiskImageStorageDeviceAttachment(
url: diskURL,
readOnly: false,
// When not specified, use "cached" caching mode for Linux VMs to prevent file-system corruption[1]
//
// [1]: https://github.com/cirruslabs/tart/pull/675
cachingMode: caching ?? (vmConfig.os == .linux ? .cached : .automatic),
synchronizationMode: sync
)
// When not specified, use "cached" caching mode for Linux VMs to prevent file-system corruption[1]
//
// [1]: https://github.com/cirruslabs/tart/pull/675
let cachingMode = caching ?? (vmConfig.os == .linux ? .cached : .automatic)
let attachment: VZStorageDeviceAttachment
if vmDir.isStackedVM {
attachment = try vmDir.diskImageStack().makeAttachment(
readOnly: false,
cachingMode: cachingMode,
synchronizationMode: sync
)
} else {
attachment = try VZDiskImageStorageDeviceAttachment(
url: vmDir.diskURL,
readOnly: false,
cachingMode: cachingMode,
synchronizationMode: sync
)
}
var devices: [VZStorageDeviceConfiguration] = [VZVirtioBlockDeviceConfiguration(attachment: attachment)]
devices.append(contentsOf: additionalStorageDevices)
@@ -444,6 +453,31 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
return configuration
}
static func configureInputDevices(
_ configuration: VZVirtualMachineConfiguration,
platform: Platform,
suspendable: Bool = false,
noUSBAccessories: Bool = false,
noTrackpad: Bool = false,
noPointer: Bool = false,
noKeyboard: Bool = false
) {
if suspendable, let platformSuspendable = platform as? PlatformSuspendable {
configuration.keyboards = platformSuspendable.keyboardsSuspendable(noUSB: noUSBAccessories)
configuration.pointingDevices = platformSuspendable.pointingDevicesSuspendable(noUSB: noUSBAccessories)
} else {
configuration.keyboards = noKeyboard ? [] : platform.keyboards(noUSB: noUSBAccessories)
if noPointer {
configuration.pointingDevices = []
} else if noTrackpad {
configuration.pointingDevices = platform.pointingDevicesSimplified(noUSB: noUSBAccessories)
} else {
configuration.pointingDevices = platform.pointingDevices(noUSB: noUSBAccessories)
}
}
}
func guestDidStop(_ virtualMachine: VZVirtualMachine) {
print("guest has stopped the virtual machine")
sema.signal()
+1 -1
View File
@@ -99,7 +99,7 @@ struct VMConfig: Codable {
func save(toURL: URL) throws {
let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
try encoder.encode(self).write(to: toURL)
}
+152 -1
View File
@@ -1,3 +1,4 @@
import Foundation
import System
import AppleArchive
@@ -10,6 +11,16 @@ fileprivate let permissions = FilePermissions(rawValue: 0o644)
// [2]: https://developer.apple.com/documentation/compression/algorithm/lzfse
extension VMDirectory {
func exportToArchive(path: String) throws {
let temporaryArchive = try stackedArchiveDirectoryIfNeeded()
let archiveSourceURL = temporaryArchive?.vmDirectory.baseURL ?? baseURL
defer {
if let temporaryArchive {
try? temporaryArchive.lock.unlock()
try? temporaryArchive.vmDirectory.removeFromDisk()
}
}
guard let fileStream = ArchiveByteStream.fileStream(
path: FilePath(path),
mode: .writeOnly,
@@ -49,7 +60,7 @@ extension VMDirectory {
return
}
try encodeStream.writeDirectoryContents(archiveFrom: FilePath(baseURL.path), keySet: keySet)
try encodeStream.writeDirectoryContents(archiveFrom: FilePath(archiveSourceURL.path), keySet: keySet)
}
func importFromArchive(path: String) throws {
@@ -92,5 +103,145 @@ extension VMDirectory {
}
_ = try ArchiveStream.process(readingFrom: decodeStream, writingTo: extractStream)
if isStackedVM {
try restoreStackedArchive()
}
}
/// Builds a self-contained staging directory for a stacked archive, if this
/// directory currently resolves to a stacked VM or cached image.
private func stackedArchiveDirectoryIfNeeded() throws -> (vmDirectory: VMDirectory, lock: FileLock)? {
guard isStackedVM || isStackedCachedImage else {
return nil
}
try DiskImageStack.requireSupport()
let contentStore = try ContentStore()
let archiveVMDir = try VMDirectory.temporary()
let archiveVMDirLock = try FileLock(lockURL: archiveVMDir.baseURL)
try archiveVMDirLock.lock()
do {
let stagedSource: (isStackedVM: Bool, contentDigests: [String])? = try contentStore.withPruneLock {
() -> (isStackedVM: Bool, contentDigests: [String])? in
// OCI tags are mutable symlinks. Resolve one digest record while tag
// replacement and cached-image deletion are blocked, then copy every
// source-owned file before releasing the lock.
let sourceVMDir = VMDirectory(baseURL: baseURL.resolvingSymlinksInPath())
guard sourceVMDir.isStackedVM || sourceVMDir.isStackedCachedImage else {
throw RuntimeError.ExportFailed("VM changed while preparing export, retry the command")
}
let sourceIsStackedVM = sourceVMDir.isStackedVM
let sourceVMLock: PIDLock?
if sourceIsStackedVM {
let lock = try sourceVMDir.lock()
guard try lock.trylock() else {
throw RuntimeError.ExportFailed("VM \"\(sourceVMDir.name)\" must be stopped before export")
}
sourceVMLock = lock
// Holding the PID lock proves that the VM is not running. A saved
// state file is the remaining suspended state that must reject export.
guard !FileManager.default.fileExists(atPath: sourceVMDir.stateURL.path) else {
try? lock.unlock()
throw RuntimeError.ExportFailed("VM \"\(sourceVMDir.name)\" must be stopped before export")
}
} else {
sourceVMLock = nil
}
defer { try? sourceVMLock?.unlock() }
try FileManager.default.copyItem(at: sourceVMDir.configURL, to: archiveVMDir.configURL)
try FileManager.default.copyItem(at: sourceVMDir.nvramURL, to: archiveVMDir.nvramURL)
try FileManager.default.copyItem(at: sourceVMDir.manifestURL, to: archiveVMDir.manifestURL)
if sourceIsStackedVM {
try FileManager.default.copyItem(at: sourceVMDir.overlayURL, to: archiveVMDir.overlayURL)
}
return (sourceIsStackedVM, try archiveVMDir.diskContentDigests())
}
guard let stagedSource else {
try archiveVMDirLock.unlock()
try archiveVMDir.removeFromDisk()
return nil
}
if !stagedSource.isStackedVM {
try archiveVMDir.diskImageStack().createWritableOverlay()
}
// The staged manifest is now an in-progress reference, so immutable
// content remains protected while these potentially large copies run
// without holding the global prune lock.
for contentDigest in stagedSource.contentDigests {
guard let sourceURL = try contentStore.existingContentURL(for: contentDigest) else {
throw RuntimeError.ExportFailed("VM is missing cached disk content \(contentDigest)")
}
let destinationURL = try contentStore.contentURL(
for: contentDigest,
under: archiveContentStoreURL(in: archiveVMDir)
)
try FileManager.default.createDirectory(
at: destinationURL.deletingLastPathComponent(),
withIntermediateDirectories: true
)
try FileManager.default.copyItem(at: sourceURL, to: destinationURL)
}
return (archiveVMDir, archiveVMDirLock)
} catch {
try? archiveVMDirLock.unlock()
try? archiveVMDir.removeFromDisk()
throw error
}
}
/// Restores immutable files from an archive into the shared content store,
/// removes the archive-only payload, then validates the resulting stack.
private func restoreStackedArchive() throws {
try DiskImageStack.requireSupport()
let contentStore = try ContentStore()
// The extracted manifest is already a reference; synchronize publication
// with a concurrent prune before installing its immutable content.
try contentStore.synchronizePublishedReferences()
for contentDigest in try diskContentDigests() {
if try contentStore.existingContentURL(for: contentDigest) != nil {
continue
}
let archivedContentURL = try contentStore.contentURL(
for: contentDigest,
under: archiveContentStoreURL(in: self)
)
guard FileManager.default.fileExists(atPath: archivedContentURL.path) else {
throw RuntimeError.ImportFailed("archive is missing disk content \(contentDigest)")
}
let temporaryURL = try contentStore.temporaryContentURL(for: contentDigest)
do {
try FileManager.default.copyItem(at: archivedContentURL, to: temporaryURL)
_ = try contentStore.install(temporaryURL, contentDigest: contentDigest)
} catch {
try? FileManager.default.removeItem(at: temporaryURL)
throw error
}
}
try FileManager.default.removeItem(at: archiveContentStoreURL(in: self))
try? FileManager.default.removeItem(at: stateURL)
// Opening the attachment validates the reconstructed immutable stack and
// imported writable overlay before the VM enters local storage.
_ = try diskImageStack().makeAttachment()
}
private func archiveContentStoreURL(in vmDir: VMDirectory) -> URL {
vmDir.baseURL.appendingPathComponent("content", isDirectory: true)
}
}
@@ -0,0 +1,142 @@
import Foundation
extension VMDirectory {
/// Returns content-store digests needed to reconstruct this VM's disk stack.
func diskContentDigests() throws -> [String] {
let manifest = try OCIManifest(fromJSON: Data(contentsOf: manifestURL))
return try manifest.diskContentDigests()
}
func diskImageStack(contentStore providedStore: ContentStore? = nil) throws -> DiskImageStack {
let manifest = try OCIManifest(fromJSON: Data(contentsOf: manifestURL))
let base: TartDiskFileGroup
let overlays: [TartDiskFileGroup]
switch try manifest.tartDiskRepresentation() {
case .flat(let pinnedBase) where pinnedBase.contentDigest != nil:
base = pinnedBase
overlays = []
case .stacked(let stackedBase, let stackedOverlays):
base = stackedBase
overlays = stackedOverlays
default:
throw RuntimeError.VMConfigurationError("VM is missing its disk image metadata")
}
guard let blockSize = manifest.diskBlockSize(),
let blockCount = manifest.diskBlockCount() else {
throw DiskImageStackError.invalidBlockLayout("disk image metadata is missing block layout")
}
let contentStore = try providedStore ?? ContentStore()
let baseURL = try diskImageURL(for: base, contentStore: contentStore)
let immutableOverlayURLs = try overlays.map { try diskImageURL(for: $0, contentStore: contentStore) }
let config = try VMConfig(fromURL: configURL)
return DiskImageStack(
baseURL: baseURL,
baseFormat: config.diskFormat,
immutableOverlayURLs: immutableOverlayURLs,
writableOverlayURL: overlayURL,
blockSize: blockSize,
blockCount: blockCount
)
}
func cloneStacked(
to destination: VMDirectory,
copyWritableOverlay: Bool,
generateMAC: Bool,
contentStore: ContentStore? = nil
) throws {
let contentStore = try contentStore ?? ContentStore()
try contentStore.withPruneLock {
try FileManager.default.copyItem(at: configURL, to: destination.configURL)
try FileManager.default.copyItem(at: nvramURL, to: destination.nvramURL)
try FileManager.default.copyItem(at: manifestURL, to: destination.manifestURL)
if copyWritableOverlay {
try FileManager.default.copyItem(at: overlayURL, to: destination.overlayURL)
}
}
if !copyWritableOverlay {
try destination.diskImageStack(contentStore: contentStore).createWritableOverlay()
}
if generateMAC {
try destination.regenerateMACAddress()
}
}
func cloneAsStackedBase(
to destination: VMDirectory,
generateMAC: Bool,
contentStore providedStore: ContentStore? = nil
) throws {
let config = try VMConfig(fromURL: configURL)
let blockLayout = try DiskImageStack.baseBlockLayout(at: diskURL, expectedFormat: config.diskFormat)
let contentDigest = try Digest.hash(diskURL)
let contentStore = try providedStore ?? ContentStore()
var manifest = try OCIManifest(fromJSON: Data(contentsOf: manifestURL))
guard case .flat = try manifest.tartDiskRepresentation() else {
throw RuntimeError.VMConfigurationError("--stacked cannot use an image that already has a stacked disk")
}
guard let firstDiskIndex = manifest.layers.firstIndex(where: { $0.mediaType == diskV2MediaType }) else {
throw OCIManifestValidationError.invalidLayout("manifest must contain at least one disk chunk")
}
var baseAnnotations = manifest.layers[firstDiskIndex].annotations ?? [:]
baseAnnotations[diskFileContentDigestAnnotation] = contentDigest
manifest.layers[firstDiskIndex].annotations = baseAnnotations
let diskSize = blockLayout.blockSize.multipliedReportingOverflow(by: blockLayout.blockCount)
guard !diskSize.overflow else {
throw DiskImageStackError.invalidBlockLayout("stacked disk block layout overflows UInt64")
}
var annotations = manifest.annotations ?? [:]
annotations[diskBlockSizeAnnotation] = String(blockLayout.blockSize)
annotations[uncompressedDiskSizeAnnotation] = String(diskSize.partialValue)
manifest.annotations = annotations
try FileManager.default.copyItem(at: configURL, to: destination.configURL)
try FileManager.default.copyItem(at: nvramURL, to: destination.nvramURL)
try contentStore.withPruneLock {
try manifest.toJSON().write(to: destination.manifestURL)
}
// Publish the temporary VM's manifest before installing the shared base.
// Reference-aware pruning includes in-progress manifests, so the content
// cannot be collected in the window before this VM is moved into place.
if try contentStore.contentURLIfPresent(for: contentDigest) == nil {
let temporaryURL = try contentStore.temporaryContentURL(for: contentDigest)
do {
try FileManager.default.copyItem(at: diskURL, to: temporaryURL)
_ = try contentStore.install(temporaryURL, contentDigest: contentDigest)
} catch {
try? FileManager.default.removeItem(at: temporaryURL)
throw error
}
}
try destination.diskImageStack(contentStore: contentStore).createWritableOverlay()
if generateMAC {
try destination.regenerateMACAddress()
}
}
private func diskImageURL(for group: TartDiskFileGroup, contentStore: ContentStore) throws -> URL {
guard let contentDigest = group.contentDigest else {
throw OCIManifestValidationError.invalidDiskMetadata("stacked disk files need a whole-file content digest")
}
// Pull/install verifies immutable content before publishing it. Clone and
// run use the trusted content-addressed entry without rereading a possibly
// very large disk file, matching Tart's existing disk.img behavior.
guard let url = try contentStore.contentURLIfPresent(for: contentDigest) else {
throw RuntimeError.VMMissingFiles("VM is missing cached disk content \(contentDigest)")
}
return url
}
}
+248 -34
View File
@@ -6,7 +6,6 @@ let legacyDiskV1MediaType = "application/vnd.cirruslabs.tart.disk.v1"
enum OCIError: Error {
case ShouldBeExactlyOneLayer
case ShouldBeAtLeastOneLayer
case FailedToCreateVmFile
case LayerIsMissingUncompressedSizeAnnotation
case LayerIsMissingUncompressedDigestAnnotation
@@ -14,7 +13,7 @@ enum OCIError: Error {
extension VMDirectory {
func pullFromRegistry(registry: Registry, manifest: OCIManifest, concurrency: UInt, localLayerCache: LocalLayerCache?, deduplicate: Bool) async throws {
// Pull VM's config file layer and re-serialize it into a config file
// Pull VM's config file layer and store it as the local config file.
let configLayers = manifest.layers.filter {
$0.mediaType == configMediaType
}
@@ -30,17 +29,22 @@ extension VMDirectory {
}
try configFile.close()
// Pull VM's disk layers and decompress them into a disk file
// Pull VM's disk chunks and decompress them into complete disk files.
if manifest.layers.contains(where: { $0.mediaType == legacyDiskV1MediaType }) {
throw RuntimeError.Generic("Pulling OCI images with legacy disk media type \(legacyDiskV1MediaType) is no longer supported, please re-push the image using a current Tart version")
}
let layers = manifest.layers.filter { $0.mediaType == diskV2MediaType }
if layers.isEmpty {
throw OCIError.ShouldBeAtLeastOneLayer
let diskRepresentation = try manifest.tartDiskRepresentation()
let diskChunks: [OCIManifestLayer]
switch diskRepresentation {
case .flat(let base):
diskChunks = base.chunks
case .stacked(let base, let overlays):
diskChunks = base.chunks + overlays.flatMap(\.chunks)
}
let diskCompressedSize = layers.map { Int64($0.size) }.reduce(0, +)
let diskCompressedSize = diskChunks.map { Int64($0.size) }.reduce(0, +)
OpenTelemetry.instance.contextProvider.activeSpan?.setAttribute(
key: "compressed_disk_size_bytes",
value: .int(Int(diskCompressedSize))
@@ -53,19 +57,42 @@ extension VMDirectory {
ProgressObserver(progress).log(defaultLogger)
do {
try await DiskV2.pull(registry: registry, diskLayers: layers, diskURL: diskURL,
concurrency: concurrency, progress: progress,
localLayerCache: localLayerCache,
deduplicate: deduplicate)
switch diskRepresentation {
case .flat(let base):
try await DiskV2.pull(registry: registry, diskLayers: base.chunks, diskURL: diskURL,
concurrency: concurrency, progress: progress,
localLayerCache: localLayerCache,
deduplicate: deduplicate)
if deduplicate, let llc = localLayerCache {
// set custom attribute to remember deduplicated bytes
diskURL.setDeduplicatedBytes(llc.deduplicatedBytes)
}
case .stacked(let base, let overlays):
// The deterministic resumable directory may contain a partial
// disk.img from an interrupted pull while this tag was standalone. A
// cached stacked image must not retain that file or it is mistaken for
// a standalone VM after the pull is moved into cache.
if FileManager.default.fileExists(atPath: diskURL.path) {
try FileManager.default.removeItem(at: diskURL)
}
let contentStore = try ContentStore()
for group in [base] + overlays {
_ = try await pullDiskFile(
registry: registry,
group: group,
contentStore: contentStore,
concurrency: concurrency,
progress: progress
)
}
}
} catch let error where error is FilterError {
throw RuntimeError.PullFailed("failed to decompress disk: \(error.localizedDescription)")
}
if deduplicate, let llc = localLayerCache {
// set custom attribute to remember deduplicated bytes
diskURL.setDeduplicatedBytes(llc.deduplicatedBytes)
}
// Pull VM's NVRAM file layer and store it in an NVRAM file
defaultLogger.appendNewLine("pulling NVRAM...")
@@ -83,12 +110,50 @@ extension VMDirectory {
try nvram.write(contentsOf: data)
}
try nvram.close()
// Serialize VM's manifest to enable better deduplication on subsequent "tart pull"'s
try manifest.toJSON().write(to: manifestURL)
}
func pushToRegistry(registry: Registry, references: [String], chunkSizeMb: Int, concurrency: UInt, labels: [String: String] = [:]) async throws -> RemoteName {
/// Reconstructs one complete immutable base disk or published ASIF overlay
/// from its Tart disk chunks, unless the shared content store already has a
/// size-matching copy.
private func pullDiskFile(
registry: Registry,
group: TartDiskFileGroup,
contentStore: ContentStore,
concurrency: UInt,
progress: Progress
) async throws -> URL {
guard let contentDigest = group.contentDigest else {
throw OCIManifestValidationError.invalidDiskMetadata("stacked disk files need a whole-file content digest")
}
// Pulls for the same semantic disk file share a stable resumable path so
// DiskV2 can resume after a transient failure. Serialize writers before
// rechecking the final entry to avoid racing on that shared path.
let lock = try FileLock(lockURL: contentStore.lockURL(for: contentDigest))
try lock.lock()
defer { try? lock.unlock() }
if let existingURL = try contentStore.contentURLIfPresent(for: contentDigest),
let actualSize = UInt64(exactly: try existingURL.sizeBytes()),
let expectedSize = group.uncompressedSize(),
actualSize == expectedSize {
progress.completedUnitCount += group.chunks.reduce(0) { $0 + Int64($1.size) }
return existingURL
}
let resumableURL = try contentStore.resumableContentURL(for: contentDigest)
try await DiskV2.pull(
registry: registry,
diskLayers: group.chunks,
diskURL: resumableURL,
concurrency: concurrency,
progress: progress
)
return try contentStore.install(resumableURL, contentDigest: contentDigest)
}
func pushToRegistry(registry: Registry, references: [String], chunkSizeMb: Int, concurrency: UInt, labels: [String: String] = [:]) async throws -> (name: RemoteName, manifest: OCIManifest) {
var layers = Array<OCIManifestLayer>()
// Read VM's config and push it as blob
@@ -102,14 +167,12 @@ extension VMDirectory {
let configDigest = try await registry.pushBlob(fromData: configJSON, chunkSizeMb: chunkSizeMb)
layers.append(OCIManifestLayer(mediaType: configMediaType, size: configJSON.count, digest: configDigest))
// Compress the disk file as multiple chunks and push them as disk layers
let diskSize = try FileManager.default.attributesOfItem(atPath: diskURL.path)[.size] as! Int64
defaultLogger.appendNewLine("pushing disk... this will take a while...")
let progress = Progress(totalUnitCount: diskSize)
ProgressObserver(progress).log(defaultLogger)
layers.append(contentsOf: try await DiskV2.push(diskURL: diskURL, registry: registry, chunkSizeMb: chunkSizeMb, concurrency: concurrency, progress: progress))
let (diskLayers, diskAnnotations) = try await pushDiskLayers(
registry: registry,
chunkSizeMb: chunkSizeMb,
concurrency: concurrency
)
layers.append(contentsOf: diskLayers)
// Read VM's NVRAM and push it as blob
defaultLogger.appendNewLine("pushing NVRAM...")
@@ -122,13 +185,13 @@ extension VMDirectory {
let ociConfigContainer = OCIConfig.ConfigContainer(Labels: labels)
let ociConfigJSON = try OCIConfig(architecture: config.arch, os: config.os, config: ociConfigContainer).toJSON()
let ociConfigDigest = try await registry.pushBlob(fromData: ociConfigJSON, chunkSizeMb: chunkSizeMb)
let manifest = OCIManifest(
var manifest = OCIManifest(
config: OCIManifestConfig(size: ociConfigJSON.count, digest: ociConfigDigest),
layers: layers,
uncompressedDiskSize: UInt64(diskSize),
uploadDate: Date()
layers: layers
)
var annotations = diskAnnotations
annotations[uploadTimeAnnotation] = Date().toISO()
manifest.annotations = annotations
// Manifest
for reference in references {
defaultLogger.appendNewLine("pushing manifest for \(reference)...")
@@ -137,7 +200,158 @@ extension VMDirectory {
}
let pushedReference = Reference(digest: try manifest.digest())
return RemoteName(host: registry.host!, namespace: registry.namespace, reference: pushedReference)
let name = RemoteName(host: registry.host!, namespace: registry.namespace, reference: pushedReference)
return (name, manifest)
}
/// Builds the disk portion of the manifest. Registry transport is shared
/// for standalone and stacked VMs; only their local disk representation
/// determines which descriptors need to be uploaded or reused.
private func pushDiskLayers(
registry: Registry,
chunkSizeMb: Int,
concurrency: UInt
) async throws -> ([OCIManifestLayer], [String: String]) {
guard isStackedVM else {
let diskSize = try FileManager.default.attributesOfItem(atPath: diskURL.path)[.size] as! Int64
defaultLogger.appendNewLine("pushing disk... this will take a while...")
let progress = Progress(totalUnitCount: diskSize)
ProgressObserver(progress).log(defaultLogger)
let layers = try await DiskV2.push(
diskURL: diskURL,
mediaType: diskV2MediaType,
registry: registry,
chunkSizeMb: chunkSizeMb,
concurrency: concurrency,
progress: progress
)
return (layers, [uncompressedDiskSizeAnnotation: String(diskSize)])
}
let localManifest = try OCIManifest(fromJSON: Data(contentsOf: manifestURL))
// pushToRegistry() reads config.json before reaching this point. Closing
// that read descriptor can release the caller's fcntl PID lock, so take a
// fresh lock before hashing, uploading, and inspecting the writable overlay.
let stackedDiskLock = try lock()
guard try stackedDiskLock.trylock() else {
throw RuntimeError.VMIsRunning(name)
}
defer { try? stackedDiskLock.unlock() }
let inheritedGroups: [TartDiskFileGroup]
switch try localManifest.tartDiskRepresentation() {
case .flat(let base) where base.contentDigest != nil:
inheritedGroups = [base]
case .stacked(let base, let overlays):
inheritedGroups = [base] + overlays
default:
throw RuntimeError.VMConfigurationError("stacked VM is missing a pinned disk stack")
}
let contentStore = try ContentStore()
var layers: [OCIManifestLayer] = []
for group in inheritedGroups {
layers.append(contentsOf: try await descriptorsForCachedDiskFile(
group,
contentStore: contentStore,
registry: registry,
chunkSizeMb: chunkSizeMb,
concurrency: concurrency
))
}
let overlaySize = try FileManager.default.attributesOfItem(atPath: overlayURL.path)[.size] as! Int64
defaultLogger.appendNewLine("pushing overlay...")
let progress = Progress(totalUnitCount: overlaySize)
ProgressObserver(progress).log(defaultLogger)
let contentDigest = try Digest.hash(overlayURL)
let chunks = try await DiskV2.push(
diskURL: overlayURL,
mediaType: asifOverlayMediaType,
registry: registry,
chunkSizeMb: chunkSizeMb,
concurrency: concurrency,
progress: progress
)
layers.append(contentsOf: annotatedChunks(chunks, kind: .asifOverlay, contentDigest: contentDigest))
let blockLayout = try DiskImageStack.diskImageBlockLayout(at: overlayURL)
let diskSize = blockLayout.blockSize.multipliedReportingOverflow(by: blockLayout.blockCount)
guard !diskSize.overflow else {
throw DiskImageStackError.invalidBlockLayout("stacked disk block layout overflows UInt64")
}
var annotations = localManifest.annotations ?? [:]
annotations[diskBlockSizeAnnotation] = String(blockLayout.blockSize)
annotations[uncompressedDiskSizeAnnotation] = String(diskSize.partialValue)
return (layers, annotations)
}
/// Returns transport descriptors for an immutable disk file. If the
/// target registry lacks the original blobs, recreate them from the local
/// content store.
private func descriptorsForCachedDiskFile(
_ group: TartDiskFileGroup,
contentStore: ContentStore,
registry: Registry,
chunkSizeMb: Int,
concurrency: UInt
) async throws -> [OCIManifestLayer] {
guard let contentDigest = group.contentDigest else {
throw RuntimeError.VMConfigurationError("stacked VM is missing a pinned disk file digest")
}
var allChunksExist = true
for chunk in group.chunks {
if try await !registry.blobExists(chunk.digest) {
allChunksExist = false
break
}
}
if allChunksExist {
return group.chunks
}
// Rebuilding transport blobs republishes this file under the pinned
// whole-file digest, so validate the cached bytes at this boundary.
guard let contentURL = try contentStore.existingContentURL(for: contentDigest) else {
throw RuntimeError.VMMissingFiles("stacked VM is missing cached disk content \(contentDigest)")
}
let contentSize = try FileManager.default.attributesOfItem(atPath: contentURL.path)[.size] as! Int64
let progress = Progress(totalUnitCount: contentSize)
let mediaType = group.kind == .base ? diskV2MediaType : asifOverlayMediaType
let chunks = try await DiskV2.push(
diskURL: contentURL,
mediaType: mediaType,
registry: registry,
chunkSizeMb: chunkSizeMb,
concurrency: concurrency,
progress: progress
)
return annotatedChunks(chunks, kind: group.kind, contentDigest: contentDigest)
}
private func annotatedChunks(
_ chunks: [OCIManifestLayer],
kind: TartDiskFileGroup.Kind,
contentDigest: String
) -> [OCIManifestLayer] {
guard !chunks.isEmpty else {
return chunks
}
var chunks = chunks
var annotations = chunks[0].annotations ?? [:]
annotations[diskFileContentDigestAnnotation] = contentDigest
if kind == .asifOverlay {
annotations[diskFileChunkCountAnnotation] = String(chunks.count)
}
chunks[0].annotations = annotations
return chunks
}
}
+188 -10
View File
@@ -26,6 +26,9 @@ struct VMDirectory: Prunable {
var manifestURL: URL {
baseURL.appendingPathComponent("manifest.json")
}
var overlayURL: URL {
baseURL.appendingPathComponent("overlay.asif")
}
var controlSocketURL: URL {
URL(fileURLWithPath: "control.sock", relativeTo: baseURL)
}
@@ -87,10 +90,74 @@ struct VMDirectory: Prunable {
return VMDirectory(baseURL: tmpDir)
}
private var hasRequiredMetadata: Bool {
let fileManager = FileManager.default
return fileManager.fileExists(atPath: configURL.path) &&
fileManager.fileExists(atPath: nvramURL.path)
}
enum Layout: Equatable {
/// Existing Tart layout with one independently attachable `disk.img`.
/// A pulled standalone OCI record may also carry `manifest.json`.
case standalone
/// Runnable stacked VM with immutable disk files from `manifest.json` and
/// a private writable `overlay.asif`.
case stackedLocal
/// Pulled OCI record for a stacked image. It intentionally has no writable
/// overlay and becomes runnable only after `tart clone` creates one.
case stackedOCIRecord
var isRunnable: Bool {
self != .stackedOCIRecord
}
}
var layout: Layout? {
let fileManager = FileManager.default
let hasDisk = fileManager.fileExists(atPath: diskURL.path)
let hasManifest = fileManager.fileExists(atPath: manifestURL.path)
let hasOverlay = fileManager.fileExists(atPath: overlayURL.path)
guard hasRequiredMetadata else {
return nil
}
if hasDisk && !hasOverlay {
return .standalone
}
if !hasDisk && hasManifest && hasOverlay {
return .stackedLocal
}
if !hasDisk && hasManifest && !hasOverlay {
return .stackedOCIRecord
}
return nil
}
var initialized: Bool {
FileManager.default.fileExists(atPath: configURL.path) &&
FileManager.default.fileExists(atPath: diskURL.path) &&
FileManager.default.fileExists(atPath: nvramURL.path)
layout?.isRunnable == true
}
var isStandalone: Bool {
layout == .standalone
}
var isStackedVM: Bool {
layout == .stackedLocal
}
var isStackedCachedImage: Bool {
layout == .stackedOCIRecord
}
/// Shapes that may live in the remote-image cache. A cached stacked image
/// has no writable overlay and is intentionally not runnable as a local VM.
var isCachedImage: Bool {
layout == .standalone || layout == .stackedOCIRecord
}
func initialize(overwrite: Bool = false) throws {
@@ -103,6 +170,9 @@ struct VMDirectory: Prunable {
try? FileManager.default.removeItem(at: configURL)
try? FileManager.default.removeItem(at: diskURL)
try? FileManager.default.removeItem(at: nvramURL)
try? FileManager.default.removeItem(at: manifestURL)
try? FileManager.default.removeItem(at: overlayURL)
try? FileManager.default.removeItem(at: stateURL)
}
func validate(userFriendlyName: String) throws {
@@ -111,8 +181,26 @@ struct VMDirectory: Prunable {
}
if !initialized {
throw RuntimeError.VMMissingFiles("VM is missing some of its files (\(configURL.lastPathComponent),"
+ " \(diskURL.lastPathComponent) or \(nvramURL.lastPathComponent))")
throw RuntimeError.VMMissingFiles(
"VM is missing files for a supported layout: "
+ "standalone requires \(configURL.lastPathComponent), \(diskURL.lastPathComponent) and \(nvramURL.lastPathComponent); "
+ "stacked requires \(configURL.lastPathComponent), \(manifestURL.lastPathComponent), "
+ "\(overlayURL.lastPathComponent) and \(nvramURL.lastPathComponent)"
)
}
}
func validateCachedImage(userFriendlyName: String) throws {
if !FileManager.default.fileExists(atPath: baseURL.path) {
throw RuntimeError.VMDoesNotExist(name: userFriendlyName)
}
if !isCachedImage {
throw RuntimeError.VMMissingFiles(
"cached image is missing files for a supported layout: "
+ "standalone requires \(configURL.lastPathComponent), \(diskURL.lastPathComponent) and \(nvramURL.lastPathComponent); "
+ "stacked requires \(configURL.lastPathComponent), \(manifestURL.lastPathComponent) and \(nvramURL.lastPathComponent)"
)
}
}
@@ -142,7 +230,38 @@ struct VMDirectory: Prunable {
try vmConfig.save(toURL: configURL)
}
func resizeDisk(_ sizeGB: UInt16, format: DiskImageFormat = .raw) throws {
func resizeDisk(
_ sizeGB: UInt16,
format: DiskImageFormat = .raw,
contentStore: ContentStore? = nil
) throws {
if isStackedVM {
// Resolve the stack before taking the config.json PID lock. Reading
// config.json after acquiring an fcntl lock would release that lock
// when the read file descriptor is closed.
let stack = try diskImageStack(contentStore: contentStore)
let lock = try lock()
guard try lock.trylock() else {
throw RuntimeError.VMConfigurationError("VM \"\(name)\" must be stopped before resizing its disk")
}
defer { try? lock.unlock() }
// Holding the PID lock proves that the VM is not running. A saved state
// file is the remaining suspended state that must also reject resize.
guard !FileManager.default.fileExists(atPath: stateURL.path) else {
throw RuntimeError.VMConfigurationError("VM \"\(name)\" must be stopped before resizing its disk")
}
let desiredSizeBytes = UInt64(sizeGB) * 1000 * 1000 * 1000
guard desiredSizeBytes.isMultiple(of: stack.blockSize) else {
throw RuntimeError.InvalidDiskSize("new disk size must align to the stacked disk block size")
}
let desiredBlockCount = desiredSizeBytes / stack.blockSize
try stack.growWritableOverlay(toBlockCount: desiredBlockCount)
return
}
let diskExists = FileManager.default.fileExists(atPath: diskURL.path)
if diskExists {
@@ -266,17 +385,33 @@ struct VMDirectory: Prunable {
throw RuntimeError.VMIsRunning(name)
}
try FileManager.default.removeItem(at: baseURL)
// Standalone local VMs do not reference the shared content store. Delete
// them directly so a full disk can still be recovered before the content
// store has ever been initialized.
if isStandalone {
try FileManager.default.removeItem(at: baseURL)
} else {
try removeFromDisk()
}
try lock.unlock()
}
/// Removes a VM directory while preserving the content-store reference
/// protocol for any complete or partially published manifest it contains.
func removeFromDisk() throws {
let contentStore = try ContentStore()
try contentStore.withPruneLock {
try FileManager.default.removeItem(at: baseURL)
}
}
func accessDate() throws -> Date {
try baseURL.accessDate()
}
func allocatedSizeBytes() throws -> Int {
try configURL.allocatedSizeBytes() + diskURL.allocatedSizeBytes() + nvramURL.allocatedSizeBytes()
try configURL.allocatedSizeBytes() + localDiskStorageAllocatedSizeBytes() + nvramURL.allocatedSizeBytes()
}
func allocatedSizeGB() throws -> Int {
@@ -284,7 +419,7 @@ struct VMDirectory: Prunable {
}
func deduplicatedSizeBytes() throws -> Int {
try configURL.deduplicatedSizeBytes() + diskURL.deduplicatedSizeBytes() + nvramURL.deduplicatedSizeBytes()
try configURL.deduplicatedSizeBytes() + localDiskStorageDeduplicatedSizeBytes() + nvramURL.deduplicatedSizeBytes()
}
func deduplicatedSizeGB() throws -> Int {
@@ -292,7 +427,7 @@ struct VMDirectory: Prunable {
}
func sizeBytes() throws -> Int {
try configURL.sizeBytes() + diskURL.sizeBytes() + nvramURL.sizeBytes()
try configURL.sizeBytes() + localDiskStorageSizeBytes() + nvramURL.sizeBytes()
}
func sizeGB() throws -> Int {
@@ -300,6 +435,30 @@ struct VMDirectory: Prunable {
}
func diskSizeBytes() throws -> Int {
if isStackedVM {
let blockLayout = try DiskImageStack.diskImageBlockLayout(at: overlayURL)
let product = blockLayout.blockSize.multipliedReportingOverflow(by: blockLayout.blockCount)
guard !product.overflow, let diskSizeBytes = Int(exactly: product.partialValue) else {
throw RuntimeError.VMConfigurationError("VM has invalid stacked disk block layout")
}
return diskSizeBytes
}
if isStackedCachedImage {
let manifest = try OCIManifest(fromJSON: Data(contentsOf: manifestURL))
guard let blockSize = manifest.diskBlockSize(),
let blockCount = manifest.diskBlockCount() else {
throw RuntimeError.VMConfigurationError("VM has invalid stacked disk block layout")
}
let product = blockSize.multipliedReportingOverflow(by: blockCount)
guard !product.overflow, let diskSizeBytes = Int(exactly: product.partialValue) else {
throw RuntimeError.VMConfigurationError("VM has invalid stacked disk block layout")
}
return diskSizeBytes
}
let vmConfig = try VMConfig(fromURL: configURL)
return switch vmConfig.diskFormat {
@@ -321,4 +480,23 @@ struct VMDirectory: Prunable {
func isExplicitlyPulled() -> Bool {
FileManager.default.fileExists(atPath: explicitlyPulledMark.path)
}
private var localDiskStorageURL: URL {
isStackedVM ? overlayURL : diskURL
}
// Cached stacked images own no disk file in their VM directory. Their
// immutable disk content lives in the shared content store and must not be
// charged to every cached image that references it.
private func localDiskStorageAllocatedSizeBytes() throws -> Int {
isStackedCachedImage ? 0 : try localDiskStorageURL.allocatedSizeBytes()
}
private func localDiskStorageDeduplicatedSizeBytes() throws -> Int {
isStackedCachedImage ? 0 : try localDiskStorageURL.deduplicatedSizeBytes()
}
private func localDiskStorageSizeBytes() throws -> Int {
isStackedCachedImage ? 0 : try localDiskStorageURL.sizeBytes()
}
}
+27 -2
View File
@@ -35,11 +35,36 @@ class VMStorageLocal: PrunableStorage {
func move(_ name: String, from: VMDirectory) throws {
_ = try FileManager.default.createDirectory(at: baseURL, withIntermediateDirectories: true)
_ = try FileManager.default.replaceItemAt(vmURL(name), withItemAt: from.baseURL)
try replace(VMDirectory(baseURL: vmURL(name)), with: from)
}
func rename(_ name: String, _ newName: String) throws {
_ = try FileManager.default.replaceItemAt(vmURL(newName), withItemAt: vmURL(name))
let source = VMDirectory(baseURL: vmURL(name))
let destination = VMDirectory(baseURL: vmURL(newName))
try replace(destination, with: source)
}
/// References in a manifest must not disappear while content GC is deciding
/// whether their immutable disk files are still in use.
private func replace(_ destination: VMDirectory, with source: VMDirectory) throws {
// Replacing a running VM's directory unlinks its locked config and disks,
// leaving a live VM that list and stop can no longer find by name.
let destinationLock = FileManager.default.fileExists(atPath: destination.configURL.path)
? try destination.lock() : nil
if let destinationLock, try !destinationLock.trylock() {
throw RuntimeError.VMIsRunning(destination.name)
}
defer { withExtendedLifetime(destinationLock) {} }
if FileManager.default.fileExists(atPath: source.manifestURL.path) ||
FileManager.default.fileExists(atPath: destination.manifestURL.path) {
let contentStore = try ContentStore()
try contentStore.withPruneLock {
_ = try FileManager.default.replaceItemAt(destination.baseURL, withItemAt: source.baseURL)
}
} else {
_ = try FileManager.default.replaceItemAt(destination.baseURL, withItemAt: source.baseURL)
}
}
func delete(_ name: String) throws {
+554 -30
View File
@@ -18,7 +18,104 @@ class VMStorageOCI: PrunableStorage {
}
func exists(_ name: RemoteName) -> Bool {
VMDirectory(baseURL: vmURL(name)).initialized
VMDirectory(baseURL: vmURL(name)).isCachedImage
}
/// Whether clone can use a cached image without pulling. Standalone images keep
/// Tart's existing structural check. Stacked cached images require every
/// immutable file with its expected length.
func hasUsableCachedImageForClone(_ name: RemoteName, requireManifest: Bool = false) throws -> Bool {
guard exists(name) else {
return false
}
let vmDir = VMDirectory(baseURL: vmURL(name))
if requireManifest && !FileManager.default.fileExists(atPath: vmDir.manifestURL.path) {
return false
}
guard vmDir.isStackedCachedImage else {
return true
}
let manifest = try OCIManifest(fromJSON: Data(contentsOf: vmDir.manifestURL))
guard case .stacked(let base, let overlays) = try manifest.tartDiskRepresentation() else {
return true
}
let contentStore = try ContentStore()
for group in [base] + overlays {
guard try hasUsableCachedDiskFile(group, contentStore: contentStore) else {
return false
}
}
return true
}
/// Whether a cached image is complete enough for `pull` to return without
/// repairing it. Standalone images keep Tart's existing structural cache-hit
/// behavior; stacked cached images additionally need every immutable disk file in
/// the shared content store.
func hasCompleteCachedImage(
_ name: RemoteName,
manifest: OCIManifest,
requireManifest: Bool = false
) throws -> Bool {
guard exists(name) else {
return false
}
let vmDir = VMDirectory(baseURL: vmURL(name))
if requireManifest && !FileManager.default.fileExists(atPath: vmDir.manifestURL.path) {
return false
}
guard let missingGroups = try missingStackedDiskFileGroups(for: manifest) else {
return true
}
return missingGroups.isEmpty
}
/// The lock-free pull fast path is only useful for a tag that already
/// points at this digest. New or retargeted tags validate once after taking
/// the host lock instead of hashing a large stack twice.
func hasCompleteLinkedImage(
_ name: RemoteName,
digestName: RemoteName,
manifest: OCIManifest,
requireManifest: Bool = false
) throws -> Bool {
guard exists(name), linked(from: name, to: digestName) else {
return false
}
return try hasCompleteCachedImage(digestName, manifest: manifest, requireManifest: requireManifest)
}
/// Bytes that this pull may need to materialize locally. For stacked images
/// this is the sum of only the missing complete disk files, not the final
/// guest-visible disk block layout.
func requiredDiskStorageBytes(for manifest: OCIManifest) throws -> UInt64? {
guard let missingGroups = try missingStackedDiskFileGroups(for: manifest) else {
return manifest.uncompressedDiskSize()
}
var total: UInt64 = 0
for group in missingGroups {
for chunk in group.chunks {
guard let uncompressedSize = chunk.uncompressedSize() else {
throw OCIManifestValidationError.invalidDiskMetadata("disk chunks need uncompressed size and content digest")
}
let addition = total.addingReportingOverflow(uncompressedSize)
guard !addition.overflow else {
throw RuntimeError.PullFailed("stacked disk storage size overflows UInt64")
}
total = addition.partialValue
}
}
return total
}
func digest(_ name: RemoteName) throws -> String {
@@ -34,7 +131,7 @@ class VMStorageOCI: PrunableStorage {
func open(_ name: RemoteName, _ accessDate: Date = Date()) throws -> VMDirectory {
let vmDir = VMDirectory(baseURL: vmURL(name))
try vmDir.validate(userFriendlyName: name.description)
try vmDir.validateCachedImage(userFriendlyName: name.description)
try vmDir.baseURL.updateAccessDate(accessDate)
@@ -44,11 +141,64 @@ class VMStorageOCI: PrunableStorage {
func create(_ name: RemoteName, overwrite: Bool = false) throws -> VMDirectory {
let vmDir = VMDirectory(baseURL: vmURL(name))
if !overwrite && vmDir.isCachedImage {
throw RuntimeError.VMDirectoryAlreadyInitialized("VM directory is already initialized, preventing overwrite")
}
try vmDir.initialize(overwrite: overwrite)
return vmDir
}
/// Materialize the digest-addressed cached image for an image Tart just
/// pushed, without routing its own local data back through the registry.
func populate(_ name: RemoteName, from source: VMDirectory, manifest: OCIManifest) throws {
if try hasCompleteCachedImage(name, manifest: manifest) {
return
}
let vmDir = try create(name, overwrite: exists(name))
do {
if source.isStackedVM {
guard case .stacked(_, let overlays) = try manifest.tartDiskRepresentation(),
let contentDigest = overlays.last?.contentDigest else {
throw RuntimeError.VMConfigurationError("pushed image is missing its writable ASIF overlay")
}
// The pushed top overlay becomes immutable in the cached image. Keep a
// semantic copy so later clones do not need to fetch it back.
let contentStore = try ContentStore()
try contentStore.withPruneLock {
try FileManager.default.copyItem(at: source.configURL, to: vmDir.configURL)
try FileManager.default.copyItem(at: source.nvramURL, to: vmDir.nvramURL)
// Publish the reference before installing the immutable top overlay,
// so reference-aware pruning cannot collect it in between.
try manifest.toJSON().write(to: vmDir.manifestURL)
}
if try contentStore.contentURLIfPresent(for: contentDigest) == nil {
let temporaryURL = try contentStore.temporaryContentURL(for: contentDigest)
do {
try FileManager.default.copyItem(at: source.overlayURL, to: temporaryURL)
_ = try contentStore.install(temporaryURL, contentDigest: contentDigest)
} catch {
try? FileManager.default.removeItem(at: temporaryURL)
throw error
}
}
} else {
try source.clone(to: vmDir, generateMAC: false)
// Keep the exact manifest Tart submitted so tag links and later pushes
// refer to the same digest-addressed cached image.
try manifest.toJSON().write(to: vmDir.manifestURL)
}
} catch {
try? vmDir.removeFromDisk()
throw error
}
}
func move(_ name: RemoteName, from: VMDirectory) throws{
let targetURL = vmURL(name)
@@ -57,11 +207,20 @@ class VMStorageOCI: PrunableStorage {
try FileManager.default.createDirectory(at: targetURL.deletingLastPathComponent(),
withIntermediateDirectories: true)
_ = try FileManager.default.replaceItemAt(targetURL, withItemAt: from.baseURL)
let target = VMDirectory(baseURL: targetURL)
if FileManager.default.fileExists(atPath: from.manifestURL.path) ||
FileManager.default.fileExists(atPath: target.manifestURL.path) {
let contentStore = try ContentStore()
try contentStore.withPruneLock {
_ = try FileManager.default.replaceItemAt(targetURL, withItemAt: from.baseURL)
}
} else {
_ = try FileManager.default.replaceItemAt(targetURL, withItemAt: from.baseURL)
}
}
func delete(_ name: RemoteName) throws {
try FileManager.default.removeItem(at: vmURL(name))
try removeRecord(at: vmURL(name))
try gc()
}
@@ -70,6 +229,7 @@ class VMStorageOCI: PrunableStorage {
guard let enumerator = FileManager.default.enumerator(at: baseURL,
includingPropertiesForKeys: [.isSymbolicLinkKey]) else {
try gcContent()
return
}
@@ -84,7 +244,7 @@ class VMStorageOCI: PrunableStorage {
}
let vmDir = VMDirectory(baseURL: foundURL.resolvingSymlinksInPath())
if !vmDir.initialized {
if !vmDir.isCachedImage {
continue
}
@@ -97,7 +257,28 @@ class VMStorageOCI: PrunableStorage {
let vmDir = VMDirectory(baseURL: baseURL)
if !vmDir.isExplicitlyPulled() && incRefCount == 0 {
try FileManager.default.removeItem(at: baseURL)
try removeRecord(at: baseURL)
}
}
try gcContent()
}
/// Cached images with a manifest publish references into the shared content
/// store. Remove them through VMDirectory so reference removal is serialized
/// with clone, export, pull, and content GC, even if a record is incomplete.
private func removeRecord(at url: URL) throws {
try VMDirectory(baseURL: url).removeFromDisk()
}
/// Remove immutable files whose final published or in-progress reference
/// has disappeared, without collecting unrelated cached images.
fileprivate func gcContent() throws {
let contentStore = try ContentStore()
try contentStore.withPruneLock {
let referencedContentDigests = try referencedContentDigests(includeCachedImages: true)
for contentURL in try contentStore.prunables(excluding: referencedContentDigests) {
try FileManager.default.removeItem(at: contentURL)
}
}
}
@@ -113,7 +294,7 @@ class VMStorageOCI: PrunableStorage {
for case let foundURL as URL in enumerator {
let vmDir = VMDirectory(baseURL: foundURL)
if !vmDir.initialized {
if !vmDir.isCachedImage {
continue
}
@@ -141,10 +322,67 @@ class VMStorageOCI: PrunableStorage {
}
func prunables() throws -> [Prunable] {
try list().filter { (_, _, isSymlink) in !isSymlink }.map { (_, vmDir, _) in vmDir }
let records = try list().filter { (_, _, isSymlink) in
!isSymlink
}.map { (_, vmDir, _) in vmDir }
// Attribute shared content to the newest cached image that references it.
// This counts each file once while charging it to the last record that
// normally needs to be removed before the file becomes reclaimable.
let nonCacheContentDigests = try referencedContentDigests(includeCachedImages: false)
var contentOwners = [String: VMDirectory]()
for record in records where record.isStackedCachedImage {
// Interrupted cache population can leave a truncated manifest in an
// otherwise recognizable cached record. It has no reliable content
// references, but it must not prevent pruning other cache entries.
for contentDigest in (try? record.diskContentDigests()) ?? []
where !nonCacheContentDigests.contains(contentDigest) {
guard let currentOwner = contentOwners[contentDigest] else {
contentOwners[contentDigest] = record
continue
}
let recordAccessDate = try record.accessDate()
let currentAccessDate = try currentOwner.accessDate()
if recordAccessDate > currentAccessDate ||
(recordAccessDate == currentAccessDate && record.url.path > currentOwner.url.path) {
contentOwners[contentDigest] = record
}
}
}
let contentStore = try ContentStore()
var ownedContentURLs = [URL: [URL]]()
for (contentDigest, owner) in contentOwners {
let contentURL = try contentStore.contentURL(for: contentDigest)
guard FileManager.default.fileExists(atPath: contentURL.path) else {
continue
}
ownedContentURLs[owner.url, default: []].append(contentURL)
}
var result: [Prunable] = records.map { record in
CachedImagePrunable(
vmDir: record,
ownedContentURLs: ownedContentURLs[record.url] ?? []
)
}
result += try contentStore.prunables(excluding: referencedContentDigests(includeCachedImages: true))
.map(ContentPrunable.init)
return result
}
func pull(_ name: RemoteName, registry: Registry, concurrency: UInt, deduplicate: Bool) async throws {
func pull(
_ name: RemoteName,
registry: Registry,
concurrency: UInt,
deduplicate: Bool,
requireManifest: Bool = false,
resolvedManifest: (manifest: OCIManifest, data: Data)? = nil
) async throws {
OpenTelemetry.instance.contextProvider.activeSpan?.setAttribute(
key: "oci.image-name",
value: .string(name.description)
@@ -152,12 +390,23 @@ class VMStorageOCI: PrunableStorage {
defaultLogger.appendNewLine("pulling manifest...")
let (manifest, manifestData) = try await registry.pullManifest(reference: name.reference.value)
let (manifest, manifestData): (OCIManifest, Data)
if let resolvedManifest {
manifest = resolvedManifest.manifest
manifestData = resolvedManifest.data
} else {
(manifest, manifestData) = try await registry.pullManifest(reference: name.reference.value)
}
let digestName = RemoteName(host: name.host, namespace: name.namespace,
reference: Reference(digest: Digest.hash(manifestData)))
if exists(name) && exists(digestName) && linked(from: name, to: digestName) {
if try hasCompleteLinkedImage(
name,
digestName: digestName,
manifest: manifest,
requireManifest: requireManifest
) {
// optimistically check if we need to do anything at all before locking
defaultLogger.appendNewLine("\(digestName) image is already cached and linked!")
return
@@ -181,11 +430,22 @@ class VMStorageOCI: PrunableStorage {
throw CancellationError()
}
if !exists(digestName) {
let digestVMDir = VMDirectory(baseURL: vmURL(digestName))
if requireManifest,
!FileManager.default.fileExists(atPath: digestVMDir.manifestURL.path),
try hasCompleteCachedImage(digestName, manifest: manifest) {
// Old Tart versions cached standalone OCI images without manifest.json.
// A stacked clone needs the manifest to describe its immutable base, but
// the existing disk remains usable and must not be downloaded again.
try manifestData.write(to: digestVMDir.manifestURL, options: .atomic)
}
if try !hasCompleteCachedImage(digestName, manifest: manifest, requireManifest: requireManifest) {
let span = OTel.shared.tracer.spanBuilder(spanName: "pull").setActive(true).startSpan()
defer { span.end() }
let tmpVMDir = try VMDirectory.temporaryDeterministic(key: name.description)
let preserveExplicitlyPulledMark = digestVMDir.isExplicitlyPulled()
// Open an existing VM directory corresponding to this name, if any,
// marking it as outdated to speed up the garbage collection process
@@ -195,22 +455,47 @@ class VMStorageOCI: PrunableStorage {
let tmpVMDirLock = try FileLock(lockURL: tmpVMDir.baseURL)
try tmpVMDirLock.lock()
// Make in-progress stacked content references visible before reclaiming
// space or reconstructing immutable files.
try ContentStore().withPruneLock {
try manifestData.write(to: tmpVMDir.manifestURL)
}
// A previously pulled standalone image already has the complete base
// disk locally as disk.img. Promote that file into the content store
// before sizing or pulling so a stacked child only fetches overlays.
try reuseStandaloneDiskForStackedBaseIfPossible(manifest)
// Try to reclaim some cache space if we know the VM size in advance
if let uncompressedDiskSize = manifest.uncompressedDiskSize() {
OpenTelemetry.instance.contextProvider.activeSpan?.setAttribute(
key: "oci.image-uncompressed-disk-size-bytes",
value: .int(Int(uncompressedDiskSize))
)
if let requiredDiskStorageBytes = try requiredDiskStorageBytes(for: manifest) {
if let telemetryValue = Int(exactly: requiredDiskStorageBytes) {
OpenTelemetry.instance.contextProvider.activeSpan?.setAttribute(
key: "oci.image-required-disk-storage-bytes",
value: .int(telemetryValue)
)
}
let otherVMFilesSize: UInt64 = 128 * 1024 * 1024
let requiredStorage = requiredDiskStorageBytes.addingReportingOverflow(otherVMFilesSize)
guard !requiredStorage.overflow else {
throw RuntimeError.PullFailed("required pull storage size overflows UInt64")
}
try Prune.reclaimIfNeeded(uncompressedDiskSize + otherVMFilesSize)
try Prune.reclaimIfNeeded(requiredStorage.partialValue)
}
try await withTaskCancellationHandler(operation: {
try await retry(maxAttempts: 5) {
// Choose the best base image which has the most deduplication ratio
let localLayerCache = try await chooseLocalLayerCache(name, manifest, registry)
// Existing standalone images can still reuse another complete local disk.
// Stacked images reconstruct their immutable files through the
// shared content store instead of materializing disk.img.
let localLayerCache: LocalLayerCache?
switch try manifest.tartDiskRepresentation() {
case .flat:
localLayerCache = try await chooseLocalLayerCache(name, manifest, registry)
case .stacked:
localLayerCache = nil
}
if let llc = localLayerCache {
let deduplicatedHuman = ByteCountFormatter.string(fromByteCount: Int64(llc.deduplicatedBytes), countStyle: .file)
@@ -232,9 +517,14 @@ class VMStorageOCI: PrunableStorage {
return .throw
}
if preserveExplicitlyPulledMark {
tmpVMDir.markExplicitlyPulled()
}
try move(digestName, from: tmpVMDir)
}, onCancel: {
try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
try? tmpVMDir.removeFromDisk()
})
} else {
defaultLogger.appendNewLine("\(digestName) image is already cached! creating a symlink...")
@@ -253,6 +543,115 @@ class VMStorageOCI: PrunableStorage {
_ = try VMStorageOCI().open(name)
}
/// Returns nil for standalone images and the missing immutable disk-file
/// groups for stacked images. Like existing standalone cached images, cache hits trust
/// already-installed files; checking size still repairs truncated entries
/// without hashing a large prewarmed base on every pull.
private func missingStackedDiskFileGroups(for manifest: OCIManifest) throws -> [TartDiskFileGroup]? {
guard case .stacked(let base, let overlays) = try manifest.tartDiskRepresentation() else {
return nil
}
let contentStore = try ContentStore()
var missingGroups: [TartDiskFileGroup] = []
for group in [base] + overlays {
if try !hasUsableCachedDiskFile(group, contentStore: contentStore) {
missingGroups.append(group)
}
}
return missingGroups
}
/// Seed a stacked image's immutable base from an already pulled standalone
/// OCI record when both manifests describe the same transport chunks. The
/// content store still verifies the whole-file digest before publishing it.
func reuseStandaloneDiskForStackedBaseIfPossible(_ manifest: OCIManifest) throws {
guard case .stacked(let base, _) = try manifest.tartDiskRepresentation(),
let contentDigest = base.contentDigest else {
return
}
let contentStore = try ContentStore()
var attemptedCandidates = Swift.Set<String>()
while true {
// Keep the source record alive only while cloning its disk. The pull's
// in-progress manifest already protects the destination content digest,
// so hashing and installing the staged clone need not hold the global
// prune lock.
let temporaryURL = try contentStore.withPruneLock { () -> URL? in
// Content-store entries are verified when installed. Avoid hashing a
// potentially large prewarmed base again on every stacked pull.
guard try contentStore.contentURLIfPresent(for: contentDigest) == nil else {
return nil
}
for (_, vmDir, isSymlink) in try list() where !isSymlink && vmDir.isStandalone {
guard !attemptedCandidates.contains(vmDir.baseURL.path),
let manifestData = try? Data(contentsOf: vmDir.manifestURL),
let candidateManifest = try? OCIManifest(fromJSON: manifestData),
case .flat(let candidateBase) = try? candidateManifest.tartDiskRepresentation(),
diskChunksMatch(candidateBase.chunks, base.chunks) else {
continue
}
attemptedCandidates.insert(vmDir.baseURL.path)
let temporaryURL = try contentStore.temporaryContentURL(for: contentDigest)
do {
try FileManager.default.copyItem(at: vmDir.diskURL, to: temporaryURL)
return temporaryURL
} catch {
try? FileManager.default.removeItem(at: temporaryURL)
throw error
}
}
return nil
}
guard let temporaryURL else {
return
}
do {
_ = try contentStore.install(temporaryURL, contentDigest: contentDigest)
return
} catch ContentStoreError.contentDigestMismatch {
try? FileManager.default.removeItem(at: temporaryURL)
} catch {
try? FileManager.default.removeItem(at: temporaryURL)
throw error
}
}
}
/// Compare the OCI transport identity while ignoring stacked-only
/// whole-file annotations added to the first base chunk.
private func diskChunksMatch(_ left: [OCIManifestLayer], _ right: [OCIManifestLayer]) -> Bool {
guard left.count == right.count else {
return false
}
return zip(left, right).allSatisfy { left, right in
left.mediaType == right.mediaType &&
left.size == right.size &&
left.digest == right.digest &&
left.uncompressedSize() == right.uncompressedSize() &&
left.uncompressedContentDigest() == right.uncompressedContentDigest()
}
}
private func hasUsableCachedDiskFile(_ group: TartDiskFileGroup, contentStore: ContentStore) throws -> Bool {
guard let contentDigest = group.contentDigest,
let contentURL = try contentStore.contentURLIfPresent(for: contentDigest),
let actualSize = UInt64(exactly: try contentURL.sizeBytes()),
let expectedSize = group.uncompressedSize() else {
return false
}
return actualSize == expectedSize
}
func linked(from: RemoteName, to: RemoteName) -> Bool {
do {
let resolvedFrom = try FileManager.default.destinationOfSymbolicLink(atPath: vmURL(from).path)
@@ -263,9 +662,13 @@ class VMStorageOCI: PrunableStorage {
}
func link(from: RemoteName, to: RemoteName) throws {
try? FileManager.default.removeItem(at: vmURL(from))
try FileManager.default.createSymbolicLink(at: vmURL(from), withDestinationURL: vmURL(to))
// Export resolves mutable tags while holding this same lock, so replace
// the symlink atomically with respect to stacked archive staging.
let contentStore = try ContentStore()
try contentStore.withPruneLock {
try? FileManager.default.removeItem(at: vmURL(from))
try FileManager.default.createSymbolicLink(at: vmURL(from), withDestinationURL: vmURL(to))
}
try gc()
}
@@ -280,10 +683,16 @@ class VMStorageOCI: PrunableStorage {
}
// Load OCI VM images and their manifests (if present)
var candidates: [(name: String, vmDir: VMDirectory, manifest: OCIManifest, deduplicatedBytes: UInt64)] = []
var candidates: [(
name: String,
vmDir: VMDirectory,
manifest: OCIManifest,
manifestDigest: String,
deduplicatedBytes: UInt64
)] = []
for (name, vmDir, isSymlink) in try list() {
if isSymlink {
if isSymlink || !vmDir.isStandalone {
continue
}
@@ -295,7 +704,13 @@ class VMStorageOCI: PrunableStorage {
continue
}
candidates.append((name, vmDir, manifest, calculateDeduplicatedBytes(manifest)))
candidates.append((
name,
vmDir,
manifest,
Digest.hash(manifestJSON),
calculateDeduplicatedBytes(manifest)
))
}
// Previously we haven't stored the OCI VM image manifests, but still fetched the VM image manifest if
@@ -305,10 +720,17 @@ class VMStorageOCI: PrunableStorage {
// with the registry if we haven't already retrieved the manifest for that OCI VM image.
if name.reference.type == .Tag,
let vmDir = try? open(name),
vmDir.isStandalone,
let digest = try? digest(name),
try !candidates.contains(where: {try $0.manifest.digest() == digest}),
let (manifest, _) = try? await registry.pullManifest(reference: digest) {
candidates.append((name.description, vmDir, manifest, calculateDeduplicatedBytes(manifest)))
!candidates.contains(where: { $0.manifestDigest == digest }),
let (manifest, manifestData) = try? await registry.pullManifest(reference: digest) {
candidates.append((
name.description,
vmDir,
manifest,
Digest.hash(manifestData),
calculateDeduplicatedBytes(manifest)
))
}
// Now, find the best match based on how many bytes we'll deduplicate
@@ -322,6 +744,108 @@ class VMStorageOCI: PrunableStorage {
try LocalLayerCache(choosen.name, choosen.deduplicatedBytes, choosen.vmDir.diskURL, choosen.manifest)
})
}
/// Returns content referenced outside the OCI cache, optionally including
/// references published by retained cached images.
private func referencedContentDigests(includeCachedImages: Bool) throws -> Swift.Set<String> {
var result = Swift.Set<String>()
for (_, vmDir) in try VMStorageLocal().list() where vmDir.isStackedVM {
result.formUnion(try vmDir.diskContentDigests())
}
// Clone, pull, and import publish their manifest before installing
// immutable content. Include partially populated temporary directories so
// pruning cannot race those operations.
for url in try FileManager.default.contentsOfDirectory(
at: Config().tartTmpDir,
includingPropertiesForKeys: [],
options: .skipsHiddenFiles
) {
let vmDir = VMDirectory(baseURL: url)
guard FileManager.default.fileExists(atPath: vmDir.manifestURL.path),
let contentDigests = try? vmDir.diskContentDigests() else {
continue
}
result.formUnion(contentDigests)
}
if includeCachedImages {
for (_, vmDir, isSymlink) in try list() where !isSymlink && vmDir.isStackedCachedImage {
// Malformed cached records are invalid references. Keep scanning so
// one interrupted population does not disable content GC globally.
if let contentDigests = try? vmDir.diskContentDigests() {
result.formUnion(contentDigests)
}
}
}
return result
}
fileprivate func deleteContentIfUnused(_ url: URL) throws {
let contentStore = try ContentStore()
try contentStore.withPruneLock {
let referencedContentDigests = try referencedContentDigests(includeCachedImages: true)
let stillPrunable = try contentStore.prunables(excluding: referencedContentDigests).contains {
$0.resolvingSymlinksInPath() == url.resolvingSymlinksInPath()
}
if stillPrunable {
try FileManager.default.removeItem(at: url)
}
}
}
}
private struct ContentPrunable: Prunable {
let url: URL
func delete() throws {
try VMStorageOCI().deleteContentIfUnused(url)
}
func accessDate() throws -> Date {
try url.accessDate()
}
func sizeBytes() throws -> Int {
try url.sizeBytes()
}
func allocatedSizeBytes() throws -> Int {
try url.allocatedSizeBytes()
}
}
/// A digest-addressed cached image plus immutable content attributed to the
/// final remote reference that can release it.
private struct CachedImagePrunable: Prunable {
let vmDir: VMDirectory
let ownedContentURLs: [URL]
var url: URL {
vmDir.url
}
func delete() throws {
try vmDir.delete()
// Deleting a record can make attributed content unreferenced. Run GC now
// so one prune invocation reclaims those bytes.
try VMStorageOCI().gcContent()
}
func accessDate() throws -> Date {
try vmDir.accessDate()
}
func sizeBytes() throws -> Int {
try vmDir.sizeBytes() + ownedContentURLs.map { try $0.sizeBytes() }.reduce(0, +)
}
func allocatedSizeBytes() throws -> Int {
try vmDir.allocatedSizeBytes() + ownedContentURLs.map { try $0.allocatedSizeBytes() }.reduce(0, +)
}
}
extension URL {
+168
View File
@@ -0,0 +1,168 @@
import Foundation
import ArgumentParser
import XCTest
@testable import tart
final class CommandBehaviorTests: XCTestCase {
func testNoUSBAccessoriesDoesNotEnableSuspendable() throws {
try withTemporaryTartHome {
let vmDir = try VMStorageLocal().create("no-usb-accessories")
try config().save(toURL: vmDir.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.nvramURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.diskURL.path, contents: Data()))
let command = try Run.parseAsRoot(["no-usb-accessories", "--no-usb-accessories"]) as! Run
XCTAssertTrue(command.noUSBAccessories)
XCTAssertFalse(command.suspendable)
XCTAssertFalse(command.noAudio)
XCTAssertFalse(command.noGraphics)
}
}
func testStandaloneDeleteDoesNotInitializeContentStore() throws {
try withTemporaryTartHome {
let vmDir = try VMStorageLocal().create("standalone")
try config().save(toURL: vmDir.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.nvramURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.diskURL.path, contents: Data()))
let contentStoreURL = try Config().tartCacheDir.appendingPathComponent("content", isDirectory: true)
XCTAssertFalse(FileManager.default.fileExists(atPath: contentStoreURL.path))
try vmDir.delete()
XCTAssertFalse(FileManager.default.fileExists(atPath: vmDir.baseURL.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: contentStoreURL.path))
}
}
func testSetDiskRejectsStackedVMBeforeSavingConfig() async throws {
try await withTemporaryTartHome {
let vmDir = try VMStorageLocal().create("stacked")
let originalConfig = config()
try originalConfig.save(toURL: vmDir.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.nvramURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.manifestURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.overlayURL.path, contents: Data()))
let replacementURL = try temporaryDirectory().appendingPathComponent("replacement.img")
XCTAssertTrue(FileManager.default.createFile(atPath: replacementURL.path, contents: Data("replacement".utf8)))
let command = try Set.parseAsRoot([
"stacked",
"--cpu", "4",
"--disk", replacementURL.path,
]) as! Set
do {
try await command.run()
XCTFail("expected stacked disk replacement to be rejected")
} catch let error as ValidationError {
XCTAssertEqual(error.message, "--disk is not supported for VMs with a stacked disk")
}
XCTAssertEqual(try VMConfig(fromURL: vmDir.configURL).cpuCount, originalConfig.cpuCount)
XCTAssertFalse(FileManager.default.fileExists(atPath: vmDir.diskURL.path))
}
}
func testRemoteAdditionalDiskRetainsTemporaryBackingFileLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let name = try RemoteName("example.com/org/image:latest")
let cachedImage = try storage.create(name)
try config().save(toURL: cachedImage.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: cachedImage.nvramURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(
atPath: cachedImage.diskURL.path,
contents: Data(repeating: 0, count: 4096)
))
do {
let additionalDisk = try AdditionalDisk(parseFrom: name.description)
let entriesBeforeGC = try temporaryEntries()
XCTAssertEqual(entriesBeforeGC.count, 1)
try Config().gc()
XCTAssertEqual(try temporaryEntries(), entriesBeforeGC)
withExtendedLifetime(additionalDisk) {}
}
try Config().gc()
XCTAssertTrue(try temporaryEntries().isEmpty)
}
}
func testGarbageCollectionPreservesLockedTemporaryDirectory() throws {
try withTemporaryTartHome {
let temporaryVMDir = try VMDirectory.temporary()
let lock = try FileLock(lockURL: temporaryVMDir.baseURL)
try lock.lock()
XCTAssertTrue(FileManager.default.createFile(
atPath: temporaryVMDir.overlayURL.path,
contents: Data("overlay".utf8)
))
try Config().gc()
XCTAssertTrue(FileManager.default.fileExists(atPath: temporaryVMDir.overlayURL.path))
try lock.unlock()
try Config().gc()
XCTAssertFalse(FileManager.default.fileExists(atPath: temporaryVMDir.baseURL.path))
}
}
private func config() -> VMConfig {
VMConfig(
platform: Linux(),
cpuCountMin: 2,
memorySizeMin: 512 * 1024 * 1024,
diskFormat: .raw
)
}
private func temporaryEntries() throws -> [URL] {
try FileManager.default.contentsOfDirectory(
at: Config().tartTmpDir,
includingPropertiesForKeys: nil
)
}
private func withTemporaryTartHome(_ body: () throws -> Void) throws {
let home = try temporaryDirectory()
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", home.path, 1)
defer { restoreEnvironment("TART_HOME", to: previousHome) }
try body()
}
private func withTemporaryTartHome(_ body: () async throws -> Void) async throws {
let home = try temporaryDirectory()
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", home.path, 1)
defer { restoreEnvironment("TART_HOME", to: previousHome) }
try await body()
}
private func temporaryDirectory() throws -> URL {
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false)
addTeardownBlock {
try? FileManager.default.removeItem(at: url)
}
return url
}
private func restoreEnvironment(_ name: String, to value: String?) {
if let value {
setenv(name, value, 1)
} else {
unsetenv(name)
}
}
}
+190
View File
@@ -0,0 +1,190 @@
import Foundation
import XCTest
@testable import tart
final class ContentStoreTests: XCTestCase {
func testCreatesDigestDirectoryDuringInitialization() throws {
let store = try temporaryStore()
let contentURL = try store.contentURL(for: Digest.hash(Data()))
XCTAssertTrue(FileManager.default.fileExists(atPath: contentURL.deletingLastPathComponent().path))
}
func testInstallAndValidatedLookup() throws {
let store = try temporaryStore()
let data = Data("base disk".utf8)
let digest = Digest.hash(data)
let temporaryURL = try store.temporaryContentURL(for: digest)
try data.write(to: temporaryURL)
let installedURL = try store.install(temporaryURL, contentDigest: digest)
XCTAssertEqual(installedURL, try store.contentURL(for: digest))
XCTAssertEqual(try store.existingContentURL(for: digest), installedURL)
}
func testCorruptCacheEntryIsMiss() throws {
let store = try temporaryStore()
let expectedDigest = Digest.hash(Data("expected".utf8))
let contentURL = try store.contentURL(for: expectedDigest)
try FileManager.default.createDirectory(at: contentURL.deletingLastPathComponent(), withIntermediateDirectories: true)
try Data("corrupt".utf8).write(to: contentURL)
XCTAssertNil(try store.existingContentURL(for: expectedDigest))
XCTAssertEqual(try store.contentURLIfPresent(for: expectedDigest), contentURL)
}
func testResumableAndLockURLsAreStablePerDigest() throws {
let store = try temporaryStore()
let firstDigest = Digest.hash(Data("first".utf8))
let secondDigest = Digest.hash(Data("second".utf8))
XCTAssertEqual(
try store.resumableContentURL(for: firstDigest),
try store.resumableContentURL(for: firstDigest)
)
XCTAssertNotEqual(
try store.resumableContentURL(for: firstDigest),
try store.resumableContentURL(for: secondDigest)
)
XCTAssertEqual(
try store.lockURL(for: firstDigest),
try store.lockURL(for: firstDigest)
)
XCTAssertTrue(FileManager.default.fileExists(atPath: try store.lockURL(for: firstDigest).path))
}
func testInstallReplacesCorruptEntry() throws {
let store = try temporaryStore()
let data = Data("expected".utf8)
let digest = Digest.hash(data)
let contentURL = try store.contentURL(for: digest)
try FileManager.default.createDirectory(at: contentURL.deletingLastPathComponent(), withIntermediateDirectories: true)
try Data("corrupt".utf8).write(to: contentURL)
let temporaryURL = try store.temporaryContentURL(for: digest)
try data.write(to: temporaryURL)
XCTAssertEqual(try store.install(temporaryURL, contentDigest: digest), contentURL)
XCTAssertEqual(try Digest.hash(contentURL), digest)
}
func testInstallPreservesExistingValidEntry() throws {
let store = try temporaryStore()
let data = Data("expected".utf8)
let digest = Digest.hash(data)
let firstTemporaryURL = try store.temporaryContentURL(for: digest)
try data.write(to: firstTemporaryURL)
let installedURL = try store.install(firstTemporaryURL, contentDigest: digest)
let secondTemporaryURL = try store.temporaryContentURL(for: digest)
try data.write(to: secondTemporaryURL)
XCTAssertEqual(try store.install(secondTemporaryURL, contentDigest: digest), installedURL)
XCTAssertFalse(FileManager.default.fileExists(atPath: secondTemporaryURL.path))
XCTAssertEqual(try Digest.hash(installedURL), digest)
}
func testConcurrentInstallsAcceptDigestValidWinner() throws {
try assertConcurrentInstalls(seedCorruptEntry: false)
}
func testConcurrentInstallsRepairCorruptEntry() throws {
try assertConcurrentInstalls(seedCorruptEntry: true)
}
func testInstallRejectsWrongContentDigest() throws {
let store = try temporaryStore()
let expectedDigest = Digest.hash(Data("expected".utf8))
let temporaryURL = try store.temporaryContentURL(for: expectedDigest)
try Data("actual".utf8).write(to: temporaryURL)
XCTAssertThrowsError(try store.install(temporaryURL, contentDigest: expectedDigest)) { error in
guard case ContentStoreError.contentDigestMismatch(let expected, _) = error else {
return XCTFail("unexpected error: \(error)")
}
XCTAssertEqual(expected, expectedDigest)
}
}
func testRejectsNonCanonicalDigest() throws {
let store = try temporaryStore()
XCTAssertThrowsError(try store.contentURL(for: "sha256:ABC")) { error in
XCTAssertEqual(error as? ContentStoreError, .invalidContentDigest("sha256:ABC"))
}
}
func testContentURLUnderArbitraryRootHasNoSideEffects() throws {
let rootURL = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
addTeardownBlock {
try? FileManager.default.removeItem(at: rootURL)
}
let digest = Digest.hash(Data("content".utf8))
let contentStore = try temporaryStore()
let contentURL = try contentStore.contentURL(for: digest, under: rootURL)
XCTAssertEqual(
contentURL,
rootURL.appendingPathComponent("sha256", isDirectory: true)
.appendingPathComponent(String(digest.dropFirst("sha256:".count)))
)
XCTAssertFalse(FileManager.default.fileExists(atPath: rootURL.path))
}
private func temporaryStore() throws -> ContentStore {
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
addTeardownBlock {
try? FileManager.default.removeItem(at: url)
}
return try ContentStore(baseURL: url)
}
private func assertConcurrentInstalls(seedCorruptEntry: Bool) throws {
let store = try temporaryStore()
let data = Data("expected".utf8)
let digest = Digest.hash(data)
let contentURL = try store.contentURL(for: digest)
try FileManager.default.createDirectory(at: contentURL.deletingLastPathComponent(), withIntermediateDirectories: true)
if seedCorruptEntry {
try Data("corrupt".utf8).write(to: contentURL)
}
let temporaryURLs = try (0..<16).map { _ in
let url = try store.temporaryContentURL(for: digest)
try data.write(to: url)
return url
}
let errors = ErrorCollector()
DispatchQueue.concurrentPerform(iterations: temporaryURLs.count) { index in
do {
_ = try store.install(temporaryURLs[index], contentDigest: digest)
} catch {
errors.append(error)
}
}
XCTAssertTrue(errors.values.isEmpty, "unexpected install errors: \(errors.values)")
XCTAssertEqual(try Digest.hash(contentURL), digest)
XCTAssertTrue(temporaryURLs.allSatisfy { !FileManager.default.fileExists(atPath: $0.path) })
}
private final class ErrorCollector: @unchecked Sendable {
private let lock = NSLock()
private var errors: [Error] = []
var values: [Error] {
lock.lock()
defer { lock.unlock() }
return errors
}
func append(_ error: Error) {
lock.lock()
defer { lock.unlock() }
errors.append(error)
}
}
}
+96
View File
@@ -0,0 +1,96 @@
import NIO
import XCTest
@testable import tart
// Avoid NSObject.bind and Tart's Darwin type shadowing the system function.
private let bindTestSocket = bind
@available(macOS 14, *)
final class ControlSocketTests: XCTestCase {
func testInitializerCreatesControlSocketBeforeReturning() async throws {
let temporaryDirectory = try makeTemporaryDirectory()
let originalDirectory = FileManager.default.currentDirectoryPath
defer {
FileManager.default.changeCurrentDirectoryPath(originalDirectory)
try? FileManager.default.removeItem(at: temporaryDirectory)
}
let socketURL = URL(fileURLWithPath: "control.sock", relativeTo: temporaryDirectory)
var controlSocket: ControlSocket? = try await ControlSocket(socketURL)
let eventLoopGroup = try XCTUnwrap(controlSocket?.eventLoopGroup)
do {
let serverChannel = try XCTUnwrap(controlSocket?.serverChannel)
XCTAssertTrue(FileManager.default.fileExists(atPath: socketURL.path))
try await serverChannel.executeThenClose { _ in }
}
controlSocket = nil
try await eventLoopGroup.shutdownGracefully()
}
func testInitializerPropagatesControlSocketCreationFailure() async throws {
let temporaryDirectory = try makeTemporaryDirectory()
let originalDirectory = FileManager.default.currentDirectoryPath
defer {
FileManager.default.changeCurrentDirectoryPath(originalDirectory)
try? FileManager.default.removeItem(at: temporaryDirectory)
}
let socketURL = URL(fileURLWithPath: "missing/control.sock", relativeTo: temporaryDirectory)
do {
_ = try await ControlSocket(socketURL)
XCTFail("Binding should fail when the socket's parent directory does not exist")
} catch {
XCTAssertFalse(FileManager.default.fileExists(atPath: socketURL.path))
}
}
func testInitializerReplacesStaleSocketInLongEncodedPath() async throws {
let temporaryDirectory = try makeTemporaryDirectory()
let originalDirectory = FileManager.default.currentDirectoryPath
defer {
FileManager.default.changeCurrentDirectoryPath(originalDirectory)
try? FileManager.default.removeItem(at: temporaryDirectory)
}
let vmDirectory = temporaryDirectory.appendingPathComponent(
"Tart Home %# 虚拟机 " + String(repeating: "v", count: 104), isDirectory: true
)
try FileManager.default.createDirectory(at: vmDirectory, withIntermediateDirectories: false)
let socketURL = URL(fileURLWithPath: "control.sock", relativeTo: vmDirectory)
XCTAssertGreaterThan(socketURL.path.utf8.count, 104)
// Closing a POSIX socket leaves its path behind, as exiting "tart run" does.
XCTAssertTrue(FileManager.default.changeCurrentDirectoryPath(vmDirectory.path))
let expectedDirectory = FileManager.default.currentDirectoryPath
let address = try SocketAddress(unixDomainSocketPath: "control.sock")
let descriptor = socket(AF_UNIX, SOCK_STREAM, 0)
XCTAssertGreaterThanOrEqual(descriptor, 0)
XCTAssertEqual(address.withSockAddr { bindTestSocket(descriptor, $0, socklen_t($1)) }, 0)
XCTAssertEqual(close(descriptor), 0)
XCTAssertTrue(FileManager.default.changeCurrentDirectoryPath(originalDirectory))
var controlSocket: ControlSocket? = try await ControlSocket(socketURL)
let eventLoopGroup = try XCTUnwrap(controlSocket?.eventLoopGroup)
do {
let serverChannel = try XCTUnwrap(controlSocket?.serverChannel)
XCTAssertEqual(FileManager.default.currentDirectoryPath, expectedDirectory)
XCTAssertTrue(FileManager.default.fileExists(atPath: socketURL.path))
try await serverChannel.executeThenClose { _ in }
}
controlSocket = nil
try await eventLoopGroup.shutdownGracefully()
}
private func makeTemporaryDirectory() throws -> URL {
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(
UUID().uuidString,
isDirectory: true
)
try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: false)
return directory
}
}
@@ -1,28 +0,0 @@
import XCTest
@testable import tart
final class ControlSocketURLTests: XCTestCase {
func testControlSocketURLResolvesToAbsolutePath() throws {
let baseURL = URL(fileURLWithPath: "/Users/test/.tart/vms/myvm/")
let vmDir = VMDirectory(baseURL: baseURL)
// The .path property resolves relative URLs to absolute paths,
// which is required for stale socket cleanup in ControlSocket.run()
// since it happens before the working directory is changed.
XCTAssertEqual(
vmDir.controlSocketURL.path,
"/Users/test/.tart/vms/myvm/control.sock"
)
}
func testControlSocketURLRelativePathIsJustFilename() throws {
let baseURL = URL(fileURLWithPath: "/Users/test/.tart/vms/myvm/")
let vmDir = VMDirectory(baseURL: baseURL)
// The .relativePath is used for socket binding after cwd is changed
XCTAssertEqual(
vmDir.controlSocketURL.relativePath,
"control.sock"
)
}
}
+31
View File
@@ -1,3 +1,4 @@
import Foundation
import XCTest
@testable import tart
@@ -21,4 +22,34 @@ final class DigestTests: XCTestCase {
XCTAssertEqual(Digest.hash(data), "sha256:d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592")
}
func testFileAndRangeHashingMatchDataHashing() throws {
let prefix = Data(repeating: 0x61, count: 4 * 1024 * 1024 + 17)
let range = Data("range".utf8)
let suffix = Data(repeating: 0x62, count: 23)
let data = prefix + range + suffix
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try data.write(to: url)
defer { try? FileManager.default.removeItem(at: url) }
XCTAssertEqual(try Digest.hash(url), Digest.hash(data))
XCTAssertEqual(try Digest.hash(url, offset: UInt64(prefix.count), size: UInt64(range.count)), Digest.hash(range))
}
func testRangeHashingRejectsOutOfBoundsRanges() throws {
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try Data("range".utf8).write(to: url)
defer { try? FileManager.default.removeItem(at: url) }
XCTAssertThrowsError(try Digest.hash(url, offset: 6, size: 0)) { error in
guard case DigestError.InvalidOffset = error else {
return XCTFail("unexpected error: \(error)")
}
}
XCTAssertThrowsError(try Digest.hash(url, offset: 1, size: UInt64.max)) { error in
guard case DigestError.InvalidSize = error else {
return XCTFail("unexpected error: \(error)")
}
}
}
}
+263
View File
@@ -0,0 +1,263 @@
import Foundation
import XCTest
@testable import tart
#if canImport(DiskImageKit)
import DiskImageKit
@available(macOS 27.0, *)
final class DiskImageStackTests: XCTestCase {
override func setUpWithError() throws {
try super.setUpWithError()
if #unavailable(macOS 27.0) {
throw XCTSkip("DiskImageKit tests require macOS 27 or newer")
}
}
func testCreatesAndAttachesRawBaseWithWritableOverlay() throws {
let fixture = try Fixture(baseFormat: .raw)
try fixture.disk.createWritableOverlay()
XCTAssertTrue(FileManager.default.fileExists(atPath: fixture.disk.writableOverlayURL.path))
_ = try fixture.disk.makeAttachment()
}
func testCreatesAndAttachesASIFBaseWithPublishedOverlay() throws {
let fixture = try Fixture(baseFormat: .asif, publishedOverlayCount: 1)
try fixture.disk.createWritableOverlay()
_ = try fixture.disk.makeAttachment()
}
func testCreatesAndAttachesMultiplePublishedOverlays() throws {
let fixture = try Fixture(baseFormat: .asif, publishedOverlayCount: 2)
try fixture.disk.createWritableOverlay()
_ = try fixture.disk.makeAttachment()
}
func testCreatesAndAttachesLongPublishedOverlayChain() throws {
let fixture = try Fixture(baseFormat: .asif, publishedOverlayCount: 8)
try fixture.disk.createWritableOverlay()
_ = try fixture.disk.makeAttachment()
}
func testAttachesStackReadOnly() throws {
let fixture = try Fixture(baseFormat: .raw)
try fixture.disk.createWritableOverlay()
_ = try fixture.disk.makeAttachment(readOnly: true)
}
func testRejectsMissingWritableOverlayWhenAttaching() throws {
let fixture = try Fixture(baseFormat: .raw)
assertThrows(.writableOverlayMissing(fixture.disk.writableOverlayURL)) {
try fixture.disk.makeAttachment()
}
}
func testRejectsExistingWritableOverlayWhenCreating() throws {
let fixture = try Fixture(baseFormat: .raw)
XCTAssertTrue(FileManager.default.createFile(atPath: fixture.disk.writableOverlayURL.path, contents: nil))
assertThrows(.writableOverlayAlreadyExists(fixture.disk.writableOverlayURL)) {
try fixture.disk.createWritableOverlay()
}
}
func testRejectsExistingCopyDestination() throws {
let fixture = try Fixture(baseFormat: .raw)
try fixture.disk.createWritableOverlay()
let destinationURL = fixture.directory.appendingPathComponent("existing-overlay.asif")
XCTAssertTrue(FileManager.default.createFile(atPath: destinationURL.path, contents: nil))
assertThrows(.writableOverlayAlreadyExists(destinationURL)) {
try fixture.disk.copyWritableOverlay(to: destinationURL)
}
}
func testRejectsNonASIFPublishedOverlay() throws {
let fixture = try Fixture(baseFormat: .raw)
let overlayURL = fixture.directory.appendingPathComponent("published-raw.img")
_ = try DiskImage(creating: .raw(url: overlayURL, blockCount: 8))
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: fixture.disk.baseFormat,
immutableOverlayURLs: [
overlayURL,
],
writableOverlayURL: fixture.disk.writableOverlayURL,
blockSize: fixture.disk.blockSize,
blockCount: fixture.disk.blockCount
)
assertThrows(.invalidDiskImage(overlayURL, "overlay must use ASIF format")) {
try fixture.disk.createWritableOverlay()
}
}
func testRejectsWrongBaseFormat() throws {
let fixture = try Fixture(baseFormat: .raw)
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: .asif,
immutableOverlayURLs: fixture.disk.immutableOverlayURLs,
writableOverlayURL: fixture.disk.writableOverlayURL,
blockSize: fixture.disk.blockSize,
blockCount: fixture.disk.blockCount
)
assertThrows(.invalidDiskImage(fixture.disk.baseURL, "base disk format does not match")) {
try fixture.disk.createWritableOverlay()
}
}
func testRejectsBlockSizeMismatch() throws {
let fixture = try Fixture(baseFormat: .raw)
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: fixture.disk.baseFormat,
immutableOverlayURLs: fixture.disk.immutableOverlayURLs,
writableOverlayURL: fixture.disk.writableOverlayURL,
blockSize: 4096,
blockCount: fixture.disk.blockCount
)
assertThrows(.invalidBlockLayout("immutable disk stack does not match manifest block size")) {
try fixture.disk.createWritableOverlay()
}
}
func testRejectsUnsupportedBlockSize() throws {
let fixture = try Fixture(baseFormat: .raw)
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: fixture.disk.baseFormat,
immutableOverlayURLs: fixture.disk.immutableOverlayURLs,
writableOverlayURL: fixture.disk.writableOverlayURL,
blockSize: 123,
blockCount: fixture.disk.blockCount
)
assertThrows(.invalidBlockLayout("unsupported stacked disk block size 123")) {
try fixture.disk.createWritableOverlay()
}
}
func testRejectsManifestBlockCountMismatch() throws {
let fixture = try Fixture(baseFormat: .raw)
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: fixture.disk.baseFormat,
immutableOverlayURLs: fixture.disk.immutableOverlayURLs,
writableOverlayURL: fixture.disk.writableOverlayURL,
blockSize: fixture.disk.blockSize,
blockCount: fixture.disk.blockCount + 1
)
assertThrows(.invalidBlockLayout("immutable disk stack does not match manifest block count")) {
try fixture.disk.createWritableOverlay()
}
}
func testCopiesAndGrowsWritableOverlay() throws {
let fixture = try Fixture(baseFormat: .raw)
try fixture.disk.createWritableOverlay()
let copiedURL = fixture.directory.appendingPathComponent("copied-overlay.asif")
try fixture.disk.copyWritableOverlay(to: copiedURL)
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: fixture.disk.baseFormat,
immutableOverlayURLs: fixture.disk.immutableOverlayURLs,
writableOverlayURL: copiedURL,
blockSize: fixture.disk.blockSize,
blockCount: fixture.disk.blockCount
)
try fixture.disk.growWritableOverlay(toBlockCount: 16)
let copied = try DiskImage(opening: .open(url: copiedURL, mode: .readOnly))
XCTAssertEqual(copied.blockCount, 16)
}
func testRejectsOverlayFromDifferentASIFParent() throws {
let fixture = try Fixture(baseFormat: .asif)
let other = try Fixture(baseFormat: .asif, publishedOverlayCount: 1)
fixture.disk = DiskImageStack(
baseURL: fixture.disk.baseURL,
baseFormat: fixture.disk.baseFormat,
immutableOverlayURLs: other.disk.immutableOverlayURLs,
writableOverlayURL: fixture.disk.writableOverlayURL,
blockSize: fixture.disk.blockSize,
blockCount: fixture.disk.blockCount
)
assertThrows(.invalidDiskImage(other.disk.immutableOverlayURLs[0], "ASIF overlay is incompatible with its parent")) {
try fixture.disk.createWritableOverlay()
}
}
func testRejectsWritableOverlayShrink() throws {
let fixture = try Fixture(baseFormat: .raw)
try fixture.disk.createWritableOverlay()
assertThrows(.invalidDiskImage(fixture.disk.writableOverlayURL, "ASIF overlay block count shrinks the stacked disk")) {
try fixture.disk.growWritableOverlay(toBlockCount: 4)
}
}
private func assertThrows<T>(
_ expected: DiskImageStackError,
operation: () throws -> T
) {
XCTAssertThrowsError(try operation()) { error in
XCTAssertEqual(error as? DiskImageStackError, expected)
}
}
private final class Fixture {
let directory: URL
var disk: DiskImageStack
init(baseFormat: DiskImageFormat, publishedOverlayCount: Int = 0) throws {
directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: false)
let baseURL = directory.appendingPathComponent("base.img")
switch baseFormat {
case .raw:
_ = try DiskImage(creating: .raw(url: baseURL, blockCount: 8))
case .asif:
_ = try DiskImage(creating: .asif(url: baseURL, blockCount: 8, blockSize: .bytes512))
}
var immutableOverlayURLs: [URL] = []
var image = try DiskImage(opening: .open(url: baseURL, mode: .readOnly))
for index in 0..<publishedOverlayCount {
let overlayURL = directory.appendingPathComponent("published-\(index).asif")
let stack = try image.appending(.asifLayer(url: overlayURL, type: .overlay))
immutableOverlayURLs.append(overlayURL)
image = stack
}
disk = DiskImageStack(
baseURL: baseURL,
baseFormat: baseFormat,
immutableOverlayURLs: immutableOverlayURLs,
writableOverlayURL: directory.appendingPathComponent("overlay.asif"),
blockSize: 512,
blockCount: 8
)
}
deinit {
try? FileManager.default.removeItem(at: directory)
}
}
}
#endif
@@ -0,0 +1,15 @@
import Foundation
import XCTest
@testable import tart
final class HumanReadableByteCountTests: XCTestCase {
func testTextAndJSONRepresentations() throws {
let integer = HumanReadableByteCount(51_400_000_000) { _ in 51 }
let string = HumanReadableByteCount(17_234_000_000) { _ in "17.234" }
let encoder = JSONEncoder()
XCTAssertEqual(string.description.compactMap(\.wholeNumberValue), [1, 7])
XCTAssertEqual(try JSONDecoder().decode(Int.self, from: encoder.encode(integer)), 51)
XCTAssertEqual(try JSONDecoder().decode(String.self, from: encoder.encode(string)), "17.234")
}
}
@@ -0,0 +1,152 @@
import Virtualization
import XCTest
@testable import tart
final class InputDeviceConfigurationTests: XCTestCase {
func testLinuxUSBInputsCanBeDisabled() {
let configuration = VZVirtualMachineConfiguration()
VM.configureInputDevices(configuration, platform: Linux())
XCTAssertEqual(configuration.keyboards.count, 1)
XCTAssertTrue(configuration.keyboards.contains { $0 is VZUSBKeyboardConfiguration })
XCTAssertEqual(configuration.pointingDevices.count, 1)
XCTAssertTrue(configuration.pointingDevices.contains { $0 is VZUSBScreenCoordinatePointingDeviceConfiguration })
VM.configureInputDevices(configuration, platform: Linux(), noUSBAccessories: true)
XCTAssertTrue(configuration.keyboards.isEmpty)
XCTAssertTrue(configuration.pointingDevices.isEmpty)
VM.configureInputDevices(configuration, platform: Linux(), noUSBAccessories: true, noTrackpad: true)
XCTAssertTrue(configuration.keyboards.isEmpty)
XCTAssertTrue(configuration.pointingDevices.isEmpty)
}
#if arch(arm64)
func testMacOS13RetainsItsNativeTrackpad() {
let platform = MacInputPlatform(nativeKeyboard: false)
let configuration = VZVirtualMachineConfiguration()
VM.configureInputDevices(configuration, platform: platform)
XCTAssertEqual(configuration.keyboards.count, 1)
XCTAssertEqual(configuration.pointingDevices.count, 2)
VM.configureInputDevices(configuration, platform: platform, noUSBAccessories: true)
XCTAssertTrue(configuration.keyboards.isEmpty)
XCTAssertEqual(configuration.pointingDevices.count, 1)
XCTAssertTrue(configuration.pointingDevices.contains { $0 is VZMacTrackpadConfiguration })
}
func testMacOS14RetainsBothNativeInputs() throws {
guard #available(macOS 14, *) else {
throw XCTSkip("Mac keyboards require macOS 14")
}
let configuration = VZVirtualMachineConfiguration()
VM.configureInputDevices(configuration, platform: MacInputPlatform(nativeKeyboard: true), noUSBAccessories: true)
XCTAssertEqual(configuration.keyboards.count, 1)
XCTAssertTrue(configuration.keyboards.contains { $0 is VZMacKeyboardConfiguration })
XCTAssertEqual(configuration.pointingDevices.count, 1)
XCTAssertTrue(configuration.pointingDevices.contains { $0 is VZMacTrackpadConfiguration })
}
func testInputFlagsStillSelectTheExpectedDevices() throws {
guard #available(macOS 14, *) else {
throw XCTSkip("Mac keyboards require macOS 14")
}
let platform = MacInputPlatform(nativeKeyboard: true)
for noUSBAccessories in [false, true] {
for noKeyboard in [false, true] {
for noPointer in [false, true] {
for noTrackpad in [false, true] {
let configuration = VZVirtualMachineConfiguration()
VM.configureInputDevices(
configuration,
platform: platform,
noUSBAccessories: noUSBAccessories,
noTrackpad: noTrackpad,
noPointer: noPointer,
noKeyboard: noKeyboard
)
XCTAssertEqual(configuration.keyboards.contains { $0 is VZUSBKeyboardConfiguration }, !noUSBAccessories && !noKeyboard)
XCTAssertEqual(configuration.keyboards.contains { $0 is VZMacKeyboardConfiguration }, !noKeyboard)
XCTAssertEqual(configuration.pointingDevices.contains { $0 is VZUSBScreenCoordinatePointingDeviceConfiguration }, !noUSBAccessories && !noPointer)
XCTAssertEqual(configuration.pointingDevices.contains { $0 is VZMacTrackpadConfiguration }, !noPointer && !noTrackpad)
}
}
}
}
}
func testSuspendableFallbackCannotReintroduceUSBInputs() {
let configuration = VZVirtualMachineConfiguration()
let platform = MacInputPlatform(nativeKeyboard: false)
VM.configureInputDevices(configuration, platform: platform, suspendable: true)
XCTAssertEqual(configuration.keyboards.count, 1)
XCTAssertEqual(configuration.pointingDevices.count, 2)
VM.configureInputDevices(
configuration,
platform: platform,
suspendable: true,
noUSBAccessories: true
)
XCTAssertTrue(configuration.keyboards.isEmpty)
XCTAssertEqual(configuration.pointingDevices.count, 1)
XCTAssertTrue(configuration.pointingDevices.contains { $0 is VZMacTrackpadConfiguration })
}
#endif
}
#if arch(arm64)
// Model macOS 13 and 14 input availability without requiring a second host.
private struct MacInputPlatform: PlatformSuspendable {
var nativeKeyboard: Bool
func os() -> OS { .darwin }
func bootLoader(nvramURL: URL) throws -> VZBootLoader {
try Linux().bootLoader(nvramURL: nvramURL)
}
func platform(nvramURL: URL, needsNestedVirtualization: Bool) throws -> VZPlatformConfiguration {
try Linux().platform(nvramURL: nvramURL, needsNestedVirtualization: needsNestedVirtualization)
}
func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration {
Linux().graphicsDevice(vmConfig: vmConfig)
}
func keyboards(noUSB: Bool) -> [VZKeyboardConfiguration] {
var devices: [VZKeyboardConfiguration] = noUSB ? [] : [VZUSBKeyboardConfiguration()]
if nativeKeyboard, #available(macOS 14, *) {
devices.append(VZMacKeyboardConfiguration())
}
return devices
}
func pointingDevices(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
var devices: [VZPointingDeviceConfiguration] = noUSB ? [] : [VZUSBScreenCoordinatePointingDeviceConfiguration()]
devices.append(VZMacTrackpadConfiguration())
return devices
}
func pointingDevicesSimplified(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
noUSB ? [] : [VZUSBScreenCoordinatePointingDeviceConfiguration()]
}
func keyboardsSuspendable(noUSB: Bool) -> [VZKeyboardConfiguration] {
if nativeKeyboard, #available(macOS 14, *) {
return [VZMacKeyboardConfiguration()]
}
return keyboards(noUSB: noUSB)
}
func pointingDevicesSuspendable(noUSB: Bool) -> [VZPointingDeviceConfiguration] {
nativeKeyboard ? [VZMacTrackpadConfiguration()] : pointingDevices(noUSB: noUSB)
}
}
#endif
+9 -2
View File
@@ -14,7 +14,7 @@ final class LayerizerTests: XCTestCase {
do {
registryRunner = try await RegistryRunner()
} catch {
try XCTSkip("Registry is unavailable: \(error)")
throw XCTSkip("Registry is unavailable: \(error)")
}
}
@@ -36,7 +36,14 @@ final class LayerizerTests: XCTestCase {
let pulledDiskFileURL = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
print("pushing disk...")
let diskLayers = try await DiskV2.push(diskURL: originalDiskFileURL, registry: registry, chunkSizeMb: 0, concurrency: 4, progress: Progress())
let diskLayers = try await DiskV2.push(
diskURL: originalDiskFileURL,
mediaType: diskV2MediaType,
registry: registry,
chunkSizeMb: 0,
concurrency: 4,
progress: Progress()
)
print("pulling disk...")
try await DiskV2.pull(registry: registry, diskLayers: diskLayers, diskURL: pulledDiskFileURL, concurrency: 16, progress: Progress())
+196
View File
@@ -0,0 +1,196 @@
import XCTest
@testable import tart
final class OCIManifestTests: XCTestCase {
func testFlatDiskRepresentation() throws {
let chunks = [chunk(mediaType: diskV2MediaType, suffix: "base-0")]
let representation = try manifest(diskDescriptors: chunks).tartDiskRepresentation()
XCTAssertEqual(representation, .flat(base: TartDiskFileGroup(kind: .base, chunks: chunks, contentDigest: nil)))
}
func testStackedDiskRepresentation() throws {
let base = chunk(mediaType: diskV2MediaType, suffix: "base-0", diskFileDigest: "sha256:base")
let overlay0 = chunk(mediaType: asifOverlayMediaType, suffix: "overlay-0", diskFileDigest: "sha256:overlay", chunkCount: 2)
let overlay1 = chunk(mediaType: asifOverlayMediaType, suffix: "overlay-1")
let representation = try manifest(diskDescriptors: [base, overlay0, overlay1]).tartDiskRepresentation()
XCTAssertEqual(representation, .stacked(
base: TartDiskFileGroup(kind: .base, chunks: [base], contentDigest: "sha256:base"),
overlays: [TartDiskFileGroup(kind: .asifOverlay, chunks: [overlay0, overlay1], contentDigest: "sha256:overlay")]
))
}
func testDiskFileGroupUncompressedSize() {
let first = chunk(mediaType: diskV2MediaType, suffix: "base-0")
let second = chunk(mediaType: diskV2MediaType, suffix: "base-1")
XCTAssertEqual(TartDiskFileGroup(kind: .base, chunks: [first, second], contentDigest: nil).uncompressedSize(), 2)
var overflowing = first
overflowing.annotations?[uncompressedSizeAnnotation] = String(UInt64.max)
XCTAssertNil(TartDiskFileGroup(kind: .base, chunks: [overflowing, second], contentDigest: nil).uncompressedSize())
}
func testDiskContentDigests() throws {
let flatBase = chunk(mediaType: diskV2MediaType, suffix: "flat", diskFileDigest: "sha256:flat")
XCTAssertEqual(try manifest(diskDescriptors: [flatBase]).diskContentDigests(), ["sha256:flat"])
let stackedBase = chunk(mediaType: diskV2MediaType, suffix: "base", diskFileDigest: "sha256:base")
let overlay = chunk(
mediaType: asifOverlayMediaType,
suffix: "overlay",
diskFileDigest: "sha256:overlay",
chunkCount: 1
)
XCTAssertEqual(
try manifest(diskDescriptors: [stackedBase, overlay]).diskContentDigests(),
["sha256:base", "sha256:overlay"]
)
}
func testStackedRepresentationRequiresBaseDigest() throws {
let base = chunk(mediaType: diskV2MediaType, suffix: "base-0")
let overlay = chunk(mediaType: asifOverlayMediaType, suffix: "overlay-0", diskFileDigest: "sha256:overlay", chunkCount: 1)
assertManifestError(
.invalidDiskMetadata("a stacked base disk needs a whole-file content digest"),
diskDescriptors: [base, overlay]
)
}
func testBaseGroupRejectsMetadataAfterFirstChunk() throws {
let base0 = chunk(mediaType: diskV2MediaType, suffix: "base-0", diskFileDigest: "sha256:base")
let base1 = chunk(mediaType: diskV2MediaType, suffix: "base-1", diskFileDigest: "sha256:other-base")
assertManifestError(
.invalidDiskMetadata("base disk metadata must appear only on its first chunk"),
diskDescriptors: [base0, base1]
)
}
func testBaseGroupRejectsOverlayChunkCount() throws {
let base = chunk(mediaType: diskV2MediaType, suffix: "base-0", diskFileDigest: "sha256:base", chunkCount: 1)
assertManifestError(
.invalidDiskMetadata("base disk metadata must appear only on its first chunk"),
diskDescriptors: [base]
)
}
func testOverlayGroupRequiresDigestAndChunkCount() throws {
let base = chunk(mediaType: diskV2MediaType, suffix: "base-0", diskFileDigest: "sha256:base")
let overlay = chunk(mediaType: asifOverlayMediaType, suffix: "overlay-0")
assertManifestError(
.invalidDiskMetadata("an ASIF overlay needs a content digest and chunk count"),
diskDescriptors: [base, overlay]
)
}
func testOverlayGroupRejectsInconsistentChunkCount() throws {
let base = chunk(mediaType: diskV2MediaType, suffix: "base-0", diskFileDigest: "sha256:base")
let overlay = chunk(mediaType: asifOverlayMediaType, suffix: "overlay-0", diskFileDigest: "sha256:overlay", chunkCount: 2)
assertManifestError(
.invalidDiskMetadata("ASIF overlay chunk count is invalid"),
diskDescriptors: [base, overlay]
)
}
func testDiskV2AfterOverlayIsRejected() throws {
let base = chunk(mediaType: diskV2MediaType, suffix: "base-0", diskFileDigest: "sha256:base")
let overlay = chunk(mediaType: asifOverlayMediaType, suffix: "overlay-0", diskFileDigest: "sha256:overlay", chunkCount: 2)
let lateBase = chunk(mediaType: diskV2MediaType, suffix: "base-1")
assertManifestError(
.invalidLayout("ASIF overlay chunks must be contiguous"),
diskDescriptors: [base, overlay, lateBase]
)
}
func testChunkMetadataIsRequired() throws {
var base = chunk(mediaType: diskV2MediaType, suffix: "base-0")
base.annotations = nil
assertManifestError(
.invalidDiskMetadata("disk chunks need uncompressed size and content digest"),
diskDescriptors: [base]
)
}
func testCanonicalConfigAndNVRAMOrderIsRequired() throws {
let disk = chunk(mediaType: diskV2MediaType, suffix: "base-0")
let manifest = OCIManifest(
config: OCIManifestConfig(size: 1, digest: "sha256:oci-config"),
layers: [disk, configLayer(), nvramLayer()]
)
XCTAssertThrowsError(try manifest.tartDiskRepresentation()) { error in
XCTAssertEqual(
error as? OCIManifestValidationError,
.invalidLayout("descriptors must be ordered as config, disk chunks, then NVRAM")
)
}
}
func testManifestBlockLayout() throws {
var manifest = manifest(diskDescriptors: [chunk(mediaType: diskV2MediaType, suffix: "base-0")])
manifest.annotations = [
uncompressedDiskSizeAnnotation: "100000000000",
diskBlockSizeAnnotation: "512",
]
XCTAssertEqual(manifest.diskBlockSize(), 512)
XCTAssertEqual(manifest.diskBlockCount(), 195312500)
}
func testManifestRejectsInexactDerivedBlockCount() throws {
var manifest = manifest(diskDescriptors: [chunk(mediaType: diskV2MediaType, suffix: "base-0")])
manifest.annotations = [
uncompressedDiskSizeAnnotation: "513",
diskBlockSizeAnnotation: "512",
]
XCTAssertNil(manifest.diskBlockCount())
}
private func assertManifestError(_ expected: OCIManifestValidationError, diskDescriptors: [OCIManifestLayer]) {
XCTAssertThrowsError(try manifest(diskDescriptors: diskDescriptors).tartDiskRepresentation()) { error in
XCTAssertEqual(error as? OCIManifestValidationError, expected)
}
}
private func manifest(diskDescriptors: [OCIManifestLayer]) -> OCIManifest {
OCIManifest(
config: OCIManifestConfig(size: 1, digest: "sha256:oci-config"),
layers: [configLayer()] + diskDescriptors + [nvramLayer()]
)
}
private func configLayer() -> OCIManifestLayer {
OCIManifestLayer(mediaType: configMediaType, size: 1, digest: "sha256:tart-config")
}
private func nvramLayer() -> OCIManifestLayer {
OCIManifestLayer(mediaType: nvramMediaType, size: 1, digest: "sha256:nvram")
}
private func chunk(mediaType: String, suffix: String, diskFileDigest: String? = nil, chunkCount: Int? = nil) -> OCIManifestLayer {
var descriptor = OCIManifestLayer(
mediaType: mediaType,
size: 1,
digest: "sha256:\(suffix)",
uncompressedSize: 1,
uncompressedContentDigest: "sha256:uncompressed-\(suffix)"
)
if let diskFileDigest {
descriptor.annotations?[diskFileContentDigestAnnotation] = diskFileDigest
}
if let chunkCount {
descriptor.annotations?[diskFileChunkCountAnnotation] = String(chunkCount)
}
return descriptor
}
}
+1 -1
View File
@@ -10,7 +10,7 @@ final class RegistryTests: XCTestCase {
do {
registryRunner = try await RegistryRunner()
} catch {
try XCTSkip("Registry is unavailable: \(error)")
throw XCTSkip("Registry is unavailable: \(error)")
}
}
+183
View File
@@ -0,0 +1,183 @@
import XCTest
@testable import tart
import Semaphore
final class SoftnetControlFDTests: XCTestCase {
func testConnectedUnixStreamSocketIsAccepted() throws {
var fds: [Int32] = [-1, -1]
XCTAssertEqual(socketpair(AF_UNIX, SOCK_STREAM, 0, &fds), 0)
defer {
close(fds[0])
close(fds[1])
}
XCTAssertNoThrow(try Softnet.validateControlFD(fds[0]))
}
func testUnixDatagramSocketIsRejected() throws {
var fds: [Int32] = [-1, -1]
XCTAssertEqual(socketpair(AF_UNIX, SOCK_DGRAM, 0, &fds), 0)
defer {
close(fds[0])
close(fds[1])
}
XCTAssertThrowsError(try Softnet.validateControlFD(fds[0]))
}
func testUnconnectedUnixStreamSocketIsRejected() throws {
let fd = socket(AF_UNIX, SOCK_STREAM, 0)
XCTAssertGreaterThan(fd, STDERR_FILENO)
defer { close(fd) }
XCTAssertThrowsError(try Softnet.validateControlFD(fd))
}
func testPipeIsRejected() throws {
var fds: [Int32] = [-1, -1]
XCTAssertEqual(pipe(&fds), 0)
defer {
close(fds[0])
close(fds[1])
}
XCTAssertThrowsError(try Softnet.validateControlFD(fds[0]))
}
func testStandardDescriptorsAreRejected() throws {
XCTAssertThrowsError(try Softnet.validateControlFD(STDIN_FILENO))
XCTAssertThrowsError(try Softnet.validateControlFD(STDOUT_FILENO))
XCTAssertThrowsError(try Softnet.validateControlFD(STDERR_FILENO))
}
func testStandardDescriptorsRemainOpenWhenInitializationFails() throws {
for fd in [STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO] {
let flags = fcntl(fd, F_GETFD)
XCTAssertNotEqual(flags, -1)
XCTAssertThrowsError(try Softnet(vmMACAddress: "02:00:00:00:00:01", controlFD: fd))
XCTAssertEqual(fcntl(fd, F_GETFD), flags)
}
}
func testControlChannelIsPassedToSoftnetAndVMFDRemainsDatagram() async throws {
let temporaryDirectory = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(UUID().uuidString)
try FileManager.default.createDirectory(at: temporaryDirectory, withIntermediateDirectories: false)
defer { try? FileManager.default.removeItem(at: temporaryDirectory) }
let executable = temporaryDirectory.appendingPathComponent("softnet")
let script = """
#!/usr/bin/env python3
import socket
import sys
assert sys.argv[1:] == ["--vm-fd", "0", "--vm-mac-address", "02:00:00:00:00:01", "--control-fd", "1"]
vm = socket.socket(fileno=0)
control = socket.socket(fileno=1)
assert vm.family == socket.AF_UNIX and vm.type == socket.SOCK_DGRAM
assert control.family == socket.AF_UNIX and control.type == socket.SOCK_STREAM
assert control.recv(4096) == b"softnet.policy.set\\n"
control.sendall(b"ok\\n")
"""
try script.write(to: executable, atomically: true, encoding: .utf8)
try FileManager.default.setAttributes([.posixPermissions: 0o755], ofItemAtPath: executable.path)
let previousPath = ProcessInfo.processInfo.environment["PATH"] ?? ""
setenv("PATH", "\(temporaryDirectory.path):\(previousPath)", 1)
defer { setenv("PATH", previousPath, 1) }
var fds: [Int32] = [-1, -1]
XCTAssertEqual(socketpair(AF_UNIX, SOCK_STREAM, 0, &fds), 0)
defer { close(fds[1]) }
var timeout = timeval(tv_sec: 5, tv_usec: 0)
XCTAssertEqual(setsockopt(fds[1], SOL_SOCKET, SO_RCVTIMEO, &timeout, socklen_t(MemoryLayout<timeval>.size)), 0)
let semaphore = AsyncSemaphore(value: 0)
let softnet = try Softnet(vmMACAddress: "02:00:00:00:00:01", controlFD: fds[0])
try softnet.run(semaphore)
XCTAssertEqual(fcntl(fds[0], F_GETFD), -1)
XCTAssertEqual(errno, EBADF)
let request = Array("softnet.policy.set\n".utf8)
XCTAssertEqual(request.withUnsafeBytes { send(fds[1], $0.baseAddress, $0.count, 0) }, request.count)
var response = [UInt8](repeating: 0, count: 128)
let received = recv(fds[1], &response, response.count, 0)
XCTAssertGreaterThan(received, 0)
XCTAssertEqual(String(decoding: response.prefix(Int(max(received, 0))), as: UTF8.self), "ok\n")
await semaphore.wait()
}
func testControlFDIsClosedWhenSoftnetInitializationFails() throws {
let previousPath = ProcessInfo.processInfo.environment["PATH"] ?? ""
setenv("PATH", "/this/path/does/not/exist", 1)
defer { setenv("PATH", previousPath, 1) }
var fds: [Int32] = [-1, -1]
XCTAssertEqual(socketpair(AF_UNIX, SOCK_STREAM, 0, &fds), 0)
defer { close(fds[1]) }
XCTAssertThrowsError(try Softnet(vmMACAddress: "02:00:00:00:00:01", controlFD: fds[0]))
XCTAssertEqual(fcntl(fds[0], F_GETFD), -1)
XCTAssertEqual(errno, EBADF)
}
func testControlFDIsClosedWhenSoftnetValidationFails() throws {
var fds: [Int32] = [-1, -1]
XCTAssertEqual(socketpair(AF_UNIX, SOCK_DGRAM, 0, &fds), 0)
defer { close(fds[1]) }
XCTAssertThrowsError(try Softnet(vmMACAddress: "02:00:00:00:00:01", controlFD: fds[0]))
XCTAssertEqual(fcntl(fds[0], F_GETFD), -1)
XCTAssertEqual(errno, EBADF)
}
func testControlFDImpliesSoftnet() throws {
let temporaryHome = try createTemporaryTartHome()
defer { try? FileManager.default.removeItem(at: temporaryHome) }
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", temporaryHome.path, 1)
defer { restoreEnvironment("TART_HOME", value: previousHome) }
let command = try Run.parse(["vm", "--net-softnet-control-fd", "3"])
XCTAssertTrue(command.netSoftnet)
XCTAssertEqual(command.netSoftnetControlFd, 3)
}
func testControlFDIsRejectedWithHostNetworking() throws {
let temporaryHome = try createTemporaryTartHome()
defer { try? FileManager.default.removeItem(at: temporaryHome) }
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", temporaryHome.path, 1)
defer { restoreEnvironment("TART_HOME", value: previousHome) }
XCTAssertThrowsError(
try Run.parse(["vm", "--net-host", "--net-softnet-control-fd", "3"])
)
}
private func createTemporaryTartHome() throws -> URL {
let temporaryHome = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(UUID().uuidString)
let vm = temporaryHome.appendingPathComponent("vms/vm")
try FileManager.default.createDirectory(at: vm, withIntermediateDirectories: true)
for name in ["config.json", "disk.img", "nvram.bin"] {
XCTAssertTrue(FileManager.default.createFile(atPath: vm.appendingPathComponent(name).path, contents: nil))
}
return temporaryHome
}
private func restoreEnvironment(_ name: String, value: String?) {
if let value = value {
setenv(name, value, 1)
} else {
unsetenv(name)
}
}
}
@@ -0,0 +1,359 @@
import Foundation
import XCTest
@testable import tart
#if canImport(DiskImageKit)
import DiskImageKit
@available(macOS 27.0, *)
final class VMDirectoryDiskImageStackTests: XCTestCase {
override func setUpWithError() throws {
try super.setUpWithError()
if #unavailable(macOS 27.0) {
throw XCTSkip("DiskImageKit tests require macOS 27 or newer")
}
}
func testBaseBlockLayoutReadsRawAndASIFImages() throws {
let directory = try temporaryDirectory()
let rawURL = directory.appendingPathComponent("base.raw")
let asifURL = directory.appendingPathComponent("base.asif")
_ = try DiskImage(creating: .raw(url: rawURL, blockCount: 8))
_ = try DiskImage(creating: .asif(url: asifURL, blockCount: 16, blockSize: .bytes512))
XCTAssertEqual(try DiskImageStack.baseBlockLayout(at: rawURL, expectedFormat: .raw).blockCount, 8)
XCTAssertEqual(try DiskImageStack.baseBlockLayout(at: asifURL, expectedFormat: .asif).blockCount, 16)
}
func testCloneAsStackedBasePinsFlatManifestAndCreatesOverlay() throws {
let contentStore = try temporaryContentStore()
let source = try flatSource()
let destination = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: destination, generateMAC: false, contentStore: contentStore)
XCTAssertTrue(destination.isStackedVM)
XCTAssertFalse(FileManager.default.fileExists(atPath: destination.diskURL.path))
let contentDigest = try Digest.hash(source.diskURL)
let manifest = try OCIManifest(fromJSON: Data(contentsOf: destination.manifestURL))
guard case .flat(let base) = try manifest.tartDiskRepresentation() else {
return XCTFail("expected a pinned base-only manifest")
}
XCTAssertEqual(base.contentDigest, contentDigest)
XCTAssertEqual(manifest.diskBlockSize(), 512)
XCTAssertEqual(manifest.diskBlockCount(), 8)
let stack = try destination.diskImageStack(contentStore: contentStore)
XCTAssertEqual(stack.baseURL, try contentStore.contentURL(for: contentDigest))
XCTAssertTrue(FileManager.default.fileExists(atPath: destination.overlayURL.path))
}
func testCloneAsStackedBaseSupportsASIFDisk() throws {
let contentStore = try temporaryContentStore()
let source = try flatSource(diskFormat: .asif)
let destination = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: destination, generateMAC: false, contentStore: contentStore)
let stack = try destination.diskImageStack(contentStore: contentStore)
XCTAssertEqual(stack.baseFormat, .asif)
XCTAssertTrue(destination.isStackedVM)
_ = try stack.makeAttachment()
}
func testStackedCloneCanCopyOrCreateWritableOverlay() throws {
let contentStore = try temporaryContentStore()
let source = try flatSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false, contentStore: contentStore)
let copied = try temporaryVMDirectory()
try stacked.cloneStacked(to: copied, copyWritableOverlay: true, generateMAC: false, contentStore: contentStore)
XCTAssertEqual(try Digest.hash(copied.overlayURL), try Digest.hash(stacked.overlayURL))
let fresh = try temporaryVMDirectory()
try stacked.cloneStacked(to: fresh, copyWritableOverlay: false, generateMAC: false, contentStore: contentStore)
XCTAssertTrue(fresh.isStackedVM)
XCTAssertTrue(FileManager.default.fileExists(atPath: fresh.overlayURL.path))
}
func testStackedRemoteAdditionalDiskRetainsTemporaryVM() throws {
try withTemporaryTartHome {
let source = try flatSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false)
let storage = try VMStorageOCI()
let name = try RemoteName("example.com/org/image:latest")
let cachedImage = try storage.create(name)
try FileManager.default.copyItem(at: stacked.configURL, to: cachedImage.configURL)
try FileManager.default.copyItem(at: stacked.nvramURL, to: cachedImage.nvramURL)
try FileManager.default.copyItem(at: stacked.manifestURL, to: cachedImage.manifestURL)
do {
let additionalDisk = try AdditionalDisk(parseFrom: name.description)
let entries = try temporaryEntries()
XCTAssertEqual(entries.count, 1)
XCTAssertTrue(VMDirectory(baseURL: entries[0]).isStackedVM)
try Config().gc()
XCTAssertEqual(try temporaryEntries(), entries)
withExtendedLifetime(additionalDisk) {}
}
try Config().gc()
XCTAssertTrue(try temporaryEntries().isEmpty)
}
}
func testResizeDiskGrowsWritableOverlayAndPreservesParentGeometry() throws {
let contentStore = try temporaryContentStore()
let source = try flatSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false, contentStore: contentStore)
try stacked.resizeDisk(1, contentStore: contentStore)
let image = try DiskImage(opening: .open(url: stacked.overlayURL, mode: .readOnly))
XCTAssertEqual(image.blockCount, 1_000_000_000 / 512)
XCTAssertEqual(try stacked.diskSizeBytes(), 1_000_000_000)
let manifest = try OCIManifest(fromJSON: Data(contentsOf: stacked.manifestURL))
XCTAssertEqual(manifest.diskBlockSize(), 512)
XCTAssertEqual(manifest.diskBlockCount(), 8)
_ = try stacked.diskImageStack(contentStore: contentStore).makeAttachment()
}
func testStackedArchiveRoundTripsImmutableContentAndOverlay() throws {
try withTemporaryTartHome {
let source = try flatSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false)
let contentDigest = try Digest.hash(source.diskURL)
let contentStore = try ContentStore()
let archivedOverlayDigest = try Digest.hash(stacked.overlayURL)
let archiveURL = try temporaryDirectory().appendingPathComponent("stacked.tvm")
try stacked.exportToArchive(path: archiveURL.path)
let cachedBaseURL = try XCTUnwrap(try contentStore.existingContentURL(for: contentDigest))
// Import must repair a corrupt cache entry from the valid archive
// instead of discarding the archive copy as an apparent cache hit.
try Data("corrupt".utf8).write(to: cachedBaseURL)
XCTAssertNil(try contentStore.existingContentURL(for: contentDigest))
let imported = try temporaryVMDirectory()
try imported.importFromArchive(path: archiveURL.path)
XCTAssertTrue(imported.isStackedVM)
XCTAssertEqual(try Digest.hash(imported.overlayURL), archivedOverlayDigest)
XCTAssertNotNil(try contentStore.existingContentURL(for: contentDigest))
_ = try imported.diskImageStack().makeAttachment()
}
}
func testStackedArchiveRejectsCorruptImmutableContent() throws {
try withTemporaryTartHome {
let source = try flatSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false)
let contentDigest = try Digest.hash(source.diskURL)
let contentStore = try ContentStore()
let cachedBaseURL = try XCTUnwrap(try contentStore.contentURLIfPresent(for: contentDigest))
try Data("corrupt".utf8).write(to: cachedBaseURL)
let archiveURL = try temporaryDirectory().appendingPathComponent("stacked.tvm")
XCTAssertThrowsError(try stacked.exportToArchive(path: archiveURL.path)) { error in
guard case RuntimeError.ExportFailed(let message) = error else {
return XCTFail("unexpected error: \(error)")
}
XCTAssertEqual(message, "VM is missing cached disk content \(contentDigest)")
}
}
}
func testStackedOCIArchiveSurvivesConcurrentRecordDeletion() throws {
try withTemporaryTartHome {
let source = try flatSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false)
let manifest = try OCIManifest(fromJSON: Data(contentsOf: stacked.manifestURL))
let storage = try VMStorageOCI()
let record = try storage.create(RemoteName(
host: "example.com",
namespace: "org/image",
reference: Reference(digest: try manifest.digest())
))
try FileManager.default.copyItem(at: stacked.configURL, to: record.configURL)
try FileManager.default.copyItem(at: stacked.nvramURL, to: record.nvramURL)
try FileManager.default.copyItem(at: stacked.manifestURL, to: record.manifestURL)
XCTAssertTrue(record.isStackedCachedImage)
let archiveURL = try temporaryDirectory().appendingPathComponent("stacked-race.tvm")
let contentStore = try ContentStore()
let lockHeld = DispatchSemaphore(value: 0)
let releaseLock = DispatchSemaphore(value: 0)
let exportStarted = DispatchSemaphore(value: 0)
let exportFinished = DispatchSemaphore(value: 0)
let deletionStarted = DispatchSemaphore(value: 0)
let deletionFinished = DispatchSemaphore(value: 0)
DispatchQueue.global().async {
try? contentStore.withPruneLock {
lockHeld.signal()
releaseLock.wait()
}
}
XCTAssertEqual(lockHeld.wait(timeout: .now() + 1), .success)
// Queue export first so it is the next prune-lock waiter, then queue
// deletion behind it. Export must finish staging everything it needs
// before deletion can remove the source cached image.
DispatchQueue.global().async {
exportStarted.signal()
try? record.exportToArchive(path: archiveURL.path)
exportFinished.signal()
}
XCTAssertEqual(exportStarted.wait(timeout: .now() + 1), .success)
Thread.sleep(forTimeInterval: 0.1)
DispatchQueue.global().async {
deletionStarted.signal()
try? record.delete()
deletionFinished.signal()
}
XCTAssertEqual(deletionStarted.wait(timeout: .now() + 1), .success)
XCTAssertEqual(exportFinished.wait(timeout: .now() + 0.1), .timedOut)
XCTAssertEqual(deletionFinished.wait(timeout: .now() + 0.1), .timedOut)
releaseLock.signal()
XCTAssertEqual(exportFinished.wait(timeout: .now() + 5), .success)
XCTAssertEqual(deletionFinished.wait(timeout: .now() + 5), .success)
XCTAssertFalse(FileManager.default.fileExists(atPath: record.baseURL.path))
let imported = try temporaryVMDirectory()
try imported.importFromArchive(path: archiveURL.path)
XCTAssertTrue(imported.isStackedVM)
_ = try imported.diskImageStack().makeAttachment()
}
}
func testResolvesPublishedOverlayFromManifestAndCache() throws {
let contentStore = try temporaryContentStore()
let source = try flatSource()
let baseOnly = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: baseOnly, generateMAC: false, contentStore: contentStore)
let contentDigest = try Digest.hash(baseOnly.overlayURL)
let temporaryContentURL = try contentStore.temporaryContentURL(for: contentDigest)
try FileManager.default.copyItem(at: baseOnly.overlayURL, to: temporaryContentURL)
_ = try contentStore.install(temporaryContentURL, contentDigest: contentDigest)
var manifest = try OCIManifest(fromJSON: Data(contentsOf: baseOnly.manifestURL))
var overlay = OCIManifestLayer(
mediaType: asifOverlayMediaType,
size: 1,
digest: "sha256:overlay-transport",
uncompressedSize: 1,
uncompressedContentDigest: "sha256:overlay-chunk"
)
overlay.annotations?[diskFileContentDigestAnnotation] = contentDigest
overlay.annotations?[diskFileChunkCountAnnotation] = "1"
manifest.layers.insert(overlay, at: manifest.layers.count - 1)
let destination = try temporaryVMDirectory()
try FileManager.default.copyItem(at: baseOnly.configURL, to: destination.configURL)
try FileManager.default.copyItem(at: baseOnly.nvramURL, to: destination.nvramURL)
try manifest.toJSON().write(to: destination.manifestURL)
let stack = try destination.diskImageStack(contentStore: contentStore)
XCTAssertEqual(stack.immutableOverlayURLs, [try contentStore.contentURL(for: contentDigest)])
try stack.createWritableOverlay()
_ = try stack.makeAttachment()
}
private func flatSource(diskFormat: DiskImageFormat = .raw) throws -> VMDirectory {
let vmDir = try temporaryVMDirectory()
let config = VMConfig(
platform: Linux(),
cpuCountMin: 2,
memorySizeMin: 512 * 1024 * 1024,
diskFormat: diskFormat
)
try config.save(toURL: vmDir.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.nvramURL.path, contents: Data()))
switch diskFormat {
case .raw:
_ = try DiskImage(creating: .raw(url: vmDir.diskURL, blockCount: 8))
case .asif:
_ = try DiskImage(creating: .asif(url: vmDir.diskURL, blockCount: 8, blockSize: .bytes512))
}
let diskChunk = OCIManifestLayer(
mediaType: diskV2MediaType,
size: 1,
digest: "sha256:transport",
uncompressedSize: 4096,
uncompressedContentDigest: "sha256:chunk"
)
let manifest = OCIManifest(
config: OCIManifestConfig(size: 1, digest: "sha256:oci-config"),
layers: [
OCIManifestLayer(mediaType: configMediaType, size: 1, digest: "sha256:config"),
diskChunk,
OCIManifestLayer(mediaType: nvramMediaType, size: 1, digest: "sha256:nvram"),
]
)
try manifest.toJSON().write(to: vmDir.manifestURL)
return vmDir
}
private func temporaryContentStore() throws -> ContentStore {
let url = try temporaryDirectory()
return try ContentStore(baseURL: url)
}
private func temporaryEntries() throws -> [URL] {
try FileManager.default.contentsOfDirectory(
at: Config().tartTmpDir,
includingPropertiesForKeys: nil
)
}
private func withTemporaryTartHome(_ body: () throws -> Void) throws {
let home = try temporaryDirectory()
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", home.path, 1)
defer {
if let previousHome {
setenv("TART_HOME", previousHome, 1)
} else {
unsetenv("TART_HOME")
}
}
try body()
}
private func temporaryVMDirectory() throws -> VMDirectory {
VMDirectory(baseURL: try temporaryDirectory())
}
private func temporaryDirectory() throws -> URL {
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false)
addTeardownBlock {
try? FileManager.default.removeItem(at: url)
}
return url
}
}
#endif
@@ -0,0 +1,154 @@
import Foundation
import XCTest
@testable import tart
final class VMDirectoryLayoutTests: XCTestCase {
func testStandaloneLayoutWithPinnedManifest() throws {
let vmDir = try temporaryVMDirectory()
try touch(vmDir.configURL)
try touch(vmDir.nvramURL)
try touch(vmDir.diskURL)
try touch(vmDir.manifestURL)
XCTAssertEqual(vmDir.layout, .standalone)
XCTAssertTrue(vmDir.initialized)
XCTAssertTrue(vmDir.isCachedImage)
XCTAssertNoThrow(try vmDir.validateCachedImage(userFriendlyName: "standalone"))
}
func testStackedVMLayout() throws {
let vmDir = try temporaryVMDirectory()
try touch(vmDir.configURL)
try touch(vmDir.nvramURL)
try touch(vmDir.manifestURL)
try touch(vmDir.overlayURL)
XCTAssertEqual(vmDir.layout, .stackedLocal)
XCTAssertTrue(vmDir.initialized)
XCTAssertFalse(vmDir.isCachedImage)
}
func testStackedCachedImageLayout() throws {
let vmDir = try temporaryVMDirectory()
try touch(vmDir.configURL)
try touch(vmDir.nvramURL)
try touch(vmDir.manifestURL)
XCTAssertEqual(vmDir.layout, .stackedOCIRecord)
XCTAssertFalse(vmDir.initialized)
XCTAssertTrue(vmDir.isCachedImage)
XCTAssertNoThrow(try vmDir.validateCachedImage(userFriendlyName: "stacked"))
}
func testAmbiguousDiskAndOverlayIsNotInitialized() throws {
let vmDir = try temporaryVMDirectory()
try touch(vmDir.configURL)
try touch(vmDir.nvramURL)
try touch(vmDir.diskURL)
try touch(vmDir.manifestURL)
try touch(vmDir.overlayURL)
XCTAssertNil(vmDir.layout)
XCTAssertFalse(vmDir.initialized)
XCTAssertFalse(vmDir.isCachedImage)
}
func testStackedVMAccountingUsesOverlay() throws {
let vmDir = try temporaryVMDirectory()
try Data("config".utf8).write(to: vmDir.configURL)
try Data("nvram".utf8).write(to: vmDir.nvramURL)
try Data("overlay".utf8).write(to: vmDir.overlayURL)
try stackedManifest(blockSize: 512, blockCount: 8).toJSON().write(to: vmDir.manifestURL)
XCTAssertEqual(
try vmDir.sizeBytes(),
try vmDir.configURL.sizeBytes() + vmDir.overlayURL.sizeBytes() + vmDir.nvramURL.sizeBytes()
)
XCTAssertEqual(
try vmDir.allocatedSizeBytes(),
try vmDir.configURL.allocatedSizeBytes() + vmDir.overlayURL.allocatedSizeBytes() + vmDir.nvramURL.allocatedSizeBytes()
)
}
func testStackedCachedImageAccountingUsesManifestBlockLayout() throws {
let vmDir = try temporaryVMDirectory()
try Data("config".utf8).write(to: vmDir.configURL)
try Data("nvram".utf8).write(to: vmDir.nvramURL)
try stackedManifest(blockSize: 512, blockCount: 8).toJSON().write(to: vmDir.manifestURL)
XCTAssertEqual(
try vmDir.sizeBytes(),
try vmDir.configURL.sizeBytes() + vmDir.nvramURL.sizeBytes()
)
XCTAssertEqual(
try vmDir.allocatedSizeBytes(),
try vmDir.configURL.allocatedSizeBytes() + vmDir.nvramURL.allocatedSizeBytes()
)
XCTAssertEqual(try vmDir.diskSizeBytes(), 4096)
}
func testStackedArchiveRequiresMacOS27() throws {
if #available(macOS 27.0, *) {
throw XCTSkip("macOS 26 compatibility test")
}
let vmDir = try temporaryVMDirectory()
try Data("config".utf8).write(to: vmDir.configURL)
try Data("nvram".utf8).write(to: vmDir.nvramURL)
try Data("overlay".utf8).write(to: vmDir.overlayURL)
try stackedManifest(blockSize: 512, blockCount: 8).toJSON().write(to: vmDir.manifestURL)
let archiveURL = try temporaryVMDirectory().baseURL.appendingPathComponent("stacked.tvm")
XCTAssertThrowsError(try vmDir.exportToArchive(path: archiveURL.path)) { error in
guard case DiskImageStackError.unavailable = error else {
return XCTFail("unexpected error: \(error)")
}
}
XCTAssertFalse(FileManager.default.fileExists(atPath: archiveURL.path))
}
private func temporaryVMDirectory() throws -> VMDirectory {
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false)
addTeardownBlock {
try? FileManager.default.removeItem(at: url)
}
return VMDirectory(baseURL: url)
}
private func touch(_ url: URL) throws {
XCTAssertTrue(FileManager.default.createFile(atPath: url.path, contents: Data()))
}
private func stackedManifest(blockSize: UInt64, blockCount: UInt64) -> OCIManifest {
var disk = OCIManifestLayer(
mediaType: diskV2MediaType,
size: 1,
digest: "sha256:transport",
uncompressedSize: blockSize * blockCount,
uncompressedContentDigest: "sha256:chunk"
)
disk.annotations?[diskFileContentDigestAnnotation] = "sha256:base"
var manifest = OCIManifest(
config: OCIManifestConfig(size: 1, digest: "sha256:oci-config"),
layers: [
OCIManifestLayer(mediaType: configMediaType, size: 1, digest: "sha256:config"),
disk,
OCIManifestLayer(mediaType: nvramMediaType, size: 1, digest: "sha256:nvram"),
]
)
manifest.annotations = [
uncompressedDiskSizeAnnotation: String(blockSize * blockCount),
diskBlockSizeAnnotation: String(blockSize),
]
return manifest
}
}
+974
View File
@@ -0,0 +1,974 @@
import Foundation
import XCTest
@testable import tart
#if canImport(DiskImageKit)
import DiskImageKit
#endif
final class VMStorageOCITests: XCTestCase {
func testPopulateStandalonePushedImageCachesDiskAndManifest() throws {
try withTemporaryTartHome {
let source = try standaloneSource(diskData: Data("disk".utf8))
let manifest = try flatManifest()
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
try storage.populate(name, from: source, manifest: manifest)
let cached = try storage.open(name)
XCTAssertTrue(cached.isStandalone)
XCTAssertEqual(try Data(contentsOf: cached.diskURL), Data("disk".utf8))
XCTAssertEqual(try OCIManifest(fromJSON: Data(contentsOf: cached.manifestURL)), manifest)
}
}
func testStackedCloneRequiresManifestForLegacyStandaloneCachedImage() throws {
try withTemporaryTartHome {
let manifest = try flatManifest()
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
let record = try storage.create(name)
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(atPath: record.diskURL.path, contents: Data()))
XCTAssertTrue(try storage.hasUsableCachedImageForClone(name))
XCTAssertFalse(try storage.hasUsableCachedImageForClone(name, requireManifest: true))
XCTAssertTrue(try storage.hasCompleteCachedImage(name, manifest: manifest))
XCTAssertFalse(try storage.hasCompleteCachedImage(name, manifest: manifest, requireManifest: true))
}
}
func testCloneCacheCheckRejectsMissingOrWrongSizedStackedContent() throws {
try withTemporaryTartHome {
let baseData = Data("base".utf8)
let overlayData = Data("overlay".utf8)
let baseDigest = Digest.hash(baseData)
let overlayDigest = Digest.hash(overlayData)
let manifest = try stackedManifest(
baseContentDigest: baseDigest,
overlayContentDigest: overlayDigest,
baseUncompressedSize: UInt64(baseData.count),
overlayUncompressedSize: UInt64(overlayData.count)
)
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
let record = try storage.create(name)
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: record.manifestURL)
XCTAssertFalse(try storage.hasUsableCachedImageForClone(name))
let contentStore = try ContentStore()
try installContent(baseData, contentDigest: baseDigest, into: contentStore)
try installContent(overlayData, contentDigest: overlayDigest, into: contentStore)
XCTAssertTrue(try storage.hasUsableCachedImageForClone(name))
try Data("bad".utf8).write(to: try contentStore.contentURL(for: overlayDigest))
XCTAssertFalse(try storage.hasUsableCachedImageForClone(name))
}
}
func testListIncludesStackedCachedImage() throws {
try withTemporaryTartHome {
let manifest = try stackedManifest()
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
let record = try storage.create(name)
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: record.manifestURL)
XCTAssertTrue(try storage.list().contains { $0.0 == name.description })
XCTAssertEqual(try record.diskSizeBytes(), 4096)
XCTAssertNoThrow(try record.allocatedSizeBytes())
}
}
func testStackedCacheHitRequiresExpectedContentSizes() throws {
try withTemporaryTartHome {
let baseData = Data(repeating: 0x41, count: 10)
let overlayData = Data(repeating: 0x42, count: 20)
let baseDigest = Digest.hash(baseData)
let overlayDigest = Digest.hash(overlayData)
let manifest = try stackedManifest(
baseContentDigest: baseDigest,
overlayContentDigest: overlayDigest,
baseUncompressedSize: 10,
overlayUncompressedSize: 20
)
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
let record = try storage.create(name)
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: record.manifestURL)
XCTAssertFalse(try storage.hasCompleteCachedImage(name, manifest: manifest))
XCTAssertEqual(try storage.requiredDiskStorageBytes(for: manifest), 30)
let contentStore = try ContentStore()
try installContent(baseData, contentDigest: baseDigest, into: contentStore)
XCTAssertFalse(try storage.hasCompleteCachedImage(name, manifest: manifest))
XCTAssertEqual(try storage.requiredDiskStorageBytes(for: manifest), 20)
try installContent(overlayData, contentDigest: overlayDigest, into: contentStore)
XCTAssertTrue(try storage.hasCompleteCachedImage(name, manifest: manifest))
XCTAssertEqual(try storage.requiredDiskStorageBytes(for: manifest), 0)
let overlayURL = try contentStore.contentURL(for: overlayDigest)
try Data("corrupt".utf8).write(to: overlayURL)
XCTAssertFalse(try storage.hasCompleteCachedImage(name, manifest: manifest))
XCTAssertEqual(try storage.requiredDiskStorageBytes(for: manifest), 20)
}
}
func testStackedPullReusesPreviouslyPulledStandaloneDisk() throws {
try withTemporaryTartHome {
let diskData = Data([0])
let contentDigest = Digest.hash(diskData)
let flatManifest = try flatManifest()
let flatName = try digestName(for: flatManifest)
let storage = try VMStorageOCI()
let flatRecord = try storage.create(flatName)
try config().save(toURL: flatRecord.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: flatRecord.nvramURL.path, contents: Data()))
try diskData.write(to: flatRecord.diskURL)
try flatManifest.toJSON().write(to: flatRecord.manifestURL)
let stackedManifest = try stackedManifest(baseContentDigest: contentDigest)
XCTAssertNil(try ContentStore().existingContentURL(for: contentDigest))
try storage.reuseStandaloneDiskForStackedBaseIfPossible(stackedManifest)
let reusedURL = try XCTUnwrap(try ContentStore().existingContentURL(for: contentDigest))
XCTAssertEqual(try Data(contentsOf: reusedURL), diskData)
}
}
func testStackedPullDoesNotRehashInstalledBaseBeforeReuse() throws {
try withTemporaryTartHome {
let contentDigest = Digest.hash(Data("base".utf8))
let manifest = try stackedManifest(baseContentDigest: contentDigest)
let contentURL = try ContentStore().contentURL(for: contentDigest)
// Hashing this path would throw. Once an entry is published, this
// fast path must trust its presence and let normal pull validation
// repair unusable content later.
try FileManager.default.createDirectory(at: contentURL, withIntermediateDirectories: false)
XCTAssertNoThrow(try VMStorageOCI().reuseStandaloneDiskForStackedBaseIfPossible(manifest))
}
}
func testNewTagDoesNotValidateCachedStackBeforeLock() throws {
try withTemporaryTartHome {
let baseDigest = Digest.hash(Data("base".utf8))
let overlayDigest = Digest.hash(Data("overlay".utf8))
let manifest = try stackedManifest(
baseContentDigest: baseDigest,
overlayContentDigest: overlayDigest
)
let digestName = try digestName(for: manifest)
let tagName = RemoteName(
host: digestName.host,
namespace: digestName.namespace,
reference: Reference(tag: "latest")
)
let storage = try VMStorageOCI()
let record = try storage.create(digestName)
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: record.manifestURL)
// Hashing this directory as a disk file throws. A new tag must skip
// validation until after it has taken the host lock.
let contentURL = try ContentStore().contentURL(for: baseDigest)
try FileManager.default.createDirectory(at: contentURL, withIntermediateDirectories: false)
XCTAssertFalse(try storage.hasCompleteLinkedImage(tagName, digestName: digestName, manifest: manifest))
}
}
func testStandaloneLayerCacheIgnoresStackedCachedImages() async throws {
try await withTemporaryTartHome {
var targetManifest = try flatManifest()
var stackedCandidateManifest = try stackedManifest()
let sharedDiskSize = 2 * 1024 * 1024 * 1024
targetManifest.layers[1].size = sharedDiskSize
stackedCandidateManifest.layers[1] = targetManifest.layers[1]
let candidateName = try digestName(for: stackedCandidateManifest)
let storage = try VMStorageOCI()
let candidate = try storage.create(candidateName)
try config().save(toURL: candidate.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: candidate.nvramURL.path, contents: Data()))
try stackedCandidateManifest.toJSON().write(to: candidate.manifestURL)
let targetName = RemoteName(
host: "example.com",
namespace: "org/target",
reference: Reference(digest: try targetManifest.digest())
)
let registry = try Registry(host: targetName.host, namespace: targetName.namespace)
let layerCache = try await storage.chooseLocalLayerCache(targetName, targetManifest, registry)
XCTAssertNil(layerCache)
}
}
func testGCPrunesOnlyUnreferencedContent() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let referenced = try installContent(Data("referenced".utf8), into: contentStore)
let unreferenced = try installContent(Data("unreferenced".utf8), into: contentStore)
let stacked = try VMStorageLocal().create("stacked")
try config().save(toURL: stacked.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: stacked.nvramURL.path, contents: Data()))
XCTAssertTrue(FileManager.default.createFile(atPath: stacked.overlayURL.path, contents: Data()))
try pinnedBaseManifest(contentDigest: referenced.digest).toJSON().write(to: stacked.manifestURL)
try VMStorageOCI().gc()
XCTAssertTrue(FileManager.default.fileExists(atPath: referenced.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: unreferenced.url.path))
}
}
func testGCPrunesContentWithoutOCIStorageDirectory() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let unreferenced = try installContent(Data("unreferenced".utf8), into: contentStore)
let storage = try VMStorageOCI()
XCTAssertFalse(FileManager.default.fileExists(atPath: storage.baseURL.path))
try storage.gc()
XCTAssertFalse(FileManager.default.fileExists(atPath: unreferenced.url.path))
}
}
func testGCDoesNotPruneContentReferencedByInProgressManifest() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let referenced = try installContent(Data("in-progress".utf8), into: contentStore)
let temporaryVMDir = try VMDirectory.temporary()
// Pull and clone publish the manifest before config, NVRAM, or a
// writable overlay necessarily exist.
try pinnedBaseManifest(contentDigest: referenced.digest).toJSON().write(to: temporaryVMDir.manifestURL)
try VMStorageOCI().gc()
XCTAssertTrue(FileManager.default.fileExists(atPath: referenced.url.path))
}
}
func testStalePrunableDoesNotDeleteNewlyReferencedContent() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let content = try installContent(Data("new-reference".utf8), into: contentStore)
let storage = try VMStorageOCI()
let candidate = try XCTUnwrap(storage.prunables().first {
$0.url.resolvingSymlinksInPath() == content.url.resolvingSymlinksInPath()
})
// Simulate a clone or pull publishing its manifest after prune built
// the candidate list but before deletion starts.
let temporaryVMDir = try VMDirectory.temporary()
try contentStore.withPruneLock {
try pinnedBaseManifest(contentDigest: content.digest).toJSON().write(to: temporaryVMDir.manifestURL)
}
try candidate.delete()
XCTAssertTrue(FileManager.default.fileExists(atPath: content.url.path))
}
}
func testVMDirectoryDeletionOfStackedOCIRecordWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let record = try createRecord(for: stackedManifest(), in: storage)
try assertDeletionWaitsForPruneLock(record: record) {
try record.delete()
}
}
}
func testStorageDeletionOfStackedOCIRecordWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let manifest = try stackedManifest()
let name = try digestName(for: manifest)
let record = try createRecord(for: manifest, in: storage)
try assertDeletionWaitsForPruneLock(record: record) {
try storage.delete(name)
}
}
}
func testStorageDeletionOfIncompleteManifestRecordWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let name = RemoteName(
host: "example.com",
namespace: "org/image",
reference: Reference(digest: "sha256:incomplete")
)
let record = try storage.create(name)
try Data("{}".utf8).write(to: record.manifestURL)
try assertDeletionWaitsForPruneLock(record: record) {
try storage.delete(name)
}
}
}
func testVMDirectoryDeletionOfUnpublishedRecordWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let record = try storage.create(RemoteName(
host: "example.com",
namespace: "org/image",
reference: Reference(digest: "sha256:unpublished")
))
try assertDeletionWaitsForPruneLock(record: record) {
try record.removeFromDisk()
}
}
}
func testTagReplacementWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let firstManifest = try stackedManifest(baseContentDigest: "sha256:first")
let secondManifest = try stackedManifest(baseContentDigest: "sha256:second")
let firstName = try digestName(for: firstManifest)
let secondName = try digestName(for: secondManifest)
_ = try createRecord(for: firstManifest, in: storage)
_ = try createRecord(for: secondManifest, in: storage)
let tagName = RemoteName(
host: secondName.host,
namespace: secondName.namespace,
reference: Reference(tag: "latest")
)
let contentStore = try ContentStore()
let lockHeld = DispatchSemaphore(value: 0)
let releaseLock = DispatchSemaphore(value: 0)
let replacementStarted = DispatchSemaphore(value: 0)
let replacementFinished = DispatchSemaphore(value: 0)
DispatchQueue.global().async {
try? contentStore.withPruneLock {
lockHeld.signal()
releaseLock.wait()
}
}
XCTAssertEqual(lockHeld.wait(timeout: .now() + 1), .success)
DispatchQueue.global().async {
replacementStarted.signal()
try? storage.link(from: tagName, to: secondName)
replacementFinished.signal()
}
XCTAssertEqual(replacementStarted.wait(timeout: .now() + 1), .success)
XCTAssertEqual(replacementFinished.wait(timeout: .now() + 0.1), .timedOut)
releaseLock.signal()
XCTAssertEqual(replacementFinished.wait(timeout: .now() + 1), .success)
XCTAssertTrue(storage.linked(from: tagName, to: secondName))
XCTAssertFalse(storage.linked(from: tagName, to: firstName))
}
}
func testGCDeletionOfStackedOCIRecordWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let record = try createRecord(for: stackedManifest(), in: storage)
try assertDeletionWaitsForPruneLock(record: record) {
try storage.gc()
}
}
}
func testTemporaryManifestGCWaitsForPruneLock() throws {
try withTemporaryTartHome {
let temporaryVMDir = try VMDirectory.temporary()
try stackedManifest().toJSON().write(to: temporaryVMDir.manifestURL)
try assertDeletionWaitsForPruneLock(record: temporaryVMDir) {
try Config().gc()
}
}
}
func testLockedTemporaryDirectorySurvivesGarbageCollection() throws {
try withTemporaryTartHome {
let temporaryVMDir = try VMDirectory.temporary()
let lock = try FileLock(lockURL: temporaryVMDir.baseURL)
try lock.lock()
try Config().gc()
XCTAssertTrue(FileManager.default.fileExists(atPath: temporaryVMDir.baseURL.path))
try lock.unlock()
try Config().gc()
XCTAssertFalse(FileManager.default.fileExists(atPath: temporaryVMDir.baseURL.path))
}
}
func testMovingStackedOCIRecordWaitsForPruneLock() throws {
try withTemporaryTartHome {
let storage = try VMStorageOCI()
let source = try temporaryVMDirectory()
let manifest = try stackedManifest()
let name = try digestName(for: manifest)
try config().save(toURL: source.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: source.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: source.manifestURL)
let contentStore = try ContentStore()
let lockHeld = DispatchSemaphore(value: 0)
let releaseLock = DispatchSemaphore(value: 0)
let moveStarted = DispatchSemaphore(value: 0)
let moveFinished = DispatchSemaphore(value: 0)
DispatchQueue.global().async {
try? contentStore.withPruneLock {
lockHeld.signal()
releaseLock.wait()
}
}
XCTAssertEqual(lockHeld.wait(timeout: .now() + 1), .success)
DispatchQueue.global().async {
moveStarted.signal()
try? storage.move(name, from: source)
moveFinished.signal()
}
XCTAssertEqual(moveStarted.wait(timeout: .now() + 1), .success)
XCTAssertEqual(moveFinished.wait(timeout: .now() + 0.1), .timedOut)
XCTAssertTrue(FileManager.default.fileExists(atPath: source.baseURL.path))
releaseLock.signal()
XCTAssertEqual(moveFinished.wait(timeout: .now() + 1), .success)
XCTAssertFalse(FileManager.default.fileExists(atPath: source.baseURL.path))
XCTAssertTrue(try storage.open(name).isStackedCachedImage)
}
}
func testPruningLastStackedOCIRecordReclaimsItsContent() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let baseContent = try installContent(Data("record-only-base".utf8), into: contentStore)
let overlayContent = try installContent(Data("record-only-overlay".utf8), into: contentStore)
let manifest = try stackedManifest(
baseContentDigest: baseContent.digest,
overlayContentDigest: overlayContent.digest,
baseUncompressedSize: UInt64(try baseContent.url.sizeBytes()),
overlayUncompressedSize: UInt64(try overlayContent.url.sizeBytes())
)
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
let record = try storage.create(name)
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: record.manifestURL)
let candidate = try XCTUnwrap(storage.prunables().first {
$0.url.lastPathComponent == record.url.lastPathComponent
})
XCTAssertGreaterThanOrEqual(
try candidate.allocatedSizeBytes(),
try baseContent.url.allocatedSizeBytes() + overlayContent.url.allocatedSizeBytes()
)
// The record itself fits in this budget, so pruning only succeeds if it
// accounts for the immutable content released with the final reference.
try Prune.pruneSpaceBudget(
prunableStorages: [storage],
spaceBudgetBytes: UInt64(try record.allocatedSizeBytes())
)
XCTAssertFalse(FileManager.default.fileExists(atPath: record.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: baseContent.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: overlayContent.url.path))
}
}
func testMalformedStackedOCIRecordDoesNotBlockPruning() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let baseContent = try installContent(Data("valid-base".utf8), into: contentStore)
let overlayContent = try installContent(Data("valid-overlay".utf8), into: contentStore)
let storage = try VMStorageOCI()
let validRecord = try createRecord(for: stackedManifest(
baseContentDigest: baseContent.digest,
overlayContentDigest: overlayContent.digest,
baseUncompressedSize: UInt64(try baseContent.url.sizeBytes()),
overlayUncompressedSize: UInt64(try overlayContent.url.sizeBytes())
), in: storage)
let malformedRecord = try storage.create(RemoteName(
host: "example.com",
namespace: "org/image",
reference: Reference(digest: "sha256:malformed")
))
try config().save(toURL: malformedRecord.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: malformedRecord.nvramURL.path, contents: Data()))
try Data("{".utf8).write(to: malformedRecord.manifestURL)
XCTAssertNoThrow(try storage.prunables())
try Prune.pruneSpaceBudget(prunableStorages: [storage], spaceBudgetBytes: 0)
XCTAssertFalse(FileManager.default.fileExists(atPath: validRecord.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: malformedRecord.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: baseContent.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: overlayContent.url.path))
}
}
func testPruningOneStackedOCIRecordPreservesSharedContent() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let baseContent = try installContent(Data("shared-base".utf8), into: contentStore)
let firstOverlay = try installContent(Data("first-overlay".utf8), into: contentStore)
let secondOverlay = try installContent(Data("second-overlay".utf8), into: contentStore)
let storage = try VMStorageOCI()
let firstManifest = try stackedManifest(
baseContentDigest: baseContent.digest,
overlayContentDigest: firstOverlay.digest,
baseUncompressedSize: UInt64(try baseContent.url.sizeBytes()),
overlayUncompressedSize: UInt64(try firstOverlay.url.sizeBytes())
)
let secondManifest = try stackedManifest(
baseContentDigest: baseContent.digest,
overlayContentDigest: secondOverlay.digest,
baseUncompressedSize: UInt64(try baseContent.url.sizeBytes()),
overlayUncompressedSize: UInt64(try secondOverlay.url.sizeBytes())
)
let firstRecord = try createRecord(for: firstManifest, in: storage)
let secondRecord = try createRecord(for: secondManifest, in: storage)
let firstCandidate = try XCTUnwrap(storage.prunables().first {
$0.url.lastPathComponent == firstRecord.url.lastPathComponent
})
try firstCandidate.delete()
XCTAssertTrue(FileManager.default.fileExists(atPath: baseContent.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: firstOverlay.url.path))
XCTAssertTrue(FileManager.default.fileExists(atPath: secondOverlay.url.path))
let secondCandidate = try XCTUnwrap(storage.prunables().first {
$0.url.lastPathComponent == secondRecord.url.lastPathComponent
})
try secondCandidate.delete()
XCTAssertFalse(FileManager.default.fileExists(atPath: baseContent.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: secondOverlay.url.path))
}
}
func testSpaceBudgetRecomputesSharedContentAfterOwnerDeletion() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let baseContent = try installContent(Data("shared-base".utf8), into: contentStore)
let firstOverlay = try installContent(Data("first-overlay".utf8), into: contentStore)
let secondOverlay = try installContent(Data("second-overlay".utf8), into: contentStore)
let storage = try VMStorageOCI()
let firstManifest = try stackedManifest(
baseContentDigest: baseContent.digest,
overlayContentDigest: firstOverlay.digest,
baseUncompressedSize: UInt64(try baseContent.url.sizeBytes()),
overlayUncompressedSize: UInt64(try firstOverlay.url.sizeBytes())
)
let secondManifest = try stackedManifest(
baseContentDigest: baseContent.digest,
overlayContentDigest: secondOverlay.digest,
baseUncompressedSize: UInt64(try baseContent.url.sizeBytes()),
overlayUncompressedSize: UInt64(try secondOverlay.url.sizeBytes())
)
let olderRecord = try createRecord(for: firstManifest, in: storage)
let newerRecord = try createRecord(for: secondManifest, in: storage)
try olderRecord.url.updateAccessDate(Date(timeIntervalSince1970: 1))
try newerRecord.url.updateAccessDate(Date(timeIntervalSince1970: 2))
let olderCandidate = try XCTUnwrap(storage.prunables().first {
$0.url.lastPathComponent == olderRecord.url.lastPathComponent
})
let budget = UInt64(try olderCandidate.allocatedSizeBytes())
// On the first pass the newer record owns the shared base and is
// selected for deletion, while the older record fits this budget.
// Recomputing must then charge the surviving record for the base and
// prune it too.
try Prune.pruneSpaceBudget(
prunableStorages: [storage],
spaceBudgetBytes: budget
)
XCTAssertFalse(FileManager.default.fileExists(atPath: olderRecord.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: newerRecord.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: baseContent.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: firstOverlay.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: secondOverlay.url.path))
}
}
func testSpaceBudgetRecomputesBeforeDeletingAnotherCandidate() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let sharedBase = try installContent(Data(repeating: 0x41, count: 128 * 1024), into: contentStore)
let newestOverlay = try installContent(Data("newest-overlay".utf8), into: contentStore)
let middleOverlay = try installContent(Data("middle-overlay".utf8), into: contentStore)
let retainedBase = try installContent(Data(repeating: 0x42, count: 32 * 1024), into: contentStore)
let retainedOverlay = try installContent(Data("retained-overlay".utf8), into: contentStore)
let storage = try VMStorageOCI()
let newest = try createRecord(for: stackedManifest(
baseContentDigest: sharedBase.digest,
overlayContentDigest: newestOverlay.digest,
baseUncompressedSize: UInt64(try sharedBase.url.sizeBytes()),
overlayUncompressedSize: UInt64(try newestOverlay.url.sizeBytes())
), in: storage)
let middle = try createRecord(for: stackedManifest(
baseContentDigest: sharedBase.digest,
overlayContentDigest: middleOverlay.digest,
baseUncompressedSize: UInt64(try sharedBase.url.sizeBytes()),
overlayUncompressedSize: UInt64(try middleOverlay.url.sizeBytes())
), in: storage)
let retained = try createRecord(for: stackedManifest(
baseContentDigest: retainedBase.digest,
overlayContentDigest: retainedOverlay.digest,
baseUncompressedSize: UInt64(try retainedBase.url.sizeBytes()),
overlayUncompressedSize: UInt64(try retainedOverlay.url.sizeBytes())
), in: storage)
try newest.url.updateAccessDate(Date(timeIntervalSince1970: 3))
try middle.url.updateAccessDate(Date(timeIntervalSince1970: 2))
try retained.url.updateAccessDate(Date(timeIntervalSince1970: 1))
let retainedCandidate = try XCTUnwrap(storage.prunables().first {
$0.url.lastPathComponent == retained.url.lastPathComponent
})
// Initially the newest record owns the shared base and is too large.
// The middle record appears small enough to retain, making the oldest
// unrelated record look like a second deletion candidate. After the
// first deletion, ownership moves to the middle record; recomputing
// before selecting again must delete it and preserve the unrelated one.
try Prune.pruneSpaceBudget(
prunableStorages: [storage],
spaceBudgetBytes: UInt64(try retainedCandidate.allocatedSizeBytes())
)
XCTAssertFalse(FileManager.default.fileExists(atPath: newest.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: middle.url.path))
XCTAssertTrue(FileManager.default.fileExists(atPath: retained.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: sharedBase.url.path))
XCTAssertTrue(FileManager.default.fileExists(atPath: retainedBase.url.path))
XCTAssertTrue(FileManager.default.fileExists(atPath: retainedOverlay.url.path))
}
}
func testAutomaticReclaimRecomputesSharedContentAfterOwnerDeletion() throws {
try withTemporaryTartHome {
let contentStore = try ContentStore()
let sharedBase = try installContent(Data(repeating: 0x41, count: 128 * 1024), into: contentStore)
let initiatorOverlay = try installContent(Data("initiator-overlay".utf8), into: contentStore)
let ownerOverlay = try installContent(Data("owner-overlay".utf8), into: contentStore)
let unrelatedBase = try installContent(Data("unrelated-base".utf8), into: contentStore)
let unrelatedOverlay = try installContent(Data("unrelated-overlay".utf8), into: contentStore)
let storage = try VMStorageOCI()
let initiatorManifest = try stackedManifest(
baseContentDigest: sharedBase.digest,
overlayContentDigest: initiatorOverlay.digest,
baseUncompressedSize: UInt64(try sharedBase.url.sizeBytes()),
overlayUncompressedSize: UInt64(try initiatorOverlay.url.sizeBytes())
)
let ownerManifest = try stackedManifest(
baseContentDigest: sharedBase.digest,
overlayContentDigest: ownerOverlay.digest,
baseUncompressedSize: UInt64(try sharedBase.url.sizeBytes()),
overlayUncompressedSize: UInt64(try ownerOverlay.url.sizeBytes())
)
let unrelatedManifest = try stackedManifest(
baseContentDigest: unrelatedBase.digest,
overlayContentDigest: unrelatedOverlay.digest,
baseUncompressedSize: UInt64(try unrelatedBase.url.sizeBytes()),
overlayUncompressedSize: UInt64(try unrelatedOverlay.url.sizeBytes())
)
let initiator = try createRecord(for: initiatorManifest, in: storage)
let owner = try createRecord(for: ownerManifest, in: storage)
let unrelated = try createRecord(for: unrelatedManifest, in: storage)
try initiator.url.updateAccessDate(Date(timeIntervalSince1970: 1))
try owner.url.updateAccessDate(Date(timeIntervalSince1970: 2))
try unrelated.url.updateAccessDate(Date(timeIntervalSince1970: 3))
let sharedBaseSize = UInt64(try sharedBase.url.allocatedSizeBytes())
// The owner is the first deletable record and is initially charged for
// the shared base. Deleting it cannot reclaim that base because the
// protected initiator still references it, so reclaim must continue.
try Prune.reclaimIfPossible(sharedBaseSize, initiator)
XCTAssertTrue(FileManager.default.fileExists(atPath: initiator.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: owner.url.path))
XCTAssertFalse(FileManager.default.fileExists(atPath: unrelated.url.path))
XCTAssertTrue(FileManager.default.fileExists(atPath: sharedBase.url.path))
}
}
#if canImport(DiskImageKit)
@available(macOS 27.0, *)
func testPopulateStackedPushedImageCachesImmutableTopOverlay() throws {
if #unavailable(macOS 27.0) {
throw XCTSkip("DiskImageKit tests require macOS 27 or newer")
}
try withTemporaryTartHome {
let source = try diskImageSource()
let stacked = try temporaryVMDirectory()
try source.cloneAsStackedBase(to: stacked, generateMAC: false)
var manifest = try OCIManifest(fromJSON: Data(contentsOf: stacked.manifestURL))
let contentDigest = try Digest.hash(stacked.overlayURL)
var overlay = OCIManifestLayer(
mediaType: asifOverlayMediaType,
size: 1,
digest: "sha256:overlay-transport",
uncompressedSize: 1,
uncompressedContentDigest: "sha256:overlay-chunk"
)
overlay.annotations?[diskFileContentDigestAnnotation] = contentDigest
overlay.annotations?[diskFileChunkCountAnnotation] = "1"
manifest.layers.insert(overlay, at: manifest.layers.count - 1)
let name = try digestName(for: manifest)
let storage = try VMStorageOCI()
try storage.populate(name, from: stacked, manifest: manifest)
let cached = try storage.open(name)
XCTAssertTrue(cached.isStackedCachedImage)
XCTAssertFalse(FileManager.default.fileExists(atPath: cached.overlayURL.path))
XCTAssertEqual(try OCIManifest(fromJSON: Data(contentsOf: cached.manifestURL)), manifest)
let cachedContent = try XCTUnwrap(try ContentStore().existingContentURL(for: contentDigest))
XCTAssertEqual(try Digest.hash(cachedContent), contentDigest)
}
}
#endif
private func standaloneSource(diskData: Data) throws -> VMDirectory {
let vmDir = try temporaryVMDirectory()
try config().save(toURL: vmDir.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.nvramURL.path, contents: Data()))
try diskData.write(to: vmDir.diskURL)
return vmDir
}
private func createRecord(for manifest: OCIManifest, in storage: VMStorageOCI) throws -> VMDirectory {
let record = try storage.create(try digestName(for: manifest))
try config().save(toURL: record.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: record.nvramURL.path, contents: Data()))
try manifest.toJSON().write(to: record.manifestURL)
return record
}
private func assertDeletionWaitsForPruneLock(
record: VMDirectory,
deletion: @escaping () throws -> Void
) throws {
let contentStore = try ContentStore()
let lockHeld = DispatchSemaphore(value: 0)
let releaseLock = DispatchSemaphore(value: 0)
let deletionStarted = DispatchSemaphore(value: 0)
let deletionFinished = DispatchSemaphore(value: 0)
DispatchQueue.global().async {
try? contentStore.withPruneLock {
lockHeld.signal()
releaseLock.wait()
}
}
XCTAssertEqual(lockHeld.wait(timeout: .now() + 1), .success)
DispatchQueue.global().async {
deletionStarted.signal()
try? deletion()
deletionFinished.signal()
}
XCTAssertEqual(deletionStarted.wait(timeout: .now() + 1), .success)
XCTAssertEqual(deletionFinished.wait(timeout: .now() + 0.1), .timedOut)
XCTAssertTrue(FileManager.default.fileExists(atPath: record.baseURL.path))
releaseLock.signal()
XCTAssertEqual(deletionFinished.wait(timeout: .now() + 1), .success)
XCTAssertFalse(FileManager.default.fileExists(atPath: record.baseURL.path))
}
#if canImport(DiskImageKit)
@available(macOS 27.0, *)
private func diskImageSource() throws -> VMDirectory {
let vmDir = try temporaryVMDirectory()
try config().save(toURL: vmDir.configURL)
XCTAssertTrue(FileManager.default.createFile(atPath: vmDir.nvramURL.path, contents: Data()))
_ = try DiskImage(creating: .raw(url: vmDir.diskURL, blockCount: 8))
try flatManifest().toJSON().write(to: vmDir.manifestURL)
return vmDir
}
#endif
private func config() -> VMConfig {
VMConfig(
platform: Linux(),
cpuCountMin: 2,
memorySizeMin: 512 * 1024 * 1024,
diskFormat: .raw
)
}
private func flatManifest() throws -> OCIManifest {
let disk = OCIManifestLayer(
mediaType: diskV2MediaType,
size: 1,
digest: "sha256:disk-transport",
uncompressedSize: 1,
uncompressedContentDigest: "sha256:disk-chunk"
)
return OCIManifest(
config: OCIManifestConfig(size: 1, digest: "sha256:oci-config"),
layers: [
OCIManifestLayer(mediaType: configMediaType, size: 1, digest: "sha256:config"),
disk,
OCIManifestLayer(mediaType: nvramMediaType, size: 1, digest: "sha256:nvram"),
]
)
}
private func stackedManifest(
baseContentDigest: String = "sha256:base",
overlayContentDigest: String = "sha256:overlay",
baseUncompressedSize: UInt64 = 1,
overlayUncompressedSize: UInt64 = 1
) throws -> OCIManifest {
var manifest = try flatManifest()
manifest.annotations?[diskBlockSizeAnnotation] = "512"
manifest.annotations?[uncompressedDiskSizeAnnotation] = "4096"
manifest.layers[1].annotations?[diskFileContentDigestAnnotation] = baseContentDigest
manifest.layers[1].annotations?[uncompressedSizeAnnotation] = String(baseUncompressedSize)
var overlay = OCIManifestLayer(
mediaType: asifOverlayMediaType,
size: 1,
digest: "sha256:overlay-transport",
uncompressedSize: overlayUncompressedSize,
uncompressedContentDigest: "sha256:overlay-chunk"
)
overlay.annotations?[diskFileContentDigestAnnotation] = overlayContentDigest
overlay.annotations?[diskFileChunkCountAnnotation] = "1"
manifest.layers.insert(overlay, at: manifest.layers.count - 1)
return manifest
}
private func installContent(_ data: Data, contentDigest: String, into contentStore: ContentStore) throws {
let temporaryURL = try contentStore.temporaryContentURL(for: contentDigest)
try data.write(to: temporaryURL)
_ = try contentStore.install(temporaryURL, contentDigest: contentDigest)
}
private func pinnedBaseManifest(contentDigest: String) -> OCIManifest {
var disk = OCIManifestLayer(
mediaType: diskV2MediaType,
size: 1,
digest: "sha256:disk-transport",
uncompressedSize: 1,
uncompressedContentDigest: "sha256:disk-chunk"
)
disk.annotations?[diskFileContentDigestAnnotation] = contentDigest
return OCIManifest(
config: OCIManifestConfig(size: 1, digest: "sha256:oci-config"),
layers: [
OCIManifestLayer(mediaType: configMediaType, size: 1, digest: "sha256:config"),
disk,
OCIManifestLayer(mediaType: nvramMediaType, size: 1, digest: "sha256:nvram"),
]
)
}
private func installContent(_ data: Data, into contentStore: ContentStore) throws -> (digest: String, url: URL) {
let digest = Digest.hash(data)
let temporaryURL = try contentStore.temporaryContentURL(for: digest)
try data.write(to: temporaryURL)
return (digest, try contentStore.install(temporaryURL, contentDigest: digest))
}
private func digestName(for manifest: OCIManifest) throws -> RemoteName {
RemoteName(
host: "example.com",
namespace: "org/image",
reference: Reference(digest: try manifest.digest())
)
}
private func withTemporaryTartHome(_ body: () throws -> Void) throws {
let home = try temporaryDirectory()
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", home.path, 1)
defer {
if let previousHome {
setenv("TART_HOME", previousHome, 1)
} else {
unsetenv("TART_HOME")
}
}
try body()
}
private func withTemporaryTartHome(_ body: () async throws -> Void) async throws {
let home = try temporaryDirectory()
let previousHome = ProcessInfo.processInfo.environment["TART_HOME"]
setenv("TART_HOME", home.path, 1)
defer {
if let previousHome {
setenv("TART_HOME", previousHome, 1)
} else {
unsetenv("TART_HOME")
}
}
try await body()
}
private func temporaryVMDirectory() throws -> VMDirectory {
VMDirectory(baseURL: try temporaryDirectory())
}
private func temporaryDirectory() throws -> URL {
let url = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false)
addTeardownBlock {
try? FileManager.default.removeItem(at: url)
}
return url
}
}
+26
View File
@@ -22,6 +22,32 @@ You can also enable the debugging output to diagnose issues:
go run cmd/main.go fio --debug
```
To compare an empty Tart home with the same pull after its immutable base has
been prewarmed, provide a standalone remote base image and a stacked image built
from it. For example, create and push a stacked child of the public Tahoe base:
```shell
BASE_IMAGE=ghcr.io/cirruslabs/macos-tahoe-base:latest
STACKED_IMAGE=ghcr.io/your-org/macos-tahoe-stacked:latest
tart clone --stacked "$BASE_IMAGE" macos-tahoe-stacked
tart push macos-tahoe-stacked "$STACKED_IMAGE"
```
Then benchmark that pair:
```shell
go run cmd/main.go stacked-oci \
--base-image "$BASE_IMAGE" \
--image "$STACKED_IMAGE"
```
The command first performs an unmeasured pull to warm registry, CDN, and
filesystem caches. It then uses disposable `TART_HOME` directories for both
measured scenarios. The prewarmed scenario keeps the VM created by
`tart clone --stacked` alive while pulling the child, so the shared immutable
base layer remains referenced and available for reuse.
## Results
### Mar 27, 2024
+2
View File
@@ -2,6 +2,7 @@ package command
import (
"github.com/cirruslabs/tart/benchmark/internal/command/fio"
"github.com/cirruslabs/tart/benchmark/internal/command/stackedoci"
"github.com/cirruslabs/tart/benchmark/internal/command/xcode"
"github.com/spf13/cobra"
)
@@ -15,6 +16,7 @@ func NewCommand() *cobra.Command {
cmd.AddCommand(
fio.NewCommand(),
stackedoci.NewCommand(),
xcode.NewCommand(),
)
@@ -0,0 +1,161 @@
package stackedoci
import (
"context"
"fmt"
"os"
"os/exec"
"strings"
"time"
"github.com/gosuri/uitable"
"github.com/spf13/cobra"
"go.uber.org/zap"
"go.uber.org/zap/zapio"
)
var (
debug bool
baseImage string
stackedImage string
insecure bool
concurrency uint
)
func NewCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "stacked-oci",
Short: "benchmark empty and prewarmed Tart homes for stacked OCI pulls",
Long: "Warm the registry once, then compare an empty Tart home with one whose " +
"immutable base has already been materialized by tart clone --stacked. " +
"Every scenario uses a disposable TART_HOME and leaves the user's Tart home untouched.",
RunE: run,
}
cmd.Flags().BoolVar(&debug, "debug", false, "enable debug logging")
cmd.Flags().StringVar(&baseImage, "base-image", "", "remote flat OCI image used as the stacked image's base")
cmd.Flags().StringVar(&stackedImage, "image", "", "remote stacked OCI image to pull and clone")
cmd.Flags().BoolVar(&insecure, "insecure", false, "connect to the OCI registry via insecure HTTP")
cmd.Flags().UintVar(&concurrency, "concurrency", 4, "network concurrency passed to tart pull and clone")
_ = cmd.MarkFlagRequired("base-image")
_ = cmd.MarkFlagRequired("image")
return cmd
}
func run(cmd *cobra.Command, _ []string) error {
if concurrency < 1 {
return fmt.Errorf("concurrency cannot be less than 1")
}
config := zap.NewProductionConfig()
if debug {
config.Level = zap.NewAtomicLevelAt(zap.DebugLevel)
}
logger, err := config.Build()
if err != nil {
return err
}
defer func() { _ = logger.Sync() }()
warmupHome, err := os.MkdirTemp("", "tart-stacked-oci-warmup-*")
if err != nil {
return err
}
defer os.RemoveAll(warmupHome)
emptyHome, err := os.MkdirTemp("", "tart-stacked-oci-empty-*")
if err != nil {
return err
}
defer os.RemoveAll(emptyHome)
warmHome, err := os.MkdirTemp("", "tart-stacked-oci-warm-*")
if err != nil {
return err
}
defer os.RemoveAll(warmHome)
table := uitable.New()
table.AddRow("Scenario", "Operation", "Time")
// Warm registry, CDN, and filesystem caches before either measured
// scenario so their difference reflects Tart's local base reuse.
if _, err := timedTart(cmd.Context(), logger, warmupHome, pullArguments(stackedImage)...); err != nil {
return fmt.Errorf("registry warmup failed: %w", err)
}
if err := os.RemoveAll(warmupHome); err != nil {
return fmt.Errorf("removing registry warmup home: %w", err)
}
duration, err := timedTart(cmd.Context(), logger, emptyHome, pullArguments(stackedImage)...)
if err != nil {
return fmt.Errorf("empty-home stacked pull failed: %w", err)
}
table.AddRow("empty", "pull stacked image", duration)
duration, err = timedTart(cmd.Context(), logger, emptyHome, "clone", stackedImage, "empty-clone")
if err != nil {
return fmt.Errorf("empty-home stacked clone failed: %w", err)
}
table.AddRow("empty", "clone stacked image", duration)
if err := os.RemoveAll(emptyHome); err != nil {
return fmt.Errorf("removing empty home: %w", err)
}
duration, err = timedTart(cmd.Context(), logger, warmHome, cloneBaseArguments(baseImage)...)
if err != nil {
return fmt.Errorf("base prewarm failed: %w", err)
}
table.AddRow("prewarmed", "clone --stacked base image", duration)
duration, err = timedTart(cmd.Context(), logger, warmHome, pullArguments(stackedImage)...)
if err != nil {
return fmt.Errorf("prewarmed stacked pull failed: %w", err)
}
table.AddRow("prewarmed", "pull stacked image", duration)
duration, err = timedTart(cmd.Context(), logger, warmHome, "clone", stackedImage, "warm-clone")
if err != nil {
return fmt.Errorf("prewarmed stacked clone failed: %w", err)
}
table.AddRow("prewarmed", "clone stacked image", duration)
fmt.Println(table.String())
return nil
}
func pullArguments(image string) []string {
args := []string{"pull", "--concurrency", fmt.Sprint(concurrency)}
if insecure {
args = append(args, "--insecure")
}
return append(args, image)
}
func cloneBaseArguments(image string) []string {
args := []string{"clone", "--stacked", "--concurrency", fmt.Sprint(concurrency)}
if insecure {
args = append(args, "--insecure")
}
return append(args, image, "prewarmed-base")
}
func timedTart(
ctx context.Context,
logger *zap.Logger,
tartHome string,
args ...string,
) (time.Duration, error) {
logger.Sugar().Debugf("TART_HOME=%s tart %s", tartHome, strings.Join(args, " "))
start := time.Now()
command := exec.CommandContext(ctx, "tart", args...)
command.Env = append(os.Environ(), "TART_HOME="+tartHome)
loggerWriter := &zapio.Writer{Log: logger, Level: zap.DebugLevel}
command.Stdout = loggerWriter
command.Stderr = loggerWriter
err := command.Run()
return time.Since(start).Round(time.Millisecond), err
}
Binary file not shown.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 MiB

@@ -11,6 +11,12 @@ categories:
# Changing Tart License
!!! note "Current license"
This post describes a historical license change announced on February 11, 2023.
As of June 5, 2026, Tart is maintained by OpenAI and licensed under
[FSL-1.1-ALv2](https://github.com/openai/tart/blob/main/LICENSE).
The usage limits, paid tiers, pricing, support commitments, and contact details described below no longer apply.
**TLDR:** We are transitioning Tart's licensing from AGPL-3.0 to [Fair Source 100](https://fair.io/). This change will
permit unlimited installations on personal computers, but organizations that exceed a certain number of server
installations utilizing 100 CPU cores will be required to obtain a paid license.
@@ -20,7 +26,7 @@ installations utilizing 100 CPU cores will be required to obtain a paid license.
Exactly a year ago on February 11th 2022 we started working on Tart – a tiny CLI to run macOS virtual machines on Apple Silicon.
Three months later we successfully started using Tart in our own production system and decided to share Tart with everyone.
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/TartSocial.png"/>
<img src="https://github.com/openai/tart/raw/main/Resources/TartSocial.png"/>
The goal was to establish a community of users and contributors to transform Tart from a small CLI to a robust tool
for various scenarios. **Unfortunately, we were not successful in attracting a significant number of contributors.**
@@ -60,13 +66,9 @@ device without a physical display connected. For example, a Mac Mini with a HDMI
but a Mac Mini on a desk with a connected physical display is considered a personal computer. **Usage on personal computers
and before reaching the 100 CPU cores limit is royalty-free and does not have the viral properties of AGPL.**
!!! note "Pricing update"
This post announced Tart licensing in February 2023 and originally listed monthly prices.
Pricing has since changed to yearly billing. See [Licensing and Support](../../licensing.md#license-tiers) for the latest terms.
When an organization surpasses the 100 CPU cores limit, they will be required to obtain a [Gold Tier License](../../licensing.md#license-tiers),
which costs \$12,000 per year. Upon reaching a limit of 500 CPU cores, a [Platinum Tier License](../../licensing.md#license-tiers)
(\$36,000 per year) will be required, and for organizations that exceed 3000 CPU cores, a custom [Diamond Tier License](../../licensing.md#license-tiers)
When an organization surpasses the 100 CPU cores limit, they will be required to obtain a Gold Tier License,
which costs \$12,000 per year. Upon reaching a limit of 500 CPU cores, a Platinum Tier License
(\$36,000 per year) will be required, and for organizations that exceed 3000 CPU cores, a custom Diamond Tier License
(\$12 per core per year) will be necessary. **All paid license tiers will include priority feature development and SLAs on support with urgent issues.**
## Have we considered alternatives?
@@ -78,6 +80,5 @@ this approach is not addressing concerns related to the viral nature of AGPL for
we concluded that transitioning to a source-available model with a mandatory paid licensing is fair, as the licensing fees
are relatively insignificant for companies that reach a significant level of usage.
If you have any questions or concerns, please feel free to reach out to [licensing@cirruslabs.org](mailto:licensing@cirruslabs.org).
If the new licensing model is not suitable for your organization, you are welcome to continue using the AGPL version of Tart,
but please ensure it is not used in a non-AGPL environment.
+3 -3
View File
@@ -78,7 +78,7 @@ in “worker” mode on macOS hosts. Orchard controller is using extremely fast
## Conclusion
Please give [Orchard](https://github.com/cirruslabs/orchard) a try! To run it locally in development mode on any Apple Silicon device
Please give [Orchard](https://github.com/openai/orchard) a try! To run it locally in development mode on any Apple Silicon device
please run the following command:
```bash
@@ -86,9 +86,9 @@ brew install cirruslabs/cli/orchard
orchard dev
```
This will launch a development cluster with a single worker on your machine. Refer to [Orchard documentation](https://github.com/cirruslabs/orchard#creating-virtual-machines)
This will launch a development cluster with a single worker on your machine. Refer to [Orchard documentation](https://github.com/openai/orchard#creating-virtual-machines)
on how to create your first virtual machine and access it.
In a [separate blog post](2023-04-28-orchard-ssh-over-grpc.md)
we’ll cover how Orchard implements seamless SSH access over a gRPC connection. Stay tuned and please don’t hesitate to
[reach out](https://github.com/cirruslabs/orchard/discussions/landing)!
[open an issue](https://github.com/openai/orchard/issues)!
@@ -11,7 +11,7 @@ categories:
# SSH over gRPC or how Orchard simplifies accessing VMs in private networks
We started developing [Orchard](https://github.com/cirruslabs/orchard), an orchestrator for [Tart](https://tart.run/), with the requirement that it should allow users to access virtual machines running on worker nodes in private networks that users might not have access to.
We started developing [Orchard](https://github.com/openai/orchard), an orchestrator for [Tart](https://tart.run/), with the requirement that it should allow users to access virtual machines running on worker nodes in private networks that users might not have access to.
At the same time, we wanted to enable users to access VMs on these remote workers just as easily as they’d access network services on their local Tart VMs.
@@ -102,14 +102,14 @@ Overall, the technology described in this article somewhat resembles what [we pr
We really hope this feature will be useful for many, just as the Cirrus Terminal, and that it will remove the pain of scaling Tart beyond a single machine.
You can give [Orchard](https://github.com/cirruslabs/orchard) a try by running it locally in development mode on any Apple Silicon device:
You can give [Orchard](https://github.com/openai/orchard) a try by running it locally in development mode on any Apple Silicon device:
```bash
brew install cirruslabs/cli/orchard
orchard dev
```
This will launch a development cluster with a single worker on your machine. Refer to [Orchard documentation](https://github.com/cirruslabs/orchard#creating-virtual-machines)
This will launch a development cluster with a single worker on your machine. Refer to [Orchard documentation](https://github.com/openai/orchard#creating-virtual-machines)
on how to create your first virtual machine and access it.
Stay tuned and don’t hesitate to send us your feedback either [on GitHub](https://github.com/cirruslabs/orchard) or [Twitter](https://twitter.com/cirrus_labs)!
Stay tuned and don’t hesitate to send us your feedback either [on GitHub](https://github.com/openai/orchard) or [Twitter](https://twitter.com/cirrus_labs)!
+9 -13
View File
@@ -19,25 +19,21 @@ Today we'd like to share some news and updates around the Tart ecosystem since t
In the last 7 months Tart community almost tripled and growth is continuing to accelerate. Tart just crossed 25,000 installations,
dozens of companies that we know of are using Tart in their daily workflows. If your company is not in the list please consider
[joining](https://github.com/cirruslabs/tart/blob/main/Resources/Users/HowToAddYourself.md)!
[joining](https://github.com/openai/tart/blob/main/Resources/Users/HowToAddYourself.md)!
<div class="grid cards" markdown>
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/Krisp.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/Mullvad.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/ahrefs.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/Suran.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/Symflower.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/Transloadit.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/PITSGlobalDataRecoveryServices.png){ height="65" }
- ![](https://github.com/cirruslabs/tart/raw/main/Resources/Users/Uphold.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/Krisp.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/Mullvad.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/ahrefs.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/Suran.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/Symflower.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/Transloadit.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/PITSGlobalDataRecoveryServices.png){ height="65" }
- ![](https://github.com/openai/tart/raw/main/Resources/Users/Uphold.png){ height="65" }
</div>
We are also very pleased by how the community responded to [the license change](2023-02-11-changing-tart-license.md).
We now have a number of companies running Tart at scale under the new license. Revenue from the licensing allowed us to
allocate time to continue improving Tart which brings us to the section below.
## Recent updates and what's changing in Tart 2.0.0
In the last 7 months we've had 12 feature releases that brought a lot of features requested by the community. Here are just
-71
View File
@@ -1,71 +0,0 @@
---
draft: false
date: 2023-10-06
search:
exclude: true
authors:
- fkorotkov
categories:
- announcement
---
# Tart is now available on AWS Marketplace
Announcing [official AMIs for EC2 Mac Instances](https://aws.amazon.com/marketplace/pp/prodview-qczco34wlkdws)
with preconfigured Tart installation that is optimized to work within AWS infrastructure.
EC2 Mac Instances is a gem of engineering powered by AWS Nitro devices. Just imagine there is a physical Mac Mini with
a plugged in Nitro device that can push the physical power button!
![EC2 M2 Pro](../images/ec2-mac2-m2pro.png)
This clever synergy between Apple Hardware and Nitro System allows seamless integration with VPC networking and booting macOS from an EBS volume.
In this blog post we’ll see how a virtualization solution like Tart can compliment and elevate experience with EC2 Mac Instances.
<!-- more -->
Let’s start from the basics, what EC2 Mac Instances allow to do compared to physical Mac Minis seating in offices of
many companies around the world?
First and foremost, EC2 Mac Instances sit inside AWS data centers and can leverage all the goodies of VPC networking
within your company's existing infrastructure. No need to connect your Macs in the office through a VPN and deal
with networking and security.
Additionally, EC2 Mac Instances are booting from EBS volumes which means it is possible to always have reproducible instances
and apply all the best practices of Infrastructure-as-Code. Managing a fleet of physical Macs is a pain and it's very hard
to make them configured in a reproducible and stable way. With booting from identical EBS volumes your team is always sure
about the identical initial state of the fleet.
## Compromises of EC2 Mac Instances
The flexibility of EBS volumes for macOS comes with some compromises that virtualization solutions like Tart can help with.
The initial boot from an EBS volume takes some time and not instant. macOS itself is pretty heavy and a Nitro device needs
to download tens of gigabytes that macOS requires in order to boot. This means that **resetting a EC2 Mac Instance to a clean state
is not instant and usually takes a couple of minutes** when you can’t utilize the precious resources for your workloads.
It is much easier to tailor such EBS volumes with tools like Packer but there is still a **friction to test newly created EBS volumes**
since one needs to start and run a EC2 Mac Instance and it’s not possible to test things locally. Similarly it is even harder
to test beta versions of macOS that require manual interaction with a running instance.
## Solution
Tart can help with all the compromises! Tart virtual machines (VMs) have nearly native performance thanks to utilizing
native `Virtualization.Framework` that was developed along the first Apple Silicon chip. **Tart VMs can be copied/disposed
instantly and booting a fresh Tart VM takes only several seconds**. It is also possible to run two different Tart VMs in parallel
that can have completely different versions of macOS and packages. For example, it is possible to have the latest stable macOS
with the release version of Xcode along with the next version of macOS with the latest beta of Xcode.
Creation of Tart VMs can be automated with [a Packer plugin](https://github.com/cirruslabs/packer-plugin-tart) the same way as
creation of EC2 AMIs with one caveat that **Tart Packer Plugin works locally so you can test the same virtual machine locally
as you would run it in the cloud**.
Lightweight nature of Tart VMs with a focus on an easy-to-integrate Tart CLI compliments any macOS automation and helps to reduce
the feedback cycle and improves reproducibility of macOS environments even further.
## Conclusion
We are excited to bring [official AMIs that include Tart installation optimized to work within AWS](https://aws.amazon.com/marketplace/pp/prodview-qczco34wlkdws).
In the coming weeks when macOS Sonoma will become available on AWS we’ll release another update specifically targeting EC2 Mac Instances.
This update will simplify access to local SSDs of Mac Instances that are slightly faster than EBS volumes. Stay tuned and don’t hesitate
to ask any [questions](https://tart.run/licensing/).
@@ -11,7 +11,7 @@ categories:
# Jumping through the hoops: SSH jump host functionality in Orchard
Almost a year ago, when we started building [Orchard](https://github.com/cirruslabs/orchard), an orchestration system for Tart, we quickly realized that most worker machines will be in a private network, and that VMs will be only reachable from the worker machines themselves. Thus, one of our goals became to simplify accessing the compute resources in a cluster through a centralized controller host.
Almost a year ago, when we started building [Orchard](https://github.com/openai/orchard), an orchestration system for Tart, we quickly realized that most worker machines will be in a private network, and that VMs will be only reachable from the worker machines themselves. Thus, one of our goals became to simplify accessing the compute resources in a cluster through a centralized controller host.
This effort resulted in commands like `orchard port-forward` and `orchard ssh`, which were later improved to support connecting not just to the VMs, but to the worker machines themselves.
@@ -55,8 +55,6 @@ Once running, you can connect to any VM in the cluster using the `ssh -J <servic
## Future plans
First of all, we’d like to thank our paid clients, without which this feature wouldn’t be possible. [Become one now](../../licensing.md) and get the benefit of higher Tart VMs and Orchard workers allowances and making sure that the roadmap for Tart and Orchard is aligned with your company's needs.
In the near future we plan to implement a mechanism similar to `authorized_keys` file that will allow attaching public SSH keys to the Orchard controller’s service accounts, and thus avoid the need to type the passwords.
Stay tuned and don’t hesitate to send us your feedback on [GitHub](https://github.com/cirruslabs/orchard) and [Twitter](https://x.com/cirrus_labs)!
Stay tuned and don’t hesitate to send us your feedback on [GitHub](https://github.com/openai/orchard) and [Twitter](https://x.com/cirrus_labs)!
@@ -11,9 +11,9 @@ categories:
# Bridging the gaps with the Tart Guest Agent
We're introducing a new improvement for the Tart usability experience: a [Tart Guest Agent](https://github.com/cirruslabs/tart-guest-agent).
We're introducing a new improvement for the Tart usability experience: a [Tart Guest Agent](https://github.com/openai/tart-guest-agent).
This agent provides automatic disk resizing, seamless clipboard sharing for macOS guests (a [long-awaited](https://github.com/cirruslabs/tart/issues/14) feature), and the ability to run commands, without SSH and networking, using the new `tart exec` command.
This agent provides automatic disk resizing, seamless clipboard sharing for macOS guests (a [long-awaited](https://github.com/openai/tart/issues/14) feature), and the ability to run commands, without SSH and networking, using the new `tart exec` command.
As of recently, we include this agent in all non-vanilla Cirrus Labs images, so you likely won't need to do anything to benefit from these usability improvements.
@@ -47,7 +47,7 @@ Using gRPC simplifies `tart exec` implementation because of code generation and
Thanks to [gRPC Swift](https://github.com/grpc/grpc-swift), which is built on top of [SwiftNIO](https://github.com/apple/swift-nio), we get [`async/await`](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/concurrency/) support for free, further simplifying the `tart exec` logic.
As for the Tart Guest Agent, the final result is a Golang binary that [can be customized](https://github.com/cirruslabs/tart-guest-agent?tab=readme-ov-file#guest-agent-for-tart-vms) depending on the execution context:
As for the Tart Guest Agent, the final result is a Golang binary that [can be customized](https://github.com/openai/tart-guest-agent?tab=readme-ov-file#guest-agent-for-tart-vms) depending on the execution context:
* launchd global daemon — runs as a privileged user (`root`), has no clipboard access
* `--resize-disk` — resizes the disk when there's a free space at the end of a disk (assuming that one previously ran `tart set --disk-size`)
@@ -59,14 +59,10 @@ We’ve also introduced `--run-daemon` (which implies `--resize-disk`) and `--ru
## Future plans
First, we'd like to thank our paid clients, without whom this feature wouldn't have been possible.
[Become one now](../../licensing.md) and enjoy higher allowances for Tart VMs and Orchard workers—while helping ensure that our roadmap aligns with your company's needs.
In the near future we plan to implement:
* Linux support — to provide seamless experience for Linux guests too
* a new `tart ip` resolver — to provide a more robust IP retrieval facility for Linux guests, which often struggle to populate the host's ARP table with their network activity
* `tart cp` command — to copy files from/to guest VMs
Stay tuned, and feel free to send us feedback on [GitHub](https://github.com/cirruslabs/tart) and [Twitter](https://x.com/cirrus_labs)!
Stay tuned, and feel free to send us feedback on [GitHub](https://github.com/openai/tart) and [Twitter](https://x.com/cirrus_labs)!
@@ -1,44 +0,0 @@
---
draft: false
date: 2025-10-27
search:
exclude: true
authors:
- fkorotkov
categories:
- announcement
---
# Press Release: Cirrus Labs Successfully Enforces Its Fair Source License
**New York City, NY – October 27th, 2025 – Cirrus Labs, Inc.**, a leading provider of platforms for digital transformation, today announced that it has reached a settlement agreement regarding a violation of its Fair Source License.
<!-- more -->
Cirrus Labs makes its Tart Virtualization Toolset, a leading virtualization toolset to build, run and manage macOS and Linux virtual machines (VMs) on Apple Silicon,
freely available on GitHub under the Fair Source License, a source-available license. Tart is used by tens of thousands of engineers at no charge within its generous free‑use limits.
Many large enterprises that need to exceed those limits support continued development through paid licenses. Cirrus Labs also uses Tart to power [Cirrus Runners](https://cirrus-runners.app/)
— a drop‑in replacement for macOS and Linux runners for GitHub Actions — offered at a fixed monthly price for unlimited usage.
Cirrus Labs discovered that, **despite a prior licensing request that was declined due to a conflict of interest**, another company used Tart in a manner that exceeded the license’s free‑use limits,
in order to create a competing product.
After several months of negotiations, the matter was settled and a settlement payment to Cirrus Labs was agreed upon.
!!! quote "Comment by Fedor Korotkov, CEO of Cirrus Labs"
As a company we embrace healthy competition that ultimately benefits the end user. Most of our users have no trouble complying with our license,
and even when they need something more than our free use limits, we can almost always grant them a license that fits their needs. **This was an exceptional case.**
We are pleased to have reached this settlement, which validates our source-available licensing strategy and reinforces our commitment to protecting our company and serving our community.
Cirrus Labs was represented in this matter by [Jordan Raphael](https://byronraphael.com/attorneys/jordan-raphael/) of Byron Raphael LLP, a boutique intellectual property law firm,
and [Heather Meeker](https://www.techlawpartners.com/heather), a well-known specialist in open source and source available licensing.
The specific financial terms of the settlement and the identity of the counterparty remain confidential.
**About Cirrus Labs:** Cirrus Labs, Inc. is a bootstrapped developer-infrastructure company founded in 2017. Our offerings among others include Tart and Cirrus Runners,
and our software is used by teams at category-leading companies including Atlassian, Figma, Zendesk, Sentry and many more.
Learn more at [https://tart.run/](https://tart.run/) and [https://cirrus-runners.app/](https://cirrus-runners.app/).
**Contact:** [hello@cirruslabs.org](mailto:hello@cirruslabs.org)
+26 -4
View File
@@ -59,7 +59,7 @@ Remote images are pulled into `~/.tart/cache/OCIs/`.
## Nested virtualization support?
Tart is limited by functionality of Apple's `Virtualization.Framework`. At the moment `Virtualization.Framework`
supports nested virtualization only on M3 or M4 chips running macOS 15 (Sequoia) or later and [only for Linux VMs](https://github.com/cirruslabs/tart/issues/1231#issuecomment-4410915463). By default, it is disabled, but can be enabled by passing the `--nested` flag to `tart run`.
supports nested virtualization only on M3 or M4 chips running macOS 15 (Sequoia) or later and [only for Linux VMs](https://github.com/openai/tart/issues/1231#issuecomment-4410915463). By default, it is disabled, but can be enabled by passing the `--nested` flag to `tart run`.
## Connecting to a service running on host
@@ -74,7 +74,7 @@ netstat -nr | awk '/default/{print $2; exit}'
```
Note: that accessing host is only possible with the default NAT network. If you are running your virtual machines with
[Softnet](https://github.com/cirruslabs/softnet) (via `tart run --net-softnet <VM NAME>)`, then the network isolation
[Softnet](https://github.com/openai/softnet) (via `tart run --net-softnet <VM NAME>)`, then the network isolation
is stricter and it's not possible to access the host.
## Avoiding the "Local Network" permission pop-up
@@ -112,7 +112,7 @@ sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.vmnet.pli
By default, the built-in macOS DHCP server allocates IP-addresses to the VMs for the duration of 86,400 seconds (one day), which may easily cause DHCP exhaustion if you run more than ~253 VMs per day, or in other words, more than one VM every ~6 minutes.
This issue is worked around automatically [when using Softnet](http://github.com/cirruslabs/softnet), however, if you don't use or can't use it, the following command will reduce the lease time from the default 86,400 seconds (one day) to 600 seconds (10 minutes):
This issue is worked around automatically [when using Softnet](https://github.com/openai/softnet), however, if you don't use or can't use it, the following command will reduce the lease time from the default 86,400 seconds (one day) to 600 seconds (10 minutes):
```shell
sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.InternetSharing.default.plist bootpd -dict DHCPLeaseTimeSecs -int 600
@@ -204,7 +204,7 @@ Alternatively, you can pass the credentials via the environment variables, see [
## How is Tart different from Anka?
Under the hood Tart is using the same technology as Anka 3.0 so there should be no real difference in performance
or features supported. If there is some feature missing please don't hesitate to [create a feature request](https://github.com/cirruslabs/tart/issues).
or features supported. If there is some feature missing please don't hesitate to [create a feature request](https://github.com/openai/tart/issues).
Instead of Anka Registry, Tart can work with any OCI-compatible container registry. This provides a much more consistent
and scalable experience for distributing virtual machines.
@@ -231,6 +231,28 @@ export TART_NO_AUTO_PRUNE=
TART_NO_AUTO_PRUNE= tart pull ...
```
## Stacked disk images
On macOS 27 or newer, `tart clone --stacked` can create a VM from a remote,
standalone macOS OCI image whose writes are stored in a private ASIF overlay while
its source disk remains a shared read-only base:
```shell
tart clone --stacked ghcr.io/cirruslabs/macos-tahoe-base:latest macos-build
```
Running and pushing `macos-build` preserves that disk relationship. Pulling
another image from the same lineage only downloads immutable disk files that
are not already present in Tart's cache. For a stopped stacked VM,
`tart set --disk-size` grows its private writable overlay without changing the
base; a subsequent push records the new guest-visible disk size.
`tart pull` can cache a stacked image without assembling its disk. Clone, run,
import, and export require a Tart build with DiskImageKit support and macOS 27
or newer. Existing standalone raw and ASIF images continue to work on older
hosts. Keep published lineages shallow when possible: every additional parent
overlay adds another ASIF file to validate and assemble at run time.
## Disk resizing
Disk resizing works on most cloud-ready Linux distributions out-of-the box (e.g. Ubuntu Cloud Images have the `cloud-initramfs-growroot` package installed that runs on boot) and on the rest of the distributions by running the `growpart` or `resize2fs` commands.
+3 -3
View File
@@ -5,8 +5,8 @@ description: Tool for running isolated tasks reproducibly in any environment wit
# Cirrus CLI
Tart itself is only responsible for managing virtual machines, but we've built Tart support into a tool called Cirrus CLI
also developed by Cirrus Labs. [Cirrus CLI](https://github.com/cirruslabs/cirrus-cli) is a command line tool with
Tart itself is only responsible for managing virtual machines, but Cirrus Labs built Tart support into a tool called
[Cirrus CLI](https://github.com/cirruslabs/cirrus-cli), a command line tool with
one configuration format to execute common CI steps (run a script, cache a folder, etc.) locally or in any CI system.
We built Cirrus CLI to solve "But it works on my machine!" problem.
@@ -38,7 +38,7 @@ cirrus run
[Cirrus CI](https://cirrus-ci.org/) already leverages Tart to power its macOS cloud infrastructure. The `.cirrus.yml`
config from above will just work in Cirrus CI and your tasks will be executed inside Tart VMs in our cloud.
**Note:** Cirrus CI only allows [images managed and regularly updated by us](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos).
**Note:** Cirrus CI only allows [images managed and regularly updated by Cirrus Labs](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos).
## Retrieving artifacts from within Tart VMs
+1 -1
View File
@@ -38,4 +38,4 @@ build {
}
```
Here is a [repository with Packer templates](https://github.com/cirruslabs/macos-image-templates) used to build [all the images managed by us](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos).
Here is a [repository with Packer templates](https://github.com/cirruslabs/macos-image-templates) used to build [all the images managed by Cirrus Labs](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos).
-113
View File
@@ -1,113 +0,0 @@
---
search:
exclude: true
---
<!-- markdownlint-disable -->
# Privacy Policy
In addition to this Privacy Policy, Cirrus Labs also has a [Terms of Service](terms.md).
### The Gist
Cirrus Labs Inc will collect certain non-personally identify information about you as you use our sites. We may use
this data to better understand our users. We can also publish this data, but the data will be about a large group of users,
not individuals.
We will also ask you to provide personal information, but you'll always be able to opt out. If you give us personal
information, we won't do anything evil with it.
We can also use cookies, but you can choose not to store these.
That's the basic idea, but you must read through the entire Privacy Policy below and agree with all the details
before you use any of our sites.
### Reuse
This document is based upon the [Automattic Privacy Policy](https://automattic.com/privacy/) and is licensed under
[Creative Commons Attribution Share-Alike License 2.5](https://creativecommons.org/licenses/by-sa/2.5/). Basically,
this means you can use it verbatim or edited, but you must release new versions under the same license and
you have to credit Automattic somewhere (like this!). Automattic is not connected with and does not sponsor or endorse
Cirrus Labs Inc or its use of the work.
Cirrus Labs Inc ("Cirrus Labs") makes available services include our web sites (https://tart.run/), our blog, our API,
and any other software, sites, and services offered by Cirrus Labs Inc in connection to any of those (taken together, the "Service").
It is Cirrus Labs Inc's policy to respect your privacy regarding any information we may collect while operating our websites.
### Questions
If you have question about this Privacy Policy, please contact us at hello@cirruslabs.org
### Visitors
Like most website operators, Cirrus Labs Inc collects non-personally-identifying information of the sort that web browsers and
servers typically make available, such as the browser type, language preference, referring site, and the date and time of each visitor request.
Cirrus Labs Inc's purpose in collecting non-personally identifying information is to better understand how Cirrus Labs Inc's
visitors use its website. From time to time, Cirrus Labs Inc may release non-personally-identifying information in the aggregate,
e.g., by publishing a report on trends in the usage of its website.
Cirrus Labs Inc also collects potentially personally-identifying information like Internet Protocol (IP) addresses.
Cirrus Labs Inc does not use such information to identify its visitors, however, and does not disclose such information,
other than under the same circumstances that it uses and discloses personally-identifying information, as described below.
We may also collect and use IP addresses to block users who violated our Terms of Service.
### Gathering of Personally-Identifying Information
Certain visitors to Cirrus Labs Inc's websites choose to interact with Cirrus Labs Inc in ways that require
Cirrus Labs Inc to gather personally-identifying information. The amount and type of information that Cirrus Labs Inc gathers
depends on the nature of the interaction. Cirrus Labs Inc collects such information only insofar as is necessary or
appropriate to fulfill the purpose of the visitor's interaction with Cirrus Labs Inc. Cirrus Labs Inc does not disclose
personally-identifying information other than as described below. And visitors can always refuse to supply personally-identifying information,
with the caveat that it may prevent them from engaging in certain Service-related activities.
Additionally, some interactions, such as posting a comment, may ask for optional personal information. For instance,
when posting a comment, may provide a website that will be displayed along with a user's name when the comment is displayed.
Supplying such personal information is completely optional and is only displayed for the benefit and the convenience of the user.
### Aggregated Statistics
Cirrus Labs Inc may collect statistics about the behavior of visitors to the Service. For instance, Cirrus Labs Inc
may monitor the most popular parts of the https://tart.run/. Cirrus Labs Inc may display this information publicly or
provide it to others. However, Cirrus Labs Inc does not disclose personally-identifying information other than as described below.
### Protection of Certain Personally-Identifying Information
Cirrus Labs Inc discloses potentially personally-identifying and personally-identifying information only to those of its employees,
contractors and affiliated organizations that (i) need to know that information in order to process it on Cirrus Labs Inc's behalf
or to provide services available at Cirrus Labs Inc's websites, and (ii) that have agreed not to disclose it to others.
Some of those employees, contractors and affiliated organizations may be located outside of your home country; by using the Service,
you consent to the transfer of such information to them. Cirrus Labs Inc will not rent or sell potentially personally-identifying and
personally-identifying information to anyone. Other than to its employees, contractors and affiliated organizations, as described above,
Cirrus Labs Inc discloses potentially personally-identifying and personally-identifying information only when required to do so by law,
or when Cirrus Labs Inc believes in good faith that disclosure is reasonably necessary to protect the property or rights of Cirrus Labs Inc,
third parties or the public at large. If you are a registered user of the Service and have supplied your email address, Cirrus Labs Inc may
occasionally send you an email to tell you about new features, solicit your feedback, or just keep you up to date with what's going on with
Cirrus Labs Inc and our products. We primarily use our website and blog to communicate this type of information, so we expect to keep
this type of email to a minimum. If you send us a request (for example via a support email or via one of our feedback mechanisms),
we reserve the right to publish it in order to help us clarify or respond to your request or to help us support other users.
Cirrus Labs Inc takes all measures reasonably necessary to protect against the unauthorized access, use, alteration or
destruction of potentially personally-identifying and personally-identifying information.
### Browser Cookies
A cookie is a string of information that a website stores on a visitor's computer, and that the visitor's browser provides
to the Service each time the visitor returns. Cirrus Labs Inc uses cookies to help Cirrus Labs Inc identify and track visitors,
their usage of Cirrus Labs Inc Service, and their Service access preferences. Cirrus Labs Inc visitors who do not wish to have
cookies placed on their computers should set their browsers to refuse cookies before using Cirrus Labs Inc's websites, with
the drawback that certain features of Cirrus Labs Inc's websites may not function properly without the aid of cookies.
### Data Storage
Cirrus Labs Inc uses third party vendors and hosting partners to provide the necessary hardware, software, networking,
storage, and related technology required to run the Service. You understand that although you retain full rights to your data,
it may be stored on third party storage and transmitted through third party networks.
### Privacy Policy Changes
Although most changes are likely to be minor, Cirrus Labs Inc may change its Privacy Policy from time to time,
and in Cirrus Labs Inc's sole discretion. Cirrus Labs Inc encourages visitors to frequently check this page for any changes
to its Privacy Policy. Your continued use of this site after any change in this Privacy Policy will constitute your
acceptance of such change.
This page was last updated on 02/20/2023.
-249
View File
@@ -1,249 +0,0 @@
---
search:
exclude: true
---
<!-- markdownlint-disable -->
# Terms of Service
This page covers Terms of Service only for Cirrus Runners and Tart Documentation website in addition to the [Privacy Policy](privacy.md).
### The Gist
Cirrus Labs Inc ("Cirrus Labs") operates the [Cirrus Runners service](https://cirrus-runners.app/) which we hope you use.
If you use it, please use it responsibly. If you don't, we'll have to terminate your subscription.
For paid plans, you'll be charged on a yearly basis. You can cancel anytime, but there are no refunds.
The Terms of Service and our prices can change at any time unless specified in your agreement. We'll warn you 30 days in advance of any price changes.
We'll try to warn you about major changes to the Terms of Service, but we make no guarantees.
That's the basic idea, but you must read through the entire Terms of Service below and agree with all the details before
you use any of our websites or services (whether or not you have signed up).
### Reuse
This document is an adaptation of the Code Climate Terms of Service, which is an adaptation of the Heroku Terms of Service,
which is turn an adaptation of the Google App Engine Terms of Service. The original work has been modified
with permission under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
Neither Code Climate, Inc, nor Heroku, Inc. nor Google, Inc. is connected with and they do not sponsor or endorse
Cirrus Labs or its use of the work.
You're welcome to adapt and use this document for your own needs. If you make an improvement, we'd appreciate it if
you would let us know, so we can consider improving our own document.
### Your Agreement with Cirrus Labs Inc
Your use of the Cirrus Runners Service is governed by this agreement (the "Terms"). The "Service" means the services Cirrus Labs
makes available include our websites (https://tart.run/, https://cirrus-runners.app/), our blog, and any other software, sites,
and services offered by Cirrus Labs in connection to any of those.
"Customer Source Code" means any source code you directly or indirectly submit to Cirrus Runners for the purpose of using the Service.
"Content" means all content generated by Cirrus Runners on your behalf (including metric data) and does not include Customer Source Code.
In order to use the Service, You (the "Customer", "You", or "Your") must first agree to the Terms. You understand and agree
that Cirrus Labs will treat Your use of the Service as acceptance of the Terms from that point onwards.
Cirrus Labs may make changes to the Terms from time to time. You may reject the changes by terminating Your subscription.
You understand and agree that if You use the Service after the date on which the Terms have changed, Cirrus Labs will treat
Your use as acceptance of the updated Terms.
If you have any question about the Terms, please [contact us](../licensing.md#general-support).
### Use of the Service
* You must provide accurate and complete registration information any time You register to use the Service.
* You are responsible for the security of Your passwords and for any use of Your user.
* Your use of the Service must comply with all applicable laws, regulations and ordinances.
* You agree to not engage in any activity that interferes with or disrupts the Service.
* Cirrus Labs reserves the right to enforce quotas and usage limits (to any resources, including the API) at its sole discretion,
with or without notice, which may result in Cirrus Labs disabling or throttling your usage of the Service for any amount of time.
### Service Policies and Privacy
The Service shall be subject to the privacy policy for the Service available at [Privacy Policy](privacy.md), hereby
expressly into the Terms of Service by reference. You agree to the use of Your data in accordance with Cirrus Labs' privacy policies.
### Fees for Use of the Service
* The Service may be provided to You without charge up with certain limits or for a certain "trial" period of time.
* All payments for use of the Service will go through Stripe unless specified in the agreement.
* Cirrus Labs may change its fees and payment policies for the Service by notifying You at least thirty (30) days before the beginning of the billing cycle in which such change will take effect.
### Cancellation and Termination
* You must cancel your subscription via Stripe or my emailing sales@cirruslabs.org.
* You agree that Cirrus Labs, in its sole discretion and for any or no reason, may terminate or suspend Your subscription. You agree that any termination of Your access to the Service may be without prior notice, and You agree that Cirrus Labs will not be liable to You or any third party for such termination.
### Customer Source Code
* Cirrus Labs claims no ownership or control over any Customer Source Code. You retain copyright and any other rights You
already hold in the Customer Source Code and You are responsible for protecting those rights, as appropriate.
* You agree to assume full responsibility for configuring the Service to allow appropriate access to any Customer Source Code provided to the Service.
* You retain sole responsibility for any collaborators or third-party services that you allow to view Customer Source Code and entrust them at your own risk.
* Cirrus Labs is not responsible if you fail to configure, or misconfigure, your project and inadvertently allow unauthorized parties to view any Customer Source Code.
### Ideas and Feedback
You may choose to or we may invite You to submit comments or ideas about the Service, including but not limited to ideas
about improving the Service or our products ("Ideas"). By submitting any Idea, You agree that Your disclosure is unsolicited
and without restriction and will not place Cirrus Labs under any fiduciary or other obligation, and that we are free to
use the Idea without any additional compensation to You, and/or to disclose the Idea on a non-confidential basis or otherwise to anyone.
### Modification of the Service
* You acknowledge and agree that the Service may change from time to time without prior notice to You.
* Changes include, without limitation, changes to fee and payment policies, security patches, added or removed functionality, and other enhancements or restrictions.
* Cirrus Labs shall not be liable to you or to any third party for any modification, price change, suspension or discontinuance of the Service.
### External Resources
The Service may include hyperlinks to other websites or content or resources or email content. You acknowledge and
agree that Cirrus Labs is not responsible for the availability of any such external sites or resources, and does not
endorse any advertising, products or other materials on or available from such web sites or resources.
### License from Cirrus Runners and Restrictions
Subject to and conditioned upon your compliance with these Terms of Service, we grant to you a personal, worldwide,
royalty-free, non-assignable and non-exclusive license to use the software provided to You by Cirrus Labs as part of
the Service as provided to You by Cirrus Labs. This license is for the sole purpose of enabling You to use and enjoy
the benefit of the Service as provided by Cirrus Labs, in the manner permitted by the Terms.
You may not (and You may not permit anyone else to): (a) copy, modify, create a derivative work of, reverse engineer,
decompile or otherwise attempt to extract the source code of the Service or any part thereof, unless this is expressly
permitted or required by law, or unless You have been specifically told that You may do so by Cirrus Labs, in writing
(e.g., through an open source software license); or (b) attempt to disable or circumvent any security mechanisms used by the Service.
Open source software licenses for components of the Service released under an open source license constitute separate written agreements.
To the limited extent that the open source software licenses expressly supersede these Terms of Service, the open source licenses
govern Your agreement with Cirrus Labs for the use of the components of the Service released under an open source license.
You may not use the Service in any manner that could damage, disable, overburden or impair our servers or networks, or
interfere with any other users' use or enjoyment of the Service.
You may not attempt to gain unauthorized access to any of the Service, member accounts, or computer systems or networks,
through hacking, password mining or any other means.
Without limiting anything else contained herein, you agree that you shall not (and you agree not to allow any third party to):
* remove any notices of copyright, trademark or other proprietary rights contained in/on or accessible through the Service
or in any content or other material obtained via the Service;
* use any robot, spider, website search/retrieval application, or other automated device, process or means to access,
retrieve or index any portion of the Service;
* reformat or frame any portion of the web pages that are part of the Service;
* use the Service for commercial purposes not permitted under these Terms;
* create users by automated means or under false or fraudulent pretenses;
* attempt to defeat any security or verification measure relating to the Service;
* provide or use tracking or monitoring functionality in connection with the Service, including, without limitation,
to identify other users’ actions or activities;
* impersonate or attempt to impersonate Cirrus Labs or any employee, contractor or associate of Cirrus Labs, or any other
person or entity; or collect or store personal data about other users in connection with the prohibited activities described in this paragraph.
### Our Copyright Dispute Policy
Cirrus Labs respects the intellectual property of others and requires that our users do the same. It is our policy to
terminate the membership of repeat infringers. If you believe that material or content residing on or accessible through
the Service infringes a copyright, please send a notice of copyright infringement containing the following information
to the Designated Copyright Agent listed below:
* identification of the copyrighted work claimed to have been infringed, or, if multiple copyrighted works are covered
by a single notification, a representative list of such works;
* information reasonably sufficient to permit us to contact you, such as an address, telephone number, and an email address;
* a statement by you that you have a good faith belief that the disputed use is not authorized by the copyright owner, its agent, or the law;
* a statement by you, made under penalty of perjury, that the above information in your notification is accurate and that
you are the copyright owner or are authorized to act on the copyright owner's behalf; and
* your physical or electronic signature.
Our Designated Copyright Agent for notification of claimed infringement can be reached by email at: hello@cirruslabs.org.
The Service may contain advertisements and/or links to other websites (“Third Party Sites”). Cirrus Labs does not endorse,
sanction or verify the accuracy or ownership of the information contained in/on any Third Party Site or any products or
services advertised on Third Party Sites. If you decide to leave the Site and navigate to Third Party Sites, or install
any software or download content from any such Third Party Sites, you do so at your own risk. Once you access a Third Party Site
through a link on our Site, you may no longer be protected by these Terms of Service and you may be subject to the terms
and conditions of such Third Party Site. You should review the applicable policies, including privacy and data gathering practices,
of any Third Party Site to which you navigate from the Site, or relating to any software you use or install from a Third Party Site.
Concerns regarding a Third Party Site should be directed to the Third Party Site itself. Cirrus Labs bears no responsibility for
any action associated with any Third Party Site.
### Disclaimer of Warranties
IF YOU ACCESS THE SERVICE, YOU DO SO AT YOUR OWN RISK. WE PROVIDE THE SERVICE “AS IS”, “WITH ALL FAULTS” AND “AS AVAILABLE.”
WE MAKE NO EXPRESS OR IMPLIED WARRANTIES OR GUARANTEES ABOUT THE SERVICE. TO THE MAXIMUM EXTENT PERMITTED BY LAW, WE HEREBY
DISCLAIM ALL SUCH WARRANTIES, INCLUDING ALL STATUTORY WARRANTIES, WITH RESPECT TO THE SERVICE, INCLUDING WITHOUT LIMITATION
ANY WARRANTIES THAT THE SERVICE IS MERCHANTABLE, OF SATISFACTORY QUALITY, ACCURATE, FIT FOR A PARTICULAR PURPOSE OR NEED,
OR NON-INFRINGING. WE DO NOT GUARANTEE THAT THE RESULTS THAT MAY BE OBTAINED FROM THE USE OF THE SERVICE WILL BE EFFECTIVE,
RELIABLE OR ACCURATE OR WILL MEET YOUR REQUIREMENTS. WE DO NOT GUARANTEE THAT YOU WILL BE ABLE TO ACCESS OR USE THE SERVICE
(EITHER DIRECTLY OR THROUGH THIRD-PARTY NETWORKS) AT TIMES OR LOCATIONS OF YOUR CHOOSING. WE ARE NOT RESPONSIBLE FOR THE ACCURACY,
RELIABILITY, TIMELINESS OR COMPLETENESS OF INFORMATION PROVIDED BY ANY OTHER USERS OF THE SERVICE OR ANY OTHER DATA OR
INFORMATION PROVIDED OR RECEIVED THROUGH THE SERVICE. EXCEPT AS EXPRESSLY SET FORTH HEREIN, CIRRUS LABS MAKES NO WARRANTIES
ABOUT THE INFORMATION SYSTEMS, SOFTWARE AND FUNCTIONS MADE ACCESSIBLE BY OR THROUGH THE SERVICE OR ANY SECURITY ASSOCIATED
WITH THE TRANSMISSION OF SENSITIVE INFORMATION. CIRRUS LABS DOES NOT WARRANT THAT THE SERVICE WILL OPERATE ERROR-FREE,
THAT ERRORS IN THE SERVICE WILL BE FIXED, THAT LOSS OF DATA WILL NOT OCCUR, OR THAT THE SERVICE OR SOFTWARE ARE FREE OF
COMPUTER VIRUSES, CONTAMINANTS OR OTHER HARMFUL ITEMS. UNDER NO CIRCUMSTANCES WILL CIRRUS LABS, ANY OF OUR AFFILIATES,
DISTRIBUTORS, PARTNERS, LICENSORS, AND/OR ANY OF OUR OR THEIR DIRECTORS, OFFICERS, EMPLOYEES, CONSULTANTS, AGENTS, OR
OTHER REPRESENTATIVES BE LIABLE FOR ANY LOSS OR DAMAGE CAUSED BY YOUR RELIANCE ON INFORMATION OBTAINED THROUGH THE SERVICE.
### Limitations on Liability
YOUR SOLE AND EXCLUSIVE REMEDY FOR ANY DISPUTE WITH US IS THE CANCELLATION OF YOUR REGISTRATION. IN NO EVENT SHALL OUR
TOTAL CUMULATIVE LIABILITY TO YOU FOR ANY AND ALL CLAIMS RELATING TO OR ARISING OUT OF YOUR USE OF THE SERVICE,
REGARDLESS OF THE FORM OF ACTION, EXCEED THE GREATER OF: (A) THE TOTAL AMOUNT OF FEES, IF ANY, THAT YOU PAID TO UTILIZE
THE SERVICE OR (B) ONE HUNDRED DOLLARS ($100). IN NO EVENT SHALL WE BE LIABLE TO YOU (OR TO ANY THIRD PARTY CLAIMING
UNDER OR THROUGH YOU) FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES OR
ANY BODILY INJURY, EMOTIONAL DISTRESS, DEATH OR ANY OTHER DAMAGES ARISING FROM YOUR USE OF OR INABILITY TO USE THE SERVICE,
WHETHER ON-LINE OR OFF-LINE, OR OTHERWISE IN CONNECTION WITH THE SERVICE. THESE EXCLUSIONS APPLY TO ANY CLAIMS FOR LOST PROFITS,
LOST DATA, LOSS OF GOODWILL OR BUSINESS REPUTATION, COST OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, WORK STOPPAGE,
COMPUTER FAILURE OR MALFUNCTION, ANY OTHER COMMERCIAL DAMAGES OR LOSSES, OR ANY PERSONAL INJURY OR PROPERTY DAMAGES,
EVEN IF WE KNEW OR SHOULD HAVE KNOWN OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME STATES OR JURISDICTIONS DO NOT ALLOW
THE EXCLUSION OR THE LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, IN SUCH STATES OR JURISDICTIONS,
OUR LIABILITY SHALL BE LIMITED TO THE EXTENT PERMITTED BY LAW. IF YOU ARE A CALIFORNIA RESIDENT, YOU WAIVE YOUR RIGHTS
WITH RESPECT TO CALIFORNIA CIVIL CODE SECTION 1542, WHICH SAYS "A GENERAL RELEASE DOES NOT EXTEND TO CLAIMS WHICH THE
CREDITOR DOES NOT KNOW OR SUSPECT TO EXIST IN HIS FAVOR AT THE TIME OF EXECUTING THE RELEASE, WHICH, IF KNOWN BY HIM
MUST HAVE MATERIALLY AFFECTED HIS SETTLEMENT WITH THE DEBTOR.”
### Indemnification
You agree to hold harmless and indemnify Cirrus Labs, and its subsidiaries, affiliates, officers, agents, employees,
advertisers, licensors, suppliers or partners (collectively "Cirrus Labs and Partners") from and against any
third party claim arising from or in any way related to (a) Your breach of the Terms, (b) Your use of the Service,
(c) Your violation of applicable laws, rules or regulations in connection with the Service, or (d) Your Customer Source Code,
including any liability or expense arising from all claims, losses, damages (actual and consequential), suits, judgments,
litigation costs and attorneys' fees, of every kind and nature. In such a case, Cirrus Labs will provide You with
written notice of such claim, suit or action.
### Choice of Law and Dispute Resolution
The Terms of Service shall be deemed to have been entered into and shall be construed and enforced in accordance with
the laws of the State of New York as applied to contracts made and performed entirely within New York, without giving
effect to any conflicts of law statutes. Any controversy, dispute or claim arising out of or related to the
Terms of Service or the Service shall be settled by final and binding arbitration to be conducted by an arbitration
tribunal in the State of New York and the County of New York, pursuant to the rules of the American Arbitration Association.
Any and all disputes that you may have with Cirrus Labs shall be resolved individually, without resort to any form of class action.
### General Legal Terms
The Terms constitute the whole legal agreement between You and Cirrus Labs and govern Your use of the Service and
completely replace any prior agreements between You and Cirrus Labs in relation to the Service.
If any part of the Terms of Service is held invalid or unenforceable, that portion shall be construed in a manner
consistent with applicable law to reflect, as nearly as possible, the original intentions of the parties, and
the remaining portions shall remain in full force and effect.
The failure of Cirrus Labs to exercise or enforce any right or provision of the Terms of Service shall not constitute
a waiver of such right or provision. The failure of either party to exercise in any respect any right provided for herein
shall not be deemed a waiver of any further rights hereunder.
You agree that if Cirrus Labs does not exercise or enforce any legal right or remedy which is contained in the Terms
(or which Cirrus Labs has the benefit of under any applicable law), this will not be taken to be a formal waiver of
Cirrus Labs' rights and that those rights or remedies will still be available to Cirrus Labs.
Cirrus Labs shall not be liable for failing or delaying performance of its obligations resulting from any condition
beyond its reasonable control, including but not limited to, governmental action, acts of terrorism, earthquake, fire,
flood or other acts of God, labor conditions, power failures, and Internet disturbances.
We may assign this contract at any time to any parent, subsidiary, or any affiliated company, or as part of the sale to,
merger with, or other transfer of our company to another entity.
This page was last updated on 02/03/2019.
-102
View File
@@ -1,102 +0,0 @@
---
hide:
- navigation
title: Licensing and Support
description: Free Tier with 100 CPU core limit. Very affordable Tiers for larger enterprises.
---
Both [Tart Virtualization](https://github.com/cirruslabs/tart) and [Orchard Orchestration](https://github.com/cirruslabs/orchard)
are licensed under [Fair Source License](https://fair.io/). Usage on personal computers including personal workstations is royalty-free,
but organizations that exceed a certain number of server installations (100 CPU cores for Tart and/or 4 hosts for Orchard)
will be required to obtain a paid license.
??? note "Host CPU Core usage"
The virtual CPU cores of Tart VMs are not tied to specific physical cores of the host CPU. Instead, for optimal performance
Tart VMs will automatically try to balance compute between all available cores of the host CPU. As a result,
all performance and energy-efficient cores of the host CPU are always counted towards the license usage.
## License Tiers
By default, when no [license is purchased](#get-the-license), it is assumed that an organization is using a Free Tier license.
You can find the Free Tier license text in [Tart](https://github.com/cirruslabs/tart/blob/main/LICENSE) and [Orchard](https://github.com/cirruslabs/orchard/blob/main/LICENSE) repositories.
Free Tier license has a 100 CPU core limit for Tart and 4 Orchard Workers limit for Orchard.
??? info "Usage Scenarios Examples"
Here are a few examples that fit into the free tier:
- Using Tart on 12 Mac Minis with 8 CPUs each running up to 24 VMs in parallel.
- Creating an Orchard cluster of 4 Mac Studio workers with 24 CPUs each.
Here are a few examples that do not fit into the free tier:
- Using Tart on 13 Mac Minis with 8 CPUs each.
- Creating an Orchard cluster of 5 Mac Minis workers with 8 CPUs each.
### Gold Tier
If an organization wishes to exceed the limits of the Free Tier license, a purchase of the [Gold Tier License](#get-the-license) is required, which costs \$12,000 per year.
Gold Tier license has a 500 CPU core limit for Tart and 20 Orchard Workers limit for Orchard.
### Platinum Tier
If an organization wishes to exceed the limits of the Gold Tier license, a purchase of the [Platinum Tier License](#get-the-license) is required, which costs \$36,000 per year.
Platinum Tier license has a 3,000 CPU core limit for Tart and 200 Orchard Workers limit for Orchard.
### Diamond Tier
For organizations that wish to exceed the limits of the Platinum Tier license, a purchase of a [custom Diamond Tier License](#get-the-license) is required, which costs \$12 per CPU core per year and gives the ability to run unlimited Orchard Workers.
## Get the license
If your organization is interested in purchasing one of the license tiers, please email [licensing@cirruslabs.org](mailto:licensing@cirruslabs.org).
You can see a template of a license subscription agreement [here](assets/TartLicenseSubscription.pdf).
!!! info "Running on AWS?"
There are [official AMIs for EC2 Mac Instances](https://aws.amazon.com/marketplace/pp/prodview-qczco34wlkdws)
with preconfigured Tart installation that is optimized to work within AWS infrastructure.
Additionally, there is a [ECR Pulic Gallery mirror](https://gallery.ecr.aws/cirruslabs/macos) of all the
[Tart VM images managed by us](https://github.com/cirruslabs/macos-image-templates).
## General Support
The best way to ask general questions about particular use cases is to email our support team at [support@cirruslabs.org](mailto:support@cirruslabs.org).
Our support team is trying our best to respond ASAP, but there is no guarantee on a response time unless your organization
has a paid license subscription which includes [Priority Support](#priority-support).
If you have a feature request or noticed lack of some documentation please feel free to [create a GitHub issue](https://github.com/cirruslabs/tart/issues/new).
Our support team will answer it by replying to the issue or by updating the documentation.
## Priority Support
In addition to the general support we provide a *Priority Support* with guaranteed response times included in all the paid license tiers.
| Severity | Support Impact | First Response Time SLA | Hours | How to Submit |
|----------|-----------------------------------------------------------------------------------------------|-------------------------|-------|--------------------------------------------------------------------------------------------------|
| 1 | Emergency (service is unavailable or completely unusable). | 30 minutes | 24x7 | Please use urgent email address. |
| 2 | Highly Degraded (Important features unavailable or extremely slow; No acceptable workaround). | 4 hours | 24x5 | Please use priority email address. |
| 3 | Medium Impact. | 8 hours | 24x5 | Please use priority email address. |
| 4 | Low Impact. | 24 hours | 24x5 | Please use regular support email address. Make sure to send the email from your corporate email. |
`24x5` means period of time from 9AM on Monday till 5PM on Friday in EST timezone.
<!-- markdownlint-disable MD037 -->
??? note "Support Impact Definitions"
* **Severity 1** - Your installation of Orchard is unavailable or completely unusable. An urgent issue can be filed and
our On-Call Support Engineer will respond within 30 minutes. Example: Orchard Controller is showing 502 errors for all users.
* **Severity 2** - Orchard installation is Highly Degraded. Significant Business Impact. Important features are unavailable
or extremely slowed, with no acceptable workaround.
* **Severity 3** - Something is preventing normal service operation. Some Business Impact. Important features of Tart or Orchard
are unavailable or somewhat slowed, but a workaround is available.
* **Severity 4** - Questions or Clarifications around features or documentation. Minimal or no Business Impact.
Information, an enhancement, or documentation clarification is requested, but there is no impact on the operation of Tart and/or Orchard.
!!! info "How to submit a priority or an urgent issue"
Once your organization [obtains a license](#license-tiers), members of your organization
will get access to separate support emails specified in your subscription contract.
+1 -1
View File
@@ -2,7 +2,7 @@
Compared to Worker, which can only be deployed on a macOS machine, Controller can be also deployed on Linux.
In fact, we've made a [container image](https://github.com/cirruslabs/orchard/pkgs/container/orchard) to ease deploying the Controller in container-native environments such as Kubernetes.
In fact, we've made a [container image](https://github.com/orgs/cirruslabs/packages/container/package/orchard) to ease deploying the Controller in container-native environments such as Kubernetes.
Another thing to keep in mind that Orchard API is secured by default: all requests must be authenticated with the credentials of a service account. When you first run Orchard Controller, a `bootstrap-admin` service account will be created automatically and credentials will be printed to the standard output.
+1 -1
View File
@@ -31,7 +31,7 @@ In this deployment method, we'll create a new job definition file for the launch
To begin, first install Orchard:
```shell
brew install cirruslabs/cli/orchard
brew install openai/tools/orchard
```
Ensure that the following command:
+1 -1
View File
@@ -1,4 +1,4 @@
Orchard has a REST API that follows [OpenAPI specification](https://swagger.io/specification/) and is described in [`api/openapi.yaml`](https://github.com/cirruslabs/orchard/blob/main/api/openapi.yaml).
Orchard has a REST API that follows [OpenAPI specification](https://swagger.io/specification/) and is described in [`api/openapi.yaml`](https://github.com/openai/orchard/blob/main/api/openapi.yaml).
You can run `orchard dev` locally and navigate to `http://127.0.0.1:6120/v1/` for interactive documentation.
+1 -1
View File
@@ -10,7 +10,7 @@ Since the Orchard's initial release, we've managed to maintain the backwards com
In case a new functionality is introduced, you might be required to finish the upgrade of both the Controller and the Worker(s) to be able to use it fully.
In case there will be backwards-incompatible changes introduced in the future, we will try to do our best and highlight this in the [release notes](https://github.com/cirruslabs/orchard/releases) accordingly.
In case there will be backwards-incompatible changes introduced in the future, we will try to do our best and highlight this in the [release notes](https://github.com/openai/orchard/releases) accordingly.
## Observability
+8 -9
View File
@@ -1,6 +1,6 @@
Tart is great for running workloads on a single machine, but what if you have more than one computer at your disposal
and
a couple of VMs is not enough anymore for your needs? This is where [Orchard](https://github.com/cirruslabs/orchard)
a couple of VMs is not enough anymore for your needs? This is where [Orchard](https://github.com/openai/orchard)
comes in to play!
It allows you to orchestrate multiple Tart-capable hosts from either an Orchard CLI (which we demonstrate below)
@@ -9,7 +9,7 @@ or [through the API](integration-guide.md).
The easiest way to start is to run Orchard in local development mode:
```shell
brew install cirruslabs/cli/orchard
brew install openai/tools/orchard
orchard dev
```
@@ -92,10 +92,9 @@ orchard delete vm tahoe-base
In addition to controlling the Orchard via the CLI arguments, there are environment variables that may be beneficial
both when automating Orchard and in daily use:
| Variable name | Description |
|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ORCHARD_HOME` | Override Orchard's home directory. Useful when running multiple Orchard instances on the same host and when testing. |
| `ORCHARD_LICENSE_TIER` | The default license limit only allows connecting 4 Orchard Workers to the Orchard Controller. If you've purchased a [Gold Tier License](../licensing.md), set this variable to `gold` to increase the limit to 20 Orchard Workers. And if you've purchased a [Platinum Tier License](../licensing.md), set this variable to `platinum` to increase the limit to 200 Orchard Workers. |
| `ORCHARD_URL` | Override controller URL on per-command basis. |
| `ORCHARD_SERVICE_ACCOUNT_NAME` | Override service account name (used for controller API auth) on per-command basis. |
| `ORCHARD_SERVICE_ACCOUNT_TOKEN` | Override service account token (used for controller API auth) on per-command basis. |
| Variable name | Description |
|---------------------------------|------------------------------------------------------------------------------------------------------------------|
| `ORCHARD_HOME` | Override Orchard's home directory. Useful when running multiple Orchard instances on the same host and testing. |
| `ORCHARD_URL` | Override controller URL on a per-command basis. |
| `ORCHARD_SERVICE_ACCOUNT_NAME` | Override service account name (used for controller API auth) on a per-command basis. |
| `ORCHARD_SERVICE_ACCOUNT_TOKEN` | Override service account token (used for controller API auth) on a per-command basis. |
+2 -2
View File
@@ -3,10 +3,10 @@
The easiest way to install Orchard CLI is through the [Homebrew](https://brew.sh/):
```shell
brew install cirruslabs/cli/orchard
brew install openai/tools/orchard
```
Binaries and packages for other architectures can be found in [GitHub Releases](https://github.com/cirruslabs/orchard/releases).
Binaries and packages for other architectures can be found in [GitHub Releases](https://github.com/openai/orchard/releases).
## Setting up a context
+16 -4
View File
@@ -8,7 +8,7 @@ description: Install Tart and run your first virtual machine on Apple Silicon in
Try running a Tart VM on your Apple Silicon device running macOS 13.0 (Ventura) or later (will download a 25 GB image):
```bash
brew install cirruslabs/cli/tart
brew install openai/tools/tart
tart clone ghcr.io/cirruslabs/macos-tahoe-base:latest tahoe-base
tart run tahoe-base
```
@@ -17,7 +17,7 @@ tart run tahoe-base
It's also possible to manually install `tart` binary from the latest released archive:
```bash
curl -LO https://github.com/cirruslabs/tart/releases/latest/download/tart.tar.gz
curl -LO https://github.com/openai/tart/releases/latest/download/tart.tar.gz
tar -xzvf tart.tar.gz
./tart.app/Contents/MacOS/tart clone ghcr.io/cirruslabs/macos-tahoe-base:latest tahoe-base
./tart.app/Contents/MacOS/tart run tahoe-base
@@ -27,7 +27,7 @@ tart run tahoe-base
to pick `tart.app/Contents/embedded.provisionprofile` for elevated privileges that Tart needs.
<p align="center">
<img src="https://github.com/cirruslabs/tart/raw/main/Resources/TartScreenshot.png"/>
<img src="https://github.com/openai/tart/raw/main/Resources/TartScreenshot.png"/>
</p>
## VM images
@@ -74,7 +74,7 @@ tart set ubuntu --disk-size 50
tart run ubuntu
```
These Linux images can be ran natively on [Vetu](https://github.com/cirruslabs/vetu), our virtualization solution for Linux, assuming that Vetu itself is running on an `arm64` machine.
These Linux images can be run natively on [Vetu](https://github.com/openai/vetu), a virtualization solution for Linux, assuming that Vetu itself is running on an `arm64` machine.
Similarly to macOS, there's also a [full list of images](https://github.com/orgs/cirruslabs/packages?repo_name=linux-image-templates) in which you can discovery specific tags (e.g. `ghcr.io/cirruslabs/ubuntu:22.04`) and [Linux-specific Packer templates](https://github.com/cirruslabs/linux-image-templates) that were used to generate these images.
@@ -265,3 +265,15 @@ tart clone acme.io/remoteorg/name:latest my-local-vm-name
```
If the specified image is not already present, this invocation calls the `tart pull` implicitly before cloning.
### Creating a Stacked Disk
On macOS 27 or newer, use `--stacked` to create a VM that keeps a remote standalone
macOS OCI image as an immutable base and stores only its own writes separately:
```bash
tart clone --stacked ghcr.io/cirruslabs/macos-tahoe-base my-local-vm-name
```
Pushing this VM preserves the disk relationship. Pulling another image from the
same lineage reuses immutable disk files that are already in Tart's cache.
+2 -8
View File
@@ -1,11 +1,5 @@
{% extends "base.html" %}
{% block announce %}
<a href="https://cirruslabs.org/">
️🎉🎉🎉️&nbsp&nbspBig milestone for Cirrus Labs &mdash; we’re joining <strong>OpenAI</strong> to work on Agent Infrastructure&nbsp;&nbsp;🎉🎉🎉
</a>
{% endblock %}
<!-- Render landing page under tabs -->
{% block tabs %} {{ super() }}
@@ -191,7 +185,7 @@
/>
</div>
<figcaption class="md-typeset">
<h2>Run at scale with <a href="https://github.com/cirruslabs/orchard">Orchard</a></h2>
<h2>Run at scale with <a href="https://github.com/openai/orchard">Orchard</a></h2>
<p>
Tart toolset includes Orchard Orchestration &mdash; tool to run and manage Tart virtual
machines at scale on a cluster of Apple Silicon hosts. An Orchard Cluster exposes a simple REST API to
@@ -220,7 +214,7 @@
</h1>
</header>
<script>
fetch("https://api.github.com/repos/cirruslabs/tart/releases?per_page=100")
fetch("https://api.github.com/repos/openai/tart/releases?per_page=100")
.then((response) => response.json())
.then((releases) => {
let allDownloads = 0;
-12
View File
@@ -1,12 +0,0 @@
source = [ "dist/tart_darwin_all/tart.app" ]
bundle_id = "com.github.cirruslabs.tart"
apple_id {
username = "hello@cirruslabs.org"
password = "@env:AC_PASSWORD"
}
sign {
application_identity = "Developer ID Application: Cirrus Labs, Inc."
entitlements_file = "Resources/tart-prod.entitlements"
}
+215
View File
@@ -0,0 +1,215 @@
package integration_test
import (
"bytes"
"context"
"encoding/json"
"integration/tart"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"syscall"
"testing"
"time"
)
// Exercise the real CLI with synthetic VM files and the same POSIX record lock
// used by tart run. This needs macOS, but does not boot a VM or download images.
func TestClonePreservesRunningDestination(t *testing.T) {
home := t.TempDir()
t.Setenv("TART_HOME", home)
t.Setenv("TART_NO_AUTO_PRUNE", "1")
createSyntheticVM(t, home, "source", "92:81:b5:ab:39:37")
destination := createSyntheticVM(t, home, "destination", "92:81:b5:ab:39:38")
if _, stderr, err := tart.Tart(t, "clone", "source", "new-destination"); err != nil {
t.Fatalf("clone to new destination: %v: %s", err, stderr)
}
config := filepath.Join(destination, "config.json")
original, err := os.ReadFile(config)
if err != nil {
t.Fatal(err)
}
held, err := os.OpenFile(config, os.O_RDWR, 0)
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { held.Close() })
originalInfo, err := held.Stat()
if err != nil {
t.Fatal(err)
}
lock := syscall.Flock_t{Type: syscall.F_WRLCK, Whence: 0}
if err := syscall.FcntlFlock(held.Fd(), syscall.F_SETLK, &lock); err != nil {
t.Fatal(err)
}
for range 2 {
_, stderr, err := tart.Tart(t, "clone", "source", "destination")
if err == nil || !strings.Contains(strings.ToLower(stderr), "running") {
t.Fatalf("clone must reject the running destination: %v: %s", err, stderr)
}
currentInfo, err := os.Stat(config)
if err != nil || !os.SameFile(originalInfo, currentInfo) {
t.Fatalf("clone replaced the locked config: %v", err)
}
// Opening and closing config again would release our process's record lock.
current := make([]byte, len(original))
if _, err := held.ReadAt(current, 0); err != nil || !bytes.Equal(original, current) {
t.Fatalf("clone changed the locked config: %v", err)
}
}
lock.Type = syscall.F_UNLCK
if err := syscall.FcntlFlock(held.Fd(), syscall.F_SETLK, &lock); err != nil {
t.Fatal(err)
}
if _, stderr, err := tart.Tart(t, "clone", "source", "destination"); err != nil {
t.Fatalf("clone after shutdown: %v: %s", err, stderr)
}
currentInfo, err := os.Stat(config)
if err != nil || os.SameFile(originalInfo, currentInfo) {
t.Fatalf("clone did not replace the stopped destination: %v", err)
}
}
// Run holds the storage lock while opening VM files. Pause publication at the
// prune lock so we can check storage-lock ownership without timing assumptions.
func TestPublishWaitsForVMLookup(t *testing.T) {
for _, operation := range []string{"create", "rename"} {
t.Run(operation, func(t *testing.T) {
if operation == "create" {
// Create validates a VM configuration even without booting it.
// Hosted macOS guests may not expose hardware virtualization.
supported, err := syscall.SysctlUint32("kern.hv_support")
if err != nil {
t.Fatalf("check hypervisor support: %v", err)
}
if supported == 0 {
t.Skip("create requires hardware virtualization; kern.hv_support is 0")
}
}
home := t.TempDir()
t.Setenv("TART_HOME", home)
t.Setenv("TART_NO_AUTO_PRUNE", "1")
createSyntheticVM(t, home, "source", "92:81:b5:ab:39:37")
destination := createSyntheticVM(t, home, "destination", "92:81:b5:ab:39:38")
// Rename accepts an incomplete destination. Its manifest makes
// replacement acquire the content-pruning lock after the PID lock.
if err := os.Remove(filepath.Join(destination, "disk.img")); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(destination, "manifest.json"), []byte("{}"), 0600); err != nil {
t.Fatal(err)
}
configPath := filepath.Join(destination, "config.json")
config, err := os.OpenFile(configPath, os.O_RDWR, 0)
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { config.Close() })
originalInfo, err := config.Stat()
if err != nil {
t.Fatal(err)
}
prunePath := filepath.Join(home, "cache", "content", ".gc.lock")
if err := os.MkdirAll(filepath.Dir(prunePath), 0700); err != nil {
t.Fatal(err)
}
prune, err := os.OpenFile(prunePath, os.O_CREATE|os.O_RDWR, 0600)
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { prune.Close() })
if err := syscall.Flock(int(prune.Fd()), syscall.LOCK_EX); err != nil {
t.Fatal(err)
}
storage, err := os.Open(home)
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { storage.Close() })
args := []string{"rename", "source", "destination"}
if operation == "create" {
args = []string{"create", "--linux", "--disk-size", "1", "destination"}
}
ctx, cancel := context.WithTimeout(t.Context(), 15*time.Second)
defer cancel()
cmd := exec.CommandContext(ctx, "tart", args...)
var output bytes.Buffer
cmd.Stdout, cmd.Stderr = &output, &output
if err := cmd.Start(); err != nil {
t.Fatal(err)
}
done := make(chan struct{})
var waitErr error
go func() { waitErr = cmd.Wait(); close(done) }()
defer func() { cancel(); <-done }()
ticker := time.NewTicker(10 * time.Millisecond)
defer ticker.Stop()
for {
lock := syscall.Flock_t{Type: syscall.F_RDLCK, Whence: 0}
if err := syscall.FcntlFlock(config.Fd(), syscall.F_GETLK, &lock); err != nil {
t.Fatal(err)
}
if lock.Type == syscall.F_WRLCK && lock.Pid == int32(cmd.Process.Pid) {
break
}
select {
case <-done:
t.Fatalf("%s exited before taking the destination PID lock: %v: %s", operation, waitErr, output.String())
case <-ticker.C:
}
}
// The command has reached replacement and cannot finish while
// we hold the prune lock. It must already own the storage lock.
if err := syscall.Flock(int(storage.Fd()), syscall.LOCK_EX|syscall.LOCK_NB); err == nil {
t.Fatalf("%s reached replacement without holding the storage lock", operation)
} else if err != syscall.EWOULDBLOCK {
t.Fatalf("probe storage lock: %v", err)
}
if err := syscall.Flock(int(prune.Fd()), syscall.LOCK_UN); err != nil {
t.Fatal(err)
}
<-done
if waitErr != nil {
t.Fatalf("%s after releasing the prune lock: %v: %s", operation, waitErr, output.String())
}
currentInfo, err := os.Stat(configPath)
if err != nil || os.SameFile(originalInfo, currentInfo) {
t.Fatalf("destination was not replaced: %v", err)
}
})
}
}
func createSyntheticVM(t *testing.T, home, name, mac string) string {
t.Helper()
directory := filepath.Join(home, "vms", name)
if err := os.MkdirAll(directory, 0700); err != nil {
t.Fatal(err)
}
config, err := json.Marshal(map[string]any{
"version": 1, "os": "linux", "arch": runtime.GOARCH,
"cpuCountMin": 4, "cpuCount": 4,
"memorySizeMin": 4294967296, "memorySize": 4294967296,
"macAddress": mac, "diskFormat": "raw",
"display": map[string]int{"width": 1024, "height": 768},
})
if err != nil {
t.Fatal(err)
}
for filename, contents := range map[string][]byte{
"config.json": config, "disk.img": make([]byte, 4096), "nvram.bin": {},
} {
if err := os.WriteFile(filepath.Join(directory, filename), contents, 0600); err != nil {
t.Fatal(err)
}
}
return directory
}
+6 -2
View File
@@ -1,5 +1,7 @@
import requests
from testcontainers.core.waiting_utils import wait_container_is_ready
from testcontainers.core.container import DockerContainer
from testcontainers.core.wait_strategies import HttpWaitStrategy
class DockerRegistry(DockerContainer):
@@ -8,9 +10,11 @@ class DockerRegistry(DockerContainer):
def __init__(self):
super().__init__("registry:2")
self.with_exposed_ports(self._default_exposed_port)
self.waiting_for(HttpWaitStrategy(self._default_exposed_port, "/v2/").for_status_code(200))
@wait_container_is_ready(requests.exceptions.ConnectionError)
def remote_name(self, for_vm: str):
exposed_port = self.get_exposed_port(self._default_exposed_port)
requests.get(f"http://127.0.0.1:{exposed_port}/v2/")
return f"127.0.0.1:{exposed_port}/tart/{for_vm}:latest"
+60
View File
@@ -0,0 +1,60 @@
package integration_test
import (
"bytes"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
)
func TestExportOverwriteConfirmation(t *testing.T) {
for _, tt := range []struct {
name string
input string
overwrite bool
}{
{name: "EOF"},
{name: "empty line", input: "\n"},
{name: "no", input: "no\n"},
{name: "yes", input: "yes\n", overwrite: true},
} {
t.Run(tt.name, func(t *testing.T) {
home := t.TempDir()
t.Setenv("TART_HOME", home)
t.Setenv("TART_NO_AUTO_PRUNE", "1")
createSyntheticVM(t, home, "source", "92:81:b5:ab:39:37")
directory := t.TempDir()
destination := filepath.Join(directory, "source.tvm")
original := []byte("existing archive")
if err := os.WriteFile(destination, original, 0600); err != nil {
t.Fatal(err)
}
cmd := exec.CommandContext(t.Context(), "tart", "export", "source")
cmd.Dir = directory
cmd.Stdin = strings.NewReader(tt.input)
output, err := cmd.CombinedOutput()
if err != nil {
t.Fatalf("export: %v: %s", err, output)
}
if !strings.Contains(string(output), "are you sure you want to overwrite it?") {
t.Fatalf("expected overwrite confirmation: %s", output)
}
if strings.Contains(string(output), "exporting...") != tt.overwrite {
t.Fatalf("unexpected export behavior: %s", output)
}
current, err := os.ReadFile(destination)
if err != nil {
t.Fatal(err)
}
changed := !bytes.Equal(original, current)
if changed != tt.overwrite {
t.Fatalf("destination changed = %t, want %t", changed, tt.overwrite)
}
})
}
}
+17 -4
View File
@@ -9,6 +9,7 @@ import (
"net/http/httptest"
"net/url"
"testing"
"time"
"github.com/stretchr/testify/require"
semconv "go.opentelemetry.io/otel/semconv/v1.37.0"
@@ -19,7 +20,7 @@ import (
func TestOpenTelemetry(t *testing.T) {
// Start a mock OpenTelemetry collector server
var traces []*tracepkg.ExportTraceServiceRequest
traces := make(chan *tracepkg.ExportTraceServiceRequest, 1)
server := httptest.NewServer(http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
var trace tracepkg.ExportTraceServiceRequest
@@ -43,7 +44,11 @@ func TestOpenTelemetry(t *testing.T) {
"we do not support %q yet", request.Header.Get("Content-Type"))
}
traces = append(traces, &trace)
select {
case traces <- &trace:
default:
t.Error("received an unexpected additional trace")
}
var response tracepkg.ExportTraceServiceResponse
@@ -54,6 +59,7 @@ func TestOpenTelemetry(t *testing.T) {
_, err = writer.Write(responseBytes)
require.NoError(t, err)
}))
t.Cleanup(server.Close)
// Start a "tart list" command
serverURL, err := url.Parse(server.URL)
@@ -67,9 +73,16 @@ func TestOpenTelemetry(t *testing.T) {
require.NoError(t, err)
// Ensure that the mock OpenTelemetry collector received a trace from "tart list"
require.Len(t, traces, 1)
var trace *tracepkg.ExportTraceServiceRequest
select {
case trace = <-traces:
case <-time.After(5 * time.Second):
t.Fatal("timed out waiting for OpenTelemetry trace")
}
server.Close()
require.Empty(t, traces, "received an unexpected additional trace")
resourceSpans := traces[0].GetResourceSpans()
resourceSpans := trace.GetResourceSpans()
require.Len(t, resourceSpans, 1)
// Ensure that service name and version resources are set

Some files were not shown because too many files have changed in this diff Show More