RapidStream TAPA Documentation

Welcome to the RapidStream TAPA documentation. RapidStream TAPA is a powerful framework for designing high-frequency FPGA dataflow accelerators. It combines a robust C++ API for expressing task-parallel designs with advanced optimization techniques from RapidStream to deliver exceptional design performance and productivity.

This documentation is divided into three main sections: User Documentation for those using TAPA to develop FPGA accelerators, Tutorials for hands-on examples, and Developer Documentation for those contributing to or extending the TAPA framework itself.

User Documentation

• Introduction
  • What is RapidStream TAPA?
  • TAPA Programming Model
  • RapidStream Optimization
  • Success Stories
  • Summary
• Installation
  • One-Step Installation
  • System Prerequisites
  • RapidStream License
• Getting Started with TAPA
  • FPGA TAPA Task
  • Host Driver Program
  • Software Simulation
  • Synthesis into RTL
  • Hardware Simulation
  • On-Board Execution
• Simulation and RTL Cosimulation
  • Software Simulation
  • Fast Hardware Simulation
  • Vitis Hardware Simulation
  • Choosing the Right Approach
• Hardware Implementation
  • Host-Kernel Interface
  • Generate Bitstream
  • Execute on an FPGA
• Tasks and Hierarchical Design
  • TAPA Tasks
  • Leaf Tasks
  • Upper-Level Tasks
  • Top-Level Task
  • Detached Tasks
  • Hierarchical Design
• Dataflow Movements
  • Dataflow Channels (Stream)
  • Memory-Mapped (MMAP)
  • Stream and MMAP Arrays
  • Asynchronous Memory Access
  • Sharing Memory Interfaces
• Optimization with RapidStream
  • Getting Started
  • Customizing the Target Device
  • Controlling the Floorplan
  • Design Space Exploration

• Quick Reference

Tutorials

• Efficient Memory Accesses
  • Example 1: Multi-Outstanding Random Memory Accesses
  • Example 2: Efficient Sequential Reading
  • Example 3: Efficient Sequential Writing
  • Example 4: Pipelined Read-Modify-Write Operations
• Migrating from Vitis HLS
  • Example 1: Basics with VecAdd
  • Example 2: Complex Scenarios
  • Example 3: HLS-Compat Helpers
• Common Mistakes and Tips
  • Passing Streams
  • Passing Memory Maps
  • Using Streams/MMAPs Arrays
  • Ensuring Correct Task Invocations
  • Organizing Task Definitions
  • Structuring Upper Tasks in TAPA
  • Working with Templates in Tasks
  • Correctly Defining Stream Arrays
  • Avoiding Static Variables
  • Other Debugging Tips
• Mini Examples
  • Vector Add
  • Bandwidth Test (using async_mmap)
  • Network
  • Cannon
  • Jacobi
• Real-World Examples

Reference

• TAPA Library (libtapa)
  • Task Library
    • task
    • seq
  • Stream Library
    • istream
    • istreams
    • ostream
    • ostreams
    • stream
    • streams
  • MMAP Library
    • async_mmap
    • mmap
    • mmaps
  • Utility Library
    • widthof()
    • widthof()
  • HLS-Compat Library
    • stream
    • stream_interface
    • task
• TAPA Compiler (tapa)
  • tapa
    • analyze
    • compile
    • g++
    • link
    • pack
    • synth
    • version
• TAPA Output Files
  • XO Object
  • Intermediate Files

Developer Documentation

• Building from Source
  • System Prerequisites
  • Clone the Repository
  • Build TAPA from Source
  • Use the Built TAPA
  • Run TAPA Tests
  • Build Binary Distribution
  • Install the Binary Distribution
  • Containerized Build (Advanced)
• Developing TAPA
  • Development Environment
  • Code Structure
  • Update Dependencies
• Contributing to TAPA
  • Pull Request Process
  • Reporting Issues
  • Community Guidelines
• Releasing TAPA Builds

FAQ

• Frequently Asked Questions