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 Obviously there's more to life than just libraries: one can use
   8 `#[no_std]` with an executable, controlling the entry point is
   9 possible in two ways: the `#[start]` attribute, or overriding the
  10 default shim for the C `main` function with your own.
  11
  12 The function marked `#[start]` is passed the command line parameters
  13 in the same format as C:
  14
  15 ```rust
  16 # #![feature(libc)]
  17 #![feature(lang_items)]
  18 #![feature(start)]
  19 #![feature(no_std)]
  20 #![no_std]
  21
  22 // Pull in the system libc library for what crt0.o likely requires
  23 extern crate libc;
  24
  25 // Entry point for this program
  26 #[start]
  27 fn start(_argc: isize, _argv: *const *const u8) -> isize {
  28     0
  29 }
  30
  31 // These functions and traits are used by the compiler, but not
  32 // for a bare-bones hello world. These are normally
  33 // provided by libstd.
  34 #[lang = "eh_personality"] extern fn eh_personality() {}
  35 #[lang = "panic_fmt"] fn panic_fmt() -> ! { loop {} }
  36 # #[lang = "eh_unwind_resume"] extern fn rust_eh_unwind_resume() {}
  37 # #[no_mangle] pub extern fn rust_eh_register_frames () {}
  38 # #[no_mangle] pub extern fn rust_eh_unregister_frames () {}
  39 # // fn main() {} tricked you, rustdoc!
  40 ```
  41
  42 To override the compiler-inserted `main` shim, one has to disable it
  43 with `#![no_main]` and then create the appropriate symbol with the
  44 correct ABI and the correct name, which requires overriding the
  45 compiler's name mangling too:
  46
  47 ```rust
  48 # #![feature(libc)]
  49 #![feature(no_std)]
  50 #![feature(lang_items)]
  51 #![feature(start)]
  52 #![no_std]
  53 #![no_main]
  54
  55 extern crate libc;
  56
  57 #[no_mangle] // ensure that this symbol is called `main` in the output
  58 pub extern fn main(argc: i32, argv: *const *const u8) -> i32 {
  59     0
  60 }
  61
  62 #[lang = "eh_personality"] extern fn eh_personality() {}
  63 #[lang = "panic_fmt"] fn panic_fmt() -> ! { loop {} }
  64 # #[lang = "eh_unwind_resume"] extern fn rust_eh_unwind_resume() {}
  65 # #[no_mangle] pub extern fn rust_eh_register_frames () {}
  66 # #[no_mangle] pub extern fn rust_eh_unregister_frames () {}
  67 # // fn main() {} tricked you, rustdoc!
  68 ```
  69
  70
  71 The compiler currently makes a few assumptions about symbols which are available
  72 in the executable to call. Normally these functions are provided by the standard
  73 library, but without it you must define your own.
  74
  75 The first of these two functions, `eh_personality`, is used by the
  76 failure mechanisms of the compiler. This is often mapped to GCC's
  77 personality function (see the
  78 [libstd implementation](../std/rt/unwind/index.html) for more
  79 information), but crates which do not trigger a panic can be assured
  80 that this function is never called. The second function, `panic_fmt`, is
  81 also used by the failure mechanisms of the compiler.
  82
  83 ## Using libcore
  84
  85 > **Note**: the core library's structure is unstable, and it is recommended to
  86 > use the standard library instead wherever possible.
  87
  88 With the above techniques, we've got a bare-metal executable running some Rust
  89 code. There is a good deal of functionality provided by the standard library,
  90 however, that is necessary to be productive in Rust. If the standard library is
  91 not sufficient, then [libcore](../core/index.html) is designed to be used
  92 instead.
  93
  94 The core library has very few dependencies and is much more portable than the
  95 standard library itself. Additionally, the core library has most of the
  96 necessary functionality for writing idiomatic and effective Rust code. When
  97 using `#![no_std]`, Rust will automatically inject the `core` crate, just like
  98 we do for `std` when we’re using it.
  99
 100 As an example, here is a program that will calculate the dot product of two
 101 vectors provided from C, using idiomatic Rust practices.
 102
 103 ```rust
 104 # #![feature(libc)]
 105 #![feature(lang_items)]
 106 #![feature(start)]
 107 #![feature(no_std)]
 108 #![feature(core)]
 109 #![feature(core_slice_ext)]
 110 #![feature(raw)]
 111 #![no_std]
 112
 113 extern crate libc;
 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 = "eh_personality"] extern fn eh_personality() {}
 152 # #[start] fn start(argc: isize, argv: *const *const u8) -> isize { 0 }
 153 # #[lang = "eh_unwind_resume"] extern fn rust_eh_unwind_resume() {}
 154 # #[no_mangle] pub extern fn rust_eh_register_frames () {}
 155 # #[no_mangle] pub extern fn rust_eh_unregister_frames () {}
 156 # fn main() {}
 157 ```
 158
 159 Note that there is one extra lang item here which differs from the examples
 160 above, `panic_fmt`. This must be defined by consumers of libcore because the
 161 core library declares panics, but it does not define it. The `panic_fmt`
 162 lang item is this crate's definition of panic, and it must be guaranteed to
 163 never return.
 164
 165 As can be seen in this example, the core library is intended to provide the
 166 power of Rust in all circumstances, regardless of platform requirements. Further
 167 libraries, such as liballoc, add functionality to libcore which make other
 168 platform-specific assumptions, but continue to be more portable than the
 169 standard library itself.
 170