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
  24 #if defined(HAVE_UNISTD_H)
  25 # include <unistd.h>
  26 #endif
  27 #if defined(HAVE_FCNTL_H)
  28 # include <fcntl.h>
  29 #endif
  30
  31 #if defined(_MSC_VER)
  32 #include <io.h>
  33 #include <fcntl.h>
  34 #ifndef STDIN_FILENO
  35 # define STDIN_FILENO 0
  36 #endif
  37 #ifndef STDOUT_FILENO
  38 # define STDOUT_FILENO 1
  39 #endif
  40 #ifndef STDERR_FILENO
  41 # define STDERR_FILENO 2
  42 #endif
  43 #endif
  44
  45 using namespace llvm;
  46
  47 raw_ostream::~raw_ostream() {
  48   // raw_ostream's subclasses should take care to flush the buffer
  49   // in their destructors.
  50   assert(OutBufCur == OutBufStart &&
  51          "raw_ostream destructor called with non-empty buffer!");
  52
  53   delete [] OutBufStart;
  54
  55   // If there are any pending errors, report them now. Clients wishing
  56   // to avoid llvm_report_error calls should check for errors with
  57   // has_error() and clear the error flag with clear_error() before
  58   // destructing raw_ostream objects which may have errors.
  59   if (Error)
  60     llvm_report_error("IO failure on output stream.");
  61 }
  62
  63 // An out of line virtual method to provide a home for the class vtable.
  64 void raw_ostream::handle() {}
  65
  66 raw_ostream &raw_ostream::operator<<(unsigned long N) {
  67   // Zero is a special case.
  68   if (N == 0)
  69     return *this << '0';
  70
  71   char NumberBuffer[20];
  72   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
  73   char *CurPtr = EndPtr;
  74
  75   while (N) {
  76     *--CurPtr = '0' + char(N % 10);
  77     N /= 10;
  78   }
  79   return write(CurPtr, EndPtr-CurPtr);
  80 }
  81
  82 raw_ostream &raw_ostream::operator<<(long N) {
  83   if (N <  0) {
  84     *this << '-';
  85     N = -N;
  86   }
  87
  88   return this->operator<<(static_cast<unsigned long>(N));
  89 }
  90
  91 raw_ostream &raw_ostream::operator<<(unsigned long long N) {
  92   // Output using 32-bit div/mod when possible.
  93   if (N == static_cast<unsigned long>(N))
  94     return this->operator<<(static_cast<unsigned long>(N));
  95
  96   char NumberBuffer[20];
  97   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
  98   char *CurPtr = EndPtr;
  99
 100   while (N) {
 101     *--CurPtr = '0' + char(N % 10);
 102     N /= 10;
 103   }
 104   return write(CurPtr, EndPtr-CurPtr);
 105 }
 106
 107 raw_ostream &raw_ostream::operator<<(long long N) {
 108   if (N <  0) {
 109     *this << '-';
 110     N = -N;
 111   }
 112
 113   return this->operator<<(static_cast<unsigned long long>(N));
 114 }
 115
 116 raw_ostream &raw_ostream::operator<<(const void *P) {
 117   uintptr_t N = (uintptr_t) P;
 118   *this << '0' << 'x';
 119
 120   // Zero is a special case.
 121   if (N == 0)
 122     return *this << '0';
 123
 124   char NumberBuffer[20];
 125   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 126   char *CurPtr = EndPtr;
 127
 128   while (N) {
 129     uintptr_t x = N % 16;
 130     *--CurPtr = (x < 10 ? '0' + x : 'a' + x - 10);
 131     N /= 16;
 132   }
 133
 134   return write(CurPtr, EndPtr-CurPtr);
 135 }
 136
 137 void raw_ostream::flush_nonempty() {
 138   assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
 139   write_impl(OutBufStart, OutBufCur - OutBufStart);
 140   OutBufCur = OutBufStart;
 141 }
 142
 143 raw_ostream &raw_ostream::write(unsigned char C) {
 144   // Group exceptional cases into a single branch.
 145   if (OutBufCur >= OutBufEnd) {
 146     if (Unbuffered) {
 147       write_impl(reinterpret_cast<char*>(&C), 1);
 148       return *this;
 149     }
 150
 151     if (!OutBufStart)
 152       SetBufferSize();
 153     else
 154       flush_nonempty();
 155   }
 156
 157   *OutBufCur++ = C;
 158   return *this;
 159 }
 160
 161 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
 162   // Group exceptional cases into a single branch.
 163   if (BUILTIN_EXPECT(OutBufCur+Size > OutBufEnd, false)) {
 164     if (Unbuffered) {
 165       write_impl(Ptr, Size);
 166       return *this;
 167     }
 168
 169     if (!OutBufStart)
 170       SetBufferSize();
 171     else
 172       flush_nonempty();
 173   }
 174
 175   // Handle short strings specially, memcpy isn't very good at very short
 176   // strings.
 177   switch (Size) {
 178   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 179   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 180   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 181   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 182   case 0: break;
 183   default:
 184     // Normally the string to emit is shorter than the buffer.
 185     if (Size <= unsigned(OutBufEnd-OutBufCur)) {
 186       memcpy(OutBufCur, Ptr, Size);
 187       break;
 188     }
 189
 190     // Otherwise we are emitting a string larger than our buffer. We
 191     // know we already flushed, so just write it out directly.
 192     write_impl(Ptr, Size);
 193     Size = 0;
 194     break;
 195   }
 196   OutBufCur += Size;
 197
 198   return *this;
 199 }
 200
 201 // Formatted output.
 202 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 203   // If we have more than a few bytes left in our output buffer, try
 204   // formatting directly onto its end.
 205   //
 206   // FIXME: This test is a bit silly, since if we don't have enough
 207   // space in the buffer we will have to flush the formatted output
 208   // anyway. We should just flush upfront in such cases, and use the
 209   // whole buffer as our scratch pad. Note, however, that this case is
 210   // also necessary for correctness on unbuffered streams.
 211   size_t NextBufferSize = 127;
 212   if (OutBufEnd-OutBufCur > 3) {
 213     size_t BufferBytesLeft = OutBufEnd-OutBufCur;
 214     size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 215
 216     // Common case is that we have plenty of space.
 217     if (BytesUsed < BufferBytesLeft) {
 218       OutBufCur += BytesUsed;
 219       return *this;
 220     }
 221
 222     // Otherwise, we overflowed and the return value tells us the size to try
 223     // again with.
 224     NextBufferSize = BytesUsed;
 225   }
 226
 227   // If we got here, we didn't have enough space in the output buffer for the
 228   // string.  Try printing into a SmallVector that is resized to have enough
 229   // space.  Iterate until we win.
 230   SmallVector<char, 128> V;
 231
 232   while (1) {
 233     V.resize(NextBufferSize);
 234
 235     // Try formatting into the SmallVector.
 236     size_t BytesUsed = Fmt.print(&V[0], NextBufferSize);
 237
 238     // If BytesUsed fit into the vector, we win.
 239     if (BytesUsed <= NextBufferSize)
 240       return write(&V[0], BytesUsed);
 241
 242     // Otherwise, try again with a new size.
 243     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 244     NextBufferSize = BytesUsed;
 245   }
 246 }
 247
 248 //===----------------------------------------------------------------------===//
 249 //  Formatted Output
 250 //===----------------------------------------------------------------------===//
 251
 252 // Out of line virtual method.
 253 void format_object_base::home() {
 254 }
 255
 256 //===----------------------------------------------------------------------===//
 257 //  raw_fd_ostream
 258 //===----------------------------------------------------------------------===//
 259
 260 /// raw_fd_ostream - Open the specified file for writing. If an error
 261 /// occurs, information about the error is put into ErrorInfo, and the
 262 /// stream should be immediately destroyed; the string will be empty
 263 /// if no error occurred.
 264 raw_fd_ostream::raw_fd_ostream(const char *Filename, bool Binary, bool Force,
 265                                std::string &ErrorInfo) : pos(0) {
 266   ErrorInfo.clear();
 267
 268   // Handle "-" as stdout.
 269   if (Filename[0] == '-' && Filename[1] == 0) {
 270     FD = STDOUT_FILENO;
 271     // If user requested binary then put stdout into binary mode if
 272     // possible.
 273     if (Binary)
 274       sys::Program::ChangeStdoutToBinary();
 275     ShouldClose = false;
 276     return;
 277   }
 278
 279   int Flags = O_WRONLY|O_CREAT|O_TRUNC;
 280 #ifdef O_BINARY
 281   if (Binary)
 282     Flags |= O_BINARY;
 283 #endif
 284   if (!Force)
 285     Flags |= O_EXCL;
 286   FD = open(Filename, Flags, 0664);
 287   if (FD < 0) {
 288     ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 289     ShouldClose = false;
 290   } else {
 291     ShouldClose = true;
 292   }
 293 }
 294
 295 raw_fd_ostream::~raw_fd_ostream() {
 296   if (FD >= 0) {
 297     flush();
 298     if (ShouldClose)
 299       if (::close(FD) != 0)
 300         error_detected();
 301   }
 302 }
 303
 304 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
 305   assert (FD >= 0 && "File already closed.");
 306   pos += Size;
 307   if (::write(FD, Ptr, Size) != (ssize_t) Size)
 308     error_detected();
 309 }
 310
 311 void raw_fd_ostream::close() {
 312   assert (ShouldClose);
 313   ShouldClose = false;
 314   flush();
 315   if (::close(FD) != 0)
 316     error_detected();
 317   FD = -1;
 318 }
 319
 320 uint64_t raw_fd_ostream::seek(uint64_t off) {
 321   flush();
 322   pos = ::lseek(FD, off, SEEK_SET);
 323   if (pos != off)
 324     error_detected();
 325   return pos;
 326 }
 327
 328 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
 329                                          bool bg) {
 330   if (sys::Process::ColorNeedsFlush())
 331     flush();
 332   const char *colorcode =
 333     (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
 334     : sys::Process::OutputColor(colors, bold, bg);
 335   if (colorcode) {
 336     size_t len = strlen(colorcode);
 337     write(colorcode, len);
 338     // don't account colors towards output characters
 339     pos -= len;
 340   }
 341   return *this;
 342 }
 343
 344 raw_ostream &raw_fd_ostream::resetColor() {
 345   if (sys::Process::ColorNeedsFlush())
 346     flush();
 347   const char *colorcode = sys::Process::ResetColor();
 348   if (colorcode) {
 349     size_t len = strlen(colorcode);
 350     write(colorcode, len);
 351     // don't account colors towards output characters
 352     pos -= len;
 353   }
 354   return *this;
 355 }
 356
 357 //===----------------------------------------------------------------------===//
 358 //  raw_stdout/err_ostream
 359 //===----------------------------------------------------------------------===//
 360
 361 raw_stdout_ostream::raw_stdout_ostream():raw_fd_ostream(STDOUT_FILENO, false) {}
 362 raw_stderr_ostream::raw_stderr_ostream():raw_fd_ostream(STDERR_FILENO, false,
 363                                                         true) {}
 364
 365 // An out of line virtual method to provide a home for the class vtable.
 366 void raw_stdout_ostream::handle() {}
 367 void raw_stderr_ostream::handle() {}
 368
 369 /// outs() - This returns a reference to a raw_ostream for standard output.
 370 /// Use it like: outs() << "foo" << "bar";
 371 raw_ostream &llvm::outs() {
 372   static raw_stdout_ostream S;
 373   return S;
 374 }
 375
 376 /// errs() - This returns a reference to a raw_ostream for standard error.
 377 /// Use it like: errs() << "foo" << "bar";
 378 raw_ostream &llvm::errs() {
 379   static raw_stderr_ostream S;
 380   return S;
 381 }
 382
 383 /// nulls() - This returns a reference to a raw_ostream which discards output.
 384 raw_ostream &llvm::nulls() {
 385   static raw_null_ostream S;
 386   return S;
 387 }
 388
 389 //===----------------------------------------------------------------------===//
 390 //  raw_os_ostream
 391 //===----------------------------------------------------------------------===//
 392
 393 raw_os_ostream::~raw_os_ostream() {
 394   flush();
 395 }
 396
 397 void raw_os_ostream::write_impl(const char *Ptr, size_t Size) {
 398   OS.write(Ptr, Size);
 399 }
 400
 401 uint64_t raw_os_ostream::current_pos() { return OS.tellp(); }
 402
 403 uint64_t raw_os_ostream::tell() {
 404   return (uint64_t)OS.tellp() + GetNumBytesInBuffer();
 405 }
 406
 407 //===----------------------------------------------------------------------===//
 408 //  raw_string_ostream
 409 //===----------------------------------------------------------------------===//
 410
 411 raw_string_ostream::~raw_string_ostream() {
 412   flush();
 413 }
 414
 415 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
 416   OS.append(Ptr, Size);
 417 }
 418
 419 //===----------------------------------------------------------------------===//
 420 //  raw_svector_ostream
 421 //===----------------------------------------------------------------------===//
 422
 423 raw_svector_ostream::~raw_svector_ostream() {
 424   flush();
 425 }
 426
 427 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
 428   OS.append(Ptr, Ptr + Size);
 429 }
 430
 431 uint64_t raw_svector_ostream::current_pos() { return OS.size(); }
 432
 433 uint64_t raw_svector_ostream::tell() {
 434   return OS.size() + GetNumBytesInBuffer();
 435 }
 436
 437 //===----------------------------------------------------------------------===//
 438 //  raw_null_ostream
 439 //===----------------------------------------------------------------------===//
 440
 441 raw_null_ostream::~raw_null_ostream() {
 442 #ifndef NDEBUG
 443   // ~raw_ostream asserts that the buffer is empty. This isn't necessary
 444   // with raw_null_ostream, but it's better to have raw_null_ostream follow
 445   // the rules than to change the rules just for raw_null_ostream.
 446   flush();
 447 #endif
 448 }
 449
 450 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
 451 }
 452
 453 uint64_t raw_null_ostream::current_pos() {
 454   return 0;
 455 }