diff options
| author | Stephen Hines <srhines@google.com> | 2019-07-02 16:25:20 -0700 |
|---|---|---|
| committer | Ali B <abittin@gmail.com> | 2019-07-05 19:33:16 +0300 |
| commit | 9afee4e65dc5f9f5eb371683729ff67b8df81d03 (patch) | |
| tree | 4cf241d6c9044f91ee8c06e6920174d06f8de0b6 /clang-r353983e/include/clang/Driver/Job.h | |
| parent | 2f19bd722c4c825320d1511c1ed83161b7f95d51 (diff) | |
clang 9.0.5 (based on r353983e) from build 5696680.
Bug: http://b/135931688
Bug: http://b/136008926
Test: N/A
Change-Id: I922d17410047d2e2df4625615352c588ee71b203
Diffstat (limited to 'clang-r353983e/include/clang/Driver/Job.h')
| -rw-r--r-- | clang-r353983e/include/clang/Driver/Job.h | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/clang-r353983e/include/clang/Driver/Job.h b/clang-r353983e/include/clang/Driver/Job.h new file mode 100644 index 00000000..41d97228 --- /dev/null +++ b/clang-r353983e/include/clang/Driver/Job.h @@ -0,0 +1,204 @@ +//===- Job.h - Commands to Execute ------------------------------*- 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_DRIVER_JOB_H +#define LLVM_CLANG_DRIVER_JOB_H + +#include "clang/Basic/LLVM.h" +#include "llvm/ADT/ArrayRef.h" +#include "llvm/ADT/Optional.h" +#include "llvm/ADT/SmallVector.h" +#include "llvm/ADT/StringRef.h" +#include "llvm/ADT/iterator.h" +#include "llvm/Option/Option.h" +#include <memory> +#include <string> +#include <utility> +#include <vector> + +namespace clang { +namespace driver { + +class Action; +class InputInfo; +class Tool; + +struct CrashReportInfo { + StringRef Filename; + StringRef VFSPath; + + CrashReportInfo(StringRef Filename, StringRef VFSPath) + : Filename(Filename), VFSPath(VFSPath) {} +}; + +/// Command - An executable path/name and argument vector to +/// execute. +class Command { + /// Source - The action which caused the creation of this job. + const Action &Source; + + /// Tool - The tool which caused the creation of this job. + const Tool &Creator; + + /// The executable to run. + const char *Executable; + + /// The list of program arguments (not including the implicit first + /// argument, which will be the executable). + llvm::opt::ArgStringList Arguments; + + /// The list of program arguments which are inputs. + llvm::opt::ArgStringList InputFilenames; + + /// Whether to print the input filenames when executing. + bool PrintInputFilenames = false; + + /// Response file name, if this command is set to use one, or nullptr + /// otherwise + const char *ResponseFile = nullptr; + + /// The input file list in case we need to emit a file list instead of a + /// proper response file + llvm::opt::ArgStringList InputFileList; + + /// String storage if we need to create a new argument to specify a response + /// file + std::string ResponseFileFlag; + + /// See Command::setEnvironment + std::vector<const char *> Environment; + + /// When a response file is needed, we try to put most arguments in an + /// exclusive file, while others remains as regular command line arguments. + /// This functions fills a vector with the regular command line arguments, + /// argv, excluding the ones passed in a response file. + void buildArgvForResponseFile(llvm::SmallVectorImpl<const char *> &Out) const; + + /// Encodes an array of C strings into a single string separated by whitespace. + /// This function will also put in quotes arguments that have whitespaces and + /// will escape the regular backslashes (used in Windows paths) and quotes. + /// The results are the contents of a response file, written into a raw_ostream. + void writeResponseFile(raw_ostream &OS) const; + +public: + Command(const Action &Source, const Tool &Creator, const char *Executable, + const llvm::opt::ArgStringList &Arguments, + ArrayRef<InputInfo> Inputs); + // FIXME: This really shouldn't be copyable, but is currently copied in some + // error handling in Driver::generateCompilationDiagnostics. + Command(const Command &) = default; + virtual ~Command() = default; + + virtual void Print(llvm::raw_ostream &OS, const char *Terminator, bool Quote, + CrashReportInfo *CrashInfo = nullptr) const; + + virtual int Execute(ArrayRef<Optional<StringRef>> Redirects, + std::string *ErrMsg, bool *ExecutionFailed) const; + + /// getSource - Return the Action which caused the creation of this job. + const Action &getSource() const { return Source; } + + /// getCreator - Return the Tool which caused the creation of this job. + const Tool &getCreator() const { return Creator; } + + /// Set to pass arguments via a response file when launching the command + void setResponseFile(const char *FileName); + + /// Set an input file list, necessary if we need to use a response file but + /// the tool being called only supports input files lists. + void setInputFileList(llvm::opt::ArgStringList List) { + InputFileList = std::move(List); + } + + /// Sets the environment to be used by the new process. + /// \param NewEnvironment An array of environment variables. + /// \remark If the environment remains unset, then the environment + /// from the parent process will be used. + void setEnvironment(llvm::ArrayRef<const char *> NewEnvironment); + + const char *getExecutable() const { return Executable; } + + const llvm::opt::ArgStringList &getArguments() const { return Arguments; } + + /// Print a command argument, and optionally quote it. + static void printArg(llvm::raw_ostream &OS, StringRef Arg, bool Quote); + + /// Set whether to print the input filenames when executing. + void setPrintInputFilenames(bool P) { PrintInputFilenames = P; } +}; + +/// Like Command, but with a fallback which is executed in case +/// the primary command crashes. +class FallbackCommand : public Command { +public: + FallbackCommand(const Action &Source_, const Tool &Creator_, + const char *Executable_, + const llvm::opt::ArgStringList &Arguments_, + ArrayRef<InputInfo> Inputs, + std::unique_ptr<Command> Fallback_); + + void Print(llvm::raw_ostream &OS, const char *Terminator, bool Quote, + CrashReportInfo *CrashInfo = nullptr) const override; + + int Execute(ArrayRef<Optional<StringRef>> Redirects, std::string *ErrMsg, + bool *ExecutionFailed) const override; + +private: + std::unique_ptr<Command> Fallback; +}; + +/// Like Command, but always pretends that the wrapped command succeeded. +class ForceSuccessCommand : public Command { +public: + ForceSuccessCommand(const Action &Source_, const Tool &Creator_, + const char *Executable_, + const llvm::opt::ArgStringList &Arguments_, + ArrayRef<InputInfo> Inputs); + + void Print(llvm::raw_ostream &OS, const char *Terminator, bool Quote, + CrashReportInfo *CrashInfo = nullptr) const override; + + int Execute(ArrayRef<Optional<StringRef>> Redirects, std::string *ErrMsg, + bool *ExecutionFailed) const override; +}; + +/// JobList - A sequence of jobs to perform. +class JobList { +public: + using list_type = SmallVector<std::unique_ptr<Command>, 4>; + using size_type = list_type::size_type; + using iterator = llvm::pointee_iterator<list_type::iterator>; + using const_iterator = llvm::pointee_iterator<list_type::const_iterator>; + +private: + list_type Jobs; + +public: + void Print(llvm::raw_ostream &OS, const char *Terminator, + bool Quote, CrashReportInfo *CrashInfo = nullptr) const; + + /// Add a job to the list (taking ownership). + void addJob(std::unique_ptr<Command> J) { Jobs.push_back(std::move(J)); } + + /// Clear the job list. + void clear(); + + const list_type &getJobs() const { return Jobs; } + + bool empty() const { return Jobs.empty(); } + size_type size() const { return Jobs.size(); } + iterator begin() { return Jobs.begin(); } + const_iterator begin() const { return Jobs.begin(); } + iterator end() { return Jobs.end(); } + const_iterator end() const { return Jobs.end(); } +}; + +} // namespace driver +} // namespace clang + +#endif // LLVM_CLANG_DRIVER_JOB_H |
