lone: extract system structure from interpreter

When I started lone I tried to force myself to keep things as simple as possible in order to maintain focus on the task at hand. As a result, I wrote code that was tightly coupled on purpose because I thought I'd get bogged down in library development if I didn't. Or worse, build system development. Hey, it's certainly happened before. I believe that approach was instrumental in conjuring up lone lisp into the realm of existence. I have created a freestanding interpreter that can successfully run programs. That's no small feat, no matter how simple and slow it is. Now comes the truly difficult part: making it useful for something other than running fibonacci calculations. For that, I need to continuously improve the system, the interpreter, the language, the modules and everything in-between. It's truly a lifetime of work. Before I start walking down that road, it is wise to finally pay back some of the mounting tech debt in this project. I'll begin by separating the lone lisp interpreter from the underlying lone system libraries. Lone was initially conceived as a freestanding lisp interpreter. As its complexity grew, a library of vital functions was implemented in order to support basic program operations such as memory allocation even in the absence of the standard C library. They were meant to be tightly integrated with the interpreter but their utility increased to the point they supported the development of tools such as lone-embed. The utility of the lone system is likely to increase even further as development of lone continues. My desire to use them to build general Linux software is also likely to increase. Decoupling the system functions from the interpreter is therefore desirable. So I am reorganizing the project in order to make the lone runtime usable without the lone interpreter. This commit marks the beginning of the lone system, a library for freestanding Linux development. The liblinux reborn, better than it ever was. May this help pave the way for amazing Linux free software.
lone-lang · Jun 30, 2024 · 935743f · 935743f
1 parent 6a4fdbb
commit 935743f
Show file tree

Hide file tree

Showing 123 changed files with 5,131 additions and 4,813 deletions.
diff --git a/GNUmakefile b/GNUmakefile
@@ -64,7 +64,7 @@ files.sources.tests := $(filter $(directories.source.tests)/%,$(files.sources.al
 
 targets.phony :=
 targets.NR.list := $(directories.build)/NR.list
-targets.NR.c := $(directories.build.include)/lone/NR.c
+targets.NR.c := $(directories.build.include)/lone/lisp/modules/intrinsic/linux/NR.c
 targets.NR := $(targets.NR.list) $(targets.NR.c)
 targets.objects.lone := $(call source_to_object,$(files.sources.lone))
 targets.objects.lone.entry_point := $(directories.build.objects)/lone.o
@@ -125,7 +125,7 @@ $(directories.build.tools)/%: $(directories.build.objects.tools)/%.o $(targets.o
 $(directories.build.tests)/%: $(directories.build.objects.tests)/%.o $(targets.objects.lone) | directories
 	$(strip $(CC) $(flags.executable) $(CFLAGS.with_overrides) $(LDFLAGS) -o $@ $^)
 
-$(call source_to_object,source/lone/modules/intrinsic/linux.c): $(targets.NR.c)
+$(call source_to_object,source/lone/lisp/modules/intrinsic/linux.c): $(targets.NR.c)
 
 $(targets.NR.c): $(targets.NR.list) scripts/NR.generate
 	scripts/NR.generate < $< > $@

diff --git a/include/lone/definitions.h b/include/lone/definitions.h
@@ -14,47 +14,17 @@
    │                                                                        │
    ╰────────────────────────────────────────────────────────────────────────╯ */
 #if __BITS_PER_LONG == 64
-	#define DECIMAL_DIGITS_PER_LONG 20
+	#define LONE_DECIMAL_DIGITS_PER_LONG 20
 #elif __BITS_PER_LONG == 32
-	#define DECIMAL_DIGITS_PER_LONG 10
+	#define LONE_DECIMAL_DIGITS_PER_LONG 10
 #else
 	#error "Unsupported architecture"
 #endif
 
-#ifndef LONE_BUFFER_SIZE
-	#define LONE_BUFFER_SIZE 4096
-#endif
-
-#ifndef LONE_MEMORY_SIZE
-	#define LONE_MEMORY_SIZE (1024 * 1024)
-#endif
-
-#ifndef LONE_MEMORY_HEAP_VALUE_COUNT
-	#define LONE_MEMORY_HEAP_VALUE_COUNT 512
-#endif
-
 #ifndef LONE_ALIGNMENT
 	#define LONE_ALIGNMENT 16
 #endif
 
-#ifndef LONE_TABLE_LOAD_FACTOR
-	#define LONE_TABLE_LOAD_FACTOR 0.7
-#endif
-
-#ifndef LONE_TABLE_GROWTH_FACTOR
-	#define LONE_TABLE_GROWTH_FACTOR 2
-#endif
-
-#define LONE_PRIMITIVE(name)                  \
-struct lone_value lone_primitive_ ## name     \
-(                                             \
-	struct lone_lisp *lone,               \
-	struct lone_value module,             \
-	struct lone_value environment,        \
-	struct lone_value arguments,          \
-	struct lone_value closure             \
-)
-
 #ifndef PT_LONE
 //      PT_LONE   l o n e
 #define PT_LONE 0x6c6f6e65

diff --git a/include/lone/hash.h b/include/lone/hash.h
@@ -5,7 +5,6 @@
 
 #include <lone/types.h>
 
-void lone_hash_initialize(struct lone_lisp *lone, struct lone_bytes random);
-size_t lone_hash(struct lone_lisp *lone, struct lone_value value);
+void lone_hash_initialize(struct lone_system *system, struct lone_bytes random);
 
 #endif /* LONE_HASH_HEADER */
diff --git a/include/lone/hash/fnv_1a.h b/include/lone/hash/fnv_1a.h
@@ -22,7 +22,7 @@
 	#error "Unsupported architecture"
 #endif
 
-void lone_hash_fnv_1a_initialize(struct lone_lisp *lone, struct lone_bytes random);
+void lone_hash_fnv_1a_initialize(struct lone_system *system, struct lone_bytes random);
 
 unsigned long
 __attribute__((pure))

diff --git a/include/lone/lisp.h b/include/lone/lisp.h
@@ -4,16 +4,16 @@
 #define LONE_LISP_HEADER
 
 #include <lone/types.h>
+#include <lone/lisp/types.h>
 
 /* ╭────────────────────────────────────────────────────────────────────────╮
    │                                                                        │
    │    The lone lisp structure represents the lone lisp interpreter.       │
    │    A pointer to this structure is passed to nearly every function.     │
-   │    It must be initialized before everything else since the memory      │
-   │    allocation system is not functional without it.                     │
+   │    It must be initialized before running lone lisp programs.           │
    │                                                                        │
    ╰────────────────────────────────────────────────────────────────────────╯ */
 
-void lone_lisp_initialize(struct lone_lisp *lone, struct lone_bytes memory, void *stack, struct lone_bytes random);
+void lone_lisp_initialize(struct lone_lisp *lone, struct lone_system *system, void *native_stack);
 
 #endif /* LONE_LISP_HEADER */
diff --git a/include/lone/lisp/constants.h b/include/lone/lisp/constants.h
@@ -3,8 +3,8 @@
 #ifndef LONE_LISP_CONSTANTS_HEADER
 #define LONE_LISP_CONSTANTS_HEADER
 
-#include <lone/types.h>
+#include <lone/lisp/types.h>
 
-struct lone_value lone_true(struct lone_lisp *lone);
+struct lone_lisp_value lone_lisp_true(struct lone_lisp *lone);
 
 #endif /* LONE_LISP_CONSTANTS_HEADER */
diff --git a/include/lone/lisp/definitions.h b/include/lone/lisp/definitions.h
@@ -0,0 +1,40 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_DEFINITIONS_HEADER
+#define LONE_LISP_DEFINITIONS_HEADER
+
+#include <lone/definitions.h>
+
+#define LONE_LISP_DECIMAL_DIGITS_PER_INTEGER LONE_DECIMAL_DIGITS_PER_LONG
+
+#ifndef LONE_LISP_BUFFER_SIZE
+	#define LONE_LISP_BUFFER_SIZE 4096
+#endif
+
+#ifndef LONE_LISP_MEMORY_SIZE
+	#define LONE_LISP_MEMORY_SIZE (1024 * 1024)
+#endif
+
+#ifndef LONE_LISP_HEAP_VALUE_COUNT
+	#define LONE_LISP_HEAP_VALUE_COUNT 512
+#endif
+
+#ifndef LONE_LISP_TABLE_LOAD_FACTOR
+	#define LONE_LISP_TABLE_LOAD_FACTOR 0.7
+#endif
+
+#ifndef LONE_LISP_TABLE_GROWTH_FACTOR
+	#define LONE_LISP_TABLE_GROWTH_FACTOR 2
+#endif
+
+#define LONE_LISP_PRIMITIVE(name)                       \
+struct lone_lisp_value lone_lisp_primitive_ ## name     \
+(                                                       \
+	struct lone_lisp *lone,                         \
+	struct lone_lisp_value module,                  \
+	struct lone_lisp_value environment,             \
+	struct lone_lisp_value arguments,               \
+	struct lone_lisp_value closure                  \
+)
+
+#endif /* LONE_LISP_DEFINITIONS_HEADER */
diff --git a/include/lone/lisp/evaluator.h b/include/lone/lisp/evaluator.h
@@ -3,7 +3,7 @@
 #ifndef LONE_LISP_EVALUATOR_HEADER
 #define LONE_LISP_EVALUATOR_HEADER
 
-#include <lone/types.h>
+#include <lone/lisp/types.h>
 
 /* ╭────────────────────────┨ LONE LISP EVALUATOR ┠─────────────────────────╮
    │                                                                        │
@@ -29,32 +29,32 @@
    │                                                                        │
    ╰────────────────────────────────────────────────────────────────────────╯ */
 
-struct lone_value lone_evaluate(
+struct lone_lisp_value lone_lisp_evaluate(
 	struct lone_lisp *lone,
-	struct lone_value module,
-	struct lone_value environment,
-	struct lone_value value
+	struct lone_lisp_value module,
+	struct lone_lisp_value environment,
+	struct lone_lisp_value value
 );
 
-struct lone_value lone_evaluate_all(
+struct lone_lisp_value lone_lisp_evaluate_all(
 	struct lone_lisp *lone,
-	struct lone_value module,
-	struct lone_value environment,
-	struct lone_value list
+	struct lone_lisp_value module,
+	struct lone_lisp_value environment,
+	struct lone_lisp_value list
 );
 
-struct lone_value lone_evaluate_in_module(
+struct lone_lisp_value lone_lisp_evaluate_in_module(
 	struct lone_lisp *lone,
-	struct lone_value module,
-	struct lone_value value
+	struct lone_lisp_value module,
+	struct lone_lisp_value value
 );
 
-struct lone_value lone_apply(
+struct lone_lisp_value lone_lisp_apply(
 	struct lone_lisp *lone,
-	struct lone_value module,
-	struct lone_value environment,
-	struct lone_value applicable,
-	struct lone_value arguments
+	struct lone_lisp_value module,
+	struct lone_lisp_value environment,
+	struct lone_lisp_value applicable,
+	struct lone_lisp_value arguments
 );
 
 #endif /* LONE_LISP_EVALUATOR_HEADER */
diff --git a/include/lone/lisp/garbage_collector.h b/include/lone/lisp/garbage_collector.h
@@ -0,0 +1,10 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_GARBAGE_COLLECTOR_HEADER
+#define LONE_LISP_GARBAGE_COLLECTOR_HEADER
+
+#include <lone/lisp/types.h>
+
+void lone_lisp_garbage_collector(struct lone_lisp *lone);
+
+#endif /* LONE_LISP_GARBAGE_COLLECTOR_HEADER */
diff --git a/include/lone/lisp/hash.h b/include/lone/lisp/hash.h
@@ -0,0 +1,10 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_HASH_HEADER
+#define LONE_LISP_HASH_HEADER
+
+#include <lone/lisp/types.h>
+
+size_t lone_lisp_hash(struct lone_lisp *lone, struct lone_lisp_value value);
+
+#endif /* LONE_LISP_HASH_HEADER */
diff --git a/include/lone/lisp/heap.h b/include/lone/lisp/heap.h
@@ -0,0 +1,13 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_HEAP_HEADER
+#define LONE_LISP_HEAP_HEADER
+
+#include <lone/lisp/definitions.h>
+#include <lone/lisp/types.h>
+
+void lone_lisp_heap_initialize(struct lone_lisp *lone);
+struct lone_lisp_heap_value *lone_lisp_heap_allocate_value(struct lone_lisp *lone);
+void lone_lisp_deallocate_dead_heaps(struct lone_lisp *lone);
+
+#endif /* LONE_LISP_HEAP_HEADER */
diff --git a/include/lone/lisp/module.h b/include/lone/lisp/module.h
@@ -0,0 +1,42 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_MODULE_HEADER
+#define LONE_LISP_MODULE_HEADER
+
+#include <lone/lisp/definitions.h>
+#include <lone/lisp/types.h>
+
+/* ╭───────────────────────────┨ LONE / MODULES ┠───────────────────────────╮
+   │                                                                        │
+   │    Module importing, exporting and loading operations.                 │
+   │                                                                        │
+   ╰────────────────────────────────────────────────────────────────────────╯ */
+
+struct lone_lisp_value lone_lisp_module_null(struct lone_lisp *lone);
+struct lone_lisp_value lone_lisp_module_for_name(struct lone_lisp *lone, struct lone_lisp_value name);
+struct lone_lisp_value lone_lisp_module_load(struct lone_lisp *lone, struct lone_lisp_value name);
+void lone_lisp_module_load_from_bytes(struct lone_lisp *lone, struct lone_lisp_value module, struct lone_bytes bytes);
+void lone_lisp_module_load_null_from_file_descriptor(struct lone_lisp *lone, int file_descriptor);
+void lone_lisp_module_load_null_from_standard_input(struct lone_lisp *lone);
+void lone_lisp_module_path_push(struct lone_lisp *lone, struct lone_lisp_value directory);
+void lone_lisp_module_path_push_c_string(struct lone_lisp *lone, char *directory);
+void lone_lisp_module_path_push_va_list(struct lone_lisp *lone, size_t count, va_list directories);
+void lone_lisp_module_path_push_all(struct lone_lisp *lone, size_t count, ...);
+
+void lone_lisp_module_export(
+	struct lone_lisp *lone,
+	struct lone_lisp_value module,
+	struct lone_lisp_value symbol
+);
+
+void lone_lisp_module_set_and_export(
+	struct lone_lisp *lone,
+	struct lone_lisp_value module,
+	struct lone_lisp_value symbol,
+	struct lone_lisp_value value
+);
+
+LONE_LISP_PRIMITIVE(module_import);
+LONE_LISP_PRIMITIVE(module_export);
+
+#endif /* LONE_LISP_MODULE_HEADER */
diff --git a/include/lone/lisp/modules/embedded.h b/include/lone/lisp/modules/embedded.h
@@ -0,0 +1,11 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_MODULES_EMBEDDED_HEADER
+#define LONE_LISP_MODULES_EMBEDDED_HEADER
+
+#include <lone/types.h>
+#include <lone/lisp/types.h>
+
+void lone_lisp_modules_embedded_load(struct lone_lisp *lone, lone_elf_segment *values);
+
+#endif /* LONE_LISP_MODULES_EMBEDDED_HEADER */
diff --git a/include/lone/modules/intrinsic.h → include/lone/lisp/modules/intrinsic.h b/include/lone/modules/intrinsic.h → include/lone/lisp/modules/intrinsic.h
@@ -1,22 +1,23 @@
 /* SPDX-License-Identifier: AGPL-3.0-or-later */
 
-#ifndef LONE_MODULES_INTRINSIC_HEADER
-#define LONE_MODULES_INTRINSIC_HEADER
+#ifndef LONE_LISP_MODULES_INTRINSIC_HEADER
+#define LONE_LISP_MODULES_INTRINSIC_HEADER
 
 #include <lone/types.h>
+#include <lone/lisp/types.h>
 
 /* ╭─────────────────────┨ LONE / MODULES / INTRINSIC ┠─────────────────────╮
    │                                                                        │
    │    Initialization for built-in modules with essential functionality.   │
    │                                                                        │
    ╰────────────────────────────────────────────────────────────────────────╯ */
 
-void lone_modules_intrinsic_initialize(
+void lone_lisp_modules_intrinsic_initialize(
 	struct lone_lisp *lone,
 	int argument_count,
 	char **argument_vector,
 	char **environment,
 	struct lone_auxiliary_vector *auxiliary_vector
 );
 
-#endif /* LONE_MODULES_INTRINSIC_HEADER */
+#endif /* LONE_LISP_MODULES_INTRINSIC_HEADER */
diff --git a/include/lone/lisp/modules/intrinsic/bytes.h b/include/lone/lisp/modules/intrinsic/bytes.h
@@ -0,0 +1,33 @@
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
+
+#ifndef LONE_LISP_MODULES_INTRINSIC_BYTES_HEADER
+#define LONE_LISP_MODULES_INTRINSIC_BYTES_HEADER
+
+#include <lone/lisp/definitions.h>
+#include <lone/lisp/types.h>
+
+/* ╭────────────────────────────────────────────────────────────────────────╮
+   │                                                                        │
+   │    Bytes operations.                                                   │
+   │                                                                        │
+   ╰────────────────────────────────────────────────────────────────────────╯ */
+
+void lone_lisp_modules_intrinsic_bytes_initialize(struct lone_lisp *lone);
+
+LONE_LISP_PRIMITIVE(bytes_new);
+
+LONE_LISP_PRIMITIVE(bytes_read_u8);
+LONE_LISP_PRIMITIVE(bytes_read_s8);
+LONE_LISP_PRIMITIVE(bytes_read_u16);
+LONE_LISP_PRIMITIVE(bytes_read_s16);
+LONE_LISP_PRIMITIVE(bytes_read_u32);
+LONE_LISP_PRIMITIVE(bytes_read_s32);
+
+LONE_LISP_PRIMITIVE(bytes_write_u8);
+LONE_LISP_PRIMITIVE(bytes_write_s8);
+LONE_LISP_PRIMITIVE(bytes_write_u16);
+LONE_LISP_PRIMITIVE(bytes_write_s16);
+LONE_LISP_PRIMITIVE(bytes_write_u32);
+LONE_LISP_PRIMITIVE(bytes_write_s32);
+
+#endif /* LONE_LISP_MODULES_INTRINSIC_BYTES_HEADER */
diff --git a/include/lone/modules/intrinsic/linux.h → include/lone/lisp/modules/intrinsic/linux.h b/include/lone/modules/intrinsic/linux.h → include/lone/lisp/modules/intrinsic/linux.h
@@ -1,19 +1,20 @@
 /* SPDX-License-Identifier: AGPL-3.0-or-later */
 
-#ifndef LONE_MODULES_INTRINSIC_LINUX_HEADER
-#define LONE_MODULES_INTRINSIC_LINUX_HEADER
+#ifndef LONE_LISP_MODULES_INTRINSIC_LINUX_HEADER
+#define LONE_LISP_MODULES_INTRINSIC_LINUX_HEADER
 
-#include <lone/definitions.h>
-#include <lone/types.h>
+#include <lone/lisp/definitions.h>
+#include <lone/lisp/types.h>
 
 /* ╭────────────────────────┨ LONE / MODULE / LINUX ┠───────────────────────╮
    │                                                                        │
    │    Linux system calls and process parameters.                          │
    │                                                                        │
    ╰────────────────────────────────────────────────────────────────────────╯ */
 
-void lone_modules_intrinsic_linux_initialize(struct lone_lisp *lone, int argc, char **argv, char **envp, struct lone_auxiliary_vector *auxv);
+void lone_lisp_modules_intrinsic_linux_initialize(struct lone_lisp *lone,
+		int argc, char **argv, char **envp, struct lone_auxiliary_vector *auxv);
 
-LONE_PRIMITIVE(linux_system_call);
+LONE_LISP_PRIMITIVE(linux_system_call);
 
-#endif /* LONE_MODULES_INTRINSIC_LINUX_HEADER */
+#endif /* LONE_LISP_MODULES_INTRINSIC_LINUX_HEADER */