Darwin.cpp 125 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279
  1. //===--- Darwin.cpp - Darwin Tool and 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. #include "Darwin.h"
  9. #include "Arch/AArch64.h"
  10. #include "Arch/ARM.h"
  11. #include "CommonArgs.h"
  12. #include "clang/Basic/AlignedAllocation.h"
  13. #include "clang/Basic/ObjCRuntime.h"
  14. #include "clang/Config/config.h"
  15. #include "clang/Driver/Compilation.h"
  16. #include "clang/Driver/Driver.h"
  17. #include "clang/Driver/DriverDiagnostic.h"
  18. #include "clang/Driver/Options.h"
  19. #include "clang/Driver/SanitizerArgs.h"
  20. #include "llvm/ADT/StringSwitch.h"
  21. #include "llvm/Option/ArgList.h"
  22. #include "llvm/ProfileData/InstrProf.h"
  23. #include "llvm/Support/Path.h"
  24. #include "llvm/Support/ScopedPrinter.h"
  25. #include "llvm/Support/TargetParser.h"
  26. #include "llvm/Support/Threading.h"
  27. #include "llvm/Support/VirtualFileSystem.h"
  28. #include <cstdlib> // ::getenv
  29. using namespace clang::driver;
  30. using namespace clang::driver::tools;
  31. using namespace clang::driver::toolchains;
  32. using namespace clang;
  33. using namespace llvm::opt;
  34. static VersionTuple minimumMacCatalystDeploymentTarget() {
  35. return VersionTuple(13, 1);
  36. }
  37. llvm::Triple::ArchType darwin::getArchTypeForMachOArchName(StringRef Str) {
  38. // See arch(3) and llvm-gcc's driver-driver.c. We don't implement support for
  39. // archs which Darwin doesn't use.
  40. // The matching this routine does is fairly pointless, since it is neither the
  41. // complete architecture list, nor a reasonable subset. The problem is that
  42. // historically the driver accepts this and also ties its -march=
  43. // handling to the architecture name, so we need to be careful before removing
  44. // support for it.
  45. // This code must be kept in sync with Clang's Darwin specific argument
  46. // translation.
  47. return llvm::StringSwitch<llvm::Triple::ArchType>(Str)
  48. .Cases("ppc", "ppc601", "ppc603", "ppc604", "ppc604e", llvm::Triple::ppc)
  49. .Cases("ppc750", "ppc7400", "ppc7450", "ppc970", llvm::Triple::ppc)
  50. .Case("ppc64", llvm::Triple::ppc64)
  51. .Cases("i386", "i486", "i486SX", "i586", "i686", llvm::Triple::x86)
  52. .Cases("pentium", "pentpro", "pentIIm3", "pentIIm5", "pentium4",
  53. llvm::Triple::x86)
  54. .Cases("x86_64", "x86_64h", llvm::Triple::x86_64)
  55. // This is derived from the driver.
  56. .Cases("arm", "armv4t", "armv5", "armv6", "armv6m", llvm::Triple::arm)
  57. .Cases("armv7", "armv7em", "armv7k", "armv7m", llvm::Triple::arm)
  58. .Cases("armv7s", "xscale", llvm::Triple::arm)
  59. .Cases("arm64", "arm64e", llvm::Triple::aarch64)
  60. .Case("arm64_32", llvm::Triple::aarch64_32)
  61. .Case("r600", llvm::Triple::r600)
  62. .Case("amdgcn", llvm::Triple::amdgcn)
  63. .Case("nvptx", llvm::Triple::nvptx)
  64. .Case("nvptx64", llvm::Triple::nvptx64)
  65. .Case("amdil", llvm::Triple::amdil)
  66. .Case("spir", llvm::Triple::spir)
  67. .Default(llvm::Triple::UnknownArch);
  68. }
  69. void darwin::setTripleTypeForMachOArchName(llvm::Triple &T, StringRef Str) {
  70. const llvm::Triple::ArchType Arch = getArchTypeForMachOArchName(Str);
  71. llvm::ARM::ArchKind ArchKind = llvm::ARM::parseArch(Str);
  72. T.setArch(Arch);
  73. if (Arch != llvm::Triple::UnknownArch)
  74. T.setArchName(Str);
  75. if (ArchKind == llvm::ARM::ArchKind::ARMV6M ||
  76. ArchKind == llvm::ARM::ArchKind::ARMV7M ||
  77. ArchKind == llvm::ARM::ArchKind::ARMV7EM) {
  78. T.setOS(llvm::Triple::UnknownOS);
  79. T.setObjectFormat(llvm::Triple::MachO);
  80. }
  81. }
  82. void darwin::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
  83. const InputInfo &Output,
  84. const InputInfoList &Inputs,
  85. const ArgList &Args,
  86. const char *LinkingOutput) const {
  87. const llvm::Triple &T(getToolChain().getTriple());
  88. ArgStringList CmdArgs;
  89. assert(Inputs.size() == 1 && "Unexpected number of inputs.");
  90. const InputInfo &Input = Inputs[0];
  91. // Determine the original source input.
  92. const Action *SourceAction = &JA;
  93. while (SourceAction->getKind() != Action::InputClass) {
  94. assert(!SourceAction->getInputs().empty() && "unexpected root action!");
  95. SourceAction = SourceAction->getInputs()[0];
  96. }
  97. // If -fno-integrated-as is used add -Q to the darwin assembler driver to make
  98. // sure it runs its system assembler not clang's integrated assembler.
  99. // Applicable to darwin11+ and Xcode 4+. darwin<10 lacked integrated-as.
  100. // FIXME: at run-time detect assembler capabilities or rely on version
  101. // information forwarded by -target-assembler-version.
  102. if (Args.hasArg(options::OPT_fno_integrated_as)) {
  103. if (!(T.isMacOSX() && T.isMacOSXVersionLT(10, 7)))
  104. CmdArgs.push_back("-Q");
  105. }
  106. // Forward -g, assuming we are dealing with an actual assembly file.
  107. if (SourceAction->getType() == types::TY_Asm ||
  108. SourceAction->getType() == types::TY_PP_Asm) {
  109. if (Args.hasArg(options::OPT_gstabs))
  110. CmdArgs.push_back("--gstabs");
  111. else if (Args.hasArg(options::OPT_g_Group))
  112. CmdArgs.push_back("-g");
  113. }
  114. // Derived from asm spec.
  115. AddMachOArch(Args, CmdArgs);
  116. // Use -force_cpusubtype_ALL on x86 by default.
  117. if (T.isX86() || Args.hasArg(options::OPT_force__cpusubtype__ALL))
  118. CmdArgs.push_back("-force_cpusubtype_ALL");
  119. if (getToolChain().getArch() != llvm::Triple::x86_64 &&
  120. (((Args.hasArg(options::OPT_mkernel) ||
  121. Args.hasArg(options::OPT_fapple_kext)) &&
  122. getMachOToolChain().isKernelStatic()) ||
  123. Args.hasArg(options::OPT_static)))
  124. CmdArgs.push_back("-static");
  125. Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
  126. assert(Output.isFilename() && "Unexpected lipo output.");
  127. CmdArgs.push_back("-o");
  128. CmdArgs.push_back(Output.getFilename());
  129. assert(Input.isFilename() && "Invalid input.");
  130. CmdArgs.push_back(Input.getFilename());
  131. // asm_final spec is empty.
  132. const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));
  133. C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
  134. Exec, CmdArgs, Inputs, Output));
  135. }
  136. void darwin::MachOTool::anchor() {}
  137. void darwin::MachOTool::AddMachOArch(const ArgList &Args,
  138. ArgStringList &CmdArgs) const {
  139. StringRef ArchName = getMachOToolChain().getMachOArchName(Args);
  140. // Derived from darwin_arch spec.
  141. CmdArgs.push_back("-arch");
  142. CmdArgs.push_back(Args.MakeArgString(ArchName));
  143. // FIXME: Is this needed anymore?
  144. if (ArchName == "arm")
  145. CmdArgs.push_back("-force_cpusubtype_ALL");
  146. }
  147. bool darwin::Linker::NeedsTempPath(const InputInfoList &Inputs) const {
  148. // We only need to generate a temp path for LTO if we aren't compiling object
  149. // files. When compiling source files, we run 'dsymutil' after linking. We
  150. // don't run 'dsymutil' when compiling object files.
  151. for (const auto &Input : Inputs)
  152. if (Input.getType() != types::TY_Object)
  153. return true;
  154. return false;
  155. }
  156. /// Pass -no_deduplicate to ld64 under certain conditions:
  157. ///
  158. /// - Either -O0 or -O1 is explicitly specified
  159. /// - No -O option is specified *and* this is a compile+link (implicit -O0)
  160. ///
  161. /// Also do *not* add -no_deduplicate when no -O option is specified and this
  162. /// is just a link (we can't imply -O0)
  163. static bool shouldLinkerNotDedup(bool IsLinkerOnlyAction, const ArgList &Args) {
  164. if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
  165. if (A->getOption().matches(options::OPT_O0))
  166. return true;
  167. if (A->getOption().matches(options::OPT_O))
  168. return llvm::StringSwitch<bool>(A->getValue())
  169. .Case("1", true)
  170. .Default(false);
  171. return false; // OPT_Ofast & OPT_O4
  172. }
  173. if (!IsLinkerOnlyAction) // Implicit -O0 for compile+linker only.
  174. return true;
  175. return false;
  176. }
  177. void darwin::Linker::AddLinkArgs(Compilation &C, const ArgList &Args,
  178. ArgStringList &CmdArgs,
  179. const InputInfoList &Inputs,
  180. VersionTuple Version, bool LinkerIsLLD) const {
  181. const Driver &D = getToolChain().getDriver();
  182. const toolchains::MachO &MachOTC = getMachOToolChain();
  183. // Newer linkers support -demangle. Pass it if supported and not disabled by
  184. // the user.
  185. if ((Version >= VersionTuple(100) || LinkerIsLLD) &&
  186. !Args.hasArg(options::OPT_Z_Xlinker__no_demangle))
  187. CmdArgs.push_back("-demangle");
  188. if (Args.hasArg(options::OPT_rdynamic) &&
  189. (Version >= VersionTuple(137) || LinkerIsLLD))
  190. CmdArgs.push_back("-export_dynamic");
  191. // If we are using App Extension restrictions, pass a flag to the linker
  192. // telling it that the compiled code has been audited.
  193. if (Args.hasFlag(options::OPT_fapplication_extension,
  194. options::OPT_fno_application_extension, false))
  195. CmdArgs.push_back("-application_extension");
  196. if (D.isUsingLTO() && (Version >= VersionTuple(116) || LinkerIsLLD) &&
  197. NeedsTempPath(Inputs)) {
  198. std::string TmpPathName;
  199. if (D.getLTOMode() == LTOK_Full) {
  200. // If we are using full LTO, then automatically create a temporary file
  201. // path for the linker to use, so that it's lifetime will extend past a
  202. // possible dsymutil step.
  203. TmpPathName =
  204. D.GetTemporaryPath("cc", types::getTypeTempSuffix(types::TY_Object));
  205. } else if (D.getLTOMode() == LTOK_Thin)
  206. // If we are using thin LTO, then create a directory instead.
  207. TmpPathName = D.GetTemporaryDirectory("thinlto");
  208. if (!TmpPathName.empty()) {
  209. auto *TmpPath = C.getArgs().MakeArgString(TmpPathName);
  210. C.addTempFile(TmpPath);
  211. CmdArgs.push_back("-object_path_lto");
  212. CmdArgs.push_back(TmpPath);
  213. }
  214. }
  215. // Use -lto_library option to specify the libLTO.dylib path. Try to find
  216. // it in clang installed libraries. ld64 will only look at this argument
  217. // when it actually uses LTO, so libLTO.dylib only needs to exist at link
  218. // time if ld64 decides that it needs to use LTO.
  219. // Since this is passed unconditionally, ld64 will never look for libLTO.dylib
  220. // next to it. That's ok since ld64 using a libLTO.dylib not matching the
  221. // clang version won't work anyways.
  222. // lld is built at the same revision as clang and statically links in
  223. // LLVM libraries, so it doesn't need libLTO.dylib.
  224. if (Version >= VersionTuple(133) && !LinkerIsLLD) {
  225. // Search for libLTO in <InstalledDir>/../lib/libLTO.dylib
  226. StringRef P = llvm::sys::path::parent_path(D.Dir);
  227. SmallString<128> LibLTOPath(P);
  228. llvm::sys::path::append(LibLTOPath, "lib");
  229. llvm::sys::path::append(LibLTOPath, "libLTO.dylib");
  230. CmdArgs.push_back("-lto_library");
  231. CmdArgs.push_back(C.getArgs().MakeArgString(LibLTOPath));
  232. }
  233. // ld64 version 262 and above runs the deduplicate pass by default.
  234. // FIXME: lld doesn't dedup by default. Should we pass `--icf=safe`
  235. // if `!shouldLinkerNotDedup()` if LinkerIsLLD here?
  236. if (Version >= VersionTuple(262) &&
  237. shouldLinkerNotDedup(C.getJobs().empty(), Args))
  238. CmdArgs.push_back("-no_deduplicate");
  239. // Derived from the "link" spec.
  240. Args.AddAllArgs(CmdArgs, options::OPT_static);
  241. if (!Args.hasArg(options::OPT_static))
  242. CmdArgs.push_back("-dynamic");
  243. if (Args.hasArg(options::OPT_fgnu_runtime)) {
  244. // FIXME: gcc replaces -lobjc in forward args with -lobjc-gnu
  245. // here. How do we wish to handle such things?
  246. }
  247. if (!Args.hasArg(options::OPT_dynamiclib)) {
  248. AddMachOArch(Args, CmdArgs);
  249. // FIXME: Why do this only on this path?
  250. Args.AddLastArg(CmdArgs, options::OPT_force__cpusubtype__ALL);
  251. Args.AddLastArg(CmdArgs, options::OPT_bundle);
  252. Args.AddAllArgs(CmdArgs, options::OPT_bundle__loader);
  253. Args.AddAllArgs(CmdArgs, options::OPT_client__name);
  254. Arg *A;
  255. if ((A = Args.getLastArg(options::OPT_compatibility__version)) ||
  256. (A = Args.getLastArg(options::OPT_current__version)) ||
  257. (A = Args.getLastArg(options::OPT_install__name)))
  258. D.Diag(diag::err_drv_argument_only_allowed_with) << A->getAsString(Args)
  259. << "-dynamiclib";
  260. Args.AddLastArg(CmdArgs, options::OPT_force__flat__namespace);
  261. Args.AddLastArg(CmdArgs, options::OPT_keep__private__externs);
  262. Args.AddLastArg(CmdArgs, options::OPT_private__bundle);
  263. } else {
  264. CmdArgs.push_back("-dylib");
  265. Arg *A;
  266. if ((A = Args.getLastArg(options::OPT_bundle)) ||
  267. (A = Args.getLastArg(options::OPT_bundle__loader)) ||
  268. (A = Args.getLastArg(options::OPT_client__name)) ||
  269. (A = Args.getLastArg(options::OPT_force__flat__namespace)) ||
  270. (A = Args.getLastArg(options::OPT_keep__private__externs)) ||
  271. (A = Args.getLastArg(options::OPT_private__bundle)))
  272. D.Diag(diag::err_drv_argument_not_allowed_with) << A->getAsString(Args)
  273. << "-dynamiclib";
  274. Args.AddAllArgsTranslated(CmdArgs, options::OPT_compatibility__version,
  275. "-dylib_compatibility_version");
  276. Args.AddAllArgsTranslated(CmdArgs, options::OPT_current__version,
  277. "-dylib_current_version");
  278. AddMachOArch(Args, CmdArgs);
  279. Args.AddAllArgsTranslated(CmdArgs, options::OPT_install__name,
  280. "-dylib_install_name");
  281. }
  282. Args.AddLastArg(CmdArgs, options::OPT_all__load);
  283. Args.AddAllArgs(CmdArgs, options::OPT_allowable__client);
  284. Args.AddLastArg(CmdArgs, options::OPT_bind__at__load);
  285. if (MachOTC.isTargetIOSBased())
  286. Args.AddLastArg(CmdArgs, options::OPT_arch__errors__fatal);
  287. Args.AddLastArg(CmdArgs, options::OPT_dead__strip);
  288. Args.AddLastArg(CmdArgs, options::OPT_no__dead__strip__inits__and__terms);
  289. Args.AddAllArgs(CmdArgs, options::OPT_dylib__file);
  290. Args.AddLastArg(CmdArgs, options::OPT_dynamic);
  291. Args.AddAllArgs(CmdArgs, options::OPT_exported__symbols__list);
  292. Args.AddLastArg(CmdArgs, options::OPT_flat__namespace);
  293. Args.AddAllArgs(CmdArgs, options::OPT_force__load);
  294. Args.AddAllArgs(CmdArgs, options::OPT_headerpad__max__install__names);
  295. Args.AddAllArgs(CmdArgs, options::OPT_image__base);
  296. Args.AddAllArgs(CmdArgs, options::OPT_init);
  297. // Add the deployment target.
  298. if (Version >= VersionTuple(520) || LinkerIsLLD)
  299. MachOTC.addPlatformVersionArgs(Args, CmdArgs);
  300. else
  301. MachOTC.addMinVersionArgs(Args, CmdArgs);
  302. Args.AddLastArg(CmdArgs, options::OPT_nomultidefs);
  303. Args.AddLastArg(CmdArgs, options::OPT_multi__module);
  304. Args.AddLastArg(CmdArgs, options::OPT_single__module);
  305. Args.AddAllArgs(CmdArgs, options::OPT_multiply__defined);
  306. Args.AddAllArgs(CmdArgs, options::OPT_multiply__defined__unused);
  307. if (const Arg *A =
  308. Args.getLastArg(options::OPT_fpie, options::OPT_fPIE,
  309. options::OPT_fno_pie, options::OPT_fno_PIE)) {
  310. if (A->getOption().matches(options::OPT_fpie) ||
  311. A->getOption().matches(options::OPT_fPIE))
  312. CmdArgs.push_back("-pie");
  313. else
  314. CmdArgs.push_back("-no_pie");
  315. }
  316. // for embed-bitcode, use -bitcode_bundle in linker command
  317. if (C.getDriver().embedBitcodeEnabled()) {
  318. // Check if the toolchain supports bitcode build flow.
  319. if (MachOTC.SupportsEmbeddedBitcode()) {
  320. CmdArgs.push_back("-bitcode_bundle");
  321. // FIXME: Pass this if LinkerIsLLD too, once it implements this flag.
  322. if (C.getDriver().embedBitcodeMarkerOnly() &&
  323. Version >= VersionTuple(278)) {
  324. CmdArgs.push_back("-bitcode_process_mode");
  325. CmdArgs.push_back("marker");
  326. }
  327. } else
  328. D.Diag(diag::err_drv_bitcode_unsupported_on_toolchain);
  329. }
  330. // If GlobalISel is enabled, pass it through to LLVM.
  331. if (Arg *A = Args.getLastArg(options::OPT_fglobal_isel,
  332. options::OPT_fno_global_isel)) {
  333. if (A->getOption().matches(options::OPT_fglobal_isel)) {
  334. CmdArgs.push_back("-mllvm");
  335. CmdArgs.push_back("-global-isel");
  336. // Disable abort and fall back to SDAG silently.
  337. CmdArgs.push_back("-mllvm");
  338. CmdArgs.push_back("-global-isel-abort=0");
  339. }
  340. }
  341. Args.AddLastArg(CmdArgs, options::OPT_prebind);
  342. Args.AddLastArg(CmdArgs, options::OPT_noprebind);
  343. Args.AddLastArg(CmdArgs, options::OPT_nofixprebinding);
  344. Args.AddLastArg(CmdArgs, options::OPT_prebind__all__twolevel__modules);
  345. Args.AddLastArg(CmdArgs, options::OPT_read__only__relocs);
  346. Args.AddAllArgs(CmdArgs, options::OPT_sectcreate);
  347. Args.AddAllArgs(CmdArgs, options::OPT_sectorder);
  348. Args.AddAllArgs(CmdArgs, options::OPT_seg1addr);
  349. Args.AddAllArgs(CmdArgs, options::OPT_segprot);
  350. Args.AddAllArgs(CmdArgs, options::OPT_segaddr);
  351. Args.AddAllArgs(CmdArgs, options::OPT_segs__read__only__addr);
  352. Args.AddAllArgs(CmdArgs, options::OPT_segs__read__write__addr);
  353. Args.AddAllArgs(CmdArgs, options::OPT_seg__addr__table);
  354. Args.AddAllArgs(CmdArgs, options::OPT_seg__addr__table__filename);
  355. Args.AddAllArgs(CmdArgs, options::OPT_sub__library);
  356. Args.AddAllArgs(CmdArgs, options::OPT_sub__umbrella);
  357. // Give --sysroot= preference, over the Apple specific behavior to also use
  358. // --isysroot as the syslibroot.
  359. StringRef sysroot = C.getSysRoot();
  360. if (sysroot != "") {
  361. CmdArgs.push_back("-syslibroot");
  362. CmdArgs.push_back(C.getArgs().MakeArgString(sysroot));
  363. } else if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
  364. CmdArgs.push_back("-syslibroot");
  365. CmdArgs.push_back(A->getValue());
  366. }
  367. Args.AddLastArg(CmdArgs, options::OPT_twolevel__namespace);
  368. Args.AddLastArg(CmdArgs, options::OPT_twolevel__namespace__hints);
  369. Args.AddAllArgs(CmdArgs, options::OPT_umbrella);
  370. Args.AddAllArgs(CmdArgs, options::OPT_undefined);
  371. Args.AddAllArgs(CmdArgs, options::OPT_unexported__symbols__list);
  372. Args.AddAllArgs(CmdArgs, options::OPT_weak__reference__mismatches);
  373. Args.AddLastArg(CmdArgs, options::OPT_X_Flag);
  374. Args.AddAllArgs(CmdArgs, options::OPT_y);
  375. Args.AddLastArg(CmdArgs, options::OPT_w);
  376. Args.AddAllArgs(CmdArgs, options::OPT_pagezero__size);
  377. Args.AddAllArgs(CmdArgs, options::OPT_segs__read__);
  378. Args.AddLastArg(CmdArgs, options::OPT_seglinkedit);
  379. Args.AddLastArg(CmdArgs, options::OPT_noseglinkedit);
  380. Args.AddAllArgs(CmdArgs, options::OPT_sectalign);
  381. Args.AddAllArgs(CmdArgs, options::OPT_sectobjectsymbols);
  382. Args.AddAllArgs(CmdArgs, options::OPT_segcreate);
  383. Args.AddLastArg(CmdArgs, options::OPT_why_load);
  384. Args.AddLastArg(CmdArgs, options::OPT_whatsloaded);
  385. Args.AddAllArgs(CmdArgs, options::OPT_dylinker__install__name);
  386. Args.AddLastArg(CmdArgs, options::OPT_dylinker);
  387. Args.AddLastArg(CmdArgs, options::OPT_Mach);
  388. }
  389. /// Determine whether we are linking the ObjC runtime.
  390. static bool isObjCRuntimeLinked(const ArgList &Args) {
  391. if (isObjCAutoRefCount(Args)) {
  392. Args.ClaimAllArgs(options::OPT_fobjc_link_runtime);
  393. return true;
  394. }
  395. return Args.hasArg(options::OPT_fobjc_link_runtime);
  396. }
  397. static bool checkRemarksOptions(const Driver &D, const ArgList &Args,
  398. const llvm::Triple &Triple) {
  399. // When enabling remarks, we need to error if:
  400. // * The remark file is specified but we're targeting multiple architectures,
  401. // which means more than one remark file is being generated.
  402. bool hasMultipleInvocations =
  403. Args.getAllArgValues(options::OPT_arch).size() > 1;
  404. bool hasExplicitOutputFile =
  405. Args.getLastArg(options::OPT_foptimization_record_file_EQ);
  406. if (hasMultipleInvocations && hasExplicitOutputFile) {
  407. D.Diag(diag::err_drv_invalid_output_with_multiple_archs)
  408. << "-foptimization-record-file";
  409. return false;
  410. }
  411. return true;
  412. }
  413. static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
  414. const llvm::Triple &Triple,
  415. const InputInfo &Output, const JobAction &JA) {
  416. StringRef Format = "yaml";
  417. if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
  418. Format = A->getValue();
  419. CmdArgs.push_back("-mllvm");
  420. CmdArgs.push_back("-lto-pass-remarks-output");
  421. CmdArgs.push_back("-mllvm");
  422. const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
  423. if (A) {
  424. CmdArgs.push_back(A->getValue());
  425. } else {
  426. assert(Output.isFilename() && "Unexpected ld output.");
  427. SmallString<128> F;
  428. F = Output.getFilename();
  429. F += ".opt.";
  430. F += Format;
  431. CmdArgs.push_back(Args.MakeArgString(F));
  432. }
  433. if (const Arg *A =
  434. Args.getLastArg(options::OPT_foptimization_record_passes_EQ)) {
  435. CmdArgs.push_back("-mllvm");
  436. std::string Passes =
  437. std::string("-lto-pass-remarks-filter=") + A->getValue();
  438. CmdArgs.push_back(Args.MakeArgString(Passes));
  439. }
  440. if (!Format.empty()) {
  441. CmdArgs.push_back("-mllvm");
  442. Twine FormatArg = Twine("-lto-pass-remarks-format=") + Format;
  443. CmdArgs.push_back(Args.MakeArgString(FormatArg));
  444. }
  445. if (getLastProfileUseArg(Args)) {
  446. CmdArgs.push_back("-mllvm");
  447. CmdArgs.push_back("-lto-pass-remarks-with-hotness");
  448. if (const Arg *A =
  449. Args.getLastArg(options::OPT_fdiagnostics_hotness_threshold_EQ)) {
  450. CmdArgs.push_back("-mllvm");
  451. std::string Opt =
  452. std::string("-lto-pass-remarks-hotness-threshold=") + A->getValue();
  453. CmdArgs.push_back(Args.MakeArgString(Opt));
  454. }
  455. }
  456. }
  457. static void AppendPlatformPrefix(SmallString<128> &Path, const llvm::Triple &T);
  458. void darwin::Linker::ConstructJob(Compilation &C, const JobAction &JA,
  459. const InputInfo &Output,
  460. const InputInfoList &Inputs,
  461. const ArgList &Args,
  462. const char *LinkingOutput) const {
  463. assert(Output.getType() == types::TY_Image && "Invalid linker output type.");
  464. // If the number of arguments surpasses the system limits, we will encode the
  465. // input files in a separate file, shortening the command line. To this end,
  466. // build a list of input file names that can be passed via a file with the
  467. // -filelist linker option.
  468. llvm::opt::ArgStringList InputFileList;
  469. // The logic here is derived from gcc's behavior; most of which
  470. // comes from specs (starting with link_command). Consult gcc for
  471. // more information.
  472. ArgStringList CmdArgs;
  473. /// Hack(tm) to ignore linking errors when we are doing ARC migration.
  474. if (Args.hasArg(options::OPT_ccc_arcmt_check,
  475. options::OPT_ccc_arcmt_migrate)) {
  476. for (const auto &Arg : Args)
  477. Arg->claim();
  478. const char *Exec =
  479. Args.MakeArgString(getToolChain().GetProgramPath("touch"));
  480. CmdArgs.push_back(Output.getFilename());
  481. C.addCommand(std::make_unique<Command>(JA, *this,
  482. ResponseFileSupport::None(), Exec,
  483. CmdArgs, std::nullopt, Output));
  484. return;
  485. }
  486. VersionTuple Version = getMachOToolChain().getLinkerVersion(Args);
  487. bool LinkerIsLLD;
  488. const char *Exec =
  489. Args.MakeArgString(getToolChain().GetLinkerPath(&LinkerIsLLD));
  490. // I'm not sure why this particular decomposition exists in gcc, but
  491. // we follow suite for ease of comparison.
  492. AddLinkArgs(C, Args, CmdArgs, Inputs, Version, LinkerIsLLD);
  493. if (willEmitRemarks(Args) &&
  494. checkRemarksOptions(getToolChain().getDriver(), Args,
  495. getToolChain().getTriple()))
  496. renderRemarksOptions(Args, CmdArgs, getToolChain().getTriple(), Output, JA);
  497. // Propagate the -moutline flag to the linker in LTO.
  498. if (Arg *A =
  499. Args.getLastArg(options::OPT_moutline, options::OPT_mno_outline)) {
  500. if (A->getOption().matches(options::OPT_moutline)) {
  501. if (getMachOToolChain().getMachOArchName(Args) == "arm64") {
  502. CmdArgs.push_back("-mllvm");
  503. CmdArgs.push_back("-enable-machine-outliner");
  504. // Outline from linkonceodr functions by default in LTO.
  505. CmdArgs.push_back("-mllvm");
  506. CmdArgs.push_back("-enable-linkonceodr-outlining");
  507. }
  508. } else {
  509. // Disable all outlining behaviour if we have mno-outline. We need to do
  510. // this explicitly, because targets which support default outlining will
  511. // try to do work if we don't.
  512. CmdArgs.push_back("-mllvm");
  513. CmdArgs.push_back("-enable-machine-outliner=never");
  514. }
  515. }
  516. // Setup statistics file output.
  517. SmallString<128> StatsFile =
  518. getStatsFileName(Args, Output, Inputs[0], getToolChain().getDriver());
  519. if (!StatsFile.empty()) {
  520. CmdArgs.push_back("-mllvm");
  521. CmdArgs.push_back(Args.MakeArgString("-lto-stats-file=" + StatsFile.str()));
  522. }
  523. // It seems that the 'e' option is completely ignored for dynamic executables
  524. // (the default), and with static executables, the last one wins, as expected.
  525. Args.AddAllArgs(CmdArgs, {options::OPT_d_Flag, options::OPT_s, options::OPT_t,
  526. options::OPT_Z_Flag, options::OPT_u_Group,
  527. options::OPT_e, options::OPT_r});
  528. // Forward -ObjC when either -ObjC or -ObjC++ is used, to force loading
  529. // members of static archive libraries which implement Objective-C classes or
  530. // categories.
  531. if (Args.hasArg(options::OPT_ObjC) || Args.hasArg(options::OPT_ObjCXX))
  532. CmdArgs.push_back("-ObjC");
  533. CmdArgs.push_back("-o");
  534. CmdArgs.push_back(Output.getFilename());
  535. if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles))
  536. getMachOToolChain().addStartObjectFileArgs(Args, CmdArgs);
  537. Args.AddAllArgs(CmdArgs, options::OPT_L);
  538. AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
  539. // Build the input file for -filelist (list of linker input files) in case we
  540. // need it later
  541. for (const auto &II : Inputs) {
  542. if (!II.isFilename()) {
  543. // This is a linker input argument.
  544. // We cannot mix input arguments and file names in a -filelist input, thus
  545. // we prematurely stop our list (remaining files shall be passed as
  546. // arguments).
  547. if (InputFileList.size() > 0)
  548. break;
  549. continue;
  550. }
  551. InputFileList.push_back(II.getFilename());
  552. }
  553. // Additional linker set-up and flags for Fortran. This is required in order
  554. // to generate executables.
  555. if (getToolChain().getDriver().IsFlangMode()) {
  556. addFortranRuntimeLibraryPath(getToolChain(), Args, CmdArgs);
  557. addFortranRuntimeLibs(getToolChain(), CmdArgs);
  558. }
  559. if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs))
  560. addOpenMPRuntime(CmdArgs, getToolChain(), Args);
  561. if (isObjCRuntimeLinked(Args) &&
  562. !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
  563. // We use arclite library for both ARC and subscripting support.
  564. getMachOToolChain().AddLinkARCArgs(Args, CmdArgs);
  565. CmdArgs.push_back("-framework");
  566. CmdArgs.push_back("Foundation");
  567. // Link libobj.
  568. CmdArgs.push_back("-lobjc");
  569. }
  570. if (LinkingOutput) {
  571. CmdArgs.push_back("-arch_multiple");
  572. CmdArgs.push_back("-final_output");
  573. CmdArgs.push_back(LinkingOutput);
  574. }
  575. if (Args.hasArg(options::OPT_fnested_functions))
  576. CmdArgs.push_back("-allow_stack_execute");
  577. getMachOToolChain().addProfileRTLibs(Args, CmdArgs);
  578. StringRef Parallelism = getLTOParallelism(Args, getToolChain().getDriver());
  579. if (!Parallelism.empty()) {
  580. CmdArgs.push_back("-mllvm");
  581. unsigned NumThreads =
  582. llvm::get_threadpool_strategy(Parallelism)->compute_thread_count();
  583. CmdArgs.push_back(Args.MakeArgString("-threads=" + Twine(NumThreads)));
  584. }
  585. if (getToolChain().ShouldLinkCXXStdlib(Args))
  586. getToolChain().AddCXXStdlibLibArgs(Args, CmdArgs);
  587. bool NoStdOrDefaultLibs =
  588. Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs);
  589. bool ForceLinkBuiltins = Args.hasArg(options::OPT_fapple_link_rtlib);
  590. if (!NoStdOrDefaultLibs || ForceLinkBuiltins) {
  591. // link_ssp spec is empty.
  592. // If we have both -nostdlib/nodefaultlibs and -fapple-link-rtlib then
  593. // we just want to link the builtins, not the other libs like libSystem.
  594. if (NoStdOrDefaultLibs && ForceLinkBuiltins) {
  595. getMachOToolChain().AddLinkRuntimeLib(Args, CmdArgs, "builtins");
  596. } else {
  597. // Let the tool chain choose which runtime library to link.
  598. getMachOToolChain().AddLinkRuntimeLibArgs(Args, CmdArgs,
  599. ForceLinkBuiltins);
  600. // No need to do anything for pthreads. Claim argument to avoid warning.
  601. Args.ClaimAllArgs(options::OPT_pthread);
  602. Args.ClaimAllArgs(options::OPT_pthreads);
  603. }
  604. }
  605. if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
  606. // endfile_spec is empty.
  607. }
  608. Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
  609. Args.AddAllArgs(CmdArgs, options::OPT_F);
  610. // -iframework should be forwarded as -F.
  611. for (const Arg *A : Args.filtered(options::OPT_iframework))
  612. CmdArgs.push_back(Args.MakeArgString(std::string("-F") + A->getValue()));
  613. if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
  614. if (Arg *A = Args.getLastArg(options::OPT_fveclib)) {
  615. if (A->getValue() == StringRef("Accelerate")) {
  616. CmdArgs.push_back("-framework");
  617. CmdArgs.push_back("Accelerate");
  618. }
  619. }
  620. }
  621. // Add non-standard, platform-specific search paths, e.g., for DriverKit:
  622. // -L<sysroot>/System/DriverKit/usr/lib
  623. // -F<sysroot>/System/DriverKit/System/Library/Framework
  624. {
  625. bool NonStandardSearchPath = false;
  626. const auto &Triple = getToolChain().getTriple();
  627. if (Triple.isDriverKit()) {
  628. // ld64 fixed the implicit -F and -L paths in ld64-605.1+.
  629. NonStandardSearchPath =
  630. Version.getMajor() < 605 ||
  631. (Version.getMajor() == 605 && Version.getMinor().value_or(0) < 1);
  632. }
  633. if (NonStandardSearchPath) {
  634. if (auto *Sysroot = Args.getLastArg(options::OPT_isysroot)) {
  635. auto AddSearchPath = [&](StringRef Flag, StringRef SearchPath) {
  636. SmallString<128> P(Sysroot->getValue());
  637. AppendPlatformPrefix(P, Triple);
  638. llvm::sys::path::append(P, SearchPath);
  639. if (getToolChain().getVFS().exists(P)) {
  640. CmdArgs.push_back(Args.MakeArgString(Flag + P));
  641. }
  642. };
  643. AddSearchPath("-L", "/usr/lib");
  644. AddSearchPath("-F", "/System/Library/Frameworks");
  645. }
  646. }
  647. }
  648. ResponseFileSupport ResponseSupport;
  649. if (Version >= VersionTuple(705) || LinkerIsLLD) {
  650. ResponseSupport = ResponseFileSupport::AtFileUTF8();
  651. } else {
  652. // For older versions of the linker, use the legacy filelist method instead.
  653. ResponseSupport = {ResponseFileSupport::RF_FileList, llvm::sys::WEM_UTF8,
  654. "-filelist"};
  655. }
  656. std::unique_ptr<Command> Cmd = std::make_unique<Command>(
  657. JA, *this, ResponseSupport, Exec, CmdArgs, Inputs, Output);
  658. Cmd->setInputFileList(std::move(InputFileList));
  659. C.addCommand(std::move(Cmd));
  660. }
  661. void darwin::StaticLibTool::ConstructJob(Compilation &C, const JobAction &JA,
  662. const InputInfo &Output,
  663. const InputInfoList &Inputs,
  664. const ArgList &Args,
  665. const char *LinkingOutput) const {
  666. const Driver &D = getToolChain().getDriver();
  667. // Silence warning for "clang -g foo.o -o foo"
  668. Args.ClaimAllArgs(options::OPT_g_Group);
  669. // and "clang -emit-llvm foo.o -o foo"
  670. Args.ClaimAllArgs(options::OPT_emit_llvm);
  671. // and for "clang -w foo.o -o foo". Other warning options are already
  672. // handled somewhere else.
  673. Args.ClaimAllArgs(options::OPT_w);
  674. // Silence warnings when linking C code with a C++ '-stdlib' argument.
  675. Args.ClaimAllArgs(options::OPT_stdlib_EQ);
  676. // libtool <options> <output_file> <input_files>
  677. ArgStringList CmdArgs;
  678. // Create and insert file members with a deterministic index.
  679. CmdArgs.push_back("-static");
  680. CmdArgs.push_back("-D");
  681. CmdArgs.push_back("-no_warning_for_no_symbols");
  682. CmdArgs.push_back("-o");
  683. CmdArgs.push_back(Output.getFilename());
  684. for (const auto &II : Inputs) {
  685. if (II.isFilename()) {
  686. CmdArgs.push_back(II.getFilename());
  687. }
  688. }
  689. // Delete old output archive file if it already exists before generating a new
  690. // archive file.
  691. const auto *OutputFileName = Output.getFilename();
  692. if (Output.isFilename() && llvm::sys::fs::exists(OutputFileName)) {
  693. if (std::error_code EC = llvm::sys::fs::remove(OutputFileName)) {
  694. D.Diag(diag::err_drv_unable_to_remove_file) << EC.message();
  695. return;
  696. }
  697. }
  698. const char *Exec = Args.MakeArgString(getToolChain().GetStaticLibToolPath());
  699. C.addCommand(std::make_unique<Command>(JA, *this,
  700. ResponseFileSupport::AtFileUTF8(),
  701. Exec, CmdArgs, Inputs, Output));
  702. }
  703. void darwin::Lipo::ConstructJob(Compilation &C, const JobAction &JA,
  704. const InputInfo &Output,
  705. const InputInfoList &Inputs,
  706. const ArgList &Args,
  707. const char *LinkingOutput) const {
  708. ArgStringList CmdArgs;
  709. CmdArgs.push_back("-create");
  710. assert(Output.isFilename() && "Unexpected lipo output.");
  711. CmdArgs.push_back("-output");
  712. CmdArgs.push_back(Output.getFilename());
  713. for (const auto &II : Inputs) {
  714. assert(II.isFilename() && "Unexpected lipo input.");
  715. CmdArgs.push_back(II.getFilename());
  716. }
  717. const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("lipo"));
  718. C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
  719. Exec, CmdArgs, Inputs, Output));
  720. }
  721. void darwin::Dsymutil::ConstructJob(Compilation &C, const JobAction &JA,
  722. const InputInfo &Output,
  723. const InputInfoList &Inputs,
  724. const ArgList &Args,
  725. const char *LinkingOutput) const {
  726. ArgStringList CmdArgs;
  727. CmdArgs.push_back("-o");
  728. CmdArgs.push_back(Output.getFilename());
  729. assert(Inputs.size() == 1 && "Unable to handle multiple inputs.");
  730. const InputInfo &Input = Inputs[0];
  731. assert(Input.isFilename() && "Unexpected dsymutil input.");
  732. CmdArgs.push_back(Input.getFilename());
  733. const char *Exec =
  734. Args.MakeArgString(getToolChain().GetProgramPath("dsymutil"));
  735. C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
  736. Exec, CmdArgs, Inputs, Output));
  737. }
  738. void darwin::VerifyDebug::ConstructJob(Compilation &C, const JobAction &JA,
  739. const InputInfo &Output,
  740. const InputInfoList &Inputs,
  741. const ArgList &Args,
  742. const char *LinkingOutput) const {
  743. ArgStringList CmdArgs;
  744. CmdArgs.push_back("--verify");
  745. CmdArgs.push_back("--debug-info");
  746. CmdArgs.push_back("--eh-frame");
  747. CmdArgs.push_back("--quiet");
  748. assert(Inputs.size() == 1 && "Unable to handle multiple inputs.");
  749. const InputInfo &Input = Inputs[0];
  750. assert(Input.isFilename() && "Unexpected verify input");
  751. // Grabbing the output of the earlier dsymutil run.
  752. CmdArgs.push_back(Input.getFilename());
  753. const char *Exec =
  754. Args.MakeArgString(getToolChain().GetProgramPath("dwarfdump"));
  755. C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
  756. Exec, CmdArgs, Inputs, Output));
  757. }
  758. MachO::MachO(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)
  759. : ToolChain(D, Triple, Args) {
  760. // We expect 'as', 'ld', etc. to be adjacent to our install dir.
  761. getProgramPaths().push_back(getDriver().getInstalledDir());
  762. if (getDriver().getInstalledDir() != getDriver().Dir)
  763. getProgramPaths().push_back(getDriver().Dir);
  764. }
  765. /// Darwin - Darwin tool chain for i386 and x86_64.
  766. Darwin::Darwin(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)
  767. : MachO(D, Triple, Args), TargetInitialized(false),
  768. CudaInstallation(D, Triple, Args), RocmInstallation(D, Triple, Args) {}
  769. types::ID MachO::LookupTypeForExtension(StringRef Ext) const {
  770. types::ID Ty = ToolChain::LookupTypeForExtension(Ext);
  771. // Darwin always preprocesses assembly files (unless -x is used explicitly).
  772. if (Ty == types::TY_PP_Asm)
  773. return types::TY_Asm;
  774. return Ty;
  775. }
  776. bool MachO::HasNativeLLVMSupport() const { return true; }
  777. ToolChain::CXXStdlibType Darwin::GetDefaultCXXStdlibType() const {
  778. // Always use libc++ by default
  779. return ToolChain::CST_Libcxx;
  780. }
  781. /// Darwin provides an ARC runtime starting in MacOS X 10.7 and iOS 5.0.
  782. ObjCRuntime Darwin::getDefaultObjCRuntime(bool isNonFragile) const {
  783. if (isTargetWatchOSBased())
  784. return ObjCRuntime(ObjCRuntime::WatchOS, TargetVersion);
  785. if (isTargetIOSBased())
  786. return ObjCRuntime(ObjCRuntime::iOS, TargetVersion);
  787. if (isNonFragile)
  788. return ObjCRuntime(ObjCRuntime::MacOSX, TargetVersion);
  789. return ObjCRuntime(ObjCRuntime::FragileMacOSX, TargetVersion);
  790. }
  791. /// Darwin provides a blocks runtime starting in MacOS X 10.6 and iOS 3.2.
  792. bool Darwin::hasBlocksRuntime() const {
  793. if (isTargetWatchOSBased() || isTargetDriverKit())
  794. return true;
  795. else if (isTargetIOSBased())
  796. return !isIPhoneOSVersionLT(3, 2);
  797. else {
  798. assert(isTargetMacOSBased() && "unexpected darwin target");
  799. return !isMacosxVersionLT(10, 6);
  800. }
  801. }
  802. void Darwin::AddCudaIncludeArgs(const ArgList &DriverArgs,
  803. ArgStringList &CC1Args) const {
  804. CudaInstallation.AddCudaIncludeArgs(DriverArgs, CC1Args);
  805. }
  806. void Darwin::AddHIPIncludeArgs(const ArgList &DriverArgs,
  807. ArgStringList &CC1Args) const {
  808. RocmInstallation.AddHIPIncludeArgs(DriverArgs, CC1Args);
  809. }
  810. // This is just a MachO name translation routine and there's no
  811. // way to join this into ARMTargetParser without breaking all
  812. // other assumptions. Maybe MachO should consider standardising
  813. // their nomenclature.
  814. static const char *ArmMachOArchName(StringRef Arch) {
  815. return llvm::StringSwitch<const char *>(Arch)
  816. .Case("armv6k", "armv6")
  817. .Case("armv6m", "armv6m")
  818. .Case("armv5tej", "armv5")
  819. .Case("xscale", "xscale")
  820. .Case("armv4t", "armv4t")
  821. .Case("armv7", "armv7")
  822. .Cases("armv7a", "armv7-a", "armv7")
  823. .Cases("armv7r", "armv7-r", "armv7")
  824. .Cases("armv7em", "armv7e-m", "armv7em")
  825. .Cases("armv7k", "armv7-k", "armv7k")
  826. .Cases("armv7m", "armv7-m", "armv7m")
  827. .Cases("armv7s", "armv7-s", "armv7s")
  828. .Default(nullptr);
  829. }
  830. static const char *ArmMachOArchNameCPU(StringRef CPU) {
  831. llvm::ARM::ArchKind ArchKind = llvm::ARM::parseCPUArch(CPU);
  832. if (ArchKind == llvm::ARM::ArchKind::INVALID)
  833. return nullptr;
  834. StringRef Arch = llvm::ARM::getArchName(ArchKind);
  835. // FIXME: Make sure this MachO triple mangling is really necessary.
  836. // ARMv5* normalises to ARMv5.
  837. if (Arch.startswith("armv5"))
  838. Arch = Arch.substr(0, 5);
  839. // ARMv6*, except ARMv6M, normalises to ARMv6.
  840. else if (Arch.startswith("armv6") && !Arch.endswith("6m"))
  841. Arch = Arch.substr(0, 5);
  842. // ARMv7A normalises to ARMv7.
  843. else if (Arch.endswith("v7a"))
  844. Arch = Arch.substr(0, 5);
  845. return Arch.data();
  846. }
  847. StringRef MachO::getMachOArchName(const ArgList &Args) const {
  848. switch (getTriple().getArch()) {
  849. default:
  850. return getDefaultUniversalArchName();
  851. case llvm::Triple::aarch64_32:
  852. return "arm64_32";
  853. case llvm::Triple::aarch64: {
  854. if (getTriple().isArm64e())
  855. return "arm64e";
  856. return "arm64";
  857. }
  858. case llvm::Triple::thumb:
  859. case llvm::Triple::arm:
  860. if (const Arg *A = Args.getLastArg(clang::driver::options::OPT_march_EQ))
  861. if (const char *Arch = ArmMachOArchName(A->getValue()))
  862. return Arch;
  863. if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
  864. if (const char *Arch = ArmMachOArchNameCPU(A->getValue()))
  865. return Arch;
  866. return "arm";
  867. }
  868. }
  869. VersionTuple MachO::getLinkerVersion(const llvm::opt::ArgList &Args) const {
  870. if (LinkerVersion) {
  871. #ifndef NDEBUG
  872. VersionTuple NewLinkerVersion;
  873. if (Arg *A = Args.getLastArg(options::OPT_mlinker_version_EQ))
  874. (void)NewLinkerVersion.tryParse(A->getValue());
  875. assert(NewLinkerVersion == LinkerVersion);
  876. #endif
  877. return *LinkerVersion;
  878. }
  879. VersionTuple NewLinkerVersion;
  880. if (Arg *A = Args.getLastArg(options::OPT_mlinker_version_EQ))
  881. if (NewLinkerVersion.tryParse(A->getValue()))
  882. getDriver().Diag(diag::err_drv_invalid_version_number)
  883. << A->getAsString(Args);
  884. LinkerVersion = NewLinkerVersion;
  885. return *LinkerVersion;
  886. }
  887. Darwin::~Darwin() {}
  888. MachO::~MachO() {}
  889. std::string Darwin::ComputeEffectiveClangTriple(const ArgList &Args,
  890. types::ID InputType) const {
  891. llvm::Triple Triple(ComputeLLVMTriple(Args, InputType));
  892. // If the target isn't initialized (e.g., an unknown Darwin platform, return
  893. // the default triple).
  894. if (!isTargetInitialized())
  895. return Triple.getTriple();
  896. SmallString<16> Str;
  897. if (isTargetWatchOSBased())
  898. Str += "watchos";
  899. else if (isTargetTvOSBased())
  900. Str += "tvos";
  901. else if (isTargetDriverKit())
  902. Str += "driverkit";
  903. else if (isTargetIOSBased() || isTargetMacCatalyst())
  904. Str += "ios";
  905. else
  906. Str += "macosx";
  907. Str += getTripleTargetVersion().getAsString();
  908. Triple.setOSName(Str);
  909. return Triple.getTriple();
  910. }
  911. Tool *MachO::getTool(Action::ActionClass AC) const {
  912. switch (AC) {
  913. case Action::LipoJobClass:
  914. if (!Lipo)
  915. Lipo.reset(new tools::darwin::Lipo(*this));
  916. return Lipo.get();
  917. case Action::DsymutilJobClass:
  918. if (!Dsymutil)
  919. Dsymutil.reset(new tools::darwin::Dsymutil(*this));
  920. return Dsymutil.get();
  921. case Action::VerifyDebugInfoJobClass:
  922. if (!VerifyDebug)
  923. VerifyDebug.reset(new tools::darwin::VerifyDebug(*this));
  924. return VerifyDebug.get();
  925. default:
  926. return ToolChain::getTool(AC);
  927. }
  928. }
  929. Tool *MachO::buildLinker() const { return new tools::darwin::Linker(*this); }
  930. Tool *MachO::buildStaticLibTool() const {
  931. return new tools::darwin::StaticLibTool(*this);
  932. }
  933. Tool *MachO::buildAssembler() const {
  934. return new tools::darwin::Assembler(*this);
  935. }
  936. DarwinClang::DarwinClang(const Driver &D, const llvm::Triple &Triple,
  937. const ArgList &Args)
  938. : Darwin(D, Triple, Args) {}
  939. void DarwinClang::addClangWarningOptions(ArgStringList &CC1Args) const {
  940. // Always error about undefined 'TARGET_OS_*' macros.
  941. CC1Args.push_back("-Wundef-prefix=TARGET_OS_");
  942. CC1Args.push_back("-Werror=undef-prefix");
  943. // For modern targets, promote certain warnings to errors.
  944. if (isTargetWatchOSBased() || getTriple().isArch64Bit()) {
  945. // Always enable -Wdeprecated-objc-isa-usage and promote it
  946. // to an error.
  947. CC1Args.push_back("-Wdeprecated-objc-isa-usage");
  948. CC1Args.push_back("-Werror=deprecated-objc-isa-usage");
  949. // For iOS and watchOS, also error about implicit function declarations,
  950. // as that can impact calling conventions.
  951. if (!isTargetMacOS())
  952. CC1Args.push_back("-Werror=implicit-function-declaration");
  953. }
  954. }
  955. /// Take a path that speculatively points into Xcode and return the
  956. /// `XCODE/Contents/Developer` path if it is an Xcode path, or an empty path
  957. /// otherwise.
  958. static StringRef getXcodeDeveloperPath(StringRef PathIntoXcode) {
  959. static constexpr llvm::StringLiteral XcodeAppSuffix(
  960. ".app/Contents/Developer");
  961. size_t Index = PathIntoXcode.find(XcodeAppSuffix);
  962. if (Index == StringRef::npos)
  963. return "";
  964. return PathIntoXcode.take_front(Index + XcodeAppSuffix.size());
  965. }
  966. void DarwinClang::AddLinkARCArgs(const ArgList &Args,
  967. ArgStringList &CmdArgs) const {
  968. // Avoid linking compatibility stubs on i386 mac.
  969. if (isTargetMacOSBased() && getArch() == llvm::Triple::x86)
  970. return;
  971. if (isTargetAppleSiliconMac())
  972. return;
  973. // ARC runtime is supported everywhere on arm64e.
  974. if (getTriple().isArm64e())
  975. return;
  976. ObjCRuntime runtime = getDefaultObjCRuntime(/*nonfragile*/ true);
  977. if ((runtime.hasNativeARC() || !isObjCAutoRefCount(Args)) &&
  978. runtime.hasSubscripting())
  979. return;
  980. SmallString<128> P(getDriver().ClangExecutable);
  981. llvm::sys::path::remove_filename(P); // 'clang'
  982. llvm::sys::path::remove_filename(P); // 'bin'
  983. llvm::sys::path::append(P, "lib", "arc");
  984. // 'libarclite' usually lives in the same toolchain as 'clang'. However, the
  985. // Swift open source toolchains for macOS distribute Clang without libarclite.
  986. // In that case, to allow the linker to find 'libarclite', we point to the
  987. // 'libarclite' in the XcodeDefault toolchain instead.
  988. if (!getVFS().exists(P)) {
  989. auto updatePath = [&](const Arg *A) {
  990. // Try to infer the path to 'libarclite' in the toolchain from the
  991. // specified SDK path.
  992. StringRef XcodePathForSDK = getXcodeDeveloperPath(A->getValue());
  993. if (XcodePathForSDK.empty())
  994. return false;
  995. P = XcodePathForSDK;
  996. llvm::sys::path::append(P, "Toolchains/XcodeDefault.xctoolchain/usr",
  997. "lib", "arc");
  998. return getVFS().exists(P);
  999. };
  1000. bool updated = false;
  1001. if (const Arg *A = Args.getLastArg(options::OPT_isysroot))
  1002. updated = updatePath(A);
  1003. if (!updated) {
  1004. if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
  1005. updatePath(A);
  1006. }
  1007. }
  1008. CmdArgs.push_back("-force_load");
  1009. llvm::sys::path::append(P, "libarclite_");
  1010. // Mash in the platform.
  1011. if (isTargetWatchOSSimulator())
  1012. P += "watchsimulator";
  1013. else if (isTargetWatchOS())
  1014. P += "watchos";
  1015. else if (isTargetTvOSSimulator())
  1016. P += "appletvsimulator";
  1017. else if (isTargetTvOS())
  1018. P += "appletvos";
  1019. else if (isTargetIOSSimulator())
  1020. P += "iphonesimulator";
  1021. else if (isTargetIPhoneOS())
  1022. P += "iphoneos";
  1023. else
  1024. P += "macosx";
  1025. P += ".a";
  1026. CmdArgs.push_back(Args.MakeArgString(P));
  1027. }
  1028. unsigned DarwinClang::GetDefaultDwarfVersion() const {
  1029. // Default to use DWARF 2 on OS X 10.10 / iOS 8 and lower.
  1030. if ((isTargetMacOSBased() && isMacosxVersionLT(10, 11)) ||
  1031. (isTargetIOSBased() && isIPhoneOSVersionLT(9)))
  1032. return 2;
  1033. return 4;
  1034. }
  1035. void MachO::AddLinkRuntimeLib(const ArgList &Args, ArgStringList &CmdArgs,
  1036. StringRef Component, RuntimeLinkOptions Opts,
  1037. bool IsShared) const {
  1038. SmallString<64> DarwinLibName = StringRef("libclang_rt.");
  1039. // an Darwin the builtins compomnent is not in the library name
  1040. if (Component != "builtins") {
  1041. DarwinLibName += Component;
  1042. if (!(Opts & RLO_IsEmbedded))
  1043. DarwinLibName += "_";
  1044. }
  1045. DarwinLibName += getOSLibraryNameSuffix();
  1046. DarwinLibName += IsShared ? "_dynamic.dylib" : ".a";
  1047. SmallString<128> Dir(getDriver().ResourceDir);
  1048. llvm::sys::path::append(Dir, "lib", "darwin");
  1049. if (Opts & RLO_IsEmbedded)
  1050. llvm::sys::path::append(Dir, "macho_embedded");
  1051. SmallString<128> P(Dir);
  1052. llvm::sys::path::append(P, DarwinLibName);
  1053. // For now, allow missing resource libraries to support developers who may
  1054. // not have compiler-rt checked out or integrated into their build (unless
  1055. // we explicitly force linking with this library).
  1056. if ((Opts & RLO_AlwaysLink) || getVFS().exists(P)) {
  1057. const char *LibArg = Args.MakeArgString(P);
  1058. CmdArgs.push_back(LibArg);
  1059. }
  1060. // Adding the rpaths might negatively interact when other rpaths are involved,
  1061. // so we should make sure we add the rpaths last, after all user-specified
  1062. // rpaths. This is currently true from this place, but we need to be
  1063. // careful if this function is ever called before user's rpaths are emitted.
  1064. if (Opts & RLO_AddRPath) {
  1065. assert(DarwinLibName.endswith(".dylib") && "must be a dynamic library");
  1066. // Add @executable_path to rpath to support having the dylib copied with
  1067. // the executable.
  1068. CmdArgs.push_back("-rpath");
  1069. CmdArgs.push_back("@executable_path");
  1070. // Add the path to the resource dir to rpath to support using the dylib
  1071. // from the default location without copying.
  1072. CmdArgs.push_back("-rpath");
  1073. CmdArgs.push_back(Args.MakeArgString(Dir));
  1074. }
  1075. }
  1076. StringRef Darwin::getPlatformFamily() const {
  1077. switch (TargetPlatform) {
  1078. case DarwinPlatformKind::MacOS:
  1079. return "MacOSX";
  1080. case DarwinPlatformKind::IPhoneOS:
  1081. if (TargetEnvironment == MacCatalyst)
  1082. return "MacOSX";
  1083. return "iPhone";
  1084. case DarwinPlatformKind::TvOS:
  1085. return "AppleTV";
  1086. case DarwinPlatformKind::WatchOS:
  1087. return "Watch";
  1088. case DarwinPlatformKind::DriverKit:
  1089. return "DriverKit";
  1090. }
  1091. llvm_unreachable("Unsupported platform");
  1092. }
  1093. StringRef Darwin::getSDKName(StringRef isysroot) {
  1094. // Assume SDK has path: SOME_PATH/SDKs/PlatformXX.YY.sdk
  1095. auto BeginSDK = llvm::sys::path::rbegin(isysroot);
  1096. auto EndSDK = llvm::sys::path::rend(isysroot);
  1097. for (auto IT = BeginSDK; IT != EndSDK; ++IT) {
  1098. StringRef SDK = *IT;
  1099. if (SDK.endswith(".sdk"))
  1100. return SDK.slice(0, SDK.size() - 4);
  1101. }
  1102. return "";
  1103. }
  1104. StringRef Darwin::getOSLibraryNameSuffix(bool IgnoreSim) const {
  1105. switch (TargetPlatform) {
  1106. case DarwinPlatformKind::MacOS:
  1107. return "osx";
  1108. case DarwinPlatformKind::IPhoneOS:
  1109. if (TargetEnvironment == MacCatalyst)
  1110. return "osx";
  1111. return TargetEnvironment == NativeEnvironment || IgnoreSim ? "ios"
  1112. : "iossim";
  1113. case DarwinPlatformKind::TvOS:
  1114. return TargetEnvironment == NativeEnvironment || IgnoreSim ? "tvos"
  1115. : "tvossim";
  1116. case DarwinPlatformKind::WatchOS:
  1117. return TargetEnvironment == NativeEnvironment || IgnoreSim ? "watchos"
  1118. : "watchossim";
  1119. case DarwinPlatformKind::DriverKit:
  1120. return "driverkit";
  1121. }
  1122. llvm_unreachable("Unsupported platform");
  1123. }
  1124. /// Check if the link command contains a symbol export directive.
  1125. static bool hasExportSymbolDirective(const ArgList &Args) {
  1126. for (Arg *A : Args) {
  1127. if (A->getOption().matches(options::OPT_exported__symbols__list))
  1128. return true;
  1129. if (!A->getOption().matches(options::OPT_Wl_COMMA) &&
  1130. !A->getOption().matches(options::OPT_Xlinker))
  1131. continue;
  1132. if (A->containsValue("-exported_symbols_list") ||
  1133. A->containsValue("-exported_symbol"))
  1134. return true;
  1135. }
  1136. return false;
  1137. }
  1138. /// Add an export directive for \p Symbol to the link command.
  1139. static void addExportedSymbol(ArgStringList &CmdArgs, const char *Symbol) {
  1140. CmdArgs.push_back("-exported_symbol");
  1141. CmdArgs.push_back(Symbol);
  1142. }
  1143. /// Add a sectalign directive for \p Segment and \p Section to the maximum
  1144. /// expected page size for Darwin.
  1145. ///
  1146. /// On iPhone 6+ the max supported page size is 16K. On macOS, the max is 4K.
  1147. /// Use a common alignment constant (16K) for now, and reduce the alignment on
  1148. /// macOS if it proves important.
  1149. static void addSectalignToPage(const ArgList &Args, ArgStringList &CmdArgs,
  1150. StringRef Segment, StringRef Section) {
  1151. for (const char *A : {"-sectalign", Args.MakeArgString(Segment),
  1152. Args.MakeArgString(Section), "0x4000"})
  1153. CmdArgs.push_back(A);
  1154. }
  1155. void Darwin::addProfileRTLibs(const ArgList &Args,
  1156. ArgStringList &CmdArgs) const {
  1157. if (!needsProfileRT(Args) && !needsGCovInstrumentation(Args))
  1158. return;
  1159. AddLinkRuntimeLib(Args, CmdArgs, "profile",
  1160. RuntimeLinkOptions(RLO_AlwaysLink));
  1161. bool ForGCOV = needsGCovInstrumentation(Args);
  1162. // If we have a symbol export directive and we're linking in the profile
  1163. // runtime, automatically export symbols necessary to implement some of the
  1164. // runtime's functionality.
  1165. if (hasExportSymbolDirective(Args) && ForGCOV) {
  1166. addExportedSymbol(CmdArgs, "___gcov_dump");
  1167. addExportedSymbol(CmdArgs, "___gcov_reset");
  1168. addExportedSymbol(CmdArgs, "_writeout_fn_list");
  1169. addExportedSymbol(CmdArgs, "_reset_fn_list");
  1170. }
  1171. // Align __llvm_prf_{cnts,data} sections to the maximum expected page
  1172. // alignment. This allows profile counters to be mmap()'d to disk. Note that
  1173. // it's not enough to just page-align __llvm_prf_cnts: the following section
  1174. // must also be page-aligned so that its data is not clobbered by mmap().
  1175. //
  1176. // The section alignment is only needed when continuous profile sync is
  1177. // enabled, but this is expected to be the default in Xcode. Specifying the
  1178. // extra alignment also allows the same binary to be used with/without sync
  1179. // enabled.
  1180. if (!ForGCOV) {
  1181. for (auto IPSK : {llvm::IPSK_cnts, llvm::IPSK_data}) {
  1182. addSectalignToPage(
  1183. Args, CmdArgs, "__DATA",
  1184. llvm::getInstrProfSectionName(IPSK, llvm::Triple::MachO,
  1185. /*AddSegmentInfo=*/false));
  1186. }
  1187. }
  1188. }
  1189. void DarwinClang::AddLinkSanitizerLibArgs(const ArgList &Args,
  1190. ArgStringList &CmdArgs,
  1191. StringRef Sanitizer,
  1192. bool Shared) const {
  1193. auto RLO = RuntimeLinkOptions(RLO_AlwaysLink | (Shared ? RLO_AddRPath : 0U));
  1194. AddLinkRuntimeLib(Args, CmdArgs, Sanitizer, RLO, Shared);
  1195. }
  1196. ToolChain::RuntimeLibType DarwinClang::GetRuntimeLibType(
  1197. const ArgList &Args) const {
  1198. if (Arg* A = Args.getLastArg(options::OPT_rtlib_EQ)) {
  1199. StringRef Value = A->getValue();
  1200. if (Value != "compiler-rt" && Value != "platform")
  1201. getDriver().Diag(clang::diag::err_drv_unsupported_rtlib_for_platform)
  1202. << Value << "darwin";
  1203. }
  1204. return ToolChain::RLT_CompilerRT;
  1205. }
  1206. void DarwinClang::AddLinkRuntimeLibArgs(const ArgList &Args,
  1207. ArgStringList &CmdArgs,
  1208. bool ForceLinkBuiltinRT) const {
  1209. // Call once to ensure diagnostic is printed if wrong value was specified
  1210. GetRuntimeLibType(Args);
  1211. // Darwin doesn't support real static executables, don't link any runtime
  1212. // libraries with -static.
  1213. if (Args.hasArg(options::OPT_static) ||
  1214. Args.hasArg(options::OPT_fapple_kext) ||
  1215. Args.hasArg(options::OPT_mkernel)) {
  1216. if (ForceLinkBuiltinRT)
  1217. AddLinkRuntimeLib(Args, CmdArgs, "builtins");
  1218. return;
  1219. }
  1220. // Reject -static-libgcc for now, we can deal with this when and if someone
  1221. // cares. This is useful in situations where someone wants to statically link
  1222. // something like libstdc++, and needs its runtime support routines.
  1223. if (const Arg *A = Args.getLastArg(options::OPT_static_libgcc)) {
  1224. getDriver().Diag(diag::err_drv_unsupported_opt) << A->getAsString(Args);
  1225. return;
  1226. }
  1227. const SanitizerArgs &Sanitize = getSanitizerArgs(Args);
  1228. if (!Sanitize.needsSharedRt() && Sanitize.needsUbsanRt()) {
  1229. getDriver().Diag(diag::err_drv_unsupported_static_ubsan_darwin);
  1230. return;
  1231. }
  1232. if (Sanitize.linkRuntimes()) {
  1233. if (Sanitize.needsAsanRt())
  1234. AddLinkSanitizerLibArgs(Args, CmdArgs, "asan");
  1235. if (Sanitize.needsLsanRt())
  1236. AddLinkSanitizerLibArgs(Args, CmdArgs, "lsan");
  1237. if (Sanitize.needsUbsanRt()) {
  1238. assert(Sanitize.needsSharedRt() && "Static sanitizer runtimes not supported");
  1239. AddLinkSanitizerLibArgs(Args, CmdArgs,
  1240. Sanitize.requiresMinimalRuntime() ? "ubsan_minimal"
  1241. : "ubsan");
  1242. }
  1243. if (Sanitize.needsTsanRt())
  1244. AddLinkSanitizerLibArgs(Args, CmdArgs, "tsan");
  1245. if (Sanitize.needsFuzzer() && !Args.hasArg(options::OPT_dynamiclib)) {
  1246. AddLinkSanitizerLibArgs(Args, CmdArgs, "fuzzer", /*shared=*/false);
  1247. // Libfuzzer is written in C++ and requires libcxx.
  1248. AddCXXStdlibLibArgs(Args, CmdArgs);
  1249. }
  1250. if (Sanitize.needsStatsRt()) {
  1251. AddLinkRuntimeLib(Args, CmdArgs, "stats_client", RLO_AlwaysLink);
  1252. AddLinkSanitizerLibArgs(Args, CmdArgs, "stats");
  1253. }
  1254. }
  1255. const XRayArgs &XRay = getXRayArgs();
  1256. if (XRay.needsXRayRt()) {
  1257. AddLinkRuntimeLib(Args, CmdArgs, "xray");
  1258. AddLinkRuntimeLib(Args, CmdArgs, "xray-basic");
  1259. AddLinkRuntimeLib(Args, CmdArgs, "xray-fdr");
  1260. }
  1261. if (isTargetDriverKit() && !Args.hasArg(options::OPT_nodriverkitlib)) {
  1262. CmdArgs.push_back("-framework");
  1263. CmdArgs.push_back("DriverKit");
  1264. }
  1265. // Otherwise link libSystem, then the dynamic runtime library, and finally any
  1266. // target specific static runtime library.
  1267. if (!isTargetDriverKit())
  1268. CmdArgs.push_back("-lSystem");
  1269. // Select the dynamic runtime library and the target specific static library.
  1270. if (isTargetIOSBased()) {
  1271. // If we are compiling as iOS / simulator, don't attempt to link libgcc_s.1,
  1272. // it never went into the SDK.
  1273. // Linking against libgcc_s.1 isn't needed for iOS 5.0+
  1274. if (isIPhoneOSVersionLT(5, 0) && !isTargetIOSSimulator() &&
  1275. getTriple().getArch() != llvm::Triple::aarch64)
  1276. CmdArgs.push_back("-lgcc_s.1");
  1277. }
  1278. AddLinkRuntimeLib(Args, CmdArgs, "builtins");
  1279. }
  1280. /// Returns the most appropriate macOS target version for the current process.
  1281. ///
  1282. /// If the macOS SDK version is the same or earlier than the system version,
  1283. /// then the SDK version is returned. Otherwise the system version is returned.
  1284. static std::string getSystemOrSDKMacOSVersion(StringRef MacOSSDKVersion) {
  1285. llvm::Triple SystemTriple(llvm::sys::getProcessTriple());
  1286. if (!SystemTriple.isMacOSX())
  1287. return std::string(MacOSSDKVersion);
  1288. VersionTuple SystemVersion;
  1289. SystemTriple.getMacOSXVersion(SystemVersion);
  1290. unsigned Major, Minor, Micro;
  1291. bool HadExtra;
  1292. if (!Driver::GetReleaseVersion(MacOSSDKVersion, Major, Minor, Micro,
  1293. HadExtra))
  1294. return std::string(MacOSSDKVersion);
  1295. VersionTuple SDKVersion(Major, Minor, Micro);
  1296. if (SDKVersion > SystemVersion)
  1297. return SystemVersion.getAsString();
  1298. return std::string(MacOSSDKVersion);
  1299. }
  1300. namespace {
  1301. /// The Darwin OS that was selected or inferred from arguments / environment.
  1302. struct DarwinPlatform {
  1303. enum SourceKind {
  1304. /// The OS was specified using the -target argument.
  1305. TargetArg,
  1306. /// The OS was specified using the -mtargetos= argument.
  1307. MTargetOSArg,
  1308. /// The OS was specified using the -m<os>-version-min argument.
  1309. OSVersionArg,
  1310. /// The OS was specified using the OS_DEPLOYMENT_TARGET environment.
  1311. DeploymentTargetEnv,
  1312. /// The OS was inferred from the SDK.
  1313. InferredFromSDK,
  1314. /// The OS was inferred from the -arch.
  1315. InferredFromArch
  1316. };
  1317. using DarwinPlatformKind = Darwin::DarwinPlatformKind;
  1318. using DarwinEnvironmentKind = Darwin::DarwinEnvironmentKind;
  1319. DarwinPlatformKind getPlatform() const { return Platform; }
  1320. DarwinEnvironmentKind getEnvironment() const { return Environment; }
  1321. void setEnvironment(DarwinEnvironmentKind Kind) {
  1322. Environment = Kind;
  1323. InferSimulatorFromArch = false;
  1324. }
  1325. StringRef getOSVersion() const {
  1326. if (Kind == OSVersionArg)
  1327. return Argument->getValue();
  1328. return OSVersion;
  1329. }
  1330. void setOSVersion(StringRef S) {
  1331. assert(Kind == TargetArg && "Unexpected kind!");
  1332. OSVersion = std::string(S);
  1333. }
  1334. bool hasOSVersion() const { return HasOSVersion; }
  1335. VersionTuple getNativeTargetVersion() const {
  1336. assert(Environment == DarwinEnvironmentKind::MacCatalyst &&
  1337. "native target version is specified only for Mac Catalyst");
  1338. return NativeTargetVersion;
  1339. }
  1340. /// Returns true if the target OS was explicitly specified.
  1341. bool isExplicitlySpecified() const { return Kind <= DeploymentTargetEnv; }
  1342. /// Returns true if the simulator environment can be inferred from the arch.
  1343. bool canInferSimulatorFromArch() const { return InferSimulatorFromArch; }
  1344. const std::optional<llvm::Triple> &getTargetVariantTriple() const {
  1345. return TargetVariantTriple;
  1346. }
  1347. /// Adds the -m<os>-version-min argument to the compiler invocation.
  1348. void addOSVersionMinArgument(DerivedArgList &Args, const OptTable &Opts) {
  1349. if (Argument)
  1350. return;
  1351. assert(Kind != TargetArg && Kind != MTargetOSArg && Kind != OSVersionArg &&
  1352. "Invalid kind");
  1353. options::ID Opt;
  1354. switch (Platform) {
  1355. case DarwinPlatformKind::MacOS:
  1356. Opt = options::OPT_mmacos_version_min_EQ;
  1357. break;
  1358. case DarwinPlatformKind::IPhoneOS:
  1359. Opt = options::OPT_mios_version_min_EQ;
  1360. break;
  1361. case DarwinPlatformKind::TvOS:
  1362. Opt = options::OPT_mtvos_version_min_EQ;
  1363. break;
  1364. case DarwinPlatformKind::WatchOS:
  1365. Opt = options::OPT_mwatchos_version_min_EQ;
  1366. break;
  1367. case DarwinPlatformKind::DriverKit:
  1368. // DriverKit always explicitly provides a version in the triple.
  1369. return;
  1370. }
  1371. Argument = Args.MakeJoinedArg(nullptr, Opts.getOption(Opt), OSVersion);
  1372. Args.append(Argument);
  1373. }
  1374. /// Returns the OS version with the argument / environment variable that
  1375. /// specified it.
  1376. std::string getAsString(DerivedArgList &Args, const OptTable &Opts) {
  1377. switch (Kind) {
  1378. case TargetArg:
  1379. case MTargetOSArg:
  1380. case OSVersionArg:
  1381. case InferredFromSDK:
  1382. case InferredFromArch:
  1383. assert(Argument && "OS version argument not yet inferred");
  1384. return Argument->getAsString(Args);
  1385. case DeploymentTargetEnv:
  1386. return (llvm::Twine(EnvVarName) + "=" + OSVersion).str();
  1387. }
  1388. llvm_unreachable("Unsupported Darwin Source Kind");
  1389. }
  1390. void setEnvironment(llvm::Triple::EnvironmentType EnvType,
  1391. const VersionTuple &OSVersion,
  1392. const std::optional<DarwinSDKInfo> &SDKInfo) {
  1393. switch (EnvType) {
  1394. case llvm::Triple::Simulator:
  1395. Environment = DarwinEnvironmentKind::Simulator;
  1396. break;
  1397. case llvm::Triple::MacABI: {
  1398. Environment = DarwinEnvironmentKind::MacCatalyst;
  1399. // The minimum native macOS target for MacCatalyst is macOS 10.15.
  1400. NativeTargetVersion = VersionTuple(10, 15);
  1401. if (HasOSVersion && SDKInfo) {
  1402. if (const auto *MacCatalystToMacOSMapping = SDKInfo->getVersionMapping(
  1403. DarwinSDKInfo::OSEnvPair::macCatalystToMacOSPair())) {
  1404. if (auto MacOSVersion = MacCatalystToMacOSMapping->map(
  1405. OSVersion, NativeTargetVersion, std::nullopt)) {
  1406. NativeTargetVersion = *MacOSVersion;
  1407. }
  1408. }
  1409. }
  1410. // In a zippered build, we could be building for a macOS target that's
  1411. // lower than the version that's implied by the OS version. In that case
  1412. // we need to use the minimum version as the native target version.
  1413. if (TargetVariantTriple) {
  1414. auto TargetVariantVersion = TargetVariantTriple->getOSVersion();
  1415. if (TargetVariantVersion.getMajor()) {
  1416. if (TargetVariantVersion < NativeTargetVersion)
  1417. NativeTargetVersion = TargetVariantVersion;
  1418. }
  1419. }
  1420. break;
  1421. }
  1422. default:
  1423. break;
  1424. }
  1425. }
  1426. static DarwinPlatform
  1427. createFromTarget(const llvm::Triple &TT, StringRef OSVersion, Arg *A,
  1428. std::optional<llvm::Triple> TargetVariantTriple,
  1429. const std::optional<DarwinSDKInfo> &SDKInfo) {
  1430. DarwinPlatform Result(TargetArg, getPlatformFromOS(TT.getOS()), OSVersion,
  1431. A);
  1432. VersionTuple OsVersion = TT.getOSVersion();
  1433. if (OsVersion.getMajor() == 0)
  1434. Result.HasOSVersion = false;
  1435. Result.TargetVariantTriple = TargetVariantTriple;
  1436. Result.setEnvironment(TT.getEnvironment(), OsVersion, SDKInfo);
  1437. return Result;
  1438. }
  1439. static DarwinPlatform
  1440. createFromMTargetOS(llvm::Triple::OSType OS, VersionTuple OSVersion,
  1441. llvm::Triple::EnvironmentType Environment, Arg *A,
  1442. const std::optional<DarwinSDKInfo> &SDKInfo) {
  1443. DarwinPlatform Result(MTargetOSArg, getPlatformFromOS(OS),
  1444. OSVersion.getAsString(), A);
  1445. Result.InferSimulatorFromArch = false;
  1446. Result.setEnvironment(Environment, OSVersion, SDKInfo);
  1447. return Result;
  1448. }
  1449. static DarwinPlatform createOSVersionArg(DarwinPlatformKind Platform, Arg *A,
  1450. bool IsSimulator) {
  1451. DarwinPlatform Result{OSVersionArg, Platform, A};
  1452. if (IsSimulator)
  1453. Result.Environment = DarwinEnvironmentKind::Simulator;
  1454. return Result;
  1455. }
  1456. static DarwinPlatform createDeploymentTargetEnv(DarwinPlatformKind Platform,
  1457. StringRef EnvVarName,
  1458. StringRef Value) {
  1459. DarwinPlatform Result(DeploymentTargetEnv, Platform, Value);
  1460. Result.EnvVarName = EnvVarName;
  1461. return Result;
  1462. }
  1463. static DarwinPlatform createFromSDK(DarwinPlatformKind Platform,
  1464. StringRef Value,
  1465. bool IsSimulator = false) {
  1466. DarwinPlatform Result(InferredFromSDK, Platform, Value);
  1467. if (IsSimulator)
  1468. Result.Environment = DarwinEnvironmentKind::Simulator;
  1469. Result.InferSimulatorFromArch = false;
  1470. return Result;
  1471. }
  1472. static DarwinPlatform createFromArch(llvm::Triple::OSType OS,
  1473. StringRef Value) {
  1474. return DarwinPlatform(InferredFromArch, getPlatformFromOS(OS), Value);
  1475. }
  1476. /// Constructs an inferred SDKInfo value based on the version inferred from
  1477. /// the SDK path itself. Only works for values that were created by inferring
  1478. /// the platform from the SDKPath.
  1479. DarwinSDKInfo inferSDKInfo() {
  1480. assert(Kind == InferredFromSDK && "can infer SDK info only");
  1481. llvm::VersionTuple Version;
  1482. bool IsValid = !Version.tryParse(OSVersion);
  1483. (void)IsValid;
  1484. assert(IsValid && "invalid SDK version");
  1485. return DarwinSDKInfo(
  1486. Version,
  1487. /*MaximumDeploymentTarget=*/VersionTuple(Version.getMajor(), 0, 99));
  1488. }
  1489. private:
  1490. DarwinPlatform(SourceKind Kind, DarwinPlatformKind Platform, Arg *Argument)
  1491. : Kind(Kind), Platform(Platform), Argument(Argument) {}
  1492. DarwinPlatform(SourceKind Kind, DarwinPlatformKind Platform, StringRef Value,
  1493. Arg *Argument = nullptr)
  1494. : Kind(Kind), Platform(Platform), OSVersion(Value), Argument(Argument) {}
  1495. static DarwinPlatformKind getPlatformFromOS(llvm::Triple::OSType OS) {
  1496. switch (OS) {
  1497. case llvm::Triple::Darwin:
  1498. case llvm::Triple::MacOSX:
  1499. return DarwinPlatformKind::MacOS;
  1500. case llvm::Triple::IOS:
  1501. return DarwinPlatformKind::IPhoneOS;
  1502. case llvm::Triple::TvOS:
  1503. return DarwinPlatformKind::TvOS;
  1504. case llvm::Triple::WatchOS:
  1505. return DarwinPlatformKind::WatchOS;
  1506. case llvm::Triple::DriverKit:
  1507. return DarwinPlatformKind::DriverKit;
  1508. default:
  1509. llvm_unreachable("Unable to infer Darwin variant");
  1510. }
  1511. }
  1512. SourceKind Kind;
  1513. DarwinPlatformKind Platform;
  1514. DarwinEnvironmentKind Environment = DarwinEnvironmentKind::NativeEnvironment;
  1515. VersionTuple NativeTargetVersion;
  1516. std::string OSVersion;
  1517. bool HasOSVersion = true, InferSimulatorFromArch = true;
  1518. Arg *Argument;
  1519. StringRef EnvVarName;
  1520. std::optional<llvm::Triple> TargetVariantTriple;
  1521. };
  1522. /// Returns the deployment target that's specified using the -m<os>-version-min
  1523. /// argument.
  1524. std::optional<DarwinPlatform>
  1525. getDeploymentTargetFromOSVersionArg(DerivedArgList &Args,
  1526. const Driver &TheDriver) {
  1527. Arg *macOSVersion = Args.getLastArg(options::OPT_mmacos_version_min_EQ);
  1528. Arg *iOSVersion = Args.getLastArg(options::OPT_mios_version_min_EQ,
  1529. options::OPT_mios_simulator_version_min_EQ);
  1530. Arg *TvOSVersion =
  1531. Args.getLastArg(options::OPT_mtvos_version_min_EQ,
  1532. options::OPT_mtvos_simulator_version_min_EQ);
  1533. Arg *WatchOSVersion =
  1534. Args.getLastArg(options::OPT_mwatchos_version_min_EQ,
  1535. options::OPT_mwatchos_simulator_version_min_EQ);
  1536. if (macOSVersion) {
  1537. if (iOSVersion || TvOSVersion || WatchOSVersion) {
  1538. TheDriver.Diag(diag::err_drv_argument_not_allowed_with)
  1539. << macOSVersion->getAsString(Args)
  1540. << (iOSVersion ? iOSVersion
  1541. : TvOSVersion ? TvOSVersion : WatchOSVersion)
  1542. ->getAsString(Args);
  1543. }
  1544. return DarwinPlatform::createOSVersionArg(Darwin::MacOS, macOSVersion,
  1545. /*IsImulator=*/false);
  1546. } else if (iOSVersion) {
  1547. if (TvOSVersion || WatchOSVersion) {
  1548. TheDriver.Diag(diag::err_drv_argument_not_allowed_with)
  1549. << iOSVersion->getAsString(Args)
  1550. << (TvOSVersion ? TvOSVersion : WatchOSVersion)->getAsString(Args);
  1551. }
  1552. return DarwinPlatform::createOSVersionArg(
  1553. Darwin::IPhoneOS, iOSVersion,
  1554. iOSVersion->getOption().getID() ==
  1555. options::OPT_mios_simulator_version_min_EQ);
  1556. } else if (TvOSVersion) {
  1557. if (WatchOSVersion) {
  1558. TheDriver.Diag(diag::err_drv_argument_not_allowed_with)
  1559. << TvOSVersion->getAsString(Args)
  1560. << WatchOSVersion->getAsString(Args);
  1561. }
  1562. return DarwinPlatform::createOSVersionArg(
  1563. Darwin::TvOS, TvOSVersion,
  1564. TvOSVersion->getOption().getID() ==
  1565. options::OPT_mtvos_simulator_version_min_EQ);
  1566. } else if (WatchOSVersion)
  1567. return DarwinPlatform::createOSVersionArg(
  1568. Darwin::WatchOS, WatchOSVersion,
  1569. WatchOSVersion->getOption().getID() ==
  1570. options::OPT_mwatchos_simulator_version_min_EQ);
  1571. return std::nullopt;
  1572. }
  1573. /// Returns the deployment target that's specified using the
  1574. /// OS_DEPLOYMENT_TARGET environment variable.
  1575. std::optional<DarwinPlatform>
  1576. getDeploymentTargetFromEnvironmentVariables(const Driver &TheDriver,
  1577. const llvm::Triple &Triple) {
  1578. std::string Targets[Darwin::LastDarwinPlatform + 1];
  1579. const char *EnvVars[] = {
  1580. "MACOSX_DEPLOYMENT_TARGET",
  1581. "IPHONEOS_DEPLOYMENT_TARGET",
  1582. "TVOS_DEPLOYMENT_TARGET",
  1583. "WATCHOS_DEPLOYMENT_TARGET",
  1584. "DRIVERKIT_DEPLOYMENT_TARGET",
  1585. };
  1586. static_assert(std::size(EnvVars) == Darwin::LastDarwinPlatform + 1,
  1587. "Missing platform");
  1588. for (const auto &I : llvm::enumerate(llvm::ArrayRef(EnvVars))) {
  1589. if (char *Env = ::getenv(I.value()))
  1590. Targets[I.index()] = Env;
  1591. }
  1592. // Allow conflicts among OSX and iOS for historical reasons, but choose the
  1593. // default platform.
  1594. if (!Targets[Darwin::MacOS].empty() &&
  1595. (!Targets[Darwin::IPhoneOS].empty() ||
  1596. !Targets[Darwin::WatchOS].empty() || !Targets[Darwin::TvOS].empty())) {
  1597. if (Triple.getArch() == llvm::Triple::arm ||
  1598. Triple.getArch() == llvm::Triple::aarch64 ||
  1599. Triple.getArch() == llvm::Triple::thumb)
  1600. Targets[Darwin::MacOS] = "";
  1601. else
  1602. Targets[Darwin::IPhoneOS] = Targets[Darwin::WatchOS] =
  1603. Targets[Darwin::TvOS] = "";
  1604. } else {
  1605. // Don't allow conflicts in any other platform.
  1606. unsigned FirstTarget = std::size(Targets);
  1607. for (unsigned I = 0; I != std::size(Targets); ++I) {
  1608. if (Targets[I].empty())
  1609. continue;
  1610. if (FirstTarget == std::size(Targets))
  1611. FirstTarget = I;
  1612. else
  1613. TheDriver.Diag(diag::err_drv_conflicting_deployment_targets)
  1614. << Targets[FirstTarget] << Targets[I];
  1615. }
  1616. }
  1617. for (const auto &Target : llvm::enumerate(llvm::ArrayRef(Targets))) {
  1618. if (!Target.value().empty())
  1619. return DarwinPlatform::createDeploymentTargetEnv(
  1620. (Darwin::DarwinPlatformKind)Target.index(), EnvVars[Target.index()],
  1621. Target.value());
  1622. }
  1623. return std::nullopt;
  1624. }
  1625. /// Returns the SDK name without the optional prefix that ends with a '.' or an
  1626. /// empty string otherwise.
  1627. static StringRef dropSDKNamePrefix(StringRef SDKName) {
  1628. size_t PrefixPos = SDKName.find('.');
  1629. if (PrefixPos == StringRef::npos)
  1630. return "";
  1631. return SDKName.substr(PrefixPos + 1);
  1632. }
  1633. /// Tries to infer the deployment target from the SDK specified by -isysroot
  1634. /// (or SDKROOT). Uses the version specified in the SDKSettings.json file if
  1635. /// it's available.
  1636. std::optional<DarwinPlatform>
  1637. inferDeploymentTargetFromSDK(DerivedArgList &Args,
  1638. const std::optional<DarwinSDKInfo> &SDKInfo) {
  1639. const Arg *A = Args.getLastArg(options::OPT_isysroot);
  1640. if (!A)
  1641. return std::nullopt;
  1642. StringRef isysroot = A->getValue();
  1643. StringRef SDK = Darwin::getSDKName(isysroot);
  1644. if (!SDK.size())
  1645. return std::nullopt;
  1646. std::string Version;
  1647. if (SDKInfo) {
  1648. // Get the version from the SDKSettings.json if it's available.
  1649. Version = SDKInfo->getVersion().getAsString();
  1650. } else {
  1651. // Slice the version number out.
  1652. // Version number is between the first and the last number.
  1653. size_t StartVer = SDK.find_first_of("0123456789");
  1654. size_t EndVer = SDK.find_last_of("0123456789");
  1655. if (StartVer != StringRef::npos && EndVer > StartVer)
  1656. Version = std::string(SDK.slice(StartVer, EndVer + 1));
  1657. }
  1658. if (Version.empty())
  1659. return std::nullopt;
  1660. auto CreatePlatformFromSDKName =
  1661. [&](StringRef SDK) -> std::optional<DarwinPlatform> {
  1662. if (SDK.startswith("iPhoneOS") || SDK.startswith("iPhoneSimulator"))
  1663. return DarwinPlatform::createFromSDK(
  1664. Darwin::IPhoneOS, Version,
  1665. /*IsSimulator=*/SDK.startswith("iPhoneSimulator"));
  1666. else if (SDK.startswith("MacOSX"))
  1667. return DarwinPlatform::createFromSDK(Darwin::MacOS,
  1668. getSystemOrSDKMacOSVersion(Version));
  1669. else if (SDK.startswith("WatchOS") || SDK.startswith("WatchSimulator"))
  1670. return DarwinPlatform::createFromSDK(
  1671. Darwin::WatchOS, Version,
  1672. /*IsSimulator=*/SDK.startswith("WatchSimulator"));
  1673. else if (SDK.startswith("AppleTVOS") || SDK.startswith("AppleTVSimulator"))
  1674. return DarwinPlatform::createFromSDK(
  1675. Darwin::TvOS, Version,
  1676. /*IsSimulator=*/SDK.startswith("AppleTVSimulator"));
  1677. else if (SDK.startswith("DriverKit"))
  1678. return DarwinPlatform::createFromSDK(Darwin::DriverKit, Version);
  1679. return std::nullopt;
  1680. };
  1681. if (auto Result = CreatePlatformFromSDKName(SDK))
  1682. return Result;
  1683. // The SDK can be an SDK variant with a name like `<prefix>.<platform>`.
  1684. return CreatePlatformFromSDKName(dropSDKNamePrefix(SDK));
  1685. }
  1686. std::string getOSVersion(llvm::Triple::OSType OS, const llvm::Triple &Triple,
  1687. const Driver &TheDriver) {
  1688. VersionTuple OsVersion;
  1689. llvm::Triple SystemTriple(llvm::sys::getProcessTriple());
  1690. switch (OS) {
  1691. case llvm::Triple::Darwin:
  1692. case llvm::Triple::MacOSX:
  1693. // If there is no version specified on triple, and both host and target are
  1694. // macos, use the host triple to infer OS version.
  1695. if (Triple.isMacOSX() && SystemTriple.isMacOSX() &&
  1696. !Triple.getOSMajorVersion())
  1697. SystemTriple.getMacOSXVersion(OsVersion);
  1698. else if (!Triple.getMacOSXVersion(OsVersion))
  1699. TheDriver.Diag(diag::err_drv_invalid_darwin_version)
  1700. << Triple.getOSName();
  1701. break;
  1702. case llvm::Triple::IOS:
  1703. if (Triple.isMacCatalystEnvironment() && !Triple.getOSMajorVersion()) {
  1704. OsVersion = VersionTuple(13, 1);
  1705. } else
  1706. OsVersion = Triple.getiOSVersion();
  1707. break;
  1708. case llvm::Triple::TvOS:
  1709. OsVersion = Triple.getOSVersion();
  1710. break;
  1711. case llvm::Triple::WatchOS:
  1712. OsVersion = Triple.getWatchOSVersion();
  1713. break;
  1714. case llvm::Triple::DriverKit:
  1715. OsVersion = Triple.getDriverKitVersion();
  1716. break;
  1717. default:
  1718. llvm_unreachable("Unexpected OS type");
  1719. break;
  1720. }
  1721. std::string OSVersion;
  1722. llvm::raw_string_ostream(OSVersion)
  1723. << OsVersion.getMajor() << '.' << OsVersion.getMinor().value_or(0) << '.'
  1724. << OsVersion.getSubminor().value_or(0);
  1725. return OSVersion;
  1726. }
  1727. /// Tries to infer the target OS from the -arch.
  1728. std::optional<DarwinPlatform>
  1729. inferDeploymentTargetFromArch(DerivedArgList &Args, const Darwin &Toolchain,
  1730. const llvm::Triple &Triple,
  1731. const Driver &TheDriver) {
  1732. llvm::Triple::OSType OSTy = llvm::Triple::UnknownOS;
  1733. StringRef MachOArchName = Toolchain.getMachOArchName(Args);
  1734. if (MachOArchName == "arm64" || MachOArchName == "arm64e")
  1735. OSTy = llvm::Triple::MacOSX;
  1736. else if (MachOArchName == "armv7" || MachOArchName == "armv7s")
  1737. OSTy = llvm::Triple::IOS;
  1738. else if (MachOArchName == "armv7k" || MachOArchName == "arm64_32")
  1739. OSTy = llvm::Triple::WatchOS;
  1740. else if (MachOArchName != "armv6m" && MachOArchName != "armv7m" &&
  1741. MachOArchName != "armv7em")
  1742. OSTy = llvm::Triple::MacOSX;
  1743. if (OSTy == llvm::Triple::UnknownOS)
  1744. return std::nullopt;
  1745. return DarwinPlatform::createFromArch(OSTy,
  1746. getOSVersion(OSTy, Triple, TheDriver));
  1747. }
  1748. /// Returns the deployment target that's specified using the -target option.
  1749. std::optional<DarwinPlatform> getDeploymentTargetFromTargetArg(
  1750. DerivedArgList &Args, const llvm::Triple &Triple, const Driver &TheDriver,
  1751. const std::optional<DarwinSDKInfo> &SDKInfo) {
  1752. if (!Args.hasArg(options::OPT_target))
  1753. return std::nullopt;
  1754. if (Triple.getOS() == llvm::Triple::Darwin ||
  1755. Triple.getOS() == llvm::Triple::UnknownOS)
  1756. return std::nullopt;
  1757. std::string OSVersion = getOSVersion(Triple.getOS(), Triple, TheDriver);
  1758. std::optional<llvm::Triple> TargetVariantTriple;
  1759. for (const Arg *A : Args.filtered(options::OPT_darwin_target_variant)) {
  1760. llvm::Triple TVT(A->getValue());
  1761. // Find a matching <arch>-<vendor> target variant triple that can be used.
  1762. if ((Triple.getArch() == llvm::Triple::aarch64 ||
  1763. TVT.getArchName() == Triple.getArchName()) &&
  1764. TVT.getArch() == Triple.getArch() &&
  1765. TVT.getSubArch() == Triple.getSubArch() &&
  1766. TVT.getVendor() == Triple.getVendor()) {
  1767. if (TargetVariantTriple)
  1768. continue;
  1769. A->claim();
  1770. // Accept a -target-variant triple when compiling code that may run on
  1771. // macOS or Mac Catalust.
  1772. if ((Triple.isMacOSX() && TVT.getOS() == llvm::Triple::IOS &&
  1773. TVT.isMacCatalystEnvironment()) ||
  1774. (TVT.isMacOSX() && Triple.getOS() == llvm::Triple::IOS &&
  1775. Triple.isMacCatalystEnvironment())) {
  1776. TargetVariantTriple = TVT;
  1777. continue;
  1778. }
  1779. TheDriver.Diag(diag::err_drv_target_variant_invalid)
  1780. << A->getSpelling() << A->getValue();
  1781. }
  1782. }
  1783. return DarwinPlatform::createFromTarget(Triple, OSVersion,
  1784. Args.getLastArg(options::OPT_target),
  1785. TargetVariantTriple, SDKInfo);
  1786. }
  1787. /// Returns the deployment target that's specified using the -mtargetos option.
  1788. std::optional<DarwinPlatform> getDeploymentTargetFromMTargetOSArg(
  1789. DerivedArgList &Args, const Driver &TheDriver,
  1790. const std::optional<DarwinSDKInfo> &SDKInfo) {
  1791. auto *A = Args.getLastArg(options::OPT_mtargetos_EQ);
  1792. if (!A)
  1793. return std::nullopt;
  1794. llvm::Triple TT(llvm::Twine("unknown-apple-") + A->getValue());
  1795. switch (TT.getOS()) {
  1796. case llvm::Triple::MacOSX:
  1797. case llvm::Triple::IOS:
  1798. case llvm::Triple::TvOS:
  1799. case llvm::Triple::WatchOS:
  1800. break;
  1801. default:
  1802. TheDriver.Diag(diag::err_drv_invalid_os_in_arg)
  1803. << TT.getOSName() << A->getAsString(Args);
  1804. return std::nullopt;
  1805. }
  1806. VersionTuple Version = TT.getOSVersion();
  1807. if (!Version.getMajor()) {
  1808. TheDriver.Diag(diag::err_drv_invalid_version_number)
  1809. << A->getAsString(Args);
  1810. return std::nullopt;
  1811. }
  1812. return DarwinPlatform::createFromMTargetOS(TT.getOS(), Version,
  1813. TT.getEnvironment(), A, SDKInfo);
  1814. }
  1815. std::optional<DarwinSDKInfo> parseSDKSettings(llvm::vfs::FileSystem &VFS,
  1816. const ArgList &Args,
  1817. const Driver &TheDriver) {
  1818. const Arg *A = Args.getLastArg(options::OPT_isysroot);
  1819. if (!A)
  1820. return std::nullopt;
  1821. StringRef isysroot = A->getValue();
  1822. auto SDKInfoOrErr = parseDarwinSDKInfo(VFS, isysroot);
  1823. if (!SDKInfoOrErr) {
  1824. llvm::consumeError(SDKInfoOrErr.takeError());
  1825. TheDriver.Diag(diag::warn_drv_darwin_sdk_invalid_settings);
  1826. return std::nullopt;
  1827. }
  1828. return *SDKInfoOrErr;
  1829. }
  1830. } // namespace
  1831. void Darwin::AddDeploymentTarget(DerivedArgList &Args) const {
  1832. const OptTable &Opts = getDriver().getOpts();
  1833. // Support allowing the SDKROOT environment variable used by xcrun and other
  1834. // Xcode tools to define the default sysroot, by making it the default for
  1835. // isysroot.
  1836. if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
  1837. // Warn if the path does not exist.
  1838. if (!getVFS().exists(A->getValue()))
  1839. getDriver().Diag(clang::diag::warn_missing_sysroot) << A->getValue();
  1840. } else {
  1841. if (char *env = ::getenv("SDKROOT")) {
  1842. // We only use this value as the default if it is an absolute path,
  1843. // exists, and it is not the root path.
  1844. if (llvm::sys::path::is_absolute(env) && getVFS().exists(env) &&
  1845. StringRef(env) != "/") {
  1846. Args.append(Args.MakeSeparateArg(
  1847. nullptr, Opts.getOption(options::OPT_isysroot), env));
  1848. }
  1849. }
  1850. }
  1851. // Read the SDKSettings.json file for more information, like the SDK version
  1852. // that we can pass down to the compiler.
  1853. SDKInfo = parseSDKSettings(getVFS(), Args, getDriver());
  1854. // The OS and the version can be specified using the -target argument.
  1855. std::optional<DarwinPlatform> OSTarget =
  1856. getDeploymentTargetFromTargetArg(Args, getTriple(), getDriver(), SDKInfo);
  1857. if (OSTarget) {
  1858. // Disallow mixing -target and -mtargetos=.
  1859. if (const auto *MTargetOSArg = Args.getLastArg(options::OPT_mtargetos_EQ)) {
  1860. std::string TargetArgStr = OSTarget->getAsString(Args, Opts);
  1861. std::string MTargetOSArgStr = MTargetOSArg->getAsString(Args);
  1862. getDriver().Diag(diag::err_drv_cannot_mix_options)
  1863. << TargetArgStr << MTargetOSArgStr;
  1864. }
  1865. std::optional<DarwinPlatform> OSVersionArgTarget =
  1866. getDeploymentTargetFromOSVersionArg(Args, getDriver());
  1867. if (OSVersionArgTarget) {
  1868. unsigned TargetMajor, TargetMinor, TargetMicro;
  1869. bool TargetExtra;
  1870. unsigned ArgMajor, ArgMinor, ArgMicro;
  1871. bool ArgExtra;
  1872. if (OSTarget->getPlatform() != OSVersionArgTarget->getPlatform() ||
  1873. (Driver::GetReleaseVersion(OSTarget->getOSVersion(), TargetMajor,
  1874. TargetMinor, TargetMicro, TargetExtra) &&
  1875. Driver::GetReleaseVersion(OSVersionArgTarget->getOSVersion(),
  1876. ArgMajor, ArgMinor, ArgMicro, ArgExtra) &&
  1877. (VersionTuple(TargetMajor, TargetMinor, TargetMicro) !=
  1878. VersionTuple(ArgMajor, ArgMinor, ArgMicro) ||
  1879. TargetExtra != ArgExtra))) {
  1880. // Select the OS version from the -m<os>-version-min argument when
  1881. // the -target does not include an OS version.
  1882. if (OSTarget->getPlatform() == OSVersionArgTarget->getPlatform() &&
  1883. !OSTarget->hasOSVersion()) {
  1884. OSTarget->setOSVersion(OSVersionArgTarget->getOSVersion());
  1885. } else {
  1886. // Warn about -m<os>-version-min that doesn't match the OS version
  1887. // that's specified in the target.
  1888. std::string OSVersionArg =
  1889. OSVersionArgTarget->getAsString(Args, Opts);
  1890. std::string TargetArg = OSTarget->getAsString(Args, Opts);
  1891. getDriver().Diag(clang::diag::warn_drv_overriding_flag_option)
  1892. << OSVersionArg << TargetArg;
  1893. }
  1894. }
  1895. }
  1896. } else if ((OSTarget = getDeploymentTargetFromMTargetOSArg(Args, getDriver(),
  1897. SDKInfo))) {
  1898. // The OS target can be specified using the -mtargetos= argument.
  1899. // Disallow mixing -mtargetos= and -m<os>version-min=.
  1900. std::optional<DarwinPlatform> OSVersionArgTarget =
  1901. getDeploymentTargetFromOSVersionArg(Args, getDriver());
  1902. if (OSVersionArgTarget) {
  1903. std::string MTargetOSArgStr = OSTarget->getAsString(Args, Opts);
  1904. std::string OSVersionArgStr = OSVersionArgTarget->getAsString(Args, Opts);
  1905. getDriver().Diag(diag::err_drv_cannot_mix_options)
  1906. << MTargetOSArgStr << OSVersionArgStr;
  1907. }
  1908. } else {
  1909. // The OS target can be specified using the -m<os>version-min argument.
  1910. OSTarget = getDeploymentTargetFromOSVersionArg(Args, getDriver());
  1911. // If no deployment target was specified on the command line, check for
  1912. // environment defines.
  1913. if (!OSTarget) {
  1914. OSTarget =
  1915. getDeploymentTargetFromEnvironmentVariables(getDriver(), getTriple());
  1916. if (OSTarget) {
  1917. // Don't infer simulator from the arch when the SDK is also specified.
  1918. std::optional<DarwinPlatform> SDKTarget =
  1919. inferDeploymentTargetFromSDK(Args, SDKInfo);
  1920. if (SDKTarget)
  1921. OSTarget->setEnvironment(SDKTarget->getEnvironment());
  1922. }
  1923. }
  1924. // If there is no command-line argument to specify the Target version and
  1925. // no environment variable defined, see if we can set the default based
  1926. // on -isysroot using SDKSettings.json if it exists.
  1927. if (!OSTarget) {
  1928. OSTarget = inferDeploymentTargetFromSDK(Args, SDKInfo);
  1929. /// If the target was successfully constructed from the SDK path, try to
  1930. /// infer the SDK info if the SDK doesn't have it.
  1931. if (OSTarget && !SDKInfo)
  1932. SDKInfo = OSTarget->inferSDKInfo();
  1933. }
  1934. // If no OS targets have been specified, try to guess platform from -target
  1935. // or arch name and compute the version from the triple.
  1936. if (!OSTarget)
  1937. OSTarget =
  1938. inferDeploymentTargetFromArch(Args, *this, getTriple(), getDriver());
  1939. }
  1940. assert(OSTarget && "Unable to infer Darwin variant");
  1941. OSTarget->addOSVersionMinArgument(Args, Opts);
  1942. DarwinPlatformKind Platform = OSTarget->getPlatform();
  1943. unsigned Major, Minor, Micro;
  1944. bool HadExtra;
  1945. // The major version should not be over this number.
  1946. const unsigned MajorVersionLimit = 1000;
  1947. // Set the tool chain target information.
  1948. if (Platform == MacOS) {
  1949. if (!Driver::GetReleaseVersion(OSTarget->getOSVersion(), Major, Minor,
  1950. Micro, HadExtra) ||
  1951. HadExtra || Major < 10 || Major >= MajorVersionLimit || Minor >= 100 ||
  1952. Micro >= 100)
  1953. getDriver().Diag(diag::err_drv_invalid_version_number)
  1954. << OSTarget->getAsString(Args, Opts);
  1955. } else if (Platform == IPhoneOS) {
  1956. if (!Driver::GetReleaseVersion(OSTarget->getOSVersion(), Major, Minor,
  1957. Micro, HadExtra) ||
  1958. HadExtra || Major >= MajorVersionLimit || Minor >= 100 || Micro >= 100)
  1959. getDriver().Diag(diag::err_drv_invalid_version_number)
  1960. << OSTarget->getAsString(Args, Opts);
  1961. ;
  1962. if (OSTarget->getEnvironment() == MacCatalyst &&
  1963. (Major < 13 || (Major == 13 && Minor < 1))) {
  1964. getDriver().Diag(diag::err_drv_invalid_version_number)
  1965. << OSTarget->getAsString(Args, Opts);
  1966. Major = 13;
  1967. Minor = 1;
  1968. Micro = 0;
  1969. }
  1970. // For 32-bit targets, the deployment target for iOS has to be earlier than
  1971. // iOS 11.
  1972. if (getTriple().isArch32Bit() && Major >= 11) {
  1973. // If the deployment target is explicitly specified, print a diagnostic.
  1974. if (OSTarget->isExplicitlySpecified()) {
  1975. if (OSTarget->getEnvironment() == MacCatalyst)
  1976. getDriver().Diag(diag::err_invalid_macos_32bit_deployment_target);
  1977. else
  1978. getDriver().Diag(diag::warn_invalid_ios_deployment_target)
  1979. << OSTarget->getAsString(Args, Opts);
  1980. // Otherwise, set it to 10.99.99.
  1981. } else {
  1982. Major = 10;
  1983. Minor = 99;
  1984. Micro = 99;
  1985. }
  1986. }
  1987. } else if (Platform == TvOS) {
  1988. if (!Driver::GetReleaseVersion(OSTarget->getOSVersion(), Major, Minor,
  1989. Micro, HadExtra) ||
  1990. HadExtra || Major >= MajorVersionLimit || Minor >= 100 || Micro >= 100)
  1991. getDriver().Diag(diag::err_drv_invalid_version_number)
  1992. << OSTarget->getAsString(Args, Opts);
  1993. } else if (Platform == WatchOS) {
  1994. if (!Driver::GetReleaseVersion(OSTarget->getOSVersion(), Major, Minor,
  1995. Micro, HadExtra) ||
  1996. HadExtra || Major >= MajorVersionLimit || Minor >= 100 || Micro >= 100)
  1997. getDriver().Diag(diag::err_drv_invalid_version_number)
  1998. << OSTarget->getAsString(Args, Opts);
  1999. } else if (Platform == DriverKit) {
  2000. if (!Driver::GetReleaseVersion(OSTarget->getOSVersion(), Major, Minor,
  2001. Micro, HadExtra) ||
  2002. HadExtra || Major < 19 || Major >= MajorVersionLimit || Minor >= 100 ||
  2003. Micro >= 100)
  2004. getDriver().Diag(diag::err_drv_invalid_version_number)
  2005. << OSTarget->getAsString(Args, Opts);
  2006. } else
  2007. llvm_unreachable("unknown kind of Darwin platform");
  2008. DarwinEnvironmentKind Environment = OSTarget->getEnvironment();
  2009. // Recognize iOS targets with an x86 architecture as the iOS simulator.
  2010. if (Environment == NativeEnvironment && Platform != MacOS &&
  2011. Platform != DriverKit && OSTarget->canInferSimulatorFromArch() &&
  2012. getTriple().isX86())
  2013. Environment = Simulator;
  2014. VersionTuple NativeTargetVersion;
  2015. if (Environment == MacCatalyst)
  2016. NativeTargetVersion = OSTarget->getNativeTargetVersion();
  2017. setTarget(Platform, Environment, Major, Minor, Micro, NativeTargetVersion);
  2018. TargetVariantTriple = OSTarget->getTargetVariantTriple();
  2019. if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
  2020. StringRef SDK = getSDKName(A->getValue());
  2021. if (SDK.size() > 0) {
  2022. size_t StartVer = SDK.find_first_of("0123456789");
  2023. StringRef SDKName = SDK.slice(0, StartVer);
  2024. if (!SDKName.startswith(getPlatformFamily()) &&
  2025. !dropSDKNamePrefix(SDKName).startswith(getPlatformFamily()))
  2026. getDriver().Diag(diag::warn_incompatible_sysroot)
  2027. << SDKName << getPlatformFamily();
  2028. }
  2029. }
  2030. }
  2031. // For certain platforms/environments almost all resources (e.g., headers) are
  2032. // located in sub-directories, e.g., for DriverKit they live in
  2033. // <SYSROOT>/System/DriverKit/usr/include (instead of <SYSROOT>/usr/include).
  2034. static void AppendPlatformPrefix(SmallString<128> &Path,
  2035. const llvm::Triple &T) {
  2036. if (T.isDriverKit()) {
  2037. llvm::sys::path::append(Path, "System", "DriverKit");
  2038. }
  2039. }
  2040. // Returns the effective sysroot from either -isysroot or --sysroot, plus the
  2041. // platform prefix (if any).
  2042. llvm::SmallString<128>
  2043. DarwinClang::GetEffectiveSysroot(const llvm::opt::ArgList &DriverArgs) const {
  2044. llvm::SmallString<128> Path("/");
  2045. if (DriverArgs.hasArg(options::OPT_isysroot))
  2046. Path = DriverArgs.getLastArgValue(options::OPT_isysroot);
  2047. else if (!getDriver().SysRoot.empty())
  2048. Path = getDriver().SysRoot;
  2049. if (hasEffectiveTriple()) {
  2050. AppendPlatformPrefix(Path, getEffectiveTriple());
  2051. }
  2052. return Path;
  2053. }
  2054. void DarwinClang::AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
  2055. llvm::opt::ArgStringList &CC1Args) const {
  2056. const Driver &D = getDriver();
  2057. llvm::SmallString<128> Sysroot = GetEffectiveSysroot(DriverArgs);
  2058. bool NoStdInc = DriverArgs.hasArg(options::OPT_nostdinc);
  2059. bool NoStdlibInc = DriverArgs.hasArg(options::OPT_nostdlibinc);
  2060. bool NoBuiltinInc = DriverArgs.hasFlag(
  2061. options::OPT_nobuiltininc, options::OPT_ibuiltininc, /*Default=*/false);
  2062. bool ForceBuiltinInc = DriverArgs.hasFlag(
  2063. options::OPT_ibuiltininc, options::OPT_nobuiltininc, /*Default=*/false);
  2064. // Add <sysroot>/usr/local/include
  2065. if (!NoStdInc && !NoStdlibInc) {
  2066. SmallString<128> P(Sysroot);
  2067. llvm::sys::path::append(P, "usr", "local", "include");
  2068. addSystemInclude(DriverArgs, CC1Args, P);
  2069. }
  2070. // Add the Clang builtin headers (<resource>/include)
  2071. if (!(NoStdInc && !ForceBuiltinInc) && !NoBuiltinInc) {
  2072. SmallString<128> P(D.ResourceDir);
  2073. llvm::sys::path::append(P, "include");
  2074. addSystemInclude(DriverArgs, CC1Args, P);
  2075. }
  2076. if (NoStdInc || NoStdlibInc)
  2077. return;
  2078. // Check for configure-time C include directories.
  2079. llvm::StringRef CIncludeDirs(C_INCLUDE_DIRS);
  2080. if (!CIncludeDirs.empty()) {
  2081. llvm::SmallVector<llvm::StringRef, 5> dirs;
  2082. CIncludeDirs.split(dirs, ":");
  2083. for (llvm::StringRef dir : dirs) {
  2084. llvm::StringRef Prefix =
  2085. llvm::sys::path::is_absolute(dir) ? "" : llvm::StringRef(Sysroot);
  2086. addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
  2087. }
  2088. } else {
  2089. // Otherwise, add <sysroot>/usr/include.
  2090. SmallString<128> P(Sysroot);
  2091. llvm::sys::path::append(P, "usr", "include");
  2092. addExternCSystemInclude(DriverArgs, CC1Args, P.str());
  2093. }
  2094. }
  2095. bool DarwinClang::AddGnuCPlusPlusIncludePaths(const llvm::opt::ArgList &DriverArgs,
  2096. llvm::opt::ArgStringList &CC1Args,
  2097. llvm::SmallString<128> Base,
  2098. llvm::StringRef Version,
  2099. llvm::StringRef ArchDir,
  2100. llvm::StringRef BitDir) const {
  2101. llvm::sys::path::append(Base, Version);
  2102. // Add the base dir
  2103. addSystemInclude(DriverArgs, CC1Args, Base);
  2104. // Add the multilib dirs
  2105. {
  2106. llvm::SmallString<128> P = Base;
  2107. if (!ArchDir.empty())
  2108. llvm::sys::path::append(P, ArchDir);
  2109. if (!BitDir.empty())
  2110. llvm::sys::path::append(P, BitDir);
  2111. addSystemInclude(DriverArgs, CC1Args, P);
  2112. }
  2113. // Add the backward dir
  2114. {
  2115. llvm::SmallString<128> P = Base;
  2116. llvm::sys::path::append(P, "backward");
  2117. addSystemInclude(DriverArgs, CC1Args, P);
  2118. }
  2119. return getVFS().exists(Base);
  2120. }
  2121. void DarwinClang::AddClangCXXStdlibIncludeArgs(
  2122. const llvm::opt::ArgList &DriverArgs,
  2123. llvm::opt::ArgStringList &CC1Args) const {
  2124. // The implementation from a base class will pass through the -stdlib to
  2125. // CC1Args.
  2126. // FIXME: this should not be necessary, remove usages in the frontend
  2127. // (e.g. HeaderSearchOptions::UseLibcxx) and don't pipe -stdlib.
  2128. // Also check whether this is used for setting library search paths.
  2129. ToolChain::AddClangCXXStdlibIncludeArgs(DriverArgs, CC1Args);
  2130. if (DriverArgs.hasArg(options::OPT_nostdinc, options::OPT_nostdlibinc,
  2131. options::OPT_nostdincxx))
  2132. return;
  2133. llvm::SmallString<128> Sysroot = GetEffectiveSysroot(DriverArgs);
  2134. switch (GetCXXStdlibType(DriverArgs)) {
  2135. case ToolChain::CST_Libcxx: {
  2136. // On Darwin, libc++ can be installed in one of the following two places:
  2137. // 1. Alongside the compiler in <install>/include/c++/v1
  2138. // 2. In a SDK (or a custom sysroot) in <sysroot>/usr/include/c++/v1
  2139. //
  2140. // The precendence of paths is as listed above, i.e. we take the first path
  2141. // that exists. Also note that we never include libc++ twice -- we take the
  2142. // first path that exists and don't send the other paths to CC1 (otherwise
  2143. // include_next could break).
  2144. // Check for (1)
  2145. // Get from '<install>/bin' to '<install>/include/c++/v1'.
  2146. // Note that InstallBin can be relative, so we use '..' instead of
  2147. // parent_path.
  2148. llvm::SmallString<128> InstallBin =
  2149. llvm::StringRef(getDriver().getInstalledDir()); // <install>/bin
  2150. llvm::sys::path::append(InstallBin, "..", "include", "c++", "v1");
  2151. if (getVFS().exists(InstallBin)) {
  2152. addSystemInclude(DriverArgs, CC1Args, InstallBin);
  2153. return;
  2154. } else if (DriverArgs.hasArg(options::OPT_v)) {
  2155. llvm::errs() << "ignoring nonexistent directory \"" << InstallBin
  2156. << "\"\n";
  2157. }
  2158. // Otherwise, check for (2)
  2159. llvm::SmallString<128> SysrootUsr = Sysroot;
  2160. llvm::sys::path::append(SysrootUsr, "usr", "include", "c++", "v1");
  2161. if (getVFS().exists(SysrootUsr)) {
  2162. addSystemInclude(DriverArgs, CC1Args, SysrootUsr);
  2163. return;
  2164. } else if (DriverArgs.hasArg(options::OPT_v)) {
  2165. llvm::errs() << "ignoring nonexistent directory \"" << SysrootUsr
  2166. << "\"\n";
  2167. }
  2168. // Otherwise, don't add any path.
  2169. break;
  2170. }
  2171. case ToolChain::CST_Libstdcxx:
  2172. llvm::SmallString<128> UsrIncludeCxx = Sysroot;
  2173. llvm::sys::path::append(UsrIncludeCxx, "usr", "include", "c++");
  2174. llvm::Triple::ArchType arch = getTriple().getArch();
  2175. bool IsBaseFound = true;
  2176. switch (arch) {
  2177. default: break;
  2178. case llvm::Triple::ppc:
  2179. case llvm::Triple::ppc64:
  2180. IsBaseFound = AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2181. "4.2.1",
  2182. "powerpc-apple-darwin10",
  2183. arch == llvm::Triple::ppc64 ? "ppc64" : "");
  2184. IsBaseFound |= AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2185. "4.0.0", "powerpc-apple-darwin10",
  2186. arch == llvm::Triple::ppc64 ? "ppc64" : "");
  2187. break;
  2188. case llvm::Triple::x86:
  2189. case llvm::Triple::x86_64:
  2190. IsBaseFound = AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2191. "4.2.1",
  2192. "i686-apple-darwin10",
  2193. arch == llvm::Triple::x86_64 ? "x86_64" : "");
  2194. IsBaseFound |= AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2195. "4.0.0", "i686-apple-darwin8",
  2196. "");
  2197. break;
  2198. case llvm::Triple::arm:
  2199. case llvm::Triple::thumb:
  2200. IsBaseFound = AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2201. "4.2.1",
  2202. "arm-apple-darwin10",
  2203. "v7");
  2204. IsBaseFound |= AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2205. "4.2.1",
  2206. "arm-apple-darwin10",
  2207. "v6");
  2208. break;
  2209. case llvm::Triple::aarch64:
  2210. IsBaseFound = AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx,
  2211. "4.2.1",
  2212. "arm64-apple-darwin10",
  2213. "");
  2214. break;
  2215. }
  2216. if (!IsBaseFound) {
  2217. getDriver().Diag(diag::warn_drv_libstdcxx_not_found);
  2218. }
  2219. break;
  2220. }
  2221. }
  2222. void DarwinClang::AddCXXStdlibLibArgs(const ArgList &Args,
  2223. ArgStringList &CmdArgs) const {
  2224. CXXStdlibType Type = GetCXXStdlibType(Args);
  2225. switch (Type) {
  2226. case ToolChain::CST_Libcxx:
  2227. CmdArgs.push_back("-lc++");
  2228. if (Args.hasArg(options::OPT_fexperimental_library))
  2229. CmdArgs.push_back("-lc++experimental");
  2230. break;
  2231. case ToolChain::CST_Libstdcxx:
  2232. // Unfortunately, -lstdc++ doesn't always exist in the standard search path;
  2233. // it was previously found in the gcc lib dir. However, for all the Darwin
  2234. // platforms we care about it was -lstdc++.6, so we search for that
  2235. // explicitly if we can't see an obvious -lstdc++ candidate.
  2236. // Check in the sysroot first.
  2237. if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
  2238. SmallString<128> P(A->getValue());
  2239. llvm::sys::path::append(P, "usr", "lib", "libstdc++.dylib");
  2240. if (!getVFS().exists(P)) {
  2241. llvm::sys::path::remove_filename(P);
  2242. llvm::sys::path::append(P, "libstdc++.6.dylib");
  2243. if (getVFS().exists(P)) {
  2244. CmdArgs.push_back(Args.MakeArgString(P));
  2245. return;
  2246. }
  2247. }
  2248. }
  2249. // Otherwise, look in the root.
  2250. // FIXME: This should be removed someday when we don't have to care about
  2251. // 10.6 and earlier, where /usr/lib/libstdc++.dylib does not exist.
  2252. if (!getVFS().exists("/usr/lib/libstdc++.dylib") &&
  2253. getVFS().exists("/usr/lib/libstdc++.6.dylib")) {
  2254. CmdArgs.push_back("/usr/lib/libstdc++.6.dylib");
  2255. return;
  2256. }
  2257. // Otherwise, let the linker search.
  2258. CmdArgs.push_back("-lstdc++");
  2259. break;
  2260. }
  2261. }
  2262. void DarwinClang::AddCCKextLibArgs(const ArgList &Args,
  2263. ArgStringList &CmdArgs) const {
  2264. // For Darwin platforms, use the compiler-rt-based support library
  2265. // instead of the gcc-provided one (which is also incidentally
  2266. // only present in the gcc lib dir, which makes it hard to find).
  2267. SmallString<128> P(getDriver().ResourceDir);
  2268. llvm::sys::path::append(P, "lib", "darwin");
  2269. // Use the newer cc_kext for iOS ARM after 6.0.
  2270. if (isTargetWatchOS()) {
  2271. llvm::sys::path::append(P, "libclang_rt.cc_kext_watchos.a");
  2272. } else if (isTargetTvOS()) {
  2273. llvm::sys::path::append(P, "libclang_rt.cc_kext_tvos.a");
  2274. } else if (isTargetIPhoneOS()) {
  2275. llvm::sys::path::append(P, "libclang_rt.cc_kext_ios.a");
  2276. } else if (isTargetDriverKit()) {
  2277. // DriverKit doesn't want extra runtime support.
  2278. } else {
  2279. llvm::sys::path::append(P, "libclang_rt.cc_kext.a");
  2280. }
  2281. // For now, allow missing resource libraries to support developers who may
  2282. // not have compiler-rt checked out or integrated into their build.
  2283. if (getVFS().exists(P))
  2284. CmdArgs.push_back(Args.MakeArgString(P));
  2285. }
  2286. DerivedArgList *MachO::TranslateArgs(const DerivedArgList &Args,
  2287. StringRef BoundArch,
  2288. Action::OffloadKind) const {
  2289. DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
  2290. const OptTable &Opts = getDriver().getOpts();
  2291. // FIXME: We really want to get out of the tool chain level argument
  2292. // translation business, as it makes the driver functionality much
  2293. // more opaque. For now, we follow gcc closely solely for the
  2294. // purpose of easily achieving feature parity & testability. Once we
  2295. // have something that works, we should reevaluate each translation
  2296. // and try to push it down into tool specific logic.
  2297. for (Arg *A : Args) {
  2298. if (A->getOption().matches(options::OPT_Xarch__)) {
  2299. // Skip this argument unless the architecture matches either the toolchain
  2300. // triple arch, or the arch being bound.
  2301. StringRef XarchArch = A->getValue(0);
  2302. if (!(XarchArch == getArchName() ||
  2303. (!BoundArch.empty() && XarchArch == BoundArch)))
  2304. continue;
  2305. Arg *OriginalArg = A;
  2306. TranslateXarchArgs(Args, A, DAL);
  2307. // Linker input arguments require custom handling. The problem is that we
  2308. // have already constructed the phase actions, so we can not treat them as
  2309. // "input arguments".
  2310. if (A->getOption().hasFlag(options::LinkerInput)) {
  2311. // Convert the argument into individual Zlinker_input_args.
  2312. for (const char *Value : A->getValues()) {
  2313. DAL->AddSeparateArg(
  2314. OriginalArg, Opts.getOption(options::OPT_Zlinker_input), Value);
  2315. }
  2316. continue;
  2317. }
  2318. }
  2319. // Sob. These is strictly gcc compatible for the time being. Apple
  2320. // gcc translates options twice, which means that self-expanding
  2321. // options add duplicates.
  2322. switch ((options::ID)A->getOption().getID()) {
  2323. default:
  2324. DAL->append(A);
  2325. break;
  2326. case options::OPT_mkernel:
  2327. case options::OPT_fapple_kext:
  2328. DAL->append(A);
  2329. DAL->AddFlagArg(A, Opts.getOption(options::OPT_static));
  2330. break;
  2331. case options::OPT_dependency_file:
  2332. DAL->AddSeparateArg(A, Opts.getOption(options::OPT_MF), A->getValue());
  2333. break;
  2334. case options::OPT_gfull:
  2335. DAL->AddFlagArg(A, Opts.getOption(options::OPT_g_Flag));
  2336. DAL->AddFlagArg(
  2337. A, Opts.getOption(options::OPT_fno_eliminate_unused_debug_symbols));
  2338. break;
  2339. case options::OPT_gused:
  2340. DAL->AddFlagArg(A, Opts.getOption(options::OPT_g_Flag));
  2341. DAL->AddFlagArg(
  2342. A, Opts.getOption(options::OPT_feliminate_unused_debug_symbols));
  2343. break;
  2344. case options::OPT_shared:
  2345. DAL->AddFlagArg(A, Opts.getOption(options::OPT_dynamiclib));
  2346. break;
  2347. case options::OPT_fconstant_cfstrings:
  2348. DAL->AddFlagArg(A, Opts.getOption(options::OPT_mconstant_cfstrings));
  2349. break;
  2350. case options::OPT_fno_constant_cfstrings:
  2351. DAL->AddFlagArg(A, Opts.getOption(options::OPT_mno_constant_cfstrings));
  2352. break;
  2353. case options::OPT_Wnonportable_cfstrings:
  2354. DAL->AddFlagArg(A,
  2355. Opts.getOption(options::OPT_mwarn_nonportable_cfstrings));
  2356. break;
  2357. case options::OPT_Wno_nonportable_cfstrings:
  2358. DAL->AddFlagArg(
  2359. A, Opts.getOption(options::OPT_mno_warn_nonportable_cfstrings));
  2360. break;
  2361. }
  2362. }
  2363. // Add the arch options based on the particular spelling of -arch, to match
  2364. // how the driver works.
  2365. if (!BoundArch.empty()) {
  2366. StringRef Name = BoundArch;
  2367. const Option MCpu = Opts.getOption(options::OPT_mcpu_EQ);
  2368. const Option MArch = Opts.getOption(clang::driver::options::OPT_march_EQ);
  2369. // This code must be kept in sync with LLVM's getArchTypeForDarwinArch,
  2370. // which defines the list of which architectures we accept.
  2371. if (Name == "ppc")
  2372. ;
  2373. else if (Name == "ppc601")
  2374. DAL->AddJoinedArg(nullptr, MCpu, "601");
  2375. else if (Name == "ppc603")
  2376. DAL->AddJoinedArg(nullptr, MCpu, "603");
  2377. else if (Name == "ppc604")
  2378. DAL->AddJoinedArg(nullptr, MCpu, "604");
  2379. else if (Name == "ppc604e")
  2380. DAL->AddJoinedArg(nullptr, MCpu, "604e");
  2381. else if (Name == "ppc750")
  2382. DAL->AddJoinedArg(nullptr, MCpu, "750");
  2383. else if (Name == "ppc7400")
  2384. DAL->AddJoinedArg(nullptr, MCpu, "7400");
  2385. else if (Name == "ppc7450")
  2386. DAL->AddJoinedArg(nullptr, MCpu, "7450");
  2387. else if (Name == "ppc970")
  2388. DAL->AddJoinedArg(nullptr, MCpu, "970");
  2389. else if (Name == "ppc64" || Name == "ppc64le")
  2390. DAL->AddFlagArg(nullptr, Opts.getOption(options::OPT_m64));
  2391. else if (Name == "i386")
  2392. ;
  2393. else if (Name == "i486")
  2394. DAL->AddJoinedArg(nullptr, MArch, "i486");
  2395. else if (Name == "i586")
  2396. DAL->AddJoinedArg(nullptr, MArch, "i586");
  2397. else if (Name == "i686")
  2398. DAL->AddJoinedArg(nullptr, MArch, "i686");
  2399. else if (Name == "pentium")
  2400. DAL->AddJoinedArg(nullptr, MArch, "pentium");
  2401. else if (Name == "pentium2")
  2402. DAL->AddJoinedArg(nullptr, MArch, "pentium2");
  2403. else if (Name == "pentpro")
  2404. DAL->AddJoinedArg(nullptr, MArch, "pentiumpro");
  2405. else if (Name == "pentIIm3")
  2406. DAL->AddJoinedArg(nullptr, MArch, "pentium2");
  2407. else if (Name == "x86_64" || Name == "x86_64h")
  2408. DAL->AddFlagArg(nullptr, Opts.getOption(options::OPT_m64));
  2409. else if (Name == "arm")
  2410. DAL->AddJoinedArg(nullptr, MArch, "armv4t");
  2411. else if (Name == "armv4t")
  2412. DAL->AddJoinedArg(nullptr, MArch, "armv4t");
  2413. else if (Name == "armv5")
  2414. DAL->AddJoinedArg(nullptr, MArch, "armv5tej");
  2415. else if (Name == "xscale")
  2416. DAL->AddJoinedArg(nullptr, MArch, "xscale");
  2417. else if (Name == "armv6")
  2418. DAL->AddJoinedArg(nullptr, MArch, "armv6k");
  2419. else if (Name == "armv6m")
  2420. DAL->AddJoinedArg(nullptr, MArch, "armv6m");
  2421. else if (Name == "armv7")
  2422. DAL->AddJoinedArg(nullptr, MArch, "armv7a");
  2423. else if (Name == "armv7em")
  2424. DAL->AddJoinedArg(nullptr, MArch, "armv7em");
  2425. else if (Name == "armv7k")
  2426. DAL->AddJoinedArg(nullptr, MArch, "armv7k");
  2427. else if (Name == "armv7m")
  2428. DAL->AddJoinedArg(nullptr, MArch, "armv7m");
  2429. else if (Name == "armv7s")
  2430. DAL->AddJoinedArg(nullptr, MArch, "armv7s");
  2431. }
  2432. return DAL;
  2433. }
  2434. void MachO::AddLinkRuntimeLibArgs(const ArgList &Args,
  2435. ArgStringList &CmdArgs,
  2436. bool ForceLinkBuiltinRT) const {
  2437. // Embedded targets are simple at the moment, not supporting sanitizers and
  2438. // with different libraries for each member of the product { static, PIC } x
  2439. // { hard-float, soft-float }
  2440. llvm::SmallString<32> CompilerRT = StringRef("");
  2441. CompilerRT +=
  2442. (tools::arm::getARMFloatABI(*this, Args) == tools::arm::FloatABI::Hard)
  2443. ? "hard"
  2444. : "soft";
  2445. CompilerRT += Args.hasArg(options::OPT_fPIC) ? "_pic" : "_static";
  2446. AddLinkRuntimeLib(Args, CmdArgs, CompilerRT, RLO_IsEmbedded);
  2447. }
  2448. bool Darwin::isAlignedAllocationUnavailable() const {
  2449. llvm::Triple::OSType OS;
  2450. if (isTargetMacCatalyst())
  2451. return TargetVersion < alignedAllocMinVersion(llvm::Triple::MacOSX);
  2452. switch (TargetPlatform) {
  2453. case MacOS: // Earlier than 10.13.
  2454. OS = llvm::Triple::MacOSX;
  2455. break;
  2456. case IPhoneOS:
  2457. OS = llvm::Triple::IOS;
  2458. break;
  2459. case TvOS: // Earlier than 11.0.
  2460. OS = llvm::Triple::TvOS;
  2461. break;
  2462. case WatchOS: // Earlier than 4.0.
  2463. OS = llvm::Triple::WatchOS;
  2464. break;
  2465. case DriverKit: // Always available.
  2466. return false;
  2467. }
  2468. return TargetVersion < alignedAllocMinVersion(OS);
  2469. }
  2470. void Darwin::addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
  2471. llvm::opt::ArgStringList &CC1Args,
  2472. Action::OffloadKind DeviceOffloadKind) const {
  2473. // Pass "-faligned-alloc-unavailable" only when the user hasn't manually
  2474. // enabled or disabled aligned allocations.
  2475. if (!DriverArgs.hasArgNoClaim(options::OPT_faligned_allocation,
  2476. options::OPT_fno_aligned_allocation) &&
  2477. isAlignedAllocationUnavailable())
  2478. CC1Args.push_back("-faligned-alloc-unavailable");
  2479. addClangCC1ASTargetOptions(DriverArgs, CC1Args);
  2480. // Enable compatibility mode for NSItemProviderCompletionHandler in
  2481. // Foundation/NSItemProvider.h.
  2482. CC1Args.push_back("-fcompatibility-qualified-id-block-type-checking");
  2483. // Give static local variables in inline functions hidden visibility when
  2484. // -fvisibility-inlines-hidden is enabled.
  2485. if (!DriverArgs.getLastArgNoClaim(
  2486. options::OPT_fvisibility_inlines_hidden_static_local_var,
  2487. options::OPT_fno_visibility_inlines_hidden_static_local_var))
  2488. CC1Args.push_back("-fvisibility-inlines-hidden-static-local-var");
  2489. }
  2490. void Darwin::addClangCC1ASTargetOptions(
  2491. const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CC1ASArgs) const {
  2492. if (TargetVariantTriple) {
  2493. CC1ASArgs.push_back("-darwin-target-variant-triple");
  2494. CC1ASArgs.push_back(Args.MakeArgString(TargetVariantTriple->getTriple()));
  2495. }
  2496. if (SDKInfo) {
  2497. /// Pass the SDK version to the compiler when the SDK information is
  2498. /// available.
  2499. auto EmitTargetSDKVersionArg = [&](const VersionTuple &V) {
  2500. std::string Arg;
  2501. llvm::raw_string_ostream OS(Arg);
  2502. OS << "-target-sdk-version=" << V;
  2503. CC1ASArgs.push_back(Args.MakeArgString(OS.str()));
  2504. };
  2505. if (isTargetMacCatalyst()) {
  2506. if (const auto *MacOStoMacCatalystMapping = SDKInfo->getVersionMapping(
  2507. DarwinSDKInfo::OSEnvPair::macOStoMacCatalystPair())) {
  2508. std::optional<VersionTuple> SDKVersion = MacOStoMacCatalystMapping->map(
  2509. SDKInfo->getVersion(), minimumMacCatalystDeploymentTarget(),
  2510. std::nullopt);
  2511. EmitTargetSDKVersionArg(
  2512. SDKVersion ? *SDKVersion : minimumMacCatalystDeploymentTarget());
  2513. }
  2514. } else {
  2515. EmitTargetSDKVersionArg(SDKInfo->getVersion());
  2516. }
  2517. /// Pass the target variant SDK version to the compiler when the SDK
  2518. /// information is available and is required for target variant.
  2519. if (TargetVariantTriple) {
  2520. if (isTargetMacCatalyst()) {
  2521. std::string Arg;
  2522. llvm::raw_string_ostream OS(Arg);
  2523. OS << "-darwin-target-variant-sdk-version=" << SDKInfo->getVersion();
  2524. CC1ASArgs.push_back(Args.MakeArgString(OS.str()));
  2525. } else if (const auto *MacOStoMacCatalystMapping =
  2526. SDKInfo->getVersionMapping(
  2527. DarwinSDKInfo::OSEnvPair::macOStoMacCatalystPair())) {
  2528. if (std::optional<VersionTuple> SDKVersion =
  2529. MacOStoMacCatalystMapping->map(
  2530. SDKInfo->getVersion(), minimumMacCatalystDeploymentTarget(),
  2531. std::nullopt)) {
  2532. std::string Arg;
  2533. llvm::raw_string_ostream OS(Arg);
  2534. OS << "-darwin-target-variant-sdk-version=" << *SDKVersion;
  2535. CC1ASArgs.push_back(Args.MakeArgString(OS.str()));
  2536. }
  2537. }
  2538. }
  2539. }
  2540. }
  2541. DerivedArgList *
  2542. Darwin::TranslateArgs(const DerivedArgList &Args, StringRef BoundArch,
  2543. Action::OffloadKind DeviceOffloadKind) const {
  2544. // First get the generic Apple args, before moving onto Darwin-specific ones.
  2545. DerivedArgList *DAL =
  2546. MachO::TranslateArgs(Args, BoundArch, DeviceOffloadKind);
  2547. // If no architecture is bound, none of the translations here are relevant.
  2548. if (BoundArch.empty())
  2549. return DAL;
  2550. // Add an explicit version min argument for the deployment target. We do this
  2551. // after argument translation because -Xarch_ arguments may add a version min
  2552. // argument.
  2553. AddDeploymentTarget(*DAL);
  2554. // For iOS 6, undo the translation to add -static for -mkernel/-fapple-kext.
  2555. // FIXME: It would be far better to avoid inserting those -static arguments,
  2556. // but we can't check the deployment target in the translation code until
  2557. // it is set here.
  2558. if (isTargetWatchOSBased() || isTargetDriverKit() ||
  2559. (isTargetIOSBased() && !isIPhoneOSVersionLT(6, 0))) {
  2560. for (ArgList::iterator it = DAL->begin(), ie = DAL->end(); it != ie; ) {
  2561. Arg *A = *it;
  2562. ++it;
  2563. if (A->getOption().getID() != options::OPT_mkernel &&
  2564. A->getOption().getID() != options::OPT_fapple_kext)
  2565. continue;
  2566. assert(it != ie && "unexpected argument translation");
  2567. A = *it;
  2568. assert(A->getOption().getID() == options::OPT_static &&
  2569. "missing expected -static argument");
  2570. *it = nullptr;
  2571. ++it;
  2572. }
  2573. }
  2574. auto Arch = tools::darwin::getArchTypeForMachOArchName(BoundArch);
  2575. if ((Arch == llvm::Triple::arm || Arch == llvm::Triple::thumb)) {
  2576. if (Args.hasFlag(options::OPT_fomit_frame_pointer,
  2577. options::OPT_fno_omit_frame_pointer, false))
  2578. getDriver().Diag(clang::diag::warn_drv_unsupported_opt_for_target)
  2579. << "-fomit-frame-pointer" << BoundArch;
  2580. }
  2581. return DAL;
  2582. }
  2583. ToolChain::UnwindTableLevel MachO::getDefaultUnwindTableLevel(const ArgList &Args) const {
  2584. // Unwind tables are not emitted if -fno-exceptions is supplied (except when
  2585. // targeting x86_64).
  2586. if (getArch() == llvm::Triple::x86_64 ||
  2587. (GetExceptionModel(Args) != llvm::ExceptionHandling::SjLj &&
  2588. Args.hasFlag(options::OPT_fexceptions, options::OPT_fno_exceptions,
  2589. true)))
  2590. return getArch() == llvm::Triple::aarch64 ? UnwindTableLevel::Synchronous
  2591. : UnwindTableLevel::Asynchronous;
  2592. return UnwindTableLevel::None;
  2593. }
  2594. bool MachO::UseDwarfDebugFlags() const {
  2595. if (const char *S = ::getenv("RC_DEBUG_OPTIONS"))
  2596. return S[0] != '\0';
  2597. return false;
  2598. }
  2599. std::string MachO::GetGlobalDebugPathRemapping() const {
  2600. if (const char *S = ::getenv("RC_DEBUG_PREFIX_MAP"))
  2601. return S;
  2602. return {};
  2603. }
  2604. llvm::ExceptionHandling Darwin::GetExceptionModel(const ArgList &Args) const {
  2605. // Darwin uses SjLj exceptions on ARM.
  2606. if (getTriple().getArch() != llvm::Triple::arm &&
  2607. getTriple().getArch() != llvm::Triple::thumb)
  2608. return llvm::ExceptionHandling::None;
  2609. // Only watchOS uses the new DWARF/Compact unwinding method.
  2610. llvm::Triple Triple(ComputeLLVMTriple(Args));
  2611. if (Triple.isWatchABI())
  2612. return llvm::ExceptionHandling::DwarfCFI;
  2613. return llvm::ExceptionHandling::SjLj;
  2614. }
  2615. bool Darwin::SupportsEmbeddedBitcode() const {
  2616. assert(TargetInitialized && "Target not initialized!");
  2617. if (isTargetIPhoneOS() && isIPhoneOSVersionLT(6, 0))
  2618. return false;
  2619. return true;
  2620. }
  2621. bool MachO::isPICDefault() const { return true; }
  2622. bool MachO::isPIEDefault(const llvm::opt::ArgList &Args) const { return false; }
  2623. bool MachO::isPICDefaultForced() const {
  2624. return (getArch() == llvm::Triple::x86_64 ||
  2625. getArch() == llvm::Triple::aarch64);
  2626. }
  2627. bool MachO::SupportsProfiling() const {
  2628. // Profiling instrumentation is only supported on x86.
  2629. return getTriple().isX86();
  2630. }
  2631. void Darwin::addMinVersionArgs(const ArgList &Args,
  2632. ArgStringList &CmdArgs) const {
  2633. VersionTuple TargetVersion = getTripleTargetVersion();
  2634. if (isTargetWatchOS())
  2635. CmdArgs.push_back("-watchos_version_min");
  2636. else if (isTargetWatchOSSimulator())
  2637. CmdArgs.push_back("-watchos_simulator_version_min");
  2638. else if (isTargetTvOS())
  2639. CmdArgs.push_back("-tvos_version_min");
  2640. else if (isTargetTvOSSimulator())
  2641. CmdArgs.push_back("-tvos_simulator_version_min");
  2642. else if (isTargetDriverKit())
  2643. CmdArgs.push_back("-driverkit_version_min");
  2644. else if (isTargetIOSSimulator())
  2645. CmdArgs.push_back("-ios_simulator_version_min");
  2646. else if (isTargetIOSBased())
  2647. CmdArgs.push_back("-iphoneos_version_min");
  2648. else if (isTargetMacCatalyst())
  2649. CmdArgs.push_back("-maccatalyst_version_min");
  2650. else {
  2651. assert(isTargetMacOS() && "unexpected target");
  2652. CmdArgs.push_back("-macosx_version_min");
  2653. }
  2654. VersionTuple MinTgtVers = getEffectiveTriple().getMinimumSupportedOSVersion();
  2655. if (!MinTgtVers.empty() && MinTgtVers > TargetVersion)
  2656. TargetVersion = MinTgtVers;
  2657. CmdArgs.push_back(Args.MakeArgString(TargetVersion.getAsString()));
  2658. if (TargetVariantTriple) {
  2659. assert(isTargetMacOSBased() && "unexpected target");
  2660. VersionTuple VariantTargetVersion;
  2661. if (TargetVariantTriple->isMacOSX()) {
  2662. CmdArgs.push_back("-macosx_version_min");
  2663. TargetVariantTriple->getMacOSXVersion(VariantTargetVersion);
  2664. } else {
  2665. assert(TargetVariantTriple->isiOS() &&
  2666. TargetVariantTriple->isMacCatalystEnvironment() &&
  2667. "unexpected target variant triple");
  2668. CmdArgs.push_back("-maccatalyst_version_min");
  2669. VariantTargetVersion = TargetVariantTriple->getiOSVersion();
  2670. }
  2671. VersionTuple MinTgtVers =
  2672. TargetVariantTriple->getMinimumSupportedOSVersion();
  2673. if (MinTgtVers.getMajor() && MinTgtVers > VariantTargetVersion)
  2674. VariantTargetVersion = MinTgtVers;
  2675. CmdArgs.push_back(Args.MakeArgString(VariantTargetVersion.getAsString()));
  2676. }
  2677. }
  2678. static const char *getPlatformName(Darwin::DarwinPlatformKind Platform,
  2679. Darwin::DarwinEnvironmentKind Environment) {
  2680. switch (Platform) {
  2681. case Darwin::MacOS:
  2682. return "macos";
  2683. case Darwin::IPhoneOS:
  2684. if (Environment == Darwin::MacCatalyst)
  2685. return "mac catalyst";
  2686. return "ios";
  2687. case Darwin::TvOS:
  2688. return "tvos";
  2689. case Darwin::WatchOS:
  2690. return "watchos";
  2691. case Darwin::DriverKit:
  2692. return "driverkit";
  2693. }
  2694. llvm_unreachable("invalid platform");
  2695. }
  2696. void Darwin::addPlatformVersionArgs(const llvm::opt::ArgList &Args,
  2697. llvm::opt::ArgStringList &CmdArgs) const {
  2698. auto EmitPlatformVersionArg =
  2699. [&](const VersionTuple &TV, Darwin::DarwinPlatformKind TargetPlatform,
  2700. Darwin::DarwinEnvironmentKind TargetEnvironment,
  2701. const llvm::Triple &TT) {
  2702. // -platform_version <platform> <target_version> <sdk_version>
  2703. // Both the target and SDK version support only up to 3 components.
  2704. CmdArgs.push_back("-platform_version");
  2705. std::string PlatformName =
  2706. getPlatformName(TargetPlatform, TargetEnvironment);
  2707. if (TargetEnvironment == Darwin::Simulator)
  2708. PlatformName += "-simulator";
  2709. CmdArgs.push_back(Args.MakeArgString(PlatformName));
  2710. VersionTuple TargetVersion = TV.withoutBuild();
  2711. if ((TargetPlatform == Darwin::IPhoneOS ||
  2712. TargetPlatform == Darwin::TvOS) &&
  2713. getTriple().getArchName() == "arm64e" &&
  2714. TargetVersion.getMajor() < 14) {
  2715. // arm64e slice is supported on iOS/tvOS 14+ only.
  2716. TargetVersion = VersionTuple(14, 0);
  2717. }
  2718. VersionTuple MinTgtVers = TT.getMinimumSupportedOSVersion();
  2719. if (!MinTgtVers.empty() && MinTgtVers > TargetVersion)
  2720. TargetVersion = MinTgtVers;
  2721. CmdArgs.push_back(Args.MakeArgString(TargetVersion.getAsString()));
  2722. if (TargetPlatform == IPhoneOS && TargetEnvironment == MacCatalyst) {
  2723. // Mac Catalyst programs must use the appropriate iOS SDK version
  2724. // that corresponds to the macOS SDK version used for the compilation.
  2725. std::optional<VersionTuple> iOSSDKVersion;
  2726. if (SDKInfo) {
  2727. if (const auto *MacOStoMacCatalystMapping =
  2728. SDKInfo->getVersionMapping(
  2729. DarwinSDKInfo::OSEnvPair::macOStoMacCatalystPair())) {
  2730. iOSSDKVersion = MacOStoMacCatalystMapping->map(
  2731. SDKInfo->getVersion().withoutBuild(),
  2732. minimumMacCatalystDeploymentTarget(), std::nullopt);
  2733. }
  2734. }
  2735. CmdArgs.push_back(Args.MakeArgString(
  2736. (iOSSDKVersion ? *iOSSDKVersion
  2737. : minimumMacCatalystDeploymentTarget())
  2738. .getAsString()));
  2739. return;
  2740. }
  2741. if (SDKInfo) {
  2742. VersionTuple SDKVersion = SDKInfo->getVersion().withoutBuild();
  2743. if (!SDKVersion.getMinor())
  2744. SDKVersion = VersionTuple(SDKVersion.getMajor(), 0);
  2745. CmdArgs.push_back(Args.MakeArgString(SDKVersion.getAsString()));
  2746. } else {
  2747. // Use an SDK version that's matching the deployment target if the SDK
  2748. // version is missing. This is preferred over an empty SDK version
  2749. // (0.0.0) as the system's runtime might expect the linked binary to
  2750. // contain a valid SDK version in order for the binary to work
  2751. // correctly. It's reasonable to use the deployment target version as
  2752. // a proxy for the SDK version because older SDKs don't guarantee
  2753. // support for deployment targets newer than the SDK versions, so that
  2754. // rules out using some predetermined older SDK version, which leaves
  2755. // the deployment target version as the only reasonable choice.
  2756. CmdArgs.push_back(Args.MakeArgString(TargetVersion.getAsString()));
  2757. }
  2758. };
  2759. EmitPlatformVersionArg(getTripleTargetVersion(), TargetPlatform,
  2760. TargetEnvironment, getEffectiveTriple());
  2761. if (!TargetVariantTriple)
  2762. return;
  2763. Darwin::DarwinPlatformKind Platform;
  2764. Darwin::DarwinEnvironmentKind Environment;
  2765. VersionTuple TargetVariantVersion;
  2766. if (TargetVariantTriple->isMacOSX()) {
  2767. TargetVariantTriple->getMacOSXVersion(TargetVariantVersion);
  2768. Platform = Darwin::MacOS;
  2769. Environment = Darwin::NativeEnvironment;
  2770. } else {
  2771. assert(TargetVariantTriple->isiOS() &&
  2772. TargetVariantTriple->isMacCatalystEnvironment() &&
  2773. "unexpected target variant triple");
  2774. TargetVariantVersion = TargetVariantTriple->getiOSVersion();
  2775. Platform = Darwin::IPhoneOS;
  2776. Environment = Darwin::MacCatalyst;
  2777. }
  2778. EmitPlatformVersionArg(TargetVariantVersion, Platform, Environment,
  2779. *TargetVariantTriple);
  2780. }
  2781. // Add additional link args for the -dynamiclib option.
  2782. static void addDynamicLibLinkArgs(const Darwin &D, const ArgList &Args,
  2783. ArgStringList &CmdArgs) {
  2784. // Derived from darwin_dylib1 spec.
  2785. if (D.isTargetIPhoneOS()) {
  2786. if (D.isIPhoneOSVersionLT(3, 1))
  2787. CmdArgs.push_back("-ldylib1.o");
  2788. return;
  2789. }
  2790. if (!D.isTargetMacOS())
  2791. return;
  2792. if (D.isMacosxVersionLT(10, 5))
  2793. CmdArgs.push_back("-ldylib1.o");
  2794. else if (D.isMacosxVersionLT(10, 6))
  2795. CmdArgs.push_back("-ldylib1.10.5.o");
  2796. }
  2797. // Add additional link args for the -bundle option.
  2798. static void addBundleLinkArgs(const Darwin &D, const ArgList &Args,
  2799. ArgStringList &CmdArgs) {
  2800. if (Args.hasArg(options::OPT_static))
  2801. return;
  2802. // Derived from darwin_bundle1 spec.
  2803. if ((D.isTargetIPhoneOS() && D.isIPhoneOSVersionLT(3, 1)) ||
  2804. (D.isTargetMacOS() && D.isMacosxVersionLT(10, 6)))
  2805. CmdArgs.push_back("-lbundle1.o");
  2806. }
  2807. // Add additional link args for the -pg option.
  2808. static void addPgProfilingLinkArgs(const Darwin &D, const ArgList &Args,
  2809. ArgStringList &CmdArgs) {
  2810. if (D.isTargetMacOS() && D.isMacosxVersionLT(10, 9)) {
  2811. if (Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_object) ||
  2812. Args.hasArg(options::OPT_preload)) {
  2813. CmdArgs.push_back("-lgcrt0.o");
  2814. } else {
  2815. CmdArgs.push_back("-lgcrt1.o");
  2816. // darwin_crt2 spec is empty.
  2817. }
  2818. // By default on OS X 10.8 and later, we don't link with a crt1.o
  2819. // file and the linker knows to use _main as the entry point. But,
  2820. // when compiling with -pg, we need to link with the gcrt1.o file,
  2821. // so pass the -no_new_main option to tell the linker to use the
  2822. // "start" symbol as the entry point.
  2823. if (!D.isMacosxVersionLT(10, 8))
  2824. CmdArgs.push_back("-no_new_main");
  2825. } else {
  2826. D.getDriver().Diag(diag::err_drv_clang_unsupported_opt_pg_darwin)
  2827. << D.isTargetMacOSBased();
  2828. }
  2829. }
  2830. static void addDefaultCRTLinkArgs(const Darwin &D, const ArgList &Args,
  2831. ArgStringList &CmdArgs) {
  2832. // Derived from darwin_crt1 spec.
  2833. if (D.isTargetIPhoneOS()) {
  2834. if (D.getArch() == llvm::Triple::aarch64)
  2835. ; // iOS does not need any crt1 files for arm64
  2836. else if (D.isIPhoneOSVersionLT(3, 1))
  2837. CmdArgs.push_back("-lcrt1.o");
  2838. else if (D.isIPhoneOSVersionLT(6, 0))
  2839. CmdArgs.push_back("-lcrt1.3.1.o");
  2840. return;
  2841. }
  2842. if (!D.isTargetMacOS())
  2843. return;
  2844. if (D.isMacosxVersionLT(10, 5))
  2845. CmdArgs.push_back("-lcrt1.o");
  2846. else if (D.isMacosxVersionLT(10, 6))
  2847. CmdArgs.push_back("-lcrt1.10.5.o");
  2848. else if (D.isMacosxVersionLT(10, 8))
  2849. CmdArgs.push_back("-lcrt1.10.6.o");
  2850. // darwin_crt2 spec is empty.
  2851. }
  2852. void Darwin::addStartObjectFileArgs(const ArgList &Args,
  2853. ArgStringList &CmdArgs) const {
  2854. // Derived from startfile spec.
  2855. if (Args.hasArg(options::OPT_dynamiclib))
  2856. addDynamicLibLinkArgs(*this, Args, CmdArgs);
  2857. else if (Args.hasArg(options::OPT_bundle))
  2858. addBundleLinkArgs(*this, Args, CmdArgs);
  2859. else if (Args.hasArg(options::OPT_pg) && SupportsProfiling())
  2860. addPgProfilingLinkArgs(*this, Args, CmdArgs);
  2861. else if (Args.hasArg(options::OPT_static) ||
  2862. Args.hasArg(options::OPT_object) ||
  2863. Args.hasArg(options::OPT_preload))
  2864. CmdArgs.push_back("-lcrt0.o");
  2865. else
  2866. addDefaultCRTLinkArgs(*this, Args, CmdArgs);
  2867. if (isTargetMacOS() && Args.hasArg(options::OPT_shared_libgcc) &&
  2868. isMacosxVersionLT(10, 5)) {
  2869. const char *Str = Args.MakeArgString(GetFilePath("crt3.o"));
  2870. CmdArgs.push_back(Str);
  2871. }
  2872. }
  2873. void Darwin::CheckObjCARC() const {
  2874. if (isTargetIOSBased() || isTargetWatchOSBased() ||
  2875. (isTargetMacOSBased() && !isMacosxVersionLT(10, 6)))
  2876. return;
  2877. getDriver().Diag(diag::err_arc_unsupported_on_toolchain);
  2878. }
  2879. SanitizerMask Darwin::getSupportedSanitizers() const {
  2880. const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
  2881. const bool IsAArch64 = getTriple().getArch() == llvm::Triple::aarch64;
  2882. SanitizerMask Res = ToolChain::getSupportedSanitizers();
  2883. Res |= SanitizerKind::Address;
  2884. Res |= SanitizerKind::PointerCompare;
  2885. Res |= SanitizerKind::PointerSubtract;
  2886. Res |= SanitizerKind::Leak;
  2887. Res |= SanitizerKind::Fuzzer;
  2888. Res |= SanitizerKind::FuzzerNoLink;
  2889. Res |= SanitizerKind::Function;
  2890. Res |= SanitizerKind::ObjCCast;
  2891. // Prior to 10.9, macOS shipped a version of the C++ standard library without
  2892. // C++11 support. The same is true of iOS prior to version 5. These OS'es are
  2893. // incompatible with -fsanitize=vptr.
  2894. if (!(isTargetMacOSBased() && isMacosxVersionLT(10, 9)) &&
  2895. !(isTargetIPhoneOS() && isIPhoneOSVersionLT(5, 0)))
  2896. Res |= SanitizerKind::Vptr;
  2897. if ((IsX86_64 || IsAArch64) &&
  2898. (isTargetMacOSBased() || isTargetIOSSimulator() ||
  2899. isTargetTvOSSimulator() || isTargetWatchOSSimulator())) {
  2900. Res |= SanitizerKind::Thread;
  2901. }
  2902. return Res;
  2903. }
  2904. void Darwin::printVerboseInfo(raw_ostream &OS) const {
  2905. CudaInstallation.print(OS);
  2906. RocmInstallation.print(OS);
  2907. }