compiler/rustc_codegen_llvm/src/declare.rs

   1 //! Declare various LLVM values.
   2 //!
   3 //! Prefer using functions and methods from this module rather than calling LLVM
   4 //! functions directly. These functions do some additional work to ensure we do
   5 //! the right thing given the preconceptions of codegen.
   6 //!
   7 //! Some useful guidelines:
   8 //!
   9 //! * Use declare_* family of methods if you are declaring, but are not
  10 //!   interested in defining the Value they return.
  11 //! * Use define_* family of methods when you might be defining the Value.
  12 //! * When in doubt, define.
  13
  14 use crate::abi::{FnAbi, FnAbiLlvmExt};
  15 use crate::attributes;
  16 use crate::context::CodegenCx;
  17 use crate::llvm;
  18 use crate::llvm::AttributePlace::Function;
  19 use crate::type_::Type;
  20 use crate::value::Value;
  21 use rustc_codegen_ssa::traits::TypeMembershipMethods;
  22 use rustc_middle::ty::Ty;
  23 use rustc_symbol_mangling::typeid::typeid_for_fnabi;
  24 use smallvec::SmallVec;
  25
  26 /// Declare a function.
  27 ///
  28 /// If there’s a value with the same name already declared, the function will
  29 /// update the declaration and return existing Value instead.
  30 fn declare_raw_fn<'ll>(
  31     cx: &CodegenCx<'ll, '_>,
  32     name: &str,
  33     callconv: llvm::CallConv,
  34     unnamed: llvm::UnnamedAddr,
  35     ty: &'ll Type,
  36 ) -> &'ll Value {
  37     debug!("declare_raw_fn(name={:?}, ty={:?})", name, ty);
  38     let llfn = unsafe {
  39         llvm::LLVMRustGetOrInsertFunction(cx.llmod, name.as_ptr().cast(), name.len(), ty)
  40     };
  41
  42     llvm::SetFunctionCallConv(llfn, callconv);
  43     llvm::SetUnnamedAddress(llfn, unnamed);
  44
  45     let mut attrs = SmallVec::<[_; 4]>::new();
  46
  47     if cx.tcx.sess.opts.cg.no_redzone.unwrap_or(cx.tcx.sess.target.disable_redzone) {
  48         attrs.push(llvm::AttributeKind::NoRedZone.create_attr(cx.llcx));
  49     }
  50
  51     attrs.extend(attributes::non_lazy_bind_attr(cx));
  52
  53     attributes::apply_to_llfn(llfn, Function, &attrs);
  54
  55     llfn
  56 }
  57
  58 impl<'ll, 'tcx> CodegenCx<'ll, 'tcx> {
  59     /// Declare a global value.
  60     ///
  61     /// If there’s a value with the same name already declared, the function will
  62     /// return its Value instead.
  63     pub fn declare_global(&self, name: &str, ty: &'ll Type) -> &'ll Value {
  64         debug!("declare_global(name={:?})", name);
  65         unsafe { llvm::LLVMRustGetOrInsertGlobal(self.llmod, name.as_ptr().cast(), name.len(), ty) }
  66     }
  67
  68     /// Declare a C ABI function.
  69     ///
  70     /// Only use this for foreign function ABIs and glue. For Rust functions use
  71     /// `declare_fn` instead.
  72     ///
  73     /// If there’s a value with the same name already declared, the function will
  74     /// update the declaration and return existing Value instead.
  75     pub fn declare_cfn(
  76         &self,
  77         name: &str,
  78         unnamed: llvm::UnnamedAddr,
  79         fn_type: &'ll Type,
  80     ) -> &'ll Value {
  81         declare_raw_fn(self, name, llvm::CCallConv, unnamed, fn_type)
  82     }
  83
  84     /// Declare a Rust function.
  85     ///
  86     /// If there’s a value with the same name already declared, the function will
  87     /// update the declaration and return existing Value instead.
  88     pub fn declare_fn(&self, name: &str, fn_abi: &FnAbi<'tcx, Ty<'tcx>>) -> &'ll Value {
  89         debug!("declare_rust_fn(name={:?}, fn_abi={:?})", name, fn_abi);
  90
  91         // Function addresses in Rust are never significant, allowing functions to
  92         // be merged.
  93         let llfn = declare_raw_fn(
  94             self,
  95             name,
  96             fn_abi.llvm_cconv(),
  97             llvm::UnnamedAddr::Global,
  98             fn_abi.llvm_type(self),
  99         );
 100         fn_abi.apply_attrs_llfn(self, llfn);
 101
 102         if self.tcx.sess.is_sanitizer_cfi_enabled() {
 103             let typeid = typeid_for_fnabi(self.tcx, fn_abi);
 104             self.set_type_metadata(llfn, typeid);
 105         }
 106
 107         llfn
 108     }
 109
 110     /// Declare a global with an intention to define it.
 111     ///
 112     /// Use this function when you intend to define a global. This function will
 113     /// return `None` if the name already has a definition associated with it. In that
 114     /// case an error should be reported to the user, because it usually happens due
 115     /// to user’s fault (e.g., misuse of `#[no_mangle]` or `#[export_name]` attributes).
 116     pub fn define_global(&self, name: &str, ty: &'ll Type) -> Option<&'ll Value> {
 117         if self.get_defined_value(name).is_some() {
 118             None
 119         } else {
 120             Some(self.declare_global(name, ty))
 121         }
 122     }
 123
 124     /// Declare a private global
 125     ///
 126     /// Use this function when you intend to define a global without a name.
 127     pub fn define_private_global(&self, ty: &'ll Type) -> &'ll Value {
 128         unsafe { llvm::LLVMRustInsertPrivateGlobal(self.llmod, ty) }
 129     }
 130
 131     /// Gets declared value by name.
 132     pub fn get_declared_value(&self, name: &str) -> Option<&'ll Value> {
 133         debug!("get_declared_value(name={:?})", name);
 134         unsafe { llvm::LLVMRustGetNamedValue(self.llmod, name.as_ptr().cast(), name.len()) }
 135     }
 136
 137     /// Gets defined or externally defined (AvailableExternally linkage) value by
 138     /// name.
 139     pub fn get_defined_value(&self, name: &str) -> Option<&'ll Value> {
 140         self.get_declared_value(name).and_then(|val| {
 141             let declaration = unsafe { llvm::LLVMIsDeclaration(val) != 0 };
 142             if !declaration { Some(val) } else { None }
 143         })
 144     }
 145 }