Skip to content

Commit 851f5dd

Browse files
committed
refactor(cuda.core): rename LogCallback to PyLogCallback
Also drop the stale userData TODO comment, move the CUlogLevel->logging level map into _default_callback (its only user), and rename its log_level param to cu_log_level for clarity. Refs NVIDIA#671
1 parent 738cf8b commit 851f5dd

1 file changed

Lines changed: 10 additions & 23 deletions

File tree

‎cuda_core/cuda/core/utils/_logging.py‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,38 +20,25 @@
2020

2121
# C callback signature for cuLogsRegisterCallback:
2222
# void callback(void *userData, CUlogLevel logLevel, char *message, size_t length)
23-
# TODO: support a user-supplied userData.
2423
_CUlogsCallback_functype = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_int, ctypes.c_char_p, ctypes.c_size_t)
24+
PyLogCallback = Callable[[Optional[int], int, bytes, int], None]
2525

26-
# CUlogLevel only defines two levels today (CUDA 12.9 cuLogs* API).
27-
_CUDA_LEVEL_TO_PY_LEVEL = {
28-
int(_driver.CUlogLevel.CU_LOG_LEVEL_ERROR): logging.ERROR,
29-
int(_driver.CUlogLevel.CU_LOG_LEVEL_WARNING): logging.WARNING,
30-
}
31-
32-
# User callback for `register_cuda_error_log`; signature matches the C
33-
# callback 1:1: callback(user_data, log_level, message, length) -> None.
34-
# user_data is the raw void* (None/0 today); log_level is the raw,
35-
# unmapped CUlogLevel; message is raw undecoded bytes; length is its byte
36-
# count. Decoding/level-mapping is the callback's job (see
37-
# `_default_callback`). Needs `logger`? Close over it.
38-
LogCallback = Callable[[Optional[int], int, bytes, int], None]
39-
40-
_lock = threading.Lock()
4126
# Keep a reference while registered, or GC'ing it leaves the driver with
4227
# a dangling function pointer -> crash on the next log message.
28+
_lock = threading.Lock()
4329
_c_callback: ctypes._FuncPointer | None = None
4430
_callback_handle = None # CUlogsCallbackHandle, needed to unregister
4531

46-
47-
def _make_c_callback(logger: logging.Logger, callback: Optional[LogCallback]) -> ctypes._FuncPointer:
32+
def _make_c_callback(logger: logging.Logger, callback: Optional[PyLogCallback]) -> ctypes._FuncPointer:
4833
"""Build the ctypes C callback passed to cuLogsRegisterCallback."""
4934

50-
def _default_callback(user_data: Optional[int], log_level: int, message: bytes, length: int) -> None:
51-
"""Decode, map the level, and forward into ``logger`` (closed over)."""
52-
del user_data, length
35+
def _default_callback(user_data: Optional[int], cu_log_level: int, message: bytes, length: int) -> None:
36+
cuda_level_to_py_level = {
37+
int(_driver.CUlogLevel.CU_LOG_LEVEL_ERROR): logging.ERROR,
38+
int(_driver.CUlogLevel.CU_LOG_LEVEL_WARNING): logging.WARNING,
39+
}
5340
msg = message.decode("utf-8", errors="replace").rstrip("\n")
54-
py_level = _CUDA_LEVEL_TO_PY_LEVEL.get(log_level, logging.ERROR)
41+
py_level = cuda_level_to_py_level.get(cu_log_level, logging.ERROR)
5542
logger.log(py_level, "[CUDA Driver] %s", msg)
5643

5744
emit = callback if callback is not None else _default_callback
@@ -71,7 +58,7 @@ def _on_log(user_data, log_level, message_ptr, length):
7158

7259
def register_cuda_error_log(
7360
logger: logging.Logger | None = None,
74-
callback: Optional[LogCallback] = None,
61+
callback: Optional[PyLogCallback] = None,
7562
) -> None:
7663
"""Register a bridge that forwards CUDA driver ``cuLogs*`` messages to
7764
a Python :class:`logging.Logger`.

0 commit comments

Comments
 (0)