1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2011 Lennart Poettering
8 #if defined(__i386__) || defined(__x86_64__)
17 #include "alloc-util.h"
18 #include "dirent-util.h"
23 #include "process-util.h"
24 #include "stat-util.h"
25 #include "string-table.h"
26 #include "string-util.h"
29 static int detect_vm_cpuid(void) {
31 /* CPUID is an x86 specific interface. */
32 #if defined(__i386__) || defined(__x86_64__)
37 } cpuid_vendor_table
[] = {
38 { "XenVMMXenVMM", VIRTUALIZATION_XEN
},
39 { "KVMKVMKVM", VIRTUALIZATION_KVM
},
40 { "TCGTCGTCGTCG", VIRTUALIZATION_QEMU
},
41 /* http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1009458 */
42 { "VMwareVMware", VIRTUALIZATION_VMWARE
},
43 /* https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/tlfs */
44 { "Microsoft Hv", VIRTUALIZATION_MICROSOFT
},
45 /* https://wiki.freebsd.org/bhyve */
46 { "bhyve bhyve ", VIRTUALIZATION_BHYVE
},
47 { "QNXQVMBSQG", VIRTUALIZATION_QNX
},
50 uint32_t eax
, ebx
, ecx
, edx
;
53 /* http://lwn.net/Articles/301888/ */
55 /* First detect whether there is a hypervisor */
56 if (__get_cpuid(1, &eax
, &ebx
, &ecx
, &edx
) == 0)
57 return VIRTUALIZATION_NONE
;
59 hypervisor
= !!(ecx
& 0x80000000U
);
68 /* There is a hypervisor, see what it is */
69 __cpuid(0x40000000U
, eax
, ebx
, ecx
, edx
);
75 log_debug("Virtualization found, CPUID=%s", sig
.text
);
77 for (j
= 0; j
< ELEMENTSOF(cpuid_vendor_table
); j
++)
78 if (streq(sig
.text
, cpuid_vendor_table
[j
].cpuid
))
79 return cpuid_vendor_table
[j
].id
;
81 return VIRTUALIZATION_VM_OTHER
;
84 log_debug("No virtualization found in CPUID");
86 return VIRTUALIZATION_NONE
;
89 static int detect_vm_device_tree(void) {
90 #if defined(__arm__) || defined(__aarch64__) || defined(__powerpc__) || defined(__powerpc64__)
91 _cleanup_free_
char *hvtype
= NULL
;
94 r
= read_one_line_file("/proc/device-tree/hypervisor/compatible", &hvtype
);
96 _cleanup_closedir_
DIR *dir
= NULL
;
99 dir
= opendir("/proc/device-tree");
101 if (errno
== ENOENT
) {
102 log_debug_errno(errno
, "/proc/device-tree: %m");
103 return VIRTUALIZATION_NONE
;
108 FOREACH_DIRENT(dent
, dir
, return -errno
)
109 if (strstr(dent
->d_name
, "fw-cfg")) {
110 log_debug("Virtualization QEMU: \"fw-cfg\" present in /proc/device-tree/%s", dent
->d_name
);
111 return VIRTUALIZATION_QEMU
;
114 log_debug("No virtualization found in /proc/device-tree/*");
115 return VIRTUALIZATION_NONE
;
119 log_debug("Virtualization %s found in /proc/device-tree/hypervisor/compatible", hvtype
);
120 if (streq(hvtype
, "linux,kvm"))
121 return VIRTUALIZATION_KVM
;
122 else if (strstr(hvtype
, "xen"))
123 return VIRTUALIZATION_XEN
;
125 return VIRTUALIZATION_VM_OTHER
;
127 log_debug("This platform does not support /proc/device-tree");
128 return VIRTUALIZATION_NONE
;
132 static int detect_vm_dmi(void) {
133 #if defined(__i386__) || defined(__x86_64__) || defined(__arm__) || defined(__aarch64__)
135 static const char *const dmi_vendors
[] = {
136 "/sys/class/dmi/id/product_name", /* Test this before sys_vendor to detect KVM over QEMU */
137 "/sys/class/dmi/id/sys_vendor",
138 "/sys/class/dmi/id/board_vendor",
139 "/sys/class/dmi/id/bios_vendor"
142 static const struct {
145 } dmi_vendor_table
[] = {
146 { "KVM", VIRTUALIZATION_KVM
},
147 { "QEMU", VIRTUALIZATION_QEMU
},
148 /* http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1009458 */
149 { "VMware", VIRTUALIZATION_VMWARE
},
150 { "VMW", VIRTUALIZATION_VMWARE
},
151 { "innotek GmbH", VIRTUALIZATION_ORACLE
},
152 { "Xen", VIRTUALIZATION_XEN
},
153 { "Bochs", VIRTUALIZATION_BOCHS
},
154 { "Parallels", VIRTUALIZATION_PARALLELS
},
155 /* https://wiki.freebsd.org/bhyve */
156 { "BHYVE", VIRTUALIZATION_BHYVE
},
161 for (i
= 0; i
< ELEMENTSOF(dmi_vendors
); i
++) {
162 _cleanup_free_
char *s
= NULL
;
165 r
= read_one_line_file(dmi_vendors
[i
], &s
);
173 for (j
= 0; j
< ELEMENTSOF(dmi_vendor_table
); j
++)
174 if (startswith(s
, dmi_vendor_table
[j
].vendor
)) {
175 log_debug("Virtualization %s found in DMI (%s)", s
, dmi_vendors
[i
]);
176 return dmi_vendor_table
[j
].id
;
181 log_debug("No virtualization found in DMI");
183 return VIRTUALIZATION_NONE
;
186 static int detect_vm_xen(void) {
188 /* Check for Dom0 will be executed later in detect_vm_xen_dom0
189 The presence of /proc/xen indicates some form of a Xen domain */
190 if (access("/proc/xen", F_OK
) < 0) {
191 log_debug("Virtualization XEN not found, /proc/xen does not exist");
192 return VIRTUALIZATION_NONE
;
195 log_debug("Virtualization XEN found (/proc/xen exists)");
196 return VIRTUALIZATION_XEN
;
199 #define XENFEAT_dom0 11 /* xen/include/public/features.h */
200 #define PATH_FEATURES "/sys/hypervisor/properties/features"
201 /* Returns -errno, or 0 for domU, or 1 for dom0 */
202 static int detect_vm_xen_dom0(void) {
203 _cleanup_free_
char *domcap
= NULL
;
207 r
= read_one_line_file(PATH_FEATURES
, &domcap
);
208 if (r
< 0 && r
!= -ENOENT
)
211 unsigned long features
;
213 /* Here, we need to use sscanf() instead of safe_atoul()
214 * as the string lacks the leading "0x". */
215 r
= sscanf(domcap
, "%lx", &features
);
217 r
= !!(features
& (1U << XENFEAT_dom0
));
218 log_debug("Virtualization XEN, found %s with value %08lx, "
219 "XENFEAT_dom0 (indicating the 'hardware domain') is%s set.",
220 PATH_FEATURES
, features
, r
? "" : " not");
223 log_debug("Virtualization XEN, found %s, unhandled content '%s'",
224 PATH_FEATURES
, domcap
);
227 r
= read_one_line_file("/proc/xen/capabilities", &domcap
);
229 log_debug("Virtualization XEN because /proc/xen/capabilities does not exist");
236 while ((cap
= strsep(&i
, ",")))
237 if (streq(cap
, "control_d"))
240 log_debug("Virtualization XEN DomU found (/proc/xen/capabilites)");
244 log_debug("Virtualization XEN Dom0 ignored (/proc/xen/capabilities)");
248 static int detect_vm_hypervisor(void) {
249 _cleanup_free_
char *hvtype
= NULL
;
252 r
= read_one_line_file("/sys/hypervisor/type", &hvtype
);
254 return VIRTUALIZATION_NONE
;
258 log_debug("Virtualization %s found in /sys/hypervisor/type", hvtype
);
260 if (streq(hvtype
, "xen"))
261 return VIRTUALIZATION_XEN
;
263 return VIRTUALIZATION_VM_OTHER
;
266 static int detect_vm_uml(void) {
267 _cleanup_free_
char *cpuinfo_contents
= NULL
;
270 /* Detect User-Mode Linux by reading /proc/cpuinfo */
271 r
= read_full_file("/proc/cpuinfo", &cpuinfo_contents
, NULL
);
273 log_debug("/proc/cpuinfo not found, assuming no UML virtualization.");
274 return VIRTUALIZATION_NONE
;
279 if (strstr(cpuinfo_contents
, "\nvendor_id\t: User Mode Linux\n")) {
280 log_debug("UML virtualization found in /proc/cpuinfo");
281 return VIRTUALIZATION_UML
;
284 log_debug("UML virtualization not found in /proc/cpuinfo.");
285 return VIRTUALIZATION_NONE
;
288 static int detect_vm_zvm(void) {
290 #if defined(__s390__)
291 _cleanup_free_
char *t
= NULL
;
294 r
= get_proc_field("/proc/sysinfo", "VM00 Control Program", WHITESPACE
, &t
);
296 return VIRTUALIZATION_NONE
;
300 log_debug("Virtualization %s found in /proc/sysinfo", t
);
301 if (streq(t
, "z/VM"))
302 return VIRTUALIZATION_ZVM
;
304 return VIRTUALIZATION_KVM
;
306 log_debug("This platform does not support /proc/sysinfo");
307 return VIRTUALIZATION_NONE
;
311 /* Returns a short identifier for the various VM implementations */
312 int detect_vm(void) {
313 static thread_local
int cached_found
= _VIRTUALIZATION_INVALID
;
317 if (cached_found
>= 0)
320 /* We have to use the correct order here:
322 * → First, try to detect Oracle Virtualbox, even if it uses KVM, as well as Xen even if it cloaks as Microsoft
325 * → Second, try to detect from CPUID, this will report KVM for whatever software is used even if info in DMI is
328 * → Third, try to detect from DMI. */
330 dmi
= detect_vm_dmi();
331 if (IN_SET(dmi
, VIRTUALIZATION_ORACLE
, VIRTUALIZATION_XEN
)) {
336 r
= detect_vm_cpuid();
339 if (r
== VIRTUALIZATION_VM_OTHER
)
341 else if (r
!= VIRTUALIZATION_NONE
)
344 /* Now, let's get back to DMI */
347 if (dmi
== VIRTUALIZATION_VM_OTHER
)
349 else if (dmi
!= VIRTUALIZATION_NONE
) {
354 /* x86 xen will most likely be detected by cpuid. If not (most likely
355 * because we're not an x86 guest), then we should try the /proc/xen
356 * directory next. If that's not found, then we check for the high-level
357 * hypervisor sysfs file.
363 if (r
== VIRTUALIZATION_VM_OTHER
)
365 else if (r
!= VIRTUALIZATION_NONE
)
368 r
= detect_vm_hypervisor();
371 if (r
== VIRTUALIZATION_VM_OTHER
)
373 else if (r
!= VIRTUALIZATION_NONE
)
376 r
= detect_vm_device_tree();
379 if (r
== VIRTUALIZATION_VM_OTHER
)
381 else if (r
!= VIRTUALIZATION_NONE
)
387 if (r
== VIRTUALIZATION_VM_OTHER
)
389 else if (r
!= VIRTUALIZATION_NONE
)
397 /* x86 xen Dom0 is detected as XEN in hypervisor and maybe others.
398 * In order to detect the Dom0 as not virtualization we need to
400 if (r
== VIRTUALIZATION_XEN
) {
403 dom0
= detect_vm_xen_dom0();
407 r
= VIRTUALIZATION_NONE
;
408 } else if (r
== VIRTUALIZATION_NONE
&& other
)
409 r
= VIRTUALIZATION_VM_OTHER
;
412 log_debug("Found VM virtualization %s", virtualization_to_string(r
));
416 int detect_container(void) {
418 static const struct {
422 { "lxc", VIRTUALIZATION_LXC
},
423 { "lxc-libvirt", VIRTUALIZATION_LXC_LIBVIRT
},
424 { "systemd-nspawn", VIRTUALIZATION_SYSTEMD_NSPAWN
},
425 { "docker", VIRTUALIZATION_DOCKER
},
426 { "rkt", VIRTUALIZATION_RKT
},
429 static thread_local
int cached_found
= _VIRTUALIZATION_INVALID
;
430 _cleanup_free_
char *m
= NULL
;
431 const char *e
= NULL
;
435 if (cached_found
>= 0)
438 /* /proc/vz exists in container and outside of the container, /proc/bc only outside of the container. */
439 if (access("/proc/vz", F_OK
) >= 0 &&
440 access("/proc/bc", F_OK
) < 0) {
441 r
= VIRTUALIZATION_OPENVZ
;
445 if (getpid_cached() == 1) {
446 /* If we are PID 1 we can just check our own environment variable, and that's authoritative. */
448 e
= getenv("container");
450 r
= VIRTUALIZATION_NONE
;
457 /* Otherwise, PID 1 might have dropped this information into a file in /run. This is better than accessing
458 * /proc/1/environ, since we don't need CAP_SYS_PTRACE for that. */
459 r
= read_one_line_file("/run/systemd/container", &m
);
465 return log_debug_errno(r
, "Failed to read /run/systemd/container: %m");
467 /* Fallback for cases where PID 1 was not systemd (for example, cases where init=/bin/sh is used. */
468 r
= getenv_for_pid(1, "container", &m
);
473 if (r
< 0) /* This only works if we have CAP_SYS_PTRACE, hence let's better ignore failures here */
474 log_debug_errno(r
, "Failed to read $container of PID 1, ignoring: %m");
476 /* Interestingly /proc/1/sched actually shows the host's PID for what we see as PID 1. Hence, if the PID shown
477 * there is not 1, we know we are in a PID namespace. and hence a container. */
478 r
= read_one_line_file("/proc/1/sched", &m
);
486 if (!startswith(t
, "(1,")) {
487 r
= VIRTUALIZATION_CONTAINER_OTHER
;
490 } else if (r
!= -ENOENT
)
493 /* If that didn't work, give up, assume no container manager. */
494 r
= VIRTUALIZATION_NONE
;
498 for (j
= 0; j
< ELEMENTSOF(value_table
); j
++)
499 if (streq(e
, value_table
[j
].value
)) {
500 r
= value_table
[j
].id
;
504 r
= VIRTUALIZATION_CONTAINER_OTHER
;
507 log_debug("Found container virtualization %s.", virtualization_to_string(r
));
512 int detect_virtualization(void) {
515 r
= detect_container();
522 static int userns_has_mapping(const char *name
) {
523 _cleanup_fclose_
FILE *f
= NULL
;
524 _cleanup_free_
char *buf
= NULL
;
525 size_t n_allocated
= 0;
530 f
= fopen(name
, "re");
532 log_debug_errno(errno
, "Failed to open %s: %m", name
);
533 return errno
== ENOENT
? false : -errno
;
536 n
= getline(&buf
, &n_allocated
, f
);
539 log_debug("%s is empty, we're in an uninitialized user namespace", name
);
543 return log_debug_errno(errno
, "Failed to read %s: %m", name
);
546 r
= sscanf(buf
, "%"PRIu32
" %"PRIu32
" %"PRIu32
, &a
, &b
, &c
);
548 return log_debug_errno(errno
, "Failed to parse %s: %m", name
);
550 if (a
== 0 && b
== 0 && c
== UINT32_MAX
) {
551 /* The kernel calls mappings_overlap() and does not allow overlaps */
552 log_debug("%s has a full 1:1 mapping", name
);
556 /* Anything else implies that we are in a user namespace */
557 log_debug("Mapping found in %s, we're in a user namespace", name
);
561 int running_in_userns(void) {
562 _cleanup_free_
char *line
= NULL
;
565 r
= userns_has_mapping("/proc/self/uid_map");
569 r
= userns_has_mapping("/proc/self/gid_map");
573 /* "setgroups" file was added in kernel v3.18-rc6-15-g9cc46516dd. It is also
574 * possible to compile a kernel without CONFIG_USER_NS, in which case "setgroups"
575 * also does not exist. We cannot distinguish those two cases, so assume that
576 * we're running on a stripped-down recent kernel, rather than on an old one,
577 * and if the file is not found, return false.
579 r
= read_one_line_file("/proc/self/setgroups", &line
);
581 log_debug_errno(r
, "/proc/self/setgroups: %m");
582 return r
== -ENOENT
? false : r
;
586 r
= streq(line
, "deny");
587 /* See user_namespaces(7) for a description of this "setgroups" contents. */
588 log_debug("/proc/self/setgroups contains \"%s\", %s user namespace", line
, r
? "in" : "not in");
592 int running_in_chroot(void) {
595 if (getenv_bool("SYSTEMD_IGNORE_CHROOT") > 0)
598 r
= files_same("/proc/1/root", "/", 0);
605 static const char *const virtualization_table
[_VIRTUALIZATION_MAX
] = {
606 [VIRTUALIZATION_NONE
] = "none",
607 [VIRTUALIZATION_KVM
] = "kvm",
608 [VIRTUALIZATION_QEMU
] = "qemu",
609 [VIRTUALIZATION_BOCHS
] = "bochs",
610 [VIRTUALIZATION_XEN
] = "xen",
611 [VIRTUALIZATION_UML
] = "uml",
612 [VIRTUALIZATION_VMWARE
] = "vmware",
613 [VIRTUALIZATION_ORACLE
] = "oracle",
614 [VIRTUALIZATION_MICROSOFT
] = "microsoft",
615 [VIRTUALIZATION_ZVM
] = "zvm",
616 [VIRTUALIZATION_PARALLELS
] = "parallels",
617 [VIRTUALIZATION_BHYVE
] = "bhyve",
618 [VIRTUALIZATION_QNX
] = "qnx",
619 [VIRTUALIZATION_VM_OTHER
] = "vm-other",
621 [VIRTUALIZATION_SYSTEMD_NSPAWN
] = "systemd-nspawn",
622 [VIRTUALIZATION_LXC_LIBVIRT
] = "lxc-libvirt",
623 [VIRTUALIZATION_LXC
] = "lxc",
624 [VIRTUALIZATION_OPENVZ
] = "openvz",
625 [VIRTUALIZATION_DOCKER
] = "docker",
626 [VIRTUALIZATION_RKT
] = "rkt",
627 [VIRTUALIZATION_CONTAINER_OTHER
] = "container-other",
630 DEFINE_STRING_TABLE_LOOKUP(virtualization
, int);