File size: 38,632 Bytes
9aa90e0 | 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 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 | # SPDX-FileCopyrightText: © 2025 Tenstorrent USA, Inc.
# SPDX-License-Identifier: Apache-2.0
import torch
import ttnn
from ..utils.tensor import bf16_tensor, local_device_to_torch
class CCLManager:
"""
Manages parallelization of DiT model.
- stores mesh device, num links, topology
- caches ping pong buffers and semaphores
- sets up one SubDevice spanning all compute cores
"""
def __init__(
self,
mesh_device,
num_links=1,
topology=None,
):
self.mesh_device = mesh_device
self.num_links = num_links
self.topology = topology
# Cache for ping pong buffers: key = (shape_tuple, dim, mesh_axis), value = [buffer1, buffer2]
self._ping_pong_buffer_cache = {}
self._ping_pong_buffer_indices = {}
# Ping-pong pool of persistent stats buffers for the fused distributed-norm op,
# keyed by the caller's shape/config key. See get_fused_norm_stats_buffer.
self._fused_norm_stats_buffer_cache = {}
# Lazily-allocated ping-pong pool of semaphore lists for the strided all-gather-matmul op
self._strided_ag_mm_sem_cache = {}
self._strided_ag_mm_sem_idx = {}
# Single shared MM->RS progress counter array. See get_mm_progress_counters_buffer.
self._mm_progress_counters_buffer = None
# Setup semaphores
self._init_subdevice()
# Initialize semaphores for reduce scatter and all gather and neighbor pad
self._init_semaphores()
# Barrier: GlobalSemaphores are created + zeroed with per-device work; without a
# sync here a fast device can start an op and fire a cross-device atomic-inc at a
# peer whose semaphore isn't created/zeroed yet -> the inc is lost (ops that read
# the semaphore without re-zeroing at startup then desync / hang). Mirrors the
# post-buffer-creation syncs in the ping-pong buffer getters.
ttnn.synchronize_device(self.mesh_device)
self.rs_ping_pong_idx = [0, 0]
self.rs_ping_pong_idx_fused = [0, 0]
self.ag_ping_pong_idx = [0, 0]
self.exp_ring_ping_pong_idx = [0, 0]
self.np_ping_pong_idx = [0, 0]
self.np_fused_ping_pong_idx = [0, 0]
self.sr_ping_pong_idx = [0, 0]
self.barrier_idx = [0, 0]
self.barrier_fused_idx = [0, 0]
def _init_subdevice(self):
compute_grid_size = self.mesh_device.compute_with_storage_grid_size()
self.ccl_cores = ttnn.CoreRangeSet(
{ttnn.CoreRange(ttnn.CoreCoord(0, 0), ttnn.CoreCoord(compute_grid_size.x - 1, compute_grid_size.y - 1))}
)
self.ccl_sub_device_id = ttnn.SubDeviceId(0)
def _init_semaphores(self):
# Initialize semaphores for reduce scatter ping pong - separate for each mesh axis
rs_n_sems = 3 * 2 # 3 semaphores * 2 for ping pong
self.rs_ping_pong_semaphores = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(rs_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(rs_n_sems)],
}
# 3 * 2 for ping pong semaphores for fused reduce scatter
self.rs_ping_pong_semaphores_fused = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(rs_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(rs_n_sems)],
}
# Initialize semaphores for all gather ping pong - separate for each mesh axis
ag_n_sems = 2 * 2 # 2 semaphores * 2 for ping pong (2 buffers)
self.ag_ping_pong_semaphores = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(ag_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(ag_n_sems)],
}
# Initialize exp ring joint SDPA semaphores (num_links per set, 2 sets for ping pong)
exp_ring_n_sems = self.num_links * 2
self.exp_ring_ping_pong_semaphores = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(exp_ring_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(exp_ring_n_sems)],
}
# Initialize neighbor pad semaphores (standalone NP path)
np_n_sems = 1 * 2
self.np_ping_pong_semaphores = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(np_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(np_n_sems)],
}
# Initialize slice reshard semaphores
sr_n_sems = 1 * 2
self.sr_ping_pong_semaphores = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(sr_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(sr_n_sems)],
}
# Initialize barrier semaphore
barrier_n_sems = 1 * 2
self.barrier_semaphores = {
0: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(barrier_n_sems)],
1: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(barrier_n_sems)],
}
# Separate semaphores for fused NP+Conv3d path to avoid state conflicts when standalone NP and fused ops.
# Per-(region,link) progress sems cover 4 face regions {H-top, H-bot, W-left, W-right} per link.
# These three pools allocate on first use: nothing selects the fused path yet, and a global
# semaphore is a device resource held for the lifetime of every CCLManager.
self._np_fused_n_sems = np_n_sems
self._barrier_fused_n_sems = barrier_n_sems
self._np_region_n_sems = 4 * self.num_links
self.np_fused_ping_pong_semaphores = None
self.barrier_fused_semaphores = None
self.np_region_progress_semaphores = None
def get_dim(self, dim, shape):
if dim < 0:
dim += len(shape)
return dim
def get_rs_ping_pong_buffer(
self, shape, dim, mesh_axis, return_output_buffer: bool = True, return_intermediate: bool = True
):
"""
Get or create ping pong buffers for reduce scatter operations.
Caches buffers based on shape, dim, and mesh_axis.
Args:
shape: Tensor shape tuple
dim: Dimension for the operation
mesh_axis: Mesh axis for parallelization
Returns:
Current ping pong buffer (alternates between two buffers)
"""
# Create cache key from the parameters
dim = self.get_dim(dim, shape)
cache_key = (tuple(shape), dim, mesh_axis)
# Create buffers if not cached
if cache_key not in self._ping_pong_buffer_cache:
# Synchronize devices to ensure all are ready to allocate and proceed
ttnn.synchronize_device(self.mesh_device)
# Create two buffers for ping pong
buffers = []
output_buffer_shape = list(shape)
output_buffer_shape[dim] //= self.mesh_device.shape[mesh_axis]
# The op's tiled intermediate is input-shaped, except on Linear topology where it holds
# two slices stacked on dim 0. Matching this exactly is required: reduce_scatter rejects
# an intermediate that is neither the tiled spec nor the contiguous staging buffer.
# TODO: Switch over to using reduce_scatter_minimal_async_create_intermediate_buffer.
intermediate_buffer_shape = list(shape)
if self.topology == ttnn.Topology.Linear:
intermediate_buffer_shape[0] *= 2
for _ in range(2):
intermediate_buffer = (
bf16_tensor(torch.empty(intermediate_buffer_shape), device=self.mesh_device)
if return_intermediate
else None
)
output_buffer = (
bf16_tensor(torch.empty(output_buffer_shape), device=self.mesh_device)
if return_output_buffer
else None
)
buffers.append([intermediate_buffer, output_buffer])
self._ping_pong_buffer_cache[cache_key] = buffers
self._ping_pong_buffer_indices[cache_key] = 0
ttnn.synchronize_device(self.mesh_device)
# Get current buffer and alternate index
current_idx = self._ping_pong_buffer_indices[cache_key]
self._ping_pong_buffer_indices[cache_key] = 1 - current_idx
return self._ping_pong_buffer_cache[cache_key][current_idx]
def get_ag_ping_pong_buffer(self, shape, dim, mesh_axis, dtype=ttnn.bfloat16):
"""
Get or create ping pong buffers for all gather operations.
Caches buffers based on shape, dim, and mesh_axis.
Args:
shape: Tensor shape tuple
dim: Dimension for the operation
mesh_axis: Mesh axis for parallelization
Returns:
Current ping pong buffer (alternates between two buffers)
"""
# Create cache key from the parameters (use different namespace than rs)
dim = self.get_dim(dim, shape)
cache_key = ("ag", tuple(shape), dim, mesh_axis, dtype)
# Create buffers if not cached
if cache_key not in self._ping_pong_buffer_cache:
# Synchronize devices to ensure all are ready to allocate and proceed
ttnn.synchronize_device(self.mesh_device)
# Create two buffers for ping pong
buffers = []
output_buffer_shape = list(shape)
output_buffer_shape[dim] *= self.mesh_device.shape[mesh_axis] # All gather increases size
for _ in range(2):
output_buffer = ttnn.from_torch(
torch.empty(output_buffer_shape),
layout=ttnn.TILE_LAYOUT,
dtype=dtype,
memory_config=ttnn.DRAM_MEMORY_CONFIG,
device=self.mesh_device,
)
buffers.append(output_buffer)
self._ping_pong_buffer_cache[cache_key] = buffers
self._ping_pong_buffer_indices[cache_key] = 0
ttnn.synchronize_device(self.mesh_device)
# Get current buffer and alternate index
current_idx = self._ping_pong_buffer_indices[cache_key]
self._ping_pong_buffer_indices[cache_key] = 1 - current_idx
return self._ping_pong_buffer_cache[cache_key][current_idx]
def get_rs_ping_pong_semaphore(self, mesh_axis):
"""
Get semaphores for reduce scatter ping pong operations.
Args:
mesh_axis: The mesh axis (0 or 1) to get semaphores for
Returns:
List of 3 semaphores for the current ping pong cycle
"""
cur_idx = self.rs_ping_pong_idx[mesh_axis]
n_sems = 3
self.rs_ping_pong_idx[mesh_axis] = (cur_idx + 1) % 2
return self.rs_ping_pong_semaphores[mesh_axis][cur_idx * n_sems : (cur_idx + 1) * n_sems]
def get_rs_ping_pong_semaphore_fused(self, mesh_axis):
"""
Get semaphores for reduce scatter ping pong operations.
Args:
mesh_axis: The mesh axis (0 or 1) to get semaphores for
Returns:
List of 3 semaphores for the current ping pong cycle
"""
cur_idx = self.rs_ping_pong_idx_fused[mesh_axis]
n_sems = 3
self.rs_ping_pong_idx_fused[mesh_axis] = (cur_idx + 1) % 2
return self.rs_ping_pong_semaphores_fused[mesh_axis][cur_idx * n_sems : (cur_idx + 1) * n_sems]
def get_ag_ping_pong_semaphore(self, mesh_axis):
"""
Get semaphores for all gather ping pong operations.
Args:
mesh_axis: The mesh axis (0 or 1) to get semaphores for
Returns:
List of 2 semaphores for the current ping pong cycle
"""
cur_idx = self.ag_ping_pong_idx[mesh_axis]
n_sems = 2
self.ag_ping_pong_idx[mesh_axis] = (cur_idx + 1) % 2
return self.ag_ping_pong_semaphores[mesh_axis][cur_idx * n_sems : (cur_idx + 1) * n_sems]
def get_strided_ag_mm_semaphore(self, mesh_axis, num_workers_per_link):
"""
Get semaphores for the strided all-gather-matmul op (strided_all_gather_minimal_matmul_async).
Unlike the 2-semaphore all-gather path, the strided op needs 2 out-ready semaphores plus
2 * num_links * num_workers_per_link per-worker aggregator semaphores (incremented over the
fabric by writer workers on the receiving device), all in a single list. A 2-deep ping-pong
pool is allocated lazily per (mesh_axis, num_workers_per_link) and rotated on each call.
Args:
mesh_axis: The mesh axis (0 or 1) to get semaphores for
num_workers_per_link: The op's num_workers_per_link (sets the aggregator-sem count)
Returns:
List of (2 + 2 * num_links * num_workers_per_link) GlobalSemaphores for this cycle
"""
cache_key = (mesh_axis, num_workers_per_link)
if cache_key not in self._strided_ag_mm_sem_cache:
ttnn.synchronize_device(self.mesh_device)
n_sems = 2 + 2 * self.num_links * num_workers_per_link
self._strided_ag_mm_sem_cache[cache_key] = [
[ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(n_sems)]
for _ in range(2)
]
self._strided_ag_mm_sem_idx[cache_key] = 0
ttnn.synchronize_device(self.mesh_device)
cur_idx = self._strided_ag_mm_sem_idx[cache_key]
self._strided_ag_mm_sem_idx[cache_key] = 1 - cur_idx
return self._strided_ag_mm_sem_cache[cache_key][cur_idx]
def get_fused_norm_stats_buffer(self, key, create_buffer):
"""Own the ping-pong pool + lifetime of the fused distributed-norm op's persistent
stats (all-gather scratch) buffer.
`create_buffer` is a 0-arg factory that returns a freshly allocated buffer (or None
when the op needs no AG scratch — the non-MUX / no-all-gather path). A 2-deep pool is
allocated once per `key` and rotated on each call, so the buffer handed out is free of
the previous invocation's in-flight AG traffic (paired with the 2-set AG-semaphore
ping-pong from get_ag_ping_pong_semaphore). The pool lives as long as this CCLManager.
The caller is responsible for creating the buffer correctly for its parameters (shape,
num_links, weight/RoPE, norm type) inside `create_buffer` and for encoding those in
`key`; num_links MUST match the op's num_preferred_links or the gather geometry desyncs.
Returns the buffer to pass as persistent_output_buffer, or None on the no-AG path.
"""
entry = self._fused_norm_stats_buffer_cache.get(key)
if entry is None:
entry = {"bufs": [create_buffer() for _ in range(2)], "idx": 0}
self._fused_norm_stats_buffer_cache[key] = entry
# Barrier before first use: ensure every device has allocated the persistent
# stats buffer (and its DRAM scratch is live) before any device launches the op
# and writes/atomic-incs into a peer's copy over fabric.
if entry["bufs"][0] is not None:
ttnn.synchronize_device(self.mesh_device)
bufs = entry["bufs"]
if bufs[0] is None:
return None
buf = bufs[entry["idx"]]
entry["idx"] = (entry["idx"] + 1) % len(bufs)
return buf
def get_mm_progress_counters_buffer(self):
"""Own the progress-counter array for the fused matmul -> strided reduce-scatter op's
per-core MM->RS signaling: one uint32 slot per matmul core, one row per core.
Same per-core row as the array the op allocates for itself, over the whole compute grid
rather than just the RS worker cores, and allocated once here instead of per compiled
program. The op's own copy is retained for as long as the program stays cached, and because
L1 is handed out top-down each of those small permanent blocks pins the freed space above it,
which eventually leaves a later op (the VAE's ring joint SDPA) short of contiguous L1 for its
circular buffers.
"""
if self._mm_progress_counters_buffer is None:
grid = self.mesh_device.compute_with_storage_grid_size()
slots = grid.x * grid.y
self._mm_progress_counters_buffer = ttnn.allocate_tensor_on_device(
ttnn.Shape([slots, slots]),
ttnn.uint32,
ttnn.ROW_MAJOR_LAYOUT,
self.mesh_device,
ttnn.MemoryConfig(
ttnn.TensorMemoryLayout.HEIGHT_SHARDED,
ttnn.BufferType.L1,
ttnn.ShardSpec(self.ccl_cores, [1, slots], ttnn.ShardOrientation.ROW_MAJOR),
),
)
return self._mm_progress_counters_buffer
def get_exp_ring_ping_pong_semaphore(self, mesh_axis):
"""
Get semaphores for exp ring joint SDPA operations.
Args:
mesh_axis: The mesh axis (0 or 1) to get semaphores for
Returns:
List of num_links semaphores for the current ping pong cycle
"""
cur_idx = self.exp_ring_ping_pong_idx[mesh_axis]
n_sems = self.num_links
self.exp_ring_ping_pong_idx[mesh_axis] = (cur_idx + 1) % 2
return self.exp_ring_ping_pong_semaphores[mesh_axis][cur_idx * n_sems : (cur_idx + 1) * n_sems]
def get_np_ping_pong_semaphore(self, mesh_axis):
"""
Get semaphores for standalone neighbor pad operations.
"""
cur_idx = self.np_ping_pong_idx[mesh_axis]
n_sems = 1
self.np_ping_pong_idx[mesh_axis] = (cur_idx + 1) % 2
return self.np_ping_pong_semaphores[mesh_axis][cur_idx]
def _make_semaphore_pool(self, n_sems):
"""Allocate a per-axis bank of `n_sems` global semaphores."""
return {
axis: [ttnn.create_global_semaphore(self.mesh_device, self.ccl_cores, 0) for _ in range(n_sems)]
for axis in (0, 1)
}
def get_np_fused_ping_pong_semaphore(self, mesh_axis):
"""
Get semaphores for fused NP+Conv3d operations (separate pool from standalone NP).
"""
if self.np_fused_ping_pong_semaphores is None:
self.np_fused_ping_pong_semaphores = self._make_semaphore_pool(self._np_fused_n_sems)
cur_idx = self.np_fused_ping_pong_idx[mesh_axis]
self.np_fused_ping_pong_idx[mesh_axis] = (cur_idx + 1) % 2
return self.np_fused_ping_pong_semaphores[mesh_axis][cur_idx]
def get_barrier_fused_semaphore(self, mesh_axis):
"""Get barrier semaphore for fused NP+Conv3d (separate pool from standalone NP)."""
if self.barrier_fused_semaphores is None:
self.barrier_fused_semaphores = self._make_semaphore_pool(self._barrier_fused_n_sems)
cur_idx = self.barrier_fused_idx[mesh_axis]
self.barrier_fused_idx[mesh_axis] = (cur_idx + 1) % 2
return self.barrier_fused_semaphores[mesh_axis][cur_idx]
def get_sr_ping_pong_semaphore(self, mesh_axis):
"""
Get semaphores for slice reshard operations.
"""
cur_idx = self.sr_ping_pong_idx[mesh_axis]
n_sems = 1
self.sr_ping_pong_idx[mesh_axis] = (cur_idx + 1) % 2
return self.sr_ping_pong_semaphores[mesh_axis][cur_idx]
def get_np_region_progress_semaphores(self, mesh_axis):
"""Get the 4*num_links per-(region,link) progress sems (static, single bank), indexed [region*num_links + link]."""
if self.np_region_progress_semaphores is None:
self.np_region_progress_semaphores = self._make_semaphore_pool(self._np_region_n_sems)
return self.np_region_progress_semaphores[mesh_axis]
def get_np_halo_buffer(self, input_shape, dim, padding, dtype=ttnn.bfloat16, dim2=None, padding2=0):
"""
Get or create a ping-pong compact halo buffer for fabric-only NeighborPad.
Handles H halo and optionally W halo.
Layout: [H-top | H-bot | W-left | W-right] where H sections are
outer_dim × padding_h × W_dev sticks, and W sections are
outer_dim × padding_w × (H_dev + 2*padding_h) sticks (extended for corner fix).
"""
import torch
outer_dim_size = 1
for d in range(dim):
outer_dim_size *= input_shape[d]
# H sticks per halo row = product of dims after dim (excluding last C dim)
h_sticks = 1
for d in range(dim + 1, len(input_shape) - 1):
h_sticks *= input_shape[d]
# W sticks per halo col = H_dev + 2*padding_h (extended to include H-padded rows for corner fix)
w_sticks = (input_shape[dim] + 2 * padding) if dim2 is not None else 0
h_halo_total = outer_dim_size * 2 * padding * h_sticks
w_halo_total = outer_dim_size * 2 * padding2 * w_sticks if dim2 is not None else 0
total_sticks = h_halo_total + w_halo_total
# Each "stick" = C channels × 2 bytes (BF16)
C = input_shape[-1] # channel dimension
cache_key = ("np_halo", tuple(input_shape), dim, padding, dim2, padding2, dtype)
if cache_key not in self._ping_pong_buffer_cache:
bufs = []
for _ in range(2):
buf = ttnn.from_torch(
torch.zeros([total_sticks, C], dtype=torch.bfloat16),
layout=ttnn.ROW_MAJOR_LAYOUT,
dtype=dtype,
memory_config=ttnn.DRAM_MEMORY_CONFIG,
device=self.mesh_device,
)
bufs.append(buf)
self._ping_pong_buffer_cache[cache_key] = bufs
self._ping_pong_buffer_indices[cache_key] = 0
cur = self._ping_pong_buffer_indices[cache_key]
self._ping_pong_buffer_indices[cache_key] = 1 - cur
return self._ping_pong_buffer_cache[cache_key][cur]
def neighbor_pad_halo_only(
self,
tensor: ttnn.Tensor,
*,
dims: list,
pad_left: list,
pad_right: list,
axes: list,
neighbor_sems: list,
num_links: list,
padding_mode: str = "zeros",
input_pad_h: int = 0,
input_pad_w: int = 0,
padded_output: ttnn.Tensor = None,
) -> ttnn.Tensor:
"""Fill and return the compact [H-top|H-bot|W-left|W-right] halo buffer via the standalone
neighbor_pad_halo op. Pair with ttnn.experimental.conv3d(halo_buffer=...) for the two-dispatch
halo-aware path (no full-pad interior copy). Halo-only variant of the neighbor-pad exchange.
input_pad_h/w > 0: `tensor` is a padded [.,H+2*ipad_h,W+2*ipad_w,C] buffer; exchange the halo of
its INTERIOR (copy-free path). The compact buffer is sized for the interior dims.
padded_output: fused mode — the op ALSO copies the interior (tensor -> padded_output) on free
cores CONCURRENTLY with the fabric exchange. Returns the compact buffer (still needed for the
border scatter); the padded interior is filled as a side effect."""
barrier_sem = self.get_barrier_semaphore(axes[0])
dim2 = dims[1] if len(dims) > 1 else None
padding2 = pad_left[1] if dim2 is not None else 0
# Compact buffer is sized from the INTERIOR shape (input_pad strips the padded border).
halo_shape = list(tensor.shape)
if input_pad_h:
halo_shape[dims[0]] -= 2 * input_pad_h
if input_pad_w and dim2 is not None:
halo_shape[dim2] -= 2 * input_pad_w
halo_buf = self.get_np_halo_buffer(
halo_shape, dims[0], pad_left[0], dtype=tensor.get_dtype(), dim2=dim2, padding2=padding2
)
pw = pad_left[1] if dim2 is not None and len(pad_left) > 1 else 0
w_sem = neighbor_sems[1] if len(neighbor_sems) > 1 else neighbor_sems[0]
np_pad2_left = pad_left[1] if dim2 is not None and len(pad_left) > 1 else 0
np_pad2_right = pad_right[1] if dim2 is not None and len(pad_right) > 1 else 0
np_pad_dim2_val = dim2 if dim2 is not None else 0
np_pad2_cluster_axis_val = axes[1] if dim2 is not None and len(axes) > 1 else 0
np_pad2_num_links = num_links[1] if dim2 is not None and len(num_links) > 1 else 1
ttnn.experimental.neighbor_pad_halo(
tensor,
halo_buf,
np_padding_h=pad_left[0],
np_padding_w=pw,
np_cluster_axis=axes[0],
np_num_links=num_links[0],
np_topology=self.topology,
h_neighbor_semaphore=neighbor_sems[0],
barrier_semaphore=barrier_sem,
w_neighbor_semaphore=w_sem,
np_pad_dim2=np_pad_dim2_val,
np_pad2_left=np_pad2_left,
np_pad2_right=np_pad2_right,
np_pad2_cluster_axis=np_pad2_cluster_axis_val,
np_pad2_num_links=np_pad2_num_links,
padding_mode=padding_mode,
input_pad_h=input_pad_h,
input_pad_w=input_pad_w,
padded_output=padded_output,
)
return halo_buf
def neighbor_pad_halo_scatter(
self,
tensor: ttnn.Tensor,
*,
dims: list,
pad_left: list,
pad_right: list,
axes: list,
neighbor_sems: list,
num_links: list,
padding_mode: str = "zeros",
input_pad_h: int = 0,
input_pad_w: int = 0,
border_only: bool = False,
) -> ttnn.Tensor:
"""Fused halo op: fabric halo exchange (into the compact buffer) then local scatter into a padded
[.,H+2pH,W+2pW,C] buffer, returned ready for a plain (pad=0) conv3d. Folds neighbor_pad_halo_only
+ halo_scatter into one call.
border_only: `tensor` already carries a padded interior (previous conv's padded output), so only
the border is written in place (copy-free). Otherwise (repack) the padded buffer is allocated and
the interior copy is FUSED into the exchange op (runs concurrently on free cores), then the border
is scattered — overlapping the interior copy with the fabric transport instead of serializing it."""
pH = pad_left[0]
pW = pad_left[1] if len(pad_left) > 1 else 0
if border_only:
compact = self.neighbor_pad_halo_only(
tensor,
dims=dims,
pad_left=pad_left,
pad_right=pad_right,
axes=axes,
neighbor_sems=neighbor_sems,
num_links=num_links,
padding_mode=padding_mode,
input_pad_h=input_pad_h,
input_pad_w=input_pad_w,
)
return ttnn.experimental.halo_scatter(compact, tensor, np_padding_h=pH, np_padding_w=pW, border_only=True)
# Repack: allocate the padded output; the exchange op copies the interior into it concurrently.
padded = self.get_np_ping_pong_buffer(list(tensor.shape), dims, pad_left, pad_right, dtype=tensor.get_dtype())
compact = self.neighbor_pad_halo_only(
tensor,
dims=dims,
pad_left=pad_left,
pad_right=pad_right,
axes=axes,
neighbor_sems=neighbor_sems,
num_links=num_links,
padding_mode=padding_mode,
input_pad_h=input_pad_h,
input_pad_w=input_pad_w,
padded_output=padded,
)
return ttnn.experimental.halo_scatter(compact, padded, np_padding_h=pH, np_padding_w=pW, border_only=True)
def get_barrier_semaphore(self, mesh_axis):
"""
Get semaphore for barrier operations.
"""
cur_idx = self.barrier_idx[mesh_axis]
n_sems = 1
self.barrier_idx[mesh_axis] = (cur_idx + 1) % 2
return self.barrier_semaphores[mesh_axis][cur_idx]
def get_np_ping_pong_buffer(
self, input_shape, dims, pad_left, pad_right, dtype=ttnn.bfloat16, t_front_pad: int = 0
):
"""
Get or create ping pong buffers for neighbor pad operations.
Caches buffers based on output shape and dtype.
Args:
input_shape: Input tensor shape
dims: List of dimensions being padded
pad_left: List of left padding amounts per dim
pad_right: List of right padding amounts per dim
dtype: Tensor dtype
t_front_pad: Number of T-front zero frames to prepend (fused T-causal padding)
Returns:
Current ping pong buffer (alternates between two buffers)
"""
output_shape = list(input_shape)
for i, dim in enumerate(dims):
output_shape[dim] += pad_left[i] + pad_right[i]
if t_front_pad > 0:
output_shape[dims[0] - 1] += t_front_pad
cache_key = ("np", tuple(output_shape), dtype)
if cache_key not in self._ping_pong_buffer_cache:
ttnn.synchronize_device(self.mesh_device)
buffers = []
for _ in range(2):
output_buffer = ttnn.from_torch(
torch.zeros(output_shape),
layout=ttnn.ROW_MAJOR_LAYOUT,
dtype=dtype,
memory_config=ttnn.DRAM_MEMORY_CONFIG,
device=self.mesh_device,
)
buffers.append(output_buffer)
self._ping_pong_buffer_cache[cache_key] = buffers
self._ping_pong_buffer_indices[cache_key] = 0
ttnn.synchronize_device(self.mesh_device)
current_idx = self._ping_pong_buffer_indices[cache_key]
self._ping_pong_buffer_indices[cache_key] = 1 - current_idx
return self._ping_pong_buffer_cache[cache_key][current_idx]
def neighbor_pad_persistent_buffer(
self,
tensor: ttnn.Tensor,
/,
*,
dims: list,
pad_left: list,
pad_right: list,
padding_mode: str,
axes: list,
neighbor_sems: list,
num_links: list,
logical_h: int = 0,
t_front_pad: int = 0,
) -> ttnn.Tensor:
"""
Helper function to neighbor-pad a tensor with a persistent output buffer.
"""
return self.neighbor_pad(
tensor,
dims=dims,
pad_left=pad_left,
pad_right=pad_right,
padding_mode=padding_mode,
axes=axes,
neighbor_sems=neighbor_sems,
num_links=num_links,
use_persistent_buffer=True,
logical_h=logical_h,
t_front_pad=t_front_pad,
)
def neighbor_pad(
self,
tensor: ttnn.Tensor,
/,
*,
dims: list,
pad_left: list,
pad_right: list,
padding_mode: str,
axes: list,
neighbor_sems: list,
num_links: list,
use_persistent_buffer: bool = False,
logical_h: int = 0,
t_front_pad: int = 0,
) -> ttnn.Tensor:
barrier_sem = self.get_barrier_semaphore(axes[0])
persistent_buf = None
if use_persistent_buffer:
persistent_buf = self.get_np_ping_pong_buffer(
tensor.shape, dims, pad_left, pad_right, dtype=tensor.get_dtype(), t_front_pad=t_front_pad
)
return ttnn.experimental.neighbor_pad_async(
tensor,
dims,
pad_left,
pad_right,
padding_mode,
axes,
neighbor_sems,
[barrier_sem],
num_links=num_links,
topology=self.topology,
persistent_output_buffer=persistent_buf,
logical_h=logical_h,
t_front_pad=t_front_pad,
)
def reset_global_semaphores(self):
"""Reset all global semaphores to 0"""
for axis in [0, 1]:
for sem in self.np_ping_pong_semaphores[axis]:
ttnn.reset_global_semaphore_value(sem, 0)
for sem in self.sr_ping_pong_semaphores[axis]:
ttnn.reset_global_semaphore_value(sem, 0)
for sem in self.rs_ping_pong_semaphores[axis]:
ttnn.reset_global_semaphore_value(sem, 0)
for sem in self.ag_ping_pong_semaphores[axis]:
ttnn.reset_global_semaphore_value(sem, 0)
# Lazily-allocated fused NP+Conv3d pools; skipped entirely until something asks for them.
for pool in (
self.np_fused_ping_pong_semaphores,
self.barrier_fused_semaphores,
self.np_region_progress_semaphores,
):
if pool is not None:
for sem in pool[axis]:
ttnn.reset_global_semaphore_value(sem, 0)
def all_gather_persistent_buffer(
self, tensor: ttnn.Tensor, /, *, dim: int, mesh_axis: int | None, use_hyperparams: bool = False
) -> ttnn.Tensor:
"""
Helper function to all-gather a tensor with a persistent output buffer.
"""
return self.all_gather(
tensor,
dim=dim,
mesh_axis=mesh_axis,
use_hyperparams=use_hyperparams,
use_persistent_buffer=True,
)
def all_gather(
self,
tensor: ttnn.Tensor,
/,
*,
dim: int,
mesh_axis: int | None,
use_hyperparams: bool,
use_persistent_buffer: bool = False,
) -> ttnn.Tensor:
if mesh_axis is None or self.mesh_device.shape[mesh_axis] == 1:
return tensor
rank = len(tensor.shape)
if dim < 0:
dim += rank
# all_gather_async currently supports tensors of rank 4 only
if rank < 4:
shape = [1] * (4 - rank) + list(tensor.shape)
tensor = ttnn.reshape(tensor, shape)
dim += 4 - rank
params = self.get_ag_hyperparams(tensor.shape) if use_hyperparams else {}
tensor = ttnn.experimental.all_gather_async(
tensor,
persistent_output_buffer=(
self.get_ag_ping_pong_buffer(tensor.shape, dim, mesh_axis, dtype=tensor.get_dtype())
if use_persistent_buffer
else None
),
barrier_semaphore=self.get_barrier_semaphore(mesh_axis) if not use_persistent_buffer else None,
dim=dim,
multi_device_global_semaphore=self.get_ag_ping_pong_semaphore(mesh_axis),
num_links=self.num_links,
topology=self.topology,
cluster_axis=mesh_axis,
**params,
)
if rank < 4:
shape = list(tensor.shape)[4 - rank :]
tensor = ttnn.reshape(tensor, shape)
return tensor
def reduce_scatter_persistent_buffer(
self, tensor: ttnn.Tensor, /, *, dim: int, mesh_axis: int | None
) -> ttnn.Tensor:
self.reduce_scatter(tensor, dim=dim, mesh_axis=mesh_axis, use_persistent_buffer=True)
def reduce_scatter(
self,
tensor: ttnn.Tensor,
/,
*,
dim: int,
mesh_axis: int | None,
use_persistent_buffer: bool = False,
) -> ttnn.Tensor:
if mesh_axis is None or self.mesh_device.shape[mesh_axis] == 1:
return tensor
rank = len(tensor.shape)
if dim < 0:
dim += rank
if rank < 4:
shape = [1] * (4 - rank) + list(tensor.shape)
tensor = ttnn.reshape(tensor, shape)
dim += 4 - rank
tensor = ttnn.experimental.reduce_scatter_minimal_async(
tensor,
persistent_output_buffers=(
self.get_rs_ping_pong_buffer(tensor.shape, dim, mesh_axis) if use_persistent_buffer else None
),
barrier_semaphore=self.get_barrier_semaphore(mesh_axis) if not use_persistent_buffer else None,
dim=dim,
multi_device_global_semaphore=self.get_rs_ping_pong_semaphore(mesh_axis),
num_links=self.num_links,
memory_config=ttnn.MemoryConfig(buffer_type=ttnn.BufferType.DRAM),
topology=self.topology,
cluster_axis=mesh_axis,
**self.get_rs_hyperparams(tensor.shape),
)
if rank < 4:
shape = list(tensor.shape)[4 - rank :]
tensor = ttnn.reshape(tensor, shape)
return tensor
def get_ag_hyperparams(self, shape):
if shape[2] > 512:
return {
"chunks_per_sync": 16,
"num_workers_per_link": 3,
"num_buffers_per_channel": 2,
}
else:
return {
"chunks_per_sync": 10,
"num_workers_per_link": 2,
"num_buffers_per_channel": 2,
}
def get_rs_hyperparams(self, shape):
return {
"chunks_per_sync": 2,
"num_workers_per_link": 2,
"num_buffers_per_channel": 2,
}
# TODO: Merge with utils.tensor.to_torch
def device_to_host(
self, tensor: ttnn.Tensor, mesh_dims: list[int], use_persistent_buffer: bool = True
) -> torch.Tensor:
"""Move a ttnn device tensor to a torch host tensor.
Args:
tensor: The ttnn tensor to move to host
mesh_dims: The dimension to gather per mesh axis. use None to skip gathering for that mesh axis. e.g [None,2] will gather along the second dimension for the mesh axis 1.
use_persistent_buffer: Whether to use a persistent buffer for the all gather operation.
Returns:
The torch host tensor
"""
device_tensor = ttnn.to_layout(tensor, ttnn.TILE_LAYOUT) # Workaround for bug in Row Major layout
for mesh_axis, mesh_dim in enumerate(mesh_dims):
if mesh_dim is not None:
device_tensor = self.all_gather(
device_tensor,
dim=mesh_dim,
mesh_axis=mesh_axis,
use_hyperparams=True,
use_persistent_buffer=use_persistent_buffer,
)
return local_device_to_torch(device_tensor)
|