Free functions for texturing, point clouds, and trace #1852

curtisblack · 2024-08-23T00:50:04Z

Description

Provides free function API for:

rs_texture
rs_texture3d
rs_environment
rs_get_texture_info
rs_get_texture_info_st
rs_pointcloud_search
rs_pointcloud_get
rs_pointcloud_write
rs_trace

Each of these match the existing signatures of the renderer services equivalents. A new function rs_trace_get is added to retrieve trace results and is intended to replace getmessage("trace", ...) which is currently not available on GPUs.

The fallback for each of these is to call the existing renderer services functions.

To achieve this, the helper structs TextureOpt, TraceOpt, NoiseOpt are removed from the host-only shading context, and are instead added into the LLVM generated code as stack allocations. These allocations only occur if the shader uses these features.

To allow these free functions to compile on GPUs, the texture per-thread context pointer is currently passed null. Future work will be needed to give this a proper home.

To make the pointcloud functions GPU friendly, they had to modified to not use variadic arguments and to avoid dynamic alloca.

Tests

Checklist:

I have read the contribution guidelines.
I have updated the documentation, if applicable.
I have ensured that the change is tested somewhere in the testsuite (adding new test cases if necessary).
My code follows the prevailing code style of this project. If I haven't
already run clang-format v17 before submitting, I definitely will look at
the CI test that runs clang-format and fix anything that it highlights as
being nonconforming.

Signed-off-by: Curtis Black <[email protected]>

src/liboslexec/llvm_instance.cpp

src/liboslexec/optexture.cpp

Signed-off-by: Curtis Black <[email protected]>

lgritz · 2024-09-18T23:01:52Z

@curtisblack Can you please resolve the merge conflict so we can run the CI?

Signed-off-by: Curtis Black <[email protected]>

AlexMWells · 2024-10-01T23:19:33Z

src/testshade/rs_simplerend.cpp

+           float dsdy, float dtdy, int nchannels, float* result,
+           float* dresultds, float* dresultdt, OSL::ustringhash* errormessage)
+{
+#ifndef __CUDA_ARCH__


Can we use OSL_HOST_RS_BITCODE macro to wrap casts to ShaderGlobals and accesss to RendererServices only happen on host bitcode.

AlexMWells · 2024-10-01T23:21:26Z

src/liboslexec/pointcloud.cpp

 {
+#ifndef __CUDA_ARCH__
+    ShaderGlobals* sg = (ShaderGlobals*)oec;


can we use get_sg(oec), means duplicating or moving get_sg.

AlexMWells · 2024-10-01T23:50:38Z

src/liboslexec/pointcloud.cpp

 {
+#ifndef __CUDA_ARCH__
+    ShaderGlobals* sg = (ShaderGlobals*)oec;
    ShadingSystemImpl& shadingsys(sg->context->shadingsys());
    if (shadingsys.no_pointcloud())  // Debug mode to skip pointcloud expense
        return 0;


Does anyone need/use the no_pointcloud option?
We could support it via the ShadingStateUniform, but don't want to if there are no use cases for it.

AlexMWells · 2024-10-02T00:19:49Z

src/liboslexec/pointcloud.cpp

@@ -379,89 +393,76 @@ RendererServices::pointcloud_write(ShaderGlobals* /*sg*/, ustringhash filename,

 namespace pvt {



Extract osl_point_* to oppointcould.cpp so bitcode compilation doesn't need to see the implementation above.

AlexMWells · 2024-10-02T00:46:00Z

src/testshade/rs_simplerend.cpp

+#ifndef __CUDA_ARCH__
+    auto sg = (OSL::ShaderGlobals*)ec;
+    return sg->renderer->texture(filename, texture_handle, texture_thread_info,
+                                 options, sg, s, t, dsdx, dtdx, dsdy, dtdy,


Let's not have a customization point call a customization point, instead lets take the default implementation of RendererServices::texture that utilizes a texuresys() and put it here as example for host (or device when OIIO texture sys free functions are fully available).

AlexMWells · 2024-10-02T00:49:55Z

@lgritz lets go ahead and get his merged. We have some cleanup ideas, but it all builds on top of this and CI is green!

AlexMWells

LGTM

…#1852 Signed-off-by: Larry Gritz <[email protected]>

The recent free function change (#1852) put the OptiX paths in testrender and testshade in a non-working state (issue #1894). The bitcode for the free functions wasn't plumbed through for OptiX. This PR rolls the free function definitions into the existing "rendlib" bitcode and PTX. This is somewhat of a stopgap fix; eventually we'll want to handle the free function more explicitly. Fixes #1894 Signed-off-by: Tim Grant <[email protected]>

curtisblack added 30 commits August 23, 2024 10:33

Free functions for texturing, point clouds, and trace

b847fc6

Signed-off-by: Curtis Black <[email protected]>

fix formatting

b531d4c

Signed-off-by: Curtis Black <[email protected]>

Fix formatting

ec27f00

Signed-off-by: Curtis Black <[email protected]>

Fix typo

139df54

Signed-off-by: Curtis Black <[email protected]>

Fix typo

02f50ba

Signed-off-by: Curtis Black <[email protected]>

Fix typo

f38b85c

Signed-off-by: Curtis Black <[email protected]>

Fix formatting

529bf2d

Signed-off-by: Curtis Black <[email protected]>

Match function signatures.

9f2fbb8

Signed-off-by: Curtis Black <[email protected]>

Fix formatting

1b1ffc1

Signed-off-by: Curtis Black <[email protected]>

Fix typo

1f28de8

Signed-off-by: Curtis Black <[email protected]>

Add const

d77fb21

Signed-off-by: Curtis Black <[email protected]>

Match function signatures.

90bb7e2

Signed-off-by: Curtis Black <[email protected]>

Fix formatting

37b1903

Signed-off-by: Curtis Black <[email protected]>

Guard CPU only code.

c4ee98d

Signed-off-by: Curtis Black <[email protected]>

Fix typo

26f5fe1

Signed-off-by: Curtis Black <[email protected]>

Guard CPU only code.

e82a6d9

Signed-off-by: Curtis Black <[email protected]>

Fix formatting

788cf68

Signed-off-by: Curtis Black <[email protected]>

Guard CPU only code.

645622c

Signed-off-by: Curtis Black <[email protected]>

Fix typo

b23ff35

Signed-off-by: Curtis Black <[email protected]>

Fix typo

3e9e67d

Signed-off-by: Curtis Black <[email protected]>

Add GPU compatibility

5742138

Signed-off-by: Curtis Black <[email protected]>

Match function signatures.

369fcef

Signed-off-by: Curtis Black <[email protected]>

Match function signatures.

a9e79bb

Signed-off-by: Curtis Black <[email protected]>

Match function signatures.

e36170c

Signed-off-by: Curtis Black <[email protected]>

Add host/device markers.

1be773d

Signed-off-by: Curtis Black <[email protected]>

Replace va_args with alloca.

3198006

Signed-off-by: Curtis Black <[email protected]>

Fix indexing.

56153f2

Signed-off-by: Curtis Black <[email protected]>

Replace CUDACC with CUDA_ARCH.

36799d9

Signed-off-by: Curtis Black <[email protected]>

Add testshade fallback functions.

37cbf11

Signed-off-by: Curtis Black <[email protected]>

Fix formatting

b8eed2d

Signed-off-by: Curtis Black <[email protected]>

AlexMWells reviewed Sep 3, 2024

View reviewed changes

src/liboslexec/llvm_instance.cpp Show resolved Hide resolved

AlexMWells reviewed Sep 3, 2024

View reviewed changes

src/liboslexec/optexture.cpp Show resolved Hide resolved

AlexMWells reviewed Sep 4, 2024

View reviewed changes

src/liboslexec/optexture.cpp Show resolved Hide resolved

curtisblack added 10 commits September 6, 2024 10:27

Fix uninitialized member.

6c55e67

Signed-off-by: Curtis Black <[email protected]>

Add rs_trace_get function to replace getmessage('trace',...).

05464fa

Signed-off-by: Curtis Black <[email protected]>

Use ustringhash_pod instead of void*.

1d7c8fe

Signed-off-by: Curtis Black <[email protected]>

Fix typos.

b87e74f

Signed-off-by: Curtis Black <[email protected]>

Fix formatting.

d5c33de

Signed-off-by: Curtis Black <[email protected]>

Disable pointcloud stats.

bcb7bfd

Signed-off-by: Curtis Black <[email protected]>

Make pointcloud stats atomic.

2f19026

Signed-off-by: Curtis Black <[email protected]>

Use OIIO namespace.

d353250

Signed-off-by: Curtis Black <[email protected]>

Change pointcloud index type to int.

1d50aed

Signed-off-by: Curtis Black <[email protected]>

Fix formatting.

d16e513

Signed-off-by: Curtis Black <[email protected]>

curtisblack added 3 commits September 20, 2024 09:30

Cleanup.

86c70f7

Signed-off-by: Curtis Black <[email protected]>

Merge branch 'main' into texture_free_function

158a220

Signed-off-by: Curtis Black <[email protected]>

Address PR feedback.

f573587

Signed-off-by: Curtis Black <[email protected]>

AlexMWells reviewed Oct 1, 2024

View reviewed changes

AlexMWells reviewed Oct 2, 2024

View reviewed changes

AlexMWells approved these changes Oct 2, 2024

View reviewed changes

lgritz merged commit 48c0b16 into AcademySoftwareFoundation:main Oct 8, 2024
21 of 22 checks passed

lgritz added a commit to lgritz/OpenShadingLanguage that referenced this pull request Oct 11, 2024

Admin: Bump version after ABI changes of PR AcademySoftwareFoundation…

fabc3fb

…#1852 Signed-off-by: Larry Gritz <[email protected]>

This was referenced Oct 28, 2024

Free functions are broken on the OptiX path #1894

Closed

Fix the OptiX path in testrender and testshade #1896

Merged

lgritz mentioned this pull request Feb 27, 2025

Re-remove device decoration from some osl_ functions #1951

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Free functions for texturing, point clouds, and trace #1852

Free functions for texturing, point clouds, and trace #1852

curtisblack commented Aug 23, 2024 •

edited

Loading

lgritz commented Sep 18, 2024

AlexMWells Oct 1, 2024 •

edited

Loading

AlexMWells Oct 1, 2024

AlexMWells Oct 1, 2024

AlexMWells Oct 2, 2024

AlexMWells Oct 2, 2024

AlexMWells commented Oct 2, 2024

AlexMWells left a comment

		@@ -379,89 +393,76 @@ RendererServices::pointcloud_write(ShaderGlobals* /sg/, ustringhash filename,

		namespace pvt {

Free functions for texturing, point clouds, and trace #1852

Free functions for texturing, point clouds, and trace #1852

Conversation

curtisblack commented Aug 23, 2024 • edited Loading

Description

Tests

Checklist:

lgritz commented Sep 18, 2024

AlexMWells Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

AlexMWells Oct 1, 2024

Choose a reason for hiding this comment

AlexMWells Oct 1, 2024

Choose a reason for hiding this comment

AlexMWells Oct 2, 2024

Choose a reason for hiding this comment

AlexMWells Oct 2, 2024

Choose a reason for hiding this comment

AlexMWells commented Oct 2, 2024

AlexMWells left a comment

Choose a reason for hiding this comment

curtisblack commented Aug 23, 2024 •

edited

Loading

AlexMWells Oct 1, 2024 •

edited

Loading