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 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
|
package qmp
import (
"context"
"encoding/json"
"errors"
"fmt"
"net"
"net/http"
"os"
"strings"
"time"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/revert"
)
// ChardevChangeInfo contains information required to change the backend of a chardev.
type ChardevChangeInfo struct {
Type string `json:"type"`
File *os.File `json:"file,omitempty"`
FDName string `json:"fdname,omitempty"`
}
// FdsetFdInfo contains information about a file descriptor that belongs to an FD set.
type FdsetFdInfo struct {
FD int `json:"fd"`
Opaque string `json:"opaque"`
}
// FdsetInfo contains information about an FD set.
type FdsetInfo struct {
ID int `json:"fdset-id"`
FDs []FdsetFdInfo `json:"fds"`
}
// AddFdInfo contains information about a file descriptor that was added to an fd set.
type AddFdInfo struct {
ID int `json:"fdset-id"`
FD int `json:"fd"`
}
// CPUInstanceProperties contains CPU instance properties.
type CPUInstanceProperties struct {
NodeID int `json:"node-id,omitempty"`
SocketID int `json:"socket-id,omitempty"`
DieID int `json:"die-id,omitempty"`
ClusterID int `json:"cluster-id,omitempty"`
CoreID int `json:"core-id,omitempty"`
ThreadID int `json:"thread-id,omitempty"`
}
// CPU contains information about a CPU.
type CPU struct {
Index int `json:"cpu-index,omitempty"`
QOMPath string `json:"qom-path,omitempty"`
ThreadID int `json:"thread-id,omitempty"`
Target string `json:"target,omitempty"`
Props CPUInstanceProperties `json:"props"`
}
// HotpluggableCPU contains information about a hotpluggable CPU.
type HotpluggableCPU struct {
Type string `json:"type"`
VCPUsCount int `json:"vcpus-count"`
QOMPath string `json:"qom-path,omitempty"`
Props CPUInstanceProperties `json:"props"`
}
// CPUModel contains information about a CPU model.
type CPUModel struct {
Name string `json:"name"`
Flags map[string]any `json:"props"`
}
// MemoryDevice contains information about a memory device.
type MemoryDevice struct {
Type string `json:"type"`
Data json.RawMessage `json:"data"`
}
// PCDimmDevice contains information about a memory device of type pc-dimm.
type PCDimmDevice struct {
ID string `json:"id"`
Addr uint64 `json:"addr"`
Slot int `json:"slot"`
Node int `json:"node"`
Memdev string `json:"memdev"`
Hotpluggable bool `json:"hotpluggable"`
Hotplugged bool `json:"hotplugged"`
}
// MemDev contains information about a memory device.
type MemDev struct {
ID string `json:"id"`
Size int `json:"size"`
Merge bool `json:"merge"`
Dump bool `json:"dump"`
Prealloc bool `json:"prealloc"`
Share bool `json:"share"`
Reserve bool `json:"reserve"`
HostNodes []int `json:"host-nodes"`
}
// MigrationStatus contains information about the ongoing migration.
type MigrationStatus struct {
Status string `json:"status"`
RAM struct {
Transferred int64 `json:"transferred"`
Remaining int64 `json:"remaining"`
Total int64 `json:"total"`
Duplicate int64 `json:"duplicate"`
Normal int64 `json:"normal"`
NormalBytes int64 `json:"normal-bytes"`
DirtyPagesRate int64 `json:"diry-pages-rate"`
MBps float64 `json:"mbps"`
DirtySyncCount int64 `json:"diry-sync-count"`
PostcopyRequests int64 `json:"postcopy-requests"`
PageSize int64 `json:"page-size"`
MultiFDBytes int64 `json:"multifd-bytes"`
PagesPerSecond int64 `json:"pages-per-second"`
PrecopyBytes int64 `json:"precopy-bytes"`
DowntimeBytes int64 `json:"downtime-bytes"`
PostcopyBytes int64 `json:"postcopy-bytes"`
DirtySyncMissedZeroCopy int64 `json:"diry-sync-missed-zero-copy"`
} `json:"ram"`
TotalTime int64 `json:"total-time"`
DownTime int64 `json:"down-time"`
ExpectedDowntime int64 `json:"expected-downtime"`
SetupTime int64 `json:"setup-time"`
CPUThrottlePercentage int64 `json:"cpu-throttle-percentage"`
PostcopyBlocktime int64 `json:"postcopy-blocktime"`
PostcopyVCPUBlocktime []int64 `json:"postcopy-vcpu-blocktime"`
DirtyLimitThrottleTimePerRound int64 `json:"dirty-limit-throttle-time-per-round"`
DirtyLimitRingFullTime int64 `json:"dirty-limit-ring-full-time"`
}
// QueryCPUs returns a list of CPUs.
func (m *Monitor) QueryCPUs() ([]CPU, error) {
// Prepare the response.
var resp struct {
Return []CPU `json:"return"`
}
err := m.Run("query-cpus-fast", nil, &resp)
if err != nil {
return nil, fmt.Errorf("Failed to query CPUs: %w", err)
}
return resp.Return, nil
}
// QueryHotpluggableCPUs returns a list of hotpluggable CPUs.
func (m *Monitor) QueryHotpluggableCPUs() ([]HotpluggableCPU, error) {
// Prepare the response.
var resp struct {
Return []HotpluggableCPU `json:"return"`
}
err := m.Run("query-hotpluggable-cpus", nil, &resp)
if err != nil {
return nil, fmt.Errorf("Failed to query hotpluggable CPUs: %w", err)
}
return resp.Return, nil
}
// QueryCPUModel returns a CPUModel for the specified model name.
func (m *Monitor) QueryCPUModel(model string) (*CPUModel, error) {
// Prepare the response.
var resp struct {
Return struct {
Model CPUModel `json:"model"`
} `json:"return"`
}
args := map[string]any{
"model": map[string]string{"name": model},
"type": "full",
}
err := m.Run("query-cpu-model-expansion", args, &resp)
if err != nil {
return nil, fmt.Errorf("Failed to query CPU model: %w", err)
}
return &resp.Return.Model, nil
}
// Status returns the current VM status.
func (m *Monitor) Status() (string, error) {
// Prepare the response.
var resp struct {
Return struct {
Status string `json:"status"`
} `json:"return"`
}
// Query the status.
err := m.Run("query-status", nil, &resp)
if err != nil {
return "", err
}
return resp.Return.Status, nil
}
// MachineDefinition returns the current QEMU machine definition name.
func (m *Monitor) MachineDefinition() (string, error) {
// Prepare the request.
var req struct {
Path string `json:"path"`
Property string `json:"property"`
}
req.Path = "/machine"
req.Property = "type"
// Prepare the response.
var resp struct {
Return string `json:"return"`
}
// Query the machine.
err := m.Run("qom-get", req, &resp)
if err != nil {
return "", err
}
return strings.TrimSuffix(resp.Return, "-machine"), nil
}
// SendFile adds a new file descriptor to the QMP fd table associated to name.
func (m *Monitor) SendFile(name string, file *os.File) error {
// Check if disconnected.
if m.disconnected {
return ErrMonitorDisconnect
}
id := m.qmp.qmpIncreaseID()
req := &qmpCommand{
ID: id,
Execute: "getfd",
Arguments: map[string]any{"fdname": name},
}
reqJSON, err := json.Marshal(req)
if err != nil {
return err
}
// Query the status.
_, err = m.qmp.runWithFile(reqJSON, file, id)
if err != nil {
// Confirm the daemon didn't die.
errPing := m.ping()
if errPing != nil {
return errPing
}
return err
}
return nil
}
// CloseFile closes an existing file descriptor in the QMP fd table associated to name.
func (m *Monitor) CloseFile(name string) error {
var req struct {
FDName string `json:"fdname"`
}
req.FDName = name
err := m.Run("closefd", req, nil)
if err != nil {
return err
}
return nil
}
// SendFileWithFDSet adds a new file descriptor to an FD set.
func (m *Monitor) SendFileWithFDSet(name string, file *os.File, readonly bool) (*AddFdInfo, error) {
// Check if disconnected.
if m.disconnected {
return nil, ErrMonitorDisconnect
}
permissions := "rdwr"
if readonly {
permissions = "rdonly"
}
id := m.qmp.qmpIncreaseID()
req := &qmpCommand{
ID: id,
Execute: "add-fd",
Arguments: map[string]any{
"opaque": fmt.Sprintf("%s:%s", permissions, name),
},
}
reqJSON, err := json.Marshal(req)
if err != nil {
return nil, err
}
ret, err := m.qmp.runWithFile(reqJSON, file, id)
if err != nil {
// Confirm the daemon didn't die.
errPing := m.ping()
if errPing != nil {
return nil, errPing
}
return nil, err
}
// Prepare the response.
var resp struct {
Return AddFdInfo `json:"return"`
}
err = json.Unmarshal(ret, &resp)
if err != nil {
return nil, err
}
return &resp.Return, nil
}
// RemoveFDFromFDSet removes an FD with the given name from an FD set.
func (m *Monitor) RemoveFDFromFDSet(name string) error {
// Prepare the response.
var resp struct {
Return []FdsetInfo `json:"return"`
}
err := m.Run("query-fdsets", nil, &resp)
if err != nil {
return fmt.Errorf("Failed to query fd sets: %w", err)
}
for _, fdSet := range resp.Return {
for _, fd := range fdSet.FDs {
fields := strings.SplitN(fd.Opaque, ":", 2)
opaque := ""
if len(fields) == 2 {
opaque = fields[1]
} else {
opaque = fields[0]
}
if opaque == name {
args := map[string]any{
"fdset-id": fdSet.ID,
}
err = m.Run("remove-fd", args, nil)
if err != nil {
return fmt.Errorf("Failed to remove fd from fd set: %w", err)
}
}
}
}
return nil
}
// MigrateSetCapabilities sets the capabilities used during migration.
func (m *Monitor) MigrateSetCapabilities(caps map[string]bool) error {
var args struct {
Capabilities []struct {
Capability string `json:"capability"`
State bool `json:"state"`
} `json:"capabilities"`
}
for capName, state := range caps {
args.Capabilities = append(args.Capabilities, struct {
Capability string `json:"capability"`
State bool `json:"state"`
}{
Capability: capName,
State: state,
})
}
err := m.Run("migrate-set-capabilities", args, nil)
if err != nil {
return err
}
return nil
}
// MigrateSetParameters sets the parameters used during migration.
func (m *Monitor) MigrateSetParameters(parameters map[string]any) error {
err := m.Run("migrate-set-parameters", parameters, nil)
if err != nil {
return err
}
return nil
}
// Migrate starts a migration stream.
func (m *Monitor) Migrate(name string) error {
// Query the status.
type migrateArgsChannel struct {
ChannelType string `json:"channel-type"`
Address map[string]string `json:"addr"`
}
type migrateArgs struct {
Channels []migrateArgsChannel `json:"channels"`
}
args := migrateArgs{}
args.Channels = []migrateArgsChannel{{
ChannelType: "main",
Address: map[string]string{
"transport": "socket",
"type": "fd",
"str": name,
},
}}
err := m.Run("migrate", args, nil)
if err != nil {
return err
}
return nil
}
// QueryMigrate gets the current migration status.
func (m *Monitor) QueryMigrate() (*MigrationStatus, error) {
var resp struct {
Return MigrationStatus `json:"return"`
}
err := m.Run("query-migrate", nil, &resp)
if err != nil {
return nil, err
}
return &resp.Return, nil
}
// MigrateWait waits until migration job reaches the specified status.
// Returns nil if the migraton job reaches the specified status or an error if the migration job is in the failed
// status.
func (m *Monitor) MigrateWait(state string) error {
// Wait until it completes or fails.
for {
// Prepare the response.
var resp struct {
Return struct {
Status string `json:"status"`
} `json:"return"`
}
err := m.Run("query-migrate", nil, &resp)
if err != nil {
return err
}
if resp.Return.Status == "failed" {
return errors.New("Migrate call failed")
}
if resp.Return.Status == state {
return nil
}
time.Sleep(1 * time.Second)
}
}
// MigrateContinue continues a migration stream.
func (m *Monitor) MigrateContinue(fromState string) error {
var args struct {
State string `json:"state"`
}
args.State = fromState
err := m.Run("migrate-continue", args, nil)
if err != nil {
return err
}
return nil
}
// MigrateIncoming starts the receiver of a migration stream.
func (m *Monitor) MigrateIncoming(ctx context.Context, name string) error {
type migrateArgsChannel struct {
ChannelType string `json:"channel-type"`
Address map[string]string `json:"addr"`
}
type migrateArgs struct {
Channels []migrateArgsChannel `json:"channels"`
}
args := migrateArgs{}
args.Channels = []migrateArgsChannel{{
ChannelType: "main",
Address: map[string]string{
"transport": "socket",
"type": "fd",
"str": name,
},
}}
// Query the status.
err := m.Run("migrate-incoming", args, nil)
if err != nil {
return err
}
// Wait until it completes or fails.
for {
// Prepare the response.
var resp struct {
Return struct {
Status string `json:"status"`
} `json:"return"`
}
err := m.Run("query-migrate", nil, &resp)
if err != nil {
return err
}
if resp.Return.Status == "failed" {
return errors.New("Migrate incoming call failed")
}
if resp.Return.Status == "completed" {
return nil
}
// Check context is cancelled last after checking job status.
// This way if the context is cancelled when the migration stream is ended this gives a chance to
// check for job success/failure before checking if the context has been cancelled.
err = ctx.Err()
if err != nil {
return err
}
time.Sleep(1 * time.Second)
}
}
// Powerdown tells the VM to gracefully shutdown.
func (m *Monitor) Powerdown() error {
return m.Run("system_powerdown", nil, nil)
}
// Start tells QEMU to start the emulation.
func (m *Monitor) Start() error {
return m.Run("cont", nil, nil)
}
// Pause tells QEMU to temporarily stop the emulation.
func (m *Monitor) Pause() error {
return m.Run("stop", nil, nil)
}
// Quit tells QEMU to exit immediately.
func (m *Monitor) Quit() error {
return m.Run("quit", nil, nil)
}
// GetCPUs fetches the vCPU information for pinning.
func (m *Monitor) GetCPUs() ([]int, error) {
// Prepare the response.
var resp struct {
Return []struct {
CPU int `json:"cpu-index"`
PID int `json:"thread-id"`
} `json:"return"`
}
// Query the consoles.
err := m.Run("query-cpus-fast", nil, &resp)
if err != nil {
return nil, err
}
// Make a slice of PIDs.
pids := []int{}
for _, cpu := range resp.Return {
pids = append(pids, cpu.PID)
}
return pids, nil
}
// GetMemorySizeBytes returns the current size of the base memory in bytes.
func (m *Monitor) GetMemorySizeBytes() (int64, error) {
// Prepare the response.
var resp struct {
Return struct {
BaseMemory int64 `json:"base-memory"`
} `json:"return"`
}
err := m.Run("query-memory-size-summary", nil, &resp)
if err != nil {
return -1, err
}
return resp.Return.BaseMemory, nil
}
// GetMemoryBalloonSizeBytes returns effective size of the memory in bytes (considering the current balloon size).
func (m *Monitor) GetMemoryBalloonSizeBytes() (int64, error) {
// Prepare the response.
var resp struct {
Return struct {
Actual int64 `json:"actual"`
} `json:"return"`
}
err := m.Run("query-balloon", nil, &resp)
if err != nil {
return -1, err
}
return resp.Return.Actual, nil
}
// SetMemoryBalloonSizeBytes sets the size of the memory in bytes (which will resize the balloon as needed).
func (m *Monitor) SetMemoryBalloonSizeBytes(sizeBytes int64) error {
args := map[string]int64{"value": sizeBytes}
return m.Run("balloon", args, nil)
}
// GetMemdev retrieves memory devices by executing the query-memdev QMP command.
func (m *Monitor) GetMemdev() ([]MemDev, error) {
// Prepare the response.
var resp struct {
Return []MemDev `json:"return"`
}
err := m.Run("query-memdev", nil, &resp)
if err != nil {
return nil, err
}
return resp.Return, nil
}
// GetMemoryDevices retrieves memory devices by executing the query-memory-devices QMP command.
func (m *Monitor) GetMemoryDevices() ([]MemoryDevice, error) {
// Prepare the response.
var resp struct {
Return []MemoryDevice `json:"return"`
}
err := m.Run("query-memory-devices", nil, &resp)
if err != nil {
return nil, err
}
return resp.Return, nil
}
// GetDimmDevices returns a list of memory devices of type pc-dimm.
func (m *Monitor) GetDimmDevices() ([]PCDimmDevice, error) {
devices, err := m.GetMemoryDevices()
if err != nil {
return nil, err
}
result := []PCDimmDevice{}
for _, dev := range devices {
if dev.Type != "dimm" {
continue
}
var dimmData PCDimmDevice
err := json.Unmarshal(dev.Data, &dimmData)
if err != nil {
continue
}
result = append(result, dimmData)
}
return result, nil
}
// AddObject adds a new object.
func (m *Monitor) AddObject(args map[string]any) error {
err := m.Run("object-add", &args, nil)
if err != nil {
return fmt.Errorf("Failed adding object: %w", err)
}
return nil
}
// AddBlockDevice adds a block device.
func (m *Monitor) AddBlockDevice(blockDev map[string]any, device map[string]any, attached bool) error {
if !attached {
return nil
}
reverter := revert.New()
defer reverter.Fail()
nodeName, ok := blockDev["node-name"].(string)
if !ok {
return errors.New("Device node name must be a string")
}
if blockDev != nil {
err := m.Run("blockdev-add", blockDev, nil)
if err != nil {
return fmt.Errorf("Failed adding block device: %w", err)
}
reverter.Add(func() {
_ = m.RemoveBlockDevice(nodeName)
})
}
err := m.AddDevice(device)
if err != nil {
return fmt.Errorf("Failed adding device: %w", err)
}
reverter.Success()
return nil
}
// RemoveBlockDevice removes a block device.
func (m *Monitor) RemoveBlockDevice(blockDevName string) error {
if blockDevName != "" {
blockDevName := map[string]string{
"node-name": blockDevName,
}
err := m.Run("blockdev-del", blockDevName, nil)
if err != nil {
if strings.Contains(err.Error(), "is in use") {
return api.StatusErrorf(http.StatusLocked, "%s", err.Error())
}
if strings.Contains(err.Error(), "Failed to find") {
return nil
}
return fmt.Errorf("Failed removing block device: %w", err)
}
}
return nil
}
// AddCharDevice adds a new character device.
func (m *Monitor) AddCharDevice(device map[string]any) error {
if device != nil {
err := m.Run("chardev-add", device, nil)
if err != nil {
return err
}
}
return nil
}
// RemoveCharDevice removes a character device.
func (m *Monitor) RemoveCharDevice(deviceID string) error {
if deviceID != "" {
deviceID := map[string]string{
"id": deviceID,
}
err := m.Run("chardev-remove", deviceID, nil)
if err != nil {
if strings.Contains(err.Error(), "not found") {
return nil
}
return err
}
}
return nil
}
// AddDevice adds a new device.
func (m *Monitor) AddDevice(device map[string]any) error {
if device != nil {
err := m.Run("device_add", device, nil)
if err != nil {
return err
}
}
return nil
}
// RemoveDevice removes a device.
func (m *Monitor) RemoveDevice(deviceID string) error {
if deviceID != "" {
deviceID := map[string]string{
"id": deviceID,
}
err := m.Run("device_del", deviceID, nil)
if err != nil {
if strings.Contains(err.Error(), "not found") {
return nil
}
return err
}
}
return nil
}
// AddNIC adds a NIC device.
func (m *Monitor) AddNIC(netDev map[string]any, device map[string]any) error {
reverter := revert.New()
defer reverter.Fail()
if netDev != nil {
err := m.Run("netdev_add", netDev, nil)
if err != nil {
return fmt.Errorf("Failed adding NIC netdev: %w", err)
}
reverter.Add(func() {
netDevDel := map[string]any{
"id": netDev["id"],
}
err = m.Run("netdev_del", netDevDel, nil)
if err != nil {
return
}
})
}
err := m.AddDevice(device)
if err != nil {
return fmt.Errorf("Failed adding NIC device: %w", err)
}
reverter.Success()
return nil
}
// RemoveNIC removes a NIC device.
func (m *Monitor) RemoveNIC(netDevID string) error {
if netDevID != "" {
netDevID := map[string]string{
"id": netDevID,
}
err := m.Run("netdev_del", netDevID, nil)
// Not all NICs need a netdev, so if its missing, its not a problem.
if err != nil && !strings.Contains(err.Error(), "not found") {
return fmt.Errorf("Failed removing NIC netdev: %w", err)
}
}
return nil
}
// SetAction sets the actions the VM will take for certain scenarios.
func (m *Monitor) SetAction(actions map[string]string) error {
err := m.Run("set-action", actions, nil)
if err != nil {
return fmt.Errorf("Failed setting actions: %w", err)
}
return nil
}
// Reset VM.
func (m *Monitor) Reset() error {
err := m.Run("system_reset", nil, nil)
if err != nil {
return fmt.Errorf("Failed resetting: %w", err)
}
return nil
}
// PCIClassInfo info about a device's class.
type PCIClassInfo struct {
Class int `json:"class"`
Description string `json:"desc"`
}
// PCIDevice represents a PCI device.
type PCIDevice struct {
DevID string `json:"qdev_id"`
Bus int `json:"bus"`
Slot int `json:"slot"`
Function int `json:"function"`
Devices []PCIDevice `json:"devices"`
Class PCIClassInfo `json:"class_info"`
Bridge PCIBridge `json:"pci_bridge"`
}
// PCIBridge represents a PCI bridge.
type PCIBridge struct {
Devices []PCIDevice `json:"devices"`
}
// QueryPCI returns info about PCI devices.
func (m *Monitor) QueryPCI() ([]PCIDevice, error) {
// Prepare the response.
var resp struct {
Return []struct {
Devices []PCIDevice `json:"devices"`
} `json:"return"`
}
err := m.Run("query-pci", nil, &resp)
if err != nil {
return nil, fmt.Errorf("Failed querying PCI devices: %w", err)
}
if len(resp.Return) > 0 {
return resp.Return[0].Devices, nil
}
return nil, nil
}
// BlockStats represents block device stats.
type BlockStats struct {
BytesWritten int `json:"wr_bytes"`
WritesCompleted int `json:"wr_operations"`
BytesRead int `json:"rd_bytes"`
ReadsCompleted int `json:"rd_operations"`
}
// GetBlockStats return block device stats.
func (m *Monitor) GetBlockStats() (map[string]BlockStats, error) {
// Prepare the response
var resp struct {
Return []struct {
Stats BlockStats `json:"stats"`
QDev string `json:"qdev"`
} `json:"return"`
}
err := m.Run("query-blockstats", nil, &resp)
if err != nil {
return nil, fmt.Errorf("Failed querying block stats: %w", err)
}
out := make(map[string]BlockStats)
for _, res := range resp.Return {
out[res.QDev] = res.Stats
}
return out, nil
}
// AddSecret adds a secret object with the given ID and secret. This function won't return an error
// if the secret object already exists.
func (m *Monitor) AddSecret(id string, secret string) error {
args := map[string]any{
"qom-type": "secret",
"id": id,
"data": secret,
"format": "base64",
}
err := m.Run("object-add", &args, nil)
if err != nil && !strings.Contains(err.Error(), "attempt to add duplicate property") {
return fmt.Errorf("Failed adding object: %w", err)
}
return nil
}
// AMDSEVCapabilities represents the SEV capabilities of QEMU.
type AMDSEVCapabilities struct {
PDH string `json:"pdh"` // Platform Diffie-Hellman key (base64-encoded)
CertChain string `json:"cert-chain"` // PDH certificate chain (base64-encoded)
CPU0Id string `json:"cpu0-id"` // Unique ID of CPU0 (base64-encoded)
CBitPos int `json:"cbitpos"` // C-bit location in page table entry
ReducedPhysBits int `json:"reduced-phys-bits"` // Number of physical address bit reduction when SEV is enabled
}
// SEVCapabilities is used to get the SEV capabilities, and is supported on AMD X86 platforms only.
func (m *Monitor) SEVCapabilities() (AMDSEVCapabilities, error) {
// Prepare the response
var resp struct {
Return AMDSEVCapabilities `json:"return"`
}
err := m.Run("query-sev-capabilities", nil, &resp)
if err != nil {
return AMDSEVCapabilities{}, fmt.Errorf("Failed querying SEV capability for QEMU: %w", err)
}
return resp.Return, nil
}
// NBDServerStart starts internal NBD server and returns a connection to it.
func (m *Monitor) NBDServerStart() (net.Conn, error) {
var args struct {
Addr struct {
Data struct {
Path string `json:"path"`
Abstract bool `json:"abstract"`
} `json:"data"`
Type string `json:"type"`
} `json:"addr"`
MaxConnections int `json:"max-connections"`
}
// Create abstract unix listener.
listener, err := net.Listen("unix", "")
if err != nil {
return nil, fmt.Errorf("Failed creating unix listener: %w", err)
}
// Get the random address, and then close the listener, and pass the address for use with nbd-server-start.
listenAddress := listener.Addr().String()
_ = listener.Close()
args.Addr.Type = "unix"
args.Addr.Data.Path = strings.TrimPrefix(listenAddress, "@")
args.Addr.Data.Abstract = true
args.MaxConnections = 1
err = m.Run("nbd-server-start", args, nil)
if err != nil {
return nil, err
}
// Connect to the NBD server and return the connection.
conn, err := net.Dial("unix", listenAddress)
if err != nil {
return nil, fmt.Errorf("Failed connecting to NBD server: %w", err)
}
return conn, nil
}
// NBDServerStop stops the internal NBD server.
func (m *Monitor) NBDServerStop() error {
err := m.Run("nbd-server-stop", nil, nil)
if err != nil {
return err
}
return nil
}
// NBDBlockExportAdd exports a writable device via the NBD server.
func (m *Monitor) NBDBlockExportAdd(deviceNodeName string) error {
var args struct {
ID string `json:"id"`
Type string `json:"type"`
NodeName string `json:"node-name"`
Writable bool `json:"writable"`
}
args.ID = deviceNodeName
args.Type = "nbd"
args.NodeName = deviceNodeName
args.Writable = true
err := m.Run("block-export-add", args, nil)
if err != nil {
return err
}
return nil
}
// BlockDevSnapshot creates a snapshot of a device using the specified snapshot device.
func (m *Monitor) BlockDevSnapshot(deviceNodeName string, snapshotNodeName string) error {
var args struct {
Node string `json:"node"`
Overlay string `json:"overlay"`
}
args.Node = deviceNodeName
args.Overlay = snapshotNodeName
err := m.Run("blockdev-snapshot", args, nil)
if err != nil {
return err
}
return nil
}
// blockJobWaitReady waits until the specified jobID is ready, errored or missing.
// Returns nil if the job is ready, otherwise an error.
func (m *Monitor) blockJobWaitReady(jobID string) error {
for {
var resp struct {
Return []struct {
Device string `json:"device"`
Ready bool `json:"ready"`
Error string `json:"error"`
} `json:"return"`
}
err := m.Run("query-block-jobs", nil, &resp)
if err != nil {
return err
}
found := false
for _, job := range resp.Return {
if job.Device != jobID {
continue
}
if job.Error != "" {
return fmt.Errorf("Failed block job: %s", job.Error)
}
if job.Ready {
return nil
}
found = true
}
if !found {
return errors.New("Specified block job not found")
}
time.Sleep(1 * time.Second)
}
}
// BlockCommit merges a snapshot device back into its parent device.
func (m *Monitor) BlockCommit(deviceNodeName string) error {
var args struct {
Device string `json:"device"`
JobID string `json:"job-id"`
}
args.Device = deviceNodeName
args.JobID = args.Device
err := m.Run("block-commit", args, nil)
if err != nil {
return err
}
err = m.blockJobWaitReady(args.JobID)
if err != nil {
return err
}
err = m.BlockJobComplete(args.JobID)
if err != nil {
return err
}
return nil
}
// BlockDevMirror mirrors the top device to the target device.
func (m *Monitor) BlockDevMirror(deviceNodeName string, targetNodeName string) error {
var args struct {
Device string `json:"device"`
Target string `json:"target"`
Sync string `json:"sync"`
JobID string `json:"job-id"`
CopyMode string `json:"copy-mode"`
}
args.Device = deviceNodeName
args.Target = targetNodeName
args.JobID = deviceNodeName
// Only synchronise the top level device (usually a snapshot).
args.Sync = "top"
// When data is written to the source, write it (synchronously) to the target as well.
// In addition, data is copied in background just like in background mode.
// This ensures that the source and target converge at the cost of I/O performance during sync.
args.CopyMode = "write-blocking"
err := m.Run("blockdev-mirror", args, nil)
if err != nil {
return err
}
err = m.blockJobWaitReady(args.JobID)
if err != nil {
return err
}
return nil
}
// BlockJobCancel cancels an ongoing block job.
func (m *Monitor) BlockJobCancel(deviceNodeName string) error {
var args struct {
Device string `json:"device"`
}
args.Device = deviceNodeName
err := m.Run("block-job-cancel", args, nil)
if err != nil {
return err
}
return nil
}
// BlockJobComplete completes a block job that is in reader state.
func (m *Monitor) BlockJobComplete(deviceNodeName string) error {
var args struct {
Device string `json:"device"`
}
args.Device = deviceNodeName
err := m.Run("block-job-complete", args, nil)
if err != nil {
return err
}
return nil
}
// UpdateBlockSize updates the size of a disk.
func (m *Monitor) UpdateBlockSize(id string) error {
var args struct {
NodeName string `json:"node-name"`
Size int64 `json:"size"`
}
args.NodeName = id
args.Size = 1
err := m.Run("block_resize", args, nil)
if err != nil {
return err
}
return nil
}
// SetBlockThrottle applies an I/O limit on a disk.
func (m *Monitor) SetBlockThrottle(id string, bytesRead int, bytesWrite int, iopsRead int, iopsWrite int) error {
var args struct {
ID string `json:"id"`
Bytes int `json:"bps"`
BytesRead int `json:"bps_rd"`
BytesWrite int `json:"bps_wr"`
IOPs int `json:"iops"`
IOPsRead int `json:"iops_rd"`
IOPsWrite int `json:"iops_wr"`
}
args.ID = id
args.BytesRead = bytesRead
args.BytesWrite = bytesWrite
args.IOPsRead = iopsRead
args.IOPsWrite = iopsWrite
err := m.Run("block_set_io_throttle", args, nil)
if err != nil {
return err
}
return nil
}
// CheckPCIDevice checks if the deviceID exists as a bridged PCI device.
func (m *Monitor) CheckPCIDevice(deviceID string) (bool, error) {
pciDevs, err := m.QueryPCI()
if err != nil {
return false, err
}
for _, pciDev := range pciDevs {
for _, bridgeDev := range pciDev.Bridge.Devices {
if bridgeDev.DevID == deviceID {
return true, nil
}
}
}
return false, nil
}
// RingbufRead returns the complete contents of the specified ring buffer.
func (m *Monitor) RingbufRead(device string) (string, error) {
// Begin by ensuring the device specified is actually a ring buffer.
var queryResp struct {
Return []struct {
Label string `json:"label"`
Filename string `json:"filename"`
FrontendOpen bool `json:"frontend_open"`
} `json:"return"`
}
err := m.Run("query-chardev", nil, &queryResp)
if err != nil {
return "", err
}
deviceFound := false
for _, qemuDevice := range queryResp.Return {
if qemuDevice.Label == device {
deviceFound = true
if qemuDevice.Filename != "ringbuf" {
// Can't call `ringbuf-read` on a non-ringbuf device.
return "", ErrNotARingbuf
}
break
}
}
if !deviceFound {
return "", fmt.Errorf("Specified qemu device %q doesn't exist", device)
}
// Now actually read from the ring buffer.
var args struct {
Device string `json:"device"`
Size int `json:"size"`
}
args.Device = device
args.Size = 10000
var readResp struct {
Return string `json:"return"`
}
var sb strings.Builder
for {
err := m.Run("ringbuf-read", args, &readResp)
if err != nil {
return "", err
}
if len(readResp.Return) == 0 {
break
}
sb.WriteString(readResp.Return)
}
return sb.String(), nil
}
// ChardevChange changes the backend of a specified chardev. Currently supports the socket and ringbuf backends.
func (m *Monitor) ChardevChange(device string, info ChardevChangeInfo) error {
if info.Type == "socket" {
// Share the existing file descriptor with qemu.
err := m.SendFile(info.FDName, info.File)
if err != nil {
return err
}
var args struct {
ID string `json:"id"`
Backend struct {
Type string `json:"type"`
Data struct {
Addr struct {
Type string `json:"type"`
Data struct {
Str string `json:"str"`
} `json:"data"`
} `json:"addr"`
Server bool `json:"server"`
Wait bool `json:"wait"`
} `json:"data"`
} `json:"backend"`
}
args.ID = device
args.Backend.Type = info.Type
args.Backend.Data.Addr.Type = "fd"
args.Backend.Data.Addr.Data.Str = info.FDName
args.Backend.Data.Server = true
args.Backend.Data.Wait = false
err = m.Run("chardev-change", args, nil)
if err != nil {
// If the chardev-change command failed for some reason, ensure qemu cleans up its file descriptor.
_ = m.CloseFile(info.FDName)
return err
}
return nil
} else if info.Type == "ringbuf" {
var args struct {
ID string `json:"id"`
Backend struct {
Type string `json:"type"`
Data struct {
Size int `json:"size"`
} `json:"data"`
} `json:"backend"`
}
args.ID = device
args.Backend.Type = info.Type
args.Backend.Data.Size = 1048576
return m.Run("chardev-change", args, nil)
}
return fmt.Errorf("Unsupported chardev type %q", info.Type)
}
// Screendump takes a screenshot of the current VGA console.
// The screendump is stored to the filename provided as argument.
func (m *Monitor) Screendump(filename string) error {
var args struct {
Filename string `json:"filename"`
Device string `json:"device,omitempty"`
Head int `json:"head,omitempty"`
Format string `json:"format,omitempty"`
}
args.Filename = filename
args.Format = "png"
var queryResp struct {
Return struct{} `json:"return"`
}
return m.Run("screendump", args, &queryResp)
}
// DumpGuestMemory dumps guest memory to a file.
func (m *Monitor) DumpGuestMemory(path string, format string) error {
var args struct {
Paging bool `json:"paging"`
Protocol string `json:"protocol"`
Format string `json:"format,omitempty"`
Detach bool `json:"detach"`
}
args.Protocol = "fd:" + path
args.Format = format
var queryResp struct {
Return struct{} `json:"return"`
}
return m.Run("dump-guest-memory", args, &queryResp)
}
|