Clarify Assignment 3 traversal TODOs

Assignment-3/Assignment-3.cpp

@@ -37,24 +37,29 @@ using namespace SVF;
 using namespace llvm;
 using namespace std;
 
-/// TODO: Implement your context-sensitive ICFG traversal here to traverse each program path
-/// by matching calls and returns while maintaining a `callstack`.
-/// Sources and sinks are identified by implementing and calling `readSrcSnkFromFile`
-/// Each path including loops, qualified by a `callstack`, should only be traversed once using a `visited` set.
-/// You will need to collect each path from src to snk and then add the path to the `paths` set.
-/// Add each path (a sequence of node IDs) as a string into std::set<std::string> paths
-/// in the format "START->1->2->4->5->END", where -> indicate an ICFGEdge connects two ICFGNode IDs
-void ICFGTraversal::reachability(const ICFGNode* src, const ICFGNode* dst) {
-
-}
-
 /// TODO: Implement your code to parse the two lines to identify sources and sinks from `SrcSnk.txt` for your
 /// reachability analysis The format in SrcSnk.txt is in the form of
 /// line 1 for sources  "{ api1 api2 api3 }"
 /// line 2 for sinks    "{ api1 api2 api3 }"
 void ICFGTraversal::readSrcSnkFromFile(const string& filename) {
 
 
+}
+
+/// TODO: Convert each collected ICFG path into a string and insert it into
+/// `std::set<std::string> paths`. The path should use the format
+/// "START->1->2->4->5->END", where each pair of adjacent node IDs is connected
+/// by an ICFG edge, similar to Assignment 2.
+void ICFGTraversal::collectICFGPath(std::vector<unsigned>& path) {
+
+}
+
+/// TODO: Implement context-sensitive ICFG traversal from `src` to `snk` by
+/// matching call and return edges while maintaining a `callstack`. Each path,
+/// including loops and qualified by its callstack, should only be traversed
+/// once using `visited`. Call `collectICFGPath` for every reachable path.
+void ICFGTraversal::reachability(const ICFGNode* src, const ICFGNode* snk) {
+
 }
 
 // TODO: Implement your Andersen's Algorithm here
@@ -113,4 +118,4 @@ void AndersenPTA::analyze() {
 			reanalyze = true;
 	} while (reanalyze);
 	finalize();
-}
+}

Assignment-3/Assignment-3.h

@@ -80,14 +80,17 @@ class ICFGTraversal {
 	ICFGTraversal(SVFIR* p)
 	: pag(p) {}
 
-	/// TODO: to be implemented context sensitive reachability
-	void reachability(const ICFGNode* curNode, const ICFGNode* sink);
+	/// TODO: Configure source and sink function names from SrcSnk.txt
+	void readSrcSnkFromFile(const std::string& filename);
 
-	// Return true if two pointers are aliases
-	bool aliasCheck(const CallICFGNode* src, const CallICFGNode* snk);
+	/// TODO: Convert and store a collected ICFG path
+	void collectICFGPath(std::vector<unsigned>& path);
 
-	// TODO: Source and sink function names read from SrcSnk.txt
-	void readSrcSnkFromFile(const std::string& filename);
+	/// TODO: Perform context-sensitive reachability and collect reachable paths
+	void reachability(const ICFGNode* src, const ICFGNode* snk);
+
+	/// TODO: Return true if the source return value aliases a sink argument
+	bool aliasCheck(const CallICFGNode* src, const CallICFGNode* snk);
 
 	// The driver method for taint checking
 	void taintChecking();