Struct kernel::process::ProcessStandard

pub struct ProcessStandard<'a, C: 'static + Chip> { /* fields omitted */ }

A type for userspace processes in Tock.

Trait Implementations

impl<C: Chip> Process for ProcessStandard<'_, C>

fn processid(&self) -> ProcessId

Returns the process’s identifier.

fn enqueue_task(&self, task: Task) -> Result<(), ErrorCode>

Queue a Task for the process. This will be added to a per-process buffer and executed by the scheduler. Tasks are some function the app should run, for example a upcall or an IPC call.

fn ready(&self) -> bool

Returns whether this process is ready to execute.

fn remove_pending_upcalls(&self, upcall_id: UpcallId)

Remove all scheduled upcalls for a given upcall id from the task queue.

fn get_state(&self) -> State

Returns the current state the process is in. Common states are “running” or “yielded”.

fn set_yielded_state(&self)

Move this process from the running state to the yielded state.

fn stop(&self)

Move this process from running or yielded state into the stopped state.

fn resume(&self)

Move this stopped process back into its original state.

fn set_fault_state(&self)

Put this process in the fault state. This will trigger the FaultResponse for this process to occur.

fn try_restart(&self, completion_code: Option<u32>)

Terminates and attempts to restart the process. The process and current application always terminate. The kernel may, based on its own policy, restart the application using the same process, reuse the process for another application, or simply terminate the process and application.

fn terminate(&self, completion_code: Option<u32>)

Stop and clear a process’s state, putting it into the Terminated state.

fn get_restart_count(&self) -> usize

Returns how many times this process has been restarted.

fn has_tasks(&self) -> bool

Return if there are any Tasks (upcalls/IPC requests) enqueued for the process.

fn dequeue_task(&self) -> Option<Task>

Remove the scheduled operation from the front of the queue and return it to be handled by the scheduler.

fn pending_tasks(&self) -> usize

Returns the number of pending tasks. If 0 then dequeue_task() will return None when called.

fn mem_start(&self) -> *const u8

The start address of allocated RAM for this process.

fn mem_end(&self) -> *const u8

The first address after the end of the allocated RAM for this process.

fn flash_start(&self) -> *const u8

The start address of the flash region allocated for this process.

fn flash_non_protected_start(&self) -> *const u8

Get the first address of process’s flash that isn’t protected by the kernel. The protected range of flash contains the TBF header and potentially other state the kernel is storing on behalf of the process, and cannot be edited by the process.

fn flash_end(&self) -> *const u8

The first address after the end of the flash region allocated for this process.

fn kernel_memory_break(&self) -> *const u8

The lowest address of the grant region for the process.

fn number_writeable_flash_regions(&self) -> usize

How many writeable flash regions defined in the TBF header for this process.

fn get_writeable_flash_region(&self, region_index: usize) -> (u32, u32)

Get the offset from the beginning of flash and the size of the defined writeable flash region.

fn update_stack_start_pointer(&self, stack_pointer: *const u8)

Debug function to update the kernel on where the stack starts for this process. Processes are not required to call this through the memop system call, but it aids in debugging the process.

fn update_heap_start_pointer(&self, heap_pointer: *const u8)

Debug function to update the kernel on where the process heap starts. Also optional.

fn app_memory_break(&self) -> *const u8

Return the highest address the process has access to, or the current process memory brk.

fn setup_mpu(&self)

Configure the MPU to use the process’s allocated regions.

fn add_mpu_region(
    &self,
    unallocated_memory_start: *const u8,
    unallocated_memory_size: usize,
    min_region_size: usize
) -> Option<Region>

Allocate a new MPU region for the process that is at least min_region_size bytes and lies within the specified stretch of unallocated memory.

fn remove_mpu_region(&self, region: Region) -> Result<(), ErrorCode>

Removes an MPU region from the process that has been previouly added with add_mpu_region.

fn sbrk(&self, increment: isize) -> Result<*const u8, Error>

Change the location of the program break, reallocate the MPU region covering program memory, and return the previous break address.

fn brk(&self, new_break: *const u8) -> Result<*const u8, Error>

Change the location of the program break and reallocate the MPU region covering program memory.

fn build_readwrite_process_buffer(
    &self,
    buf_start_addr: *mut u8,
    size: usize
) -> Result<ReadWriteProcessBuffer, ErrorCode>

Creates a ReadWriteProcessBuffer from the given offset and size in process memory.

fn build_readonly_process_buffer(
    &self,
    buf_start_addr: *const u8,
    size: usize
) -> Result<ReadOnlyProcessBuffer, ErrorCode>

Creates a ReadOnlyProcessBuffer from the given offset and size in process memory.

unsafe fn set_byte(&self, addr: *mut u8, value: u8) -> bool

Set a single byte within the process address space at addr to value. Return true if addr is within the RAM bounds currently exposed to the process (thereby writable by the process itself) and the value was set, false otherwise.

fn grant_is_allocated(&self, grant_num: usize) -> Option<bool>

Check if a given grant for this process has been allocated.

fn allocate_grant(
    &self,
    grant_num: usize,
    driver_num: usize,
    size: usize,
    align: usize
) -> Option<NonNull<u8>>

Allocate memory from the grant region and store the reference in the proper grant pointer index.

fn allocate_custom_grant(
    &self,
    size: usize,
    align: usize
) -> Option<(ProcessCustomGrantIdentifer, NonNull<u8>)>

Allocate memory from the grant region that is size bytes long and aligned to align bytes. This is used for creating custom grants which are not recorded in the grant pointer array, but are useful for capsules which need additional process-specific dynamically allocated memory.

fn enter_grant(&self, grant_num: usize) -> Result<*mut u8, Error>

Enter the grant based on grant_num for this process.

fn enter_custom_grant(
    &self,
    identifier: ProcessCustomGrantIdentifer
) -> Result<*mut u8, Error>

Enter a custom grant based on the identifier.

fn leave_grant(&self, grant_num: usize)

Opposite of enter_grant(). Used to signal that the grant is no longer entered.

fn grant_allocated_count(&self) -> Option<usize>

Return the count of the number of allocated grant pointers if the process is active. This does not count custom grants.

fn lookup_grant_from_driver_num(
    &self,
    driver_num: usize
) -> Result<usize, Error>

Get the grant number (grant_num) associated with a given driver number if there is a grant associated with that driver_num.

fn is_valid_upcall_function_pointer(&self, upcall_fn: NonNull<()>) -> bool

Verify that an Upcall function pointer is within process-accessible memory.

fn get_process_name(&self) -> &'static str

Get the name of the process. Used for IPC.

fn set_syscall_return_value(&self, return_value: SyscallReturn)

Set the return value the process should see when it begins executing again after the syscall.

fn set_process_function(&self, callback: FunctionCall)

Set the function that is to be executed when the process is resumed.

fn switch_to(&self) -> Option<ContextSwitchReason>

Context switch to a specific process.

fn debug_syscall_count(&self) -> usize

Returns how many syscalls this app has called.

fn debug_dropped_upcall_count(&self) -> usize

Returns how many upcalls for this process have been dropped.

fn debug_timeslice_expiration_count(&self) -> usize

Returns how many times this process has exceeded its timeslice.

fn debug_timeslice_expired(&self)

Increment the number of times the process has exceeded its timeslice.

fn debug_syscall_called(&self, last_syscall: Syscall)

Increment the number of times the process called a syscall and record the last syscall that was called.

fn debug_heap_start(&self) -> Option<*const u8>

Return the address of the start of the process heap, if known.

fn debug_stack_start(&self) -> Option<*const u8>

Return the address of the start of the process stack, if known.

fn debug_stack_end(&self) -> Option<*const u8>

Return the lowest recorded address of the process stack, if known.

fn get_addresses(&self) -> ProcessAddresses

Return process state information related to the location in memory of various process data structures.

fn get_sizes(&self) -> ProcessSizes

Return process state information related to the size in memory of various process data structures.

fn print_memory_map(&self, writer: &mut dyn Write)

Print out the memory map (Grant region, heap, stack, program memory, BSS, and data sections) of this process.

fn print_full_process(&self, writer: &mut dyn Write)

Print out the full state of the process: its memory map, its context, and the state of the memory protection unit (MPU).