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