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