Bootable kernel skeleton

src/lib.rs

@@ -11,31 +11,37 @@
 //! `open(path: &str, flags: usize) -> Result<file_descriptor: usize>`
 //!
 //! Open a file, providing a path as a `&str` and flags, defined elsewhere.
+//!
 //! Returns a number, known as a file descriptor, that is passed to other syscalls
 //!
 //! ### Close
 //! `close(file_descriptor: usize) -> Result<()>`
 //!
 //! Close a file descriptor, providing the file descriptor from `open`
+//!
 //! Returns an error, `EBADF`, if the file descriptor was not found.
+//!
 //! This potential error is often ignored by userspace
 //!
 //! ### Duplicate
 //! `dup(file_descriptor: usize) -> Result<file_descriptor: usize>`
 //!
 //! Duplicate a file descriptor, providing the file descriptor from `open`
+//!
 //! Returns a new file descriptor, or an error
 //!
 //! ### Read
 //! `read(file_descriptor: usize, buffer: &mut [u8]) -> Result<count: usize>`
 //!
 //! Read from a file descriptor, providing the file descriptor from `open` and a mutable buffer
+//!
 //! Returns the number of bytes actually read, or an error
 //!
 //! ### Write
 //! `write(file_descriptor: usize, buffer: &[u8]) -> Result<count: usize>`
 //!
 //! Write to a file descriptor, providing the file descriptor from `open` and a const buffer
+//!
 //! Returns the number of bytes actually written, or an error
 //!
 //! ### Stat
@@ -43,12 +49,34 @@
 //!
 //! Get information from a file descriptor, providing the file descriptor from `open`
 //! and a mutable Stat struct, defined elsewhere.
+//!
 //! Returns an error if the operation failed
 //!
 //! ### Path
 //! `fpath(file_descriptor: usize, buffer: &mut [u8]) -> Result<count: usize>`
 //!
-//! Read the path of a file descriptor, providing the file descriptor from `open`
-//! and a mutable buffer. The buffer should be 4096 bytes, to ensure that the
-//! entire path will fit.
+//! Read the path of a file descriptor, providing the file descriptor from `open` and
+//! a mutable buffer.
+//!
 //! Returns the number of bytes actually read, or an error
+//!
+//! The buffer should be 4096 bytes, to ensure that the entire path will fit.
+//! An error will be returned, `ENOBUFS`, if the buffer is not long enough for the name.
+//! In this case, it is recommended to add one page, 4096 bytes, to the buffer and retry.
+
+#![feature(asm)]
+#![feature(lang_items)]
+#![feature(naked_functions)]
+#![no_std]
+
+/// Architecture specific items
+pub mod arch;
+
+#[cfg(not(test))]
+#[lang = "eh_personality"]
+extern "C" fn eh_personality() {}
+
+#[cfg(not(test))]
+/// Required to handle panics
+#[lang = "panic_fmt"]
+extern "C" fn panic_fmt() -> ! {loop{}}