Source file vmm_core.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
module String_set = Set.Make(String)
module String_map = Map.Make(String)
let conn_metrics kind =
let s = ref (0, 0) in
let open Metrics in
let doc = "connection statistics" in
let data () =
Data.v [
int "active" (fst !s) ;
int "total" (snd !s) ;
] in
let tags = Tags.string "kind" in
let src = Src.v ~doc ~tags:Tags.[ tags ] ~data "connections" in
(fun action ->
(match action with
| `Open -> s := (succ (fst !s), succ (snd !s))
| `Close -> s := (pred (fst !s), snd !s));
Metrics.add src (fun x -> x kind) (fun d -> d ()))
let tmpdir = ref (Fpath.v "/nonexisting")
let set_tmpdir path = tmpdir := path
type service = [ `Console | `Stats | `Vmmd ]
let socket_path t =
let path = match t with
| `Console -> "console"
| `Vmmd -> "vmmd"
| `Stats -> "stat"
in
Fpath.to_string Fpath.(!tmpdir / "util" / path + "sock")
let pp_socket ppf t =
let name = socket_path t in
Fmt.pf ppf "socket: %s" name
module I = struct
type t = int
let compare : int -> int -> int = compare
end
module IS = Set.Make(I)
module IM = Map.Make(I)
module Name = struct
type path = string list
type t = path * string option
let for_all p s =
let n = String.length s in
let rec loop i =
if i = n then true
else if p (String.unsafe_get s i) then loop (succ i)
else false in
loop 0
let [@inline always] valid_label s =
String.length s < 64 &&
String.length s > 0 &&
String.get s 0 <> '-' &&
for_all (function
| 'a'..'z' | 'A'..'Z' | '0'..'9' | '-' | '.' -> true
| _ -> false)
s
let path_equal (x, _) (y, _) =
let rec equal x y = match x, y with
| [], [] -> true
| x::xs, y::ys -> String.equal x y && equal xs ys
| _ -> false
in
equal x y
let opt_eq a b = match a, b with
| None, None -> true
| Some a, Some b -> String.equal a b
| _ -> false
let equal x y =
path_equal x y && opt_eq (snd x) (snd y)
let pp ppf (p, name) =
Fmt.(pf ppf "[unikernel: %a:%a]" (list ~sep:(any ":") string) p
(option ~none:(any "") string) name)
let path (p, _) = p
let name (_, name) = name
let create path name =
if valid_label name then
Ok (path, Some name)
else
Error (`Msg ("invalid name: " ^ name))
let create_of_path p = (p, None)
let create_exn path name =
match create path name with
| Ok t -> t
| Error `Msg m -> invalid_arg m
let drop_path (_, name) = [], name
let rec drop_prefix_exn (p, name) p' =
match p, p' with
| _, [] -> p, name
| [], _ -> invalid_arg "p is shorter than p'"
| a::bs, a'::bs' ->
if String.equal a a' then
drop_prefix_exn (bs, name) bs'
else
invalid_arg "p' is not a prefix of p"
let path_to_list p = p
let path_of_list ps =
if List.for_all valid_label ps then
Ok ps
else
Error (`Msg "invalid path")
let of_path ps = match List.rev ps with
| name :: rev_path -> Ok (List.rev rev_path, Some name)
| [] -> Error (`Msg "empty name")
let to_list (p, name) =
Option.fold ~none:p ~some:(fun n -> p @ [ n ]) name
let of_list ids =
match path_of_list ids with
| Error _ -> Error (`Msg "invalid name")
| Ok _ -> of_path ids
let path_to_string x = String.concat ":" x
let path_of_string str =
let ps = String.split_on_char ':' str in
let ps = match ps with | ""::tl -> tl | ps -> ps in
if List.for_all valid_label ps then
Ok ps
else
Error (`Msg "invalid path")
let to_string (p, n) =
path_to_string p ^ ":" ^ Option.value ~default:"" n
let of_string str =
let ( let* ) = Result.bind in
let* () =
if String.equal str "" then Error (`Msg "empty name") else Ok ()
in
let last_idx = String.length str - 1 in
if String.get str last_idx = ':' then
let* path = path_of_string (String.sub str 0 last_idx) in
Ok (path, None)
else
match path_of_string str with
| Error _ -> Error (`Msg "invalid name")
| Ok ps -> of_path ps
let root_path = []
let is_root_path = function [] -> true | _ -> false
let parent_path p = match List.rev p with
| [] -> []
| _::tl -> List.rev tl
let root = (root_path, None)
let is_root (p, n) = is_root_path p && Option.is_none n
let append_path prefix p =
if valid_label p then
Ok (prefix @ [ p ])
else
Error (`Msg ("invalid path: " ^ p))
let append_path_exn prefix p =
match append_path prefix p with
| Ok p -> p
| Error `Msg m -> invalid_arg m
let image_file name =
let file = to_string name in
Fpath.(!tmpdir / file + "img")
let fifo_file name =
let file = to_string name in
Fpath.(!tmpdir / "fifo" / file)
let block_name unikernel_name dev = path unikernel_name, Some dev
let mac name bridge =
let prefix = "\x00\x80\x41"
and ours = Digest.string (bridge ^ to_string name)
in
Macaddr.of_octets_exn (prefix ^ String.sub ours 0 3)
end
module Policy = struct
let pp_is ppf is = Fmt.pf ppf "%a" Fmt.(list ~sep:(any ",") int) (IS.elements is)
let eq_int (a : int) (b : int) = a = b
type t = {
unikernels : int ;
cpuids : IS.t ;
memory : int ;
block : int option ;
bridges : String_set.t ;
}
let equal p1 p2 =
let eq_opt a b = match a, b with
| None, None -> true
| Some a, Some b -> eq_int a b
| _ -> false
in
eq_int p1.unikernels p2.unikernels &&
IS.equal p1.cpuids p2.cpuids &&
eq_int p1.memory p2.memory &&
eq_opt p1.block p2.block &&
String_set.equal p1.bridges p2.bridges
let pp ppf res =
let bridges =
if String_set.is_empty res.bridges then "" else ", bridges: "
in
Fmt.pf ppf "policy: %d unikernels %a cpus %d MB memory %a block%s%a"
res.unikernels pp_is res.cpuids res.memory
Fmt.(option ~none:(any "no") (int ++ any " MB")) res.block
bridges
Fmt.(list ~sep:(any ", ") string) (String_set.elements res.bridges)
let usable { unikernels ; cpuids ; memory ; block ; _ } =
if unikernels <= 0 then
Error (`Msg "Unusable policy with no unikernels")
else if IS.is_empty cpuids then
Error (`Msg "Unusable policy with no CPUids")
else if memory <= 16 then
Error (`Msg ("Unusable policy with memory " ^ string_of_int memory ^ " MB <= 16 MB"))
else match block with
| None -> Ok ()
| Some x when x >= 0 -> Ok ()
| Some x -> Error (`Msg ("Unusable policy with block " ^ string_of_int x ^ " MB < 0 MB"))
let is_smaller ~super ~sub =
let sub_block sub super =
match super, sub with
| None, None -> true
| Some _, None -> true
| Some x, Some y -> x >= y
| None, Some _ -> false
in
if super.unikernels < sub.unikernels then
Error (`Msg (Fmt.str "policy above allows %d unikernels, which is fewer than %d"
super.unikernels sub.unikernels))
else if super.memory < sub.memory then
Error (`Msg (Fmt.str "policy above allows %d MB memory, which is fewer than %d MB"
super.memory sub.memory))
else if not (IS.subset sub.cpuids super.cpuids) then
Error (`Msg (Fmt.str "policy above allows CPUids %a, which is not a superset of %a"
Fmt.(list ~sep:(any ", ") int) (IS.elements super.cpuids)
Fmt.(list ~sep:(any ", ") int) (IS.elements sub.cpuids)))
else if not (String_set.subset sub.bridges super.bridges) then
Error (`Msg (Fmt.str "policy above allows bridge(s) %a, which is not a superset of %a"
Fmt.(list ~sep:(any ", ") string) (String_set.elements super.bridges)
Fmt.(list ~sep:(any ", ") string) (String_set.elements sub.bridges)))
else if not (sub_block sub.block super.block) then
Error (`Msg (Fmt.str "policy above allows %d MB block storage, which is fewer than %d MB"
(match super.block with None -> 0 | Some x -> x)
(match sub.block with None -> 0 | Some x -> x)))
else
Ok ()
end
module Unikernel = struct
type typ = [ `Solo5 ]
let pp_typ ppf = function
| `Solo5 -> Fmt.pf ppf "solo5"
type fail_behaviour = [ `Quit | `Restart of IS.t option ]
let pp_fail_behaviour ppf = function
| `Quit -> Fmt.string ppf "quit"
| `Restart codes ->
Fmt.pf ppf "restart %a"
Fmt.(option ~none:(any "all except 1") (list ~sep:(any ", ") int))
(match codes with None -> None | Some x -> Some (IS.elements x))
type config = {
typ : typ ;
compressed : bool ;
image : string ;
fail_behaviour : fail_behaviour;
cpuid : int ;
memory : int ;
block_devices : (string * string option * int option) list ;
bridges : (string * string option * Macaddr.t option) list ;
argv : string list option ;
}
let bridges (unikernel : config) =
List.map
(fun (net, bri, _mac) -> match bri with None -> net | Some s -> s)
unikernel.bridges
let fine_with_policy (p : Policy.t) (c : config) =
let bridge_allowed set s = String_set.mem s set in
if not (IS.mem c.cpuid p.cpuids) then
Error (`Msg (Fmt.str "CPUid of unikernel (%d) not allowed by policy (%a)"
c.cpuid Fmt.(list ~sep:(any ", ") int) (IS.elements p.cpuids)))
else if c.memory > p.memory then
Error (`Msg (Fmt.str "%u MB memory assigned to unikernel exceeds policy (%uMB)"
c.memory p.memory))
else match List.partition (bridge_allowed p.Policy.bridges) (bridges c) with
| _, [] -> Ok ()
| _, disallowed ->
Error (`Msg (Fmt.str "Bridge(s) %a not allowed by policy (available: %a)"
Fmt.(list ~sep:(any ", ") string) disallowed
Fmt.(list ~sep:(any ", ") string)
(String_set.elements p.bridges)))
let pp_block ppf (name, device, sector_size) =
Fmt.pf ppf "%s -> %s%a" name (Option.value ~default:name device)
Fmt.(option ((any ", sector-size: ") ++ int)) sector_size
let pp_bridge ppf (name, bridge, mac) =
Fmt.pf ppf "%s -> %s%a" name (Option.value ~default:name bridge)
Fmt.(option ((any "@") ++ Macaddr.pp)) mac
let pp_config ppf (unikernel : config) =
Fmt.pf ppf "typ %a@ compression %B image %d bytes@ fail behaviour %a@ cpu %d@ %d MB memory@ block devices %a@ bridge %a"
pp_typ unikernel.typ
unikernel.compressed
(String.length unikernel.image)
pp_fail_behaviour unikernel.fail_behaviour
unikernel.cpuid unikernel.memory
Fmt.(list ~sep:(any ", ") pp_block) unikernel.block_devices
Fmt.(list ~sep:(any ", ") pp_bridge) unikernel.bridges
let pp_config_with_argv ppf (unikernel : config) =
Fmt.pf ppf "%a@ argv %a" pp_config unikernel
Fmt.(option ~none:(any "no") (list ~sep:(any " ") string)) unikernel.argv
let restart_handler config =
match config.fail_behaviour with `Quit -> false | `Restart _ -> true
type arguments = {
fail_behaviour : fail_behaviour;
cpuid : int ;
memory : int ;
block_devices : (string * string option * int option) list ;
bridges : (string * string option * Macaddr.t option) list ;
argv : string list option ;
}
let pp_arguments ppf (unikernel : arguments) =
Fmt.pf ppf "fail behaviour %a@ cpu %d@ %d MB memory@ block devices %a@ bridge %a"
pp_fail_behaviour unikernel.fail_behaviour
unikernel.cpuid unikernel.memory
Fmt.(list ~sep:(any ", ") pp_block) unikernel.block_devices
Fmt.(list ~sep:(any ", ") pp_bridge) unikernel.bridges
let pp_arguments_with_argv ppf (unikernel : arguments) =
Fmt.pf ppf "%a@ argv %a" pp_arguments unikernel
Fmt.(option ~none:(any "no") (list ~sep:(any " ") string)) unikernel.argv
type t = {
config : config ;
cmd : string array ;
pid : int ;
taps : (string * Macaddr.t) list ;
digest : string ;
started : Ptime.t ;
}
let pp ppf unikernel =
let hex_digest = Ohex.encode unikernel.digest in
Fmt.pf ppf "pid %d@ taps %a (block %a) cmdline %a digest %s"
unikernel.pid
Fmt.(list ~sep:(any ", ") (pair ~sep:(any ": ") string Macaddr.pp)) unikernel.taps
Fmt.(list ~sep:(any ", ") pp_block) unikernel.config.block_devices
Fmt.(array ~sep:(any " ") string) unikernel.cmd
hex_digest
type block_info = {
unikernel_device : string ;
host_device : string ;
sector_size : int ;
size : int ;
}
let pp_block_info ppf { unikernel_device ; host_device ; sector_size ; size } =
Fmt.pf ppf "%s -> %s (sector-size: %u bytes, size %u MB)"
unikernel_device host_device sector_size size
type net_info = {
unikernel_device : string ;
host_device : string ;
mac : Macaddr.t ;
}
let pp_net_info ppf { unikernel_device ; host_device ; mac } =
Fmt.pf ppf "%s -> %s (mac %a)" unikernel_device host_device
Macaddr.pp mac
type info = {
typ : typ ;
fail_behaviour : fail_behaviour;
cpuid : int ;
memory : int ;
block_devices : block_info list ;
bridges : net_info list ;
argv : string list option ;
digest : string ;
started : Ptime.t ;
}
let info block_size t =
let cfg = t.config in
let block_devices =
List.map (fun (unikernel_device, host_device, sector_size) ->
let host_device = Option.value ~default:unikernel_device host_device
and sector_size = Option.value ~default:512 sector_size
in
let size = Option.value ~default:0 (block_size host_device) in
{ unikernel_device ; host_device ; sector_size ; size })
cfg.block_devices
and bridges =
List.map2 (fun (unikernel_device, host_device, _mac) (_tap, mac) ->
let host_device = Option.value ~default:unikernel_device host_device in
{ unikernel_device ; host_device ; mac }
) cfg.bridges t.taps
in
{ typ = cfg.typ ; fail_behaviour = cfg.fail_behaviour ; cpuid = cfg.cpuid ;
memory = cfg.memory ; block_devices ;
bridges ; argv = cfg.argv ; digest = t.digest ; started = t.started }
let pp_info ppf (info : info) =
let hex_digest = Ohex.encode info.digest in
Fmt.pf ppf "typ %a@ started %a@ fail behaviour %a@ cpu %d@ %d MB memory@ block devices %a@ bridge %a@ digest %s"
pp_typ info.typ
(Ptime.pp_rfc3339 ()) info.started
pp_fail_behaviour info.fail_behaviour
info.cpuid info.memory
Fmt.(list ~sep:(any ", ") pp_block_info) info.block_devices
Fmt.(list ~sep:(any ", ") pp_net_info) info.bridges
hex_digest
let pp_info_with_argv ppf (info : info) =
Fmt.pf ppf "%a@ argv %a"
pp_info info
Fmt.(option ~none:(any "no") (list ~sep:(any " ") string)) info.argv
end
module Stats = struct
type rusage = {
utime : (int64 * int) ;
stime : (int64 * int) ;
maxrss : int64 ;
ixrss : int64 ;
idrss : int64 ;
isrss : int64 ;
minflt : int64 ;
majflt : int64 ;
nswap : int64 ;
inblock : int64 ;
outblock : int64 ;
msgsnd : int64 ;
msgrcv : int64 ;
nsignals : int64 ;
nvcsw : int64 ;
nivcsw : int64 ;
}
let pp_rusage ppf r =
Fmt.pf ppf "utime %Lu.%06d stime %Lu.%06d maxrss %Lu ixrss %Lu idrss %Lu isrss %Lu minflt %Lu majflt %Lu nswap %Lu inblock %Lu outblock %Lu msgsnd %Lu msgrcv %Lu signals %Lu nvcsw %Lu nivcsw %Lu"
(fst r.utime) (snd r.utime) (fst r.stime) (snd r.stime) r.maxrss r.ixrss r.idrss r.isrss r.minflt r.majflt r.nswap r.inblock r.outblock r.msgsnd r.msgrcv r.nsignals r.nvcsw r.nivcsw
let pp_rusage_mem ppf r =
Fmt.pf ppf "maxrss %Lu ixrss %Lu idrss %Lu isrss %Lu minflt %Lu majflt %Lu"
r.maxrss r.ixrss r.idrss r.isrss r.minflt r.majflt
type kinfo_mem = {
vsize : int64 ;
rss : int64 ;
tsize : int64 ;
dsize : int64 ;
ssize : int64 ;
runtime : int64 ;
cow : int ;
start : (int64 * int) ;
}
let pp_kinfo_mem ppf t =
Fmt.pf ppf "virtual-size %Lu rss %Lu text-size %Lu data-size %Lu stack-size %Lu runtime %Lu cow %u start %Lu.%06d"
t.vsize t.rss t.tsize t.dsize t.ssize t.runtime t.cow (fst t.start) (snd t.start)
type vmm = (string * int64) list
let pp_vmm ppf vmm =
Fmt.(list ~sep:(any "@.") (pair ~sep:(any ": ") string int64)) ppf vmm
let pp_vmm_mem ppf vmm =
Fmt.(list ~sep:(any "@.") (pair ~sep:(any ": ") string int64)) ppf
(List.filter (fun (k, _) -> k = "Resident memory" || k = "Wired memory") vmm)
type ifdata = {
bridge : string ;
flags : int32 ;
send_length : int32 ;
max_send_length : int32 ;
send_drops : int32 ;
mtu : int32 ;
baudrate : int64 ;
input_packets : int64 ;
input_errors : int64 ;
output_packets : int64 ;
output_errors : int64 ;
collisions : int64 ;
input_bytes : int64 ;
output_bytes : int64 ;
input_mcast : int64 ;
output_mcast : int64 ;
input_dropped : int64 ;
output_dropped : int64 ;
}
let pp_ifdata ppf i =
Fmt.pf ppf "bridge %s flags %lX send_length %lu max_send_length %lu send_drops %lu mtu %lu baudrate %Lu input_packets %Lu input_errors %Lu output_packets %Lu output_errors %Lu collisions %Lu input_bytes %Lu output_bytes %Lu input_mcast %Lu output_mcast %Lu input_dropped %Lu output_dropped %Lu"
i.bridge i.flags i.send_length i.max_send_length i.send_drops i.mtu i.baudrate i.input_packets i.input_errors i.output_packets i.output_errors i.collisions i.input_bytes i.output_bytes i.input_mcast i.output_mcast i.input_dropped i.output_dropped
type t = rusage * kinfo_mem option * vmm option * ifdata list
let pp ppf (ru, mem, vmm, ifs) =
Fmt.pf ppf "%a@.%a@.%a@.%a"
pp_rusage ru
Fmt.(option ~none:(any "no kinfo_mem stats") pp_kinfo_mem) mem
Fmt.(option ~none:(any "no vmm stats") pp_vmm) vmm
Fmt.(list ~sep:(any "@.@.") pp_ifdata) ifs
end
type process_exit = [ `Exit of int | `Signal of int | `Stop of int ]
let pp_process_exit ppf = function
| `Exit n -> Fmt.pf ppf "exit %d" n
| `Signal n -> Fmt.pf ppf "signal %a (numeric %d)" Fmt.Dump.signal n n
| `Stop n -> Fmt.pf ppf "stop %a (numeric %d)" Fmt.Dump.signal n n
let should_restart (config : Unikernel.config) name = function
| (`Signal _ | `Stop _) as r ->
Logs.warn (fun m -> m "unikernel %a exited with signal %a"
Name.pp name pp_process_exit r);
false
| `Exit i ->
let opt_mem i =
match config.Unikernel.fail_behaviour with
| `Quit -> assert false
| `Restart None -> true
| `Restart (Some c) -> IS.mem i c
in
match i with
| 1 ->
Logs.warn (fun m -> m "unikernel %a solo5 exit failure (1)"
Name.pp name);
false
| 60 | 61 | 62 | 63 | 64 ->
Logs.warn (fun m -> m "unikernel %a exited %d, not restarting"
Name.pp name i);
false
| _ when opt_mem i ->
Logs.info (fun m -> m "unikernel %a exited %d, restarting"
Name.pp name i);
true
| _ ->
Logs.info (fun m -> m "unikernel %a exited %d, not restarting %a"
Name.pp name i Unikernel.pp_fail_behaviour config.fail_behaviour);
false