Flang.cpp

Go to the documentation of this file.

//===-- Flang.cpp - Flang+LLVM 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 "Flang.h"
#include "Arch/RISCV.h"
#include "Cuda.h"
 
#include "clang/Basic/CodeGenOptions.h"
#include "clang/Basic/MakeSupport.h"
#include "clang/Driver/CommonArgs.h"
#include "clang/Options/OptionUtils.h"
#include "clang/Options/Options.h"
#include "llvm/Frontend/Debug/Options.h"
#include "llvm/Support/Path.h"
#include "llvm/TargetParser/Host.h"
#include "llvm/TargetParser/RISCVISAInfo.h"
#include "llvm/TargetParser/RISCVTargetParser.h"
 
#include <cassert>
 
using namespace clang::driver;
using namespace clang::driver::tools;
using namespace clang;
using namespace llvm::opt;
 
/// Add -x lang to \p CmdArgs for \p Input.
static void addDashXForInput(const ArgList &Args, const InputInfo &Input,
                             ArgStringList &CmdArgs) {
  CmdArgs.push_back("-x");
  // Map the driver type to the frontend type.
  CmdArgs.push_back(types::getTypeName(Input.getType()));
}
 
// Translate the dependency-file options into the arguments understood by
// `flang -fc1`. The options handled here:
//   -M    Emit only the dependencies and skip code generation. They are
//         written to stdout unless -MF redirects them.
//   -MM   Treated identically to -M. The -MM/-M split exists to omit system
//         headers, but Fortran has no notion of system vs user headers, so
//         there is nothing for -MM to exclude.
//   -MD   Compile normally and produce the object file, while also writing the
//         dependency file. Its name defaults to the -o value, or the input
//         file name when -o is absent, with the extension replaced by .d.
//   -MMD  Treated identically to -MD, for the same reason -MM equals -M.
//   -MF   Set the path of the dependency file to write.
//   -MT   Set the dependency target name (the part before the colon).
//   -MQ   Like -MT, but additionally quotes characters special to Make.
static void renderDependencyGenerationOptions(Compilation &C,
                                              const JobAction &JA,
                                              const ArgList &Args,
                                              const InputInfo &Output,
                                              const InputInfoList &Inputs,
                                              ArgStringList &CmdArgs) {
  Arg *ArgM = Args.getLastArg(options::OPT_M, options::OPT_MM);
  Arg *ArgMD = Args.getLastArg(options::OPT_MD, options::OPT_MMD);
 
  if (!ArgM && !ArgMD)
    return;
 
  // Drop warnings for -M/-MM so they don't mix into the dependency output.
  if (ArgM)
    CmdArgs.push_back("-w");
  else
    ArgM = ArgMD;
 
  // Emit "-MT <target>", quoting Make metacharacters when requested.
  auto addTarget = [&](StringRef Target, bool Quote) {
    CmdArgs.push_back("-MT");
    if (Quote) {
      SmallString<128> Quoted;
      clang::quoteMakeTarget(Target, Quoted);
      CmdArgs.push_back(Args.MakeArgString(Quoted));
    } else {
      CmdArgs.push_back(Args.MakeArgString(Target));
    }
  };
 
  // Decide where to write the dependency file.
  const char *DepFile;
  if (Arg *MF = Args.getLastArg(options::OPT_MF)) {
    // -MF gives the path explicitly.
    DepFile = MF->getValue();
    C.addFailureResultFile(DepFile, &JA);
  } else if (Output.getType() == types::TY_Dependencies) {
    // Plain -M/-MM: the dependency file is the output, so use its name
    DepFile = Output.getFilename();
  } else if (!ArgMD) {
    // -M/-MM with no -o: write the dependencies to stdout.
    DepFile = "-";
  } else {
    // -MD/-MMD: name it after -o, else the input, with a .d extension.
    SmallString<128> P;
    if (Arg *OutputOpt = Args.getLastArg(options::OPT_o))
      P = OutputOpt->getValue();
    else
      P = llvm::sys::path::filename(Inputs[0].getBaseInput());
    llvm::sys::path::replace_extension(P, "d");
    DepFile = Args.MakeArgString(P);
    C.addFailureResultFile(DepFile, &JA);
  }
  CmdArgs.push_back("-dependency-file");
  CmdArgs.push_back(DepFile);
 
  // Render the explicit target(s). -MT is verbatim, -MQ is Make-quoted.
  bool HasTarget = false;
  for (const Arg *A : Args.filtered(options::OPT_MT, options::OPT_MQ)) {
    HasTarget = true;
    A->claim();
    addTarget(A->getValue(), A->getOption().matches(options::OPT_MQ));
  }
 
  // With no explicit target, default to the object file. In -M/-MM mode -o
  // names the dependency file, not the target, so derive <base>.o instead.
  if (!HasTarget) {
    Arg *OutputOpt = Args.getLastArg(options::OPT_o);
    if (OutputOpt && Output.getType() != types::TY_Dependencies) {
      addTarget(OutputOpt->getValue(), /*Quote=*/true);
    } else {
      SmallString<128> P(llvm::sys::path::filename(Inputs[0].getBaseInput()));
      llvm::sys::path::replace_extension(P, "o");
      addTarget(P, /*Quote=*/true);
    }
  }
}
 
void Flang::addFortranDialectOptions(const ArgList &Args,
                                     ArgStringList &CmdArgs) const {
  Args.addAllArgs(CmdArgs,
                  {options::OPT_ffixed_form,
                   options::OPT_ffree_form,
                   options::OPT_ffixed_line_length_EQ,
                   options::OPT_fopenacc,
                   options::OPT_finput_charset_EQ,
                   options::OPT_fimplicit_none,
                   options::OPT_fimplicit_none_ext,
                   options::OPT_fimplicit_module_prefix,
                   options::OPT_fno_implicit_none,
                   options::OPT_fno_implicit_module_prefix,
                   options::OPT_fbackslash,
                   options::OPT_fno_backslash,
                   options::OPT_flogical_abbreviations,
                   options::OPT_fno_logical_abbreviations,
                   options::OPT_fxor_operator,
                   options::OPT_fno_xor_operator,
                   options::OPT_falternative_parameter_statement,
                   options::OPT_fdefault_integer_4,
                   options::OPT_fdefault_real_4,
                   options::OPT_fdefault_real_8,
                   options::OPT_fdefault_integer_8,
                   options::OPT_fdefault_double_8,
                   options::OPT_flarge_sizes,
                   options::OPT_fno_automatic,
                   options::OPT_fhermetic_module_files,
                   options::OPT_frealloc_lhs,
                   options::OPT_fno_realloc_lhs,
                   options::OPT_fsave_main_program,
                   options::OPT_fd_lines_as_code,
                   options::OPT_fd_lines_as_comments,
                   options::OPT_fno_save_main_program,
                   options::OPT_fprefer_intrinsic_module_use_association,
                   options::OPT_fno_prefer_intrinsic_module_use_association});
}
 
void Flang::addPreprocessingOptions(const ArgList &Args,
                                    ArgStringList &CmdArgs) const {
  Args.addAllArgs(CmdArgs,
                  {options::OPT_P, options::OPT_D, options::OPT_U,
                   options::OPT_I, options::OPT_cpp, options::OPT_nocpp});
}
 
/// @C shouldLoopVersion
///
/// Check if a loop versioning pass should be enabled.
/// We look for the last of one of the following:
///   -Ofast, -O4, -O<number>, -O0 and the pass's -f[no-]version-loops-for-*
///   flag.
/// Loop versioning is disabled if the last option is the -fno- flag or -O0.
/// Loop versioning is enabled if the last option is one of:
///  the -f flag
///  -Ofast
///  -O4
///  -O3
/// For all other cases, loop versioning is disabled.
///
/// The gfortran compiler automatically enables the option for -O3 or -Ofast.
///
/// @return true if loop-versioning should be enabled, otherwise false.
static bool shouldLoopVersion(const ArgList &Args, options::ID PosFlag,
                              options::ID NegFlag) {
  const Arg *LoopVersioningArg =
      Args.getLastArg(options::OPT_Ofast, options::OPT_O, options::OPT_O4,
                      options::OPT_O0, PosFlag, NegFlag);
  if (!LoopVersioningArg)
    return false;
 
  if (LoopVersioningArg->getOption().matches(NegFlag) ||
      LoopVersioningArg->getOption().matches(options::OPT_O0))
    return false;
 
  if (LoopVersioningArg->getOption().matches(PosFlag))
    return true;
 
  if (LoopVersioningArg->getOption().matches(options::OPT_Ofast) ||
      LoopVersioningArg->getOption().matches(options::OPT_O4))
    return true;
 
  if (LoopVersioningArg->getOption().matches(options::OPT_O)) {
    StringRef S(LoopVersioningArg->getValue());
    unsigned OptLevel = 0;
    // Note -Os or Oz woould "fail" here, so return false. Which is the
    // desiered behavior.
    if (S.getAsInteger(10, OptLevel))
      return false;
 
    return OptLevel > 2;
  }
 
  llvm_unreachable("We should not end up here");
  return false;
}
 
void Flang::addDebugOptions(const llvm::opt::ArgList &Args, const JobAction &JA,
                            const InputInfo &Output, const InputInfo &Input,
                            llvm::opt::ArgStringList &CmdArgs) const {
  const auto &TC = getToolChain();
  const Driver &D = TC.getDriver();
  Args.addAllArgs(CmdArgs,
                  {options::OPT_module_dir,
                   options::OPT_fdebug_module_writer,
                   options::OPT_fintrinsic_modules_path,
                   options::OPT_pedantic,
                   options::OPT_std_EQ,
                   options::OPT_W_Joined,
                   options::OPT_fconvert_EQ,
                   options::OPT_fpass_plugin_EQ,
                   options::OPT_funderscoring,
                   options::OPT_fno_underscoring,
                   options::OPT_funsigned,
                   options::OPT_fno_unsigned,
                   options::OPT_fout_of_bounds_subscripts,
                   options::OPT_fno_out_of_bounds_subscripts,
                   options::OPT_fopenacc_default_none_scalars_strict,
                   options::OPT_fno_openacc_default_none_scalars_strict,
                   options::OPT_fopenacc_multiple_names_in_routine,
                   options::OPT_fno_openacc_multiple_names_in_routine,
                   options::OPT_finstrument_functions});
 
  llvm::codegenoptions::DebugInfoKind DebugInfoKind;
  bool hasDwarfNArg = getDwarfNArg(Args) != nullptr;
  if (Args.hasArg(options::OPT_gN_Group)) {
    Arg *gNArg = Args.getLastArg(options::OPT_gN_Group);
    DebugInfoKind = debugLevelToInfoKind(*gNArg);
  } else if (Args.hasArg(options::OPT_g_Flag) || hasDwarfNArg) {
    DebugInfoKind = llvm::codegenoptions::FullDebugInfo;
  } else {
    DebugInfoKind = llvm::codegenoptions::NoDebugInfo;
  }
  addDebugInfoKind(CmdArgs, DebugInfoKind);
  // Pass on the DWARF version when debug information is being generated, or
  // when -gdwarf-N names a version. Leaving it out means the version stays
  // unset and the backend falls back to dwarf::DWARF_VERSION (4) instead of
  // honouring toolchain default like clang does.
  //
  // Note that both conditions are needed to match clang for cases like
  // "-gdwarf-5 -g0".
  if (hasDwarfNArg || DebugInfoKind != llvm::codegenoptions::NoDebugInfo) {
    const unsigned DwarfVersion = getDwarfVersion(getToolChain(), Args);
    CmdArgs.push_back(
        Args.MakeArgString("-dwarf-version=" + Twine(DwarfVersion)));
  }
  if (Args.hasArg(options::OPT_gsplit_dwarf) ||
      Args.hasArg(options::OPT_gsplit_dwarf_EQ)) {
    // FIXME: -gsplit-dwarf on AIX is currently unimplemented.
    if (TC.getTriple().isOSAIX()) {
      D.Diag(diag::err_drv_unsupported_opt_for_target)
          << Args.getLastArg(options::OPT_gsplit_dwarf)->getSpelling()
          << TC.getTriple().str();
      return;
    }
    if (DebugInfoKind == llvm::codegenoptions::NoDebugInfo)
      return;
 
    Arg *SplitDWARFArg;
    DwarfFissionKind DwarfFission = getDebugFissionKind(D, Args, SplitDWARFArg);
 
    if (DwarfFission == DwarfFissionKind::None ||
        !checkDebugInfoOption(SplitDWARFArg, Args, D, TC))
      return;
 
    if (!TC.getTriple().isOSBinFormatELF() &&
        !TC.getTriple().isOSBinFormatWasm() &&
        !TC.getTriple().isOSBinFormatCOFF()) {
      D.Diag(diag::warn_drv_unsupported_debug_info_opt_for_target)
          << SplitDWARFArg->getSpelling() << TC.getTriple().str();
      return;
    }
 
    if (!isa<AssembleJobAction>(JA) && !isa<CompileJobAction>(JA) &&
        isa<BackendJobAction>(JA))
      return;
 
    const char *SplitDWARFOut = SplitDebugName(JA, Args, Input, Output);
    CmdArgs.push_back("-split-dwarf-file");
    CmdArgs.push_back(SplitDWARFOut);
    if (DwarfFission == DwarfFissionKind::Split) {
      CmdArgs.push_back("-split-dwarf-output");
      CmdArgs.push_back(SplitDWARFOut);
    }
  }
 
  // Handle compressed debug sections (-gz).
  renderDebugInfoCompressionArgs(Args, CmdArgs, D, TC);
 
  addDebugInfoForProfilingArgs(D, TC, Args, CmdArgs);
}
 
void Flang::addCodegenOptions(const ArgList &Args,
                              ArgStringList &CmdArgs) const {
  Arg *stackArrays =
      Args.getLastArg(options::OPT_Ofast, options::OPT_fstack_arrays,
                      options::OPT_fno_stack_arrays);
  if (stackArrays &&
      !stackArrays->getOption().matches(options::OPT_fno_stack_arrays))
    CmdArgs.push_back("-fstack-arrays");
 
  if (Args.hasFlag(options::OPT_fsafe_trampoline,
                   options::OPT_fno_safe_trampoline, false)) {
    const llvm::Triple &T = getToolChain().getTriple();
    if (T.getArch() == llvm::Triple::x86_64 ||
        T.getArch() == llvm::Triple::aarch64 ||
        T.getArch() == llvm::Triple::aarch64_be) {
      CmdArgs.push_back("-fsafe-trampoline");
    } else {
      getToolChain().getDriver().Diag(
          diag::warn_drv_unsupported_option_for_target)
          << "-fsafe-trampoline" << T.str();
    }
  }
 
  // -fno-protect-parens is the default for -Ofast.
  if (!Args.hasFlag(options::OPT_fprotect_parens,
                    options::OPT_fno_protect_parens,
                    /*Default=*/!Args.hasArg(options::OPT_Ofast)))
    CmdArgs.push_back("-fno-protect-parens");
 
  if (Args.hasFlag(options::OPT_funsafe_cray_pointers,
                   options::OPT_fno_unsafe_cray_pointers, false)) {
    // TODO: currently passed as MLIR option
    CmdArgs.push_back("-mmlir");
    CmdArgs.push_back("-unsafe-cray-pointers");
  }
 
  Args.addOptInFlag(CmdArgs, options::OPT_fexperimental_loop_fusion,
                    options::OPT_fno_experimental_loop_fusion);
  Args.AddLastArg(CmdArgs, options::OPT_ffp_sum_reassociation,
                  options::OPT_fno_fp_sum_reassociation);
 
  Args.addOptInFlag(CmdArgs, options::OPT_funique_internal_linkage_names,
                    options::OPT_fno_unique_internal_linkage_names);
 
  handleInterchangeLoopsArgs(Args, CmdArgs);
  handleVectorizeLoopsArgs(Args, CmdArgs);
  handleVectorizeSLPArgs(Args, CmdArgs);
 
  if (shouldLoopVersion(Args, options::OPT_floop_versioning,
                        options::OPT_fno_loop_versioning))
    CmdArgs.push_back("-fversion-loops-for-stride");
  if (shouldLoopVersion(Args, options::OPT_floop_tripcount_versioning,
                        options::OPT_fno_loop_tripcount_versioning))
    CmdArgs.push_back("-fversion-loops-for-trip-count");
 
  for (const auto &arg :
       Args.getAllArgValues(options::OPT_frepack_arrays_contiguity_EQ))
    if (arg != "whole" && arg != "innermost") {
      getToolChain().getDriver().Diag(diag::err_drv_unsupported_option_argument)
          << "-frepack-arrays-contiguity=" << arg;
    }
 
  Args.addAllArgs(
      CmdArgs,
      {options::OPT_fdo_concurrent_to_openmp_EQ,
       options::OPT_fno_ppc_native_vec_elem_order,
       options::OPT_fppc_native_vec_elem_order, options::OPT_finit_global_zero,
       options::OPT_fno_init_global_zero, options::OPT_finit_local_EQ,
       options::OPT_frepack_arrays, options::OPT_fno_repack_arrays,
       options::OPT_frepack_arrays_contiguity_EQ,
       options::OPT_fstack_repack_arrays, options::OPT_fno_stack_repack_arrays,
       options::OPT_ftime_report, options::OPT_ftime_report_EQ,
       options::OPT_funroll_loops, options::OPT_fno_unroll_loops,
       options::OPT_relaxed_c_loc});
 
  Args.addOptOutFlag(CmdArgs, options::OPT_foptimize_sibling_calls,
                     options::OPT_fno_optimize_sibling_calls);
 
  const llvm::Triple &Triple = getToolChain().getEffectiveTriple();
  addSeparateSectionFlags(Triple, Args, CmdArgs);
 
  if (Args.hasArg(options::OPT_fcoarray))
    CmdArgs.push_back("-fcoarray");
}
 
void Flang::addLTOOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
  const ToolChain &TC = getToolChain();
  LTOKind LTOMode = TC.getLTOMode(Args);
  // LTO mode is parsed by the Clang driver library.
  assert(LTOMode != LTOK_Unknown && "Unknown LTO mode.");
  if (LTOMode == LTOK_Full)
    CmdArgs.push_back("-flto=full");
  else if (LTOMode == LTOK_Thin)
    CmdArgs.push_back("-flto=thin");
 
  if (Args.hasFlag(options::OPT_fsplit_lto_unit,
                   options::OPT_fno_split_lto_unit, /*Default=*/false))
    CmdArgs.push_back("-fsplit-lto-unit");
 
  Args.addAllArgs(CmdArgs, {options::OPT_ffat_lto_objects,
                            options::OPT_fno_fat_lto_objects});
}
 
void Flang::addPicOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
  // ParsePICArgs parses -fPIC/-fPIE and their variants and returns a tuple of
  // (RelocationModel, PICLevel, IsPIE).
  llvm::Reloc::Model RelocationModel;
  unsigned PICLevel;
  bool IsPIE;
  std::tie(RelocationModel, PICLevel, IsPIE) =
      ParsePICArgs(getToolChain(), Args);
 
  if (auto *RMName = RelocationModelName(RelocationModel)) {
    CmdArgs.push_back("-mrelocation-model");
    CmdArgs.push_back(RMName);
  }
  if (PICLevel > 0) {
    CmdArgs.push_back("-pic-level");
    CmdArgs.push_back(PICLevel == 1 ? "1" : "2");
    if (IsPIE)
      CmdArgs.push_back("-pic-is-pie");
  }
}
 
void Flang::AddAArch64TargetArgs(const ArgList &Args,
                                 ArgStringList &CmdArgs) const {
  // Handle -msve_vector_bits=<bits>
  if (Arg *A = Args.getLastArg(options::OPT_msve_vector_bits_EQ)) {
    StringRef Val = A->getValue();
    const Driver &D = getToolChain().getDriver();
    if (Val == "128" || Val == "256" || Val == "512" || Val == "1024" ||
        Val == "2048" || Val == "128+" || Val == "256+" || Val == "512+" ||
        Val == "1024+" || Val == "2048+") {
      unsigned Bits = 0;
      if (!Val.consume_back("+")) {
        [[maybe_unused]] bool Invalid = Val.getAsInteger(10, Bits);
        assert(!Invalid && "Failed to parse value");
        CmdArgs.push_back(
            Args.MakeArgString("-mvscale-max=" + llvm::Twine(Bits / 128)));
      }
 
      [[maybe_unused]] bool Invalid = Val.getAsInteger(10, Bits);
      assert(!Invalid && "Failed to parse value");
      CmdArgs.push_back(
          Args.MakeArgString("-mvscale-min=" + llvm::Twine(Bits / 128)));
      // Silently drop requests for vector-length agnostic code as it's implied.
    } else if (Val != "scalable")
      // Handle the unsupported values passed to msve-vector-bits.
      D.Diag(diag::err_drv_unsupported_option_argument)
          << A->getSpelling() << Val;
  }
}
 
void Flang::AddLoongArch64TargetArgs(const ArgList &Args,
                                     ArgStringList &CmdArgs) const {
  const Driver &D = getToolChain().getDriver();
  // Currently, flang only support `-mabi=lp64d` in LoongArch64.
  if (const Arg *A = Args.getLastArg(options::OPT_mabi_EQ)) {
    StringRef V = A->getValue();
    if (V != "lp64d") {
      D.Diag(diag::err_drv_argument_not_allowed_with) << "-mabi" << V;
    }
  }
 
  if (const Arg *A = Args.getLastArg(options::OPT_mannotate_tablejump,
                                     options::OPT_mno_annotate_tablejump)) {
    if (A->getOption().matches(options::OPT_mannotate_tablejump)) {
      CmdArgs.push_back("-mllvm");
      CmdArgs.push_back("-loongarch-annotate-tablejump");
    }
  }
}
 
void Flang::AddPPCTargetArgs(const ArgList &Args,
                             ArgStringList &CmdArgs) const {
  const Driver &D = getToolChain().getDriver();
  bool VecExtabi = false;
 
  if (const Arg *A = Args.getLastArg(options::OPT_mabi_EQ)) {
    StringRef V = A->getValue();
    if (V == "vec-extabi")
      VecExtabi = true;
    else if (V == "vec-default")
      VecExtabi = false;
    else
      D.Diag(diag::err_drv_unsupported_option_argument)
          << A->getSpelling() << V;
  }
 
  const llvm::Triple &T = getToolChain().getTriple();
  if (VecExtabi) {
    if (!T.isOSAIX()) {
      D.Diag(diag::err_drv_unsupported_opt_for_target)
          << "-mabi=vec-extabi" << T.str();
    }
    CmdArgs.push_back("-mabi=vec-extabi");
  }
}
 
void Flang::AddRISCVTargetArgs(const ArgList &Args,
                               ArgStringList &CmdArgs) const {
  const Driver &D = getToolChain().getDriver();
  const llvm::Triple &Triple = getToolChain().getTriple();
 
  StringRef ABIName = riscv::getRISCVABI(Args, Triple);
  if (ABIName == "lp64" || ABIName == "lp64f" || ABIName == "lp64d")
    CmdArgs.push_back(Args.MakeArgString("-mabi=" + ABIName));
  else
    D.Diag(diag::err_drv_unsupported_option_argument) << "-mabi=" << ABIName;
 
  // Handle -mrvv-vector-bits=<bits>
  if (Arg *A = Args.getLastArg(options::OPT_mrvv_vector_bits_EQ)) {
    StringRef Val = A->getValue();
 
    // Get minimum VLen from march.
    unsigned MinVLen = 0;
    std::string Arch = riscv::getRISCVArch(Args, Triple);
    auto ISAInfo = llvm::RISCVISAInfo::parseArchString(
        Arch, /*EnableExperimentalExtensions*/ true);
    // Ignore parsing error.
    if (!errorToBool(ISAInfo.takeError()))
      MinVLen = (*ISAInfo)->getMinVLen();
 
    // If the value is "zvl", use MinVLen from march. Otherwise, try to parse
    // as integer as long as we have a MinVLen.
    unsigned Bits = 0;
    if (Val == "zvl" && MinVLen >= llvm::RISCV::RVVBitsPerBlock) {
      Bits = MinVLen;
    } else if (!Val.getAsInteger(10, Bits)) {
      // Only accept power of 2 values beteen RVVBitsPerBlock and 65536 that
      // at least MinVLen.
      if (Bits < MinVLen || Bits < llvm::RISCV::RVVBitsPerBlock ||
          Bits > 65536 || !llvm::isPowerOf2_32(Bits))
        Bits = 0;
    }
 
    // If we got a valid value try to use it.
    if (Bits != 0) {
      unsigned VScaleMin = Bits / llvm::RISCV::RVVBitsPerBlock;
      CmdArgs.push_back(
          Args.MakeArgString("-mvscale-max=" + llvm::Twine(VScaleMin)));
      CmdArgs.push_back(
          Args.MakeArgString("-mvscale-min=" + llvm::Twine(VScaleMin)));
    } else if (Val != "scalable") {
      // Handle the unsupported values passed to mrvv-vector-bits.
      D.Diag(diag::err_drv_unsupported_option_argument)
          << A->getSpelling() << Val;
    }
  }
}
 
void Flang::AddX86_64TargetArgs(const ArgList &Args,
                                ArgStringList &CmdArgs) const {
  if (Arg *A = Args.getLastArg(options::OPT_masm_EQ)) {
    StringRef Value = A->getValue();
    if (Value == "intel" || Value == "att") {
      CmdArgs.push_back(Args.MakeArgString("-mllvm"));
      CmdArgs.push_back(Args.MakeArgString("-x86-asm-syntax=" + Value));
    } else {
      getToolChain().getDriver().Diag(diag::err_drv_unsupported_option_argument)
          << A->getSpelling() << Value;
    }
  }
}
 
static void addVSDefines(const ToolChain &TC, const ArgList &Args,
                         ArgStringList &CmdArgs) {
 
  unsigned ver = 0;
  const VersionTuple vt = TC.computeMSVCVersion(nullptr, Args);
  ver = vt.getMajor() * 10000000 + vt.getMinor().value_or(0) * 100000 +
        vt.getSubminor().value_or(0);
  CmdArgs.push_back(Args.MakeArgString("-D_MSC_VER=" + Twine(ver / 100000)));
  CmdArgs.push_back(Args.MakeArgString("-D_MSC_FULL_VER=" + Twine(ver)));
  CmdArgs.push_back(Args.MakeArgString("-D_WIN32"));
 
  const llvm::Triple &triple = TC.getTriple();
  if (triple.isAArch64()) {
    CmdArgs.push_back("-D_M_ARM64=1");
  } else if (triple.isX86() && triple.isArch32Bit()) {
    CmdArgs.push_back("-D_M_IX86=600");
  } else if (triple.isX86() && triple.isArch64Bit()) {
    CmdArgs.push_back("-D_M_X64=100");
  } else {
    llvm_unreachable(
        "Flang on Windows only supports X86_32, X86_64 and AArch64");
  }
}
 
static void processVSRuntimeLibrary(const ToolChain &TC, const ArgList &Args,
                                    ArgStringList &CmdArgs) {
  assert(TC.getTriple().isKnownWindowsMSVCEnvironment() &&
         "can only add VS runtime library on Windows!");
 
  // Flang/Clang (including clang-cl) -compiled programs targeting the MSVC ABI
  // should only depend on msv(u)crt. LLVM still emits libgcc/compiler-rt
  // functions in some cases like 128-bit integer math (__udivti3, __modti3,
  // __fixsfti, __floattidf, ...) that msvc does not support. We are injecting a
  // dependency to Compiler-RT's builtin library where these are implemented.
  CmdArgs.push_back(Args.MakeArgString(
      "--dependent-lib=" + TC.getCompilerRTBasename(Args, "builtins")));
 
  unsigned RTOptionID = options::OPT__SLASH_MT;
  if (auto *rtl = Args.getLastArg(options::OPT_fms_runtime_lib_EQ)) {
    RTOptionID = llvm::StringSwitch<unsigned>(rtl->getValue())
                     .Case("static", options::OPT__SLASH_MT)
                     .Case("static_dbg", options::OPT__SLASH_MTd)
                     .Case("dll", options::OPT__SLASH_MD)
                     .Case("dll_dbg", options::OPT__SLASH_MDd)
                     .Default(options::OPT__SLASH_MT);
  }
  switch (RTOptionID) {
  case options::OPT__SLASH_MT:
    CmdArgs.push_back("-D_MT");
    CmdArgs.push_back("--dependent-lib=libcmt");
    CmdArgs.push_back("--dependent-lib=flang_rt.runtime.static.lib");
    break;
  case options::OPT__SLASH_MTd:
    CmdArgs.push_back("-D_MT");
    CmdArgs.push_back("-D_DEBUG");
    CmdArgs.push_back("--dependent-lib=libcmtd");
    CmdArgs.push_back("--dependent-lib=flang_rt.runtime.static_dbg.lib");
    break;
  case options::OPT__SLASH_MD:
    CmdArgs.push_back("-D_MT");
    CmdArgs.push_back("-D_DLL");
    CmdArgs.push_back("--dependent-lib=msvcrt");
    CmdArgs.push_back("--dependent-lib=flang_rt.runtime.dynamic.lib");
    break;
  case options::OPT__SLASH_MDd:
    CmdArgs.push_back("-D_MT");
    CmdArgs.push_back("-D_DEBUG");
    CmdArgs.push_back("-D_DLL");
    CmdArgs.push_back("--dependent-lib=msvcrtd");
    CmdArgs.push_back("--dependent-lib=flang_rt.runtime.dynamic_dbg.lib");
    break;
  }
}
 
void Flang::AddAMDGPUTargetArgs(const ArgList &Args, ArgStringList &CmdArgs,
                                BoundArch BA,
                                Action::OffloadKind DeviceOffloadKind) const {
  if (Arg *A = Args.getLastArg(options::OPT_mcode_object_version_EQ)) {
    StringRef Val = A->getValue();
    CmdArgs.push_back(Args.MakeArgString("-mcode-object-version=" + Val));
    CmdArgs.push_back(Args.MakeArgString("-mllvm"));
    CmdArgs.push_back(
        Args.MakeArgString("--amdhsa-code-object-version=" + Val));
  }
 
  const ToolChain &TC = getToolChain();
  TC.addClangTargetOptions(Args, CmdArgs, BA, DeviceOffloadKind);
}
 
void Flang::AddNVPTXTargetArgs(const ArgList &Args, ArgStringList &CmdArgs,
                               BoundArch BA,
                               Action::OffloadKind DeviceOffloadKind) const {
  // we cannot use addClangTargetOptions, as it appends unsupported args for
  // flang: -fcuda-is-device, -fno-threadsafe-statics,
  // -fcuda-allow-variadic-functions and -target-sdk-version Instead we manually
  // detect the CUDA installation and link libdevice
  const ToolChain &TC = getToolChain();
  const Driver &D = TC.getDriver();
  const llvm::Triple &Triple = TC.getEffectiveTriple();
 
  if (!Args.hasFlag(options::OPT_offloadlib, options::OPT_no_offloadlib, true))
    return;
 
  // Detect CUDA installation and link libdevice
  CudaInstallationDetector CudaInstallation(D, Triple, Args);
  if (!CudaInstallation.isValid()) {
    D.Diag(diag::err_drv_no_cuda_installation);
    return;
  }
 
  StringRef GpuArch = Args.getLastArgValue(options::OPT_march_EQ);
  if (GpuArch.empty()) {
    D.Diag(diag::err_drv_offload_missing_gpu_arch) << "NVPTX" << "flang";
    return;
  }
 
  std::string LibDeviceFile = CudaInstallation.getLibDeviceFile(GpuArch);
  if (LibDeviceFile.empty()) {
    D.Diag(diag::err_drv_no_cuda_libdevice) << GpuArch;
    return;
  }
 
  CmdArgs.push_back("-mlink-builtin-bitcode");
  CmdArgs.push_back(Args.MakeArgString(LibDeviceFile));
}
 
void Flang::addTargetOptions(const ArgList &Args, ArgStringList &CmdArgs,
                             BoundArch BA,
                             Action::OffloadKind DeviceOffloadKind) const {
  const ToolChain &TC = getToolChain();
  const llvm::Triple &Triple = TC.getEffectiveTriple();
  const Driver &D = TC.getDriver();
 
  std::string CPU = getCPUName(D, Args, Triple);
  if (!CPU.empty()) {
    CmdArgs.push_back("-target-cpu");
    CmdArgs.push_back(Args.MakeArgString(CPU));
  }
 
  addOutlineAtomicsArgs(D, getToolChain(), Args, CmdArgs, Triple);
 
  // Add the target features.
  switch (TC.getArch()) {
  default:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    break;
  case llvm::Triple::aarch64:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    AddAArch64TargetArgs(Args, CmdArgs);
    break;
  case llvm::Triple::amdgpu:
  case llvm::Triple::r600:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    AddAMDGPUTargetArgs(Args, CmdArgs, BA, DeviceOffloadKind);
    break;
  case llvm::Triple::nvptx:
  case llvm::Triple::nvptx64:
    AddNVPTXTargetArgs(Args, CmdArgs, BA, DeviceOffloadKind);
    break;
  case llvm::Triple::riscv64:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    AddRISCVTargetArgs(Args, CmdArgs);
    break;
  case llvm::Triple::x86_64:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    AddX86_64TargetArgs(Args, CmdArgs);
    break;
  case llvm::Triple::ppc:
  case llvm::Triple::ppc64:
  case llvm::Triple::ppc64le:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    AddPPCTargetArgs(Args, CmdArgs);
    break;
  case llvm::Triple::loongarch64:
    getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
    AddLoongArch64TargetArgs(Args, CmdArgs);
    break;
  }
 
  if (Arg *A = Args.getLastArg(options::OPT_fveclib)) {
    StringRef Name = A->getValue();
    if (Name == "SVML") {
      if (Triple.getArch() != llvm::Triple::x86 &&
          Triple.getArch() != llvm::Triple::x86_64)
        D.Diag(diag::err_drv_unsupported_opt_for_target)
            << Name << Triple.getArchName();
    } else if (Name == "AMDLIBM") {
      if (Triple.getArch() != llvm::Triple::x86 &&
          Triple.getArch() != llvm::Triple::x86_64)
        D.Diag(diag::err_drv_unsupported_opt_for_target)
            << Name << Triple.getArchName();
    } else if (Name == "libmvec") {
      if (Triple.getArch() != llvm::Triple::x86 &&
          Triple.getArch() != llvm::Triple::x86_64 &&
          Triple.getArch() != llvm::Triple::aarch64 &&
          Triple.getArch() != llvm::Triple::aarch64_be)
        D.Diag(diag::err_drv_unsupported_opt_for_target)
            << Name << Triple.getArchName();
    } else if (Name == "SLEEF" || Name == "ArmPL") {
      if (Triple.getArch() != llvm::Triple::aarch64 &&
          Triple.getArch() != llvm::Triple::aarch64_be)
        D.Diag(diag::err_drv_unsupported_opt_for_target)
            << Name << Triple.getArchName();
    }
 
    if (Triple.isOSDarwin()) {
      // flang doesn't currently suport nostdlib, nodefaultlibs. Adding these
      // here incase they are added someday
      if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
        if (A->getValue() == StringRef{"Accelerate"}) {
          CmdArgs.push_back("-framework");
          CmdArgs.push_back("Accelerate");
        }
      }
    }
    A->render(Args, CmdArgs);
  }
 
  if (Triple.isKnownWindowsMSVCEnvironment()) {
    processVSRuntimeLibrary(TC, Args, CmdArgs);
    addVSDefines(TC, Args, CmdArgs);
  }
 
  // TODO: Add target specific flags, ABI, mtune option etc.
  if (const Arg *A = Args.getLastArg(options::OPT_mtune_EQ)) {
    CmdArgs.push_back("-tune-cpu");
    if (A->getValue() == StringRef{"native"})
      CmdArgs.push_back(Args.MakeArgString(llvm::sys::getHostCPUName()));
    else
      CmdArgs.push_back(A->getValue());
  }
 
  Args.addAllArgs(CmdArgs,
                  {options::OPT_fverbose_asm, options::OPT_fno_verbose_asm,
                   options::OPT_fatomic_ignore_denormal_mode,
                   options::OPT_fno_atomic_ignore_denormal_mode,
                   options::OPT_fatomic_fine_grained_memory,
                   options::OPT_fno_atomic_fine_grained_memory,
                   options::OPT_fatomic_remote_memory,
                   options::OPT_fno_atomic_remote_memory,
                   options::OPT_munsafe_fp_atomics});
}
 
void Flang::addOffloadOptions(Compilation &C, const InputInfoList &Inputs,
                              const JobAction &JA, const ArgList &Args,
                              ArgStringList &CmdArgs) const {
  bool IsOpenMPDevice = JA.isDeviceOffloading(Action::OFK_OpenMP);
  bool IsHostOffloadingAction = JA.isHostOffloading(Action::OFK_OpenMP) ||
                                JA.isHostOffloading(C.getActiveOffloadKinds());
 
  // Tell the frontend when it is compiling for an offloading device, regardless
  // of offloading programming model.
  if (JA.getOffloadingDeviceKind() > Action::OFK_Host)
    CmdArgs.push_back("-foffload-device");
 
  // Skips the primary input file, which is the input file that the compilation
  // proccess will be executed upon (e.g. the host bitcode file) and
  // adds other secondary input (e.g. device bitcode files for embedding to the
  // -fembed-offload-object argument or the host IR file for proccessing
  // during device compilation to the fopenmp-host-ir-file-path argument via
  // OpenMPDeviceInput). This is condensed logic from the ConstructJob
  // function inside of the Clang driver for pushing on further input arguments
  // needed for offloading during various phases of compilation.
  for (size_t i = 1; i < Inputs.size(); ++i) {
    if (Inputs[i].getType() == types::TY_Nothing) {
      // contains nothing, so it's skippable
    } else if (IsHostOffloadingAction) {
      CmdArgs.push_back(
          Args.MakeArgString("-fembed-offload-object=" +
                             getToolChain().getInputFilename(Inputs[i])));
    } else if (IsOpenMPDevice) {
      if (Inputs[i].getFilename()) {
        CmdArgs.push_back("-fopenmp-host-ir-file-path");
        CmdArgs.push_back(Args.MakeArgString(Inputs[i].getFilename()));
      } else {
        llvm_unreachable("missing openmp host-ir file for device offloading");
      }
    } else {
      llvm_unreachable(
          "unexpectedly given multiple inputs or given unknown input");
    }
  }
 
  // When in OpenMP offloading mode, forward assumptions information about
  // thread and team counts in the target device. The host needs to know about
  // this to prevent the SPMD to SPMD-no-loop promotion being done differently
  // for host and device on the same target region.
  if (Args.hasFlag(options::OPT_fopenmp_assume_teams_oversubscription,
                   options::OPT_fno_openmp_assume_teams_oversubscription,
                   /*Default=*/false))
    CmdArgs.push_back("-fopenmp-assume-teams-oversubscription");
  if (Args.hasFlag(options::OPT_fopenmp_assume_threads_oversubscription,
                   options::OPT_fno_openmp_assume_threads_oversubscription,
                   /*Default=*/false))
    CmdArgs.push_back("-fopenmp-assume-threads-oversubscription");
 
  if (IsOpenMPDevice) {
    // -fopenmp-is-target-device is passed along to tell the frontend that it is
    // generating code for a device, so that only the relevant code is emitted.
    CmdArgs.push_back("-fopenmp-is-target-device");
 
    // -fopenmp-target-fast implies -fopenmp-assume-no-thread-state and
    // -fopenmp-assume-no-nested-parallelism, and forces -O3 unless an
    // explicit optimization level was requested.
    bool TargetFastUsed =
        Args.hasFlag(options::OPT_fopenmp_target_fast,
                     options::OPT_fno_openmp_target_fast, false);
 
    if (TargetFastUsed && !Args.hasArg(options::OPT_O_Group))
      CmdArgs.push_back("-O3");
 
    // When in OpenMP offloading mode, enable debugging on the device.
    Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_target_debug_EQ);
    if (Args.hasFlag(options::OPT_fopenmp_target_debug,
                     options::OPT_fno_openmp_target_debug, /*Default=*/false))
      CmdArgs.push_back("-fopenmp-target-debug");
 
    // Handle -fopenmp-assume-no-thread-state (implied by target-fast)
    if (Args.hasFlag(options::OPT_fopenmp_assume_no_thread_state,
                     options::OPT_fno_openmp_assume_no_thread_state,
                     /*Default=*/TargetFastUsed))
      CmdArgs.push_back("-fopenmp-assume-no-thread-state");
 
    // Handle -fopenmp-assume-no-nested-parallelism (implied by target-fast)
    if (Args.hasFlag(options::OPT_fopenmp_assume_no_nested_parallelism,
                     options::OPT_fno_openmp_assume_no_nested_parallelism,
                     /*Default=*/TargetFastUsed))
      CmdArgs.push_back("-fopenmp-assume-no-nested-parallelism");
 
    if (!Args.hasFlag(options::OPT_offloadlib, options::OPT_no_offloadlib,
                      true))
      CmdArgs.push_back("-nogpulib");
  }
 
  addOpenMPHostOffloadingArgs(C, JA, Args, CmdArgs);
}
 
static void addFloatingPointOptions(const Driver &D, const ArgList &Args,
                                    ArgStringList &CmdArgs) {
  StringRef FPContract;
  StringRef LastSeenFfpContractOption;
  StringRef LastFpContractOverrideOption;
  bool HonorINFs = true;
  bool HonorNaNs = true;
  bool ApproxFunc = false;
  bool SignedZeros = true;
  bool AssociativeMath = false;
  bool ReciprocalMath = false;
 
  StringRef LastComplexRangeOption;
  LangOptions::ComplexRangeKind Range = LangOptions::ComplexRangeKind::CX_None;
 
  for (const Arg *A : Args) {
    auto optId = A->getOption().getID();
    switch (optId) {
    // if this isn't an FP option, skip the claim below
    default:
      continue;
 
    case options::OPT_fcomplex_arithmetic_EQ: {
      LangOptions::ComplexRangeKind NewRange;
      StringRef Val = A->getValue();
      if (Val == "full")
        NewRange = LangOptions::ComplexRangeKind::CX_Full;
      else if (Val == "improved")
        NewRange = LangOptions::ComplexRangeKind::CX_Improved;
      else if (Val == "basic")
        NewRange = LangOptions::ComplexRangeKind::CX_Basic;
      else {
        D.Diag(diag::err_drv_unsupported_option_argument)
            << A->getSpelling() << Val;
        break;
      }
 
      setComplexRange(D, Args.MakeArgString(A->getSpelling() + Val), NewRange,
                      LastComplexRangeOption, Range);
      break;
    }
    case options::OPT_fhonor_infinities:
      HonorINFs = true;
      break;
    case options::OPT_fno_honor_infinities:
      HonorINFs = false;
      break;
    case options::OPT_fhonor_nans:
      HonorNaNs = true;
      break;
    case options::OPT_fno_honor_nans:
      HonorNaNs = false;
      break;
    case options::OPT_fapprox_func:
      ApproxFunc = true;
      break;
    case options::OPT_fno_approx_func:
      ApproxFunc = false;
      break;
    case options::OPT_fsigned_zeros:
      SignedZeros = true;
      break;
    case options::OPT_fno_signed_zeros:
      SignedZeros = false;
      break;
    case options::OPT_fassociative_math:
      AssociativeMath = true;
      break;
    case options::OPT_fno_associative_math:
      AssociativeMath = false;
      break;
    case options::OPT_freciprocal_math:
      ReciprocalMath = true;
      break;
    case options::OPT_fno_reciprocal_math:
      ReciprocalMath = false;
      break;
    case options::OPT_ffp_contract: {
      StringRef Val = A->getValue();
      if (Val == "fast" || Val == "off") {
        if (Val != FPContract && LastFpContractOverrideOption != "") {
          D.Diag(clang::diag::warn_drv_overriding_option)
              << LastFpContractOverrideOption
              << Args.MakeArgString("-ffp-contract=" + Val);
        }
        FPContract = Val;
        LastSeenFfpContractOption = Val;
      } else if (Val == "on") {
        // Warn instead of error because users might have makefiles written for
        // gfortran (which accepts -ffp-contract=on)
        D.Diag(diag::warn_drv_unsupported_option_for_flang)
            << Val << A->getOption().getName() << "off";
        FPContract = "off";
        LastSeenFfpContractOption = "off";
      } else {
        // Clang's "fast-honor-pragmas" option is not supported because it is
        // non-standard
        D.Diag(diag::err_drv_unsupported_option_argument)
            << A->getSpelling() << Val;
      }
      LastFpContractOverrideOption = "";
      break;
    }
    case options::OPT_Ofast:
      [[fallthrough]];
    case options::OPT_ffast_math:
      HonorINFs = false;
      HonorNaNs = false;
      AssociativeMath = true;
      ReciprocalMath = true;
      ApproxFunc = true;
      SignedZeros = false;
      FPContract = "fast";
      if (A->getOption().getID() == options::OPT_Ofast)
        LastFpContractOverrideOption = "-Ofast";
      else
        LastFpContractOverrideOption = "-ffast-math";
      setComplexRange(D, A->getSpelling(),
                      LangOptions::ComplexRangeKind::CX_Basic,
                      LastComplexRangeOption, Range);
      break;
    case options::OPT_fno_fast_math:
      HonorINFs = true;
      HonorNaNs = true;
      AssociativeMath = false;
      ReciprocalMath = false;
      ApproxFunc = false;
      SignedZeros = true;
      // -fno-fast-math should undo -ffast-math so I return FPContract to the
      // default. If -ffp-contract= was explicitly specified, restore the
      // user-requested value from LastSeenFfpContractOption so that
      // -ffp-contract=off -fno-fast-math --> -ffp-contract=off
      if (LastSeenFfpContractOption != "")
        FPContract = LastSeenFfpContractOption;
      else
        FPContract = "";
      setComplexRange(D, A->getSpelling(),
                      LangOptions::ComplexRangeKind::CX_None,
                      LastComplexRangeOption, Range);
      LastFpContractOverrideOption = "";
      break;
    }
 
    // If we handled this option claim it
    A->claim();
  }
 
  StringRef Recip = parseMRecipOption(D.getDiags(), Args);
  if (!Recip.empty())
    CmdArgs.push_back(Args.MakeArgString("-mrecip=" + Recip));
 
  if (Range != LangOptions::ComplexRangeKind::CX_None) {
    std::string ComplexRangeStr = renderComplexRangeOption(Range);
    CmdArgs.push_back(Args.MakeArgString(ComplexRangeStr));
    CmdArgs.push_back(Args.MakeArgString("-fcomplex-arithmetic=" +
                                         complexRangeKindToStr(Range)));
  }
 
  if (llvm::opt::Arg *A =
          Args.getLastArg(clang::options::OPT_ffast_real_mod,
                          clang::options::OPT_fno_fast_real_mod)) {
    if (A->getOption().matches(clang::options::OPT_ffast_real_mod))
      CmdArgs.push_back("-ffast-real-mod");
    else if (A->getOption().matches(clang::options::OPT_fno_fast_real_mod))
      CmdArgs.push_back("-fno-fast-real-mod");
  }
 
  if (!HonorINFs && !HonorNaNs && AssociativeMath && ReciprocalMath &&
      ApproxFunc && !SignedZeros &&
      (FPContract == "fast" || FPContract.empty())) {
    CmdArgs.push_back("-ffast-math");
    return;
  }
 
  if (!FPContract.empty())
    CmdArgs.push_back(Args.MakeArgString("-ffp-contract=" + FPContract));
 
  if (!HonorINFs)
    CmdArgs.push_back("-menable-no-infs");
 
  if (!HonorNaNs)
    CmdArgs.push_back("-menable-no-nans");
 
  if (ApproxFunc)
    CmdArgs.push_back("-fapprox-func");
 
  if (!SignedZeros)
    CmdArgs.push_back("-fno-signed-zeros");
 
  if (AssociativeMath && !SignedZeros)
    CmdArgs.push_back("-mreassociate");
 
  if (ReciprocalMath)
    CmdArgs.push_back("-freciprocal-math");
}
 
// Add options related to IEEE Floating point modes
//
// Initial halting mode:
// Validate -ffpe-trap= and forward it to -fc1. This is handled separately from
// addFloatingPointOptions() on purpose: -ffpe-trap= is not part of the
// fast-math option set, so it must not be skipped by that function's
// -ffast-math fast path. The value check and the target-support warnings depend
// only on the option value and the target triple (no frontend-only state), so
// they are done here in the driver rather than deferred to -fc1; -fc1 only
// translates the list into its LangOptions bitmask.
//
// TODO:
// Rounding modes
// Underflow mode
static void addIEEEFPModesOptions(const Driver &D, const ArgList &Args,
                                  ArgStringList &CmdArgs,
                                  const llvm::Triple &Triple) {
  const Arg *A = Args.getLastArg(options::OPT_ffpe_trap_EQ);
  if (!A)
    return;
 
  // The value is a comma-separated list of exception mnemonics. "none" and an
  // empty list request no halting and reset any earlier request in the list;
  // any other unrecognized mnemonic is an error.
  llvm::SmallVector<StringRef, 6> Traps;
  StringRef(A->getValue())
      .split(Traps, ',', /*MaxSplit=*/-1, /*KeepEmpty=*/false);
 
  bool RequestsTrap = false;
  bool RequestsDenormal = false;
  for (StringRef Trap : Traps) {
    if (Trap == "none") {
      RequestsTrap = false;
      RequestsDenormal = false;
      continue;
    }
    bool IsKnown = llvm::StringSwitch<bool>(Trap)
                       .Cases({"invalid", "zero", "overflow", "underflow",
                               "inexact", "denormal"},
                              true)
                       .Default(false);
    if (!IsKnown) {
      D.Diag(diag::err_drv_unsupported_option_argument)
          << A->getSpelling() << Trap;
      return;
    }
    RequestsTrap = true;
    RequestsDenormal |= (Trap == "denormal");
  }
 
  // Run-time halting is implemented in flang-rt only where the target's
  // floating-point environment can trap: it relies on glibc's feenableexcept
  // (in practice Linux), and "denormal" additionally requires an x86 target.
  // Warn (conservatively) when the target cannot honor the request; the runtime
  // otherwise ignores it. The denormal-specific warning names just
  // "-ffpe-trap=denormal" to point at the unsupported mnemonic.
  if (RequestsTrap && !Triple.isX86() && !Triple.isOSLinux())
    D.Diag(diag::warn_drv_unsupported_option_for_target)
        << A->getAsString(Args) << Triple.str();
  else if (RequestsDenormal && !Triple.isX86())
    D.Diag(diag::warn_drv_unsupported_option_for_target)
        << "-ffpe-trap=denormal" << Triple.str();
 
  A->render(Args, CmdArgs);
}
 
static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
                                 const InputInfo &Input) {
  StringRef Format = "yaml";
  if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
    Format = A->getValue();
 
  CmdArgs.push_back("-opt-record-file");
 
  const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
  if (A) {
    CmdArgs.push_back(A->getValue());
  } else {
    SmallString<128> F;
 
    if (Args.hasArg(options::OPT_c) || Args.hasArg(options::OPT_S)) {
      if (Arg *FinalOutput = Args.getLastArg(options::OPT_o))
        F = FinalOutput->getValue();
    }
 
    if (F.empty()) {
      // Use the input filename.
      F = llvm::sys::path::stem(Input.getBaseInput());
    }
 
    SmallString<32> Extension;
    Extension += "opt.";
    Extension += Format;
 
    llvm::sys::path::replace_extension(F, Extension);
    CmdArgs.push_back(Args.MakeArgString(F));
  }
 
  if (const Arg *A =
          Args.getLastArg(options::OPT_foptimization_record_passes_EQ)) {
    CmdArgs.push_back("-opt-record-passes");
    CmdArgs.push_back(A->getValue());
  }
 
  if (!Format.empty()) {
    CmdArgs.push_back("-opt-record-format");
    CmdArgs.push_back(Format.data());
  }
}
 
static void addPGOAndCoverageFlags(const ToolChain &TC, const JobAction &JA,
                                   const ArgList &Args,
                                   ArgStringList &CmdArgs) {
  const Driver &D = TC.getDriver();
  const llvm::Triple &T = TC.getTriple();
 
  bool IsCudaDevice = JA.isDeviceOffloading(Action::OFK_Cuda);
  bool IsHIPDevice = JA.isDeviceOffloading(Action::OFK_HIP);
 
  if (T.isOSAIX()) {
    if (Arg *ProfileSampleUseArg = getLastProfileSampleUseArg(Args))
      D.Diag(diag::err_drv_unsupported_opt_for_target)
          << ProfileSampleUseArg->getSpelling() << TC.getTriple().str();
  }
 
  if (!(IsCudaDevice || IsHIPDevice)) {
    // recognise options: -fprofile-sample-use= and -fno-profile-sample-use=
    if (Arg *A = getLastProfileSampleUseArg(Args)) {
      if (Arg *PGOArg = Args.getLastArg(options::OPT_fprofile_generate,
                                        options::OPT_fprofile_generate_EQ)) {
        D.Diag(diag::err_drv_argument_not_allowed_with)
            << PGOArg->getAsString(Args) << A->getAsString(Args);
      }
 
      StringRef fname = A->getValue();
      if (!llvm::sys::fs::exists(fname))
        D.Diag(diag::err_drv_no_such_file) << fname;
      else
        A->render(Args, CmdArgs);
    }
  }
 
  //-fpseudo-probe-for-profiling
  if (Args.hasFlag(options::OPT_fpseudo_probe_for_profiling,
                   options::OPT_fno_pseudo_probe_for_profiling, false))
    CmdArgs.push_back("-fpseudo-probe-for-profiling");
 
  // TODO: Consider reusing Clang's addPGOAndCoverageFlags() for
  // -fprofile-generate and other similar options handling instead of
  // duplicating driver logic here.
  if (Arg *PGOGenerateArg = Args.getLastArg(
          options::OPT_fprofile_generate, options::OPT_fprofile_generate_EQ,
          options::OPT_fno_profile_generate)) {
    if (!PGOGenerateArg->getOption().matches(options::OPT_fno_profile_generate))
      PGOGenerateArg->render(Args, CmdArgs);
  }
 
  addSplitMachineFunctionsArgs(TC.getDriver(), Args, CmdArgs, TC.getTriple());
  Args.addAllArgs(CmdArgs, {options::OPT_fprofile_use_EQ});
}
 
void Flang::ConstructJob(Compilation &C, const JobAction &JA,
                         const InputInfo &Output, const InputInfoList &Inputs,
                         const ArgList &Args, const char *LinkingOutput) const {
  const auto &TC = getToolChain();
  const llvm::Triple &Triple = TC.getEffectiveTriple();
  const std::string &TripleStr = Triple.getTriple();
 
  const Driver &D = TC.getDriver();
  ArgStringList CmdArgs;
 
  // Invoke ourselves in -fc1 mode.
  CmdArgs.push_back("-fc1");
 
  // Add the "effective" target triple.
  CmdArgs.push_back("-triple");
  CmdArgs.push_back(Args.MakeArgString(TripleStr));
 
  if (isa<PreprocessJobAction>(JA)) {
    if (Output.getType() == types::TY_Dependencies) {
      CmdArgs.push_back("-fsyntax-only");
    } else {
      CmdArgs.push_back("-E");
      if (Args.getLastArg(options::OPT_dM))
        CmdArgs.push_back("-dM");
    }
  } else if (isa<CompileJobAction>(JA) || isa<BackendJobAction>(JA)) {
    if (JA.getType() == types::TY_Nothing) {
      CmdArgs.push_back("-fsyntax-only");
    } else if (JA.getType() == types::TY_AST) {
      CmdArgs.push_back("-emit-ast");
    } else if (JA.getType() == types::TY_LLVM_IR ||
               JA.getType() == types::TY_LTO_IR) {
      CmdArgs.push_back("-emit-llvm");
    } else if (JA.getType() == types::TY_LLVM_BC ||
               JA.getType() == types::TY_LTO_BC) {
      CmdArgs.push_back("-emit-llvm-bc");
    } else if (JA.getType() == types::TY_PP_Asm) {
      CmdArgs.push_back("-S");
    } else {
      assert(false && "Unexpected output type!");
    }
  } else if (isa<AssembleJobAction>(JA)) {
    CmdArgs.push_back("-emit-obj");
  } else if (isa<PrecompileJobAction>(JA)) {
    // The precompile job action is only needed for options such as -mcpu=help.
    // Those will already have been handled by the fc1 driver.
  } else {
    assert(false && "Unexpected action class for Flang tool.");
  }
 
  // We support some options that are invalid for Fortran and have no effect.
  // These are solely for compatibility with other compilers. Emit a warning if
  // any such options are provided, then proceed normally.
  for (options::ID Opt : {options::OPT_fbuiltin, options::OPT_fno_builtin})
    if (const Arg *A = Args.getLastArg(Opt))
      D.Diag(diag::warn_drv_invalid_argument_for_flang) << A->getSpelling();
 
  // Warn about options that are ignored by flang. These are options that are
  // accepted by gfortran, but have no equivalent in flang.
  for (const Arg *A :
       Args.filtered(options::OPT_clang_ignored_gcc_optimization_f_Group)) {
    D.Diag(diag::warn_ignored_gcc_optimization) << A->getAsString(Args);
    A->claim();
  }
 
  // -fkeep-inline-functions/-fno-keep-inline-functions are real Clang options
  // but are not supported by Flang; warn and ignore them.
  for (options::ID Opt : {options::OPT_fkeep_inline_functions,
                          options::OPT_fno_keep_inline_functions}) {
    if (const Arg *A = Args.getLastArg(Opt)) {
      D.Diag(diag::warn_ignored_gcc_optimization) << A->getAsString(Args);
      A->claim();
    }
  }
 
  const InputInfo &Input = Inputs[0];
  types::ID InputType = Input.getType();
 
  // Add preprocessing options like -I, -D, etc. if we are using the
  // preprocessor (i.e. skip when dealing with e.g. binary files).
  if (types::getPreprocessedType(InputType) != types::TY_INVALID)
    addPreprocessingOptions(Args, CmdArgs);
 
  addFortranDialectOptions(Args, CmdArgs);
 
  // 'flang -E' always produces output that is suitable for use as fixed form
  // Fortran. However it is only valid free form source if the original is also
  // free form. Ensure this logic does not incorrectly assume fixed-form for
  // cases where it shouldn't, such as `flang -x f95 foo.f90`.
  bool isAtemporaryPreprocessedFile =
      Input.isFilename() &&
      llvm::sys::path::extension(Input.getFilename())
          .ends_with(types::getTypeTempSuffix(InputType, /*CLStyle=*/false));
  if (InputType == types::TY_PP_Fortran && isAtemporaryPreprocessedFile &&
      !Args.getLastArg(options::OPT_ffixed_form, options::OPT_ffree_form))
    CmdArgs.push_back("-ffixed-form");
 
  handleColorDiagnosticsArgs(D, Args, CmdArgs);
 
  addLTOOptions(Args, CmdArgs);
 
  // -fPIC and related options.
  addPicOptions(Args, CmdArgs);
 
  // Floating point related options
  addFloatingPointOptions(D, Args, CmdArgs);
 
  // Initial floating-point exception halting mode. Handled separately so it is
  // not skipped by the -ffast-math fast path in addFloatingPointOptions().
  addIEEEFPModesOptions(D, Args, CmdArgs, Triple);
 
  // Integer MOD/MODULO zero-divisor check. Forwarded here with -ffpe-trap=
  // rather than in addFloatingPointOptions() so -ffast-math does not drop it.
  Args.AddLastArg(CmdArgs, options::OPT_fcheck_integer_mod_zero_divisor);
 
  // Add target args, features, etc.
  addTargetOptions(Args, CmdArgs, JA.getOffloadingArch(),
                   JA.getOffloadingDeviceKind());
 
  if (!TC.useIntegratedAs())
    CmdArgs.push_back("-no-integrated-as");
 
  llvm::Reloc::Model RelocationModel =
      std::get<0>(ParsePICArgs(getToolChain(), Args));
  // Add MCModel information
  addMCModel(D, Args, Triple, RelocationModel, CmdArgs);
 
  // Add Codegen options
  addCodegenOptions(Args, CmdArgs);
 
  // Add R Group options
  Args.AddAllArgs(CmdArgs, options::OPT_R_Group);
 
  // Remarks can be enabled with any of the `-f.*optimization-record.*` flags.
  if (willEmitRemarks(Args))
    renderRemarksOptions(Args, CmdArgs, Input);
 
  // Add debug compile options
  addDebugOptions(Args, JA, Output, Input, CmdArgs);
 
  // Disable all warnings
  // TODO: Handle interactions between -w, -pedantic, -Wall, -WOption
  Args.AddLastArg(CmdArgs, options::OPT_w);
 
  addPGOAndCoverageFlags(TC, JA, Args, CmdArgs);
 
  // Forward flags for OpenMP. We don't do this if the current action is an
  // device offloading action other than OpenMP.
  if (Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
                   options::OPT_fno_openmp, false) &&
      (JA.isDeviceOffloading(Action::OFK_None) ||
       JA.isDeviceOffloading(Action::OFK_OpenMP))) {
    switch (D.getOpenMPRuntime(Args)) {
    case Driver::OMPRT_OMP:
    case Driver::OMPRT_IOMP5:
      // Clang can generate useful OpenMP code for these two runtime libraries.
      CmdArgs.push_back("-fopenmp");
      Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_version_EQ);
 
      if (Args.hasArg(options::OPT_fopenmp_force_usm))
        CmdArgs.push_back("-fopenmp-force-usm");
      Args.AddLastArg(CmdArgs, options::OPT_fopenmp_simd,
                      options::OPT_fno_openmp_simd);
 
      // FIXME: Clang supports a whole bunch more flags here.
      break;
    default:
      // By default, if Clang doesn't know how to generate useful OpenMP code
      // for a specific runtime library, we just don't pass the '-fopenmp' flag
      // down to the actual compilation.
      // FIXME: It would be better to have a mode which *only* omits IR
      // generation based on the OpenMP support so that we get consistent
      // semantic analysis, etc.
      const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
      D.Diag(diag::warn_drv_unsupported_openmp_library)
          << A->getSpelling() << A->getValue();
      break;
    }
  } else {
    Args.AddLastArg(CmdArgs, options::OPT_fopenmp_simd,
                    options::OPT_fno_openmp_simd);
  }
 
  // Pass the path to compiler resource files.
  CmdArgs.push_back("-resource-dir");
  CmdArgs.push_back(D.ResourceDir.c_str());
 
  // Default intrinsic module dirs must be added after any user-provided dirs in
  // -fintrinsic-modules-path since the default dirs have lower precedence than
  // user-provided dirs
  if (std::optional<std::string> IntrModPath =
          TC.getDefaultIntrinsicModuleDir()) {
    CmdArgs.push_back("-fintrinsic-modules-path");
    CmdArgs.push_back(Args.MakeArgString(*IntrModPath));
  }
 
  // Ideally, every target triple has its own set of builtin modules since they
  // are compiled with platform-dependent conditionals such as `#if __x86_64__`.
  // However, getting the builtin modules for offload targets requires building
  // the flang-rt and openmp for those targets as well:
  // -DLLVM_RUNTIME_TARGETS=default;amdgcn-amd-amdhsa;nvptx64-nvidia-cuda.
  // To reduce friction when build systems have not yet been updated, we also
  // add the host's builtin module to the search path (with lower priority), in
  // case a module file has not been found for the offload targets itself.
  // FIXME: This workaround may mix module files targeting different triples and
  //        should eventually be removed.
  auto &&HostTCs =
      C.getOffloadToolChains<clang::driver::OffloadAction ::OFK_Host>();
  for (auto [OKind, HostTC] : llvm::make_range(HostTCs.first, HostTCs.second)) {
    if (HostTC == &TC)
      continue;
 
    if (std::optional<std::string> IntrModPath =
            HostTC->getDefaultIntrinsicModuleDir()) {
      CmdArgs.push_back("-fintrinsic-modules-path");
      CmdArgs.push_back(Args.MakeArgString(*IntrModPath));
    }
  }
 
  // Offloading related options
  addOffloadOptions(C, Inputs, JA, Args, CmdArgs);
 
  // Forward -Xflang arguments to -fc1
  Args.AddAllArgValues(CmdArgs, options::OPT_Xflang);
 
  CodeGenOptions::FramePointerKind FPKeepKind =
      getFramePointerKind(Args, Triple);
 
  const char *FPKeepKindStr = nullptr;
  switch (FPKeepKind) {
  case CodeGenOptions::FramePointerKind::None:
    FPKeepKindStr = "-mframe-pointer=none";
    break;
  case CodeGenOptions::FramePointerKind::Reserved:
    FPKeepKindStr = "-mframe-pointer=reserved";
    break;
  case CodeGenOptions::FramePointerKind::NonLeafNoReserve:
    FPKeepKindStr = "-mframe-pointer=non-leaf-no-reserve";
    break;
  case CodeGenOptions::FramePointerKind::NonLeaf:
    FPKeepKindStr = "-mframe-pointer=non-leaf";
    break;
  case CodeGenOptions::FramePointerKind::All:
    FPKeepKindStr = "-mframe-pointer=all";
    break;
  }
  assert(FPKeepKindStr && "unknown FramePointerKind");
  CmdArgs.push_back(FPKeepKindStr);
 
  // Forward -mllvm options to the LLVM option parser. In practice, this means
  // forwarding to `-fc1` as that's where the LLVM parser is run.
  for (const Arg *A : Args.filtered(options::OPT_mllvm)) {
    A->claim();
    A->render(Args, CmdArgs);
  }
 
  for (const Arg *A : Args.filtered(options::OPT_mmlir)) {
    A->claim();
    A->render(Args, CmdArgs);
  }
 
  // Remove any unsupported gfortran diagnostic options
  for (const Arg *A : Args.filtered(options::OPT_flang_ignored_w_Group)) {
    A->claim();
    D.Diag(diag::warn_drv_unsupported_diag_option_for_flang)
        << A->getOption().getName();
  }
 
  // Optimization level for CodeGen.
  if (const Arg *A = Args.getLastArg(options::OPT_O_Group)) {
    if (A->getOption().matches(options::OPT_O4)) {
      CmdArgs.push_back("-O3");
      D.Diag(diag::warn_O4_is_O3);
    } else if (A->getOption().matches(options::OPT_Ofast)) {
      CmdArgs.push_back("-O3");
      D.Diag(diag::warn_drv_deprecated_arg_ofast_for_flang);
    } else {
      A->render(Args, CmdArgs);
    }
  }
 
  renderGlobalISelOptions(D, Args, CmdArgs, Triple);
  renderCommonIntegerOverflowOptions(Args, CmdArgs, false);
 
  assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");
  if (Output.isFilename()) {
    CmdArgs.push_back("-o");
    CmdArgs.push_back(Output.getFilename());
  }
 
  if (Args.getLastArg(options::OPT_save_temps_EQ))
    Args.AddLastArg(CmdArgs, options::OPT_save_temps_EQ);
 
  renderDependencyGenerationOptions(C, JA, Args, Output, Inputs, CmdArgs);
 
  addDashXForInput(Args, Input, CmdArgs);
 
  bool FRecordCmdLine = false;
  bool GRecordCmdLine = false;
  bool DXRecordCmdLine = false;
  if (shouldRecordCommandLine(TC, Args, FRecordCmdLine, GRecordCmdLine,
                              DXRecordCmdLine)) {
    const char *CmdLine = renderEscapedCommandLine(TC, Args);
    if (FRecordCmdLine) {
      CmdArgs.push_back("-record-command-line");
      CmdArgs.push_back(CmdLine);
    }
    if (TC.UseDwarfDebugFlags() || GRecordCmdLine) {
      CmdArgs.push_back("-dwarf-debug-flags");
      CmdArgs.push_back(CmdLine);
    }
  }
 
  // The input could be Ty_Nothing when "querying" options such as -mcpu=help
  // are used.
  ArrayRef<InputInfo> FrontendInputs = Input;
  if (Input.isNothing())
    FrontendInputs = {};
 
  for (const InputInfo &Input : FrontendInputs) {
    if (Input.isFilename())
      CmdArgs.push_back(Input.getFilename());
    else
      Input.getInputArg().renderAsInput(Args, CmdArgs);
  }
 
  // Handle "clang --driver-mode=flang" case
  bool isClangDriverWithFlangMode = false;
  std::string DriverName = D.Name;
  if (const char *PA = D.getPrependArg())
    DriverName = PA;
  if (DriverName.find("clang") != std::string::npos && D.IsFlangMode())
    isClangDriverWithFlangMode = true;
 
  const char *Exec = isClangDriverWithFlangMode
                         ? Args.MakeArgString(D.GetProgramPath("flang", TC))
                         : D.getDriverProgramPath();
  C.addCommand(std::make_unique<Command>(JA, *this,
                                         ResponseFileSupport::AtFileUTF8(),
                                         Exec, CmdArgs, Inputs, Output));
}
 
Flang::Flang(const ToolChain &TC) : Tool("flang", "flang frontend", TC) {}
 
Flang::~Flang() {}