New features - Generate callgraph from a list of startfuncs, callgraph as json, script to compute syscalls

README.md

@@ -8,12 +8,16 @@ We update this repository to add more features and fix bugs. In case of any quer
 
 
 ## Upgrades and fixes
-We have upgraded SysPart for use in latest ubuntu versions. (ubuntu 18.04+). We have tested in ubuntu 22.04. Please find more info about how to upgrade in the [section](#run-in-latest-oS-versions).
+**⚡ LATEST UPDATE (SCALABLE TOOL WITH NEWER OPTIONS)!! ⚡**
+We have introduced new features, including improved scalability to handle larger binaries more efficiently, as well as added scripts that simplify and accelerate the analysis process. For more information, please see the sections [build new features](#build-new-features) and [run new features and options](#run-new-features-and-options).
+
+**⚡ UPGRADE TO LATEST OS!! ⚡**
+We have upgraded SysPart for use in latest ubuntu versions. (ubuntu 18.04+). We have tested in ubuntu 22.04. Please find more info about how to upgrade in the section [run in latest OS versions](#in-latest-os-versions).
 
 ## Basic Requirements
 - Works on **linux binaries (ELF)** which run on **x86-64** architecture
 - Tested with **ELF binaries with symbols** (application as well as libraries). It will work with stripped binaries, only that the results (like callgraph) might be overapproximated.
-- The tool was initially tested on **Ubuntu 18.04** and currently we have upgraded to later versions having been tested in ubuntu 22.04. Refer [section](#run-in-latest-oS-versions) to upgrade the repo for the latest ubuntu.
+- The tool was initially tested on **Ubuntu 18.04** and currently we have upgraded to later versions having been tested in ubuntu 22.04. Refer [run in latest OS versions](#in-latest-os-versions) to upgrade the repo for the latest ubuntu.
 
 ## Capabilities of the tool
 ### Any application
@@ -46,13 +50,6 @@ Once you ensure your public  keys are configured, you an clone the repository re
 git clone --recursive https://github.com/vidyalakshmir/SysPartCode.git
 ```
 
-#### Run in latest OS versions
-The initial repo was tested in ubuntu 18.04. We have upgraded it to work on latest ubuntu versions. As of now, we have tested on ubuntu 22.04. Please issue the following commands for the upgrade
-```
-cd SysPartCode/analysis/tools/egalito
-git checkout egalito-upgrade
-```
-
 ### Install all dependencies
 
 ```
@@ -61,14 +58,47 @@ sudo apt-get install make g++ libreadline-dev gdb lsb-release unzip libc6-dbg li
 sudo apt install libunwind-dev python3
 ```
 
-### Building the tool
+### Build new features
+If you want to use the newly added features of the tool including scalability updates and other additional features, please checkout the following git branch
+
+```
+git checkout new-features
+```
+
+### Building the tool 
+#### Older versions until Ubuntu 18.04
 
 ```
 ./build.sh
 ```
 
+#### In latest OS versions
+The initial repo was tested in ubuntu 18.04. We have upgraded it to work on latest ubuntu versions. As of now, we have tested on ubuntu 22.04. Please issue the following commands for the upgrade
+```
+./build_upgraded_egalito.sh
+```
+
 ## Using the tool
+### Run new features and options
+**To generate callgraph and compute system calls of a binary**
+
+Please make sure you are on the `new-features` branch of the git repository and have build it correctly. 
+
+In order to obtain the system calls of a ELF binary and its dependent libraries reachable from a list of system calls, use the following command
+
+```
+cd analysis/app
+src/scripts/compute_syscalls.sh $BINARY $OUT $STARTFILE --log`
+
+where $BINARY is the ELF binary to be analyzed
+      $OUT is the directory where output files will be stored (output directory)
+      $STARTFILE is the file containing a list of start functions
+      --log is optional parameter that logs the paths from start functions to the system calls in logfile.txt within the output directory
+```
+
+This will produce the callgraph as well the reachable system calls in different files within the output directory. To get more information about the script, please run the script `compute_syscalls.sh` with --help option.
 
+This does not produce results of dynamic libraries. Please refer to section [Dynamic Library Profiling](#dynamic-library-profiling) for more info.
 
 ### Generate callgraph 
 Uses static analysis to generate the callgraph of the application as well as its dependent libraries.