carray 3.0.3 → 3.0.4

data/ext/ca_obj_stack.c

@@ -125,6 +125,26 @@ ca_stack_setup_with_axis (CAStack *ca, int32_t n_parents, CArray **parents,
   int32_t i;
   int8_t  a;
 
+  /* ca == NULL asks for the checks only, so that a constructor can run
+     them before it allocates.  They see the parents as the setup will,
+     one Face level down, without changing the caller's list. */
+  if ( ca == NULL ) {
+    volatile VALUE holder = 0;
+    CArray **seen = ALLOCV_N(CArray *, holder, n_parents > 0 ? n_parents : 1);
+    for ( i = 0; i < n_parents; i++ ) {
+      seen[i] = ca_is_face(parents[i]) ? CAVIEW(parents[i])->parent : parents[i];
+    }
+    ca_stack_check_uniform(n_parents, seen);
+    ca_check_rank_fits(seen[0]->ndim + 1, NULL);
+    if ( k_axis < 0 || k_axis > seen[0]->ndim ) {
+      rb_raise(rb_eArgError,
+               "CAStack k_axis %d out of range [0, %d]",
+               (int) k_axis, (int) seen[0]->ndim);
+    }
+    ALLOCV_END(holder);
+    return 0;
+  }
+
   /* §8.3 / MEMO_FACE_DOUBLE_LIFT §15.3: pre-strip Face parents one level to
      storage so a stacked Face lifts to a single-Face chain
      (CATime[CAStack[entity, ...]]) instead of a Face on top of Face parents.
@@ -141,6 +161,7 @@ ca_stack_setup_with_axis (CAStack *ca, int32_t n_parents, CArray **parents,
   ca_stack_check_uniform(n_parents, parents);
   ref = parents[0];
 
+  ca_check_rank_fits(ref->ndim + 1, NULL);
   if ( k_axis < 0 || k_axis > ref->ndim ) {
     rb_raise(rb_eArgError,
              "CAStack k_axis %d out of range [0, %d]",
@@ -190,7 +211,9 @@ ca_stack_setup (CAStack *ca, int32_t n_parents, CArray **parents)
 CAStack *
 ca_stack_new_with_axis (int32_t n_parents, CArray **parents, int8_t k_axis)
 {
-  CAStack *ca = ALLOC(CAStack);
+  CAStack *ca;
+  ca_stack_setup_with_axis(NULL, n_parents, parents, k_axis);
+  ca = ALLOC(CAStack);
   ca_stack_setup_with_axis(ca, n_parents, parents, k_axis);
   return ca;
 }
@@ -236,12 +259,12 @@ ca_stack_func_clone (void *ap)
 /* On the mask of a CAStack: let its stand-ins give way to the parents' own
    masks (see ca_multi_parent_mask_refresh). */
 static void
-ca_stack_mask_refresh (CAStack *ca, int for_write)
+ca_stack_mask_refresh (CAStack *ca)
 {
   CAStack *o = (CAStack *) ca->mask_owner;
   if ( o != NULL ) {
     ca_multi_parent_mask_refresh((CArray *) ca, o->parents, o->mask_standins,
-                                 o->n_parents, for_write);
+                                 o->n_parents);
   }
 }
 
@@ -259,7 +282,7 @@ static void
 ca_stack_func_xfer_index (void *ap, ca_size_t *idx, void *data, int dir)
 {
   CAStack *ca = (CAStack *) ap;
-  ca_stack_mask_refresh(ca, dir == CA_XFER_PUT);
+  ca_stack_mask_refresh(ca);
   int8_t   k_axis = ca->k_axis;
   ca_size_t k = idx[k_axis];
   if ( k < 0 || k >= ca->n_parents ) {
@@ -295,7 +318,7 @@ ca_stack_func_xfer_addrs (void *ap, ca_size_t n, ca_size_t *addrs,
                           void *data, int dir)
 {
   CAStack *ca = (CAStack *) ap;
-  ca_stack_mask_refresh(ca, dir == CA_XFER_PUT);
+  ca_stack_mask_refresh(ca);
   int8_t   k_axis = ca->k_axis;
   ca_size_t parent_elements = ca->parents[0]->elements;
   ca_size_t bytes = ca->bytes;
@@ -422,7 +445,7 @@ ca_stack_func_xfer_stride (void *ap, ca_size_t *starts, ca_size_t *counts,
 {
   if ( ca_region_is_empty(((CArray *) ap)->ndim, counts) ) return;
   CAStack *ca = (CAStack *) ap;
-  ca_stack_mask_refresh(ca, dir == CA_XFER_PUT);
+  ca_stack_mask_refresh(ca);
   int8_t   k_axis = ca->k_axis;
   int8_t   pndim = ca->ndim - 1;
   ca_size_t native[CA_RANK_MAX], dstride[CA_RANK_MAX];
@@ -515,6 +538,7 @@ ca_stack_func_xfer_stride (void *ap, ca_size_t *starts, ca_size_t *counts,
           ca_size_t pidx[CA_RANK_MAX];
           ca_size_t paddr = 0;
           for ( a = 0; a < pndim; a++ ) pidx[a] = 0;
+          /* empty: the slot returns on an empty region at its entry */
           while ( 1 ) {
             ca_size_t voff = k_off;
             for ( a = 0; a < k_axis; a++ )     voff += pidx[a] * dstride[a];
@@ -593,6 +617,7 @@ ca_stack_func_xfer_stride (void *ap, ca_size_t *starts, ca_size_t *counts,
            the CAStack-level addr2index dispatch hop in the per-cell fallback. */
         ca_size_t pidx[CA_RANK_MAX], doff = 0;
         for ( i = 0; i < ca->ndim; i++ ) odo[i] = 0;
+        /* empty: the slot returns on an empty region at its entry */
         while ( 1 ) {
           ca_size_t k2 = starts[k_axis] + odo[p];
           for ( a = 0; a < pndim; a++ ) {
@@ -611,6 +636,7 @@ ca_stack_func_xfer_stride (void *ap, ca_size_t *starts, ca_size_t *counts,
       s = ca->bytes;
       for ( i = ca->ndim - 1; i >= 0; i-- ) { dstride[i] = s; s *= counts[i]; }
       for ( i = 0; i <= p; i++ ) odo[i] = 0;
+      /* empty: the slot returns on an empty region at its entry */
       while ( 1 ) {
         ca_size_t k2 = starts[k_axis] + odo[p];
         ca_size_t doff = 0;
@@ -640,6 +666,7 @@ ca_stack_func_xfer_stride (void *ap, ca_size_t *starts, ca_size_t *counts,
     ca_size_t idx[CA_RANK_MAX], doff = 0, base = 0;
     for ( i = 0; i < ca->ndim; i++ ) base += starts[i] * native[i];
     for ( i = 0; i < ca->ndim; i++ ) idx[i] = 0;
+    /* empty: the slot returns on an empty region at its entry */
     while ( 1 ) {
       ca_size_t toff = base, vidx[CA_RANK_MAX];
       for ( i = 0; i < ca->ndim; i++ ) toff += idx[i] * strides[i];
@@ -749,6 +776,7 @@ ca_stack_xfer_parents (CAStack *ca, char *d, int dir, int into_buffers)
         }
         else if ( dir == CA_XFER_GET ) {
           /* dir-hoisted GET inner loop, incremental voff. */
+          /* empty: the function returns on an empty view at its entry */
           while ( 1 ) {
             memcpy(d + voff, buf + paddr_bytes, bytes);
             paddr_bytes += bytes;
@@ -764,6 +792,7 @@ ca_stack_xfer_parents (CAStack *ca, char *d, int dir, int into_buffers)
         }
         else {
           /* dir-hoisted PUT inner loop, incremental voff. */
+          /* empty: the function returns on an empty view at its entry */
           while ( 1 ) {
             memcpy(buf + paddr_bytes, d + voff, bytes);
             paddr_bytes += bytes;
@@ -795,7 +824,7 @@ ca_stack_xfer_parents (CAStack *ca, char *d, int dir, int into_buffers)
 static void
 ca_stack_func_xfer_all (void *ap, void *data, int dir)
 {
-  ca_stack_mask_refresh((CAStack *) ap, dir == CA_XFER_PUT);
+  ca_stack_mask_refresh((CAStack *) ap);
   ca_stack_xfer_parents((CAStack *) ap, (char *) data, dir, 0);
 }
 
@@ -807,9 +836,9 @@ static void
 ca_stack_func_allocate (void *ap)
 {
   CAStack *ca = (CAStack *) ap;
-  ca_stack_mask_refresh(ca, 0);
+  ca_stack_mask_refresh(ca);
   ca_attach_all(ca->parents, ca->n_parents);
-  ca->ptr = xmalloc(ca_length(ca));
+  ca->ptr = ca_alloc_cells((CArray *) ca);
 }
 
 static VALUE
@@ -823,23 +852,18 @@ static void
 ca_stack_func_attach (void *ap)
 {
   CAStack *ca = (CAStack *) ap;
-  ca_stack_mask_refresh(ca, 0);
-  int32_t k;
-  int     tag = 0;
+  ca_stack_mask_refresh(ca);
   ca_attach_all(ca->parents, ca->n_parents);
-  rb_protect(ca_stack_attach_owned, (VALUE) ca, &tag);
-  if ( tag ) {
-    for ( k = 0; k < ca->n_parents; k++ ) {
-      ca_detach(ca->parents[k]);
-    }
-    rb_jump_tag(tag);
-  }
+  ca_fill_or_detach(ca->n_parents, ca->parents, ca_stack_attach_owned, (VALUE) ca);
 }
 
+static void ca_stack_mask_refuse_sync (CAStack *ca);
+
 static void
 ca_stack_func_sync (void *ap)
 {
   CAStack *ca = (CAStack *) ap;
+  ca_stack_mask_refuse_sync(ca);
   ca_stack_xfer_parents(ca, ca->ptr, CA_XFER_PUT, 1);
   ca_sync_all(ca->parents, ca->n_parents);
   ca_stack_mask_settle(ca);
@@ -865,7 +889,7 @@ static void
 ca_stack_func_fill_data (void *ap, void *ptr)
 {
   CAStack *ca = (CAStack *) ap;
-  ca_stack_mask_refresh(ca, 1);
+  ca_stack_mask_refresh(ca);
   int32_t k;
   for ( k = 0; k < ca->n_parents; k++ ) {
     ca_fill(ca->parents[k], ptr);
@@ -968,54 +992,172 @@ ca_stack_func_fold_stride (void *ap, ca_fold_t *f, void **next_parent)
 /* operation table                                                      */
 /* ------------------------------------------------------------------- */
 
-/* The table's write slots: after a write, refuse a true that reached the
-   stand-in of a value array or a mask array (ca_multi_parent_mask_check).
-   Only the mask of a CAStack has stand-ins to check. */
+/* The table's write slots: after a write that may have put a true into a
+   stand-in, the true goes on to the parent's mask, or is refused for a
+   value array or a mask array (ca_mask_standin_settle).  Only the mask of
+   a CAStack has stand-ins. */
+/* A write to the mask of a CAStack, run once against blank masks first
+   (ca_multi_parent_mask_refuse_first), so that a write refused for a value
+   array or mask array part changes no other part. */
+enum { CA_STACK_PUT_INDEX, CA_STACK_PUT_ADDRS, CA_STACK_PUT_STRIDE, CA_STACK_PUT_ALL,
+       CA_STACK_PUT_FILL, CA_STACK_PUT_SYNC, CA_STACK_PUT_FILL_ADDRS,
+       CA_STACK_PUT_FILL_STRIDE };
+
+typedef struct {
+  int        slot;
+  void      *ap;
+  ca_size_t *idx;
+  ca_size_t  n;
+  ca_size_t *addrs;
+  ca_size_t *starts;
+  ca_size_t *counts;
+  ca_size_t *strides;
+  void      *data;
+  ca_size_t  base;
+  int8_t     ndim;
+  ca_size_t *steps;
+} ca_stack_put_t;
+
+static VALUE
+ca_stack_put_body (VALUE arg)
+{
+  ca_stack_put_t *a = (ca_stack_put_t *) arg;
+  switch ( a->slot ) {
+  case CA_STACK_PUT_INDEX:
+    ca_stack_func_xfer_index(a->ap, a->idx, a->data, CA_XFER_PUT); break;
+  case CA_STACK_PUT_ADDRS:
+    ca_stack_func_xfer_addrs(a->ap, a->n, a->addrs, a->data, CA_XFER_PUT); break;
+  case CA_STACK_PUT_STRIDE:
+    ca_stack_func_xfer_stride(a->ap, a->starts, a->counts, a->strides, a->data,
+                             CA_XFER_PUT); break;
+  case CA_STACK_PUT_ALL:
+    ca_stack_func_xfer_all(a->ap, a->data, CA_XFER_PUT); break;
+  case CA_STACK_PUT_FILL:
+    ca_stack_func_fill_data(a->ap, a->data); break;
+  case CA_STACK_PUT_FILL_ADDRS:
+    ca_fill_addrs_default(a->ap, a->n, a->addrs, a->data); break;
+  case CA_STACK_PUT_FILL_STRIDE:
+    ca_fill_stride_default(a->ap, a->base, a->ndim, a->counts, a->steps,
+                           a->data); break;
+  case CA_STACK_PUT_SYNC:
+    ca_stack_xfer_parents((CAStack *) a->ap, ((CArray *) a->ap)->ptr, CA_XFER_PUT, 1);
+    break;
+  }
+  return Qnil;
+}
+
 static void
-ca_stack_mask_check (CAStack *ca)
+ca_stack_mask_refuse_first (ca_stack_put_t *a)
 {
-  CAStack *o = (CAStack *) ca->mask_owner;
+  CAStack *o = (CAStack *) ((CAStack *) a->ap)->mask_owner;
   if ( o != NULL ) {
-    ca_multi_parent_mask_check((CArray *) ca, o->parents, o->mask_standins,
-                               o->n_parents);
+    ca_multi_parent_mask_refuse_first((CArray *) a->ap, o->parents,
+                                      o->mask_standins, o->n_parents,
+                                      ca_stack_put_body, (VALUE) a);
+  }
+}
+
+static void
+ca_stack_mask_refuse_sync (CAStack *ca)
+{
+  ca_stack_put_t a = { CA_STACK_PUT_SYNC, ca, NULL, 0, NULL, NULL, NULL, NULL, NULL };
+  ca_stack_mask_refuse_first(&a);
+}
+
+/* After a write of n cells of `data` to the mask of a CAStack: a true
+   that went into a stand-in goes on to its parent's mask. */
+static void
+ca_stack_mask_settle_after (CAStack *ca, const void *data, ca_size_t n)
+{
+  if ( ca->mask_owner != NULL && ca_mask_any_true(data, n) ) {
+    ca_stack_mask_settle(ca);
   }
 }
 
 static void
 ca_stack_put_xfer_index (void *ap, ca_size_t *idx, void *data, int dir)
 {
+  if ( dir == CA_XFER_PUT ) {
+    ca_stack_put_t a = { CA_STACK_PUT_INDEX, ap, idx, 0, NULL, NULL, NULL, NULL, data };
+    ca_stack_mask_refuse_first(&a);
+  }
   ca_stack_func_xfer_index(ap, idx, data, dir);
-  if ( dir == CA_XFER_PUT ) ca_stack_mask_check((CAStack *) ap);
+  if ( dir == CA_XFER_PUT ) ca_stack_mask_settle_after((CAStack *) ap, data, 1);
 }
 
 static void
 ca_stack_put_xfer_addrs (void *ap, ca_size_t n, ca_size_t *addrs, void *data,
                          int dir)
 {
+  if ( dir == CA_XFER_PUT ) {
+    ca_stack_put_t a = { CA_STACK_PUT_ADDRS, ap, NULL, n, addrs, NULL, NULL, NULL, data };
+    ca_stack_mask_refuse_first(&a);
+  }
   ca_stack_func_xfer_addrs(ap, n, addrs, data, dir);
-  if ( dir == CA_XFER_PUT ) ca_stack_mask_check((CAStack *) ap);
+  if ( dir == CA_XFER_PUT ) ca_stack_mask_settle_after((CAStack *) ap, data, n);
 }
 
 static void
 ca_stack_put_xfer_stride (void *ap, ca_size_t *starts, ca_size_t *counts,
                           ca_size_t *strides, void *data, int dir)
 {
+  if ( dir == CA_XFER_PUT ) {
+    ca_stack_put_t a = { CA_STACK_PUT_STRIDE, ap, NULL, 0, NULL, starts, counts, strides, data };
+    ca_stack_mask_refuse_first(&a);
+  }
   ca_stack_func_xfer_stride(ap, starts, counts, strides, data, dir);
-  if ( dir == CA_XFER_PUT ) ca_stack_mask_check((CAStack *) ap);
+  if ( dir == CA_XFER_PUT ) {
+    ca_stack_mask_settle_after((CAStack *) ap, data,
+                               ca_shape_elements(((CArray *) ap)->ndim, counts, 1));
+  }
 }
 
 static void
 ca_stack_put_xfer_all (void *ap, void *data, int dir)
 {
+  if ( dir == CA_XFER_PUT ) {
+    ca_stack_put_t a = { CA_STACK_PUT_ALL, ap, NULL, 0, NULL, NULL, NULL, NULL, data };
+    ca_stack_mask_refuse_first(&a);
+  }
   ca_stack_func_xfer_all(ap, data, dir);
-  if ( dir == CA_XFER_PUT ) ca_stack_mask_check((CAStack *) ap);
+  if ( dir == CA_XFER_PUT ) {
+    ca_stack_mask_settle_after((CAStack *) ap, data, ((CArray *) ap)->elements);
+  }
 }
 
 static void
 ca_stack_put_fill_data (void *ap, void *ptr)
 {
+  {
+    ca_stack_put_t a = { CA_STACK_PUT_FILL, ap, NULL, 0, NULL, NULL, NULL, NULL, ptr };
+    ca_stack_mask_refuse_first(&a);
+  }
   ca_stack_func_fill_data(ap, ptr);
-  ca_stack_mask_check((CAStack *) ap);
+  ca_stack_mask_settle_after((CAStack *) ap, ptr, 1);
+}
+
+/* A fill of part of the mask goes cell by cell through xfer_index; run
+   the whole of it against blank masks first, so that a cell refused late
+   does not leave the cells before it written. */
+static void
+ca_stack_put_fill_addrs (void *ap, ca_size_t n, ca_size_t *addrs, void *ptr)
+{
+  ca_stack_put_t a = { CA_STACK_PUT_FILL_ADDRS, ap, NULL, n, addrs, NULL, NULL,
+                     NULL, ptr };
+  ca_stack_mask_refuse_first(&a);
+  ca_fill_addrs_default(ap, n, addrs, ptr);
+  ca_stack_mask_settle_after((CAStack *) ap, ptr, 1);
+}
+
+static void
+ca_stack_put_fill_stride (void *ap, ca_size_t base, int8_t ndim,
+                         ca_size_t *counts, ca_size_t *steps, void *ptr)
+{
+  ca_stack_put_t a = { CA_STACK_PUT_FILL_STRIDE, ap, NULL, 0, NULL, NULL, counts,
+                     NULL, ptr, base, ndim, steps };
+  ca_stack_mask_refuse_first(&a);
+  ca_fill_stride_default(ap, base, ndim, counts, steps, ptr);
+  ca_stack_mask_settle_after((CAStack *) ap, ptr, 1);
 }
 
 ca_operation_function_t ca_stack_func = {
@@ -1149,8 +1291,8 @@ rb_ca_stack_initialize (int argc, VALUE *argv, VALUE self)
     VALUE first = rb_ary_entry(list, 0);
     rb_check_carray_object(first);
     TypedData_Get_Struct(first, CArray, &carray_data_type, ref);
-    k_axis = (int8_t) rb_ca_normalize_axis_for_ndim(
-        NUM2LONG(axis_val), (int) ref->ndim + 1, "CAStack.new");
+    k_axis = (int8_t) ca_normalize_axis_arg(
+        axis_val, (int) ref->ndim + 1, "CAStack.new");
   }
   TypedData_Get_Struct(self, CAStack, &castack_data_type, ca);
   ca_check_uninitialized(ca);
@@ -1247,6 +1389,9 @@ Init_ca_obj_stack (void)
   rb_cCAStack     = rb_define_class("CAStack", rb_cCAView);
   rb_cCAStackMask = rb_define_class("CAStackMask", rb_cCAStack);
 
+  ca_stack_func.fill_addrs  = ca_stack_put_fill_addrs;
+  ca_stack_func.fill_stride = ca_stack_put_fill_stride;
+
   CA_OBJ_STACK = ca_install_obj_type(rb_cCAStack,
                                      &castack_data_type,
                                      rb_cCAStackMask,