Commit f99a0200 authored by Stephen Tozer's avatar Stephen Tozer
Browse files

Reapply "[DebugInfo] Make DIArgList inherit from Metadata and always unique" 

This reverts commit 0fd5dc94.

The original commit removed DIArgLists from being in an MDNode map, but did
not insert a new `delete` in the LLVMContextImpl destructor. This
reapply adds that call to delete, preventing a memory leak.
parent e2fb816c

llvm/include/llvm/AsmParser/LLParser.h

+1 −2
Original line number Diff line number Diff line
@@ -548,6 +548,7 @@ namespace llvm { 
    bool parseMetadataAsValue(Value *&V, PerFunctionState &PFS);

    bool parseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg,

                              PerFunctionState *PFS);

    bool parseDIArgList(Metadata *&MD, PerFunctionState *PFS);

    bool parseMetadata(Metadata *&MD, PerFunctionState *PFS);

    bool parseMDTuple(MDNode *&MD, bool IsDistinct = false);

    bool parseMDNode(MDNode *&N);
@@ -569,8 +570,6 @@ namespace llvm { 
#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \

  bool parse##CLASS(MDNode *&Result, bool IsDistinct);

#include "llvm/IR/Metadata.def"

    bool parseDIArgList(MDNode *&Result, bool IsDistinct,

                        PerFunctionState *PFS);



    // Function Parsing.

    struct ArgInfo {

llvm/include/llvm/IR/DebugInfoMetadata.h

+10 −21
Original line number Diff line number Diff line
@@ -3753,51 +3753,40 @@ public: 


/// List of ValueAsMetadata, to be used as an argument to a dbg.value

/// intrinsic.

class DIArgList : public MDNode {

class DIArgList : public Metadata, ReplaceableMetadataImpl {

  friend class ReplaceableMetadataImpl;

  friend class LLVMContextImpl;

  friend class MDNode;

  using iterator = SmallVectorImpl<ValueAsMetadata *>::iterator;



  SmallVector<ValueAsMetadata *, 4> Args;



  DIArgList(LLVMContext &C, StorageType Storage,

            ArrayRef<ValueAsMetadata *> Args)

      : MDNode(C, DIArgListKind, Storage, std::nullopt),

  DIArgList(LLVMContext &Context, ArrayRef<ValueAsMetadata *> Args)

      : Metadata(DIArgListKind, Uniqued), ReplaceableMetadataImpl(Context),

        Args(Args.begin(), Args.end()) {

    track();

  }

  ~DIArgList() { untrack(); }



  static DIArgList *getImpl(LLVMContext &Context,

                            ArrayRef<ValueAsMetadata *> Args,

                            StorageType Storage, bool ShouldCreate = true);



  TempDIArgList cloneImpl() const {

    return getTemporary(getContext(), getArgs());

  }



  void track();

  void untrack();

  void dropAllReferences();

  void dropAllReferences(bool Untrack);



public:

  DEFINE_MDNODE_GET(DIArgList, (ArrayRef<ValueAsMetadata *> Args), (Args))



  TempDIArgList clone() const { return cloneImpl(); }

  static DIArgList *get(LLVMContext &Context, ArrayRef<ValueAsMetadata *> Args);



  ArrayRef<ValueAsMetadata *> getArgs() const { return Args; }



  iterator args_begin() { return Args.begin(); }

  iterator args_end() { return Args.end(); }



  ReplaceableMetadataImpl *getReplaceableUses() {

    return Context.getReplaceableUses();

  }



  static bool classof(const Metadata *MD) {

    return MD->getMetadataID() == DIArgListKind;

  }



  SmallVector<DPValue *> getAllDPValueUsers() {

    return ReplaceableMetadataImpl::getAllDPValueUsers();

  }



  void handleChangedOperand(void *Ref, Metadata *New);

};

llvm/include/llvm/IR/Metadata.def

+1 −1
Original line number Diff line number Diff line
@@ -77,6 +77,7 @@ HANDLE_METADATA_BRANCH(ValueAsMetadata) 
HANDLE_METADATA_LEAF(ConstantAsMetadata)

HANDLE_METADATA_LEAF(LocalAsMetadata)

HANDLE_METADATA_LEAF(DistinctMDOperandPlaceholder)

HANDLE_METADATA_LEAF(DIArgList)

HANDLE_MDNODE_BRANCH(MDNode)

HANDLE_MDNODE_LEAF_UNIQUABLE(MDTuple)

HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DILocation)
@@ -115,7 +116,6 @@ HANDLE_SPECIALIZED_MDNODE_BRANCH(DIMacroNode) 
HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DIMacro)

HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DIMacroFile)

HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DICommonBlock)

HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DIArgList)

HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DIStringType)

HANDLE_SPECIALIZED_MDNODE_LEAF_UNIQUABLE(DIGenericSubrange)

llvm/include/llvm/IR/Metadata.h

+1 −4
Original line number Diff line number Diff line
@@ -1037,7 +1037,6 @@ struct TempMDNodeDeleter { 
class MDNode : public Metadata {

  friend class ReplaceableMetadataImpl;

  friend class LLVMContextImpl;

  friend class DIArgList;



  /// The header that is coallocated with an MDNode along with its "small"

  /// operands. It is located immediately before the main body of the node.
@@ -1220,9 +1219,7 @@ public: 
  bool isDistinct() const { return Storage == Distinct; }

  bool isTemporary() const { return Storage == Temporary; }



  bool isReplaceable() const {

    return isTemporary() || getMetadataID() == DIArgListKind;

  }

  bool isReplaceable() const { return isTemporary(); }



  /// RAUW a temporary.

  ///

llvm/lib/AsmParser/LLParser.cpp

+9 −9
Original line number Diff line number Diff line
@@ -5488,13 +5488,9 @@ bool LLParser::parseDIExpression(MDNode *&Result, bool IsDistinct) { 
  return false;

}



bool LLParser::parseDIArgList(MDNode *&Result, bool IsDistinct) {

  return parseDIArgList(Result, IsDistinct, nullptr);

}

/// ParseDIArgList:

///   ::= !DIArgList(i32 7, i64 %0)

bool LLParser::parseDIArgList(MDNode *&Result, bool IsDistinct,

                              PerFunctionState *PFS) {

bool LLParser::parseDIArgList(Metadata *&MD, PerFunctionState *PFS) {

  assert(PFS && "Expected valid function state");

  assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");

  Lex.Lex();
@@ -5514,7 +5510,7 @@ bool LLParser::parseDIArgList(MDNode *&Result, bool IsDistinct, 
  if (parseToken(lltok::rparen, "expected ')' here"))

    return true;



  Result = GET_OR_DISTINCT(DIArgList, (Context, Args));

  MD = DIArgList::get(Context, Args);

  return false;

}
@@ -5628,13 +5624,17 @@ bool LLParser::parseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg, 
///  ::= !DILocation(...)

bool LLParser::parseMetadata(Metadata *&MD, PerFunctionState *PFS) {

  if (Lex.getKind() == lltok::MetadataVar) {

    MDNode *N;

    // DIArgLists are a special case, as they are a list of ValueAsMetadata and

    // so parsing this requires a Function State.

    if (Lex.getStrVal() == "DIArgList") {

      if (parseDIArgList(N, false, PFS))

      Metadata *AL;

      if (parseDIArgList(AL, PFS))

        return true;

    } else if (parseSpecializedMDNode(N)) {

      MD = AL;

      return false;

    }

    MDNode *N;

    if (parseSpecializedMDNode(N)) {

      return true;

    }

    MD = N;