llvm/lib/Support
Pavel Labath bca3cda284 Add Chrono.h - std::chrono support header
Summary:
std::chrono mostly covers the functionality of llvm::sys::TimeValue and
lldb_private::TimeValue. This header adds a bit of utility functions and
typedefs, which make the usage of the library and porting code from TimeValues
easier.

Rationale:
- TimePoint typedef - precision of system_clock is implementation defined -
  using a well-defined precision helps maintain consistency between platforms,
  makes it interact better with existing TimeValue classes, and avoids cases
  there a time point is implicitly convertible to a specific precision on some
  platforms but not on others.
- system_clock::to_time_t only accepts time_points with the default system
  precision (even though time_t has only second precision on all platforms we
  support). To avoid the need for explicit casts, I have added a toTimeT()
  wrapper function. toTimePoint(time_t) was not strictly necessary, but I have
  added it for symmetry.

Reviewers: zturner, mehdi_amini

Subscribers: beanz, mgorny, llvm-commits, modocache

Differential Revision: https://reviews.llvm.org/D25416

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@284590 91177308-0d34-0410-b5e6-96231b3b80d8
2016-10-19 13:58:55 +00:00
..
Unix Add Chrono.h - std::chrono support header 2016-10-19 13:58:55 +00:00
Windows Add Chrono.h - std::chrono support header 2016-10-19 13:58:55 +00:00
Allocator.cpp
APFloat.cpp
APInt.cpp Missing includes. 2016-09-14 08:55:18 +00:00
APSInt.cpp
ARMBuildAttrs.cpp Use StringRef instead of raw pointers in ARMBuildAttrs (NFC) 2016-10-05 00:15:18 +00:00
ARMWinEH.cpp
Atomic.cpp
BlockFrequency.cpp
BranchProbability.cpp
CachePruning.cpp Missing includes. 2016-09-14 08:55:18 +00:00
Chrono.cpp Add Chrono.h - std::chrono support header 2016-10-19 13:58:55 +00:00
circular_raw_ostream.cpp
CMakeLists.txt Add Chrono.h - std::chrono support header 2016-10-19 13:58:55 +00:00
COM.cpp
CommandLine.cpp [Support][CommandLine] Display subcommands in help when there are less than 3 2016-10-12 10:04:35 +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
COPYRIGHT.regex
CrashRecoveryContext.cpp
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
DataStream.cpp
Debug.cpp
DeltaAlgorithm.cpp Missing includes. 2016-09-14 08:55:18 +00:00
Dwarf.cpp Re-commit "Use StringRef in Support/Darf APIs (NFC)" 2016-10-05 05:59:29 +00:00
DynamicLibrary.cpp
Errno.cpp
Error.cpp Missing includes. 2016-09-14 08:55:18 +00:00
ErrorHandling.cpp
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
Hashing.cpp
Host.cpp Reduce global namespace pollution. NFC. 2016-10-18 19:39:31 +00:00
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
JamCRC.cpp
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt Add an c++ itanium demangler to llvm. 2016-09-06 19:16:48 +00:00
Locale.cpp
LockFileManager.cpp Missing includes. 2016-09-14 08:55:18 +00:00
ManagedStatic.cpp [ManagedStatic] Reimplement double-checked locking with std::atomic. 2016-06-29 15:04:07 +00:00
MathExtras.cpp
MD5.cpp
Memory.cpp
MemoryBuffer.cpp Add interface to compute number of physical cores on host system 2016-10-13 17:43:20 +00:00
MemoryObject.cpp
Mutex.cpp
NativeFormatting.cpp Revert "Resubmit "Add support for advanced number formatting."" 2016-10-18 09:30: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
Program.cpp
RandomNumberGenerator.cpp [Support] Fix undefined behavior in RandomNumberGenerator. 2016-10-11 18:17:26 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Revert "Resubmit "Add support for advanced number formatting."" 2016-10-18 09:30:18 +00:00
README.txt.system
regcclass.h
regcname.h
regcomp.c
regengine.inc
regerror.c
regex2.h
regex_impl.h
Regex.cpp [Support] - Fix possible crash in match() of llvm::Regex. 2016-09-02 08:44:46 +00:00
regexec.c
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp
ScaledNumber.cpp
ScopedPrinter.cpp
SearchForAddressOfSpecialSymbol.cpp
SHA1.cpp
Signals.cpp
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
Statistic.cpp Statistic: Bring back printing on exit by default 2016-09-27 19:38:55 +00:00
StreamingMemoryObject.cpp
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
Threading.cpp Rename interface for querying physical hardware concurrency 2016-10-17 14:56:53 +00:00
ThreadLocal.cpp
ThreadPool.cpp
Timer.cpp Timer: Fix doxygen comments, use member initializer; NFC 2016-10-14 00:17:19 +00:00
TimeValue.cpp Add Chrono.h - std::chrono support header 2016-10-19 13:58:55 +00:00
ToolOutputFile.cpp
Triple.cpp Define "contiki" OS specifier. 2016-10-14 14:41:46 +00:00
Twine.cpp
Unicode.cpp
Valgrind.cpp
Watchdog.cpp
xxhash.cpp Add xxhash to llvm. 2016-09-27 15:45:57 +00:00
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

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