\chapter{Array}
\label{c:Array}


\section{Introduction}
\label{s:ArrayIntro}

Arrays 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.
This chapter describes the new \CFA language and library features that introduce a length-checked array type to the \CFA standard library~\cite{Cforall}.

Specifically, a new \CFA array is declared by instantiating the generic @array@ type,
much like instantiating any other standard-library generic type (such as @dlist@),
though using a new style of generic parameter.
\begin{cfa}
@array( float, 99 )@ x;					$\C[2.75in]{// x contains 99 floats}$
\end{cfa}
Here, the arguments to the @array@ type are @float@ (element type) and @99@ (length).
When this type is used as a function parameter, the type-system requires that a call's argument matches, down to the length.
\begin{cfa}
void f( @array( float, 42 )@ & p ) {}	$\C{// p accepts 42 floats}$
f( x );									$\C{// statically rejected: types are different, 99 != 42}$

test2.cfa:3:1 error: Invalid application of existing declaration(s) in expression.
Applying untyped:  Name: f ... to:  Name: x
\end{cfa}
Here, the function @f@'s parameter @p@ is declared with length 42.
The call @f( x )@, with the argument being the previously-declared object, is invalid, because the @array@ lengths @99@ and @42@ do not match.

A function declaration can be polymorphic over these @array@ arguments by using the @forall@ declaration prefix.
This function @g@'s takes arbitrary type parameter @T@ (familiar) and \emph{dimension parameter} @N@ (new).
A dimension paramter represents a to-be-determined count of elements, managed by the type system.
\begin{cfa}
forall( T, @[N]@ )
void g( array( T, @N@ ) & p, int i ) {
	T elem = p[i];						$\C{// dynamically checked: requires 0 <= i < N}$
}
g( x, 0 );								$\C{// T is float, N is 99, dynamic subscript check succeeds}$
g( x, 1000 );							$\C{// T is float, N is 99, dynamic subscript check fails}\CRT$

Cforall Runtime error: subscript 1000 exceeds dimension range [0,99) $for$ array 0x555555558020.
\end{cfa}
The call @g( x, 0 )@ is valid because @g@ accepts any length of array, where the type system infers @float@ for @T@ and length @99@ for @N@.
Inferring values for @T@ and @N@ is implicit, without programmer involvement.
Furthermore, in this case, the runtime subscript @x[0]@ (parameter @i@ being @0@) in @g@ is valid because 0 is in the dimension range $[0,99)$ of argument @x@.
The call @g( x, 1000 )@ is also accepted through compile time;
however, this case's subscript, @x[1000]@, generates an error, because @1000@ is outside the dimension range $[0,99)$ of argument @x@.

The generic @array@ type is comparable to the C array type, which \CFA inherits from C.
Their runtime characteristics are often identical, and some features are available in both.
For example, assume a caller instantiates @N@ with 42 (discussion about how to follow) in:
\begin{cfa}
forall( [N] )
void declDemo() {
	float x1[N];						$\C{// built-in type ("C array")}$
	array(float, N) x2;					$\C{// type from library}$
}
\end{cfa}
Both of the locally-declared array variables, @x1@ and @x2@, have 42 elements, each element being a @float@.
The two variables have identical size and layout; they both encapsulate 42-float stack allocations, with no additional ``bookkeeping'' allocations or headers.
Providing 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.

Admittedly, the @array@ library type (type for @x2@) is syntactically different from its C counterpart.
A future goal (TODO xref) is to provide the new features upon a built-in type whose syntax approaches C's (declaration style of @x1@).
Then, the library @array@ type could be removed, giving \CFA a largely uniform array type.
At present, the C-syntax array gets partial support for the new features, so the generic @array@ is used exclusively when introducing features;
feature support and C compatibility are revisited in Section ? TODO.

Offering 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++@).
However, 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.
Hence, 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.

In all discussion following, ``C array'' means the types like that of @x@ and ``\CFA array'' means the standard-library @array@ type (instantiations), like the type of @x2@.

My contributions in this chapter are:
\begin{enumerate}
\item A type system enhancement that lets polymorphic functions and generic types be parameterized by a numeric value: @forall( [N] )@.
\item Provide a length-checked array-type in the \CFA standard library, where the array's length is statically managed and dynamically valued.
\item Provide argument/parameter passing safety for arrays and subscript safety.
\item TODO: general parking...
\item Identify the interesting specific abilities available by the new @array@ type.
\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.
\end{enumerate}


\section{Definitions and design considerations}


\subsection{Dependent typing}



General dependent typing allows the type system to encode arbitrary predicates (e.g. behavioural specifications for functions),
which is an anti-goal for my work.
Firstly, this application is strongly associated with pure functional languages,
where a characterization of the return value (giving it a precise type, generally dependent upon the parameters)
is a sufficient postcondition.
In 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.
Secondly, TODO: bash Rust.
TODO: cite the crap out of these claims.



\section{Features added}

This section shows more about using the \CFA array and dimension parameters, demonstrating their syntax and semantics by way of motivating examples.
As stated, the core capability of the new array is tracking all dimensions within the type system, where dynamic dimensions are represented using type variables.

By declaring type variables at the front of object declarations, an array dimension is lexically referenceable where it is needed.
For example, a declaration can share one length, @N@, among a pair of parameters and the return,
meaning that it requires both input arrays to be of the same length, and guarantees that the result with be of that length as well.
\lstinput{10-17}{hello-array.cfa}
This function @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.
The dynamic allocation of the @ret@ array by preexisting @alloc@ uses the parameterized dimension information implicitly within its @sizeof@ determination, and casts the return type.
Note that alloc only sees one whole type for its @T@ (which is @f@'s @array(bool, N)@); this type's size is a computation based on @N@.
\begin{cfa}
// simplification
static inline forall( T & | sized(T) )
T * alloc() {
	return (T *)malloc( sizeof(T) );
}
\end{cfa}
This example illustrates how the new @array@ type plugs into existing \CFA behaviour by implementing necessary @sized@ assertions needed by other types.
(@sized@ implies a concrete \vs abstract type with a runtime-available size, exposed as @sizeof@.)
As 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.

\begin{figure}
\lstinput{30-43}{hello-array.cfa}
\lstinput{45-48}{hello-array.cfa}
\caption{\lstinline{f} Harness}
\label{f:fHarness}
\end{figure}

\VRef[Figure]{f:fHarness} shows a harness that uses function @f@, illustrating how dynamic values are fed into the @array@ type.
Here, the dimension of arrays @x@, @y@, and @result@ is specified from a command-line value, @dim@, and these arrays are allocated on the stack.
Then 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.
The program main is run (see figure bottom) with inputs @5@ and @7@ for sequence lengths.
The loops follow the familiar pattern of using the variable @dim@ to iterate through the arrays.
Most importantly, the type system implicitly captures @dim@ at the call of @f@ and makes it available throughout @f@ as @N@.
The 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@.
Except 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.
The result is a significant improvement in safety and usability.

In 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.
The syntactic form is chosen to parallel other @forall@ forms:
\begin{cfa}
forall( @[N]@ ) ...	$\C[1.5in]{// dimension}$
forall( T & ) ...	$\C{// opaque datatype (formerly, "dtype")}$
forall( T ) ...		$\C{// value datatype (formerly, "otype")}\CRT$
\end{cfa}
% The notation @array(thing, N)@ is a single-dimensional case, giving a generic type instance.
In summary:
\begin{itemize}
\item
@[N]@ within a @forall@ declares the type variable @N@ to be a managed length.
\item
@N@ can be used an expression of type @size_t@ within the declared function body.
\item
The value of an @N@-expression is the acquired length, derived from the usage site, \ie generic declaration or function call.
\item
@array( thing, N0, N1, ... )@ is a multi-dimensional type wrapping $\prod_i N_i$ adjacent occurrences of @thing@-typed objects.
\end{itemize}

\VRef[Figure]{f:TemplateVsGenericType} shows @N@ is not the same as a @size_t@ declaration in a \CC \lstinline[language=C++]{template}.
\begin{enumerate}[leftmargin=*]
\item
The \CC template @N@ can only be compile-time value, while the \CFA @N@ may be a runtime value.
% agreed, though already said
\item
\CC does not allow a template function to be nested, while \CFA lests its polymorphic functions to be nested.
% why is this important?
\item
The \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@.
The \CFA @N@ is part of the array type and passed implicitly at the call.
% fixed by comparing to std::array
% mycode/arrr/thesis-examples/check-peter/cs-cpp.cpp, v2
\item
\CC cannot have an array of references, but can have an array of pointers.
\CC has a (mistaken) belief that references are not objects, but pointers are objects.
In the \CC example, the arrays fall back on C arrays, which have a duality with references with respect to automatic dereferencing.
The \CFA array is a contiguous object with an address, which can be stored as a reference or pointer.
% not really about forall-N vs template-N
% any better CFA support is how Rob left references, not what Mike did to arrays
% https://stackoverflow.com/questions/1164266/why-are-arrays-of-references-illegal
% https://stackoverflow.com/questions/922360/why-cant-i-make-a-vector-of-references
\item
C/\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).
% fixed by comparing to std::array
% mycode/arrr/thesis-examples/check-peter/cs-cpp.cpp, v10
\end{enumerate}
TODO: settle Mike's concerns with this comparison (perhaps, remove)

\begin{figure}
\begin{tabular}{@{}l@{\hspace{20pt}}l@{}}
\begin{c++}

@template< typename T, size_t N >@
void copy( T ret[@N@], T x[@N@] ) {
	for ( int i = 0; i < N; i += 1 ) ret[i] = x[i];
}
int main() {

	int ret[10], x[10];
	for ( int i = 0; i < 10; i += 1 ) x[i] = i;
	@copy<int, 10 >( ret, x );@
	for ( int i = 0; i < 10; i += 1 )
		cout << ret[i] << ' ';
	cout << endl;
}
\end{c++}
&
\begin{cfa}
int main() {
	@forall( T, [N] )@		// nested function
	void copy( array( T, @N@ ) & ret, array( T, @N@ ) & x ) {
		for ( i; N ) ret[i] = x[i];
	}

	const int n = promptForLength();
	array( int, n ) ret, x;
	for ( i; n ) x[i] = i;
	@copy( ret,  x );@
	for ( i; n )
		sout | ret[i] | nonl;
	sout | nl;
}
\end{cfa}
\end{tabular}
\caption{\lstinline{N}-style paramters, for \CC template \vs \CFA generic type }
\label{f:TemplateVsGenericType}
\end{figure}

Just as the first example in \VRef[Section]{s:ArrayIntro} shows a compile-time rejection of a length mismatch,
so are length mismatches stopped when they invlove dimension parameters.
While \VRef[Figure]{f:fHarness} shows successfully calling a function @f@ expecting two arrays of the same length,
\begin{cfa}
array( bool, N ) & f( array( float, N ) &, array( float, N ) & );
\end{cfa}
a static rejection occurs when attempting to call @f@ with arrays of potentially differing lengths.
\lstinput[tabsize=1]{70-74}{hello-array.cfa}
When the argument lengths themselves are statically unknown,
the static check is conservative and, as always, \CFA's casting lets the programmer use knowledge not shared with the type system.
\begin{tabular}{@{\hspace{0.5in}}l@{\hspace{1in}}l@{}}
\lstinput{90-97}{hello-array.cfa}
&
\lstinput{110-117}{hello-array.cfa}
\end{tabular}

\noindent
This static check's full rules are presented in \VRef[Section]{s:ArrayTypingC}.

Orthogonally, the \CFA array type works within generic \emph{types}, \ie @forall@-on-@struct@.
The same argument safety and the associated implicit communication of array length occurs.
Preexisting \CFA allowed aggregate types to be generalized with type parameters, enabling parameterizing for element types.
Now, \CFA also allows parameterizing them by length.
Doing so gives a refinement of C's ``flexible array member'' pattern[TODO: cite ARM 6.7.2.1 pp18]\cite{arr:gnu-flex-mbr}.
While a C flexible array member can only occur at the end of the enclosing structure,
\CFA allows length-parameterized array members to be nested at arbitrary locations.
This flexibility, in turn, allows for multiple array members.
\lstinput{10-15}{hello-accordion.cfa}
This structure's 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.

The school example has the data structure capturing many students' course-preference forms.
It has course- and student-level metadata (their respective display names) and a position-based preferecens' matrix.
The input files in \VRef[Figure]{f:checkHarness} give example data.

When a function operates on a @School@ structure, the type system handles its memory layout transparently.
\lstinput{30-37}{hello-accordion.cfa}
In the running example, this @getPref@ function answers,
for the student at position @sIx@, what is the position of its @pref@\textsuperscript{th}-favoured class?

\VRef[Figure]{f:checkHarness} shows the @School@ harness and results with different array sizes.
This example program prints the courses in each student's preferred order, all using the looked-up display names.
Note the declaration of the @school@ variable.
It is on the stack and its initialization does not use any casting or size arithmetic.
Both of these points are impossible with a C flexible array member.
When heap allocation is preferred, the original pattern still applies.
\begin{cfa}
School( classes, students ) * sp = alloc();
\end{cfa}
This ability to avoid casting and size arithmetic improves safety and usability over C flexible array members.


\begin{figure}
% super hack to get this to line up
\begin{tabular}{@{}ll@{\hspace{25pt}}l@{}}
\begin{tabular}{@{}p{3.25in}@{}}
\lstinput{50-55}{hello-accordion.cfa}
\vspace*{-3pt}
\lstinput{90-98}{hello-accordion.cfa}
\end{tabular}
&
\raisebox{0.32\totalheight}{%
}%
&
\end{tabular}

TODO: Get Peter's layout help

\$ cat school1

\lstinput{}{school1}

\$ ./a.out < school1

\lstinput{}{school1.out}

\$ cat school2

\lstinput{}{school2}

\$ ./a.out < school2

\lstinput{}{school2.out}

\caption{\lstinline{School} harness, input and output}
\label{f:checkHarness}
\end{figure}


\section{Typing of C Arrays}
\label{s:ArrayTypingC}

Essential in giving a guarantee of accurate length is the compiler's ability
to reject a program that presumes to mishandle length.
By contrast, most discussion so far dealt with communicating length,
from one party who knows it, to another who is willing to work with any given length.
For scenarios where the concern is a mishandled length,
the interaction is between two parties who both claim to know (something about) it.
Such a scenario occurs in this pure C fragment, wich today's C compilers accept:
\begin{cfa}
	int n = @42@;
	float x[n];
	float (*xp)[@999@] = &x;
	(*xp)[@500@];  // in "bound"?
\end{cfa}

Here, the array @x@ has length 42, while a pointer to it (@xp@) claims length 999.
So, while the subscript of @xp@ at position 500 is out of bound of its referent @x@,
the access appears in-bound of the type information available on @xp@.
Truly, length is being mishandled in the previous step,
where the type-carried length information on @x@ is not compatible with that of @xp@.

The \CFA new-array rejects the analogous case:
\begin{cfa}
	int n = @42@;
	array(float, n) x;
	array(float, 999) * xp = x; // static rejection here
	(*xp)[@500@]; // runtime check vs len 999
\end{cfa}

% TODO: kill the vertical whitespace around these lists
% nothing from https://stackoverflow.com/questions/1061112/eliminate-space-before-beginitemize is working

The way the \CFA array is implemented,
the type analysis of this \CFA case reduces to a case similar to the earlier C version.
The \CFA compiler's compatibility analysis proceeds as:
\begin{itemize}[noitemsep,partopsep=-\parskip,parsep=0pt,leftmargin=4em]
\item
	Is @array(float, 999)@ type-compatible with @array(float, n)@?
\item
	Is @arrayX(float, char[999])@ type-compatible with @arrayX(float, char[n])@?
	\footnote{Here, \lstinline{arrayX} represents the type that results
		from desugaring the \lstinline{array} type
		into a type whose generic parameters are all types.
		This presentation elides the noisy fact that
		\lstinline{array} is actually a macro for something bigger;
		the reduction to \lstinline{char[-]} still proceeds as sketched.}
\item
	Is @char[999]@ type-compatible with @char[n]@?
\end{itemize}

I chose to achieve the necessary rejection of the \CFA case
by adding a rejection of the corresponding C case.

This decision is not backward compatible.
There are two complementary mitigations for this incompatibility.

First, a simple recourse is available to a programmer who intends to proceed
with the statically unsound assignment.
This situation might arise if @n@ were known to be 999,
rather than 42, as in the introductory examples.
The programmer can add a cast, as in:
\begin{cfa}
	xp = ( float (*)[999] ) & x;
\end{cfa}
This addition causes \CFA to accept, beacause now, the programmer has accepted blame.
This addition is benign in plain C, because the cast is valid, just unnecessary there.
Moreover, the addition can even be seen as appropriate ``eye candy,''
marking where the unchecked length knowledge is used.
Therefore, a program being onboarded to \CFA can receive a simple upgrade,
to satisfy the \CFA rules (and arguably become clearer),
without giving up its validity to a plain C compiler.

Second, the incompatibility only affects types like pointer-to-array,
which are are infrequently used in C.
The more common C idiom for aliasing an array is to use the pointer-to-first-element type,
which does not participate in the \CFA array's length checking.
\footnote{Notably, the desugaring of the \lstinline{array@} type,
	avoids letting any \lstinline{-[-]} type decay,
	in order to preserve the length information that powers runtime bound checking.}
Therefore, the frequency of needing to upgrade wild C code (as discussed in the first mitigation)
is anticipated to be low.

Because the incompatibility represents a low cost to a \CFA onboarding effort
(with a plausible side benefit of linting the original code for a missing annotation),
I elected not to add special measures to retain the compatibility.
It would be possible to flag occurrences of @-[-]@ types that come from @array@ desugaring,
treating those with stricter \CFA rules, while treating others with classic C rules.
If future lessons from C project onboarding warrant it,
this special compatibility measure can be added.

Having allowed that both the initial C example's check
\begin{itemize}[noitemsep,partopsep=-\parskip,parsep=0pt,leftmargin=4em]
	\item
		Is @float[999]@ type-compatible with @float[n]@?
\end{itemize}
and the second \CFA exmple's induced check
\begin{itemize}[noitemsep,partopsep=-\parskip,parsep=0pt,leftmargin=4em]
	\item
		Is @char[999]@ type-compatible with @char[n]@?
\end{itemize}
shall have the same answer, (``no''),
discussion turns to how I got the \CFA compiler to produce this answer.
In its preexisting form, it produced a (buggy) approximation of the C rules.
To implement the new \CFA rules, I took the syntactic recursion a step further, obtaining,
in both cases:
\begin{itemize}[noitemsep,partopsep=-\parskip,parsep=0pt,leftmargin=4em]
	\item
		Is @999@ TBD-compatible with @n@?
\end{itemize}
This compatibility question applies to a pair of expressions, where the earlier ones were to types.
Such an expression-compatibility question is a new addition to the \CFA compiler.
These questions only arise in the context of dimension expressions on (C) array types.

TODO: ensure these compiler implementation matters are treated under \CFA compiler background:
type unification,
cost calculation,
GenPoly.

The relevant technical component of the \CFA compiler is,
within the type resolver, the type unification procedure.
I added rules for continuing this unification into expressions that occur within types.
It 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.)

An unfortunate fact about the \CFA compiler's preexisting implementation is that
type unification suffers from two forms of duplication.

The first duplication has (many of) the unification rules stated twice.
As a result, my additions for dimension expressions are stated twice.
The extra statement of the rules occurs in the GenPoly module,
where concrete types like @array(int, 5)@\footnote{
	Again, the presentation is simplified
	by leaving the \lstinline{array} macro unexpanded}
are lowered into corresponding C types @struct __conc_array_1234@ (the suffix being a generated index).
In this case, the struct's definition gives fields that hardcode the argument values of @float@ and @5@.
The next time an @array(-,-)@ concrete instance is encountered,
is the previous @struct __conc_array_1234@ suitable for it?
Yes, for another occurrance of @array(int, 5)@;
no, for either @array(rational(int), 5)@ or @array(int, 42)@.
By the last example, this phase must ``reject''
the hypothesis that it should reuse the dimension-5 instance's C-lowering for a dimension-42 instance.

The second duplication has unification (proper) being invoked at two stages of expression resolution.
As a result, my added rule set needs to handle more cases than the preceding discussion motivates.
In the program
\begin{cfa}
	void f( double );
	forall( T & ) void f( T & );
	void g( int n ) {
		array( float, n + 1 ) x;
		f(x);
	}
\end{cfa}
when resolving the function call, the first unification stage
compares the types @T@, of the parameter, with @array( float, n + 1 )@, of the argument.
TODO: finish.

The actual rules for comparing two dimension expressions are conservative.
To answer, ``yes, consider this pair of expressions to be matching,''
is to imply, ``all else being equal, allow an array with length calculated by $e_1$
to be passed to a function expecting a length-$e_2$ array.''\footnote{
	TODO: Deal with directionality, that I'm doing exact-match, no ``at least as long as,'' no subtyping.
	Should it be an earlier scoping principle?  Feels like it should matter in more places than here.}
So, a ``yes'' answer must represent a guarantee that both expressions will evaluate the
same result, while a ``no'' can tolerate ``they might, but we're not sure,'
provided that practical recourses are available
to let programmers express their better knowledge.
The specific rule-set that I offer with the current release is, in fact, extremely conservative.
I chose to keep things simple,
and allow real future needs do drive adding additional complexity,
within the framework that I laid out.

For 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.
Rather, the analysis assumes a variable's value can be anything,
and so there can be no guarantee that its value is 999.
So, a variable use and a literal can never match.

Two occurrences of the same literal value are obviously a fine match.
For two occurrences of the same varialbe, more information is needed.
For example, this one is fine
\begin{cfa}
	void f( const int n ) {
		float x[n];
		float (*xp)[n] = x; // accept
	}
\end{cfa}
while this one is not:
\begin{cfa}
	void f() {
		int n = 42;
		float x[n];
		n = 999;
		float (*xp)[n] = x; // reject
	}
\end{cfa}
Furthermore, the fact that the first example sees @n@ as @const@
is not actually a sufficent basis.
In this example, @f@'s length expression's declaration is as @const@ as it can be,
yet its value still changes between the two invocations:
\begin{cfa}
	// compile unit 1
	void g();
	void f( const int & const nr ) {
		float x[nr];
		g();
		float (*xp)[nr] = x; // reject
	}
	// compile unit 2
	static int n = 42;
	void g() {
		n = 99;
	}
	void f( const int & );
	int main () {
		f(n);
		return 0;
	}
\end{cfa}
The issue in this last case is,
just because you aren't able to change something doesn't mean someone else can't.

My rule set also respects a feature of the C tradition.
In spite of the several limitations of the C rules
accepting cases that produce different values, there are a few mismatches that C stops.
C is quite precise when working with two static values:
\begin{cfa}
	enum { fortytwo = 42 };
	float x[fortytwo];
	float (*xp1)[42] = &x; // accept
	float (*xp2)[999] = &x; // reject
\end{cfa}
My \CFA rules agree with C's on these cases.

My rules classify expressions into three groups:
\begin{description}
\item[Statically Evaluable]
	Expressions for which a specific value can be calculated (conservatively)
	at compile-time.
	A preexisting \CFA compiler module defines which expressions qualify,
	and evaluates them.
	Includes literals and enumeration values.
\item[Dynamic but Stable]
	The value of a variable declared as @const@.
	Includes a @const@ parameter.
\item[Potentially Unstable]
	The catch-all category.  Notable examples include:
	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.
\end{description}

My \CFA rules are:
\begin{itemize}
\item
	Accept a Statically Evaluable pair, if both expressions have the same value.
	Notably, this rule allows a literal to match with an enumeration value, based on the value.
\item
	Accept a Dynamic but Stable pair, if both expressions are written out the same, e.g. refers to same variable declaration.
\item
	Otherwise, reject.
	Notably, reject all pairs from the Potentially Unstable group.
	Notably, reject all pairs that cross groups.
\end{itemize}

The traditional C rules are:
\begin{itemize}
\item
	Reject a Statically Evaluable pair, if the expressions have two different values.
\item
	Otherwise, accept.
\end{itemize}


\newcommand{\falsealarm}{{\color{orange}\small{*}}}
\newcommand{\allowmisuse}{{\color{red}\textbf{!}}}
\newcommand{\cmark}{\ding{51}} % from pifont
\newcommand{\xmark}{\ding{55}}
\begin{figure}
	\begin{tabular}{@{}l@{\hspace{16pt}}c@{\hspace{8pt}}c@{\hspace{16pt}}c@{\hspace{8pt}}c@{\hspace{16pt}}c}
	 & \multicolumn{2}{c}{\underline{Values Equal}}
	 & \multicolumn{2}{c}{\underline{Values Unequal}} 
	 & \\
	\textbf{Case}                                & C      & \CFA                & C                      & \CFA    & Compat. \\
	Both Statically Evaluable, Same Symbol       & Accept & Accept              &                        &         & \cmark \\
	Both Statically Evaluable, Different Symbols & Accept & Accept              & Reject                 & Reject  & \cmark \\
	Both Dynamic but Stable, Same Symbol         & Accept & Accept              &                        &         & \cmark \\
	Both Dynamic but Stable, Different Symbols   & Accept & Reject\,\falsealarm & Accept\,\allowmisuse   & Reject  & \xmark \\
	Both Potentially Unstable, Same Symbol       & Accept & Reject\,\falsealarm & Accept\,\allowmisuse   & Reject  & \xmark \\
	Any other grouping, Different Symbol         & Accept & Reject\,\falsealarm & Accept\,\allowmisuse   & Reject  & \xmark
	\end{tabular}

	\vspace{12pt}
	\noindent\textbf{Legend:}
	\begin{itemize}
	\item
		Each row gives the treatment of a test harness of the form
		\begin{cfa}
			float x[ expr1 ];
			float (*xp)[ expr2 ] = &x;
		\end{cfa}
		where \lstinline{expr1} and \lstinline{expr2} are metavariables varying according to the row's Case.
		Each row's claim applies to other harnesses too, including,
		\begin{itemize}
		\item
			calling a function with a paramter like \lstinline{x} and an argument of the \lstinline{xp} type,
		\item
			assignment in place of initialization,
		\item
			using references in place of pointers, and
		\item
			for the \CFA array, calling a polymorphic function on two \lstinline{T}-typed parameters with \lstinline{&x}- and \lstinline{xp}-typed arguments.
		\end{itemize}
	\item
		Each case's claim is symmetric (swapping \lstinline{expr1} with \lstinline{expr2} has no effect),
		even though most test harnesses are asymetric.
	\item
		The table treats symbolic identity (Same/Different on rows)
		apart from value eqality (Equal/Unequal on columns).
		\begin{itemize}
		\item
			The expressions \lstinline{1}, \lstinline{0+1} and \lstinline{n}
			(where \lstinline{n} is a variable with value 1),
			are all different symbols with the value 1.
		\item
			The column distinction expresses ground truth about whether an omniscient analysis should accept or reject.
		\item
			The row distinction expresses the simple static factors used by today's analyses.
		\end{itemize}
	\item
		Accordingly, every Reject under Values Equal is a false alarm (\falsealarm),
		while every Accept under Values Unequal is an allowed misuse (\allowmisuse).
	\end{itemize}
	\caption{Case comparison for array type compatibility, given pairs of dimension expressions.
		TODO: get Peter's LaTeX help on overall appearance, probably including column spacing/centering and bullet indentation.}
	\label{f:DimexprRuleCompare}
\end{figure}


Figure~\ref{f:DimexprRuleCompare} gives a case-by-case comparison of the consequences of these rule sets.
It demonstrates that the \CFA false alarms occur in the same cases as C treats unsafely.
It also shows that C-incompatibilities only occur in cases that C treats unsafely.


The 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.
This recourse is to declare an explicit constant for the dimension value.
Consider these two dimension expressions,
whose reuses are rejected by the blunt current-state rules:
\begin{cfa}
	void f( int & nr, const int nv ) {
		float x[nr];
		float (*xp)[nr] = & x; // reject: nr varying (no references)
		float y[nv + 1];
		float (*yp)[nv + 1] = & y; // reject: ?+? unpredicable (no functions)
	}
\end{cfa}
Yet, both dimension expressions are reused safely.
(The @nr@ reference is never written, not volatile
and control does not leave the function between the uses.
The name @?+?@ resolves to a function that is quite predictable.)
The programmer here can add the constant declarations:
\begin{cfa}
	void f( int & nr, const int nv ) {
		@const int nx@ = nr;
		float x[nx];
		float (*xp)[nx] = & x; // acept
		@const int ny@ = nv + 1;
		float y[ny];
		float (*yp)[ny] = & y; // accept
	}
\end{cfa}
The result is the originally intended semantics,
achieved by adding a superfluous ``snapshot it as of now'' directive.

The snapshotting trick is also used by the translation, though to achieve a different outcome.
Rather obviously, every array must be subscriptable, even a bizzarre one:
\begin{cfa}
	array( float, rand(10) ) x;
	x[0];  // 10% chance of bound-check failure
\end{cfa}
Less obvious is that the mechanism of subscripting is a function call,
which must communicate length accurately.
The bound-check above (callee logic) must use the actual allocated length of @x@,
without mistakenly reevaluating the dimension expression, @rand(10)@.
Adjusting the example to make the function's use of length more explicit:
\begin{cfa}
	forall ( T * )
	void f( T * x ) { sout | sizeof(*x); }
	float x[ rand(10) ];
	f( x );
\end{cfa}
Considering that the partly translated function declaration is, loosely,
\begin{cfa}
	void f( size_t __sizeof_T, void * x ) { sout | __sizeof_T; }
\end{cfa}
the translated call must not go like:
\begin{cfa}
	float x[ rand(10) ];
	f( rand(10), &x );
\end{cfa}
Rather, its actual translation is like:
\begin{cfa}
	size_t __dim_x = rand(10);
	float x[ __dim_x ];
	f( __dim_x, &x );
\end{cfa}
The occurrence of this dimension hoisting during translation was present in the preexisting \CFA compiler.
But its cases were buggy, particularly with determining, ``Can hoisting be skipped here?''
For skipping this hoisting is clearly desirable in some cases,
not the least of which is when the programmer has already done so manually.
My work includes getting these cases right, harmonized with the accept/reject criteria, and tested.



TODO: Discuss the interaction of this dimension hoisting with the challenge of extra unification for cost calculation

\section{Multidimensional Arrays}
\label{toc:mdimpl}

% TODO: introduce multidimensional array feature and approaches

When working with arrays, \eg linear algebra, array dimensions are referred to as ``rows'' and ``columns'' for a matrix, adding ``planes'' for a cube.
(There is little terminology for higher dimensional arrays.)
For example, an acrostic poem\footnote{A type of poetry where the first, last or other letters in a line spell out a particular word or phrase in a vertical column.}
can be treated as a grid of characters, where the rows are the text and the columns are the embedded keyword(s).
Within a poem, there is the concept of a \newterm{slice}, \eg a row is a slice for the poem text, a column is a slice for a keyword.
In general, the dimensioning and subscripting for multidimensional arrays has two syntactic forms: @m[r,c]@ or @m[r][c]@.

Commonly, an array, matrix, or cube, is visualized (especially in mathematics) as a contiguous row, rectangle, or block.
This conceptualization is reenforced by subscript ordering, \eg $m_{r,c}$ for a matrix and $c_{p,r,c}$ for a cube.
Few programming languages differ from the mathematical subscript ordering.
However, computer memory is flat, and hence, array forms are structured in memory as appropriate for the runtime system.
The closest representation to the conceptual visualization is for an array object to be contiguous, and the language structures this memory using pointer arithmetic to access the values using various subscripts.
This approach still has degrees of layout freedom, such as row or column major order, \ie juxtaposed rows or columns in memory, even when the subscript order remains fixed.
For example, programming languages like MATLAB, Fortran, Julia and R store matrices in column-major order since they are commonly used for processing column-vectors in tabular data sets but retain row-major subscripting.
In general, storage layout is hidden by subscripting, and only appears when passing arrays among different programming languages or accessing specific hardware.

\VRef[Figure]{f:FixedVariable} shows two C90 approaches for manipulating a contiguous matrix.
Note, C90 does not support VLAs.
The fixed-dimension approach (left) uses the type system;
however, it requires all dimensions except the first to be specified at compile time, \eg @m[][6]@, allowing all subscripting stride calculations to be generated with constants.
Hence, every matrix passed to @fp1@ must have exactly 6 columns but the row size can vary.
The variable-dimension approach (right) ignores (violates) the type system, \ie argument and parameters types do not match, and subscripting is performed manually using pointer arithmetic in the macro @sub@.

\begin{figure}
\begin{tabular}{@{}l@{\hspace{40pt}}l@{}}
\multicolumn{1}{c}{\textbf{Fixed Dimension}} & \multicolumn{1}{c}{\textbf{Variable Dimension}} \\
\begin{cfa}

void fp1( int rows, int m[][@6@] ) {
	...  printf( "%d ", @m[r][c]@ );  ...
}
int fm1[4][@6@], fm2[6][@6@]; // no VLA
// initialize matrixes
fp1( 4, fm1 ); // implicit 6 columns
fp1( 6, fm2 );
\end{cfa}
&
\begin{cfa}
#define sub( m, r, c ) *(m + r * sizeof( m[0] ) + c)
void fp2( int rows, int cols, int *m ) {
	...  printf( "%d ", @sub( m, r, c )@ );  ...
}
int vm1[@4@][@4@], vm2[@6@][@8@]; // no VLA
// initialize matrixes
fp2( 4, 4, vm1 );
fp2( 6, 8, vm2 );
\end{cfa}
\end{tabular}
\caption{C90 Fixed \vs Variable Contiguous Matrix Styles}
\label{f:FixedVariable}
\end{figure}

Many languages allow multidimensional arrays-of-arrays, \eg in Pascal or \CC.
\begin{cquote}
\begin{tabular}{@{}ll@{}}
\begin{pascal}
var m : array[0..4, 0..4] of Integer;  (* matrix *)
type AT = array[0..4] of Integer;  (* array type *)
type MT = array[0..4] of AT;  (* array of array type *)
var aa : MT;  (* array of array variable *)
m@[1][2]@ := 1;   aa@[1][2]@ := 1 (* same subscripting *)
\end{pascal}
&
\begin{c++}
int m[5][5];

typedef vector< vector<int> > MT;
MT vm( 5, vector<int>( 5 ) );
m@[1][2]@ = 1;  aa@[1][2]@ = 1;
\end{c++}
\end{tabular}
\end{cquote}
The language decides if the matrix and array-of-array are laid out the same or differently.
For example, an array-of-array may be an array of row pointers to arrays of columns, so the rows may not be contiguous in memory nor even the same length (triangular matrix).
Regardless, there is usually a uniform subscripting syntax masking the memory layout, even though a language could differentiated between the two forms using subscript syntax, \eg @m[1,2]@ \vs @aa[1][2]@.
Nevertheless, controlling memory layout can make a difference in what operations are allowed and in performance (caching/NUMA effects).

C also provides non-contiguous arrays-of-arrays.
\begin{cfa}
int m[5][5];							$\C{// contiguous}$
int * aa[5];							$\C{// non-contiguous}$
\end{cfa}
both with different memory layout using the same subscripting, and both with different degrees of issues.
The focus of this work is on the contiguous multidimensional arrays in C.
The reason is that programmers are often forced to use the more complex array-of-array form when a contiguous array would be simpler, faster, and safer.
Nevertheless, the C array-of-array form is still important for special circumstances.

\VRef[Figure]{f:ContiguousNon-contiguous} shows the extensions made in C99 for manipulating contiguous \vs non-contiguous arrays.\footnote{C90 also supported non-contiguous arrays.}
First, VLAs are supported.
Second, for contiguous arrays, C99 conjoins one or more of the parameters as a downstream dimension(s), \eg @cols@, implicitly using this parameter to compute the row stride of @m@.
If the declaration of @fc@ is changed to:
\begin{cfa}
void fc( int rows, int cols, int m[@rows@][@cols@] ) ...
\end{cfa}
it is possible for C to perform bound checking across all subscripting, but it does not.
While this contiguous-array capability is a step forward, it is still the programmer's responsibility to manually manage the number of dimensions and their sizes, both at the function definition and call sites.
That is, the array does not automatically carry its structure and sizes for use in computing subscripts.
While the non-contiguous style in @faa@ looks very similar to @fc@, the compiler only understands the unknown-sized array of row pointers, and it relies on the programmer to traverse the columns in a row correctly with a correctly bounded loop index.
Specifically, there is no requirement that the rows are the same length, like a poem with different length lines.

\begin{figure}
\begin{tabular}{@{}ll@{}}
\multicolumn{1}{c}{\textbf{Contiguous}} & \multicolumn{1}{c}{\textbf{ Non-contiguous}} \\
\begin{cfa}
void fc( int rows, @int cols@, int m[ /* rows */ ][@cols@] ) {
	...  printf( "%d ", @m[r][c]@ );  ...
}
int m@[5][5]@;
for ( int r = 0; r < 5; r += 1 ) {

	for ( int c = 0; c < 5; c += 1 )
		m[r][c] = r + c;
}
fc( 5, 5, m );
\end{cfa}
&
\begin{cfa}
void faa( int rows, int cols, int * m[ @/* cols */@ ] ) {
	...  printf( "%d ", @m[r][c]@ );  ...
}
int @* aa[5]@;  // row pointers
for ( int r = 0; r < 5; r += 1 ) {
	@aa[r] = malloc( 5 * sizeof(int) );@ // create rows
	for ( int c = 0; c < 5; c += 1 )
		aa[r][c] = r + c;
}
faa( 5, 5, aa );
\end{cfa}
\end{tabular}
\caption{C99 Contiguous \vs Non-contiguous Matrix Styles}
\label{f:ContiguousNon-contiguous}
\end{figure}


\subsection{Multidimensional array implementation}

A multidimensional array implementation has three relevant levels of abstraction, from highest to lowest, where the array occupies \emph{contiguous memory}.
\begin{enumerate}
\item
Flexible-stride memory:
this 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]@.
\item
Fixed-stride memory:
this 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).
After which, subscripting and memory layout are independent.
\item
Explicit-displacement memory:
this 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@.
A programmer must manually build any notion of dimensions using other tools;
hence, this style is not offering multidimensional arrays \see{\VRef[Figure]{f:FixedVariable} right example}.
\end{enumerate}

There is some debate as to whether the abstraction ordering goes $\{1, 2\} < 3$, rather than my numerically-ordering.
That is, styles 1 and 2 are at the same abstraction level, with 3 offering a limited set of functionality.
I chose to build the \CFA style-1 array upon a style-2 abstraction.
(Justification of the decision follows, after the description of the design.)

Style 3 is the inevitable target of any array implementation.
The hardware offers this model to the C compiler, with bytes as the unit of displacement.
C offers this model to its programmer as pointer arithmetic, with arbitrary sizes as the unit.
Casting 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.

Now 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.
A C/\CFA array interface includes the resulting memory layout.
The defining requirement of a type-2 system is the ability to slice a column from a column-finest matrix.
The required memory shape of such a slice is fixed, before any discussion of implementation.
The 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.
TODO: do I have/need a presentation of just this layout, just the semantics of -[all]?

The new \CFA standard library @array@ datatype supports richer multidimensional features than C.
The 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.
Beyond 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.

The 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.
\par
\mbox{\lstinput{121-126}{hello-md.cfa}}
\par\noindent
The memory layout is 35 contiguous elements with strictly increasing addresses.

A trivial form of slicing extracts a contiguous inner array, within an array-of-arrays.
As 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.
This 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@.
The following is an example slicing a row.
\lstinput{60-64}{hello-md.cfa}
\lstinput[aboveskip=0pt]{140-140}{hello-md.cfa}

However, function @print1d@ is asserting too much knowledge about its parameter @r@ for printing either a row slice or a column slice.
Specifically, declaring the parameter @r@ with type @array@ means that @r@ is contiguous, which is unnecessarily restrictive.
That is, @r@ need only be of a container type that offers a subscript operator (of type @ptrdiff_t@ $\rightarrow$ @float@) with managed length @N@.
The new-array library provides the trait @ar@, so-defined.
With it, the original declaration can be generalized with the same body.
\lstinput{43-44}{hello-md.cfa}
\lstinput[aboveskip=0pt]{145-145}{hello-md.cfa}
The 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.
In 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.
\lstinput{150-151}{hello-md.cfa}

The example shows @x[2]@ and @x[[2, all]]@ both refer to the same, ``2.*'' slice.
Indeed, 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]@.
This 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''.
That is:
\begin{cquote}
\begin{tabular}{@{}cccccl@{}}
@x[[2,all]][3]@	& $\equiv$	& @x[2][all][3]@  & $\equiv$	& @x[2][3]@  & (here, @all@ is redundant)  \\
@x[[all,3]][2]@	& $\equiv$	& @x[all][3][2]@  & $\equiv$	& @x[2][3]@  & (here, @all@ is effective)
\end{tabular}
\end{cquote}

Narrating progress through each of the @-[-][-][-]@\footnote{
The first ``\lstinline{-}'' is a variable expression and the remaining ``\lstinline{-}'' are subscript expressions.}
expressions gives, firstly, a definition of @-[all]@, and secondly, a generalization of C's @-[i]@.
Where @all@ is redundant:
\begin{cquote}
\begin{tabular}{@{}ll@{}}
@x@  & 2-dimensional, want subscripts for coarse then fine \\
@x[2]@  & 1-dimensional, want subscript for fine; lock coarse == 2 \\
@x[2][all]@  & 1-dimensional, want subscript for fine \\
@x[2][all][3]@  & 0-dimensional; lock fine == 3
\end{tabular}
\end{cquote}
Where @all@ is effective:
\begin{cquote}
\begin{tabular}{@{}ll@{}}
@x@  & 2-dimensional, want subscripts for coarse then fine \\
@x[all]@  & 2-dimensional, want subscripts for fine then coarse \\
@x[all][3]@  & 1-dimensional, want subscript for coarse; lock fine == 3 \\
@x[all][3][2]@  & 0-dimensional; lock coarse == 2
\end{tabular}
\end{cquote}
The semantics of @-[all]@ is to dequeue from the front of the ``want subscripts'' list and re-enqueue at its back.
For example, in a two dimensional matrix, this semantics conceptually transposes the matrix by reversing the subscripts.
The semantics of @-[i]@ is to dequeue from the front of the ``want subscripts'' list and lock its value to be @i@.

Contiguous arrays, and slices of them, are all represented by the same underlying parameterized type, which includes stride information in its metatdata.
\PAB{Do not understand this sentence: The \lstinline{-[all]} operation is a conversion from a reference to one instantiation to a reference to another instantiation.}
The running example's @all@-effective step, stated more concretely, is:
\begin{cquote}
\begin{tabular}{@{}ll@{}}
@x@       & : 5 of ( 7 of @float@ each spaced 1 @float@ apart ) each spaced 7 @floats@ apart \\
@x[all]@  & : 7 of ( 5 of @float@ each spaced 7 @float@s apart ) each spaced 1 @float@ apart
\end{tabular}
\end{cquote}

\begin{figure}
\includegraphics{measuring-like-layout}
\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.
The horizontal layout represents contiguous memory addresses while the vertical layout is conceptual.
The vertical shaded band highlights the location of the targeted element, 2.3.
Any such vertical slice contains various interpretations of a single address.}
\label{fig:subscr-all}
\end{figure}

Figure~\ref{fig:subscr-all} shows one element (in the shaded band) accessed two different ways: as @x[2][3]@ and as @x[all][3][2]@.
In both cases, value 2 selects from the coarser dimension (rows of @x@),
while the value 3 selects from the finer dimension (columns of @x@).
The figure illustrates the value of each subexpression, comparing how numeric subscripting proceeds from @x@, \vs from @x[all]@.
Proceeding from @x@ gives the numeric indices as coarse then fine, while proceeding from @x[all]@ gives them fine then coarse.
These two starting expressions, which are the example's only multidimensional subexpressions
(those that received zero numeric indices so far), are illustrated with vertical steps where a \emph{first} numeric index would select.

The figure's presentation offers an intuition answering to: What is an atomic element of @x[all]@?
From there, @x[all]@ itself is simply a two-dimensional array, in the strict C sense, of these building blocks.
An atom (like the bottommost value, @x[all][3][2]@), is the contained value (in the square box)
and a lie about its size (the left diagonal above it, growing upward).
An array of these atoms (like the intermediate @x[all][3]@) is just a contiguous arrangement of them, done according to their size;
call such an array a column.
A column is almost ready to be arranged into a matrix;
it is the \emph{contained value} of the next-level building block, but another lie about size is required.
At 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).
These lying columns, arranged contiguously according to their size (as announced) form the matrix @x[all]@.
Because @x[all]@ takes indices, first for the fine stride, then for the coarse stride, it achieves the requirement of representing the transpose of @x@.
Yet every time the programmer presents an index, a C-array subscript is achieving the offset calculation.

In the @x[all]@ case, after the finely strided subscript is done (column 3 is selected),
the locations referenced by the coarse subscript options (rows 0..4) are offset by 3 floats,
compared with where analogous rows appear when the row-level option is presented for @x@.

For example, in \lstinline{x[all]}, the shaded band touches atoms 2.0, 2.1, 2.2, 2.3, 1.4, 1.5 and 1.6 (left diagonal).
But only the atom 2.3 is storing its value there.
The rest are lying about (conflicting) claims on this location, but never exercising these alleged claims.

Lying is implemented as casting.
The arrangement just described is implemented in the structure @arpk@.
This structure uses one type in its internal field declaration and offers a different type as the return of its subscript operator.
The 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]@.
The subscript operator presents what is really inside, by casting to the type below the left diagonal of the lie.

%  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.

Casting, overlapping, and lying are unsafe.
The mission is to implement a style-1 feature in the type system for safe use by a programmer.
The offered style-1 system is allowed to be internally unsafe,
just 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.
Having a style-1 system relieves the programmer from resorting to unsafe pointer arithmetic when working with noncontiguous slices.

% PAB: repeat from previous paragraph.
% 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.
% My casting is unsafe, but I do not do any pointer arithmetic.
% When a programmer works in the common-case style-2 subset (in the no-@[all]@ top of Figure~\ref{fig:subscr-all}), my casts are identities, and the C compiler is doing its usual displacement calculations.
% 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.

% \noindent END: Paste looking for a home

The new-array library defines types and operations that ensure proper elements are accessed soundly in spite of the overlapping.
The @arpk@ structure and its @-[i]@ operator are defined as:
\begin{cfa}
forall(
	[N],					$\C{// length of current dimension}$
	S & | sized(S),			$\C{// masquerading-as}$
	Timmed &,				$\C{// immediate element, often another array}$
	Tbase &					$\C{// base element, e.g. float, never array}$
) { // distribute forall to each element
	struct arpk {
		S strides[N];		$\C{// so that sizeof(this) is N of S}$
	};
	// expose Timmed, stride by S
	static inline Timmed & ?[?]( arpk( N, S, Timmed, Tbase ) & a, long int i ) {
		subcheck( a, i, 0, N );
		return (Timmed &)a.strides[i];
	}
}
\end{cfa}
The private @arpk@ structure (array with explicit packing) is generic over four types: dimension length, masquerading-as, ...
This structure's public interface is hidden behind the @array(...)@ macro and the subscript operator.
Construction by @array@ initializes the masquerading-as type information to be equal to the contained-element information.
Subscripting by @all@ rearranges the order of masquerading-as types to achieve, in general, nontrivial striding.
Subscripting by a number consumes the masquerading-as size of the contained element type, does normal array stepping according to that size, and returns there element found there, in unmasked form.

An 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, ...)@.
In the base case, @array(E_base)@ is just @E_base@.
Because this construction uses the same value for the generic parameters @S@ and @E_im@, the resulting layout has trivial strides.

Subscripting 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.
Expressed as an operation on types, this rotation is:
\begin{eqnarray*}
suball( arpk(N, S, E_i, E_b) ) & = & enq( N, S, E_i, E_b ) \\
enq( N, S, E_b, E_b ) & = & arpk( N, S, E_b, E_b ) \\
enq( N, S, arpk(N', S', E_i', E_b), E_b ) & = & arpk( N', S', enq(N, S, E_i', E_b), E_b )
\end{eqnarray*}


\section{Bound checks, added and removed}

\CFA array subscripting is protected with runtime bound checks.
Having dependent typing causes the optimizer to remove more of these bound checks than it would without them.
This section provides a demonstration of the effect.

The 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.
The 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.
The experiment compares with the \CC version to keep access to generated assembly code simple.

As 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.
When 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.
But 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.

TODO: paste source and assembly codes

Incorporating reuse among dimension sizes is seen to give \CFA an advantage at being optimized.
The case is naive matrix multiplication over a row-major encoding.

TODO: paste source codes





\section{Comparison with other arrays}


\subsection{Rust}

\CFA's array is the first lightweight application of dependently-typed bound tracking to an extension of C.
Other 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.
These systems, therefore, ask the programmer to convince the type checker that every pointer dereference is valid.
\CFA imposes the lighter-weight obligation, with the more limited guarantee, that initially-declared bounds are respected thereafter.

\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.
Other 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.
The \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.


\subsection{Java}

Java arrays are arrays-of-arrays because all objects are references \see{\VRef{toc:mdimpl}}.
For each array, Java implicitly storages the array dimension in a descriptor, supporting array length, subscript checking, and allowing dynamically-sized array-parameter declarations.
\begin{cquote}
\begin{tabular}{rl}
C      &  @void f( size_t n, size_t m, float x[n][m] );@ \\
Java   &  @void f( float x[][] );@
\end{tabular}
\end{cquote}
However, in the C prototype, the parameters @n@ and @m@  are documentation only as the intended size of the first and second dimension of @x@.
\VRef[Figure]{f:JavaVsCTriangularMatrix} compares a triangular matrix (array-of-arrays) in dynamically safe Java to unsafe C.
Each dynamically sized row in Java stores its dimension, while C requires the programmer to manage these sizes explicitly (@rlnth@).
All subscripting is Java has bounds checking, while C has none.
Both Java and C require explicit null checking, otherwise there is a runtime failure.

\begin{figure}
\setlength{\tabcolsep}{15pt}
\begin{tabular}{ll@{}}
\begin{java}
int m[][] = {  // triangular matrix
	new int [4],
	new int [3],
	new int [2],
	new int [1],
	null
};

for ( int r = 0; r < m.length; r += 1 ) {
	if ( m[r] == null ) continue;
	for ( int c = 0; c < m[r].length; c += 1 ) {
		m[r][c] = c + r; // subscript checking
	}

}

for ( int r = 0; r < m.length; r += 1 ) {
	if ( m[r] == null ) {
		System.out.println( "null row" );
		continue;
	}
	for ( int c = 0; c < m[r].length; c += 1 ) {
		System.out.print( m[r][c] + " " );
	}
	System.out.println();

}
\end{java}
&
\begin{cfa}
int * m[5] = {  // triangular matrix
	calloc( 4, sizeof(int) ),
	calloc( 3, sizeof(int) ),
	calloc( 2, sizeof(int) ),
	calloc( 1, sizeof(int) ),
	NULL
};
int rlnth = 4;
for ( int r = 0; r < 5; r += 1 ) {
	if ( m[r] == NULL ) continue;
	for ( int c = 0; c < rlnth; c += 1 ) {
		m[r][c] = c + r; // no subscript checking
	}
	rlnth -= 1;
}
rlnth = 4;
for ( int r = 0; r < 5; r += 1 ) {
	if ( m[r] == NULL ) {
		printf( "null row\n" );
		continue;
	}
	for ( int c = 0; c < rlnth; c += 1 ) {
		printf( "%d ", m[r][c] );
	}
	printf( "\n" );
	rlnth -= 1;
}
\end{cfa}
\end{tabular}
\caption{Java (left) \vs C (right) Triangular Matrix}
\label{f:JavaVsCTriangularMatrix}
\end{figure}

The downside of the arrays-of-arrays approach is performance due to pointer chasing versus pointer arithmetic for a contiguous arrays.
Furthermore, there is the cost of managing the implicit array descriptor.
It is unlikely that a JIT can dynamically rewrite an arrays-of-arrays form into a contiguous form.


\subsection{\CC}

Because C arrays are difficult and dangerous, the mantra for \CC programmers is to use @std::vector@ in place of the C array.
While 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@.
\begin{c++}
vector< vector< int > > m( 5, vector<int>(8) ); // initialize size of 5 x 8 with 6 dynamic allocations
\end{c++}
Multidimensional arrays are arrays-of-arrays with associated costs.
Each @vector@ array has an array descriptor contain the dimension, which allows bound checked using @x.at(i)@ in place of @x[i]@.
Used 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.
This scheme matches Java's safety and expressiveness exactly, but with the inherent costs.


\subsection{Levels of dependently typed arrays}

The \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:
\begin{itemize}
\item a \emph{zip}-style operation that consumes two arrays of equal length
\item a \emph{map}-style operation whose produced length matches the consumed length
\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
\end{itemize}
Across 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.
Along the way, the \CFA array also closes the safety gap (with respect to bounds) that Java has over C.

Dependent type systems, considered for the purpose of bound-tracking, can be full-strength or restricted.
In a full-strength dependent type system, a type can encode an arbitrarily complex predicate, with bound-tracking being an easy example.
The tradeoff of this expressiveness is complexity in the checker, even typically, a potential for its nontermination.
In 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.
[TODO: clarify how even Idris type checking terminates]

Idris is a current, general-purpose dependently typed programming language.
Length checking is a common benchmark for full dependent type systems.
Here, 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.
[TODO: finish explaining what Data.Vect is and then the essence of the comparison]

POINTS:
here is how our basic checks look (on a system that does not have to compromise);
it can also do these other cool checks, but watch how I can mess with its conservativeness and termination

Two 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.
Unlike \CFA, both are garbage-collected functional languages.
Because they are garbage-collected, referential integrity is built-in, meaning that the heavyweight analysis, that \CFA aims to avoid, is unnecessary.
So, like \CFA, the checking in question is a lightweight bounds-only analysis.
Like \CFA, their checks that are conservatively limited by forbidding arithmetic in the depended-upon expression.



The 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.
There is a particular emphasis on an existential type, enabling callee-determined return shapes.


Dex uses a novel conception of size, embedding its quantitative information completely into an ordinary type.

Futhark and full-strength dependently typed languages treat array sizes are ordinary values.
Futhark restricts these expressions syntactically to variables and constants, while a full-strength dependent system does not.

\CFA's hybrid presentation, @forall( [N] )@, has @N@ belonging to the type system, yet has no instances.
Belonging to the type system means it is inferred at a call site and communicated implicitly, like in Dex and unlike in Futhark.
Having 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.

\subsection{Static safety in C extensions}


\section{Future work}

\subsection{Declaration syntax}

\subsection{Range slicing}

\subsection{With a module system}

\subsection{With described enumerations}

A project in \CFA's current portfolio will improve enumerations.
In the incumbent state, \CFA has C's enumerations, unmodified.
I will not discuss the core of this project, which has a tall mission already, to improve type safety, maintain appropriate C compatibility and offer more flexibility about storage use.
It also has a candidate stretch goal, to adapt \CFA's @forall@ generic system to communicate generalized enumerations:
\begin{cfa}
forall( T | is_enum(T) )
void show_in_context( T val ) {
	for( T i ) {
		string decorator = "";
		if ( i == val-1 ) decorator = "< ready";
		if ( i == val   ) decorator = "< go"   ;
		sout | i | decorator;
	}
}
enum weekday { mon, tue, wed = 500, thu, fri };
show_in_context( wed );
\end{cfa}
with output
\begin{cfa}
mon
tue < ready
wed < go
thu
fri
\end{cfa}
The details in this presentation aren't meant to be taken too precisely as suggestions for how it should look in \CFA.
But the example shows these abilities:
\begin{itemize}
\item a built-in way (the @is_enum@ trait) for a generic routine to require enumeration-like information about its instantiating type
\item an implicit implementation of the trait whenever a user-written enum occurs (@weekday@'s declaration implies @is_enum@)
\item a total order over the enumeration constants, with predecessor/successor (@val-1@) available, and valid across gaps in values (@tue == 1 && wed == 500 && tue == wed - 1@)
\item a provision for looping (the @for@ form used) over the values of the type.
\end{itemize}

If \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.

[TODO: introduce Ada in the comparators]

In 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.
The 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.

This change of perspective also lets us remove ubiquitous dynamic bound checks.
[TODO: xref] discusses how automatically inserted bound checks can often be optimized away.
But this approach is unsatisfying to a programmer who believes she has written code in which dynamic checks are unnecessary, but now seeks confirmation.
To 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.

[TODO, fix confusion:  Idris has this arrangement of checks, but still the natural numbers as the domain.]

The 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.
Dex's @Ix@ is analogous the @is_enum@ proposed for \CFA above.
\begin{cfa}
interface Ix n
get_size n : Unit -> Int
ordinal : n -> Int
unsafe_from_ordinal n : Int -> n
\end{cfa}

Dex uses this foundation of a trait (as an array type's domain) to achieve polymorphism over shapes.
This 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.
Dex's example is a routine that calculates pointwise differences between two samples.
Done 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).
In 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.

The polymorphism plays out with the pointwise-difference routine advertising a single-dimensional interface whose domain type is generic.
In the audio instantiation, the duration-of-clip type argument is used for the domain.
In the photograph instantiation, it's the tuple-type of $ \langle \mathrm{img\_wd}, \mathrm{img\_ht} \rangle $.
This 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
\begin{cfa}
instance {a b} [Ix a, Ix b] Ix (a & b)
get_size = \(). size a * size b
ordinal = \(i, j). (ordinal i * size b) + ordinal j
unsafe_from_ordinal = \o.
bs = size b
(unsafe_from_ordinal a (idiv o bs), unsafe_from_ordinal b (rem o bs))
\end{cfa}
and 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
\begin{cfa}
img_trans :: (img_wd,img_ht)=>Real
img_trans.(i,j) = img.i.j
result = pairwise img_trans
\end{cfa}
[TODO: cite as simplification of example from https://openreview.net/pdf?id=rJxd7vsWPS section 4]

In 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.

\subsection{Retire pointer arithmetic}


\section{\CFA}

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \\
moved from background chapter \\
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \\

Traditionally, fixing C meant leaving the C-ism alone, while providing a better alternative beside it.
(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.)

\subsection{\CFA features interacting with arrays}

Prior work on \CFA included making C arrays, as used in C code from the wild,
work, if this code is fed into @cfacc@.
The quality of this this treatment was fine, with no more or fewer bugs than is typical.

More mixed results arose with feeding these ``C'' arrays into preexisting \CFA features.

A notable success was with the \CFA @alloc@ function,
which type information associated with a polymorphic return type
replaces @malloc@'s use of programmer-supplied size information.
\begin{cfa}
// C, library
void * malloc( size_t );
// C, user
struct tm * el1 = malloc( sizeof(struct tm) );
struct tm * ar1 = malloc( 10 * sizeof(struct tm) );

// CFA, library
forall( T * ) T * alloc();
// CFA, user
tm * el2 = alloc();
tm (*ar2)[10] = alloc();
\end{cfa}
The alloc polymorphic return compiles into a hidden parameter, which receives a compiler-generated argument.
This compiler's argument generation uses type information from the left-hand side of the initialization to obtain the intended type.
Using a compiler-produced value eliminates an opportunity for user error.

TODO: 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

Bringing 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.
In the last example, the choice of ``pointer to array'' @ar2@ breaks a parallel with @ar1@.
They are not subscripted in the same way.
\begin{cfa}
ar1[5];
(*ar2)[5];
\end{cfa}
Using ``reference to array'' works at resolving this issue.  TODO: discuss connection with Doug-Lea \CC proposal.
\begin{cfa}
tm (&ar3)[10] = *alloc();
ar3[5];
\end{cfa}
The implicit size communication to @alloc@ still works in the same ways as for @ar2@.

Using proper array types (@ar2@ and @ar3@) addresses a concern about using raw element pointers (@ar1@), albeit a theoretical one.
TODO xref C standard does not claim that @ar1@ may be subscripted,
because no stage of interpreting the construction of @ar1@ has it be that ``there is an \emph{array object} here.''
But both @*ar2@ and the referent of @ar3@ are the results of \emph{typed} @alloc@ calls,
where the type requested is an array, making the result, much more obviously, an array object.

The ``reference to array'' type has its sore spots too.
TODO see also @dimexpr-match-c/REFPARAM_CALL@ (under @TRY_BUG_1@)

TODO: I fixed a bug associated with using an array as a T.  I think.  Did I really?  What was the bug?