inst.rs 14 KB
Newer Older
qinsoon's avatar
qinsoon committed
1 2 3 4 5
use ir::*;
use ptr::*;
use types::*;
use op::*;

6
use utils::vec_utils;
7 8

use std::fmt;
qinsoon's avatar
qinsoon committed
9
use std::sync::RwLock;
10

qinsoon's avatar
qinsoon committed
11
#[derive(Debug)]
12
pub struct Instruction {
qinsoon's avatar
qinsoon committed
13
    pub value : Option<Vec<P<Value>>>,
qinsoon's avatar
qinsoon committed
14
    pub ops : RwLock<Vec<P<TreeNode>>>,
15 16 17
    pub v: Instruction_
}

qinsoon's avatar
qinsoon committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
use rustc_serialize::{Encodable, Encoder, Decodable, Decoder};
impl Encodable for Instruction {
    fn encode<S: Encoder> (&self, s: &mut S) -> Result<(), S::Error> {
        s.emit_struct("Instruction", 3, |s| {
            try!(s.emit_struct_field("value", 0, |s| self.value.encode(s)));
            
            let ops = &self.ops.read().unwrap();
            try!(s.emit_struct_field("ops", 1, |s| ops.encode(s)));
            
            try!(s.emit_struct_field("v", 2, |s| self.v.encode(s)));
            
            Ok(()) 
        })        
    }
}

impl Decodable for Instruction {
    fn decode<D: Decoder>(d: &mut D) -> Result<Instruction, D::Error> {
        d.read_struct("Instruction", 3, |d| {
            let value = try!(d.read_struct_field("value", 0, |d| Decodable::decode(d)));
            
            let ops = try!(d.read_struct_field("ops", 1, |d| Decodable::decode(d)));
            
            let v = try!(d.read_struct_field("v", 2, |d| Decodable::decode(d)));
            
            Ok(Instruction{
                value: value,
                ops: RwLock::new(ops),
                v: v
            })
        })
    }
}

impl Clone for Instruction {
    fn clone(&self) -> Self {
        Instruction {
            value: self.value.clone(),
            ops: RwLock::new(self.ops.read().unwrap().clone()),
            v: self.v.clone()
        }
    }
}

62 63 64 65 66 67 68 69
impl Instruction {
    fn debug_str(&self, ops: &Vec<P<TreeNode>>) -> String {
        self.v.debug_str(ops)
    }
}

impl fmt::Display for Instruction {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
qinsoon's avatar
qinsoon committed
70
        let ops = &self.ops.read().unwrap();
71
        if self.value.is_some() {
qinsoon's avatar
qinsoon committed
72
            write!(f, "{} = {}", vec_utils::as_str(self.value.as_ref().unwrap()), self.v.debug_str(ops))
73 74 75 76 77 78
        } else {
            write!(f, "{}", self.v.debug_str(ops))
        }
    }
}

qinsoon's avatar
qinsoon committed
79
#[derive(Debug, Clone, RustcEncodable, RustcDecodable)]
80 81
pub enum Instruction_ {
    // non-terminal instruction
82

83
    // expressions
84 85

    BinOp(BinOp, OpIndex, OpIndex),
86
    CmpOp(CmpOp, OpIndex, OpIndex),
87

88 89 90
    // yields a tuple of results from the call
    ExprCall{
        data: CallData,
qinsoon's avatar
qinsoon committed
91
        is_abort: bool, // T to abort, F to rethrow - FIXME: current, always rethrow for now
92
    },
93

94 95 96 97 98 99
    // yields the memory value
    Load{
        is_ptr: bool,
        order: MemoryOrder,
        mem_loc: OpIndex
    },
100

101 102 103
    // yields nothing
    Store{
        is_ptr: bool,
104
        order: MemoryOrder,
105 106 107
        mem_loc: OpIndex,
        value: OpIndex
    },
108

109 110 111 112 113 114 115 116 117 118
    // yields pair (oldvalue, boolean (T = success, F = failure))
    CmpXchg{
        is_ptr: bool,
        is_weak: bool,
        success_order: MemoryOrder,
        fail_order: MemoryOrder,
        mem_loc: OpIndex,
        expected_value: OpIndex,
        desired_value: OpIndex
    },
119

120 121 122 123 124 125 126 127
    // yields old memory value
    AtomicRMW{
        is_ptr: bool, // T for iref, F for ptr
        order: MemoryOrder,
        op: AtomicRMWOp,
        mem_loc: OpIndex,
        value: OpIndex // operand for op
    },
128

129 130
    // yields a reference of the type
    New(P<MuType>),
131

132 133
    // yields an iref of the type
    AllocA(P<MuType>),
134

135 136
    // yields ref
    NewHybrid(P<MuType>, OpIndex),
137

138 139
    // yields iref
    AllocAHybrid(P<MuType>, OpIndex),
140

141 142 143
    // yields stack ref
    NewStack(OpIndex), // func
                           // TODO: common inst
144

145 146
    // yields thread reference
    NewThread(OpIndex, Vec<OpIndex>), // stack, args
147

148 149
    // yields thread reference (thread resumes with exceptional value)
    NewThreadExn(OpIndex, OpIndex), // stack, exception
150

151 152
    // yields frame cursor
    NewFrameCursor(OpIndex), // stack
153

154 155
    // ref<T> -> iref<T>
    GetIRef(OpIndex),
156

157 158 159 160 161 162
    // iref|uptr<struct|hybrid<T>> int<M> -> iref|uptr<U>
    GetFieldIRef{
        is_ptr: bool,
        base: OpIndex, // iref or uptr
        index: OpIndex // constant
    },
163

164 165 166 167 168 169
    // iref|uptr<array<T N>> int<M> -> iref|uptr<T>
    GetElementIRef{
        is_ptr: bool,
        base: OpIndex,
        index: OpIndex // can be constant or ssa var
    },
170

171 172 173 174 175 176
    // iref|uptr<T> int<M> -> iref|uptr<T>
    ShiftIRef{
        is_ptr: bool,
        base: OpIndex,
        offset: OpIndex
    },
177

178 179 180 181 182
    // iref|uptr<hybrid<T U>> -> iref|uptr<U>
    GetVarPartIRef{
        is_ptr: bool,
        base: OpIndex
    },
183

184 185 186 187 188 189 190 191 192
//    PushFrame{
//        stack: P<Value>,
//        func: P<Value>
//    },
//    PopFrame{
//        stack: P<Value>
//    }

    Fence(MemoryOrder),
193

194 195 196
    // terminal instruction
    Return(Vec<OpIndex>),
    ThreadExit, // TODO:  common inst
197
    Throw(OpIndex),
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    TailCall(CallData),
    Branch1(Destination),
    Branch2{
        cond: OpIndex,
        true_dest: Destination,
        false_dest: Destination,
        true_prob: f32
    },
    Watchpoint{ // Watchpoint NONE ResumptionData
                //   serves as an unconditional trap. Trap to client, and resume with ResumptionData
                // Watchpoint (WPID dest) ResumptionData
                //   when disabled, jump to dest
                //   when enabled, trap to client and resume
        id: Option<WPID>,
        disable_dest: Option<Destination>,
        resume: ResumptionData
214
    },
215
    WPBranch{
216
        wp: WPID,
217 218 219 220 221 222 223
        disable_dest: Destination,
        enable_dest: Destination
    },
    Call{
        data: CallData,
        resume: ResumptionData
    },
qinsoon's avatar
qinsoon committed
224 225 226 227
    CCall{
        data: CallData,
        resume: ResumptionData
    },
228 229 230 231 232 233 234 235 236 237 238 239
    SwapStack{
        stack: OpIndex,
        is_exception: bool,
        args: Vec<OpIndex>,
        resume: ResumptionData
    },
    Switch{
        cond: OpIndex,
        default: Destination,
        branches: Vec<(OpIndex, Destination)>
    },
    ExnInstruction{
qinsoon's avatar
qinsoon committed
240
        inner: Box<Instruction>,
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
        resume: ResumptionData
    }
}

impl Instruction_ {
    fn debug_str(&self, ops: &Vec<P<TreeNode>>) -> String {
        match self {
            &Instruction_::BinOp(op, op1, op2) => format!("{:?} {} {}", op, ops[op1], ops[op2]),
            &Instruction_::CmpOp(op, op1, op2) => format!("{:?} {} {}", op, ops[op1], ops[op2]),
            &Instruction_::ExprCall{ref data, is_abort} => {
                let abort = select_value!(is_abort, "ABORT_ON_EXN", "RETHROW");
                format!("CALL {} {}", data.debug_str(ops), abort)
            },
            &Instruction_::Load{is_ptr, mem_loc, order} => {
                let ptr = select_value!(is_ptr, "PTR", "");
256
                format!("LOAD {} {:?} {}", ptr, order, ops[mem_loc])
257 258 259 260 261
            },
            &Instruction_::Store{value, is_ptr, mem_loc, order} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                format!("STORE {} {:?} {} {}", ptr, order, ops[mem_loc], ops[value])
            },
262
            &Instruction_::CmpXchg{is_ptr, is_weak, success_order, fail_order,
263 264 265
                mem_loc, expected_value, desired_value} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                let weak = select_value!(is_weak, "WEAK", "");
266 267
                format!("CMPXCHG {} {} {:?} {:?} {} {} {}",
                    ptr, weak, success_order, fail_order, ops[mem_loc], ops[expected_value], ops[desired_value])
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
            },
            &Instruction_::AtomicRMW{is_ptr, order, op, mem_loc, value} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                format!("ATOMICRMW {} {:?} {:?} {} {}", ptr, order, op, ops[mem_loc], ops[value])
            },
            &Instruction_::New(ref ty) => format!("NEW {}", ty),
            &Instruction_::AllocA(ref ty) => format!("ALLOCA {}", ty),
            &Instruction_::NewHybrid(ref ty, len) => format!("NEWHYBRID {} {}", ty, ops[len]),
            &Instruction_::AllocAHybrid(ref ty, len) => format!("ALLOCAHYBRID {} {}", ty, ops[len]),
            &Instruction_::NewStack(func) => format!("NEWSTACK {}", ops[func]),
            &Instruction_::NewThread(stack, ref args) => format!("NEWTHREAD {} PASS_VALUES {}", ops[stack], op_vector_str(args, ops)),
            &Instruction_::NewThreadExn(stack, exn) => format!("NEWTHREAD {} THROW_EXC {}", ops[stack], ops[exn]),
            &Instruction_::NewFrameCursor(stack) => format!("NEWFRAMECURSOR {}", ops[stack]),
            &Instruction_::GetIRef(reference) => format!("GETIREF {}", ops[reference]),
            &Instruction_::GetFieldIRef{is_ptr, base, index} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                format!("GETFIELDIREF {} {} {}", ptr, ops[base], ops[index])
            },
            &Instruction_::GetElementIRef{is_ptr, base, index} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                format!("GETELEMENTIREF {} {} {}", ptr, ops[base], ops[index])
            },
            &Instruction_::ShiftIRef{is_ptr, base, offset} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                format!("SHIFTIREF {} {} {}", ptr, ops[base], ops[offset])
            },
            &Instruction_::GetVarPartIRef{is_ptr, base} => {
                let ptr = select_value!(is_ptr, "PTR", "");
                format!("GETVARPARTIREF {} {}", ptr, ops[base])
            },
298

299 300 301
            &Instruction_::Fence(order) => {
                format!("FENCE {:?}", order)
            },
302

303 304
            &Instruction_::Return(ref vals) => format!("RET {}", op_vector_str(vals, ops)),
            &Instruction_::ThreadExit => "THREADEXIT".to_string(),
305
            &Instruction_::Throw(exn_obj) => format!("THROW {}", ops[exn_obj]),
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
            &Instruction_::TailCall(ref call) => format!("TAILCALL {}", call.debug_str(ops)),
            &Instruction_::Branch1(ref dest) => format!("BRANCH {}", dest.debug_str(ops)),
            &Instruction_::Branch2{cond, ref true_dest, ref false_dest, ..} => {
                format!("BRANCH2 {} {} {}", ops[cond], true_dest.debug_str(ops), false_dest.debug_str(ops))
            },
            &Instruction_::Watchpoint{id, ref disable_dest, ref resume} => {
                match id {
                    Some(id) => {
                        format!("WATCHPOINT {} {} {}", id, disable_dest.as_ref().unwrap().debug_str(ops), resume.debug_str(ops))
                    },
                    None => {
                        format!("TRAP {}", resume.debug_str(ops))
                    }
                }
            },
            &Instruction_::WPBranch{wp, ref disable_dest, ref enable_dest} => {
                format!("WPBRANCH {} {} {}", wp, disable_dest.debug_str(ops), enable_dest.debug_str(ops))
            },
            &Instruction_::Call{ref data, ref resume} => format!("CALL {} {}", data.debug_str(ops), resume.debug_str(ops)),
qinsoon's avatar
qinsoon committed
325
            &Instruction_::CCall{ref data, ref resume} => format!("CALL {} {}", data.debug_str(ops), resume.debug_str(ops)),
326 327 328 329 330 331 332 333 334 335 336 337 338
            &Instruction_::SwapStack{stack, is_exception, ref args, ref resume} => {
                format!("SWAPSTACK {} {} {} {}", ops[stack], is_exception, op_vector_str(args, ops), resume.debug_str(ops))
            },
            &Instruction_::Switch{cond, ref default, ref branches} => {
                let mut ret = format!("SWITCH {} {} {{", ops[cond], default.debug_str(ops));
                for i in 0..branches.len() {
                    let (op, ref dest) = branches[i];
                    ret.push_str(format!("{} {}", ops[op], dest.debug_str(ops)).as_str());
                    if i != branches.len() - 1 {
                        ret.push_str(", ");
                    }
                }
                ret.push_str("}}");
339

340 341 342 343 344 345
                ret
            },
            &Instruction_::ExnInstruction{ref inner, ref resume} => {
                format!("{} {}", inner.debug_str(ops), resume.debug_str(ops))
            }
        }
346
    }
347 348
}

qinsoon's avatar
qinsoon committed
349
#[derive(Copy, Clone, Debug, RustcEncodable, RustcDecodable)]
350 351 352 353 354 355 356 357 358 359
pub enum MemoryOrder {
    NotAtomic,
    Relaxed,
    Consume,
    Acquire,
    Release,
    AcqRel,
    SeqCst
}

qinsoon's avatar
qinsoon committed
360
#[derive(Copy, Clone, Debug, RustcEncodable, RustcDecodable)]
361 362 363 364 365
pub enum CallConvention {
    Mu,
    Foreign(ForeignFFI)
}

qinsoon's avatar
qinsoon committed
366
#[derive(Copy, Clone, Debug, RustcEncodable, RustcDecodable)]
367 368 369 370
pub enum ForeignFFI {
    C
}

qinsoon's avatar
qinsoon committed
371
#[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
372 373 374 375 376 377 378 379 380 381 382 383
pub struct CallData {
    pub func: OpIndex,
    pub args: Vec<OpIndex>,
    pub convention: CallConvention
}

impl CallData {
    fn debug_str(&self, ops: &Vec<P<TreeNode>>) -> String {
        format!("{:?} {} [{}]", self.convention, ops[self.func], op_vector_str(&self.args, ops))
    }
}

qinsoon's avatar
qinsoon committed
384
#[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
385 386 387 388 389 390 391 392 393 394 395
pub struct ResumptionData {
    pub normal_dest: Destination,
    pub exn_dest: Destination
}

impl ResumptionData {
    fn debug_str(&self, ops: &Vec<P<TreeNode>>) -> String {
        format!("normal: {}, exception: {}", self.normal_dest.debug_str(ops), self.exn_dest.debug_str(ops))
    }
}

qinsoon's avatar
qinsoon committed
396
#[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
397
pub struct Destination {
qinsoon's avatar
qinsoon committed
398
    pub target: MuID,
399 400 401 402 403
    pub args: Vec<DestArg>
}

impl Destination {
    fn debug_str(&self, ops: &Vec<P<TreeNode>>) -> String {
qinsoon's avatar
qinsoon committed
404
        let mut ret = format!("{} with ", self.target);
405 406 407 408 409 410 411 412 413
        ret.push('[');
        for i in 0..self.args.len() {
            let ref arg = self.args[i];
            ret.push_str(arg.debug_str(ops).as_str());
            if i != self.args.len() - 1 {
                ret.push_str(", ");
            }
        }
        ret.push(']');
414

415 416
        ret
    }
417 418 419 420 421 422 423 424 425 426
    
    pub fn get_arguments(&self, ops: &Vec<P<TreeNode>>) -> Vec<P<Value>> {
        vec_utils::map(&self.args, 
            |x| {
                match x {
                    &DestArg::Normal(i) => ops[i].clone_value(),
                    &DestArg::Freshbound(_) => unimplemented!()
                }
        })
    }
427 428
}

qinsoon's avatar
qinsoon committed
429
#[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
430 431 432 433 434 435 436 437 438
pub enum DestArg {
    Normal(OpIndex),
    Freshbound(usize)
}

impl DestArg {
    fn debug_str(&self, ops: &Vec<P<TreeNode>>) -> String {
        match self {
            &DestArg::Normal(index) => format!("{}", ops[index]),
439
            &DestArg::Freshbound(n) => format!("${}", n)
440 441
        }
    }
qinsoon's avatar
qinsoon committed
442
}