raa.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2009 The NASM Authors - All Rights Reserved
   4  *   See the file AUTHORS included with the NASM distribution for
   5  *   the specific copyright holders.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following
   9  *   conditions are met:
  10  *
  11  *   * Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  *   * Redistributions in binary form must reproduce the above
  14  *     copyright notice, this list of conditions and the following
  15  *     disclaimer in the documentation and/or other materials provided
  16  *     with the distribution.
  17  *
  18  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  19  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * ----------------------------------------------------------------------- */
  33
  34 #ifndef NASM_RAA_H
  35 #define NASM_RAA_H 1
  36
  37 #include "compiler.h"
  38
  39 /*
  40  * Routines to manage a dynamic random access array of int64_ts which
  41  * may grow in size to be more than the largest single malloc'able
  42  * chunk.
  43  */
  44
  45 #define RAA_BLKSHIFT    15      /* 2**this many longs allocated at once */
  46 #define RAA_BLKSIZE     (1 << RAA_BLKSHIFT)
  47 #define RAA_LAYERSHIFT  15      /* 2**this many _pointers_ allocated */
  48 #define RAA_LAYERSIZE   (1 << RAA_LAYERSHIFT)
  49
  50 typedef struct RAA RAA;
  51 typedef union RAA_UNION RAA_UNION;
  52 typedef struct RAA_LEAF RAA_LEAF;
  53 typedef struct RAA_BRANCH RAA_BRANCH;
  54
  55 struct RAA {
  56     /*
  57      * Number of layers below this one to get to the real data. 0
  58      * means this structure is a leaf, holding RAA_BLKSIZE real
  59      * data items; 1 and above mean it's a branch, holding
  60      * RAA_LAYERSIZE pointers to the next level branch or leaf
  61      * structures.
  62      */
  63     int layers;
  64
  65     /*
  66      * Number of real data items spanned by one position in the
  67      * `data' array at this level. This number is 0 trivially, for
  68      * a leaf (level 0): for a level 1 branch it should be
  69      * RAA_BLKSHIFT, and for a level 2 branch it's
  70      * RAA_LAYERSHIFT+RAA_BLKSHIFT.
  71      */
  72     int shift;
  73
  74     union RAA_UNION {
  75         struct RAA_LEAF {
  76             int64_t data[RAA_BLKSIZE];
  77         } l;
  78         struct RAA_BRANCH {
  79             struct RAA *data[RAA_LAYERSIZE];
  80         } b;
  81     } u;
  82 };
  83
  84 struct RAA *raa_init(void);
  85 void raa_free(struct RAA *);
  86 int64_t raa_read(struct RAA *, int32_t);
  87 struct RAA *raa_write(struct RAA *r, int32_t posn, int64_t value);
  88
  89 #endif                          /* NASM_RAA_H */