Welcome to ShadowFI’s documentation!

ShadowFI is an emulation-based fault injection framework for fault chareacterization and reliability assesemnt of hardware designs. ShadowFI leverages the acceleration capabilities of hiperscale infrastructures providing support for executing long fault injection tasks in both High Performance Computing (HPC) and FPGA hiperscaler systems.

ShadowFI implments fault instrumentation by inserting saboteur circuits directly on syntesizable HDL designs. This instrumentation is applied automatically based on user configurations, providing flexibility regarding the target components or hardware structures subject of evaluation.

Fault Instrumentation	Fault Simulation Workflow	Fault Emulation Workflow

ShadowFI provides both a CLI and GUI interfaces to automate the configuration and setup of the fault injection campaigns. ShadowFI incorporates two main workflows. The simulation workflow is mainly dedicated for executing fault injection workloads on HPC systems, whereas the emulation workflow accelerates the fault injection taks by using FPGA hiperscale systems.

Note

Simulation Workflow for deployment on HPC systems.

Note

FPGA emulation Workflow for deployment on HyperFPGA system.

Note

This project is under active development. The documentation is a work in progress and may not cover all features or configurations yet. Contributions are welcome!

Contents

• Quick Start Guide
  • Host System Requirements
    • Tool versioning SHADOWFI flow
  • Getting Started with ShadowFI on a local machine
    • Instalation procedure
      • Option 1: Use a prebuild singularity container
      • Option 2: Custom instalation
      • Option3: Build your own singularity container
    • Executing the first Fault Injection Campaign
  • Getting Started with HPC simulations
  • Getting Started with FPGA emulations
• Examples
  • Benchmarks using CLI mode
  • Benchmarks using GUI mode
    • Intro to GUI usage
• Tutorials
  • quick start
  • fault injection
  • saboteur circuits
  • case studies
• ShadowFI commands
  • Create projects
  • Load project
  • Elaborate HDL
  • SBTR place & routes
  • TestBench Setup
  • Fault Simulation Setup
  • Fault Simulation Execution
• Configuration Details
  • Basic Project Settings
  • Design Information Settings
  • Saboteur Insertion Settings
  • TestBench Settings For Simulation Workflows
  • Fault Simulation Settings For Simulation Workflows
  • FPGA Emulation Settings For Fault Emulation Workflow