]> git.xonotic.org Git - xonotic/gmqcc.git/blob - code.c
Add missing -width to .Bl in doc/gmqpak.1
[xonotic/gmqcc.git] / 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 <string.h>
25 #include "gmqcc.h"
26
27 /*
28  * We could use the old method of casting to uintptr_t then to void*
29  * or qcint_t; however, it's incredibly unsafe for two reasons.
30  * 1) The compilers aliasing optimization can legally make it unstable
31  *    (it's undefined behaviour).
32  *
33  * 2) The cast itself depends on fresh storage (newly allocated in which
34  *    ever function is using the cast macros), the contents of which are
35  *    transferred in a way that the obligation to release storage is not
36  *    propagated.
37  */
38 typedef union {
39     void   *enter;
40     qcint_t   leave;
41 } code_hash_entry_t;
42
43 /* Some sanity macros */
44 #define CODE_HASH_ENTER(ENTRY) ((ENTRY).enter)
45 #define CODE_HASH_LEAVE(ENTRY) ((ENTRY).leave)
46
47 void code_push_statement(code_t *code, prog_section_statement_t *stmt_in, lex_ctx_t ctx)
48 {
49     prog_section_statement_t stmt = *stmt_in;
50
51     if (OPTS_FLAG(TYPELESS_STORES)) {
52         switch (stmt.opcode) {
53             case INSTR_LOAD_S:
54             case INSTR_LOAD_ENT:
55             case INSTR_LOAD_FLD:
56             case INSTR_LOAD_FNC:
57                 stmt.opcode = INSTR_LOAD_F;
58                 break;
59             case INSTR_STORE_S:
60             case INSTR_STORE_ENT:
61             case INSTR_STORE_FLD:
62             case INSTR_STORE_FNC:
63                 stmt.opcode = INSTR_STORE_F;
64                 break;
65             case INSTR_STOREP_S:
66             case INSTR_STOREP_ENT:
67             case INSTR_STOREP_FLD:
68             case INSTR_STOREP_FNC:
69                 stmt.opcode = INSTR_STOREP_F;
70                 break;
71         }
72     }
73
74
75     if (OPTS_FLAG(SORT_OPERANDS)) {
76         uint16_t pair;
77
78         switch (stmt.opcode) {
79             case INSTR_MUL_F:
80             case INSTR_MUL_V:
81             case INSTR_ADD_F:
82             case INSTR_EQ_F:
83             case INSTR_EQ_S:
84             case INSTR_EQ_E:
85             case INSTR_EQ_FNC:
86             case INSTR_NE_F:
87             case INSTR_NE_V:
88             case INSTR_NE_S:
89             case INSTR_NE_E:
90             case INSTR_NE_FNC:
91             case INSTR_AND:
92             case INSTR_OR:
93             case INSTR_BITAND:
94             case INSTR_BITOR:
95                 if (stmt.o1.u1 < stmt.o2.u1) {
96                     uint16_t a = stmt.o2.u1;
97                     stmt.o1.u1 = stmt.o2.u1;
98                     stmt.o2.u1 = a;
99                 }
100                 break;
101
102             case INSTR_MUL_VF: pair = INSTR_MUL_FV; goto case_pair_gen;
103             case INSTR_MUL_FV: pair = INSTR_MUL_VF; goto case_pair_gen;
104             case INSTR_LT:     pair = INSTR_GT;     goto case_pair_gen;
105             case INSTR_GT:     pair = INSTR_LT;     goto case_pair_gen;
106             case INSTR_LE:     pair = INSTR_GT;     goto case_pair_gen;
107             case INSTR_GE:     pair = INSTR_LE;
108
109             case_pair_gen:
110                 if (stmt.o1.u1 < stmt.o2.u1) {
111                     uint16_t x  = stmt.o1.u1;
112                     stmt.o1.u1  = stmt.o2.u1;
113                     stmt.o2.u1  = x;
114                     stmt.opcode = pair;
115                 }
116                 break;
117         }
118     }
119
120     vec_push(code->statements, stmt);
121     vec_push(code->linenums,   (int)ctx.line);
122     vec_push(code->columnnums, (int)ctx.column);
123 }
124
125 void code_pop_statement(code_t *code)
126 {
127     vec_pop(code->statements);
128     vec_pop(code->linenums);
129     vec_pop(code->columnnums);
130 }
131
132 code_t *code_init() {
133     static lex_ctx_t                empty_ctx       = {0, 0, 0};
134     static prog_section_function_t  empty_function  = {0,0,0,0,0,0,0,{0,0,0,0,0,0,0,0}};
135     static prog_section_statement_t empty_statement = {0,{0},{0},{0}};
136     static prog_section_def_t       empty_def       = {0, 0, 0};
137
138     code_t *code       = (code_t*)mem_a(sizeof(code_t));
139     int     i          = 0;
140
141     memset(code, 0, sizeof(code_t));
142     code->entfields    = 0;
143     code->string_cache = util_htnew(OPTS_OPTIMIZATION(OPTIM_OVERLAP_STRINGS) ? 0x100 : 1024);
144
145     /*
146      * The way progs.dat is suppose to work is odd, there needs to be
147      * some null (empty) statements, functions, and 28 globals
148      */
149     for(; i < 28; i++)
150         vec_push(code->globals, 0);
151
152     vec_push(code->chars, '\0');
153     vec_push(code->functions,  empty_function);
154
155     code_push_statement(code, &empty_statement, empty_ctx);
156
157     vec_push(code->defs,    empty_def);
158     vec_push(code->fields,  empty_def);
159
160     return code;
161 }
162
163 void *code_util_str_htgeth(hash_table_t *ht, const char *key, size_t bin);
164
165 uint32_t code_genstring(code_t *code, const char *str) {
166     size_t            hash;
167     code_hash_entry_t existing;
168
169     if (!str)
170         return 0;
171
172     if (!*str) {
173         if (!code->string_cached_empty) {
174             code->string_cached_empty = vec_size(code->chars);
175             vec_push(code->chars, 0);
176         }
177         return code->string_cached_empty;
178     }
179
180     if (OPTS_OPTIMIZATION(OPTIM_OVERLAP_STRINGS)) {
181         hash                      = ((unsigned char*)str)[strlen(str)-1];
182         CODE_HASH_ENTER(existing) = code_util_str_htgeth(code->string_cache, str, hash);
183     } else {
184         hash                      = util_hthash(code->string_cache, str);
185         CODE_HASH_ENTER(existing) = util_htgeth(code->string_cache, str, hash);
186     }
187
188     if (CODE_HASH_ENTER(existing))
189         return CODE_HASH_LEAVE(existing);
190
191     CODE_HASH_LEAVE(existing) = vec_size(code->chars);
192     vec_append(code->chars, strlen(str)+1, str);
193
194     util_htseth(code->string_cache, str, hash, CODE_HASH_ENTER(existing));
195     return CODE_HASH_LEAVE(existing);
196 }
197
198 qcint_t code_alloc_field (code_t *code, size_t qcsize)
199 {
200     qcint_t pos = (qcint_t)code->entfields;
201     code->entfields += qcsize;
202     return pos;
203 }
204
205 static size_t code_size_generic(code_t *code, prog_header_t *code_header, bool lno) {
206     size_t size = 0;
207     if (lno) {
208         size += 4;  /* LNOF */
209         size += sizeof(uint32_t); /* version */
210         size += sizeof(code_header->defs.length);
211         size += sizeof(code_header->globals.length);
212         size += sizeof(code_header->fields.length);
213         size += sizeof(code_header->statements.length);
214         size += sizeof(code->linenums[0])   * vec_size(code->linenums);
215         size += sizeof(code->columnnums[0]) * vec_size(code->columnnums);
216     } else {
217         size += sizeof(prog_header_t);
218         size += sizeof(prog_section_statement_t) * vec_size(code->statements);
219         size += sizeof(prog_section_def_t)       * vec_size(code->defs);
220         size += sizeof(prog_section_field_t)     * vec_size(code->fields);
221         size += sizeof(prog_section_function_t)  * vec_size(code->functions);
222         size += sizeof(int32_t)                  * vec_size(code->globals);
223         size += 1                                * vec_size(code->chars);
224     }
225     return size;
226 }
227
228 #define code_size_binary(C, H) code_size_generic((C), (H), false)
229 #define code_size_debug(C, H)  code_size_generic((C), (H), true)
230
231 static void code_create_header(code_t *code, prog_header_t *code_header, const char *filename, const char *lnofile) {
232     size_t i;
233
234     code_header->statements.offset = sizeof(prog_header_t);
235     code_header->statements.length = vec_size(code->statements);
236     code_header->defs.offset       = code_header->statements.offset + (sizeof(prog_section_statement_t) * vec_size(code->statements));
237     code_header->defs.length       = vec_size(code->defs);
238     code_header->fields.offset     = code_header->defs.offset       + (sizeof(prog_section_def_t)       * vec_size(code->defs));
239     code_header->fields.length     = vec_size(code->fields);
240     code_header->functions.offset  = code_header->fields.offset     + (sizeof(prog_section_field_t)     * vec_size(code->fields));
241     code_header->functions.length  = vec_size(code->functions);
242     code_header->globals.offset    = code_header->functions.offset  + (sizeof(prog_section_function_t)  * vec_size(code->functions));
243     code_header->globals.length    = vec_size(code->globals);
244     code_header->strings.offset    = code_header->globals.offset    + (sizeof(int32_t)                  * vec_size(code->globals));
245     code_header->strings.length    = vec_size(code->chars);
246     code_header->version           = 6;
247     code_header->skip              = 0;
248
249     if (OPTS_OPTION_BOOL(OPTION_FORCECRC))
250         code_header->crc16         = OPTS_OPTION_U16(OPTION_FORCED_CRC);
251     else
252         code_header->crc16         = code->crc;
253     code_header->entfield          = code->entfields;
254
255     if (OPTS_FLAG(DARKPLACES_STRING_TABLE_BUG)) {
256         util_debug("GEN", "Patching stringtable for -fdarkplaces-stringtablebug\n");
257
258         /* >= + P */
259         vec_push(code->chars, '\0'); /* > */
260         vec_push(code->chars, '\0'); /* = */
261         vec_push(code->chars, '\0'); /* P */
262     }
263
264     /* ensure all data is in LE format */
265     util_endianswap(&code_header->version,    1, sizeof(code_header->version));
266     util_endianswap(&code_header->crc16,      1, sizeof(code_header->crc16));
267     util_endianswap(&code_header->statements, 2, sizeof(code_header->statements.offset));
268     util_endianswap(&code_header->defs,       2, sizeof(code_header->statements.offset));
269     util_endianswap(&code_header->fields,     2, sizeof(code_header->statements.offset));
270     util_endianswap(&code_header->functions,  2, sizeof(code_header->statements.offset));
271     util_endianswap(&code_header->strings,    2, sizeof(code_header->statements.offset));
272     util_endianswap(&code_header->globals,    2, sizeof(code_header->statements.offset));
273     util_endianswap(&code_header->entfield,   1, sizeof(code_header->entfield));
274
275     /*
276      * These are not part of the header but we ensure LE format here to save on duplicated
277      * code.
278      */
279     util_endianswap(code->statements, vec_size(code->statements), sizeof(prog_section_statement_t));
280     util_endianswap(code->defs,       vec_size(code->defs),       sizeof(prog_section_def_t));
281     util_endianswap(code->fields,     vec_size(code->fields),     sizeof(prog_section_field_t));
282     util_endianswap(code->functions,  vec_size(code->functions),  sizeof(prog_section_function_t));
283     util_endianswap(code->globals,    vec_size(code->globals),    sizeof(int32_t));
284
285
286     if (!OPTS_OPTION_BOOL(OPTION_QUIET)) {
287         if (lnofile)
288             con_out("writing '%s' and '%s'...\n", filename, lnofile);
289         else
290             con_out("writing '%s'\n", filename);
291     }
292
293     if (!OPTS_OPTION_BOOL(OPTION_QUIET) &&
294         !OPTS_OPTION_BOOL(OPTION_PP_ONLY))
295     {
296         char buffer[1024];
297         con_out("\nOptimizations:\n");
298         for (i = 0; i < COUNT_OPTIMIZATIONS; ++i) {
299             if (opts_optimizationcount[i]) {
300                 util_optimizationtostr(opts_opt_list[i].name, buffer, sizeof(buffer));
301                 con_out(
302                     "    %s: %u\n",
303                     buffer,
304                     (unsigned int)opts_optimizationcount[i]
305                 );
306             }
307         }
308     }
309 }
310
311 static void code_stats(const char *filename, const char *lnofile, code_t *code, prog_header_t *code_header) {
312     if (OPTS_OPTION_BOOL(OPTION_QUIET) ||
313         OPTS_OPTION_BOOL(OPTION_PP_ONLY))
314             return;
315
316     con_out("\nFile statistics:\n");
317     con_out("    dat:\n");
318     con_out("        name: %s\n",         filename);
319     con_out("        size: %u (bytes)\n", code_size_binary(code, code_header));
320     con_out("        crc:  0x%04X\n",     code->crc);
321
322     if (lnofile) {
323         con_out("    lno:\n");
324         con_out("        name: %s\n",  lnofile);
325         con_out("        size: %u (bytes)\n",  code_size_debug(code, code_header));
326     }
327
328     con_out("\n");
329 }
330
331 /*
332  * Same principle except this one allocates memory and writes the lno(optional) and the dat file
333  * directly out to allocated memory. Which is actually very useful for the future library support
334  * we're going to add.
335  */
336 #if 0
337 static bool code_write_memory(code_t *code, uint8_t **datmem, size_t *sizedat, uint8_t **lnomem, size_t *sizelno) GMQCC_UNUSED {
338     prog_header_t code_header;
339     uint32_t      offset  = 0;
340
341     if (!datmem)
342         return false;
343
344     code_create_header(code, &code_header, "<<memory>>", "<<memory>>");
345
346     #define WRITE_CHUNK(C,X,S)                                     \
347         do {                                                       \
348             memcpy((void*)(&(*C)[offset]), (const void*)(X), (S)); \
349             offset += (S);                                         \
350         } while (0)
351
352     /* Calculate size required to store entire file out to memory */
353     if (lnomem) {
354         uint32_t version = 1;
355
356         *sizelno = code_size_debug(code, &code_header);
357         *lnomem  = (uint8_t*)mem_a(*sizelno);
358
359         WRITE_CHUNK(lnomem, "LNOF",                         4);
360         WRITE_CHUNK(lnomem, &version,                       sizeof(version));
361         WRITE_CHUNK(lnomem, &code_header.defs.length,       sizeof(code_header.defs.length));
362         WRITE_CHUNK(lnomem, &code_header.globals.length,    sizeof(code_header.globals.length));
363         WRITE_CHUNK(lnomem, &code_header.fields.length,     sizeof(code_header.fields.length));
364         WRITE_CHUNK(lnomem, &code_header.statements.length, sizeof(code_header.statements.length));
365
366         /* something went terribly wrong */
367         if (offset != *sizelno) {
368             mem_d(*lnomem);
369             *sizelno = 0;
370             return false;
371         }
372         offset = 0;
373     }
374
375     /* Write out the dat */
376     *sizedat = code_size_binary(code, &code_header);
377     *datmem  = (uint8_t*)mem_a(*sizedat);
378
379     WRITE_CHUNK(datmem, &code_header,     sizeof(prog_header_t));
380     WRITE_CHUNK(datmem, code->statements, sizeof(prog_section_statement_t) * vec_size(code->statements));
381     WRITE_CHUNK(datmem, code->defs,       sizeof(prog_section_def_t)       * vec_size(code->defs));
382     WRITE_CHUNK(datmem, code->fields,     sizeof(prog_section_field_t)     * vec_size(code->fields));
383     WRITE_CHUNK(datmem, code->functions,  sizeof(prog_section_function_t)  * vec_size(code->functions));
384     WRITE_CHUNK(datmem, code->globals,    sizeof(int32_t)                  * vec_size(code->globals));
385     WRITE_CHUNK(datmem, code->chars,      1                                * vec_size(code->chars));
386
387     vec_free(code->statements);
388     vec_free(code->linenums);
389     vec_free(code->columnnums);
390     vec_free(code->defs);
391     vec_free(code->fields);
392     vec_free(code->functions);
393     vec_free(code->globals);
394     vec_free(code->chars);
395
396     util_htdel(code->string_cache);
397     mem_d(code);
398     code_stats("<<memory>>", (lnomem) ? "<<memory>>" : NULL, code, &code_header);
399     return true;
400 }
401 #endif /*!#if 0 reenable when ready to be used */
402 #undef WRITE_CHUNK
403
404 bool code_write(code_t *code, const char *filename, const char *lnofile) {
405     prog_header_t  code_header;
406     FILE          *fp           = NULL;
407     size_t         it           = 2;
408
409     code_create_header(code, &code_header, filename, lnofile);
410
411     if (lnofile) {
412         uint32_t version = 1;
413
414         fp = fs_file_open(lnofile, "wb");
415         if (!fp)
416             return false;
417
418         util_endianswap(&version,         1,                          sizeof(version));
419         util_endianswap(code->linenums,   vec_size(code->linenums),   sizeof(code->linenums[0]));
420         util_endianswap(code->columnnums, vec_size(code->columnnums), sizeof(code->columnnums[0]));
421
422         if (fs_file_write("LNOF",                          4,                                      1,                          fp) != 1 ||
423             fs_file_write(&version,                        sizeof(version),                        1,                          fp) != 1 ||
424             fs_file_write(&code_header.defs.length,        sizeof(code_header.defs.length),        1,                          fp) != 1 ||
425             fs_file_write(&code_header.globals.length,     sizeof(code_header.globals.length),     1,                          fp) != 1 ||
426             fs_file_write(&code_header.fields.length,      sizeof(code_header.fields.length),      1,                          fp) != 1 ||
427             fs_file_write(&code_header.statements.length,  sizeof(code_header.statements.length),  1,                          fp) != 1 ||
428             fs_file_write(code->linenums,                  sizeof(code->linenums[0]),              vec_size(code->linenums),   fp) != vec_size(code->linenums) ||
429             fs_file_write(code->columnnums,                sizeof(code->columnnums[0]),            vec_size(code->columnnums), fp) != vec_size(code->columnnums))
430         {
431             con_err("failed to write lno file\n");
432         }
433
434         fs_file_close(fp);
435         fp = NULL;
436     }
437
438     fp = fs_file_open(filename, "wb");
439     if (!fp)
440         return false;
441
442     if (1                          != fs_file_write(&code_header,     sizeof(prog_header_t)           , 1                         , fp) ||
443         vec_size(code->statements) != fs_file_write(code->statements, sizeof(prog_section_statement_t), vec_size(code->statements), fp) ||
444         vec_size(code->defs)       != fs_file_write(code->defs,       sizeof(prog_section_def_t)      , vec_size(code->defs)      , fp) ||
445         vec_size(code->fields)     != fs_file_write(code->fields,     sizeof(prog_section_field_t)    , vec_size(code->fields)    , fp) ||
446         vec_size(code->functions)  != fs_file_write(code->functions,  sizeof(prog_section_function_t) , vec_size(code->functions) , fp) ||
447         vec_size(code->globals)    != fs_file_write(code->globals,    sizeof(int32_t)                 , vec_size(code->globals)   , fp) ||
448         vec_size(code->chars)      != fs_file_write(code->chars,      1                               , vec_size(code->chars)     , fp))
449     {
450         fs_file_close(fp);
451         return false;
452     }
453
454     util_debug("GEN","HEADER:\n");
455     util_debug("GEN","    version:    = %d\n", code_header.version );
456     util_debug("GEN","    crc16:      = %d\n", code_header.crc16   );
457     util_debug("GEN","    entfield:   = %d\n", code_header.entfield);
458     util_debug("GEN","    statements  = {.offset = % 8d, .length = % 8d}\n", code_header.statements.offset, code_header.statements.length);
459     util_debug("GEN","    defs        = {.offset = % 8d, .length = % 8d}\n", code_header.defs      .offset, code_header.defs      .length);
460     util_debug("GEN","    fields      = {.offset = % 8d, .length = % 8d}\n", code_header.fields    .offset, code_header.fields    .length);
461     util_debug("GEN","    functions   = {.offset = % 8d, .length = % 8d}\n", code_header.functions .offset, code_header.functions .length);
462     util_debug("GEN","    globals     = {.offset = % 8d, .length = % 8d}\n", code_header.globals   .offset, code_header.globals   .length);
463     util_debug("GEN","    strings     = {.offset = % 8d, .length = % 8d}\n", code_header.strings   .offset, code_header.strings   .length);
464
465     /* FUNCTIONS */
466     util_debug("GEN", "FUNCTIONS:\n");
467     for (; it < vec_size(code->functions); it++) {
468         size_t j = code->functions[it].entry;
469         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",
470             code->functions[it].entry,
471             code->functions[it].firstlocal,
472             code->functions[it].locals,
473             code->functions[it].profile,
474             code->functions[it].name,
475             code->functions[it].file,
476             code->functions[it].nargs,
477             code->functions[it].argsize[0],
478             code->functions[it].argsize[1],
479             code->functions[it].argsize[2],
480             code->functions[it].argsize[3],
481             code->functions[it].argsize[4],
482             code->functions[it].argsize[5],
483             code->functions[it].argsize[6],
484             code->functions[it].argsize[7]
485
486         );
487         util_debug("GEN", "    NAME: %s\n", &code->chars[code->functions[it].name]);
488         /* Internal functions have no code */
489         if (code->functions[it].entry >= 0) {
490             util_debug("GEN", "    CODE:\n");
491             for (;;) {
492                 if (code->statements[j].opcode != INSTR_DONE)
493                     util_debug("GEN", "        %-12s {% 5i,% 5i,% 5i}\n",
494                         util_instr_str[code->statements[j].opcode],
495                         code->statements[j].o1.s1,
496                         code->statements[j].o2.s1,
497                         code->statements[j].o3.s1
498                     );
499                 else {
500                     util_debug("GEN", "        DONE  {0x00000,0x00000,0x00000}\n");
501                     break;
502                 }
503                 j++;
504             }
505         }
506     }
507
508     fs_file_close(fp);
509     code_stats(filename, lnofile, code, &code_header);
510     return true;
511 }
512
513 void code_cleanup(code_t *code) {
514     vec_free(code->statements);
515     vec_free(code->linenums);
516     vec_free(code->columnnums);
517     vec_free(code->defs);
518     vec_free(code->fields);
519     vec_free(code->functions);
520     vec_free(code->globals);
521     vec_free(code->chars);
522
523     util_htdel(code->string_cache);
524
525     mem_d(code);
526 }