src/librustc_trans/debuginfo/utils.rs

   1 // Copyright 2015 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 // Utility Functions.
  12
  13 use super::{CrateDebugContext};
  14 use super::namespace::item_namespace;
  15
  16 use rustc::hir::def_id::DefId;
  17
  18 use llvm;
  19 use llvm::debuginfo::{DIScope, DIBuilderRef, DIDescriptor, DIArray};
  20 use machine;
  21 use common::{CrateContext};
  22 use type_::Type;
  23
  24 use syntax_pos::{self, Span};
  25 use syntax::ast;
  26
  27 use std::ops;
  28
  29 pub fn is_node_local_to_unit(cx: &CrateContext, node_id: ast::NodeId) -> bool
  30 {
  31     // The is_local_to_unit flag indicates whether a function is local to the
  32     // current compilation unit (i.e. if it is *static* in the C-sense). The
  33     // *reachable* set should provide a good approximation of this, as it
  34     // contains everything that might leak out of the current crate (by being
  35     // externally visible or by being inlined into something externally
  36     // visible). It might better to use the `exported_items` set from
  37     // `driver::CrateAnalysis` in the future, but (atm) this set is not
  38     // available in the translation pass.
  39     !cx.exported_symbols().contains(&node_id)
  40 }
  41
  42 #[allow(non_snake_case)]
  43 pub fn create_DIArray(builder: DIBuilderRef, arr: &[DIDescriptor]) -> DIArray {
  44     return unsafe {
  45         llvm::LLVMRustDIBuilderGetOrCreateArray(builder, arr.as_ptr(), arr.len() as u32)
  46     };
  47 }
  48
  49 /// Return syntax_pos::Loc corresponding to the beginning of the span
  50 pub fn span_start(cx: &CrateContext, span: Span) -> syntax_pos::Loc {
  51     cx.sess().codemap().lookup_char_pos(span.lo)
  52 }
  53
  54 pub fn size_and_align_of(cx: &CrateContext, llvm_type: Type) -> (u64, u32) {
  55     (machine::llsize_of_alloc(cx, llvm_type), machine::llalign_of_min(cx, llvm_type))
  56 }
  57
  58 pub fn bytes_to_bits<T>(bytes: T) -> T
  59     where T: ops::Mul<Output=T> + From<u8> {
  60     bytes * 8u8.into()
  61 }
  62
  63 #[inline]
  64 pub fn debug_context<'a, 'tcx>(cx: &'a CrateContext<'a, 'tcx>)
  65                            -> &'a CrateDebugContext<'tcx> {
  66     cx.dbg_cx().as_ref().unwrap()
  67 }
  68
  69 #[inline]
  70 #[allow(non_snake_case)]
  71 pub fn DIB(cx: &CrateContext) -> DIBuilderRef {
  72     cx.dbg_cx().as_ref().unwrap().builder
  73 }
  74
  75 pub fn get_namespace_and_span_for_item(cx: &CrateContext, def_id: DefId)
  76                                    -> (DIScope, Span) {
  77     let containing_scope = item_namespace(cx, DefId {
  78         krate: def_id.krate,
  79         index: cx.tcx().def_key(def_id).parent
  80                  .expect("get_namespace_and_span_for_item: missing parent?")
  81     });
  82
  83     // Try to get some span information, if we have an inlined item.
  84     let definition_span = cx.tcx().def_span(def_id);
  85
  86     (containing_scope, definition_span)
  87 }