forked from xapi-project/xen-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xapi_xenops.ml
2764 lines (2583 loc) · 107 KB
/
xapi_xenops.ml
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
(*
* Copyright (C) Citrix Systems Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; version 2.1 only. with the special
* exception on linking described in file LICENSE.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*)
module D=Debug.Make(struct let name="xenops" end)
open D
open Network
open Xstringext
open Listext
open Threadext
open Pervasiveext
open Fun
module XenAPI = Client.Client
module Rrdd = Rrd_client.Client
open Xenops_interface
open Xapi_xenops_queue
let event_wait queue_name dbg ?from p =
let finished = ref false in
let event_id = ref from in
let module Client = (val make_client queue_name : XENOPS) in
while not !finished do
let _, deltas, next_id = Client.UPDATES.get dbg !event_id (Some 30) in
event_id := Some next_id;
List.iter (fun d -> if p d then finished := true) deltas;
done
let task_ended queue_name dbg id =
let module Client = (val make_client queue_name : XENOPS) in
match (Client.TASK.stat dbg id).Task.state with
| Task.Completed _
| Task.Failed _ -> true
| Task.Pending _ -> false
let assume_task_succeeded queue_name dbg id =
let module Client = (val make_client queue_name : XENOPS) in
let t = Client.TASK.stat dbg id in
Client.TASK.destroy dbg id;
match t.Task.state with
| Task.Completed _ -> t
| Task.Failed x ->
let exn = exn_of_exnty (Exception.exnty_of_rpc x) in
let bt = Backtrace.t_of_sexp (Sexplib.Sexp.of_string t.Task.backtrace) in
Backtrace.add exn bt;
raise exn
| Task.Pending _ -> failwith "task pending"
let wait_for_task queue_name dbg id =
let module Client = (val make_client queue_name : XENOPS) in
let finished = function
| Dynamic.Task id' ->
id = id' && (task_ended queue_name dbg id)
| _ ->
false in
let from = Client.UPDATES.last_id dbg in
if not(task_ended queue_name dbg id) then event_wait queue_name dbg ~from finished;
id
let xenapi_of_xenops_power_state = function
| Some Running -> `Running
| Some Halted -> `Halted
| Some Suspended -> `Suspended
| Some Paused -> `Paused
| None -> `Halted
let xenops_of_xenapi_power_state = function
| `Running -> Running
| `Halted -> Halted
| `Suspended -> Suspended
| `Paused -> Paused
module Platform = struct
(* Keys we push through to xenstore. *)
let acpi = "acpi"
let apic = "apic"
let nx = "nx"
let pae = "pae"
let viridian = "viridian"
let acpi_s3 = "acpi_s3"
let acpi_s4 = "acpi_s4"
let mmio_size_mib = "mmio_size_mib"
let revision = "revision"
let device_id = "device_id"
let tsc_mode = "tsc_mode"
let device_model = "device-model"
let xenguest = "xenguest"
let pv_kernel_max_size = "pv-kernel-max-size"
let pv_ramdisk_max_size = "pv-ramdisk-max-size"
let pv_postinstall_kernel_max_size = "pv-postinstall-kernel-max-size"
let pv_postinstall_ramdisk_max_size = "pv-postinstall-ramdisk-max-size"
let usb = "usb"
let usb_tablet = "usb_tablet"
let parallel = "parallel"
let vga = "vga"
let vgpu_pci_id = Xapi_globs.vgpu_pci_key
let vgpu_config = Xapi_globs.vgpu_config_key
let vgpu_extra_args = Xapi_globs.vgpu_extra_args_key
let igd_passthru_key = Xapi_globs.igd_passthru_key
(* This is only used to block the 'present multiple physical cores as one big hyperthreaded core' feature *)
let filtered_flags = [
acpi;
apic;
nx;
pae;
viridian;
acpi_s3;
acpi_s4;
mmio_size_mib;
revision;
device_id;
tsc_mode;
device_model;
xenguest;
pv_kernel_max_size;
pv_ramdisk_max_size;
pv_postinstall_kernel_max_size;
pv_postinstall_ramdisk_max_size;
usb;
usb_tablet;
parallel;
vga;
vgpu_pci_id;
vgpu_config;
vgpu_extra_args;
]
(* Other keys we might want to write to the platform map. *)
let timeoffset = "timeoffset"
let generation_id = "generation-id"
(* Helper functions. *)
let is_true ~key ~platformdata ~default =
try
match List.assoc key platformdata with
| "true" | "1" -> true
| "false" | "0" -> false
| _ -> default
with Not_found ->
default
let sanity_check ~platformdata ~vcpu_max ~vcpu_at_startup ~hvm ~filter_out_unknowns =
(* Filter out unknown flags, if applicable *)
let platformdata =
if filter_out_unknowns
then List.filter (fun (k, v) -> List.mem k filtered_flags) platformdata
else platformdata
in
(* Filter out invalid TSC modes. *)
let platformdata =
List.filter
(fun (k, v) -> k <> tsc_mode || List.mem v ["0"; "1"; "2"; "3"])
platformdata
in
(* Sanity check for HVM domains with invalid VCPU configuration*)
if hvm && (List.mem_assoc "cores-per-socket" platformdata) then
begin
try
let cores_per_socket = int_of_string(List.assoc "cores-per-socket" platformdata) in
(* cores per socket has to be in multiples of VCPUs_max and VCPUs_at_startup *)
if (((Int64.to_int(vcpu_max) mod cores_per_socket) <> 0)
|| ((Int64.to_int(vcpu_at_startup) mod cores_per_socket) <> 0)) then
raise (Api_errors.Server_error(Api_errors.invalid_value,
["platform:cores-per-socket";
"VCPUs_max/VCPUs_at_startup must be a multiple of this field"]))
with Failure msg ->
raise (Api_errors.Server_error(Api_errors.invalid_value, ["platform:cores-per-socket";
Printf.sprintf "value = %s is not a valid int" (List.assoc "cores-per-socket" platformdata)]))
end;
(* Add usb emulation flags.
Make sure we don't send usb=false and usb_tablet=true,
as that wouldn't make sense. *)
let usb_enabled =
is_true ~key:usb ~platformdata ~default:true in
let usb_tablet_enabled =
if usb_enabled
then is_true ~key:usb_tablet ~platformdata ~default:true
else false
in
let platformdata =
List.update_assoc
[(usb, string_of_bool usb_enabled);
(usb_tablet, string_of_bool usb_tablet_enabled)]
platformdata
in
(* Filter out invalid values for the "parallel" key. We don't want to give
* guests access to anything other than a real parallel port. *)
let platformdata =
let is_valid_parallel_flag = function
| "none" -> true
| dev -> String.startswith "/dev/parport" dev
in
List.filter
(fun (k, v) -> k <> parallel || is_valid_parallel_flag v)
platformdata
in
platformdata
end
let xenops_vdi_locator_of_strings sr_uuid vdi_location =
Printf.sprintf "%s/%s" sr_uuid vdi_location
let xenops_vdi_locator ~__context ~self =
let sr = Db.VDI.get_SR ~__context ~self in
let sr_uuid = Db.SR.get_uuid ~__context ~self:sr in
let vdi_location = Db.VDI.get_location ~__context ~self in
xenops_vdi_locator_of_strings sr_uuid vdi_location
let disk_of_vdi ~__context ~self =
try Some (VDI (xenops_vdi_locator ~__context ~self)) with _ -> None
let vdi_of_disk ~__context x = match String.split ~limit:2 '/' x with
| [ sr_uuid; location ] ->
let open Db_filter_types in
let sr = Db.SR.get_by_uuid ~__context ~uuid:sr_uuid in
begin match Db.VDI.get_records_where ~__context ~expr:(And((Eq (Field "location", Literal location)),Eq (Field "SR", Literal (Ref.string_of sr)))) with
| x :: _ -> Some x
| _ ->
error "Failed to find VDI: %s" x;
None
end
| _ ->
error "Failed to parse VDI name: %s" x;
None
let backend_of_network net =
if List.mem_assoc "backend_vm" net.API.network_other_config then begin
let backend_vm = List.assoc "backend_vm" net.API.network_other_config in
debug "Using VM %s as backend for VIF on network %s" backend_vm net.API.network_uuid;
Network.Remote (backend_vm, net.API.network_bridge)
end else
Network.Local net.API.network_bridge (* PR-1255 *)
let find f map default feature =
try
let v = List.assoc feature map in
try f v
with e ->
warn "Failed to parse %s as value for %s: %s; Using default value."
v feature (Printexc.to_string e);
default
with Not_found -> default
let string = find (fun x -> x)
let int = find int_of_string
let bool = find (function "1" -> true | "0" -> false | x -> bool_of_string x)
let rtc_timeoffset_of_vm ~__context (vm, vm_t) vbds =
let timeoffset = string vm_t.API.vM_platform "0" Platform.timeoffset in
(* If any VDI has on_boot = reset AND has a VDI.other_config:timeoffset
then we override the platform/timeoffset. This is needed because windows
stores the local time in timeoffset (the BIOS clock) but records whether
it has adjusted it for daylight savings in the system disk. If we reset
the system disk to an earlier snapshot then the BIOS clock needs to be
reset too. *)
let non_empty_vbds = List.filter (fun vbd -> not vbd.API.vBD_empty) vbds in
let vdis = List.map (fun vbd -> vbd.API.vBD_VDI) non_empty_vbds in
let vdis_with_timeoffset_to_be_reset_on_boot =
vdis
|> List.map (fun self -> (self, Db.VDI.get_record ~__context ~self))
|> List.filter (fun (_, record) -> record.API.vDI_on_boot = `reset)
|> List.filter_map (fun (reference, record) ->
Opt.of_exception (fun () ->
reference,
List.assoc Platform.timeoffset
record.API.vDI_other_config)) in
match vdis_with_timeoffset_to_be_reset_on_boot with
| [] ->
timeoffset
| [(reference, timeoffset)] ->
timeoffset
| reference_timeoffset_pairs ->
raise (Api_errors.Server_error (
(Api_errors.vm_attached_to_more_than_one_vdi_with_timeoffset_marked_as_reset_on_boot),
(Ref.string_of vm) ::
(reference_timeoffset_pairs
|> List.map fst
|> List.map Ref.string_of)))
(* /boot/ contains potentially sensitive files like xen-initrd, so we will only*)
(* allow directly booting guests from the subfolder /boot/guest/ *)
let allowed_dom0_directory_for_boot_files = "/boot/guest/"
let is_boot_file_whitelisted filename =
let safe_str str = not (String.has_substr str "..") in
(* make sure the script prefix is the allowed dom0 directory *)
(String.startswith allowed_dom0_directory_for_boot_files filename)
(* avoid ..-style attacks and other weird things *)
&&(safe_str filename)
let builder_of_vm ~__context (vmref, vm) timeoffset pci_passthrough vgpu =
let open Vm in
let video_mode =
if vgpu then Vgpu
else if (Platform.is_true
~key:Platform.igd_passthru_key
~platformdata:vm.API.vM_platform
~default:false)
then (IGD_passthrough GVT_d)
else
match string vm.API.vM_platform "cirrus" Platform.vga with
| "std" -> Standard_VGA
| "cirrus" -> Cirrus
| x ->
error "Unknown platform/vga option: %s (expected 'std' or 'cirrus')" x;
Cirrus
in
let pci_emulations =
let s = try Some (List.assoc "mtc_pci_emulations" vm.API.vM_other_config) with _ -> None in
match s with
| None -> []
| Some x ->
try
let l = String.split ',' x in
List.map (String.strip String.isspace) l
with _ -> []
in
match Helpers.boot_method_of_vm ~__context ~vm with
| Helpers.HVM { Helpers.timeoffset = t } -> HVM {
hap = true;
shadow_multiplier = vm.API.vM_HVM_shadow_multiplier;
timeoffset = timeoffset;
video_mib = begin
(* For vGPU, make sure videoram is at least 16MiB. *)
let requested_videoram = int vm.API.vM_platform 4 "videoram" in
if video_mode = Vgpu
then max requested_videoram 16
else requested_videoram
end;
video = video_mode;
acpi = bool vm.API.vM_platform true "acpi";
serial = begin
(* The platform value should override the other_config value. If
* neither are set, use pty. *)
let key = "hvm_serial" in
let other_config_value =
try Some (List.assoc key vm.API.vM_other_config)
with Not_found -> None
in
let platform_value =
try Some (List.assoc key vm.API.vM_platform)
with Not_found -> None
in
match other_config_value, platform_value with
| None, None -> Some "pty"
| _, Some value -> Some value
| Some value, None -> Some value
end;
keymap = Some (string vm.API.vM_platform "en-us" "keymap");
vnc_ip = None (*None PR-1255*);
pci_emulations = pci_emulations;
pci_passthrough = pci_passthrough;
boot_order = string vm.API.vM_HVM_boot_params "cd" "order";
qemu_disk_cmdline = bool vm.API.vM_platform false "qemu_disk_cmdline";
qemu_stubdom = bool vm.API.vM_platform false "qemu_stubdom";
}
| Helpers.DirectPV { Helpers.kernel = k; kernel_args = ka; ramdisk = initrd } ->
let k = if is_boot_file_whitelisted k then k else begin
debug "kernel %s is not in the whitelist: ignoring" k;
""
end in
let initrd = Opt.map (fun x ->
if is_boot_file_whitelisted x then x else begin
debug "initrd %s is not in the whitelist: ignoring" k;
""
end
) initrd in
PV {
boot = Direct { kernel = k; cmdline = ka; ramdisk = initrd };
framebuffer = bool vm.API.vM_platform false "pvfb";
framebuffer_ip = None; (* None PR-1255 *)
vncterm = begin match List.mem_assoc "disable_pv_vnc" vm.API.vM_other_config with
|true -> false
|false -> true
end;
vncterm_ip = None (*None PR-1255*);
}
| Helpers.IndirectPV { Helpers.bootloader = b; extra_args = e; legacy_args = l; pv_bootloader_args = p; vdis = vdis } ->
PV {
boot = Indirect { bootloader = b; extra_args = e; legacy_args = l; bootloader_args = p; devices = List.filter_map (fun x -> disk_of_vdi ~__context ~self:x) vdis };
framebuffer = bool vm.API.vM_platform false "pvfb";
framebuffer_ip = None; (* None PR-1255 *)
vncterm = begin match List.mem_assoc "disable_pv_vnc" vm.API.vM_other_config with
|true -> false
|false -> true
end;
vncterm_ip = None (*None PR-1255*);
}
module MD = struct
(** Convert between xapi DB records and xenopsd records *)
let of_vbd ~__context ~vm ~vbd =
let hvm = vm.API.vM_HVM_boot_policy <> "" in
let device_number = Device_number.of_string hvm vbd.API.vBD_userdevice in
let open Vbd in
let ty = vbd.API.vBD_qos_algorithm_type in
let params = vbd.API.vBD_qos_algorithm_params in
let qos_class params =
if List.mem_assoc "class" params then
match List.assoc "class" params with
| "highest" -> Highest
| "high" -> High
| "normal" -> Normal
| "low" -> Low
| "lowest" -> Lowest
| s ->
try Other (int_of_string s)
with _ ->
warn "Unknown VBD QoS scheduler class (try 'high' 'low' 'normal')";
Normal
else
Normal in
let qos_scheduler params =
try
match List.assoc "sched" params with
| "rt" | "real-time" -> RealTime (qos_class params)
| "idle" -> Idle
| "best-effort" -> BestEffort (qos_class params)
| _ ->
warn "Unknown VBD QoS scheduler (try 'real-time' 'idle' 'best-effort')";
BestEffort (qos_class params)
with Not_found ->
BestEffort (qos_class params) in
let qos = function
| "ionice" -> Some (Ionice (qos_scheduler params))
| "" -> None
| x ->
warn "Unknown VBD QoS type: %s (try 'ionice')" x;
None in
let other_config_keys ?(default=None) key =
let oc = vbd.API.vBD_other_config in
let k = key in
try
let v = List.assoc k oc in
[(k, v)]
with Not_found -> match default with None->[] | Some x->[(k, x)]
in
let in_range ~min ~max ~fallback values =
List.map (fun (k,v)-> k,
let value = try int_of_string v
with _->
debug "%s: warning: value %s is not an integer. Using fallback value %d" k v fallback;
fallback
in
string_of_int (
if value < min then min
else if value > max then max
else value
)
)
values
in
let backend_kind_keys = other_config_keys Xapi_globs.vbd_backend_key in
let poll_duration_keys = in_range ~min:0 ~max:max_int
~fallback:0 (* if user provides invalid integer, use 0 = disable polling *)
(other_config_keys Xapi_globs.vbd_polling_duration_key ~default:(Some (string_of_int !Xapi_globs.default_vbd3_polling_duration)))
in
let poll_idle_threshold_keys = in_range ~min:0 ~max:100
~fallback:50 (* if user provides invalid float, use 50 = default 50% *)
(other_config_keys Xapi_globs.vbd_polling_idle_threshold_key ~default:(Some (string_of_int !Xapi_globs.default_vbd3_polling_idle_threshold)))
in
{
id = (vm.API.vM_uuid, Device_number.to_linux_device device_number);
position = Some device_number;
mode = if vbd.API.vBD_mode = `RO then ReadOnly else ReadWrite;
backend = disk_of_vdi ~__context ~self:vbd.API.vBD_VDI;
ty = (match vbd.API.vBD_type with
| `Disk -> Disk
| `CD -> CDROM
| `Floppy -> Floppy);
unpluggable = vbd.API.vBD_unpluggable;
extra_backend_keys = backend_kind_keys @ poll_duration_keys @ poll_idle_threshold_keys;
extra_private_keys = [];
qos = qos ty;
persistent = (try Db.VDI.get_on_boot ~__context ~self:vbd.API.vBD_VDI = `persist with _ -> true);
}
let of_vif ~__context ~vm ~vif =
let net = Db.Network.get_record ~__context ~self:vif.API.vIF_network in
let net_mtu = Int64.to_int (net.API.network_MTU) in
let mtu =
try
if List.mem_assoc "mtu" vif.API.vIF_other_config
then List.assoc "mtu" vif.API.vIF_other_config |> int_of_string
else net_mtu
with _ ->
error "Failed to parse VIF.other_config:mtu; defaulting to network.mtu";
net_mtu in
let qos_type = vif.API.vIF_qos_algorithm_type in
let qos_params = vif.API.vIF_qos_algorithm_params in
let log_qos_failure reason =
warn "vif QoS failed: %s (vm=%s,vif=%s)" reason vm.API.vM_uuid vif.API.vIF_uuid in
let rate = match qos_type with
| "ratelimit" ->
let timeslice =
try Int64.of_string (List.assoc "timeslice_us" qos_params)
with _ -> 0L in
begin
try
let rate = Int64.of_string (List.assoc "kbps" qos_params) in
Some (rate, timeslice)
with
| Failure "int_of_string" ->
log_qos_failure "parameter \"kbps\" not an integer"; None
| Not_found ->
log_qos_failure "necessary parameter \"kbps\" not found"; None
| e ->
log_qos_failure (Printf.sprintf "unexpected error: %s" (Printexc.to_string e)); None
end
| "" -> None
| _ -> log_qos_failure (Printf.sprintf "unknown type: %s" qos_type); None in
let locking_mode = match vif.API.vIF_locking_mode, net.API.network_default_locking_mode with
| `network_default, `disabled -> Vif.Disabled
| `network_default, `unlocked -> Vif.Unlocked
| `locked, _ -> Vif.Locked { Vif.ipv4 = vif.API.vIF_ipv4_allowed; ipv6 = vif.API.vIF_ipv6_allowed }
| `unlocked, _ -> Vif.Unlocked
| `disabled, _ -> Vif.Disabled in
let carrier =
if !Xapi_globs.pass_through_pif_carrier then
(* We need to reflect the carrier of the local PIF on the network (if any) *)
let host = Helpers.get_localhost ~__context in
let pifs = Xapi_network_attach_helpers.get_local_pifs ~__context ~network:vif.API.vIF_network ~host in
match pifs with
| [] -> true (* Internal network; consider as "always up" *)
| pif :: _ ->
try
let metrics = Db.PIF.get_metrics ~__context ~self:pif in
Db.PIF_metrics.get_carrier ~__context ~self:metrics
with _ -> true
else
(* If we don't need to reflect anything, the carrier is set to "true" *)
true
in
let open Vif in {
id = (vm.API.vM_uuid, vif.API.vIF_device);
position = int_of_string vif.API.vIF_device;
mac = vif.API.vIF_MAC;
carrier = carrier;
mtu = mtu;
rate = rate;
backend = backend_of_network net;
other_config = vif.API.vIF_other_config;
locking_mode = locking_mode;
extra_private_keys = [
"vif-uuid", vif.API.vIF_uuid;
"network-uuid", net.API.network_uuid;
]
}
let pcis_of_vm ~__context (vmref, vm) =
let vgpu_pcidevs = Vgpuops.list_pcis_for_passthrough ~__context ~vm:vmref in
let devs = List.flatten (List.map (fun (_, dev) -> dev) (Pciops.sort_pcidevs vgpu_pcidevs)) in
(* The 'unmanaged' PCI devices are in the other_config key: *)
let other_pcidevs = Pciops.other_pcidevs_of_vm ~__context vm.API.vM_other_config in
let unmanaged = List.flatten (List.map (fun (_, dev) -> dev) (Pciops.sort_pcidevs other_pcidevs)) in
let devs = devs @ unmanaged in
let open Pci in
List.map
(fun (idx, (domain, bus, dev, fn)) -> {
id = (vm.API.vM_uuid, Printf.sprintf "%04x:%02x:%02x.%01x" domain bus dev fn);
position = idx;
address = {domain; bus; dev; fn};
msitranslate = None;
power_mgmt = None;
})
(List.combine (Range.to_list (Range.make 0 (List.length devs))) devs)
let get_target_pci_address ~__context vgpu =
let pgpu =
if Db.is_valid_ref __context
vgpu.Db_actions.vGPU_scheduled_to_be_resident_on
then vgpu.Db_actions.vGPU_scheduled_to_be_resident_on
else vgpu.Db_actions.vGPU_resident_on
in
let pci = Db.PGPU.get_PCI ~__context ~self:pgpu in
let pci_address = Db.PCI.get_pci_id ~__context ~self:pci in
Xenops_interface.Pci.address_of_string pci_address
let of_nvidia_vgpu ~__context vm vgpu =
let open Vgpu in
(* Get the PCI address. *)
let physical_pci_address = get_target_pci_address ~__context vgpu in
(* Get the vGPU config. *)
let vgpu_type = vgpu.Db_actions.vGPU_type in
let internal_config =
Db.VGPU_type.get_internal_config ~__context ~self:vgpu_type in
let config_file =
try List.assoc Xapi_globs.vgpu_config_key internal_config
with Not_found -> failwith "NVIDIA vGPU config file not specified"
in
let implementation =
Nvidia {
physical_pci_address;
config_file;
}
in {
id = (vm.API.vM_uuid, vgpu.Db_actions.vGPU_device);
position = int_of_string vgpu.Db_actions.vGPU_device;
implementation;
}
let of_gvt_g_vgpu ~__context vm vgpu =
let open Vgpu in
(* Get the PCI address. *)
let physical_pci_address = get_target_pci_address ~__context vgpu in
(* Get the vGPU config. *)
let vgpu_type = vgpu.Db_actions.vGPU_type in
let internal_config =
Db.VGPU_type.get_internal_config ~__context ~self:vgpu_type in
try
let implementation =
GVT_g {
physical_pci_address;
low_gm_sz =
List.assoc Xapi_globs.vgt_low_gm_sz internal_config
|> Int64.of_string;
high_gm_sz =
List.assoc Xapi_globs.vgt_high_gm_sz internal_config
|> Int64.of_string;
fence_sz =
List.assoc Xapi_globs.vgt_fence_sz internal_config
|> Int64.of_string;
}
in {
id = (vm.API.vM_uuid, vgpu.Db_actions.vGPU_device);
position = int_of_string vgpu.Db_actions.vGPU_device;
implementation;
}
with
| Not_found -> failwith "Intel GVT-g settings not specified"
| Failure "int_of_string" ->
failwith "Intel GVT-g settings invalid"
let vgpus_of_vm ~__context (vmref, vm) =
let open Vgpu in
if Vgpuops.vgpu_manual_setup_of_vm vm
&& (List.mem_assoc Platform.vgpu_pci_id vm.API.vM_platform)
&& (List.mem_assoc Platform.vgpu_config vm.API.vM_platform)
then begin
(* We're using the vGPU manual setup mode, so get the vGPU configuration
* from the VM platform keys. *)
let implementation =
Nvidia {
physical_pci_address =
Xenops_interface.Pci.address_of_string
(List.assoc Platform.vgpu_pci_id vm.API.vM_platform);
config_file = List.assoc Platform.vgpu_config vm.API.vM_platform;
}
in [{
id = (vm.API.vM_uuid, "0");
position = 0;
implementation;
}]
end else
List.fold_left
(fun acc vgpu ->
let vgpu_record = Db.VGPU.get_record_internal ~__context ~self:vgpu in
let implementation =
Db.VGPU_type.get_implementation ~__context
~self:vgpu_record.Db_actions.vGPU_type
in
match implementation with
(* Passthrough VGPUs are dealt with in pcis_of_vm. *)
| `passthrough -> acc
| `nvidia ->
(of_nvidia_vgpu ~__context vm vgpu_record) :: acc
| `gvt_g ->
(of_gvt_g_vgpu ~__context vm vgpu_record) :: acc)
[] vm.API.vM_VGPUs
let of_vm ~__context (vmref, vm) vbds pci_passthrough vgpu =
let on_crash_behaviour = function
| `preserve -> [ Vm.Pause ]
| `coredump_and_restart -> [ Vm.Coredump; Vm.Start ]
| `coredump_and_destroy -> [ Vm.Coredump; Vm.Shutdown ]
| `restart
| `rename_restart -> [ Vm.Start ]
| `destroy -> [ Vm.Shutdown ] in
let on_normal_exit_behaviour = function
| `restart -> [ Vm.Start ]
| `destroy -> [ Vm.Shutdown ] in
let open Vm in
let scheduler_params =
(* vcpu <-> pcpu affinity settings are stored here.
Format is either:
1,2,3 :: all vCPUs receive this mask
1,2,3; 4,5,6 :: vCPU n receives mask n. Unlisted vCPUs
receive first mask *)
let affinity =
try
List.map
(fun x -> List.map int_of_string (String.split ',' x))
(String.split ';' (List.assoc "mask" vm.API.vM_VCPUs_params))
with _ -> [] in
let localhost = Helpers.get_localhost ~__context in
let host_guest_VCPUs_params = Db.Host.get_guest_VCPUs_params ~__context ~self:localhost in
let host_cpu_mask =
try
List.map int_of_string (String.split ',' (List.assoc "mask" host_guest_VCPUs_params))
with _ -> [] in
let affinity =
match affinity,host_cpu_mask with
| [],[] -> []
| [],h -> [h]
| v,[] -> v
| affinity,mask ->
List.map
(fun vcpu_affinity ->
List.filter (fun x -> List.mem x mask) vcpu_affinity) affinity in
let priority =
let weight =
let default=256 in
try
let weight = List.assoc "weight" vm.API.vM_VCPUs_params in
int_of_string weight
with
| Not_found -> default
| e -> error "%s" (Printexc.to_string e);
debug "Could not parse weight value. Setting it to default value %d." default; default in
let cap =
let default=0 in
try
let cap = List.assoc "cap" vm.API.vM_VCPUs_params in
int_of_string cap
with
| Not_found -> default
| e -> error "%s" (Printexc.to_string e);
debug "Could not parse cap value. Setting it to default value %d." default; default in
Some ( weight , cap ) in
{ priority = priority; affinity = affinity } in
let platformdata =
Platform.sanity_check
~platformdata:vm.API.vM_platform
~vcpu_max:vm.API.vM_VCPUs_max
~vcpu_at_startup:vm.API.vM_VCPUs_at_startup
~hvm:(Helpers.will_boot_hvm ~__context ~self:vmref)
~filter_out_unknowns:
(not(Pool_features.is_enabled ~__context Features.No_platform_filter))
in
(* Replace the timeoffset in the platform data too, to avoid confusion *)
let timeoffset = rtc_timeoffset_of_vm ~__context (vmref, vm) vbds in
let platformdata =
(Platform.timeoffset, timeoffset) ::
(List.filter (fun (key, _) -> key <> Platform.timeoffset) platformdata) in
let platformdata =
let genid = match vm.API.vM_generation_id with
| "0:0" -> Xapi_vm_helpers.vm_fresh_genid ~__context ~self:vmref
| _ -> vm.API.vM_generation_id in
(Platform.generation_id, genid) :: platformdata
in
let pci_msitranslate = true in (* default setting *)
(* CA-55754: allow VM.other_config:msitranslate to override the bus-wide setting *)
let pci_msitranslate =
if List.mem_assoc "msitranslate" vm.API.vM_other_config
then List.assoc "msitranslate" vm.API.vM_other_config = "1"
else pci_msitranslate in
(* CA-55754: temporarily disable msitranslate when GPU is passed through. *)
let pci_msitranslate =
if vm.API.vM_VGPUs <> [] then false else pci_msitranslate in
{
id = vm.API.vM_uuid;
name = vm.API.vM_name_label;
ssidref = 0l;
xsdata = vm.API.vM_xenstore_data;
platformdata = platformdata;
bios_strings = vm.API.vM_bios_strings;
ty = builder_of_vm ~__context (vmref, vm) timeoffset pci_passthrough vgpu;
suppress_spurious_page_faults = (try List.assoc "suppress-spurious-page-faults" vm.API.vM_other_config = "true" with _ -> false);
machine_address_size = (try Some(int_of_string (List.assoc "machine-address-size" vm.API.vM_other_config)) with _ -> None);
memory_static_max = vm.API.vM_memory_static_max;
memory_dynamic_max = vm.API.vM_memory_dynamic_max;
memory_dynamic_min = vm.API.vM_memory_dynamic_min;
vcpu_max = Int64.to_int vm.API.vM_VCPUs_max;
vcpus = Int64.to_int vm.API.vM_VCPUs_at_startup;
scheduler_params = scheduler_params;
on_crash = on_crash_behaviour vm.API.vM_actions_after_crash;
on_shutdown = on_normal_exit_behaviour vm.API.vM_actions_after_shutdown;
on_reboot = on_normal_exit_behaviour vm.API.vM_actions_after_reboot;
pci_msitranslate = pci_msitranslate;
pci_power_mgmt = false;
auto_update_drivers = vm.API.vM_auto_update_drivers
}
end
open Xenops_interface
open Fun
module Guest_agent_features = struct
module Xapi = struct
let auto_update_enabled = "auto_update_enabled"
let auto_update_url = "auto_update_url"
end
module Xenopsd = struct
let auto_update_enabled = "enabled"
let auto_update_url = "update_url"
let enabled = "1"
let disabled = "0"
end
let auto_update_parameters_of_config config =
let auto_update_enabled =
match
if List.mem_assoc Xapi.auto_update_enabled config
then Some
(* bool_of_string should be safe as the setter in xapi_pool.ml only
* allows "true" or "false" to be put into the database. *)
(bool_of_string (List.assoc Xapi.auto_update_enabled config))
else None
with
| Some true -> [Xenopsd.auto_update_enabled, Xenopsd.enabled]
| Some false -> [Xenopsd.auto_update_enabled, Xenopsd.disabled]
| None -> []
in
let auto_update_url =
if List.mem_assoc Xapi.auto_update_url config
then [Xenopsd.auto_update_url, List.assoc Xapi.auto_update_url config]
else []
in
auto_update_enabled @ auto_update_url
let of_config ~__context config =
let open Features in
let vss =
let name = Features.name_of_feature VSS in
let licensed = Pool_features.is_enabled ~__context VSS in
let parameters = [] in
Host.({
name;
licensed;
parameters;
})
in
let guest_agent_auto_update =
let name = Features.name_of_feature Guest_agent_auto_update in
let licensed =
Pool_features.is_enabled ~__context Guest_agent_auto_update in
let parameters = auto_update_parameters_of_config config in
Host.({
name;
licensed;
parameters;
})
in
[vss; guest_agent_auto_update]
end
let apply_guest_agent_config ~__context config =
let dbg = Context.string_of_task __context in
let features = Guest_agent_features.of_config ~__context config in
let module Client = (val make_client (default_xenopsd ()): XENOPS) in
Client.HOST.update_guest_agent_features dbg features
(* If a VM was suspended pre-xenopsd it won't have a last_booted_record of the format understood by xenopsd. *)
(* If we can parse the last_booted_record according to the old syntax, update it before attempting to resume. *)
let generate_xenops_state ~__context ~self ~vm ~vbds ~pcis ~vgpus =
try
let vm_to_resume = {
(Helpers.parse_boot_record vm.API.vM_last_booted_record) with
API.vM_VBDs = vm.API.vM_VBDs
} in
debug "Successfully parsed old last_booted_record format - translating to new format so that xenopsd can resume the VM.";
let module Client = (val make_client (queue_of_vmr vm): XENOPS) in
let vm = MD.of_vm ~__context
(self, vm_to_resume) vbds (pcis <> []) (vgpus <> [])
in
let dbg = Context.string_of_task __context in
Client.VM.generate_state_string dbg vm
with Xml.Error _ ->
debug "last_booted_record is not of the old format, so we should be able to resume the VM.";
vm.API.vM_last_booted_record
(* Create an instance of Metadata.t, suitable for uploading to the xenops service *)
let create_metadata ~__context ~upgrade ~self =
let vm = Db.VM.get_record ~__context ~self in
let vbds = List.filter (fun vbd -> vbd.API.vBD_currently_attached)
(List.map (fun self -> Db.VBD.get_record ~__context ~self) vm.API.vM_VBDs) in
let vbds' = List.map (fun vbd -> MD.of_vbd ~__context ~vm ~vbd) vbds in
let vifs = List.filter (fun vif -> vif.API.vIF_currently_attached)
(List.map (fun self -> Db.VIF.get_record ~__context ~self) vm.API.vM_VIFs) in
let vifs' = List.map (fun vif -> MD.of_vif ~__context ~vm ~vif) vifs in
let pcis = MD.pcis_of_vm ~__context (self, vm) in
let vgpus = MD.vgpus_of_vm ~__context (self, vm) in
let domains =
(* For suspended VMs, we may need to translate the last_booted_record from the old format. *)
if vm.API.vM_power_state = `Suspended || upgrade then begin
(* We need to recall the currently_attached devices *)
Some(generate_xenops_state ~__context ~self ~vm ~vbds ~pcis ~vgpus)
end else None in
let open Metadata in {
vm = MD.of_vm ~__context (self, vm) vbds (pcis <> []) (vgpus <> []);
vbds = vbds';
vifs = vifs';
pcis = pcis;
vgpus = vgpus;
domains = domains
}
let id_of_vm ~__context ~self = Db.VM.get_uuid ~__context ~self
let vm_of_id ~__context uuid = Db.VM.get_by_uuid ~__context ~uuid
let vm_exists_in_xenopsd queue_name dbg id =
let module Client = (val make_client queue_name : XENOPS) in
Client.VM.exists dbg id
let string_of_exn = function
| Api_errors.Server_error(code, params) -> Printf.sprintf "%s [ %s ]" code (String.concat "; " params)
| e -> Printexc.to_string e
(* Serialise updates to the metadata caches *)
let metadata_m = Mutex.create ()
module Xapi_cache = struct
(** Keep a cache of the "xenops-translation" of XenAPI VM configuration,
updated whenever we receive an event from xapi. *)
let cache = Hashtbl.create 10 (* indexed by Vm.id *)
let _register_nolock id initial_value =
debug "xapi_cache: creating cache for %s" id;
if not(Hashtbl.mem cache id) || (Hashtbl.find cache id = None)
then Hashtbl.replace cache id initial_value
let _unregister_nolock id =
debug "xapi_cache: deleting cache for %s" id;
Hashtbl.remove cache id
let find_nolock id =
if Hashtbl.mem cache id
then Hashtbl.find cache id
else None
let update_nolock id t =
if Hashtbl.mem cache id then begin
debug "xapi_cache: updating cache for %s" id;
Hashtbl.replace cache id t
end else debug "xapi_cache: not updating cache for %s" id
let list_nolock () = Hashtbl.fold (fun id _ acc -> id :: acc) cache []
end
module Xenops_cache = struct
(** Remember the last events received from xenopsd so we can compute
field-level differences. This allows us to minimise the number of
database writes we issue upwards. *)
type t = {
vm: Vm.state option;
vbds: (Vbd.id * Vbd.state) list;
vifs: (Vif.id * Vif.state) list;
pcis: (Pci.id * Pci.state) list;
vgpus: (Vgpu.id * Vgpu.state) list;
}
let empty = {
vm = None;
vbds = [];
vifs = [];
pcis = [];
vgpus = [];
}
let cache = Hashtbl.create 10 (* indexed by Vm.id *)
let _register_nolock id =
debug "xenops_cache: creating empty cache for %s" id;
Hashtbl.replace cache id empty
let _unregister_nolock id =
debug "xenops_cache: deleting cache for %s" id;
Hashtbl.remove cache id