Cycles: Make OSL shader compilation threadsafe and multi-threaded #130133

Open
Lukas Stockner wants to merge 2 commits from LukasStockner/blender:threadsafe-osl into main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Member

The original OSL Shading System API was stateful: You'd create a shader group, configure it, and then end it. However, this means that only one group can be created at a time. Further, since Cycles reuses the Shading System for multiple instances (e.g. viewport render and material preview), a process-wide mutex is needed.

However, for years now OSL has had a better interface, where you explicitly provide the group you refer to. With this, we can not only get rid of the mutex, but actually multi-thread the shader setup even within one instance.

Realistically, most time is still spent in the JIT stage, but it's still better than nothing.

The original OSL Shading System API was stateful: You'd create a shader group, configure it, and then end it. However, this means that only one group can be created at a time. Further, since Cycles reuses the Shading System for multiple instances (e.g. viewport render and material preview), a process-wide mutex is needed. However, for years now OSL has had a better interface, where you explicitly provide the group you refer to. With this, we can not only get rid of the mutex, but actually multi-thread the shader setup even within one instance. Realistically, most time is still spent in the JIT stage, but it's still better than nothing.
Lukas Stockner added 2 commits 2024-11-11 15:26:54 +01:00
Compile OSL shaders multithreaded
All checks were successful
buildbot/vexp-code-patch-lint Build done.
buildbot/vexp-code-patch-linux-x86_64 Build done.
buildbot/vexp-code-patch-darwin-arm64 Build done.
buildbot/vexp-code-patch-darwin-x86_64 Build done.
buildbot/vexp-code-patch-windows-amd64 Build done.
buildbot/vexp-code-patch-coordinator Build done.
d2014ecc82
Lukas Stockner added this to the Render & Cycles project 2024-11-11 15:26:59 +01:00
Lukas Stockner requested review from Sergey Sharybin 2024-11-11 15:27:13 +01:00
Lukas Stockner requested review from Weizhen Huang 2024-11-11 15:27:13 +01:00
Author
Member

@blender-bot build

@blender-bot build
Sergey Sharybin reviewed 2024-11-12 12:20:32 +01:00
@ -1245,2 +1263,3 @@
ss->ShaderGroupEnd(*current_group);
return group;
return std::move(current_group);

Don't use std::move in return. Compilers should actually warn about, but I didn't double-check it in Blender/Cycles code :)

Some details https://devblogs.microsoft.com/oldnewthing/20231124-00/?p=109059

Don't use `std::move` in `return`. Compilers should actually warn about, but I didn't double-check it in Blender/Cycles code :) Some details https://devblogs.microsoft.com/oldnewthing/20231124-00/?p=109059
Author
Member

current_group is a shared_ptr member variable of the OSL compiler here, my intention was to steal its reference and clear it in a single line.
Quite possible that I got it wrong though, I'll have a closer look later.

`current_group` is a `shared_ptr` member variable of the OSL compiler here, my intention was to steal its reference and clear it in a single line. Quite possible that I got it wrong though, I'll have a closer look later.
All checks were successful
buildbot/vexp-code-patch-lint Build done.
buildbot/vexp-code-patch-linux-x86_64 Build done.
buildbot/vexp-code-patch-darwin-arm64 Build done.
buildbot/vexp-code-patch-darwin-x86_64 Build done.
buildbot/vexp-code-patch-windows-amd64 Build done.
buildbot/vexp-code-patch-coordinator Build done.
Merge conflict checking is in progress. Try again in few moments.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u threadsafe-osl:LukasStockner-threadsafe-osl
git checkout LukasStockner-threadsafe-osl
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Code Documentation
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Viewport & EEVEE
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Module
Viewport & EEVEE
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Severity
High
Severity
Low
Severity
Normal
Severity
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#130133
No description provided.