include or backport: * std::invoke * std::invoke_result * std::invoke_result_t * std::is_invocable * std::is_invocable_v * std::is_invocable_r * std::is_invocable_r_v * std::is_nothrow_invocable * std::is_nothrow_invocable_v * std::is_nothrow_invocable_r * std::is_nothrow_invocable_r_v
Namespaces
Name |
Description |
Implementation helpers for make_array and make_array_with. |
|
Implementation details. |
|
READ ME: The docs for this library are in |
|
Implementation details for BitIterator. |
|
BSER binary serialization for dynamic values. |
|
Internal implementation details for ConcurrentBSkipList. |
|
Sender/receiver channel primitives for asynchronous value streams. |
|
Time‐related wrappers and clock utilities. |
|
Compression and decompression codecs over IOBufs. |
|
Coroutine primitives and combinators. |
|
Cryptographic hashing primitives. |
|
Implementation details of the |
|
Implementation details. |
|
Implementation details for dynamic. |
|
Implementation details for DynamicConverter and DynamicConstructor. |
|
Facilities for capturing and stacking exception stack traces. |
|
Implementation details for folly::Expected. |
|
Namespace for experimental Folly components. |
|
Extension namespace for library authors, a public analog of |
|
Vendored third‐party code adapted for use in Folly. |
|
Implementation details for the F14 hash table family. |
|
A fallback implementation used when the standard trait is unavailable. |
|
Implementation details for fbstring. |
|
Lightweight cooperative userspace threads (fibers) and related primitives. |
|
Portable wrappers and imports for file‐descriptor operations. |
|
Implementation details. |
|
Implementation details for folly::findFixed. |
|
The user should return loop_break and loop_continue if they want to iterate in such a way that they can preemptively stop the loop and break out when certain conditions are met. |
|
Utilities for all format value specializations. |
|
Portable filesystem imports selecting the available |
|
Futures‐based asynchronous programming primitives. |
|
Lazy sequence generators and pipeline operators. |
|
Minimal stand‐in for the gflags namespace when gflags is unavailable. |
|
Hashing algorithms and helpers. |
|
Implementation details of the folly invocation traits. |
|
Cursor and queue utilities for reading and writing IOBuf chains. |
|
JSON parsing and serialization utilities. |
|
JSON Schema (draft v4) validation utilities. |
|
Implementation details for libc++ bitset support. |
|
Folly's logging library. |
|
Memory management utilities. |
|
Internal namespace hosting the copy/move control base types. |
|
Cross‐platform socket operation wrappers. |
|
numbers |
|
Folly's observer library. |
|
Implementation details. |
|
Utilities for storing data aligned on block (possibly cache‐line) boundaries, with optional padding. |
|
Aliases that use a polymorphic allocator. |
|
Interfaces and helpers for the |
|
Portability shims for platform‐specific system interfaces. |
|
Low‐level helpers exposing the RecordIO record format. |
|
Implementation details for |
|
Runtime configuration settings framework. |
|
Implementation details for SharedMutex; not part of the public API. |
|
SIMD algorithms and utilities. |
|
Policies that customize the behavior of folly::small_vector. |
|
SSL and TLS helpers built on OpenSSL. |
|
Implementation details for the stable radix sort. |
|
Stable LSD (Least Significant Digit) Radix Sort |
|
Stack trace capture and symbolization utilities. |
|
Testing utilities. |
|
Implementation details. |
|
There is a bug in libstdc++, libc++, and MSVC's STL that causes it to ignore unused template parameter arguments in template aliases and does not cause substitution failures. This defect has been recorded here: http://open‐std.org/JTC1/SC22/WG21/docs/cwg_defects.html#1558. |
|
Implementation namespace for the IsEqualityComparable trait. |
|
Implementation namespace for the IsLessThanComparable trait. |
Types
Name |
Description |
Tag selecting strict access mode for thread‐local storage. |
|
AccessSpreader arranges access to a striped data structure in such a way that concurrently executing threads are likely to be accessing different stripes. It does NOT guarantee uncontended access. Your underlying algorithm must be thread‐safe without spreading, this is merely an optimization. AccessSpreader::current(n) is typically much faster than a cache miss (12 nanos on my dev box, tested fast in both 2.6 and 3.2 kernels). |
|
AlignedSysAllocator |
|
AllocatorHasDefaultObjectConstruct |
|
AllocatorHasDefaultObjectDestroy |
|
AllocatorHasTrivialDeallocate |
|
A scoped lock for any capability‐annotated mutex. |
|
A |
|
Callable that invokes a function with the elements of a tuple as arguments. |
|
Arena that allocates memory in blocks and frees it all at destruction. |
|
Simple arena: allocate memory which gets freed when the arena gets destroyed. |
|
Check if two ascii characters are case insensitive equal. The difference between the lower/upper case characters are the 6‐th bit. We also check they are alpha chars, in case of xor = 32. |
|
Case‐sensitive equality comparator for ASCII characters. |
|
Generic C++ interface around Linux IO(io_submit, io_uring) |
|
An AsyncBaseOp represents a pending operation. You may set a notification callback or you may use this class's methods directly. |
|
Wrapper around AsyncBase that allows you to schedule more requests than the AsyncBase's object capacity. Other requests are queued and processed in a FIFO order. |
|
Receives the result of detaching a file descriptor from a socket. |
|
Intended for use with Unix sockets. Unlike regular |
|
Test fixture friendship declaration generated by the GTest macro. |
|
An implementation of |
|
C++ interface around Linux Async IO. |
|
A pending operation backed by the Linux io_submit interface. |
|
Creates AsyncIoUringSocket instances and reports io_uring support. |
|
An abstract LogWriter implementation that provides functionality for asynchronous IO operations. Users can subclass this class and provide their own IO operation implementation by overriding |
|
Read from a pipe in an async manner. |
|
Write to a pipe in an async manner. |
|
Interface for the read side of an asynchronous transport. |
|
A class for performing asynchronous I/O on an SSL connection. |
|
Connector that drives the SSL handshake for an AsyncSSLSocket. |
|
AsyncServerSocket is a listening socket that asynchronously informs a callback whenever a new connection has been accepted. |
|
A handler to receive notification about POSIX signals. |
|
An asynchronous socket. |
|
Base interface for asynchronous sockets bound to an event base. |
|
Exception thrown by folly asynchronous socket operations. |
|
Container of observers attached to an AsyncSocket. |
|
Observer of socket events. |
|
Abstract asynchronous transport backed by a socket. |
|
Represents a frame in an async stack trace. |
|
A stack‐root represents the context of an event loop that is running some asynchronous work. The current async operation that is being executed by the event loop (if any) is pointed to by the 'topFrame'. |
|
AsyncTimeout is used to asynchronously wait for a timeout to occur. |
|
AsyncTransport defines an asynchronous API for bidirectional streaming I/O. |
|
Generic interface applications may implement to convey self or peer certificate related information. |
|
UDP server socket |
|
UDP socket |
|
Interface for the write side of an asynchronous transport. |
|
AtFork |
|
AtForkList |
|
This class creates core‐local caches for a given shared_ptr, to mitigate contention when acquiring/releasing it. |
|
Fixed‐size, lock‐free hash array and building block for |
|
Linear probing strategy for |
|
Quadratic probing strategy for |
|
Lock‐free, growable hash map built on top of |
|
Thrown when insertion fails due to running out of space for submaps. |
|
A lock‐free intrusive single‐linked list. |
|
A very simple atomic single‐linked list primitive. |
|
A very simple atomic single‐linked list primitive. |
|
A producer‐consumer queue for passing tasks to consumer thread. |
|
An atomically‐swappable owner of a |
|
AtomicStruct<T> work like C++ atomics, but can be used on any POD type <= 8 bytes. |
|
You're probably reading this because you are looking for an AtomicUnorderedMap<K,V> that is fully general, highly concurrent (for reads, writes, and iteration), and makes no performance compromises. We haven't figured that one out yet. What you will find here is a hash table implementation that sacrifices generality so that it can give you all of the other things. |
|
Automatically times a block of code, printing a specified log message on destruction or whenever the log() method is called. For example: |
|
An exception type thrown by Expected on catastrophic logic errors, i.e., when the caller tries to access the value within an Expected but when the Expected instead contains an error. |
|
Exception thrown when a format argument string is invalid. |
|
Exception type that is thrown on invalid access of an empty |
|
Exception type that is thrown when attempting to extract from a |
|
Formatter class. |
|
Thread‐safe (atomic) token bucket implementation. |
|
A class for holding up to |
|
Specialization of BasicDynamicTokenBucket with a fixed token generation rate and a fixed maximum burst size. |
|
A Baton allows a thread to block once and be awoken. Captures a single handoff, and during its lifecycle (from construction/reset to destruction/reset) a baton must either be post()ed and wait()ed exactly once each, or not at all. |
|
Supporting type for BENCHMARK_SUSPEND defined below. |
|
Fast bit iteration facility. |
|
Wrapper class with static methods for various bit‐level operations, treating an array of T as an array of bits (in little‐endian order). (T is either an unsigned integral type or Unaligned<X>, where X is an unsigned integral type) |
|
Abstract interface for a queue that can block callers until items are available. |
|
Result of adding an item to a BlockingQueue. |
|
This class represents a bucketed time series which keeps track of values added in the recent past, and merges these values together into a fixed number of buckets to keep a lid on memory use if the number of values added is very large. |
|
A Thread pool for CPU bound tasks. |
|
Holds cache sharing topology for the current system. |
|
Derived template class that allows forwarding of a callback to be invoked in the overridden signalReceived(). |
|
Exception thrown by *Checked methods of Subprocess. |
|
A CancellationCallback object registers the callback with the specified CancellationToken such that the callback will be executed if the corresponding CancellationSource object has the requestCancellation() method called on it. |
|
A CancellationSource object provides the ability to request cancellation of operations that an associated CancellationToken was passed to. |
|
A CancellationToken is an object that can be passed into an function or operation that allows the caller to later request that the operation be cancelled. |
|
CertificateIdentityVerifier implementations are used during TLS handshakes to extract and verify end‐entity certificate identities. |
|
Base of exception hierarchy for CertificateIdentityVerifier failure reasons. |
|
Base class for structured async cleanup. |
|
CoDel (controlled delay) is an active queue management algorithm from networking for battling bufferbloat. |
|
The default configuration policy for ConcurrentBSkipList. |
|
Concurrent B‐skip‐list container; declared here for friend declarations. |
|
An atomic bitset of fixed size (specified at compile time). |
|
Implementations of high‐performance Concurrent Hashmaps that support erase and update. |
|
Thread‐safe, delayed initialization of a value computed once at first access. |
|
A concurrent, sorted, unique‐key associative container. |
|
A mixin that fires registered callbacks each time a class constructor runs. |
|
Exception thrown when a conversion fails, carrying a ConversionCode. |
|
Base class for exceptions thrown by folly conversion routines. |
|
An C++ allocator adapter for coreMalloc/Free. The allocator is stateless, to avoid increasing the footprint of the container that uses it, so the stripe needs to be passed out of band: allocate() can only be called while there is an active CoreAllocatorGuard. deallocate() can instead be called at any point. |
|
Scope guard that binds CoreAllocator allocations to a stripe. |
|
This class creates core‐local caches for a given shared_ptr, to mitigate contention when acquiring/releasing it. |
|
Core‐local cache of weak pointers to a shared object. |
|
Identification of an Intel CPU. Supports CPUID feature flags (EAX=1) and extended features (EAX=7, ECX=0). Values from http://www.intel.com/content/www/us/en/processors/processor‐identification‐cpuid‐instruction‐note.html |
|
A LogFormatter implementation that produces messages in a format specified using a config. |
|
CxxAllocatorAdaptor |
|
STL compatible huge page allocator, for use with STL‐style containers. |
|
An STL‐compatible allocator backed by the io_uring arena. |
|
Debug‐only guard that checks the context is unchanged across a scope. |
|
Interface for an object that watches an executor for deadlocks. |
|
Factory that creates DeadlockDetector instances for executors. |
|
Convenience class so that AsyncTransport can be decorated without having to redefine every single method. |
|
An alignment policy that carries a runtime alignment value. |
|
An Executor accepts units of work with add(), which should be threadsafe. |
|
DynamicBoundedQueue supports: ‐ Dynamic memory usage that grows and shrink in proportion to the number of elements in the queue. ‐ Adjustable capacity that helps throttle pathological cases of producer‐consumer imbalance that may lead to excessive memory usage. ‐ The adjustable capacity can also help prevent deadlock by allowing users to temporarily increase capacity substantially to guarantee accommodating producer requests that cannot wait. ‐ SPSC, SPMC, MPSC, MPMC variants. ‐ Blocking and spinning‐only variants. ‐ Inter‐operable non‐waiting, timed until, timed for, and waiting variants of producer and consumer operations. ‐ Optional variable element weights. |
|
DelayedDestruction is a helper class to ensure objects are not deleted while they still have functions executing in a higher stack frame. |
|
DelayedDestructionBase is a helper class to ensure objects are not deleted while they still have functions executing in a higher stack frame. |
|
DelayedInit ‐‐ thread‐safe delayed initialization of a value. There are two important differences between Lazy and DelayedInit: 1. DelayedInit does not store the factory function inline. 2. DelayedInit is thread‐safe. |
|
Node traits for types that derive from IntrusiveHeapNode. |
|
DestructorCheck is a helper class that helps to detect if a tracked object was deleted. This is useful for objects that request callbacks from other components. |
|
Stat digests, such as TDigest, can be expensive to merge. It is faster to buffer writes and merge them in larger chunks. DigestBuilder buffers writes to improve performance. |
|
Discriminated pointer. |
|
An executor that can be driven forward via its |
|
A bounded, FIFO, multi‐producer multi‐consumer queue with adjustable capacity and dynamic memory usage. |
|
Each specialization of DynamicConstructor has the function 'static dynamic construct(const C&);' |
|
Each specialization of DynamicConverter has the function 'static T convert(const dynamic&);' |
|
A small DSL for losslessly parsing a folly::dynamic into another representation while recording any parts that cause errors. |
|
When DynamicParser is used incorrectly, it will throw this exception instead of reporting an error via releaseErrors(). It is unsafe to call any parser methods after catching a LogicError. |
|
With DynamicParser::OnError::THROW, reports the first error. It is forbidden to call releaseErrors() if you catch this. |
|
A ring buffer queue backed by a power‐of‐two sized array that grows on overflow. Not thread‐safe. |
|
DEPRECATED: use |
|
Identification of hardware capabilities via the ELF auxiliary vector. |
|
EnablePrimaryFromThis provides an object with appropriate access to the functionality of the PrimaryPtr holding this. |
|
Converts integral and floating point values between native, big‐endian, and little‐endian byte orders. |
|
An event loop that drives asynchronous I/O and timers. |
|
Lock‐free notification queue of tasks consumed by a single consumer. |
|
Abstract base for the backend that drives an EventBase loop. |
|
Wrapper around a libevent event owned by an EventBase backend. |
|
Storage for data tied to the lifetime of an EventBase. |
|
Manager for per‐thread EventBase objects. This class will find or create a EventBase for the current thread, associated with thread‐specific storage for that thread. Although a typical application will generally only have one EventBaseManager, there is no restriction on multiple instances; the EventBases belong to one instance are isolated from those of another. |
|
Observer interface that samples EventBase loop activity. |
|
Owns an EventBase running on its own thread. |
|
A Timekeeper that schedules timeouts on an externally supplied EventBase. |
|
Event count: a condition variable for lock free algorithms. |
|
The EventHandler class is used to asynchronously wait for events on a file descriptor. |
|
low‐level libevent utility functions |
|
A general purpose LRU evicting cache designed to support constant time set/get/insert/erase ops. The only required configuration parameter is the |
|
Observes the execution of a task. Multiple execution observers can be chained together. As a caveat, execution observers should not remove themselves from the list of observers during execution |
|
Notifies a list of execution observers around a scoped task execution. |
|
Schedules and runs asynchronous work. |
|
Records whether blocking is forbidden while an executor is running work. |
|
Scoped guard that pushes an executor blocking context for its lifetime. |
|
A node in the thread‐local stack of executor blocking contexts. |
|
|
|
Wraps an executor so that submitted tasks run at a chosen priority. |
|
Forward declarations |
|
F14 hash map that selects a value or vector layout based on entry size. |
|
F14 hash set that selects a value or vector layout based on element size. |
|
An opaque token holding the precomputed hash of a key. |
|
A key paired with its precomputed F14 hash token for faster lookups. |
|
F14 hash map that stores each entry in a separately allocated node. |
|
F14 hash set that stores each element in a separately allocated node. |
|
Diagnostic statistics describing the internal state of an F14 table. |
|
F14 hash map that stores entries inline in the main array. |
|
F14 hash set that stores elements inline in the main array. |
|
Test‐only accessor granting inspection of F14ValueSet internals. |
|
F14 hash map that keeps entries in a dense, index‐addressable vector. |
|
F14 hash set that keeps elements in a dense, index‐addressable vector. |
|
A class that lazily binds a unique (for each implementation of Atom) identifier to a thread. This is a fallback mechanism for the access spreader if __vdso_getcpu can't be loaded |
|
An IOExecutor that executes funcs under mapped fiber context |
|
A File represents an open file. |
|
FileHandlerFactory is a LogHandlerFactory that constructs log handlers that write to a file. |
|
A helper class for creating an AsyncFileWriter or ImmediateFileWriter based on log handler options settings. |
|
Compute the Rabin fingerprint. |
|
An alignment policy that carries a compile‐time alignment value. |
|
A simple fixed‐capacity ring buffer queue backed by a power‐of‐two sized array. Not thread‐safe. |
|
‐ A simple interface that requires minimal extra code by the user. To use this interface efficiently the user‐provided functions must be copyable to folly::Function without dynamic allocation. If this is impossible or inconvenient, the user is encouraged to use the custom interface described below. ‐ A custom interface that supports custom combining and custom request structure, either for the sake of smart combining or for efficiently supporting operations that are not be copyable to folly::Function without dynamic allocation. ‐ Both synchronous and asynchronous operations. ‐ Request records with and without thread‐caching. ‐ Combining with and without a dedicated combiner thread. |
|
Thread‐safe priority queue based on flat combining. If the constructor parameter maxSize is greater than 0 (default = 0), then the queue is bounded. This template provides blocking, non‐blocking, and timed variants of each of push(), pop(), and peek() operations. The empty() and size() functions are inherently non‐blocking. |
|
Parsed format argument. |
|
Exception class thrown when a format key is not found in the given associative container keyed by strings. We inherit std::out_of_range for compatibility with callers that expect exception to be thrown directly by std::map or std::unordered_map. |
|
Customization point for formatting a value of type |
|
Binds a format string to its arguments for deferred formatting. |
|
A polymorphic, move‐only wrapper for any callable of a given signature. |
|
A reference wrapper for callable objects |
|
Schedules any number of functions to run at various intervals. E.g., |
|
Executor wrapper that adds future‐returning task submission. |
|
FutureSplitter provides a `getFuture()' method which can be called multiple times, returning a new Future each time. These futures are completed when the original Future passed to the FutureSplitter constructor is completed, and are completed on the same executor (if any) and at the same priority as the original Future. Calls to `getFuture()' after that time return a completed Future. |
|
Exception thrown when a FutureSplitter holds no Future. |
|
A concurrent, bounded, approximately‐LRU cache with lock‐free lookups. |
|
Interface for executors that provide a WorkerProvider to collect thread ids. |
|
Knows how to derive a function pointer to the VDSO implementation of getcpu(2), if available |
|
Load counters for the global immutable CPU executor. |
|
A LogFormatter implementation that produces messages in a format similar to that produced by the Google logging library. |
|
The default |
|
Group varint encoder/decoder for 32‐ or 64‐bit integers. |
|
Simplify use of GroupVarint* for the case where the last group in the input may be incomplete (but the exact size of the input is known). Allows for extracting values one at a time. |
|
Simplify use of GroupVarint* for the case where data is available one entry at a time (instead of one group at a time). Handles buffering and an incomplete last chunk. |
|
Hashed Hierarchical Wheel Timer |
|
Generic variadic hasher that dispatches to folly::hasher for each argument. |
|
Assigns thread ids by hashing the platform thread identifier. |
|
A lock‐free LIFO stack that reclaims popped nodes with hazard pointers. |
|
Set implemented as an ordered singly‐linked list. |
|
Wide CAS. |
|
A Timekeeper with a dedicated thread that manages the timeouts using a heap. Timeouts can be scheduled with microsecond resolution, though in practice the accuracy depends on the OS scheduler's ability to wake up the worker thread in a timely fashion. |
|
Equality comparator that enables heterogeneous lookup for key type |
|
Hasher that enables heterogeneous lookup for key type |
|
Trait that is true when two hashers agree on prehash values. |
|
A basic histogram class. |
|
A supported huge page size and its mount point. |
|
IOBuf manages heap‐allocated byte buffers. |
|
Ordering for IOBuf objects. Compares data in the entire chain. |
|
Equality predicate for IOBuf objects. Compares data in the entire chain. |
|
Greater predicate for IOBuf objects. Compares data in the entire chain. |
|
At‐least predicate for IOBuf objects. Compares data in the entire chain. |
|
Hasher for IOBuf objects. Hashes the entire chain using SpookyHashV2. |
|
IOBufIovecBuilder exists to help allocate and fill IOBuf chains using iovec‐based scatter/gather APIs. |
|
Less predicate for IOBuf objects. Compares data in the entire chain. |
|
At‐most predicate for IOBuf objects. Compares data in the entire chain. |
|
Inequality predicate for IOBuf objects. Compares data in the entire chain. |
|
An IOBufQueue encapsulates a chain of IOBufs and provides convenience functions to append data to the back of the chain and remove data from the front. |
|
An executor backed by an I/O event loop. |
|
Caches objects of type T that are bound to an EventBase from the global IOExecutor. |
|
Observer that attaches a deadlock detector to each event base of an IO thread pool. |
|
A Thread Pool for IO bound tasks |
|
Base interface for executors that run tasks on IO threads with EventBases. |
|
A representation of an IP address (IPv4 or IPv6). |
|
Exception that is thrown when dealing with invalid IP addresses. A subclass of |
|
A representation of an IPv4 address. |
|
A representation of an IPv6 address. |
|
A type that is implicitly constructible from and assignable by anything. |
|
A LogWriter implementation that immediately writes to a file descriptor when it is invoked. |
|
ImmutableRequestData is a folly::RequestData that holds an immutable value. It is thread‐safe (a requirement of RequestData) because it is immutable. |
|
|
Deprecated subclass of Synchronized that provides implicit locking via operator‐>. This is intended to ease migration while preventing accidental use of operator‐> in new code. |
A variant of EvictingCacheMap that assigns weights to entries and evicts entries in LRU order to ensure the total weight of all entries stays below some set maximum. ImplicitlyWeighted means this variant derives the weights from the key‐values using a chosen function. TWeightFn must be a type implementing |
|
Wraps an inline object that is never destructed, for Meyers singletons. |
|
Instances of IndexedMemPool dynamically allocate and then pool their element type (T), returning 4‐byte integer indices that can be passed to the pool's operator[]method to access or obtain pointers to the actual elements. The memory backing items returned from the pool will always be readable, even if items have been returned to the pool. These two features are useful for lock‐free algorithms. The indexing behavior makes it easy to build tagged pointer‐like‐things, since a large number of elements can be managed using fewer bits than a full pointer. The access‐after‐free behavior makes it safe to read from T‐s even after they have been recycled, since it is guaranteed that the memory won't have been returned to the OS and unmapped (the algorithm must still use a mechanism to validate that the read was correct, but it doesn't have to worry about page faults), and if the elements use internal sequence numbers it can be guaranteed that there won't be an ABA match due to the element being overwritten with a different type that has the same bit pattern. |
|
A Traits type that controls the object lifecycle strategy of an IndexedMemPool. |
|
RAII object constructed at the beginning of main() and destructed implicitly at the end of main(). |
|
Options controlling folly initialization. |
|
A thread factory that runs setup and teardown callbacks around each thread. |
|
When work is "queued", execute it immediately inline. Usually when you think you want this, you actually want a QueuedImmediateExecutor. |
|
Base class for executors that run queued work inline. |
|
IntrusiveHeap implements a skew heap with intrusive pointers to provide O(log(n)) operations on any node in the heap with no separately allocated node type. |
|
Base class for items to be inserted into IntrusiveHeap<..., Tag> storing pointers for internal use. |
|
Test fixture granted access to node internals. |
|
Exception that is thrown when an IP Address is not of the family expected (ie, expected a V4 but is a V6). A subclass of IPAddressFormatException. |
|
Base class for an io_uring submission queue entry managed by Folly. |
|
A memory arena registered with the kernel for io_uring operations. |
|
The io_uring‐based EventBase backend. |
|
Receives notifications about the outcome of an io_uring connect operation. |
|
Performs an asynchronous connect over an io_uring‐backed socket. |
|
Tracks a file descriptor registered with an io_uring ring. |
|
A pending operation backed by the Linux io_uring interface. |
|
Receives notifications about the progress of an io_uring receive operation. |
|
Manages inbound receives over an io_uring‐backed socket. |
|
Receives notifications about the progress of an io_uring send operation. |
|
Manages a single outbound send over an io_uring‐backed socket. |
|
Trait: true when hasher Hasher avalanches input entropy across every bit of the hash of key Key. |
|
Trait detecting whether a type can be a split() output field. |
|
A trait describing whether a value of type T can be relocated with memcpy. |
|
Trait that identifies string‐like types such as |
|
A trait describing whether value‐initialization equals zero‐filling memory. |
|
An allocator which uses Jemalloc to create a dedicated huge page arena, backed by 2MB huge pages (on linux x86‐64). |
|
An allocator which uses Jemalloc to create an dedicated arena to allocate memory from. The only special property set on the allocated memory is that the memory is not dump‐able. |
|
Similar to AccessSpreader, but it has exactly one stripe for each last‐level cache that is accessible by the current process. |
|
Example: |
|
A singleton whose instance is intentionally never destroyed. |
|
A helper clock type to helper older code using BucketedTimeSeries with std::chrono::seconds transition to properly using clock types and time_point objects. |
|
Concrete LIFO semaphore parameterized by its baton and atomic types. |
|
A blocking multi‐producer, multi‐consumer queue backed by a LIFO semaphore. |
|
LockFreeRingBuffer<T> is a fixed‐size, concurrent ring buffer with the following semantics: |
|
A LockedPtr keeps a Synchronized<T> object locked for the duration of LockedPtr's existence. |
|
Base class that owns the lock held by a |
|
LogCategory stores all of the logging configuration for a specific log category. |
|
Configuration for a LogCategory |
|
Configuration describing log categories and handlers. |
|
Exception thrown when a log configuration string cannot be parsed. |
|
LogFormatter defines the interface for serializing a LogMessage object into a buffer to be given to a LogWriter. |
|
Consumes and processes log messages. |
|
Configuration for a LogHandler |
|
Interface for factories that construct log handlers from config options. |
|
LogMessage represents a single message to be logged. |
|
The LogName class contains utility functions for processing log category names. It primarily handles canonicalization of names. |
|
A std::ostream implementation for use by the logging macros. |
|
A std::streambuf implementation for use by LogStream |
|
LogStreamProcessor receives a LogStream and logs it. |
|
LogStreamVoidify() is a helper class used in the FB_LOG() and XLOG() macros. |
|
Writes serialized log messages to an output. |
|
Logger is the class you will use to specify the log category when logging messages with FB_LOG(). |
|
LoggerDB stores the set of LogCategory objects. |
|
A multi‐producer, multi‐consumer pipeline of processing stages. |
|
Describes a pipeline stage carrying element type T with amplification Amp. |
|
MPMCQueue<T> is a high‐performance bounded concurrent queue that supports multiple producers, multiple consumers, and optional blocking. The queue has a fixed capacity, for which all memory will be allocated up front. The bulk of the work of enqueuing and dequeuing can be performed in parallel. |
|
A 48‐bit ethernet MAC address. |
|
Caches the resolved MIB for a |
|
Caches the resolved MIB for a |
|
Caches the resolved MIB for a |
|
Caches the resolved MIB for a |
|
A ManualExecutor only does work when you turn the crank, by calling run() or indirectly with makeProgress() or waitFor(). |
|
Manually controlled Timekeeper for unit testing. |
|
MaybeManagedPtr stores either a raw pointer or a shared_ptr. It provides normal pointer operations on the underlying raw pointer/shared_ptr. |
|
Node traits for types that hold an IntrusiveHeapNode member. |
|
Maps files in memory (read‐only). |
|
A tiny one‐byte spinlock with a configurable spin and yield budget. |
|
Base class holding the lock byte and the bit‐packing helpers shared by every MicroLock specialization. |
|
A really, really small spinlock for fine‐grained locking of lots of teeny‐tiny data. |
|
C++11 closures don't support move‐in capture. Nor does std::bind. facepalm. |
|
This class represents a timeseries which keeps several levels of data granularity (similar in principle to the loads reported by the UNIX 'uptime' command). It uses several instances (one per level) of BucketedTimeSeries as the underlying storage. |
|
Equivalent to (but more efficient than) a SimpleQuantileEstimator plus one SlidingWindowQuantileEstimator for each requested window. |
|
MutableAtom is a tiny wrapper that gives you the option of atomically updating values inserted into an AtomicUnorderedInsertMap<K, MutableAtom<V>>. This relies on AtomicUnorderedInsertMap's guarantee that it doesn't move values. |
|
MutableData is a tiny wrapper that gives you the option of using an external concurrency control mechanism to updating values inserted into an AtomicUnorderedInsertMap. |
|
NOTE: This is highly experimental. Do not use. |
|
A ThreadFactory that names each thread it creates. |
|
A thin wrapper over the platform's native counting semaphore. |
|
App that uses a nested command line, of the form: |
|
Result of parsing a nested command line. |
|
NetworkSocket is just a very thin wrapper around either a file descriptor or a SOCKET depending on platform, along with a couple of helper methods for explicitly converting to/from file descriptors, even on Windows. |
|
Tag type used to construct an empty Optional, akin to std::nullopt_t. |
|
Queue used to deliver messages to an EventBase thread. |
|
Policy‐based implementation of ObserverContainerBase. |
|
Base ObserverContainer and definition of Observers. |
|
Policy for ObserverContainerBase. |
|
Policy‐based implementation of ObserverContainerStoreBase. |
|
Interface for store of pointers to observers. |
|
Policy for ObserverContainerStore. |
|
Handler for OpenSSL session tickets. |
|
Generic interface applications may implement to convey self or peer certificate related information. |
|
IMPORTANT: |
|
Optional is superseded by std::optional. Now that the C++ has a standardized implementation, Optional exists primarily for backward compatibility. |
|
Exception thrown when unwrapping the value of an empty Optional. |
|
An 8‐byte pointer with an integrated spin lock and 15‐bit integer. |
|
A portable, futex‐like waiter registry keyed by address. |
|
Password collector that reads a passphrase from a file on construction. |
|
Spin lock on a single bit in an integral type. You can use this with 16, 32, or 64‐bit integral types. |
|
|
|
Used in the definition of a |
|
A list of member pointers describing a |
|
Helper that computes the self type of a |
|
Predefined sets of quantiles for use with QuantileHistogram. |
|
PrimaryPtr should be used to achieve deterministic destruction of objects with shared ownership. Once an object is managed by a PrimaryPtr, shared_ptrs can be obtained pointing to that object. However destroying those shared_ptrs will never call the object destructor inline. To destroy the object, join() method must be called on PrimaryPtr or the task returned from cleanup() must be completed, which will wait for all shared_ptrs to be released and then call the object destructor on the caller supplied execution context. |
|
PrimaryPtrRef is a non‐owning reference to the pointer. PrimaryPtr::join() and the PrimaryPtr::cleanup() work do NOT wait for outstanding PrimaryPtrRef objects to be released. |
|
A blocking queue with priority levels backed by per‐priority MPMC queues and a LIFO semaphore. |
|
A ThreadFactory that sets nice values for each thread. The main use case for this class is if there are multiple CPUThreadPoolExecutors in a single process, or between multiple processes, where some should have a higher priority than the others. |
|
A blocking queue with a fixed number of priority levels. |
|
PriorityUnboundedQueueSet |
|
Class to wrap a process return code. |
|
A single‐producer, single‐consumer, lock‐free bounded queue. |
|
Exception that commands may throw to force the program to exit cleanly with a given exit code. NestedCommandLineApp::run() catches this and makes run() print the given message on stderr (followed by a newline, unless empty; the message is only allowed when exiting with a non‐zero status), and return the exit code. (Other exceptions will propagate out of run()) |
|
Summary statistics and quantile estimates produced by a QuantileEstimator. |
|
|
A histogram that tracks the locations of a fixed set of quantiles. |
Exception thrown when adding to a full queue that uses THROW behavior. |
|
Aggregates the worker thread ids per queue name along with their keep‐alives. |
|
Observes enqueue and dequeue events on a queue. |
|
Factory that creates QueueObserver instances for a queue. |
|
Runs inline like InlineExecutor, but with a queue so that any tasks added to this executor by one of its own callbacks will be queued instead of executed inline (nested). This is usually better behavior than Inline. |
|
A simple, small (4‐bytes), but unfair rwlock. Use it when you want a nice writer and don't expect a lot of write/read contention, or when you need small rwlocks since you are creating a large number of them. |
|
Provides static random number generation utilities. |
|
A lightweight, non‐owning view over a range of elements. |
|
Owning pointer that gives cheap, lock‐free reads to shared objects. |
|
This can be used to destroy multiple ReadMostlyMainPtrs at once. |
|
Shared reader handle to a read‐mostly managed object. |
|
Non‐owning weak reference to a read‐mostly managed object. |
|
Class to read from a RecordIO file. Will skip invalid records. |
|
Class to write a stream of RecordIO records to a file. |
|
RegexMatchCache |
|
RegexMatchCacheDynamicBitset |
|
RegexMatchCacheIndexedVector |
|
RegexMatchCacheKey |
|
RegexMatchCacheKeyAndView |
|
A fast, scalable, relaxed concurrent priority queue. |
|
Wraps a |
|
Per‐request context associated with an enqueued item. |
|
RequestContextSaverScopeGuard allows to replace the current context without switching back to original context, while ensuring that the original context is restored on guard destruction. |
|
Note: you probably want to use ShallowCopyRequestContextScopeGuard This resets all other RequestData for the duration of the scope! |
|
Base class for data that follows an async request through a process. |
|
Sets and retrieves the EventBase associated with a request via RequestContext. |
|
A token used to fetch data from a RequestContext. |
|
Run SSL_accept via a runner |
|
Wrap OpenSSL SSL_CTX into a class. |
|
Exception describing an SSL error and its underlying OpenSSL code. |
|
A TimeoutManager backed by a TimerFD that tracks a single timeout. |
|
SaturatingSemaphore is a flag that allows concurrent posting by multiple posters and concurrent non‐destructive waiting by multiple waiters. |
|
An executor that supports timed scheduling. Like RxScheduler. |
|
Helper that runs an EventBase loop on a dedicated std::thread. |
|
This class temporarily unlocks a LockedPtr in a scoped manner. |
|
An executor that sequences tasks whose submissions were sequenced. |
|
Assigns thread ids from a monotonically increasing counter. |
|
A sequenced executor that never runs its tasks concurrently. |
|
This guard maintains all the RequestData pointers of the parent. This allows to overwrite a specific RequestData pointer for the scope's duration, without breaking others. |
|
A small, fast, scalable reader‐writer lock. |
|
Default tuning and feature policy for SharedMutexImpl. |
|
Records where a shared lock was recorded so it can be released quickly. |
|
SharedPromise provides the same interface as Promise, but you can extract multiple Futures from it, i.e. you can call getFuture() as many times as you'd like. When the SharedPromise is fulfilled, all of the Futures are completed. Calls to getFuture() after the SharedPromise is fulfilled return a completed Future. If you find yourself constructing collections of Promises and fulfilling them simultaneously with the same value, consider this utility instead. Likewise, if you find yourself in need of setting multiple callbacks on the same Future (which is indefinitely unsupported), consider refactoring to use SharedPromise to "split" the Future. |
|
The exception thrown when wait()ing on an isShutdown() LifoSem |
|
Set of sockets that allows immediate, take‐no‐prisoners abort. |
|
SimpleAsyncIO is a wrapper around AsyncIO intended to hide all the details. |
|
A QuantileEstimator that buffers writes for 1 second. |
|
SingleWriterFixedHashMap: |
|
Singleton allows for simple access to registering and instantiating singletons. Create instances of this class in the global scope of type Singleton<T> to register your singleton for later access via Singleton<T>::try_get(). |
|
A CRTP base class that keeps a global count of instances of a type. |
|
Provides access to the running instance count of a countable type. |
|
A singleton‐per‐tag relaxed counter. |
|
SingletonThreadLocal |
|
SingletonVault ‐ a library to manage the creation and destruction of interdependent singletons. |
|
A QuantileEstimator that keeps values for nWindows * windowDuration (see constructor). Values are buffered for windowDuration. |
|
Provides a unified interface for socket addresses. |
|
Represents an ordered collection of file descriptors. This union type either contains: ‐ FDs to be sent on a socket ‐‐ with shared ownership, since the sender may still need them, OR ‐ FDs just received, with sole ownership. |
|
Uniquely identifies a handle to a socket option value. Each combination of level and option name corresponds to one socket option value. |
|
Variant container for socket option values: integer or string. Implicit ctor/compares with int for backward compatibility. |
|
Executor that performs priority‐based scheduling with a deadline assigned to each task. |
|
* SparseByteSet |
|
A small, non‐recursive spin lock with a standard lock interface. |
|
Array of spinlocks where each one is padded to prevent false sharing. Useful for shard‐based locking implementations in environments where contention is unlikely. |
|
SplitOptions |
|
StandardLogHandler is a LogHandler implementation that uses a LogFormatter class to serialize the LogMessage into a string, and then gives it to a LogWriter object. |
|
StandardLogHandlerFactory contains helper methods for LogHandlerFactory implementations that create StandardLogHandler objects. |
|
A template for defining ODR‐usable constexpr instances, free of ODR and init‐order problems. |
|
Shared serialising queue used by StrandExecutors to run at most one task at a time. |
|
Executor that serialises work while delegating execution to a parent executor, sharing a StrandContext to serialise across executors. |
|
StreamHandlerFactory is a LogHandlerFactory that constructs log handlers that write to stdout or stderr. |
|
Robust and efficient online computation of statistics, using Welford's method for variance. https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm |
|
A logical conjunction of traits that evaluates all sub‐conditions eagerly. |
|
A logical disjunction of traits that evaluates all sub‐conditions eagerly. |
|
An approximate implementation of an Earliest Deadline First executor. |
|
A BlockingQueue sharded by LLC cache. Compared to the default PriorityUnboundedBlockingQueue, this can reduce contention on systems with a large number of LLC caches, at the cost of unfairness and work conservation; see the StripedThrottledLifoSem documentation for a detailed explanation. |
|
A striped version of ThrottledLifoSem. |
|
Background balancer that periodically corrects stripe imbalances. |
|
Subprocess. |
|
Base exception thrown by the Subprocess methods. |
|
Exception thrown if the subprocess cannot be started. |
|
Error type for trySplitTo(), below. |
|
|
|
SynchronizedBase is a helper parent class for Synchronized<T>. |
|
A |
|
Holds a lock together with access to the element it protects. |
|
SysAllocator |
|
Arena that uses the system allocator (malloc / free) |
|
Deleter that releases memory with |
|
TDigests are a biased quantile estimator designed to estimate the values of the quantiles of streaming data with high accuracy and low memory, particularly for quantiles at the tails (p0.1, p1, p99, p99.9). See https://github.com/tdunning/t‐digest/blob/master/docs/t‐digest‐paper/histo.pdf for an explanation of what the purpose of TDigests is, and how they work. |
|
A reference counter that keeps per‐thread counts to avoid contention. |
|
Abstraction layer for capturing current TCP and congestion control state. |
|
Dispatcher that enables calls to TcpInfo to be intercepted for tests. |
|
Container for folly::TcpInfoDispatcher. |
|
Thread‐caching arena: allocate memory which gets freed when the arena gets destroyed. |
|
A thread‐safe counter that caches increments in thread‐local storage. |
|
Interface for creating threads used by executors. |
|
WorkerProvider backed by an explicitly maintained set of thread ids. |
|
Thread‐local storage for a value of type |
|
A PRNG with one instance per thread. This PRNG uses a mersenne twister random number generator and is seeded from /dev/urandom. It should not be used for anything which requires security, only for statistical randomness. |
|
Thread‐local owning pointer to a value of type |
|
Base class for implementing threadpool based executors. |
|
A hook for tracking which threads belong to which thread pools. This is used only by a gdb extension to aid in debugging. You won't be able to see any useful information from within C++ code. |
|
The default Timekeeper implementation which uses a HHWheelTimer on an EventBase in a dedicated thread. Users needn't deal with this directly, it is used by default by Future methods that work with timeouts. |
|
* ThreadedExecutor |
|
For each function |
|
ThrottledLifoSem is a semaphore that can wait up to a configurable wakeUpInterval before waking up a sleeping waiter. This gives an opportunity to new waiters to consume the posted values, avoiding the overhead of waking up a thread when the already active threads can consume values fast enough, effectively allowing to batch the work. The semaphore is "throttled" because sleeping waiters can be awoken at most once every wakeUpInterval. |
|
A DrivableExecutor can be driven via its drive() method or its driveUntil() that drives until some time point. |
|
This class turns a Executor into a ScheduledExecutor. |
|
Exception thrown when no timekeeper is available for scheduling. |
|
Base interface to be implemented by all classes expecting to manage timeouts. AsyncTimeout will use implementations of this interface to schedule/cancel timeouts. |
|
A queue of scheduled timeout events keyed by expiration time. |
|
Manages many timeouts on a single TimerFD. |
|
TimeseriesHistogram tracks data distributions as they change over time. |
|
Default policy for the token bucket templates, selecting the alignment, atomic type, clock, and concurrency behavior. |
|
Thread‐safe (atomic) token bucket primitive. |
|
Equality comparator for strings of |
|
Hasher for strings of |
|
A wrapper that contains either an instance of |
|
Exception type thrown by |
|
Recursively hashes tuple elements, combining them into a single hash. |
|
Exception thrown when a dynamic is accessed as the wrong type. |
|
Wrapper class to handle a IOBuf as a typed buffer (to a standard layout class). |
|
A view over a UTF‐8 string that iterates it as UTF‐32 code points. |
|
Representation of an unaligned value of a POD type. |
|
An Unaligned<T> variant whose loads and stores can have address sanitizer disabled on demand. |
|
A blocking queue with unbounded capacity. |
|
UnboundedQueue supports a variety of options for unbounded dynamically expanding an shrinking queues, including variations of: ‐ Single vs. multiple producers ‐ Single vs. multiple consumers ‐ Blocking vs. spin‐waiting ‐ Non‐waiting, timed, and waiting consumer operations. Producer operations never wait or fail (unless out‐of‐memory). |
|
Unexpected ‐ a helper type used to disambiguate the construction of Expected objects in the error state. |
|
In functional programming, the degenerate case is often called "unit". In C++, "void" is often the best analogue. However, because of the syntactic special‐casing required for void, it is frequently a liability for template metaprogramming. So, instead of writing specializations to handle cases like SomeContainer<void>, a library author may instead rule that out and simply have library users use SomeContainer<Unit>. Contained values may be ignored. Much easier. |
|
Class representing a URI. |
|
A single user‐defined benchmark metric holding a value and its kind. |
|
Exception thrown when an uninitialized |
|
Light‐weight view onto an existing EventBase. |
|
VirtualExecutor implements a light‐weight view onto existing Executor. |
|
Callback object for |
|
WaitOptions |
|
A variant of EvictingCacheMap that tracks weights for entries and evicts entries in LRU order to ensure the total weight of all entries stays below some set maximum. Weights are stored as a size_t with each entry. |
|
WorkerProvider is a simple interface that can be used to collect information about worker threads that are pulling work from a given queue. |
|
Wrapper class for WriteCallback that includes a boolean variable to track whether the write has already started or not |
|
Helper class that redirects write() and writev() calls to writeChain(). |
|
Options controlling the behavior of writeFileAtomic(). |
|
Per‐XLOG()‐statement storage for the resolved log category. |
|
File‐scope cache of the log level and category shared by a |
|
A file‐static XlogLevelInfo and XlogCategoryInfo object is declared for each XLOG() statement. |
|
Tag type indicating that a lock transition should adopt existing lock state. |
|
A wrapper that stores a value of type T with at least the given alignment. |
|
allocator_delete |
|
Scoped guard that suppresses ThreadSanitizer reports within its lifetime. |
|
For cases when multiple badge holders need to call a function we can use folly::any_badge over each individual holder allowed. We allow subsets of badges to lift into supersets: folly::any_badge[ lifts into folly::any_badge[.]] |
|
Traits providing the asymmetric fence callables for an atomic template. |
|
atomic_grow_array |
|
atomic_grow_array_policy_default |
|
A reference wrapper offering atomic operations on a non‐atomic object. |
|
Atomic wrapper around std::shared_ptr providing lock‐free style operations. |
|
Trait giving the thread‐fence function for an atomic template. |
|
Trait giving the effective value type of an atomic‐like type. |
|
Badge pattern allows us to abstract over friend classes and make friend feature more scoped. Using this simple technique we can specify a badge tag on specific functions we want to gate for particular caller contexts (badge holders). Badge can only be constructed by the specified badge holder binding the tagged functions to that call site. |
|
Exception thrown when base64 decoding fails. |
|
Result of a low‐level base64 decode operation. |
|
cstring_view |
|
This is the basic_string replacement. For conformity, basic_fbstring takes the same template parameters, plus the last one which is the core. |
|
The flag template to be used with call_once. Parameterizable by the mutex type and atomic template. The mutex type is required to mimic std::mutex and the atomic type is required to mimic std::atomic. |
|
A container for C arrays, for returning non‐zero‐sized C arrays from constexpr functions. |
|
An empty type aligned to cacheline_align_v. |
|
Exception thrown by the simple cli_apply_args_files overload. |
|
Options controlling args‐file expansion. |
|
Callback interface receiving events while expanding args‐files. |
|
Start with the user docs in |
|
An alternative flag that can be used with call_once that uses only 1 byte. Uses a 3‐state std::atomic<uint8_t> with wait/notify for synchronization. |
|
Comparison predicate that is true when the underlying comparator |
|
Comparison predicate that is true when the underlying comparator |
|
Comparison predicate that is true when the underlying comparator |
|
Comparison predicate that is true when the underlying comparator |
|
Comparison predicate that is true when the underlying comparator |
|
Comparison predicate that is true when the underlying comparator |
|
/////////////////////////////////////////////////////////////////// |
|
constexpr_iterated_squares_desc |
|
Calculates the duration of time intervals. Prefer this over directly using monotonic clocks. It is very lightweight and provides convenient facilities to avoid common pitfalls. |
|
Default policy handling null‐pointer violations for not_null. |
|
Maps a type to itself, and maps Unit back to |
|
Dummy fbstring core that uses an actual std::string. This doesn't make any sense ‐ it's just for testing purposes. |
|
Forward declaration of folly::dynamic used for serializing results. |
|
A mutable view of a dynamic that can extract values without copying. |
|
Argument tuple for variadic emplace/constructor calls. Stores arguments by (decayed) value. Restores original argument types with reference qualifiers and adornments at unpack time to emulate perfect forwarding. |
|
Empty‐`Try` policy type that maps the empty state to an error |
|
Empty‐`Try` policy that produces a |
|
Holds an error ( |
|
An immutable refcounted string suitable for use in an exception. |
|
Throwing exceptions can be a convenient way to handle errors. Storing exceptions in an |
|
Tag type selecting the factory constructor of |
|
This is the core of the string. The code should work on 32‐ and 64‐bit and both big‐ and little‐endian architectures with any Char size. |
|
Forward declaration of the fbvector container. |
|
floating_point_integral_constant |
|
fmt_vformat_mangle_format_string_fn fmt_vformat_mangle_format_string |
|
Callable that invokes a function for each named argument in a format string. |
|
Transports the cvref‐qualifications of |
|
Yields the function type |
|
Discovers every fact of a function type |
|
get_exception_tag_t |
|
Retrieves the rich error code associated with an error. |
|
Base that grants trusted subclasses a token to bypass null checks. |
|
hash_counter_engine |
|
Primary template for folly's per‐type hasher; specialized for supported key types. |
|
hazptr_array |
|
hazptr_deleter |
|
hazptr_domain |
|
hazptr_holder |
|
Grants hazptr_local access to the thread cache internals. |
|
hazptr_obj |
|
hazptr_obj_base |
|
hazptr_obj_base_linked |
|
hazptr_obj_cohort |
|
hazptr_obj_linked |
|
hazptr_obj_list |
|
hazptr_obj_retired_list |
|
hazptr_rec |
|
hazptr_root |
|
hazptr_tc: |
|
hazptr_tc_entry |
|
Tag type identifying the hazard pointer thread cache's thread‐local singleton. |
|
A heap_vector_map based on heap layout. |
|
heap_vector_set is a specialization of heap_vector_container |
|
A lock‐holder type which holds shared locks for shared mutex types or exclusive locks otherwise. |
|
A lock‐holder base which holds shared locks for shared mutex types or exclusive locks otherwise. |
|
For shared mutex types, effectively |
|
A rich error whose storage has static (immortal) lifetime. |
|
index_iterator |
|
indirect |
|
inheriting_coded_rich_error |
|
Initializer lists are a powerful compile time syntax introduced in C++11 but due to their often conflicting syntax they are not used by APIs for construction. |
|
Composite invoker delegating to the first invoker matching the call. |
|
Wraps a callable made via |
|
Traits container mimicking the C++17 invocation traits for invoker |
|
Trait that detects whether a type is a |
|
A trait type to test whether a type is an allocator. |
|
A trait type that is true when T is an arithmetic type. |
|
A type to check if a given type is a bounded array. |
|
is_complete is_complete_v |
|
A type which determines whether the type parameter is constexpr default‐constructible. |
|
A trait type to test whether a metafunction succeeds in substitution. |
|
Trait that reports whether T is an instantiation of heap_vector_map. |
|
Trait that reports whether T is an instantiation of heap_vector_set. |
|
A type to check if a given type is an instantiation of a class template. |
|
A trait type that is true when T is an integral type. |
|
Trait testing whether |
|
Trait testing whether the result of invoking |
|
A trait type that is true when Int is integral but not bool. |
|
Trait testing whether |
|
Trait testing the nothrow invocation of |
|
Trait testing whether the |
|
Type trait to test if a type is a |
|
A trait type that is true when T is a signed type. |
|
Trait that detects a small_sorted_vector_map specialization. |
|
Trait that detects a small_sorted_vector_set specialization. |
|
Trait that detects whether a type is a folly::small_vector. |
|
Trait that detects a sorted_vector_map specialization. |
|
Trait that detects a sorted_vector_set specialization. |
|
Trait testing whether the |
|
A trait type to test whether a type follows the is‐transparent protocol. |
|
A type to check if a given type is an unbounded array. |
|
A trait type that is true when T is an unsigned type. |
|
A parsed JSON Patch document, as described in RFC 6902 "JSON Patch". |
|
A parsed JSON Pointer, as described in RFC 6901 "JSON Pointer". |
|
Kahan (Kahan‐Babushka‐Neumaier) compensated summation accumulator. |
|
Maps a type to itself, and maps |
|
A trait to replace the cvref category of |
|
literal_c_str |
|
literal_string |
|
A trait that yields the signed integer type corresponding to T. |
|
A trait that yields the unsigned integer type corresponding to T. |
|
A callable wrapper that manually asserts the |
|
A reference wrapper that manually asserts the |
|
A value wrapper that manually asserts the |
|
A type aligned at least as strictly as the most‐aligned fundamental type. |
|
member_pointer_traits |
|
nestable_coded_rich_error |
|
nonesuch |
|
not_null specializable class. |
|
not_null_base, the common interface for all not_null subclasses. ‐ Implicitly constructs and casts just like a PtrT. ‐ Has unwrap() function to access the underlying PtrT. |
|
Awaitable that unwinds a |
|
Awaitable that unwinds an owned |
|
Extension point yielding an order‐preserving reinsertion view of a container. |
|
Extension point returning a reinsertion view or the argument itself. |
|
mimic: std::partial_ordering, c++20 (partial) |
|
A const‐propagating wrapper around a pointer‐like type. |
|
Defines an RCU domain that scopes readers and updaters together. |
|
Base class giving derived objects preallocated RCU retirement storage. |
|
A reentrant mmap‐based allocator. |
|
Configuration options for |
|
Like |
|
A type trait to remove all const volatile and reference qualifiers on a type T |
|
Reproducible floating‐point accumulator via binned floating‐point arithmetic. |
|
Reproducible floating‐point accumulator via binned floating‐point arithmetic. |
|
A value, an error ( |
|
A rich error carrying a user‐defined base type and a formatted message. |
|
Base class for exceptions that carry a queryable rich error code. |
|
Aggregates a rich error's base types with the codes it owns. |
|
Maps an error‐code enum onto the rich‐error machinery. |
|
Query object used to retrieve the rich error code from an exception. |
|
|
|
A message that can automatically capture source locations. |
|
Quacks like |
|
Class template that wraps a reference to an rvalue. Similar to std::reference_wrapper but with three important differences: |
|
Primary trait template that measures the |
|
Computes the |
|
shared_from_this_ptr |
|
A lock‐holder base which holds shared locks, usable with any shared mutex. |
|
A lock‐guard which holds shared locks, usable with any shared mutex type. |
|
Specialize heap_vector_map to integral key type and std::less comparaison. small_heap_map achieve a very fast find for small map < 200 elements. |
|
Forward declaration of the small_vector container. |
|
Tag type indicating a container is sorted but not necessarily unique. |
|
Tag type indicating a container is sorted and unique. |
|
A sorted_vector_map is similar to a sorted_vector_set but stores <key,value> pairs instead of single elements. |
|
A sorted_vector_set is a container similar to std::set<>, but implemented as a sorted array with std::vector<>. |
|
splitmix64_engine |
|
static_function_deleter |
|
Tag type signaling that a work‐tree was stopped (aka cancelled). |
|
|
|
|
|
Holds the result type of a valid |
|
tag_t tag |
|
A container adapter that builds a version of |
|
A synchronized value with a per‐thread cache for accelerated reads. |
|
Alphabet mapping a digit value to its ASCII character, lower‐ or upper‐case. |
|
Holds an integral value for conversion to a floating‐point target type. |
|
Holds a floating‐point value for conversion to an integral target type. |
|
Holds an integral value for possibly‐narrowing conversion to a target type. |
|
Adapter that marks a type as transparent for heterogeneous lookup. |
|
uint_division_result |
|
uint_divisor |
|
A UTF‐8 encoding of a single Unicode code point. |
|
Exception thrown when Unicode decoding or encoding fails. |
|
unique_hash_key |
|
unique_hash_key_with |
|
A lock‐holder base which holds exclusive locks, usable with any mutex type. |
|
A lock‐guard which holds exclusive locks, usable with any mutex type. |
|
Convertible to any default‐constructible type, yielding a default‐initialized value on conversion. |
|
Convenience base or member that tags a type as unsafe for async usage. |
|
Conditionally tags a type as unsafe for async usage. |
|
A lock‐holder type which holds upgrade locks, usable with any upgrade mutex. |
|
A lock‐holder base which holds upgrade locks, usable with any upgrade mutex. |
|
A |
|
variadic_constant_of variadic_constant_of_fn |
|
vtag_t vtag |
|
Decoded x86 cpuid cache descriptor for one cache level. |
|
Vendor identification string as returned by the cpuid instruction. |
|
xoshiro256++ pseudo‐random number generator. |
Type Aliases
Name |
Description |
Standard‐conforming allocator that draws memory from an Arena. |
|
A queue of operations backed by an AsyncIO context. |
|
Base observer‐container type for AsyncSocket observers. |
|
Alias kept for backward compatibility with older transport wrapper names. |
|
AtomicUnorderedInsertMap64 is just a type alias that makes it easier to select a 64 bit slot index type. Use this if you need a capacity bigger than 2ˆ30 (about a billion). This increases memory overheads, obviously. |
|
Alias for BaseFormatterImpl with an index sequence built from |
|
Specialization for |
|
Specialization of |
|
A read‐only view over a sequence of bytes. |
|
Pair of IPAddress, netmask |
|
Pair of IPAddressV4, netmask |
|
Pair of IPAddressV6, netmask |
|
Callback type for functions scheduled on an executor. |
|
A concurrent sorted map with payloads stored inline in the leaves. |
|
A concurrent sorted map with separately stored payloads. |
|
A concurrent sorted set built on ConcurrentBSkipList. |
|
SIMD‐backed ConcurrentHashMap based on F14ValueMap. |
|
An intrusive list with const‐time size() method. |
|
DMPMCQueue |
|
DMPSCQueue |
|
DSPMCQueue |
|
DSPSCQueue |
|
Default reference‐count type used by the read‐mostly smart pointers. |
|
Alias for the default vector type used by xoshiro256pp. |
|
Unique pointer that destroys a DelayedDestruction object via destroy(). |
|
The default distributed mutex, ready to use without template arguments. |
|
folly::Duration is an alias for the best resolution we offer/work with. However, it is not intended to be used for client code ‐ you should use a descriptive std::chrono::duration type instead. e.g. do not write this: |
|
Dynamic token bucket with an adjustable rate and burst size using the default policy. |
|
Alias for an Expected type's associated error_type |
|
Alias for an Expected type's associated value_type |
|
Arena allocator that falls back to std::allocator when the arena is exhausted. |
|
The FallbackGetcpu specialization selected for the current platform. |
|
SysArena allocator that falls back to std::allocator when exhausted. |
|
A fixed‐capacity string of |
|
A move‐only callable holding a unit of work with no arguments or result. |
|
Function type that returns the deadlock detector factory instance. |
|
GroupVarint codec for 32‐bit values. |
|
GroupVarint decoder for 32‐bit values. |
|
GroupVarint codec for 64‐bit values. |
|
GroupVarint decoder for 64‐bit values. |
|
A hashed hierarchical wheel timer with millisecond resolution. |
|
A hashed hierarchical wheel timer with microsecond resolution. |
|
A higher‐resolution duration alias used where microsecond precision is needed. |
|
Vector of (huge_page_size, mount_point), sorted by huge_page_size. mount_point might be empty if no hugetlbfs file system is mounted for that size. |
|
Callable that creates an IOBuf with the requested capacity. |
|
Type of the identity function object. |
|
An alias for Ignore that accepts and ignores any type arguments. |
|
IndexedMemPool traits that implements the eager lifecycle strategy. In this strategy elements are constructed when they are allocated from the pool and destroyed when recycled. |
|
IndexedMemPool traits that implements the lazy lifecycle strategy. In this strategy elements are default‐constructed the first time they are allocated, and destroyed when the pool itself is destroyed. |
|
An intrusive list. |
|
An auto‐unlink intrusive list hook. |
|
A trait to test whether T is one of the types T1, T2, ..., Tn. |
|
Callable that returns information about lagging queues. |
|
LifoSem is a semaphore that wakes its waiters in a manner intended to maximize performance rather than fairness. It should be preferred to a mutex+condvar or POSIX sem_t solution when all of the waiters are equivalent. It is faster than a condvar or sem_t, and it has a shutdown state that might save you a lot of complexity when it comes time to shut down your work pipelines. LifoSem is larger than sem_t, but that is only because it uses padding and alignment to avoid false sharing. |
|
/////////////////////////////////////////////////////////////////// |
|
Function type that builds a QueueObserverFactory. |
|
Caches the resolved MIB for a |
|
Executor that meters how many tasks it feeds into a wrapped executor. |
|
Default MicroLock specialization with the standard spin and yield budget. |
|
A mutable view over a sequence of bytes. |
|
A mutable view over a sequence of |
|
When used in conjunction with |
|
Within the definition of interface |
|
Priority queue set with multi‐producer, multi‐consumer queues. |
|
Priority queue set with multi‐producer, single‐consumer queues. |
|
Priority queue set with single‐producer, multi‐consumer queues. |
|
Priority queue set with single‐producer, single‐consumer queues. |
|
An |
|
The base hash‐key type underlying RegexMatchCacheKey. |
|
A token/data pair used to populate a RequestContext. |
|
Single‐producer version of SmallExecutor. It is the responsibility of the caller to guarantee that calls to add() are externally serialized, but it can be slightly faster. |
|
Shared‐ownership pointer to an SSLContext. |
|
A safe intrusive list. |
|
A safe‐link intrusive list hook. |
|
Executor that runs added tasks serially and in order on a parent executor. |
|
Default SharedMutex; an alias for the write‐priority variant. |
|
SharedMutex variant that gives priority to readers. |
|
SharedMutex variant that suppresses ThreadSanitizer rwlock annotations. |
|
SharedMutex variant that tracks the id of the owning thread. |
|
SharedMutex variant that gives priority to writers. |
|
Maps socket option keys to integer control‐message values. |
|
Maps socket option keys to string control‐message values. |
|
Maps socket option keys to their values. |
|
A read‐only view over a sequence of |
|
Standard‐conforming allocator backed by a SysArena. |
|
A unique_ptr owning a |
|
Standard‐conforming allocator backed by a ThreadCachedArena. |
|
Token bucket with a fixed rate and burst size using the default policy. |
|
Unbounded multi‐producer, multi‐consumer queue. |
|
Unbounded multi‐producer, single‐consumer queue. |
|
Unbounded single‐producer, multi‐consumer queue. |
|
Unbounded single‐producer, single‐consumer queue. |
|
Maps user‐defined counter names to their metric values. |
|
* _t |
|
Type used by hazptr_array and hazptr_local. |
|
An uninitialized storage type suitable for holding an object of type T. |
|
An uninitialized storage type of the given length and alignment. |
|
Mimic the invoke suite of traits for tuple based apply invocation |
|
The result type of applying |
|
The effective value type of an atomic‐like type. |
|
Behaves just like std::back_insert_iterator except that it calls emplace_back() instead of insert(). Uses perfect forwarding. |
|
An aligned wrapper for T using at least cache‐line alignment. |
|
A type alias for |
|
conditional_t |
|
copy_cvref_t |
|
Type of a customization‐point object, deduced from its tag value. |
|
A null‐terminated string view over char. |
|
detected_or |
|
detected_or_t |
|
detected_t |
|
Alias for the type produced by drop_unit. |
|
Behaves just like std::insert_iterator except that it calls emplace() instead of insert(). Uses perfect forwarding. |
|
A helper for defining partial specializations of a hasher class that rely on other partial specializations of that hasher class being usable. |
|
A helper for defining partial specializations of a hasher class that rely on other partial specializations of that hasher class being usable. |
|
erased_unique_ptr |
|
The rich‐error counterpart to |
|
A |
|
Options type for fmt_vformat_mangle_format_string. |
|
Options type for format_string_for_each_named_arg. |
|
Behaves just like std::front_insert_iterator except that it calls emplace_front() instead of insert(). Uses perfect forwarding. |
|
The type of the argument at index |
|
The argument‐list size of the given function type, as an integral_constant. |
|
The function type formed by transporting the cvref of |
|
The function type |
|
The result type of the given function type. |
|
hazard_pointer class name consistent with standard proposal |
|
hazard_pointer_domain class name consistent with standard proposal |
|
hazard_pointer_obj_base class template name consistent with standard proposal |
|
Behaves just like std::insert_iterator except that it calls emplace_hint() instead of insert(). Uses perfect forwarding. |
|
An alias for a std::integral_constant of type std::size_t. |
|
Helper to generate an index sequence from a tuple like type |
|
A signed 128‐bit integer type, where the compiler supports one. |
|
An alias for the signed integer type with |
|
An alias for the signed integer type with the given number of bits. |
|
Holds the result type of invoking |
|
Trait testing whether |
|
Trait testing whether applying |
|
Trait constant that is true when T models the async cleanup concept. |
|
Trait that reports whether T publicly derives from EnablePrimaryFromThis. |
|
Checks that the given hasher template's specialization for the given type is usable with the standard library containters, for example |
|
Checks the requirements that the Hasher class must satisfy in order to be used with the standard library containers, for example |
|
Trait testing whether |
|
Trait testing the nothrow application of |
|
Trait testing whether a nothrow |
|
Trait that is true if |
|
Trait testing whether a |
|
Extracts iterator_category from an iterator. |
|
Extracts a key type from an iterator, leverages the knowledge that key/value containers usually use std::pair<const K, V> as a value_type. |
|
Extracts a mapped type from an iterator. |
|
Extracts reference from an iterator (C++20 iter_reference_t backported) |
|
Extracts a value type from an iterator. |
|
Portable type of a libevent event file descriptor. |
|
Alias for the type produced by lift_unit. |
|
like like_t |
|
An alias for the signed integer type corresponding to T. |
|
An alias for the unsigned integer type corresponding to T. |
|
member_pointer_member_t |
|
member_pointer_object_t |
|
Monotonic clock used as the default time source for stop watches. |
|
Backwards‐compatible alias for |
|
The flag type to be used with call_once. |
|
register_pass_t |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
An alias for the type T with all cv and reference qualifiers removed. |
|
Alias for rich error types to declare fast exception‐lookup hints. |
|
An |
|
A sorted_vector_map backed by a small_vector with inline capacity N. |
|
A sorted_vector_set backed by a small_vector with inline capacity N. |
|
Portable alias for the standard |
|
A type alias for |
|
string_tape ‐ a common usecase. |
|
Digit alphabet producing lowercase letters. |
|
Digit alphabet producing uppercase letters. |
|
type_list_concat_t |
|
type_list_element_t |
|
type_list_find_t |
|
type_list_size_t |
|
In the type pack Ts..., the Ith element. |
|
type_pack_find_t |
|
type_pack_size_t |
|
A type alias for the first template type argument. |
|
An unsigned 128‐bit integer type, where the compiler supports one. |
|
An alias for the unsigned integer type with |
|
An alias for the unsigned integer type with the given number of bits. |
|
Function‐reference type used as the |
|
unique_hash_key_strong_sha256 |
|
Alias to |
|
value_list_concat_t |
|
value_list_element_type_t |
|
value_list_size_t |
|
value_pack_element_type_t |
|
value_pack_size_t |
|
Convenience alias to use instead of |
|
A type alias for |
|
xoshiro256++ generator producing 32‐bit results. |
|
xoshiro256++ generator producing 64‐bit results. |
Enums
Name |
Description |
Defines a special acquisition method for constructing fbstring objects. AcquireMallocatedString means that the user passes a pointer to a malloc‐allocated string that the fbstring object will take into custody. |
|
Consumer::operator() can optionally return AtomicNotificationQueueTaskStatus to indicate if the provided task should be considered consumed or discarded. Discarded tasks are not counted towards maxReadAtOnce_. |
|
Detailed result of an insertion into a ConcurrentBSkipList. |
|
Wraps errors from parsing IP/MASK string |
|
Error codes describing why a string‐to‐value conversion failed. |
|
Error reported when a varint cannot be decoded. |
|
Output style for the default glog‐based |
|
Error codes for non‐throwing interface of IPAddress family of functions. |
|
Selects how Skipper reads a key slot under concurrent writes. |
|
Selects how leaf key/payload data is laid out in memory. |
|
Log level values. |
|
Error codes reported when parsing or constructing a MacAddress fails. |
|
The outcome of a park operation. |
|
Unit families understood by prettyPrint and prettyToDouble. |
|
Process phases |
|
Behavior of a queue when an item is added while the queue is full. |
|
Categories of SSL failure reported by SSLException. |
|
Whether an atomic write syncs to storage to guarantee ordering. |
|
Selects which threads' thread‐local instances are destroyed. |
|
Controls whether a wait node is retained and whether unparking continues. |
|
overloadbrief URI‐escape a string. |
|
Error codes for parsing issues. Used by tryFromString() |
|
Result code returned by UUID parsing functions. |
|
Flags given by the application for write* calls. |
|
The lock mode reported to ThreadSanitizer rwlock annotations. |
|
Error codes reported by args‐file expansion. |
|
Three‐way comparison result: less‐than, equal, or greater‐than. |
|
A hierarchy of memory‐safety levels for a type, from least to most safe. |
|
Recognized x86 CPU vendors. |
Functions
Name |
Description |
Printer for GTest. |
|
Folly's tuned |
|
Set the first |
|
|
|
Acquire locks for multiple Synchronized<T> objects, in a deadlock‐safe manner. |
|
A version of acquireLocked() that returns a std::pair rather than a std::tuple, which is easier to use in many places. |
|
Activate the specified AsyncStackFrame on the specified AsyncStackRoot, setting it as the current 'topFrame'. |
|
Push a dummy "leaf" frame into the stack to annotate the stack as "suspended". |
|
Adds a benchmark. Usually not called directly but instead through the macro BENCHMARK defined below. The lambda function involved can have one of the following forms: * take zero parameters, and the benchmark calls it repeatedly * take exactly one parameter of type unsigned, and the benchmark uses it with counter semantics (iteration occurs inside the function). * 2 versions of the above cases but also accept UserCounters& as as their first parameter. |
|
|
|
|
|
A special case of memcpy() that always copies memory forwards. (libc's memcpy() is allowed to copy memory backwards, and will do so when using SSSE3 instructions). |
|
Free memory previously obtained from |
|
Allocate |
|
Allocate storage for |
|
Creates a not_null_shared_ptr using an allocator, like std::allocate_shared. |
|
Allocate a |
|
allocate_unique, like std::allocate_shared but for std::unique_ptr |
|
Return the number of bytes |
|
Encode a single Unicode code point into a UTF‐8 byte sequence. |
|
Applies the given socket options to a socket at the given position. |
|
|
|
Emits a compiler barrier preventing reordering of memory accesses. |
|
Emits a CPU pause/yield hint suitable for spin‐wait loops. |
|
assume(cond) informs the compiler that cond can be assumed true. If cond is not true at runtime the behavior is undefined. |
|
|
assume_unreachable() informs the compiler that the statement is not reachable at runtime. It is undefined behavior if the statement is actually reached. |
Issue a heavyweight asymmetric thread fence. |
|
Issue a lightweight asymmetric thread fence. |
|
Run a callable asynchronously on the global CPU executor. |
|
Compare‐exchange (strong) that works around a TSAN bug in the standard library version. |
|
Compare‐exchange (weak) that works around a TSAN bug in the standard library version. |
|
|
|
available_concurrency |
|
Convenience function to construct a folly::back_emplace_iterator, analogous to std::back_inserter(). |
|
|
|
|
|
|
|
|
|
|
|
Encode a byte range to standard base64 at runtime. |
|
Compute the encoded size for standard base64. |
|
|
|
|
|
|
|
|
|
|
|
|
|
Encode a byte range to URL‐safe base64 at runtime. |
|
Compute the encoded size for URL‐safe base64. |
|
Deserialize benchmark results from a dynamic value. |
|
Serialize benchmark results into a dynamic value. |
|
Reverse the order of the bits in n. |
|
Evict cache lines by writing to a large block of memory. |
|
Calculates the size of the LLC (Last Level Cache, typically L3 on x86‐64). |
|
|
|
|
|
|
|
Return whether nallocx() is supported by the current allocator. |
|
Return whether sdallocx() is supported by the current allocator. |
|
This returns true if the current platform supports setting the name of the current thread. |
|
This returns true if the current platform supports setting the name of threads other than the one currently executing. |
|
Merge the given tokens into a single CancellationToken. |
|
|
|
Perform some consistency checks on the specified AsyncStackFrame, assuming that it is the currently active AsyncStackFrame. |
|
Checks the return value from a fopen‐style function (non‐null |
|
Checks the return value from a fopen‐style function and throws using an explicit saved |
|
Checks a Linux kernel‐style return code (>= 0 on success, negative error number on error) and throws on error. |
|
Checks a POSIX return code (0 on success, error number on error) and throws on error. |
|
Checks a traditional Unix return code (‐1 and sets |
|
Checks a traditional Unix return code (‐1 on error) and throws using an explicit saved |
|
Allocate |
|
Allocate uninitialized storage for |
|
Trivial wrapper around calloc that check for allocation failure and throw std::bad_alloc in that case. |
|
Trivial wrapper around malloc that check for allocation failure and throw std::bad_alloc in that case. |
|
Trivial wrapper around realloc that check for allocation failure and throw std::bad_alloc in that case. |
|
|
|
Divide two integers, reporting division by zero. |
|
Compute the remainder of integer division, reporting division by zero. |
|
Multiply two unsigned integers, reporting overflow instead of wrapping. |
|
Compute base * mul + add for unsigned integers, reporting overflow. |
|
Clear the n least significant bits of x, leaving the others unchanged. |
|
Clear the n most significant bits of x, leaving the others unchanged. |
|
|
|
Converts a list of strings into a null‐pointer‐terminated array of C strings borrowing the storage of the input strings. |
|
|
|
Encodes a single Unicode code point as a UTF‐8 string. |
|
Resize a vector and shrink its capacity to fit. |
|
Like compareJson, but with dynamic instances. |
|
Like compareJsonWithTolerance, but operates directly on the dynamics. |
|
Compares two JSON strings and returns whether they represent the same document (thus ignoring things like object ordering or multiple representations of the same number). |
|
Like compareJson, but if strNestingDepth > 0 then contained strings that are valid JSON will be compared using compareJsonWithNestedJson(str1, str2, strNestingDepth ‐ 1). |
|
Like compareJson, but allows for the given tolerance when comparing numbers. |
|
Permits the compiler to assume the truth of the provided expression. |
|
Permits the compiler to assume the two pointers address separate storage. |
|
|
Permits the compiler to assume that this statement cannot be reached. |
Marks |
|
Marks |
|
Creates a |
|
|
|
|
|
Casts |
|
Read an unaligned value of type T and return it. Constexpr, but not optimized. Accepts inputs either of char‐array types or char‐backed enum‐array types. |
|
Read an unaligned value of type T and return it. Constexpr, but not optimized. Accepts inputs either of char‐array types or char‐backed enum‐array types. |
|
Compute the absolute value of a number. |
|
Add two values, clamping to the type's range on overflow. |
|
constexpr_ceil |
|
|
|
|
|
|
|
constexpr_find_first_set |
|
constexpr_find_last_set |
|
constexpr_floor |
|
Test whether a value is NaN. |
|
constexpr_log |
|
Compute the integer base‐2 logarithm of a value. |
|
Compute the ceiling of the integer base‐2 logarithm of a value. |
|
Return the maximum of the given values. |
|
Return the minimum of the given values. |
|
constexpr_mult |
|
|
|
constexpr_round |
|
Compares two null‐terminated strings at compile time. |
|
Computes the length of a null‐terminated string at compile time. |
|
Subtract two values, clamping to the type's range on overflow. |
|
|
|
This function checks whether container contains given key. Use container specific .contains() implementation if available, otherwise uses .find() implementation. |
|
Return a well‐typed representation of a dynamic. |
|
copy |
|
copy_through_shared_ptr |
|
copy_through_unique_ptr |
|
copy_to_erased_unique_ptr |
|
copy_to_shared_ptr |
|
copy_to_unique_ptr |
|
Frees memory allocated with coreMalloc(). |
|
An allocator that can be used with AccessSpreader to allocate core‐local memory. |
|
|
|
Compute the CRC‐32 checksum of a buffer, using a hardware‐accelerated implementation if available or a portable software implementation as a default. |
|
Given two checksums, combine them in to one checksum. |
|
Compute the CRC‐32 checksum of a buffer, using a hardware‐accelerated implementation if available or a portable software implementation as a default. |
|
Compute the CRC‐32C checksum of a buffer, using a hardware‐accelerated implementation if available or a portable software implementation as a default. |
|
Combine two CRC‐32C checksums into one, like crc32_combine() but using the CRC‐32C polynomial. |
|
crc32c_combine_seed is the same as crc32c_combine. Unlike crc32c_combine that only works for crc32c computed using a starting checksum 0U, this method works for any starting checksum that is an uint32_t. |
|
current_exception |
|
A convenience shorthand for |
|
Deactivate the specified AsyncStackFrame, clearing the current 'topFrame'. |
|
Pop the dummy "leaf" frame off the stack to annotate the stack as having resumed. |
|
Free storage for |
|
Decode a value from a given buffer, advances data past the returned value. Throws on error. |
|
Reverse the ZigZag encoding produced by encodeZigZag. |
|
Access the process‐wide default hazard pointer domain. |
|
Wraps |
|
|
|
Report whether demangling was built with cxxabi support. |
|
Report whether demangling was built with libiberty support. |
|
Returns whether an outcome represents a fresh insert or a revive. |
|
Returns num/denom, rounded toward positive infinity. Put another way, returns the smallest integral value that is greater than or equal to the exact (not rounded) fraction num/denom. |
|
Returns num/denom, rounded toward negative infinity. Put another way, returns the largest integral value that is less than or equal to the exact (not rounded) fraction num/denom. |
|
Returns num/denom, rounded away from zero. If num and denom are non‐zero and have different signs (so the unrounded fraction num/denom is negative), returns divFloor, otherwise returns divCeil. If T is an unsigned type then this is always equal to divCeil. |
|
Returns num/denom, rounded toward zero. If num and denom are non‐zero and have different signs (so the unrounded fraction num/denom is negative), returns divCeil, otherwise returns divFloor. If T is an unsigned type then this is always equal to divFloor. |
|
Ensure that a value is computed even after optimization. |
|
|
|
|
|
Duplicates a file descriptor onto another, retrying on EINTR. |
|
Duplicates a file descriptor, retrying on EINTR. |
|
|
|
Convenience function to construct a folly::emplace_iterator, analogous to std::inserter(). |
|
empty_erased_unique_ptr |
|
Route hazard pointer reclamation through the global CPU thread pool executor. |
|
Encode a value in the given buffer, returning the number of bytes used for encoding. buf must have enough space to represent the value (at least kMaxVarintLength64 bytes to encode arbitrary 64‐bit values) |
|
Determine the number of bytes needed to represent "val". 32‐bit values need at most 5 bytes. 64‐bit values need at most 10 bytes. |
|
ZigZag encoding that maps signed integers with a small absolute value to unsigned integers with a small (positive) values. Without this, encoding negative values using Varint would use up 9 or 10 bytes. |
|
Composes a task with an async cleanup that always runs after it. |
|
Adapts a range so a range‐based for loop can also observe the iteration index. |
|
|
|
|
|
|
|
Pretty print an errno. |
|
Returns the most appropriate error category for |
|
|
|
|
|
Whether exception‐ptr object inspection is supported on this platform. |
|
|
|
|
|
Returns the true runtime type info of the exception as stored. |
|
exception_ptr_try_get_object_exact_fast |
|
Returns whether the stored exception is uniquely referenced. |
|
Returns the reference count of the stored exception. |
|
Replaces the state of a PrimaryPtr with a new value and returns the old one. |
|
Exchange the current thread's active AsyncStackRoot with the specified AsyncStackRoot pointer, returning the old AsyncStackRoot pointer. |
|
extractFirstSet |
|
Synchronizes a file's data to storage, retrying on EINTR. |
|
Utility method to help access elements of a sequence with one uniform interface. |
|
|
|
Linear search for a value in a range whose size is known at compile time. |
|
findLastSet |
|
Compute the 128‐bit Rabin fingerprint of a string. Return the 64 most significant bits in *msb, and the 64 least significant bits in *lsb. |
|
Return the 64‐bit Rabin fingerprint of a string. |
|
Compute the 96‐bit Rabin fingerprint of a string. Return the 64 most significant bits in *msb, and the 32 least significant bits in *lsb. |
|
Applies an advisory lock, retrying on EINTR. |
|
|
|
Builds a dynamic format‐args store from the key/value pairs in |
|
|
|
folly::for_each is a generalized iteration algorithm. Example: |
|
|
|
Forwards a value with the value category of another type. |
|
Get a tuple of references from the passed tuple, forwarding will be applied on the individual types of the tuple based on the value category of the passed tuple |
|
Convenience function to construct a folly::front_emplace_iterator, analogous to std::front_inserter(). |
|
Synchronizes a file's state to storage, retrying on EINTR. |
|
Truncates a file by descriptor, retrying on EINTR. |
|
Given an initial AsyncStackFrame, this will write |
|
folly::getBaseLoggingConfig() allows individual executables to easily customize their default logging configuration. |
|
|
methodset Deprecated |
Get access to the current thread's top‐most AsyncStackRoot. |
|
Get a process‐specific identifier for the current thread. |
|
Equivalent to getThreadName(std::this_thread::get_id()); |
|
Get a pointer to a special frame that can be used as the root‐frame for a chain of AsyncStackFrame that does not chain onto a normal call‐stack. |
|
|
methodset Deprecated |
Returns the current thread's executor blocking context, if any is active. |
|
methodset Executors |
|
methodset Executors |
|
methodset Executors |
|
methodset Executors |
|
Return the mount point for the requested huge page size. 0 = use smallest available. Returns nullptr if the requested huge page size is not available. |
|
Return the huge page size for a device. returns nullptr if device does not refer to a huge page filesystem. |
|
Get list of supported huge page sizes and their mount points, if hugetlbfs file systems are mounted for those sizes. |
|
|
methodset Deprecated |
Return value of MALLCTL_ARENAS_ALL defined in jemalloc's header. |
|
|
|
Get the operating‐system level thread ID for the current thread. |
|
|
|
Gets the named property. |
|
Returns a CancellationToken that can be used to schedule callbacks. The CancellationToken is cancelled when any of SIGTERM and SIGINT signal is received. |
|
Get the name of the given thread, or nothing if an error occurs or the functionality is not available. |
|
methodset Executors |
|
methodset Executors |
|
methodset Executors |
|
Returns a weak keep‐alive to |
|
Get the default XLOG() category name for the given filename. |
|
Read the bit at position idx from an array of unsigned integers. |
|
Calls getpid() and returns the returned value, with a thread‐safe cache in front. The cache is updated in the child after fork(). |
|
Weak hook resolving to the deadlock detector factory instance getter. |
|
|
|
Getters |
|
|
|
|
|
|
|
|
|
|
|
|
|
Get the current process phase. |
|
|
|
Same as |
|
|
|
|
|
|
|
|
|
JemallocNodumpAllocator singleton. |
|
Simple wrapper around nallocx |
|
Safely compares whether |
|
Grows |
|
Returns a hardware timestamp counter value. |
|
hardware_timestamp_measurement_start hardware_timestamp_measurement_stop |
|
Ends precise measurement of a region of code and returns a timestamp. |
|
Returns if string contains std::isspace or std::iscntrl characters. |
|
|
|
Reclaim all retired objects in a domain that are no longer protected. |
|
Access the process‐wide default hazard pointer domain. |
|
Reclaim all retired objects in a domain that are no longer protected. |
|
Push a list of retired objects into a domain for later reclamation. |
|
Retire an object so it is reclaimed once no hazard pointer protects it. |
|
hazptr_tc_evict ‐‐ Used only for benchmarking |
|
Access the thread‐local hazard pointer cache. |
|
Report whether hazard pointer reclamation may use an executor. |
|
|
|
hex_decode_digit |
|
hex_decode_digit_flavor_aarch64 |
|
hex_decode_digit_flavor_x86_64 |
|
hex_decode_digit_raw |
|
hex_decode_digit_raw_flavor_aarch64 |
|
hex_decode_digit_raw_flavor_x86_64 |
|
hex_decode_digit_table |
|
hex_decoded_digit_is_valid |
|
hex_is_digit |
|
hex_is_digit_flavor_aarch64 |
|
hex_is_digit_flavor_x86_64 |
|
hex_is_digit_table |
|
|
|
Convenience function to construct a folly::hint_emplace_iterator, analogous to std::inserter(). |
|
|
|
Returns the argument unchanged. |
|
|
Initializes folly (deprecated non‐RAII form). |
|
|
|
|
initializeLoggerDB() will be called to configure the main LoggerDB singleton the first time that LoggerDB::get() is called. |
|
Wraps the invocable for lazy conversion to its result type. |
|
|
|
|
invoke_noreturn_cold |
|
|
Returns true if and only if a LogLevel is fatal. |
|
Return true if and only if v is a power of two. |
|
Tests whether all flags of |
|
Returns whether the given leaf frame is currently an active suspended leaf. |
|
Reports whether evaluation occurs in a constant context, with a default. |
|
Determines whether a value is negative, the same as |
|
Determines whether a value is non‐negative, the same as |
|
Determines whether a value is non‐positive, the same as |
|
Determines whether a value is positive, the same as |
|
|
|
|
|
Creates a lazy value whose initialization is deferred until first use. |
|
Safely compares whether |
|
linux_syscall_openat2 |
|
Read an unaligned value of type T and return it. |
|
|
|
|
|
|
|
Get a human‐readable string representing the LogLevel. |
|
Specify characters to ltrim. |
|
Remove leading whitespace. |
|
Creates an |
|
Helper function, so you can write auto bi = makeBitIterator(container.begin()); |
|
Custom Error Translation |
|
Creates a DelayedDestructionUniquePtr owning a new object. |
|
Create a scope guard in the dismissed state. |
|
For constructing an Expected object from a value, with the specified Error type. Usage is as follows: |
|
** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** Construct a |
|
Create a scope guard. |
|
Make a MoveWrapper from the argument. Because the name "makeMoveWrapper" is already quite transparent in its intent, this will work for lvalues as if you had wrapped them in std::move. |
|
|
|
|
|
|
|
|
|
For constructing an Unexpected object from an error code. Unexpected objects are implicitly convertible to Expected object in the error state. Usage is as follows: |
|
Hide a value from the optimizer so it cannot shape the following code. |
|
Constructs a std::array with the given argument list. |
|
Generates a std::array<..., Size> with elements m(i) for i in [0, Size).] |
|
Build an atomic_ref referring to the given object. |
|
|
|
|
|
Pack arguments in a tuple for assignment to a folly::emplace_iterator, folly::front_emplace_iterator, or folly::back_emplace_iterator. The iterator's operator= will unpack the tuple and pass the unpacked arguments to the container's emplace function, which in turn forwards the arguments to the (multi‐argument) constructor of the target class. |
|
make_erased_unique |
|
Builds a std::error_code from an args‐file expansion error code. |
|
|
|
Builds an |
|
|
|
|
|
|
|
|
|
Creates a not_null_shared_ptr, like std::make_shared. |
|
Creates a not_null_unique_ptr, like std::make_unique. |
|
|
|
|
|
Constructs a std::seed_seq from the given seed value. |
|
Invokes a |
|
Reads a value from jemalloc through the named |
|
Writes a value and reads the previous one through the named |
|
Writes a value to jemalloc through the named |
|
Wraps a callable, asserting the given safety level; see |
|
Wraps a reference, asserting the given safety level; see |
|
Wraps a value, asserting the given safety level; see |
|
Wraps the result of |
|
|
|
The load part of a possibly‐composite memory order. |
|
The store part of a possibly‐composite memory order. |
|
|
|
|
|
|
|
mlock2 is Linux‐only and exists since Linux 4.4 On Linux pre‐4.4 and other platforms fail with ENOSYS. glibc added the mlock2 wrapper in 2.27 https://lists.gnu.org/archive/html/info‐gnu/2018‐02/msg00000.html |
|
Copy a file using mmap(). Overwrites dest. |
|
Return a value of type T with the n least significant bits set. |
|
Return a value of type T with the n most significant bits set. |
|
Return the smallest power of two that is greater than or equal to v. |
|
|
|
Convenience wrappers around some commonly used system calls. The *NoInt wrappers retry on EINTR. The *Full wrappers retry on EINTR and also loop until all data is written. Note that *Full wrappers weaken the thread semantics of underlying system calls. |
|
Coawait operators |
|
User‐defined literal building a cstring_view from a string literal. |
|
** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** * User‐defined literals for creating FixedString objects from string literals on the compilers that support it. |
|
Creates a |
|
Creates a |
|
Creates a |
|
Creates a |
|
Creates a |
|
Creates a |
|
User‐defined literal yielding the literal string value. |
|
User‐defined literal yielding a value tag of the literal string. |
|
Creates a shell command formatter from a string literal. |
|
|
|
operator""_uzic |
|
Modulus operators |
|
operator%= |
|
Bitwise conjunction operators |
|
Intersects |
|
Multiplies two dynamics. |
|
Addition operators |
|
Add an integer to a LogLevel in place, capping at LogLevel::MAX_LEVEL. |
|
Subtraction operators |
|
Subtract an integer from a LogLevel in place. |
|
Division operators |
|
operator/= |
|
Right shift operators |
|
Bitwise‐XORs two dynamics. |
|
|
|
|
|
Bitwise disjunction operators |
|
Unions |
|
Computes the complement of a flag set. |
|
|
|
Combine multiple |
|
Parse a json blob out of a range and produce a dynamic representing it. |
|
|
Parse an experimental json5 blob and produce a dynamic representing it. |
|
|
Parse a log configuration string. |
|
Parse a folly::dynamic object. |
|
Parse a JSON configuration string. |
|
|
|
|
|
Read l bytes into the low bits of a value of an unsigned integral type T, where l < sizeof(T). |
|
///////////////////////////////////////////////////////////////////////////// |
|
|
|
///////////////////////////////////////////////////////////////////////////// |
|
///////////////////////////////////////////////////////////////////////////// |
|
///////////////////////////////////////////////////////////////////////////// |
|
Pop the 'callee' frame off the stack, restoring the parent frame as the current frame. |
|
popcount |
|
Like readFull but reads at a given offset. |
|
Reads from a file descriptor at an offset, retrying on EINTR. |
|
Reads into multiple buffers from a file at a given offset. |
|
Like readvFull but scatter‐reads at a given offset. |
|
Scatter‐reads from a file descriptor at an offset, retrying on EINTR. |
|
Pretty printer for numbers with units. |
|
|
|
Returns a statically‐allocated C string containing the pretty name of T. |
|
Print a comparison between two sets of benchmark results. |
|
Generates a 64‐bit id that is unique within the process. The returned ids should not be persisted or passed to other processes, and there are no ordering guarantees. |
|
Push the 'callee' frame onto the current thread's async stack, deactivating the 'caller' frame and setting up the 'caller' to be the parent‐frame of the 'callee'. |
|
Like writeFull but writes at a given offset. |
|
Writes to a file descriptor at an offset, retrying on EINTR. |
|
Writes multiple buffers to a file at a given offset. |
|
Like writevFull but gather‐writes at a given offset. |
|
Gather‐writes to a file descriptor at an offset, retrying on EINTR. |
|
|
|
|
|
Return a good seed for a random number generator. |
|
|
|
Waits for all in‐flight deleters in the domain to complete. |
|
Returns the process‐wide default RCU domain. |
|
Retires a pointer, invoking its deleter after a grace period. |
|
Waits for all pre‐existing RCU readers in the domain to complete. |
|
|
|
Wrapper around read() (and pread()) that, in addition to retrying on EINTR, will loop until all data is read. |
|
Reads from a file descriptor, retrying on EINTR. |
|
Like readFull but scatter‐reads into multiple buffers. |
|
Scatter‐reads from a file descriptor, retrying on EINTR. |
|
|
|
|
|
Casts |
|
|
|
Reserves space for |
|
|
|
Wraps the return value from the lambda |
|
Converts a |
|
|
|
|
rethrow_current_exception |
Finds the last occurrence of needle in haystack. The result is the offset reported to the beginning of haystack, or string::npos if needle wasn't found. |
|
Make a shared locking helper for a const object. |
|
|
|
Specify characters to rtrim. |
|
Remove trailing whitespace. |
|
Runs all benchmarks defined. Usually put in main(). |
|
Runs all benchmarks defined if and only if the ‐‐benchmark flag has been passed to the program. Usually put in main(). |
|
Fills the destination buffer with data generated from the seed sequence. |
|
Returns the position of the k‐th 1 in the 64‐bit word x. k is 0‐based, so k=0 returns the position of the first 1. |
|
|
methodset Deprecated |
|
methodset Deprecated |
|
methodset Deprecated |
Install (or, with all‐null arguments, remove) the keep‐alive object tracing hooks. |
|
|
|
methodset Executors |
|
methodset Executors |
|
methodset Executors |
|
Set the n least significant bits of x, leaving the others unchanged. |
|
Set the n most significant bits of x, leaving the others unchanged. |
|
|
|
Start Regular phase and register handler to set Exit phase. To be called exactly once in each program that uses Folly. Ideally, it is to be called from folly::init(), which in turn is to be called by every program that uses Folly. |
|
|
|
|
|
Quotes an argument to make it suitable for use as shell command arguments. |
|
|
Create argument array for |
Shuts down a socket, retrying on EINTR. |
|
Free a buffer previously returned by checkedAlignedMalloc. |
|
Free a buffer previously returned by checkedArrayMalloc<T>. |
|
Frees's memory using sdallocx if possible |
|
DEPRECATED: Use ltrimWhitespace instead |
|
Reallocs if there is less slack in the buffer, else performs malloc‐copy‐free. |
|
Formats a source location as |
|
|
|
Convenience function, allowing us to exploit template argument deduction to improve readability. |
|
split, to an output iterator |
|
splitmix64 |
|
|
|
|
|
|
|
|
|
Casts |
|
Return the index of the first set bit in a bitset, or bitset.size() if none. |
|
Return the index of the first set bit in a bitset after the given index, or bitset.size() if none. |
|
Write an unaligned value of type T. |
|
Return the smallest power of two that is strictly greater than v. |
|
Return the largest power of two that is strictly less than v. |
|
Append printf‐style output to string. |
|
|
|
Construct a LogLevel from a string name. |
|
Append va_list printf‐style output to string. |
|
|
|
De‐indent a string. |
|
Copy a C string, size‐bounded and always null‐terminated (mimics BSD strlcpy). |
|
|
|
Apply |
|
Acquire locks for multiple Synchronized<> objects, in a deadlock‐safe manner. |
|
|
|
|
terminate_with |
|
Formats a message with fmt and terminates with an exception built from it. |
|
|
|
Throws a |
|
|
|
throw_exception |
|
Formats a message with fmt and throws an exception constructed from it. |
|
|
|
|
|
|
|
|
|
|
|
|
Turn an arbitrary type into a dynamic. |
|
Serialize a dynamic into a json string. |
|
|
|
Serialize a dynamic into a json string with indentation. Note that the keys of all objects will be sorted. |
|
|
|
|
|
|
|
|
|
Number of digits in the base‐Base representation of v. |
|
Number of decimal digits in v; alias of to_ascii_size<10>. |
|
|
|
|
|
Constructs a boolean from the argument. |
|
to_erased_unique_ptr |
|
Wraps the argument for floating‐point conversion. |
|
Wraps the argument for integral conversion. |
|
Wraps the argument for narrowing conversion. |
|
Convert a signed comparison value into the matching |
|
to_shared_ptr |
|
|
|
to_shared_ptr_non_owning |
|
Converts the argument to the corresponding signed type. |
|
Converts an enum value to its underlying type. |
|
Converts the argument to the corresponding unsigned type. |
|
to_weak_ptr |
|
to_weak_ptr_aliasing |
|
Atomically transitions from the from‐lock to the to‐lock, waiting unboundedly for the transition to become available. |
|
|
|
Eventually and atomically upgrades an upgrade lock to an exclusive lock. |
|
Immediately and atomically downgrades an exclusive lock to an upgrade lock. |
|
Specify characters to trim. |
|
Remove leading and trailing whitespace. |
|
Truncates a file by path, retrying on EINTR. |
|
Try to move the value/exception from another |
|
A variant of decodeVarint() that does not throw on error. Useful in contexts where only part of a serialized varint may be attempted to be decoded, e.g., when a serialized varint arrives on the boundary of a network packet. |
|
|
|
|
|
Get access to the current thread's top‐most AsyncStackRoot. |
|
Returns the process‐global shutdown socket set, if one has been installed. |
|
Returns the process‐global shutdown socket set using a read‐mostly pointer. |
|
Try to split a string into a fixed number of fields by delimiter, using folly::tryTo<> for conversions. types by delimiter. ‐ On success, all output values will be initialized and the 'Unit{}' value is returned. Arguments are assigned in reverse order. ‐ On failure, the first failing 'ConversionCode' is returned with its associated substring in a 'SubstringConversionCode'. ‐ String splitting is performed prior to each conversion; field values will not contain the delimiter. ‐ All custom error codes are mapped to ConversionCode::CUSTOM. |
|
|
|
|
|
|
|
|
|
|
|
Attempts an atomic transition from the from‐lock to the to‐lock, without waiting if the transition is not immediately available. |
|
Attempts an atomic transition from the from‐lock to the to‐lock, waiting up to the given timeout for the transition to become available. |
|
Attempts an atomic transition from the from‐lock to the to‐lock, waiting up to the given deadline for the transition to become available. |
|
|
|
|
|
|
|
Immediately attempts to atomically upgrade a shared lock to an upgrade lock. |
|
Attempts, up to a timeout, to atomically upgrade a shared lock to an upgrade lock. |
|
Attempts, up to a deadline, to atomically upgrade a shared lock to an upgrade lock. |
|
|
|
Make an upgrade locking helper. |
|
Clears the flags of |
|
uncaught_exceptions |
|
Wraps a function taking N arguments into a function which accepts a tuple of N arguments. Note: This function will also accept an std::pair if N == 2. |
|
Disambiguation tag for constructing an Expected in the error state. |
|
|
|
Combines a UTF‐16 surrogate pair into a single code point. |
|
Encodes a single Unicode code point into a UTF‐8 byte sequence. |
|
Hash the input items with SHA256, returning a Size‐byte digest. |
|
Initializes folly without an RAII scope guard. |
|
Unwrap a tuple of |
|
|
|
|
|
Determines whether the process is using jemalloc. |
|
Determines whether the process is using tcmalloc. |
|
Returns whether a UTF‐16 code unit lies in the Basic Multilingual Plane. |
|
Returns whether a UTF‐16 code unit is a high surrogate. |
|
Returns whether a UTF‐16 code unit is a low surrogate. |
|
Decode a single Unicode code point from UTF‐8 byte sequence. |
|
|
|
Parses a 36‐byte UUID string into a 16‐byte buffer. |
|
Returns whether the given alignment value is valid. |
|
Returns the subset of options that apply to the given family and position. |
|
Does nothing regardless of the arguments passed. |
|
|
|
|
|
|
|
|
|
|
|
Similar to readFull and preadFull above, wrappers around write() and pwrite() that loop until all data is written. |
|
Writes to a file descriptor, retrying on EINTR. |
|
Like writeFull but gather‐writes from multiple buffers. |
|
Gather‐writes to a file descriptor, retrying on EINTR. |
|
x86_cpuid |
|
Returns cache info for the cache with the given id for the given vendor. |
|
|
|
Detects the CPU vendor via the cpuid instruction. |
|
Returns the maximum supported cpuid leaf for the given leaf group. |
|
Tests whether a character is a directory separator. |
|
Strip directory prefixes from a filename before using it in XLOG macros. |
|
Left shift operators |
|
Equality operators |
|
Inequality operators |
|
Less‐than operators |
|
Less‐than‐or‐equal operators |
|
Greater‐than operators |
|
Greater‐than‐or‐equal operators |
|
Three‐way comparison operators |
Variables
Name |
Description |
Tag value indicating that a lock transition should adopt existing lock state. |
|
always_false |
|
Customization point object that flips a bit and returns its previous value. |
|
Customization point object that atomically transforms an atomic value. |
|
Customization point object that resets a bit and returns its previous value. |
|
Customization point object that sets a bit and returns its previous value. |
|
Wakes all threads waiting on the atomic, like futex wake with max count. |
|
Wakes one thread waiting on the atomic, like futex wake with count 1. |
|
Blocks until the atomic changes from an expected value, like futex wait. |
|
Blocks until the atomic changes or a deadline passes, returning cv_status. |
|
The environment variable name used to cap available_concurrency(). |
|
A value corresponding to hardware_constructive_interference_size but which may be used with alignas, since hardware_constructive_interference_size may be too large on some platforms to be used with alignas. |
|
constexpr_iterated_squares_desc_2_v |
|
constexpr_iterated_squares_desc_size_v |
|
constexpr_iterated_squares_desc_v |
|
Global default domain defined in Hazptr.cpp |
|
Maximum symbol size that demangling will attempt, or 0 for no limit. |
|
An empty socket option map. |
|
The empty‐`Try`‐as‐error policy value. |
|
Tag value selecting the factory constructor of |
|
Callable that mangles the content of vformat format‐strings. |
|
Callable object enumerating the named arguments of a format string. |
|
The number of arguments in the given function type. |
|
True precisely when the given function type is marked noexcept. |
|
True precisely when the given function type is C‐style variadic. |
|
The cache line size for true sharing, from the standard library. |
|
The minimum spacing to avoid false sharing, from the standard library. |
|
has_extended_alignment |
|
hex_alphabet_lower |
|
hex_alphabet_table |
|
hex_alphabet_upper |
|
Tag value used to disambiguate initializer‐list construction. |
|
is_allocator_v is_allocator |
|
True if applying |
|
True if |
|
A trait variable that is true when T is an arithmetic type. |
|
is_bounded_array_v is_bounded_array |
|
A specialization of is_bounded_array_v for bounded array types. |
|
True when T models the async cleanup concept (has a conforming cleanup()). |
|
See is_complete. |
|
is_constexpr_default_constructible_v is_constexpr_default_constructible |
|
True when |
|
Whether a type declares a |
|
A trait variable to test whether a metafunction succeeds in substitution. |
|
True if T publicly derives from EnablePrimaryFromThis. |
|
Checks that the given hasher template's specialization for the given type is usable with the standard library containters, for example |
|
Checks the requirements that the Hasher class must satisfy in order to be used with the standard library containers, for example |
|
True if T is an instantiation of heap_vector_map. |
|
True if T is an instantiation of heap_vector_set. |
|
is_instantiation_of_v is_instantiation_of instantiated_from uncvref_instantiated_from |
|
A specialization of is_instantiation_of_v for matching instantiations. |
|
A trait variable that is true when T is an integral type. |
|
True if invoking |
|
True if |
|
is_non_bool_integral_v |
|
True if the nothrow application of |
|
True if |
|
True if a nothrow invocation of |
|
True if |
|
True if a nothrow |
|
True if the |
|
A trait variable that is true when T is one of the types Ts. |
|
is_register_pass_v |
|
Whether an lvalue reference may be passed in a register; always true. |
|
Whether an rvalue reference may be passed in a register; always true. |
|
A trait variable that is true when T is a signed type. |
|
True if T is a sorted_vector_map backed by a small_vector. |
|
True if T is a sorted_vector_set backed by a small_vector. |
|
|
|
True if T is a sorted_vector_map specialization. |
|
True if T is a sorted_vector_set specialization. |
|
True if a |
|
True if the |
|
is_transparent_v is_transparent |
|
is_unbounded_array_v is_unbounded_array |
|
A specialization of is_unbounded_array_v for unbounded array types. |
|
A trait variable that is true when T is an unsigned type. |
|
True when T is the proxy reference type of a std::vector<bool>. |
|
Specialization recognizing the libc++ std::vector<bool> bit reference. |
|
Whether an iterator's category matches Category (std::input_iterator_tag, std::output_iterator_tag, etc). Defined for non‐iterator types as well. |
|
Whether std::distance over a pair of iterators is reasonably known to give the distance without advancing the iterators or copies of them. |
|
Specialization for a matching iterator and sentinel type. |
|
The Clang major version, or zero when not compiling with Clang. |
|
Default maximum number of core‐local slots used by the cached pointers. |
|
The Dinkumware cpplib version, or zero when not using cpplib. |
|
The default log level used when none is specified. |
|
True when libstdc++ assertions are enabled. |
|
The libstdc++ release version, or zero when not using libstdc++. |
|
The GCC major version, or zero when not compiling with GCC. |
|
True when the current build supports C++ exceptions. |
|
True when run‐time type information (RTTI) is enabled for this build. |
|
True when the target platform supports unaligned loads and stores. |
|
True when the toolchain supports weak symbols. |
|
True if integer division on this platform yields a remainder, i.e. the hardware division instruction produces both quotient and remainder. |
|
Maximum number of |
|
True when the target operating system is Android. |
|
True when the target operating system is an Apple platform. |
|
True when the target Apple platform is iOS. |
|
True when the target Apple platform is macOS. |
|
True when the target Apple platform is tvOS. |
|
True when the target Apple platform is watchOS. |
|
True when targeting the 64‐bit ARM (AArch64) architecture. |
|
True when targeting the 64‐bit x86 (amd64) architecture. |
|
True when targeting the 32‐bit ARM architecture. |
|
True when targeting the 64‐bit PowerPC architecture. |
|
True when targeting the 64‐bit RISC‐V architecture. |
|
True when targeting the 64‐bit IBM Z (s390x) architecture. |
|
True when targeting WebAssembly. |
|
True when targeting 32‐bit WebAssembly. |
|
True when targeting 64‐bit WebAssembly. |
|
True when targeting the 32‐bit x86 architecture. |
|
True when the target platform is big‐endian. |
|
True when compiling with Clang. |
|
True when the current build is a debug build. |
|
True when the target operating system is FreeBSD. |
|
True when the standard library is GNU libstdc++. |
|
True when the standard library is LLVM libc++. |
|
True when folly itself was compiled with AddressSanitizer enabled. |
|
True when the standard library is GNU libstdc++. |
|
True when the target operating system is non‐mobile Linux. |
|
True when the target operating system is Linux, mobile included. |
|
True when the target platform is little‐endian. |
|
True when targeting a mobile platform. |
|
True when the current translation unit is compiled as Objective‐C. |
|
True when the current build is optimized. |
|
True when the current build is optimized for size. |
|
True when the current build uses any sanitizer. |
|
True when the current build uses AddressSanitizer. |
|
True when the current build uses DataFlowSanitizer. |
|
True when the current build uses ThreadSanitizer. |
|
True when the target operating system is Windows. |
|
Environment variable name that controls folly logging configuration. |
|
The compile‐time minimum log level below which XLOG() statements compile out. |
|
Maximum length (in bytes) of the varint encoding of a 32‐bit value. |
|
Maximum length (in bytes) of the varint encoding of a 64‐bit value. |
|
The Microsoft ABI version, or zero when not targeting the Microsoft ABI. |
|
The lowest log level considered fatal for the current build. |
|
The lowest address that may be a valid mapped pointer on this platform. |
|
The MSVC compiler version, or zero when not compiling with MSVC. |
|
Number of bits in a machine word used by the bitset scanning routines. |
|
Write flags that are related to timestamping. |
|
The |
|
Return value that tells for_each to stop iterating. |
|
Return value that tells for_each to continue iterating. |
|
True if |
|
True if type |
|
max_align_v is the alignment of max_align_t. |
|
Constant tag used to clear or construct an empty Optional. |
|
The sentinel value returned by search functions when no match is found. |
|
Whether std::distance over the begin and end iterators is reasonably known to give the distance without advancing the iterators or copies of them. |
|
The pointer to the process‐wide default RCU domain. |
|
register_pass_max_size |
|
require_sizeof |
|
Resizes a container without initializing newly added elements. |
|
Pseudo‐function template handy for disambiguating function overloads. |
|
Tag value indicating a container is sorted but not necessarily unique. |
|
Tag value indicating a container is sorted and unique. |
|
The stopped/cancellation signal value. |
|
The |
|
A generic type‐list value. |
|
Maximum buffer size to hold the base‐Base ASCII form of any value of unsigned type Int. |
|
Maximum buffer size for the decimal ASCII form of Int; alias of to_ascii_size_max<10>. |
|
type_list_find_v |
|
type_list_size_v |
|
type_pack_find_v |
|
type_pack_size_v |
|
Digest size in bytes produced by the given hash algorithm object. |
|
The single value of type Unit. |
|
Object yielding a default‐initialized value on conversion. |
|
value_list_element_v |
|
value_list_size_v |
|
value_pack_element_type_t |
|
value_pack_size_v |
|
An invocable object that ignores its arguments and returns a constant. |
|
A generic value‐list value. |
|
Vendor identification strings indexed by |
Concepts
Name |
Description |
Concept for types supported by folly::findFixed: fixed‐width integers and enums with such an underlying type. |
|
Concept matching types with optional‐like semantics (has_value/value), such as std::optional, folly::Optional, and Thrift optional fields. |
|
A concept satisfied when T is an instantiation of the class template Templ. |
|
Satisfied when |
|
passable_to |
|
Like instantiated_from, but after stripping cvref qualifiers from T. |
|
Concept to check that a type is same as a given type, when stripping qualifiers and refernces. Especially useful for perfect forwarding of a specific type. |
|
Concept satisfied by the proxy reference type of a std::vector<bool>. |
Using Declarations
Name |
Description |
Imported |
|
A trait to test whether values of T and U can be compared with operator==. |
|
A trait to test whether values of T and U can be compared with operator<. |
|
Base that disallows copy but allows move in derived types. |
|
Base that disallows both copy and move in derived types. |
|
/////////////////////////////////////////////////////////////////// |
|
Like std::decay_t but possibly faster to compile. |
|
Sentinel extent value marking a span whose size is known only at runtime. |
|
The result type of invoking |
|
A trait type that is true when one type is nothrow‐convertible to another. |
|
A trait variable that is true when one type is nothrow‐convertible to another. |
|
Most platforms hopefully provide std::nextafter, std::remainder. |
|
Imported |
|
Alias to |
|
The result type of invoking the |
|
Alias to |
Created with MrDocs