blob: 9acc0d8e46d5ac2c6847878f736cf938ee117750 [file] [log] [blame]
Chris Lattner84b94f72008-08-17 01:35:29 +00001//===--- 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"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ADT/STLExtras.h"
Chris Lattner22b52c92008-08-23 19:23:10 +000016#include "llvm/ADT/SmallVector.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000017#include "llvm/ADT/StringExtras.h"
Chris Lattnerd564f292008-08-22 15:45:00 +000018#include "llvm/Config/config.h"
Daniel Dunbar437b8a52009-03-17 21:15:18 +000019#include "llvm/Support/Compiler.h"
Daniel Dunbardcb50b92009-07-15 08:11:46 +000020#include "llvm/Support/ErrorHandling.h"
Rafael Espindola6d354812013-07-16 19:44:17 +000021#include "llvm/Support/FileSystem.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000022#include "llvm/Support/Format.h"
Nick Kledzike6480372014-09-25 20:30:58 +000023#include "llvm/Support/MathExtras.h"
Zachary Turner733be512016-10-11 19:24:45 +000024#include "llvm/Support/NativeFormatting.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000025#include "llvm/Support/Process.h"
26#include "llvm/Support/Program.h"
Eugene Zelenko33d7b762016-08-23 17:14:32 +000027#include <algorithm>
Benjamin Krameref14f802010-01-29 15:19:06 +000028#include <cctype>
Benjamin Kramerce84a252010-05-05 15:17:47 +000029#include <cerrno>
Eugene Zelenko33d7b762016-08-23 17:14:32 +000030#include <cstdio>
31#include <iterator>
Eugene Zelenko33d7b762016-08-23 17:14:32 +000032#include <sys/stat.h>
Zachary Turner733be512016-10-11 19:24:45 +000033#include <system_error>
Chris Lattner84b94f72008-08-17 01:35:29 +000034
NAKAMURA Takumi212c80a2013-07-17 02:21:10 +000035// <fcntl.h> may provide O_BINARY.
36#if defined(HAVE_FCNTL_H)
37# include <fcntl.h>
38#endif
39
Chris Lattnerd564f292008-08-22 15:45:00 +000040#if defined(HAVE_UNISTD_H)
41# include <unistd.h>
42#endif
Daniel Dunbar4fed8872011-02-03 03:32:32 +000043#if defined(HAVE_SYS_UIO_H) && defined(HAVE_WRITEV)
44# include <sys/uio.h>
45#endif
Argyrios Kyrtzidisb97ff822008-08-17 09:25:21 +000046
NAKAMURA Takumife84f392010-10-19 01:21:55 +000047#if defined(__CYGWIN__)
48#include <io.h>
49#endif
50
Argyrios Kyrtzidisb97ff822008-08-17 09:25:21 +000051#if defined(_MSC_VER)
Chris Lattner84b94f72008-08-17 01:35:29 +000052#include <io.h>
Owen Anderson93719642008-08-21 00:14:44 +000053#ifndef STDIN_FILENO
54# define STDIN_FILENO 0
55#endif
56#ifndef STDOUT_FILENO
57# define STDOUT_FILENO 1
58#endif
59#ifndef STDERR_FILENO
60# define STDERR_FILENO 2
61#endif
Chris Lattner84b94f72008-08-17 01:35:29 +000062#endif
63
Yunzhong Gaofb2a9c42016-01-06 00:50:06 +000064#ifdef LLVM_ON_WIN32
65#include "Windows/WindowsSupport.h"
66#endif
67
Chris Lattnerd564f292008-08-22 15:45:00 +000068using namespace llvm;
69
Dan Gohman58fcef92009-07-15 23:25:33 +000070raw_ostream::~raw_ostream() {
Dan Gohman1b763292009-07-27 20:49:44 +000071 // raw_ostream's subclasses should take care to flush the buffer
72 // in their destructors.
73 assert(OutBufCur == OutBufStart &&
74 "raw_ostream destructor called with non-empty buffer!");
75
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000076 if (BufferMode == InternalBuffer)
77 delete [] OutBufStart;
Dan Gohman58fcef92009-07-15 23:25:33 +000078}
Chris Lattnerd564f292008-08-22 15:45:00 +000079
Chris Lattner84b94f72008-08-17 01:35:29 +000080// An out of line virtual method to provide a home for the class vtable.
81void raw_ostream::handle() {}
82
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +000083size_t raw_ostream::preferred_buffer_size() const {
Dan Gohman84487b92009-08-13 17:27:29 +000084 // BUFSIZ is intended to be a reasonable default.
85 return BUFSIZ;
86}
87
88void raw_ostream::SetBuffered() {
89 // Ask the subclass to determine an appropriate buffer size.
Dan Gohman17710222009-08-15 02:05:19 +000090 if (size_t Size = preferred_buffer_size())
91 SetBufferSize(Size);
92 else
93 // It may return 0, meaning this stream should be unbuffered.
94 SetUnbuffered();
Dan Gohman84487b92009-08-13 17:27:29 +000095}
96
Dan Gohmanb452d4e2010-03-24 19:38:02 +000097void raw_ostream::SetBufferAndMode(char *BufferStart, size_t Size,
Nick Lewycky7bfd86d2011-08-28 03:30:02 +000098 BufferKind Mode) {
Craig Topper2617dcc2014-04-15 06:32:26 +000099 assert(((Mode == Unbuffered && !BufferStart && Size == 0) ||
100 (Mode != Unbuffered && BufferStart && Size != 0)) &&
Daniel Dunbar316b4a02009-09-15 20:31:46 +0000101 "stream must be unbuffered or have at least one byte");
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000102 // Make sure the current buffer is free of content (we can't flush here; the
103 // child buffer management logic will be in write_impl).
104 assert(GetNumBytesInBuffer() == 0 && "Current buffer is non-empty!");
Dan Gohman54401d42009-08-13 15:58:55 +0000105
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000106 if (BufferMode == InternalBuffer)
107 delete [] OutBufStart;
108 OutBufStart = BufferStart;
Dan Gohman54401d42009-08-13 15:58:55 +0000109 OutBufEnd = OutBufStart+Size;
110 OutBufCur = OutBufStart;
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000111 BufferMode = Mode;
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000112
113 assert(OutBufStart <= OutBufEnd && "Invalid size!");
Dan Gohman54401d42009-08-13 15:58:55 +0000114}
115
Owen Andersond2850532008-08-21 20:58:52 +0000116raw_ostream &raw_ostream::operator<<(unsigned long N) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000117 write_integer(*this, static_cast<uint64_t>(N), IntegerStyle::Integer);
Zachary Turner733be512016-10-11 19:24:45 +0000118 return *this;
Owen Andersond2850532008-08-21 20:58:52 +0000119}
120
121raw_ostream &raw_ostream::operator<<(long N) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000122 write_integer(*this, static_cast<int64_t>(N), IntegerStyle::Integer);
Zachary Turner733be512016-10-11 19:24:45 +0000123 return *this;
Owen Andersond2850532008-08-21 20:58:52 +0000124}
125
126raw_ostream &raw_ostream::operator<<(unsigned long long N) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000127 write_integer(*this, static_cast<uint64_t>(N), IntegerStyle::Integer);
Zachary Turner733be512016-10-11 19:24:45 +0000128 return *this;
Owen Andersond2850532008-08-21 20:58:52 +0000129}
130
131raw_ostream &raw_ostream::operator<<(long long N) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000132 write_integer(*this, static_cast<int64_t>(N), IntegerStyle::Integer);
Zachary Turner733be512016-10-11 19:24:45 +0000133 return *this;
Owen Andersond2850532008-08-21 20:58:52 +0000134}
135
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000136raw_ostream &raw_ostream::write_hex(unsigned long long N) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000137 llvm::write_hex(*this, N, HexPrintStyle::Lower);
Zachary Turner733be512016-10-11 19:24:45 +0000138 return *this;
Chris Lattner0c19df42008-08-23 22:23:09 +0000139}
140
Daniel Dunbar65dc8912010-11-27 07:59:50 +0000141raw_ostream &raw_ostream::write_escaped(StringRef Str,
142 bool UseHexEscapes) {
Craig Topper775fb732016-02-04 06:51:41 +0000143 for (unsigned char c : Str) {
Daniel Dunbar4108c432009-10-17 20:43:08 +0000144 switch (c) {
145 case '\\':
146 *this << '\\' << '\\';
147 break;
148 case '\t':
149 *this << '\\' << 't';
150 break;
151 case '\n':
152 *this << '\\' << 'n';
153 break;
154 case '"':
155 *this << '\\' << '"';
156 break;
157 default:
158 if (std::isprint(c)) {
159 *this << c;
160 break;
161 }
162
Daniel Dunbar65dc8912010-11-27 07:59:50 +0000163 // Write out the escaped representation.
164 if (UseHexEscapes) {
165 *this << '\\' << 'x';
166 *this << hexdigit((c >> 4 & 0xF));
167 *this << hexdigit((c >> 0) & 0xF);
168 } else {
169 // Always use a full 3-character octal escape.
170 *this << '\\';
171 *this << char('0' + ((c >> 6) & 7));
172 *this << char('0' + ((c >> 3) & 7));
173 *this << char('0' + ((c >> 0) & 7));
174 }
Daniel Dunbar4108c432009-10-17 20:43:08 +0000175 }
176 }
177
178 return *this;
179}
180
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000181raw_ostream &raw_ostream::operator<<(const void *P) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000182 llvm::write_hex(*this, (uintptr_t)P, HexPrintStyle::PrefixLower);
Zachary Turner733be512016-10-11 19:24:45 +0000183 return *this;
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000184}
185
Chris Lattner06fa1762009-08-24 03:52:50 +0000186raw_ostream &raw_ostream::operator<<(double N) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000187 llvm::write_double(*this, N, FloatStyle::Exponent);
Zachary Turner733be512016-10-11 19:24:45 +0000188 return *this;
Chris Lattner06fa1762009-08-24 03:52:50 +0000189}
190
Daniel Dunbard24535f2009-03-16 22:55:06 +0000191void raw_ostream::flush_nonempty() {
192 assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000193 size_t Length = OutBufCur - OutBufStart;
194 OutBufCur = OutBufStart;
195 write_impl(OutBufStart, Length);
Daniel Dunbard24535f2009-03-16 22:55:06 +0000196}
197
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000198raw_ostream &raw_ostream::write(unsigned char C) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000199 // Group exceptional cases into a single branch.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000200 if (LLVM_UNLIKELY(OutBufCur >= OutBufEnd)) {
201 if (LLVM_UNLIKELY(!OutBufStart)) {
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000202 if (BufferMode == Unbuffered) {
Dan Gohman23f90c12009-08-18 20:09:59 +0000203 write_impl(reinterpret_cast<char*>(&C), 1);
204 return *this;
205 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000206 // Set up a buffer and start over.
207 SetBuffered();
208 return write(C);
Dan Gohman23f90c12009-08-18 20:09:59 +0000209 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000210
211 flush_nonempty();
Daniel Dunbar2d603da2009-03-17 01:13:35 +0000212 }
213
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000214 *OutBufCur++ = C;
Daniel Dunbar87862182009-03-16 22:08:44 +0000215 return *this;
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000216}
Chris Lattner0c19df42008-08-23 22:23:09 +0000217
Dan Gohmanf199ad62009-07-16 15:24:40 +0000218raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000219 // Group exceptional cases into a single branch.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000220 if (LLVM_UNLIKELY(size_t(OutBufEnd - OutBufCur) < Size)) {
221 if (LLVM_UNLIKELY(!OutBufStart)) {
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000222 if (BufferMode == Unbuffered) {
Dan Gohman52022c22009-08-13 15:44:52 +0000223 write_impl(Ptr, Size);
224 return *this;
225 }
226 // Set up a buffer and start over.
Dan Gohman84487b92009-08-13 17:27:29 +0000227 SetBuffered();
Dan Gohman52022c22009-08-13 15:44:52 +0000228 return write(Ptr, Size);
229 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000230
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000231 size_t NumBytes = OutBufEnd - OutBufCur;
232
Benjamin Krameracf08422011-03-04 18:18:16 +0000233 // If the buffer is empty at this point we have a string that is larger
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000234 // than the buffer. Directly write the chunk that is a multiple of the
235 // preferred buffer size and put the remainder in the buffer.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000236 if (LLVM_UNLIKELY(OutBufCur == OutBufStart)) {
Michael Ilseman5be22a12014-12-12 21:48:03 +0000237 assert(NumBytes != 0 && "undefined behavior");
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000238 size_t BytesToWrite = Size - (Size % NumBytes);
239 write_impl(Ptr, BytesToWrite);
Matt Beaumont-Gaya182be82013-03-12 23:55:24 +0000240 size_t BytesRemaining = Size - BytesToWrite;
241 if (BytesRemaining > size_t(OutBufEnd - OutBufCur)) {
242 // Too much left over to copy into our buffer.
243 return write(Ptr + BytesToWrite, BytesRemaining);
244 }
245 copy_to_buffer(Ptr + BytesToWrite, BytesRemaining);
Benjamin Krameracf08422011-03-04 18:18:16 +0000246 return *this;
247 }
248
249 // We don't have enough space in the buffer to fit the string in. Insert as
250 // much as possible, flush and start over with the remainder.
Benjamin Krameracf08422011-03-04 18:18:16 +0000251 copy_to_buffer(Ptr, NumBytes);
252 flush_nonempty();
253 return write(Ptr + NumBytes, Size - NumBytes);
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000254 }
Dan Gohman52022c22009-08-13 15:44:52 +0000255
256 copy_to_buffer(Ptr, Size);
257
258 return *this;
259}
260
261void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
Dan Gohmanc04a00a2009-08-13 20:32:03 +0000262 assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
Dan Gohman98205552009-08-13 18:38:15 +0000263
Owen Andersond2850532008-08-21 20:58:52 +0000264 // Handle short strings specially, memcpy isn't very good at very short
265 // strings.
266 switch (Size) {
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000267 case 4: OutBufCur[3] = Ptr[3]; LLVM_FALLTHROUGH;
268 case 3: OutBufCur[2] = Ptr[2]; LLVM_FALLTHROUGH;
269 case 2: OutBufCur[1] = Ptr[1]; LLVM_FALLTHROUGH;
270 case 1: OutBufCur[0] = Ptr[0]; LLVM_FALLTHROUGH;
Owen Andersond2850532008-08-21 20:58:52 +0000271 case 0: break;
272 default:
Dan Gohman52022c22009-08-13 15:44:52 +0000273 memcpy(OutBufCur, Ptr, Size);
Owen Andersond2850532008-08-21 20:58:52 +0000274 break;
275 }
Daniel Dunbar3da6a702009-03-10 16:21:55 +0000276
Dan Gohman52022c22009-08-13 15:44:52 +0000277 OutBufCur += Size;
Owen Andersond2850532008-08-21 20:58:52 +0000278}
279
Chris Lattner22b52c92008-08-23 19:23:10 +0000280// Formatted output.
281raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000282 // If we have more than a few bytes left in our output buffer, try
283 // formatting directly onto its end.
Dan Gohmanf199ad62009-07-16 15:24:40 +0000284 size_t NextBufferSize = 127;
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000285 size_t BufferBytesLeft = OutBufEnd - OutBufCur;
286 if (BufferBytesLeft > 3) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000287 size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000288
Chris Lattner22b52c92008-08-23 19:23:10 +0000289 // Common case is that we have plenty of space.
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000290 if (BytesUsed <= BufferBytesLeft) {
Chris Lattner22b52c92008-08-23 19:23:10 +0000291 OutBufCur += BytesUsed;
292 return *this;
293 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000294
Chris Lattner22b52c92008-08-23 19:23:10 +0000295 // Otherwise, we overflowed and the return value tells us the size to try
296 // again with.
297 NextBufferSize = BytesUsed;
298 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000299
Chris Lattner22b52c92008-08-23 19:23:10 +0000300 // If we got here, we didn't have enough space in the output buffer for the
301 // string. Try printing into a SmallVector that is resized to have enough
302 // space. Iterate until we win.
303 SmallVector<char, 128> V;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000304
Eugene Zelenko33d7b762016-08-23 17:14:32 +0000305 while (true) {
Chris Lattner22b52c92008-08-23 19:23:10 +0000306 V.resize(NextBufferSize);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000307
Chris Lattner22b52c92008-08-23 19:23:10 +0000308 // Try formatting into the SmallVector.
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000309 size_t BytesUsed = Fmt.print(V.data(), NextBufferSize);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000310
Chris Lattner22b52c92008-08-23 19:23:10 +0000311 // If BytesUsed fit into the vector, we win.
Chris Lattner2bfc72e2008-10-26 19:20:47 +0000312 if (BytesUsed <= NextBufferSize)
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000313 return write(V.data(), BytesUsed);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000314
Chris Lattner22b52c92008-08-23 19:23:10 +0000315 // Otherwise, try again with a new size.
316 assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
317 NextBufferSize = BytesUsed;
318 }
319}
320
Nick Kledzike6480372014-09-25 20:30:58 +0000321raw_ostream &raw_ostream::operator<<(const FormattedString &FS) {
322 unsigned Len = FS.Str.size();
323 int PadAmount = FS.Width - Len;
324 if (FS.RightJustify && (PadAmount > 0))
325 this->indent(PadAmount);
326 this->operator<<(FS.Str);
327 if (!FS.RightJustify && (PadAmount > 0))
328 this->indent(PadAmount);
329 return *this;
330}
331
332raw_ostream &raw_ostream::operator<<(const FormattedNumber &FN) {
333 if (FN.Hex) {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000334 HexPrintStyle Style;
335 if (FN.Upper && FN.HexPrefix)
336 Style = HexPrintStyle::PrefixUpper;
337 else if (FN.Upper && !FN.HexPrefix)
338 Style = HexPrintStyle::Upper;
339 else if (!FN.Upper && FN.HexPrefix)
340 Style = HexPrintStyle::PrefixLower;
341 else
342 Style = HexPrintStyle::Lower;
343 llvm::write_hex(*this, FN.HexValue, Style, FN.Width);
Nick Kledzike6480372014-09-25 20:30:58 +0000344 } else {
Zachary Turner5b2243e2016-10-29 00:27:22 +0000345 llvm::SmallString<16> Buffer;
346 llvm::raw_svector_ostream Stream(Buffer);
347 llvm::write_integer(Stream, FN.DecValue, IntegerStyle::Integer);
348 if (Buffer.size() < FN.Width)
349 indent(FN.Width - Buffer.size());
350 (*this) << Buffer;
Nick Kledzike6480372014-09-25 20:30:58 +0000351 }
Zachary Turner733be512016-10-11 19:24:45 +0000352 return *this;
Nick Kledzike6480372014-09-25 20:30:58 +0000353}
354
Zachary Turner4a86af02016-11-10 20:16:45 +0000355raw_ostream &raw_ostream::operator<<(const FormattedBytes &FB) {
356 if (FB.Bytes.empty())
357 return *this;
358
Greg Claytonbde0a162016-11-09 00:15:54 +0000359 size_t LineIndex = 0;
Zachary Turner4a86af02016-11-10 20:16:45 +0000360 auto Bytes = FB.Bytes;
361 const size_t Size = Bytes.size();
362 HexPrintStyle HPS = FB.Upper ? HexPrintStyle::Upper : HexPrintStyle::Lower;
363 uint64_t OffsetWidth = 0;
364 if (FB.FirstByteOffset.hasValue()) {
365 // Figure out how many nibbles are needed to print the largest offset
366 // represented by this data set, so that we can align the offset field
367 // to the right width.
368 size_t Lines = Size / FB.NumPerLine;
369 uint64_t MaxOffset = *FB.FirstByteOffset + Lines * FB.NumPerLine;
370 unsigned Power = 0;
371 if (MaxOffset > 0)
372 Power = llvm::Log2_64_Ceil(MaxOffset);
373 OffsetWidth = std::max(4ULL, llvm::alignTo(Power, 4) / 4);
374 }
375
376 // The width of a block of data including all spaces for group separators.
377 unsigned NumByteGroups =
378 alignTo(FB.NumPerLine, FB.ByteGroupSize) / FB.ByteGroupSize;
379 unsigned BlockCharWidth = FB.NumPerLine * 2 + NumByteGroups - 1;
380
381 while (!Bytes.empty()) {
382 indent(FB.IndentLevel);
383
Greg Claytonbde0a162016-11-09 00:15:54 +0000384 if (FB.FirstByteOffset.hasValue()) {
385 uint64_t Offset = FB.FirstByteOffset.getValue();
Zachary Turner4a86af02016-11-10 20:16:45 +0000386 llvm::write_hex(*this, Offset + LineIndex, HPS, OffsetWidth);
Greg Claytonbde0a162016-11-09 00:15:54 +0000387 *this << ": ";
388 }
Zachary Turner4a86af02016-11-10 20:16:45 +0000389
390 auto Line = Bytes.take_front(FB.NumPerLine);
391
392 size_t CharsPrinted = 0;
393 // Print the hex bytes for this line in groups
394 for (size_t I = 0; I < Line.size(); ++I, CharsPrinted += 2) {
395 if (I && (I % FB.ByteGroupSize) == 0) {
396 ++CharsPrinted;
Greg Claytonbde0a162016-11-09 00:15:54 +0000397 *this << " ";
Zachary Turner4a86af02016-11-10 20:16:45 +0000398 }
399 llvm::write_hex(*this, Line[I], HPS, 2);
Greg Claytonbde0a162016-11-09 00:15:54 +0000400 }
Zachary Turner4a86af02016-11-10 20:16:45 +0000401
Greg Claytonbde0a162016-11-09 00:15:54 +0000402 if (FB.ASCII) {
403 // Print any spaces needed for any bytes that we didn't print on this
404 // line so that the ASCII bytes are correctly aligned.
Zachary Turner4a86af02016-11-10 20:16:45 +0000405 assert(BlockCharWidth >= CharsPrinted);
406 indent(BlockCharWidth - CharsPrinted + 2);
407 *this << "|";
408
Greg Claytonbde0a162016-11-09 00:15:54 +0000409 // Print the ASCII char values for each byte on this line
Zachary Turner4a86af02016-11-10 20:16:45 +0000410 for (uint8_t Byte : Line) {
411 if (isprint(Byte))
412 *this << static_cast<char>(Byte);
Greg Claytonbde0a162016-11-09 00:15:54 +0000413 else
414 *this << '.';
415 }
416 *this << '|';
417 }
Zachary Turner4a86af02016-11-10 20:16:45 +0000418
419 Bytes = Bytes.drop_front(Line.size());
420 LineIndex += Line.size();
Greg Claytonbde0a162016-11-09 00:15:54 +0000421 if (LineIndex < Size)
422 *this << '\n';
423 }
424 return *this;
425}
426
Chris Lattnere6db2c32009-08-22 23:10:29 +0000427/// indent - Insert 'NumSpaces' spaces.
428raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
Dan Gohmanf88f52e2009-08-24 04:13:01 +0000429 static const char Spaces[] = " "
430 " "
431 " ";
Chris Lattnere6db2c32009-08-22 23:10:29 +0000432
433 // Usually the indentation is small, handle it with a fastpath.
Dan Gohmanc9fa0512009-08-24 04:43:38 +0000434 if (NumSpaces < array_lengthof(Spaces))
Chris Lattnere6db2c32009-08-22 23:10:29 +0000435 return write(Spaces, NumSpaces);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000436
Chris Lattnere6db2c32009-08-22 23:10:29 +0000437 while (NumSpaces) {
Dan Gohmanc9fa0512009-08-24 04:43:38 +0000438 unsigned NumToWrite = std::min(NumSpaces,
439 (unsigned)array_lengthof(Spaces)-1);
Chris Lattnere6db2c32009-08-22 23:10:29 +0000440 write(Spaces, NumToWrite);
441 NumSpaces -= NumToWrite;
442 }
443 return *this;
444}
445
Chris Lattner22b52c92008-08-23 19:23:10 +0000446//===----------------------------------------------------------------------===//
447// Formatted Output
448//===----------------------------------------------------------------------===//
449
450// Out of line virtual method.
451void format_object_base::home() {
452}
453
Chris Lattner84b94f72008-08-17 01:35:29 +0000454//===----------------------------------------------------------------------===//
455// raw_fd_ostream
456//===----------------------------------------------------------------------===//
457
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000458static int getFD(StringRef Filename, std::error_code &EC,
459 sys::fs::OpenFlags Flags) {
Dan Gohmanc825cee2010-08-18 22:26:19 +0000460 // Handle "-" as stdout. Note that when we do this, we consider ourself
461 // the owner of stdout. This means that we can do things like close the
462 // file descriptor when we're done and set the "binary" flag globally.
Rafael Espindola3fd1e992014-08-25 18:16:47 +0000463 if (Filename == "-") {
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000464 EC = std::error_code();
Daniel Dunbared90e702008-11-13 05:01:07 +0000465 // If user requested binary then put stdout into binary mode if
466 // possible.
Rafael Espindola90c7f1c2014-02-24 18:20:12 +0000467 if (!(Flags & sys::fs::F_Text))
Rafael Espindolacb2eca02013-06-12 20:58:35 +0000468 sys::ChangeStdoutToBinary();
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000469 return STDOUT_FILENO;
Chris Lattnerd5bc0682008-08-17 03:53:23 +0000470 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000471
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000472 int FD;
Rafael Espindola3fd1e992014-08-25 18:16:47 +0000473 EC = sys::fs::openFileForWrite(Filename, FD, Flags);
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000474 if (EC)
475 return -1;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000476
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000477 return FD;
Chris Lattner84b94f72008-08-17 01:35:29 +0000478}
479
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000480raw_fd_ostream::raw_fd_ostream(StringRef Filename, std::error_code &EC,
481 sys::fs::OpenFlags Flags)
482 : raw_fd_ostream(getFD(Filename, EC, Flags), true) {}
483
Rafael Espindola62e6ec02015-04-09 16:59:07 +0000484/// FD is the file descriptor that this writes to. If ShouldClose is true, this
485/// closes the file when the stream is destroyed.
Francois Picheta3037c32010-10-14 20:30:58 +0000486raw_fd_ostream::raw_fd_ostream(int fd, bool shouldClose, bool unbuffered)
Rafael Espindola37b70152015-04-14 15:00:34 +0000487 : raw_pwrite_stream(unbuffered), FD(fd), ShouldClose(shouldClose),
Rafael Espindola3f210fc2015-12-16 22:59:06 +0000488 Error(false) {
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000489 if (FD < 0 ) {
490 ShouldClose = false;
491 return;
492 }
Michael J. Spencerb7479902011-01-17 15:53:12 +0000493
494 // Get the starting position.
495 off_t loc = ::lseek(FD, 0, SEEK_CUR);
Rafael Espindolaa9b84ab2015-04-13 11:09:48 +0000496#ifdef LLVM_ON_WIN32
497 // MSVCRT's _lseek(SEEK_CUR) doesn't return -1 for pipes.
498 sys::fs::file_status Status;
499 std::error_code EC = status(FD, Status);
500 SupportsSeeking = !EC && Status.type() == sys::fs::file_type::regular_file;
501#else
Rafael Espindola74d2f612015-04-10 18:15:51 +0000502 SupportsSeeking = loc != (off_t)-1;
Rafael Espindolaa9b84ab2015-04-13 11:09:48 +0000503#endif
Rafael Espindola74d2f612015-04-10 18:15:51 +0000504 if (!SupportsSeeking)
Michael J. Spencerb7479902011-01-17 15:53:12 +0000505 pos = 0;
506 else
507 pos = static_cast<uint64_t>(loc);
Francois Picheta3037c32010-10-14 20:30:58 +0000508}
509
Chris Lattner84b94f72008-08-17 01:35:29 +0000510raw_fd_ostream::~raw_fd_ostream() {
Dan Gohman38adfdd2010-08-20 16:34:20 +0000511 if (FD >= 0) {
512 flush();
David Majnemer51c2afc2014-10-07 05:48:40 +0000513 if (ShouldClose && sys::Process::SafelyCloseFileDescriptor(FD))
514 error_detected();
Dan Gohman38adfdd2010-08-20 16:34:20 +0000515 }
516
NAKAMURA Takumi76e68ea2011-03-16 02:53:39 +0000517#ifdef __MINGW32__
518 // On mingw, global dtors should not call exit().
519 // report_fatal_error() invokes exit(). We know report_fatal_error()
520 // might not write messages to stderr when any errors were detected
521 // on FD == 2.
522 if (FD == 2) return;
523#endif
524
Dan Gohman38adfdd2010-08-20 16:34:20 +0000525 // If there are any pending errors, report them now. Clients wishing
526 // to avoid report_fatal_error calls should check for errors with
527 // has_error() and clear the error flag with clear_error() before
528 // destructing raw_ostream objects which may have errors.
529 if (has_error())
Chad Rosier7ce810c2013-03-27 18:30:00 +0000530 report_fatal_error("IO failure on output stream.", /*GenCrashDiag=*/false);
Chris Lattnerce3b2c32010-08-17 23:11:56 +0000531}
Chris Lattner9e6f1f12009-08-23 02:51:22 +0000532
Dan Gohmanf199ad62009-07-16 15:24:40 +0000533void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000534 assert(FD >= 0 && "File already closed.");
Daniel Dunbardb7a36c2009-03-16 23:29:31 +0000535 pos += Size;
Dan Gohmanef969f32010-05-06 01:27:36 +0000536
Yunzhong Gaofb2a9c42016-01-06 00:50:06 +0000537#ifndef LLVM_ON_WIN32
538 bool ShouldWriteInChunks = false;
539#else
540 // Writing a large size of output to Windows console returns ENOMEM. It seems
541 // that, prior to Windows 8, WriteFile() is redirecting to WriteConsole(), and
542 // the latter has a size limit (66000 bytes or less, depending on heap usage).
Reid Kleckner5fb7a582016-01-11 23:33:03 +0000543 bool ShouldWriteInChunks = !!::_isatty(FD) && !RunningWindows8OrGreater();
Yunzhong Gaofb2a9c42016-01-06 00:50:06 +0000544#endif
545
Benjamin Kramerce84a252010-05-05 15:17:47 +0000546 do {
Yunzhong Gaofb2a9c42016-01-06 00:50:06 +0000547 size_t ChunkSize = Size;
548 if (ChunkSize > 32767 && ShouldWriteInChunks)
549 ChunkSize = 32767;
550
551 ssize_t ret = ::write(FD, Ptr, ChunkSize);
Dan Gohmanef969f32010-05-06 01:27:36 +0000552
553 if (ret < 0) {
554 // If it's a recoverable error, swallow it and retry the write.
Dan Gohmandea53102010-05-18 15:25:14 +0000555 //
556 // Ideally we wouldn't ever see EAGAIN or EWOULDBLOCK here, since
557 // raw_ostream isn't designed to do non-blocking I/O. However, some
558 // programs, such as old versions of bjam, have mistakenly used
559 // O_NONBLOCK. For compatibility, emulate blocking semantics by
560 // spinning until the write succeeds. If you don't want spinning,
561 // don't use O_NONBLOCK file descriptors with raw_ostream.
Dan Gohmand3511162010-05-06 02:06:20 +0000562 if (errno == EINTR || errno == EAGAIN
563#ifdef EWOULDBLOCK
564 || errno == EWOULDBLOCK
565#endif
566 )
Dan Gohmanef969f32010-05-06 01:27:36 +0000567 continue;
568
569 // Otherwise it's a non-recoverable error. Note it and quit.
570 error_detected();
571 break;
572 }
573
574 // The write may have written some or all of the data. Update the
575 // size and buffer pointer to reflect the remainder that needs
576 // to be written. If there are no bytes left, we're done.
577 Ptr += ret;
578 Size -= ret;
579 } while (Size > 0);
Chris Lattner84b94f72008-08-17 01:35:29 +0000580}
581
Dan Gohman44790e72010-08-18 01:34:52 +0000582void raw_fd_ostream::close() {
583 assert(ShouldClose);
584 ShouldClose = false;
585 flush();
David Majnemer51c2afc2014-10-07 05:48:40 +0000586 if (sys::Process::SafelyCloseFileDescriptor(FD))
587 error_detected();
Dan Gohman44790e72010-08-18 01:34:52 +0000588 FD = -1;
589}
590
Ted Kremeneka2669922009-01-26 21:42:04 +0000591uint64_t raw_fd_ostream::seek(uint64_t off) {
Yaron Keren7cf7f802016-02-23 07:17:58 +0000592 assert(SupportsSeeking && "Stream does not support seeking!");
Ted Kremeneka2669922009-01-26 21:42:04 +0000593 flush();
Daniel Dunbardcb50b92009-07-15 08:11:46 +0000594 pos = ::lseek(FD, off, SEEK_SET);
Rafael Espindola642a2212015-04-14 22:54:16 +0000595 if (pos == (uint64_t)-1)
Dan Gohman58fcef92009-07-15 23:25:33 +0000596 error_detected();
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000597 return pos;
Ted Kremeneka2669922009-01-26 21:42:04 +0000598}
599
Rafael Espindola4ba9af12015-04-20 13:04:30 +0000600void raw_fd_ostream::pwrite_impl(const char *Ptr, size_t Size,
601 uint64_t Offset) {
Rafael Espindola37b70152015-04-14 15:00:34 +0000602 uint64_t Pos = tell();
603 seek(Offset);
604 write(Ptr, Size);
605 seek(Pos);
606}
607
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000608size_t raw_fd_ostream::preferred_buffer_size() const {
Chris Lattnerca97c922010-07-07 15:52:27 +0000609#if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(__minix)
Chris Lattnerc86cdc72010-04-09 20:45:04 +0000610 // Windows and Minix have no st_blksize.
Dan Gohman84487b92009-08-13 17:27:29 +0000611 assert(FD >= 0 && "File not yet open!");
612 struct stat statbuf;
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000613 if (fstat(FD, &statbuf) != 0)
614 return 0;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000615
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000616 // If this is a terminal, don't use buffering. Line buffering
617 // would be a more traditional thing to do, but it's not worth
618 // the complexity.
619 if (S_ISCHR(statbuf.st_mode) && isatty(FD))
620 return 0;
621 // Return the preferred block size.
622 return statbuf.st_blksize;
Dan Gohmanfeaeb362010-05-28 16:50:01 +0000623#else
Dan Gohman84487b92009-08-13 17:27:29 +0000624 return raw_ostream::preferred_buffer_size();
Dan Gohmanfeaeb362010-05-28 16:50:01 +0000625#endif
Dan Gohman84487b92009-08-13 17:27:29 +0000626}
627
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000628raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
629 bool bg) {
630 if (sys::Process::ColorNeedsFlush())
631 flush();
632 const char *colorcode =
633 (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
634 : sys::Process::OutputColor(colors, bold, bg);
635 if (colorcode) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000636 size_t len = strlen(colorcode);
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000637 write(colorcode, len);
638 // don't account colors towards output characters
639 pos -= len;
640 }
641 return *this;
642}
643
644raw_ostream &raw_fd_ostream::resetColor() {
645 if (sys::Process::ColorNeedsFlush())
646 flush();
647 const char *colorcode = sys::Process::ResetColor();
648 if (colorcode) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000649 size_t len = strlen(colorcode);
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000650 write(colorcode, len);
651 // don't account colors towards output characters
652 pos -= len;
653 }
654 return *this;
655}
656
Benjamin Kramer13d16f32012-04-16 08:56:50 +0000657raw_ostream &raw_fd_ostream::reverseColor() {
658 if (sys::Process::ColorNeedsFlush())
659 flush();
660 const char *colorcode = sys::Process::OutputReverse();
661 if (colorcode) {
662 size_t len = strlen(colorcode);
663 write(colorcode, len);
664 // don't account colors towards output characters
665 pos -= len;
666 }
667 return *this;
668}
669
Dan Gohmane5929232009-09-11 20:46:33 +0000670bool raw_fd_ostream::is_displayed() const {
671 return sys::Process::FileDescriptorIsDisplayed(FD);
672}
673
Daniel Dunbar04b45832012-07-20 18:29:41 +0000674bool raw_fd_ostream::has_colors() const {
675 return sys::Process::FileDescriptorHasColors(FD);
676}
677
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000678//===----------------------------------------------------------------------===//
Dan Gohmane9a46912010-08-20 16:44:56 +0000679// outs(), errs(), nulls()
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000680//===----------------------------------------------------------------------===//
Chris Lattner84b94f72008-08-17 01:35:29 +0000681
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000682/// outs() - This returns a reference to a raw_ostream for standard output.
683/// Use it like: outs() << "foo" << "bar";
Owen Anderson93719642008-08-21 00:14:44 +0000684raw_ostream &llvm::outs() {
Justin Lebarc75d5662016-02-19 00:18:46 +0000685 // Set buffer settings to model stdout behavior. Delete the file descriptor
686 // when the program exits, forcing error detection. This means that if you
687 // ever call outs(), you can't open another raw_fd_ostream on stdout, as we'll
688 // close stdout twice and print an error the second time.
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000689 std::error_code EC;
690 static raw_fd_ostream S("-", EC, sys::fs::F_None);
691 assert(!EC);
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000692 return S;
693}
694
695/// errs() - This returns a reference to a raw_ostream for standard error.
696/// Use it like: errs() << "foo" << "bar";
Owen Anderson93719642008-08-21 00:14:44 +0000697raw_ostream &llvm::errs() {
Dan Gohman443f2d62010-08-20 16:39:41 +0000698 // Set standard error to be unbuffered by default.
699 static raw_fd_ostream S(STDERR_FILENO, false, true);
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000700 return S;
701}
702
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000703/// nulls() - This returns a reference to a raw_ostream which discards output.
704raw_ostream &llvm::nulls() {
705 static raw_null_ostream S;
706 return S;
707}
708
Chris Lattner205af962008-08-23 22:43:04 +0000709//===----------------------------------------------------------------------===//
710// raw_string_ostream
711//===----------------------------------------------------------------------===//
712
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000713raw_string_ostream::~raw_string_ostream() {
714 flush();
715}
716
Dan Gohmanf199ad62009-07-16 15:24:40 +0000717void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
Daniel Dunbardb7a36c2009-03-16 23:29:31 +0000718 OS.append(Ptr, Size);
Chris Lattner205af962008-08-23 22:43:04 +0000719}
720
721//===----------------------------------------------------------------------===//
722// raw_svector_ostream
723//===----------------------------------------------------------------------===//
724
Yaron Keren3d1173b2015-08-13 06:19:52 +0000725uint64_t raw_svector_ostream::current_pos() const { return OS.size(); }
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000726
Yaron Keren3d1173b2015-08-13 06:19:52 +0000727void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
728 OS.append(Ptr, Ptr + Size);
Nick Lewyckye2f6fb52015-08-13 18:10:19 +0000729}
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000730
Rafael Espindola4ba9af12015-04-20 13:04:30 +0000731void raw_svector_ostream::pwrite_impl(const char *Ptr, size_t Size,
732 uint64_t Offset) {
Yaron Keren3d1173b2015-08-13 06:19:52 +0000733 memcpy(OS.data() + Offset, Ptr, Size);
Daniel Dunbare813cba2009-08-19 18:40:58 +0000734}
735
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000736//===----------------------------------------------------------------------===//
737// raw_null_ostream
738//===----------------------------------------------------------------------===//
739
Dan Gohman4b66b472009-07-27 21:46:02 +0000740raw_null_ostream::~raw_null_ostream() {
741#ifndef NDEBUG
742 // ~raw_ostream asserts that the buffer is empty. This isn't necessary
743 // with raw_null_ostream, but it's better to have raw_null_ostream follow
744 // the rules than to change the rules just for raw_null_ostream.
745 flush();
746#endif
747}
748
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000749void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
750}
751
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000752uint64_t raw_null_ostream::current_pos() const {
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000753 return 0;
754}
Rafael Espindola37b70152015-04-14 15:00:34 +0000755
Rafael Espindola4ba9af12015-04-20 13:04:30 +0000756void raw_null_ostream::pwrite_impl(const char *Ptr, size_t Size,
757 uint64_t Offset) {}