altos/lisp: Cleanup some DBG defines
[fw/altos] / src / lisp / ao_lisp.h
index 86a5ddcff018f4a2feb0e33c42a5f9de8d400432..fa3632b157afaeb8c38c8c7a9c7810efe5395434 100644 (file)
 #ifndef _AO_LISP_H_
 #define _AO_LISP_H_
 
+#define DBG_MEM                0
+#define DBG_EVAL       0
+
 #include <stdint.h>
 #include <string.h>
-//#include <stdio.h>
 #include <ao_lisp_os.h>
 
+typedef uint16_t       ao_poly;
+typedef int16_t                ao_signed_poly;
+
+#ifdef AO_LISP_SAVE
+
+struct ao_lisp_os_save {
+       ao_poly         atoms;
+       ao_poly         globals;
+       uint16_t        const_checksum;
+       uint16_t        const_checksum_inv;
+};
+
+#define AO_LISP_POOL_EXTRA     (sizeof(struct ao_lisp_os_save))
+#define AO_LISP_POOL   ((int) (AO_LISP_POOL_TOTAL - AO_LISP_POOL_EXTRA))
+
+int
+ao_lisp_os_save(void);
+
+int
+ao_lisp_os_restore_save(struct ao_lisp_os_save *save, int offset);
+
+int
+ao_lisp_os_restore(void);
+
+#endif
+
 #ifdef AO_LISP_MAKE_CONST
 #define AO_LISP_POOL_CONST     16384
 extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
@@ -47,12 +75,16 @@ extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
 #define _ao_lisp_atom_eval     _atom("eval")
 #define _ao_lisp_atom_read     _atom("read")
 #define _ao_lisp_atom_eof      _atom("eof")
+#define _ao_lisp_atom_save     _atom("save")
+#define _ao_lisp_atom_restore  _atom("restore")
+#define _ao_lisp_atom_call2fcc _atom("call/cc")
+#define _ao_lisp_atom_collect  _atom("collect")
 #else
 #include "ao_lisp_const.h"
 #ifndef AO_LISP_POOL
-#define AO_LISP_POOL   16384
+#define AO_LISP_POOL   3072
 #endif
-extern uint8_t         ao_lisp_pool[AO_LISP_POOL];
+extern uint8_t         ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA];
 #endif
 
 /* Primitive types */
@@ -71,7 +103,11 @@ extern uint8_t              ao_lisp_pool[AO_LISP_POOL];
 #define AO_LISP_BUILTIN                5
 #define AO_LISP_FRAME          6
 #define AO_LISP_LAMBDA         7
-#define AO_LISP_NUM_TYPE       8
+#define AO_LISP_STACK          8
+#define AO_LISP_NUM_TYPE       9
+
+/* Leave two bits for types to use as they please */
+#define AO_LISP_OTHER_TYPE_MASK        0x3f
 
 #define AO_LISP_NIL    0
 
@@ -85,45 +121,26 @@ extern uint16_t            ao_lisp_top;
 
 extern uint8_t         ao_lisp_exception;
 
-typedef uint16_t       ao_poly;
-typedef int16_t                ao_signed_poly;
-
 static inline int
 ao_lisp_is_const(ao_poly poly) {
        return poly & AO_LISP_CONST;
 }
 
-#define AO_LISP_POOL_BASE      (ao_lisp_pool - 4)
-#define AO_LISP_CONST_BASE     (ao_lisp_const - 4)
-
 #define AO_LISP_IS_CONST(a)    (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
 #define AO_LISP_IS_POOL(a)     (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
+#define AO_LISP_IS_INT(p)      (ao_lisp_base_type(p) == AO_LISP_INT);
 
-static inline void *
-ao_lisp_ref(ao_poly poly) {
-       if (poly == 0xBEEF)
-               ao_lisp_abort();
-       if (poly == AO_LISP_NIL)
-               return NULL;
-       if (poly & AO_LISP_CONST)
-               return (void *) (AO_LISP_CONST_BASE + (poly & AO_LISP_REF_MASK));
-       return (void *) (AO_LISP_POOL_BASE + (poly & AO_LISP_REF_MASK));
-}
+void *
+ao_lisp_ref(ao_poly poly);
 
-static inline ao_poly
-ao_lisp_poly(const void *addr, ao_poly type) {
-       const uint8_t   *a = addr;
-       if (a == NULL)
-               return AO_LISP_NIL;
-       if (AO_LISP_IS_CONST(a))
-               return AO_LISP_CONST | (a - AO_LISP_CONST_BASE) | type;
-       return (a - AO_LISP_POOL_BASE) | type;
-}
+ao_poly
+ao_lisp_poly(const void *addr, ao_poly type);
 
 struct ao_lisp_type {
        int     (*size)(void *addr);
        void    (*mark)(void *addr);
        void    (*move)(void *addr);
+       char    name[];
 };
 
 struct ao_lisp_cons {
@@ -146,10 +163,18 @@ struct ao_lisp_val {
 struct ao_lisp_frame {
        uint8_t                 type;
        uint8_t                 num;
-       ao_poly                 next;
+       ao_poly                 prev;
        struct ao_lisp_val      vals[];
 };
 
+/* Set on type when the frame escapes the lambda */
+#define AO_LISP_FRAME_MARK     0x80
+#define AO_LISP_FRAME_PRINT    0x40
+
+static inline int ao_lisp_frame_marked(struct ao_lisp_frame *f) {
+       return f->type & AO_LISP_FRAME_MARK;
+}
+
 static inline struct ao_lisp_frame *
 ao_lisp_poly_frame(ao_poly poly) {
        return ao_lisp_ref(poly);
@@ -162,17 +187,19 @@ ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
 
 enum eval_state {
        eval_sexpr,             /* Evaluate an sexpr */
-       eval_val,
-       eval_formal,
-       eval_exec,
-       eval_cond,
-       eval_cond_test,
-       eval_progn,
-       eval_while,
-       eval_while_test,
+       eval_val,               /* Value computed */
+       eval_formal,            /* Formal computed */
+       eval_exec,              /* Start a lambda evaluation */
+       eval_cond,              /* Start next cond clause */
+       eval_cond_test,         /* Check cond condition */
+       eval_progn,             /* Start next progn entry */
+       eval_while,             /* Start while condition */
+       eval_while_test,        /* Check while condition */
+       eval_macro,             /* Finished with macro generation */
 };
 
 struct ao_lisp_stack {
+       uint8_t                 type;           /* AO_LISP_STACK */
        uint8_t                 state;          /* enum eval_state */
        ao_poly                 prev;           /* previous stack frame */
        ao_poly                 sexprs;         /* expressions to evaluate */
@@ -182,6 +209,17 @@ struct ao_lisp_stack {
        ao_poly                 list;           /* most recent function call */
 };
 
+#define AO_LISP_STACK_MARK     0x80    /* set on type when a reference has been taken */
+#define AO_LISP_STACK_PRINT    0x40    /* stack is being printed */
+
+static inline int ao_lisp_stack_marked(struct ao_lisp_stack *s) {
+       return s->type & AO_LISP_STACK_MARK;
+}
+
+static inline void ao_lisp_stack_mark(struct ao_lisp_stack *s) {
+       s->type |= AO_LISP_STACK_MARK;
+}
+
 static inline struct ao_lisp_stack *
 ao_lisp_poly_stack(ao_poly p)
 {
@@ -194,7 +232,6 @@ ao_lisp_stack_poly(struct ao_lisp_stack *stack)
        return ao_lisp_poly(stack, AO_LISP_OTHER);
 }
 
-extern struct ao_lisp_stack    *ao_lisp_stack;
 extern ao_poly                 ao_lisp_v;
 
 #define AO_LISP_FUNC_LAMBDA    0
@@ -202,6 +239,14 @@ extern ao_poly                     ao_lisp_v;
 #define AO_LISP_FUNC_MACRO     2
 #define AO_LISP_FUNC_LEXPR     3
 
+#define AO_LISP_FUNC_FREE_ARGS 0x80
+#define AO_LISP_FUNC_MASK      0x7f
+
+#define AO_LISP_FUNC_F_LAMBDA  (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LAMBDA)
+#define AO_LISP_FUNC_F_NLAMBDA (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_NLAMBDA)
+#define AO_LISP_FUNC_F_MACRO   (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_MACRO)
+#define AO_LISP_FUNC_F_LEXPR   (AO_LISP_FUNC_FREE_ARGS | AO_LISP_FUNC_LEXPR)
+
 struct ao_lisp_builtin {
        uint8_t         type;
        uint8_t         args;
@@ -243,6 +288,10 @@ enum ao_lisp_builtin_id {
        builtin_flush,
        builtin_delay,
        builtin_led,
+       builtin_save,
+       builtin_restore,
+       builtin_call_cc,
+       builtin_collect,
        _builtin_last
 };
 
@@ -282,7 +331,11 @@ ao_lisp_poly_other(ao_poly poly) {
 
 static inline uint8_t
 ao_lisp_other_type(void *other) {
-       return *((uint8_t *) other);
+#if DBG_MEM
+       if ((*((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK) >= AO_LISP_NUM_TYPE)
+               ao_lisp_abort();
+#endif
+       return *((uint8_t *) other) & AO_LISP_OTHER_TYPE_MASK;
 }
 
 static inline ao_poly
@@ -292,11 +345,17 @@ ao_lisp_other_poly(const void *other)
 }
 
 static inline int
-ao_lisp_mem_round(int size)
+ao_lisp_size_round(int size)
 {
        return (size + 3) & ~3;
 }
 
+static inline int
+ao_lisp_size(const struct ao_lisp_type *type, void *addr)
+{
+       return ao_lisp_size_round(type->size(addr));
+}
+
 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
 
 static inline int ao_lisp_poly_base_type(ao_poly poly) {
@@ -371,13 +430,18 @@ ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
 }
 
 /* memory functions */
+
+extern int ao_lisp_collects[2];
+extern int ao_lisp_freed[2];
+extern int ao_lisp_loops[2];
+
 /* returns 1 if the object was already marked */
 int
 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
 
 /* returns 1 if the object was already marked */
 int
-ao_lisp_mark_memory(void *addr, int size);
+ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr);
 
 void *
 ao_lisp_move_map(void *addr);
@@ -388,22 +452,44 @@ ao_lisp_move(const struct ao_lisp_type *type, void **ref);
 
 /* returns 1 if the object was already moved */
 int
-ao_lisp_move_memory(void **ref, int size);
+ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref);
 
 void *
 ao_lisp_alloc(int size);
 
-void
-ao_lisp_collect(void);
+#define AO_LISP_COLLECT_FULL           1
+#define AO_LISP_COLLECT_INCREMENTAL    0
 
 int
-ao_lisp_root_add(const struct ao_lisp_type *type, void *addr);
+ao_lisp_collect(uint8_t style);
 
-int
-ao_lisp_root_poly_add(ao_poly *p);
+void
+ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons);
+
+struct ao_lisp_cons *
+ao_lisp_cons_fetch(int id);
 
 void
-ao_lisp_root_clear(void *addr);
+ao_lisp_poly_stash(int id, ao_poly poly);
+
+ao_poly
+ao_lisp_poly_fetch(int id);
+
+void
+ao_lisp_string_stash(int id, char *string);
+
+char *
+ao_lisp_string_fetch(int id);
+
+static inline void
+ao_lisp_stack_stash(int id, struct ao_lisp_stack *stack) {
+       ao_lisp_poly_stash(id, ao_lisp_stack_poly(stack));
+}
+
+static inline struct ao_lisp_stack *
+ao_lisp_stack_fetch(int id) {
+       return ao_lisp_poly_stack(ao_lisp_poly_fetch(id));
+}
 
 /* cons */
 extern const struct ao_lisp_type ao_lisp_cons_type;
@@ -411,6 +497,11 @@ extern const struct ao_lisp_type ao_lisp_cons_type;
 struct ao_lisp_cons *
 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
 
+extern struct ao_lisp_cons *ao_lisp_cons_free_list;
+
+void
+ao_lisp_cons_free(struct ao_lisp_cons *cons);
+
 void
 ao_lisp_cons_print(ao_poly);
 
@@ -423,9 +514,6 @@ ao_lisp_cons_length(struct ao_lisp_cons *cons);
 /* string */
 extern const struct ao_lisp_type ao_lisp_string_type;
 
-char *
-ao_lisp_string_new(int len);
-
 char *
 ao_lisp_string_copy(char *a);
 
@@ -457,6 +545,9 @@ ao_lisp_atom_print(ao_poly a);
 struct ao_lisp_atom *
 ao_lisp_atom_intern(char *name);
 
+ao_poly *
+ao_lisp_atom_ref(struct ao_lisp_frame *frame, ao_poly atom);
+
 ao_poly
 ao_lisp_atom_get(ao_poly atom);
 
@@ -483,6 +574,12 @@ ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
 
 /* eval */
 
+void
+ao_lisp_eval_clear_globals(void);
+
+int
+ao_lisp_eval_restart(void);
+
 ao_poly
 ao_lisp_eval(ao_poly p);
 
@@ -511,6 +608,10 @@ char *
 ao_lisp_args_name(uint8_t args);
 
 /* read */
+extern struct ao_lisp_cons     *ao_lisp_read_cons;
+extern struct ao_lisp_cons     *ao_lisp_read_cons_tail;
+extern struct ao_lisp_cons     *ao_lisp_read_stack;
+
 ao_poly
 ao_lisp_read(void);
 
@@ -521,12 +622,25 @@ ao_lisp_read_eval_print(void);
 /* frame */
 extern const struct ao_lisp_type ao_lisp_frame_type;
 
+#define AO_LISP_FRAME_FREE     6
+
+extern struct ao_lisp_frame    *ao_lisp_frame_free_list[AO_LISP_FRAME_FREE];
+
+ao_poly
+ao_lisp_frame_mark(struct ao_lisp_frame *frame);
+
 ao_poly *
 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
 
 struct ao_lisp_frame *
 ao_lisp_frame_new(int num);
 
+void
+ao_lisp_frame_free(struct ao_lisp_frame *frame);
+
+void
+ao_lisp_frame_bind(struct ao_lisp_frame *frame, int num, ao_poly atom, ao_poly val);
+
 int
 ao_lisp_frame_add(struct ao_lisp_frame **frame, ao_poly atom, ao_poly val);
 
@@ -536,6 +650,8 @@ ao_lisp_frame_print(ao_poly p);
 /* lambda */
 extern const struct ao_lisp_type ao_lisp_lambda_type;
 
+extern const char *ao_lisp_state_names[];
+
 struct ao_lisp_lambda *
 ao_lisp_lambda_new(ao_poly cons);
 
@@ -557,10 +673,48 @@ ao_lisp_macro(struct ao_lisp_cons *cons);
 ao_poly
 ao_lisp_lambda_eval(void);
 
+/* save */
+
+ao_poly
+ao_lisp_save(struct ao_lisp_cons *cons);
+
+ao_poly
+ao_lisp_restore(struct ao_lisp_cons *cons);
+
+/* stack */
+
+extern const struct ao_lisp_type ao_lisp_stack_type;
+extern struct ao_lisp_stack    *ao_lisp_stack;
+extern struct ao_lisp_stack    *ao_lisp_stack_free_list;
+
+void
+ao_lisp_stack_reset(struct ao_lisp_stack *stack);
+
+int
+ao_lisp_stack_push(void);
+
+void
+ao_lisp_stack_pop(void);
+
+void
+ao_lisp_stack_clear(void);
+
+void
+ao_lisp_stack_print(ao_poly stack);
+
+ao_poly
+ao_lisp_stack_eval(void);
+
+ao_poly
+ao_lisp_call_cc(struct ao_lisp_cons *cons);
+
 /* error */
 
 void
-ao_lisp_stack_print(void);
+ao_lisp_error_poly(char *name, ao_poly poly, ao_poly last);
+
+void
+ao_lisp_error_frame(int indent, char *name, struct ao_lisp_frame *frame);
 
 ao_poly
 ao_lisp_error(int error, char *format, ...);
@@ -580,7 +734,7 @@ int ao_lisp_stack_depth;
 #define DBG_CONS(a)    ao_lisp_cons_print(ao_lisp_cons_poly(a))
 #define DBG_POLY(a)    ao_lisp_poly_print(a)
 #define OFFSET(a)      ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
-#define DBG_STACK()    ao_lisp_stack_print()
+#define DBG_STACK()    ao_lisp_stack_print(ao_lisp_stack_poly(ao_lisp_stack))
 static inline void
 ao_lisp_frames_dump(void)
 {
@@ -605,4 +759,31 @@ ao_lisp_frames_dump(void)
 #define DBG_FRAMES()
 #endif
 
+#define DBG_MEM_START  1
+
+#if DBG_MEM
+
+#include <assert.h>
+extern int dbg_move_depth;
+#define MDBG_DUMP 1
+#define MDBG_OFFSET(a) ((int) ((uint8_t *) (a) - ao_lisp_pool))
+
+extern int dbg_mem;
+
+#define MDBG_DO(a)     a
+#define MDBG_MOVE(...) do { if (dbg_mem) { int d; for (d = 0; d < dbg_move_depth; d++) printf ("  "); printf(__VA_ARGS__); } } while (0)
+#define MDBG_MORE(...) do { if (dbg_mem) printf(__VA_ARGS__); } while (0)
+#define MDBG_MOVE_IN() (dbg_move_depth++)
+#define MDBG_MOVE_OUT()        (assert(--dbg_move_depth >= 0))
+
+#else
+
+#define MDBG_DO(a)
+#define MDBG_MOVE(...)
+#define MDBG_MORE(...)
+#define MDBG_MOVE_IN()
+#define MDBG_MOVE_OUT()
+
+#endif
+
 #endif /* _AO_LISP_H_ */