include/llvm/IR/Function.h

   1 //===-- llvm/Function.h - Class to represent a single function --*- 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 // This file contains the declaration of the Function class, which represents a
  11 // single function/procedure in LLVM.
  12 //
  13 // A function basically consists of a list of basic blocks, a list of arguments,
  14 // and a symbol table.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_IR_FUNCTION_H
  19 #define LLVM_IR_FUNCTION_H
  20
  21 #include "llvm/ADT/iterator_range.h"
  22 #include "llvm/ADT/Optional.h"
  23 #include "llvm/IR/Argument.h"
  24 #include "llvm/IR/Attributes.h"
  25 #include "llvm/IR/BasicBlock.h"
  26 #include "llvm/IR/CallingConv.h"
  27 #include "llvm/IR/GlobalObject.h"
  28 #include "llvm/IR/OperandTraits.h"
  29 #include "llvm/Support/Compiler.h"
  30
  31 namespace llvm {
  32
  33 class FunctionType;
  34 class LLVMContext;
  35
  36 template<> struct ilist_traits<Argument>
  37   : public SymbolTableListTraits<Argument, Function> {
  38
  39   Argument *createSentinel() const {
  40     return static_cast<Argument*>(&Sentinel);
  41   }
  42   static void destroySentinel(Argument*) {}
  43
  44   Argument *provideInitialHead() const { return createSentinel(); }
  45   Argument *ensureHead(Argument*) const { return createSentinel(); }
  46   static void noteHead(Argument*, Argument*) {}
  47
  48   static ValueSymbolTable *getSymTab(Function *ItemParent);
  49 private:
  50   mutable ilist_half_node<Argument> Sentinel;
  51 };
  52
  53 class Function : public GlobalObject, public ilist_node<Function> {
  54 public:
  55   typedef iplist<Argument> ArgumentListType;
  56   typedef iplist<BasicBlock> BasicBlockListType;
  57
  58   // BasicBlock iterators...
  59   typedef BasicBlockListType::iterator iterator;
  60   typedef BasicBlockListType::const_iterator const_iterator;
  61
  62   typedef ArgumentListType::iterator arg_iterator;
  63   typedef ArgumentListType::const_iterator const_arg_iterator;
  64
  65 private:
  66   // Important things that make up a function!
  67   BasicBlockListType  BasicBlocks;        ///< The basic blocks
  68   mutable ArgumentListType ArgumentList;  ///< The formal arguments
  69   ValueSymbolTable *SymTab;               ///< Symbol table of args/instructions
  70   AttributeSet AttributeSets;             ///< Parameter attributes
  71   FunctionType *Ty;
  72
  73   /*
  74    * Value::SubclassData
  75    *
  76    * bit 0  : HasLazyArguments
  77    * bit 1  : HasPrefixData
  78    * bit 2  : HasPrologueData
  79    * bit 3-6: CallingConvention
  80    */
  81
  82   /// Bits from GlobalObject::GlobalObjectSubclassData.
  83   enum {
  84     /// Whether this function is materializable.
  85     IsMaterializableBit = 1 << 0,
  86     HasMetadataHashEntryBit = 1 << 1
  87   };
  88   void setGlobalObjectBit(unsigned Mask, bool Value) {
  89     setGlobalObjectSubClassData((~Mask & getGlobalObjectSubClassData()) |
  90                                 (Value ? Mask : 0u));
  91   }
  92
  93   friend class SymbolTableListTraits<Function, Module>;
  94
  95   void setParent(Module *parent);
  96
  97   /// hasLazyArguments/CheckLazyArguments - The argument list of a function is
  98   /// built on demand, so that the list isn't allocated until the first client
  99   /// needs it.  The hasLazyArguments predicate returns true if the arg list
 100   /// hasn't been set up yet.
 101   bool hasLazyArguments() const {
 102     return getSubclassDataFromValue() & (1<<0);
 103   }
 104   void CheckLazyArguments() const {
 105     if (hasLazyArguments())
 106       BuildLazyArguments();
 107   }
 108   void BuildLazyArguments() const;
 109
 110   Function(const Function&) = delete;
 111   void operator=(const Function&) = delete;
 112
 113   /// Function ctor - If the (optional) Module argument is specified, the
 114   /// function is automatically inserted into the end of the function list for
 115   /// the module.
 116   ///
 117   Function(FunctionType *Ty, LinkageTypes Linkage,
 118            const Twine &N = "", Module *M = nullptr);
 119
 120 public:
 121   static Function *Create(FunctionType *Ty, LinkageTypes Linkage,
 122                           const Twine &N = "", Module *M = nullptr) {
 123     return new(1) Function(Ty, Linkage, N, M);
 124   }
 125
 126   ~Function() override;
 127
 128   /// \brief Provide fast operand accessors
 129   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 130
 131   /// \brief Get the personality function associated with this function.
 132   bool hasPersonalityFn() const { return getNumOperands() != 0; }
 133   Constant *getPersonalityFn() const {
 134     assert(hasPersonalityFn());
 135     return cast<Constant>(Op<0>());
 136   }
 137   void setPersonalityFn(Constant *C);
 138
 139   Type *getReturnType() const;           // Return the type of the ret val
 140   FunctionType *getFunctionType() const; // Return the FunctionType for me
 141
 142   /// getContext - Return a reference to the LLVMContext associated with this
 143   /// function.
 144   LLVMContext &getContext() const;
 145
 146   /// isVarArg - Return true if this function takes a variable number of
 147   /// arguments.
 148   bool isVarArg() const;
 149
 150   bool isMaterializable() const;
 151   void setIsMaterializable(bool V);
 152
 153   /// getIntrinsicID - This method returns the ID number of the specified
 154   /// function, or Intrinsic::not_intrinsic if the function is not an
 155   /// intrinsic, or if the pointer is null.  This value is always defined to be
 156   /// zero to allow easy checking for whether a function is intrinsic or not.
 157   /// The particular intrinsic functions which correspond to this value are
 158   /// defined in llvm/Intrinsics.h.
 159   Intrinsic::ID getIntrinsicID() const LLVM_READONLY { return IntID; }
 160   bool isIntrinsic() const { return getName().startswith("llvm."); }
 161
 162   /// \brief Recalculate the ID for this function if it is an Intrinsic defined
 163   /// in llvm/Intrinsics.h.  Sets the intrinsic ID to Intrinsic::not_intrinsic
 164   /// if the name of this function does not match an intrinsic in that header.
 165   /// Note, this method does not need to be called directly, as it is called
 166   /// from Value::setName() whenever the name of this function changes.
 167   void recalculateIntrinsicID();
 168
 169   /// getCallingConv()/setCallingConv(CC) - These method get and set the
 170   /// calling convention of this function.  The enum values for the known
 171   /// calling conventions are defined in CallingConv.h.
 172   CallingConv::ID getCallingConv() const {
 173     return static_cast<CallingConv::ID>(getSubclassDataFromValue() >> 3);
 174   }
 175   void setCallingConv(CallingConv::ID CC) {
 176     setValueSubclassData((getSubclassDataFromValue() & 7) |
 177                          (static_cast<unsigned>(CC) << 3));
 178   }
 179
 180   /// @brief Return the attribute list for this Function.
 181   AttributeSet getAttributes() const { return AttributeSets; }
 182
 183   /// @brief Set the attribute list for this Function.
 184   void setAttributes(AttributeSet attrs) { AttributeSets = attrs; }
 185
 186   /// @brief Add function attributes to this function.
 187   void addFnAttr(Attribute::AttrKind N) {
 188     setAttributes(AttributeSets.addAttribute(getContext(),
 189                                              AttributeSet::FunctionIndex, N));
 190   }
 191
 192   /// @brief Remove function attributes from this function.
 193   void removeFnAttr(Attribute::AttrKind N) {
 194     setAttributes(AttributeSets.removeAttribute(
 195         getContext(), AttributeSet::FunctionIndex, N));
 196   }
 197
 198   /// @brief Add function attributes to this function.
 199   void addFnAttr(StringRef Kind) {
 200     setAttributes(
 201       AttributeSets.addAttribute(getContext(),
 202                                  AttributeSet::FunctionIndex, Kind));
 203   }
 204   void addFnAttr(StringRef Kind, StringRef Value) {
 205     setAttributes(
 206       AttributeSets.addAttribute(getContext(),
 207                                  AttributeSet::FunctionIndex, Kind, Value));
 208   }
 209
 210   /// Set the entry count for this function.
 211   void setEntryCount(uint64_t Count);
 212
 213   /// Get the entry count for this function.
 214   Optional<uint64_t> getEntryCount() const;
 215
 216   /// @brief Return true if the function has the attribute.
 217   bool hasFnAttribute(Attribute::AttrKind Kind) const {
 218     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex, Kind);
 219   }
 220   bool hasFnAttribute(StringRef Kind) const {
 221     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex, Kind);
 222   }
 223
 224   /// @brief Return the attribute for the given attribute kind.
 225   Attribute getFnAttribute(Attribute::AttrKind Kind) const {
 226     return AttributeSets.getAttribute(AttributeSet::FunctionIndex, Kind);
 227   }
 228   Attribute getFnAttribute(StringRef Kind) const {
 229     return AttributeSets.getAttribute(AttributeSet::FunctionIndex, Kind);
 230   }
 231
 232   /// \brief Return the stack alignment for the function.
 233   unsigned getFnStackAlignment() const {
 234     return AttributeSets.getStackAlignment(AttributeSet::FunctionIndex);
 235   }
 236
 237   /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm
 238   ///                             to use during code generation.
 239   bool hasGC() const;
 240   const char *getGC() const;
 241   void setGC(const char *Str);
 242   void clearGC();
 243
 244   /// @brief adds the attribute to the list of attributes.
 245   void addAttribute(unsigned i, Attribute::AttrKind attr);
 246
 247   /// @brief adds the attributes to the list of attributes.
 248   void addAttributes(unsigned i, AttributeSet attrs);
 249
 250   /// @brief removes the attributes from the list of attributes.
 251   void removeAttributes(unsigned i, AttributeSet attr);
 252
 253   /// @brief adds the dereferenceable attribute to the list of attributes.
 254   void addDereferenceableAttr(unsigned i, uint64_t Bytes);
 255
 256   /// @brief adds the dereferenceable_or_null attribute to the list of
 257   /// attributes.
 258   void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
 259
 260   /// @brief Extract the alignment for a call or parameter (0=unknown).
 261   unsigned getParamAlignment(unsigned i) const {
 262     return AttributeSets.getParamAlignment(i);
 263   }
 264
 265   /// @brief Extract the number of dereferenceable bytes for a call or
 266   /// parameter (0=unknown).
 267   uint64_t getDereferenceableBytes(unsigned i) const {
 268     return AttributeSets.getDereferenceableBytes(i);
 269   }
 270
 271   /// @brief Extract the number of dereferenceable_or_null bytes for a call or
 272   /// parameter (0=unknown).
 273   uint64_t getDereferenceableOrNullBytes(unsigned i) const {
 274     return AttributeSets.getDereferenceableOrNullBytes(i);
 275   }
 276
 277   /// @brief Determine if the function does not access memory.
 278   bool doesNotAccessMemory() const {
 279     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 280                                       Attribute::ReadNone);
 281   }
 282   void setDoesNotAccessMemory() {
 283     addFnAttr(Attribute::ReadNone);
 284   }
 285
 286   /// @brief Determine if the function does not access or only reads memory.
 287   bool onlyReadsMemory() const {
 288     return doesNotAccessMemory() ||
 289       AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 290                                  Attribute::ReadOnly);
 291   }
 292   void setOnlyReadsMemory() {
 293     addFnAttr(Attribute::ReadOnly);
 294   }
 295
 296   /// @brief Determine if the call can access memmory only using pointers based
 297   /// on its arguments.
 298   bool onlyAccessesArgMemory() const {
 299     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 300                                       Attribute::ArgMemOnly);
 301   }
 302   void setOnlyAccessesArgMemory() {
 303     addFnAttr(Attribute::ArgMemOnly);
 304   }
 305
 306   /// @brief Determine if the function cannot return.
 307   bool doesNotReturn() const {
 308     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 309                                       Attribute::NoReturn);
 310   }
 311   void setDoesNotReturn() {
 312     addFnAttr(Attribute::NoReturn);
 313   }
 314
 315   /// @brief Determine if the function cannot unwind.
 316   bool doesNotThrow() const {
 317     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 318                                       Attribute::NoUnwind);
 319   }
 320   void setDoesNotThrow() {
 321     addFnAttr(Attribute::NoUnwind);
 322   }
 323
 324   /// @brief Determine if the call cannot be duplicated.
 325   bool cannotDuplicate() const {
 326     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 327                                       Attribute::NoDuplicate);
 328   }
 329   void setCannotDuplicate() {
 330     addFnAttr(Attribute::NoDuplicate);
 331   }
 332
 333   /// @brief Determine if the call is convergent.
 334   bool isConvergent() const {
 335     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 336                                       Attribute::Convergent);
 337   }
 338   void setConvergent() {
 339     addFnAttr(Attribute::Convergent);
 340   }
 341
 342
 343   /// @brief True if the ABI mandates (or the user requested) that this
 344   /// function be in a unwind table.
 345   bool hasUWTable() const {
 346     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 347                                       Attribute::UWTable);
 348   }
 349   void setHasUWTable() {
 350     addFnAttr(Attribute::UWTable);
 351   }
 352
 353   /// @brief True if this function needs an unwind table.
 354   bool needsUnwindTableEntry() const {
 355     return hasUWTable() || !doesNotThrow();
 356   }
 357
 358   /// @brief Determine if the function returns a structure through first
 359   /// pointer argument.
 360   bool hasStructRetAttr() const {
 361     return AttributeSets.hasAttribute(1, Attribute::StructRet) ||
 362            AttributeSets.hasAttribute(2, Attribute::StructRet);
 363   }
 364
 365   /// @brief Determine if the parameter does not alias other parameters.
 366   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 367   bool doesNotAlias(unsigned n) const {
 368     return AttributeSets.hasAttribute(n, Attribute::NoAlias);
 369   }
 370   void setDoesNotAlias(unsigned n) {
 371     addAttribute(n, Attribute::NoAlias);
 372   }
 373
 374   /// @brief Determine if the parameter can be captured.
 375   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 376   bool doesNotCapture(unsigned n) const {
 377     return AttributeSets.hasAttribute(n, Attribute::NoCapture);
 378   }
 379   void setDoesNotCapture(unsigned n) {
 380     addAttribute(n, Attribute::NoCapture);
 381   }
 382
 383   bool doesNotAccessMemory(unsigned n) const {
 384     return AttributeSets.hasAttribute(n, Attribute::ReadNone);
 385   }
 386   void setDoesNotAccessMemory(unsigned n) {
 387     addAttribute(n, Attribute::ReadNone);
 388   }
 389
 390   bool onlyReadsMemory(unsigned n) const {
 391     return doesNotAccessMemory(n) ||
 392       AttributeSets.hasAttribute(n, Attribute::ReadOnly);
 393   }
 394   void setOnlyReadsMemory(unsigned n) {
 395     addAttribute(n, Attribute::ReadOnly);
 396   }
 397
 398   /// Optimize this function for minimum size (-Oz).
 399   bool optForMinSize() const {
 400     return hasFnAttribute(Attribute::MinSize);
 401   };
 402
 403   /// Optimize this function for size (-Os) or minimum size (-Oz).
 404   bool optForSize() const {
 405     return hasFnAttribute(Attribute::OptimizeForSize) || optForMinSize();
 406   }
 407
 408   /// copyAttributesFrom - copy all additional attributes (those not needed to
 409   /// create a Function) from the Function Src to this one.
 410   void copyAttributesFrom(const GlobalValue *Src) override;
 411
 412   /// deleteBody - This method deletes the body of the function, and converts
 413   /// the linkage to external.
 414   ///
 415   void deleteBody() {
 416     dropAllReferences();
 417     setLinkage(ExternalLinkage);
 418   }
 419
 420   /// removeFromParent - This method unlinks 'this' from the containing module,
 421   /// but does not delete it.
 422   ///
 423   void removeFromParent() override;
 424
 425   /// eraseFromParent - This method unlinks 'this' from the containing module
 426   /// and deletes it.
 427   ///
 428   void eraseFromParent() override;
 429
 430
 431   /// Get the underlying elements of the Function... the basic block list is
 432   /// empty for external functions.
 433   ///
 434   const ArgumentListType &getArgumentList() const {
 435     CheckLazyArguments();
 436     return ArgumentList;
 437   }
 438   ArgumentListType &getArgumentList() {
 439     CheckLazyArguments();
 440     return ArgumentList;
 441   }
 442   static iplist<Argument> Function::*getSublistAccess(Argument*) {
 443     return &Function::ArgumentList;
 444   }
 445
 446   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 447         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 448   static iplist<BasicBlock> Function::*getSublistAccess(BasicBlock*) {
 449     return &Function::BasicBlocks;
 450   }
 451
 452   const BasicBlock       &getEntryBlock() const   { return front(); }
 453         BasicBlock       &getEntryBlock()         { return front(); }
 454
 455   //===--------------------------------------------------------------------===//
 456   // Symbol Table Accessing functions...
 457
 458   /// getSymbolTable() - Return the symbol table...
 459   ///
 460   inline       ValueSymbolTable &getValueSymbolTable()       { return *SymTab; }
 461   inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
 462
 463
 464   //===--------------------------------------------------------------------===//
 465   // BasicBlock iterator forwarding functions
 466   //
 467   iterator                begin()       { return BasicBlocks.begin(); }
 468   const_iterator          begin() const { return BasicBlocks.begin(); }
 469   iterator                end  ()       { return BasicBlocks.end();   }
 470   const_iterator          end  () const { return BasicBlocks.end();   }
 471
 472   size_t                   size() const { return BasicBlocks.size();  }
 473   bool                    empty() const { return BasicBlocks.empty(); }
 474   const BasicBlock       &front() const { return BasicBlocks.front(); }
 475         BasicBlock       &front()       { return BasicBlocks.front(); }
 476   const BasicBlock        &back() const { return BasicBlocks.back();  }
 477         BasicBlock        &back()       { return BasicBlocks.back();  }
 478
 479 /// @name Function Argument Iteration
 480 /// @{
 481
 482   arg_iterator arg_begin() {
 483     CheckLazyArguments();
 484     return ArgumentList.begin();
 485   }
 486   const_arg_iterator arg_begin() const {
 487     CheckLazyArguments();
 488     return ArgumentList.begin();
 489   }
 490   arg_iterator arg_end() {
 491     CheckLazyArguments();
 492     return ArgumentList.end();
 493   }
 494   const_arg_iterator arg_end() const {
 495     CheckLazyArguments();
 496     return ArgumentList.end();
 497   }
 498
 499   iterator_range<arg_iterator> args() {
 500     return iterator_range<arg_iterator>(arg_begin(), arg_end());
 501   }
 502
 503   iterator_range<const_arg_iterator> args() const {
 504     return iterator_range<const_arg_iterator>(arg_begin(), arg_end());
 505   }
 506
 507 /// @}
 508
 509   size_t arg_size() const;
 510   bool arg_empty() const;
 511
 512   bool hasPrefixData() const {
 513     return getSubclassDataFromValue() & (1<<1);
 514   }
 515
 516   Constant *getPrefixData() const;
 517   void setPrefixData(Constant *PrefixData);
 518
 519   bool hasPrologueData() const {
 520     return getSubclassDataFromValue() & (1<<2);
 521   }
 522
 523   Constant *getPrologueData() const;
 524   void setPrologueData(Constant *PrologueData);
 525
 526   /// Print the function to an output stream with an optional
 527   /// AssemblyAnnotationWriter.
 528   void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW = nullptr) const;
 529
 530   /// viewCFG - This function is meant for use from the debugger.  You can just
 531   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 532   /// program, displaying the CFG of the current function with the code for each
 533   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 534   /// in your path.
 535   ///
 536   void viewCFG() const;
 537
 538   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 539   /// just like viewCFG, but it does not include the contents of basic blocks
 540   /// into the nodes, just the label.  If you are only interested in the CFG
 541   /// this can make the graph smaller.
 542   ///
 543   void viewCFGOnly() const;
 544
 545   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 546   static inline bool classof(const Value *V) {
 547     return V->getValueID() == Value::FunctionVal;
 548   }
 549
 550   /// dropAllReferences() - This method causes all the subinstructions to "let
 551   /// go" of all references that they are maintaining.  This allows one to
 552   /// 'delete' a whole module at a time, even though there may be circular
 553   /// references... first all references are dropped, and all use counts go to
 554   /// zero.  Then everything is deleted for real.  Note that no operations are
 555   /// valid on an object that has "dropped all references", except operator
 556   /// delete.
 557   ///
 558   /// Since no other object in the module can have references into the body of a
 559   /// function, dropping all references deletes the entire body of the function,
 560   /// including any contained basic blocks.
 561   ///
 562   void dropAllReferences();
 563
 564   /// hasAddressTaken - returns true if there are any uses of this function
 565   /// other than direct calls or invokes to it, or blockaddress expressions.
 566   /// Optionally passes back an offending user for diagnostic purposes.
 567   ///
 568   bool hasAddressTaken(const User** = nullptr) const;
 569
 570   /// isDefTriviallyDead - Return true if it is trivially safe to remove
 571   /// this function definition from the module (because it isn't externally
 572   /// visible, does not have its address taken, and has no callers).  To make
 573   /// this more accurate, call removeDeadConstantUsers first.
 574   bool isDefTriviallyDead() const;
 575
 576   /// callsFunctionThatReturnsTwice - Return true if the function has a call to
 577   /// setjmp or other function that gcc recognizes as "returning twice".
 578   bool callsFunctionThatReturnsTwice() const;
 579
 580   /// \brief Check if this has any metadata.
 581   bool hasMetadata() const { return hasMetadataHashEntry(); }
 582
 583   /// \brief Get the current metadata attachment, if any.
 584   ///
 585   /// Returns \c nullptr if such an attachment is missing.
 586   /// @{
 587   MDNode *getMetadata(unsigned KindID) const;
 588   MDNode *getMetadata(StringRef Kind) const;
 589   /// @}
 590
 591   /// \brief Set a particular kind of metadata attachment.
 592   ///
 593   /// Sets the given attachment to \c MD, erasing it if \c MD is \c nullptr or
 594   /// replacing it if it already exists.
 595   /// @{
 596   void setMetadata(unsigned KindID, MDNode *MD);
 597   void setMetadata(StringRef Kind, MDNode *MD);
 598   /// @}
 599
 600   /// \brief Get all current metadata attachments.
 601   void
 602   getAllMetadata(SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs) const;
 603
 604   /// \brief Drop metadata not in the given list.
 605   ///
 606   /// Drop all metadata from \c this not included in \c KnownIDs.
 607   void dropUnknownMetadata(ArrayRef<unsigned> KnownIDs);
 608
 609 private:
 610   // Shadow Value::setValueSubclassData with a private forwarding method so that
 611   // subclasses cannot accidentally use it.
 612   void setValueSubclassData(unsigned short D) {
 613     Value::setValueSubclassData(D);
 614   }
 615
 616   bool hasMetadataHashEntry() const {
 617     return getGlobalObjectSubClassData() & HasMetadataHashEntryBit;
 618   }
 619   void setHasMetadataHashEntry(bool HasEntry) {
 620     setGlobalObjectBit(HasMetadataHashEntryBit, HasEntry);
 621   }
 622
 623   void clearMetadata();
 624 };
 625
 626 inline ValueSymbolTable *
 627 ilist_traits<BasicBlock>::getSymTab(Function *F) {
 628   return F ? &F->getValueSymbolTable() : nullptr;
 629 }
 630
 631 inline ValueSymbolTable *
 632 ilist_traits<Argument>::getSymTab(Function *F) {
 633   return F ? &F->getValueSymbolTable() : nullptr;
 634 }
 635
 636 template <>
 637 struct OperandTraits<Function> : public OptionalOperandTraits<Function> {};
 638
 639 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(Function, Value)
 640
 641 } // End llvm namespace
 642
 643 #endif