[analyzer] print() JSONify: Create pointers

[Charusso]

Summary

-

[NoQ]

Yay thx!

For Environment they aren't that useful, but it definitely doesn't hurt.

[Charusso]

In D63726#1556825, @NoQ wrote:

Yay thx!

For Environment they aren't that useful, but it definitely doesn't hurt.

It is pretty interesting when you could track the call among the entire graph, it is could be our first Explorer.

clang/lib/StaticAnalyzer/Core/Environment.cpp

EnvironmentManager::removeDeadBindings(Environment Env,
   NewEnv.ExprBindings = EBMapRef.asImmutableMap();
   return NewEnv;
 }
 
 void Environment::printJson(raw_ostream &Out, const ASTContext &Ctx,
                             const LocationContext *LCtx, const char *NL,
                             unsigned int Space, bool IsDot) const {
   Indent(Out, Space, IsDot) << "\"environment\": ";
-  ++Space;
 
   if (ExprBindings.isEmpty()) {
     Out << "null," << NL;
     return;
   }
 
+  ++Space;
   if (!LCtx) {
     // Find the freshest location context.
     llvm::SmallPtrSet<const LocationContext *, 16> FoundContexts;
     for (const auto &I : *this) {
       const LocationContext *LC = I.first.getLocationContext();
       if (FoundContexts.count(LC) == 0) {
         // This context is fresher than all other contexts so far.
         LCtx = LC;
         for (const LocationContext *LCI = LC; LCI; LCI = LCI->getParent())
           FoundContexts.insert(LCI);
       }
     }
   }
 
   assert(LCtx);
 
-  Out << '[' << NL; // Start of Environment.
+  Out << "{ \"pointer\": \"" << (const void *)LCtx->getStackFrame()
+      << "\", \"items\": [" << NL;
   PrintingPolicy PP = Ctx.getPrintingPolicy();
 
   LCtx->printJson(Out, NL, Space, IsDot, [&](const LocationContext *LC) {
     // LCtx items begin
     bool HasItem = false;
     unsigned int InnerSpace = Space + 1;
 
     // Store the last ExprBinding which we will print.
LCtx->printJson(Out, NL, Space, IsDot, [&](const LocationContext *LC) {
     }
 
     if (HasItem)
       Indent(Out, --InnerSpace, IsDot) << ']';
     else
       Out << "null ";
   });
 
-  Indent(Out, --Space, IsDot) << "]," << NL; // End of Environment.
+  Indent(Out, --Space, IsDot) << "]}," << NL;
 }

clang/lib/StaticAnalyzer/Core/RegionStore.cpp

void RegionStoreManager::printJson(raw_ostream &Out, Store S, const char *NL,
 
   Indent(Out, Space, IsDot) << "\"store\": ";
 
   if (Bindings.isEmpty()) {
     Out << "null," << NL;
     return;
   }
 
-  Out << '[' << NL;
-  Bindings.printJson(Out, NL, ++Space, IsDot);
-  Indent(Out, --Space, IsDot) << "]," << NL;
+  Out << "{ \"pointer\": \"" << Bindings.asStore() << "\", \"items\": [" << NL;
+  Bindings.printJson(Out, NL, Space + 1, IsDot);
+  Indent(Out, Space, IsDot) << "]}," << NL;
 }

clang/test/Analysis/exploded-graph-rewriter/environment.dot

 Node0x1 [shape=record,label=
  "{
     { "node_id": 1,
       "pointer": "0x1",
       "state_id": 2,
       "program_points": [],
       "program_state": {
         "store": null,
-        "environment": [
+        "environment": {
+          "pointer": "0x2",
+          "items": [
             {
               "location_context": "#0 Call",
               "lctx_id": 3,
               "calling": "foo",
               "call_line": 4,
               "items": [
                 {
                   "stmt_id": 5,
                   "pretty": "bar()",
                   "value": "Unknown"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];

clang/test/Analysis/exploded-graph-rewriter/environment_diff.dot

 // RUN: %exploded_graph_rewriter -d %s | FileCheck %s
 
 // FIXME: Substitution doesn't seem to work on Windows.
 // UNSUPPORTED: system-windows
 
 // No diffs on the first node, nothing to check.
 Node0x1 [shape=record,label=
  "{
     { "node_id": 1,
       "pointer": "0x1",
       "state_id": 2,
       "program_points": [],
       "program_state": {
         "store": null,
-        "environment": [
+        "environment": {
+          "pointer": "0x2",
+          "items": [
             {
               "location_context": "#0 Call",
               "lctx_id": 3,
               "calling": "foo",
               "call_line": 4,
               "items": [
                 {
                   "stmt_id": 5,
                   "pretty": "bar()",
                   "value": "Unknown"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];
 
 Node0x1 -> Node0x6;
 
 // CHECK: Node0x6 [
 // CHECK-SAME: <tr>
 // CHECK-SAME:   <td><font color="red">-</font></td>
 // CHECK-SAME:   <td align="left"><i>S5</i></td>

 Node0x6 [shape=record,label=
  "{
     { "node_id": 6,
       "pointer": "0x6",
       "state_id": 7,
       "program_points": [],
       "program_state": {
         "store": null,
-        "environment": [
+        "environment": {
+          "pointer": "0x2",
+          "items": [
             {
               "location_context": "#0 Call",
               "lctx_id": 3,
               "calling": "foo",
               "call_line": 4,
               "items": [
                 {
                   "stmt_id": 9,
                   "pretty": "baz()",
                   "value": "Undefined"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];
 
 Node0x6 -> Node0x9;
 // Make sure that the last node in the path is not diffed.
 // CHECK: Node0x9 [
 // CHECK-SAME: <tr>
 // CHECK-SAME:   <td></td>
 // CHECK-SAME:   <td align="left"><i>S9</i></td>
 // CHECK-SAME:   <td align="left">baz()</td>
 // CHECK-SAME:   <td align="left">Undefined</td>
 // CHECK-SAME: </tr>
 Node0x9 [shape=record,label=
  "{
     { "node_id": 9,
       "pointer": "0x9",
       "state_id": 7,
       "program_points": [],
       "program_state": {
         "store": null,
-        "environment": [
+        "environment": {
+          "pointer": "0x2",
+          "items": [
             {
               "location_context": "#0 Call",
               "lctx_id": 3,
               "calling": "foo",
               "call_line": 4,
               "items": [
                 {
                   "stmt_id": 9,
                   "pretty": "baz()",
                   "value": "Undefined"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];

clang/test/Analysis/exploded-graph-rewriter/store.dot

 Node0x1 [shape=record,label=
  "{
     { "node_id": 1,
       "pointer": "0x1",
       "state_id": 2,
       "program_points": [],
       "program_state": {
         "environment": null,
-        "store": [
+        "store": {
+          "pointer": "0x2",
+          "items": [
             {
               "cluster": "x",
               "pointer": "0x3",
               "items": [
                 {
                   "kind": "Default",
                   "offset": 0,
                   "value": "Undefined"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];

clang/test/Analysis/exploded-graph-rewriter/store_diff.dot

 // RUN: %exploded_graph_rewriter -d %s | FileCheck %s
 
 // FIXME: Substitution doesn't seem to work on Windows.
 // UNSUPPORTED: system-windows
 
 Node0x1 [shape=record,label=
  "{
     { "node_id": 1,
       "pointer": "0x1",
       "state_id": 2,
       "program_points": [],
       "program_state": {
         "environment": null,
-        "store": [
+        "store": {
+          "pointer": "0x2",
+          "items": [
             {
               "cluster": "x",
               "pointer": "0x3",
               "items": [
                 {
                   "kind": "Default",
                   "offset": 0,
                   "value": "Undefined"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];
 
 Node0x1 -> Node0x4;
 
 // CHECK: Node0x4 [
 // CHECK-SAME: <tr>
 // CHECK-SAME:   <td><font color="red">-</font></td>
 // CHECK-SAME:   <td align="left">x</td><td align="left">0</td>

 Node0x4 [shape=record,label=
  "{
     { "node_id": 4,
       "pointer": "0x4",
       "state_id": 5,
       "program_points": [],
       "program_state": {
         "environment": null,
-        "store": [
+        "store": {
+          "pointer": "0x5",
+          "items": [
             {
               "cluster": "x",
               "pointer": "0x3",
               "items": [
                 {
                   "kind": "Default",
                   "offset": 0,
                   "value": "Unknown"
                 }
               ]
             }
           ]
         }
       }
+    }
 \l}"];
 
 Node0x4 -> Node0x6;
 
 Node0x6 [shape=record,label=
  "{
     { "node_id": 6,
       "pointer": "0x6",
       "state_id": 7,
       "program_points": [],
       "program_state": null
     }
 \l}"];

clang/test/Analysis/expr-inspection.c

if (y == 2) {
       int z = x > 13;
       if (!z)
         clang_analyzer_printState();
     }
   }
 }
 
 // CHECK:      "program_state": {
-// CHECK-NEXT:   "store": [
+// CHECK-NEXT:   "store": { "pointer": "{{0x[0-9a-f]+}}", "items": [
 // CHECK-NEXT:     { "cluster": "y", "pointer": "{{0x[0-9a-f]+}}", "items": [
 // CHECK-NEXT:       { "kind": "Direct", "offset": 0, "value": "2 S32b" }
 // CHECK-NEXT:     ]}
-// CHECK-NEXT:   ],
-// CHECK-NEXT:   "environment": [
+// CHECK-NEXT:   ]},
+// CHECK-NEXT:   "environment": { "pointer": "{{0x[0-9a-f]+}}", "items": [
 // CHECK-NEXT:     { "lctx_id": 1, "location_context": "#0 Call", "calling": "foo", "call_line": null, "items": [
 // CHECK-NEXT:       { "stmt_id": {{[0-9]+}}, "pretty": "clang_analyzer_printState", "value": "&code{clang_analyzer_printState}" }
 // CHECK-NEXT:     ]}
-// CHECK-NEXT:   ],
+// CHECK-NEXT:   ]},
 // CHECK-NEXT:   "constraints": [
 // CHECK-NEXT:     { "symbol": "reg_$0<int x>", "range": "{ [-2147483648, 13] }" }
 // CHECK-NEXT:   ],
 // CHECK-NEXT:   "dynamic_types": null,
 // CHECK-NEXT:   "constructing_objects": null,
 // CHECK-NEXT:   "checker_messages": null
 // CHECK-NEXT: }
 

clang/utils/analyzer/exploded-graph-rewriter.py

def is_different(self, prev):
         removed, added = self.diff_bindings(prev)
         return len(removed) != 0 or len(added) != 0
 
 
 # A deserialized Environment.
 class Environment(object):
     def __init__(self, json_e):
         super(Environment, self).__init__()
-        self.frames = [EnvironmentFrame(f) for f in json_e]
+        self.ptr = json_e['pointer']
+        self.frames = [EnvironmentFrame(f) for f in json_e['items']]
 
     def diff_frames(self, prev):
         # TODO: It's difficult to display a good diff when frame numbers shift.
         if len(self.frames) != len(prev.frames):
             return None
 
         updated = []
         for i in range(len(self.frames)):
def is_different(self, prev):
         removed, added = self.diff_bindings(prev)
         return len(removed) != 0 or len(added) != 0
 
 
 # A deserialized RegionStore.
 class Store(object):
     def __init__(self, json_s):
         super(Store, self).__init__()
+        self.ptr = json_s['pointer']
         self.clusters = collections.OrderedDict(
-            [(c['pointer'], StoreCluster(c)) for c in json_s])
+            [(c['pointer'], StoreCluster(c)) for c in json_s['items']])
 
     def diff_clusters(self, prev):
         removed = [k for k in prev.clusters if k not in self.clusters]
         added = [k for k in self.clusters if k not in prev.clusters]
         updated = [k for k in prev.clusters if k in self.clusters
                    and prev.clusters[k].is_different(self.clusters[k])]
         return (removed, added, updated)