Skip to content

GH-131296: fix clang-cl warning on Windows in socketmodule.c #131821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 9, 2025

Conversation

chris-eibl
Copy link
Member

@chris-eibl chris-eibl commented Mar 28, 2025

@@ -3237,7 +3231,7 @@ sock_setsockopt(PyObject *self, PyObject *args)
&level, &optname, &flag)) {
#ifdef MS_WINDOWS
if (optname == SIO_TCP_SET_ACK_FREQUENCY) {
int dummy;
DWORD dummy;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix warning : incompatible pointer types passing 'int *' to parameter of type 'LPDWORD' (aka 'unsigned long *') [-Wincompatible-pointer-types]

@@ -6066,8 +6060,10 @@ socket_gethostbyname_ex(PyObject *self, PyObject *args)
#ifdef USE_GETHOSTBYNAME_LOCK
PyThread_acquire_lock(netdb_lock, 1);
#endif
SUPPRESS_DEPRECATED_CALL
_Py_COMP_DIAG_PUSH
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest of the PR cares about deprecation warnings like

..\Modules\socketmodule.c(6070,9): warning : 'gethostbyname' is deprecated:
Use getaddrinfo() or GetAddrInfoW() instead or define _WINSOCK_DEPRECATED_NO_WARNINGS
to disable deprecated API warnings [-Wdeprecated-declarations]

https://github.com/python/cpython/actions/runs/14044831663/job/39366560293?pr=131690#step:4:183

using the already existing infrastructure _Py_COMP_DIAG_PUSH et al. from pyport.h, because clang-cl unfortunately does not (yet) respect

# define SUPPRESS_DEPRECATED_CALL __pragma(warning(suppress: 4996))

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there another way to spell the pragma that will work? The idea of pyport.h is to deal with compiler differences as much as possible, so it's the place to handle it if the original macro can be made to work.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-cl does not understand suppress, hence I need to push and pop and thus used the existing infrastructure from pyport.h (warning(disable: 4996))

cpython/Include/pyport.h

Lines 308 to 311 in 0045100

#elif defined(_MSC_VER)
#define _Py_COMP_DIAG_PUSH __pragma(warning(push))
#define _Py_COMP_DIAG_IGNORE_DEPR_DECLS __pragma(warning(disable: 4996))
#define _Py_COMP_DIAG_POP __pragma(warning(pop))

Likewise, AFAIK, there is no supress in gcc / "regular" clang, so we need to always push / pop there.

@chris-eibl
Copy link
Member Author

I am pretty sure that failing of Ubuntu (free-threading) / build and test (ubuntu-24.04) (pull_request) is unrelated to the PR.

@python-cla-bot
Copy link

python-cla-bot bot commented Apr 6, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@chris-eibl
Copy link
Member Author

@zooba May I ask you for a review?

Comment on lines 6173 to 6174
_Py_COMP_DIAG_POP
#endif /* HAVE_GETHOSTBYNAME_R */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Two space indents of preprocessor directives might be uncommon in CPython except when a line starts with # .

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I indented everywhere by two spaces to easier spot the macros, but I will happily indent by four spaces if this is preferred.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to avoid thinking of the intention when reading, so +1 for four spaces.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I had a look at the other occurrences in the code base: either no indentation or like the code they guard.

I switched to the latter.

@zooba
Copy link
Member

zooba commented Jun 9, 2025

LGTM. I'll merge after CI is done unless something else comes up (or if someone else sees this and can merge, go ahead)

@zooba zooba merged commit cc8e6d2 into python:main Jun 9, 2025
38 checks passed
@chris-eibl chris-eibl deleted the fix_clangcl_socketmodule branch June 9, 2025 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants