code.c

   1 /*
   2  * Copyright (C) 2012, 2013
   3  *     Dale Weiler
   4  *     Wolfgang Bumiller
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   7  * this software and associated documentation files (the "Software"), to deal in
   8  * the Software without restriction, including without limitation the rights to
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  10  * of the Software, and to permit persons to whom the Software is furnished to do
  11  * so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #include "gmqcc.h"
  25
  26 /*
  27  * We could use the old method of casting to uintptr_t then to void*
  28  * or qcint; however, it's incredibly unsafe for two reasons.
  29  * 1) The compilers aliasing optimization can legally make it unstable
  30  *    (it's undefined behaviour).
  31  *
  32  * 2) The cast itself depends on fresh storage (newly allocated in which
  33  *    ever function is using the cast macros), the contents of which are
  34  *    transferred in a way that the obligation to release storage is not
  35  *    propagated.
  36  */
  37 typedef union {
  38     void   *enter;
  39     qcint   leave;
  40 } code_hash_entry_t;
  41
  42 /* Some sanity macros */
  43 #define CODE_HASH_ENTER(ENTRY) ((ENTRY).enter)
  44 #define CODE_HASH_LEAVE(ENTRY) ((ENTRY).leave)
  45
  46 void code_push_statement(code_t *code, prog_section_statement *stmt, int linenum)
  47 {
  48     vec_push(code->statements, *stmt);
  49     vec_push(code->linenums,   linenum);
  50 }
  51
  52 void code_pop_statement(code_t *code)
  53 {
  54     vec_pop(code->statements);
  55     vec_pop(code->linenums);
  56 }
  57
  58 code_t *code_init() {
  59     static prog_section_function  empty_function  = {0,0,0,0,0,0,0,{0,0,0,0,0,0,0,0}};
  60     static prog_section_statement empty_statement = {0,{0},{0},{0}};
  61     static prog_section_def       empty_def       = {0, 0, 0};
  62
  63     code_t *code       = (code_t*)mem_a(sizeof(code_t));
  64     int     i          = 0;
  65
  66     memset(code, 0, sizeof(code_t));
  67     code->entfields    = 0;
  68     code->string_cache = util_htnew(OPTS_OPTIMIZATION(OPTIM_OVERLAP_STRINGS) ? 0x100 : 1024);
  69
  70     /*
  71      * The way progs.dat is suppose to work is odd, there needs to be
  72      * some null (empty) statements, functions, and 28 globals
  73      */
  74     for(; i < 28; i++)
  75         vec_push(code->globals, 0);
  76
  77     vec_push(code->chars, '\0');
  78     vec_push(code->functions,  empty_function);
  79
  80     code_push_statement(code, &empty_statement, 0);
  81
  82     vec_push(code->defs,    empty_def);
  83     vec_push(code->fields,  empty_def);
  84
  85     return code;
  86 }
  87
  88 void *code_util_str_htgeth(hash_table_t *ht, const char *key, size_t bin);
  89
  90 uint32_t code_genstring(code_t *code, const char *str) {
  91     size_t            hash;
  92     code_hash_entry_t existing;
  93
  94     if (!str)
  95         return 0;
  96
  97     if (!*str) {
  98         if (!code->string_cached_empty) {
  99             code->string_cached_empty = vec_size(code->chars);
 100             vec_push(code->chars, 0);
 101         }
 102         return code->string_cached_empty;
 103     }
 104
 105     if (OPTS_OPTIMIZATION(OPTIM_OVERLAP_STRINGS)) {
 106         hash                      = ((unsigned char*)str)[strlen(str)-1];
 107         CODE_HASH_ENTER(existing) = code_util_str_htgeth(code->string_cache, str, hash);
 108     } else {
 109         hash                      = util_hthash(code->string_cache, str);
 110         CODE_HASH_ENTER(existing) = util_htgeth(code->string_cache, str, hash);
 111     }
 112
 113     if (CODE_HASH_ENTER(existing))
 114         return CODE_HASH_LEAVE(existing);
 115
 116     CODE_HASH_LEAVE(existing) = vec_size(code->chars);
 117     vec_upload(code->chars, str, strlen(str)+1);
 118
 119     util_htseth(code->string_cache, str, hash, CODE_HASH_ENTER(existing));
 120     return CODE_HASH_LEAVE(existing);
 121 }
 122
 123 qcint code_alloc_field (code_t *code, size_t qcsize)
 124 {
 125     qcint pos = (qcint)code->entfields;
 126     code->entfields += qcsize;
 127     return pos;
 128 }
 129
 130 static void code_create_header(code_t *code, prog_header *code_header) {
 131     code_header->statements.offset = sizeof(prog_header);
 132     code_header->statements.length = vec_size(code->statements);
 133     code_header->defs.offset       = code_header->statements.offset + (sizeof(prog_section_statement) * vec_size(code->statements));
 134     code_header->defs.length       = vec_size(code->defs);
 135     code_header->fields.offset     = code_header->defs.offset       + (sizeof(prog_section_def)       * vec_size(code->defs));
 136     code_header->fields.length     = vec_size(code->fields);
 137     code_header->functions.offset  = code_header->fields.offset     + (sizeof(prog_section_field)     * vec_size(code->fields));
 138     code_header->functions.length  = vec_size(code->functions);
 139     code_header->globals.offset    = code_header->functions.offset  + (sizeof(prog_section_function)  * vec_size(code->functions));
 140     code_header->globals.length    = vec_size(code->globals);
 141     code_header->strings.offset    = code_header->globals.offset    + (sizeof(int32_t)                * vec_size(code->globals));
 142     code_header->strings.length    = vec_size(code->chars);
 143     code_header->version           = 6;
 144
 145     if (OPTS_OPTION_BOOL(OPTION_FORCECRC))
 146         code_header->crc16         = OPTS_OPTION_U16(OPTION_FORCED_CRC);
 147     else
 148         code_header->crc16         = code->crc;
 149     code_header->entfield          = code->entfields;
 150
 151     if (OPTS_FLAG(DARKPLACES_STRING_TABLE_BUG)) {
 152         util_debug("GEN", "Patching stringtable for -fdarkplaces-stringtablebug\n");
 153
 154         /* >= + P */
 155         vec_push(code->chars, '\0'); /* > */
 156         vec_push(code->chars, '\0'); /* = */
 157         vec_push(code->chars, '\0'); /* P */
 158     }
 159
 160     /* ensure all data is in LE format */
 161     util_endianswap(&code_header->version,    1, sizeof(code_header->version));
 162     util_endianswap(&code_header->crc16,      1, sizeof(code_header->crc16));
 163     util_endianswap(&code_header->statements, 2, sizeof(code_header->statements.offset));
 164     util_endianswap(&code_header->defs,       2, sizeof(code_header->statements.offset));
 165     util_endianswap(&code_header->fields,     2, sizeof(code_header->statements.offset));
 166     util_endianswap(&code_header->functions,  2, sizeof(code_header->statements.offset));
 167     util_endianswap(&code_header->strings,    2, sizeof(code_header->statements.offset));
 168     util_endianswap(&code_header->globals,    2, sizeof(code_header->statements.offset));
 169     util_endianswap(&code_header->entfield,   1, sizeof(code_header->entfield));
 170
 171     /*
 172      * These are not part of the header but we ensure LE format here to save on duplicated
 173      * code.
 174      */
 175     util_endianswap(code->statements, vec_size(code->statements), sizeof(prog_section_statement));
 176     util_endianswap(code->defs,       vec_size(code->defs),       sizeof(prog_section_def));
 177     util_endianswap(code->fields,     vec_size(code->fields),     sizeof(prog_section_field));
 178     util_endianswap(code->functions,  vec_size(code->functions),  sizeof(prog_section_function));
 179     util_endianswap(code->globals,    vec_size(code->globals),    sizeof(int32_t));
 180 }
 181
 182 /*
 183  * Same principle except this one allocates memory and writes the lno(optional) and the dat file
 184  * directly out to allocated memory. Which is actually very useful for the future library support
 185  * we're going to add.
 186  */
 187 bool code_write_memory(code_t *code, uint8_t **datmem, size_t *sizedat, uint8_t **lnomem, size_t *sizelno) {
 188     prog_header code_header;
 189     uint32_t    offset  = 0;
 190
 191     if (!datmem)
 192         return false;
 193
 194     code_create_header(code, &code_header);
 195
 196     #define WRITE_CHUNK(C,X,S)                                     \
 197         do {                                                       \
 198             memcpy((void*)(&(*C)[offset]), (const void*)(X), (S)); \
 199             offset += (S);                                         \
 200         } while (0)
 201
 202     /* Calculate size required to store entire file out to memory */
 203     if (lnomem) {
 204         uint32_t version = 1;
 205
 206         *sizelno += 4;               /* LNOF */
 207         *sizelno += sizeof(version);
 208         *sizelno += sizeof(code_header.defs.length);
 209         *sizelno += sizeof(code_header.globals.length);
 210         *sizelno += sizeof(code_header.fields.length);
 211         *sizelno += sizeof(code_header.statements.length);
 212         *sizelno += sizeof(code->linenums[0]) * vec_size(code->linenums);
 213
 214         *lnomem   = (uint8_t*)mem_a(*sizelno);
 215
 216         WRITE_CHUNK(lnomem, "LNOF",                         4);
 217         WRITE_CHUNK(lnomem, &version,                       sizeof(version));
 218         WRITE_CHUNK(lnomem, &code_header.defs.length,       sizeof(code_header.defs.length));
 219         WRITE_CHUNK(lnomem, &code_header.globals.length,    sizeof(code_header.globals.length));
 220         WRITE_CHUNK(lnomem, &code_header.fields.length,     sizeof(code_header.fields.length));
 221         WRITE_CHUNK(lnomem, &code_header.statements.length, sizeof(code_header.statements.length));
 222
 223         /* something went terribly wrong */
 224         if (offset != *sizelno) {
 225             mem_d(*lnomem);
 226             *sizelno = 0;
 227             return false;
 228         }
 229         offset = 0;
 230     }
 231
 232     /* Write out the dat */
 233     *sizedat += sizeof(prog_header);
 234     *sizedat += sizeof(prog_section_statement) * vec_size(code->statements);
 235     *sizedat += sizeof(prog_section_def)       * vec_size(code->defs);
 236     *sizedat += sizeof(prog_section_field)     * vec_size(code->fields);
 237     *sizedat += sizeof(prog_section_function)  * vec_size(code->functions);
 238     *sizedat += sizeof(int32_t)                * vec_size(code->globals);
 239     *sizedat += 1                              * vec_size(code->chars);
 240
 241     *datmem = (uint8_t*)mem_a(*sizedat);
 242
 243     WRITE_CHUNK(datmem, &code_header,     sizeof(prog_header));
 244     WRITE_CHUNK(datmem, code->statements, sizeof(prog_section_statement) * vec_size(code->statements));
 245     WRITE_CHUNK(datmem, code->defs,       sizeof(prog_section_def)       * vec_size(code->defs));
 246     WRITE_CHUNK(datmem, code->fields,     sizeof(prog_section_field)     * vec_size(code->fields));
 247     WRITE_CHUNK(datmem, code->functions,  sizeof(prog_section_function)  * vec_size(code->functions));
 248     WRITE_CHUNK(datmem, code->globals,    sizeof(int32_t)                * vec_size(code->globals));
 249     WRITE_CHUNK(datmem, code->chars,      1                              * vec_size(code->chars));
 250
 251     #undef WRITE_CHUNK
 252
 253     vec_free(code->statements);
 254     vec_free(code->linenums);
 255     vec_free(code->defs);
 256     vec_free(code->fields);
 257     vec_free(code->functions);
 258     vec_free(code->globals);
 259     vec_free(code->chars);
 260
 261     util_htdel(code->string_cache);
 262     mem_d(code);
 263
 264     return true;
 265 }
 266
 267 bool code_write(code_t *code, const char *filename, const char *lnofile) {
 268     prog_header  code_header;
 269     FILE        *fp           = NULL;
 270     size_t       it           = 2;
 271
 272     code_create_header(code, &code_header);
 273
 274     if (lnofile) {
 275         uint32_t version = 1;
 276
 277         fp = fs_file_open(lnofile, "wb");
 278         if (!fp)
 279             return false;
 280
 281         util_endianswap(&version,      1,                         sizeof(version));
 282         util_endianswap(code->linenums, vec_size(code->linenums), sizeof(code->linenums[0]));
 283
 284
 285         if (fs_file_write("LNOF",                          4,                                      1,                        fp) != 1 ||
 286             fs_file_write(&version,                        sizeof(version),                        1,                        fp) != 1 ||
 287             fs_file_write(&code_header.defs.length,        sizeof(code_header.defs.length),        1,                        fp) != 1 ||
 288             fs_file_write(&code_header.globals.length,     sizeof(code_header.globals.length),     1,                        fp) != 1 ||
 289             fs_file_write(&code_header.fields.length,      sizeof(code_header.fields.length),      1,                        fp) != 1 ||
 290             fs_file_write(&code_header.statements.length,  sizeof(code_header.statements.length),  1,                        fp) != 1 ||
 291             fs_file_write(code->linenums,                  sizeof(code->linenums[0]),              vec_size(code->linenums), fp) != vec_size(code->linenums))
 292         {
 293             con_err("failed to write lno file\n");
 294         }
 295
 296         fs_file_close(fp);
 297         fp = NULL;
 298     }
 299
 300     fp = fs_file_open(filename, "wb");
 301     if (!fp)
 302         return false;
 303
 304     if (1                          != fs_file_write(&code_header,     sizeof(prog_header)           , 1                         , fp) ||
 305         vec_size(code->statements) != fs_file_write(code->statements, sizeof(prog_section_statement), vec_size(code->statements), fp) ||
 306         vec_size(code->defs)       != fs_file_write(code->defs,       sizeof(prog_section_def)      , vec_size(code->defs)      , fp) ||
 307         vec_size(code->fields)     != fs_file_write(code->fields,     sizeof(prog_section_field)    , vec_size(code->fields)    , fp) ||
 308         vec_size(code->functions)  != fs_file_write(code->functions,  sizeof(prog_section_function) , vec_size(code->functions) , fp) ||
 309         vec_size(code->globals)    != fs_file_write(code->globals,    sizeof(int32_t)               , vec_size(code->globals)   , fp) ||
 310         vec_size(code->chars)      != fs_file_write(code->chars,      1                             , vec_size(code->chars)     , fp))
 311     {
 312         fs_file_close(fp);
 313         return false;
 314     }
 315
 316     util_debug("GEN","HEADER:\n");
 317     util_debug("GEN","    version:    = %d\n", code_header.version );
 318     util_debug("GEN","    crc16:      = %d\n", code_header.crc16   );
 319     util_debug("GEN","    entfield:   = %d\n", code_header.entfield);
 320     util_debug("GEN","    statements  = {.offset = % 8d, .length = % 8d}\n", code_header.statements.offset, code_header.statements.length);
 321     util_debug("GEN","    defs        = {.offset = % 8d, .length = % 8d}\n", code_header.defs      .offset, code_header.defs      .length);
 322     util_debug("GEN","    fields      = {.offset = % 8d, .length = % 8d}\n", code_header.fields    .offset, code_header.fields    .length);
 323     util_debug("GEN","    functions   = {.offset = % 8d, .length = % 8d}\n", code_header.functions .offset, code_header.functions .length);
 324     util_debug("GEN","    globals     = {.offset = % 8d, .length = % 8d}\n", code_header.globals   .offset, code_header.globals   .length);
 325     util_debug("GEN","    strings     = {.offset = % 8d, .length = % 8d}\n", code_header.strings   .offset, code_header.strings   .length);
 326
 327     /* FUNCTIONS */
 328     util_debug("GEN", "FUNCTIONS:\n");
 329     for (; it < vec_size(code->functions); it++) {
 330         size_t j = code->functions[it].entry;
 331         util_debug("GEN", "    {.entry =% 5d, .firstlocal =% 5d, .locals =% 5d, .profile =% 5d, .name =% 5d, .file =% 5d, .nargs =% 5d, .argsize ={%d,%d,%d,%d,%d,%d,%d,%d} }\n",
 332             code->functions[it].entry,
 333             code->functions[it].firstlocal,
 334             code->functions[it].locals,
 335             code->functions[it].profile,
 336             code->functions[it].name,
 337             code->functions[it].file,
 338             code->functions[it].nargs,
 339             code->functions[it].argsize[0],
 340             code->functions[it].argsize[1],
 341             code->functions[it].argsize[2],
 342             code->functions[it].argsize[3],
 343             code->functions[it].argsize[4],
 344             code->functions[it].argsize[5],
 345             code->functions[it].argsize[6],
 346             code->functions[it].argsize[7]
 347
 348         );
 349         util_debug("GEN", "    NAME: %s\n", &code->chars[code->functions[it].name]);
 350         /* Internal functions have no code */
 351         if (code->functions[it].entry >= 0) {
 352             util_debug("GEN", "    CODE:\n");
 353             for (;;) {
 354                 if (code->statements[j].opcode != INSTR_DONE)
 355                     util_debug("GEN", "        %-12s {% 5i,% 5i,% 5i}\n",
 356                         asm_instr[code->statements[j].opcode].m,
 357                         code->statements[j].o1.s1,
 358                         code->statements[j].o2.s1,
 359                         code->statements[j].o3.s1
 360                     );
 361                 else {
 362                     util_debug("GEN", "        DONE  {0x00000,0x00000,0x00000}\n");
 363                     break;
 364                 }
 365                 j++;
 366             }
 367         }
 368     }
 369
 370     fs_file_close(fp);
 371     return true;
 372 }
 373
 374 void code_cleanup(code_t *code) {
 375     vec_free(code->statements);
 376     vec_free(code->linenums);
 377     vec_free(code->defs);
 378     vec_free(code->fields);
 379     vec_free(code->functions);
 380     vec_free(code->globals);
 381     vec_free(code->chars);
 382
 383     util_htdel(code->string_cache);
 384
 385     mem_d(code);
 386 }