[clang] - Add missing builtin name to AtomicExpr JSON dump

[serge-sans-paille]

Summary

As a side effect, introduce AtomicExpr::getOpAsString() to dump the
AtomicOp string representation.

[aaron.ballman]

The changes LGTM as far as they go, but should we also update the TextNodeDumper at the same time?

[serge-sans-paille]

I don't have a strong opinion on the synchronization with TextNodeDumper. I'm pretty sure I didn't update it while adding fields for the Attribute nodes though...

[aaron.ballman]

In D158558#4613139, @serge-sans-paille wrote:

I don't have a strong opinion on the synchronization with TextNodeDumper. I'm pretty sure I didn't update it while adding fields for the Attribute nodes though...

We usually try to keep them marginally in sync with one another (they're both intended debugging aids, so if you need the info in one form, it's plausible you'd need it in the other as well), but there's no hard requirement given that they're debugging aids.

[dyung]

Hi @serge-sans-paille, the test you added seems to be failing on some bots. Can you take a look and revert if you need time to investigate?

• https://lab.llvm.org/buildbot/#/builders/139/builds/48265
• https://lab.llvm.org/buildbot/#/builders/216/builds/26208

[vvereschaka]

Hi @serge-sans-paille,

also on this builder: https://lab.llvm.org/buildbot/#/builders/60/builds/13587

[efocht]

Can somebody please revert this patch? It kills all builds on https://lab.llvm.org/buildbot/#/builders/91 since yesterday. @serge-sans-paille ?

[serge-sans-paille]

In D158558#4616275, @efocht wrote:

Can somebody please revert this patch? It kills all builds on https://lab.llvm.org/buildbot/#/builders/91 since yesterday. @serge-sans-paille ?

This got reverted by https://reviews.llvm.org/rGbfbea459af391266cf6a4611f0da4952930d7834 and I just pushed a fix

clang/include/clang/AST/Expr.h

public:
   }
   Expr *getWeak() const {
     assert(NumSubExprs > WEAK);
     return cast<Expr>(SubExprs[WEAK]);
   }
   QualType getValueType() const;
 
   AtomicOp getOp() const { return Op; }
+  StringRef getOpAsString() const {
+    switch (Op) {
+#define BUILTIN(ID, TYPE, ATTRS)
+#define ATOMIC_BUILTIN(ID, TYPE, ATTRS)                                        \
+  case AO##ID:                                                                 \
+    return #ID;
+#include "clang/Basic/Builtins.def"
+    }
+  }
   unsigned getNumSubExprs() const { return NumSubExprs; }
 
   Expr **getSubExprs() { return reinterpret_cast<Expr **>(SubExprs); }
   const Expr * const *getSubExprs() const {
     return reinterpret_cast<Expr * const *>(SubExprs);
   }
 
   bool isVolatile() const {

clang/include/clang/AST/JSONNodeDumper.h

public:
 
   void VisitDeclRefExpr(const DeclRefExpr *DRE);
   void VisitSYCLUniqueStableNameExpr(const SYCLUniqueStableNameExpr *E);
   void VisitPredefinedExpr(const PredefinedExpr *PE);
   void VisitUnaryOperator(const UnaryOperator *UO);
   void VisitBinaryOperator(const BinaryOperator *BO);
   void VisitCompoundAssignOperator(const CompoundAssignOperator *CAO);
   void VisitMemberExpr(const MemberExpr *ME);
+  void VisitAtomicExpr(const AtomicExpr *AE);
   void VisitCXXNewExpr(const CXXNewExpr *NE);
   void VisitCXXDeleteExpr(const CXXDeleteExpr *DE);
   void VisitCXXThisExpr(const CXXThisExpr *TE);
   void VisitCastExpr(const CastExpr *CE);
   void VisitImplicitCastExpr(const ImplicitCastExpr *ICE);
   void VisitCallExpr(const CallExpr *CE);
   void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *TTE);
   void VisitSizeOfPackExpr(const SizeOfPackExpr *SOPE);

clang/lib/AST/JSONNodeDumper.cpp

void JSONNodeDumper::VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D) {
   JOS.attribute("ivarDecl", createBareDeclRef(D->getPropertyIvarDecl()));
 }
 
 void JSONNodeDumper::VisitBlockDecl(const BlockDecl *D) {
   attributeOnlyIfTrue("variadic", D->isVariadic());
   attributeOnlyIfTrue("capturesThis", D->capturesCXXThis());
 }
 
+void JSONNodeDumper::VisitAtomicExpr(const AtomicExpr *AE) {
+  JOS.attribute("name", AE->getOpAsString());
+}
+
 void JSONNodeDumper::VisitObjCEncodeExpr(const ObjCEncodeExpr *OEE) {
   JOS.attribute("encodedType", createQualType(OEE->getEncodedType()));
 }
 
 void JSONNodeDumper::VisitObjCMessageExpr(const ObjCMessageExpr *OME) {
   std::string Str;
   llvm::raw_string_ostream OS(Str);
 

clang/test/AST/ast-dump-atomic-json.c

+// RUN: %clang_cc1 -triple x86_64-unknown-unknown -Wno-unused-value -ast-dump=json %s | FileCheck %s
+
+int foo(int * ptr) {
+  return __atomic_load_n(ptr, __ATOMIC_SEQ_CST);
+}
+
+// NOTE: CHECK lines have been autogenerated by gen_ast_dump_json_test.py
+// using --filters=AtomicExpr
+
+
+// CHECK-NOT: {{^}}Dumping
+// CHECK:  "kind": "AtomicExpr",
+// CHECK-NEXT:  "range": {
+// CHECK-NEXT:   "begin": {
+// CHECK-NEXT:    "offset": 132,
+// CHECK-NEXT:    "col": 10,
+// CHECK-NEXT:    "tokLen": 15
+// CHECK-NEXT:   },
+// CHECK-NEXT:   "end": {
+// CHECK-NEXT:    "offset": 169,
+// CHECK-NEXT:    "col": 47,
+// CHECK-NEXT:    "tokLen": 1
+// CHECK-NEXT:   }
+// CHECK-NEXT:  },
+// CHECK-NEXT:  "type": {
+// CHECK-NEXT:   "qualType": "int"
+// CHECK-NEXT:  },
+// CHECK-NEXT:  "valueCategory": "prvalue",
+// CHECK-NEXT:  "name": "__atomic_load_n",
+// CHECK-NEXT:  "inner": [
+// CHECK-NEXT:   {
+// CHECK-NEXT:    "id": "0x{{.*}}",
+// CHECK-NEXT:    "kind": "ImplicitCastExpr",
+// CHECK-NEXT:    "range": {
+// CHECK-NEXT:     "begin": {
+// CHECK-NEXT:      "offset": 148,
+// CHECK-NEXT:      "col": 26,
+// CHECK-NEXT:      "tokLen": 3
+// CHECK-NEXT:     },
+// CHECK-NEXT:     "end": {
+// CHECK-NEXT:      "offset": 148,
+// CHECK-NEXT:      "col": 26,
+// CHECK-NEXT:      "tokLen": 3
+// CHECK-NEXT:     }
+// CHECK-NEXT:    },
+// CHECK-NEXT:    "type": {
+// CHECK-NEXT:     "qualType": "int *"
+// CHECK-NEXT:    },
+// CHECK-NEXT:    "valueCategory": "prvalue",
+// CHECK-NEXT:    "castKind": "LValueToRValue",
+// CHECK-NEXT:    "inner": [
+// CHECK-NEXT:     {
+// CHECK-NEXT:      "id": "0x{{.*}}",
+// CHECK-NEXT:      "kind": "DeclRefExpr",
+// CHECK-NEXT:      "range": {
+// CHECK-NEXT:       "begin": {
+// CHECK-NEXT:        "offset": 148,
+// CHECK-NEXT:        "col": 26,
+// CHECK-NEXT:        "tokLen": 3
+// CHECK-NEXT:       },
+// CHECK-NEXT:       "end": {
+// CHECK-NEXT:        "offset": 148,
+// CHECK-NEXT:        "col": 26,
+// CHECK-NEXT:        "tokLen": 3
+// CHECK-NEXT:       }
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "type": {
+// CHECK-NEXT:       "qualType": "int *"
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "valueCategory": "lvalue",
+// CHECK-NEXT:      "referencedDecl": {
+// CHECK-NEXT:       "id": "0x{{.*}}",
+// CHECK-NEXT:       "kind": "ParmVarDecl",
+// CHECK-NEXT:       "name": "ptr",
+// CHECK-NEXT:       "type": {
+// CHECK-NEXT:        "qualType": "int *"
+// CHECK-NEXT:       }
+// CHECK-NEXT:      }
+// CHECK-NEXT:     }
+// CHECK-NEXT:    ]
+// CHECK-NEXT:   },
+// CHECK-NEXT:   {
+// CHECK-NEXT:    "id": "0x{{.*}}",
+// CHECK-NEXT:    "kind": "IntegerLiteral",
+// CHECK-NEXT:    "range": {
+// CHECK-NEXT:     "begin": {
+// CHECK-NEXT:      "spellingLoc": {
+// CHECK-NEXT:       "offset": 417,
+// CHECK-NEXT:       "file": "<built-in>",
+// CHECK-NEXT:       "line": 13,
+// CHECK-NEXT:       "presumedLine": 12,
+// CHECK-NEXT:       "col": 26,
+// CHECK-NEXT:       "tokLen": 1
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "expansionLoc": {
+// CHECK-NEXT:       "offset": 153,
+// CHECK-NEXT:       "file": "{{.*}}",
+// CHECK-NEXT:       "line": 4,
+// CHECK-NEXT:       "col": 31,
+// CHECK-NEXT:       "tokLen": 16
+// CHECK-NEXT:      }
+// CHECK-NEXT:     },
+// CHECK-NEXT:     "end": {
+// CHECK-NEXT:      "spellingLoc": {
+// CHECK-NEXT:       "offset": 417,
+// CHECK-NEXT:       "file": "<built-in>",
+// CHECK-NEXT:       "line": 13,
+// CHECK-NEXT:       "presumedLine": 12,
+// CHECK-NEXT:       "col": 26,
+// CHECK-NEXT:       "tokLen": 1
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "expansionLoc": {
+// CHECK-NEXT:       "offset": 153,
+// CHECK-NEXT:       "file": "{{.*}}",
+// CHECK-NEXT:       "line": 4,
+// CHECK-NEXT:       "col": 31,
+// CHECK-NEXT:       "tokLen": 16
+// CHECK-NEXT:      }
+// CHECK-NEXT:     }
+// CHECK-NEXT:    },
+// CHECK-NEXT:    "type": {
+// CHECK-NEXT:     "qualType": "int"
+// CHECK-NEXT:    },
+// CHECK-NEXT:    "valueCategory": "prvalue",
+// CHECK-NEXT:    "value": "5"
+// CHECK-NEXT:   }
+// CHECK-NEXT:  ]
+// CHECK-NEXT: }