llvm-6502/lib/Support
Chandler Carruth 0b66c6fca2 Rewrite LLVM's generalized support library for hashing to follow the API
of the proposed standard hashing interfaces (N3333), and to use
a modified and tuned version of the CityHash algorithm.

Some of the highlights of this change:
 -- Significantly higher quality hashing algorithm with very well
    distributed results, and extremely few collisions. Should be close to
    a checksum for up to 64-bit keys. Very little clustering or clumping of
    hash codes, to better distribute load on probed hash tables.
 -- Built-in support for reserved values.
 -- Simplified API that composes cleanly with other C++ idioms and APIs.
 -- Better scaling performance as keys grow. This is the fastest
    algorithm I've found and measured for moderately sized keys (such as
    show up in some of the uniquing and folding use cases)
 -- Support for enabling per-execution seeds to prevent table ordering
    or other artifacts of hashing algorithms to impact the output of
    LLVM. The seeding would make each run different and highlight these
    problems during bootstrap.

This implementation was tested extensively using the SMHasher test
suite, and pased with flying colors, doing better than the original
CityHash algorithm even.

I've included a unittest, although it is somewhat minimal at the moment.
I've also added (or refactored into the proper location) type traits
necessary to implement this, and converted users of GeneralHash over.

My only immediate concerns with this implementation is the performance
of hashing small keys. I've already started working to improve this, and
will continue to do so. Currently, the only algorithms faster produce
lower quality results, but it is likely there is a better compromise
than the current one.

Many thanks to Jeffrey Yasskin who did most of the work on the N3333
paper, pair-programmed some of this code, and reviewed much of it. Many
thanks also go to Geoff Pike Pike and Jyrki Alakuijala, the original
authors of CityHash on which this is heavily based, and Austin Appleby
who created MurmurHash and the SMHasher test suite.

Also thanks to Nadav, Tobias, Howard, Jay, Nick, Ahmed, and Duncan for
all of the review comments! If there are further comments or concerns,
please let me know and I'll jump on 'em.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@151822 91177308-0d34-0410-b5e6-96231b3b80d8
2012-03-01 18:55:25 +00:00
..
Unix Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Windows Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Allocator.cpp Add BumpPtrAllocator::getTotalMemory() to allow clients to query how much memory a BumpPtrAllocator allocated. 2011-04-18 22:44:46 +00:00
APFloat.cpp APFloat::toString(): Fix overrun at scanning. 2012-02-19 03:18:29 +00:00
APInt.cpp Fix undefined behavior. 2012-02-24 19:06:15 +00:00
APSInt.cpp
Atomic.cpp drop unneeded config.h includes 2011-12-22 23:04:07 +00:00
BlockFrequency.cpp BlockFrequency: Use a smarter overflow check. 2011-10-27 16:38:50 +00:00
BranchProbability.cpp Print branch probabilities as percentages. 2011-10-23 11:32:54 +00:00
circular_raw_ostream.cpp
CMakeLists.txt Rewrite LLVM's generalized support library for hashing to follow the API 2012-03-01 18:55:25 +00:00
CommandLine.cpp Correct use of const in ParseCommandLineOptions 2012-02-07 19:36:01 +00:00
ConstantRange.cpp Convert assert(0) to llvm_unreachable 2012-02-07 05:05:23 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp Remove dead code. Improve llvm_unreachable text. Simplify some control flow. 2012-02-19 11:37:01 +00:00
DAGDeltaAlgorithm.cpp Adding missing anchor to DATDeltaAlgorithm. 2011-12-07 06:44:23 +00:00
DataExtractor.cpp Remove extra semi-colons. 2012-02-22 17:25:00 +00:00
DataStream.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Debug.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
DeltaAlgorithm.cpp
Disassembler.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
Dwarf.cpp Add new tag and an attribute to support debug info for objective-c property. 2012-02-03 23:57:08 +00:00
DynamicLibrary.cpp Make DynamicLibrary thread-safe w/r/t call to dlerror() after dlopen(). PR10718 2011-08-22 19:01:52 +00:00
Errno.cpp lib/Support/Errno.cpp: Check strerror_s() with HAVE_DECL_STRERROR_S in config.h.*. 2011-02-09 04:18:48 +00:00
ErrorHandling.cpp Like the coding standards say, do not use "using namespace std". 2011-04-23 09:06:00 +00:00
FileUtilities.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
FoldingSet.cpp Simplify & microoptimize code. No intended functionality change. 2011-07-18 00:00:20 +00:00
FormattedStream.cpp Add missing standard headers. Patch by Joerg Sonnenberger! 2010-12-19 20:43:38 +00:00
GraphWriter.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Host.cpp Remove unreachable code. (replace with llvm_unreachable to help GCC where necessary) 2012-01-17 04:43:56 +00:00
IncludeFile.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
IntEqClasses.cpp Use IntEqClasses to compute connected components of live intervals. 2010-12-21 00:48:17 +00:00
IntervalMap.cpp Add IntervalMap::iterator::set{Start,Stop,Value} methods that allow limited 2010-12-03 19:02:00 +00:00
IntrusiveRefCntPtr.cpp Unweaken vtables as per http://llvm.org/docs/CodingStandards.html#ll_virtual_anch 2011-12-20 02:50:00 +00:00
IsInf.cpp
IsNAN.cpp
JSONParser.cpp fix typo 2012-02-06 05:29:29 +00:00
LLVMBuild.txt LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
LockFileManager.cpp Move Clang's file-level locking facility over to LLVM's support 2012-01-29 20:15:10 +00:00
Makefile Merge System into Support. 2010-11-29 18:16:10 +00:00
ManagedStatic.cpp Add support for tsan annotations (thread sanitizer, a valgrind-based tool). 2011-11-14 20:50:16 +00:00
Memory.cpp The Mips specific function for instruction cache invalidation cannot be 2011-10-10 18:41:02 +00:00
MemoryBuffer.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
MemoryObject.cpp Make MemoryObject accessor members const again 2012-02-29 01:09:06 +00:00
Mutex.cpp Persuade GCC that there is nothing worth warning about here (there isn't). 2012-02-05 14:20:11 +00:00
Path.cpp Support/FileSystem: Add file_magic and move a vew clients over to it. 2011-12-13 23:17:12 +00:00
PathV2.cpp Support/PathV2: Fix namespace qualifier in make_absolute(), for Win32. 2012-02-29 00:46:46 +00:00
PluginLoader.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
PrettyStackTrace.cpp Add more initializers to quiet a clang warning. 2011-10-05 05:00:26 +00:00
Process.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Program.cpp Support/Program: Make Change<stream>ToBinary return error_code. 2011-12-13 23:16:49 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Support/Program: Make Change<stream>ToBinary return error_code. 2011-12-13 23:16:49 +00:00
README.txt.system Merge System into Support. 2010-11-29 18:16:10 +00:00
regcclass.h
regcname.h
regcomp.c lib/Support/regcomp.c: Fix cygwin warning. 2011-03-08 12:25:29 +00:00
regengine.inc
regerror.c
regex2.h
regex_impl.h
Regex.cpp regexes are allowed to match empty things, e.g. {{.*}} in filecheck. 2011-04-09 06:29:24 +00:00
regexec.c lib/Support/regexec.c: Let Regex LLP64-aware. 2010-12-16 01:48:15 +00:00
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp Remove dead code. 2012-01-15 01:09:13 +00:00
SearchForAddressOfSpecialSymbol.cpp These symbols appear to be visible by SearchForAddressOfSymbol and no longer 2011-09-27 20:01:41 +00:00
Signals.cpp Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
SmallPtrSet.cpp Prevent infinite growth of SmallPtrSet instances. 2011-03-30 18:32:48 +00:00
SmallVector.cpp
SourceMgr.cpp Removing unused default switch cases in switches over enums that already account for all enumeration values explicitly. 2012-01-16 23:24:27 +00:00
Statistic.cpp Silence tsan false-positives (tsan can't track things which are only safe due to 2011-12-05 23:07:05 +00:00
StreamableMemoryObject.cpp Make MemoryObject accessor members const again 2012-02-29 01:09:06 +00:00
StringExtras.cpp Move the implementation of StringRef::split out of StringExtras.cpp 2012-02-21 12:00:25 +00:00
StringMap.cpp Switch StringMap from an array of structures to a structure of arrays. 2011-12-27 20:35:07 +00:00
StringPool.cpp
StringRef.cpp Workaround a miscompilation by gcc-4.3 that showed up as a failure 2012-02-24 09:01:34 +00:00
system_error.cpp Support/MemoryBuffer: Replace all uses of std::string *ErrMsg with error_code &ec. And fix clients. 2010-12-09 17:36:48 +00:00
SystemUtils.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
TargetRegistry.cpp revert r147542 after comments from Joerg Sonnenberger 2012-01-05 18:28:46 +00:00
Threading.cpp rename ENABLE_THREADS to LLVM_ENABLE_THREADS 2011-11-28 00:48:58 +00:00
ThreadLocal.cpp rename ENABLE_THREADS to LLVM_ENABLE_THREADS 2011-11-28 00:48:58 +00:00
Timer.cpp Add more PRI.64 macros for MSVC and use them throughout the codebase. 2011-11-05 08:57:40 +00:00
TimeValue.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
ToolOutputFile.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Triple.cpp Support was removed from LLVM's MIPS backend for the PSP variant of that 2012-02-22 11:32:54 +00:00
Twine.cpp Add Twine support for characters, and switch twine to use a union internally 2011-07-24 20:44:30 +00:00
Valgrind.cpp Don't define these unless we plan to use them. 2011-11-28 22:14:02 +00:00

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