Add additional rustdocs for missing docs found during CI

This commit is contained in:
Brandon Fish
2019-11-10 15:16:07 -06:00
parent 2d00b2589e
commit 82ec5e970a
2 changed files with 9 additions and 0 deletions

View File

@ -377,6 +377,7 @@ pub struct FaultInfo {
pub known_registers: [Option<u64>; 32], pub known_registers: [Option<u64>; 32],
} }
/// Gets fault info for the given siginfo and context pointers.
#[cfg(all(target_os = "linux", target_arch = "x86_64"))] #[cfg(all(target_os = "linux", target_arch = "x86_64"))]
pub unsafe fn get_fault_info(siginfo: *const c_void, ucontext: *const c_void) -> FaultInfo { pub unsafe fn get_fault_info(siginfo: *const c_void, ucontext: *const c_void) -> FaultInfo {
use libc::{ use libc::{

View File

@ -1,3 +1,5 @@
//! The tiering module supports switching between code compiled with different optimization levels
//! as runtime.
use crate::backend::{Compiler, CompilerConfig}; use crate::backend::{Compiler, CompilerConfig};
use crate::compile_with_config; use crate::compile_with_config;
use crate::fault::{ use crate::fault::{
@ -22,12 +24,17 @@ impl<F: FnOnce()> Drop for Defer<F> {
} }
} }
/// Kind of shell exit operation.
pub enum ShellExitOperation { pub enum ShellExitOperation {
/// Operation to continue with an instance image.
ContinueWith(InstanceImage), ContinueWith(InstanceImage),
} }
/// Context for an interactive shell.
pub struct InteractiveShellContext { pub struct InteractiveShellContext {
/// Optional instance image.
pub image: Option<InstanceImage>, pub image: Option<InstanceImage>,
/// Flag to indicate patching.
pub patched: bool, pub patched: bool,
} }
@ -70,6 +77,7 @@ unsafe fn do_optimize(
} }
} }
/// Runs an instance with tiering.
pub unsafe fn run_tiering<F: Fn(InteractiveShellContext) -> ShellExitOperation>( pub unsafe fn run_tiering<F: Fn(InteractiveShellContext) -> ShellExitOperation>(
module_info: &ModuleInfo, module_info: &ModuleInfo,
wasm_binary: &[u8], wasm_binary: &[u8],