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.

Sign up for GitHub

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
Merged

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a242ab
fix clangcl warnings in socketmodule.c
chris-eibl Mar 28, 2025
cecf1f9
Merge remote-tracking branch 'upstream/main' into fix_clangcl_socketm…
chris-eibl Jun 9, 2025
21e49ef
indent the _Py_COMP_* macros like the code they guard
chris-eibl Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions Modules/socketmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,12 +671,6 @@ select_error(void)
# define SOCK_INPROGRESS_ERR EINPROGRESS
#endif

#ifdef _MSC_VER
# define SUPPRESS_DEPRECATED_CALL __pragma(warning(suppress: 4996))
#else
# define SUPPRESS_DEPRECATED_CALL
#endif

/* Convenience function to raise an error according to errno
and return a NULL pointer from a function. */

Expand Down Expand Up @@ -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]

res = WSAIoctl(get_sock_fd(s), SIO_TCP_SET_ACK_FREQUENCY, &flag,
sizeof(flag), NULL, 0, &dummy, NULL, NULL);
if (res >= 0) {
Expand Down Expand Up @@ -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.

_Py_COMP_DIAG_IGNORE_DEPR_DECLS
h = gethostbyname(name);
_Py_COMP_DIAG_POP
#endif /* HAVE_GETHOSTBYNAME_R */
Py_END_ALLOW_THREADS
/* Some C libraries would require addr.__ss_family instead of
Expand Down Expand Up @@ -6171,8 +6167,10 @@ socket_gethostbyaddr(PyObject *self, PyObject *args)
#ifdef USE_GETHOSTBYNAME_LOCK
PyThread_acquire_lock(netdb_lock, 1);
#endif
SUPPRESS_DEPRECATED_CALL
_Py_COMP_DIAG_PUSH
_Py_COMP_DIAG_IGNORE_DEPR_DECLS
h = gethostbyaddr(ap, al, af);
_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.

Py_END_ALLOW_THREADS
ret = gethost_common(state, h, SAS2SA(&addr), sizeof(addr), af);
Expand Down Expand Up @@ -6649,8 +6647,10 @@ _socket_socket_inet_aton_impl(PySocketSockObject *self, const char *ip_addr)
packed_addr = INADDR_BROADCAST;
} else {

SUPPRESS_DEPRECATED_CALL
_Py_COMP_DIAG_PUSH
_Py_COMP_DIAG_IGNORE_DEPR_DECLS
packed_addr = inet_addr(ip_addr);
_Py_COMP_DIAG_POP

if (packed_addr == INADDR_NONE) { /* invalid address */
PyErr_SetString(PyExc_OSError,
Expand Down Expand Up @@ -6693,8 +6693,10 @@ _socket_socket_inet_ntoa_impl(PySocketSockObject *self, Py_buffer *packed_ip)
memcpy(&packed_addr, packed_ip->buf, packed_ip->len);
PyBuffer_Release(packed_ip);

SUPPRESS_DEPRECATED_CALL
_Py_COMP_DIAG_PUSH
_Py_COMP_DIAG_IGNORE_DEPR_DECLS
return PyUnicode_FromString(inet_ntoa(packed_addr));
_Py_COMP_DIAG_POP
}
#endif // HAVE_INET_NTOA

Expand Down
Loading