1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2011 Lennart Poettering
7 systemd is free software; you can redistribute it and/or modify it
8 under the terms of the GNU Lesser General Public License as published by
9 the Free Software Foundation; either version 2.1 of the License, or
10 (at your option) any later version.
12 systemd is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with systemd; If not, see <http://www.gnu.org/licenses/>.
21 #if defined(__i386__) || defined(__x86_64__)
30 #include "alloc-util.h"
31 #include "dirent-util.h"
36 #include "process-util.h"
37 #include "stat-util.h"
38 #include "string-table.h"
39 #include "string-util.h"
42 #if 0 /// UNNEEDED by elogind
43 static int detect_vm_cpuid(void) {
45 /* CPUID is an x86 specific interface. */
46 #if defined(__i386__) || defined(__x86_64__)
51 } cpuid_vendor_table[] = {
52 { "XenVMMXenVMM", VIRTUALIZATION_XEN },
53 { "KVMKVMKVM", VIRTUALIZATION_KVM },
54 { "TCGTCGTCGTCG", VIRTUALIZATION_QEMU },
55 /* http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1009458 */
56 { "VMwareVMware", VIRTUALIZATION_VMWARE },
57 /* https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/tlfs */
58 { "Microsoft Hv", VIRTUALIZATION_MICROSOFT },
59 /* https://wiki.freebsd.org/bhyve */
60 { "bhyve bhyve ", VIRTUALIZATION_BHYVE },
61 { "QNXQVMBSQG", VIRTUALIZATION_QNX },
64 uint32_t eax, ebx, ecx, edx;
67 /* http://lwn.net/Articles/301888/ */
69 /* First detect whether there is a hypervisor */
70 if (__get_cpuid(1, &eax, &ebx, &ecx, &edx) == 0)
71 return VIRTUALIZATION_NONE;
73 hypervisor = !!(ecx & 0x80000000U);
82 /* There is a hypervisor, see what it is */
83 __cpuid(0x40000000U, eax, ebx, ecx, edx);
89 log_debug("Virtualization found, CPUID=%s", sig.text);
91 for (j = 0; j < ELEMENTSOF(cpuid_vendor_table); j ++)
92 if (streq(sig.text, cpuid_vendor_table[j].cpuid))
93 return cpuid_vendor_table[j].id;
95 return VIRTUALIZATION_VM_OTHER;
98 log_debug("No virtualization found in CPUID");
100 return VIRTUALIZATION_NONE;
103 static int detect_vm_device_tree(void) {
104 #if defined(__arm__) || defined(__aarch64__) || defined(__powerpc__) || defined(__powerpc64__)
105 _cleanup_free_ char *hvtype = NULL;
108 r = read_one_line_file("/proc/device-tree/hypervisor/compatible", &hvtype);
110 _cleanup_closedir_ DIR *dir = NULL;
113 dir = opendir("/proc/device-tree");
115 if (errno == ENOENT) {
116 log_debug_errno(errno, "/proc/device-tree: %m");
117 return VIRTUALIZATION_NONE;
122 FOREACH_DIRENT(dent, dir, return -errno)
123 if (strstr(dent->d_name, "fw-cfg")) {
124 log_debug("Virtualization QEMU: \"fw-cfg\" present in /proc/device-tree/%s", dent->d_name);
125 return VIRTUALIZATION_QEMU;
128 log_debug("No virtualization found in /proc/device-tree/*");
129 return VIRTUALIZATION_NONE;
133 log_debug("Virtualization %s found in /proc/device-tree/hypervisor/compatible", hvtype);
134 if (streq(hvtype, "linux,kvm"))
135 return VIRTUALIZATION_KVM;
136 else if (strstr(hvtype, "xen"))
137 return VIRTUALIZATION_XEN;
139 return VIRTUALIZATION_VM_OTHER;
141 log_debug("This platform does not support /proc/device-tree");
142 return VIRTUALIZATION_NONE;
146 static int detect_vm_dmi(void) {
147 #if defined(__i386__) || defined(__x86_64__) || defined(__arm__) || defined(__aarch64__)
149 static const char *const dmi_vendors[] = {
150 "/sys/class/dmi/id/product_name", /* Test this before sys_vendor to detect KVM over QEMU */
151 "/sys/class/dmi/id/sys_vendor",
152 "/sys/class/dmi/id/board_vendor",
153 "/sys/class/dmi/id/bios_vendor"
156 static const struct {
159 } dmi_vendor_table[] = {
160 { "KVM", VIRTUALIZATION_KVM },
161 { "QEMU", VIRTUALIZATION_QEMU },
162 /* http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1009458 */
163 { "VMware", VIRTUALIZATION_VMWARE },
164 { "VMW", VIRTUALIZATION_VMWARE },
165 { "innotek GmbH", VIRTUALIZATION_ORACLE },
166 { "Xen", VIRTUALIZATION_XEN },
167 { "Bochs", VIRTUALIZATION_BOCHS },
168 { "Parallels", VIRTUALIZATION_PARALLELS },
169 /* https://wiki.freebsd.org/bhyve */
170 { "BHYVE", VIRTUALIZATION_BHYVE },
175 for (i = 0; i < ELEMENTSOF(dmi_vendors); i++) {
176 _cleanup_free_ char *s = NULL;
179 r = read_one_line_file(dmi_vendors[i], &s);
187 for (j = 0; j < ELEMENTSOF(dmi_vendor_table); j++)
188 if (startswith(s, dmi_vendor_table[j].vendor)) {
189 log_debug("Virtualization %s found in DMI (%s)", s, dmi_vendors[i]);
190 return dmi_vendor_table[j].id;
195 log_debug("No virtualization found in DMI");
197 return VIRTUALIZATION_NONE;
200 static int detect_vm_xen(void) {
202 /* Check for Dom0 will be executed later in detect_vm_xen_dom0
203 The presence of /proc/xen indicates some form of a Xen domain */
204 if (access("/proc/xen", F_OK) < 0) {
205 log_debug("Virtualization XEN not found, /proc/xen does not exist");
206 return VIRTUALIZATION_NONE;
209 log_debug("Virtualization XEN found (/proc/xen exists)");
210 return VIRTUALIZATION_XEN;
213 #define XENFEAT_dom0 11 /* xen/include/public/features.h */
214 #define PATH_FEATURES "/sys/hypervisor/properties/features"
215 /* Returns -errno, or 0 for domU, or 1 for dom0 */
216 static int detect_vm_xen_dom0(void) {
217 _cleanup_free_ char *domcap = NULL;
221 r = read_one_line_file(PATH_FEATURES, &domcap);
222 if (r < 0 && r != -ENOENT)
225 unsigned long features;
227 /* Here, we need to use sscanf() instead of safe_atoul()
228 * as the string lacks the leading "0x". */
229 r = sscanf(domcap, "%lx", &features);
231 r = !!(features & (1U << XENFEAT_dom0));
232 log_debug("Virtualization XEN, found %s with value %08lx, "
233 "XENFEAT_dom0 (indicating the 'hardware domain') is%s set.",
234 PATH_FEATURES, features, r ? "" : " not");
237 log_debug("Virtualization XEN, found %s, unhandled content '%s'",
238 PATH_FEATURES, domcap);
241 r = read_one_line_file("/proc/xen/capabilities", &domcap);
243 log_debug("Virtualization XEN because /proc/xen/capabilities does not exist");
250 while ((cap = strsep(&i, ",")))
251 if (streq(cap, "control_d"))
254 log_debug("Virtualization XEN DomU found (/proc/xen/capabilites)");
258 log_debug("Virtualization XEN Dom0 ignored (/proc/xen/capabilities)");
262 static int detect_vm_hypervisor(void) {
263 _cleanup_free_ char *hvtype = NULL;
266 r = read_one_line_file("/sys/hypervisor/type", &hvtype);
268 return VIRTUALIZATION_NONE;
272 log_debug("Virtualization %s found in /sys/hypervisor/type", hvtype);
274 if (streq(hvtype, "xen"))
275 return VIRTUALIZATION_XEN;
277 return VIRTUALIZATION_VM_OTHER;
280 static int detect_vm_uml(void) {
281 _cleanup_free_ char *cpuinfo_contents = NULL;
284 /* Detect User-Mode Linux by reading /proc/cpuinfo */
285 r = read_full_file("/proc/cpuinfo", &cpuinfo_contents, NULL);
289 if (strstr(cpuinfo_contents, "\nvendor_id\t: User Mode Linux\n")) {
290 log_debug("UML virtualization found in /proc/cpuinfo");
291 return VIRTUALIZATION_UML;
294 log_debug("No virtualization found in /proc/cpuinfo.");
295 return VIRTUALIZATION_NONE;
298 static int detect_vm_zvm(void) {
300 #if defined(__s390__)
301 _cleanup_free_ char *t = NULL;
304 r = get_proc_field("/proc/sysinfo", "VM00 Control Program", WHITESPACE, &t);
306 return VIRTUALIZATION_NONE;
310 log_debug("Virtualization %s found in /proc/sysinfo", t);
311 if (streq(t, "z/VM"))
312 return VIRTUALIZATION_ZVM;
314 return VIRTUALIZATION_KVM;
316 log_debug("This platform does not support /proc/sysinfo");
317 return VIRTUALIZATION_NONE;
321 /* Returns a short identifier for the various VM implementations */
322 int detect_vm(void) {
323 static thread_local int cached_found = _VIRTUALIZATION_INVALID;
327 if (cached_found >= 0)
330 /* We have to use the correct order here:
332 * -> First try to detect Oracle Virtualbox, even if it uses KVM.
333 * -> Second try to detect from cpuid, this will report KVM for
334 * whatever software is used even if info in dmi is overwritten.
335 * -> Third try to detect from dmi. */
337 dmi = detect_vm_dmi();
338 if (dmi == VIRTUALIZATION_ORACLE) {
343 r = detect_vm_cpuid();
346 if (r != VIRTUALIZATION_NONE) {
347 if (r == VIRTUALIZATION_VM_OTHER)
356 if (r != VIRTUALIZATION_NONE) {
357 if (r == VIRTUALIZATION_VM_OTHER)
363 /* x86 xen will most likely be detected by cpuid. If not (most likely
364 * because we're not an x86 guest), then we should try the /proc/xen
365 * directory next. If that's not found, then we check for the high-level
366 * hypervisor sysfs file.
372 if (r != VIRTUALIZATION_NONE) {
373 if (r == VIRTUALIZATION_VM_OTHER)
379 r = detect_vm_hypervisor();
382 if (r != VIRTUALIZATION_NONE) {
383 if (r == VIRTUALIZATION_VM_OTHER)
389 r = detect_vm_device_tree();
392 if (r != VIRTUALIZATION_NONE) {
393 if (r == VIRTUALIZATION_VM_OTHER)
402 if (r != VIRTUALIZATION_NONE) {
403 if (r == VIRTUALIZATION_VM_OTHER)
414 /* x86 xen Dom0 is detected as XEN in hypervisor and maybe others.
415 * In order to detect the Dom0 as not virtualization we need to
417 if (r == VIRTUALIZATION_XEN) {
418 int ret = detect_vm_xen_dom0();
422 r = VIRTUALIZATION_NONE;
423 } else if (r == VIRTUALIZATION_NONE && other)
424 r = VIRTUALIZATION_VM_OTHER;
427 log_debug("Found VM virtualization %s", virtualization_to_string(r));
432 int detect_container(void) {
434 static const struct {
438 { "lxc", VIRTUALIZATION_LXC },
439 { "lxc-libvirt", VIRTUALIZATION_LXC_LIBVIRT },
440 { "systemd-nspawn", VIRTUALIZATION_SYSTEMD_NSPAWN },
441 { "docker", VIRTUALIZATION_DOCKER },
442 { "rkt", VIRTUALIZATION_RKT },
445 static thread_local int cached_found = _VIRTUALIZATION_INVALID;
446 _cleanup_free_ char *m = NULL;
447 const char *e = NULL;
451 if (cached_found >= 0)
454 /* /proc/vz exists in container and outside of the container, /proc/bc only outside of the container. */
455 if (access("/proc/vz", F_OK) >= 0 &&
456 access("/proc/bc", F_OK) < 0) {
457 r = VIRTUALIZATION_OPENVZ;
461 if (getpid_cached() == 1) {
462 /* If we are PID 1 we can just check our own environment variable, and that's authoritative. */
464 e = getenv("container");
466 r = VIRTUALIZATION_NONE;
473 /* Otherwise, PID 1 might have dropped this information into a file in /run. This is better than accessing
474 * /proc/1/environ, since we don't need CAP_SYS_PTRACE for that. */
475 r = read_one_line_file("/run/systemd/container", &m);
481 return log_debug_errno(r, "Failed to read /run/systemd/container: %m");
483 /* Fallback for cases where PID 1 was not systemd (for example, cases where init=/bin/sh is used. */
484 r = getenv_for_pid(1, "container", &m);
489 if (r < 0) /* This only works if we have CAP_SYS_PTRACE, hence let's better ignore failures here */
490 log_debug_errno(r, "Failed to read $container of PID 1, ignoring: %m");
492 /* Interestingly /proc/1/sched actually shows the host's PID for what we see as PID 1. Hence, if the PID shown
493 * there is not 1, we know we are in a PID namespace. and hence a container. */
494 r = read_one_line_file("/proc/1/sched", &m);
502 if (!startswith(t, "(1,")) {
503 r = VIRTUALIZATION_CONTAINER_OTHER;
506 } else if (r != -ENOENT)
509 /* If that didn't work, give up, assume no container manager. */
510 r = VIRTUALIZATION_NONE;
514 for (j = 0; j < ELEMENTSOF(value_table); j++)
515 if (streq(e, value_table[j].value)) {
516 r = value_table[j].id;
520 r = VIRTUALIZATION_CONTAINER_OTHER;
523 log_debug("Found container virtualization %s.", virtualization_to_string(r));
528 #if 0 /// UNNEEDED by elogind
529 int detect_virtualization(void) {
532 r = detect_container();
539 static int userns_has_mapping(const char *name) {
540 _cleanup_fclose_ FILE *f = NULL;
541 _cleanup_free_ char *buf = NULL;
542 size_t n_allocated = 0;
547 f = fopen(name, "re");
549 log_debug_errno(errno, "Failed to open %s: %m", name);
550 return errno == ENOENT ? false : -errno;
553 n = getline(&buf, &n_allocated, f);
556 log_debug("%s is empty, we're in an uninitialized user namespace", name);
560 return log_debug_errno(errno, "Failed to read %s: %m", name);
563 r = sscanf(buf, "%"PRIu32" %"PRIu32" %"PRIu32, &a, &b, &c);
565 return log_debug_errno(errno, "Failed to parse %s: %m", name);
567 if (a == 0 && b == 0 && c == UINT32_MAX) {
568 /* The kernel calls mappings_overlap() and does not allow overlaps */
569 log_debug("%s has a full 1:1 mapping", name);
573 /* Anything else implies that we are in a user namespace */
574 log_debug("Mapping found in %s, we're in a user namespace", name);
578 int running_in_userns(void) {
579 _cleanup_free_ char *line = NULL;
582 r = userns_has_mapping("/proc/self/uid_map");
586 r = userns_has_mapping("/proc/self/gid_map");
590 /* "setgroups" file was added in kernel v3.18-rc6-15-g9cc46516dd. It is also
591 * possible to compile a kernel without CONFIG_USER_NS, in which case "setgroups"
592 * also does not exist. We cannot distinguish those two cases, so assume that
593 * we're running on a stripped-down recent kernel, rather than on an old one,
594 * and if the file is not found, return false.
596 r = read_one_line_file("/proc/self/setgroups", &line);
598 log_debug_errno(r, "/proc/self/setgroups: %m");
599 return r == -ENOENT ? false : r;
603 r = streq(line, "deny");
604 /* See user_namespaces(7) for a description of this "setgroups" contents. */
605 log_debug("/proc/self/setgroups contains \"%s\", %s user namespace", line, r ? "in" : "not in");
610 int running_in_chroot(void) {
613 #if 0 /// elogind does not allow to ignore chroots, we are never init!
614 if (getenv_bool("SYSTEMD_IGNORE_CHROOT") > 0)
618 ret = files_same("/proc/1/root", "/", 0);
625 static const char *const virtualization_table[_VIRTUALIZATION_MAX] = {
626 [VIRTUALIZATION_NONE] = "none",
627 [VIRTUALIZATION_KVM] = "kvm",
628 [VIRTUALIZATION_QEMU] = "qemu",
629 [VIRTUALIZATION_BOCHS] = "bochs",
630 [VIRTUALIZATION_XEN] = "xen",
631 [VIRTUALIZATION_UML] = "uml",
632 [VIRTUALIZATION_VMWARE] = "vmware",
633 [VIRTUALIZATION_ORACLE] = "oracle",
634 [VIRTUALIZATION_MICROSOFT] = "microsoft",
635 [VIRTUALIZATION_ZVM] = "zvm",
636 [VIRTUALIZATION_PARALLELS] = "parallels",
637 [VIRTUALIZATION_BHYVE] = "bhyve",
638 [VIRTUALIZATION_QNX] = "qnx",
639 [VIRTUALIZATION_VM_OTHER] = "vm-other",
641 [VIRTUALIZATION_SYSTEMD_NSPAWN] = "systemd-nspawn",
642 [VIRTUALIZATION_LXC_LIBVIRT] = "lxc-libvirt",
643 [VIRTUALIZATION_LXC] = "lxc",
644 [VIRTUALIZATION_OPENVZ] = "openvz",
645 [VIRTUALIZATION_DOCKER] = "docker",
646 [VIRTUALIZATION_RKT] = "rkt",
647 [VIRTUALIZATION_CONTAINER_OTHER] = "container-other",
650 DEFINE_STRING_TABLE_LOOKUP(virtualization, int);