altos/lisp: Cache freed cons and stack items
[fw/altos] / src / lisp / ao_lisp.h
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 #ifndef _AO_LISP_H_
16 #define _AO_LISP_H_
17
18 #include <stdint.h>
19 #include <string.h>
20 //#include <stdio.h>
21 #include <ao_lisp_os.h>
22
23 typedef uint16_t        ao_poly;
24 typedef int16_t         ao_signed_poly;
25
26 #ifdef AO_LISP_SAVE
27
28 struct ao_lisp_os_save {
29         ao_poly         atoms;
30         ao_poly         globals;
31         uint16_t        const_checksum;
32         uint16_t        const_checksum_inv;
33 };
34
35 #define AO_LISP_POOL_EXTRA      (sizeof(struct ao_lisp_os_save))
36 #define AO_LISP_POOL    ((int) (AO_LISP_POOL_TOTAL - AO_LISP_POOL_EXTRA))
37
38 int
39 ao_lisp_os_save(void);
40
41 int
42 ao_lisp_os_restore_save(struct ao_lisp_os_save *save, int offset);
43
44 int
45 ao_lisp_os_restore(void);
46
47 #endif
48
49 #ifdef AO_LISP_MAKE_CONST
50 #define AO_LISP_POOL_CONST      16384
51 extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
52 #define ao_lisp_pool ao_lisp_const
53 #define AO_LISP_POOL AO_LISP_POOL_CONST
54
55 #define _atom(n) ao_lisp_atom_poly(ao_lisp_atom_intern(n))
56
57 #define _ao_lisp_atom_quote     _atom("quote")
58 #define _ao_lisp_atom_set       _atom("set")
59 #define _ao_lisp_atom_setq      _atom("setq")
60 #define _ao_lisp_atom_t         _atom("t")
61 #define _ao_lisp_atom_car       _atom("car")
62 #define _ao_lisp_atom_cdr       _atom("cdr")
63 #define _ao_lisp_atom_cons      _atom("cons")
64 #define _ao_lisp_atom_last      _atom("last")
65 #define _ao_lisp_atom_length    _atom("length")
66 #define _ao_lisp_atom_cond      _atom("cond")
67 #define _ao_lisp_atom_lambda    _atom("lambda")
68 #define _ao_lisp_atom_led       _atom("led")
69 #define _ao_lisp_atom_delay     _atom("delay")
70 #define _ao_lisp_atom_pack      _atom("pack")
71 #define _ao_lisp_atom_unpack    _atom("unpack")
72 #define _ao_lisp_atom_flush     _atom("flush")
73 #define _ao_lisp_atom_eval      _atom("eval")
74 #define _ao_lisp_atom_read      _atom("read")
75 #define _ao_lisp_atom_eof       _atom("eof")
76 #define _ao_lisp_atom_save      _atom("save")
77 #define _ao_lisp_atom_restore   _atom("restore")
78 #else
79 #include "ao_lisp_const.h"
80 #ifndef AO_LISP_POOL
81 #define AO_LISP_POOL    3072
82 #endif
83 extern uint8_t          ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA];
84 #endif
85
86 /* Primitive types */
87 #define AO_LISP_CONS            0
88 #define AO_LISP_INT             1
89 #define AO_LISP_STRING          2
90 #define AO_LISP_OTHER           3
91
92 #define AO_LISP_TYPE_MASK       0x0003
93 #define AO_LISP_TYPE_SHIFT      2
94 #define AO_LISP_REF_MASK        0x7ffc
95 #define AO_LISP_CONST           0x8000
96
97 /* These have a type value at the start of the struct */
98 #define AO_LISP_ATOM            4
99 #define AO_LISP_BUILTIN         5
100 #define AO_LISP_FRAME           6
101 #define AO_LISP_LAMBDA          7
102 #define AO_LISP_NUM_TYPE        8
103
104 #define AO_LISP_NIL     0
105
106 extern uint16_t         ao_lisp_top;
107
108 #define AO_LISP_OOM             0x01
109 #define AO_LISP_DIVIDE_BY_ZERO  0x02
110 #define AO_LISP_INVALID         0x04
111 #define AO_LISP_UNDEFINED       0x08
112 #define AO_LISP_EOF             0x10
113
114 extern uint8_t          ao_lisp_exception;
115
116 static inline int
117 ao_lisp_is_const(ao_poly poly) {
118         return poly & AO_LISP_CONST;
119 }
120
121 #define AO_LISP_POOL_BASE       (ao_lisp_pool - 4)
122 #define AO_LISP_CONST_BASE      (ao_lisp_const - 4)
123
124 #define AO_LISP_IS_CONST(a)     (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
125 #define AO_LISP_IS_POOL(a)      (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
126
127 void *
128 ao_lisp_ref(ao_poly poly);
129
130 ao_poly
131 ao_lisp_poly(const void *addr, ao_poly type);
132
133 struct ao_lisp_type {
134         int     (*size)(void *addr);
135         void    (*mark)(void *addr);
136         void    (*move)(void *addr);
137         char    name[];
138 };
139
140 struct ao_lisp_cons {
141         ao_poly         car;
142         ao_poly         cdr;
143 };
144
145 struct ao_lisp_atom {
146         uint8_t         type;
147         uint8_t         pad[1];
148         ao_poly         next;
149         char            name[];
150 };
151
152 struct ao_lisp_val {
153         ao_poly         atom;
154         ao_poly         val;
155 };
156
157 struct ao_lisp_frame {
158         uint8_t                 type;
159         uint8_t                 num;
160         ao_poly                 next;
161         struct ao_lisp_val      vals[];
162 };
163
164 static inline struct ao_lisp_frame *
165 ao_lisp_poly_frame(ao_poly poly) {
166         return ao_lisp_ref(poly);
167 }
168
169 static inline ao_poly
170 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
171         return ao_lisp_poly(frame, AO_LISP_OTHER);
172 }
173
174 enum eval_state {
175         eval_sexpr,             /* Evaluate an sexpr */
176         eval_val,
177         eval_formal,
178         eval_exec,
179         eval_cond,
180         eval_cond_test,
181         eval_progn,
182         eval_while,
183         eval_while_test,
184 };
185
186 struct ao_lisp_stack {
187         uint8_t                 state;          /* enum eval_state */
188         ao_poly                 prev;           /* previous stack frame */
189         ao_poly                 sexprs;         /* expressions to evaluate */
190         ao_poly                 values;         /* values computed */
191         ao_poly                 values_tail;    /* end of the values list for easy appending */
192         ao_poly                 frame;          /* current lookup frame */
193         ao_poly                 list;           /* most recent function call */
194 };
195
196 static inline struct ao_lisp_stack *
197 ao_lisp_poly_stack(ao_poly p)
198 {
199         return ao_lisp_ref(p);
200 }
201
202 static inline ao_poly
203 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
204 {
205         return ao_lisp_poly(stack, AO_LISP_OTHER);
206 }
207
208 extern struct ao_lisp_stack     *ao_lisp_stack;
209 extern struct ao_lisp_stack     *ao_lisp_stack_free_list;
210 extern ao_poly                  ao_lisp_v;
211
212 #define AO_LISP_FUNC_LAMBDA     0
213 #define AO_LISP_FUNC_NLAMBDA    1
214 #define AO_LISP_FUNC_MACRO      2
215 #define AO_LISP_FUNC_LEXPR      3
216
217 #define AO_LISP_FUNC_FREE_ARGS  0x80
218 #define AO_LISP_FUNC_MASK       0x7f
219
220 #define AO_LISP_FUNC_F_LAMBDA   (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
221 #define AO_LISP_FUNC_F_NLAMBDA  (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
222 #define AO_LISP_FUNC_F_MACRO    (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
223 #define AO_LISP_FUNC_F_LEXPR    (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
224
225 struct ao_lisp_builtin {
226         uint8_t         type;
227         uint8_t         args;
228         uint16_t        func;
229 };
230
231 enum ao_lisp_builtin_id {
232         builtin_eval,
233         builtin_read,
234         builtin_lambda,
235         builtin_lexpr,
236         builtin_nlambda,
237         builtin_macro,
238         builtin_car,
239         builtin_cdr,
240         builtin_cons,
241         builtin_last,
242         builtin_length,
243         builtin_quote,
244         builtin_set,
245         builtin_setq,
246         builtin_cond,
247         builtin_progn,
248         builtin_while,
249         builtin_print,
250         builtin_patom,
251         builtin_plus,
252         builtin_minus,
253         builtin_times,
254         builtin_divide,
255         builtin_mod,
256         builtin_equal,
257         builtin_less,
258         builtin_greater,
259         builtin_less_equal,
260         builtin_greater_equal,
261         builtin_pack,
262         builtin_unpack,
263         builtin_flush,
264         builtin_delay,
265         builtin_led,
266         builtin_save,
267         builtin_restore,
268         _builtin_last
269 };
270
271 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
272
273 extern const ao_lisp_func_t     ao_lisp_builtins[];
274
275 static inline ao_lisp_func_t
276 ao_lisp_func(struct ao_lisp_builtin *b)
277 {
278         return ao_lisp_builtins[b->func];
279 }
280
281 struct ao_lisp_lambda {
282         uint8_t         type;
283         uint8_t         args;
284         ao_poly         code;
285         ao_poly         frame;
286 };
287
288 static inline struct ao_lisp_lambda *
289 ao_lisp_poly_lambda(ao_poly poly)
290 {
291         return ao_lisp_ref(poly);
292 }
293
294 static inline ao_poly
295 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
296 {
297         return ao_lisp_poly(lambda, AO_LISP_OTHER);
298 }
299
300 static inline void *
301 ao_lisp_poly_other(ao_poly poly) {
302         return ao_lisp_ref(poly);
303 }
304
305 static inline uint8_t
306 ao_lisp_other_type(void *other) {
307         return *((uint8_t *) other);
308 }
309
310 static inline ao_poly
311 ao_lisp_other_poly(const void *other)
312 {
313         return ao_lisp_poly(other, AO_LISP_OTHER);
314 }
315
316 static inline int
317 ao_lisp_size_round(int size)
318 {
319         return (size + 3) & ~3;
320 }
321
322 static inline int
323 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
324 {
325         return ao_lisp_size_round(type->size(addr));
326 }
327
328 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
329
330 static inline int ao_lisp_poly_base_type(ao_poly poly) {
331         return poly & AO_LISP_TYPE_MASK;
332 }
333
334 static inline int ao_lisp_poly_type(ao_poly poly) {
335         int     type = poly & AO_LISP_TYPE_MASK;
336         if (type == AO_LISP_OTHER)
337                 return ao_lisp_other_type(ao_lisp_poly_other(poly));
338         return type;
339 }
340
341 static inline struct ao_lisp_cons *
342 ao_lisp_poly_cons(ao_poly poly)
343 {
344         return ao_lisp_ref(poly);
345 }
346
347 static inline ao_poly
348 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
349 {
350         return ao_lisp_poly(cons, AO_LISP_CONS);
351 }
352
353 static inline int
354 ao_lisp_poly_int(ao_poly poly)
355 {
356         return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
357 }
358
359 static inline ao_poly
360 ao_lisp_int_poly(int i)
361 {
362         return ((ao_poly) i << 2) | AO_LISP_INT;
363 }
364
365 static inline char *
366 ao_lisp_poly_string(ao_poly poly)
367 {
368         return ao_lisp_ref(poly);
369 }
370
371 static inline ao_poly
372 ao_lisp_string_poly(char *s)
373 {
374         return ao_lisp_poly(s, AO_LISP_STRING);
375 }
376
377 static inline struct ao_lisp_atom *
378 ao_lisp_poly_atom(ao_poly poly)
379 {
380         return ao_lisp_ref(poly);
381 }
382
383 static inline ao_poly
384 ao_lisp_atom_poly(struct ao_lisp_atom *a)
385 {
386         return ao_lisp_poly(a, AO_LISP_OTHER);
387 }
388
389 static inline struct ao_lisp_builtin *
390 ao_lisp_poly_builtin(ao_poly poly)
391 {
392         return ao_lisp_ref(poly);
393 }
394
395 static inline ao_poly
396 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
397 {
398         return ao_lisp_poly(b, AO_LISP_OTHER);
399 }
400
401 /* memory functions */
402
403 extern int ao_lisp_collects;
404
405 /* returns 1 if the object was already marked */
406 int
407 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
408
409 /* returns 1 if the object was already marked */
410 int
411 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
412
413 void *
414 ao_lisp_move_map(void *addr);
415
416 /* returns 1 if the object was already moved */
417 int
418 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
419
420 /* returns 1 if the object was already moved */
421 int
422 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
423
424 void *
425 ao_lisp_alloc(int size);
426
427 void
428 ao_lisp_collect(void);
429
430 void
431 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
432
433 struct ao_lisp_cons *
434 ao_lisp_cons_fetch(int id);
435
436 void
437 ao_lisp_string_stash(int id, char *string);
438
439 char *
440 ao_lisp_string_fetch(int id);
441
442 void
443 ao_lisp_poly_stash(int id, ao_poly poly);
444
445 ao_poly
446 ao_lisp_poly_fetch(int id);
447
448 /* cons */
449 extern const struct ao_lisp_type ao_lisp_cons_type;
450
451 struct ao_lisp_cons *
452 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
453
454 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
455
456 void
457 ao_lisp_cons_free(struct ao_lisp_cons *cons);
458
459 void
460 ao_lisp_cons_print(ao_poly);
461
462 void
463 ao_lisp_cons_patom(ao_poly);
464
465 int
466 ao_lisp_cons_length(struct ao_lisp_cons *cons);
467
468 /* string */
469 extern const struct ao_lisp_type ao_lisp_string_type;
470
471 char *
472 ao_lisp_string_copy(char *a);
473
474 char *
475 ao_lisp_string_cat(char *a, char *b);
476
477 ao_poly
478 ao_lisp_string_pack(struct ao_lisp_cons *cons);
479
480 ao_poly
481 ao_lisp_string_unpack(char *a);
482
483 void
484 ao_lisp_string_print(ao_poly s);
485
486 void
487 ao_lisp_string_patom(ao_poly s);
488
489 /* atom */
490 extern const struct ao_lisp_type ao_lisp_atom_type;
491
492 extern struct ao_lisp_atom      *ao_lisp_atoms;
493 extern struct ao_lisp_frame     *ao_lisp_frame_global;
494 extern struct ao_lisp_frame     *ao_lisp_frame_current;
495
496 void
497 ao_lisp_atom_print(ao_poly a);
498
499 struct ao_lisp_atom *
500 ao_lisp_atom_intern(char *name);
501
502 ao_poly
503 ao_lisp_atom_get(ao_poly atom);
504
505 ao_poly
506 ao_lisp_atom_set(ao_poly atom, ao_poly val);
507
508 /* int */
509 void
510 ao_lisp_int_print(ao_poly i);
511
512 /* prim */
513 void
514 ao_lisp_poly_print(ao_poly p);
515
516 void
517 ao_lisp_poly_patom(ao_poly p);
518
519 int
520 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
521
522 /* returns 1 if the object has already been moved */
523 int
524 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
525
526 /* eval */
527
528 void
529 ao_lisp_eval_clear_globals(void);
530
531 int
532 ao_lisp_eval_restart(void);
533
534 ao_poly
535 ao_lisp_eval(ao_poly p);
536
537 ao_poly
538 ao_lisp_set_cond(struct ao_lisp_cons *cons);
539
540 /* builtin */
541 void
542 ao_lisp_builtin_print(ao_poly b);
543
544 extern const struct ao_lisp_type ao_lisp_builtin_type;
545
546 /* Check argument count */
547 ao_poly
548 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
549
550 /* Check argument type */
551 ao_poly
552 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
553
554 /* Fetch an arg (nil if off the end) */
555 ao_poly
556 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
557
558 char *
559 ao_lisp_args_name(uint8_t args);
560
561 /* read */
562 extern struct ao_lisp_cons      *ao_lisp_read_cons;
563 extern struct ao_lisp_cons      *ao_lisp_read_cons_tail;
564 extern struct ao_lisp_cons      *ao_lisp_read_stack;
565
566 ao_poly
567 ao_lisp_read(void);
568
569 /* rep */
570 ao_poly
571 ao_lisp_read_eval_print(void);
572
573 /* frame */
574 extern const struct ao_lisp_type ao_lisp_frame_type;
575
576 ao_poly *
577 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
578
579 struct ao_lisp_frame *
580 ao_lisp_frame_new(int num);
581
582 int
583 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
584
585 void
586 ao_lisp_frame_print(ao_poly p);
587
588 /* lambda */
589 extern const struct ao_lisp_type ao_lisp_lambda_type;
590
591 struct ao_lisp_lambda *
592 ao_lisp_lambda_new(ao_poly cons);
593
594 void
595 ao_lisp_lambda_print(ao_poly lambda);
596
597 ao_poly
598 ao_lisp_lambda(struct ao_lisp_cons *cons);
599
600 ao_poly
601 ao_lisp_lexpr(struct ao_lisp_cons *cons);
602
603 ao_poly
604 ao_lisp_nlambda(struct ao_lisp_cons *cons);
605
606 ao_poly
607 ao_lisp_macro(struct ao_lisp_cons *cons);
608
609 ao_poly
610 ao_lisp_lambda_eval(void);
611
612 /* save */
613
614 ao_poly
615 ao_lisp_save(struct ao_lisp_cons *cons);
616
617 ao_poly
618 ao_lisp_restore(struct ao_lisp_cons *cons);
619
620 /* error */
621
622 extern const struct ao_lisp_type ao_lisp_stack_type;
623
624 void
625 ao_lisp_stack_print(void);
626
627 ao_poly
628 ao_lisp_error(int error, char *format, ...);
629
630 /* debugging macros */
631
632 #if DBG_EVAL
633 #define DBG_CODE        1
634 int ao_lisp_stack_depth;
635 #define DBG_DO(a)       a
636 #define DBG_INDENT()    do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf("  "); } while(0)
637 #define DBG_IN()        (++ao_lisp_stack_depth)
638 #define DBG_OUT()       (--ao_lisp_stack_depth)
639 #define DBG_RESET()     (ao_lisp_stack_depth = 0)
640 #define DBG(...)        printf(__VA_ARGS__)
641 #define DBGI(...)       do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
642 #define DBG_CONS(a)     ao_lisp_cons_print(ao_lisp_cons_poly(a))
643 #define DBG_POLY(a)     ao_lisp_poly_print(a)
644 #define OFFSET(a)       ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
645 #define DBG_STACK()     ao_lisp_stack_print()
646 static inline void
647 ao_lisp_frames_dump(void)
648 {
649         struct ao_lisp_stack *s;
650         DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
651         for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
652                 DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
653         }
654 }
655 #define DBG_FRAMES()    ao_lisp_frames_dump()
656 #else
657 #define DBG_DO(a)
658 #define DBG_INDENT()
659 #define DBG_IN()
660 #define DBG_OUT()
661 #define DBG(...)
662 #define DBGI(...)
663 #define DBG_CONS(a)
664 #define DBG_POLY(a)
665 #define DBG_RESET()
666 #define DBG_STACK()
667 #define DBG_FRAMES()
668 #endif
669
670 #define DBG_MEM         0
671 #define DBG_MEM_START   1
672
673 #if DBG_MEM
674
675 #include <assert.h>
676 extern int dbg_move_depth;
677 #define MDBG_DUMP 1
678 #define MDBG_OFFSET(a)  ((int) ((uint8_t *) (a) - ao_lisp_pool))
679
680 extern int dbg_mem;
681
682 #define MDBG_DO(a)      a
683 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf ("  "); printf(__VA_ARGS__); } } while (0)
684 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
685 #define MDBG_MOVE_IN()  (dbg_move_depth++)
686 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
687
688 #else
689
690 #define MDBG_DO(a)
691 #define MDBG_MOVE(...)
692 #define MDBG_MORE(...)
693 #define MDBG_MOVE_IN()
694 #define MDBG_MOVE_OUT()
695
696 #endif
697
698 #endif /* _AO_LISP_H_ */