src/doc/trpl/no-stdlib.md

   1 % No stdlib
   2
   3 By default, `std` is linked to every Rust crate. In some contexts,
   4 this is undesirable, and can be avoided with the `#![no_std]`
   5 attribute attached to the crate.
   6
   7 ```ignore
   8 // a minimal library
   9 #![crate_type="lib"]
  10 #![feature(no_std)]
  11 #![no_std]
  12 # // fn main() {} tricked you, rustdoc!
  13 ```
  14
  15 Obviously there's more to life than just libraries: one can use
  16 `#[no_std]` with an executable, controlling the entry point is
  17 possible in two ways: the `#[start]` attribute, or overriding the
  18 default shim for the C `main` function with your own.
  19
  20 The function marked `#[start]` is passed the command line parameters
  21 in the same format as C:
  22
  23 ```rust
  24 #![feature(lang_items, start, no_std, libc)]
  25 #![no_std]
  26
  27 // Pull in the system libc library for what crt0.o likely requires
  28 extern crate libc;
  29
  30 // Entry point for this program
  31 #[start]
  32 fn start(_argc: isize, _argv: *const *const u8) -> isize {
  33     0
  34 }
  35
  36 // These functions and traits are used by the compiler, but not
  37 // for a bare-bones hello world. These are normally
  38 // provided by libstd.
  39 #[lang = "stack_exhausted"] extern fn stack_exhausted() {}
  40 #[lang = "eh_personality"] extern fn eh_personality() {}
  41 #[lang = "panic_fmt"] fn panic_fmt() -> ! { loop {} }
  42 # // fn main() {} tricked you, rustdoc!
  43 ```
  44
  45 To override the compiler-inserted `main` shim, one has to disable it
  46 with `#![no_main]` and then create the appropriate symbol with the
  47 correct ABI and the correct name, which requires overriding the
  48 compiler's name mangling too:
  49
  50 ```ignore
  51 #![feature(no_std)]
  52 #![no_std]
  53 #![no_main]
  54 #![feature(lang_items, start)]
  55
  56 extern crate libc;
  57
  58 #[no_mangle] // ensure that this symbol is called `main` in the output
  59 pub extern fn main(argc: i32, argv: *const *const u8) -> i32 {
  60     0
  61 }
  62
  63 #[lang = "stack_exhausted"] extern fn stack_exhausted() {}
  64 #[lang = "eh_personality"] extern fn eh_personality() {}
  65 #[lang = "panic_fmt"] fn panic_fmt() -> ! { loop {} }
  66 # // fn main() {} tricked you, rustdoc!
  67 ```
  68
  69
  70 The compiler currently makes a few assumptions about symbols which are available
  71 in the executable to call. Normally these functions are provided by the standard
  72 library, but without it you must define your own.
  73
  74 The first of these three functions, `stack_exhausted`, is invoked whenever stack
  75 overflow is detected.  This function has a number of restrictions about how it
  76 can be called and what it must do, but if the stack limit register is not being
  77 maintained then a thread always has an "infinite stack" and this function
  78 shouldn't get triggered.
  79
  80 The second of these three functions, `eh_personality`, is used by the
  81 failure mechanisms of the compiler. This is often mapped to GCC's
  82 personality function (see the
  83 [libstd implementation](../std/rt/unwind/index.html) for more
  84 information), but crates which do not trigger a panic can be assured
  85 that this function is never called. The final function, `panic_fmt`, is
  86 also used by the failure mechanisms of the compiler.
  87
  88 ## Using libcore
  89
  90 > **Note**: the core library's structure is unstable, and it is recommended to
  91 > use the standard library instead wherever possible.
  92
  93 With the above techniques, we've got a bare-metal executable running some Rust
  94 code. There is a good deal of functionality provided by the standard library,
  95 however, that is necessary to be productive in Rust. If the standard library is
  96 not sufficient, then [libcore](../core/index.html) is designed to be used
  97 instead.
  98
  99 The core library has very few dependencies and is much more portable than the
 100 standard library itself. Additionally, the core library has most of the
 101 necessary functionality for writing idiomatic and effective Rust code.
 102
 103 As an example, here is a program that will calculate the dot product of two
 104 vectors provided from C, using idiomatic Rust practices.
 105
 106 ```ignore
 107 #![feature(lang_items, start, no_std, core, libc)]
 108 #![no_std]
 109
 110 # extern crate libc;
 111 extern crate core;
 112
 113 use core::prelude::*;
 114
 115 use core::mem;
 116
 117 #[no_mangle]
 118 pub extern fn dot_product(a: *const u32, a_len: u32,
 119                           b: *const u32, b_len: u32) -> u32 {
 120     use core::raw::Slice;
 121
 122     // Convert the provided arrays into Rust slices.
 123     // The core::raw module guarantees that the Slice
 124     // structure has the same memory layout as a &[T]
 125     // slice.
 126     //
 127     // This is an unsafe operation because the compiler
 128     // cannot tell the pointers are valid.
 129     let (a_slice, b_slice): (&[u32], &[u32]) = unsafe {
 130         mem::transmute((
 131             Slice { data: a, len: a_len as usize },
 132             Slice { data: b, len: b_len as usize },
 133         ))
 134     };
 135
 136     // Iterate over the slices, collecting the result
 137     let mut ret = 0;
 138     for (i, j) in a_slice.iter().zip(b_slice.iter()) {
 139         ret += (*i) * (*j);
 140     }
 141     return ret;
 142 }
 143
 144 #[lang = "panic_fmt"]
 145 extern fn panic_fmt(args: &core::fmt::Arguments,
 146                     file: &str,
 147                     line: u32) -> ! {
 148     loop {}
 149 }
 150
 151 #[lang = "stack_exhausted"] extern fn stack_exhausted() {}
 152 #[lang = "eh_personality"] extern fn eh_personality() {}
 153 # #[start] fn start(argc: isize, argv: *const *const u8) -> isize { 0 }
 154 # fn main() {}
 155 ```
 156
 157 Note that there is one extra lang item here which differs from the examples
 158 above, `panic_fmt`. This must be defined by consumers of libcore because the
 159 core library declares panics, but it does not define it. The `panic_fmt`
 160 lang item is this crate's definition of panic, and it must be guaranteed to
 161 never return.
 162
 163 As can be seen in this example, the core library is intended to provide the
 164 power of Rust in all circumstances, regardless of platform requirements. Further
 165 libraries, such as liballoc, add functionality to libcore which make other
 166 platform-specific assumptions, but continue to be more portable than the
 167 standard library itself.
 168