]> git.lizzy.rs Git - rust.git/blob - src/rtstartup/rsbegin.rs
Minor grammar fix 'can not' -> 'cannot'
[rust.git] / 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 #![feature(no_core, lang_items)]
26 #![crate_type="rlib"]
27 #![no_core]
28 #![allow(non_camel_case_types)]
29
30 #[lang = "sized"]
31 trait Sized {}
32 #[lang = "sync"]
33 trait Sync {}
34 #[lang = "copy"]
35 trait Copy {}
36 impl<T> Sync for T {}
37
38 #[cfg(all(target_os="windows", target_arch = "x86", target_env="gnu"))]
39 pub mod eh_frames {
40     #[no_mangle]
41     #[link_section = ".eh_frame"]
42     // Marks beginning of the stack frame unwind info section
43     pub static __EH_FRAME_BEGIN__: [u8; 0] = [];
44
45     // Scratch space for unwinder's internal book-keeping.
46     // This is defined as `struct object` in $GCC/libgcc/unwind-dw2-fde.h.
47     static mut OBJ: [isize; 6] = [0; 6];
48
49     // Unwind info registration/deregistration routines.
50     // See the docs of `unwind` module in libstd.
51     extern "C" {
52         fn rust_eh_register_frames(eh_frame_begin: *const u8, object: *mut u8);
53         fn rust_eh_unregister_frames(eh_frame_begin: *const u8, object: *mut u8);
54     }
55
56     unsafe fn init() {
57         // register unwind info on module startup
58         rust_eh_register_frames(&__EH_FRAME_BEGIN__ as *const u8,
59                                 &mut OBJ as *mut _ as *mut u8);
60     }
61
62     unsafe fn uninit() {
63         // unregister on shutdown
64         rust_eh_unregister_frames(&__EH_FRAME_BEGIN__ as *const u8,
65                                   &mut OBJ as *mut _ as *mut u8);
66     }
67
68     // MSVC-specific init/uninit routine registration
69     pub mod ms_init {
70         // .CRT$X?? sections are roughly analogous to ELF's .init_array and .fini_array,
71         // except that they exploit the fact that linker will sort them alphabitically,
72         // so e.g. sections with names between .CRT$XIA and .CRT$XIZ are guaranteed to be
73         // placed between those two, without requiring any ordering of objects on the linker
74         // command line.
75         // Note that ordering of same-named sections from different objects is not guaranteed.
76         // Since .CRT$XIA contains init array's header symbol, which must always come first,
77         // we place our initialization callback into .CRT$XIB.
78
79         #[link_section = ".CRT$XIB"] // .CRT$XI? : C initialization callbacks
80         pub static P_INIT: unsafe fn() = super::init;
81
82         #[link_section = ".CRT$XTY"] // .CRT$XT? : C termination callbacks
83         pub static P_UNINIT: unsafe fn() = super::uninit;
84     }
85 }