1//===--- Distro.cpp - Linux distribution detection support ------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "clang/Driver/Distro.h"
10#include "clang/Basic/LLVM.h"
11#include "llvm/ADT/StringRef.h"
12#include "llvm/ADT/StringSwitch.h"
13#include "llvm/Support/ErrorOr.h"
14#include "llvm/Support/MemoryBuffer.h"
15#include "llvm/Support/Threading.h"
16#include "llvm/TargetParser/Host.h"
17#include "llvm/TargetParser/Triple.h"
18
19using namespace clang::driver;
20using namespace clang;
21
22static Distro::DistroType DetectOsRelease(llvm::vfs::FileSystem &VFS) {
23 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> File =
24 VFS.getBufferForFile(Name: "/etc/os-release");
25 if (!File)
26 File = VFS.getBufferForFile(Name: "/usr/lib/os-release");
27 if (!File)
28 return Distro::UnknownDistro;
29
30 SmallVector<StringRef, 16> Lines;
31 File.get()->getBuffer().split(A&: Lines, Separator: "\n");
32 Distro::DistroType Version = Distro::UnknownDistro;
33
34 // Obviously this can be improved a lot.
35 for (StringRef Line : Lines)
36 if (Version == Distro::UnknownDistro && Line.starts_with(Prefix: "ID="))
37 Version = llvm::StringSwitch<Distro::DistroType>(Line.substr(Start: 3))
38 .Case(S: "alpine", Value: Distro::AlpineLinux)
39 .Case(S: "fedora", Value: Distro::Fedora)
40 .Case(S: "gentoo", Value: Distro::Gentoo)
41 .Case(S: "arch", Value: Distro::ArchLinux)
42 // On SLES, /etc/os-release was introduced in SLES 11.
43 .Case(S: "sles", Value: Distro::OpenSUSE)
44 .Case(S: "opensuse", Value: Distro::OpenSUSE)
45 .Case(S: "exherbo", Value: Distro::Exherbo)
46 .Default(Value: Distro::UnknownDistro);
47 return Version;
48}
49
50static Distro::DistroType DetectLsbRelease(llvm::vfs::FileSystem &VFS) {
51 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> File =
52 VFS.getBufferForFile(Name: "/etc/lsb-release");
53 if (!File)
54 return Distro::UnknownDistro;
55
56 SmallVector<StringRef, 16> Lines;
57 File.get()->getBuffer().split(A&: Lines, Separator: "\n");
58 Distro::DistroType Version = Distro::UnknownDistro;
59
60 for (StringRef Line : Lines)
61 if (Version == Distro::UnknownDistro &&
62 Line.starts_with(Prefix: "DISTRIB_CODENAME="))
63 Version = llvm::StringSwitch<Distro::DistroType>(Line.substr(Start: 17))
64 .Case(S: "quantal", Value: Distro::UbuntuQuantal)
65 .Case(S: "raring", Value: Distro::UbuntuRaring)
66 .Case(S: "saucy", Value: Distro::UbuntuSaucy)
67 .Case(S: "trusty", Value: Distro::UbuntuTrusty)
68 .Case(S: "utopic", Value: Distro::UbuntuUtopic)
69 .Case(S: "vivid", Value: Distro::UbuntuVivid)
70 .Case(S: "wily", Value: Distro::UbuntuWily)
71 .Case(S: "xenial", Value: Distro::UbuntuXenial)
72 .Case(S: "yakkety", Value: Distro::UbuntuYakkety)
73 .Case(S: "zesty", Value: Distro::UbuntuZesty)
74 .Case(S: "artful", Value: Distro::UbuntuArtful)
75 .Case(S: "bionic", Value: Distro::UbuntuBionic)
76 .Case(S: "cosmic", Value: Distro::UbuntuCosmic)
77 .Case(S: "disco", Value: Distro::UbuntuDisco)
78 .Case(S: "eoan", Value: Distro::UbuntuEoan)
79 .Case(S: "focal", Value: Distro::UbuntuFocal)
80 .Case(S: "groovy", Value: Distro::UbuntuGroovy)
81 .Case(S: "hirsute", Value: Distro::UbuntuHirsute)
82 .Case(S: "impish", Value: Distro::UbuntuImpish)
83 .Case(S: "jammy", Value: Distro::UbuntuJammy)
84 .Case(S: "kinetic", Value: Distro::UbuntuKinetic)
85 .Case(S: "lunar", Value: Distro::UbuntuLunar)
86 .Case(S: "mantic", Value: Distro::UbuntuMantic)
87 .Case(S: "noble", Value: Distro::UbuntuNoble)
88 .Case(S: "oracular", Value: Distro::UbuntuOracular)
89 .Case(S: "plucky", Value: Distro::UbuntuPlucky)
90 .Case(S: "questing", Value: Distro::UbuntuQuesting)
91 .Case(S: "resolute", Value: Distro::UbuntuResolute)
92 .Case(S: "stonking", Value: Distro::UbuntuStonking)
93 .Case(S: "tenacious", Value: Distro::UbuntuTenacious)
94 .Default(Value: Distro::UnknownDistro);
95 return Version;
96}
97
98static Distro::DistroType DetectDistro(llvm::vfs::FileSystem &VFS) {
99 Distro::DistroType Version = Distro::UnknownDistro;
100
101 // Newer freedesktop.org's compilant systemd-based systems
102 // should provide /etc/os-release or /usr/lib/os-release.
103 Version = DetectOsRelease(VFS);
104 if (Version != Distro::UnknownDistro)
105 return Version;
106
107 // Older systems might provide /etc/lsb-release.
108 Version = DetectLsbRelease(VFS);
109 if (Version != Distro::UnknownDistro)
110 return Version;
111
112 // Otherwise try some distro-specific quirks for Red Hat...
113 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> File =
114 VFS.getBufferForFile(Name: "/etc/redhat-release");
115
116 if (File) {
117 StringRef Data = File.get()->getBuffer();
118 if (Data.starts_with(Prefix: "Fedora release"))
119 return Distro::Fedora;
120 if (Data.starts_with(Prefix: "Red Hat Enterprise Linux") ||
121 Data.starts_with(Prefix: "CentOS") || Data.starts_with(Prefix: "AlmaLinux") ||
122 Data.starts_with(Prefix: "Rocky Linux") ||
123 Data.starts_with(Prefix: "Scientific Linux")) {
124 if (Data.contains(Other: "release 10"))
125 return Distro::RHEL10;
126 if (Data.contains(Other: "release 9"))
127 return Distro::RHEL9;
128 if (Data.contains(Other: "release 8"))
129 return Distro::RHEL8;
130 if (Data.contains(Other: "release 7"))
131 return Distro::RHEL7;
132 }
133 return Distro::UnknownDistro;
134 }
135
136 // ...for Debian
137 File = VFS.getBufferForFile(Name: "/etc/debian_version");
138 if (File) {
139 StringRef Data = File.get()->getBuffer();
140 // Contents: < major.minor > or < codename/sid >
141 int MajorVersion;
142 if (!Data.split(Separator: '.').first.getAsInteger(Radix: 10, Result&: MajorVersion)) {
143 switch (MajorVersion) {
144 case 8:
145 return Distro::DebianJessie;
146 case 9:
147 return Distro::DebianStretch;
148 case 10:
149 return Distro::DebianBuster;
150 case 11:
151 return Distro::DebianBullseye;
152 case 12:
153 return Distro::DebianBookworm;
154 case 13:
155 return Distro::DebianTrixie;
156 case 14:
157 return Distro::DebianForky;
158 case 15:
159 return Distro::DebianDuke;
160 default:
161 return Distro::UnknownDistro;
162 }
163 }
164 return llvm::StringSwitch<Distro::DistroType>(Data.split(Separator: "\n").first)
165 .Case(S: "jessie/sid", Value: Distro::DebianJessie)
166 .Case(S: "stretch/sid", Value: Distro::DebianStretch)
167 .Case(S: "buster/sid", Value: Distro::DebianBuster)
168 .Case(S: "bullseye/sid", Value: Distro::DebianBullseye)
169 .Case(S: "bookworm/sid", Value: Distro::DebianBookworm)
170 .Case(S: "trixie/sid", Value: Distro::DebianTrixie)
171 .Case(S: "forky/sid", Value: Distro::DebianForky)
172 .Case(S: "duke/sid", Value: Distro::DebianDuke)
173 .Default(Value: Distro::UnknownDistro);
174 }
175
176 // ...for SUSE
177 File = VFS.getBufferForFile(Name: "/etc/SuSE-release");
178 if (File) {
179 StringRef Data = File.get()->getBuffer();
180 SmallVector<StringRef, 8> Lines;
181 Data.split(A&: Lines, Separator: "\n");
182 for (const StringRef &Line : Lines) {
183 if (!Line.trim().starts_with(Prefix: "VERSION"))
184 continue;
185 std::pair<StringRef, StringRef> SplitLine = Line.split(Separator: '=');
186 // Old versions have split VERSION and PATCHLEVEL
187 // Newer versions use VERSION = x.y
188 std::pair<StringRef, StringRef> SplitVer =
189 SplitLine.second.trim().split(Separator: '.');
190 int Version;
191
192 // OpenSUSE/SLES 10 and older are not supported and not compatible
193 // with our rules, so just treat them as Distro::UnknownDistro.
194 if (!SplitVer.first.getAsInteger(Radix: 10, Result&: Version) && Version > 10)
195 return Distro::OpenSUSE;
196 return Distro::UnknownDistro;
197 }
198 return Distro::UnknownDistro;
199 }
200
201 // ...and others.
202 if (VFS.exists(Path: "/etc/gentoo-release"))
203 return Distro::Gentoo;
204
205 return Distro::UnknownDistro;
206}
207
208static Distro::DistroType GetDistro(llvm::vfs::FileSystem &VFS,
209 const llvm::Triple &TargetOrHost) {
210 // If we don't target Linux, no need to check the distro. This saves a few
211 // OS calls.
212 if (!TargetOrHost.isOSLinux())
213 return Distro::UnknownDistro;
214
215 // True if we're backed by a real file system.
216 const bool onRealFS = (llvm::vfs::getRealFileSystem() == &VFS);
217
218 // If the host is not running Linux, and we're backed by a real file
219 // system, no need to check the distro. This is the case where someone
220 // is cross-compiling from BSD or Windows to Linux, and it would be
221 // meaningless to try to figure out the "distro" of the non-Linux host.
222 llvm::Triple HostTriple(llvm::sys::getProcessTriple());
223 if (!HostTriple.isOSLinux() && onRealFS)
224 return Distro::UnknownDistro;
225
226 if (onRealFS) {
227 // If we're backed by a real file system, perform
228 // the detection only once and save the result.
229 static const Distro::DistroType LinuxDistro = DetectDistro(VFS);
230 return LinuxDistro;
231 }
232 // This is mostly for passing tests which uses llvm::vfs::InMemoryFileSystem,
233 // which is not "real".
234 return DetectDistro(VFS);
235}
236
237Distro::Distro(llvm::vfs::FileSystem &VFS, const llvm::Triple &TargetOrHost)
238 : DistroVal(GetDistro(VFS, TargetOrHost)) {}
239