cmake: replace `check_include_file_concat()` for LDAP and GSS detection by vszakats · Pull Request #15157 · curl/curl

vszakats · 2024-10-04T23:13:49Z

Replace check_include_file_concat() with check_include_file() in
GSS/LDAP detection to avoid these headers spilling into subsequent
feature checks.

For LDAP, reverse detection order to match with ./configure.
Though, in current LDAP packages ldap.h does include lber.h.
For GSS, align header detection logic with ./configure, where
gssapi/gssapi_generic.h might require gssapi/gssapi.h, and
gssapi/gssapi_krb5.h might require both.

Ref: #436

rebase on build: add ldap to libcurl.pc Requires: #15163
verify that this PR didn't change LDAP detection results in CI.

vszakats · 2024-10-05T10:40:58Z

That's a deep rabbit-hole of issues...

Optional dependencies should not use check_include_file_concat() for header detection and polluting the global header list with dependency headers. (also happens with GSS)
There are curl-specific customization variables that are namespaced CMAKE_*: CMAKE_LDAP_LIB, CMAKE_LBER_LIB, CURL_LDAP_INCLUDE_DIR.
They use non-standard naming scheme, and probably should not be namespaced at all (or to CURL_*).
These variables do not accept input via command-line, only by updating them in cache? or were they meant for internal use only?
Core OpenLDAP detection should probably be in its own Find module.
ldap is missed from the pkg-config dependency list (also in autotools): LIBCURL_PC_REQUIRES_PRIVATE.
custom curl CMake code should probably never (or only with a strong reason with comments) depend on CMake built-in globals: CMAKE_REQUIRED_FLAGS, CMAKE_REQUIRED_DEFINITIONS, CMAKE_REQUIRED_LINK_OPTIONS, CMAKE_REQUIRED_LIBRARIES, CMAKE_REQUIRED_INCLUDES, CMAKE_EXTRA_INCLUDE_FILES. This will have to untangled and see what sets depends on which uses.
OpenLDAP (detection) is very lightly tested in CI.

Related commit/PR(s): #436

https://cmake.org/cmake/help/latest/module/CMakePushCheckState.html

edit: Most of these were addressed via separate PRs.

dfandrich · 2024-10-05T13:43:17Z

Analysis of PR #15157 at bc0992c7:

Test 593 failed, which has NOT been flaky recently, so there could be a real issue in the PR.

Generated by Testclutch

…DES` Cherry-picked from curl#15157

Enclose `CMAKE_EXTRA_INCLUDE_FILES`, `CMAKE_REQUIRED_DEFINITIONS`, `CMAKE_REQUIRED_FLAGS`, `CMAKE_REQUIRED_INCLUDES`, `CMAKE_REQUIRED_LIBRARIES`, `CMAKE_REQUIRED_LINK_OPTIONS`, settings within `cmake_push_check_state()`/`cmake_pop_check_state()` calls. It prevents spilling them into other feature checks. It also replaces manual resets found in some places (which can have the undesired side-effect of destroying values meant for global use.) Cherry-picked from #15157 Closes #15251

…DES` It was done for `zlib`, `brotli`, `libpsl`, `libssh2`, `wolfssh` (a copy-paste case for `wolfssh`). Feature detections should not rely by default on dependency headers. There is no evidence they do now. If it becomes necessary, headers should added for the duration of the feature check. Ref: 118977f Cherry-picked from #15157 Closes #15252

Add comments saying when we want values set in feature check option variables to apply to all feature checks, globally. These are currently: `ws2_32` and `socket` libraries, and `-D_WIN32_WINNT=` macro. Also use `list(APPEND ...)` for the libraries to avoid overwriting potentially existing values. Cherry-picked from #15157 Closes #15253

ldap.h includes lber.h. If you know of a system where this is not the case, let us know.

include gssapi/gssapi.h when checking for gssapi_generic.h/gssapi_krb5.h To continue doing what ./configure does.

Via these configuration values: - `LDAP_LIBRARY` - `LDAP_LBER_LIBRARY` - `LDAP_INCLUDE_DIR` Following the naming scheme used in `Find` modules. Cherry-picked from #15157 Closes #15255

Regression from rebase mistake in 91d451b curl#15157

- limit `SIZEOF_SA_FAMILY_T` detection to non-Windows. - make sure `sys/socket.h` exists before detecting `SIZEOF_SA_FAMILY_T`. - limit `mach_absolute_time()` detection to `APPLE`. Drop from Windows pre-cache. - skip `HAVE_LIBSOCKET` detection for Windows, drop pre-cached value. - drop redundant pre-cached `HAVE_LIBZ` for Windows. - `curl_required_libpaths()`: stop accepting multiple arguments. To prepare for `CMAKE_REQUIRED_LINK_DIRECTORIES` support. Follow-up to 7bab201 #15193 - GSS: fix recent rebase mistakes: - fix variable name. - do not add a header twice. Follow-up to 91d451b #15157 - GSS: quote a variable. Closes #15271

Enclose `CMAKE_EXTRA_INCLUDE_FILES`, `CMAKE_REQUIRED_DEFINITIONS`, `CMAKE_REQUIRED_FLAGS`, `CMAKE_REQUIRED_INCLUDES`, `CMAKE_REQUIRED_LIBRARIES`, `CMAKE_REQUIRED_LINK_OPTIONS`, settings within `cmake_push_check_state()`/`cmake_pop_check_state()` calls. It prevents spilling them into other feature checks. It also replaces manual resets found in some places (which can have the undesired side-effect of destroying values meant for global use.) Cherry-picked from curl#15157 Closes curl#15251

…DES` It was done for `zlib`, `brotli`, `libpsl`, `libssh2`, `wolfssh` (a copy-paste case for `wolfssh`). Feature detections should not rely by default on dependency headers. There is no evidence they do now. If it becomes necessary, headers should added for the duration of the feature check. Ref: 118977f Cherry-picked from curl#15157 Closes curl#15252

Add comments saying when we want values set in feature check option variables to apply to all feature checks, globally. These are currently: `ws2_32` and `socket` libraries, and `-D_WIN32_WINNT=` macro. Also use `list(APPEND ...)` for the libraries to avoid overwriting potentially existing values. Cherry-picked from curl#15157 Closes curl#15253

Via these configuration values: - `LDAP_LIBRARY` - `LDAP_LBER_LIBRARY` - `LDAP_INCLUDE_DIR` Following the naming scheme used in `Find` modules. Cherry-picked from curl#15157 Closes curl#15255

Replace `check_include_file_concat()` with `check_include_file()` in GSS/LDAP detection to avoid these headers spilling into subsequent feature checks. - For LDAP, reverse detection order to match with `./configure`. Though, in current LDAP packages `ldap.h` does include `lber.h`. - For GSS, align header detection logic with `./configure`, where `gssapi/gssapi_generic.h` might require `gssapi/gssapi.h`, and `gssapi/gssapi_krb5.h` might require both. Ref: curl#436 Closes curl#15157

- limit `SIZEOF_SA_FAMILY_T` detection to non-Windows. - make sure `sys/socket.h` exists before detecting `SIZEOF_SA_FAMILY_T`. - limit `mach_absolute_time()` detection to `APPLE`. Drop from Windows pre-cache. - skip `HAVE_LIBSOCKET` detection for Windows, drop pre-cached value. - drop redundant pre-cached `HAVE_LIBZ` for Windows. - `curl_required_libpaths()`: stop accepting multiple arguments. To prepare for `CMAKE_REQUIRED_LINK_DIRECTORIES` support. Follow-up to 7bab201 curl#15193 - GSS: fix recent rebase mistakes: - fix variable name. - do not add a header twice. Follow-up to 91d451b curl#15157 - GSS: quote a variable. Closes curl#15271

vszakats added cmake LDAP tidy-up labels Oct 4, 2024

github-actions Bot added the build label Oct 4, 2024

vszakats marked this pull request as draft October 5, 2024 10:43

vszakats changed the title ~~cmake: use cmake_{push,pop}_check_state() in LDAP detection~~ cmake: use cmake_{push,pop}_check_state() more, and other tidy-ups Oct 5, 2024

vszakats force-pushed the cm-use-pushpop branch from bc0992c to d1ac210 Compare October 5, 2024 14:23

github-actions Bot added the CI Continuous Integration label Oct 5, 2024

vszakats marked this pull request as ready for review October 5, 2024 15:04

github-actions Bot added the tests label Oct 5, 2024

vszakats removed the tests label Oct 5, 2024

vszakats mentioned this pull request Oct 6, 2024

cmake: untangle feature detection interdependencies #15164

Closed

4 tasks

vszakats force-pushed the cm-use-pushpop branch from b49f3c3 to f7f4e78 Compare October 6, 2024 09:34

vszakats changed the title ~~cmake: use cmake_{push,pop}_check_state() more, and other tidy-ups~~ cmake: use cmake_push_check_state() more, other tidy-ups Oct 6, 2024

vszakats marked this pull request as draft October 7, 2024 11:06

vszakats force-pushed the cm-use-pushpop branch from f7f4e78 to d63202d Compare October 10, 2024 15:11

vszakats mentioned this pull request Oct 10, 2024

cmake: use cmake_push_check_state() around feature checks #15251

Closed

vszakats added a commit to vszakats/curl that referenced this pull request Oct 10, 2024

cmake: stop adding dependency headers to global `CMAKE_REQUIRED_INCLU…

a290e58

…DES` Cherry-picked from curl#15157

This was referenced Oct 10, 2024

cmake: stop adding dependency headers to global CMAKE_REQUIRED_INCLUDES #15252

Closed

cmake: add comments to feature check options applied globally #15253

Closed

vszakats mentioned this pull request Oct 10, 2024

cmake: rename LDAP dependency config variables to match Find modules #15255

Closed

2 tasks

vszakats added 3 commits October 10, 2024 20:03

avoid check_include_file_concat

9757149

ldap.h includes lber.h. If you know of a system where this is not the case, let us know.

avoid check_include_file_concat for GSS

6ff3926

include gssapi/gssapi.h when checking for gssapi_generic.h/gssapi_krb5.h To continue doing what ./configure does.

mimic configure

fc16a2d

vszakats force-pushed the cm-use-pushpop branch from d63202d to fc16a2d Compare October 10, 2024 18:24

vszakats changed the title ~~cmake: use cmake_push_check_state() more, other tidy-ups~~ cmake: replace check_include_file_concat() for LDAP and GSS detection Oct 10, 2024

vszakats marked this pull request as ready for review October 10, 2024 18:29

vszakats closed this in 91d451b Oct 10, 2024

github-actions Bot added the hacktoberfest-accepted label Oct 10, 2024

vszakats deleted the cm-use-pushpop branch October 10, 2024 20:52

vszakats removed the hacktoberfest-accepted label Oct 10, 2024

vszakats mentioned this pull request Oct 11, 2024

cmake: tidy-ups and rebase fixups #15271

Closed

vszakats added a commit to vszakats/curl that referenced this pull request Oct 12, 2024

GSS: fix variable name

4007772

Regression from rebase mistake in 91d451b curl#15157

Navigation Menu

Uh oh!

Uh oh!

cmake: replace `check_include_file_concat()` for LDAP and GSS detection - #15157

cmake: replace `check_include_file_concat()` for LDAP and GSS detection#15157
vszakats wants to merge 3 commits into
curl:masterfrom
vszakats:cm-use-pushpop

vszakats commented Oct 4, 2024 •

edited

Loading

Uh oh!

vszakats commented Oct 5, 2024 •

edited

Loading

Uh oh!

dfandrich commented Oct 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

vszakats commented Oct 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vszakats commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dfandrich commented Oct 5, 2024

Generated by Testclutch

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

vszakats commented Oct 4, 2024 •

edited

Loading

vszakats commented Oct 5, 2024 •

edited

Loading