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