File size: 27,188 Bytes
9c6594c |
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 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 |
"""
Profile Guided Optimization (PGO) implementation for Dynamo.
This module provides functionality for caching and managing code state profiles
that guide optimization decisions in Dynamo. It implements both local and remote
caching mechanisms for storing profile information across runs, handles profile
merging across distributed ranks, and manages the lifecycle of profile data
during compilation. The profiles track dynamic vs static properties of tensors
and help Dynamo make better specialization decisions.
"""
from __future__ import annotations
import base64
import copy
import dataclasses
import enum
import logging
import os
import pickle
import re
from collections import defaultdict
from typing import Optional, TYPE_CHECKING, TypeVar, Union
from typing_extensions import Self
import torch._dynamo.config
import torch._utils_internal
import torch.compiler.config
import torch.distributed as dist
from torch._dynamo.utils import (
CompileEventLogger,
dynamo_timed,
set_feature_use,
warn_once,
)
from torch._environment import is_fbcode
from torch._logging._internal import trace_structured_artifact
from torch.compiler._cache import CacheArtifactManager, CacheArtifactType
if TYPE_CHECKING:
import types
from torch._dynamo.symbolic_convert import InstructionTranslator
from torch._inductor.remote_cache import JsonDataTy, RemoteCache
class ReservedWorkflowIdUserError(ValueError):
pass
log = logging.getLogger(__name__)
LOCK_TIMEOUT = 10
# How does in memory representation work? Concretely, this module is
# responsible for holding GLOBAL state representing the state it holds, no
# other copies permitted. So we retire frame_state entirely and store it
# here. This should be reset when Dynamo is reset. We never GC information
# (similar to how the filesystem doesn't get cleaned up except by tmp
# cleaner), so the expectation is the information is relatively cheap and we
# don't mind leaking it.
# How exactly did we design the cache key? Here are some of the questions:
#
# - JOB_ID: Do we have a unique identifier for the "training run" (such that
# it stays the same if we're running the same code, and changes if we're
# running something different).
#
# - RANK: Are we sharing the cache across ranks, or does each rank get
# an individual cache?
#
# We choose to require job_id for PGO cache. This is to prevent
# situations where unrelated invocations of PyTorch unpredictably cause
# changes to each other's behavior. With a job_id, at least you know there
# is some "state" associated with it. (State dict might be another way to
# tell if a run is related or not.) You can opt-in to YOLO everything
# aliases everything by passing a shared job_id for all your invocations.
#
# We choose to NOT share PGO cache across ranks. With no RANK_SHARING, there
# is never contention between runs, so we can leisurely update a bundle with
# information we need. Because we are grouped by job_id, we can have a single
# consolidated bundle for everything (or not; maybe worry about O(n^2) IO if
# we updated every compile--let's just instrument this.) Can even take a
# filelock for extra safety (expect no contention); expect 50ns overhead from
# uncontended filelock.
#
# If we did share ranks, everyone is storming to modify the same cache files.
# We can do this by having folks atomic write to a CAS-store and then having
# readers do on-the-fly merging (this can be implemented in remote using
# prefix iteration). As an optional optimization, one rank can be elected to
# handling bundling post facto (ideally, this is done async, after quiescence,
# without compiler collective need to wait for everyone to finish writing
# their bits.) Not sure how you can avoid a listdir because if some rank shows
# up with some new entries we need to pull them in ASAP (unless you want to
# delay bundling).
#
# But compiler collectives fill a similar niche: compilers chat with each
# other so rank 0 has collected everything. So elect rank 0 only to write the
# bundle. Don't even need CAS-store atomic write; just one rank writing an
# updating bundles. The point is that use compiler collectives to share
# profiles across ranks, but use the PGO cache to persist profiles per rank
# across attempts. No need to have one mechanism to do everything.
@dataclasses.dataclass(frozen=True)
class CodeId:
filename: str
firstlineno: int
name: str
@staticmethod
def make(code: types.CodeType) -> CodeId:
return CodeId(code.co_filename, code.co_firstlineno, code.co_name)
@dataclasses.dataclass
class CodeState:
automatic_dynamic: defaultdict[str, FrameStateSizeEntry] = dataclasses.field(
default_factory=lambda: defaultdict(FrameStateSizeEntry)
)
_INIT_CODE_STATE: Optional[defaultdict[CodeId, CodeState]] = None
_CODE_STATE: Optional[defaultdict[CodeId, CodeState]] = None
@dataclasses.dataclass(frozen=True)
class InferStride:
"""
Denotes the quantity stride[dim] * size[dim], which is what the stride would
be for the next physical dimension that results in a contiguous layout.
For example, given size = [2, 3], stride = [3, 1], we can replace this with
stride = [InferStride(1), 1], because InferStride(1) = stride[1] * size[1] = 1 * 3 = 3
Indirecting the representation in this way is important for the join operation
on strides as if we join [2, 3][3, 1] and [2, 4][4, 1],
we don't want [2, None][None, 1] which would get eventually symbolized into
[2, s0][s1, 1] (notice that the relationship between s0 and s1 is broken).
If we instead rewrite the expressions as InferStride so we have [2, 3][InferStride(1), 1]
and [2, 4][InferStride(1), 1] we now join to [2, None][InferStride(1), 1] will
result in [2, s0][s0, 1], as desired.
"""
dim: int
_T = TypeVar("_T")
class AutoUnset(enum.Enum):
"""
The identity element of our semilattice, a generic "don't know" element that
is always subsumed when we get more information.
"""
token = 0
auto_unset = AutoUnset.token
class AutoDynamic(enum.Enum):
"""
The top element of our (bounded) semilattice, whenever you merge this with
any other element you always get it again
"""
token = 0
auto_dynamic = AutoDynamic.token
@dataclasses.dataclass
class FrameStateSizeEntry:
scalar: Union[int, AutoDynamic, AutoUnset] = dataclasses.field(default=auto_unset)
# NB: We don't have cases where we have a known dimensionality but
# we know NOTHING about the individual sizes
size: Union[AutoDynamic, AutoUnset, tuple[Union[int, AutoDynamic], ...]] = (
dataclasses.field(default=auto_unset)
)
stride: Union[
AutoDynamic, AutoUnset, tuple[Union[int, AutoDynamic, InferStride], ...]
] = dataclasses.field(default=auto_unset)
def render(self) -> str:
# Special cases
def render_single(s: Union[int, AutoDynamic, AutoUnset, InferStride]) -> str:
if s is auto_dynamic:
return "?"
elif s is auto_unset:
# This basically shouldn't happen, this is for debugging
return "auto unset"
elif isinstance(s, InferStride):
return f"S({s.dim})"
else:
return str(s)
def render_tuple(ss: tuple[Union[int, AutoDynamic, InferStride], ...]) -> str:
return "[" + ", ".join(render_single(s) for s in ss) + "]"
# Common cases
if self.size is auto_dynamic and self.stride is auto_dynamic:
if self.scalar is auto_dynamic:
return "fully dynamic scalar or tensor"
else:
return f"scalar {self.scalar}"
elif self.scalar is auto_dynamic:
if isinstance(self.size, tuple) and isinstance(self.stride, tuple):
return f"tensor size={render_tuple(self.size)} stride={render_tuple(self.stride)}"
# Fallback
return "unusual {repr(self)}"
def __post_init__(self) -> None:
assert not isinstance(self.scalar, torch.SymInt), self.scalar
if isinstance(self.size, tuple):
for s in self.size:
assert not isinstance(s, torch.SymInt), s
if isinstance(self.stride, tuple):
for s1 in self.stride:
assert not isinstance(s1, torch.SymInt), s1
def is_size_dynamic(self, dim: int) -> bool:
if self.size is auto_dynamic:
return True
if self.size is auto_unset:
return False
return self.size[dim] is auto_dynamic
def is_stride_dynamic(self, dim: int) -> bool:
# At the moment, dynamic strides is a bit buggy. Good test case
# here is `PYTORCH_TEST_WITH_DYNAMO=1 python test/test_autograd.py
# TestAutograd.test_gradcheck_jacobian_mismatch`
#
# This if statement preserves historical behavior, which is that we
# ONLY make strides dynamic if the size is exactly static everywhere.
# We could potentially relax this but in general we should be very
# careful about when to infer dynamic strides.
#
# Actually, the existing algorithm is already somewhat problematic.
# Suppose a tensor that is sometimes:
# f32[2, 3, 5][15, 5, 1] and other times
# f32[2, 3, 5][5, 10, 1] (specifically, dim 0 and 1 are physically transposed).
# If we infer strides should be (DYNAMIC, DYNAMIC, 1). But this is
# silly: we really should have just guarded on dim order.
if not (
isinstance(self.size, tuple) and all(type(s) is int for s in self.size)
):
return False
if self.stride is auto_dynamic:
return True
if self.stride is auto_unset:
return False
return self.stride[dim] is auto_dynamic
@staticmethod
def _munge_symint(xs: tuple[int, ...]) -> tuple[Union[AutoDynamic, int], ...]:
return tuple(auto_dynamic if isinstance(x, torch.SymInt) else x for x in xs)
@classmethod
def make_scalar(cls, x: int) -> FrameStateSizeEntry:
return FrameStateSizeEntry(scalar=x, size=auto_dynamic, stride=auto_dynamic)
@classmethod
def make_tensor(
cls, size: tuple[int, ...], stride: tuple[int, ...]
) -> FrameStateSizeEntry:
return FrameStateSizeEntry(
scalar=auto_dynamic,
size=cls._munge_symint(size),
stride=cls._munge_symint(stride),
)
@classmethod
def make_size(cls, size: tuple[int, ...]) -> FrameStateSizeEntry:
return FrameStateSizeEntry(
scalar=auto_unset,
size=cls._munge_symint(size),
stride=auto_unset,
)
@staticmethod
def _merge_atom(x: _T, y: _T) -> Union[AutoDynamic, _T]:
if x is auto_unset:
return y
if y is auto_unset:
return x
if x is auto_dynamic or y is auto_dynamic or x != y:
return auto_dynamic
return x
@classmethod
def _merge_atom_tup(
cls,
xs: Union[AutoDynamic, AutoUnset, tuple[_T, ...]],
ys: Union[AutoDynamic, AutoUnset, tuple[_T, ...]],
) -> Union[AutoDynamic, AutoUnset, tuple[Union[AutoDynamic, _T], ...]]:
if xs is auto_unset:
return ys
if ys is auto_unset:
return xs
if xs is auto_dynamic or ys is auto_dynamic:
return auto_dynamic
if len(xs) != len(ys):
return auto_dynamic
return tuple(cls._merge_atom(x, y) for x, y in zip(xs, ys))
def __ior__(self, other: Self) -> Self:
self.scalar = self._merge_atom(self.scalar, other.scalar)
self.size = self._merge_atom_tup(self.size, other.size)
self.stride = self._merge_atom_tup(self.stride, other.stride)
return self
def update_automatic_dynamic(
tx: InstructionTranslator,
name: str,
entry: FrameStateSizeEntry,
*,
is_unspecialized_nn_module: bool = False,
) -> FrameStateSizeEntry:
code_id = CodeId.make(tx.f_code)
frame_state = get_code_state()[code_id]
is_update = name in frame_state.automatic_dynamic
mut_entry = frame_state.automatic_dynamic[name]
old_entry = copy.copy(mut_entry)
mut_entry |= entry
# Do some logs (damn, I spend more code logging than I do actually doing
# the updates lol)
if is_update and old_entry.scalar != mut_entry.scalar:
log.debug(
"automatic dynamic int %s val %s != %s",
name,
entry.scalar,
old_entry.scalar,
)
CompileEventLogger.instant(
"automatic_dynamic",
{
"name": name,
"dim_changed": "scalar",
"reason": "scalar change",
"cached": str(old_entry.scalar),
"new": str(entry.scalar),
},
)
if is_unspecialized_nn_module:
log.info(
"%s is converted to a symbolic integer. It is an attribute of a "
"user defined nn module class. If you wish to keep it static, you can "
"mark the nn module class as `torch._dynamo.mark_static`.",
name,
)
def log_tup(
tup_name: str, short_reason: str, long_reason: str, i: Optional[int] = None
) -> None:
entry_tup = (
getattr(entry, tup_name) if i is None else getattr(entry, tup_name)[i]
)
old_entry_tup = (
getattr(old_entry, tup_name)
if i is None
else getattr(old_entry, tup_name)[i]
)
log.debug(
"automatic dynamic %s %s %s %s != %s",
tup_name,
name,
short_reason,
# NB: We used to only report len(...) here for dim mismatch
entry_tup,
old_entry_tup,
)
CompileEventLogger.instant(
"automatic_dynamic",
{
"name": name,
"dim_changed": "all" if i is None else i,
"reason": long_reason,
"cached": str(old_entry_tup),
"new": str(entry_tup),
},
)
if is_update and old_entry.size != mut_entry.size:
if isinstance(old_entry.size, tuple) and isinstance(entry.size, tuple):
if len(old_entry.size) != len(entry.size):
log_tup("size", "dim", "dimensionality change")
else:
for i in range(len(entry.size)):
if old_entry.size[i] != entry.size[i]:
log_tup("size", f"size({i})", "size change", i)
else:
log_tup("size", "other", "other")
if is_update and old_entry.stride != mut_entry.stride:
if isinstance(old_entry.stride, tuple) and isinstance(entry.stride, tuple):
if len(old_entry.stride) != len(entry.stride):
log_tup("stride", "dim", "dimensionality change")
else:
for i in range(len(entry.stride)):
if old_entry.stride[i] != entry.stride[i]:
log_tup("stride", f"stride({i})", "stride change", i)
else:
log_tup("stride", "other", "other")
return mut_entry
def process_automatic_dynamic(
tx: InstructionTranslator,
name: str,
entry: FrameStateSizeEntry,
*,
is_unspecialized_nn_module: bool = False,
) -> FrameStateSizeEntry:
if (st := tx.distributed_state) is None:
return update_automatic_dynamic(
tx,
name,
entry,
is_unspecialized_nn_module=is_unspecialized_nn_module,
)
elif st.all_states is None:
# Preflight, always pretend as if it's static. The point here
# is we want to get through the preflight quickly, and static
# will run faster. The preexisting frame state will get
# applied anyway after we do compiler collectives.
# TODO: I'm not sure if we should just bong the entire pgo
# state here, it kind of depends if we're going to have other
# things that talk in compiler collective. Also, the PGO
# state, if we've already inferred something is automatic
# dynamic, will have lost the actual input sizes, which might
# be useful for debugging purposes (e.g., observing 0/1
# specialization). Bonging the entire PGO state here would
# let us delete this logic here; the compiler collective
# would just directly update_automatic_dynamic
st.local_state.automatic_dynamic[name] = entry
return entry
else:
# Apply the updates. NB: all_states includes the local state
# too.
res = None
for sub_state in st.all_states:
if name in sub_state.automatic_dynamic:
res = update_automatic_dynamic(
tx,
name,
sub_state.automatic_dynamic[name],
is_unspecialized_nn_module=is_unspecialized_nn_module,
)
assert res is not None
return res
def get_cache_key() -> Optional[str]:
# TODO: info versions of these logs that log only once
if torch._inductor.config.force_disable_caches:
warn_once(
"dynamo_pgo force disabled by torch._inductor.config.force_disable_caches"
)
return None
# NB: We always use global rank for keys, even though they are overkill
# for local only cache
rank = None
if dist.is_available() and dist.is_initialized():
rank = dist.get_rank()
tag = torch.compiler.config.cache_key_tag
# NB: We namespace the cache keys so that only user-specified job id
# can alias with each other.
if (r := torch.compiler.config.job_id) is not None:
if r.startswith("mast:"):
raise ReservedWorkflowIdUserError(
"torch.compiler.config.job_id with prefix 'mast:' is reserved for "
"automatically generated job id associated with a specific MAST job "
"name and version."
)
return f"{r}:{rank}:{tag}"
if (name_version := torch._utils_internal.get_mast_job_name_version()) is not None:
mast_job_name, mast_job_version = name_version
return f"mast:{mast_job_name}:{mast_job_version}:{rank}:{tag}"
return None
# This solely controls local PGO
def code_state_path(cache_key: str) -> Optional[str]:
if not torch._dynamo.config.automatic_dynamic_local_pgo:
log.debug("automatic_dynamic_local_pgo not enabled")
return None
from torch._inductor.runtime.runtime_utils import cache_dir
code_state_key = re.sub(r'[<>:"/\\|?*]', "_", f"code_state_{cache_key}.pkl")
return os.path.join(cache_dir(), "dynamo", code_state_key)
def should_use_remote_dynamo_pgo_cache() -> bool:
if torch._inductor.config.force_disable_caches:
return False
if (r := torch._dynamo.config.automatic_dynamic_remote_pgo) is not None:
return r
if not is_fbcode():
return False
if torch._utils_internal.is_fb_unit_test():
return False
try:
from torch._inductor.fb.remote_cache import REMOTE_CACHE_VERSION
except ModuleNotFoundError:
return False
return REMOTE_CACHE_VERSION >= torch._utils_internal.justknobs_getval_int(
"pytorch/remote_cache:dynamo_pgo_version"
)
def get_remote_cache() -> Optional[RemoteCache[JsonDataTy]]:
from torch._inductor.remote_cache import create_cache
if not should_use_remote_dynamo_pgo_cache():
return None
return create_cache(
"dynamo-pgo",
is_fbcode(),
"FbRemoteDynamoPGOCache",
"RemoteDynamoPGOCache",
)
def render_code_state(cs: defaultdict[CodeId, CodeState]) -> str:
return "\n".join(
f"{k.filename}:{k.firstlineno}:{k.name}:\n"
+ "\n".join(
f" {src}: {fs.render()}" for src, fs in v.automatic_dynamic.items()
)
for k, v in cs.items()
)
def get_code_state() -> defaultdict[CodeId, CodeState]:
global _CODE_STATE, _INIT_CODE_STATE
if _CODE_STATE is not None:
return _CODE_STATE
# Initialize it (even if we don't look up profile)
_CODE_STATE = defaultdict(CodeState)
cache_key = get_cache_key()
if cache_key is None:
return _CODE_STATE
def hit(ty: str) -> defaultdict[CodeId, CodeState]:
global _INIT_CODE_STATE
assert isinstance(_CODE_STATE, defaultdict)
log.info("get_code_state %s hit %s, %d entries", path, ty, len(_CODE_STATE))
trace_structured_artifact(
f"get_{ty}_code_state",
"string",
lambda: render_code_state(_CODE_STATE),
)
set_feature_use("pgo", True)
_INIT_CODE_STATE = copy.deepcopy(_CODE_STATE)
return _CODE_STATE
# Attempt local
path = code_state_path(cache_key)
if path is not None and os.path.exists(path):
with dynamo_timed(
name := "pgo.get_local_code_state", log_pt2_compile_event=True
):
CompileEventLogger.pt2_compile(name, cache_key=cache_key)
# Read lock not necessary as we always write atomically write to
# the actual location
with open(path, "rb") as f:
try:
content = f.read()
_CODE_STATE = pickle.loads(content)
CompileEventLogger.pt2_compile(name, cache_size_bytes=f.tell())
except Exception:
log.warning(
"get_code_state failed while reading %s", path, exc_info=True
)
else:
CacheArtifactManager.record_artifact(
CacheArtifactType.PGO, cache_key, content
)
return hit("local")
# Attempt remote
remote_cache = get_remote_cache()
if remote_cache is not None:
with dynamo_timed(
name := "pgo.get_remote_code_state", log_pt2_compile_event=True
):
CompileEventLogger.pt2_compile(name, cache_key=cache_key)
# TODO: I don't really understand why there's a JSON container format
try:
cache_data = remote_cache.get(cache_key)
except Exception:
log.warning(
"get_code_state failed remote read on %s", cache_key, exc_info=True
)
else:
if cache_data is not None:
try:
assert isinstance(cache_data, dict)
data = cache_data["data"]
assert isinstance(data, str)
payload = base64.b64decode(data)
CompileEventLogger.pt2_compile(
name, cache_size_bytes=len(payload)
)
_CODE_STATE = pickle.loads(payload)
except Exception:
log.warning(
"get_code_state failed parsing remote result on %s",
cache_key,
exc_info=True,
)
else:
CacheArtifactManager.record_artifact(
CacheArtifactType.PGO, cache_key, payload
)
return hit("remote")
else:
log.info("get_code_state remote miss on %s", cache_key)
log.info("get_code_state using default")
assert _CODE_STATE is not None
return _CODE_STATE
def put_code_state() -> None:
if _CODE_STATE is None:
log.info("put_code_state: never initialized, will not write")
return
if _CODE_STATE == _INIT_CODE_STATE:
log.info("put_code_state: no change, skipping")
return
cache_key = get_cache_key()
if cache_key is None:
log.info("put_code_state: no cache key, skipping")
return
put_local_code_state(cache_key)
put_remote_code_state(cache_key)
def write_local_impl(cache_key: str, pickled_code: bytes) -> Optional[tuple[str, int]]:
path = code_state_path(cache_key)
if path is None:
return None
# If the user isn't misusing our API, we should have exclusive access to
# this directory. But it's not too hard
tmp_path = path + ".tmp"
lock_path = path + ".lock"
# We /mostly/ don't need the lock but the tmp file could be clobbered
# TODO: use a safe tempfile create to eliminate lock
from torch.utils._filelock import FileLock
os.makedirs(os.path.dirname(path), exist_ok=True)
with FileLock(lock_path, timeout=LOCK_TIMEOUT):
with open(tmp_path, "wb") as f:
f.write(pickled_code)
size = f.tell()
os.replace(tmp_path, path)
return path, size
def put_local_code_state(cache_key: str) -> None:
with dynamo_timed(name := "pgo.put_local_code_state", log_pt2_compile_event=True):
CompileEventLogger.pt2_compile(name, cache_key=cache_key)
assert _CODE_STATE is not None
pickled_code = pickle.dumps(_CODE_STATE)
CacheArtifactManager.record_artifact(
CacheArtifactType.PGO, cache_key, pickled_code
)
meta = write_local_impl(cache_key, pickled_code)
if meta is None:
log.info("put_code_state: local cache disabled")
return
path, size = meta
CompileEventLogger.pt2_compile(name, cache_size_bytes=size)
log.info("put_code_state: wrote local %s, %d entries", path, len(_CODE_STATE))
trace_structured_artifact(
"put_local_code_state",
"string",
lambda: render_code_state(_CODE_STATE),
)
def put_remote_code_state(cache_key: str) -> None:
with dynamo_timed(name := "pgo.put_remote_code_state", log_pt2_compile_event=True):
CompileEventLogger.pt2_compile(name, cache_key=cache_key)
assert _CODE_STATE is not None
remote_cache = get_remote_cache()
if remote_cache is None:
log.info("put_code_state: remote cache disabled")
return
content = pickle.dumps(_CODE_STATE)
CompileEventLogger.pt2_compile(name, cache_size_bytes=len(content))
cache_data: JsonDataTy = {
"data": base64.b64encode(content).decode("ascii"),
}
remote_cache.put(cache_key, cache_data)
log.info(
"put_code_state: wrote remote %s, %d entries", cache_key, len(_CODE_STATE)
)
# TODO: don't log this multiple times
trace_structured_artifact(
"put_remote_code_state",
"string",
lambda: render_code_state(_CODE_STATE),
)
# NB: this does NOT reset the cached code state on disk
def reset_code_state() -> None:
global _CODE_STATE, _INIT_CODE_STATE
_CODE_STATE = None
_INIT_CODE_STATE = None
|