Removed unused methods, rewritten error prints, added new checks in SmartContract

Author: merendamattia

src/main/java/it/unipr/EVMLiSA.java

@@ -145,10 +145,8 @@ public static void setTestMode() {
 	 * Executes the analysis workflow.
 	 *
 	 * @param args command-line arguments
-	 * 
-	 * @throws Exception if an error occurs during execution
 	 */
-	private void go(String[] args) throws Exception {
+	private void go(String[] args) {
 		CommandLine cmd = parseCommandLine(args);
 		if (cmd == null)
 			return;
@@ -194,7 +192,6 @@ else if (cmd.hasOption("bytecode"))
 					.setBytecode(cmd.getOptionValue("bytecode"));
 
 		else {
-			log.error("No valid option provided.");
 			JSONManager.throwNewError("No valid option provided.");
 			System.exit(1);
 		}
@@ -207,13 +204,21 @@ else if (cmd.hasOption("bytecode"))
 	 * Analyzes a set of smart contracts from a given file.
 	 *
 	 * @param filePath the path to the file containing contract addresses
-	 * 
-	 * @throws Exception if an error occurs during analysis
 	 */
-	public static void analyzeSetOfContracts(Path filePath) throws Exception {
-		log.info("Analyzing set of contracts...");
-
+	public static void analyzeSetOfContracts(Path filePath) {
+		log.info("Building contracts...");
 		List<SmartContract> contracts = buildContractsFromFile(filePath);
+		analyzeSetOfContracts(contracts);
+	}
+
+	/**
+	 * Analyzes a set of smart contracts from a list of {@link SmartContract}.
+	 *
+	 * @param contracts the list of {@link SmartContract} to be analyzed
+	 */
+	public static void analyzeSetOfContracts(List<SmartContract> contracts) {
+		log.info("Analyzing {} contracts...", contracts.size());
+
 		ExecutorService executor = Executors.newFixedThreadPool(CORES);
 		List<Future<?>> futures = new ArrayList<>();
 
@@ -225,7 +230,7 @@ public static void analyzeSetOfContracts(Path filePath) throws Exception {
 		waitForCompletion(futures);
 
 		executor.shutdown();
-		log.info("Finished analyzing {} contracts.", contracts.size());
+		log.info("Finished analysis of {} contracts.", contracts.size());
 
 		Path outputDir = OUTPUT_DIRECTORY_PATH.resolve("set-of-contracts");
 		try {
@@ -236,7 +241,8 @@ public static void analyzeSetOfContracts(Path filePath) throws Exception {
 					StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
 			log.info("Results saved in {}", outputDir.resolve("results.json"));
 		} catch (IOException e) {
-			log.error("Failed to save results in {}", outputDir, e);
+			System.err.println(JSONManager.throwNewError("Failed to save results in " + outputDir));
+			System.exit(1);
 		}
 	}
 
@@ -246,19 +252,15 @@ public static void analyzeSetOfContracts(Path filePath) throws Exception {
 	 * @param contract the smart contract to analyze
 	 */
 	public static void analyzeContract(SmartContract contract) {
-		if (TEST_MODE) {
-			analyzeContractInTestMode(contract);
-			return;
-		}
-
 		log.info("Analyzing contract {}...", contract.getAddress());
 
-		Program program;
+		Program program = null;
 		try {
 			program = EVMFrontend.generateCfgFromFile(contract.getMnemonicBytecodePath().toString());
 		} catch (IOException e) {
-			log.error("Unable to generate CFG from file");
-			return;
+			System.err.println(
+					JSONManager.throwNewError("Unable to generate partial CFG from file", contract.toJson()));
+			System.exit(1);
 		}
 
 		LiSAConfiguration conf = LiSAConfigurationManager.createConfiguration(contract);
@@ -272,8 +274,11 @@ public static void analyzeContract(SmartContract contract) {
 
 		contract.setStatistics(
 				computeStatistics(checker, lisa, program));
-
 		contract.setCFG(checker.getComputedCFG());
+
+		if (TEST_MODE)
+			return;
+
 		contract.computeFunctionsSignatureEntryPoints();
 		contract.computeFunctionsSignatureExitPoints();
 		contract.computeEventsSignatureEntryPoints();
@@ -321,67 +326,6 @@ public static void analyzeContract(SmartContract contract) {
 		contract.toFile();
 	}
 
-	/**
-	 * Analyzes a given smart contract in test mode (i.e., without computing
-	 * functions, events).
-	 *
-	 * @param contract the smart contract to analyze
-	 */
-	public static void analyzeContractInTestMode(SmartContract contract) {
-		log.info("Analyzing contract {}...", contract.getAddress());
-
-		Program program;
-		try {
-			program = EVMFrontend.generateCfgFromFile(contract.getMnemonicBytecodePath().toString());
-		} catch (IOException e) {
-			log.error("Unable to generate CFG from file");
-			return;
-		}
-
-		LiSAConfiguration conf = LiSAConfigurationManager.createConfiguration(contract);
-		JumpSolver checker = new JumpSolver();
-		conf.semanticChecks.add(checker);
-
-		LiSA lisa = new LiSA(conf);
-		lisa.run(program);
-
-		log.info("Analysis ended ({})", contract.getAddress());
-
-		contract.setStatistics(
-				computeStatistics(checker, lisa, program));
-	}
-
-	/**
-	 * Analyzes a given smart contract in test mode (i.e., without producing
-	 * output files).
-	 *
-	 * @param contract the smart contract to analyze
-	 */
-	public static void analyzeContractInWebAppMode(SmartContract contract) {
-		Program program;
-		try {
-			program = EVMFrontend.generateCfgFromFile(contract.getMnemonicBytecodePath().toString());
-		} catch (IOException e) {
-			log.error("Unable to generate CFG from file");
-			return;
-		}
-
-		LiSAConfiguration conf = LiSAConfigurationManager.createConfigurationForWebApp(contract);
-		JumpSolver checker = new JumpSolver();
-		conf.semanticChecks.add(checker);
-
-		LiSA lisa = new LiSA(conf);
-		lisa.run(program);
-
-		contract.setStatistics(
-				computeStatistics(checker, lisa, program));
-		contract.setCFG(checker.getComputedCFG());
-		contract.computeFunctionsSignatureEntryPoints();
-		contract.computeFunctionsSignatureExitPoints();
-		contract.computeEventsSignatureEntryPoints();
-		contract.computeEventsExitPoints();
-	}
-
 	/**
 	 * Computes statistics based on the analysis of jumps within the given
 	 * program.
@@ -551,10 +495,8 @@ private static Set<Statement> getSoundlySolvedJumps(JumpSolver checker, LiSA lis
 	 * @param filePath the path to the file containing contract addresses
 	 * 
 	 * @return a list of {@link SmartContract} objects
-	 * 
-	 * @throws Exception if an error occurs while reading the file
 	 */
-	public static List<SmartContract> buildContractsFromFile(Path filePath) throws Exception {
+	public static List<SmartContract> buildContractsFromFile(Path filePath) {
 		log.info("Parsing contracts from {}", filePath);
 
 		List<SmartContract> contracts = new ArrayList<>();
@@ -572,8 +514,8 @@ public static List<SmartContract> buildContractsFromFile(Path filePath) throws E
 			myReader.close();
 
 		} catch (FileNotFoundException e) {
-			log.error("{} not found.", filePath);
-			throw e;
+			JSONManager.throwNewError("Unable to read " + filePath + ". File not found.");
+			System.exit(1);
 		}
 
 		log.info("Created {} contracts.", contracts.size());
@@ -608,7 +550,7 @@ private void setupGlobalOptions(CommandLine cmd) {
 			if (cmd.hasOption("stack-set-size"))
 				AbstractStackSet.setStackSetSize(Integer.parseInt(cmd.getOptionValue("stack-set-size")));
 		} catch (NumberFormatException e) {
-			log.error("Size must be an integer.");
+			System.err.println(JSONManager.throwNewError("Size must be an integer."));
 			System.exit(1);
 		}
 
@@ -782,9 +724,11 @@ static private void waitForCompletion(List<Future<?>> futures) {
 			try {
 				future.get();
 			} catch (ExecutionException e) {
-				log.error("Error during task execution: {}", e.getMessage());
+				System.err.println(JSONManager.throwNewError("Error during task execution: " + e.getMessage()));
+				System.exit(1);
 			} catch (InterruptedException ie) {
-				log.error("Interrupted during task execution: {}", ie.getMessage());
+				System.err.println(JSONManager.throwNewError("Interrupted during task execution: " + ie.getMessage()));
+				System.exit(1);
 			}
 	}
 }

src/main/java/it/unipr/analysis/contract/SmartContract.java

@@ -120,6 +120,7 @@ public SmartContract(String address) {
 			if (!file.exists()) {
 				Thread.sleep(500); // Etherscan API request limit
 				Files.createDirectories(outputDir);
+
 				this._bytecode = EVMFrontend.parseBytecodeFromEtherscan(address);
 				// Write bytecode to file
 				if (this._bytecode != null)
@@ -144,12 +145,13 @@ public SmartContract(String address) {
 			File file = new File(String.valueOf(_abiFilePath));
 			if (!file.exists()) {
 				Thread.sleep(500); // Etherscan API request limit
+
 				Files.createDirectories(outputDir);
 				this._abi = EVMFrontend.parseABIFromEtherscan(address);
+
 				// Write ABI to file
-				if (this._abi != null)
-					Files.writeString(this._abiFilePath, this._abi.toString(4), StandardOpenOption.CREATE,
-							StandardOpenOption.TRUNCATE_EXISTING);
+				Files.writeString(this._abiFilePath, this._abi.toString(4), StandardOpenOption.CREATE,
+						StandardOpenOption.TRUNCATE_EXISTING);
 			} else {
 				log.warn("Contract (ABI) already present in {}, not downloaded.", _abiFilePath);
 				this._abi = new JSONArray(new String(Files.readAllBytes(Paths.get(_abiFilePath.toString()))));
@@ -423,11 +425,16 @@ public SmartContract setAbi(JSONArray abi) {
 	/**
 	 * Sets the control flow graph and extracts basic blocks.
 	 *
-	 * @param cfg The EVMCFG to set.
+	 * @param cfg The {@link EVMCFG} to set.
 	 * 
 	 * @return This SmartContract instance for method chaining.
 	 */
 	public SmartContract setCFG(EVMCFG cfg) {
+		if (cfg == null) {
+			System.err.println(JSONManager.throwNewError("CFG cannot be null"));
+			System.exit(1);
+		}
+
 		this._cfg = cfg;
 		this._basicBlocks = BasicBlock.getBasicBlocks(cfg);
 		return this;

src/main/java/it/unipr/utils/JSONManager.java

@@ -207,4 +207,18 @@ public static JSONObject throwNewError(String error) {
 		errorJson.put("error", error);
 		return errorJson;
 	}
+
+	public static JSONObject throwNewError(String error, String notes) {
+		JSONObject errorJson = new JSONObject();
+		errorJson.put("error", error);
+		errorJson.put("notes", notes);
+		return errorJson;
+	}
+
+	public static JSONObject throwNewError(String error, JSONObject notes) {
+		JSONObject errorJson = new JSONObject();
+		errorJson.put("error", error);
+		errorJson.put("notes", notes);
+		return errorJson;
+	}
 }