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::write_hex(unsigned long long N) {
 117   // Zero is a special case.
 118   if (N == 0)
 119     return *this << '0';
 120
 121   char NumberBuffer[20];
 122   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 123   char *CurPtr = EndPtr;
 124
 125   while (N) {
 126     uintptr_t x = N % 16;
 127     *--CurPtr = (x < 10 ? '0' + x : 'a' + x - 10);
 128     N /= 16;
 129   }
 130
 131   return write(CurPtr, EndPtr-CurPtr);
 132 }
 133
 134 raw_ostream &raw_ostream::operator<<(const void *P) {
 135   *this << '0' << 'x';
 136
 137   return write_hex((uintptr_t) P);
 138 }
 139
 140 void raw_ostream::flush_nonempty() {
 141   assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
 142   write_impl(OutBufStart, OutBufCur - OutBufStart);
 143   OutBufCur = OutBufStart;
 144 }
 145
 146 raw_ostream &raw_ostream::write(unsigned char C) {
 147   // Group exceptional cases into a single branch.
 148   if (OutBufCur >= OutBufEnd) {
 149     if (Unbuffered) {
 150       write_impl(reinterpret_cast<char*>(&C), 1);
 151       return *this;
 152     }
 153
 154     if (!OutBufStart)
 155       SetBufferSize();
 156     else
 157       flush_nonempty();
 158   }
 159
 160   *OutBufCur++ = C;
 161   return *this;
 162 }
 163
 164 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
 165   // Group exceptional cases into a single branch.
 166   if (BUILTIN_EXPECT(OutBufCur+Size > OutBufEnd, false)) {
 167     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 168       if (Unbuffered) {
 169         write_impl(Ptr, Size);
 170         return *this;
 171       }
 172       // Set up a buffer and start over.
 173       SetBufferSize();
 174       return write(Ptr, Size);
 175     }
 176     // Write out the data in buffer-sized blocks until the remainder
 177     // fits within the buffer.
 178     do {
 179       size_t NumBytes = OutBufEnd - OutBufCur;
 180       copy_to_buffer(Ptr, NumBytes);
 181       flush_nonempty();
 182       Ptr += NumBytes;
 183       Size -= NumBytes;
 184     } while (OutBufCur+Size > OutBufEnd);
 185   }
 186
 187   copy_to_buffer(Ptr, Size);
 188
 189   return *this;
 190 }
 191
 192 void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
 193   // Handle short strings specially, memcpy isn't very good at very short
 194   // strings.
 195   switch (Size) {
 196   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 197   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 198   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 199   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 200   case 0: break;
 201   default:
 202     memcpy(OutBufCur, Ptr, Size);
 203     break;
 204   }
 205
 206   OutBufCur += Size;
 207 }
 208
 209 // Formatted output.
 210 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 211   // If we have more than a few bytes left in our output buffer, try
 212   // formatting directly onto its end.
 213   //
 214   // FIXME: This test is a bit silly, since if we don't have enough
 215   // space in the buffer we will have to flush the formatted output
 216   // anyway. We should just flush upfront in such cases, and use the
 217   // whole buffer as our scratch pad. Note, however, that this case is
 218   // also necessary for correctness on unbuffered streams.
 219   size_t NextBufferSize = 127;
 220   if (OutBufEnd-OutBufCur > 3) {
 221     size_t BufferBytesLeft = OutBufEnd-OutBufCur;
 222     size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 223
 224     // Common case is that we have plenty of space.
 225     if (BytesUsed < BufferBytesLeft) {
 226       OutBufCur += BytesUsed;
 227       return *this;
 228     }
 229
 230     // Otherwise, we overflowed and the return value tells us the size to try
 231     // again with.
 232     NextBufferSize = BytesUsed;
 233   }
 234
 235   // If we got here, we didn't have enough space in the output buffer for the
 236   // string.  Try printing into a SmallVector that is resized to have enough
 237   // space.  Iterate until we win.
 238   SmallVector<char, 128> V;
 239
 240   while (1) {
 241     V.resize(NextBufferSize);
 242
 243     // Try formatting into the SmallVector.
 244     size_t BytesUsed = Fmt.print(&V[0], NextBufferSize);
 245
 246     // If BytesUsed fit into the vector, we win.
 247     if (BytesUsed <= NextBufferSize)
 248       return write(&V[0], BytesUsed);
 249
 250     // Otherwise, try again with a new size.
 251     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 252     NextBufferSize = BytesUsed;
 253   }
 254 }
 255
 256 //===----------------------------------------------------------------------===//
 257 //  Formatted Output
 258 //===----------------------------------------------------------------------===//
 259
 260 // Out of line virtual method.
 261 void format_object_base::home() {
 262 }
 263
 264 //===----------------------------------------------------------------------===//
 265 //  raw_fd_ostream
 266 //===----------------------------------------------------------------------===//
 267
 268 /// raw_fd_ostream - Open the specified file for writing. If an error
 269 /// occurs, information about the error is put into ErrorInfo, and the
 270 /// stream should be immediately destroyed; the string will be empty
 271 /// if no error occurred.
 272 raw_fd_ostream::raw_fd_ostream(const char *Filename, bool Binary, bool Force,
 273                                std::string &ErrorInfo) : pos(0) {
 274   ErrorInfo.clear();
 275
 276   // Handle "-" as stdout.
 277   if (Filename[0] == '-' && Filename[1] == 0) {
 278     FD = STDOUT_FILENO;
 279     // If user requested binary then put stdout into binary mode if
 280     // possible.
 281     if (Binary)
 282       sys::Program::ChangeStdoutToBinary();
 283     ShouldClose = false;
 284     return;
 285   }
 286
 287   int Flags = O_WRONLY|O_CREAT|O_TRUNC;
 288 #ifdef O_BINARY
 289   if (Binary)
 290     Flags |= O_BINARY;
 291 #endif
 292   if (!Force)
 293     Flags |= O_EXCL;
 294   FD = open(Filename, Flags, 0664);
 295   if (FD < 0) {
 296     ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 297     ShouldClose = false;
 298   } else {
 299     ShouldClose = true;
 300   }
 301 }
 302
 303 raw_fd_ostream::~raw_fd_ostream() {
 304   if (FD >= 0) {
 305     flush();
 306     if (ShouldClose)
 307       if (::close(FD) != 0)
 308         error_detected();
 309   }
 310 }
 311
 312 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
 313   assert (FD >= 0 && "File already closed.");
 314   pos += Size;
 315   if (::write(FD, Ptr, Size) != (ssize_t) Size)
 316     error_detected();
 317 }
 318
 319 void raw_fd_ostream::close() {
 320   assert (ShouldClose);
 321   ShouldClose = false;
 322   flush();
 323   if (::close(FD) != 0)
 324     error_detected();
 325   FD = -1;
 326 }
 327
 328 uint64_t raw_fd_ostream::seek(uint64_t off) {
 329   flush();
 330   pos = ::lseek(FD, off, SEEK_SET);
 331   if (pos != off)
 332     error_detected();
 333   return pos;
 334 }
 335
 336 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
 337                                          bool bg) {
 338   if (sys::Process::ColorNeedsFlush())
 339     flush();
 340   const char *colorcode =
 341     (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
 342     : sys::Process::OutputColor(colors, bold, bg);
 343   if (colorcode) {
 344     size_t len = strlen(colorcode);
 345     write(colorcode, len);
 346     // don't account colors towards output characters
 347     pos -= len;
 348   }
 349   return *this;
 350 }
 351
 352 raw_ostream &raw_fd_ostream::resetColor() {
 353   if (sys::Process::ColorNeedsFlush())
 354     flush();
 355   const char *colorcode = sys::Process::ResetColor();
 356   if (colorcode) {
 357     size_t len = strlen(colorcode);
 358     write(colorcode, len);
 359     // don't account colors towards output characters
 360     pos -= len;
 361   }
 362   return *this;
 363 }
 364
 365 //===----------------------------------------------------------------------===//
 366 //  raw_stdout/err_ostream
 367 //===----------------------------------------------------------------------===//
 368
 369 raw_stdout_ostream::raw_stdout_ostream():raw_fd_ostream(STDOUT_FILENO, false) {}
 370 raw_stderr_ostream::raw_stderr_ostream():raw_fd_ostream(STDERR_FILENO, false,
 371                                                         true) {}
 372
 373 // An out of line virtual method to provide a home for the class vtable.
 374 void raw_stdout_ostream::handle() {}
 375 void raw_stderr_ostream::handle() {}
 376
 377 /// outs() - This returns a reference to a raw_ostream for standard output.
 378 /// Use it like: outs() << "foo" << "bar";
 379 raw_ostream &llvm::outs() {
 380   static raw_stdout_ostream S;
 381   return S;
 382 }
 383
 384 /// errs() - This returns a reference to a raw_ostream for standard error.
 385 /// Use it like: errs() << "foo" << "bar";
 386 raw_ostream &llvm::errs() {
 387   static raw_stderr_ostream S;
 388   return S;
 389 }
 390
 391 /// nulls() - This returns a reference to a raw_ostream which discards output.
 392 raw_ostream &llvm::nulls() {
 393   static raw_null_ostream S;
 394   return S;
 395 }
 396
 397 //===----------------------------------------------------------------------===//
 398 //  raw_os_ostream
 399 //===----------------------------------------------------------------------===//
 400
 401 raw_os_ostream::~raw_os_ostream() {
 402   flush();
 403 }
 404
 405 void raw_os_ostream::write_impl(const char *Ptr, size_t Size) {
 406   OS.write(Ptr, Size);
 407 }
 408
 409 uint64_t raw_os_ostream::current_pos() { return OS.tellp(); }
 410
 411 uint64_t raw_os_ostream::tell() {
 412   return (uint64_t)OS.tellp() + GetNumBytesInBuffer();
 413 }
 414
 415 //===----------------------------------------------------------------------===//
 416 //  raw_string_ostream
 417 //===----------------------------------------------------------------------===//
 418
 419 raw_string_ostream::~raw_string_ostream() {
 420   flush();
 421 }
 422
 423 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
 424   OS.append(Ptr, Size);
 425 }
 426
 427 //===----------------------------------------------------------------------===//
 428 //  raw_svector_ostream
 429 //===----------------------------------------------------------------------===//
 430
 431 raw_svector_ostream::~raw_svector_ostream() {
 432   flush();
 433 }
 434
 435 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
 436   OS.append(Ptr, Ptr + Size);
 437 }
 438
 439 uint64_t raw_svector_ostream::current_pos() { return OS.size(); }
 440
 441 uint64_t raw_svector_ostream::tell() {
 442   return OS.size() + GetNumBytesInBuffer();
 443 }
 444
 445 //===----------------------------------------------------------------------===//
 446 //  raw_null_ostream
 447 //===----------------------------------------------------------------------===//
 448
 449 raw_null_ostream::~raw_null_ostream() {
 450 #ifndef NDEBUG
 451   // ~raw_ostream asserts that the buffer is empty. This isn't necessary
 452   // with raw_null_ostream, but it's better to have raw_null_ostream follow
 453   // the rules than to change the rules just for raw_null_ostream.
 454   flush();
 455 #endif
 456 }
 457
 458 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
 459 }
 460
 461 uint64_t raw_null_ostream::current_pos() {
 462   return 0;
 463 }