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

Last change on this file since e0350e0 was cecb260, checked in by Peter A. Buhr <pabuhr@…>, 4 months ago

proofread array chapter

  • Property mode set to 100644
File size: 88.2 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, 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.
10
11
12\section{Introduction}
13\label{s:ArrayIntro}
14
15The new \CFA array is declared by instantiating the generic @array@ type,
16much like instantiating any other standard-library generic type (such as \CC @vector@),
17though using a new style of generic parameter.
18\begin{cfa}
19@array( float, 99 )@ x; $\C[2.5in]{// x contains 99 floats}$
20\end{cfa}
21Here, the arguments to the @array@ type are @float@ (element type) and @99@ (dimension).
22When this type is used as a function parameter, the type-system requires the argument is a perfect match.
23\begin{cfa}
24void f( @array( float, 42 )@ & p ) {} $\C{// p accepts 42 floats}$
25f( x ); $\C{// statically rejected: type lengths are different, 99 != 42}$
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}$
39Cforall Runtime error: subscript 1000 exceeds dimension range [0,99) $for$ array 0x555555558020.
40\end{cfa}
41Function @g@ takes an arbitrary type parameter @T@ and an unsigned integer \emph{dimension} @N@.
42The dimension represents a to-be-determined number of elements, managed by the type system, where 0 represents an empty array.
43The type system implicitly infers @float@ for @T@ and @99@ for @N@.
44Furthermore, 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@.
45The call @g( x, 1000 )@ is also accepted at compile time.
46However, the subscript, @x[1000]@, generates a runtime error, because @1000@ is outside the dimension range $[0,99)$ of argument @x@.
47In 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.
48The syntactic form is chosen to parallel other @forall@ forms:
49\begin{cfa}
50forall( @[N]@ ) ... $\C{// dimension}$
51forall( T ) ... $\C{// value datatype}$
52forall( T & ) ... $\C{// opaque datatype}$
53\end{cfa}
54% The notation @array(thing, N)@ is a single-dimensional case, giving a generic type instance.
55
56The generic @array@ type is comparable to the C array type, which \CFA inherits from C.
57Their runtime characteristics are often identical, and some features are available in both.
58For example, assume a caller has an argument that instantiates @N@ with 42.
59\begin{cfa}
60forall( [N] )
61void f( ... ) {
62 float x1[@N@]; $\C{// C array, no subscript checking}$
63 array(float, N) x2; $\C{// \CFA array, subscript checking}\CRT$
64}
65\end{cfa}
66Both of the stack declared array variables, @x1@ and @x2@, have 42 elements, each element being a @float@.
67The two variables have identical size and layout, with no additional ``bookkeeping'' allocations or headers.
68The C array, @x1@, has no subscript checking, while \CFA array, @x2@, does.
69Providing this 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.
70In all following discussion, ``C array'' means types like @x1@ and ``\CFA array'' means types like @x2@.
71
72A future goal is to provide the new @array@ features with syntax approaching C's (declaration style of @x1@).
73Then, the library @array@ type could be removed, giving \CFA a largely uniform array type.
74At present, the C-syntax @array@ is only partially supported, so the generic @array@ is used exclusively in the thesis.
75
76My contributions in this chapter are:
77\begin{enumerate}[leftmargin=*]
78\item A type system enhancement that lets polymorphic functions and generic types be parameterized by a numeric value: @forall( [N] )@.
79\item Provide a dimension/subscript-checked array-type in the \CFA standard library, where the array's length is statically managed and dynamically valued.
80\item Provide argument/parameter passing safety for arrays and subscript safety.
81\item Identify the interesting specific abilities available by the new @array@ type.
82\item Where there is a gap concerning this feature's readiness for prime-time, identification of specific workable improvements that are likely to close the gap.
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, TODO: bash Rust.
95TODO: 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)@ );
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\lstinput{30-43}{hello-array.cfa}
123\lstinput{45-48}{hello-array.cfa}
124\caption{\lstinline{f} Example}
125\label{f:fExample}
126\end{figure}
127
128\VRef[Figure]{f:fExample} shows an example using function @f@, illustrating how dynamic values are fed into the @array@ type.
129Here, the dimension of arrays @x@, @y@, and @result@ is specified from a command-line value, @dim@, and these arrays are allocated on the stack.
130Then 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.
131The program main is run (see figure bottom) with inputs @5@ and @7@ for sequence lengths.
132The loops follow the familiar pattern of using the variable @dim@ to iterate through the arrays.
133Most importantly, the type system implicitly captures @dim@ at the call of @f@ and makes it available throughout @f@ as @N@.
134The 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@.
135Except 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.
136The result is a significant improvement in safety and usability.
137
138In summary:
139\begin{itemize}[leftmargin=*]
140\item
141@[N]@ within a @forall@ declares the type variable @N@ to be a managed length.
142\item
143@N@ can be used in an expression with type @size_t@ within the function body.
144\item
145The value of an @N@-expression is the acquired length, derived from the usage site, \ie generic declaration or function call.
146\item
147@array( thing, N0, N1, ... )@ is a multi-dimensional type wrapping $\prod_i N_i$ adjacent occurrences of @thing@-typed objects.
148\end{itemize}
149
150\VRef[Figure]{f:TemplateVsGenericType} shows @N@ is not the same as a @size_t@ declaration in a \CC \lstinline[language=C++]{template}.
151\begin{enumerate}[leftmargin=*]
152\item
153The \CC template @N@ can only be a compile-time value, while the \CFA @N@ may be a runtime value.
154\item
155\CC does not allow a template function to be nested, while \CFA lets its polymorphic functions to be nested.
156Hence, \CC precludes a simple form of information hiding.
157\item
158\label{p:DimensionPassing}
159The \CC template @N@ must be passed explicitly at the call, unless @N@ has a default value, even when \CC can deduct the type of @T@.
160The \CFA @N@ is part of the array type and passed implicitly at the call.
161% fixed by comparing to std::array
162% mycode/arrr/thesis-examples/check-peter/cs-cpp.cpp, v2
163\item
164\CC cannot have an array of references, but can have an array of @const@ pointers.
165\CC has a (mistaken) belief that references are not objects, but pointers are objects.
166In the \CC example, the arrays fall back on C arrays, which have a duality with references with respect to automatic dereferencing.
167The \CFA array is a contiguous object with an address, which can be stored as a reference or pointer.
168% not really about forall-N vs template-N
169% any better CFA support is how Rob left references, not what Mike did to arrays
170% https://stackoverflow.com/questions/1164266/why-are-arrays-of-references-illegal
171% https://stackoverflow.com/questions/922360/why-cant-i-make-a-vector-of-references
172\item
173\label{p:ArrayCopy}
174C/\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).
175% fixed by comparing to std::array
176% mycode/arrr/thesis-examples/check-peter/cs-cpp.cpp, v10
177\end{enumerate}
178The \CC template @array@ type mitigates points \VRef[]{p:DimensionPassing} and \VRef[]{p:ArrayCopy}, but it is also trying to accomplish a similar mechanism to \CFA @array@.
179
180\begin{figure}
181\begin{tabular}{@{}l@{\hspace{20pt}}l@{}}
182\begin{c++}
183
184@template< typename T, size_t N >@
185void copy( T ret[@N@], T x[@N@] ) {
186 for ( int i = 0; i < N; i += 1 ) ret[i] = x[i];
187}
188int main() {
189
190 int ret[10], x[10];
191 for ( int i = 0; i < 10; i += 1 ) x[i] = i;
192 @copy<int, 10 >( ret, x );@
193 for ( int i = 0; i < 10; i += 1 )
194 cout << ret[i] << ' ';
195 cout << endl;
196}
197\end{c++}
198&
199\begin{cfa}
200int main() {
201 @forall( T, [N] )@ // nested function
202 void copy( array( T, @N@ ) & ret, array( T, @N@ ) & x ) {
203 for ( i; N ) ret[i] = x[i];
204 }
205
206 const int n = promptForLength();
207 array( int, n ) ret, x;
208 for ( i; n ) x[i] = i;
209 @copy( ret, x );@
210 for ( i; n )
211 sout | ret[i] | nonl;
212 sout | nl;
213}
214\end{cfa}
215\end{tabular}
216\caption{\lstinline{N}-style parameters, for \CC template \vs \CFA generic type }
217\label{f:TemplateVsGenericType}
218\end{figure}
219
220Just as the first example in \VRef[Section]{s:ArrayIntro} shows a compile-time rejection of a length mismatch,
221so are length mismatches stopped when they involve dimension parameters.
222While \VRef[Figure]{f:fExample} shows successfully calling a function @f@ expecting two arrays of the same length,
223\begin{cfa}
224array( bool, N ) & f( array( float, N ) &, array( float, N ) & );
225\end{cfa}
226a static rejection occurs when attempting to call @f@ with arrays of differing lengths.
227\lstinput[tabsize=1]{70-74}{hello-array.cfa}
228When the argument lengths themselves are statically unknown,
229the static check is conservative and, as always, \CFA's casting lets the programmer use knowledge not shared with the type system.
230\begin{tabular}{@{\hspace{0.5in}}l@{\hspace{1in}}l@{}}
231\lstinput{90-97}{hello-array.cfa}
232&
233\lstinput{110-117}{hello-array.cfa}
234\end{tabular}
235
236\noindent
237This static check's full rules are presented in \VRef[Section]{s:ArrayTypingC}.
238
239Orthogonally, the \CFA array type works within generic \emph{types}, \ie @forall@-on-@struct@.
240The same argument safety and the associated implicit communication of array length occurs.
241Preexisting \CFA allowed aggregate types to be generalized with type parameters, enabling parameterizing of element types.
242This has been extended to allow parameterizing by dimension.
243Doing so gives a refinement of C's ``flexible array member''~\cite[\S~6.7.2.1.18]{C11}.
244\begin{cfa}
245struct S {
246 ...
247 double d []; // incomplete array type => flexible array member
248} * s = malloc( sizeof( struct S ) + sizeof( double [10] ) );
249\end{cfa}
250which creates a VLA of size 10 @double@s at the end of the structure.
251A C flexible array member can only occur at the end of a structure;
252\CFA allows length-parameterized array members to be nested at arbitrary locations, with intervening member declarations.
253\lstinput{10-15}{hello-accordion.cfa}
254The structure has course- and student-level metatdata (their respective field names) and a position-based preferences' matrix.
255Its layout has the starting offset of @studentIds@ varying according to the generic parameter @C@, and the offset of @preferences@ varying according to both generic parameters.
256
257\VRef[Figure]{f:checkExample} shows a program main using @School@ and results with different array sizes.
258The @school@ variable holds many students' course-preference forms.
259It is on the stack and its initialization does not use any casting or size arithmetic.
260Both of these points are impossible with a C flexible array member.
261When heap allocation is preferred, the original pattern still applies.
262\begin{cfa}
263School( classes, students ) * sp = alloc();
264\end{cfa}
265This ability to avoid casting and size arithmetic improves safety and usability over C flexible array members.
266Finally, inputs and outputs are given at the bottom for different sized schools.
267The example program prints the courses in each student's preferred order, all using the looked-up display names.
268
269\begin{figure}
270\begin{cquote}
271\lstinput{50-55}{hello-accordion.cfa}
272\lstinput{90-98}{hello-accordion.cfa}
273\ \\
274@$ cat school1@
275\lstinput{}{school1}
276
277@$ ./a.out < school1@
278\lstinput{}{school1.out}
279
280@$ cat school2@
281\lstinput{}{school2}
282
283@$ ./a.out < school2@
284\lstinput{}{school2.out}
285\end{cquote}
286
287\caption{\lstinline{School} Example, Input and Output}
288\label{f:checkExample}
289\end{figure}
290
291When a function operates on a @School@ structure, the type system handles its memory layout transparently.
292\lstinput{30-37}{hello-accordion.cfa}
293In the example, function @getPref@ returns, for the student at position @is@, what is the position of their @pref@\textsuperscript{th}-favoured class?
294
295
296\section{Dimension Parameter Implementation}
297
298The core of the preexisting \CFA compiler already had the ``heavy equipment'' needed to provide the feature set just reviewed (up to bugs in cases not yet exercised).
299To apply this equipment in tracking array lengths, I encoded a dimension (array's length) as a type.
300The type in question does not describe any data that the program actually uses at runtime.
301It simply carries information through intermediate stages of \CFA-to-C lowering.
302And this type takes a form such that, once \emph{it} gets lowered, the result does the right thing.
303This 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.
304
305Furthermore, the @array@ type itself is really ``icing on the cake.''
306Presenting its full version is deferred until \VRef[Section]{s:ArrayMdImpl}
307(where added complexity needed for multiple dimensions is considered).
308But simplifications close enough for the present discussion are:
309\begin{cfa}
310forall( [N] )
311struct array_1d_float {
312 float items[N];
313};
314forall( T, [N] )
315struct array_1d_T {
316 T items[N];
317};
318\end{cfa}
319These two structure patterns, plus a subscript operator, is all that @array@ provides.
320My main work is letting a programmer define such a structure (one whose type is parameterized by @[N]@) and functions that operate on it (these being similarly parameterized).
321
322The repurposed heavy equipment is
323\begin{itemize}[leftmargin=*]
324\item
325 Resolver provided values for a used declaration's type-system variables, gathered from type information in scope at the usage site.
326\item
327 The box pass, encoding information about type parameters into ``extra'' regular parameters/arguments on declarations and calls.
328 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.
329\end{itemize}
330
331The rules for resolution had to be restricted slightly, in order to achieve important refusal cases.
332This work is detailed in \VRef[Section]{s:ArrayTypingC}.
333However, the resolution--boxing scheme, in its preexisting state, was already equipped to work on (desugared) dimension parameters.
334The following discussion explains the desugaring and how correctly lowered code results.
335
336A simpler structure, and a toy function on it, demonstrate what is needed for the encoding.
337\begin{cfa}
338forall( [@N@] ) { $\C{// [1]}$
339 struct thing {};
340 void f( thing(@N@) ) { sout | @N@; } $\C{// [2], [3]}$
341}
342int main() {
343 thing( @10@ ) x; f( x ); $\C{// prints 10, [4]}$
344 thing( @100@ ) y; f( y ); $\C{// prints 100}$
345}
346\end{cfa}
347This example has:
348\begin{enumerate}[leftmargin=*]
349\item
350 The symbol @N@ being declared as a type variable (a variable of the type system).
351\item
352 The symbol @N@ being used to parameterize a type.
353\item
354 The symbol @N@ being used as an expression (value).
355\item
356 A value like 10 being used as an argument to the parameter @N@.
357\end{enumerate}
358The chosen solution is to encode the value @N@ \emph{as a type}, so items 1 and 2 are immediately available for free.
359Item 3 needs a way to recover the encoded value from a (valid) type (and to reject invalid types occurring here).
360Item 4 needs a way to produce a type that encodes the given value.
361
362Because the box pass handles a type's size as its main datum, the encoding is chosen to use it.
363The production and recovery are then straightforward.
364\begin{itemize}[leftmargin=*]
365\item
366 The value $n$ is encoded as a type whose size is $n$.
367\item
368 Given a dimension expression $e$, produce an internal type @char[@$e$@]@ to represent it.
369 If $e$ evaluates to $n$ then the encoded type has size $n$.
370\item
371 Given a type $T$ (produced by these rules), recover the value that it represents with the expression @sizeof(@$T$@)@.
372 If $T$ has size $n$ then the recovery expression evaluates to $n$.
373\end{itemize}
374
375This desugaring is applied in a translation step before the resolver.
376The ``validate'' pass hosts it, along with several other canonicalizing and desugaring transformations (the pass's name notwithstanding).
377The running example is lowered to:
378\begin{cfa}
379forall( @N *@ ) { $\C{// [1]}$
380 struct thing {};
381 void f( thing(@N@) ) { sout | @sizeof(N)@; } $\C{// [2], [3]}$
382}
383int main() {
384 thing( @char[10]@ ) x; f( x ); $\C{// prints 10, [4]}$
385 thing( @char[100]@ ) y; f( y ); $\C{// prints 100}$
386}
387\end{cfa}
388Observe:
389\begin{enumerate}[leftmargin=*]
390\item
391 @N@ is now declared to be a type.
392 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.
393\item
394 @thing(N)@ is a type; the argument to the generic @thing@ is a type (type variable).
395\item
396 The @sout...@ expression (being an application of the @?|?@ operator) has a second argument that is an ordinary expression.
397\item
398 The type of variable @x@ is another @thing(-)@ type; the argument to the generic @thing@ is a type (array type of bytes, @char[@$e$@]@).
399\end{enumerate}
400
401From this point, preexisting \CFA compilation takes over lowering it the rest of the way to C.
402Here the result shows only the relevant changes of the box pass (as informed by the resolver), leaving the rest unadulterated:
403\begin{cfa}
404// [1]
405void f( size_t __sizeof_N, @void *@ ) { sout | @__sizeof_N@; } $\C{// [2], [3]}$
406int main() {
407 struct __conc_thing_10 {} x; f( @10@, &x ); $\C{// prints 10, [4]}$
408 struct __conc_thing_100 {} y; f( @100@, &y ); $\C{// prints 100}$
409}
410\end{cfa}
411Observe:
412\begin{enumerate}[leftmargin=*]
413\item
414 The type parameter @N@ is gone.
415\item
416 The type @thing(N)@ is (replaced by @void *@, but thereby effectively) gone.
417\item
418 The @sout...@ expression (being an application of the @?|?@ operator) has a regular variable (parameter) usage for its second argument.
419\item
420 Information about the particular @thing@ instantiation (value 10) is moved, from the type, to a regular function-call argument.
421\end{enumerate}
422At the end of the desugaring and downstream processing, the original C idiom of ``pass both a length parameter and a pointer'' has been reconstructed.
423In the programmer-written form, only the @thing@ is passed.
424The compiler's action produces the more complex form, which if handwritten, would be error-prone.
425
426At the compiler front end, the parsing changes AST schema extensions and validation rules for enabling the sugared user input.
427\begin{itemize}[leftmargin=*]
428\item
429 Recognize the form @[N]@ as a type-variable declaration within a @forall@.
430\item
431 Have the new brand of type-variable, \emph{Dimension}, in the AST form of a type-variable, to represent one parsed from @[-]@.
432\item
433 Allow a type variable to occur in an expression. Validate (after parsing) that only dimension-branded type-variables are used here.
434\item
435 Allow an expression to occur in type-argument position. Brand the resulting type argument as a dimension.
436\item
437 Validate (after parsing), on a generic-type usage, \eg the type part of the declaration
438 \begin{cfa}
439 array_1d( foo, bar ) x;
440 \end{cfa}
441 \vspace*{-10pt}
442 that the brands on the generic arguments match the brands of the declared type variables.
443 Here, that @foo@ is a type and @bar@ is a dimension.
444\end{itemize}
445
446
447\section{Typing of C Arrays}
448\label{s:ArrayTypingC}
449
450Essential in giving a guarantee of accurate length is the compiler's ability to reject a program that presumes to mishandle length.
451By contrast, most discussion so far deals with communicating length, from one party who knows it, to another willing to work with any given length.
452For scenarios where the concern is a mishandled length, the interaction is between two parties who both claim to know something about it.
453
454C and \CFA can check when working with two static values.
455\begin{cfa}
456enum { n = 42 };
457float x[@n@]; // or just 42
458float (*xp1)[@42@] = &x; // accept
459float (*xp2)[@999@] = &x; // reject
460warning: initialization of 'float (*)[999]' from incompatible pointer type 'float (*)[42]'
461\end{cfa}
462When a variable is involved, C and \CFA take two different approaches.
463Today's C compilers accept the following without warning.
464\begin{cfa}
465static const int n = 42;
466float x[@n@];
467float (* xp)[@999@] = &x; $\C{// should be static rejection here}$
468(*xp)[@500@]; $\C{// in "bound"?}$
469\end{cfa}
470Here, the array @x@ has length 42, while a pointer to it (@xp@) claims length 999.
471So, while the subscript of @xp@ at position 500 is out of bound with its referent @x@,
472the access appears in-bound of the type information available on @xp@.
473In fact, length is being mishandled in the previous step, where the type-carried length information on @x@ is not compatible with that of @xp@.
474
475In \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:
476\begin{cfa}
477static const int n = 42;
478array( float, @n@ ) x;
479array( float, @999@ ) * xp = &x; $\C{// static rejection here}$
480(*xp)[@500@]; $\C{// runtime check passes}$
481\end{cfa}
482The way the \CFA array is implemented, the type analysis for this case reduces to a case similar to the earlier C version.
483The \CFA compiler's compatibility analysis proceeds as:
484\begin{itemize}[parsep=0pt]
485\item
486 Is @array( float, 999 )@ type-compatible with @array( float, n )@?
487\item
488 Is desugared @array( float, char[999] )@ type-compatible with desugared @array( float, char[n] )@?
489% \footnote{
490% Here, \lstinline{arrayX} represents the type that results from desugaring the \lstinline{array} type into a type whose generic parameters are all types.
491% This presentation elides the noisy fact that \lstinline{array} is actually a macro for something bigger;
492% the reduction to \lstinline{char [-]} still proceeds as sketched.}
493\item
494 Is internal type @char[999]@ type-compatible with internal type @char[n]@?
495\end{itemize}
496The answer is false because, in general, the value of @n@ is unknown at compile time, and hence, an error is raised.
497For safety, it makes sense to reject the corresponding C case, which is a non-backwards compatible change.
498There are two mitigations for this incompatibility.
499
500First, a simple recourse is available in a situation where @n@ is \emph{known} to be 999 by using a cast.
501\begin{cfa}
502float (* xp)[999] = @(float (*)[999])@&x;
503\end{cfa}
504The cast means the programmer has accepted blame.
505Moreover, the cast is ``eye candy'' marking where the unchecked length knowledge is used.
506Therefore, 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.
507Second, the incompatibility only affects types like pointer-to-array, which are infrequently used in C.
508The 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{
509 Notably, the desugaring of the \lstinline{array} type avoids letting any \lstinline{-[-]} type decay,
510 in order to preserve the length information that powers runtime bound-checking.}
511Therefore, the need to upgrade legacy C code is low.
512Finally, if this incompatibility is a problem onboarding C programs to \CFA, it is 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.
513
514To handle two occurrences of the same variable, more information is needed, \eg, this is fine,
515\begin{cfa}
516int n = 42;
517float x[@n@];
518float (*xp)[@n@] = x; // accept
519\end{cfa}
520where @n@ remains fixed across a contiguous declaration context.
521However, intervening dynamic statement cause failures.
522\begin{cfa}
523int n = 42;
524float x[@n@];
525@n@ = 999; // dynamic change
526float (*xp)[@n@] = x; // reject
527\end{cfa}
528However, side-effects can occur in a contiguous declaration context.
529\begin{cquote}
530\setlength{\tabcolsep}{20pt}
531\begin{tabular}{@{}ll@{}}
532\begin{cfa}
533// compile unit 1
534extern int @n@;
535extern float g();
536void f() {
537 float x[@n@] = { g() };
538 float (*xp)[@n@] = x; // reject
539}
540\end{cfa}
541&
542\begin{cfa}
543// compile unit 2
544int @n@ = 42;
545void g() {
546 @n@ = 99;
547}
548
549
550\end{cfa}
551\end{tabular}
552\end{cquote}
553The issue here is that knowledge needed to make a correct decision is hidden by separate compilation.
554Even within a translation unit, static analysis might not be able to provide all the information.
555However, if the example uses @const@, the check is possible.
556\begin{cquote}
557\setlength{\tabcolsep}{20pt}
558\begin{tabular}{@{}ll@{}}
559\begin{cfa}
560// compile unit 1
561extern @const@ int n;
562extern float g();
563void f() {
564 float x[n] = { g() };
565 float (*xp)[n] = x; // reject
566}
567\end{cfa}
568&
569\begin{cfa}
570// compile unit 2
571@const@ int n = 42;
572void g() {
573 @n = 99@; // allowed
574}
575
576
577\end{cfa}
578\end{tabular}
579\end{cquote}
580
581In summary, the new rules classify expressions into three groups:
582\begin{description}
583\item[Statically Evaluable]
584 Expressions for which a specific value can be calculated (conservatively) at compile-time.
585 A preexisting \CFA compiler module defines which literals, enumerators, and expressions qualify and evaluates them.
586\item[Dynamic but Stable]
587 The value of a variable declared as @const@, including a @const@ parameter.
588\item[Potentially Unstable]
589 The catch-all category. Notable examples include:
590 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-typed variable.
591\end{description}
592Within these groups, my \CFA rules are:
593\begin{itemize}[leftmargin=*]
594\item
595 Accept a Statically Evaluable pair, if both expressions have the same value.
596 Notably, this rule allows a literal to match with an enumeration value, based on the value.
597\item
598 Accept a Dynamic but Stable pair, if both expressions are written out the same, \eg refers to the same variable declaration.
599\item
600 Otherwise, reject.
601 Notably, reject all pairs from the Potentially Unstable group and all pairs that cross groups.
602\end{itemize}
603The traditional C rules are:
604\begin{itemize}[leftmargin=*]
605\item
606 Reject a Statically Evaluable pair, if the expressions have two different values.
607\item
608 Otherwise, accept.
609\end{itemize}
610\VRef[Figure]{f:DimexprRuleCompare} gives a case-by-case comparison of the consequences of these rule sets.
611It demonstrates that the \CFA false alarms occur in the same cases as C treats unsafe.
612It also shows that C-incompatibilities only occur in cases that C treats unsafe.
613
614\begin{figure}
615 \newcommand{\falsealarm}{{\color{blue}\small{*}}}
616 \newcommand{\allowmisuse}{{\color{red}\textbf{!}}}
617
618 \begin{tabular}{@{}l@{\hspace{16pt}}c@{\hspace{8pt}}c@{\hspace{16pt}}c@{\hspace{8pt}}c@{\hspace{16pt}}c}
619 & \multicolumn{2}{c}{\underline{Values Equal}}
620 & \multicolumn{2}{c}{\underline{Values Unequal}}
621 & \\
622 \textbf{Case} & C & \CFA & C & \CFA & Compat. \\
623 Both Statically Evaluable, Same Symbol & Accept & Accept & & & \cmark \\
624 Both Statically Evaluable, Different Symbols & Accept & Accept & Reject & Reject & \cmark \\
625 Both Dynamic but Stable, Same Symbol & Accept & Accept & & & \cmark \\
626 Both Dynamic but Stable, Different Symbols & Accept & Reject\,\falsealarm & Accept\,\allowmisuse & Reject & \xmark \\
627 Both Potentially Unstable, Same Symbol & Accept & Reject\,\falsealarm & Accept\,\allowmisuse & Reject & \xmark \\
628 Any other grouping, Different Symbol & Accept & Reject\,\falsealarm & Accept\,\allowmisuse & Reject & \xmark
629 \end{tabular}
630
631 \medskip
632 \noindent\textbf{Legend}
633 \begin{itemize}[leftmargin=*]
634 \item
635 Each row gives the treatment of a test harness of the form
636 \begin{cfa}
637 float x[ expr1 ];
638 float (*xp)[ expr2 ] = &x;
639 \end{cfa}
640 \vspace*{-10pt}
641 where \lstinline{expr1} and \lstinline{expr2} are meta-variables varying according to the row's Case.
642 Each row's claim applies to other harnesses too, including,
643 \begin{itemize}[leftmargin=*]
644 \item
645 calling a function with a parameter like \lstinline{x} and an argument of the \lstinline{xp} type,
646 \item
647 assignment in place of initialization,
648 \item
649 using references in place of pointers, and
650 \item
651 for the \CFA array, calling a polymorphic function on two \lstinline{T}-typed parameters with \lstinline{&x}- and \lstinline{xp}-typed arguments.
652 \end{itemize}
653 \item
654 Each case's claim is symmetric (swapping \lstinline{expr1} with \lstinline{expr2} has no effect),
655 even though most test harnesses are asymmetric.
656 \item
657 The table treats symbolic identity (Same/Different on rows)
658 apart from value equality (Equal/Unequal on columns).
659 \begin{itemize}[leftmargin=*]
660 \item
661 The expressions \lstinline{1}, \lstinline{0+1} and \lstinline{n}
662 (where \lstinline{n} is a variable with value 1),
663 are all different symbols with the value 1.
664 \item
665 The column distinction expresses ground truth about whether an omniscient analysis should accept or reject.
666 \item
667 The row distinction expresses the simple static factors used by today's analyses.
668 \end{itemize}
669 \item
670 Accordingly, every Reject under Values Equal is a false alarm (\falsealarm),
671 while every Accept under Values Unequal is an allowed misuse (\allowmisuse).
672 \end{itemize}
673
674 \caption{Case comparison for array type compatibility, given pairs of dimension expressions.}
675 \label{f:DimexprRuleCompare}
676\end{figure}
677
678\begin{comment}
679Given that the above check
680\begin{itemize}
681 \item
682 Is internal type @char[999]@ type-compatible with internal type @char[n]@?
683\end{itemize}
684answers false, discussion turns to how I got the \CFA compiler to produce this answer.
685In its preexisting form, the type system had a buggy approximation of the C rules.
686To implement the new \CFA rules, I added one further step.
687\begin{itemize}
688 \item
689 Is @999@ compatible with @n@?
690\end{itemize}
691This question applies to a pair of expressions, where the earlier question applies to types.
692An 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.
693
694% TODO: ensure these compiler implementation matters are treated under \CFA compiler background: type unification, cost calculation, GenPoly.
695
696The relevant technical component of the \CFA compiler is the standard type-unification within the type resolver.
697\begin{cfa}
698example
699\end{cfa}
700I added rules for continuing this unification into expressions that occur within types.
701It 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.)
702An unfortunate fact about the \CFA compiler's preexisting implementation is that type unification suffers from two forms of duplication.
703
704In detail, the first duplication has (many of) the unification rules stated twice.
705As a result, my additions for dimension expressions are stated twice.
706The extra statement of the rules occurs in the @GenPoly@ module, where concrete types like @array( int, 5 )@\footnote{
707 Again, the presentation is simplified
708 by leaving the \lstinline{array} macro unexpanded.}
709are lowered into corresponding C types @struct __conc_array_1234@ (the suffix being a generated index).
710In this case, the struct's definition contains fields that hardcode the argument values of @float@ and @5@.
711The next time an @array( -, - )@ concrete instance is encountered, it checks if the previous @struct __conc_array_1234@ is suitable for it.
712Yes, for another occurrence of @array( int, 5 )@;
713no, for examples like @array( int, 42 )@ or @array( rational(int), 5 )@.
714In the first example, it must reject the reuse hypothesis for a dimension-@5@ and a dimension-@42@ instance.
715
716The second duplication has unification (proper) being invoked at two stages of expression resolution.
717As a result, my added rule set needs to handle more cases than the preceding discussion motivates.
718In the program
719\begin{cfa}
720void @f@( double ); // overload
721forall( T & ) void @f@( T & ); // overload
722void g( int n ) {
723 array( float, n + 1 ) x;
724 f(x); // overloaded
725}
726\end{cfa}
727when 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.
728\PAB{TODO: finish.}
729
730The actual rules for comparing two dimension expressions are conservative.
731To answer, ``yes, consider this pair of expressions to be matching,''
732is to imply, ``all else being equal, allow an array with length calculated by $e_1$
733to be passed to a function expecting a length-$e_2$ array.''\footnote{
734 TODO: Deal with directionality, that I'm doing exact-match, no ``at least as long as,'' no subtyping.
735 Should it be an earlier scoping principle? Feels like it should matter in more places than here.}
736So, a ``yes'' answer must represent a guarantee that both expressions evaluate the
737same result, while a ``no'' can tolerate ``they might, but we're not sure'',
738provided that practical recourses are available
739to let programmers express better knowledge.
740The new rule-set in the current release is, in fact, extremely conservative.
741I chose to keep things simple,
742and allow future needs to drive adding additional complexity, within the new framework.
743
744For 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.
745Rather, the analysis assumes a variable's value can be anything, and so there can be no guarantee that its value is 999.
746So, a variable and a literal can never match.
747
748TODO: Discuss the interaction of this dimension hoisting with the challenge of extra unification for cost calculation
749\end{comment}
750
751The conservatism of the new rule set can leave a programmer needing a recourse, when needing to use a dimension expression whose stability argument is more subtle than current-state analysis.
752This recourse is to declare an explicit constant for the dimension value.
753Consider these two dimension expressions, whose uses are rejected by the blunt current-state rules:
754\begin{cfa}
755void f( int @&@ nr, @const@ int nv ) {
756 float x[@nr@];
757 float (*xp)[@nr@] = &x; // reject: nr varying (no references)
758 float y[@nv + 1@];
759 float (*yp)[@nv + 1@] = &y; // reject: ?+? unpredictable (no functions)
760}
761\end{cfa}
762Yet, both dimension expressions are reused safely.
763The @nr@ reference is never written, not volatile meaning no implicit code (load) between declarations, and control does not leave the function between the uses.
764As well, the build-in @?+?@ function is predictable.
765To make these cases work, the programmer must add the follow constant declarations (cast does not work):
766\begin{cfa}
767void f( int & nr, const int nv ) {
768 @const int nx@ = nr;
769 float x[nx];
770 float (*xp)[nx] = & x; // accept
771 @const int ny@ = nv + 1;
772 float y[ny];
773 float (*yp)[ny] = & y; // accept
774}
775\end{cfa}
776The result is the originally intended semantics,
777achieved by adding a superfluous ``snapshot it as of now'' directive.
778
779The snapshot trick is also used by the \CFA translation, though to achieve a different outcome.
780Rather obviously, every array must be subscriptable, even a bizarre one:
781\begin{cfa}
782array( float, @rand(10)@ ) x;
783x[@0@]; // 10% chance of bound-check failure
784\end{cfa}
785Less obvious is that the mechanism of subscripting is a function call, which must communicate length accurately.
786The bound-check above (callee logic) must use the actual allocated length of @x@, without mistakenly reevaluating the dimension expression, @rand(10)@.
787Adjusting the example to make the function's use of length more explicit:
788\begin{cfa}
789forall( T * )
790void f( T * x ) { sout | sizeof( *x ); }
791float x[ rand(10) ];
792f( x );
793\end{cfa}
794Considering that the partly translated function declaration is, loosely,
795\begin{cfa}
796void f( size_t __sizeof_T, void * x ) { sout | __sizeof_T; }
797\end{cfa}
798the translation calls the dimension argument twice:
799\begin{cfa}
800float x[ rand(10) ];
801f( rand(10), &x );
802\end{cfa}
803The correct form is:
804\begin{cfa}
805size_t __dim_x = rand(10);
806float x[ __dim_x ];
807f( __dim_x, &x );
808\end{cfa}
809Dimension hoisting already existed in the \CFA compiler.
810But its was buggy, particularly with determining, ``Can hoisting the expression be skipped here?'', for skipping this hoisting is clearly desirable in some cases.
811For example, when a programmer has already hoisted to perform an optimization to prelude duplicate code (expression) and/or expression evaluation.
812In the new implementation, these cases are correct, harmonized with the accept/reject criteria.
813
814
815\section{Multidimensional Array Implementation}
816\label{s:ArrayMdImpl}
817
818A multidimensional array implementation has three relevant levels of abstraction, from highest to lowest, where the array occupies \emph{contiguous memory}.
819\begin{enumerate}[leftmargin=*]
820\item
821Flexible-stride memory:
822this model has complete independence between subscripting ordering and memory layout, offering the ability to slice by (provide an index for) any dimension, \eg slice a plane, row, or column, \eg @c[3][*][*]@, @c[3][4][*]@, @c[3][*][5]@.
823\item
824Fixed-stride memory:
825this 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).
826After which, subscripting and memory layout are independent.
827\item
828Explicit-displacement memory:
829this 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 from the start of @x@.
830A programmer must manually build any notion of dimensions using other tools;
831hence, this style is not offering multidimensional arrays \see{\VRef[Figure]{f:FixedVariable} right example}.
832\end{enumerate}
833
834There is some debate as to whether the abstraction point ordering above goes $\{1, 2\} < 3$, rather than my numerically-ordering.
835That is, styles 1 and 2 are at the same abstraction level, with 3 offering a limited set of functionality.
836I chose to build the \CFA style-1 array upon a style-2 abstraction.
837(Justification of the decision follows, after the description of the design.)
838
839Style 3 is the inevitable target of any array implementation.
840The hardware offers this model to the C compiler, with bytes as the unit of displacement.
841C offers this model to its programmer as pointer arithmetic, with arbitrary sizes as the unit.
842Casting 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.
843
844Now stepping 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 even the interface is quite low-level.
845A C/\CFA array interface includes the resulting memory layout.
846The defining requirement of a type-2 system is the ability to slice a column from a column-finest matrix.
847The required memory shape of such a slice is fixed, before any discussion of implementation.
848The 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.
849% TODO: do I have/need a presentation of just this layout, just the semantics of -[all]?
850
851The new \CFA standard-library @array@-datatype supports richer multidimensional features than C.
852The 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.
853Beyond what C's array type offers, the new array brings direct support for working with a noncontiguous array slice, allowing a program to work with dimension subscripts given in a non-physical order.
854
855The 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 stepping across the length-5 coarsely-strided row dimension.
856\par
857\mbox{\lstinput{121-126}{hello-md.cfa}}
858\par\noindent
859The memory layout is 35 contiguous elements with strictly increasing addresses.
860
861A trivial form of slicing extracts a contiguous inner array, within an array-of-arrays.
862As 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.
863This 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@.
864The following is an example slicing a row.
865\lstinput{60-64}{hello-md.cfa}
866\lstinput[aboveskip=0pt]{140-140}{hello-md.cfa}
867
868However, function @print1d@ is asserting too much knowledge about its parameter @r@ for printing either a row slice or a column slice.
869Specifically, declaring the parameter @r@ with type @array@ means that @r@ is contiguous, which is unnecessarily restrictive.
870That is, @r@ need only be of a container type that offers a subscript operator (of type @ptrdiff_t@ $\rightarrow$ @float@) with managed length @N@.
871The new-array library provides the trait @ar@, so-defined.
872With it, the original declaration can be generalized with the same body.
873\lstinput{43-44}{hello-md.cfa}
874\lstinput[aboveskip=0pt]{145-145}{hello-md.cfa}
875The 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.
876In a multi-dimensional subscript operation, any dimension given as @all@ is a placeholder, \ie ``not yet subscripted by a value'', waiting for such a value, implementing the @ar@ trait.
877\lstinput{150-151}{hello-md.cfa}
878
879The example shows @x[2]@ and @x[[2, all]]@ both refer to the same, ``2.*'' slice.
880Indeed, 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]@.
881This 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''.
882That is:
883\begin{cquote}
884\begin{tabular}{@{}cccccl@{}}
885@x[[2,all]][3]@ & $\equiv$ & @x[2][all][3]@ & $\equiv$ & @x[2][3]@ & (here, @all@ is redundant) \\
886@x[[all,3]][2]@ & $\equiv$ & @x[all][3][2]@ & $\equiv$ & @x[2][3]@ & (here, @all@ is effective)
887\end{tabular}
888\end{cquote}
889
890Narrating progress through each of the @-[-][-][-]@\footnote{
891The first ``\lstinline{-}'' is a variable expression and the remaining ``\lstinline{-}'' are subscript expressions.}
892expressions gives, firstly, a definition of @-[all]@, and secondly, a generalization of C's @-[i]@.
893Where @all@ is redundant:
894\begin{cquote}
895\begin{tabular}{@{}ll@{}}
896@x@ & 2-dimensional, want subscripts for coarse then fine \\
897@x[2]@ & 1-dimensional, want subscript for fine; lock coarse == 2 \\
898@x[2][all]@ & 1-dimensional, want subscript for fine \\
899@x[2][all][3]@ & 0-dimensional; lock fine == 3
900\end{tabular}
901\end{cquote}
902Where @all@ is effective:
903\begin{cquote}
904\begin{tabular}{@{}ll@{}}
905@x@ & 2-dimensional, want subscripts for coarse then fine \\
906@x[all]@ & 2-dimensional, want subscripts for fine then coarse \\
907@x[all][3]@ & 1-dimensional, want subscript for coarse; lock fine == 3 \\
908@x[all][3][2]@ & 0-dimensional; lock coarse == 2
909\end{tabular}
910\end{cquote}
911The semantics of @-[all]@ is to dequeue from the front of the ``want subscripts'' list and re-enqueue at its back.
912For example, in a two dimensional matrix, this semantics conceptually transposes the matrix by reversing the subscripts.
913The semantics of @-[i]@ is to dequeue from the front of the ``want subscripts'' list and lock its value to be @i@.
914
915Contiguous arrays, and slices of them, are all represented by the same underlying parameterized type, which includes stride information in its metatdata.
916The \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.
917The running example's @all@-effective step, stated more concretely, is:
918\begin{cquote}
919\begin{tabular}{@{}ll@{}}
920@x@ & : 5 of ( 7 of @float@ each spaced 1 @float@ apart ) each spaced 7 @floats@ apart \\
921@x[all]@ & : 7 of ( 5 of @float@ each spaced 7 @float@s apart ) each spaced 1 @float@ apart
922\end{tabular}
923\end{cquote}
924
925\begin{figure}
926\includegraphics{measuring-like-layout}
927\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.
928The horizontal layout represents contiguous memory addresses while the vertical layout is conceptual.
929The vertical shaded band highlights the location of the targeted element, 2.3.
930Any such vertical slice contains various interpretations of a single address.}
931\label{fig:subscr-all}
932\end{figure}
933
934\VRef[Figure]{fig:subscr-all} shows one element (in the white band) accessed two different ways: as @x[2][3]@ and as @x[all][3][2]@.
935In both cases, subscript 2 selects from the coarser dimension (rows of @x@),
936while subscript 3 selects from the finer dimension (columns of @x@).
937The figure illustrates the value of each subexpression, comparing how numeric subscripting proceeds from @x@, \vs from @x[all]@.
938Proceeding from @x@ gives the numeric indices as coarse then fine, while proceeding from @x[all]@ gives them fine then coarse.
939These two starting expressions, which are the example's only multidimensional subexpressions
940(those that received zero numeric indices so far), are illustrated with vertical steps where a \emph{first} numeric index would select.
941
942The figure's presentation offers an intuition answer to: What is an atomic element of @x[all]@?
943From there, @x[all]@ itself is simply a two-dimensional array, in the strict C sense, of these building blocks.
944An atom (like the bottommost value, @x[all][3][2]@), is the contained value (in the square box)
945and a lie about its size (the left diagonal above it, growing upward).
946An array of these atoms (like the intermediate @x[all][3]@) is just a contiguous arrangement of them, done according to their size;
947call such an array a column.
948A column is almost ready to be arranged into a matrix;
949it is the \emph{contained value} of the next-level building block, but another lie about size is required.
950At first, an atom needs to be arranged as if it were bigger, but now a column needs to be arranged as if it is smaller (the left diagonal above it, shrinking upward).
951These lying columns, arranged contiguously according to their size (as announced) form the matrix @x[all]@.
952Because @x[all]@ takes indices, first for the fine stride, then for the coarse stride, it achieves the requirement of representing the transpose of @x@.
953Yet every time the programmer presents an index, a C-array subscript is achieving the offset calculation.
954
955In the @x[all]@ case, after the finely strided subscript is done (column 3 is selected),
956the locations referenced by the coarse subscript options (rows 0..4) are offset by 3 floats,
957compared with where analogous rows appear when the row-level option is presented for @x@.
958For 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.
959But only the atom 2.3 is storing its value there.
960The rest are lying about (conflicting) claims on this location, but never exercising these alleged claims.
961
962Lying is implemented as casting.
963The arrangement just described is implemented in the structure @arpk@.
964This structure uses one type in its internal field declaration and offers a different type as the return of its subscript operator.
965The 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]@.
966The subscript operator presents what is really inside, by casting to the type below the left diagonal of the lie.
967
968% 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.
969
970Casting, overlapping, and lying are unsafe.
971The mission is to implement a style-1 feature in the type system for safe use by a programmer.
972The offered style-1 system is allowed to be internally unsafe,
973just 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.
974Having a style-1 system relieves the programmer from resorting to unsafe pointer arithmetic when working with noncontiguous slices.
975
976% PAB: repeat from previous paragraph.
977% 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.
978% My casting is unsafe, but I do not do any pointer arithmetic.
979% 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.
980% 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.
981
982% \noindent END: Paste looking for a home
983
984The new-array library defines types and operations that ensure proper elements are accessed soundly in spite of the overlapping.
985The @arpk@ structure and its @-[i]@ operator are defined as:
986\begin{cfa}
987forall(
988 [N], $\C{// length of current dimension}$
989 S & | sized(S), $\C{// masquerading-as}$
990 Timmed &, $\C{// immediate element, often another array}$
991 Tbase & $\C{// base element, \eg float, never array}$
992) { // distribute forall to each element
993 struct arpk {
994 S strides[N]; $\C{// so that sizeof(this) is N of S}$
995 };
996 // expose Timmed, stride by S
997 static inline Timmed & ?[?]( arpk( N, S, Timmed, Tbase ) & a, long int i ) {
998 subcheck( a, i, 0, N );
999 return (Timmed &)a.strides[i];
1000 }
1001}
1002\end{cfa}
1003The private @arpk@ structure (array with explicit packing) is generic over four types: dimension length, masquerading-as, ...
1004This structure's public interface is hidden behind the @array(...)@ macro and the subscript operator.
1005Construction by @array@ initializes the masquerading-as type information to be equal to the contained-element information.
1006Subscripting by @all@ rearranges the order of masquerading-as types to achieve, in general, nontrivial striding.
1007Subscripting 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.
1008
1009An 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, ... )@.
1010In the base case, @array( E_base )@ is just @E_base@.
1011Because this construction uses the same value for the generic parameters @S@ and @E_im@, the resulting layout has trivial strides.
1012
1013Subscripting 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.
1014Expressed as an operation on types, this rotation is:
1015\begin{eqnarray*}
1016suball( arpk(N, S, E_i, E_b) ) & = & enq( N, S, E_i, E_b ) \\
1017enq( N, S, E_b, E_b ) & = & arpk( N, S, E_b, E_b ) \\
1018enq( N, S, arpk(N', S', E_i', E_b), E_b ) & = & arpk( N', S', enq(N, S, E_i', E_b), E_b )
1019\end{eqnarray*}
1020
1021
1022\section{Bound Checks, Added and Removed}
1023
1024\CFA array subscripting is protected with runtime bound checks.
1025The array dependent-typing provides information to the C optimizer allowing it remove many of the bound checks.
1026This section provides a demonstration of the effect.
1027
1028The experiment compares the \CFA array system with the padded-room system [TODO:xref] most typically exemplified by Java arrays, but also reflected in the \CC pattern where restricted vector usage models a checked array.
1029The essential feature of this padded-room system is the one-to-one correspondence between array instances and the symbolic bounds on which dynamic checks are based.
1030The experiment compares with the \CC version to keep access to generated assembly code simple.
1031
1032As a control case, a simple loop (with no reused dimension sizes) is seen to get the same optimization treatment in both the \CFA and \CC versions.
1033When the programmer treats the array's bound correctly (making the subscript ``obviously fine''), no dynamic bound check is observed in the program's optimized assembly code.
1034But when the bounds are adjusted, such that the subscript is possibly invalid, the bound check appears in the optimized assembly, ready to catch an occurrence the mistake.
1035
1036TODO: paste source and assembly codes
1037
1038Incorporating reuse among dimension sizes is seen to give \CFA an advantage at being optimized.
1039The case is naive matrix multiplication over a row-major encoding.
1040
1041TODO: paste source codes
1042
1043
1044\section{Array Lifecycle}
1045
1046An array, like a structure, wraps subordinate objects.
1047Any object type, like @string@, can be an array element or structure member.
1048A 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.
1049Modern programming languages implicitly perform these operations via a type's constructor and destructor.
1050Therefore, \CFA must assure that an array's subordinate objects' lifetime operations are called.
1051Preexisting \CFA mechanisms achieve this requirement, but with poor performance.
1052Furthermore, advanced array users need an exception to the basic mechanism, which does not occur with other aggregates.
1053Hence, arrays introduce subtleties in supporting an element's lifecycle.
1054
1055The preexisting \CFA support for contained-element lifecycle is based on recursive occurrences of the object-type (otype) pseudo-trait.
1056A type is an otype, if it provides a default (parameterless) constructor, copy constructor, assignment operator, and destructor (like \CC).
1057For a structure with otype members, the compiler implicitly generates implementations of the four otype functions for the outer structure.
1058Then the generated default constructor for the outer structure calls the default constructor for each member, and the other otype functions work similarly.
1059For a member that is a C array, these calls occur in a loop for each array element, which even works for VLAs.
1060This 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)@).
1061The \CFA array has the simplified form (similar to one seen before):
1062\begin{cfa}
1063forall( T * ) // non-otype element, no lifecycle functions
1064// forall( T ) // otype element, lifecycle functions asserted
1065struct array5 {
1066 T __items[ 5 ];
1067};
1068\end{cfa}
1069Being a structure with a C-array member, the otype-form declaration @T@ causes @array5( float )@ to be an otype too.
1070But this otype-recursion pattern has a performance issue.
1071\VRef[Figure]{f:OtypeRecursionBlowup} shows the steps to find lifecycle functions, under the otype-recursion pattern, for a cube of @float@:
1072\begin{cfa}
1073array5( array5( array5( float ) ) )
1074\end{cfa}
1075The work needed for the full @float@-cube is 256 leaves.
1076Then the otype-recursion pattern generates helper functions and thunks that are exponential in the number of dimensions.
1077Anecdotal experience is annoyingly slow compile time at three dimensions and unusable at four.
1078
1079%array5(T) offers
1080%1 parameterless ctor, which asks for T to have
1081% 1 parameterless ctor
1082% 2 copy ctor
1083% 3 asgt
1084% 4 dtor
1085%2 copy ctor, which asks for T to have
1086% 1 parameterless ctor
1087% 2 copy ctor
1088% 3 asgt
1089% 4 dtor
1090%3 asgt, which asks for T to have
1091% 1 parameterless ctor
1092% 2 copy ctor
1093% 3 asgt
1094% 4 dtor
1095%4 dtor, which asks for T to have
1096% 1 parameterless ctor
1097% 2 copy ctor
1098% 3 asgt
1099% 4 dtor
1100
1101\begin{figure}
1102\centering
1103\setlength{\tabcolsep}{20pt}
1104\begin{tabular}{@{}lll@{}}
1105\begin{cfa}[deletekeywords={default}]
1106float offers
11071 default ctor
11082 copy ctor
11093 assignment
11104 dtor
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135\end{cfa}
1136&
1137\begin{cfa}[deletekeywords={default}]
1138array5( float ) has
11391 default ctor, using float$'$s
1140 1 default ctor
1141 2 copy ctor
1142 3 assignment
1143 4 dtor
11442 copy ctor, using float$'$s
1145 1 default ctor
1146 2 copy ctor
1147 3 assignment
1148 4 dtor
11493 assignment, using float$'$s
1150 1 default ctor
1151 2 copy ctor
1152 3 assignment
1153 4 dtor
11544 dtor, using float$'$s
1155 1 default ctor
1156 2 copy ctor
1157 3 assignment
1158 4 dtor
1159
1160
1161
1162
1163
1164
1165
1166
1167\end{cfa}
1168&
1169\begin{cfa}[deletekeywords={default}]
1170array5( array5( float ) ) has
11711 default ctor, using array5( float )
1172 1 default ctor, using float$'$s
1173 1 default ctor
1174 2 copy ctor
1175 3 assignment
1176 4 dtor
1177 2 copy ctor, using float$'$s
1178 1 default ctor
1179 2 copy ctor
1180 3 assignment
1181 4 dtor
1182 3 assignment, using float$'$s
1183 1 default ctor
1184 2 copy ctor
1185 3 assignment
1186 4 dtor
1187 4 dtor, using float$'$s
1188 1 default ctor
1189 2 copy ctor
1190 3 assignment
1191 4 dtor
11922 copy ctor, using array5( float )
1193 ... 4 children, 16 leaves
11943 assignment, using array5( float )
1195 ... 4 children, 16 leaves
11964 dtor, using array5( float )
1197 ... 4 children, 16 leaves
1198(64 leaves)
1199\end{cfa}
1200\end{tabular}
1201\caption{Exponential thunk generation under the otype-recursion pattern.
1202 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.
1203 So, each non-leaf line represents a generated thunk and every line represents a search request for the resolver to find a satisfying function.}
1204\label{f:OtypeRecursionBlowup}
1205\end{figure}
1206
1207The issue is that the otype-recursion pattern uses more assertions than needed.
1208For example, @array5( float )@'s default constructor has all four lifecycle assertions about the element type, @float@.
1209However, it only needs @float@'s default constructor, as the other operations are never used.
1210Current work by the \CFA team aims to improve this situation.
1211Therefore, I had to construct a workaround.
1212
1213My 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.
1214\begin{cquote}
1215\setlength{\tabcolsep}{10pt}
1216\begin{tabular}{@{}ll@{}}
1217\begin{cfa}
1218// autogenerated for otype-recursion:
1219forall( T )
1220void ?{}( array5( T ) & this ) {
1221 for ( i; 5 ) { ( this[i] ){}; }
1222}
1223forall( T )
1224void ?{}( array5( T ) & this, array5( T ) & src ) {
1225 for ( i; 5 ) { ( this[i] ){ src[i] }; }
1226}
1227forall( T )
1228void ^?{}( array5( T ) & this ) {
1229 for ( i; 5 ) { ^( this[i] ){}; }
1230}
1231\end{cfa}
1232&
1233\begin{cfa}
1234// lean, bespoke:
1235forall( T* | { void @?{}( T & )@; } )
1236void ?{}( array5( T ) & this ) {
1237 for ( i; 5 ) { ( this[i] ){}; }
1238}
1239forall( T* | { void @?{}( T &, T )@; } )
1240void ?{}( array5( T ) & this, array5( T ) & src ) {
1241 for ( i; 5 ) { ( this[i] ){ src[i] }; }
1242}
1243forall( T* | { void @?{}( T & )@; } )
1244void ^?{}( array5(T) & this ) {
1245 for (i; 5) { ^( this[i] ){}; }
1246}
1247\end{cfa}
1248\end{tabular}
1249\end{cquote}
1250Moreover, the assignment operator is skipped, to avoid hitting a lingering growth case.
1251Temporarily skipping assignment is tolerable because array assignment is not a common operation.
1252With this solution, the critical lifecycle functions are available, with linear growth in thunk creation for the default constructor.
1253
1254Finally, the intuition that a programmer using an array always wants the elements' default constructor called \emph{automatically} is simplistic.
1255Arrays exist to store different values at each position.
1256So, array initialization needs to let the programmer provide different constructor arguments to each element.
1257\begin{cfa}
1258thread worker { int id; };
1259void ?{}( worker & ) = void; // remove default constructor
1260void ?{}( worker &, int id );
1261array( worker, 5 ) ws = @{}@; // rejected; but desire is for no initialization yet
1262for ( i; 5 ) (ws[i]){ @i@ }; // explicitly initialize each thread, giving id
1263\end{cfa}
1264Note the use of the \CFA explicit constructor call, analogous to \CC's placement-@new@.
1265This call is where initialization is desired, and not at the declaration of @ws@.
1266The attempt to initialize from nothing (equivalent to dropping @= {}@ altogether) is invalid because the @worker@ type removes the default constructor.
1267The @worker@ type is designed this way to work with the threading system.
1268A thread type forks a thread at the end of each constructor and joins with it at the start of each destructor.
1269But a @worker@ cannot begin its forked-thread work without knowing its @id@.
1270Therefore, there is a conflict between the implicit actions of the builtin @thread@ type and a user's desire to defer these actions.
1271
1272Another \CFA feature for providing C backwards compatibility, at first seem viable for initializing the array @ws@, though on closer inspection is not.
1273C initialization without a constructor is specified with \lstinline|@=|, \eg \lstinline|array(worker, 5) ws @= {}| ignores all \CFA lifecycle management and uses C empty initialization.
1274This option does achieve the desired semantics on the construction side.
1275But on destruction side, the desired semantics is for implicit destructor calls to continue, to keep the join operation tied to lexical scope.
1276C initialization disables \emph{all} implicit lifecycle management, but the goal is to disable only the implicit construction.
1277
1278To fix this problem, I enhanced the \CFA standard library to provide the missing semantics, available in either form:
1279\begin{cfa}
1280array( @uninit@(worker), 5 ) ws1;
1281array( worker, 5) ws2 = { @delay_init@ };
1282\end{cfa}
1283Both cause the @ws@-construction-time implicit call chain to stop before reaching a @worker@ constructor, while leaving the implicit destruction calls intact.
1284Two forms are available, to parallel the development of this feature in \uCpp~\cite{uC++}.
1285Originally \uCpp offered only the @ws1@ form, using the class-template @uNoCtor@ equivalent to \CFA's @uninit@.
1286More recently, \uCpp was extended with the declaration macro, @uArray@, with usage similar to the @ws2@ case.
1287Based on experience piloting @uArray@ as a replacement of @uNoCtor@, it should be possible to remove the first option.
1288
1289% note to Mike, I have more fragments on some details available in push24\fragments\uNoCtor.txt
1290
1291\section{Array Comparison}
1292
1293
1294\subsection{Rust}
1295
1296A 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]@.
1297\begin{rust}
1298let val = 42;
1299let mut ia: [usize; 5] = [val; 5]; $\C{// mutable, repeated initialization [42, 42, 42, 42, 42]}$
1300let fval = 42.2;
1301let fa: [f64; 5] = [1.2, fval, 5.6, 7.3, 9.1]; $\C{// immutable, individual initialization}$
1302\end{rust}
1303Initialization is required even if the array is subsequently initialized.
1304Rust arrays are not VLAs, but the compile-time length can be queried using member @len()@.
1305Arrays 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.
1306
1307Array iteration is by a range or array variable.
1308\begin{rust}
1309for i in @0..ia.len()@ { print!("{:?} ", ia[i] ); } $\C{// 42 42 42 42 42}$
1310for fv in @fa@ { print!("{:?} ", fv ); } $\C{// 1.2 42.2 5.6 7.3 9.1}$
1311for i in 0..=1 { ia[i] = i; } $\C{// mutable changes}$
1312for iv in ia { print!("{:?} ", iv ); } $\C{// 0 1 42 42 42}$
1313\end{rust}
1314An array can be assigned and printed as a set.
1315\begin{rust}
1316ia = @[5; 5]@; println!( "{:?} {:?}", @ia@, ia.len() ); $\C{// [5, 5, 5, 5, 5] 5}$
1317ia = @[1, 2, 3, 4, 5]@; println!( "{:?} {:?}", @ia@, ia.len() ); $\C{// [1, 2, 3, 4, 5] 5}$
1318\end{rust}
1319
1320Multi-dimensional arrays use nested dimensions, resulting in columns before rows.
1321Here the outer array is a length @ROWS@ array whose elements are @f64@ arrays of length @COLS@ each.
1322\begin{cquote}
1323\setlength{\tabcolsep}{10pt}
1324\begin{tabular}{@{}ll@{}}
1325\begin{rust}
1326const ROWS: usize = 4; const COLS: usize = 6;
1327let mut fmatrix: [[f64; @COLS@]; @ROWS@] = [[0.; @COLS@]; @ROWS@];
1328for r in 0 .. ROWS {
1329 for c in 0 .. COLS { fmatrix[r][c] = r as f64 + c as f64; } }
1330\end{rust}
1331&
1332\begin{rust}
1333[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
1334[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
1335[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]
1336[ 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
1337\end{rust}
1338\end{tabular}
1339\end{cquote}
1340
1341Slices borrow a section of an array (subarray) and have type @&[T]@.
1342A slice has a dynamic size and does not implicitly coerce to an array.
1343\begin{rust}
1344println!( "{:?}", @&ia[0 .. 3]@ ); $\C{// fixed bounds, [1, 2, 3]}$
1345println!( "{:?}", @&ia[ia.len() - 2 .. ia.len()@] ); $\C{// variable bounds, [4, 5]}$
1346println!( "{:?}", @&ia[ia.len() - 2 .. ]@ ); $\C{// drop upper bound, [4, 5]}$
1347println!( "{:?}", @&ia[.. ia.len() - 2 ]@ ); $\C{// drop lower bound, [1, 2, 3]}$
1348println!( "{:?}", @&ia[..]@ ); $\C{// drop both bound, [1, 2, 3, 4, 5]}$
1349\end{rust}
1350A multi-dimensional slice can only borrow subrows because a slice requires contiguous memory.
1351Here columns 2--4 are sliced from row 3.
1352\begin{rust}
1353let mut slice2: &[f64] = &fmatrix[3][@2 ..= 4@];
1354println!( "{:?}", slice2 ); $\C{// [5.0, 6.0, 7.0]}$
1355\end{rust}
1356Here row 2 is sliced from the sub-matrix formed from rows 1--3.
1357\begin{rust}
1358slice2 = &fmatrix[@1 ..= 3@][1];
1359println!( "{:?}", slice2 ); $\C{// [3.0, 4.0, 5.0, 6.0, 7.0, 8.0]}$
1360\end{rust}
1361A slice can be explicitly converted into an array or reference to an array.
1362\begin{rust}
1363let slice: &[f64];
1364slice = &fa[0 ..= 1]; $\C{// create slice, [1.2, 42.2]}$
1365let mut fa2: [f64; 2] = @<[f64; 2]>::try_from( slice ).unwrap()@; $\C{// convert slice to array, [1.2, 42.2]}$
1366fa2 = @(& fa[2 ..= 3]).try_into().unwrap()@; $\C{// convert slice to array, [5.6, 7.3]}$
1367\end{rust}
1368
1369The @vec@ macro (using @Vec@ type) provides dynamically-size dynamically-growable arrays of arrays only using the heap (\CC @vector@ type).
1370\begin{cquote}
1371\setlength{\tabcolsep}{10pt}
1372\begin{tabular}{@{}ll@{}}
1373\multicolumn{1}{c}{Rust} &\multicolumn{1}{c}{\CC} \\
1374\begin{rust}
1375let (rows, cols) = (4, 6);
1376let mut matrix = vec![vec![0; cols]; rows];
1377... matrix[r][c] = r + c; // fill matrix
1378\end{rust}
1379&
1380\begin{c++}
1381int rows = 4, cols = 6;
1382vector<vector<int>> matrix( rows, vector<int>(cols) );
1383... matrix[r][c] = r + c; // fill matrix}
1384\end{c++}
1385\end{tabular}
1386\end{cquote}
1387A dynamically-size array is sliced the same as a fixed-size one.
1388\begin{rust}
1389let mut slice3: &[usize] = &matrix[3][2 ..= 4]; $\C{// [5, 6, 7]}$
1390slice3 = &matrix[1 ..= 3][1]; $\C{// [2, 3, 4, 5, 6, 7]}$
1391\end{rust}
1392Finally, to mitigate the restriction of matching array dimensions between argument and parameter types, it is possible for a parameter to be a slice.
1393\begin{rust}
1394fn zero( arr: @& mut [usize]@ ){
1395 for i in 0 .. arr.len() { arr[i] = 0; }
1396}
1397zero( & mut ia[0..5] ); // arbitrary sized slice
1398zero( & mut ia[0..3] );
1399\end{rust}
1400Or write a \emph{generic} function taking an array of fixed-element type and any size.
1401\begin{rust}
1402fn aprint<@const N: usize@>( arg: [usize; N] ) {
1403 for r in 0 .. arg.len() { print!( "{} ", arg[r] ); }
1404}
1405aprint( ia );
1406\end{rust}
1407
1408
1409\subsection{Java}
1410
1411Java arrays are references, so multi-dimension arrays are arrays-of-arrays \see{\VRef{toc:mdimpl}}.
1412For each array, Java implicitly storages the array dimension in a descriptor, supporting array length, subscript checking, and allowing dynamically-sized array-parameter declarations.
1413\begin{cquote}
1414\begin{tabular}{rl}
1415C & @void f( size_t n, size_t m, float x[n][m] );@ \\
1416Java & @void f( float x[][] );@
1417\end{tabular}
1418\end{cquote}
1419However, 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@.
1420\VRef[Figure]{f:JavaVsCTriangularMatrix} compares a triangular matrix (array-of-arrays) in dynamically safe Java to unsafe C.
1421Each dynamically sized row in Java stores its dimension, while C requires the programmer to manage these sizes explicitly (@rlnth@).
1422All subscripting is Java has bounds checking, while C has none.
1423Both Java and C require explicit null checking, otherwise there is a runtime failure.
1424
1425\begin{figure}
1426\setlength{\tabcolsep}{15pt}
1427\begin{tabular}{ll@{}}
1428\begin{java}
1429int m[][] = { // triangular matrix
1430 new int [4],
1431 new int [3],
1432 new int [2],
1433 new int [1],
1434 null
1435};
1436
1437for ( int r = 0; r < m.length; r += 1 ) {
1438 if ( m[r] == null ) continue;
1439 for ( int c = 0; c < m[r].length; c += 1 ) {
1440 m[r][c] = c + r; // subscript checking
1441 }
1442
1443}
1444
1445for ( int r = 0; r < m.length; r += 1 ) {
1446 if ( m[r] == null ) {
1447 System.out.println( "null row" );
1448 continue;
1449 }
1450 for ( int c = 0; c < m[r].length; c += 1 ) {
1451 System.out.print( m[r][c] + " " );
1452 }
1453 System.out.println();
1454
1455}
1456\end{java}
1457&
1458\begin{cfa}
1459int * m[5] = { // triangular matrix
1460 calloc( 4, sizeof(int) ),
1461 calloc( 3, sizeof(int) ),
1462 calloc( 2, sizeof(int) ),
1463 calloc( 1, sizeof(int) ),
1464 NULL
1465};
1466int rlnth = 4;
1467for ( int r = 0; r < 5; r += 1 ) {
1468 if ( m[r] == NULL ) continue;
1469 for ( int c = 0; c < rlnth; c += 1 ) {
1470 m[r][c] = c + r; // no subscript checking
1471 }
1472 rlnth -= 1;
1473}
1474rlnth = 4;
1475for ( int r = 0; r < 5; r += 1 ) {
1476 if ( m[r] == NULL ) {
1477 printf( "null row\n" );
1478 continue;
1479 }
1480 for ( int c = 0; c < rlnth; c += 1 ) {
1481 printf( "%d ", m[r][c] );
1482 }
1483 printf( "\n" );
1484 rlnth -= 1;
1485}
1486\end{cfa}
1487\end{tabular}
1488\caption{Java (left) \vs C (right) Triangular Matrix}
1489\label{f:JavaVsCTriangularMatrix}
1490\end{figure}
1491
1492The downside of the arrays-of-arrays approach is performance due to pointer chasing versus pointer arithmetic for a contiguous arrays.
1493Furthermore, there is the cost of managing the implicit array descriptor.
1494It is unlikely that a JIT can dynamically rewrite an arrays-of-arrays form into a contiguous form.
1495
1496
1497\subsection{\CC}
1498
1499Because C arrays are difficult and dangerous, the mantra for \CC programmers is to use @std::vector@ in place of the C array.
1500While the vector size can grow and shrink dynamically, \vs a fixed-size dynamic size with VLAs, the cost of this extra feature is mitigated by preallocating the maximum size (like the VLA) at the declaration (one dynamic call) to avoid using @push_back@.
1501\begin{c++}
1502vector< vector< int > > m( 5, vector<int>(8) ); // initialize size of 5 x 8 with 6 dynamic allocations
1503\end{c++}
1504Multidimensional arrays are arrays-of-arrays with associated costs.
1505Each @vector@ array has an array descriptor contain the dimension, which allows bound checked using @x.at(i)@ in place of @x[i]@.
1506Used 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 invalidate references to contained values.
1507This scheme matches Java's safety and expressiveness exactly, but with the inherent costs.
1508
1509
1510\subsection{Levels of Dependently Typed Arrays}
1511
1512\CFA's array is the first lightweight application of dependently-typed bound tracking to an extension of C.
1513Other 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.
1514These systems, therefore, ask the programmer to convince the type checker that every pointer dereference is valid.
1515\CFA imposes the lighter-weight obligation, with the more limited guarantee, that initially-declared bounds are respected thereafter.
1516
1517\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.
1518Other 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.
1519The \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.
1520
1521The \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:
1522\begin{itemize}[leftmargin=*]
1523\item a \emph{zip}-style operation that consumes two arrays of equal length
1524\item a \emph{map}-style operation whose produced length matches the consumed length
1525\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
1526\end{itemize}
1527Across 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.
1528Along the way, the \CFA array also closes the safety gap (with respect to bounds) that Java has over C.
1529
1530Dependent type systems, considered for the purpose of bound-tracking, can be full-strength or restricted.
1531In a full-strength dependent type system, a type can encode an arbitrarily complex predicate, with bound-tracking being an easy example.
1532The tradeoff of this expressiveness is complexity in the checker, even typically, a potential for its nontermination.
1533In 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.
1534[TODO: clarify how even Idris type checking terminates]
1535
1536Idris is a current, general-purpose dependently typed programming language.
1537Length checking is a common benchmark for full dependent type systems.
1538Here, 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.
1539[TODO: finish explaining what Data.Vect is and then the essence of the comparison]
1540
1541POINTS:
1542here is how our basic checks look (on a system that does not have to compromise);
1543it can also do these other cool checks, but watch how I can mess with its conservativeness and termination
1544
1545Two current, state-of-the-art array languages, Dex\cite{arr:dex:long} and Futhark\cite{arr:futhark:tytheory}, offer novel contributions concerning similar, restricted dependent types for tracking array length.
1546Unlike \CFA, both are garbage-collected functional languages.
1547Because they are garbage-collected, referential integrity is built-in, meaning that the heavyweight analysis, that \CFA aims to avoid, is unnecessary.
1548So, like \CFA, the checking in question is a lightweight bounds-only analysis.
1549Like \CFA, their checks that are conservatively limited by forbidding arithmetic in the depended-upon expression.
1550
1551
1552
1553The 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.
1554There is a particular emphasis on an existential type, enabling callee-determined return shapes.
1555
1556
1557Dex uses a novel conception of size, embedding its quantitative information completely into an ordinary type.
1558
1559Futhark and full-strength dependently typed languages treat array sizes are ordinary values.
1560Futhark restricts these expressions syntactically to variables and constants, while a full-strength dependent system does not.
1561
1562\CFA's hybrid presentation, @forall( [N] )@, has @N@ belonging to the type system, yet has no instances.
1563Belonging to the type system means it is inferred at a call site and communicated implicitly, like in Dex and unlike in Futhark.
1564Having 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.
1565
1566If \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.
1567
1568[TODO: introduce Ada in the comparators]
1569
1570In 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.
1571The generality has obvious aesthetic benefits for programmers working on scheduling resources to weekdays, and for programmers who prefer to count from an initial number of their own choosing.
1572
1573This change of perspective also lets us remove ubiquitous dynamic bound checks.
1574[TODO: xref] discusses how automatically inserted bound checks can often be optimized away.
1575But this approach is unsatisfying to a programmer who believes she has written code in which dynamic checks are unnecessary, but now seeks confirmation.
1576To 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.
1577
1578[TODO, fix confusion: Idris has this arrangement of checks, but still the natural numbers as the domain.]
1579
1580The 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.
1581Dex's @Ix@ is analogous the @is_enum@ proposed for \CFA above.
1582\begin{cfa}
1583interface Ix n
1584get_size n : Unit -> Int
1585ordinal : n -> Int
1586unsafe_from_ordinal n : Int -> n
1587\end{cfa}
1588
1589Dex uses this foundation of a trait (as an array type's domain) to achieve polymorphism over shapes.
1590This 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.
1591Dex's example is a routine that calculates pointwise differences between two samples.
1592Done 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).
1593In 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.
1594
1595The polymorphism plays out with the pointwise-difference routine advertising a single-dimensional interface whose domain type is generic.
1596In the audio instantiation, the duration-of-clip type argument is used for the domain.
1597In the photograph instantiation, it's the tuple-type of $ \langle \mathrm{img\_wd}, \mathrm{img\_ht} \rangle $.
1598This 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
1599\begin{cfa}
1600instance {a b} [Ix a, Ix b] Ix (a & b)
1601get_size = \(). size a * size b
1602ordinal = \(i, j). (ordinal i * size b) + ordinal j
1603unsafe_from_ordinal = \o.
1604bs = size b
1605(unsafe_from_ordinal a (idiv o bs), unsafe_from_ordinal b (rem o bs))
1606\end{cfa}
1607and 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
1608\begin{cfa}
1609img_trans :: (img_wd,img_ht)=>Real
1610img_trans.(i,j) = img.i.j
1611result = pairwise img_trans
1612\end{cfa}
1613[TODO: cite as simplification of example from https://openreview.net/pdf?id=rJxd7vsWPS section 4]
1614
1615In 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.
1616
1617\subsection{Static Safety in C Extensions}
1618
1619
1620\section{Future Work}
1621
1622\subsection{Array Syntax}
1623
1624An important goal is to recast @array(...)@ syntax into C-style @[]@.
1625The proposal (which is partially implemented) is an alternate dimension and subscript syntax.
1626C multi-dimension and subscripting syntax uses multiple brackets.
1627\begin{cfa}
1628int m@[2][3]@; // dimension
1629m@[0][1]@ = 3; // subscript
1630\end{cfa}
1631Leveraging this syntax, the following (simpler) syntax should be intuitive to C programmers with only a small backwards compatibility issue.
1632\begin{cfa}
1633int m@[2, 3]@; // dimension
1634m@[0, 1]@ = 3; // subscript
1635\end{cfa}
1636However, the new subscript syntax is not backwards compatible, as @0, 1@ is a comma expression.
1637Interestingly, disallowed the comma expression in this context eliminates an unreported error: subscripting a matrix with @m[i, j]@ instead of @m[i][j]@, which selects the @j@th row not the @i, j@ element.
1638Hence, a comma expression in this context is rare.
1639Finally, it is possible to write @m[(i, j)]@ in the new syntax to achieve the equivalent of the old @m[i, j]@.
1640Note, the new subscript syntax can easily be internally lowered to @[-][-]...@ and handled as regular subscripting.
1641The only ambiguity with C syntax is for a single dimension array, where the syntax for old and new are the same.
1642\begin{cfa}
1643int m[2@,@]; // single dimension
1644m[0] = 3; // subscript
1645\end{cfa}
1646The solution for the dimension is to use a terminating comma to denote a new single-dimension array.
1647This syntactic form is also used for the (rare) singleton tuple @[y@{\color{red},}@]@.
1648The extra comma in the dimension is only mildly annoying, and acts as eye-candy differentiating old and new arrays.
1649The subscript operator is not an issue as overloading selects the correct single-dimension operation for old/new array types.
1650The ultimately 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.
1651
1652
1653\subsection{Range Slicing}
1654
1655\subsection{With a Module System}
1656
1657
1658\subsection{Retire Pointer Arithmetic}
1659
1660
1661\begin{comment}
1662\section{\texorpdfstring{\CFA}{Cforall}}
1663
1664XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \\
1665moved from background chapter \\
1666XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \\
1667
1668Traditionally, fixing C meant leaving the C-ism alone, while providing a better alternative beside it.
1669(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.)
1670
1671\subsection{\texorpdfstring{\CFA}{Cforall} Features Interacting with Arrays}
1672
1673Prior work on \CFA included making C arrays, as used in C code from the wild,
1674work, if this code is fed into @cfacc@.
1675The quality of this this treatment was fine, with no more or fewer bugs than is typical.
1676
1677More mixed results arose with feeding these ``C'' arrays into preexisting \CFA features.
1678
1679A notable success was with the \CFA @alloc@ function,
1680which type information associated with a polymorphic return type
1681replaces @malloc@'s use of programmer-supplied size information.
1682\begin{cfa}
1683// C, library
1684void * malloc( size_t );
1685// C, user
1686struct tm * el1 = malloc( sizeof(struct tm) );
1687struct tm * ar1 = malloc( 10 * sizeof(struct tm) );
1688
1689// CFA, library
1690forall( T * ) T * alloc();
1691// CFA, user
1692tm * el2 = alloc();
1693tm (*ar2)[10] = alloc();
1694\end{cfa}
1695The alloc polymorphic return compiles into a hidden parameter, which receives a compiler-generated argument.
1696This compiler's argument generation uses type information from the left-hand side of the initialization to obtain the intended type.
1697Using a compiler-produced value eliminates an opportunity for user error.
1698
1699TODO: 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
1700
1701Bringing 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.
1702In the last example, the choice of ``pointer to array'' @ar2@ breaks a parallel with @ar1@.
1703They are not subscripted in the same way.
1704\begin{cfa}
1705ar1[5];
1706(*ar2)[5];
1707\end{cfa}
1708Using ``reference to array'' works at resolving this issue. TODO: discuss connection with Doug-Lea \CC proposal.
1709\begin{cfa}
1710tm (&ar3)[10] = *alloc();
1711ar3[5];
1712\end{cfa}
1713The implicit size communication to @alloc@ still works in the same ways as for @ar2@.
1714
1715Using proper array types (@ar2@ and @ar3@) addresses a concern about using raw element pointers (@ar1@), albeit a theoretical one.
1716TODO xref C standard does not claim that @ar1@ may be subscripted,
1717because no stage of interpreting the construction of @ar1@ has it be that ``there is an \emph{array object} here.''
1718But both @*ar2@ and the referent of @ar3@ are the results of \emph{typed} @alloc@ calls,
1719where the type requested is an array, making the result, much more obviously, an array object.
1720
1721The ``reference to array'' type has its sore spots too.
1722TODO see also @dimexpr-match-c/REFPARAM_CALL@ (under @TRY_BUG_1@)
1723
1724TODO: I fixed a bug associated with using an array as a T. I think. Did I really? What was the bug?
1725\end{comment}
Note: See TracBrowser for help on using the repository browser.