source: doc/generic_types/generic_types.tex @ c87eb50

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since c87eb50 was c87eb50, checked in by Aaron Moss <a3moss@…>, 5 years ago

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

  • Property mode set to 100644
File size: 73.2 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{graphicx}
9
10\makeatletter
11% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
12% use rather than use \parident directly.
13\newlength{\parindentlnth}
14\setlength{\parindentlnth}{\parindent}
15
16\newlength{\gcolumnposn}                                % temporary hack because lstlisting does handle tabs correctly
17\newlength{\columnposn}
18\setlength{\gcolumnposn}{2.75in}
19\setlength{\columnposn}{\gcolumnposn}
20\newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@commentstyle{#2}}}
21\newcommand{\CRT}{\global\columnposn=\gcolumnposn}
22
23\newcommand{\TODO}[1]{\textbf{TODO}: {\itshape #1}} % TODO included
24%\newcommand{\TODO}[1]{} % TODO elided
25% Latin abbreviation
26\newcommand{\abbrevFont}{\textit}       % set empty for no italics
27\newcommand*{\eg}{%
28        \@ifnextchar{,}{\abbrevFont{e}.\abbrevFont{g}.}%
29                {\@ifnextchar{:}{\abbrevFont{e}.\abbrevFont{g}.}%
30                        {\abbrevFont{e}.\abbrevFont{g}.,\xspace}}%
31}%
32\newcommand*{\ie}{%
33        \@ifnextchar{,}{\abbrevFont{i}.\abbrevFont{e}.}%
34                {\@ifnextchar{:}{\abbrevFont{i}.\abbrevFont{e}.}%
35                        {\abbrevFont{i}.\abbrevFont{e}.,\xspace}}%
36}%
37\newcommand*{\etc}{%
38        \@ifnextchar{.}{\abbrevFont{etc}}%
39        {\abbrevFont{etc}.\xspace}%
40}%
41\newcommand{\etal}{%
42        \@ifnextchar{.}{\abbrevFont{et~al}}%
43                {\abbrevFont{et al}.\xspace}%
44}%
45% \newcommand{\eg}{\textit{e}.\textit{g}.,\xspace}
46% \newcommand{\ie}{\textit{i}.\textit{e}.,\xspace}
47% \newcommand{\etc}{\textit{etc}.,\xspace}
48\makeatother
49
50% Useful macros
51\newcommand{\CFA}{C$\mathbf\forall$\xspace} % Cforall symbolic name
52\newcommand{\CC}{\rm C\kern-.1em\hbox{+\kern-.25em+}\xspace} % C++ symbolic name
53\newcommand{\CCeleven}{\rm C\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name
54\newcommand{\CCfourteen}{\rm C\kern-.1em\hbox{+\kern-.25em+}14\xspace} % C++14 symbolic name
55\newcommand{\CCseventeen}{\rm C\kern-.1em\hbox{+\kern-.25em+}17\xspace} % C++17 symbolic name
56\newcommand{\CCtwenty}{\rm C\kern-.1em\hbox{+\kern-.25em+}20\xspace} % C++20 symbolic name
57\newcommand{\CCV}{\rm C\kern-.1em\hbox{+\kern-.25em+}obj\xspace} % C++ virtual symbolic name
58\newcommand{\CS}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace}
59\newcommand{\Textbf}[1]{{\color{red}\textbf{#1}}}
60
61% CFA programming language, based on ANSI C (with some gcc additions)
62\lstdefinelanguage{CFA}[ANSI]{C}{
63        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
64                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
65                fallthrough,fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,one_t,otype,restrict,_Static_assert,
66                _Thread_local,throw,throwResume,trait,try,ttype,typeof,__typeof,__typeof__,zero_t},
67}%
68
69\lstset{
70language=CFA,
71columns=fullflexible,
72basicstyle=\linespread{0.9}\sf,                                                 % reduce line spacing and use sanserif font
73stringstyle=\tt,                                                                                % use typewriter font
74tabsize=4,                                                                                              % 4 space tabbing
75xleftmargin=\parindentlnth,                                                             % indent code to paragraph indentation
76%mathescape=true,                                                                               % LaTeX math escape in CFA code $...$
77escapechar=\$,                                                                                  % LaTeX escape in CFA code
78keepspaces=true,                                                                                %
79showstringspaces=false,                                                                 % do not show spaces with cup
80showlines=true,                                                                                 % show blank lines at end of code
81aboveskip=4pt,                                                                                  % spacing above/below code block
82belowskip=3pt,
83% replace/adjust listing characters that look bad in sanserif
84literate={-}{\raisebox{-0.15ex}{\texttt{-}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
85        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {_}{\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}1 % {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
86        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2,
87moredelim=**[is][\color{red}]{`}{`},
88}% lstset
89
90% inline code @...@
91\lstMakeShortInline@%
92
93% ACM Information
94\citestyle{acmauthoryear}
95
96\acmJournal{PACMPL}
97
98\title{Generic and Tuple Types with Efficient Dynamic Layout in \CFA}
99
100\author{Aaron Moss}
101\email{a3moss@uwaterloo.ca}
102\author{Robert Schluntz}
103\email{rschlunt@uwaterloo.ca}
104\author{Peter Buhr}
105\email{pabuhr@uwaterloo.ca}
106\affiliation{%
107        \institution{University of Waterloo}
108        \department{David R. Cheriton School of Computer Science}
109        \streetaddress{Davis Centre, University of Waterloo}
110        \city{Waterloo}
111        \state{ON}
112        \postcode{N2L 3G1}
113        \country{Canada}
114}
115
116\terms{generic, tuple, variadic, types}
117\keywords{generic types, tuple types, variadic types, polymorphic functions, C, Cforall}
118
119\begin{CCSXML}
120<ccs2012>
121<concept>
122<concept_id>10011007.10011006.10011008.10011024.10011025</concept_id>
123<concept_desc>Software and its engineering~Polymorphism</concept_desc>
124<concept_significance>500</concept_significance>
125</concept>
126<concept>
127<concept_id>10011007.10011006.10011008.10011024.10011028</concept_id>
128<concept_desc>Software and its engineering~Data types and structures</concept_desc>
129<concept_significance>500</concept_significance>
130</concept>
131<concept>
132<concept_id>10011007.10011006.10011041.10011047</concept_id>
133<concept_desc>Software and its engineering~Source code generation</concept_desc>
134<concept_significance>300</concept_significance>
135</concept>
136</ccs2012>
137\end{CCSXML}
138
139\ccsdesc[500]{Software and its engineering~Polymorphism}
140\ccsdesc[500]{Software and its engineering~Data types and structures}
141\ccsdesc[300]{Software and its engineering~Source code generation}
142
143\begin{abstract}
144The 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. This installation base and the programmers producing it represent a massive software-engineering investment spanning decades and likely to continue for decades more. Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive. The 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. Prior 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. Specifically, \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. This 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.
145\end{abstract}
146
147\begin{document}
148\maketitle
149
150
151\section{Introduction and Background}
152
153The 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. This installation base and the programmers producing it represent a massive software-engineering investment spanning decades and likely to continue for decades more.
154The \citet{TIOBE} ranks the top 5 most popular programming languages as: Java 16\%, \Textbf{C 7\%}, \Textbf{\CC 5\%}, \CS 4\%, Python 4\% = 36\%, where the next 50 languages are less than 3\% each with a long tail. The top 3 rankings over the past 30 years are:
155\lstDeleteShortInline@%
156\begin{center}
157\setlength{\tabcolsep}{10pt}
158\begin{tabular}{@{}r|c|c|c|c|c|c|c@{}}
159                & 2017  & 2012  & 2007  & 2002  & 1997  & 1992  & 1987          \\
160\hline
161Java    & 1             & 1             & 1             & 1             & 12    & -             & -                     \\
162\hline
163\Textbf{C}      & \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{1}& \Textbf{1}& \Textbf{1}    \\
164\hline
165\CC             & 3             & 3             & 3             & 3             & 2             & 2             & 4                     \\
166\end{tabular}
167\end{center}
168\lstMakeShortInline@%
169Love it or hate it, C is extremely popular, highly used, and one of the few system's languages.
170In many cases, \CC is often used solely as a better C.
171Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive.
172
173\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. The four key design goals for \CFA~\citep{Bilson03} are:
174(1) The behaviour of standard C code must remain the same when translated by a \CFA compiler as when translated by a C compiler;
175(2) Standard C code must be as fast and as small when translated by a \CFA compiler as when translated by a C compiler;
176(3) \CFA code must be at least as portable as standard C code;
177(4) Extensions introduced by \CFA must be translated in the most efficient way possible.
178These 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.
179Unfortunately, \CC is actively diverging from C, so incremental additions require significant effort and training, coupled with multiple legacy design-choices that cannot be updated.
180
181\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). Ultimately, a compiler is necessary for advanced features and optimal performance.
182
183This 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. Specifically, 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. The new constructs are empirically compared with both standard C and \CC; the results show the new design is comparable in performance.
184
185
186\subsection{Polymorphic Functions}
187\label{sec:poly-fns}
188
189\CFA's polymorphism was originally formalized by \citet{Ditchfield92}, and first implemented by \citet{Bilson03}. The signature feature of \CFA is parametric-polymorphic functions where functions are generalized using a @forall@ clause (giving the language its name):
190\begin{lstlisting}
191`forall( otype T )` T identity( T val ) { return val; }
192int forty_two = identity( 42 );                         $\C{// T is bound to int, forty\_two == 42}$
193\end{lstlisting}
194The @identity@ function above can be applied to any complete \emph{object type} (or @otype@). The 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. The \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. If this extra information is not needed, \eg for a pointer, the type parameter can be declared as a \emph{data type} (or @dtype@).
195
196In \CFA, the polymorphism runtime-cost is spread over each polymorphic call, due to passing more arguments to polymorphic functions; preliminary experiments show this overhead is similar to \CC virtual-function calls. An advantage of this design is that, unlike \CC template-functions, \CFA polymorphic-functions are compatible with C \emph{separate compilation}, preventing compilation and code bloat.
197
198Since bare polymorphic-types provide only a narrow set of available operations, \CFA provides a \emph{type assertion} mechanism to provide further type information, where type assertions may be variable or function declarations that depend on a polymorphic type-variable. For example, the function @twice@ can be defined using the \CFA syntax for operator overloading:
199\begin{lstlisting}
200forall( otype T `| { T ?+?(T, T); }` ) T twice( T x ) { return x + x; } $\C{// ? denotes operands}$
201int val = twice( twice( 3.7 ) );
202\end{lstlisting}
203which works for any type @T@ with a matching addition operator. The 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@. There 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, as in~\cite{Ada}, in its type analysis.
204The first approach has a late conversion from @double@ to @int@ on the final assignment, while the second has an eager conversion to @int@. \CFA minimizes the number of conversions and their potential to lose information, so it selects the first approach, which corresponds with C-programmer intuition.
205
206Crucial to the design of a new programming language are the libraries to access thousands of external software features.
207Like \CC, \CFA inherits a massive compatible library-base, where other programming languages must rewrite or provide fragile inter-language communication with C.
208A simple example is leveraging the existing type-unsafe (@void *@) C @bsearch@ to binary search a sorted floating-point array:
209\begin{lstlisting}
210void * bsearch( const void * key, const void * base, size_t nmemb, size_t size,
211                                int (* compar)( const void *, const void * ));
212int comp( const void * t1, const void * t2 ) { return *(double *)t1 < *(double *)t2 ? -1 :
213                                *(double *)t2 < *(double *)t1 ? 1 : 0; }
214double vals[10] = { /* 10 floating-point values */ };
215double key = 5.0;
216double * val = (double *)bsearch( &key, vals, 10, sizeof(vals[0]), comp );      $\C{// search sorted array}$
217\end{lstlisting}
218which can be augmented simply with a generalized, type-safe, \CFA-overloaded wrappers:
219\begin{lstlisting}
220forall( otype T | { int ?<?( T, T ); } ) T * bsearch( T key, const T * arr, size_t size ) {
221        int comp( const void * t1, const void * t2 ) { /* as above with double changed to T */ }
222        return (T *)bsearch( &key, arr, size, sizeof(T), comp ); }
223forall( otype T | { int ?<?( T, T ); } ) unsigned int bsearch( T key, const T * arr, size_t size ) {
224        T *result = bsearch( key, arr, size );  $\C{// call first version}$
225        return result ? result - arr : size; }  $\C{// pointer subtraction includes sizeof(T)}$
226double * val = bsearch( 5.0, vals, 10 );        $\C{// selection based on return type}$
227int posn = bsearch( 5.0, vals, 10 );
228\end{lstlisting}
229The nested function @comp@ provides the hidden interface from typed \CFA to untyped (@void *@) C, plus the cast of the result.
230Providing a hidden @comp@ function in \CC is awkward as lambdas do not use C calling-conventions and template declarations cannot appear at block scope.
231As well, an alternate kind of return is made available: position versus pointer to found element.
232\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@.
233
234\CFA has replacement libraries condensing hundreds of existing C functions into tens of \CFA overloaded functions, all without rewriting the actual computations.
235For example, it is possible to write a type-safe \CFA wrapper @malloc@ based on the C @malloc@:
236\begin{lstlisting}
237forall( dtype T | sized(T) ) T * malloc( void ) { return (T *)(void *)malloc( (size_t)sizeof(T) ); }
238int * ip = malloc();                                            $\C{// select type and size from left-hand side}$
239double * dp = malloc();
240struct S {...} * sp = malloc();
241\end{lstlisting}
242where the return type supplies the type/size of the allocation, which is impossible in most type systems.
243
244Call-site inferencing and nested functions provide a localized form of inheritance. For example, the \CFA @qsort@ only sorts in ascending order using @<@. However, it is trivial to locally change this behaviour:
245\begin{lstlisting}
246forall( otype T | { int ?<?( T, T ); } ) void qsort( const T * arr, size_t size ) { /* use C qsort */ }
247{       int ?<?( double x, double y ) { return x `>` y; }       $\C{// locally override behaviour}$
248        qsort( vals, size );                                    $\C{// descending sort}$
249}
250\end{lstlisting}
251Within the block, the nested version of @<@ performs @>@ and this local version overrides the built-in @<@ so it is passed to @qsort@.
252Hence, programmers can easily form local environments, adding and modifying appropriate functions, to maximize reuse of other existing functions and types.
253
254Finally, \CFA allows variable overloading:
255\lstDeleteShortInline@%
256\par\smallskip
257\begin{tabular}{@{}l@{\hspace{\parindent}}|@{\hspace{\parindent}}l@{}}
258\begin{lstlisting}
259short int MAX = ...;
260int MAX = ...;
261double MAX = ...;
262\end{lstlisting}
263&
264\begin{lstlisting}
265short int s = MAX;  // select correct MAX
266int i = MAX;
267double d = MAX;
268\end{lstlisting}
269\end{tabular}
270\smallskip\par\noindent
271\lstMakeShortInline@%
272Hence, the single name @MAX@ replaces all the C type-specific names: @SHRT_MAX@, @INT_MAX@, @DBL_MAX@.
273As 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.
274In addition, several operations are defined in terms values @0@ and @1@, \eg:
275\begin{lstlisting}
276int x;
277if (x) x++                                                                      $\C{// if (x != 0) x += 1;}$
278\end{lstlisting}
279Every if 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.
280Due 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.
281The 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.
282
283
284\subsection{Traits}
285
286\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:
287\begin{lstlisting}
288trait summable( otype T ) {
289        void ?{}( T *, zero_t );                                $\C{// constructor from 0 literal}$
290        T ?+?( T, T );                                                  $\C{// assortment of additions}$
291        T ?+=?( T *, T );
292        T ++?( T * );
293        T ?++( T * ); };
294forall( otype T `| summable( T )` ) T sum( T a[$\,$], size_t size ) {  // use trait
295        `T` total = { `0` };                                    $\C{// instantiate T from 0 by calling its constructor}$
296        for ( unsigned int i = 0; i < size; i += 1 ) total `+=` a[i]; $\C{// select appropriate +}$
297        return total; }
298\end{lstlisting}
299
300In fact, the set of trait operators is incomplete, as there is no assignment requirement for type @T@, but @otype@ is syntactic sugar for the following implicit trait:
301\begin{lstlisting}
302trait otype( dtype T | sized(T) ) {  // sized is a pseudo-trait for types with known size and alignment
303        void ?{}( T * );                                                $\C{// default constructor}$
304        void ?{}( T *, T );                                             $\C{// copy constructor}$
305        void ?=?( T *, T );                                             $\C{// assignment operator}$
306        void ^?{}( T * ); };                                    $\C{// destructor}$
307\end{lstlisting}
308Given 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.
309% As an example, the @sum@ function produces generated code something like the following (simplified for clarity and brevity)\TODO{fix example, maybe elide, it's likely too long with the more complicated function}:
310% \begin{lstlisting}
311% void abs( size_t _sizeof_M, size_t _alignof_M,
312%               void (*_ctor_M)(void*), void (*_copy_M)(void*, void*),
313%               void (*_assign_M)(void*, void*), void (*_dtor_M)(void*),
314%               _Bool (*_lt_M)(void*, void*), void (*_neg_M)(void*, void*),
315%       void (*_ctor_M_zero)(void*, int),
316%               void* m, void* _rtn ) {                         $\C{// polymorphic parameter and return passed as void*}$
317%                                                                                       $\C{// M zero = { 0 };}$
318%       void* zero = alloca(_sizeof_M);                 $\C{// stack allocate zero temporary}$
319%       _ctor_M_zero(zero, 0);                                  $\C{// initialize using zero\_t constructor}$
320%                                                                                       $\C{// return m < zero ? -m : m;}$
321%       void *_tmp = alloca(_sizeof_M);
322%       _copy_M( _rtn,                                                  $\C{// copy-initialize return value}$
323%               _lt_M( m, zero ) ?                                      $\C{// check condition}$
324%                (_neg_M(m, _tmp), _tmp) :                      $\C{// negate m}$
325%                m);
326%       _dtor_M(_tmp); _dtor_M(zero);                   $\C{// destroy temporaries}$
327% }
328% \end{lstlisting}
329
330In 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.
331Hence, trait names play no part in type equivalence;
332the names are simply macros for a list of polymorphic assertions, which are expanded at usage sites.
333Nevertheless, trait names form a logical subtype-hierarchy with @dtype@ at the top, where traits often contain overlapping assertions, \eg operator @+@.
334Traits are used like interfaces in Java or abstract base-classes in \CC, but without the nominal inheritance-relationships.
335Instead, 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.
336Hence, 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.
337(Nominal inheritance can be approximated with traits using marker variables or functions, as is done in Go.)
338
339% Nominal inheritance can be simulated with traits using marker variables or functions:
340% \begin{lstlisting}
341% trait nominal(otype T) {
342%     T is_nominal;
343% };
344% int is_nominal;                                                               $\C{// int now satisfies the nominal trait}$
345% \end{lstlisting}
346%
347% 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:
348% \begin{lstlisting}
349% trait pointer_like(otype Ptr, otype El) {
350%     lvalue El *?(Ptr);                                                $\C{// Ptr can be dereferenced into a modifiable value of type El}$
351% }
352% struct list {
353%     int value;
354%     list *next;                                                               $\C{// may omit "struct" on type names as in \CC}$
355% };
356% typedef list *list_iterator;
357%
358% lvalue int *?( list_iterator it ) { return it->value; }
359% \end{lstlisting}
360% 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@).
361% 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.
362
363
364\section{Generic Types}
365
366One of the known shortcomings of standard C is that it does not provide reusable type-safe abstractions for generic data structures and algorithms. Broadly speaking, there are three approaches to create data structures in C. One approach is to write bespoke data structures for each context in which they are needed. While 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.
367A second approach is to use @void *@--based polymorphism, \eg the C standard-library functions @bsearch@ and @qsort@, and does allow the use of common code for common functionality. However, 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.
368A 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. Furthermore, writing and using preprocessor macros can be unnatural and inflexible.
369
370Other languages use \emph{generic types}, \eg \CC and Java, to produce type-safe abstract data-types. \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. However, for known concrete parameters, the generic type can be inlined, like \CC templates.
371
372A 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:
373\begin{lstlisting}
374forall( otype R, otype S ) struct pair {
375        R first;
376        S second;
377};
378forall( otype T ) T value( pair( const char *, T ) p ) { return p.second; }
379forall( dtype F, otype T ) T value_p( pair( F *, T * ) p ) { return *p.second; }
380pair( const char *, int ) p = { "magic", 42 };
381int magic = value( p );
382pair( void *, int * ) q = { 0, &p.second };
383magic = value_p( q );
384double d = 1.0;
385pair( double *, double * ) r = { &d, &d };
386d = value_p( r );
387\end{lstlisting}
388
389\CFA classifies generic types as either \emph{concrete} or \emph{dynamic}. Concrete have a fixed memory layout regardless of type parameters, while dynamic vary in memory layout depending on their type parameters. A type may have polymorphic parameters but still be concrete, called \emph{dtype-static}. Polymorphic 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.
390
391\CFA generic types also allow checked argument-constraints. For example, the following declaration of a sorted set-type ensures the set key supports equality and relational comparison:
392\begin{lstlisting}
393forall( otype Key | { _Bool ?==?(Key, Key); _Bool ?<?(Key, Key); } ) struct sorted_set;
394\end{lstlisting}
395
396
397\subsection{Concrete Generic-Types}
398
399The \CFA translator template-expands concrete generic-types into new structure types, affording maximal inlining. To 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. For 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. For example, the concrete instantiation for @pair( const char *, int )@ is:
400\begin{lstlisting}
401struct _pair_conc1 {
402        const char * first;
403        int second;
404};
405\end{lstlisting}
406
407A concrete generic-type with dtype-static parameters is also expanded to a structure type, but this type is used for all matching instantiations. In 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:
408\begin{lstlisting}
409struct _pair_conc0 {
410        void * first;
411        void * second;
412};
413\end{lstlisting}
414
415
416\subsection{Dynamic Generic-Types}
417
418Though \CFA implements concrete generic-types efficiently, it also has a fully general system for dynamic generic types.
419As 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.
420Dynamic generic-types also have an \emph{offset array} containing structure member-offsets.
421A dynamic generic-union needs no such offset array, as all members are at offset 0 but size and alignment are still necessary.
422Access 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.
423
424The offset arrays are statically generated where possible.
425If 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;
426if 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.
427As 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 )@.
428The offset array @_offsetof_pair@ is generated at the call site as @size_t _offsetof_pair[] = { offsetof(_pair_conc1, first), offsetof(_pair_conc1, second) }@.
429
430In some cases the offset arrays cannot be statically generated. For 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.
431\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.
432The \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.
433These 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).
434Results of these layout functions are cached so that they are only computed once per type per function. %, as in the example below for @pair@.
435% \begin{lstlisting}
436% static inline void _layoutof_pair(size_t* _szeof_pair, size_t* _alignof_pair, size_t* _offsetof_pair,
437%               size_t _szeof_R, size_t _alignof_R, size_t _szeof_S, size_t _alignof_S) {
438%     *_szeof_pair = 0; // default values
439%     *_alignof_pair = 1;
440%
441%       // add offset, size, and alignment of first field
442%     _offsetof_pair[0] = *_szeof_pair;
443%     *_szeof_pair += _szeof_R;
444%     if ( *_alignof_pair < _alignof_R ) *_alignof_pair = _alignof_R;
445%
446%       // padding, offset, size, and alignment of second field
447%     if ( *_szeof_pair & (_alignof_S - 1) )
448%               *_szeof_pair += (_alignof_S - ( *_szeof_pair & (_alignof_S - 1) ) );
449%     _offsetof_pair[1] = *_szeof_pair;
450%     *_szeof_pair += _szeof_S;
451%     if ( *_alignof_pair < _alignof_S ) *_alignof_pair = _alignof_S;
452%
453%       // pad to struct alignment
454%     if ( *_szeof_pair & (*_alignof_pair - 1) )
455%               *_szeof_pair += ( *_alignof_pair - ( *_szeof_pair & (*_alignof_pair - 1) ) );
456% }
457% \end{lstlisting}
458Layout functions also allow generic types to be used in a function definition without reflecting them in the function signature.
459For 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.
460This function could acquire the layout for @set(T)@ by calling its layout function with the layout of @T@ implicitly passed into the function.
461
462Whether a type is concrete, dtype-static, or dynamic is decided solely on the type parameters and @forall@ clause on a declaration.
463This 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.
464If 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.
465
466
467\subsection{Applications}
468\label{sec:generic-apps}
469
470The reuse of dtype-static structure instantiations enables useful programming patterns at zero runtime cost. The 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@:
471\begin{lstlisting}
472forall(dtype T) int lexcmp( pair( T *, T * ) * a, pair( T *, T * ) * b, int (* cmp)( T *, T * ) ) {
473        return cmp( a->first, b->first ) ? : cmp( a->second, b->second );
474}
475\end{lstlisting}
476%       int c = cmp( a->first, b->first );
477%       if ( c == 0 ) c = cmp( a->second, b->second );
478%       return c;
479Since @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.
480
481Another useful pattern enabled by reused dtype-static type instantiations is zero-cost \emph{tag-structures}.
482Sometimes information is only used for type-checking and can be omitted at runtime, \eg:
483\begin{lstlisting}
484forall(dtype Unit) struct scalar { unsigned long value; };
485struct metres {};
486struct litres {};
487
488forall(dtype U) scalar(U) ?+?( scalar(U) a, scalar(U) b ) {
489        return (scalar(U)){ a.value + b.value };
490}
491scalar(metres) half_marathon = { 21093 };
492scalar(litres) swimming_pool = { 2500000 };
493scalar(metres) marathon = half_marathon + half_marathon;
494scalar(litres) two_pools = swimming_pool + swimming_pool;
495marathon + swimming_pool;                                       $\C{// compilation ERROR}$
496\end{lstlisting}
497@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 @?+?@.
498These implementations may even be separately compiled, unlike \CC template functions.
499However, the \CFA type-checker ensures matching types are used by all calls to @?+?@, preventing nonsensical computations like adding a length to a volume.
500
501
502\section{Tuples}
503\label{sec:tuples}
504
505In many languages, functions can return at most one value;
506however, many operations have multiple outcomes, some exceptional.
507Consider C's @div@ and @remquo@ functions, which return the quotient and remainder for a division of integer and floating-point values, respectively.
508\begin{lstlisting}
509typedef struct { int quo, rem; } div_t;
510div_t div( int num, int den );
511double remquo( double num, double den, int * quo );
512div_t qr = div( 13, 5 );                                        $\C{// return quotient/remainder aggregate}$
513int q;
514double r = remquo( 13.5, 5.2, &q );                     $\C{// return remainder, alias quotient}$
515\end{lstlisting}
516@div@ aggregates the quotient/remainder in a structure, while @remquo@ aliases a parameter to an argument.
517Both approaches are awkward.
518Alternatively, a programming language can directly support returning multiple values, \eg in \CFA:
519\begin{lstlisting}
520[ int, int ] div( int num, int den );           $\C{// return two integers}$
521[ double, double ] div( double num, double den ); $\C{// return two doubles}$
522int q, r;                                                                       $\C{// overload variable names}$
523double q, r;
524[ q, r ] = div( 13, 5 );                                        $\C{// select appropriate div and q, r}$
525[ q, r ] = div( 13.5, 5.2 );
526\end{lstlisting}
527Clearly, this approach is straightforward to understand and use;
528therefore, why do few programming languages support this obvious feature or provide it awkwardly?
529The answer is that there are complex consequences that cascade through multiple aspects of the language, especially the type-system.
530This section show these consequences and how \CFA deals with them.
531
532
533\subsection{Tuple Expressions}
534
535The addition of multiple-return-value functions (MRVF) are useless without a syntax for accepting multiple values at the call-site.
536The simplest mechanism for capturing the return values is variable assignment, allowing the values to be retrieved directly.
537As 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}.
538
539However, 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:
540\begin{lstlisting}
541printf( "%d %d\n", div( 13, 5 ) );                      $\C{// return values seperated into arguments}$
542\end{lstlisting}
543Here, the values returned by @div@ are composed with the call to @printf@.
544However, the \CFA type-system must support significantly more complex composition:
545\begin{lstlisting}
546[ int, int ] foo$\(_1\)$( int );
547[ double ] foo$\(_2\)$( int );
548void bar( int, double, double );
549bar( foo( 3 ), foo( 3 ) );
550\end{lstlisting}
551The 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.
552No combination of @foo@s are an exact match with @bar@'s parameters, so the resolver applies C conversions.
553The minimal cost is @bar( foo@$_1$@( 3 ), foo@$_2$@( 3 ) )@, giving (@int@, {\color{green}@int@}, @double@) to (@int@, {\color{green}@double@}, @double@) with one {\color{green}safe} (widening) conversion from @int@ to @double@ versus ({\color{red}@double@}, {\color{green}@int@}, {\color{green}@int@}) to ({\color{red}@int@}, {\color{green}@double@}, {\color{green}@double@}) with one {\color{red}unsafe} (narrowing) conversion from @double@ to @int@ and two safe conversions.
554
555
556\subsection{Tuple Variables}
557
558An important observation from function composition is that new variable names are not required to initialize parameters from an MRVF.
559\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.
560As a consequence, \CFA allows declaration of \emph{tuple variables} that can be initialized from an MRVF, \eg:
561\begin{lstlisting}
562[ int, int ] qr = div( 13, 5 );                         $\C{// tuple-variable declaration and initialization}$
563[ double, double ] qr = div( 13.5, 5.2 );
564\end{lstlisting}
565where the tuple variable-name serves the same purpose as the parameter name(s).
566Tuple variables can be composed of any types, except for array types, since array sizes are generally unknown.
567
568One way to access the tuple-variable components is with assignment or composition:
569\begin{lstlisting}
570[ q, r ] = qr;                                                          $\C{// access tuple-variable components}$
571printf( "%d %d\n", qr );
572\end{lstlisting}
573\CFA also supports \emph{tuple indexing} to access single components of a tuple expression:
574\begin{lstlisting}
575[int, int] * p = &qr;                                           $\C{// tuple pointer}$
576int rem = qr.1;                                                         $\C{// access remainder}$
577int quo = div( 13, 5 ).0;                                       $\C{// access quotient}$
578p->0 = 5;                                                                       $\C{// change quotient}$
579bar( qr.1, qr );                                                        $\C{// pass remainder and quotient/remainder}$
580rem = [42, div( 13, 5 )].0.1;                           $\C{// access 2nd component of 1st component of tuple expression}$
581\end{lstlisting}
582
583
584\subsection{Flattening and Restructuring}
585
586In function call contexts, tuples support implicit flattening and restructuring conversions.
587Tuple flattening recursively expands a tuple into the list of its basic components.
588Tuple structuring packages a list of expressions into a value of tuple type, \eg:
589\lstDeleteShortInline@%
590\par\smallskip
591\begin{tabular}{@{}l@{\hspace{\parindent}}|@{\hspace{\parindent}}l@{}}
592\begin{lstlisting}
593int f( int, int );
594int g( [int, int] );
595int h( int, [int, int] );
596[int, int] x;
597\end{lstlisting}
598&
599\begin{lstlisting}
600int y;
601f( x );                 $\C[1in]{// flatten}$
602g( y, 10 );             $\C{// structure}$
603h( x, y );              $\C{// flatten and structure}\CRT{}$
604\end{lstlisting}
605\end{tabular}
606\smallskip\par\noindent
607\lstMakeShortInline@%
608In the call to @f@, @x@ is implicitly flattened so the components of @x@ are passed as the two arguments.
609In 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@.
610Finally, 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]@.
611The 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.
612
613
614\subsection{Tuple Assignment}
615
616An assignment where the left side is a tuple type is called \emph{tuple assignment}.
617There 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.
618\lstDeleteShortInline@%
619\par\smallskip
620\begin{tabular}{@{}l@{\hspace{\parindent}}|@{\hspace{\parindent}}l@{}}
621\begin{lstlisting}
622int x = 10;
623double y = 3.5;
624[int, double] z;
625
626\end{lstlisting}
627&
628\begin{lstlisting}
629z = [x, y];             $\C[1in]{// multiple assignment}$
630[x, y] = z;             $\C{// multiple assignment}$
631z = 10;                 $\C{// mass assignment}$
632[y, x] = 3.14$\C{// mass assignment}\CRT{}$
633\end{lstlisting}
634\end{tabular}
635\smallskip\par\noindent
636\lstMakeShortInline@%
637Both kinds of tuple assignment have parallel semantics, so that each value on the left and right side is evaluated before any assignments occur.
638As 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]@.
639This 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.
640For example, @[y, x] = 3.14@ performs the assignments @y = 3.14@ and @x = 3.14@, yielding @y == 3.14@ and @x == 3@;
641whereas C cascading assignment @y = x = 3.14@ performs the assignments @x = 3.14@ and @y = x@, yielding @3@ in @y@ and @x@.
642Finally, 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.
643This example shows mass, multiple, and cascading assignment used in one expression:
644\begin{lstlisting}
645void f( [int, int] );
646f( [x, y] = z = 1.5 );                                          $\C{// assignments in parameter list}$
647\end{lstlisting}
648
649
650\subsection{Member Access}
651
652It is also possible to access multiple fields from a single expression using a \emph{member-access}.
653The result is a single tuple-valued expression whose type is the tuple of the types of the members, \eg:
654\begin{lstlisting}
655struct S { int x; double y; char * z; } s;
656s.[x, y, z] = 0;
657\end{lstlisting}
658Here, the mass assignment sets all members of @s@ to zero.
659Since 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).
660\lstDeleteShortInline@%
661\par\smallskip
662\begin{tabular}{@{}l@{\hspace{\parindent}}|@{\hspace{\parindent}}l@{}}
663\begin{lstlisting}
664[int, int, long, double] x;
665void f( double, long );
666
667\end{lstlisting}
668&
669\begin{lstlisting}
670x.[0, 1] = x.[1, 0];    $\C[1in]{// rearrange: [x.0, x.1] = [x.1, x.0]}$
671f( x.[0, 3] );            $\C{// drop: f(x.0, x.3)}\CRT{}$
672[int, int, int] y = x.[2, 0, 2]; // duplicate: [y.0, y.1, y.2] = [x.2, x.0. x.2]
673\end{lstlisting}
674\end{tabular}
675\smallskip\par\noindent
676\lstMakeShortInline@%
677It is also possible for a member access to contain other member accesses, \eg:
678\begin{lstlisting}
679struct A { double i; int j; };
680struct B { int * k; short l; };
681struct C { int x; A y; B z; } v;
682v.[x, y.[i, j], z.k];                                           $\C{// [v.x, [v.y.i, v.y.j], v.z.k]}$
683\end{lstlisting}
684
685
686\begin{comment}
687\subsection{Casting}
688
689In C, the cast operator is used to explicitly convert between types. In \CFA, the cast operator has a secondary use as type ascription. That 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:
690\begin{lstlisting}
691int f();     // (1)
692double f()// (2)
693
694f();       // ambiguous - (1),(2) both equally viable
695(int)f()// choose (2)
696\end{lstlisting}
697
698Since casting is a fundamental operation in \CFA, casts should be given a meaningful interpretation in the context of tuples. Taking a look at standard C provides some guidance with respect to the way casts should work with tuples:
699\begin{lstlisting}
700int f();
701void g();
702
703(void)f()// (1)
704(int)g()// (2)
705\end{lstlisting}
706In C, (1) is a valid cast, which calls @f@ and discards its result. On the other hand, (2) is invalid, because @g@ does not produce a result, so requesting an @int@ to materialize from nothing is nonsensical. Generalizing 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.
707
708Formally, 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$. Excess 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. This approach follows naturally from the way that a cast to @void@ works in C.
709
710For example, in
711\begin{lstlisting}
712[int, int, int] f();
713[int, [int, int], int] g();
714
715([int, double])f();           $\C{// (1)}$
716([int, int, int])g();         $\C{// (2)}$
717([void, [int, int]])g();      $\C{// (3)}$
718([int, int, int, int])g();    $\C{// (4)}$
719([int, [int, int, int]])g()$\C{// (5)}$
720\end{lstlisting}
721
722(1) discards the last element of the return value and converts the second element to @double@. Since @int@ is effectively a 1-element tuple, (2) discards the second component of the second element of the return value of @g@. If @g@ is free of side effects, this expression is equivalent to @[(int)(g().0), (int)(g().1.0), (int)(g().2)]@.
723Since @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)]@).
724
725Note 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.}. As such, (4) is invalid because the cast target type contains 4 components, while the source type contains only 3. Similarly, (5) is invalid because the cast @([int, int, int])(g().1)@ is invalid. That is, it is invalid to cast @[int, int]@ to @[int, int, int]@.
726\end{comment}
727
728
729\subsection{Polymorphism}
730
731Tuples also integrate with \CFA polymorphism as a kind of generic type.
732Due 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:
733\begin{lstlisting}
734forall(otype T, dtype U) void f( T x, U * y );
735f( [5, "hello"] );
736\end{lstlisting}
737where @[5, "hello"]@ is flattened, giving argument list @5, "hello"@, and @T@ binds to @int@ and @U@ binds to @const char@.
738Tuples, however, may contain polymorphic components.
739For example, a plus operator can be written to add two triples together.
740\begin{lstlisting}
741forall(otype T | { T ?+?( T, T ); }) [T, T, T] ?+?( [T, T, T] x, [T, T, T] y ) {
742        return [x.0 + y.0, x.1 + y.1, x.2 + y.2];
743}
744[int, int, int] x;
745int i1, i2, i3;
746[i1, i2, i3] = x + ([10, 20, 30]);
747\end{lstlisting}
748
749Flattening and restructuring conversions are also applied to tuple types in polymorphic type assertions.
750\begin{lstlisting}
751int f( [int, double], double );
752forall(otype T, otype U | { T f( T, U, U ); })
753void g( T, U );
754g( 5, 10.21 );
755\end{lstlisting}
756Hence, function parameter and return lists are flattened for the purposes of type unification allowing the example to pass expression resolution.
757This relaxation is possible by extending the thunk scheme described by \citet{Bilson03}.
758Whenever 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:
759\begin{lstlisting}
760int _thunk( int _p0, double _p1, double _p2 ) {
761        return f( [_p0, _p1], _p2 );
762}
763\end{lstlisting}
764so the thunk provides flattening and structuring conversions to inferred functions, improving the compatibility of tuples and polymorphism.
765These thunks take advantage of GCC C nested-functions to produce closures that have the usual function pointer signature.
766
767
768\subsection{Variadic Tuples}
769\label{sec:variadic-tuples}
770
771To define variadic functions, \CFA adds a new kind of type parameter, @ttype@ (tuple type).
772Matching against a @ttype@ parameter consumes all remaining argument components and packages them into a tuple, binding to the resulting tuple of types.
773In 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.
774As such, @ttype@ variables are also called \emph{argument packs}.
775
776Like variadic templates, the main way to manipulate @ttype@ polymorphic functions is via recursion.
777Since nothing is known about a parameter pack by default, assertion parameters are key to doing anything meaningful.
778Unlike variadic templates, @ttype@ polymorphic functions can be separately compiled.
779For example, a generalized @sum@ function written using @ttype@:
780\begin{lstlisting}
781int sum$\(_0\)$() { return 0; }
782forall(ttype Params | { int sum( Params ); } ) int sum$\(_1\)$( int x, Params rest ) {
783        return x + sum( rest );
784}
785sum( 10, 20, 30 );
786\end{lstlisting}
787Since @sum@\(_0\) does not accept any arguments, it is not a valid candidate function for the call @sum(10, 20, 30)@.
788In 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]@.
789The process continues, @Params@ is bound to @[]@, requiring an assertion @int sum()@, which matches @sum@\(_0\) and terminates the recursion.
790Effectively, 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))@.
791
792It is reasonable to take the @sum@ function a step further to enforce a minimum number of arguments:
793\begin{lstlisting}
794int sum( int x, int y ) { return x + y; }
795forall(ttype Params | { int sum( int, Params ); } ) int sum( int x, int y, Params rest ) {
796        return sum( x + y, rest );
797}
798\end{lstlisting}
799One more step permits the summation of any summable type with all arguments of the same type:
800\begin{lstlisting}
801trait summable(otype T) {
802        T ?+?( T, T );
803};
804forall(otype R | summable( R ) ) R sum( R x, R y ) {
805        return x + y;
806}
807forall(otype R, ttype Params | summable(R) | { R sum(R, Params); } ) R sum(R x, R y, Params rest) {
808        return sum( x + y, rest );
809}
810\end{lstlisting}
811Unlike C variadic functions, it is unnecessary to hard code the number and expected types.
812Furthermore, this code is extendable so any user-defined type with a @?+?@ operator.
813Summing arbitrary heterogeneous lists is possible with similar code by adding the appropriate type variables and addition operators.
814
815It is also possible to write a type-safe variadic print function to replace @printf@:
816\begin{lstlisting}
817struct S { int x, y; };
818forall(otype T, ttype Params | { void print(T); void print(Params); }) void print(T arg, Params rest) {
819        print(arg);
820        print(rest);
821}
822void print( char * x ) { printf( "%s", x ); }
823void print( int x ) { printf( "%d", x ); }
824void print( S s ) { print( "{ ", s.x, ",", s.y, " }" ); }
825print( "s = ", (S){ 1, 2 }, "\n" );
826\end{lstlisting}
827This example showcases a variadic-template-like decomposition of the provided argument list.
828The individual @print@ functions allow printing a single element of a type.
829The polymorphic @print@ allows printing any list of types, as long as each individual type has a @print@ function.
830The individual print functions can be used to build up more complicated @print@ functions, such as for @S@, which is something that cannot be done with @printf@ in C.
831
832Finally, it is possible to use @ttype@ polymorphism to provide arbitrary argument forwarding functions.
833For example, it is possible to write @new@ as a library function:
834\begin{lstlisting}
835struct pair( otype R, otype S );
836forall( otype R, otype S ) void ?{}( pair(R, S) *, R, S );  // (1)
837forall( dtype T, ttype Params | sized(T) | { void ?{}( T *, Params ); } ) T * new( Params p ) {
838        return ((T*)malloc( sizeof(T) )){ p }; // construct into result of malloc
839}
840pair( int, char ) * x = new( 42, '!' );
841\end{lstlisting}
842The @new@ function provides the combination of type-safe @malloc@ with a \CFA constructor call, making it impossible to forget constructing dynamically allocated objects.
843This function provides the type-safety of @new@ in \CC, without the need to specify the allocated type again, thanks to return-type inference.
844
845% In the call to @new@, @pair(double, char)@ is selected to match @T@, and @Params@ is expanded to match @[double, char]@. The constructor (1) may be specialized to  satisfy the assertion for a constructor with an interface compatible with @void ?{}(pair(int, char) *, int, char)@.
846
847
848\subsection{Implementation}
849
850Tuples are implemented in the \CFA translator via a transformation into generic types.
851For each $N$, the first time an $N$-tuple is seen in a scope a generic type with $N$ type parameters is generated. \eg:
852\begin{lstlisting}
853[int, int] f() {
854        [double, double] x;
855        [int, double, int] y;
856}
857\end{lstlisting}
858is transformed into:
859\begin{lstlisting}
860// generated before the first 2-tuple
861forall(dtype T0, dtype T1 | sized(T0) | sized(T1)) struct _tuple2 {
862        T0 field_0;
863        T1 field_1;
864};
865_tuple2(int, int) f() {
866        _tuple2(double, double) x;
867        // generated before the first 3-tuple
868        forall(dtype T0, dtype T1, dtype T2 | sized(T0) | sized(T1) | sized(T2)) struct _tuple3 {
869                T0 field_0;
870                T1 field_1;
871                T2 field_2;
872        };
873        _tuple3(int, double, int) y;
874}
875\end{lstlisting}
876Tuple expressions are then simply converted directly into compound literals:
877\begin{lstlisting}
878[5, 'x', 1.24];
879\end{lstlisting}
880becomes:
881\begin{lstlisting}
882(_tuple3(int, char, double)){ 5, 'x', 1.24 };
883\end{lstlisting}
884
885\begin{comment}
886Since tuples are essentially structures, tuple indexing expressions are just field accesses:
887\begin{lstlisting}
888void f(int, [double, char]);
889[int, double] x;
890
891x.0+x.1;
892printf("%d %g\n", x);
893f(x, 'z');
894\end{lstlisting}
895Is transformed into:
896\begin{lstlisting}
897void f(int, _tuple2(double, char));
898_tuple2(int, double) x;
899
900x.field_0+x.field_1;
901printf("%d %g\n", x.field_0, x.field_1);
902f(x.field_0, (_tuple2){ x.field_1, 'z' });
903\end{lstlisting}
904Note that due to flattening, @x@ used in the argument position is converted into the list of its fields. In the call to @f@, the second and third argument components are structured into a tuple argument. Similarly, tuple member expressions are recursively expanded into a list of member access expressions.
905
906Expressions that may contain side effects are made into \emph{unique expressions} before being expanded by the flattening conversion. Each unique expression is assigned an identifier and is guaranteed to be executed exactly once:
907\begin{lstlisting}
908void g(int, double);
909[int, double] h();
910g(h());
911\end{lstlisting}
912Internally, this expression is converted to two variables and an expression:
913\begin{lstlisting}
914void g(int, double);
915[int, double] h();
916
917_Bool _unq0_finished_ = 0;
918[int, double] _unq0;
919g(
920        (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).0,
921        (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).1,
922);
923\end{lstlisting}
924Since argument evaluation order is not specified by the C programming language, this scheme is built to work regardless of evaluation order. The first time a unique expression is executed, the actual expression is evaluated and the accompanying boolean is set to true. Every subsequent evaluation of the unique expression then results in an access to the stored result of the actual expression. Tuple member expressions also take advantage of unique expressions in the case of possible impurity.
925
926Currently, the \CFA translator has a very broad, imprecise definition of impurity, where any function call is assumed to be impure. This 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.
927
928The various kinds of tuple assignment, constructors, and destructors generate GNU C statement expressions. A 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. The 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. However, 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.
929\end{comment}
930
931
932\section{Evaluation}
933
934Though \CFA provides significant added functionality over C, these added features do not impose a significant runtime penalty. In fact, \CFA's features for generic programming can enable runtime execution that is faster than idiomatic @void*@-based C code. We have produced a set of generic-code-based micro-benchmarks to demonstrate these claims, source code for which may be found in \TODO{Appendix A}. These benchmarks test a generic stack based on a singly-linked-list, a generic pair data structure, and a variadic @print@ routine similar to that shown in Section~\ref{sec:variadic-tuples}. Each benchmark has been implemented in C with @void*@-based polymorphism, \CFA with the features discussed in this paper, \CC with templates, and \CC using only class inheritance for polymorphism (``\CCV''). The intention of these benchmarks is to represent the costs of idiomatic use of each language's features, rather than the strict maximal performance obtainable by code written in each language -- as all the languages considered have a shared subset comprising most of standard C, a set of maximal-performance benchmarks would presumably show very little runtime variance, and would differ primarily in length and clarity of source code. Particularly, in the \CCV variant of the benchmark all objects inherit from a base @object@ class, explicitly implement interfaces defined as abstract base classes, and must do runtime checks in generic code to safely down-cast objects; this is not an idiomatic programming pattern for \CC, but is meant to represent the design of a simple object-oriented programming language. The most notable difference between the implementations is  memory layout; the \CFA and \CC variants inline the stack and pair elements into their corresponding list and pair nodes, while the C and \CCV versions are forced by their lack of a generic type capability to store generic objects via pointers to separately-allocated objects. For more idiomatic language use, the C and \CFA variants used \texttt{cstdio.h} for printing, while the \CC and \CCV variants used \texttt{iostream}, though preliminary experiments showed this distinction to make little runtime difference. For consistency in testing, all implementations used the C @rand()@ function for random number generation.
935
936\begin{figure}
937\centering
938\includegraphics{evaluation/timing}
939\caption{Timing Results for benchmarks}
940\label{fig:eval}
941\end{figure}
942
943\begin{table}
944\caption{Properties of benchmark code}
945\label{tab:eval}
946\begin{tabular}{lrrrr}
947                                                        &       C               &       \CFA    &       \CC             &       \CCV    \\ \hline
948maximum memory usage (MB)       &       10001   &       2501    &       2503    &       11253   \\
949source code size (lines)        &       301             &       224             &       188             &       437             \\
950binary size (KB)                        &       18.46   &       234.22  &       18.42   &       42.10   \\
951\end{tabular}
952\end{table}
953
954The results of running the benchmarks can be seen in Figure~\ref{fig:eval} and Table~\ref{tab:eval}; each result records the time taken by a single function call, repeated $N = 40,000,000$ times where appropriate. The five functions are $N$ stack pushes of randomly generated elements, deep copy of an $N$ element stack, clearing all nodes of an $N$ element stack, $N/2$ variadic @print@ calls each containing two constant strings and two stack elements \TODO{right now $N$ fresh elements: FIX}, and $N$ stack pops, keeping a running record of the maximum element to ensure that the object copies are not optimized out. These five functions are run first for a stack of integers, and second for a stack of generic pairs of a boolean and a @char@. \TODO{} The data shown is the median of 5 consecutive runs of each program, with an initial warm-up run omitted. All code was compiled at \texttt{-O2} by GCC or G++ 6.2.0, with all \CC code compiled as \CCfourteen. The benchmarks were 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. The C and \CCV variants are generally the slowest and most memory-hungry, due to their less-efficient memory layout and the pointer-indirection necessary to implement generic types in these languages; this problem is exacerbated by the second level of generic types in the pair-based benchmarks. By contrast, the \CFA and \CC variants run in roughly equivalent time for both the integer and pair of boolean and char tests, which makes sense given that an integer is actually larger than the pair in both languages.
955
956The \CC code is the shortest largely due to its use of header-only libraries, as template code cannot be separately compiled, the \CFA line count would shrink to \TODO{} if it used a header-only approach instead of the more idiomatic separate compilation. \CFA and \CC also have the advantage of a more extensive standard library; as part of the standard library neither language's generic @pair@ type is included in the line count, while this type must be written by the user programmer in both C and \CCV. The definition of @object@ and wrapper classes for @bool@, @char@, @int@, and @const char*@ are included in the line count for \CCV, which somewhat inflates its line count, as an actual object-oriented language would include these in the standard library and with their omission the \CCV line count is similar to C; we justify the given line count by the fact that many object-oriented languages do not allow implementing new interfaces on library types without subclassing or boilerplate-filled wrapper types, which may be similarly verbose. Raw line-count, however, is a fairly rough measure of code complexity; another important factor is how much type information the programmer must manually specify, especially where that information is not checked by the compiler. Such un-checked 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@) \TODO{Actually calculate this; I want to put a distinctive comment in the source code and grep for it}.
957
958\section{Related Work}
959
960
961\subsection{Generics}
962
963\CC is the existing language it is most natural to compare \CFA to, as they are both more modern extensions to C with backwards source compatibility. The most fundamental difference in approach between \CC and \CFA is their approach to this C compatibility. \CC does provide fairly strong source backwards compatibility with C, but is a dramatically more complex language than C, and imposes a steep learning curve to use many of its extension features. For instance, in a break from general C practice, template code is typically written in header files, with a variety of subtle restrictions implied on its use by this choice, while the other polymorphism mechanism made available by \CC, class inheritance, requires programmers to learn an entirely new object-oriented programming paradigm; the interaction between templates and inheritance is also quite complex. \CFA, by contrast, has a single facility for polymorphic code, one which supports separate compilation and the existing procedural paradigm of C code. A major difference between the approaches of \CC and \CFA to polymorphism is that the set of assumed properties for a type is \emph{explicit} in \CFA. One of the major limiting factors of \CC's approach is that templates cannot be separately compiled, and, until concepts~\citep{C++Concepts} are standardized (currently anticipated for \CCtwenty), \CC provides no way to specify the requirements of a generic function in code beyond compilation errors for template expansion failures. By contrast, the explicit nature of assertions in \CFA allows polymorphic functions to be separately compiled, and for their requirements to be checked by the compiler; similarly, \CFA generic types may be opaque, unlike \CC template classes.
964
965Cyclone also provides capabilities for polymorphic functions and existential types~\citep{Grossman06}, similar in concept to \CFA's @forall@ functions and generic types. Cyclone 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. Furthermore, Cyclone's polymorphic functions and types are restricted in that they may only abstract over types with the same layout and calling convention as @void*@, in practice only pointer types and @int@ - in \CFA terms, all Cyclone polymorphism must be dtype-static. This design provides the efficiency benefits discussed in Section~\ref{sec:generic-apps} for dtype-static polymorphism, but is more restrictive than \CFA's more general model.
966
967Apple's Objective-C \citep{obj-c-book} is another industrially successful set of extensions to C. The Objective-C language model is a fairly radical departure from C, adding object-orientation and message-passing. Objective-C implements variadic functions using the C @va_arg@ mechanism, and did not support type-checked generics until recently \citep{xcode7}, historically using less-efficient and more error-prone runtime checking of object types instead. The GObject framework \citep{GObject} also adds object-orientation with runtime type-checking and reference-counting garbage-collection to C; these are much more intrusive feature additions than those provided by \CFA, in addition to the runtime overhead of reference-counting. The Vala programming language \citep{Vala} compiles to GObject-based C, and so adds the burden of learning a separate language syntax to the aforementioned demerits of GObject as a modernization path for existing C code-bases. Java \citep{Java8} has had generic types and variadic functions since Java~5; Java's generic types are type-checked at compilation and type-erased at runtime, similar to \CFA's, though in Java each object carries its own table of method pointers, while \CFA passes the method pointers separately so as to maintain a C-compatible struct layout. Java variadic functions are simply syntactic sugar for an array of a single type, and therefore less useful than \CFA's heterogeneously-typed variadic functions. Java is also a garbage-collected, object-oriented language, with the associated resource usage and C-interoperability burdens.
968
969D \citep{D}, Go \citep{Go}, and Rust \citep{Rust} are modern, compiled languages with abstraction features similar to \CFA traits, \emph{interfaces} in D and Go and \emph{traits} in Rust. However, each language represents dramatic departures from C in terms of language model, and none has the same level of compatibility with C as \CFA. D and Go are garbage-collected languages, imposing the associated runtime overhead. The necessity of accounting for data transfer between the managed Go runtime and the unmanaged C runtime complicates foreign-function interface between Go and C. Furthermore, 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. D restricts garbage collection to its own heap by default, while Rust is not garbage-collected, and thus has a lighter-weight runtime that is more easily interoperable with C. Rust also possesses much more powerful abstraction capabilities for writing generic code than Go. On the other hand, Rust's borrow-checker, while it does provide strong safety guarantees, is complex and difficult to learn, and imposes a distinctly idiomatic programming style on Rust. \CFA, with its more modest safety features, is significantly easier to port C code to, while maintaining the idiomatic style of the original source.
970
971
972\subsection{Tuples/Variadics}
973
974Many programming languages have some form of tuple construct and/or variadic functions, \eg SETL, C, KW-C, \CC, D, Go, Java, ML, and Scala.
975SETL~\cite{SETL} is a high-level mathematical programming language, with tuples being one of the primary data types.
976Tuples in SETL allow subscripting, dynamic expansion, and multiple assignment.
977KW-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.
978The main contributions of that work were adding MRVF, tuple mass and multiple assignment, and record-field access.
979\CCeleven introduced @std::tuple@ as a library variadic template structure.
980Tuples are a generalization of @std::pair@, in that they allow for arbitrary length, fixed-size aggregation of heterogeneous values.
981Operations include @std::get<N>@ to extract vales, @std::tie@ to create a tuple of references used for assignment, and lexicographic comparisons.
982\CCseventeen proposes \emph{structured bindings}~\cite{Sutter15} to eliminate pre-declaring variables and use of @std::tie@ for binding the results.
983This 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.
984Furthermore, structured bindings are not a full replacement for @std::tie@, as it always declares new variables.
985Like \CC, D provides tuples through a library variadic-template structure.
986Go does not have tuple but supports MRVF.
987Java's variadic functions appears similar to C's but type-safe using arrays.
988Tuples are a fundamental abstraction in most functional programming languages, such as Standard ML~\cite{sml} and Scala~\cite{Scala}, which decompose tuples using pattern matching.
989
990
991\section{Conclusion \& Future Work}
992
993There is ongoing work on a wide range of \CFA feature extensions, including reference types, exceptions, and concurrent programming primitives. In addition to this work, there are some interesting future directions the polymorphism design could take. Notably, \CC template functions trade compile time and code bloat for optimal runtime of individual instantiations of polymorphic functions. \CFA polymorphic functions, by contrast, use an approach that is essentially dynamic virtual dispatch. The runtime overhead of this approach is low, but not as low as \CC template functions, and it may be beneficial to provide a mechanism for particularly performance-sensitive code to close this gap. Further research is needed, but two promising approaches are to allow an annotation on polymorphic function call sites that tells the translator to create a template-specialization of the function (provided the code is visible in the current translation unit) or placing an annotation on polymorphic function definitions that instantiates a version of the polymorphic function specialized to some set of types. These approaches are not mutually exclusive, and would allow these performance optimizations to be applied only where most useful to increase performance, without suffering the code bloat or loss of generality of a template expansion approach where it is unnecessary.
994
995In conclusion, the authors' design for generic types and tuples, unlike those available in existing work, is both reusable and type-checked, while still supporting a full range of C features, including separately-compiled modules. We have experimentally validated the performance of our design against both \CC and standard C, showing it is \TODO{shiny, cap'n}.
996
997\begin{acks}
998The authors would like to thank Magnus Madsen for valuable editorial feedback.
999
1000This work is supported in part by a corporate partnership with \grantsponsor{Huawei}{Huawei Ltd.}{http://www.huawei.com}\ and 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.
1001\end{acks}
1002
1003\bibliographystyle{ACM-Reference-Format}
1004\bibliography{cfa}
1005
1006\end{document}
1007
1008% Local Variables: %
1009% tab-width: 4 %
1010% compile-command: "make" %
1011% End: %
Note: See TracBrowser for help on using the repository browser.