Rendering toolkit embree code sample PR #710

MichaelRoyceCarroll · 2021-10-18T22:25:02Z

Adding a New Sample(s)

Description

New sample PR for oneapi rendering toolkit embree sample. (library #2 of 4)
See #697

Checklist

Administrative

Review sample design with the appropriate Domain Expert:
If you have any new dependencies/binaries, inform the oneAPI Code Samples Project Manager: @JoeOster

Code Development

Implement coding guidelines and ensure code quality. see wiki for details
Adhere to readme template
Enforce format via clang-format config file
Adhere to sample.json specification. https://github.com/oneapi-src/oneAPI-samples/wiki/sample-json-specification
Ensure/create CI test configurations for sample (ciTests field) https://github.com/oneapi-src/oneAPI-samples/wiki/sample-json-ci-test-object
Run jsonlint on sample.json to verify json syntax. www.jsonlint.com

Security and Legal

OSPDT Approval (see @JoeOster for assistance)
Compile using the following compiler flags and fix any warnings, the falgs are: "/Wall -Wformat-security -Werror=format-security"
Bandit Scans (Python only)
Virus scan

Review

Review DPC++ code with Paul Peterseon. (GitHub User: pmpeter1)
Review readme with Tom Lenth(@tomlenth) and/or Joe Oster(@JoeOster)
Tested using Dev Cloud when applicable

* Update Makefile * Update Makefile * Update Makefile * Update DCT.hpp * Update intrin_ftz_sample.cpp * Update merge_sort.cpp * Update intrin_double_sample.cpp * Update intrin_dot_sample.cpp * Update DCT.cpp

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

…ed commit) Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Moving README.md content to individual folders

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

…roll/oneAPI-samples into RenderingToolkit

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

…get stuck. It is not too big. Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123

Approve for CI purposes only

praveenkk123 · 2021-10-18T23:08:20Z

Hi Michael,
I see that you submitted to master branch. Can you please submit to the development branch. Please do the same for other three PRs too

Thanks
Praveen

JoeOster · 2021-10-19T15:15:17Z

DirectProgramming/C++/CompilerInfrastructure/Intrinsics/Makefile

-# NOT LIMITED TO ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-# PURPOSE, NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS.
-#
-# =============================================================
 CC = icc


Three of the 4 PR's recently entered show the license header being removed. Once we start merging these, conflicts will probably start appearing. The License headers should only be removed in one PR

Hi Joe thanks for the feedback... I think I may have some issues because my fork was from master and the merge request is to devel? I'm not sure why/how this file could be touched. Can you provide any suggestions around this... Should I merge devel into my local branch and push again?

Thanks

DirectProgramming/ content should not be touched as part of any diff I create

@JoeOster @praveenkk123 I believe I was able to align all 4 PR branches with the upstream development branch. Hopefully this one is no longer an issue. The tag now says outdated.

JoeOster · 2021-10-19T15:19:44Z

Libraries/oneMKL/black_scholes/code_wrapper.tpp

@@ -0,0 +1,28 @@
+//==============================================================


Is this tpp file unique to this project or is it from another source? If unique, remove the license header from the file, if not what project is it from? include url

Hi Joe... thanks... I think this is in the same bucket of issues related to devel.

I think I may have some issues because my fork was from master and the merge request is to devel? I'm not sure why/how this file could be touched. Can you provide any suggestions around this... Should I merge devel into my local branch and push again?

Thanks

Libraries/ content should not be touched as part of any diff I create

Hi Michael, yes there are some conflicts in your PRs. Please fetch the latest from development branch , update your code and submit to the development branch again. I see lots of conflicting files that are not relavant to your project

@JoeOster @praveenkk123 I believe I was able to align all 4 PR branches with the upstream development branch. Hopefully this one is no longer an issue. The tag now says outdated.

JoeOster · 2021-10-19T15:22:38Z

RenderingToolkit/02_embree_gsg/README.md

@@ -0,0 +1,79 @@
+# Getting Started Sample for Intel oneAPI Rendering Toolkit: Intel Embree


This readme, needs to follow the oneAPI format for readme's. See the mandlebrot readme as an example

README.md's have been update for this PR and all 4x PRs to better match mandlebrot.

JoeOster · 2021-10-19T16:38:43Z

OSPDT Approved per OSPDT-1015 * All Apache Licensed libraries distributed as part of oneAPI have been approved

Embree is part of the oneAPI Rendering Toolkit

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

…json Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

…een removed Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123

Approve for CI purposes only

…I and public build Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123

Approve for CI

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123

Approve for CI

praveenkk123

Approve for CI

MichaelRoyceCarroll · 2021-10-28T00:36:56Z

@Yury-B Same question here as in PR #713... is CMake available? If not, can it be available?

MichaelRoyceCarroll · 2021-10-28T18:16:59Z

@Yury-B Do you have any recommendations on env variables for oneAPI and rpath? Are they being sourced for this build? Any speculation would be appreciated... I forsee a lot of trial and error here to find a good solution.

If @rpath will search DYLD_LIBRARY_PATH, and DYLD_LIBRARY_PATH is set via oneAPI environment variables... I'm scratching my head trying to follow why this lib isn't loading... I think there are a few options to "hard code" to rpath... but I don't think we want that... We want @rpath to resolve from source /opt/intel/oneapi/setvars.sh env vars (DYLD_LIBRARY_PATH).

Ref: https://gitlab.kitware.com/cmake/community/-/wikis/doc/cmake/RPATH-handling

It almost makes me think oneapi env vars are not available in this environment.

I should make the ONEAPI_ROOT message more robust with an indicator "dynamically determined" or "default strings" which I have included. Maybe we push on the rpath at build time iff env vars are not detected...

It's possible libembree3.3.dylib is built incorrectly or built to allow client programs to resolve through DYLD_LIBRARY_PATH. There are pluses and minuses to both approaches with tbb. I'm going to try some experiments and run it by Rudy.

-MichaelC

MichaelRoyceCarroll · 2021-10-28T18:17:29Z

@Yury-B Same question here as in PR #713... is CMake available? If not, can it be available?

This looks like it was resolved.

Yury-B · 2021-10-28T19:17:06Z

If @rpath will search DYLD_LIBRARY_PATH, and DYLD_LIBRARY_PATH is set via oneAPI environment variables... I'm scratching my head trying to follow why this lib isn't loading... I think there are a few options to "hard code" to rpath... but I don't think we want that... We want @rpath to resolve from source /opt/intel/oneapi/setvars.sh env vars (DYLD_LIBRARY_PATH).

you can't rely on DYLD_LIBRARY_PATH, because of
https://developer.apple.com/library/archive/documentation/Security/Conceptual/System_Integrity_Protection_Guide/RuntimeProtections/RuntimeProtections.html

MichaelRoyceCarroll · 2021-10-28T20:22:51Z

If @rpath will search DYLD_LIBRARY_PATH, and DYLD_LIBRARY_PATH is set via oneAPI environment variables... I'm scratching my head trying to follow why this lib isn't loading... I think there are a few options to "hard code" to rpath... but I don't think we want that... We want @rpath to resolve from source /opt/intel/oneapi/setvars.sh env vars (DYLD_LIBRARY_PATH).

you can't rely on DYLD_LIBRARY_PATH, because of https://developer.apple.com/library/archive/documentation/Security/Conceptual/System_Integrity_Protection_Guide/RuntimeProtections/RuntimeProtections.html

@Yury-B Thanks I'm glad I asked this is really insightful. Is the implication that the env DYLD_LIBRARY_PATH purge occurs here due to the CI wrapper? This makes me want to bake paths for CI sample.json steps after build using otool/install_name_tool Ref: https://medium.com/@donblas/fun-with-rpath-otool-and-install-name-tool-e3e41ae86172

Or maybe I should just call the env script again in the sample.json test steps?

-MichaelC

Yury-B · 2021-10-28T20:41:56Z

Or maybe I should just call the env script again in the sample.json test steps?

why don't you check compiler implementation?
e.g. /oneAPI-samples/DirectProgramming/C++/GraphTraversal/MergesortOMP
see makefile and json config.
i think common look and feel is ok for samples.

MichaelRoyceCarroll · 2021-10-28T22:10:10Z

Or maybe I should just call the env script again in the sample.json test steps?

why don't you check compiler implementation? e.g. /oneAPI-samples/DirectProgramming/C++/GraphTraversal/MergesortOMP see makefile and json config. i think common look and feel is ok for samples.

I updated it to be similar for this PR... Can we check it again?

Yury-B · 2021-10-29T09:25:09Z

excellent, now it's green!

praveenkk123

Approve for CI

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123

Approve for CI

* ONSAM-1414 Broken Link in Headers (#685) * Update Makefile * Update Makefile * Update Makefile * Update DCT.hpp * Update intrin_ftz_sample.cpp * Update merge_sort.cpp * Update intrin_double_sample.cpp * Update intrin_dot_sample.cpp * Update DCT.cpp * fix deprecation notice (#682) * initial commit for RenderingToolkit GSG sample proposal * signed inital commit for RenderingToolkit GSG intro samples Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Added generated GUIDS to .repo-tools/Docs_Automation/guids.json (signed commit) Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Update README.md Moving README.md content to individual folders * Order samples folders Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Update README.md * Adding per sample component README.md files Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Update README.md * Adding percomponent LICENSE placeholder files (to be reviewed) Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Adding converted .pfm input file. This file could help users if they get stuck. It is not too big. Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Updating sample.json files per Joseph Oster guidance Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Updates to oidn README.md for linux and macos Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Update README for library requirements Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * New branch for just embree sample Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Add description to base README.md Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * removing overlapping content. overlap to RenderingToolkit-ospray branch Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Updates for embree README.md Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Updates for the embree README.md (editorial) Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * clang-format for source Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Escape extra quotes for CI and get the correct minimal.exe in sample.json Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Should be no Release folder for sample.json on macos or lin. It has been removed Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Escape for accurate exe invoke Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Updates for CMakeLists.txt and sample.json to be more adaptable for CI and public build Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Update some errors in embree README.md Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Moving file heirarchy to RenderingToolkit/GettingStarted Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * CMakeLists change for variable consistency Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> * Update sample.json * Update sample.json for DYLD_LIBRARY_PATH CI workaround * CMakeLists health updates Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu> Co-authored-by: JoeOster <52936608+JoeOster@users.noreply.github.com> Co-authored-by: ericlars <eric.larson@intel.com>

JoeOster and others added 18 commits September 29, 2021 09:45

ONSAM-1414 Broken Link in Headers (oneapi-src#685)

8e0bdb3

* Update Makefile * Update Makefile * Update Makefile * Update DCT.hpp * Update intrin_ftz_sample.cpp * Update merge_sort.cpp * Update intrin_double_sample.cpp * Update intrin_dot_sample.cpp * Update DCT.cpp

fix deprecation notice (oneapi-src#682)

4bed52e

initial commit for RenderingToolkit GSG sample proposal

b23d63a

signed inital commit for RenderingToolkit GSG intro samples

f0a1b50

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Added generated GUIDS to .repo-tools/Docs_Automation/guids.json (sign…

9fa62ea

…ed commit) Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Update README.md

be21e94

Moving README.md content to individual folders

Order samples folders

78b2bff

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Update README.md

8990739

Adding per sample component README.md files

fb7dcf2

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Merge branch 'RenderingToolkit' of https://github.com/MichaelRoyceCar…

002b232

…roll/oneAPI-samples into RenderingToolkit

Update README.md

d85d358

Adding percomponent LICENSE placeholder files (to be reviewed)

507eb04

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Adding converted .pfm input file. This file could help users if they …

b738b26

…get stuck. It is not too big. Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Updating sample.json files per Joseph Oster guidance

5f91694

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Updates to oidn README.md for linux and macos

a3461c3

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Update README for library requirements

86c8200

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

New branch for just embree sample

96cda75

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Add description to base README.md

eadc649

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123 approved these changes Oct 18, 2021

View reviewed changes

JoeOster linked an issue Oct 18, 2021 that may be closed by this pull request

Request to Add a oneAPI Sample: Initial Rendering Toolkit sample #697

Closed

MichaelRoyceCarroll changed the base branch from master to development October 18, 2021 23:40

JoeOster requested changes Oct 19, 2021

View reviewed changes

JoeOster approved these changes Oct 19, 2021

View reviewed changes

JoeOster added the OSPDT Approved label Oct 19, 2021

MichaelRoyceCarroll added 4 commits October 19, 2021 15:02

Attempting to merge all .repo-tools/Docs_Automation/guids.json

6f4864d

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

removing overlapping content. overlap to RenderingToolkit-ospray branch

b371f4c

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Updates for embree README.md

b465ecc

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Updates for the embree README.md (editorial)

94c7332

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

MichaelRoyceCarroll added 4 commits October 21, 2021 15:04

clang-format for source

d2bdd18

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Escape extra quotes for CI and get the correct minimal.exe in sample.…

b1c2176

…json Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Should be no Release folder for sample.json on macos or lin. It has b…

f63bd1a

…een removed Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Escape for accurate exe invoke

9b00e52

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123 approved these changes Oct 22, 2021

View reviewed changes

Updates for CMakeLists.txt and sample.json to be more adaptable for C…

4a06d1c

…I and public build Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123 approved these changes Oct 25, 2021

View reviewed changes

MichaelRoyceCarroll added 3 commits October 26, 2021 14:25

Update some errors in embree README.md

234d639

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

Moving file heirarchy to RenderingToolkit/GettingStarted

7d11e26

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

CMakeLists change for variable consistency

471aba8

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123 approved these changes Oct 26, 2021

View reviewed changes

Update sample.json

1d78ae3

praveenkk123 approved these changes Oct 27, 2021

View reviewed changes

Update sample.json for DYLD_LIBRARY_PATH CI workaround

7702741

praveenkk123 requested a review from pmpeter1 October 28, 2021 23:13

praveenkk123 approved these changes Oct 29, 2021

View reviewed changes

CMakeLists health updates

31bbb36

Signed-off-by: Michael R Carroll <michael.carroll@alumni.usc.edu>

praveenkk123 approved these changes Nov 1, 2021

View reviewed changes

pmpeter1 approved these changes Nov 1, 2021

View reviewed changes

praveenkk123 merged commit eb52d7e into oneapi-src:development Nov 4, 2021

		@@ -0,0 +1,28 @@
		//==============================================================

		@@ -0,0 +1,79 @@
		# Getting Started Sample for Intel oneAPI Rendering Toolkit: Intel Embree

Rendering toolkit embree code sample PR #710

Rendering toolkit embree code sample PR #710

Uh oh!

Conversation

MichaelRoyceCarroll commented Oct 18, 2021

Adding a New Sample(s)

Description

Checklist

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

praveenkk123 commented Oct 18, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoeOster commented Oct 19, 2021

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

MichaelRoyceCarroll commented Oct 28, 2021

Uh oh!

MichaelRoyceCarroll commented Oct 28, 2021

Uh oh!

MichaelRoyceCarroll commented Oct 28, 2021

Uh oh!

Yury-B commented Oct 28, 2021

Uh oh!

MichaelRoyceCarroll commented Oct 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Yury-B commented Oct 28, 2021

Uh oh!

MichaelRoyceCarroll commented Oct 28, 2021

Uh oh!

Yury-B commented Oct 29, 2021

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

praveenkk123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MichaelRoyceCarroll commented Oct 28, 2021 •

edited

Loading