Skip to content

Metal backend: exported .pte does not load outside a process that already has PyTorch's libomp (embedded AOTI object links /opt/llvm-openmp/lib/libomp.dylib) #22955

Description

@abdelaziz-mahdy

Summary

A Metal .pte loads under executor_runner built by run_metal_test.sh, but fails in an application that links the ExecuTorch runtime on its own:

E executorch:metal_backend.cpp:352] Failed to load shared library: dlopen(.../<hash>_so_blob<pid>.so, 0x0005):
  Library not loaded: /opt/llvm-openmp/lib/libomp.dylib
E executorch:method.cpp:132] Init failed for backend MetalBackend: 0x22

Cause

On macOS inductor's _get_openmp_args always adds -lomp. The libomp it resolves is the one bundled in the PyTorch wheel (torch/lib/libomp.dylib), whose LC_ID_DYLIB is the absolute path /opt/llvm-openmp/lib/libomp.dylib, and that path is recorded as a dependency of the AOTI object embedded in the .pte. The path exists on no end-user machine.

It goes unnoticed in-tree because run_metal_test.sh already rewrites the same reference in executor_runner to @rpath/libomp.dylib with an rpath into torch/lib. The runner therefore loads PyTorch's libomp first, and dyld then satisfies the model's dependency by install name. An app that ships its own libomp (or none) has no image with that install name loaded, so dlopen fails.

The dependency is not used: nm -u on the embedded object shows no omp / kmp symbol for a Metal-delegated MobileNet, as expected for a graph that runs on the GPU.

Possible directions

  • Link the AOTI object with -Wl,-dead_strip_dylibs for the Metal backend, so dylibs the object does not reference are dropped and libomp stays only if a model really needs it. Inductor has no option for extra link flags today; we do it from outside by pointing torch._inductor.config.cpp.cxx at a wrapper compiler that appends the flag on link steps. The resulting object links only libc++ and libSystem and loads in a process with no libomp at all.
  • Independently, a check next to MetalBackend.codesign_so that the compiled object has no dependency outside /usr/lib and /System would turn this from a load-time surprise on someone else's machine into an export-time error.

Happy to send a PR for the check if that direction sounds right; the link-flag part probably belongs in inductor.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

module: metalIssues related to the AOTI Metal backendtriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions