code.c

   1 /*
   2  * Copyright (C) 2012
   3  *     Dale Weiler, Wolfgang Bumiller
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is furnished to do
  10  * so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23 #include "gmqcc.h"
  24
  25 /*
  26  * The macros below expand to a typesafe vector implementation, which
  27  * can be viewed in gmqcc.h
  28  *
  29  * code_statements_data      -- raw prog_section_statement array
  30  * code_statements_elements  -- number of elements
  31  * code_statements_allocated -- size of the array allocated
  32  * code_statements_add(T)    -- add element (returns -1 on error)
  33  *
  34  * code_vars_data            -- raw prog_section_var array
  35  * code_vars_elements        -- number of elements
  36  * code_vars_allocated       -- size of the array allocated
  37  * code_vars_add(T)          -- add element (returns -1 on error)
  38  *
  39  * code_fields_data          -- raw prog_section_field array
  40  * code_fields_elements      -- number of elements
  41  * code_fields_allocated     -- size of the array allocated
  42  * code_fields_add(T)        -- add element (returns -1 on error)
  43  *
  44  * code_functions_data       -- raw prog_section_function array
  45  * code_functions_elements   -- number of elements
  46  * code_functions_allocated  -- size of the array allocated
  47  * code_functions_add(T)     -- add element (returns -1 on error)
  48  *
  49  * code_globals_data         -- raw prog_section_def array
  50  * code_globals_elements     -- number of elements
  51  * code_globals_allocated    -- size of the array allocated
  52  * code_globals_add(T)       -- add element (returns -1 on error)
  53  *
  54  * code_chars_data           -- raw char* array
  55  * code_chars_elements       -- number of elements
  56  * code_chars_allocated      -- size of the array allocated
  57  * code_chars_add(T)         -- add element (returns -1 on error)
  58  */
  59 VECTOR_MAKE(prog_section_statement, code_statements);
  60 VECTOR_MAKE(prog_section_def,       code_defs      );
  61 VECTOR_MAKE(prog_section_field,     code_fields    );
  62 VECTOR_MAKE(prog_section_function,  code_functions );
  63 VECTOR_MAKE(int,                    code_globals   );
  64 VECTOR_MAKE(char,                   code_chars     );
  65
  66 uint16_t                            code_crc;
  67 uint32_t                            code_entfields;
  68
  69 void code_init() {
  70     prog_section_function  empty_function  = {0,0,0,0,0,0,0,{0}};
  71     prog_section_statement empty_statement = {0,{0},{0},{0}};
  72     prog_section_def       empty_def       = {0, 0, 0};
  73     int                    i               = 0;
  74
  75     code_crc = 0;
  76     code_entfields = 0;
  77
  78     /* omit creation of null code */
  79     if (OPTS_FLAG(OMIT_NULL_BYTES))
  80         return;
  81
  82     /*
  83      * The way progs.dat is suppose to work is odd, there needs to be
  84      * some null (empty) statements, functions, and 28 globals
  85      */
  86     for(; i < 28; i++)
  87         code_globals_add(0);
  88
  89     code_chars_add     ('\0');
  90     code_functions_add (empty_function);
  91     code_statements_add(empty_statement);
  92     code_defs_add      (empty_def);
  93     code_fields_add    (empty_def);
  94 }
  95
  96 uint32_t code_genstring(const char *str)
  97 {
  98     uint32_t off = code_chars_elements;
  99     while (*str) {
 100         code_chars_add(*str);
 101         ++str;
 102     }
 103     code_chars_add(0);
 104     return off;
 105 }
 106
 107 uint32_t code_cachedstring(const char *str)
 108 {
 109     size_t s = 0;
 110     /* We could implement knuth-morris-pratt or something
 111      * and also take substrings, but I'm uncomfortable with
 112      * pointing to subparts of strings for the sake of clarity...
 113      */
 114     while (s < code_chars_elements) {
 115         if (!strcmp(str, code_chars_data + s))
 116             return s;
 117         while (code_chars_data[s]) ++s;
 118         ++s;
 119     }
 120     return code_genstring(str);
 121 }
 122
 123 void code_test() {
 124     prog_section_def       d1 = { TYPE_VOID,     28, 1 };
 125     prog_section_def       d2 = { TYPE_FUNCTION, 29, 8 };
 126     prog_section_def       d3 = { TYPE_STRING,   30, 14};
 127     prog_section_function  f1 = { 1, 0, 0, 0, 1,            0,0, {0}};
 128     prog_section_function  f2 = {-4, 0, 0, 0, 8,            0,0, {0}};
 129     prog_section_function  f3 = { 0, 0, 0, 0, 14+13,        0,0, {0}};
 130     prog_section_function  f4 = { 0, 0, 0, 0, 14+13+10,     0,0, {0}};
 131     prog_section_function  f5 = { 0, 0, 0, 0, 14+13+10+7,   0,0, {0}};
 132     prog_section_function  f6 = { 0, 0, 0, 0, 14+13+10+7+9, 0,0, {0}};
 133     prog_section_statement s1 = { INSTR_STORE_F, {30}, {OFS_PARM0}, {0}};
 134     prog_section_statement s2 = { INSTR_CALL1,   {29}, {0},         {0}};
 135     prog_section_statement s3 = { INSTR_RETURN,  {0},  {0},         {0}};
 136
 137     code_chars_put("m_init",        0x6);
 138     code_chars_put("print",         0x5);
 139     code_chars_put("hello world\n", 0xC);
 140     code_chars_put("m_keydown",     0x9);
 141     code_chars_put("m_draw",        0x6);
 142     code_chars_put("m_toggle",      0x8);
 143     code_chars_put("m_shutdown",    0xA);
 144
 145     code_globals_add(1);  /* m_init */
 146     code_globals_add(2);  /* print  */
 147     code_globals_add(14); /* hello world in string table */
 148
 149     /* now the defs */
 150     code_defs_add      (d1); /* m_init    */
 151     code_defs_add      (d2); /* print     */
 152     code_defs_add      (d3); /*hello_world*/
 153     code_functions_add (f1); /* m_init    */
 154     code_functions_add (f2); /* print     */
 155     code_functions_add (f3); /* m_keydown */
 156     code_functions_add (f4);
 157     code_functions_add (f5);
 158     code_functions_add (f6);
 159     code_statements_add(s1);
 160     code_statements_add(s2);
 161     code_statements_add(s3);
 162 }
 163
 164 qcint code_alloc_field (size_t qcsize)
 165 {
 166     qcint pos = (qcint)code_entfields;
 167     code_entfields += qcsize;
 168     return pos;
 169 }
 170
 171 bool code_write(const char *filename) {
 172     prog_header  code_header;
 173     FILE        *fp           = NULL;
 174     size_t       it           = 2;
 175
 176     /* see proposal.txt */
 177     if (OPTS_FLAG(OMIT_NULL_BYTES)) {}
 178     code_header.statements.offset = sizeof(prog_header);
 179     code_header.statements.length = code_statements_elements;
 180     code_header.defs.offset       = code_header.statements.offset + (sizeof(prog_section_statement) * code_statements_elements);
 181     code_header.defs.length       = code_defs_elements;
 182     code_header.fields.offset     = code_header.defs.offset       + (sizeof(prog_section_def)       * code_defs_elements);
 183     code_header.fields.length     = code_fields_elements;
 184     code_header.functions.offset  = code_header.fields.offset     + (sizeof(prog_section_field)     * code_fields_elements);
 185     code_header.functions.length  = code_functions_elements;
 186     code_header.globals.offset    = code_header.functions.offset  + (sizeof(prog_section_function)  * code_functions_elements);
 187     code_header.globals.length    = code_globals_elements;
 188     code_header.strings.offset    = code_header.globals.offset    + (sizeof(int32_t)                * code_globals_elements);
 189     code_header.strings.length    = code_chars_elements;
 190     code_header.version           = 6;
 191     if (opts_forcecrc)
 192         code_header.crc16         = opts_forced_crc;
 193     else
 194         code_header.crc16         = code_crc;
 195     code_header.entfield          = code_entfields;
 196
 197     if (OPTS_FLAG(DARKPLACES_STRING_TABLE_BUG)) {
 198         util_debug("GEN", "Patching stringtable for -fdarkplaces-stringtablebug\n");
 199
 200         /* >= + P */
 201         code_chars_add('\0'); /* > */
 202         code_chars_add('\0'); /* = */
 203         code_chars_add('\0'); /* P */
 204     }
 205
 206     /* ensure all data is in LE format */
 207     util_endianswap(&code_header,          1,                       sizeof(prog_header));
 208     util_endianswap(code_statements_data, code_statements_elements, sizeof(prog_section_statement));
 209     util_endianswap(code_defs_data,       code_defs_elements,       sizeof(prog_section_def));
 210     util_endianswap(code_fields_data,     code_fields_elements,     sizeof(prog_section_field));
 211     util_endianswap(code_functions_data,  code_functions_elements,  sizeof(prog_section_function));
 212     util_endianswap(code_globals_data,    code_globals_elements,    sizeof(int32_t));
 213
 214     fp = util_fopen(filename, "wb");
 215     if (!fp)
 216         return false;
 217
 218     if (1 != fwrite(&code_header,         sizeof(prog_header), 1, fp) ||
 219         code_statements_elements != fwrite(code_statements_data, sizeof(prog_section_statement), code_statements_elements, fp) ||
 220         code_defs_elements       != fwrite(code_defs_data,       sizeof(prog_section_def)      , code_defs_elements      , fp) ||
 221         code_fields_elements     != fwrite(code_fields_data,     sizeof(prog_section_field)    , code_fields_elements    , fp) ||
 222         code_functions_elements  != fwrite(code_functions_data,  sizeof(prog_section_function) , code_functions_elements , fp) ||
 223         code_globals_elements    != fwrite(code_globals_data,    sizeof(int32_t)               , code_globals_elements   , fp) ||
 224         code_chars_elements      != fwrite(code_chars_data,      1                             , code_chars_elements     , fp))
 225     {
 226         fclose(fp);
 227         return false;
 228     }
 229
 230     util_debug("GEN","HEADER:\n");
 231     util_debug("GEN","    version:    = %d\n", code_header.version );
 232     util_debug("GEN","    crc16:      = %d\n", code_header.crc16   );
 233     util_debug("GEN","    entfield:   = %d\n", code_header.entfield);
 234     util_debug("GEN","    statements  = {.offset = % 8d, .length = % 8d}\n", code_header.statements.offset, code_header.statements.length);
 235     util_debug("GEN","    defs        = {.offset = % 8d, .length = % 8d}\n", code_header.defs      .offset, code_header.defs      .length);
 236     util_debug("GEN","    fields      = {.offset = % 8d, .length = % 8d}\n", code_header.fields    .offset, code_header.fields    .length);
 237     util_debug("GEN","    functions   = {.offset = % 8d, .length = % 8d}\n", code_header.functions .offset, code_header.functions .length);
 238     util_debug("GEN","    globals     = {.offset = % 8d, .length = % 8d}\n", code_header.globals   .offset, code_header.globals   .length);
 239     util_debug("GEN","    strings     = {.offset = % 8d, .length = % 8d}\n", code_header.strings   .offset, code_header.strings   .length);
 240
 241     /* FUNCTIONS */
 242     util_debug("GEN", "FUNCTIONS:\n");
 243     for (; it < code_functions_elements; it++) {
 244         size_t j = code_functions_data[it].entry;
 245         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",
 246             code_functions_data[it].entry,
 247             code_functions_data[it].firstlocal,
 248             code_functions_data[it].locals,
 249             code_functions_data[it].profile,
 250             code_functions_data[it].name,
 251             code_functions_data[it].file,
 252             code_functions_data[it].nargs,
 253             code_functions_data[it].argsize[0],
 254             code_functions_data[it].argsize[1],
 255             code_functions_data[it].argsize[2],
 256             code_functions_data[it].argsize[3],
 257             code_functions_data[it].argsize[4],
 258             code_functions_data[it].argsize[5],
 259             code_functions_data[it].argsize[6],
 260             code_functions_data[it].argsize[7]
 261
 262         );
 263         util_debug("GEN", "    NAME: %s\n", &code_chars_data[code_functions_data[it].name]);
 264         /* Internal functions have no code */
 265         if (code_functions_data[it].entry >= 0) {
 266             util_debug("GEN", "    CODE:\n");
 267             for (;;) {
 268                 if (code_statements_data[j].opcode != AINSTR_END)
 269                     util_debug("GEN", "        %-12s {% 5i,% 5i,% 5i}\n",
 270                         asm_instr[code_statements_data[j].opcode].m,
 271                         code_statements_data[j].o1.s1,
 272                         code_statements_data[j].o2.s1,
 273                         code_statements_data[j].o3.s1
 274                     );
 275                 else {
 276                     util_debug("GEN", "        DONE  {0x00000,0x00000,0x00000}\n");
 277                     break;
 278                 }
 279                 j++;
 280             }
 281         }
 282     }
 283
 284     mem_d(code_statements_data);
 285     mem_d(code_defs_data);
 286     mem_d(code_fields_data);
 287     mem_d(code_functions_data);
 288     mem_d(code_globals_data);
 289     mem_d(code_chars_data);
 290     fclose(fp);
 291     return true;
 292 }