Developer Guide

Intel® oneAPI DPC++/C++ Compiler Handbook for FPGAs

Download PDF
ID 785441
Date 6/24/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Intel oneAPI DPC++/C++ Compiler Handbook for FPGAs Overview Introduction To FPGA Design Concepts Intel oneAPI FPGA Development Getting Started with the Intel oneAPI DPC++/C++ Compiler for Intel FPGA Development Defining a Kernel for FPGAs Debugging and Verifying Your Design Analyzing Your Design Optimizing Your Kernel Optimizing Your Host Application Integrating Your Kernel into DSP Builder for Intel FPGAs Integrating Your RTL IP Core Into a System RTL IP Core Kernel Interfaces Loops Pipes Data Types and Arithmetic Operations Parallelism Memories and Memory Operations Libraries Additional FPGA Acceleration Flow Considerations FPGA Optimization Flags, Attributes, Pragmas, and Extensions Quick Reference Additional Information Document Revision History for the Intel oneAPI DPC++/C++ Compiler Handbook for Intel FPGAs Notices and Disclaimers
Introduction To FPGA Design Concepts x
FPGA Architecture Overview Concepts of FPGA Hardware Design How Source Code Becomes a Custom Hardware Datapath
How Source Code Becomes a Custom Hardware Datapath x
Mapping Source Code Instructions to Hardware Scheduling Mapping Parallelism Models to FPGA Hardware Memory Types
Intel oneAPI FPGA Development x
FPGA Flow Terminology Intel oneAPI FPGA Development Flow Types of SYCL* FPGA Compilation FPGA Compilation Flags FPGA Workflows in IDEs
Types of SYCL* FPGA Compilation x
Separating Device and Host Code Compilation
Getting Started with the Intel oneAPI DPC++/C++ Compiler for Intel FPGA Development x
Installing the Intel oneAPI FPGA Development Environment FPGA Development for Intel oneAPI Toolkits with Visual Studio* Code
Installing the Intel oneAPI FPGA Development Environment x
Simulation Prerequisites Installing the Questa*-Intel FPGA Edition Software Set Up the Simulation Environment
FPGA Development for Intel oneAPI Toolkits with Visual Studio* Code x
Set the Environment Variables and Launch Visual Studio* Code Create an FPGA Visual Studio* Code Project Enable Code Completion in a Visual Studio* Code Project Configure Running and Debugging in a Visual Studio* Code Project Debugging Your Kernel in Visual Studio* Code with a Native Debugger Generate and View the FPGA Optimization Report Build and Run the FPGA Hardware Image
Defining a Kernel for FPGAs x
Suggested Kernel Coding Styles Single Work-Item Kernels
Single Work-Item Kernels x
Single Work-item Kernel Design Guidelines Single-Cycle Floating-Point Accumulator for Single Work-Item Kernels
Single-Cycle Floating-Point Accumulator for Single Work-Item Kernels x
Strategies for Inferring the Accumulator
Debugging and Verifying Your Design x
Device Selectors for FPGA printf Command Restrictions Emulate and Debug Your Design Evaluate Your Kernel Through Simulation
Emulate and Debug Your Design x
Emulator Environment Variables Compile and Emulate Your Design Limitations of the Emulator Troubleshooting Discrepancies in Hardware and Emulator Results Emulator Known Issues
Evaluate Your Kernel Through Simulation x
Debug During Verification Compile a Kernel for Simulation Simulate Your Kernel Viewing Simulation Waveforms Troubleshooting Simulator Issues
Analyzing Your Design x
Review the FPGA Optimization Report Quartus (Static) Summary Intel® FPGA Dynamic Profiler for DPC++
Review the FPGA Optimization Report x
Loop Analysis Bottlenecks Viewer Area Estimates System Viewer Kernel Memory Viewer Schedule Viewer Access FPGA Optimization Reports in JSON Format
Quartus (Static) Summary x
Timing Failures
Intel® FPGA Dynamic Profiler for DPC++ x
Measure Kernel Performance Instrument the Kernel Pipeline with Performance Counters (-Xsprofile) Obtain Profiling Data During Run Time Reduce Area Resource Use While Profiling Profiler Analyses of Example SYCL* Design Scenarios Limitations
Obtain Profiling Data During Run Time x
Invoke the Profiler Runtime Wrapper to Obtain Profiling Data Use Intel® VTune™ Profiler
Use Intel® VTune™ Profiler x
Interpret Performance Counter Data
Optimizing Your Host Application x
Throughput Resource Use System-level Profiling Using the Intercept Layer for OpenCL™ Applications Multithreaded Host Application Utilizing Hardware Kernel Invocation Queue Double Buffering Host Utilizing Kernel Invocation Queue N-Way Buffering to Overlap Kernel Execution Prepinning Memory Simple Host-Device Streaming Buffered Host-Device Streaming
System-level Profiling Using the Intercept Layer for OpenCL™ Applications x
Set Up the Intercept Layer for OpenCL™ Applications
Double Buffering Host Utilizing Kernel Invocation Queue x
Analyzing Buffering Using the Intercept Layer for OpenCL™ Applications
Integrating Your RTL IP Core Into a System x
Synthesize Your RTL IP Core with Quartus Prime Software Encrypting RTL IP Cores Add an RTL IP Core into a Platform Designer System Add an RTL IP Core into a Quartus Prime Project
Encrypting RTL IP Cores x
Encrypting RTL IP Cores Without Licensing Encrypting RTL IP Core With Licensing
RTL IP Core Kernel Interfaces x
Kernel Argument Interfaces Memory-Mapped (MM) Agent Kernel Invocation Interface Ready/Valid Handshaking Kernel Invocation Interface Memory-Mapped Host Interfaces Structs in RTL IP Core Interfaces IP core Reset Behavior
Memory-Mapped Host Interfaces x
Memory-Mapped Host Interfaces Using Unified Shared Memory Pointers and the annotated_arg Class Memory-Mapped Host Interfaces Using Accessors
Memory-Mapped Host Interfaces Using Unified Shared Memory Pointers and the annotated_arg Class x
Buffer Locations in Memory-Mapped Host Interfaces The annotated_arg Template Class
Loops x
Refactor the Loop-Carried Data Dependency Relax Loop-Carried Dependency Transfer Loop-Carried Dependency to Local Memory Minimize the Memory Dependencies for Loop Pipelining Unroll Loops Fuse Loops to Reduce Overhead and Improve Performance Optimize Loops With Loop Speculation Remove Loop Bottlenecks Improve fMAX/II with Shannonization Optimize Inner Loop Throughput Improve Loop Performance by Caching Data in On-Chip Memory
Pipes x
Host Pipes Pipes Extension
Host Pipes x
Host Pipe Declaration Host Pipe API Host Pipes RTL Interfaces
Pipes Extension x
Key Properties of a Pipe Accessing Pipes The pipe Class and its Use I/O Pipes Characteristics of Pipes Restrictions of Pipes Guidelines for Designing Pipes The atomic_fence Function and Pipes
I/O Pipes x
Emulate Applications with a Pipe That Reads or Writes to an I/O Pipe
Data Types and Arithmetic Operations x
Optimize Floating-point Operation Minimize the Use of Expensive Functions Variable-Precision Data Type Support
Variable-Precision Data Type Support x
Advantages and Limitations of Variable Precision Data Types Declare and Use the AC Data Types
Declare and Use the AC Data Types x
Declare the ac_int Data Type Declare the ac_fixed Data Type Declare the ac_complex Data Type Declare the ap_float Data Type
Declare the ap_float Data Type x
Conversion Rules for the ap_float Data Type Operations with Explicit Precision Controls Comparison Operators Additional ap_float Functions Additional Data Types Provided by the ap_float.hpp Header File Quality of Results and the ap_float Data Type
Parallelism x
Pipelined Kernels NDRange Kernels Asynchronous Parallelism Within Kernels (task_sequence)
Pipelined Kernels x
Stable Arguments
Asynchronous Parallelism Within Kernels (task_sequence) x
Task Functions task_sequence Use Cases
Memories and Memory Operations x
The device_global Extension (Beta) The annotated_ptr Template Class (Beta) Memory Accesses Kernel Variable Accesses
Memory Accesses x
Load-Store Units Global Memory Accesses Optimization Perform Kernel Computations Using Local or Private Memory Local and Private Memory Accesses Optimization Annotating Unified Shared Memory Pointers Zero-Copy Memory Access Additional Recommendations
Load-Store Units x
Load-Store Unit Styles Load-Store Unit Modifiers Load-Store Unit Controls
Global Memory Accesses Optimization x
Global Memory Bandwidth Use Calculation Manual Partition of Global Memory Partitioning Buffers Across Different Memory Types (Heterogeneous Memory) Partitioning Buffers Across Memory Channels of the Same Memory Type Ignoring Dependencies Between Accessor Arguments Contiguous Memory Accesses Static Memory Coalescing
Libraries x
Use SYCL Shared Library With Third-Party Applications Use of RTL Libraries for FPGA Object Manifest File Syntax of an RTL Library Restrictions and Limitations in RTL Support Agilex 7 and Stratix 10 Design-Specific Reset Requirements for Stall-Free and Stallable RTL Libraries Stall-Free RTL
Additional FPGA Acceleration Flow Considerations x
FPGA-CPU Interaction FPGA Boards and Board Support Packages (BSPs) Targeting Multiple Identical FPGA Devices Targeting Multiple Platforms Split Kernel into Multiple FPGA Images (Linux only)
FPGA Boards and Board Support Packages (BSPs) x
The FPGA Board Utility Commands Managing an FPGA Board Installing a BSP (aocl install Command) Listing Detected FPGA Boards (aocl list-devices Command) Initializing an FPGA Board (aocl initialize Command) Running the Board-Related Diagnostic Utility (aocl diagnose Command) Uninstalling a BSP (aocl uninstall Command) Advanced Board Management The OpenCL™ Installable Client Driver (ICD)
Advanced Board Management x
Extracting the FPGA Device Image (.aocx) File from a Multiarchitecture Binary File
FPGA Optimization Flags, Attributes, Pragmas, and Extensions x
Optimization Flags Optimization Targets Kernel Variables Kernel Attributes Memory Attributes Loop Directives Floating-Point Pragmas Latency Controls (Beta)
Optimization Flags x
Specify Schedule fMAX Target for Kernels (-Xsclock=<clock target>) Create a 2xclock Interface (-Xsuse-2xclock) Disable Burst-Interleaving of Global Memory (-Xsno-interleaving) Force Ring Interconnect for Global Memory (-Xsglobal-ring) Force a Single Store Ring to Reduce Area (-Xsforce-single-store-ring) Force Fewer Read Data Reorder Units to Reduce Area (-Xsnum-reorder) Disable Hardware Kernel Invocation Queue (-Xsno-hardware-kernel-invocation-queue) Modify the Handshaking Protocol Between Clusters (-Xshyper-optimized-handshaking) Disable Automatic Fusion of Loops (-Xsdisable-auto-loop-fusion) Fuse Adjacent Loops With Unequal Trip Counts (-Xsenable-unequal-tc-fusion) Pipeline Loops in Non-task Kernels (-Xsauto-pipeline) Control Semantics of Floating-Point Operations (-fp-model=<value>) Modify the Rounding Mode of Floating-point Operations (-Xsrounding=<rounding_type>) Global Control of Exit FIFO Latency of Stall-free Clusters (-Xssfc-exit-fifo-type=<value>) Enable the Read-Only Cache for Read-Only Accessors (-Xsread-only-cache-size=<N>) Control Hardware Implementation of the Supported Data Types and Math Operations (-Xsdsp-mode=<option>) Generate Register Map Wrapper (-Xsregister-map-wrapper-type) Allow Wide Memory Initialization (-Xsallow-wide-device-globals)
Optimization Targets x
Minimum Latency Flow Minimum Area Flow Balanced Throughput-Area Trade-Offs Flow
Kernel Attributes x
Specify Schedule fMAX Target for Kernels (scheduler_target_fmax_mhz) Specify a Workgroup Size (max_work_group_size/reqd_work_group_size) Specify Number of SIMD Work Items (num_simd_work_items) Omit Hardware that Generates and Dispatches Kernel IDs (max_global_work_dim) Omit Hardware that Supports Global Work Offsets (no_global_work_offset) Reduce Kernel Area and Latency (use_stall_enable_clusters)
Loop Directives x
disable_loop_pipelining Attribute initiation_interval Attribute ivdep Attribute loop_coalesce Attribute max_concurrency Attribute max_interleaving Attribute speculated_iterations Attribute unroll Pragma Loop Fuse Functions and nofusion Attribute max_reinvocation_delay Attribute (Beta)
Quick Reference x
Algorithmic C Data Types Floating Point Pragmas FPGA Accessor Properties FPGA Extensions FPGA Kernel Attributes FPGA Local Memory Function Latency Control Properties (Beta) FPGA LSU Controls FPGA Loop Directives FPGA Memory Attributes FPGA Optimization Flags Pipe API
Intel oneAPI DPC++/C++ Compiler Handbook for FPGAs Overview
Introduction To FPGA Design Concepts
Intel oneAPI FPGA Development
Getting Started with the Intel oneAPI DPC++/C++ Compiler for Intel FPGA Development
Defining a Kernel for FPGAs
Debugging and Verifying Your Design
Analyzing Your Design
Optimizing Your Kernel
Optimizing Your Host Application
Integrating Your Kernel into DSP Builder for Intel FPGAs
Integrating Your RTL IP Core Into a System
RTL IP Core Kernel Interfaces
Loops
Pipes
Data Types and Arithmetic Operations
Parallelism
Memories and Memory Operations
Libraries
Additional FPGA Acceleration Flow Considerations
FPGA Optimization Flags, Attributes, Pragmas, and Extensions
Quick Reference
Additional Information
Document Revision History for the Intel oneAPI DPC++/C++ Compiler Handbook for Intel FPGAs
Notices and Disclaimers

Managing an FPGA Board

Managing an FPGA board typically involves the following tasks:

Installing a BSP (aocl install Command)

Installing a BSP with the aocl install command installs the device drivers that make the FPGA board accessible to the host operating system, and it installs the FPGA client driver (FCD) for your board to make the board accessible to the oneAPI runtime.

Before you install a BSP, you must have the FPGA board connected to your host system.

To run the aocl install command, you must know the directory that contains the BSP files for your board. Optionally, you can set the AOCL_BOARD_PACKAGE_ROOT environment variable to point this directory. If you have the AOCL_BOARD_PACKAGE_ROOT environment variable, you can omit the path to the BSP from any FPGA utility commands that require that path.

aocl install Command Use Cases
Use Case Command
Install a BSP aocl install <BSP_root_folder>

where <BSP_root_folder> is the full path of the directory that contains the BSP.
Install the FCD for the board only

For this use case, the FPGA board device drivers must be already be installed.

This use case typically occurs if you have previous run the aocl uninstall -fcd-only command.

 aocl install <BSP_root_folder> -fcd-only

where <BSP_root_folder> is the full path of the directory that contains the BSP.

After you have run the aocl install command, you can use the aocl list-devices and aocl diagnose commands to confirm that the BSP installation was successful.

Listing Detected FPGA Boards (aocl list-devices Command)

Use the aocl list-devices command to show a list of FPGA boards that are detected on your system. The board device name shown under the Device Name section in the output of this command is needed for board-specific FPGA utility commands such as aocl initialize.

The command generates output similar to the following:

--------------------------------------------------------------------
Device Name:
acl0
 
BSP Install Location:
<board_package_path>
 
Vendor: Intel(R) Corporation
 
Phys Dev Name   Status   Information
 
<phys_dev_name> Passed   <descriptive_board_name>
                         PCIe dev_id = <dev_id>, bus:slot.func = 01:00.00, Gen3 x8
                         FPGA temperature = 32.6016 degrees C.
 
DIAGNOSTIC_PASSED
--------------------------------------------------------------------

Initializing an FPGA Board (aocl initialize Command)

Initializing an FPGA board with the aocl initialize command lets the oneAPI SYCL* runtime know that the FPGA board (and board variant) is available. Your multiarchtechture binary will fail to run it if the target board is not initialized.

You must initialize an FPGA board after any of the following events:

  • The FPGA board host system was power cycled.
  • A non-SYCL* workload was run on the FPGA device.
  • The multiarchitecture binary was recompiled to a different board variant (as specified by the -Xstarget compiler command option)

To initialize a board, you must know the FPGA board device name (from the aocl list-devices command), and the name of the board variant as specified by the -Xstarget compiler command option when the multiarchitecture binary was compiled. Whoever compiled the multiarchitecture binary can provide you with the board variant to specify.

Initialize a board with the following command:

aocl intialize <board_device_name> <board_variant>

Running the Board-Related Diagnostic Utility (aocl diagnose Command)

Running the board-related diagnostic utilities checks and reports your OpenCL* installable client driver (ICD) and your FPGA client driver (FCD) configuration. For more information about the OpenCL* installable client driver (ICD) and its role in developing your multiarchitecture binary, refer to The OpenCL™ Installable Client Driver (ICD).

The utility can report information about the FPGA boards that are discoverable by the host operating system.

The diagnostic utility has the following use modes:

Default mode
In default mode, the utility runs ICD and FCD diagnostics and lists the FPGA boards that are discoverable by the host operating system. Run the utility in default mode with the following command: 
aocl diagnose

If your system is configured correctly, the command output includes the following messages:

  • ICD diagnostics passed
  • DIAGNOSTIC_PASSED

Client driver–only mode
In client driver–only mode, the utility runs only the ICD and FCD diagnostics. Run the utility in client driver–only mode with the following command: 
aocl diagnose -icd-only
If your system is configured correctly, the command output includes the following messages: 
  • ICD diagnostics passed

You can successfully run the utility in client driver–only mode without any FPGA boards present on the host system.

Board diagnostic mode
In board diagnostic mode, the utility runs a diagnostic routine provided by your FPGA acceleration board vendor. To run the diagnostic routine, the FPGA board must be discoverable by the host operating system. Run the utility in board diagnostic mode with the following command: 
aocl diagnose <board_device_name>
where <board_device_name> is the board device name as reported under the Device Name section of either the aocl list-devices command output or the default mode aocl diagnose command output.

Uninstalling a BSP (aocl uninstall Command)

Uninstalling a BSP removes the FCD for the board and uninstalls the device drivers for the board. You can also choose to uninstall only the FCD.

aocl uninstall Command Use Cases
Use Case Command
Uninstall a BSP aocl uninstall <BSP_root_folder>

where <BSP_root_folder> is the full directory path of the BSP that you are uninstalling.
Uninstall the FCD for the board only

For this use case, the FPGA board device drivers remain installed.

Use the aocl install -fcd-install command to reinstall the FCD.

 aocl uninstall <BSP_root_folder> -fcd-only

where <BSP_root_folder> is the full directory path of the BSP that you are uninstalling.

Parent topic: FPGA Boards and Board Support Packages (BSPs)
Level Two Title