llvm-project/llvm/lib/Support
Greg Clayton bde0a1632b Added the ability to dump hex bytes easily into a raw_ostream.
Unit tests were added to verify this functionality keeps working correctly.

Example output for raw hex bytes:
llvm::ArrayRef<uint8_t> Bytes = ...;
llvm::outs() << format_hex_bytes(Bytes);
554889e5 4881ec70 04000048 8d051002
00004c8d 05fd0100 004c8b0d d0020000

Example output for raw hex bytes with offsets:
llvm::outs() << format_hex_bytes(Bytes, 0x100000d10);
0x0000000100000d10: 554889e5 4881ec70 04000048 8d051002
0x0000000100000d20: 00004c8d 05fd0100 004c8b0d d0020000

Example output for raw hex bytes with ASCII with offsets:
llvm::outs() << format_hex_bytes_with_ascii(Bytes, 0x100000d10);
0x0000000100000d10: 554889e5 4881ec70 04000048 8d051002 |UH.?H.?p...H....|
0x0000000100000d20: 00004c8d 05fd0100 004c8b0d d0020000 |..L..?...L..?...|

The default groups bytes into 4 byte groups, but this can be changed to 1 byte:
llvm::outs() << format_hex_bytes(Bytes, 0x100000d10, 16 /*NumPerLine*/, 1 /*ByteGroupSize*/);
0x0000000100000d10: 55 48 89 e5 48 81 ec 70 04 00 00 48 8d 05 10 02
0x0000000100000d20: 00 00 4c 8d 05 fd 01 00 00 4c 8b 0d d0 02 00 00

llvm::outs() << format_hex_bytes(Bytes, 0x100000d10, 16 /*NumPerLine*/, 2 /*ByteGroupSize*/);
0x0000000100000d10: 5548 89e5 4881 ec70 0400 0048 8d05 1002
0x0000000100000d20: 0000 4c8d 05fd 0100 004c 8b0d d002 0000

llvm::outs() << format_hex_bytes(Bytes, 0x100000d10, 8 /*NumPerLine*/, 1 /*ByteGroupSize*/);
0x0000000100000d10: 55 48 89 e5 48 81 ec 70
0x0000000100000d18: 04 00 00 48 8d 05 10 02
0x0000000100000d20: 00 00 4c 8d 05 fd 01 00
0x0000000100000d28: 00 4c 8b 0d d0 02 00 00

https://reviews.llvm.org/D26405

llvm-svn: 286316
2016-11-09 00:15:54 +00:00
..
Unix Correct mprotect page boundries to round up end page. Fixes PR30905. 2016-11-05 04:22:15 +00:00
Windows Removed FIXME from include ordering comment 2016-10-24 17:15:05 +00:00
APFloat.cpp Fix memory leaks (coverity issues 1365586 & 1365591) 2016-11-08 10:00:45 +00:00
APInt.cpp Missing includes. 2016-09-14 08:55:18 +00:00
APSInt.cpp Remove some unneeded headers and replace some headers with forward class declarations (NFC) 2016-04-16 07:51:28 +00:00
ARMBuildAttrs.cpp Use StringRef instead of raw pointers in ARMBuildAttrs (NFC) 2016-10-05 00:15:18 +00:00
ARMWinEH.cpp
Allocator.cpp
Atomic.cpp Remove all of the legacy home-grown atomic operations LLVM provided 2016-06-02 17:11:11 +00:00
BlockFrequency.cpp Add - and -= operators to BlockFrequency using saturating arithmetic. 2015-10-12 18:34:00 +00:00
BranchProbability.cpp Annotate dump() methods with LLVM_DUMP_METHOD, addressing Richard Smith r259192 post commit comment. 2016-01-29 20:50:44 +00:00
CMakeLists.txt Support: Remove MemoryObject and DataStreamer interfaces. 2016-11-02 00:08:37 +00:00
COM.cpp
COPYRIGHT.regex
CachePruning.cpp Remove TimeValue usage from llvm/Support 2016-10-24 10:59:17 +00:00
Chrono.cpp Reapply "Add Chrono.h - std::chrono support header" 2016-10-20 12:05:50 +00:00
CommandLine.cpp Allow resolving response file names relative to including file 2016-11-01 06:53:29 +00:00
Compression.cpp Define a dummy zlib::uncompress when zlib is not available. 2016-09-12 13:00:51 +00:00
ConvertUTF.cpp Move UTF functions into namespace llvm. 2016-09-30 00:38:45 +00:00
ConvertUTFWrapper.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
CrashRecoveryContext.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
Debug.cpp The --debug-only option now takes a comma separated list of debug types. 2016-01-12 10:23:13 +00:00
DeltaAlgorithm.cpp Missing includes. 2016-09-14 08:55:18 +00:00
Dwarf.cpp Refactor DW_LNE_* into Dwarf.def 2016-10-28 22:57:02 +00:00
DynamicLibrary.cpp
Errno.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Error.cpp Remove LLVM_NOEXCEPT and replace it with noexcept 2016-10-19 23:52:38 +00:00
ErrorHandling.cpp [Support] Make all Errors convertible to std::error_code. 2016-03-23 23:57:28 +00:00
FileOutputBuffer.cpp Fix a real temp file leak in FileOutputBuffer 2016-09-02 01:10:53 +00:00
FileUtilities.cpp Fix some Clang-tidy modernize-use-using and Include What You Use warnings; other minor fixes. 2016-08-23 17:14:32 +00:00
FoldingSet.cpp PR30711: Fix incorrect profiling of 'long long' in FoldingSet, then use it to 2016-10-16 17:49:09 +00:00
FormattedStream.cpp
GraphWriter.cpp [Support] Reapply r245289 "Always wait for GraphViz before opening the viewer" 2015-09-18 10:56:30 +00:00
Hashing.cpp
Host.cpp Add computeHostNumPhysicalCores() implementation for Darwin 2016-10-19 22:36:07 +00:00
IntEqClasses.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
JamCRC.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
LEB128.cpp
LLVMBuild.txt Add an c++ itanium demangler to llvm. 2016-09-06 19:16:48 +00:00
LineIterator.cpp
Locale.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
LockFileManager.cpp Missing includes. 2016-09-14 08:55:18 +00:00
MD5.cpp
ManagedStatic.cpp [ManagedStatic] Reimplement double-checked locking with std::atomic. 2016-06-29 15:04:07 +00:00
MathExtras.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Memory.cpp
MemoryBuffer.cpp Add interface to compute number of physical cores on host system 2016-10-13 17:43:20 +00:00
Mutex.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
NativeFormatting.cpp NativeFormatting.cpp: Fix build for mingw. Where would writePadding() be? 2016-10-29 23:14:18 +00:00
Options.cpp
Path.cpp [Support] remove_dots: Remove .. from absolute paths. 2016-10-17 13:28:21 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Convert ENABLE_BACKTRACES into a 0/1 definition. 2016-09-30 20:04:24 +00:00
Process.cpp [Support] Creation of minidump after compiler crash on Windows 2016-05-04 16:56:51 +00:00
Program.cpp
README.txt.system
RWMutex.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
RandomNumberGenerator.cpp [Support] Fix undefined behavior in RandomNumberGenerator. 2016-10-11 18:17:26 +00:00
Regex.cpp [Support] - Fix possible crash in match() of llvm::Regex. 2016-09-02 08:44:46 +00:00
SHA1.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
ScaledNumber.cpp Remove some unneeded headers and replace some headers with forward class declarations (NFC) 2016-04-16 07:51:28 +00:00
ScopedPrinter.cpp Move llvm-readobj/StreamWriter to Support. 2016-05-03 00:28:04 +00:00
SearchForAddressOfSpecialSymbol.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Signals.cpp Search for llvm-symbolizer binary in the same directory as argv[0], before 2016-06-09 00:53:21 +00:00
SmallPtrSet.cpp Fix some Clang-tidy modernize-use-using and Include What You Use warnings; other minor fixes. 2016-08-23 17:14:32 +00:00
SmallVector.cpp
SourceMgr.cpp Use StringRef for MemoryBuffer identifier API (NFC) 2016-10-01 16:38:28 +00:00
SpecialCaseList.cpp Do a sweep over move ctors and remove those that are identical to the default. 2016-10-20 12:20:28 +00:00
Statistic.cpp Statistic: Bring back printing on exit by default 2016-09-27 19:38:55 +00:00
StringExtras.cpp
StringMap.cpp Fix some Clang-tidy modernize-use-using and Include What You Use warnings; other minor fixes. 2016-08-23 17:14:32 +00:00
StringPool.cpp
StringRef.cpp Speculative fix for build failures due to consumeInteger. 2016-09-22 15:55:05 +00:00
StringSaver.cpp Use StringRef in StringSaver API (NFC) 2016-10-05 01:32:41 +00:00
SystemUtils.cpp
TargetParser.cpp [ARM]: Add Cortex-R52 target to LLVM 2016-10-07 12:06:40 +00:00
TargetRegistry.cpp Revert "Use StringRef instead of raw pointer in TargetRegistry API (NFC)" 2016-10-01 07:08:23 +00:00
ThreadLocal.cpp
ThreadPool.cpp Removing whitespace from test commit rL273447 2016-06-22 18:01:11 +00:00
Threading.cpp Rename interface for querying physical hardware concurrency 2016-10-17 14:56:53 +00:00
TimeValue.cpp Reapply "Add Chrono.h - std::chrono support header" 2016-10-20 12:05:50 +00:00
Timer.cpp Remove TimeValue usage from llvm/Support 2016-10-24 10:59:17 +00:00
ToolOutputFile.cpp
Triple.cpp [RISCV] Recognise riscv32 and riscv64 in triple parsing code 2016-11-01 16:47:54 +00:00
Twine.cpp Annotate dump() methods with LLVM_DUMP_METHOD, addressing Richard Smith r259192 post commit comment. 2016-01-29 20:50:44 +00:00
Unicode.cpp
Valgrind.cpp Add a missing include of cstddef needed for size_t. 2015-10-15 19:41:54 +00:00
Watchdog.cpp
YAMLParser.cpp Support: Return void from Scanner::scan_ns_uri_char, no one uses the result 2016-10-16 22:01:22 +00:00
YAMLTraits.cpp [YAML] Fix YAML tags appearing before the start of sequence elements 2016-06-28 21:10:26 +00:00
circular_raw_ostream.cpp
raw_os_ostream.cpp
raw_ostream.cpp Added the ability to dump hex bytes easily into a raw_ostream. 2016-11-09 00:15:54 +00:00
regcclass.h
regcname.h
regcomp.c
regengine.inc
regerror.c
regex2.h
regex_impl.h
regexec.c
regfree.c
regstrlcpy.c
regutils.h
xxhash.cpp Add xxhash to llvm. 2016-09-27 15:45:57 +00:00

README.txt.system

Design Of lib/System
====================

The software in this directory is designed to completely shield LLVM from any
and all operating system specific functionality. It is not intended to be a
complete operating system wrapper (such as ACE), but only to provide the
functionality necessary to support LLVM.

The software located here, of necessity, has very specific and stringent design
rules. Violation of these rules means that cracks in the shield could form and
the primary goal of the library is defeated. By consistently using this library,
LLVM becomes more easily ported to new platforms since the only thing requiring
porting is this library.

Complete documentation for the library can be found in the file:
  llvm/docs/SystemLibrary.html
or at this URL:
  http://llvm.org/docs/SystemLibrary.html

While we recommend that you read the more detailed documentation, for the
impatient, here's a high level summary of the library's requirements.

 1. No system header files are to be exposed through the interface.
 2. Std C++ and Std C header files are okay to be exposed through the interface.
 3. No exposed system-specific functions.
 4. No exposed system-specific data.
 5. Data in lib/System classes must use only simple C++ intrinsic types.
 6. Errors are handled by returning "true" and setting an optional std::string
 7. Library must not throw any exceptions, period.
 8. Interface functions must not have throw() specifications.
 9. No duplicate function impementations are permitted within an operating
    system class.

To accomplish these requirements, the library has numerous design criteria that
must be satisfied. Here's a high level summary of the library's design criteria:

 1. No unused functionality (only what LLVM needs)
 2. High-Level Interfaces
 3. Use Opaque Classes
 4. Common Implementations
 5. Multiple Implementations
 6. Minimize Memory Allocation
 7. No Virtual Methods