platform.h File Reference

#include "mos/interrupt/ipi.h"
#include "mos/misc/cmdline.h"
#include "mos/mm/paging/pml_types.h"
#include "mos/mm/physical/pmm.h"
#include "mos/platform/platform_defs.h"
#include <mos/lib/structures/list.h>
#include <mos/lib/sync/spinlock.h>
#include <mos/mm/mm_types.h>
#include <mos/mos_global.h>
#include <mos/tasks/signal_types.h>

Include dependency graph for platform.h:

Go to the source code of this file.

Classes
struct	mm_context_t
struct	cpu_t
struct	timeval_t
struct	mos_platform_info_t
struct	mos_platform_info_t::cpu

Macros
#define	PER_CPU_DECLARE(type, name)
#define	PER_CPU_VAR_INIT   { .percpu_value = { 0 } }
#define	per_cpu(var)
#define	current_cpu   per_cpu(platform_info->cpu)
#define	current_thread   (current_cpu->thread)
#define	current_process   (current_thread->owner)
#define	current_mm   (current_cpu->mm_context)
#define	MOS_KERNEL_PFN(vaddr)
#define	platform_alias(name)

Typedefs
typedef void(*	irq_handler) (u32 irq)
typedef struct _thread	thread_t
typedef struct _console	console_t
typedef struct _platform_regs	platform_regs_t
typedef struct _platform_process_options	platform_process_options_t
typedef struct _platform_thread_options	platform_thread_options_t
typedef char	datetime_str_t[32]
typedef struct _sigreturn_data	sigreturn_data_t

Enumerations
enum	vm_flags {   VM_READ = MEM_PERM_READ , VM_WRITE = MEM_PERM_WRITE , VM_EXEC = MEM_PERM_EXEC , VM_USER = 1 << 3 ,   VM_WRITE_THROUGH = 1 << 4 , VM_CACHE_DISABLED = 1 << 5 , VM_GLOBAL = 1 << 6 , VM_RW = VM_READ | VM_WRITE ,   VM_RX = VM_READ | VM_EXEC , VM_RWX = VM_READ | VM_WRITE | VM_EXEC , VM_USER_RW = VM_USER | VM_RW , VM_USER_RX = VM_USER | VM_RX ,   VM_USER_RO = VM_USER | VM_READ , VM_USER_RWX = VM_USER | VM_RWX }
enum	thread_state_t {   THREAD_STATE_CREATED , THREAD_STATE_READY , THREAD_STATE_RUNNING , THREAD_STATE_BLOCKED ,   THREAD_STATE_NONINTERRUPTIBLE , THREAD_STATE_DEAD }
enum	switch_flags_t { SWITCH_REGULAR , SWITCH_TO_NEW_USER_THREAD , SWITCH_TO_NEW_KERNEL_THREAD }

Functions
void	mos_start_kernel (void)
void	platform_ap_entry (u64 arg)
void	platform_startup_early ()
void	platform_startup_setup_kernel_mm ()
void	platform_startup_late ()
void	platform_shutdown (void)
void	platform_dump_regs (platform_regs_t *regs)
void	platform_dump_stack (platform_regs_t *regs)
void	platform_dump_current_stack ()
void	platform_dump_thread_kernel_stack (const thread_t *thread)
void	platform_get_time (timeval_t *val)
void	platform_halt_cpu (void)
void	platform_invalidate_tlb (ptr_t vaddr)
u32	platform_current_cpu_id (void)
void	platform_cpu_idle (void)
u64	platform_get_timestamp (void)
datetime_str_t *	platform_get_datetime_str (void)
void	platform_interrupt_enable (void)
void	platform_interrupt_disable (void)
pfn_t	platform_pml1e_get_pfn (const pml1e_t *pml1)
void	platform_pml1e_set_pfn (pml1e_t *pml1, pfn_t pfn)
bool	platform_pml1e_get_present (const pml1e_t *pml1)
void	platform_pml1e_set_flags (pml1e_t *pml1, vm_flags flags)
vm_flags	platform_pml1e_get_flags (const pml1e_t *pml1e)
platform_regs_t *	platform_thread_regs (const thread_t *thread)
void	platform_context_setup_main_thread (thread_t *thread, ptr_t entry, ptr_t sp, int argc, ptr_t argv, ptr_t envp)
void	platform_context_setup_child_thread (thread_t *thread, thread_entry_t entry, void *arg)
void	platform_context_clone (const thread_t *from, thread_t *to)
void	platform_context_cleanup (thread_t *thread)
void	platform_switch_mm (const mm_context_t *new_mm)
void	platform_switch_to_thread (thread_t *current, thread_t *new_thread, switch_flags_t switch_flags)
void	platform_return_to_userspace (platform_regs_t *regs)
u64	platform_arch_syscall (u64 syscall, u64 arg1, u64 arg2, u64 arg3, u64 arg4)
void	platform_ipi_send (u8 target_cpu, ipi_type_t type)
void	platform_jump_to_signal_handler (const platform_regs_t *regs, const sigreturn_data_t *sigreturn_data, const sigaction_t *sa)
void	platform_restore_from_signal_handler (void *sp)
void	platform_syscall_setup_restart_context (platform_regs_t *regs, reg_t syscall_nr)
void	platform_syscall_store_retval (platform_regs_t *regs, reg_t result)

Variables
mos_platform_info_t *const	platform_info
__BEGIN_DECLS const char	__MOS_KERNEL_CODE_START []
__BEGIN_DECLS const char	__MOS_KERNEL_CODE_END []
const char	__MOS_KERNEL_RODATA_START []
const char	__MOS_KERNEL_RODATA_END []
const char	__MOS_KERNEL_RW_START []
const char	__MOS_KERNEL_RW_END []
const char	__MOS_KERNEL_END []

Macro Definition Documentation

PER_CPU_DECLARE

#define PER_CPU_DECLARE	(		type,
			name )

Value:

struct name { type percpu_value[1]; } name

Definition at line 23 of file platform.h.

Referenced by platform_get_datetime_str().

PER_CPU_VAR_INIT

#define PER_CPU_VAR_INIT   { .percpu_value = { 0 } }

Definition at line 24 of file platform.h.

per_cpu

#define per_cpu

(

var

)

Value:

(&(var.percpu_value[0]))

Definition at line 25 of file platform.h.

Referenced by platform_get_datetime_str(), platform_switch_to_thread(), x86_cpu_initialise_caps(), x86_init_percpu_gdt(), and x86_init_percpu_tss().

current_cpu

#define current_cpu   per_cpu(platform_info->cpu)

Definition at line 29 of file platform.h.

Referenced by blocked_reschedule(), elf_setup_main_thread(), mm_dump_current_pagetable(), mm_switch_context(), mos_start_kernel(), platform_ap_entry(), platform_arch_syscall(), platform_startup_late(), platform_switch_to_thread(), reschedule(), reschedule_for_waitlist(), riscv64_trap_handler(), try_handle_kernel_panics_at(), x86_dump_stack_at(), and x86_interrupt_entry().

current_thread

#define current_thread   (current_cpu->thread)

Definition at line 30 of file platform.h.

Referenced by dentry_from_fd(), do_signal_exit_to_user_prepare(), dump_process(), enter_scheduler(), futex_wait(), get_tid(), invalid_page_fault(), io_poll(), ksyscall_enter(), kthread_entry(), mm_dump_current_pagetable(), mm_handle_fault(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), naive_sched_select_next(), pipe_write(), platform_arch_syscall(), platform_arch_syscall(), platform_context_setup_child_thread(), platform_jump_to_signal_handler(), platform_restore_from_signal_handler(), platform_return_to_userspace(), process_do_execveat(), process_do_fork(), process_exit(), process_sysfs_thread_stat(), riscv64_start_kernel_thread(), riscv64_start_user_thread(), riscv64_trap_handler(), signal_do_ignore(), signal_do_terminate(), signal_exit_to_user_prepare(), signal_exit_to_user_prepare_syscall(), signal_get_next_pending(), signal_has_pending(), signal_on_returned(), signal_send_to_thread(), thread_destroy(), timer_msleep(), waitlist_append(), waitlist_remove_me(), x86_handle_exception(), x86_interrupt_entry(), x86_pit_timer_handler(), x86_start_kernel_thread(), and x86_start_user_thread().

current_process

#define current_process   (current_thread->owner)

Definition at line 31 of file platform.h.

Referenced by create_thread(), current_stdio(), dentry_from_fd(), do_signal_exit_to_user_prepare(), dump_process(), execveat(), exit(), fd_manipulate(), fork(), futex_get_key(), get_parent_pid(), get_pid(), invalid_page_fault(), io_close(), io_dup(), io_dup2(), io_pread(), io_read(), io_readv(), io_seek(), io_tell(), io_write(), ipc_accept(), ipc_connect(), ipc_create(), memfd_create(), mm_dump_current_pagetable(), mmap_file(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), MOS_STATIC_ASSERT(), munmap(), platform_arch_syscall(), platform_context_setup_child_thread(), process_destroy(), process_do_execveat(), process_sysfs_process_stat(), process_wait_for_pid(), riscv64_trap_handler(), signal_do_coredump(), signal_do_terminate(), signal_exit_to_user_prepare(), signal_exit_to_user_prepare_syscall(), thread_wait_for_tid(), vfs_chdirat(), vfs_fstatat(), and vfs_ipc_file_read().

current_mm

#define current_mm   (current_cpu->mm_context)

Definition at line 32 of file platform.h.

Referenced by dmabuf_allocate(), dmabuf_free(), mm_handle_fault(), mmap_anonymous(), mmap_file(), MOS_STATIC_ASSERT(), platform_context_setup_child_thread(), process_destroy(), and process_sysfs_vmap_stat().

MOS_KERNEL_PFN

#define MOS_KERNEL_PFN

(

vaddr

)

Value:

((ALIGN_DOWN_TO_PAGE((vaddr) - (platform_info->k_basevaddr)) / MOS_PAGE_SIZE) + (platform_info->k_basepfn))

Definition at line 137 of file platform.h.

Referenced by mos_start_kernel().

platform_alias

#define platform_alias

(

name

)

Value:

__attribute__((alias("platform_default_" #name)))

Definition at line 154 of file platform.h.

Typedef Documentation

irq_handler

typedef void(* irq_handler) (u32 irq)

Definition at line 34 of file platform.h.

console_t

typedef struct _console console_t

Definition at line 37 of file platform.h.

platform_regs_t

typedef struct _platform_regs platform_regs_t

Definition at line 86 of file platform.h.

platform_process_options_t

typedef struct _platform_process_options platform_process_options_t

Definition at line 141 of file platform.h.

platform_thread_options_t

typedef struct _platform_thread_options platform_thread_options_t

Definition at line 142 of file platform.h.

datetime_str_t

typedef char datetime_str_t[32]

Definition at line 184 of file platform.h.

sigreturn_data_t

typedef struct _sigreturn_data sigreturn_data_t

Definition at line 263 of file platform.h.

Enumeration Type Documentation

vm_flags

enum vm_flags

Enumerator
VM_READ
VM_WRITE
VM_EXEC
VM_USER
VM_WRITE_THROUGH
VM_CACHE_DISABLED
VM_GLOBAL
VM_RW
VM_RX
VM_RWX
VM_USER_RW
VM_USER_RX
VM_USER_RO
VM_USER_RWX

Definition at line 39 of file platform.h.

thread_state_t

enum thread_state_t

Enumerator
THREAD_STATE_CREATED	created or forked, but not ever started
THREAD_STATE_READY	thread can be scheduled
THREAD_STATE_RUNNING	thread is currently running
THREAD_STATE_BLOCKED	thread is blocked by a wait condition
THREAD_STATE_NONINTERRUPTIBLE	thread is blocked, and cannot be interrupted
THREAD_STATE_DEAD	thread is dead, and will be cleaned up soon by the scheduler

Definition at line 60 of file platform.h.

switch_flags_t

enum switch_flags_t

Enumerator
SWITCH_REGULAR
SWITCH_TO_NEW_USER_THREAD
SWITCH_TO_NEW_KERNEL_THREAD

Definition at line 70 of file platform.h.

Function Documentation

mos_start_kernel()

void mos_start_kernel ( void )

extern

Definition at line 102 of file kmain.c.

Referenced by limine_entry().

Here is the call graph for this function:

platform_ap_entry()

void platform_ap_entry

(

u64

arg

)

Definition at line 23 of file ap_entry.c.

Referenced by ap_entry().

Here is the call graph for this function:

platform_startup_early()

void platform_startup_early

(

)

Definition at line 47 of file riscv64_platform.c.

Referenced by mos_start_kernel().

Here is the call graph for this function:

platform_startup_setup_kernel_mm()

void platform_startup_setup_kernel_mm

(

)

Definition at line 60 of file riscv64_platform.c.

Referenced by mos_start_kernel().

Here is the call graph for this function:

platform_startup_late()

void platform_startup_late

(

)

Definition at line 79 of file riscv64_platform.c.

Referenced by mos_start_kernel().

Here is the call graph for this function:

platform_shutdown()

void platform_shutdown

(

void

)

Definition at line 34 of file riscv64_platform_api.c.

Referenced by power_shutdown().

Here is the call graph for this function:

platform_dump_regs()

void platform_dump_regs

(

platform_regs_t *

regs

)

Definition at line 51 of file riscv64_platform_api.c.

Referenced by invalid_page_fault(), try_handle_kernel_panics_at(), x86_handle_exception(), and x86_handle_nmi().

platform_dump_stack()

void platform_dump_stack

(

platform_regs_t *

regs

)

Definition at line 290 of file riscv64_platform_api.c.

Referenced by invalid_page_fault(), try_handle_kernel_panics_at(), and x86_handle_exception().

Here is the call graph for this function:

platform_dump_current_stack()

void platform_dump_current_stack

(

)

Definition at line 181 of file x86_platform.c.

Referenced by try_handle_kernel_panics_at(), and x86_handle_exception().

Here is the call graph for this function:

platform_dump_thread_kernel_stack()

void platform_dump_thread_kernel_stack

(

const thread_t *

thread

)

Definition at line 96 of file x86_platform_api.c.

Here is the call graph for this function:

platform_get_time()

void platform_get_time

(

timeval_t *

val

)

Definition at line 197 of file x86_platform_api.c.

Referenced by clock_gettimeofday(), and platform_get_datetime_str().

Here is the call graph for this function:

platform_halt_cpu()

void platform_halt_cpu

(

void

)

Definition at line 65 of file mm.c.

Referenced by mos_test_engine_run_tests(), platform_ap_entry(), and try_handle_kernel_panics_at().

Here is the call graph for this function:

platform_invalidate_tlb()

void platform_invalidate_tlb

(

ptr_t

vaddr

)

Definition at line 72 of file mm.c.

Referenced by pml1e_do_flag_callback(), pml1e_do_map_callback(), pml1e_do_mask_callback(), and pml1e_do_unmap_callback().

Here is the call graph for this function:

platform_current_cpu_id()

u32 platform_current_cpu_id

(

void

)

Definition at line 41 of file riscv64_platform_api.c.

Referenced by do_syslog(), enter_scheduler(), and platform_ap_entry().

platform_cpu_idle()

void platform_cpu_idle

(

void

)

Definition at line 46 of file riscv64_platform_api.c.

Referenced by idle_task(), and platform_shutdown().

platform_get_timestamp()

u64 platform_get_timestamp

(

void

)

Definition at line 61 of file x86_platform_api.c.

Referenced by do_syslog().

Here is the call graph for this function:

platform_get_datetime_str()

datetime_str_t * platform_get_datetime_str

(

void

)

Definition at line 66 of file x86_platform_api.c.

Referenced by do_syslog().

Here is the call graph for this function:

platform_interrupt_enable()

void platform_interrupt_enable

(

void

)

Definition at line 131 of file riscv64_platform_api.c.

Referenced by idle_task().

platform_interrupt_disable()

void platform_interrupt_disable

(

void

)

Definition at line 125 of file riscv64_platform_api.c.

Referenced by platform_shutdown(), and try_handle_kernel_panics_at().

platform_pml1e_get_pfn()

pfn_t platform_pml1e_get_pfn

(

const pml1e_t *

pml1

)

Definition at line 78 of file mm.c.

Referenced by pagetable_iter_next(), pagetable_iterator_start_current_range(), pml1e_do_copy_callback(), pml1e_do_unmap_callback(), and pml1e_get_pfn().

platform_pml1e_set_pfn()

void platform_pml1e_set_pfn	(	pml1e_t *	pml1,
		pfn_t	pfn )

Definition at line 83 of file mm.c.

Referenced by pml1e_do_map_callback().

platform_pml1e_get_present()

bool platform_pml1e_get_present

(

const pml1e_t *

pml1

)

Definition at line 90 of file mm.c.

Referenced by pagetable_iter_next(), pagetable_iterator_start_current_range(), pml1e_do_copy_callback(), pml1e_do_flag_callback(), pml1e_do_mask_callback(), pml1e_do_unmap_callback(), and pml1e_is_present().

platform_pml1e_set_flags()

void platform_pml1e_set_flags	(	pml1e_t *	pml1,
		vm_flags	flags )

Definition at line 95 of file mm.c.

Referenced by pml1e_do_flag_callback(), pml1e_do_map_callback(), and pml1e_do_mask_callback().

Here is the call graph for this function:

platform_pml1e_get_flags()

vm_flags platform_pml1e_get_flags

(

const pml1e_t *

pml1e

)

Definition at line 101 of file mm.c.

Referenced by mm_do_get_flags(), pagetable_iter_next(), pagetable_iterator_start_current_range(), and pml1e_do_mask_callback().

Here is the call graph for this function:

platform_thread_regs()

platform_regs_t * platform_thread_regs

(

const thread_t *

thread

)

Definition at line 64 of file riscv64_platform_api.c.

Referenced by platform_arch_syscall(), platform_arch_syscall(), platform_context_clone(), platform_context_setup_child_thread(), platform_context_setup_main_thread(), process_do_execveat(), riscv64_start_kernel_thread(), riscv64_start_user_thread(), x86_setup_thread_common(), x86_start_kernel_thread(), and x86_start_user_thread().

platform_context_setup_main_thread()

void platform_context_setup_main_thread	(	thread_t *	thread,
		ptr_t	entry,
		ptr_t	sp,
		int	argc,
		ptr_t	argv,
		ptr_t	envp )

Definition at line 75 of file riscv64_platform_api.c.

Referenced by elf_do_fill_process().

Here is the call graph for this function:

platform_context_setup_child_thread()

void platform_context_setup_child_thread	(	thread_t *	thread,
		thread_entry_t	entry,
		void *	arg )

Definition at line 86 of file riscv64_platform_api.c.

Referenced by create_thread(), and kthread_create_no_sched().

Here is the call graph for this function:

platform_context_clone()

void platform_context_clone	(	const thread_t *	from,
		thread_t *	to )

Definition at line 106 of file riscv64_platform_api.c.

Referenced by process_do_fork().

Here is the call graph for this function:

platform_context_cleanup()

void platform_context_cleanup

(

thread_t *

thread

)

Definition at line 119 of file riscv64_platform_api.c.

Referenced by process_do_execveat(), and thread_destroy().

platform_switch_mm()

void platform_switch_mm

(

const mm_context_t *

new_mm

)

Definition at line 137 of file riscv64_platform_api.c.

Referenced by mm_switch_context(), mos_start_kernel(), and platform_ap_entry().

platform_switch_to_thread()

void platform_switch_to_thread	(	thread_t *	current,
		thread_t *	new_thread,
		switch_flags_t	switch_flags )

Definition at line 228 of file riscv64_platform_api.c.

Referenced by reschedule().

Here is the call graph for this function:

platform_return_to_userspace()

void platform_return_to_userspace

(

platform_regs_t *

regs

)

Definition at line 252 of file riscv64_platform_api.c.

Referenced by platform_jump_to_signal_handler(), platform_restore_from_signal_handler(), process_do_execveat(), riscv64_start_user_thread(), riscv64_trap_handler(), and x86_start_user_thread().

Here is the call graph for this function:

platform_arch_syscall()

u64 platform_arch_syscall	(	u64	syscall,
		u64	arg1,
		u64	arg2,
		u64	arg3,
		u64	arg4 )

Definition at line 265 of file riscv64_platform_api.c.

Referenced by arch_syscall().

Here is the call graph for this function:

platform_ipi_send()

void platform_ipi_send	(	u8	target_cpu,
		ipi_type_t	type )

Definition at line 283 of file riscv64_platform_api.c.

Here is the call graph for this function:

platform_jump_to_signal_handler()

void platform_jump_to_signal_handler	(	const platform_regs_t *	regs,
		const sigreturn_data_t *	sigreturn_data,
		const sigaction_t *	sa )

Definition at line 314 of file riscv64_platform_api.c.

Referenced by do_signal_exit_to_user_prepare().

Here is the call graph for this function:

platform_restore_from_signal_handler()

void platform_restore_from_signal_handler

(

void *

sp

)

Definition at line 331 of file riscv64_platform_api.c.

Referenced by MOS_STATIC_ASSERT().

Here is the call graph for this function:

platform_syscall_setup_restart_context()

void platform_syscall_setup_restart_context	(	platform_regs_t *	regs,
		reg_t	syscall_nr )

Definition at line 303 of file riscv64_platform_api.c.

Referenced by signal_exit_to_user_prepare_syscall().

platform_syscall_store_retval()

void platform_syscall_store_retval	(	platform_regs_t *	regs,
		reg_t	result )

Definition at line 309 of file riscv64_platform_api.c.

Referenced by signal_exit_to_user_prepare_syscall().

Variable Documentation

platform_info

mos_platform_info_t* const platform_info

extern

Definition at line 15 of file riscv64_platform.c.

Referenced by add_to_memmap(), cmdline_get_option(), create_idle_task(), initrd_read(), limine_entry(), mm_create_context(), mm_destroy_context(), mm_dump_current_pagetable(), mm_sysfs_init(), mos_cmdline_init(), mos_start_kernel(), platform_ap_entry(), platform_context_clone(), platform_startup_early(), platform_startup_late(), platform_startup_setup_kernel_mm(), pmm_find_reserved_region(), pmm_init(), process_allocate(), setup_xsave_slab(), vmap_create(), x86_cpu_initialise_caps(), x86_cpu_setup_xsave_area(), x86_paging_setup(), and x86_setup_direct_map().

__MOS_KERNEL_CODE_START

__BEGIN_DECLS const char __MOS_KERNEL_CODE_START[]

extern

Referenced by mos_start_kernel(), and x86_handle_exception().

__MOS_KERNEL_CODE_END

__BEGIN_DECLS const char __MOS_KERNEL_CODE_END[]

Definition at line 147 of file platform.h.

Referenced by mos_start_kernel(), and x86_handle_exception().

__MOS_KERNEL_RODATA_START

const char __MOS_KERNEL_RODATA_START[]

extern

Referenced by mos_start_kernel().

__MOS_KERNEL_RODATA_END

const char __MOS_KERNEL_RODATA_END[]

Definition at line 148 of file platform.h.

Referenced by mos_start_kernel().

__MOS_KERNEL_RW_START

const char __MOS_KERNEL_RW_START[]

extern

Referenced by mos_start_kernel().

__MOS_KERNEL_RW_END

const char __MOS_KERNEL_RW_END[]

Definition at line 149 of file platform.h.

Referenced by mos_start_kernel().

__MOS_KERNEL_END

const char __MOS_KERNEL_END[]

extern