Windows x64 Build with support for xnnpack and llama example #6979

vortex-captain · 2024-11-20T06:23:13Z

Summary

This PR introduces support for out-of-the-box builds on Windows x64 with xnnpack, simplifying the setup process for developers using executorch on Windows. Additionally, it lays the groundwork for future Windows build pipelines and prebuilt PyPI packages.

Fixes #4661

Test plan

PR tested by running minimal executor_runner example (https://pytorch.org/executorch/stable/getting-started-setup.html#run-your-program) in the following environment:

Windows 11 x64
Visual Studio Enterprise 2022 with these components installed:
- C++ Clang tools for Windows
- MSBuild support for LLVM (clang-cl) toolset
- C++ CMake tools for Windows

Steps:

# run the following in command prompt
cd executorch/  # contains code of this PR
git pull
git submodule sync
git submodule update --init

./install_requirements.bat --pybind xnnpack
Remove-Item -Path "add.pte" -ErrorAction SilentlyContinue
python .\export_add.py  # export_add.py from https://pytorch.org/executorch/stable/getting-started-setup.html#export-a-program
msbuild pip-out\temp.win-amd64-cpython-310\cmake-out\executorch.sln /t:Rebuild
pip-out\temp.win-amd64-cpython-310\cmake-out\Debug\executor_runner.exe --model-path add.pte

References

#4681
#5252
#4899
#5164
#4993

pytorch-bot · 2024-11-20T06:23:17Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/6979

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 6 New Failures

As of commit 8e2b8bd with merge base 3475707 ():

NEW FAILURES - The following jobs have failed:

Lint / lintrunner / linux-job (gh)
>>> Lint for extension/llm/custom_ops/sdpa_with_kv_cache.py:
pull / android / build-llm-demo / linux-job (gh)
/pytorch/executorch/extension/android/../../../executorch/extension/llm/runner/util.h:47:3: error: use of undeclared identifier 'timespec_get'; did you mean 'timespec'?
pull / test-llama-runner-linux-android / linux-job (gh)
/pytorch/executorch/examples/models/llama/../../../../executorch/extension/llm/runner/util.h:47:3: error: use of undeclared identifier 'timespec_get'; did you mean 'timespec'?
pull / test-llava-runner-linux / linux-job (gh)
test_llava_export
pull / unittest / linux / linux-job (gh)
RuntimeError: Command docker exec -t 08767ca8700d09198dad0af3364e34166bdcc982f48709bd04a03f7ed450877e /exec failed with exit code 1
pull / unittest / macos / macos-job (gh)
RuntimeError: Command bash /Users/ec2-user/runner/_work/_temp/exec_script failed with exit code 1

This comment was automatically generated by Dr. CI and updates every 15 minutes.

- fix extension/data_loader/file_data_loader.cpp for Windows x64

pytorch-bot · 2024-11-21T02:27:46Z

❌ 🤖 pytorchbot command failed:

@pytorchbot: error: argument command: invalid choice: 'Release' (choose from 'merge', 'revert', 'rebase', 'label', 'drci', 'cherry-pick', 'close')

usage: @pytorchbot [-h] {merge,revert,rebase,label,drci,cherry-pick,close} ...

Try @pytorchbot --help for more info.

vortex-captain · 2024-11-21T02:28:42Z

@pytorchbot label "Release notes: build"

pytorch-bot · 2024-11-21T02:28:45Z

Didn't find following labels among repository labels: Release notes: build

vortex-captain · 2024-11-21T02:29:36Z

@pytorchbot label "release notes: build"

vortex-captain · 2024-11-21T04:38:38Z

Hi @kirklandsign and @dbort! Could you kindly help assign reviewers to this PR? Many thanks!

- attempt to fix extension/data_loader/file_data_loader.cpp:20:10: fatal error: 'executorch/runtime/platform/unistd.h' file not found

vortex-captain · 2024-11-22T02:39:47Z

Hi @dbort I attempted to address the issues in the checks, could you kindly help rerun them? Thanks 😄

backends/xnnpack/CMakeLists.txt

kernels/quantized/CMakeLists.txt

…E for executorch in Windows

malfet

IMO this change would benefit from splitting it into several separate PRs, namely:

Please rename unistd.h to compat_unistd.h as redefining system headers might create some hard to debug confusions
Submit a separate PR for adding dataloader on Windows
Submit smaller fixes for individual changes in headers/cpp files explaining why they are needed
Submit a separate PR with generic build system changes

mcr229

XNN related changes look good to me

mcr229 · 2024-12-05T20:19:16Z

backends/xnnpack/CMakeLists.txt

+endif()
+
+
+if (WIN32)


this looks fine to me, i'm assuming this has to be done for every flatbuffer outputted header file

this looks fine to me, i'm assuming this has to be done for every flatbuffer outputted header file

Thanks for the review! As suggested, we will split into smaller PRs (#7217), and apply these "platform-dependent shell command" changes everywhere in a later PR

tarun292 · 2024-12-05T19:51:40Z

runtime/platform/compiler.h

-// There currently doesn't seem to be a great way to do this in Windows and
-// given that weak linkage is not really critical on Windows, we'll just leave
-// it as a stub.
-#define ET_WEAK


@vortex-captain does this work with MSVC now? Is there a certain version of MSVC this works for, because i remember it didn't work for the older versions.

@vortex-captain does this work with MSVC now? Is there a certain version of MSVC this works for, because i remember it didn't work for the older versions.

yes, Windows x64 build uses clang-cl compiler, which supports __attribute__((weak))

tarun292 · 2024-12-05T20:04:21Z

extension/data_loader/mman_windows.cpp

@@ -0,0 +1,251 @@
+/*
+ * Copyright (c) Google Inc. and affiliates.


I think as @malfet mentioned, isolating these changes to a separate PR would be much more easier to review.

I think as @malfet mentioned, isolating these changes to a separate PR would be much more easier to review.

Sure! We plan to split into 3 smaller PRs: #7217

tarun292 · 2024-12-05T20:06:35Z

runtime/platform/unistd.h

@@ -0,0 +1,75 @@
+/*


I feel like we should maybe create a separate folder for this like runtime/platform/windows and put this under there. @dbort what do you think?

I feel like we should maybe create a separate folder for this like runtime/platform/windows and put this under there. @dbort what do you think?

As @malfet suggested, We renamed unistd.h to compat_unistd.h in the new PR which would serve as a wrapper of <unistd.h> used in different platforms. Would it be clearer to put it in runtime/platform/windows? Thanks!

vortex-captain · 2024-12-06T07:44:47Z

IMO this change would benefit from splitting it into several separate PRs, namely:

Please rename unistd.h to compat_unistd.h as redefining system headers might create some hard to debug confusions

Submit a separate PR for adding dataloader on Windows

Submit smaller fixes for individual changes in headers/cpp files explaining why they are needed

Submit a separate PR with generic build system changes

Thanks for the great suggestions! We plan to split this PR into 3 smaller ones, please find details in the new PR here, in which unistd.h has been renamed to compat_unistd.h

SS-JIA · 2025-03-17T16:21:15Z

Closing this PR now, as the changes contained in this PR are now merged as a part of the recent Windows support effort i.e. #9198

fix resolve_buck on windows

33c9f75

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Nov 20, 2024

Yi Ren and others added 3 commits November 20, 2024 14:58

- add runtime/platform/unistd.h for Windows x64 compatibility

555246a

- fix extension/data_loader/file_data_loader.cpp for Windows x64

fix install_requirements.bat

77d1428

Merge branch 'pytorch:main' into win_build

c8beaf3

pytorch-bot bot added the release notes: build Changes related to build, including dependency upgrades, build flags, optimizations, etc. label Nov 21, 2024

vortex-captain marked this pull request as ready for review November 21, 2024 03:24

kirklandsign requested a review from dbort November 21, 2024 18:42

vortex-captain and others added 2 commits November 22, 2024 09:48

Merge branch 'pytorch:main' into win_build

eaeb483

- fix lintrunner/linux-job issues

6c9bc9e

- attempt to fix extension/data_loader/file_data_loader.cpp:20:10: fatal error: 'executorch/runtime/platform/unistd.h' file not found

chinazhangchao mentioned this pull request Nov 25, 2024

compiler.h changes for Windows MSVC support #6623

Merged

chinazhangchao and others added 6 commits November 27, 2024 16:39

merge mman and fix some build issue

0a56ebc

add pread function to unistd.h

14324cd

Merge branch 'win_build' into xnnpack

d58c11a

fix build issue

d232bff

fix build issue

d59096a

Merge branch 'pytorch:main' into win_build

5d10dfa

vortex-captain commented Nov 29, 2024

View reviewed changes

backends/xnnpack/CMakeLists.txt Outdated Show resolved Hide resolved

fix flatcc build issue

ecb0042

vortex-captain commented Dec 2, 2024

View reviewed changes

kernels/quantized/CMakeLists.txt Show resolved Hide resolved

vortex-captain changed the title ~~Windows x64 Build Support~~ Windows x64 Build Support with xnnpack Dec 3, 2024

chinazhangchao and others added 2 commits December 3, 2024 14:48

fix windows build issue

19033e2

make examples/models/llama/runner build in win_x64

d46f329

followup fixes for llama example in Windows; add missing /WHOLEARCHIV…

8e2b8bd

…E for executorch in Windows

vortex-captain changed the title ~~Windows x64 Build Support with xnnpack~~ Windows x64 Build with support for xnnpack and llama example Dec 4, 2024

mergennachin requested a review from tarun292 December 5, 2024 17:18

malfet reviewed Dec 5, 2024

View reviewed changes

mergennachin requested review from digantdesai and mcr229 December 5, 2024 17:19

mcr229 approved these changes Dec 5, 2024

View reviewed changes

tarun292 reviewed Dec 5, 2024

View reviewed changes

chinazhangchao mentioned this pull request Dec 6, 2024

Support build on native Windows x64 #7217

Closed

SS-JIA mentioned this pull request Mar 12, 2025

[Windows] misc fixes to enable Windows build #9198

Merged

SS-JIA closed this Mar 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows x64 Build with support for xnnpack and llama example #6979

Windows x64 Build with support for xnnpack and llama example #6979

vortex-captain commented Nov 20, 2024 •

edited

Loading

pytorch-bot bot commented Nov 20, 2024 •

edited

Loading

pytorch-bot bot commented Nov 21, 2024

vortex-captain commented Nov 21, 2024

pytorch-bot bot commented Nov 21, 2024

vortex-captain commented Nov 21, 2024

vortex-captain commented Nov 21, 2024

vortex-captain commented Nov 22, 2024

malfet left a comment

mcr229 left a comment

mcr229 Dec 5, 2024

vortex-captain Dec 6, 2024 •

edited

Loading

tarun292 Dec 5, 2024

vortex-captain Dec 6, 2024

tarun292 Dec 5, 2024

vortex-captain Dec 6, 2024

tarun292 Dec 5, 2024

vortex-captain Dec 6, 2024

vortex-captain commented Dec 6, 2024

SS-JIA commented Mar 17, 2025

		@@ -0,0 +1,251 @@
		/*
		* Copyright (c) Google Inc. and affiliates.

		endif()


		if (WIN32)

Windows x64 Build with support for xnnpack and llama example #6979

Windows x64 Build with support for xnnpack and llama example #6979

Conversation

vortex-captain commented Nov 20, 2024 • edited Loading

Summary

Test plan

References

pytorch-bot bot commented Nov 20, 2024 • edited Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/6979

❌ 6 New Failures

pytorch-bot bot commented Nov 21, 2024

vortex-captain commented Nov 21, 2024

pytorch-bot bot commented Nov 21, 2024

vortex-captain commented Nov 21, 2024

vortex-captain commented Nov 21, 2024

vortex-captain commented Nov 22, 2024

malfet left a comment

Choose a reason for hiding this comment

mcr229 left a comment

Choose a reason for hiding this comment

mcr229 Dec 5, 2024

Choose a reason for hiding this comment

vortex-captain Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

tarun292 Dec 5, 2024

Choose a reason for hiding this comment

vortex-captain Dec 6, 2024

Choose a reason for hiding this comment

tarun292 Dec 5, 2024

Choose a reason for hiding this comment

vortex-captain Dec 6, 2024

Choose a reason for hiding this comment

tarun292 Dec 5, 2024

Choose a reason for hiding this comment

vortex-captain Dec 6, 2024

Choose a reason for hiding this comment

vortex-captain commented Dec 6, 2024

SS-JIA commented Mar 17, 2025

vortex-captain commented Nov 20, 2024 •

edited

Loading

pytorch-bot bot commented Nov 20, 2024 •

edited

Loading

vortex-captain Dec 6, 2024 •

edited

Loading