Statically build the onnx runtime

[oovm]

I tried to build onnxruntime from source, but there's no onnxruntime.lib in artifacts.

All arartifacts are:

/d/models/static-onnx/target/Release/Release (master)
$ ll
total 5796557
-rwxr-xr-x    106496 14:58 custom_op_invalid_library.dll*
-rw-r--r--      1043 14:58 custom_op_invalid_library.exp
-rw-r--r--      2052 14:58 custom_op_invalid_library.lib
-rwxr-xr-x    218624 15:14 custom_op_library.dll*
-rw-r--r--      1160 15:14 custom_op_library.exp
-rw-r--r--      2204 15:14 custom_op_library.lib
-rw-r--r--         0 20:55 libonnxruntime_common.a
-rw-r--r--   7936040 15:13 onnx_test_data_proto.lib
-rwxr-xr-x  12283904 15:21 onnx_test_runner.exe*
-rw-r--r--  59764458 15:14 onnx_test_runner_common.lib
-rw-r--r--  43092120 15:14 onnxruntime_common.lib
-rw-r--r--   9176984 15:14 onnxruntime_flatbuffers.lib
-rw-r--r-- 714289176 15:14 onnxruntime_framework.lib
-rw-r--r-- 271686414 15:13 onnxruntime_graph.lib
-rw-r--r--  60823470 15:15 onnxruntime_mlas.lib
-rwxr-xr-x   1757696 15:15 onnxruntime_mlas_test.exe*
-rw-r--r-- 966718364 15:15 onnxruntime_optimizer.lib
-rwxr-xr-x  12248576 15:20 onnxruntime_perf_test.exe*
-rw-r--r--   1049089 15:17 onnxruntime_providers.lib
-rwxr-xr-x 261312512 15:13 onnxruntime_providers_cuda.dll*
-rw-r--r--       913 15:13 onnxruntime_providers_cuda.exp
-rw-r--r--      2038 15:13 onnxruntime_providers_cuda.lib
-rwxr-xr-x    107520 14:58 onnxruntime_providers_shared.dll*
-rw-r--r--      1059 14:58 onnxruntime_providers_shared.exp
-rw-r--r--      2314 14:58 onnxruntime_providers_shared.lib
-rwxr-xr-x   2416640 15:12 onnxruntime_providers_tensorrt.dll*
-rw-r--r--       925 15:11 onnxruntime_providers_tensorrt.exp
-rw-r--r--      2090 15:11 onnxruntime_providers_tensorrt.lib
-rw-r--r-- 237943372 15:14 onnxruntime_session.lib
-rwxr-xr-x  30826496 15:27 onnxruntime_test_all.exe*
-rw-r--r--     88620 15:15 onnxruntime_test_cuda_ops_lib.lib
-rw-r--r--  66842804 15:14 onnxruntime_test_utils.lib
-rw-r--r--  36793882 15:14 onnxruntime_util.lib
-rw-r--r--        65 14:57 requirements.txt
drwxr-xr-x         0 15:17 samples/
-rwxr-xr-x    348672 15:12 test_execution_provider.dll*
-rw-r--r--      1058 15:12 test_execution_provider.exp
-rw-r--r--      2218 15:12 test_execution_provider.lib
drwxr-xr-x         0 15:17 testdata/
-rw-r--r--    108898 15:14 win_getopt_wide.lib

When set

ORT_STRATEGY = "system"
# artifacts path
ORT_LIB_LOCATION = "D:\\models\\static-onnx\\target\\Release\\Release"

ort build failed because

error: linking with `link.exe` failed: exit code: 1181
  |
  = note: "C:\\Program Files\\Microsoft Visual tudio\\2022\\Community\\VC\\Tools\\MSVC\\14.35.32215\\bin\\HostX64\\x64\\link.exe" 
  = note: LINK : fatal error LNK1181:  can not open input file “onnxruntime.lib”

Reference

• How to build and use onnxruntime static lib on windows?  microsoft/onnxruntime#1472 (comment)

[decahedron1]

Could you try making an empty file libonnxruntime_common.a in the build directory? I never updated static linking to work with Windows (though with the empty file it will work) - here it checks for libonnxruntime_common.a before trying to static link; needs_link will be true if the file does not exist, leading to here where it tries to link to onnxruntime.lib, giving the error.

[oovm]

Hack works, but missing protobuf

error: could not find native static library `protobuf-lited`, perhaps an -L flag is missing?

since full protobuf option on, it may conflict with lited.

• https://github.com/microsoft/onnxruntime/blob/0fa00429d561fcdea5330ebe817c69d52b2ad6fb/tools/ci_build/build.py#L1098-L1100

• https://github.com/microsoft/onnxruntime/blob/0fa00429d561fcdea5330ebe817c69d52b2ad6fb/tools/ci_build/build.py#L1018-L1025

[decahedron1]

Could you please list the files in D:\\models\\static-onnx\\target\\Release\\Release\\_deps\\protobuf-build

[oovm]

/d/models/static-onnx/target/Release/_deps/protobuf-build (master)
$ ll
total 431
-rw-r--r-- 21813 14:58 ALL_BUILD.vcxproj
-rw-r--r--   316 14:58 ALL_BUILD.vcxproj.filters
drwxr-xr-x     0 14:59 CMakeFiles/
-rw-r--r--   337 14:58 CTestTestfile.cmake
-rw-r--r-- 10561 14:58 INSTALL.vcxproj
-rw-r--r--   527 14:58 INSTALL.vcxproj.filters
-rw-r--r-- 10904 14:58 PACKAGE.vcxproj
-rw-r--r--   527 14:58 PACKAGE.vcxproj.filters
-rw-r--r--  9995 14:58 RUN_TESTS.vcxproj
-rw-r--r--   529 14:58 RUN_TESTS.vcxproj.filters
drwxr-xr-x     0 14:59 Release/
drwxr-xr-x     0 14:58 cmake/
-rw-r--r-- 53578 14:58 cmake_install.cmake
-rw-r--r-- 20579 14:55 extract_includes.bat
-rw-r--r-- 47061 14:58 libprotobuf-lite.vcxproj
-rw-r--r-- 15127 14:58 libprotobuf-lite.vcxproj.filters
drwxr-xr-x     0 14:58 libprotobuf.dir/
-rw-r--r-- 52941 14:58 libprotobuf.vcxproj
-rw-r--r-- 23434 14:58 libprotobuf.vcxproj.filters
drwxr-xr-x     0 14:58 libprotoc.dir/
-rw-r--r-- 54166 14:58 libprotoc.vcxproj
-rw-r--r-- 23859 14:58 libprotoc.vcxproj.filters
-rw-r--r--   343 14:55 protobuf-lite.pc
-rw-r--r--   343 14:55 protobuf.pc
-rw-r--r--  9911 14:58 protobuf.sln
drwxr-xr-x     0 14:59 protoc.dir/
-rw-r--r-- 41960 14:58 protoc.vcxproj
-rw-r--r--   851 14:58 protoc.vcxproj.filters
-rw-r--r--  1372 14:55 version.rc

/d/models/static-onnx/target/Release/_deps (master)
$ ll
total 196
14:58 abseil_cpp-build/
14:54 abseil_cpp-src/
14:54 abseil_cpp-subbuild/
14:57 cutlass-build/
14:58 cutlass-src/
14:57 cutlass-subbuild/
14:58 date-build/
14:54 date-src/
14:54 date-subbuild/
14:56 eigen-build/
14:57 eigen-src/
14:57 eigen-subbuild/
15:13 flatbuffers-build/
14:56 flatbuffers-src/
14:56 flatbuffers-subbuild/
14:58 googletest-build/
14:56 googletest-src/
14:56 googletest-subbuild/
14:58 gsl-build/
14:56 gsl-src/
14:56 gsl-subbuild/
14:57 microsoft_wil-build/
14:57 microsoft_wil-src/
14:57 microsoft_wil-subbuild/
14:58 mp11-build/
14:55 mp11-src/
14:55 mp11-subbuild/
14:58 nlohmann_json-build/
14:55 nlohmann_json-src/
14:55 nlohmann_json-subbuild/
14:59 onnx-build/
14:57 onnx-src/
14:57 onnx-subbuild/
14:59 onnx_tensorrt-build/
14:58 onnx_tensorrt-src/
14:58 onnx_tensorrt-subbuild/
14:59 protobuf-build/
14:55 protobuf-src/
14:54 protobuf-subbuild/
15:13 pytorch_cpuinfo-build/
14:56 pytorch_cpuinfo-src/
14:56 pytorch_cpuinfo-subbuild/
15:14 re2-build/
14:56 re2-src/
14:56 re2-subbuild/
14:58 safeint-build/
14:56 safeint-src/
14:56 safeint-subbuild/

build script

export CudaToolkitCustomDir="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.6"
python3 ./onnxruntime/tools/ci_build/build.py \
  --cmake_generator "Visual Studio 17 2022" \
  --build_dir ./target/ \
  --config Release \
  --parallel 8 \
  --use_cuda \
  --use_tensorrt \
  --cuda_version 11.6 \
  --cuda_home "C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.6" \
  --cudnn_home "D:\models\static-onnx\CUDNN-8.8.1.3" \
  --tensorrt_home "D:/models/static-onnx/TensorRT-8.5.3.1" \
  --enable_lto \
  --enable_msvc_static_runtime \
  --skip_tests \
  --skip_submodule_sync

[decahedron1]

d9dff01 should fix this now

[oovm]

@sudo-carson This problem still exists, I found that the cmake I use will have an extra layer of /Release directory.

I am using the cmake built in Visual Studio 17 2022.

let path = "D:\\models\\static-onnx\\target\\Release"

lib name	path.join()
onnxruntime_*	Release
protobuf.lib	_deps\protobuf-build\Release
nsync_cpp.lib	no such file
cpuinfo.lib	_deps\pytorch_cpuinfo-build\Release
clog.lib	_deps\pytorch_cpuinfo-build\Release
re2.lib	_deps\re2-build\Release
absl*.lib	_deps\abseil_cpp-build\absl\base\Release

I didn't find this problem before, because there was no error, and nothing found when linking.

We can change line 336 to expose the problem:

		let external_lib_dir = lib_dir.join("_deps")
		let external_lib_dir = lib_dir.join("_deps").canonicalize().expect("`/_deps/` not found");

[decahedron1]

ccd3cbc verified to link and run with --config Release on Windows. I have not tested it with CUDA, just MLAS. If you get linking errors with CUDA please let me know, but it should be easily fixable by adding println!("cargo:rustc-link-lib=onnxruntime_providers_cuda"); around line 399 in build.rs.

[mush42]

@sudo-carson would you mind providing the steps required to statically link onnxruntime in the final artifact?

[decahedron1]

Sure, my build process for Windows looked something like this:

# in onnxruntime source
./build.bat --update --build --config Release

# in rust project
$env:ORT_LIB_LOCATION = 'E:\path\to\onnxruntime\build\Windows\Release';
$env:ORT_STRATEGY = 'system';
cargo build --release

[mush42]

@sudo-carson following the steps you outlined, it gives me the following error:

error: failed to run custom build command for `ort v1.14.1 (https://github.com/pykeio/ort?rev=f6135fcb1134e20a8375afb9166f5f7222137a67#f6135fcb)`

Caused by:
  process didn't exit successfully: `D:\projects\blindpandas\libtashkeel\target\release\build\ort-de3f866f31dff3c0\build-script-build` (exit code: 101)
  --- stdout
  [ort] strategy: "system"
  cargo:rerun-if-env-changed=ORT_STRATEGY

  --- stderr
  thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 3, kind: NotFound, message: "The system cannot find the path specified." }', C:\Users\ibnom\.cargo\git\checkouts\ort-675c4f2a84c4db27\f6135fc\build.rs:286:43
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
warning: build failed, waiting for other jobs to finish...

[decahedron1]

Disable the copy-dylibs Cargo feature for now, I'll push a proper fix in an hour