kernel: vm: pmap.h -> vm_pmap.h

Signed-off-by: sigsegv7 <ian@vegaa.systems>

1 files changed, 54 insertions, 0 deletions

diff --git a/sys/include/vm/vm_pmap.h b/sys/include/vm/vm_pmap.h
new file mode 100644
index 0000000..8dd6b7d
--- /dev/null
+++ b/sys/include/vm/vm_pmap.h
@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2023 Ian Marco Moffett and the VegaOS team.
+ * 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 VegaOS 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 _VM_PMAP_H_
+#define _VM_PMAP_H_
+
+/*
+ * Each architecture is expected to implement
+ * this header. It should contain a `struct vas'
+ * which will contain information about a VAS
+ * (virtual address space)
+ *
+ * On AMD64 this struct contains: PML4, etc
+ *
+ * XXX: Compiler errors pointing to this include means you
+ *      forgot to implement it!!!
+ *
+ *      `struct vas' MUST have a `struct spinlock lock' field!!!
+ */
+#include <machine/vas.h>
+
+/*
+ * Read virtual address space descriptor
+ * and return it.
+ */
+struct vas pmap_read_vas(void);
+
+#endif  /* _VM_PMAP_H_ */