1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
|
//===-- Stream.cpp --------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Utility/Stream.h"
#include "lldb/Utility/Endian.h"
#include "lldb/Utility/VASPrintf.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/LEB128.h"
#include <string>
#include <cinttypes>
#include <cstddef>
using namespace lldb;
using namespace lldb_private;
Stream::Stream(uint32_t flags, uint32_t addr_size, ByteOrder byte_order,
bool colors)
: m_flags(flags), m_addr_size(addr_size), m_byte_order(byte_order),
m_forwarder(*this, colors) {}
Stream::Stream(bool colors)
: m_flags(0), m_byte_order(endian::InlHostByteOrder()),
m_forwarder(*this, colors) {}
// Destructor
Stream::~Stream() = default;
ByteOrder Stream::SetByteOrder(ByteOrder byte_order) {
ByteOrder old_byte_order = m_byte_order;
m_byte_order = byte_order;
return old_byte_order;
}
// Put an offset "uval" out to the stream using the printf format in "format".
void Stream::Offset(uint32_t uval, const char *format) { Printf(format, uval); }
// Put an SLEB128 "uval" out to the stream using the printf format in "format".
size_t Stream::PutSLEB128(int64_t sval) {
if (m_flags.Test(eBinary))
return llvm::encodeSLEB128(sval, m_forwarder);
else
return Printf("0x%" PRIi64, sval);
}
// Put an ULEB128 "uval" out to the stream using the printf format in "format".
size_t Stream::PutULEB128(uint64_t uval) {
if (m_flags.Test(eBinary))
return llvm::encodeULEB128(uval, m_forwarder);
else
return Printf("0x%" PRIx64, uval);
}
// Print a raw NULL terminated C string to the stream.
size_t Stream::PutCString(llvm::StringRef str) {
size_t bytes_written = 0;
bytes_written = Write(str.data(), str.size());
// when in binary mode, emit the NULL terminator
if (m_flags.Test(eBinary))
bytes_written += PutChar('\0');
return bytes_written;
}
// Print a double quoted NULL terminated C string to the stream using the
// printf format in "format".
void Stream::QuotedCString(const char *cstr, const char *format) {
Printf(format, cstr);
}
// Put an address "addr" out to the stream with optional prefix and suffix
// strings.
void lldb_private::DumpAddress(llvm::raw_ostream &s, uint64_t addr,
uint32_t addr_size, const char *prefix,
const char *suffix) {
if (prefix == nullptr)
prefix = "";
if (suffix == nullptr)
suffix = "";
s << prefix << llvm::format_hex(addr, 2 + 2 * addr_size) << suffix;
}
// Put an address range out to the stream with optional prefix and suffix
// strings.
void lldb_private::DumpAddressRange(llvm::raw_ostream &s, uint64_t lo_addr,
uint64_t hi_addr, uint32_t addr_size,
const char *prefix, const char *suffix) {
if (prefix && prefix[0])
s << prefix;
DumpAddress(s, lo_addr, addr_size, "[");
DumpAddress(s, hi_addr, addr_size, "-", ")");
if (suffix && suffix[0])
s << suffix;
}
size_t Stream::PutChar(char ch) { return Write(&ch, 1); }
// Print some formatted output to the stream.
size_t Stream::Printf(const char *format, ...) {
va_list args;
va_start(args, format);
size_t result = PrintfVarArg(format, args);
va_end(args);
return result;
}
// Print some formatted output to the stream.
size_t Stream::PrintfVarArg(const char *format, va_list args) {
llvm::SmallString<1024> buf;
VASprintf(buf, format, args);
// Include the NULL termination byte for binary output
size_t length = buf.size();
if (m_flags.Test(eBinary))
++length;
return Write(buf.c_str(), length);
}
// Print and End of Line character to the stream
size_t Stream::EOL() { return PutChar('\n'); }
size_t Stream::Indent(llvm::StringRef str) {
const size_t ind_length = PutCString(std::string(m_indent_level, ' '));
const size_t str_length = PutCString(str);
return ind_length + str_length;
}
// Stream a character "ch" out to this stream.
Stream &Stream::operator<<(char ch) {
PutChar(ch);
return *this;
}
// Stream the NULL terminated C string out to this stream.
Stream &Stream::operator<<(const char *s) {
Printf("%s", s);
return *this;
}
Stream &Stream::operator<<(llvm::StringRef str) {
Write(str.data(), str.size());
return *this;
}
// Stream the pointer value out to this stream.
Stream &Stream::operator<<(const void *p) {
Printf("0x%.*tx", static_cast<int>(sizeof(const void *)) * 2, (ptrdiff_t)p);
return *this;
}
// Get the current indentation level
unsigned Stream::GetIndentLevel() const { return m_indent_level; }
// Set the current indentation level
void Stream::SetIndentLevel(unsigned indent_level) {
m_indent_level = indent_level;
}
// Increment the current indentation level
void Stream::IndentMore(unsigned amount) { m_indent_level += amount; }
// Decrement the current indentation level
void Stream::IndentLess(unsigned amount) {
if (m_indent_level >= amount)
m_indent_level -= amount;
else
m_indent_level = 0;
}
// Get the address size in bytes
uint32_t Stream::GetAddressByteSize() const { return m_addr_size; }
// Set the address size in bytes
void Stream::SetAddressByteSize(uint32_t addr_size) { m_addr_size = addr_size; }
// The flags get accessor
Flags &Stream::GetFlags() { return m_flags; }
// The flags const get accessor
const Flags &Stream::GetFlags() const { return m_flags; }
// The byte order get accessor
lldb::ByteOrder Stream::GetByteOrder() const { return m_byte_order; }
size_t Stream::PrintfAsRawHex8(const char *format, ...) {
va_list args;
va_start(args, format);
llvm::SmallString<1024> buf;
VASprintf(buf, format, args);
ByteDelta delta(*this);
for (char C : buf)
_PutHex8(C, false);
va_end(args);
return *delta;
}
size_t Stream::PutNHex8(size_t n, uint8_t uvalue) {
ByteDelta delta(*this);
for (size_t i = 0; i < n; ++i)
_PutHex8(uvalue, false);
return *delta;
}
void Stream::_PutHex8(uint8_t uvalue, bool add_prefix) {
if (m_flags.Test(eBinary)) {
Write(&uvalue, 1);
} else {
if (add_prefix)
PutCString("0x");
static char g_hex_to_ascii_hex_char[16] = {'0', '1', '2', '3', '4', '5',
'6', '7', '8', '9', 'a', 'b',
'c', 'd', 'e', 'f'};
char nibble_chars[2];
nibble_chars[0] = g_hex_to_ascii_hex_char[(uvalue >> 4) & 0xf];
nibble_chars[1] = g_hex_to_ascii_hex_char[(uvalue >> 0) & 0xf];
Write(nibble_chars, sizeof(nibble_chars));
}
}
size_t Stream::PutHex8(uint8_t uvalue) {
ByteDelta delta(*this);
_PutHex8(uvalue, false);
return *delta;
}
size_t Stream::PutHex16(uint16_t uvalue, ByteOrder byte_order) {
ByteDelta delta(*this);
if (byte_order == eByteOrderInvalid)
byte_order = m_byte_order;
if (byte_order == eByteOrderLittle) {
for (size_t byte = 0; byte < sizeof(uvalue); ++byte)
_PutHex8(static_cast<uint8_t>(uvalue >> (byte * 8)), false);
} else {
for (size_t byte = sizeof(uvalue) - 1; byte < sizeof(uvalue); --byte)
_PutHex8(static_cast<uint8_t>(uvalue >> (byte * 8)), false);
}
return *delta;
}
size_t Stream::PutHex32(uint32_t uvalue, ByteOrder byte_order) {
ByteDelta delta(*this);
if (byte_order == eByteOrderInvalid)
byte_order = m_byte_order;
if (byte_order == eByteOrderLittle) {
for (size_t byte = 0; byte < sizeof(uvalue); ++byte)
_PutHex8(static_cast<uint8_t>(uvalue >> (byte * 8)), false);
} else {
for (size_t byte = sizeof(uvalue) - 1; byte < sizeof(uvalue); --byte)
_PutHex8(static_cast<uint8_t>(uvalue >> (byte * 8)), false);
}
return *delta;
}
size_t Stream::PutHex64(uint64_t uvalue, ByteOrder byte_order) {
ByteDelta delta(*this);
if (byte_order == eByteOrderInvalid)
byte_order = m_byte_order;
if (byte_order == eByteOrderLittle) {
for (size_t byte = 0; byte < sizeof(uvalue); ++byte)
_PutHex8(static_cast<uint8_t>(uvalue >> (byte * 8)), false);
} else {
for (size_t byte = sizeof(uvalue) - 1; byte < sizeof(uvalue); --byte)
_PutHex8(static_cast<uint8_t>(uvalue >> (byte * 8)), false);
}
return *delta;
}
size_t Stream::PutMaxHex64(uint64_t uvalue, size_t byte_size,
lldb::ByteOrder byte_order) {
switch (byte_size) {
case 1:
return PutHex8(static_cast<uint8_t>(uvalue));
case 2:
return PutHex16(static_cast<uint16_t>(uvalue), byte_order);
case 4:
return PutHex32(static_cast<uint32_t>(uvalue), byte_order);
case 8:
return PutHex64(uvalue, byte_order);
}
return 0;
}
size_t Stream::PutPointer(void *ptr) {
return PutRawBytes(&ptr, sizeof(ptr), endian::InlHostByteOrder(),
endian::InlHostByteOrder());
}
size_t Stream::PutFloat(float f, ByteOrder byte_order) {
if (byte_order == eByteOrderInvalid)
byte_order = m_byte_order;
return PutRawBytes(&f, sizeof(f), endian::InlHostByteOrder(), byte_order);
}
size_t Stream::PutDouble(double d, ByteOrder byte_order) {
if (byte_order == eByteOrderInvalid)
byte_order = m_byte_order;
return PutRawBytes(&d, sizeof(d), endian::InlHostByteOrder(), byte_order);
}
size_t Stream::PutLongDouble(long double ld, ByteOrder byte_order) {
if (byte_order == eByteOrderInvalid)
byte_order = m_byte_order;
return PutRawBytes(&ld, sizeof(ld), endian::InlHostByteOrder(), byte_order);
}
size_t Stream::PutRawBytes(const void *s, size_t src_len,
ByteOrder src_byte_order, ByteOrder dst_byte_order) {
ByteDelta delta(*this);
if (src_byte_order == eByteOrderInvalid)
src_byte_order = m_byte_order;
if (dst_byte_order == eByteOrderInvalid)
dst_byte_order = m_byte_order;
const uint8_t *src = static_cast<const uint8_t *>(s);
bool binary_was_set = m_flags.Test(eBinary);
if (!binary_was_set)
m_flags.Set(eBinary);
if (src_byte_order == dst_byte_order) {
for (size_t i = 0; i < src_len; ++i)
_PutHex8(src[i], false);
} else {
for (size_t i = src_len; i > 0; --i)
_PutHex8(src[i - 1], false);
}
if (!binary_was_set)
m_flags.Clear(eBinary);
return *delta;
}
size_t Stream::PutBytesAsRawHex8(const void *s, size_t src_len,
ByteOrder src_byte_order,
ByteOrder dst_byte_order) {
ByteDelta delta(*this);
if (src_byte_order == eByteOrderInvalid)
src_byte_order = m_byte_order;
if (dst_byte_order == eByteOrderInvalid)
dst_byte_order = m_byte_order;
const uint8_t *src = static_cast<const uint8_t *>(s);
bool binary_is_set = m_flags.Test(eBinary);
m_flags.Clear(eBinary);
if (src_byte_order == dst_byte_order) {
for (size_t i = 0; i < src_len; ++i)
_PutHex8(src[i], false);
} else {
for (size_t i = src_len; i > 0; --i)
_PutHex8(src[i - 1], false);
}
if (binary_is_set)
m_flags.Set(eBinary);
return *delta;
}
size_t Stream::PutStringAsRawHex8(llvm::StringRef s) {
ByteDelta delta(*this);
bool binary_is_set = m_flags.Test(eBinary);
m_flags.Clear(eBinary);
for (char c : s)
_PutHex8(c, false);
if (binary_is_set)
m_flags.Set(eBinary);
return *delta;
}
|