src/apc/irmem.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <stdint.h>
   4 #include <errno.h>
   5 #include <string.h>
   6 #include <stdlib.h>
   7 #include <apc/ir.h>
   8
   9
  10 struct odat*
  11 alloc_odat(void);
  12 void
  13 alloc_vdat(void);
  14 struct ref*
  15 alloc_link(void);
  16 struct ref*
  17 alloc_ref(void);
  18 struct cdat*
  19 curr_cdat(void);
  20 struct odat*
  21 curr_odat(void);
  22 struct ele*
  23 curr_ele(void);
  24 struct set*
  25 curr_set(void);
  26 struct ref*
  27 prev_ref(void);
  28
  29 #define CURR_CDAT (*cdat_stackp)
  30 #define CURR_SET set_list[CURR_CDAT->num_sets]
  31 #define CURR_ELE ele_list[CURR_CDAT->CURR_SET.num_ele]
  32 #define PREV_REF (ref_buf[num_refs-1])
  33 #define CURR_REF (ref_buf[num_refs])
  34 #define PREV_ODAT (odat_buf[num_odats-1])
  35 #define CURR_ODAT (odat_buf[num_odats])
  36 #define CURR_VDAT (vdat_buf[num_vdats])
  37 #define PREV_VDAT (vdat_buf[num_vdats-1])
  38 #define CURR_MODEL model_list[CURR_VDAT->num_models]
  39 #define CURR_LINK (link_buf[num_links])
  40 #define CURR_POST (post_buf[num_posts])
  41
  42 /*  General: All information from the directory structure is stored in        */
  43 /*  five buffers that comprise the IR: cdat_buf, odat_buf, vdat_buf, ref_buf  */
  44 /*  and link_buf. Each buf corresponds to the data structure that it stores.  */
  45 /*  The storage techique for all bufs (except cdat) is the same. Each bufs member first */
  46 /*  populates its struct and then allocates the space for the next member     */
  47 /*  and increments the buf index. This means that we have to allocate the     */
  48 /*  very first member of each buf at ir_init(), so that we don't segfault     */
  49 /*  as the first member attempts to access memory that its previous member    */
  50 /*  didn't allocate (because it doesnt exist). We access the buf members      */
  51 /*  through standard array indexing but conceal the tediousness of array      */
  52 /*  indexing with macros. E.g. without macros, acessing an elements name      */
  53 /*  member would look like (split up to not go over line char limit):         */
  54 /*  (*cdat_stackp)->set_list[(*cdat_stackp)->num_sets] */
  55 /*     .ele_list[(*cdat_stackp)->set_list[(*cdat_stackp->num_sets)].num_ele].name */
  56
  57 /* For cdats in cdat_buf, we allocate the memory for a cdat once a cdat
  58    is recognized in the grammar. Cdat_buf is different from the other bufs
  59    because cdats have a root cdat that all cdats are a subclass of. This root
  60    cdat can have a set_list like other cdats.                                */
  61
  62 /*  Elements: Ele stands for element and has two representations in the IR.   */
  63 /*  In the cdat_buf eles store their name, cdat_idx (their classes index in   */
  64 /*  the cdat_buf) and the ref_id (refer to ref ). In the odat_buf, eles store */
  65 /*  their object data (odat). At output time, the ref_id is dereferenced to   */
  66 /*  determine the elements odat which is the data that the engine expects     */
  67 /*  from an element.                                                          */
  68
  69
  70 /*  All bufs are of pointers to their respective structs. When a buf is full */
  71 /*  (number of data structs pointers >= max number of data struct pointers),        */
  72 /*  we need to allocate a more pointers for that buf. Allocate these       */
  73 /*  pointers a page at a time (1024 = Page bytes (4096)/bytes per pointer(4))   */
  74
  75 struct ele {
  76   char name[32];
  77   uint64_t ref_id;
  78   int cdat_idx;
  79 };
  80
  81 /*  Sets: The set is similar to the ele, but it contains a list of its    */
  82 /*  elements. The set is populated at parse time AFTER the elements are   */
  83 /*  populated, due to the nature of bottom up parsing.                    */
  84
  85 struct set {
  86   char name[32];
  87   uint64_t ref_id;
  88   int cdat_idx;
  89   int num_ele;
  90   struct ele ele_list[MAX_ELES];
  91 };
  92
  93 /*  Cdats: A cdat is a class data structure. Cdats serve as the central       */
  94 /*  data types of the IR. At output, the cdat_buf is iterated through and     */
  95 /*  each is written to the output file. For each cdat, sets and element       */
  96 /*  ref_ids must be dereferenced to determine the odat information. Cdats     */
  97 /*  contain pointers to their subclasses so that the relationship between     */
  98 /*  classes can be determined, but the subclasses are not represented inside  */
  99 /*  of the cdat itself but rather in the subsequent cdats in cdat_buf. We     */
 100 /*  can determine the number of subclasses (the last index into cdat_buf      */
 101 /*  that represents a subclass of some arbitrary cdat) each cdat has by       */
 102 /*  incrementing num_classes during parse time.                               */
 103 /*  TODO: Should classes point to their parent class?                         */
 104
 105 struct cdat {
 106   char name[32];
 107   int idx;
 108   int num_classes;
 109   int num_sets;
 110   struct cdat* class_list[MAX_CLASSES];
 111   struct set set_list[MAX_SETS];
 112 };
 113
 114 /* There are an unknown amount of cdats at compile time, so we maintain    */
 115 /*   a cdat_buf of cdat pointers that can be expanded as needed.           */
 116 struct cdat* cdat_buf[PTRS_IN_PAGE];
 117
 118 /* The cdat_stack is a stack pointers to cdat pointers, the top of which is
 119    the cdat that is currently being parsed. Whenever a new cdat is recognized
 120    by the grammar (CLOPEN), a cdat is pushed onto the cdat_stack, and we refer
 121    to this cdat through the macro CURR_CDAT. By keeping a cdat_stack, we have
 122    access to the current cdat so that the elements and sets can populate themselves
 123    in the cdat accordingly. */
 124
 125 struct cdat* cdat_stack[PTRS_IN_PAGE];
 126 struct cdat** cdat_stackp;
 127 int num_cdats = 0;
 128 int curr_max_cdats = PTRS_IN_PAGE;
 129
 130 /* Refs: Each set/ele has a reference to its object data (odat) through a ref_id.
 131    Ref_ids are unsigned 64 byte integers that map to the hex values RGBA. During
 132    the construction of the directory structure, users can choose a RGBA value for
 133    each object that any other object can refer to via links (see link). If a user
 134    does not choose an RGBA value, then the object is given one from the system space.
 135    We maintain a doubly linked list of refs in the ref_buf at parse time so that
 136    links can be resolved after the parsing of the directory structure is complete.
 137    For every 16th ref, we create a post so that we can reduce on the search time for
 138    a random access. */
 139
 140 struct ref {
 141   int type;
 142   struct ref* nextref;
 143   struct ref* lastref;
 144   struct odat* odatp;
 145   uint64_t ref_id; //0xFFFFFF->digit
 146 };
 147
 148
 149 /* Like the cdat_buf, ref_buf stores pointers to refs and can
 150    increase in size */
 151 struct ref* ref_buf[PTRS_IN_PAGE];
 152 int num_refs = 0;
 153 int curr_max_refs = PTRS_IN_PAGE;
 154 uint64_t ss_ref_id = 0x00FFFFFF; /* system space for ref_ids */
 155
 156 /* posts for ref_buf */
 157 struct ref* post_buf[PTRS_IN_PAGE];
 158 int num_posts = 0;
 159 int curr_max_posts = PTRS_IN_PAGE;
 160
 161 /* Links: At parse time, a set/ele can include a link in their
 162    grammar representation instead of the actual data and this signifies
 163    to the APC that that set/ele wishes to use the data of another
 164    set/ele, either its video data (vdat) or object data (odat). The link
 165    itself contains the type of link it is, the ref_id OR name, and
 166    which set/ele created the link. During parse time, links can be made
 167    to o/vdats that have yet to be parsed. In order to accomodate for this,
 168    we resolve all links AFTER parse time by iterating through the link_buf,
 169    finding the ref_id that was stored for some object (if the ref_id exists),
 170    and creating a relative pointer from the original object to the data that
 171    was linked */
 172
 173 /* Svlinks stand for short vlink, which is a link to a vdat
 174    TODO: diff btwn vlink*/
 175
 176 struct svlink {
 177   uint64_t ref_id;
 178 };
 179
 180 /* A vlink is what it sounds like, a link to a vdat
 181  TODO: model link? */
 182 struct vlink {
 183   uint64_t ref_id;
 184   char anim_name[32];
 185 };
 186
 187 /* Olinks are links to odats */
 188 struct olink {
 189   uint64_t ref_id;
 190 };
 191
 192 union link_t {
 193   struct olink olink;
 194   struct vlink vlink;
 195   struct svlink svlink;
 196 };
 197
 198 struct link {
 199   int type; //1 = olink, 2 = vlink, 3 = svlink
 200   union link_t link_t;
 201   int cdat_idx;
 202   int set_idx;
 203   int ele_idx;
 204 };
 205
 206 /* link_buf contains all the links that
 207    we encountered during parse time that need
 208    to be resolved to an offset at output time.
 209    This does not include quad refs, because
 210    those are already known to need to be resolved */
 211 struct link* link_buf[PTRS_IN_PAGE];
 212 int num_links = 0;
 213 int curr_max_links = PTRS_IN_PAGE;
 214
 215
 216 /* Odats: Odats consist of the object data necessary for
 217    each object. Odats are sometimes referred to as archetypes
 218    at compile-time, in order to distinguish the difference from
 219    a runtime object and a compile-time object.
 220    TODO: Need more info about objects at runtime, to described
 221          the reasoning behind odat structure at compile-time*/
 222
 223 /* Each set has a quad_list or a list of quads. The quad_list
 224    is the ? */
 225 struct quad {
 226   int x, y, z;
 227   uint64_t ref_id; //rgba
 228 };
 229
 230 struct root {
 231   int x, y, z;
 232 };
 233
 234 struct odat {
 235   char name[32];
 236   int vdat_id;
 237   int cdat_idx;
 238   int hitbox;
 239   struct root root;
 240   struct ref* refp; /* pointer to it's ref on ref_list */
 241   int num_quads;
 242   struct quad quad_list[MAX_QUADS];
 243 };
 244 struct odat* odat_buf[PTRS_IN_PAGE];
 245 int num_odats = 0;
 246 int curr_max_odats = PTRS_IN_PAGE;
 247
 248 /* A framesheet is a grouping of animation frames in
 249    a single direction (N,W,S,E) */
 250 struct framesheet {
 251   int width;
 252   int height;
 253   int num_frames;
 254   void* frames[MAX_FRAMES];
 255 };
 256
 257 /* A model is a collection of framesheets for every
 258    direction (N,W,S,E,NW,NE,SW,SE)*/
 259 /* NAMED spritesheet */
 260 struct model {
 261   char name[32];
 262   struct framesheet spritesheet[8]; //one for each
 263 };
 264
 265 /* Vdat: Vdats are the video data of each object. They can not be
 266    created as a stand alone object (because they consist solely
 267    of animation information and not the skeleton on which the
 268    animation manipulates). Vdats have a list of models for every
 269    animation that the vdats odat can do for that vdat*/
 270 struct vdat {
 271   struct odat* creator; //pointer to odat that made this vdat
 272   int num_models;
 273   struct model model_list[MAX_MODELS];
 274 };
 275
 276 struct vdat* vdat_buf[PTRS_IN_PAGE];
 277 int num_vdats = 0;
 278 int curr_max_vdats = PTRS_IN_PAGE;
 279
 280 struct odat*
 281 alloc_odat
 282 ()
 283 {
 284
 285   num_odats++;
 286   if(num_odats >= curr_max_odats)
 287     { if( (realloc((void*) odat_buf, PTRS_IN_PAGE * 4)) == NULL)
 288         perror("realloc odat_buf failed");
 289       curr_max_odats += PTRS_IN_PAGE;
 290     }
 291   if( (CURR_ODAT = (struct odat*) malloc(sizeof (struct odat))) == NULL)
 292     perror("malloc odat failed");
 293
 294   return CURR_ODAT;
 295 }
 296
 297 void
 298 alloc_vdat
 299 ()
 300 {
 301   num_vdats++;
 302   if(num_vdats >= curr_max_vdats)
 303     { if( (realloc((void*) vdat_buf, PTRS_IN_PAGE * 4)) == NULL)
 304         perror("realloc vdat_buf failed");
 305       curr_max_vdats += PTRS_IN_PAGE;
 306     }
 307   if((CURR_VDAT = (struct vdat*) malloc(sizeof (struct vdat))) == NULL)
 308      perror("malloc vdat failed");
 309
 310   return CURR_VDAT;
 311
 312 }
 313
 314 struct link*
 315 alloc_link
 316 ()
 317 {
 318   num_links++;
 319
 320   if(num_links >= curr_max_links)
 321     { if( (realloc((void*) link_buf, PTRS_IN_PAGE * 4)) == NULL)
 322         perror("realloc vdat_buf failed");
 323       curr_max_links += PTRS_IN_PAGE;
 324     }
 325   if((CURR_LINK = (struct link*) malloc(sizeof (struct link))) == NULL)
 326       perror("malloc link failed");
 327
 328   return CURR_LINK;
 329 }
 330
 331 struct ref*
 332 alloc_ref
 333 ()
 334 {
 335   num_refs++;
 336
 337   if(num_refs % 16 == 0)
 338     { CURR_POST = CURR_REF;
 339       inc_posts();
 340     }
 341
 342   if(num_refs >= curr_max_refs)
 343     { if( (realloc((void*) ref_buf, PTRS_IN_PAGE * 4)) == NULL)
 344         perror("realloc ref_buf failed");
 345       curr_max_refs += PTRS_IN_PAGE;
 346     }
 347   if((CURR_REF = (struct ref*) malloc(sizeof (struct ref))) == NULL)
 348     perror("malloc ref failed");
 349
 350   return CURR_REF;
 351 }
 352
 353 struct cdat*
 354 curr_cdat
 355 ()
 356 {
 357   return CURR_CDAT;
 358 }
 359
 360 struct odat*
 361 curr_odat
 362 ()
 363 {
 364   return CURR_ODAT;
 365 }
 366 struct set*
 367 curr_set
 368 ()
 369 {
 370   return CURR_CDAT->CURR_SET;
 371 }
 372 struct ele*
 373 curr_ele
 374 ()
 375 {
 376   return CURR_CDAT->CURR_SET->CURR_ELE;
 377 }
 378
 379 struct ref*
 380 prev_ref
 381 ()
 382 {
 383   return PREV_REF;
 384 }