]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/basic/virt.c
grypt-util: drop two emacs modelines
[thirdparty/systemd.git] / src / basic / virt.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 /***
3 Copyright 2011 Lennart Poettering
4 ***/
5
6 #if defined(__i386__) || defined(__x86_64__)
7 #include <cpuid.h>
8 #endif
9 #include <errno.h>
10 #include <stdint.h>
11 #include <stdlib.h>
12 #include <string.h>
13 #include <unistd.h>
14
15 #include "alloc-util.h"
16 #include "dirent-util.h"
17 #include "env-util.h"
18 #include "fd-util.h"
19 #include "fileio.h"
20 #include "macro.h"
21 #include "process-util.h"
22 #include "stat-util.h"
23 #include "string-table.h"
24 #include "string-util.h"
25 #include "virt.h"
26
27 static int detect_vm_cpuid(void) {
28
29 /* CPUID is an x86 specific interface. */
30 #if defined(__i386__) || defined(__x86_64__)
31
32 static const struct {
33 const char *cpuid;
34 int id;
35 } cpuid_vendor_table[] = {
36 { "XenVMMXenVMM", VIRTUALIZATION_XEN },
37 { "KVMKVMKVM", VIRTUALIZATION_KVM },
38 { "TCGTCGTCGTCG", VIRTUALIZATION_QEMU },
39 /* http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1009458 */
40 { "VMwareVMware", VIRTUALIZATION_VMWARE },
41 /* https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/tlfs */
42 { "Microsoft Hv", VIRTUALIZATION_MICROSOFT },
43 /* https://wiki.freebsd.org/bhyve */
44 { "bhyve bhyve ", VIRTUALIZATION_BHYVE },
45 { "QNXQVMBSQG", VIRTUALIZATION_QNX },
46 };
47
48 uint32_t eax, ebx, ecx, edx;
49 bool hypervisor;
50
51 /* http://lwn.net/Articles/301888/ */
52
53 /* First detect whether there is a hypervisor */
54 if (__get_cpuid(1, &eax, &ebx, &ecx, &edx) == 0)
55 return VIRTUALIZATION_NONE;
56
57 hypervisor = ecx & 0x80000000U;
58
59 if (hypervisor) {
60 union {
61 uint32_t sig32[3];
62 char text[13];
63 } sig = {};
64 unsigned j;
65
66 /* There is a hypervisor, see what it is */
67 __cpuid(0x40000000U, eax, ebx, ecx, edx);
68
69 sig.sig32[0] = ebx;
70 sig.sig32[1] = ecx;
71 sig.sig32[2] = edx;
72
73 log_debug("Virtualization found, CPUID=%s", sig.text);
74
75 for (j = 0; j < ELEMENTSOF(cpuid_vendor_table); j ++)
76 if (streq(sig.text, cpuid_vendor_table[j].cpuid))
77 return cpuid_vendor_table[j].id;
78
79 return VIRTUALIZATION_VM_OTHER;
80 }
81 #endif
82 log_debug("No virtualization found in CPUID");
83
84 return VIRTUALIZATION_NONE;
85 }
86
87 static int detect_vm_device_tree(void) {
88 #if defined(__arm__) || defined(__aarch64__) || defined(__powerpc__) || defined(__powerpc64__)
89 _cleanup_free_ char *hvtype = NULL;
90 int r;
91
92 r = read_one_line_file("/proc/device-tree/hypervisor/compatible", &hvtype);
93 if (r == -ENOENT) {
94 _cleanup_closedir_ DIR *dir = NULL;
95 struct dirent *dent;
96
97 dir = opendir("/proc/device-tree");
98 if (!dir) {
99 if (errno == ENOENT) {
100 log_debug_errno(errno, "/proc/device-tree: %m");
101 return VIRTUALIZATION_NONE;
102 }
103 return -errno;
104 }
105
106 FOREACH_DIRENT(dent, dir, return -errno)
107 if (strstr(dent->d_name, "fw-cfg")) {
108 log_debug("Virtualization QEMU: \"fw-cfg\" present in /proc/device-tree/%s", dent->d_name);
109 return VIRTUALIZATION_QEMU;
110 }
111
112 log_debug("No virtualization found in /proc/device-tree/*");
113 return VIRTUALIZATION_NONE;
114 } else if (r < 0)
115 return r;
116
117 log_debug("Virtualization %s found in /proc/device-tree/hypervisor/compatible", hvtype);
118 if (streq(hvtype, "linux,kvm"))
119 return VIRTUALIZATION_KVM;
120 else if (strstr(hvtype, "xen"))
121 return VIRTUALIZATION_XEN;
122 else
123 return VIRTUALIZATION_VM_OTHER;
124 #else
125 log_debug("This platform does not support /proc/device-tree");
126 return VIRTUALIZATION_NONE;
127 #endif
128 }
129
130 static int detect_vm_dmi(void) {
131 #if defined(__i386__) || defined(__x86_64__) || defined(__arm__) || defined(__aarch64__)
132
133 static const char *const dmi_vendors[] = {
134 "/sys/class/dmi/id/product_name", /* Test this before sys_vendor to detect KVM over QEMU */
135 "/sys/class/dmi/id/sys_vendor",
136 "/sys/class/dmi/id/board_vendor",
137 "/sys/class/dmi/id/bios_vendor"
138 };
139
140 static const struct {
141 const char *vendor;
142 int id;
143 } dmi_vendor_table[] = {
144 { "KVM", VIRTUALIZATION_KVM },
145 { "QEMU", VIRTUALIZATION_QEMU },
146 /* http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1009458 */
147 { "VMware", VIRTUALIZATION_VMWARE },
148 { "VMW", VIRTUALIZATION_VMWARE },
149 { "innotek GmbH", VIRTUALIZATION_ORACLE },
150 { "Xen", VIRTUALIZATION_XEN },
151 { "Bochs", VIRTUALIZATION_BOCHS },
152 { "Parallels", VIRTUALIZATION_PARALLELS },
153 /* https://wiki.freebsd.org/bhyve */
154 { "BHYVE", VIRTUALIZATION_BHYVE },
155 };
156 unsigned i;
157 int r;
158
159 for (i = 0; i < ELEMENTSOF(dmi_vendors); i++) {
160 _cleanup_free_ char *s = NULL;
161 unsigned j;
162
163 r = read_one_line_file(dmi_vendors[i], &s);
164 if (r < 0) {
165 if (r == -ENOENT)
166 continue;
167
168 return r;
169 }
170
171 for (j = 0; j < ELEMENTSOF(dmi_vendor_table); j++)
172 if (startswith(s, dmi_vendor_table[j].vendor)) {
173 log_debug("Virtualization %s found in DMI (%s)", s, dmi_vendors[i]);
174 return dmi_vendor_table[j].id;
175 }
176 }
177 #endif
178
179 log_debug("No virtualization found in DMI");
180
181 return VIRTUALIZATION_NONE;
182 }
183
184 static int detect_vm_xen(void) {
185
186 /* Check for Dom0 will be executed later in detect_vm_xen_dom0
187 The presence of /proc/xen indicates some form of a Xen domain */
188 if (access("/proc/xen", F_OK) < 0) {
189 log_debug("Virtualization XEN not found, /proc/xen does not exist");
190 return VIRTUALIZATION_NONE;
191 }
192
193 log_debug("Virtualization XEN found (/proc/xen exists)");
194 return VIRTUALIZATION_XEN;
195 }
196
197 #define XENFEAT_dom0 11 /* xen/include/public/features.h */
198 #define PATH_FEATURES "/sys/hypervisor/properties/features"
199 /* Returns -errno, or 0 for domU, or 1 for dom0 */
200 static int detect_vm_xen_dom0(void) {
201 _cleanup_free_ char *domcap = NULL;
202 char *cap, *i;
203 int r;
204
205 r = read_one_line_file(PATH_FEATURES, &domcap);
206 if (r < 0 && r != -ENOENT)
207 return r;
208 if (r == 0) {
209 unsigned long features;
210
211 /* Here, we need to use sscanf() instead of safe_atoul()
212 * as the string lacks the leading "0x". */
213 r = sscanf(domcap, "%lx", &features);
214 if (r == 1) {
215 r = !!(features & (1U << XENFEAT_dom0));
216 log_debug("Virtualization XEN, found %s with value %08lx, "
217 "XENFEAT_dom0 (indicating the 'hardware domain') is%s set.",
218 PATH_FEATURES, features, r ? "" : " not");
219 return r;
220 }
221 log_debug("Virtualization XEN, found %s, unhandled content '%s'",
222 PATH_FEATURES, domcap);
223 }
224
225 r = read_one_line_file("/proc/xen/capabilities", &domcap);
226 if (r == -ENOENT) {
227 log_debug("Virtualization XEN because /proc/xen/capabilities does not exist");
228 return 0;
229 }
230 if (r < 0)
231 return r;
232
233 i = domcap;
234 while ((cap = strsep(&i, ",")))
235 if (streq(cap, "control_d"))
236 break;
237 if (!cap) {
238 log_debug("Virtualization XEN DomU found (/proc/xen/capabilites)");
239 return 0;
240 }
241
242 log_debug("Virtualization XEN Dom0 ignored (/proc/xen/capabilities)");
243 return 1;
244 }
245
246 static int detect_vm_hypervisor(void) {
247 _cleanup_free_ char *hvtype = NULL;
248 int r;
249
250 r = read_one_line_file("/sys/hypervisor/type", &hvtype);
251 if (r == -ENOENT)
252 return VIRTUALIZATION_NONE;
253 if (r < 0)
254 return r;
255
256 log_debug("Virtualization %s found in /sys/hypervisor/type", hvtype);
257
258 if (streq(hvtype, "xen"))
259 return VIRTUALIZATION_XEN;
260 else
261 return VIRTUALIZATION_VM_OTHER;
262 }
263
264 static int detect_vm_uml(void) {
265 _cleanup_free_ char *cpuinfo_contents = NULL;
266 int r;
267
268 /* Detect User-Mode Linux by reading /proc/cpuinfo */
269 r = read_full_file("/proc/cpuinfo", &cpuinfo_contents, NULL);
270 if (r == -ENOENT) {
271 log_debug("/proc/cpuinfo not found, assuming no UML virtualization.");
272 return VIRTUALIZATION_NONE;
273 }
274 if (r < 0)
275 return r;
276
277 if (strstr(cpuinfo_contents, "\nvendor_id\t: User Mode Linux\n")) {
278 log_debug("UML virtualization found in /proc/cpuinfo");
279 return VIRTUALIZATION_UML;
280 }
281
282 log_debug("UML virtualization not found in /proc/cpuinfo.");
283 return VIRTUALIZATION_NONE;
284 }
285
286 static int detect_vm_zvm(void) {
287
288 #if defined(__s390__)
289 _cleanup_free_ char *t = NULL;
290 int r;
291
292 r = get_proc_field("/proc/sysinfo", "VM00 Control Program", WHITESPACE, &t);
293 if (r == -ENOENT)
294 return VIRTUALIZATION_NONE;
295 if (r < 0)
296 return r;
297
298 log_debug("Virtualization %s found in /proc/sysinfo", t);
299 if (streq(t, "z/VM"))
300 return VIRTUALIZATION_ZVM;
301 else
302 return VIRTUALIZATION_KVM;
303 #else
304 log_debug("This platform does not support /proc/sysinfo");
305 return VIRTUALIZATION_NONE;
306 #endif
307 }
308
309 /* Returns a short identifier for the various VM implementations */
310 int detect_vm(void) {
311 static thread_local int cached_found = _VIRTUALIZATION_INVALID;
312 bool other = false;
313 int r, dmi;
314
315 if (cached_found >= 0)
316 return cached_found;
317
318 /* We have to use the correct order here:
319 *
320 * → First, try to detect Oracle Virtualbox, even if it uses KVM, as well as Xen even if it cloaks as Microsoft
321 * Hyper-V.
322 *
323 * → Second, try to detect from CPUID, this will report KVM for whatever software is used even if info in DMI is
324 * overwritten.
325 *
326 * → Third, try to detect from DMI. */
327
328 dmi = detect_vm_dmi();
329 if (IN_SET(dmi, VIRTUALIZATION_ORACLE, VIRTUALIZATION_XEN)) {
330 r = dmi;
331 goto finish;
332 }
333
334 r = detect_vm_cpuid();
335 if (r < 0)
336 return r;
337 if (r == VIRTUALIZATION_VM_OTHER)
338 other = true;
339 else if (r != VIRTUALIZATION_NONE)
340 goto finish;
341
342 /* Now, let's get back to DMI */
343 if (dmi < 0)
344 return dmi;
345 if (dmi == VIRTUALIZATION_VM_OTHER)
346 other = true;
347 else if (dmi != VIRTUALIZATION_NONE) {
348 r = dmi;
349 goto finish;
350 }
351
352 /* x86 xen will most likely be detected by cpuid. If not (most likely
353 * because we're not an x86 guest), then we should try the /proc/xen
354 * directory next. If that's not found, then we check for the high-level
355 * hypervisor sysfs file.
356 */
357
358 r = detect_vm_xen();
359 if (r < 0)
360 return r;
361 if (r == VIRTUALIZATION_VM_OTHER)
362 other = true;
363 else if (r != VIRTUALIZATION_NONE)
364 goto finish;
365
366 r = detect_vm_hypervisor();
367 if (r < 0)
368 return r;
369 if (r == VIRTUALIZATION_VM_OTHER)
370 other = true;
371 else if (r != VIRTUALIZATION_NONE)
372 goto finish;
373
374 r = detect_vm_device_tree();
375 if (r < 0)
376 return r;
377 if (r == VIRTUALIZATION_VM_OTHER)
378 other = true;
379 else if (r != VIRTUALIZATION_NONE)
380 goto finish;
381
382 r = detect_vm_uml();
383 if (r < 0)
384 return r;
385 if (r == VIRTUALIZATION_VM_OTHER)
386 other = true;
387 else if (r != VIRTUALIZATION_NONE)
388 goto finish;
389
390 r = detect_vm_zvm();
391 if (r < 0)
392 return r;
393
394 finish:
395 /* x86 xen Dom0 is detected as XEN in hypervisor and maybe others.
396 * In order to detect the Dom0 as not virtualization we need to
397 * double-check it */
398 if (r == VIRTUALIZATION_XEN) {
399 int dom0;
400
401 dom0 = detect_vm_xen_dom0();
402 if (dom0 < 0)
403 return dom0;
404 if (dom0 > 0)
405 r = VIRTUALIZATION_NONE;
406 } else if (r == VIRTUALIZATION_NONE && other)
407 r = VIRTUALIZATION_VM_OTHER;
408
409 cached_found = r;
410 log_debug("Found VM virtualization %s", virtualization_to_string(r));
411 return r;
412 }
413
414 int detect_container(void) {
415
416 static const struct {
417 const char *value;
418 int id;
419 } value_table[] = {
420 { "lxc", VIRTUALIZATION_LXC },
421 { "lxc-libvirt", VIRTUALIZATION_LXC_LIBVIRT },
422 { "systemd-nspawn", VIRTUALIZATION_SYSTEMD_NSPAWN },
423 { "docker", VIRTUALIZATION_DOCKER },
424 { "rkt", VIRTUALIZATION_RKT },
425 };
426
427 static thread_local int cached_found = _VIRTUALIZATION_INVALID;
428 _cleanup_free_ char *m = NULL;
429 const char *e = NULL;
430 unsigned j;
431 int r;
432
433 if (cached_found >= 0)
434 return cached_found;
435
436 /* /proc/vz exists in container and outside of the container, /proc/bc only outside of the container. */
437 if (access("/proc/vz", F_OK) >= 0 &&
438 access("/proc/bc", F_OK) < 0) {
439 r = VIRTUALIZATION_OPENVZ;
440 goto finish;
441 }
442
443 if (getpid_cached() == 1) {
444 /* If we are PID 1 we can just check our own environment variable, and that's authoritative. */
445
446 e = getenv("container");
447 if (isempty(e)) {
448 r = VIRTUALIZATION_NONE;
449 goto finish;
450 }
451
452 goto translate_name;
453 }
454
455 /* Otherwise, PID 1 might have dropped this information into a file in /run. This is better than accessing
456 * /proc/1/environ, since we don't need CAP_SYS_PTRACE for that. */
457 r = read_one_line_file("/run/systemd/container", &m);
458 if (r >= 0) {
459 e = m;
460 goto translate_name;
461 }
462 if (r != -ENOENT)
463 return log_debug_errno(r, "Failed to read /run/systemd/container: %m");
464
465 /* Fallback for cases where PID 1 was not systemd (for example, cases where init=/bin/sh is used. */
466 r = getenv_for_pid(1, "container", &m);
467 if (r > 0) {
468 e = m;
469 goto translate_name;
470 }
471 if (r < 0) /* This only works if we have CAP_SYS_PTRACE, hence let's better ignore failures here */
472 log_debug_errno(r, "Failed to read $container of PID 1, ignoring: %m");
473
474 /* Interestingly /proc/1/sched actually shows the host's PID for what we see as PID 1. Hence, if the PID shown
475 * there is not 1, we know we are in a PID namespace. and hence a container. */
476 r = read_one_line_file("/proc/1/sched", &m);
477 if (r >= 0) {
478 const char *t;
479
480 t = strrchr(m, '(');
481 if (!t)
482 return -EIO;
483
484 if (!startswith(t, "(1,")) {
485 r = VIRTUALIZATION_CONTAINER_OTHER;
486 goto finish;
487 }
488 } else if (r != -ENOENT)
489 return r;
490
491 /* If that didn't work, give up, assume no container manager. */
492 r = VIRTUALIZATION_NONE;
493 goto finish;
494
495 translate_name:
496 for (j = 0; j < ELEMENTSOF(value_table); j++)
497 if (streq(e, value_table[j].value)) {
498 r = value_table[j].id;
499 goto finish;
500 }
501
502 r = VIRTUALIZATION_CONTAINER_OTHER;
503
504 finish:
505 log_debug("Found container virtualization %s.", virtualization_to_string(r));
506 cached_found = r;
507 return r;
508 }
509
510 int detect_virtualization(void) {
511 int r;
512
513 r = detect_container();
514 if (r == 0)
515 r = detect_vm();
516
517 return r;
518 }
519
520 static int userns_has_mapping(const char *name) {
521 _cleanup_fclose_ FILE *f = NULL;
522 _cleanup_free_ char *buf = NULL;
523 size_t n_allocated = 0;
524 ssize_t n;
525 uint32_t a, b, c;
526 int r;
527
528 f = fopen(name, "re");
529 if (!f) {
530 log_debug_errno(errno, "Failed to open %s: %m", name);
531 return errno == ENOENT ? false : -errno;
532 }
533
534 n = getline(&buf, &n_allocated, f);
535 if (n < 0) {
536 if (feof(f)) {
537 log_debug("%s is empty, we're in an uninitialized user namespace", name);
538 return true;
539 }
540
541 return log_debug_errno(errno, "Failed to read %s: %m", name);
542 }
543
544 r = sscanf(buf, "%"PRIu32" %"PRIu32" %"PRIu32, &a, &b, &c);
545 if (r < 3)
546 return log_debug_errno(errno, "Failed to parse %s: %m", name);
547
548 if (a == 0 && b == 0 && c == UINT32_MAX) {
549 /* The kernel calls mappings_overlap() and does not allow overlaps */
550 log_debug("%s has a full 1:1 mapping", name);
551 return false;
552 }
553
554 /* Anything else implies that we are in a user namespace */
555 log_debug("Mapping found in %s, we're in a user namespace", name);
556 return true;
557 }
558
559 int running_in_userns(void) {
560 _cleanup_free_ char *line = NULL;
561 int r;
562
563 r = userns_has_mapping("/proc/self/uid_map");
564 if (r != 0)
565 return r;
566
567 r = userns_has_mapping("/proc/self/gid_map");
568 if (r != 0)
569 return r;
570
571 /* "setgroups" file was added in kernel v3.18-rc6-15-g9cc46516dd. It is also
572 * possible to compile a kernel without CONFIG_USER_NS, in which case "setgroups"
573 * also does not exist. We cannot distinguish those two cases, so assume that
574 * we're running on a stripped-down recent kernel, rather than on an old one,
575 * and if the file is not found, return false.
576 */
577 r = read_one_line_file("/proc/self/setgroups", &line);
578 if (r < 0) {
579 log_debug_errno(r, "/proc/self/setgroups: %m");
580 return r == -ENOENT ? false : r;
581 }
582
583 truncate_nl(line);
584 r = streq(line, "deny");
585 /* See user_namespaces(7) for a description of this "setgroups" contents. */
586 log_debug("/proc/self/setgroups contains \"%s\", %s user namespace", line, r ? "in" : "not in");
587 return r;
588 }
589
590 int running_in_chroot(void) {
591 int r;
592
593 if (getenv_bool("SYSTEMD_IGNORE_CHROOT") > 0)
594 return 0;
595
596 r = files_same("/proc/1/root", "/", 0);
597 if (r < 0)
598 return r;
599
600 return r == 0;
601 }
602
603 static const char *const virtualization_table[_VIRTUALIZATION_MAX] = {
604 [VIRTUALIZATION_NONE] = "none",
605 [VIRTUALIZATION_KVM] = "kvm",
606 [VIRTUALIZATION_QEMU] = "qemu",
607 [VIRTUALIZATION_BOCHS] = "bochs",
608 [VIRTUALIZATION_XEN] = "xen",
609 [VIRTUALIZATION_UML] = "uml",
610 [VIRTUALIZATION_VMWARE] = "vmware",
611 [VIRTUALIZATION_ORACLE] = "oracle",
612 [VIRTUALIZATION_MICROSOFT] = "microsoft",
613 [VIRTUALIZATION_ZVM] = "zvm",
614 [VIRTUALIZATION_PARALLELS] = "parallels",
615 [VIRTUALIZATION_BHYVE] = "bhyve",
616 [VIRTUALIZATION_QNX] = "qnx",
617 [VIRTUALIZATION_VM_OTHER] = "vm-other",
618
619 [VIRTUALIZATION_SYSTEMD_NSPAWN] = "systemd-nspawn",
620 [VIRTUALIZATION_LXC_LIBVIRT] = "lxc-libvirt",
621 [VIRTUALIZATION_LXC] = "lxc",
622 [VIRTUALIZATION_OPENVZ] = "openvz",
623 [VIRTUALIZATION_DOCKER] = "docker",
624 [VIRTUALIZATION_RKT] = "rkt",
625 [VIRTUALIZATION_CONTAINER_OTHER] = "container-other",
626 };
627
628 DEFINE_STRING_TABLE_LOOKUP(virtualization, int);