1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
|
import collections
import dataclasses
import functools
import os
import shutil
import sys
from dataclasses import dataclass, field
from typing import Callable, Dict, List, Optional, Tuple
from torch._inductor.runtime.cache_dir_utils import cache_dir
# Set the subdirectory name
SUBDIR_NAME = "bisect"
@dataclass
class Subsystem:
name: str
@dataclass
class BisectSubsystem(Subsystem):
pass
@dataclass
class BinarySubsystem(Subsystem):
pass
@dataclass
class ConfigChange(BinarySubsystem):
name: str = field(init=False)
config_name: str
config_field: str
config_value: object
def __post_init__(self) -> None:
self.name = f"{self.config_name}_{self.config_field}"
# Dictionary of backend -> subsystems
BACKENDS: Dict[str, List[Subsystem]] = {
# run dynamo without aot_autograd
"eager": [],
# run dynamo with aot_autograd, but no partitioner or decomps
"aot_eager": [],
# run dynamo with aot autograd, decompositions and partitioner
"aot_eager_decomp_partition": [
ConfigChange("aot_eager_decomp_partition", "cse", False),
BisectSubsystem(
"decomposition"
), # number of decompositions we apply in tracing
], # TODO - add cse ?
# applies CrossRefFakeMode on invocation
"aot_eager_decomp_partition_crossref": [],
"inductor": [
BisectSubsystem("joint_graph_passes"), # passes applied on joint graph
BisectSubsystem(
"post_grad_passes"
), # passes applied individually on forward, and backward in inductor
ConfigChange("inductor", "fallback_random", True),
ConfigChange("inductor", "emulate_precision_casts", True),
BisectSubsystem("lowerings"), # lowering aten operators to inductor
], # TODO - add more - fusions ?
}
subsystem_call_counter: Dict[str, int] = collections.Counter()
call_counter_debug_info: Dict[int, str] = {}
def reset_counters() -> None:
subsystem_call_counter.clear()
call_counter_debug_info.clear()
@functools.lru_cache(None)
def get_env_val(env_str: str) -> Optional[str]:
return os.environ.get(env_str, None)
@dataclasses.dataclass
class BisectionResult:
"""
backend: torch.compile backend responsible for failure
subsystem: optional, registered component identified for failure
bisect_number: optional, number of times the subsystem needed to be applied to trigger failure
debug_info: associated info of the triggering bisect application of subsystem
"""
backend: str
subsystem: Optional[str] = None
bisect_number: Optional[int] = None
debug_info: Optional[str] = None
class CompilerBisector:
"""
This class iteratively runs torch.compile backends (eager, aot_eager, inductor) to find the
first backend that can repro an issue.
Once it discovers the offending backend it will iteratively disable subsystems within the backend.
For subsystems which are applied repeatedly, such as the number of post grad passes or number
of lowering of nodes to inductor ir, it will bisect to find the offending application.
The idiomatic way to run it is with `do_bisect`. You can also use it by setting the env flags
`TORCH_BISECT_BACKEND`, `TORCH_BISECT_SUBSYSTEM` and `TORCH_BISECT_MAX`.
It also supports a CLI interface, although this is less well tested.
You must run python compiler_bisector.py [start | good | bad | end]
"""
bisection_enabled: bool = False
@classmethod
def get_dir(cls) -> str:
return f"{cache_dir()}/{SUBDIR_NAME}"
@classmethod
def write_lines_to_file(cls, file_path: str, lines: List[str]) -> None:
os.makedirs(os.path.dirname(file_path), exist_ok=True)
with open(file_path, "w") as file:
file.writelines(lines)
@classmethod
def read_lines_from_file(cls, file_path: str) -> List[str]:
if os.path.exists(file_path):
with open(file_path) as file:
return file.readlines()
return []
@classmethod
def update_run_state(
cls, backend_name: str, subsystem: Subsystem, run_state: str
) -> None:
file_path = os.path.join(
cls.get_dir(), backend_name, f"{subsystem.name}_run_state.txt"
)
if isinstance(subsystem, ConfigChange):
assert run_state == "test_disable"
cls.set_config_values(
backend_name,
subsystem.name,
{subsystem.config_field: subsystem.config_value},
)
cls.write_lines_to_file(file_path, [run_state])
@classmethod
def set_config_values(
cls, backend: str, subsystem: str, config_data: Dict[str, object]
) -> None:
file_path = os.path.join(cls.get_dir(), backend, f"{subsystem}_config.txt")
lines = [f"{k}={v}\n" for k, v in config_data.items()]
cls.write_lines_to_file(file_path, lines)
@classmethod
def update_bisect_status(cls, backend_name: str, subsystem_name: str) -> None:
assert isinstance(subsystem_name, str)
file_path = os.path.join(cls.get_dir(), "bisect_status.txt")
lines = [f"backend={backend_name}\n", f"subsystem={subsystem_name}\n"]
cls.write_lines_to_file(file_path, lines)
@classmethod
def update_bisect_range(
cls, backend_name: str, subsystem_name: str, low: int, high: int
) -> None:
assert isinstance(subsystem_name, str)
file_path = os.path.join(
cls.get_dir(), backend_name, f"{subsystem_name}_bisect_range.txt"
)
lines = [f"low={low}\n", f"high={high}\n"]
cls.write_lines_to_file(file_path, lines)
@classmethod
def get_backend(cls) -> Optional[str]:
"""
Returns the active backend, if any
"""
if val := get_env_val("TORCH_BISECT_BACKEND"):
return val
file_path = os.path.join(cls.get_dir(), "bisect_status.txt")
lines = cls.read_lines_from_file(file_path)
for line in lines:
if line.startswith("backend="):
return line.strip().split("=")[1]
return None
@classmethod
def get_subsystem(cls) -> Optional[str]:
"""
Returns the active subsystem, if any
"""
if val := get_env_val("TORCH_BISECT_SUBSYSTEM"):
return val
file_path = os.path.join(cls.get_dir(), "bisect_status.txt")
lines = cls.read_lines_from_file(file_path)
for line in lines:
if line.startswith("subsystem="):
out = line.strip().split("=")[1]
return out if out else None
return None
@classmethod
def get_subsystem_object(cls, backend_name: str, subsystem_name: str) -> Subsystem:
return next(obj for obj in BACKENDS[backend_name] if obj.name == subsystem_name)
@classmethod
def get_run_state(cls, backend_name: str, subsystem_name: str) -> Optional[str]:
"""
Returns the current stage of bisecting, if Any
"""
file_path = os.path.join(
cls.get_dir(), backend_name, f"{subsystem_name}_run_state.txt"
)
lines = cls.read_lines_from_file(file_path)
if lines:
out = lines[0].strip()
assert out in ("test_disable", "find_max_bounds", "bisect")
return out
return None
@classmethod
def get_bisect_range(
cls, backend_name: str, subsystem_name: str
) -> Tuple[int, int]:
file_path = os.path.join(
cls.get_dir(), backend_name, f"{subsystem_name}_bisect_range.txt"
)
lines = cls.read_lines_from_file(file_path)
low = None
high = None
for line in reversed(lines):
if line.startswith("low="):
low = int(line.strip().split("=")[1])
elif line.startswith("high="):
high = int(line.strip().split("=")[1])
if low is not None and high is not None:
break
if low is None or high is None:
raise RuntimeError(
f"Trying to get bisect range when it is not set: subsystem {subsystem_name}"
)
return low, high
@classmethod
def update_config_change(cls, backend: str, subsystem: ConfigChange) -> None:
file_path = os.path.join(cls.get_dir(), backend, f"{subsystem.name}_config.txt")
lines = [
f"config_name={subsystem.config_name}\n",
f"config_field={subsystem.config_field}\n",
f"config_value={subsystem.config_value}\n",
]
cls.write_lines_to_file(file_path, lines)
@classmethod
def get_config_change(cls, config_name: str) -> Optional[Dict[str, object]]:
backend = cls.get_backend()
subsystem = cls.get_subsystem()
if not backend or not subsystem:
return None
file_path = os.path.join(cls.get_dir(), backend, f"{subsystem}_config.txt")
if not os.path.exists(file_path):
return None
lines = cls.read_lines_from_file(file_path)
config_data = {}
for line in lines:
key, value = line.strip().split("=", 1)
config_data[key] = eval(value)
return config_data
@classmethod
def delete_bisect_status(cls) -> None:
if os.path.exists(cls.get_dir()):
shutil.rmtree(cls.get_dir())
print("Bisection status deleted.")
else:
print("No bisection status found.")
@classmethod
def get_system_counter(cls, name: str, increment: bool = True) -> int:
global subsystem_call_counter
curr = subsystem_call_counter[name]
if increment:
subsystem_call_counter[name] += 1
return curr
@classmethod
def disable_subsystem(
cls,
backend: str,
subsystem: str,
debug_info: Optional[Callable[[], str]] = None,
) -> bool:
if not cls.bisection_enabled:
return False
if cls.get_backend() != backend:
return False
if cls.get_subsystem() != subsystem:
return False
if val := get_env_val("TORCH_BISECT_MAX"):
counter = cls.get_system_counter(subsystem, increment=True)
return counter > int(val)
run_state = cls.get_run_state(backend, subsystem)
if run_state == "test_disable":
# First run, disable completely
return True
elif run_state == "find_max_bounds":
# Second run, update bisection range and return True to enable the subsystem
cls.update_bisect_range(
backend,
subsystem,
0,
cls.get_system_counter(subsystem, increment=True),
)
return False
else:
assert run_state == "bisect"
# If the environment variable is not set, use the bisection range midpoint
low, high = cls.get_bisect_range(backend, subsystem)
# if high - low <= 2:
midpoint = (low + high) // 2
call_counter = cls.get_system_counter(subsystem)
if (
call_counter >= low
and call_counter <= high
and (low - high) <= 2
and debug_info is not None
):
call_counter_debug_info[call_counter] = debug_info()
return call_counter > midpoint
@classmethod
def advance_subsystem(
cls, curr_backend: str, curr_subsystem: Subsystem
) -> Optional[Subsystem]:
"""
Tries to move to the next subsystem within the current system.
"""
print(f"Disabling {curr_subsystem.name} did not fix the issue.")
current_subsystems = BACKENDS[curr_backend]
current_subsystem_index = next(
i
for i, subsystem in enumerate(current_subsystems)
if subsystem.name == curr_subsystem.name
)
if current_subsystem_index < len(current_subsystems) - 1:
next_subsystem = current_subsystems[current_subsystem_index + 1]
cls.update_bisect_status(curr_backend, next_subsystem.name)
cls.update_run_state(curr_backend, next_subsystem, "test_disable")
print(
f"Moving to the next subsystem: {curr_backend} - {next_subsystem.name}"
)
return next_subsystem
else:
print(
f"All subsystems in {curr_backend} have been checked. The issue is not in this system."
)
return None
@classmethod
def advance_backend(cls, curr_backend: str) -> Optional[str]:
"""
Tries Move to the next backend.
"""
current_system_index = list(BACKENDS.keys()).index(curr_backend)
if current_system_index < len(BACKENDS) - 1:
curr_backend = list(BACKENDS.keys())[current_system_index + 1]
cls.update_bisect_status(curr_backend, "")
print(f"Moving to the next system: {curr_backend}")
return curr_backend
else:
return None
@classmethod
def process_subsystem(
cls,
curr_backend: str,
curr_subsystem: Subsystem,
fn: Callable[[], bool],
cli_interface: bool = True,
) -> bool:
"""
Process the current subsystem. Returns True if the issue is found, False otherwise.
"""
assert isinstance(curr_subsystem, Subsystem)
while True:
run_state = cls.get_run_state(curr_backend, curr_subsystem.name)
reset_counters()
if run_state == "test_disable":
if not fn():
next_subsystem = cls.advance_subsystem(curr_backend, curr_subsystem)
if not next_subsystem:
return False
curr_subsystem = next_subsystem
else:
if isinstance(curr_subsystem, ConfigChange):
print(
f"Setting config {curr_subsystem.config_name} field {curr_subsystem.config_field} "
f"to {curr_subsystem.config_value} fixed the issue"
)
else:
print(f"Disabling {curr_subsystem.name} fixed the issue.")
if isinstance(curr_subsystem, BinarySubsystem):
return True
print("Starting bisect by getting upper bound.")
cls.update_run_state(
curr_backend, curr_subsystem, "find_max_bounds"
)
elif run_state == "find_max_bounds":
if fn():
raise RuntimeError(
f"Function succeeded with 'find_max_bounds' status for {curr_backend} - {curr_subsystem.name}."
)
else:
_, high = cls.get_bisect_range(curr_backend, curr_subsystem.name)
print(f"Upper bound of {high} found for {curr_backend}.")
cls.update_run_state(curr_backend, curr_subsystem, "bisect")
elif run_state == "bisect":
low, high = cls.get_bisect_range(curr_backend, curr_subsystem.name)
midpoint = (low + high) // 2
print(
f"Bisecting {curr_backend} - {curr_subsystem.name} (Range: [{low}, {high}], Midpoint: {midpoint})"
)
if fn():
cls.update_bisect_range(
curr_backend, curr_subsystem.name, midpoint + 1, high
)
else:
cls.update_bisect_range(
curr_backend, curr_subsystem.name, low, midpoint
)
low, high = cls.get_bisect_range(curr_backend, curr_subsystem.name)
if low == high:
print(
f"Binary search completed for {curr_backend} - {curr_subsystem.name}. The bisect number is {low}. "
f"Debug info: {call_counter_debug_info.get(low, 'not found')}"
)
return True
else:
raise RuntimeError(f"Unexpected run_state {run_state}")
if cli_interface:
sys.exit(0)
@classmethod
def initialize_system(cls) -> None:
curr_backend = next(iter(BACKENDS.keys()))
curr_subsystem = ""
cls.update_bisect_status(curr_backend, curr_subsystem)
print(f"Starting bisection process with system: {curr_backend}")
@classmethod
def do_bisect(
cls, fn: Callable[[], bool], cli_interface: bool = False
) -> Optional[BisectionResult]:
"""
Run fn repeatedly attempting to bisect torch.compile. fn should return True on success and False on failure.
"""
if not cli_interface:
bisection_enabled_orig = cls.bisection_enabled
cls.delete_bisect_status()
cls.bisection_enabled = True
# TODO - cli interface, and in-process different directories
class DisableBisect:
def __del__(self) -> None:
cls.bisection_enabled = bisection_enabled_orig
cls.delete_bisect_status()
cleanup = DisableBisect()
curr_backend = cls.get_backend()
curr_subsystem_name = cls.get_subsystem()
if not curr_backend:
cls.initialize_system()
curr_backend = cls.get_backend()
assert curr_backend is not None
curr_subsystem_name = cls.get_subsystem()
curr_subsystem = (
cls.get_subsystem_object(curr_backend, curr_subsystem_name)
if curr_subsystem_name is not None
else None
)
while True:
assert curr_backend is not None
reset_counters()
if curr_subsystem:
result = cls.process_subsystem(
curr_backend, curr_subsystem, fn, cli_interface=cli_interface
)
if result:
curr_subsystem = cls.get_subsystem_object(
curr_backend, cls.get_subsystem() # type: ignore[arg-type]
)
if isinstance(curr_subsystem, BinarySubsystem):
return BisectionResult(
curr_backend,
curr_subsystem.name,
0,
curr_subsystem.name,
)
low, _ = cls.get_bisect_range(curr_backend, curr_subsystem.name)
return BisectionResult(
curr_backend,
curr_subsystem.name,
low,
call_counter_debug_info.get(low, None),
)
next_subsystem = cls.advance_subsystem(curr_backend, curr_subsystem)
if not next_subsystem:
print(
f"The issue is in the {curr_backend} system, but could not identify subsystem."
)
assert curr_backend is not None
return BisectionResult(curr_backend)
curr_subsystem = next_subsystem
else:
if fn():
next_backend = cls.advance_backend(curr_backend)
if not next_backend:
print("All systems have been checked.")
return None
curr_backend = next_backend
else:
current_subsystems = BACKENDS[curr_backend]
if current_subsystems:
curr_subsystem = current_subsystems[0]
cls.update_bisect_status(curr_backend, curr_subsystem.name)
cls.update_run_state(
curr_backend, curr_subsystem, "test_disable"
)
print(
f"The issue is in the {curr_backend} system. Moving to the first subsystem: {curr_subsystem}"
)
else:
print(f"The issue is in the {curr_backend} system.")
return BisectionResult(curr_backend)
if cli_interface:
sys.exit(0)
def command_line_usage() -> None:
if len(sys.argv) < 2:
print("Usage: python bisect_update.py <start|end|good|bad>")
sys.exit(1)
bisection_manager = CompilerBisector()
command = sys.argv[1]
if command == "end":
bisection_manager.delete_bisect_status()
sys.exit(0)
if command == "start":
bisection_manager.delete_bisect_status()
bisection_manager.initialize_system()
sys.exit(0)
if command not in ["good", "bad"]:
print("Invalid command. Must be 'good', 'bad', 'start', or 'end'.")
sys.exit(1)
def test_function() -> bool:
return command == "good"
if not bisection_manager.get_backend():
raise ValueError("Must call start prior to good or bad")
bisection_manager.do_bisect(test_function, cli_interface=True)
def get_is_bisection_enabled() -> bool:
return (
CompilerBisector.get_subsystem() is not None
or CompilerBisector.get_backend() is not None
)
CompilerBisector.bisection_enabled = get_is_bisection_enabled()
if __name__ == "__main__":
command_line_usage()
|