LLVM  6.0.0svn
Module.h
Go to the documentation of this file.
1 //===- llvm/Module.h - C++ class to represent a VM module -------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// @file
11 /// Module.h This file contains the declarations for the Module class.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_IR_MODULE_H
16 #define LLVM_IR_MODULE_H
17 
18 #include "llvm-c/Types.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/ADT/StringRef.h"
23 #include "llvm/IR/Attributes.h"
24 #include "llvm/IR/Comdat.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/Function.h"
27 #include "llvm/IR/GlobalAlias.h"
28 #include "llvm/IR/GlobalIFunc.h"
29 #include "llvm/IR/GlobalVariable.h"
30 #include "llvm/IR/Metadata.h"
33 #include "llvm/Support/CodeGen.h"
34 #include <cstddef>
35 #include <cstdint>
36 #include <iterator>
37 #include <memory>
38 #include <string>
39 #include <vector>
40 
41 namespace llvm {
42 
43 class Error;
44 class FunctionType;
45 class GVMaterializer;
46 class LLVMContext;
47 class MemoryBuffer;
48 class RandomNumberGenerator;
49 template <class PtrType> class SmallPtrSetImpl;
50 class StructType;
51 
52 /// A Module instance is used to store all the information related to an
53 /// LLVM module. Modules are the top level container of all other LLVM
54 /// Intermediate Representation (IR) objects. Each module directly contains a
55 /// list of globals variables, a list of functions, a list of libraries (or
56 /// other modules) this module depends on, a symbol table, and various data
57 /// about the target's characteristics.
58 ///
59 /// A module maintains a GlobalValRefMap object that is used to hold all
60 /// constant references to global variables in the module. When a global
61 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
62 /// @brief The main container class for the LLVM Intermediate Representation.
63 class Module {
64 /// @name Types And Enumerations
65 /// @{
66 public:
67  /// The type for the list of global variables.
69  /// The type for the list of functions.
71  /// The type for the list of aliases.
73  /// The type for the list of ifuncs.
75  /// The type for the list of named metadata.
77  /// The type of the comdat "symbol" table.
79 
80  /// The Global Variable iterator.
82  /// The Global Variable constant iterator.
84 
85  /// The Function iterators.
87  /// The Function constant iterator
89 
90  /// The Function reverse iterator.
92  /// The Function constant reverse iterator.
94 
95  /// The Global Alias iterators.
97  /// The Global Alias constant iterator
99 
100  /// The Global IFunc iterators.
102  /// The Global IFunc constant iterator
104 
105  /// The named metadata iterators.
107  /// The named metadata constant iterators.
109 
110  /// This enumeration defines the supported behaviors of module flags.
112  /// Emits an error if two values disagree, otherwise the resulting value is
113  /// that of the operands.
114  Error = 1,
115 
116  /// Emits a warning if two values disagree. The result value will be the
117  /// operand for the flag from the first module being linked.
118  Warning = 2,
119 
120  /// Adds a requirement that another module flag be present and have a
121  /// specified value after linking is performed. The value must be a metadata
122  /// pair, where the first element of the pair is the ID of the module flag
123  /// to be restricted, and the second element of the pair is the value the
124  /// module flag should be restricted to. This behavior can be used to
125  /// restrict the allowable results (via triggering of an error) of linking
126  /// IDs with the **Override** behavior.
127  Require = 3,
128 
129  /// Uses the specified value, regardless of the behavior or value of the
130  /// other module. If both modules specify **Override**, but the values
131  /// differ, an error will be emitted.
132  Override = 4,
133 
134  /// Appends the two values, which are required to be metadata nodes.
135  Append = 5,
136 
137  /// Appends the two values, which are required to be metadata
138  /// nodes. However, duplicate entries in the second list are dropped
139  /// during the append operation.
141 
142  /// Takes the max of the two values, which are required to be integers.
143  Max = 7,
144 
145  // Markers:
148  };
149 
150  /// Checks if Metadata represents a valid ModFlagBehavior, and stores the
151  /// converted result in MFB.
152  static bool isValidModFlagBehavior(Metadata *MD, ModFlagBehavior &MFB);
153 
158 
160  : Behavior(B), Key(K), Val(V) {}
161  };
162 
163 /// @}
164 /// @name Member Variables
165 /// @{
166 private:
167  LLVMContext &Context; ///< The LLVMContext from which types and
168  ///< constants are allocated.
169  GlobalListType GlobalList; ///< The Global Variables in the module
170  FunctionListType FunctionList; ///< The Functions in the module
171  AliasListType AliasList; ///< The Aliases in the module
172  IFuncListType IFuncList; ///< The IFuncs in the module
173  NamedMDListType NamedMDList; ///< The named metadata in the module
174  std::string GlobalScopeAsm; ///< Inline Asm at global scope.
175  ValueSymbolTable *ValSymTab; ///< Symbol table for values
176  ComdatSymTabType ComdatSymTab; ///< Symbol table for COMDATs
177  std::unique_ptr<MemoryBuffer>
178  OwnedMemoryBuffer; ///< Memory buffer directly owned by this
179  ///< module, for legacy clients only.
180  std::unique_ptr<GVMaterializer>
181  Materializer; ///< Used to materialize GlobalValues
182  std::string ModuleID; ///< Human readable identifier for the module
183  std::string SourceFileName; ///< Original source file name for module,
184  ///< recorded in bitcode.
185  std::string TargetTriple; ///< Platform target triple Module compiled on
186  ///< Format: (arch)(sub)-(vendor)-(sys0-(abi)
187  void *NamedMDSymTab; ///< NamedMDNode names.
188  DataLayout DL; ///< DataLayout associated with the module
189 
190  friend class Constant;
191 
192 /// @}
193 /// @name Constructors
194 /// @{
195 public:
196  /// The Module constructor. Note that there is no default constructor. You
197  /// must provide a name for the module upon construction.
198  explicit Module(StringRef ModuleID, LLVMContext& C);
199  /// The module destructor. This will dropAllReferences.
200  ~Module();
201 
202 /// @}
203 /// @name Module Level Accessors
204 /// @{
205 
206  /// Get the module identifier which is, essentially, the name of the module.
207  /// @returns the module identifier as a string
208  const std::string &getModuleIdentifier() const { return ModuleID; }
209 
210  /// Get the module's original source file name. When compiling from
211  /// bitcode, this is taken from a bitcode record where it was recorded.
212  /// For other compiles it is the same as the ModuleID, which would
213  /// contain the source file name.
214  const std::string &getSourceFileName() const { return SourceFileName; }
215 
216  /// \brief Get a short "name" for the module.
217  ///
218  /// This is useful for debugging or logging. It is essentially a convenience
219  /// wrapper around getModuleIdentifier().
220  StringRef getName() const { return ModuleID; }
221 
222  /// Get the data layout string for the module's target platform. This is
223  /// equivalent to getDataLayout()->getStringRepresentation().
224  const std::string &getDataLayoutStr() const {
225  return DL.getStringRepresentation();
226  }
227 
228  /// Get the data layout for the module's target platform.
229  const DataLayout &getDataLayout() const;
230 
231  /// Get the target triple which is a string describing the target host.
232  /// @returns a string containing the target triple.
233  const std::string &getTargetTriple() const { return TargetTriple; }
234 
235  /// Get the global data context.
236  /// @returns LLVMContext - a container for LLVM's global information
237  LLVMContext &getContext() const { return Context; }
238 
239  /// Get any module-scope inline assembly blocks.
240  /// @returns a string containing the module-scope inline assembly blocks.
241  const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
242 
243  /// Get a RandomNumberGenerator salted for use with this module. The
244  /// RNG can be seeded via -rng-seed=<uint64> and is salted with the
245  /// ModuleID and the provided pass salt. The returned RNG should not
246  /// be shared across threads or passes.
247  ///
248  /// A unique RNG per pass ensures a reproducible random stream even
249  /// when other randomness consuming passes are added or removed. In
250  /// addition, the random stream will be reproducible across LLVM
251  /// versions when the pass does not change.
252  std::unique_ptr<RandomNumberGenerator> createRNG(const Pass* P) const;
253 
254 /// @}
255 /// @name Module Level Mutators
256 /// @{
257 
258  /// Set the module identifier.
259  void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
260 
261  /// Set the module's original source file name.
262  void setSourceFileName(StringRef Name) { SourceFileName = Name; }
263 
264  /// Set the data layout
265  void setDataLayout(StringRef Desc);
266  void setDataLayout(const DataLayout &Other);
267 
268  /// Set the target triple.
269  void setTargetTriple(StringRef T) { TargetTriple = T; }
270 
271  /// Set the module-scope inline assembly blocks.
272  /// A trailing newline is added if the input doesn't have one.
274  GlobalScopeAsm = Asm;
275  if (!GlobalScopeAsm.empty() && GlobalScopeAsm.back() != '\n')
276  GlobalScopeAsm += '\n';
277  }
278 
279  /// Append to the module-scope inline assembly blocks.
280  /// A trailing newline is added if the input doesn't have one.
282  GlobalScopeAsm += Asm;
283  if (!GlobalScopeAsm.empty() && GlobalScopeAsm.back() != '\n')
284  GlobalScopeAsm += '\n';
285  }
286 
287 /// @}
288 /// @name Generic Value Accessors
289 /// @{
290 
291  /// Return the global value in the module with the specified name, of
292  /// arbitrary type. This method returns null if a global with the specified
293  /// name is not found.
295 
296  /// Return a unique non-zero ID for the specified metadata kind. This ID is
297  /// uniqued across modules in the current LLVMContext.
298  unsigned getMDKindID(StringRef Name) const;
299 
300  /// Populate client supplied SmallVector with the name for custom metadata IDs
301  /// registered in this LLVMContext.
302  void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
303 
304  /// Populate client supplied SmallVector with the bundle tags registered in
305  /// this LLVMContext. The bundle tags are ordered by increasing bundle IDs.
306  /// \see LLVMContext::getOperandBundleTagID
308 
309  /// Return the type with the specified name, or null if there is none by that
310  /// name.
311  StructType *getTypeByName(StringRef Name) const;
312 
313  std::vector<StructType *> getIdentifiedStructTypes() const;
314 
315 /// @}
316 /// @name Function Accessors
317 /// @{
318 
319  /// Look up the specified function in the module symbol table. Four
320  /// possibilities:
321  /// 1. If it does not exist, add a prototype for the function and return it.
322  /// 2. If it exists, and has a local linkage, the existing function is
323  /// renamed and a new one is inserted.
324  /// 3. Otherwise, if the existing function has the correct prototype, return
325  /// the existing function.
326  /// 4. Finally, the function exists but has the wrong prototype: return the
327  /// function with a constantexpr cast to the right prototype.
330 
332 
333  /// Look up the specified function in the module symbol table. If it does not
334  /// exist, add a prototype for the function and return it. This function
335  /// guarantees to return a constant of pointer to the specified function type
336  /// or a ConstantExpr BitCast of that type if the named function has a
337  /// different type. This version of the method takes a list of
338  /// function arguments, which makes it easier for clients to use.
339  template<typename... ArgsTy>
341  AttributeList AttributeList,
342  Type *RetTy, ArgsTy... Args)
343  {
344  SmallVector<Type*, sizeof...(ArgsTy)> ArgTys{Args...};
345  return getOrInsertFunction(Name,
346  FunctionType::get(RetTy, ArgTys, false),
347  AttributeList);
348  }
349 
350  /// Same as above, but without the attributes.
351  template<typename... ArgsTy>
352  Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ArgsTy... Args) {
353  return getOrInsertFunction(Name, AttributeList{}, RetTy, Args...);
354  }
355 
356  /// Look up the specified function in the module symbol table. If it does not
357  /// exist, return null.
358  Function *getFunction(StringRef Name) const;
359 
360 /// @}
361 /// @name Global Variable Accessors
362 /// @{
363 
364  /// Look up the specified global variable in the module symbol table. If it
365  /// does not exist, return null. If AllowInternal is set to true, this
366  /// function will return types that have InternalLinkage. By default, these
367  /// types are not returned.
369  return getGlobalVariable(Name, false);
370  }
371 
372  GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal) const;
373 
375  bool AllowInternal = false) {
376  return static_cast<const Module *>(this)->getGlobalVariable(Name,
377  AllowInternal);
378  }
379 
380  /// Return the global variable in the module with the specified name, of
381  /// arbitrary type. This method returns null if a global with the specified
382  /// name is not found.
384  return getGlobalVariable(Name, true);
385  }
387  return const_cast<GlobalVariable *>(
388  static_cast<const Module *>(this)->getNamedGlobal(Name));
389  }
390 
391  /// Look up the specified global in the module symbol table.
392  /// 1. If it does not exist, add a declaration of the global and return it.
393  /// 2. Else, the global exists but has the wrong type: return the function
394  /// with a constantexpr cast to the right type.
395  /// 3. Finally, if the existing global is the correct declaration, return
396  /// the existing global.
398 
399 /// @}
400 /// @name Global Alias Accessors
401 /// @{
402 
403  /// Return the global alias in the module with the specified name, of
404  /// arbitrary type. This method returns null if a global with the specified
405  /// name is not found.
406  GlobalAlias *getNamedAlias(StringRef Name) const;
407 
408 /// @}
409 /// @name Global IFunc Accessors
410 /// @{
411 
412  /// Return the global ifunc in the module with the specified name, of
413  /// arbitrary type. This method returns null if a global with the specified
414  /// name is not found.
415  GlobalIFunc *getNamedIFunc(StringRef Name) const;
416 
417 /// @}
418 /// @name Named Metadata Accessors
419 /// @{
420 
421  /// Return the first NamedMDNode in the module with the specified name. This
422  /// method returns null if a NamedMDNode with the specified name is not found.
423  NamedMDNode *getNamedMetadata(const Twine &Name) const;
424 
425  /// Return the named MDNode in the module with the specified name. This method
426  /// returns a new NamedMDNode if a NamedMDNode with the specified name is not
427  /// found.
429 
430  /// Remove the given NamedMDNode from this module and delete it.
431  void eraseNamedMetadata(NamedMDNode *NMD);
432 
433 /// @}
434 /// @name Comdat Accessors
435 /// @{
436 
437  /// Return the Comdat in the module with the specified name. It is created
438  /// if it didn't already exist.
440 
441 /// @}
442 /// @name Module Flags Accessors
443 /// @{
444 
445  /// Returns the module flags in the provided vector.
447 
448  /// Return the corresponding value if Key appears in module flags, otherwise
449  /// return null.
451 
452  /// Returns the NamedMDNode in the module that represents module-level flags.
453  /// This method returns null if there are no module-level flags.
455 
456  /// Returns the NamedMDNode in the module that represents module-level flags.
457  /// If module-level flags aren't found, it creates the named metadata that
458  /// contains them.
460 
461  /// Add a module-level flag to the module-level flags metadata. It will create
462  /// the module-level flags named metadata if it doesn't already exist.
464  void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Constant *Val);
465  void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
466  void addModuleFlag(MDNode *Node);
467 
468 /// @}
469 /// @name Materialization
470 /// @{
471 
472  /// Sets the GVMaterializer to GVM. This module must not yet have a
473  /// Materializer. To reset the materializer for a module that already has one,
474  /// call materializeAll first. Destroying this module will destroy
475  /// its materializer without materializing any more GlobalValues. Without
476  /// destroying the Module, there is no way to detach or destroy a materializer
477  /// without materializing all the GVs it controls, to avoid leaving orphan
478  /// unmaterialized GVs.
479  void setMaterializer(GVMaterializer *GVM);
480  /// Retrieves the GVMaterializer, if any, for this Module.
481  GVMaterializer *getMaterializer() const { return Materializer.get(); }
482  bool isMaterialized() const { return !getMaterializer(); }
483 
484  /// Make sure the GlobalValue is fully read.
486 
487  /// Make sure all GlobalValues in this Module are fully read and clear the
488  /// Materializer.
490 
492 
493 /// @}
494 /// @name Direct access to the globals list, functions list, and symbol table
495 /// @{
496 
497  /// Get the Module's list of global variables (constant).
498  const GlobalListType &getGlobalList() const { return GlobalList; }
499  /// Get the Module's list of global variables.
500  GlobalListType &getGlobalList() { return GlobalList; }
501 
503  return &Module::GlobalList;
504  }
505 
506  /// Get the Module's list of functions (constant).
507  const FunctionListType &getFunctionList() const { return FunctionList; }
508  /// Get the Module's list of functions.
509  FunctionListType &getFunctionList() { return FunctionList; }
511  return &Module::FunctionList;
512  }
513 
514  /// Get the Module's list of aliases (constant).
515  const AliasListType &getAliasList() const { return AliasList; }
516  /// Get the Module's list of aliases.
517  AliasListType &getAliasList() { return AliasList; }
518 
520  return &Module::AliasList;
521  }
522 
523  /// Get the Module's list of ifuncs (constant).
524  const IFuncListType &getIFuncList() const { return IFuncList; }
525  /// Get the Module's list of ifuncs.
526  IFuncListType &getIFuncList() { return IFuncList; }
527 
529  return &Module::IFuncList;
530  }
531 
532  /// Get the Module's list of named metadata (constant).
533  const NamedMDListType &getNamedMDList() const { return NamedMDList; }
534  /// Get the Module's list of named metadata.
535  NamedMDListType &getNamedMDList() { return NamedMDList; }
536 
538  return &Module::NamedMDList;
539  }
540 
541  /// Get the symbol table of global variable and function identifiers
542  const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
543  /// Get the Module's symbol table of global variable and function identifiers.
544  ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; }
545 
546  /// Get the Module's symbol table for COMDATs (constant).
547  const ComdatSymTabType &getComdatSymbolTable() const { return ComdatSymTab; }
548  /// Get the Module's symbol table for COMDATs.
549  ComdatSymTabType &getComdatSymbolTable() { return ComdatSymTab; }
550 
551 /// @}
552 /// @name Global Variable Iteration
553 /// @{
554 
555  global_iterator global_begin() { return GlobalList.begin(); }
556  const_global_iterator global_begin() const { return GlobalList.begin(); }
557  global_iterator global_end () { return GlobalList.end(); }
558  const_global_iterator global_end () const { return GlobalList.end(); }
559  bool global_empty() const { return GlobalList.empty(); }
560 
562  return make_range(global_begin(), global_end());
563  }
565  return make_range(global_begin(), global_end());
566  }
567 
568 /// @}
569 /// @name Function Iteration
570 /// @{
571 
572  iterator begin() { return FunctionList.begin(); }
573  const_iterator begin() const { return FunctionList.begin(); }
574  iterator end () { return FunctionList.end(); }
575  const_iterator end () const { return FunctionList.end(); }
576  reverse_iterator rbegin() { return FunctionList.rbegin(); }
577  const_reverse_iterator rbegin() const{ return FunctionList.rbegin(); }
578  reverse_iterator rend() { return FunctionList.rend(); }
579  const_reverse_iterator rend() const { return FunctionList.rend(); }
580  size_t size() const { return FunctionList.size(); }
581  bool empty() const { return FunctionList.empty(); }
582 
584  return make_range(begin(), end());
585  }
587  return make_range(begin(), end());
588  }
589 
590 /// @}
591 /// @name Alias Iteration
592 /// @{
593 
594  alias_iterator alias_begin() { return AliasList.begin(); }
595  const_alias_iterator alias_begin() const { return AliasList.begin(); }
596  alias_iterator alias_end () { return AliasList.end(); }
597  const_alias_iterator alias_end () const { return AliasList.end(); }
598  size_t alias_size () const { return AliasList.size(); }
599  bool alias_empty() const { return AliasList.empty(); }
600 
602  return make_range(alias_begin(), alias_end());
603  }
605  return make_range(alias_begin(), alias_end());
606  }
607 
608 /// @}
609 /// @name IFunc Iteration
610 /// @{
611 
612  ifunc_iterator ifunc_begin() { return IFuncList.begin(); }
613  const_ifunc_iterator ifunc_begin() const { return IFuncList.begin(); }
614  ifunc_iterator ifunc_end () { return IFuncList.end(); }
615  const_ifunc_iterator ifunc_end () const { return IFuncList.end(); }
616  size_t ifunc_size () const { return IFuncList.size(); }
617  bool ifunc_empty() const { return IFuncList.empty(); }
618 
620  return make_range(ifunc_begin(), ifunc_end());
621  }
623  return make_range(ifunc_begin(), ifunc_end());
624  }
625 
626  /// @}
627  /// @name Convenience iterators
628  /// @{
629 
630  using global_object_iterator =
635 
637  return concat<GlobalObject>(functions(), globals());
638  }
640  return concat<const GlobalObject>(functions(), globals());
641  }
642 
644  return global_objects().begin();
645  }
647 
649  return global_objects().begin();
650  }
652  return global_objects().end();
653  }
654 
655  using global_value_iterator =
661 
663  return concat<GlobalValue>(functions(), globals(), aliases(), ifuncs());
664  }
666  return concat<const GlobalValue>(functions(), globals(), aliases(),
667  ifuncs());
668  }
669 
672 
674  return global_values().begin();
675  }
677  return global_values().end();
678  }
679 
680  /// @}
681  /// @name Named Metadata Iteration
682  /// @{
683 
684  named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
686  return NamedMDList.begin();
687  }
688 
689  named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
691  return NamedMDList.end();
692  }
693 
694  size_t named_metadata_size() const { return NamedMDList.size(); }
695  bool named_metadata_empty() const { return NamedMDList.empty(); }
696 
699  }
702  }
703 
704  /// An iterator for DICompileUnits that skips those marked NoDebug.
706  : public std::iterator<std::input_iterator_tag, DICompileUnit *> {
707  NamedMDNode *CUs;
708  unsigned Idx;
709 
710  void SkipNoDebugCUs();
711 
712  public:
713  explicit debug_compile_units_iterator(NamedMDNode *CUs, unsigned Idx)
714  : CUs(CUs), Idx(Idx) {
715  SkipNoDebugCUs();
716  }
717 
719  ++Idx;
720  SkipNoDebugCUs();
721  return *this;
722  }
723 
726  ++Idx;
727  return T;
728  }
729 
731  return Idx == I.Idx;
732  }
733 
735  return Idx != I.Idx;
736  }
737 
738  DICompileUnit *operator*() const;
739  DICompileUnit *operator->() const;
740  };
741 
743  auto *CUs = getNamedMetadata("llvm.dbg.cu");
744  return debug_compile_units_iterator(CUs, 0);
745  }
746 
748  auto *CUs = getNamedMetadata("llvm.dbg.cu");
749  return debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0);
750  }
751 
752  /// Return an iterator for all DICompileUnits listed in this Module's
753  /// llvm.dbg.cu named metadata node and aren't explicitly marked as
754  /// NoDebug.
756  auto *CUs = getNamedMetadata("llvm.dbg.cu");
757  return make_range(
759  debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0));
760  }
761 /// @}
762 
763  /// Destroy ConstantArrays in LLVMContext if they are not used.
764  /// ConstantArrays constructed during linking can cause quadratic memory
765  /// explosion. Releasing all unused constants can cause a 20% LTO compile-time
766  /// slowdown for a large application.
767  ///
768  /// NOTE: Constants are currently owned by LLVMContext. This can then only
769  /// be called where all uses of the LLVMContext are understood.
771 
772 /// @name Utility functions for printing and dumping Module objects
773 /// @{
774 
775  /// Print the module to an output stream with an optional
776  /// AssemblyAnnotationWriter. If \c ShouldPreserveUseListOrder, then include
777  /// uselistorder directives so that use-lists can be recreated when reading
778  /// the assembly.
780  bool ShouldPreserveUseListOrder = false,
781  bool IsForDebug = false) const;
782 
783  /// Dump the module to stderr (for debugging).
784  void dump() const;
785 
786  /// This function causes all the subinstructions to "let go" of all references
787  /// that they are maintaining. This allows one to 'delete' a whole class at
788  /// a time, even though there may be circular references... first all
789  /// references are dropped, and all use counts go to zero. Then everything
790  /// is delete'd for real. Note that no operations are valid on an object
791  /// that has "dropped all references", except operator delete.
792  void dropAllReferences();
793 
794 /// @}
795 /// @name Utility functions for querying Debug information.
796 /// @{
797 
798  /// \brief Returns the Number of Register ParametersDwarf Version by checking
799  /// module flags.
800  unsigned getNumberRegisterParameters() const;
801 
802  /// \brief Returns the Dwarf Version by checking module flags.
803  unsigned getDwarfVersion() const;
804 
805  /// \brief Returns the CodeView Version by checking module flags.
806  /// Returns zero if not present in module.
807  unsigned getCodeViewFlag() const;
808 
809 /// @}
810 /// @name Utility functions for querying and setting PIC level
811 /// @{
812 
813  /// \brief Returns the PIC level (small or large model)
815 
816  /// \brief Set the PIC level (small or large model)
818 /// @}
819 
820 /// @}
821 /// @name Utility functions for querying and setting PIE level
822 /// @{
823 
824  /// \brief Returns the PIE level (small or large model)
826 
827  /// \brief Set the PIE level (small or large model)
828  void setPIELevel(PIELevel::Level PL);
829 /// @}
830 
831  /// @name Utility functions for querying and setting PGO summary
832  /// @{
833 
834  /// \brief Attach profile summary metadata to this module.
835  void setProfileSummary(Metadata *M);
836 
837  /// \brief Returns profile summary metadata
839  /// @}
840 
841  /// Take ownership of the given memory buffer.
842  void setOwnedMemoryBuffer(std::unique_ptr<MemoryBuffer> MB);
843 };
844 
845 /// \brief Given "llvm.used" or "llvm.compiler.used" as a global name, collect
846 /// the initializer elements of that global in Set and return the global itself.
849  bool CompilerUsed);
850 
851 /// An raw_ostream inserter for modules.
852 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
853  M.print(O, nullptr);
854  return O;
855 }
856 
857 // Create wrappers for C Binding types (see CBindingWrapping.h).
859 
860 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
861  * Module.
862  */
864  return reinterpret_cast<Module*>(MP);
865 }
866 
867 } // end namespace llvm
868 
869 #endif // LLVM_IR_MODULE_H
Pass interface - Implemented by all &#39;passes&#39;.
Definition: Pass.h:81
uint64_t CallInst * C
debug_compile_units_iterator debug_compile_units_end() const
Definition: Module.h:747
const_alias_iterator alias_end() const
Definition: Module.h:597
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:109
const std::string & getTargetTriple() const
Get the target triple which is a string describing the target host.
Definition: Module.h:233
This class provides a symbol table of name/value pairs.
const_named_metadata_iterator named_metadata_begin() const
Definition: Module.h:685
llvm::Error materializeAll()
Make sure all GlobalValues in this Module are fully read and clear the Materializer.
Definition: Module.cpp:393
LLVMContext & Context
ValueSymbolTable & getValueSymbolTable()
Get the Module&#39;s symbol table of global variable and function identifiers.
Definition: Module.h:544
const_reverse_iterator rend() const
Definition: Module.h:579
Takes the max of the two values, which are required to be integers.
Definition: Module.h:143
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
struct LLVMOpaqueModule * LLVMModuleRef
The top-level container for all other LLVM Intermediate Representation (IR) objects.
Definition: Types.h:62
Constant * getOrInsertFunction(StringRef Name, FunctionType *T, AttributeList AttributeList)
Look up the specified function in the module symbol table.
Definition: Module.cpp:142
NamedMDNode * getModuleFlagsMetadata() const
Returns the NamedMDNode in the module that represents module-level flags.
Definition: Module.cpp:315
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:63
void setModuleIdentifier(StringRef ID)
Set the module identifier.
Definition: Module.h:259
const ValueSymbolTable & getValueSymbolTable() const
Get the symbol table of global variable and function identifiers.
Definition: Module.h:542
This provides a very simple, boring adaptor for a begin and end iterator into a range type...
void setMaterializer(GVMaterializer *GVM)
Sets the GVMaterializer to GVM.
Definition: Module.cpp:379
const std::string & getStringRepresentation() const
Returns the string representation of the DataLayout.
Definition: DataLayout.h:224
size_t named_metadata_size() const
Definition: Module.h:694
debug_compile_units_iterator operator++(int)
Definition: Module.h:724
named_metadata_iterator named_metadata_end()
Definition: Module.h:689
This file contains the declarations for metadata subclasses.
FunctionListType::iterator iterator
The Function iterators.
Definition: Module.h:86
const GlobalVariable * getNamedGlobal(StringRef Name) const
Return the global variable in the module with the specified name, of arbitrary type.
Definition: Module.h:383
ifunc_iterator ifunc_end()
Definition: Module.h:614
iterator_range< const_iterator > functions() const
Definition: Module.h:586
bool global_empty() const
Definition: Module.h:559
NamedMDNode * getOrInsertNamedMetadata(StringRef Name)
Return the named MDNode in the module with the specified name.
Definition: Module.cpp:251
const_iterator begin() const
Definition: Module.h:573
void setDataLayout(StringRef Desc)
Set the data layout.
Definition: Module.cpp:355
global_object_iterator global_object_begin()
Definition: Module.h:643
debug_compile_units_iterator & operator++()
Definition: Module.h:718
const_reverse_iterator rbegin() const
Definition: Module.h:577
const std::string & getDataLayoutStr() const
Get the data layout string for the module&#39;s target platform.
Definition: Module.h:224
GlobalVariable * getGlobalVariable(StringRef Name) const
Look up the specified global variable in the module symbol table.
Definition: Module.h:368
const_global_iterator global_end() const
Definition: Module.h:558
Metadata node.
Definition: Metadata.h:862
StringRef getName() const
Get a short "name" for the module.
Definition: Module.h:220
AliasListType::iterator alias_iterator
The Global Alias iterators.
Definition: Module.h:96
const GlobalListType & getGlobalList() const
Get the Module&#39;s list of global variables (constant).
Definition: Module.h:498
iterator_range< const_ifunc_iterator > ifuncs() const
Definition: Module.h:622
const_ifunc_iterator ifunc_begin() const
Definition: Module.h:613
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:345
Adds a requirement that another module flag be present and have a specified value after linking is pe...
Definition: Module.h:127
const AliasListType & getAliasList() const
Get the Module&#39;s list of aliases (constant).
Definition: Module.h:515
iterator_range< global_object_iterator > global_objects()
Definition: Module.h:636
ComdatSymTabType & getComdatSymbolTable()
Get the Module&#39;s symbol table for COMDATs.
Definition: Module.h:549
ModFlagBehavior Behavior
Definition: Module.h:155
Appends the two values, which are required to be metadata nodes.
Definition: Module.h:135
GlobalAlias * getNamedAlias(StringRef Name) const
Return the global alias in the module with the specified name, of arbitrary type. ...
Definition: Module.cpp:231
A tuple of MDNodes.
Definition: Metadata.h:1316
iterator_range< const_global_iterator > globals() const
Definition: Module.h:564
#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)
const DataLayout & getDataLayout() const
Get the data layout for the module&#39;s target platform.
Definition: Module.cpp:361
global_value_iterator global_value_end()
Definition: Module.h:671
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
Attribute unwrap(LLVMAttributeRef Attr)
Definition: Attributes.h:195
void eraseNamedMetadata(NamedMDNode *NMD)
Remove the given NamedMDNode from this module and delete it.
Definition: Module.cpp:264
const ComdatSymTabType & getComdatSymbolTable() const
Get the Module&#39;s symbol table for COMDATs (constant).
Definition: Module.h:547
Class to represent struct types.
Definition: DerivedTypes.h:201
LLVMContext & getContext() const
Get the global data context.
Definition: Module.h:237
This file contains the simple types necessary to represent the attributes associated with functions a...
void setModuleInlineAsm(StringRef Asm)
Set the module-scope inline assembly blocks.
Definition: Module.h:273
Metadata * getProfileSummary()
Returns profile summary metadata.
Definition: Module.cpp:505
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:695
APInt operator*(APInt a, uint64_t RHS)
Definition: APInt.h:2070
global_iterator global_begin()
Definition: Module.h:555
Class to represent function types.
Definition: DerivedTypes.h:103
reverse_iterator rend()
Definition: Module.h:578
NamedMDListType & getNamedMDList()
Get the Module&#39;s list of named metadata.
Definition: Module.h:535
const_iterator end() const
Definition: Module.h:575
bool empty() const
Definition: Module.h:581
bool operator==(const debug_compile_units_iterator &I) const
Definition: Module.h:730
#define T
NamedMDNode * getNamedMetadata(const Twine &Name) const
Return the first NamedMDNode in the module with the specified name.
Definition: Module.cpp:242
GlobalValue * getNamedValue(StringRef Name) const
Return the global value in the module with the specified name, of arbitrary type. ...
Definition: Module.cpp:112
debug_compile_units_iterator debug_compile_units_begin() const
Definition: Module.h:742
global_object_iterator global_object_end()
Definition: Module.h:646
iterator_range< const_alias_iterator > aliases() const
Definition: Module.h:604
This file contains the declaration of the Comdat class, which represents a single COMDAT in LLVM...
void dropAllReferences()
This function causes all the subinstructions to "let go" of all references that they are maintaining...
Definition: Module.cpp:431
const_alias_iterator alias_begin() const
Definition: Module.h:595
const char * Name
IFuncListType & getIFuncList()
Get the Module&#39;s list of ifuncs.
Definition: Module.h:526
const std::string & getSourceFileName() const
Get the module&#39;s original source file name.
Definition: Module.h:214
unsigned getCodeViewFlag() const
Returns the CodeView Version by checking module flags.
Definition: Module.cpp:460
static AliasListType Module::* getSublistAccess(GlobalAlias *)
Definition: Module.h:519
bool alias_empty() const
Definition: Module.h:599
void getOperandBundleTags(SmallVectorImpl< StringRef > &Result) const
Populate client supplied SmallVector with the bundle tags registered in this LLVMContext.
Definition: Module.cpp:129
static IFuncListType Module::* getSublistAccess(GlobalIFunc *)
Definition: Module.h:528
#define P(N)
Module(StringRef ModuleID, LLVMContext &C)
The Module constructor.
Definition: Module.cpp:72
Emits an error if two values disagree, otherwise the resulting value is that of the operands...
Definition: Module.h:114
iterator_range< iterator > functions()
Definition: Module.h:583
alias_iterator alias_end()
Definition: Module.h:596
PIELevel::Level getPIELevel() const
Returns the PIE level (small or large model)
Definition: Module.cpp:487
const FunctionListType & getFunctionList() const
Get the Module&#39;s list of functions (constant).
Definition: Module.h:507
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
AliasListType & getAliasList()
Get the Module&#39;s list of aliases.
Definition: Module.h:517
iterator_range< const_global_object_iterator > global_objects() const
Definition: Module.h:639
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:68
Constant * getOrInsertGlobal(StringRef Name, Type *Ty)
Look up the specified global in the module symbol table.
Definition: Module.cpp:202
Metadata * getModuleFlag(StringRef Key) const
Return the corresponding value if Key appears in module flags, otherwise return null.
Definition: Module.cpp:302
This is an important base class in LLVM.
Definition: Constant.h:42
ifunc_iterator ifunc_begin()
Definition: Module.h:612
iterator_range< const_global_value_iterator > global_values() const
Definition: Module.h:665
void dump() const
Dump the module to stderr (for debugging).
Definition: AsmWriter.cpp:3614
static GlobalListType Module::* getSublistAccess(GlobalVariable *)
Definition: Module.h:502
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
ModFlagBehavior
This enumeration defines the supported behaviors of module flags.
Definition: Module.h:111
size_t alias_size() const
Definition: Module.h:598
iterator_range< named_metadata_iterator > named_metadata()
Definition: Module.h:697
static FunctionListType Module::* getSublistAccess(Function *)
Definition: Module.h:510
void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Metadata *Val)
Add a module-level flag to the module-level flags metadata.
Definition: Module.cpp:329
AliasListType::const_iterator const_alias_iterator
The Global Alias constant iterator.
Definition: Module.h:98
static FunctionType * get(Type *Result, ArrayRef< Type *> Params, bool isVarArg)
This static method is the primary way of constructing a FunctionType.
Definition: Type.cpp:297
const_global_value_iterator global_value_end() const
Definition: Module.h:676
An iterator for DICompileUnits that skips those marked NoDebug.
Definition: Module.h:705
struct LLVMOpaqueModuleProvider * LLVMModuleProviderRef
Interface used to provide a module to JIT or interpreter.
Definition: Types.h:111
Comdat * getOrInsertComdat(StringRef Name)
Return the Comdat in the module with the specified name.
Definition: Module.cpp:467
const NamedMDListType & getNamedMDList() const
Get the Module&#39;s list of named metadata (constant).
Definition: Module.h:533
const std::string & getModuleIdentifier() const
Get the module identifier which is, essentially, the name of the module.
Definition: Module.h:208
unsigned getDwarfVersion() const
Returns the Dwarf Version by checking module flags.
Definition: Module.cpp:453
An intrusive list with ownership and callbacks specified/controlled by ilist_traits, only with API safe for polymorphic types.
Definition: ilist.h:403
const_global_value_iterator global_value_begin() const
Definition: Module.h:673
const IFuncListType & getIFuncList() const
Get the Module&#39;s list of ifuncs (constant).
Definition: Module.h:524
std::vector< StructType * > getIdentifiedStructTypes() const
Definition: Module.cpp:410
reverse_iterator rbegin()
Definition: Module.h:576
void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW, bool ShouldPreserveUseListOrder=false, bool IsForDebug=false) const
Print the module to an output stream with an optional AssemblyAnnotationWriter.
Definition: AsmWriter.cpp:3376
global_iterator global_end()
Definition: Module.h:557
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
GlobalVariable * collectUsedGlobalVariables(const Module &M, SmallPtrSetImpl< GlobalValue *> &Set, bool CompilerUsed)
Given "llvm.used" or "llvm.compiler.used" as a global name, collect the initializer elements of that ...
Definition: Module.cpp:513
Iterator for intrusive lists based on ilist_node.
ModuleFlagEntry(ModFlagBehavior B, MDString *K, Metadata *V)
Definition: Module.h:159
GlobalListType & getGlobalList()
Get the Module&#39;s list of global variables.
Definition: Module.h:500
#define B
Definition: LargeTest.cpp:24
void dropTriviallyDeadConstantArrays()
Destroy ConstantArrays in LLVMContext if they are not used.
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:864
static bool isValidModFlagBehavior(Metadata *MD, ModFlagBehavior &MFB)
Checks if Metadata represents a valid ModFlagBehavior, and stores the converted result in MFB...
Definition: Module.cpp:269
GlobalVariable * getNamedGlobal(StringRef Name)
Definition: Module.h:386
always inline
NamedMDNode * getOrInsertModuleFlagsMetadata()
Returns the NamedMDNode in the module that represents module-level flags.
Definition: Module.cpp:322
alias_iterator alias_begin()
Definition: Module.h:594
const_ifunc_iterator ifunc_end() const
Definition: Module.h:615
Constant * getOrInsertFunction(StringRef Name, Type *RetTy, ArgsTy... Args)
Same as above, but without the attributes.
Definition: Module.h:352
size_t ifunc_size() const
Definition: Module.h:616
static NamedMDListType Module::* getSublistAccess(NamedMDNode *)
Definition: Module.h:537
Uses the specified value, regardless of the behavior or value of the other module.
Definition: Module.h:132
Function * getFunction(StringRef Name) const
Look up the specified function in the module symbol table.
Definition: Module.cpp:172
A range adaptor for a pair of iterators.
Constant * getOrInsertFunction(StringRef Name, AttributeList AttributeList, Type *RetTy, ArgsTy... Args)
Look up the specified function in the module symbol table.
Definition: Module.h:340
Emits a warning if two values disagree.
Definition: Module.h:118
FunctionListType & getFunctionList()
Get the Module&#39;s list of functions.
Definition: Module.h:509
const_global_object_iterator global_object_begin() const
Definition: Module.h:648
const_named_metadata_iterator named_metadata_end() const
Definition: Module.h:690
bool isMaterialized() const
Definition: Module.h:482
static std::vector< std::string > Flags
Definition: FlagsTest.cpp:8
void setProfileSummary(Metadata *M)
Attach profile summary metadata to this module.
Definition: Module.cpp:501
debug_compile_units_iterator(NamedMDNode *CUs, unsigned Idx)
Definition: Module.h:713
iterator end()
Definition: Module.h:574
Appends the two values, which are required to be metadata nodes.
Definition: Module.h:140
bool ifunc_empty() const
Definition: Module.h:617
GlobalVariable * getGlobalVariable(StringRef Name, bool AllowInternal=false)
Definition: Module.h:374
void setSourceFileName(StringRef Name)
Set the module&#39;s original source file name.
Definition: Module.h:262
size_t size() const
Definition: Module.h:580
#define I(x, y, z)
Definition: MD5.cpp:58
global_value_iterator global_value_begin()
Definition: Module.h:670
iterator_range< debug_compile_units_iterator > debug_compile_units() const
Return an iterator for all DICompileUnits listed in this Module&#39;s llvm.dbg.cu named metadata node and...
Definition: Module.h:755
std::unique_ptr< RandomNumberGenerator > createRNG(const Pass *P) const
Get a RandomNumberGenerator salted for use with this module.
Definition: Module.cpp:91
iterator begin()
Definition: Module.h:572
void appendModuleInlineAsm(StringRef Asm)
Append to the module-scope inline assembly blocks.
Definition: Module.h:281
llvm::Error materialize(GlobalValue *GV)
Make sure the GlobalValue is fully read.
Definition: Module.cpp:386
void setTargetTriple(StringRef T)
Set the target triple.
Definition: Module.h:269
StructType * getTypeByName(StringRef Name) const
Return the type with the specified name, or null if there is none by that name.
Definition: Type.cpp:509
~Module()
The module destructor. This will dropAllReferences.
Definition: Module.cpp:79
void setPIELevel(PIELevel::Level PL)
Set the PIE level (small or large model)
Definition: Module.cpp:497
iterator_range< ifunc_iterator > ifuncs()
Definition: Module.h:619
void setOwnedMemoryBuffer(std::unique_ptr< MemoryBuffer > MB)
Take ownership of the given memory buffer.
Definition: Module.cpp:509
raw_ostream & operator<<(raw_ostream &OS, const APInt &I)
Definition: APInt.h:2018
const std::string & getModuleInlineAsm() const
Get any module-scope inline assembly blocks.
Definition: Module.h:241
void getMDKindNames(SmallVectorImpl< StringRef > &Result) const
Populate client supplied SmallVector with the name for custom metadata IDs registered in this LLVMCon...
Definition: Module.cpp:125
unsigned getMDKindID(StringRef Name) const
Return a unique non-zero ID for the specified metadata kind.
Definition: Module.cpp:118
unsigned getNumberRegisterParameters() const
Returns the Number of Register ParametersDwarf Version by checking module flags.
Definition: Module.cpp:445
FunctionListType::const_iterator const_iterator
The Function constant iterator.
Definition: Module.h:88
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
bool named_metadata_empty() const
Definition: Module.h:695
GlobalListType::const_iterator const_global_iterator
The Global Variable constant iterator.
Definition: Module.h:83
const_global_iterator global_begin() const
Definition: Module.h:556
void setPICLevel(PICLevel::Level PL)
Set the PIC level (small or large model)
Definition: Module.cpp:483
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:44
PICLevel::Level getPICLevel() const
Returns the PIC level (small or large model)
Definition: Module.cpp:473
iterator_range< global_iterator > globals()
Definition: Module.h:561
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
A single uniqued string.
Definition: Metadata.h:602
Iterator wrapper that concatenates sequences together.
Definition: STLExtras.h:520
iterator_range< global_value_iterator > global_values()
Definition: Module.h:662
GlobalIFunc * getNamedIFunc(StringRef Name) const
Return the global ifunc in the module with the specified name, of arbitrary type. ...
Definition: Module.cpp:235
Root of the metadata hierarchy.
Definition: Metadata.h:58
GlobalListType::iterator global_iterator
The Global Variable iterator.
Definition: Module.h:81
llvm::Error materializeMetadata()
Definition: Module.cpp:400
bool operator!=(const debug_compile_units_iterator &I) const
Definition: Module.h:734
named_metadata_iterator named_metadata_begin()
Definition: Module.h:684
const_global_object_iterator global_object_end() const
Definition: Module.h:651
GVMaterializer * getMaterializer() const
Retrieves the GVMaterializer, if any, for this Module.
Definition: Module.h:481
iterator_range< const_named_metadata_iterator > named_metadata() const
Definition: Module.h:700
iterator_range< alias_iterator > aliases()
Definition: Module.h:601