src/librustc/middle/trans/glue.rs

   1 // Copyright 2012-2013 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 //!
  12 //
  13 // Code relating to taking, dropping, etc as well as type descriptors.
  14
  15
  16 use back::abi;
  17 use back::link::*;
  18 use lib::llvm::{llvm, ValueRef, True};
  19 use lib;
  20 use middle::lang_items::{FreeFnLangItem, ExchangeFreeFnLangItem};
  21 use middle::trans::adt;
  22 use middle::trans::base::*;
  23 use middle::trans::build::*;
  24 use middle::trans::callee;
  25 use middle::trans::cleanup;
  26 use middle::trans::cleanup::CleanupMethods;
  27 use middle::trans::common::*;
  28 use middle::trans::expr;
  29 use middle::trans::machine::*;
  30 use middle::trans::reflect;
  31 use middle::trans::tvec;
  32 use middle::trans::type_::Type;
  33 use middle::trans::type_of::{type_of, sizing_type_of};
  34 use middle::ty;
  35 use util::ppaux::ty_to_short_str;
  36 use util::ppaux;
  37
  38 use arena::TypedArena;
  39 use std::c_str::ToCStr;
  40 use std::cell::Cell;
  41 use std::libc::c_uint;
  42 use syntax::ast;
  43 use syntax::parse::token;
  44
  45 pub fn trans_free<'a>(cx: &'a Block<'a>, v: ValueRef) -> &'a Block<'a> {
  46     let _icx = push_ctxt("trans_free");
  47     callee::trans_lang_call(cx,
  48         langcall(cx, None, "", FreeFnLangItem),
  49         [PointerCast(cx, v, Type::i8p())],
  50         Some(expr::Ignore)).bcx
  51 }
  52
  53 pub fn trans_exchange_free<'a>(cx: &'a Block<'a>, v: ValueRef)
  54                            -> &'a Block<'a> {
  55     let _icx = push_ctxt("trans_exchange_free");
  56     callee::trans_lang_call(cx,
  57         langcall(cx, None, "", ExchangeFreeFnLangItem),
  58         [PointerCast(cx, v, Type::i8p())],
  59         Some(expr::Ignore)).bcx
  60 }
  61
  62 pub fn take_ty<'a>(bcx: &'a Block<'a>, v: ValueRef, t: ty::t)
  63                -> &'a Block<'a> {
  64     // NB: v is an *alias* of type t here, not a direct value.
  65     let _icx = push_ctxt("take_ty");
  66     match ty::get(t).sty {
  67         ty::ty_box(_) => incr_refcnt_of_boxed(bcx, v),
  68         _ if ty::type_is_structural(t)
  69           && ty::type_needs_drop(bcx.tcx(), t) => {
  70             iter_structural_ty(bcx, v, t, take_ty)
  71         }
  72         _ => bcx
  73     }
  74 }
  75
  76 fn get_drop_glue_type(ccx: &CrateContext, t: ty::t) -> ty::t {
  77     let tcx = ccx.tcx;
  78     if !ty::type_needs_drop(tcx, t) {
  79         return ty::mk_i8();
  80     }
  81     match ty::get(t).sty {
  82         ty::ty_box(typ) if !ty::type_needs_drop(tcx, typ) =>
  83             ty::mk_box(tcx, ty::mk_i8()),
  84
  85         ty::ty_uniq(typ) if !ty::type_needs_drop(tcx, typ) => {
  86             let llty = sizing_type_of(ccx, typ);
  87             // Unique boxes do not allocate for zero-size types. The standard library may assume
  88             // that `free` is never called on the pointer returned for `~ZeroSizeType`.
  89             if llsize_of_alloc(ccx, llty) == 0 {
  90                 ty::mk_i8()
  91             } else {
  92                 ty::mk_uniq(tcx, ty::mk_i8())
  93             }
  94         }
  95
  96         ty::ty_vec(mt, ty::vstore_uniq) if !ty::type_needs_drop(tcx, mt.ty) =>
  97             ty::mk_uniq(tcx, ty::mk_i8()),
  98
  99         _ => t
 100     }
 101 }
 102
 103 pub fn drop_ty<'a>(bcx: &'a Block<'a>, v: ValueRef, t: ty::t)
 104                -> &'a Block<'a> {
 105     // NB: v is an *alias* of type t here, not a direct value.
 106     let _icx = push_ctxt("drop_ty");
 107     let ccx = bcx.ccx();
 108     if ty::type_needs_drop(bcx.tcx(), t) {
 109         let glue = get_drop_glue(ccx, t);
 110         let glue_type = get_drop_glue_type(ccx, t);
 111         let ptr = if glue_type != t {
 112             PointerCast(bcx, v, type_of(ccx, glue_type).ptr_to())
 113         } else {
 114             v
 115         };
 116         Call(bcx, glue, [ptr], []);
 117     }
 118     bcx
 119 }
 120
 121 pub fn drop_ty_immediate<'a>(bcx: &'a Block<'a>, v: ValueRef, t: ty::t)
 122                          -> &'a Block<'a> {
 123     let _icx = push_ctxt("drop_ty_immediate");
 124     let vp = alloca(bcx, type_of(bcx.ccx(), t), "");
 125     Store(bcx, v, vp);
 126     drop_ty(bcx, vp, t)
 127 }
 128
 129 pub fn get_drop_glue(ccx: @CrateContext, t: ty::t) -> ValueRef {
 130     let t = get_drop_glue_type(ccx, t);
 131     {
 132         let drop_glues = ccx.drop_glues.borrow();
 133         match drop_glues.get().find(&t) {
 134             Some(&glue) => return glue,
 135             _ => { }
 136         }
 137     }
 138
 139     let llfnty = Type::glue_fn(type_of(ccx, t).ptr_to());
 140     let glue = declare_generic_glue(ccx, t, llfnty, "drop");
 141
 142     {
 143         let mut drop_glues = ccx.drop_glues.borrow_mut();
 144         drop_glues.get().insert(t, glue);
 145     }
 146
 147     make_generic_glue(ccx, t, glue, make_drop_glue, "drop");
 148
 149     glue
 150 }
 151
 152 pub fn lazily_emit_visit_glue(ccx: @CrateContext, ti: @tydesc_info) {
 153     let _icx = push_ctxt("lazily_emit_visit_glue");
 154
 155     let llfnty = Type::glue_fn(type_of(ccx, ti.ty).ptr_to());
 156
 157     match ti.visit_glue.get() {
 158         Some(_) => (),
 159         None => {
 160             debug!("+++ lazily_emit_tydesc_glue VISIT {}", ppaux::ty_to_str(ccx.tcx, ti.ty));
 161             let glue_fn = declare_generic_glue(ccx, ti.ty, llfnty, "visit");
 162             ti.visit_glue.set(Some(glue_fn));
 163             make_generic_glue(ccx, ti.ty, glue_fn, make_visit_glue, "visit");
 164             debug!("--- lazily_emit_tydesc_glue VISIT {}", ppaux::ty_to_str(ccx.tcx, ti.ty));
 165         }
 166     }
 167 }
 168
 169 // See [Note-arg-mode]
 170 pub fn call_visit_glue(bcx: &Block, v: ValueRef, tydesc: ValueRef,
 171                        static_ti: Option<@tydesc_info>) {
 172     let _icx = push_ctxt("call_tydesc_glue_full");
 173     let ccx = bcx.ccx();
 174     // NB: Don't short-circuit even if this block is unreachable because
 175     // GC-based cleanup needs to the see that the roots are live.
 176     if bcx.unreachable.get() && !ccx.sess.no_landing_pads() { return; }
 177
 178     let static_glue_fn = match static_ti {
 179         None => None,
 180         Some(sti) => {
 181             lazily_emit_visit_glue(ccx, sti);
 182             sti.visit_glue.get()
 183         }
 184     };
 185
 186     // When static type info is available, avoid casting to a generic pointer.
 187     let llrawptr = if static_glue_fn.is_none() {
 188         PointerCast(bcx, v, Type::i8p())
 189     } else {
 190         v
 191     };
 192
 193     let llfn = {
 194         match static_glue_fn {
 195             None => {
 196                 // Select out the glue function to call from the tydesc
 197                 let llfnptr = GEPi(bcx, tydesc, [0u, abi::tydesc_field_visit_glue]);
 198                 Load(bcx, llfnptr)
 199             }
 200             Some(sgf) => sgf
 201         }
 202     };
 203
 204     Call(bcx, llfn, [llrawptr], []);
 205 }
 206
 207 fn make_visit_glue<'a>(bcx: &'a Block<'a>, v: ValueRef, t: ty::t)
 208                    -> &'a Block<'a> {
 209     let _icx = push_ctxt("make_visit_glue");
 210     let mut bcx = bcx;
 211     let (visitor_trait, object_ty) = match ty::visitor_object_ty(bcx.tcx(),
 212                                                                  ty::ReStatic) {
 213         Ok(pair) => pair,
 214         Err(s) => {
 215             bcx.tcx().sess.fatal(s);
 216         }
 217     };
 218     let v = PointerCast(bcx, v, type_of(bcx.ccx(), object_ty).ptr_to());
 219     bcx = reflect::emit_calls_to_trait_visit_ty(bcx, t, v, visitor_trait.def_id);
 220     bcx
 221 }
 222
 223 fn trans_struct_drop_flag<'a>(bcx: &'a Block<'a>,
 224                               t: ty::t,
 225                               v0: ValueRef,
 226                               dtor_did: ast::DefId,
 227                               class_did: ast::DefId,
 228                               substs: &ty::substs)
 229                               -> &'a Block<'a> {
 230     let repr = adt::represent_type(bcx.ccx(), t);
 231     let drop_flag = adt::trans_drop_flag_ptr(bcx, repr, v0);
 232     with_cond(bcx, IsNotNull(bcx, Load(bcx, drop_flag)), |cx| {
 233         trans_struct_drop(cx, t, v0, dtor_did, class_did, substs)
 234     })
 235 }
 236
 237 fn trans_struct_drop<'a>(bcx: &'a Block<'a>,
 238                          t: ty::t,
 239                          v0: ValueRef,
 240                          dtor_did: ast::DefId,
 241                          class_did: ast::DefId,
 242                          substs: &ty::substs)
 243                          -> &'a Block<'a> {
 244     let repr = adt::represent_type(bcx.ccx(), t);
 245
 246     // Find and call the actual destructor
 247     let dtor_addr = get_res_dtor(bcx.ccx(), dtor_did,
 248                                  class_did, substs.tps.clone());
 249
 250     // The second argument is the "self" argument for drop
 251     let params = unsafe {
 252         let ty = Type::from_ref(llvm::LLVMTypeOf(dtor_addr));
 253         ty.element_type().func_params()
 254     };
 255
 256     // Class dtors have no explicit args, so the params should
 257     // just consist of the environment (self)
 258     assert_eq!(params.len(), 1);
 259
 260     // Be sure to put all of the fields into a scope so we can use an invoke
 261     // instruction to call the user destructor but still call the field
 262     // destructors if the user destructor fails.
 263     let field_scope = bcx.fcx.push_custom_cleanup_scope();
 264
 265     let self_arg = PointerCast(bcx, v0, params[0]);
 266     let args = ~[self_arg];
 267
 268     // Add all the fields as a value which needs to be cleaned at the end of
 269     // this scope.
 270     let field_tys = ty::struct_fields(bcx.tcx(), class_did, substs);
 271     for (i, fld) in field_tys.iter().enumerate() {
 272         let llfld_a = adt::trans_field_ptr(bcx, repr, v0, 0, i);
 273         bcx.fcx.schedule_drop_mem(cleanup::CustomScope(field_scope),
 274                                   llfld_a,
 275                                   fld.mt.ty);
 276     }
 277
 278     let (_, bcx) = invoke(bcx, dtor_addr, args, [], None);
 279
 280     bcx.fcx.pop_and_trans_custom_cleanup_scope(bcx, field_scope)
 281 }
 282
 283 fn make_drop_glue<'a>(bcx: &'a Block<'a>, v0: ValueRef, t: ty::t) -> &'a Block<'a> {
 284     // NB: v0 is an *alias* of type t here, not a direct value.
 285     let _icx = push_ctxt("make_drop_glue");
 286     let ccx = bcx.ccx();
 287     match ty::get(t).sty {
 288         ty::ty_box(body_ty) => {
 289             decr_refcnt_maybe_free(bcx, v0, body_ty)
 290         }
 291         ty::ty_uniq(content_ty) => {
 292             let llbox = Load(bcx, v0);
 293             let not_null = IsNotNull(bcx, llbox);
 294             with_cond(bcx, not_null, |bcx| {
 295                 let bcx = drop_ty(bcx, llbox, content_ty);
 296                 trans_exchange_free(bcx, llbox)
 297             })
 298         }
 299         ty::ty_vec(_, ty::vstore_uniq) | ty::ty_str(ty::vstore_uniq) => {
 300             make_drop_glue(bcx, v0, tvec::expand_boxed_vec_ty(bcx.tcx(), t))
 301         }
 302         ty::ty_unboxed_vec(_) => {
 303             tvec::make_drop_glue_unboxed(bcx, v0, t)
 304         }
 305         ty::ty_struct(did, ref substs) => {
 306             let tcx = bcx.tcx();
 307             match ty::ty_dtor(tcx, did) {
 308                 ty::TraitDtor(dtor, true) => {
 309                     trans_struct_drop_flag(bcx, t, v0, dtor, did, substs)
 310                 }
 311                 ty::TraitDtor(dtor, false) => {
 312                     trans_struct_drop(bcx, t, v0, dtor, did, substs)
 313                 }
 314                 ty::NoDtor => {
 315                     // No dtor? Just the default case
 316                     iter_structural_ty(bcx, v0, t, drop_ty)
 317                 }
 318             }
 319         }
 320         ty::ty_trait(_, _, ty::UniqTraitStore, _, _) => {
 321             let lluniquevalue = GEPi(bcx, v0, [0, abi::trt_field_box]);
 322             // Only drop the value when it is non-null
 323             with_cond(bcx, IsNotNull(bcx, Load(bcx, lluniquevalue)), |bcx| {
 324                 let dtor_ptr = Load(bcx, GEPi(bcx, v0, [0, abi::trt_field_vtable]));
 325                 let dtor = Load(bcx, dtor_ptr);
 326                 Call(bcx, dtor, [PointerCast(bcx, lluniquevalue, Type::i8p())], []);
 327                 bcx
 328             })
 329         }
 330         ty::ty_closure(ref f) if f.sigil == ast::OwnedSigil => {
 331             let box_cell_v = GEPi(bcx, v0, [0u, abi::fn_field_box]);
 332             let env = Load(bcx, box_cell_v);
 333             let env_ptr_ty = Type::at_box(ccx, Type::i8()).ptr_to();
 334             let env = PointerCast(bcx, env, env_ptr_ty);
 335             with_cond(bcx, IsNotNull(bcx, env), |bcx| {
 336                 let dtor_ptr = GEPi(bcx, env, [0u, abi::box_field_tydesc]);
 337                 let dtor = Load(bcx, dtor_ptr);
 338                 let cdata = GEPi(bcx, env, [0u, abi::box_field_body]);
 339                 Call(bcx, dtor, [PointerCast(bcx, cdata, Type::i8p())], []);
 340
 341                 // Free the environment itself
 342                 trans_exchange_free(bcx, env)
 343             })
 344         }
 345         _ => {
 346             if ty::type_needs_drop(ccx.tcx, t) &&
 347                 ty::type_is_structural(t) {
 348                 iter_structural_ty(bcx, v0, t, drop_ty)
 349             } else {
 350                 bcx
 351             }
 352         }
 353     }
 354 }
 355
 356 fn decr_refcnt_maybe_free<'a>(bcx: &'a Block<'a>,
 357                               box_ptr_ptr: ValueRef,
 358                               t: ty::t) -> &'a Block<'a> {
 359     let _icx = push_ctxt("decr_refcnt_maybe_free");
 360     let fcx = bcx.fcx;
 361     let ccx = bcx.ccx();
 362
 363     let decr_bcx = fcx.new_temp_block("decr");
 364     let free_bcx = fcx.new_temp_block("free");
 365     let next_bcx = fcx.new_temp_block("next");
 366
 367     let box_ptr = Load(bcx, box_ptr_ptr);
 368     let llnotnull = IsNotNull(bcx, box_ptr);
 369     CondBr(bcx, llnotnull, decr_bcx.llbb, next_bcx.llbb);
 370
 371     let rc_ptr = GEPi(decr_bcx, box_ptr, [0u, abi::box_field_refcnt]);
 372     let rc = Sub(decr_bcx, Load(decr_bcx, rc_ptr), C_int(ccx, 1));
 373     Store(decr_bcx, rc, rc_ptr);
 374     CondBr(decr_bcx, IsNull(decr_bcx, rc), free_bcx.llbb, next_bcx.llbb);
 375
 376     let v = Load(free_bcx, box_ptr_ptr);
 377     let body = GEPi(free_bcx, v, [0u, abi::box_field_body]);
 378     let free_bcx = drop_ty(free_bcx, body, t);
 379     let free_bcx = trans_free(free_bcx, v);
 380     Br(free_bcx, next_bcx.llbb);
 381
 382     next_bcx
 383 }
 384
 385 fn incr_refcnt_of_boxed<'a>(bcx: &'a Block<'a>,
 386                             box_ptr_ptr: ValueRef) -> &'a Block<'a> {
 387     let _icx = push_ctxt("incr_refcnt_of_boxed");
 388     let ccx = bcx.ccx();
 389     let box_ptr = Load(bcx, box_ptr_ptr);
 390     let rc_ptr = GEPi(bcx, box_ptr, [0u, abi::box_field_refcnt]);
 391     let rc = Load(bcx, rc_ptr);
 392     let rc = Add(bcx, rc, C_int(ccx, 1));
 393     Store(bcx, rc, rc_ptr);
 394     bcx
 395 }
 396
 397
 398 // Generates the declaration for (but doesn't emit) a type descriptor.
 399 pub fn declare_tydesc(ccx: &CrateContext, t: ty::t) -> @tydesc_info {
 400     // If emit_tydescs already ran, then we shouldn't be creating any new
 401     // tydescs.
 402     assert!(!ccx.finished_tydescs.get());
 403
 404     let llty = type_of(ccx, t);
 405
 406     if ccx.sess.count_type_sizes() {
 407         println!("{}\t{}", llsize_of_real(ccx, llty),
 408                  ppaux::ty_to_str(ccx.tcx, t));
 409     }
 410
 411     let llsize = llsize_of(ccx, llty);
 412     let llalign = llalign_of(ccx, llty);
 413     let name = mangle_internal_name_by_type_and_seq(ccx, t, "tydesc");
 414     debug!("+++ declare_tydesc {} {}", ppaux::ty_to_str(ccx.tcx, t), name);
 415     let gvar = name.with_c_str(|buf| {
 416         unsafe {
 417             llvm::LLVMAddGlobal(ccx.llmod, ccx.tydesc_type.to_ref(), buf)
 418         }
 419     });
 420     note_unique_llvm_symbol(ccx, name);
 421
 422     let ty_name = token::intern_and_get_ident(ppaux::ty_to_str(ccx.tcx, t));
 423     let ty_name = C_str_slice(ccx, ty_name);
 424
 425     let inf = @tydesc_info {
 426         ty: t,
 427         tydesc: gvar,
 428         size: llsize,
 429         align: llalign,
 430         name: ty_name,
 431         visit_glue: Cell::new(None),
 432     };
 433     debug!("--- declare_tydesc {}", ppaux::ty_to_str(ccx.tcx, t));
 434     return inf;
 435 }
 436
 437 fn declare_generic_glue(ccx: &CrateContext, t: ty::t, llfnty: Type,
 438                         name: &str) -> ValueRef {
 439     let _icx = push_ctxt("declare_generic_glue");
 440     let fn_nm = mangle_internal_name_by_type_and_seq(ccx, t, ~"glue_" + name);
 441     debug!("{} is for type {}", fn_nm, ppaux::ty_to_str(ccx.tcx, t));
 442     let llfn = decl_cdecl_fn(ccx.llmod, fn_nm, llfnty, ty::mk_nil());
 443     note_unique_llvm_symbol(ccx, fn_nm);
 444     return llfn;
 445 }
 446
 447 fn make_generic_glue(ccx: @CrateContext,
 448                      t: ty::t,
 449                      llfn: ValueRef,
 450                      helper: <'a> |&'a Block<'a>, ValueRef, ty::t|
 451                                   -> &'a Block<'a>,
 452                      name: &str)
 453                      -> ValueRef {
 454     let _icx = push_ctxt("make_generic_glue");
 455     let glue_name = format!("glue {} {}", name, ty_to_short_str(ccx.tcx, t));
 456     let _s = StatRecorder::new(ccx, glue_name);
 457
 458     let arena = TypedArena::new();
 459     let fcx = new_fn_ctxt(ccx, ~[], llfn, -1, false, ty::mk_nil(), None, None,
 460                           &arena);
 461
 462     init_function(&fcx, false, ty::mk_nil(), None);
 463
 464     lib::llvm::SetLinkage(llfn, lib::llvm::InternalLinkage);
 465     ccx.stats.n_glues_created.set(ccx.stats.n_glues_created.get() + 1u);
 466     // All glue functions take values passed *by alias*; this is a
 467     // requirement since in many contexts glue is invoked indirectly and
 468     // the caller has no idea if it's dealing with something that can be
 469     // passed by value.
 470     //
 471     // llfn is expected be declared to take a parameter of the appropriate
 472     // type, so we don't need to explicitly cast the function parameter.
 473
 474     let bcx = fcx.entry_bcx.get().unwrap();
 475     let llrawptr0 = unsafe { llvm::LLVMGetParam(llfn, fcx.arg_pos(0) as c_uint) };
 476     let bcx = helper(bcx, llrawptr0, t);
 477     finish_fn(&fcx, bcx);
 478
 479     llfn
 480 }
 481
 482 pub fn emit_tydescs(ccx: @CrateContext) {
 483     let _icx = push_ctxt("emit_tydescs");
 484     // As of this point, allow no more tydescs to be created.
 485     ccx.finished_tydescs.set(true);
 486     let glue_fn_ty = Type::generic_glue_fn(ccx).ptr_to();
 487     let mut tyds = ccx.tydescs.borrow_mut();
 488     for (_, &val) in tyds.get().iter() {
 489         let ti = val;
 490
 491         // Each of the glue functions needs to be cast to a generic type
 492         // before being put into the tydesc because we only have a singleton
 493         // tydesc type. Then we'll recast each function to its real type when
 494         // calling it.
 495         let drop_glue = unsafe {
 496             llvm::LLVMConstPointerCast(get_drop_glue(ccx, ti.ty), glue_fn_ty.to_ref())
 497         };
 498         ccx.stats.n_real_glues.set(ccx.stats.n_real_glues.get() + 1);
 499         let visit_glue =
 500             match ti.visit_glue.get() {
 501               None => {
 502                   ccx.stats.n_null_glues.set(ccx.stats.n_null_glues.get() +
 503                                              1u);
 504                   C_null(glue_fn_ty)
 505               }
 506               Some(v) => {
 507                 unsafe {
 508                     ccx.stats.n_real_glues.set(ccx.stats.n_real_glues.get() +
 509                                                1);
 510                     llvm::LLVMConstPointerCast(v, glue_fn_ty.to_ref())
 511                 }
 512               }
 513             };
 514
 515         let tydesc = C_named_struct(ccx.tydesc_type,
 516                                     [ti.size, // size
 517                                      ti.align, // align
 518                                      drop_glue, // drop_glue
 519                                      visit_glue, // visit_glue
 520                                      ti.name]); // name
 521
 522         unsafe {
 523             let gvar = ti.tydesc;
 524             llvm::LLVMSetInitializer(gvar, tydesc);
 525             llvm::LLVMSetGlobalConstant(gvar, True);
 526             lib::llvm::SetLinkage(gvar, lib::llvm::InternalLinkage);
 527         }
 528     };
 529 }