folly/docs/Overview.md

   1 ### `folly/`
   2
   3 For a high level overview see the [README](folly/README.md)
   4
   5 ### Components
   6
   7 Below is a list of (some) Folly components in alphabetical order, along with
   8 a brief description of each.
   9
  10 #### `Arena.h`, `ThreadCachedArena.h`
  11
  12 Simple arena for memory allocation: multiple allocations get freed all
  13 at once. With threaded version.
  14
  15 #### [`AtomicHashMap.h`, `AtomicHashArray.h`](AtomicHashMap.md), `AtomicHashArray.h`, `AtomicLinkedList.h`, ...
  16
  17 High-performance atomic data-structures. Many of these are built with very specific
  18 tradeoffs and constraints in mind that make them faster than their more general
  19 counterparts. Each header should contain information about what these tradeoffs are.
  20
  21 #### `Baton.h`
  22
  23 A Baton allows a thread to block once and be awoken: it captures a single handoff. It is
  24 essentially a (very small, very fast) semaphore that supports only a single call to `sem_call`
  25 and `sem_wait`.
  26
  27 #### [`Benchmark.h`](Benchmark.md)
  28
  29 A small framework for benchmarking code. Client code registers
  30 benchmarks, optionally with an argument that dictates the scale of the
  31 benchmark (iterations, working set size etc). The framework runs
  32 benchmarks (subject to a command-line flag) and produces formatted
  33 output with timing information.
  34
  35 #### `Bits.h`
  36
  37 Various bit manipulation utilities optimized for speed; includes functions
  38 that wrap the
  39 [ffsl(l)](http://linux.die.net/man/3/ffsll) primitives in a uniform
  40 interface.
  41
  42 #### `ConcurrentSkipList.h`
  43
  44 An implementation of the structure described in [A Provably Correct
  45 Scalable Concurrent Skip
  46 List](http://www.cs.tau.ac.il/~shanir/nir-pubs-web/Papers/OPODIS2006-BA.pdf)
  47 by Herlihy et al.
  48
  49 #### [`Conv.h`](Conv.md)
  50
  51 A variety of data conversion routines (notably to and from string),
  52 optimized for speed and safety.
  53
  54 #### `Demangle.h`
  55
  56 Pretty-printing C++ types.
  57
  58 #### `DiscriminatedPtr.h`
  59
  60 Similar to `boost::variant`, but restricted to pointers only. Uses the
  61 highest-order unused 16 bits in a pointer as discriminator. So
  62 `sizeof(DiscriminatedPtr<int, string, Widget>) == sizeof(void*)`.
  63
  64 #### [`dynamic.h`](Dynamic.md)
  65
  66 Dynamically-typed object, created with JSON objects in mind. `DynamicConverter.h` is
  67 a utility for effeciently converting from a `dynamic` to a more concrete structure when
  68 the scheme is known (e.g. json -> `map<int,int>`).
  69
  70 #### `EvictingCacheMap.h`
  71
  72 A simple LRU hash map.
  73
  74 ####[`FBString.h`](FBString.md)
  75
  76 A drop-in implementation of `std::string` with a variety of optimizations.
  77
  78 ####[`FBVector.h`](FBVector.md)
  79
  80 A mostly drop-in implementation of `std::vector` with a variety of
  81 optimizations.
  82
  83 #### `File.h`
  84
  85 A C++ abstraction around files.
  86
  87 #### `Fingerprint.h`
  88
  89 Rabin fingerprinting.
  90
  91 ### [`futures/`](folly/futures/Readme.md)
  92
  93 Futures is a framework for expressing asynchronous code in C++ using the Promise/Future pattern.
  94
  95 ####[`Format.h`](Format.md)
  96
  97 Python-style formatting utilities.
  98
  99 #### `gen/`
 100
 101 This library makes it possible to write declarative comprehensions for
 102 processing sequences of values efficiently in C++ akin to C#'s LINQ.
 103
 104 ####[`GroupVarint.h`](GroupVarint.md)
 105
 106 [Group Varint
 107 encoding](http://www.ir.uwaterloo.ca/book/addenda-06-index-compression.html)
 108 for 32-bit values.
 109
 110 ####`IpAddress.h`
 111
 112 A collection of utilities to deal with IPAddresses, including ipv4 and ipv6.
 113
 114 #### `io/`
 115
 116 A collection of useful of abstractions for high-performance io. This is heavily relied upon
 117 in Facebook's internally networking code.
 118
 119 ####`Hash.h`
 120
 121 Various popular hash function implementations.
 122
 123 ####[`Histogram.h`](Histogram.md)
 124
 125 A simple class for collecting histogram data.
 126
 127 ####`IntrusiveList.h`
 128
 129 Convenience type definitions for using `boost::intrusive_list`.
 130
 131 ####`json.h`
 132
 133 JSON serializer and deserializer. Uses `dynamic.h`.
 134
 135 ####`Likely.h`
 136
 137 Wrappers around [`__builtin_expect`](http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html).
 138
 139 ####`Malloc.h`, `Memory.h`
 140
 141 Memory allocation helpers, particularly when using jemalloc.
 142
 143 ####`MicroSpinLock.h`
 144
 145 A really, *really* small spinlock for fine-grained locking of lots of teeny-tiny data.
 146
 147 ####`MPMCQueue.h`
 148
 149 MPMCQueue<typename> is a high-performance bounded concurrent queue that
 150 supports multiple producers, multiple consumers, and optional blocking.
 151 The queue has a fixed capacity, for which all memory will be allocated
 152  up front.
 153
 154 The additional utility `MPMCPipeline.h` is an extension that lets you
 155 chain several queues together with processing steps in between.
 156
 157 ####[`PackedSyncPtr.h`](PackedSyncPtr.md)
 158
 159 A highly specialized data structure consisting of a pointer, a 1-bit
 160 spin lock, and a 15-bit integral, all inside one 64-bit word.
 161
 162 ####`Preprocessor.h`
 163
 164 Necessarily evil stuff.
 165
 166 ####[`ProducerConsumerQueue.h`](ProducerConsumerQueue.md)
 167
 168 Lock free single-reader, single-writer queue.
 169
 170 ####`Random.h`
 171
 172 Defines only one function---`randomNumberSeed()`.
 173
 174 ####`Range.h`
 175
 176 Boost-style range facility and the `StringPiece` specialization.
 177
 178 ####`RWSpinLock.h`
 179
 180 Fast and compact reader-writer spin lock.
 181
 182 ####`ScopeGuard.h`
 183
 184 C++11 incarnation of the old [ScopeGuard](http://drdobbs.com/184403758) idiom.
 185
 186 ####`Singleton.h`
 187
 188 A singleton to rule the singletons. This is an attempt to insert a layer between
 189 C++ statics and the fiasco that ensues, so that things can be created, and destroyed,
 190 correctly upon program creation, program end and sometimes `dlopen` and `fork`.
 191
 192 Singletons are bad for you, but this may help.
 193
 194 ####[`SmallLocks.h`](SmallLocks.md)
 195
 196 Very small spin locks (1 byte and 1 bit).
 197
 198 ####`small_vector.h`
 199
 200 Vector with the small buffer optimization and an optional embedded
 201 `PicoSpinLock`.
 202
 203 ####`sorted_vector_types.h`
 204
 205 Collections similar to `std::map` but implemented as sorted vectors.
 206
 207 #### `stats/`
 208
 209 A collection of efficient utilities for collecting statistics (often of
 210 time series data).
 211
 212 ####`StlAllocator.h`
 213
 214 STL allocator wrapping a simple allocate/deallocate interface.
 215
 216 ####`String.h`
 217
 218 String utilities that connect `folly::fbstring` with `std::string`.
 219
 220 ####`Subprocess.h`
 221
 222 Subprocess library, modeled after Python's subprocess module.
 223
 224 ####[`Synchronized.h`](Synchronized.md)
 225
 226 High-level synchronization library.
 227
 228 ####`System.h`
 229
 230 Demangling and errno utilities.
 231
 232 ####[`ThreadCachedInt.h`](ThreadCachedInt.md)
 233
 234 High-performance atomic increment using thread caching.
 235
 236 ####[`ThreadLocal.h`](ThreadLocal.md)
 237
 238 Improved thread local storage for non-trivial types.
 239
 240 ####`TimeoutQueue.h`
 241
 242 Queue with per-item timeout.
 243
 244 ####`Traits.h`
 245
 246 Type traits that complement those defined in the standard C++11 header
 247 `<traits>`.
 248
 249 ####`Unicode.h`
 250
 251 Defines the `codePointToUtf8` function.
 252
 253 ####`Uri.h`
 254
 255 A collection of utilities to deal with URIs.