kern: Add traprame related MD headers

Signed-off-by: Ian Moffett <ian@osmora.org>

2 files changed, 220 insertions, 0 deletions

diff --git a/src/sys/include/arch/amd64/frame.h b/src/sys/include/arch/amd64/frame.h
new file mode 100644
index 0000000..62c46d5
--- /dev/null
+++ b/src/sys/include/arch/amd64/frame.h
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the project nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _MACHINE_FRAME_H_
+#define _MACHINE_FRAME_H_ 1
+
+#include <sys/types.h>
+
+/*
+ * Every time we are trapped into the kernel due
+ * to an interrupt, a trapframe will be created
+ * storing the current processor register state
+ * so that it may be restored later.
+ */
+struct trapframe {
+    uint64_t trapno;
+    uint64_t rax;
+    uint64_t rcx;
+    uint64_t rdx;
+    uint64_t rbx;
+    uint64_t rsi;
+    uint64_t rdi;
+    uint64_t rbp;
+    uint64_t r8;
+    uint64_t r9;
+    uint64_t r10;
+    uint64_t r11;
+    uint64_t r12;
+    uint64_t r13;
+    uint64_t r14;
+    uint64_t r15;
+    /* pushed by hardware */
+    uint64_t error_code;
+    uint64_t rip;
+    uint64_t cs;
+    uint64_t rflags;
+    uint64_t rsp;
+    uint64_t ss;
+};
+
+#endif /* _MACHINE_FRAME_H_ */
diff --git a/src/sys/include/arch/amd64/frameasm.h b/src/sys/include/arch/amd64/frameasm.h
new file mode 100644
index 0000000..083acce
--- /dev/null
+++ b/src/sys/include/arch/amd64/frameasm.h
@@ -0,0 +1,153 @@
+/*
+ * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the project nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _MACHINE_FRAMEASM_H_
+#define _MACHINE_FRAMEASM_H_ 1
+
+/*
+ * If the interrupt has an error code, this macro shall
+ * be used to create the trapframe.
+ *
+ * XXX: A trapframe created with this must be popped with
+ *      pop_trapframe_ec
+ */
+#define PUSH_TRAPFRAME_EC(TRAPNO) \
+    push %r15                   ; \
+    push %r14                   ; \
+    push %r13                   ; \
+    push %r12                   ; \
+    push %r11                   ; \
+    push %r10                   ; \
+    push %r9                    ; \
+    push %r8                    ; \
+    push %rbp                   ; \
+    push %rdi                   ; \
+    push %rsi                   ; \
+    push %rbx                   ; \
+    push %rdx                   ; \
+    push %rcx                   ; \
+    push %rax                   ; \
+    push TRAPNO
+
+/*
+ * If the interrupt has an error code, this macro shall
+ * be used to cleanup the trapframe.
+ */
+#define POP_TRAPFRAME_EC                  \
+    add $8, %rsp        /* Trapno */    ; \
+    pop %rax                            ; \
+    pop %rcx                            ; \
+    pop %rdx                            ; \
+    pop %rbx                            ; \
+    pop %rsi                            ; \
+    pop %rdi                            ; \
+    pop %rbp                            ; \
+    pop %r8                             ; \
+    pop %r9                             ; \
+    pop %r10                            ; \
+    pop %r11                            ; \
+    pop %r12                            ; \
+    pop %r13                            ; \
+    pop %r14                            ; \
+    pop %r15
+
+/*
+ * If the interrupt has no error code, this macro
+ * shall be used to create the trapframe.
+ *
+ * XXX: A trapframe created with this must be popped
+ *      with pop_trapframe
+ */
+#define PUSH_TRAPFRAME(TRAPNO)   \
+    push $0                    ;\
+    PUSH_TRAPFRAME_EC(TRAPNO)
+
+/*
+ * If the interrupt has no error code, this macro shall
+ * be used to cleanup the trapframe.
+ */
+#define POP_TRAPFRAME    \
+    POP_TRAPFRAME_EC   ;\
+    add $8, %rsp
+
+#define INTR_ENTRY(NAME)            \
+    NAME:                           \
+        testq $0x3, 8(%rsp)        ;\
+        jz 1f                      ;\
+        lfence                     ;\
+        swapgs                     ;\
+    1:  PUSH_TRAPFRAME($0)         ;\
+
+#define INTR_EXIT(NAME)             \
+    NAME##_exit:                    \
+        POP_TRAPFRAME              ;\
+        testq $0x3, 8(%rsp)        ;\
+        jz 2f                      ;\
+        lfence                     ;\
+        swapgs                     ;\
+    2:  iretq
+
+#define TRAP_ENTRY_EC(NAME, TRAPNO) \
+    NAME:                           \
+        cli                        ;\
+        testq $0x3, 16(%rsp)       ;\
+        jz 1f                      ;\
+        lfence                     ;\
+        swapgs                     ;\
+    1:  PUSH_TRAPFRAME_EC(TRAPNO)  ;\
+
+#define TRAP_EXIT_EC(NAME)          \
+    NAME##_exit:                   ;\
+        POP_TRAPFRAME_EC           ;\
+        testq $0x3, 16(%rsp)       ;\
+        jz 2f                      ;\
+        lfence                     ;\
+        swapgs                     ;\
+        sti                        ;\
+    2:  iretq
+
+#define TRAP_ENTRY(NAME, TRAPNO)    \
+    NAME:                           \
+        cli                        ;\
+        testq $0x3, 8(%rsp)        ;\
+        jz 1f                      ;\
+        lfence                     ;\
+        swapgs                     ;\
+    1:  PUSH_TRAPFRAME(TRAPNO)     ;\
+
+#define TRAP_EXIT(NAME)             \
+        POP_TRAPFRAME_EC           ;\
+        testq $0x3, 16(%rsp)       ;\
+        jz 2f                      ;\
+        lfence                     ;\
+        swapgs                     ;\
+        sti                        ;\
+    2:  iretq
+
+#endif  /* !_MACHINE_FRAMEASM_H_ */