1 //===--- Types.cpp - Driver input & temporary type information ------------===//
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/Types.h"
10 #include "clang/Driver/Driver.h"
11 #include "clang/Driver/DriverDiagnostic.h"
12 #include "clang/Driver/Options.h"
13 #include "llvm/ADT/STLExtras.h"
14 #include "llvm/ADT/SmallVector.h"
15 #include "llvm/ADT/StringSwitch.h"
16 #include "llvm/Option/Arg.h"
17 #include <cassert>
18 #include <cstring>
19 
20 using namespace clang::driver;
21 using namespace clang::driver::types;
22 
23 struct TypeInfo {
24   const char *Name;
25   const char *TempSuffix;
26   ID PreprocessedType;
27   class PhasesBitSet {
28     unsigned Bits = 0;
29 
30   public:
31     constexpr PhasesBitSet(std::initializer_list<phases::ID> Phases) {
32       for (auto Id : Phases)
33         Bits |= 1 << Id;
34     }
35     bool contains(phases::ID Id) const { return Bits & (1 << Id); }
36   } Phases;
37 };
38 
39 static constexpr TypeInfo TypeInfos[] = {
40 #define TYPE(NAME, ID, PP_TYPE, TEMP_SUFFIX, ...) \
41   { NAME, TEMP_SUFFIX, TY_##PP_TYPE, { __VA_ARGS__ }, },
42 #include "clang/Driver/Types.def"
43 #undef TYPE
44 };
45 static const unsigned numTypes = llvm::array_lengthof(TypeInfos);
46 
47 static const TypeInfo &getInfo(unsigned id) {
48   assert(id > 0 && id - 1 < numTypes && "Invalid Type ID.");
49   return TypeInfos[id - 1];
50 }
51 
52 const char *types::getTypeName(ID Id) {
53   return getInfo(Id).Name;
54 }
55 
56 types::ID types::getPreprocessedType(ID Id) {
57   ID PPT = getInfo(Id).PreprocessedType;
58   assert((getInfo(Id).Phases.contains(phases::Preprocess) !=
59           (PPT == TY_INVALID)) &&
60          "Unexpected Preprocess Type.");
61   return PPT;
62 }
63 
64 static bool isPreprocessedModuleType(ID Id) {
65   return Id == TY_CXXModule || Id == TY_PP_CXXModule;
66 }
67 
68 types::ID types::getPrecompiledType(ID Id) {
69   if (isPreprocessedModuleType(Id))
70     return TY_ModuleFile;
71   if (onlyPrecompileType(Id))
72     return TY_PCH;
73   return TY_INVALID;
74 }
75 
76 const char *types::getTypeTempSuffix(ID Id, bool CLMode) {
77   if (CLMode) {
78     switch (Id) {
79     case TY_Object:
80     case TY_LTO_BC:
81       return "obj";
82     case TY_Image:
83       return "exe";
84     case TY_PP_Asm:
85       return "asm";
86     default:
87       break;
88     }
89   }
90   return getInfo(Id).TempSuffix;
91 }
92 
93 bool types::onlyPrecompileType(ID Id) {
94   return getInfo(Id).Phases.contains(phases::Precompile) &&
95          !isPreprocessedModuleType(Id);
96 }
97 
98 bool types::canTypeBeUserSpecified(ID Id) {
99   static const clang::driver::types::ID kStaticLangageTypes[] = {
100       TY_CUDA_DEVICE,   TY_HIP_DEVICE,    TY_PP_CHeader,
101       TY_PP_ObjCHeader, TY_PP_CXXHeader,  TY_PP_ObjCXXHeader,
102       TY_PP_CXXModule,  TY_LTO_IR,        TY_LTO_BC,
103       TY_Plist,         TY_RewrittenObjC, TY_RewrittenLegacyObjC,
104       TY_Remap,         TY_PCH,           TY_Object,
105       TY_Image,         TY_dSYM,          TY_Dependencies,
106       TY_CUDA_FATBIN,   TY_HIP_FATBIN};
107   return !llvm::is_contained(kStaticLangageTypes, Id);
108 }
109 
110 bool types::appendSuffixForType(ID Id) {
111   return Id == TY_PCH || Id == TY_dSYM || Id == TY_CUDA_FATBIN ||
112          Id == TY_HIP_FATBIN;
113 }
114 
115 bool types::canLipoType(ID Id) {
116   return (Id == TY_Nothing ||
117           Id == TY_Image ||
118           Id == TY_Object ||
119           Id == TY_LTO_BC);
120 }
121 
122 bool types::isAcceptedByClang(ID Id) {
123   switch (Id) {
124   default:
125     return false;
126 
127   case TY_Asm:
128   case TY_C: case TY_PP_C:
129   case TY_CL: case TY_CLCXX:
130   case TY_CUDA: case TY_PP_CUDA:
131   case TY_CUDA_DEVICE:
132   case TY_HIP:
133   case TY_PP_HIP:
134   case TY_HIP_DEVICE:
135   case TY_ObjC: case TY_PP_ObjC: case TY_PP_ObjC_Alias:
136   case TY_CXX: case TY_PP_CXX:
137   case TY_ObjCXX: case TY_PP_ObjCXX: case TY_PP_ObjCXX_Alias:
138   case TY_CHeader: case TY_PP_CHeader:
139   case TY_CLHeader:
140   case TY_ObjCHeader: case TY_PP_ObjCHeader:
141   case TY_CXXHeader: case TY_PP_CXXHeader:
142   case TY_ObjCXXHeader: case TY_PP_ObjCXXHeader:
143   case TY_CXXModule: case TY_PP_CXXModule:
144   case TY_AST: case TY_ModuleFile: case TY_PCH:
145   case TY_LLVM_IR: case TY_LLVM_BC:
146   case TY_API_INFO:
147     return true;
148   }
149 }
150 
151 bool types::isDerivedFromC(ID Id) {
152   switch (Id) {
153   default:
154     return false;
155 
156   case TY_PP_C:
157   case TY_C:
158   case TY_CL:
159   case TY_CLCXX:
160   case TY_PP_CUDA:
161   case TY_CUDA:
162   case TY_CUDA_DEVICE:
163   case TY_PP_HIP:
164   case TY_HIP:
165   case TY_HIP_DEVICE:
166   case TY_PP_ObjC:
167   case TY_PP_ObjC_Alias:
168   case TY_ObjC:
169   case TY_PP_CXX:
170   case TY_CXX:
171   case TY_PP_ObjCXX:
172   case TY_PP_ObjCXX_Alias:
173   case TY_ObjCXX:
174   case TY_RenderScript:
175   case TY_PP_CHeader:
176   case TY_CHeader:
177   case TY_CLHeader:
178   case TY_PP_ObjCHeader:
179   case TY_ObjCHeader:
180   case TY_PP_CXXHeader:
181   case TY_CXXHeader:
182   case TY_PP_ObjCXXHeader:
183   case TY_ObjCXXHeader:
184   case TY_CXXModule:
185   case TY_PP_CXXModule:
186     return true;
187   }
188 }
189 
190 bool types::isObjC(ID Id) {
191   switch (Id) {
192   default:
193     return false;
194 
195   case TY_ObjC: case TY_PP_ObjC: case TY_PP_ObjC_Alias:
196   case TY_ObjCXX: case TY_PP_ObjCXX:
197   case TY_ObjCHeader: case TY_PP_ObjCHeader:
198   case TY_ObjCXXHeader: case TY_PP_ObjCXXHeader: case TY_PP_ObjCXX_Alias:
199     return true;
200   }
201 }
202 
203 bool types::isOpenCL(ID Id) { return Id == TY_CL || Id == TY_CLCXX; }
204 
205 bool types::isCXX(ID Id) {
206   switch (Id) {
207   default:
208     return false;
209 
210   case TY_CXX: case TY_PP_CXX:
211   case TY_ObjCXX: case TY_PP_ObjCXX: case TY_PP_ObjCXX_Alias:
212   case TY_CXXHeader: case TY_PP_CXXHeader:
213   case TY_ObjCXXHeader: case TY_PP_ObjCXXHeader:
214   case TY_CXXModule: case TY_PP_CXXModule:
215   case TY_CUDA: case TY_PP_CUDA: case TY_CUDA_DEVICE:
216   case TY_HIP:
217   case TY_PP_HIP:
218   case TY_HIP_DEVICE:
219     return true;
220   }
221 }
222 
223 bool types::isLLVMIR(ID Id) {
224   switch (Id) {
225   default:
226     return false;
227 
228   case TY_LLVM_IR:
229   case TY_LLVM_BC:
230   case TY_LTO_IR:
231   case TY_LTO_BC:
232     return true;
233   }
234 }
235 
236 bool types::isCuda(ID Id) {
237   switch (Id) {
238   default:
239     return false;
240 
241   case TY_CUDA:
242   case TY_PP_CUDA:
243   case TY_CUDA_DEVICE:
244     return true;
245   }
246 }
247 
248 bool types::isHIP(ID Id) {
249   switch (Id) {
250   default:
251     return false;
252 
253   case TY_HIP:
254   case TY_PP_HIP:
255   case TY_HIP_DEVICE:
256     return true;
257   }
258 }
259 
260 bool types::isFortran(ID Id) {
261   switch (Id) {
262   default:
263     return false;
264 
265   case TY_Fortran: case TY_PP_Fortran:
266     return true;
267   }
268 }
269 
270 bool types::isSrcFile(ID Id) {
271   return Id != TY_Object && getPreprocessedType(Id) != TY_INVALID;
272 }
273 
274 types::ID types::lookupTypeForExtension(llvm::StringRef Ext) {
275   return llvm::StringSwitch<types::ID>(Ext)
276            .Case("c", TY_C)
277            .Case("C", TY_CXX)
278            .Case("F", TY_Fortran)
279            .Case("f", TY_PP_Fortran)
280            .Case("h", TY_CHeader)
281            .Case("H", TY_CXXHeader)
282            .Case("i", TY_PP_C)
283            .Case("m", TY_ObjC)
284            .Case("M", TY_ObjCXX)
285            .Case("o", TY_Object)
286            .Case("S", TY_Asm)
287            .Case("s", TY_PP_Asm)
288            .Case("bc", TY_LLVM_BC)
289            .Case("cc", TY_CXX)
290            .Case("CC", TY_CXX)
291            .Case("cl", TY_CL)
292            .Case("clcpp", TY_CLCXX)
293            .Case("cp", TY_CXX)
294            .Case("cu", TY_CUDA)
295            .Case("hh", TY_CXXHeader)
296            .Case("ii", TY_PP_CXX)
297            .Case("ll", TY_LLVM_IR)
298            .Case("mi", TY_PP_ObjC)
299            .Case("mm", TY_ObjCXX)
300            .Case("rs", TY_RenderScript)
301            .Case("adb", TY_Ada)
302            .Case("ads", TY_Ada)
303            .Case("asm", TY_PP_Asm)
304            .Case("ast", TY_AST)
305            .Case("ccm", TY_CXXModule)
306            .Case("cpp", TY_CXX)
307            .Case("CPP", TY_CXX)
308            .Case("c++", TY_CXX)
309            .Case("C++", TY_CXX)
310            .Case("cui", TY_PP_CUDA)
311            .Case("cxx", TY_CXX)
312            .Case("CXX", TY_CXX)
313            .Case("F90", TY_Fortran)
314            .Case("f90", TY_PP_Fortran)
315            .Case("F95", TY_Fortran)
316            .Case("f95", TY_PP_Fortran)
317            .Case("for", TY_PP_Fortran)
318            .Case("FOR", TY_PP_Fortran)
319            .Case("fpp", TY_Fortran)
320            .Case("FPP", TY_Fortran)
321            .Case("gch", TY_PCH)
322            .Case("hip", TY_HIP)
323            .Case("hpp", TY_CXXHeader)
324            .Case("hxx", TY_CXXHeader)
325            .Case("iim", TY_PP_CXXModule)
326            .Case("lib", TY_Object)
327            .Case("mii", TY_PP_ObjCXX)
328            .Case("obj", TY_Object)
329            .Case("ifs", TY_IFS)
330            .Case("pch", TY_PCH)
331            .Case("pcm", TY_ModuleFile)
332            .Case("c++m", TY_CXXModule)
333            .Case("cppm", TY_CXXModule)
334            .Case("cxxm", TY_CXXModule)
335            .Case("hlsl", TY_HLSL)
336            .Default(TY_INVALID);
337 }
338 
339 types::ID types::lookupTypeForTypeSpecifier(const char *Name) {
340   for (unsigned i=0; i<numTypes; ++i) {
341     types::ID Id = (types::ID) (i + 1);
342     if (canTypeBeUserSpecified(Id) &&
343         strcmp(Name, getInfo(Id).Name) == 0)
344       return Id;
345   }
346   // Accept "cu" as an alias for "cuda" for NVCC compatibility
347   if (strcmp(Name, "cu") == 0) {
348     return types::TY_CUDA;
349   }
350   return TY_INVALID;
351 }
352 
353 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases>
354 types::getCompilationPhases(ID Id, phases::ID LastPhase) {
355   llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> P;
356   const auto &Info = getInfo(Id);
357   for (int I = 0; I <= LastPhase; ++I)
358     if (Info.Phases.contains(static_cast<phases::ID>(I)))
359       P.push_back(static_cast<phases::ID>(I));
360   assert(P.size() <= phases::MaxNumberOfPhases && "Too many phases in list");
361   return P;
362 }
363 
364 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases>
365 types::getCompilationPhases(const clang::driver::Driver &Driver,
366                             llvm::opt::DerivedArgList &DAL, ID Id) {
367   return types::getCompilationPhases(Id, Driver.getFinalPhase(DAL));
368 }
369 
370 ID types::lookupCXXTypeForCType(ID Id) {
371   switch (Id) {
372   default:
373     return Id;
374 
375   case types::TY_C:
376     return types::TY_CXX;
377   case types::TY_PP_C:
378     return types::TY_PP_CXX;
379   case types::TY_CHeader:
380     return types::TY_CXXHeader;
381   case types::TY_PP_CHeader:
382     return types::TY_PP_CXXHeader;
383   }
384 }
385 
386 ID types::lookupHeaderTypeForSourceType(ID Id) {
387   switch (Id) {
388   default:
389     return Id;
390 
391   // FIXME: Handle preprocessed input types.
392   case types::TY_C:
393     return types::TY_CHeader;
394   case types::TY_CXX:
395   case types::TY_CXXModule:
396     return types::TY_CXXHeader;
397   case types::TY_ObjC:
398     return types::TY_ObjCHeader;
399   case types::TY_ObjCXX:
400     return types::TY_ObjCXXHeader;
401   case types::TY_CL:
402   case types::TY_CLCXX:
403     return types::TY_CLHeader;
404   }
405 }
406