include_2core_2arch_8h_source.html

#ifndef _CORE_ARCH_H

#define _CORE_ARCH_H


/*

 * The functions every architecture provides to the generic kernel, in

 * arch/ARCH/. See docs/kernel/architecture.md for how the kernel and the

 * architecture meet.

 */


#include <core/types.h>

#include <sys/proc.h>

#include <dev/irq.h>


/* arch/ARCH/sys/proc.c */


void arch_proc_init(struct proc *proc);


void arch_sleep(void);


/* arch/ARCH/sys/thread.c */


int  arch_thread_create(struct thread *thread, uintptr_t stack, uintptr_t entry, uintptr_t uentry, uintptr_t arg);


void arch_kthread_create(struct thread *thread, uintptr_t entry);


void arch_thread_kill(struct thread *thread);


void arch_thread_spawn(struct thread *thread);


void arch_thread_switch(struct thread *thread);


void arch_idle(void);


/* arch/ARCH/sys/fork.c */


int arch_proc_fork(struct thread *thread, struct proc *fork);


/* arch/ARCH/sys/syscall.c */


void arch_syscall_return(struct thread *thread, uintptr_t val);


/* arch/ARCH/sys/sched.c */


void arch_sched_init(void);


void arch_cur_thread_kill(void);


void arch_yield(void);


/* arch/ARCH/sys/execve.c */


void arch_exec_start(struct thread *thread, uintptr_t entry, uintptr_t sp);


/* arch/ARCH/sys/signal.c */


void arch_sigreturn(void);


int  arch_sigcode_map(struct proc *proc);


/* arch/ARCH/mm/ */


void arch_mm_setup(void);


paddr_t arch_page_get_mapping(struct pmap *pmap, vaddr_t vaddr);


void *arch_phys_map(uintptr_t paddr, size_t size);


void *arch_mmio_map(uintptr_t paddr, size_t size);


/* Allocates an IRQ for a device's MSI, with its handler, and returns the

 * message the device must write (address, data). It is weak: an

 * architecture whose interrupt controller takes no MSI doesn't have it. */

int arch_msi_alloc(irq_handler_t handler, void *arg, uint64_t *addr, uint32_t *data) __attribute__((weak));


void arch_reboot(void);


void arch_halt(void) __attribute__((noreturn));


void arch_poweroff(void) __attribute__((noreturn));


uint64_t arch_rtime_ns(void);


uint64_t arch_rtime_us(void);


uint64_t arch_rtime_ms(void);


uint64_t arch_cycles(void);


int arch_time_get(struct timespec *ts);


void arch_stack_trace(void);


#endif /* ! _CORE_ARCH_H */

arch_stack_trace
void arch_stack_trace(void)
Prints the stack trace of the running code, for a panic: the return address of each frame.
Definition trace.c:14

arch_msi_alloc
int arch_msi_alloc(irq_handler_t handler, void *arg, uint64_t *addr, uint32_t *data)
Gets an IRQ for a device's MSI, and installs its handler.
Definition apic.c:271

paddr_t
uint64_t paddr_t
Definition mm.h:39

vaddr_t
uint64_t vaddr_t
Definition mm.h:40

arch_exec_start
void arch_exec_start(struct thread *thread, uintptr_t entry, uintptr_t sp)
Sets up a thread to start a new program when it next returns to user mode: at its entry point,...
Definition execve.c:15

arch_proc_fork
int arch_proc_fork(struct thread *thread, struct proc *fork)
Sets up the CPU state of a fork() child's thread: a copy of the parent's kernel stack,...
Definition fork.c:21

arch_proc_init
void arch_proc_init(struct proc *proc)
Sets up the architecture's part of a new process's thread (init's, at boot): its kernel stack,...
Definition proc.c:19

arch_yield
void arch_yield(void)
Puts the current thread at the end of the ready list, and runs the next ready thread.
Definition sched.c:94

arch_idle
void arch_idle(void)
Makes this CPU idle, on its idle stack, until an interrupt makes a thread ready.
Definition sched.c:62

arch_sleep
void arch_sleep(void)
Puts the current thread to sleep.
Definition sched.c:101

arch_cur_thread_kill
void arch_cur_thread_kill(void)
Ends the current thread.
Definition sched.c:87

arch_sched_init
void arch_sched_init(void)
Starts the timer tick on every CPU, and the clock where it needs to be started.
Definition sched.c:43

arch_sigreturn
void arch_sigreturn(void)
Returns from a signal handler, for sigreturn(): restores the registers, the signal mask and the FPU s...
Definition signal.c:247

arch_sigcode_map
int arch_sigcode_map(struct proc *proc)
Maps the page with the code that calls sigreturn() (the sigcode) into a process's new address space.
Definition signal.c:107

arch_syscall_return
void arch_syscall_return(struct thread *thread, uintptr_t val)
Sets the result of a thread's system call, in the register that returns it to user mode.
Definition syscall.c:43

arch_thread_create
int arch_thread_create(struct thread *thread, uintptr_t stack, uintptr_t entry, uintptr_t uentry, uintptr_t arg)
Sets up a new user thread's CPU state and kernel stack, for pthread_create().
Definition thread.c:92

arch_kthread_create
void arch_kthread_create(struct thread *thread, uintptr_t entry)
Sets up a kernel thread's CPU state.
Definition thread.c:113

arch_thread_switch
void arch_thread_switch(struct thread *thread)
Switches to a thread that has run before: its address space, its kernel stack, then where it stopped.
Definition thread.c:76

arch_thread_kill
void arch_thread_kill(struct thread *thread)
Frees a thread's CPU state and kernel stack.
Definition thread.c:133

arch_thread_spawn
void arch_thread_spawn(struct thread *thread)
Runs a thread for the first time: switches to its address space and kernel stack, and starts it.
Definition thread.c:63

irq.h

irq_handler_t
void(*) irq_handler_t(void *arg)
Definition irq.h:21

arch_page_get_mapping
paddr_t arch_page_get_mapping(struct pmap *pmap, vaddr_t vaddr)
Finds the page mapped at a virtual address of an address space.
Definition pmap.c:431

arch_phys_map
void * arch_phys_map(uintptr_t paddr, size_t size)
Returns a kernel address for a range of physical memory: its address in the direct map if it's there,...
Definition pmap.c:497

arch_mm_setup
void arch_mm_setup(void)
Finishes setting up memory at boot, once mm_setup() has set up the page structures and the buddy allo...
Definition pmap.c:514

arch_mmio_map
void * arch_mmio_map(uintptr_t paddr, size_t size)
Maps a device's registers into the kernel's address space, uncached (memory-mapped I/O).
Definition pmap.c:508

proc.h

arch_reboot
void arch_reboot(void)
Restarts the machine.
Definition psci.c:25

arch_halt
void arch_halt(void)
Stops the CPU for good, with interrupts off.
Definition psci.c:38

arch_poweroff
void arch_poweroff(void)
Powers the machine off, or halts it if it can't be powered off.
Definition psci.c:31

arch_time_get
int arch_time_get(struct timespec *ts)
Reads the date and time from the real time clock.
Definition rtc.c:16

uintptr_t
__SIZE_TYPE__ uintptr_t
Definition stddef.h:12

uint32_t
unsigned int uint32_t
Definition stddef.h:22

uint64_t
unsigned long long int uint64_t
Definition stddef.h:23

handler
An installed handler, on its interrupt's list.
Definition irq.c:19

pmap
An address space's page tables, on x86.
Definition pmap.h:9

proc
A process.
Definition proc.h:75

thread
A thread.
Definition thread.h:23

timespec
Definition types.h:30

arch_rtime_ns
uint64_t arch_rtime_ns(void)
Reads the monotonic clock, which starts at boot.
Definition timer.c:56

arch_rtime_us
uint64_t arch_rtime_us(void)
Reads the monotonic clock, in microseconds.
Definition timer.c:65

arch_rtime_ms
uint64_t arch_rtime_ms(void)
Reads the monotonic clock, in milliseconds.
Definition timer.c:73

arch_cycles
uint64_t arch_cycles(void)
Reads a counter that changes as fast as the CPU runs, which the kernel uses as a source of randomness...
Definition timer.c:82

types.h