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_IS_CONST(a) (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
122 #define AO_LISP_IS_POOL(a) (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
125 ao_lisp_ref(ao_poly poly);
128 ao_lisp_poly(const void *addr, ao_poly type);
130 struct ao_lisp_type {
131 int (*size)(void *addr);
132 void (*mark)(void *addr);
133 void (*move)(void *addr);
137 struct ao_lisp_cons {
142 struct ao_lisp_atom {
154 struct ao_lisp_frame {
158 struct ao_lisp_val vals[];
161 #define AO_LISP_FRAME_NUM_MASK 0x7f
163 /* Set when the frame escapes the lambda */
164 #define AO_LISP_FRAME_MARK 0x80
166 static inline int ao_lisp_frame_num(struct ao_lisp_frame *f) {
169 return f->_num & AO_LISP_FRAME_NUM_MASK;
172 static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
175 return f->_num & AO_LISP_FRAME_MARK;
178 static inline struct ao_lisp_frame *
179 ao_lisp_poly_frame(ao_poly poly) {
180 struct ao_lisp_frame *frame = ao_lisp_ref(poly);
181 if (frame && frame->_num == 0xff)
183 return ao_lisp_ref(poly);
186 static inline ao_poly
187 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
188 return ao_lisp_poly(frame, AO_LISP_OTHER);
192 eval_sexpr, /* Evaluate an sexpr */
193 eval_val, /* Value computed */
194 eval_formal, /* Formal computed */
195 eval_exec, /* Start a lambda evaluation */
196 eval_cond, /* Start next cond clause */
197 eval_cond_test, /* Check cond condition */
198 eval_progn, /* Start next progn entry */
199 eval_while, /* Start while condition */
200 eval_while_test, /* Check while condition */
201 eval_macro, /* Finished with macro generation */
204 struct ao_lisp_stack {
205 uint8_t state; /* enum eval_state */
206 ao_poly prev; /* previous stack frame */
207 ao_poly sexprs; /* expressions to evaluate */
208 ao_poly values; /* values computed */
209 ao_poly values_tail; /* end of the values list for easy appending */
210 ao_poly frame; /* current lookup frame */
211 ao_poly list; /* most recent function call */
214 static inline struct ao_lisp_stack *
215 ao_lisp_poly_stack(ao_poly p)
217 return ao_lisp_ref(p);
220 static inline ao_poly
221 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
223 return ao_lisp_poly(stack, AO_LISP_OTHER);
226 extern struct ao_lisp_stack *ao_lisp_stack;
227 extern struct ao_lisp_stack *ao_lisp_stack_free_list;
228 extern ao_poly ao_lisp_v;
230 #define AO_LISP_FUNC_LAMBDA 0
231 #define AO_LISP_FUNC_NLAMBDA 1
232 #define AO_LISP_FUNC_MACRO 2
233 #define AO_LISP_FUNC_LEXPR 3
235 #define AO_LISP_FUNC_FREE_ARGS 0x80
236 #define AO_LISP_FUNC_MASK 0x7f
238 #define AO_LISP_FUNC_F_LAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
239 #define AO_LISP_FUNC_F_NLAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
240 #define AO_LISP_FUNC_F_MACRO (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
241 #define AO_LISP_FUNC_F_LEXPR (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
243 struct ao_lisp_builtin {
249 enum ao_lisp_builtin_id {
278 builtin_greater_equal,
289 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
291 extern const ao_lisp_func_t ao_lisp_builtins[];
293 static inline ao_lisp_func_t
294 ao_lisp_func(struct ao_lisp_builtin *b)
296 return ao_lisp_builtins[b->func];
299 struct ao_lisp_lambda {
306 static inline struct ao_lisp_lambda *
307 ao_lisp_poly_lambda(ao_poly poly)
309 return ao_lisp_ref(poly);
312 static inline ao_poly
313 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
315 return ao_lisp_poly(lambda, AO_LISP_OTHER);
319 ao_lisp_poly_other(ao_poly poly) {
320 return ao_lisp_ref(poly);
323 static inline uint8_t
324 ao_lisp_other_type(void *other) {
325 return *((uint8_t *) other);
328 static inline ao_poly
329 ao_lisp_other_poly(const void *other)
331 return ao_lisp_poly(other, AO_LISP_OTHER);
335 ao_lisp_size_round(int size)
337 return (size + 3) & ~3;
341 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
343 return ao_lisp_size_round(type->size(addr));
346 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
348 static inline int ao_lisp_poly_base_type(ao_poly poly) {
349 return poly & AO_LISP_TYPE_MASK;
352 static inline int ao_lisp_poly_type(ao_poly poly) {
353 int type = poly & AO_LISP_TYPE_MASK;
354 if (type == AO_LISP_OTHER)
355 return ao_lisp_other_type(ao_lisp_poly_other(poly));
359 static inline struct ao_lisp_cons *
360 ao_lisp_poly_cons(ao_poly poly)
362 return ao_lisp_ref(poly);
365 static inline ao_poly
366 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
368 return ao_lisp_poly(cons, AO_LISP_CONS);
372 ao_lisp_poly_int(ao_poly poly)
374 return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
377 static inline ao_poly
378 ao_lisp_int_poly(int i)
380 return ((ao_poly) i << 2) | AO_LISP_INT;
384 ao_lisp_poly_string(ao_poly poly)
386 return ao_lisp_ref(poly);
389 static inline ao_poly
390 ao_lisp_string_poly(char *s)
392 return ao_lisp_poly(s, AO_LISP_STRING);
395 static inline struct ao_lisp_atom *
396 ao_lisp_poly_atom(ao_poly poly)
398 return ao_lisp_ref(poly);
401 static inline ao_poly
402 ao_lisp_atom_poly(struct ao_lisp_atom *a)
404 return ao_lisp_poly(a, AO_LISP_OTHER);
407 static inline struct ao_lisp_builtin *
408 ao_lisp_poly_builtin(ao_poly poly)
410 return ao_lisp_ref(poly);
413 static inline ao_poly
414 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
416 return ao_lisp_poly(b, AO_LISP_OTHER);
419 /* memory functions */
421 extern int ao_lisp_collects[2];
422 extern int ao_lisp_freed[2];
423 extern int ao_lisp_loops[2];
425 /* returns 1 if the object was already marked */
427 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
429 /* returns 1 if the object was already marked */
431 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
434 ao_lisp_move_map(void *addr);
436 /* returns 1 if the object was already moved */
438 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
440 /* returns 1 if the object was already moved */
442 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
445 ao_lisp_alloc(int size);
447 #define AO_LISP_COLLECT_FULL 1
448 #define AO_LISP_COLLECT_INCREMENTAL 0
451 ao_lisp_collect(uint8_t style);
454 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
456 struct ao_lisp_cons *
457 ao_lisp_cons_fetch(int id);
460 ao_lisp_string_stash(int id, char *string);
463 ao_lisp_string_fetch(int id);
466 ao_lisp_poly_stash(int id, ao_poly poly);
469 ao_lisp_poly_fetch(int id);
472 extern const struct ao_lisp_type ao_lisp_cons_type;
474 struct ao_lisp_cons *
475 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
477 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
480 ao_lisp_cons_free(struct ao_lisp_cons *cons);
483 ao_lisp_cons_print(ao_poly);
486 ao_lisp_cons_patom(ao_poly);
489 ao_lisp_cons_length(struct ao_lisp_cons *cons);
492 extern const struct ao_lisp_type ao_lisp_string_type;
495 ao_lisp_string_copy(char *a);
498 ao_lisp_string_cat(char *a, char *b);
501 ao_lisp_string_pack(struct ao_lisp_cons *cons);
504 ao_lisp_string_unpack(char *a);
507 ao_lisp_string_print(ao_poly s);
510 ao_lisp_string_patom(ao_poly s);
513 extern const struct ao_lisp_type ao_lisp_atom_type;
515 extern struct ao_lisp_atom *ao_lisp_atoms;
516 extern struct ao_lisp_frame *ao_lisp_frame_global;
517 extern struct ao_lisp_frame *ao_lisp_frame_current;
520 ao_lisp_atom_print(ao_poly a);
522 struct ao_lisp_atom *
523 ao_lisp_atom_intern(char *name);
526 ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
529 ao_lisp_atom_get(ao_poly atom);
532 ao_lisp_atom_set(ao_poly atom, ao_poly val);
536 ao_lisp_int_print(ao_poly i);
540 ao_lisp_poly_print(ao_poly p);
543 ao_lisp_poly_patom(ao_poly p);
546 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
548 /* returns 1 if the object has already been moved */
550 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
555 ao_lisp_eval_clear_globals(void);
558 ao_lisp_eval_restart(void);
561 ao_lisp_eval(ao_poly p);
564 ao_lisp_set_cond(struct ao_lisp_cons *cons);
568 ao_lisp_builtin_print(ao_poly b);
570 extern const struct ao_lisp_type ao_lisp_builtin_type;
572 /* Check argument count */
574 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
576 /* Check argument type */
578 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
580 /* Fetch an arg (nil if off the end) */
582 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
585 ao_lisp_args_name(uint8_t args);
588 extern struct ao_lisp_cons *ao_lisp_read_cons;
589 extern struct ao_lisp_cons *ao_lisp_read_cons_tail;
590 extern struct ao_lisp_cons *ao_lisp_read_stack;
597 ao_lisp_read_eval_print(void);
600 extern const struct ao_lisp_type ao_lisp_frame_type;
602 #define AO_LISP_FRAME_FREE 4
604 extern struct ao_lisp_frame *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
607 ao_lisp_frame_mark(struct ao_lisp_frame *frame);
610 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
612 struct ao_lisp_frame *
613 ao_lisp_frame_new(int num);
616 ao_lisp_frame_free(struct ao_lisp_frame *frame);
619 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
622 ao_lisp_frame_print(ao_poly p);
625 extern const struct ao_lisp_type ao_lisp_lambda_type;
627 struct ao_lisp_lambda *
628 ao_lisp_lambda_new(ao_poly cons);
631 ao_lisp_lambda_print(ao_poly lambda);
634 ao_lisp_lambda(struct ao_lisp_cons *cons);
637 ao_lisp_lexpr(struct ao_lisp_cons *cons);
640 ao_lisp_nlambda(struct ao_lisp_cons *cons);
643 ao_lisp_macro(struct ao_lisp_cons *cons);
646 ao_lisp_lambda_eval(void);
651 ao_lisp_save(struct ao_lisp_cons *cons);
654 ao_lisp_restore(struct ao_lisp_cons *cons);
658 extern const struct ao_lisp_type ao_lisp_stack_type;
661 ao_lisp_stack_print(void);
664 ao_lisp_error(int error, char *format, ...);
666 /* debugging macros */
670 int ao_lisp_stack_depth;
672 #define DBG_INDENT() do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf(" "); } while(0)
673 #define DBG_IN() (++ao_lisp_stack_depth)
674 #define DBG_OUT() (--ao_lisp_stack_depth)
675 #define DBG_RESET() (ao_lisp_stack_depth = 0)
676 #define DBG(...) printf(__VA_ARGS__)
677 #define DBGI(...) do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
678 #define DBG_CONS(a) ao_lisp_cons_print(ao_lisp_cons_poly(a))
679 #define DBG_POLY(a) ao_lisp_poly_print(a)
680 #define OFFSET(a) ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
681 #define DBG_STACK() ao_lisp_stack_print()
683 ao_lisp_frames_dump(void)
685 struct ao_lisp_stack *s;
686 DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
687 for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
688 DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
691 #define DBG_FRAMES() ao_lisp_frames_dump()
707 #define DBG_MEM_START 1
712 extern int dbg_move_depth;
714 #define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
719 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf (" "); printf(__VA_ARGS__); } } while (0)
720 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
721 #define MDBG_MOVE_IN() (dbg_move_depth++)
722 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
727 #define MDBG_MOVE(...)
728 #define MDBG_MORE(...)
729 #define MDBG_MOVE_IN()
730 #define MDBG_MOVE_OUT()
734 #endif /* _AO_LISP_H_ */