2 * Copyright © 2016 Keith Packard <keithp@keithp.com>
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.
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.
21 #include <ao_lisp_os.h>
23 typedef uint16_t ao_poly;
24 typedef int16_t ao_signed_poly;
28 struct ao_lisp_os_save {
31 uint16_t const_checksum;
32 uint16_t const_checksum_inv;
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))
39 ao_lisp_os_save(void);
42 ao_lisp_os_restore_save(struct ao_lisp_os_save *save, int offset);
45 ao_lisp_os_restore(void);
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
55 #define _atom(n) ao_lisp_atom_poly(ao_lisp_atom_intern(n))
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")
79 #include "ao_lisp_const.h"
81 #define AO_LISP_POOL 3072
83 extern uint8_t ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA];
87 #define AO_LISP_CONS 0
89 #define AO_LISP_STRING 2
90 #define AO_LISP_OTHER 3
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
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
104 #define AO_LISP_NIL 0
106 extern uint16_t ao_lisp_top;
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
114 extern uint8_t ao_lisp_exception;
117 ao_lisp_is_const(ao_poly poly) {
118 return poly & AO_LISP_CONST;
121 #define AO_LISP_POOL_BASE (ao_lisp_pool - 4)
122 #define AO_LISP_CONST_BASE (ao_lisp_const - 4)
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)
128 ao_lisp_ref(ao_poly poly);
131 ao_lisp_poly(const void *addr, ao_poly type);
133 struct ao_lisp_type {
134 int (*size)(void *addr);
135 void (*mark)(void *addr);
136 void (*move)(void *addr);
140 struct ao_lisp_cons {
145 struct ao_lisp_atom {
157 struct ao_lisp_frame {
161 struct ao_lisp_val vals[];
164 #define AO_LISP_FRAME_NUM_MASK 0x7f
166 /* Set when the frame escapes the lambda */
167 #define AO_LISP_FRAME_MARK 0x80
169 static inline int ao_lisp_frame_num(struct ao_lisp_frame *f) {
172 return f->_num & AO_LISP_FRAME_NUM_MASK;
175 static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
178 return f->_num & AO_LISP_FRAME_MARK;
181 static inline struct ao_lisp_frame *
182 ao_lisp_poly_frame(ao_poly poly) {
183 struct ao_lisp_frame *frame = ao_lisp_ref(poly);
184 if (frame && frame->_num == 0xff)
186 return ao_lisp_ref(poly);
189 static inline ao_poly
190 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
191 return ao_lisp_poly(frame, AO_LISP_OTHER);
195 eval_sexpr, /* Evaluate an sexpr */
196 eval_val, /* Value computed */
197 eval_formal, /* Formal computed */
198 eval_exec, /* Start a lambda evaluation */
199 eval_cond, /* Start next cond clause */
200 eval_cond_test, /* Check cond condition */
201 eval_progn, /* Start next progn entry */
202 eval_while, /* Start while condition */
203 eval_while_test, /* Check while condition */
204 eval_macro, /* Finished with macro generation */
207 struct ao_lisp_stack {
208 uint8_t state; /* enum eval_state */
209 ao_poly prev; /* previous stack frame */
210 ao_poly sexprs; /* expressions to evaluate */
211 ao_poly values; /* values computed */
212 ao_poly values_tail; /* end of the values list for easy appending */
213 ao_poly frame; /* current lookup frame */
214 ao_poly list; /* most recent function call */
217 static inline struct ao_lisp_stack *
218 ao_lisp_poly_stack(ao_poly p)
220 return ao_lisp_ref(p);
223 static inline ao_poly
224 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
226 return ao_lisp_poly(stack, AO_LISP_OTHER);
229 extern struct ao_lisp_stack *ao_lisp_stack;
230 extern struct ao_lisp_stack *ao_lisp_stack_free_list;
231 extern ao_poly ao_lisp_v;
233 #define AO_LISP_FUNC_LAMBDA 0
234 #define AO_LISP_FUNC_NLAMBDA 1
235 #define AO_LISP_FUNC_MACRO 2
236 #define AO_LISP_FUNC_LEXPR 3
238 #define AO_LISP_FUNC_FREE_ARGS 0x80
239 #define AO_LISP_FUNC_MASK 0x7f
241 #define AO_LISP_FUNC_F_LAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
242 #define AO_LISP_FUNC_F_NLAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
243 #define AO_LISP_FUNC_F_MACRO (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
244 #define AO_LISP_FUNC_F_LEXPR (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
246 struct ao_lisp_builtin {
252 enum ao_lisp_builtin_id {
281 builtin_greater_equal,
292 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
294 extern const ao_lisp_func_t ao_lisp_builtins[];
296 static inline ao_lisp_func_t
297 ao_lisp_func(struct ao_lisp_builtin *b)
299 return ao_lisp_builtins[b->func];
302 struct ao_lisp_lambda {
309 static inline struct ao_lisp_lambda *
310 ao_lisp_poly_lambda(ao_poly poly)
312 return ao_lisp_ref(poly);
315 static inline ao_poly
316 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
318 return ao_lisp_poly(lambda, AO_LISP_OTHER);
322 ao_lisp_poly_other(ao_poly poly) {
323 return ao_lisp_ref(poly);
326 static inline uint8_t
327 ao_lisp_other_type(void *other) {
328 return *((uint8_t *) other);
331 static inline ao_poly
332 ao_lisp_other_poly(const void *other)
334 return ao_lisp_poly(other, AO_LISP_OTHER);
338 ao_lisp_size_round(int size)
340 return (size + 3) & ~3;
344 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
346 return ao_lisp_size_round(type->size(addr));
349 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
351 static inline int ao_lisp_poly_base_type(ao_poly poly) {
352 return poly & AO_LISP_TYPE_MASK;
355 static inline int ao_lisp_poly_type(ao_poly poly) {
356 int type = poly & AO_LISP_TYPE_MASK;
357 if (type == AO_LISP_OTHER)
358 return ao_lisp_other_type(ao_lisp_poly_other(poly));
362 static inline struct ao_lisp_cons *
363 ao_lisp_poly_cons(ao_poly poly)
365 return ao_lisp_ref(poly);
368 static inline ao_poly
369 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
371 return ao_lisp_poly(cons, AO_LISP_CONS);
375 ao_lisp_poly_int(ao_poly poly)
377 return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
380 static inline ao_poly
381 ao_lisp_int_poly(int i)
383 return ((ao_poly) i << 2) | AO_LISP_INT;
387 ao_lisp_poly_string(ao_poly poly)
389 return ao_lisp_ref(poly);
392 static inline ao_poly
393 ao_lisp_string_poly(char *s)
395 return ao_lisp_poly(s, AO_LISP_STRING);
398 static inline struct ao_lisp_atom *
399 ao_lisp_poly_atom(ao_poly poly)
401 return ao_lisp_ref(poly);
404 static inline ao_poly
405 ao_lisp_atom_poly(struct ao_lisp_atom *a)
407 return ao_lisp_poly(a, AO_LISP_OTHER);
410 static inline struct ao_lisp_builtin *
411 ao_lisp_poly_builtin(ao_poly poly)
413 return ao_lisp_ref(poly);
416 static inline ao_poly
417 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
419 return ao_lisp_poly(b, AO_LISP_OTHER);
422 /* memory functions */
424 extern int ao_lisp_collects;
426 /* returns 1 if the object was already marked */
428 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
430 /* returns 1 if the object was already marked */
432 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
435 ao_lisp_move_map(void *addr);
437 /* returns 1 if the object was already moved */
439 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
441 /* returns 1 if the object was already moved */
443 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
446 ao_lisp_alloc(int size);
449 ao_lisp_collect(void);
452 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
454 struct ao_lisp_cons *
455 ao_lisp_cons_fetch(int id);
458 ao_lisp_string_stash(int id, char *string);
461 ao_lisp_string_fetch(int id);
464 ao_lisp_poly_stash(int id, ao_poly poly);
467 ao_lisp_poly_fetch(int id);
470 extern const struct ao_lisp_type ao_lisp_cons_type;
472 struct ao_lisp_cons *
473 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
475 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
478 ao_lisp_cons_free(struct ao_lisp_cons *cons);
481 ao_lisp_cons_print(ao_poly);
484 ao_lisp_cons_patom(ao_poly);
487 ao_lisp_cons_length(struct ao_lisp_cons *cons);
490 extern const struct ao_lisp_type ao_lisp_string_type;
493 ao_lisp_string_copy(char *a);
496 ao_lisp_string_cat(char *a, char *b);
499 ao_lisp_string_pack(struct ao_lisp_cons *cons);
502 ao_lisp_string_unpack(char *a);
505 ao_lisp_string_print(ao_poly s);
508 ao_lisp_string_patom(ao_poly s);
511 extern const struct ao_lisp_type ao_lisp_atom_type;
513 extern struct ao_lisp_atom *ao_lisp_atoms;
514 extern struct ao_lisp_frame *ao_lisp_frame_global;
515 extern struct ao_lisp_frame *ao_lisp_frame_current;
518 ao_lisp_atom_print(ao_poly a);
520 struct ao_lisp_atom *
521 ao_lisp_atom_intern(char *name);
524 ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
527 ao_lisp_atom_get(ao_poly atom);
530 ao_lisp_atom_set(ao_poly atom, ao_poly val);
534 ao_lisp_int_print(ao_poly i);
538 ao_lisp_poly_print(ao_poly p);
541 ao_lisp_poly_patom(ao_poly p);
544 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
546 /* returns 1 if the object has already been moved */
548 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
553 ao_lisp_eval_clear_globals(void);
556 ao_lisp_eval_restart(void);
559 ao_lisp_eval(ao_poly p);
562 ao_lisp_set_cond(struct ao_lisp_cons *cons);
566 ao_lisp_builtin_print(ao_poly b);
568 extern const struct ao_lisp_type ao_lisp_builtin_type;
570 /* Check argument count */
572 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
574 /* Check argument type */
576 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
578 /* Fetch an arg (nil if off the end) */
580 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
583 ao_lisp_args_name(uint8_t args);
586 extern struct ao_lisp_cons *ao_lisp_read_cons;
587 extern struct ao_lisp_cons *ao_lisp_read_cons_tail;
588 extern struct ao_lisp_cons *ao_lisp_read_stack;
595 ao_lisp_read_eval_print(void);
598 extern const struct ao_lisp_type ao_lisp_frame_type;
600 #define AO_LISP_FRAME_FREE 4
602 extern struct ao_lisp_frame *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
605 ao_lisp_frame_mark(struct ao_lisp_frame *frame);
608 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
610 struct ao_lisp_frame *
611 ao_lisp_frame_new(int num);
614 ao_lisp_frame_free(struct ao_lisp_frame *frame);
617 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
620 ao_lisp_frame_print(ao_poly p);
623 extern const struct ao_lisp_type ao_lisp_lambda_type;
625 struct ao_lisp_lambda *
626 ao_lisp_lambda_new(ao_poly cons);
629 ao_lisp_lambda_print(ao_poly lambda);
632 ao_lisp_lambda(struct ao_lisp_cons *cons);
635 ao_lisp_lexpr(struct ao_lisp_cons *cons);
638 ao_lisp_nlambda(struct ao_lisp_cons *cons);
641 ao_lisp_macro(struct ao_lisp_cons *cons);
644 ao_lisp_lambda_eval(void);
649 ao_lisp_save(struct ao_lisp_cons *cons);
652 ao_lisp_restore(struct ao_lisp_cons *cons);
656 extern const struct ao_lisp_type ao_lisp_stack_type;
659 ao_lisp_stack_print(void);
662 ao_lisp_error(int error, char *format, ...);
664 /* debugging macros */
668 int ao_lisp_stack_depth;
670 #define DBG_INDENT() do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf(" "); } while(0)
671 #define DBG_IN() (++ao_lisp_stack_depth)
672 #define DBG_OUT() (--ao_lisp_stack_depth)
673 #define DBG_RESET() (ao_lisp_stack_depth = 0)
674 #define DBG(...) printf(__VA_ARGS__)
675 #define DBGI(...) do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
676 #define DBG_CONS(a) ao_lisp_cons_print(ao_lisp_cons_poly(a))
677 #define DBG_POLY(a) ao_lisp_poly_print(a)
678 #define OFFSET(a) ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
679 #define DBG_STACK() ao_lisp_stack_print()
681 ao_lisp_frames_dump(void)
683 struct ao_lisp_stack *s;
684 DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
685 for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
686 DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
689 #define DBG_FRAMES() ao_lisp_frames_dump()
705 #define DBG_MEM_START 1
710 extern int dbg_move_depth;
712 #define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
717 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf (" "); printf(__VA_ARGS__); } } while (0)
718 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
719 #define MDBG_MOVE_IN() (dbg_move_depth++)
720 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
725 #define MDBG_MOVE(...)
726 #define MDBG_MORE(...)
727 #define MDBG_MOVE_IN()
728 #define MDBG_MOVE_OUT()
732 #endif /* _AO_LISP_H_ */