a3s-box-runtime 3.2.3

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

use a3s_box_core::{ExecutionIsolation, ExecutionManager, OperationId};
use a3s_runtime::contract::{RuntimeInspection, RuntimeUnitState};
use a3s_runtime::{
    RuntimeClient, RuntimeDriver, RuntimeError, RuntimeRequestState, RuntimeStateStore,
};

use crate::{BoxRecord, ManagedExecutionState};

use super::super::mapping::{creation_request, operation};
use super::super::metadata::{local_identity, now_ms};
use super::fixture::BoxRuntimeConformanceFixture;
use super::{require, Result};

pub(super) async fn run(
    fixture: &BoxRuntimeConformanceFixture,
    client: &dyn RuntimeClient,
) -> Result<()> {
    // Keep the real-provider scenario state machines off libtest's default
    // thread stack as this profile grows.
    Box::pin(partial_creation_replays_same_provider_identity(fixture)).await?;
    Box::pin(create_before_ack_and_client_restart(fixture)).await?;
    Box::pin(cancelled_task_apply_is_replayable(fixture)).await?;
    Box::pin(completed_client_restart(fixture, client)).await?;
    Box::pin(provider_restart(fixture, client)).await?;
    Box::pin(external_deletion_and_single_replacement(fixture, client)).await?;
    Box::pin(duplicate_resource_detection(fixture, client)).await
}

async fn partial_creation_replays_same_provider_identity(
    fixture: &BoxRuntimeConformanceFixture,
) -> Result<()> {
    let request = fixture.cases.service(
        "recovery-partial-creation",
        "printf 'r17-partial-creation\\n'; exec sleep 3600",
    );
    let state_reservation = fixture.state.reserve_apply(&request, now_ms()).await?;
    require(
        state_reservation.dispatch,
        "partial-creation reservation did not require provider work",
    )?;

    let provider_reservation = fixture
        .driver
        .manager
        .create(
            creation_request(&request.spec, fixture.driver.execution_isolation())?,
            &operation(&request.spec)?,
        )
        .await
        .map_err(|error| super::external("reserve partial provider creation", error))?;
    let provider_id = provider_reservation.execution_id.to_string();
    let created = fixture
        .driver
        .manager
        .managed_record(&provider_reservation.execution_id)
        .await
        .map_err(|error| super::external("load partial provider creation", error))?
        .ok_or_else(|| super::protocol("partial provider creation was not durable"))?;
    require(
        local_identity(&created)?.2 == ManagedExecutionState::Created,
        "partial provider creation advanced before Runtime replay",
    )?;

    let restarted_driver = fixture.restarted_driver()?;
    let restarted = fixture.client_with(restarted_driver.clone(), fixture.state.clone());
    let recovered = restarted.apply(&request).await?;
    require(
        recovered.state == RuntimeUnitState::Running
            && recovered.provider_resource_id.as_deref() == Some(provider_id.as_str()),
        "partial-creation replay did not start the reserved provider identity",
    )?;
    let records = fixture
        .records_for(&restarted_driver, &request.spec)
        .await?;
    require(
        records.len() == 1 && records[0].id == provider_id,
        "partial-creation replay left duplicate provider resources",
    )?;
    fixture
        .remove_unit(&restarted, &request.spec, "recovery-partial-creation")
        .await
}

async fn create_before_ack_and_client_restart(
    fixture: &BoxRuntimeConformanceFixture,
) -> Result<()> {
    let request = fixture.cases.service(
        "recovery-create-before-ack",
        "printf 'r17-create-before-ack\\n'; exec sleep 3600",
    );
    let reservation = fixture.state.reserve_apply(&request, now_ms()).await?;
    require(
        reservation.dispatch,
        "create-before-ack reservation did not require provider work",
    )?;
    let created = fixture
        .driver
        .apply(&request.spec, &reservation.record.observation)
        .await?;
    require(
        created.state == RuntimeUnitState::Running,
        "create-before-ack provider effect did not start a Service",
    )?;
    let original_id = created
        .provider_resource_id
        .clone()
        .ok_or_else(|| super::protocol("create-before-ack returned no provider identity"))?;

    // Deliberately omit RuntimeStateStore::update_observation: this is the
    // exact provider-effect-before-durable-ack crash window.
    let restarted_driver = fixture.restarted_driver()?;
    let restarted = fixture.client_with(restarted_driver, fixture.state.clone());
    let recovered = restarted.apply(&request).await?;
    require(
        recovered.provider_resource_id.as_deref() == Some(original_id.as_str()),
        "pending replay substituted provider identity after create-before-ack",
    )?;
    let records = fixture.records_for(&fixture.driver, &request.spec).await?;
    require(
        records.len() == 1 && records[0].id == original_id,
        "create-before-ack recovery left duplicate provider resources",
    )?;
    fixture
        .remove_unit(&restarted, &request.spec, "recovery-create-before-ack")
        .await
}

async fn cancelled_task_apply_is_replayable(fixture: &BoxRuntimeConformanceFixture) -> Result<()> {
    const RELEASE_MARKER: &str = "r17-cancelled-task-release";
    let command = format!(
        "printf 'r17-cancelled-task\\n'; while [ ! -e /workspace/{RELEASE_MARKER} ]; do sleep 1; done"
    );
    let request = fixture
        .cases
        .task("recovery-cancelled-task", &command, 30_000);
    let client = Arc::new(fixture.client_with(fixture.driver.clone(), fixture.state.clone()));
    let apply = {
        let client = client.clone();
        let request = request.clone();
        tokio::spawn(async move { client.apply(&request).await })
    };

    let provider_record = tokio::time::timeout(Duration::from_secs(120), async {
        loop {
            let records = fixture.records_for(&fixture.driver, &request.spec).await?;
            require(
                records.len() <= 1,
                "cancelled Task created duplicate provider resources before cancellation",
            )?;
            if let Some(record) = records.first() {
                match local_identity(record)?.2 {
                    ManagedExecutionState::Running => break Ok(record.clone()),
                    ManagedExecutionState::Stopped | ManagedExecutionState::Failed => {
                        break Err(super::protocol(
                            "cancellation fixture Task became terminal before cancellation",
                        ));
                    }
                    _ => {}
                }
            }
            if apply.is_finished() {
                break Err(super::protocol(
                    "cancellation fixture apply completed before cancellation",
                ));
            }
            tokio::time::sleep(Duration::from_millis(25)).await;
        }
    })
    .await
    .map_err(|_| super::failure("cancellation fixture did not reach a running provider unit"))??;

    let provider_id = provider_record.id.clone();
    apply.abort();
    match apply.await {
        Err(error) if error.is_cancelled() => {}
        Ok(result) => {
            return Err(super::protocol(format!(
                "cancelled Task apply completed unexpectedly: {result:?}"
            )));
        }
        Err(error) => {
            return Err(super::external("join cancelled Task apply", error));
        }
    }
    let pending = fixture
        .state
        .load_request(&request.spec.unit_id, &request.request_id)
        .await?;
    require(
        pending.state == RuntimeRequestState::Pending,
        "cancelled Task apply did not preserve a replayable pending receipt",
    )?;
    std::fs::write(
        provider_record
            .box_dir
            .join("workspace")
            .join(RELEASE_MARKER),
        b"release\n",
    )
    .map_err(|error| super::external("release cancelled Task fixture", error))?;

    let restarted_driver = fixture.restarted_driver()?;
    let restarted = fixture.client_with(restarted_driver.clone(), fixture.state.clone());
    let recovered = restarted.apply(&request).await?;
    require(
        recovered.state == RuntimeUnitState::Succeeded
            && recovered.provider_resource_id.as_deref() == Some(provider_id.as_str()),
        format!(
            "cancelled Task replay did not reattach to the original provider identity: state={:?}, provider_resource_id={:?}, expected_provider_resource_id={provider_id}",
            recovered.state, recovered.provider_resource_id
        ),
    )?;
    let records = fixture
        .records_for(&restarted_driver, &request.spec)
        .await?;
    require(
        records.len() == 1 && records[0].id == provider_id,
        "cancelled Task replay left duplicate provider resources",
    )?;
    fixture
        .remove_unit(&restarted, &request.spec, "recovery-cancelled-task")
        .await
}

async fn completed_client_restart(
    fixture: &BoxRuntimeConformanceFixture,
    client: &dyn RuntimeClient,
) -> Result<()> {
    let request = fixture.cases.service(
        "recovery-client-restart",
        "printf 'r17-client-restart\\n'; exec sleep 3600",
    );
    let first = client.apply(&request).await?;
    let restarted = fixture.client_with(fixture.driver.clone(), fixture.state.clone());
    let replay = restarted.apply(&request).await?;
    require(
        replay == first,
        "completed request changed after Runtime client restart",
    )?;
    fixture
        .remove_unit(&restarted, &request.spec, "recovery-client-restart")
        .await
}

async fn provider_restart(
    fixture: &BoxRuntimeConformanceFixture,
    client: &dyn RuntimeClient,
) -> Result<()> {
    let request = fixture.cases.service(
        "recovery-provider-restart",
        "printf 'r17-provider-restart\\n'; exec sleep 3600",
    );
    let running = client.apply(&request).await?;
    let provider_id = running.provider_resource_id.clone();
    let restarted_driver = fixture.restarted_driver()?;
    let restarted = fixture.client_with(restarted_driver, fixture.state.clone());
    let RuntimeInspection::Found { observation, .. } =
        restarted.inspect(&request.spec.unit_id).await?
    else {
        return Err(super::protocol("provider restart lost a running Service"));
    };
    require(
        observation.state == RuntimeUnitState::Running
            && observation.provider_resource_id == provider_id,
        "provider restart changed running provider identity",
    )?;
    fixture
        .remove_unit(&restarted, &request.spec, "recovery-provider-restart")
        .await
}

async fn external_deletion_and_single_replacement(
    fixture: &BoxRuntimeConformanceFixture,
    client: &dyn RuntimeClient,
) -> Result<()> {
    let first_request = fixture.cases.service(
        "recovery-external-loss",
        "printf 'r17-external-loss\\n'; exec sleep 3600",
    );
    let running = client.apply(&first_request).await?;
    let lost_id = running
        .provider_resource_id
        .clone()
        .ok_or_else(|| super::protocol("external-loss fixture returned no provider identity"))?;
    let record = fixture.record_for(&first_request.spec).await?;
    delete_external_resource(fixture, &record).await?;

    let restarted_driver = fixture.restarted_driver()?;
    let restarted = fixture.client_with(restarted_driver, fixture.state.clone());
    let RuntimeInspection::Found { observation, .. } =
        restarted.inspect(&first_request.spec.unit_id).await?
    else {
        return Err(super::protocol(
            "external deletion did not preserve durable Runtime identity",
        ));
    };
    require(
        observation.state == RuntimeUnitState::Unknown,
        "external deletion did not persist unknown before replacement",
    )?;

    let mut replacement_request = first_request.clone();
    replacement_request.request_id = fixture
        .cases
        .request_id("recovery-external-loss-replacement");
    let replacement = restarted.apply(&replacement_request).await?;
    let replacement_id = replacement
        .provider_resource_id
        .clone()
        .ok_or_else(|| super::protocol("replacement returned no provider identity"))?;
    require(
        replacement_id != lost_id,
        "confirmed provider loss reused the deleted identity",
    )?;
    let exact = restarted.apply(&replacement_request).await?;
    require(
        exact.provider_resource_id.as_deref() == Some(replacement_id.as_str()),
        "replacement replay created another provider identity",
    )?;
    let records = fixture
        .records_for(&fixture.driver, &replacement_request.spec)
        .await?;
    require(
        records.len() == 1 && records[0].id == replacement_id,
        "external-loss recovery did not converge to exactly one replacement",
    )?;
    fixture
        .remove_unit(
            &restarted,
            &replacement_request.spec,
            "recovery-external-loss",
        )
        .await
}

async fn duplicate_resource_detection(
    fixture: &BoxRuntimeConformanceFixture,
    client: &dyn RuntimeClient,
) -> Result<()> {
    let request = fixture.cases.service(
        "recovery-duplicate",
        "printf 'r17-duplicate\\n'; exec sleep 3600",
    );
    client.apply(&request).await?;

    let injection_operation =
        OperationId::new(format!("r17-duplicate-injection:{}", uuid::Uuid::new_v4()))
            .map_err(|error| super::invalid(error.to_string()))?;
    let reservation = fixture
        .driver
        .manager
        .create(
            creation_request(&request.spec, fixture.driver.execution_isolation())?,
            &injection_operation,
        )
        .await
        .map_err(|error| super::external("reserve duplicate provider unit", error))?;
    fixture
        .driver
        .manager
        .start(&reservation.execution_id, reservation.generation)
        .await
        .map_err(|error| super::external("start duplicate provider unit", error))?;

    let error = client.inspect(&request.spec.unit_id).await.unwrap_err();
    require(
        matches!(error, RuntimeError::Protocol(_)),
        format!("duplicate provider resource did not fail closed: {error}"),
    )?;
    let records = fixture.records_for(&fixture.driver, &request.spec).await;
    require(
        matches!(records, Err(RuntimeError::Protocol(_))),
        "duplicate provider records were accepted as one resource",
    )?;

    let injected = fixture
        .driver
        .manager
        .managed_record(&reservation.execution_id)
        .await
        .map_err(|error| super::external("load duplicate provider unit", error))?
        .ok_or_else(|| super::protocol("duplicate provider unit disappeared before cleanup"))?;
    fixture
        .driver
        .retire_record(injected, &request.spec.unit_id)
        .await?;
    let remaining = fixture.driver.unit_records(&request.spec.unit_id).await?;
    require(
        remaining.len() == 1,
        "duplicate cleanup did not preserve exactly one original resource",
    )?;
    fixture
        .remove_unit(client, &request.spec, "recovery-duplicate")
        .await
}

async fn delete_external_resource(
    fixture: &BoxRuntimeConformanceFixture,
    record: &BoxRecord,
) -> Result<()> {
    match fixture.driver.execution_isolation() {
        ExecutionIsolation::Sandbox => {
            let home = fixture.home_dir.clone();
            let box_dir = record.box_dir.clone();
            let cleanup_id = record.id.clone();
            tokio::task::spawn_blocking(move || {
                crate::vm::reap::cleanup_recorded_sandbox_runtime_in(&home, &box_dir, &cleanup_id)
            })
            .await
            .map_err(|error| super::external("join external Sandbox deletion", error))?
            .map_err(|error| super::external("delete external Sandbox resource", error))
        }
        ExecutionIsolation::Microvm => delete_external_microvm(record).await,
    }
}

#[cfg(target_os = "linux")]
async fn delete_external_microvm(record: &BoxRecord) -> Result<()> {
    let pid = record
        .pid
        .ok_or_else(|| super::protocol("external-loss MicroVM has no host PID"))?;
    let start_time = record
        .pid_start_time
        .ok_or_else(|| super::protocol("external-loss MicroVM has no host PID identity"))?;
    let stopped = tokio::task::spawn_blocking(move || -> std::io::Result<bool> {
        if !crate::process::is_process_alive_with_identity(pid, Some(start_time)) {
            return Err(std::io::Error::new(
                std::io::ErrorKind::NotFound,
                "external-loss MicroVM process identity is not running",
            ));
        }
        let raw_pid = i32::try_from(pid).map_err(|_| {
            std::io::Error::new(
                std::io::ErrorKind::InvalidInput,
                "external-loss MicroVM PID exceeds the host signal range",
            )
        })?;
        // SAFETY: the dedicated conformance fixture recorded this PID and its
        // Linux start-time identity, which was revalidated immediately above.
        if unsafe { libc::kill(raw_pid, libc::SIGKILL) } != 0 {
            return Err(std::io::Error::last_os_error());
        }
        Ok(crate::process::wait_for_process_stop_with_identity(
            pid,
            start_time,
            Duration::from_secs(10),
        ))
    })
    .await
    .map_err(|error| super::external("join external MicroVM deletion", error))?
    .map_err(|error| super::external("delete external MicroVM resource", error))?;
    require(stopped, "external-loss MicroVM did not stop after SIGKILL")
}

#[cfg(not(target_os = "linux"))]
async fn delete_external_microvm(_record: &BoxRecord) -> Result<()> {
    Err(super::failure(
        "external MicroVM loss certification currently requires Linux",
    ))
}