blob: b8a1537ae8ad2b9ad2080d0414ac2cf691850acc [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"
23#include "llvm/Support/Process.h"
24#include "llvm/Support/Program.h"
Benjamin Krameref14f802010-01-29 15:19:06 +000025#include <cctype>
Benjamin Kramerce84a252010-05-05 15:17:47 +000026#include <cerrno>
Dan Gohman84487b92009-08-13 17:27:29 +000027#include <sys/stat.h>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000028#include <system_error>
Chris Lattner84b94f72008-08-17 01:35:29 +000029
NAKAMURA Takumi212c80a2013-07-17 02:21:10 +000030// <fcntl.h> may provide O_BINARY.
31#if defined(HAVE_FCNTL_H)
32# include <fcntl.h>
33#endif
34
Chris Lattnerd564f292008-08-22 15:45:00 +000035#if defined(HAVE_UNISTD_H)
36# include <unistd.h>
37#endif
Daniel Dunbar4fed8872011-02-03 03:32:32 +000038#if defined(HAVE_SYS_UIO_H) && defined(HAVE_WRITEV)
39# include <sys/uio.h>
40#endif
Argyrios Kyrtzidisb97ff822008-08-17 09:25:21 +000041
NAKAMURA Takumife84f392010-10-19 01:21:55 +000042#if defined(__CYGWIN__)
43#include <io.h>
44#endif
45
Argyrios Kyrtzidisb97ff822008-08-17 09:25:21 +000046#if defined(_MSC_VER)
Chris Lattner84b94f72008-08-17 01:35:29 +000047#include <io.h>
Owen Anderson93719642008-08-21 00:14:44 +000048#ifndef STDIN_FILENO
49# define STDIN_FILENO 0
50#endif
51#ifndef STDOUT_FILENO
52# define STDOUT_FILENO 1
53#endif
54#ifndef STDERR_FILENO
55# define STDERR_FILENO 2
56#endif
Chris Lattner84b94f72008-08-17 01:35:29 +000057#endif
58
Chris Lattnerd564f292008-08-22 15:45:00 +000059using namespace llvm;
60
Dan Gohman58fcef92009-07-15 23:25:33 +000061raw_ostream::~raw_ostream() {
Dan Gohman1b763292009-07-27 20:49:44 +000062 // raw_ostream's subclasses should take care to flush the buffer
63 // in their destructors.
64 assert(OutBufCur == OutBufStart &&
65 "raw_ostream destructor called with non-empty buffer!");
66
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000067 if (BufferMode == InternalBuffer)
68 delete [] OutBufStart;
Dan Gohman58fcef92009-07-15 23:25:33 +000069}
Chris Lattnerd564f292008-08-22 15:45:00 +000070
Chris Lattner84b94f72008-08-17 01:35:29 +000071// An out of line virtual method to provide a home for the class vtable.
72void raw_ostream::handle() {}
73
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +000074size_t raw_ostream::preferred_buffer_size() const {
Dan Gohman84487b92009-08-13 17:27:29 +000075 // BUFSIZ is intended to be a reasonable default.
76 return BUFSIZ;
77}
78
79void raw_ostream::SetBuffered() {
80 // Ask the subclass to determine an appropriate buffer size.
Dan Gohman17710222009-08-15 02:05:19 +000081 if (size_t Size = preferred_buffer_size())
82 SetBufferSize(Size);
83 else
84 // It may return 0, meaning this stream should be unbuffered.
85 SetUnbuffered();
Dan Gohman84487b92009-08-13 17:27:29 +000086}
87
Dan Gohmanb452d4e2010-03-24 19:38:02 +000088void raw_ostream::SetBufferAndMode(char *BufferStart, size_t Size,
Nick Lewycky7bfd86d2011-08-28 03:30:02 +000089 BufferKind Mode) {
Craig Topper2617dcc2014-04-15 06:32:26 +000090 assert(((Mode == Unbuffered && !BufferStart && Size == 0) ||
91 (Mode != Unbuffered && BufferStart && Size != 0)) &&
Daniel Dunbar316b4a02009-09-15 20:31:46 +000092 "stream must be unbuffered or have at least one byte");
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000093 // Make sure the current buffer is free of content (we can't flush here; the
94 // child buffer management logic will be in write_impl).
95 assert(GetNumBytesInBuffer() == 0 && "Current buffer is non-empty!");
Dan Gohman54401d42009-08-13 15:58:55 +000096
Daniel Dunbar317a6cd2009-08-18 23:42:36 +000097 if (BufferMode == InternalBuffer)
98 delete [] OutBufStart;
99 OutBufStart = BufferStart;
Dan Gohman54401d42009-08-13 15:58:55 +0000100 OutBufEnd = OutBufStart+Size;
101 OutBufCur = OutBufStart;
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000102 BufferMode = Mode;
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000103
104 assert(OutBufStart <= OutBufEnd && "Invalid size!");
Dan Gohman54401d42009-08-13 15:58:55 +0000105}
106
Owen Andersond2850532008-08-21 20:58:52 +0000107raw_ostream &raw_ostream::operator<<(unsigned long N) {
108 // Zero is a special case.
109 if (N == 0)
110 return *this << '0';
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000111
Owen Andersond2850532008-08-21 20:58:52 +0000112 char NumberBuffer[20];
113 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
114 char *CurPtr = EndPtr;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000115
Owen Andersond2850532008-08-21 20:58:52 +0000116 while (N) {
117 *--CurPtr = '0' + char(N % 10);
118 N /= 10;
119 }
120 return write(CurPtr, EndPtr-CurPtr);
121}
122
123raw_ostream &raw_ostream::operator<<(long N) {
124 if (N < 0) {
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000125 *this << '-';
Eli Friedman53ba2082011-10-13 22:49:56 +0000126 // Avoid undefined behavior on LONG_MIN with a cast.
127 N = -(unsigned long)N;
Owen Andersond2850532008-08-21 20:58:52 +0000128 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000129
Owen Andersond2850532008-08-21 20:58:52 +0000130 return this->operator<<(static_cast<unsigned long>(N));
131}
132
133raw_ostream &raw_ostream::operator<<(unsigned long long N) {
Daniel Dunbar465de3e2009-08-19 16:25:25 +0000134 // Output using 32-bit div/mod when possible.
Daniel Dunbara94f58a2009-07-29 06:45:14 +0000135 if (N == static_cast<unsigned long>(N))
136 return this->operator<<(static_cast<unsigned long>(N));
137
Daniel Dunbar465de3e2009-08-19 16:25:25 +0000138 char NumberBuffer[20];
139 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
140 char *CurPtr = EndPtr;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000141
Daniel Dunbar465de3e2009-08-19 16:25:25 +0000142 while (N) {
143 *--CurPtr = '0' + char(N % 10);
144 N /= 10;
145 }
146 return write(CurPtr, EndPtr-CurPtr);
Owen Andersond2850532008-08-21 20:58:52 +0000147}
148
149raw_ostream &raw_ostream::operator<<(long long N) {
Chris Lattner3db3bb02010-08-03 16:41:24 +0000150 if (N < 0) {
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000151 *this << '-';
Chris Lattner3db3bb02010-08-03 16:41:24 +0000152 // Avoid undefined behavior on INT64_MIN with a cast.
153 N = -(unsigned long long)N;
Owen Andersond2850532008-08-21 20:58:52 +0000154 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000155
Owen Andersond2850532008-08-21 20:58:52 +0000156 return this->operator<<(static_cast<unsigned long long>(N));
157}
158
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000159raw_ostream &raw_ostream::write_hex(unsigned long long N) {
Daniel Dunbar87862182009-03-16 22:08:44 +0000160 // Zero is a special case.
161 if (N == 0)
162 return *this << '0';
163
164 char NumberBuffer[20];
165 char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
166 char *CurPtr = EndPtr;
167
168 while (N) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000169 uintptr_t x = N % 16;
Daniel Dunbar87862182009-03-16 22:08:44 +0000170 *--CurPtr = (x < 10 ? '0' + x : 'a' + x - 10);
171 N /= 16;
172 }
173
174 return write(CurPtr, EndPtr-CurPtr);
Chris Lattner0c19df42008-08-23 22:23:09 +0000175}
176
Daniel Dunbar65dc8912010-11-27 07:59:50 +0000177raw_ostream &raw_ostream::write_escaped(StringRef Str,
178 bool UseHexEscapes) {
Daniel Dunbar4108c432009-10-17 20:43:08 +0000179 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
180 unsigned char c = Str[i];
181
182 switch (c) {
183 case '\\':
184 *this << '\\' << '\\';
185 break;
186 case '\t':
187 *this << '\\' << 't';
188 break;
189 case '\n':
190 *this << '\\' << 'n';
191 break;
192 case '"':
193 *this << '\\' << '"';
194 break;
195 default:
196 if (std::isprint(c)) {
197 *this << c;
198 break;
199 }
200
Daniel Dunbar65dc8912010-11-27 07:59:50 +0000201 // Write out the escaped representation.
202 if (UseHexEscapes) {
203 *this << '\\' << 'x';
204 *this << hexdigit((c >> 4 & 0xF));
205 *this << hexdigit((c >> 0) & 0xF);
206 } else {
207 // Always use a full 3-character octal escape.
208 *this << '\\';
209 *this << char('0' + ((c >> 6) & 7));
210 *this << char('0' + ((c >> 3) & 7));
211 *this << char('0' + ((c >> 0) & 7));
212 }
Daniel Dunbar4108c432009-10-17 20:43:08 +0000213 }
214 }
215
216 return *this;
217}
218
Daniel Dunbar6c9629b2009-07-30 18:21:23 +0000219raw_ostream &raw_ostream::operator<<(const void *P) {
220 *this << '0' << 'x';
221
222 return write_hex((uintptr_t) P);
223}
224
Chris Lattner06fa1762009-08-24 03:52:50 +0000225raw_ostream &raw_ostream::operator<<(double N) {
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000226#ifdef _WIN32
227 // On MSVCRT and compatible, output of %e is incompatible to Posix
228 // by default. Number of exponent digits should be at least 2. "%+03d"
229 // FIXME: Implement our formatter to here or Support/Format.h!
NAKAMURA Takumi79addb82014-01-12 14:44:46 +0000230#if __cplusplus >= 201103L && defined(__MINGW32__)
231 // FIXME: It should be generic to C++11.
232 if (N == 0.0 && std::signbit(N))
233 return *this << "-0.000000e+00";
234#else
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000235 int fpcl = _fpclass(N);
236
237 // negative zero
238 if (fpcl == _FPCLASS_NZ)
239 return *this << "-0.000000e+00";
NAKAMURA Takumi79addb82014-01-12 14:44:46 +0000240#endif
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000241
242 char buf[16];
243 unsigned len;
244 len = snprintf(buf, sizeof(buf), "%e", N);
245 if (len <= sizeof(buf) - 2) {
246 if (len >= 5 && buf[len - 5] == 'e' && buf[len - 3] == '0') {
247 int cs = buf[len - 4];
248 if (cs == '+' || cs == '-') {
249 int c1 = buf[len - 2];
250 int c0 = buf[len - 1];
Guy Benyei83c74e92013-02-12 21:21:59 +0000251 if (isdigit(static_cast<unsigned char>(c1)) &&
252 isdigit(static_cast<unsigned char>(c0))) {
NAKAMURA Takumibac0d762011-03-18 09:30:10 +0000253 // Trim leading '0': "...e+012" -> "...e+12\0"
254 buf[len - 3] = c1;
255 buf[len - 2] = c0;
256 buf[--len] = 0;
257 }
258 }
259 }
260 return this->operator<<(buf);
261 }
262#endif
Benjamin Kramer6bee24a2010-01-29 14:40:33 +0000263 return this->operator<<(format("%e", N));
Chris Lattner06fa1762009-08-24 03:52:50 +0000264}
265
266
267
Daniel Dunbard24535f2009-03-16 22:55:06 +0000268void raw_ostream::flush_nonempty() {
269 assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000270 size_t Length = OutBufCur - OutBufStart;
271 OutBufCur = OutBufStart;
272 write_impl(OutBufStart, Length);
Daniel Dunbard24535f2009-03-16 22:55:06 +0000273}
274
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000275raw_ostream &raw_ostream::write(unsigned char C) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000276 // Group exceptional cases into a single branch.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000277 if (LLVM_UNLIKELY(OutBufCur >= OutBufEnd)) {
278 if (LLVM_UNLIKELY(!OutBufStart)) {
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000279 if (BufferMode == Unbuffered) {
Dan Gohman23f90c12009-08-18 20:09:59 +0000280 write_impl(reinterpret_cast<char*>(&C), 1);
281 return *this;
282 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000283 // Set up a buffer and start over.
284 SetBuffered();
285 return write(C);
Dan Gohman23f90c12009-08-18 20:09:59 +0000286 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000287
288 flush_nonempty();
Daniel Dunbar2d603da2009-03-17 01:13:35 +0000289 }
290
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000291 *OutBufCur++ = C;
Daniel Dunbar87862182009-03-16 22:08:44 +0000292 return *this;
Daniel Dunbar7a9bb9e2009-03-16 22:00:17 +0000293}
Chris Lattner0c19df42008-08-23 22:23:09 +0000294
Dan Gohmanf199ad62009-07-16 15:24:40 +0000295raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000296 // Group exceptional cases into a single branch.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000297 if (LLVM_UNLIKELY(size_t(OutBufEnd - OutBufCur) < Size)) {
298 if (LLVM_UNLIKELY(!OutBufStart)) {
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000299 if (BufferMode == Unbuffered) {
Dan Gohman52022c22009-08-13 15:44:52 +0000300 write_impl(Ptr, Size);
301 return *this;
302 }
303 // Set up a buffer and start over.
Dan Gohman84487b92009-08-13 17:27:29 +0000304 SetBuffered();
Dan Gohman52022c22009-08-13 15:44:52 +0000305 return write(Ptr, Size);
306 }
Daniel Dunbar0cf16862009-08-19 00:23:39 +0000307
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000308 size_t NumBytes = OutBufEnd - OutBufCur;
309
Benjamin Krameracf08422011-03-04 18:18:16 +0000310 // If the buffer is empty at this point we have a string that is larger
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000311 // than the buffer. Directly write the chunk that is a multiple of the
312 // preferred buffer size and put the remainder in the buffer.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000313 if (LLVM_UNLIKELY(OutBufCur == OutBufStart)) {
Benjamin Kramerdfb0ad32011-03-04 19:49:30 +0000314 size_t BytesToWrite = Size - (Size % NumBytes);
315 write_impl(Ptr, BytesToWrite);
Matt Beaumont-Gaya182be82013-03-12 23:55:24 +0000316 size_t BytesRemaining = Size - BytesToWrite;
317 if (BytesRemaining > size_t(OutBufEnd - OutBufCur)) {
318 // Too much left over to copy into our buffer.
319 return write(Ptr + BytesToWrite, BytesRemaining);
320 }
321 copy_to_buffer(Ptr + BytesToWrite, BytesRemaining);
Benjamin Krameracf08422011-03-04 18:18:16 +0000322 return *this;
323 }
324
325 // We don't have enough space in the buffer to fit the string in. Insert as
326 // much as possible, flush and start over with the remainder.
Benjamin Krameracf08422011-03-04 18:18:16 +0000327 copy_to_buffer(Ptr, NumBytes);
328 flush_nonempty();
329 return write(Ptr + NumBytes, Size - NumBytes);
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000330 }
Dan Gohman52022c22009-08-13 15:44:52 +0000331
332 copy_to_buffer(Ptr, Size);
333
334 return *this;
335}
336
337void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
Dan Gohmanc04a00a2009-08-13 20:32:03 +0000338 assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
Dan Gohman98205552009-08-13 18:38:15 +0000339
Owen Andersond2850532008-08-21 20:58:52 +0000340 // Handle short strings specially, memcpy isn't very good at very short
341 // strings.
342 switch (Size) {
343 case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
344 case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
345 case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
346 case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
347 case 0: break;
348 default:
Dan Gohman52022c22009-08-13 15:44:52 +0000349 memcpy(OutBufCur, Ptr, Size);
Owen Andersond2850532008-08-21 20:58:52 +0000350 break;
351 }
Daniel Dunbar3da6a702009-03-10 16:21:55 +0000352
Dan Gohman52022c22009-08-13 15:44:52 +0000353 OutBufCur += Size;
Owen Andersond2850532008-08-21 20:58:52 +0000354}
355
Chris Lattner22b52c92008-08-23 19:23:10 +0000356// Formatted output.
357raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
Daniel Dunbar64fa3862009-03-17 01:36:56 +0000358 // If we have more than a few bytes left in our output buffer, try
359 // formatting directly onto its end.
Dan Gohmanf199ad62009-07-16 15:24:40 +0000360 size_t NextBufferSize = 127;
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000361 size_t BufferBytesLeft = OutBufEnd - OutBufCur;
362 if (BufferBytesLeft > 3) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000363 size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000364
Chris Lattner22b52c92008-08-23 19:23:10 +0000365 // Common case is that we have plenty of space.
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000366 if (BytesUsed <= BufferBytesLeft) {
Chris Lattner22b52c92008-08-23 19:23:10 +0000367 OutBufCur += BytesUsed;
368 return *this;
369 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000370
Chris Lattner22b52c92008-08-23 19:23:10 +0000371 // Otherwise, we overflowed and the return value tells us the size to try
372 // again with.
373 NextBufferSize = BytesUsed;
374 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000375
Chris Lattner22b52c92008-08-23 19:23:10 +0000376 // If we got here, we didn't have enough space in the output buffer for the
377 // string. Try printing into a SmallVector that is resized to have enough
378 // space. Iterate until we win.
379 SmallVector<char, 128> V;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000380
Chris Lattner22b52c92008-08-23 19:23:10 +0000381 while (1) {
382 V.resize(NextBufferSize);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000383
Chris Lattner22b52c92008-08-23 19:23:10 +0000384 // Try formatting into the SmallVector.
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000385 size_t BytesUsed = Fmt.print(V.data(), NextBufferSize);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000386
Chris Lattner22b52c92008-08-23 19:23:10 +0000387 // If BytesUsed fit into the vector, we win.
Chris Lattner2bfc72e2008-10-26 19:20:47 +0000388 if (BytesUsed <= NextBufferSize)
Daniel Dunbar47a309c2009-08-23 20:31:39 +0000389 return write(V.data(), BytesUsed);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000390
Chris Lattner22b52c92008-08-23 19:23:10 +0000391 // Otherwise, try again with a new size.
392 assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
393 NextBufferSize = BytesUsed;
394 }
395}
396
Chris Lattnere6db2c32009-08-22 23:10:29 +0000397/// indent - Insert 'NumSpaces' spaces.
398raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
Dan Gohmanf88f52e2009-08-24 04:13:01 +0000399 static const char Spaces[] = " "
400 " "
401 " ";
Chris Lattnere6db2c32009-08-22 23:10:29 +0000402
403 // Usually the indentation is small, handle it with a fastpath.
Dan Gohmanc9fa0512009-08-24 04:43:38 +0000404 if (NumSpaces < array_lengthof(Spaces))
Chris Lattnere6db2c32009-08-22 23:10:29 +0000405 return write(Spaces, NumSpaces);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000406
Chris Lattnere6db2c32009-08-22 23:10:29 +0000407 while (NumSpaces) {
Dan Gohmanc9fa0512009-08-24 04:43:38 +0000408 unsigned NumToWrite = std::min(NumSpaces,
409 (unsigned)array_lengthof(Spaces)-1);
Chris Lattnere6db2c32009-08-22 23:10:29 +0000410 write(Spaces, NumToWrite);
411 NumSpaces -= NumToWrite;
412 }
413 return *this;
414}
415
416
Chris Lattner22b52c92008-08-23 19:23:10 +0000417//===----------------------------------------------------------------------===//
418// Formatted Output
419//===----------------------------------------------------------------------===//
420
421// Out of line virtual method.
422void format_object_base::home() {
423}
424
Chris Lattner84b94f72008-08-17 01:35:29 +0000425//===----------------------------------------------------------------------===//
426// raw_fd_ostream
427//===----------------------------------------------------------------------===//
428
Daniel Dunbar1ca20df2008-10-21 19:53:10 +0000429/// raw_fd_ostream - Open the specified file for writing. If an error
430/// occurs, information about the error is put into ErrorInfo, and the
431/// stream should be immediately destroyed; the string will be empty
432/// if no error occurred.
Ben Langmuir27a58bf2014-02-27 02:09:10 +0000433raw_fd_ostream::raw_fd_ostream(const char *Filename, std::string &ErrorInfo,
Rafael Espindola6d354812013-07-16 19:44:17 +0000434 sys::fs::OpenFlags Flags)
435 : Error(false), UseAtomicWrites(false), pos(0) {
Craig Topper2617dcc2014-04-15 06:32:26 +0000436 assert(Filename && "Filename is null");
Daniel Dunbar1ca20df2008-10-21 19:53:10 +0000437 ErrorInfo.clear();
438
Dan Gohmanc825cee2010-08-18 22:26:19 +0000439 // Handle "-" as stdout. Note that when we do this, we consider ourself
440 // the owner of stdout. This means that we can do things like close the
441 // file descriptor when we're done and set the "binary" flag globally.
Ben Langmuir27a58bf2014-02-27 02:09:10 +0000442 if (Filename[0] == '-' && Filename[1] == 0) {
Chris Lattnerd5bc0682008-08-17 03:53:23 +0000443 FD = STDOUT_FILENO;
Daniel Dunbared90e702008-11-13 05:01:07 +0000444 // If user requested binary then put stdout into binary mode if
445 // possible.
Rafael Espindola90c7f1c2014-02-24 18:20:12 +0000446 if (!(Flags & sys::fs::F_Text))
Rafael Espindolacb2eca02013-06-12 20:58:35 +0000447 sys::ChangeStdoutToBinary();
Dan Gohmanc825cee2010-08-18 22:26:19 +0000448 // Close stdout when we're done, to detect any output errors.
449 ShouldClose = true;
Chris Lattnerd5bc0682008-08-17 03:53:23 +0000450 return;
451 }
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000452
Rafael Espindola3acea392014-06-12 21:46:39 +0000453 std::error_code EC = sys::fs::openFileForWrite(Filename, FD, Flags);
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000454
Rafael Espindola6d354812013-07-16 19:44:17 +0000455 if (EC) {
Benjamin Kramer8f5d4252013-10-03 16:59:14 +0000456 ErrorInfo = "Error opening output file '" + std::string(Filename) + "': " +
457 EC.message();
Rafael Espindola6d354812013-07-16 19:44:17 +0000458 ShouldClose = false;
459 return;
Chris Lattner84b94f72008-08-17 01:35:29 +0000460 }
Dan Gohmand3511162010-05-06 02:06:20 +0000461
462 // Ok, we successfully opened the file, so it'll need to be closed.
463 ShouldClose = true;
Chris Lattner84b94f72008-08-17 01:35:29 +0000464}
465
Francois Picheta3037c32010-10-14 20:30:58 +0000466/// raw_fd_ostream ctor - FD is the file descriptor that this writes to. If
467/// ShouldClose is true, this closes the file when the stream is destroyed.
468raw_fd_ostream::raw_fd_ostream(int fd, bool shouldClose, bool unbuffered)
469 : raw_ostream(unbuffered), FD(fd),
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000470 ShouldClose(shouldClose), Error(false), UseAtomicWrites(false) {
Francois Picheta3037c32010-10-14 20:30:58 +0000471#ifdef O_BINARY
NAKAMURA Takumi4961f7a2014-01-12 16:14:24 +0000472 // Setting STDOUT to binary mode is necessary in Win32
Francois Picheta3037c32010-10-14 20:30:58 +0000473 // to avoid undesirable linefeed conversion.
NAKAMURA Takumi4961f7a2014-01-12 16:14:24 +0000474 // Don't touch STDERR, or w*printf() (in assert()) would barf wide chars.
475 if (fd == STDOUT_FILENO)
Francois Picheta3037c32010-10-14 20:30:58 +0000476 setmode(fd, O_BINARY);
477#endif
Michael J. Spencerb7479902011-01-17 15:53:12 +0000478
479 // Get the starting position.
480 off_t loc = ::lseek(FD, 0, SEEK_CUR);
481 if (loc == (off_t)-1)
482 pos = 0;
483 else
484 pos = static_cast<uint64_t>(loc);
Francois Picheta3037c32010-10-14 20:30:58 +0000485}
486
Chris Lattner84b94f72008-08-17 01:35:29 +0000487raw_fd_ostream::~raw_fd_ostream() {
Dan Gohman38adfdd2010-08-20 16:34:20 +0000488 if (FD >= 0) {
489 flush();
490 if (ShouldClose)
491 while (::close(FD) != 0)
492 if (errno != EINTR) {
493 error_detected();
494 break;
495 }
496 }
497
NAKAMURA Takumi76e68ea2011-03-16 02:53:39 +0000498#ifdef __MINGW32__
499 // On mingw, global dtors should not call exit().
500 // report_fatal_error() invokes exit(). We know report_fatal_error()
501 // might not write messages to stderr when any errors were detected
502 // on FD == 2.
503 if (FD == 2) return;
504#endif
505
Dan Gohman38adfdd2010-08-20 16:34:20 +0000506 // If there are any pending errors, report them now. Clients wishing
507 // to avoid report_fatal_error calls should check for errors with
508 // has_error() and clear the error flag with clear_error() before
509 // destructing raw_ostream objects which may have errors.
510 if (has_error())
Chad Rosier7ce810c2013-03-27 18:30:00 +0000511 report_fatal_error("IO failure on output stream.", /*GenCrashDiag=*/false);
Chris Lattnerce3b2c32010-08-17 23:11:56 +0000512}
Chris Lattner9e6f1f12009-08-23 02:51:22 +0000513
Dan Gohman44790e72010-08-18 01:34:52 +0000514
Dan Gohmanf199ad62009-07-16 15:24:40 +0000515void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000516 assert(FD >= 0 && "File already closed.");
Daniel Dunbardb7a36c2009-03-16 23:29:31 +0000517 pos += Size;
Dan Gohmanef969f32010-05-06 01:27:36 +0000518
Benjamin Kramerce84a252010-05-05 15:17:47 +0000519 do {
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000520 ssize_t ret;
521
522 // Check whether we should attempt to use atomic writes.
Benjamin Kramerbd7f8d02012-08-29 22:57:00 +0000523 if (LLVM_LIKELY(!UseAtomicWrites)) {
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000524 ret = ::write(FD, Ptr, Size);
525 } else {
526 // Use ::writev() where available.
527#if defined(HAVE_WRITEV)
Galina Kistanova7da65782012-07-12 20:45:36 +0000528 const void *Addr = static_cast<const void *>(Ptr);
529 struct iovec IOV = {const_cast<void *>(Addr), Size };
Daniel Dunbar4fed8872011-02-03 03:32:32 +0000530 ret = ::writev(FD, &IOV, 1);
531#else
532 ret = ::write(FD, Ptr, Size);
533#endif
534 }
Dan Gohmanef969f32010-05-06 01:27:36 +0000535
536 if (ret < 0) {
537 // If it's a recoverable error, swallow it and retry the write.
Dan Gohmandea53102010-05-18 15:25:14 +0000538 //
539 // Ideally we wouldn't ever see EAGAIN or EWOULDBLOCK here, since
540 // raw_ostream isn't designed to do non-blocking I/O. However, some
541 // programs, such as old versions of bjam, have mistakenly used
542 // O_NONBLOCK. For compatibility, emulate blocking semantics by
543 // spinning until the write succeeds. If you don't want spinning,
544 // don't use O_NONBLOCK file descriptors with raw_ostream.
Dan Gohmand3511162010-05-06 02:06:20 +0000545 if (errno == EINTR || errno == EAGAIN
546#ifdef EWOULDBLOCK
547 || errno == EWOULDBLOCK
548#endif
549 )
Dan Gohmanef969f32010-05-06 01:27:36 +0000550 continue;
551
552 // Otherwise it's a non-recoverable error. Note it and quit.
553 error_detected();
554 break;
555 }
556
557 // The write may have written some or all of the data. Update the
558 // size and buffer pointer to reflect the remainder that needs
559 // to be written. If there are no bytes left, we're done.
560 Ptr += ret;
561 Size -= ret;
562 } while (Size > 0);
Chris Lattner84b94f72008-08-17 01:35:29 +0000563}
564
Dan Gohman44790e72010-08-18 01:34:52 +0000565void raw_fd_ostream::close() {
566 assert(ShouldClose);
567 ShouldClose = false;
568 flush();
569 while (::close(FD) != 0)
570 if (errno != EINTR) {
571 error_detected();
572 break;
573 }
574 FD = -1;
575}
576
Ted Kremeneka2669922009-01-26 21:42:04 +0000577uint64_t raw_fd_ostream::seek(uint64_t off) {
578 flush();
Daniel Dunbardcb50b92009-07-15 08:11:46 +0000579 pos = ::lseek(FD, off, SEEK_SET);
Dan Gohman213e87b2009-07-15 16:43:01 +0000580 if (pos != off)
Dan Gohman58fcef92009-07-15 23:25:33 +0000581 error_detected();
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000582 return pos;
Ted Kremeneka2669922009-01-26 21:42:04 +0000583}
584
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000585size_t raw_fd_ostream::preferred_buffer_size() const {
Chris Lattnerca97c922010-07-07 15:52:27 +0000586#if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(__minix)
Chris Lattnerc86cdc72010-04-09 20:45:04 +0000587 // Windows and Minix have no st_blksize.
Dan Gohman84487b92009-08-13 17:27:29 +0000588 assert(FD >= 0 && "File not yet open!");
589 struct stat statbuf;
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000590 if (fstat(FD, &statbuf) != 0)
591 return 0;
Dan Gohmanb452d4e2010-03-24 19:38:02 +0000592
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000593 // If this is a terminal, don't use buffering. Line buffering
594 // would be a more traditional thing to do, but it's not worth
595 // the complexity.
596 if (S_ISCHR(statbuf.st_mode) && isatty(FD))
597 return 0;
598 // Return the preferred block size.
599 return statbuf.st_blksize;
Dan Gohmanfeaeb362010-05-28 16:50:01 +0000600#else
Dan Gohman84487b92009-08-13 17:27:29 +0000601 return raw_ostream::preferred_buffer_size();
Dan Gohmanfeaeb362010-05-28 16:50:01 +0000602#endif
Dan Gohman84487b92009-08-13 17:27:29 +0000603}
604
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000605raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
606 bool bg) {
607 if (sys::Process::ColorNeedsFlush())
608 flush();
609 const char *colorcode =
610 (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
611 : sys::Process::OutputColor(colors, bold, bg);
612 if (colorcode) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000613 size_t len = strlen(colorcode);
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000614 write(colorcode, len);
615 // don't account colors towards output characters
616 pos -= len;
617 }
618 return *this;
619}
620
621raw_ostream &raw_fd_ostream::resetColor() {
622 if (sys::Process::ColorNeedsFlush())
623 flush();
624 const char *colorcode = sys::Process::ResetColor();
625 if (colorcode) {
Dan Gohmanf199ad62009-07-16 15:24:40 +0000626 size_t len = strlen(colorcode);
Torok Edwin9b5a47f2009-06-04 07:09:50 +0000627 write(colorcode, len);
628 // don't account colors towards output characters
629 pos -= len;
630 }
631 return *this;
632}
633
Benjamin Kramer13d16f32012-04-16 08:56:50 +0000634raw_ostream &raw_fd_ostream::reverseColor() {
635 if (sys::Process::ColorNeedsFlush())
636 flush();
637 const char *colorcode = sys::Process::OutputReverse();
638 if (colorcode) {
639 size_t len = strlen(colorcode);
640 write(colorcode, len);
641 // don't account colors towards output characters
642 pos -= len;
643 }
644 return *this;
645}
646
Dan Gohmane5929232009-09-11 20:46:33 +0000647bool raw_fd_ostream::is_displayed() const {
648 return sys::Process::FileDescriptorIsDisplayed(FD);
649}
650
Daniel Dunbar04b45832012-07-20 18:29:41 +0000651bool raw_fd_ostream::has_colors() const {
652 return sys::Process::FileDescriptorHasColors(FD);
653}
654
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000655//===----------------------------------------------------------------------===//
Dan Gohmane9a46912010-08-20 16:44:56 +0000656// outs(), errs(), nulls()
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000657//===----------------------------------------------------------------------===//
Chris Lattner84b94f72008-08-17 01:35:29 +0000658
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000659/// outs() - This returns a reference to a raw_ostream for standard output.
660/// Use it like: outs() << "foo" << "bar";
Owen Anderson93719642008-08-21 00:14:44 +0000661raw_ostream &llvm::outs() {
Dan Gohman443f2d62010-08-20 16:39:41 +0000662 // Set buffer settings to model stdout behavior.
Dan Gohmane9a46912010-08-20 16:44:56 +0000663 // Delete the file descriptor when the program exists, forcing error
664 // detection. If you don't want this behavior, don't use outs().
665 static raw_fd_ostream S(STDOUT_FILENO, true);
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000666 return S;
667}
668
669/// errs() - This returns a reference to a raw_ostream for standard error.
670/// Use it like: errs() << "foo" << "bar";
Owen Anderson93719642008-08-21 00:14:44 +0000671raw_ostream &llvm::errs() {
Dan Gohman443f2d62010-08-20 16:39:41 +0000672 // Set standard error to be unbuffered by default.
673 static raw_fd_ostream S(STDERR_FILENO, false, true);
Chris Lattnerd3723fc2008-08-17 04:13:37 +0000674 return S;
675}
676
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000677/// nulls() - This returns a reference to a raw_ostream which discards output.
678raw_ostream &llvm::nulls() {
679 static raw_null_ostream S;
680 return S;
681}
682
Douglas Gregorb231e572009-04-20 07:34:17 +0000683
Chris Lattner205af962008-08-23 22:43:04 +0000684//===----------------------------------------------------------------------===//
685// raw_string_ostream
686//===----------------------------------------------------------------------===//
687
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000688raw_string_ostream::~raw_string_ostream() {
689 flush();
690}
691
Dan Gohmanf199ad62009-07-16 15:24:40 +0000692void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
Daniel Dunbardb7a36c2009-03-16 23:29:31 +0000693 OS.append(Ptr, Size);
Chris Lattner205af962008-08-23 22:43:04 +0000694}
695
696//===----------------------------------------------------------------------===//
697// raw_svector_ostream
698//===----------------------------------------------------------------------===//
699
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000700// The raw_svector_ostream implementation uses the SmallVector itself as the
701// buffer for the raw_ostream. We guarantee that the raw_ostream buffer is
702// always pointing past the end of the vector, but within the vector
703// capacity. This allows raw_ostream to write directly into the correct place,
704// and we only need to set the vector size when the data is flushed.
705
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000706raw_svector_ostream::raw_svector_ostream(SmallVectorImpl<char> &O) : OS(O) {
Daniel Dunbare813cba2009-08-19 18:40:58 +0000707 // Set up the initial external buffer. We make sure that the buffer has at
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000708 // least 128 bytes free; raw_ostream itself only requires 64, but we want to
709 // make sure that we don't grow the buffer unnecessarily on destruction (when
710 // the data is flushed). See the FIXME below.
Daniel Dunbare813cba2009-08-19 18:40:58 +0000711 OS.reserve(OS.size() + 128);
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000712 SetBuffer(OS.end(), OS.capacity() - OS.size());
Daniel Dunbar317a6cd2009-08-18 23:42:36 +0000713}
714
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000715raw_svector_ostream::~raw_svector_ostream() {
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000716 // FIXME: Prevent resizing during this flush().
Daniel Dunbard882f4b2009-08-18 20:07:36 +0000717 flush();
718}
719
Chris Lattner1386a882010-01-22 21:16:10 +0000720/// resync - This is called when the SmallVector we're appending to is changed
721/// outside of the raw_svector_ostream's control. It is only safe to do this
722/// if the raw_svector_ostream has previously been flushed.
723void raw_svector_ostream::resync() {
724 assert(GetNumBytesInBuffer() == 0 && "Didn't flush before mutating vector");
725
726 if (OS.capacity() - OS.size() < 64)
727 OS.reserve(OS.capacity() * 2);
Chris Lattner8fa0e352010-01-22 19:17:48 +0000728 SetBuffer(OS.end(), OS.capacity() - OS.size());
729}
730
Dan Gohmanf199ad62009-07-16 15:24:40 +0000731void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
Alp Tokerbc4d1a32014-07-11 14:02:04 +0000732 size_t NewSize = OS.size() + Size;
733 size_t NewReservation = NewSize + 64;
734
735 bool NoOverlap = Ptr + Size < OS.begin() || Ptr > OS.begin() + OS.capacity();
736
737 if (NoOverlap) {
738 assert(!GetNumBytesInBuffer());
739 OS.reserve(NewReservation);
740 memcpy(OS.end(), Ptr, Size);
741 OS.set_size(NewSize);
742 } else if (Ptr == OS.end()) {
743 // Grow the buffer to include the scratch area without copying.
744 assert(NewSize <= OS.capacity() && "Invalid write_impl() call!");
745 OS.set_size(NewSize);
746 OS.reserve(NewReservation);
Chris Lattner115158f2010-02-15 02:18:26 +0000747 } else {
Alp Tokerbc4d1a32014-07-11 14:02:04 +0000748 OS.append(Ptr, Ptr + Size);
749 OS.reserve(NewReservation);
Chris Lattner115158f2010-02-15 02:18:26 +0000750 }
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000751
Daniel Dunbarb090bf42009-08-19 17:54:29 +0000752 SetBuffer(OS.end(), OS.capacity() - OS.size());
Chris Lattner205af962008-08-23 22:43:04 +0000753}
754
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000755uint64_t raw_svector_ostream::current_pos() const {
756 return OS.size();
757}
Douglas Gregorb231e572009-04-20 07:34:17 +0000758
Daniel Dunbare813cba2009-08-19 18:40:58 +0000759StringRef raw_svector_ostream::str() {
760 flush();
761 return StringRef(OS.begin(), OS.size());
762}
763
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000764//===----------------------------------------------------------------------===//
765// raw_null_ostream
766//===----------------------------------------------------------------------===//
767
Dan Gohman4b66b472009-07-27 21:46:02 +0000768raw_null_ostream::~raw_null_ostream() {
769#ifndef NDEBUG
770 // ~raw_ostream asserts that the buffer is empty. This isn't necessary
771 // with raw_null_ostream, but it's better to have raw_null_ostream follow
772 // the rules than to change the rules just for raw_null_ostream.
773 flush();
774#endif
775}
776
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000777void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
778}
779
Chris Lattnerdd3e9aa2009-12-19 01:38:42 +0000780uint64_t raw_null_ostream::current_pos() const {
Daniel Dunbar95a551a2009-07-16 21:17:53 +0000781 return 0;
782}