src/ir.c

   1 /*!@file
   2   \brief   IR Memory Implementation
   3   \details Intermediary memory management
   4   \author  Jordan Lavatai
   5   \date    Aug 2016
   6   ----------------------------------------------------------------------------*/
   7 /* Standard */
   8 #include <stdlib.h> //exit, malloc
   9 #include <stdio.h>  //print
  10 #include <stdarg.h> //va_args
  11 #include <stdint.h> //uint64_t
  12 #include <string.h> //memset, str*
  13 /* Unicode */
  14 #include <unistd.h>   //u8_* functions
  15 #include <unitypes.h> //uint8_t as a char
  16 #include <unistr.h>   //u32_cpy
  17 /* Local */
  18 #include "apc.h"
  19 #include "ir.h"
  20 /* Public */
  21 int      ir_init(void);
  22 void     ir_quit(void);
  23 int      ir_linker(void);
  24 int      ir_condenser(void);
  25 /* Memory allocation structures */
  26 enum dtype { FSDAT, MSDAT, ADAT, LDAT, FBDAT };
  27 struct pagenode_t;
  28 struct pagenode_header_t {
  29   struct pagenode_t* next;
  30   char*              head;
  31 };
  32 struct pagenode_t {
  33   struct pagenode_header_t header;
  34   char                     root[];
  35 };
  36 struct pagelist_t {
  37   struct pagenode_t* root, * head;
  38   size_t             pagesize;
  39 };
  40 struct ir_namelist_t;
  41 struct ir_namelist_t
  42 { struct ir_namelist_t* nextsib;
  43   uint8_t*              name;
  44 };
  45 struct ir_classld_t
  46 { struct ir_class_t*    root_class;
  47   struct ir_namelist_t* namelist, * namelist_head;
  48 };
  49 struct ir_setld_t
  50 { struct ir_classld_t*  classld;
  51   long long             ref;
  52   struct ir_namelist_t* namelist, * namelist_head;
  53 };
  54 /* Set data mem */
  55 struct ir_setdata_header_t
  56 { enum dtype          type;
  57   uint8_t*            src_filename, * data_name;
  58   union ir_setdata_t* nextsib;
  59 };
  60 struct ir_frameinfo_t
  61 { int facing, w, h; };
  62 struct ir_framedata_t
  63 { struct ir_setdata_header_t header;
  64   struct ir_frameinfo_t      frameinfo;
  65 };
  66 struct ir_framebox_t
  67 { struct ir_setdata_header_t header;
  68   struct ir_framedata_t      framesheets[FACING_MAX];
  69   struct ir_framedata_t      mapsheets[FACING_MAX];
  70 };
  71 struct ir_simplex_t { struct ir_setdata_header_t header; };
  72 struct ir_link_t
  73 { struct ir_setdata_header_t header;
  74   struct ir_classld_t*       classld;
  75   struct ir_setld_t*         setld;
  76   enum ltype                 type;
  77 };
  78 union ir_setdata_t
  79 { struct ir_setdata_header_t  header;
  80   struct ir_framebox_t        framebox;
  81   struct ir_framedata_t       framesheet;
  82   struct ir_framedata_t       mapsheet;
  83   struct ir_simplex_t         audio;
  84   struct ir_link_t            link;
  85 };
  86 struct ir_class_t
  87 { struct ir_class_t* nextchild, * nextsib;
  88   struct ir_set_t*   root_set;
  89   uint8_t*           name;
  90 };
  91 struct ir_set_t
  92 { struct ir_set_t*      nextchild, * nextsib;
  93   struct ir_class_t*    class;
  94   long long             ref;
  95   uint8_t*              name;
  96   struct ir_framebox_t* frameboxes;
  97   struct ir_simplex_t*  audio;
  98   struct ir_link_t*     links;
  99 };
 100 /* Functions */
 101 static inline
 102 int                   init_pagelist(struct pagelist_t*,size_t);
 103 static inline
 104 struct ir_framebox_t* ir_set_add_framebox(struct ir_set_t*,const uint8_t*);
 105 static
 106 void                  ir_free_pagenodes(struct pagenode_t*);
 107 static inline
 108 int                   bytes_identical(const uint8_t*,const uint8_t*);
 109 static
 110 void*                 stack_alloc(size_t);
 111 static
 112 uint8_t*              name_alloc(const uint8_t*);
 113 static inline
 114 union ir_setdata_t*   ir_framedata (enum dtype,const uint8_t*,apc_facing,int,int);
 115 /* Function-Like Macros */
 116 #define do_warn() do {                          \
 117   } while (0)
 118 #define wprint(str) do {                        \
 119     fprintf(stderr, str);                       \
 120     do_warn();                                  \
 121   } while (0)
 122 #define wprintf(fmt,...) do {                   \
 123     fprintf(stderr, fmt, __VA_ARGS__);          \
 124     do_warn();                                  \
 125   } while (0)
 126 #define do_error() do {                         \
 127     exit(-1);                                   \
 128   } while (0)
 129 #define eprint(str) do {                        \
 130     fprintf(stderr, str);                       \
 131     do_error();                                 \
 132   } while (0)
 133 #define eprintf(fmt,...) do {                   \
 134     fprintf(stderr, fmt, __VA_ARGS__);          \
 135     do_error();                                 \
 136   } while (0)
 137 #define struct_alloc(_T) ((struct _T*) stack_alloc(sizeof(struct _T)))
 138 #define DATA_PAGESIZE   (sys_pagesize)
 139 #define NAME_PAGESIZE   (APC_NAME_MAX * 1024)
 140 #define PL_HEADERSIZE   (sizeof(struct pagenode_header_t))
 141 #define PL_HEADSIZE(_PL) (_PL.head->header.head - _PL.head->root)
 142 #define PL_HEADMEM(_PL)  (_PL.pagesize - PL_HEADERSIZE - PL_HEADSIZE(_PL))
 143 /* Memory */
 144 extern //apc.c
 145 long sys_pagesize;
 146 static
 147 struct pagelist_t datapages, namepages;
 148 static
 149 struct ir_class_t root_class = { .name = (uint8_t*)"." };
 150
 151 /* Init */
 152 int ir_init
 153 ( void )
 154 { if (init_pagelist(&datapages, (size_t)DATA_PAGESIZE))
 155     eprint("Memory allocation error\n");
 156   if (init_pagelist(&namepages, (size_t)NAME_PAGESIZE))
 157     eprint("Memory allocation error\n");
 158   return 0;
 159 }
 160
 161 static inline
 162 int init_pagelist
 163 ( struct pagelist_t* pl,
 164   size_t size
 165 )
 166 { pl->pagesize = size;
 167   pl->root = (struct pagenode_t*) calloc(size,1);
 168   if (pl->root == NULL)
 169     return -1;
 170   pl->root->header.head = pl->root->root;
 171   pl->head = pl->root;
 172   return 0;
 173 }
 174
 175 /* Quit/Cleanup
 176    Recursively clean pagenode linked list
 177 */
 178 void ir_quit
 179 ( void )
 180 { ir_free_pagenodes(datapages.root);
 181   ir_free_pagenodes(namepages.root);
 182 }
 183
 184 static
 185 void ir_free_pagenodes
 186 ( struct pagenode_t* pagenode )
 187 { if (pagenode->header.next != NULL)
 188     ir_free_pagenodes(pagenode->header.next);
 189   free(pagenode);
 190 }
 191
 192 /* Link
 193 */
 194 int ir_linker
 195 ( void )
 196 { return 0; }
 197
 198 /* Condense
 199 */
 200 int ir_condenser
 201 ( void )
 202 { return 0; }
 203
 204 /* Return the class's name string */
 205 uint8_t* ir_class_name
 206 ( struct ir_class_t* class )
 207 { return class->name; }
 208
 209 /* Return a pointer to the root class */
 210 struct ir_class_t* ir_class_root
 211 ( void )
 212 { return &root_class; }
 213
 214 /* Add a subclass to a class
 215    Attempts to create a new subclass in the provided class, returning
 216    the class if it already exists
 217 */
 218 struct ir_class_t* ir_class_addchild
 219 ( struct ir_class_t* class,
 220   const uint8_t*     name
 221 )
 222 { struct ir_class_t* iter;
 223   if (class->nextchild == NULL)
 224     goto alloc;
 225   iter = class->nextchild;
 226   if (iter->name == NULL)
 227     eprintf("Null name pointer in class %p\n", iter);
 228   if (name == NULL)
 229     eprintf("Null child added to class %s\n", iter->name);
 230  check:
 231   if (bytes_identical(iter->name, name))
 232     return iter;
 233   if (iter->nextsib != NULL)
 234     { iter = iter->nextsib;
 235       goto check;
 236     }
 237  alloc:
 238   iter = struct_alloc(ir_class_t);
 239   iter->nextsib = class->nextchild;
 240   iter->name = name_alloc(name);
 241   return class->nextchild = iter;
 242 }
 243
 244 /* Add a set to a class
 245    Attempts to create a new root set in the specified class, returning
 246    the set if it already exists
 247 */
 248 struct ir_set_t* ir_class_addset
 249 ( struct ir_class_t* class,
 250   const uint8_t*     name
 251 )
 252 { struct ir_set_t* iter;
 253   if (class->root_set == NULL)
 254     goto alloc;
 255   iter = class->root_set;
 256   if (iter->name == NULL)
 257     eprintf("Null name pointer in class %p\n", iter);
 258   if (name == NULL)
 259     eprintf("Null set added to class %s\n", iter->name);
 260  check:
 261   if (bytes_identical(iter->name, name))
 262     return iter;
 263   if (iter->nextsib != NULL)
 264     { iter = iter->nextsib;
 265       goto check;
 266     }
 267  alloc:
 268   iter = struct_alloc(ir_set_t);
 269   iter->nextsib = class->root_set;
 270   iter->name = name_alloc(name);
 271   return class->root_set = iter;
 272 }
 273
 274 /* Add a set to a set
 275    Attempts to create a new subset of the specified set, returning the
 276    child if it already exists
 277 */
 278 struct ir_set_t* ir_set_addchild
 279 ( struct ir_set_t* set,
 280   const uint8_t*   name
 281 )
 282 { struct ir_set_t* iter;
 283   if (set->nextchild == NULL)
 284     goto alloc;
 285   iter = set->nextchild;
 286   if (iter->name == NULL)
 287     eprintf("Null name pointer in set %p\n", iter);
 288   if (name == NULL)
 289     eprintf("Null child added to set %s\n", iter->name);
 290  check:
 291   if (bytes_identical(iter->name, name))
 292     return iter;
 293   if (iter->nextsib != NULL)
 294     { iter = iter->nextsib;
 295       goto check;
 296     }
 297  alloc:
 298   iter = struct_alloc(ir_set_t);
 299   iter->nextsib = set->nextchild;
 300   iter->name = name_alloc(name);
 301   return set->nextchild = iter;
 302 }
 303
 304 /* Add a framebox to a set
 305    Attempts to create a new framebox of the specified set, returning
 306    the framebox if it already exists
 307 */
 308 static inline
 309 struct ir_framebox_t* ir_set_add_framebox
 310 ( struct ir_set_t* set,
 311   const uint8_t*   name
 312 )
 313 { struct ir_framebox_t* iter;
 314   if (set->frameboxes == NULL)
 315     goto alloc;
 316   iter = set->frameboxes;
 317  check:
 318   if (bytes_identical(iter->header.data_name, name))
 319     return iter;
 320   if (iter->header.nextsib != NULL)
 321     { iter = (struct ir_framebox_t*) iter->header.nextsib;
 322       goto check;
 323     }
 324  alloc:
 325   iter = struct_alloc(ir_framebox_t);
 326   iter->header.nextsib = (union ir_setdata_t*) set->frameboxes;
 327   iter->header.data_name = name_alloc(name);
 328   return set->frameboxes = iter;
 329 }
 330
 331 /* Match two null-terminated bytestrings
 332    Return 1 if the two bytestrings are identical, else 0
 333 */
 334 static inline
 335 int bytes_identical
 336 ( const uint8_t* stra,
 337   const uint8_t* strb
 338 )
 339 { int ca, cb;
 340   do {
 341     ca = *stra++;
 342     cb = *strb++;
 343   } while (ca && ca != '_' && ca == cb);
 344   return (ca == cb);
 345 }
 346
 347 /* Assign Setdata to Set
 348
 349  */
 350 void ir_set_assign_data
 351 ( struct ir_set_t*      set,
 352   union  ir_setdata_t*  setdata
 353 )
 354 { struct ir_framebox_t* framebox;
 355   struct ir_simplex_t*  simplex;
 356   switch (setdata->header.type)
 357     { case FSDAT:
 358         framebox = ir_set_add_framebox(set, setdata->header.data_name);
 359         if (framebox->framesheets[setdata->framesheet.frameinfo.facing].header.data_name != NULL)
 360           wprintf("Duplicate framesheet [%i] %s\n",
 361                   setdata->framesheet.frameinfo.facing, setdata->header.data_name);
 362         framebox->framesheets[setdata->framesheet.frameinfo.facing] = setdata->framesheet;
 363         break;
 364       case MSDAT:
 365         framebox = ir_set_add_framebox(set, setdata->header.data_name);
 366         if (framebox->mapsheets[setdata->mapsheet.frameinfo.facing].header.data_name != NULL)
 367           wprintf("Duplicate mapsheet [%i] %s\n",
 368                   setdata->mapsheet.frameinfo.facing, setdata->header.data_name);
 369         framebox->mapsheets[setdata->mapsheet.frameinfo.facing] = setdata->mapsheet;
 370         break;
 371       case ADAT:
 372         if (set->audio == NULL)
 373           { set->audio = (struct ir_simplex_t*) setdata;
 374             return;
 375           }
 376         simplex = set->audio;
 377         while (simplex->header.nextsib != NULL)
 378           if (bytes_identical(simplex->header.data_name, setdata->header.data_name))
 379             { wprintf("Duplicate audio %s\n", setdata->header.data_name);
 380               *simplex = setdata->audio;
 381               //setdata is now a pointer to redundant, unused memory.
 382               return;
 383             }
 384           else
 385             simplex = (struct ir_simplex_t*) simplex->header.nextsib;
 386         setdata->audio.header.nextsib = (union ir_setdata_t*) set->audio;
 387         set->audio = (struct ir_simplex_t*) setdata;
 388         break;
 389       case LDAT:
 390         setdata->link.header.nextsib = (union ir_setdata_t*) set->links;
 391         set->links = (struct ir_link_t*) setdata;
 392         break;
 393       default:
 394         fprintf(stderr, "Unknown setdata type %x\n", setdata->header.type);
 395         exit(-1);
 396     }
 397 }
 398
 399 void ir_set_assign_ref
 400 ( struct ir_set_t* set,
 401   long long        ref
 402 )
 403 { if (set->ref != 0)
 404     wprintf("Ref override: 0x%lx -> 0x%lx for set %s\n",
 405             (long unsigned) set->ref, (long unsigned) ref, set->name);
 406   set->ref = ref;
 407   //TODO: reflist_add(set);
 408 }
 409
 410 void ir_data_assign_path
 411 ( union ir_setdata_t* setdata,
 412   const uint8_t*      path
 413 )
 414 { if (path == NULL)
 415     eprintf("Null path in data %s\n", setdata->header.data_name);
 416   if (setdata->header.src_filename != NULL)
 417     wprintf("Path override: %s -> %s for setdata %s\n",
 418             setdata->header.src_filename, path, setdata->header.data_name);
 419   setdata->header.src_filename = name_alloc(path);
 420 }
 421
 422 union ir_setdata_t* ir_framesheet
 423 ( const uint8_t* name,
 424   apc_facing     d,
 425   int            width,
 426   int            height
 427 )
 428 { return ir_framedata(FSDAT, name, d, width, height); }
 429
 430 union ir_setdata_t* ir_mapsheet
 431 ( const uint8_t* name,
 432   apc_facing     d,
 433   int            width,
 434   int            height
 435 )
 436 { return ir_framedata(MSDAT, name, d, width, height); }
 437
 438 static inline
 439 union ir_setdata_t* ir_framedata
 440 ( enum dtype     type,
 441   const uint8_t* name,
 442   apc_facing     d,
 443   int            width,
 444   int            height
 445 )
 446 { struct ir_framedata_t* framedata = struct_alloc(ir_framedata_t);
 447   if (name == NULL)
 448     eprint("Null name in set allocation\n");
 449   framedata->header.type = type;
 450   framedata->header.data_name = name_alloc(name);
 451   framedata->frameinfo.facing = d;
 452   framedata->frameinfo.w = width;
 453   framedata->frameinfo.h = height;
 454   return (union ir_setdata_t*) framedata;
 455 }
 456
 457 union ir_setdata_t* ir_audio
 458 ( const uint8_t* name )
 459 { struct ir_simplex_t* audio = struct_alloc(ir_simplex_t);
 460   if (name == NULL)
 461     eprint("Null audio\n");
 462   audio->header.type = ADAT;
 463   audio->header.data_name = name_alloc(name);
 464   return (union ir_setdata_t*) audio;
 465 }
 466
 467
 468 /* Create classld that points to a class */
 469 struct ir_classld_t* ir_classld_from_class
 470 ( struct ir_class_t* class )
 471 { struct ir_classld_t* classld;
 472   if (class == NULL)
 473     eprint("Null class in classld\n");
 474   classld = struct_alloc(ir_classld_t);
 475   classld->root_class = class;
 476   return classld;
 477 }
 478
 479 struct ir_setld_t* ir_setld_from_ref
 480 ( long long ref )
 481 { struct ir_setld_t* setld;
 482   setld = struct_alloc(ir_setld_t);
 483   setld->ref = ref;
 484   return setld;
 485 }
 486
 487 struct ir_setld_t* ir_setld_from_classld
 488 ( struct ir_classld_t* classld,
 489   const uint8_t*       name
 490 )
 491 { struct ir_setld_t* setld;
 492   setld = struct_alloc(ir_setld_t);
 493   setld->namelist = struct_alloc(ir_namelist_t);
 494   setld->namelist_head = setld->namelist;
 495   setld->namelist_head->name = name_alloc(name);
 496   setld->classld = classld;
 497   return setld;
 498 }
 499
 500 struct ir_setld_t* ir_setld_addchild
 501 ( struct ir_setld_t* setld,
 502   const uint8_t*     name
 503 )
 504 { if (setld->namelist == NULL)
 505     { setld->namelist = struct_alloc(ir_namelist_t);
 506       setld->namelist_head = setld->namelist;
 507     }
 508   else
 509     { setld->namelist_head->nextsib = struct_alloc(ir_namelist_t);
 510       setld->namelist_head = setld->namelist_head->nextsib;
 511     }
 512   setld->namelist_head->name = name_alloc(name);
 513   return setld;
 514 }
 515
 516 union ir_setdata_t* ir_link
 517 ( enum ltype         link_type,
 518   struct ir_setld_t* setld,
 519   const uint8_t*     name
 520 )
 521 { struct ir_link_t* link;
 522   link = struct_alloc(ir_link_t);
 523   link->header.type = LDAT;
 524   link->type = link_type;
 525   link->classld = setld->classld;
 526   link->setld = setld;
 527   if (link_type != OLINK && name != NULL)
 528     link->header.data_name = name_alloc(name);
 529   return (union ir_setdata_t*) link;
 530 }
 531
 532
 533 static
 534 void* stack_alloc
 535 ( size_t bytes )
 536 { if (!bytes) //valid behavior to attain current head
 537     return datapages.head->header.head;
 538   if (PL_HEADMEM(datapages) < bytes)
 539     { datapages.head->header.next = (struct pagenode_t*) calloc(datapages.pagesize,1);
 540       if (datapages.head->header.next == NULL)
 541         eprint("Memory allocation error \n");
 542       datapages.head = datapages.head->header.next;
 543       datapages.head->header.head = datapages.head->root;
 544     }
 545   datapages.head->header.head += bytes;
 546   return (void*) datapages.head->header.head - bytes;
 547 }
 548
 549 static
 550 uint8_t* name_alloc
 551 ( const uint8_t* name_src )
 552 { const uint8_t* iter;
 553   uint8_t*       name;
 554   int            head_mem;
 555  copy:
 556   name = (uint8_t*)namepages.head->header.head;
 557   iter = name_src;
 558   for (head_mem = PL_HEADMEM(namepages); *iter && *iter != '_' && head_mem; head_mem--)
 559     *(namepages.head->header.head)++ = *iter++;
 560   if (head_mem == 0) //not enough room
 561     { namepages.head->header.next = (struct pagenode_t*) calloc(namepages.pagesize,1);
 562       if (namepages.head->header.next == NULL)
 563         eprint("Memory allocation error\n");
 564       namepages.head = namepages.head->header.next;
 565       namepages.head->header.head = namepages.head->root;
 566       goto copy;
 567     }
 568   *(namepages.head->header.head)++ = '\0';
 569   return name;
 570 }