lib/Support/raw_ostream.cpp

   1 //===--- raw_ostream.cpp - Implement the raw_ostream classes --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This implements support for bulk buffered stream output.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Support/raw_ostream.h"
  15 #include "llvm/Support/Format.h"
  16 #include "llvm/System/Program.h"
  17 #include "llvm/System/Process.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/Config/config.h"
  20 #include "llvm/Support/Compiler.h"
  21 #include "llvm/Support/ErrorHandling.h"
  22 #include "llvm/System/Signals.h"
  23 #include "llvm/ADT/STLExtras.h"
  24 #include <cctype>
  25 #include <cerrno>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28
  29 #if defined(HAVE_UNISTD_H)
  30 # include <unistd.h>
  31 #endif
  32 #if defined(HAVE_FCNTL_H)
  33 # include <fcntl.h>
  34 #endif
  35
  36 #if defined(_MSC_VER)
  37 #include <io.h>
  38 #include <fcntl.h>
  39 #ifndef STDIN_FILENO
  40 # define STDIN_FILENO 0
  41 #endif
  42 #ifndef STDOUT_FILENO
  43 # define STDOUT_FILENO 1
  44 #endif
  45 #ifndef STDERR_FILENO
  46 # define STDERR_FILENO 2
  47 #endif
  48 #endif
  49
  50 using namespace llvm;
  51
  52 raw_ostream::~raw_ostream() {
  53   // raw_ostream's subclasses should take care to flush the buffer
  54   // in their destructors.
  55   assert(OutBufCur == OutBufStart &&
  56          "raw_ostream destructor called with non-empty buffer!");
  57
  58   if (BufferMode == InternalBuffer)
  59     delete [] OutBufStart;
  60 }
  61
  62 // An out of line virtual method to provide a home for the class vtable.
  63 void raw_ostream::handle() {}
  64
  65 size_t raw_ostream::preferred_buffer_size() const {
  66   // BUFSIZ is intended to be a reasonable default.
  67   return BUFSIZ;
  68 }
  69
  70 void raw_ostream::SetBuffered() {
  71   // Ask the subclass to determine an appropriate buffer size.
  72   if (size_t Size = preferred_buffer_size())
  73     SetBufferSize(Size);
  74   else
  75     // It may return 0, meaning this stream should be unbuffered.
  76     SetUnbuffered();
  77 }
  78
  79 void raw_ostream::SetBufferAndMode(char *BufferStart, size_t Size,
  80                                     BufferKind Mode) {
  81   assert(((Mode == Unbuffered && BufferStart == 0 && Size == 0) ||
  82           (Mode != Unbuffered && BufferStart && Size)) &&
  83          "stream must be unbuffered or have at least one byte");
  84   // Make sure the current buffer is free of content (we can't flush here; the
  85   // child buffer management logic will be in write_impl).
  86   assert(GetNumBytesInBuffer() == 0 && "Current buffer is non-empty!");
  87
  88   if (BufferMode == InternalBuffer)
  89     delete [] OutBufStart;
  90   OutBufStart = BufferStart;
  91   OutBufEnd = OutBufStart+Size;
  92   OutBufCur = OutBufStart;
  93   BufferMode = Mode;
  94
  95   assert(OutBufStart <= OutBufEnd && "Invalid size!");
  96 }
  97
  98 raw_ostream &raw_ostream::operator<<(unsigned long N) {
  99   // Zero is a special case.
 100   if (N == 0)
 101     return *this << '0';
 102
 103   char NumberBuffer[20];
 104   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 105   char *CurPtr = EndPtr;
 106
 107   while (N) {
 108     *--CurPtr = '0' + char(N % 10);
 109     N /= 10;
 110   }
 111   return write(CurPtr, EndPtr-CurPtr);
 112 }
 113
 114 raw_ostream &raw_ostream::operator<<(long N) {
 115   if (N <  0) {
 116     *this << '-';
 117     N = -N;
 118   }
 119
 120   return this->operator<<(static_cast<unsigned long>(N));
 121 }
 122
 123 raw_ostream &raw_ostream::operator<<(unsigned long long N) {
 124   // Output using 32-bit div/mod when possible.
 125   if (N == static_cast<unsigned long>(N))
 126     return this->operator<<(static_cast<unsigned long>(N));
 127
 128   char NumberBuffer[20];
 129   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 130   char *CurPtr = EndPtr;
 131
 132   while (N) {
 133     *--CurPtr = '0' + char(N % 10);
 134     N /= 10;
 135   }
 136   return write(CurPtr, EndPtr-CurPtr);
 137 }
 138
 139 raw_ostream &raw_ostream::operator<<(long long N) {
 140   if (N < 0) {
 141     *this << '-';
 142     // Avoid undefined behavior on INT64_MIN with a cast.
 143     N = -(unsigned long long)N;
 144   }
 145
 146   return this->operator<<(static_cast<unsigned long long>(N));
 147 }
 148
 149 raw_ostream &raw_ostream::write_hex(unsigned long long N) {
 150   // Zero is a special case.
 151   if (N == 0)
 152     return *this << '0';
 153
 154   char NumberBuffer[20];
 155   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 156   char *CurPtr = EndPtr;
 157
 158   while (N) {
 159     uintptr_t x = N % 16;
 160     *--CurPtr = (x < 10 ? '0' + x : 'a' + x - 10);
 161     N /= 16;
 162   }
 163
 164   return write(CurPtr, EndPtr-CurPtr);
 165 }
 166
 167 raw_ostream &raw_ostream::write_escaped(StringRef Str) {
 168   for (unsigned i = 0, e = Str.size(); i != e; ++i) {
 169     unsigned char c = Str[i];
 170
 171     switch (c) {
 172     case '\\':
 173       *this << '\\' << '\\';
 174       break;
 175     case '\t':
 176       *this << '\\' << 't';
 177       break;
 178     case '\n':
 179       *this << '\\' << 'n';
 180       break;
 181     case '"':
 182       *this << '\\' << '"';
 183       break;
 184     default:
 185       if (std::isprint(c)) {
 186         *this << c;
 187         break;
 188       }
 189
 190       // Always expand to a 3-character octal escape.
 191       *this << '\\';
 192       *this << char('0' + ((c >> 6) & 7));
 193       *this << char('0' + ((c >> 3) & 7));
 194       *this << char('0' + ((c >> 0) & 7));
 195     }
 196   }
 197
 198   return *this;
 199 }
 200
 201 raw_ostream &raw_ostream::operator<<(const void *P) {
 202   *this << '0' << 'x';
 203
 204   return write_hex((uintptr_t) P);
 205 }
 206
 207 raw_ostream &raw_ostream::operator<<(double N) {
 208   return this->operator<<(format("%e", N));
 209 }
 210
 211
 212
 213 void raw_ostream::flush_nonempty() {
 214   assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
 215   size_t Length = OutBufCur - OutBufStart;
 216   OutBufCur = OutBufStart;
 217   write_impl(OutBufStart, Length);
 218 }
 219
 220 raw_ostream &raw_ostream::write(unsigned char C) {
 221   // Group exceptional cases into a single branch.
 222   if (BUILTIN_EXPECT(OutBufCur >= OutBufEnd, false)) {
 223     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 224       if (BufferMode == Unbuffered) {
 225         write_impl(reinterpret_cast<char*>(&C), 1);
 226         return *this;
 227       }
 228       // Set up a buffer and start over.
 229       SetBuffered();
 230       return write(C);
 231     }
 232
 233     flush_nonempty();
 234   }
 235
 236   *OutBufCur++ = C;
 237   return *this;
 238 }
 239
 240 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
 241   // Group exceptional cases into a single branch.
 242   if (BUILTIN_EXPECT(OutBufCur+Size > OutBufEnd, false)) {
 243     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 244       if (BufferMode == Unbuffered) {
 245         write_impl(Ptr, Size);
 246         return *this;
 247       }
 248       // Set up a buffer and start over.
 249       SetBuffered();
 250       return write(Ptr, Size);
 251     }
 252
 253     // Write out the data in buffer-sized blocks until the remainder
 254     // fits within the buffer.
 255     do {
 256       size_t NumBytes = OutBufEnd - OutBufCur;
 257       copy_to_buffer(Ptr, NumBytes);
 258       flush_nonempty();
 259       Ptr += NumBytes;
 260       Size -= NumBytes;
 261     } while (OutBufCur+Size > OutBufEnd);
 262   }
 263
 264   copy_to_buffer(Ptr, Size);
 265
 266   return *this;
 267 }
 268
 269 void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
 270   assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
 271
 272   // Handle short strings specially, memcpy isn't very good at very short
 273   // strings.
 274   switch (Size) {
 275   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 276   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 277   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 278   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 279   case 0: break;
 280   default:
 281     memcpy(OutBufCur, Ptr, Size);
 282     break;
 283   }
 284
 285   OutBufCur += Size;
 286 }
 287
 288 // Formatted output.
 289 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 290   // If we have more than a few bytes left in our output buffer, try
 291   // formatting directly onto its end.
 292   size_t NextBufferSize = 127;
 293   size_t BufferBytesLeft = OutBufEnd - OutBufCur;
 294   if (BufferBytesLeft > 3) {
 295     size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 296
 297     // Common case is that we have plenty of space.
 298     if (BytesUsed <= BufferBytesLeft) {
 299       OutBufCur += BytesUsed;
 300       return *this;
 301     }
 302
 303     // Otherwise, we overflowed and the return value tells us the size to try
 304     // again with.
 305     NextBufferSize = BytesUsed;
 306   }
 307
 308   // If we got here, we didn't have enough space in the output buffer for the
 309   // string.  Try printing into a SmallVector that is resized to have enough
 310   // space.  Iterate until we win.
 311   SmallVector<char, 128> V;
 312
 313   while (1) {
 314     V.resize(NextBufferSize);
 315
 316     // Try formatting into the SmallVector.
 317     size_t BytesUsed = Fmt.print(V.data(), NextBufferSize);
 318
 319     // If BytesUsed fit into the vector, we win.
 320     if (BytesUsed <= NextBufferSize)
 321       return write(V.data(), BytesUsed);
 322
 323     // Otherwise, try again with a new size.
 324     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 325     NextBufferSize = BytesUsed;
 326   }
 327 }
 328
 329 /// indent - Insert 'NumSpaces' spaces.
 330 raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
 331   static const char Spaces[] = "                                "
 332                                "                                "
 333                                "                ";
 334
 335   // Usually the indentation is small, handle it with a fastpath.
 336   if (NumSpaces < array_lengthof(Spaces))
 337     return write(Spaces, NumSpaces);
 338
 339   while (NumSpaces) {
 340     unsigned NumToWrite = std::min(NumSpaces,
 341                                    (unsigned)array_lengthof(Spaces)-1);
 342     write(Spaces, NumToWrite);
 343     NumSpaces -= NumToWrite;
 344   }
 345   return *this;
 346 }
 347
 348
 349 //===----------------------------------------------------------------------===//
 350 //  Formatted Output
 351 //===----------------------------------------------------------------------===//
 352
 353 // Out of line virtual method.
 354 void format_object_base::home() {
 355 }
 356
 357 //===----------------------------------------------------------------------===//
 358 //  raw_fd_ostream
 359 //===----------------------------------------------------------------------===//
 360
 361 /// raw_fd_ostream - Open the specified file for writing. If an error
 362 /// occurs, information about the error is put into ErrorInfo, and the
 363 /// stream should be immediately destroyed; the string will be empty
 364 /// if no error occurred.
 365 raw_fd_ostream::raw_fd_ostream(const char *Filename, std::string &ErrorInfo,
 366                                unsigned Flags) : Error(false), pos(0) {
 367   assert(Filename != 0 && "Filename is null");
 368   // Verify that we don't have both "append" and "excl".
 369   assert((!(Flags & F_Excl) || !(Flags & F_Append)) &&
 370          "Cannot specify both 'excl' and 'append' file creation flags!");
 371
 372   ErrorInfo.clear();
 373
 374   // Handle "-" as stdout. Note that when we do this, we consider ourself
 375   // the owner of stdout. This means that we can do things like close the
 376   // file descriptor when we're done and set the "binary" flag globally.
 377   if (Filename[0] == '-' && Filename[1] == 0) {
 378     FD = STDOUT_FILENO;
 379     // If user requested binary then put stdout into binary mode if
 380     // possible.
 381     if (Flags & F_Binary)
 382       sys::Program::ChangeStdoutToBinary();
 383     // Close stdout when we're done, to detect any output errors.
 384     ShouldClose = true;
 385     return;
 386   }
 387
 388   int OpenFlags = O_WRONLY|O_CREAT;
 389 #ifdef O_BINARY
 390   if (Flags & F_Binary)
 391     OpenFlags |= O_BINARY;
 392 #endif
 393
 394   if (Flags & F_Append)
 395     OpenFlags |= O_APPEND;
 396   else
 397     OpenFlags |= O_TRUNC;
 398   if (Flags & F_Excl)
 399     OpenFlags |= O_EXCL;
 400
 401   while ((FD = open(Filename, OpenFlags, 0664)) < 0) {
 402     if (errno != EINTR) {
 403       ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 404       ShouldClose = false;
 405       return;
 406     }
 407   }
 408
 409   // Ok, we successfully opened the file, so it'll need to be closed.
 410   ShouldClose = true;
 411 }
 412
 413 raw_fd_ostream::~raw_fd_ostream() {
 414   if (FD >= 0) {
 415     flush();
 416     if (ShouldClose)
 417       while (::close(FD) != 0)
 418         if (errno != EINTR) {
 419           error_detected();
 420           break;
 421         }
 422   }
 423
 424   // If there are any pending errors, report them now. Clients wishing
 425   // to avoid report_fatal_error calls should check for errors with
 426   // has_error() and clear the error flag with clear_error() before
 427   // destructing raw_ostream objects which may have errors.
 428   if (has_error())
 429     report_fatal_error("IO failure on output stream.");
 430 }
 431
 432
 433 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
 434   assert(FD >= 0 && "File already closed.");
 435   pos += Size;
 436
 437   do {
 438     ssize_t ret = ::write(FD, Ptr, Size);
 439
 440     if (ret < 0) {
 441       // If it's a recoverable error, swallow it and retry the write.
 442       //
 443       // Ideally we wouldn't ever see EAGAIN or EWOULDBLOCK here, since
 444       // raw_ostream isn't designed to do non-blocking I/O. However, some
 445       // programs, such as old versions of bjam, have mistakenly used
 446       // O_NONBLOCK. For compatibility, emulate blocking semantics by
 447       // spinning until the write succeeds. If you don't want spinning,
 448       // don't use O_NONBLOCK file descriptors with raw_ostream.
 449       if (errno == EINTR || errno == EAGAIN
 450 #ifdef EWOULDBLOCK
 451           || errno == EWOULDBLOCK
 452 #endif
 453           )
 454         continue;
 455
 456       // Otherwise it's a non-recoverable error. Note it and quit.
 457       error_detected();
 458       break;
 459     }
 460
 461     // The write may have written some or all of the data. Update the
 462     // size and buffer pointer to reflect the remainder that needs
 463     // to be written. If there are no bytes left, we're done.
 464     Ptr += ret;
 465     Size -= ret;
 466   } while (Size > 0);
 467 }
 468
 469 void raw_fd_ostream::close() {
 470   assert(ShouldClose);
 471   ShouldClose = false;
 472   flush();
 473   while (::close(FD) != 0)
 474     if (errno != EINTR) {
 475       error_detected();
 476       break;
 477     }
 478   FD = -1;
 479 }
 480
 481 uint64_t raw_fd_ostream::seek(uint64_t off) {
 482   flush();
 483   pos = ::lseek(FD, off, SEEK_SET);
 484   if (pos != off)
 485     error_detected();
 486   return pos;
 487 }
 488
 489 size_t raw_fd_ostream::preferred_buffer_size() const {
 490 #if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(__minix)
 491   // Windows and Minix have no st_blksize.
 492   assert(FD >= 0 && "File not yet open!");
 493   struct stat statbuf;
 494   if (fstat(FD, &statbuf) != 0)
 495     return 0;
 496
 497   // If this is a terminal, don't use buffering. Line buffering
 498   // would be a more traditional thing to do, but it's not worth
 499   // the complexity.
 500   if (S_ISCHR(statbuf.st_mode) && isatty(FD))
 501     return 0;
 502   // Return the preferred block size.
 503   return statbuf.st_blksize;
 504 #else
 505   return raw_ostream::preferred_buffer_size();
 506 #endif
 507 }
 508
 509 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
 510                                          bool bg) {
 511   if (sys::Process::ColorNeedsFlush())
 512     flush();
 513   const char *colorcode =
 514     (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
 515     : sys::Process::OutputColor(colors, bold, bg);
 516   if (colorcode) {
 517     size_t len = strlen(colorcode);
 518     write(colorcode, len);
 519     // don't account colors towards output characters
 520     pos -= len;
 521   }
 522   return *this;
 523 }
 524
 525 raw_ostream &raw_fd_ostream::resetColor() {
 526   if (sys::Process::ColorNeedsFlush())
 527     flush();
 528   const char *colorcode = sys::Process::ResetColor();
 529   if (colorcode) {
 530     size_t len = strlen(colorcode);
 531     write(colorcode, len);
 532     // don't account colors towards output characters
 533     pos -= len;
 534   }
 535   return *this;
 536 }
 537
 538 bool raw_fd_ostream::is_displayed() const {
 539   return sys::Process::FileDescriptorIsDisplayed(FD);
 540 }
 541
 542 //===----------------------------------------------------------------------===//
 543 //  raw_stdout/err_ostream
 544 //===----------------------------------------------------------------------===//
 545
 546 /// outs() - This returns a reference to a raw_ostream for standard output.
 547 /// Use it like: outs() << "foo" << "bar";
 548 raw_ostream &llvm::outs() {
 549   // Set buffer settings to model stdout behavior.
 550   static raw_fd_ostream S(STDOUT_FILENO, false);
 551   return S;
 552 }
 553
 554 /// errs() - This returns a reference to a raw_ostream for standard error.
 555 /// Use it like: errs() << "foo" << "bar";
 556 raw_ostream &llvm::errs() {
 557   // Set standard error to be unbuffered by default.
 558   static raw_fd_ostream S(STDERR_FILENO, false, true);
 559   return S;
 560 }
 561
 562 /// nulls() - This returns a reference to a raw_ostream which discards output.
 563 raw_ostream &llvm::nulls() {
 564   static raw_null_ostream S;
 565   return S;
 566 }
 567
 568
 569 //===----------------------------------------------------------------------===//
 570 //  raw_string_ostream
 571 //===----------------------------------------------------------------------===//
 572
 573 raw_string_ostream::~raw_string_ostream() {
 574   flush();
 575 }
 576
 577 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
 578   OS.append(Ptr, Size);
 579 }
 580
 581 //===----------------------------------------------------------------------===//
 582 //  raw_svector_ostream
 583 //===----------------------------------------------------------------------===//
 584
 585 // The raw_svector_ostream implementation uses the SmallVector itself as the
 586 // buffer for the raw_ostream. We guarantee that the raw_ostream buffer is
 587 // always pointing past the end of the vector, but within the vector
 588 // capacity. This allows raw_ostream to write directly into the correct place,
 589 // and we only need to set the vector size when the data is flushed.
 590
 591 raw_svector_ostream::raw_svector_ostream(SmallVectorImpl<char> &O) : OS(O) {
 592   // Set up the initial external buffer. We make sure that the buffer has at
 593   // least 128 bytes free; raw_ostream itself only requires 64, but we want to
 594   // make sure that we don't grow the buffer unnecessarily on destruction (when
 595   // the data is flushed). See the FIXME below.
 596   OS.reserve(OS.size() + 128);
 597   SetBuffer(OS.end(), OS.capacity() - OS.size());
 598 }
 599
 600 raw_svector_ostream::~raw_svector_ostream() {
 601   // FIXME: Prevent resizing during this flush().
 602   flush();
 603 }
 604
 605 /// resync - This is called when the SmallVector we're appending to is changed
 606 /// outside of the raw_svector_ostream's control.  It is only safe to do this
 607 /// if the raw_svector_ostream has previously been flushed.
 608 void raw_svector_ostream::resync() {
 609   assert(GetNumBytesInBuffer() == 0 && "Didn't flush before mutating vector");
 610
 611   if (OS.capacity() - OS.size() < 64)
 612     OS.reserve(OS.capacity() * 2);
 613   SetBuffer(OS.end(), OS.capacity() - OS.size());
 614 }
 615
 616 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
 617   // If we're writing bytes from the end of the buffer into the smallvector, we
 618   // don't need to copy the bytes, just commit the bytes because they are
 619   // already in the right place.
 620   if (Ptr == OS.end()) {
 621     assert(OS.size() + Size <= OS.capacity() && "Invalid write_impl() call!");
 622     OS.set_size(OS.size() + Size);
 623   } else {
 624     assert(GetNumBytesInBuffer() == 0 &&
 625            "Should be writing from buffer if some bytes in it");
 626     // Otherwise, do copy the bytes.
 627     OS.append(Ptr, Ptr+Size);
 628   }
 629
 630   // Grow the vector if necessary.
 631   if (OS.capacity() - OS.size() < 64)
 632     OS.reserve(OS.capacity() * 2);
 633
 634   // Update the buffer position.
 635   SetBuffer(OS.end(), OS.capacity() - OS.size());
 636 }
 637
 638 uint64_t raw_svector_ostream::current_pos() const {
 639    return OS.size();
 640 }
 641
 642 StringRef raw_svector_ostream::str() {
 643   flush();
 644   return StringRef(OS.begin(), OS.size());
 645 }
 646
 647 //===----------------------------------------------------------------------===//
 648 //  raw_null_ostream
 649 //===----------------------------------------------------------------------===//
 650
 651 raw_null_ostream::~raw_null_ostream() {
 652 #ifndef NDEBUG
 653   // ~raw_ostream asserts that the buffer is empty. This isn't necessary
 654   // with raw_null_ostream, but it's better to have raw_null_ostream follow
 655   // the rules than to change the rules just for raw_null_ostream.
 656   flush();
 657 #endif
 658 }
 659
 660 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
 661 }
 662
 663 uint64_t raw_null_ostream::current_pos() const {
 664   return 0;
 665 }
 666
 667 //===----------------------------------------------------------------------===//
 668 //  tool_output_file
 669 //===----------------------------------------------------------------------===//
 670
 671 /// SetupRemoveOnSignal - This is a helper for tool_output_file's constructor
 672 /// to allow the signal handlers to be installed before constructing the
 673 /// base class raw_fd_ostream.
 674 static const char *SetupRemoveOnSignal(const char *Filename) {
 675   // Arrange for the file to be deleted if the process is killed.
 676   if (strcmp(Filename, "-") != 0)
 677     sys::RemoveFileOnSignal(sys::Path(Filename));
 678   return Filename;
 679 }
 680
 681 tool_output_file::tool_output_file(const char *filename, std::string &ErrorInfo,
 682                                    unsigned Flags)
 683   : raw_fd_ostream(SetupRemoveOnSignal(filename), ErrorInfo, Flags),
 684     Filename(filename),
 685     Keep(!ErrorInfo.empty() /* If open fails, no cleanup is needed. */) {
 686 }
 687
 688 tool_output_file::~tool_output_file() {
 689   // Delete the file if the client hasn't told us not to.
 690   if (!Keep && Filename != "-")
 691     sys::Path(Filename).eraseFromDisk();
 692 }