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")
78 #define _ao_lisp_atom_call2fcc _atom("call/cc")
80 #include "ao_lisp_const.h"
82 #define AO_LISP_POOL 3072
84 extern uint8_t ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA];
88 #define AO_LISP_CONS 0
90 #define AO_LISP_STRING 2
91 #define AO_LISP_OTHER 3
93 #define AO_LISP_TYPE_MASK 0x0003
94 #define AO_LISP_TYPE_SHIFT 2
95 #define AO_LISP_REF_MASK 0x7ffc
96 #define AO_LISP_CONST 0x8000
98 /* These have a type value at the start of the struct */
99 #define AO_LISP_ATOM 4
100 #define AO_LISP_BUILTIN 5
101 #define AO_LISP_FRAME 6
102 #define AO_LISP_LAMBDA 7
103 #define AO_LISP_STACK 8
104 #define AO_LISP_NUM_TYPE 9
106 /* Leave two bits for types to use as they please */
107 #define AO_LISP_OTHER_TYPE_MASK 0x3f
109 #define AO_LISP_NIL 0
111 extern uint16_t ao_lisp_top;
113 #define AO_LISP_OOM 0x01
114 #define AO_LISP_DIVIDE_BY_ZERO 0x02
115 #define AO_LISP_INVALID 0x04
116 #define AO_LISP_UNDEFINED 0x08
117 #define AO_LISP_EOF 0x10
119 extern uint8_t ao_lisp_exception;
122 ao_lisp_is_const(ao_poly poly) {
123 return poly & AO_LISP_CONST;
126 #define AO_LISP_IS_CONST(a) (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
127 #define AO_LISP_IS_POOL(a) (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
130 ao_lisp_ref(ao_poly poly);
133 ao_lisp_poly(const void *addr, ao_poly type);
135 struct ao_lisp_type {
136 int (*size)(void *addr);
137 void (*mark)(void *addr);
138 void (*move)(void *addr);
142 struct ao_lisp_cons {
147 struct ao_lisp_atom {
159 struct ao_lisp_frame {
163 struct ao_lisp_val vals[];
166 /* Set on type when the frame escapes the lambda */
167 #define AO_LISP_FRAME_MARK 0x80
168 #define AO_LISP_FRAME_PRINT 0x40
170 static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
171 return f->type & AO_LISP_FRAME_MARK;
174 static inline struct ao_lisp_frame *
175 ao_lisp_poly_frame(ao_poly poly) {
176 return ao_lisp_ref(poly);
179 static inline ao_poly
180 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
181 return ao_lisp_poly(frame, AO_LISP_OTHER);
185 eval_sexpr, /* Evaluate an sexpr */
186 eval_val, /* Value computed */
187 eval_formal, /* Formal computed */
188 eval_exec, /* Start a lambda evaluation */
189 eval_cond, /* Start next cond clause */
190 eval_cond_test, /* Check cond condition */
191 eval_progn, /* Start next progn entry */
192 eval_while, /* Start while condition */
193 eval_while_test, /* Check while condition */
194 eval_macro, /* Finished with macro generation */
197 struct ao_lisp_stack {
198 uint8_t type; /* AO_LISP_STACK */
199 uint8_t state; /* enum eval_state */
200 ao_poly prev; /* previous stack frame */
201 ao_poly sexprs; /* expressions to evaluate */
202 ao_poly values; /* values computed */
203 ao_poly values_tail; /* end of the values list for easy appending */
204 ao_poly frame; /* current lookup frame */
205 ao_poly list; /* most recent function call */
208 #define AO_LISP_STACK_MARK 0x80 /* set on type when a reference has been taken */
209 #define AO_LISP_STACK_PRINT 0x40 /* stack is being printed */
211 static inline int ao_lisp_stack_marked(struct ao_lisp_stack *s) {
212 return s->type & AO_LISP_STACK_MARK;
215 static inline void ao_lisp_stack_mark(struct ao_lisp_stack *s) {
216 s->type |= AO_LISP_STACK_MARK;
219 static inline struct ao_lisp_stack *
220 ao_lisp_poly_stack(ao_poly p)
222 return ao_lisp_ref(p);
225 static inline ao_poly
226 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
228 return ao_lisp_poly(stack, AO_LISP_OTHER);
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,
293 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
295 extern const ao_lisp_func_t ao_lisp_builtins[];
297 static inline ao_lisp_func_t
298 ao_lisp_func(struct ao_lisp_builtin *b)
300 return ao_lisp_builtins[b->func];
303 struct ao_lisp_lambda {
310 static inline struct ao_lisp_lambda *
311 ao_lisp_poly_lambda(ao_poly poly)
313 return ao_lisp_ref(poly);
316 static inline ao_poly
317 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
319 return ao_lisp_poly(lambda, AO_LISP_OTHER);
323 ao_lisp_poly_other(ao_poly poly) {
324 return ao_lisp_ref(poly);
327 static inline uint8_t
328 ao_lisp_other_type(void *other) {
329 return *((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK;
332 static inline ao_poly
333 ao_lisp_other_poly(const void *other)
335 return ao_lisp_poly(other, AO_LISP_OTHER);
339 ao_lisp_size_round(int size)
341 return (size + 3) & ~3;
345 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
347 return ao_lisp_size_round(type->size(addr));
350 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
352 static inline int ao_lisp_poly_base_type(ao_poly poly) {
353 return poly & AO_LISP_TYPE_MASK;
356 static inline int ao_lisp_poly_type(ao_poly poly) {
357 int type = poly & AO_LISP_TYPE_MASK;
358 if (type == AO_LISP_OTHER)
359 return ao_lisp_other_type(ao_lisp_poly_other(poly));
363 static inline struct ao_lisp_cons *
364 ao_lisp_poly_cons(ao_poly poly)
366 return ao_lisp_ref(poly);
369 static inline ao_poly
370 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
372 return ao_lisp_poly(cons, AO_LISP_CONS);
376 ao_lisp_poly_int(ao_poly poly)
378 return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
381 static inline ao_poly
382 ao_lisp_int_poly(int i)
384 return ((ao_poly) i << 2) | AO_LISP_INT;
388 ao_lisp_poly_string(ao_poly poly)
390 return ao_lisp_ref(poly);
393 static inline ao_poly
394 ao_lisp_string_poly(char *s)
396 return ao_lisp_poly(s, AO_LISP_STRING);
399 static inline struct ao_lisp_atom *
400 ao_lisp_poly_atom(ao_poly poly)
402 return ao_lisp_ref(poly);
405 static inline ao_poly
406 ao_lisp_atom_poly(struct ao_lisp_atom *a)
408 return ao_lisp_poly(a, AO_LISP_OTHER);
411 static inline struct ao_lisp_builtin *
412 ao_lisp_poly_builtin(ao_poly poly)
414 return ao_lisp_ref(poly);
417 static inline ao_poly
418 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
420 return ao_lisp_poly(b, AO_LISP_OTHER);
423 /* memory functions */
425 extern int ao_lisp_collects[2];
426 extern int ao_lisp_freed[2];
427 extern int ao_lisp_loops[2];
429 /* returns 1 if the object was already marked */
431 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
433 /* returns 1 if the object was already marked */
435 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
438 ao_lisp_move_map(void *addr);
440 /* returns 1 if the object was already moved */
442 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
444 /* returns 1 if the object was already moved */
446 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
449 ao_lisp_alloc(int size);
451 #define AO_LISP_COLLECT_FULL 1
452 #define AO_LISP_COLLECT_INCREMENTAL 0
455 ao_lisp_collect(uint8_t style);
458 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
460 struct ao_lisp_cons *
461 ao_lisp_cons_fetch(int id);
464 ao_lisp_string_stash(int id, char *string);
467 ao_lisp_string_fetch(int id);
470 ao_lisp_stack_stash(int id, struct ao_lisp_stack *stack);
472 struct ao_lisp_stack *
473 ao_lisp_stack_fetch(int id);
476 ao_lisp_poly_stash(int id, ao_poly poly);
479 ao_lisp_poly_fetch(int id);
482 extern const struct ao_lisp_type ao_lisp_cons_type;
484 struct ao_lisp_cons *
485 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
487 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
490 ao_lisp_cons_free(struct ao_lisp_cons *cons);
493 ao_lisp_cons_print(ao_poly);
496 ao_lisp_cons_patom(ao_poly);
499 ao_lisp_cons_length(struct ao_lisp_cons *cons);
502 extern const struct ao_lisp_type ao_lisp_string_type;
505 ao_lisp_string_copy(char *a);
508 ao_lisp_string_cat(char *a, char *b);
511 ao_lisp_string_pack(struct ao_lisp_cons *cons);
514 ao_lisp_string_unpack(char *a);
517 ao_lisp_string_print(ao_poly s);
520 ao_lisp_string_patom(ao_poly s);
523 extern const struct ao_lisp_type ao_lisp_atom_type;
525 extern struct ao_lisp_atom *ao_lisp_atoms;
526 extern struct ao_lisp_frame *ao_lisp_frame_global;
527 extern struct ao_lisp_frame *ao_lisp_frame_current;
530 ao_lisp_atom_print(ao_poly a);
532 struct ao_lisp_atom *
533 ao_lisp_atom_intern(char *name);
536 ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
539 ao_lisp_atom_get(ao_poly atom);
542 ao_lisp_atom_set(ao_poly atom, ao_poly val);
546 ao_lisp_int_print(ao_poly i);
550 ao_lisp_poly_print(ao_poly p);
553 ao_lisp_poly_patom(ao_poly p);
556 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
558 /* returns 1 if the object has already been moved */
560 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
565 ao_lisp_eval_clear_globals(void);
568 ao_lisp_eval_restart(void);
571 ao_lisp_eval(ao_poly p);
574 ao_lisp_set_cond(struct ao_lisp_cons *cons);
578 ao_lisp_builtin_print(ao_poly b);
580 extern const struct ao_lisp_type ao_lisp_builtin_type;
582 /* Check argument count */
584 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
586 /* Check argument type */
588 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
590 /* Fetch an arg (nil if off the end) */
592 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
595 ao_lisp_args_name(uint8_t args);
598 extern struct ao_lisp_cons *ao_lisp_read_cons;
599 extern struct ao_lisp_cons *ao_lisp_read_cons_tail;
600 extern struct ao_lisp_cons *ao_lisp_read_stack;
607 ao_lisp_read_eval_print(void);
610 extern const struct ao_lisp_type ao_lisp_frame_type;
612 #define AO_LISP_FRAME_FREE 4
614 extern struct ao_lisp_frame *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
617 ao_lisp_frame_mark(struct ao_lisp_frame *frame);
620 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
622 struct ao_lisp_frame *
623 ao_lisp_frame_new(int num);
626 ao_lisp_frame_free(struct ao_lisp_frame *frame);
629 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
632 ao_lisp_frame_print(ao_poly p);
635 extern const struct ao_lisp_type ao_lisp_lambda_type;
637 extern const char *ao_lisp_state_names[];
639 struct ao_lisp_lambda *
640 ao_lisp_lambda_new(ao_poly cons);
643 ao_lisp_lambda_print(ao_poly lambda);
646 ao_lisp_lambda(struct ao_lisp_cons *cons);
649 ao_lisp_lexpr(struct ao_lisp_cons *cons);
652 ao_lisp_nlambda(struct ao_lisp_cons *cons);
655 ao_lisp_macro(struct ao_lisp_cons *cons);
658 ao_lisp_lambda_eval(void);
663 ao_lisp_save(struct ao_lisp_cons *cons);
666 ao_lisp_restore(struct ao_lisp_cons *cons);
670 extern const struct ao_lisp_type ao_lisp_stack_type;
671 extern struct ao_lisp_stack *ao_lisp_stack;
672 extern struct ao_lisp_stack *ao_lisp_stack_free_list;
675 ao_lisp_stack_reset(struct ao_lisp_stack *stack);
678 ao_lisp_stack_push(void);
681 ao_lisp_stack_pop(void);
684 ao_lisp_stack_clear(void);
687 ao_lisp_stack_print(ao_poly stack);
690 ao_lisp_stack_eval(void);
693 ao_lisp_call_cc(struct ao_lisp_cons *cons);
698 ao_lisp_error_poly(char *name, ao_poly poly, ao_poly last);
701 ao_lisp_error_frame(int indent, char *name, struct ao_lisp_frame *frame);
704 ao_lisp_error(int error, char *format, ...);
706 /* debugging macros */
710 int ao_lisp_stack_depth;
712 #define DBG_INDENT() do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf(" "); } while(0)
713 #define DBG_IN() (++ao_lisp_stack_depth)
714 #define DBG_OUT() (--ao_lisp_stack_depth)
715 #define DBG_RESET() (ao_lisp_stack_depth = 0)
716 #define DBG(...) printf(__VA_ARGS__)
717 #define DBGI(...) do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
718 #define DBG_CONS(a) ao_lisp_cons_print(ao_lisp_cons_poly(a))
719 #define DBG_POLY(a) ao_lisp_poly_print(a)
720 #define OFFSET(a) ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
721 #define DBG_STACK() ao_lisp_stack_print()
723 ao_lisp_frames_dump(void)
725 struct ao_lisp_stack *s;
726 DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
727 for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
728 DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
731 #define DBG_FRAMES() ao_lisp_frames_dump()
747 #define DBG_MEM_START 1
752 extern int dbg_move_depth;
754 #define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
759 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf (" "); printf(__VA_ARGS__); } } while (0)
760 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
761 #define MDBG_MOVE_IN() (dbg_move_depth++)
762 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
767 #define MDBG_MOVE(...)
768 #define MDBG_MORE(...)
769 #define MDBG_MOVE_IN()
770 #define MDBG_MOVE_OUT()
774 #endif /* _AO_LISP_H_ */