This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: setup.py grep_headers_for() is broken by design
Type: behavior Stage: patch review
Components: Build, ctypes Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: amaury.forgeotdarc, belopolsky, christian.heimes, eric.araujo, meador.inge, ned.deily, thesamesam
Priority: normal Keywords: patch

Created on 2021-10-24 12:05 by christian.heimes, last changed 2022-04-11 14:59 by admin.

Pull Requests
URL Status Linked Edit
PR 29352 closed christian.heimes, 2021-11-01 07:44
Messages (4)
msg404926 - (view) Author: Christian Heimes (christian.heimes) * (Python committer) Date: 2021-10-24 12:05
The setup.py helper function grep_headers_for() is used by ctypes build step to search header files for functions. The function kinda works on most platforms, but only by accident. On my system it opens all header files that match /usr/include/*.h and returns true if any (!) header file contains the string (!) "ffi_prep_cif_var". The check would also match "ffi_prep_cif_var" in a comment of an unrelated header file.

We cannot limit the search to "ffi.h" only, because that would break multiarch builds with a header file like this:

    #if defined(__i386__)
    #include "ffi-i386.h"
    #elif defined(__powerpc64__)
    #include "ffi-ppc64.h"
    ...

Solutions:

1) Use "AC_EGREP_HEADER" autoconf macro. It runs a header file through the C preprocessor
2) Use AC_LINK_IFELSE autoconf macro. This macro compiles and links code to detect if a library exports a function.
3) Re-implement any of the macros in pure Python (ugh!)
4) Just assume that libffi supports ffi_prep_cif_var, ffi_prep_closure_loc, and ffi_closure_alloc on our target platforms. According to [1] the functions have been around for over a decade.

I favor (4).

Ned, what about USING_APPLE_OS_LIBFFI? Is it still relevant?

[1] https://github.com/libffi/libffi/blame/48bdb02867edb7e9f3785ccb4bdff1087fb44246/include/ffi.h.in#L309
msg404927 - (view) Author: Christian Heimes (christian.heimes) * (Python committer) Date: 2021-10-24 12:06
If we remove grep_headers_for(), then we can also close bpo-42325
msg405379 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2021-10-30 17:54
We could look in distro patch trackers to see they patch CPython’s setup.py to evaluate the impact of removing this function.
msg405580 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2021-11-03 03:37
> Ned, what about USING_APPLE_OS_LIBFFI? Is it still relevant?

It was just added a year ago as part of the support for macOS 11 Big Sur and Apple Silicon systems.
History
Date User Action Args
2022-04-11 14:59:51adminsetgithub: 89761
2021-11-03 03:37:49ned.deilysetmessages: + msg405580
2021-11-01 07:44:31christian.heimessetkeywords: + patch
stage: patch review
pull_requests: + pull_request27613
2021-10-30 17:54:02eric.araujosetnosy: + eric.araujo
messages: + msg405379
2021-10-29 16:13:19thesamesamsetnosy: + thesamesam
2021-10-24 12:06:09christian.heimessetmessages: + msg404927
2021-10-24 12:05:01christian.heimescreate