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 two main sections: User Documentation for those using TAPA to develop FPGA accelerators, 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
• Optimization with RapidStream
  • Getting Started
  • Customizing the Target Device
  • Controlling the Floorplan
  • Design Space Exploration
• RTL Simulation
  • Fast Lightweight Simulation
  • Vitis Hardware Simulation
  • Choosing the Right Approach
• Hardware Implementation
  • Generate Bitstream
  • Execute on an FPGA

• Quick Reference

Tutorial: Expressiveness

• Flexible Interaction with Streams
  • Peeking a Stream
  • End-of-Transaction
• More on Defining Tasks
  • Detached Task
  • Hierarchical Design
• Less Repetitive Code with Stream/MMAP Array
• Flexible Memory Access
  • The Programming Model of async_mmap
  • Basic Usage of async_mmap
  • Runtime Burst Detection
  • Smaller Area Overhead
  • Sharing External Memory Interfaces
  • Example 1: Multi-Outstanding Random Memory Accesses
  • Example 2: Sequential Read from async_mmap into an Array
  • Example 3: Sequential Write into async_mmap from a FIFO
  • Example 4: Simultaneous Read and Write to async_mmap

Tutorial: Design Tips

• Migrate from Vitis HLS
  • Example 1
    • Update the Includes
    • Update the Top Function
    • Update Task Definitions
    • Final Look of Example 1
  • Example 2
    • Dataflow in a Loop
    • Computation in the Top Function
    • Final Look of Example 2
  • HLS-Compat Helpers
    • HLS-Compat Header
    • Infinite-Depth Stream
    • I/O Direction-Agnostic Stream Interface
    • Sequentially Scheduled Task
    • HLS-Compat Version of Example 1
• Debug Tips

Example Designs

• Mini Examples
  • Vector Add
  • Vector Add with Shared Memory Interface
  • Vector Add with Multiple Task Hierarchy
  • Bandwidth Test (using async_mmap)
  • Network
  • Cannon
  • Jacobi
• Real-World Examples

More about TAPA

• Summary
  • Programmability Improvement
  • Beyond Programmability
• Kernel Communication Interface
• Host-Kernel Interface
• Software Simulation
• RTL Code Generation
• Memory System
• Detached Tasks
• Hardware FIFO
• Timing Closure

Reference

• The TAPA Library (libtapa)
  • The Task Instantiation Library
    • task
      • task
        • task::task()
        • task::invoke()
        • task::invoke()
        • task::invoke()
      • seq
        • seq::seq()
  • The Streaming Library
    • istream
      • istream
        • istream::empty()
        • istream::try_eot()
        • istream::eot()
        • istream::eot()
        • istream::try_peek()
        • istream::peek()
        • istream::peek()
        • istream::peek()
        • istream::try_read()
        • istream::read()
        • istream::operator>>()
        • istream::read()
        • istream::read()
        • istream::read()
        • istream::try_open()
        • istream::open()
    • istreams
      • istreams
        • istreams::operator[]()
        • istreams::length
    • ostream
      • ostream
        • ostream::full()
        • ostream::try_write()
        • ostream::write()
        • ostream::operator<<()
        • ostream::try_close()
        • ostream::close()
    • ostreams
      • ostreams
        • ostreams::operator[]()
        • ostreams::length
    • stream
      • stream
        • stream::stream()
        • stream::stream()
        • stream::depth
    • streams
      • streams
        • streams::streams()
        • streams::streams()
        • streams::operator[]()
        • streams::length
        • streams::depth
  • The MMAP Library
    • async_mmap
      • async_mmap
        • async_mmap::addr_t
        • async_mmap::resp_t
        • async_mmap::read_addr
        • async_mmap::read_data
        • async_mmap::write_addr
        • async_mmap::write_data
        • async_mmap::write_resp
    • mmap
      • mmap
        • mmap::mmap()
        • mmap::mmap()
        • mmap::mmap()
        • mmap::operator T*()
        • mmap::operator++()
        • mmap::operator--()
        • mmap::operator++()
        • mmap::operator--()
        • mmap::data()
        • mmap::get()
        • mmap::size()
        • mmap::vectorized()
        • mmap::reinterpret()
    • mmaps
      • mmaps
        • mmaps::mmaps()
        • mmaps::mmaps()
        • mmaps::operator[]()
        • mmaps::vectorized()
        • mmaps::reinterpret()
  • The Utility Library
    • widthof
      • widthof()
      • widthof()
  • The HLS-Compat Library
    • hls_compat::stream
      • stream
    • hls_compat::stream_interface
      • stream_interface
    • hls_compat::task
      • task
• The TAPA Compiler (tapac)
  • tapa
    • analyze
    • compile
    • g++
    • link
    • pack
    • synth
    • version
• Organization of TAPA Output Files
  • The XO Object
  • The XXX_generate_bitstream.sh script
  • The XXX_floorplan.tcl
  • tapac Intermediate Files
• Known Issues

Developer Documentation