Skip to content

Commit 572015c

Browse files
committed
refactor(cuda.core): rename register_cuda_log_bridge to register_cuda_error_log
Matches CUDA's own Error Log Management terminology (cuLogs* API). Refs: NVIDIA#671
1 parent a84e6c0 commit 572015c

3 files changed

Lines changed: 23 additions & 23 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
args_viewable_as_strided_memory,
1919
)
2020
from cuda.core.utils._logging import (
21-
register_cuda_log_bridge,
22-
unregister_cuda_log_bridge,
21+
register_cuda_error_log,
22+
unregister_cuda_error_log,
2323
)
2424
from cuda.core.utils._program_cache import (
2525
FileStreamProgramCache,
@@ -42,6 +42,6 @@
4242
"discard_prefetch_batch",
4343
"make_program_cache_key",
4444
"prefetch_batch",
45-
"register_cuda_log_bridge",
46-
"unregister_cuda_log_bridge",
45+
"register_cuda_error_log",
46+
"unregister_cuda_error_log",
4747
]

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from cuda.bindings import driver as _driver
2626
from cuda.core._utils.cuda_utils import handle_return
2727

28-
__all__ = ["register_cuda_log_bridge", "unregister_cuda_log_bridge"]
28+
__all__ = ["register_cuda_error_log", "unregister_cuda_error_log"]
2929

3030
# C callback signature expected by cuLogsRegisterCallback:
3131
# void callback(void *userData, CUlogLevel logLevel, char *message, size_t length)
@@ -45,12 +45,12 @@
4545

4646
# User-supplied hook that customizes how each driver log message is
4747
# displayed/handled; see the ``callback`` parameter of
48-
# :func:`register_cuda_log_bridge`.
48+
# :func:`register_cuda_error_log`.
4949
#
5050
# callback(logger, level, message) -> None
5151
#
5252
# ``logger`` is the same :class:`logging.Logger` passed to (or defaulted by)
53-
# :func:`register_cuda_log_bridge`, ``level`` is the already-mapped
53+
# :func:`register_cuda_error_log`, ``level`` is the already-mapped
5454
# ``logging.ERROR`` / ``logging.WARNING`` level, and ``message`` is the
5555
# decoded driver log text (without the ``[CUDA Driver]`` prefix added by the
5656
# default formatter).
@@ -86,12 +86,12 @@ def _on_log(_user_data, log_level, message_ptr, length):
8686
py_level = _CUDA_LEVEL_TO_PY_LEVEL.get(log_level, logging.ERROR)
8787
emit(logger, py_level, msg)
8888
except Exception:
89-
logger.exception("cuda_log_bridge: error while forwarding driver log")
89+
logger.exception("cuda_error_log: error while forwarding driver log")
9090

9191
return _CUlogsCallback_functype(_on_log)
9292

9393

94-
def register_cuda_log_bridge(
94+
def register_cuda_error_log(
9595
logger: logging.Logger | None = None,
9696
callback: Optional[LogCallback] = None,
9797
) -> None:
@@ -148,9 +148,9 @@ def register_cuda_log_bridge(
148148
_callback_handle = handle
149149

150150

151-
def unregister_cuda_log_bridge() -> None:
151+
def unregister_cuda_error_log() -> None:
152152
"""Unregister the bridge previously installed by
153-
:func:`register_cuda_log_bridge`.
153+
:func:`register_cuda_error_log`.
154154
155155
Idempotent: safe to call even if no bridge is currently registered.
156156

‎cuda_core/tests/test_cuda_log_bridge.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
import pytest
1212

1313
from cuda.bindings import driver
14-
from cuda.core.utils import register_cuda_log_bridge, unregister_cuda_log_bridge
14+
from cuda.core.utils import register_cuda_error_log, unregister_cuda_error_log
1515

1616

1717
@pytest.fixture(autouse=True)
1818
def teardown_bridge():
1919
yield
2020
# Guarantee the callback is unregistered after every test, so a leaked
2121
# bridge/slot from one test can't affect later ones.
22-
unregister_cuda_log_bridge()
22+
unregister_cuda_error_log()
2323

2424

2525
# 使用方式1: 调用 register(logger), 通过 caplog 捕获 driver log
@@ -30,7 +30,7 @@ def test_cuda_driver_log_captured_via_caplog(caplog):
3030
# 2. 注册桥接,将驱动日志路由到用户提供的 logger
3131
logger_name = "cuda.driver.caplog_test"
3232
logger_obj = logging.getLogger(logger_name)
33-
register_cuda_log_bridge(logger_obj)
33+
register_cuda_error_log(logger_obj)
3434

3535
# 3. 触发驱动错误:ordinal 9999 必然越界,驱动会写入两条 [E] 日志
3636
with caplog.at_level(logging.ERROR, logger=logger_name):
@@ -67,7 +67,7 @@ def test_cuda_driver_log_written_to_file(tmp_path):
6767

6868
try:
6969
# 3. 注册桥接,将驱动日志路由到该 logger
70-
register_cuda_log_bridge(logger_obj)
70+
register_cuda_error_log(logger_obj)
7171

7272
# 4. 触发驱动错误:ordinal 9999 必然越界,驱动会写入两条 [E] 日志
7373
driver.cuDeviceGet(9999)
@@ -97,15 +97,15 @@ def test_cuda_driver_log_rebind_logger(caplog):
9797
name_a, name_b = "cuda.driver.rebind_a", "cuda.driver.rebind_b"
9898

9999
# 先绑定 logger_a,确认能收到日志
100-
register_cuda_log_bridge(logging.getLogger(name_a))
100+
register_cuda_error_log(logging.getLogger(name_a))
101101
with caplog.at_level(logging.ERROR, logger=name_a):
102102
driver.cuDeviceGet(9999)
103103
assert any(r.name == name_a for r in caplog.records)
104104

105105
# 换绑到 logger_b:必须先 unregister 释放驱动侧 slot,再用新 logger register
106-
unregister_cuda_log_bridge()
106+
unregister_cuda_error_log()
107107
caplog.clear()
108-
register_cuda_log_bridge(logging.getLogger(name_b))
108+
register_cuda_error_log(logging.getLogger(name_b))
109109
with caplog.at_level(logging.ERROR, logger=name_b):
110110
driver.cuDeviceGet(9999)
111111

@@ -119,7 +119,7 @@ def test_cuda_driver_log_level_filtering(caplog):
119119
driver.cuInit(0)
120120

121121
logger_name = "cuda.driver.level_test"
122-
register_cuda_log_bridge(logging.getLogger(logger_name))
122+
register_cuda_error_log(logging.getLogger(logger_name))
123123

124124
# 阈值设为 CRITICAL:ERROR 级别的驱动日志应被过滤,caplog 收不到任何记录
125125
with caplog.at_level(logging.CRITICAL, logger=logger_name):
@@ -150,7 +150,7 @@ def emit(self, record):
150150
logger_obj.addHandler(counter_handler)
151151

152152
try:
153-
register_cuda_log_bridge(logger_obj)
153+
register_cuda_error_log(logger_obj)
154154
driver.cuDeviceGet(9999)
155155
finally:
156156
logger_obj.removeHandler(counter_handler)
@@ -173,7 +173,7 @@ def my_callback(logger, level, message):
173173

174174
# (c) register 时传入 callback,覆盖掉内部默认的
175175
# logger.log(level, "[CUDA Driver] %s", message) 转发逻辑
176-
register_cuda_log_bridge(logger_obj, callback=my_callback)
176+
register_cuda_error_log(logger_obj, callback=my_callback)
177177

178178
# 1. logging 默认的 WARNING 级别阈值下,DEBUG 级别的驱动日志会被过滤掉,
179179
# caplog 收不到任何记录
@@ -197,7 +197,7 @@ def my_callback(logger, level, message):
197197
f"Expected every record logged as DEBUG via my_callback, got levels: {[r.levelname for r in records]}"
198198
)
199199

200-
# 验证消息前缀是 logger name(而不是 register_cuda_log_bridge 默认的 "[CUDA Driver] " 前缀)
200+
# 验证消息前缀是 logger name(而不是 register_cuda_error_log 默认的 "[CUDA Driver] " 前缀)
201201
messages = [r.message for r in records]
202202
assert any(m.startswith(f"{logger_name}: ") for m in messages), (
203203
f"Expected messages prefixed with '{logger_name}: ', got:\n{messages}"
@@ -210,4 +210,4 @@ def my_callback(logger, level, message):
210210
# callback 必须是可调用对象或 None,否则应尽早报错
211211
def test_cuda_driver_log_callback_must_be_callable_or_none():
212212
with pytest.raises(TypeError):
213-
register_cuda_log_bridge(logging.getLogger("cuda.driver.bad_callback_test"), callback="not-callable")
213+
register_cuda_error_log(logging.getLogger("cuda.driver.bad_callback_test"), callback="not-callable")

0 commit comments

Comments
 (0)