source: doc/theses/mubeen_zulfiqar_MMath/allocator.tex @ bb7c77d

ADTast-experimentalpthread-emulationqualifiedEnum
Last change on this file since bb7c77d was bb7c77d, checked in by Peter A. Buhr <pabuhr@…>, 23 months ago

complete proofreading allocator chapter

  • Property mode set to 100644
File size: 60.4 KB
Line 
1\chapter{Allocator}
2
3This chapter presents a new stand-alone concurrent low-latency memory-allocator ($\approx$1,200 lines of code), called llheap (low-latency heap), for C/\CC programs using kernel threads (1:1 threading), and specialized versions of the allocator for the programming languages \uC and \CFA using user-level threads running over multiple kernel threads (M:N threading).
4The new allocator fulfills the GNU C Library allocator API~\cite{GNUallocAPI}.
5
6
7\section{llheap}
8
9The primary design objective for llheap is low-latency across all allocator calls independent of application access-patterns and/or number of threads, \ie very seldom does the allocator have a delay during an allocator call.
10(Large allocations requiring initialization, \eg zero fill, and/or copying are not covered by the low-latency objective.)
11A direct consequence of this objective is very simple or no storage coalescing;
12hence, llheap's design is willing to use more storage to lower latency.
13This objective is apropos because systems research and industrial applications are striving for low latency and computers have huge amounts of RAM memory.
14Finally, llheap's performance should be comparable with the current best allocators (see performance comparison in \VRef[Chapter]{c:Performance}).
15
16% The objective of llheap's new design was to fulfill following requirements:
17% \begin{itemize}
18% \item It should be concurrent and thread-safe for multi-threaded programs.
19% \item It should avoid global locks, on resources shared across all threads, as much as possible.
20% \item It's performance (FIX ME: cite performance benchmarks) should be comparable to the commonly used allocators (FIX ME: cite common allocators).
21% \item It should be a lightweight memory allocator.
22% \end{itemize}
23
24%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25
26\section{Design Choices}
27
28llheap's design was reviewed and changed multiple times throughout the thesis.
29Some of the rejected designs are discussed because they show the path to the final design (see discussion in \VRef{s:MultipleHeaps}).
30Note, a few simples tests for a design choice were compared with the current best allocators to determine the viability of a design.
31
32
33\subsection{Allocation Fastpath}
34\label{s:AllocationFastpath}
35
36These designs look at the allocation/free \newterm{fastpath}, \ie when an allocation can immediately return free storage or returned storage is not coalesced.
37\paragraph{T:1 model}
38\VRef[Figure]{f:T1SharedBuckets} shows one heap accessed by multiple kernel threads (KTs) using a bucket array, where smaller bucket sizes are N-shared across KTs.
39This design leverages the fact that 95\% of allocation requests are less than 1024 bytes and there are only 3--5 different request sizes.
40When KTs $\le$ N, the common bucket sizes are uncontented;
41when KTs $>$ N, the free buckets are contented and latency increases significantly.
42In all cases, a KT must acquire/release a lock, contented or uncontented, along the fast allocation path because a bucket is shared.
43Therefore, while threads are contending for a small number of buckets sizes, the buckets are distributed among them to reduce contention, which lowers latency;
44however, picking N is workload specific.
45
46\begin{figure}
47\centering
48\input{AllocDS1}
49\caption{T:1 with Shared Buckets}
50\label{f:T1SharedBuckets}
51\end{figure}
52
53Problems:
54\begin{itemize}
55\item
56Need to know when a KT is created/destroyed to assign/unassign a shared bucket-number from the memory allocator.
57\item
58When no thread is assigned a bucket number, its free storage is unavailable.
59\item
60All KTs contend for the global-pool lock for initial allocations, before free-lists get populated.
61\end{itemize}
62Tests showed having locks along the allocation fast-path produced a significant increase in allocation costs and any contention among KTs produces a significant spike in latency.
63
64\paragraph{T:H model}
65\VRef[Figure]{f:THSharedHeaps} shows a fixed number of heaps (N), each a local free pool, where the heaps are sharded across the KTs.
66A KT can point directly to its assigned heap or indirectly through the corresponding heap bucket.
67When KT $\le$ N, the heaps are uncontented;
68when KTs $>$ N, the heaps are contented.
69In all cases, a KT must acquire/release a lock, contented or uncontented along the fast allocation path because a heap is shared.
70By adjusting N upwards, this approach reduces contention but increases storage (time versus space);
71however, picking N is workload specific.
72
73\begin{figure}
74\centering
75\input{AllocDS2}
76\caption{T:H with Shared Heaps}
77\label{f:THSharedHeaps}
78\end{figure}
79
80Problems:
81\begin{itemize}
82\item
83Need to know when a KT is created/destroyed to assign/unassign a heap from the memory allocator.
84\item
85When no thread is assigned to a heap, its free storage is unavailable.
86\item
87Ownership issues arise (see \VRef{s:Ownership}).
88\item
89All KTs contend for the local/global-pool lock for initial allocations, before free-lists get populated.
90\end{itemize}
91Tests showed having locks along the allocation fast-path produced a significant increase in allocation costs and any contention among KTs produces a significant spike in latency.
92
93\paragraph{T:H model, H = number of CPUs}
94This design is the T:H model but H is set to the number of CPUs on the computer or the number restricted to an application, \eg via @taskset@.
95(See \VRef[Figure]{f:THSharedHeaps} but with a heap bucket per CPU.)
96Hence, each CPU logically has its own private heap and local pool.
97A memory operation is serviced from the heap associated with the CPU executing the operation.
98This approach removes fastpath locking and contention, regardless of the number of KTs mapped across the CPUs, because only one KT is running on each CPU at a time (modulo operations on the global pool and ownership).
99This approach is essentially an M:N approach where M is the number if KTs and N is the number of CPUs.
100
101Problems:
102\begin{itemize}
103\item
104Need to know when a CPU is added/removed from the @taskset@.
105\item
106Need a fast way to determine the CPU a KT is executing on to access the appropriate heap.
107\item
108Need to prevent preemption during a dynamic memory operation because of the \newterm{serially-reusable problem}.
109\begin{quote}
110A sequence of code that is guaranteed to run to completion before being invoked to accept another input is called serially-reusable code.~\cite{SeriallyReusable}
111\end{quote}
112If a KT is preempted during an allocation operation, the operating system can schedule another KT on the same CPU, which can begin an allocation operation before the previous operation associated with this CPU has completed, invalidating heap correctness.
113Note, the serially-reusable problem can occur in sequential programs with preemption, if the signal handler calls the preempted function, unless the function is serially reusable.
114Essentially, the serially-reusable problem is a race condition on an unprotected critical section, where the operating system is providing the second thread via the signal handler.
115
116Library @librseq@~\cite{librseq} was used to perform a fast determination of the CPU and to ensure all memory operations complete on one CPU using @librseq@'s restartable sequences, which restart the critical section after undoing its writes, if the critical section is preempted.
117\end{itemize}
118Tests showed that @librseq@ can determine the particular CPU quickly but setting up the restartable critical-section along the allocation fast-path produced a significant increase in allocation costs.
119Also, the number of undoable writes in @librseq@ is limited and restartable sequences cannot deal with user-level thread (UT) migration across KTs.
120For example, UT$_1$ is executing a memory operation by KT$_1$ on CPU$_1$ and a time-slice preemption occurs.
121The signal handler context switches UT$_1$ onto the user-level ready-queue and starts running UT$_2$ on KT$_1$, which immediately calls a memory operation.
122Since KT$_1$ is still executing on CPU$_1$, @librseq@ takes no action because it assumes KT$_1$ is still executing the same critical section.
123Then UT$_1$ is scheduled onto KT$_2$ by the user-level scheduler, and its memory operation continues in parallel with UT$_2$ using references into the heap associated with CPU$_1$, which corrupts CPU$_1$'s heap.
124If @librseq@ had an @rseq_abort@ which:
125\begin{enumerate}
126\item
127Marked the current restartable critical-section as cancelled so it restarts when attempting to commit.
128\item
129Do nothing if there is no current restartable critical section in progress.
130\end{enumerate}
131Then @rseq_abort@ could be called on the backside of a  user-level context-switching.
132A feature similar to this idea might exist for hardware transactional-memory.
133A significant effort was made to make this approach work but its complexity, lack of robustness, and performance costs resulted in its rejection.
134
135\paragraph{1:1 model}
136This design is the T:H model with T = H, where there is one thread-local heap for each KT.
137(See \VRef[Figure]{f:THSharedHeaps} but with a heap bucket per KT and no bucket or local-pool lock.)
138Hence, immediately after a KT starts, its heap is created and just before a KT terminates, its heap is (logically) deleted.
139Heaps are uncontended for a KTs memory operations to its heap (modulo operations on the global pool and ownership).
140
141Problems:
142\begin{itemize}
143\item
144Need to know when a KT is starts/terminates to create/delete its heap.
145
146\noindent
147It is possible to leverage constructors/destructors for thread-local objects to get a general handle on when a KT starts/terminates.
148\item
149There is a classic \newterm{memory-reclamation} problem for ownership because storage passed to another thread can be returned to a terminated heap.
150
151\noindent
152The classic solution only deletes a heap after all referents are returned, which is complex.
153The cheap alternative is for heaps to persist for program duration to handle outstanding referent frees.
154If old referents return storage to a terminated heap, it is handled in the same way as an active heap.
155To prevent heap blowup, terminated heaps can be reused by new KTs, where a reused heap may be populated with free storage from a prior KT (external fragmentation).
156In most cases, heap blowup is not a problem because programs have a small allocation set-size, so the free storage from a prior KT is apropos for a new KT.
157\item
158There can be significant external fragmentation as the number of KTs increases.
159
160\noindent
161In many concurrent applications, good performance is achieved with the number of KTs proportional to the number of CPUs.
162Since the number of CPUs is relatively small, >~1024, and a heap relatively small, $\approx$10K bytes (not including any associated freed storage), the worst-case external fragmentation is still small compared to the RAM available on large servers with many CPUs.
163\item
164There is the same serially-reusable problem with UTs migrating across KTs.
165\end{itemize}
166Tests showed this design produced the closest performance match with the best current allocators, and code inspection showed most of these allocators use different variations of this approach.
167
168
169\vspace{5pt}
170\noindent
171The conclusion from this design exercise is: any atomic fence, atomic instruction (lock free), or lock along the allocation fastpath produces significant slowdown.
172For the T:1 and T:H models, locking must exist along the allocation fastpath because the buckets or heaps maybe shared by multiple threads, even when KTs $\le$ N.
173For the T:H=CPU and 1:1 models, locking is eliminated along the allocation fastpath.
174However, T:H=CPU has poor operating-system support to determine the CPU id (heap id) and prevent the serially-reusable problem for KTs.
175More operating system support is required to make this model viable, but there is still the serially-reusable problem with user-level threading.
176Leaving the 1:1 model with no atomic actions along the fastpath and no special operating-system support required.
177The 1:1 model still has the serially-reusable problem with user-level threading, which is addressed in \VRef{s:UserlevelThreadingSupport}, and the greatest potential for heap blowup for certain allocation patterns.
178
179
180% \begin{itemize}
181% \item
182% A decentralized design is better to centralized design because their concurrency is better across all bucket-sizes as design 1 shards a few buckets of selected sizes while other designs shards all the buckets. Decentralized designs shard the whole heap which has all the buckets with the addition of sharding @sbrk@ area. So Design 1 was eliminated.
183% \item
184% Design 2 was eliminated because it has a possibility of contention in-case of KT > N while Design 3 and 4 have no contention in any scenario.
185% \item
186% Design 3 was eliminated because it was slower than Design 4 and it provided no way to achieve user-threading safety using librseq. We had to use CFA interruption handling to achieve user-threading safety which has some cost to it.
187% that  because of 4 was already slower than Design 3, adding cost of interruption handling on top of that would have made it even slower.
188% \end{itemize}
189% Of the four designs for a low-latency memory allocator, the 1:1 model was chosen for the following reasons:
190
191% \subsection{Advantages of distributed design}
192%
193% The distributed design of llheap is concurrent to work in multi-threaded applications.
194% Some key benefits of the distributed design of llheap are as follows:
195% \begin{itemize}
196% \item
197% The bump allocation is concurrent as memory taken from @sbrk@ is sharded across all heaps as bump allocation reserve. The call to @sbrk@ will be protected using locks but bump allocation (on memory taken from @sbrk@) will not be contended once the @sbrk@ call has returned.
198% \item
199% Low or almost no contention on heap resources.
200% \item
201% It is possible to use sharing and stealing techniques to share/find unused storage, when a free list is unused or empty.
202% \item
203% Distributed design avoids unnecessary locks on resources shared across all KTs.
204% \end{itemize}
205
206\subsection{Allocation Latency}
207
208A primary goal of llheap is low latency.
209Two forms of latency are internal and external.
210Internal latency is the time to perform an allocation, while external latency is time to obtain/return storage from/to the operating system.
211Ideally latency is $O(1)$ with a small constant.
212
213To obtain $O(1)$ internal latency means no searching on the allocation fastpath, largely prohibits coalescing, which leads to external fragmentation.
214The mitigating factor is that most programs have well behaved allocation patterns, where the majority of allocation operations can be $O(1)$, and heap blowup does not occur without coalescing (although the allocation footprint may be slightly larger).
215
216To obtain $O(1)$ external latency means obtaining one large storage area from the operating system and subdividing it across all program allocations, which requires a good guess at the program storage high-watermark and potential large external fragmentation.
217Excluding real-time operating-systems, operating-system operations are unbounded, and hence some external latency is unavoidable.
218The mitigating factor is that operating-system calls can often be reduced if a programmer has a sense of the storage high-watermark and the allocator is capable of using this information (see @malloc_expansion@ \VPageref{p:malloc_expansion}).
219Furthermore, while operating-system calls are unbounded, many are now reasonably fast, so their latency is tolerable and infrequent.
220
221
222%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
223
224\section{llheap Structure}
225
226\VRef[Figure]{f:llheapStructure} shows the design of llheap, which uses the following features:
227\begin{itemize}
228\item
2291:1 multiple-heap model to minimize the fastpath,
230\item
231can be built with or without heap ownership,
232\item
233headers per allocation versus containers,
234\item
235no coalescing to minimize latency,
236\item
237global heap memory (pool) obtained from the operating system using @mmap@ to create and reuse heaps needed by threads,
238\item
239local reserved memory (pool) per heap obtained from global pool,
240\item
241global reserved memory (pool) obtained from the operating system using @sbrk@ call,
242\item
243optional fast-lookup table for converting allocation requests into bucket sizes,
244\item
245optional statistic-counters table for accumulating counts of allocation operations.
246\end{itemize}
247
248\begin{figure}
249\centering
250% \includegraphics[width=0.65\textwidth]{figures/NewHeapStructure.eps}
251\input{llheap}
252\caption{llheap Structure}
253\label{f:llheapStructure}
254\end{figure}
255
256llheap starts by creating an array of $N$ global heaps from storage obtained using @mmap@, where $N$ is the number of computer cores, that persists for program duration.
257There is a global bump-pointer to the next free heap in the array.
258When this array is exhausted, another array is allocated.
259There is a global top pointer for a heap intrusive link to chain free heaps from terminated threads.
260When statistics are turned on, there is a global top pointer for a heap intrusive link to chain \emph{all} the heaps, which is traversed to accumulate statistics counters across heaps using @malloc_stats@.
261
262When a KT starts, a heap is allocated from the current array for exclusive use by the KT.
263When a KT terminates, its heap is chained onto the heap free-list for reuse by a new KT, which prevents unbounded growth of heaps.
264The free heaps is a stack so hot storage is reused first.
265Preserving all heaps created during the program lifetime, solves the storage lifetime problem, when ownership is used.
266This approach wastes storage if a large number of KTs are created/terminated at program start and then the program continues sequentially.
267llheap can be configured with object ownership, where an object is freed to the heap from which it is allocated, or object no-ownership, where an object is freed to the KT's current heap.
268
269Each heap uses segregated free-buckets that have free objects distributed across 91 different sizes from 16 to 4M.
270The number of buckets used is determined dynamically depending on the crossover point from @sbrk@ to @mmap@ allocation using @mallopt( M_MMAP_THRESHOLD )@, \ie small objects managed by the program and large objects managed by the operating system.
271Each free bucket of a specific size has the following two lists:
272\begin{itemize}
273\item
274A free stack used solely by the KT heap-owner, so push/pop operations do not require locking.
275The free objects are a stack so hot storage is reused first.
276\item
277For ownership, a shared away-stack for KTs to return storage allocated by other KTs, so push/pop operations require locking.
278When the free stack is empty, the entire ownership stack is removed and becomes the head of the corresponding free stack.
279\end{itemize}
280
281Algorithm~\ref{alg:heapObjectAlloc} shows the allocation outline for an object of size $S$.
282First, the allocation is divided into small (@sbrk@) or large (@mmap@).
283For large allocations, the storage is mapped directly from the operating system.
284For small allocations, $S$ is quantized into a bucket size.
285Quantizing is performed using a binary search over the ordered bucket array.
286An optional optimization is fast lookup $O(1)$ for sizes < 64K from a 64K array of type @char@, where each element has an index to the corresponding bucket.
287(Type @char@ restricts the number of bucket sizes to 256.)
288For $S$ > 64K, a binary search is used.
289Then, the allocation storage is obtained from the following locations (in order), with increasing latency.
290\begin{enumerate}[topsep=0pt,itemsep=0pt,parsep=0pt]
291\item
292bucket's free stack,
293\item
294bucket's away stack,
295\item
296heap's local pool
297\item
298global pool
299\item
300operating system (@sbrk@)
301\end{enumerate}
302
303\begin{figure}
304\vspace*{-10pt}
305\begin{algorithm}[H]
306\small
307\caption{Dynamic object allocation of size $S$}\label{alg:heapObjectAlloc}
308\begin{algorithmic}[1]
309\State $\textit{O} \gets \text{NULL}$
310\If {$S >= \textit{mmap-threshhold}$}
311        \State $\textit{O} \gets \text{allocate dynamic memory using system call mmap with size S}$
312\Else
313        \State $\textit{B} \gets \text{smallest free-bucket} \geq S$
314        \If {$\textit{B's free-list is empty}$}
315                \If {$\textit{B's away-list is empty}$}
316                        \If {$\textit{heap's allocation buffer} < S$}
317                                \State $\text{get allocation from global pool (which might call \lstinline{sbrk})}$
318                        \EndIf
319                        \State $\textit{O} \gets \text{bump allocate an object of size S from allocation buffer}$
320                \Else
321                        \State $\textit{merge B's away-list into free-list}$
322                        \State $\textit{O} \gets \text{pop an object from B's free-list}$
323                \EndIf
324        \Else
325                \State $\textit{O} \gets \text{pop an object from B's free-list}$
326        \EndIf
327        \State $\textit{O's owner} \gets \text{B}$
328\EndIf
329\State $\Return \textit{ O}$
330\end{algorithmic}
331\end{algorithm}
332
333\vspace*{-15pt}
334\begin{algorithm}[H]
335\small
336\caption{Dynamic object free at address $A$ with object ownership}\label{alg:heapObjectFreeOwn}
337\begin{algorithmic}[1]
338\If {$\textit{A mapped allocation}$}
339        \State $\text{return A's dynamic memory to system using system call \lstinline{munmap}}$
340\Else
341        \State $\text{B} \gets \textit{O's owner}$
342        \If {$\textit{B is thread-local heap's bucket}$}
343                \State $\text{push A to B's free-list}$
344        \Else
345                \State $\text{push A to B's away-list}$
346        \EndIf
347\EndIf
348\end{algorithmic}
349\end{algorithm}
350
351\vspace*{-15pt}
352\begin{algorithm}[H]
353\small
354\caption{Dynamic object free at address $A$ without object ownership}\label{alg:heapObjectFreeNoOwn}
355\begin{algorithmic}[1]
356\If {$\textit{A mapped allocation}$}
357        \State $\text{return A's dynamic memory to system using system call \lstinline{munmap}}$
358\Else
359        \State $\text{B} \gets \textit{O's owner}$
360        \If {$\textit{B is thread-local heap's bucket}$}
361                \State $\text{push A to B's free-list}$
362        \Else
363                \State $\text{C} \gets \textit{thread local heap's bucket with same size as B}$
364                \State $\text{push A to C's free-list}$
365        \EndIf
366\EndIf
367\end{algorithmic}
368\end{algorithm}
369\end{figure}
370
371Algorithm~\ref{alg:heapObjectFreeOwn} shows the de-allocation (free) outline for an object at address $A$ with ownership.
372First, the address is divided into small (@sbrk@) or large (@mmap@).
373For large allocations, the storage is unmapped back to the operating system.
374For small allocations, the bucket associated with the request size is retrieved.
375If the bucket is local to the thread, the allocation is pushed onto the thread's associated bucket.
376If the bucket is not local to the thread, the allocation is pushed onto the owning thread's associated away stack.
377
378Algorithm~\ref{alg:heapObjectFreeNoOwn} shows the de-allocation (free) outline for an object at address $A$ without ownership.
379The algorithm is the same as for ownership except if the bucket is not local to the thread.
380Then the corresponding bucket of the owner thread is computed for the deallocating thread, and the allocation is pushed onto the deallocating thread's bucket.
381
382Finally, the llheap design funnels \label{p:FunnelRoutine} all allocation/deallocation operations through routines @malloc@/@free@, which are the only routines to directly access and manage the internal data structures of the heap.
383Other allocation operations, \eg @calloc@, @memalign@, and @realloc@, are composed of calls to @malloc@ and possibly @free@, and may manipulate header information after storage is allocated.
384This design simplifies heap-management code during development and maintenance.
385
386
387\subsection{Alignment}
388
389All dynamic memory allocations must have a minimum storage alignment for the contained object(s).
390Often the minimum memory alignment, M, is the bus width (32 or 64-bit) or the largest register (double, long double) or largest atomic instruction (DCAS) or vector data (MMMX).
391In general, the minimum storage alignment is 8/16-byte boundary on 32/64-bit computers.
392For consistency, the object header is normally aligned at this same boundary.
393Larger alignments must be a power of 2, such page alignment (4/8K).
394Any alignment request, N, $\le$ the minimum alignment is handled as a normal allocation with minimal alignment.
395
396For alignments greater than the minimum, the obvious approach for aligning to address @A@ is: compute the next address that is a multiple of @N@ after the current end of the heap, @E@, plus room for the header before @A@ and the size of the allocation after @A@, moving the end of the heap to @E'@.
397\begin{center}
398\input{Alignment1}
399\end{center}
400The storage between @E@ and @H@ is chained onto the appropriate free list for future allocations.
401This approach is also valid within any sufficiently large free block, where @E@ is the start of the free block, and any unused storage before @H@ or after the allocated object becomes free storage.
402In this approach, the aligned address @A@ is the same as the allocated storage address @P@, \ie @P@ $=$ @A@ for all allocation routines, which simplifies deallocation.
403However, if there are a large number of aligned requests, this approach leads to memory fragmentation from the small free areas around the aligned object.
404As well, it does not work for large allocations, where many memory allocators switch from program @sbrk@ to operating-system @mmap@.
405The reason is that @mmap@ only starts on a page boundary, and it is difficult to reuse the storage before the alignment boundary for other requests.
406Finally, this approach is incompatible with allocator designs that funnel allocation requests through @malloc@ as it directly manipulates management information within the allocator to optimize the space/time of a request.
407
408Instead, llheap alignment is accomplished by making a \emph{pessimistically} allocation request for sufficient storage to ensure that \emph{both} the alignment and size request are satisfied, \eg:
409\begin{center}
410\input{Alignment2}
411\end{center}
412The amount of storage necessary is @alignment - M + size@, which ensures there is an address, @A@, after the storage returned from @malloc@, @P@, that is a multiple of @alignment@ followed by sufficient storage for the data object.
413The approach is pessimistic because if @P@ already has the correct alignment @N@, the initial allocation has already requested sufficient space to move to the next multiple of @N@.
414For this special case, there is @alignment - M@ bytes of unused storage after the data object, which subsequently can be used by @realloc@.
415
416Note, the address returned is @A@, which is subsequently returned to @free@.
417However, to correctly free the allocated object, the value @P@ must be computable, since that is the value generated by @malloc@ and returned within @memalign@.
418Hence, there must be a mechanism to detect when @P@ $\neq$ @A@ and how to compute @P@ from @A@.
419
420The llheap approach uses two headers:
421the \emph{original} header associated with a memory allocation from @malloc@, and a \emph{fake} header within this storage before the alignment boundary @A@, which is returned from @memalign@, e.g.:
422\begin{center}
423\input{Alignment2Impl}
424\end{center}
425Since @malloc@ has a minimum alignment of @M@, @P@ $\neq$ @A@ only holds for alignments of @M@ or greater.
426When @P@ $\neq$ @A@, the minimum distance between @P@ and @A@ is @M@ bytes, due to the pessimistic storage-allocation.
427Therefore, there is always room for an @M@-byte fake header before @A@.
428
429The fake header must supply an indicator to distinguish it from a normal header and the location of address @P@ generated by @malloc@.
430This information is encoded as an offset from A to P and the initialize alignment (discussed in \VRef{s:ReallocStickyProperties}).
431To distinguish a fake header from a normal header, the least-significant bit of the alignment is used because the offset participates in multiple calculations, while the alignment is just remembered data.
432\begin{center}
433\input{FakeHeader}
434\end{center}
435
436
437\subsection{\lstinline{realloc} and Sticky Properties}
438\label{s:ReallocStickyProperties}
439
440Allocation routine @realloc@ provides a memory-management pattern for shrinking/enlarging an existing allocation, while maintaining some or all of the object data, rather than performing the following steps manually.
441\begin{flushleft}
442\begin{tabular}{ll}
443\multicolumn{1}{c}{\textbf{realloc pattern}} & \multicolumn{1}{c}{\textbf{manually}} \\
444\begin{lstlisting}
445T * naddr = realloc( oaddr, newSize );
446
447
448
449\end{lstlisting}
450&
451\begin{lstlisting}
452T * naddr = (T *)malloc( newSize ); $\C[2.4in]{// new storage}$
453memcpy( naddr, addr, oldSize );  $\C{// copy old bytes}$
454free( addr );                           $\C{// free old storage}$
455addr = naddr;                           $\C{// change pointer}\CRT$
456\end{lstlisting}
457\end{tabular}
458\end{flushleft}
459The realloc pattern leverages available storage at the end of an allocation due to bucket sizes, possibly eliminating a new allocation and copying.
460This pattern is not used enough to reduce storage management costs.
461In fact, if @oaddr@ is @nullptr@, @realloc@ does a @malloc@, so even the initial @malloc@ can be a @realloc@ for consistency in the pattern.
462
463The hidden problem for this pattern is the effect of zero fill and alignment with respect to reallocation.
464Are these properties transient or persistent (``sticky'')?
465For example, when memory is initially allocated by @calloc@ or @memalign@ with zero fill or alignment properties, respectively, what happens when those allocations are given to @realloc@ to change size.
466That is, if @realloc@ logically extends storage into unused bucket space or allocates new storage to satisfy a size change, are initial allocation properties preserve?
467Currently, allocation properties are not preserved, so subsequent use of @realloc@ storage may cause inefficient execution or errors due to lack of zero fill or alignment.
468This silent problem is unintuitive to programmers and difficult to locate because it is transient.
469To prevent these problems, llheap preserves initial allocation properties for the lifetime of an allocation and the semantics of @realloc@ are augmented to preserve these properties, with additional query routines.
470This change makes the realloc pattern efficient and safe.
471
472
473\subsection{Header}
474
475To preserve allocation properties requires storing additional information with an allocation,
476The only available location is the header, where \VRef[Figure]{f:llheapNormalHeader} shows the llheap storage layout.
477The header has two data field sized appropriately for 32/64-bit alignment requirements.
478The first field is a union of three values:
479\begin{description}
480\item[bucket pointer]
481is for allocated storage and points back to the bucket associated with this storage requests (see \VRef[Figure]{f:llheapStructure} for the fields accessible in a bucket).
482\item[mapped size]
483is for mapped storage and is the storage size for use in unmapping.
484\item[next free block]
485is for free storage and is an intrusive pointer chaining same-size free blocks onto a bucket's free stack.
486\end{description}
487The second field remembers the request size versus the allocation (bucket) size, \eg request 42 bytes which is rounded up to 64 bytes.
488Since programmers think in request sizes rather than allocation sizes, the request size allows better generation of statistics or errors.
489
490\begin{figure}
491\centering
492\input{Header}
493\caption{llheap Normal Header}
494\label{f:llheapNormalHeader}
495\end{figure}
496
497The low-order 3-bits of the first field are \emph{unused} for any stored values, whereas the second field may use all of its bits.
498The 3 unused bits are used to represent mapped allocation, zero filled, and alignment, respectively.
499Note, the alignment bit is not used in the normal header and the zero-filled/mapped bits are not used in the fake header.
500This implementation allows a fast test if any of the lower 3-bits are on (@&@ and compare).
501If no bits are on, it implies a basic allocation, which is handled quickly;
502otherwise, the bits are analysed and appropriate actions are taken for the complex cases.
503Since most allocations are basic, this implementation results in a significant performance gain along the allocation and free fastpath.
504
505
506\section{Statistics and Debugging}
507
508llheap can be built to accumulate fast and largely contention-free allocation statistics to help understand allocation behaviour.
509Incrementing statistic counters must appear on the allocation fastpath.
510As noted, any atomic operation along the fastpath produces a significant increase in allocation costs.
511To make statistics performant enough for use on running systems, each heap has its own set of statistic counters, so heap operations do not require atomic operations.
512
513To locate all statistic counters, heaps are linked together in statistics mode, and this list is locked and traversed to sum all counters across heaps.
514Note, the list is locked to prevent errors traversing an active list;
515the statistics counters are not locked and can flicker during accumulation, which is not an issue with atomic read/write.
516\VRef[Figure]{f:StatiticsOutput} shows an example of statistics output, which covers all allocation operations and information about deallocating storage not owned by a thread.
517No other memory allocator studied provides as comprehensive statistical information.
518Finally, these statistics were invaluable during the development of this thesis for debugging and verifying correctness, and hence, should be equally valuable to application developers.
519
520\begin{figure}
521\begin{lstlisting}
522Heap statistics: (storage request / allocation)
523  malloc >0 calls 2,766; 0 calls 2,064; storage 12,715 / 13,367 bytes
524  aalloc >0 calls 0; 0 calls 0; storage 0 / 0 bytes
525  calloc >0 calls 6; 0 calls 0; storage 1,008 / 1,104 bytes
526  memalign >0 calls 0; 0 calls 0; storage 0 / 0 bytes
527  amemalign >0 calls 0; 0 calls 0; storage 0 / 0 bytes
528  cmemalign >0 calls 0; 0 calls 0; storage 0 / 0 bytes
529  resize >0 calls 0; 0 calls 0; storage 0 / 0 bytes
530  realloc >0 calls 0; 0 calls 0; storage 0 / 0 bytes
531  free !null calls 2,766; null calls 4,064; storage 12,715 / 13,367 bytes
532  away pulls 0; pushes 0; storage 0 / 0 bytes
533  sbrk calls 1; storage 10,485,760 bytes
534  mmap calls 10,000; storage 10,000 / 10,035 bytes
535  munmap calls 10,000; storage 10,000 / 10,035 bytes
536  threads started 4; exited 3
537  heaps new 4; reused 0
538\end{lstlisting}
539\caption{Statistics Output}
540\label{f:StatiticsOutput}
541\end{figure}
542
543llheap can also be built with debug checking, which inserts many asserts along all allocation paths.
544These assertions detect incorrect allocation usage, like double frees, unfreed storage, or memory corruptions because internal values (like header fields) are overwritten.
545These checks are best effort as opposed to complete allocation checking as in @valgrind@.
546Nevertheless, the checks detect many allocation problems.
547There is an unfortunate problem in detecting unfreed storage because some library routines assume their allocations have life-time duration, and hence, do not free their storage.
548For example, @printf@ allocates a 1024 buffer on first call and never deletes this buffer.
549To prevent a false positive for unfreed storage, it is possible to specify an amount of storage that is never freed (see @malloc_unfreed@ \VPageref{p:malloc_unfreed}), and it is subtracted from the total allocate/free difference.
550Determining the amount of never-freed storage is annoying, but once done, any warnings of unfreed storage are application related.
551
552Tests indicate only a 30\% performance increase when statistics \emph{and} debugging are enabled, and the latency cost for accumulating statistic is mitigated by limited calls, often only one at the end of the program.
553
554
555\section{User-level Threading Support}
556\label{s:UserlevelThreadingSupport}
557
558The serially-reusable problem (see \VRef{s:AllocationFastpath}) occurs for kernel threads in the ``T:H model, H = number of CPUs'' model and for user threads in the ``1:1'' model, where llheap uses the ``1:1'' model.
559The solution is to prevent interrupts that can result in CPU or KT change during operations that are logically critical sections.
560Locking these critical sections negates any attempt for a quick fastpath and results in high contention.
561For user-level threading, the serially-reusable problem appears with time slicing for preemptable scheduling, as the signal handler context switches to another user-level thread.
562Without time slicing, a user thread performing a long computation can prevent execution (starve) other threads.
563To prevent starvation for an allocation-active thread, \ie the time slice always triggers in an allocation critical-section for one thread, a thread-local \newterm{rollforward} flag is set in the signal handler when it aborts a time slice.
564The rollforward flag is tested at the end of each allocation funnel routine (see \VPageref{p:FunnelRoutine}), and if set, it is reset and a volunteer yield (context switch) is performed to allow other threads to execute.
565
566llheap uses two techniques to detect when execution is in a allocation operation or routine called from allocation operation, to abort any time slice during this period.
567On the slowpath when executing expensive operations, like @sbrk@ or @mmap@, interrupts are disabled/enabled by setting thread-local flags so the signal handler aborts immediately.
568On the fastpath, disabling/enabling interrupts is too expensive as accessing thread-local storage can be expensive and not thread-safe.
569For example, the ARM processor stores the thread-local pointer in a coprocessor register that cannot perform atomic base-displacement addressing.
570Hence, there is a window between loading the thread-local pointer from the coprocessor register into a normal register and adding the displacement when a time slice can move a thread.
571
572The fast technique defines a special code section and places all non-interruptible routines in this section.
573The linker places all code in this section into a contiguous block of memory, but the order of routines within the block is unspecified.
574Then, the signal handler compares the program counter at the point of interrupt with the the start and end address of the non-interruptible section, and aborts if executing within this section and sets the rollforward flag.
575This technique is fragile because any calls in the non-interruptible code outside of the non-interruptible section (like @sbrk@) must be bracketed with disable/enable interrupts and these calls must be along the slowpath.
576Hence, for correctness, this approach requires inspection of generated assembler code for routines placed in the non-interruptible section.
577This issue is mitigated by the llheap funnel design so only funnel routines and a few statistics routines are placed in the non-interruptible section and their assembler code examined.
578These techniques are used in both the \uC and \CFA versions of llheap, where both of these systems have user-level threading.
579
580
581\section{Bootstrapping}
582
583There are problems bootstrapping a memory allocator.
584\begin{enumerate}
585\item
586Programs can be statically or dynamically linked.
587\item
588The order the linker schedules startup code is poorly supported.
589\item
590Knowing a KT's start and end independently from the KT code is difficult.
591\end{enumerate}
592
593For static linking, the allocator is loaded with the program.
594Hence, allocation calls immediately invoke the allocator operation defined by the loaded allocation library and there is only one memory allocator used in the program.
595This approach allows allocator substitution by placing an allocation library before any other in the linked/load path.
596
597Allocator substitution is similar for dynamic linking, but the problem is that the dynamic loader starts first and needs to perform dynamic allocations \emph{before} the substitution allocator is loaded.
598As a result, the dynamic loader uses a default allocator until the substitution allocator is loaded, after which all allocation operations are handled by the substitution allocator, including from the dynamic loader.
599Hence, some part of the @sbrk@ area may be used by the default allocator and statistics about allocation operations cannot be correct.
600Furthermore, dynamic linking goes through trampolines, so there is an additional cost along the allocator fastpath for all allocation operations.
601Testing showed up to a 5\% performance increase for dynamic linking over static linking, even when using @tls_model("initial-exec")@ so the dynamic loader can obtain tighter binding.
602
603All allocator libraries need to perform startup code to initialize data structures, such as the heap array for llheap.
604The problem is getting initialized done before the first allocator call.
605However, there does not seem to be mechanism to tell either the static or dynamic loader to first perform initialization code before any calls to a loaded library.
606As a result, calls to allocation routines occur without initialization.
607To deal with this problem, it is necessary to put a conditional initialization check along the allocation fastpath to trigger initialization (singleton pattern).
608
609Two other important execution points are program startup and termination, which include prologue or epilogue code to bootstrap a program, which programmers are unaware of.
610For example, dynamic-memory allocations before/after the application starts should not be considered in statistics because the application does not make these calls.
611llheap establishes these two points using routines:
612\begin{lstlisting}
613__attribute__(( constructor( 100 ) )) static void startup( void ) {
614        // clear statistic counters
615        // reset allocUnfreed counter
616}
617__attribute__(( destructor( 100 ) )) static void shutdown( void ) {
618        // sum allocUnfreed for all heaps
619        // subtract global unfreed storage
620        // if allocUnfreed > 0 then print warning message
621}
622\end{lstlisting}
623which use global constructor/destructor priority 100, where the linker calls these routines at program prologue/epilogue in increasing/decreasing order of priority.
624Application programs may only use global constructor/destructor priorities greater than 100.
625Hence, @startup@ is called after the program prologue but before the application starts, and @shutdown@ is called after the program terminates but before the program epilogue.
626By resetting counters in @startup@, prologue allocations are ignored, and checking unfreed storage in @shutdown@ checks only application memory management, ignoring the program epilogue.
627
628While @startup@/@shutdown@ apply to the program KT, a concurrent program creates additional KTs that do not trigger these routines.
629However, it is essential for the allocator to know when each KT is started/terminated.
630One approach is to create a thread-local object with a construct/destructor, which is triggered after a new KT starts and before it terminates, respectively.
631\begin{lstlisting}
632struct ThreadManager {
633        volatile bool pgm_thread;
634        ThreadManager() {} // unusable
635        ~ThreadManager() { if ( pgm_thread ) heapManagerDtor(); }
636};
637static thread_local ThreadManager threadManager;
638\end{lstlisting}
639Unfortunately, thread-local variables are created lazily, \ie on the first dereference of @threadManager@, which then triggers its constructor.
640Therefore, the constructor is useless for knowing when a KT starts because the KT must reference it, and the allocator does not control the application KT.
641Fortunately, the singleton pattern needed for initializing the program KT also triggers KT allocator initialization, which can then reference @pgm_thread@ to call @threadManager@'s constructor, otherwise its destructor is not called.
642Now when a KT terminates, @~ThreadManager@ is called to chained it onto the global-heap free-stack, where @pgm_thread@ is set to true only for the program KT.
643The conditional destructor call prevents closing down the program heap, which must remain available because epilogue code may free more storage.
644
645Finally, there is a recursive problem when the singleton pattern dereferences @pgm_thread@ to initialize the thread-local object, because its initialization calls @atExit@, which immediately calls @malloc@ to obtain storage.
646This recursion is handled with another thread-local flag to prevent double initialization.
647A similar problem exists when the KT terminates and calls member @~ThreadManager@, because immediately afterwards, the terminating KT calls @free@ to deallocate the storage obtained from the @atExit@.
648In the meantime, the terminated heap has been put on the global-heap free-stack, and may be active by a new KT, so the @atExit@ free is handled as a free to another heap and put onto the away list using locking.
649
650For user threading systems, the KTs are controlled by the runtime, and hence, start/end pointers are known and interact directly with the llheap allocator for \uC and \CFA, which eliminates or simplifies several of these problems.
651The following API was created to provide interaction between the language runtime and the allocator.
652\begin{lstlisting}
653void startTask();                       $\C{// KT starts}$
654void finishTask();                      $\C{// KT ends}$
655void startup();                         $\C{// when application code starts}$
656void shutdown();                        $\C{// when application code ends}$
657bool traceHeap();                       $\C{// enable allocation/free printing for debugging}$
658bool traceHeapOn();                     $\C{// start printing allocation/free calls}$
659bool traceHeapOff();                    $\C{// stop printing allocation/free calls}$
660\end{lstlisting}
661This kind of API is necessary to allow concurrent runtime systems to interact with difference memory allocators in a consistent way.
662
663%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
664
665\section{Added Features and Methods}
666
667The C dynamic-allocation API (see \VRef[Figure]{f:CDynamicAllocationAPI}) is neither orthogonal nor complete.
668For example,
669\begin{itemize}
670\item
671It is possible to zero fill or align an allocation but not both.
672\item
673It is \emph{only} possible to zero fill an array allocation.
674\item
675It is not possible to resize a memory allocation without data copying.
676\item
677@realloc@ does not preserve initial allocation properties.
678\end{itemize}
679As a result, programmers must provide these options, which is error prone, resulting in blaming the entire programming language for a poor dynamic-allocation API.
680Furthermore, newer programming languages have better type systems that can provide safer and more powerful APIs for memory allocation.
681
682\begin{figure}
683\begin{lstlisting}
684void * malloc( size_t size );
685void * calloc( size_t nmemb, size_t size );
686void * realloc( void * ptr, size_t size );
687void * reallocarray( void * ptr, size_t nmemb, size_t size );
688void free( void * ptr );
689void * memalign( size_t alignment, size_t size );
690void * aligned_alloc( size_t alignment, size_t size );
691int posix_memalign( void ** memptr, size_t alignment, size_t size );
692void * valloc( size_t size );
693void * pvalloc( size_t size );
694
695struct mallinfo mallinfo( void );
696int mallopt( int param, int val );
697int malloc_trim( size_t pad );
698size_t malloc_usable_size( void * ptr );
699void malloc_stats( void );
700int malloc_info( int options, FILE * fp );
701\end{lstlisting}
702\caption{C Dynamic-Allocation API}
703\label{f:CDynamicAllocationAPI}
704\end{figure}
705
706The following presents design and API changes for C, \CC (\uC), and \CFA, all of which are implemented in llheap.
707
708
709\subsection{Out of Memory}
710
711Most allocators use @nullptr@ to indicate an allocation failure, specifically out of memory;
712hence the need to return an alternate value for a zero-sized allocation.
713A different approach allowed by the C API is to abort a program when out of memory and return @nullptr@ for a zero-sized allocation.
714In theory, notifying the programmer of memory failure allows recovery;
715in practice, it is almost impossible to gracefully recover when out of memory.
716Hence, the cheaper approach of returning @nullptr@ for a zero-sized allocation is chosen because no pseudo allocation is necessary.
717
718
719\subsection{C Interface}
720
721For C, it is possible to increase functionality and orthogonality of the dynamic-memory API to make allocation better for programmers.
722
723For existing C allocation routines:
724\begin{itemize}
725\item
726@calloc@ sets the sticky zero-fill property.
727\item
728@memalign@, @aligned_alloc@, @posix_memalign@, @valloc@ and @pvalloc@ set the sticky alignment property.
729\item
730@realloc@ and @reallocarray@ preserve sticky properties.
731\end{itemize}
732
733The C dynamic-memory API is extended with the following routines:
734
735\paragraph{\lstinline{void * aalloc( size_t dim, size_t elemSize )}}
736extends @calloc@ for allocating a dynamic array of objects without calculating the total size of array explicitly but \emph{without} zero-filling the memory.
737@aalloc@ is significantly faster than @calloc@, which is the only alternative.
738
739\noindent\textbf{Usage}
740@aalloc@ takes two parameters.
741\begin{itemize}
742\item
743@dim@: number of array objects
744\item
745@elemSize@: size of array object
746\end{itemize}
747It returns the address of the dynamic array or @NULL@ if either @dim@ or @elemSize@ are zero.
748
749\paragraph{\lstinline{void * resize( void * oaddr, size_t size )}}
750extends @realloc@ for resizing an existing allocation \emph{without} copying previous data into the new allocation or preserving sticky properties.
751@resize@ is significantly faster than @realloc@, which is the only alternative.
752
753\noindent\textbf{Usage}
754@resize@ takes two parameters.
755\begin{itemize}
756\item
757@oaddr@: address to be resized
758\item
759@size@: new allocation size (smaller or larger than previous)
760\end{itemize}
761It returns the address of the old or new storage with the specified new size or @NULL@ if @size@ is zero.
762
763\paragraph{\lstinline{void * amemalign( size_t alignment, size_t dim, size_t elemSize )}}
764extends @aalloc@ and @memalign@ for allocating an aligned dynamic array of objects.
765Sets sticky alignment property.
766
767\noindent\textbf{Usage}
768@amemalign@ takes three parameters.
769\begin{itemize}
770\item
771@alignment@: alignment requirement
772\item
773@dim@: number of array objects
774\item
775@elemSize@: size of array object
776\end{itemize}
777It returns the address of the aligned dynamic-array or @NULL@ if either @dim@ or @elemSize@ are zero.
778
779\paragraph{\lstinline{void * cmemalign( size_t alignment, size_t dim, size_t elemSize )}}
780extends @amemalign@ with zero fill and has the same usage as @amemalign@.
781Sets sticky zero-fill and alignment property.
782It returns the address of the aligned, zero-filled dynamic-array or @NULL@ if either @dim@ or @elemSize@ are zero.
783
784\paragraph{\lstinline{size_t malloc_alignment( void * addr )}}
785returns the alignment of the dynamic object for use in aligning similar allocations.
786
787\noindent\textbf{Usage}
788@malloc_alignment@ takes one parameter.
789\begin{itemize}
790\item
791@addr@: address of an allocated object.
792\end{itemize}
793It returns the alignment of the given object, where objects not allocated with alignment return the minimal allocation alignment.
794
795\paragraph{\lstinline{bool malloc_zero_fill( void * addr )}}
796returns true if the object has the zero-fill sticky property for use in zero filling similar allocations.
797
798\noindent\textbf{Usage}
799@malloc_zero_fill@ takes one parameters.
800
801\begin{itemize}
802\item
803@addr@: address of an allocated object.
804\end{itemize}
805It returns true if the zero-fill sticky property is set and false otherwise.
806
807\paragraph{\lstinline{size_t malloc_size( void * addr )}}
808returns the request size of the dynamic object (updated when an object is resized) for use in similar allocations.
809See also @malloc_usable_size@.
810
811\noindent\textbf{Usage}
812@malloc_size@ takes one parameters.
813\begin{itemize}
814\item
815@addr@: address of an allocated object.
816\end{itemize}
817It returns the request size or zero if @addr@ is @NULL@.
818
819\paragraph{\lstinline{int malloc_stats_fd( int fd )}}
820changes the file descriptor where @malloc_stats@ writes statistics (default @stdout@).
821
822\noindent\textbf{Usage}
823@malloc_stats_fd@ takes one parameters.
824\begin{itemize}
825\item
826@fd@: files description.
827\end{itemize}
828It returns the previous file descriptor.
829
830\paragraph{\lstinline{size_t malloc_expansion()}}
831\label{p:malloc_expansion}
832set the amount (bytes) to extend the heap when there is insufficient free storage to service an allocation request.
833It returns the heap extension size used throughout a program, \ie called once at heap initialization.
834
835\paragraph{\lstinline{size_t malloc_mmap_start()}}
836set the crossover between allocations occurring in the @sbrk@ area or separately mapped.
837It returns the crossover point used throughout a program, \ie called once at heap initialization.
838
839\paragraph{\lstinline{size_t malloc_unfreed()}}
840\label{p:malloc_unfreed}
841amount subtracted to adjust for unfreed program storage (debug only).
842It returns the new subtraction amount and called by @malloc_stats@.
843
844
845\subsection{\CC Interface}
846
847The following extensions take advantage of overload polymorphism in the \CC type-system.
848
849\paragraph{\lstinline{void * resize( void * oaddr, size_t nalign, size_t size )}}
850extends @resize@ with an alignment re\-quirement.
851
852\noindent\textbf{Usage}
853takes three parameters.
854\begin{itemize}
855\item
856@oaddr@: address to be resized
857\item
858@nalign@: alignment requirement
859\item
860@size@: new allocation size (smaller or larger than previous)
861\end{itemize}
862It returns the address of the old or new storage with the specified new size and alignment, or @NULL@ if @size@ is zero.
863
864\paragraph{\lstinline{void * realloc( void * oaddr, size_t nalign, size_t size )}}
865extends @realloc@ with an alignment re\-quirement and has the same usage as aligned @resize@.
866
867
868\subsection{\CFA Interface}
869
870The following extensions take advantage of overload polymorphism in the \CFA type-system.
871The key safety advantage of the \CFA type system is using the return type to select overloads;
872hence, a polymorphic routine knows the returned type and its size.
873This capability is used to remove the object size parameter and correctly cast the return storage to match the result type.
874For example, the following is the \CFA wrapper for C @malloc@:
875\begin{cfa}
876forall( T & | sized(T) ) {
877        T * malloc( void ) {
878                if ( _Alignof(T) <= libAlign() ) return @(T *)@malloc( @sizeof(T)@ ); // C allocation
879                else return @(T *)@memalign( @_Alignof(T)@, @sizeof(T)@ ); // C allocation
880        } // malloc
881\end{cfa}
882and is used as follows:
883\begin{lstlisting}
884int * i = malloc();
885double * d = malloc();
886struct Spinlock { ... } __attribute__(( aligned(128) ));
887Spinlock * sl = malloc();
888\end{lstlisting}
889where each @malloc@ call provides the return type as @T@, which is used with @sizeof@, @_Alignof@, and casting the storage to the correct type.
890This interface removes many of the common allocation errors in C programs.
891\VRef[Figure]{f:CFADynamicAllocationAPI} show the \CFA wrappers for the equivalent C/\CC allocation routines with same semantic behaviour.
892
893\begin{figure}
894\begin{lstlisting}
895T * malloc( void );
896T * aalloc( size_t dim );
897T * calloc( size_t dim );
898T * resize( T * ptr, size_t size );
899T * realloc( T * ptr, size_t size );
900T * memalign( size_t align );
901T * amemalign( size_t align, size_t dim );
902T * cmemalign( size_t align, size_t dim  );
903T * aligned_alloc( size_t align );
904int posix_memalign( T ** ptr, size_t align );
905T * valloc( void );
906T * pvalloc( void );
907\end{lstlisting}
908\caption{\CFA C-Style Dynamic-Allocation API}
909\label{f:CFADynamicAllocationAPI}
910\end{figure}
911
912In addition to the \CFA C-style allocator interface, a new allocator interface is provided to further increase orthogonality and usability of dynamic-memory allocation.
913This interface helps programmers in three ways.
914\begin{itemize}
915\item
916naming: \CFA regular and @ttype@ polymorphism is used to encapsulate a wide range of allocation functionality into a single routine name, so programmers do not have to remember multiple routine names for different kinds of dynamic allocations.
917\item
918named arguments: individual allocation properties are specified using postfix function call, so programmers do have to remember parameter positions in allocation calls.
919\item
920object size: like the \CFA C-style interface, programmers do not have to specify object size or cast allocation results.
921\end{itemize}
922Note, postfix function call is an alternative call syntax, using backtick @`@, where the argument appears before the function name, \eg
923\begin{cfa}
924duration ?@`@h( int h );                // ? denote the position of the function operand
925duration ?@`@m( int m );
926duration ?@`@s( int s );
927duration dur = 3@`@h + 42@`@m + 17@`@s;
928\end{cfa}
929@ttype@ polymorphism is similar to \CC variadic templates.
930
931\paragraph{\lstinline{T * alloc( ... )} or \lstinline{T * alloc( size_t dim, ... )}}
932is overloaded with a variable number of specific allocation routines, or an integer dimension parameter followed by a variable number specific allocation routines.
933A call without parameters returns a dynamically allocated object of type @T@ (@malloc@).
934A call with only the dimension (dim) parameter returns a dynamically allocated array of objects of type @T@ (@aalloc@).
935The variable number of arguments consist of allocation properties, which can be combined to produce different kinds of allocations.
936The only restriction is for properties @realloc@ and @resize@, which cannot be combined.
937
938The allocation property functions are:
939\subparagraph{\lstinline{T_align ?`align( size_t alignment )}}
940to align the allocation.
941The alignment parameter must be $\ge$ the default alignment (@libAlign()@ in \CFA) and a power of two, \eg:
942\begin{cfa}
943int * i0 = alloc( @4096`align@ );  sout | i0 | nl;
944int * i1 = alloc( 3, @4096`align@ );  sout | i1; for (i; 3 ) sout | &i1[i]; sout | nl;
945
9460x555555572000
9470x555555574000 0x555555574000 0x555555574004 0x555555574008
948\end{cfa}
949returns a dynamic object and object array aligned on a 4096-byte boundary.
950
951\subparagraph{\lstinline{S_fill(T) ?`fill ( /* various types */ )}}
952to initialize storage.
953There are three ways to fill storage:
954\begin{enumerate}
955\item
956A char fills each byte of each object.
957\item
958An object of the returned type fills each object.
959\item
960An object array pointer fills some or all of the corresponding object array.
961\end{enumerate}
962For example:
963\begin{cfa}[numbers=left]
964int * i0 = alloc( @0n`fill@ );  sout | *i0 | nl;  // disambiguate 0
965int * i1 = alloc( @5`fill@ );  sout | *i1 | nl;
966int * i2 = alloc( @'\xfe'`fill@ ); sout | hex( *i2 ) | nl;
967int * i3 = alloc( 5, @5`fill@ );  for ( i; 5 ) sout | i3[i]; sout | nl;
968int * i4 = alloc( 5, @0xdeadbeefN`fill@ );  for ( i; 5 ) sout | hex( i4[i] ); sout | nl;
969int * i5 = alloc( 5, @i3`fill@ );  for ( i; 5 ) sout | i5[i]; sout | nl;
970int * i6 = alloc( 5, @[i3, 3]`fill@ );  for ( i; 5 ) sout | i6[i]; sout | nl;
971\end{cfa}
972\begin{lstlisting}[numbers=left]
9730
9745
9750xfefefefe
9765 5 5 5 5
9770xdeadbeef 0xdeadbeef 0xdeadbeef 0xdeadbeef 0xdeadbeef
9785 5 5 5 5
9795 5 5 -555819298 -555819298  // two undefined values
980\end{lstlisting}
981Examples 1 to 3, fill an object with a value or characters.
982Examples 4 to 7, fill an array of objects with values, another array, or part of an array.
983
984\subparagraph{\lstinline{S_resize(T) ?`resize( void * oaddr )}}
985used to resize, realign, and fill, where the old object data is not copied to the new object.
986The old object type may be different from the new object type, since the values are not used.
987For example:
988\begin{cfa}[numbers=left]
989int * i = alloc( @5`fill@ );  sout | i | *i;
990i = alloc( @i`resize@, @256`align@, @7`fill@ );  sout | i | *i;
991double * d = alloc( @i`resize@, @4096`align@, @13.5`fill@ );  sout | d | *d;
992\end{cfa}
993\begin{lstlisting}[numbers=left]
9940x55555556d5c0 5
9950x555555570000 7
9960x555555571000 13.5
997\end{lstlisting}
998Examples 2 to 3 change the alignment, fill, and size for the initial storage of @i@.
999
1000\begin{cfa}[numbers=left]
1001int * ia = alloc( 5, @5`fill@ );  for ( i; 5 ) sout | ia[i]; sout | nl;
1002ia = alloc( 10, @ia`resize@, @7`fill@ ); for ( i; 10 ) sout | ia[i]; sout | nl;
1003sout | ia; ia = alloc( 5, @ia`resize@, @512`align@, @13`fill@ ); sout | ia; for ( i; 5 ) sout | ia[i]; sout | nl;;
1004ia = alloc( 3, @ia`resize@, @4096`align@, @2`fill@ );  sout | ia; for ( i; 3 ) sout | &ia[i] | ia[i]; sout | nl;
1005\end{cfa}
1006\begin{lstlisting}[numbers=left]
10075 5 5 5 5
10087 7 7 7 7 7 7 7 7 7
10090x55555556d560 0x555555571a00 13 13 13 13 13
10100x555555572000 0x555555572000 2 0x555555572004 2 0x555555572008 2
1011\end{lstlisting}
1012Examples 2 to 4 change the array size, alignment and fill for the initial storage of @ia@.
1013
1014\subparagraph{\lstinline{S_realloc(T) ?`realloc( T * a ))}}
1015used to resize, realign, and fill, where the old object data is copied to the new object.
1016The old object type must be the same as the new object type, since the values used.
1017Note, for @fill@, only the extra space after copying the data from the old object is filled with the given parameter.
1018For example:
1019\begin{cfa}[numbers=left]
1020int * i = alloc( @5`fill@ );  sout | i | *i;
1021i = alloc( @i`realloc@, @256`align@ );  sout | i | *i;
1022i = alloc( @i`realloc@, @4096`align@, @13`fill@ );  sout | i | *i;
1023\end{cfa}
1024\begin{lstlisting}[numbers=left]
10250x55555556d5c0 5
10260x555555570000 5
10270x555555571000 5
1028\end{lstlisting}
1029Examples 2 to 3 change the alignment for the initial storage of @i@.
1030The @13`fill@ for example 3 does nothing because no extra space is added.
1031
1032\begin{cfa}[numbers=left]
1033int * ia = alloc( 5, @5`fill@ );  for ( i; 5 ) sout | ia[i]; sout | nl;
1034ia = alloc( 10, @ia`realloc@, @7`fill@ ); for ( i; 10 ) sout | ia[i]; sout | nl;
1035sout | ia; ia = alloc( 1, @ia`realloc@, @512`align@, @13`fill@ ); sout | ia; for ( i; 1 ) sout | ia[i]; sout | nl;;
1036ia = alloc( 3, @ia`realloc@, @4096`align@, @2`fill@ );  sout | ia; for ( i; 3 ) sout | &ia[i] | ia[i]; sout | nl;
1037\end{cfa}
1038\begin{lstlisting}[numbers=left]
10395 5 5 5 5
10405 5 5 5 5 7 7 7 7 7
10410x55555556c560 0x555555570a00 5
10420x555555571000 0x555555571000 5 0x555555571004 2 0x555555571008 2
1043\end{lstlisting}
1044Examples 2 to 4 change the array size, alignment and fill for the initial storage of @ia@.
1045The @13`fill@ for example 3 does nothing because no extra space is added.
1046
1047These \CFA allocation features are used extensively in the development of the \CFA runtime.
Note: See TracBrowser for help on using the repository browser.