Skip to content

gh-123797: Check for runtime availability of ptsname_r on macos #123806

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 4 commits into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
7 changes: 7 additions & 0 deletions Lib/test/test_posix.py
Original file line number Diff line number Diff line change
Expand Up @@ -2140,6 +2140,13 @@ def test_stat(self):
with self.assertRaisesRegex(NotImplementedError, "dir_fd unavailable"):
os.stat("file", dir_fd=0)

def test_ptsname_r(self):
self._verify_available("HAVE_PTSNAME_R")
if self.mac_ver >= (10, 13, 4):
self.assertIn("HAVE_PTSNAME_R", posix._have_functions)
else:
self.assertNotIn("HAVE_PTSNAME_R", posix._have_functions)

def test_access(self):
self._verify_available("HAVE_FACCESSAT")
if self.mac_ver >= (10, 10):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Check for runtime availability of ``ptsname_r`` function on macos.
51 changes: 41 additions & 10 deletions Modules/posixmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
# define HAVE_PWRITEV_RUNTIME __builtin_available(macOS 11.0, iOS 14.0, tvOS 14.0, watchOS 7.0, *)
# define HAVE_MKFIFOAT_RUNTIME __builtin_available(macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0, *)
# define HAVE_MKNODAT_RUNTIME __builtin_available(macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0, *)
# define HAVE_PTSNAME_R_RUNTIME __builtin_available(macOS 10.13.4, iOS 11.3, tvOS 11.3, watchOS 4.3, *)

# define HAVE_POSIX_SPAWN_SETSID_RUNTIME __builtin_available(macOS 10.15, *)

Expand Down Expand Up @@ -206,6 +207,10 @@
# define HAVE_MKNODAT_RUNTIME (mknodat != NULL)
# endif

# ifdef HAVE_PTSNAME_R
# define HAVE_PTSNAME_R_RUNTIME (ptsname_r != NULL)
# endif

#endif

#ifdef HAVE_FUTIMESAT
Expand All @@ -231,6 +236,7 @@
# define HAVE_PWRITEV_RUNTIME 1
# define HAVE_MKFIFOAT_RUNTIME 1
# define HAVE_MKNODAT_RUNTIME 1
# define HAVE_PTSNAME_R_RUNTIME 1
#endif


Expand Down Expand Up @@ -8635,6 +8641,18 @@ os_unlockpt_impl(PyObject *module, int fd)
#endif /* HAVE_UNLOCKPT */

#if defined(HAVE_PTSNAME) || defined(HAVE_PTSNAME_R)
static PyObject *
from_ptsname(int fd)
{
char *name = ptsname(fd);
/* POSIX manpage: Upon failure, ptsname() shall return a null pointer and may set errno.
*MAY* set errno? Hmm... */
if (name == NULL) {
return posix_error();
}
return PyUnicode_DecodeFSDefault(name);
}

/*[clinic input]
os.ptsname

Expand All @@ -8656,22 +8674,28 @@ os_ptsname_impl(PyObject *module, int fd)
int ret;
char name[MAXPATHLEN+1];

ret = ptsname_r(fd, name, sizeof(name));
if (HAVE_PTSNAME_R_RUNTIME) {
ret = ptsname_r(fd, name, sizeof(name));
}
else {
#if defined(HAVE_PTSNAME)
// fallback to `ptsname` if `ptsname_r` is not available in runtime.
return from_ptsname(fd);
#else
// unknown error:
// both ptsname_r and ptsname are not available for some reason.
ret = -1;
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a "cannot happen" case: ptsname is available on all versions of macOS where configure detects ptsname_r.

I'd either drop drop the guard for the block above or replace this bit by an #error.

(And regardless ret = -1 is wrong, the value should be an errno value such as ENOSYS).

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, thanks for the review! 👍

Copy link
Member

Choose a reason for hiding this comment

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

This is a "cannot happen" case: ptsname is available on all versions of macOS where configure detects ptsname_r.

Is there a macOS or iOS platform where ptsname() and ptsname_r() are not available?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a macOS or iOS platform where ptsname() and ptsname_r() are not available?
In short, no.

ptsname_r() is available on macOS 10.13.4 and iOS 11.3 (and later), ptsname() has been available from the start. Or at least, there are no availability annotations in Apple's headers which is a good indication that the API was available from the start.

#endif /* HAVE_PTSNAME */
}
if (ret != 0) {
errno = ret;
return posix_error();
}
#else
char *name;

name = ptsname(fd);
/* POSIX manpage: Upon failure, ptsname() shall return a null pointer and may set errno.
*MAY* set errno? Hmm... */
if (name == NULL)
return posix_error();
#endif /* HAVE_PTSNAME_R */

return PyUnicode_DecodeFSDefault(name);
#else
return from_ptsname(fd);
#endif /* HAVE_PTSNAME_R */
}
#endif /* defined(HAVE_PTSNAME) || defined(HAVE_PTSNAME_R) */

Expand Down Expand Up @@ -17751,6 +17775,9 @@ PROBE(probe_futimens, HAVE_FUTIMENS_RUNTIME)
PROBE(probe_utimensat, HAVE_UTIMENSAT_RUNTIME)
#endif

#ifdef HAVE_PTSNAME_R
PROBE(probe_ptsname_r, HAVE_PTSNAME_R_RUNTIME)
#endif



Expand Down Expand Up @@ -17891,6 +17918,10 @@ static const struct have_function {
{ "HAVE_UTIMENSAT", probe_utimensat },
#endif

#ifdef HAVE_PTSNAME_R
{ "HAVE_PTSNAME_R", probe_ptsname_r },
#endif

#ifdef MS_WINDOWS
{ "MS_WINDOWS", NULL },
#endif
Expand Down
Loading