ONNX Runtime: cross-platform, high performance ML inferencing and training accelerator
Find a file
Yulong Wang 8680244ebc
Fix delay load for WebGPU EP and DML EP (#23111)
### Description

This change fixes the DLL delay load problem for the WebGPU EP and
DirectML EP. See detailed explanation below.

### Problem

When onnxruntime.dll uses delay loading for its dependencies, the
dependencies are loaded using `LoadLibraryEx()`, which search the
directory of process (.exe) instead of this library (onnxruntime.dll).
This is a problem for usages of Node.js binding and python binding,
because Windows will try to find the dependencies in the directory of
node.exe or python.exe, which is not the directory of onnxruntime.dll.

There was previous attempt to fix this by loading DirectML.dll in the
initialization of onnxruntime nodejs binding, which works for DML EP but
is not a good solution because it does not really "delay" the load.

For WebGPU, the situation became worse because webgpu_dawn.dll depends
on dxil.dll and dxcompiler.dll, which are explicitly dynamically loaded
in the code using `LoadLibraryA()`. This has the same problem of the DLL
search.

### Solutions

For onnxruntime.dll loading its direct dependencies, it can be resolved
by set the [`__pfnDliNotifyHook2`
hook](https://learn.microsoft.com/en-us/cpp/build/reference/understanding-the-helper-function?view=msvc-170#structure-and-constant-definitions)
to load from an absolute path that constructed from the onnxruntime.dll
folder and the DLL name.

For webgpu_dawn.dll loading dxil.dll and dxcompiler.dll, since they are
explicitly loaded in the code, the hook does not work. Instead, it can
be resolved by ~~using WIN32 API `SetDllDirectory()` to add the
onnxruntime.dll folder to the search path.~~ preloading the 2 DLLs from
the onnxruntime.dll folder .
2024-12-19 10:23:48 -08:00
.config Auto-generated baselines by 1ES Pipeline Templates (#22817) 2024-11-13 13:50:52 -08:00
.devcontainer
.gdn
.github Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
.pipelines [DML EP] Update DML to 1.15.4 (#22635) 2024-10-29 17:13:57 -07:00
.vscode Stop VSCode appending file associations to settings.json (#21944) 2024-08-31 19:04:12 -07:00
cgmanifests Bump version of Dawn to 12a3b24c4 (#23002) 2024-12-04 09:47:16 -08:00
cmake Fix delay load for WebGPU EP and DML EP (#23111) 2024-12-19 10:23:48 -08:00
csharp [CoreML] Create EP by AppendExecutionProvider (#22675) 2024-11-27 09:26:31 +08:00
dockerfiles fix requirements.txt path (#22946) 2024-12-04 13:08:29 -08:00
docs Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
include/onnxruntime/core Fix a deadlock bug in EigenNonBlockingThreadPool.h (#23098) 2024-12-16 09:05:12 -08:00
java Revert DML pipeline changes (#23135) 2024-12-18 10:42:10 -08:00
js Fix delay load for WebGPU EP and DML EP (#23111) 2024-12-19 10:23:48 -08:00
objectivec Use UTF8 string encoding in ORTSaveCodeAndDescriptionToError(). (#22982) 2024-12-02 17:41:52 -08:00
onnxruntime Fix delay load for WebGPU EP and DML EP (#23111) 2024-12-19 10:23:48 -08:00
orttraining Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
rust Fix typos according to reviewdog report. (#21335) 2024-07-22 13:37:32 -07:00
samples
tools Fix delay load for WebGPU EP and DML EP (#23111) 2024-12-19 10:23:48 -08:00
winml Update Intel Thread Counts (#22894) 2024-12-06 13:56:50 -08:00
.clang-format
.clang-tidy
.dockerignore
.gitattributes Fix typos according to reviewdog report. (#21335) 2024-07-22 13:37:32 -07:00
.gitignore
.gitmodules Revert "Upgrade emsdk from 3.1.59 to 3.1.62" (#21817) 2024-08-22 11:21:00 -07:00
.lintrunner.toml Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
build.bat
build.sh
build_arm64x.bat
CITATION.cff
CODEOWNERS Update CODEOWNERS: remove onnxruntime-es (#21677) 2024-12-17 13:39:13 -08:00
CONTRIBUTING.md
CPPLINT.cfg Ignore all whitespace lint messages for cpplint (#22781) 2024-11-08 14:31:28 -08:00
lgtm.yml
LICENSE
NuGet.config Update C# test projects (#21631) 2024-09-05 08:21:23 +10:00
ort.wprp
ORT_icon_for_light_bg.png
packages.config [DML EP] Update DML to 1.15.4 (#22635) 2024-10-29 17:13:57 -07:00
pyproject.toml Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
README.md Update pipeline status (#22924) 2024-11-24 21:26:27 -08:00
requirements-dev.txt Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
requirements-doc.txt
requirements-lintrunner.txt Update lintrunner requirements (#22185) 2024-09-23 18:27:16 -07:00
requirements-training.txt
requirements.txt
SECURITY.md
setup.py Update python version metadata (remove 3.7, 3.8, 3.9; add 3.13). (#23067) 2024-12-17 10:59:20 -08:00
ThirdPartyNotices.txt Cleanup code (#22827) 2024-11-19 14:13:33 -08:00
VERSION_NUMBER bumps up version in main from 1.20 -> 1.21 (#22482) 2024-10-17 12:32:35 -07:00

ONNX Runtime is a cross-platform inference and training machine-learning accelerator.

ONNX Runtime inference can enable faster customer experiences and lower costs, supporting models from deep learning frameworks such as PyTorch and TensorFlow/Keras as well as classical machine learning libraries such as scikit-learn, LightGBM, XGBoost, etc. ONNX Runtime is compatible with different hardware, drivers, and operating systems, and provides optimal performance by leveraging hardware accelerators where applicable alongside graph optimizations and transforms. Learn more →

ONNX Runtime training can accelerate the model training time on multi-node NVIDIA GPUs for transformer models with a one-line addition for existing PyTorch training scripts. Learn more →

Get Started & Resources

Builtin Pipeline Status

System Inference Training
Windows Build Status
Build Status
Build Status
Build Status
Linux Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Mac Build Status
Android Build Status
iOS Build Status
Web Build Status
Other Build Status

This project is tested with BrowserStack.

Third-party Pipeline Status

System Inference Training
Linux Build Status

Releases

The current release and past releases can be found here: https://github.com/microsoft/onnxruntime/releases.

For details on the upcoming release, including release dates, announcements, features, and guidance on submitting feature requests, please visit the release roadmap: https://onnxruntime.ai/roadmap.

Data/Telemetry

Windows distributions of this project may collect usage data and send it to Microsoft to help improve our products and services. See the privacy statement for more details.

Contributions and Feedback

We welcome contributions! Please see the contribution guidelines.

For feature requests or bug reports, please file a GitHub Issue.

For general discussion or questions, please use GitHub Discussions.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

This project is licensed under the MIT License.