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