blob: 49ef400c5f2d7d32c1c8bc79cb72b942f58f8ae3 [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"
Chandler Carruthed0881b2012-12-03 16:50:05 +000024#include "llvm/Support/Process.h"
25#include "llvm/Support/Program.h"
Benjamin Krameref14f802010-01-29 15:19:06 +000026#include <cctype>
Benjamin Kramerce84a252010-05-05 15:17:47 +000027#include <cerrno>
Dan Gohman84487b92009-08-13 17:27:29 +000028#include <sys/stat.h>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000029#include <system_error>
Chris Lattner84b94f72008-08-17 01:35:29 +000030
NAKAMURA Takumi212c80a2013-07-17 02:21:10 +000031// <fcntl.h> may provide O_BINARY.
32#if defined(HAVE_FCNTL_H)
33# include <fcntl.h>
34#endif
35
Chris Lattnerd564f292008-08-22 15:45:00 +000036#if defined(HAVE_UNISTD_H)
37# include <unistd.h>
38#endif
Daniel Dunbar4fed8872011-02-03 03:32:32 +000039#if defined(HAVE_SYS_UIO_H) && defined(HAVE_WRITEV)
40# include <sys/uio.h>
41#endif
Argyrios Kyrtzidisb97ff822008-08-17 09:25:21 +000042
NAKAMURA Takumife84f392010-10-19 01:21:55 +000043#if defined(__CYGWIN__)
44#include <io.h>
45#endif
46
Argyrios Kyrtzidisb97ff822008-08-17 09:25:21 +000047#if defined(_MSC_VER)
Chris Lattner84b94f72008-08-17 01:35:29 +000048#include <io.h>
Owen Anderson93719642008-08-21 00:14:44 +000049#ifndef STDIN_FILENO
50# define STDIN_FILENO 0
51#endif
52#ifndef STDOUT_FILENO
53# define STDOUT_FILENO 1
54#endif
55#ifndef STDERR_FILENO
56# define STDERR_FILENO 2
57#endif
Chris Lattner84b94f72008-08-17 01:35:29 +000058#endif
59
Chris Lattnerd564f292008-08-22 15:45:00 +000060using namespace llvm;
61
Dan Gohman58fcef92009-07-15 23:25:33 +000062raw_ostream::~raw_ostream() {
Dan Gohman1b763292009-07-27 20:49:44 +000063 // raw_ostream's subclasses should take care to flush the buffer
64 // in their destructors.
65 assert(OutBufCur == OutBufStart &&
66 "raw_ostream destructor called with non-empty buffer!");
67
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000068 if (BufferMode == InternalBuffer)
69 delete [] OutBufStart;
Dan Gohman58fcef92009-07-15 23:25:33 +000070}
Chris Lattnerd564f292008-08-22 15:45:00 +000071
Chris Lattner84b94f72008-08-17 01:35:29 +000072// An out of line virtual method to provide a home for the class vtable.
73void raw_ostream::handle() {}
74
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +000075size_t raw_ostream::preferred_buffer_size() const {
Dan Gohman84487b92009-08-13 17:27:29 +000076 // BUFSIZ is intended to be a reasonable default.
77 return BUFSIZ;
78}
79
80void raw_ostream::SetBuffered() {
81 // Ask the subclass to determine an appropriate buffer size.
Dan Gohman17710222009-08-15 02:05:19 +000082 if (size_t Size = preferred_buffer_size())
83 SetBufferSize(Size);
84 else
85 // It may return 0, meaning this stream should be unbuffered.
86 SetUnbuffered();
Dan Gohman84487b92009-08-13 17:27:29 +000087}
88
Dan Gohmanb452d4e2010-03-24 19:38:02 +000089void raw_ostream::SetBufferAndMode(char *BufferStart, size_t Size,
Nick Lewycky7bfd86d2011-08-28 03:30:02 +000090 BufferKind Mode) {
Craig Topper2617dcc2014-04-15 06:32:26 +000091 assert(((Mode == Unbuffered && !BufferStart && Size == 0) ||
92 (Mode != Unbuffered && BufferStart && Size != 0)) &&
Daniel Dunbar316b4a02009-09-15 20:31:46 +000093 "stream must be unbuffered or have at least one byte");
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000094 // Make sure the current buffer is free of content (we can't flush here; the
95 // child buffer management logic will be in write_impl).
96 assert(GetNumBytesInBuffer() == 0 && "Current buffer is non-empty!");
Dan Gohman54401d42009-08-13 15:58:55 +000097
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000098 if (BufferMode == InternalBuffer)
99 delete [] OutBufStart;
100 OutBufStart = BufferStart;
Dan Gohman54401d42009-08-13 15:58:55 +0000101 OutBufEnd = OutBufStart+Size;
102 OutBufCur = OutBufStart;
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000103 BufferMode = Mode;
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000104
105 assert(OutBufStart <= OutBufEnd && "Invalid size!");
Dan Gohman54401d42009-08-13 15:58:55 +0000106}
107
Owen Andersond2850532008-08-21 20:58:52 +0000108raw_ostream &raw_ostream::operator<<(unsigned long N) {
109 // Zero is a special case.
110 if (N == 0)
111 return *this << '0';
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000112
Owen Andersond2850532008-08-21 20:58:52 +0000113 char NumberBuffer[20];
114 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
115 char *CurPtr = EndPtr;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000116
Owen Andersond2850532008-08-21 20:58:52 +0000117 while (N) {
118 *--CurPtr = '0' + char(N % 10);
119 N /= 10;
120 }
121 return write(CurPtr, EndPtr-CurPtr);
122}
123
124raw_ostream &raw_ostream::operator<<(long N) {
125 if (N < 0) {
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000126 *this << '-';
Eli Friedman53ba2082011-10-13 22:49:56 +0000127 // Avoid undefined behavior on LONG_MIN with a cast.
128 N = -(unsigned long)N;
Owen Andersond2850532008-08-21 20:58:52 +0000129 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000130
Owen Andersond2850532008-08-21 20:58:52 +0000131 return this->operator<<(static_cast<unsigned long>(N));
132}
133
134raw_ostream &raw_ostream::operator<<(unsigned long long N) {
Daniel Dunbar465de3e2009-08-19 16:25:25 +0000135 // Output using 32-bit div/mod when possible.
Daniel Dunbara94f58a2009-07-29 06:45:14 +0000136 if (N == static_cast<unsigned long>(N))
137 return this->operator<<(static_cast<unsigned long>(N));
138
Daniel Dunbar465de3e2009-08-19 16:25:25 +0000139 char NumberBuffer[20];
140 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
141 char *CurPtr = EndPtr;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000142
Daniel Dunbar465de3e2009-08-19 16:25:25 +0000143 while (N) {
144 *--CurPtr = '0' + char(N % 10);
145 N /= 10;
146 }
147 return write(CurPtr, EndPtr-CurPtr);
Owen Andersond2850532008-08-21 20:58:52 +0000148}
149
150raw_ostream &raw_ostream::operator<<(long long N) {
Chris Lattner3db3bb02010-08-03 16:41:24 +0000151 if (N < 0) {
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000152 *this << '-';
Chris Lattner3db3bb02010-08-03 16:41:24 +0000153 // Avoid undefined behavior on INT64_MIN with a cast.
154 N = -(unsigned long long)N;
Owen Andersond2850532008-08-21 20:58:52 +0000155 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000156
Owen Andersond2850532008-08-21 20:58:52 +0000157 return this->operator<<(static_cast<unsigned long long>(N));
158}
159
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000160raw_ostream &raw_ostream::write_hex(unsigned long long N) {
Daniel Dunbar87862182009-03-16 22:08:44 +0000161 // Zero is a special case.
162 if (N == 0)
163 return *this << '0';
164
165 char NumberBuffer[20];
166 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
167 char *CurPtr = EndPtr;
168
169 while (N) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000170 uintptr_t x = N % 16;
Daniel Dunbar87862182009-03-16 22:08:44 +0000171 *--CurPtr = (x < 10 ? '0' + x : 'a' + x - 10);
172 N /= 16;
173 }
174
175 return write(CurPtr, EndPtr-CurPtr);
Chris Lattner0c19df42008-08-23 22:23:09 +0000176}
177
Daniel Dunbar65dc8912010-11-27 07:59:50 +0000178raw_ostream &raw_ostream::write_escaped(StringRef Str,
179 bool UseHexEscapes) {
Daniel Dunbar4108c432009-10-17 20:43:08 +0000180 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
181 unsigned char c = Str[i];
182
183 switch (c) {
184 case '\\':
185 *this << '\\' << '\\';
186 break;
187 case '\t':
188 *this << '\\' << 't';
189 break;
190 case '\n':
191 *this << '\\' << 'n';
192 break;
193 case '"':
194 *this << '\\' << '"';
195 break;
196 default:
197 if (std::isprint(c)) {
198 *this << c;
199 break;
200 }
201
Daniel Dunbar65dc8912010-11-27 07:59:50 +0000202 // Write out the escaped representation.
203 if (UseHexEscapes) {
204 *this << '\\' << 'x';
205 *this << hexdigit((c >> 4 & 0xF));
206 *this << hexdigit((c >> 0) & 0xF);
207 } else {
208 // Always use a full 3-character octal escape.
209 *this << '\\';
210 *this << char('0' + ((c >> 6) & 7));
211 *this << char('0' + ((c >> 3) & 7));
212 *this << char('0' + ((c >> 0) & 7));
213 }
Daniel Dunbar4108c432009-10-17 20:43:08 +0000214 }
215 }
216
217 return *this;
218}
219
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000220raw_ostream &raw_ostream::operator<<(const void *P) {
221 *this << '0' << 'x';
222
223 return write_hex((uintptr_t) P);
224}
225
Chris Lattner06fa1762009-08-24 03:52:50 +0000226raw_ostream &raw_ostream::operator<<(double N) {
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000227#ifdef _WIN32
228 // On MSVCRT and compatible, output of %e is incompatible to Posix
229 // by default. Number of exponent digits should be at least 2. "%+03d"
230 // FIXME: Implement our formatter to here or Support/Format.h!
NAKAMURA Takumi79addb82014-01-12 14:44:46 +0000231#if __cplusplus >= 201103L && defined(__MINGW32__)
232 // FIXME: It should be generic to C++11.
233 if (N == 0.0 && std::signbit(N))
234 return *this << "-0.000000e+00";
235#else
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000236 int fpcl = _fpclass(N);
237
238 // negative zero
239 if (fpcl == _FPCLASS_NZ)
240 return *this << "-0.000000e+00";
NAKAMURA Takumi79addb82014-01-12 14:44:46 +0000241#endif
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000242
243 char buf[16];
244 unsigned len;
Benjamin Krameraf09f222015-02-15 22:15:41 +0000245 len = format("%e", N).snprint(buf, sizeof(buf));
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000246 if (len <= sizeof(buf) - 2) {
247 if (len >= 5 && buf[len - 5] == 'e' && buf[len - 3] == '0') {
248 int cs = buf[len - 4];
249 if (cs == '+' || cs == '-') {
250 int c1 = buf[len - 2];
251 int c0 = buf[len - 1];
Guy Benyei83c74e92013-02-12 21:21:59 +0000252 if (isdigit(static_cast<unsigned char>(c1)) &&
253 isdigit(static_cast<unsigned char>(c0))) {
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000254 // Trim leading '0': "...e+012" -> "...e+12\0"
255 buf[len - 3] = c1;
256 buf[len - 2] = c0;
257 buf[--len] = 0;
258 }
259 }
260 }
261 return this->operator<<(buf);
262 }
263#endif
Benjamin Kramer6bee24a2010-01-29 14:40:33 +0000264 return this->operator<<(format("%e", N));
Chris Lattner06fa1762009-08-24 03:52:50 +0000265}
266
267
268
Daniel Dunbard24535f2009-03-16 22:55:06 +0000269void raw_ostream::flush_nonempty() {
270 assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000271 size_t Length = OutBufCur - OutBufStart;
272 OutBufCur = OutBufStart;
273 write_impl(OutBufStart, Length);
Daniel Dunbard24535f2009-03-16 22:55:06 +0000274}
275
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000276raw_ostream &raw_ostream::write(unsigned char C) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000277 // Group exceptional cases into a single branch.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000278 if (LLVM_UNLIKELY(OutBufCur >= OutBufEnd)) {
279 if (LLVM_UNLIKELY(!OutBufStart)) {
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000280 if (BufferMode == Unbuffered) {
Dan Gohman23f90c12009-08-18 20:09:59 +0000281 write_impl(reinterpret_cast<char*>(&C), 1);
282 return *this;
283 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000284 // Set up a buffer and start over.
285 SetBuffered();
286 return write(C);
Dan Gohman23f90c12009-08-18 20:09:59 +0000287 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000288
289 flush_nonempty();
Daniel Dunbar2d603da2009-03-17 01:13:35 +0000290 }
291
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000292 *OutBufCur++ = C;
Daniel Dunbar87862182009-03-16 22:08:44 +0000293 return *this;
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000294}
Chris Lattner0c19df42008-08-23 22:23:09 +0000295
Dan Gohmanf199ad62009-07-16 15:24:40 +0000296raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000297 // Group exceptional cases into a single branch.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000298 if (LLVM_UNLIKELY(size_t(OutBufEnd - OutBufCur) < Size)) {
299 if (LLVM_UNLIKELY(!OutBufStart)) {
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000300 if (BufferMode == Unbuffered) {
Dan Gohman52022c22009-08-13 15:44:52 +0000301 write_impl(Ptr, Size);
302 return *this;
303 }
304 // Set up a buffer and start over.
Dan Gohman84487b92009-08-13 17:27:29 +0000305 SetBuffered();
Dan Gohman52022c22009-08-13 15:44:52 +0000306 return write(Ptr, Size);
307 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000308
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000309 size_t NumBytes = OutBufEnd - OutBufCur;
310
Benjamin Krameracf08422011-03-04 18:18:16 +0000311 // If the buffer is empty at this point we have a string that is larger
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000312 // than the buffer. Directly write the chunk that is a multiple of the
313 // preferred buffer size and put the remainder in the buffer.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000314 if (LLVM_UNLIKELY(OutBufCur == OutBufStart)) {
Michael Ilseman5be22a12014-12-12 21:48:03 +0000315 assert(NumBytes != 0 && "undefined behavior");
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000316 size_t BytesToWrite = Size - (Size % NumBytes);
317 write_impl(Ptr, BytesToWrite);
Matt Beaumont-Gaya182be82013-03-12 23:55:24 +0000318 size_t BytesRemaining = Size - BytesToWrite;
319 if (BytesRemaining > size_t(OutBufEnd - OutBufCur)) {
320 // Too much left over to copy into our buffer.
321 return write(Ptr + BytesToWrite, BytesRemaining);
322 }
323 copy_to_buffer(Ptr + BytesToWrite, BytesRemaining);
Benjamin Krameracf08422011-03-04 18:18:16 +0000324 return *this;
325 }
326
327 // We don't have enough space in the buffer to fit the string in. Insert as
328 // much as possible, flush and start over with the remainder.
Benjamin Krameracf08422011-03-04 18:18:16 +0000329 copy_to_buffer(Ptr, NumBytes);
330 flush_nonempty();
331 return write(Ptr + NumBytes, Size - NumBytes);
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000332 }
Dan Gohman52022c22009-08-13 15:44:52 +0000333
334 copy_to_buffer(Ptr, Size);
335
336 return *this;
337}
338
339void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
Dan Gohmanc04a00a2009-08-13 20:32:03 +0000340 assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
Dan Gohman98205552009-08-13 18:38:15 +0000341
Owen Andersond2850532008-08-21 20:58:52 +0000342 // Handle short strings specially, memcpy isn't very good at very short
343 // strings.
344 switch (Size) {
345 case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
346 case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
347 case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
348 case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
349 case 0: break;
350 default:
Dan Gohman52022c22009-08-13 15:44:52 +0000351 memcpy(OutBufCur, Ptr, Size);
Owen Andersond2850532008-08-21 20:58:52 +0000352 break;
353 }
Daniel Dunbar3da6a702009-03-10 16:21:55 +0000354
Dan Gohman52022c22009-08-13 15:44:52 +0000355 OutBufCur += Size;
Owen Andersond2850532008-08-21 20:58:52 +0000356}
357
Chris Lattner22b52c92008-08-23 19:23:10 +0000358// Formatted output.
359raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000360 // If we have more than a few bytes left in our output buffer, try
361 // formatting directly onto its end.
Dan Gohmanf199ad62009-07-16 15:24:40 +0000362 size_t NextBufferSize = 127;
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000363 size_t BufferBytesLeft = OutBufEnd - OutBufCur;
364 if (BufferBytesLeft > 3) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000365 size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000366
Chris Lattner22b52c92008-08-23 19:23:10 +0000367 // Common case is that we have plenty of space.
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000368 if (BytesUsed <= BufferBytesLeft) {
Chris Lattner22b52c92008-08-23 19:23:10 +0000369 OutBufCur += BytesUsed;
370 return *this;
371 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000372
Chris Lattner22b52c92008-08-23 19:23:10 +0000373 // Otherwise, we overflowed and the return value tells us the size to try
374 // again with.
375 NextBufferSize = BytesUsed;
376 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000377
Chris Lattner22b52c92008-08-23 19:23:10 +0000378 // If we got here, we didn't have enough space in the output buffer for the
379 // string. Try printing into a SmallVector that is resized to have enough
380 // space. Iterate until we win.
381 SmallVector<char, 128> V;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000382
Chris Lattner22b52c92008-08-23 19:23:10 +0000383 while (1) {
384 V.resize(NextBufferSize);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000385
Chris Lattner22b52c92008-08-23 19:23:10 +0000386 // Try formatting into the SmallVector.
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000387 size_t BytesUsed = Fmt.print(V.data(), NextBufferSize);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000388
Chris Lattner22b52c92008-08-23 19:23:10 +0000389 // If BytesUsed fit into the vector, we win.
Chris Lattner2bfc72e2008-10-26 19:20:47 +0000390 if (BytesUsed <= NextBufferSize)
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000391 return write(V.data(), BytesUsed);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000392
Chris Lattner22b52c92008-08-23 19:23:10 +0000393 // Otherwise, try again with a new size.
394 assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
395 NextBufferSize = BytesUsed;
396 }
397}
398
Nick Kledzike6480372014-09-25 20:30:58 +0000399raw_ostream &raw_ostream::operator<<(const FormattedString &FS) {
400 unsigned Len = FS.Str.size();
401 int PadAmount = FS.Width - Len;
402 if (FS.RightJustify && (PadAmount > 0))
403 this->indent(PadAmount);
404 this->operator<<(FS.Str);
405 if (!FS.RightJustify && (PadAmount > 0))
406 this->indent(PadAmount);
407 return *this;
408}
409
410raw_ostream &raw_ostream::operator<<(const FormattedNumber &FN) {
411 if (FN.Hex) {
412 unsigned Nibbles = (64 - countLeadingZeros(FN.HexValue)+3)/4;
Zachary Turner39571b32015-01-26 18:21:33 +0000413 unsigned PrefixChars = FN.HexPrefix ? 2 : 0;
414 unsigned Width = std::max(FN.Width, Nibbles + PrefixChars);
415
Nick Kledzike6480372014-09-25 20:30:58 +0000416 char NumberBuffer[20] = "0x0000000000000000";
Zachary Turner39571b32015-01-26 18:21:33 +0000417 if (!FN.HexPrefix)
418 NumberBuffer[1] = '0';
Nick Kledzike6480372014-09-25 20:30:58 +0000419 char *EndPtr = NumberBuffer+Width;
420 char *CurPtr = EndPtr;
421 const char A = FN.Upper ? 'A' : 'a';
422 unsigned long long N = FN.HexValue;
423 while (N) {
424 uintptr_t x = N % 16;
425 *--CurPtr = (x < 10 ? '0' + x : A + x - 10);
426 N /= 16;
427 }
428
429 return write(NumberBuffer, Width);
430 } else {
431 // Zero is a special case.
432 if (FN.DecValue == 0) {
433 this->indent(FN.Width-1);
434 return *this << '0';
435 }
436 char NumberBuffer[32];
437 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
438 char *CurPtr = EndPtr;
439 bool Neg = (FN.DecValue < 0);
David Majnemer4b3c90f2014-09-26 02:48:14 +0000440 uint64_t N = Neg ? -static_cast<uint64_t>(FN.DecValue) : FN.DecValue;
Nick Kledzike6480372014-09-25 20:30:58 +0000441 while (N) {
442 *--CurPtr = '0' + char(N % 10);
443 N /= 10;
444 }
445 int Len = EndPtr - CurPtr;
446 int Pad = FN.Width - Len;
447 if (Neg)
448 --Pad;
449 if (Pad > 0)
450 this->indent(Pad);
451 if (Neg)
452 *this << '-';
453 return write(CurPtr, Len);
454 }
455}
456
457
Chris Lattnere6db2c32009-08-22 23:10:29 +0000458/// indent - Insert 'NumSpaces' spaces.
459raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
Dan Gohmanf88f52e2009-08-24 04:13:01 +0000460 static const char Spaces[] = " "
461 " "
462 " ";
Chris Lattnere6db2c32009-08-22 23:10:29 +0000463
464 // Usually the indentation is small, handle it with a fastpath.
Dan Gohmanc9fa0512009-08-24 04:43:38 +0000465 if (NumSpaces < array_lengthof(Spaces))
Chris Lattnere6db2c32009-08-22 23:10:29 +0000466 return write(Spaces, NumSpaces);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000467
Chris Lattnere6db2c32009-08-22 23:10:29 +0000468 while (NumSpaces) {
Dan Gohmanc9fa0512009-08-24 04:43:38 +0000469 unsigned NumToWrite = std::min(NumSpaces,
470 (unsigned)array_lengthof(Spaces)-1);
Chris Lattnere6db2c32009-08-22 23:10:29 +0000471 write(Spaces, NumToWrite);
472 NumSpaces -= NumToWrite;
473 }
474 return *this;
475}
476
477
Chris Lattner22b52c92008-08-23 19:23:10 +0000478//===----------------------------------------------------------------------===//
479// Formatted Output
480//===----------------------------------------------------------------------===//
481
482// Out of line virtual method.
483void format_object_base::home() {
484}
485
Chris Lattner84b94f72008-08-17 01:35:29 +0000486//===----------------------------------------------------------------------===//
487// raw_fd_ostream
488//===----------------------------------------------------------------------===//
489
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000490static int getFD(StringRef Filename, std::error_code &EC,
491 sys::fs::OpenFlags Flags) {
Dan Gohmanc825cee2010-08-18 22:26:19 +0000492 // Handle "-" as stdout. Note that when we do this, we consider ourself
493 // the owner of stdout. This means that we can do things like close the
494 // file descriptor when we're done and set the "binary" flag globally.
Rafael Espindola3fd1e992014-08-25 18:16:47 +0000495 if (Filename == "-") {
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000496 EC = std::error_code();
Daniel Dunbared90e702008-11-13 05:01:07 +0000497 // If user requested binary then put stdout into binary mode if
498 // possible.
Rafael Espindola90c7f1c2014-02-24 18:20:12 +0000499 if (!(Flags & sys::fs::F_Text))
Rafael Espindolacb2eca02013-06-12 20:58:35 +0000500 sys::ChangeStdoutToBinary();
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000501 return STDOUT_FILENO;
Chris Lattnerd5bc0682008-08-17 03:53:23 +0000502 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000503
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000504 int FD;
Rafael Espindola3fd1e992014-08-25 18:16:47 +0000505 EC = sys::fs::openFileForWrite(Filename, FD, Flags);
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000506 if (EC)
507 return -1;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000508
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000509 return FD;
Chris Lattner84b94f72008-08-17 01:35:29 +0000510}
511
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000512raw_fd_ostream::raw_fd_ostream(StringRef Filename, std::error_code &EC,
513 sys::fs::OpenFlags Flags)
514 : raw_fd_ostream(getFD(Filename, EC, Flags), true) {}
515
Rafael Espindola62e6ec02015-04-09 16:59:07 +0000516/// FD is the file descriptor that this writes to. If ShouldClose is true, this
517/// closes the file when the stream is destroyed.
Francois Picheta3037c32010-10-14 20:30:58 +0000518raw_fd_ostream::raw_fd_ostream(int fd, bool shouldClose, bool unbuffered)
Rafael Espindola37b70152015-04-14 15:00:34 +0000519 : raw_pwrite_stream(unbuffered), FD(fd), ShouldClose(shouldClose),
520 Error(false), UseAtomicWrites(false) {
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000521 if (FD < 0 ) {
522 ShouldClose = false;
523 return;
524 }
Michael J. Spencerb7479902011-01-17 15:53:12 +0000525
526 // Get the starting position.
527 off_t loc = ::lseek(FD, 0, SEEK_CUR);
Rafael Espindolaa9b84ab2015-04-13 11:09:48 +0000528#ifdef LLVM_ON_WIN32
529 // MSVCRT's _lseek(SEEK_CUR) doesn't return -1 for pipes.
530 sys::fs::file_status Status;
531 std::error_code EC = status(FD, Status);
532 SupportsSeeking = !EC && Status.type() == sys::fs::file_type::regular_file;
533#else
Rafael Espindola74d2f612015-04-10 18:15:51 +0000534 SupportsSeeking = loc != (off_t)-1;
Rafael Espindolaa9b84ab2015-04-13 11:09:48 +0000535#endif
Rafael Espindola74d2f612015-04-10 18:15:51 +0000536 if (!SupportsSeeking)
Michael J. Spencerb7479902011-01-17 15:53:12 +0000537 pos = 0;
538 else
539 pos = static_cast<uint64_t>(loc);
Francois Picheta3037c32010-10-14 20:30:58 +0000540}
541
Chris Lattner84b94f72008-08-17 01:35:29 +0000542raw_fd_ostream::~raw_fd_ostream() {
Dan Gohman38adfdd2010-08-20 16:34:20 +0000543 if (FD >= 0) {
544 flush();
David Majnemer51c2afc2014-10-07 05:48:40 +0000545 if (ShouldClose && sys::Process::SafelyCloseFileDescriptor(FD))
546 error_detected();
Dan Gohman38adfdd2010-08-20 16:34:20 +0000547 }
548
NAKAMURA Takumi76e68ea2011-03-16 02:53:39 +0000549#ifdef __MINGW32__
550 // On mingw, global dtors should not call exit().
551 // report_fatal_error() invokes exit(). We know report_fatal_error()
552 // might not write messages to stderr when any errors were detected
553 // on FD == 2.
554 if (FD == 2) return;
555#endif
556
Dan Gohman38adfdd2010-08-20 16:34:20 +0000557 // If there are any pending errors, report them now. Clients wishing
558 // to avoid report_fatal_error calls should check for errors with
559 // has_error() and clear the error flag with clear_error() before
560 // destructing raw_ostream objects which may have errors.
561 if (has_error())
Chad Rosier7ce810c2013-03-27 18:30:00 +0000562 report_fatal_error("IO failure on output stream.", /*GenCrashDiag=*/false);
Chris Lattnerce3b2c32010-08-17 23:11:56 +0000563}
Chris Lattner9e6f1f12009-08-23 02:51:22 +0000564
Dan Gohman44790e72010-08-18 01:34:52 +0000565
Dan Gohmanf199ad62009-07-16 15:24:40 +0000566void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000567 assert(FD >= 0 && "File already closed.");
Daniel Dunbardb7a36c2009-03-16 23:29:31 +0000568 pos += Size;
Dan Gohmanef969f32010-05-06 01:27:36 +0000569
Benjamin Kramerce84a252010-05-05 15:17:47 +0000570 do {
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000571 ssize_t ret;
572
573 // Check whether we should attempt to use atomic writes.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000574 if (LLVM_LIKELY(!UseAtomicWrites)) {
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000575 ret = ::write(FD, Ptr, Size);
576 } else {
577 // Use ::writev() where available.
578#if defined(HAVE_WRITEV)
Galina Kistanova7da65782012-07-12 20:45:36 +0000579 const void *Addr = static_cast<const void *>(Ptr);
580 struct iovec IOV = {const_cast<void *>(Addr), Size };
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000581 ret = ::writev(FD, &IOV, 1);
582#else
583 ret = ::write(FD, Ptr, Size);
584#endif
585 }
Dan Gohmanef969f32010-05-06 01:27:36 +0000586
587 if (ret < 0) {
588 // If it's a recoverable error, swallow it and retry the write.
Dan Gohmandea53102010-05-18 15:25:14 +0000589 //
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.
Dan Gohmand3511162010-05-06 02:06:20 +0000596 if (errno == EINTR || errno == EAGAIN
597#ifdef EWOULDBLOCK
598 || errno == EWOULDBLOCK
599#endif
600 )
Dan Gohmanef969f32010-05-06 01:27:36 +0000601 continue;
602
603 // Otherwise it's a non-recoverable error. Note it and quit.
604 error_detected();
605 break;
606 }
607
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.
611 Ptr += ret;
612 Size -= ret;
613 } while (Size > 0);
Chris Lattner84b94f72008-08-17 01:35:29 +0000614}
615
Dan Gohman44790e72010-08-18 01:34:52 +0000616void raw_fd_ostream::close() {
617 assert(ShouldClose);
618 ShouldClose = false;
619 flush();
David Majnemer51c2afc2014-10-07 05:48:40 +0000620 if (sys::Process::SafelyCloseFileDescriptor(FD))
621 error_detected();
Dan Gohman44790e72010-08-18 01:34:52 +0000622 FD = -1;
623}
624
Ted Kremeneka2669922009-01-26 21:42:04 +0000625uint64_t raw_fd_ostream::seek(uint64_t off) {
626 flush();
Daniel Dunbardcb50b92009-07-15 08:11:46 +0000627 pos = ::lseek(FD, off, SEEK_SET);
Rafael Espindola642a2212015-04-14 22:54:16 +0000628 if (pos == (uint64_t)-1)
Dan Gohman58fcef92009-07-15 23:25:33 +0000629 error_detected();
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000630 return pos;
Ted Kremeneka2669922009-01-26 21:42:04 +0000631}
632
Rafael Espindola4ba9af12015-04-20 13:04:30 +0000633void raw_fd_ostream::pwrite_impl(const char *Ptr, size_t Size,
634 uint64_t Offset) {
Rafael Espindola37b70152015-04-14 15:00:34 +0000635 uint64_t Pos = tell();
636 seek(Offset);
637 write(Ptr, Size);
638 seek(Pos);
639}
640
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000641size_t raw_fd_ostream::preferred_buffer_size() const {
Chris Lattnerca97c922010-07-07 15:52:27 +0000642#if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(__minix)
Chris Lattnerc86cdc72010-04-09 20:45:04 +0000643 // Windows and Minix have no st_blksize.
Dan Gohman84487b92009-08-13 17:27:29 +0000644 assert(FD >= 0 && "File not yet open!");
645 struct stat statbuf;
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000646 if (fstat(FD, &statbuf) != 0)
647 return 0;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000648
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000649 // If this is a terminal, don't use buffering. Line buffering
650 // would be a more traditional thing to do, but it's not worth
651 // the complexity.
652 if (S_ISCHR(statbuf.st_mode) && isatty(FD))
653 return 0;
654 // Return the preferred block size.
655 return statbuf.st_blksize;
Dan Gohmanfeaeb362010-05-28 16:50:01 +0000656#else
Dan Gohman84487b92009-08-13 17:27:29 +0000657 return raw_ostream::preferred_buffer_size();
Dan Gohmanfeaeb362010-05-28 16:50:01 +0000658#endif
Dan Gohman84487b92009-08-13 17:27:29 +0000659}
660
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000661raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
662 bool bg) {
663 if (sys::Process::ColorNeedsFlush())
664 flush();
665 const char *colorcode =
666 (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
667 : sys::Process::OutputColor(colors, bold, bg);
668 if (colorcode) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000669 size_t len = strlen(colorcode);
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000670 write(colorcode, len);
671 // don't account colors towards output characters
672 pos -= len;
673 }
674 return *this;
675}
676
677raw_ostream &raw_fd_ostream::resetColor() {
678 if (sys::Process::ColorNeedsFlush())
679 flush();
680 const char *colorcode = sys::Process::ResetColor();
681 if (colorcode) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000682 size_t len = strlen(colorcode);
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000683 write(colorcode, len);
684 // don't account colors towards output characters
685 pos -= len;
686 }
687 return *this;
688}
689
Benjamin Kramer13d16f32012-04-16 08:56:50 +0000690raw_ostream &raw_fd_ostream::reverseColor() {
691 if (sys::Process::ColorNeedsFlush())
692 flush();
693 const char *colorcode = sys::Process::OutputReverse();
694 if (colorcode) {
695 size_t len = strlen(colorcode);
696 write(colorcode, len);
697 // don't account colors towards output characters
698 pos -= len;
699 }
700 return *this;
701}
702
Dan Gohmane5929232009-09-11 20:46:33 +0000703bool raw_fd_ostream::is_displayed() const {
704 return sys::Process::FileDescriptorIsDisplayed(FD);
705}
706
Daniel Dunbar04b45832012-07-20 18:29:41 +0000707bool raw_fd_ostream::has_colors() const {
708 return sys::Process::FileDescriptorHasColors(FD);
709}
710
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000711//===----------------------------------------------------------------------===//
Dan Gohmane9a46912010-08-20 16:44:56 +0000712// outs(), errs(), nulls()
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000713//===----------------------------------------------------------------------===//
Chris Lattner84b94f72008-08-17 01:35:29 +0000714
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000715/// outs() - This returns a reference to a raw_ostream for standard output.
716/// Use it like: outs() << "foo" << "bar";
Owen Anderson93719642008-08-21 00:14:44 +0000717raw_ostream &llvm::outs() {
Dan Gohman443f2d62010-08-20 16:39:41 +0000718 // Set buffer settings to model stdout behavior.
Hans Wennborg0fc52d42014-07-17 18:33:44 +0000719 // Delete the file descriptor when the program exits, forcing error
Dan Gohmane9a46912010-08-20 16:44:56 +0000720 // detection. If you don't want this behavior, don't use outs().
Rafael Espindola79be4cc2015-04-13 10:28:56 +0000721 std::error_code EC;
722 static raw_fd_ostream S("-", EC, sys::fs::F_None);
723 assert(!EC);
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000724 return S;
725}
726
727/// errs() - This returns a reference to a raw_ostream for standard error.
728/// Use it like: errs() << "foo" << "bar";
Owen Anderson93719642008-08-21 00:14:44 +0000729raw_ostream &llvm::errs() {
Dan Gohman443f2d62010-08-20 16:39:41 +0000730 // Set standard error to be unbuffered by default.
731 static raw_fd_ostream S(STDERR_FILENO, false, true);
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000732 return S;
733}
734
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000735/// nulls() - This returns a reference to a raw_ostream which discards output.
736raw_ostream &llvm::nulls() {
737 static raw_null_ostream S;
738 return S;
739}
740
Douglas Gregorb231e572009-04-20 07:34:17 +0000741
Chris Lattner205af962008-08-23 22:43:04 +0000742//===----------------------------------------------------------------------===//
743// raw_string_ostream
744//===----------------------------------------------------------------------===//
745
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000746raw_string_ostream::~raw_string_ostream() {
747 flush();
748}
749
Dan Gohmanf199ad62009-07-16 15:24:40 +0000750void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
Daniel Dunbardb7a36c2009-03-16 23:29:31 +0000751 OS.append(Ptr, Size);
Chris Lattner205af962008-08-23 22:43:04 +0000752}
753
754//===----------------------------------------------------------------------===//
755// raw_svector_ostream
756//===----------------------------------------------------------------------===//
757
Yaron Keren3d1173b2015-08-13 06:19:52 +0000758uint64_t raw_svector_ostream::current_pos() const { return OS.size(); }
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000759
Yaron Keren3d1173b2015-08-13 06:19:52 +0000760void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
761 OS.append(Ptr, Ptr + Size);
Nick Lewyckye2f6fb52015-08-13 18:10:19 +0000762}
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000763
Rafael Espindola4ba9af12015-04-20 13:04:30 +0000764void raw_svector_ostream::pwrite_impl(const char *Ptr, size_t Size,
765 uint64_t Offset) {
Yaron Keren3d1173b2015-08-13 06:19:52 +0000766 memcpy(OS.data() + Offset, Ptr, Size);
Daniel Dunbare813cba2009-08-19 18:40:58 +0000767}
768
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000769//===----------------------------------------------------------------------===//
770// raw_null_ostream
771//===----------------------------------------------------------------------===//
772
Dan Gohman4b66b472009-07-27 21:46:02 +0000773raw_null_ostream::~raw_null_ostream() {
774#ifndef NDEBUG
775 // ~raw_ostream asserts that the buffer is empty. This isn't necessary
776 // with raw_null_ostream, but it's better to have raw_null_ostream follow
777 // the rules than to change the rules just for raw_null_ostream.
778 flush();
779#endif
780}
781
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000782void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
783}
784
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000785uint64_t raw_null_ostream::current_pos() const {
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000786 return 0;
787}
Rafael Espindola37b70152015-04-14 15:00:34 +0000788
Rafael Espindola4ba9af12015-04-20 13:04:30 +0000789void raw_null_ostream::pwrite_impl(const char *Ptr, size_t Size,
790 uint64_t Offset) {}