Added support for --lib-name in manual kernel registration #12193

Tanish2101 · 2025-07-03T13:59:43Z

Summary

This PR adds support for explicit function-based kernel registration in ExecuTorch through a new --lib-name flag in the code generation workflow. This allows each kernel library to generate a register_<lib_name>_kernels() function instead of relying on static constructors and -force_load, which improves build portability especially for platforms like Xcode where -force_load needs to be used currently.

Key changes:

Introduced --lib-name option for --manual-registration mode in codegen.
Generates register_<lib_name>_kernels() in RegisterKernels.cpp and corresponding headers.
Extended documentation under kernel-library-selective-build.md to describe the new registration mechanism.

Fixes #11221

@larryliu0820 @shoumikhin

pytorch-bot · 2025-07-03T13:59:48Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR

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

❌ 87 New Failures

As of commit d83a541 with merge base ef48cc2 ():

NEW FAILURES - The following jobs have failed:

Build documentation / build (buck2) / Build doc (gh)
RuntimeError: Command docker exec -t 2e6ef7fcd9693b8d6890cbdba30266e4a7ee8453d42bce6a53b2d6215a1c281d /exec failed with exit code 1
Build Presets / apple (ios-simulator) / build (gh)
RuntimeError: Command bash /Users/runner/work/_temp/exec_script failed with exit code 65
Build Presets / apple (ios) / build (gh)
RuntimeError: Command bash /Users/runner/work/_temp/exec_script failed with exit code 65
Build Presets / apple (llm) / build (gh)
RuntimeError: Command bash /Users/runner/work/_temp/exec_script failed with exit code 2
Build Presets / apple (macos) / build (gh)
RuntimeError: Command bash /Users/runner/work/_temp/exec_script failed with exit code 65
Build Presets / apple (pybind) / build (gh)
RuntimeError: Command bash /Users/runner/work/_temp/exec_script failed with exit code 2
Build Presets / linux (linux, linux.2xlarge, executorch-ubuntu-22.04-clang12) / build (gh)
RuntimeError: Command docker exec -t f2e2e2ee4db7349e70438cd5caf1651eb0bc3dbcee9cb4c74f5bbe3a021bcf07 /exec failed with exit code 2
Build Presets / linux (linux, linux.arm64.2xlarge, executorch-ubuntu-22.04-gcc11-aarch64) / build (gh)
RuntimeError: Command docker exec -t 63aadf020b7e0321c1306eaf752056d4db04a9aab1f96a5d555a44fca3c66042 /exec failed with exit code 2
Build Presets / linux (llm, linux.2xlarge, executorch-ubuntu-22.04-clang12) / build (gh)
RuntimeError: Command docker exec -t bf66b184b3da874f163ab256c05c07765fd1d42e23921dbbe73f3c3c70b15247 /exec failed with exit code 2
Build Presets / linux (llm, linux.arm64.2xlarge, executorch-ubuntu-22.04-gcc11-aarch64) / build (gh)
Build Presets / linux (pybind, linux.2xlarge, executorch-ubuntu-22.04-clang12) / build (gh)
RuntimeError: Command docker exec -t 2532a0a1a8f14cb00c289cf240ddf4b87a3c5c5b2bb321429a435735c1bf816c /exec failed with exit code 2
Build Presets / linux (pybind, linux.arm64.2xlarge, executorch-ubuntu-22.04-gcc11-aarch64) / build (gh)
RuntimeError: Command docker exec -t 63aa540382af6063c133189c1910c32b54f4c73965eec8e1f04eaab4adf001ba /exec failed with exit code 2
Build Presets / zephyr (zephyr) / build (gh)
RuntimeError: Command docker exec -t 68e4a55c569432157e8355f9c7d53974056b4795f38ca45a10ba2b3825397770 /exec failed with exit code 2
Lint / lintrunner / linux-job (gh)
RuntimeError: Command docker exec -t 5bd8f87f3e3b26589c3002316e9190bcd41498db1c1379f2090393cf13a4fcec /exec failed with exit code 1
pull / android / build-llm-demo / linux-job (gh)
RuntimeError: Command docker exec -t 8f3392f0b4da4af027b936c4adb7a19ad3a58e415fc231f1ba67ff886e6ba889 /exec failed with exit code 1
pull / test-binary-size-linux / linux-job (gh)
RuntimeError: Command docker exec -t 524f213b325d00ab2400f6af70dfd0ef0aa33c95c286a33f83e600934b18f124 /exec failed with exit code 2
pull / test-binary-size-linux-gcc / linux-job (gh)
RuntimeError: Command docker exec -t c2851260a3f8278fe8b583e9aefa4077504a04289ae3520b3b74e0a5190dc6d6 /exec failed with exit code 2
pull / test-build-wasm-linux / linux-job (gh)
RuntimeError: Command docker exec -t 26622e6ab2210e1767c45cd989bc865d71fa285ebcf831b235a54d345dfab38c /exec failed with exit code 1
pull / test-custom-ops-linux / linux-job (gh)
RuntimeError: Command docker exec -t 6062dae02286bf256d0c5dde26a1e60a352b05e5c5140a1a3538a28ec159017f /exec failed with exit code 1
pull / test-eval_llama-mmlu-linux / linux-job (gh)
RuntimeError: Command docker exec -t 792ee94198428e232f706d883c7f3a9af01f493a1dbddaadf3faa753f25167b3 /exec failed with exit code 1
pull / test-eval_llama-wikitext-linux / linux-job (gh)
RuntimeError: Command docker exec -t e1111d4fa4d44ce165f55f7a1d6f9bcf0719abae89e7752e0469028adf3b3673 /exec failed with exit code 1
pull / test-llama_runner_eager-linux / linux-job (gh)
RuntimeError: Command docker exec -t 39c2999cc79cc820e8a073cd79c0bf07461bb7d07b518e4b0ad5d127df2ff377 /exec failed with exit code 1
pull / test-llama-runner-linux (bf16, custom, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t 46ede6fb1a1c1bceb7927b2b78cc0861b1c20d245957e1c10aff3a78422f9f59 /exec failed with exit code 1
pull / test-llama-runner-linux (fp32, xnnpack+custom+qe, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t d8060c29f89b2d3f924ee831ff3270b7162c6320bc198238b83d53e2920d1759 /exec failed with exit code 1
pull / test-llama-runner-linux (fp32, xnnpack+custom+qe, linux.arm64.2xlarge, executorch-ubuntu-22.04-gc... / linux-job (gh)
RuntimeError: Command docker exec -t ae6462ee31660893f361ae7e84f72eb8a8f40d90be7904f2cfeee816c742e23a /exec failed with exit code 1
pull / test-llama-runner-linux (fp32, xnnpack+custom+quantize_kv, linux.2xlarge, executorch-ubuntu-22.04... / linux-job (gh)
RuntimeError: Command docker exec -t d062af46215f4428c14ecfe7673b850a63772ab87466fa03c2cd739b172e6666 /exec failed with exit code 1
pull / test-llama-runner-linux (fp32, xnnpack+custom+quantize_kv, linux.arm64.2xlarge, executorch-ubuntu... / linux-job (gh)
RuntimeError: Command docker exec -t bfa47c6a2dcfdd5ccde56a010c9d32396e312bb79f7929e41d60f41151b7341e /exec failed with exit code 1
pull / test-llama-runner-linux (fp32, xnnpack+quantize_kv, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t a148163ad040b84ab585b26b6d00f55d943ab52455580c39c323ce1022a541be /exec failed with exit code 1
pull / test-llama-runner-linux (fp32, xnnpack+quantize_kv, linux.arm64.2xlarge, executorch-ubuntu-22.04-... / linux-job (gh)
RuntimeError: Command docker exec -t a2c11842dbb1eb2e4e66945788b4755ef37701177640a5db5a68a72d5f36dfe3 /exec failed with exit code 1
pull / test-llama-runner-linux-android / linux-job (gh)
RuntimeError: Command docker exec -t dc294f556eff2829d0edf563b485ae8e1fba146844f512c81a8e45d9febbdbc2 /exec failed with exit code 1
pull / test-llama-runner-qnn-linux (fp32, qnn_16a16w, qnn) / linux-job (gh)
RuntimeError: Command docker exec -t 45501ff7f94ac0fe37d97c7b6bb5d1d59dce868e72690c327657d8ecd9eec0e5 /exec failed with exit code 2
pull / test-llama-runner-qnn-linux (fp32, qnn_8a8w, qnn) / linux-job (gh)
RuntimeError: Command docker exec -t 5bbf7f3f7538527261abc6b6429e919f7d66acbb1e2f56edbe6ed81f8c45790a /exec failed with exit code 2
pull / test-llava-runner-linux / linux-job (gh)
RuntimeError: Command docker exec -t 87ce505da1c31058ce5b2100c57d574722b3493a79d0c607c40242159d14f318 /exec failed with exit code 1
pull / test-mediatek-models-linux / linux-job (gh)
RuntimeError: Command docker exec -t 78bd4916cff31c13038fe42fdabe91cbc087fd72dc9386d4a4d0fa1b910f5c1c /exec failed with exit code 1
pull / test-models-linux (add_mul, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 9b3bbc1160dbf3ead8241f6d891f28f4ab43117ed75d594307653e0c244bce5d /exec failed with exit code 1
pull / test-models-linux (add_mul, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 7e3425dccd059a0bb8423098a91abc973d347b3fd30f1fe4a8b5c83035907f28 /exec failed with exit code 1
pull / test-models-linux (add, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t b353c810af4b1183c5f590317639e0982c7b4790269fdbfa9cab2f4db8577db5 /exec failed with exit code 1
pull / test-models-linux (add, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 52bd766d1f22b725b1af0e57876f95c85419be9fb7f4bee887c987c5b6ea0dc8 /exec failed with exit code 1
pull / test-models-linux (emformer_join, portable, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t 5d8a29696b5b75ee2810e0c012d8c9fdfee7f9e731b27320faaaaeb1e18b7f30 /exec failed with exit code 1
pull / test-models-linux (emformer_join, xnnpack-quantization-delegation, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t ec60c5b95d9d4100ff504169cacfe385b22c370e3c32f85d96c9cf5c6373f55b /exec failed with exit code 1
pull / test-models-linux (emformer_transcribe, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t c5b9b4ef963d09131109abc13912623cd823021540f80ac5142333d71e5c3a51 /exec failed with exit code 1
pull / test-models-linux (emformer_transcribe, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t d2de3451202b4a349882407bdd6d658e40e7474f90bca864d2d94d55469ff59c /exec failed with exit code 1
pull / test-models-linux (ic3, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 56a7143e8c353ecd587aff3ad249411353ff818561f363d033c572c9c2071f35 /exec failed with exit code 1
pull / test-models-linux (ic3, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 08fea2e2814420de7fdf4b0bf0d0151c6539fc6331cf5a61f948492df0486dd3 /exec failed with exit code 1
pull / test-models-linux (ic4, portable, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t 98fc652e860177791cd08f6b333a443f41a2b4d16b2dbe98749bcf303825d291 /exec failed with exit code 1
pull / test-models-linux (ic4, xnnpack-quantization-delegation, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t 624c3ab071f2af2226c47a00f324e111d2b50ec8a6ba843e161e4ea34ce756e4 /exec failed with exit code 1
pull / test-models-linux (linear, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t fa1579cb16963d8c3154a9c3642ac6cc2866e4fcf4eae5e0a3bff46feb1b262a /exec failed with exit code 1
pull / test-models-linux (linear, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t eea72aee02d30006f59ddc6f800aa75e56c628fccb42623fd507aa2a416cc7f8 /exec failed with exit code 1
pull / test-models-linux (llama3_2_vision_encoder, portable, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t d75a27da0e5d5583960e008dda1316b8c20b15c372d95ecac033e63ed5336c90 /exec failed with exit code 1
pull / test-models-linux (mobilebert, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t d53a91ef14d196c728099d9e42bbb3c8c755868f8754f3c3b4af17210a59fda5 /exec failed with exit code 1
pull / test-models-linux (mobilebert, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t cbfc030b2f9bdff1532ea127de373ff05a453f097f23084c923370744f0ab647 /exec failed with exit code 1
pull / test-models-linux (mv2, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 60f472e5760901d428803305fbe33211894899858cc3ff71ae074ed51d2c8f52 /exec failed with exit code 1
pull / test-models-linux (mv2, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t c2833f409fbb61240b93d46fdad7ce50a6167becd7c0d8f538e55fa0e96d6c17 /exec failed with exit code 1
pull / test-models-linux (phi_4_mini, portable, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t 34452a8c33a0b922780db563a7bb77e1566786082a0b3af300567f842489eab3 /exec failed with exit code 1
pull / test-models-linux (resnet18, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 5544edb0c12727e4eff8fc3c8d555074731b5b0fb9a135e6d1773f6d2afa705c /exec failed with exit code 1
pull / test-models-linux (resnet18, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t a8a1cac7a83c22b8457d041b536a1489159f473932ec408a7fff8e05deb0aac2 /exec failed with exit code 1
pull / test-models-linux (resnet50, portable, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t 535f352f9f47b82dcf7d6cdec4ce9380263f661212497a502f344b24ff8fcf3e /exec failed with exit code 1
pull / test-models-linux (resnet50, xnnpack-quantization-delegation, linux.2xlarge) / linux-job (gh)
RuntimeError: Command docker exec -t ed8b400e8bbdd89fa63a578ccb48c6641e953004d4803a2982b776d5c2b444dd /exec failed with exit code 1
pull / test-models-linux (w2l, portable, linux.4xlarge.memory) / linux-job (gh)
RuntimeError: Command docker exec -t 8a1621e429c3680a249cb43cd9893b70e0399c37ce0a82787f9561a80de81705 /exec failed with exit code 1
pull / test-models-linux-basic (mv3, portable, buck2, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t 73746fdb9af16550bf7c471b73a37610d0486dd3e8073b429065e91c5be6c1b2 /exec failed with exit code 1
pull / test-models-linux-basic (mv3, portable, cmake, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t 38830e669928e98e3ed944b374f8f903a37f6c4f3f8f4d8105795dbdeb6be366 /exec failed with exit code 1
pull / test-models-linux-basic (mv3, portable, cmake, linux.arm64.2xlarge, executorch-ubuntu-22.04-gcc11... / linux-job (gh)
RuntimeError: Command docker exec -t 24162410306efb036015f81988f31cd043a527c41da218197ae204c6fd4e0043 /exec failed with exit code 1
pull / test-models-linux-basic (mv3, xnnpack-quantization-delegation, buck2, linux.2xlarge, executorch-u... / linux-job (gh)
RuntimeError: Command docker exec -t a1343cfd24483799ce07bcb2f8dffb4023c265c7f150a3f0ada03a8cc0d0f829 /exec failed with exit code 1
pull / test-models-linux-basic (mv3, xnnpack-quantization-delegation, cmake, linux.2xlarge, executorch-u... / linux-job (gh)
RuntimeError: Command docker exec -t a3f9df418159ea41b5fe657f159db81af753146bb11f50ff6fdf24ea4640f1d8 /exec failed with exit code 1
pull / test-models-linux-basic (mv3, xnnpack-quantization-delegation, cmake, linux.arm64.2xlarge, execut... / linux-job (gh)
RuntimeError: Command docker exec -t 07137ea7e77a9affdd1c6a36b06974ae82586d736dc44325aefbc145a4aa9de8 /exec failed with exit code 1
pull / test-models-linux-basic (vit, portable, buck2, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t 088e2a09f7044be6445e4b25e83c453ea0b8637921c56363caacab8d9391f2d6 /exec failed with exit code 1
pull / test-models-linux-basic (vit, portable, cmake, linux.2xlarge, executorch-ubuntu-22.04-clang12) / linux-job (gh)
RuntimeError: Command docker exec -t d7bac547ded3bb169ae9bafb53b5842c8d48918a3899485991d5485b0d8b7a7c /exec failed with exit code 1
pull / test-models-linux-basic (vit, portable, cmake, linux.arm64.2xlarge, executorch-ubuntu-22.04-gcc11... / linux-job (gh)
RuntimeError: Command docker exec -t eeab6ca0f03570dc1c5595a5a8e264309b8a4ece5c25c65608acb72b91750025 /exec failed with exit code 1
pull / test-models-linux-basic (vit, xnnpack-quantization-delegation, buck2, linux.2xlarge, executorch-u... / linux-job (gh)
RuntimeError: Command docker exec -t 3b2156a5fab8788dcb77d9e287b865eb51548c690bff16f0f886addcad779d5e /exec failed with exit code 1
pull / test-models-linux-basic (vit, xnnpack-quantization-delegation, cmake, linux.2xlarge, executorch-u... / linux-job (gh)
RuntimeError: Command docker exec -t 80d71ff46b7d8ac55cf88959f098c7ca091132ecb88e0aa427e2b65c850ef6ce /exec failed with exit code 1
pull / test-models-linux-basic (vit, xnnpack-quantization-delegation, cmake, linux.arm64.2xlarge, execut... / linux-job (gh)
RuntimeError: Command docker exec -t 6a31fde2c25ad34a0412d50869cc1282281b406146f2f16524d5968a14b49574 /exec failed with exit code 1
pull / test-moshi-linux / linux-job (gh)
RuntimeError: Command docker exec -t 3a825f5b83946b4fa71ba0e0d2ab4db4917bb7b21ed61c658db5fd1584f00ec3 /exec failed with exit code 1
pull / test-openvino-linux / linux-job (gh)
RuntimeError: Command docker exec -t aa42bdf748d6187ea90603da8084ea530ffb31e59da6ff30a48e2ff42b568282 /exec failed with exit code 1
pull / test-phi-3-mini-runner-linux / linux-job (gh)
RuntimeError: Command docker exec -t 5e7184c51f1693674e9a5c60a85256d3389f2e982b4c4f068a21a0fe674b00ca /exec failed with exit code 1
pull / test-quantized-aot-lib-linux / linux-job (gh)
RuntimeError: Command docker exec -t 50f58fc037b2fa9ec25045920341174a009cd21af8222fce2b3b63688fff9861 /exec failed with exit code 1
pull / test-selective-build-linux / linux-job (gh)
RuntimeError: Command docker exec -t fb6cf7cac9469af4dd7b8e4365b3af00862255ab1d39db477ad28179d167b45c /exec failed with exit code 1
pull / test-setup-linux-gcc / linux-job (gh)
RuntimeError: Command docker exec -t 8a266e136c914eaaef0754c73c018eb04d23e89f9cff0dbc8b24c5a28c5b3671 /exec failed with exit code 1
pull / test-static-llama-qnn-linux / linux-job (gh)
RuntimeError: Command docker exec -t 36b36bf825fcdda41b8aee4a4e7f66cf0de7ce60f15cd7fd22ac95a7300309a9 /exec failed with exit code 2
pull / unittest / linux / linux-job (gh)
RuntimeError: Command docker exec -t a9de034b59613b41c35087aa6dd3d340f942c03e27ddf94c8ac4d7d3090af2a0 /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
pull / unittest-arm-backend-with-no-fvp (test_pytest_models) / linux-job (gh)
RuntimeError: Command docker exec -t 81c5be7ee772c19981a6fc021be91f78f8f48bcb171633b3b1839af54ff6e32d /exec failed with exit code 1
pull / unittest-arm-backend-with-no-fvp (test_pytest_ops) / linux-job (gh)
RuntimeError: Command docker exec -t 02ef7d9c45bdefbf8ffa6ee4dc0c2991e67a17444b034b1be37024530214603a /exec failed with exit code 1
pull / unittest-buck / linux / linux-job (gh)
RuntimeError: Command docker exec -t 0f23461ed9046bbdc4da0899faaf236ad264ddce5b9352a44a888308f067d468 /exec failed with exit code 1
pull / unittest-buck / macos / macos-job (gh)
RuntimeError: Command bash /Users/ec2-user/runner/_work/_temp/exec_script failed with exit code 1
pull / unittest-editable / linux / linux-job (gh)
RuntimeError: Command docker exec -t 69261eb9b379bc2ba15a9409157b2e980437900a9f2b031dc579876cbaaccc93 /exec failed with exit code 1
pull / unittest-editable / macos / macos-job (gh)
RuntimeError: Command bash /Users/ec2-user/runner/_work/_temp/exec_script failed with exit code 1
pull / unittest-nxp-neutron / linux-job (gh)
RuntimeError: Command docker exec -t 9faaf084873f1472e0efef3cd7cb57ca33bd5f21f47cf68facd629246f575bb4 /exec failed with exit code 1

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

github-actions · 2025-07-03T14:00:27Z

This PR needs a `release notes:` label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

Tanish2101 · 2025-07-03T14:03:14Z

@pytorchbot label "release notes: none"

pytorch-bot · 2025-07-03T14:03:17Z

Didn't find following labels among repository labels: Release Notes: ops & kernels

shoumikhin · 2025-07-03T15:13:26Z

Thanks for the change!

Wdyt if we call the newly exposed symbol as register_kerlens_ to match the Apple frameworks product naming?

larryliu0820 · 2025-07-03T17:31:48Z

Thank you for submitting PR! Let me take a look

larryliu0820 · 2025-07-03T17:32:53Z

codegen/gen.py

            kernel_index=kernel_index,
            manual_registration=options.manual_registration,
            add_exception_boundary=options.add_exception_boundary,
+            lib_name=options.lib_name,


Let's error out, if lib_name is specified but manual_registration is not enabled.

Also can you please add a unit test here: https://github.com/pytorch/executorch/blob/main/codegen/test/test_executorch_gen.py

larryliu0820 · 2025-07-03T17:34:26Z

codegen/templates/RegisterKernels.cpp

      ::executorch::runtime::register_kernels({kernels_to_register});
  if (success_with_kernel_reg != Error::Ok) {
-    ET_LOG(Error, "Failed register all kernels");
+    ET_LOG(Error, "Failed to register ${lib_name} kernels");


Would be good to print out the number of kernels, also __FILE__ for debugging

larryliu0820 · 2025-07-03T18:09:11Z

docs/source/kernel-library-selective-build.md

+  ROOT_OPS              # comma separated operator names to be selected
+  INCLUDE_ALL_OPS       # boolean flag to include all operators
+  OPS_FROM_MODEL        # path to a pte file of model to select operators from
+  DTYPE_SELECTIVE_BUILD # boolean flag to enable dtye selection


Typo. Thank you for adding this docstring!

larryliu0820 · 2025-07-03T18:19:40Z

tools/cmake/Codegen.cmake

+  if(GEN_LIB_NAME)
+    list(APPEND _gen_command --lib-name=${GEN_LIB_NAME})
+  endif()


Ok this is a bit of problem.

We want to support 3 options:

Using static initializer to register all kernels (default option)

Using manual registration
2.1 Generate register_all_kernels() API
2.2 Generate register_{lib_name}_kernels() API

2.1 already exist and we don't want to break it. Now if you look at here, GEN_LIB_NAME is always being passed in, which effectively change 2.1 behavior to 2.2. Can we design the API in a way that we an support all 3 options?

Please use register_kernels_{lib name} format :)

Why does it matter?

So that it matches the packages naming, see my comment to the original proposal issue.
Plus we're gonna have manual registration for backends too seems like, so having it like register_{kernels/backend}_{name} sounds right

Ok this is a bit of problem.

We want to support 3 options:

Using static initializer to register all kernels (default option)

Using manual registration
2.1 Generate register_all_kernels() API
2.2 Generate register_{lib_name}_kernels() API

2.1 already exist and we don't want to break it. Now if you look at here, GEN_LIB_NAME is always being passed in, which effectively change 2.1 behavior to 2.2. Can we design the API in a way that we an support all 3 options?

So do you mean that I should also support the case where there is manual registration along with lib name then only I should pass GEN_LIB_NAME so this way it doesn't break already existing 2.1?

So do you mean that I should also support the case where there is manual registration along with lib name

Yeah, you can imagine somewhere people are using manual registration and calling register_all_kernels() API, we should still allow them to do that. So maybe in this macro you can add another boolean argument like USE_LIB_NAME_IN_REGISTER or something similar. By default it's false and only if it's true, we generate register_kernels_{lib_name}() instead of register_all_kernels() API.

lucylq · 2025-07-03T18:29:41Z

Thanks for the contribution! Could you rebase this PR on top of main? Looks like some changes from #12112 were also pulled in here :0

Tanish2101 · 2025-07-09T15:32:00Z

Can anyone help me resolve this conflict issue in documentation file ? Also have I pushed the changes correctly? Other than my changes there are others changes as well

@larryliu0820 @shoumikhin @lucylq

lucylq · 2025-07-10T16:30:18Z

Can anyone help me resolve this conflict issue in documentation file ? Also have I pushed the changes correctly? Other than my changes there are others changes as well

@larryliu0820 @shoumikhin @lucylq

Hi @Tanish2101, can you try rebasing on top of main, and picking only your changes?
i.e., you can try git rebase -i main, and only attach your commits.

Tanish2101 · 2025-07-11T13:43:50Z

Can anyone help me resolve this conflict issue in documentation file ? Also have I pushed the changes correctly? Other than my changes there are others changes as well
@larryliu0820 @shoumikhin @lucylq

Hi @Tanish2101, can you try rebasing on top of main, and picking only your changes? i.e., you can try git rebase -i main, and only attach your commits.

Thanks @lucylq now the problem is resolved. 👍

Tanish2101 · 2025-07-11T13:46:45Z

Please check my changes now.
@larryliu0820 @shoumikhin

larryliu0820

Looks good to me. Thank you for adding this. Can you make sure CI looks ok before merging

larryliu0820 · 2025-07-11T21:03:48Z

Can you resolve the conflict and I can help kicking off the CI

This PR was reopened (likely due to being reverted), so your approval was removed. Please request another review.

Tanish2101 · 2025-07-12T07:31:49Z

Can you resolve the conflict and I can help kicking off the CI

I have already resolved those conflicts which occured in kernel-library-selective-build.md file, I don't know why it is still showing the conflict.

larryliu0820

I can take a look on Monday

Tanish2101 · 2025-07-16T13:27:44Z

I can take a look on Monday

Please let me know if there are any changes required.

larryliu0820 · 2025-07-16T16:12:48Z

ok resolved the conflict. Waiting for CI signals before I merge this

larryliu0820 · 2025-07-16T16:38:05Z

@Tanish2101 seeing this error:

Traceback (most recent call last):
  File "/opt/conda/envs/py_3.10/lib/python3.10/runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/opt/conda/envs/py_3.10/lib/python3.10/runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "/pytorch/executorch/codegen/gen.py", line 1053, in <module>
    main()
  File "/pytorch/executorch/codegen/gen.py", line 1008, in main
    gen_headers(
  File "/pytorch/executorch/codegen/gen.py", line 530, in gen_headers
    cpu_fm.write(
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/utils.py", line 229, in write
    self.write_with_template(filename, filename, env_callable)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/utils.py", line 218, in write_with_template
    substitute_out = self.substitute_with_template(
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/utils.py", line 184, in substitute_with_template
    substitute_out = template.substitute(env)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/code_template.py", line 83, in substitute
    return self.substitution.sub(replace, self.pattern)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/code_template.py", line 70, in replace
    v = lookup(key)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/code_template.py", line 47, in lookup
    return kwargs[v] if v in kwargs else env[v]
KeyError: 'lib_name'

Can you take a look?

To repro this, run:

cmake --preset linux
cmake --build cmake-out -j7

Tanish2101 · 2025-07-22T12:43:05Z

@Tanish2101 seeing this error:

Traceback (most recent call last):
  File "/opt/conda/envs/py_3.10/lib/python3.10/runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/opt/conda/envs/py_3.10/lib/python3.10/runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "/pytorch/executorch/codegen/gen.py", line 1053, in <module>
    main()
  File "/pytorch/executorch/codegen/gen.py", line 1008, in main
    gen_headers(
  File "/pytorch/executorch/codegen/gen.py", line 530, in gen_headers
    cpu_fm.write(
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/utils.py", line 229, in write
    self.write_with_template(filename, filename, env_callable)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/utils.py", line 218, in write_with_template
    substitute_out = self.substitute_with_template(
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/utils.py", line 184, in substitute_with_template
    substitute_out = template.substitute(env)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/code_template.py", line 83, in substitute
    return self.substitution.sub(replace, self.pattern)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/code_template.py", line 70, in replace
    v = lookup(key)
  File "/opt/conda/envs/py_3.10/lib/python3.10/site-packages/torchgen/code_template.py", line 47, in lookup
    return kwargs[v] if v in kwargs else env[v]
KeyError: 'lib_name'

Can you take a look?

To repro this, run:

cmake --preset linux
cmake --build cmake-out -j7

Ok, I will check.

github-actions · 2025-09-21T00:51:26Z

Looks like this PR hasn't been updated in a while so we're going to go ahead and mark this as Stale.
Feel free to remove the Stale label if you feel this was a mistake.
If you are unable to remove the Stale label please contact a maintainer in order to do so.
If you want the bot to never mark this PR stale again, add the no-stale label.
Stale pull requests will automatically be closed after 30 days of inactivity.

Added support for --lib-name in manual kernel registration

8ebb8eb

Tanish2101 requested review from kirklandsign, larryliu0820, lucylq and mergennachin as code owners July 3, 2025 13:59

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 Jul 3, 2025

Fixed the documentation conflict in kernel-library-selective-build.md

ab3400d

larryliu0820 reviewed Jul 3, 2025

View reviewed changes

Tanish2101 requested review from Gasoonjia, GregoryComer, JacobSzwejbka, SS-JIA, cccclai, digantdesai, jackzhxng, kimishpatel, manuelcandales, mcr229, metascroy and swolchok as code owners July 9, 2025 15:19

Final changes done based on review comments

4e0bac5

Tanish2101 force-pushed the manual-registration-lib-name-11221 branch from b47f474 to 4e0bac5 Compare July 11, 2025 13:34

larryliu0820 previously approved these changes Jul 11, 2025

View reviewed changes

Update kernel-library-selective-build.md

2635d1e

Tanish2101 closed this Jul 12, 2025

Tanish2101 reopened this Jul 12, 2025

larryliu0820 approved these changes Jul 12, 2025

View reviewed changes

Merge branch 'main' into manual-registration-lib-name-11221

d83a541

github-actions bot added the stale PRs inactive for over 60 days label Sep 21, 2025

Uh oh!

Added support for --lib-name in manual kernel registration #12193

Are you sure you want to change the base?

Added support for --lib-name in manual kernel registration #12193

Uh oh!

Conversation

Tanish2101 commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key changes:

Uh oh!

pytorch-bot bot commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

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

❌ 87 New Failures

Uh oh!

github-actions bot commented Jul 3, 2025

This PR needs a release notes: label

Uh oh!

Tanish2101 commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Jul 3, 2025

Uh oh!

shoumikhin commented Jul 3, 2025

Uh oh!

larryliu0820 commented Jul 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shoumikhin Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shoumikhin Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucylq commented Jul 3, 2025

Uh oh!

Tanish2101 commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lucylq commented Jul 10, 2025

Uh oh!

Tanish2101 commented Jul 11, 2025

Uh oh!

Tanish2101 commented Jul 11, 2025

Uh oh!

larryliu0820 left a comment

Choose a reason for hiding this comment

Uh oh!

larryliu0820 commented Jul 11, 2025

Uh oh!

Tanish2101 commented Jul 12, 2025

Uh oh!

larryliu0820 left a comment

Choose a reason for hiding this comment

Uh oh!

Tanish2101 commented Jul 16, 2025

Uh oh!

larryliu0820 commented Jul 16, 2025

Uh oh!

larryliu0820 commented Jul 16, 2025

Uh oh!

Tanish2101 commented Jul 3, 2025 •

edited

Loading

pytorch-bot bot commented Jul 3, 2025 •

edited

Loading

This PR needs a `release notes:` label

Tanish2101 commented Jul 3, 2025 •

edited

Loading

shoumikhin Jul 3, 2025 •

edited

Loading

shoumikhin Jul 3, 2025 •

edited

Loading

Tanish2101 commented Jul 9, 2025 •

edited

Loading