//===--- Darwin.h - Darwin ToolChain Implementations ------------*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_DARWIN_H

#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_DARWIN_H

#include "Cuda.h"

#include "ROCm.h"

#include "clang/Basic/DarwinSDKInfo.h"

#include "clang/Basic/LangOptions.h"

#include "clang/Driver/Tool.h"

#include "clang/Driver/ToolChain.h"

#include "clang/Driver/XRayArgs.h"

namespace clang {

namespace driver {

namespace toolchains {

class MachO;

} // end namespace toolchains

namespace tools {

namespace darwin {

llvm::Triple::ArchType getArchTypeForMachOArchName(StringRef Str);

void setTripleTypeForMachOArchName(llvm::Triple &T, StringRef Str,

                                   const llvm::opt::ArgList &Args);

class LLVM_LIBRARY_VISIBILITY MachOTool : public Tool {

  virtual void anchor();

protected:

  void AddMachOArch(const llvm::opt::ArgList &Args,

                    llvm::opt::ArgStringList &CmdArgs) const;

  const toolchains::MachO &getMachOToolChain() const {

    return reinterpret_cast<const toolchains::MachO &>(getToolChain());

  }

public:

  MachOTool(const char *Name, const char *ShortName, const ToolChain &TC)

      : Tool(Name, ShortName, TC) {}

};

class LLVM_LIBRARY_VISIBILITY Assembler : public MachOTool {

public:

  Assembler(const ToolChain &TC)

      : MachOTool("darwin::Assembler", "assembler", TC) {}

  bool hasIntegratedCPP() const override { return false; }

  void ConstructJob(Compilation &C, const JobAction &JA,

                    const InputInfo &Output, const InputInfoList &Inputs,

                    const llvm::opt::ArgList &TCArgs,

                    const char *LinkingOutput) const override;

};

class LLVM_LIBRARY_VISIBILITY Linker : public MachOTool {

  bool NeedsTempPath(const InputInfoList &Inputs) const;

  void AddLinkArgs(Compilation &C, const llvm::opt::ArgList &Args,

                   llvm::opt::ArgStringList &CmdArgs,

                   const InputInfoList &Inputs, VersionTuple Version,

                   bool LinkerIsLLD) const;

public:

  Linker(const ToolChain &TC) : MachOTool("darwin::Linker", "linker", TC) {}

  bool hasIntegratedCPP() const override { return false; }

  bool isLinkJob() const override { return true; }

  void ConstructJob(Compilation &C, const JobAction &JA,

                    const InputInfo &Output, const InputInfoList &Inputs,

                    const llvm::opt::ArgList &TCArgs,

                    const char *LinkingOutput) const override;

};

class LLVM_LIBRARY_VISIBILITY StaticLibTool : public MachOTool {

public:

  StaticLibTool(const ToolChain &TC)

      : MachOTool("darwin::StaticLibTool", "static-lib-linker", TC) {}

  bool hasIntegratedCPP() const override { return false; }

  bool isLinkJob() const override { return true; }

  void ConstructJob(Compilation &C, const JobAction &JA,

                    const InputInfo &Output, const InputInfoList &Inputs,

                    const llvm::opt::ArgList &TCArgs,

                    const char *LinkingOutput) const override;

};

class LLVM_LIBRARY_VISIBILITY Lipo : public MachOTool {

public:

  Lipo(const ToolChain &TC) : MachOTool("darwin::Lipo", "lipo", TC) {}

  bool hasIntegratedCPP() const override { return false; }

  void ConstructJob(Compilation &C, const JobAction &JA,

                    const InputInfo &Output, const InputInfoList &Inputs,

                    const llvm::opt::ArgList &TCArgs,

                    const char *LinkingOutput) const override;

};

class LLVM_LIBRARY_VISIBILITY Dsymutil : public MachOTool {

public:

  Dsymutil(const ToolChain &TC)

      : MachOTool("darwin::Dsymutil", "dsymutil", TC) {}

  bool hasIntegratedCPP() const override { return false; }

  bool isDsymutilJob() const override { return true; }

  void ConstructJob(Compilation &C, const JobAction &JA,

                    const InputInfo &Output, const InputInfoList &Inputs,

                    const llvm::opt::ArgList &TCArgs,

                    const char *LinkingOutput) const override;

};

class LLVM_LIBRARY_VISIBILITY VerifyDebug : public MachOTool {

public:

  VerifyDebug(const ToolChain &TC)

      : MachOTool("darwin::VerifyDebug", "dwarfdump", TC) {}

  bool hasIntegratedCPP() const override { return false; }

  void ConstructJob(Compilation &C, const JobAction &JA,

                    const InputInfo &Output, const InputInfoList &Inputs,

                    const llvm::opt::ArgList &TCArgs,

                    const char *LinkingOutput) const override;

};

} // end namespace darwin

} // end namespace tools

namespace toolchains {

class LLVM_LIBRARY_VISIBILITY MachO : public ToolChain {

protected:

  Tool *buildAssembler() const override;

  Tool *buildLinker() const override;

  Tool *buildStaticLibTool() const override;

  Tool *getTool(Action::ActionClass AC) const override;

private:

  mutable std::unique_ptr<tools::darwin::Lipo> Lipo;

  mutable std::unique_ptr<tools::darwin::Dsymutil> Dsymutil;

  mutable std::unique_ptr<tools::darwin::VerifyDebug> VerifyDebug;

  /// The version of the linker known to be available in the tool chain.

  mutable std::optional<VersionTuple> LinkerVersion;

public:

  MachO(const Driver &D, const llvm::Triple &Triple,

        const llvm::opt::ArgList &Args);

  ~MachO() override;

  /// @name MachO specific toolchain API

  /// {

  /// Get the "MachO" arch name for a particular compiler invocation. For

  /// example, Apple treats different ARM variations as distinct architectures.

  StringRef getMachOArchName(const llvm::opt::ArgList &Args) const;

  /// Get the version of the linker known to be available for a particular

  /// compiler invocation (via the `-mlinker-version=` arg).

  VersionTuple getLinkerVersion(const llvm::opt::ArgList &Args) const;

  /// Add the linker arguments to link the ARC runtime library.

  virtual void AddLinkARCArgs(const llvm::opt::ArgList &Args,

                              llvm::opt::ArgStringList &CmdArgs) const {}

  /// Add the linker arguments to link the compiler runtime library.

  ///

  /// FIXME: This API is intended for use with embedded libraries only, and is

  /// misleadingly named.

  virtual void AddLinkRuntimeLibArgs(const llvm::opt::ArgList &Args,

                                     llvm::opt::ArgStringList &CmdArgs,

                                     bool ForceLinkBuiltinRT = false) const;

  virtual void addStartObjectFileArgs(const llvm::opt::ArgList &Args,

                                      llvm::opt::ArgStringList &CmdArgs) const {

  }

  virtual void addMinVersionArgs(const llvm::opt::ArgList &Args,

                                 llvm::opt::ArgStringList &CmdArgs) const {}

  virtual void addPlatformVersionArgs(const llvm::opt::ArgList &Args,

                                      llvm::opt::ArgStringList &CmdArgs) const {

  }

  /// On some iOS platforms, kernel and kernel modules were built statically. Is

  /// this such a target?

  virtual bool isKernelStatic() const { return false; }

  /// Is the target either iOS or an iOS simulator?

  bool isTargetIOSBased() const { return false; }

  /// Options to control how a runtime library is linked.

  enum RuntimeLinkOptions : unsigned {

    /// Link the library in even if it can't be found in the VFS.

    RLO_AlwaysLink = 1 << 0,

    /// Use the embedded runtime from the macho_embedded directory.

    RLO_IsEmbedded = 1 << 1,

    /// Emit rpaths for @executable_path as well as the resource directory.

    RLO_AddRPath = 1 << 2,

  };

  /// Add a runtime library to the list of items to link.

  void AddLinkRuntimeLib(const llvm::opt::ArgList &Args,

                         llvm::opt::ArgStringList &CmdArgs, StringRef Component,

                         RuntimeLinkOptions Opts = RuntimeLinkOptions(),

                         bool IsShared = false) const;

  /// Add any profiling runtime libraries that are needed. This is essentially a

  /// MachO specific version of addProfileRT in Tools.cpp.

  void addProfileRTLibs(const llvm::opt::ArgList &Args,

                        llvm::opt::ArgStringList &CmdArgs) const override {

    // There aren't any profiling libs for embedded targets currently.

  }

  /// }

  /// @name ToolChain Implementation

  /// {

  types::ID LookupTypeForExtension(StringRef Ext) const override;

  bool HasNativeLLVMSupport() const override;

  llvm::opt::DerivedArgList *

  TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,

                Action::OffloadKind DeviceOffloadKind) const override;

  bool IsBlocksDefault() const override {

    // Always allow blocks on Apple; users interested in versioning are

    // expected to use /usr/include/Block.h.

    return true;

  }

  bool IsMathErrnoDefault() const override { return false; }

  bool IsEncodeExtendedBlockSignatureDefault() const override { return true; }

  bool IsObjCNonFragileABIDefault() const override {

    // Non-fragile ABI is default for everything but i386.

    return getTriple().getArch() != llvm::Triple::x86;

  }

  bool UseObjCMixedDispatch() const override { return true; }

  UnwindTableLevel

  getDefaultUnwindTableLevel(const llvm::opt::ArgList &Args) const override;

  RuntimeLibType GetDefaultRuntimeLibType() const override {

    return ToolChain::RLT_CompilerRT;

  }

  bool isPICDefault() const override;

  bool isPIEDefault(const llvm::opt::ArgList &Args) const override;

  bool isPICDefaultForced() const override;

  bool SupportsProfiling() const override;

  bool UseDwarfDebugFlags() const override;

  std::string GetGlobalDebugPathRemapping() const override;

  llvm::ExceptionHandling

  GetExceptionModel(const llvm::opt::ArgList &Args) const override {

    return llvm::ExceptionHandling::None;

  }

  virtual StringRef getOSLibraryNameSuffix(bool IgnoreSim = false) const {

    return "";

  }

  // Darwin toolchain uses legacy thin LTO API, which is not

  // capable of unit splitting.

  bool canSplitThinLTOUnit() const override { return false; }

  /// }

};

/// Darwin - The base Darwin tool chain.

class LLVM_LIBRARY_VISIBILITY Darwin : public MachO {

public:

  /// Whether the information on the target has been initialized.

  //

  // FIXME: This should be eliminated. What we want to do is make this part of

  // the "default target for arguments" selection process, once we get out of

  // the argument translation business.

  mutable bool TargetInitialized;

  enum DarwinPlatformKind {

    MacOS,

    IPhoneOS,

    TvOS,

    WatchOS,

    DriverKit,

    LastDarwinPlatform = DriverKit

  };

  enum DarwinEnvironmentKind {

    NativeEnvironment,

    Simulator,

    MacCatalyst,

  };

  mutable DarwinPlatformKind TargetPlatform;

  mutable DarwinEnvironmentKind TargetEnvironment;

  /// The native OS version we are targeting.

  mutable VersionTuple TargetVersion;

  /// The OS version we are targeting as specified in the triple.

  mutable VersionTuple OSTargetVersion;

  /// The information about the darwin SDK that was used.

  mutable std::optional<DarwinSDKInfo> SDKInfo;

  /// The target variant triple that was specified (if any).

  mutable std::optional<llvm::Triple> TargetVariantTriple;

  CudaInstallationDetector CudaInstallation;

  RocmInstallationDetector RocmInstallation;

private:

  void AddDeploymentTarget(llvm::opt::DerivedArgList &Args) const;

public:

  Darwin(const Driver &D, const llvm::Triple &Triple,

         const llvm::opt::ArgList &Args);

  ~Darwin() override;

  std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args,

                                          types::ID InputType) const override;

  /// @name Apple Specific Toolchain Implementation

  /// {

  void addMinVersionArgs(const llvm::opt::ArgList &Args,

                         llvm::opt::ArgStringList &CmdArgs) const override;

  void addPlatformVersionArgs(const llvm::opt::ArgList &Args,

                              llvm::opt::ArgStringList &CmdArgs) const override;

  void addStartObjectFileArgs(const llvm::opt::ArgList &Args,

                              llvm::opt::ArgStringList &CmdArgs) const override;

  bool isKernelStatic() const override {

    return (!(isTargetIPhoneOS() && !isIPhoneOSVersionLT(6, 0)) &&

            !isTargetWatchOS() && !isTargetDriverKit());

  }

  void addProfileRTLibs(const llvm::opt::ArgList &Args,

                        llvm::opt::ArgStringList &CmdArgs) const override;

protected:

  /// }

  /// @name Darwin specific Toolchain functions

  /// {

  // FIXME: Eliminate these ...Target functions and derive separate tool chains

  // for these targets and put version in constructor.

  void setTarget(DarwinPlatformKind Platform, DarwinEnvironmentKind Environment,

                 unsigned Major, unsigned Minor, unsigned Micro,

                 VersionTuple NativeTargetVersion) const {

    // FIXME: For now, allow reinitialization as long as values don't

    // change. This will go away when we move away from argument translation.

    if (TargetInitialized && TargetPlatform == Platform &&

        TargetEnvironment == Environment &&

        (Environment == MacCatalyst ? OSTargetVersion : TargetVersion) ==

            VersionTuple(Major, Minor, Micro))

      return;

    assert(!TargetInitialized && "Target already initialized!");

    TargetInitialized = true;

    TargetPlatform = Platform;

    TargetEnvironment = Environment;

    TargetVersion = VersionTuple(Major, Minor, Micro);

    if (Environment == Simulator)

      const_cast<Darwin *>(this)->setTripleEnvironment(llvm::Triple::Simulator);

    else if (Environment == MacCatalyst) {

      const_cast<Darwin *>(this)->setTripleEnvironment(llvm::Triple::MacABI);

      TargetVersion = NativeTargetVersion;

      OSTargetVersion = VersionTuple(Major, Minor, Micro);

    }

  }

public:

  bool isTargetIPhoneOS() const {

    assert(TargetInitialized && "Target not initialized!");

    return (TargetPlatform == IPhoneOS || TargetPlatform == TvOS) &&

           TargetEnvironment == NativeEnvironment;

  }

  bool isTargetIOSSimulator() const {

    assert(TargetInitialized && "Target not initialized!");

    return (TargetPlatform == IPhoneOS || TargetPlatform == TvOS) &&

           TargetEnvironment == Simulator;

  }

  bool isTargetIOSBased() const {

    assert(TargetInitialized && "Target not initialized!");

    return isTargetIPhoneOS() || isTargetIOSSimulator();

  }

  bool isTargetTvOS() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == TvOS && TargetEnvironment == NativeEnvironment;

  }

  bool isTargetTvOSSimulator() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == TvOS && TargetEnvironment == Simulator;

  }

  bool isTargetTvOSBased() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == TvOS;

  }

  bool isTargetWatchOS() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == WatchOS && TargetEnvironment == NativeEnvironment;

  }

  bool isTargetWatchOSSimulator() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == WatchOS && TargetEnvironment == Simulator;

  }

  bool isTargetWatchOSBased() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == WatchOS;

  }

  bool isTargetDriverKit() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == DriverKit;

  }

  bool isTargetMacCatalyst() const {

    return TargetPlatform == IPhoneOS && TargetEnvironment == MacCatalyst;

  }

  bool isTargetMacOS() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == MacOS;

  }

  bool isTargetMacOSBased() const {

    assert(TargetInitialized && "Target not initialized!");

    return TargetPlatform == MacOS || isTargetMacCatalyst();

  }

  bool isTargetAppleSiliconMac() const {

    assert(TargetInitialized && "Target not initialized!");

    return isTargetMacOSBased() && getArch() == llvm::Triple::aarch64;

  }

  bool isTargetInitialized() const { return TargetInitialized; }

  /// The version of the OS that's used by the OS specified in the target

  /// triple. It might be different from the actual target OS on which the

  /// program will run, e.g. MacCatalyst code runs on a macOS target, but its

  /// target triple is iOS.

  VersionTuple getTripleTargetVersion() const {

    assert(TargetInitialized && "Target not initialized!");

    return isTargetMacCatalyst() ? OSTargetVersion : TargetVersion;

  }

  bool isIPhoneOSVersionLT(unsigned V0, unsigned V1 = 0,

                           unsigned V2 = 0) const {

    assert(isTargetIOSBased() && "Unexpected call for non iOS target!");

    return TargetVersion < VersionTuple(V0, V1, V2);

  }

  /// Returns true if the minimum supported macOS version for the slice that's

  /// being built is less than the specified version. If there's no minimum

  /// supported macOS version, the deployment target version is compared to the

  /// specifed version instead.

  bool isMacosxVersionLT(unsigned V0, unsigned V1 = 0, unsigned V2 = 0) const {

    assert(isTargetMacOSBased() &&

           (getTriple().isMacOSX() || getTriple().isMacCatalystEnvironment()) &&

           "Unexpected call for non OS X target!");

    // The effective triple might not be initialized yet, so construct a

    // pseudo-effective triple to get the minimum supported OS version.

    VersionTuple MinVers =

        llvm::Triple(getTriple().getArchName(), "apple", "macos")

            .getMinimumSupportedOSVersion();

    return (!MinVers.empty() && MinVers > TargetVersion

                ? MinVers

                : TargetVersion) < VersionTuple(V0, V1, V2);

  }

protected:

  /// Return true if c++17 aligned allocation/deallocation functions are not

  /// implemented in the c++ standard library of the deployment target we are

  /// targeting.

  bool isAlignedAllocationUnavailable() const;

  void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,

                             llvm::opt::ArgStringList &CC1Args,

                             Action::OffloadKind DeviceOffloadKind) const override;

  void addClangCC1ASTargetOptions(

      const llvm::opt::ArgList &Args,

      llvm::opt::ArgStringList &CC1ASArgs) const override;

  StringRef getPlatformFamily() const;

  StringRef getOSLibraryNameSuffix(bool IgnoreSim = false) const override;

public:

  static StringRef getSDKName(StringRef isysroot);

  /// }

  /// @name ToolChain Implementation

  /// {

  // Darwin tools support multiple architecture (e.g., i386 and x86_64) and

  // most development is done against SDKs, so compiling for a different

  // architecture should not get any special treatment.

  bool isCrossCompiling() const override { return false; }

  llvm::opt::DerivedArgList *

  TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,

                Action::OffloadKind DeviceOffloadKind) const override;

  CXXStdlibType GetDefaultCXXStdlibType() const override;

  ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const override;

  bool hasBlocksRuntime() const override;

  void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,

                          llvm::opt::ArgStringList &CC1Args) const override;

  void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs,

                         llvm::opt::ArgStringList &CC1Args) const override;

  bool UseObjCMixedDispatch() const override {

    // This is only used with the non-fragile ABI and non-legacy dispatch.

    // Mixed dispatch is used everywhere except OS X before 10.6.

    return !(isTargetMacOSBased() && isMacosxVersionLT(10, 6));

  }

  LangOptions::StackProtectorMode

  GetDefaultStackProtectorLevel(bool KernelOrKext) const override {

    // Stack protectors default to on for user code on 10.5,

    // and for everything in 10.6 and beyond

    if (isTargetIOSBased() || isTargetWatchOSBased() || isTargetDriverKit())

      return LangOptions::SSPOn;

    else if (isTargetMacOSBased() && !isMacosxVersionLT(10, 6))

      return LangOptions::SSPOn;

    else if (isTargetMacOSBased() && !isMacosxVersionLT(10, 5) && !KernelOrKext)

      return LangOptions::SSPOn;

    return LangOptions::SSPOff;

  }

  void CheckObjCARC() const override;

  llvm::ExceptionHandling GetExceptionModel(

      const llvm::opt::ArgList &Args) const override;

  bool SupportsEmbeddedBitcode() const override;

  SanitizerMask getSupportedSanitizers() const override;

  void printVerboseInfo(raw_ostream &OS) const override;

};

/// DarwinClang - The Darwin toolchain used by Clang.

class LLVM_LIBRARY_VISIBILITY DarwinClang : public Darwin {

public:

  DarwinClang(const Driver &D, const llvm::Triple &Triple,

              const llvm::opt::ArgList &Args);

  /// @name Apple ToolChain Implementation

  /// {

  RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const override;

  void AddLinkRuntimeLibArgs(const llvm::opt::ArgList &Args,

                             llvm::opt::ArgStringList &CmdArgs,

                             bool ForceLinkBuiltinRT = false) const override;

  void AddClangCXXStdlibIncludeArgs(

      const llvm::opt::ArgList &DriverArgs,

      llvm::opt::ArgStringList &CC1Args) const override;

  void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,

                                 llvm::opt::ArgStringList &CC1Args) const override;

  void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,

                           llvm::opt::ArgStringList &CmdArgs) const override;

  void AddCCKextLibArgs(const llvm::opt::ArgList &Args,

                        llvm::opt::ArgStringList &CmdArgs) const override;

  void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override;

  void AddLinkARCArgs(const llvm::opt::ArgList &Args,

                      llvm::opt::ArgStringList &CmdArgs) const override;

  unsigned GetDefaultDwarfVersion() const override;

  // Until dtrace (via CTF) and LLDB can deal with distributed debug info,

  // Darwin defaults to standalone/full debug info.

  bool GetDefaultStandaloneDebug() const override { return true; }

  llvm::DebuggerKind getDefaultDebuggerTuning() const override {

    return llvm::DebuggerKind::LLDB;

  }

  /// }

private:

  void AddLinkSanitizerLibArgs(const llvm::opt::ArgList &Args,

                               llvm::opt::ArgStringList &CmdArgs,

                               StringRef Sanitizer,

                               bool shared = true) const;

  bool AddGnuCPlusPlusIncludePaths(const llvm::opt::ArgList &DriverArgs,

                                   llvm::opt::ArgStringList &CC1Args,

                                   llvm::SmallString<128> Base,

                                   llvm::StringRef Version,

                                   llvm::StringRef ArchDir,

                                   llvm::StringRef BitDir) const;

  llvm::SmallString<128>

  GetEffectiveSysroot(const llvm::opt::ArgList &DriverArgs) const;

};

} // end namespace toolchains

} // end namespace driver

} // end namespace clang

#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_DARWIN_H