src/librustc_codegen_llvm/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 use rustc::ty::DefIdTree;
  18
  19 use llvm;
  20 use llvm::debuginfo::{DIScope, DIBuilderRef, DIDescriptor_opaque, DIArray};
  21 use common::{CodegenCx};
  22
  23 use std::ptr::NonNull;
  24 use syntax_pos::{self, Span};
  25
  26 pub fn is_node_local_to_unit(cx: &CodegenCx, def_id: DefId) -> bool
  27 {
  28     // The is_local_to_unit flag indicates whether a function is local to the
  29     // current compilation unit (i.e. if it is *static* in the C-sense). The
  30     // *reachable* set should provide a good approximation of this, as it
  31     // contains everything that might leak out of the current crate (by being
  32     // externally visible or by being inlined into something externally
  33     // visible). It might better to use the `exported_items` set from
  34     // `driver::CrateAnalysis` in the future, but (atm) this set is not
  35     // available in the codegen pass.
  36     !cx.tcx.is_reachable_non_generic(def_id)
  37 }
  38
  39 #[allow(non_snake_case)]
  40 pub fn create_DIArray(builder: DIBuilderRef, arr: &[Option<NonNull<DIDescriptor_opaque>>]) -> DIArray {
  41     return unsafe {
  42         llvm::LLVMRustDIBuilderGetOrCreateArray(builder, arr.as_ptr(), arr.len() as u32)
  43     };
  44 }
  45
  46 /// Return syntax_pos::Loc corresponding to the beginning of the span
  47 pub fn span_start(cx: &CodegenCx, span: Span) -> syntax_pos::Loc {
  48     cx.sess().codemap().lookup_char_pos(span.lo())
  49 }
  50
  51 #[inline]
  52 pub fn debug_context<'a, 'tcx>(cx: &'a CodegenCx<'a, 'tcx>)
  53                            -> &'a CrateDebugContext<'a, 'tcx> {
  54     cx.dbg_cx.as_ref().unwrap()
  55 }
  56
  57 #[inline]
  58 #[allow(non_snake_case)]
  59 pub fn DIB(cx: &CodegenCx) -> DIBuilderRef {
  60     cx.dbg_cx.as_ref().unwrap().builder
  61 }
  62
  63 pub fn get_namespace_for_item(cx: &CodegenCx, def_id: DefId) -> DIScope {
  64     item_namespace(cx, cx.tcx.parent(def_id)
  65         .expect("get_namespace_for_item: missing parent?"))
  66 }