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.
15 #define AO_LISP_CONST_BITS
20 #ifdef AO_LISP_MAKE_CONST
23 * When building the constant table, it is the
24 * pool for allocations.
28 uint8_t ao_lisp_const[AO_LISP_POOL_CONST] __attribute__((aligned(4)));
29 #define ao_lisp_pool ao_lisp_const
31 #define AO_LISP_POOL AO_LISP_POOL_CONST
35 uint8_t ao_lisp_pool[AO_LISP_POOL + AO_LISP_POOL_EXTRA] __attribute__((aligned(4)));
40 #define DBG_MEM_STATS DBG_MEM
45 int dbg_mem = DBG_MEM_START;
48 struct ao_lisp_record {
49 struct ao_lisp_record *next;
50 const struct ao_lisp_type *type;
55 static struct ao_lisp_record *record_head, **record_tail;
58 ao_lisp_record_free(struct ao_lisp_record *record)
61 struct ao_lisp_record *next = record->next;
68 ao_lisp_record_reset(void)
70 ao_lisp_record_free(record_head);
72 record_tail = &record_head;
76 ao_lisp_record(const struct ao_lisp_type *type,
80 struct ao_lisp_record *r = malloc(sizeof (struct ao_lisp_record));
87 record_tail = &r->next;
90 static struct ao_lisp_record *
91 ao_lisp_record_save(void)
93 struct ao_lisp_record *r = record_head;
96 record_tail = &record_head;
101 ao_lisp_record_compare(char *where,
102 struct ao_lisp_record *a,
103 struct ao_lisp_record *b)
106 if (a->type != b->type || a->size != b->size) {
107 printf("%s record difers %d %s %d -> %d %s %d\n",
109 MDBG_OFFSET(a->addr),
112 MDBG_OFFSET(b->addr),
121 printf("%s record differs %d %s %d -> NULL\n",
123 MDBG_OFFSET(a->addr),
129 printf("%s record differs NULL -> %d %s %d\n",
131 MDBG_OFFSET(b->addr),
139 #define ao_lisp_record_reset()
142 uint8_t ao_lisp_exception;
144 struct ao_lisp_root {
145 const struct ao_lisp_type *type;
149 static struct ao_lisp_cons *save_cons[2];
150 static char *save_string[2];
151 static ao_poly save_poly[3];
153 static const struct ao_lisp_root ao_lisp_root[] = {
155 .type = &ao_lisp_cons_type,
156 .addr = (void **) &save_cons[0],
159 .type = &ao_lisp_cons_type,
160 .addr = (void **) &save_cons[1],
163 .type = &ao_lisp_string_type,
164 .addr = (void **) &save_string[0],
167 .type = &ao_lisp_string_type,
168 .addr = (void **) &save_string[1],
172 .addr = (void **) (void *) &save_poly[0]
176 .addr = (void **) (void *) &save_poly[1]
180 .addr = (void **) (void *) &save_poly[2]
183 .type = &ao_lisp_atom_type,
184 .addr = (void **) &ao_lisp_atoms
187 .type = &ao_lisp_frame_type,
188 .addr = (void **) &ao_lisp_frame_global,
191 .type = &ao_lisp_frame_type,
192 .addr = (void **) &ao_lisp_frame_current,
195 .type = &ao_lisp_stack_type,
196 .addr = (void **) &ao_lisp_stack,
200 .addr = (void **) (void *) &ao_lisp_v,
203 .type = &ao_lisp_cons_type,
204 .addr = (void **) &ao_lisp_read_cons,
207 .type = &ao_lisp_cons_type,
208 .addr = (void **) &ao_lisp_read_cons_tail,
211 .type = &ao_lisp_cons_type,
212 .addr = (void **) &ao_lisp_read_stack,
216 #define AO_LISP_ROOT (sizeof (ao_lisp_root) / sizeof (ao_lisp_root[0]))
218 static const void ** const ao_lisp_cache[] = {
219 (const void **) &ao_lisp_cons_free_list,
220 (const void **) &ao_lisp_stack_free_list,
221 (const void **) &ao_lisp_frame_free_list[0],
222 (const void **) &ao_lisp_frame_free_list[1],
223 (const void **) &ao_lisp_frame_free_list[2],
224 (const void **) &ao_lisp_frame_free_list[3],
225 (const void **) &ao_lisp_frame_free_list[4],
226 (const void **) &ao_lisp_frame_free_list[5],
229 #if AO_LISP_FRAME_FREE != 6
230 #error Unexpected AO_LISP_FRAME_FREE value
233 #define AO_LISP_CACHE (sizeof (ao_lisp_cache) / sizeof (ao_lisp_cache[0]))
235 #define AO_LISP_BUSY_SIZE ((AO_LISP_POOL + 31) / 32)
237 static uint8_t ao_lisp_busy[AO_LISP_BUSY_SIZE];
238 static uint8_t ao_lisp_cons_note[AO_LISP_BUSY_SIZE];
239 static uint8_t ao_lisp_cons_last[AO_LISP_BUSY_SIZE];
240 static uint8_t ao_lisp_cons_noted;
242 uint16_t ao_lisp_top;
244 struct ao_lisp_chunk {
252 #define AO_LISP_NCHUNK 64
254 static struct ao_lisp_chunk ao_lisp_chunk[AO_LISP_NCHUNK];
256 /* Offset of an address within the pool. */
257 static inline uint16_t pool_offset(void *addr) {
259 if (!AO_LISP_IS_POOL(addr))
262 return ((uint8_t *) addr) - ao_lisp_pool;
265 static inline void mark(uint8_t *tag, int offset) {
266 int byte = offset >> 5;
267 int bit = (offset >> 2) & 7;
268 tag[byte] |= (1 << bit);
271 static inline void clear(uint8_t *tag, int offset) {
272 int byte = offset >> 5;
273 int bit = (offset >> 2) & 7;
274 tag[byte] &= ~(1 << bit);
277 static inline int busy(uint8_t *tag, int offset) {
278 int byte = offset >> 5;
279 int bit = (offset >> 2) & 7;
280 return (tag[byte] >> bit) & 1;
283 static inline int min(int a, int b) { return a < b ? a : b; }
284 static inline int max(int a, int b) { return a > b ? a : b; }
286 static inline int limit(int offset) {
287 return min(AO_LISP_POOL, max(offset, 0));
291 note_cons(uint16_t offset)
293 MDBG_MOVE("note cons %d\n", offset);
294 ao_lisp_cons_noted = 1;
295 mark(ao_lisp_cons_note, offset);
298 static uint16_t chunk_low, chunk_high;
299 static uint16_t chunk_first, chunk_last;
302 find_chunk(uint16_t offset)
305 /* Binary search for the location */
309 int m = (l + r) >> 1;
310 if (ao_lisp_chunk[m].old_offset < offset)
319 note_chunk(uint16_t offset, uint16_t size)
323 if (offset < chunk_low || chunk_high <= offset)
326 l = find_chunk(offset);
329 * The correct location is always in 'l', with r = l-1 being
330 * the entry before the right one
334 /* Off the right side */
335 if (l >= AO_LISP_NCHUNK)
338 /* Off the left side */
339 if (l == 0 && chunk_last && offset > ao_lisp_chunk[0].old_offset)
343 /* Shuffle existing entries right */
344 int end = min(AO_LISP_NCHUNK, chunk_last + 1);
346 memmove(&ao_lisp_chunk[l+1],
348 (end - (l+1)) * sizeof (struct ao_lisp_chunk));
351 ao_lisp_chunk[l].old_offset = offset;
352 ao_lisp_chunk[l].size = size;
354 /* Increment the number of elements up to the size of the array */
355 if (chunk_last < AO_LISP_NCHUNK)
358 /* Set the top address if the array is full */
359 if (chunk_last == AO_LISP_NCHUNK)
360 chunk_high = ao_lisp_chunk[AO_LISP_NCHUNK-1].old_offset +
361 ao_lisp_chunk[AO_LISP_NCHUNK-1].size;
367 chunk_high = ao_lisp_top;
373 * Walk all referenced objects calling functions on each one
377 walk(int (*visit_addr)(const struct ao_lisp_type *type, void **addr),
378 int (*visit_poly)(ao_poly *p, uint8_t do_note_cons))
382 ao_lisp_record_reset();
383 memset(ao_lisp_busy, '\0', sizeof (ao_lisp_busy));
384 memset(ao_lisp_cons_note, '\0', sizeof (ao_lisp_cons_note));
385 ao_lisp_cons_noted = 0;
386 for (i = 0; i < (int) AO_LISP_ROOT; i++) {
387 if (ao_lisp_root[i].type) {
388 void **a = ao_lisp_root[i].addr, *v;
390 MDBG_MOVE("root ptr %d\n", MDBG_OFFSET(v));
391 visit_addr(ao_lisp_root[i].type, a);
394 ao_poly *a = (ao_poly *) ao_lisp_root[i].addr, p;
396 MDBG_MOVE("root poly %d\n", MDBG_OFFSET(ao_lisp_ref(p)));
401 while (ao_lisp_cons_noted) {
402 memcpy(ao_lisp_cons_last, ao_lisp_cons_note, sizeof (ao_lisp_cons_note));
403 memset(ao_lisp_cons_note, '\0', sizeof (ao_lisp_cons_note));
404 ao_lisp_cons_noted = 0;
405 for (i = 0; i < AO_LISP_POOL; i += 4) {
406 if (busy(ao_lisp_cons_last, i)) {
407 void *v = ao_lisp_pool + i;
408 MDBG_MOVE("root cons %d\n", MDBG_OFFSET(v));
409 visit_addr(&ao_lisp_cons_type, &v);
421 for (i = 0; i < ao_lisp_top; i += 4) {
422 if ((i & 0xff) == 0) {
426 else if ((i & 0x1f) == 0)
428 if (busy(ao_lisp_busy, i))
435 #define DUMP_BUSY() dump_busy()
440 static const struct ao_lisp_type const *ao_lisp_types[AO_LISP_NUM_TYPE] = {
441 [AO_LISP_CONS] = &ao_lisp_cons_type,
442 [AO_LISP_INT] = NULL,
443 [AO_LISP_STRING] = &ao_lisp_string_type,
444 [AO_LISP_OTHER] = (void *) 0x1,
445 [AO_LISP_ATOM] = &ao_lisp_atom_type,
446 [AO_LISP_BUILTIN] = &ao_lisp_builtin_type,
447 [AO_LISP_FRAME] = &ao_lisp_frame_type,
448 [AO_LISP_LAMBDA] = &ao_lisp_lambda_type,
449 [AO_LISP_STACK] = &ao_lisp_stack_type,
453 ao_lisp_mark_ref(const struct ao_lisp_type *type, void **ref)
455 return ao_lisp_mark(type, *ref);
459 ao_lisp_poly_mark_ref(ao_poly *p, uint8_t do_note_cons)
461 return ao_lisp_poly_mark(*p, do_note_cons);
465 int ao_lisp_collects[2];
466 int ao_lisp_freed[2];
467 int ao_lisp_loops[2];
470 int ao_lisp_last_top;
473 ao_lisp_collect(uint8_t style)
481 struct ao_lisp_record *mark_record = NULL, *move_record = NULL;
483 MDBG_MOVE("collect %d\n", ao_lisp_collects[style]);
486 /* The first time through, we're doing a full collect */
487 if (ao_lisp_last_top == 0)
488 style = AO_LISP_COLLECT_FULL;
490 /* Clear references to all caches */
491 for (i = 0; i < (int) AO_LISP_CACHE; i++)
492 *ao_lisp_cache[i] = NULL;
493 if (style == AO_LISP_COLLECT_FULL) {
496 chunk_low = top = ao_lisp_last_top;
502 MDBG_MOVE("move chunks from %d to %d\n", chunk_low, top);
503 /* Find the sizes of the first chunk of objects to move */
505 walk(ao_lisp_mark_ref, ao_lisp_poly_mark_ref);
508 ao_lisp_record_free(mark_record);
509 mark_record = ao_lisp_record_save();
510 if (mark_record && move_record)
511 ao_lisp_record_compare("mark", move_record, mark_record);
516 /* Find the first moving object */
517 for (i = 0; i < chunk_last; i++) {
518 uint16_t size = ao_lisp_chunk[i].size;
525 if (ao_lisp_chunk[i].old_offset > top)
528 MDBG_MOVE("chunk %d %d not moving\n",
529 ao_lisp_chunk[i].old_offset,
530 ao_lisp_chunk[i].size);
532 if (ao_lisp_chunk[i].old_offset != top)
539 * Limit amount of chunk array used in mapping moves
540 * to the active region
543 chunk_low = ao_lisp_chunk[i].old_offset;
545 /* Copy all of the objects */
546 for (; i < chunk_last; i++) {
547 uint16_t size = ao_lisp_chunk[i].size;
554 MDBG_MOVE("chunk %d %d -> %d\n",
555 ao_lisp_chunk[i].old_offset,
558 ao_lisp_chunk[i].new_offset = top;
560 memmove(&ao_lisp_pool[top],
561 &ao_lisp_pool[ao_lisp_chunk[i].old_offset],
567 if (chunk_first < chunk_last) {
568 /* Relocate all references to the objects */
569 walk(ao_lisp_move, ao_lisp_poly_move);
572 ao_lisp_record_free(move_record);
573 move_record = ao_lisp_record_save();
574 if (mark_record && move_record)
575 ao_lisp_record_compare("move", mark_record, move_record);
579 /* If we ran into the end of the heap, then
580 * there's no need to keep walking
582 if (chunk_last != AO_LISP_NCHUNK)
585 /* Next loop starts right above this loop */
586 chunk_low = chunk_high;
591 ++ao_lisp_collects[style];
592 ao_lisp_freed[style] += ao_lisp_top - top;
593 ao_lisp_loops[style] += loops;
597 if (style == AO_LISP_COLLECT_FULL)
598 ao_lisp_last_top = top;
600 MDBG_DO(memset(ao_lisp_chunk, '\0', sizeof (ao_lisp_chunk));
601 walk(ao_lisp_mark_ref, ao_lisp_poly_mark_ref));
603 return AO_LISP_POOL - ao_lisp_top;
607 * Mark interfaces for objects
611 * Note a reference to memory and collect information about a few
612 * object sizes at a time
616 ao_lisp_mark_memory(const struct ao_lisp_type *type, void *addr)
619 if (!AO_LISP_IS_POOL(addr))
622 offset = pool_offset(addr);
623 MDBG_MOVE("mark memory %d\n", MDBG_OFFSET(addr));
624 if (busy(ao_lisp_busy, offset)) {
625 MDBG_MOVE("already marked\n");
628 mark(ao_lisp_busy, offset);
629 note_chunk(offset, ao_lisp_size(type, addr));
634 * Mark an object and all that it refereces
637 ao_lisp_mark(const struct ao_lisp_type *type, void *addr)
640 MDBG_MOVE("mark %d\n", MDBG_OFFSET(addr));
642 ret = ao_lisp_mark_memory(type, addr);
644 MDBG_MOVE("mark recurse\n");
652 * Mark an object, unless it is a cons cell and
653 * do_note_cons is set. In that case, just
654 * set a bit in the cons note array; those
655 * will be marked in a separate pass to avoid
656 * deep recursion in the collector
659 ao_lisp_poly_mark(ao_poly p, uint8_t do_note_cons)
664 type = ao_lisp_poly_base_type(p);
666 if (type == AO_LISP_INT)
669 addr = ao_lisp_ref(p);
670 if (!AO_LISP_IS_POOL(addr))
673 if (type == AO_LISP_CONS && do_note_cons) {
674 note_cons(pool_offset(addr));
677 if (type == AO_LISP_OTHER)
678 type = ao_lisp_other_type(addr);
680 const struct ao_lisp_type *lisp_type = ao_lisp_types[type];
686 return ao_lisp_mark(lisp_type, addr);
691 * Find the current location of an object
692 * based on the original location. For unmoved
693 * objects, this is simple. For moved objects,
698 move_map(uint16_t offset)
702 if (offset < chunk_low || chunk_high <= offset)
705 l = find_chunk(offset);
708 if (ao_lisp_chunk[l].old_offset != offset)
711 return ao_lisp_chunk[l].new_offset;
715 ao_lisp_move_memory(const struct ao_lisp_type *type, void **ref)
718 uint16_t offset, orig_offset;
720 if (!AO_LISP_IS_POOL(addr))
725 MDBG_MOVE("move memory %d\n", MDBG_OFFSET(addr));
726 orig_offset = pool_offset(addr);
727 offset = move_map(orig_offset);
728 if (offset != orig_offset) {
729 MDBG_MOVE("update ref %d %d -> %d\n",
730 AO_LISP_IS_POOL(ref) ? MDBG_OFFSET(ref) : -1,
731 orig_offset, offset);
732 *ref = ao_lisp_pool + offset;
734 if (busy(ao_lisp_busy, offset)) {
735 MDBG_MOVE("already moved\n");
738 mark(ao_lisp_busy, offset);
739 MDBG_DO(ao_lisp_record(type, addr, ao_lisp_size(type, addr)));
744 ao_lisp_move(const struct ao_lisp_type *type, void **ref)
747 MDBG_MOVE("move object %d\n", MDBG_OFFSET(*ref));
749 ret = ao_lisp_move_memory(type, ref);
751 MDBG_MOVE("move recurse\n");
759 ao_lisp_poly_move(ao_poly *ref, uint8_t do_note_cons)
765 uint16_t offset, orig_offset;
768 base_type = type = ao_lisp_poly_base_type(p);
770 if (type == AO_LISP_INT)
773 addr = ao_lisp_ref(p);
774 if (!AO_LISP_IS_POOL(addr))
777 orig_offset = pool_offset(addr);
778 offset = move_map(orig_offset);
780 if (type == AO_LISP_CONS && do_note_cons) {
781 note_cons(orig_offset);
784 if (type == AO_LISP_OTHER)
785 type = ao_lisp_other_type(ao_lisp_pool + offset);
787 const struct ao_lisp_type *lisp_type = ao_lisp_types[type];
793 ret = ao_lisp_move(lisp_type, &addr);
796 /* Re-write the poly value */
797 if (offset != orig_offset) {
798 ao_poly np = ao_lisp_poly(ao_lisp_pool + offset, base_type);
799 MDBG_MOVE("poly %d moved %d -> %d\n",
800 type, orig_offset, offset);
808 ao_lisp_validate(void)
811 memset(ao_lisp_chunk, '\0', sizeof (ao_lisp_chunk));
812 walk(ao_lisp_mark_ref, ao_lisp_poly_mark_ref);
820 ao_lisp_alloc(int size)
824 MDBG_DO(++dbg_allocs);
825 MDBG_DO(if (dbg_validate) ao_lisp_validate());
826 size = ao_lisp_size_round(size);
827 if (AO_LISP_POOL - ao_lisp_top < size &&
828 ao_lisp_collect(AO_LISP_COLLECT_INCREMENTAL) < size &&
829 ao_lisp_collect(AO_LISP_COLLECT_FULL) < size)
831 ao_lisp_error(AO_LISP_OOM, "out of memory");
834 addr = ao_lisp_pool + ao_lisp_top;
840 ao_lisp_cons_stash(int id, struct ao_lisp_cons *cons)
842 save_cons[id] = cons;
845 struct ao_lisp_cons *
846 ao_lisp_cons_fetch(int id)
848 struct ao_lisp_cons *cons = save_cons[id];
849 save_cons[id] = NULL;
854 ao_lisp_poly_stash(int id, ao_poly poly)
856 save_poly[id] = poly;
860 ao_lisp_poly_fetch(int id)
862 ao_poly poly = save_poly[id];
863 save_poly[id] = AO_LISP_NIL;
868 ao_lisp_string_stash(int id, char *string)
870 save_string[id] = string;
874 ao_lisp_string_fetch(int id)
876 char *string = save_string[id];
877 save_string[id] = NULL;