-
Notifications
You must be signed in to change notification settings - Fork 1
/
vm.go
715 lines (608 loc) · 17.7 KB
/
vm.go
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
package minivmm
import (
"context"
"crypto/rand"
"encoding/base64"
"encoding/json"
"fmt"
"log"
"os"
"path/filepath"
"strings"
"syscall"
"text/template"
"time"
"github.com/pkg/errors"
"github.com/yaamai/govmm/qemu"
)
var (
qmpSocketFileName = "qmp.socket"
vncSocketFileName = "vnc.socket"
vmMetaDataFileName = "metadata.json"
cloudInitISOFileName = "cloud-init.iso"
cloudInitUserDataFileName = "user-data"
cloudInitMetaDataFileName = "meta-data"
// VMIPAddressUpdateChan is a channel to update IP address by DHCP server
VMIPAddressUpdateChan = make(chan *VMMetaData)
)
var vmIFSetupScriptTemplate = `#!/bin/sh
if_name=$1
sudo ip link set dev $if_name netns minivmm
sudo ip netns exec minivmm ip link set dev $if_name master br-minivmm
sudo ip netns exec minivmm ip link set dev $if_name promisc on
sudo ip netns exec minivmm ip link set dev $if_name up
`
var vmIFCleanupScriptTemplate = `#!/bin/sh
if_name=$1
sudo ip netns exec minivmm ip link set dev $if_name down
sudo ip netns exec minivmm ip link set dev $if_name promisc off
sudo ip netns exec minivmm ip link set dev $if_name nomaster
sudo ip netns exec minivmm ip link set dev $if_name netns 1
`
// VMMetaData is VM's metadata.
type VMMetaData struct {
Name string `json:"name"`
Status string `json:"status"`
Owner string `json:"owner"`
Image string `json:"image"`
Arch string `json:"arch"`
Volume string `json:"volume"`
MacAddress string `json:"mac_address"`
IPAddress string `json:"ip_address"`
CPU string `json:"cpu"`
Memory string `json:"memory"`
Disk string `json:"disk"`
Tag string `json:"tag"`
Lock bool `json:"lock"`
VNCPassword string `json:"vnc_password"`
UserData string `json:"user_data"`
CloudInitIso string `json:"cloud_init_iso"`
ExtraVolumes []ExtraVolume `json:"extra_volumes"`
}
// ExtraVolume is extra volume's metadata
type ExtraVolume struct {
Name string `json:"name"`
Path string `json:"path"`
Size string `json:"size"`
}
func exists(filename string) bool {
_, err := os.Stat(filename)
return err == nil
}
func prepareVMIF(ifName string) error {
return Execs([][]string{
{"sudo", "ip", "tuntap", "add", "dev", ifName, "mode", "tap"},
})
}
func cleanupVMIF(ifName string) error {
return Execs([][]string{
{"sudo", "ip", "link", "del", "dev", ifName},
})
}
func isExistsVMIF(ifName string) bool {
err := Execs([][]string{
{"sudo", "ip", "netns", "exec", "minivmm", "ip", "link", "show", "dev", ifName},
})
if err == nil {
return true
}
err = Execs([][]string{
{"sudo", "ip", "link", "show", "dev", ifName},
})
if err == nil {
return true
}
// FIXME: extend Execs and check return-code instead of error message check
return !strings.Contains(err.Error(), "does not exist.")
}
func getMachineArch() (string, error) {
u := syscall.Utsname{}
err := syscall.Uname(&u)
if err != nil {
return "", err
}
var m string
for _, val := range u.Machine {
if int(val) == 0 {
continue
}
m += string(int(val))
}
return m, nil
}
func getMachineArchFromMetaData(metaData *VMMetaData) string {
if metaData.Arch != "" {
return metaData.Arch
}
arch, err := getMachineArch()
if err == nil {
return arch
}
log.Println(err)
return "x86_64"
}
func generateQemuParams(qmpSocketPath, vncSocketPath, driveFilePath, machineArch, cloudInitISOPath, vmMACAddr, vmIFName, cpu, memory string, extraVolumes []string) []string {
params := make([]string, 0, 32)
if !C.NoKvm {
params = append(params, "--enable-kvm")
params = append(params, "-cpu", "host")
}
envVNCKeyboardLayout := C.VNCKeyboardLayout
params = append(params, "-drive", fmt.Sprintf("file=%s,if=virtio,cache=none,aio=threads,format=qcow2", driveFilePath))
if extraVolumes != nil {
for _, vol := range extraVolumes {
params = append(params, "-drive", fmt.Sprintf("file=%s,if=virtio,cache=none,aio=threads,format=qcow2", vol))
}
}
if machineArch == "aarch64" {
params = append(params, "-machine", "virt")
params = append(params, "-bios", "/usr/share/qemu-efi-aarch64/QEMU_EFI.fd")
}
params = append(params, "-cdrom", cloudInitISOPath)
params = append(params, "-net", fmt.Sprintf("nic,model=virtio,macaddr=%s", vmMACAddr))
params = append(params, "-net", fmt.Sprintf("tap,ifname=%s,script=/tmp/ifup,downscript=/tmp/ifdown", vmIFName))
params = append(params, "-daemonize")
params = append(params, "-qmp", fmt.Sprintf("unix:%s,server,nowait", qmpSocketPath))
params = append(params, "-m", memory, "-smp", fmt.Sprintf("cpus=%s", cpu))
params = append(params, "-vnc", fmt.Sprintf("unix:%s", vncSocketPath))
params = append(params, "-k", envVNCKeyboardLayout)
return params
}
func generateMACAddress() string {
vendor := "52:54:00"
buf := make([]byte, 3)
rand.Read(buf)
return fmt.Sprintf("%s:%02x:%02x:%02x", vendor, buf[0], buf[1], buf[2])
}
func generateVMIFSetupScript(path string) error {
f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0755)
if err != nil {
return err
}
defer f.Close()
t := template.Must(template.New("ifscript").Parse(vmIFSetupScriptTemplate))
err = t.Execute(f, nil)
if err != nil {
return err
}
return nil
}
func generateVMIFCleanupScript(path string) error {
f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0755)
if err != nil {
return err
}
defer f.Close()
t := template.Must(template.New("ifscript").Parse(vmIFCleanupScriptTemplate))
err = t.Execute(f, nil)
if err != nil {
return err
}
return nil
}
func initQMP(qmpSocketPath string) (*qemu.QMP, chan struct{}, error) {
disconnectedCh := make(chan struct{})
cfg := qemu.QMPConfig{}
q, _, err := qemu.QMPStart(context.Background(), qmpSocketPath, cfg, disconnectedCh)
if err != nil {
return nil, nil, err
}
// must call capabilities check cmd (if missing, following method will fail)
err = q.ExecuteQMPCapabilities(context.Background())
if err != nil {
return nil, nil, err
}
return q, disconnectedCh, nil
}
func getQMPSocketPath(name string) string {
return filepath.Join(C.VMDir, name, qmpSocketFileName)
}
func getVNCSocketPath(name string) string {
return filepath.Join(C.VMDir, name, vncSocketFileName)
}
func generateRandomPassword() (string, error) {
b := make([]byte, 8)
_, err := rand.Read(b)
if err != nil {
return "", err
}
return base64.URLEncoding.EncodeToString(b), err
}
// NOTE: QMP command 'query-vnc' can only return a path of the unix domain socket
// as a string of up to 31 chars (maybe bug), so removed this function.
// func GetVncPort(name string) (string, error) {
// }
func saveVMMetaData(name string, metaData *VMMetaData) error {
metaDataByte, err := json.Marshal(metaData)
if err != nil {
return err
}
vmDataDir := filepath.Join(C.VMDir, name)
os.MkdirAll(vmDataDir, os.ModePerm)
metaDataPath := filepath.Join(vmDataDir, vmMetaDataFileName)
f, err := os.OpenFile(metaDataPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
if err != nil {
return err
}
defer f.Close()
lockpath := filepath.Join(vmDataDir, vmMetaDataFileName+".lock")
err = WriteWithLock(f, lockpath, metaDataByte)
if err != nil {
return err
}
return nil
}
func loadVMMetaData(name string) (*VMMetaData, error) {
metaDataPath := filepath.Join(C.VMDir, name, vmMetaDataFileName)
vmMetaData := VMMetaData{}
metaDataByte, err := os.ReadFile(metaDataPath)
if err != nil {
return nil, err
}
json.Unmarshal(metaDataByte, &vmMetaData)
return &vmMetaData, nil
}
func createCloudInitISO(cloudInitFilesPath, isoPath, name, userData string) error {
// write userdata
userDataPath := filepath.Join(cloudInitFilesPath, cloudInitUserDataFileName)
userDataFile, err := os.OpenFile(userDataPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
if err != nil {
return err
}
defer userDataFile.Close()
userDataFile.Write([]byte(userData))
// write metadata
// maybe cloud-init require meta-data file exists
metaDataPath := filepath.Join(cloudInitFilesPath, cloudInitMetaDataFileName)
metaDataFile, err := os.OpenFile(metaDataPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
if err != nil {
return err
}
defer metaDataFile.Close()
metaData := fmt.Sprintf("local-hostname: %s", name)
metaDataFile.Write([]byte(metaData))
err = Execs([][]string{
{"genisoimage", "-output", isoPath, "-volid", "cidata", "-joliet", "-rock", userDataPath, metaDataPath},
})
return err
}
// CreateVM creates new VM and starts it.
func CreateVM(name, owner, imageName, cpu, memory, disk, userData, tag string) (ret *VMMetaData, retErr error) {
if exists(filepath.Join(C.VMDir, name, vmMetaDataFileName)) {
return nil, errors.Errorf("CreateVM: VM '%s' already exists", name)
}
defer func() {
if retErr != nil && name != "" {
rmErr := os.RemoveAll(filepath.Join(C.VMDir, name))
if rmErr != nil {
log.Println("Ignore RemoveAll error:", rmErr)
}
}
}()
vmDataDir := filepath.Join(C.VMDir, name)
driveFilePath, err := CreateImage(name, disk, imageName, vmDataDir)
if err != nil {
return nil, err
}
// to support cloud-init, generate userdata ISO
isoFilePath := filepath.Join(C.VMDir, name, cloudInitISOFileName)
userDataPath := filepath.Join(C.VMDir, name)
err = createCloudInitISO(userDataPath, isoFilePath, name, userData)
if err != nil {
return nil, err
}
vmMACAddr := generateMACAddress()
password, _ := generateRandomPassword()
machineArch, err := getMachineArch()
if err != nil {
log.Println(err)
machineArch = "x86_64"
}
metaData := &VMMetaData{
Name: name,
Owner: owner,
Image: imageName,
Arch: machineArch,
Volume: driveFilePath,
MacAddress: vmMACAddr,
CPU: cpu,
Memory: memory,
Disk: disk,
Tag: tag,
Lock: false,
VNCPassword: password,
UserData: userData,
CloudInitIso: isoFilePath,
}
err = saveVMMetaData(name, metaData)
if err != nil {
return nil, err
}
metaData, err = StartVM(name)
if err != nil {
return nil, err
}
// Save metadata again because some parameters will be updated when VM starts
err = saveVMMetaData(name, metaData)
if err != nil {
return nil, err
}
return metaData, nil
}
// StopVM shuts down VM.
func StopVM(name string) error {
status := getVMStatus(name)
if status == "stopped" {
// VM has already stopped
return nil
}
q, disconnectedCh, err := initQMP(getQMPSocketPath(name))
if err != nil {
return errors.Wrap(err, "StopVM: QMP connection cannot established")
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
err = q.ExecuteSystemPowerdown(ctx)
cancel()
if err != nil {
err = q.ExecuteQuit(context.Background())
if err != nil {
return errors.Wrap(err, "StopVM: ExecuteQuit failed")
}
}
q.Shutdown()
<-disconnectedCh
return nil
}
func prepareStartVM(name string, metaData *VMMetaData) ([]string, error) {
qmpSocketPath := getQMPSocketPath(name)
vncSocketPath := getVNCSocketPath(name)
driveFilePath := metaData.Volume
machineArch := getMachineArchFromMetaData(metaData)
cloudInitISOPath := metaData.CloudInitIso
vmMACAddr := metaData.MacAddress
cpu := metaData.CPU
memory, err := ConvertSIPrefixedValue(metaData.Memory, "mebi")
if err != nil {
return nil, err
}
extraVolumes := []string{}
if metaData.ExtraVolumes != nil {
for _, vol := range metaData.ExtraVolumes {
extraVolumes = append(extraVolumes, vol.Path)
}
}
vmIFName := fmt.Sprintf("tap-%s", name)
prepareVMIF(vmIFName)
qemuParams := generateQemuParams(qmpSocketPath, vncSocketPath, driveFilePath, machineArch, cloudInitISOPath, vmMACAddr, vmIFName, cpu, memory, extraVolumes)
log.Println("Prepare if script ...")
err = generateVMIFSetupScript("/tmp/ifup")
if err != nil {
return nil, errors.Wrap(err, "StartVM: VM interface setup script generate failed")
}
err = generateVMIFCleanupScript("/tmp/ifdown")
if err != nil {
return nil, errors.Wrap(err, "StartVM: VM interface setup script generate failed")
}
log.Println("Launching vm with: ", driveFilePath, qmpSocketFileName, qemuParams)
return qemuParams, nil
}
// StartVM starts VM.
func StartVM(name string) (*VMMetaData, error) {
metaData, err := loadVMMetaData(name)
if err != nil {
return nil, errors.Wrap(err, "StartVM: VM metadata load failed")
}
status := getVMStatus(name)
if status != "stopped" {
return nil, errors.New("Cannot start non-stopped VM")
}
qemuBinaryName := "qemu-system-" + getMachineArchFromMetaData(metaData)
qemuParams, err := prepareStartVM(name, metaData)
stdErr, err := qemu.LaunchCustomQemu(context.Background(), qemuBinaryName, qemuParams, nil, nil, nil)
if err != nil {
log.Println(stdErr)
return nil, errors.Wrap(err, "StartVM: VM launch failed")
}
return metaData, nil
}
// ResizeVM updates the size metadata of VM.
func ResizeVM(name, cpu, memory, disk string) (*VMMetaData, error) {
metaData, err := GetVM(name)
if err != nil {
return nil, errors.Wrap(err, "ResizeVM: Failed to get VM metadata")
}
if cpu != "" {
metaData.CPU = cpu
}
if memory != "" {
metaData.Memory = memory
}
if disk != "" {
metaData.Disk = disk
}
err = saveVMMetaData(name, metaData)
if err != nil {
return nil, err
}
return metaData, nil
}
// LockVM lock the VM to prevent from some operations.
func LockVM(name string) (*VMMetaData, error) {
return setVMLock(name, true)
}
// UnlockVM unlock the VM.
func UnlockVM(name string) (*VMMetaData, error) {
return setVMLock(name, false)
}
func setVMLock(name string, lock bool) (*VMMetaData, error) {
metaData, err := GetVM(name)
if err != nil {
return nil, errors.Wrap(err, "setVMLock: Failed to get VM metadata")
}
metaData.Lock = lock
err = saveVMMetaData(name, metaData)
if err != nil {
return nil, err
}
return metaData, nil
}
// AddVolume adds a new extra volume to the VM
func AddVolume(name, size string) (*VMMetaData, error) {
metaData, err := GetVM(name)
if err != nil {
return nil, errors.Wrap(err, "AddVolume: Failed to get VM metadata")
}
loop:
for i := 1; i <= 256; i++ {
imageName := fmt.Sprintf("extra-volume%d", i)
for _, vol := range metaData.ExtraVolumes {
if imageName == vol.Name {
continue loop
}
}
vmDataDir := filepath.Join(C.VMDir, name)
path, err := CreateImage(imageName, size, "", vmDataDir)
if err != nil {
return nil, errors.Wrap(err, "AddVolume: Failed to create image")
}
ev := ExtraVolume{Name: imageName, Path: path, Size: size}
metaData.ExtraVolumes = append(metaData.ExtraVolumes, ev)
err = saveVMMetaData(name, metaData)
if err != nil {
os.Remove(path)
return nil, err
}
return metaData, nil
}
return nil, errors.New("The maximum number of extra volumes is 256")
}
// RemoveVolume removes a extra volume from the VM
func RemoveVolume(name, volName string) (*VMMetaData, error) {
metaData, err := GetVM(name)
if err != nil {
return nil, errors.Wrap(err, "RemoveVolume: Failed to get VM metadata")
}
if metaData.Lock {
return nil, errors.New("VM is locked")
}
for i, vol := range metaData.ExtraVolumes {
if volName == vol.Name {
os.Remove(vol.Path)
metaData.ExtraVolumes = append(metaData.ExtraVolumes[:i], metaData.ExtraVolumes[i+1:]...)
err = saveVMMetaData(name, metaData)
if err != nil {
return nil, err
}
return metaData, nil
}
}
return nil, fmt.Errorf("Cannot remove '%s'. No such a image file", volName)
}
func getVMStatus(name string) string {
// VM status not saved in metadata
q, _, err := initQMP(getQMPSocketPath(name))
if err != nil {
return "stopped"
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
statusInfo, err := q.ExecuteQueryStatus(ctx)
cancel()
if err != nil {
log.Println("getVMStatus: ", err)
return "unknown"
}
q.Shutdown()
return statusInfo.Status
}
// GetVM returns VM metadata.
func GetVM(name string) (*VMMetaData, error) {
metaData, err := loadVMMetaData(name)
if err != nil {
return nil, err
}
status := getVMStatus(name)
metaData.Status = status
return metaData, nil
}
// GetVMFromMac returns VM metadata.
func GetVMFromMac(mac string) (*VMMetaData, error) {
metaDataList, err := ListVMs()
if err != nil {
return nil, err
}
for _, metaData := range metaDataList {
if metaData.MacAddress == mac {
return metaData, nil
}
}
return nil, fmt.Errorf("GetVMFromMac: Cannot find vm with '%s'", mac)
}
// ListVMs returns a list of VM metadata.
func ListVMs() ([]*VMMetaData, error) {
dirEntries, err := os.ReadDir(C.VMDir)
if err != nil {
return nil, errors.Wrap(err, "ListVMs: Cannot read vm data dir")
}
var ret []*VMMetaData
for _, f := range dirEntries {
if f.IsDir() {
m, err := GetVM(f.Name())
if err != nil {
log.Println("Ignore GetVM error:", err)
continue
}
ret = append(ret, m)
}
}
return ret, nil
}
// UpdateIPAddress updates IP address in VM metadata.
func UpdateIPAddress() {
for {
r := <-VMIPAddressUpdateChan
e, err := GetVMFromMac(r.MacAddress)
if err != nil {
log.Println("Ignore GetVMFromMac error:", err)
continue
}
e.IPAddress = r.IPAddress
err = saveVMMetaData(e.Name, e)
if err != nil {
log.Println("Ignore saveVMMetaData error:", err)
continue
}
UpdateIPAddressInForwarder(e.Name, r.IPAddress)
}
}
// RemoveVM remove VM
func RemoveVM(name string) error {
metaData, err := GetVM(name)
if err != nil {
return errors.Wrap(err, "RemoveVM: Failed to get VM metadata")
}
if metaData.Lock {
return errors.New("VM is locked")
}
err = StopVM(name)
if err != nil {
return err
}
vmIFName := fmt.Sprintf("tap-%s", name)
if isExistsVMIF(vmIFName) {
retryCount := 0
for {
if retryCount > 30 {
return errors.New("VM tap deletion timed out")
}
err = cleanupVMIF(vmIFName)
if err == nil {
break
}
time.Sleep(3 * time.Second)
retryCount = retryCount + 1
}
}
vmDataDir := filepath.Join(C.VMDir, name)
err = os.RemoveAll(vmDataDir)
return err
}