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))
58 #define _bool(v) ao_lisp_bool_poly(ao_lisp_bool_get(v))
60 #define _ao_lisp_bool_true _bool(1)
61 #define _ao_lisp_bool_false _bool(0)
62 #define _ao_lisp_atom_quote _atom(quote)
63 #define _ao_lisp_atom_set _atom(set)
64 #define _ao_lisp_atom_setq _atom(setq)
65 #define _ao_lisp_atom_car _atom(car)
66 #define _ao_lisp_atom_cdr _atom(cdr)
67 #define _ao_lisp_atom_cons _atom(cons)
68 #define _ao_lisp_atom_last _atom(last)
69 #define _ao_lisp_atom_length _atom(length)
70 #define _ao_lisp_atom_cond _atom(cond)
71 #define _ao_lisp_atom_lambda _atom(lambda)
72 #define _ao_lisp_atom_led _atom(led)
73 #define _ao_lisp_atom_delay _atom(delay)
74 #define _ao_lisp_atom_pack _atom(pack)
75 #define _ao_lisp_atom_unpack _atom(unpack)
76 #define _ao_lisp_atom_flush _atom(flush)
77 #define _ao_lisp_atom_eval _atom(eval)
78 #define _ao_lisp_atom_read _atom(read)
79 #define _ao_lisp_atom_eof _atom(eof)
80 #define _ao_lisp_atom_save _atom(save)
81 #define _ao_lisp_atom_restore _atom(restore)
82 #define _ao_lisp_atom_call2fcc _atom(call/cc)
83 #define _ao_lisp_atom_collect _atom(collect)
84 #define _ao_lisp_atom_symbolp _atom(symbol?)
85 #define _ao_lisp_atom_builtin _atom(builtin?)
86 #define _ao_lisp_atom_symbolp _atom(symbol?)
87 #define _ao_lisp_atom_symbolp _atom(symbol?)
89 #include "ao_lisp_const.h"
91 #define AO_LISP_POOL 3072
93 extern uint8_t ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA] __attribute__((aligned(4)));
97 #define AO_LISP_CONS 0
99 #define AO_LISP_STRING 2
100 #define AO_LISP_OTHER 3
102 #define AO_LISP_TYPE_MASK 0x0003
103 #define AO_LISP_TYPE_SHIFT 2
104 #define AO_LISP_REF_MASK 0x7ffc
105 #define AO_LISP_CONST 0x8000
107 /* These have a type value at the start of the struct */
108 #define AO_LISP_ATOM 4
109 #define AO_LISP_BUILTIN 5
110 #define AO_LISP_FRAME 6
111 #define AO_LISP_LAMBDA 7
112 #define AO_LISP_STACK 8
113 #define AO_LISP_BOOL 9
114 #define AO_LISP_NUM_TYPE 10
116 /* Leave two bits for types to use as they please */
117 #define AO_LISP_OTHER_TYPE_MASK 0x3f
119 #define AO_LISP_NIL 0
121 extern uint16_t ao_lisp_top;
123 #define AO_LISP_OOM 0x01
124 #define AO_LISP_DIVIDE_BY_ZERO 0x02
125 #define AO_LISP_INVALID 0x04
126 #define AO_LISP_UNDEFINED 0x08
127 #define AO_LISP_EOF 0x10
129 extern uint8_t ao_lisp_exception;
132 ao_lisp_is_const(ao_poly poly) {
133 return poly & AO_LISP_CONST;
136 #define AO_LISP_IS_CONST(a) (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
137 #define AO_LISP_IS_POOL(a) (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
138 #define AO_LISP_IS_INT(p) (ao_lisp_base_type(p) == AO_LISP_INT);
141 ao_lisp_ref(ao_poly poly);
144 ao_lisp_poly(const void *addr, ao_poly type);
146 struct ao_lisp_type {
147 int (*size)(void *addr);
148 void (*mark)(void *addr);
149 void (*move)(void *addr);
153 struct ao_lisp_cons {
158 struct ao_lisp_atom {
170 struct ao_lisp_frame {
174 struct ao_lisp_val vals[];
177 struct ao_lisp_bool {
183 /* Set on type when the frame escapes the lambda */
184 #define AO_LISP_FRAME_MARK 0x80
185 #define AO_LISP_FRAME_PRINT 0x40
187 static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
188 return f->type & AO_LISP_FRAME_MARK;
191 static inline struct ao_lisp_frame *
192 ao_lisp_poly_frame(ao_poly poly) {
193 return ao_lisp_ref(poly);
196 static inline ao_poly
197 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
198 return ao_lisp_poly(frame, AO_LISP_OTHER);
202 eval_sexpr, /* Evaluate an sexpr */
203 eval_val, /* Value computed */
204 eval_formal, /* Formal computed */
205 eval_exec, /* Start a lambda evaluation */
206 eval_cond, /* Start next cond clause */
207 eval_cond_test, /* Check cond condition */
208 eval_progn, /* Start next progn entry */
209 eval_while, /* Start while condition */
210 eval_while_test, /* Check while condition */
211 eval_macro, /* Finished with macro generation */
214 struct ao_lisp_stack {
215 uint8_t type; /* AO_LISP_STACK */
216 uint8_t state; /* enum eval_state */
217 ao_poly prev; /* previous stack frame */
218 ao_poly sexprs; /* expressions to evaluate */
219 ao_poly values; /* values computed */
220 ao_poly values_tail; /* end of the values list for easy appending */
221 ao_poly frame; /* current lookup frame */
222 ao_poly list; /* most recent function call */
225 #define AO_LISP_STACK_MARK 0x80 /* set on type when a reference has been taken */
226 #define AO_LISP_STACK_PRINT 0x40 /* stack is being printed */
228 static inline int ao_lisp_stack_marked(struct ao_lisp_stack *s) {
229 return s->type & AO_LISP_STACK_MARK;
232 static inline void ao_lisp_stack_mark(struct ao_lisp_stack *s) {
233 s->type |= AO_LISP_STACK_MARK;
236 static inline struct ao_lisp_stack *
237 ao_lisp_poly_stack(ao_poly p)
239 return ao_lisp_ref(p);
242 static inline ao_poly
243 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
245 return ao_lisp_poly(stack, AO_LISP_OTHER);
248 extern ao_poly ao_lisp_v;
250 #define AO_LISP_FUNC_LAMBDA 0
251 #define AO_LISP_FUNC_NLAMBDA 1
252 #define AO_LISP_FUNC_MACRO 2
253 #define AO_LISP_FUNC_LEXPR 3
255 #define AO_LISP_FUNC_FREE_ARGS 0x80
256 #define AO_LISP_FUNC_MASK 0x7f
258 #define AO_LISP_FUNC_F_LAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
259 #define AO_LISP_FUNC_F_NLAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
260 #define AO_LISP_FUNC_F_MACRO (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
261 #define AO_LISP_FUNC_F_LEXPR (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
263 struct ao_lisp_builtin {
269 #define AO_LISP_BUILTIN_ID
270 #include "ao_lisp_builtin.h"
272 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
274 extern const ao_lisp_func_t ao_lisp_builtins[];
276 static inline ao_lisp_func_t
277 ao_lisp_func(struct ao_lisp_builtin *b)
279 return ao_lisp_builtins[b->func];
282 struct ao_lisp_lambda {
289 static inline struct ao_lisp_lambda *
290 ao_lisp_poly_lambda(ao_poly poly)
292 return ao_lisp_ref(poly);
295 static inline ao_poly
296 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
298 return ao_lisp_poly(lambda, AO_LISP_OTHER);
302 ao_lisp_poly_other(ao_poly poly) {
303 return ao_lisp_ref(poly);
306 static inline uint8_t
307 ao_lisp_other_type(void *other) {
309 if ((*((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK) >= AO_LISP_NUM_TYPE)
312 return *((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK;
315 static inline ao_poly
316 ao_lisp_other_poly(const void *other)
318 return ao_lisp_poly(other, AO_LISP_OTHER);
322 ao_lisp_size_round(int size)
324 return (size + 3) & ~3;
328 ao_lisp_size(const struct ao_lisp_type *type, void *addr)
330 return ao_lisp_size_round(type->size(addr));
333 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
335 static inline int ao_lisp_poly_base_type(ao_poly poly) {
336 return poly & AO_LISP_TYPE_MASK;
339 static inline int ao_lisp_poly_type(ao_poly poly) {
340 int type = poly & AO_LISP_TYPE_MASK;
341 if (type == AO_LISP_OTHER)
342 return ao_lisp_other_type(ao_lisp_poly_other(poly));
346 static inline struct ao_lisp_cons *
347 ao_lisp_poly_cons(ao_poly poly)
349 return ao_lisp_ref(poly);
352 static inline ao_poly
353 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
355 return ao_lisp_poly(cons, AO_LISP_CONS);
359 ao_lisp_poly_int(ao_poly poly)
361 return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
364 static inline ao_poly
365 ao_lisp_int_poly(int i)
367 return ((ao_poly) i << 2) | AO_LISP_INT;
371 ao_lisp_poly_string(ao_poly poly)
373 return ao_lisp_ref(poly);
376 static inline ao_poly
377 ao_lisp_string_poly(char *s)
379 return ao_lisp_poly(s, AO_LISP_STRING);
382 static inline struct ao_lisp_atom *
383 ao_lisp_poly_atom(ao_poly poly)
385 return ao_lisp_ref(poly);
388 static inline ao_poly
389 ao_lisp_atom_poly(struct ao_lisp_atom *a)
391 return ao_lisp_poly(a, AO_LISP_OTHER);
394 static inline struct ao_lisp_builtin *
395 ao_lisp_poly_builtin(ao_poly poly)
397 return ao_lisp_ref(poly);
400 static inline ao_poly
401 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
403 return ao_lisp_poly(b, AO_LISP_OTHER);
406 static inline ao_poly
407 ao_lisp_bool_poly(struct ao_lisp_bool *b)
409 return ao_lisp_poly(b, AO_LISP_OTHER);
412 static inline struct ao_lisp_bool *
413 ao_lisp_poly_bool(ao_poly poly)
415 return ao_lisp_ref(poly);
417 /* memory functions */
419 extern int ao_lisp_collects[2];
420 extern int ao_lisp_freed[2];
421 extern int ao_lisp_loops[2];
423 /* returns 1 if the object was already marked */
425 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
427 /* returns 1 if the object was already marked */
429 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
432 ao_lisp_move_map(void *addr);
434 /* returns 1 if the object was already moved */
436 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
438 /* returns 1 if the object was already moved */
440 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
443 ao_lisp_alloc(int size);
445 #define AO_LISP_COLLECT_FULL 1
446 #define AO_LISP_COLLECT_INCREMENTAL 0
449 ao_lisp_collect(uint8_t style);
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_poly_stash(int id, ao_poly poly);
461 ao_lisp_poly_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) {
471 ao_lisp_poly_stash(id, ao_lisp_stack_poly(stack));
474 static inline struct ao_lisp_stack *
475 ao_lisp_stack_fetch(int id) {
476 return ao_lisp_poly_stack(ao_lisp_poly_fetch(id));
481 extern const struct ao_lisp_type ao_lisp_bool_type;
484 ao_lisp_bool_print(ao_poly v);
486 #ifdef AO_LISP_MAKE_CONST
487 struct ao_lisp_bool *ao_lisp_true, *ao_lisp_false;
489 struct ao_lisp_bool *
490 ao_lisp_bool_get(uint8_t value);
494 extern const struct ao_lisp_type ao_lisp_cons_type;
496 struct ao_lisp_cons *
497 ao_lisp_cons_cons(ao_poly car, ao_poly cdr);
500 ao_lisp__cons(ao_poly car, ao_poly cdr);
502 extern struct ao_lisp_cons *ao_lisp_cons_free_list;
505 ao_lisp_cons_free(struct ao_lisp_cons *cons);
508 ao_lisp_cons_print(ao_poly);
511 ao_lisp_cons_patom(ao_poly);
514 ao_lisp_cons_length(struct ao_lisp_cons *cons);
517 extern const struct ao_lisp_type ao_lisp_string_type;
520 ao_lisp_string_copy(char *a);
523 ao_lisp_string_cat(char *a, char *b);
526 ao_lisp_string_pack(struct ao_lisp_cons *cons);
529 ao_lisp_string_unpack(char *a);
532 ao_lisp_string_print(ao_poly s);
535 ao_lisp_string_patom(ao_poly s);
538 extern const struct ao_lisp_type ao_lisp_atom_type;
540 extern struct ao_lisp_atom *ao_lisp_atoms;
541 extern struct ao_lisp_frame *ao_lisp_frame_global;
542 extern struct ao_lisp_frame *ao_lisp_frame_current;
545 ao_lisp_atom_print(ao_poly a);
547 struct ao_lisp_atom *
548 ao_lisp_atom_intern(char *name);
551 ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
554 ao_lisp_atom_get(ao_poly atom);
557 ao_lisp_atom_set(ao_poly atom, ao_poly val);
561 ao_lisp_int_print(ao_poly i);
565 ao_lisp_poly_print(ao_poly p);
568 ao_lisp_poly_patom(ao_poly p);
571 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
573 /* returns 1 if the object has already been moved */
575 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
580 ao_lisp_eval_clear_globals(void);
583 ao_lisp_eval_restart(void);
586 ao_lisp_eval(ao_poly p);
589 ao_lisp_set_cond(struct ao_lisp_cons *cons);
593 ao_lisp_builtin_print(ao_poly b);
595 extern const struct ao_lisp_type ao_lisp_builtin_type;
597 /* Check argument count */
599 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
601 /* Check argument type */
603 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
605 /* Fetch an arg (nil if off the end) */
607 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
610 ao_lisp_args_name(uint8_t args);
613 extern struct ao_lisp_cons *ao_lisp_read_cons;
614 extern struct ao_lisp_cons *ao_lisp_read_cons_tail;
615 extern struct ao_lisp_cons *ao_lisp_read_stack;
622 ao_lisp_read_eval_print(void);
625 extern const struct ao_lisp_type ao_lisp_frame_type;
627 #define AO_LISP_FRAME_FREE 6
629 extern struct ao_lisp_frame *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
632 ao_lisp_frame_mark(struct ao_lisp_frame *frame);
635 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
637 struct ao_lisp_frame *
638 ao_lisp_frame_new(int num);
641 ao_lisp_frame_free(struct ao_lisp_frame *frame);
644 ao_lisp_frame_bind(struct ao_lisp_frame *frame, int num, ao_poly atom, ao_poly val);
647 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
650 ao_lisp_frame_print(ao_poly p);
653 extern const struct ao_lisp_type ao_lisp_lambda_type;
655 extern const char *ao_lisp_state_names[];
657 struct ao_lisp_lambda *
658 ao_lisp_lambda_new(ao_poly cons);
661 ao_lisp_lambda_print(ao_poly lambda);
664 ao_lisp_lambda_eval(void);
668 extern const struct ao_lisp_type ao_lisp_stack_type;
669 extern struct ao_lisp_stack *ao_lisp_stack;
670 extern struct ao_lisp_stack *ao_lisp_stack_free_list;
673 ao_lisp_stack_reset(struct ao_lisp_stack *stack);
676 ao_lisp_stack_push(void);
679 ao_lisp_stack_pop(void);
682 ao_lisp_stack_clear(void);
685 ao_lisp_stack_print(ao_poly stack);
688 ao_lisp_stack_eval(void);
693 ao_lisp_error_poly(char *name, ao_poly poly, ao_poly last);
696 ao_lisp_error_frame(int indent, char *name, struct ao_lisp_frame *frame);
699 ao_lisp_error(int error, char *format, ...);
703 #define AO_LISP_BUILTIN_DECLS
704 #include "ao_lisp_builtin.h"
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(ao_lisp_stack_poly(ao_lisp_stack))
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()
746 #define DBG_MEM_START 1
751 extern int dbg_move_depth;
753 #define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
758 #define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf (" "); printf(__VA_ARGS__); } } while (0)
759 #define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
760 #define MDBG_MOVE_IN() (dbg_move_depth++)
761 #define MDBG_MOVE_OUT() (assert(--dbg_move_depth >= 0))
766 #define MDBG_MOVE(...)
767 #define MDBG_MORE(...)
768 #define MDBG_MOVE_IN()
769 #define MDBG_MOVE_OUT()
773 #endif /* _AO_LISP_H_ */