urbit/g/a.c

/* g/a.c
**
** This file is in the public domain.
*/
#include "all.h"

/* _box_slot(): select the right free list to search for a block.
*/
c3_w
_box_slot(c3_w siz_w)
{
  if ( siz_w < 8 ) {
    return 0;
  }
  else {
    c3_w i_w = 1;

    while ( 1 ) {
      if ( i_w == u3_cc_fbox_no ) {
        return (i_w - 1);
      }
      if ( siz_w < 16 ) {
        return i_w;
      }
      siz_w = (siz_w + 1) >> 1;
      i_w += 1;
    }
  }
}

/* _box_make(): construct a box.
*/
u3_cs_box*
_box_make(void* box_v, c3_w siz_w, c3_w use_w)
{
  u3_cs_box* box_u = box_v;
  c3_w*      box_w = box_v;

  c3_assert(siz_w >= u3_cc_minimum);

  box_w[0] = siz_w;
  box_w[siz_w - 1] = siz_w;
  box_u->use_w = use_w;
  c3_assert(2 != use_w);

# ifdef  U3_MEMORY_DEBUG
    box_u->cod_w = u3_Code;
    box_u->eus_w = 0;
# endif

  return box_u;
}

/* _box_attach(): attach a box to the free list.
*/
void
_box_attach(u3_cs_box* box_u)
{
  c3_assert(box_u->siz_w >= (1 + c3_wiseof(u3_cs_fbox)));
  c3_assert(0 != u3of(u3_cs_fbox, box_u));

#if 0
  //  For debugging, fill the box with beef.
  {
    c3_w* box_w = (void *)box_u;
    c3_w  i_w;

    for ( i_w = c3_wiseof(u3_cs_box); (i_w + 1) < box_u->siz_w; i_w++ ) {
      box_w[i_w] = 0xdeadbeef;
    }
  }
#endif

  u3R->all.fre_w += box_u->siz_w;
  {
    c3_w             sel_w = _box_slot(box_u->siz_w);
    u3p(u3_cs_fbox)  fre_p = u3of(u3_cs_fbox, box_u);
    u3p(u3_cs_fbox)* pfr_p = &u3R->all.fre_p[sel_w];
    u3p(u3_cs_fbox)  nex_p = *pfr_p;

    u3to(u3_cs_fbox, fre_p)->pre_p = 0;
    u3to(u3_cs_fbox, fre_p)->nex_p = nex_p;
    if ( u3to(u3_cs_fbox, fre_p)->nex_p ) {
      u3to(u3_cs_fbox, u3to(u3_cs_fbox, fre_p)->nex_p)->pre_p = fre_p;
    }
    (*pfr_p) = fre_p;
  }
}

/* _box_detach(): detach a box from the free list.
*/
void
_box_detach(u3_cs_box* box_u)
{
  u3p(u3_cs_fbox) fre_p = u3of(u3_cs_fbox, box_u);
  u3p(u3_cs_fbox) pre_p = u3to(u3_cs_fbox, fre_p)->pre_p;
  u3p(u3_cs_fbox) nex_p = u3to(u3_cs_fbox, fre_p)->nex_p;

  u3R->all.fre_w -= box_u->siz_w;

  if ( nex_p ) {
    c3_assert(u3to(u3_cs_fbox, nex_p)->pre_p == fre_p);
    u3to(u3_cs_fbox, nex_p)->pre_p = pre_p;
  }
  if ( pre_p ) {
    c3_assert(u3to(u3_cs_fbox, pre_p)->nex_p == fre_p);
    u3to(u3_cs_fbox, pre_p)->nex_p = nex_p;
  }
  else {
    c3_w sel_w = _box_slot(box_u->siz_w);

    c3_assert(fre_p == u3R->all.fre_p[sel_w]);
    u3R->all.fre_p[sel_w] = nex_p;
  }
}

/* _me_road_all_hat(): in u3R, allocate directly on the hat.
*/
static c3_w*
_me_road_all_hat(c3_w len_w)
{
  if ( len_w > u3_co_open(u3R) ) {
    u3_cm_bail(c3__meme); return 0;
  }

  if ( u3_yes == u3_co_is_north(u3R) ) {
    c3_w* all_w;
     
    all_w = u3R->hat_w;
    u3R->hat_w += len_w;
    return all_w;
  }  
  else {
    u3R->hat_w -= len_w;
    return u3R->hat_w;
  }
}

#if 0  // not yet used
/* _me_road_all_cap(): in u3R, allocate directly on the cap.
*/
static c3_w*
_me_road_all_cap(c3_w len_w)
{
  if ( len_w > u3_co_open(u3R) ) {
    u3_cm_bail(c3__meme); return 0;
  }

  if ( u3_yes == u3_co_is_north(u3R) ) {
    u3R->cap_w -= len_w;
    return u3R->cap_w;
  }  
  else {
    c3_w* all_w;
     
    all_w = u3R->cap_w;
    u3R->cap_w += len_w;
    return all_w;
  }
}
#endif

#if 0
/* u3_ca_sane(): check allocator sanity.
*/
void
u3_ca_sane(void)
{
  c3_w i_w;
   
  for ( i_w = 0; i_w < u3_cc_fbox_no; i_w++ ) {
    u3_cs_fbox* fre_u = u3R->all.fre_u[i_w];
 
    while ( fre_u ) {
      if ( fre_u == u3R->all.fre_u[i_w] ) {
        c3_assert(fre_u->pre_u == 0);
      }
      else {
        c3_assert(fre_u->pre_u != 0);
        c3_assert(fre_u->pre_u->nex_u == fre_u);
        if ( fre_u->nex_u != 0 ) {
          c3_assert(fre_u->nex_u->pre_u == fre_u);
        }
      }
      fre_u = fre_u->nex_u;
    }
  }
}
#endif

/* _ca_walloc(): u3_ca_walloc() internals.
*/
static void*
_ca_walloc(c3_w len_w)
{
  c3_w siz_w = c3_max(u3_cc_minimum, u3_co_boxed(len_w));
  c3_w sel_w = _box_slot(siz_w);

  //  XX: this logic is totally bizarre, but preserve it.
  //
  if ( (sel_w != 0) && (sel_w != u3_cc_fbox_no - 1) ) {
    sel_w += 1;
  }

  // fprintf(stderr, "walloc %d: *pfr_p %x\n", len_w, u3R->all.fre_p[sel_w]);
  while ( 1 ) {
    u3p(u3_cs_fbox) *pfr_p = &u3R->all.fre_p[sel_w];

    while ( 1 ) {
      if ( 0 == *pfr_p ) {
        if ( sel_w < (u3_cc_fbox_no - 1) ) {
          sel_w += 1;
          break;
        }
        else {
          /* Nothing in top free list.  Chip away at the hat_w.
          */
          return u3_co_boxto(_box_make(_me_road_all_hat(siz_w), siz_w, 1));
        }
      }
      else {
        if ( siz_w > u3to(u3_cs_fbox, *pfr_p)->box_u.siz_w ) {
          /* This free block is too small.  Continue searching.
          */
          pfr_p = &(u3to(u3_cs_fbox, *pfr_p)->nex_p);
          continue;
        } 
        else {
          u3_cs_box* box_u = &(u3to(u3_cs_fbox, *pfr_p)->box_u);

          /* We have found a free block of adequate size.  Remove it
          ** from the free list.
          */
          {
            {
              c3_assert((0 == u3to(u3_cs_fbox, *pfr_p)->pre_p) || 
                  (u3to(u3_cs_fbox, u3to(u3_cs_fbox, *pfr_p)->pre_p)->nex_p 
                        == (*pfr_p)));

              c3_assert((0 == u3to(u3_cs_fbox, *pfr_p)->nex_p) || 
                  (u3to(u3_cs_fbox, u3to(u3_cs_fbox, *pfr_p)->nex_p)->pre_p 
                        == (*pfr_p)));
            }

            if ( 0 != u3to(u3_cs_fbox, *pfr_p)->nex_p ) {
              u3to(u3_cs_fbox, u3to(u3_cs_fbox, *pfr_p)->nex_p)->pre_p = 
                u3to(u3_cs_fbox, *pfr_p)->pre_p;
            }
            *pfr_p = u3to(u3_cs_fbox, *pfr_p)->nex_p;
          }

          /* If we can chop off another block, do it.
          */
          if ( (siz_w + u3_cc_minimum) <= box_u->siz_w ) {
            /* Split the block.
            */ 
            c3_w* box_w = ((c3_w *)(void *)box_u);
            c3_w* end_w = box_w + siz_w;
            c3_w  lef_w = (box_u->siz_w - siz_w);

            _box_attach(_box_make(end_w, lef_w, 0));
            return u3_co_boxto(_box_make(box_w, siz_w, 1));
          }
          else {
            c3_assert(0 == box_u->use_w);
            box_u->use_w = 1;

#ifdef      U2_MEMORY_DEBUG
              box_u->cod_w = u3_Code; 
#endif
            return u3_co_boxto(box_u);
          }
        }
      }
    }
  }
}

int FOO;

/* u3_ca_walloc(): allocate storage words on hat_w.
*/
void*
u3_ca_walloc(c3_w len_w)
{
  void* ptr_v = _ca_walloc(len_w);

#if 0
  if ( (703 == u3_Code) &&
      u3_co_botox(ptr_v) == (u3_cs_box*)(void *)0x200dfe3e4 ) {
    static int xuc_i;

    printf("xuc_i %d\r\n", xuc_i);
    if ( 1 == xuc_i ) { 
      u3_cs_box* box_u = u3_co_botox(ptr_v);

      box_u->cod_w = 999;
      FOO = 1;
    }
    // if ( 9 == xuc_i ) { FOO = 1; }
    xuc_i++;
  }
#endif
  return ptr_v;
}

/* u3_ca_malloc(): allocate storage measured in bytes.
*/
void*
u3_ca_malloc(c3_w len_w)
{
  return u3_ca_walloc((len_w + 3) >> 2);
}

/* u3_ca_wealloc(): realloc in words.
*/
void*
u3_ca_wealloc(void* lag_v, c3_w len_w)
{
  if ( !lag_v ) {
    return u3_ca_malloc(len_w);
  } 
  else {
    u3_cs_box* box_u = u3_co_botox(lag_v);
    c3_w*      old_w = lag_v;
    c3_w       tiz_w = c3_min(box_u->siz_w, len_w);
    {
      c3_w* new_w = u3_ca_walloc(len_w);
      c3_w  i_w;

      for ( i_w = 0; i_w < tiz_w; i_w++ ) {
        new_w[i_w] = old_w[i_w];
      }
      u3_ca_free(lag_v);
      return new_w;
    }
  }
}

/* u3_ca_realloc(): realloc in bytes.
*/
void*
u3_ca_realloc(void* lag_v, c3_w len_w)
{
  return u3_ca_wealloc(lag_v, (len_w + 3) >> 2);
}

/* u3_ca_free(): free storage.
*/
void
u3_ca_free(void* tox_v)
{
  u3_cs_box* box_u = u3_co_botox(tox_v);
  c3_w*      box_w = (c3_w *)(void *)box_u;

  c3_assert(box_u->use_w != 0);
  box_u->use_w -= 1;
  if ( 0 != box_u->use_w ) return;

#if 0
  /* Clear the contents of the block, for debugging.
  */
  {
    c3_w i_w;

    for ( i_w = c3_wiseof(u3_cs_box); (i_w + 1) < box_u->siz_w; i_w++ ) {
      box_w[i_w] = 0xdeadbeef;
    }
  }
#endif

  if ( u3_yes == u3_co_is_north(u3R) ) {
    /* Try to coalesce with the block below.
    */
    if ( box_w != u3R->rut_w ) {
      c3_w       laz_w = *(box_w - 1);
      u3_cs_box* pox_u = (u3_cs_box*)(void *)(box_w - laz_w);

      if ( 0 == pox_u->use_w ) {
        _box_detach(pox_u);
        _box_make(pox_u, (laz_w + box_u->siz_w), 0);

        box_u = pox_u;
        box_w = (c3_w*)(void *)pox_u;
      }
    }

    /* Try to coalesce with the block above, or the wilderness.
    */
    if ( (box_w + box_u->siz_w) == u3R->hat_w ) {
      u3R->hat_w = box_w;
    }
    else {
      u3_cs_box* nox_u = (u3_cs_box*)(void *)(box_w + box_u->siz_w);

      if ( 0 == nox_u->use_w ) {
        _box_detach(nox_u);
        _box_make(box_u, (box_u->siz_w + nox_u->siz_w), 0);
      }
      _box_attach(box_u);
    }
  }
  else {
    /* Try to coalesce with the block above.
    */
    if ( (box_w + box_u->siz_w) != u3R->rut_w ) {
      u3_cs_box* nox_u = (u3_cs_box*)(void *)(box_w + box_u->siz_w);

      if ( 0 == nox_u->use_w ) {
        _box_detach(nox_u);
        _box_make(box_u, (box_u->siz_w + nox_u->siz_w), 0);
      }
    }

    /* Try to coalesce with the block below, or with the wilderness.
    */
    if ( box_w == u3R->hat_w ) {
      u3R->hat_w = (box_w + box_u->siz_w);
    }
    else {
      c3_w laz_w = *(box_w - 1);
      u3_cs_box* pox_u = (u3_cs_box*)(void *)(box_w - laz_w);

      if ( 0 == pox_u->use_w ) {
        _box_detach(pox_u);
        _box_make(pox_u, (laz_w + box_u->siz_w), 0);
        box_u = pox_u;
      }
      _box_attach(box_u);
    }
  }
}

#if 1
/* _me_wash_north(): clean up mug slots after copy.
*/
static void _me_wash_north(u3_noun dog);
static void
_me_wash_north_in(u3_noun som)
{
  if ( u3_so(u3_co_is_cat(som)) ) return;
  if ( u3_ne(u3_co_north_is_junior(u3R, som)) ) return;

  _me_wash_north(som);
}
static void
_me_wash_north(u3_noun dog)
{
  c3_assert(u3_yes == u3_co_is_dog(dog));
  // c3_assert(u3_yes == u3_co_north_is_junior(u3R, dog));
  {
    u3_cs_noun* dog_u = u3_co_to_ptr(dog);

    if ( dog_u->mug_w == 0 ) return;  dog_u->mug_w = 0;    //  power wash
    // if ( dog_u->mug_w >> 31 ) { dog_u->mug_w = 0; }

    if ( u3_so(u3_co_is_pom(dog)) ) {
      u3_cs_cell* god_u = (u3_cs_cell *)(void *)dog_u;
    
      _me_wash_north_in(god_u->hed);
      _me_wash_north_in(god_u->tel);
    }
  } 
}

/* _me_wash_south(): clean up mug slots after copy.
*/
static void _me_wash_south(u3_noun dog);
static void
_me_wash_south_in(u3_noun som)
{
  if ( u3_so(u3_co_is_cat(som)) ) return;
  if ( u3_ne(u3_co_south_is_junior(u3R, som)) ) return;

  _me_wash_south(som);
}
static void
_me_wash_south(u3_noun dog)
{
  c3_assert(u3_yes == u3_co_is_dog(dog));
  // c3_assert(u3_yes == u3_co_south_is_junior(u3R, dog));
  {
    u3_cs_noun* dog_u = u3_co_to_ptr(dog);

    if ( dog_u->mug_w == 0 ) return;  dog_u->mug_w = 0;    //  power wash
    //  if ( dog_u->mug_w >> 31 ) { dog_u->mug_w = 0; }

    if ( u3_so(u3_co_is_pom(dog)) ) {
      u3_cs_cell* god_u = (u3_cs_cell *)(void *)dog_u;
    
      _me_wash_south_in(god_u->hed);
      _me_wash_south_in(god_u->tel);
    }
  } 
}

/* u3_ca_wash(): wash all lazy mugs.  RETAIN.
*/
void
u3_ca_wash(u3_noun som)
{
  if ( u3_so(u3_co_is_cat(som)) ) {
    return;
  }
  if ( u3_so(u3_co_is_north(u3R)) ) {
    if ( u3_so(u3_co_north_is_junior(u3R, som)) ) {
      _me_wash_north(som);
    }
  } 
  else {
    if ( u3_so(u3_co_south_is_junior(u3R, som)) ) {
      _me_wash_south(som);
    }
  }
}
#endif

extern u3_noun BDA, BDB;

/* _me_gain_use(): increment use count.
*/
static void
_me_gain_use(u3_noun dog)
{
  c3_w* dog_w      = u3_co_to_ptr(dog);
  u3_cs_box* box_u = u3_co_botox(dog_w);

  if ( 0x7fffffff == box_u->use_w ) {
    u3_cm_bail(c3__fail);
  }
  else {
    if ( box_u->use_w == 0 ) {
      u3_cm_bail(c3__foul);
    }
    box_u->use_w += 1;

#ifdef U3_MEMORY_DEBUG
    // if ( u3_Code && !box_u->cod_w ) { box_u->cod_w = u3_Code; }

#if 0
    if ( u3_cr_mug(dog) == 0x15d47649 ) {
      static c3_w bug_w = 0;

      printf("bad %x %d %d\r\n", dog, bug_w, box_u->use_w);
      if ( bug_w == 0 ) { abort(); }
      bug_w++;
    }
#endif
#if 0
    {
      static c3_w bug_w = 0;

      if ( BDA == dog ) {
        printf("BDA %d %d\r\n", bug_w, box_u->use_w);
        // if ( bug_w == 0 ) { abort(); }
        bug_w++;
      }
    }
#endif

#if 0
    {
      static c3_w bug_w = 0;

      if ( FOO && u3_co_botox(u3_co_to_ptr(dog)) == (void *)0x200dfe3e4 ) {
        u3_cs_box* box_u = u3_co_botox(u3_co_to_ptr(dog));

        printf("GAIN %d %d\r\n", bug_w, box_u->use_w);
        if ( bug_w == 8 ) { abort(); }
        bug_w++;
      }
    }
#endif
#endif

  }
}

/* _me_copy_north_in(): copy subjuniors on a north road.
*/
static u3_noun _me_copy_north(u3_noun);
static u3_noun
_me_copy_north_in(u3_noun som)
{
  c3_assert(u3_none != som);
  if ( u3_so(u3_co_is_cat(som)) ) {
    return som;
  }
  else { 
    u3_noun dog = som;

    if ( u3_so(u3_co_north_is_senior(u3R, dog)) ) {
      return dog;
    }
    else if ( u3_so(u3_co_north_is_junior(u3R, dog)) ) {
      return _me_copy_north(dog);
    }
    else {
      _me_gain_use(dog);
      return dog;
    }
  }
}
/* _me_copy_north(): copy juniors on a north road.
*/
static u3_noun
_me_copy_north(u3_noun dog)
{
  c3_assert(u3_yes == u3_co_north_is_junior(u3R, dog));

  if ( u3_ne(u3_co_north_is_junior(u3R, dog)) ) {
    if ( u3_ne(u3_co_north_is_senior(u3R, dog)) ) {
      _me_gain_use(dog);
    }
    return dog;
  } 
  else {
    u3_cs_noun* dog_u = u3_co_to_ptr(dog);

    /* Borrow mug slot to record new destination.
    */
    if ( dog_u->mug_w >> 31 ) {
      u3_noun nov = (u3_noun) dog_u->mug_w;

      c3_assert(u3_so(u3_co_north_is_normal(u3R, nov)));
      _me_gain_use(nov);

      return nov;
    }
    else {
      if ( u3_yes == u3_co_is_pom(dog) ) {
        u3_cs_cell* old_u = u3_co_to_ptr(dog);
        c3_w*       new_w = u3_ca_walloc(c3_wiseof(u3_cs_cell));
        u3_noun     new   = u3_co_de_twin(dog, new_w);
        u3_cs_cell* new_u = (u3_cs_cell*)(void *)new_w;

        new_u->mug_w = old_u->mug_w;
        new_u->hed = _me_copy_north_in(old_u->hed);
        new_u->tel = _me_copy_north_in(old_u->tel);

        /* Borrow mug slot to record new destination.
        */
        old_u->mug_w = new;
        return new;
      } 
      else {
        u3_cs_atom* old_u = u3_co_to_ptr(dog);
        c3_w*       new_w = u3_ca_walloc(old_u->len_w + c3_wiseof(u3_cs_atom));
        u3_noun     new   = u3_co_de_twin(dog, new_w);
        u3_cs_atom* new_u = (u3_cs_atom*)(void *)new_w;

        new_u->mug_w = old_u->mug_w;
        new_u->len_w = old_u->len_w;
        {
          c3_w i_w;

          for ( i_w=0; i_w < old_u->len_w; i_w++ ) {
            new_u->buf_w[i_w] = old_u->buf_w[i_w];
          }
        }

        /* Borrow mug slot to record new destination.
        */
        old_u->mug_w = new;
        return new;
      }
    }
  }
}

/* _me_copy_south_in(): copy subjuniors on a south road.
*/
static u3_noun _me_copy_south(u3_noun);
static u3_noun
_me_copy_south_in(u3_noun som)
{
  c3_assert(u3_none != som);
  if ( u3_so(u3_co_is_cat(som)) ) {
    return som;
  }
  else { 
    u3_noun dog = som;

    if ( u3_so(u3_co_south_is_senior(u3R, dog)) ) {
      return dog;
    }
    else if ( u3_so(u3_co_south_is_junior(u3R, dog)) ) {
      return _me_copy_south(dog);
    }
    else {
      _me_gain_use(dog);
      return dog;
    }
  }
}
/* _me_copy_south(): copy juniors on a south road.
*/
static u3_noun
_me_copy_south(u3_noun dog)
{
  c3_assert(u3_yes == u3_co_south_is_junior(u3R, dog));

  if ( u3_ne(u3_co_south_is_junior(u3R, dog)) ) {
    if ( u3_ne(u3_co_south_is_senior(u3R, dog)) ) {
      _me_gain_use(dog);
    }
    return dog;
  } 
  else {
    u3_cs_noun* dog_u = u3_co_to_ptr(dog);

    /* Borrow mug slot to record new destination.
    */
    if ( dog_u->mug_w >> 31 ) {
      u3_noun nov = (u3_noun) dog_u->mug_w;

      // printf("south: %p is already %p\r\n", dog_u, u3_co_to_ptr(nov));

      c3_assert(u3_so(u3_co_south_is_normal(u3R, nov)));
      _me_gain_use(nov);

      return nov;
    }
    else {
      if ( u3_yes == u3_co_is_pom(dog) ) {
        u3_cs_cell* old_u = u3_co_to_ptr(dog);
        c3_w*       new_w = u3_ca_walloc(c3_wiseof(u3_cs_cell));
        u3_noun     new   = u3_co_de_twin(dog, new_w);
        u3_cs_cell* new_u = (u3_cs_cell*)(void *)new_w;

        // printf("south: cell %p to %p\r\n", old_u, new_u);

        new_u->mug_w = old_u->mug_w;
        // new_u->mug_w = 0;
        new_u->hed = _me_copy_south_in(old_u->hed);
        new_u->tel = _me_copy_south_in(old_u->tel);

        /* Borrow mug slot to record new destination.
        */
        old_u->mug_w = new;
        return new;
      } 
      else {
        u3_cs_atom* old_u = u3_co_to_ptr(dog);
        c3_w*       new_w = u3_ca_walloc(old_u->len_w + c3_wiseof(u3_cs_atom));
        u3_noun     new   = u3_co_de_twin(dog, new_w);
        u3_cs_atom* new_u = (u3_cs_atom*)(void *)new_w;

        // printf("south: atom %p to %p\r\n", old_u, new_u);

        new_u->mug_w = old_u->mug_w;
        // new_u->mug_w = 0;
        new_u->len_w = old_u->len_w;
        {
          c3_w i_w;

          for ( i_w=0; i_w < old_u->len_w; i_w++ ) {
            new_u->buf_w[i_w] = old_u->buf_w[i_w];
          }
        }

        /* Borrow mug slot to record new destination.
        */
        old_u->mug_w = new;
        return new;
      }
    }
  }
}

/* _me_take_north(): take on a north road.
*/
static u3_noun
_me_take_north(u3_noun dog)
{
  if ( u3_yes == u3_co_north_is_senior(u3R, dog) ) {
    /*  senior pointers are not refcounted
    */
    return dog;
  }
  else if ( u3_yes == u3_co_north_is_junior(u3R, dog) ) {
    /* junior pointers are copied
    */
    u3_noun mos = _me_copy_north(dog);

    // printf("north: %p to %p\r\n", u3_co_to_ptr(dog), u3_co_to_ptr(mos));
    return mos;
  }
  else {
    /* normal pointers are refcounted
    */
    _me_gain_use(dog);
    return dog;
  }
}

/* _me_take_south(): take on a south road.
*/
static u3_noun
_me_take_south(u3_noun dog)
{
  if ( u3_yes == u3_co_south_is_senior(u3R, dog) ) {
    /*  senior pointers are not refcounted
    */
    return dog;
  }
  else if ( u3_yes == u3_co_south_is_junior(u3R, dog) ) {
    /* junior pointers are copied
    */
    u3_noun mos = _me_copy_south(dog);

    // printf("south: %p to %p\r\n", u3_co_to_ptr(dog), u3_co_to_ptr(mos));
    return mos;
  }
  else {
    /* normal pointers are refcounted
    */
    _me_gain_use(dog);
    return dog;
  }
}

/* u3_ca_take(): gain, copying juniors.
*/
u3_noun
u3_ca_take(u3_noun som)
{
  c3_assert(u3_none != som);

  if ( u3_so(u3_co_is_cat(som)) ) {
    return som;
  }
  else {
    return u3_so(u3_co_is_north(u3R))
              ? _me_take_north(som)
              : _me_take_south(som);
  }
}

/* u3_ca_left(): true of junior if preserved.
*/
c3_o
u3_ca_left(u3_noun som)
{
  if ( u3_so(u3_co_is_cat(som)) ||
       u3_ne(u3_co_is_junior(u3R, som)) )
  {
    return u3_yes;
  }
  else {
    u3_cs_noun* dog_u = u3_co_to_ptr(som);

    return u3_say(0 != (dog_u->mug_w >> 31));
  }
}

/* _me_gain_north(): gain on a north road.
*/
static u3_noun
_me_gain_north(u3_noun dog)
{
  if ( u3_yes == u3_co_north_is_senior(u3R, dog) ) {
    /*  senior pointers are not refcounted
    */
    return dog;
  }
  else {
    /* junior nouns are disallowed
    */
    c3_assert(u3_ne(u3_co_north_is_junior(u3R, dog)));

    /* normal pointers are refcounted
    */
    _me_gain_use(dog);
    return dog;
  }
}

/* _me_gain_south(): gain on a south road.
*/
static u3_noun
_me_gain_south(u3_noun dog)
{
  if ( u3_yes == u3_co_south_is_senior(u3R, dog) ) {
    /*  senior pointers are not refcounted
    */
    return dog;
  }
  else {
    /* junior nouns are disallowed
    */
    c3_assert(u3_ne(u3_co_south_is_junior(u3R, dog)));

    /* normal nouns are refcounted
    */
    _me_gain_use(dog);
    return dog;
  }
}

/* _me_lose_north(): lose on a north road.
*/
static void
_me_lose_north(u3_noun dog)
{
top:
  if ( u3_yes == u3_co_north_is_normal(u3R, dog) ) {
    c3_w* dog_w      = u3_co_to_ptr(dog);
    u3_cs_box* box_u = u3_co_botox(dog_w);

    if ( box_u->use_w > 1 ) {
      box_u->use_w -= 1;
    }
    else {
      if ( 0 == box_u->use_w ) {
        u3_cm_bail(c3__foul);
      }
      else {
        if ( u3_so(u3_co_is_pom(dog)) ) {
          u3_cs_cell* dog_u = (void *)dog_w;
          u3_noun     h_dog = dog_u->hed;
          u3_noun     t_dog = dog_u->tel;

          if ( u3_ne(u3_co_is_cat(h_dog)) ) {
            _me_lose_north(h_dog);
          }
          u3_ca_free(dog_w);
          if ( u3_ne(u3_co_is_cat(t_dog)) ) {
            dog = t_dog;
            goto top;
          }
        }
        else {
          u3_ca_free(dog_w);
        }
      }
    }
  }
}

/* _me_lose_south(): lose on a south road.
*/
static void
_me_lose_south(u3_noun dog)
{
top:
  if ( u3_yes == u3_co_south_is_normal(u3R, dog) ) {
    c3_w* dog_w      = u3_co_to_ptr(dog);
    u3_cs_box* box_u = u3_co_botox(dog_w);

    if ( box_u->use_w > 1 ) {
      box_u->use_w -= 1;
    }
    else {
      if ( 0 == box_u->use_w ) {
        u3_cm_bail(c3__foul);
      }
      else {
        if ( u3_so(u3_co_is_pom(dog)) ) {
          u3_cs_cell* dog_u = (void *)dog_w;
          u3_noun     h_dog = dog_u->hed;
          u3_noun     t_dog = dog_u->tel;

          if ( u3_ne(u3_co_is_cat(h_dog)) ) {
            _me_lose_south(h_dog);
          }
          u3_ca_free(dog_w);
          if ( u3_ne(u3_co_is_cat(t_dog)) ) {
            dog = t_dog;
            goto top;
          }
        }
        else {
          u3_ca_free(dog_w);
        }
      }
    }
  }
}

/* u3_ca_gain(): gain a reference count in normal space.
*/
u3_noun
u3_ca_gain(u3_noun som)
{
  c3_assert(u3_none != som);

  if ( u3_so(u3_co_is_cat(som)) ) {
    return som;
  }
  else {
    return u3_so(u3_co_is_north(u3R))
              ? _me_gain_north(som)
              : _me_gain_south(som);
  }
}

/* u3_ca_lose(): lose a reference count.
*/
void
u3_ca_lose(u3_noun som)
{
  if ( u3_ne(u3_co_is_cat(som)) ) {
    if ( u3_so(u3_co_is_north(u3R)) ) {
      _me_lose_north(som);
    } else {
      _me_lose_south(som);
    }
  }
}

/* u3_ca_use(): reference count.
*/
c3_w
u3_ca_use(u3_noun som)
{
  if ( u3_so(u3_co_is_cat(som)) ) {
    return 1;
  } 
  else {
    c3_w* dog_w      = u3_co_to_ptr(som);
    u3_cs_box* box_u = u3_co_botox(dog_w);

    return box_u->use_w;
  }
}

/* u3_ca_mark_ptr(): mark a pointer for gc.  Produce size if first mark.
*/
c3_w
u3_ca_mark_ptr(void* ptr_v)
{
  if ( u3_so(u3_co_is_north(u3R)) ) {
    if ( !((ptr_v >= (void*)u3R->rut_w) && (ptr_v < (void*)u3R->hat_w)) ) {
      return 0;
    }
  }
  else {
    if ( !((ptr_v >= (void*)u3R->hat_w) && (ptr_v < (void*)u3R->rut_w)) ) {
      return 0;
    }
  }
  {
    u3_cs_box* box_u  = u3_co_botox(ptr_v);
    c3_w       siz_w;

#ifdef U3_MEMORY_DEBUG
    if ( box_u->eus_w == 0 ) {
      siz_w = box_u->siz_w;
    } 
    else {
      siz_w = 0;
    }
    box_u->eus_w += 1;
#else
    c3_ws use_ws = (c3_ws)box_u->use_w;

    if ( use_ws == 0 ) {
      fprintf(stderr, "%p is bogus\r\n", ptr_v);
      siz_w = 0;
    }
    else {
      c3_assert(use_ws != 0);

      if ( use_ws < 0 ) {
        use_ws -= 1;
        siz_w = 0;
      } 
      else {
        use_ws = -1;
        siz_w = box_u->siz_w;
      }
      box_u->use_w = (c3_w)use_ws;
    }
#endif
    return siz_w;
  }
}

/* u3_ca_mark_noun(): mark a noun for gc.  Produce size.
*/
c3_w
u3_ca_mark_noun(u3_noun som)
{
  c3_w siz_w = 0;

  while ( 1 ) {
    if ( u3_so(u3_co_is_senior(u3R, som)) ) {
      return siz_w;
    }
    else {
      c3_w* dog_w = u3_co_to_ptr(som);
      c3_w  new_w = u3_ca_mark_ptr(dog_w);

      if ( 0 == new_w ) {
        return siz_w;
      }
      else {
        siz_w += new_w;
        if ( u3_so(u3du(som)) ) {
          siz_w += u3_ca_mark_noun(u3h(som));
          som = u3t(som);
        }
        else return siz_w;
      }
    }
  }
}

/* u3_ca_print_memory: print memory amount.
*/
void
u3_ca_print_memory(c3_c* cap_c, c3_w wor_w)
{
  c3_w byt_w = (wor_w * 4);
  c3_w gib_w = (byt_w / 1000000000);
  c3_w mib_w = (byt_w % 1000000000) / 1000000;
  c3_w kib_w = (byt_w % 1000000) / 1000;
  c3_w bib_w = (byt_w % 1000);

  if ( byt_w ) {
    if ( gib_w ) {
      fprintf(stderr, "%s: GB/%d.%03d.%03d.%03d\r\n", 
          cap_c, gib_w, mib_w, kib_w, bib_w);
    }
    else if ( mib_w ) {
      fprintf(stderr, "%s: MB/%d.%03d.%03d\r\n", cap_c, mib_w, kib_w, bib_w);
    }
    else if ( kib_w ) {
      fprintf(stderr, "%s: KB/%d.%03d\r\n", cap_c, kib_w, bib_w);
    }
    else if ( bib_w ) {
      fprintf(stderr, "%s: B/%d\r\n", cap_c, bib_w);
    }
  }
}

/* u3_ca_sweep(): sweep a fully marked road.
*/
void
u3_ca_sweep(c3_c* cap_c)
{
  c3_w neg_w, pos_w, leq_w, weq_w, tot_w, caf_w;

  /* Measure allocated memory by counting the free list.
  */
  {
    c3_w end_w;
    c3_w fre_w = 0;
    c3_w i_w;

    end_w = u3_so(u3_co_is_north(u3R)) 
                ? (u3R->hat_w - u3R->rut_w)
                : (u3R->rut_w - u3R->hat_w);

    for ( i_w = 0; i_w < u3_cc_fbox_no; i_w++ ) {
      u3p(u3_cs_fbox) fre_p = u3R->all.fre_p[i_w];
   
      while ( fre_p ) {
        u3_cs_fbox* fre_u = u3to(u3_cs_fbox, fre_p);

        fre_w += fre_u->box_u.siz_w;
        fre_p = fre_u->nex_p;
      }
    }
    neg_w = (end_w - fre_w);
  }

  /* Sweep through the arena, repairing and counting leaks.
  */
  pos_w = leq_w = weq_w = 0;
  {
    c3_w* box_w = u3_so(u3_co_is_north(u3R)) ? u3R->rut_w : u3R->hat_w;

    while ( box_w < (u3_so(u3_co_is_north(u3R)) ? u3R->hat_w : u3R->rut_w) ) {
      u3_cs_box* box_u  = (void *)box_w;

#ifdef U3_MEMORY_DEBUG
      if ( box_u->use_w != box_u->eus_w ) {
        if ( box_u->eus_w != 0 ) {
          if ( box_u->use_w == 0 ) {
            printf("dank %p (%d, %d)\r\n", box_u, box_u->use_w, box_u->eus_w);
          }
          else {
            printf("weak %p %x (%d, %d)\r\n", 
                    box_u, 
                    ((u3_cs_noun *)(u3_co_boxto(box_w)))->mug_w,
                    box_u->use_w, box_u->eus_w);
            // u3_cm_p("weak", u3_co_to_pom(u3_co_outa(u3_co_boxto(box_w))));
          }
          weq_w += box_u->siz_w;
        }
        else {
          printf("leak %p %x (%d)\r\n", 
                  box_u, 
                  ((u3_cs_noun *)(u3_co_boxto(box_w)))->mug_w
                    ? ((u3_cs_noun *)(u3_co_boxto(box_w)))->mug_w
                    : u3_cr_mug(u3_co_to_pom(u3_co_outa(u3_co_boxto(box_w)))),
                  box_u->use_w);
          // u3_cm_p("leak", u3_co_to_pom(u3_co_outa(u3_co_boxto(box_w))));
          leq_w += box_u->siz_w;
        }
        if ( box_u->cod_w ) {
          u3_cm_p("  code", box_u->cod_w);
        }
        box_u->use_w = box_u->eus_w;
      }
      else {
        if ( box_u->use_w ) {
          pos_w += box_u->siz_w;
        }
      }
      box_u->eus_w = 0;
#else
      c3_ws use_ws = (c3_ws)box_u->use_w;

      if ( use_ws > 0 ) {
        printf("leak %p\r\n", box_u);
        leq_w += box_u->siz_w;
        box_u->use_w = 0;

        _box_attach(box_u);
      }
      else if ( use_ws < 0 ) {
        pos_w += box_u->siz_w;
        box_u->use_w = (c3_w)(0 - use_ws);
      }
#endif
      box_w += box_u->siz_w;
    }
  }

  tot_w = u3_so(u3_co_is_north(u3R)) 
                ? u3R->mat_w - u3R->rut_w
                : u3R->rut_w - u3R->mat_w;
  caf_w = u3_so(u3_co_is_north(u3R)) 
                ? u3R->mat_w - u3R->cap_w
                : u3R->cap_w - u3R->mat_w;

  // u3_ca_print_memory("available", (tot_w - pos_w));
  // u3_ca_print_memory("allocated", pos_w);
  // u3_ca_print_memory("volatile", caf_w);
  u3_ca_print_memory("leaked", leq_w);
  u3_ca_print_memory("weaked", weq_w);

  c3_assert((pos_w + leq_w + weq_w) == neg_w);

  if ( 0 != leq_w || (0 != weq_w) ) { c3_assert(0); }
}

/* u3_ca_slab(): create a length-bounded proto-atom.
*/
c3_w*
u3_ca_slab(c3_w len_w)
{
  c3_w*       nov_w = u3_ca_walloc(len_w + c3_wiseof(u3_cs_atom));
  u3_cs_atom* pug_u = (void *)nov_w;

  pug_u->mug_w = 0;
  pug_u->len_w = len_w;

  /* Clear teh slab.
  */
  {
    c3_w i_w;

    for ( i_w=0; i_w < len_w; i_w++ ) {
      pug_u->buf_w[i_w] = 0;
    }
  }
  return pug_u->buf_w;
}

/* u3_ca_slaq(): u3_ca_slaq() with a defined blocksize.
*/
c3_w*
u3_ca_slaq(c3_g met_g, c3_w len_w)
{
  return u3_ca_slab(((len_w << met_g) + 31) >> 5);
}

/* u3_ca_malt(): measure and finish a proto-atom.
*/
u3_noun
u3_ca_malt(c3_w* sal_w)
{
  c3_w*       nov_w = (sal_w - c3_wiseof(u3_cs_atom));
  u3_cs_atom* nov_u = (void *)nov_w;
  c3_w        len_w;

  for ( len_w = nov_u->len_w; len_w; len_w-- ) {
    if ( 0 != nov_u->buf_w[len_w - 1] ) {
      break;
    }
  }
  return u3_ca_mint(sal_w, len_w);
}

/* u3_ca_moot(): finish a pre-measured proto-atom; dangerous.
*/
u3_noun
u3_ca_moot(c3_w* sal_w)
{
  c3_w*       nov_w = (sal_w - c3_wiseof(u3_cs_atom));
  u3_cs_atom* nov_u = (void*)nov_w;
  c3_w        len_w = nov_u->len_w;
  c3_w        las_w = nov_u->buf_w[len_w - 1];

  c3_assert(0 != len_w);
  c3_assert(0 != las_w);

  if ( 1 == len_w ) {
    if ( u3_so(u3_co_is_cat(las_w)) ) {
      u3_ca_free(nov_w);

      return las_w;
    }
  }
  return u3_co_to_pug(u3_co_outa(nov_w));
}

/* _ca_detect(): in u3_ca_detect().
*/
static c3_d
_ca_detect(u3_ch_root* har_u, u3_noun fum, u3_noun som, c3_d axe_d)
{
  while ( 1 ) {
    if ( som == fum ) {
      return axe_d;
    }
    else if ( u3_ne(u3du(fum)) || (u3_none != u3_ch_get(har_u, fum)) ) {
      return 0;
    }
    else {
      c3_d eax_d;

      u3_ch_put(har_u, fum, 0);

      if ( 0 != (eax_d = _ca_detect(har_u, u3h(fum), som, 2ULL * axe_d)) ) {
        return u3_yes;
      }
      else {
        fum = u3t(fum);
        axe_d = (2ULL * axe_d) + 1;
      }
    }
  }
}

/* u3_ca_detect(): for debugging, check if (som) is referenced from (fum). 
**
** (som) and (fum) are both RETAINED.
*/
c3_d
u3_ca_detect(u3_noun fum, u3_noun som)
{
  u3_ch_root* har_u = u3_ch_new();
  c3_o        ret_o;

  ret_o = _ca_detect(har_u, fum, som, 1);
  u3_ch_free(har_u);

  return ret_o;
}

/* u3_ca_mint(): finish a measured proto-atom.
*/
u3_noun
u3_ca_mint(c3_w* sal_w, c3_w len_w)
{
  c3_w*       nov_w = (sal_w - c3_wiseof(u3_cs_atom));
  u3_cs_atom* nov_u = (void*)nov_w;

  /* See if we can free the slab entirely.
  */
  if ( len_w == 0 ) {
    u3_ca_free(nov_w);

    return 0;
  }
  else if ( len_w == 1 ) {
    c3_w low_w = nov_u->buf_w[0];

    if ( u3_so(u3_co_is_cat(low_w)) ) {
      u3_ca_free(nov_w);

      return low_w;
    }
  }

  /* See if we can strip off a block on the end.
  */
  {
    c3_w old_w = nov_u->len_w;
    c3_w dif_w = (old_w - len_w);

    if ( dif_w >= u3_cc_minimum ) {
      c3_w* box_w = (void *)u3_co_botox(nov_w);
      c3_w* end_w = (nov_w + c3_wiseof(u3_cs_atom) + len_w + 1);
      c3_w  asz_w = (end_w - box_w);
      c3_w  bsz_w = box_w[0] - asz_w;

      _box_attach(_box_make(end_w, bsz_w, 0));

      box_w[0] = asz_w;
      box_w[asz_w - 1] = asz_w;
    }
    nov_u->len_w = len_w;
  }
  return u3_co_to_pug(u3_co_outa(nov_w));
}

#ifdef U3_MEMORY_DEBUG
/* u3_ca_lush(): leak push.
*/
c3_w 
u3_ca_lush(c3_w lab_w)
{
  c3_w cod_w = u3_Code;

  u3_Code = lab_w;
  return cod_w;
}

/* u3_ca_lop(): leak pop.
*/
void
u3_ca_lop(c3_w lab_w)
{
  u3_Code = 0;
}
#endif