rust/src/librustc/middle/trans/datum.rs

850 lines
27 KiB
Rust
Raw Normal View History

// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
/*!
*
* A `Datum` contains all the information you need to describe the LLVM
* translation of a Rust value. It describes where the value is stored,
* what Rust type the value has, whether it is addressed by reference,
* and so forth.
*
* The idea of a datum is that, to the extent possible, you should not
* care about these details, but rather use the methods on the Datum
* type to "do what you want to do". For example, you can simply call
* `copy_to()` or `move_to()` to copy or move the value into a new
* home.
*
* # Datum location
*
* The primary two fields of a datum are the `val` and the `mode`.
* The `val` is an LLVM value ref. It may either *be the value* that
* is being tracked, or it may be a *pointer to the value being
* tracked*. This is specified in the `mode` field, which can either
* be `ByValue` or `ByRef`, respectively. The (Rust) type of the
* value stored in the datum is indicated in the field `ty`.
*
* Generally speaking, you probably do not want to access the `val` field
* unless you know what mode the value is in. Intead you should use one
* of the following accessors:
*
* - `to_value_llval()` converts to by-value
* - `to_ref_llval()` converts to by-ref, allocating a stack slot if necessary
* - `to_appropriate_llval()` converts to by-value if this is an
* immediate type, by-ref otherwise. This is particularly
* convenient for interfacing with the various code floating around
* that predates datums.
*
* # Datum cleanup styles
*
* Each datum carries with it an idea of how its value will be cleaned
* up. This is important after a move, because we need to know how to
* cancel the cleanup (since the value has been moved and therefore does
* not need to be freed). There are two options:
*
* 1. `RevokeClean`: To cancel the cleanup, we invoke `revoke_clean()`.
* This is used for temporary rvalues.
*
* 2. `ZeroMem`: To cancel the cleanup, we zero out the memory where
* the value resides. This is used for lvalues.
*
* # Copying, moving, and storing
*
* There are three methods for moving the value into a new
* location:
*
* - `copy_to()` will copy the value into a new location, meaning that
* the value is first mem-copied and then the new location is "taken"
* via the take glue, in effect creating a deep clone.
*
* - `move_to()` will copy the value, meaning that the value is mem-copied
* into its new home and then the cleanup on the this datum is revoked.
* This is a "shallow" clone. After `move_to()`, the current datum
* is invalid and should no longer be used.
*
* - `store_to()` either performs a copy or a move by consulting the
* moves_map computed by `middle::moves`.
*
* # Scratch datum
*
* Sometimes you just need some temporary scratch space. The
* `scratch_datum()` function will yield you up a by-ref datum that
* points into the stack. It's your responsibility to ensure that
* whatever you put in there gets cleaned up etc.
*
* # Other actions
*
* There are various other helper methods on Datum, such as `deref()`,
* `get_base_and_len()` and so forth. These are documented on the
* methods themselves. Most are only suitable for some types of
* values. */
use core::prelude::*;
use lib::llvm::ValueRef;
use middle::borrowck::{RootInfo, root_map_key};
use middle::trans::base::*;
use middle::trans::build::*;
use middle::trans::common::*;
use middle::trans::common;
use middle::trans::tvec;
use middle::typeck;
use util::common::indenter;
use util::ppaux::ty_to_str;
use core::cmp;
use core::option;
use core::uint;
use core::vec;
use syntax::parse::token::special_idents;
#[deriving_eq]
pub enum CopyAction {
INIT,
DROP_EXISTING
}
pub struct Datum {
/// The llvm value. This is either a pointer to the Rust value or
/// the value itself, depending on `mode` below.
val: ValueRef,
/// The rust type of the value.
ty: ty::t,
/// Indicates whether this is by-ref or by-value.
mode: DatumMode,
/// How did this value originate? This is particularly important
/// if the value is MOVED or prematurely DROPPED, because it
/// describes how to cancel the cleanup that was scheduled before.
/// See the def'n of the `DatumCleanup` type.
source: DatumCleanup
}
pub struct DatumBlock {
bcx: block,
datum: Datum,
}
pub enum DatumMode {
/// `val` is a pointer to the actual value (and thus has type *T)
ByRef,
/// `val` is the actual value (*only used for immediates* like ints, ptrs)
ByValue,
}
pub impl DatumMode {
fn is_by_ref() -> bool {
match self { ByRef => true, ByValue => false }
}
fn is_by_value() -> bool {
match self { ByRef => false, ByValue => true }
}
}
pub impl cmp::Eq for DatumMode {
pure fn eq(&self, other: &DatumMode) -> bool {
(*self) as uint == (*other as uint)
}
pure fn ne(&self, other: &DatumMode) -> bool { !(*self).eq(other) }
}
pub impl to_bytes::IterBytes for DatumMode {
pure fn iter_bytes(&self, +lsb0: bool, f: to_bytes::Cb) {
(*self as uint).iter_bytes(lsb0, f)
}
}
/// See `Datum cleanup styles` section at the head of this module.
#[deriving_eq]
pub enum DatumCleanup {
RevokeClean,
ZeroMem
}
pub fn immediate_rvalue(val: ValueRef, ty: ty::t) -> Datum {
return Datum {val: val, ty: ty,
mode: ByValue, source: RevokeClean};
}
pub fn immediate_rvalue_bcx(bcx: block,
val: ValueRef,
ty: ty::t)
-> DatumBlock {
return DatumBlock {bcx: bcx, datum: immediate_rvalue(val, ty)};
}
pub fn scratch_datum(bcx: block, ty: ty::t, zero: bool) -> Datum {
/*!
*
* Allocates temporary space on the stack using alloca() and
* returns a by-ref Datum pointing to it. If `zero` is true, the
* space will be zeroed when it is allocated; this is normally not
* necessary, but in the case of automatic rooting in match
* statements it is possible to have temporaries that may not get
* initialized if a certain arm is not taken, so we must zero
* them. You must arrange any cleanups etc yourself! */
let llty = type_of::type_of(bcx.ccx(), ty);
let scratch = alloca_maybe_zeroed(bcx, llty, zero);
Datum { val: scratch, ty: ty, mode: ByRef, source: RevokeClean }
}
pub fn appropriate_mode(ty: ty::t) -> DatumMode {
/*!
*
* Indicates the "appropriate" mode for this value,
* which is either by ref or by value, depending
* on whether type is immediate or not. */
if ty::type_is_nil(ty) || ty::type_is_bot(ty) {
ByValue
} else if ty::type_is_immediate(ty) {
ByValue
} else {
ByRef
}
}
pub impl Datum {
fn store_to(bcx: block, id: ast::node_id,
action: CopyAction, dst: ValueRef) -> block {
/*!
*
* Stores this value into its final home. This moves if
* `id` is located in the move table, but copies otherwise.
*/
if bcx.ccx().maps.moves_map.contains_key(&id) {
self.move_to(bcx, action, dst)
} else {
self.copy_to(bcx, action, dst)
}
}
fn store_to_dest(bcx: block, id: ast::node_id,
dest: expr::Dest) -> block {
match dest {
expr::Ignore => {
return bcx;
}
expr::SaveIn(addr) => {
return self.store_to(bcx, id, INIT, addr);
}
}
}
fn store_to_datum(bcx: block, id: ast::node_id,
action: CopyAction, datum: Datum) -> block {
debug!("store_to_datum(self=%s, action=%?, datum=%s)",
self.to_str(bcx.ccx()), action, datum.to_str(bcx.ccx()));
assert datum.mode.is_by_ref();
self.store_to(bcx, id, action, datum.val)
}
fn move_to_datum(bcx: block, action: CopyAction, datum: Datum) -> block {
assert datum.mode.is_by_ref();
self.move_to(bcx, action, datum.val)
}
fn copy_to_datum(bcx: block, action: CopyAction, datum: Datum) -> block {
assert datum.mode.is_by_ref();
self.copy_to(bcx, action, datum.val)
}
fn copy_to(bcx: block, action: CopyAction, dst: ValueRef) -> block {
/*!
*
* Copies the value into `dst`, which should be a pointer to a
* memory location suitable for `self.ty`. You PROBABLY want
* `store_to()` instead, which will move if possible but copy if
* neccessary. */
let _icx = bcx.insn_ctxt("copy_to");
if ty::type_is_nil(self.ty) || ty::type_is_bot(self.ty) {
return bcx;
}
debug!("copy_to(self=%s, action=%?, dst=%s)",
self.to_str(bcx.ccx()), action, bcx.val_str(dst));
// Watch out for the case where we are writing the copying the
// value into the same location we read it out from. We want
// to avoid the case where we drop the existing value, which
// frees it, and then overwrite it with itself (which has been
// freed).
if action == DROP_EXISTING &&
ty::type_needs_drop(bcx.tcx(), self.ty)
{
match self.mode {
ByRef => {
let cast = PointerCast(bcx, dst, val_ty(self.val));
let cmp = ICmp(bcx, lib::llvm::IntNE, cast, self.val);
do with_cond(bcx, cmp) |bcx| {
self.copy_to_no_check(bcx, action, dst)
}
}
ByValue => {
self.copy_to_no_check(bcx, action, dst)
}
}
} else {
self.copy_to_no_check(bcx, action, dst)
}
}
fn copy_to_no_check(bcx: block, action: CopyAction,
dst: ValueRef) -> block
{
/*!
*
* A helper for `copy_to()` which does not check to see if we
* are copying to/from the same value. */
let _icx = bcx.insn_ctxt("copy_to_no_check");
let mut bcx = bcx;
if action == DROP_EXISTING {
bcx = glue::drop_ty(bcx, dst, self.ty);
}
match self.mode {
ByValue => {
Store(bcx, self.val, dst);
}
ByRef => {
base::memcpy_ty(bcx, dst, self.val, self.ty);
}
}
return glue::take_ty(bcx, dst, self.ty);
}
// This works like copy_val, except that it deinitializes the source.
// Since it needs to zero out the source, src also needs to be an lval.
//
fn move_to(bcx: block, action: CopyAction, dst: ValueRef) -> block {
let _icx = bcx.insn_ctxt("move_to");
let mut bcx = bcx;
debug!("move_to(self=%s, action=%?, dst=%s)",
self.to_str(bcx.ccx()), action, bcx.val_str(dst));
if ty::type_is_nil(self.ty) || ty::type_is_bot(self.ty) {
return bcx;
}
if action == DROP_EXISTING {
bcx = glue::drop_ty(bcx, dst, self.ty);
}
match self.mode {
ByRef => {
base::memcpy_ty(bcx, dst, self.val, self.ty);
}
ByValue => {
Store(bcx, self.val, dst);
}
}
self.cancel_clean(bcx);
return bcx;
}
fn add_clean(bcx: block) {
/*!
*
* Schedules this datum for cleanup in `bcx`. The datum
* must be an rvalue. */
assert self.source == RevokeClean;
match self.mode {
ByValue => {
add_clean_temp_immediate(bcx, self.val, self.ty);
}
ByRef => {
add_clean_temp_mem(bcx, self.val, self.ty);
}
}
}
fn cancel_clean(bcx: block) {
if ty::type_needs_drop(bcx.tcx(), self.ty) {
match self.source {
RevokeClean => {
revoke_clean(bcx, self.val);
}
ZeroMem => {
// Lvalues which potentially need to be dropped
// must be passed by ref, so that we can zero them
// out.
assert self.mode.is_by_ref();
zero_mem(bcx, self.val, self.ty);
}
}
}
}
fn to_str(ccx: &crate_ctxt) -> ~str {
fmt!("Datum { val=%s, ty=%s, mode=%?, source=%? }",
val_str(ccx.tn, self.val),
ty_to_str(ccx.tcx, self.ty),
self.mode,
self.source)
}
fn to_value_datum(bcx: block) -> Datum {
/*!
*
* Yields a by-ref form of this datum. This may involve
* creation of a temporary stack slot. The value returned by
* this function is not separately rooted from this datum, so
* it will not live longer than the current datum. */
match self.mode {
ByValue => self,
ByRef => {
Datum {val: self.to_value_llval(bcx), mode: ByValue,
ty: self.ty, source: RevokeClean}
}
}
}
fn to_value_llval(bcx: block) -> ValueRef {
/*!
*
* Yields the value itself. */
if ty::type_is_nil(self.ty) || ty::type_is_bot(self.ty) {
C_nil()
} else {
match self.mode {
ByValue => self.val,
ByRef => Load(bcx, self.val)
}
}
}
fn to_ref_datum(bcx: block) -> Datum {
/*!
*
* Yields a by-ref form of this datum. This may involve
* creation of a temporary stack slot. The value returned by
* this function is not separately rooted from this datum, so
* it will not live longer than the current datum. */
match self.mode {
ByRef => self,
ByValue => {
Datum {val: self.to_ref_llval(bcx), mode: ByRef,
ty: self.ty, source: RevokeClean}
}
}
}
fn to_ref_llval(bcx: block) -> ValueRef {
match self.mode {
ByRef => self.val,
ByValue => {
if ty::type_is_nil(self.ty) || ty::type_is_bot(self.ty) {
C_null(T_ptr(type_of::type_of(bcx.ccx(), self.ty)))
} else {
let slot = alloc_ty(bcx, self.ty);
Store(bcx, self.val, slot);
slot
}
}
}
}
fn appropriate_mode() -> DatumMode {
/*! See the `appropriate_mode()` function */
appropriate_mode(self.ty)
}
fn to_appropriate_llval(bcx: block) -> ValueRef {
/*!
*
* Yields an llvalue with the `appropriate_mode()`. */
match self.appropriate_mode() {
ByValue => self.to_value_llval(bcx),
ByRef => self.to_ref_llval(bcx)
}
}
fn to_appropriate_datum(bcx: block) -> Datum {
/*!
*
* Yields a datum with the `appropriate_mode()`. */
match self.appropriate_mode() {
ByValue => self.to_value_datum(bcx),
ByRef => self.to_ref_datum(bcx)
}
}
fn GEPi(bcx: block,
ixs: &[uint],
ty: ty::t,
source: DatumCleanup)
-> Datum {
let base_val = self.to_ref_llval(bcx);
Datum {
val: GEPi(bcx, base_val, ixs),
mode: ByRef,
ty: ty,
source: source
}
}
fn root(bcx: block, root_info: RootInfo) -> block {
/*!
*
* In some cases, borrowck will decide that an @T/@[]/@str
* value must be rooted for the program to be safe. In that
* case, we will call this function, which will stash a copy
* away until we exit the scope `scope_id`. */
debug!("root(scope_id=%?, freezes=%?, self=%?)",
root_info.scope, root_info.freezes, self.to_str(bcx.ccx()));
if bcx.sess().trace() {
trans_trace(
bcx, None,
fmt!("preserving until end of scope %d", root_info.scope));
}
let scratch = scratch_datum(bcx, self.ty, true);
self.copy_to_datum(bcx, INIT, scratch);
base::add_root_cleanup(bcx, root_info, scratch.val, scratch.ty);
// If we need to freeze the box, do that now.
if root_info.freezes {
callee::trans_rtcall_or_lang_call(
bcx,
bcx.tcx().lang_items.borrow_as_imm_fn(),
~[
Load(bcx,
PointerCast(bcx,
scratch.val,
T_ptr(T_ptr(T_i8()))))
],
expr::Ignore)
} else {
bcx
}
}
fn perform_write_guard(bcx: block) -> block {
// Create scratch space, but do not root it.
let llval = match self.mode {
ByValue => self.val,
ByRef => Load(bcx, self.val),
};
callee::trans_rtcall_or_lang_call(
bcx,
bcx.tcx().lang_items.check_not_borrowed_fn(),
~[ PointerCast(bcx, llval, T_ptr(T_i8())) ],
expr::Ignore)
}
fn drop_val(bcx: block) -> block {
if !ty::type_needs_drop(bcx.tcx(), self.ty) {
return bcx;
}
return match self.mode {
ByRef => glue::drop_ty(bcx, self.val, self.ty),
ByValue => glue::drop_ty_immediate(bcx, self.val, self.ty)
};
}
fn box_body(bcx: block) -> Datum {
/*!
*
* This datum must represent an @T or ~T box. Returns a new
* by-ref datum of type T, pointing at the contents. */
let content_ty = match ty::get(self.ty).sty {
ty::ty_box(mt) | ty::ty_uniq(mt) => mt.ty,
_ => {
bcx.tcx().sess.bug(fmt!(
"box_body() invoked on non-box type %s",
ty_to_str(bcx.tcx(), self.ty)));
}
};
let ptr = self.to_value_llval(bcx);
let body = opaque_box_body(bcx, content_ty, ptr);
Datum {val: body, ty: content_ty, mode: ByRef, source: ZeroMem}
}
fn to_rptr(bcx: block) -> Datum {
//!
//
// Returns a new datum of region-pointer type containing the
// the same ptr as this datum (after converting to by-ref
// using `to_ref_llval()`).
// Convert to ref, yielding lltype *T. Then create a Rust
// type &static/T (which translates to *T). Construct new
// result (which will be by-value). Note that it is not
// significant *which* region we pick here.
let llval = self.to_ref_llval(bcx);
let rptr_ty = ty::mk_imm_rptr(bcx.tcx(), ty::re_static,
self.ty);
Datum {val: llval, ty: rptr_ty,
mode: ByValue, source: RevokeClean}
}
fn try_deref(
bcx: block, // block wherein to generate insn's
expr_id: ast::node_id, // id of expr being deref'd
derefs: uint, // number of times deref'd already
is_auto: bool) // if true, only deref if auto-derefable
-> (Option<Datum>, block)
{
let ccx = bcx.ccx();
debug!("try_deref(expr_id=%d, derefs=%?, is_auto=%b, self=%?)",
expr_id, derefs, is_auto, self.to_str(bcx.ccx()));
let _indenter = indenter();
// root the autoderef'd value, if necessary:
//
// (Note: root'd values are always boxes)
let key = root_map_key { id: expr_id, derefs: derefs };
let bcx = match ccx.maps.root_map.find(&key) {
None => bcx,
Some(root_info) => self.root(bcx, root_info)
};
// Perform the write guard, if necessary.
//
// (Note: write-guarded values are always boxes)
let bcx = match ccx.maps.write_guard_map.find(&key) {
None => bcx,
Some(_) => self.perform_write_guard(bcx)
};
match ty::get(self.ty).sty {
ty::ty_box(_) | ty::ty_uniq(_) => {
return (Some(self.box_body(bcx)), bcx);
}
ty::ty_ptr(mt) => {
if is_auto { // unsafe ptrs are not AUTO-derefable
return (None, bcx);
} else {
return (Some(deref_ptr(bcx, &self, mt.ty)), bcx);
}
}
ty::ty_rptr(_, mt) => {
return (Some(deref_ptr(bcx, &self, mt.ty)), bcx);
}
ty::ty_enum(did, ref substs) => {
// Check whether this enum is a newtype enum:
let variants = ty::enum_variants(ccx.tcx, did);
2012-10-27 19:16:00 -05:00
if (*variants).len() != 1 || variants[0].args.len() != 1 {
return (None, bcx);
}
let ty = ty::subst(ccx.tcx, substs, variants[0].args[0]);
return match self.mode {
ByRef => {
// Recast lv.val as a pointer to the newtype
// rather than a ptr to the enum type.
let llty = T_ptr(type_of::type_of(ccx, ty));
(
Some(Datum {
val: PointerCast(bcx, self.val, llty),
ty: ty,
mode: ByRef,
source: ZeroMem
}),
bcx
)
}
ByValue => {
// Actually, this case cannot happen right
// now, because enums are never immediate.
// But in principle newtype'd immediate
// values should be immediate, and in that
// case the * would be a no-op except for
// changing the type, so I am putting this
// code in place here to do the right
// thing if this change ever goes through.
assert ty::type_is_immediate(ty);
(Some(Datum {ty: ty, ..self}), bcx)
}
};
}
ty::ty_struct(did, ref substs) => {
// Check whether this struct is a newtype struct.
let fields = ty::struct_fields(ccx.tcx, did, substs);
if fields.len() != 1 || fields[0].ident !=
special_idents::unnamed_field {
return (None, bcx);
}
let ty = fields[0].mt.ty;
return match self.mode {
ByRef => {
// Recast lv.val as a pointer to the newtype rather
// than a pointer to the struct type.
// XXX: This isn't correct for structs with
// destructors.
(
Some(Datum {
val: GEPi(bcx, self.val, [0, 0, 0]),
ty: ty,
mode: ByRef,
source: ZeroMem
}),
bcx
)
}
ByValue => {
// Actually, this case cannot happen right now,
// because structs are never immediate. But in
// principle, newtype'd immediate values should be
// immediate, and in that case the * would be a no-op
// except for changing the type, so I am putting this
// code in place here to do the right thing if this
// change ever goes through.
assert ty::type_is_immediate(ty);
(Some(Datum {ty: ty, ..self}), bcx)
}
}
}
_ => { // not derefable.
return (None, bcx);
}
}
fn deref_ptr(bcx: block, lv: &Datum, ty: ty::t) -> Datum {
Datum {
val: lv.to_value_llval(bcx),
ty: ty,
mode: ByRef,
source: ZeroMem // *p is an lvalue
}
}
}
fn deref(bcx: block,
expr: @ast::expr, // the expression whose value is being deref'd
derefs: uint)
-> DatumBlock {
match self.try_deref(bcx, expr.id, derefs, false) {
(Some(lvres), bcx) => DatumBlock { bcx: bcx, datum: lvres },
(None, _) => {
bcx.ccx().sess.span_bug(
expr.span, ~"Cannot deref this expression");
}
}
}
fn autoderef(bcx: block,
expr_id: ast::node_id,
max: uint)
-> DatumBlock {
let _icx = bcx.insn_ctxt("autoderef");
debug!("autoderef(expr_id=%d, max=%?, self=%?)",
expr_id, max, self.to_str(bcx.ccx()));
let _indenter = indenter();
let mut datum = self;
let mut derefs = 0u;
let mut bcx = bcx;
while derefs < max {
derefs += 1u;
match datum.try_deref(bcx, expr_id, derefs, true) {
(None, new_bcx) => { bcx = new_bcx; break }
(Some(datum_deref), new_bcx) => {
datum = datum_deref;
bcx = new_bcx;
}
}
}
// either we were asked to deref a specific number of times,
// in which case we should have, or we asked to deref as many
// times as we can
assert derefs == max || max == uint::max_value;
DatumBlock { bcx: bcx, datum: datum }
}
fn get_base_and_len(bcx: block) -> (ValueRef, ValueRef) {
tvec::get_base_and_len(bcx, self.to_appropriate_llval(bcx), self.ty)
}
fn to_result(bcx: block) -> common::Result {
rslt(bcx, self.to_appropriate_llval(bcx))
}
}
pub impl DatumBlock {
fn unpack(bcx: &mut block) -> Datum {
*bcx = self.bcx;
return self.datum;
}
fn assert_by_ref() -> DatumBlock {
assert self.datum.mode.is_by_ref();
self
}
fn drop_val() -> block {
self.datum.drop_val(self.bcx)
}
fn store_to(id: ast::node_id, action: CopyAction,
dst: ValueRef) -> block {
self.datum.store_to(self.bcx, id, action, dst)
}
fn copy_to(action: CopyAction, dst: ValueRef) -> block {
self.datum.copy_to(self.bcx, action, dst)
}
fn move_to(action: CopyAction, dst: ValueRef) -> block {
self.datum.move_to(self.bcx, action, dst)
}
fn to_value_llval() -> ValueRef {
self.datum.to_value_llval(self.bcx)
}
fn to_result() -> common::Result {
rslt(self.bcx, self.datum.to_appropriate_llval(self.bcx))
}
fn ccx() -> @crate_ctxt {
self.bcx.ccx()
}
fn tcx() -> ty::ctxt {
self.bcx.tcx()
}
fn to_str(&self) -> ~str {
self.datum.to_str(self.ccx())
}
}