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 <ostream>
  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() {
  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 >= 64)) &&
  87          "stream must be unbuffered, or have >= 64 bytes of buffer");
  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::operator<<(const void *P) {
 171   *this << '0' << 'x';
 172
 173   return write_hex((uintptr_t) P);
 174 }
 175
 176 void raw_ostream::flush_nonempty() {
 177   assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
 178   size_t Length = OutBufCur - OutBufStart;
 179   OutBufCur = OutBufStart;
 180   write_impl(OutBufStart, Length);
 181 }
 182
 183 raw_ostream &raw_ostream::write(unsigned char C) {
 184   // Group exceptional cases into a single branch.
 185   if (BUILTIN_EXPECT(OutBufCur >= OutBufEnd, false)) {
 186     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 187       if (BufferMode == Unbuffered) {
 188         write_impl(reinterpret_cast<char*>(&C), 1);
 189         return *this;
 190       }
 191       // Set up a buffer and start over.
 192       SetBuffered();
 193       return write(C);
 194     }
 195
 196     flush_nonempty();
 197   }
 198
 199   *OutBufCur++ = C;
 200   return *this;
 201 }
 202
 203 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
 204   // Group exceptional cases into a single branch.
 205   if (BUILTIN_EXPECT(OutBufCur+Size > OutBufEnd, false)) {
 206     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 207       if (BufferMode == Unbuffered) {
 208         write_impl(Ptr, Size);
 209         return *this;
 210       }
 211       // Set up a buffer and start over.
 212       SetBuffered();
 213       return write(Ptr, Size);
 214     }
 215
 216     // Write out the data in buffer-sized blocks until the remainder
 217     // fits within the buffer.
 218     do {
 219       size_t NumBytes = OutBufEnd - OutBufCur;
 220       copy_to_buffer(Ptr, NumBytes);
 221       flush_nonempty();
 222       Ptr += NumBytes;
 223       Size -= NumBytes;
 224     } while (OutBufCur+Size > OutBufEnd);
 225   }
 226
 227   copy_to_buffer(Ptr, Size);
 228
 229   return *this;
 230 }
 231
 232 void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
 233   assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
 234
 235   // Handle short strings specially, memcpy isn't very good at very short
 236   // strings.
 237   switch (Size) {
 238   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 239   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 240   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 241   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 242   case 0: break;
 243   default:
 244     memcpy(OutBufCur, Ptr, Size);
 245     break;
 246   }
 247
 248   OutBufCur += Size;
 249 }
 250
 251 // Formatted output.
 252 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 253   // If we have more than a few bytes left in our output buffer, try
 254   // formatting directly onto its end.
 255   size_t NextBufferSize = 127;
 256   if (OutBufEnd-OutBufCur > 3) {
 257     size_t BufferBytesLeft = OutBufEnd-OutBufCur;
 258     size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 259
 260     // Common case is that we have plenty of space.
 261     if (BytesUsed < BufferBytesLeft) {
 262       OutBufCur += BytesUsed;
 263       return *this;
 264     }
 265
 266     // Otherwise, we overflowed and the return value tells us the size to try
 267     // again with.
 268     NextBufferSize = BytesUsed;
 269   }
 270
 271   // If we got here, we didn't have enough space in the output buffer for the
 272   // string.  Try printing into a SmallVector that is resized to have enough
 273   // space.  Iterate until we win.
 274   SmallVector<char, 128> V;
 275
 276   while (1) {
 277     V.resize(NextBufferSize);
 278
 279     // Try formatting into the SmallVector.
 280     size_t BytesUsed = Fmt.print(&V[0], NextBufferSize);
 281
 282     // If BytesUsed fit into the vector, we win.
 283     if (BytesUsed <= NextBufferSize)
 284       return write(&V[0], BytesUsed);
 285
 286     // Otherwise, try again with a new size.
 287     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 288     NextBufferSize = BytesUsed;
 289   }
 290 }
 291
 292 //===----------------------------------------------------------------------===//
 293 //  Formatted Output
 294 //===----------------------------------------------------------------------===//
 295
 296 // Out of line virtual method.
 297 void format_object_base::home() {
 298 }
 299
 300 //===----------------------------------------------------------------------===//
 301 //  raw_fd_ostream
 302 //===----------------------------------------------------------------------===//
 303
 304 /// raw_fd_ostream - Open the specified file for writing. If an error
 305 /// occurs, information about the error is put into ErrorInfo, and the
 306 /// stream should be immediately destroyed; the string will be empty
 307 /// if no error occurred.
 308 raw_fd_ostream::raw_fd_ostream(const char *Filename, bool Binary, bool Force,
 309                                std::string &ErrorInfo) : pos(0) {
 310   ErrorInfo.clear();
 311
 312   // Handle "-" as stdout.
 313   if (Filename[0] == '-' && Filename[1] == 0) {
 314     FD = STDOUT_FILENO;
 315     // If user requested binary then put stdout into binary mode if
 316     // possible.
 317     if (Binary)
 318       sys::Program::ChangeStdoutToBinary();
 319     ShouldClose = false;
 320     return;
 321   }
 322
 323   int Flags = O_WRONLY|O_CREAT|O_TRUNC;
 324 #ifdef O_BINARY
 325   if (Binary)
 326     Flags |= O_BINARY;
 327 #endif
 328   if (!Force)
 329     Flags |= O_EXCL;
 330   FD = open(Filename, Flags, 0664);
 331   if (FD < 0) {
 332     ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 333     ShouldClose = false;
 334   } else {
 335     ShouldClose = true;
 336   }
 337 }
 338
 339 raw_fd_ostream::~raw_fd_ostream() {
 340   if (FD >= 0) {
 341     flush();
 342     if (ShouldClose)
 343       if (::close(FD) != 0)
 344         error_detected();
 345   }
 346 }
 347
 348 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
 349   assert (FD >= 0 && "File already closed.");
 350   pos += Size;
 351   if (::write(FD, Ptr, Size) != (ssize_t) Size)
 352     error_detected();
 353 }
 354
 355 void raw_fd_ostream::close() {
 356   assert (ShouldClose);
 357   ShouldClose = false;
 358   flush();
 359   if (::close(FD) != 0)
 360     error_detected();
 361   FD = -1;
 362 }
 363
 364 uint64_t raw_fd_ostream::seek(uint64_t off) {
 365   flush();
 366   pos = ::lseek(FD, off, SEEK_SET);
 367   if (pos != off)
 368     error_detected();
 369   return pos;
 370 }
 371
 372 size_t raw_fd_ostream::preferred_buffer_size() {
 373 #if !defined(_MSC_VER) && !defined(__MINGW32__) // Windows has no st_blksize.
 374   assert(FD >= 0 && "File not yet open!");
 375   struct stat statbuf;
 376   if (fstat(FD, &statbuf) == 0) {
 377     // If this is a terminal, don't use buffering. Line buffering
 378     // would be a more traditional thing to do, but it's not worth
 379     // the complexity.
 380     if (S_ISCHR(statbuf.st_mode) && isatty(FD))
 381       return 0;
 382     // Return the preferred block size.
 383     return statbuf.st_blksize;
 384   }
 385   error_detected();
 386 #endif
 387   return raw_ostream::preferred_buffer_size();
 388 }
 389
 390 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
 391                                          bool bg) {
 392   if (sys::Process::ColorNeedsFlush())
 393     flush();
 394   const char *colorcode =
 395     (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
 396     : sys::Process::OutputColor(colors, bold, bg);
 397   if (colorcode) {
 398     size_t len = strlen(colorcode);
 399     write(colorcode, len);
 400     // don't account colors towards output characters
 401     pos -= len;
 402   }
 403   return *this;
 404 }
 405
 406 raw_ostream &raw_fd_ostream::resetColor() {
 407   if (sys::Process::ColorNeedsFlush())
 408     flush();
 409   const char *colorcode = sys::Process::ResetColor();
 410   if (colorcode) {
 411     size_t len = strlen(colorcode);
 412     write(colorcode, len);
 413     // don't account colors towards output characters
 414     pos -= len;
 415   }
 416   return *this;
 417 }
 418
 419 //===----------------------------------------------------------------------===//
 420 //  raw_stdout/err_ostream
 421 //===----------------------------------------------------------------------===//
 422
 423 // Set buffer settings to model stdout and stderr behavior.
 424 // Set standard error to be unbuffered by default.
 425 raw_stdout_ostream::raw_stdout_ostream():raw_fd_ostream(STDOUT_FILENO, false) {}
 426 raw_stderr_ostream::raw_stderr_ostream():raw_fd_ostream(STDERR_FILENO, false,
 427                                                         true) {}
 428
 429 // An out of line virtual method to provide a home for the class vtable.
 430 void raw_stdout_ostream::handle() {}
 431 void raw_stderr_ostream::handle() {}
 432
 433 /// outs() - This returns a reference to a raw_ostream for standard output.
 434 /// Use it like: outs() << "foo" << "bar";
 435 raw_ostream &llvm::outs() {
 436   static raw_stdout_ostream S;
 437   return S;
 438 }
 439
 440 /// errs() - This returns a reference to a raw_ostream for standard error.
 441 /// Use it like: errs() << "foo" << "bar";
 442 raw_ostream &llvm::errs() {
 443   static raw_stderr_ostream S;
 444   return S;
 445 }
 446
 447 /// nulls() - This returns a reference to a raw_ostream which discards output.
 448 raw_ostream &llvm::nulls() {
 449   static raw_null_ostream S;
 450   return S;
 451 }
 452
 453 //===----------------------------------------------------------------------===//
 454 //  raw_os_ostream
 455 //===----------------------------------------------------------------------===//
 456
 457 raw_os_ostream::~raw_os_ostream() {
 458   flush();
 459 }
 460
 461 void raw_os_ostream::write_impl(const char *Ptr, size_t Size) {
 462   OS.write(Ptr, Size);
 463 }
 464
 465 uint64_t raw_os_ostream::current_pos() { return OS.tellp(); }
 466
 467 //===----------------------------------------------------------------------===//
 468 //  raw_string_ostream
 469 //===----------------------------------------------------------------------===//
 470
 471 raw_string_ostream::~raw_string_ostream() {
 472   flush();
 473 }
 474
 475 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
 476   OS.append(Ptr, Size);
 477 }
 478
 479 //===----------------------------------------------------------------------===//
 480 //  raw_svector_ostream
 481 //===----------------------------------------------------------------------===//
 482
 483 // The raw_svector_ostream implementation uses the SmallVector itself as the
 484 // buffer for the raw_ostream. We guarantee that the raw_ostream buffer is
 485 // always pointing past the end of the vector, but within the vector
 486 // capacity. This allows raw_ostream to write directly into the correct place,
 487 // and we only need to set the vector size when the data is flushed.
 488
 489 raw_svector_ostream::raw_svector_ostream(SmallVectorImpl<char> &O) : OS(O) {
 490   // Set up the initial external buffer. We make sure that the buffer has at
 491   // least 128 bytes free; raw_ostream itself only requires 64, but we want to
 492   // make sure that we don't grow the buffer unnecessarily on destruction (when
 493   // the data is flushed). See the FIXME below.
 494   OS.reserve(OS.size() + 128);
 495   SetBuffer(OS.end(), OS.capacity() - OS.size());
 496 }
 497
 498 raw_svector_ostream::~raw_svector_ostream() {
 499   // FIXME: Prevent resizing during this flush().
 500   flush();
 501 }
 502
 503 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
 504   assert(Ptr == OS.end() && OS.size() + Size <= OS.capacity() &&
 505          "Invalid write_impl() call!");
 506
 507   // We don't need to copy the bytes, just commit the bytes to the
 508   // SmallVector.
 509   OS.set_size(OS.size() + Size);
 510
 511   // Grow the vector if necessary.
 512   if (OS.capacity() - OS.size() < 64)
 513     OS.reserve(OS.capacity() * 2);
 514
 515   // Update the buffer position.
 516   SetBuffer(OS.end(), OS.capacity() - OS.size());
 517 }
 518
 519 uint64_t raw_svector_ostream::current_pos() { return OS.size(); }
 520
 521 StringRef raw_svector_ostream::str() {
 522   flush();
 523   return StringRef(OS.begin(), OS.size());
 524 }
 525
 526 //===----------------------------------------------------------------------===//
 527 //  raw_null_ostream
 528 //===----------------------------------------------------------------------===//
 529
 530 raw_null_ostream::~raw_null_ostream() {
 531 #ifndef NDEBUG
 532   // ~raw_ostream asserts that the buffer is empty. This isn't necessary
 533   // with raw_null_ostream, but it's better to have raw_null_ostream follow
 534   // the rules than to change the rules just for raw_null_ostream.
 535   flush();
 536 #endif
 537 }
 538
 539 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
 540 }
 541
 542 uint64_t raw_null_ostream::current_pos() {
 543   return 0;
 544 }