//===--- FreeBSD.cpp - FreeBSD 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

//

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

#include "FreeBSD.h"

#include "Arch/ARM.h"

#include "Arch/Mips.h"

#include "Arch/Sparc.h"

#include "CommonArgs.h"

#include "clang/Config/config.h"

#include "clang/Driver/Compilation.h"

#include "clang/Driver/DriverDiagnostic.h"

#include "clang/Driver/Options.h"

#include "clang/Driver/SanitizerArgs.h"

#include "llvm/Option/ArgList.h"

#include "llvm/Support/VirtualFileSystem.h"

using namespace clang::driver;

using namespace clang::driver::tools;

using namespace clang::driver::toolchains;

using namespace clang;

using namespace llvm::opt;

void freebsd::Assembler::ConstructJob(Compilation &C, const JobAction &JA,

                                      const InputInfo &Output,

                                      const InputInfoList &Inputs,

                                      const ArgList &Args,

                                      const char *LinkingOutput) const {

  const auto &ToolChain = static_cast<const FreeBSD &>(getToolChain());

  const auto &D = getToolChain().getDriver();

  const llvm::Triple &Triple = ToolChain.getTriple();

  ArgStringList CmdArgs;

  claimNoWarnArgs(Args);

  // When building 32-bit code on FreeBSD/amd64, we have to explicitly

  // instruct as in the base system to assemble 32-bit code.

  switch (ToolChain.getArch()) {

  default:

    break;

  case llvm::Triple::x86:

    CmdArgs.push_back("--32");

    break;

  case llvm::Triple::ppc:

  case llvm::Triple::ppcle:

    CmdArgs.push_back("-a32");

    break;

  case llvm::Triple::mips:

  case llvm::Triple::mipsel:

  case llvm::Triple::mips64:

  case llvm::Triple::mips64el: {

    StringRef CPUName;

    StringRef ABIName;

    mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);

    CmdArgs.push_back("-march");

    CmdArgs.push_back(CPUName.data());

    CmdArgs.push_back("-mabi");

    CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data());

    if (Triple.isLittleEndian())

      CmdArgs.push_back("-EL");

    else

      CmdArgs.push_back("-EB");

    if (Arg *A = Args.getLastArg(options::OPT_G)) {

      StringRef v = A->getValue();

      CmdArgs.push_back(Args.MakeArgString("-G" + v));

      A->claim();

    }

    AddAssemblerKPIC(ToolChain, Args, CmdArgs);

    break;

  }

  case llvm::Triple::arm:

  case llvm::Triple::armeb:

  case llvm::Triple::thumb:

  case llvm::Triple::thumbeb: {

    arm::FloatABI ABI = arm::getARMFloatABI(ToolChain, Args);

    if (ABI == arm::FloatABI::Hard)

      CmdArgs.push_back("-mfpu=vfp");

    else

      CmdArgs.push_back("-mfpu=softvfp");

    CmdArgs.push_back("-meabi=5");

    break;

  }

  case llvm::Triple::sparcv9: {

    std::string CPU = getCPUName(D, Args, Triple);

    CmdArgs.push_back(sparc::getSparcAsmModeForCPU(CPU, Triple));

    AddAssemblerKPIC(ToolChain, Args, CmdArgs);

    break;

  }

  }

  for (const Arg *A : Args.filtered(options::OPT_ffile_prefix_map_EQ,

                                    options::OPT_fdebug_prefix_map_EQ)) {

    StringRef Map = A->getValue();

    if (!Map.contains('='))

      D.Diag(diag::err_drv_invalid_argument_to_option)

          << Map << A->getOption().getName();

    else {

      CmdArgs.push_back(Args.MakeArgString("--debug-prefix-map"));

      CmdArgs.push_back(Args.MakeArgString(Map));

    }

    A->claim();

  }

  Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);

  CmdArgs.push_back("-o");

  CmdArgs.push_back(Output.getFilename());

  for (const auto &II : Inputs)

    CmdArgs.push_back(II.getFilename());

  const char *Exec = Args.MakeArgString(ToolChain.GetProgramPath("as"));

  C.addCommand(std::make_unique<Command>(JA, *this,

                                         ResponseFileSupport::AtFileCurCP(),

                                         Exec, CmdArgs, Inputs, Output));

}

void freebsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,

                                   const InputInfo &Output,

                                   const InputInfoList &Inputs,

                                   const ArgList &Args,

                                   const char *LinkingOutput) const {

  const auto &ToolChain = static_cast<const FreeBSD &>(getToolChain());

  const Driver &D = ToolChain.getDriver();

  const llvm::Triple::ArchType Arch = ToolChain.getArch();

  const bool IsPIE =

      !Args.hasArg(options::OPT_shared) &&

      (Args.hasArg(options::OPT_pie) || ToolChain.isPIEDefault(Args));

  ArgStringList CmdArgs;

  // Silence warning for "clang -g foo.o -o foo"

  Args.ClaimAllArgs(options::OPT_g_Group);

  // and "clang -emit-llvm foo.o -o foo"

  Args.ClaimAllArgs(options::OPT_emit_llvm);

  // and for "clang -w foo.o -o foo". Other warning options are already

  // handled somewhere else.

  Args.ClaimAllArgs(options::OPT_w);

  if (!D.SysRoot.empty())

    CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));

  if (IsPIE)

    CmdArgs.push_back("-pie");

  CmdArgs.push_back("--eh-frame-hdr");

  if (Args.hasArg(options::OPT_static)) {

    CmdArgs.push_back("-Bstatic");

  } else {

    if (Args.hasArg(options::OPT_rdynamic))

      CmdArgs.push_back("-export-dynamic");

    if (Args.hasArg(options::OPT_shared)) {

      CmdArgs.push_back("-shared");

    } else if (!Args.hasArg(options::OPT_r)) {

      CmdArgs.push_back("-dynamic-linker");

      CmdArgs.push_back("/libexec/ld-elf.so.1");

    }

    const llvm::Triple &T = ToolChain.getTriple();

    if (Arch == llvm::Triple::arm || T.isX86())

      CmdArgs.push_back("--hash-style=both");

    CmdArgs.push_back("--enable-new-dtags");

  }

  // Explicitly set the linker emulation for platforms that might not

  // be the default emulation for the linker.

  switch (Arch) {

  case llvm::Triple::x86:

    CmdArgs.push_back("-m");

    CmdArgs.push_back("elf_i386_fbsd");

    break;

  case llvm::Triple::ppc:

    CmdArgs.push_back("-m");

    CmdArgs.push_back("elf32ppc_fbsd");

    break;

  case llvm::Triple::ppcle:

    CmdArgs.push_back("-m");

    // Use generic -- only usage is for freestanding.

    CmdArgs.push_back("elf32lppc");

    break;

  case llvm::Triple::mips:

    CmdArgs.push_back("-m");

    CmdArgs.push_back("elf32btsmip_fbsd");

    break;

  case llvm::Triple::mipsel:

    CmdArgs.push_back("-m");

    CmdArgs.push_back("elf32ltsmip_fbsd");

    break;

  case llvm::Triple::mips64:

    CmdArgs.push_back("-m");

    if (tools::mips::hasMipsAbiArg(Args, "n32"))

      CmdArgs.push_back("elf32btsmipn32_fbsd");

    else

      CmdArgs.push_back("elf64btsmip_fbsd");

    break;

  case llvm::Triple::mips64el:

    CmdArgs.push_back("-m");

    if (tools::mips::hasMipsAbiArg(Args, "n32"))

      CmdArgs.push_back("elf32ltsmipn32_fbsd");

    else

      CmdArgs.push_back("elf64ltsmip_fbsd");

    break;

  case llvm::Triple::riscv64:

    CmdArgs.push_back("-m");

    CmdArgs.push_back("elf64lriscv");

    CmdArgs.push_back("-X");

    break;

  default:

    break;

  }

  if (Arg *A = Args.getLastArg(options::OPT_G)) {

    if (ToolChain.getTriple().isMIPS()) {

      StringRef v = A->getValue();

      CmdArgs.push_back(Args.MakeArgString("-G" + v));

      A->claim();

    }

  }

  assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");

  if (Output.isFilename()) {

    CmdArgs.push_back("-o");

    CmdArgs.push_back(Output.getFilename());

  }

  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,

                   options::OPT_r)) {

    const char *crt1 = nullptr;

    if (!Args.hasArg(options::OPT_shared)) {

      if (Args.hasArg(options::OPT_pg))

        crt1 = "gcrt1.o";

      else if (IsPIE)

        crt1 = "Scrt1.o";

      else

        crt1 = "crt1.o";

    }

    if (crt1)

      CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crt1)));

    CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crti.o")));

    const char *crtbegin = nullptr;

    if (Args.hasArg(options::OPT_static))

      crtbegin = "crtbeginT.o";

    else if (Args.hasArg(options::OPT_shared) || IsPIE)

      crtbegin = "crtbeginS.o";

    else

      crtbegin = "crtbegin.o";

    CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));

  }

  Args.AddAllArgs(CmdArgs, options::OPT_L);

  ToolChain.AddFilePathLibArgs(Args, CmdArgs);

  Args.addAllArgs(CmdArgs, {options::OPT_T_Group, options::OPT_s,

                            options::OPT_t, options::OPT_r});

  if (D.isUsingLTO()) {

    assert(!Inputs.empty() && "Must have at least one input.");

    // Find the first filename InputInfo object.

    auto Input = llvm::find_if(

        Inputs, [](const InputInfo &II) -> bool { return II.isFilename(); });

    if (Input == Inputs.end())

      // For a very rare case, all of the inputs to the linker are

      // InputArg. If that happens, just use the first InputInfo.

      Input = Inputs.begin();

    addLTOOptions(ToolChain, Args, CmdArgs, Output, *Input,

                  D.getLTOMode() == LTOK_Thin);

  }

  bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);

  bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);

  addLinkerCompressDebugSectionsOption(ToolChain, Args, CmdArgs);

  AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);

  unsigned Major = ToolChain.getTriple().getOSMajorVersion();

  bool Profiling = Args.hasArg(options::OPT_pg) && Major != 0 && Major < 14;

  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs,

                   options::OPT_r)) {

    // Use the static OpenMP runtime with -static-openmp

    bool StaticOpenMP = Args.hasArg(options::OPT_static_openmp) &&

                        !Args.hasArg(options::OPT_static);

    addOpenMPRuntime(CmdArgs, ToolChain, Args, StaticOpenMP);

    if (D.CCCIsCXX()) {

      if (ToolChain.ShouldLinkCXXStdlib(Args))

        ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);

      if (Profiling)

        CmdArgs.push_back("-lm_p");

      else

        CmdArgs.push_back("-lm");

    }

    // Silence warnings when linking C code with a C++ '-stdlib' argument.

    Args.ClaimAllArgs(options::OPT_stdlib_EQ);

    // Additional linker set-up and flags for Fortran. This is required in order

    // to generate executables. As Fortran runtime depends on the C runtime,

    // these dependencies need to be listed before the C runtime below (i.e.

    // AddRunTimeLibs).

    if (D.IsFlangMode()) {

      addFortranRuntimeLibraryPath(ToolChain, Args, CmdArgs);

      addFortranRuntimeLibs(ToolChain, Args, CmdArgs);

      if (Profiling)

        CmdArgs.push_back("-lm_p");

      else

        CmdArgs.push_back("-lm");

    }

    if (NeedsSanitizerDeps)

      linkSanitizerRuntimeDeps(ToolChain, Args, CmdArgs);

    if (NeedsXRayDeps)

      linkXRayRuntimeDeps(ToolChain, Args, CmdArgs);

    // FIXME: For some reason GCC passes -lgcc and -lgcc_s before adding

    // the default system libraries. Just mimic this for now.

    if (Profiling)

      CmdArgs.push_back("-lgcc_p");

    else

      CmdArgs.push_back("-lgcc");

    if (Args.hasArg(options::OPT_static)) {

      CmdArgs.push_back("-lgcc_eh");

    } else if (Profiling) {

      CmdArgs.push_back("-lgcc_eh_p");

    } else {

      CmdArgs.push_back("--as-needed");

      CmdArgs.push_back("-lgcc_s");

      CmdArgs.push_back("--no-as-needed");

    }

    if (Args.hasArg(options::OPT_pthread)) {

      if (Profiling)

        CmdArgs.push_back("-lpthread_p");

      else

        CmdArgs.push_back("-lpthread");

    }

    if (Profiling) {

      if (Args.hasArg(options::OPT_shared))

        CmdArgs.push_back("-lc");

      else

        CmdArgs.push_back("-lc_p");

      CmdArgs.push_back("-lgcc_p");

    } else {

      CmdArgs.push_back("-lc");

      CmdArgs.push_back("-lgcc");

    }

    if (Args.hasArg(options::OPT_static)) {

      CmdArgs.push_back("-lgcc_eh");

    } else if (Profiling) {

      CmdArgs.push_back("-lgcc_eh_p");

    } else {

      CmdArgs.push_back("--as-needed");

      CmdArgs.push_back("-lgcc_s");

      CmdArgs.push_back("--no-as-needed");

    }

  }

  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,

                   options::OPT_r)) {

    const char *crtend = nullptr;

    if (Args.hasArg(options::OPT_shared) || IsPIE)

      crtend = "crtendS.o";

    else

      crtend = "crtend.o";

    CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend)));

    CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o")));

  }

  ToolChain.addProfileRTLibs(Args, CmdArgs);

  const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());

  C.addCommand(std::make_unique<Command>(JA, *this,

                                         ResponseFileSupport::AtFileCurCP(),

                                         Exec, CmdArgs, Inputs, Output));

}

/// FreeBSD - FreeBSD tool chain which can call as(1) and ld(1) directly.

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

                 const ArgList &Args)

    : Generic_ELF(D, Triple, Args) {

  // When targeting 32-bit platforms, look for '/usr/lib32/crt1.o' and fall

  // back to '/usr/lib' if it doesn't exist.

  if (Triple.isArch32Bit() &&

      D.getVFS().exists(concat(getDriver().SysRoot, "/usr/lib32/crt1.o")))

    getFilePaths().push_back(concat(getDriver().SysRoot, "/usr/lib32"));

  else

    getFilePaths().push_back(concat(getDriver().SysRoot, "/usr/lib"));

}

void FreeBSD::AddClangSystemIncludeArgs(

    const llvm::opt::ArgList &DriverArgs,

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

  const Driver &D = getDriver();

  if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))

    return;

  if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {

    SmallString<128> Dir(D.ResourceDir);

    llvm::sys::path::append(Dir, "include");

    addSystemInclude(DriverArgs, CC1Args, Dir.str());

  }

  if (DriverArgs.hasArg(options::OPT_nostdlibinc))

    return;

  // Check for configure-time C include directories.

  StringRef CIncludeDirs(C_INCLUDE_DIRS);

  if (CIncludeDirs != "") {

    SmallVector<StringRef, 5> dirs;

    CIncludeDirs.split(dirs, ":");

    for (StringRef dir : dirs) {

      StringRef Prefix =

          llvm::sys::path::is_absolute(dir) ? StringRef(D.SysRoot) : "";

      addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);

    }

    return;

  }

  addExternCSystemInclude(DriverArgs, CC1Args,

                          concat(D.SysRoot, "/usr/include"));

}

void FreeBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,

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

  addSystemInclude(DriverArgs, CC1Args,

                   concat(getDriver().SysRoot, "/usr/include/c++/v1"));

}

void FreeBSD::AddCXXStdlibLibArgs(const ArgList &Args,

                                  ArgStringList &CmdArgs) const {

  unsigned Major = getTriple().getOSMajorVersion();

  bool Profiling = Args.hasArg(options::OPT_pg) && Major != 0 && Major < 14;

  CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++");

  if (Args.hasArg(options::OPT_fexperimental_library))

    CmdArgs.push_back("-lc++experimental");

}

void FreeBSD::AddCudaIncludeArgs(const ArgList &DriverArgs,

                                 ArgStringList &CC1Args) const {

  CudaInstallation->AddCudaIncludeArgs(DriverArgs, CC1Args);

}

void FreeBSD::AddHIPIncludeArgs(const ArgList &DriverArgs,

                                ArgStringList &CC1Args) const {

  RocmInstallation->AddHIPIncludeArgs(DriverArgs, CC1Args);

}

Tool *FreeBSD::buildAssembler() const {

  return new tools::freebsd::Assembler(*this);

}

Tool *FreeBSD::buildLinker() const { return new tools::freebsd::Linker(*this); }

bool FreeBSD::HasNativeLLVMSupport() const { return true; }

ToolChain::UnwindTableLevel

FreeBSD::getDefaultUnwindTableLevel(const ArgList &Args) const {

  return UnwindTableLevel::Asynchronous;

}

bool FreeBSD::isPIEDefault(const llvm::opt::ArgList &Args) const {

  return getSanitizerArgs(Args).requiresPIE();

}

SanitizerMask FreeBSD::getSupportedSanitizers() const {

  const bool IsAArch64 = getTriple().getArch() == llvm::Triple::aarch64;

  const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;

  const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;

  const bool IsMIPS64 = getTriple().isMIPS64();

  SanitizerMask Res = ToolChain::getSupportedSanitizers();

  Res |= SanitizerKind::Address;

  Res |= SanitizerKind::PointerCompare;

  Res |= SanitizerKind::PointerSubtract;

  Res |= SanitizerKind::Vptr;

  if (IsAArch64 || IsX86_64 || IsMIPS64) {

    Res |= SanitizerKind::Leak;

    Res |= SanitizerKind::Thread;

  }

  if (IsAArch64 || IsX86 || IsX86_64) {

    Res |= SanitizerKind::SafeStack;

    Res |= SanitizerKind::Fuzzer;

    Res |= SanitizerKind::FuzzerNoLink;

  }

  if (IsAArch64 || IsX86_64) {

    Res |= SanitizerKind::KernelAddress;

    Res |= SanitizerKind::KernelMemory;

    Res |= SanitizerKind::Memory;

  }

  return Res;

}