Path: blob/main/contrib/llvm-project/clang/lib/Driver/ToolChains/AIX.cpp
35294 views
//===--- AIX.cpp - AIX ToolChain Implementations ----------------*- C++ -*-===//1//2// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.3// See https://llvm.org/LICENSE.txt for license information.4// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception5//6//===----------------------------------------------------------------------===//78#include "AIX.h"9#include "Arch/PPC.h"10#include "CommonArgs.h"11#include "clang/Driver/Compilation.h"12#include "clang/Driver/Options.h"13#include "clang/Driver/SanitizerArgs.h"14#include "llvm/ADT/StringExtras.h"15#include "llvm/Option/ArgList.h"16#include "llvm/ProfileData/InstrProf.h"17#include "llvm/Support/Path.h"1819#include <set>2021using AIX = clang::driver::toolchains::AIX;22using namespace clang::driver;23using namespace clang::driver::tools;24using namespace clang::driver::toolchains;2526using namespace llvm::opt;27using namespace llvm::sys;2829void aix::Assembler::ConstructJob(Compilation &C, const JobAction &JA,30const InputInfo &Output,31const InputInfoList &Inputs,32const ArgList &Args,33const char *LinkingOutput) const {34const Driver &D = getToolChain().getDriver();35ArgStringList CmdArgs;3637const bool IsArch32Bit = getToolChain().getTriple().isArch32Bit();38const bool IsArch64Bit = getToolChain().getTriple().isArch64Bit();39// Only support 32 and 64 bit.40if (!IsArch32Bit && !IsArch64Bit)41llvm_unreachable("Unsupported bit width value.");4243if (Arg *A = C.getArgs().getLastArg(options::OPT_G)) {44D.Diag(diag::err_drv_unsupported_opt_for_target)45<< A->getSpelling() << D.getTargetTriple();46}4748// Specify the mode in which the as(1) command operates.49if (IsArch32Bit) {50CmdArgs.push_back("-a32");51} else {52// Must be 64-bit, otherwise asserted already.53CmdArgs.push_back("-a64");54}5556// Accept any mixture of instructions.57// On Power for AIX and Linux, this behaviour matches that of GCC for both the58// user-provided assembler source case and the compiler-produced assembler59// source case. Yet XL with user-provided assembler source would not add this.60CmdArgs.push_back("-many");6162Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);6364// Specify assembler output file.65assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");66if (Output.isFilename()) {67CmdArgs.push_back("-o");68CmdArgs.push_back(Output.getFilename());69}7071// Specify assembler input file.72// The system assembler on AIX takes exactly one input file. The driver is73// expected to invoke as(1) separately for each assembler source input file.74if (Inputs.size() != 1)75llvm_unreachable("Invalid number of input files.");76const InputInfo &II = Inputs[0];77assert((II.isFilename() || II.isNothing()) && "Invalid input.");78if (II.isFilename())79CmdArgs.push_back(II.getFilename());8081const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));82C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),83Exec, CmdArgs, Inputs, Output));84}8586// Determine whether there are any linker options that supply an export list87// (or equivalent information about what to export) being sent to the linker.88static bool hasExportListLinkerOpts(const ArgStringList &CmdArgs) {89for (size_t i = 0, Size = CmdArgs.size(); i < Size; ++i) {90llvm::StringRef ArgString(CmdArgs[i]);9192if (ArgString.starts_with("-bE:") || ArgString.starts_with("-bexport:") ||93ArgString == "-bexpall" || ArgString == "-bexpfull")94return true;9596// If we split -b option, check the next opt.97if (ArgString == "-b" && i + 1 < Size) {98++i;99llvm::StringRef ArgNextString(CmdArgs[i]);100if (ArgNextString.starts_with("E:") ||101ArgNextString.starts_with("export:") || ArgNextString == "expall" ||102ArgNextString == "expfull")103return true;104}105}106return false;107}108109void aix::Linker::ConstructJob(Compilation &C, const JobAction &JA,110const InputInfo &Output,111const InputInfoList &Inputs, const ArgList &Args,112const char *LinkingOutput) const {113const AIX &ToolChain = static_cast<const AIX &>(getToolChain());114const Driver &D = ToolChain.getDriver();115ArgStringList CmdArgs;116117const bool IsArch32Bit = ToolChain.getTriple().isArch32Bit();118const bool IsArch64Bit = ToolChain.getTriple().isArch64Bit();119// Only support 32 and 64 bit.120if (!(IsArch32Bit || IsArch64Bit))121llvm_unreachable("Unsupported bit width value.");122123if (Arg *A = C.getArgs().getLastArg(options::OPT_G)) {124D.Diag(diag::err_drv_unsupported_opt_for_target)125<< A->getSpelling() << D.getTargetTriple();126}127128// Force static linking when "-static" is present.129if (Args.hasArg(options::OPT_static))130CmdArgs.push_back("-bnso");131132// Add options for shared libraries.133if (Args.hasArg(options::OPT_shared)) {134CmdArgs.push_back("-bM:SRE");135CmdArgs.push_back("-bnoentry");136}137138if (Args.hasFlag(options::OPT_mxcoff_roptr, options::OPT_mno_xcoff_roptr,139false)) {140if (Args.hasArg(options::OPT_shared))141D.Diag(diag::err_roptr_cannot_build_shared);142143// The `-mxcoff-roptr` option places constants in RO sections as much as144// possible. Then `-bforceimprw` changes such sections to RW if they contain145// imported symbols that need to be resolved.146CmdArgs.push_back("-bforceimprw");147}148149// PGO instrumentation generates symbols belonging to special sections, and150// the linker needs to place all symbols in a particular section together in151// memory; the AIX linker does that under an option.152if (Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,153false) ||154Args.hasFlag(options::OPT_fprofile_generate,155options::OPT_fno_profile_generate, false) ||156Args.hasFlag(options::OPT_fprofile_generate_EQ,157options::OPT_fno_profile_generate, false) ||158Args.hasFlag(options::OPT_fprofile_instr_generate,159options::OPT_fno_profile_instr_generate, false) ||160Args.hasFlag(options::OPT_fprofile_instr_generate_EQ,161options::OPT_fno_profile_instr_generate, false) ||162Args.hasFlag(options::OPT_fcs_profile_generate,163options::OPT_fno_profile_generate, false) ||164Args.hasFlag(options::OPT_fcs_profile_generate_EQ,165options::OPT_fno_profile_generate, false) ||166Args.hasArg(options::OPT_fcreate_profile) ||167Args.hasArg(options::OPT_coverage))168CmdArgs.push_back("-bdbg:namedsects:ss");169170if (Arg *A =171Args.getLastArg(clang::driver::options::OPT_mxcoff_build_id_EQ)) {172StringRef BuildId = A->getValue();173if (BuildId[0] != '0' || BuildId[1] != 'x' ||174BuildId.find_if_not(llvm::isHexDigit, 2) != StringRef::npos)175ToolChain.getDriver().Diag(diag::err_drv_unsupported_option_argument)176<< A->getSpelling() << BuildId;177else {178std::string LinkerFlag = "-bdbg:ldrinfo:xcoff_binary_id:0x";179if (BuildId.size() % 2) // Prepend a 0 if odd number of digits.180LinkerFlag += "0";181LinkerFlag += BuildId.drop_front(2).lower();182CmdArgs.push_back(Args.MakeArgString(LinkerFlag));183}184}185186// Specify linker output file.187assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");188if (Output.isFilename()) {189CmdArgs.push_back("-o");190CmdArgs.push_back(Output.getFilename());191}192193// Set linking mode (i.e., 32/64-bit) and the address of194// text and data sections based on arch bit width.195if (IsArch32Bit) {196CmdArgs.push_back("-b32");197CmdArgs.push_back("-bpT:0x10000000");198CmdArgs.push_back("-bpD:0x20000000");199} else {200// Must be 64-bit, otherwise asserted already.201CmdArgs.push_back("-b64");202CmdArgs.push_back("-bpT:0x100000000");203CmdArgs.push_back("-bpD:0x110000000");204}205206if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,207options::OPT_shared, options::OPT_r)) {208auto getCrt0Basename = [&Args, IsArch32Bit] {209if (Arg *A = Args.getLastArgNoClaim(options::OPT_p, options::OPT_pg)) {210// Enable gprofiling when "-pg" is specified.211if (A->getOption().matches(options::OPT_pg))212return IsArch32Bit ? "gcrt0.o" : "gcrt0_64.o";213// Enable profiling when "-p" is specified.214return IsArch32Bit ? "mcrt0.o" : "mcrt0_64.o";215}216return IsArch32Bit ? "crt0.o" : "crt0_64.o";217};218219CmdArgs.push_back(220Args.MakeArgString(ToolChain.GetFilePath(getCrt0Basename())));221222CmdArgs.push_back(Args.MakeArgString(223ToolChain.GetFilePath(IsArch32Bit ? "crti.o" : "crti_64.o")));224}225226// Collect all static constructor and destructor functions in both C and CXX227// language link invocations. This has to come before AddLinkerInputs as the228// implied option needs to precede any other '-bcdtors' settings or229// '-bnocdtors' that '-Wl' might forward.230CmdArgs.push_back("-bcdtors:all:0:s");231232// Specify linker input file(s).233AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);234235if (D.isUsingLTO()) {236assert(!Inputs.empty() && "Must have at least one input.");237// Find the first filename InputInfo object.238auto Input = llvm::find_if(239Inputs, [](const InputInfo &II) -> bool { return II.isFilename(); });240if (Input == Inputs.end())241// For a very rare case, all of the inputs to the linker are242// InputArg. If that happens, just use the first InputInfo.243Input = Inputs.begin();244245addLTOOptions(ToolChain, Args, CmdArgs, Output, *Input,246D.getLTOMode() == LTOK_Thin);247}248249if (Args.hasArg(options::OPT_shared) && !hasExportListLinkerOpts(CmdArgs)) {250251const char *CreateExportListExec = Args.MakeArgString(252path::parent_path(ToolChain.getDriver().ClangExecutable) +253"/llvm-nm");254ArgStringList CreateExportCmdArgs;255256std::string CreateExportListPath =257C.getDriver().GetTemporaryPath("CreateExportList", "exp");258const char *ExportList =259C.addTempFile(C.getArgs().MakeArgString(CreateExportListPath));260261for (const auto &II : Inputs)262if (II.isFilename())263CreateExportCmdArgs.push_back(II.getFilename());264265CreateExportCmdArgs.push_back("--export-symbols");266CreateExportCmdArgs.push_back("-X");267if (IsArch32Bit) {268CreateExportCmdArgs.push_back("32");269} else {270// Must be 64-bit, otherwise asserted already.271CreateExportCmdArgs.push_back("64");272}273274auto ExpCommand = std::make_unique<Command>(275JA, *this, ResponseFileSupport::None(), CreateExportListExec,276CreateExportCmdArgs, Inputs, Output);277ExpCommand->setRedirectFiles(278{std::nullopt, std::string(ExportList), std::nullopt});279C.addCommand(std::move(ExpCommand));280CmdArgs.push_back(Args.MakeArgString(llvm::Twine("-bE:") + ExportList));281}282283// Add directory to library search path.284Args.AddAllArgs(CmdArgs, options::OPT_L);285if (!Args.hasArg(options::OPT_r)) {286ToolChain.AddFilePathLibArgs(Args, CmdArgs);287ToolChain.addProfileRTLibs(Args, CmdArgs);288289if (getToolChain().ShouldLinkCXXStdlib(Args))290getToolChain().AddCXXStdlibLibArgs(Args, CmdArgs);291292if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {293AddRunTimeLibs(ToolChain, D, CmdArgs, Args);294295// Add OpenMP runtime if -fopenmp is specified.296if (Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,297options::OPT_fno_openmp, false)) {298switch (ToolChain.getDriver().getOpenMPRuntime(Args)) {299case Driver::OMPRT_OMP:300CmdArgs.push_back("-lomp");301break;302case Driver::OMPRT_IOMP5:303CmdArgs.push_back("-liomp5");304break;305case Driver::OMPRT_GOMP:306CmdArgs.push_back("-lgomp");307break;308case Driver::OMPRT_Unknown:309// Already diagnosed.310break;311}312}313314// Support POSIX threads if "-pthreads" or "-pthread" is present.315if (Args.hasArg(options::OPT_pthreads, options::OPT_pthread))316CmdArgs.push_back("-lpthreads");317318if (D.CCCIsCXX())319CmdArgs.push_back("-lm");320321CmdArgs.push_back("-lc");322323if (Args.hasArgNoClaim(options::OPT_p, options::OPT_pg)) {324CmdArgs.push_back(Args.MakeArgString((llvm::Twine("-L") + D.SysRoot) +325"/lib/profiled"));326CmdArgs.push_back(Args.MakeArgString((llvm::Twine("-L") + D.SysRoot) +327"/usr/lib/profiled"));328}329}330}331332if (D.IsFlangMode()) {333addFortranRuntimeLibraryPath(ToolChain, Args, CmdArgs);334addFortranRuntimeLibs(ToolChain, Args, CmdArgs);335CmdArgs.push_back("-lm");336CmdArgs.push_back("-lpthread");337}338const char *Exec = Args.MakeArgString(ToolChain.GetLinkerPath());339C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),340Exec, CmdArgs, Inputs, Output));341}342343/// AIX - AIX tool chain which can call as(1) and ld(1) directly.344AIX::AIX(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)345: ToolChain(D, Triple, Args) {346getProgramPaths().push_back(getDriver().Dir);347348ParseInlineAsmUsingAsmParser = Args.hasFlag(349options::OPT_fintegrated_as, options::OPT_fno_integrated_as, true);350getLibraryPaths().push_back(getDriver().SysRoot + "/usr/lib");351}352353// Returns the effective header sysroot path to use.354// This comes from either -isysroot or --sysroot.355llvm::StringRef356AIX::GetHeaderSysroot(const llvm::opt::ArgList &DriverArgs) const {357if (DriverArgs.hasArg(options::OPT_isysroot))358return DriverArgs.getLastArgValue(options::OPT_isysroot);359if (!getDriver().SysRoot.empty())360return getDriver().SysRoot;361return "/";362}363364void AIX::AddOpenMPIncludeArgs(const ArgList &DriverArgs,365ArgStringList &CC1Args) const {366// Add OpenMP include paths if -fopenmp is specified.367if (DriverArgs.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,368options::OPT_fno_openmp, false)) {369SmallString<128> PathOpenMP;370switch (getDriver().getOpenMPRuntime(DriverArgs)) {371case Driver::OMPRT_OMP:372PathOpenMP = GetHeaderSysroot(DriverArgs);373llvm::sys::path::append(PathOpenMP, "opt/IBM/openxlCSDK", "include",374"openmp");375addSystemInclude(DriverArgs, CC1Args, PathOpenMP.str());376break;377case Driver::OMPRT_IOMP5:378case Driver::OMPRT_GOMP:379case Driver::OMPRT_Unknown:380// Unknown / unsupported include paths.381break;382}383}384}385386void AIX::AddClangSystemIncludeArgs(const ArgList &DriverArgs,387ArgStringList &CC1Args) const {388// Return if -nostdinc is specified as a driver option.389if (DriverArgs.hasArg(options::OPT_nostdinc))390return;391392llvm::StringRef Sysroot = GetHeaderSysroot(DriverArgs);393const Driver &D = getDriver();394395if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {396SmallString<128> P(D.ResourceDir);397// Add the PowerPC intrinsic headers (<resource>/include/ppc_wrappers)398path::append(P, "include", "ppc_wrappers");399addSystemInclude(DriverArgs, CC1Args, P);400// Add the Clang builtin headers (<resource>/include)401addSystemInclude(DriverArgs, CC1Args, path::parent_path(P.str()));402}403404// Add the include directory containing omp.h. This needs to be before405// adding the system include directory because other compilers put their406// omp.h in /usr/include.407AddOpenMPIncludeArgs(DriverArgs, CC1Args);408409// Return if -nostdlibinc is specified as a driver option.410if (DriverArgs.hasArg(options::OPT_nostdlibinc))411return;412413// Add <sysroot>/usr/include.414SmallString<128> UP(Sysroot);415path::append(UP, "/usr/include");416addSystemInclude(DriverArgs, CC1Args, UP.str());417}418419void AIX::AddClangCXXStdlibIncludeArgs(420const llvm::opt::ArgList &DriverArgs,421llvm::opt::ArgStringList &CC1Args) const {422423if (DriverArgs.hasArg(options::OPT_nostdinc) ||424DriverArgs.hasArg(options::OPT_nostdincxx) ||425DriverArgs.hasArg(options::OPT_nostdlibinc))426return;427428switch (GetCXXStdlibType(DriverArgs)) {429case ToolChain::CST_Libstdcxx:430llvm::report_fatal_error(431"picking up libstdc++ headers is unimplemented on AIX");432case ToolChain::CST_Libcxx: {433llvm::StringRef Sysroot = GetHeaderSysroot(DriverArgs);434SmallString<128> PathCPP(Sysroot);435llvm::sys::path::append(PathCPP, "opt/IBM/openxlCSDK", "include", "c++",436"v1");437addSystemInclude(DriverArgs, CC1Args, PathCPP.str());438// Required in order to suppress conflicting C++ overloads in the system439// libc headers that were used by XL C++.440CC1Args.push_back("-D__LIBC_NO_CPP_MATH_OVERLOADS__");441return;442}443}444445llvm_unreachable("Unexpected C++ library type; only libc++ is supported.");446}447448void AIX::AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,449llvm::opt::ArgStringList &CmdArgs) const {450switch (GetCXXStdlibType(Args)) {451case ToolChain::CST_Libstdcxx:452llvm::report_fatal_error("linking libstdc++ unimplemented on AIX");453case ToolChain::CST_Libcxx:454CmdArgs.push_back("-lc++");455if (Args.hasArg(options::OPT_fexperimental_library))456CmdArgs.push_back("-lc++experimental");457CmdArgs.push_back("-lc++abi");458return;459}460461llvm_unreachable("Unexpected C++ library type; only libc++ is supported.");462}463464// This function processes all the mtocdata options to build the final465// simplified toc data options to pass to CC1.466static void addTocDataOptions(const llvm::opt::ArgList &Args,467llvm::opt::ArgStringList &CC1Args,468const Driver &D) {469470// Check the global toc-data setting. The default is -mno-tocdata.471// To enable toc-data globally, -mtocdata must be specified.472// Additionally, it must be last to take effect.473const bool TOCDataGloballyinEffect = [&Args]() {474if (const Arg *LastArg =475Args.getLastArg(options::OPT_mtocdata, options::OPT_mno_tocdata))476return LastArg->getOption().matches(options::OPT_mtocdata);477else478return false;479}();480481enum TOCDataSetting {482AddressInTOC = 0, // Address of the symbol stored in the TOC.483DataInTOC = 1 // Symbol defined in the TOC.484};485486const TOCDataSetting DefaultTocDataSetting =487TOCDataGloballyinEffect ? DataInTOC : AddressInTOC;488489// Process the list of variables in the explicitly specified options490// -mtocdata= and -mno-tocdata= to see which variables are opposite to491// the global setting of tocdata in TOCDataGloballyinEffect.492// Those that have the opposite setting to TOCDataGloballyinEffect, are added493// to ExplicitlySpecifiedGlobals.494std::set<llvm::StringRef> ExplicitlySpecifiedGlobals;495for (const auto Arg :496Args.filtered(options::OPT_mtocdata_EQ, options::OPT_mno_tocdata_EQ)) {497TOCDataSetting ArgTocDataSetting =498Arg->getOption().matches(options::OPT_mtocdata_EQ) ? DataInTOC499: AddressInTOC;500501if (ArgTocDataSetting != DefaultTocDataSetting)502for (const char *Val : Arg->getValues())503ExplicitlySpecifiedGlobals.insert(Val);504else505for (const char *Val : Arg->getValues())506ExplicitlySpecifiedGlobals.erase(Val);507}508509auto buildExceptionList = [](const std::set<llvm::StringRef> &ExplicitValues,510const char *OptionSpelling) {511std::string Option(OptionSpelling);512bool IsFirst = true;513for (const auto &E : ExplicitValues) {514if (!IsFirst)515Option += ",";516517IsFirst = false;518Option += E.str();519}520return Option;521};522523// Pass the final tocdata options to CC1 consisting of the default524// tocdata option (-mtocdata/-mno-tocdata) along with the list525// option (-mno-tocdata=/-mtocdata=) if there are any explicitly specified526// variables which would be exceptions to the default setting.527const char *TocDataGlobalOption =528TOCDataGloballyinEffect ? "-mtocdata" : "-mno-tocdata";529CC1Args.push_back(TocDataGlobalOption);530531const char *TocDataListOption =532TOCDataGloballyinEffect ? "-mno-tocdata=" : "-mtocdata=";533if (!ExplicitlySpecifiedGlobals.empty())534CC1Args.push_back(Args.MakeArgString(llvm::Twine(535buildExceptionList(ExplicitlySpecifiedGlobals, TocDataListOption))));536}537538void AIX::addClangTargetOptions(539const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CC1Args,540Action::OffloadKind DeviceOffloadingKind) const {541Args.AddLastArg(CC1Args, options::OPT_mignore_xcoff_visibility);542Args.AddLastArg(CC1Args, options::OPT_mdefault_visibility_export_mapping_EQ);543Args.addOptInFlag(CC1Args, options::OPT_mxcoff_roptr, options::OPT_mno_xcoff_roptr);544545// Forward last mtocdata/mno_tocdata options to -cc1.546if (Args.hasArg(options::OPT_mtocdata_EQ, options::OPT_mno_tocdata_EQ,547options::OPT_mtocdata))548addTocDataOptions(Args, CC1Args, getDriver());549550if (Args.hasFlag(options::OPT_fxl_pragma_pack,551options::OPT_fno_xl_pragma_pack, true))552CC1Args.push_back("-fxl-pragma-pack");553554// Pass "-fno-sized-deallocation" only when the user hasn't manually enabled555// or disabled sized deallocations.556if (!Args.getLastArgNoClaim(options::OPT_fsized_deallocation,557options::OPT_fno_sized_deallocation))558CC1Args.push_back("-fno-sized-deallocation");559}560561void AIX::addProfileRTLibs(const llvm::opt::ArgList &Args,562llvm::opt::ArgStringList &CmdArgs) const {563if (needsProfileRT(Args)) {564// Add linker option -u__llvm_profile_runtime to cause runtime565// initialization to occur.566CmdArgs.push_back(Args.MakeArgString(567Twine("-u", llvm::getInstrProfRuntimeHookVarName())));568569if (const auto *A =570Args.getLastArgNoClaim(options::OPT_fprofile_update_EQ)) {571StringRef Val = A->getValue();572if (Val == "atomic" || Val == "prefer-atomic")573CmdArgs.push_back("-latomic");574}575}576577ToolChain::addProfileRTLibs(Args, CmdArgs);578}579580ToolChain::CXXStdlibType AIX::GetDefaultCXXStdlibType() const {581return ToolChain::CST_Libcxx;582}583584ToolChain::RuntimeLibType AIX::GetDefaultRuntimeLibType() const {585return ToolChain::RLT_CompilerRT;586}587588auto AIX::buildAssembler() const -> Tool * { return new aix::Assembler(*this); }589590auto AIX::buildLinker() const -> Tool * { return new aix::Linker(*this); }591592593