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 /* This is outrageous! */
  27 #define QCINT_ENTRY void*
  28 #define QCINT_TO_HASH_ENTRY(q) ((void*)(uintptr_t)(q))
  29 #define HASH_ENTRY_TO_QCINT(h) ((qcint)(uintptr_t)(h))
  30
  31 void code_push_statement(code_t *code, prog_section_statement *stmt, int linenum)
  32 {
  33     vec_push(code->statements, *stmt);
  34     vec_push(code->linenums,   linenum);
  35 }
  36
  37 void code_pop_statement(code_t *code)
  38 {
  39     vec_pop(code->statements);
  40     vec_pop(code->linenums);
  41 }
  42
  43 code_t *code_init() {
  44     static prog_section_function  empty_function  = {0,0,0,0,0,0,0,{0,0,0,0,0,0,0,0}};
  45     static prog_section_statement empty_statement = {0,{0},{0},{0}};
  46     static prog_section_def       empty_def       = {0, 0, 0};
  47
  48     code_t *code       = (code_t*)mem_a(sizeof(code_t));
  49     int     i          = 0;
  50
  51     memset(code, 0, sizeof(code_t));
  52     code->entfields    = 0;
  53     code->string_cache = util_htnew(OPTS_OPTIMIZATION(OPTIM_OVERLAP_STRINGS) ? 0x100 : 1024);
  54
  55     /*
  56      * The way progs.dat is suppose to work is odd, there needs to be
  57      * some null (empty) statements, functions, and 28 globals
  58      */
  59     for(; i < 28; i++)
  60         vec_push(code->globals, 0);
  61
  62     vec_push(code->chars, '\0');
  63     vec_push(code->functions,  empty_function);
  64
  65     code_push_statement(code, &empty_statement, 0);
  66
  67     vec_push(code->defs,    empty_def);
  68     vec_push(code->fields,  empty_def);
  69
  70     return code;
  71 }
  72
  73 void *code_util_str_htgeth(hash_table_t *ht, const char *key, size_t bin);
  74
  75 uint32_t code_genstring(code_t *code, const char *str)
  76 {
  77     uint32_t off;
  78     size_t   hash;
  79     QCINT_ENTRY existing;
  80
  81     if (!str)
  82         return 0;
  83
  84     if (!*str) {
  85         if (!code->string_cached_empty) {
  86             code->string_cached_empty = vec_size(code->chars);
  87             vec_push(code->chars, 0);
  88         }
  89         return code->string_cached_empty;
  90     }
  91
  92     if (OPTS_OPTIMIZATION(OPTIM_OVERLAP_STRINGS)) {
  93         hash     = ((unsigned char*)str)[strlen(str)-1];
  94         existing = code_util_str_htgeth(code->string_cache, str, hash);
  95     } else {
  96         hash     = util_hthash(code->string_cache, str);
  97         existing = util_htgeth(code->string_cache, str, hash);
  98     }
  99
 100     if (existing)
 101         return HASH_ENTRY_TO_QCINT(existing);
 102
 103     off = vec_size(code->chars);
 104     vec_upload(code->chars, str, strlen(str)+1);
 105
 106     util_htseth(code->string_cache, str, hash, QCINT_TO_HASH_ENTRY(off));
 107     return off;
 108 }
 109
 110 qcint code_alloc_field (code_t *code, size_t qcsize)
 111 {
 112     qcint pos = (qcint)code->entfields;
 113     code->entfields += qcsize;
 114     return pos;
 115 }
 116
 117 static void code_create_header(code_t *code, prog_header *code_header) {
 118     code_header->statements.offset = sizeof(prog_header);
 119     code_header->statements.length = vec_size(code->statements);
 120     code_header->defs.offset       = code_header->statements.offset + (sizeof(prog_section_statement) * vec_size(code->statements));
 121     code_header->defs.length       = vec_size(code->defs);
 122     code_header->fields.offset     = code_header->defs.offset       + (sizeof(prog_section_def)       * vec_size(code->defs));
 123     code_header->fields.length     = vec_size(code->fields);
 124     code_header->functions.offset  = code_header->fields.offset     + (sizeof(prog_section_field)     * vec_size(code->fields));
 125     code_header->functions.length  = vec_size(code->functions);
 126     code_header->globals.offset    = code_header->functions.offset  + (sizeof(prog_section_function)  * vec_size(code->functions));
 127     code_header->globals.length    = vec_size(code->globals);
 128     code_header->strings.offset    = code_header->globals.offset    + (sizeof(int32_t)                * vec_size(code->globals));
 129     code_header->strings.length    = vec_size(code->chars);
 130     code_header->version           = 6;
 131
 132     if (OPTS_OPTION_BOOL(OPTION_FORCECRC))
 133         code_header->crc16         = OPTS_OPTION_U16(OPTION_FORCED_CRC);
 134     else
 135         code_header->crc16         = code->crc;
 136     code_header->entfield          = code->entfields;
 137
 138     if (OPTS_FLAG(DARKPLACES_STRING_TABLE_BUG)) {
 139         util_debug("GEN", "Patching stringtable for -fdarkplaces-stringtablebug\n");
 140
 141         /* >= + P */
 142         vec_push(code->chars, '\0'); /* > */
 143         vec_push(code->chars, '\0'); /* = */
 144         vec_push(code->chars, '\0'); /* P */
 145     }
 146
 147     /* ensure all data is in LE format */
 148     util_endianswap(&code_header->version,    1, sizeof(code_header->version));
 149     util_endianswap(&code_header->crc16,      1, sizeof(code_header->crc16));
 150     util_endianswap(&code_header->statements, 2, sizeof(code_header->statements.offset));
 151     util_endianswap(&code_header->defs,       2, sizeof(code_header->statements.offset));
 152     util_endianswap(&code_header->fields,     2, sizeof(code_header->statements.offset));
 153     util_endianswap(&code_header->functions,  2, sizeof(code_header->statements.offset));
 154     util_endianswap(&code_header->strings,    2, sizeof(code_header->statements.offset));
 155     util_endianswap(&code_header->globals,    2, sizeof(code_header->statements.offset));
 156     util_endianswap(&code_header->entfield,   1, sizeof(code_header->entfield));
 157
 158     /*
 159      * These are not part of the header but we ensure LE format here to save on duplicated
 160      * code.
 161      */
 162     util_endianswap(code->statements, vec_size(code->statements), sizeof(prog_section_statement));
 163     util_endianswap(code->defs,       vec_size(code->defs),       sizeof(prog_section_def));
 164     util_endianswap(code->fields,     vec_size(code->fields),     sizeof(prog_section_field));
 165     util_endianswap(code->functions,  vec_size(code->functions),  sizeof(prog_section_function));
 166     util_endianswap(code->globals,    vec_size(code->globals),    sizeof(int32_t));
 167 }
 168
 169 /*
 170  * Same principle except this one allocates memory and writes the lno(optional) and the dat file
 171  * directly out to allocated memory. Which is actually very useful for the future library support
 172  * we're going to add.
 173  */
 174 bool code_write_memory(code_t *code, uint8_t **datmem, size_t *sizedat, uint8_t **lnomem, size_t *sizelno) {
 175     prog_header code_header;
 176     uint32_t    offset  = 0;
 177
 178     if (!datmem)
 179         return false;
 180
 181     code_create_header(code, &code_header);
 182
 183     #define WRITE_CHUNK(C,X,S)                                     \
 184         do {                                                       \
 185             memcpy((void*)(&(*C)[offset]), (const void*)(X), (S)); \
 186             offset += (S);                                         \
 187         } while (0)
 188
 189     /* Calculate size required to store entire file out to memory */
 190     if (lnomem) {
 191         uint32_t version = 1;
 192
 193         *sizelno += 4;               /* LNOF */
 194         *sizelno += sizeof(version);
 195         *sizelno += sizeof(code_header.defs.length);
 196         *sizelno += sizeof(code_header.globals.length);
 197         *sizelno += sizeof(code_header.fields.length);
 198         *sizelno += sizeof(code_header.statements.length);
 199         *sizelno += sizeof(code->linenums[0]) * vec_size(code->linenums);
 200
 201         *lnomem   = (uint8_t*)mem_a(*sizelno);
 202
 203         WRITE_CHUNK(lnomem, "LNOF",                         4);
 204         WRITE_CHUNK(lnomem, &version,                       sizeof(version));
 205         WRITE_CHUNK(lnomem, &code_header.defs.length,       sizeof(code_header.defs.length));
 206         WRITE_CHUNK(lnomem, &code_header.globals.length,    sizeof(code_header.globals.length));
 207         WRITE_CHUNK(lnomem, &code_header.fields.length,     sizeof(code_header.fields.length));
 208         WRITE_CHUNK(lnomem, &code_header.statements.length, sizeof(code_header.statements.length));
 209
 210         /* something went terribly wrong */
 211         if (offset != *sizelno) {
 212             mem_d(*lnomem);
 213             *sizelno = 0;
 214             return false;
 215         }
 216         offset = 0;
 217     }
 218
 219     /* Write out the dat */
 220     *sizedat += sizeof(prog_header);
 221     *sizedat += sizeof(prog_section_statement) * vec_size(code->statements);
 222     *sizedat += sizeof(prog_section_def)       * vec_size(code->defs);
 223     *sizedat += sizeof(prog_section_field)     * vec_size(code->fields);
 224     *sizedat += sizeof(prog_section_function)  * vec_size(code->functions);
 225     *sizedat += sizeof(int32_t)                * vec_size(code->globals);
 226     *sizedat += 1                              * vec_size(code->chars);
 227
 228     *datmem = (uint8_t*)mem_a(*sizedat);
 229
 230     WRITE_CHUNK(datmem, &code_header,     sizeof(prog_header));
 231     WRITE_CHUNK(datmem, code->statements, sizeof(prog_section_statement) * vec_size(code->statements));
 232     WRITE_CHUNK(datmem, code->defs,       sizeof(prog_section_def)       * vec_size(code->defs));
 233     WRITE_CHUNK(datmem, code->fields,     sizeof(prog_section_field)     * vec_size(code->fields));
 234     WRITE_CHUNK(datmem, code->functions,  sizeof(prog_section_function)  * vec_size(code->functions));
 235     WRITE_CHUNK(datmem, code->globals,    sizeof(int32_t)                * vec_size(code->globals));
 236     WRITE_CHUNK(datmem, code->chars,      1                              * vec_size(code->chars));
 237
 238     #undef WRITE_CHUNK
 239
 240     vec_free(code->statements);
 241     vec_free(code->linenums);
 242     vec_free(code->defs);
 243     vec_free(code->fields);
 244     vec_free(code->functions);
 245     vec_free(code->globals);
 246     vec_free(code->chars);
 247
 248     util_htdel(code->string_cache);
 249     mem_d(code);
 250
 251     return true;
 252 }
 253
 254 bool code_write(code_t *code, const char *filename, const char *lnofile) {
 255     prog_header  code_header;
 256     FILE        *fp           = NULL;
 257     size_t       it           = 2;
 258
 259     code_create_header(code, &code_header);
 260
 261     if (lnofile) {
 262         uint32_t version = 1;
 263
 264         fp = fs_file_open(lnofile, "wb");
 265         if (!fp)
 266             return false;
 267
 268         util_endianswap(&version,      1,                         sizeof(version));
 269         util_endianswap(code->linenums, vec_size(code->linenums), sizeof(code->linenums[0]));
 270
 271
 272         if (fs_file_write("LNOF",                          4,                                      1,                        fp) != 1 ||
 273             fs_file_write(&version,                        sizeof(version),                        1,                        fp) != 1 ||
 274             fs_file_write(&code_header.defs.length,        sizeof(code_header.defs.length),        1,                        fp) != 1 ||
 275             fs_file_write(&code_header.globals.length,     sizeof(code_header.globals.length),     1,                        fp) != 1 ||
 276             fs_file_write(&code_header.fields.length,      sizeof(code_header.fields.length),      1,                        fp) != 1 ||
 277             fs_file_write(&code_header.statements.length,  sizeof(code_header.statements.length),  1,                        fp) != 1 ||
 278             fs_file_write(code->linenums,                  sizeof(code->linenums[0]),              vec_size(code->linenums), fp) != vec_size(code->linenums))
 279         {
 280             con_err("failed to write lno file\n");
 281         }
 282
 283         fs_file_close(fp);
 284         fp = NULL;
 285     }
 286
 287     fp = fs_file_open(filename, "wb");
 288     if (!fp)
 289         return false;
 290
 291     if (1                          != fs_file_write(&code_header,     sizeof(prog_header)           , 1                         , fp) ||
 292         vec_size(code->statements) != fs_file_write(code->statements, sizeof(prog_section_statement), vec_size(code->statements), fp) ||
 293         vec_size(code->defs)       != fs_file_write(code->defs,       sizeof(prog_section_def)      , vec_size(code->defs)      , fp) ||
 294         vec_size(code->fields)     != fs_file_write(code->fields,     sizeof(prog_section_field)    , vec_size(code->fields)    , fp) ||
 295         vec_size(code->functions)  != fs_file_write(code->functions,  sizeof(prog_section_function) , vec_size(code->functions) , fp) ||
 296         vec_size(code->globals)    != fs_file_write(code->globals,    sizeof(int32_t)               , vec_size(code->globals)   , fp) ||
 297         vec_size(code->chars)      != fs_file_write(code->chars,      1                             , vec_size(code->chars)     , fp))
 298     {
 299         fs_file_close(fp);
 300         return false;
 301     }
 302
 303     util_debug("GEN","HEADER:\n");
 304     util_debug("GEN","    version:    = %d\n", code_header.version );
 305     util_debug("GEN","    crc16:      = %d\n", code_header.crc16   );
 306     util_debug("GEN","    entfield:   = %d\n", code_header.entfield);
 307     util_debug("GEN","    statements  = {.offset = % 8d, .length = % 8d}\n", code_header.statements.offset, code_header.statements.length);
 308     util_debug("GEN","    defs        = {.offset = % 8d, .length = % 8d}\n", code_header.defs      .offset, code_header.defs      .length);
 309     util_debug("GEN","    fields      = {.offset = % 8d, .length = % 8d}\n", code_header.fields    .offset, code_header.fields    .length);
 310     util_debug("GEN","    functions   = {.offset = % 8d, .length = % 8d}\n", code_header.functions .offset, code_header.functions .length);
 311     util_debug("GEN","    globals     = {.offset = % 8d, .length = % 8d}\n", code_header.globals   .offset, code_header.globals   .length);
 312     util_debug("GEN","    strings     = {.offset = % 8d, .length = % 8d}\n", code_header.strings   .offset, code_header.strings   .length);
 313
 314     /* FUNCTIONS */
 315     util_debug("GEN", "FUNCTIONS:\n");
 316     for (; it < vec_size(code->functions); it++) {
 317         size_t j = code->functions[it].entry;
 318         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",
 319             code->functions[it].entry,
 320             code->functions[it].firstlocal,
 321             code->functions[it].locals,
 322             code->functions[it].profile,
 323             code->functions[it].name,
 324             code->functions[it].file,
 325             code->functions[it].nargs,
 326             code->functions[it].argsize[0],
 327             code->functions[it].argsize[1],
 328             code->functions[it].argsize[2],
 329             code->functions[it].argsize[3],
 330             code->functions[it].argsize[4],
 331             code->functions[it].argsize[5],
 332             code->functions[it].argsize[6],
 333             code->functions[it].argsize[7]
 334
 335         );
 336         util_debug("GEN", "    NAME: %s\n", &code->chars[code->functions[it].name]);
 337         /* Internal functions have no code */
 338         if (code->functions[it].entry >= 0) {
 339             util_debug("GEN", "    CODE:\n");
 340             for (;;) {
 341                 if (code->statements[j].opcode != INSTR_DONE)
 342                     util_debug("GEN", "        %-12s {% 5i,% 5i,% 5i}\n",
 343                         asm_instr[code->statements[j].opcode].m,
 344                         code->statements[j].o1.s1,
 345                         code->statements[j].o2.s1,
 346                         code->statements[j].o3.s1
 347                     );
 348                 else {
 349                     util_debug("GEN", "        DONE  {0x00000,0x00000,0x00000}\n");
 350                     break;
 351                 }
 352                 j++;
 353             }
 354         }
 355     }
 356
 357     fs_file_close(fp);
 358     return true;
 359 }
 360
 361 void code_cleanup(code_t *code) {
 362     vec_free(code->statements);
 363     vec_free(code->linenums);
 364     vec_free(code->defs);
 365     vec_free(code->fields);
 366     vec_free(code->functions);
 367     vec_free(code->globals);
 368     vec_free(code->chars);
 369
 370     util_htdel(code->string_cache);
 371
 372     mem_d(code);
 373 }