search

conda-forge / eigen-feedstock

A conda-smithy repository for eigen.
BSD 3-Clause "New" or "Revised" License
2 stars 15 forks source link

Add eigen-abi package for use in downstrem compiled libraries that use eigen in their public headers #41

Open traversaro opened 1 year ago

traversaro commented 1 year ago

Note: this is meant to be a proposal for discussion, I just propose it as PR as it is easier to discuss it in this form.

eigen itself is a header-only library, so there is no need to account for its ABI. Anyhow, several feedstock (including some that I mantain) are C++ compiled libraries that use Eigen in their public headers, including:

To cleanly handle this without any downside for existing users of eigen that use them either not in libraries or in libraries without using it in public headers, similarly to what is done in https://github.com/conda-forge/pybind11-feedstock I propose to add a new package, called eigen-abi, that is used to track compiled libraries that use eigen in their public headers.

If this PR is accepted, the idea is to add eigen-abi as a dependency (on the top of the existing eigen dependency) for compiled libraries that include eigen in their public headers. Furthermore, the idea is to add eigen-abi to https://github.com/conda-forge/conda-forge-pinning-feedstock, so that we can do migrations for new versions of eigen-abi.

Checklist

conda-forge-webservices[bot] commented 1 year ago

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipe) and found some lint.

Here's what I've got...

For recipe:

traversaro commented 1 year ago

@conda-forge/eigen any suggestion or comment is welcome!

traversaro commented 1 year ago

@conda-forge-admin, please rerender

conda-forge-webservices[bot] commented 1 year ago

Hi! This is the friendly automated conda-forge-linting service.

I just wanted to let you know that I linted all conda-recipes in your PR (recipe) and found it was in an excellent condition.

traversaro commented 1 year ago

@conda-forge-admin, please rerender

traversaro commented 10 months ago

@conda-forge/eigen the PR is ready for comments/review

traversaro commented 10 months ago

If it is helpful, I can also add myself to the mantainers of the feedstock.

traversaro commented 6 months ago

I guess this PR become even more important as now microarchitecture packages are coming to conda-forge, see https://github.com/conda-forge/conda-forge.github.io/pull/2091#pullrequestreview-1907410958 . Eigen public ABI depends on the optimization enabled (at least for what regards the used alignment, see https://gitlab.com/libeigen/eigen/-/blob/fa201f1bb3e2c05271cfc00ceda7b6a0228c4af5/Eigen/src/Core/util/ConfigureVectorization.h#L42-60), so we may want to include the microarchitecture used in the build string of eigen-abi and also somehow in the run_exports of the eigen-abi packages. Packages built against Eigen in public headers with a given microarchitecture can only be used in packages that compile for a given microarchitecture.

jakirkham commented 6 months ago

So we would want some kind of run_exports then? Or would users of this package need to figure this out on their own?

traversaro commented 6 months ago

Ideally, nothing should change for recipe that already use eigen and do not include eigen in public headers. Recipe of compiled libraries that include eigen in their public headers should start depending also from eigen-abi . For what regard microarch builds, I need to thing a bit about them.

traversaro commented 6 months ago

For what regard microarch builds, I need to thing a bit about them.

I think I need to get to use microarch builds to get an idea on how to use them. Fortunately I maintain a few packages without eigen used in the public headers that would benefit from them, so I can get a bit of experience there before proceeding here.