1//===--- MSVC.h - MSVC ToolChain Implementations ----------------*- 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#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_MSVC_H
10#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_MSVC_H
11
12#include "clang/Driver/Compilation.h"
13#include "clang/Driver/CudaInstallationDetector.h"
14#include "clang/Driver/LazyDetector.h"
15#include "clang/Driver/RocmInstallationDetector.h"
16#include "clang/Driver/SyclInstallationDetector.h"
17#include "clang/Driver/Tool.h"
18#include "clang/Driver/ToolChain.h"
19#include "llvm/Frontend/Debug/Options.h"
20#include "llvm/WindowsDriver/MSVCPaths.h"
21
22namespace clang {
23namespace driver {
24namespace tools {
25
26/// Visual studio tools.
27namespace visualstudio {
28class LLVM_LIBRARY_VISIBILITY Linker final : public Tool {
29public:
30 Linker(const ToolChain &TC) : Tool("visualstudio::Linker", "linker", TC) {}
31
32 bool hasIntegratedCPP() const override { return false; }
33 bool isLinkJob() const override { return true; }
34
35 void ConstructJob(Compilation &C, const JobAction &JA,
36 const InputInfo &Output, const InputInfoList &Inputs,
37 const llvm::opt::ArgList &TCArgs,
38 const char *LinkingOutput) const override;
39};
40} // end namespace visualstudio
41
42class LLVM_LIBRARY_VISIBILITY ARM64XObjcopy : public Tool {
43public:
44 ARM64XObjcopy(const ToolChain &TC)
45 : Tool("ARM64XObjcopy", "llvm-objcopy", TC) {}
46
47 bool hasIntegratedCPP() const override { return false; }
48
49 void ConstructJob(Compilation &C, const JobAction &JA,
50 const InputInfo &Output, const InputInfoList &Inputs,
51 const llvm::opt::ArgList &TCArgs,
52 const char *LinkingOutput) const override;
53};
54
55} // end namespace tools
56
57namespace toolchains {
58
59class LLVM_LIBRARY_VISIBILITY MSVCToolChain : public ToolChain {
60public:
61 MSVCToolChain(const Driver &D, const llvm::Triple &Triple,
62 const llvm::opt::ArgList &Args);
63
64 llvm::opt::DerivedArgList *
65 TranslateArgs(const llvm::opt::DerivedArgList &Args, BoundArch BA,
66 Action::OffloadKind DeviceOffloadKind) const override;
67
68 UnwindTableLevel
69 getDefaultUnwindTableLevel(const llvm::opt::ArgList &Args) const override;
70 bool isPICDefault() const override;
71 bool isPIEDefault(const llvm::opt::ArgList &Args) const override;
72 bool isPICDefaultForced() const override;
73
74 /// Set CodeView as the default debug info format for non-MachO binary
75 /// formats, and to DWARF otherwise. Users can use -gcodeview and -gdwarf to
76 /// override the default.
77 llvm::codegenoptions::DebugInfoFormat getDefaultDebugFormat() const override {
78 return getTriple().isOSBinFormatCOFF() ? llvm::codegenoptions::DIF_CodeView
79 : llvm::codegenoptions::DIF_DWARF;
80 }
81
82 /// Set the debugger tuning to "default", since we're definitely not tuning
83 /// for GDB.
84 llvm::DebuggerKind getDefaultDebuggerTuning() const override {
85 return llvm::DebuggerKind::Default;
86 }
87
88 unsigned GetDefaultDwarfVersion() const override {
89 return 4;
90 }
91
92 std::string getSubDirectoryPath(llvm::SubDirectoryType Type,
93 llvm::StringRef SubdirParent = "") const;
94 std::string getSubDirectoryPath(llvm::SubDirectoryType Type,
95 llvm::Triple::ArchType TargetArch) const;
96
97 bool getIsVS2017OrNewer() const {
98 return VSLayout == llvm::ToolsetLayout::VS2017OrNewer;
99 }
100
101 void
102 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
103 llvm::opt::ArgStringList &CC1Args) const override;
104 void AddClangCXXStdlibIncludeArgs(
105 const llvm::opt::ArgList &DriverArgs,
106 llvm::opt::ArgStringList &CC1Args) const override;
107
108 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
109 llvm::opt::ArgStringList &CC1Args) const override;
110
111 void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs,
112 llvm::opt::ArgStringList &CC1Args) const override;
113
114 void addOffloadRTLibs(unsigned ActiveKinds, const llvm::opt::ArgList &Args,
115 llvm::opt::ArgStringList &CmdArgs) const override;
116
117 void addSYCLIncludeArgs(const llvm::opt::ArgList &DriverArgs,
118 llvm::opt::ArgStringList &CC1Args) const override;
119
120 bool getWindowsSDKLibraryPath(
121 const llvm::opt::ArgList &Args, std::string &path) const;
122 bool getUniversalCRTLibraryPath(const llvm::opt::ArgList &Args,
123 std::string &path) const;
124 bool useUniversalCRT() const;
125 VersionTuple
126 computeMSVCVersion(const Driver *D,
127 const llvm::opt::ArgList &Args) const override;
128
129 std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args,
130 BoundArch BA,
131 types::ID InputType) const override;
132 SanitizerMask
133 getSupportedSanitizers(BoundArch BA,
134 Action::OffloadKind DeviceOffloadKind) const override;
135
136 void printVerboseInfo(raw_ostream &OS) const override;
137
138 bool FoundMSVCInstall() const { return !VCToolChainPath.empty(); }
139
140 void
141 addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
142 llvm::opt::ArgStringList &CC1Args, BoundArch BA,
143 Action::OffloadKind DeviceOffloadKind) const override;
144
145protected:
146 void AddSystemIncludeWithSubfolder(const llvm::opt::ArgList &DriverArgs,
147 llvm::opt::ArgStringList &CC1Args,
148 const std::string &folder,
149 const Twine &subfolder1,
150 const Twine &subfolder2 = "",
151 const Twine &subfolder3 = "") const;
152
153 Tool *getTool(Action::ActionClass AC) const override;
154 Tool *buildLinker() const override;
155 Tool *buildAssembler() const override;
156
157private:
158 std::optional<llvm::StringRef> WinSdkDir, WinSdkVersion, WinSysRoot;
159 std::string VCToolChainPath;
160 llvm::ToolsetLayout VSLayout = llvm::ToolsetLayout::OlderVS;
161 LazyDetector<CudaInstallationDetector> CudaInstallation;
162 LazyDetector<RocmInstallationDetector> RocmInstallation;
163 LazyDetector<SYCLInstallationDetector> SYCLInstallation;
164 mutable std::unique_ptr<tools::ARM64XObjcopy> Objcopy;
165};
166
167} // end namespace toolchains
168} // end namespace driver
169} // end namespace clang
170
171#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_MSVC_H
172