Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nima-sayadi committed Dec 26, 2024
1 parent 46e9eb5 commit 9c15046
Showing 1 changed file with 42 additions and 9 deletions.
51 changes: 42 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,26 @@ We address the following questions:

As large-scale studies with hundreds to thousands of systems are not easy to perform, such a study has not yet been performed.

# Steps to Use FlippyRAM
## 1. Download the ISO Image
- The FlippyRAM project provides an ISO image, HammerISO, for automated Rowhammer testing.
- Download the latest version of the ISO from [flippyr.am](https://flippyr.am).
# How to Run FlippyRAM
There are two easy ways to run the tool:

1. Use the ISO image (USB Device Required)
2. Use the `Docker` container

# Steps to Run FlippyRAM Using the ISO image
HammerISO is an ISO image that can be used for automated Rowhammer testing of
different systems. In the end of the experiment, a brief overview of the number
of bit flips found by different tools is shown.

## 1. Download the ISO Image
- The FlippyRAM project provides an ISO image, HammerISO, for automated Rowhammer testing.
- Download the latest version of the ISO from [flippyr.am](https://flippyr.am).

### Alternative: Build the ISO Image (Optional)
If you'd like to build the ISO image yourself:
- Ensure you are running **ArchLinux**.
- Clone the repository:
```
```bash
git clone https://github.com/iisys-sns/FlippyRAM.git
cd FlippyRAM
```
Expand Down Expand Up @@ -57,16 +63,43 @@ size connected to the system.

The parameter `<path/to/ISO/image.iso>` specifies the path to the ISO image.

## 3. Run the Tests
## 3. Run the Experiment
- Boot your target system using the USB drive with the flashed HammerISO.
- The ISO will automatically perform Rowhammer tests and display an overview of the results, including the number of bit flips detected.
- The ISO will automatically performs Rowhammer experiment and displays an overview of the results, including the number of bit flips detected.

## 4. The Results
- Logs/Results are saved and compressed in a ZIP file on a separate partition of the USB drive where you can easily access anytime.
- Logs/Results are stored and compressed in a ZIP file on a separate partition of the USB drive where you can easily access anytime.
- Multiple tests/boots will NOT erase previous results.

## 5. Upload Results (Optional)
- After completing the tests, the setup will prompt you to upload the results to our server (Optional).
- After completing the experiment, the setup will prompt you to upload the results to our server (Optional).
- Uploading helps contribute to the large-scale study at [flippyr.am](https://flippyr.am).

# Steps to Run FlippyRAM Using the Docker file
FlippyRAM provides a Docker file for easy and consistent deployment across different systems.
The Docker container simplifies the setup process by packaging all required dependencies and tools.
This approach allows you to run automated Rowhammer testing without worrying about system-specific configurations.

## 1. Install Docker Engine
You can find the instructions on how to install docker on your operating system here: [docker.com](https://docs.docker.com/engine/install/)

## 2. Run the Experiment
- Clone the repository:
```bash
git clone https://github.com/iisys-sns/FlippyRAM.git
cd FlippyRAM/ARHE
```
- Run the `Docker` file using:
```bash
sudo bash docker-run.sh
```

## 3. The Results
- Logs/Results are stored and compressed in a ZIP file in this path: `FlippyRAM/ARHE/data`
- Multiple tests will NOT erase previous results.

## 4. Upload Results (Optional)
- After completing the experiment, the setup will prompt you to upload the results to our server (Optional).
- Uploading helps contribute to the large-scale study at [flippyr.am](https://flippyr.am).

# Additional Information
Expand Down

0 comments on commit 9c15046

Please sign in to comment.