Skip to content
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

connection: fix getpid() call on disconnect #166

Merged
merged 1 commit into from
Dec 24, 2024
Merged

connection: fix getpid() call on disconnect #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 21 additions & 21 deletions valkey/connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
import copy
import os
import socket
import ssl
import sys
import threading
import weakref
from abc import abstractmethod
from itertools import chain

# We need to explicitly import `getpid` from `os` instead of importing `os`. The
# reason for that is that Valkey class contains a __del__ method that causes the
# call chain:
# 1. Valkey.close()
# 2. ConnectionPool.disconnect()
# 3. ConnectionPool._checkpid()
# 4. os.getpid()
#
# If os.getpid is garbage collected before Valkey, then the __del__
# method will raise an AttributeError when trying to call os.getpid.
# It wasn't an issue in practice until Python REPL was reworked in 3.13
# to collect all globals at the end of the session, which caused
# os.getpid to be garbage collected before Valkey.
from os import getpid
from queue import Empty, Full, LifoQueue
from time import time
from typing import Any, Callable, List, Optional, Sequence, Type, Union
Expand Down Expand Up @@ -178,7 +192,7 @@ def __init__(
"1. 'password' and (optional) 'username'\n"
"2. 'credential_provider'"
)
self.pid = os.getpid()
self.pid = getpid()
self.db = db
self.client_name = client_name
self.lib_name = lib_name
Expand Down Expand Up @@ -445,7 +459,7 @@ def disconnect(self, *args):
if conn_sock is None:
return

if os.getpid() == self.pid:
if getpid() == self.pid:
try:
conn_sock.shutdown(socket.SHUT_RDWR)
except (OSError, TypeError):
Expand Down Expand Up @@ -1011,20 +1025,6 @@ def __init__(
self.connection_kwargs = connection_kwargs
self.max_connections = max_connections

# We need to preserve the pointer to os.getpid because Valkey class
# contains a __del__ method that causes the call chain:
# 1. Valkey.close()
# 2. ConnectionPool.disconnect()
# 3. ConnectionPool._checkpid()
# 4. os.getpid()
#
# If os.getpid is garbage collected before Valkey, then the __del__
# method will raise an AttributeError when trying to call os.getpid.
# It wasn't an issue in practice until Python REPL was reworked in 3.13
# to collect all globals at the end of the session, which caused
# os.getpid to be garbage collected before Valkey.
self._getpid = os.getpid

# a lock to protect the critical section in _checkpid().
# this lock is acquired when the process id changes, such as
# after a fork. during this time, multiple threads in the child
Expand Down Expand Up @@ -1057,7 +1057,7 @@ def reset(self) -> None:
# release _fork_lock. when each of these threads eventually acquire
# _fork_lock, they will notice that another thread already called
# reset() and they will immediately release _fork_lock and continue on.
self.pid = os.getpid()
self.pid = getpid()

def _checkpid(self) -> None:
# _checkpid() attempts to keep ConnectionPool fork-safe on modern
Expand Down Expand Up @@ -1094,14 +1094,14 @@ def _checkpid(self) -> None:
# seconds to acquire _fork_lock. if _fork_lock cannot be acquired in
# that time it is assumed that the child is deadlocked and a
# valkey.ChildDeadlockedError error is raised.
if self.pid != self._getpid():
if self.pid != getpid():
acquired = self._fork_lock.acquire(timeout=5)
if not acquired:
raise ChildDeadlockedError
# reset() the instance for the new process if another thread
# hasn't already done so
try:
if self.pid != self._getpid():
if self.pid != getpid():
self.reset()
finally:
self._fork_lock.release()
Expand Down Expand Up @@ -1307,7 +1307,7 @@ def reset(self):
# release _fork_lock. when each of these threads eventually acquire
# _fork_lock, they will notice that another thread already called
# reset() and they will immediately release _fork_lock and continue on.
self.pid = os.getpid()
self.pid = getpid()

def make_connection(self):
"Make a fresh connection."
Expand Down
Loading