source: doc/theses/mike_brooks_MMath/array.tex@ eaee33e

Last change on this file since eaee33e was 1037b4c, checked in by Michael Brooks <mlbrooks@…>, 5 days ago

proof-read array chapter

  • Property mode set to 100644
File size: 101.1 KB
Line 
1\chapter{Array}
2\label{c:Array}
3
4Arrays in C are possibly the single most misunderstood and incorrectly used feature in the language \see{\VRef{s:Array}}, resulting in the largest proportion of runtime errors and security violations.
5This chapter describes the new \CFA language and library features that introduce a length-checked array type, @array@, to the \CFA standard library~\cite{Cforall}.
6
7Offering the @array@ type, as a distinct alternative to the C array, is consistent with \CFA's goal of backwards compatibility, \ie virtually all existing C (@gcc@) programs can be compiled by \CFA with only a small number of changes, similar to \CC (@g++@).
8However, a few compatibility-breaking changes to the behaviour of the C array are necessary, both as an implementation convenience and to fix C's lax treatment of arrays.
9Hence, the @array@ type is an opportunity to start from a clean slate and show a cohesive selection of features, making it unnecessary to deal with every inherited complexity of the C array.
10Future work is to sugar the @array@ syntax to look like C arrays \see{\VRef{f:FutureWork}}.
11
12
13\section{Introduction}
14\label{s:ArrayIntro}
15
16The new \CFA array is declared by instantiating the generic @array@ type, much like instantiating any other standard-library generic type (such as \CC @vector@), using a new style of generic parameter.
17\begin{cfa}
18@array( float, 99 )@ x; $\C[2.5in]{// x contains 99 floats}$
19\end{cfa}
20Here, the arguments to the @array@ type are @float@ (element type) and @99@ (dimension).
21When this type is used as a function parameter, the type system requires the argument to be a perfect match.
22\begin{cfa}
23void f( @array( float, 42 )@ & p ) {} $\C{// p accepts 42 floats}$
24f( x ); $\C{// statically rejected: type lengths are different, 99 != 42}$
25
26test2.cfa:3:1 error: Invalid application of existing declaration(s) in expression.
27Applying untyped: Name: f ... to: Name: x
28\end{cfa}
29Function @f@'s parameter expects an array with dimension 42, but the argument dimension 99 does not match.
30
31A function can be polymorphic over @array@ arguments using the \CFA @forall@ declaration prefix.
32\begin{cfa}
33forall( T, @[N]@ )
34void g( array( T, @N@ ) & p, int i ) {
35 T elem = p[i]; $\C{// dynamically checked: requires 0 <= i < N}$
36}
37g( x, 0 ); $\C{// T is float, N is 99, dynamic subscript check succeeds}$
38g( x, 1000 ); $\C{// T is float, N is 99, dynamic subscript check fails}$
39
40Cforall Runtime error: subscript 1000 exceeds dimension range [0,99) $for$ array 0x555555558020.
41\end{cfa}
42Function @g@ takes an arbitrary type parameter @T@ and an unsigned integer \emph{dimension} @N@.
43The dimension represents a to-be-determined number of elements, managed by the type system, where 0 represents an empty array.
44The type system implicitly infers @float@ for @T@ and @99@ for @N@.
45Furthermore, the runtime subscript @x[0]@ (parameter @i@ being @0@) in @g@ is valid because 0 is in the dimension range $[0,99)$ for argument @x@.
46The call @g( x, 1000 )@ is also accepted at compile time.
47However, the subscript, @x[1000]@, generates a runtime error, because @1000@ is outside the dimension range $[0,99)$ of argument @x@.
48In general, the @forall( ..., [N] )@ participates in the user-relevant declaration of the name @N@, which becomes usable in parameter/return declarations and within a function.
49The syntactic form is chosen to parallel other @forall@ forms:
50\begin{cfa}
51forall( @[N]@ ) ... $\C{// dimension}$
52forall( T ) ... $\C{// value datatype}$
53forall( T & ) ... $\C{// opaque datatype}$
54\end{cfa}
55% The notation @array(thing, N)@ is a single-dimensional case, giving a generic type instance.
56
57The generic @array@ type is comparable to the C array type, which \CFA inherits from C.
58Their runtime characteristics are often identical, and some features are available in both.
59For example, assume a caller has an argument that instantiates @N@ with 42.
60\begin{cfa}
61forall( [N] )
62void f( ... ) {
63 float x1[@N@]; $\C{// C array, no subscript checking}$
64 array(float, N) x2; $\C{// \CFA array, subscript checking}\CRT$
65}
66\end{cfa}
67Both of the variables, @x1@ and @x2@, name 42 contiguous, stack-allocated @float@ values.
68The two variables have identical size and layout, with no additional ``bookkeeping'' allocations or headers.
69The C array, @x1@, has no subscript checking, while \CFA array, @x2@, does.
70This explicit, generic approach requires a significant extension to the \CFA type system to support a full-feature, safe, efficient (space and time) array type, which forms the foundation for more complex array forms in \CFA.
71In all following discussion, ``C array'' means types like @x1@ and ``\CFA array'' means types like @x2@.
72
73A future goal is to provide the new @array@ features with syntax approaching C's (declaration style of @x1@).
74Then, the library @array@ type could be removed, giving \CFA a largely uniform array type.
75At present, new-array features are only partially supported through C-style syntax, so the generic @array@ is used exclusively in the thesis.
76
77My contributions in this chapter are:
78\begin{enumerate}[leftmargin=*]
79\item A type system enhancement that lets polymorphic functions and generic types be parameterized by a numeric value: @forall( [N] )@.
80\item Provide a dimension/subscript-checked array type in the \CFA standard library, where the array's length is statically managed and dynamically valued.
81\item Provide argument/parameter passing safety for arrays and subscript safety.
82\item Identify the interesting abilities available by the new @array@ type.
83\end{enumerate}
84
85
86\begin{comment}
87\section{Dependent Typing}
88
89General dependent typing allows a type system to encode arbitrary predicates, \eg behavioural specifications for functions, which is an anti-goal for my work.
90Firstly, this application is strongly associated with pure functional languages,
91where a characterization of the return value (giving it a precise type, generally dependent upon the parameters)
92is a sufficient postcondition.
93In an imperative language like C and \CFA, it is also necessary to discuss side effects, for which an even heavier formalism, like separation logic, is required.
94Secondly: ... bash Rust.
95... cite the crap out of these claims.
96\end{comment}
97
98
99\section{Features Added}
100
101This section shows more about using the \CFA array and dimension parameters, demonstrating syntax and semantics by way of motivating examples.
102As stated, the core capability of the new array is tracking all dimensions within the type system, where dynamic dimensions are represented using type variables.
103
104By declaring type variables at the front of object declarations, an array dimension is lexically referenceable where it is needed.
105For example, a declaration can share one length, @N@, among a pair of parameters and return type, meaning the input arrays and return array are the same length.
106\lstinput{10-17}{hello-array.cfa}
107Function @f@ does a pointwise comparison of its two input arrays, checking if each pair of numbers is within half a percent of each other, returning the answers in a newly allocated @bool@ array.
108The dynamic allocation of the @ret@ array uses the library @alloc@ function,
109\begin{cfa}
110forall( T & | sized(T) )
111T * alloc() {
112 return @(T *)@malloc( @sizeof(T)@ ); // C malloc
113}
114\end{cfa}
115which captures the parameterized dimension information implicitly within its @sizeof@ determination, and casts the return type.
116Note, @alloc@ only sees the whole type for its @T@, @array(bool, N)@, where this type's size is a computation based on @N@.
117This example illustrates how the new @array@ type plugs into existing \CFA behaviour by implementing necessary \emph{sized} assertions needed by other types.
118(\emph{sized} implies a concrete \vs abstract type with a runtime-available size, exposed as @sizeof@.)
119As a result, there is significant programming safety by making the size accessible and implicit, compared with C's @calloc@ and non-array supporting @memalign@, which take an explicit length parameter not managed by the type system.
120
121\begin{figure}
122\begin{cfa}
123forall( [N] ) array( bool, N ) & f( array( float, N ) &, array( float, N ) & );
124\end{cfa}
125\lstinput{30-43}{hello-array.cfa}
126\lstinput{45-48}{hello-array.cfa}
127\caption{Example of calling a dimension-generic function.}
128\label{f:fExample}
129\end{figure}
130
131\VRef[Figure]{f:fExample} shows an example using function @f@, illustrating how dynamic values are fed into the @array@ type.
132Here, the dimension of arrays @x@, @y@, and @result@ is specified from a command-line value, @dim@, and these arrays are allocated on the stack.
133Then the @x@ array is initialized with decreasing values, and the @y@ array with amounts offset by constant @0.005@, giving relative differences within tolerance initially and diverging for later values.
134The program main is run (see figure bottom) with inputs @5@ and @7@ for sequence lengths.
135The loops follow the familiar pattern of using the variable @dim@ to iterate through the arrays.
136Most importantly, the type system implicitly captures @dim@ at the call of @f@ and makes it available throughout @f@ as @N@.
137The example shows @dim@ adapting into a type-system managed length at the declarations of @x@, @y@, and @result@; @N@ adapting in the same way at @f@'s loop bound; and a pass-thru use of @dim@ at @f@'s declaration of @ret@.
138Except for the lifetime-management issue of @result@, \ie explicit @free@, this program has eliminated both the syntactic and semantic problems associated with C arrays and their usage.
139The result is a significant improvement in safety and usability.
140In summary:
141\begin{itemize}[leftmargin=*]
142\item
143@[N]@ within a @forall@ declares the type variable @N@ to be a managed length.
144\item
145@N@ can be used in an expression with type @size_t@ within the function body.
146\item
147The value of an @N@-expression is the acquired length, derived from the usage site, \ie generic declaration or function call.
148\begin{comment} % was not discussed yet
149\item
150@array( T, N0, N1, ... )@ is a multi-dimensional type wrapping $\prod_i N_i$ contiguous @T@-typed objects.
151\end{comment}
152\end{itemize}
153
154\VRef[Figure]{f:TemplateVsGenericType} shows @N@ is not the same as a @size_t@ declaration in a \CC \lstinline[language=C++]{template}. It illustrates these differences:
155\begin{enumerate}[leftmargin=*]
156\item
157The \CC template @N@ can only be a compile-time value, while the \CFA @N@ may be a runtime value.
158\item
159\CC does not allow a template function to be nested, while \CFA allows polymorphic functions be nested.
160Hence, \CC precludes a simple form of information hiding.
161\item
162\label{p:DimensionPassing}
163The \CC template @N@ must be passed explicitly at the call, unless @N@ has a default value, even when \CC can deduce the type of @T@.
164The \CFA @N@ is part of the array type and passed implicitly at the call.
165% fixed by comparing to std::array
166% mycode/arrr/thesis-examples/check-peter/cs-cpp.cpp, v2
167\begin{comment} % does not appear in the example; I think we've found CFA suffering a similar "belief"
168\item
169\CC cannot have an array of references, but can have an array of @const@ pointers.
170\CC has a (mistaken) belief that references are not objects, but pointers are objects.
171In the \CC example, the arrays fall back on C arrays, which have a duality with references with respect to automatic dereferencing.
172The \CFA array is a contiguous object with an address, which can be stored as a reference or pointer.
173\end{comment}
174% not really about forall-N vs template-N
175% any better CFA support is how Rob left references, not what Mike did to arrays
176% https://stackoverflow.com/questions/1164266/why-are-arrays-of-references-illegal
177% https://stackoverflow.com/questions/922360/why-cant-i-make-a-vector-of-references
178\item
179\label{p:ArrayCopy}
180C/\CC arrays cannot be copied, while \CFA arrays can be copied, making them a first-class object (although array copy is often avoided for efficiency).
181% fixed by comparing to std::array
182% mycode/arrr/thesis-examples/check-peter/cs-cpp.cpp, v10
183\end{enumerate}
184The \CC template @std::array@ tries to accomplish a similar mechanism to \CFA @array@.
185It is an aggregate type with the same semantics as a @struct@ holding a C-style array \see{\VRef{s:ArraysCouldbeValues}}, which mitigates points \VRef[]{p:DimensionPassing} and \VRef[]{p:ArrayCopy}.
186
187\begin{figure}
188\setlength{\tabcolsep}{3pt}
189\begin{tabular}{@{}ll@{}}
190\begin{c++}
191
192@template< typename T, size_t N >@
193void copy( T ret[@N@], T x[@N@] ) {
194 for ( int i = 0; i < N; i += 1 ) ret[i] = x[i];
195}
196void demo() {
197 const size_t n = 10;
198 int ret[n], x[n]; $\C[1.9in]{// static size}$
199 for ( int i = 0; i < n; i += 1 ) x[i] = i;
200 @copy<int, n >( ret, x );@
201 for ( int i = 0; i < n; i += 1 ) cout << ret[i] << ' ';
202 cout << endl;
203}
204int main() {
205 demo();
206}
207\end{c++}
208&
209\begin{cfa}
210int main() {
211 @forall( T, [N] )@ $\C{// nested function}$
212 void copy( array( T, @N@ ) & ret, array( T, @N@ ) & x ) {
213 for ( i; N ) ret[i] = x[i];
214 }
215 void demo( const size_t n ) {
216
217 array( int, n ) ret, x; $\C{// dynamic-fixed size}$
218 for ( i; n ) x[i] = i; $\C{// initialize}$
219 @copy( ret, x );@ $\C{// alternative ret = x}$
220 for ( i; n ) sout | ret[i] | nonl;
221 sout | nl;
222 }
223 size_t n; sin | n; $\C{// obtain size}\CRT$
224 demo( n );
225}
226\end{cfa}
227\end{tabular}
228\caption{\lstinline{N}-style parameters, for \CC template \vs \CFA generic type }
229\label{f:TemplateVsGenericType}
230\end{figure}
231
232Just as the first example in \VRef[Section]{s:ArrayIntro} shows a compile-time rejection of a length mismatch,
233so are length mismatches stopped when they involve dimension parameters.
234While \VRef[Figure]{f:fExample} shows successfully calling a function @f@ expecting two arrays of the same length,
235\begin{cfa}
236array( bool, N ) & f( array( float, N ) &, array( float, N ) & );
237\end{cfa}
238a static rejection occurs when attempting to call @f@ with arrays of differing lengths.
239\lstinput[tabsize=1]{70-74}{hello-array.cfa}
240When the argument lengths themselves are statically unknown,
241the static check is conservative and, as always, \CFA's casting lets the programmer use knowledge not shared with the type system.
242\lstinput{90-96}{hello-array.cfa}
243This static check's rules are presented in \VRef[Section]{s:ArrayTypingC}.
244
245Orthogonally, the \CFA array type works within generic \emph{types}, \ie @forall@-on-@struct@.
246The same argument safety and the associated implicit communication of array length occurs.
247Preexisting \CFA allowed aggregate types to be generalized with type parameters, enabling parameterizing of element types.
248This feature is extended to allow parameterizing by dimension.
249Doing so gives a refinement of C's ``flexible array member''~\cite[\S~6.7.2.1.18]{C11}:
250\begin{cfa}
251struct S {
252 ...
253 double d []; // incomplete array type => flexible array member
254} * s = malloc( sizeof( struct S ) + sizeof( double [10] ) );
255\end{cfa}
256which creates a VLA of size 10 @double@s at the end of the structure.
257A C flexible array member can only occur at the end of a structure;
258\CFA allows length-parameterized array members to be nested at arbitrary locations, with intervening member declarations.
259\lstinput{10-15}{hello-accordion.cfa}
260The structure has course- and student-level metadata (their respective field names) and a position-based preferences' matrix.
261The structure's layout is dynamic; the starting offset of @student_ids@ varies according to the generic parameter @C@; the offset of @preferences@ varies by both.
262
263\VRef[Figure]{f:checkExample} shows a program main using @School@ and results with different array sizes.
264The @school@ variable holds many students' course-preference forms.
265It is on the stack and its initialization does not use any casting or size arithmetic.
266Both of these points are impossible with a C flexible array member.
267When heap allocation is preferred, the original pattern still applies.
268\begin{cfa}
269School( classes, students ) * sp = alloc();
270\end{cfa}
271This ability to avoid casting and size arithmetic improves safety and usability over C flexible array members.
272The example program prints the courses in each student's preferred order, all using the looked-up display names.
273When a function operates on a @School@ structure, the type system handles its memory layout transparently.
274In the example, function @getPref@ returns, for the student at position @is@, what is the position of their @pref@\textsuperscript{th}-favoured class.
275Finally, inputs and outputs are given on the right for different sized schools.
276
277\begin{figure}
278\begin{lrbox}{\myboxA}
279\begin{tabular}{@{}l@{}}
280\lstinput{30-38}{hello-accordion.cfa} \\
281\lstinput{50-55}{hello-accordion.cfa} \\
282\lstinput{90-98}{hello-accordion.cfa}
283\end{tabular}
284\end{lrbox}
285
286\begin{lrbox}{\myboxB}
287\begin{tabular}{@{}l@{}}
288@$ cat school1@ \\
289\lstinputlisting{school1} \\
290@$ ./a.out < school1@ \\
291\lstinputlisting{school1.out} \\
292@$ cat school2@ \\
293\lstinputlisting{school2} \\
294@$ ./a.out < school2@ \\
295\lstinputlisting{school2.out}
296\end{tabular}
297\end{lrbox}
298
299\setlength{\tabcolsep}{10pt}
300\begin{tabular}{@{}ll@{}}
301\usebox\myboxA
302&
303\usebox\myboxB
304\end{tabular}
305
306\caption{\lstinline{School} Example, Input and Output}
307\label{f:checkExample}
308\end{figure}
309
310
311\section{Single Dimension Array Implementation}
312\label{s:1d-impl}
313
314The core of the preexisting \CFA compiler already has the ``heavy equipment'' needed to provide the feature set just reviewed.
315To apply this equipment in tracking array lengths, I encoded a dimension (array's length) as a type.
316The type in question does not describe any data that the program actually uses at runtime.
317It simply carries information through intermediate stages of \CFA-to-C lowering.
318And this type takes a form such that, once \emph{it} gets lowered, the result does the right thing.
319This new dimension type, encoding the array dimension within it, is the first limited \newterm{dependent type}~\cite{DependentType} added to the \CFA type-system and is used at appropriate points during type resolution.
320
321% Furthermore, the @array@ type itself is really ``icing on the cake.''
322% Presenting its full version is deferred until \VRef[Section]{s:ArrayMdImpl} (where added complexity needed for multiple dimensions is considered).
323Discussion of the new array implementation is broken into single- and multi-dimensional features.
324The multidimensional feature set of \VRef[Section]{s:ArrayMdImpl} is a toolkit for managing repeated application of the single-dimensional features.
325Details of the @array@ type are introduced as needed.
326The single-dimension discussions begins with a simple example stripped of the @array@ type.
327\begin{cfa}
328forall( [N] )
329struct array_1d_float {
330 float items[N]; $\C[2in]{// float elements }$
331};
332forall( T, [N] )
333struct array_1d {
334 T items[N]; $\C{// any-typed elements}\CRT$
335};
336\end{cfa}
337These two structure patterns, plus a subscript operator, is all that @array@ provides.
338My main work is letting a programmer define such a structure (one whose type is parameterized by @[N]@) and define functions that operate on it (these being parameterized similarly).
339
340The repurposed heavy equipment is
341\begin{itemize}[leftmargin=*]
342\item
343 The ``resolver'' compiler pass, which provides argument values for a declaration's type-system parameters, gathered from type information in scope at the usage site.
344\item
345 The ``box'' compiler pass, which encodes information about type parameters into ``extra'' regular parameters on declarations and and arguments on calls.
346 Notably, it conveys the size of a type @foo@ as a @__sizeof_foo@ parameter, and rewrites the @sizeof(foo)@ expression as @__sizeof_foo@, \ie a use of the parameter.
347\end{itemize}
348
349The rules for resolution had to be restricted slightly, in order to achieve important refusal cases.
350This work is detailed in \VRef[Section]{s:ArrayTypingC}.
351However, the resolution--boxing scheme, in its preexisting state, is equipped to work on (desugared) dimension parameters.
352The following discussion explains the desugaring and why its lowered code is correct.
353
354A simpler structure, and a toy function on it, demonstrate what is needed for the encoding.
355\begin{cfa}
356forall( [@N@] ) { $\C{// [1]}$
357 struct thing {};
358 void f( thing(@N@) ) { sout | @N@; } $\C{// [2], [3]}$
359}
360int main() {
361 thing( @10@ ) x; f( x ); $\C{// prints 10, [4]}$
362 thing( @100@ ) y; f( y ); $\C{// prints 100}$
363}
364\end{cfa}
365This example has:
366\begin{enumerate}[leftmargin=*]
367\item
368 The symbol @N@ being declared as a type variable (a variable of the type system).
369\item
370 The symbol @N@ being used to parameterize a type.
371\item
372 The symbol @N@ being used as an expression (value).
373\item
374 A value like 10 being used as an argument to the parameter @N@.
375\end{enumerate}
376The chosen solution is to encode the value @N@ \emph{as a type}, so items 1 and 2 are immediately available for free.
377Item 3 needs a way to recover the encoded value from a (valid) type and to reject invalid types.
378Item 4 needs a way to produce a type that encodes the given value.
379
380Because the box pass handles a type's size as its main datum, the encoding is chosen to use it.
381The production and recovery are then straightforward.
382\begin{itemize}[leftmargin=*]
383\item
384 The value $n$ is encoded as a type whose size is $n$.
385\item
386 Given a dimension expression $e$, produce an internal type @char[@$e$@]@ to represent it.
387 If $e$ evaluates to $n$ then the encoded type has size $n$.
388\item
389 Given a type $T$ (produced by these rules), recover the value that it represents with the expression @sizeof(@$T$@)@.
390 If $T$ has size $n$ then the recovery expression evaluates to $n$.
391\end{itemize}
392
393This desugaring is applied in a translation step before the resolver.
394The ``validate'' pass hosts it, along with several other canonicalizing and desugaring transformations (the pass's name notwithstanding).
395The running example is lowered to:
396\begin{cfa}
397forall( @N *@ ) { $\C{// [1]}$
398 struct thing {};
399 void f( thing(@N@) ) { sout | @sizeof(N)@; } $\C{// [2], [3]}$
400}
401int main() {
402 thing( @char[10]@ ) x; f( x ); $\C{// prints 10, [4]}$
403 thing( @char[100]@ ) y; f( y ); $\C{// prints 100}$
404}
405\end{cfa}
406Observe:
407\begin{enumerate}[leftmargin=*]
408\item
409 @N@ is now declared to be a type.
410 It is declared to be \emph{sized} (by the @*@), meaning that the box pass shall do its @sizeof(N)@$\rightarrow$@__sizeof_N@ extra parameter and expression translation.
411\item
412 @thing(N)@ is a type; the argument to the generic @thing@ is a type (type variable).
413\item
414 The @sout...@ expression (being an application of the @?|?@ operator) has a second argument that is an ordinary expression.
415\item
416 The type of variable @x@ is another @thing(-)@ type; the argument to the generic @thing@ is a type (array type of bytes, @char[@$e$@]@).
417\end{enumerate}
418
419From this point, preexisting \CFA compilation takes over lowering it the rest of the way to C.
420Here the result shows only the relevant changes of the box pass (as informed by the resolver), leaving the rest unadulterated:
421\begin{cfa}
422// [1]
423void f( size_t __sizeof_N, @void *@ ) { sout | @__sizeof_N@; } $\C{// [2], [3]}$
424int main() {
425 struct __conc_thing_10 {} x; f( @10@, &x ); $\C{// prints 10, [4]}$
426 struct __conc_thing_100 {} y; f( @100@, &y ); $\C{// prints 100}$
427}
428\end{cfa}
429Observe:
430\begin{enumerate}[leftmargin=*]
431\item
432 The type parameter @N@ is gone.
433\item
434 The type @thing(N)@ is (replaced by @void *@, but thereby effectively) gone.
435\item
436 The @sout...@ expression has a regular variable (parameter) usage for its second argument.
437\item
438 Information about the particular @thing@ instantiation (value 10) is moved, from the type, to a regular function-call argument.
439\end{enumerate}
440At the end of the desugaring and downstream processing, the original C idiom of ``pass both a length parameter and a pointer'' has been reconstructed.
441In the programmer-written form, only the @thing@ is passed.
442The compiler's action produces the more complex form, which if handwritten, is error-prone.
443
444At the \CFA compiler's front end, changes to the parser are AST schema extensions and validation rules for enabling the sugared user input.
445\begin{itemize}[leftmargin=*]
446\item
447 Recognize the syntax @forall( ... [N] ... )@ as a type-variable declaration.
448\item
449 Where the AST's representation of a type variable encodes its \newterm{brand}, previously including full-object types @T@ and opaque datatypes @T&@, define new brand, \newterm{Dimension}. Apply this brand to the new syntax.
450\item
451 Allow a type variable to occur in an expression. Validate (after parsing) that only dimension-branded type-variables are used here.
452\item
453 Allow an expression to occur in type-argument position. Brand the resulting type argument as a dimension.
454\item
455 Validate (after parsing), on a generic-type usage, \eg the type part of the declaration
456 \begin{cfa}
457 array_1d( foo, bar ) x;
458 \end{cfa}
459 \vspace*{-10pt}
460 that the brands on the generic arguments match the brands of the declared type variables.
461 Here, that @foo@ is a type and @bar@ is a dimension.
462\end{itemize}
463
464
465\section{Typing of C Arrays}
466\label{s:ArrayTypingC}
467
468Essential in giving a guarantee of accurate length is the compiler's ability to reject a program that presumes to mishandle length.
469By contrast, most discussion so far deals with communicating length, from one party who knows it, to another willing to work with any given length.
470For scenarios where the concern is a mishandled length, the interaction is between two parties who both claim to know something about it.
471
472C and \CFA can check when working with two static values.
473\begin{cfa}
474enum { n = 42 };
475float x[@n@]; $\C{// or just 42}$
476float (*xp1)[@42@] = &x; $\C{// accept}$
477float (*xp2)[@999@] = &x; $\C{// reject}$
478warning: initialization of 'float (*)[999]' from incompatible pointer type 'float (*)[42]'
479\end{cfa}
480When a variable is involved, C and \CFA take two different approaches.
481Today's C compilers accept the following without a warning.
482\begin{cfa}
483static const int n = 42;
484float x[@n@];
485float (* xp)[@999@] = &x; $\C{// should be static rejection here}$
486(*xp)[@500@]; $\C{// in "bound"?}$
487\end{cfa}
488Here, the array @x@ has length 42, while a pointer to it (@xp@) claims length 999.
489So, while the subscript of @xp@ at position 500 is out of bound with its referent @x@,
490the access appears in-bound of the type information available on @xp@.
491In fact, length is being mishandled in the previous step, where the type-carried length information on @x@ is not compatible with that of @xp@.
492
493In \CFA, I choose to reject this C example at the point where the type-carried length information on @x@ is not compatible with that of @xp@, and correspondingly, its array counterpart at the same location:
494\begin{cfa}
495static const int n = 42;
496array( float, @n@ ) x;
497array( float, @999@ ) * xp = &x; $\C{// static rejection here}$
498(*xp)[@500@]; $\C{// runtime check would pass if program compiled}$
499\end{cfa}
500The way the \CFA array is implemented, the type analysis for this case reduces to a case similar to the earlier C version.
501The \CFA compiler's compatibility analysis proceeds as:
502\begin{itemize}[leftmargin=*,parsep=0pt]
503\item
504 Is @array( float, 999 )@ type-compatible with @array( float, n )@?
505\item
506 Is desugared @array( float, char[999] )@ type-compatible with desugared @array( float, char[n] )@?
507% \footnote{
508% Here, \lstinline{arrayX} represents the type that results from desugaring the \lstinline{array} type into a type whose generic parameters are all types.
509% This presentation elides the noisy fact that \lstinline{array} is actually a macro for something bigger;
510% the reduction to \lstinline{char [-]} still proceeds as sketched.}
511\item
512 Is internal type @char[999]@ type-compatible with internal type @char[n]@?
513\end{itemize}
514The answer is false because, in general, the value of @n@ is unknown at compile time, and hence, an error is raised.
515For safety, it makes sense to reject the corresponding C case, which is a non-backwards compatible change.
516There are two mitigations for this incompatibility.
517
518First, a simple recourse is available in a situation where @n@ is \emph{known} to be 999 by using a cast.
519\begin{cfa}
520float (* xp)[999] = @(float (*)[999])@&x;
521\end{cfa}
522The cast means the programmer has accepted blame.
523Moreover, the cast is ``eye candy'' marking where the unchecked length knowledge is used.
524Therefore, a program being onboarded to \CFA requires some upgrading to satisfy the \CFA rules (and arguably become clearer), without giving up its validity to a plain C compiler.
525Second, the incompatibility only affects types like pointer-to-array, which are infrequently used in C.
526The more common C idiom for aliasing an array is to use a pointer-to-first-element type, which does not participate in the \CFA array's length checking.\footnote{
527 Notably, the desugaring of the \lstinline{array} type avoids letting any \lstinline{-[-]} type decay,
528 in order to preserve the length information that powers runtime bound-checking.}
529Therefore, the need to upgrade legacy C code is low.
530Finally, if this incompatibility is a problem onboarding C programs to \CFA, it should be possible to change the C type check to a warning rather than an error, acting as a \emph{lint} of the original code for a missing type annotation.
531
532To handle two occurrences of the same variable, more information is needed, \eg, this is fine,
533\begin{cfa}
534int n = 42;
535float x[@n@];
536float (*xp)[@n@] = x; $\C{// accept}$
537\end{cfa}
538where @n@ remains fixed across a contiguous declaration context.
539However, intervening dynamic statements can cause failures.
540\begin{cfa}
541int n = 42;
542float x[@n@];
543@n@ = 999; $\C{// dynamic change}$
544float (*xp)[@n@] = x; $\C{// reject}$
545\end{cfa}
546As well, side-effects can even occur in a contiguous declaration context.
547\begin{cquote}
548\setlength{\tabcolsep}{20pt}
549\begin{tabular}{@{}ll@{}}
550\begin{cfa}
551// compile unit 1
552extern int @n@;
553extern float g();
554void f() {
555 float x[@n@] = { @g()@ }; // side-effect
556 float (*xp)[@n@] = x; // reject
557}
558\end{cfa}
559&
560\begin{cfa}
561// compile unit 2
562int @n@ = 42;
563void g() {
564 @n@ = 999; // accept
565}
566
567
568\end{cfa}
569\end{tabular}
570\end{cquote}
571The issue here is that knowledge needed to make a correct decision is hidden by separate compilation.
572Even within a translation unit, static analysis might not be able to provide all the information.
573However, if the example uses @const@, the check is possible even though the value is unknown.
574\begin{cquote}
575\setlength{\tabcolsep}{20pt}
576\begin{tabular}{@{}ll@{}}
577\begin{cfa}
578// compile unit 1
579extern @const@ int n;
580extern float g();
581void f() {
582 float x[n] = { g() };
583 float (*xp)[n] = x; // accept
584}
585\end{cfa}
586&
587\begin{cfa}
588// compile unit 2
589@const@ int n = 42;
590void g() {
591 @n = 999@; // reject
592}
593
594
595\end{cfa}
596\end{tabular}
597\end{cquote}
598
599In summary, the new rules classify expressions into three groups:
600\begin{description}
601\item[Statically Evaluable]
602 Expressions for which a specific value can be calculated (conservatively) at compile-time.
603 A preexisting \CFA compiler module defines which literals, enumerators, and expressions qualify and evaluates them.
604\item[Dynamic but Stable]
605 The value of a variable declared as @const@, including a @const@ parameter.
606\item[Potentially Unstable]
607 The catch-all category. Notable examples include:
608 any function-call result, @float x[foo()]@, the particular function-call result that is a pointer dereference, @void f(const int * n)@ @{ float x[*n]; }@, and any use of a reference-type variable.
609\end{description}
610Within these groups, my \CFA rules are:
611\begin{itemize}[leftmargin=*]
612\item
613 Accept a Statically Evaluable pair, if both expressions have the same value.
614 Notably, this rule allows a literal to match with an enumeration value, based on the value.
615\item
616 Accept a Dynamic but Stable pair, if both expressions are written out the same, \eg refers to the same variable declaration.
617\item
618 Otherwise, reject.
619 Notably, reject all pairs from the Potentially Unstable group and all pairs that cross groups.
620\end{itemize}
621The traditional C rules are:
622\begin{itemize}[leftmargin=*]
623\item
624 Reject a Statically Evaluable pair, if the expressions have two different values.
625\item
626 Otherwise, accept.
627\end{itemize}
628\VRef[Figure]{f:DimexprRuleCompare} gives a case-by-case comparison of the consequences of these rule sets.
629It demonstrates that the \CFA false alarms occur in the same cases as C treats unsafely.
630It also shows that C-incompatibilities only occur in cases that C treats unsafely.
631
632\begin{figure}
633 \newcommand{\falsealarm}{{\color{blue}\small{*}}}
634 \newcommand{\allowmisuse}{{\color{red}\textbf{!}}}
635
636 \begin{tabular}{@{}l@{\hspace{16pt}}c@{\hspace{8pt}}c@{\hspace{16pt}}c@{\hspace{8pt}}c@{\hspace{16pt}}c}
637 & \multicolumn{2}{c}{\underline{Values Equal}}
638 & \multicolumn{2}{c}{\underline{Values Unequal}}
639 & \\
640 \textbf{Case} & C & \CFA & C & \CFA & Compat. \\
641 Both Statically Evaluable, Same Symbol & Accept & Accept & & & \cmark \\
642 Both Statically Evaluable, Different Symbols & Accept & Accept & Reject & Reject & \cmark \\
643 Both Dynamic but Stable, Same Symbol & Accept & Accept & & & \cmark \\
644 Both Dynamic but Stable, Different Symbols & Accept & Reject\,\falsealarm & Accept\,\allowmisuse & Reject & \xmark \\
645 Both Potentially Unstable, Same Symbol & Accept & Reject\,\falsealarm & Accept\,\allowmisuse & Reject & \xmark \\
646 Any other grouping, Different Symbol & Accept & Reject\,\falsealarm & Accept\,\allowmisuse & Reject & \xmark
647 \end{tabular}
648
649 \medskip
650 \noindent\textbf{Legend}
651 \begin{itemize}[leftmargin=*]
652 \item
653 Each row gives the treatment of a test harness of the form
654 \begin{cfa}
655 float x[ expr1 ];
656 float (*xp)[ expr2 ] = &x;
657 \end{cfa}
658 \vspace*{-10pt}
659 where \lstinline{expr1} and \lstinline{expr2} are meta-variables varying according to the row's Case.
660 Each row's claim applies to other harnesses too, including,
661 \begin{itemize}[leftmargin=*]
662 \item
663 calling a function with a parameter like \lstinline{x} and an argument of the \lstinline{xp} type,
664 \item
665 assignment in place of initialization,
666 \item
667 using references in place of pointers, and
668 \item
669 for the \CFA array, calling a polymorphic function on two \lstinline{T}-typed parameters with \lstinline{&x}- and \lstinline{xp}-typed arguments.
670 \end{itemize}
671 \item
672 Each case's claim is symmetric (swapping \lstinline{expr1} with \lstinline{expr2} has no effect),
673 even though most test harnesses are asymmetric.
674 \item
675 The table treats symbolic identity (Same/Different on rows)
676 apart from value equality (Equal/Unequal on columns).
677 \begin{itemize}[leftmargin=*]
678 \item
679 The expressions \lstinline{1}, \lstinline{0+1} and \lstinline{n}
680 (where \lstinline{n} is a variable with value 1),
681 are all different symbols with the value 1.
682 \item
683 The column distinction expresses ground truth about whether an omniscient analysis should accept or reject.
684 \item
685 The row distinction expresses the simple static factors used by today's analyses.
686 \end{itemize}
687 \item
688 Accordingly, every Reject under Values Equal is a false alarm (\falsealarm),
689 while every Accept under Values Unequal is an allowed misuse (\allowmisuse).
690 \end{itemize}
691
692 \caption{Case comparison for array type compatibility, given pairs of dimension expressions.}
693 \label{f:DimexprRuleCompare}
694\end{figure}
695
696\begin{comment}
697Given that the above check
698\begin{itemize}
699 \item
700 Is internal type @char[999]@ type-compatible with internal type @char[n]@?
701\end{itemize}
702answers false, discussion turns to how I got the \CFA compiler to produce this answer.
703In its preexisting form, the type system had a buggy approximation of the C rules.
704To implement the new \CFA rules, I added one further step.
705\begin{itemize}
706 \item
707 Is @999@ compatible with @n@?
708\end{itemize}
709This question applies to a pair of expressions, where the earlier question applies to types.
710An expression-compatibility question is a new addition to the \CFA compiler, and occurs in the context of dimension expressions, and possibly enumerations assigns, which must be unique.
711
712% ... ensure these compiler implementation matters are treated under \CFA compiler background: type unification, cost calculation, GenPoly.
713
714The relevant technical component of the \CFA compiler is the standard type-unification within the type resolver.
715\begin{cfa}
716example
717\end{cfa}
718I added rules for continuing this unification into expressions that occur within types.
719It is still fundamentally doing \emph{type} unification because it is participating in binding type variables, and not participating in binding any variables that stand in for expression fragments (for there is no such sort of variable in \CFA's analysis.)
720An unfortunate fact about the \CFA compiler's preexisting implementation is that type unification suffers from two forms of duplication.
721
722In detail, the first duplication has (many of) the unification rules stated twice.
723As a result, my additions for dimension expressions are stated twice.
724The extra statement of the rules occurs in the @GenPoly@ module, where concrete types like @array( int, 5 )@\footnote{
725 Again, the presentation is simplified
726 by leaving the \lstinline{array} macro unexpanded.}
727are lowered into corresponding C types @struct __conc_array_1234@ (the suffix being a generated index).
728In this case, the struct's definition contains fields that hardcode the argument values of @float@ and @5@.
729The next time an @array( -, - )@ concrete instance is encountered, it checks if the previous @struct __conc_array_1234@ is suitable for it.
730Yes, for another occurrence of @array( int, 5 )@;
731no, for examples like @array( int, 42 )@ or @array( rational(int), 5 )@.
732In the first example, it must reject the reuse hypothesis for a dimension-@5@ and a dimension-@42@ instance.
733
734The second duplication has unification (proper) being invoked at two stages of expression resolution.
735As a result, my added rule set needs to handle more cases than the preceding discussion motivates.
736In the program
737\begin{cfa}
738void @f@( double ); // overload
739forall( T & ) void @f@( T & ); // overload
740void g( int n ) {
741 array( float, n + 1 ) x;
742 f(x); // overloaded
743}
744\end{cfa}
745when resolving a function call to @g@, the first unification stage compares the type @T@ of the parameter with @array( float, n + 1 )@, of the argument.
746
747The actual rules for comparing two dimension expressions are conservative.
748To answer, ``yes, consider this pair of expressions to be matching,''
749is to imply, ``all else being equal, allow an array with length calculated by $e_1$
750to be passed to a function expecting a length-$e_2$ array.''\footnote{
751 ... Deal with directionality, that I'm doing exact-match, no ``at least as long as,'' no subtyping.
752 Should it be an earlier scoping principle? Feels like it should matter in more places than here.}
753So, a ``yes'' answer must represent a guarantee that both expressions evaluate the
754same result, while a ``no'' can tolerate ``they might, but we're not sure'',
755provided that practical recourses are available
756to let programmers express better knowledge.
757The new rule-set in the current release is, in fact, extremely conservative.
758I chose to keep things simple,
759and allow future needs to drive adding additional complexity, within the new framework.
760
761For starters, the original motivating example's rejection is not based on knowledge that the @xp@ length of (the literal) 999 is value-unequal to the (obvious) runtime value of the variable @n@, which is the @x@ length.
762Rather, the analysis assumes a variable's value can be anything, and so there can be no guarantee that its value is 999.
763So, a variable and a literal can never match.
764
765... Discuss the interaction of this dimension hoisting with the challenge of extra unification for cost calculation
766\end{comment}
767
768These rules being conservative is the reason that \VRef{s:1d-impl} calls the \CFA array type only \emph{limited} dependent.
769In programming languages featuring general dependent typing, considerably more effort is invested in being able to conclude that two type-parameterizing expressions always compute the same value.
770While conservatism is inescapable, these languages use good approximations of eventual runtime behaviour to enable conclusions about more dynamic behaviours, such as a program never popping from an empty stack.
771
772The conservatism of the new rule set can leave a programmer requiring a recourse, when needing to use a dimension expression whose stability argument is more subtle than current-state analysis.
773This recourse is to declare an explicit constant for the dimension value.
774Consider these two dimension expressions, rejected by the blunt current-state rules:
775\begin{cfa}
776void f( int @&@ nr, @const@ int nv ) {
777 float x[@nr@];
778 float (*xp)[@nr@] = &x; $\C[2.5in]{// reject: nr varying (no references)}$
779 float y[@nv + 1@];
780 float (*yp)[@nv + 1@] = &y; $\C{// reject: ?+? unpredictable (no functions)}\CRT$
781}
782\end{cfa}
783Yet, both dimension expressions are reused safely.
784The @nr@ reference is never written, no implicit code (load) between declarations, and control does not leave the function between the uses.
785As well, the build-in @?+?@ function is predictable.
786
787To make these cases work, the programmer adds these constant declarations:
788\begin{cfa}
789void f( int & nr, const int nv ) {
790 @const int nx@ = nr;
791 float x[nx];
792 float (*xp)[nx] = & x; $\C[2.5in]{// accept}$
793 @const int ny@ = nv + 1;
794 float y[ny];
795 float (*yp)[ny] = & y; $\C{// accept}\CRT$
796}
797\end{cfa}
798The result is the originally intended semantics,
799achieved by adding a superfluous ``snapshot it as of now'' directive.
800Note that casting does not help with this issue, because it does not express information about values at different points in time.
801
802The snapshot trick is also used by the \CFA translation, though to achieve a different outcome.
803Rather obviously, every array must be subscriptable, even a bizarre one:
804\begin{cfa}
805array( float, @rand(10)@ ) x; $\C[2.5in]{// x[0] => no elements}$
806x[@0@]; $\C{// 10\% chance of bound-check failure}\CRT$
807\end{cfa}
808Less obvious is that the mechanism of subscripting is a function call, which must communicate length accurately.
809The bound-check above (callee logic) must use the actual allocated length of @x@, without mistakenly reevaluating the dimension expression, @rand(10)@.
810Adjusting the example to make the function's use of length more explicit:
811\begin{cfa}
812forall( T * )
813void f( T * x ) { sout | sizeof( *x ); }
814float x[ rand(10) ];
815f( x );
816\end{cfa}
817Considering that the partly translated function declaration is, loosely,
818\begin{cfa}
819void f( size_t __sizeof_T, void * x ) { sout | __sizeof_T; }
820\end{cfa}
821the translation calls the dimension argument twice:
822\begin{cfa}
823float x[ rand(10) ];
824f( rand(10), &x );
825\end{cfa}
826The correct form is:
827\begin{cfa}
828size_t __dim_x = rand(10);
829float x[ __dim_x ];
830f( __dim_x, &x );
831\end{cfa}
832Dimension hoisting already existed in the \CFA compiler.
833However, it was buggy, particularly with determining, ``Can hoisting the expression be skipped here?'' for skipping this hoisting is clearly desirable in some cases.
834For example, when a programmer has already done manual hoisting.
835In the new implementation, these cases are correct, harmonized with the accept/reject criteria.
836
837
838\section{Multidimensional Array Implementation}
839\label{s:ArrayMdImpl}
840
841A multidimensional array implementation has three relevant levels of abstraction, from highest to lowest, where the array occupies \emph{contiguous memory}.
842\begin{enumerate}[leftmargin=*]
843\item
844Flexible-stride memory:
845this model has complete independence between subscript ordering and memory layout, offering the ability to slice by (provide an index for) any dimension, \eg slice a row, column, or plane, \eg @c[3][4][*]@, @c[3][*][5]@, @c[3][*][*]@.
846\item
847Fixed-stride memory:
848this model binds the first subscript and the first memory layout dimension, offering the ability to slice by (provide an index for) only the coarsest dimension, @m[row][*]@ or @c[plane][*][*]@, \eg slice only by row (2D) or plane (3D).
849\item
850Explicit-displacement memory:
851this model has no awareness of dimensions just the ability to access memory at a distance from a reference point (base-displacement addressing), \eg @x + 23@ or @x[23]@ $\Rightarrow$ 23rd element after the start of @x@.
852A programmer must manually build any notion of dimensions using other tools;
853hence, this style is not offering multidimensional arrays \see{\VRef[Figure]{f:FixedVariable} right example}.
854\end{enumerate}
855
856There is some debate as to whether the abstraction point ordering above goes $\{1, 2\} < 3$, rather than my numeric ordering.
857That is, styles 1 and 2 are at the same abstraction level, with 3 offering a limited set of functionality.
858I chose to build the \CFA style-1 array upon a style-2 abstraction.
859Justification of the decision follows, after the description of the design.
860
861Style 3 is the inevitable target of any array implementation.
862The hardware offers this model to the C compiler, with bytes as the unit of displacement.
863C offers this model to programmers as pointer arithmetic, with arbitrary sizes as the unit.
864Casting a multidimensional array as a single-dimensional array/pointer, then using @x[i]@ syntax to access its elements, is still a form of pointer arithmetic.
865
866To step into the implementation of \CFA's new type-1 multidimensional arrays in terms of C's existing type-2 multidimensional arrays, it helps to clarify that the interface is low-level, \ie a C/\CFA array interface includes memory-layout detail.
867Specifically, the defining requirement of a type-1 system is the ability to slice a column from a column-finest matrix.
868Hence, the required memory shape of such a slice is fixed, before any discussion of implementation.
869The implementation presented here is how the \CFA array-library wrangles the C type system to make it do memory steps that are consistent with this layout while not affecting legacy C programs.
870% TODO: do I have/need a presentation of just this layout, just the semantics of -[all]?
871
872The new \CFA standard-library @array@-datatype supports richer multidimensional features than C.
873The new array implementation follows C's contiguous approach, \ie @float [r][c]@, with one contiguous object subscripted by coarsely-strided dimensions directly wrapping finely-strided dimensions.
874Beyond what C's array type offers, the new array brings direct support for working with a \emph{noncontiguous} array slice, allowing a program to work with dimension subscripts given in a non-physical order.
875
876The following examples use the matrix declaration @array( float, 5, 7 ) m@, loaded with values incremented by $0.1$, when stepping across the length-7 finely-strided column dimension, and incremented by $1$, when stepping across the length-5 coarsely-strided row dimension.
877\par
878\mbox{\lstinput{121-126}{hello-md.cfa}}
879\par\noindent
880The memory layout is 35 contiguous elements with strictly increasing addresses.
881
882A trivial form of slicing extracts a contiguous inner array, within an array-of-arrays.
883As for the C array, a lesser-dimensional array reference can be bound to the result of subscripting a greater-dimensional array by a prefix of its dimensions, \eg @m[2]@, giving the third row.
884This action first subscripts away the most coarsely strided dimensions, leaving a result that expects to be subscripted by the more finely strided dimensions, \eg @m[2][3]@, giving the value @2.3@.
885The following is an example slicing a row.
886\lstinput{60-64}{hello-md.cfa}
887\lstinput[aboveskip=0pt]{140-140}{hello-md.cfa}
888
889However, function @print1d_cstyle@ is asserting too much knowledge about its parameter @r@ for printing either a row slice or a column slice.
890Specifically, declaring the parameter @r@ with type @array@ means that @r@ is contiguous, which is unnecessarily restrictive.
891That is, @r@ need only be of a container type that offers a subscript operator (of type @ptrdiff_t@ $\rightarrow$ @float@) with managed length @N@.
892The new-array library provides the trait @ar@, so-defined.
893With it, the original declaration can be generalized with the same body.
894\lstinput{43-44}{hello-md.cfa}
895\lstinput[aboveskip=0pt]{145-145}{hello-md.cfa}
896The nontrivial slicing in this example now allows passing a \emph{noncontiguous} slice to @print1d@, where the new-array library provides a ``subscript by all'' operation for this purpose.
897In a multi-dimensional subscript operation, any dimension given as @all@ is a placeholder, \ie ``not yet subscripted by a value'', waiting for a value implementing the @ar@ trait.
898\lstinput{150-151}{hello-md.cfa}
899
900The example shows @x[2]@ and @x[2, all]@ both refer to the same, ``2.*'' slice.
901Indeed, the various @print1d@ calls under discussion access the entry with value @2.3@ as @x[2][3]@, @x[2,all][3]@, and @x[all,3][2]@.
902This design preserves (and extends) C array semantics by defining @x[i,j]@ to be @x[i][j]@ for numeric subscripts, but also for ``subscripting by all''.
903That is:
904\begin{cquote}
905\begin{tabular}{@{}cccccl@{}}
906@x[2,all][3]@ & $\equiv$ & @x[2][all][3]@ & $\equiv$ & @x[2][3]@ & (here, @all@ is redundant) \\
907@x[all,3][2]@ & $\equiv$ & @x[all][3][2]@ & $\equiv$ & @x[2][3]@ & (here, @all@ is effective)
908\end{tabular}
909\end{cquote}
910
911Narrating progress through each of the @-[-][-][-]@\footnote{
912The first ``\lstinline{-}'' is a variable expression and the remaining ``\lstinline{-}'' are subscript expressions.}
913expressions gives, firstly, a definition of @-[all]@, and secondly, a generalization of C's @-[i]@.
914Where @all@ is redundant:
915\begin{cquote}
916\begin{tabular}{@{}ll@{}}
917@x@ & 2-dimensional, want subscripts for coarse then fine \\
918@x[2]@ & 1-dimensional, want subscript for fine; lock coarse == 2 \\
919@x[2][all]@ & 1-dimensional, want subscript for fine \\
920@x[2][all][3]@ & 0-dimensional; lock fine == 3
921\end{tabular}
922\end{cquote}
923Where @all@ is effective:
924\begin{cquote}
925\begin{tabular}{@{}ll@{}}
926@x@ & 2-dimensional, want subscripts for coarse then fine \\
927@x[all]@ & 2-dimensional, want subscripts for fine then coarse \\
928@x[all][3]@ & 1-dimensional, want subscript for coarse; lock fine == 3 \\
929@x[all][3][2]@ & 0-dimensional; lock coarse == 2
930\end{tabular}
931\end{cquote}
932The semantics of @-[all]@ is to dequeue from the front of the ``want subscripts'' list and re-enqueue at its back.
933For example, in a two dimensional matrix, this semantics conceptually transposes the matrix by reversing the subscripts.
934The semantics of @-[i]@ is to dequeue from the front of the ``want subscripts'' list and lock its value to be @i@.
935
936Contiguous arrays, and slices of them, are all represented by the same underlying parameterized type, which includes stride information in its metadata.
937The \lstinline{-[all]} operation takes subscripts, \eg @x[2][all]@, @x[all][3]@, \etc, and converts (transposes) from the base reference @x[all]@ to a specific reference of the appropriate form.
938The running example's @all@-effective step, stated more concretely, is:
939\begin{cquote}
940\begin{tabular}{@{}ll@{}}
941@x@ & : 5 of ( 7 of @float@ each spaced 1 @float@ apart ) each spaced 7 @floats@ apart \\
942@x[all]@ & : 7 of ( 5 of @float@ each spaced 7 @float@s apart ) each spaced 1 @float@ apart
943\end{tabular}
944\end{cquote}
945
946\begin{figure}
947\includegraphics{measuring-like-layout}
948\caption{Visualization of subscripting by value and by \lstinline[language=CFA]{all}, for \lstinline{x} of type \lstinline{array( float, 5, 7 )} understood as 5 rows by 7 columns.
949The horizontal layout represents contiguous memory addresses while the vertical layout is conceptual.
950The vertical shaded band highlights the location of the targeted element, 2.3.
951Any such vertical slice contains various interpretations of a single address.}
952\label{fig:subscr-all}
953\end{figure}
954
955\VRef[Figure]{fig:subscr-all} shows one element (in the shaded band) accessed two different ways: as @x[2][3]@ and as @x[all][3][2]@.
956In both cases, subscript 2 selects from the coarser dimension (rows of @x@),
957while subscript 3 selects from the finer dimension (columns of @x@).
958The figure illustrates the value of each subexpression, comparing how numeric subscripting proceeds from @x@, \vs from @x[all]@.
959Proceeding from @x@ gives the numeric indices as coarse then fine, while proceeding from @x[all]@ gives them fine then coarse.
960These two starting expressions, which are the example's only multidimensional subexpressions
961(those that received zero numeric indices so far), are illustrated with vertical steps where a \emph{first} numeric index selects.
962
963The figure's presentation offers an intuitive answer to: What is an atomic element of @x[all]@?
964\begin{enumerate}[leftmargin=*]
965\item
966@x[all]@ itself is simply a two-dimensional array, in the strict C sense, of these building blocks.
967\item
968An array of these atoms (like the intermediate @x[all][3]@) is just a contiguous arrangement of them, done according to their size;
969call such an array a column.
970A column is almost ready to be arranged into a matrix;
971it is the \emph{contained value} of the next-level building block, but another lie about size is required.
972\item
973An atom (like the bottommost value, @x[all][3][2]@), is the contained value (in the square box) and a lie about its size (the left diagonal above it, growing upward).
974\end{enumerate}
975At first, an atom needs to be arranged as if it is bigger, but now a column needs to be arranged as if it is smaller (the left diagonal above it, shrinking upward).
976These lying columns, arranged contiguously according to their size (as announced) form the matrix @x[all]@.
977Because @x[all]@ takes indices, first for the fine stride, then for the coarse stride, it achieves the requirement of representing the transpose of @x@.
978Yet every time the programmer presents an index, a C-array subscript is achieving the offset calculation.
979
980In the @x[all]@ case, after the finely strided subscript is done (column 3 is selected),
981the locations referenced by the coarse subscript options (rows 0..4) are offset by 3 floats,
982compared with where analogous rows appear when the row-level option is presented for @x@.
983For example, in \lstinline{x[all]}, the shaded band and its immediate values to the left touches atoms 2.3, 2.0, 2.1, 2.2, 1.4, 1.5 and 1.6.
984But only the atom 2.3 is storing its value there.
985The rest are lying about (conflicting) claims on this location, but never exercising these alleged claims.
986
987Lying is implemented as casting.
988The arrangement just described is implemented in the structure @arpk@.
989This structure uses one type in its internal field declaration and offers a different type as the return of its subscript operator.
990The field within is a plain-C array of the fictional type, which is 7 floats long for @x[all][3][2]@ and 1 float long for @x[all][3]@.
991The subscript operator presents what is really inside, by casting to the type below the left diagonal of the lie.
992
993% Does x[all] have to lie too? The picture currently glosses over how it it advertises a size of 7 floats. I'm leaving that as an edge case benignly misrepresented in the picture. Edge cases only have to be handled right in the code.
994
995Casting, overlapping, and lying are unsafe.
996The mission is to implement a style-1 feature in the type system for safe use by a programmer.
997The offered style-1 system is allowed to be internally unsafe,
998just as C's implementation of a style-2 system (upon a style-3 system) is unsafe within, even when the programmer is using it without casts or pointer arithmetic.
999Having a style-1 system relieves the programmer from resorting to unsafe pointer arithmetic when working with noncontiguous slices.
1000
1001% PAB: repeat from previous paragraph.
1002% The choice to implement this style-1 system upon C's style-2 arrays, rather than its style-3 pointer arithmetic, reduces the attack surface of unsafe code.
1003% My casting is unsafe, but I do not do any pointer arithmetic.
1004% When a programmer works in the common-case style-2 subset (in the no-@[all]@ top of \VRef[Figure]{fig:subscr-all}), my casts are identities, and the C compiler is doing its usual displacement calculations.
1005% If I had implemented my system upon style-3 pointer arithmetic, then this common case would be circumventing C's battle-hardened displacement calculations in favour of my own.
1006
1007% \noindent END: Paste looking for a home
1008
1009The new-array library defines types and operations that ensure proper elements are accessed soundly in spite of the overlapping.
1010The @arpk@ structure and its @-[i]@ operator are defined as:
1011\begin{cfa}
1012forall(
1013 [N], $\C{// length of current dimension}$
1014 S & | sized(S), $\C{// masquerading-as}$
1015 Timmed &, $\C{// immediate element, often another array}$
1016 Tbase & $\C{// base element, \eg float, never array}$
1017) { // distribute forall to each element
1018 struct arpk {
1019 S strides[N]; $\C{// so that sizeof(this) is N of S}$
1020 };
1021 // expose Timmed, stride by S
1022 static inline Timmed & ?[?]( arpk( N, S, Timmed, Tbase ) & a, long int i ) {
1023 subcheck( a, i, 0, N );
1024 return (Timmed &)a.strides[i];
1025 }
1026}
1027\end{cfa}
1028The private @arpk@ structure (array with explicit packing) is generic over four types: dimension length, masquerading-as, ...
1029This structure's public interface is hidden behind the @array(...)@ macro and the subscript operator.
1030Construction by @array@ initializes the masquerading-as type information to be equal to the contained-element information.
1031Subscripting by @all@ rearranges the order of masquerading-as types to achieve, in general, nontrivial striding.
1032Subscripting by a number consumes the masquerading-as size of the contained element type, does normal array stepping according to that size, and returns the element found there, in unmasked form.
1033
1034An instantiation of the @arpk@ generic is given by the @array( E_base, N0, N1, ... )@ expansion, which is @arpk( N0, Rec, Rec, E_base )@, where @Rec@ is @array( E_base, N1, ... )@.
1035In the base case, @array( E_base )@ is just @E_base@.
1036Because this construction uses the same value for the generic parameters @S@ and @E_im@, the resulting layout has trivial strides.
1037
1038Subscripting by @all@, to operate on nontrivial strides, is a dequeue-enqueue operation on the @E_im@ chain, which carries @S@ instantiations, intact, to new positions.
1039Expressed as an operation on types, this rotation is:
1040\begin{eqnarray*}
1041suball( arpk(N, S, E_i, E_b) ) & = & enq( N, S, E_i, E_b ) \\
1042enq( N, S, E_b, E_b ) & = & arpk( N, S, E_b, E_b ) \\
1043enq( N, S, arpk(N', S', E_i', E_b), E_b ) & = & arpk( N', S', enq(N, S, E_i', E_b), E_b )
1044\end{eqnarray*}
1045
1046
1047\section{Zero Overhead}
1048
1049At runtime, the \CFA array is exactly a C array.
1050\CFA array subscripting is protected with runtime bound checks.
1051The array dependent-typing provides information to the C optimizer, allowing it to remove many of the bound checks.
1052This section provides a demonstration of these effects.
1053
1054The experiment compares the \CFA array system with the simple-safety system most typically exemplified by Java arrays (\VRef[Section]{JavaCompare}), and reflected in \CC vector using member @.at@ for subscripting (\VRef[Section]{CppCompare}).
1055The essential feature is the one-to-one correspondence between array instances and the symbolic bounds on which dynamic checks are based.
1056Hence, it is the implicit \CFA checked subscripting and explicit \CC @vector@ @.at@ mechanisms being explained and not limitations of \CC optimization.
1057
1058As a control case, a simple loop receives the same optimization treatment in both the \CFA and \CC versions.
1059When the surrounding code makes it clear subscripting is always in bound, no dynamic bound check is observed in the program's optimized assembly code.
1060But when the environment is adjusted, such that the subscript is possibly invalid, the bound check appears in the optimized assembly, ready to catch a mistake.
1061
1062\VRef[Figure]{f:ovhd-ctl} gives a control-case example of summing values in an array, where each column shows the program in languages C (a,~d,~g), \CFA (b,~e,~h), and \CC (c,~f,~i).
1063The C code has no bounds checking, while the \CFA and \CC can have bounds checking.
1064The source-code functions in (a, b, c) can be compiled to have either correct or incorrect uses of bounds.
1065When compiling for correct bound use, the @BND@ macro passes its argument through, so the loops cover exactly the passed array sizes.
1066When compiling for possible incorrect bound use (a programming error), the @BND@ macro hardcodes the loops for 100 iterations, which implies out-of-bound access attempts when the passed array has fewer than 100 elements.
1067The assembly code excerpts show optimized translations for correct-bound mode in (d, e, f) and incorrect-bound mode in (g, h, i).
1068Because incorrect-bound mode hardcodes 100 iterations, the loop always executes a first time, so this mode does not have the @n == 0@ branch seen in correct-bound mode.
1069For C, this difference is the only (d--g) difference.
1070For correct bounds, the \CFA translation equals the C translation, \ie~there is no (d--e) difference, while \CC has an additional indirection to dereference the vector's auxiliary allocation.
1071
1072\begin{figure}
1073\setlength{\tabcolsep}{10pt}
1074\begin{tabular}{llll@{}}
1075\multicolumn{1}{c}{C} &
1076\multicolumn{1}{c}{\CFA} &
1077\multicolumn{1}{c}{\CC (nested vector)}
1078\\[1em]
1079\lstinput{20-28}{ar-bchk/control.c} &
1080\lstinput{20-28}{ar-bchk/control.cfa} &
1081\lstinput{20-28}{ar-bchk/control.cc}
1082\\
1083\multicolumn{1}{c}{(a)} &
1084\multicolumn{1}{c}{(b)} &
1085\multicolumn{1}{c}{(c)}
1086\\[1em]
1087\multicolumn{4}{l}{
1088 \includegraphics[page=1,trim=0 9.125in 2in 0,clip]{ar-bchk}
1089}
1090\\
1091\multicolumn{1}{c}{(d)} &
1092\multicolumn{1}{c}{(e)} &
1093\multicolumn{1}{c}{(f)}
1094\\[1em]
1095\multicolumn{4}{l}{
1096 \includegraphics[page=2,trim=0 8.75in 2in 0,clip]{ar-bchk}
1097}
1098\\
1099\multicolumn{1}{c}{(g)} &
1100\multicolumn{1}{c}{(h)} &
1101\multicolumn{1}{c}{(i)}
1102\end{tabular}
1103\caption{Overhead comparison, control case.
1104All three programs/compilers generate equally performant code when the programmer ``self-checks'' bounds via a loop's condition.
1105Yet both \CFA and \CC versions generate code that is slower and safer than C's when the programmer might overrun the bounds.}
1106\label{f:ovhd-ctl}
1107\end{figure}
1108
1109Differences arise when the bound-incorrect programs are passed an array shorter than 100.
1110The C version, (g), proceeds with undefined behaviour, reading past the end of the array.
1111The \CFA and \CC versions, (h, i), flag the mistake with the runtime check, the @i >= n@ branch.
1112This check is provided implicitly by the library types @array@ and @vector@, respectively.
1113The significant result is the \emph{absence} of runtime checks from the bound-correct translations, (e, f).
1114The code optimizer has removed them because, at the point where they would occur (immediately past @.L28@/@.L3@), it knows from the surrounding control flow either @i == 0 && 0 < n@ or @i < n@ (directly), \ie @i < n@ either way.
1115So any repeated checks, \ie the branch and its consequent code (raise error), are removable.
1116
1117% Progressing from the control case, a deliberately bound-incorrect mode is no longer informative.
1118% Rather, given a (well-typed) program that does good work on good data, the issue is whether it is (determinably) bound-correct on all data.
1119
1120When dimension sizes get reused, \CFA has an advantage over \CC-vector at getting simply written programs well optimized.
1121\VRef[Figures]{f:ovhd-treat-src} shows a simple matrix multiplication over a row-major encoding.
1122Simple means coding directly to the intuition of the mathematical definition without trying to optimize for memory layout.
1123In the assembly code of \VRef[Figure]{f:ovhd-treat-asm}, the looping pattern of \VRef[Figure]{f:ovhd-ctl} (d, e, f), ``Skip ahead on zero; loop back for next,'' occurs with three nesting levels.
1124Simultaneously, the dynamic bound-check pattern of \VRef[Figure]{f:ovhd-ctl} (h,~i), ``Get out on invalid,'' occurs, targeting @.L7@, @.L9@ and @.L8@ (bottom right).
1125Here, \VRef[Figures]{f:ovhd-treat-asm} shows the \CFA solution optimizing into practically the C solution, while the \CC solution shows added runtime bound checks.
1126Like in \VRef[Figure]{f:ovhd-ctl} (e), the significance is the \emph{absence} of library-imposed runtime checks, even though the source code is working through the the \CFA @array@ library.
1127The optimizer removed the library-imposed checks because the data structure @array@-of-@array@ is constrained by its type to be shaped correctly for the intuitive looping.
1128In \CC, the same constraint does not apply to @vector@-of-@vector@.
1129Because every individual @vector@ carries its own size, two types of bound mistakes are possible.
1130
1131\begin{figure}
1132\setlength{\tabcolsep}{10pt}
1133\begin{tabular}{llll@{}}
1134\multicolumn{1}{c}{C} &
1135\multicolumn{1}{c}{\CFA} &
1136\multicolumn{1}{c}{\CC (nested vector)}
1137\\
1138\lstinput{20-37}{ar-bchk/treatment.c} &
1139\lstinput{20-37}{ar-bchk/treatment.cfa} &
1140\lstinput{20-37}{ar-bchk/treatment.cc}
1141\end{tabular}
1142\caption{Overhead comparison, differentiation case, source.}
1143\label{f:ovhd-treat-src}
1144\end{figure}
1145
1146\begin{figure}
1147\newcolumntype{C}[1]{>{\centering\arraybackslash}p{#1}}
1148\begin{tabular}{C{1.5in}C{1.5in}C{1.5in}p{1in}}
1149C &
1150\CFA &
1151\CC (nested vector)
1152\\[1em]
1153\multicolumn{4}{l}{
1154 \includegraphics[page=3,trim=0 4in 2in 0,clip]{ar-bchk}
1155}
1156\end{tabular}
1157\caption{Overhead comparison, differentiation case, assembly.
1158}
1159\label{f:ovhd-treat-asm}
1160\end{figure}
1161
1162In detail, the three structures received may not be matrices at all, per the obvious/dense/total interpretation; rather, any one might be ragged-right in its rows.
1163The \CFA solution guards against this possibility by encoding the minor length (number of columns) in the major element (row) type.
1164In @res@, for example, each of the @M@ rows is @array(float, N)@, guaranteeing @N@ cells within it.
1165Or more technically, guaranteeing @N@ as the basis for the imposed bound check \emph{of every row.}
1166As well, the \CC type does not impose the mathematically familiar constraint of $(M \times P) (P \times N) \rightarrow (M \times N)$.
1167Even assuming away the first issue, \eg that in @lhs@ all minor/cell counts agree, the data format allows the @rhs@ major/row count to disagree.
1168Or, the possibility that the row count @res.size()@ disagrees with the row count @lhs.size()@ illustrates this bound-mistake type in isolation.
1169The \CFA solution guards against this possibility by keeping length information separate from the array data, and therefore eligible for sharing.
1170This capability lets \CFA escape the one-to-one correspondence between array instances and symbolic bounds, where this correspondence leaves a \CC-vector programmer stuck with a matrix representation that repeats itself.
1171
1172It is important to clarify that the \CFA solution does not become unsafe (like C) in losing its dynamic checks, even though it becomes fast (as C) in losing them.
1173The dynamic checks are dismissed as unnecessary \emph{because} the program is safe to begin with.
1174To achieve the same performance, a \CC programmer must state appropriate assertions or assumptions, to allow the optimizer to dismiss the runtime checks.
1175% Especially considering that two of them are in the inner-most loop.
1176The solution requires doing the work of the inner-loop checks as a \emph{preflight step}.
1177But this step requires looping and doing it upfront gives too much separation for the optimizer to see ``has been checked already'' in the deep loop.
1178So, the programmer must restate the preflight observation within the deep loop, but this time as an unchecked assumption.
1179Such assumptions are risky because they introduce further undefined behaviour when misused.
1180Only the programmer's discipline remains to ensure this work is done without error.
1181
1182In summary, the \CFA solution lets a simply stated program have dynamic guards that catch bugs, while letting a simply stated bug-free program run as fast as the unguarded C equivalent.
1183
1184\begin{comment}
1185The ragged-right issue brings with it a source-of-truth difficulty: Where, in the \CC version, is one to find the value of $N$? $M$ can come from either @res@'s or @lhs@'s major/row count, and checking these for equality is straightforward. $P$ can come from @rhs@'s major/row count. But $N$ is only available from columns, \ie minor/cell counts, which are ragged. So any choice of initial source of truth, \eg
1186\end{comment}
1187
1188
1189\section{Array Lifecycle}
1190
1191An array, like a structure, wraps subordinate objects.
1192Any object type, like @string@, can be an array element or structure member.
1193A consequence is that the lifetime of the container must match with its subordinate objects: all elements and members must be initialized/uninitialized implicitly as part of the container's allocation/deallocation.
1194Modern programming languages implicitly perform these operations via a type's constructor and destructor.
1195Therefore, \CFA must assure that an array's subordinate objects' lifetime operations are called.
1196Preexisting \CFA mechanisms achieve this requirement, but with poor performance.
1197Furthermore, advanced array users need an exception to the basic mechanism, which does not occur with other aggregates.
1198Hence, arrays introduce subtleties in supporting an element's lifecycle.
1199
1200The preexisting \CFA support for contained-element lifecycle is based on recursive occurrences of the object-type (otype) pseudo-trait.
1201A type is an otype, if it provides a default (parameterless) constructor, copy constructor, assignment operator, and destructor (like \CC).
1202For a structure with otype members, the compiler implicitly generates implementations of the four otype functions for the outer structure.
1203Then the generated default constructor for the outer structure calls the default constructor for each member, and the other otype functions work similarly.
1204For a member that is a C array, these calls occur in a loop for each array element, which even works for VLAs.
1205This logic works the same, whether the member is a concrete type (that happens to be an otype) or if the member is a polymorphic type asserted to be an otype (which is implicit in the syntax, @forall(T)@).
1206The \CFA array has the simplified form (similar to one seen before):
1207\begin{cfa}
1208forall( T * ) // non-otype element, no lifecycle functions
1209// forall( T ) // otype element, lifecycle functions asserted
1210struct array5 {
1211 T __items[ 5 ];
1212};
1213\end{cfa}
1214Being a structure with a C-array member, the otype-form declaration @T@ causes @array5( float )@ to be an otype too.
1215But this otype-recursion pattern has a performance issue.
1216\VRef[Figure]{f:OtypeRecursionBlowup} shows the steps to find lifecycle functions, under the otype-recursion pattern, for a cube of @float@:
1217\begin{cfa}
1218array5( array5( array5( float ) ) )
1219\end{cfa}
1220The work needed for the full @float@-cube is 256 leaves.
1221Then the otype-recursion pattern generates helper functions and thunks that are exponential in the number of dimensions.
1222Anecdotal experience is annoyingly slow compile time at three dimensions and unusable at four.
1223
1224%array5(T) offers
1225%1 parameterless ctor, which asks for T to have
1226% 1 parameterless ctor
1227% 2 copy ctor
1228% 3 asgt
1229% 4 dtor
1230%2 copy ctor, which asks for T to have
1231% 1 parameterless ctor
1232% 2 copy ctor
1233% 3 asgt
1234% 4 dtor
1235%3 asgt, which asks for T to have
1236% 1 parameterless ctor
1237% 2 copy ctor
1238% 3 asgt
1239% 4 dtor
1240%4 dtor, which asks for T to have
1241% 1 parameterless ctor
1242% 2 copy ctor
1243% 3 asgt
1244% 4 dtor
1245
1246\begin{figure}
1247\centering
1248\setlength{\tabcolsep}{20pt}
1249\begin{tabular}{@{}lll@{}}
1250\begin{cfa}[deletekeywords={default}]
1251float offers
12521 default ctor
12532 copy ctor
12543 assignment
12554 dtor
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280\end{cfa}
1281&
1282\begin{cfa}[deletekeywords={default}]
1283array5( float ) has
12841 default ctor, using float$'$s
1285 1 default ctor
1286 2 copy ctor
1287 3 assignment
1288 4 dtor
12892 copy ctor, using float$'$s
1290 1 default ctor
1291 2 copy ctor
1292 3 assignment
1293 4 dtor
12943 assignment, using float$'$s
1295 1 default ctor
1296 2 copy ctor
1297 3 assignment
1298 4 dtor
12994 dtor, using float$'$s
1300 1 default ctor
1301 2 copy ctor
1302 3 assignment
1303 4 dtor
1304
1305
1306
1307
1308
1309
1310
1311
1312\end{cfa}
1313&
1314\begin{cfa}[deletekeywords={default}]
1315array5( array5( float ) ) has
13161 default ctor, using array5( float )
1317 1 default ctor, using float$'$s
1318 1 default ctor
1319 2 copy ctor
1320 3 assignment
1321 4 dtor
1322 2 copy ctor, using float$'$s
1323 1 default ctor
1324 2 copy ctor
1325 3 assignment
1326 4 dtor
1327 3 assignment, using float$'$s
1328 1 default ctor
1329 2 copy ctor
1330 3 assignment
1331 4 dtor
1332 4 dtor, using float$'$s
1333 1 default ctor
1334 2 copy ctor
1335 3 assignment
1336 4 dtor
13372 copy ctor, using array5( float )
1338 ... 4 children, 16 leaves
13393 assignment, using array5( float )
1340 ... 4 children, 16 leaves
13414 dtor, using array5( float )
1342 ... 4 children, 16 leaves
1343(64 leaves)
1344\end{cfa}
1345\end{tabular}
1346\caption{Exponential thunk generation under the otype-recursion pattern.
1347 Each time one type's function (\eg ctor) uses another type's function, the \CFA compiler generates a thunk, to capture the used function's dependencies, presented according to the using function's need.
1348 So, each non-leaf line represents a generated thunk and every line represents a search request for the resolver to find a satisfying function.}
1349\label{f:OtypeRecursionBlowup}
1350\end{figure}
1351
1352The issue is that the otype-recursion pattern uses more assertions than needed.
1353For example, @array5( float )@'s default constructor has all four lifecycle assertions about the element type, @float@.
1354However, it only needs @float@'s default constructor, as the other operations are never used.
1355Current work by the \CFA team aims to improve this situation.
1356My workaround moves from otype (value) to dtype (pointer) with a default-constructor assertion, where dtype does not generate any constructors but the assertion claws back the default otype constructor.
1357\begin{cquote}
1358\setlength{\tabcolsep}{10pt}
1359\begin{tabular}{@{}ll@{}}
1360\begin{cfa}
1361// autogenerated for otype-recursion:
1362forall( T )
1363void ?{}( array5( T ) & this ) {
1364 for ( i; 5 ) { ( this[i] ){}; }
1365}
1366forall( T )
1367void ?{}( array5( T ) & this, array5( T ) & src ) {
1368 for ( i; 5 ) { ( this[i] ){ src[i] }; }
1369}
1370forall( T )
1371void ^?{}( array5( T ) & this ) {
1372 for ( i; 5 ) { ^( this[i] ){}; }
1373}
1374\end{cfa}
1375&
1376\begin{cfa}
1377// lean, bespoke:
1378forall( T* | { void @?{}( T & )@; } )
1379void ?{}( array5( T ) & this ) {
1380 for ( i; 5 ) { ( this[i] ){}; }
1381}
1382forall( T* | { void @?{}( T &, T )@; } )
1383void ?{}( array5( T ) & this, array5( T ) & src ) {
1384 for ( i; 5 ) { ( this[i] ){ src[i] }; }
1385}
1386forall( T* | { void @?{}( T & )@; } )
1387void ^?{}( array5(T) & this ) {
1388 for (i; 5) { ^( this[i] ){}; }
1389}
1390\end{cfa}
1391\end{tabular}
1392\end{cquote}
1393Moreover, the assignment operator is skipped, to avoid hitting a lingering growth case.
1394Temporarily skipping assignment is tolerable because array assignment is not a common operation.
1395With this solution, the critical lifecycle functions are available, with linear growth in thunk creation for the default constructor.
1396
1397Finally, the intuition that a programmer using an array always wants the elements' default constructor called \emph{automatically} is simplistic.
1398Arrays exist to store different values at each position.
1399So, array initialization needs to let the programmer provide different constructor arguments to each element.
1400\begin{cfa}
1401thread worker { int id; };
1402void ?{}( worker & ) = void; $\C[2.5in]{// remove default constructor}$
1403void ?{}( worker &, int id );
1404array( worker, 5 ) ws = @{}@; $\C{// rejected; but desire is for no initialization yet}$
1405for ( i; 5 ) (ws[i]){ @i@ }; $\C{// explicit (placement) initialization for each thread, giving id}\CRT$
1406\end{cfa}
1407Note the use of the \CFA explicit constructor call, analogous to \CC's placement-@new@.
1408This call is where initialization is desired, and not at the declaration of @ws@.
1409The attempt to initialize from nothing (equivalent to dropping @= {}@ altogether) is invalid because the @worker@ type removes the default constructor.
1410The @worker@ type is designed this way to work with the threading system.
1411A thread type forks a thread at the end of each constructor and joins with it at the start of each destructor.
1412But a @worker@ cannot begin its forked-thread work without knowing its @id@.
1413Therefore, there is a conflict between the implicit actions of the builtin @thread@ type and a user's desire to defer these actions.
1414
1415Another \CFA feature for providing C backwards compatibility, at first seems viable for initializing the array @ws@, though on closer inspection is not.
1416C initialization without a constructor is specified with \lstinline|@=|, \eg \lstinline|array(worker, 5) ws @= {}| ignores all \CFA lifecycle management and uses C empty initialization.
1417This option does achieve the desired semantics on the construction side.
1418But on destruction side, the desired semantics is for implicit destructor calls to continue, to keep the join operation tied to lexical scope.
1419C initialization disables \emph{all} implicit lifecycle management, but the goal is to disable only the implicit construction.
1420
1421To fix this problem, I enhanced the \CFA standard library to provide the missing semantics, available in either form:
1422\begin{cfa}
1423array( @uninit@(worker), 5 ) ws1;
1424array( worker, 5) ws2 = { @delay_init@ };
1425\end{cfa}
1426Both cause the @ws@-construction-time implicit call chain to stop before reaching a @worker@ constructor, while leaving the implicit destruction calls intact.
1427Two forms are available, to parallel the development of this feature in \uCpp~\cite{uC++}.
1428Originally \uCpp offered only the @ws1@ form, using the class-template @uNoCtor@ equivalent to \CFA's @uninit@.
1429More recently, \uCpp was extended with the declaration macro, @uArray@, with usage similar to the @ws2@ case.
1430Based on experience piloting @uArray@ as a replacement of @uNoCtor@, it should be possible to remove the first option.
1431
1432% note to Mike, I have more fragments on some details available in push24\fragments\uNoCtor.txt
1433
1434\section{Array Comparison}
1435
1436
1437\subsection{Rust}
1438
1439A Rust array is a set of mutable or immutable (@const@) contiguous objects of the same type @T@, where the compile-time dimension(s) is part of the type signature @[T; dimension]@.
1440\begin{rust}
1441let val = 42;
1442let mut ia: [usize; 5] = [val; 5]; $\C{// mutable, repeated initialization [42, 42, 42, 42, 42]}$
1443let fval = 42.2;
1444let fa: [f64; 5] = [1.2, fval, 5.6, 7.3, 9.1]; $\C{// immutable, individual initialization}$
1445\end{rust}
1446Initialization is required even if an array is subsequently initialized.
1447Rust arrays are not VLAs, but the compile-time length can be queried using member @len()@.
1448Arrays can be assigned and passed to parameters by value or reference, if and only if, the type and dimension match, meaning a different function is needed for each array size.
1449
1450Array iteration is by a range or array variable.
1451\begin{rust}
1452for i in @0..ia.len()@ { print!("{:?} ", ia[i] ); } $\C{// 42 42 42 42 42}$
1453for fv in @fa@ { print!("{:?} ", fv ); } $\C{// 1.2 42.2 5.6 7.3 9.1}$
1454for i in 0..=1 { ia[i] = i; } $\C{// mutable changes}$
1455for iv in ia { print!("{:?} ", iv ); } $\C{// 0 1 42 42 42}$
1456\end{rust}
1457An array can be assigned and printed as a set.
1458\begin{rust}
1459ia = @[5; 5]@; println!( "{:?} {:?}", @ia@, ia.len() ); $\C{// [5, 5, 5, 5, 5] 5}$
1460ia = @[1, 2, 3, 4, 5]@; println!( "{:?} {:?}", @ia@, ia.len() ); $\C{// [1, 2, 3, 4, 5] 5}$
1461\end{rust}
1462
1463Multi-dimensional arrays use nested dimensions, resulting in columns before rows.
1464Here the outer array is a length @ROWS@ array whose elements are @f64@ arrays of length @COLS@ each.
1465\begin{cquote}
1466\setlength{\tabcolsep}{10pt}
1467\begin{tabular}{@{}ll@{}}
1468\begin{rust}
1469const ROWS: usize = 4; const COLS: usize = 6;
1470let mut fmatrix: [[f64; @COLS@]; @ROWS@] = [[0.; @COLS@]; @ROWS@];
1471for r in 0 .. ROWS {
1472 for c in 0 .. COLS { fmatrix[r][c] = r as f64 + c as f64; } }
1473\end{rust}
1474&
1475\begin{rust}
1476[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
1477[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
1478[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]
1479[ 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
1480\end{rust}
1481\end{tabular}
1482\end{cquote}
1483
1484Slices borrow a section of an array (subarray) and have type @&[T]@.
1485A slice has a dynamic size and does not implicitly coerce to an array.
1486\begin{rust}
1487println!( "{:?}", @&ia[0 .. 3]@ ); $\C{// fixed bounds, [1, 2, 3]}$
1488println!( "{:?}", @&ia[ia.len() - 2 .. ia.len()@] ); $\C{// variable bounds, [4, 5]}$
1489println!( "{:?}", @&ia[ia.len() - 2 .. ]@ ); $\C{// drop upper bound, [4, 5]}$
1490println!( "{:?}", @&ia[.. ia.len() - 2 ]@ ); $\C{// drop lower bound, [1, 2, 3]}$
1491println!( "{:?}", @&ia[..]@ ); $\C{// drop both bound, [1, 2, 3, 4, 5]}$
1492\end{rust}
1493A multi-dimensional slice can only borrow subrows because a slice requires contiguous memory.
1494Here columns 2--4 are sliced from row 3.
1495\begin{rust}
1496let mut slice2: &[f64] = &fmatrix[3][@2 ..= 4@];
1497println!( "{:?}", slice2 ); $\C{// [5.0, 6.0, 7.0]}$
1498\end{rust}
1499Here row 2 is sliced from the sub-matrix formed from rows 1--3.
1500\begin{rust}
1501slice2 = &fmatrix[@1 ..= 3@][1];
1502println!( "{:?}", slice2 ); $\C{// [3.0, 4.0, 5.0, 6.0, 7.0, 8.0]}$
1503\end{rust}
1504A slice can be explicitly converted into an array or reference to an array.
1505\begin{rust}
1506let slice: &[f64];
1507slice = &fa[0 ..= 1]; $\C{// create slice, [1.2, 42.2]}$
1508let mut fa2: [f64; 2] = @<[f64; 2]>::try_from( slice ).unwrap()@; $\C{// convert slice to array, [1.2, 42.2]}$
1509fa2 = @(& fa[2 ..= 3]).try_into().unwrap()@; $\C{// convert slice to array, [5.6, 7.3]}$
1510\end{rust}
1511
1512The @vec@ macro (using @Vec@ type) provides dynamically-size dynamically-growable arrays of arrays only using the heap (\CC @vector@ type).
1513\begin{cquote}
1514\setlength{\tabcolsep}{10pt}
1515\begin{tabular}{@{}ll@{}}
1516\multicolumn{1}{c}{Rust} &\multicolumn{1}{c}{\CC} \\
1517\begin{rust}
1518let (rows, cols) = (4, 6);
1519let mut matrix = vec![vec![0; cols]; rows];
1520... matrix[r][c] = r + c; // fill matrix
1521\end{rust}
1522&
1523\begin{c++}
1524int rows = 4, cols = 6;
1525vector<vector<int>> matrix( rows, vector<int>(cols) );
1526... matrix[r][c] = r + c; // fill matrix}
1527\end{c++}
1528\end{tabular}
1529\end{cquote}
1530A dynamically-size array is sliced the same as a fixed-size one.
1531\begin{rust}
1532let mut slice3: &[usize] = &matrix[3][2 ..= 4]; $\C{// [5, 6, 7]}$
1533slice3 = &matrix[1 ..= 3][1]; $\C{// [2, 3, 4, 5, 6, 7]}$
1534\end{rust}
1535Finally, to mitigate the restriction of matching array dimensions between argument and parameter types, it is possible for a parameter to be a slice.
1536\begin{rust}
1537fn zero( arr: @& mut [usize]@ ){
1538 for i in 0 .. arr.len() { arr[i] = 0; }
1539}
1540zero( & mut ia[0..5] ); // arbitrary sized slice
1541zero( & mut ia[0..3] );
1542\end{rust}
1543Or write a \emph{generic} function taking an array of fixed-element type and any size.
1544\begin{rust}
1545fn aprint<@const N: usize@>( arg: [usize; N] ) {
1546 for r in 0 .. arg.len() { print!( "{} ", arg[r] ); }
1547}
1548aprint( ia );
1549\end{rust}
1550
1551
1552\subsection{Java}
1553\label{JavaCompare}
1554
1555Java arrays are references, so multi-dimension arrays are arrays-of-arrays \see{\VRef{toc:mdimpl}}.
1556For each array, Java implicitly stores the array dimension in a descriptor, supporting array length, subscript checking, and allowing dynamically-sized array-parameter declarations.
1557\begin{cquote}
1558\begin{tabular}{rl}
1559C & @void f( size_t n, size_t m, float x[n][m] );@ \\
1560Java & @void f( float x[][] );@
1561\end{tabular}
1562\end{cquote}
1563However, in the C prototype, the parameters @n@ and @m@ are manually managed, \ie there is no guarantee they match with the argument matrix for parameter @x@.
1564\VRef[Figure]{f:JavaVsCTriangularMatrix} compares a triangular matrix (array-of-arrays) in dynamically safe Java to unsafe C.
1565Each dynamically sized row in Java stores its dimension, while C requires the programmer to manage these sizes explicitly (@rlnth@).
1566All subscripting is Java has bounds checking, while C has none.
1567Both Java and C require explicit null checking, otherwise there is a runtime failure.
1568
1569\begin{figure}
1570\centering
1571\begin{lrbox}{\myboxA}
1572\begin{java}
1573int m[][] = { // triangular matrix
1574 new int [4],
1575 new int [3],
1576 new int [2],
1577 new int [1],
1578 null
1579};
1580
1581for ( int r = 0; r < m.length; r += 1 ) {
1582 if ( m[r] == null ) continue;
1583 for ( int c = 0; c < m[r].length; c += 1 ) {
1584 m[r][c] = c + r; // subscript checking
1585 }
1586
1587}
1588
1589for ( int r = 0; r < m.length; r += 1 ) {
1590 if ( m[r] == null ) {
1591 System.out.println( "null row" );
1592 continue;
1593 }
1594 for ( int c = 0; c < m[r].length; c += 1 ) {
1595 System.out.print( m[r][c] + " " );
1596 }
1597 System.out.println();
1598
1599}
1600\end{java}
1601\end{lrbox}
1602
1603\begin{lrbox}{\myboxB}
1604\begin{cfa}
1605int * m[5] = { // triangular matrix
1606 calloc( 4, sizeof(int) ),
1607 calloc( 3, sizeof(int) ),
1608 calloc( 2, sizeof(int) ),
1609 calloc( 1, sizeof(int) ),
1610 NULL
1611};
1612int rlnth = 4;
1613for ( int r = 0; r < 5; r += 1 ) {
1614 if ( m[r] == NULL ) continue;
1615 for ( int c = 0; c < rlnth; c += 1 ) {
1616 m[r][c] = c + r; // no subscript checking
1617 }
1618 rlnth -= 1;
1619}
1620rlnth = 4;
1621for ( int r = 0; r < 5; r += 1 ) {
1622 if ( m[r] == NULL ) {
1623 printf( "null row\n" );
1624 continue;
1625 }
1626 for ( int c = 0; c < rlnth; c += 1 ) {
1627 printf( "%d ", m[r][c] );
1628 }
1629 printf( "\n" );
1630 rlnth -= 1;
1631}
1632\end{cfa}
1633\end{lrbox}
1634
1635\subfloat[Java]{\label{f:JavaTriangularMatrix}\usebox\myboxA}
1636\hspace{6pt}
1637\vrule
1638\hspace{6pt}
1639\subfloat[C]{\label{f:CTriangularMatrix}\usebox\myboxB}
1640\hspace{6pt}
1641
1642\caption{Triangular Matrix}
1643\label{f:JavaVsCTriangularMatrix}
1644\end{figure}
1645
1646The downside of the arrays-of-arrays approach is performance due to pointer chasing versus pointer arithmetic for a contiguous arrays.
1647Furthermore, there is the cost of managing the implicit array descriptor.
1648It is unlikely that a JIT can dynamically rewrite an arrays-of-arrays form into a contiguous form.
1649
1650
1651\subsection{\CC}
1652\label{CppCompare}
1653
1654Because C arrays are difficult and dangerous, the mantra for \CC programmers is to use @std::vector@ in place of the C array.
1655While the vector size can grow and shrink dynamically, \vs an unchanging dynamic size with VLAs, the cost of this extra feature is mitigated by preallocating the maximum size (like the VLA) at the declaration.
1656So, it costs one upfront dynamic allocation and avoids growing the array through pushing.
1657\begin{c++}
1658vector< vector< int > > m( 5, vector<int>(8) ); // initialize size of 5 x 8 with 6 dynamic allocations
1659\end{c++}
1660Multidimensional arrays are arrays-of-arrays with associated costs.
1661Each @vector@ array has an array descriptor containing the dimension, which allows bound checked using @x.at(i)@ in place of @x[i]@.
1662Used with these restrictions, out-of-bound accesses are caught, and in-bound accesses never exercise the vector's ability to grow, preventing costly reallocate-and-copy, and never invalidating references to contained values.
1663
1664This scheme matches a Java array's safety and expressiveness exactly, with the same inherent costs.
1665Notably, a \CC vector of vectors does not provide contiguous element storage (even when upfront allocation is done carefully) because a vector puts its elements in an auxiliary allocation.
1666So, in spite of @vector< vector< int > >@ appearing to be ``everything by value,'' it is still a first array whose elements include pointers to further arrays.
1667
1668\CC has options for working with memory-adjacent data in desirable ways, particularly in recent revisions.
1669But none makes an allocation with a dynamically given fixed size less awkward than the vector arrangement just described.
1670
1671\CC~26 adds @std::inplace_vector@ providing an interesting vector--array hybrid.
1672Like a vector, it lets a user construct elements in a loop, rather than imposing uniform construction.
1673Yet it preserves \lstinline{std::array}'s ability to be entirely stack-allocated, by avoiding an auxiliary elements' allocation.
1674However, it preserves the fundamental limit of \lstinline{std::array}, that the length, being a template parameter, must be a static value.
1675
1676\CC~20's @std::span@ is a view that unifies true arrays, vectors, static sizes and dynamic sizes, under a common API that adds bounds checking.
1677When wrapping a vector, bounds checking occurs on regular subscripting, \ie one need not remember to use @.at@.
1678When wrapping a locally declared fixed-size array, bound communication is implicit.
1679But it has a soundness gap by offering construction from pointer and user-given length.
1680
1681\CC~23's @std::mdspan@ adds multidimensional indexing and reshaping capabilities analogous to those built into \CFA's @array@.
1682Like @span@, it works over multiple underlying container types.
1683But neither @span@ nor @mdspan@ augments the available allocation options.
1684
1685Thus, these options do not offer an allocation with a dynamically given fixed size.
1686And furthermore, they do not provide any improvement to the C flexible array member pattern, for making a dynamic amount of storage contiguous with its header, as do \CFA's accordions.
1687
1688
1689\begin{comment}
1690\subsection{Levels of Dependently Typed Arrays}
1691
1692TODO: fix the position; checked c does not do linear types
1693\CFA's array is the first lightweight application of dependently-typed bound tracking to an extension of C.
1694Other extensions of C that apply dependently-typed bound tracking are heavyweight, in that the bound tracking is part of a linearly-typed ownership-system, which further helps guarantee statically the validity of every pointer deference.
1695These systems, therefore, ask the programmer to convince the type checker that every pointer dereference is valid.
1696\CFA imposes the lighter-weight obligation, with the more limited guarantee, that initially-declared bounds are respected thereafter.
1697
1698\CFA's array is also the first extension of C to use its tracked bounds to generate the pointer arithmetic implied by advanced allocation patterns.
1699Other bound-tracked extensions of C either forbid certain C patterns entirely, or address the problem of \emph{verifying} that the user's provided pointer arithmetic is self-consistent.
1700The \CFA array, applied to accordion structures [TOD: cross-reference] \emph{implies} the necessary pointer arithmetic, generated automatically, and not appearing at all in a user's program.
1701
1702The \CFA array and the field of ``array language'' comparators all leverage dependent types to improve on the expressiveness over C and Java, accommodating examples such as:
1703\begin{itemize}[leftmargin=*]
1704\item a \emph{zip}-style operation that consumes two arrays of equal length
1705\item a \emph{map}-style operation whose produced length matches the consumed length
1706\item a formulation of matrix multiplication, where the two operands must agree on a middle dimension, and where the result dimensions match the operands' outer dimensions
1707\end{itemize}
1708Across this field, this expressiveness is not just an available place to document such assumption, but these requirements are strongly guaranteed by default, with varying levels of statically/dynamically checked and ability to opt out.
1709Along the way, the \CFA array also closes the safety gap (with respect to bounds) that Java has over C.
1710
1711Dependent type systems, considered for the purpose of bound-tracking, can be full-strength or restricted.
1712In a full-strength dependent type system, a type can encode an arbitrarily complex predicate, with bound-tracking being an easy example.
1713The tradeoff of this expressiveness is complexity in the checker, even typically, a potential for its nontermination.
1714In a restricted dependent type system (purposed for bound tracking), the goal is to check helpful properties, while keeping the checker well-behaved; the other restricted checkers surveyed here, including \CFA's, always terminate.
1715[TODO: clarify how even Idris type checking terminates]
1716
1717Idris is a current, general-purpose dependently typed programming language.
1718Length checking is a common benchmark for full dependent type systems.
1719Here, the capability being considered is to track lengths that adjust during the execution of a program, such as when an \emph{add} operation produces a collection one element longer than the one on which it started.
1720[TODO: finish explaining what Data.Vect is and then the essence of the comparison]
1721
1722POINTS:
1723here is how our basic checks look (on a system that does not have to compromise);
1724it can also do these other cool checks, but watch how I can mess with its conservativeness and termination
1725
1726Two contemporary array-centric languages, Dex\cite{arr:dex:long} and Futhark\cite{arr:futhark:tytheory}, contribute similar, restricted dependent types for tracking array length.
1727Unlike \CFA, both are garbage-collected functional languages.
1728Because they are garbage-collected, referential integrity is built-in, meaning that the heavyweight analysis, that \CFA aims to avoid, is unnecessary.
1729So, like \CFA, the checking in question is a lightweight bounds-only analysis.
1730Like \CFA, their checks that are conservatively limited by forbidding arithmetic in the depended-upon expression.
1731
1732
1733
1734The Futhark work discusses the working language's connection to a lambda calculus, with typing rules and a safety theorem proven in reference to an operational semantics.
1735There is a particular emphasis on an existential type, enabling callee-determined return shapes.
1736
1737Dex uses an Ada-style conception of size, embedding quantitative information completely into an ordinary type.
1738
1739Futhark and full-strength dependently typed languages treat array sizes as ordinary values.
1740Futhark restricts these expressions syntactically to variables and constants, while a full-strength dependent system does not.
1741
1742\CFA's hybrid presentation, @forall( [N] )@, has @N@ belonging to the type system, yet no objects of type @[N]@ occur.
1743Belonging to the type system means it is inferred at a call site and communicated implicitly, like in Dex and unlike in Futhark.
1744Having no instances means there is no type for a variable @i@ that constrains @i@ to be in the range for @N@, unlike Dex, [TODO: verify], but like Futhark.
1745
1746If \CFA gets such a system for describing the list of values in a type, then \CFA arrays are poised to move from the Futhark level of expressiveness, up to the Dex level.
1747
1748[TODO: introduce Ada in the comparators]
1749
1750In Ada and Dex, an array is conceived as a function whose domain must satisfy only certain structural assumptions, while in C, \CC, Java, Futhark and \CFA today, the domain is a prefix of the natural numbers.
1751The Ada--Dex generality has aesthetic benefits for certain programmers. For those working on scheduling resources to weekdays:
1752For those who prefer to count from an initial number of their own choosing:
1753
1754This change of perspective also lets us remove ubiquitous dynamic bound checks.
1755[TODO: xref] discusses how automatically inserted bound checks can often be optimized away.
1756But this approach is unsatisfying to a programmer who believes she has written code in which dynamic checks are unnecessary, but now seeks confirmation.
1757To remove the ubiquitous dynamic checking is to say that an ordinary subscript operation is only valid when it can be statically verified to be in-bound (and so the ordinary subscript is not dynamically checked), and an explicit dynamic check is available when the static criterion is impractical to meet.
1758
1759[TODO, fix confusion: Idris has this arrangement of checks, but still the natural numbers as the domain.]
1760
1761The structural assumptions required for the domain of an array in Dex are given by the trait (there, ``interface'') @Ix@, which says that the parameter @n@ is a type (which could take an argument like @weekday@) that provides two-way conversion with the integers and a report on the number of values.
1762Dex's @Ix@ is analogous the @is_enum@ proposed for \CFA above.
1763\begin{cfa}
1764interface Ix n
1765get_size n : Unit -> Int
1766ordinal : n -> Int
1767unsafe_from_ordinal n : Int -> n
1768\end{cfa}
1769
1770Dex uses this foundation of a trait (as an array type's domain) to achieve polymorphism over shapes.
1771This flavour of polymorphism lets a function be generic over how many (and the order of) dimensions a caller uses when interacting with arrays communicated with this function.
1772Dex's example is a routine that calculates pointwise differences between two samples.
1773Done with shape polymorphism, one function body is equally applicable to a pair of single-dimensional audio clips (giving a single-dimensional result) and a pair of two-dimensional photographs (giving a two-dimensional result).
1774In both cases, but with respectively dimensioned interpretations of ``size,'' this function requires the argument sizes to match, and it produces a result of the that size.
1775
1776The polymorphism plays out with the pointwise-difference routine advertising a single-dimensional interface whose domain type is generic.
1777In the audio instantiation, the duration-of-clip type argument is used for the domain.
1778In the photograph instantiation, it's the tuple-type of $ \langle \mathrm{img\_wd}, \mathrm{img\_ht} \rangle $.
1779This use of a tuple-as-index is made possible by the built-in rule for implementing @Ix@ on a pair, given @Ix@ implementations for its elements
1780\begin{cfa}
1781instance {a b} [Ix a, Ix b] Ix (a & b)
1782get_size = \(). size a * size b
1783ordinal = \(i, j). (ordinal i * size b) + ordinal j
1784unsafe_from_ordinal = \o.
1785bs = size b
1786(unsafe_from_ordinal a (idiv o bs), unsafe_from_ordinal b (rem o bs))
1787\end{cfa}
1788% fix mike's syntax highlighter
1789and by a user-provided adapter expression at the call site that shows how to indexing with a tuple is backed by indexing each dimension at a time
1790\begin{cfa}
1791img_trans :: (img_wd,img_ht)=>Real
1792img_trans.(i,j) = img.i.j
1793result = pairwise img_trans
1794\end{cfa}
1795[TODO: cite as simplification of example from https://openreview.net/pdf?id=rJxd7vsWPS section 4]
1796
1797In the case of adapting this pattern to \CFA, my current work provides an adapter from ``successively subscripted'' to ``subscripted by tuple,'' so it is likely that generalizing my adapter beyond ``subscripted by @ptrdiff_t@'' is sufficient to make a user-provided adapter unnecessary.
1798
1799\subsection{Static Safety in C Extensions}
1800\end{comment}
1801
1802
1803\section{Future Work}
1804\label{f:FutureWork}
1805
1806% \subsection{Array Syntax}
1807
1808An important goal is to recast \CFA-style @array(...)@ syntax into C-style array syntax.
1809The proposal (which is partially implemented) is an alternate dimension and subscript syntax for multi-dimension arrays.
1810C multi-dimension and subscripting syntax uses multiple bracketed constants/expressions.
1811\begin{cfa}
1812int m@[2][3]@; // dimension
1813m@[0][1]@ = 3; // subscript
1814\end{cfa}
1815The alternative \CFA syntax is a comma separated list:
1816\begin{cfa}
1817int m@[2, 3]@; // dimension
1818m@[0, 1]@ = 3; // subscript
1819\end{cfa}
1820which should be intuitive to C programmers and is used in mathematics $M_{i,j}$ and other programing languages, \eg PL/I, Fortran.
1821With respect to the dimension expressions, C only allows an assignment expression, not a comma expression.
1822\begin{cfa}
1823 a[i, j];
1824test.c:3:16: error: expected ']' before ',' token
1825\end{cfa}
1826However, there is an ambiguity for a single dimension array, where the syntax for old and new arrays are the same, @int ar[10]@.
1827The solution is to use a terminating comma to denote a \CFA-style single-dimension array.
1828\begin{cfa}
1829int ar[2$\Huge\color{red},$]; // single dimension new array
1830\end{cfa}
1831This syntactic form is also used for the (rare) singleton tuple @[y@{\Large\color{red},}@]@.
1832The extra comma in the dimension is only mildly annoying, and acts as eye-candy differentiating old and new arrays.
1833Hence, \CFA can repurpose the comma expression in this context for a list of dimensions.
1834The ultimate goal is to replace all C arrays with \CFA arrays, establishing a higher level of safety in C programs, and eliminating the need for the terminating comma.
1835With respect to the subscript expression, the comma expression is allowed.
1836However, a comma expression in this context is rare, and is most commonly a (silent) mistake: subscripting a matrix with @m[i, j]@ instead of @m[i][j]@ selects the @j@th row not the @i, j@ element.
1837It is still possible to write @m[(i, j)]@ in the new syntax to achieve the equivalent of the old @m[i, j]@.
1838Internally, the compiler must de-sugar @[i, j, k]@ into @[i][j][k]@ to match with three calls to subscript operators.
1839Note, there is no ambiguity for subscripting a single dimensional array, as the subscript operator selects the correct form from the array type.
1840Currently, @array@ supports the old and new subscript syntax \see{\VRef[Figure]{f:ovhd-treat-src}}, including combinations of new and old, @arr[1, 2][3]@.
1841The new subscript syntax can be extended to C arrays for uniformity, but requires the non-compatible removal of the (rare) comma-expression as a subscript.
1842
1843
1844\begin{comment}
1845\subsection{Range Slicing}
1846
1847\subsection{With a Module System}
1848
1849
1850\subsection{Retire Pointer Arithmetic}
1851
1852
1853\section{\texorpdfstring{\CFA}{Cforall}}
1854
1855XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \\
1856moved from background chapter \\
1857XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \\
1858
1859Traditionally, fixing C meant leaving the C-ism alone, while providing a better alternative beside it.
1860(For later: That's what I offer with array.hfa, but in the future-work vision for arrays, the fix includes helping programmers stop accidentally using a broken C-ism.)
1861
1862\subsection{\texorpdfstring{\CFA}{Cforall} Features Interacting with Arrays}
1863
1864Prior work on \CFA included making C arrays, as used in C code from the wild,
1865work, if this code is fed into @cfacc@.
1866The quality of this this treatment was fine, with no more or fewer bugs than is typical.
1867
1868More mixed results arose with feeding these ``C'' arrays into preexisting \CFA features.
1869
1870A notable success was with the \CFA @alloc@ function,
1871which type information associated with a polymorphic return type
1872replaces @malloc@'s use of programmer-supplied size information.
1873\begin{cfa}
1874// C, library
1875void * malloc( size_t );
1876// C, user
1877struct tm * el1 = malloc( sizeof(struct tm) );
1878struct tm * ar1 = malloc( 10 * sizeof(struct tm) );
1879
1880// CFA, library
1881forall( T * ) T * alloc();
1882// CFA, user
1883tm * el2 = alloc();
1884tm (*ar2)[10] = alloc();
1885\end{cfa}
1886The alloc polymorphic return compiles into a hidden parameter, which receives a compiler-generated argument.
1887This compiler's argument generation uses type information from the left-hand side of the initialization to obtain the intended type.
1888Using a compiler-produced value eliminates an opportunity for user error.
1889
1890...someday... fix in following: even the alloc call gives bad code gen: verify it was always this way; walk back the wording about things just working here; assignment (rebind) seems to offer workaround, as in bkgd-cfa-arrayinteract.cfa
1891
1892Bringing in another \CFA feature, reference types, both resolves a sore spot of the last example, and gives a first example of an array-interaction bug.
1893In the last example, the choice of ``pointer to array'' @ar2@ breaks a parallel with @ar1@.
1894They are not subscripted in the same way.
1895\begin{cfa}
1896ar1[5];
1897(*ar2)[5];
1898\end{cfa}
1899Using ``reference to array'' works at resolving this issue. ...someday... discuss connection with Doug-Lea \CC proposal.
1900\begin{cfa}
1901tm (&ar3)[10] = *alloc();
1902ar3[5];
1903\end{cfa}
1904The implicit size communication to @alloc@ still works in the same ways as for @ar2@.
1905
1906Using proper array types (@ar2@ and @ar3@) addresses a concern about using raw element pointers (@ar1@), albeit a theoretical one.
1907...someday... xref C standard does not claim that @ar1@ may be subscripted,
1908because no stage of interpreting the construction of @ar1@ has it be that ``there is an \emph{array object} here.''
1909But both @*ar2@ and the referent of @ar3@ are the results of \emph{typed} @alloc@ calls,
1910where the type requested is an array, making the result, much more obviously, an array object.
1911
1912The ``reference to array'' type has its sore spots too.
1913...someday... see also @dimexpr-match-c/REFPARAM_CALL@ (under @TRY_BUG_1@)
1914
1915...someday... I fixed a bug associated with using an array as a T. I think. Did I really? What was the bug?
1916\end{comment}
Note: See TracBrowser for help on using the repository browser.