Swift: comment models-as-data implementation.

geoffw0 · geoffw0 · commit 26ef1bc249c0 · 2024-03-06T16:12:46.000Z
diff --git a/swift/ql/lib/codeql/swift/dataflow/internal/DataFlowPrivate.qll b/swift/ql/lib/codeql/swift/dataflow/internal/DataFlowPrivate.qll
@@ -320,6 +320,7 @@ private module Cached {
   cached
   predicate localFlowStepImpl(Node nodeFrom, Node nodeTo) {
     localFlowStepCommon(nodeFrom, nodeTo) or
+    // models-as-data summarized flow
     FlowSummaryImpl::Private::Steps::summaryThroughStepValue(nodeFrom, nodeTo, _)
   }
 
@@ -1023,6 +1024,7 @@ predicate captureValueStep(Node node1, Node node2) {
 }
 
 predicate jumpStep(Node pred, Node succ) {
+  // models-as-data summarized flow
   FlowSummaryImpl::Private::Steps::summaryJumpStep(pred.(FlowSummaryNode).getSummaryNode(),
     succ.(FlowSummaryNode).getSummaryNode())
 }
@@ -1132,6 +1134,7 @@ predicate storeStep(Node node1, ContentSet c, Node node2) {
     c.isSingleton(any(Content::CollectionContent cc))
   )
   or
+  // models-as-data summarized flow
   FlowSummaryImpl::Private::Steps::summaryStoreStep(node1.(FlowSummaryNode).getSummaryNode(), c,
     node2.(FlowSummaryNode).getSummaryNode())
   or
@@ -1237,6 +1240,7 @@ predicate readStep(Node node1, ContentSet c, Node node2) {
     c instanceof OptionalSomeContentSet
   )
   or
+  // models-as-data summarized flow
   FlowSummaryImpl::Private::Steps::summaryReadStep(node1.(FlowSummaryNode).getSummaryNode(), c,
     node2.(FlowSummaryNode).getSummaryNode())
   or

Original file line number	Diff line number	Diff line change
`@@ -320,6 +320,7 @@ private module Cached {`
`320`	`320`	`cached`
`321`	`321`	`predicate localFlowStepImpl(Node nodeFrom, Node nodeTo) {`
`322`	`322`	`localFlowStepCommon(nodeFrom, nodeTo) or`
	`323`	`+ // models-as-data summarized flow`
`323`	`324`	`FlowSummaryImpl::Private::Steps::summaryThroughStepValue(nodeFrom, nodeTo, _)`
`324`	`325`	`}`
`325`	`326`
`@@ -1023,6 +1024,7 @@ predicate captureValueStep(Node node1, Node node2) {`
`1023`	`1024`	`}`
`1024`	`1025`
`1025`	`1026`	`predicate jumpStep(Node pred, Node succ) {`
	`1027`	`+ // models-as-data summarized flow`
`1026`	`1028`	`FlowSummaryImpl::Private::Steps::summaryJumpStep(pred.(FlowSummaryNode).getSummaryNode(),`
`1027`	`1029`	`succ.(FlowSummaryNode).getSummaryNode())`
`1028`	`1030`	`}`
`@@ -1132,6 +1134,7 @@ predicate storeStep(Node node1, ContentSet c, Node node2) {`
`1132`	`1134`	`c.isSingleton(any(Content::CollectionContent cc))`
`1133`	`1135`	`)`
`1134`	`1136`	`or`
	`1137`	`+ // models-as-data summarized flow`
`1135`	`1138`	`FlowSummaryImpl::Private::Steps::summaryStoreStep(node1.(FlowSummaryNode).getSummaryNode(), c,`
`1136`	`1139`	`node2.(FlowSummaryNode).getSummaryNode())`
`1137`	`1140`	`or`
`@@ -1237,6 +1240,7 @@ predicate readStep(Node node1, ContentSet c, Node node2) {`
`1237`	`1240`	`c instanceof OptionalSomeContentSet`
`1238`	`1241`	`)`
`1239`	`1242`	`or`
	`1243`	`+ // models-as-data summarized flow`
`1240`	`1244`	`FlowSummaryImpl::Private::Steps::summaryReadStep(node1.(FlowSummaryNode).getSummaryNode(), c,`
`1241`	`1245`	`node2.(FlowSummaryNode).getSummaryNode())`
`1242`	`1246`	`or`