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.
23 #include <ao_lisp_os.h>
25 typedef uint16_t ao_poly;
26 typedef int16_t ao_signed_poly;
30 struct ao_lisp_os_save {
33 uint16_t const_checksum;
34 uint16_t const_checksum_inv;
37 #define AO_LISP_POOL_EXTRA (sizeof(struct ao_lisp_os_save))
38 #define AO_LISP_POOL ((int) (AO_LISP_POOL_TOTAL - AO_LISP_POOL_EXTRA))
41 ao_lisp_os_save(void);
44 ao_lisp_os_restore_save(struct ao_lisp_os_save *save, int offset);
47 ao_lisp_os_restore(void);
51 #ifdef AO_LISP_MAKE_CONST
52 #define AO_LISP_POOL_CONST 16384
53 extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST] __attribute__((aligned(4)));
54 #define ao_lisp_pool ao_lisp_const
55 #define AO_LISP_POOL AO_LISP_POOL_CONST
57 #define _atom(n) ao_lisp_atom_poly(ao_lisp_atom_intern(n))
59 #define _ao_lisp_atom_quote _atom("quote")
60 #define _ao_lisp_atom_set _atom("set")
61 #define _ao_lisp_atom_setq _atom("setq")
62 #define _ao_lisp_atom_t _atom("t")
63 #define _ao_lisp_atom_car _atom("car")
64 #define _ao_lisp_atom_cdr _atom("cdr")
65 #define _ao_lisp_atom_cons _atom("cons")
66 #define _ao_lisp_atom_last _atom("last")
67 #define _ao_lisp_atom_length _atom("length")
68 #define _ao_lisp_atom_cond _atom("cond")
69 #define _ao_lisp_atom_lambda _atom("lambda")
70 #define _ao_lisp_atom_led _atom("led")
71 #define _ao_lisp_atom_delay _atom("delay")
72 #define _ao_lisp_atom_pack _atom("pack")
73 #define _ao_lisp_atom_unpack _atom("unpack")
74 #define _ao_lisp_atom_flush _atom("flush")
75 #define _ao_lisp_atom_eval _atom("eval")
76 #define _ao_lisp_atom_read _atom("read")
77 #define _ao_lisp_atom_eof _atom("eof")
78 #define _ao_lisp_atom_save _atom("save")
79 #define _ao_lisp_atom_restore _atom("restore")
80 #define _ao_lisp_atom_call2fcc _atom("call/cc")
81 #define _ao_lisp_atom_collect _atom("collect")
82 #define _ao_lisp_atom_symbolp _atom("symbol?")
83 #define _ao_lisp_atom_builtin _atom("builtin?")
84 #define _ao_lisp_atom_symbolp _atom("symbol?")
85 #define _ao_lisp_atom_symbolp _atom("symbol?")
87 #include "ao_lisp_const.h"
89 #define AO_LISP_POOL 3072
91 extern uint8_t ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA] __attribute__((aligned(4)));
95 #define AO_LISP_CONS 0
97 #define AO_LISP_STRING 2
98 #define AO_LISP_OTHER 3
100 #define AO_LISP_TYPE_MASK 0x0003
101 #define AO_LISP_TYPE_SHIFT 2
102 #define AO_LISP_REF_MASK 0x7ffc
103 #define AO_LISP_CONST 0x8000
105 /* These have a type value at the start of the struct */
106 #define AO_LISP_ATOM 4
107 #define AO_LISP_BUILTIN 5
108 #define AO_LISP_FRAME 6
109 #define AO_LISP_LAMBDA 7
110 #define AO_LISP_STACK 8
111 #define AO_LISP_NUM_TYPE 9
113 /* Leave two bits for types to use as they please */
114 #define AO_LISP_OTHER_TYPE_MASK 0x3f
116 #define AO_LISP_NIL 0
118 extern uint16_t ao_lisp_top;
120 #define AO_LISP_OOM 0x01
121 #define AO_LISP_DIVIDE_BY_ZERO 0x02
122 #define AO_LISP_INVALID 0x04
123 #define AO_LISP_UNDEFINED 0x08
124 #define AO_LISP_EOF 0x10
126 extern uint8_t ao_lisp_exception;
129 ao_lisp_is_const(ao_poly poly) {
130 return poly & AO_LISP_CONST;
133 #define AO_LISP_IS_CONST(a) (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
134 #define AO_LISP_IS_POOL(a) (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
135 #define AO_LISP_IS_INT(p) (ao_lisp_base_type(p) == AO_LISP_INT);
138 ao_lisp_ref(ao_poly poly);
141 ao_lisp_poly(const void *addr, ao_poly type);
143 struct ao_lisp_type {
144 int (*size)(void *addr);
145 void (*mark)(void *addr);
146 void (*move)(void *addr);
150 struct ao_lisp_cons {
155 struct ao_lisp_atom {
167 struct ao_lisp_frame {
171 struct ao_lisp_val vals[];
174 /* Set on type when the frame escapes the lambda */
175 #define AO_LISP_FRAME_MARK 0x80
176 #define AO_LISP_FRAME_PRINT 0x40
178 static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
179 return f->type & AO_LISP_FRAME_MARK;
182 static inline struct ao_lisp_frame *
183 ao_lisp_poly_frame(ao_poly poly) {
184 return ao_lisp_ref(poly);
187 static inline ao_poly
188 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
189 return ao_lisp_poly(frame, AO_LISP_OTHER);
193 eval_sexpr, /* Evaluate an sexpr */
194 eval_val, /* Value computed */
195 eval_formal, /* Formal computed */
196 eval_exec, /* Start a lambda evaluation */
197 eval_cond, /* Start next cond clause */
198 eval_cond_test, /* Check cond condition */
199 eval_progn, /* Start next progn entry */
200 eval_while, /* Start while condition */
201 eval_while_test, /* Check while condition */
202 eval_macro, /* Finished with macro generation */
205 struct ao_lisp_stack {
206 uint8_t type; /* AO_LISP_STACK */
207 uint8_t state; /* enum eval_state */
208 ao_poly prev; /* previous stack frame */
209 ao_poly sexprs; /* expressions to evaluate */
210 ao_poly values; /* values computed */
211 ao_poly values_tail; /* end of the values list for easy appending */
212 ao_poly frame; /* current lookup frame */
213 ao_poly list; /* most recent function call */
216 #define AO_LISP_STACK_MARK 0x80 /* set on type when a reference has been taken */
217 #define AO_LISP_STACK_PRINT 0x40 /* stack is being printed */
219 static inline int ao_lisp_stack_marked(struct ao_lisp_stack *s) {
220 return s->type & AO_LISP_STACK_MARK;
223 static inline void ao_lisp_stack_mark(struct ao_lisp_stack *s) {
224 s->type |= AO_LISP_STACK_MARK;
227 static inline struct ao_lisp_stack *
228 ao_lisp_poly_stack(ao_poly p)
230 return ao_lisp_ref(p);
233 static inline ao_poly
234 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
236 return ao_lisp_poly(stack, AO_LISP_OTHER);
239 extern ao_poly ao_lisp_v;
241 #define AO_LISP_FUNC_LAMBDA 0
242 #define AO_LISP_FUNC_NLAMBDA 1
243 #define AO_LISP_FUNC_MACRO 2
244 #define AO_LISP_FUNC_LEXPR 3
246 #define AO_LISP_FUNC_FREE_ARGS 0x80
247 #define AO_LISP_FUNC_MASK 0x7f
249 #define AO_LISP_FUNC_F_LAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
250 #define AO_LISP_FUNC_F_NLAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
251 #define AO_LISP_FUNC_F_MACRO (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
252 #define AO_LISP_FUNC_F_LEXPR (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
254 struct ao_lisp_builtin {
260 enum ao_lisp_builtin_id {
289 builtin_greater_equal,
302 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
304 extern const ao_lisp_func_t ao_lisp_builtins[];
306 static inline ao_lisp_func_t
307 ao_lisp_func(struct ao_lisp_builtin *b)
309 return ao_lisp_builtins[b->func];
312 struct ao_lisp_lambda {
319 static inline struct ao_lisp_lambda *
320 ao_lisp_poly_lambda(ao_poly poly)
322 return ao_lisp_ref(poly);
325 static inline ao_poly
326 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
328 return ao_lisp_poly(lambda, AO_LISP_OTHER);
332 ao_lisp_poly_other(ao_poly poly) {
333 return ao_lisp_ref(poly);
336 static inline uint8_t
337 ao_lisp_other_type(void *other) {
339 if ((*((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK) >= AO_LISP_NUM_TYPE)
342 return *((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK;
345 static inline ao_poly
346 ao_lisp_other_poly(const void *other)
348 return ao_lisp_poly(other, AO_LISP_OTHER);
352 ao_lisp_size_round(int size)
354 return (size + 3) & ~3;
358 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
360 return ao_lisp_size_round(type->size(addr));
363 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
365 static inline int ao_lisp_poly_base_type(ao_poly poly) {
366 return poly & AO_LISP_TYPE_MASK;
369 static inline int ao_lisp_poly_type(ao_poly poly) {
370 int type = poly & AO_LISP_TYPE_MASK;
371 if (type == AO_LISP_OTHER)
372 return ao_lisp_other_type(ao_lisp_poly_other(poly));
376 static inline struct ao_lisp_cons *
377 ao_lisp_poly_cons(ao_poly poly)
379 return ao_lisp_ref(poly);
382 static inline ao_poly
383 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
385 return ao_lisp_poly(cons, AO_LISP_CONS);
389 ao_lisp_poly_int(ao_poly poly)
391 return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
394 static inline ao_poly
395 ao_lisp_int_poly(int i)
397 return ((ao_poly) i << 2) | AO_LISP_INT;
401 ao_lisp_poly_string(ao_poly poly)
403 return ao_lisp_ref(poly);
406 static inline ao_poly
407 ao_lisp_string_poly(char *s)
409 return ao_lisp_poly(s, AO_LISP_STRING);
412 static inline struct ao_lisp_atom *
413 ao_lisp_poly_atom(ao_poly poly)
415 return ao_lisp_ref(poly);
418 static inline ao_poly
419 ao_lisp_atom_poly(struct ao_lisp_atom *a)
421 return ao_lisp_poly(a, AO_LISP_OTHER);
424 static inline struct ao_lisp_builtin *
425 ao_lisp_poly_builtin(ao_poly poly)
427 return ao_lisp_ref(poly);
430 static inline ao_poly
431 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
433 return ao_lisp_poly(b, AO_LISP_OTHER);
436 /* memory functions */
438 extern int ao_lisp_collects[2];
439 extern int ao_lisp_freed[2];
440 extern int ao_lisp_loops[2];
442 /* returns 1 if the object was already marked */
444 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
446 /* returns 1 if the object was already marked */
448 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
451 ao_lisp_move_map(void *addr);
453 /* returns 1 if the object was already moved */
455 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
457 /* returns 1 if the object was already moved */
459 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
462 ao_lisp_alloc(int size);
464 #define AO_LISP_COLLECT_FULL 1
465 #define AO_LISP_COLLECT_INCREMENTAL 0
468 ao_lisp_collect(uint8_t style);
471 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
473 struct ao_lisp_cons *
474 ao_lisp_cons_fetch(int id);
477 ao_lisp_poly_stash(int id, ao_poly poly);
480 ao_lisp_poly_fetch(int id);
483 ao_lisp_string_stash(int id, char *string);
486 ao_lisp_string_fetch(int id);
489 ao_lisp_stack_stash(int id, struct ao_lisp_stack *stack) {
490 ao_lisp_poly_stash(id, ao_lisp_stack_poly(stack));
493 static inline struct ao_lisp_stack *
494 ao_lisp_stack_fetch(int id) {
495 return ao_lisp_poly_stack(ao_lisp_poly_fetch(id));
499 extern const struct ao_lisp_type ao_lisp_cons_type;
501 struct ao_lisp_cons *
502 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
504 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
507 ao_lisp_cons_free(struct ao_lisp_cons *cons);
510 ao_lisp_cons_print(ao_poly);
513 ao_lisp_cons_patom(ao_poly);
516 ao_lisp_cons_length(struct ao_lisp_cons *cons);
519 extern const struct ao_lisp_type ao_lisp_string_type;
522 ao_lisp_string_copy(char *a);
525 ao_lisp_string_cat(char *a, char *b);
528 ao_lisp_string_pack(struct ao_lisp_cons *cons);
531 ao_lisp_string_unpack(char *a);
534 ao_lisp_string_print(ao_poly s);
537 ao_lisp_string_patom(ao_poly s);
540 extern const struct ao_lisp_type ao_lisp_atom_type;
542 extern struct ao_lisp_atom *ao_lisp_atoms;
543 extern struct ao_lisp_frame *ao_lisp_frame_global;
544 extern struct ao_lisp_frame *ao_lisp_frame_current;
547 ao_lisp_atom_print(ao_poly a);
549 struct ao_lisp_atom *
550 ao_lisp_atom_intern(char *name);
553 ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
556 ao_lisp_atom_get(ao_poly atom);
559 ao_lisp_atom_set(ao_poly atom, ao_poly val);
563 ao_lisp_int_print(ao_poly i);
567 ao_lisp_poly_print(ao_poly p);
570 ao_lisp_poly_patom(ao_poly p);
573 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
575 /* returns 1 if the object has already been moved */
577 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
582 ao_lisp_eval_clear_globals(void);
585 ao_lisp_eval_restart(void);
588 ao_lisp_eval(ao_poly p);
591 ao_lisp_set_cond(struct ao_lisp_cons *cons);
595 ao_lisp_builtin_print(ao_poly b);
597 extern const struct ao_lisp_type ao_lisp_builtin_type;
599 /* Check argument count */
601 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
603 /* Check argument type */
605 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
607 /* Fetch an arg (nil if off the end) */
609 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
612 ao_lisp_args_name(uint8_t args);
615 extern struct ao_lisp_cons *ao_lisp_read_cons;
616 extern struct ao_lisp_cons *ao_lisp_read_cons_tail;
617 extern struct ao_lisp_cons *ao_lisp_read_stack;
624 ao_lisp_read_eval_print(void);
627 extern const struct ao_lisp_type ao_lisp_frame_type;
629 #define AO_LISP_FRAME_FREE 6
631 extern struct ao_lisp_frame *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
634 ao_lisp_frame_mark(struct ao_lisp_frame *frame);
637 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
639 struct ao_lisp_frame *
640 ao_lisp_frame_new(int num);
643 ao_lisp_frame_free(struct ao_lisp_frame *frame);
646 ao_lisp_frame_bind(struct ao_lisp_frame *frame, int num, ao_poly atom, ao_poly val);
649 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
652 ao_lisp_frame_print(ao_poly p);
655 extern const struct ao_lisp_type ao_lisp_lambda_type;
657 extern const char *ao_lisp_state_names[];
659 struct ao_lisp_lambda *
660 ao_lisp_lambda_new(ao_poly cons);
663 ao_lisp_lambda_print(ao_poly lambda);
666 ao_lisp_lambda(struct ao_lisp_cons *cons);
669 ao_lisp_lexpr(struct ao_lisp_cons *cons);
672 ao_lisp_nlambda(struct ao_lisp_cons *cons);
675 ao_lisp_macro(struct ao_lisp_cons *cons);
678 ao_lisp_lambda_eval(void);
683 ao_lisp_save(struct ao_lisp_cons *cons);
686 ao_lisp_restore(struct ao_lisp_cons *cons);
690 extern const struct ao_lisp_type ao_lisp_stack_type;
691 extern struct ao_lisp_stack *ao_lisp_stack;
692 extern struct ao_lisp_stack *ao_lisp_stack_free_list;
695 ao_lisp_stack_reset(struct ao_lisp_stack *stack);
698 ao_lisp_stack_push(void);
701 ao_lisp_stack_pop(void);
704 ao_lisp_stack_clear(void);
707 ao_lisp_stack_print(ao_poly stack);
710 ao_lisp_stack_eval(void);
713 ao_lisp_call_cc(struct ao_lisp_cons *cons);
718 ao_lisp_error_poly(char *name, ao_poly poly, ao_poly last);
721 ao_lisp_error_frame(int indent, char *name, struct ao_lisp_frame *frame);
724 ao_lisp_error(int error, char *format, ...);
726 /* debugging macros */
730 int ao_lisp_stack_depth;
732 #define DBG_INDENT() do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf(" "); } while(0)
733 #define DBG_IN() (++ao_lisp_stack_depth)
734 #define DBG_OUT() (--ao_lisp_stack_depth)
735 #define DBG_RESET() (ao_lisp_stack_depth = 0)
736 #define DBG(...) printf(__VA_ARGS__)
737 #define DBGI(...) do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
738 #define DBG_CONS(a) ao_lisp_cons_print(ao_lisp_cons_poly(a))
739 #define DBG_POLY(a) ao_lisp_poly_print(a)
740 #define OFFSET(a) ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
741 #define DBG_STACK() ao_lisp_stack_print(ao_lisp_stack_poly(ao_lisp_stack))
743 ao_lisp_frames_dump(void)
745 struct ao_lisp_stack *s;
746 DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
747 for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
748 DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
751 #define DBG_FRAMES() ao_lisp_frames_dump()
766 #define DBG_MEM_START 1
771 extern int dbg_move_depth;
773 #define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
778 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf (" "); printf(__VA_ARGS__); } } while (0)
779 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
780 #define MDBG_MOVE_IN() (dbg_move_depth++)
781 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
786 #define MDBG_MOVE(...)
787 #define MDBG_MORE(...)
788 #define MDBG_MOVE_IN()
789 #define MDBG_MOVE_OUT()
793 #endif /* _AO_LISP_H_ */