Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-132124: improve safety nets for creating AF_UNIX socket files#134085

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from1 commit
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
PrevPrevious commit
NextNext commit
emit a warning if system-wide temporary directory is used
  • Loading branch information
@picnixz
picnixz committedMay 17, 2025
commit84f7020eaaae80fb9064af009f796b25783565d8
93 changes: 67 additions & 26 deletionsLib/multiprocessing/util.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@
from . import process

__all__ = [
'sub_debug', 'debug', 'info', 'sub_warning', 'get_logger',
'sub_debug', 'debug', 'info', 'sub_warning', 'warn', 'get_logger',
Copy link
Member

Choose a reason for hiding this comment

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

note to self: I'm going to leave 'warn' out of__all__ and rename the function to_warn as a modification to our 3.13 backport as it'd technically be an API change in a bugfix release otherwise.

'log_to_stderr', 'get_temp_dir', 'register_after_fork',
'is_exiting', 'Finalize', 'ForkAwareThreadLock', 'ForkAwareLocal',
'close_all_fds_except', 'SUBDEBUG', 'SUBWARNING',
Expand All@@ -34,6 +34,7 @@
DEBUG = 10
INFO = 20
SUBWARNING = 25
WARNING = 30

LOGGER_NAME = 'multiprocessing'
DEFAULT_LOGGING_FORMAT = '[%(levelname)s/%(processName)s] %(message)s'
Expand All@@ -53,6 +54,10 @@ def info(msg, *args):
if _logger:
_logger.log(INFO, msg, *args, stacklevel=2)

def warn(msg, *args):
if _logger:
_logger.log(WARNING, msg, *args, stacklevel=2)

def sub_warning(msg, *args):
if _logger:
_logger.log(SUBWARNING, msg, *args, stacklevel=2)
Expand DownExpand Up@@ -121,17 +126,17 @@ def is_abstract_socket_namespace(address):
# Function returning a temp directory which will be removed on exit
#

# Maximum length of a socket file path is usually between 92 and 108 [1].
#BSD-based operating systems usuallyuse104 (OpenBSD, FreeBSD, macOS)
#and Linux uses108[2].
# Maximum length of a socket file path is usually between 92 and 108 [1],
#but Linux is known tousea size of 108 [2]. BSD-based systems usually
#use a size of 104 or108and Windows does not create AF_UNIX sockets.
#
# [1]: https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/sys_un.h.html
# [2]: https://man7.org/linux/man-pages/man7/unix.7.html.

if sys.platform == 'linux':
_SUN_PATH_MAX = 104
elif sys.platform.startswith(('openbsd', 'freebsd')):
_SUN_PATH_MAX = 108
elif sys.platform.startswith(('openbsd', 'freebsd')):
_SUN_PATH_MAX = 104
else:
# On Windows platforms, we do not create AF_UNIX sockets.
_SUN_PATH_MAX = None if os.name == 'nt' else 92
Expand All@@ -145,31 +150,67 @@ def _remove_temp_dir(rmtree, tempdir):
if current_process is not None:
current_process._config['tempdir'] = None

def _get_base_temp_dir(tempfile):
"""Get a temporary directory where socket files will be created.

To prevent additional imports, pass a pre-imported 'tempfile' module.
"""
if os.name == 'nt':
return None
# Most of the time, the default temporary directory is /tmp. Thus,
# listener sockets files "$TMPDIR/pymp-XXXXXXXX/sock-XXXXXXXX" do
# not have a path length exceeding SUN_PATH_MAX.
#
# If users specify their own temporary directory, we may be unable
# to create those files. Therefore, we fall back to the system-wide
# temporary directory /tmp, assumed to exist on POSIX systems.
#
# See https://github.com/python/cpython/issues/132124.
base_tempdir = tempfile.gettempdir()
# Files created in a temporary directory are suffixed by a string
# generated by tempfile._RandomNameSequence, which, by design,
# is 8 characters long.
#
# Thus, the length of socket filename will be:
#
# len(base_tempdir + '/pymp-XXXXXXXX' + '/sock-XXXXXXXX')
sun_path_len = len(base_tempdir) + 14 + 14
if sun_path_len <= _SUN_PATH_MAX:
return base_tempdir
# Fallback to the default system-wide temporary directory.
# This ignores user-defined environment variables.
#
# On POSIX systems, /tmp MUST be writable by any application [1].
# We however emit a warning if this is not the case to prevent
# obscure errors later in the execution.
#
# On some legacy systems, /var/tmp and /usr/tmp can be present
# and will be used instead.
#
# [1]: https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch03s18.html
dirlist = ['/tmp', '/var/tmp', '/usr/tmp']
try:
base_system_tempdir = tempfile._get_default_tempdir(dirlist)
except FileNotFoundError:
warn("Process-wide temporary directory %r will not be usable for "
"creating socket files and no usable system-wide temporary "
"directory was found in %r", base_tempdir, dirlist)
# At this point, the system-wide temporary directory is not usable
# but we may assume that the user-defined one is, even if we will
# not be able to write socket files out there.
return base_tempdir
warn("Ignoring user-defined temporary directory: %s", base_tempdir)
# at most max(map(len, dirlist)) + 14 + 14 = 36 characters
assert len(base_system_tempdir) + 14 + 14 <= _SUN_PATH_MAX
return base_system_tempdir

def get_temp_dir():
# get name of a temp directory which will be automatically cleaned up
tempdir = process.current_process()._config.get('tempdir')
if tempdir is None:
import shutil, tempfile
if os.name == 'nt':
tempdir = tempfile.mkdtemp(prefix='pymp-')
else:
# Most of the time, the root temporary directory is /tmp, and thus
# listener sockets files "$TMPDIR/pymp-XXXXXXXX/sock-XXXXXXXX"
# do not have a path length exceeding SUN_PATH_MAX.
#
# If users specify their own temporary directory, we may be unable
# to create those files. Therefore, we fall back to the system-wide
# temporary directory /tmp, assumed to exist on POSIX systems.
#
# See https://github.com/python/cpython/issues/132124.
base_tempdir = tempfile.gettempdir()
# len(base_tempdir) + len('/pymp-XXXXXXXX') + len('/sock-XXXXXXXX')
sun_path_len = len(base_tempdir) + 14 + 14
if sun_path_len > _SUN_PATH_MAX:
# fallback to the system-wide temporary directory,
# ignoring environment variables.
base_tempdir = '/tmp'
tempdir = tempfile.mkdtemp(prefix='pymp-', dir=base_tempdir)
base_tempdir = _get_base_temp_dir(tempfile)
tempdir = tempfile.mkdtemp(prefix='pymp-', dir=base_tempdir)
info('created temp directory %s', tempdir)
# keep a strong reference to shutil.rmtree(), since the finalizer
# can be called late during Python shutdown
Expand Down
5 changes: 3 additions & 2 deletionsLib/tempfile.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -180,7 +180,7 @@ def _candidate_tempdir_list():

return dirlist

def _get_default_tempdir():
def _get_default_tempdir(dirlist=None):
"""Calculate the default directory to use for temporary files.
This routine should be called exactly once.

Expand All@@ -190,7 +190,8 @@ def _get_default_tempdir():
service, the name of the test file must be randomized."""

namer = _RandomNameSequence()
dirlist = _candidate_tempdir_list()
if dirlist is None:
dirlist = _candidate_tempdir_list()

for dir in dirlist:
if dir != _os.curdir:
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp