README.md

pfuzz

Simulated processor fuzzing tool.

Table of contents

• Getting Started
  • Prerequisites
  • Installation
• Licenses

Getting Started

Prerequisites

• Python 3.10+ with pip 19.0+
• pipx
• Csmith
• gcc-riscv64-linux-gnu

Installation

Open the terminal and follow these steps:

1. Clone the repository:

   git clone git@github.com:SE-Processor-Fuzzing/pfuzz.git

2. Navigate to the project root:

   cd pfuzz

3. Install Poetry in an isolated environment with:

   pipx install poetry

4. Set Poetry configuration:

   Note: This command will make sure that poetry creates virtual environments within the project's root folder.

   poetry config virtualenvs.in-project true

5. Install all required dependencies:

   Note: Running the command will automatically create a virtual environment and install all dependencies in an isolated manner. For details see Poetry documentation.

   • For running the tool:

     poetry install

   • For development:

     poetry install --with dev