# source:doc/generic_types/generic_types.tex@4cfcf41

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 4cfcf41 was 7a026ff, 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: 74.7 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
9\makeatletter
10% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
11% use rather than use \parident directly.
12\newlength{\parindentlnth}
13\setlength{\parindentlnth}{\parindent}
14
15\newlength{\gcolumnposn}                                % temporary hack because lstlisting does handle tabs correctly
16\newlength{\columnposn}
17\setlength{\gcolumnposn}{2.75in}
18\setlength{\columnposn}{\gcolumnposn}
20\newcommand{\CRT}{\global\columnposn=\gcolumnposn}
21\makeatother
22
23% Useful macros
24\newcommand{\CFA}{C$\mathbf\forall$\xspace} % Cforall symbolic name
25\newcommand{\CC}{\rm C\kern-.1em\hbox{+\kern-.25em+}\xspace} % C++ symbolic name
26\newcommand{\CCeleven}{\rm C\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name
27\newcommand{\CCfourteen}{\rm C\kern-.1em\hbox{+\kern-.25em+}14\xspace} % C++14 symbolic name
28\newcommand{\CCseventeen}{\rm C\kern-.1em\hbox{+\kern-.25em+}17\xspace} % C++17 symbolic name
29\newcommand{\CCtwenty}{\rm C\kern-.1em\hbox{+\kern-.25em+}20\xspace} % C++20 symbolic name
30\newcommand{\CS}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace}
31\newcommand{\Textbf}[1]{{\color{red}\textbf{#1}}}
32
33\newcommand{\TODO}[1]{\textbf{TODO}: {\itshape #1}} % TODO included
34%\newcommand{\TODO}[1]{} % TODO elided
35\newcommand{\eg}{\textit{e}.\textit{g}.,\xspace}
36\newcommand{\ie}{\textit{i}.\textit{e}.,\xspace}
37\newcommand{\etc}{\textit{etc}.,\xspace}
38
39% CFA programming language, based on ANSI C (with some gcc additions)
40\lstdefinelanguage{CFA}[ANSI]{C}{
41        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
42                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
43                fallthrough,fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,one_t,otype,restrict,_Static_assert,
45}%
46
47\lstset{
48language=CFA,
49columns=fullflexible,
50basicstyle=\linespread{0.9}\sf,                                                 % reduce line spacing and use sanserif font
51stringstyle=\tt,                                                                                % use typewriter font
52tabsize=4,                                                                                              % 4 space tabbing
53xleftmargin=\parindent,                                                                 % indent code to paragraph indentation
54%mathescape=true,                                                                               % LaTeX math escape in CFA code $...$
55escapechar=\$, % LaTeX escape in CFA code 56keepspaces=true, % 57showstringspaces=false, % do not show spaces with cup 58showlines=true, % show blank lines at end of code 59aboveskip=4pt, % spacing above/below code block 60belowskip=3pt, 61% replace/adjust listing characters that look bad in sanserif 62literate={-}{\raisebox{-0.15ex}{\texttt{-}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1 63 {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {_}{\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}1 % {}{\ttfamily\upshape\hspace*{-0.1ex}}1 64 {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2, 65moredelim=**[is][\color{red}]{}{}, 66}% lstset 67 68% inline code @...@ 69\lstMakeShortInline@ 70 71% ACM Information 72\citestyle{acmauthoryear} 73 74\acmJournal{PACMPL} 75 76\title{Generic and Tuple Types with Efficient Dynamic Layout in \CFA} 77 78\author{Aaron Moss} 79\email{a3moss@uwaterloo.ca} 80\author{Robert Schluntz} 81\email{rschlunt@uwaterloo.ca} 82\author{Peter Buhr} 83\email{pabuhr@uwaterloo.ca} 84\affiliation{% 85 \institution{University of Waterloo} 86 \department{David R. Cheriton School of Computer Science} 87 \streetaddress{Davis Centre, University of Waterloo} 88 \city{Waterloo} 89 \state{ON} 90 \postcode{N2L 3G1} 91 \country{Canada} 92} 93 94\terms{generic, tuple, variadic, types} 95\keywords{generic types, tuple types, variadic types, polymorphic functions, C, Cforall} 96 97\begin{CCSXML} 98<ccs2012> 99<concept> 100<concept_id>10011007.10011006.10011008.10011024.10011025</concept_id> 101<concept_desc>Software and its engineering~Polymorphism</concept_desc> 102<concept_significance>500</concept_significance> 103</concept> 104<concept> 105<concept_id>10011007.10011006.10011008.10011024.10011028</concept_id> 106<concept_desc>Software and its engineering~Data types and structures</concept_desc> 107<concept_significance>500</concept_significance> 108</concept> 109<concept> 110<concept_id>10011007.10011006.10011041.10011047</concept_id> 111<concept_desc>Software and its engineering~Source code generation</concept_desc> 112<concept_significance>300</concept_significance> 113</concept> 114</ccs2012> 115\end{CCSXML} 116 117\ccsdesc[500]{Software and its engineering~Polymorphism} 118\ccsdesc[500]{Software and its engineering~Data types and structures} 119\ccsdesc[300]{Software and its engineering~Source code generation} 120 121\begin{abstract} 122The 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. 123\end{abstract} 124 125\begin{document} 126\maketitle 127 128 129\section{Introduction and Background} 130 131The 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. 132The \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: 133\lstDeleteShortInline@ 134\begin{center} 135\setlength{\tabcolsep}{10pt} 136\begin{tabular}{@{}r|c|c|c|c|c|c|c@{}} 137 & 2017 & 2012 & 2007 & 2002 & 1997 & 1992 & 1987 \\ 138\hline 139Java & 1 & 1 & 1 & 3 & 13 & - & - \\ 140\hline 141\Textbf{C} & \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{1}& \Textbf{1}& \Textbf{1}& \Textbf{1} \\ 142\hline 143\CC & 3 & 3 & 3 & 3 & 2 & 2 & 4 \\ 144\end{tabular} 145\end{center} 146\lstMakeShortInline@ 147Love it or hate it, C is extremely popular, highly used, and one of the few system's languages. 148In many cases, \CC is often used solely as a better C. 149Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive. 150 151\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: 152(1) The behaviour of standard C code must remain the same when translated by a \CFA compiler as when translated by a C compiler; 153(2) Standard C code must be as fast and as small when translated by a \CFA compiler as when translated by a C compiler; 154(3) \CFA code must be at least as portable as standard C code; 155(4) Extensions introduced by \CFA must be translated in the most efficient way possible. 156These 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. In its current implementation, \CFA is compiled by translating it 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. 157 158This 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. 159 160 161\subsection{Polymorphic Functions} 162\label{sec:poly-fns} 163 164\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): 165\begin{lstlisting} 166forall( otype T ) T identity( T val ) { return val; } 167int forty_two = identity( 42 );$\C{// T is bound to int, forty\_two == 42}168\end{lstlisting} 169The @identity@ function above can be applied to any complete 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 @dtype T@, where @dtype@ is short for data type''. 170 171Here, the runtime cost of polymorphism is spread over each polymorphic call, due to passing more arguments to polymorphic functions; preliminary experiments have shown this overhead is similar to \CC virtual function calls. An advantage of this design is that, unlike \CC template functions, \CFA @forall@ functions are compatible with C \emph{separate} compilation. 172 173Since 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: 174\begin{lstlisting} 175forall( otype T | { T ?+?(T, T); } ) T twice( T x ) { return x + x; }\C{// ? denotes operands}$176int val = twice( twice( 3.7 ) ); 177\end{lstlisting} 178which 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 in its type analysis. The first approach has a late conversion from @int@ to @double@ 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. 179 180Monomorphic specializations of polymorphic functions can satisfy polymorphic type-assertions. 181% \begin{lstlisting} 182% forall(otype T | { T twice(T); })$\C{// type assertion}$183% T four_times(T x) { return twice( twice(x) ); } 184% double twice(double d) { return d * 2.0; }$\C{// (1)}$185% double magic = four_times(10.5);$\C{// T bound to double, uses (1) to satisfy type assertion}$186% \end{lstlisting} 187\begin{lstlisting} 188forall( otype T | { int ?<?( T, T ); } ) void qsort( const T * arr, size_t size ); 189forall( otype T | { int ?<?( T, T ); } ) T * bsearch( T key, const T * arr, size_t size ); 190double vals[10] = { /* 10 floating-point values */ }; 191qsort( vals, 10 );$\C{// sort array}$192double * val = bsearch( 5.0, vals, 10 );$\C{// binary search sorted array for key}$193\end{lstlisting} 194@qsort@ and @bsearch@ work for any type @T@ with a matching @<@ operator, and the built-in monomorphic specialization of @<@ for type @double@ is passed as an implicit parameter to the calls of @qsort@ and @bsearch@. 195 196Crucial to the design of a new programming language are the libraries to access thousands of external features. 197\CFA inherits a massive compatible library-base, where other programming languages have to rewrite or provide fragile inter-language communication with C. 198A simple example is leveraging the existing type-unsafe (@void *@) C @bsearch@, shown here searching a floating-point array: 199\begin{lstlisting} 200void * bsearch( const void * key, const void * base, size_t nmemb, size_t size, 201 int (* compar)(const void *, const void *)); 202int comp( const void * t1, const void * t2 ) { return *(double *)t1 < *(double *)t2 ? -1 : 203 *(double *)t2 < *(double *)t1 ? 1 : 0; } 204double key = 5.0; 205double * val = (double *)bsearch( &key, vals, size, sizeof(vals[0]), comp ); 206\end{lstlisting} 207which can be augmented simply with a generalized, type-safe, \CFA-overloaded wrapper: 208\begin{lstlisting} 209forall( otype T | { int ?<?( T, T ); } ) T * bsearch( T key, const T * arr, size_t size ) { 210 int comp( const void * t1, const void * t2 ) { /* as above with double changed to T */ } 211 return (T *)bsearch( &key, arr, size, sizeof(T), comp ); 212} 213forall( otype T | { int ?<?( T, T ); } ) unsigned int bsearch( T key, const T * arr, size_t size ) { 214 T *result = bsearch( key, arr, size );$\C{// call first version}$215 return result ? result - arr : size;$\C{// pointer subtraction includes sizeof(T)}$216} 217double * val = bsearch( 5.0, vals, 10 );$\C{// selection based on return type}$218int posn = bsearch( 5.0, vals, 10 ); 219\end{lstlisting} 220The nested routine @comp@ provides the hidden interface from typed \CFA to untyped (@void *@) C, plus the cast of the result. 221As well, an alternate kind of return is made available: position versus pointer to found element. 222\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@. 223 224Call-site inferencing and nested functions provide a localized form of inheritance. For example, @qsort@ only sorts in ascending order using @<@. However, it is trivial to locally change this behaviour: 225\begin{lstlisting} 226{ 227 int ?<?( double x, double y ) { return x > y; }$\C{// override behaviour}$228 qsort( vals, size );$\C{// descending sort}$229} 230\end{lstlisting} 231Within the block, the nested version of @<@ performs @>@ and this local version overrides the built-in @<@ so it is passed to @qsort@. 232Hence, programmers can easily form a local environments, adding and modifying appropriate functions, to maximize reuse of other existing functions and types. 233 234Finally, \CFA allows variable overloading: 235\lstDeleteShortInline@ 236\par\smallskip 237\begin{tabular}{@{}l@{\hspace{\parindent}}|@{\hspace{\parindent}}l@{}} 238\begin{lstlisting} 239short int MAX = ...; 240int MAX = ...; 241double MAX = ...; 242\end{lstlisting} 243& 244\begin{lstlisting} 245short int s = MAX; // select correct MAX 246int i = MAX; 247double d = MAX; 248\end{lstlisting} 249\end{tabular} 250\lstMakeShortInline@ 251\smallskip\par\noindent 252Hence, the single name @MAX@ replaces all the C type-specific names: @SHRT_MAX@, @INT_MAX@, @DBL_MAX@. 253 254 255\subsection{Traits} 256 257\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: 258\begin{lstlisting} 259trait summable( otype T ) { 260 void ?{}( T *, zero_t );$\C{// constructor from 0 literal}$261 T ?+?( T, T );$\C{// assortment of additions}$262 T ?+=?( T *, T ); 263 T ++?( T * ); 264 T ?++( T * ); 265}; 266forall( otype T | summable( T ) ) T sum( T a[$\,$], size_t size ) { // use trait 267 T total = { 0 };$\C{// instantiate T from 0 by calling its constructor}$268 for ( unsigned int i = 0; i < size; i += 1 ) 269 total += a[i];$\C{// select appropriate +}270 return total; 271} 272\end{lstlisting} 273 274In fact, the set of operators is incomplete, \eg no assignment, but @otype@ is syntactic sugar for the following implicit trait: 275\begin{lstlisting} 276trait otype( dtype T | sized(T) ) { // sized is a pseudo-trait for types with known size and alignment 277 void ?{}( T * );\C{// default constructor}$278 void ?{}( T *, T );$\C{// copy constructor}$279 void ?=?( T *, T );$\C{// assignment operator}$280 void ^?{}( T * );$\C{// destructor}281}; 282\end{lstlisting} 283Given 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. 284% 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}: 285% \begin{lstlisting} 286% void abs( size_t _sizeof_M, size_t _alignof_M, 287% void (*_ctor_M)(void*), void (*_copy_M)(void*, void*), 288% void (*_assign_M)(void*, void*), void (*_dtor_M)(void*), 289% _Bool (*_lt_M)(void*, void*), void (*_neg_M)(void*, void*), 290% void (*_ctor_M_zero)(void*, int), 291% void* m, void* _rtn ) {\C{// polymorphic parameter and return passed as void*}$292%$\C{// M zero = { 0 };}$293% void* zero = alloca(_sizeof_M);$\C{// stack allocate zero temporary}$294% _ctor_M_zero(zero, 0);$\C{// initialize using zero\_t constructor}$295%$\C{// return m < zero ? -m : m;}$296% void *_tmp = alloca(_sizeof_M); 297% _copy_M( _rtn,$\C{// copy-initialize return value}$298% _lt_M( m, zero ) ?$\C{// check condition}$299% (_neg_M(m, _tmp), _tmp) :$\C{// negate m}$300% m); 301% _dtor_M(_tmp); _dtor_M(zero);$\C{// destroy temporaries}$302% } 303% \end{lstlisting} 304 305Traits may be used for many of the same purposes as interfaces in Java or abstract base classes in \CC. Unlike Java interfaces or \CC base classes, \CFA types do not explicitly state any inheritance relationship to traits they satisfy, which is a form of structural inheritance, similar to the implementation of an interface in Go~\citep{Go}, as opposed to the nominal inheritance model of Java and \CC. 306 307Nominal inheritance can be simulated with traits using marker variables or functions: 308\begin{lstlisting} 309trait nominal(otype T) { 310 T is_nominal; 311}; 312int is_nominal;$\C{// int now satisfies the nominal trait}$313\end{lstlisting} 314 315Traits, 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: 316\begin{lstlisting} 317trait pointer_like(otype Ptr, otype El) { 318 lvalue El *?(Ptr);$\C{// Ptr can be dereferenced into a modifiable value of type El}$319} 320struct list { 321 int value; 322 list *next;$\C{// may omit "struct" on type names as in \CC}323}; 324typedef list *list_iterator; 325 326lvalue int *?( list_iterator it ) { return it->value; } 327\end{lstlisting} 328 329In 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@). 330While 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. 331 332\section{Generic Types} 333 334One 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. A second approach is to use @void*@-based polymorphism. This approach is taken by the C standard library functions @qsort@ and @bsearch@, 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 requires a number of extra function parameters, and also adds pointer indirection and dynamic allocation to algorithms and data structures that would not otherwise require them. A third approach to generic code is to use pre-processor macros to generate it -- this approach does allow the generated code to be both generic and type-checked, though any errors produced may be difficult to interpret. Furthermore, writing and invoking C code as preprocessor macros is unnatural and somewhat inflexible. 335 336Other C-like languages such as \CC and Java use \emph{generic types} to produce type-safe abstract data types. \CFA implements generic types with some care taken that the generic types design for \CFA integrates efficiently and naturally with the existing polymorphic functions in \CFA while retaining backwards compatibility with C; maintaining separate compilation is a particularly important constraint on the design. However, where the concrete parameters of the generic type are known, there is no extra overhead for the use of a generic type, as for \CC templates. 337 338A 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: 339\begin{lstlisting} 340forall(otype R, otype S) struct pair { 341 R first; 342 S second; 343}; 344 345forall(otype T) 346T value( pair(const char*, T) p ) { return p.second; } 347 348forall(dtype F, otype T) 349T value_p( pair(F*, T*) p ) { return *p.second; } 350 351pair(const char*, int) p = { "magic", 42 }; 352int magic = value( p ); 353 354pair(void*, int*) q = { 0, &p.second }; 355magic = value_p( q ); 356double d = 1.0; 357pair(double*, double*) r = { &d, &d }; 358d = value_p( r ); 359\end{lstlisting} 360 361\CFA classifies generic types as either \emph{concrete} or \emph{dynamic}. Concrete generic types have a fixed memory layout regardless of type parameters, while dynamic generic types vary in their in-memory layout depending on their type parameters. A type may have polymorphic parameters but still be concrete; in \CFA such types are called \emph{dtype-static}. Polymorphic pointers are an example of dtype-static types -- @forall(dtype T) T*@ is a polymorphic type, but for any @T@ chosen, @T*@ has exactly the same in-memory representation as a @void*@, and can therefore be represented by a @void*@ in code generation. 362 363\CFA generic types may also specify constraints on their argument type to be checked by the compiler. For example, consider the following declaration of a sorted set-type, which ensures that the set key supports equality and relational comparison: 364\begin{lstlisting} 365forall(otype Key | { _Bool ?==?(Key, Key); _Bool ?<?(Key, Key); }) 366 struct sorted_set; 367\end{lstlisting} 368 369\subsection{Concrete Generic Types} 370 371The \CFA translator instantiates concrete generic types by template-expanding them to fresh struct types; concrete generic types can therefore be used with zero runtime overhead. 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 struct 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 that can see that declaration may reuse. As an example of the expansion, the concrete instantiation for @pair(const char*, int)@ looks like this: 372\begin{lstlisting} 373struct _pair_conc1 { 374 const char* first; 375 int second; 376}; 377\end{lstlisting} 378 379A concrete generic type with dtype-static parameters is also expanded to a struct type, but this struct type is used for all matching instantiations. In the example above, the @pair(F*, T*)@ parameter to @value_p@ is such a type; its expansion looks something like this, and is used as the type of the variables @q@ and @r@ as well, with casts for member access where appropriate: 380\begin{lstlisting} 381struct _pair_conc0 { 382 void* first; 383 void* second; 384}; 385\end{lstlisting} 386 387\subsection{Dynamic Generic Types} 388 389Though \CFA implements concrete generic types efficiently, it also has a fully general system for computing with dynamic generic types. As 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. Dynamic generic structs also have implicit size and alignment parameters, and also an \emph{offset array} which contains the offsets of each member of the struct\footnote{Dynamic generic unions need no such offset array, as all members are at offset 0; the size and alignment parameters are still provided for dynamic unions, however.}. Access to members\footnote{The \lstinline@offsetof@ macro is implemented similarly.} of a dynamic generic struct is provided by adding the corresponding member of the offset array to the struct pointer at runtime, essentially moving a compile-time offset calculation to runtime where necessary. 390 391These offset arrays are statically generated where possible. If a dynamic generic type is declared to be passed or returned by value from a polymorphic function, the translator can safely assume that the generic type is complete (that is, has a known layout) at any call-site, and the offset array is passed from the caller; if 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. As 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 in to @value@ for @pair(const char*, T)@. The offset array @_offsetof_pair@ is generated at the call site as @size_t _offsetof_pair[] = { offsetof(_pair_conc1, first), offsetof(_pair_conc1, second) };@. 392 393In 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 struct and associated accessor and mutator routines in a header file, with the actual implementations in a separately-compiled \texttt{.c} file. \CFA supports this pattern for generic types, and in this instance the caller does not know the actual layout or size of the dynamic generic type, and only holds it by pointer. The \CFA translator automatically generates \emph{layout functions} for cases where the size, alignment, and offset array of a generic struct cannot be passed in to a function from that function's caller. These 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 struct (un-@sized@ parameters are forbidden from the language from being used in a context that affects layout). Results of these layout functions are cached so that they are only computed once per type per function.%, as in the example below for @pair@. 394% \begin{lstlisting} 395% static inline void _layoutof_pair(size_t* _szeof_pair, size_t* _alignof_pair, size_t* _offsetof_pair, 396% size_t _szeof_R, size_t _alignof_R, size_t _szeof_S, size_t _alignof_S) { 397% *_szeof_pair = 0; // default values 398% *_alignof_pair = 1; 399 400% // add offset, size, and alignment of first field 401% _offsetof_pair[0] = *_szeof_pair; 402% *_szeof_pair += _szeof_R; 403% if ( *_alignof_pair < _alignof_R ) *_alignof_pair = _alignof_R; 404 405% // padding, offset, size, and alignment of second field 406% if ( *_szeof_pair & (_alignof_S - 1) ) 407% *_szeof_pair += (_alignof_S - ( *_szeof_pair & (_alignof_S - 1) ) ); 408% _offsetof_pair[1] = *_szeof_pair; 409% *_szeof_pair += _szeof_S; 410% if ( *_alignof_pair < _alignof_S ) *_alignof_pair = _alignof_S; 411 412% // pad to struct alignment 413% if ( *_szeof_pair & (*_alignof_pair - 1) ) 414% *_szeof_pair += ( *_alignof_pair - ( *_szeof_pair & (*_alignof_pair - 1) ) ); 415% } 416% \end{lstlisting} 417 418Layout functions also allow generic types to be used in a function definition without reflecting them in the function signature. For 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. This function could acquire the layout for @set(T)@ by calling its layout function with the layout of @T@ implicitly passed into the function. 419 420Whether a type is concrete, dtype-static, or dynamic is decided based solely on the type parameters and @forall@ clause on the struct declaration. This design allows opaque forward declarations of generic types like @forall(otype T) struct Box;@ -- like in C, all uses of @Box(T)@ can be in a separately compiled translation unit, and callers from other translation units know the proper calling conventions to use. If the definition of a struct type was included in the decision of 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. 421 422\subsection{Applications} 423\label{sec:generic-apps} 424 425The reuse of dtype-static struct instantiations enables some 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*@, as in this example, which takes a @qsort@ or @bsearch@-compatible comparison routine and creates a similar lexicographic comparison for pairs of pointers: 426\begin{lstlisting} 427forall(dtype T) 428int lexcmp( pair(T*, T*)* a, pair(T*, T*)* b, int (*cmp)(T*, T*) ) { 429 int c = cmp(a->first, b->first); 430 if ( c == 0 ) c = cmp(a->second, b->second); 431 return c; 432} 433\end{lstlisting} 434Since @pair(T*, T*)@ is a concrete type, there are no added implicit parameters to @lexcmp@, so the code generated by \CFA is effectively identical to a version of this function written in standard C using @void*@, yet the \CFA version is type-checked to ensure that the fields of both pairs and the arguments to the comparison function match in type. 435 436Another useful pattern enabled by reused dtype-static type instantiations is zero-cost tag'' structs. Sometimes a particular bit of information is only useful for type-checking, and can be omitted at runtime. Tag structs can be used to provide this information to the compiler without further runtime overhead, as in the following example: 437\begin{lstlisting} 438forall(dtype Unit) struct scalar { unsigned long value; }; 439 440struct metres {}; 441struct litres {}; 442 443forall(dtype U) 444scalar(U) ?+?(scalar(U) a, scalar(U) b) { 445 return (scalar(U)){ a.value + b.value }; 446} 447 448scalar(metres) half_marathon = { 21093 }; 449scalar(litres) swimming_pool = { 2500000 }; 450 451scalar(metres) marathon = half_marathon + half_marathon; 452scalar(litres) two_pools = swimming_pool + swimming_pool; 453marathon + swimming_pool; // ERROR -- caught by compiler 454\end{lstlisting} 455@scalar@ is a dtype-static type, so all uses of it use a single struct definition, containing only a single @unsigned long@, and can share the same implementations of common routines like @?+?@ -- these implementations may even be separately compiled, unlike \CC template functions. However, the \CFA type-checker ensures that matching types are used by all calls to @?+?@, preventing nonsensical computations like adding the length of a marathon to the volume of an olympic pool. 456 457\section{Tuples} 458\label{sec:tuples} 459 460The @pair(R, S)@ generic type used as an example in the previous section can be considered a special case of a more general \emph{tuple} data structure. The authors have implemented tuples in \CFA, with a design particularly motivated by two use cases: \emph{multiple-return-value functions} and \emph{variadic functions}. 461 462In standard C, functions can return at most one value. This restriction results in code that emulates functions with multiple return values by \emph{aggregation} or by \emph{aliasing}. In the former situation, the function designer creates a record type that combines all of the return values into a single type. Unfortunately, the designer must come up with a name for the return type and for each of its fields. Unnecessary naming is a common programming language issue, introducing verbosity and a complication of the user's mental model. As such, this technique is effective when used sparingly, but can quickly get out of hand if many functions need to return different combinations of types. In the latter approach, the designer simulates multiple return values by passing the additional return values as pointer parameters. The pointer parameters are assigned inside of the routine body to emulate a return. Using this approach, the caller is directly responsible for allocating storage for the additional temporary return values. This responsibility complicates the call site with a sequence of variable declarations leading up to the call. Also, while a disciplined use of @const@ can give clues about whether a pointer parameter is going to be used as an out parameter, it is not immediately obvious from only the routine signature whether the callee expects such a parameter to be initialized before the call. Furthermore, while many C routines that accept pointers are designed so that it is safe to pass @NULL@ as a parameter, there are many C routines that are not null-safe. On a related note, C does not provide a standard mechanism to state that a parameter is going to be used as an additional return value, which makes the job of ensuring that a value is returned more difficult for the compiler. 463 464C does provide a mechanism for variadic functions through manipulation of @va_list@ objects, but it is notoriously type-unsafe. A variadic function is one that contains at least one parameter, followed by @...@ as the last token in the parameter list. In particular, some form of \emph{argument descriptor} is needed to inform the function of the number of arguments and their types, commonly a format string or counter parameter. It is important to note that both of these mechanisms are inherently redundant, because they require the user to specify information that the compiler knows explicitly. This required repetition is error prone, because it is easy for the user to add or remove arguments without updating the argument descriptor. In addition, C requires the programmer to hard code all of the possible expected types. As a result, it is cumbersome to write a variadic function that is open to extension. For example, consider a simple function that sumsN$@int@s: 465\begin{lstlisting} 466int sum(int N, ...) { 467 va_list args; 468 va_start(args, N); // must manually specify last non-variadic argument 469 int ret = 0; 470 while(N) { 471 ret += va_arg(args, int); // must specify type 472 N--; 473 } 474 va_end(args); 475 return ret; 476} 477 478sum(3, 10, 20, 30); // must keep initial counter argument in sync 479\end{lstlisting} 480 481The @va_list@ type is a special C data type that abstracts variadic argument manipulation. The @va_start@ macro initializes a @va_list@, given the last named parameter. Each use of the @va_arg@ macro allows access to the next variadic argument, given a type. Since the function signature does not provide any information on what types can be passed to a variadic function, the compiler does not perform any error checks on a variadic call. As such, it is possible to pass any value to the @sum@ function, including pointers, floating-point numbers, and structures. In the case where the provided type is not compatible with the argument's actual type after default argument promotions, or if too many arguments are accessed, the behaviour is undefined~\citep{C11}. Furthermore, there is no way to perform the necessary error checks in the @sum@ function at run-time, since type information is not carried into the function body. Since they rely on programmer convention rather than compile-time checks, variadic functions are inherently unsafe. 482 483In practice, compilers can provide warnings to help mitigate some of the problems. For example, GCC provides the @format@ attribute to specify that a function uses a format string, which allows the compiler to perform some checks related to the standard format specifiers. Unfortunately, this attribute does not permit extensions to the format string syntax, so a programmer cannot extend it to warn for mismatches with custom types. 484 485\subsection{Tuple Expressions} 486 487The tuple extensions in \CFA can express multiple return values and variadic function parameters in an efficient and type-safe manner. \CFA introduces \emph{tuple expressions} and \emph{tuple types}. A tuple expression is an expression producing a fixed-size, ordered list of values of heterogeneous types. The type of a tuple expression is the tuple of the subexpression types, or a \emph{tuple type}. In \CFA, a tuple expression is denoted by a comma-separated list of expressions enclosed in square brackets. For example, the expression @[5, 'x', 10.5]@ has type @[int, char, double]@. The previous expression has three \emph{components}. Each component in a tuple expression can be any \CFA expression, including another tuple expression. The order of evaluation of the components in a tuple expression is unspecified, to allow a compiler the greatest flexibility for program optimization. It is, however, guaranteed that each component of a tuple expression is evaluated for side-effects, even if the result is not used. Multiple-return-value functions can equivalently be called \emph{tuple-returning functions}. 488 489\CFA allows declaration of \emph{tuple variables}, variables of tuple type. For example: 490\begin{lstlisting} 491[int, char] most_frequent(const char*); 492 493const char* str = "hello, world!"; 494[int, char] freq = most_frequent(str); 495printf("%s -- %d %c\n", str, freq); 496\end{lstlisting} 497In this example, the type of the @freq@ and the return type of @most_frequent@ are both tuple types. Also of note is how the tuple expression @freq@ is implicitly flattened into separate @int@ and @char@ arguments to @printf@; this code snippet could have been shortened by replacing the last two lines with @printf("%s -- %d %c\n", str, most_frequent(str));@ using exactly the same mechanism. 498 499In addition to variables of tuple type, it is also possible to have pointers to tuples, and arrays of tuples. Tuple types can be composed of any types, except for array types, since arrays are not of fixed size, which makes tuple assignment difficult when a tuple contains an array. 500\begin{lstlisting} 501[double, int] di; 502[double, int] * pdi 503[double, int] adi[10]; 504\end{lstlisting} 505This example declares a variable of type @[double, int]@, a variable of type pointer to @[double, int]@, and an array of ten @[double, int]@. 506 507\subsection{Flattening and Restructuring} 508 509In function call contexts, tuples support implicit flattening and restructuring conversions. Tuple flattening recursively expands a tuple into the list of its basic components. Tuple structuring packages a list of expressions into a value of tuple type. 510\begin{lstlisting} 511int f(int, int); 512int g([int, int]); 513int h(int, [int, int]); 514[int, int] x; 515int y; 516 517f(x); // flatten 518g(y, 10); // structure 519h(x, y); // flatten & structure 520\end{lstlisting} 521In \CFA, each of these calls is valid. In the call to @f@, @x@ is implicitly flattened so that the components of @x@ are passed as the two arguments to @f@. For the call to @g@, the values @y@ and @10@ are structured into a single argument of type @[int, int]@ to match the type of the parameter of @g@. Finally, in the call to @h@, @y@ 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]@. The flexible structure of tuples permits a simple and expressive function call syntax to work seamlessly with both single- and multiple-return-value functions, and with any number of arguments of arbitrarily complex structure. 522 523% In {K-W C} \citep{Buhr94a,Till89}, a precursor to \CFA, there were 4 tuple coercions: opening, closing, flattening, and structuring. Opening coerces a tuple value into a tuple of values, while closing converts a tuple of values into a single tuple value. Flattening coerces a nested tuple into a flat tuple, \ie it takes a tuple with tuple components and expands it into a tuple with only non-tuple components. Structuring moves in the opposite direction, \ie it takes a flat tuple value and provides structure by introducing nested tuple components. 524 525In \CFA, the design has been simplified to require only the two conversions previously described, which trigger only in function call and return situations. Specifically, the expression resolution algorithm examines all of the possible alternatives for an expression to determine the best match. In resolving a function call expression, each combination of function value and list of argument alternatives is examined. Given a particular argument list and function value, the list of argument alternatives is flattened to produce a list of non-tuple valued expressions. Then the flattened list of expressions is compared with each value in the function's parameter list. If the parameter's type is not a tuple type, then the current argument value is unified with the parameter type, and on success the next argument and parameter are examined. If the parameter's type is a tuple type, then the structuring conversion takes effect, recursively applying the parameter matching algorithm using the tuple's component types as the parameter list types. Assuming a successful unification, eventually the algorithm gets to the end of the tuple type, which causes all of the matching expressions to be consumed and structured into a tuple expression. For example, in 526\begin{lstlisting} 527int f(int, [double, int]); 528f([5, 10.2], 4); 529\end{lstlisting} 530There is only a single definition of @f@, and 3 arguments with only single interpretations. First, the argument alternative list @[5, 10.2], 4@ is flattened to produce the argument list @5, 10.2, 4@. Next, the parameter matching algorithm begins, with$P =~$@int@ and$A =~$@int@, which unifies exactly. Moving to the next parameter and argument,$P =~$@[double, int]@ and$A =~$@double@. This time, the parameter is a tuple type, so the algorithm applies recursively with$P' =~$@double@ and$A =~$@double@, which unifies exactly. Then$P' =~$@int@ and$A =~$@double@, which again unifies exactly. At this point, the end of$P'$has been reached, so the arguments @10.2, 4@ are structured into the tuple expression @[10.2, 4]@. Finally, the end of the parameter list$P$has also been reached, so the final expression is @f(5, [10.2, 4])@. 531 532\subsection{Member Access} 533 534At times, it is desirable to access a single component of a tuple-valued expression without creating unnecessary temporary variables to assign to. Given a tuple-valued expression @e@ and a compile-time constant integer$i$where$0 \leq i < n$, where$n$is the number of components in @e@, @e.i@ accesses the$i$\textsuperscript{th} component of @e@. For example, 535\begin{lstlisting} 536[int, double] x; 537[char *, int] f(); 538void g(double, int); 539[int, double] * p; 540 541int y = x.0; // access int component of x 542y = f().1; // access int component of f 543p->0 = 5; // access int component of tuple pointed-to by p 544g(x.1, x.0); // rearrange x to pass to g 545double z = [x, f()].0.1; // access second component of first component of tuple expression 546\end{lstlisting} 547As seen above, tuple-index expressions can occur on any tuple-typed expression, including tuple-returning functions, square-bracketed tuple expressions, and other tuple-index expressions, provided the retrieved component is also a tuple. This feature was proposed for {K-W C}, but never implemented~\citep[p.~45]{Till89}. 548 549It is possible to access multiple fields from a single expression using a \emph{member-access tuple expression}. The result is a single tuple expression whose type is the tuple of the types of the members. For example, 550\begin{lstlisting} 551struct S { int x; double y; char * z; } s; 552s.[x, y, z]; 553\end{lstlisting} 554Here, the type of @s.[x, y, z]@ is @[int, double, char *]@. A member tuple expression has the form @a.[x, y, z];@ where @a@ is an expression with type @T@, where @T@ supports member access expressions, and @x, y, z@ are all members of @T@ with types @T$_x$@, @T$_y$@, and @T$_z$@ respectively. Then the type of @a.[x, y, z]@ is @[T$_x$, T$_y$, T$_z$]@. 555 556Since 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 components, drop components, duplicate components, etc.): 557\begin{lstlisting} 558[int, int, long, double] x; 559void f(double, long); 560 561f(x.[0, 3]); // f(x.0, x.3) 562x.[0, 1] = x.[1, 0]; // [x.0, x.1] = [x.1, x.0] 563[long, int, long] y = x.[2, 0, 2]; 564\end{lstlisting} 565 566It is possible for a member tuple expression to contain other member access expressions: 567\begin{lstlisting} 568struct A { double i; int j; }; 569struct B { int * k; short l; }; 570struct C { int x; A y; B z; } v; 571v.[x, y.[i, j], z.k]; 572\end{lstlisting} 573This expression is equivalent to @[v.x, [v.y.i, v.y.j], v.z.k]@. That is, the aggregate expression is effectively distributed across the tuple, which allows simple and easy access to multiple components in an aggregate, without repetition. It is guaranteed that the aggregate expression to the left of the @.@ in a member tuple expression is evaluated exactly once. As such, it is safe to use member tuple expressions on the result of a side-effecting function. 574 575\subsection{Tuple Assignment} 576 577In addition to tuple-index expressions, individual components of tuples can be accessed by a \emph{destructuring assignment} which has a tuple expression with lvalue components on its left-hand side. More generally, an assignment where the left-hand side of the assignment operator has a tuple type is called \emph{tuple assignment}. There are two kinds of tuple assignment depending on whether the right-hand side of the assignment operator has a tuple type or a non-tuple type, called \emph{multiple assignment} and \emph{mass assignment}, respectively. 578\begin{lstlisting} 579int x; 580double y; 581[int, double] z; 582[y, x] = 3.14; // mass assignment 583[x, y] = z; // multiple assignment 584z = 10; // mass assignment 585z = [x, y]; // multiple assignment 586\end{lstlisting} 587Let$L_i$for$i$in$[0, n)$represent each component of the flattened left-hand side,$R_i$represent each component of the flattened right-hand side of a multiple assignment, and$R$represent the right-hand side of a mass assignment. 588 589For a multiple assignment to be valid, both tuples must have the same number of elements when flattened. Multiple assignment assigns$R_i$to$L_i$for each$i$. 590That is, @?=?(&$L_i$,$R_i$)@ must be a well-typed expression. In the previous example, @[x, y] = z@, @z@ is flattened into @z.0, z.1@, and the assignments @x = z.0@ and @y = z.1@ are executed. 591 592A mass assignment assigns the value$R$to each$L_i$. For a mass assignment to be valid, @?=?(&$L_i$,$R$)@ must be a well-typed expression. This rule differs from C cascading assignment (\eg @a=b=c@) in that conversions are applied to$R$in each individual assignment, which prevents data loss from the chain of conversions that can happen during a cascading assignment. For example, @[y, x] = 3.14@ performs the assignments @y = 3.14@ and @x = 3.14@, which results in the value @3.14@ in @y@ and the value @3@ in @x@. On the other hand, the C cascading assignment @y = x = 3.14@ performs the assignments @x = 3.14@ and @y = x@, which results in the value @3@ in @x@, and as a result the value @3@ in @y@ as well. 593 594Both kinds of tuple assignment have parallel semantics, such that each value on the left side and right side is evaluated \emph{before} any assignments occur. As a result, it is possible to swap the values in two variables without explicitly creating any temporary variables or calling a function: 595\begin{lstlisting} 596int x = 10, y = 20; 597[x, y] = [y, x]; 598\end{lstlisting} 599After executing this code, @x@ has the value @20@ and @y@ has the value @10@. 600 601Tuple 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. This definition allows cascading tuple assignment and use of tuple assignment in other expression contexts, an occasionally useful idiom to keep code succinct and reduce repetition. 602% In \CFA, tuple assignment is an expression where the result type is the type of the left-hand side of the assignment, as in normal assignment. That is, a tuple assignment produces the value of the left-hand side after assignment. These semantics allow cascading tuple assignment to work out naturally in any context where a tuple is permitted. These semantics are a change from the original tuple design in {K-W C}~\citep{Till89}, wherein tuple assignment was a statement that allows cascading assignments as a special case. This decision was made in an attempt to fix what was seen as a problem with assignment, wherein it can be used in many different locations, such as in function-call argument position. While permitting assignment as an expression does introduce the potential for subtle complexities, it is impossible to remove assignment expressions from \CFA without affecting backwards compatibility with C. Furthermore, there are situations where permitting assignment as an expression improves readability by keeping code succinct and reducing repetition, and complicating the definition of tuple assignment puts a greater cognitive burden on the user. In another language, tuple assignment as a statement could be reasonable, but it would be inconsistent for tuple assignment to be the only kind of assignment in \CFA that is not an expression. 603 604\subsection{Casting} 605 606In 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: 607\begin{lstlisting} 608int f(); // (1) 609double f(); // (2) 610 611f(); // ambiguous - (1),(2) both equally viable 612(int)f(); // choose (2) 613\end{lstlisting} 614 615Since 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: 616\begin{lstlisting} 617int f(); 618void g(); 619 620(void)f(); // (1) 621(int)g(); // (2) 622\end{lstlisting} 623In 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. 624 625Formally, 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. 626 627For example, in 628\begin{lstlisting} 629 [int, int, int] f(); 630 [int, [int, int], int] g(); 631 632 ([int, double])f();$\C{// (1)}$633 ([int, int, int])g();$\C{// (2)}$634 ([void, [int, int]])g();$\C{// (3)}$635 ([int, int, int, int])g();$\C{// (4)}$636 ([int, [int, int, int]])g();$\C{// (5)}$637\end{lstlisting} 638 639(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)]@. 640Since @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)]@). 641 642Note 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]@. 643 644\subsection{Polymorphism} 645 646Tuples also integrate with \CFA polymorphism as a special sort of generic type. Due to the implicit flattening and structuring conversions involved in argument passing, @otype@ and @dtype@ parameters are restricted to matching only with non-tuple types. 647\begin{lstlisting} 648forall(otype T, dtype U) 649void f(T x, U * y); 650 651f([5, "hello"]); 652\end{lstlisting} 653In this example, @[5, "hello"]@ is flattened, so that the argument list appears as @5, "hello"@. The argument matching algorithm binds @T@ to @int@ and @U@ to @const char*@, and calls the function as normal. 654 655Tuples, however, may contain polymorphic components. For example, a plus operator can be written to add two triples of a type together. 656\begin{lstlisting} 657forall(otype T | { T ?+?(T, T); }) 658[T, T, T] ?+?([T, T, T] x, [T, T, T] y) { 659 return [x.0+y.0, x.1+y.1, x.2+y.2]; 660} 661[int, int, int] x; 662int i1, i2, i3; 663[i1, i2, i3] = x + ([10, 20, 30]); 664\end{lstlisting} 665 666Flattening and restructuring conversions are also applied to tuple types in polymorphic type assertions. Previously in \CFA, it has been assumed that assertion arguments must match the parameter type exactly, modulo polymorphic specialization (\ie no implicit conversions are applied to assertion arguments). In the example below: 667\begin{lstlisting} 668int f([int, double], double); 669forall(otype T, otype U | { T f(T, U, U); }) 670void g(T, U); 671g(5, 10.21); 672\end{lstlisting} 673If assertion arguments must match exactly, then the call to @g@ cannot be resolved, since the expected type of @f@ is flat, while the only @f@ in scope requires a tuple type. Since tuples are fluid, this requirement reduces the usability of tuples in polymorphic code. To ease this pain point, function parameter and return lists are flattened for the purposes of type unification, which allows the previous example to pass expression resolution. 674 675This relaxation is made possible by extending the existing thunk generation scheme, as described by \citet{Bilson03}. Now, whenever 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: 676\begin{lstlisting} 677int _thunk(int _p0, double _p1, double _p2) { 678 return f([_p0, _p1], _p2); 679} 680\end{lstlisting} 681Essentially, this thunk provides flattening and structuring conversions to inferred functions, improving the compatibility of tuples and polymorphism. These thunks take advantage of GCC C nested functions to produce closures that have the usual function pointer signature. 682 683\subsection{Variadic Tuples} 684 685To define variadic functions, \CFA adds a new kind of type parameter, @ttype@. Matching against a @ttype@ (`tuple type'') parameter consumes all remaining argument components and packages them into a tuple, binding to the resulting tuple of types. In a given parameter list, there should be at most one @ttype@ parameter that must occur last, otherwise the call can never resolve, given the previous rule. This idea essentially matches normal variadic semantics, with a strong feeling of similarity to \CCeleven variadic templates. As such, @ttype@ variables are also referred to as \emph{argument} or \emph{parameter packs} in this paper. 686 687Like variadic templates, the main way to manipulate @ttype@ polymorphic functions is through recursion. Since nothing is known about a parameter pack by default, assertion parameters are key to doing anything meaningful. Unlike variadic templates, @ttype@ polymorphic functions can be separately compiled. 688 689For example, the C @sum@ function at the beginning of Section~\ref{sec:tuples} could be written using @ttype@ as: 690\begin{lstlisting} 691int sum(){ return 0; } // (0) 692forall(ttype Params | { int sum(Params); }) 693int sum(int x, Params rest) { // (1) 694 return x+sum(rest); 695} 696sum(10, 20, 30); 697\end{lstlisting} 698Since (0) does not accept any arguments, it is not a valid candidate function for the call @sum(10, 20, 30)@. 699In order to call (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]@. 700In order to finish the resolution of @sum@, an assertion parameter that matches @int sum(int, int)@ is required. 701Like in the previous iteration, (0) is not a valid candidate, so (1) is examined with @Params@ bound to @[int]@, requiring the assertion @int sum(int)@. 702Next, (0) fails, and to satisfy (1) @Params@ is bound to @[]@, requiring an assertion @int sum()@. 703Finally, (0) matches and (1) fails, which terminates the recursion. 704Effectively, 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))@. 705 706As a point of note, this version does not require any form of argument descriptor, since the \CFA type system keeps track of all of these details. It might be reasonable to take the @sum@ function a step further to enforce a minimum number of arguments: 707\begin{lstlisting} 708int sum(int x, int y){ 709 return x+y; 710} 711forall(ttype Params | { int sum(int, Params); }) 712int sum(int x, int y, Params rest) { 713 return sum(x+y, rest); 714} 715\end{lstlisting} 716 717One more iteration permits the summation of any summable type, as long as all arguments are the same type: 718\begin{lstlisting} 719trait summable(otype T) { 720 T ?+?(T, T); 721}; 722forall(otype R | summable(R)) 723R sum(R x, R y){ 724 return x+y; 725} 726forall(otype R, ttype Params 727 | summable(R) 728 | { R sum(R, Params); }) 729R sum(R x, R y, Params rest) { 730 return sum(x+y, rest); 731} 732\end{lstlisting} 733Unlike C, it is not necessary to hard code the expected type. This code is naturally open to extension, in that any user-defined type with a @?+?@ operator is automatically able to be used with the @sum@ function. That is to say, the programmer who writes @sum@ does not need full program knowledge of every possible data type, unlike what is necessary to write an equivalent function using the standard C mechanisms. Summing arbitrary heterogeneous lists is possible with similar code by adding the appropriate type variables and addition operators. 734 735It is also possible to write a type-safe variadic print routine which can replace @printf@: 736\begin{lstlisting} 737struct S { int x, y; }; 738forall(otype T, ttype Params | 739 { void print(T); void print(Params); }) 740void print(T arg, Params rest) { 741 print(arg); 742 print(rest); 743} 744void print(char * x) { printf("%s", x); } 745void print(int x) { printf("%d", x); } 746void print(S s) { print("{ ", s.x, ",", s.y, " }"); } 747 748print("s = ", (S){ 1, 2 }, "\n"); 749\end{lstlisting} 750This example routine showcases a variadic-template-like decomposition of the provided argument list. The individual @print@ routines allow printing a single element of a type. The polymorphic @print@ allows printing any list of types, as long as each individual type has a @print@ function. The individual print functions can be used to build up more complicated @print@ routines, such as for @S@, which is something that cannot be done with @printf@ in C. 751 752It is also possible to use @ttype@ polymorphism to provide arbitrary argument forwarding functions. For example, it is possible to write @new@ as a library function: 753\begin{lstlisting} 754struct Pair(otype R, otype S); 755forall(otype R, otype S) 756void ?{}(Pair(R, S) *, R, S); // (1) 757 758forall(dtype T, ttype Params | sized(T) | { void ?{}(T *, Params); }) 759T * new(Params p) { 760 return ((T*)malloc( sizeof(T) )){ p }; // construct into result of malloc 761} 762 763Pair(int, char) * x = new(42, '!'); 764\end{lstlisting} 765The @new@ function provides the combination of type-safe @malloc@ with a constructor call, so that it becomes impossible to forget to construct dynamically allocated objects. This function provides the type-safety of @new@ in \CC, without the need to specify the allocated type again, thanks to return-type inference. 766 767In 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)@. 768 769\TODO{Check if we actually can use ttype parameters on generic types (if they set the complete flag, it should work, or nearly so).} 770 771\subsection{Implementation} 772 773Tuples are implemented in the \CFA translator via a transformation into generic types. For each$N$, the first time an$N$-tuple is seen in a scope a generic type with$N\$ type parameters is generated. For example:
774\begin{lstlisting}
775[int, int] f() {
776  [double, double] x;
777  [int, double, int] y;
778}
779\end{lstlisting}
780Is transformed into:
781\begin{lstlisting}
782forall(dtype T0, dtype T1 | sized(T0) | sized(T1))
783struct _tuple2 {  // generated before the first 2-tuple
784  T0 field_0;
785  T1 field_1;
786};
787_tuple2(int, int) f() {
788  _tuple2(double, double) x;
789  forall(dtype T0, dtype T1, dtype T2 | sized(T0) | sized(T1) | sized(T2))
790  struct _tuple3 {  // generated before the first 3-tuple
791    T0 field_0;
792    T1 field_1;
793    T2 field_2;
794  };
795  _tuple3_(int, double, int) y;
796}
797\end{lstlisting}
798
799Tuple expressions are then simply converted directly into compound literals:
800\begin{lstlisting}
801[5, 'x', 1.24];
802\end{lstlisting}
803Becomes:
804\begin{lstlisting}
805(_tuple3(int, char, double)){ 5, 'x', 1.24 };
806\end{lstlisting}
807
808Since tuples are essentially structures, tuple indexing expressions are just field accesses:
809\begin{lstlisting}
810void f(int, [double, char]);
811[int, double] x;
812
813x.0+x.1;
814printf("%d %g\n", x);
815f(x, 'z');
816\end{lstlisting}
817Is transformed into:
818\begin{lstlisting}
819void f(int, _tuple2(double, char));
820_tuple2(int, double) x;
821
822x.field_0+x.field_1;
823printf("%d %g\n", x.field_0, x.field_1);
824f(x.field_0, (_tuple2){ x.field_1, 'z' });
825\end{lstlisting}
826Note 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.
827
828Expressions 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:
829\begin{lstlisting}
830void g(int, double);
831[int, double] h();
832g(h());
833\end{lstlisting}
834Internally, this expression is converted to two variables and an expression:
835\begin{lstlisting}
836void g(int, double);
837[int, double] h();
838
839_Bool _unq0_finished_ = 0;
840[int, double] _unq0;
841g(
842  (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).0,
843  (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).1,
844);
845\end{lstlisting}
846Since 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.
847
848Currently, 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.
849
850The 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.
851
852\section{Evaluation}
853
854\TODO{Magnus suggests we need some graphs, it's kind of a done thing that the reviewers will be looking for. Also, we've made some unsubstantiated claims about the runtime performance of \CFA, which some micro-benchmarks could help with. I'm thinking a simple stack push and pop, with an idiomatic \lstinline@void*@, \CFA, \CC template and \CC virtual inheritance versions (the void* and virtual inheritance versions likely need to be linked lists, or clumsy in their API -- possibly both versions) to test generics, and variadic print to test tuples. We measure SLOC, runtime performance, executable size (making sure to include benchmarks for multiple types in the executable), and possibly manually count the number of places where the programmer must provide un-type-checked type information. Appendices don't count against our page limit, so we might want to include the source code for the benchmarks (or at least the relevant implementation details) in one.}
855
856\section{Related Work}
857
858\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.
859
860Cyclone 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.
861
863
864D \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.
865
866\section{Conclusion \& Future Work}
867
868There 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.
869
870In 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}.
871
872\begin{acks}
873The authors would like to thank Magnus Madsen for valuable editorial feedback.
874
875This 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.
876\end{acks}
877
878\bibliographystyle{ACM-Reference-Format}
879\bibliography{cfa}
880
881\end{document}
882
883% Local Variables: %
884% tab-width: 4 %
885% compile-command: "make" %
886% End: %
Note: See TracBrowser for help on using the repository browser.