thread.rs 10.2 KB
Newer Older
qinsoon's avatar
qinsoon committed
1
#![allow(dead_code)]
qinsoon's avatar
qinsoon committed
2 3

use ast::ir::*;
qinsoon's avatar
qinsoon committed
4 5 6
use ast::ptr::*;
use ast::types::*;
use vm::VM;
7
use runtime;
8
use runtime::ValueLocation;
9
use runtime::mm;
qinsoon's avatar
qinsoon committed
10

qinsoon's avatar
qinsoon committed
11
use utils::ByteSize;
qinsoon's avatar
qinsoon committed
12
use utils::Address;
qinsoon's avatar
qinsoon committed
13
use utils::Word;
qinsoon's avatar
qinsoon committed
14 15 16
use utils::mem::memmap;
use utils::mem::memsec;

17
use std::mem;
qinsoon's avatar
qinsoon committed
18 19
use std::thread;
use std::thread::JoinHandle;
20
use std::sync::Arc;
qinsoon's avatar
qinsoon committed
21 22 23 24 25 26

pub const STACK_SIZE : ByteSize = (4 << 20); // 4mb

#[cfg(target_arch = "x86_64")]
pub const PAGE_SIZE  : ByteSize = (4 << 10); // 4kb

qinsoon's avatar
qinsoon committed
27 28 29
impl_mu_entity!(MuThread);
impl_mu_entity!(MuStack);

30
#[repr(C)]
qinsoon's avatar
qinsoon committed
31
pub struct MuStack {
qinsoon's avatar
qinsoon committed
32
    pub hdr: MuEntityHeader,
qinsoon's avatar
qinsoon committed
33
    
34 35
    func_addr: ValueLocation,
    func_id: MuID, 
qinsoon's avatar
qinsoon committed
36
    
qinsoon's avatar
qinsoon committed
37
    size: ByteSize,
qinsoon's avatar
qinsoon committed
38 39 40 41 42 43 44 45 46 47
    //    lo addr                                                    hi addr
    //     | overflow guard page | actual stack ..................... | underflow guard page|
    //     |                     |                                    |                     |
    // overflowGuard           lowerBound                           upperBound
    //                                                              underflowGuard    
    overflow_guard : Address,
    lower_bound    : Address,
    upper_bound    : Address,
    underflow_guard: Address,
    
qinsoon's avatar
qinsoon committed
48 49 50 51 52
    // this frame pointers should only be used when stack is not active
    sp : Address,
    bp : Address,
    ip : Address,
    
qinsoon's avatar
qinsoon committed
53 54
    exception_obj  : Option<Address>,
    
55
    state: MuStackState,
qinsoon's avatar
qinsoon committed
56 57 58 59 60
    #[allow(dead_code)]
    mmap           : memmap::Mmap
}

impl MuStack {
61
    pub fn new(id: MuID, func_addr: ValueLocation, func: &MuFunction) -> MuStack {
qinsoon's avatar
qinsoon committed
62 63 64 65 66 67 68
        let total_size = PAGE_SIZE * 2 + STACK_SIZE;
        
        let anon_mmap = match memmap::Mmap::anonymous(total_size, memmap::Protection::ReadWrite) {
            Ok(m) => m,
            Err(_) => panic!("failed to mmap for a stack"),
        };
        
qinsoon's avatar
qinsoon committed
69 70 71 72 73 74 75 76 77 78 79 80
        let mmap_start = Address::from_ptr(anon_mmap.ptr());
        debug_assert!(mmap_start.is_aligned_to(PAGE_SIZE));
        
        let overflow_guard = mmap_start;
        let lower_bound = mmap_start.plus(PAGE_SIZE);
        let upper_bound = lower_bound.plus(STACK_SIZE);
        let underflow_guard = upper_bound;
        
        unsafe {
            memsec::mprotect(overflow_guard.to_ptr_mut::<u8>(),  PAGE_SIZE, memsec::Prot::NoAccess);
            memsec::mprotect(underflow_guard.to_ptr_mut::<u8>(), PAGE_SIZE, memsec::Prot::NoAccess);
        }
qinsoon's avatar
qinsoon committed
81
        
qinsoon's avatar
qinsoon committed
82 83 84 85 86 87 88 89
        debug!("creating stack {} with entry func {:?}", id, func);
        debug!("overflow_guard : {}", overflow_guard);
        debug!("lower_bound    : {}", lower_bound);
        debug!("upper_bound    : {}", upper_bound);
        debug!("underflow_guard: {}", underflow_guard);
        
        MuStack {
            hdr: MuEntityHeader::unnamed(id),
90
            func_addr: func_addr,
qinsoon's avatar
qinsoon committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
            func_id: func.id(),
            
            state: MuStackState::Ready(func.sig.arg_tys.clone()),
            
            size: STACK_SIZE,
            overflow_guard: overflow_guard,
            lower_bound: lower_bound,
            upper_bound: upper_bound,
            underflow_guard: upper_bound,
            
            sp: upper_bound,
            bp: upper_bound,
            ip: unsafe {Address::zero()},
            
            exception_obj: None,
            
            mmap: anon_mmap
        }
qinsoon's avatar
qinsoon committed
109
    }
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
    
    #[cfg(target_arch = "x86_64")]
    pub fn runtime_load_args(&mut self, vals: Vec<ValueLocation>) {
        use compiler::backend::Word;
        use compiler::backend::WORD_SIZE;
        use compiler::backend::RegGroup;
        use compiler::backend::x86_64;
        
        let mut gpr_used = vec![];
        let mut fpr_used = vec![];
        
        for i in 0..vals.len() {
            let ref val = vals[i];
            let (reg_group, word) = val.load_value();
            
            match reg_group {
                RegGroup::GPR => gpr_used.push(word),
                RegGroup::FPR => fpr_used.push(word),
            }
        }
        
        let mut stack_ptr = self.sp;
        for i in 0..x86_64::ARGUMENT_FPRs.len() {
            stack_ptr = stack_ptr.sub(WORD_SIZE);
            let val = {
                if i < fpr_used.len() {
                    fpr_used[i]
                } else {
                    0 as Word
                }
            };
            
            debug!("store {} to {}", val, stack_ptr);
            unsafe {stack_ptr.store(val);}
        }
        
        for i in 0..x86_64::ARGUMENT_GPRs.len() {
            stack_ptr = stack_ptr.sub(WORD_SIZE);
            let val = {
                if i < gpr_used.len() {
                    gpr_used[i]
                } else {
                    0 as Word
                }
            };
            
            debug!("store {} to {}", val, stack_ptr);
            unsafe {stack_ptr.store(val);}
        }
qinsoon's avatar
qinsoon committed
159

160 161
        // save it back
        self.sp = stack_ptr;
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
        
        self.print_stack(Some(20));
    }
    
    pub fn print_stack(&self, n_entries: Option<usize>) {
        use compiler::backend::Word;
        use compiler::backend::WORD_SIZE;
        
        let mut cursor = self.upper_bound.sub(WORD_SIZE);
        let mut count = 0;
        
        println!("0x{:x} | UPPER_BOUND", self.upper_bound); 
        while cursor >= self.lower_bound {
            let val = unsafe{cursor.load::<Word>()};
            print!("0x{:x} | 0x{:x} ({})", cursor, val, val);
            
            if cursor == self.sp {
                print!(" <- SP");
            }
            
            println!("");
            
            cursor = cursor.sub(WORD_SIZE);
            count += 1;
            
            if n_entries.is_some() && count > n_entries.unwrap() {
                println!("...");
                break;
            }
        }
        
        println!("0x{:x} | LOWER_BOUND", self.lower_bound); 
194
    }
qinsoon's avatar
qinsoon committed
195 196
}

qinsoon's avatar
qinsoon committed
197 198 199 200 201 202
pub enum MuStackState {
    Ready(Vec<P<MuType>>), // ready to resume when values of given types are supplied (can be empty)
    Active,
    Dead
}

203
#[repr(C)]
204
#[allow(improper_ctypes)]
205
// do not change the layout (unless change the offset of fields correspondingly)
qinsoon's avatar
qinsoon committed
206
pub struct MuThread {
qinsoon's avatar
qinsoon committed
207
    pub hdr: MuEntityHeader,
208
    allocator: mm::Mutator,
qinsoon's avatar
qinsoon committed
209
    pub stack: Option<Box<MuStack>>,
qinsoon's avatar
qinsoon committed
210
    
211
    native_sp_loc: Address,
212 213
    user_tls: Option<Address>,
    
qinsoon's avatar
qinsoon committed
214 215
    pub vm: Arc<VM>,
    pub exception_obj: Address
qinsoon's avatar
qinsoon committed
216 217
}

218 219 220 221 222
// this depends on the layout of MuThread
lazy_static! {
    pub static ref NATIVE_SP_LOC_OFFSET : usize = mem::size_of::<MuEntityHeader>() 
                + mem::size_of::<Box<mm::Mutator>>()
                + mem::size_of::<Option<Box<MuStack>>>();
qinsoon's avatar
qinsoon committed
223 224
    
    pub static ref ALLOCATOR_OFFSET : usize = mem::size_of::<MuEntityHeader>();
225 226 227 228 229 230
    
    pub static ref VM_OFFSET : usize = mem::size_of::<MuEntityHeader>() 
                + mem::size_of::<Box<mm::Mutator>>()
                + mem::size_of::<Option<Box<MuStack>>>()
                + mem::size_of::<Address>()
                + mem::size_of::<Option<Address>>();
qinsoon's avatar
qinsoon committed
231 232

    pub static ref EXCEPTION_OBJ_OFFSET : usize = *VM_OFFSET + mem::size_of::<Arc<VM>>();                
233 234
}

235
#[cfg(target_arch = "x86_64")]
Kunshan Wang's avatar
Kunshan Wang committed
236
#[cfg(any(target_os = "macos", target_os = "linux"))]
237 238
#[link(name = "runtime")]
extern "C" {
qinsoon's avatar
qinsoon committed
239
    pub fn set_thread_local(thread: *mut MuThread);
qinsoon's avatar
qinsoon committed
240
    pub fn muentry_get_thread_local() -> Address;
241 242 243
}

#[cfg(target_arch = "x86_64")]
Kunshan Wang's avatar
Kunshan Wang committed
244
#[cfg(any(target_os = "macos", target_os = "linux"))]
245 246 247
#[link(name = "swap_stack")]
extern "C" {
    fn swap_to_mu_stack(new_sp: Address, entry: Address, old_sp_loc: Address);
qinsoon's avatar
qinsoon committed
248
    fn muentry_swap_back_to_native_stack(sp_loc: Address);
qinsoon's avatar
qinsoon committed
249
    pub fn get_current_frame_rbp() -> Address;
qinsoon's avatar
qinsoon committed
250
    pub fn exception_restore(dest: Address, callee_saved: *const Word, rsp: Address) -> !;
251 252
}

qinsoon's avatar
qinsoon committed
253
impl MuThread {
254
    pub fn new(id: MuID, allocator: mm::Mutator, stack: Box<MuStack>, user_tls: Option<Address>, vm: Arc<VM>) -> MuThread {
qinsoon's avatar
qinsoon committed
255 256 257 258
        MuThread {
            hdr: MuEntityHeader::unnamed(id),
            allocator: allocator,
            stack: Some(stack),
259
            native_sp_loc: unsafe {Address::zero()},
260 261 262
            user_tls: user_tls,
            vm: vm,
            exception_obj: unsafe {Address::zero()}
qinsoon's avatar
qinsoon committed
263 264
        }
    }
qinsoon's avatar
qinsoon committed
265
    
qinsoon's avatar
qinsoon committed
266
    #[inline(always)]
267 268
    pub fn current() -> &'static MuThread {
        unsafe{
qinsoon's avatar
qinsoon committed
269
            muentry_get_thread_local().to_ptr::<MuThread>().as_ref().unwrap()
qinsoon's avatar
qinsoon committed
270 271 272
        }
    }
    
qinsoon's avatar
qinsoon committed
273
    #[inline(always)]
274 275
    pub fn current_mut() -> &'static mut MuThread {
        unsafe{
qinsoon's avatar
qinsoon committed
276
            muentry_get_thread_local().to_ptr_mut::<MuThread>().as_mut().unwrap()
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
        }
    }
    
    pub fn new_thread_normal(mut stack: Box<MuStack>, threadlocal: Address, vals: Vec<ValueLocation>, vm: Arc<VM>) -> JoinHandle<()> {
        let user_tls = {
            if threadlocal.is_zero() {
                None
            } else {
                Some(threadlocal)
            }
        };
        
        // set up arguments on stack
        stack.runtime_load_args(vals);
        
        MuThread::mu_thread_launch(vm.next_id(), stack, user_tls, vm)
    }    
    
295
    #[no_mangle]
qinsoon's avatar
qinsoon committed
296
    #[allow(unused_variables)]
297
    pub extern fn mu_thread_launch(id: MuID, stack: Box<MuStack>, user_tls: Option<Address>, vm: Arc<VM>) -> JoinHandle<()> {
298 299 300 301
        let new_sp = stack.sp;
        let entry = runtime::resolve_symbol(vm.name_of(stack.func_id));
        debug!("entry : 0x{:x}", entry);
        
qinsoon's avatar
qinsoon committed
302
        match thread::Builder::new().name(format!("Mu Thread #{}", id)).spawn(move || {
303
            let muthread : *mut MuThread = Box::into_raw(Box::new(MuThread::new(id, mm::new_mutator(), stack, user_tls, vm)));
304 305
            
            // set thread local
306 307
            unsafe {set_thread_local(muthread)};
            
qinsoon's avatar
qinsoon committed
308
            let addr = unsafe {muentry_get_thread_local()};
309
            let sp_threadlocal_loc = addr.plus(*NATIVE_SP_LOC_OFFSET);
310 311 312
            
            debug!("new sp: 0x{:x}", new_sp);
            debug!("sp_store: 0x{:x}", sp_threadlocal_loc);
313
            
314 315 316
            unsafe {
                swap_to_mu_stack(new_sp, entry, sp_threadlocal_loc); 
            }
317 318
            
            debug!("returned to Rust stack. Going to quit");
qinsoon's avatar
qinsoon committed
319 320 321 322 323
        }) {
            Ok(handle) => handle,
            Err(_) => panic!("failed to create a thread")
        }
    }
324 325
}

qinsoon's avatar
qinsoon committed
326
#[derive(Debug, RustcEncodable, RustcDecodable)]
327 328 329
pub struct MuPrimordialThread {
    pub func_id: MuID,
    pub args: Vec<Constant>
Kunshan Wang's avatar
Kunshan Wang committed
330
}