ecaslab/cynq

PYNQ bindings for C and C++ to avoid requiring Python or Vitis to execute hardware acceleration.

cynq's Issues

Personalize installation of XRT

In ETH: /opt/xilinx/xrt/include

In Kria: /usr/include/xrt

Thread safety

We require a thread safety mechanism when dealing with accesses to an instance from different threads.

Improve the Hardware Creation and Accelerator API

Improve the Hardware Factory to require only the parameters needed.

The Accelerator API must guarantee the Read/Write/Attach to be uniform across platforms.

How to Compile A Program ?

Hi,
I'm trying to compile a program using your interface by running the GCC compiler on it and I keep getting this list of errors that i'm not really sure how to solve. What instructions and options do I need to configure with my compiler in order to get software properly with this frame work ?

test_cynq.cpp:(.text+0x28): undefined reference to `std::allocator<char>::allocator()'
/usr/bin/ld: test_cynq.cpp:(.text+0x5c): undefined reference to `cynq::IHardware::Create(cynq::HardwareArchitecture, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)'
/usr/bin/ld: test_cynq.cpp:(.text+0x64): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::~basic_string()'
/usr/bin/ld: test_cynq.cpp:(.text+0x6c): undefined reference to `std::allocator<char>::~allocator()'
/usr/bin/ld: test_cynq.cpp:(.text+0x110): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::~basic_string()'
/usr/bin/ld: test_cynq.cpp:(.text+0x120): undefined reference to `std::allocator<char>::~allocator()'
/usr/bin/ld: /tmp/cc3ZiyKX.o: in function `__static_initialization_and_destruction_0(int, int)':
test_cynq.cpp:(.text+0x198): undefined reference to `std::ios_base::Init::Init()'
/usr/bin/ld: test_cynq.cpp:(.text+0x1ac): undefined reference to `std::ios_base::Init::~Init()'
/usr/bin/ld: test_cynq.cpp:(.text+0x1b0): undefined reference to `std::ios_base::Init::~Init()'
/usr/bin/ld: /tmp/cc3ZiyKX.o: in function `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_Alloc_hider::~_Alloc_hider()':
test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_Alloc_hiderD2Ev[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_Alloc_hiderD5Ev]+0x10): undefined reference to `std::allocator<char>::~allocator()'
/usr/bin/ld: /tmp/cc3ZiyKX.o: in function `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::basic_string<std::allocator<char> >(char const*, std::allocator<char> const&)':
test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEC2IS3_EEPKcRKS3_[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEC5IS3_EEPKcRKS3_]+0x34): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_local_data()'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEC2IS3_EEPKcRKS3_[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEC5IS3_EEPKcRKS3_]+0x44): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_Alloc_hider::_Alloc_hider(char*, std::allocator<char> const&)'
/usr/bin/ld: /tmp/cc3ZiyKX.o: in function `void std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_construct<char const*>(char const*, char const*, std::forward_iterator_tag)':
test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0x70): undefined reference to `std::__throw_logic_error(char const*)'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0xa0): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_create(unsigned long&, unsigned long)'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0xac): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_data(char*)'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0xbc): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_capacity(unsigned long)'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0xc4): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_data() const'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0xd0): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_S_copy_chars(char*, char const*, char const*)'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0xe0): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_set_length(unsigned long)'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0x108): undefined reference to `__cxa_begin_catch'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0x110): undefined reference to `std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >::_M_dispose()'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0x114): undefined reference to `__cxa_rethrow'
/usr/bin/ld: test_cynq.cpp:(.text._ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag[_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE12_M_constructIPKcEEvT_S8_St20forward_iterator_tag]+0x11c): undefined reference to `__cxa_end_catch'
/usr/bin/ld: /tmp/cc3ZiyKX.o:(.data.rel.local.DW.ref.__gxx_personality_v0[DW.ref.__gxx_personality_v0]+0x0): undefined reference to `__gxx_personality_v0'
collect2: error: ld returned 1 exit status

Queue support

Using queues allows the creation of execution graphs. This support requires implementation

CYNQ clocking issues

Given that CYNQ does not parse the .hwh file, it is not possible to know addresses, aliases and clocks. There are two possibilities:

1. (Short term): add the option to configure clocks
2. (Long term): support .hwh parsing

Add support for multiple devices

Add the Hardware to work with a device ID.

Alveo already supports it.

Add attach support for MMIO accels

This intends to universalise the API between Alveo and MMIO

Support for XSA files

CYNQ can receive the bitstream only and work with it. However, it implies some drawbacks:

1. The addresses and offsets cannot be guessed: user is required to find them in Vivado and Vitis HLS
2. The clocks cannot be guessed: user is required to set a frequency for the design

To workaround this, we can use the .xsa file, which contains the .bit and the .hwh file. The former contains:

• IP names
• Addresses and offsets
• Clocks

Rename XRT Accelerator and XRT Data Mover to be MMIO and DMA respectively

This implies:

• Renaming the XRTAccelerator to be MMIOAccelerator
• Renaming the XRTDataMover to be DMADataMover
• Use the proper enumerators
• Return not implemented in case of trying another one.
• Handle everything at the HW Level
• Detect if the bitstream is provided or not in UltraScale hardware class

Memory synchronisation in XRT

There is no way in Ubuntu 22.04 to synchronise memory in a ordered fashion. The idea is to create a mechanism based on std::async when using eager mode.