attention.py 259 KB
Newer Older
1
# Copyright (c) 2022-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
3
4
5
#
# See LICENSE for license information.

"""Attention."""
6
import collections
7
from contextlib import nullcontext
8
from importlib.metadata import version as get_pkg_version
9
import math
10
import os
11
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
12
import warnings
13
import logging
14

cyanguwa's avatar
cyanguwa committed
15
import numpy as np
16
from packaging.version import Version as PkgVersion
17
18

import torch
19
import torch.nn.functional as F
20

21
import transformer_engine_torch as tex
22
23
import transformer_engine as te
from transformer_engine.pytorch.utils import get_cudnn_version
24
25
26
27
from transformer_engine.pytorch.cpp_extensions import (
    cast_to_fp8,
    cast_from_fp8,
)
28
29
30
31
32
from transformer_engine.pytorch.cpp_extensions.fused_attn import (
    fused_attn_fwd_qkvpacked,
    fused_attn_bwd_qkvpacked,
    fused_attn_fwd_kvpacked,
    fused_attn_bwd_kvpacked,
33
34
    fused_attn_fwd,
    fused_attn_bwd,
35
36
37
38
39
    QKVLayout,
    AttnBiasType,
    AttnMaskType,
    FusedAttnBackend,
)
40
41
from transformer_engine.pytorch.fp8 import get_fp8_te_dtype
from transformer_engine.pytorch.float8_tensor import Float8Tensor
42
from transformer_engine.pytorch.module import LayerNormLinear, Linear
43
from transformer_engine.pytorch.module.base import TransformerEngineBaseModule
44
45
46
47
48
from transformer_engine.pytorch.utils import (
    divide,
    attention_mask_func,
    split_tensor_along_dim,
    get_device_compute_capability,
49
    get_default_init_method,
50
51
52
53
)
from transformer_engine.pytorch.constants import (
    AttnMaskTypes,
    AttnTypes,
54
    AttnBiasTypes,
55
    QKVLayouts,
56
    dist_group_type,
57
    TE_DType,
58
59
60
61
)
from transformer_engine.pytorch.softmax import FusedScaleMaskSoftmax
from transformer_engine.pytorch.distributed import (
    get_distributed_world_size,
62
    get_distributed_rank,
63
    checkpoint,
64
65
66
    set_all_rng_states,
    CudaRNGStatesTracker,
    graph_safe_rng_available,
67
68
)
from transformer_engine.pytorch.export import is_in_onnx_export_mode
69
from transformer_engine.pytorch.jit import jit_fuser, no_torch_dynamo
70
71
from transformer_engine.pytorch.graph import is_graph_capturing

72

73
74
75
76
77
78
79
_flash_attn_version = PkgVersion(get_pkg_version("flash-attn"))
_flash_attn_version_required = PkgVersion("2.0.6")
_flash_attn_max_version = PkgVersion("2.5.8")
_flash_attn_2_1_plus = _flash_attn_version >= PkgVersion("2.1")
_flash_attn_2_3_plus = _flash_attn_version >= PkgVersion("2.3")
_flash_attn_2_4_plus = _flash_attn_version >= PkgVersion("2.4")
_flash_attn_2_4_1_plus = _flash_attn_version >= PkgVersion("2.4.1")
80

81
if _flash_attn_version >= _flash_attn_version_required:
82
83
84
85
    from flash_attn.flash_attn_interface import flash_attn_varlen_func as flash_attn_forward_func
    from flash_attn.flash_attn_interface import _flash_attn_varlen_forward as _flash_attn_forward
    from flash_attn.flash_attn_interface import _flash_attn_varlen_backward as _flash_attn_backward
    from flash_attn_2_cuda import varlen_bwd as flash_attn_cuda_bwd
86

87
META_QKV = tex.FP8FwdTensors.GEMM1_OUTPUT
88
META_DQKV = tex.FP8BwdTensors.GRAD_OUTPUT1
89
90
91
92
META_O = tex.FP8FwdTensors.GEMM2_INPUT
META_DO = tex.FP8BwdTensors.GRAD_INPUT2
META_S = tex.FP8FwdTensors.GEMM3_OUTPUT
META_DP = tex.FP8BwdTensors.GRAD_INPUT3
93

94
# NVTE_DEBUG = 0/1 # disables/enables debug mode, default = 0
95
_NVTE_DEBUG = int(os.getenv("NVTE_DEBUG", "0"))
96
97
98
99
100
# NVTE_DEBUG_LEVEL = 0/1/2 # enables more and more verbose debug mode, default = 0
_NVTE_DEBUG_LEVEL = int(os.getenv("NVTE_DEBUG_LEVEL", "0"))
log_level = _NVTE_DEBUG * _NVTE_DEBUG_LEVEL
log_levels = {0: logging.WARNING, 1: logging.INFO, 2: logging.DEBUG}
logging.basicConfig(
101
102
    format="[%(levelname)-8s | %(name)-19s]: %(message)s",
    level=log_levels[log_level if log_level in [0, 1, 2] else 2],
103
104
)

105
106
107
108
109
110
111
112
_alibi_cache = {
    "_num_heads": None,
    "_alibi_slopes": None,
    "_max_seqlen_q": None,
    "_max_seqlen_kv": None,
    "_alibi_bias": None,
    "_alibi_slopes_require_update": False,
    "_alibi_bias_require_update": False,
113
}
114
115


116
117
__all__ = ["DotProductAttention", "InferenceParams", "MultiheadAttention"]

118

119
class InferenceParams:  # pylint: disable=too-few-public-methods
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
    """
    Inference parameters that are passed to the main model in order
    to efficienly calculate and store the context during inference.

    Parameters
    ----------
    max_batch_size : int
                    maximum batch size during inference.
    max_sequence_length : int
                         maximum sequence length during inference.
    """

    def __init__(self, max_batch_size, max_sequence_length):
        self.max_sequence_length = max_sequence_length
        self.max_batch_size = max_batch_size
        self.sequence_len_offset = 0
        self.batch_size_offset = 0
        self.key_value_memory_dict = {}

    def swap_key_value_dict(self, batch_indices):
        """
        Reorders the KV cache using the specified batch indices.

        Parameters
        ----------
        batch_indices : List[int]
                       Sequence of indices to reorder along the batch dimensions of
                       the KV cache. Must have a length equal to the batch size.
        """
        if len(self.key_value_memory_dict) == 0:
            raise ValueError("should not swap when dict in empty")

        for layer_number, inference_memory in self.key_value_memory_dict.items():
            inference_key_memory, inference_value_memory = inference_memory
            assert (
                len(batch_indices) == inference_key_memory.shape[1]
            )  # make sure batch size is the same
            new_inference_key_memory = inference_key_memory[:, batch_indices]
            new_inference_value_memory = inference_value_memory[:, batch_indices]
            self.key_value_memory_dict[layer_number] = (
                new_inference_key_memory,
                new_inference_value_memory,
            )
163

164

165
166
167
168
169
@torch.no_grad()
def get_alibi(
    num_heads: int,
    max_seqlen_q: int,
    max_seqlen_kv: int,
170
171
172
    alibi_slopes: Optional[torch.Tensor] = None,
    bias_dtype: Optional[torch.dtype] = None,
) -> Tuple[torch.Tensor, torch.Tensor]:
173
    """
174
175
176
177
178
179
180
181
182
183
184
185
    Parameters
    ----------
    num_heads: int
        Number of heads.
    max_seqlen_q: int
        Maximum sequence length for queries.
    max_seqlen_kv: int
        Maximum sequence length for keys and values.
    alibi_slopes: Optional[torch.Tensor], default = `None`
        Custom ALiBi slopes, FP32, CUDA tensor, in shape [num_heads] or [batch_size, num_heads].
    bias_dtype: Optional[torch.dtype], default = `None`
        Dtype of the generated ALiBi bias. If None, use torch.float32.
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
    Returns
    ----------
    alibi_slopes: torch.Tensor
        ALiBi slopes in FP32 and shape [num_heads] or [batch_size, num_heads].
    alibi_bias: torch.Tensor
        ALiBi bias in FP32 or `bias_dtype`. If `alibi_slopes` is in [num_heads] shape,
        then `alibi_bias` is in [1, num_heads, max_seqlen_q, max_seqlen_kv], and if
        `alibi_slopes` is in [batch_size, num_heads], then the bias is in
        [batch_size, num_heads, max_seqlen_q, max_seqlen_kv].
    """
    global _alibi_cache
    if _alibi_cache["_alibi_slopes_require_update"]:
        if alibi_slopes is not None:
            _alibi_cache["_alibi_slopes"] = alibi_slopes
        else:
            n = 2 ** math.floor(math.log2(num_heads))
            m_0 = 2.0 ** (-8.0 / n)
            m = torch.pow(m_0, torch.arange(1, 1 + n))

            if n < num_heads:
                m_hat_0 = 2.0 ** (-4.0 / n)
                m_hat = torch.pow(m_hat_0, torch.arange(1, 1 + 2 * (num_heads - n), 2))
                m = torch.cat([m, m_hat])

            _alibi_cache["_alibi_slopes"] = m.to(dtype=torch.float32, device="cuda")
        _alibi_cache["_num_heads"] = num_heads
        _alibi_cache["_alibi_slopes_require_update"] = False

    if _alibi_cache["_alibi_bias_require_update"]:
        assert _alibi_cache["_alibi_slopes"] is not None, "ALiBi slopes can not be None!"
        if _alibi_cache["_alibi_slopes"].dim() == 1:
            slopes_shape = torch.Size([1, _alibi_cache["_alibi_slopes"].shape[0], 1, 1])
        if _alibi_cache["_alibi_slopes"].dim() == 2:
            slopes_shape = torch.Size([*_alibi_cache["_alibi_slopes"].shape[:], 1, 1])
221
222
223
224
225
226
        bias = torch.arange(1 - max_seqlen_kv, 1, dtype=torch.int32, device="cuda").view(
            1, 1, 1, max_seqlen_kv
        )
        bias = bias - torch.arange(1 - max_seqlen_q, 1, dtype=torch.int32, device="cuda").view(
            1, 1, max_seqlen_q, 1
        )
227
228
229
230
231
232
233
234
        bias = bias.abs().mul(-1)
        bias = bias * _alibi_cache["_alibi_slopes"].view(slopes_shape)
        _alibi_cache["_max_seqlen_q"], _alibi_cache["_max_seqlen_kv"] = max_seqlen_q, max_seqlen_kv
        bias_dtype = torch.float32 if bias_dtype is None else bias_dtype
        _alibi_cache["_alibi_bias"] = bias.contiguous().to(dtype=bias_dtype, device="cuda")
        _alibi_cache["_alibi_bias_require_update"] = False

    return _alibi_cache["_alibi_slopes"], _alibi_cache["_alibi_bias"]
235
236
237
238
239
240
241
242
243


def get_cu_seqlens(mask: torch.Tensor) -> torch.Tensor:
    """
    Given a padding mask of shape [batch_size, 1, 1, max_seqlen], returns an int32
    tensor of shape [batch_size + 1] containing the cumulative sequence lengths of
    the samples in a batch.
    """
    mask = mask.squeeze(1).squeeze(1)
244
    reduced_mask = mask.logical_not().sum(dim=1)
245
246
247
248
249
250
    cu_seqlens = reduced_mask.cumsum(dim=0).to(torch.int32)
    zero = torch.zeros(1, dtype=torch.int32, device="cuda")
    cu_seqlens = torch.cat((zero, cu_seqlens))

    return cu_seqlens

251

252
253
254
def get_cu_seqlens_and_indices(mask: torch.Tensor) -> Tuple[torch.Tensor, torch.Tensor]:
    """
    Given a padding mask of shape [batch_size, 1, 1, max_seqlen], returns an int32
255
256
257
    tensor of shape [batch_size + 1] containing the cumulative sequence lengths of
    the samples in a batch, and another int32 tensor of shape [batch_size * max_seqlen, 1, 1]
    containing the indices for the valid tokens.
258
259
260
261
    """
    mask = mask.squeeze(1).squeeze(1)
    bs, seqlen = mask.shape

262
    reduced_mask = mask.logical_not().sum(dim=1)
263
264
265
266
267
    cu_seqlens = reduced_mask.cumsum(dim=0).to(torch.int32)
    zero = torch.zeros(1, dtype=torch.int32, device="cuda")
    cu_seqlens = torch.cat((zero, cu_seqlens))

    mask = mask.reshape(-1)
268
    indices = mask.logical_not().nonzero()
269
270
271
272
    indices = indices.unsqueeze(-1)

    num_nonzeros = indices.shape[0]
    pad_amount = bs * seqlen - num_nonzeros
273
274
275
    indices = F.pad(
        input=indices, pad=(0, 0, 0, 0, 0, pad_amount), mode="constant", value=float(bs * seqlen)
    )
276
277
278
279

    return cu_seqlens, indices


280
281
282
283
284
285
286
287
def get_indices(max_seqlen: int, cu_seqlens: torch.Tensor) -> torch.Tensor:
    """
    Given max_seqlen and cu_seqlens of shape [batch_size + 1], returns an int32
    tensor of shape [batch_size * max_seqlen, 1, 1] containing the indices for
    the valid tokens in a batch.
    """
    bs = len(cu_seqlens) - 1
    seqlens = cu_seqlens[1:] - cu_seqlens[:-1]
288
289
    indices = [i * max_seqlen + ii for i, j in enumerate(seqlens) for ii in range(j)]
    indices = torch.Tensor(indices).unsqueeze(1).unsqueeze(1).to(dtype=torch.int64, device="cuda")
290
291
292

    num_nonzeros = indices.shape[0]
    pad_amount = bs * max_seqlen - num_nonzeros
293
294
295
296
297
298
    indices = F.pad(
        input=indices,
        pad=(0, 0, 0, 0, 0, pad_amount),
        mode="constant",
        value=float(bs * max_seqlen),
    )
299
300
301

    return indices

302

303
_cu_seqlens_cache = {}
304
305


306
307
308
309
310
311
312
313
314
315
def _get_full_cu_seqlens(
    batch_size: int,
    max_seqlen: int,
    device: torch.device,
) -> torch.Tensor:
    """Cumulative sequence lengths in full data batch

    All sequences in batch have the maximum sequence length.

    """
316
317
318
319
320
321
322
323
324
325
    global _cu_seqlens_cache
    if (batch_size, max_seqlen) not in _cu_seqlens_cache:
        _cu_seqlens_cache[(batch_size, max_seqlen)] = torch.arange(
            0,
            (batch_size + 1) * max_seqlen,
            step=max_seqlen,
            dtype=torch.int32,
            device=device,
        )
    return _cu_seqlens_cache[(batch_size, max_seqlen)]
326
327


328
329
330
331
332
333
334
335
336
@jit_fuser
def pack_tensor(
    indices: torch.Tensor,
    tensor: torch.Tensor,
) -> torch.Tensor:
    """
    Packs the given tensor using the `indices`.
    """
    padding_indice = torch.zeros(
337
338
        1, tensor.shape[1], tensor.shape[2], dtype=tensor.dtype, device=tensor.device
    )
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
    tensor = torch.cat((tensor, padding_indice), dim=0)

    indices = indices.repeat(1, tensor.shape[1], tensor.shape[2])
    packed = torch.gather(tensor, 0, indices)
    return packed


@jit_fuser
def pack_2_tensors(
    indices: torch.Tensor,
    t1: torch.Tensor,
    t2: torch.Tensor,
) -> Tuple[torch.Tensor, torch.Tensor]:
    """
    Packs the given 2 tensors using the `indices`.
    """
    t1_packed = pack_tensor(indices, t1)
    t2_packed = pack_tensor(indices, t2)
    return t1_packed, t2_packed


@jit_fuser
def pack_3_tensors(
    indices: torch.Tensor,
    t1: torch.Tensor,
    t2: torch.Tensor,
    t3: torch.Tensor,
) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor]:
    """
    Packs the given 3 tensors using the `indices`.
    """
    t1_packed = pack_tensor(indices, t1)
    t2_packed = pack_tensor(indices, t2)
    t3_packed = pack_tensor(indices, t3)
    return t1_packed, t2_packed, t3_packed


@jit_fuser
def unpack_tensor(
    indices: torch.Tensor,
    dim0: int,
    tensor: torch.Tensor,
) -> torch.Tensor:
    """
    Inverse of `pack_tensor`.
    """
    indices = indices.repeat(1, tensor.shape[1], tensor.shape[2])
    unpacked = torch.zeros(
387
388
        dim0 + 1, tensor.shape[1], tensor.shape[2], dtype=tensor.dtype, device=tensor.device
    )
389
    unpacked.scatter_(0, indices, tensor)
390
    unpacked = unpacked[0:-1, :, :]
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
    return unpacked


@jit_fuser
def unpack_2_tensors(
    indices: torch.Tensor,
    dim0: int,
    t1: torch.Tensor,
    t2: torch.Tensor,
) -> Tuple[torch.Tensor, torch.Tensor]:
    """
    Inverse of `pack_2_tensors`.
    """
    t1_unpacked = unpack_tensor(indices, dim0, t1)
    t2_unpacked = unpack_tensor(indices, dim0, t2)
    return t1_unpacked, t2_unpacked


@jit_fuser
def unpack_3_tensors(
    indices: torch.Tensor,
    dim0: int,
    t1: torch.Tensor,
    t2: torch.Tensor,
    t3: torch.Tensor,
) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor]:
    """
    Inverse of `pack_3_tensors`.
    """
    t1_unpacked = unpack_tensor(indices, dim0, t1)
    t2_unpacked = unpack_tensor(indices, dim0, t2)
    t3_unpacked = unpack_tensor(indices, dim0, t3)
    return t1_unpacked, t2_unpacked, t3_unpacked


class PackTensors(torch.autograd.Function):
    """
    Autograd function to pack tensors.
    """
430

431
432
    @staticmethod
    def forward(
433
        ctx, indices: torch.Tensor, *tensors: Tuple[torch.Tensor, ...]
434
435
    ) -> Union[Tuple[torch.Tensor, ...], torch.Tensor]:
        assert 1 <= len(tensors) <= 3, f"Packing {len(tensors)} tensors not supported."
436
        ctx.save_for_backward(indices)
437
438
439
440
441
442
443
444
445
        ctx.dim0 = tensors[0].shape[0]
        if len(tensors) == 1:
            return pack_tensor(indices, *tensors)
        if len(tensors) == 2:
            return pack_2_tensors(indices, *tensors)
        return pack_3_tensors(indices, *tensors)

    @staticmethod
    def backward(ctx, *grad_outputs: Tuple[torch.Tensor, ...]):
446
        (indices,) = ctx.saved_tensors
447
        if len(grad_outputs) == 1:
448
            return None, unpack_tensor(indices, ctx.dim0, *grad_outputs)
449
        if len(grad_outputs) == 2:
450
451
            return None, *unpack_2_tensors(indices, ctx.dim0, *grad_outputs)
        return None, *unpack_3_tensors(indices, ctx.dim0, *grad_outputs)
452
453
454
455
456
457


class UnpackTensor(torch.autograd.Function):
    """
    Autograd function to unpack a tensor.
    """
458

459
460
461
462
463
464
465
    @staticmethod
    def forward(
        ctx,
        indices: torch.Tensor,
        dim0: int,
        tensor: torch.Tensor,
    ) -> torch.Tensor:
466
        ctx.save_for_backward(indices)
467
468
469
470
        return unpack_tensor(indices, dim0, tensor)

    @staticmethod
    def backward(ctx, grad_output):
471
472
        (indices,) = ctx.saved_tensors
        return None, None, pack_tensor(indices, grad_output)
473
474


475
476
477
def flash_attn_p2p_communicate(
    rank, send_tensor, send_dst, recv_tensor, recv_src, cp_group, batch_p2p_comm
):
478
    """Point-to-point communications of KV and dKV in Attention with context parallelism"""
479
480
481
482
    send_recv_ops = []

    if batch_p2p_comm:
        if rank % 2 == 0:
483
484
485
486
487
488
            send_op = torch.distributed.P2POp(
                torch.distributed.isend, send_tensor, send_dst, cp_group
            )
            recv_op = torch.distributed.P2POp(
                torch.distributed.irecv, recv_tensor, recv_src, cp_group
            )
489
490
491
            send_recv_ops.append(send_op)
            send_recv_ops.append(recv_op)
        else:
492
493
494
495
496
497
            recv_op = torch.distributed.P2POp(
                torch.distributed.irecv, recv_tensor, recv_src, cp_group
            )
            send_op = torch.distributed.P2POp(
                torch.distributed.isend, send_tensor, send_dst, cp_group
            )
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
            send_recv_ops.append(recv_op)
            send_recv_ops.append(send_op)
        send_recv_reqs = torch.distributed.batch_isend_irecv(send_recv_ops)
    else:
        if rank % 2 == 0:
            send_op = torch.distributed.isend(send_tensor, send_dst, cp_group)
            recv_op = torch.distributed.irecv(recv_tensor, recv_src, cp_group)
            send_recv_ops.append(send_op)
            send_recv_ops.append(recv_op)
        else:
            recv_op = torch.distributed.irecv(recv_tensor, recv_src, cp_group)
            send_op = torch.distributed.isend(send_tensor, send_dst, cp_group)
            send_recv_ops.append(recv_op)
            send_recv_ops.append(send_op)
        send_recv_reqs = send_recv_ops

    return send_recv_reqs


517
@jit_fuser
518
def flash_attn_fwd_out_correction(out, out_per_step, seq_dim, softmax_lse, softmax_lse_per_step):
519
    """Merge partial outputs of each step in Attention with context parallelism"""
520
    softmax_lse_corrected_exp = torch.exp(softmax_lse_per_step - softmax_lse).movedim(2, seq_dim)
521
    softmax_lse_corrected_exp = softmax_lse_corrected_exp.unsqueeze(-1)
522
    out_corrected = out_per_step * softmax_lse_corrected_exp
523
524
525
    out.add_(out_corrected)


526
@jit_fuser
527
def flash_attn_fwd_softmax_lse_correction(softmax_lse, softmax_lse_per_step):
528
    """Merge softmax stats of each step in Attention with context parallelism"""
529
530
531
532
    max_scale = torch.max(softmax_lse, softmax_lse_per_step)
    min_scale = torch.min(softmax_lse, softmax_lse_per_step)
    new_scale = max_scale + torch.log(1 + torch.exp(min_scale - max_scale))
    softmax_lse.copy_(new_scale)
533
534


535
class AttnFuncWithCP(torch.autograd.Function):
536
    """
537
538
    Attention implementation with context parallelism.
    Split attention compute into multiple steps, and overlap current-step
539
540
541
542
    compute with next-step communication.
    """

    @staticmethod
543
544
545
546
547
548
549
550
551
552
    def forward(
        ctx,
        is_training,
        q,
        k,
        v,
        cu_seqlens_q,
        cu_seqlens_k,
        max_seqlen_q,
        max_seqlen_k,
553
554
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
555
556
557
558
559
560
561
562
563
564
565
566
        dropout_p,
        cp_group,
        cp_global_ranks,
        cp_stream,
        softmax_scale,
        qkv_format,
        attn_mask_type,
        attn_bias_type,
        attn_bias,
        deterministic,
        use_fused_attention,
    ):
567
568
569
570
571
572
        if softmax_scale is None:
            softmax_scale = q.shape[-1] ** (-0.5)

        cp_size = get_distributed_world_size(cp_group)
        rank = get_distributed_rank(cp_group)
        send_dst = cp_global_ranks[(rank + 1) % cp_size]
573
        recv_src = cp_global_ranks[(rank - 1) % cp_size]
574
575
        batch_p2p_comm = int(os.getenv("NVTE_BATCH_MHA_P2P_COMM", "0")) or (cp_size == 2)

576
577
        causal = "causal" in attn_mask_type
        padding = "padding" in attn_mask_type
578

579
580
        qkv_layout = qkv_format + "_" + qkv_format + "_" + qkv_format

581
        if causal:
582
583
            if qkv_format == "bshd":
                # [b, s, np, hn] -> [b, 2, s//2, np, hn]
584
                q, k, v = [x.view(x.shape[0], 2, x.shape[1] // 2, *x.shape[2:]) for x in [q, k, v]]
585
586
            elif qkv_format == "sbhd":
                # [s, b, np, hn] -> [2, s//2, b, np, hn]
587
                q, k, v = [x.view(2, x.shape[0] // 2, *x.shape[1:]) for x in [q, k, v]]
588
        if attn_bias is not None:
589
            assert len(attn_bias.shape) == 4, (
590
591
592
593
                "Only support bias shape of [b, h, sq, sk] for forward, "
                "and [1, h, sq, sk] for backward!"
            )
            # [b, np, sq, sk] -> [b, np, 2, sq//2, 2*cp, sk//(2*cp)]
594
595
596
597
598
599
            attn_bias_ = attn_bias.view(
                *attn_bias.shape[:-2],
                2,
                attn_bias.shape[-2] // 2,
                2 * cp_size,
                attn_bias.shape[-1] // (2 * cp_size),
600
601
            )
            # [b, np, sq, sk] -> [b, np, sq, 2*cp, sk//(2*cp)]
602
603
            attn_bias = attn_bias.view(
                *attn_bias.shape[:-1], 2 * cp_size, attn_bias.shape[-1] // (2 * cp_size)
604
            )
605
        assert q.shape[-1] % 8 == 0, "hidden size per attention head should be multiple of 8"
606
607
608
609
610
        fa_optional_forward_kwargs = {}
        if _flash_attn_2_3_plus:
            fa_optional_forward_kwargs["window_size"] = [-1, 0] if causal else [-1, -1]
        if _flash_attn_2_4_plus:
            fa_optional_forward_kwargs["alibi_slopes"] = None
611

612
613
614
        # Flash Attn inputs
        q_inputs = [None, None]
        kv_inputs = [None, None]
615
        attn_bias_inputs = [None, None]
616
617
618
619
        # Flash Attn outputs
        out_per_step = [None for _ in range(cp_size)]
        softmax_lse_per_step = [None for _ in range(cp_size)]
        rng_states = [None for _ in range(cp_size)]
620
        attn_biases = [None for _ in range(cp_size)]
621
622
623
624
625
626
627
628
629
630

        # create two streams to resolve wave quantization issue of Flash Attn in each step
        flash_attn_streams = [torch.cuda.current_stream(), cp_stream]
        # synchronize fwd results correction across steps
        fwd_results_correction_done = torch.cuda.Event()

        p2p_comm_buffers = [None for _ in range(cp_size)]
        p2p_comm_buffers[0] = torch.cat((k.unsqueeze(0), v.unsqueeze(0)), dim=0)
        send_recv_reqs = [[], []]

631
        for i in range(cp_size + 1):
632
            if i < cp_size:
633
                with torch.cuda.stream(flash_attn_streams[i % 2]):
634
                    # wait until KV is received
635
                    for req in send_recv_reqs[(i + 1) % 2]:
636
637
                        req.wait()

638
639
640
641
642
643
644
645
646
647
648
649
650
                    if i < (cp_size - 1):
                        p2p_comm_buffers[i + 1] = torch.empty_like(p2p_comm_buffers[i])
                        send_recv_reqs[i % 2] = flash_attn_p2p_communicate(
                            rank,
                            p2p_comm_buffers[i],
                            send_dst,
                            p2p_comm_buffers[i + 1],
                            recv_src,
                            cp_group,
                            batch_p2p_comm,
                        )

                    kv_inputs[i % 2] = p2p_comm_buffers[i]
651
652
                    if causal:
                        if i == 0:
653
                            if use_fused_attention:
654
655
                                if qkv_format == "bshd":
                                    # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
656
                                    q_inputs[i % 2] = q.view(q.shape[0], -1, *q.shape[-2:])
657
                                    # [2, b, 2, sk//2, np, hn] -> [2, b, sk, np, hn]
658
659
660
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(
                                        2, k.shape[0], -1, *k.shape[-2:]
                                    )
661
662
                                elif qkv_format == "sbhd":
                                    # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
663
                                    q_inputs[i % 2] = q.view(-1, *q.shape[-3:])
664
                                    # [2, 2, sk//2, b, np, hn] -> [2, sk, b, np, hn]
665
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-3:])
666
                                elif qkv_format == "thd":
667
                                    q_inputs[i % 2] = q
668
669
                                if attn_bias is not None:
                                    idx = (rank - i) % cp_size
670
671
672
673
674
675
                                    attn_bias_inputs[i % 2] = torch.cat(
                                        (
                                            attn_bias[..., idx, :],
                                            attn_bias[..., (2 * cp_size - idx - 1), :],
                                        ),
                                        dim=-1,
676
                                    ).contiguous()
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
                                out_per_step[i], [softmax_lse_per_step[i], rng_states[i], *rest] = (
                                    fused_attn_fwd(
                                        is_training,
                                        max_seqlen_q,
                                        max_seqlen_k,
                                        cu_seqlens_q,
                                        cu_seqlens_k,
                                        q_inputs[i % 2],
                                        kv_inputs[i % 2][0],
                                        kv_inputs[i % 2][1],
                                        TE_DType[q.dtype],
                                        tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
                                        attn_scale=softmax_scale,
                                        dropout=dropout_p,
                                        qkv_layout=qkv_layout,
                                        attn_mask_type=attn_mask_type,
                                        attn_bias_type=attn_bias_type,
                                        attn_bias=attn_bias_inputs[i % 2],
695
696
                                        cu_seqlens_q_padded=cu_seqlens_q_padded,
                                        cu_seqlens_kv_padded=cu_seqlens_kv_padded,
697
                                    )
698
                                )
699
700
                                if len(rest) > 0:
                                    attn_biases[i] = rest[0]
701
702
                            else:
                                # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
703
                                q_inputs[i % 2] = q.view(-1, *q.shape[-2:])
704
                                # [2, b, 2, sk//2, np, hn] -> [2, b*sk, np, hn]
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
                                kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-2:])
                                (
                                    _,
                                    _,
                                    _,
                                    _,
                                    out_per_step[i],
                                    softmax_lse_per_step[i],
                                    _,
                                    rng_states[i],
                                ) = _flash_attn_forward(
                                    q_inputs[i % 2],
                                    kv_inputs[i % 2][0],
                                    kv_inputs[i % 2][1],
                                    cu_seqlens_q,
                                    cu_seqlens_k,
                                    max_seqlen_q,
                                    max_seqlen_k,
                                    dropout_p,
                                    softmax_scale,
                                    causal=True,
                                    return_softmax=False,
                                    **fa_optional_forward_kwargs,
728
                                )
729
                        elif i <= rank:
730
                            if use_fused_attention:
731
732
                                if qkv_format == "bshd":
                                    # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
733
                                    q_inputs[i % 2] = q.view(q.shape[0], -1, *q.shape[-2:])
734
                                    # [2, b, 2, sk//2, np, hn] -> [2, b, sk//2, np, hn]
735
                                    kv_inputs[i % 2] = kv_inputs[i % 2][:, :, 0, ...].contiguous()
736
737
                                elif qkv_format == "sbhd":
                                    # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
738
                                    q_inputs[i % 2] = q.view(-1, *q.shape[-3:])
739
                                    # [2, 2, sk//2, b, np, hn] -> [2, sk//2, b, np, hn]
740
                                    kv_inputs[i % 2] = kv_inputs[i % 2][:, 0, ...].contiguous()
741
                                elif qkv_format == "thd":
742
                                    q_inputs[i % 2] = q
743
                                    # [2, t, np, hn] -> [2, t/2, np, hn]
744
745
746
                                    kv_inputs[i % 2] = tex.thd_read_half_tensor(
                                        kv_inputs[i % 2], cu_seqlens_k, 0
                                    )
747
748
                                if attn_bias is not None:
                                    idx = (rank - i) % cp_size
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
                                    attn_bias_inputs[i % 2] = attn_bias[..., idx, :].contiguous()
                                out_per_step[i], [softmax_lse_per_step[i], rng_states[i], *rest] = (
                                    fused_attn_fwd(
                                        is_training,
                                        max_seqlen_q,
                                        max_seqlen_k // 2,
                                        cu_seqlens_q,
                                        cu_seqlens_k // 2,
                                        q_inputs[i % 2],
                                        kv_inputs[i % 2][0],
                                        kv_inputs[i % 2][1],
                                        TE_DType[q.dtype],
                                        tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
                                        attn_scale=softmax_scale,
                                        dropout=dropout_p,
                                        qkv_layout=qkv_layout,
                                        attn_mask_type="padding" if padding else "no_mask",
                                        attn_bias_type=attn_bias_type,
                                        attn_bias=attn_bias_inputs[i % 2],
768
769
770
771
772
                                        cu_seqlens_q_padded=cu_seqlens_q_padded,
                                        cu_seqlens_kv_padded=(
                                            None
                                            if cu_seqlens_kv_padded is None
                                            else cu_seqlens_kv_padded // 2
773
774
                                        ),
                                    )
775
                                )
776
777
                                if len(rest) > 0:
                                    attn_biases[i] = rest[0]
778
779
                            else:
                                # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
780
                                q_inputs[i % 2] = q.view(-1, *q.shape[-2:])
781
782
                                if qkv_format == "thd":
                                    # [2, t, np, hn] -> [2, t/2, np, hn]
783
784
785
                                    kv_inputs[i % 2] = tex.thd_read_half_tensor(
                                        kv_inputs[i % 2], cu_seqlens_k, 0
                                    )
786
787
                                else:
                                    # [2, b, 2, sk//2, np, hn] -> [2, b, sk//2, np, hn]
788
                                    kv_inputs[i % 2] = kv_inputs[i % 2][:, :, 0, ...].contiguous()
789
                                # [2, b, sk//2, np, hn] -> [2, b*sk//2, np, hn]
790
                                kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-2:])
791
792
                                if _flash_attn_2_3_plus:
                                    fa_optional_forward_kwargs["window_size"] = [-1, -1]
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
                                (
                                    _,
                                    _,
                                    _,
                                    _,
                                    out_per_step[i],
                                    softmax_lse_per_step[i],
                                    _,
                                    rng_states[i],
                                ) = _flash_attn_forward(
                                    q_inputs[i % 2],
                                    kv_inputs[i % 2][0],
                                    kv_inputs[i % 2][1],
                                    cu_seqlens_q,
                                    cu_seqlens_k // 2,
                                    max_seqlen_q,
                                    max_seqlen_k // 2,
                                    dropout_p,
                                    softmax_scale,
                                    causal=False,
                                    return_softmax=False,
                                    **fa_optional_forward_kwargs,
815
816
817
                                )
                        else:
                            if use_fused_attention:
818
819
                                if qkv_format == "bshd":
                                    # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
820
                                    q_inputs[i % 2] = q[:, 1, ...].contiguous()
821
                                    # [2, b, 2, sk//2, np, hn] -> [2, b, sk, np, hn]
822
823
824
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(
                                        2, k.shape[0], -1, *k.shape[-2:]
                                    )
825
826
                                elif qkv_format == "sbhd":
                                    # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
827
                                    q_inputs[i % 2] = q[1].contiguous()
828
                                    # [2, 2, sk//2, b, np, hn] -> [2, sk, b, np, hn]
829
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-3:])
830
831
                                elif qkv_format == "thd":
                                    # [t, np, hn] -> [t/2, np, hn]
832
                                    q_inputs[i % 2] = tex.thd_read_half_tensor(q, cu_seqlens_q, 1)
833
834
                                if attn_bias is not None:
                                    idx = (rank - i) % cp_size
835
836
837
838
839
840
                                    attn_bias_inputs[i % 2] = torch.cat(
                                        (
                                            attn_bias_[..., 1, :, idx, :],
                                            attn_bias_[..., 1, :, (2 * cp_size - idx - 1), :],
                                        ),
                                        dim=-1,
841
                                    ).contiguous()
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
                                out_per_step[i], [softmax_lse_per_step[i], rng_states[i], *rest] = (
                                    fused_attn_fwd(
                                        is_training,
                                        max_seqlen_q // 2,
                                        max_seqlen_k,
                                        cu_seqlens_q // 2,
                                        cu_seqlens_k,
                                        q_inputs[i % 2],
                                        kv_inputs[i % 2][0],
                                        kv_inputs[i % 2][1],
                                        TE_DType[q.dtype],
                                        tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
                                        attn_scale=softmax_scale,
                                        dropout=dropout_p,
                                        qkv_layout=qkv_layout,
                                        attn_mask_type="padding" if padding else "no_mask",
                                        attn_bias_type=attn_bias_type,
                                        attn_bias=attn_bias_inputs[i % 2],
860
861
862
863
                                        cu_seqlens_q_padded=(
                                            None
                                            if cu_seqlens_q_padded is None
                                            else cu_seqlens_q_padded // 2
864
                                        ),
865
                                        cu_seqlens_kv_padded=cu_seqlens_kv_padded,
866
                                    )
867
                                )
868
869
                                if len(rest) > 0:
                                    attn_biases[i] = rest[0]
870
                            else:
871
872
                                if qkv_format == "thd":
                                    # [t, np, hn] -> [t/2, np, hn]
873
                                    q_inputs[i % 2] = tex.thd_read_half_tensor(q, cu_seqlens_q, 1)
874
875
                                else:
                                    # [b, 2, sq//2, np, hn]->[b, sq//2, np, hn]->[b*sq//2, np, hn]
876
                                    q_inputs[i % 2] = (
877
                                        q[:, 1, ...].contiguous().view(-1, *q.shape[-2:])
878
                                    )
879
                                # [2, b, 2, sk//2, np, hn] -> [2, b*sk, np, hn]
880
                                kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-2:])
881
882
                                if _flash_attn_2_3_plus:
                                    fa_optional_forward_kwargs["window_size"] = [-1, -1]
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
                                (
                                    _,
                                    _,
                                    _,
                                    _,
                                    out_per_step[i],
                                    softmax_lse_per_step[i],
                                    _,
                                    rng_states[i],
                                ) = _flash_attn_forward(
                                    q_inputs[i % 2],
                                    kv_inputs[i % 2][0],
                                    kv_inputs[i % 2][1],
                                    cu_seqlens_q // 2,
                                    cu_seqlens_k,
                                    max_seqlen_q // 2,
                                    max_seqlen_k,
                                    dropout_p,
                                    softmax_scale,
                                    causal=False,
                                    return_softmax=False,
                                    **fa_optional_forward_kwargs,
905
906
907
                                )
                    else:
                        if use_fused_attention:
908
909
                            if attn_bias is not None:
                                idx = (rank - i) % cp_size
910
911
912
913
914
915
                                attn_bias_inputs[i % 2] = torch.cat(
                                    (
                                        attn_bias[..., idx, :],
                                        attn_bias[..., (2 * cp_size - idx - 1), :],
                                    ),
                                    dim=-1,
916
                                ).contiguous()
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
                            out_per_step[i], [softmax_lse_per_step[i], rng_states[i], *rest] = (
                                fused_attn_fwd(
                                    is_training,
                                    max_seqlen_q,
                                    max_seqlen_k,
                                    cu_seqlens_q,
                                    cu_seqlens_k,
                                    q,
                                    kv_inputs[i % 2][0],
                                    kv_inputs[i % 2][1],
                                    TE_DType[q.dtype],
                                    tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
                                    attn_scale=softmax_scale,
                                    dropout=dropout_p,
                                    qkv_layout=qkv_layout,
                                    attn_mask_type=attn_mask_type,
                                    attn_bias_type=attn_bias_type,
                                    attn_bias=attn_bias_inputs[i % 2],
935
936
                                    cu_seqlens_q_padded=cu_seqlens_q_padded,
                                    cu_seqlens_kv_padded=cu_seqlens_kv_padded,
937
                                )
938
                            )
939
940
                            if len(rest) > 0:
                                attn_biases[i] = rest[0]
941
                        else:
942
                            # [b, sq, np, hn] -> [b*sq, np, hn]
943
                            q_inputs[i % 2] = q.view(-1, *q.shape[-2:])
944
                            # [2, b, sk, np, hn] -> [2, b*sk, np, hn]
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
                            kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-2:])
                            (
                                _,
                                _,
                                _,
                                _,
                                out_per_step[i],
                                softmax_lse_per_step[i],
                                _,
                                rng_states[i],
                            ) = _flash_attn_forward(
                                q_inputs[i % 2],
                                kv_inputs[i % 2][0],
                                kv_inputs[i % 2][1],
                                cu_seqlens_q,
                                cu_seqlens_k,
                                max_seqlen_q,
                                max_seqlen_k,
                                dropout_p,
                                softmax_scale,
                                causal=False,
                                return_softmax=False,
                                **fa_optional_forward_kwargs,
968
                            )
969
970
971
972

            if i > 0:
                # wait until fwd restuls correction of last step is done
                if i > 1:
973
                    flash_attn_streams[(i - 1) % 2].wait_event(fwd_results_correction_done)
974

975
976
                if use_fused_attention:
                    # [b, np, sq, 1] -> [b, np, sq]
977
                    softmax_lse_per_step[i - 1].squeeze_(-1)
978

979
                with torch.cuda.stream(flash_attn_streams[(i - 1) % 2]):
980
981
982
                    if i == 1:
                        out = torch.empty_like(q).zero_()
                        softmax_lse = torch.clone(softmax_lse_per_step[0]).to(torch.double)
983
                        if causal and qkv_format != "thd":
984
985
                            # [b, np, sq] -> [b, np, 2, sq//2]
                            softmax_lse_ = softmax_lse.view(
986
                                *softmax_lse.shape[:-1], 2, softmax_lse.shape[-1] // 2
987
                            )
988
989
990
991
                    elif (i - 1) <= rank or not causal:
                        flash_attn_fwd_softmax_lse_correction(
                            softmax_lse, softmax_lse_per_step[i - 1]
                        )
992
                    else:
993
                        if qkv_format == "thd":
994
995
996
                            tex.thd_second_half_lse_correction(
                                softmax_lse, softmax_lse_per_step[i - 1], cu_seqlens_q, q.size(0)
                            )
997
                        else:
998
999
1000
                            flash_attn_fwd_softmax_lse_correction(
                                softmax_lse_[..., 1, :], softmax_lse_per_step[i - 1]
                            )
1001
1002

                if i < cp_size:
1003
                    flash_attn_streams[(i - 1) % 2].record_event(fwd_results_correction_done)
1004
1005
1006
1007

        torch.cuda.current_stream().wait_stream(flash_attn_streams[1])

        softmax_lse = softmax_lse.to(torch.float)
1008
1009
        if qkv_format in ["bshd", "sbhd"]:
            seq_dim = qkv_format.index("s")
1010
        for i in range(cp_size):
1011
1012
1013
1014
1015
1016
            if qkv_format == "bshd":
                out_per_step[i] = out_per_step[i].view(out.shape[0], -1, *out.shape[-2:])
                out_ = out[:, 1, ...]
            elif qkv_format == "sbhd":
                out_per_step[i] = out_per_step[i].view(-1, *out.shape[-3:])
                out_ = out[1]
1017

1018
            if i <= rank or not causal:
1019
                if qkv_format in ["bshd", "sbhd"]:
1020
1021
1022
1023
1024
1025
1026
                    flash_attn_fwd_out_correction(
                        out.view(*out_per_step[i].shape),
                        out_per_step[i],
                        seq_dim,
                        softmax_lse,
                        softmax_lse_per_step[i],
                    )
1027
                elif qkv_format == "thd":
1028
1029
1030
1031
1032
1033
1034
1035
                    tex.thd_out_correction(
                        out,
                        out_per_step[i],
                        softmax_lse,
                        softmax_lse_per_step[i],
                        cu_seqlens_q,
                        False,
                    )
1036
1037
                else:
                    assert False, f"{qkv_format} is an unsupported qkv_format!"
1038
            else:
1039
                if qkv_format in ["bshd", "sbhd"]:
1040
1041
1042
1043
1044
1045
1046
                    flash_attn_fwd_out_correction(
                        out_,
                        out_per_step[i],
                        seq_dim,
                        softmax_lse_[..., 1, :],
                        softmax_lse_per_step[i],
                    )
1047
                elif qkv_format == "thd":
1048
1049
1050
1051
1052
1053
1054
1055
                    tex.thd_out_correction(
                        out,
                        out_per_step[i],
                        softmax_lse,
                        softmax_lse_per_step[i],
                        cu_seqlens_q,
                        True,
                    )
1056
1057
                else:
                    assert False, f"{qkv_format} is an unsupported qkv_format!"
1058
1059

        kv = p2p_comm_buffers[-1]
1060
        if use_fused_attention:
1061
1062
1063
1064
            if qkv_format == "bshd":
                out = out.view(out.shape[0], -1, *out.shape[-2:])
            elif qkv_format == "sbhd":
                out = out.view(-1, *out.shape[-3:])
1065
1066
        else:
            out = out.view(-1, *out.shape[-2:])
1067

1068
        ctx.save_for_backward(
1069
1070
1071
1072
1073
1074
            q,
            kv,
            out,
            softmax_lse,
            cu_seqlens_q,
            cu_seqlens_k,
1075
1076
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
1077
1078
            *rng_states,
            *attn_biases,
1079
        )
1080
1081
1082
1083
1084
1085
        ctx.cp_group = cp_group
        ctx.cp_global_ranks = cp_global_ranks
        ctx.dropout_p = dropout_p
        ctx.max_seqlen_q = max_seqlen_q
        ctx.max_seqlen_k = max_seqlen_k
        ctx.softmax_scale = softmax_scale
1086
        ctx.qkv_format = qkv_format
1087
        ctx.attn_mask_type = attn_mask_type
1088
1089
        ctx.attn_bias_type = attn_bias_type
        ctx.attn_bias_shape = None if attn_bias is None else attn_bias.shape
1090
        ctx.deterministic = deterministic
1091
        ctx.use_fused_attention = use_fused_attention
1092
1093
1094
1095
        return out

    @staticmethod
    def backward(ctx, dout):
1096
        (q, kv, out, softmax_lse, cu_seqlens_q, cu_seqlens_k) = ctx.saved_tensors[:6]
1097
        (cu_seqlens_q_padded, cu_seqlens_kv_padded) = ctx.saved_tensors[6:8]
1098
        cp_size = get_distributed_world_size(ctx.cp_group)
1099
1100
        rng_states = ctx.saved_tensors[8 : 8 + cp_size]
        attn_biases = ctx.saved_tensors[8 + cp_size : 8 + cp_size * 2]
1101

1102
        rank = get_distributed_rank(ctx.cp_group)
1103
        send_dst = ctx.cp_global_ranks[(rank - 1) % cp_size]
1104
1105
1106
        recv_src = ctx.cp_global_ranks[(rank + 1) % cp_size]
        batch_p2p_comm = int(os.getenv("NVTE_BATCH_MHA_P2P_COMM", "0")) or (cp_size == 2)

1107
1108
        causal = "causal" in ctx.attn_mask_type
        padding = "padding" in ctx.attn_mask_type
1109
1110
        qkv_layout = ctx.qkv_format + "_" + ctx.qkv_format + "_" + ctx.qkv_format

1111
        if attn_biases[0] is not None:
1112
1113
            # [b, np, sq, 2*cp, sk//(2*cp)]
            attn_dbias = torch.zeros(
1114
                *ctx.attn_bias_shape, dtype=attn_biases[0].dtype, device=attn_biases[0].device
1115
1116
1117
            )
            # [b, np, sq, 2*cp, sk//(2*cp)] -> [b, np, 2, sq//2, 2*cp, sk//(2*cp)]
            attn_dbias_ = attn_dbias.view(
1118
                *attn_dbias.shape[:-3], 2, attn_dbias.shape[-3] // 2, *attn_dbias.shape[-2:]
1119
1120
1121
1122
            )
        else:
            attn_dbias = None

1123
        if causal:
1124
1125
1126
1127
            if ctx.qkv_format == "thd":
                softmax_lse_ = tex.thd_read_second_half_lse(softmax_lse, cu_seqlens_q, q.size(0))
            else:
                # [b, np, sq] -> [b, np, 2, sq//2]
1128
1129
1130
                softmax_lse_ = softmax_lse.view(
                    *softmax_lse.shape[:-1], 2, softmax_lse.shape[-1] // 2
                )
1131
1132
1133
1134
1135
                softmax_lse_ = softmax_lse_[..., 1, :].contiguous()
                if ctx.use_fused_attention:
                    # [b, np, sq//2] -> [b, np, sq//2, 1]
                    softmax_lse_.unsqueeze_(-1)

1136
1137
1138
        if ctx.use_fused_attention:
            # [b, np, sq] -> [b, np, sq, 1]
            softmax_lse.unsqueeze_(-1)
1139
1140
1141
1142
1143
        out = out.view(*q.shape)
        dout = dout.view(*q.shape)
        # Flash Attn outputs
        dq = torch.empty_like(q)

1144
1145
1146
1147
        p2p_comm_buffers = [
            torch.empty((2, *kv.shape), dtype=kv.dtype, device=kv.device),
            torch.empty((2, *kv.shape), dtype=kv.dtype, device=kv.device),
        ]
1148
1149
1150
        p2p_comm_buffers[0][0].copy_(kv)
        send_recv_reqs = []

1151
1152
1153
1154
1155
1156
        fa_optional_backward_kwargs = {}
        if _flash_attn_2_4_plus:
            fa_optional_backward_kwargs["alibi_slopes"] = None
        if _flash_attn_2_4_1_plus:
            fa_optional_backward_kwargs["deterministic"] = ctx.deterministic

1157
1158
1159
1160
1161
        for i in range(cp_size):
            # wait until KV is received
            for req in send_recv_reqs:
                req.wait()

1162
1163
            send_tensor = p2p_comm_buffers[i % 2]
            recv_tensor = p2p_comm_buffers[(i + 1) % 2]
1164
1165
1166
            if i == 0:
                send_tensor = send_tensor[0]
                recv_tensor = recv_tensor[0]
1167
            if i == (cp_size - 1):
1168
1169
1170
                send_tensor = send_tensor[1]
                recv_tensor = recv_tensor[1]

1171
1172
1173
            send_recv_reqs = flash_attn_p2p_communicate(
                rank, send_tensor, send_dst, recv_tensor, recv_src, ctx.cp_group, batch_p2p_comm
            )
1174

1175
            kv = p2p_comm_buffers[i % 2][0]
1176
            # In reversed order of fwd
1177
            if causal:
1178
                if i == (cp_size - 1):
1179
                    if ctx.use_fused_attention:
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
                        if ctx.qkv_format == "bshd":
                            # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
                            q_ = q.view(q.shape[0], -1, *q.shape[-2:])
                            # [2, b, 2, sk//2, np, hn] -> [2, b, sk, np, hn]
                            kv_ = kv.view(*kv.shape[0:2], -1, *kv.shape[-2:])
                            # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
                            out_ = out.view(out.shape[0], -1, *out.shape[-2:])
                            dout_ = dout.view(dout.shape[0], -1, *dout.shape[-2:])
                        elif ctx.qkv_format == "sbhd":
                            # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                            q_ = q.view(-1, *q.shape[-3:])
                            # [2, 2, sk//2, b, np, hn] -> [2, sk, b, np, hn]
                            kv_ = kv.view(kv.shape[0], -1, *kv.shape[-3:])
                            # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                            out_ = out.view(-1, *out.shape[-3:])
                            dout_ = dout.view(-1, *dout.shape[-3:])
1196
1197
                        elif ctx.qkv_format == "thd":
                            q_, kv_, out_, dout_ = q, kv, out, dout
1198
                        aux_ctx_tensors = [softmax_lse, rng_states[cp_size - i - 1]]
1199
                        if attn_dbias is not None:
1200
                            aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
1201
                        dq_, dk_, dv_, dbias_ = fused_attn_bwd(
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
                            ctx.max_seqlen_q,
                            ctx.max_seqlen_k,
                            cu_seqlens_q,
                            cu_seqlens_k,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            dout_,
                            TE_DType[q.dtype],
                            TE_DType[kv.dtype],
                            aux_ctx_tensors,
1214
                            tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
1215
1216
                            cu_seqlens_q_padded=cu_seqlens_q_padded,
                            cu_seqlens_kv_padded=cu_seqlens_kv_padded,
1217
1218
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
1219
                            qkv_layout=qkv_layout,
1220
                            attn_mask_type=ctx.attn_mask_type,
1221
                            attn_bias_type=ctx.attn_bias_type,
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
                        )
                    else:
                        # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
                        q_ = q.view(-1, *q.shape[-2:])
                        dq_ = torch.empty_like(q_)
                        # [2, b, 2, sk//2, np, hn] -> [2, b*sk, np, hn]
                        kv_ = kv.view(2, -1, *kv.shape[-2:])
                        dkv_ = torch.empty_like(kv_)
                        # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
                        out_ = out.view(-1, *out.shape[-2:])
                        dout_ = dout.view(-1, *dout.shape[-2:])
                        if _flash_attn_2_3_plus:
                            fa_optional_backward_kwargs["window_size"] = [-1, 0]
                        _flash_attn_backward(
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
                            dout_,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            softmax_lse,
                            dq_,
                            dkv_[0],
                            dkv_[1],
                            cu_seqlens_q,
                            cu_seqlens_k,
                            ctx.max_seqlen_q,
                            ctx.max_seqlen_k,
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            True,
                            rng_state=rng_states[cp_size - i - 1],
                            **fa_optional_backward_kwargs,
1254
                        )
1255
                elif i >= (cp_size - rank - 1):
1256
                    if ctx.use_fused_attention:
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
                        if ctx.qkv_format == "bshd":
                            # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
                            q_ = q.view(q.shape[0], -1, *q.shape[-2:])
                            # [2, b, 2, sk//2, np, hn] -> [2, b, sk//2, np, hn]
                            kv_ = kv[:, :, 0, ...].contiguous()
                            # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
                            out_ = out.view(out.shape[0], -1, *out.shape[-2:])
                            dout_ = dout.view(dout.shape[0], -1, *dout.shape[-2:])
                        elif ctx.qkv_format == "sbhd":
                            # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                            q_ = q.view(-1, *q.shape[-3:])
                            # [2, 2, sk//2, b, np, hn] -> [2, sk//2, b, np, hn]
                            kv_ = kv[:, 0, ...].contiguous()
                            # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                            out_ = out.view(-1, *out.shape[-3:])
                            dout_ = dout.view(-1, *dout.shape[-3:])
1273
1274
1275
1276
                        elif ctx.qkv_format == "thd":
                            q_, out_, dout_ = q, out, dout
                            # [2, t, np, hn] -> [2, t/2, np, hn]
                            kv_ = tex.thd_read_half_tensor(kv, cu_seqlens_k, 0)
1277
                        aux_ctx_tensors = [softmax_lse, rng_states[cp_size - i - 1]]
1278
                        if attn_dbias is not None:
1279
                            aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
1280
                        dq_, dk_, dv_, dbias_ = fused_attn_bwd(
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
                            ctx.max_seqlen_q,
                            ctx.max_seqlen_k // 2,
                            cu_seqlens_q,
                            cu_seqlens_k // 2,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            dout_,
                            TE_DType[q.dtype],
                            TE_DType[kv.dtype],
                            aux_ctx_tensors,
1293
                            tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
1294
1295
1296
1297
                            cu_seqlens_q_padded=cu_seqlens_q_padded,
                            cu_seqlens_kv_padded=(
                                None if cu_seqlens_kv_padded is None else cu_seqlens_kv_padded // 2
                            ),
1298
1299
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
1300
                            qkv_layout=qkv_layout,
1301
                            attn_mask_type="padding" if padding else "no_mask",
1302
                            attn_bias_type=ctx.attn_bias_type,
1303
1304
1305
1306
1307
                        )
                    else:
                        # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
                        q_ = q.view(-1, *q.shape[-2:])
                        dq_ = torch.empty_like(q_)
1308
1309
1310
1311
1312
1313
                        if ctx.qkv_format == "thd":
                            # [2, t, np, hn] -> [2, t/2, np, hn]
                            kv_ = tex.thd_read_half_tensor(kv, cu_seqlens_k, 0)
                        else:
                            # [2, b, 2, sk//2, np, hn]->[2, b, sk//2, np, hn]->[2, b*sk//2, np, hn]
                            kv_ = kv[:, :, 0, ...].contiguous().view(2, -1, *kv.shape[-2:])
1314
1315
1316
1317
1318
1319
1320
                        dkv_ = torch.empty_like(kv_)
                        # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
                        out_ = out.view(-1, *out.shape[-2:])
                        dout_ = dout.view(-1, *dout.shape[-2:])
                        if _flash_attn_2_3_plus:
                            fa_optional_backward_kwargs["window_size"] = [-1, -1]
                        _flash_attn_backward(
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
                            dout_,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            softmax_lse,
                            dq_,
                            dkv_[0],
                            dkv_[1],
                            cu_seqlens_q,
                            cu_seqlens_k // 2,
                            ctx.max_seqlen_q,
                            ctx.max_seqlen_k // 2,
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            False,
                            rng_state=rng_states[cp_size - i - 1],
                            **fa_optional_backward_kwargs,
1339
1340
1341
                        )
                else:
                    if ctx.use_fused_attention:
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
                        if ctx.qkv_format == "bshd":
                            # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
                            q_ = q[:, 1, ...].contiguous()
                            # [2, b, 2, sk//2, np, hn] -> [2, b, sk, np, hn]
                            kv_ = kv.view(*kv.shape[0:2], -1, *kv.shape[-2:])
                            # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
                            out_ = out[:, 1, ...].contiguous()
                            dout_ = dout[:, 1, ...].contiguous()
                        elif ctx.qkv_format == "sbhd":
                            # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
                            q_ = q[1].contiguous()
                            # [2, 2, sk//2, b, np, hn] -> [2, sk, b, np, hn]
                            kv_ = kv.view(kv.shape[0], -1, *kv.shape[-3:])
                            # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
                            out_ = out[1].contiguous()
                            dout_ = dout[1].contiguous()
1358
1359
1360
1361
1362
1363
                        elif ctx.qkv_format == "thd":
                            # [t, np, hn] -> [t/2, np, hn]
                            q_ = tex.thd_read_half_tensor(q, cu_seqlens_q, 1)
                            out_ = tex.thd_read_half_tensor(out, cu_seqlens_q, 1)
                            dout_ = tex.thd_read_half_tensor(dout, cu_seqlens_q, 1)
                            kv_ = kv
1364
                        aux_ctx_tensors = [softmax_lse_, rng_states[cp_size - i - 1]]
1365
                        if attn_dbias is not None:
1366
                            aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
1367
                        dq_, dk_, dv_, dbias_ = fused_attn_bwd(
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
                            ctx.max_seqlen_q // 2,
                            ctx.max_seqlen_k,
                            cu_seqlens_q // 2,
                            cu_seqlens_k,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            dout_,
                            TE_DType[q.dtype],
                            TE_DType[kv.dtype],
                            aux_ctx_tensors,
1380
                            tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
1381
1382
1383
1384
                            cu_seqlens_q_padded=(
                                None if cu_seqlens_q_padded is None else cu_seqlens_q_padded // 2
                            ),
                            cu_seqlens_kv_padded=cu_seqlens_kv_padded,
1385
1386
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
1387
                            qkv_layout=qkv_layout,
1388
                            attn_mask_type="padding" if padding else "no_mask",
1389
                            attn_bias_type=ctx.attn_bias_type,
1390
1391
                        )
                    else:
1392
1393
1394
1395
1396
1397
                        if ctx.qkv_format == "thd":
                            # [t, np, hn] -> [t/2, np, hn]
                            q_ = tex.thd_read_half_tensor(q, cu_seqlens_q, 1)
                        else:
                            # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn] -> [b*sq//2, np, hn]
                            q_ = q[:, 1, ...].contiguous().view(-1, *q.shape[-2:])
1398
1399
1400
1401
                        dq_ = torch.empty_like(q_)
                        # [2, b, 2, sk//2, np, hn] -> [2, b*sk, np, hn]
                        kv_ = kv.view(2, -1, *kv.shape[-2:])
                        dkv_ = torch.empty_like(kv_)
1402
1403
1404
1405
1406
1407
1408
                        if ctx.qkv_format == "thd":
                            out_ = tex.thd_read_half_tensor(out, cu_seqlens_q, 1)
                            dout_ = tex.thd_read_half_tensor(dout, cu_seqlens_q, 1)
                        else:
                            # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn] -> [b*sq//2, np, hn]
                            out_ = out[:, 1, ...].contiguous().view(-1, *out.shape[-2:])
                            dout_ = dout[:, 1, ...].contiguous().view(-1, *dout.shape[-2:])
1409
1410
1411
                        if _flash_attn_2_3_plus:
                            fa_optional_backward_kwargs["window_size"] = [-1, -1]
                        _flash_attn_backward(
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
                            dout_,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            softmax_lse_,
                            dq_,
                            dkv_[0],
                            dkv_[1],
                            cu_seqlens_q // 2,
                            cu_seqlens_k,
                            ctx.max_seqlen_q // 2,
                            ctx.max_seqlen_k,
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            False,
                            rng_state=rng_states[cp_size - i - 1],
                            **fa_optional_backward_kwargs,
1430
1431
1432
                        )
            else:
                if ctx.use_fused_attention:
1433
                    aux_ctx_tensors = [softmax_lse, rng_states[cp_size - i - 1]]
1434
                    if attn_dbias is not None:
1435
                        aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
1436
                    dq_, dk_, dv_, dbias_ = fused_attn_bwd(
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
                        ctx.max_seqlen_q,
                        ctx.max_seqlen_k,
                        cu_seqlens_q,
                        cu_seqlens_k,
                        q,
                        kv[0],
                        kv[1],
                        out,
                        dout,
                        TE_DType[q.dtype],
                        TE_DType[kv.dtype],
                        aux_ctx_tensors,
1449
                        tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
1450
1451
                        cu_seqlens_q_padded=cu_seqlens_q_padded,
                        cu_seqlens_kv_padded=cu_seqlens_kv_padded,
1452
1453
                        attn_scale=ctx.softmax_scale,
                        dropout=ctx.dropout_p,
1454
                        qkv_layout=qkv_layout,
1455
                        attn_mask_type=ctx.attn_mask_type,
1456
                        attn_bias_type=ctx.attn_bias_type,
1457
1458
1459
                    )
                else:
                    # [b, sq, np, hn] -> [b*sq, np, hn]
1460
1461
                    q_ = q.view(-1, *q.shape[-2:])
                    dq_ = torch.empty_like(q_)
1462
                    # [2, b, sk, np, hn] -> [2, b*sk, np, hn]
1463
1464
                    kv_ = kv.view(2, -1, *kv.shape[-2:])
                    dkv_ = torch.empty_like(kv_)
1465
                    # [b, sq, np, hn] -> [b*sq, np, hn]
1466
1467
                    out_ = out.view(-1, *out.shape[-2:])
                    dout_ = dout.view(-1, *dout.shape[-2:])
1468
1469
                    if _flash_attn_2_3_plus:
                        fa_optional_backward_kwargs["window_size"] = [-1, -1]
1470
                    _flash_attn_backward(
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
                        dout_,
                        q_,
                        kv_[0],
                        kv_[1],
                        out_,
                        softmax_lse,
                        dq_,
                        dkv_[0],
                        dkv_[1],
                        cu_seqlens_q,
                        cu_seqlens_k,
                        ctx.max_seqlen_q,
                        ctx.max_seqlen_k,
                        ctx.dropout_p,
                        ctx.softmax_scale,
                        False,
                        **fa_optional_backward_kwargs,
1488
1489
                    )

1490
            if i >= (cp_size - rank - 1) or not causal:
1491
1492
1493
1494
                # [b*sq, np, hn] -> [b, 2, sq//2, np, hn] if causal
                # [b*sq, np, hn] -> [b, sq, np, hn] if not causal
                dq_ = dq_.view(*dq.shape)
            else:
1495
1496
1497
1498
1499
1500
                if ctx.qkv_format == "bshd":
                    # [b*sq//2, np, hn] -> [b, sq//2, np, hn]
                    dq_ = dq_.view(dq.shape[0], *dq.shape[2:])
                elif ctx.qkv_format == "sbhd":
                    # [b*sq//2, np, hn] -> [sq//2, b, np, hn]
                    dq_ = dq_.view(-1, *dq.shape[-3:])
1501

1502
            if causal:
1503
                if i > (cp_size - rank - 1):
1504
                    dq.add_(dq_)
1505
1506
                elif i == (cp_size - rank - 1):
                    if rank == (cp_size - 1):
1507
1508
                        dq.copy_(dq_)
                    else:
1509
1510
1511
1512
1513
1514
                        if ctx.qkv_format == "bshd":
                            dq[:, 0, ...].copy_(dq_[:, 0, ...])
                            dq[:, 1, ...].add_(dq_[:, 1, ...])
                        elif ctx.qkv_format == "sbhd":
                            dq[0].copy_(dq_[0])
                            dq[1].add_(dq_[1])
1515
1516
                        elif ctx.qkv_format == "thd":
                            tex.thd_grad_correction(dq, dq_, cu_seqlens_q, "copy", "add")
1517
                elif i > 0:
1518
1519
1520
1521
                    if ctx.qkv_format == "bshd":
                        dq[:, 1, ...].add_(dq_)
                    elif ctx.qkv_format == "sbhd":
                        dq[1].add_(dq_)
1522
1523
                    elif ctx.qkv_format == "thd":
                        tex.thd_grad_correction(dq, dq_, cu_seqlens_q, "none", "add")
1524
                else:
1525
1526
1527
1528
                    if ctx.qkv_format == "bshd":
                        dq[:, 1, ...].copy_(dq_)
                    elif ctx.qkv_format == "sbhd":
                        dq[1].copy_(dq_)
1529
1530
                    elif ctx.qkv_format == "thd":
                        tex.thd_grad_correction(dq, dq_, cu_seqlens_q, "none", "copy")
1531
1532
1533
1534
1535
            else:
                if i == 0:
                    dq.copy_(dq_)
                else:
                    dq.add_(dq_)
1536

1537
            if attn_dbias is not None:
1538
                idx = (rank + i + 1) % cp_size
1539
                if i == (cp_size - 1) or not causal:
1540
                    # [b, np, sq, sk//cp] -> [b, np, sq, 2, sk//(2*cp)]
1541
                    dbias_ = dbias_.view(*dbias_.shape[:-1], 2, dbias_.shape[-1] // 2)
1542
                    attn_dbias[..., idx, :].copy_(dbias_[..., 0, :])
1543
1544
                    attn_dbias[..., (2 * cp_size - idx - 1), :].copy_(dbias_[..., 1, :])
                elif i >= (cp_size - rank - 1):
1545
1546
1547
1548
                    # [b, np, sq, sk//(2*cp)]
                    attn_dbias[..., idx, :].copy_(dbias_)
                else:
                    # [b, np, sq//2, sk//cp] -> [b, np, sq//2, 2, sk//(2*cp)]
1549
                    dbias_ = dbias_.view(*dbias_.shape[:-1], 2, dbias_.shape[-1] // 2)
1550
                    attn_dbias_[..., 1, :, idx, :].copy_(dbias_[..., 0, :])
1551
                    attn_dbias_[..., 1, :, (2 * cp_size - idx - 1), :].copy_(dbias_[..., 1, :])
1552

1553
1554
1555
            # wait until dKV is received
            for req in send_recv_reqs:
                req.wait()
1556

1557
            dkv = p2p_comm_buffers[(i + 1) % 2][1]
1558
1559
            if ctx.use_fused_attention:
                dkv_ = torch.cat((dk_.unsqueeze(0), dv_.unsqueeze(0)), dim=0)
1560
            if causal and i >= (cp_size - rank - 1) and i != (cp_size - 1):
1561
1562
1563
1564
1565
1566
                if ctx.qkv_format == "bshd":
                    # [2, b*sk//2, np, hn] -> [2, b, sk//2, np, hn]
                    dkv_ = dkv_.view(*dkv.shape[0:2], *dkv.shape[3:])
                elif ctx.qkv_format == "sbhd":
                    # [2, b*sk//2, np, hn] -> [2, sk//2, b, np, hn]
                    dkv_ = dkv_.view(dkv.shape[0], -1, *dkv.shape[-3:])
1567
1568
1569
1570
            else:
                # [2, b*sk, np, hn] -> [2, b, 2, sk//2, np, hn] if causal
                # [2, b*sk, np, hn] -> [2, b, sk, np, hn] if not causal
                dkv_ = dkv_.view(*dkv.shape)
1571

1572
            if causal:
1573
                if i == (cp_size - 1):
1574
                    if rank == 0:
1575
1576
1577
1578
1579
1580
                        if ctx.qkv_format == "bshd":
                            dkv[:, :, 0, ...].add_(dkv_[:, :, 0, ...])
                            dkv[:, :, 1, ...].copy_(dkv_[:, :, 1, ...])
                        elif ctx.qkv_format == "sbhd":
                            dkv[:, 0, ...].add_(dkv_[:, 0, ...])
                            dkv[:, 1, ...].copy_(dkv_[:, 1, ...])
1581
1582
                        elif ctx.qkv_format == "thd":
                            tex.thd_grad_correction(dkv, dkv_, cu_seqlens_k, "add", "copy")
1583
1584
                    else:
                        dkv.add_(dkv_)
1585
1586
                elif i >= (cp_size - rank - 1):
                    if i == 0 and rank == (cp_size - 1):
1587
1588
1589
1590
                        if ctx.qkv_format == "bshd":
                            dkv[:, :, 0, ...].copy_(dkv_)
                        elif ctx.qkv_format == "sbhd":
                            dkv[:, 0, ...].copy_(dkv_)
1591
1592
                        elif ctx.qkv_format == "thd":
                            tex.thd_grad_correction(dkv, dkv_, cu_seqlens_k, "copy", "none")
1593
                    else:
1594
1595
1596
1597
                        if ctx.qkv_format == "bshd":
                            dkv[:, :, 0, ...].add_(dkv_)
                        elif ctx.qkv_format == "sbhd":
                            dkv[:, 0, ...].add_(dkv_)
1598
1599
                        elif ctx.qkv_format == "thd":
                            tex.thd_grad_correction(dkv, dkv_, cu_seqlens_k, "add", "none")
1600
1601
1602
1603
1604
                elif i > 0:
                    dkv.add_(dkv_)
                else:
                    dkv.copy_(dkv_)
            else:
1605
1606
1607
1608
1609
                if i == 0:
                    dkv.copy_(dkv_)
                else:
                    dkv.add_(dkv_)

1610
        if causal:
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
            if ctx.qkv_format == "bshd":
                # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
                dq = dq.view(q.shape[0], -1, *q.shape[-2:])
                # [2, b, 2, sk//2, np, hn] -> [2, b, sk, np, hn]
                dkv = dkv.view(*kv.shape[0:2], -1, *kv.shape[-2:])
            elif ctx.qkv_format == "sbhd":
                # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                dq = dq.view(-1, *q.shape[-3:])
                # [2, 2, sk//2, b, np, hn] -> [2, sk, b, np, hn]
                dkv = dkv.view(kv.shape[0], -1, *kv.shape[-3:])

        if attn_dbias is not None:
            # [b, np, sq, 2*cp, sk//(2*cp)] -> [b, np, sq, sk]
            attn_dbias = attn_dbias.view(*attn_dbias.shape[:-2], -1)

1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
        return (
            None,
            dq,
            dkv[0],
            dkv[1],
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            attn_dbias,
            None,
            None,
        )
1649
1650
1651


def attn_forward_func_with_cp(
1652
1653
1654
1655
1656
1657
1658
1659
    is_training,
    q,
    k,
    v,
    cu_seqlens_q,
    cu_seqlens_k,
    max_seqlen_q,
    max_seqlen_k,
1660
1661
    cu_seqlens_q_padded,
    cu_seqlens_kv_padded,
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
    dropout_p,
    cp_group,
    cp_global_ranks,
    cp_stream,
    softmax_scale=None,
    qkv_format="bshd",
    attn_mask_type="causal",
    attn_bias_type="no_bias",
    attn_bias=None,
    deterministic=False,
    use_fused_attention=False,
1673
1674
) -> torch.Tensor:
    """Attention implementation with context parallelism"""
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
    assert qkv_format in [
        "bshd",
        "sbhd",
        "thd",
    ], f"QKV format of {qkv_format} is not supported with context parallelism!"
    assert (
        qkv_format != "sbhd" or use_fused_attention
    ), "FlashAttention does not support sbhd format!"
    assert (
        qkv_format != "thd"
        or not use_fused_attention
        or attn_mask_type in ["padding", "padding_causal"]
    ), (
        f"Context parallelism is not supported for {attn_mask_type} mask type and "
        f"{qkv_format} format with {'FusedAttention' if use_fused_attention else 'FlashAttention'}!"
    )
    assert attn_bias is None or (use_fused_attention and "padding" not in attn_mask_type), (
        """Attention bias is only supported with FusedAttention and "causal" """
        """or "no_mask" mask types!"""
    )
1695
    out = AttnFuncWithCP.apply(
1696
1697
1698
1699
1700
1701
1702
1703
        is_training,
        q,
        k,
        v,
        cu_seqlens_q,
        cu_seqlens_k,
        max_seqlen_q,
        max_seqlen_k,
1704
1705
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
        dropout_p,
        cp_group,
        cp_global_ranks,
        cp_stream,
        softmax_scale,
        qkv_format,
        attn_mask_type,
        attn_bias_type,
        attn_bias,
        deterministic,
        use_fused_attention,
1717
1718
1719
1720
    )
    return out


1721
1722
1723
1724
class RotaryPositionEmbedding(torch.nn.Module):
    """
    Implements Rotary Position Embedding from https://arxiv.org/abs/2104.09864.
    """
1725

1726
1727
1728
    def __init__(
        self,
        dim: int,
1729
        rotary_percent: float = 1.0,
1730
1731
1732
1733
1734
1735
1736
1737
        seq_len_interpolation_factor: Optional[int] = None,
        pretrained_max_position_embeddings: Optional[int] = None,
    ):
        """
        Parameters
        ----------
        dim: int
            rotary embedding dimension
1738
1739
        rotary_percent: float
            Percent of rotary dimension to use for rotary position embeddings.
1740
1741
1742
1743
1744
1745
1746
        seq_len_interpolation_factor: int
            if not None, discrete positions will be interpolated by this factor via the trick in
            https://arxiv.org/abs/2306.15595
        pretrained_max_position_embeddings: int
            pre-trained max_position_embeddings before position interpolation
        """
        super().__init__()
1747
1748
        if rotary_percent < 1.0:
            dim = int(dim * rotary_percent)
1749
        self.seq_len_interpolation_factor = seq_len_interpolation_factor
1750
1751
1752
1753
1754
1755
1756
        inv_freq = 1.0 / (
            10000
            ** (
                torch.arange(0, dim, 2, dtype=torch.float32, device=torch.cuda.current_device())
                / dim
            )
        )
1757
        self.register_buffer("inv_freq", inv_freq)
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
        self.pretrained_max_position_embeddings = pretrained_max_position_embeddings

    def forward(self, max_seq_len: int, offset: int = 0):
        """
        Create rotary position embedding frequencies

        Parameters
        ----------
        max_seq_len: int
            sequence length of a sample
        offset: int, default = 0
            fixed offset for freqencies
        """
1771
1772
1773
1774
        seq = (
            torch.arange(max_seq_len, device=self.inv_freq.device, dtype=self.inv_freq.dtype)
            + offset
        )
1775

1776
1777
1778
1779
1780
1781
1782
1783
        if (
            self.pretrained_max_position_embeddings is not None
            and self.seq_len_interpolation_factor is not None
        ):
            if (
                max_seq_len
                > self.pretrained_max_position_embeddings * self.seq_len_interpolation_factor
            ):
1784
1785
1786
1787
1788
1789
                # dynamic linear scaling (length > position we have learned)
                seq *= 1 / (max_seq_len / self.pretrained_max_position_embeddings)
            else:
                # fixed linear scaling
                seq *= 1 / self.seq_len_interpolation_factor

1790
        freqs = torch.einsum("i , j -> i j", seq, self.inv_freq)
1791
1792
1793
1794
1795
1796
        # first part even vector components, second part odd vector components,
        #  2 * dim in dimension size
        emb = torch.cat((freqs, freqs), dim=-1)
        # emb [seq_length, .., dim]
        return emb.reshape(emb.size(0), 1, 1, emb.size(1))

1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814

class FusedRoPEFunc(torch.autograd.Function):
    """
    Function for FusedRoPE

    This implementation assumes the input tensor to be in `sbhd`, `bshd` or `thd` format and
    the RoPE tensor to be of shape (s, 1, 1, d). It accepts arbitrary memory layouts to avoid
    the expensive `.contiguous()` calls, thus it may not achieve the best memory access pattern.
    """

    @staticmethod
    def forward(
        ctx,
        t: torch.Tensor,
        freqs: torch.Tensor,
        tensor_format: str = "sbhd",
        cu_seqlens: Union[torch.Tensor, None] = None,
    ) -> torch.Tensor:
1815
1816
        if freqs.dtype != torch.float32:
            freqs = freqs.float()
1817
1818
1819
        if tensor_format == "sbhd":
            output = tex.fused_rope_forward(t, freqs, False)
        elif tensor_format == "bshd":
1820
            output = tex.fused_rope_forward(t.transpose(0, 1), freqs, True).transpose(0, 1)
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
        elif tensor_format == "thd":
            output = tex.fused_rope_thd_forward(t, cu_seqlens, freqs)
        else:
            raise ValueError(f"Unsupported tensor_format: {tensor_format}.")
        ctx.save_for_backward(freqs, cu_seqlens)
        ctx.tensor_format = tensor_format

        return output

    @staticmethod
1831
    def backward(ctx, grad_output: torch.Tensor) -> Tuple[Union[torch.Tensor, None], ...]:
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
        freqs, cu_seqlens = ctx.saved_tensors
        if ctx.tensor_format == "sbhd":
            grad_input = tex.fused_rope_backward(grad_output, freqs, False)
        elif ctx.tensor_format == "bshd":
            grad_input = tex.fused_rope_backward(
                grad_output.transpose(0, 1), freqs, True
            ).transpose(0, 1)
        elif ctx.tensor_format == "thd":
            grad_input = tex.fused_rope_thd_backward(grad_output, cu_seqlens, freqs)
        else:
            raise ValueError(f"Unsupported tensor_format: {ctx.tensor_format}.")

        return grad_input, None, None, None, None


1847
1848
1849
1850
1851
1852
1853
1854
1855
def _rotate_half(x: torch.Tensor) -> torch.Tensor:
    """
    change sign so the last dimension becomes [-odd, +even]
    """
    x = x.view(x.shape[:-1] + torch.Size((2, x.shape[-1] // 2)))
    x1, x2 = x.unbind(dim=-2)
    return torch.cat((-x2, x1), dim=-1)


1856
def apply_rotary_pos_emb(
1857
1858
1859
1860
1861
1862
    t: torch.Tensor,
    freqs: torch.Tensor,
    tensor_format: str = "sbhd",
    fused: bool = False,
    cu_seqlens: Union[torch.Tensor, None] = None,
) -> torch.Tensor:
1863
    """
1864
    Apply rotary positional embedding tensor to the input tensor.
1865

1866
1867
1868
    Parameters
    ----------
    t: torch.Tensor
1869
        Input tensor of shape `[s, b, h, d]`, `[b, s, h, d]` or `[t, h, d]`, on which
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
        rotary positional embedding will be applied.
    freqs: torch.Tensor
        Rotary positional embedding tensor of shape `[s2, 1, 1, d2]` and dtype 'float',
        with `s2 >= s` and `d2 <= d`.
    fused: bool, default = False
        Whether to use a fused applying RoPE implementation.
    tensor_format: {'sbhd', 'bshd', 'thd'}, default = 'sbhd'
        is `bshd` if `t` is of shape `[bs, seq, ...]`, or `sbhd` if `t` is
        of shape `[seq, bs, ...]`. 'thd' is only supported when `fused` is True.
    cu_seqlens: torch.Tensor, default = None.
        Cumulative sum of sequence lengths in a batch for `t`, with shape [b + 1] and
        dtype torch.int32. Only valid when `tensor_format` is 'thd'.
1882
    """
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
    if fused:
        assert (
            tensor_format != "thd" or cu_seqlens is not None
        ), "cu_seqlens must not be None when tensor_format is 'thd'."
        return FusedRoPEFunc.apply(t, freqs, tensor_format, cu_seqlens)

    assert tensor_format in ("sbhd", "bshd"), (
        "Only formats `sbhd` or `bshd` are supported for input tensor `t` "
        f"when fused is False, got {tensor_format}."
    )

1894
1895
1896
1897
1898
    max_seq_len = freqs.shape[0]
    cur_seq_len = t.shape[1] if tensor_format == "bshd" else t.shape[0]

    # Only apply the rotary embeddings up to the sequence length of the running
    # input.
1899
1900
1901
    assert (
        cur_seq_len <= max_seq_len
    ), f"Rotary Embeddings only supported up to {max_seq_len} sequence length!"
1902
    freqs = freqs[:cur_seq_len]
1903
    if tensor_format == "bshd":
1904
1905
1906
1907
        freqs = freqs.transpose(0, 1)  # [seq, 1, 1, dim] -> [1, seq, 1, dim]
    # cos/sin first then dtype conversion for better precision
    cos_ = torch.cos(freqs).to(t.dtype)
    sin_ = torch.sin(freqs).to(t.dtype)
1908

1909
1910
1911
1912
1913
1914
    rot_dim = freqs.shape[-1]
    # ideally t_pass is empty so rotary pos embedding is applied to all tensor t
    t, t_pass = t[..., :rot_dim], t[..., rot_dim:]

    # first part is cosine component
    # second part is sine component, need to change signs with _rotate_half method
1915
    t = (t * cos_) + (_rotate_half(t) * sin_)
1916
1917
1918
    return torch.cat((t, t_pass), dim=-1)


cyanguwa's avatar
cyanguwa committed
1919
class _SplitAlongDim(torch.autograd.Function):
1920
1921
1922
    """"""

    @staticmethod
1923
1924
1925
1926
1927
    def forward(
        ctx,
        mixed_x_layer: torch.Tensor,
        split_dim: int,
        split_size_or_sections: Union[int, List[int], Tuple[int]],
1928
    ) -> Tuple[torch.Tensor, ...]:
cyanguwa's avatar
cyanguwa committed
1929
1930
        ctx.split_dim = split_dim
        ctx.split_size_or_sections = split_size_or_sections
1931
        if isinstance(mixed_x_layer, Float8Tensor):
1932
1933
1934
1935
1936
1937
            return tuple(
                Float8Tensor.make_like(
                    mixed_x_layer,
                    data=x,
                )
                for x in torch.split(
1938
1939
                    mixed_x_layer._data,
                    split_size_or_sections=split_size_or_sections,
1940
1941
1942
1943
                    dim=split_dim,
                )
            )
        return torch.split(mixed_x_layer, split_size_or_sections, dim=split_dim)
1944
1945

    @staticmethod
1946
    def backward(ctx, *grad_outputs):
1947
1948
        assert len(grad_outputs) > 0, "No gradients received for backprop!"

cyanguwa's avatar
cyanguwa committed
1949
1950
        if isinstance(ctx.split_size_or_sections, (list, tuple)):
            split_sizes = ctx.split_size_or_sections
1951
1952
1953
            assert len(grad_outputs) == len(
                split_sizes
            ), "Unequal number of gradients vs split sections for backprop!"
cyanguwa's avatar
cyanguwa committed
1954
1955
1956
1957
1958
        if isinstance(ctx.split_size_or_sections, int):
            split_sizes = [ctx.split_size_or_sections] * len(grad_outputs)
        dims = len(grad_outputs[0].shape)
        split_dim = (ctx.split_dim + dims) % dims

1959
1960
1961
1962
1963
1964
1965
1966
        if isinstance(grad_outputs[0], Float8Tensor):
            noop_ok = True
            strides = grad_outputs[0].stride()
            data_ptr = grad_outputs[0]._data.untyped_storage().data_ptr()
            shape = list(grad_outputs[0].shape)
            for i, tensor in enumerate(grad_outputs):
                shape_i = shape
                shape_i[split_dim] = split_sizes[i]
1967
1968
1969
1970
1971
1972
1973
                offset_size = sum(split_sizes[:i]) * np.prod(shape[split_dim + 1 :])
                if (
                    tensor.stride() != strides
                    or list(tensor.shape) != shape_i
                    or tensor._data.untyped_storage().data_ptr() != data_ptr
                    or tensor.storage_offset() != offset_size
                ):
1974
1975
1976
                    noop_ok = False
                    break
            if noop_ok:
1977
1978
1979
                ret = torch.Tensor().to(
                    device=grad_outputs[0].device, dtype=grad_outputs[0]._data.dtype
                )
1980
1981
                new_shape = list(shape)
                new_shape[split_dim] = sum(split_sizes)
1982
1983
1984
1985
1986
                ret.set_(
                    grad_outputs[0]._data.untyped_storage(),
                    grad_outputs[0]._data.storage_offset(),
                    new_shape,
                    strides,
1987
1988
1989
1990
                )
                return Float8Tensor.make_like(grad_outputs[0], data=ret), None, None

            grad_outputs_data = [x._data for x in grad_outputs]
1991
1992
1993
1994
1995
1996
1997
            return (
                Float8Tensor.make_like(
                    grad_outputs[0], data=torch.cat(grad_outputs_data, dim=split_dim)
                ),
                None,
                None,
            )
1998
1999
        noop_ok = True
        strides = grad_outputs[0].stride()
2000
        data_ptr = grad_outputs[0].untyped_storage().data_ptr()
cyanguwa's avatar
cyanguwa committed
2001
        shape = list(grad_outputs[0].shape)
2002
        for i, tensor in enumerate(grad_outputs):
cyanguwa's avatar
cyanguwa committed
2003
2004
            shape_i = shape
            shape_i[split_dim] = split_sizes[i]
2005
2006
2007
2008
2009
2010
2011
            offset_size = sum(split_sizes[:i]) * np.prod(shape[split_dim + 1 :])
            if (
                tensor.stride() != strides
                or list(tensor.shape) != shape_i
                or tensor.untyped_storage().data_ptr() != data_ptr
                or tensor.storage_offset() != offset_size
            ):
2012
2013
2014
                noop_ok = False
                break
        if noop_ok:
2015
            ret = torch.Tensor().to(device=grad_outputs[0].device, dtype=grad_outputs[0].dtype)
2016
            new_shape = list(shape)
cyanguwa's avatar
cyanguwa committed
2017
            new_shape[split_dim] = sum(split_sizes)
2018
2019
2020
2021
2022
            ret.set_(
                grad_outputs[0].untyped_storage(),
                grad_outputs[0].storage_offset(),
                new_shape,
                strides,
2023
            )
cyanguwa's avatar
cyanguwa committed
2024
            return ret, None, None
2025

2026
        return torch.cat(grad_outputs, dim=split_dim), None, None
2027
2028
2029
2030
2031
2032
2033
2034
2035


class UnfusedDotProductAttention(torch.nn.Module):
    """Parallel attention w/o QKV and Proj Gemms
    BMM1 -> softmax + dropout -> BMM2
    """

    def __init__(
        self,
2036
        softmax_scale: float,
2037
2038
2039
2040
2041
2042
        attention_dropout: float = 0.0,
        attention_dropout_ctx: Optional[Callable] = nullcontext,
        layer_number: Optional[int] = None,
    ) -> None:
        super().__init__()

2043
        self.softmax_scale = softmax_scale
2044
2045
2046
        self.attention_dropout_ctx = attention_dropout_ctx
        self.layer_number = layer_number

2047
        self.scale_mask_softmax = FusedScaleMaskSoftmax(attention_mask_func)
2048
2049
2050
2051
2052
2053

        # Dropout. Note that for a single iteration, this layer will generate
        # different outputs on different number of parallel partitions but
        # on average it should not be partition dependent.
        self.attention_dropout = torch.nn.Dropout(attention_dropout)

2054
2055
        # An FP16 training trick required for certain GPT-like models.
        self.apply_qk_layer_scaling = (
2056
2057
            bool(int(os.getenv("NVTE_APPLY_QK_LAYER_SCALING", "0"))) and layer_number is not None
        )
2058

2059
2060
2061
2062
2063
    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
2064
        qkv_layout: str = "sbh3d",
2065
2066
        cu_seqlens_q: Optional[torch.Tensor] = None,  # pylint: disable=unused-argument
        cu_seqlens_kv: Optional[torch.Tensor] = None,  # pylint: disable=unused-argument
2067
        attn_mask_type: str = "causal",
2068
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
2069
2070
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
2071
        alibi_slopes: Optional[torch.Tensor] = None,
2072
    ) -> torch.Tensor:
2073
        """Unfused attention fprop"""
2074

2075
2076
2077
2078
2079
        assert (
            qkv_layout in QKVLayouts
        ), f"UnfusedDotProductAttention does not support qkv_layout = {qkv_layout}!"
        qkv_format = "".join([i for i in qkv_layout.split("_")[0] if i.isalpha()])
        if qkv_format == "bshd":
2080
            # convert to sbhd and use sbhd implementation for now
2081
2082
2083
            query_layer, key_layer, value_layer = [
                x.transpose(0, 1) for x in [query_layer, key_layer, value_layer]
            ]
2084

2085
        batch_size, seqlen = query_layer.shape[1], query_layer.shape[0]
2086
        apply_qk_layer_scaling = self.apply_qk_layer_scaling and key_layer.dtype == torch.float16
2087
2088
2089
2090
2091
2092
2093
2094
2095

        # [b, np, sq, sk]
        output_size = (
            query_layer.size(1),
            query_layer.size(2),
            query_layer.size(0),
            key_layer.size(0),
        )

2096
        if key_layer.shape[2] != query_layer.shape[2]:
2097
2098
2099
            assert (
                query_layer.shape[2] % key_layer.shape[2] == 0
            ), "The number of attention heads must be divisible by the number of GQA groups!"
2100
            key_layer = key_layer.repeat_interleave(
2101
2102
                int(query_layer.shape[2] / key_layer.shape[2]), dim=2
            )
2103
            value_layer = value_layer.repeat_interleave(
2104
2105
                int(query_layer.shape[2] / value_layer.shape[2]), dim=2
            )
2106

2107
        # [sq, b, np, hn] -> [sq, b * np, hn]
2108
        query_layer = query_layer.reshape(output_size[2], output_size[0] * output_size[1], -1)
2109
2110
2111
2112
        # [sk, b, np, hn] -> [sk, b * np, hn]
        key_layer = key_layer.reshape(output_size[3], output_size[0] * output_size[1], -1)

        # preallocting result tensor: [b * np, sq, sk]
2113
2114
        # WAR to set dtype to FP32 as ONNX lacks BF16 support for ConstantOfShape operator
        is_bf16 = query_layer.dtype == torch.bfloat16
2115
2116
2117
2118
        matmul_result = torch.empty(
            output_size[0] * output_size[1],
            output_size[2],
            output_size[3],
2119
            dtype=torch.float32 if is_in_onnx_export_mode() and is_bf16 else query_layer.dtype,
2120
2121
2122
            device=torch.cuda.current_device(),
        )

2123
2124
2125
        if is_in_onnx_export_mode() and is_bf16:
            matmul_result = matmul_result.bfloat16()

2126
        scale = self.softmax_scale
2127
        if apply_qk_layer_scaling:
2128
            scale /= self.layer_number
2129
2130

        # Raw attention scores. [b * np, sq, sk]
2131
2132
2133
2134
2135
2136
        if core_attention_bias_type == "no_bias":
            matmul_result = torch.baddbmm(
                matmul_result,
                query_layer.transpose(0, 1),  # [b * np, sq, hn]
                key_layer.transpose(0, 1).transpose(1, 2),  # [b * np, hn, sk]
                beta=0.0,
2137
                alpha=scale,
2138
2139
2140
2141
2142
2143
2144
2145
            )

        elif core_attention_bias_type == "pre_scale_bias":
            assert core_attention_bias is not None, "core_attention_bias should not be None!"
            matmul_result = torch.bmm(
                query_layer.transpose(0, 1),  # [b * np, sq, hn]
                key_layer.transpose(0, 1).transpose(1, 2),  # [b * np, hn, sk]
            )
2146
2147
2148
2149
            matmul_result = (
                matmul_result.view(output_size[0], output_size[1], output_size[2], output_size[3])
                + core_attention_bias
            ).view(-1, output_size[2], output_size[3])
2150
            matmul_result *= scale
2151

2152
2153
2154
2155
        elif core_attention_bias_type in ["post_scale_bias", "alibi"]:
            if core_attention_bias_type == "post_scale_bias":
                assert core_attention_bias is not None, "core_attention_bias should not be None!"
            if core_attention_bias_type == "alibi":
2156
                _, core_attention_bias = get_alibi(
2157
2158
                    output_size[1], output_size[2], output_size[3], alibi_slopes=alibi_slopes
                )
2159
2160
2161
2162
2163
            matmul_result = torch.baddbmm(
                matmul_result,
                query_layer.transpose(0, 1),  # [b * np, sq, hn]
                key_layer.transpose(0, 1).transpose(1, 2),  # [b * np, hn, sk]
                beta=0.0,
2164
                alpha=scale,
2165
            )
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
            matmul_result = (
                (
                    matmul_result.view(
                        output_size[0], output_size[1], output_size[2], output_size[3]
                    )
                    + core_attention_bias
                )
                .view(-1, output_size[2], output_size[3])
                .to(dtype=query_layer.dtype)
            )
2176
2177
2178
2179
2180
2181

        # change view to [b, np, sq, sk]
        attention_scores = matmul_result.view(*output_size)

        # attention scores and attention mask [b, np, sq, sk]
        softmax_scale = self.layer_number if apply_qk_layer_scaling else None
2182
        attention_probs = self.scale_mask_softmax(
2183
2184
            attention_scores, attention_mask, attn_mask_type, softmax_scale
        )
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200

        # This is actually dropping out entire tokens to attend to, which might
        # seem a bit unusual, but is taken from the original Transformer paper.
        with self.attention_dropout_ctx():
            attention_probs = self.attention_dropout(attention_probs)

        # value_layer -> context layer.
        # [sk, b, np, hn] --> [b, np, sq, hn]
        output_size = (
            value_layer.size(1),
            value_layer.size(2),
            query_layer.size(0),
            value_layer.size(3),
        )

        # change view [sk, b * np, hn]
2201
        value_layer = value_layer.reshape(value_layer.size(0), output_size[0] * output_size[1], -1)
2202
2203

        # change view [b * np, sq, sk]
2204
        attention_probs = attention_probs.view(output_size[0] * output_size[1], output_size[2], -1)
2205
2206
2207
2208
2209
2210
2211

        # matmul: [b * np, sq, hn]
        context_layer = torch.bmm(attention_probs, value_layer.transpose(0, 1))

        # change view [b, np, sq, hn]
        context_layer = context_layer.view(*output_size)

2212
        if qkv_format == "sbhd":
2213
2214
            # [b, np, sq, hn] --> [sq, b, np, hn]
            context_layer = context_layer.permute(2, 0, 1, 3).contiguous()
2215

2216
2217
2218
            # [sq, b, np, hn] --> [sq, b, hp]
            context_layer = context_layer.view(seqlen, batch_size, -1)

2219
        if qkv_format == "bshd":
2220
2221
2222
2223
2224
            # [b, np, sq, hn] --> [b, sq, np, hn]
            context_layer = context_layer.permute(0, 2, 1, 3).contiguous()

            # [b, sq, np, hn] --> [b, sq, hp]
            context_layer = context_layer.view(batch_size, seqlen, -1)
2225
2226
2227
2228
2229
2230

        return context_layer


class _PrepareQKVForFA(torch.autograd.Function):
    """This class converts QKV from interleaved (s, b, ...) layout
2231
    to separate contiguous q, k, v tensors in (b, s, ...) layout."""
2232
2233

    @staticmethod
2234
2235
2236
2237
    def forward(
        _ctx: torch.autograd.function.FunctionCtx,  # unused
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
2238
        value_layer: torch.Tensor,
2239
    ) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor]:
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
        # All inputs received are non-contiguous tensors.
        # The `query_layer` tensor is used to access the
        # full memory region of the QKV tensor.
        qkv = tex.fa_prepare_fwd(query_layer)
        q, k, v = split_tensor_along_dim(qkv, 0, 3)
        query_layer = torch.squeeze(q, 0)
        key_layer = torch.squeeze(k, 0)
        value_layer = torch.squeeze(v, 0)
        return query_layer, key_layer, value_layer

    @staticmethod
2251
2252
2253
2254
    def backward(
        _ctx: torch.autograd.function.FunctionCtx,  # unused
        dq: torch.Tensor,
        dk: torch.Tensor,
2255
        dv: torch.Tensor,
2256
2257
2258
2259
2260
    ) -> Tuple[Union[torch.Tensor, None], ...]:
        dqkv = tex.fa_prepare_bwd(dq, dk, dv)
        dq, dk, dv = split_tensor_along_dim(dqkv, -1, 3)
        return dq, dk, dv

2261

2262
def _get_qkv_layout(
2263
2264
2265
2266
2267
    q: torch.Tensor,
    k: torch.Tensor,
    v: torch.Tensor,
    qkv_format: str = "sbhd",
) -> str:
2268
    """Get qkv layout.
2269

2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
    Parameters
    ----------
    q: torch.Tensor
        Query tensor.
    k: torch.Tensor
        Key tensor.
    v: torch.Tensor
        Value tensor.
    qkv_format: str, default = `sbhd`
        Dimension format for `q`, `k` and `v`, {`sbhd`, `bshd`, `thd`}. `s` stands for
        the sequence length dimension, `b` batch size, `h` the number of attention heads,
        `d` head size, and `t` the total number of sequences in a batch, i.e.
        `t = sum(s_i) for i = 0...b-1`.

    Returns
    ----------
    qkv_layout: str
       Memory layout of `q`, `k` and `v`. Each `qkv_format` can be mapped to one of five
       memory layouts. For example, `sb3hd` means `q`, `k`, `v` are created as one chunk
       of memory and that they are interleaved in the `2`nd dimension. `sbhd_sbh2d` means
       `q` and `kv` are created in two chunks and that `q` itself is contiguous and `k`, `v`
       are interleaved with each other in the `3`rd dimension, `k = kv[:,:,:,0,:]` and
       `v = kv[:,:,:,1,:]`.
       Mapping:
       `sbhd`: {`sb3hd`, `sbh3d`, `sbhd_sb2hd`, `sbhd_sbh2d`, `sbhd_sbhd_sbhd`}
       `bshd`: {`bs3hd`, `bsh3d`, `bshd_bs2hd`, `bshd_bsh2d`, `bshd_bshd_bshd`}
       `thd` : {`t3hd`, `th3d`, `thd_t2hd`, `thd_th2d`, `thd_thd_thd`}
    """
2298

2299
2300
    check_last_dim_contiguous = all(x.stride(-1) == 1 for x in [q, k, v])
    assert check_last_dim_contiguous, "q, k and v must have stride 1 in their last dimension!"
2301

2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
    def run_iteratively(q, k, v):
        data_ptr = q.untyped_storage().data_ptr()
        check_ptrs_qkv = all(x.untyped_storage().data_ptr() == data_ptr for x in [q, k, v])
        data_ptr = k.untyped_storage().data_ptr()
        check_ptrs_kv = all(x.untyped_storage().data_ptr() == data_ptr for x in [k, v])

        stride = q.stride()
        check_strides_qkv = all(stride == x.stride() for x in [q, k, v])
        stride = k.stride()
        check_strides_kv = all(stride == x.stride() for x in [k, v])

        shape = q.shape
        check_shapes_qkv = all(shape == x.shape for x in [q, k, v])
        shape = k.shape
        check_shapes_kv = all(shape == x.shape for x in [k, v])

        last_dim_size = q.shape[-1]
2319
2320
2321
        check_last_dim_offsets_qkv = all(
            i * last_dim_size == x.storage_offset() for i, x in enumerate([q, k, v])
        )
2322
        last_dim_size = k.shape[-1]
2323
2324
2325
        check_last_dim_offsets_kv = all(
            i * last_dim_size == x.storage_offset() for i, x in enumerate([k, v])
        )
2326
2327

        last_two_dims_size = q.shape[-1] * q.shape[-2]
2328
2329
2330
        check_last_two_dims_offsets_qkv = all(
            i * last_two_dims_size == x.storage_offset() for i, x in enumerate([q, k, v])
        )
2331
        last_two_dims_size = k.shape[-1] * k.shape[-2]
2332
2333
2334
        check_last_two_dims_offsets_kv = all(
            i * last_two_dims_size == x.storage_offset() for i, x in enumerate([k, v])
        )
2335

2336
2337
2338
2339
        if (
            check_ptrs_qkv
            and check_strides_qkv
            and check_shapes_qkv
2340
            and check_last_two_dims_offsets_qkv
2341
2342
            and not check_last_dim_offsets_qkv
        ):
2343
            # sb3hd, bs3hd, t3hd
2344
2345
2346
2347
            qkv_layout = qkv_format[:-2] + "3" + qkv_format[-2:]
        elif (
            check_ptrs_qkv and check_strides_qkv and check_shapes_qkv and check_last_dim_offsets_qkv
        ):
2348
            # sbh3d, bsh3d, th3d
2349
2350
2351
2352
2353
            qkv_layout = qkv_format[:-1] + "3" + qkv_format[-1:]
        elif (
            check_ptrs_kv
            and check_strides_kv
            and check_shapes_kv
2354
            and check_last_two_dims_offsets_kv
2355
2356
            and not check_last_dim_offsets_kv
        ):
2357
            # sbhd_sb2hd, bshd_bs2hd, thd_t2hd
2358
2359
            qkv_layout = qkv_format + "_" + qkv_format[:-2] + "2" + qkv_format[-2:]
        elif check_ptrs_kv and check_strides_kv and check_shapes_kv and check_last_dim_offsets_kv:
2360
            # sbhd_sbh2d, bshd_bsh2d, thd_th2d
2361
            qkv_layout = qkv_format + "_" + qkv_format[:-1] + "2" + qkv_format[-1:]
2362
2363
        elif check_strides_kv and check_shapes_kv:
            # sbhd_sbhd_sbhd, bshd_bshd_bshd, thd_thd_thd
2364
            qkv_layout = "_".join(list([qkv_format]) * 3)
2365
        else:
2366
            qkv_layout = "not_supported"
2367
2368
2369
2370

        return qkv_layout

    qkv_layout = run_iteratively(q, k, v)
2371
    if qkv_layout == "not_supported":
2372
2373
2374
        # force q,k,v to be contiguous and run get_layout again
        q, k, v = [x.contiguous() for x in [q, k, v]]
        qkv_layout = run_iteratively(q, k, v)
2375
    if qkv_layout == "not_supported":
2376
2377
        raise Exception("The provided qkv memory layout is not supported!")

2378
    return qkv_layout, q, k, v
2379

2380

2381
def check_set_window_size(
2382
2383
2384
    attn_mask_type: str,
    window_size: Tuple[int, int] = None,
):
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
    """Check if sliding window size is compliant with mask type and if not,
    assert or set it to the appropriate size
    """
    if "causal" in attn_mask_type:
        if window_size is None:
            window_size = (-1, 0)
        else:
            assert (
                window_size[1] == 0
            ), "window_size[1] should be 0 when self_attn_mask_type includes 'causal'!"
    else:
        if window_size is None:
            window_size = (-1, -1)
    return window_size
2399

2400

2401
class FlashAttention(torch.nn.Module):
2402
    """Dot product attention, using HazyResearch flash-attn package:
2403
    https://github.com/Dao-AILab/flash-attention
2404
2405
2406
2407
    """

    def __init__(
        self,
2408
        softmax_scale: float,
2409
2410
        attention_dropout: float = 0.0,
        attention_dropout_ctx: Optional[Callable] = nullcontext,
2411
2412
        attention_type: str = "self",
        layer_number: Optional[int] = None,
2413
        deterministic: bool = False,
2414
2415
2416
2417
2418
2419
    ) -> None:
        super().__init__()

        assert (
            _flash_attn_version >= _flash_attn_version_required
        ), f"FlashAttention minimum version {_flash_attn_version_required} is required."
2420
2421
2422
        assert (
            _flash_attn_version <= _flash_attn_max_version
        ), f"FlashAttention maximum version {_flash_attn_max_version} is supported."
2423

2424
        self.softmax_scale = softmax_scale
2425
2426
        self.attention_dropout_ctx = attention_dropout_ctx
        self.attention_dropout = attention_dropout
2427
2428
        self.attention_type = attention_type
        self.layer_number = 1 if layer_number is None else layer_number
2429
        self.deterministic = deterministic
2430
2431
2432
2433
2434
2435

    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
2436
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
2437
2438
2439
        qkv_layout: str = "sbh3d",
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
2440
2441
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
2442
        attn_mask_type: str = "causal",
2443
        window_size: Optional[Tuple[int, int]] = None,
2444
        alibi_slopes: Optional[torch.Tensor] = None,
2445
        cp_group: Optional[dist_group_type] = None,
2446
        cp_global_ranks: List[int] = None,
2447
        cp_stream: torch.cuda.Stream = None,
2448
2449
2450
    ) -> torch.Tensor:
        """flash-attn fprop"""

2451
2452
        window_size = check_set_window_size(attn_mask_type, window_size)

2453
        assert (
2454
2455
2456
            query_layer.dtype in [torch.float16, torch.bfloat16]
            and key_layer.dtype in [torch.float16, torch.bfloat16]
            and value_layer.dtype in [torch.float16, torch.bfloat16]
2457
        ), "FlashAttention currently only supports FP16 and BF16."
2458
2459
        assert (
            query_layer.is_cuda and key_layer.is_cuda and value_layer.is_cuda
2460
        ), "FlashAttention currently only supports CUDA tensors."
2461
2462
        assert (
            qkv_layout in QKVLayouts
2463
        ), f"FlashAttention does not support qkv_layout = {qkv_layout}!"
2464

2465
2466
        context_parallel = (cp_group is not None) and (get_distributed_world_size(cp_group) != 1)

2467
        qkv_format = "".join([i for i in qkv_layout.split("_")[0] if i.isalpha()])
2468

2469
        if qkv_format == "sbhd":
2470
            # For now just 128, will make it more general in the future
2471
2472
2473
2474
2475
2476
2477
2478
            if (
                query_layer.shape[-1] == 128
                and query_layer.shape[0] * query_layer.shape[1] >= 512
                and qkv_layout == "sbh3d"
            ):
                query_layer, key_layer, value_layer = _PrepareQKVForFA.apply(
                    query_layer, key_layer, value_layer
                )
2479
            else:
2480
2481
2482
2483
2484
2485
2486
                query_layer, key_layer, value_layer = [
                    x.transpose(0, 1).contiguous() for x in (query_layer, key_layer, value_layer)
                ]
        elif qkv_format in ["bshd", "thd"]:
            query_layer, key_layer, value_layer = [
                x.contiguous() for x in (query_layer, key_layer, value_layer)
            ]
2487

2488
        batch_size = query_layer.shape[0]
2489

2490
        if qkv_format in ["sbhd", "bshd"]:
2491
            max_seqlen_q, max_seqlen_kv = query_layer.shape[1], key_layer.shape[1]
2492
2493
2494
2495
2496
2497
2498
            if not context_parallel:
                # [b * s, h, d]
                query_layer, key_layer, value_layer = [
                    x.view(x.shape[0] * x.shape[1], *x.shape[2:])
                    for x in [query_layer, key_layer, value_layer]
                ]

2499
            if "padding" in attn_mask_type:
2500
                assert not context_parallel, "Padding mask not supported with context parallelism!"
2501
2502
2503
2504
2505

                if self.attention_type == "self":
                    assert (
                        max_seqlen_q == max_seqlen_kv
                    ), "Maximum sequence length for Q and KV should be the same."
2506
                    if cu_seqlens_q is None:
2507
2508
2509
                        assert (
                            attention_mask is not None
                        ), "Please provide attention_mask for padding!"
2510
2511
2512
2513
2514
2515
                        cu_seqlens_q, indices_q = get_cu_seqlens_and_indices(attention_mask)
                    else:
                        indices_q = get_indices(max_seqlen_q, cu_seqlens_q)
                    cu_seqlens_kv = cu_seqlens_q
                    query_layer, key_layer, value_layer = PackTensors.apply(
                        indices_q, query_layer, key_layer, value_layer
2516
2517
                    )
                else:
2518
                    if cu_seqlens_q is None or cu_seqlens_kv is None:
2519
2520
2521
2522
2523
                        assert (
                            attention_mask is not None
                        ), "Please provide attention_mask for padding!"
                        cu_seqlens_q, indices_q = get_cu_seqlens_and_indices(attention_mask[0])
                        cu_seqlens_kv, indices_kv = get_cu_seqlens_and_indices(attention_mask[1])
2524
2525
2526
2527
                    else:
                        indices_q = get_indices(max_seqlen_q, cu_seqlens_q)
                        indices_kv = get_indices(max_seqlen_kv, cu_seqlens_kv)
                    query_layer = PackTensors.apply(indices_q, query_layer)
2528
                    key_layer, value_layer = PackTensors.apply(indices_kv, key_layer, value_layer)
2529
            else:
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
                # Cumulative sequence lengths for unpadded data
                if cu_seqlens_q is None:
                    cu_seqlens_q = _get_full_cu_seqlens(
                        batch_size,
                        max_seqlen_q,
                        query_layer.device,
                    )
                if cu_seqlens_kv is None:
                    cu_seqlens_kv = _get_full_cu_seqlens(
                        batch_size,
                        max_seqlen_kv,
                        key_layer.device,
                    )
2543
2544
2545
2546
        elif qkv_format == "thd":
            assert (
                cu_seqlens_q is not None and cu_seqlens_kv is not None
            ), "cu_seqlens_q and cu_seqlens_kv can not be None when qkv_format = thd!"
2547
2548
2549
2550
2551
2552
            if max_seqlen_q is None:
                seqlens_q = cu_seqlens_q[1:] - cu_seqlens_q[:-1]
                max_seqlen_q = seqlens_q.max().item()
            if max_seqlen_kv is None:
                seqlens_kv = cu_seqlens_kv[1:] - cu_seqlens_kv[:-1]
                max_seqlen_kv = seqlens_kv.max().item()
2553

2554
        if context_parallel:
2555
2556
2557
2558
            assert window_size in (
                (-1, -1),
                (-1, 0),
            ), "Sliding window attention is not supported with context parallelism."
2559
2560
2561
            assert (
                alibi_slopes is None
            ), "Alibi slope bias addition is not supported with context parallelism."
2562
            with self.attention_dropout_ctx():
2563
                output = attn_forward_func_with_cp(
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
                    self.training,
                    query_layer,
                    key_layer,
                    value_layer,
                    cu_seqlens_q,
                    cu_seqlens_kv,
                    max_seqlen_q,
                    max_seqlen_kv,
                    None,
                    None,
2574
                    self.attention_dropout if self.training else 0.0,
2575
2576
2577
                    cp_group,
                    cp_global_ranks,
                    cp_stream,
2578
                    softmax_scale=self.softmax_scale,
2579
                    qkv_format="bshd" if qkv_format == "sbhd" else qkv_format,
2580
                    attn_mask_type=attn_mask_type,
2581
                    deterministic=self.deterministic,
2582
2583
                )
        else:
2584
2585

            from .cpu_offload import CPUOffloadEnabled
2586

2587
2588
2589
2590
2591
2592
            if CPUOffloadEnabled:
                tensor_list = [query_layer, key_layer, value_layer, cu_seqlens_q, cu_seqlens_kv]
                for tensor in tensor_list:
                    if tensor is not None:
                        tensor.activation_offloading = True

2593
            with self.attention_dropout_ctx():
2594
                fa_optional_forward_kwargs = {}
2595
2596
                if _flash_attn_2_3_plus:
                    fa_optional_forward_kwargs["window_size"] = window_size
2597
2598
2599
2600
                if _flash_attn_2_4_plus:
                    fa_optional_forward_kwargs["alibi_slopes"] = alibi_slopes
                if _flash_attn_2_4_1_plus:
                    fa_optional_forward_kwargs["deterministic"] = self.deterministic
2601
                output = flash_attn_forward_func(
2602
2603
2604
2605
2606
2607
2608
                    query_layer,
                    key_layer,
                    value_layer,
                    cu_seqlens_q,
                    cu_seqlens_kv,
                    max_seqlen_q,
                    max_seqlen_kv,
2609
                    self.attention_dropout if self.training else 0.0,
2610
2611
                    softmax_scale=self.softmax_scale,
                    causal="causal" in attn_mask_type,
2612
                    **fa_optional_forward_kwargs,
2613
                )
2614

2615
        if qkv_format in ["sbhd", "bshd"] and "padding" in attn_mask_type:
2616
            output = UnpackTensor.apply(indices_q, batch_size * max_seqlen_q, output)
2617

2618
        if qkv_format == "sbhd":
2619
2620
            # (bs)hd -> bs(hd) -> sb(hd)
            output = output.view(batch_size, max_seqlen_q, -1).transpose(0, 1).contiguous()
2621
        elif qkv_format == "bshd":
2622
2623
            # (bs)hd -> bs(hd)
            output = output.view(batch_size, max_seqlen_q, -1).contiguous()
2624
        elif qkv_format == "thd":
2625
2626
            # thd -> t(hd)
            output = output.view(output.shape[0], -1).contiguous()
2627
2628

        return output
2629

2630

2631
def _combine_tensors(
2632
2633
2634
    tensors: List[torch.Tensor],
    dim: int,
) -> torch.Tensor:
2635
2636
2637
2638
2639
2640
    """Combine tensors along a particular dimension"""

    num_tensors = len(tensors)
    new_shape = list(tensors[0].shape)
    new_shape.insert(dim, num_tensors)
    new_stride = list(tensors[0].stride())
2641
    new_stride.insert(dim, int(new_stride[dim - 1] / num_tensors))
2642
    if isinstance(tensors[0], Float8Tensor):
2643
        combined_tensor = torch.Tensor().to(device=tensors[0].device, dtype=tensors[0]._data.dtype)
2644
2645
2646
        combined_tensor.set_(
            tensors[0]._data.untyped_storage(),
            tensors[0]._data.storage_offset(),
2647
2648
2649
2650
            new_shape,
            new_stride,
        )
        combined_tensor = Float8Tensor.make_like(tensors[0], data=combined_tensor)
2651
    else:
2652
        combined_tensor = torch.Tensor().to(device=tensors[0].device, dtype=tensors[0].dtype)
2653
        combined_tensor.set_(
2654
2655
            tensors[0].untyped_storage(), tensors[0].storage_offset(), new_shape, new_stride
        )
2656
2657

    return combined_tensor
2658

2659

2660
2661
2662
2663
class FusedAttnFunc_qkvpacked(torch.autograd.Function):
    """Function for FusedAttention with packed QKV input"""

    @staticmethod
2664
2665
2666
2667
2668
    def forward(
        ctx,
        is_training,
        max_seqlen,
        cu_seqlens,
2669
        cu_seqlens_padded,
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
        qkv,
        qkv_dtype,
        attn_bias,
        attn_scale,
        dropout_p,
        fast_zero_fill,
        qkv_layout,
        attn_bias_type,
        attn_mask_type,
        rng_gen,
        fused_attention_backend,
        use_FAv2_bwd,
        fp8,
        fp8_meta,
    ):
2685
        logger = logging.getLogger("FusedAttnFunc_qkvpacked")
2686
        if fp8:
2687
            logger.debug("Running forward in FP8")
2688
            if fp8_meta["recipe"].fp8_mha:
2689
                assert isinstance(qkv, Float8Tensor), "qkv must be Float8Tensors for FP8 MHA."
2690
2691
2692
2693
                fp8_meta["scaling_fwd"].scale_inv[META_QKV] = qkv._scale_inv
            fused_attention_backend = FusedAttnBackend["FP8"]
            fp8_dtype_forward = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
            # 1: qkv packed, 2: kv packed, 3: qkv separate
2694
2695
2696
2697
2698
            qkv_group = len(qkv_layout.split("_"))
            assert qkv_group == 1, (
                "qkv layout should conform to 3hd or h3d, e.g. sb3hd,                 but found"
                f" {qkv_layout}."
            )
2699
2700
2701
2702
            if fp8_meta["recipe"].fp8_mha:
                qkv_fp8 = qkv._data
            else:
                qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
2703
2704
2705
                qkv_fp8 = cast_to_fp8(
                    qkv_c, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                ).view(qkv.shape)
2706
            out_fp8, aux_ctx_tensors = fused_attn_fwd_qkvpacked(
2707
2708
2709
2710
2711
2712
2713
                is_training,
                max_seqlen,
                cu_seqlens,
                qkv_fp8,
                fp8_dtype_forward,
                fused_attention_backend,
                attn_bias,
2714
                cu_seqlens_padded,
2715
2716
2717
2718
2719
2720
                fp8_meta["scaling_fwd"].scale_inv[META_QKV],
                fp8_meta["scaling_fwd"].scale_inv[META_S],
                fp8_meta["scaling_fwd"].scale[META_S],
                fp8_meta["scaling_fwd"].scale[META_O],
                fp8_meta["scaling_fwd"].amax_history[0][META_S],
                fp8_meta["scaling_fwd"].amax_history[0][META_O],
2721
2722
2723
2724
2725
2726
2727
2728
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
                rng_gen,
            )
2729
            if fp8_meta["recipe"].fp8_mha:
2730
2731
                out_ret = Float8Tensor(
                    data=out_fp8,
2732
2733
2734
2735
2736
2737
2738
2739
2740
                    fp8_meta=fp8_meta,
                    fp8_meta_forward=True,
                    fp8_meta_index=META_O,
                    fp8_dtype=fp8_dtype_forward,
                    dtype=qkv.dtype,
                )
            else:
                out_ret = cast_from_fp8(
                    out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
2741
2742
2743
2744
2745
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
2746
2747
2748
            out_save = out_ret
            if fp8_meta["recipe"].fp8_mha and not int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
                qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
2749
2750
                qkv = cast_from_fp8(
                    qkv_c._data,
2751
                    fp8_meta["scaling_fwd"],
2752
2753
2754
2755
                    META_QKV,
                    fp8_dtype_forward,
                    TE_DType[qkv.dtype],
                ).view(qkv.shape)
2756
2757
                out_save = cast_from_fp8(
                    out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
2758
2759
2760
2761
2762
2763
2764
2765
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
            fp8_tensors = (
                qkv_fp8,
                out_fp8,
2766
                fp8_meta["scaling_fwd"].scale.clone(),
2767
2768
                fp8_meta["scaling_fwd"].scale_inv.clone(),
            )
2769
        else:
2770
            logger.debug("Running forward in %s", qkv.dtype)
2771
            out_ret, aux_ctx_tensors = fused_attn_fwd_qkvpacked(
2772
2773
2774
2775
2776
2777
2778
                is_training,
                max_seqlen,
                cu_seqlens,
                qkv,
                qkv_dtype,
                fused_attention_backend,
                attn_bias,
2779
                cu_seqlens_padded,
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
                None,
                None,
                None,
                None,
                None,
                None,
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
                rng_gen,
            )
2794
2795
2796
2797
2798
            fp8_tensors = (None, None, None, None)
            out_save = out_ret

        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
        qkvo_tensors = (qkv, out_save) if not ctx.fp8 else (None, None)
2799
        ctx.save_for_backward(
2800
            *qkvo_tensors, cu_seqlens, cu_seqlens_padded, *fp8_tensors, *aux_ctx_tensors
2801
        )
2802
        ctx.fp8_meta = fp8_meta
2803
2804
2805
2806
2807
2808
2809
2810
        ctx.max_seqlen = max_seqlen
        ctx.qkv_dtype = qkv_dtype
        ctx.attn_scale = attn_scale
        ctx.dropout_p = dropout_p
        ctx.fast_zero_fill = fast_zero_fill
        ctx.qkv_layout = qkv_layout
        ctx.attn_bias_type = attn_bias_type
        ctx.attn_mask_type = attn_mask_type
2811
        ctx.fused_attention_backend = (
2812
            fused_attention_backend if ctx.fp8 else FusedAttnBackend["F16_arbitrary_seqlen"]
2813
        )
2814
        ctx.use_FAv2_bwd = use_FAv2_bwd
2815

2816
        return out_ret
2817
2818
2819

    @staticmethod
    def backward(ctx, d_out):
2820
        logger = logging.getLogger("FusedAttnFunc_qkvpacked")
2821
        if ctx.fp8_meta["recipe"].fp8_mha:
2822
2823
2824
            assert isinstance(
                d_out, Float8Tensor
            ), "Gradient of the DPA output must be in Float8Tensor type for FP8 MHA."
2825
2826
2827
            d_out_f8tensor = d_out
            d_out = d_out._data

2828
        d_out = d_out.contiguous()
2829
2830
2831
2832
        (
            qkv,
            out,
            cu_seqlens,
2833
            cu_seqlens_padded,
2834
2835
2836
2837
2838
2839
            qkv_fp8,
            out_fp8,
            fwd_scales,
            fwd_scale_invs,
            *aux_ctx_tensors,
        ) = ctx.saved_tensors
2840
2841
        if not aux_ctx_tensors[0].is_contiguous():
            aux_ctx_tensors[0] = aux_ctx_tensors[0].contiguous()
2842
        if ctx.use_FAv2_bwd:
2843
            softmax_lse, rng_state = aux_ctx_tensors
2844
2845
            dqkv = torch.empty_like(qkv)
            maybe_contiguous = lambda x: x.contiguous() if x.stride(-1) != 1 else x
2846
2847
2848
            d_out, q, k, v, out = [
                maybe_contiguous(x) for x in (d_out, qkv[:, 0], qkv[:, 1], qkv[:, 2], out)
            ]
2849
            flash_attn_cuda_bwd(
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
                d_out,
                q,
                k,
                v,
                out,
                softmax_lse,
                dqkv[:, 0],
                dqkv[:, 1],
                dqkv[:, 2],
                cu_seqlens,
                cu_seqlens,
                ctx.max_seqlen,
                ctx.max_seqlen,
                ctx.dropout_p,
                ctx.attn_scale,
                False,
                "causal" in ctx.attn_mask_type,
                None,
                rng_state,
2869
            )
2870
            dqkv = dqkv[..., : d_out.shape[-1]]
2871
        else:
2872
2873
            with torch.cuda.nvtx.range("_FusedAttn_qkvpacked"):
                if ctx.fp8:
2874
                    logger.debug("Running backward in FP8")
2875
                    fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
2876
                    fp8_dtype_backward = get_fp8_te_dtype(
2877
2878
                        ctx.fp8_meta["recipe"], fprop_tensor=False
                    )
2879
2880
                    if ctx.fp8_meta["recipe"].fp8_mha:
                        d_out_fp8 = d_out
2881
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = d_out_f8tensor._scale_inv
2882
2883
2884
                    else:
                        d_out_fp8 = cast_to_fp8(
                            d_out.view(-1, d_out.shape[-2] * d_out.shape[-1]),
2885
2886
2887
2888
                            ctx.fp8_meta["scaling_bwd"],
                            META_DO,
                            fp8_dtype_backward,
                        ).view(d_out.shape)
2889
                    dqkv_fp8, *rest = fused_attn_bwd_qkvpacked(
2890
2891
2892
2893
2894
2895
2896
2897
                        ctx.max_seqlen,
                        cu_seqlens,
                        qkv_fp8,
                        out_fp8,
                        d_out_fp8,
                        fp8_dtype_forward,
                        fp8_dtype_backward,
                        aux_ctx_tensors,
2898
                        ctx.fused_attention_backend,
2899
                        cu_seqlens_padded,
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
                        fwd_scale_invs[META_QKV],  # d_scale_qkv,
                        fwd_scale_invs[META_S],  # d_scale_s,
                        fwd_scale_invs[META_O],  # d_scale_o,
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO],  # d_scale_do
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DP],  # d_scale_dp
                        fwd_scales[META_S],  # q_scale_s
                        ctx.fp8_meta["scaling_bwd"].scale[META_DP],  # q_scale_dp
                        ctx.fp8_meta["scaling_bwd"].scale[META_DQKV],  # q_scale_dqkv
                        ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DP],  # amax_dp
                        ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DQKV],  # amax_dqkv
                        ctx.attn_scale,
                        ctx.dropout_p,
                        ctx.fast_zero_fill,
                        ctx.qkv_layout,
                        ctx.attn_bias_type,
                        ctx.attn_mask_type,
                    )
2917
                    if ctx.fp8_meta["recipe"].fp8_mha:
2918
2919
                        dqkv = Float8Tensor(
                            data=dqkv_fp8,
2920
2921
2922
2923
2924
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
2925
                        )
2926
                    else:
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
                        dqkv_c_fp8 = dqkv_fp8.view(
                            -1, dqkv_fp8.shape[-3] * dqkv_fp8.shape[-2] * dqkv_fp8.shape[-1]
                        )
                        dqkv = cast_from_fp8(
                            dqkv_c_fp8,
                            ctx.fp8_meta["scaling_bwd"],
                            META_DQKV,
                            fp8_dtype_backward,
                            ctx.qkv_dtype,
                        ).view(dqkv_fp8.shape)
2937
                else:
2938
                    logger.debug("Running backward in %s", qkv.dtype)
2939
2940
2941
                    if d_out.dtype == torch.uint8:
                        d_out = d_out_f8tensor.from_float8(qkv.dtype)
                    dqkv, *rest = fused_attn_bwd_qkvpacked(
2942
2943
2944
2945
2946
2947
2948
2949
                        ctx.max_seqlen,
                        cu_seqlens,
                        qkv,
                        out,
                        d_out,
                        ctx.qkv_dtype,
                        ctx.qkv_dtype,
                        aux_ctx_tensors,
2950
                        ctx.fused_attention_backend,
2951
                        cu_seqlens_padded,
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        ctx.attn_scale,
                        ctx.dropout_p,
                        ctx.fast_zero_fill,
                        ctx.qkv_layout,
                        ctx.attn_bias_type,
                        ctx.attn_mask_type,
                    )
2969

2970
2971
        # if no_bias or alibi, return dqkv
        if ctx.attn_bias_type in ["no_bias", "alibi"]:
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
            return (
                None,
                None,
                None,
                None,
                dqkv,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
            )
2994
        # else, return (dqkv, dbias)
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
        return (
            None,
            None,
            None,
            None,
            dqkv,
            None,
            rest[0],
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
        )
3017

3018

3019
3020
3021
3022
class FusedAttnFunc_kvpacked(torch.autograd.Function):
    """Function for FusedAttention with packed KV input"""

    @staticmethod
3023
3024
3025
3026
3027
3028
3029
    def forward(
        ctx,
        is_training,
        max_seqlen_q,
        max_seqlen_kv,
        cu_seqlens_q,
        cu_seqlens_kv,
3030
3031
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
        q,
        kv,
        qkv_dtype,
        attn_bias,
        attn_scale,
        dropout_p,
        fast_zero_fill,
        qkv_layout,
        attn_bias_type,
        attn_mask_type,
        rng_gen,
        fused_attention_backend,
        use_FAv2_bwd,
        fp8,
        fp8_meta,
    ):
3048
        logger = logging.getLogger("FusedAttnFunc_kvpacked")
3049
        if fp8:
3050
            logger.debug("Running forward in FP8")
3051
            if fp8_meta["recipe"].fp8_mha:
3052
3053
3054
                assert isinstance(q, Float8Tensor) and isinstance(
                    kv, Float8Tensor
                ), "q/kv must be Float8Tensors for FP8 MHA."
3055
3056
3057
3058
3059
3060
3061
                fp8_meta["scaling_fwd"].scale_inv[META_QKV] = q._scale_inv
            fused_attention_backend = FusedAttnBackend["FP8"]
            fp8_dtype_forward = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
            if fp8_meta["recipe"].fp8_mha:
                q_fp8, kv_fp8 = q._data, kv._data
            else:
                # 1: qkv packed, 2: kv packed, 3: qkv separate
3062
3063
3064
3065
3066
3067
3068
3069
                qkv_group = len(qkv_layout.split("_"))
                assert qkv_group == 2, (
                    "qkv layout should conform to hd_2hd or hd_h2d, e.g. sbhd_sb2hd,              "
                    f"       but found {qkv_layout}."
                )
                q_fp8 = cast_to_fp8(q, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward).view(
                    q.shape
                )
3070
                kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
3071
3072
3073
                kv_fp8 = cast_to_fp8(
                    kv_c, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                ).view(kv.shape)
3074
            out_fp8, aux_ctx_tensors = fused_attn_fwd_kvpacked(
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
                is_training,
                max_seqlen_q,
                max_seqlen_kv,
                cu_seqlens_q,
                cu_seqlens_kv,
                q_fp8,
                kv_fp8,
                fp8_dtype_forward,
                fused_attention_backend,
                attn_bias,
3085
3086
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
3087
3088
3089
3090
3091
3092
                fp8_meta["scaling_fwd"].scale_inv[META_QKV],
                fp8_meta["scaling_fwd"].scale_inv[META_S],
                fp8_meta["scaling_fwd"].scale[META_S],
                fp8_meta["scaling_fwd"].scale[META_O],
                fp8_meta["scaling_fwd"].amax_history[0][META_S],
                fp8_meta["scaling_fwd"].amax_history[0][META_O],
3093
3094
3095
3096
3097
3098
3099
3100
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
                rng_gen,
            )
3101
            if fp8_meta["recipe"].fp8_mha:
3102
3103
                out_ret = Float8Tensor(
                    data=out_fp8,
3104
3105
3106
3107
3108
3109
3110
3111
3112
                    fp8_meta=fp8_meta,
                    fp8_meta_forward=True,
                    fp8_meta_index=META_O,
                    fp8_dtype=fp8_dtype_forward,
                    dtype=q.dtype,
                )
            else:
                out_ret = cast_from_fp8(
                    out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
3113
3114
3115
3116
3117
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
3118
3119
            out_save = out_ret
            if fp8_meta["recipe"].fp8_mha and not int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
3120
3121
3122
                q = cast_from_fp8(
                    q._data, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward, TE_DType[q.dtype]
                ).view(q.shape)
3123
                kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
3124
3125
                kv = cast_from_fp8(
                    kv_c._data,
3126
                    fp8_meta["scaling_fwd"],
3127
3128
3129
3130
                    META_QKV,
                    fp8_dtype_forward,
                    TE_DType[kv.dtype],
                ).view(kv.shape)
3131
3132
                out_save = cast_from_fp8(
                    out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
3133
3134
3135
3136
3137
3138
3139
3140
3141
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
            fp8_tensors = (
                q_fp8,
                kv_fp8,
                out_fp8,
3142
                fp8_meta["scaling_fwd"].scale.clone(),
3143
3144
                fp8_meta["scaling_fwd"].scale_inv.clone(),
            )
3145
        else:
3146
            logger.debug("Running forward in %s", q.dtype)
3147
            out_ret, aux_ctx_tensors = fused_attn_fwd_kvpacked(
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
                is_training,
                max_seqlen_q,
                max_seqlen_kv,
                cu_seqlens_q,
                cu_seqlens_kv,
                q,
                kv,
                qkv_dtype,
                fused_attention_backend,
                attn_bias,
3158
3159
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
                None,
                None,
                None,
                None,
                None,
                None,
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
                rng_gen,
            )
3174
3175
3176
3177
3178
            out_save = out_ret
            fp8_tensors = (None, None, None, None, None)

        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
        qkvo_tensors = (q, kv, out_save) if not ctx.fp8 else (None, None, None)
3179
3180
3181
3182
        ctx.save_for_backward(
            *qkvo_tensors,
            cu_seqlens_q,
            cu_seqlens_kv,
3183
3184
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
3185
3186
3187
            *fp8_tensors,
            *aux_ctx_tensors,
        )
3188
        ctx.fp8_meta = fp8_meta
3189
3190
3191
3192
3193
3194
3195
3196
3197
        ctx.max_seqlen_q = max_seqlen_q
        ctx.max_seqlen_kv = max_seqlen_kv
        ctx.qkv_dtype = qkv_dtype
        ctx.attn_scale = attn_scale
        ctx.dropout_p = dropout_p
        ctx.fast_zero_fill = fast_zero_fill
        ctx.qkv_layout = qkv_layout
        ctx.attn_bias_type = attn_bias_type
        ctx.attn_mask_type = attn_mask_type
3198
        ctx.fused_attention_backend = (
3199
            fused_attention_backend if ctx.fp8 else FusedAttnBackend["F16_arbitrary_seqlen"]
3200
        )
3201
        ctx.use_FAv2_bwd = use_FAv2_bwd
3202

3203
        return out_ret
3204
3205
3206

    @staticmethod
    def backward(ctx, d_out):
3207
        logger = logging.getLogger("FusedAttnFunc_kvpacked")
3208
        if ctx.fp8_meta["recipe"].fp8_mha:
3209
3210
3211
            assert isinstance(
                d_out, Float8Tensor
            ), "Gradient of the DPA output must be in Float8Tensor type for FP8 MHA."
3212
3213
3214
            d_out_f8tensor = d_out
            d_out = d_out._data

3215
        d_out = d_out.contiguous()
3216
3217
3218
3219
3220
3221
        (
            q,
            kv,
            out,
            cu_seqlens_q,
            cu_seqlens_kv,
3222
3223
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
3224
3225
3226
3227
3228
3229
3230
            q_fp8,
            kv_fp8,
            out_fp8,
            fwd_scales,
            fwd_scale_invs,
            *aux_ctx_tensors,
        ) = ctx.saved_tensors
3231
3232
        if not aux_ctx_tensors[0].is_contiguous():
            aux_ctx_tensors[0] = aux_ctx_tensors[0].contiguous()
3233
        if ctx.use_FAv2_bwd:
3234
            softmax_lse, rng_state = aux_ctx_tensors
3235
3236
3237
            dq = torch.empty_like(q)
            dkv = torch.empty_like(kv)
            maybe_contiguous = lambda x: x.contiguous() if x.stride(-1) != 1 else x
3238
            d_out, q, k, v, out = [maybe_contiguous(x) for x in (d_out, q, kv[:, 0], kv[:, 1], out)]
3239
            flash_attn_cuda_bwd(
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
                d_out,
                q,
                k,
                v,
                out,
                softmax_lse,
                dq,
                dkv[:, 0],
                dkv[:, 1],
                cu_seqlens_q,
                cu_seqlens_kv,
                ctx.max_seqlen_q,
                ctx.max_seqlen_kv,
                ctx.dropout_p,
                ctx.attn_scale,
                False,
                "causal" in ctx.attn_mask_type,
                None,
                rng_state,
3259
            )
3260
3261
            dq = dq[..., : d_out.shape[-1]]
            dkv = dkv[..., : d_out.shape[-1]]
3262
        else:
3263
3264
            with torch.cuda.nvtx.range("_FusedAttn_kvpacked"):
                if ctx.fp8:
3265
                    logger.debug("Running backward in FP8")
3266
                    fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
3267
                    fp8_dtype_backward = get_fp8_te_dtype(
3268
3269
                        ctx.fp8_meta["recipe"], fprop_tensor=False
                    )
3270
3271
                    if ctx.fp8_meta["recipe"].fp8_mha:
                        d_out_fp8 = d_out
3272
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = d_out_f8tensor._scale_inv
3273
3274
3275
                    else:
                        d_out_fp8 = cast_to_fp8(
                            d_out.view(-1, d_out.shape[-2] * d_out.shape[-1]),
3276
3277
3278
3279
                            ctx.fp8_meta["scaling_bwd"],
                            META_DO,
                            fp8_dtype_backward,
                        ).view(d_out.shape)
3280
                    dq_fp8, dkv_fp8, *rest = fused_attn_bwd_kvpacked(
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
                        ctx.max_seqlen_q,
                        ctx.max_seqlen_kv,
                        cu_seqlens_q,
                        cu_seqlens_kv,
                        q_fp8,
                        kv_fp8,
                        out_fp8,
                        d_out_fp8,
                        fp8_dtype_forward,
                        fp8_dtype_backward,
                        aux_ctx_tensors,
3292
                        ctx.fused_attention_backend,
3293
3294
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
                        fwd_scale_invs[META_QKV],  # d_scale_qkv,
                        fwd_scale_invs[META_S],  # d_scale_s,
                        fwd_scale_invs[META_O],  # d_scale_o,
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO],  # d_scale_do
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DP],  # d_scale_dp
                        fwd_scales[META_S],  # q_scale_s
                        ctx.fp8_meta["scaling_bwd"].scale[META_DP],  # q_scale_dp
                        ctx.fp8_meta["scaling_bwd"].scale[META_DQKV],  # q_scale_dqkv
                        ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DP],  # amax_dp
                        ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DQKV],  # amax_dqkv
                        ctx.attn_scale,
                        ctx.dropout_p,
                        ctx.fast_zero_fill,
                        ctx.qkv_layout,
                        ctx.attn_bias_type,
                        ctx.attn_mask_type,
                    )
3312
                    if ctx.fp8_meta["recipe"].fp8_mha:
3313
3314
                        dq = Float8Tensor(
                            data=dq_fp8,
3315
3316
3317
3318
3319
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
3320
3321
3322
                        )
                        dkv = Float8Tensor(
                            data=dkv_fp8,
3323
3324
3325
3326
3327
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
3328
                        )
3329
3330
3331
                    else:
                        dq = cast_from_fp8(
                            dq_fp8.view(-1, dq_fp8.shape[-2] * dq_fp8.shape[-1]),
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
                            ctx.fp8_meta["scaling_bwd"],
                            META_DQKV,
                            fp8_dtype_backward,
                            ctx.qkv_dtype,
                        ).view(dq_fp8.shape)
                        dkv_c_fp8 = dkv_fp8.view(
                            -1, dkv_fp8.shape[-3] * dkv_fp8.shape[-2] * dkv_fp8.shape[-1]
                        )
                        dkv = cast_from_fp8(
                            dkv_c_fp8,
                            ctx.fp8_meta["scaling_bwd"],
                            META_DQKV,
                            fp8_dtype_backward,
                            ctx.qkv_dtype,
                        ).view(dkv_fp8.shape)
3347
                else:
3348
                    logger.debug("Running backward in %s", q.dtype)
3349
3350
3351
                    if d_out.dtype == torch.uint8:
                        d_out = d_out_f8tensor.from_float8(q.dtype)
                    dq, dkv, *rest = fused_attn_bwd_kvpacked(
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
                        ctx.max_seqlen_q,
                        ctx.max_seqlen_kv,
                        cu_seqlens_q,
                        cu_seqlens_kv,
                        q,
                        kv,
                        out,
                        d_out,
                        ctx.qkv_dtype,
                        ctx.qkv_dtype,
                        aux_ctx_tensors,
3363
                        ctx.fused_attention_backend,
3364
3365
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        ctx.attn_scale,
                        ctx.dropout_p,
                        ctx.fast_zero_fill,
                        ctx.qkv_layout,
                        ctx.attn_bias_type,
                        ctx.attn_mask_type,
                    )
3383

3384
3385
        # if no_bias or alibi, return dqkv
        if ctx.attn_bias_type in ["no_bias", "alibi"]:
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
            return (
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                dq,
                dkv,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
            )
3412
        # else, return (dqkv, dbias)
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
        return (
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            dq,
            dkv,
            None,
            rest[0],
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
        )

3440

3441
3442
3443
3444
class FusedAttnFunc(torch.autograd.Function):
    """Function for FusedAttention with separate Q, K, V tensors"""

    @staticmethod
3445
3446
3447
3448
3449
3450
3451
    def forward(
        ctx,
        is_training,
        max_seqlen_q,
        max_seqlen_kv,
        cu_seqlens_q,
        cu_seqlens_kv,
3452
3453
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
        q,
        k,
        v,
        qkv_dtype,
        attn_bias,
        attn_scale,
        dropout_p,
        fast_zero_fill,
        qkv_layout,
        attn_bias_type,
        attn_mask_type,
        rng_gen,
        fused_attention_backend,
        use_FAv2_bwd,
        fp8,
        fp8_meta,
    ):
3471
        logger = logging.getLogger("FusedAttnFunc")
3472
        if fp8:
3473
            logger.debug("Running forward in FP8")
3474
3475
3476
            fused_attention_backend = FusedAttnBackend["FP8"]
            fp8_dtype_forward = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
            if fp8_meta["recipe"].fp8_mha:
3477
3478
                assert (
                    isinstance(q, Float8Tensor)
3479
                    and isinstance(k, Float8Tensor)
3480
3481
                    and isinstance(v, Float8Tensor)
                ), "q/k/v must be Float8Tensors for FP8 MHA."
3482
3483
3484
3485
                fp8_meta["scaling_fwd"].scale_inv[META_QKV] = q._scale_inv
                q_fp8, k_fp8, v_fp8 = q._data, k._data, v._data
            else:
                # 1: qkv packed, 2: kv packed, 3: qkv separate
3486
                qkv_group = len(qkv_layout.split("_"))
3487
                if qkv_group == 1:
3488
3489
                    dim = qkv_layout.find("3")
                    qkv = _combine_tensors([q, k, v], dim)
3490
                    qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
3491
3492
3493
3494
                    qkv_fp8 = cast_to_fp8(
                        qkv_c, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                    ).view(qkv.shape)
                    q_fp8, k_fp8, v_fp8 = _SplitAlongDim.apply(qkv_fp8, dim, [1, 1, 1])
3495
3496
                    q_fp8, k_fp8, v_fp8 = [x.squeeze(dim) for x in [q_fp8, k_fp8, v_fp8]]
                if qkv_group == 2:
3497
3498
3499
3500
3501
                    q_fp8 = cast_to_fp8(
                        q, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                    ).view(q.shape)
                    dim = qkv_layout.split("_")[1].find("2")
                    kv = _combine_tensors([k, v], dim)
3502
                    kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
3503
3504
3505
3506
                    kv_fp8 = cast_to_fp8(
                        kv_c, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                    ).view(kv.shape)
                    k_fp8, v_fp8 = _SplitAlongDim.apply(kv_fp8, dim, [1, 1])
3507
3508
                    k_fp8, v_fp8 = [x.squeeze(dim) for x in [k_fp8, v_fp8]]
                if qkv_group == 3:
3509
3510
3511
3512
3513
3514
3515
3516
3517
                    q_fp8 = cast_to_fp8(
                        q, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                    ).view(q.shape)
                    k_fp8 = cast_to_fp8(
                        k, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                    ).view(k.shape)
                    v_fp8 = cast_to_fp8(
                        v, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                    ).view(v.shape)
3518
            out_fp8, aux_ctx_tensors = fused_attn_fwd(
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
                is_training,
                max_seqlen_q,
                max_seqlen_kv,
                cu_seqlens_q,
                cu_seqlens_kv,
                q_fp8,
                k_fp8,
                v_fp8,
                fp8_dtype_forward,
                fused_attention_backend,
                attn_bias,
3530
3531
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
3532
3533
3534
3535
3536
3537
                fp8_meta["scaling_fwd"].scale_inv[META_QKV],
                fp8_meta["scaling_fwd"].scale_inv[META_S],
                fp8_meta["scaling_fwd"].scale[META_S],
                fp8_meta["scaling_fwd"].scale[META_O],
                fp8_meta["scaling_fwd"].amax_history[0][META_S],
                fp8_meta["scaling_fwd"].amax_history[0][META_O],
3538
3539
3540
3541
3542
3543
3544
3545
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
                rng_gen,
            )
3546
            if fp8_meta["recipe"].fp8_mha:
3547
3548
                out_ret = Float8Tensor(
                    data=out_fp8,
3549
3550
3551
3552
3553
3554
3555
3556
3557
                    fp8_meta=fp8_meta,
                    fp8_meta_forward=True,
                    fp8_meta_index=META_O,
                    fp8_dtype=fp8_dtype_forward,
                    dtype=q.dtype,
                )
            else:
                out_ret = cast_from_fp8(
                    out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
3558
3559
3560
3561
3562
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
3563
3564
3565
3566
            out_save = out_ret

            if fp8_meta["recipe"].fp8_mha and not int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
                # 1: qkv packed, 2: kv packed, 3: qkv separate
3567
                qkv_group = len(qkv_layout.split("_"))
3568
                if qkv_group == 1:
3569
3570
                    dim = qkv_layout.find("3")
                    qkv = _combine_tensors([q, k, v], dim)
3571
                    qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
3572
3573
                    qkv_no_fp8 = cast_from_fp8(
                        qkv_c._data,
3574
                        fp8_meta["scaling_fwd"],
3575
3576
3577
3578
3579
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[qkv.dtype],
                    ).view(qkv.shape)
                    q, k, v = _SplitAlongDim.apply(qkv_no_fp8, dim, [1, 1, 1])
3580
3581
                    q, k, v = [x.squeeze(dim) for x in [q, k, v]]
                if qkv_group == 2:
3582
3583
                    q = cast_from_fp8(
                        q._data,
3584
                        fp8_meta["scaling_fwd"],
3585
3586
3587
3588
3589
3590
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[q.dtype],
                    ).view(q.shape)
                    dim = qkv_layout.split("_")[1].find("2")
                    kv = _combine_tensors([k, v], dim)
3591
                    kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
3592
3593
                    kv_no_fp8 = cast_from_fp8(
                        kv_c._data,
3594
                        fp8_meta["scaling_fwd"],
3595
3596
3597
3598
3599
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[kv.dtype],
                    ).view(kv.shape)
                    k, v = _SplitAlongDim.apply(kv_no_fp8, dim, [1, 1])
3600
3601
                    k, v = [x.squeeze(dim) for x in [k, v]]
                if qkv_group == 3:
3602
3603
                    q = cast_from_fp8(
                        q._data,
3604
                        fp8_meta["scaling_fwd"],
3605
3606
3607
3608
3609
3610
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[q.dtype],
                    ).view(q.shape)
                    k = cast_from_fp8(
                        k._data,
3611
                        fp8_meta["scaling_fwd"],
3612
3613
3614
3615
3616
3617
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[k.dtype],
                    ).view(k.shape)
                    v = cast_from_fp8(
                        v._data,
3618
                        fp8_meta["scaling_fwd"],
3619
3620
3621
3622
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[v.dtype],
                    ).view(v.shape)
3623
3624
                out_save = cast_from_fp8(
                    out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)

            fp8_tensors = (
                q_fp8,
                k_fp8,
                v_fp8,
                out_fp8,
3636
                fp8_meta["scaling_fwd"].scale.clone(),
3637
3638
                fp8_meta["scaling_fwd"].scale_inv.clone(),
            )
3639
        else:
3640
            logger.debug("Running forward in %s", q.dtype)
3641
            out_ret, aux_ctx_tensors = fused_attn_fwd(
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
                is_training,
                max_seqlen_q,
                max_seqlen_kv,
                cu_seqlens_q,
                cu_seqlens_kv,
                q,
                k,
                v,
                qkv_dtype,
                fused_attention_backend,
                attn_bias,
3653
3654
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
                None,
                None,
                None,
                None,
                None,
                None,
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
                rng_gen,
            )
3669
3670
            out_save = out_ret
            fp8_tensors = (None, None, None, None, None, None)
3671

3672
        from .cpu_offload import CPUOffloadEnabled
3673

3674
        if CPUOffloadEnabled:
3675
            tensor_list = [q, k, v, out_save, cu_seqlens_q, cu_seqlens_kv]
3676
            qkv_layout = "sbhd_sbhd_sbhd"
3677
3678
3679
3680
            for tensor in tensor_list:
                if tensor is not None:
                    tensor.activation_offloading = True

3681
3682
        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
        qkvo_tensors = (q, k, v, out_save) if not ctx.fp8 else (None, None, None, None)
3683
3684
3685
3686
        ctx.save_for_backward(
            *qkvo_tensors,
            cu_seqlens_q,
            cu_seqlens_kv,
3687
3688
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
3689
3690
3691
            *fp8_tensors,
            *aux_ctx_tensors,
        )
3692
        ctx.fp8_meta = fp8_meta
3693
3694
3695
3696
3697
3698
3699
3700
3701
        ctx.max_seqlen_q = max_seqlen_q
        ctx.max_seqlen_kv = max_seqlen_kv
        ctx.qkv_dtype = qkv_dtype
        ctx.attn_scale = attn_scale
        ctx.dropout_p = dropout_p
        ctx.fast_zero_fill = fast_zero_fill
        ctx.qkv_layout = qkv_layout
        ctx.attn_bias_type = attn_bias_type
        ctx.attn_mask_type = attn_mask_type
3702
        ctx.fused_attention_backend = (
3703
            fused_attention_backend if ctx.fp8 else FusedAttnBackend["F16_arbitrary_seqlen"]
3704
        )
3705
3706
        ctx.use_FAv2_bwd = use_FAv2_bwd

3707
        return out_ret
3708
3709
3710

    @staticmethod
    def backward(ctx, d_out):
3711
        logger = logging.getLogger("FusedAttnFunc")
3712
        if ctx.fp8_meta["recipe"].fp8_mha:
3713
3714
3715
            assert isinstance(
                d_out, Float8Tensor
            ), "Gradient of the DPA output must be in Float8Tensor type for FP8 MHA."
3716
3717
3718
            d_out_f8tensor = d_out
            d_out = d_out._data

3719
        d_out = d_out.contiguous()
3720
3721
3722
3723
3724
3725
3726
        (
            q,
            k,
            v,
            out,
            cu_seqlens_q,
            cu_seqlens_kv,
3727
3728
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
3729
3730
3731
3732
3733
3734
3735
3736
            q_fp8,
            k_fp8,
            v_fp8,
            out_fp8,
            fwd_scales,
            fwd_scale_invs,
            *aux_ctx_tensors,
        ) = ctx.saved_tensors
3737
3738
        if not aux_ctx_tensors[0].is_contiguous():
            aux_ctx_tensors[0] = aux_ctx_tensors[0].contiguous()
3739
        if ctx.use_FAv2_bwd:
3740
            softmax_lse, rng_state = aux_ctx_tensors
3741
3742
3743
3744
            dq = torch.empty_like(q)
            dk = torch.empty_like(k)
            dv = torch.empty_like(v)
            maybe_contiguous = lambda x: x.contiguous() if x.stride(-1) != 1 else x
3745
            d_out, q, k, v, out = [maybe_contiguous(x) for x in (d_out, q, k, v, out)]
3746
            flash_attn_cuda_bwd(
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
                d_out,
                q,
                k,
                v,
                out,
                softmax_lse,
                dq,
                dk,
                dv,
                cu_seqlens_q,
                cu_seqlens_kv,
                ctx.max_seqlen_q,
                ctx.max_seqlen_kv,
                ctx.dropout_p,
                ctx.attn_scale,
                False,
                "causal" in ctx.attn_mask_type,
                None,
                rng_state,
3766
            )
3767
3768
3769
            dq = dq[..., : d_out.shape[-1]]
            dk = dk[..., : d_out.shape[-1]]
            dv = dv[..., : d_out.shape[-1]]
3770
        else:
3771
3772
            with torch.cuda.nvtx.range("_FusedAttn"):
                if ctx.fp8:
3773
                    logger.debug("Running backward in FP8")
3774
3775
                    fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
                    fp8_dtype_backward = get_fp8_te_dtype(
3776
3777
                        ctx.fp8_meta["recipe"], fprop_tensor=False
                    )
3778
3779
                    if ctx.fp8_meta["recipe"].fp8_mha:
                        d_out_fp8 = d_out
3780
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = d_out_f8tensor._scale_inv
3781
3782
3783
                    else:
                        d_out_fp8 = cast_to_fp8(
                            d_out.view(-1, d_out.shape[-2] * d_out.shape[-1]),
3784
3785
3786
3787
                            ctx.fp8_meta["scaling_bwd"],
                            META_DO,
                            fp8_dtype_backward,
                        ).view(d_out.shape)
3788
                    dq_fp8, dk_fp8, dv_fp8, *rest = fused_attn_bwd(
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
                        ctx.max_seqlen_q,
                        ctx.max_seqlen_kv,
                        cu_seqlens_q,
                        cu_seqlens_kv,
                        q_fp8,
                        k_fp8,
                        v_fp8,
                        out_fp8,
                        d_out_fp8,
                        fp8_dtype_forward,
                        fp8_dtype_backward,
                        aux_ctx_tensors,
3801
                        ctx.fused_attention_backend,
3802
3803
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
                        fwd_scale_invs[META_QKV],  # d_scale_qkv,
                        fwd_scale_invs[META_S],  # d_scale_s,
                        fwd_scale_invs[META_O],  # d_scale_o,
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO],  # d_scale_do
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DP],  # d_scale_dp
                        fwd_scales[META_S],  # q_scale_s
                        ctx.fp8_meta["scaling_bwd"].scale[META_DP],  # q_scale_dp
                        ctx.fp8_meta["scaling_bwd"].scale[META_DQKV],  # q_scale_dqkv
                        ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DP],  # amax_dp
                        ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DQKV],  # amax_dqkv
                        ctx.attn_scale,
                        ctx.dropout_p,
                        ctx.fast_zero_fill,
                        ctx.qkv_layout,
                        ctx.attn_bias_type,
                        ctx.attn_mask_type,
                    )
3821

3822
                    if ctx.fp8_meta["recipe"].fp8_mha:
3823
3824
                        dq = Float8Tensor(
                            data=dq_fp8,
3825
3826
3827
3828
3829
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
3830
3831
3832
                        )
                        dk = Float8Tensor(
                            data=dk_fp8,
3833
3834
3835
3836
3837
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
3838
3839
3840
                        )
                        dv = Float8Tensor(
                            data=dv_fp8,
3841
3842
3843
3844
3845
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
3846
                        )
3847
                    else:
3848
                        qkv_group = len(ctx.qkv_layout.split("_"))
3849
                        if qkv_group == 1:
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
                            dim = ctx.qkv_layout.find("3")
                            dqkv_fp8 = _combine_tensors([dq_fp8, dk_fp8, dv_fp8], dim)
                            dqkv_c_fp8 = dqkv_fp8.view(
                                -1, dqkv_fp8.shape[-3] * dqkv_fp8.shape[-2] * dqkv_fp8.shape[-1]
                            )
                            dqkv = cast_from_fp8(
                                dqkv_c_fp8,
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dqkv_fp8.shape)
                            dq, dk, dv = _SplitAlongDim.apply(dqkv, dim, [1, 1, 1])
3863
3864
3865
3866
                            dq, dk, dv = [x.squeeze(dim) for x in [dq, dk, dv]]
                        if qkv_group == 2:
                            dq = cast_from_fp8(
                                dq_fp8.view(-1, dq_fp8.shape[-2] * dq_fp8.shape[-1]),
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dq_fp8.shape)
                            dim = ctx.qkv_layout.split("_")[1].find("2")
                            dkv_fp8 = _combine_tensors([dk_fp8, dv_fp8], dim)
                            dkv_c_fp8 = dkv_fp8.view(
                                -1, dkv_fp8.shape[-3] * dkv_fp8.shape[-2] * dkv_fp8.shape[-1]
                            )
                            dkv = cast_from_fp8(
                                dkv_c_fp8,
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dkv_fp8.shape)
                            dk, dv = _SplitAlongDim.apply(dkv, dim, [1, 1])
3885
3886
3887
3888
                            dk, dv = [x.squeeze(dim) for x in [dk, dv]]
                        if qkv_group == 3:
                            dq = cast_from_fp8(
                                dq_fp8.view(-1, dq_fp8.shape[-2] * dq_fp8.shape[-1]),
3889
3890
3891
3892
3893
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dq_fp8.shape)
3894
3895
                            dk = cast_from_fp8(
                                dk_fp8.view(-1, dk_fp8.shape[-2] * dk_fp8.shape[-1]),
3896
3897
3898
3899
3900
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dk_fp8.shape)
3901
3902
                            dv = cast_from_fp8(
                                dv_fp8.view(-1, dv_fp8.shape[-2] * dv_fp8.shape[-1]),
3903
3904
3905
3906
3907
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dv_fp8.shape)
3908
                else:
3909
                    logger.debug("Running backward in %s", q.dtype)
3910
3911
3912
                    if d_out.dtype == torch.uint8:
                        d_out = d_out_f8tensor.from_float8(q.dtype)
                    dq, dk, dv, *rest = fused_attn_bwd(
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
                        ctx.max_seqlen_q,
                        ctx.max_seqlen_kv,
                        cu_seqlens_q,
                        cu_seqlens_kv,
                        q,
                        k,
                        v,
                        out,
                        d_out,
                        ctx.qkv_dtype,
                        ctx.qkv_dtype,
                        aux_ctx_tensors,
3925
                        ctx.fused_attention_backend,
3926
3927
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        None,
                        ctx.attn_scale,
                        ctx.dropout_p,
                        ctx.fast_zero_fill,
                        ctx.qkv_layout,
                        ctx.attn_bias_type,
                        ctx.attn_mask_type,
                    )
3945

3946
3947
        # if no_bias or alibi, return dqkv
        if ctx.attn_bias_type in ["no_bias", "alibi"]:
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
            return (
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                dq,
                dk,
                dv,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
            )
3975
        # else, return (dqkv, dbias)
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
        return (
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            dq,
            dk,
            dv,
            None,
            rest[0],
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
        )
4003

4004

4005
class FusedAttention(torch.nn.Module):
4006
4007
4008
4009
4010
4011
4012
4013
4014
    """Dot product attention, with multiple backends:

    1. FusedAttnBackend["F16_max512_seqlen"]
       cuDNN based fused attention for FP16/BF16 and <=512 sequence length.
    2. FusedAttnBackend["F16_arbitrary_seqlen"]
       cuDNN based fused attention for FP16/BF16 and any sequence length.

    Support matrix:

4015
4016
4017
4018
    | backend       | 1                       | 2                              |
    | flash based   | no                      | yes                            |
    | cuDNN based   | yes                     | yes                            |
    | qkv dtype     | fp16/bf16               | fp16/bf16                      |
4019
    | attn_type     | self/cross              | self/cross                     |
4020
    | qkv_layout    |                         |                                |
4021
    |  - (q,k,v)    | sb3hd, bs3hd            | sb3hd, bs3hd, sbh3d, bsh3d     |
4022
    |               | sbhd_sb2hd, bshd_bs2hd  | sbhd_sb2hd, bshd_bs2hd         |
4023
4024
    |               | bshd_bshd_bshd          | sbhd_sbh2d, bshd_bsh2d         |
    |               |                         | sbhd_sbhd_sbhd, bshd_bshd_bshd |
4025
4026
    | mask_type     | causal/padding/no_mask  | causal/padding/no_mask         |
    | bias_type     | post_scale_bias/no_bias | post_scale_bias/alibi/no_bias  |
4027
    | dropout       | yes                     | yes                            |
4028
4029
    | max_seqlen    | <=512, multiple of 64   | any, multiple of 64            |
    | head_dim      | 64                      | <=128, multiple of 8           |
4030
    | output dtype  | fp16/bf16               | fp16/bf16                      |
4031
4032
4033
4034
    """

    def __init__(
        self,
4035
        softmax_scale: float,
4036
4037
4038
        attention_dropout: float = 0.0,
        attention_dropout_ctx: Optional[Callable] = nullcontext,
        attention_type: str = "self",
4039
4040
        layer_number: Optional[int] = None,
        deterministic: bool = False,
4041
4042
4043
    ) -> None:
        super().__init__()

4044
        self.logger = logging.getLogger("FusedAttention")
4045
        self.softmax_scale = softmax_scale
4046
4047
4048
        self.attention_dropout = attention_dropout
        self.attention_dropout_ctx = attention_dropout_ctx
        self.attention_type = attention_type
4049
4050
4051
        self.use_FAv2_bwd = os.getenv(
            "NVTE_FUSED_ATTN_USE_FAv2_BWD", "0"
        ) == "1" and get_device_compute_capability() == (9, 0)
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
        self.layer_number = 1 if layer_number is None else layer_number
        if deterministic:
            # workspace optimization path is deterministic
            os.environ["CUDNN_FRONTEND_ATTN_DP_WORKSPACE_LIMIT"] = "-1"

        # CUDNN_FRONTEND_ATTN_DP_WORKSPACE_LIMIT
        # - unset:       enables workspace optimization when required workspace is <= 256MB
        #                or when bias gradient needs to be computed
        # - n:           enables workspace optimization when required workspace is <= n bytes
        # - -1:          enables workspace optimization always
        # - 0:           disables workspace optimization always
        if "NVTE_FUSED_ATTN_FORCE_WORKSPACE_OPT" in os.environ:
            if os.environ["NVTE_FUSED_ATTN_FORCE_WORKSPACE_OPT"] == "0":
                os.environ["CUDNN_FRONTEND_ATTN_DP_WORKSPACE_LIMIT"] = "0"
            if os.environ["NVTE_FUSED_ATTN_FORCE_WORKSPACE_OPT"] == "1":
                os.environ["CUDNN_FRONTEND_ATTN_DP_WORKSPACE_LIMIT"] = "-1"
4068

4069
        def remove_extra_states_check(self, incompatible_keys):  # pylint: disable=unused-argument
4070
4071
            """
            Temporarily remove fused_attention._extra_state as a missing key
4072
4073
4074
4075
            or an unexpected key when loading TransformerEngine checkpoints.
            Please store FP8 metadata as DotProductAttention's _extra_state,
            rather than FusedAttention's _extra_state. This hook will be
            phased out in TransformerEngine 2.0.
4076
4077
            """
            for key in incompatible_keys.missing_keys:
4078
                if "fused_attention._extra_state" in key:
4079
                    incompatible_keys.missing_keys.remove(key)
4080
4081
4082
4083
4084
4085
4086
            for key in incompatible_keys.unexpected_keys:
                if "fused_attention._extra_state" in key:
                    incompatible_keys.unexpected_keys.remove(key)
                    warnings.warn(
                        "fused_attention._extra_state is not loaded from checkpoint. Please map "
                        "FusedAttention's _extra_state to DotProductAttention's _extra_state."
                    )
4087

4088
4089
        self.register_load_state_dict_post_hook(remove_extra_states_check)

4090
    @no_torch_dynamo()
4091
4092
4093
4094
4095
    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
4096
4097
4098
        qkv_layout: str = "sbh3d",
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
4099
4100
        cu_seqlens_q_padded: Optional[torch.Tensor] = None,
        cu_seqlens_kv_padded: Optional[torch.Tensor] = None,
4101
4102
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
4103
        attn_mask_type: str = "causal",
4104
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
4105
        fused_attention_backend: tex.NVTE_Fused_Attn_Backend = tex.NVTE_Fused_Attn_Backend.NVTE_No_Backend,
4106
4107
4108
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
        fast_zero_fill: bool = True,
4109
4110
4111
        cp_group: Optional[dist_group_type] = None,
        cp_global_ranks: List[int] = None,
        cp_stream: torch.cuda.Stream = None,
4112
4113
        fp8: bool = False,
        fp8_meta: Optional[Dict[str, Any]] = None,
4114
4115
    ) -> torch.Tensor:
        """fused attention fprop"""
4116
4117
4118
        assert (
            fused_attention_backend != tex.NVTE_Fused_Attn_Backend.NVTE_No_Backend
        ), "No fused attention backend supports this input combination!"
4119
        assert (
4120
4121
4122
            (query_layer.dtype in [torch.float16, torch.bfloat16, torch.uint8])
            and (key_layer.dtype in [torch.float16, torch.bfloat16, torch.uint8])
            and (value_layer.dtype in [torch.float16, torch.bfloat16, torch.uint8])
4123
        ), "FusedAttention only supports FP16 and BF16 data types."
4124
4125
        assert (
            query_layer.is_cuda and key_layer.is_cuda and value_layer.is_cuda
4126
        ), "FusedAttention only supports CUDA tensors."
4127
4128
        assert (
            qkv_layout in QKVLayouts
4129
        ), f"FusedAttention does not support qkv_layout = {qkv_layout}!"
4130

4131
4132
        context_parallel = (cp_group is not None) and (get_distributed_world_size(cp_group) != 1)

4133
        qkv_format = "".join([i for i in qkv_layout.split("_")[0] if i.isalpha()])
4134

4135
4136
        if qkv_format in ["sbhd", "bshd"]:
            if qkv_format == "sbhd":
4137
                batch_size, max_seqlen_q, max_seqlen_kv = (
4138
4139
4140
4141
4142
                    query_layer.shape[1],
                    query_layer.shape[0],
                    key_layer.shape[0],
                )
            if qkv_format == "bshd":
4143
                batch_size, max_seqlen_q, max_seqlen_kv = (
4144
4145
4146
4147
4148
                    query_layer.shape[0],
                    query_layer.shape[1],
                    key_layer.shape[1],
                )
            if "padding" in attn_mask_type:
4149
4150
                assert not context_parallel, "Padding mask not supported with context parallelism!"

4151
4152
4153
4154
4155
                if cu_seqlens_q is None or cu_seqlens_kv is None:
                    if attention_mask is None:
                        raise RuntimeError(
                            "Please provide attention_mask or cu_seqlens for padding!"
                        )
4156
                    if self.attention_type == "self":
4157
4158
                        cu_seqlens_q = get_cu_seqlens(attention_mask)
                        cu_seqlens_kv = cu_seqlens_q
4159
                    else:
4160
4161
                        cu_seqlens_q = get_cu_seqlens(attention_mask[0])
                        cu_seqlens_kv = get_cu_seqlens(attention_mask[1])
4162
            else:
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
                if cu_seqlens_q is None:
                    cu_seqlens_q = _get_full_cu_seqlens(
                        batch_size,
                        max_seqlen_q,
                        query_layer.device,
                    )
                if cu_seqlens_kv is None:
                    cu_seqlens_kv = _get_full_cu_seqlens(
                        batch_size,
                        max_seqlen_kv,
                        key_layer.device,
                    )
4175
4176
4177
        if qkv_format == "thd":
            assert (
                max_seqlen_q is not None
4178
4179
4180
                and max_seqlen_kv is not None
                and cu_seqlens_q is not None
                and cu_seqlens_kv is not None
4181
            ), "max_seqlen_q/kv and cu_seqlens_q/kv can not be None when qkv_format is thd!"
4182
4183
4184
4185

        if cu_seqlens_q_padded is None or cu_seqlens_kv_padded is None:
            cu_seqlens_q_padded = cu_seqlens_q
            cu_seqlens_kv_padded = cu_seqlens_kv
4186
4187
4188

        qkv_dtype = TE_DType[query_layer.dtype]

4189
4190
4191
4192
4193
        use_FAv2_bwd = (
            self.use_FAv2_bwd
            and (core_attention_bias_type == "no_bias")
            and (fused_attention_backend == tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen)
        )
4194
4195

        if context_parallel:
4196
            assert (
4197
4198
4199
4200
4201
4202
4203
4204
                fused_attention_backend == tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen
            ), f"{fused_attention_backend} does not work with context parallelism!"
            assert core_attention_bias_type not in [
                "alibi"
            ], f"{core_attention_bias_type} is not supported with context parallelism!"
            query_layer, key_layer, value_layer = [
                x.contiguous() for x in (query_layer, key_layer, value_layer)
            ]
4205
4206
4207
            with self.attention_dropout_ctx():
                output = attn_forward_func_with_cp(
                    self.training,
4208
4209
4210
4211
4212
4213
4214
                    query_layer,
                    key_layer,
                    value_layer,
                    cu_seqlens_q,
                    cu_seqlens_kv,
                    max_seqlen_q,
                    max_seqlen_kv,
4215
4216
                    cu_seqlens_q_padded,
                    cu_seqlens_kv_padded,
4217
                    self.attention_dropout if self.training else 0.0,
4218
4219
4220
                    cp_group,
                    cp_global_ranks,
                    cp_stream,
4221
                    softmax_scale=self.softmax_scale,
4222
                    qkv_format=qkv_format,
4223
                    attn_mask_type=attn_mask_type,
4224
4225
                    attn_bias_type=core_attention_bias_type,
                    attn_bias=core_attention_bias,
4226
4227
4228
                    use_fused_attention=True,
                )
        else:
4229
4230
4231
4232
4233
            with self.attention_dropout_ctx():
                if fp8:
                    assert fused_attention_backend == tex.NVTE_Fused_Attn_Backend.NVTE_FP8, (
                        f"cuDNN attention sub-backend {int(tex.NVTE_Fused_Attn_Backend.NVTE_FP8)}"
                        " is required for FP8 attention!"
4234
                    )
4235
4236
4237
4238
4239
4240
4241
4242
4243
                    assert (
                        fp8_meta is not None
                    ), "FP8 metadata fp8_meta is required for FP8 attention!"
                output = FusedAttnFunc.apply(
                    self.training,
                    max_seqlen_q,
                    max_seqlen_kv,
                    cu_seqlens_q,
                    cu_seqlens_kv,
4244
4245
                    cu_seqlens_q_padded,
                    cu_seqlens_kv_padded,
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
                    query_layer,
                    key_layer,
                    value_layer,
                    qkv_dtype,
                    core_attention_bias,
                    self.softmax_scale,
                    self.attention_dropout if self.training else 0.0,
                    fast_zero_fill,
                    qkv_layout,
                    core_attention_bias_type,
                    attn_mask_type,
                    None,  # rng_gen
                    fused_attention_backend,
                    use_FAv2_bwd,
                    fp8,
                    fp8_meta,
                )
4263

4264
4265
        # ...hd -> ...(hd)
        return output.view(*output.shape[:-2], -1)
4266
4267


4268
class DotProductAttention(TransformerEngineBaseModule):
4269
4270
4271
4272
4273
4274
    """Allows the model to jointly attend to information from different
    representation subspaces as described in the paper:
    `Attention Is All You Need <https://arxiv.org/abs/1706.03762>`_.

    .. note::

4275
        Argument :attr:`attention_mask` in the `forward` call is only used when
4276
        :attr:`attn_mask_type` includes '"padding"' or `"arbitrary"`.
4277
4278
4279

    .. warning::

4280
        FlashAttention uses a non-deterministic algorithm for optimal performance. To observe
4281
        deterministic behavior at the cost of performance, use FlashAttention version >= `2.4.1`
4282
4283
        and set the environment variable :attr:`NVTE_ALLOW_NONDETERMINISTIC_ALGO=0`. In order
        to disable`flash-attn` entirely, set :attr:`NVTE_FLASH_ATTN=0`.
4284
4285
4286
4287
4288
4289

    Parameters
    ----------
    num_attention_heads : int
                         number of attention heads in the transformer layer.
    kv_channels : int
4290
                number of key-query-value channels per attention head.
4291
4292
4293
4294
4295
4296
4297
4298
    num_gqa_groups : Optional[int] = None
                    number of GQA groups in the transformer layer.
                    Grouped Query Attention is described in
                    `this paper <https://arxiv.org/pdf/2305.13245.pdf>`_.
                    This only affects the keys and values, not the queries.
                    GQA-1 is equivalent to Multi-Query Attention
                    (`MQA <https://arxiv.org/pdf/1911.02150.pdf>`_), while GQA-H
                    is equivalent to MHA, i.e. `num_gqa_groups = num_attention_heads`.
4299
4300
    attention_dropout: float, default = 0.0
                      dropout probability for the dropout op during multi-head attention.
4301
    attn_mask_type: str, default = `causal`
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
                   type of attention mask passed into softmax operation, options are "`no_mask`",
                   "`padding`", "`causal`", "`padding,causal`", "`causal,padding`", and
                   "`arbitrary`", where "`padding,causal`" and "`causal,padding`" are equivalent.
                   This arg can be overridden by :attr:`attn_mask_type` in the `forward` method.
                   It is useful for cases involving compilation/tracing, e.g. ONNX export, and the
                   forward arg is useful for dynamically changing mask types, e.g. a different mask
                   for training and inference. For "`no_mask`", no attention mask is applied. For
                   "`causal`" or the causal mask in "`padding,causal`", TransformerEngine calculates
                   and applies an upper triangular mask to the softmax input. No user input is
                   needed. For "`padding`" or the padding mask in "`padding,causal`", users need to
                   provide the locations of padded tokens either via :attr:`cu_seqlens_q` and
                   :attr:`cu_seqlens_kv` in the shape of [batch_size + 1] or :attr:`attention_mask`
                   in the shape [batch_size, 1, 1, max_seq_len]. For the "`arbitrary`" mask, users
                   need to provide a mask that is broadcastable to the shape of softmax input.
4316
4317
4318
4319
4320
4321
    window_size: Optional[Tuple[int, int]], default = `None`
                sliding window size for local attention, where query at position i attends to keys
                in [i + seqlen_k - seqlen_q - window_size[0], i + seqlen_k - seqlen_q
                + window_size[1]] inclusive. Special cases (-1, -1) and (-1, 0) mean no sliding
                window and causal mask specifically. Similar to :attr:`attn_mask_type`, it can
                be overridden by :attr:`window_size` in `forward` as well.
4322
4323
    attention_type: str, default = `self`
                   type of attention, either "`self`" and "`cross`".
4324
4325
4326
    layer_number: int, default = `None`
                 layer number of the current `DotProductAttention` when multiple such modules
                 are concatenated, for instance in consecutive transformer blocks.
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
    qkv_format: str, default = `sbhd`
               dimension format for `query_layer`, `key_layer` and `value_layer`,
               {`sbhd`, `bshd`, `thd`}. `s` stands for the sequence length, `b` batch size,
               `h` the number of heads, `d` head size, and `t` the total number of sequences
               in a batch, with `t = sum(s_i), for i = 0...b-1`. `sbhd` and `bshd` formats
               are used for when sequences in a batch are of equal length or padded to
               equal length, and the `thd` format is used for when sequences in a batch
               have different lengths. Please note that these formats do not reflect how
               tensors `query_layer`, `key_layer`, `value_layer` are laid out in memory.
               For that, please use `_get_qkv_layout` to gain the layout information.
4337
4338
4339
    softmax_scale: Optional[float], default = `None`
                softmax scale for the attention scores. If `None`, defaults to
                `1.0 / math.sqrt(kv_channels)`.
4340
4341
4342
4343
4344
4345
4346
4347
4348

    Parallelism parameters
    ----------------------
    sequence_parallel : bool, default = `False`
                       if set to `True`, uses sequence parallelism.
    tp_size : int, default = 1
             tensor parallel world size.
    tp_group : ProcessGroup, default = `None`
              tensor parallel process group.
4349
4350
4351
4352
4353
4354
4355
4356
4357
    cp_group : ProcessGroup, default = `None`
              context parallel process group.
    cp_global_ranks : list of global rank IDs, default = `None`
                     global rank IDs of GPUs that are in cp_group.
    cp_stream : CUDA stream, default = `None`
               context parallelism splits flash attention into multiple steps for
               compute and communication overlapping. To address the wave quantization
               issue of each split step, we add an additional CUDA stream so that we
               can overlap two flash attention kernels.
4358
4359
4360
4361
4362
4363
    """

    def __init__(
        self,
        num_attention_heads: int,
        kv_channels: int,
4364
        num_gqa_groups: Optional[int] = None,
4365
        attention_dropout: float = 0.0,
4366
        qkv_format: str = "sbhd",
4367
        attn_mask_type: str = "causal",
4368
        window_size: Optional[Tuple[int, int]] = None,
4369
4370
4371
4372
4373
        sequence_parallel: bool = False,
        tp_size: int = 1,
        get_rng_state_tracker: Optional[Callable] = None,
        tp_group: Optional[dist_group_type] = None,
        layer_number: Optional[int] = None,
4374
        attention_type: str = "self",
4375
        cp_group: Optional[dist_group_type] = None,
4376
        cp_global_ranks: List[int] = None,
4377
        cp_stream: torch.cuda.Stream = None,
4378
        softmax_scale: Optional[float] = None,
4379
4380
4381
    ) -> None:
        super().__init__()

4382
        self.logger = logging.getLogger("DotProductAttention")
4383
        self.qkv_format = qkv_format
4384
        attn_mask_type = attn_mask_type.replace(",", "_")
4385
4386
        if attn_mask_type == "causal_padding":
            attn_mask_type = "padding_causal"
4387
        self.attn_mask_type = attn_mask_type
4388
4389
        self.window_size = window_size
        self.window_size = check_set_window_size(attn_mask_type, self.window_size)
4390
4391
4392
4393
4394
4395
4396
        if tp_group is None:
            self.tp_size = tp_size
            if tp_size == 1:
                self.set_tensor_parallel_group(tp_group)
        else:
            self.tp_size = get_distributed_world_size(tp_group)
            self.set_tensor_parallel_group(tp_group)
4397
        self.get_rng_state_tracker = get_rng_state_tracker
4398
        self.num_attention_heads = num_attention_heads
4399
        self.layer_number = 1 if layer_number is None else layer_number
4400
4401
4402
        self.cp_group = cp_group
        self.cp_global_ranks = cp_global_ranks
        self.cp_stream = cp_stream
4403

4404
        self.hidden_size_per_attention_head = kv_channels
4405

4406
        self.num_gqa_groups = num_attention_heads if num_gqa_groups is None else num_gqa_groups
4407
4408
        self.num_gqa_groups_per_partition = int(self.num_gqa_groups // tp_size)

4409
4410
4411
        assert (
            num_attention_heads % self.num_gqa_groups == 0
        ), "The number of attention heads must be divisible by the number of GQA groups!"
4412

4413
        self.rng_states_tracker = None
4414
4415
4416
        if sequence_parallel or get_rng_state_tracker is None:
            attention_dropout_ctx = nullcontext
        else:
4417
4418
4419
            self.rng_states_tracker = get_rng_state_tracker()
            set_all_rng_states(self.rng_states_tracker.get_states())
            attention_dropout_ctx = self.rng_states_tracker.fork
4420

4421
4422
        if softmax_scale is None:
            softmax_scale = 1.0 / math.sqrt(kv_channels)
4423
4424

        self.device_compute_capability = get_device_compute_capability()
4425
4426
4427
        self.deterministic = (
            not bool(int(os.getenv("NVTE_ALLOW_NONDETERMINISTIC_ALGO", "1")))
            or torch.are_deterministic_algorithms_enabled()
4428
        )
4429
4430
4431
4432

        self.use_flash_attention = int(
            os.getenv("NVTE_FLASH_ATTN", "1")
        ) and self.device_compute_capability >= (8, 0)
4433
4434
4435
4436
4437
        if int(os.getenv("NVTE_FLASH_ATTN", "1")) == 0:
            self.logger.debug("Disabling FlashAttention due to NVTE_FLASH_ATTN=0")
        if self.device_compute_capability < (8, 0):
            self.logger.debug("Disabling FlashAttention for compute capability < sm80")

4438
        if not _flash_attn_2_4_1_plus and self.deterministic:
4439
            self.use_flash_attention = False
4440
            self.logger.warning(
4441
4442
4443
                "Disabling usage of FlashAttention since version <2.4.1 does not support "
                "deterministic execution. In order to use FA with deterministic behavior,"
                " please install FlashAttention version >=2.4.1."
4444
4445
            )

4446
4447
4448
        self.use_fused_attention = int(
            os.getenv("NVTE_FUSED_ATTN", "1")
        ) and self.device_compute_capability >= (8, 0)
4449
4450
4451
4452
        if int(os.getenv("NVTE_FUSED_ATTN", "1")) == 0:
            self.logger.debug("Disabling FusedAttention due to NVTE_FUSED_ATTN=0")
        if self.device_compute_capability < (8, 0):
            self.logger.debug("Disabling FusedAttention for compute capability < sm80")
4453

4454
        assert attention_type in AttnTypes, f"attention_type {attention_type} not supported"
4455
4456
4457
4458

        self.attention_type = attention_type
        self.attention_dropout = attention_dropout

4459
4460
4461
4462
4463
4464
        attn_kwargs = {
            "attention_dropout": attention_dropout,
            "attention_dropout_ctx": attention_dropout_ctx,
        }

        if self.use_flash_attention:
4465
4466
4467
4468
4469
4470
4471
            self.flash_attention = FlashAttention(
                softmax_scale,
                attention_type=attention_type,
                layer_number=layer_number,
                deterministic=self.deterministic,
                **attn_kwargs,
            )
4472

4473
        # Instantiating three types since use of flash-attn and FusedAttention
4474
        # might be ruled out due to forward inputs.
4475
        if self.use_fused_attention:
4476
4477
4478
4479
4480
4481
4482
            self.fused_attention = FusedAttention(
                softmax_scale,
                attention_type=attention_type,
                layer_number=layer_number,
                deterministic=self.deterministic,
                **attn_kwargs,
            )
4483

4484
        self.unfused_attention = UnfusedDotProductAttention(
4485
4486
            softmax_scale, **attn_kwargs, layer_number=layer_number
        )
4487

4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
        def remove_extra_states_check(self, incompatible_keys):  # pylint: disable=unused-argument
            """
            Temporarily remove core_attention._extra_state as a missing key
            when loading older TransformerEngine checkpoints. Will phase out
            this hook in TransformerEngine 2.0.
            """
            for key in incompatible_keys.missing_keys:
                if "core_attention._extra_state" in key:
                    incompatible_keys.missing_keys.remove(key)

        self.register_load_state_dict_post_hook(remove_extra_states_check)

4500
4501
4502
4503
    def _checkpointed_attention_forward(
        self,
        attention_func: Callable,
        *forward_args: Tuple[torch.Tensor, ...],
4504
        **forward_kwargs: Dict[str, Any],
4505
4506
4507
    ) -> torch.Tensor:
        """Forward method with activation checkpointing."""

4508
4509
        def custom_forward(*input_args, **input_kwargs):
            return attention_func(*input_args, **input_kwargs)
4510
4511
4512

        hidden_states = checkpoint(
            custom_forward,
4513
4514
4515
            distribute_saved_activations=False,
            get_rng_state_tracker=self.get_rng_state_tracker,
            tp_group=self.tp_group,
4516
            *forward_args,
4517
            **forward_kwargs,
4518
4519
4520
4521
        )

        return hidden_states

4522
4523
4524
4525
4526
4527
    def set_context_parallel_group(
        self,
        cp_group: Union[dist_group_type, None],
        cp_global_ranks: List[int],
        cp_stream: torch.cuda.Stream,
    ) -> None:
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
        """
        Set the context parallel attributes for the given
        module before executing the forward pass.

        Parameters
        ----------
        cp_group : ProcessGroup
                  context parallel process group.
        cp_global_ranks : List[int]
                         list of global ranks in the context group.
        cp_stream : torch.cuda.Stream
                   cuda stream for context parallel execution.
        """
4541
4542
4543
4544
        self.cp_group = cp_group
        self.cp_global_ranks = cp_global_ranks
        self.cp_stream = cp_stream

4545
    @no_torch_dynamo(recursive=False)
4546
4547
4548
4549
4550
    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
4551
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
4552
4553
4554
        qkv_format: Optional[str] = None,
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
4555
4556
        cu_seqlens_q_padded: Optional[torch.Tensor] = None,
        cu_seqlens_kv_padded: Optional[torch.Tensor] = None,
4557
4558
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
4559
        attn_mask_type: Optional[str] = None,
4560
        window_size: Optional[Tuple[int, int]] = None,
4561
        checkpoint_core_attention: bool = False,
4562
4563
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
4564
        alibi_slopes: Optional[torch.Tensor] = None,
4565
        fast_zero_fill: bool = True,
4566
        inference_params: Optional[InferenceParams] = None,
4567
        is_first_microbatch: Optional[bool] = None,
4568
4569
4570
4571
4572
4573
    ) -> torch.Tensor:
        """
        Dot Product Attention Layer.

        .. note::

4574
4575
            Argument :attr:`attention_mask` is only used when :attr:`attn_mask_type`
            includes '"padding"' or `"arbitrary"`.
4576
4577
4578

        .. note::

4579
4580
4581
            Input tensor :attr:`query_layer` must be of shape
            (:attr:`sequence_length`, :attr:`batch_size`, :attr:`num_attention_heads`,
            :attr:`kv_channels`) and the tensors :attr:`key_layer` and :attr:`value_layer`
4582
            must each be of shape (:attr:`sequence_length`, :attr:`batch_size`,
4583
            :attr:`num_gqa_groups`, :attr:`kv_channels`). Output of shape
4584
4585
4586
            (:attr:`sequence_length`, :attr:`batch_size`, :attr:`num_attention_heads`
            * :attr:`kv_channels`) is returned.

4587
4588
        .. note::

4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
            DotProductAttention supports three backends: 1) FlashAttention which calls
            HazyResearch/Dao-AILab's `flash-attn <https://arxiv.org/pdf/2305.13245.pdf>`_
            PyTorch API, 2) FusedAttention which has multiple fused attention implementations
            based on `cuDNN Graph API
            <https://docs.nvidia.com/deeplearning/cudnn/developer-guide/index.html#op-fusion>`_
            (see :attr:`FusedAttention` for more details on FusedAttention backends), and 3)
            UnfusedDotProductAttention which is the native PyTorch implementation
            with fused scaled masked softmax.

        .. note::

            Users can use environment variables :attr:`NVTE_FLASH_ATTN`, :attr:`NVTE_FUSED_ATTN`,
            and :attr:`NVTE_FUSED_ATTN_BACKEND` to control which DotProductAttention backend,
            and FusedAttention backend if applicable, to use. TransformerEngine prioritizes
            FlashAttention over FusedAttention and over UnfusedDotProductAttention.
            If FusedAttention is being used, users can also choose to switch to flash-attn's
            implementation for backward by setting :attr:`NVTE_FUSED_ATTN_USE_FAv2_BWD=1`
            (default: 0), because of the performance differences between various versions of
4607
4608
4609
4610
4611
            flash-attn and FusedAttention. Further, :attr:`NVTE_FUSED_ATTN_FORCE_WORKSPACE_OPT`
            can be used to enable (:attr:`1`) or disable (:attr:`0`) the workspace related
            optimizations in FusedAttention. When unset, TransformerEngine determines the code path
            based on its internal logic. These optimizations trade memory for performance
            and should be used with care.
4612

4613
4614
4615
4616
4617
4618
4619
4620
        Parameters
        ----------
        query_layer : torch.Tensor
                     Query tensor.
        key_layer : torch.Tensor
                   Key tensor.
        value_layer : torch.Tensor
                     Value tensor.
4621
4622
4623
4624
4625
4626
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]],
             default = `None`. Boolean tensor(s) used to mask out attention softmax input.
             It should be 'None' for 'causal' and 'no_mask' types. For 'padding' masks, it should be
             a single tensor of [batch_size, 1, 1, seqlen_q] for self-attention, and a tuple of
             two tensors in shapes [batch_size, 1, 1, seqlen_q] and [batch_size, 1, 1, seqlen_kv]
             for cross-attention. For the 'arbitrary' mask type, it should be in a shape that is
4627
4628
4629
             broadcastable to [batch_size, num_heads, max_seqlen_q, max_seqlen_kv]. A `True` value
             means the corresponding position is masked out and a `False` means that position is
             allowed to participate in attention.
4630
4631
4632
        qkv_format: str, default = `None`
                   If provided, overrides :attr:`qkv_format` from initialization.
        cu_seqlens_q: Optional[torch.Tensor], default = `None`
4633
                   Cumulative sum of sequence lengths (without offset) in a batch for `query_layer`,
4634
4635
                   with shape [batch_size + 1] and dtype torch.int32.
        cu_seqlens_kv: Optional[torch.Tensor], default = `None`
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
                   Cumulative sum of sequence lengths (without offset) in a batch for `key_layer`
                   and `value_layer`, with shape [batch_size + 1] and dtype torch.int32.
        cu_seqlens_q_padded: Optional[torch.Tensor], default = `None`
                   Cumulative sum of sequence lengths (with offset) in a batch for
                   `query_layer`, with shape [batch_size + 1] and dtype torch.int32.
                   When there is no padding between sequences in a batch,
                   `cu_seqlens_q_padded = cu_seqlens_q`.
        cu_seqlens_kv_padded: Optional[torch.Tensor], default = `None`
                   Cumulative sum of sequence lengths (with offset) in a batch for `key_layer`
                   and `value_layer`, with shape [batch_size + 1] and dtype torch.int32.
                   When there is no padding between sequences in a batch,
                   `cu_seqlens_kv_padded = cu_seqlens_kv`.
4648
4649
4650
4651
4652
4653
        max_seqlen_q: Optional[int], default = `None`
                      Maximum sequence length in `query_layer`.
                      Calculated from `cu_seqlens_q` if not provided.
        max_seqlen_kv: Optional[int], default = `None`
                       Maximum sequence length in `key_layer` and `value_layer`.
                       Calculated from `cu_seqlens_kv` if not provided.
4654
4655
4656
        attn_mask_type: {`no_mask`, `padding`, `causal`, `padding,causal`, `causal,padding`,
                       `arbitrary`}, default = `None`. Type of attention mask passed into
                       softmax operation. 'padding,causal' and 'causal,padding' are equivalent.
4657
        window_size: Optional[Tuple[int, int]], default = `None`
4658
                    Sliding window size for local attention.
4659
4660
4661
4662
4663
        checkpoint_core_attention : bool, default = `False`
                                   If true, forward activations for attention are recomputed
                                   during the backward pass in order to save memory that would
                                   otherwise be occupied to store the forward activations until
                                   backprop.
4664
        core_attention_bias_type: str, default = `no_bias`
4665
                    Bias type, {`no_bias`, `pre_scale_bias`, `post_scale_bias`, `alibi`}
4666
        core_attention_bias: Optional[torch.Tensor], default = `None`
4667
4668
                    Bias tensor for Q * K.T, shape [1, num_head, max_seqlen_q, max_seqlen_kv].
                    It should be 'None' for 'no_bias' and 'alibi' bias types.
4669
4670
4671
4672
        alibi_slopes: Optional[torch.Tensor], default = `None`
                     ALiBi slopes in FP32 and shape [nheads] or [batch_size, nheads].
                     It adds a bias of (-alibi_slope * (i + seqlen_k - seqlen_q - j))
                     to the attention score of query i and key j.
4673
        fast_zero_fill: bool, default = `True`
4674
                    Whether to use the fast path to set output tensors to 0 or not.
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
        inference_params: Optional[InferenceParams], default = `None`
            Optimizes execution performance during inference by caching Keys and Values of the
            current decoding iteration. These cached values are appended to the K and V values
            computed in previous iterations, eliminating the need to recalculate them for the
            entire sequence.
            Initialization of `inference_params` is required prior to use to ensure sufficient
            memory allocation.
            Adjustments of the sequence_len_offset should be done after a complete forward pass.
            If rotary positional embeddings (RoPE) are utilized, they must be prepared beforehand.
            Supports "sbhd" and "bshd" layouts, with the "sbhd" layout being more efficient.
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
        is_first_microbatch : {True, False, None}, default = None
                             During training using either gradient accumulation or
                             pipeline parallelism a minibatch of data is further split
                             into microbatches. Between the microbatches of the same minibatch
                             the model weights are not updated. Setting this parameter indicates
                             whether the current microbatch is the first in a minibatch or not.
                             When set, this parameter enables additional optimizations:

                             * during FP8 training, it allows caching of the FP8 versions of
                               the weights
                             * it also allows skipping gradient accumulation during the
                               first microbatch (since it is the first gradient being
                               produced)
4698
        """
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
        with self.prepare_forward(
            query_layer,
            is_first_microbatch,
            num_gemms=3,
            allow_non_contiguous=True,
        ) as query_layer:

            if self.fp8:
                forced_fp8_dpa = ""
                if self.fp8_meta["recipe"].fp8_mha:
                    if not self.fp8_meta["recipe"].fp8_dpa:
                        self.fp8_meta["recipe"].fp8_dpa = True
                        forced_fp8_dpa = " (forced)"

            if self.fp8 and self.fp8_meta["recipe"].fp8_dpa:
                forward_dtype = get_fp8_te_dtype(self.fp8_meta["recipe"], fprop_tensor=True)
                backward_dtype = get_fp8_te_dtype(self.fp8_meta["recipe"], fprop_tensor=False)
                assert forward_dtype in [
                    tex.DType.kFloat8E4M3,
                    tex.DType.kFloat8E5M2,
                ] and backward_dtype in [
                    tex.DType.kFloat8E4M3,
                    tex.DType.kFloat8E5M2,
                ], """DotProductAttention only supports "E4M3" and "E5M2" FP8 data types."""
4723

4724
4725
4726
            assert (
                query_layer.is_cuda and key_layer.is_cuda and value_layer.is_cuda
            ), "DotProductAttention only supports CUDA tensors."
4727

4728
            assert key_layer.shape == value_layer.shape, "Keys and values must have the same shape!"
4729

4730
4731
4732
4733
4734
4735
4736
4737
            if attn_mask_type is not None:
                window_size = check_set_window_size(attn_mask_type, window_size)
            if attn_mask_type is None:
                attn_mask_type = self.attn_mask_type
            else:
                attn_mask_type = attn_mask_type.replace(",", "_")
                if attn_mask_type == "causal_padding":
                    attn_mask_type = "padding_causal"
4738

4739
            assert (
4740
4741
4742
4743
4744
4745
                attn_mask_type in AttnMaskTypes
            ), f"Attention mask type {attn_mask_type} is not supported!"
            if qkv_format == "thd":
                assert (
                    "padding" in attn_mask_type
                ), "Attention mask type must be padding or padding_causal for qkv_format=thd!"
4746

4747
4748
4749
4750
4751
4752
4753
            if self.rng_states_tracker is not None and is_graph_capturing():
                assert isinstance(
                    self.rng_states_tracker, CudaRNGStatesTracker
                ), "Unsupported RNG states tracker."
                assert (
                    graph_safe_rng_available()
                ), "Upgrade PyTorch version to get RNG manipulation support for cuda graph capture."
4754

4755
4756
            if window_size is None:
                window_size = self.window_size
4757

4758
4759
            if qkv_format is None:
                qkv_format = self.qkv_format
4760

4761
4762
            if inference_params is not None:
                assert self.layer_number is not None, "Layer number must be set!"
4763

4764
4765
4766
                if qkv_format == "bshd":
                    key_layer = key_layer.transpose(0, 1)
                    value_layer = value_layer.transpose(0, 1)
4767

4768
4769
4770
4771
                (
                    inference_key_memory,
                    inference_value_memory,
                ) = inference_params.key_value_memory_dict[self.layer_number]
4772

4773
4774
4775
                batch_start = inference_params.batch_size_offset
                batch_end = batch_start + key_layer.size(1)
                assert batch_end <= inference_key_memory.size(1)
4776

4777
4778
4779
                sequence_start = inference_params.sequence_len_offset
                sequence_end = sequence_start + key_layer.size(0)
                assert sequence_end <= inference_key_memory.size(0)
4780

4781
4782
4783
4784
4785
4786
4787
4788
4789
                # Copy keys and values into KV-cache
                inference_key_memory[sequence_start:sequence_end, batch_start:batch_end, ...] = (
                    key_layer
                )
                inference_value_memory[sequence_start:sequence_end, batch_start:batch_end, ...] = (
                    value_layer
                )
                key_layer = inference_key_memory[:sequence_end, batch_start:batch_end, ...]
                value_layer = inference_value_memory[:sequence_end, batch_start:batch_end, ...]
4790

4791
4792
4793
                if qkv_format == "bshd":
                    key_layer = key_layer.transpose(0, 1)
                    value_layer = value_layer.transpose(0, 1)
4794

4795
4796
                key_layer = key_layer.contiguous()
                value_layer = value_layer.contiguous()
4797
4798

            assert (
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
                key_layer.shape[-2] == self.num_gqa_groups_per_partition
                and value_layer.shape[-2] == self.num_gqa_groups_per_partition
            ), f"Keys and values must have num_gqa_group = {self.num_gqa_groups} heads!"
            assert qkv_format in [
                "sbhd",
                "bshd",
                "thd",
            ], "DotProductAttention only supports qkv_format = {'sbhd', 'bshd', 'thd'}!"

            if qkv_format == "thd":
4809
                assert all(
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
                    len(x.shape) == 3 for x in (query_layer, key_layer, value_layer)
                ), "Queries, keys and values must be 3D tensors when qkv_format = thd!"
                assert (
                    cu_seqlens_q is not None and cu_seqlens_kv is not None
                ), "cu_seqlens_q and cu_seqlens_kv can not be None when qkv_format = thd!"
                assert (
                    cu_seqlens_q.shape == cu_seqlens_kv.shape
                    and len(cu_seqlens_q.shape) == 1
                    and len(cu_seqlens_kv.shape) == 1
                ), "cu_seqlens_q and cu_seqlens_q must both have shape [batch_size + 1]!"
                assert (
                    cu_seqlens_q.dtype == torch.int32 and cu_seqlens_kv.dtype == torch.int32
                ), "cu_seqlens_q and cu_seqlens_q must both be in dtype torch.int32!"
                if max_seqlen_q is None:
                    seqlens_q = cu_seqlens_q[1:] - cu_seqlens_q[:-1]
                    max_seqlen_q = pow(2, math.ceil(math.log2(seqlens_q.max().item())))
                if max_seqlen_kv is None:
                    seqlens_kv = cu_seqlens_kv[1:] - cu_seqlens_kv[:-1]
                    max_seqlen_kv = pow(2, math.ceil(math.log2(seqlens_kv.max().item())))

            if qkv_format in ["sbhd", "bshd"]:
4831
                assert all(
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
                    len(x.shape) == 4 for x in (query_layer, key_layer, value_layer)
                ), f"Queries, keys and values must be 4D tensors when qkv_format = {qkv_format}!"
                if qkv_format == "sbhd":
                    max_seqlen_q, max_seqlen_kv = (query_layer.shape[0], key_layer.shape[0])
                if qkv_format == "bshd":
                    max_seqlen_q, max_seqlen_kv = (query_layer.shape[1], key_layer.shape[1])
                if cu_seqlens_q is not None:
                    seqlens_q = cu_seqlens_q[1:] - cu_seqlens_q[:-1]
                    assert all(
                        seqlens_q <= max_seqlen_q
                    ), """Sequence lengths indicated by cu_seqlens_q must be no greater than
                        the sequence dimention in 'query_layer'!"""
                if cu_seqlens_kv is not None:
                    seqlens_kv = cu_seqlens_kv[1:] - cu_seqlens_kv[:-1]
                    assert all(
                        seqlens_kv <= max_seqlen_kv
                    ), """Sequence lengths indicated by cu_seqlens_kv must be no greater than
                        the sequence dimention in 'key_layer' and 'value_layer'!"""
4850

4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
            if (
                isinstance(query_layer, Float8Tensor)
                and isinstance(key_layer, Float8Tensor)
                and isinstance(value_layer, Float8Tensor)
            ):
                qkv_layout, query_layer._data, key_layer._data, value_layer._data = _get_qkv_layout(
                    query_layer._data, key_layer._data, value_layer._data, qkv_format=qkv_format
                )
            else:
                qkv_layout, query_layer, key_layer, value_layer = _get_qkv_layout(
                    query_layer, key_layer, value_layer, qkv_format=qkv_format
                )
4863

4864
4865
4866
4867
4868
            # The priority for attention backends (subject to availability and clearing the filters)
            # is: FlashAttention > FusedAttention (cuDNN) > UnfusedDotProductAttention.
            use_flash_attention = self.use_flash_attention
            use_fused_attention = self.use_fused_attention
            use_unfused_attention = True
4869

4870
4871
            # The following section filters out some backends based on
            # certain asserts before executing the forward pass.
4872

4873
            # Filter: QKV layout.
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
            if qkv_format == "thd":
                if use_unfused_attention:
                    self.logger.debug("Disabling UnusedDotProductAttention for qkv_format = thd")
                    use_unfused_attention = False
                if use_fused_attention and (
                    (
                        cu_seqlens_q_padded is not None
                        and torch.equal(cu_seqlens_q_padded, cu_seqlens_q)
                    )
                    or (
                        cu_seqlens_kv_padded is not None
                        and torch.equal(cu_seqlens_kv_padded, cu_seqlens_kv)
                    )
                ):
                    self.logger.debug(
                        "Disabling FlashAttention for qkv_format = thd "
                        "when there is padding between sequences."
                    )
                    use_flash_attention = False
4893

4894
4895
            # Filter: ONNX export.
            if is_in_onnx_export_mode():
4896
                if use_flash_attention:
4897
                    self.logger.debug("Disabling FlashAttention for ONNX mode")
4898
                use_flash_attention = False
4899
4900
4901
                if use_fused_attention:
                    self.logger.debug("Disabling FusedAttention for ONNX mode")
                use_fused_attention = False
4902

4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
            # Filter: Input type.
            if use_flash_attention and (
                query_layer.dtype not in [torch.bfloat16, torch.float16]
                or key_layer.dtype not in [torch.bfloat16, torch.float16]
                or value_layer.dtype not in [torch.bfloat16, torch.float16]
                or any(isinstance(x, Float8Tensor) for x in [query_layer, key_layer, value_layer])
            ):
                self.logger.debug(
                    "Disabling FlashAttention due to unsupported QKV data types. "
                    "Supported: [torch.bfloat16, torch.float16]. "
                    "Found: query_layer.dtype=%s, key_layer.dtype=%s, value_layer.dtype=%s.",
                    query_layer.dtype,
                    key_layer.dtype,
                    value_layer.dtype,
                )
                use_flash_attention = False
            if use_fused_attention and (
                query_layer.dtype not in [torch.bfloat16, torch.float16]
                or key_layer.dtype not in [torch.bfloat16, torch.float16]
                or value_layer.dtype not in [torch.bfloat16, torch.float16]
            ):
                self.logger.debug(
                    "Disabling FusedAttention due to unsupported QKV data types. "
                    "Supported: [torch.bfloat16, torch.float16, Float8Tensor]. "
                    "Found: query_layer.dtype=%s, key_layer.dtype=%s, value_layer.dtype=%s.",
                    query_layer.dtype,
                    key_layer.dtype,
                    value_layer.dtype,
                )
                use_fused_attention = False
4933

4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
            # Filter: Execution type.
            if use_flash_attention and self.fp8 and self.fp8_meta["recipe"].fp8_dpa:
                self.logger.debug("Disabling FlashAttention as it does not support FP8 execution.")
                use_flash_attention = False
            if use_unfused_attention and self.fp8 and self.fp8_meta["recipe"].fp8_dpa:
                self.logger.debug(
                    "Disabling UnfusedDotProductAttention as it does not support FP8 execution."
                )
                use_unfused_attention = False

            # Filter: Device and dimensions.
            # FAv2 supports head_dim <= 256, and for >192 requires sm80/sm90
            # FAv2 requires head_dim % 8 == 0
            if use_flash_attention and (
                query_layer.shape[-1] > 256
                or query_layer.shape[-1] % 8 != 0
                or (
                    query_layer.shape[-1] > 192
                    and self.device_compute_capability not in ((8, 0), (9, 0))
                )
            ):
                self.logger.debug(
                    "Disabling FlashAttention due to unsupported head_dim. "
                    "Supported: %%8 == 0, and <= 256; sm80/90 for >192. "
                    "Found: query_layer.shape[-1]=%s, key_layer.shape[-1]=%s, sm=%s",
                    query_layer.shape[-1],
                    key_layer.shape[-1],
                    ".".join([str(i) for i in self.device_compute_capability]),
                )
                use_flash_attention = False
4964

4965
4966
            # Filter: cross attention + causal mask.
            # (in training mode)
4967
            if (
4968
4969
4970
4971
4972
                use_flash_attention
                and inference_params is None
                and _flash_attn_2_1_plus
                and "causal" in attn_mask_type
                and max_seqlen_q != max_seqlen_kv
4973
            ):
4974
4975
4976
4977
4978
4979
                self.logger.warning(
                    "In training mode, disable the use of FlashAttention since version 2.1+ has "
                    "changed its behavior for causal mask in cross attention. See "
                    "https://github.com/Dao-AILab/flash-attention#21-change-behavior-of-causal-flag"
                )
                use_flash_attention = False
4980

4981
4982
            context_parallel = (
                self.cp_group is not None and get_distributed_world_size(self.cp_group) != 1
4983
            )
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013

            # Filter: sliding window attention.
            # UnfusedDotProductAttention can support SWA via arbitrary attention mask.
            if window_size not in ((-1, -1), (-1, 0)):
                if use_fused_attention:
                    self.logger.debug("Disabling FusedAttention for SWA")
                use_fused_attention = False
                if (not _flash_attn_2_3_plus) or context_parallel:
                    if use_flash_attention:
                        self.logger.debug(
                            "Disabling FusedAttention as it requires flash-attn 2.3+ "
                            "and no context parallelism"
                        )
                    use_flash_attention = False

            # Filter: Attention mask type.
            #   attn_mask_type(s)    |     supported backends
            # ------------------------------------------------
            #   no_mask              |     All
            #   padding              |     UnfusedDotProductAttention, FlashAttention, FusedAttention
            #   causal               |     All
            #   padding + causal     |     FlashAttention, FusedAttention
            #   arbitrary            |     UnfusedDotProductAttention
            #
            if attn_mask_type == "arbitrary":
                if use_flash_attention:
                    self.logger.debug("Disabling FlashAttention for arbitrary mask")
                use_flash_attention = False
                if use_fused_attention:
                    self.logger.debug("Disabling FusedAttention for arbitrary mask")
5014
5015
                use_fused_attention = False

5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
            if (
                use_unfused_attention
                and inference_params is None
                and "causal" in attn_mask_type
                and max_seqlen_q != max_seqlen_kv
            ):
                self.logger.debug("Disabling UnusedDotProductAttention for qkv_format = thd")
                use_unfused_attention = False

            # Filter: bias.
            global _alibi_cache
            if alibi_slopes is not None:
                assert (
                    core_attention_bias_type == "alibi"
                ), "core_attention_bias_type must be alibi in order to use alibi_slopes!"
                if self.layer_number == 1:
                    _alibi_cache["_alibi_slopes_require_update"] = True
                    _alibi_cache["_alibi_bias_require_update"] = True
            if core_attention_bias_type == "alibi":
                assert (
                    core_attention_bias is None
                ), "core_attention_bias must be None when core_attention_bias_type is alibi!"
                if (
                    _alibi_cache["_num_heads"] != query_layer.shape[-2]
                    or _alibi_cache["_max_seqlen_q"] != max_seqlen_q
                    or _alibi_cache["_max_seqlen_kv"] != max_seqlen_kv
                    or _alibi_cache["_alibi_slopes"] is None
                ):
                    _alibi_cache["_alibi_slopes_require_update"] = True
                    _alibi_cache["_alibi_bias_require_update"] = True

            if use_flash_attention and (
                core_attention_bias_type not in ["no_bias", "alibi"]
                or core_attention_bias is not None
            ):
                self.logger.debug("Disabling FlashAttention for pre/post_scale_bias")
                use_flash_attention = False

            fu_core_attention_bias_type = core_attention_bias_type
            fu_core_attention_bias = core_attention_bias
            if (
                core_attention_bias_type == "alibi"
                and use_fused_attention
                and alibi_slopes is not None
            ):
                fu_core_attention_bias_type = "post_scale_bias"
                _, fu_core_attention_bias = get_alibi(
                    query_layer.shape[-2],
                    max_seqlen_q,
                    max_seqlen_kv,
                    alibi_slopes=alibi_slopes,
                    bias_dtype=query_layer.dtype,
5068
5069
                )
            if (
5070
                use_fused_attention
5071
                and fu_core_attention_bias_type == "post_scale_bias"
5072
5073
5074
5075
5076
                and (
                    fu_core_attention_bias.shape[0] != 1
                    or fu_core_attention_bias.shape[1] != query_layer.shape[-2]
                )
            ):
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
                if fu_core_attention_bias.requires_grad:
                    # remove this line when cuDNN adds bwd support for
                    # [1, 1, s, s], [b, 1, s, s] and [b, h, s, s]
                    self.logger.debug("Disabling FusedAttention for dBias in [1, H, S, S] shape")
                    use_fused_attention = False
                else:
                    # max512 backend will only support [1, h, s, s]
                    os.environ["NVTE_FUSED_ATTN_BACKEND"] = "1"

            if use_fused_attention:
                q_type = TE_DType[query_layer.dtype]
                kv_type = TE_DType[key_layer.dtype]
                if self.fp8 and self.fp8_meta["recipe"].fp8_dpa:
                    if isinstance(query_layer, Float8Tensor) and isinstance(
                        key_layer, Float8Tensor
                    ):
                        q_type = query_layer._fp8_dtype
                        kv_type = value_layer._fp8_dtype
                    else:
                        q_type = forward_dtype
                        kv_type = forward_dtype
                fused_attention_backend = tex.get_fused_attn_backend(
                    q_type,
                    kv_type,
                    QKVLayout[qkv_layout],
                    AttnBiasType[fu_core_attention_bias_type],
                    AttnMaskType[attn_mask_type],
                    self.attention_dropout,
                    query_layer.shape[-2],  # num_attn_heads
                    key_layer.shape[-2],  # num_gqa_groups
                    max_seqlen_q,
                    max_seqlen_kv,
                    query_layer.shape[-1],  # head_dim
                )
                # DPA does not support FP8; for FP8, use cpp_extensions modules directly
                is_backend_avail = fused_attention_backend in [
                    FusedAttnBackend["F16_max512_seqlen"],
                    FusedAttnBackend["F16_arbitrary_seqlen"],
                    FusedAttnBackend["FP8"],
                ]
                use_fused_attention = (
                    use_fused_attention
                    and is_backend_avail
                    and (
                        not context_parallel
                        or fused_attention_backend == FusedAttnBackend["F16_arbitrary_seqlen"]
                    )
5124
                )
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
                if (
                    fused_attention_backend == FusedAttnBackend["F16_max512_seqlen"]
                    and fu_core_attention_bias_type == "post_scale_bias"
                    and (
                        fu_core_attention_bias.shape[0] != 1
                        or fu_core_attention_bias.shape[1] != query_layer.shape[-2]
                    )
                ):
                    self.logger.debug(
                        "Disabling FusedAttention as no backend supports the provided input"
                    )
                    use_fused_attention = False

            # Filter: determinism.
            # backend                                  | deterministic
            # ---------------------------------------------------------
            # flash-attn v1                            | yes
            # flash-attn v2                            | no
            # FusedAttnBackend["F16_max512_seqlen"]    | yes
            # FusedAttnBackend["F16_arbitrary_seqlen"] | workspace optimization path: yes; otherwise: no
            # UnfusedDotProductAttention               | yes
            #
            # Note that FusedAttnBackend["F16_arbitrary_seqlen"] only has workspace optimization path
            # on sm90 architectures.
            #
            if (
                use_fused_attention
                and fused_attention_backend == FusedAttnBackend["F16_arbitrary_seqlen"]
                and self.deterministic
                and self.device_compute_capability != (9, 0)
            ):
                self.logger.debug("Disabling FusedAttention for determinism reasons")
5157
                use_fused_attention = False
5158

5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
            # Select FusedAttention on sm90 and FlashAttention on others for performance
            if (
                use_flash_attention
                and use_fused_attention
                and fused_attention_backend == FusedAttnBackend["F16_arbitrary_seqlen"]
            ):
                if self.device_compute_capability == (9, 0):
                    self.logger.debug(
                        "Disabling FlashAttention to give FusedAttention preference on Hopper+ "
                        "for performance reasons"
                    )
                    use_flash_attention = False
5171

5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
            run_config = {
                "compute_capability": "sm"
                + str(
                    (lambda x, y: x * 10 + y)(
                        self.device_compute_capability[0], self.device_compute_capability[1]
                    )
                ),
                "q_dtype": query_layer.dtype,
                "k_dtype": key_layer.dtype,
                "v_dtype": value_layer.dtype,
                "q_shape": list(query_layer.shape),
                "k_shape": list(key_layer.shape),
                "v_shape": list(value_layer.shape),
                "qkv_format": qkv_format,
                "qkv_layout": qkv_layout,
                "mask_type": attn_mask_type,
                "bias_type": core_attention_bias_type,
                "bias_shape": (
                    core_attention_bias.shape if core_attention_bias is not None else None
                ),
                "dropout": self.attention_dropout,
                "context_parallel": context_parallel,
                "is_training": self.training,
                "transformer_engine_version": te.__version__,
                "flash_attn_version": _flash_attn_version,
                "cudnn_version": ".".join([str(i) for i in get_cudnn_version()]),
            }
5199

5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
            if use_flash_attention:
                self.logger.info("Running with FlashAttention backend ")
                self.logger.debug("Running with config=%s", run_config)
                if core_attention_bias_type == "alibi":
                    alibi_slopes, _ = get_alibi(
                        query_layer.shape[-2],
                        max_seqlen_q,
                        max_seqlen_kv,
                        alibi_slopes=alibi_slopes,
                    )
                return self.flash_attention(
                    query_layer,
                    key_layer,
                    value_layer,
                    attention_mask=attention_mask,
                    qkv_layout=qkv_layout,
                    cu_seqlens_q=cu_seqlens_q,
                    cu_seqlens_kv=cu_seqlens_kv,
                    attn_mask_type=attn_mask_type,
                    window_size=window_size,
                    alibi_slopes=alibi_slopes,
                    cp_group=self.cp_group,
                    cp_global_ranks=self.cp_global_ranks,
                    cp_stream=self.cp_stream,
                    max_seqlen_q=max_seqlen_q,
                    max_seqlen_kv=max_seqlen_kv,
5226
                )
5227

5228
5229
5230
5231
            if use_fused_attention:
                self.logger.info(
                    "Running with FusedAttention backend (sub-backend %s)",
                    int(fused_attention_backend),
5232
                )
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
                if self.fp8:
                    self.logger.debug(
                        "Running with fp8_recipe.fp8_mha=%s, "
                        "fp8_recipe.fp8_dpa=%s%s, and NVTE_FP8_DPA_BWD=%s",
                        self.fp8_meta["recipe"].fp8_mha,
                        self.fp8_meta["recipe"].fp8_dpa,
                        forced_fp8_dpa,
                        int(os.getenv("NVTE_FP8_DPA_BWD", "1")),
                    )
                self.logger.debug("Running with config=%s", run_config)
                if checkpoint_core_attention:
                    return self._checkpointed_attention_forward(
                        self.fused_attention,
                        query_layer,
                        key_layer,
                        value_layer,
                        qkv_layout=qkv_layout,
                        cu_seqlens_q=cu_seqlens_q,
                        cu_seqlens_kv=cu_seqlens_kv,
5252
5253
                        cu_seqlens_q_padded=cu_seqlens_q_padded,
                        cu_seqlens_kv_padded=cu_seqlens_kv_padded,
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
                        max_seqlen_q=max_seqlen_q,
                        max_seqlen_kv=max_seqlen_kv,
                        attn_mask_type=attn_mask_type,
                        attention_mask=attention_mask,
                        fused_attention_backend=fused_attention_backend,
                        core_attention_bias_type=fu_core_attention_bias_type,
                        core_attention_bias=fu_core_attention_bias,
                        fast_zero_fill=fast_zero_fill,
                        cp_group=self.cp_group,
                        cp_global_ranks=self.cp_global_ranks,
                        cp_stream=self.cp_stream,
                        fp8=self.fp8 and self.fp8_meta["recipe"].fp8_dpa,
                        fp8_meta=self.fp8_meta,
                    )
                return self.fused_attention(
5269
5270
5271
5272
5273
5274
                    query_layer,
                    key_layer,
                    value_layer,
                    qkv_layout=qkv_layout,
                    cu_seqlens_q=cu_seqlens_q,
                    cu_seqlens_kv=cu_seqlens_kv,
5275
5276
                    cu_seqlens_q_padded=cu_seqlens_q_padded,
                    cu_seqlens_kv_padded=cu_seqlens_kv_padded,
5277
5278
                    max_seqlen_q=max_seqlen_q,
                    max_seqlen_kv=max_seqlen_kv,
5279
5280
5281
                    attn_mask_type=attn_mask_type,
                    attention_mask=attention_mask,
                    fused_attention_backend=fused_attention_backend,
5282
5283
                    core_attention_bias_type=fu_core_attention_bias_type,
                    core_attention_bias=fu_core_attention_bias,
5284
5285
5286
5287
                    fast_zero_fill=fast_zero_fill,
                    cp_group=self.cp_group,
                    cp_global_ranks=self.cp_global_ranks,
                    cp_stream=self.cp_stream,
5288
5289
                    fp8=self.fp8 and self.fp8_meta["recipe"].fp8_dpa,
                    fp8_meta=self.fp8_meta,
5290
                )
5291

5292
5293
5294
            assert (
                not context_parallel
            ), "Context parallelism is only implemented with Flash Attention and Fused Attention!"
5295

5296
            from .cpu_offload import CPUOffloadEnabled
5297

5298
5299
5300
5301
5302
            if CPUOffloadEnabled:
                warnings.warn(
                    "Attention activation Offloading is only implemented"
                    "with Flash Attention and Fused Attention!"
                )
5303

5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
            if use_unfused_attention:
                self.logger.info("Running with UnfusedDotProductAttention backend")
                self.logger.debug("Running with config=%s", run_config)
                if checkpoint_core_attention:
                    return self._checkpointed_attention_forward(
                        self.unfused_attention,
                        query_layer,
                        key_layer,
                        value_layer,
                        qkv_layout=qkv_layout,
                        cu_seqlens_q=cu_seqlens_q,
                        cu_seqlens_kv=cu_seqlens_kv,
                        attn_mask_type=attn_mask_type,
                        attention_mask=attention_mask,
                        core_attention_bias_type=core_attention_bias_type,
                        core_attention_bias=core_attention_bias,
                        alibi_slopes=alibi_slopes,
                    )
                return self.unfused_attention(
5323
5324
5325
                    query_layer,
                    key_layer,
                    value_layer,
5326
5327
5328
5329
5330
5331
5332
5333
5334
                    qkv_layout=qkv_layout,
                    cu_seqlens_q=cu_seqlens_q,
                    cu_seqlens_kv=cu_seqlens_kv,
                    attn_mask_type=attn_mask_type,
                    attention_mask=attention_mask,
                    core_attention_bias_type=core_attention_bias_type,
                    core_attention_bias=core_attention_bias,
                    alibi_slopes=alibi_slopes,
                )
5335

5336
            raise Exception("No dot product attention support for the provided inputs!")
5337
5338


5339
5340
5341
5342
5343
5344
5345
class MultiheadAttention(torch.nn.Module):
    r"""
    Multi-head Attention (MHA), including Query,
    Key, Value and Output projection.

    .. note::

5346
5347
        Argument :attr:`attention_mask` in the `forward` call is only used when
        :attr:`attn_mask_type` includes '"padding"' or `"arbitrary"`.
5348

5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
    Parameters
    ----------
    hidden_size : int
                 size of each input sample.
    num_attention_heads : int
                         number of attention heads in the transformer layer.
    kv_channels: int, default = `None`
                number of key-value channels. defaults to
                :attr:`hidden_size` / :attr:`num_attention_heads` if `None`.
    attention_dropout: float, default = 0.1
                      dropout probability for the dropout op during multi-head attention.
    layernorm_epsilon : float, default = 1e-5
                       a value added to the denominator of layer normalization
                       for numerical stability.
    init_method : Callable, default = `None`
                 used for initializing weights of QKV and FC1 weights in the following way:
                 `init_method(weight)`. When set to `None`, defaults to
                 `torch.nn.init.normal_(mean=0.0, std=0.023)`.
    output_layer_init_method : Callable, default = `None`
                              used for initializing weights of PROJ and FC2 in the following way:
                              `output_layer_init_method(weight)`. When set to `None`, defaults to
                              `torch.nn.init.normal_(mean=0.0, std=0.023)`.
    layer_number: int, default = `None`
                 layer number of the current `TransformerLayer` when multiple such modules are
                 concatenated to form a transformer block.
5374
5375
    attn_mask_type: {'no_mask', 'padding', 'causal', 'padding_causal' 'arbitrary'},
                   default = `causal`
5376
5377
5378
5379
5380
                   type of attention mask passed into softmax operation. Overridden by
                   :attr:`attn_mask_type` in the `forward` method. The forward
                   arg is useful for dynamically changing mask types, e.g. a different
                   mask for training and inference. The init arg is useful for cases
                   involving compilation/tracing, e.g. ONNX export.
5381
5382
5383
5384
5385
5386
    window_size: Optional[Tuple[int, int]], default = `None`
                sliding window size for local attention, where query at position i attends to keys
                in [i + seqlen_k - seqlen_q - window_size[0], i + seqlen_k - seqlen_q
                + window_size[1]] inclusive. Special cases (-1, -1) and (-1, 0) mean no sliding
                window and causal mask specifically. Similar to :attr:`attn_mask_type`, it can
                be overridden by :attr:`window_size` in `forward` as well.
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
    num_gqa_groups : int, default = `None`
                         number of GQA groups in the transformer layer.
                         Grouped Query Attention is described in
                         `this paper <https://arxiv.org/pdf/2305.13245.pdf>`_.
                         This only affects the keys and values, not the querys.
                         GQA-1 is equivalent to Multi-Query Attention
                         (`MQA <https://arxiv.org/pdf/1911.02150.pdf>`_), while GQA-H
                         is equivalent to MHA, i.e. `num_gqa_groups = num_attention_heads`.
    return_layernorm_output : bool, default = `False`
                             if set to `True`, output of layernorm is returned from the forward
                             together with the output of the linear transformation.
                             Example use case: residual connection for transformer module is
                             taken post layernorm.
5400
5401
    input_layernorm: bool, default = `False`
                     if set to `True`, layer normalization to the input is applied.
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
    attention_type: { 'self', 'cross' }, default = 'self'
                   type of attention applied.
    zero_centered_gamma : bool, default = 'False'
                         if set to 'True', gamma parameter in LayerNorm is initialized to 0 and
                         the LayerNorm formula changes to

                         .. math::
                            y = \frac{x - \mathrm{E}[x]}{ \sqrt{\mathrm{Var}[x] + \varepsilon}} *
                            (1 + \gamma) + \beta
    normalization : { 'LayerNorm', 'RMSNorm' }, default = 'LayerNorm'
                   type of normalization applied.
    qkv_weight_interleaved : bool, default = `True`
                            if set to `False`, the QKV weight is interpreted as a concatenation of
                            query, key, and value weights along the `0th` dimension. The default
                            interpretation is that the individual `q`, `k`, and `v` weights for each
                            attention head are interleaved. This parameter is set to `False` when
                            using :attr:`fuse_qkv_params=False`.
    bias : bool, default = `True`
          if set to `False`, the transformer layer will not learn any additive biases.
    device : Union[torch.device, str], default = "cuda"
          The device on which the parameters of the model will allocated. It is the user's
          responsibility to ensure all parameters are moved to the GPU before running the
          forward pass.
5425
5426
5427
5428
5429
5430
5431
5432
    qkv_format: str, default = `sbhd`
            dimension format for `query_layer`, `key_layer` and `value_layer`,
            {`sbhd`, `bshd`}. `s` stands for the sequence length, `b` batch size,
            `h` the number of heads and `d` head size. `sbhd` and `bshd` formats
            are used for when sequences in a batch are of equal length or padded to
            equal length. Please note that these formats do not reflect how
            tensors `query_layer`, `key_layer`, `value_layer` are laid out in memory.
            For that, please use `_get_qkv_layout` to gain the layout information.
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472

    Parallelism parameters
    ----------------------
    set_parallel_mode : bool, default = `False`
                      if set to `True`, QKV and FC1 layers are used as Column Parallel
                      whereas PROJ and FC2 is used as Row Parallel as described
                      `here <https://arxiv.org/pdf/1909.08053.pdf>`_.
    sequence_parallel : bool, default = `False`
                       if set to `True`, uses sequence parallelism.
    tp_group : ProcessGroup, default = `None`
              tensor parallel process group.
    tp_size : int, default = 1
             used as TP (tensor parallel) world size when TP groups are not formed during
             initialization. In this case, users must call the
             `set_tensor_parallel_group(tp_group)` method on the initialized module before the
             forward pass to supply the tensor parallel group needed for tensor and sequence
             parallel collectives.

    Optimization parameters
    -----------------------
    fuse_wgrad_accumulation : bool, default = 'False'
                             if set to `True`, enables fusing of creation and accumulation of
                             the weight gradient. When enabled, it is assumed that the weights
                             have an additional `main_grad` attribute (used instead of the
                             regular `grad`) which is a pre-allocated buffer of the correct
                             size to accumulate gradients in.
    params_dtype : torch.dtype, default = `torch.get_default_dtype()`
                  it controls the type used to allocate the initial parameters. Useful when
                  the model is trained with lower precision and the original FP32 parameters
                  would not fit in GPU memory.
    return_bias : bool, default = `False`
                 when set to `True`, this module will not apply the additive bias itself, but
                 instead return the bias value during the forward pass together with the
                 output of the linear transformation :math:`y = xA^T`. This is useful when
                 the bias addition can be fused to subsequent operations.
    fuse_qkv_params: bool, default = 'False'
                    if set to `True`, `TransformerLayer` module exposes a single fused
                    parameter for query-key-value. This enables optimizations such as QKV
                    fusion without concatentations/splits and also enables the argument
                    `fuse_wgrad_accumulation`.
5473
5474
5475
5476
5477
5478
    """

    def __init__(
        self,
        hidden_size: int,
        num_attention_heads: int,
5479
5480
5481
5482
5483
        kv_channels: Optional[int] = None,
        attention_dropout: float = 0.1,
        layernorm_epsilon: float = 1e-5,
        init_method: Optional[Callable] = None,
        output_layer_init_method: Optional[Callable] = None,
5484
        layer_number: Optional[int] = None,
5485
        attn_mask_type: str = "causal",
5486
        window_size: Optional[Tuple[int, int]] = None,
5487
5488
        tp_group: Optional[dist_group_type] = None,
        tp_size: int = 1,
5489
        num_gqa_groups: Optional[int] = None,
5490
5491
5492
        fuse_wgrad_accumulation: bool = False,
        get_rng_state_tracker: Optional[Callable] = None,
        sequence_parallel: bool = False,
5493
        params_dtype: Optional[torch.dtype] = None,
5494
        return_bias: bool = False,
5495
5496
5497
5498
5499
5500
5501
5502
5503
        return_layernorm_output: bool = False,
        input_layernorm: bool = False,
        attention_type: str = "self",
        set_parallel_mode: bool = False,
        fuse_qkv_params: bool = False,
        zero_centered_gamma: bool = False,
        qkv_weight_interleaved: bool = True,
        ub_bulk_wgrad: bool = False,
        ub_bulk_dgrad: bool = False,
Jaemin Choi's avatar
Jaemin Choi committed
5504
        ub_overlap_rs_dgrad: bool = False,
5505
5506
        ub_overlap_rs: bool = False,
        ub_overlap_ag: bool = False,
5507
        bias: bool = True,
5508
        normalization: str = "LayerNorm",
5509
        device: Union[torch.device, str] = "cuda",
5510
        qkv_format: str = "sbhd",
5511
5512
    ) -> None:
        super().__init__()
5513

5514
        self.qkv_format = qkv_format
5515
        self.attn_mask_type = attn_mask_type
5516
5517
        self.window_size = window_size
        self.window_size = check_set_window_size(attn_mask_type, self.window_size)
5518
        self.layer_number = layer_number
5519
5520
5521
5522
5523
        self.input_layernorm = input_layernorm
        self.attention_type = attention_type
        self.get_rng_state_tracker = get_rng_state_tracker
        self.tp_group = tp_group
        self.return_layernorm_output = return_layernorm_output
5524
        self.params_dtype = torch.get_default_dtype() if params_dtype is None else params_dtype
5525
        self.num_attention_heads = num_attention_heads
5526
5527
5528
5529
5530
5531
5532
5533
        self.return_bias = return_bias

        kv_channels = kv_channels if kv_channels else (hidden_size // num_attention_heads)

        if init_method is None:
            init_method = get_default_init_method()
        if output_layer_init_method is None:
            output_layer_init_method = get_default_init_method()
5534
5535
5536
5537
5538

        if not fuse_qkv_params:
            qkv_weight_interleaved = False
        self.qkv_weight_interleaved = qkv_weight_interleaved

5539
5540
5541
        assert attention_type in AttnTypes, f"attention_type {attention_type} not supported"
        if layer_number is not None:
            assert layer_number > 0, "layer_number must be a positive integer"
5542
5543
5544
5545
5546
5547

        tp_size = tp_size if tp_group is None else get_distributed_world_size(tp_group)
        self.tp_size = tp_size
        self.sequence_parallel = (tp_size > 1) and sequence_parallel

        self.num_attention_heads_per_partition = divide(num_attention_heads, tp_size)
5548
5549
5550
5551
5552
5553
5554
        self.num_gqa_groups = num_attention_heads if num_gqa_groups is None else num_gqa_groups
        assert (
            num_attention_heads % self.num_gqa_groups == 0
        ), "The number of attention heads must be divisible by the number of GQA groups!"
        assert (
            self.num_gqa_groups % tp_size == 0
        ), "The number of GQA groups must be divisible by tensor parallel size!"
5555
        self.num_gqa_groups_per_partition = int(self.num_gqa_groups // tp_size)
5556
5557
5558
5559

        self.hidden_size_per_attention_head = kv_channels
        self.hidden_size_q = self.hidden_size_per_attention_head * num_attention_heads
        self.hidden_size_kv = self.hidden_size_per_attention_head * self.num_gqa_groups
5560
5561
5562
5563
5564
5565
5566

        common_gemm_kwargs = {
            "fuse_wgrad_accumulation": fuse_wgrad_accumulation,
            "tp_group": tp_group,
            "tp_size": tp_size,
            "get_rng_state_tracker": get_rng_state_tracker,
            "sequence_parallel": sequence_parallel,
5567
            "params_dtype": self.params_dtype,
5568
            "device": device,
5569
5570
5571
5572
        }

        qkv_parallel_mode = "column" if set_parallel_mode else None

cyanguwa's avatar
cyanguwa committed
5573
        if self.attention_type == "self":
5574
5575
            parameters_split = None
            if not fuse_qkv_params:
5576
5577
5578
5579
5580
5581
5582
                parameters_split = collections.OrderedDict(
                    [
                        ("query", self.hidden_size_q),
                        ("key", self.hidden_size_kv),
                        ("value", self.hidden_size_kv),
                    ]
                )
5583
5584
5585
            if self.input_layernorm:
                self.layernorm_qkv = LayerNormLinear(
                    hidden_size,
5586
                    self.hidden_size_q + 2 * self.hidden_size_kv,
5587
5588
5589
5590
5591
5592
                    eps=layernorm_epsilon,
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
                    return_layernorm_output=return_layernorm_output,
cyanguwa's avatar
cyanguwa committed
5593
                    parameters_split=parameters_split,
5594
5595
5596
                    zero_centered_gamma=zero_centered_gamma,
                    ub_bulk_wgrad=ub_bulk_wgrad,
                    ub_bulk_dgrad=ub_bulk_dgrad,
Jaemin Choi's avatar
Jaemin Choi committed
5597
                    ub_overlap_rs_dgrad=ub_overlap_rs_dgrad,
5598
                    ub_overlap_ag=ub_overlap_ag,
5599
                    normalization=normalization,
Przemyslaw Tredak's avatar
Przemyslaw Tredak committed
5600
                    ub_name="qkv",
5601
5602
5603
5604
5605
                    **common_gemm_kwargs,
                )
            else:
                self.qkv = Linear(
                    hidden_size,
5606
                    self.hidden_size_q + 2 * self.hidden_size_kv,
5607
5608
5609
5610
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
cyanguwa's avatar
cyanguwa committed
5611
                    parameters_split=parameters_split,
5612
5613
                    **common_gemm_kwargs,
                )
cyanguwa's avatar
cyanguwa committed
5614
        elif self.attention_type == "cross":
5615
5616
5617
            if self.input_layernorm:
                self.layernorm_query = LayerNormLinear(
                    hidden_size,
5618
                    self.hidden_size_q,
5619
5620
5621
5622
5623
                    eps=layernorm_epsilon,
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
5624
                    parameters_split=("query",) if not fuse_qkv_params else None,
5625
5626
5627
5628
                    return_layernorm_output=return_layernorm_output,
                    zero_centered_gamma=zero_centered_gamma,
                    ub_bulk_wgrad=ub_bulk_wgrad,
                    ub_bulk_dgrad=ub_bulk_dgrad,
Jaemin Choi's avatar
Jaemin Choi committed
5629
                    ub_overlap_rs_dgrad=ub_overlap_rs_dgrad,
5630
                    ub_overlap_ag=ub_overlap_ag,
5631
                    normalization=normalization,
Przemyslaw Tredak's avatar
Przemyslaw Tredak committed
5632
                    ub_name="qkv",
5633
5634
5635
5636
5637
                    **common_gemm_kwargs,
                )
            else:
                self.query_layer = Linear(
                    hidden_size,
5638
                    self.hidden_size_q,
5639
5640
5641
5642
5643
5644
5645
5646
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
                    **common_gemm_kwargs,
                )
            self.key_value = Linear(
                hidden_size,
5647
                2 * self.hidden_size_kv,
5648
5649
5650
5651
                init_method=init_method,
                bias=bias,
                return_bias=False,
                parallel_mode=qkv_parallel_mode,
5652
                parameters_split=("key", "value") if not fuse_qkv_params else None,
5653
5654
5655
5656
5657
5658
                **common_gemm_kwargs,
            )

        # Attention.
        self.core_attention = DotProductAttention(
            num_attention_heads,
5659
            self.hidden_size_per_attention_head,
5660
5661
            num_gqa_groups=self.num_gqa_groups,
            attention_dropout=attention_dropout,
5662
            qkv_format=self.qkv_format,
5663
5664
5665
5666
            tp_size=tp_size,
            get_rng_state_tracker=get_rng_state_tracker,
            sequence_parallel=sequence_parallel,
            tp_group=tp_group,
5667
            layer_number=self.layer_number,
5668
            attention_type=self.attention_type,
5669
5670
5671
5672
        )

        # Linear
        self.proj = Linear(
5673
            self.hidden_size_q,
5674
5675
5676
            hidden_size,
            init_method=output_layer_init_method,
            bias=bias,
5677
            return_bias=return_bias,
5678
            parallel_mode="row" if set_parallel_mode else None,
5679
5680
            ub_overlap_rs=ub_overlap_rs,
            ub_overlap_ag=ub_overlap_ag,
Przemyslaw Tredak's avatar
Przemyslaw Tredak committed
5681
            ub_name="proj",
5682
5683
5684
5685
            **common_gemm_kwargs,
        )

    def _allocate_memory(
5686
        self, inference_max_sequence_len: int, batch_size: int, dtype: torch.dtype
5687
5688
5689
5690
    ) -> torch.Tensor:
        return torch.empty(
            inference_max_sequence_len,
            batch_size,
5691
            self.num_gqa_groups_per_partition,
5692
            self.hidden_size_per_attention_head,
5693
            dtype=dtype,
5694
5695
5696
5697
            device=torch.cuda.current_device(),
        )

    def set_tensor_parallel_group(self, tp_group: Union[dist_group_type, None]) -> None:
5698
5699
5700
5701
5702
5703
5704
5705
5706
        """
        Set the tensor parallel group for the given
        module before executing the forward pass.

        Parameters
        ----------
        tp_group : ProcessGroup, default = `None`
                  tensor parallel process group.
        """
5707
5708
        self.tp_group = tp_group

5709
    def set_context_parallel_group(
5710
5711
        self,
        cp_group: Union[dist_group_type, None],
5712
        cp_global_ranks: List[int],
5713
5714
        cp_stream: torch.cuda.Stream,
    ) -> None:
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
        """
        Set the context parallel attributes for the given
        module before executing the forward pass.

        Parameters
        ----------
        cp_group : ProcessGroup
                  context parallel process group.
        cp_global_ranks : List[int]
                         list of global ranks in the context group.
        cp_stream : torch.cuda.Stream
                   cuda stream for context parallel execution.
        """
5728
5729
5730
5731
5732
5733
        # Deep iterate but skip self to avoid infinite recursion.
        for index, child in enumerate(self.modules()):
            if index == 0:
                continue
            if hasattr(child, "set_context_parallel_group"):
                child.set_context_parallel_group(cp_group, cp_global_ranks, cp_stream)
5734

5735
5736
5737
    def forward(
        self,
        hidden_states: torch.Tensor,
5738
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
5739
        encoder_output: Optional[torch.Tensor] = None,
5740
        attn_mask_type: Optional[str] = None,
5741
        window_size: Optional[Tuple[int, int]] = None,
5742
5743
        is_first_microbatch: Optional[bool] = None,
        checkpoint_core_attention: bool = False,
5744
        inference_params: Optional[InferenceParams] = None,
5745
        rotary_pos_emb: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
5746
5747
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
5748
        alibi_slopes: Optional[torch.Tensor] = None,
5749
        fast_zero_fill: bool = True,
5750
    ) -> Tuple[Union[torch.Tensor, None], ...]:
5751
5752
5753
5754
5755
        """
        Forward propagation for MultiheadAttention layer.

        .. note::

5756
5757
            Argument :attr:`attention_mask` is only used when :attr:`attn_mask_type`
            includes `"padding"` or `"arbitrary"`.
5758
5759
5760
5761
5762

        Parameters
        ----------
        hidden_states : torch.Tensor
             Input tensor.
5763
5764
5765
5766
5767
5768
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]],
             default = `None`. Boolean tensor(s) used to mask out attention softmax input.
             It should be 'None' for 'causal' and 'no_mask' types. For 'padding' masks, it should be
             a single tensor of [batch_size, 1, 1, seqlen_q] for self-attention, and a tuple of
             two tensors in shapes [batch_size, 1, 1, seqlen_q] and [batch_size, 1, 1, seqlen_kv]
             for cross-attention. For the 'arbitrary' mask type, it should be in a shape that is
5769
5770
5771
             broadcastable to [batch_size, num_heads, max_seqlen_q, max_seqlen_kv]. A `True` value
             means the corresponding position is masked out and a `False` means that position is
             allowed to participate in attention.
5772
5773
        attn_mask_type: {'no_mask', 'padding', 'causal', 'padding_causal', 'arbitrary'},
                       default = `None`
5774
                       type of attention mask passed into softmax operation.
5775
5776
        window_size: Optional[Tuple[int, int]], default = `None`
                    sliding window size for local attention.
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
        encoder_output : Optional[torch.Tensor], default = `None`
             Output of the encoder block to be fed into the decoder block if using
             `layer_type="decoder"`.
        is_first_microbatch : {True, False, None}, default = None
                             During training using either gradient accumulation or
                             pipeline parallelism a minibatch of data is further split
                             into microbatches. Between the microbatches of the same minibatch
                             the model weights are not updated. Setting this parameter indicates
                             whether the current microbatch is the first in a minibatch or not.
                             When set, this parameter enables additional optimizations:

                             * during FP8 training, it allows caching of the FP8 versions of
                               the weights
                             * it also allows skipping gradient accumulation during the
                               first microbatch (since it is the first gradient being
                               produced)
        checkpoint_core_attention: bool, default = `False`
                                  If true, forward activations for core attention are recomputed
                                  during the backward pass in order to save memory that would
                                  otherwise be occupied to store the forward activations until
                                  backprop.
        rotary_pos_emb: Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]], default = `None`
                       Embeddings for query and key tensors for applying rotary position
                       embedding. By default no input embedding is applied.
        core_attention_bias_type: str, default = `no_bias`
5802
                    Bias type, {`no_bias`, `pre_scale_bias`, 'post_scale_bias`, `alibi`}
5803
        core_attention_bias: Optional[torch.Tensor], default = `None`
5804
5805
                    Bias tensor for Q * K.T, shape [1, num_head, max_seqlen_q, max_seqlen_kv].
                    It should be 'None' for 'no_bias' and 'alibi' bias types.
5806
5807
5808
5809
        alibi_slopes: Optional[torch.Tensor], default = `None`
                     ALiBi slopes in FP32 and shape [nheads] or [batch_size, nheads].
                     It adds a bias of (-alibi_slope * (i + seqlen_k - seqlen_q - j))
                     to the attention score of query i and key j.
5810
5811
5812
        fast_zero_fill: bool, default = `True`
                    Whether to set output tensors to 0 or not before use.
        """
5813
5814
        # hidden_states: [sq, b, h]

5815
5816
        if attn_mask_type is not None:
            window_size = check_set_window_size(attn_mask_type, window_size)
5817
        if attn_mask_type is None:
5818
            attn_mask_type = self.attn_mask_type
5819
5820
        if window_size is None:
            window_size = self.window_size
5821

5822
        if "padding" in attn_mask_type and attention_mask is not None:
5823
            for i, _ in enumerate(attention_mask):
5824
5825
5826
                assert (
                    attention_mask[i].dtype == torch.bool
                ), "Attention mask must be in boolean type!"
5827

5828
5829
5830
        assert (
            core_attention_bias_type in AttnBiasTypes
        ), f"core_attention_bias_type {core_attention_bias_type} is not supported!"
5831

5832
        # =================================================
5833
        # Pre-allocate memory for key-values for inference
5834
5835
5836
5837
        # =================================================

        if inference_params and self.layer_number is not None:
            if self.layer_number not in inference_params.key_value_memory_dict:
5838
                inf_max_seq_len = inference_params.max_sequence_length
5839
5840
                inf_max_batch_size = inference_params.max_batch_size
                inference_key_memory = self._allocate_memory(
5841
                    inf_max_seq_len, inf_max_batch_size, hidden_states.dtype
5842
5843
                )
                inference_value_memory = self._allocate_memory(
5844
                    inf_max_seq_len, inf_max_batch_size, hidden_states.dtype
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
                )
                inference_params.key_value_memory_dict[self.layer_number] = (
                    inference_key_memory,
                    inference_value_memory,
                )
            else:
                (
                    inference_key_memory,
                    inference_value_memory,
                ) = inference_params.key_value_memory_dict[self.layer_number]

5856
        # ======================
5857
        # Query, Key, and Value
5858
        # ======================
5859

cyanguwa's avatar
cyanguwa committed
5860
5861
        if self.attention_type == "self":
            # Attention heads [sq, b, h] --> [sq, b, ng * (np/ng + 2) * hn]
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
            if self.input_layernorm:
                layernorm_qkv_outputs = self.layernorm_qkv(
                    hidden_states,
                    is_first_microbatch=is_first_microbatch,
                )
                if self.return_layernorm_output:
                    mixed_x_layer, layernorm_output = layernorm_qkv_outputs
                else:
                    mixed_x_layer = layernorm_qkv_outputs
            else:
                mixed_x_layer = self.qkv(
                    hidden_states,
                    is_first_microbatch=is_first_microbatch,
5875
                    is_first_module_in_mha=True,  # specific to FP8 MHA
5876
5877
                )

5878
5879
5880
            num_queries_per_key_value = (
                self.num_attention_heads_per_partition // self.num_gqa_groups_per_partition
            )
5881
            if self.qkv_weight_interleaved:
cyanguwa's avatar
cyanguwa committed
5882
                # [sq, b, ng * (np/ng + 2) * hn] --> [sq, b, ng, (np/ng + 2), hn]
5883
                new_tensor_shape = mixed_x_layer.size()[:-1] + (
cyanguwa's avatar
cyanguwa committed
5884
5885
                    self.num_gqa_groups_per_partition,
                    (num_queries_per_key_value + 2),
5886
5887
5888
5889
                    self.hidden_size_per_attention_head,
                )
                # split along second last dimension
                split_dim = -2
cyanguwa's avatar
cyanguwa committed
5890
5891
5892
5893
5894
            else:
                # [sq, b, ng * (np/ng + 2) * hn] --> [sq, b, (np/ng + 2), ng, hn]
                new_tensor_shape = mixed_x_layer.size()[:-1] + (
                    (num_queries_per_key_value + 2),
                    self.num_gqa_groups_per_partition,
5895
                    self.hidden_size_per_attention_head,
cyanguwa's avatar
cyanguwa committed
5896
5897
5898
                )
                # split along third last dimension
                split_dim = -3
5899
5900
5901

            mixed_x_layer = mixed_x_layer.view(*new_tensor_shape)

cyanguwa's avatar
cyanguwa committed
5902
5903
5904
5905
5906
5907
5908
5909
5910
            # qkv_weight_interleaved:
            #  [sq, b, ng, (np/ng + 2), hn]
            #  --> [sq, b, ng, np/ng, hn], [sq, b, ng, 1, hn], [sq, b, ng, 1, hn]
            # not qkv_weight_interleaved:
            #  [sq, b, (np/ng + 2), ng, hn]
            #  --> [sq, b, np/ng, np, hn], [sq, b, 1, ng, hn], [sq, b, 1, ng, hn]
            if not is_in_onnx_export_mode():
                query_layer, key_layer, value_layer = _SplitAlongDim.apply(
                    mixed_x_layer, split_dim, (num_queries_per_key_value, 1, 1)
5911
                )
5912
            else:
cyanguwa's avatar
cyanguwa committed
5913
                query_layer, key_layer, value_layer = torch.split(
5914
5915
5916
5917
                    mixed_x_layer,
                    (num_queries_per_key_value, 1, 1),
                    dim=split_dim,
                )
cyanguwa's avatar
cyanguwa committed
5918
5919
5920

            # query: -> [sq, b, np, hn]
            # key, value: -> [sq, b, ng, hn]
5921
5922
5923
5924
            query_layer, key_layer, value_layer = (
                x.reshape(x.size(0), x.size(1), -1, self.hidden_size_per_attention_head)
                for x in (query_layer, key_layer, value_layer)
            )
cyanguwa's avatar
cyanguwa committed
5925
5926
5927

        elif self.attention_type == "cross":
            # Attention heads [sk, b, h] --> [sk, b, (ng * 2 * hn)]
5928
            mixed_kv_layer = self.key_value(
cyanguwa's avatar
cyanguwa committed
5929
                encoder_output,
5930
                is_first_microbatch=is_first_microbatch,
5931
                is_first_module_in_mha=True,  # specific to FP8 MHA
5932
5933
5934
            )

            if self.qkv_weight_interleaved:
cyanguwa's avatar
cyanguwa committed
5935
                # [sq, b, (ng * 2 * hn)] --> [sq, b, ng, 2 * hn]
5936
                new_tensor_shape = mixed_kv_layer.size()[:-1] + (
5937
                    self.num_gqa_groups_per_partition,
5938
5939
5940
5941
5942
                    2 * self.hidden_size_per_attention_head,
                )
                # split along last dimension
                split_dim = -1
            else:
cyanguwa's avatar
cyanguwa committed
5943
                # [sq, b, (ng * 2 * hn)] --> [sq, b, 2 * ng, hn]
5944
                new_tensor_shape = mixed_kv_layer.size()[:-1] + (
5945
                    2 * self.num_gqa_groups_per_partition,
5946
5947
5948
5949
5950
5951
5952
                    self.hidden_size_per_attention_head,
                )
                # split along second last dimension
                split_dim = -2

            mixed_kv_layer = mixed_kv_layer.view(*new_tensor_shape)

cyanguwa's avatar
cyanguwa committed
5953
5954
5955
            # mixed_kv_layer --> 2 [sk, b, ng, hn]
            if not is_in_onnx_export_mode():
                key_layer, value_layer = _SplitAlongDim.apply(
5956
5957
5958
                    mixed_kv_layer,
                    split_dim,
                    mixed_kv_layer.shape[split_dim] // 2,
cyanguwa's avatar
cyanguwa committed
5959
                )
5960
            else:
cyanguwa's avatar
cyanguwa committed
5961
                key_layer, value_layer = torch.split(
5962
5963
5964
                    mixed_kv_layer,
                    mixed_kv_layer.shape[split_dim] // 2,
                    dim=split_dim,
cyanguwa's avatar
cyanguwa committed
5965
                )
5966
5967
5968
5969
5970
5971
5972
5973
5974
            key_layer, value_layer = (
                x.reshape(
                    x.size(0),
                    x.size(1),
                    -1,
                    self.hidden_size_per_attention_head,
                )
                for x in (key_layer, value_layer)
            )
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989

            # Attention head [sq, b, h] --> [sq, b, hp]
            if self.input_layernorm:
                layernorm_query_outputs = self.layernorm_query(
                    hidden_states,
                    is_first_microbatch=is_first_microbatch,
                )
                if self.return_layernorm_output:
                    query_layer, layernorm_output = layernorm_query_outputs
                else:
                    query_layer = layernorm_query_outputs
            else:
                query_layer = self.query_layer(
                    hidden_states,
                    is_first_microbatch=is_first_microbatch,
5990
                    is_first_module_in_mha=True,  # specific to FP8 MHA
5991
5992
5993
5994
5995
5996
5997
5998
5999
                )

            # [sq, b, hp] --> [sq, b, np, hn]
            new_tensor_shape = query_layer.size()[:-1] + (
                self.num_attention_heads_per_partition,
                self.hidden_size_per_attention_head,
            )
            query_layer = query_layer.view(*new_tensor_shape)

6000
6001
6002
        # ======================================================
        # Apply relative positional encoding (rotary embedding)
        # ======================================================
6003

6004
        if rotary_pos_emb is not None:
6005
6006
6007
            assert not isinstance(query_layer, Float8Tensor) and not isinstance(
                key_layer, Float8Tensor
            ), "RoPE is not supported for Float8Tensors!"
6008
            # duplicate the pos_emb for self attention
6009
            if not isinstance(rotary_pos_emb, tuple):
6010
                rotary_pos_emb = (rotary_pos_emb,) * 2
6011
6012

            q_pos_emb, k_pos_emb = rotary_pos_emb
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026

            # adjust key and value for inference
            if inference_params is not None:
                if self.qkv_format == "sbhd":
                    sequence_length = key_layer.size(0)
                elif self.qkv_format == "bshd":
                    sequence_length = key_layer.size(1)

                sequence_start = inference_params.sequence_len_offset
                sequence_end = sequence_start + sequence_length

                q_pos_emb = q_pos_emb[sequence_start:sequence_end, ...]
                k_pos_emb = k_pos_emb[sequence_start:sequence_end, ...]

6027
6028
            query_layer = apply_rotary_pos_emb(query_layer, q_pos_emb, self.qkv_format, fused=True)
            key_layer = apply_rotary_pos_emb(key_layer, k_pos_emb, self.qkv_format, fused=True)
6029

6030
6031
6032
6033
        # ===========================
        # Core attention computation
        # ===========================

6034
6035
6036
6037
        context_layer = self.core_attention(
            query_layer,
            key_layer,
            value_layer,
6038
            qkv_format=self.qkv_format,
6039
6040
            cu_seqlens_q=None,
            cu_seqlens_kv=None,
6041
6042
            attention_mask=attention_mask,
            attn_mask_type=attn_mask_type,
6043
            window_size=window_size,
6044
6045
6046
            checkpoint_core_attention=checkpoint_core_attention,
            core_attention_bias_type=core_attention_bias_type,
            core_attention_bias=core_attention_bias,
6047
            alibi_slopes=alibi_slopes,
6048
            fast_zero_fill=fast_zero_fill,
6049
            inference_params=inference_params,
6050
6051
        )

6052
        # ===================
6053
        # Output. [sq, b, h]
6054
        # ===================
6055

6056
        projection_output = self.proj(
6057
6058
            context_layer,
            is_first_microbatch=is_first_microbatch,
6059
6060
        )

6061
6062
6063
6064
6065
6066
6067
6068
        if self.return_bias:
            attention_output, attention_bias = projection_output
        else:
            attention_output, attention_bias = projection_output, None

        outputs = (attention_output,)
        if self.return_bias:
            outputs += (attention_bias,)
6069
        if self.input_layernorm and self.return_layernorm_output:
6070
6071
            outputs += (layernorm_output,)
        return outputs if len(outputs) > 1 else outputs[0]