Coverage for cuda/pathfinder/_dynamic_libs/search_platform.py: 95.62%

1# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 

2# SPDX-License-Identifier: Apache-2.0 

3 

4"""Platform abstraction for filesystem search steps. 

5 

6The goal is to keep :mod:`search_steps` platform-agnostic: it should not branch 

7on OS flags like ``IS_WINDOWS``. Instead, it calls through the single 

8``PLATFORM`` instance exported here. 

9""" 

10 

11from __future__ import annotations (empty)

12 

13import os (empty)

14from collections.abc import Sequence (empty)

15from dataclasses import dataclass (empty)

16from pathlib import PurePath (empty)

17from typing import Protocol, cast (empty)

18 

19from cuda.pathfinder._dynamic_libs.lib_descriptor import LibDescriptor (empty)

20from cuda.pathfinder._dynamic_libs.supported_nvidia_libs import is_suppressed_dll_file (empty)

21from cuda.pathfinder._utils.find_sub_dirs import find_sub_dirs_all_sitepackages (empty)

22from cuda.pathfinder._utils.platform_aware import IS_WINDOWS (empty)

23from cuda.pathfinder._utils.windows_arch import windows_pe_matches_arch, windows_python_arch (empty)

24 

25 

26def _no_such_file_in_sub_dirs( (empty)

27 sub_dirs: Sequence[str], file_description: str, error_messages: list[str], attachments: list[str] 

28) -> None: 

29 error_messages.append(f"No such file: {file_description}") 10 ctx1agFijklref

30 for sub_dir in find_sub_dirs_all_sitepackages(sub_dirs): 10 ctx1agFijklref

31 attachments.append(f' listdir("{sub_dir}"):') 7 ctx1ijklref

32 for node in sorted(os.listdir(sub_dir)): 7 ctx1ijklref

33 attachments.append(f" {node}") 6 ctx1ijklef

34 

35 

36def _find_descriptor_so_under_dir(dirpath: str, desc: LibDescriptor) -> str | None: (empty)

37 for soname in desc.linux_sonames: 31 ctx1ambcnoST2UVBCDE3GHIijklrJWXYZ01

38 path = os.path.join(dirpath, soname) 31 ctx1ambcnoST2UVBCDE3GHIijklrJWXYZ01

39 if os.path.isfile(path): 31 ctx1ambcnoST2UVBCDE3GHIijklrJWXYZ01

40 return path 22 ctx1ambcnoST2UV3GHIJWXYZ01

41 return None 9 ctx1BCDEijklr

42 

43 

44def _find_so_in_rel_dirs( (empty)

45 rel_dirs: tuple[str, ...], 

46 desc: LibDescriptor, 

47 file_description: str, 

48 error_messages: list[str], 

49 attachments: list[str], 

50) -> str | None: 

51 sub_dirs_searched: list[tuple[str, ...]] = [] 11 ctx1agGHIijklrJ

52 for rel_dir in rel_dirs: 11 ctx1agGHIijklrJ

53 sub_dir = PurePath(rel_dir).parts 11 ctx1agGHIijklrJ

54 for abs_dir in find_sub_dirs_all_sitepackages(sub_dir): 11 ctx1agGHIijklrJ

55 so_path = _find_descriptor_so_under_dir(abs_dir, desc) 9 ctx1GHIijklrJ

56 if so_path is not None: 9 ctx1GHIijklrJ

57 return so_path 4 ctx1GHIJ

58 sub_dirs_searched.append(sub_dir) 7 ctx1agijklr

59 for sub_dir in sub_dirs_searched: 7 ctx1agijklr

60 _no_such_file_in_sub_dirs(sub_dir, file_description, error_messages, attachments) 7 ctx1agijklr

61 return None 7 ctx1agijklr

62 

63 

64def _find_descriptor_dll_under_dir( (empty)

65 dirpath: str, 

66 desc: LibDescriptor, 

67 target_arch: str | None = None, 

68) -> str | None: 

69 def candidate_is_usable(path: str) -> bool: 34 ctx1ambcnoOwKLPQpMNqtusve456789fhyzAdx

70 if not os.path.isfile(path): 34 ctx1ambcnoOwKLPQpMNqtusve456789fhyzAdx

71 return False 22 ctx1ambcnopMNqtuse56789fhd

72 if is_suppressed_dll_file(os.path.basename(path)): 26 ctx1ambcnoOwKLPQpMNqtusv4yzAdx

73 return False 

74 return target_arch is None or windows_pe_matches_arch(path, target_arch) 26 ctx1ambcnoOwKLPQpMNqtusv4yzAdx

75 

76 for dll_basename in desc.windows_dlls: 34 ctx1ambcnoOwKLPQpMNqtusve456789fhyzAdx

77 path = os.path.join(dirpath, dll_basename) 34 ctx1ambcnoOwKLPQpMNqtusve456789fhyzAdx

78 if candidate_is_usable(path): 34 ctx1ambcnoOwKLPQpMNqtusve456789fhyzAdx

79 return path 24 ctx1ambcnoOwKLPQMNtusv4yzAdx

80 return None 11 ctx1pqe56789fhd

81 

82 

83def _find_dll_in_rel_dirs( (empty)

84 rel_dirs: tuple[str, ...], 

85 desc: LibDescriptor, 

86 target_arch: str, 

87 lib_searched_for: str, 

88 error_messages: list[str], 

89 attachments: list[str], 

90) -> str | None: 

91 sub_dirs_searched: list[tuple[str, ...]] = [] 9 ctx1agtFusvef

92 checked_arch = target_arch if desc.requires_windows_binary_arch_check else None 9 ctx1agtFusvef

93 for rel_dir in rel_dirs: 9 ctx1agtFusvef

94 sub_dir = PurePath(rel_dir).parts 9 ctx1agtFusvef

95 for abs_dir in find_sub_dirs_all_sitepackages(sub_dir): 9 ctx1agtFusvef

96 dll_name = _find_descriptor_dll_under_dir(abs_dir, desc, checked_arch) 6 ctx1tusvef

97 if dll_name is not None: 6 ctx1tusvef

98 return dll_name 4 ctx1tusv

99 sub_dirs_searched.append(sub_dir) 6 ctx1agFsef

100 for sub_dir in sub_dirs_searched: 5 ctx1agFef

101 _no_such_file_in_sub_dirs(sub_dir, lib_searched_for, error_messages, attachments) 5 ctx1agFef

102 return None 5 ctx1agFef

103 

104 

105class SearchPlatform(Protocol): (empty)

106 def lib_searched_for(self, desc: LibDescriptor) -> str: ... (empty)

107 

108 def site_packages_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: ... (empty)

109 

110 def conda_anchor_point(self, conda_prefix: str) -> str: ... (empty)

111 

112 def anchor_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: ... (empty)

113 

114 def install_root_env_vars(self, desc: LibDescriptor) -> tuple[str, ...]: ... (empty)

115 

116 def install_root_env_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: ... (empty)

117 

118 def program_files_root_globs(self, desc: LibDescriptor) -> tuple[str, ...]: ... (empty)

119 

120 def find_in_site_packages( (empty)

121 self, 

122 rel_dirs: tuple[str, ...], 

123 desc: LibDescriptor, 

124 error_messages: list[str], 

125 attachments: list[str], 

126 ) -> str | None: ... 

127 

128 def find_in_lib_dir( (empty)

129 self, 

130 lib_dir: str, 

131 desc: LibDescriptor, 

132 error_messages: list[str], 

133 attachments: list[str], 

134 ) -> str | None: ... 

135 

136 

137@dataclass(frozen=True, slots=True) (empty)

138class LinuxSearchPlatform: (empty)

139 def lib_searched_for(self, desc: LibDescriptor) -> str: (empty)

140 return " or ".join(desc.linux_sonames) 20 ctx1aRg)BCDEGHIijklrJ*+,

141 

142 def site_packages_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

143 return cast(tuple[str, ...], desc.site_packages_linux) 12 ctx1agGHIijklrJ-

144 

145 def conda_anchor_point(self, conda_prefix: str) -> str: (empty)

146 return conda_prefix 8 ctx1STUVBCDE

147 

148 def anchor_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

149 return cast(tuple[str, ...], desc.anchor_rel_dirs_linux) 20 ctx1amb%cno'ST./2UVBCDE3

150 

151 def install_root_env_vars(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

152 return cast(tuple[str, ...], desc.install_root_env_vars_linux) 10 ctx1abcRWXYZ01

153 

154 def install_root_env_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

155 return cast(tuple[str, ...], desc.install_root_env_rel_dirs_linux) 10 ctx1abcRWXYZ01

156 

157 def program_files_root_globs(self, _desc: LibDescriptor) -> tuple[str, ...]: (empty)

158 return () 2 ctx1bR

159 

160 def find_in_site_packages( (empty)

161 self, 

162 rel_dirs: tuple[str, ...], 

163 desc: LibDescriptor, 

164 error_messages: list[str], 

165 attachments: list[str], 

166 ) -> str | None: 

167 return _find_so_in_rel_dirs(rel_dirs, desc, self.lib_searched_for(desc), error_messages, attachments) 11 ctx1agGHIijklrJ

168 

169 def find_in_lib_dir( (empty)

170 self, 

171 lib_dir: str, 

172 desc: LibDescriptor, 

173 error_messages: list[str], 

174 attachments: list[str], 

175 ) -> str | None: 

176 so_path = _find_descriptor_so_under_dir(lib_dir, desc) 22 ctx1ambcnoST2UVBCDE3WXYZ01

177 if so_path is not None: 22 ctx1ambcnoST2UVBCDE3WXYZ01

178 return so_path 18 ctx1ambcnoST2UV3WXYZ01

179 error_messages.append(f"No such file: {self.lib_searched_for(desc)}") 4 ctx1BCDE

180 attachments.append(f' listdir("{lib_dir}"):') 4 ctx1BCDE

181 if not os.path.isdir(lib_dir): 4 ctx1BCDE

182 attachments.append(" DIRECTORY DOES NOT EXIST") 

183 else: 

184 for node in sorted(os.listdir(lib_dir)): 4 ctx1BCDE

185 attachments.append(f" {node}") 4 ctx1BCDE

186 return None 4 ctx1BCDE

187 

188 

189@dataclass(frozen=True, slots=True) (empty)

190class WindowsSearchPlatform: (empty)

191 target_arch: str (empty)

192 

193 def lib_searched_for(self, desc: LibDescriptor) -> str: (empty)

194 return f"known {desc.name} DLL" 15 ctx1aRgpqtFusvef:hd

195 

196 def site_packages_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

197 return cast(tuple[str, ...], desc.site_packages_windows.for_arch(self.target_arch)) 11 ctx1agwtFusvef!

198 

199 def conda_anchor_point(self, conda_prefix: str) -> str: (empty)

200 return os.path.join(conda_prefix, "Library") 3 ctx1KL!

201 

202 def anchor_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

203 return cast(tuple[str, ...], desc.anchor_rel_dirs_windows.for_arch(self.target_arch)) 24 ctx1amb%cno'O;=?@KLPQpMNq!dx

204 

205 def install_root_env_vars(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

206 if self.target_arch not in desc.supported_windows_arch: 11 ctx1abcRw#$hyzA

207 return () 

208 return cast(tuple[str, ...], desc.install_root_env_vars_windows) 11 ctx1abcRw#$hyzA

209 

210 def install_root_env_rel_dirs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

211 if self.target_arch not in desc.supported_windows_arch: 11 ctx1abcRw#$hyzA

212 return () 

213 return cast(tuple[str, ...], desc.install_root_env_rel_dirs_windows.for_arch(self.target_arch)) 11 ctx1abcRw#$hyzA

214 

215 def program_files_root_globs(self, desc: LibDescriptor) -> tuple[str, ...]: (empty)

216 program_files = os.environ.get("PROGRAMW6432") or os.environ.get("PROGRAMFILES") 5 ctx1bR!dx

217 if not program_files: 5 ctx1bR!dx

218 return () 

219 rel_globs = desc.program_files_root_globs_windows.for_arch(self.target_arch) 5 ctx1bR!dx

220 return tuple(os.path.join(program_files, rel_glob) for rel_glob in rel_globs) 5 ctx1bR!dx

221 

222 def find_in_site_packages( (empty)

223 self, 

224 rel_dirs: tuple[str, ...], 

225 desc: LibDescriptor, 

226 error_messages: list[str], 

227 attachments: list[str], 

228 ) -> str | None: 

229 return _find_dll_in_rel_dirs( 9 ctx1agtFusvef

230 rel_dirs, 

231 desc, 

232 self.target_arch, 

233 self.lib_searched_for(desc), 

234 error_messages, 

235 attachments, 

236 ) 

237 

238 def find_in_lib_dir( (empty)

239 self, 

240 lib_dir: str, 

241 desc: LibDescriptor, 

242 error_messages: list[str], 

243 attachments: list[str], 

244 ) -> str | None: 

245 target_arch = self.target_arch if desc.requires_windows_binary_arch_check else None 22 ctx1ambcnoOwKLPQpMNqhyzAdx

246 dll_name = _find_descriptor_dll_under_dir(lib_dir, desc, target_arch) 22 ctx1ambcnoOwKLPQpMNqhyzAdx

247 if dll_name is not None: 22 ctx1ambcnoOwKLPQpMNqhyzAdx

248 return dll_name 19 ctx1ambcnoOwKLPQMNyzAdx

249 lib_searched_for = self.lib_searched_for(desc) 4 ctx1pqhd

250 if target_arch is None: 4 ctx1pqhd

251 error_messages.append(f"No such file: {lib_searched_for}") 2 ctx1hd

252 else: 

253 error_messages.append(f"No {target_arch}-compatible PE file: {lib_searched_for}") 2 ctx1pq

254 attachments.append(f' listdir("{lib_dir}"):') 4 ctx1pqhd

255 if not os.path.isdir(lib_dir): 4 ctx1pqhd

256 attachments.append(" DIRECTORY DOES NOT EXIST") 

257 else: 

258 for node in sorted(os.listdir(lib_dir)): 4 ctx1pqhd

259 attachments.append(f" {node}") 4 ctx1pqhd

260 return None 4 ctx1pqhd

261 

262 

263def _platform_for_current_system() -> SearchPlatform: (empty)

264 if IS_WINDOWS: 2 ctx1a(

265 return WindowsSearchPlatform(target_arch=windows_python_arch()) (empty)

266 return LinuxSearchPlatform() 2 ctx1a(

267 

268 

269PLATFORM = _platform_for_current_system() (empty)