An open API service indexing awesome lists of open source software.

https://github.com/rcore-os/trapframe-rs

Handle TrapFrame across kernel and user space on multiple ISAs.
https://github.com/rcore-os/trapframe-rs

bare-metal interrupt multiple-architectures operating-system rust

Last synced: 12 days ago
JSON representation

Handle TrapFrame across kernel and user space on multiple ISAs.

Awesome Lists containing this project

README

        

# TrapFrame-rs

[![Crate](https://img.shields.io/crates/v/trapframe.svg)](https://crates.io/crates/trapframe)
[![Docs](https://docs.rs/trapframe/badge.svg)](https://docs.rs/trapframe)
[![Actions Status](https://github.com/rcore-os/trapframe-rs/workflows/CI/badge.svg)](https://github.com/rcore-os/trapframe-rs/actions)

Handle Trap Frame across kernel and user space on multiple ISAs.

Supported ISA: x86_64, aarch64, riscv32, riscv64, mipsel

## Example

### Go to user space

```rust
use trapframe::{UserContext, GeneralRegs};

fn kernel_thread() {
// initialize trap handling
unsafe {
trapframe::init();
}
// construct a user space context, set registers
let mut context = UserContext {
general: GeneralRegs {
rip: 0x1000,
rsp: 0x10000,
..Default::default()
},
..Default::default()
};
// go to user space with the context
context.run();
// come back from user space, maybe syscall or trap
println!("back from user: {:#x?}", context);
// check the context and handle the trap
match context.trap_num {
0x3 => println!("breakpoint"),
0xd => println!("general protection fault"),
0x100 => println!("syscall: id={}", context.general.rax),
...
}
}
```

### Handle kernel trap

```rust
use trapframe::TrapFrame;

#[no_mangle] // export a function 'trap_handler'
extern "sysv64" fn trap_handler(tf: &mut TrapFrame) {
match tf.trap_num {
0x3 => {
println!("TRAP: Breakpoint");
tf.rip += 1;
}
_ => panic!("TRAP: {:#x?}", tf),
}
}
```

### More examples

* [x86_64](./examples/uefi)
* [RISC-V](./examples/riscv)

## Internal

Control flow on x86_64:

![x86_64](./docs/x86_64.svg)