LLVM  15.0.0git
ToolOutputFile.cpp
Go to the documentation of this file.
1 //===--- ToolOutputFile.cpp - Implement the ToolOutputFile class --------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This implements the ToolOutputFile class.
10 //
11 //===----------------------------------------------------------------------===//
12 
15 #include "llvm/Support/Signals.h"
16 using namespace llvm;
17 
18 static bool isStdout(StringRef Filename) { return Filename == "-"; }
19 
20 ToolOutputFile::CleanupInstaller::CleanupInstaller(StringRef Filename)
21  : Filename(std::string(Filename)), Keep(false) {
22  // Arrange for the file to be deleted if the process is killed.
23  if (!isStdout(Filename))
24  sys::RemoveFileOnSignal(Filename);
25 }
26 
27 ToolOutputFile::CleanupInstaller::~CleanupInstaller() {
28  if (isStdout(Filename))
29  return;
30 
31  // Delete the file if the client hasn't told us not to.
32  if (!Keep)
33  sys::fs::remove(Filename);
34 
35  // Ok, the file is successfully written and closed, or deleted. There's no
36  // further need to clean it up on signals.
38 }
39 
40 ToolOutputFile::ToolOutputFile(StringRef Filename, std::error_code &EC,
41  sys::fs::OpenFlags Flags)
42  : Installer(Filename) {
43  if (isStdout(Filename)) {
44  OS = &outs();
45  EC = std::error_code();
46  return;
47  }
48  OSHolder.emplace(Filename, EC, Flags);
49  OS = OSHolder.getPointer();
50  // If open fails, no cleanup is needed.
51  if (EC)
52  Installer.Keep = true;
53 }
54 
56  : Installer(Filename) {
57  OSHolder.emplace(FD, true);
58  OS = OSHolder.getPointer();
59 }
Signals.h
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
FileSystem.h
llvm::ToolOutputFile::ToolOutputFile
ToolOutputFile(StringRef Filename, std::error_code &EC, sys::fs::OpenFlags Flags)
This constructor's arguments are passed to raw_fd_ostream's constructor.
Definition: ToolOutputFile.cpp:40
llvm::outs
raw_fd_ostream & outs()
This returns a reference to a raw_fd_ostream for standard output.
Definition: raw_ostream.cpp:885
false
Definition: StackSlotColoring.cpp:141
ToolOutputFile.h
isStdout
static bool isStdout(StringRef Filename)
Definition: ToolOutputFile.cpp:18
llvm::sys::fs::remove
std::error_code remove(const Twine &path, bool IgnoreNonExisting=true)
Remove path.
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
std
Definition: BitVector.h:851
llvm::sys::fs::OpenFlags
OpenFlags
Definition: FileSystem.h:756
llvm::FunctionReturnThunksKind::Keep
@ Keep
No function return thunk.
llvm::sys::DontRemoveFileOnSignal
void DontRemoveFileOnSignal(StringRef Filename)
This function removes a file from the list of files to be removed on signal delivery.
llvm::sys::RemoveFileOnSignal
bool RemoveFileOnSignal(StringRef Filename, std::string *ErrMsg=nullptr)
This function registers signal handlers to ensure that if a signal gets delivered that the named file...
SpecialSubKind::string
@ string