mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-05 18:51:11 +01:00
Chandler CarruthandJon Ross-Perkins
d3a5b0eee7
The install directory contains the BUILD logic for creating an installable tree of data files and executables for the toolchain, and a library to facilitate toolchain code accessing the paths to their data within this installation. Then adds an installation of LLD in a synthetic LLVM installation, and teaches the Clang runner to configure this and use it for linking instead of the system linker. Currently, the install paths only really manage access to the LLVM binaries installed and used by the Clang runner for linking, but eventually other data files like the prelude and runtime libraries will be fleshed out as well. There are TODOs for moving more things over here such as the prelude. One interesting aspect of this is where to put helpers like parts of LLVM in our install. This PR suggests nesting those files under `lib/carbon`. While using a `lib` subdirectory isn't a perfect fit for the FHS (Filesystem Hierarchy Standard), having a single location where private data is collected is significantly superior to spreading them across the system. This also matches similar patterns used by Clang itself and several other language toolchains and standard libraries. The install directory also provides a natural place for us to build out packaging rules to create installable packages in various formats, but that remains future work. --------- Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
62 lines
2.5 KiB
C++
62 lines
2.5 KiB
C++
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
// Exceptions. See /LICENSE for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
#ifndef CARBON_TOOLCHAIN_DRIVER_CLANG_RUNNER_H_
|
|
#define CARBON_TOOLCHAIN_DRIVER_CLANG_RUNNER_H_
|
|
|
|
#include "clang/Basic/DiagnosticIDs.h"
|
|
#include "common/ostream.h"
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "toolchain/install/install_paths.h"
|
|
|
|
namespace Carbon {
|
|
|
|
// Runs Clang in a similar fashion to invoking it with the provided arguments on
|
|
// the command line. We use a textual command line interface to allow easily
|
|
// incorporating custom command line flags from user invocations that we don't
|
|
// parse, but will pass transparently along to Clang itself.
|
|
//
|
|
// This doesn't literally use a subprocess to invoke Clang; it instead tries to
|
|
// directly use the Clang command line driver library. We also work to simplify
|
|
// how that driver operates and invoke it in an opinionated way to get the best
|
|
// behavior for our expected use cases in the Carbon driver:
|
|
//
|
|
// - Minimize canonicalization of file names to try to preserve the paths as
|
|
// users type them.
|
|
// - Minimize the use of subprocess invocations which are expensive on some
|
|
// operating systems. To the extent possible, we try to directly invoke the
|
|
// Clang logic within this process.
|
|
// - Provide programmatic API to control defaults of Clang. For example, causing
|
|
// verbose output.
|
|
//
|
|
// Note that this makes the current process behave like running Clang -- it uses
|
|
// standard output and standard error, and otherwise can only read and write
|
|
// files based on their names described in the arguments. It doesn't provide any
|
|
// higher-level abstraction such as streams for inputs or outputs.
|
|
class ClangRunner {
|
|
public:
|
|
// Build a Clang runner that uses the provided `exe_name` and `err_stream`.
|
|
//
|
|
// If `verbose` is passed as true, will enable verbose logging to the
|
|
// `err_stream` both from the runner and Clang itself.
|
|
ClangRunner(const InstallPaths* install_paths, llvm::StringRef target,
|
|
llvm::raw_ostream* vlog_stream = nullptr);
|
|
|
|
// Run Clang with the provided arguments.
|
|
auto Run(llvm::ArrayRef<llvm::StringRef> args) -> bool;
|
|
|
|
private:
|
|
const InstallPaths* installation_;
|
|
|
|
llvm::StringRef target_;
|
|
llvm::raw_ostream* vlog_stream_;
|
|
|
|
llvm::IntrusiveRefCntPtr<clang::DiagnosticIDs> diagnostic_ids_;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // CARBON_TOOLCHAIN_DRIVER_CLANG_RUNNER_H_
|