-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathsnapshot.go
More file actions
746 lines (685 loc) · 25 KB
/
snapshot.go
File metadata and controls
746 lines (685 loc) · 25 KB
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
package instances
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"time"
"github.com/kernel/hypeman/lib/forkvm"
"github.com/kernel/hypeman/lib/hypervisor"
"github.com/kernel/hypeman/lib/logger"
"github.com/kernel/hypeman/lib/network"
restartpolicy "github.com/kernel/hypeman/lib/restart-policy"
snapshotstore "github.com/kernel/hypeman/lib/snapshot"
"github.com/kernel/hypeman/lib/tags"
"github.com/nrednav/cuid2"
"go.opentelemetry.io/otel/attribute"
"gvisor.dev/gvisor/pkg/cleanup"
)
type snapshotRecord struct {
Snapshot Snapshot
StoredMetadata StoredMetadata
}
func (m *manager) listSnapshots(ctx context.Context, filter *ListSnapshotsFilter) ([]Snapshot, error) {
_ = ctx
snapshots, err := m.snapshotStore().List(filter)
if err != nil {
return nil, fmt.Errorf("list snapshots: %w", err)
}
counts, err := m.snapshotForkCounts()
if err != nil {
return nil, err
}
for i := range snapshots {
snapshots[i].RefCount = counts[snapshots[i].Id]
}
return snapshots, nil
}
func (m *manager) getSnapshot(ctx context.Context, snapshotID string) (*Snapshot, error) {
_ = ctx
snapshot, err := m.snapshotStore().Get(snapshotID)
if err != nil {
if errors.Is(err, snapshotstore.ErrNotFound) {
return nil, ErrSnapshotNotFound
}
return nil, err
}
refCount, err := m.countSnapshotForks(snapshotID)
if err != nil {
return nil, err
}
snapshot.RefCount = refCount
return snapshot, nil
}
func (m *manager) createSnapshot(ctx context.Context, id string, req CreateSnapshotRequest) (_ *Snapshot, retErr error) {
log := logger.FromContext(ctx)
log.InfoContext(ctx, "creating snapshot", "instance_id", id, "kind", req.Kind, "name", req.Name)
ctx, span := m.startLifecycleSpan(ctx, "instances.create_snapshot",
attribute.String("instance_id", id),
attribute.String("operation", "create_snapshot"),
attribute.String("snapshot_kind", string(req.Kind)),
)
defer func() { finishInstancesSpan(span, retErr) }()
if err := validateCreateSnapshotRequest(req); err != nil {
return nil, err
}
meta, err := m.loadMetadata(id)
if err != nil {
return nil, err
}
inst := m.toInstance(ctx, meta)
stored := &meta.StoredMetadata
if err := validateForkVolumeSafety(stored.Volumes); err != nil {
return nil, fmt.Errorf("%w: snapshot requires readonly volume attachments: %v", ErrNotSupported, err)
}
if err := m.ensureSnapshotNameAvailable(stored.Id, req.Name); err != nil {
return nil, err
}
snapshotID := cuid2.Generate()
if _, err := m.loadSnapshotRecord(snapshotID); err == nil {
return nil, fmt.Errorf("%w: generated snapshot id already exists", ErrAlreadyExists)
} else if !errors.Is(err, ErrSnapshotNotFound) {
return nil, err
}
snapshotDir := m.paths.SnapshotDir(snapshotID)
snapshotGuestDir := m.paths.SnapshotGuestDir(snapshotID)
cu := cleanup.Make(func() {
_ = os.RemoveAll(snapshotDir)
})
defer cu.Clean()
if err := os.MkdirAll(m.paths.SnapshotStoreDir(), 0755); err != nil {
return nil, fmt.Errorf("create snapshot store dir: %w", err)
}
switch req.Kind {
case SnapshotKindStandby:
restoreSource := false
switch inst.State {
case StateRunning:
if err := ensureGuestAgentReadyForForkPhase(ctx, &inst.StoredMetadata, "before running snapshot"); err != nil {
return nil, err
}
if _, err := m.standbyInstance(ctx, id, StandbyInstanceRequest{}, true); err != nil {
return nil, fmt.Errorf("standby source instance: %w", err)
}
restoreSource = true
case StateStandby:
target, err := m.cancelAndWaitCompressionJob(ctx, m.snapshotJobKeyForInstance(id))
if err != nil {
return nil, fmt.Errorf("wait for source instance compression to stop: %w", err)
}
if target != nil && target.State == compressionJobStateRunning {
m.recordSnapshotCompressionPreemption(ctx, snapshotCompressionPreemptionCreateSnapshot, target.Target)
}
if err := m.clearPendingStandbyCompression(ctx, id); err != nil && !errors.Is(err, ErrNotFound) {
return nil, fmt.Errorf("clear source standby compression plan: %w", err)
}
if err := m.ensureSnapshotMemoryReady(ctx, m.paths.InstanceSnapshotLatest(id), "", stored.HypervisorType); err != nil {
return nil, fmt.Errorf("prepare source snapshot memory for copy: %w", err)
}
default:
return nil, fmt.Errorf("%w: standby snapshot requires source in %s or %s, got %s", ErrInvalidState, StateRunning, StateStandby, inst.State)
}
copyErr := m.copySnapshotPayload(id, snapshotGuestDir)
if copyErr == nil {
meta, copyErr = m.loadMetadata(id)
}
if restoreSource {
_, restoreErr := m.restoreInstance(ctx, id)
if restoreErr != nil {
if copyErr != nil {
return nil, fmt.Errorf("snapshot copy failed: %v; additionally failed to restore source: %w", copyErr, restoreErr)
}
return nil, fmt.Errorf("restore source after snapshot: %w", restoreErr)
}
}
if copyErr != nil {
return nil, copyErr
}
snapshotMeta := cloneStoredMetadataWithoutPendingStandbyCompression(meta.StoredMetadata)
snapshotMeta.ForkOfSnapshot = ""
rec := &snapshotRecord{
Snapshot: Snapshot{
Id: snapshotID,
Name: req.Name,
Kind: req.Kind,
Tags: tags.Clone(req.Tags),
SourceInstanceID: stored.Id,
SourceName: stored.Name,
SourceHypervisor: stored.HypervisorType,
CreatedAt: time.Now(),
},
StoredMetadata: snapshotMeta,
}
sizeBytes, err := snapshotstore.DirectoryFileSize(snapshotGuestDir)
if err != nil {
return nil, err
}
rec.Snapshot.SizeBytes = sizeBytes
rec.Snapshot.CompressionState = snapshotstore.SnapshotCompressionStateNone
effectiveCompression, err := m.resolveSnapshotCompressionPolicy(stored, req.Compression)
if err != nil {
return nil, err
}
if effectiveCompression.Enabled {
rec.Snapshot.Compression = cloneCompressionConfig(&effectiveCompression)
rec.Snapshot.CompressionState = snapshotstore.SnapshotCompressionStateCompressing
}
if err := m.saveSnapshotRecord(rec); err != nil {
return nil, err
}
if effectiveCompression.Enabled {
m.startCompressionJob(ctx, compressionTarget{
Key: m.snapshotJobKeyForSnapshot(snapshotID),
OwnerID: stored.Id,
SnapshotID: snapshotID,
SnapshotDir: snapshotGuestDir,
HypervisorType: stored.HypervisorType,
Source: snapshotCompressionSourceSnapshot,
Policy: effectiveCompression,
})
}
cu.Release()
log.InfoContext(ctx, "snapshot created", "instance_id", id, "snapshot_id", snapshotID, "kind", req.Kind)
return &rec.Snapshot, nil
case SnapshotKindStopped:
if inst.State != StateStopped {
return nil, fmt.Errorf("%w: stopped snapshot requires source in %s, got %s", ErrInvalidState, StateStopped, inst.State)
}
if err := m.copySnapshotPayload(id, snapshotGuestDir); err != nil {
return nil, err
}
snapshotMeta := cloneStoredMetadataWithoutPendingStandbyCompression(meta.StoredMetadata)
snapshotMeta.ForkOfSnapshot = ""
rec := &snapshotRecord{
Snapshot: Snapshot{
Id: snapshotID,
Name: req.Name,
Kind: req.Kind,
Tags: tags.Clone(req.Tags),
SourceInstanceID: stored.Id,
SourceName: stored.Name,
SourceHypervisor: stored.HypervisorType,
CreatedAt: time.Now(),
},
StoredMetadata: snapshotMeta,
}
sizeBytes, err := snapshotstore.DirectoryFileSize(snapshotGuestDir)
if err != nil {
return nil, err
}
rec.Snapshot.SizeBytes = sizeBytes
rec.Snapshot.CompressionState = snapshotstore.SnapshotCompressionStateNone
if err := m.saveSnapshotRecord(rec); err != nil {
return nil, err
}
cu.Release()
log.InfoContext(ctx, "snapshot created", "instance_id", id, "snapshot_id", snapshotID, "kind", req.Kind)
return &rec.Snapshot, nil
default:
return nil, fmt.Errorf("%w: unsupported snapshot kind %q", ErrInvalidRequest, req.Kind)
}
}
func (m *manager) deleteSnapshot(ctx context.Context, snapshotID string) error {
if _, err := m.snapshotStore().Get(snapshotID); err != nil {
if errors.Is(err, snapshotstore.ErrNotFound) {
return ErrSnapshotNotFound
}
return err
}
forks, err := m.countSnapshotForks(snapshotID)
if err != nil {
return err
}
if forks > 0 {
return fmt.Errorf("%w: cannot delete snapshot %s with %d fork(s)", ErrInvalidState, snapshotID, forks)
}
target, err := m.cancelAndWaitCompressionJob(ctx, m.snapshotJobKeyForSnapshot(snapshotID))
if err != nil {
return fmt.Errorf("wait for snapshot compression to stop: %w", err)
}
if target != nil && target.State == compressionJobStateRunning {
m.recordSnapshotCompressionPreemption(ctx, snapshotCompressionPreemptionDeleteSnapshot, target.Target)
}
if err := m.snapshotStore().Delete(snapshotID); err != nil {
if errors.Is(err, snapshotstore.ErrNotFound) {
return ErrSnapshotNotFound
}
return err
}
return nil
}
func (m *manager) restoreSnapshot(ctx context.Context, id string, snapshotID string, req RestoreSnapshotRequest) (_ *Instance, retErr error) {
log := logger.FromContext(ctx)
ctx, span := m.startLifecycleSpan(ctx, "instances.restore_snapshot",
attribute.String("instance_id", id),
attribute.String("operation", "restore_snapshot"),
attribute.String("snapshot_id", snapshotID),
)
defer func() { finishInstancesSpan(span, retErr) }()
rec, err := m.loadSnapshotRecord(snapshotID)
if err != nil {
return nil, err
}
if rec.Snapshot.SourceInstanceID != id {
return nil, fmt.Errorf("%w: snapshot %s belongs to instance %s", ErrInvalidRequest, snapshotID, rec.Snapshot.SourceInstanceID)
}
sourceMeta, err := m.loadMetadata(id)
if err != nil {
return nil, err
}
sourceInst := m.toInstance(ctx, sourceMeta)
if sourceInst.State == StateRunning {
return nil, fmt.Errorf("%w: cannot restore snapshot while source is %s", ErrInvalidState, sourceInst.State)
}
targetState, err := resolveSnapshotTargetState(rec.Snapshot.Kind, req.TargetState)
if err != nil {
return nil, err
}
targetHypervisor, err := m.resolveSnapshotTargetHypervisor(rec, req.TargetHypervisor)
if err != nil {
return nil, err
}
target, err := m.cancelAndWaitCompressionJob(ctx, m.snapshotJobKeyForSnapshot(snapshotID))
if err != nil {
return nil, fmt.Errorf("wait for snapshot compression to stop: %w", err)
}
if target != nil && target.State == compressionJobStateRunning {
m.recordSnapshotCompressionPreemption(ctx, snapshotCompressionPreemptionRestoreSnapshot, target.Target)
}
target, err = m.cancelAndWaitCompressionJob(ctx, m.snapshotJobKeyForInstance(id))
if err != nil {
return nil, fmt.Errorf("wait for source instance compression to stop: %w", err)
}
if target != nil && target.State == compressionJobStateRunning {
m.recordSnapshotCompressionPreemption(ctx, snapshotCompressionPreemptionRestoreSnapshot, target.Target)
}
if err := m.replaceInstanceWithSnapshotPayload(snapshotID, id); err != nil {
return nil, err
}
restored := cloneStoredMetadataWithoutPendingStandbyCompression(rec.StoredMetadata)
restored.Id = sourceMeta.Id
restored.Name = sourceMeta.Name
restored.DataDir = m.paths.InstanceDir(id)
restored.HypervisorPID = nil
restored.StartedAt = nil
restored.StoppedAt = nil
restored.ExitCode = nil
restored.ExitMessage = ""
restored.HypervisorType = targetHypervisor
restored.ForkOfSnapshot = ""
starter, err := m.getVMStarter(targetHypervisor)
if err != nil {
return nil, fmt.Errorf("get vm starter: %w", err)
}
if targetHypervisor != rec.StoredMetadata.HypervisorType {
hvVersion, err := starter.GetVersion(m.paths)
if err != nil {
log.WarnContext(ctx, "failed to get hypervisor version", "hypervisor", targetHypervisor, "error", err)
hvVersion = "unknown"
}
restored.HypervisorVersion = hvVersion
}
restored.SocketPath = m.paths.InstanceSocket(id, starter.SocketName())
restored.VsockSocket = m.paths.InstanceSocket(id, hypervisor.VsockSocketNameForType(targetHypervisor))
if rec.Snapshot.Kind == SnapshotKindStopped {
restored.VsockCID = generateVsockCID(id)
}
if err := m.saveMetadata(&metadata{StoredMetadata: restored}); err != nil {
return nil, fmt.Errorf("save restored metadata: %w", err)
}
switch rec.Snapshot.Kind {
case SnapshotKindStandby:
switch targetState {
case StateStandby:
return m.getInstance(ctx, id)
case StateStopped:
if err := os.RemoveAll(m.paths.InstanceSnapshotLatest(id)); err != nil {
return nil, fmt.Errorf("remove instance snapshot: %w", err)
}
return m.getInstance(ctx, id)
case StateRunning:
inst, err := m.restoreInstance(ctx, id)
if err != nil {
return nil, err
}
if err := ensureGuestAgentReadyForForkPhase(ctx, &inst.StoredMetadata, "before returning running snapshot restore instance"); err != nil {
return nil, fmt.Errorf("wait for snapshot restore guest agent readiness: %w", err)
}
return inst, nil
}
case SnapshotKindStopped:
switch targetState {
case StateStopped:
_ = os.RemoveAll(m.paths.InstanceSnapshotLatest(id))
return m.getInstance(ctx, id)
case StateRunning:
inst, err := m.startInstance(ctx, id, StartInstanceRequest{})
if err != nil {
return nil, err
}
if err := ensureGuestAgentReadyForForkPhase(ctx, &inst.StoredMetadata, "before returning running snapshot restore instance"); err != nil {
return nil, fmt.Errorf("wait for snapshot restore guest agent readiness: %w", err)
}
return inst, nil
}
}
return nil, fmt.Errorf("%w: unsupported restore target state %s for snapshot kind %s", ErrInvalidRequest, targetState, rec.Snapshot.Kind)
}
func (m *manager) forkSnapshot(ctx context.Context, snapshotID string, req ForkSnapshotRequest) (*Instance, error) {
if err := validateForkSnapshotRequest(req); err != nil {
return nil, err
}
rec, err := m.loadSnapshotRecord(snapshotID)
if err != nil {
return nil, err
}
if err := validateForkVolumeSafety(rec.StoredMetadata.Volumes); err != nil {
return nil, fmt.Errorf("%w: snapshot requires readonly volume attachments: %v", ErrNotSupported, err)
}
if err := m.ensureInstanceNameAvailableForSnapshotFork(ctx, req.Name, rec.StoredMetadata.NetworkEnabled); err != nil {
return nil, err
}
targetState, err := resolveSnapshotTargetState(rec.Snapshot.Kind, req.TargetState)
if err != nil {
return nil, err
}
targetHypervisor, err := m.resolveSnapshotTargetHypervisor(rec, req.TargetHypervisor)
if err != nil {
return nil, err
}
forkID := cuid2.Generate()
if _, err := m.loadMetadata(forkID); err == nil {
return nil, fmt.Errorf("%w: generated fork id already exists", ErrAlreadyExists)
} else if !errors.Is(err, ErrNotFound) {
return nil, err
}
dstDir := m.paths.InstanceDir(forkID)
cu := cleanup.Make(func() {
_ = os.RemoveAll(dstDir)
})
defer cu.Clean()
target, err := m.cancelAndWaitCompressionJob(ctx, m.snapshotJobKeyForSnapshot(snapshotID))
if err != nil {
return nil, fmt.Errorf("wait for snapshot compression to stop: %w", err)
}
if target != nil && target.State == compressionJobStateRunning {
m.recordSnapshotCompressionPreemption(ctx, snapshotCompressionPreemptionForkSnapshot, target.Target)
}
if err := m.ensureSnapshotMemoryReady(ctx, m.paths.SnapshotGuestDir(snapshotID), "", rec.StoredMetadata.HypervisorType); err != nil {
return nil, fmt.Errorf("prepare snapshot memory for fork: %w", err)
}
srcDir := m.paths.SnapshotGuestDir(snapshotID)
copyOpts := forkvm.CopyOptions{}
srcMemPath, srcMemRel, hasSharedMem := snapshotMemHardlinkSource(srcDir)
if hasSharedMem {
copyOpts.SkipRelPaths = []string{srcMemRel}
}
if err := forkvm.CopyGuestDirectoryWithOptions(srcDir, dstDir, copyOpts); err != nil {
if errors.Is(err, forkvm.ErrSparseCopyUnsupported) {
return nil, fmt.Errorf("fork from snapshot requires sparse-capable filesystem (SEEK_DATA/SEEK_HOLE unsupported): %w", err)
}
return nil, fmt.Errorf("clone snapshot payload: %w", err)
}
if hasSharedMem {
if err := installForkSnapshotMemHardlink(srcMemPath, dstDir, srcMemRel); err != nil {
return nil, fmt.Errorf("hardlink snapshot mem-file into fork: %w", err)
}
}
starter, err := m.getVMStarter(targetHypervisor)
if err != nil {
return nil, fmt.Errorf("get vm starter: %w", err)
}
now := time.Now()
forkMeta := cloneStoredMetadataWithoutPendingStandbyCompression(rec.StoredMetadata)
forkMeta.Id = forkID
forkMeta.Name = req.Name
forkMeta.CreatedAt = now
forkMeta.StartedAt = nil
forkMeta.StoppedAt = nil
forkMeta.HypervisorPID = nil
forkMeta.DataDir = dstDir
forkMeta.HypervisorType = targetHypervisor
if targetHypervisor != rec.StoredMetadata.HypervisorType {
hvVersion, err := starter.GetVersion(m.paths)
if err != nil {
hvVersion = "unknown"
}
forkMeta.HypervisorVersion = hvVersion
}
forkMeta.SocketPath = m.paths.InstanceSocket(forkID, starter.SocketName())
forkMeta.VsockSocket = m.paths.InstanceSocket(forkID, hypervisor.VsockSocketNameForType(targetHypervisor))
forkMeta.ExitCode = nil
forkMeta.ExitMessage = ""
forkMeta.RestartStatus = restartpolicy.Status{}
forkMeta.ForkOfSnapshot = snapshotID
if rec.Snapshot.Kind == SnapshotKindStandby {
forkMeta.VsockCID = rec.StoredMetadata.VsockCID
} else {
forkMeta.VsockCID = generateVsockCID(forkID)
}
if forkMeta.NetworkEnabled {
forkMeta.IP = ""
forkMeta.MAC = ""
}
if rec.Snapshot.Kind == SnapshotKindStandby {
netCfg := (*hypervisor.ForkNetworkConfig)(nil)
if forkMeta.NetworkEnabled {
netCfg = &hypervisor.ForkNetworkConfig{TAPDevice: network.GenerateTAPName(forkID)}
}
if _, err := starter.PrepareFork(ctx, hypervisor.ForkPrepareRequest{
SnapshotConfigPath: m.paths.InstanceSnapshotConfig(forkID),
SourceDataDir: rec.StoredMetadata.DataDir,
TargetDataDir: forkMeta.DataDir,
VsockCID: forkMeta.VsockCID,
VsockSocket: forkMeta.VsockSocket,
SerialLogPath: m.paths.InstanceAppLog(forkID),
Network: netCfg,
}); err != nil {
if errors.Is(err, hypervisor.ErrNotSupported) {
return nil, fmt.Errorf("%w: snapshot fork is not supported for hypervisor %s", ErrNotSupported, targetHypervisor)
}
return nil, fmt.Errorf("prepare snapshot fork state: %w", err)
}
}
if err := m.saveMetadata(&metadata{StoredMetadata: forkMeta}); err != nil {
return nil, fmt.Errorf("save fork metadata: %w", err)
}
cu.Release()
inst, err := m.applyForkTargetState(ctx, forkID, targetState)
if err != nil {
if cleanupErr := m.cleanupForkInstanceOnError(ctx, forkID); cleanupErr != nil {
return nil, fmt.Errorf("apply snapshot fork target state: %w; additionally failed to cleanup forked instance %s: %v", err, forkID, cleanupErr)
}
return nil, fmt.Errorf("apply snapshot fork target state: %w", err)
}
return inst, nil
}
func (m *manager) copySnapshotPayload(sourceInstanceID, snapshotGuestDir string) error {
if err := forkvm.CopyGuestDirectory(m.paths.InstanceDir(sourceInstanceID), snapshotGuestDir); err != nil {
if errors.Is(err, forkvm.ErrSparseCopyUnsupported) {
return fmt.Errorf("snapshot requires sparse-capable filesystem (SEEK_DATA/SEEK_HOLE unsupported): %w", err)
}
return fmt.Errorf("copy guest directory into snapshot: %w", err)
}
return nil
}
func (m *manager) replaceInstanceWithSnapshotPayload(snapshotID, instanceID string) error {
instanceDir := m.paths.InstanceDir(instanceID)
if err := os.RemoveAll(instanceDir); err != nil {
return fmt.Errorf("clear instance directory: %w", err)
}
if err := forkvm.CopyGuestDirectory(m.paths.SnapshotGuestDir(snapshotID), instanceDir); err != nil {
if errors.Is(err, forkvm.ErrSparseCopyUnsupported) {
return fmt.Errorf("restore requires sparse-capable filesystem (SEEK_DATA/SEEK_HOLE unsupported): %w", err)
}
return fmt.Errorf("restore snapshot payload: %w", err)
}
return nil
}
func (m *manager) resolveSnapshotTargetHypervisor(rec *snapshotRecord, requested hypervisor.Type) (hypervisor.Type, error) {
if requested == "" {
return rec.StoredMetadata.HypervisorType, nil
}
if rec.Snapshot.Kind == SnapshotKindStandby {
return "", fmt.Errorf("%w: target_hypervisor is only allowed for stopped snapshots", ErrInvalidRequest)
}
if _, err := m.getVMStarter(requested); err != nil {
return "", fmt.Errorf("%w: unsupported target hypervisor %q", ErrInvalidRequest, requested)
}
return requested, nil
}
func resolveSnapshotTargetState(kind SnapshotKind, requested State) (State, error) {
resolved, err := snapshotstore.ResolveTargetState(kind, string(requested))
if err != nil {
return "", fmt.Errorf("%w: %v", ErrInvalidRequest, err)
}
return State(resolved), nil
}
func validateCreateSnapshotRequest(req CreateSnapshotRequest) error {
if req.Kind != SnapshotKindStandby && req.Kind != SnapshotKindStopped {
return fmt.Errorf("%w: kind must be one of %s, %s", ErrInvalidRequest, SnapshotKindStandby, SnapshotKindStopped)
}
if req.Kind == SnapshotKindStopped && req.Compression != nil && req.Compression.Enabled {
return fmt.Errorf("%w: compression is only supported for standby snapshots", ErrInvalidRequest)
}
if _, err := normalizeCompressionConfig(req.Compression); err != nil {
return err
}
if err := tags.Validate(req.Tags); err != nil {
return fmt.Errorf("%w: %v", ErrInvalidRequest, err)
}
if req.Name != "" {
if err := validateInstanceName(req.Name); err != nil {
return fmt.Errorf("%w: %v", ErrInvalidRequest, err)
}
}
return nil
}
func validateForkSnapshotRequest(req ForkSnapshotRequest) error {
if err := validateInstanceName(req.Name); err != nil {
return fmt.Errorf("%w: %v", ErrInvalidRequest, err)
}
if req.TargetState != "" && req.TargetState != StateStopped && req.TargetState != StateStandby && req.TargetState != StateRunning {
return fmt.Errorf("%w: invalid target_state %q", ErrInvalidRequest, req.TargetState)
}
return nil
}
func (m *manager) snapshotStore() *snapshotstore.Store {
return snapshotstore.NewStore(m.paths)
}
func (m *manager) ensureSnapshotNameAvailable(sourceInstanceID, snapshotName string) error {
if err := m.snapshotStore().EnsureNameAvailable(sourceInstanceID, snapshotName); err != nil {
if errors.Is(err, snapshotstore.ErrNameExists) {
return fmt.Errorf("%w: %v", ErrAlreadyExists, err)
}
return err
}
return nil
}
func (m *manager) ensureInstanceNameAvailableForSnapshotFork(ctx context.Context, name string, networkEnabled bool) error {
existsByMetadata, err := m.instanceNameExists(name)
if err != nil {
return fmt.Errorf("check instance name availability: %w", err)
}
if existsByMetadata {
return fmt.Errorf("%w: instance name '%s' already exists", ErrAlreadyExists, name)
}
if networkEnabled {
exists, err := m.networkManager.NameExists(ctx, name, "")
if err != nil {
return fmt.Errorf("check instance name availability: %w", err)
}
if exists {
return fmt.Errorf("%w: instance name '%s' already exists in network", ErrAlreadyExists, name)
}
}
return nil
}
func (m *manager) saveSnapshotRecord(rec *snapshotRecord) error {
if err := snapshotstore.SaveTypedRecord(m.snapshotStore(), &snapshotstore.TypedRecord[StoredMetadata]{
Snapshot: rec.Snapshot,
StoredMetadata: rec.StoredMetadata,
}); err != nil {
return err
}
return nil
}
func (m *manager) loadSnapshotRecord(snapshotID string) (*snapshotRecord, error) {
record, err := snapshotstore.LoadTypedRecord[StoredMetadata](m.snapshotStore(), snapshotID)
if err != nil {
if errors.Is(err, snapshotstore.ErrNotFound) {
return nil, ErrSnapshotNotFound
}
return nil, err
}
return &snapshotRecord{
Snapshot: record.Snapshot,
StoredMetadata: record.StoredMetadata,
}, nil
}
func (m *manager) listSnapshotRecords() ([]snapshotRecord, error) {
storedRecords, err := snapshotstore.ListTypedRecords[StoredMetadata](m.snapshotStore())
if err != nil {
return nil, err
}
records := make([]snapshotRecord, 0, len(storedRecords))
for _, stored := range storedRecords {
records = append(records, snapshotRecord{
Snapshot: stored.Snapshot,
StoredMetadata: stored.StoredMetadata,
})
}
return records, nil
}
func (m *manager) countSnapshotForks(snapshotID string) (int, error) {
counts, err := m.snapshotForkCounts()
if err != nil {
return 0, err
}
return counts[snapshotID], nil
}
func (m *manager) snapshotForkCounts() (map[string]int, error) {
metaFiles, err := m.listMetadataFiles()
if err != nil {
return nil, err
}
counts := make(map[string]int)
for _, metaPath := range metaFiles {
content, err := os.ReadFile(metaPath)
if err != nil {
return nil, fmt.Errorf("read instance metadata %s: %w", metaPath, err)
}
var meta metadata
if err := json.Unmarshal(content, &meta); err != nil {
return nil, fmt.Errorf("unmarshal instance metadata %s: %w", metaPath, err)
}
if meta.ForkOfSnapshot != "" {
counts[meta.ForkOfSnapshot]++
}
}
return counts, nil
}
func snapshotMemHardlinkSource(srcDir string) (absPath, relSlash string, ok bool) {
abs, found := findRawSnapshotMemoryFile(srcDir)
if !found {
return "", "", false
}
rel, err := filepath.Rel(srcDir, abs)
if err != nil {
return "", "", false
}
return abs, filepath.ToSlash(rel), true
}
func installForkSnapshotMemHardlink(srcMemPath, dstDir, relSlash string) error {
dstMem := filepath.Join(dstDir, filepath.FromSlash(relSlash))
if err := os.MkdirAll(filepath.Dir(dstMem), 0755); err != nil {
return fmt.Errorf("ensure fork mem-file parent dir: %w", err)
}
_ = os.Remove(dstMem)
if err := os.Link(srcMemPath, dstMem); err != nil {
return fmt.Errorf("link snapshot mem-file: %w", err)
}
return nil
}