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   delete [] OutBufStart;
  56
  57   // If there are any pending errors, report them now. Clients wishing
  58   // to avoid llvm_report_error calls should check for errors with
  59   // has_error() and clear the error flag with clear_error() before
  60   // destructing raw_ostream objects which may have errors.
  61   if (Error)
  62     llvm_report_error("IO failure on output stream.");
  63 }
  64
  65 // An out of line virtual method to provide a home for the class vtable.
  66 void raw_ostream::handle() {}
  67
  68 size_t raw_ostream::preferred_buffer_size() {
  69   // BUFSIZ is intended to be a reasonable default.
  70   return BUFSIZ;
  71 }
  72
  73 void raw_ostream::SetBuffered() {
  74   // Ask the subclass to determine an appropriate buffer size.
  75   if (size_t Size = preferred_buffer_size())
  76     SetBufferSize(Size);
  77   else
  78     // It may return 0, meaning this stream should be unbuffered.
  79     SetUnbuffered();
  80 }
  81
  82 void raw_ostream::SetBufferSize(size_t Size) {
  83   assert(Size >= 64 &&
  84          "Buffer size must be somewhat large for invariants to hold");
  85   flush();
  86
  87   delete [] OutBufStart;
  88   OutBufStart = new char[Size];
  89   OutBufEnd = OutBufStart+Size;
  90   OutBufCur = OutBufStart;
  91   Unbuffered = false;
  92 }
  93
  94 void raw_ostream::SetUnbuffered() {
  95   flush();
  96
  97   delete [] OutBufStart;
  98   OutBufStart = OutBufEnd = OutBufCur = 0;
  99   Unbuffered = true;
 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   write_impl(OutBufStart, OutBufCur - OutBufStart);
 179   OutBufCur = OutBufStart;
 180 }
 181
 182 raw_ostream &raw_ostream::write(unsigned char C) {
 183   // Group exceptional cases into a single branch.
 184   if (OutBufCur >= OutBufEnd) {
 185     if (Unbuffered) {
 186       write_impl(reinterpret_cast<char*>(&C), 1);
 187       return *this;
 188     }
 189
 190     if (OutBufStart)
 191       flush_nonempty();
 192     else {
 193       SetBuffered();
 194       // It's possible for the underlying stream to decline
 195       // buffering, so check this condition again.
 196       if (Unbuffered) {
 197         write_impl(reinterpret_cast<char*>(&C), 1);
 198         return *this;
 199       }
 200     }
 201   }
 202
 203   *OutBufCur++ = C;
 204   return *this;
 205 }
 206
 207 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
 208   // Group exceptional cases into a single branch.
 209   if (BUILTIN_EXPECT(OutBufCur+Size > OutBufEnd, false)) {
 210     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 211       if (Unbuffered) {
 212         write_impl(Ptr, Size);
 213         return *this;
 214       }
 215       // Set up a buffer and start over.
 216       SetBuffered();
 217       return write(Ptr, Size);
 218     }
 219     // Write out the data in buffer-sized blocks until the remainder
 220     // fits within the buffer.
 221     do {
 222       size_t NumBytes = OutBufEnd - OutBufCur;
 223       copy_to_buffer(Ptr, NumBytes);
 224       flush_nonempty();
 225       Ptr += NumBytes;
 226       Size -= NumBytes;
 227     } while (OutBufCur+Size > OutBufEnd);
 228   }
 229
 230   copy_to_buffer(Ptr, Size);
 231
 232   return *this;
 233 }
 234
 235 void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
 236   assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
 237
 238   // Handle short strings specially, memcpy isn't very good at very short
 239   // strings.
 240   switch (Size) {
 241   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 242   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 243   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 244   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 245   case 0: break;
 246   default:
 247     memcpy(OutBufCur, Ptr, Size);
 248     break;
 249   }
 250
 251   OutBufCur += Size;
 252 }
 253
 254 // Formatted output.
 255 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 256   // If we have more than a few bytes left in our output buffer, try
 257   // formatting directly onto its end.
 258   //
 259   // FIXME: This test is a bit silly, since if we don't have enough
 260   // space in the buffer we will have to flush the formatted output
 261   // anyway. We should just flush upfront in such cases, and use the
 262   // whole buffer as our scratch pad. Note, however, that this case is
 263   // also necessary for correctness on unbuffered streams.
 264   size_t NextBufferSize = 127;
 265   if (OutBufEnd-OutBufCur > 3) {
 266     size_t BufferBytesLeft = OutBufEnd-OutBufCur;
 267     size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 268
 269     // Common case is that we have plenty of space.
 270     if (BytesUsed < BufferBytesLeft) {
 271       OutBufCur += BytesUsed;
 272       return *this;
 273     }
 274
 275     // Otherwise, we overflowed and the return value tells us the size to try
 276     // again with.
 277     NextBufferSize = BytesUsed;
 278   }
 279
 280   // If we got here, we didn't have enough space in the output buffer for the
 281   // string.  Try printing into a SmallVector that is resized to have enough
 282   // space.  Iterate until we win.
 283   SmallVector<char, 128> V;
 284
 285   while (1) {
 286     V.resize(NextBufferSize);
 287
 288     // Try formatting into the SmallVector.
 289     size_t BytesUsed = Fmt.print(&V[0], NextBufferSize);
 290
 291     // If BytesUsed fit into the vector, we win.
 292     if (BytesUsed <= NextBufferSize)
 293       return write(&V[0], BytesUsed);
 294
 295     // Otherwise, try again with a new size.
 296     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 297     NextBufferSize = BytesUsed;
 298   }
 299 }
 300
 301 //===----------------------------------------------------------------------===//
 302 //  Formatted Output
 303 //===----------------------------------------------------------------------===//
 304
 305 // Out of line virtual method.
 306 void format_object_base::home() {
 307 }
 308
 309 //===----------------------------------------------------------------------===//
 310 //  raw_fd_ostream
 311 //===----------------------------------------------------------------------===//
 312
 313 /// raw_fd_ostream - Open the specified file for writing. If an error
 314 /// occurs, information about the error is put into ErrorInfo, and the
 315 /// stream should be immediately destroyed; the string will be empty
 316 /// if no error occurred.
 317 raw_fd_ostream::raw_fd_ostream(const char *Filename, bool Binary, bool Force,
 318                                std::string &ErrorInfo) : pos(0) {
 319   ErrorInfo.clear();
 320
 321   // Handle "-" as stdout.
 322   if (Filename[0] == '-' && Filename[1] == 0) {
 323     FD = STDOUT_FILENO;
 324     // If user requested binary then put stdout into binary mode if
 325     // possible.
 326     if (Binary)
 327       sys::Program::ChangeStdoutToBinary();
 328     ShouldClose = false;
 329     return;
 330   }
 331
 332   int Flags = O_WRONLY|O_CREAT|O_TRUNC;
 333 #ifdef O_BINARY
 334   if (Binary)
 335     Flags |= O_BINARY;
 336 #endif
 337   if (!Force)
 338     Flags |= O_EXCL;
 339   FD = open(Filename, Flags, 0664);
 340   if (FD < 0) {
 341     ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 342     ShouldClose = false;
 343   } else {
 344     ShouldClose = true;
 345   }
 346 }
 347
 348 raw_fd_ostream::~raw_fd_ostream() {
 349   if (FD >= 0) {
 350     flush();
 351     if (ShouldClose)
 352       if (::close(FD) != 0)
 353         error_detected();
 354   }
 355 }
 356
 357 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
 358   assert (FD >= 0 && "File already closed.");
 359   pos += Size;
 360   if (::write(FD, Ptr, Size) != (ssize_t) Size)
 361     error_detected();
 362 }
 363
 364 void raw_fd_ostream::close() {
 365   assert (ShouldClose);
 366   ShouldClose = false;
 367   flush();
 368   if (::close(FD) != 0)
 369     error_detected();
 370   FD = -1;
 371 }
 372
 373 uint64_t raw_fd_ostream::seek(uint64_t off) {
 374   flush();
 375   pos = ::lseek(FD, off, SEEK_SET);
 376   if (pos != off)
 377     error_detected();
 378   return pos;
 379 }
 380
 381 size_t raw_fd_ostream::preferred_buffer_size() {
 382 #if !defined(_MSC_VER) && !defined(__MINGW32__) // Windows has no st_blksize.
 383   assert(FD >= 0 && "File not yet open!");
 384   struct stat statbuf;
 385   if (fstat(FD, &statbuf) == 0) {
 386     // If this is a terminal, don't use buffering. Line buffering
 387     // would be a more traditional thing to do, but it's not worth
 388     // the complexity.
 389     if (S_ISCHR(statbuf.st_mode) && isatty(FD))
 390       return 0;
 391     // Return the preferred block size.
 392     return statbuf.st_blksize;
 393   }
 394   error_detected();
 395 #endif
 396   return raw_ostream::preferred_buffer_size();
 397 }
 398
 399 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
 400                                          bool bg) {
 401   if (sys::Process::ColorNeedsFlush())
 402     flush();
 403   const char *colorcode =
 404     (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
 405     : sys::Process::OutputColor(colors, bold, bg);
 406   if (colorcode) {
 407     size_t len = strlen(colorcode);
 408     write(colorcode, len);
 409     // don't account colors towards output characters
 410     pos -= len;
 411   }
 412   return *this;
 413 }
 414
 415 raw_ostream &raw_fd_ostream::resetColor() {
 416   if (sys::Process::ColorNeedsFlush())
 417     flush();
 418   const char *colorcode = sys::Process::ResetColor();
 419   if (colorcode) {
 420     size_t len = strlen(colorcode);
 421     write(colorcode, len);
 422     // don't account colors towards output characters
 423     pos -= len;
 424   }
 425   return *this;
 426 }
 427
 428 //===----------------------------------------------------------------------===//
 429 //  raw_stdout/err_ostream
 430 //===----------------------------------------------------------------------===//
 431
 432 // Set buffer settings to model stdout and stderr behavior.
 433 // Set standard error to be unbuffered by default.
 434 raw_stdout_ostream::raw_stdout_ostream():raw_fd_ostream(STDOUT_FILENO, false) {}
 435 raw_stderr_ostream::raw_stderr_ostream():raw_fd_ostream(STDERR_FILENO, false,
 436                                                         true) {}
 437
 438 // An out of line virtual method to provide a home for the class vtable.
 439 void raw_stdout_ostream::handle() {}
 440 void raw_stderr_ostream::handle() {}
 441
 442 /// outs() - This returns a reference to a raw_ostream for standard output.
 443 /// Use it like: outs() << "foo" << "bar";
 444 raw_ostream &llvm::outs() {
 445   static raw_stdout_ostream S;
 446   return S;
 447 }
 448
 449 /// errs() - This returns a reference to a raw_ostream for standard error.
 450 /// Use it like: errs() << "foo" << "bar";
 451 raw_ostream &llvm::errs() {
 452   static raw_stderr_ostream S;
 453   return S;
 454 }
 455
 456 /// nulls() - This returns a reference to a raw_ostream which discards output.
 457 raw_ostream &llvm::nulls() {
 458   static raw_null_ostream S;
 459   return S;
 460 }
 461
 462 //===----------------------------------------------------------------------===//
 463 //  raw_os_ostream
 464 //===----------------------------------------------------------------------===//
 465
 466 raw_os_ostream::~raw_os_ostream() {
 467   flush();
 468 }
 469
 470 void raw_os_ostream::write_impl(const char *Ptr, size_t Size) {
 471   OS.write(Ptr, Size);
 472 }
 473
 474 uint64_t raw_os_ostream::current_pos() { return OS.tellp(); }
 475
 476 uint64_t raw_os_ostream::tell() {
 477   return (uint64_t)OS.tellp() + GetNumBytesInBuffer();
 478 }
 479
 480 //===----------------------------------------------------------------------===//
 481 //  raw_string_ostream
 482 //===----------------------------------------------------------------------===//
 483
 484 raw_string_ostream::~raw_string_ostream() {
 485   flush();
 486 }
 487
 488 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
 489   OS.append(Ptr, Size);
 490 }
 491
 492 //===----------------------------------------------------------------------===//
 493 //  raw_svector_ostream
 494 //===----------------------------------------------------------------------===//
 495
 496 raw_svector_ostream::~raw_svector_ostream() {
 497   flush();
 498 }
 499
 500 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
 501   OS.append(Ptr, Ptr + Size);
 502 }
 503
 504 uint64_t raw_svector_ostream::current_pos() { return OS.size(); }
 505
 506 uint64_t raw_svector_ostream::tell() {
 507   return OS.size() + GetNumBytesInBuffer();
 508 }
 509
 510 //===----------------------------------------------------------------------===//
 511 //  raw_null_ostream
 512 //===----------------------------------------------------------------------===//
 513
 514 raw_null_ostream::~raw_null_ostream() {
 515 #ifndef NDEBUG
 516   // ~raw_ostream asserts that the buffer is empty. This isn't necessary
 517   // with raw_null_ostream, but it's better to have raw_null_ostream follow
 518   // the rules than to change the rules just for raw_null_ostream.
 519   flush();
 520 #endif
 521 }
 522
 523 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
 524 }
 525
 526 uint64_t raw_null_ostream::current_pos() {
 527   return 0;
 528 }