1 use rustc::ty::adjustment::PointerCast;
5 pub fn trans_fn<'clif, 'tcx, B: Backend + 'static>(
6 cx: &mut crate::CodegenCx<'clif, 'tcx, B>,
7 instance: Instance<'tcx>,
12 let mir = *tcx.instance_mir(instance.def);
15 let (name, sig) = get_function_name_and_sig(tcx, instance, false);
16 let func_id = cx.module.declare_function(&name, linkage, &sig).unwrap();
17 let mut debug_context = cx
20 .map(|debug_context| FunctionDebugContext::new(tcx, debug_context, mir, func_id, &name, &sig));
22 // Make FunctionBuilder
23 let mut func = Function::with_name_signature(ExternalName::user(0, 0), sig);
24 let mut func_ctx = FunctionBuilderContext::new();
25 let mut bcx = FunctionBuilder::new(&mut func, &mut func_ctx);
28 let start_ebb = bcx.create_ebb();
29 let mut ebb_map: HashMap<BasicBlock, Ebb> = HashMap::new();
30 for (bb, _bb_data) in mir.basic_blocks().iter_enumerated() {
31 ebb_map.insert(bb, bcx.create_ebb());
35 let pointer_type = cx.module.target_config().pointer_type();
36 let clif_comments = crate::pretty_clif::CommentWriter::new(tcx, instance);
38 let mut fx = FunctionCx {
48 local_map: HashMap::new(),
51 constants_cx: &mut cx.constants_cx,
52 caches: &mut cx.caches,
53 source_info_set: indexmap::IndexSet::new(),
56 crate::abi::codegen_fn_prelude(&mut fx, start_ebb);
57 codegen_fn_content(&mut fx);
59 // Recover all necessary data from fx, before accessing func will prevent future access to it.
60 let instance = fx.instance;
61 let clif_comments = fx.clif_comments;
62 let source_info_set = fx.source_info_set;
64 #[cfg(debug_assertions)]
65 crate::pretty_clif::write_clif_file(cx.tcx, "unopt", instance, &func, &clif_comments, None);
68 verify_func(tcx, &clif_comments, &func);
71 let context = &mut cx.caches.context;
73 cx.module.define_function(func_id, context).unwrap();
75 let value_ranges = context
76 .build_value_labels_ranges(cx.module.isa())
77 .expect("value location ranges");
79 // Write optimized function to file for debugging
80 #[cfg(debug_assertions)]
81 crate::pretty_clif::write_clif_file(
90 // Define debuginfo for function
91 let isa = cx.module.isa();
94 .map(|x| x.define(tcx, context, isa, &source_info_set));
96 // Clear context to make it usable for the next function
100 fn verify_func(tcx: TyCtxt, writer: &crate::pretty_clif::CommentWriter, func: &Function) {
101 let flags = settings::Flags::new(settings::builder());
102 match ::cranelift::codegen::verify_function(&func, &flags) {
105 tcx.sess.err(&format!("{:?}", err));
106 let pretty_error = ::cranelift::codegen::print_errors::pretty_verifier_error(
109 Some(Box::new(writer)),
113 .fatal(&format!("cranelift verify error:\n{}", pretty_error));
118 fn codegen_fn_content(fx: &mut FunctionCx<'_, '_, impl Backend>) {
119 for (bb, bb_data) in fx.mir.basic_blocks().iter_enumerated() {
120 if bb_data.is_cleanup {
121 // Unwinding after panicking is not supported
125 let ebb = fx.get_ebb(bb);
126 fx.bcx.switch_to_block(ebb);
129 for stmt in &bb_data.statements {
130 fx.set_debug_loc(stmt.source_info);
131 trans_stmt(fx, ebb, stmt);
134 #[cfg(debug_assertions)]
136 let mut terminator_head = "\n".to_string();
140 .fmt_head(&mut terminator_head)
142 let inst = fx.bcx.func.layout.last_inst(ebb).unwrap();
143 fx.add_comment(inst, terminator_head);
146 fx.set_debug_loc(bb_data.terminator().source_info);
148 match &bb_data.terminator().kind {
149 TerminatorKind::Goto { target } => {
150 let ebb = fx.get_ebb(*target);
151 fx.bcx.ins().jump(ebb, &[]);
153 TerminatorKind::Return => {
154 crate::abi::codegen_return(fx);
156 TerminatorKind::Assert {
163 if !fx.tcx.sess.overflow_checks() {
164 if let mir::interpret::PanicInfo::OverflowNeg = *msg {
165 let target = fx.get_ebb(*target);
166 fx.bcx.ins().jump(target, &[]);
170 let cond = trans_operand(fx, cond).load_scalar(fx);
171 let target = fx.get_ebb(*target);
173 fx.bcx.ins().brnz(cond, target, &[]);
175 fx.bcx.ins().brz(cond, target, &[]);
180 "[panic] Assert {:?} at {:?} failed.",
182 bb_data.terminator().source_info.span
187 TerminatorKind::SwitchInt {
193 let discr = trans_operand(fx, discr).load_scalar(fx);
194 let mut switch = ::cranelift::frontend::Switch::new();
195 for (i, value) in values.iter().enumerate() {
196 let ebb = fx.get_ebb(targets[i]);
197 switch.set_entry(*value as u64, ebb);
199 let otherwise_ebb = fx.get_ebb(targets[targets.len() - 1]);
200 switch.emit(&mut fx.bcx, discr, otherwise_ebb);
202 TerminatorKind::Call {
209 crate::abi::codegen_terminator_call(
214 bb_data.terminator().source_info.span,
217 TerminatorKind::Resume | TerminatorKind::Abort => {
218 trap_unreachable(fx, "[corruption] Unwinding bb reached.");
220 TerminatorKind::Unreachable => {
221 trap_unreachable(fx, "[corruption] Hit unreachable code.");
223 TerminatorKind::Yield { .. }
224 | TerminatorKind::FalseEdges { .. }
225 | TerminatorKind::FalseUnwind { .. }
226 | TerminatorKind::DropAndReplace { .. }
227 | TerminatorKind::GeneratorDrop => {
228 bug!("shouldn't exist at trans {:?}", bb_data.terminator());
230 TerminatorKind::Drop {
235 let drop_place = trans_place(fx, location);
236 crate::abi::codegen_drop(fx, drop_place);
238 let target_ebb = fx.get_ebb(*target);
239 fx.bcx.ins().jump(target_ebb, &[]);
244 fx.bcx.seal_all_blocks();
249 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
251 stmt: &Statement<'tcx>,
253 let _print_guard = PrintOnPanic(|| format!("stmt {:?}", stmt));
255 fx.set_debug_loc(stmt.source_info);
257 #[cfg(debug_assertions)]
259 StatementKind::StorageLive(..) | StatementKind::StorageDead(..) => {} // Those are not very useful
261 let inst = fx.bcx.func.layout.last_inst(cur_ebb).unwrap();
262 fx.add_comment(inst, format!("{:?}", stmt));
267 StatementKind::SetDiscriminant {
271 let place = trans_place(fx, place);
272 crate::discriminant::codegen_set_discriminant(fx, place, *variant_index);
274 StatementKind::Assign(to_place_and_rval) => {
275 let lval = trans_place(fx, &to_place_and_rval.0);
276 let dest_layout = lval.layout();
277 match &to_place_and_rval.1 {
278 Rvalue::Use(operand) => {
279 let val = trans_operand(fx, operand);
280 lval.write_cvalue(fx, val);
282 Rvalue::Ref(_, _, place) => {
283 let place = trans_place(fx, place);
284 place.write_place_ref(fx, lval);
286 Rvalue::BinaryOp(bin_op, lhs, rhs) => {
287 let lhs = trans_operand(fx, lhs);
288 let rhs = trans_operand(fx, rhs);
290 let res = crate::num::codegen_binop(fx, *bin_op, lhs, rhs);
291 lval.write_cvalue(fx, res);
293 Rvalue::CheckedBinaryOp(bin_op, lhs, rhs) => {
294 let lhs = trans_operand(fx, lhs);
295 let rhs = trans_operand(fx, rhs);
297 let res = if !fx.tcx.sess.overflow_checks() {
299 crate::num::trans_int_binop(fx, *bin_op, lhs, rhs).load_scalar(fx);
300 let is_overflow = fx.bcx.ins().iconst(types::I8, 0);
301 CValue::by_val_pair(val, is_overflow, lval.layout())
303 crate::num::trans_checked_int_binop(fx, *bin_op, lhs, rhs)
306 lval.write_cvalue(fx, res);
308 Rvalue::UnaryOp(un_op, operand) => {
309 let operand = trans_operand(fx, operand);
310 let layout = operand.layout();
311 let val = operand.load_scalar(fx);
312 let res = match un_op {
314 match layout.ty.kind {
316 let val = fx.bcx.ins().uextend(types::I32, val); // WORKAROUND for CraneStation/cranelift#466
317 let res = fx.bcx.ins().icmp_imm(IntCC::Equal, val, 0);
318 CValue::by_val(fx.bcx.ins().bint(types::I8, res), layout)
320 ty::Uint(_) | ty::Int(_) => {
321 CValue::by_val(fx.bcx.ins().bnot(val), layout)
323 _ => unimplemented!("un op Not for {:?}", layout.ty),
326 UnOp::Neg => match layout.ty.kind {
328 let zero = CValue::const_val(fx, layout.ty, 0);
329 crate::num::trans_int_binop(fx, BinOp::Sub, zero, operand)
332 CValue::by_val(fx.bcx.ins().fneg(val), layout)
334 _ => unimplemented!("un op Neg for {:?}", layout.ty),
337 lval.write_cvalue(fx, res);
339 Rvalue::Cast(CastKind::Pointer(PointerCast::ReifyFnPointer), operand, ty) => {
340 let layout = fx.layout_of(ty);
342 .monomorphize(&operand.ty(&fx.mir.local_decls, fx.tcx))
345 ty::FnDef(def_id, substs) => {
346 let func_ref = fx.get_function_ref(
347 Instance::resolve(fx.tcx, ParamEnv::reveal_all(), def_id, substs)
350 let func_addr = fx.bcx.ins().func_addr(fx.pointer_type, func_ref);
351 lval.write_cvalue(fx, CValue::by_val(func_addr, layout));
353 _ => bug!("Trying to ReifyFnPointer on non FnDef {:?}", ty),
356 Rvalue::Cast(CastKind::Pointer(PointerCast::UnsafeFnPointer), operand, ty)
357 | Rvalue::Cast(CastKind::Pointer(PointerCast::MutToConstPointer), operand, ty)
358 | Rvalue::Cast(CastKind::Pointer(PointerCast::ArrayToPointer), operand, ty) => {
359 let operand = trans_operand(fx, operand);
360 let layout = fx.layout_of(ty);
361 lval.write_cvalue(fx, operand.unchecked_cast_to(layout));
363 Rvalue::Cast(CastKind::Misc, operand, to_ty) => {
364 let operand = trans_operand(fx, operand);
365 let from_ty = operand.layout().ty;
366 let to_ty = fx.monomorphize(to_ty);
369 fx: &FunctionCx<'_, 'tcx, impl Backend>,
372 ty.builtin_deref(true)
377 }| has_ptr_meta(fx.tcx, pointee_ty),
382 if is_fat_ptr(fx, from_ty) {
383 if is_fat_ptr(fx, to_ty) {
384 // fat-ptr -> fat-ptr
385 lval.write_cvalue(fx, operand.unchecked_cast_to(dest_layout));
387 // fat-ptr -> thin-ptr
388 let (ptr, _extra) = operand.load_scalar_pair(fx);
389 lval.write_cvalue(fx, CValue::by_val(ptr, dest_layout))
391 } else if let ty::Adt(adt_def, _substs) = from_ty.kind {
392 // enum -> discriminant value
393 assert!(adt_def.is_enum());
395 ty::Uint(_) | ty::Int(_) => {}
396 _ => unreachable!("cast adt {} -> {}", from_ty, to_ty),
399 let discr = crate::discriminant::codegen_get_discriminant(
404 lval.write_cvalue(fx, discr);
406 let to_clif_ty = fx.clif_type(to_ty).unwrap();
407 let from = operand.load_scalar(fx);
409 let res = clif_int_or_float_cast(
416 lval.write_cvalue(fx, CValue::by_val(res, dest_layout));
419 Rvalue::Cast(CastKind::Pointer(PointerCast::ClosureFnPointer(_)), operand, _ty) => {
420 let operand = trans_operand(fx, operand);
421 match operand.layout().ty.kind {
422 ty::Closure(def_id, substs) => {
423 let instance = Instance::resolve_closure(
427 ty::ClosureKind::FnOnce,
429 let func_ref = fx.get_function_ref(instance);
430 let func_addr = fx.bcx.ins().func_addr(fx.pointer_type, func_ref);
431 lval.write_cvalue(fx, CValue::by_val(func_addr, lval.layout()));
433 _ => bug!("{} cannot be cast to a fn ptr", operand.layout().ty),
436 Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), operand, _ty) => {
437 let operand = trans_operand(fx, operand);
438 operand.unsize_value(fx, lval);
440 Rvalue::Discriminant(place) => {
441 let place = trans_place(fx, place);
442 let value = place.to_cvalue(fx);
444 crate::discriminant::codegen_get_discriminant(fx, value, dest_layout);
445 lval.write_cvalue(fx, discr);
447 Rvalue::Repeat(operand, times) => {
448 let operand = trans_operand(fx, operand);
450 let index = fx.bcx.ins().iconst(fx.pointer_type, i as i64);
451 let to = lval.place_index(fx, index);
452 to.write_cvalue(fx, operand);
455 Rvalue::Len(place) => {
456 let place = trans_place(fx, place);
457 let usize_layout = fx.layout_of(fx.tcx.types.usize);
458 let len = codegen_array_len(fx, place);
459 lval.write_cvalue(fx, CValue::by_val(len, usize_layout));
461 Rvalue::NullaryOp(NullOp::Box, content_ty) => {
462 use rustc::middle::lang_items::ExchangeMallocFnLangItem;
464 let usize_type = fx.clif_type(fx.tcx.types.usize).unwrap();
465 let layout = fx.layout_of(content_ty);
466 let llsize = fx.bcx.ins().iconst(usize_type, layout.size.bytes() as i64);
470 .iconst(usize_type, layout.align.abi.bytes() as i64);
471 let box_layout = fx.layout_of(fx.tcx.mk_box(content_ty));
474 let def_id = match fx.tcx.lang_items().require(ExchangeMallocFnLangItem) {
479 .fatal(&format!("allocation of `{}` {}", box_layout.ty, s));
482 let instance = ty::Instance::mono(fx.tcx, def_id);
483 let func_ref = fx.get_function_ref(instance);
484 let call = fx.bcx.ins().call(func_ref, &[llsize, llalign]);
485 let ptr = fx.bcx.inst_results(call)[0];
486 lval.write_cvalue(fx, CValue::by_val(ptr, box_layout));
488 Rvalue::NullaryOp(NullOp::SizeOf, ty) => {
492 .is_sized(fx.tcx.at(DUMMY_SP), ParamEnv::reveal_all()));
493 let ty_size = fx.layout_of(ty).size.bytes();
494 let val = CValue::const_val(fx, fx.tcx.types.usize, ty_size.into());
495 lval.write_cvalue(fx, val);
497 Rvalue::Aggregate(kind, operands) => match **kind {
498 AggregateKind::Array(_ty) => {
499 for (i, operand) in operands.into_iter().enumerate() {
500 let operand = trans_operand(fx, operand);
501 let index = fx.bcx.ins().iconst(fx.pointer_type, i as i64);
502 let to = lval.place_index(fx, index);
503 to.write_cvalue(fx, operand);
506 _ => unreachable!("shouldn't exist at trans {:?}", to_place_and_rval.1),
510 StatementKind::StorageLive(_)
511 | StatementKind::StorageDead(_)
513 | StatementKind::FakeRead(..)
514 | StatementKind::Retag { .. }
515 | StatementKind::AscribeUserType(..) => {}
517 StatementKind::InlineAsm(asm) => {
518 use syntax::ast::Name;
524 let rustc::hir::InlineAsmInner {
525 asm: asm_code, // Name
526 outputs, // Vec<Name>
528 clobbers, // Vec<Name>
531 dialect: _, // syntax::ast::AsmDialect
534 match &*asm_code.as_str() {
536 assert_eq!(inputs, &[Name::intern("r")]);
537 assert!(outputs.is_empty(), "{:?}", outputs);
541 "cpuid" | "cpuid\n" => {
542 assert_eq!(inputs, &[Name::intern("{eax}"), Name::intern("{ecx}")]);
544 assert_eq!(outputs.len(), 4);
545 for (i, c) in (&["={eax}", "={ebx}", "={ecx}", "={edx}"])
549 assert_eq!(&outputs[i].constraint.as_str(), c);
550 assert!(!outputs[i].is_rw);
551 assert!(!outputs[i].is_indirect);
554 assert_eq!(clobbers, &[Name::intern("rbx")]);
557 assert!(!alignstack);
559 crate::trap::trap_unimplemented(
561 "__cpuid_count arch intrinsic is not supported",
565 assert_eq!(inputs, &[Name::intern("{ecx}")]);
567 assert_eq!(outputs.len(), 2);
568 for (i, c) in (&["={eax}", "={edx}"]).iter().enumerate() {
569 assert_eq!(&outputs[i].constraint.as_str(), c);
570 assert!(!outputs[i].is_rw);
571 assert!(!outputs[i].is_indirect);
574 assert_eq!(clobbers, &[]);
577 assert!(!alignstack);
579 crate::trap::trap_unimplemented(fx, "_xgetbv arch intrinsic is not supported");
581 _ if fx.tcx.symbol_name(fx.instance).name.as_str() == "__rust_probestack" => {
582 crate::trap::trap_unimplemented(fx, "__rust_probestack is not supported");
584 _ => unimpl!("Inline assembly is not supported"),
590 fn codegen_array_len<'tcx>(
591 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
594 match place.layout().ty.kind {
595 ty::Array(_elem_ty, len) => {
596 let len = crate::constant::force_eval_const(fx, len)
597 .eval_usize(fx.tcx, ParamEnv::reveal_all()) as i64;
598 fx.bcx.ins().iconst(fx.pointer_type, len)
600 ty::Slice(_elem_ty) => place
601 .to_addr_maybe_unsized(fx)
603 .expect("Length metadata for slice place"),
604 _ => bug!("Rvalue::Len({:?})", place),
608 pub fn trans_place<'tcx>(
609 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
612 let mut cplace = match &place.base {
613 PlaceBase::Local(local) => fx.get_local_place(*local),
614 PlaceBase::Static(static_) => match static_.kind {
615 StaticKind::Static => {
616 crate::constant::codegen_static_ref(fx, static_.def_id, static_.ty)
618 StaticKind::Promoted(promoted, substs) => {
619 let instance = Instance::new(static_.def_id, fx.monomorphize(&substs));
620 crate::constant::trans_promoted(fx, instance, promoted, static_.ty)
625 for elem in &*place.projection {
627 PlaceElem::Deref => {
628 cplace = cplace.place_deref(fx);
630 PlaceElem::Field(field, _ty) => {
631 cplace = cplace.place_field(fx, field);
633 PlaceElem::Index(local) => {
634 let index = fx.get_local_place(local).to_cvalue(fx).load_scalar(fx);
635 cplace = cplace.place_index(fx, index);
637 PlaceElem::ConstantIndex {
642 let index = if !from_end {
643 fx.bcx.ins().iconst(fx.pointer_type, offset as i64)
645 let len = codegen_array_len(fx, cplace);
646 fx.bcx.ins().iadd_imm(len, -(offset as i64))
648 cplace = cplace.place_index(fx, index);
650 PlaceElem::Subslice { from, to, from_end } => {
651 // These indices are generated by slice patterns.
652 // slice[from:-to] in Python terms.
654 match cplace.layout().ty.kind {
655 ty::Array(elem_ty, len) => {
656 let elem_layout = fx.layout_of(elem_ty);
657 let ptr = cplace.to_addr(fx);
658 let len = crate::constant::force_eval_const(fx, len)
659 .eval_usize(fx.tcx, ParamEnv::reveal_all());
660 cplace = CPlace::for_addr(
663 .iadd_imm(ptr, elem_layout.size.bytes() as i64 * from as i64),
664 fx.layout_of(fx.tcx.mk_array(elem_ty, len - from as u64 - to as u64)),
667 ty::Slice(elem_ty) => {
668 assert!(from_end, "slice subslices should be `from_end`");
669 let elem_layout = fx.layout_of(elem_ty);
670 let (ptr, len) = cplace.to_addr_maybe_unsized(fx);
671 let len = len.unwrap();
672 cplace = CPlace::for_addr_with_extra(
675 .iadd_imm(ptr, elem_layout.size.bytes() as i64 * from as i64),
676 fx.bcx.ins().iadd_imm(len, -(from as i64 + to as i64)),
683 PlaceElem::Downcast(_adt_def, variant) => {
684 cplace = cplace.downcast_variant(fx, variant);
692 pub fn trans_operand<'tcx>(
693 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
694 operand: &Operand<'tcx>,
697 Operand::Move(place) | Operand::Copy(place) => {
698 let cplace = trans_place(fx, place);
701 Operand::Constant(const_) => crate::constant::trans_constant(fx, const_),