1 //===--- raw_ostream.cpp - Implement the raw_ostream classes --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This implements support for bulk buffered stream output.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Support/raw_ostream.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/Config/config.h"
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/FileSystem.h"
22 #include "llvm/Support/Format.h"
23 #include "llvm/Support/FormatVariadic.h"
24 #include "llvm/Support/MathExtras.h"
25 #include "llvm/Support/NativeFormatting.h"
26 #include "llvm/Support/Process.h"
27 #include "llvm/Support/Program.h"
34 #include <system_error>
36 // <fcntl.h> may provide O_BINARY.
37 #if defined(HAVE_FCNTL_H)
41 #if defined(HAVE_UNISTD_H)
44 #if defined(HAVE_SYS_UIO_H) && defined(HAVE_WRITEV)
48 #if defined(__CYGWIN__)
55 # define STDIN_FILENO 0
58 # define STDOUT_FILENO 1
61 # define STDERR_FILENO 2
66 #include "Windows/WindowsSupport.h"
71 raw_ostream::~raw_ostream() {
72 // raw_ostream's subclasses should take care to flush the buffer
73 // in their destructors.
74 assert(OutBufCur == OutBufStart &&
75 "raw_ostream destructor called with non-empty buffer!");
77 if (BufferMode == InternalBuffer)
78 delete [] OutBufStart;
81 // An out of line virtual method to provide a home for the class vtable.
82 void raw_ostream::handle() {}
84 size_t raw_ostream::preferred_buffer_size() const {
85 // BUFSIZ is intended to be a reasonable default.
89 void raw_ostream::SetBuffered() {
90 // Ask the subclass to determine an appropriate buffer size.
91 if (size_t Size = preferred_buffer_size())
94 // It may return 0, meaning this stream should be unbuffered.
98 void raw_ostream::SetBufferAndMode(char *BufferStart, size_t Size,
100 assert(((Mode == Unbuffered && !BufferStart && Size == 0) ||
101 (Mode != Unbuffered && BufferStart && Size != 0)) &&
102 "stream must be unbuffered or have at least one byte");
103 // Make sure the current buffer is free of content (we can't flush here; the
104 // child buffer management logic will be in write_impl).
105 assert(GetNumBytesInBuffer() == 0 && "Current buffer is non-empty!");
107 if (BufferMode == InternalBuffer)
108 delete [] OutBufStart;
109 OutBufStart = BufferStart;
110 OutBufEnd = OutBufStart+Size;
111 OutBufCur = OutBufStart;
114 assert(OutBufStart <= OutBufEnd && "Invalid size!");
117 raw_ostream &raw_ostream::operator<<(unsigned long N) {
118 write_integer(*this, static_cast<uint64_t>(N), 0, IntegerStyle::Integer);
122 raw_ostream &raw_ostream::operator<<(long N) {
123 write_integer(*this, static_cast<int64_t>(N), 0, IntegerStyle::Integer);
127 raw_ostream &raw_ostream::operator<<(unsigned long long N) {
128 write_integer(*this, static_cast<uint64_t>(N), 0, IntegerStyle::Integer);
132 raw_ostream &raw_ostream::operator<<(long long N) {
133 write_integer(*this, static_cast<int64_t>(N), 0, IntegerStyle::Integer);
137 raw_ostream &raw_ostream::write_hex(unsigned long long N) {
138 llvm::write_hex(*this, N, HexPrintStyle::Lower);
142 raw_ostream &raw_ostream::write_escaped(StringRef Str,
143 bool UseHexEscapes) {
144 for (unsigned char c : Str) {
147 *this << '\\' << '\\';
150 *this << '\\' << 't';
153 *this << '\\' << 'n';
156 *this << '\\' << '"';
159 if (std::isprint(c)) {
164 // Write out the escaped representation.
166 *this << '\\' << 'x';
167 *this << hexdigit((c >> 4 & 0xF));
168 *this << hexdigit((c >> 0) & 0xF);
170 // Always use a full 3-character octal escape.
172 *this << char('0' + ((c >> 6) & 7));
173 *this << char('0' + ((c >> 3) & 7));
174 *this << char('0' + ((c >> 0) & 7));
182 raw_ostream &raw_ostream::operator<<(const void *P) {
183 llvm::write_hex(*this, (uintptr_t)P, HexPrintStyle::PrefixLower);
187 raw_ostream &raw_ostream::operator<<(double N) {
188 llvm::write_double(*this, N, FloatStyle::Exponent);
192 void raw_ostream::flush_nonempty() {
193 assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
194 size_t Length = OutBufCur - OutBufStart;
195 OutBufCur = OutBufStart;
196 write_impl(OutBufStart, Length);
199 raw_ostream &raw_ostream::write(unsigned char C) {
200 // Group exceptional cases into a single branch.
201 if (LLVM_UNLIKELY(OutBufCur >= OutBufEnd)) {
202 if (LLVM_UNLIKELY(!OutBufStart)) {
203 if (BufferMode == Unbuffered) {
204 write_impl(reinterpret_cast<char*>(&C), 1);
207 // Set up a buffer and start over.
219 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
220 // Group exceptional cases into a single branch.
221 if (LLVM_UNLIKELY(size_t(OutBufEnd - OutBufCur) < Size)) {
222 if (LLVM_UNLIKELY(!OutBufStart)) {
223 if (BufferMode == Unbuffered) {
224 write_impl(Ptr, Size);
227 // Set up a buffer and start over.
229 return write(Ptr, Size);
232 size_t NumBytes = OutBufEnd - OutBufCur;
234 // If the buffer is empty at this point we have a string that is larger
235 // than the buffer. Directly write the chunk that is a multiple of the
236 // preferred buffer size and put the remainder in the buffer.
237 if (LLVM_UNLIKELY(OutBufCur == OutBufStart)) {
238 assert(NumBytes != 0 && "undefined behavior");
239 size_t BytesToWrite = Size - (Size % NumBytes);
240 write_impl(Ptr, BytesToWrite);
241 size_t BytesRemaining = Size - BytesToWrite;
242 if (BytesRemaining > size_t(OutBufEnd - OutBufCur)) {
243 // Too much left over to copy into our buffer.
244 return write(Ptr + BytesToWrite, BytesRemaining);
246 copy_to_buffer(Ptr + BytesToWrite, BytesRemaining);
250 // We don't have enough space in the buffer to fit the string in. Insert as
251 // much as possible, flush and start over with the remainder.
252 copy_to_buffer(Ptr, NumBytes);
254 return write(Ptr + NumBytes, Size - NumBytes);
257 copy_to_buffer(Ptr, Size);
262 void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
263 assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
265 // Handle short strings specially, memcpy isn't very good at very short
268 case 4: OutBufCur[3] = Ptr[3]; LLVM_FALLTHROUGH;
269 case 3: OutBufCur[2] = Ptr[2]; LLVM_FALLTHROUGH;
270 case 2: OutBufCur[1] = Ptr[1]; LLVM_FALLTHROUGH;
271 case 1: OutBufCur[0] = Ptr[0]; LLVM_FALLTHROUGH;
274 memcpy(OutBufCur, Ptr, Size);
282 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
283 // If we have more than a few bytes left in our output buffer, try
284 // formatting directly onto its end.
285 size_t NextBufferSize = 127;
286 size_t BufferBytesLeft = OutBufEnd - OutBufCur;
287 if (BufferBytesLeft > 3) {
288 size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
290 // Common case is that we have plenty of space.
291 if (BytesUsed <= BufferBytesLeft) {
292 OutBufCur += BytesUsed;
296 // Otherwise, we overflowed and the return value tells us the size to try
298 NextBufferSize = BytesUsed;
301 // If we got here, we didn't have enough space in the output buffer for the
302 // string. Try printing into a SmallVector that is resized to have enough
303 // space. Iterate until we win.
304 SmallVector<char, 128> V;
307 V.resize(NextBufferSize);
309 // Try formatting into the SmallVector.
310 size_t BytesUsed = Fmt.print(V.data(), NextBufferSize);
312 // If BytesUsed fit into the vector, we win.
313 if (BytesUsed <= NextBufferSize)
314 return write(V.data(), BytesUsed);
316 // Otherwise, try again with a new size.
317 assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
318 NextBufferSize = BytesUsed;
322 raw_ostream &raw_ostream::operator<<(const formatv_object_base &Obj) {
328 raw_ostream &raw_ostream::operator<<(const FormattedString &FS) {
329 if (FS.Str.size() >= FS.Width || FS.Justify == FormattedString::JustifyNone) {
330 this->operator<<(FS.Str);
333 const size_t Difference = FS.Width - FS.Str.size();
334 switch (FS.Justify) {
335 case FormattedString::JustifyLeft:
336 this->operator<<(FS.Str);
337 this->indent(Difference);
339 case FormattedString::JustifyRight:
340 this->indent(Difference);
341 this->operator<<(FS.Str);
343 case FormattedString::JustifyCenter: {
344 int PadAmount = Difference / 2;
345 this->indent(PadAmount);
346 this->operator<<(FS.Str);
347 this->indent(Difference - PadAmount);
351 llvm_unreachable("Bad Justification");
356 raw_ostream &raw_ostream::operator<<(const FormattedNumber &FN) {
359 if (FN.Upper && FN.HexPrefix)
360 Style = HexPrintStyle::PrefixUpper;
361 else if (FN.Upper && !FN.HexPrefix)
362 Style = HexPrintStyle::Upper;
363 else if (!FN.Upper && FN.HexPrefix)
364 Style = HexPrintStyle::PrefixLower;
366 Style = HexPrintStyle::Lower;
367 llvm::write_hex(*this, FN.HexValue, Style, FN.Width);
369 llvm::SmallString<16> Buffer;
370 llvm::raw_svector_ostream Stream(Buffer);
371 llvm::write_integer(Stream, FN.DecValue, 0, IntegerStyle::Integer);
372 if (Buffer.size() < FN.Width)
373 indent(FN.Width - Buffer.size());
379 raw_ostream &raw_ostream::operator<<(const FormattedBytes &FB) {
380 if (FB.Bytes.empty())
383 size_t LineIndex = 0;
384 auto Bytes = FB.Bytes;
385 const size_t Size = Bytes.size();
386 HexPrintStyle HPS = FB.Upper ? HexPrintStyle::Upper : HexPrintStyle::Lower;
387 uint64_t OffsetWidth = 0;
388 if (FB.FirstByteOffset.hasValue()) {
389 // Figure out how many nibbles are needed to print the largest offset
390 // represented by this data set, so that we can align the offset field
391 // to the right width.
392 size_t Lines = Size / FB.NumPerLine;
393 uint64_t MaxOffset = *FB.FirstByteOffset + Lines * FB.NumPerLine;
396 Power = llvm::Log2_64_Ceil(MaxOffset);
397 OffsetWidth = std::max<uint64_t>(4, llvm::alignTo(Power, 4) / 4);
400 // The width of a block of data including all spaces for group separators.
401 unsigned NumByteGroups =
402 alignTo(FB.NumPerLine, FB.ByteGroupSize) / FB.ByteGroupSize;
403 unsigned BlockCharWidth = FB.NumPerLine * 2 + NumByteGroups - 1;
405 while (!Bytes.empty()) {
406 indent(FB.IndentLevel);
408 if (FB.FirstByteOffset.hasValue()) {
409 uint64_t Offset = FB.FirstByteOffset.getValue();
410 llvm::write_hex(*this, Offset + LineIndex, HPS, OffsetWidth);
414 auto Line = Bytes.take_front(FB.NumPerLine);
416 size_t CharsPrinted = 0;
417 // Print the hex bytes for this line in groups
418 for (size_t I = 0; I < Line.size(); ++I, CharsPrinted += 2) {
419 if (I && (I % FB.ByteGroupSize) == 0) {
423 llvm::write_hex(*this, Line[I], HPS, 2);
427 // Print any spaces needed for any bytes that we didn't print on this
428 // line so that the ASCII bytes are correctly aligned.
429 assert(BlockCharWidth >= CharsPrinted);
430 indent(BlockCharWidth - CharsPrinted + 2);
433 // Print the ASCII char values for each byte on this line
434 for (uint8_t Byte : Line) {
436 *this << static_cast<char>(Byte);
443 Bytes = Bytes.drop_front(Line.size());
444 LineIndex += Line.size();
445 if (LineIndex < Size)
451 /// indent - Insert 'NumSpaces' spaces.
452 raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
453 static const char Spaces[] = " "
457 // Usually the indentation is small, handle it with a fastpath.
458 if (NumSpaces < array_lengthof(Spaces))
459 return write(Spaces, NumSpaces);
462 unsigned NumToWrite = std::min(NumSpaces,
463 (unsigned)array_lengthof(Spaces)-1);
464 write(Spaces, NumToWrite);
465 NumSpaces -= NumToWrite;
470 //===----------------------------------------------------------------------===//
472 //===----------------------------------------------------------------------===//
474 // Out of line virtual method.
475 void format_object_base::home() {
478 //===----------------------------------------------------------------------===//
480 //===----------------------------------------------------------------------===//
482 static int getFD(StringRef Filename, std::error_code &EC,
483 sys::fs::OpenFlags Flags) {
484 // Handle "-" as stdout. Note that when we do this, we consider ourself
485 // the owner of stdout and may set the "binary" flag globally based on Flags.
486 if (Filename == "-") {
487 EC = std::error_code();
488 // If user requested binary then put stdout into binary mode if
490 if (!(Flags & sys::fs::F_Text))
491 sys::ChangeStdoutToBinary();
492 return STDOUT_FILENO;
496 EC = sys::fs::openFileForWrite(Filename, FD, Flags);
503 raw_fd_ostream::raw_fd_ostream(StringRef Filename, std::error_code &EC,
504 sys::fs::OpenFlags Flags)
505 : raw_fd_ostream(getFD(Filename, EC, Flags), true) {}
507 /// FD is the file descriptor that this writes to. If ShouldClose is true, this
508 /// closes the file when the stream is destroyed.
509 raw_fd_ostream::raw_fd_ostream(int fd, bool shouldClose, bool unbuffered)
510 : raw_pwrite_stream(unbuffered), FD(fd), ShouldClose(shouldClose),
516 // We do not want to close STDOUT as there may have been several uses of it
517 // such as the case: llc %s -o=- -pass-remarks-output=- -filetype=asm
518 // which cause multiple closes of STDOUT_FILENO and/or use-after-close of it.
519 // Using dup() in getFD doesn't work as we end up with original STDOUT_FILENO
521 if (FD <= STDERR_FILENO)
524 // Get the starting position.
525 off_t loc = ::lseek(FD, 0, SEEK_CUR);
527 // MSVCRT's _lseek(SEEK_CUR) doesn't return -1 for pipes.
528 sys::fs::file_status Status;
529 std::error_code EC = status(FD, Status);
530 SupportsSeeking = !EC && Status.type() == sys::fs::file_type::regular_file;
532 SupportsSeeking = loc != (off_t)-1;
534 if (!SupportsSeeking)
537 pos = static_cast<uint64_t>(loc);
540 raw_fd_ostream::~raw_fd_ostream() {
543 if (ShouldClose && sys::Process::SafelyCloseFileDescriptor(FD))
548 // On mingw, global dtors should not call exit().
549 // report_fatal_error() invokes exit(). We know report_fatal_error()
550 // might not write messages to stderr when any errors were detected
555 // If there are any pending errors, report them now. Clients wishing
556 // to avoid report_fatal_error calls should check for errors with
557 // has_error() and clear the error flag with clear_error() before
558 // destructing raw_ostream objects which may have errors.
560 report_fatal_error("IO failure on output stream.", /*GenCrashDiag=*/false);
563 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
564 assert(FD >= 0 && "File already closed.");
567 #ifndef LLVM_ON_WIN32
568 #if defined(__linux__)
569 bool ShouldWriteInChunks = true;
571 bool ShouldWriteInChunks = false;
574 // Writing a large size of output to Windows console returns ENOMEM. It seems
575 // that, prior to Windows 8, WriteFile() is redirecting to WriteConsole(), and
576 // the latter has a size limit (66000 bytes or less, depending on heap usage).
577 bool ShouldWriteInChunks = !!::_isatty(FD) && !RunningWindows8OrGreater();
581 size_t ChunkSize = Size;
582 if (ChunkSize > 32767 && ShouldWriteInChunks)
585 ssize_t ret = ::write(FD, Ptr, ChunkSize);
588 // If it's a recoverable error, swallow it and retry the write.
590 // Ideally we wouldn't ever see EAGAIN or EWOULDBLOCK here, since
591 // raw_ostream isn't designed to do non-blocking I/O. However, some
592 // programs, such as old versions of bjam, have mistakenly used
593 // O_NONBLOCK. For compatibility, emulate blocking semantics by
594 // spinning until the write succeeds. If you don't want spinning,
595 // don't use O_NONBLOCK file descriptors with raw_ostream.
596 if (errno == EINTR || errno == EAGAIN
598 || errno == EWOULDBLOCK
603 // Otherwise it's a non-recoverable error. Note it and quit.
608 // The write may have written some or all of the data. Update the
609 // size and buffer pointer to reflect the remainder that needs
610 // to be written. If there are no bytes left, we're done.
616 void raw_fd_ostream::close() {
620 if (sys::Process::SafelyCloseFileDescriptor(FD))
625 uint64_t raw_fd_ostream::seek(uint64_t off) {
626 assert(SupportsSeeking && "Stream does not support seeking!");
629 pos = ::_lseeki64(FD, off, SEEK_SET);
630 #elif defined(HAVE_LSEEK64)
631 pos = ::lseek64(FD, off, SEEK_SET);
633 pos = ::lseek(FD, off, SEEK_SET);
635 if (pos == (uint64_t)-1)
640 void raw_fd_ostream::pwrite_impl(const char *Ptr, size_t Size,
642 uint64_t Pos = tell();
648 size_t raw_fd_ostream::preferred_buffer_size() const {
649 #if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(__minix)
650 // Windows and Minix have no st_blksize.
651 assert(FD >= 0 && "File not yet open!");
653 if (fstat(FD, &statbuf) != 0)
656 // If this is a terminal, don't use buffering. Line buffering
657 // would be a more traditional thing to do, but it's not worth
659 if (S_ISCHR(statbuf.st_mode) && isatty(FD))
661 // Return the preferred block size.
662 return statbuf.st_blksize;
664 return raw_ostream::preferred_buffer_size();
668 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
670 if (sys::Process::ColorNeedsFlush())
672 const char *colorcode =
673 (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
674 : sys::Process::OutputColor(colors, bold, bg);
676 size_t len = strlen(colorcode);
677 write(colorcode, len);
678 // don't account colors towards output characters
684 raw_ostream &raw_fd_ostream::resetColor() {
685 if (sys::Process::ColorNeedsFlush())
687 const char *colorcode = sys::Process::ResetColor();
689 size_t len = strlen(colorcode);
690 write(colorcode, len);
691 // don't account colors towards output characters
697 raw_ostream &raw_fd_ostream::reverseColor() {
698 if (sys::Process::ColorNeedsFlush())
700 const char *colorcode = sys::Process::OutputReverse();
702 size_t len = strlen(colorcode);
703 write(colorcode, len);
704 // don't account colors towards output characters
710 bool raw_fd_ostream::is_displayed() const {
711 return sys::Process::FileDescriptorIsDisplayed(FD);
714 bool raw_fd_ostream::has_colors() const {
715 return sys::Process::FileDescriptorHasColors(FD);
718 //===----------------------------------------------------------------------===//
719 // outs(), errs(), nulls()
720 //===----------------------------------------------------------------------===//
722 /// outs() - This returns a reference to a raw_ostream for standard output.
723 /// Use it like: outs() << "foo" << "bar";
724 raw_ostream &llvm::outs() {
725 // Set buffer settings to model stdout behavior. Delete the file descriptor
726 // when the program exits, forcing error detection. This means that if you
727 // ever call outs(), you can't open another raw_fd_ostream on stdout, as we'll
728 // close stdout twice and print an error the second time.
730 static raw_fd_ostream S("-", EC, sys::fs::F_None);
735 /// errs() - This returns a reference to a raw_ostream for standard error.
736 /// Use it like: errs() << "foo" << "bar";
737 raw_ostream &llvm::errs() {
738 // Set standard error to be unbuffered by default.
739 static raw_fd_ostream S(STDERR_FILENO, false, true);
743 /// nulls() - This returns a reference to a raw_ostream which discards output.
744 raw_ostream &llvm::nulls() {
745 static raw_null_ostream S;
749 //===----------------------------------------------------------------------===//
750 // raw_string_ostream
751 //===----------------------------------------------------------------------===//
753 raw_string_ostream::~raw_string_ostream() {
757 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
758 OS.append(Ptr, Size);
761 //===----------------------------------------------------------------------===//
762 // raw_svector_ostream
763 //===----------------------------------------------------------------------===//
765 uint64_t raw_svector_ostream::current_pos() const { return OS.size(); }
767 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
768 OS.append(Ptr, Ptr + Size);
771 void raw_svector_ostream::pwrite_impl(const char *Ptr, size_t Size,
773 memcpy(OS.data() + Offset, Ptr, Size);
776 //===----------------------------------------------------------------------===//
778 //===----------------------------------------------------------------------===//
780 raw_null_ostream::~raw_null_ostream() {
782 // ~raw_ostream asserts that the buffer is empty. This isn't necessary
783 // with raw_null_ostream, but it's better to have raw_null_ostream follow
784 // the rules than to change the rules just for raw_null_ostream.
789 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
792 uint64_t raw_null_ostream::current_pos() const {
796 void raw_null_ostream::pwrite_impl(const char *Ptr, size_t Size,