Crate starina_api

Starina standard library for applications.

This is libstd in Starina. All components except the kernel use this library.

APIs you should to know

Here are the most frequently used APIs that you will encounter first:

• info!, warn!, error!, debug!, trace!: Logging macros.
• Channel: A channel for inter-process communication.
• Environ: Environment variables in Starina.

Server APIs

Servers are long-running processes that provide services to clients, such as device drivers, filesystem drivers, TCP/IP stack, and so on.

• Mainloop: An event loop for applications.

Device driver APIs

In Starina, device drivers are servers with the hardware access. To control the hardware conveniently, Starina provides the following APIs:

• MappedFolio: A physically-contiguous memory region for DMA/MMIO access.
• Interrupt: Hardware interrupt handling.
• starina_driver_utils::mmio: Type-safe MMIO access.
• starina_driver_utils::DmaBufferPool: The DMA buffer pool allocator.

Prelude

The prelude module contains the most common types and traits that you’ll use in Starina programs. Here is an idiomatic way to import the prelude:

use starina_api::prelude::*;

Re-exports

• pub use starina_types as types;

Modules

• channel
  A message-passing channel.
• collections
  Collections. HashMap, HashSet, VecDeque, BinaryHeap, and more.
• environ
  Environ, a collection of key-value pairs passed to the application.
• folio
  A contiguous page-aliged memory block.
• handle
  Kernel object handle types.
• interrupt
  A hardware interrupt object.
• log
  Logging utilities.
• mainloop
  The mainloop for applications.
• poll
  A polling API, similar to Linux’s epoll.
• prelude
  Frequently used types and traits.
• print
  Low-level printing utilities.
• signal
  A semaphore-like API.
• sync
  Synchronization primitives such as Arc and Weak.
• syscall
  Low-level system call interfaces.
• vmspace
  A virtual address space object.

Macros

• autogen
  Embeds the code generated by starina_autogen crate.
• debug
  Logs with LogLevel::Debug.
• debug_warn
  Similar to warn!, but only logs in debug mode.
• error
  Logs with LogLevel::Error.
• info
  Logs with LogLevel::Info.
• log
  Logs a message.
• print
  Prints a string without a newline.
• println
  Prints a string and a newline.
• trace
  Logs with LogLevel::Trace.
• warn
  Logs with LogLevel::Warn.