altos/scheme: Support scheme subsetting via feature settings
[fw/altos] / src / scheme / ao_scheme_make_const.c
1 /*
2  * Copyright © 2016 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  */
14
15 #include "ao_scheme.h"
16 #include <stdlib.h>
17 #include <ctype.h>
18 #include <unistd.h>
19 #include <getopt.h>
20 #include <stdbool.h>
21
22 static struct ao_scheme_builtin *
23 ao_scheme_make_builtin(enum ao_scheme_builtin_id func, int args) {
24         struct ao_scheme_builtin *b = ao_scheme_alloc(sizeof (struct ao_scheme_builtin));
25
26         b->type = AO_SCHEME_BUILTIN;
27         b->func = func;
28         b->args = args;
29         return b;
30 }
31
32 struct builtin_func {
33         char    *feature;
34         char    *name;
35         int     args;
36         enum ao_scheme_builtin_id       func;
37 };
38
39 struct builtin_atom {
40         char    *feature;
41         char    *name;
42 };
43
44 #define AO_SCHEME_BUILTIN_CONSTS
45 #define AO_SCHEME_BUILTIN_ATOM_NAMES
46
47 #include "ao_scheme_builtin.h"
48
49 #define N_FUNC          (sizeof funcs / sizeof funcs[0])
50
51 #define N_ATOM          (sizeof atoms / sizeof atoms[0])
52
53 struct ao_scheme_frame  *globals;
54
55 static int
56 is_atom(int offset)
57 {
58         struct ao_scheme_atom *a;
59
60         for (a = ao_scheme_atoms; a; a = ao_scheme_poly_atom(a->next))
61                 if (((uint8_t *) a->name - ao_scheme_const) == offset)
62                         return strlen(a->name);
63         return 0;
64 }
65
66 #define AO_FEC_CRC_INIT 0xffff
67
68 static inline uint16_t
69 ao_fec_crc_byte(uint8_t byte, uint16_t crc)
70 {
71         uint8_t bit;
72
73         for (bit = 0; bit < 8; bit++) {
74                 if (((crc & 0x8000) >> 8) ^ (byte & 0x80))
75                         crc = (crc << 1) ^ 0x8005;
76                 else
77                         crc = (crc << 1);
78                 byte <<= 1;
79         }
80         return crc;
81 }
82
83 uint16_t
84 ao_fec_crc(const uint8_t *bytes, uint8_t len)
85 {
86         uint16_t        crc = AO_FEC_CRC_INIT;
87
88         while (len--)
89                 crc = ao_fec_crc_byte(*bytes++, crc);
90         return crc;
91 }
92
93 struct ao_scheme_macro_stack {
94         struct ao_scheme_macro_stack *next;
95         ao_poly p;
96 };
97
98 struct ao_scheme_macro_stack *macro_stack;
99
100 int
101 ao_scheme_macro_push(ao_poly p)
102 {
103         struct ao_scheme_macro_stack *m = macro_stack;
104
105         while (m) {
106                 if (m->p == p)
107                         return 1;
108                 m = m->next;
109         }
110         m = malloc (sizeof (struct ao_scheme_macro_stack));
111         m->p = p;
112         m->next = macro_stack;
113         macro_stack = m;
114         return 0;
115 }
116
117 void
118 ao_scheme_macro_pop(void)
119 {
120         struct ao_scheme_macro_stack *m = macro_stack;
121
122         macro_stack = m->next;
123         free(m);
124 }
125
126 #define DBG_MACRO 0
127 #if DBG_MACRO
128 int macro_scan_depth;
129
130 void indent(void)
131 {
132         int i;
133         for (i = 0; i < macro_scan_depth; i++)
134                 printf("  ");
135 }
136 #define MACRO_DEBUG(a)  a
137 #else
138 #define MACRO_DEBUG(a)
139 #endif
140
141 ao_poly
142 ao_has_macro(ao_poly p);
143
144 ao_poly
145 ao_macro_test_get(ao_poly atom)
146 {
147         ao_poly *ref = ao_scheme_atom_ref(atom, NULL);
148         if (ref)
149                 return *ref;
150         return AO_SCHEME_NIL;
151 }
152
153 ao_poly
154 ao_is_macro(ao_poly p)
155 {
156         struct ao_scheme_builtin        *builtin;
157         struct ao_scheme_lambda *lambda;
158         ao_poly ret;
159
160         MACRO_DEBUG(indent(); printf ("is macro "); ao_scheme_poly_write(p); printf("\n"); ++macro_scan_depth);
161         switch (ao_scheme_poly_type(p)) {
162         case AO_SCHEME_ATOM:
163                 if (ao_scheme_macro_push(p))
164                         ret = AO_SCHEME_NIL;
165                 else {
166                         if (ao_is_macro(ao_macro_test_get(p)))
167                                 ret = p;
168                         else
169                                 ret = AO_SCHEME_NIL;
170                         ao_scheme_macro_pop();
171                 }
172                 break;
173         case AO_SCHEME_CONS:
174                 ret = ao_has_macro(p);
175                 break;
176         case AO_SCHEME_BUILTIN:
177                 builtin = ao_scheme_poly_builtin(p);
178                 if ((builtin->args & AO_SCHEME_FUNC_MASK) == AO_SCHEME_FUNC_MACRO)
179                         ret = p;
180                 else
181                         ret = 0;
182                 break;
183
184         case AO_SCHEME_LAMBDA:
185                 lambda = ao_scheme_poly_lambda(p);
186                 if (lambda->args == AO_SCHEME_FUNC_MACRO)
187                         ret = p;
188                 else
189                         ret = ao_has_macro(lambda->code);
190                 break;
191         default:
192                 ret = AO_SCHEME_NIL;
193                 break;
194         }
195         MACRO_DEBUG(--macro_scan_depth; indent(); printf ("... "); ao_scheme_poly_write(ret); printf("\n"));
196         return ret;
197 }
198
199 ao_poly
200 ao_has_macro(ao_poly p)
201 {
202         struct ao_scheme_cons   *cons;
203         struct ao_scheme_lambda *lambda;
204         ao_poly                 m;
205         ao_poly                 list;
206
207         if (p == AO_SCHEME_NIL)
208                 return AO_SCHEME_NIL;
209
210         MACRO_DEBUG(indent(); printf("has macro "); ao_scheme_poly_write(p); printf("\n"); ++macro_scan_depth);
211         switch (ao_scheme_poly_type(p)) {
212         case AO_SCHEME_LAMBDA:
213                 lambda = ao_scheme_poly_lambda(p);
214                 p = ao_has_macro(lambda->code);
215                 break;
216         case AO_SCHEME_CONS:
217                 cons = ao_scheme_poly_cons(p);
218                 if ((p = ao_is_macro(cons->car)))
219                         break;
220
221                 list = cons->cdr;
222                 p = AO_SCHEME_NIL;
223                 while (list != AO_SCHEME_NIL && ao_scheme_poly_type(list) == AO_SCHEME_CONS) {
224                         cons = ao_scheme_poly_cons(list);
225                         m = ao_has_macro(cons->car);
226                         if (m) {
227                                 p = m;
228                                 break;
229                         }
230                         list = cons->cdr;
231                 }
232                 break;
233
234         default:
235                 p = AO_SCHEME_NIL;
236                 break;
237         }
238         MACRO_DEBUG(--macro_scan_depth; indent(); printf("... "); ao_scheme_poly_write(p); printf("\n"));
239         return p;
240 }
241
242 static struct ao_scheme_builtin *
243 ao_scheme_get_builtin(ao_poly p)
244 {
245         if (ao_scheme_poly_type(p) == AO_SCHEME_BUILTIN)
246                 return ao_scheme_poly_builtin(p);
247         return NULL;
248 }
249
250 struct seen_builtin {
251         struct seen_builtin             *next;
252         struct ao_scheme_builtin        *builtin;
253 };
254
255 static struct seen_builtin *seen_builtins;
256
257 static int
258 ao_scheme_seen_builtin(struct ao_scheme_builtin *b)
259 {
260         struct seen_builtin     *s;
261
262         for (s = seen_builtins; s; s = s->next)
263                 if (s->builtin == b)
264                         return 1;
265         s = malloc (sizeof (struct seen_builtin));
266         s->builtin = b;
267         s->next = seen_builtins;
268         seen_builtins = s;
269         return 0;
270 }
271
272 int
273 ao_scheme_read_eval_abort(void)
274 {
275         ao_poly in, out = AO_SCHEME_NIL;
276         for(;;) {
277                 in = ao_scheme_read();
278                 if (in == _ao_scheme_atom_eof)
279                         break;
280                 out = ao_scheme_eval(in);
281                 if (ao_scheme_exception)
282                         return 0;
283                 ao_scheme_poly_write(out);
284                 putchar ('\n');
285         }
286         return 1;
287 }
288
289 static FILE     *in;
290 static FILE     *out;
291
292 struct feature {
293         struct feature  *next;
294         char            name[];
295 };
296
297 static struct feature *enable;
298 static struct feature *disable;
299
300 void
301 ao_scheme_add_feature(struct feature **list, char *name)
302 {
303         struct feature *feature = malloc (sizeof (struct feature) + strlen(name) + 1);
304         strcpy(feature->name, name);
305         feature->next = *list;
306         *list = feature;
307 }
308
309 bool
310 ao_scheme_has_feature(struct feature *list, char *name)
311 {
312         while (list) {
313                 if (!strcmp(list->name, name))
314                         return true;
315                 list = list->next;
316         }
317         return false;
318 }
319
320 void
321 ao_scheme_add_features(struct feature **list, char *names)
322 {
323         char    *saveptr = NULL;
324         char    *name;
325
326         while ((name = strtok_r(names, ",", &saveptr)) != NULL) {
327                 names = NULL;
328                 if (!ao_scheme_has_feature(*list, name))
329                         ao_scheme_add_feature(list, name);
330         }
331 }
332
333 int
334 ao_scheme_getc(void)
335 {
336         return getc(in);
337 }
338
339 static const struct option options[] = {
340         { .name = "out", .has_arg = 1, .val = 'o' },
341         { .name = "disable", .has_arg = 1, .val = 'd' },
342         { .name = "enable", .has_arg = 1, .val = 'e' },
343         { 0, 0, 0, 0 }
344 };
345
346 static void usage(char *program)
347 {
348         fprintf(stderr, "usage: %s [--out=<output>] [--disable={feature,...}] [--enable={feature,...} [input]\n", program);
349         exit(1);
350 }
351
352 int
353 main(int argc, char **argv)
354 {
355         int     f, o, an;
356         ao_poly val;
357         struct ao_scheme_atom   *a;
358         struct ao_scheme_builtin        *b;
359         int     in_atom = 0;
360         char    *out_name = NULL;
361         int     c;
362         enum ao_scheme_builtin_id       prev_func;
363         enum ao_scheme_builtin_id       target_func;
364         enum ao_scheme_builtin_id       func_map[_builtin_last];
365
366         in = stdin;
367         out = stdout;
368
369         while ((c = getopt_long(argc, argv, "o:d:e:", options, NULL)) != -1) {
370                 switch (c) {
371                 case 'o':
372                         out_name = optarg;
373                         break;
374                 case 'd':
375                         ao_scheme_add_features(&disable, optarg);
376                         break;
377                 case 'e':
378                         ao_scheme_add_features(&enable, optarg);
379                         break;
380                 default:
381                         usage(argv[0]);
382                         break;
383                 }
384         }
385
386         ao_scheme_frame_init();
387
388         /* Boolean values #f and #t */
389         ao_scheme_bool_get(0);
390         ao_scheme_bool_get(1);
391
392         prev_func = _builtin_last;
393         target_func = 0;
394         for (f = 0; f < (int) N_FUNC; f++) {
395                 if (ao_scheme_has_feature(enable, funcs[f].feature) || !ao_scheme_has_feature(disable, funcs[f].feature)) {
396                         if (funcs[f].func != prev_func) {
397                                 prev_func = funcs[f].func;
398                                 b = ao_scheme_make_builtin(prev_func, funcs[f].args);
399
400                                 /* Target may have only a subset of
401                                  * the enum values; record what those
402                                  * values will be here. This obviously
403                                  * depends on the functions in the
404                                  * array being in the same order as
405                                  * the enumeration; which
406                                  * ao_scheme_make_builtin ensures.
407                                  */
408                                 func_map[prev_func] = target_func++;
409                         }
410                         a = ao_scheme_atom_intern(funcs[f].name);
411                         ao_scheme_atom_def(ao_scheme_atom_poly(a),
412                                            ao_scheme_builtin_poly(b));
413                 }
414         }
415
416         /* atoms */
417         for (an = 0; an < (int) N_ATOM; an++) {
418                 if (ao_scheme_has_feature(enable, atoms[an].feature) || !ao_scheme_has_feature(disable, atoms[an].feature))
419                         a = ao_scheme_atom_intern((char *) atoms[an].name);
420         }
421
422         if (argv[optind]){
423                 in = fopen(argv[optind], "r");
424                 if (!in) {
425                         perror(argv[optind]);
426                         exit(1);
427                 }
428         }
429         if (!ao_scheme_read_eval_abort()) {
430                 fprintf(stderr, "eval failed\n");
431                 exit(1);
432         }
433
434         /* Reduce to referenced values */
435         ao_scheme_collect(AO_SCHEME_COLLECT_FULL);
436
437         for (f = 0; f < ao_scheme_frame_global->num; f++) {
438                 struct ao_scheme_frame_vals     *vals = ao_scheme_poly_frame_vals(ao_scheme_frame_global->vals);
439
440                 val = ao_has_macro(vals->vals[f].val);
441                 if (val != AO_SCHEME_NIL) {
442                         printf("error: function %s contains unresolved macro: ",
443                                ao_scheme_poly_atom(vals->vals[f].atom)->name);
444                         ao_scheme_poly_write(val);
445                         printf("\n");
446                         exit(1);
447                 }
448
449                 /* Remap builtin enum values to match target set */
450                 b = ao_scheme_get_builtin(vals->vals[f].val);
451                 if (b != NULL) {
452                         if (!ao_scheme_seen_builtin(b))
453                                 b->func = func_map[b->func];
454                 }
455         }
456
457         if (out_name) {
458                 out = fopen(out_name, "w");
459                 if (!out) {
460                         perror(out_name);
461                         exit(1);
462                 }
463         }
464
465         fprintf(out, "/* Generated file, do not edit */\n\n");
466
467         fprintf(out, "#define AO_SCHEME_POOL_CONST %d\n", ao_scheme_top);
468         fprintf(out, "extern const uint8_t ao_scheme_const[AO_SCHEME_POOL_CONST] __attribute__((aligned(4)));\n");
469         fprintf(out, "#define ao_builtin_atoms 0x%04x\n", ao_scheme_atom_poly(ao_scheme_atoms));
470         fprintf(out, "#define ao_builtin_frame 0x%04x\n", ao_scheme_frame_poly(ao_scheme_frame_global));
471         fprintf(out, "#define ao_scheme_const_checksum ((uint16_t) 0x%04x)\n", ao_fec_crc(ao_scheme_const, ao_scheme_top));
472
473         fprintf(out, "#define _ao_scheme_bool_false 0x%04x\n", ao_scheme_bool_poly(ao_scheme_false));
474         fprintf(out, "#define _ao_scheme_bool_true 0x%04x\n", ao_scheme_bool_poly(ao_scheme_true));
475
476         for (a = ao_scheme_atoms; a; a = ao_scheme_poly_atom(a->next)) {
477                 char    *n = a->name, c;
478                 fprintf(out, "#define _ao_scheme_atom_");
479                 while ((c = *n++)) {
480                         if (isalnum(c))
481                                 fprintf(out, "%c", c);
482                         else
483                                 fprintf(out, "%02x", c);
484                 }
485                 fprintf(out, "  0x%04x\n", ao_scheme_atom_poly(a));
486         }
487         fprintf(out, "#ifdef AO_SCHEME_CONST_BITS\n");
488         fprintf(out, "const uint8_t ao_scheme_const[AO_SCHEME_POOL_CONST] __attribute((aligned(4))) = {");
489         for (o = 0; o < ao_scheme_top; o++) {
490                 uint8_t c;
491                 if ((o & 0xf) == 0)
492                         fprintf(out, "\n\t");
493                 else
494                         fprintf(out, " ");
495                 c = ao_scheme_const[o];
496                 if (!in_atom)
497                         in_atom = is_atom(o);
498                 if (in_atom) {
499                         fprintf(out, " '%c',", c);
500                         in_atom--;
501                 } else {
502                         fprintf(out, "0x%02x,", c);
503                 }
504         }
505         fprintf(out, "\n};\n");
506         fprintf(out, "#endif /* AO_SCHEME_CONST_BITS */\n");
507         exit(0);
508 }