source: doc/generic_types/generic_types.tex @ 3bdd6f5

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 3bdd6f5 was 3bdd6f5, checked in by Peter A. Buhr <pabuhr@…>, 4 years ago

more cleanup

  • Property mode set to 100644
File size: 80.6 KB
Line 
1% take off review (for line numbers) and anonymous (for anonymization) on submission
2\documentclass[format=acmlarge,anonymous,review]{acmart}
3% \documentclass[format=acmlarge,review]{acmart}
4
5\usepackage{xspace,calc,comment}
6\usepackage{upquote}                                                                    % switch curled `'" to straight
7\usepackage{listings}                                                                   % format program code
8\usepackage[usenames]{color}
9
10\makeatletter
11% Default underscore is too low and wide. Cannot use lstlisting "literate" as replacing underscore
12% removes it as a variable-name character so keyworks in variables are highlighted
13\DeclareTextCommandDefault{\textunderscore}{\leavevmode\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}
14
15% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
16% use rather than use \parident directly.
17\newlength{\parindentlnth}
18\setlength{\parindentlnth}{\parindent}
19
20\newlength{\gcolumnposn}                                % temporary hack because lstlisting does not handle tabs correctly
21\newlength{\columnposn}
22\setlength{\gcolumnposn}{2.75in}
23\setlength{\columnposn}{\gcolumnposn}
24\newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@commentstyle{#2}}}
25\newcommand{\CRT}{\global\columnposn=\gcolumnposn}
26
27% Latin abbreviation
28\newcommand{\abbrevFont}{\textit}       % set empty for no italics
29\newcommand*{\eg}{%
30        \@ifnextchar{,}{\abbrevFont{e}.\abbrevFont{g}.}%
31                {\@ifnextchar{:}{\abbrevFont{e}.\abbrevFont{g}.}%
32                        {\abbrevFont{e}.\abbrevFont{g}.,\xspace}}%
33}%
34\newcommand*{\ie}{%
35        \@ifnextchar{,}{\abbrevFont{i}.\abbrevFont{e}.}%
36                {\@ifnextchar{:}{\abbrevFont{i}.\abbrevFont{e}.}%
37                        {\abbrevFont{i}.\abbrevFont{e}.,\xspace}}%
38}%
39\newcommand*{\etc}{%
40        \@ifnextchar{.}{\abbrevFont{etc}}%
41        {\abbrevFont{etc}.\xspace}%
42}%
43\newcommand{\etal}{%
44        \@ifnextchar{.}{\abbrevFont{et~al}}%
45                {\abbrevFont{et al}.\xspace}%
46}%
47\makeatother
48
49% Useful macros
50\newcommand{\CFA}{C$\mathbf\forall$\xspace} % Cforall symbolic name
51\newcommand{\CC}{\rm C\kern-.1em\hbox{+\kern-.25em+}\xspace} % C++ symbolic name
52\newcommand{\CCeleven}{\rm C\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name
53\newcommand{\CCfourteen}{\rm C\kern-.1em\hbox{+\kern-.25em+}14\xspace} % C++14 symbolic name
54\newcommand{\CCseventeen}{\rm C\kern-.1em\hbox{+\kern-.25em+}17\xspace} % C++17 symbolic name
55\newcommand{\CCtwenty}{\rm C\kern-.1em\hbox{+\kern-.25em+}20\xspace} % C++20 symbolic name
56\newcommand{\CCV}{\rm C\kern-.1em\hbox{+\kern-.25em+}obj\xspace} % C++ virtual symbolic name
57\newcommand{\Csharp}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace} % C# symbolic name
58\newcommand{\Textbf}[1]{{\color{red}\textbf{#1}}}
59\newcommand{\TODO}[1]{\textbf{TODO}: {\itshape #1}} % TODO included
60%\newcommand{\TODO}[1]{} % TODO elided
61
62% CFA programming language, based on ANSI C (with some gcc additions)
63\lstdefinelanguage{CFA}[ANSI]{C}{
64        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
65                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
66                fallthrough,fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,one_t,otype,restrict,_Static_assert,
67                _Thread_local,throw,throwResume,trait,try,ttype,typeof,__typeof,__typeof__,zero_t},
68}%
69
70\lstset{
71language=CFA,
72columns=fullflexible,
73basicstyle=\linespread{0.9}\sf,                                                 % reduce line spacing and use sanserif font
74stringstyle=\tt,                                                                                % use typewriter font
75tabsize=4,                                                                                              % 4 space tabbing
76xleftmargin=\parindentlnth,                                                             % indent code to paragraph indentation
77%mathescape=true,                                                                               % LaTeX math escape in CFA code $...$
78escapechar=\$,                                                                                  % LaTeX escape in CFA code
79keepspaces=true,                                                                                %
80showstringspaces=false,                                                                 % do not show spaces with cup
81showlines=true,                                                                                 % show blank lines at end of code
82aboveskip=4pt,                                                                                  % spacing above/below code block
83belowskip=3pt,
84% replace/adjust listing characters that look bad in sanserif
85literate={-}{\makebox[1.4ex][c]{\raisebox{0.5ex}{\rule{1.2ex}{0.1ex}}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
86        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 % {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
87        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {->}{\makebox[1.4ex][c]{\raisebox{0.5ex}{\rule{1.2ex}{0.1ex}}}\kern-0.3ex\textgreater}2,
88moredelim=**[is][\color{red}]{`}{`},
89}% lstset
90
91% inline code @...@
92\lstMakeShortInline@%
93
94% ACM Information
95\citestyle{acmauthoryear}
96
97\acmJournal{PACMPL}
98
99\title{Generic and Tuple Types with Efficient Dynamic Layout in \CFA}
100
101\author{Aaron Moss}
102\email{a3moss@uwaterloo.ca}
103\author{Robert Schluntz}
104\email{rschlunt@uwaterloo.ca}
105\author{Peter Buhr}
106\email{pabuhr@uwaterloo.ca}
107\affiliation{%
108        \institution{University of Waterloo}
109        \department{David R. Cheriton School of Computer Science}
110        \streetaddress{Davis Centre, University of Waterloo}
111        \city{Waterloo}
112        \state{ON}
113        \postcode{N2L 3G1}
114        \country{Canada}
115}
116
117\terms{generic, tuple, variadic, types}
118\keywords{generic types, tuple types, variadic types, polymorphic functions, C, Cforall}
119
120\begin{CCSXML}
121<ccs2012>
122<concept>
123<concept_id>10011007.10011006.10011008.10011024.10011025</concept_id>
124<concept_desc>Software and its engineering~Polymorphism</concept_desc>
125<concept_significance>500</concept_significance>
126</concept>
127<concept>
128<concept_id>10011007.10011006.10011008.10011024.10011028</concept_id>
129<concept_desc>Software and its engineering~Data types and structures</concept_desc>
130<concept_significance>500</concept_significance>
131</concept>
132<concept>
133<concept_id>10011007.10011006.10011041.10011047</concept_id>
134<concept_desc>Software and its engineering~Source code generation</concept_desc>
135<concept_significance>300</concept_significance>
136</concept>
137</ccs2012>
138\end{CCSXML}
139
140\ccsdesc[500]{Software and its engineering~Polymorphism}
141\ccsdesc[500]{Software and its engineering~Data types and structures}
142\ccsdesc[300]{Software and its engineering~Source code generation}
143
144\begin{abstract}
145The C programming language is a foundational technology for modern computing with millions of lines of code implementing everything from commercial operating-systems to hobby projects.
146This installation base and the programmers producing it represent a massive software-engineering investment spanning decades and likely to continue for decades more.
147Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive.
148The goal of the \CFA project is to create an extension of C that provides modern safety and productivity features while still ensuring strong backwards compatibility with C and its programmers.
149Prior projects have attempted similar goals but failed to honour C programming-style; for instance, adding object-oriented or functional programming with garbage collection is a non-starter for many C developers.
150Specifically, \CFA is designed to have an orthogonal feature-set based closely on the C programming paradigm, so that \CFA features can be added \emph{incrementally} to existing C code-bases, and C programmers can learn \CFA extensions on an as-needed basis, preserving investment in existing code and engineers.
151This paper describes two \CFA extensions, generic and tuple types, details how their design avoids shortcomings of similar features in C and other C-like languages, and presents experimental results validating the design.
152\end{abstract}
153
154\begin{document}
155\maketitle
156
157
158\section{Introduction and Background}
159
160The C programming language is a foundational technology for modern computing with millions of lines of code implementing everything from commercial operating-systems to hobby projects.
161This installation base and the programmers producing it represent a massive software-engineering investment spanning decades and likely to continue for decades more.
162The \citet{TIOBE} ranks the top 5 most popular programming languages as: Java 16\%, \Textbf{C 7\%}, \Textbf{\CC 5\%}, \Csharp 4\%, Python 4\% = 36\%, where the next 50 languages are less than 3\% each with a long tail.
163The top 3 rankings over the past 30 years are:
164\lstDeleteShortInline@%
165\begin{center}
166\setlength{\tabcolsep}{10pt}
167\begin{tabular}{@{}rccccccc@{}}
168                & 2017  & 2012  & 2007  & 2002  & 1997  & 1992  & 1987          \\ \hline
169Java    & 1             & 1             & 1             & 1             & 12    & -             & -                     \\
170\Textbf{C}      & \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{1}& \Textbf{1}& \Textbf{1}    \\
171\CC             & 3             & 3             & 3             & 3             & 2             & 2             & 4                     \\
172\end{tabular}
173\end{center}
174\lstMakeShortInline@%
175Love it or hate it, C is extremely popular, highly used, and one of the few systems languages.
176In many cases, \CC is often used solely as a better C.
177Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive.
178
179\CFA (pronounced ``C-for-all'', and written \CFA or Cforall) is an evolutionary extension of the C programming language that aims to add modern language features to C while maintaining both source compatibility with C and a familiar programming model for programmers.
180The four key design goals for \CFA~\citep{Bilson03} are:
181(1) The behaviour of standard C code must remain the same when translated by a \CFA compiler as when translated by a C compiler;
182(2) Standard C code must be as fast and as small when translated by a \CFA compiler as when translated by a C compiler;
183(3) \CFA code must be at least as portable as standard C code;
184(4) Extensions introduced by \CFA must be translated in the most efficient way possible.
185These goals ensure existing C code-bases can be converted to \CFA incrementally with minimal effort, and C programmers can productively generate \CFA code without training beyond the features being used.
186\CC is used similarly, but has the disadvantages of multiple legacy design-choices that cannot be updated and active divergence of the language model from C, requiring significant effort and training to incrementally add \CC to a C-based project.
187
188\CFA is currently implemented as a source-to-source translator from \CFA to the GCC-dialect of C~\citep{GCCExtensions}, allowing it to leverage the portability and code optimizations provided by GCC, meeting goals (1)--(3).
189Ultimately, a compiler is necessary for advanced features and optimal performance.
190
191This paper identifies shortcomings in existing approaches to generic and variadic data types in C-like languages and presents a design for generic and variadic types avoiding those shortcomings.
192Specifically, the solution is both reusable and type-checked, as well as conforming to the design goals of \CFA with ergonomic use of existing C abstractions.
193The new constructs are empirically compared with both standard C and \CC; the results show the new design is comparable in performance.
194
195
196\subsection{Polymorphic Functions}
197\label{sec:poly-fns}
198
199\CFA's polymorphism was originally formalized by \citet{Ditchfield92}, and first implemented by \citet{Bilson03}.
200The signature feature of \CFA is parametric-polymorphic functions~\citep{forceone:impl,Cormack90,Duggan96} with functions generalized using a @forall@ clause (giving the language its name):
201\begin{lstlisting}
202`forall( otype T )` T identity( T val ) { return val; }
203int forty_two = identity( 42 );                         $\C{// T is bound to int, forty\_two == 42}$
204\end{lstlisting}
205The @identity@ function above can be applied to any complete \emph{object type} (or @otype@).
206The type variable @T@ is transformed into a set of additional implicit parameters encoding sufficient information about @T@ to create and return a variable of that type.
207The \CFA implementation passes the size and alignment of the type represented by an @otype@ parameter, as well as an assignment operator, constructor, copy constructor and destructor.
208If this extra information is not needed, \eg for a pointer, the type parameter can be declared as a \emph{data type} (or @dtype@).
209
210In \CFA, the polymorphism runtime-cost is spread over each polymorphic call, due to passing more arguments to polymorphic functions;
211the experiments in Section~\ref{sec:eval} show this overhead is similar to \CC virtual-function calls.
212A design advantage is that, unlike \CC template-functions, \CFA polymorphic-functions are compatible with C \emph{separate compilation}, preventing compilation and code bloat.
213
214Since bare polymorphic-types provide a restricted set of available operations, \CFA provides a \emph{type assertion}~\cite[pp.~37-44]{Alphard} mechanism to provide further type information, where type assertions may be variable or function declarations that depend on a polymorphic type-variable.
215For example, the function @twice@ can be defined using the \CFA syntax for operator overloading:
216\begin{lstlisting}
217forall( otype T `| { T ?+?(T, T); }` ) T twice( T x ) { return x + x; } $\C{// ? denotes operands}$
218int val = twice( twice( 3.7 ) );
219\end{lstlisting}
220which works for any type @T@ with a matching addition operator.
221The polymorphism is achieved by creating a wrapper function for calling @+@ with @T@ bound to @double@, then passing this function to the first call of @twice@.
222There is now the option of using the same @twice@ and converting the result to @int@ on assignment, or creating another @twice@ with type parameter @T@ bound to @int@ because \CFA uses the return type~\cite{Cormack81,Baker82,Ada}, in its type analysis.
223The first approach has a late conversion from @double@ to @int@ on the final assignment, while the second has an eager conversion to @int@.
224\CFA minimizes the number of conversions and their potential to lose information, so it selects the first approach, which corresponds with C-programmer intuition.
225
226Crucial to the design of a new programming language are the libraries to access thousands of external software features.
227Like \CC, \CFA inherits a massive compatible library-base, where other programming languages must rewrite or provide fragile inter-language communication with C.
228A simple example is leveraging the existing type-unsafe (@void *@) C @bsearch@ to binary search a sorted floating-point array:
229\begin{lstlisting}
230void * bsearch( const void * key, const void * base, size_t nmemb, size_t size,
231                                int (* compar)( const void *, const void * ));
232int comp( const void * t1, const void * t2 ) { return *(double *)t1 < *(double *)t2 ? -1 :
233                                *(double *)t2 < *(double *)t1 ? 1 : 0; }
234double key = 5.0, vals[10] = { /* 10 floating-point values */ };
235double * val = (double *)bsearch( &key, vals, 10, sizeof(vals[0]), comp );      $\C{// search sorted array}$
236\end{lstlisting}
237which can be augmented simply with a generalized, type-safe, \CFA-overloaded wrappers:
238\begin{lstlisting}
239forall( otype T | { int ?<?( T, T ); } ) T * bsearch( T key, const T * arr, size_t size ) {
240        int comp( const void * t1, const void * t2 ) { /* as above with double changed to T */ }
241        return (T *)bsearch( &key, arr, size, sizeof(T), comp ); }
242forall( otype T | { int ?<?( T, T ); } ) unsigned int bsearch( T key, const T * arr, size_t size ) {
243        T * result = bsearch( key, arr, size ); $\C{// call first version}$
244        return result ? result - arr : size; }  $\C{// pointer subtraction includes sizeof(T)}$
245double * val = bsearch( 5.0, vals, 10 );        $\C{// selection based on return type}$
246int posn = bsearch( 5.0, vals, 10 );
247\end{lstlisting}
248The nested function @comp@ provides the hidden interface from typed \CFA to untyped (@void *@) C, plus the cast of the result.
249Providing a hidden @comp@ function in \CC is awkward as lambdas do not use C calling-conventions and template declarations cannot appear at block scope.
250As well, an alternate kind of return is made available: position versus pointer to found element.
251\CC's type-system cannot disambiguate between the two versions of @bsearch@ because it does not use the return type in overload resolution, nor can \CC separately compile a templated @bsearch@.
252
253\CFA has replacement libraries condensing hundreds of existing C functions into tens of \CFA overloaded functions, all without rewriting the actual computations.
254For example, it is possible to write a type-safe \CFA wrapper @malloc@ based on the C @malloc@:
255\begin{lstlisting}
256forall( dtype T | sized(T) ) T * malloc( void ) { return (T *)malloc( sizeof(T) ); }
257int * ip = malloc();                                            $\C{// select type and size from left-hand side}$
258double * dp = malloc();
259struct S {...} * sp = malloc();
260\end{lstlisting}
261where the return type supplies the type/size of the allocation, which is impossible in most type systems.
262
263Call-site inferencing and nested functions provide a localized form of inheritance.
264For example, the \CFA @qsort@ only sorts in ascending order using @<@.
265However, it is trivial to locally change this behaviour:
266\begin{lstlisting}
267forall( otype T | { int ?<?( T, T ); } ) void qsort( const T * arr, size_t size ) { /* use C qsort */ }
268{       int ?<?( double x, double y ) { return x `>` y; }       $\C{// locally override behaviour}$
269        qsort( vals, size );                                    $\C{// descending sort}$
270}
271\end{lstlisting}
272Within the block, the nested version of @<@ performs @>@ and this local version overrides the built-in @<@ so it is passed to @qsort@.
273Hence, programmers can easily form local environments, adding and modifying appropriate functions, to maximize reuse of other existing functions and types.
274
275Finally, \CFA allows variable overloading:
276\begin{lstlisting}
277short int MAX = ...;   int MAX = ...;  double MAX = ...;
278short int s = MAX;    int i = MAX;    double d = MAX;   $\C{// select correct MAX}$
279\end{lstlisting}
280Here, the single name @MAX@ replaces all the C type-specific names: @SHRT_MAX@, @INT_MAX@, @DBL_MAX@.
281As well, restricted constant overloading is allowed for the values @0@ and @1@, which have special status in C, \eg the value @0@ is both an integer and a pointer literal, so its meaning depends on context.
282In addition, several operations are defined in terms values @0@ and @1@, \eg:
283\begin{lstlisting}
284int x;
285if (x) x++                                                                      $\C{// if (x != 0) x += 1;}$
286\end{lstlisting}
287Every if and iteration statement in C compares the condition with @0@, and every increment and decrement operator is semantically equivalent to adding or subtracting the value @1@ and storing the result.
288Due to these rewrite rules, the values @0@ and @1@ have the types @zero_t@ and @one_t@ in \CFA, which allows overloading various operations for new types that seamlessly connect to all special @0@ and @1@ contexts.
289The types @zero_t@ and @one_t@ have special built in implicit conversions to the various integral types, and a conversion to pointer types for @0@, which allows standard C code involving @0@ and @1@ to work as normal.
290
291
292\subsection{Traits}
293
294\CFA provides \emph{traits} to name a group of type assertions, where the trait name allows specifying the same set of assertions in multiple locations, preventing repetition mistakes at each function declaration:
295\begin{lstlisting}
296trait summable( otype T ) {
297        void ?{}( T *, zero_t );                                $\C{// constructor from 0 literal}$
298        T ?+?( T, T );                                                  $\C{// assortment of additions}$
299        T ?+=?( T *, T );
300        T ++?( T * );
301        T ?++( T * ); };
302forall( otype T `| summable( T )` ) T sum( T a[$\,$], size_t size ) {  // use trait
303        `T` total = { `0` };                                    $\C{// instantiate T from 0 by calling its constructor}$
304        for ( unsigned int i = 0; i < size; i += 1 ) total `+=` a[i]; $\C{// select appropriate +}$
305        return total; }
306\end{lstlisting}
307
308In fact, the set of @summable@ trait operators is incomplete, as it is missing assignment for type @T@, but @otype@ is syntactic sugar for the following implicit trait:
309\begin{lstlisting}
310trait otype( dtype T | sized(T) ) {  // sized is a pseudo-trait for types with known size and alignment
311        void ?{}( T * );                                                $\C{// default constructor}$
312        void ?{}( T *, T );                                             $\C{// copy constructor}$
313        void ?=?( T *, T );                                             $\C{// assignment operator}$
314        void ^?{}( T * ); };                                    $\C{// destructor}$
315\end{lstlisting}
316Given the information provided for an @otype@, variables of polymorphic type can be treated as if they were a complete type: stack-allocatable, default or copy-initialized, assigned, and deleted.
317
318In summation, the \CFA type-system uses \emph{nominal typing} for concrete types, matching with the C type-system, and \emph{structural typing} for polymorphic types.
319Hence, trait names play no part in type equivalence;
320the names are simply macros for a list of polymorphic assertions, which are expanded at usage sites.
321Nevertheless, trait names form a logical subtype-hierarchy with @dtype@ at the top, where traits often contain overlapping assertions, \eg operator @+@.
322Traits are used like interfaces in Java or abstract base-classes in \CC, but without the nominal inheritance-relationships.
323Instead, each polymorphic function (or generic type) defines the structural type needed for its execution (polymorphic type-key), and this key is fulfilled at each call site from the lexical environment, which is similar to Go~\citep{Go} interfaces.
324Hence, new lexical scopes and nested functions are used extensively to create local subtypes, as in the @qsort@ example, without having to manage a nominal-inheritance hierarchy.
325(Nominal inheritance can be approximated with traits using marker variables or functions, as is done in Go.)
326
327% Nominal inheritance can be simulated with traits using marker variables or functions:
328% \begin{lstlisting}
329% trait nominal(otype T) {
330%     T is_nominal;
331% };
332% int is_nominal;                                                               $\C{// int now satisfies the nominal trait}$
333% \end{lstlisting}
334%
335% Traits, however, are significantly more powerful than nominal-inheritance interfaces; most notably, traits may be used to declare a relationship \emph{among} multiple types, a property that may be difficult or impossible to represent in nominal-inheritance type systems:
336% \begin{lstlisting}
337% trait pointer_like(otype Ptr, otype El) {
338%     lvalue El *?(Ptr);                                                $\C{// Ptr can be dereferenced into a modifiable value of type El}$
339% }
340% struct list {
341%     int value;
342%     list * next;                                                              $\C{// may omit "struct" on type names as in \CC}$
343% };
344% typedef list * list_iterator;
345%
346% lvalue int *?( list_iterator it ) { return it->value; }
347% \end{lstlisting}
348% In the example above, @(list_iterator, int)@ satisfies @pointer_like@ by the user-defined dereference function, and @(list_iterator, list)@ also satisfies @pointer_like@ by the built-in dereference operator for pointers. Given a declaration @list_iterator it@, @*it@ can be either an @int@ or a @list@, with the meaning disambiguated by context (\eg @int x = *it;@ interprets @*it@ as an @int@, while @(*it).value = 42;@ interprets @*it@ as a @list@).
349% While a nominal-inheritance system with associated types could model one of those two relationships by making @El@ an associated type of @Ptr@ in the @pointer_like@ implementation, few such systems could model both relationships simultaneously.
350
351
352\section{Generic Types}
353
354One of the known shortcomings of standard C is that it does not provide reusable type-safe abstractions for generic data structures and algorithms.
355Broadly speaking, there are three approaches to implement abstract data-structures in C.
356One approach is to write bespoke data structures for each context in which they are needed.
357While this approach is flexible and supports integration with the C type-checker and tooling, it is also tedious and error-prone, especially for more complex data structures.
358A second approach is to use @void *@--based polymorphism, \eg the C standard-library functions @bsearch@ and @qsort@; an approach which does allow reuse of code for common functionality.
359However, basing all polymorphism on @void *@ eliminates the type-checker's ability to ensure that argument types are properly matched, often requiring a number of extra function parameters, pointer indirection, and dynamic allocation that would not otherwise be needed.
360A third approach to generic code is to use preprocessor macros, which does allow the generated code to be both generic and type-checked, but errors may be difficult to interpret.
361Furthermore, writing and using preprocessor macros can be unnatural and inflexible.
362
363\CC, Java, and other languages use \emph{generic types} to produce type-safe abstract data-types.
364\CFA also implements generic types that integrate efficiently and naturally with the existing polymorphic functions, while retaining backwards compatibility with C and providing separate compilation.
365However, for known concrete parameters, the generic-type definition can be inlined, like \CC templates.
366
367A generic type can be declared by placing a @forall@ specifier on a @struct@ or @union@ declaration, and instantiated using a parenthesized list of types after the type name:
368\begin{lstlisting}
369forall( otype R, otype S ) struct pair {
370        R first;
371        S second;
372};
373forall( otype T ) T value( pair( const char *, T ) p ) { return p.second; }
374forall( dtype F, otype T ) T value_p( pair( F *, T * ) p ) { return * p.second; }
375pair( const char *, int ) p = { "magic", 42 };
376int magic = value( p );
377pair( void *, int * ) q = { 0, &p.second };
378magic = value_p( q );
379double d = 1.0;
380pair( double *, double * ) r = { &d, &d };
381d = value_p( r );
382\end{lstlisting}
383
384\CFA classifies generic types as either \emph{concrete} or \emph{dynamic}.
385Concrete types have a fixed memory layout regardless of type parameters, while dynamic types vary in memory layout depending on their type parameters.
386A type may have polymorphic parameters but still be concrete, called \emph{dtype-static}.
387Polymorphic pointers are an example of dtype-static types, \eg @forall(dtype T) T *@ is a polymorphic type, but for any @T@, @T *@  is a fixed-sized pointer, and therefore, can be represented by a @void *@ in code generation.
388
389\CFA generic types also allow checked argument-constraints.
390For example, the following declaration of a sorted set-type ensures the set key supports equality and relational comparison:
391\begin{lstlisting}
392forall( otype Key | { _Bool ?==?(Key, Key); _Bool ?<?(Key, Key); } ) struct sorted_set;
393\end{lstlisting}
394
395
396\subsection{Concrete Generic-Types}
397
398The \CFA translator template-expands concrete generic-types into new structure types, affording maximal inlining.
399To enable inter-operation among equivalent instantiations of a generic type, the translator saves the set of instantiations currently in scope and reuses the generated structure declarations where appropriate.
400For example, a function declaration that accepts or returns a concrete generic-type produces a declaration for the instantiated struct in the same scope, which all callers may reuse.
401For example, the concrete instantiation for @pair( const char *, int )@ is:
402\begin{lstlisting}
403struct _pair_conc1 {
404        const char * first;
405        int second;
406};
407\end{lstlisting}
408
409A concrete generic-type with dtype-static parameters is also expanded to a structure type, but this type is used for all matching instantiations.
410In the above example, the @pair( F *, T * )@ parameter to @value_p@ is such a type; its expansion is below and it is used as the type of the variables @q@ and @r@ as well, with casts for member access where appropriate:
411\begin{lstlisting}
412struct _pair_conc0 {
413        void * first;
414        void * second;
415};
416\end{lstlisting}
417
418
419\subsection{Dynamic Generic-Types}
420
421Though \CFA implements concrete generic-types efficiently, it also has a fully general system for dynamic generic types.
422As mentioned in Section~\ref{sec:poly-fns}, @otype@ function parameters (in fact all @sized@ polymorphic parameters) come with implicit size and alignment parameters provided by the caller.
423Dynamic generic-types also have an \emph{offset array} containing structure-member offsets.
424A dynamic generic-union needs no such offset array, as all members are at offset 0, but size and alignment are still necessary.
425Access to members of a dynamic structure is provided at runtime via base-displacement addressing with the structure pointer and the member offset (similar to the @offsetof@ macro), moving a compile-time offset calculation to runtime.
426
427The offset arrays are statically generated where possible.
428If a dynamic generic-type is declared to be passed or returned by value from a polymorphic function, the translator can safely assume the generic type is complete (\ie has a known layout) at any call-site, and the offset array is passed from the caller;
429if the generic type is concrete at the call site, the elements of this offset array can even be statically generated using the C @offsetof@ macro.
430As an example, @p.second@ in the @value@ function above is implemented as @*(p + _offsetof_pair[1])@, where @p@ is a @void *@, and @_offsetof_pair@ is the offset array passed into @value@ for @pair( const char *, T )@.
431The offset array @_offsetof_pair@ is generated at the call site as @size_t _offsetof_pair[] = { offsetof(_pair_conc1, first), offsetof(_pair_conc1, second) }@.
432
433In some cases the offset arrays cannot be statically generated.
434For instance, modularity is generally provided in C by including an opaque forward-declaration of a structure and associated accessor and mutator functions in a header file, with the actual implementations in a separately-compiled @.c@ file.
435\CFA supports this pattern for generic types, but the caller does not know the actual layout or size of the dynamic generic-type, and only holds it by a pointer.
436The \CFA translator automatically generates \emph{layout functions} for cases where the size, alignment, and offset array of a generic struct cannot be passed into a function from that function's caller.
437These layout functions take as arguments pointers to size and alignment variables and a caller-allocated array of member offsets, as well as the size and alignment of all @sized@ parameters to the generic structure (un@sized@ parameters are forbidden from being used in a context that affects layout).
438Results of these layout functions are cached so that they are only computed once per type per function. %, as in the example below for @pair@.
439Layout functions also allow generic types to be used in a function definition without reflecting them in the function signature.
440For instance, a function that strips duplicate values from an unsorted @vector(T)@ would likely have a pointer to the vector as its only explicit parameter, but use some sort of @set(T)@ internally to test for duplicate values.
441This function could acquire the layout for @set(T)@ by calling its layout function with the layout of @T@ implicitly passed into the function.
442
443Whether a type is concrete, dtype-static, or dynamic is decided solely on the type parameters and @forall@ clause on a declaration.
444This design allows opaque forward declarations of generic types, \eg @forall(otype T) struct Box@ -- like in C, all uses of @Box(T)@ can be separately compiled, and callers from other translation units know the proper calling conventions to use.
445If the definition of a structure type is included in deciding whether a generic type is dynamic or concrete, some further types may be recognized as dtype-static (\eg @forall(otype T) struct unique_ptr { T * p }@ does not depend on @T@ for its layout, but the existence of an @otype@ parameter means that it \emph{could}.), but preserving separate compilation (and the associated C compatibility) in the existing design is judged to be an appropriate trade-off.
446
447
448\subsection{Applications}
449\label{sec:generic-apps}
450
451The reuse of dtype-static structure instantiations enables useful programming patterns at zero runtime cost.
452The most important such pattern is using @forall(dtype T) T *@ as a type-checked replacement for @void *@, \eg creating a lexicographic comparison for pairs of pointers used by @bsearch@ or @qsort@:
453\begin{lstlisting}
454forall(dtype T) int lexcmp( pair( T *, T * ) * a, pair( T *, T * ) * b, int (* cmp)( T *, T * ) ) {
455        return cmp( a->first, b->first ) ? : cmp( a->second, b->second );
456}
457\end{lstlisting}
458Since @pair(T *, T * )@ is a concrete type, there are no implicit parameters passed to @lexcmp@, so the generated code is identical to a function written in standard C using @void *@, yet the \CFA version is type-checked to ensure the fields of both pairs and the arguments to the comparison function match in type.
459
460Another useful pattern enabled by reused dtype-static type instantiations is zero-cost \emph{tag-structures}.
461Sometimes information is only used for type-checking and can be omitted at runtime, \eg:
462\begin{lstlisting}
463forall(dtype Unit) struct scalar { unsigned long value; };
464struct metres {};
465struct litres {};
466
467forall(dtype U) scalar(U) ?+?( scalar(U) a, scalar(U) b ) {
468        return (scalar(U)){ a.value + b.value };
469}
470scalar(metres) half_marathon = { 21093 };
471scalar(litres) swimming_pool = { 2500000 };
472scalar(metres) marathon = half_marathon + half_marathon;
473scalar(litres) two_pools = swimming_pool + swimming_pool;
474marathon + swimming_pool;                                       $\C{// compilation ERROR}$
475\end{lstlisting}
476@scalar@ is a dtype-static type, so all uses have a single structure definition, containing @unsigned long@, and can share the same implementations of common functions like @?+?@.
477These implementations may even be separately compiled, unlike \CC template functions.
478However, the \CFA type-checker ensures matching types are used by all calls to @?+?@, preventing nonsensical computations like adding a length to a volume.
479
480
481\section{Tuples}
482\label{sec:tuples}
483
484In many languages, functions can return at most one value;
485however, many operations have multiple outcomes, some exceptional.
486Consider C's @div@ and @remquo@ functions, which return the quotient and remainder for a division of integer and floating-point values, respectively.
487\begin{lstlisting}
488typedef struct { int quo, rem; } div_t;         $\C{// from include stdlib.h}$
489div_t div( int num, int den );
490double remquo( double num, double den, int * quo );
491div_t qr = div( 13, 5 );                                        $\C{// return quotient/remainder aggregate}$
492int q;
493double r = remquo( 13.5, 5.2, &q );                     $\C{// return remainder, alias quotient}$
494\end{lstlisting}
495@div@ aggregates the quotient/remainder in a structure, while @remquo@ aliases a parameter to an argument.
496Both approaches are awkward.
497Alternatively, a programming language can directly support returning multiple values, \eg in \CFA:
498\begin{lstlisting}
499[ int, int ] div( int num, int den );           $\C{// return two integers}$
500[ double, double ] div( double num, double den ); $\C{// return two doubles}$
501int q, r;                                                                       $\C{// overloaded variable names}$
502double q, r;
503[ q, r ] = div( 13, 5 );                                        $\C{// select appropriate div and q, r}$
504[ q, r ] = div( 13.5, 5.2 );                            $\C{// assign into tuple}$
505\end{lstlisting}
506Clearly, this approach is straightforward to understand and use;
507therefore, why do few programming languages support this obvious feature or provide it awkwardly?
508The answer is that there are complex consequences that cascade through multiple aspects of the language, especially the type-system.
509This section show these consequences and how \CFA handles them.
510
511
512\subsection{Tuple Expressions}
513
514The addition of multiple-return-value functions (MRVF) are useless without a syntax for accepting multiple values at the call-site.
515The simplest mechanism for capturing the return values is variable assignment, allowing the values to be retrieved directly.
516As such, \CFA allows assigning multiple values from a function into multiple variables, using a square-bracketed list of lvalue expressions (as above), called a \emph{tuple}.
517
518However, functions also use \emph{composition} (nested calls), with the direct consequence that MRVFs must also support composition to be orthogonal with single-returning-value functions (SRVF), \eg:
519\begin{lstlisting}
520printf( "%d %d\n", div( 13, 5 ) );                      $\C{// return values seperated into arguments}$
521\end{lstlisting}
522Here, the values returned by @div@ are composed with the call to @printf@ by flattening the tuple into separate arguments.
523However, the \CFA type-system must support significantly more complex composition:
524\begin{lstlisting}
525[ int, int ] foo$\(_1\)$( int );
526[ double ] foo$\(_2\)$( int );
527void bar( int, double, double );
528bar( foo( 3 ), foo( 3 ) );
529\end{lstlisting}
530The type-resolver only has the tuple return-types to resolve the call to @bar@ as the @foo@ parameters are identical, which involves unifying the possible @foo@ functions with @bar@'s parameter list.
531No combination of @foo@s are an exact match with @bar@'s parameters, so the resolver applies C conversions.
532The minimal cost is @bar( foo@$_1$@( 3 ), foo@$_2$@( 3 ) )@, giving (@int@, {\color{ForestGreen}@int@}, @double@) to (@int@, {\color{ForestGreen}@double@}, @double@) with one {\color{ForestGreen}safe} (widening) conversion from @int@ to @double@ versus ({\color{red}@double@}, {\color{ForestGreen}@int@}, {\color{ForestGreen}@int@}) to ({\color{red}@int@}, {\color{ForestGreen}@double@}, {\color{ForestGreen}@double@}) with one {\color{red}unsafe} (narrowing) conversion from @double@ to @int@ and two safe conversions.
533
534
535\subsection{Tuple Variables}
536
537An important observation from function composition is that new variable names are not required to initialize parameters from an MRVF.
538\CFA also allows declaration of tuple variables that can be initialized from an MRVF, since it can be awkward to declare multiple variables of different types, \eg:
539\begin{lstlisting}
540[ int, int ] qr = div( 13, 5 );                         $\C{// tuple-variable declaration and initialization}$
541[ double, double ] qr = div( 13.5, 5.2 );
542\end{lstlisting}
543where the tuple variable-name serves the same purpose as the parameter name(s).
544Tuple variables can be composed of any types, except for array types, since array sizes are generally unknown.
545
546One way to access the tuple-variable components is with assignment or composition:
547\begin{lstlisting}
548[ q, r ] = qr;                                                          $\C{// access tuple-variable components}$
549printf( "%d %d\n", qr );
550\end{lstlisting}
551\CFA also supports \emph{tuple indexing} to access single components of a tuple expression:
552\begin{lstlisting}
553[int, int] * p = &qr;                                           $\C{// tuple pointer}$
554int rem = qr.1;                                                         $\C{// access remainder}$
555int quo = div( 13, 5 ).0;                                       $\C{// access quotient}$
556p->0 = 5;                                                                       $\C{// change quotient}$
557bar( qr.1, qr );                                                        $\C{// pass remainder and quotient/remainder}$
558rem = [42, div( 13, 5 )].0.1;                           $\C{// access 2nd component of 1st component of tuple expression}$
559\end{lstlisting}
560
561
562\subsection{Flattening and Restructuring}
563
564In function call contexts, tuples support implicit flattening and restructuring conversions.
565Tuple flattening recursively expands a tuple into the list of its basic components.
566Tuple structuring packages a list of expressions into a value of tuple type, \eg:
567%\lstDeleteShortInline@%
568%\par\smallskip
569%\begin{tabular}{@{}l@{\hspace{1.5\parindent}}||@{\hspace{1.5\parindent}}l@{}}
570\begin{lstlisting}
571int f( int, int );
572int g( [int, int] );
573int h( int, [int, int] );
574[int, int] x;
575int y;
576f( x );                 $\C{// flatten}$
577g( y, 10 );             $\C{// structure}$
578h( x, y );              $\C{// flatten and structure}$
579\end{lstlisting}
580%\end{lstlisting}
581%&
582%\begin{lstlisting}
583%\end{tabular}
584%\smallskip\par\noindent
585%\lstMakeShortInline@%
586In the call to @f@, @x@ is implicitly flattened so the components of @x@ are passed as the two arguments.
587In the call to @g@, the values @y@ and @10@ are structured into a single argument of type @[int, int]@ to match the parameter type of @g@.
588Finally, in the call to @h@, @x@ is flattened to yield an argument list of length 3, of which the first component of @x@ is passed as the first parameter of @h@, and the second component of @x@ and @y@ are structured into the second argument of type @[int, int]@.
589The flexible structure of tuples permits a simple and expressive function call syntax to work seamlessly with both SRVF and MRVF, and with any number of arguments of arbitrarily complex structure.
590
591
592\subsection{Tuple Assignment}
593
594An assignment where the left side is a tuple type is called \emph{tuple assignment}.
595There are two kinds of tuple assignment depending on whether the right side of the assignment operator has a tuple type or a non-tuple type, called \emph{multiple} and \emph{mass assignment}, respectively.
596%\lstDeleteShortInline@%
597%\par\smallskip
598%\begin{tabular}{@{}l@{\hspace{1.5\parindent}}||@{\hspace{1.5\parindent}}l@{}}
599\begin{lstlisting}
600int x = 10;
601double y = 3.5;
602[int, double] z;
603z = [x, y];                                                                     $\C{// multiple assignment}$
604[x, y] = z;                                                                     $\C{// multiple assignment}$
605z = 10;                                                                         $\C{// mass assignment}$
606[y, x] = 3.14;                                                          $\C{// mass assignment}$
607\end{lstlisting}
608%\end{lstlisting}
609%&
610%\begin{lstlisting}
611%\end{tabular}
612%\smallskip\par\noindent
613%\lstMakeShortInline@%
614Both kinds of tuple assignment have parallel semantics, so that each value on the left and right side is evaluated before any assignments occur.
615As a result, it is possible to swap the values in two variables without explicitly creating any temporary variables or calling a function, \eg, @[x, y] = [y, x]@.
616This semantics means mass assignment differs from C cascading assignment (\eg @a = b = c@) in that conversions are applied in each individual assignment, which prevents data loss from the chain of conversions that can happen during a cascading assignment.
617For example, @[y, x] = 3.14@ performs the assignments @y = 3.14@ and @x = 3.14@, yielding @y == 3.14@ and @x == 3@;
618whereas C cascading assignment @y = x = 3.14@ performs the assignments @x = 3.14@ and @y = x@, yielding @3@ in @y@ and @x@.
619Finally, tuple assignment is an expression where the result type is the type of the left-hand side of the assignment, just like all other assignment expressions in C.
620This example shows mass, multiple, and cascading assignment used in one expression:
621\begin{lstlisting}
622void f( [int, int] );
623f( [x, y] = z = 1.5 );                                          $\C{// assignments in parameter list}$
624\end{lstlisting}
625
626
627\subsection{Member Access}
628
629It is also possible to access multiple fields from a single expression using a \emph{member-access}.
630The result is a single tuple-valued expression whose type is the tuple of the types of the members, \eg:
631\begin{lstlisting}
632struct S { int x; double y; char * z; } s;
633s.[x, y, z] = 0;
634\end{lstlisting}
635Here, the mass assignment sets all members of @s@ to zero.
636Since tuple-index expressions are a form of member-access expression, it is possible to use tuple-index expressions in conjunction with member tuple expressions to manually restructure a tuple (\eg rearrange, drop, and duplicate components).
637%\lstDeleteShortInline@%
638%\par\smallskip
639%\begin{tabular}{@{}l@{\hspace{1.5\parindent}}||@{\hspace{1.5\parindent}}l@{}}
640\begin{lstlisting}
641[int, int, long, double] x;
642void f( double, long );
643x.[0, 1] = x.[1, 0];                                            $\C{// rearrange: [x.0, x.1] = [x.1, x.0]}$
644f( x.[0, 3] );                                                          $\C{// drop: f(x.0, x.3)}$
645[int, int, int] y = x.[2, 0, 2];                        $\C{// duplicate: [y.0, y.1, y.2] = [x.2, x.0.x.2]}$
646\end{lstlisting}
647%\end{lstlisting}
648%&
649%\begin{lstlisting}
650%\end{tabular}
651%\smallskip\par\noindent
652%\lstMakeShortInline@%
653It is also possible for a member access to contain other member accesses, \eg:
654\begin{lstlisting}
655struct A { double i; int j; };
656struct B { int * k; short l; };
657struct C { int x; A y; B z; } v;
658v.[x, y.[i, j], z.k];                                           $\C{// [v.x, [v.y.i, v.y.j], v.z.k]}$
659\end{lstlisting}
660
661
662\begin{comment}
663\subsection{Casting}
664
665In C, the cast operator is used to explicitly convert between types.
666In \CFA, the cast operator has a secondary use as type ascription.
667That is, a cast can be used to select the type of an expression when it is ambiguous, as in the call to an overloaded function:
668\begin{lstlisting}
669int f();     // (1)
670double f()// (2)
671
672f();       // ambiguous - (1),(2) both equally viable
673(int)f()// choose (2)
674\end{lstlisting}
675
676Since casting is a fundamental operation in \CFA, casts should be given a meaningful interpretation in the context of tuples.
677Taking a look at standard C provides some guidance with respect to the way casts should work with tuples:
678\begin{lstlisting}
679int f();
680void g();
681
682(void)f()// (1)
683(int)g()// (2)
684\end{lstlisting}
685In C, (1) is a valid cast, which calls @f@ and discards its result.
686On the other hand, (2) is invalid, because @g@ does not produce a result, so requesting an @int@ to materialize from nothing is nonsensical.
687Generalizing these principles, any cast wherein the number of components increases as a result of the cast is invalid, while casts that have the same or fewer number of components may be valid.
688
689Formally, a cast to tuple type is valid when $T_n \leq S_m$, where $T_n$ is the number of components in the target type and $S_m$ is the number of components in the source type, and for each $i$ in $[0, n)$, $S_i$ can be cast to $T_i$.
690Excess elements ($S_j$ for all $j$ in $[n, m)$) are evaluated, but their values are discarded so that they are not included in the result expression.
691This approach follows naturally from the way that a cast to @void@ works in C.
692
693For example, in
694\begin{lstlisting}
695[int, int, int] f();
696[int, [int, int], int] g();
697
698([int, double])f();           $\C{// (1)}$
699([int, int, int])g();         $\C{// (2)}$
700([void, [int, int]])g();      $\C{// (3)}$
701([int, int, int, int])g();    $\C{// (4)}$
702([int, [int, int, int]])g()$\C{// (5)}$
703\end{lstlisting}
704
705(1) discards the last element of the return value and converts the second element to @double@.
706Since @int@ is effectively a 1-element tuple, (2) discards the second component of the second element of the return value of @g@.
707If @g@ is free of side effects, this expression is equivalent to @[(int)(g().0), (int)(g().1.0), (int)(g().2)]@.
708Since @void@ is effectively a 0-element tuple, (3) discards the first and third return values, which is effectively equivalent to @[(int)(g().1.0), (int)(g().1.1)]@).
709
710Note that a cast is not a function call in \CFA, so flattening and structuring conversions do not occur for cast expressions\footnote{User-defined conversions have been considered, but for compatibility with C and the existing use of casts as type ascription, any future design for such conversions would require more precise matching of types than allowed for function arguments and parameters.}.
711As such, (4) is invalid because the cast target type contains 4 components, while the source type contains only 3.
712Similarly, (5) is invalid because the cast @([int, int, int])(g().1)@ is invalid.
713That is, it is invalid to cast @[int, int]@ to @[int, int, int]@.
714\end{comment}
715
716
717\subsection{Polymorphism}
718
719Tuples also integrate with \CFA polymorphism as a kind of generic type.
720Due to the implicit flattening and structuring conversions involved in argument passing, @otype@ and @dtype@ parameters are restricted to matching only with non-tuple types, \eg:
721\begin{lstlisting}
722forall(otype T, dtype U) void f( T x, U * y );
723f( [5, "hello"] );
724\end{lstlisting}
725where @[5, "hello"]@ is flattened, giving argument list @5, "hello"@, and @T@ binds to @int@ and @U@ binds to @const char@.
726Tuples, however, may contain polymorphic components.
727For example, a plus operator can be written to add two triples together.
728\begin{lstlisting}
729forall(otype T | { T ?+?( T, T ); }) [T, T, T] ?+?( [T, T, T] x, [T, T, T] y ) {
730        return [x.0 + y.0, x.1 + y.1, x.2 + y.2];
731}
732[int, int, int] x;
733int i1, i2, i3;
734[i1, i2, i3] = x + ([10, 20, 30]);
735\end{lstlisting}
736
737Flattening and restructuring conversions are also applied to tuple types in polymorphic type assertions.
738\begin{lstlisting}
739int f( [int, double], double );
740forall(otype T, otype U | { T f( T, U, U ); }) void g( T, U );
741g( 5, 10.21 );
742\end{lstlisting}
743Hence, function parameter and return lists are flattened for the purposes of type unification allowing the example to pass expression resolution.
744This relaxation is possible by extending the thunk scheme described by \citet{Bilson03}.
745Whenever a candidate's parameter structure does not exactly match the formal parameter's structure, a thunk is generated to specialize calls to the actual function:
746\begin{lstlisting}
747int _thunk( int _p0, double _p1, double _p2 ) { return f( [_p0, _p1], _p2 ); }
748\end{lstlisting}
749so the thunk provides flattening and structuring conversions to inferred functions, improving the compatibility of tuples and polymorphism.
750These thunks take advantage of GCC C nested-functions to produce closures that have the usual function pointer signature.
751
752
753\subsection{Variadic Tuples}
754\label{sec:variadic-tuples}
755
756To define variadic functions, \CFA adds a new kind of type parameter, @ttype@ (tuple type).
757Matching against a @ttype@ parameter consumes all remaining argument components and packages them into a tuple, binding to the resulting tuple of types.
758In a given parameter list, there must be at most one @ttype@ parameter that occurs last, which matches normal variadic semantics, with a strong feeling of similarity to \CCeleven variadic templates.
759As such, @ttype@ variables are also called \emph{argument packs}.
760
761Like variadic templates, the main way to manipulate @ttype@ polymorphic functions is via recursion.
762Since nothing is known about a parameter pack by default, assertion parameters are key to doing anything meaningful.
763Unlike variadic templates, @ttype@ polymorphic functions can be separately compiled.
764For example, a generalized @sum@ function written using @ttype@:
765\begin{lstlisting}
766int sum$\(_0\)$() { return 0; }
767forall(ttype Params | { int sum( Params ); } ) int sum$\(_1\)$( int x, Params rest ) {
768        return x + sum( rest );
769}
770sum( 10, 20, 30 );
771\end{lstlisting}
772Since @sum@\(_0\) does not accept any arguments, it is not a valid candidate function for the call @sum(10, 20, 30)@.
773In order to call @sum@\(_1\), @10@ is matched with @x@, and the argument resolution moves on to the argument pack @rest@, which consumes the remainder of the argument list and @Params@ is bound to @[20, 30]@.
774The process continues, @Params@ is bound to @[]@, requiring an assertion @int sum()@, which matches @sum@\(_0\) and terminates the recursion.
775Effectively, this algorithm traces as @sum(10, 20, 30)@ $\rightarrow$ @10 + sum(20, 30)@ $\rightarrow$ @10 + (20 + sum(30))@ $\rightarrow$ @10 + (20 + (30 + sum()))@ $\rightarrow$ @10 + (20 + (30 + 0))@.
776
777It is reasonable to take the @sum@ function a step further to enforce a minimum number of arguments:
778\begin{lstlisting}
779int sum( int x, int y ) { return x + y; }
780forall(ttype Params | { int sum( int, Params ); } ) int sum( int x, int y, Params rest ) {
781        return sum( x + y, rest );
782}
783\end{lstlisting}
784One more step permits the summation of any summable type with all arguments of the same type:
785\begin{lstlisting}
786trait summable(otype T) {
787        T ?+?( T, T );
788};
789forall(otype R | summable( R ) ) R sum( R x, R y ) {
790        return x + y;
791}
792forall(otype R, ttype Params | summable(R) | { R sum(R, Params); } ) R sum(R x, R y, Params rest) {
793        return sum( x + y, rest );
794}
795\end{lstlisting}
796Unlike C variadic functions, it is unnecessary to hard code the number and expected types.
797Furthermore, this code is extendable so any user-defined type with a @?+?@ operator.
798Summing arbitrary heterogeneous lists is possible with similar code by adding the appropriate type variables and addition operators.
799
800It is also possible to write a type-safe variadic print function to replace @printf@:
801\begin{lstlisting}
802struct S { int x, y; };
803forall(otype T, ttype Params | { void print(T); void print(Params); }) void print(T arg, Params rest) {
804        print(arg);  print(rest);
805}
806void print( char * x ) { printf( "%s", x ); }
807void print( int x ) { printf( "%d", x ); }
808void print( S s ) { print( "{ ", s.x, ",", s.y, " }" ); }
809print( "s = ", (S){ 1, 2 }, "\n" );
810\end{lstlisting}
811This example showcases a variadic-template-like decomposition of the provided argument list.
812The individual @print@ functions allow printing a single element of a type.
813The polymorphic @print@ allows printing any list of types, where as each individual type has a @print@ function.
814The individual print functions can be used to build up more complicated @print@ functions, such as @S@, which cannot be done with @printf@ in C.
815
816Finally, it is possible to use @ttype@ polymorphism to provide arbitrary argument forwarding functions.
817For example, it is possible to write @new@ as a library function:
818\begin{lstlisting}
819forall( otype R, otype S ) void ?{}( pair(R, S) *, R, S );
820forall( dtype T, ttype Params | sized(T) | { void ?{}( T *, Params ); } ) T * new( Params p ) {
821        return ((T *)malloc()){ p };                    $\C{// construct into result of malloc}$
822}
823pair( int, char ) * x = new( 42, '!' );
824\end{lstlisting}
825The @new@ function provides the combination of type-safe @malloc@ with a \CFA constructor call, making it impossible to forget constructing dynamically allocated objects.
826This function provides the type-safety of @new@ in \CC, without the need to specify the allocated type again, thanks to return-type inference.
827
828
829\subsection{Implementation}
830
831Tuples are implemented in the \CFA translator via a transformation into generic types.
832For each $N$, the first time an $N$-tuple is seen in a scope a generic type with $N$ type parameters is generated, \eg:
833\begin{lstlisting}
834[int, int] f() {
835        [double, double] x;
836        [int, double, int] y;
837}
838\end{lstlisting}
839is transformed into:
840\begin{lstlisting}
841forall(dtype T0, dtype T1 | sized(T0) | sized(T1)) struct _tuple2 {
842        T0 field_0;                                                             $\C{// generated before the first 2-tuple}$
843        T1 field_1;
844};
845_tuple2(int, int) f() {
846        _tuple2(double, double) x;
847        forall(dtype T0, dtype T1, dtype T2 | sized(T0) | sized(T1) | sized(T2)) struct _tuple3 {
848                T0 field_0;                                                     $\C{// generated before the first 3-tuple}$
849                T1 field_1;
850                T2 field_2;
851        };
852        _tuple3(int, double, int) y;
853}
854\end{lstlisting}
855Tuple expressions are then simply converted directly into compound literals, \eg @[5, 'x', 1.24]@ becomes @(_tuple3(int, char, double)){ 5, 'x', 1.24 }@.
856
857\begin{comment}
858Since tuples are essentially structures, tuple indexing expressions are just field accesses:
859\begin{lstlisting}
860void f(int, [double, char]);
861[int, double] x;
862
863x.0+x.1;
864printf("%d %g\n", x);
865f(x, 'z');
866\end{lstlisting}
867Is transformed into:
868\begin{lstlisting}
869void f(int, _tuple2(double, char));
870_tuple2(int, double) x;
871
872x.field_0+x.field_1;
873printf("%d %g\n", x.field_0, x.field_1);
874f(x.field_0, (_tuple2){ x.field_1, 'z' });
875\end{lstlisting}
876Note that due to flattening, @x@ used in the argument position is converted into the list of its fields.
877In the call to @f@, the second and third argument components are structured into a tuple argument.
878Similarly, tuple member expressions are recursively expanded into a list of member access expressions.
879
880Expressions that may contain side effects are made into \emph{unique expressions} before being expanded by the flattening conversion.
881Each unique expression is assigned an identifier and is guaranteed to be executed exactly once:
882\begin{lstlisting}
883void g(int, double);
884[int, double] h();
885g(h());
886\end{lstlisting}
887Internally, this expression is converted to two variables and an expression:
888\begin{lstlisting}
889void g(int, double);
890[int, double] h();
891
892_Bool _unq0_finished_ = 0;
893[int, double] _unq0;
894g(
895        (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).0,
896        (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).1,
897);
898\end{lstlisting}
899Since argument evaluation order is not specified by the C programming language, this scheme is built to work regardless of evaluation order.
900The first time a unique expression is executed, the actual expression is evaluated and the accompanying boolean is set to true.
901Every subsequent evaluation of the unique expression then results in an access to the stored result of the actual expression.
902Tuple member expressions also take advantage of unique expressions in the case of possible impurity.
903
904Currently, the \CFA translator has a very broad, imprecise definition of impurity, where any function call is assumed to be impure.
905This notion could be made more precise for certain intrinsic, auto-generated, and builtin functions, and could analyze function bodies when they are available to recursively detect impurity, to eliminate some unique expressions.
906
907The various kinds of tuple assignment, constructors, and destructors generate GNU C statement expressions.
908A variable is generated to store the value produced by a statement expression, since its fields may need to be constructed with a non-trivial constructor and it may need to be referred to multiple time, \eg in a unique expression.
909The use of statement expressions allows the translator to arbitrarily generate additional temporary variables as needed, but binds the implementation to a non-standard extension of the C language.
910However, there are other places where the \CFA translator makes use of GNU C extensions, such as its use of nested functions, so this restriction is not new.
911\end{comment}
912
913
914\section{Evaluation}
915\label{sec:eval}
916
917Though \CFA provides significant added functionality over C, these features have a low runtime penalty.
918In fact, \CFA's features for generic programming can enable faster runtime execution than idiomatic @void *@-based C code.
919This claim is demonstrated through a set of generic-code-based micro-benchmarks in C, \CFA, and \CC (see stack implementations in Appendix~\ref{sec:BenchmarkStackImplementation}).
920Since all these languages share a subset essentially comprising standard C, maximal-performance benchmarks would show little runtime variance, other than in length and clarity of source code.
921A more illustrative benchmark measures the costs of idiomatic usage of each language's features.
922Figure~\ref{fig:BenchmarkTest} shows the \CFA benchmark tests for a generic stack based on a singly linked-list, a generic pair-data-structure, and a variadic @print@ routine similar to that in Section~\ref{sec:variadic-tuples}.
923The benchmark test is similar for C and \CC.
924The experiment uses element types @int@ and @pair(_Bool, char)@, and pushes $N=40M$ elements on a generic stack, copies the stack, clears one of the stacks, finds the maximum value in the other stack, and prints $N/2$ (to reduce graph height) constants.
925
926\begin{figure}
927\begin{lstlisting}[xleftmargin=3\parindentlnth,aboveskip=0pt,belowskip=0pt]
928int main( int argc, char * argv[] ) {
929        FILE * out = fopen( "cfa-out.txt", "w" );
930        int maxi = 0, vali = 42;
931        stack(int) si, ti;
932
933        REPEAT_TIMED( "push_int", N, push( &si, vali ); )
934        TIMED( "copy_int", ti = si; )
935        TIMED( "clear_int", clear( &si ); )
936        REPEAT_TIMED( "pop_int", N,
937                int xi = pop( &ti ); if ( xi > maxi ) { maxi = xi; } )
938        REPEAT_TIMED( "print_int", N/2, print( out, vali, ":", vali, "\n" ); )
939
940        pair(_Bool, char) maxp = { (_Bool)0, '\0' }, valp = { (_Bool)1, 'a' };
941        stack(pair(_Bool, char)) sp, tp;
942
943        REPEAT_TIMED( "push_pair", N, push( &sp, valp ); )
944        TIMED( "copy_pair", tp = sp; )
945        TIMED( "clear_pair", clear( &sp ); )
946        REPEAT_TIMED( "pop_pair", N,
947                pair(_Bool, char) xp = pop( &tp ); if ( xp > maxp ) { maxp = xp; } )
948        REPEAT_TIMED( "print_pair", N/2, print( out, valp, ":", valp, "\n" ); )
949        fclose(out);
950}
951\end{lstlisting}
952\caption{\CFA Benchmark Test}
953\label{fig:BenchmarkTest}
954\end{figure}
955
956The structure of each benchmark implemented is: C with @void *@-based polymorphism, \CFA with the presented features, \CC with templates, and \CC using only class inheritance for polymorphism, called \CCV.
957The \CCV variant illustrates an alternative object-oriented idiom where all objects inherit from a base @object@ class, mimicking a Java-like interface;
958hence runtime checks are necessary to safely down-cast objects.
959The most notable difference among the implementations is in memory layout of generic types: \CFA and \CC inline the stack and pair elements into corresponding list and pair nodes, while C and \CCV lack such a capability and instead must store generic objects via pointers to separately-allocated objects.
960For the print benchmark, idiomatic printing is used: the C and \CFA variants used @stdio.h@, while the \CC and \CCV variants used @iostream@; preliminary tests show this distinction has negligible runtime impact.
961Note, the C benchmark uses unchecked casts as there is no runtime mechanism to perform such checks, while \CFA and \CC provide type-safety statically.
962
963Figure~\ref{fig:eval} and Table~\ref{tab:eval} show the results of running the benchmark in Figure~\ref{fig:BenchmarkTest} and its C, \CC, and \CCV equivalents.
964The graph plots the median of 5 consecutive runs of each program, with an initial warm-up run omitted.
965All code is compiled at \texttt{-O2} by GCC or G++ 6.2.0, with all \CC code compiled as \CCfourteen.
966The benchmarks are run on an Ubuntu 16.04 workstation with 16 GB of RAM and a 6-core AMD FX-6300 CPU with 3.5 GHz maximum clock frequency.
967
968\begin{figure}
969\centering
970\input{timing}
971\caption{Benchmark Timing Results (smaller is better)}
972\label{fig:eval}
973\end{figure}
974
975\begin{table}
976\caption{Properties of benchmark code}
977\label{tab:eval}
978\newcommand{\CT}[1]{\multicolumn{1}{c}{#1}}
979\begin{tabular}{rrrrr}
980                                                                        & \CT{C}        & \CT{\CFA}     & \CT{\CC}      & \CT{\CCV}             \\ \hline
981maximum memory usage (MB)                       & 10001         & 2502          & 2503          & 11253                 \\
982source code size (lines)                        & 247           & 222           & 165           & 339                   \\
983redundant type annotations (lines)      & 39            & 2                     & 2                     & 15                    \\
984binary size (KB)                                        & 14            & 229           & 18            & 38                    \\
985\end{tabular}
986\end{table}
987
988The C and \CCV variants are generally the slowest with the largest memory footprint, because of their less-efficient memory layout and the pointer-indirection necessary to implement generic types;
989this inefficiency is exacerbated by the second level of generic types in the pair-based benchmarks.
990By contrast, the \CFA and \CC variants run in roughly equivalent time for both the integer and pair of @_Bool@ and @char@ because the storage layout is equivalent, with the inlined libraries (\ie no separate compilation) and greater maturity of the \CC compiler contributing to its lead.
991\CCV is slower than C largely due to the cost of runtime type-checking of down-casts (implemented with @dynamic_cast@);
992There are two outliers in the graph for \CFA: all prints and pop of @pair@.
993Both of these cases result from the complexity of the C-generated polymorphic code, so that the GCC compiler is unable to optimize some dead code and condense nested calls.
994A compiler designed for \CFA could easily perform these optimizations.
995Finally, the binary size for \CFA is larger because of static linking with the \CFA libraries.
996
997\CFA is also competitive in terms of source code size, measured as a proxy for programmer effort. The line counts in Table~\ref{tab:eval} include implementations of @pair@ and @stack@ types for all four languages for purposes of direct comparison, though it should be noted that \CFA and \CC have pre-written data structures in their standard libraries that programmers would generally use instead. Use of these standard library types has minimal impact on the performance benchmarks, but shrinks the \CFA and \CC benchmarks to 73 and 54 lines, respectively.
998On the other hand, C does not have a generic collections-library in its standard distribution, resulting in frequent reimplementation of such collection types by C programmers.
999\CCV does not use the \CC standard template library by construction, and in fact includes the definition of @object@ and wrapper classes for @bool@, @char@, @int@, and @const char *@ in its line count, which inflates this count somewhat, as an actual object-oriented language would include these in the standard library;
1000with their omission the \CCV line count is similar to C.
1001We justify the given line count by noting that many object-oriented languages do not allow implementing new interfaces on library types without subclassing or wrapper types, which may be similarly verbose.
1002
1003Raw line-count, however, is a fairly rough measure of code complexity;
1004another important factor is how much type information the programmer must manually specify, especially where that information is not checked by the compiler.
1005Such unchecked type information produces a heavier documentation burden and increased potential for runtime bugs, and is much less common in \CFA than C, with its manually specified function pointers arguments and format codes, or \CCV, with its extensive use of un-type-checked downcasts (\eg @object@ to @integer@ when popping a stack, or @object@ to @printable@ when printing the elements of a @pair@).
1006To quantify this, the ``redundant type annotations'' line in Table~\ref{tab:eval} counts the number of lines on which the type of a known variable is re-specified, either as a format specifier, explicit downcast, type-specific function, or by name in a @sizeof@, struct literal, or @new@ expression.
1007The \CC benchmark uses two redundant type annotations to create a new stack nodes, while the C and \CCV benchmarks have several such annotations spread throughout their code.
1008The two instances in which the \CFA benchmark still uses redundant type specifiers are to cast the result of a polymorphic @malloc@ call (the @sizeof@ argument is inferred by the compiler).
1009These uses are similar to the @new@ expressions in \CC, though the \CFA compiler's type resolver should shortly render even these type casts superfluous.
1010
1011
1012\section{Related Work}
1013
1014
1015\subsection{Polymorphism}
1016
1017\CC is the most similar language to \CFA;
1018both are extensions to C with source and runtime backwards compatibility.
1019The fundamental difference is in their engineering approach to C compatibility and programmer expectation.
1020While \CC provides good backwards compatibility with C, it has a steep learning curve for many of its extensions.
1021For example, polymorphism is provided via three disjoint mechanisms: overloading, inheritance, and templates.
1022The overloading is restricted because resolution does not using the return type, inheritance requires learning object-oriented programming and coping with a restricted nominal-inheritance hierarchy, templates cannot be separately compiled resulting in compilation/code bloat and poor error messages, and determining how these mechanisms interact and which to use is confusing.
1023In contrast, \CFA has a single facility for polymorphic code supporting type-safe separate-compilation of polymorphic functions and generic (opaque) types, which uniformly leverage the C procedural paradigm.
1024The key mechanism to support separate compilation is \CFA's \emph{explicit} use of assumed properties for a type.
1025Until \CC~\citet{C++Concepts} are standardized (anticipated for \CCtwenty), \CC provides no way to specify the requirements of a generic function in code beyond compilation errors during template expansion;
1026furthermore, \CC concepts are restricted to template polymorphism.
1027
1028Cyclone~\citep{Grossman06} also provides capabilities for polymorphic functions and existential types, similar to \CFA's @forall@ functions and generic types.
1029Cyclone existential types can include function pointers in a construct similar to a virtual function-table, but these pointers must be explicitly initialized at some point in the code, a tedious and potentially error-prone process.
1030Furthermore, Cyclone's polymorphic functions and types are restricted to abstraction over types with the same layout and calling convention as @void *@, \ie only pointer types and @int@.
1031In \CFA terms, all Cyclone polymorphism must be dtype-static.
1032While the Cyclone design provides the efficiency benefits discussed in Section~\ref{sec:generic-apps} for dtype-static polymorphism, it is more restrictive than \CFA's general model.
1033\citet{Smith98} present Polymorphic C, an ML dialect with polymorphic functions and C-like syntax and pointer types; it lacks many of C's features, however, most notably structure types, and so is not a practical C replacement.
1034
1035\citet{obj-c-book} is an industrially successful extension to C.
1036However, Objective-C is a radical departure from C, using an object-oriented model with message-passing.
1037Objective-C did not support type-checked generics until recently \citet{xcode7}, historically using less-efficient runtime checking of object types.
1038The~\citet{GObject} framework also adds object-oriented programming with runtime type-checking and reference-counting garbage-collection to C;
1039these features are more intrusive additions than those provided by \CFA, in addition to the runtime overhead of reference-counting.
1040\citet{Vala} compiles to GObject-based C, adding the burden of learning a separate language syntax to the aforementioned demerits of GObject as a modernization path for existing C code-bases.
1041Java~\citep{Java8} included generic types in Java~5, which are type-checked at compilation and type-erased at runtime, similar to \CFA's.
1042However, in Java, each object carries its own table of method pointers, while \CFA passes the method pointers separately to maintain a C-compatible layout.
1043Java is also a garbage-collected, object-oriented language, with the associated resource usage and C-interoperability burdens.
1044
1045D~\citep{D}, Go, and~\citet{Rust} are modern, compiled languages with abstraction features similar to \CFA traits, \emph{interfaces} in D and Go and \emph{traits} in Rust.
1046However, each language represents a significant departure from C in terms of language model, and none has the same level of compatibility with C as \CFA.
1047D and Go are garbage-collected languages, imposing the associated runtime overhead.
1048The necessity of accounting for data transfer between managed runtimes and the unmanaged C runtime complicates foreign-function interfaces to C.
1049Furthermore, while generic types and functions are available in Go, they are limited to a small fixed set provided by the compiler, with no language facility to define more.
1050D restricts garbage collection to its own heap by default, while Rust is not garbage-collected, and thus has a lighter-weight runtime more interoperable with C.
1051Rust also possesses much more powerful abstraction capabilities for writing generic code than Go.
1052On the other hand, Rust's borrow-checker provides strong safety guarantees but is complex and difficult to learn and imposes a distinctly idiomatic programming style.
1053\CFA, with its more modest safety features, allows direct ports of C code while maintaining the idiomatic style of the original source.
1054
1055
1056\subsection{Tuples/Variadics}
1057
1058Many programming languages have some form of tuple construct and/or variadic functions, \eg SETL, C, KW-C, \CC, D, Go, Java, ML, and Scala.
1059SETL~\cite{SETL} is a high-level mathematical programming language, with tuples being one of the primary data types.
1060Tuples in SETL allow subscripting, dynamic expansion, and multiple assignment.
1061C provides variadic functions through @va_list@ objects, but the programmer is responsible for managing the number of arguments and their types, so the mechanism is type unsafe.
1062KW-C~\cite{Buhr94a}, a predecessor of \CFA, introduced tuples to C as an extension of the C syntax, taking much of its inspiration from SETL.
1063The main contributions of that work were adding MRVF, tuple mass and multiple assignment, and record-field access.
1064\CCeleven introduced @std::tuple@ as a library variadic template structure.
1065Tuples are a generalization of @std::pair@, in that they allow for arbitrary length, fixed-size aggregation of heterogeneous values.
1066Operations include @std::get<N>@ to extract vales, @std::tie@ to create a tuple of references used for assignment, and lexicographic comparisons.
1067\CCseventeen proposes \emph{structured bindings}~\cite{Sutter15} to eliminate pre-declaring variables and use of @std::tie@ for binding the results.
1068This extension requires the use of @auto@ to infer the types of the new variables, so complicated expressions with a non-obvious type must be documented with some other mechanism.
1069Furthermore, structured bindings are not a full replacement for @std::tie@, as it always declares new variables.
1070Like \CC, D provides tuples through a library variadic-template structure.
1071Go does not have tuples but supports MRVF.
1072Java's variadic functions appear similar to C's but are type-safe using homogeneous arrays, which are less useful than \CFA's heterogeneously-typed variadic functions.
1073Tuples are a fundamental abstraction in most functional programming languages, such as Standard ML~\cite{sml} and~\cite{Scala}, which decompose tuples using pattern matching.
1074
1075
1076\section{Conclusion and Future Work}
1077
1078The goal of \CFA is to provide an evolutionary pathway for large C development-environments to be more productive and safer, while respecting the talent and skill of C programmers.
1079While other programming languages purport to be a better C, they are in fact new and interesting languages in their own right, but not C extensions.
1080The purpose of this paper is to introduce \CFA, and showcase two language features that illustrate the \CFA type-system and approaches taken to achieve the goal of evolutionary C extension.
1081The contributions are a powerful type-system using parametric polymorphism and overloading, generic types, and tuples, which all have complex interactions.
1082The work is a challenging design, engineering, and implementation exercise.
1083On the surface, the project may appear as a rehash of similar mechanisms in \CC.
1084However, every \CFA feature is different than its \CC counterpart, often with extended functionality, better integration with C and its programmers, and always supporting separate compilation.
1085All of these new features are being used by the \CFA development-team to build the \CFA runtime-system.
1086Finally, we demonstrate that \CFA performance for some idiomatic cases is better than C and close to \CC, showing the design is practically applicable.
1087
1088There is ongoing work on a wide range of \CFA feature extensions, including reference types, exceptions, concurrent primitives and modules.
1089(While all examples in the paper compile and run, a public beta-release of \CFA will take another 8--12 months to finalize these additional extensions.)
1090In addition, there are interesting future directions for the polymorphism design.
1091Notably, \CC template functions trade compile time and code bloat for optimal runtime of individual instantiations of polymorphic functions.
1092\CFA polymorphic functions use dynamic virtual-dispatch;
1093the runtime overhead of this approach is low, but not as low as inlining, and it may be beneficial to provide a mechanism for performance-sensitive code.
1094Two promising approaches are an @inline@ annotation at polymorphic function call sites to create a template-specialization of the function (provided the code is visible) or placing an @inline@ annotation on polymorphic function-definitions to instantiate a specialized version for some set of types.
1095These approaches are not mutually exclusive and allow performance optimizations to be applied only when necessary, without suffering global code-bloat.
1096In general, we believe separate compilation, producing smaller code, works well with loaded hardware-caches, which may offset the benefit of larger inlined-code.
1097
1098
1099\begin{acks}
1100The authors would like to recognize the design assistance of Glen Ditchfield, Richard Bilson, and Thierry Delisle on the features described in this paper, and thank Magnus Madsen and the three anonymous reviewers for valuable feedback.
1101This work is supported in part by a corporate partnership with \grantsponsor{Huawei}{Huawei Ltd.}{http://www.huawei.com}, and Aaron Moss and Peter Buhr are funded by the \grantsponsor{Natural Sciences and Engineering Research Council} of Canada.
1102% the first author's \grantsponsor{NSERC-PGS}{NSERC PGS D}{http://www.nserc-crsng.gc.ca/Students-Etudiants/PG-CS/BellandPostgrad-BelletSuperieures_eng.asp} scholarship.
1103\end{acks}
1104
1105
1106\bibliographystyle{ACM-Reference-Format}
1107\bibliography{cfa}
1108
1109
1110\appendix
1111
1112\section{Benchmark Stack Implementation}
1113\label{sec:BenchmarkStackImplementation}
1114
1115\lstset{basicstyle=\linespread{0.9}\sf\small}
1116
1117Throughout, @/***/@ designates a counted redundant type annotation.
1118
1119\medskip\noindent
1120\CFA
1121\begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt]
1122forall(otype T) struct stack_node {
1123        T value;
1124        stack_node(T) * next;
1125};
1126forall(otype T) void ?{}(stack(T) * s) { (&s->head){ 0 }; }
1127forall(otype T) void ?{}(stack(T) * s, stack(T) t) {
1128        stack_node(T) ** crnt = &s->head;
1129        for ( stack_node(T) * next = t.head; next; next = next->next ) {
1130                *crnt = ((stack_node(T) *)malloc()){ next->value }; /***/
1131                stack_node(T) * acrnt = *crnt;
1132                crnt = &acrnt->next;
1133        }
1134        *crnt = 0;
1135}
1136forall(otype T) stack(T) ?=?(stack(T) * s, stack(T) t) {
1137        if ( s->head == t.head ) return *s;
1138        clear(s);
1139        s{ t };
1140        return *s;
1141}
1142forall(otype T) void ^?{}(stack(T) * s) { clear(s); }
1143forall(otype T) _Bool empty(const stack(T) * s) { return s->head == 0; }
1144forall(otype T) void push(stack(T) * s, T value) {
1145        s->head = ((stack_node(T) *)malloc()){ value, s->head }; /***/
1146}
1147forall(otype T) T pop(stack(T) * s) {
1148        stack_node(T) * n = s->head;
1149        s->head = n->next;
1150        T x = n->value;
1151        ^n{};
1152        free(n);
1153        return x;
1154}
1155forall(otype T) void clear(stack(T) * s) {
1156        for ( stack_node(T) * next = s->head; next; ) {
1157                stack_node(T) * crnt = next;
1158                next = crnt->next;
1159                delete(crnt);
1160        }
1161        s->head = 0;
1162}
1163\end{lstlisting}
1164
1165\medskip\noindent
1166\CC
1167\begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt]
1168template<typename T> class stack {
1169        struct node {
1170                T value;
1171                node * next;
1172                node( const T & v, node * n = nullptr ) : value(v), next(n) {}
1173        };
1174        node * head;
1175        void copy(const stack<T>& o) {
1176                node ** crnt = &head;
1177                for ( node * next = o.head;; next; next = next->next ) {
1178                        *crnt = new node{ next->value }; /***/
1179                        crnt = &(*crnt)->next;
1180                }
1181                *crnt = nullptr;
1182        }
1183  public:
1184        stack() : head(nullptr) {}
1185        stack(const stack<T>& o) { copy(o); }
1186        stack(stack<T> && o) : head(o.head) { o.head = nullptr; }
1187        ~stack() { clear(); }
1188        stack & operator= (const stack<T>& o) {
1189                if ( this == &o ) return *this;
1190                clear();
1191                copy(o);
1192                return *this;
1193        }
1194        stack & operator= (stack<T> && o) {
1195                if ( this == &o ) return *this;
1196                head = o.head;
1197                o.head = nullptr;
1198                return *this;
1199        }
1200        bool empty() const { return head == nullptr; }
1201        void push(const T & value) { head = new node{ value, head };  /***/ }
1202        T pop() {
1203                node * n = head;
1204                head = n->next;
1205                T x = std::move(n->value);
1206                delete n;
1207                return x;
1208        }
1209        void clear() {
1210                for ( node * next = head; next; ) {
1211                        node * crnt = next;
1212                        next = crnt->next;
1213                        delete crnt;
1214                }
1215                head = nullptr;
1216        }
1217};
1218\end{lstlisting}
1219
1220\medskip\noindent
1221C
1222\begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt]
1223struct stack_node {
1224        void * value;
1225        struct stack_node * next;
1226};
1227struct stack new_stack() { return (struct stack){ NULL }; /***/ }
1228void copy_stack(struct stack * s, const struct stack * t, void * (*copy)(const void *)) {
1229        struct stack_node ** crnt = &s->head;
1230        for ( struct stack_node * next = t->head; next; next = next->next ) {
1231                *crnt = malloc(sizeof(struct stack_node)); /***/
1232                **crnt = (struct stack_node){ copy(next->value) }; /***/
1233                crnt = &(*crnt)->next;
1234        }
1235        *crnt = 0;
1236}
1237_Bool stack_empty(const struct stack * s) { return s->head == NULL; }
1238void push_stack(struct stack * s, void * value) {
1239        struct stack_node * n = malloc(sizeof(struct stack_node)); /***/
1240        *n = (struct stack_node){ value, s->head }; /***/
1241        s->head = n;
1242}
1243void * pop_stack(struct stack * s) {
1244        struct stack_node * n = s->head;
1245        s->head = n->next;
1246        void * x = n->value;
1247        free(n);
1248        return x;
1249}
1250void clear_stack(struct stack * s, void (*free_el)(void *)) {
1251        for ( struct stack_node * next = s->head; next; ) {
1252                struct stack_node * crnt = next;
1253                next = crnt->next;
1254                free_el(crnt->value);
1255                free(crnt);
1256        }
1257        s->head = NULL;
1258}
1259\end{lstlisting}
1260
1261\medskip\noindent
1262\CCV
1263\begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt]
1264stack::node::node( const object & v, node * n ) : value( v.new_copy() ), next( n ) {}
1265void stack::copy(const stack & o) {
1266        node ** crnt = &head;
1267        for ( node * next = o.head; next; next = next->next ) {
1268                *crnt = new node{ *next->value };
1269                crnt = &(*crnt)->next;
1270        }
1271        *crnt = nullptr;
1272}
1273stack::stack() : head(nullptr) {}
1274stack::stack(const stack & o) { copy(o); }
1275stack::stack(stack && o) : head(o.head) { o.head = nullptr; }
1276stack::~stack() { clear(); }
1277stack & stack::operator= (const stack & o) {
1278        if ( this == &o ) return *this;
1279        clear();
1280        copy(o);
1281        return *this;
1282}
1283stack & stack::operator= (stack && o) {
1284        if ( this == &o ) return *this;
1285        head = o.head;
1286        o.head = nullptr;
1287        return *this;
1288}
1289bool stack::empty() const { return head == nullptr; }
1290void stack::push(const object & value) { head = new node{ value, head }; /***/ }
1291ptr<object> stack::pop() {
1292        node * n = head;
1293        head = n->next;
1294        ptr<object> x = std::move(n->value);
1295        delete n;
1296        return x;
1297}
1298void stack::clear() {
1299        for ( node * next = head; next; ) {
1300                node * crnt = next;
1301                next = crnt->next;
1302                delete crnt;
1303        }
1304        head = nullptr;
1305}
1306\end{lstlisting}
1307
1308
1309\begin{comment}
1310
1311\subsubsection{bench.h}
1312(\texttt{bench.hpp} is similar.)
1313
1314\lstinputlisting{evaluation/bench.h}
1315
1316\subsection{C}
1317
1318\subsubsection{c-stack.h} ~
1319
1320\lstinputlisting{evaluation/c-stack.h}
1321
1322\subsubsection{c-stack.c} ~
1323
1324\lstinputlisting{evaluation/c-stack.c}
1325
1326\subsubsection{c-pair.h} ~
1327
1328\lstinputlisting{evaluation/c-pair.h}
1329
1330\subsubsection{c-pair.c} ~
1331
1332\lstinputlisting{evaluation/c-pair.c}
1333
1334\subsubsection{c-print.h} ~
1335
1336\lstinputlisting{evaluation/c-print.h}
1337
1338\subsubsection{c-print.c} ~
1339
1340\lstinputlisting{evaluation/c-print.c}
1341
1342\subsubsection{c-bench.c} ~
1343
1344\lstinputlisting{evaluation/c-bench.c}
1345
1346\subsection{\CFA}
1347
1348\subsubsection{cfa-stack.h} ~
1349
1350\lstinputlisting{evaluation/cfa-stack.h}
1351
1352\subsubsection{cfa-stack.c} ~
1353
1354\lstinputlisting{evaluation/cfa-stack.c}
1355
1356\subsubsection{cfa-print.h} ~
1357
1358\lstinputlisting{evaluation/cfa-print.h}
1359
1360\subsubsection{cfa-print.c} ~
1361
1362\lstinputlisting{evaluation/cfa-print.c}
1363
1364\subsubsection{cfa-bench.c} ~
1365
1366\lstinputlisting{evaluation/cfa-bench.c}
1367
1368\subsection{\CC}
1369
1370\subsubsection{cpp-stack.hpp} ~
1371
1372\lstinputlisting[language=c++]{evaluation/cpp-stack.hpp}
1373
1374\subsubsection{cpp-print.hpp} ~
1375
1376\lstinputlisting[language=c++]{evaluation/cpp-print.hpp}
1377
1378\subsubsection{cpp-bench.cpp} ~
1379
1380\lstinputlisting[language=c++]{evaluation/cpp-bench.cpp}
1381
1382\subsection{\CCV}
1383
1384\subsubsection{object.hpp} ~
1385
1386\lstinputlisting[language=c++]{evaluation/object.hpp}
1387
1388\subsubsection{cpp-vstack.hpp} ~
1389
1390\lstinputlisting[language=c++]{evaluation/cpp-vstack.hpp}
1391
1392\subsubsection{cpp-vstack.cpp} ~
1393
1394\lstinputlisting[language=c++]{evaluation/cpp-vstack.cpp}
1395
1396\subsubsection{cpp-vprint.hpp} ~
1397
1398\lstinputlisting[language=c++]{evaluation/cpp-vprint.hpp}
1399
1400\subsubsection{cpp-vbench.cpp} ~
1401
1402\lstinputlisting[language=c++]{evaluation/cpp-vbench.cpp}
1403\end{comment}
1404
1405\end{document}
1406
1407% Local Variables: %
1408% tab-width: 4 %
1409% compile-command: "make" %
1410% End: %
Note: See TracBrowser for help on using the repository browser.