code.c

   1 /*
   2  * Copyright (C) 2012
   3  *     Dale Weiler
   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 typedef struct {
  26     uint32_t offset;      /* Offset in file of where data begins  */
  27     uint32_t length;      /* Length of section (how many of)      */
  28 } prog_section;
  29
  30 typedef struct {
  31     uint16_t     version;      /* Program version (6)     */
  32     uint16_t     flags;        /* see propsal.txt         */
  33     uint16_t     crc16;        /* What is this?           */
  34     uint16_t     skip;         /* see propsal.txt         */
  35
  36     prog_section statements;   /* prog_section_statement  */
  37     prog_section defs;         /* prog_section_def        */
  38     prog_section fields;       /* prog_section_field      */
  39     prog_section functions;    /* prog_section_function   */
  40     prog_section strings;      /* What is this?           */
  41     prog_section globals;      /* What is this?           */
  42     uint32_t     entfield;     /* Number of entity fields */
  43 } prog_header;
  44
  45 /*
  46  * The macros below expand to a typesafe vector implementation, which
  47  * can be viewed in gmqcc.h
  48  *
  49  * code_statements_data      -- raw prog_section_statement array
  50  * code_statements_elements  -- number of elements
  51  * code_statements_allocated -- size of the array allocated
  52  * code_statements_add(T)    -- add element (returns -1 on error)
  53  *
  54  * code_vars_data            -- raw prog_section_var array
  55  * code_vars_elements        -- number of elements
  56  * code_vars_allocated       -- size of the array allocated
  57  * code_vars_add(T)          -- add element (returns -1 on error)
  58  *
  59  * code_fields_data          -- raw prog_section_field array
  60  * code_fields_elements      -- number of elements
  61  * code_fields_allocated     -- size of the array allocated
  62  * code_fields_add(T)        -- add element (returns -1 on error)
  63  *
  64  * code_functions_data       -- raw prog_section_function array
  65  * code_functions_elements   -- number of elements
  66  * code_functions_allocated  -- size of the array allocated
  67  * code_functions_add(T)     -- add element (returns -1 on error)
  68  *
  69  * code_globals_data         -- raw prog_section_def array
  70  * code_globals_elements     -- number of elements
  71  * code_globals_allocated    -- size of the array allocated
  72  * code_globals_add(T)       -- add element (returns -1 on error)
  73  *
  74  * code_chars_data           -- raw char* array
  75  * code_chars_elements       -- number of elements
  76  * code_chars_allocated      -- size of the array allocated
  77  * code_chars_add(T)         -- add element (returns -1 on error)
  78  */
  79 VECTOR_MAKE(prog_section_statement, code_statements);
  80 VECTOR_MAKE(prog_section_def,       code_defs      );
  81 VECTOR_MAKE(prog_section_field,     code_fields    );
  82 VECTOR_MAKE(prog_section_function,  code_functions );
  83 VECTOR_MAKE(int,                    code_globals   );
  84 VECTOR_MAKE(char,                   code_chars     );
  85
  86 void code_init() {
  87     /* omit creation of null code */
  88     if (opts_omit_nullcode)
  89         return;
  90
  91     /*
  92      * The way progs.dat is suppose to work is odd, there needs to be
  93      * some null (empty) statements, functions, and 28 globals
  94      */
  95     prog_section_function  empty_function  = {0,0,0,0,0,0,0,{0}};
  96     prog_section_statement empty_statement = {0,{0},{0},{0}};
  97     int i;
  98     for(i = 0; i < 28; i++)
  99         code_globals_add(0);
 100
 101     code_chars_add     ('\0');
 102     code_functions_add (empty_function);
 103     code_statements_add(empty_statement);
 104 }
 105
 106 void code_test() {
 107     code_chars_put("m_init",        0x6);
 108     code_chars_put("print",         0x5);
 109     code_chars_put("hello world\n", 0xC);
 110     code_chars_put("m_keydown",     0x9);
 111     code_chars_put("m_draw",        0x6);
 112     code_chars_put("m_toggle",      0x8);
 113     code_chars_put("m_shutdown",    0xA);
 114
 115     code_globals_add(1);  /* m_init */
 116     code_globals_add(2);  /* print  */
 117     code_globals_add(14); /* hello world in string table */
 118
 119     /* now the defs */
 120     code_defs_add((prog_section_def){.type=TYPE_VOID,    .offset=28/*globals[28]*/, .name=1 }); /* m_init */
 121     code_defs_add((prog_section_def){.type=TYPE_FUNCTION,.offset=29/*globals[29]*/, .name=8 }); /* print  */
 122     code_defs_add((prog_section_def){.type=TYPE_STRING,  .offset=30/*globals[30]*/, .name=14}); /*hello_world*/
 123
 124     code_functions_add((prog_section_function){1,  0, 0, 0, .name=1, 0, 0, {0}}); /* m_init */
 125     code_functions_add((prog_section_function){-4, 0, 0, 0, .name=8, 0, 0, {0}}); /* print  */
 126     code_functions_add((prog_section_function){0,  0, 0, 0, .name=14+13,        0,0, {0}}); /* m_keydown */
 127     code_functions_add((prog_section_function){0,  0, 0, 0, .name=14+13+10,     0,0, {0}});
 128     code_functions_add((prog_section_function){0,  0, 0, 0, .name=14+13+10+7,   0,0, {0}});
 129     code_functions_add((prog_section_function){0,  0, 0, 0, .name=14+13+10+7+9, 0,0, {0}});
 130
 131     code_statements_add((prog_section_statement){INSTR_STORE_F, {30}/*30 is hello_world */, {OFS_PARM0}, {0}});
 132     code_statements_add((prog_section_statement){INSTR_CALL1,   {29}/*29 is print       */, {0},         {0}});
 133     code_statements_add((prog_section_statement){INSTR_RETURN,  {0},                        {0},         {0}});
 134 }
 135
 136 void code_write() {
 137     prog_header code_header={0};
 138
 139     /* see proposal.txt */
 140     if (opts_omit_nullcode) {
 141         code_header.skip   = 28;
 142         code_header.flags  = 1;
 143     }
 144
 145     code_header.version    = 6;
 146     code_header.crc16      = 0; /* TODO: */
 147     code_header.statements = (prog_section){sizeof(prog_header), code_statements_elements };
 148     code_header.defs       = (prog_section){code_header.statements.offset + sizeof(prog_section_statement)*code_statements_elements,  code_defs_elements      };
 149     code_header.fields     = (prog_section){code_header.defs.offset       + sizeof(prog_section_def)      *code_defs_elements,        code_fields_elements    };
 150     code_header.functions  = (prog_section){code_header.fields.offset     + sizeof(prog_section_field)    *code_fields_elements,      code_functions_elements };
 151     code_header.globals    = (prog_section){code_header.functions.offset  + sizeof(prog_section_function) *code_functions_elements,   code_globals_elements   };
 152     code_header.strings    = (prog_section){code_header.globals.offset    + sizeof(int)                   *code_globals_elements,     code_chars_elements     };
 153     code_header.entfield   = 0; /* TODO: */
 154
 155     if (opts_darkplaces_stringtablebug) {
 156         util_debug("GEN", "Patching stringtable for -fdarkplaces-stringtablebug\n");
 157
 158         /* >= + P */
 159         code_chars_add('\0'); /* > */
 160         code_chars_add('\0'); /* = */
 161         code_chars_add('\0'); /* P */
 162     }
 163
 164     /* ensure all data is in LE format */
 165     util_endianswap(&code_header,         1,                        sizeof(prog_header));
 166     util_endianswap(code_statements_data, code_statements_elements, sizeof(prog_section_statement));
 167     util_endianswap(code_defs_data,       code_defs_elements,       sizeof(prog_section_def));
 168     util_endianswap(code_fields_data,     code_fields_elements,     sizeof(prog_section_field));
 169     util_endianswap(code_functions_data,  code_functions_elements,  sizeof(prog_section_function));
 170     util_endianswap(code_globals_data,    code_globals_elements,    sizeof(int));
 171
 172     FILE *fp = fopen("program.dat", "wb");
 173     fwrite(&code_header,         1, sizeof(prog_header), fp);
 174     fwrite(code_statements_data, 1, sizeof(prog_section_statement)*code_statements_elements, fp);
 175     fwrite(code_defs_data,       1, sizeof(prog_section_def)      *code_defs_elements,       fp);
 176     fwrite(code_fields_data,     1, sizeof(prog_section_field)    *code_fields_elements,     fp);
 177     fwrite(code_functions_data,  1, sizeof(prog_section_function) *code_functions_elements,  fp);
 178     fwrite(code_globals_data,    1, sizeof(int)                   *code_globals_elements,    fp);
 179     fwrite(code_chars_data,      1, 1                             *code_chars_elements,      fp);
 180
 181     util_debug("GEN","HEADER:\n");
 182     util_debug("GEN","    version:    = %d\n", code_header.version );
 183     util_debug("GEN","    crc16:      = %d\n", code_header.crc16   );
 184     util_debug("GEN","    entfield:   = %d\n", code_header.entfield);
 185     util_debug("GEN","    statements  = {.offset = % 8d, .length = % 8d}\n", code_header.statements.offset, code_header.statements.length);
 186     util_debug("GEN","    defs        = {.offset = % 8d, .length = % 8d}\n", code_header.defs      .offset, code_header.defs      .length);
 187     util_debug("GEN","    fields      = {.offset = % 8d, .length = % 8d}\n", code_header.fields    .offset, code_header.fields    .length);
 188     util_debug("GEN","    functions   = {.offset = % 8d, .length = % 8d}\n", code_header.functions .offset, code_header.functions .length);
 189     util_debug("GEN","    globals     = {.offset = % 8d, .length = % 8d}\n", code_header.globals   .offset, code_header.globals   .length);
 190     util_debug("GEN","    strings     = {.offset = % 8d, .length = % 8d}\n", code_header.strings   .offset, code_header.strings   .length);
 191
 192     /* FUNCTIONS */
 193     util_debug("GEN", "FUNCTIONS:\n");
 194     size_t i = 1;
 195     for (; i < code_functions_elements; i++) {
 196         size_t j = code_functions_data[i].entry;
 197         util_debug("GEN", "    {.entry =% 5d, .firstlocal =% 5d, .locals =% 5d, .profile =% 5d, .name =% 5d, .file =% 5d, .nargs =% 5d, .argsize =%0X }\n",
 198             code_functions_data[i].entry,
 199             code_functions_data[i].firstlocal,
 200             code_functions_data[i].locals,
 201             code_functions_data[i].profile,
 202             code_functions_data[i].name,
 203             code_functions_data[i].file,
 204             code_functions_data[i].nargs,
 205             *((int32_t*)&code_functions_data[i].argsize)
 206         );
 207         util_debug("GEN", "    NAME: %s\n", &code_chars_data[code_functions_data[i].name]);
 208         /* Internal functions have no code */
 209         if (code_functions_data[i].entry >= 0) {
 210             util_debug("GEN", "    CODE:\n");
 211             for (;;) {
 212                 if (code_statements_data[j].opcode != INSTR_DONE &&
 213                     code_statements_data[j].opcode != INSTR_RETURN)
 214                     util_debug("GEN", "        %s {0x%05d,0x%05d,0x%05d}\n",
 215                         asm_instr[code_statements_data[j].opcode].m,
 216                         code_statements_data[j].s1,
 217                         code_statements_data[j].s2,
 218                         code_statements_data[j].s3
 219                     );
 220                 else break;
 221                 j++;
 222             }
 223         }
 224     }
 225
 226     mem_d(code_statements_data);
 227     mem_d(code_defs_data);
 228     mem_d(code_fields_data);
 229     mem_d(code_functions_data);
 230     mem_d(code_globals_data);
 231     mem_d(code_chars_data);
 232     fclose(fp);
 233 }