Skip to content

Use a single APC and completion routine #14924

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
seanbudd merged 12 commits into from
Jun 2, 2023
Merged

Use a single APC and completion routine #14924

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
39c0df5
Use a single APC and completion routine
May 11, 2023
894fa39
Linting
May 12, 2023
b5f9f42
use proper cast
LeonarddeR May 12, 2023
12e549b
Review actions
LeonarddeR May 15, 2023
813a565
Fixup
LeonarddeR May 15, 2023
f90df1c
Merge remote-tracking branch 'origin/master' into hwIoSingleAPC
LeonarddeR May 19, 2023
41bd560
Import LPOVERLAPPED and OVERLAPPED directly, more documentation about…
LeonarddeR May 19, 2023
a939279
Merge remote-tracking branch 'origin/master' into hwIoSingleAPC
LeonarddeR May 31, 2023
e7a93e2
Readd autoDeleteApcReferences
LeonarddeR May 31, 2023
10ade40
Rename apcsWillBeStronglyReferenced
LeonarddeR Jun 1, 2023
5228a8c
Merge remote-tracking branch 'origin/master' into hwIoSingleAPC
seanbudd Jun 2, 2023
27b655f
update changes
seanbudd Jun 2, 2023
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
Prev Previous commit
Next Next commit
Import LPOVERLAPPED and OVERLAPPED directly, more documentation about… 
… OCR store
  • Loading branch information
@LeonarddeR
LeonarddeR committed May 19, 2023
commit 41bd560cdb63f015c3a000d9b98fe0dfa77bd107
20 changes: 12 additions & 8 deletions source/hwIo/ioThread.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import winKernel
import typing
from logHandler import log
import serial.win32
from serial.win32 import OVERLAPPED, LPOVERLAPPED
from contextlib import contextmanager
from extensionPoints.util import AnnotatableWeakref, BoundMethodWeakref
from inspect import ismethod
Expand All @@ -23,23 +23,23 @@
None,
ctypes.wintypes.DWORD,
ctypes.wintypes.DWORD,
serial.win32.LPOVERLAPPED
LPOVERLAPPED
)
ApcT = typing.Callable[[int], None]
ApcIdT = int
CompletionRoutineIdT = int
CompletionRoutineT = typing.Callable[[int, int, serial.win32.LPOVERLAPPED], None]
OverlappedStructAddressT = int
CompletionRoutineT = typing.Callable[[int, int, LPOVERLAPPED], None]
ApcStoreT = typing.Dict[
ApcIdT,
typing.Tuple[
typing.Union[ApcT, BoundMethodWeakref[ApcT], AnnotatableWeakref[ApcT]], ApcIdT
]
]
CompletionRoutineStoreTypeT = typing.Dict[
CompletionRoutineIdT,
OverlappedStructAddressT,
typing.Tuple[
typing.Union[BoundMethodWeakref[CompletionRoutineT], AnnotatableWeakref[CompletionRoutineT]],
serial.win32.OVERLAPPED
OVERLAPPED
]
]
apcsWillBeStronglyReferenced = version_year < 2024 and NVDAState._allowDeprecatedAPI()
Expand Down Expand Up @@ -76,6 +76,10 @@ class IoThread(threading.Thread):
#: Store of Python functions to be called as Overlapped Completion Routine.
#: This allows us to have a single completion routine in the class rather than on
#: each instance, which prevents reference cycles.
#: Note that we use the address of the OVERLAPPED structure as key in this store,
#: eventhough the structure is also stored in the value.
#: The OVERLAPPED structure can't be used as key because ctypes does not have OOR (original object return),
#: it constructs a new, equivalent object each time you retrieve the contents of a LPOVERLAPPED.
_completionRoutineStore: CompletionRoutineStoreTypeT = {}

def __init__(self):
Expand Down Expand Up @@ -114,7 +118,7 @@ def _internalApc(param: ApcIdT):
def _internalCompletionRoutine(
error: int,
numberOfBytes: int,
overlapped: serial.win32.LPOVERLAPPED
overlapped: LPOVERLAPPED
):
threadinst = threading.current_thread()
if not isinstance(threadinst, IoThread):
Expand Down Expand Up @@ -218,7 +222,7 @@ def setWaitableTimer(
def queueAsCompletionRoutine(
Comment thread
seanbudd marked this conversation as resolved.
self,
func: CompletionRoutineT,
overlapped: serial.win32.OVERLAPPED,
overlapped: OVERLAPPED,
):
"""safely queues a Python function call as an overlapped completion routine.
A weak reference to the Python function is saved in a store on the IoThread instance
Expand Down