Visible to Intel only — GUID: fip1521143226927
Ixiasoft
1. Intel® FPGA SDK for OpenCL™ Standard Edition Overview
2. Intel® FPGA SDK for OpenCL™ Offline Compiler Kernel Compilation Flows
3. Obtaining General Information on Software, Compiler, and Custom Platform
4. Managing an FPGA Board
5. Structuring Your OpenCL Kernel
6. Designing Your Host Application
7. Compiling Your OpenCL Kernel
8. Emulating and Debugging Your OpenCL Kernel
9. Reviewing Your Kernel's report.html File
10. Profiling Your OpenCL Kernel
11. Developing OpenCL™ Applications Using Intel® Code Builder for OpenCL™
12. Intel® FPGA SDK for OpenCL™ Standard Edition Advanced Features
A. Support Statuses of OpenCL Features
B. Document Revision History of the Intel® FPGA SDK for OpenCL™ Standard Edition Programming Guide
3.1. Displaying the Software Version (version)
3.2. Displaying the Compiler Version (-version)
3.3. Listing the Intel® FPGA SDK for OpenCL™ Standard Edition Utility Command Options (help)
3.4. Listing the Intel® FPGA SDK for OpenCL™ Offline Compiler Command Options (no argument, -help, or -h)
3.5. Listing the Available FPGA Boards in Your Custom Platform (-list-boards)
3.6. Displaying the Compilation Environment of an OpenCL Binary (env)
4.1. Installing an FPGA Board (install)
4.2. Uninstalling the FPGA Board (uninstall)
4.3. Querying the Device Name of Your FPGA Board (diagnose)
4.4. Running a Board Diagnostic Test (diagnose <device_name>)
4.5. Programming the FPGA Offline or without a Host (program <device_name>)
4.6. Programming the Flash Memory (flash <device_name>)
5.1. Guidelines for Naming the Kernel
5.2. Programming Strategies for Optimizing Data Processing Efficiency
5.3. Programming Strategies for Optimizing Pointer-to-Local Memory Size
5.4. Implementing the Intel® FPGA SDK for OpenCL™ Standard Edition Channels Extension
5.5. Implementing OpenCL Pipes
5.6. Implementing Arbitrary Precision Integers
5.7. Using Predefined Preprocessor Macros in Conditional Compilation
5.8. Declaring __constant Address Space Qualifiers
5.9. Including Structure Data Types as Arguments in OpenCL Kernels
5.10. Inferring a Register
5.11. Enabling Double Precision Floating-Point Operations
5.12. Single-Cycle Floating-Point Accumulator for Single Work-Item Kernels
5.4.1. Overview of the Intel® FPGA SDK for OpenCL™ Standard Edition Channels Extension
5.4.2. Channel Data Behavior
5.4.3. Multiple Work-Item Ordering for Channels
5.4.4. Restrictions in the Implementation of Intel® FPGA SDK for OpenCL™ Standard Edition Channels Extension
5.4.5. Enabling the Intel® FPGA SDK for OpenCL™ Standard Edition Channels for OpenCL Kernel
5.4.5.1. Declaring the Channel Handle
5.4.5.2. Implementing Blocking Channel Writes
5.4.5.3. Implementing Blocking Channel Reads
5.4.5.4. Implementing I/O Channels Using the io Channels Attribute
5.4.5.5. Emulating I/O Channels
5.4.5.6. Use Models of Intel® FPGA SDK for OpenCL™ Standard Edition Channels Implementation
5.4.5.7. Implementing Buffered Channels Using the depth Channels Attribute
5.4.5.8. Enforcing the Order of Channel Calls
5.5.5.1. Ensuring Compatibility with Other OpenCL SDKs
5.5.5.2. Declaring the Pipe Handle
5.5.5.3. Implementing Pipe Writes
5.5.5.4. Implementing Pipe Reads
5.5.5.5. Implementing Buffered Pipes Using the depth Attribute
5.5.5.6. Implementing I/O Pipes Using the io Attribute
5.5.5.7. Enforcing the Order of Pipe Calls
6.1. Host Programming Requirements
6.2. Allocating OpenCL Buffers for Manual Partitioning of Global Memory
6.3. Collecting Profile Data During Kernel Execution
6.4. Accessing Custom Platform-Specific Functions
6.5. Modifying Host Program for Structure Parameter Conversion
6.6. Managing Host Application
6.7. Allocating Shared Memory for OpenCL Kernels Targeting SoCs
6.8. Debugging Your OpenCL System That is Gradually Slowing Down
6.6.1. Displaying Example Makefile Fragments (example-makefile or makefile)
6.6.2. Compiling and Linking Your Host Application
6.6.3. Linking Your Host Application to the Khronos ICD Loader Library
6.6.4. Programming an FPGA via the Host
6.6.5. Termination of the Runtime Environment and Error Recovery
6.6.2.1. Displaying Flags for Compiling Host Application (compile-config)
6.6.2.2. Displaying Paths to OpenCL Host Runtime and MMD Libraries (ldflags)
6.6.2.3. Listing OpenCL Host Runtime and MMD Libraries (ldlibs)
6.6.2.4. Displaying Information on OpenCL Host Runtime and MMD Libraries (link-config or linkflags)
7.1. Compiling Your Kernel to Create Hardware Configuration File
7.2. Compiling Your Kernel without Building Hardware (-c)
7.3. Specifying the Location of Header Files (-I=<directory>)
7.4. Specifying the Name of an Intel® FPGA SDK for OpenCL™ Offline Compiler Output File (-o=<filename>)
7.5. Compiling a Kernel for a Specific FPGA Board (-board=<board_name>)
7.6. Resolving Hardware Generation Fitting Errors during Kernel Compilation (-high-effort)
7.7. Defining Preprocessor Macros to Specify Kernel Parameters (-D<macro_name>)
7.8. Generating Compilation Progress Report (-v)
7.9. Displaying the Estimated Resource Usage Summary On-Screen (-report)
7.10. Suppressing Warning Messages from the Intel® FPGA SDK for OpenCL™ Offline Compiler (-W)
7.11. Converting Warning Messages from the Intel® FPGA SDK for OpenCL™ Offline Compiler into Error Messages (-Werror)
7.12. Removing Debug Data from Compiler Reports and Source Code from the .aocx File (-g0)
7.13. Disabling Burst-Interleaving of Global Memory (-no-interleaving=<global_memory_type>)
7.14. Configuring Constant Memory Cache Size (-const-cache-bytes=<N>)
7.15. Relaxing the Order of Floating-Point Operations (-fp-relaxed)
7.16. Reducing Floating-Point Rounding Operations (-fpc)
8.1. Modifying Channels Kernel Code for Emulation
8.2. Compiling a Kernel for Emulation (-march=emulator)
8.3. Emulating Your OpenCL Kernel
8.4. Debugging Your OpenCL Kernel on Linux
8.5. Limitations of the Intel® FPGA SDK for OpenCL™ Standard Edition Emulator
8.6. Discrepancies in Hardware and Emulator Results
12.1.1. Understanding RTL Modules and the OpenCL Pipeline
12.1.2. Packaging an OpenCL Helper Function File for an OpenCL Library
12.1.3. Packaging an RTL Component for an OpenCL Library
12.1.4. Verifying the RTL Modules
12.1.5. Packaging Multiple Object Files into a Library File
12.1.6. Specifying an OpenCL Library when Compiling an OpenCL Kernel
12.1.7. Using an OpenCL Library that Works with Simple Functions (Example 1)
12.1.8. Using an OpenCL Library that Works with External Memory (Example 2)
12.1.9. OpenCL Library Command-Line Options
12.1.1.1. Overview: Intel FPGA SDK for OpenCL Pipeline Approach
12.1.1.2. Integration of an RTL Module into the Intel FPGA SDK for OpenCL Pipeline
12.1.1.3. Stall-Free RTL
12.1.1.4. RTL Module Interfaces
12.1.1.5. Avalon Streaming (Avalon-ST) Interface
12.1.1.6. RTL Reset and Clock Signals
12.1.1.7. XML Syntax of an RTL Module
12.1.1.8. Interaction between RTL Module and External Memory
12.1.1.9. Order of Threads Entering an RTL Module
12.1.1.10. OpenCL C Model of an RTL Module
12.1.1.11. Potential Incompatibility between RTL Modules and Partial Reconfiguration
A.1.1. OpenCL1.0 C Programming Language Implementation
A.1.2. OpenCL C Programming Language Restrictions
A.1.3. Argument Types for Built-in Geometric Functions
A.1.4. Numerical Compliance Implementation
A.1.5. Image Addressing and Filtering Implementation
A.1.6. Atomic Functions
A.1.7. Embedded Profile Implementation
Visible to Intel only — GUID: fip1521143226927
Ixiasoft
8.6. Discrepancies in Hardware and Emulator Results
When you emulate a kernel, your OpenCL system might produce results different from that of the kernel compiled for hardware.
Warning: These discrepancies usually occur when the Intel FPGA SDK for OpenCL Emulator is unable to model some aspects of the hardware computation accurately, or when your program relies on an undefined behavior.
The most common reasons for differences in emulator and hardware results are as follows:
- Your OpenCL kernel code is using the#pragma ivdep directive. The Emulator will not model your OpenCL system when a true dependence is broken by a pragma ivdep directive. During a full hardware compilation, you will observe this as an incorrect result.
- Your OpenCL kernel code is relying on uninitialized data. Examples of uninitialized data include uninitialized variables and uninitialized or partially initialized global buffers, local arrays, and private arrays.
- Your OpenCL kernel code behavior depends on the precise results of floating point operations. The Emulator uses floating point computation hardware of the CPU whereas the hardware run uses floating point cores implemented as FPGA cores. The use of -fp-relaxed aoc option in your OpenCL kernel code might change the order of operations leading to further divergence in the floating point results.
Note: The OpenCL standard allows one or more least significant bits of floating point computations to differ between platforms, while still being considered correct on both such platforms.
- Your OpenCL kernel code behavior depends on the order of channel accesses in different kernels. The emulation of channel behavior has limitations, especially for conditional channel operations where the kernel does not call the channel operation in every loop iteration. In such cases, the Emulator might execute channel operations in an order different from that on the hardware.
- Your OpenCL kernel or host code is accessing global memory buffers out-of-bounds.
Attention:
- Uninitialized memory read and write behaviors are platform-dependent. Verify sizes of your global memory buffers when using all addresses within kernels, allocating clCreateBuffer function call, and transferring clEnqueueReadBuffer and clEnqueueWriteBuffer function calls.
- You may use software memory leak detection tools, such as Valgrind, on emulated version of your OpenCL system to analyze memory related problems. Absence of warnings from such tools does not mean the absence of problems. It only means that the tool could not detect any problem. In such a scenario, Intel recommends manual verification of your OpenCL kernel or host code.
- Your OpenCL kernel code is accessing local or private variables out-of-bounds. For example, accessing a local or private array out-of-bounds or accessing a private variable after it has gone out of scope.
Attention: In software terms, these issues are referred to as stack corruption issues because accessing variables out-of-bounds usually affects unrelated variables located close to the variable being accessed on a software stack. Emulated OpenCL kernels are implemented as regular CPU functions, and have an actual stack that can be corrupted. When targeting hardware, no stack exists and hence, the stack corruption issues are guaranteed to manifest differently. You may use memory leak analyzer tools, such as Valgrind, when a stack corruption is suspected. However, stack related issues are usually difficult to identify. Intel recommends manual verification of your OpenCL kernel code to debug a stack related issue.
- Your OpenCL kernel code is using shifts that are larger than the type being shifted. For example, shifting a 64-bit integer by 65 bits. According to the OpenCL specification version 1.0, the behavior of such shifts is undefined.
Warning: If the shift amount is known during compilation, the offline compiler issues a warning message. You must heed to the warning message.
- When you compile your OpenCL kernel for emulation, the default channel depth is different from the default channel depth generated when your kernel is compiled for hardware. This difference in channel depths might lead to scenarios where execution on the hardware hangs while kernel emulation works without any issue. Refer to Emulating Channel Depth for information on how to fix the channel depth difference.
- In terms of ordering the printed lines, the output of the printf function might be ordered differently on the Emulator and hardware. This is because, in the hardware, printf data is stored in a global memory buffer and flushed from the buffer only when the kernel execution is complete, or when the buffer is full. In the Emulator, the printf function uses the x86 stdout.