src/rtstartup/rsbegin.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 // rsbegin.o and rsend.o are the so called "compiler runtime startup objects".
  12 // They contain code needed to correctly initialize the compiler runtime.
  13 //
  14 // When an executable or dylib image is linked, all user code and libraries are
  15 // "sandwiched" between these two object files, so code or data from rsbegin.o
  16 // become first in the respective sections of the image, whereas code and data
  17 // from rsend.o become the last ones.  This effect can be used to place symbols
  18 // at the beginning or at the end of a section, as well as to insert any required
  19 // headers or footers.
  20 //
  21 // Note that the actual module entry point is located in the C runtime startup
  22 // object (usually called `crtX.o), which then invokes initialization callbacks
  23 // of other runtime components (registered via yet another special image section).
  24
  25 #![crate_type="rlib"]
  26 #![no_std]
  27 #![allow(non_camel_case_types)]
  28
  29 #[cfg(all(target_os="windows", target_arch = "x86", target_env="gnu"))]
  30 pub mod eh_frames
  31 {
  32     #[no_mangle]
  33     #[link_section = ".eh_frame"]
  34     // Marks beginning of the stack frame unwind info section
  35     pub static __EH_FRAME_BEGIN__: [u8; 0] = [];
  36
  37     // Scratch space for unwinder's internal book-keeping.
  38     // This is defined as `struct object` in $GCC/libgcc/unwind-dw2-fde.h.
  39     static mut obj: [isize; 6] = [0; 6];
  40
  41     // Unwind info registration/deregistration routines.
  42     // See the docs of `unwind` module in libstd.
  43     extern {
  44         fn rust_eh_register_frames(eh_frame_begin: *const u8, object: *mut u8);
  45         fn rust_eh_unregister_frames(eh_frame_begin: *const u8, object: *mut u8);
  46     }
  47
  48     unsafe fn init() {
  49         // register unwind info on module startup
  50         rust_eh_register_frames(&__EH_FRAME_BEGIN__ as *const u8,
  51                                 &mut obj as *mut _ as *mut u8);
  52     }
  53
  54     unsafe fn uninit() {
  55         // unregister on shutdown
  56         rust_eh_unregister_frames(&__EH_FRAME_BEGIN__ as *const u8,
  57                                   &mut obj as *mut _ as *mut u8);
  58     }
  59
  60     // MSVC-specific init/uninit routine registration
  61     pub mod ms_init
  62     {
  63         // .CRT$X?? sections are roughly analogous to ELF's .init_array and .fini_array,
  64         // except that they exploit the fact that linker will sort them alphabitically,
  65         // so e.g. sections with names between .CRT$XIA and .CRT$XIZ are guaranteed to be
  66         // placed between those two, without requiring any ordering of objects on the linker
  67         // command line.
  68         // Note that ordering of same-named sections from different objects is not guaranteed.
  69         // Since .CRT$XIA contains init array's header symbol, which must always come first,
  70         // we place our initialization callback into .CRT$XIB.
  71
  72         #[link_section = ".CRT$XIB"] // .CRT$XI? : C initialization callbacks
  73         pub static P_INIT: unsafe fn() = super::init;
  74
  75         #[link_section = ".CRT$XTY"] // .CRT$XT? : C termination callbacks
  76         pub static P_UNINIT: unsafe fn() = super::uninit;
  77     }
  78 }