[SYCL][FPGA] Support Intel FPGA simulator device selector #6715

mendell27 · 2022-09-07T13:18:07Z

Create fpga_simulator_selector to be used to select the FPGA simulator device. This assumes that the user has compiled their program with -Xssimulation (as well as -fintelfpga) to prepare for the simulator.

An object of class fpga_simulator_selector must be constructed early in the execution of the host program in order to make the simulator available at runtime.

The current implementation has the effect that if an object of class sycl::ext::intel::fpga_simulator_selector is defined, FPGA hardware devices selected using sycl::ext::intel::fpga_selector will select simulator devices. This will be documented in the release notes and the specification. We expect this behaviour to be eliminated in the future.

Create fpga_simulator_selector to be used to select the FPGA simulator. This assumes that the user has compiled their program with -Xssimulation (as well as -fintelfpga) to prepare for the simulator. An object of class fpga_simulator_selector must be constructed early in the execution of the host program in order to make the simulator available at runtime. The emulator and hardware FPGA device selectors will prefer the emulator/hardware over a simulation device if both have the same device name.

mendell27 · 2022-09-07T14:08:02Z

The failing tests have nothing to do with my change. What can/should I do?

I tried with SetEnvironmentA, and it didn't work for me

Create fpga_simulator_selector to be used to select the FPGA simulator. This assumes that the user has compiled their program with -Xssimulation (as well as -fintelfpga) to prepare for the simulator. An object of class fpga_simulator_selector must be constructed early in the execution of the host program in order to make the simulator available at runtime. The emulator and hardware FPGA device selectors will prefer the emulator/hardware over a simulation device if both have the same device name.

I tried with SetEnvironmentA, and it didn't work for me

At this point, I am okay with the restriction that the simulator device replaces any hardware ones. It is unlikely that anyone interested in using the simulator would also want to use hardware in the same program

mendell27 · 2022-09-08T20:30:01Z

I changed my mind. This is now okay to review. We will live with the hardware/simulator restriction as if is unlikely for a user to want both simultaneously.

I have updated to re-use existing code

mendell27 · 2022-09-08T20:43:55Z

How do I fix a clang-format failure in a clang file that I didn't change? clang/lib/Sema/SemaChecking.cpp

sycl/include/sycl/ext/intel/fpga_device_selector.hpp

romanovvlad · 2022-09-11T14:57:57Z

sycl/include/sycl/ext/intel/fpga_device_selector.hpp

+    //   Currently only 1 simulator device is supported
+    auto devices = std::to_string(numDevices);
+#ifdef _WIN32
+    _putenv_s("CL_CONTEXT_MPSIM_DEVICE_INTELFPGA", devices.c_str());


Could you please provide a link to some documentation for this env var?

It is documented in oneAPI and for OpenCL in 11.1.7.2. Simulating Your OpenCL Library in OpenCL

For oneAPI, the intent is to hide this environment variable from the user, as it is very intrusive. OpenCL has a multi-step process for running programs, while oneAPI hides all that. We would prefer it not to be openly documented.

When compiling for OpenCL for simulation, the aoc command explicitly tells the user to set the variable. For oneAPI, aoc does not print this message

sycl/include/sycl/ext/intel/fpga_device_selector.hpp

mendell27 · 2022-09-12T15:15:40Z

Is it possible to resolve this today? We want to get the code sample changes in by CC (Thursday?), so there is a bit of a rush

Document fpga_simulator_selector in official documentation. Bump the version to 2.

sycl/include/sycl/feature_test.hpp.in

gmlueck · 2022-09-12T21:07:11Z

Do you mind using this PR to update the extension specification to use the official template? I know the existing spec does not follow that template, but this seems like a good opportunity to remove some technical debt.

The specification needs to be updated anyway to make it clear that the new fpga_simulator_selector is added in revision 2 of the spec. This will be easier to do if it follows the template.

Create fpga_simulator_selector to be used to select the FPGA simulator device. This assumes that the user has compiled their program with -Xssimulation (as well as -fintelfpga) to prepare for the simulator.

An object of class fpga_simulator_selector must be constructed early in the execution of the host program in order to make the simulator available at runtime.

The emulator and hardware FPGA device selectors will prefer the emulator/hardware over a simulation device if both have the same device name.

The current implementation has the effect that if an object of class sycl::ext::intel::fpga_simulator_selector is defined, FPGA hardware devices selected using sycl::ext::intel::fpga_selector will select simulator devices. This will be documented in the release notes. We expect this behaviour to be eliminated in the future.

Some of this information seems like important stuff that the user needs to know. If so, it should be added to the extension specification, perhaps as a NOTE. For example:

[NOTE]
====
In the DPC++ implementation, the application must be built with "-Xssimulation"
in order to use `sycl::ext::intel::fpga_simulator_selector`.
====

Note that the SYCL 2020 style for selectors is to define an object that is the selector, not to define a type that the application has to construct. Do you plan to update this extension to follow that style? Mentioning this now in case you want to migrate to the new style now and then add this new selector only with the new style.

Rewrite as requested. Document current restrictions with the simulator selector affecting hardware.

mendell27 · 2022-09-13T15:00:50Z

Updated to the current template. I am not going to change to the object format at this time, as the current implementation of the FPGA runtime needs to be enhanced to support having the simulator active at all times first

sycl/doc/extensions/supported/sycl_ext_intel_fpga_device_selector.asciidoc

mendell27 · 2022-09-14T20:47:00Z

Build check failures are not related to my changes

mendell27 requested a review from a team as a code owner September 7, 2022 13:18

mendell27 requested a review from romanovvlad September 7, 2022 13:18

Fix clang-format problems found

f961817

bader changed the title ~~Support Intel FPGA simulator device selector~~ [SYCL] Support Intel FPGA simulator device selector Sep 7, 2022

mendell27 changed the title ~~[SYCL] Support Intel FPGA simulator device selector~~ [SYCL][FPGA] Support Intel FPGA simulator device selector Sep 7, 2022

mendell27 added 5 commits September 7, 2022 16:19

Use _putenv_s to set env for FPGA simulator

18f6943

I tried with SetEnvironmentA, and it didn't work for me

Use _putenv_s to set env for FPGA simulator

652163a

I tried with SetEnvironmentA, and it didn't work for me

Redo implementation to re-use existing code

c2eb7dc

At this point, I am okay with the restriction that the simulator device replaces any hardware ones. It is unlikely that anyone interested in using the simulator would also want to use hardware in the same program

Redo implementation to re-use existing code

1ab603d

At this point, I am okay with the restriction that the simulator device replaces any hardware ones. It is unlikely that anyone interested in using the simulator would also want to use hardware in the same program

romanovvlad requested changes Sep 11, 2022

View reviewed changes

Merge branch 'intel:fpga_simulator_device' into fpga_simulator_device

bc368a1

bader requested a review from romanovvlad September 12, 2022 15:52

Clean implementation of fpga_simulator_selector

d141b1d

Document fpga_simulator_selector in official documentation. Bump the version to 2.

mendell27 requested a review from a team as a code owner September 12, 2022 20:26

mendell27 commented Sep 12, 2022

View reviewed changes

sycl/include/sycl/feature_test.hpp.in Outdated Show resolved Hide resolved

mendell27 added 2 commits September 12, 2022 17:31

Remove incorrect #ifndef for version change

1be2e53

Rewrite documentation using asciidoc template

23f37ea

Rewrite as requested. Document current restrictions with the simulator selector affecting hardware.

mendell27 added 2 commits September 13, 2022 11:04

Correct doc errors

202fc47

Make more doc fixes

47b020a

romanovvlad previously approved these changes Sep 13, 2022

View reviewed changes

mendell27 requested a review from gmlueck September 13, 2022 16:48

gmlueck reviewed Sep 14, 2022

View reviewed changes

Make changes from doc review

242d844

mendell27 dismissed romanovvlad’s stale review via 242d844 September 14, 2022 20:00

gmlueck approved these changes Sep 14, 2022

View reviewed changes

mendell27 requested a review from romanovvlad September 14, 2022 20:07

romanovvlad approved these changes Sep 14, 2022

View reviewed changes

bader merged commit 9bef890 into intel:sycl Sep 15, 2022

mendell27 deleted the fpga_simulator_device branch September 15, 2022 12:54

yuguen mentioned this pull request Sep 26, 2022

Add simulation targets to oneAPI examples printf and merge_sort haoxian2/oneAPI-samples#1

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[SYCL][FPGA] Support Intel FPGA simulator device selector #6715

[SYCL][FPGA] Support Intel FPGA simulator device selector #6715

Uh oh!

mendell27 commented Sep 7, 2022 •

edited

Loading

Uh oh!

mendell27 commented Sep 7, 2022

Uh oh!

mendell27 commented Sep 8, 2022

Uh oh!

mendell27 commented Sep 8, 2022 •

edited

Loading

Uh oh!

Uh oh!

romanovvlad Sep 11, 2022

Uh oh!

mendell27 Sep 12, 2022

Uh oh!

Uh oh!

Uh oh!

mendell27 commented Sep 12, 2022

Uh oh!

Uh oh!

gmlueck commented Sep 12, 2022

Uh oh!

mendell27 commented Sep 13, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mendell27 commented Sep 14, 2022

Uh oh!

Uh oh!

[SYCL][FPGA] Support Intel FPGA simulator device selector #6715

[SYCL][FPGA] Support Intel FPGA simulator device selector #6715

Uh oh!

Conversation

mendell27 commented Sep 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mendell27 commented Sep 7, 2022

Uh oh!

mendell27 commented Sep 8, 2022

Uh oh!

mendell27 commented Sep 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

romanovvlad Sep 11, 2022

Choose a reason for hiding this comment

Uh oh!

mendell27 Sep 12, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mendell27 commented Sep 12, 2022

Uh oh!

Uh oh!

gmlueck commented Sep 12, 2022

Uh oh!

mendell27 commented Sep 13, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mendell27 commented Sep 14, 2022

Uh oh!

Uh oh!

mendell27 commented Sep 7, 2022 •

edited

Loading

mendell27 commented Sep 8, 2022 •

edited

Loading