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.
24 #include <ao_lisp_os.h>
26 typedef uint16_t ao_poly;
27 typedef int16_t ao_signed_poly;
31 struct ao_lisp_os_save {
34 uint16_t const_checksum;
35 uint16_t const_checksum_inv;
38 #define AO_LISP_POOL_EXTRA (sizeof(struct ao_lisp_os_save))
39 #define AO_LISP_POOL ((int) (AO_LISP_POOL_TOTAL - AO_LISP_POOL_EXTRA))
42 ao_lisp_os_save(void);
45 ao_lisp_os_restore_save(struct ao_lisp_os_save *save, int offset);
48 ao_lisp_os_restore(void);
52 #ifdef AO_LISP_MAKE_CONST
53 #define AO_LISP_POOL_CONST 16384
54 extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
55 #define ao_lisp_pool ao_lisp_const
56 #define AO_LISP_POOL AO_LISP_POOL_CONST
58 #define _atom(n) ao_lisp_atom_poly(ao_lisp_atom_intern(n))
60 #define _ao_lisp_atom_quote _atom("quote")
61 #define _ao_lisp_atom_set _atom("set")
62 #define _ao_lisp_atom_setq _atom("setq")
63 #define _ao_lisp_atom_t _atom("t")
64 #define _ao_lisp_atom_car _atom("car")
65 #define _ao_lisp_atom_cdr _atom("cdr")
66 #define _ao_lisp_atom_cons _atom("cons")
67 #define _ao_lisp_atom_last _atom("last")
68 #define _ao_lisp_atom_length _atom("length")
69 #define _ao_lisp_atom_cond _atom("cond")
70 #define _ao_lisp_atom_lambda _atom("lambda")
71 #define _ao_lisp_atom_led _atom("led")
72 #define _ao_lisp_atom_delay _atom("delay")
73 #define _ao_lisp_atom_pack _atom("pack")
74 #define _ao_lisp_atom_unpack _atom("unpack")
75 #define _ao_lisp_atom_flush _atom("flush")
76 #define _ao_lisp_atom_eval _atom("eval")
77 #define _ao_lisp_atom_read _atom("read")
78 #define _ao_lisp_atom_eof _atom("eof")
79 #define _ao_lisp_atom_save _atom("save")
80 #define _ao_lisp_atom_restore _atom("restore")
81 #define _ao_lisp_atom_call2fcc _atom("call/cc")
83 #include "ao_lisp_const.h"
85 #define AO_LISP_POOL 3072
87 extern uint8_t ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA];
91 #define AO_LISP_CONS 0
93 #define AO_LISP_STRING 2
94 #define AO_LISP_OTHER 3
96 #define AO_LISP_TYPE_MASK 0x0003
97 #define AO_LISP_TYPE_SHIFT 2
98 #define AO_LISP_REF_MASK 0x7ffc
99 #define AO_LISP_CONST 0x8000
101 /* These have a type value at the start of the struct */
102 #define AO_LISP_ATOM 4
103 #define AO_LISP_BUILTIN 5
104 #define AO_LISP_FRAME 6
105 #define AO_LISP_LAMBDA 7
106 #define AO_LISP_STACK 8
107 #define AO_LISP_NUM_TYPE 9
109 /* Leave two bits for types to use as they please */
110 #define AO_LISP_OTHER_TYPE_MASK 0x3f
112 #define AO_LISP_NIL 0
114 extern uint16_t ao_lisp_top;
116 #define AO_LISP_OOM 0x01
117 #define AO_LISP_DIVIDE_BY_ZERO 0x02
118 #define AO_LISP_INVALID 0x04
119 #define AO_LISP_UNDEFINED 0x08
120 #define AO_LISP_EOF 0x10
122 extern uint8_t ao_lisp_exception;
125 ao_lisp_is_const(ao_poly poly) {
126 return poly & AO_LISP_CONST;
129 #define AO_LISP_IS_CONST(a) (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
130 #define AO_LISP_IS_POOL(a) (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
133 ao_lisp_ref(ao_poly poly);
136 ao_lisp_poly(const void *addr, ao_poly type);
138 struct ao_lisp_type {
139 int (*size)(void *addr);
140 void (*mark)(void *addr);
141 void (*move)(void *addr);
145 struct ao_lisp_cons {
150 struct ao_lisp_atom {
162 struct ao_lisp_frame {
166 struct ao_lisp_val vals[];
169 /* Set on type when the frame escapes the lambda */
170 #define AO_LISP_FRAME_MARK 0x80
171 #define AO_LISP_FRAME_PRINT 0x40
173 static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
174 return f->type & AO_LISP_FRAME_MARK;
177 static inline struct ao_lisp_frame *
178 ao_lisp_poly_frame(ao_poly poly) {
179 return ao_lisp_ref(poly);
182 static inline ao_poly
183 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
184 return ao_lisp_poly(frame, AO_LISP_OTHER);
188 eval_sexpr, /* Evaluate an sexpr */
189 eval_val, /* Value computed */
190 eval_formal, /* Formal computed */
191 eval_exec, /* Start a lambda evaluation */
192 eval_cond, /* Start next cond clause */
193 eval_cond_test, /* Check cond condition */
194 eval_progn, /* Start next progn entry */
195 eval_while, /* Start while condition */
196 eval_while_test, /* Check while condition */
197 eval_macro, /* Finished with macro generation */
200 struct ao_lisp_stack {
201 uint8_t type; /* AO_LISP_STACK */
202 uint8_t state; /* enum eval_state */
203 ao_poly prev; /* previous stack frame */
204 ao_poly sexprs; /* expressions to evaluate */
205 ao_poly values; /* values computed */
206 ao_poly values_tail; /* end of the values list for easy appending */
207 ao_poly frame; /* current lookup frame */
208 ao_poly list; /* most recent function call */
211 #define AO_LISP_STACK_MARK 0x80 /* set on type when a reference has been taken */
212 #define AO_LISP_STACK_PRINT 0x40 /* stack is being printed */
214 static inline int ao_lisp_stack_marked(struct ao_lisp_stack *s) {
215 return s->type & AO_LISP_STACK_MARK;
218 static inline void ao_lisp_stack_mark(struct ao_lisp_stack *s) {
219 s->type |= AO_LISP_STACK_MARK;
222 static inline struct ao_lisp_stack *
223 ao_lisp_poly_stack(ao_poly p)
225 return ao_lisp_ref(p);
228 static inline ao_poly
229 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
231 return ao_lisp_poly(stack, AO_LISP_OTHER);
234 extern ao_poly ao_lisp_v;
236 #define AO_LISP_FUNC_LAMBDA 0
237 #define AO_LISP_FUNC_NLAMBDA 1
238 #define AO_LISP_FUNC_MACRO 2
239 #define AO_LISP_FUNC_LEXPR 3
241 #define AO_LISP_FUNC_FREE_ARGS 0x80
242 #define AO_LISP_FUNC_MASK 0x7f
244 #define AO_LISP_FUNC_F_LAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
245 #define AO_LISP_FUNC_F_NLAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
246 #define AO_LISP_FUNC_F_MACRO (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
247 #define AO_LISP_FUNC_F_LEXPR (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
249 struct ao_lisp_builtin {
255 enum ao_lisp_builtin_id {
284 builtin_greater_equal,
296 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
298 extern const ao_lisp_func_t ao_lisp_builtins[];
300 static inline ao_lisp_func_t
301 ao_lisp_func(struct ao_lisp_builtin *b)
303 return ao_lisp_builtins[b->func];
306 struct ao_lisp_lambda {
313 static inline struct ao_lisp_lambda *
314 ao_lisp_poly_lambda(ao_poly poly)
316 return ao_lisp_ref(poly);
319 static inline ao_poly
320 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
322 return ao_lisp_poly(lambda, AO_LISP_OTHER);
326 ao_lisp_poly_other(ao_poly poly) {
327 return ao_lisp_ref(poly);
330 static inline uint8_t
331 ao_lisp_other_type(void *other) {
333 if ((*((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK) >= AO_LISP_NUM_TYPE)
336 return *((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK;
339 static inline ao_poly
340 ao_lisp_other_poly(const void *other)
342 return ao_lisp_poly(other, AO_LISP_OTHER);
346 ao_lisp_size_round(int size)
348 return (size + 3) & ~3;
352 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
354 return ao_lisp_size_round(type->size(addr));
357 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
359 static inline int ao_lisp_poly_base_type(ao_poly poly) {
360 return poly & AO_LISP_TYPE_MASK;
363 static inline int ao_lisp_poly_type(ao_poly poly) {
364 int type = poly & AO_LISP_TYPE_MASK;
365 if (type == AO_LISP_OTHER)
366 return ao_lisp_other_type(ao_lisp_poly_other(poly));
370 static inline struct ao_lisp_cons *
371 ao_lisp_poly_cons(ao_poly poly)
373 return ao_lisp_ref(poly);
376 static inline ao_poly
377 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
379 return ao_lisp_poly(cons, AO_LISP_CONS);
383 ao_lisp_poly_int(ao_poly poly)
385 return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
388 static inline ao_poly
389 ao_lisp_int_poly(int i)
391 return ((ao_poly) i << 2) | AO_LISP_INT;
395 ao_lisp_poly_string(ao_poly poly)
397 return ao_lisp_ref(poly);
400 static inline ao_poly
401 ao_lisp_string_poly(char *s)
403 return ao_lisp_poly(s, AO_LISP_STRING);
406 static inline struct ao_lisp_atom *
407 ao_lisp_poly_atom(ao_poly poly)
409 return ao_lisp_ref(poly);
412 static inline ao_poly
413 ao_lisp_atom_poly(struct ao_lisp_atom *a)
415 return ao_lisp_poly(a, AO_LISP_OTHER);
418 static inline struct ao_lisp_builtin *
419 ao_lisp_poly_builtin(ao_poly poly)
421 return ao_lisp_ref(poly);
424 static inline ao_poly
425 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
427 return ao_lisp_poly(b, AO_LISP_OTHER);
430 /* memory functions */
432 extern int ao_lisp_collects[2];
433 extern int ao_lisp_freed[2];
434 extern int ao_lisp_loops[2];
436 /* returns 1 if the object was already marked */
438 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
440 /* returns 1 if the object was already marked */
442 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
445 ao_lisp_move_map(void *addr);
447 /* returns 1 if the object was already moved */
449 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
451 /* returns 1 if the object was already moved */
453 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
456 ao_lisp_alloc(int size);
458 #define AO_LISP_COLLECT_FULL 1
459 #define AO_LISP_COLLECT_INCREMENTAL 0
462 ao_lisp_collect(uint8_t style);
465 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
467 struct ao_lisp_cons *
468 ao_lisp_cons_fetch(int id);
471 ao_lisp_poly_stash(int id, ao_poly poly);
474 ao_lisp_poly_fetch(int id);
477 ao_lisp_string_stash(int id, char *string);
480 ao_lisp_string_fetch(int id);
483 ao_lisp_stack_stash(int id, struct ao_lisp_stack *stack) {
484 ao_lisp_poly_stash(id, ao_lisp_stack_poly(stack));
487 static inline struct ao_lisp_stack *
488 ao_lisp_stack_fetch(int id) {
489 return ao_lisp_poly_stack(ao_lisp_poly_fetch(id));
493 extern const struct ao_lisp_type ao_lisp_cons_type;
495 struct ao_lisp_cons *
496 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
498 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
501 ao_lisp_cons_free(struct ao_lisp_cons *cons);
504 ao_lisp_cons_print(ao_poly);
507 ao_lisp_cons_patom(ao_poly);
510 ao_lisp_cons_length(struct ao_lisp_cons *cons);
513 extern const struct ao_lisp_type ao_lisp_string_type;
516 ao_lisp_string_copy(char *a);
519 ao_lisp_string_cat(char *a, char *b);
522 ao_lisp_string_pack(struct ao_lisp_cons *cons);
525 ao_lisp_string_unpack(char *a);
528 ao_lisp_string_print(ao_poly s);
531 ao_lisp_string_patom(ao_poly s);
534 extern const struct ao_lisp_type ao_lisp_atom_type;
536 extern struct ao_lisp_atom *ao_lisp_atoms;
537 extern struct ao_lisp_frame *ao_lisp_frame_global;
538 extern struct ao_lisp_frame *ao_lisp_frame_current;
541 ao_lisp_atom_print(ao_poly a);
543 struct ao_lisp_atom *
544 ao_lisp_atom_intern(char *name);
547 ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
550 ao_lisp_atom_get(ao_poly atom);
553 ao_lisp_atom_set(ao_poly atom, ao_poly val);
557 ao_lisp_int_print(ao_poly i);
561 ao_lisp_poly_print(ao_poly p);
564 ao_lisp_poly_patom(ao_poly p);
567 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
569 /* returns 1 if the object has already been moved */
571 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
576 ao_lisp_eval_clear_globals(void);
579 ao_lisp_eval_restart(void);
582 ao_lisp_eval(ao_poly p);
585 ao_lisp_set_cond(struct ao_lisp_cons *cons);
589 ao_lisp_builtin_print(ao_poly b);
591 extern const struct ao_lisp_type ao_lisp_builtin_type;
593 /* Check argument count */
595 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
597 /* Check argument type */
599 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
601 /* Fetch an arg (nil if off the end) */
603 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
606 ao_lisp_args_name(uint8_t args);
609 extern struct ao_lisp_cons *ao_lisp_read_cons;
610 extern struct ao_lisp_cons *ao_lisp_read_cons_tail;
611 extern struct ao_lisp_cons *ao_lisp_read_stack;
618 ao_lisp_read_eval_print(void);
621 extern const struct ao_lisp_type ao_lisp_frame_type;
623 #define AO_LISP_FRAME_FREE 4
625 extern struct ao_lisp_frame *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
628 ao_lisp_frame_mark(struct ao_lisp_frame *frame);
631 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
633 struct ao_lisp_frame *
634 ao_lisp_frame_new(int num);
637 ao_lisp_frame_free(struct ao_lisp_frame *frame);
640 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
643 ao_lisp_frame_print(ao_poly p);
646 extern const struct ao_lisp_type ao_lisp_lambda_type;
648 extern const char *ao_lisp_state_names[];
650 struct ao_lisp_lambda *
651 ao_lisp_lambda_new(ao_poly cons);
654 ao_lisp_lambda_print(ao_poly lambda);
657 ao_lisp_lambda(struct ao_lisp_cons *cons);
660 ao_lisp_lexpr(struct ao_lisp_cons *cons);
663 ao_lisp_nlambda(struct ao_lisp_cons *cons);
666 ao_lisp_macro(struct ao_lisp_cons *cons);
669 ao_lisp_lambda_eval(void);
674 ao_lisp_save(struct ao_lisp_cons *cons);
677 ao_lisp_restore(struct ao_lisp_cons *cons);
681 extern const struct ao_lisp_type ao_lisp_stack_type;
682 extern struct ao_lisp_stack *ao_lisp_stack;
683 extern struct ao_lisp_stack *ao_lisp_stack_free_list;
686 ao_lisp_stack_reset(struct ao_lisp_stack *stack);
689 ao_lisp_stack_push(void);
692 ao_lisp_stack_pop(void);
695 ao_lisp_stack_clear(void);
698 ao_lisp_stack_print(ao_poly stack);
701 ao_lisp_stack_eval(void);
704 ao_lisp_call_cc(struct ao_lisp_cons *cons);
709 ao_lisp_error_poly(char *name, ao_poly poly, ao_poly last);
712 ao_lisp_error_frame(int indent, char *name, struct ao_lisp_frame *frame);
715 ao_lisp_error(int error, char *format, ...);
717 /* debugging macros */
721 int ao_lisp_stack_depth;
723 #define DBG_INDENT() do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf(" "); } while(0)
724 #define DBG_IN() (++ao_lisp_stack_depth)
725 #define DBG_OUT() (--ao_lisp_stack_depth)
726 #define DBG_RESET() (ao_lisp_stack_depth = 0)
727 #define DBG(...) printf(__VA_ARGS__)
728 #define DBGI(...) do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
729 #define DBG_CONS(a) ao_lisp_cons_print(ao_lisp_cons_poly(a))
730 #define DBG_POLY(a) ao_lisp_poly_print(a)
731 #define OFFSET(a) ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
732 #define DBG_STACK() ao_lisp_stack_print()
734 ao_lisp_frames_dump(void)
736 struct ao_lisp_stack *s;
737 DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
738 for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
739 DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
742 #define DBG_FRAMES() ao_lisp_frames_dump()
757 #define DBG_MEM_START 1
762 extern int dbg_move_depth;
764 #define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
769 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf (" "); printf(__VA_ARGS__); } } while (0)
770 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
771 #define MDBG_MOVE_IN() (dbg_move_depth++)
772 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
777 #define MDBG_MOVE(...)
778 #define MDBG_MORE(...)
779 #define MDBG_MOVE_IN()
780 #define MDBG_MOVE_OUT()
784 #endif /* _AO_LISP_H_ */