3 * Dale Weiler, Wolfgang Bumiller
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:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
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
26 uint32_t offset; /* Offset in file of where data begins */
27 uint32_t length; /* Length of section (how many of) */
31 uint32_t version; /* Program version (6) */
32 uint16_t crc16; /* What is this? */
33 uint16_t skip; /* see propsal.txt */
35 prog_section statements; /* prog_section_statement */
36 prog_section defs; /* prog_section_def */
37 prog_section fields; /* prog_section_field */
38 prog_section functions; /* prog_section_function */
39 prog_section strings; /* What is this? */
40 prog_section globals; /* What is this? */
41 uint32_t entfield; /* Number of entity fields */
45 * The macros below expand to a typesafe vector implementation, which
46 * can be viewed in gmqcc.h
48 * code_statements_data -- raw prog_section_statement array
49 * code_statements_elements -- number of elements
50 * code_statements_allocated -- size of the array allocated
51 * code_statements_add(T) -- add element (returns -1 on error)
53 * code_vars_data -- raw prog_section_var array
54 * code_vars_elements -- number of elements
55 * code_vars_allocated -- size of the array allocated
56 * code_vars_add(T) -- add element (returns -1 on error)
58 * code_fields_data -- raw prog_section_field array
59 * code_fields_elements -- number of elements
60 * code_fields_allocated -- size of the array allocated
61 * code_fields_add(T) -- add element (returns -1 on error)
63 * code_functions_data -- raw prog_section_function array
64 * code_functions_elements -- number of elements
65 * code_functions_allocated -- size of the array allocated
66 * code_functions_add(T) -- add element (returns -1 on error)
68 * code_globals_data -- raw prog_section_def array
69 * code_globals_elements -- number of elements
70 * code_globals_allocated -- size of the array allocated
71 * code_globals_add(T) -- add element (returns -1 on error)
73 * code_chars_data -- raw char* array
74 * code_chars_elements -- number of elements
75 * code_chars_allocated -- size of the array allocated
76 * code_chars_add(T) -- add element (returns -1 on error)
78 VECTOR_MAKE(prog_section_statement, code_statements);
79 VECTOR_MAKE(prog_section_def, code_defs );
80 VECTOR_MAKE(prog_section_field, code_fields );
81 VECTOR_MAKE(prog_section_function, code_functions );
82 VECTOR_MAKE(int, code_globals );
83 VECTOR_MAKE(char, code_chars );
86 prog_section_function empty_function = {0,0,0,0,0,0,0,{0}};
87 prog_section_statement empty_statement = {0,{0},{0},{0}};
90 /* omit creation of null code */
91 if (opts_omit_nullcode)
95 * The way progs.dat is suppose to work is odd, there needs to be
96 * some null (empty) statements, functions, and 28 globals
101 code_chars_add ('\0');
102 code_functions_add (empty_function);
103 code_statements_add(empty_statement);
106 uint32_t code_genstring(const char *str)
108 uint32_t off = code_chars_elements;
110 code_chars_add(*str);
117 uint32_t code_cachedstring(const char *str)
120 /* We could implement knuth-morris-pratt or something
121 * and also take substrings, but I'm uncomfortable with
122 * pointing to subparts of strings for the sake of clarity...
124 while (s < code_chars_elements) {
125 if (!strcmp(str, code_chars_data + s))
127 while (code_chars_data[s]) ++s;
130 return code_genstring(str);
134 prog_section_def d1 = { TYPE_VOID, 28, 1 };
135 prog_section_def d2 = { TYPE_FUNCTION, 29, 8 };
136 prog_section_def d3 = { TYPE_STRING, 30, 14};
137 prog_section_function f1 = { 1, 0, 0, 0, 1, 0,0, {0}};
138 prog_section_function f2 = {-4, 0, 0, 0, 8, 0,0, {0}};
139 prog_section_function f3 = { 0, 0, 0, 0, 14+13, 0,0, {0}};
140 prog_section_function f4 = { 0, 0, 0, 0, 14+13+10, 0,0, {0}};
141 prog_section_function f5 = { 0, 0, 0, 0, 14+13+10+7, 0,0, {0}};
142 prog_section_function f6 = { 0, 0, 0, 0, 14+13+10+7+9, 0,0, {0}};
143 prog_section_statement s1 = { INSTR_STORE_F, {30}, {OFS_PARM0}, {0}};
144 prog_section_statement s2 = { INSTR_CALL1, {29}, {0}, {0}};
145 prog_section_statement s3 = { INSTR_RETURN, {0}, {0}, {0}};
147 code_chars_put("m_init", 0x6);
148 code_chars_put("print", 0x5);
149 code_chars_put("hello world\n", 0xC);
150 code_chars_put("m_keydown", 0x9);
151 code_chars_put("m_draw", 0x6);
152 code_chars_put("m_toggle", 0x8);
153 code_chars_put("m_shutdown", 0xA);
155 code_globals_add(1); /* m_init */
156 code_globals_add(2); /* print */
157 code_globals_add(14); /* hello world in string table */
160 code_defs_add (d1); /* m_init */
161 code_defs_add (d2); /* print */
162 code_defs_add (d3); /*hello_world*/
163 code_functions_add (f1); /* m_init */
164 code_functions_add (f2); /* print */
165 code_functions_add (f3); /* m_keydown */
166 code_functions_add (f4);
167 code_functions_add (f5);
168 code_functions_add (f6);
169 code_statements_add(s1);
170 code_statements_add(s2);
171 code_statements_add(s3);
174 bool code_write(const char *filename) {
175 prog_header code_header;
179 /* see proposal.txt */
180 if (opts_omit_nullcode) {}
181 code_header.statements.offset = sizeof(prog_header);
182 code_header.statements.length = code_statements_elements;
183 code_header.defs.offset = code_header.statements.offset + (sizeof(prog_section_statement) * code_statements_elements);
184 code_header.defs.length = code_defs_elements;
185 code_header.fields.offset = code_header.defs.offset + (sizeof(prog_section_def) * code_defs_elements);
186 code_header.fields.length = code_fields_elements;
187 code_header.functions.offset = code_header.fields.offset + (sizeof(prog_section_field) * code_fields_elements);
188 code_header.functions.length = code_functions_elements;
189 code_header.globals.offset = code_header.functions.offset + (sizeof(prog_section_function) * code_functions_elements);
190 code_header.globals.length = code_globals_elements;
191 code_header.strings.offset = code_header.globals.offset + (sizeof(int32_t) * code_globals_elements);
192 code_header.strings.length = code_chars_elements;
193 code_header.version = 6;
194 code_header.crc16 = 0; /* TODO: */
195 code_header.entfield = 0; /* TODO: */
197 if (opts_darkplaces_stringtablebug) {
198 util_debug("GEN", "Patching stringtable for -fdarkplaces-stringtablebug\n");
201 code_chars_add('\0'); /* > */
202 code_chars_add('\0'); /* = */
203 code_chars_add('\0'); /* P */
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));
214 fp = fopen(filename, "wb");
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))
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);
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]
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");
268 if (code_statements_data[j].opcode != AINSTR_END)
269 util_debug("GEN", " %s {0x%05x,0x%05x,0x%05x}\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
276 util_debug("GEN", " DONE {0x00000,0x00000,0x00000}\n");
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);