attention.py 349 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
from importlib.metadata import PackageNotFoundError
10
import math
11
import os
12
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
13
import warnings
14
import logging
15

16
from dataclasses import dataclass, fields
cyanguwa's avatar
cyanguwa committed
17
import numpy as np
18
from packaging.version import Version as PkgVersion
19
20

import torch
21
import torch.nn.functional as F
22

23
import transformer_engine_torch as tex
24
25
import transformer_engine as te
from transformer_engine.pytorch.utils import get_cudnn_version
26
27
28
29
from transformer_engine.pytorch.cpp_extensions import (
    cast_to_fp8,
    cast_from_fp8,
)
30
31
32
33
34
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,
35
36
    fused_attn_fwd,
    fused_attn_bwd,
37
38
39
40
    QKVLayout,
    AttnBiasType,
    AttnMaskType,
    FusedAttnBackend,
41
42
43
44
45
46
47
48
49
50
51
52
53
    META_QKV,
    META_DQKV,
    META_O,
    META_DO,
    META_S,
    META_DP,
    META_O_CP,
    META_DQKV_CP,
)
from transformer_engine.pytorch.fp8 import (
    FP8GlobalStateManager,
    get_fp8_te_dtype,
    get_fp8_torch_dtype,
54
)
55
from transformer_engine.pytorch.float8_tensor import Float8Tensor
56
from transformer_engine.pytorch.module import LayerNormLinear, Linear
57
from transformer_engine.pytorch.module.base import TransformerEngineBaseModule
58
59
60
61
62
from transformer_engine.pytorch.utils import (
    divide,
    attention_mask_func,
    split_tensor_along_dim,
    get_device_compute_capability,
63
    get_default_init_method,
64
65
66
67
)
from transformer_engine.pytorch.constants import (
    AttnMaskTypes,
    AttnTypes,
68
    AttnBiasTypes,
69
    QKVLayouts,
70
    dist_group_type,
71
    TE_DType,
72
73
74
75
)
from transformer_engine.pytorch.softmax import FusedScaleMaskSoftmax
from transformer_engine.pytorch.distributed import (
    get_distributed_world_size,
76
    get_distributed_rank,
77
    checkpoint,
78
79
80
    set_all_rng_states,
    CudaRNGStatesTracker,
    graph_safe_rng_available,
81
82
    gather_along_first_dim,
    reduce_scatter_along_first_dim,
83
84
)
from transformer_engine.pytorch.export import is_in_onnx_export_mode
85
from transformer_engine.pytorch.jit import jit_fuser, no_torch_dynamo
86
87
from transformer_engine.pytorch.graph import is_graph_capturing

88

89
90
91
_NVTE_FLASH_ATTN = int(os.getenv("NVTE_FLASH_ATTN", "1"))
_NVTE_FUSED_ATTN = int(os.getenv("NVTE_FUSED_ATTN", "1"))
_NVTE_UNFUSED_ATTN = int(os.getenv("NVTE_UNFUSED_ATTN", "1"))
92
93
_flash_attn_version = PkgVersion(get_pkg_version("flash-attn"))
_flash_attn_version_required = PkgVersion("2.0.6")
94
_flash_attn_max_version = PkgVersion("2.6.3")
95
_flash_attn_2_plus = _flash_attn_version >= PkgVersion("2")
96
97
98
99
_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")
100
_flash_attn_2_5_7_plus = _flash_attn_version >= PkgVersion("2.5.7")
101
102
103
104
105
106
_flash_attn_3_plus = False
_use_flash_attn_3 = False
try:
    _flash_attn_v3_version = PkgVersion(get_pkg_version("flashattn-hopper"))
    _flash_attn_3_plus = _flash_attn_v3_version >= PkgVersion("2.6.1")
except PackageNotFoundError:
107
108
109
110
111
112
113
114
    if get_device_compute_capability() == (9, 0) and _NVTE_FLASH_ATTN:
        warnings.warn(
            "To use flash-attn v3, please use the following commands to install: \n"
            """(1) pip install "git+https://github.com/Dao-AILab/flash-attention.git#egg=flashattn-hopper&subdirectory=hopper" \n"""
            """(2) python_path=`python -c "import site; print(site.getsitepackages()[0])"` \n"""
            """(3) mkdir -p $python_path/flashattn_hopper \n"""
            """(4) wget -P $python_path/flashattn_hopper https://raw.githubusercontent.com/Dao-AILab/flash-attention/main/hopper/flash_attn_interface.py"""
        )
115
116
117
118
119
120
121
122
123
124
125
126
127
else:
    from flashattn_hopper.flash_attn_interface import flash_attn_func as flash_attn_func_v3
    from flashattn_hopper.flash_attn_interface import (
        flash_attn_varlen_func as flash_attn_varlen_func_v3,
    )
    from flashattn_hopper.flash_attn_interface import (  # pylint: disable=unused-import
        _flash_attn_forward as _flash_attn_forward_v3,
    )
    from flashattn_hopper.flash_attn_interface import (  # pylint: disable=unused-import
        _flash_attn_backward as _flash_attn_backward_v3,
    )

    _use_flash_attn_3 = True
128

129
if _flash_attn_version >= _flash_attn_version_required:
130
    from flash_attn.flash_attn_interface import flash_attn_func, flash_attn_varlen_func
131
132
133
    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
134
135


136
# NVTE_DEBUG = 0/1 # disables/enables debug mode, default = 0
137
_NVTE_DEBUG = int(os.getenv("NVTE_DEBUG", "0"))
138
139
# 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"))
140
141
142
143
144
145
_log_level = _NVTE_DEBUG * _NVTE_DEBUG_LEVEL
_log_levels = {0: logging.WARNING, 1: logging.INFO, 2: logging.DEBUG}
_log_level = _log_levels[_log_level if _log_level in [0, 1, 2] else 2]
_formatter = logging.Formatter("[%(levelname)-8s | %(name)-19s]: %(message)s")
_stream_handler = logging.StreamHandler()
_stream_handler.setFormatter(_formatter)
146

147
148
149
150
151
152
153
_attention_backends = {
    "attention_params": None,
    "use_flash_attention": None,
    "use_fused_attention": None,
    "fused_attention_backend": None,
    "use_unfused_attention": None,
    "backend_selection_requires_update": False,
154
}
155
156


157
158
@dataclass(eq=True)
class AttentionParams:
159
    """
160
    Attention parameters used to determine which backend to be used.
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

    Parameters
    ----------
    qkv_type: Union[torch.Tensor, Float8Tensor], default = `torch.Tensor`
        Type of query/key/value tensors, {`torch.Tensor`, `Float8Tensor`}.
    qkv_dtype: torch.dtype, default = `torch.bfloat16`
        Data type of query/key/value tensors.
    qkv_layout: str, default = "sbh3d"
        Query/key/value tensor memory layout.
    batch_size: int, default = 1
        Batch size.
    num_heads: int, default = 16
        Number of attention heads in the query tensor.
    num_gqa_groups: int, default = 16
        Number of attention heads in key and value tensors.
    max_seqlen_q: int, default = 128
        Maximum sequence length of the query tensor.
    max_seqlen_kv: int, default = 128
        Maximum sequence length of the key and value tensors.
180
181
182
183
    head_dim_qk: int, default = 64
        The size of each attention head in query and key tensors.
    head_dim_v: int, default = 64
        The size of each attention head in the value tensor.
184
185
186
    attn_mask_type: str, default = `no_mask`
        Attention mask type, {`no_mask`, `padding`, `causal`, `padding_causal`,
        `causal_bottom_right`, `padding_causal_bottom_right`, `arbitrary`}
187
    window_size: Tuple[int, int], default = None
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
        Sliding window attention size.
    alibi_slopes_shape: Optional[Union[torch.Size, List]], default = `None`
        Tensor shape of :attr:`alibi_slopes` in `DotProductAttention`.
    core_attention_bias_type: str, default = `no_bias`
        Attention bias type, {`no_bias`, `pre_scale_bias`, `post_scale_bias`, `alibi`}.
    core_attention_bias_shape: str, default = `1hss`
        Attention bias shape, {`1hss`, `b1ss`, `bhss`}.
    core_attention_bias_requires_grad: bool, default = `True`
        Whether attention bias requires gradient.
    pad_between_seqs: bool, default = `False`
        Whether there is padding between sequences in a batch.
        This only applies to `qkv_format=thd`.
    attention_dropout: float, default = 0.0
        Attention dropout.
    context_parallel: bool, default = `False`
        Whether context parallelism is used or not.
    deterministic: bool, default = `False`
        Whether to run `DotProductAttention` with determinism or not.
206
207
    is_training: bool, default = `True`
        Whether in training mode (`True`) or inference mode (`False`)
208
209
210
211
    fp8: bool, default = `False`
        Whether `DotProductAttention` is in an `fp8_autocast` region.
    fp8_meta: Optional[Dict[str Any]], default = `None`
        The FP8 metadata tensor of `DotProductAttention`.
212
213
214
215
216
217
218
219
220
221
    """

    qkv_type: Union[torch.Tensor, Float8Tensor] = torch.Tensor
    qkv_dtype: torch.dtype = torch.bfloat16
    qkv_layout: str = "sbh3d"
    batch_size: int = 1
    num_heads: int = 16
    num_gqa_groups: int = 16
    max_seqlen_q: int = 128
    max_seqlen_kv: int = 128
222
223
    head_dim_qk: int = 64
    head_dim_v: int = 64
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
    attn_mask_type: str = "no_mask"
    window_size: Union[Tuple[int, int], None] = None
    alibi_slopes_shape: Union[torch.Size, List, None] = None
    core_attention_bias_type: str = "no_bias"
    core_attention_bias_shape: str = "1hss"
    core_attention_bias_requires_grad: bool = True
    pad_between_seqs: bool = False
    attention_dropout: float = 0.0
    context_parallel: bool = False
    deterministic: bool = False
    is_training: bool = True
    fp8: bool = False
    fp8_meta: Union[Dict[str, Any], None] = None


_alibi_cache = {
    "_num_heads": None,
    "_alibi_slopes": None,
    "_max_seqlen_q": None,
    "_max_seqlen_kv": None,
    "_bottom_right_alignment": True,
    "_alibi_bias": None,
    "_alibi_slopes_require_update": False,
    "_alibi_bias_require_update": False,
}


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


def get_attention_backend(
    attention_params: AttentionParams = None,
):
    """
    Select the appropriate attention backend/sub-backend based on user input and runtime environment.

    Parameters
    ----------
    See `AttentionParams`.
263
264
265
266
267
268
269

    Returns
    ----------
    use_flash_attention: bool
        Whether the `FlashAttention` backend has been selected.
    use_fused_attention: bool
        Whether the `FusedAttention` backend has been selected.
270
271
    fused_attention_backend: tex.NVTE_Fused_Attn_Backend
        If `use_fused_attention = True`, one of `FusedAttention` three sub-backends, else `None`.
272
273
274
275
276
277
    use_unfused_attention: bool
        Whether the `UnfusedDotProductAttention` backend has been selected.
    available_backends: List[bool]
        All available backends that could support the provided input. A list of Booleans
        in the form of [use_flash_attention, use_fused_attention, use_unfused_attention].
    """
278
279
280
281
282
283
284
285
    qkv_type = attention_params.qkv_type
    qkv_dtype = attention_params.qkv_dtype
    qkv_layout = attention_params.qkv_layout
    batch_size = attention_params.batch_size
    num_heads = attention_params.num_heads
    num_gqa_groups = attention_params.num_gqa_groups
    max_seqlen_q = attention_params.max_seqlen_q
    max_seqlen_kv = attention_params.max_seqlen_kv
286
287
    head_dim_qk = attention_params.head_dim_qk
    head_dim_v = attention_params.head_dim_v
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
    attn_mask_type = attention_params.attn_mask_type
    window_size = attention_params.window_size
    alibi_slopes_shape = attention_params.alibi_slopes_shape
    core_attention_bias_type = attention_params.core_attention_bias_type
    core_attention_bias_shape = attention_params.core_attention_bias_shape
    core_attention_bias_requires_grad = attention_params.core_attention_bias_requires_grad
    pad_between_seqs = attention_params.pad_between_seqs
    attention_dropout = attention_params.attention_dropout
    context_parallel = attention_params.context_parallel
    deterministic = attention_params.deterministic
    is_training = attention_params.is_training
    fp8 = attention_params.fp8
    fp8_meta = attention_params.fp8_meta

    # Run config
303
    logger = logging.getLogger("DotProductAttention")
304
305
306
    logger.setLevel(_log_level)
    if not logger.hasHandlers():
        logger.addHandler(_stream_handler)
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
    device_compute_capability = get_device_compute_capability()
    cudnn_version = get_cudnn_version()
    run_config = {
        "transformer_engine_version": te.__version__,
        "compute_capability": "sm"
        + str(
            (lambda x, y: x * 10 + y)(device_compute_capability[0], device_compute_capability[1])
        ),
        "flash_attn_version": _flash_attn_version,
        "cudnn_version": ".".join([str(i) for i in cudnn_version]),
    }
    attention_params_dict = {
        field.name: getattr(attention_params, field.name) for field in fields(attention_params)
    }
    run_config.update(attention_params_dict)
    if fp8:
        run_config["NVTE_FP8_DPA_BWD"] = int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
    logger.debug("Running with config=%s", run_config)
325
326

    # Filter: Environment variables
327
328
329
330
331
332
333
    global _NVTE_FLASH_ATTN, _NVTE_FUSED_ATTN, _NVTE_UNFUSED_ATTN
    _NVTE_FLASH_ATTN = int(os.getenv("NVTE_FLASH_ATTN", "1"))
    _NVTE_FUSED_ATTN = int(os.getenv("NVTE_FUSED_ATTN", "1"))
    _NVTE_UNFUSED_ATTN = int(os.getenv("NVTE_UNFUSED_ATTN", "1"))
    use_flash_attention = _NVTE_FLASH_ATTN
    use_fused_attention = _NVTE_FUSED_ATTN
    use_unfused_attention = _NVTE_UNFUSED_ATTN
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
    if not use_flash_attention:
        logger.debug("Disabling FlashAttention due to NVTE_FLASH_ATTN=0")
    if not use_fused_attention:
        logger.debug("Disabling FusedAttention due to NVTE_FUSED_ATTN=0")
    if not use_unfused_attention:
        logger.debug("Disabling UnfusedDotProductAttention due to NVTE_UNFUSED_ATTN=0")

    # Filter: ONNX mode
    if is_in_onnx_export_mode():
        if use_flash_attention:
            logger.debug("Disabling FlashAttention due to ONNX mode")
        use_flash_attention = False
        if use_fused_attention:
            logger.debug("Disabling FusedAttention due to ONNX mode")
        use_fused_attention = False

    # Filter: Compute capability
351
    global _flash_attn_3_plus, _use_flash_attn_3
352
353
354
355
356
357
358
    if device_compute_capability < (8, 0):
        if use_flash_attention:
            logger.debug("Disabling FlashAttention as it requires compute capability sm80+")
            use_flash_attention = False
        if use_fused_attention:
            logger.debug("Disabling FusedAttention as it requires compute capability sm80+")
            use_fused_attention = False
359
360
361
362
    if device_compute_capability < (9, 0):
        if use_flash_attention and _flash_attn_3_plus:
            logger.debug("Disabling FlashAttention 3 as it requires compute capability sm90+")
            _use_flash_attn_3 = False
363
364

    # Filter: Data type
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
    if qkv_dtype not in [torch.bfloat16, torch.float16] or qkv_type not in [
        torch.Tensor,
        Float8Tensor,
    ]:
        if use_flash_attention:
            logger.debug(
                "Disabling FlashAttention due to unsupported QKV data type. "
                "Supported: qkv_dtype = {torch.bfloat16, torch.float16}. "
                "Found: qkv_dtype = %s.",
                qkv_dtype,
            )
            use_flash_attention = False
        if use_fused_attention:
            logger.debug(
                "Disabling FusedAttention due to unsupported QKV data type. "
                "Supported: qkv_dtype = {torch.bfloat16, torch.float16}. "
                "Found: qkv_dtype = %s.",
                qkv_dtype,
            )
            use_fused_attention = False
385
386
387

    # Filter: Execution type
    if fp8 and fp8_meta["recipe"].fp8_dpa:
388
389
390
391
392
393
394
        if use_flash_attention and not _use_flash_attn_3:
            logger.debug("Disabling FlashAttention as FlashAttention 2 does not support FP8")
            use_flash_attention = False
        if use_flash_attention and _use_flash_attn_3 and is_training:
            logger.debug(
                "Disabling FlashAttention as FlashAttention 3 does not support FP8 training"
            )
395
396
397
398
399
400
            use_flash_attention = False
        if use_unfused_attention:
            logger.debug("Disabling UnfusedDotProductAttention as it does not support FP8")
            use_unfused_attention = False

    # Filter: Head dimension
401
402
403
    if use_flash_attention and head_dim_qk != head_dim_v:
        logger.debug("Disabling FlashAttention as it does not support MLA.")
        use_flash_attention = False
404
    if use_flash_attention and (
405
406
407
        head_dim_qk > 256
        or head_dim_qk % 8 != 0
        or (head_dim_qk > 192 and device_compute_capability not in ((8, 0), (9, 0)))
408
409
    ):
        logger.debug(
410
411
412
413
414
415
            "Disabling FlashAttention due to unsupported head_dim_qk and head_dim_v. "
            "Supported: head_dim_qk = head_dim_v, head_dim_qk %%8 = 0, "
            "head_dim_qk <= 256 (>192 requires sm80/90). "
            "Found: head_dim_qk = %s, head_dim_v = %s, on sm%s.",
            head_dim_qk,
            head_dim_v,
416
417
418
            ".".join([str(i) for i in device_compute_capability]),
        )
        use_flash_attention = False
419
420
421
422
423
424
425
    qkv_layout_group = qkv_layout.replace("b", "").replace("s", "").replace("t", "")
    if use_fused_attention and head_dim_qk != head_dim_v and qkv_layout_group != "hd_hd_hd":
        logger.debug(
            "Disabling FusedAttention as MLA is not supported with qkv_layout = %s",
            qkv_layout,
        )
        use_fused_attention = False
426
427
428
429
430
431
432
433
434
435
436
437
438
439

    # Filter: QKV layout
    qkv_format = "".join([i for i in qkv_layout.split("_")[0] if i.isalpha()])
    if qkv_format == "thd":
        if use_unfused_attention:
            logger.debug("Disabling UnfusedDotProductAttention for qkv_format = thd")
            use_unfused_attention = False
        if use_flash_attention and pad_between_seqs:
            logger.debug(
                "Disabling FlashAttention for qkv_format = thd when there is "
                "padding between sequences, i.e. [a, a, PAD, b, b, b, PAD, c, PAD]"
            )
            use_flash_attention = False

440
441
442
443
444
445
    # Filter: Dropout
    if attention_dropout != 0.0 and use_flash_attention:
        if _flash_attn_3_plus and _use_flash_attn_3:
            logger.debug("Disabling FlashAttention 3 for dropout")
            _use_flash_attn_3 = False

446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
    # Filter: Context parallelism
    # qkv_format | attn_mask_type              | attn_bias_type           | supported backends
    # ----------------------------------------------------------------------------------------------------
    # bshd, sbhd | self-attention:             | no_bias, post_scale_bias | FlashAttention, FusedAttention
    #            |     no_mask, causal         |                          |
    #            | cross-attention:            |                          |
    #            |     no_mask                 |                          |
    # thd        | self-attention:             | no_bias                  | FlashAttention, FusedAttention
    #            |     padding, padding_causal |                          | if no padding between sequences,
    #            | cross-attention:            |                          | FusedAttention
    #            |     padding                 |                          | if there is padding between sequences
    # Note: context parallelism requires seq_len % (cp_size * 2) == 0 for each sequence in q, k, v.
    if context_parallel and use_unfused_attention:
        logger.debug(
            "Disabling UnfusedDotProductAttention as it does not support context parallelism"
        )
        use_unfused_attention = False
    if context_parallel and use_flash_attention:
464
465
466
467
468
469
470
471
        if _flash_attn_3_plus and _use_flash_attn_3:
            logger.debug("Disabling FlashAttention 3 for context parallelism")
            _use_flash_attn_3 = False
        if fp8 and fp8_meta["recipe"].fp8_dpa:
            logger.debug(
                "Disabling FlashAttention as it does not support context parallelism with FP8"
            )
            use_flash_attention = False
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
        if "bottom_right" in attn_mask_type:
            logger.debug(
                "Disabling FlashAttention as it does not support context parallelism with"
                " causal_bottom_right masking"
            )
            use_flash_attention = False
        elif "causal" in attn_mask_type and max_seqlen_q != max_seqlen_kv:
            logger.debug(
                "Disabling FlashAttention as it does not support context parallelism with causal"
                " masking for cross-attention"
            )
            use_flash_attention = False
        elif core_attention_bias_type not in ["no_bias", "post_scale_bias"]:
            logger.debug(
                "Disabling FlashAttention as it does not support context parallelism with bias type"
                " of %s",
                core_attention_bias_type,
            )
            use_flash_attention = False
        elif qkv_format == "thd" and core_attention_bias_type != "no_bias":
            logger.debug(
                "Disabling FlashAttention as it does not support context parallelism with attention"
                " bias for THD format"
            )
            use_flash_attention = False
497

498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
    if context_parallel and use_fused_attention:
        if "bottom_right" in attn_mask_type:
            logger.debug(
                "Disabling FusedAttention as it does not support context parallelism with"
                " causal_bottom_right masking"
            )
            use_fused_attention = False
        elif "causal" in attn_mask_type and max_seqlen_q != max_seqlen_kv:
            logger.debug(
                "Disabling FusedAttention as it does not support context parallelism with causal"
                " masking for cross-attention"
            )
            use_fused_attention = False
        elif core_attention_bias_type not in ["no_bias", "post_scale_bias"]:
            logger.debug(
                "Disabling FusedAttention as it does not support context parallelism with bias type"
                " of %s",
                core_attention_bias_type,
            )
            use_fused_attention = False
        elif qkv_format == "thd" and core_attention_bias_type != "no_bias":
            logger.debug(
                "Disabling FusedAttention as it does not support context parallelism with attention"
                " bias for THD format"
            )
            use_fused_attention = False
        elif head_dim_qk != head_dim_v:
            logger.debug(
                "Disabling FusedAttention as it does not support context parallelism with MLA"
            )
            use_fused_attention = False

530
    # Filter: Attention mask
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
    # attn_mask_type              | attention_mask                       | supported backends
    # ----------------------------------------------------------------------------------------
    # no_mask                     | None                                 | All
    # padding                     |                                      | All
    #     self-attention          | One tensor in shape [b, 1, 1, sq]    |
    #     cross-attention         | Tuple of two tensors in shapes       |
    #                             | [b, 1, 1, sq] and [b, 1, 1, skv]     |
    # causal                      | None                                 |
    #     self-attention          |                                      | All
    #     cross-attention         |                                      | FusedAttention, UnfusedDotProductAttention
    # padding_causal              | Same as "padding"                    |
    #     self-attention          |                                      | All
    #     cross-attention         |                                      | FusedAttention, UnfusedDotProductAttention
    # causal_bottom_right         | None                                 | All
    # padding_causal_bottom_right | Same as "padding"                    |
    #     self-attention          |                                      | All
    #     cross-attention         |                                      | FlashAttention, UnfusedDotProductAttention
    # arbitrary                   | One tensor in shape broadcastable to | UnfusedDotProductAttention
    #                             | [b, h, sq, skv]                      |
550
551
552
553
554
555
556
    if attn_mask_type == "arbitrary":
        if use_flash_attention:
            logger.debug("Disabling FlashAttention for arbitrary mask")
        use_flash_attention = False
        if use_fused_attention:
            logger.debug("Disabling FusedAttention for arbitrary mask")
        use_fused_attention = False
557
558
559
560
561
562
563
564
565
566
567
568
    if (
        use_flash_attention
        and _flash_attn_3_plus
        and attn_mask_type in ["causal", "padding_causal"]
        and max_seqlen_q != max_seqlen_kv
    ):
        logger.warning(
            "Disabling FlashAttention 3 as it only supports bottom-right-diagonal "
            "causal mask since flash-attn 2.1. See "
            "https://github.com/Dao-AILab/flash-attention#21-change-behavior-of-causal-flag"
        )
        _use_flash_attn_3 = False
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
    if (
        use_flash_attention
        and _flash_attn_2_1_plus
        and attn_mask_type in ["causal", "padding_causal"]
        and max_seqlen_q != max_seqlen_kv
    ):
        logger.warning(
            "Disabling FlashAttention as it only supports bottom-right-diagonal "
            "causal mask since flash-attn 2.1. See "
            "https://github.com/Dao-AILab/flash-attention#21-change-behavior-of-causal-flag"
        )
        use_flash_attention = False
    if (
        use_flash_attention
        and not _flash_attn_2_1_plus
        and attn_mask_type in ["causal_bottom_right", "padding_causal_bottom_right"]
        and max_seqlen_q != max_seqlen_kv
    ):
        logger.warning(
            "Disabling FlashAttention as it only supports top-left-diagonal "
            "causal mask before flash-attn 2.1. See "
            "https://github.com/Dao-AILab/flash-attention#21-change-behavior-of-causal-flag"
        )
        use_flash_attention = False

    # Filter: Sliding window attention
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
    #    backend                 |      window_size       | diagonal alignment
    # ---------------------------------------------------------------------------------
    # FlashAttention             | (-1, -1) or (>=0, >=0) | bottom right
    # FusedAttention             | (-1,  0) or (>=0, 0)   | top left
    # UnfusedDotProductAttention | (-1, -1) or (>=0, >=0) | both;
    #                            |                        | converts window_size to an 'arbitrary' mask
    if window_size is None:
        window_size = check_set_window_size(attn_mask_type, window_size)
    else:
        if use_fused_attention and (window_size[0] != -1 or window_size[1] not in [-1, 0]):
            if fp8 and (fp8_meta["recipe"].fp8_dpa or fp8_meta["recipe"].fp8_mha):
                logger.debug(
                    "Disabling FusedAttention as it does not support sliding window attention"
                    " for FP8"
                )
                use_fused_attention = False
            elif window_size[1] != 0 or attention_dropout != 0.0 or qkv_format == "thd":
                logger.debug(
                    "Disabling FusedAttention as it only supports sliding window attention "
                    "with causal mask, no dropout, and qkv_format = bshd/sbhd"
                )
                use_fused_attention = False
            elif context_parallel:
                logger.debug(
                    "Disabling FusedAttention as it does not support sliding window attention "
                    "with context parallelism"
                )
                use_fused_attention = False
            elif max_seqlen_q != max_seqlen_kv and attn_mask_type in [
                "no_mask",
                "padding",
                "causal_bottom_right",
                "padding_causal_bottom_right",
            ]:
                logger.debug(
                    "Disabling FusedAttention as it does not support sliding window attention "
                    "with attn_mask_type = %s for cross-attention",
                    attn_mask_type,
                )
                use_fused_attention = False
            elif "padding" in attn_mask_type:
                logger.debug(
                    "Disabling FusedAttention as it does not support sliding window attention "
                    "with attn_mask_type = %s",
                    attn_mask_type,
                )
                use_fused_attention = False
642
643
644
645
646
647
648
649
650
        if (
            use_flash_attention
            and (window_size[0] != -1 or window_size[1] not in [-1, 0])
            and _flash_attn_3_plus
        ):
            logger.debug(
                "Disabling FlashAttention 3 as it does not support sliding window attention"
            )
            _use_flash_attn_3 = False
651
652
653
        if (
            use_flash_attention
            and (window_size[0] != -1 or window_size[1] not in [-1, 0])
654
            and not _flash_attn_2_3_plus
655
        ):
656
            logger.debug(
657
                "Disabling FlashAttention as sliding window attention requires flash-attn 2.3+"
658
659
660
661
            )
            use_flash_attention = False

    # Filter: Attention bias
662
663
664
665
666
667
668
669
    #    backend                 |      bias types              | ALiBi diagonal alignment
    # ---------------------------------------------------------------------------------
    # FlashAttention             | no_bias, alibi/alibi_slopes  | bottom right
    # FusedAttention             | no_bias, post_scale_bias     |
    #                            | alibi/alibi_slopes           | top left,
    #                            |                              | bottom_right (converts to a 'post_scale_bias' bias)
    # UnfusedDotProductAttention | no_bias, pre/post_scale_bias |
    #                            | alibi/alibi_slopes           | both; converts to a 'post_scale_bias' bias
670
671
672
673
674
675
676
677
    if use_flash_attention and core_attention_bias_type == "alibi":
        if _flash_attn_3_plus and _use_flash_attn_3:
            logger.debug("Disabling FlashAttention 3 for ALiBi")
            _use_flash_attn_3 = False
            if not _flash_attn_2_4_plus:
                logger.debug("Disabling FlashAttention for ALiBi")
                use_flash_attention = False

678
679
680
681
682
683
684
685
686
687
688
689
690
    if use_flash_attention and (
        core_attention_bias_type not in ["no_bias", "alibi"]
        or core_attention_bias_shape is not None
    ):
        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_shape = core_attention_bias_shape
    fu_core_attention_bias_requires_grad = core_attention_bias_requires_grad
    if (
        use_fused_attention
        and core_attention_bias_type == "alibi"
691
        and (alibi_slopes_shape is not None or max_seqlen_q != max_seqlen_kv)
692
693
694
    ):
        fu_core_attention_bias_type = "post_scale_bias"
        fu_core_attention_bias_requires_grad = False
695
696
697
698
699
        if alibi_slopes_shape is None:
            fu_core_attention_bias_shape = "1hss"
        elif len(alibi_slopes_shape) == 1 and alibi_slopes_shape[0] == num_heads:
            fu_core_attention_bias_shape = "1hss"
        elif (
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
            len(alibi_slopes_shape) == 2
            and alibi_slopes_shape[0] == batch_size
            and alibi_slopes_shape[1] == num_heads
        ):
            fu_core_attention_bias_shape = "bhss"

    if (
        use_fused_attention
        and fu_core_attention_bias_type == "post_scale_bias"
        and fu_core_attention_bias_shape != "1hss"
    ):
        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]
            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"

    # Filter: cuDNN support
    fused_attention_backend = None
    if use_fused_attention:
        q_type = TE_DType[qkv_dtype]
        kv_type = q_type
        if fp8 and fp8_meta["recipe"].fp8_dpa:
            q_type = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
            kv_type = q_type
        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],
            attention_dropout,
            num_heads,
            num_gqa_groups,
            max_seqlen_q,
            max_seqlen_kv,
739
740
            head_dim_qk,
            head_dim_v,
741
742
            window_size[0],
            window_size[1],
743
        )
744
        if fused_attention_backend == FusedAttnBackend["No_Backend"]:
745
746
            logger.debug("Disabling FusedAttention as no backend supports the provided input")
            use_fused_attention = False
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
            fused_attention_backend = None
        if (
            use_fused_attention
            and window_size is not None
            and window_size[0] != -1
            and fused_attention_backend != FusedAttnBackend["F16_arbitrary_seqlen"]
        ):
            logger.debug(
                "Disabling FusedAttention as only sub-backend %s does not support "
                "slidng window attention",
                int(fused_attention_backend),
            )
            use_fused_attention = False
            fused_attention_backend = None
        if (
            use_fused_attention
            and fused_attention_backend == FusedAttnBackend["F16_max512_seqlen"]
764
765
766
767
768
769
770
771
            and fu_core_attention_bias_type == "post_scale_bias"
            and fu_core_attention_bias_shape != "1hss"
        ):
            logger.debug(
                "Disabling FusedAttention as cuDNN sub-backend 0 only supports post_scale_bias in"
                " [1, H, S, S] shape"
            )
            use_fused_attention = False
772
            fused_attention_backend = None
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792

    # Filter: Determinism
    # backend                      | deterministic
    # ---------------------------------------------
    # FlashAttention               |
    #     flash-attn >=2.0, <2.4.1 | no
    #     flash-attn >=2.4.1       | yes
    # FusedAttention               |
    #     sub-backend 0            | yes
    #     sub-backend 1            | workspace optimization path and sm90+: yes;
    #                              | otherwise: no
    #     sub-backend 2            | no
    # UnfusedDotProductAttention   | yes
    if use_flash_attention and deterministic and not _flash_attn_2_4_1_plus:
        logger.warning(
            "Disabling FlashAttention as version <2.4.1 does not support deterministic "
            "execution. To use FlashAttention with deterministic behavior, "
            "please install flash-attn >= 2.4.1."
        )
        use_flash_attention = False
793
794
795
796
797
798
799
800
801
802
803
    if use_fused_attention and deterministic:
        if fused_attention_backend == FusedAttnBackend["FP8"] and is_training:
            logger.debug("Disabling FusedAttention for determinism reasons")
            use_fused_attention = False
        if (
            fused_attention_backend == FusedAttnBackend["F16_arbitrary_seqlen"]
            and is_training
            and (
                device_compute_capability < (9, 0)
                or core_attention_bias_requires_grad
                or cudnn_version < (8, 9, 5)
804
            )
805
806
807
        ):
            logger.debug("Disabling FusedAttention for determinism reasons")
            use_fused_attention = False
808
809
810

    # All available backends
    available_backends = [use_flash_attention, use_fused_attention, use_unfused_attention]
811
812
813
814
815
816
817
818
819
820
821
822
    logger.debug(
        "Available backends = {FlashAttention=%s, FusedAttention=%s%s,"
        " UnfusedDotProductAttention=%s}",
        bool(available_backends[0]),
        bool(available_backends[1]),
        (
            f" (sub-backend {int(fused_attention_backend)})"
            if fused_attention_backend is not None
            else ""
        ),
        bool(available_backends[2]),
    )
823
824
825
826
827
828
829
830
831
832
833
834
835
836

    # Select FusedAttention for performance
    if (
        use_flash_attention
        and use_fused_attention
        and fused_attention_backend == FusedAttnBackend["F16_arbitrary_seqlen"]
    ):
        if device_compute_capability == (9, 0):
            logger.debug(
                "Disabling FlashAttention to give FusedAttention preference on Hopper+ "
                "for performance reasons"
            )
            use_flash_attention = False

837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
    # Select FusedAttention for FP8
    # FA3 uses default scaling factors (i.e. 1) in FP8 execution, while FusedAttention takes
    # scaling factors from `fp8_meta` and offers more accurate quantization/de-quantization
    if (
        use_flash_attention
        and use_fused_attention
        and fused_attention_backend == FusedAttnBackend["FP8"]
        and _use_flash_attn_3
    ):
        logger.debug(
            "Disabling FlashAttention 3 to give FusedAttention preference as FusedAttention "
            "supports more accurate scaling factors in FP8 execution"
        )
        use_flash_attention = False

852
853
854
855
856
857
    # Selected backend
    if use_flash_attention:
        use_fused_attention = False
        use_unfused_attention = False
    elif use_fused_attention:
        use_unfused_attention = False
858
    selected_backend = "NoBackend"
859
860
861
862
863
864
    if use_flash_attention:
        selected_backend = "FlashAttention"
    elif use_fused_attention:
        selected_backend = f"FusedAttention (sub-backend {int(fused_attention_backend)})"
    elif use_unfused_attention:
        selected_backend = "UnfusedDotProductAttention"
865
    logger.debug("Selected backend = %s", selected_backend)
866

867
868
869
870
871
872
    global _attention_backends
    _attention_backends["use_flash_attention"] = use_flash_attention
    _attention_backends["use_fused_attention"] = use_fused_attention
    _attention_backends["fused_attention_backend"] = fused_attention_backend
    _attention_backends["use_unfused_attention"] = use_unfused_attention
    _attention_backends["backend_selection_requires_update"] = False
873
874
875
876

    return (
        use_flash_attention,
        use_fused_attention,
877
        fused_attention_backend,
878
879
880
881
882
        use_unfused_attention,
        available_backends,
    )


883
class InferenceParams:  # pylint: disable=too-few-public-methods
884
885
    """
    Inference parameters that are passed to the main model in order
886
    to efficiently calculate and store the context during inference.
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926

    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,
            )
927

928

929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
@torch.no_grad()
def get_swa_mask(
    window_size: Tuple[int, int],
    max_seqlen_q: int,
    max_seqlen_kv: int,
    attn_mask_type: str = "no_mask",
    attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
) -> torch.Tensor:
    """
    Convert sliding window `window_size` to an equivalent "`arbitrary`" mask.
    For "`causal`" mask type, the sliding window diagonal is aligned to the top left corner,
    and for other mask types, the bottom right corner.

    Parameters
    ----------
    window_size: Tuple[int, int]
        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. Both `causal` and `causal_bottom_right` masks
        map to `window_size = (-1, 0)` and Transformer Engine distinguishes them based on
        `attn_mask_type`.
    max_seqlen_q: int
        Maximum sequence length for queries.
    max_seqlen_kv: int
        Maximum sequence length for keys and values.
    attn_mask_type: str, default = `no_mask`
        Attention mask type, {"`no_mask`", "`padding`", "`causal`", "`padding_causal`",
        "`causal_bottom_right`", "`padding_causal_bottom_right`", "`arbitrary`"}
    attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]],
        default = `None`
        Boolean tensor(s) used to mask out attention softmax input.

    Returns
    ----------
    attention_mask: torch.Tensor
        Combined `attention_mask` (input) and sliding window attention mask.
        The shape is [max_seqlen_q, max_seqlen_kv] when input `attention_mask` is None;
        else, the same shape as input `attention_mask`.
    """
    mask = torch.ones(max_seqlen_q, max_seqlen_kv, dtype=torch.bool, device="cuda")
    if attn_mask_type in ["causal"]:
        left = window_size[0] if window_size[0] != -1 else max_seqlen_q
        right = window_size[1] if window_size[1] != -1 else max_seqlen_q
        mask_upper = torch.triu(mask, diagonal=-left)
        mask_lower = torch.tril(mask_upper, diagonal=right)
    else:
        left = window_size[0] if window_size[0] != -1 else max_seqlen_kv
        right = window_size[1] if window_size[1] != -1 else max_seqlen_kv
        mask_upper = torch.triu(mask, diagonal=max_seqlen_kv - max_seqlen_q - left)
        mask_lower = torch.tril(mask_upper, diagonal=max_seqlen_kv - max_seqlen_q + right)
    attn_mask_type = "arbitrary"
    mask = mask_lower.logical_not()
    if attention_mask is not None:
        mask = torch.logical_and(attention_mask, mask)
    return attn_mask_type, mask


987
988
989
990
991
@torch.no_grad()
def get_alibi(
    num_heads: int,
    max_seqlen_q: int,
    max_seqlen_kv: int,
992
993
    actual_seqlens_q: Optional[torch.Tensor] = None,
    actual_seqlens_kv: Optional[torch.Tensor] = None,
994
995
    alibi_slopes: Optional[torch.Tensor] = None,
    bias_dtype: Optional[torch.dtype] = None,
996
    bottom_right_alignment: bool = True,
997
) -> Tuple[torch.Tensor, torch.Tensor]:
998
    """
999
1000
1001
1002
1003
1004
1005
1006
    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.
1007
1008
1009
1010
    actual_seqlens_q: Optional[torch.Tensor], default = `None`
        Actual sequence lengths for queries, in shape [batch_size].
    actual_seqlens_kv: Optional[torch.Tensor], default = `None`
        Actual sequence lengths for keys and values, in shape [batch_size].
1011
1012
1013
1014
    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.
1015
1016
1017
    bottom_right_alignment: bool, default = `True`
        Whether to align the diagonal of the ALiBi bias to the bottom right corner of
        the matrix (`True`) or top left (`False`).
1018

1019
1020
1021
1022
1023
    Returns
    ----------
    alibi_slopes: torch.Tensor
        ALiBi slopes in FP32 and shape [num_heads] or [batch_size, num_heads].
    alibi_bias: torch.Tensor
1024
1025
1026
1027
1028
1029
        ALiBi bias in FP32 or `bias_dtype`. Its shape is
        (1) [1, num_heads, max_seqlen_q, max_seqlen_kv] if `alibi_slopes` is in [num_heads] shape,
        and `actual_seqlens_q` and `actual_seqlens_kv` are `None`; or
        (2) [batch_size, num_heads, max_seqlen_q, max_seqlen_kv] if `alibi_slopes` is in
        [batch_size, num_heads] shape, or, if `alibi_slopes` is in [num_heads] shape and
        `actual_seqlens_q` and `actual_seqlens_kv` are not `None`.
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
    """
    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])
1055
        bias = torch.arange(max_seqlen_q, dtype=torch.int32, device="cuda").view(
1056
            1, 1, max_seqlen_q, 1
1057
1058
        ) - torch.arange(max_seqlen_kv, dtype=torch.int32, device="cuda").view(
            1, 1, 1, max_seqlen_kv
1059
        )
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
        if actual_seqlens_q is None and actual_seqlens_kv is None:
            if bottom_right_alignment:
                bias = bias + max_seqlen_kv - max_seqlen_q
        elif actual_seqlens_q is not None and actual_seqlens_kv is not None:
            batch_size = actual_seqlens_q.shape[0]
            bias = bias.expand(batch_size, 1, max_seqlen_q, max_seqlen_kv)
            if bottom_right_alignment:
                bias = bias + (actual_seqlens_kv - actual_seqlens_q).view(batch_size, 1, 1, 1)
        else:
            assert (
                False
            ), "actual_seqlens_q and actual_seqlens_kv need to be both None or torch.Tensors!"
1072
1073
1074
        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
1075
        _alibi_cache["_bottom_right_alignment"] = bottom_right_alignment
1076
1077
1078
1079
1080
        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"]
1081
1082
1083
1084
1085
1086
1087
1088
1089


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)
1090
    reduced_mask = mask.logical_not().sum(dim=1)
1091
1092
1093
1094
1095
1096
    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

1097

1098
1099
1100
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
1101
1102
1103
    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.
1104
1105
1106
1107
    """
    mask = mask.squeeze(1).squeeze(1)
    bs, seqlen = mask.shape

1108
    reduced_mask = mask.logical_not().sum(dim=1)
1109
1110
1111
1112
1113
    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)
1114
    indices = mask.logical_not().nonzero()
1115
1116
1117
1118
    indices = indices.unsqueeze(-1)

    num_nonzeros = indices.shape[0]
    pad_amount = bs * seqlen - num_nonzeros
1119
1120
1121
    indices = F.pad(
        input=indices, pad=(0, 0, 0, 0, 0, pad_amount), mode="constant", value=float(bs * seqlen)
    )
1122
1123
1124
1125

    return cu_seqlens, indices


1126
1127
1128
1129
1130
1131
1132
1133
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]
1134
1135
    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")
1136
1137
1138

    num_nonzeros = indices.shape[0]
    pad_amount = bs * max_seqlen - num_nonzeros
1139
1140
1141
1142
1143
1144
    indices = F.pad(
        input=indices,
        pad=(0, 0, 0, 0, 0, pad_amount),
        mode="constant",
        value=float(bs * max_seqlen),
    )
1145
1146
1147

    return indices

1148

1149
_cu_seqlens_cache = {}
1150
1151


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
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.

    """
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
    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)]
1172
1173


1174
@torch.compile
1175
1176
1177
1178
1179
1180
1181
1182
def pack_tensor(
    indices: torch.Tensor,
    tensor: torch.Tensor,
) -> torch.Tensor:
    """
    Packs the given tensor using the `indices`.
    """
    padding_indice = torch.zeros(
1183
1184
        1, tensor.shape[1], tensor.shape[2], dtype=tensor.dtype, device=tensor.device
    )
1185
    indices = indices.repeat(1, tensor.shape[1], tensor.shape[2])
1186
1187
1188
1189
1190
1191
1192
1193
    if isinstance(tensor, Float8Tensor):
        tensor_data = torch.cat((tensor._data, padding_indice), dim=0)

        packed = Float8Tensor.make_like(tensor, data=torch.gather(tensor_data, 0, indices))
    else:
        tensor = torch.cat((tensor, padding_indice), dim=0)

        packed = torch.gather(tensor, 0, indices)
1194
1195
1196
    return packed


1197
@torch.compile
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
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


1211
@torch.compile
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
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


1227
@torch.compile
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
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(
1238
1239
        dim0 + 1, tensor.shape[1], tensor.shape[2], dtype=tensor.dtype, device=tensor.device
    )
1240
1241
1242
1243
1244
1245
    if isinstance(tensor, Float8Tensor):
        unpacked.scatter_(0, indices, tensor._data)
        unpacked = Float8Tensor.make_like(tensor, data=unpacked[0:-1, :, :])
    else:
        unpacked.scatter_(0, indices, tensor)
        unpacked = unpacked[0:-1, :, :]
1246
1247
1248
    return unpacked


1249
@torch.compile
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
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


1264
@torch.compile
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
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.
    """
1285

1286
1287
    @staticmethod
    def forward(
1288
        ctx, indices: torch.Tensor, *tensors: Tuple[torch.Tensor, ...]
1289
1290
    ) -> Union[Tuple[torch.Tensor, ...], torch.Tensor]:
        assert 1 <= len(tensors) <= 3, f"Packing {len(tensors)} tensors not supported."
1291
        ctx.save_for_backward(indices)
1292
1293
1294
1295
1296
1297
1298
1299
1300
        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, ...]):
1301
        (indices,) = ctx.saved_tensors
1302
        if len(grad_outputs) == 1:
1303
            return None, unpack_tensor(indices, ctx.dim0, *grad_outputs)
1304
        if len(grad_outputs) == 2:
1305
1306
            return None, *unpack_2_tensors(indices, ctx.dim0, *grad_outputs)
        return None, *unpack_3_tensors(indices, ctx.dim0, *grad_outputs)
1307
1308
1309
1310
1311
1312


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

1314
1315
1316
1317
1318
1319
1320
    @staticmethod
    def forward(
        ctx,
        indices: torch.Tensor,
        dim0: int,
        tensor: torch.Tensor,
    ) -> torch.Tensor:
1321
        ctx.save_for_backward(indices)
1322
1323
1324
1325
        return unpack_tensor(indices, dim0, tensor)

    @staticmethod
    def backward(ctx, grad_output):
1326
1327
        (indices,) = ctx.saved_tensors
        return None, None, pack_tensor(indices, grad_output)
1328
1329


1330
1331
1332
def flash_attn_p2p_communicate(
    rank, send_tensor, send_dst, recv_tensor, recv_src, cp_group, batch_p2p_comm
):
1333
    """Point-to-point communications of KV and dKV in Attention with context parallelism"""
1334
1335
1336
1337
    send_recv_ops = []

    if batch_p2p_comm:
        if rank % 2 == 0:
1338
1339
1340
1341
1342
1343
            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
            )
1344
1345
1346
            send_recv_ops.append(send_op)
            send_recv_ops.append(recv_op)
        else:
1347
1348
1349
1350
1351
1352
            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
            )
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
            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


1372
@jit_fuser
1373
def flash_attn_fwd_out_correction(out, out_per_step, seq_dim, softmax_lse, softmax_lse_per_step):
1374
    """Merge partial outputs of each step in Attention with context parallelism"""
1375
    softmax_lse_corrected_exp = torch.exp(softmax_lse_per_step - softmax_lse).movedim(2, seq_dim)
1376
    softmax_lse_corrected_exp = softmax_lse_corrected_exp.unsqueeze(-1)
1377
    out_corrected = out_per_step * softmax_lse_corrected_exp
1378
1379
1380
    out.add_(out_corrected)


1381
@jit_fuser
1382
def flash_attn_fwd_softmax_lse_correction(softmax_lse, softmax_lse_per_step):
1383
    """Merge softmax stats of each step in Attention with context parallelism"""
1384
1385
1386
1387
    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)
1388
1389


1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
@jit_fuser
def get_cu_seqlens_on_cp_rank(
    cu_seqlens, cu_seqlens_padded_on_cp_rank, cp_size, cp_rank, first_half, second_half
):
    """Compute cu_seqlens of a context parallelism rank"""
    seqlens = cu_seqlens[1:] - cu_seqlens[:-1]
    seqlens_padded = (cu_seqlens_padded_on_cp_rank[1:] - cu_seqlens_padded_on_cp_rank[:-1]) // 2
    zeros = torch.zeros_like(seqlens)
    cu_seqlens_on_cp_rank = torch.zeros_like(cu_seqlens)
    if first_half:
        seqlens_1 = seqlens - cp_rank * seqlens_padded
        seqlens_1 = seqlens_1.clamp(zeros, seqlens_padded)
        cu_seqlens_on_cp_rank[1:].add_(seqlens_1)
    if second_half:
        seqlens_2 = seqlens - (2 * cp_size - cp_rank - 1) * seqlens_padded
        seqlens_2 = seqlens_2.clamp(zeros, seqlens_padded)
        cu_seqlens_on_cp_rank[1:].add_(seqlens_2)
    cu_seqlens_on_cp_rank.cumsum_(dim=0)
    return cu_seqlens_on_cp_rank


1411
class AttnFuncWithCPAndKVP2P(torch.autograd.Function):
1412
    """
1413
1414
1415
    Attention implementation with context parallelism. Exchange KV between CP ranks
    with P2P in ring topology. Split attention compute into multiple steps, and overlap
    current-step compute with next-step communication.
1416
1417
1418
    """

    @staticmethod
1419
1420
1421
1422
1423
1424
1425
    def forward(
        ctx,
        is_training,
        q,
        k,
        v,
        cu_seqlens_q,
1426
        cu_seqlens_kv,
1427
        max_seqlen_q,
1428
        max_seqlen_kv,
1429
1430
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
        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,
1442
1443
        fp8,
        fp8_meta,
1444
    ):
1445
1446
1447
1448
1449
1450
        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]
1451
        recv_src = cp_global_ranks[(rank - 1) % cp_size]
1452
1453
        batch_p2p_comm = int(os.getenv("NVTE_BATCH_MHA_P2P_COMM", "0")) or (cp_size == 2)

1454
1455
        causal = "causal" in attn_mask_type
        padding = "padding" in attn_mask_type
1456

1457
        if qkv_format in ["bshd", "sbhd"]:
1458
            seq_dim = qkv_format.index("s")
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
            qkv_layout = qkv_format + "_" + qkv_format[:-2] + "2" + qkv_format[-2:]
        else:
            qkv_layout = qkv_format + "_" + qkv_format + "_" + qkv_format

        pad_between_seqs_q = not torch.equal(cu_seqlens_q_padded, cu_seqlens_q)
        pad_between_seqs_kv = not torch.equal(cu_seqlens_kv_padded, cu_seqlens_kv)
        max_seqlen_q = max_seqlen_q // cp_size
        max_seqlen_kv = max_seqlen_kv // cp_size
        cu_seqlens_q_padded = cu_seqlens_q_padded // cp_size
        cu_seqlens_kv_padded = cu_seqlens_kv_padded // cp_size
        cu_seqlens_q_per_step = [None for _ in range(cp_size)]
        cu_seqlens_kv_per_step = [None for _ in range(cp_size)]
1471

1472
1473
1474
        assert qkv_format == "thd" or (
            q.shape[seq_dim] % 2 == 0 and k.shape[seq_dim] % 2 == 0
        ), "Sequence length per GPU needs to be divisible by 2!"
1475
        if causal:
1476
1477
            if qkv_format == "bshd":
                # [b, s, np, hn] -> [b, 2, s//2, np, hn]
1478
                q, k, v = [x.view(x.shape[0], 2, x.shape[1] // 2, *x.shape[2:]) for x in [q, k, v]]
1479
1480
            elif qkv_format == "sbhd":
                # [s, b, np, hn] -> [2, s//2, b, np, hn]
1481
                q, k, v = [x.view(2, x.shape[0] // 2, *x.shape[1:]) for x in [q, k, v]]
1482
1483
1484
        total_tokens_kv = None if qkv_format != "thd" else k.shape[0]
        # remove padded tokens at the end
        k, v = [x if qkv_format != "thd" else x[: cu_seqlens_kv_padded[-1]] for x in [k, v]]
1485
        if attn_bias is not None:
1486
            assert len(attn_bias.shape) == 4, (
1487
1488
1489
                "Only support bias shape of [b, h, sq, sk] for forward, "
                "and [1, h, sq, sk] for backward!"
            )
1490
1491
1492
            assert (
                attn_bias.shape[-2] % 2 == 0 and attn_bias.shape[-1] % (2 * cp_size) == 0
            ), "Sequence length does not meet divisible requirements!"
1493
            # [b, np, sq, sk] -> [b, np, 2, sq//2, 2*cp, sk//(2*cp)]
1494
1495
1496
1497
1498
1499
            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),
1500
1501
            )
            # [b, np, sq, sk] -> [b, np, sq, 2*cp, sk//(2*cp)]
1502
1503
            attn_bias = attn_bias.view(
                *attn_bias.shape[:-1], 2 * cp_size, attn_bias.shape[-1] // (2 * cp_size)
1504
            )
1505
        assert q.shape[-1] % 8 == 0, "hidden size per attention head should be multiple of 8"
1506
1507
        fa_optional_forward_kwargs = {}
        if _flash_attn_2_3_plus:
1508
            fa_optional_forward_kwargs["window_size"] = (-1, 0) if causal else (-1, -1)
1509
1510
        if _flash_attn_2_4_plus:
            fa_optional_forward_kwargs["alibi_slopes"] = None
1511
1512
        if _flash_attn_2_5_7_plus:
            fa_optional_forward_kwargs["block_table"] = None
1513

1514
1515
1516
        # Flash Attn inputs
        q_inputs = [None, None]
        kv_inputs = [None, None]
1517
        attn_bias_inputs = [None, None]
1518
1519
1520
1521
        # 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)]
1522
        attn_biases = [None for _ in range(cp_size)]
1523
1524
1525
1526
1527
1528

        # 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()

1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
        if fp8:
            if use_fused_attention:
                fp8_dtype_forward = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
                fused_attn_qkv_dtype = fp8_dtype_forward
                fused_attn_backend = FusedAttnBackend["FP8"]
                if fp8_meta["recipe"].fp8_mha:
                    assert (
                        isinstance(q, Float8Tensor)
                        and isinstance(k, Float8Tensor)
                        and isinstance(v, Float8Tensor)
                    ), "q/k/v must be Float8Tensors for FP8 MHA!"
                    fp8_meta["scaling_fwd"].scale_inv[META_QKV] = q._scale_inv
                    q_fp8, k_fp8, v_fp8 = q, k, v
                    q, k, v = q_fp8._data, k_fp8._data, v_fp8._data
                else:
                    q_f16, k_f16, v_f16 = q, k, v
                    q = cast_to_fp8(q_f16, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward)
                    if int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
                        k, v = [
                            cast_to_fp8(x, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward)
                            for x in [k_f16, v_f16]
                        ]
                fp8_meta_kwargs = {}
1552
1553
1554
1555
1556
1557
1558
1559
                fp8_meta_kwargs["d_scale_qkv"] = fp8_meta["scaling_fwd"].scale_inv
                fp8_meta_kwargs["d_scale_qkv_offset"] = META_QKV
                fp8_meta_kwargs["d_scale_s"] = fp8_meta["scaling_fwd"].scale_inv
                fp8_meta_kwargs["d_scale_s_offset"] = META_S
                fp8_meta_kwargs["q_scale_s"] = fp8_meta["scaling_fwd"].scale
                fp8_meta_kwargs["q_scale_s_offset"] = META_S
                fp8_meta_kwargs["q_scale_o"] = fp8_meta["scaling_fwd"].scale
                fp8_meta_kwargs["q_scale_o_offset"] = META_O_CP
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
                amax_per_step = torch.zeros((2, cp_size), dtype=torch.float32, device=q.device)
            else:
                assert False, "FP8 is only supported with Fused Attention!"
        else:
            q_f16 = q
            if use_fused_attention:
                fp8_meta_kwargs = {}
                fused_attn_qkv_dtype = TE_DType[q.dtype]
                fused_attn_backend = FusedAttnBackend["F16_arbitrary_seqlen"]

1570
        p2p_comm_buffers = [None for _ in range(cp_size)]
1571
1572
1573
1574
        if use_fused_attention and qkv_format in ["bshd", "sbhd"]:
            p2p_comm_buffers[0] = torch.cat((k.unsqueeze(-3), v.unsqueeze(-3)), dim=-3)
        else:
            p2p_comm_buffers[0] = torch.cat((k.unsqueeze(0), v.unsqueeze(0)), dim=0)
1575
1576
        send_recv_reqs = [[], []]

1577
        for i in range(cp_size + 1):
1578
            if i < cp_size:
1579
                with torch.cuda.stream(flash_attn_streams[i % 2]):
1580
                    # wait until KV is received
1581
                    for req in send_recv_reqs[(i + 1) % 2]:
1582
1583
                        req.wait()

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
                    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,
                        )

1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
                    if (
                        not fp8
                        or fp8_meta["recipe"].fp8_mha
                        or int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
                    ):
                        kv_inputs[i % 2] = p2p_comm_buffers[i]
                    else:
                        # KV exchange is in BF16/FP16, cast received KV in each step
                        kv_inputs[i % 2] = cast_to_fp8(
                            p2p_comm_buffers[i],
                            fp8_meta["scaling_fwd"],
                            META_QKV,
                            fp8_dtype_forward,
                        )
                    if fp8 and use_fused_attention:
1611
1612
1613
1614
                        fp8_meta_kwargs["amax_s"] = amax_per_step
                        fp8_meta_kwargs["amax_s_offset"] = i
                        fp8_meta_kwargs["amax_o"] = amax_per_step
                        fp8_meta_kwargs["amax_o_offset"] = cp_size + i
1615
1616
                    if causal:
                        if i == 0:
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
                            if pad_between_seqs_q:
                                cu_seqlens_q_per_step[i] = get_cu_seqlens_on_cp_rank(
                                    cu_seqlens_q, cu_seqlens_q_padded, cp_size, rank, True, True
                                )
                            else:
                                cu_seqlens_q_per_step[i] = cu_seqlens_q // cp_size
                            if pad_between_seqs_kv:
                                cu_seqlens_kv_per_step[i] = get_cu_seqlens_on_cp_rank(
                                    cu_seqlens_kv, cu_seqlens_kv_padded, cp_size, rank, True, True
                                )
                            else:
                                cu_seqlens_kv_per_step[i] = cu_seqlens_kv // cp_size
1629
                            if use_fused_attention:
1630
1631
                                if qkv_format == "bshd":
                                    # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
1632
                                    q_inputs[i % 2] = q.view(q.shape[0], -1, *q.shape[-2:])
1633
                                    # [b, 2, sk//2, 2, np, hn] -> [b, sk, 2, np, hn]
1634
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(
1635
                                        k.shape[0], -1, 2, *k.shape[-2:]
1636
                                    )
1637
1638
                                elif qkv_format == "sbhd":
                                    # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
1639
                                    q_inputs[i % 2] = q.view(-1, *q.shape[-3:])
1640
1641
1642
1643
                                    # [2, sk//2, b, 2, np, hn] -> [sk, b, 2, np, hn]
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(
                                        -1, k.shape[2], 2, *k.shape[-2:]
                                    )
1644
                                elif qkv_format == "thd":
1645
                                    q_inputs[i % 2] = q
1646
1647
                                if attn_bias is not None:
                                    idx = (rank - i) % cp_size
1648
1649
1650
1651
1652
1653
                                    attn_bias_inputs[i % 2] = torch.cat(
                                        (
                                            attn_bias[..., idx, :],
                                            attn_bias[..., (2 * cp_size - idx - 1), :],
                                        ),
                                        dim=-1,
1654
                                    ).contiguous()
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
                                out_per_step[i], aux_ctx_tensors = fused_attn_fwd(
                                    is_training,
                                    max_seqlen_q,
                                    max_seqlen_kv,
                                    cu_seqlens_q_per_step[i],
                                    cu_seqlens_kv_per_step[i],
                                    q_inputs[i % 2],
                                    (
                                        kv_inputs[i % 2][..., 0, :, :]
                                        if qkv_format in ["bshd", "sbhd"]
                                        else kv_inputs[i % 2][0]
                                    ),
                                    (
                                        kv_inputs[i % 2][..., 1, :, :]
                                        if qkv_format in ["bshd", "sbhd"]
                                        else kv_inputs[i % 2][1]
                                    ),
                                    fused_attn_qkv_dtype,
                                    fused_attn_backend,
                                    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],
                                    cu_seqlens_q_padded=cu_seqlens_q_padded,
                                    cu_seqlens_kv_padded=cu_seqlens_kv_padded,
                                    **fp8_meta_kwargs,
1683
                                )
1684
1685
1686
1687
1688
                                if fp8:
                                    softmax_lse_per_step[i], _, rng_states[i] = aux_ctx_tensors
                                else:
                                    softmax_lse_per_step[i], rng_states[i], *rest = aux_ctx_tensors
                                    attn_biases[i] = rest[0] if len(rest) > 0 else None
1689
1690
                            else:
                                # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
1691
                                q_inputs[i % 2] = q.view(-1, *q.shape[-2:])
1692
                                # [2, b, 2, sk//2, np, hn] -> [2, b*sk, np, hn]
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
                                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],
1707
1708
                                    cu_seqlens_q_per_step[i],
                                    cu_seqlens_kv_per_step[i],
1709
                                    max_seqlen_q,
1710
                                    max_seqlen_kv,
1711
1712
1713
1714
1715
                                    dropout_p,
                                    softmax_scale,
                                    causal=True,
                                    return_softmax=False,
                                    **fa_optional_forward_kwargs,
1716
                                )
1717
                        elif i <= rank:
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
                            if pad_between_seqs_q:
                                cu_seqlens_q_per_step[i] = get_cu_seqlens_on_cp_rank(
                                    cu_seqlens_q, cu_seqlens_q_padded, cp_size, rank, True, True
                                )
                            else:
                                cu_seqlens_q_per_step[i] = cu_seqlens_q // cp_size
                            if pad_between_seqs_kv:
                                cu_seqlens_kv_per_step[i] = get_cu_seqlens_on_cp_rank(
                                    cu_seqlens_kv,
                                    cu_seqlens_kv_padded,
                                    cp_size,
                                    (rank - i) % cp_size,
                                    True,
                                    False,
                                )
                            else:
                                cu_seqlens_kv_per_step[i] = cu_seqlens_kv // (cp_size * 2)
1735
                            if use_fused_attention:
1736
1737
                                if qkv_format == "bshd":
                                    # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
1738
                                    q_inputs[i % 2] = q.view(q.shape[0], -1, *q.shape[-2:])
1739
1740
                                    # [b, 2, sk//2, 2, np, hn] -> [b, sk//2, 2, np, hn]
                                    kv_inputs[i % 2] = kv_inputs[i % 2][:, 0, ...].contiguous()
1741
1742
                                elif qkv_format == "sbhd":
                                    # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
1743
                                    q_inputs[i % 2] = q.view(-1, *q.shape[-3:])
1744
1745
                                    # [2, sk//2, b, 2, np, hn] -> [sk//2, b, 2, np, hn]
                                    kv_inputs[i % 2] = kv_inputs[i % 2][0].contiguous()
1746
                                elif qkv_format == "thd":
1747
                                    q_inputs[i % 2] = q
1748
                                    # [2, t, np, hn] -> [2, t/2, np, hn]
1749
                                    kv_inputs[i % 2] = tex.thd_read_half_tensor(
1750
                                        kv_inputs[i % 2], cu_seqlens_kv_padded, 0
1751
                                    )
1752
1753
                                if attn_bias is not None:
                                    idx = (rank - i) % cp_size
1754
                                    attn_bias_inputs[i % 2] = attn_bias[..., idx, :].contiguous()
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
                                out_per_step[i], aux_ctx_tensors = fused_attn_fwd(
                                    is_training,
                                    max_seqlen_q,
                                    max_seqlen_kv // 2,
                                    cu_seqlens_q_per_step[i],
                                    cu_seqlens_kv_per_step[i],
                                    q_inputs[i % 2],
                                    (
                                        kv_inputs[i % 2][..., 0, :, :]
                                        if qkv_format in ["bshd", "sbhd"]
                                        else kv_inputs[i % 2][0]
                                    ),
                                    (
                                        kv_inputs[i % 2][..., 1, :, :]
                                        if qkv_format in ["bshd", "sbhd"]
                                        else kv_inputs[i % 2][1]
                                    ),
                                    fused_attn_qkv_dtype,
                                    fused_attn_backend,
                                    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],
                                    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
                                    ),
                                    **fp8_meta_kwargs,
1787
                                )
1788
1789
1790
1791
1792
                                if fp8:
                                    softmax_lse_per_step[i], _, rng_states[i] = aux_ctx_tensors
                                else:
                                    softmax_lse_per_step[i], rng_states[i], *rest = aux_ctx_tensors
                                    attn_biases[i] = rest[0] if len(rest) > 0 else None
1793
1794
                            else:
                                # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
1795
                                q_inputs[i % 2] = q.view(-1, *q.shape[-2:])
1796
1797
                                if qkv_format == "thd":
                                    # [2, t, np, hn] -> [2, t/2, np, hn]
1798
                                    kv_inputs[i % 2] = tex.thd_read_half_tensor(
1799
                                        kv_inputs[i % 2], cu_seqlens_kv_padded, 0
1800
                                    )
1801
1802
                                else:
                                    # [2, b, 2, sk//2, np, hn] -> [2, b, sk//2, np, hn]
1803
                                    kv_inputs[i % 2] = kv_inputs[i % 2][:, :, 0, ...].contiguous()
1804
                                # [2, b, sk//2, np, hn] -> [2, b*sk//2, np, hn]
1805
                                kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-2:])
1806
                                if _flash_attn_2_3_plus:
1807
                                    fa_optional_forward_kwargs["window_size"] = (-1, -1)
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
                                (
                                    _,
                                    _,
                                    _,
                                    _,
                                    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],
1821
1822
                                    cu_seqlens_q_per_step[i],
                                    cu_seqlens_kv_per_step[i],
1823
                                    max_seqlen_q,
1824
                                    max_seqlen_kv // 2,
1825
1826
1827
1828
1829
                                    dropout_p,
                                    softmax_scale,
                                    causal=False,
                                    return_softmax=False,
                                    **fa_optional_forward_kwargs,
1830
1831
                                )
                        else:
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
                            if pad_between_seqs_q:
                                cu_seqlens_q_per_step[i] = get_cu_seqlens_on_cp_rank(
                                    cu_seqlens_q, cu_seqlens_q_padded, cp_size, rank, False, True
                                )
                            else:
                                cu_seqlens_q_per_step[i] = cu_seqlens_q // (cp_size * 2)
                            if pad_between_seqs_kv:
                                cu_seqlens_kv_per_step[i] = get_cu_seqlens_on_cp_rank(
                                    cu_seqlens_kv,
                                    cu_seqlens_kv_padded,
                                    cp_size,
                                    (rank - i) % cp_size,
                                    True,
                                    True,
                                )
                            else:
                                cu_seqlens_kv_per_step[i] = cu_seqlens_kv // cp_size
1849
                            if use_fused_attention:
1850
1851
                                if qkv_format == "bshd":
                                    # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
1852
                                    q_inputs[i % 2] = q[:, 1, ...].contiguous()
1853
                                    # [b, 2, sk//2, 2, np, hn] -> [b, sk, 2, np, hn]
1854
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(
1855
                                        k.shape[0], -1, 2, *k.shape[-2:]
1856
                                    )
1857
1858
                                elif qkv_format == "sbhd":
                                    # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
1859
                                    q_inputs[i % 2] = q[1].contiguous()
1860
1861
1862
1863
                                    # [2, sk//2, b, 2, np, hn] -> [sk, b, 2, np, hn]
                                    kv_inputs[i % 2] = kv_inputs[i % 2].view(
                                        -1, k.shape[2], 2, *k.shape[-2:]
                                    )
1864
1865
                                elif qkv_format == "thd":
                                    # [t, np, hn] -> [t/2, np, hn]
1866
1867
1868
                                    q_inputs[i % 2] = tex.thd_read_half_tensor(
                                        q, cu_seqlens_q_padded, 1
                                    )
1869
1870
                                if attn_bias is not None:
                                    idx = (rank - i) % cp_size
1871
1872
1873
1874
1875
1876
                                    attn_bias_inputs[i % 2] = torch.cat(
                                        (
                                            attn_bias_[..., 1, :, idx, :],
                                            attn_bias_[..., 1, :, (2 * cp_size - idx - 1), :],
                                        ),
                                        dim=-1,
1877
                                    ).contiguous()
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
                                out_per_step[i], aux_ctx_tensors = fused_attn_fwd(
                                    is_training,
                                    max_seqlen_q // 2,
                                    max_seqlen_kv,
                                    cu_seqlens_q_per_step[i],
                                    cu_seqlens_kv_per_step[i],
                                    q_inputs[i % 2],
                                    (
                                        kv_inputs[i % 2][..., 0, :, :]
                                        if qkv_format in ["bshd", "sbhd"]
                                        else kv_inputs[i % 2][0]
                                    ),
                                    (
                                        kv_inputs[i % 2][..., 1, :, :]
                                        if qkv_format in ["bshd", "sbhd"]
                                        else kv_inputs[i % 2][1]
                                    ),
                                    fused_attn_qkv_dtype,
                                    fused_attn_backend,
                                    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],
                                    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,
                                    **fp8_meta_kwargs,
1910
                                )
1911
1912
1913
1914
1915
                                if fp8:
                                    softmax_lse_per_step[i], _, rng_states[i] = aux_ctx_tensors
                                else:
                                    softmax_lse_per_step[i], rng_states[i], *rest = aux_ctx_tensors
                                    attn_biases[i] = rest[0] if len(rest) > 0 else None
1916
                            else:
1917
1918
                                if qkv_format == "thd":
                                    # [t, np, hn] -> [t/2, np, hn]
1919
1920
1921
                                    q_inputs[i % 2] = tex.thd_read_half_tensor(
                                        q, cu_seqlens_q_padded, 1
                                    )
1922
1923
                                else:
                                    # [b, 2, sq//2, np, hn]->[b, sq//2, np, hn]->[b*sq//2, np, hn]
1924
                                    q_inputs[i % 2] = (
1925
                                        q[:, 1, ...].contiguous().view(-1, *q.shape[-2:])
1926
                                    )
1927
                                # [2, b, 2, sk//2, np, hn] -> [2, b*sk, np, hn]
1928
                                kv_inputs[i % 2] = kv_inputs[i % 2].view(2, -1, *k.shape[-2:])
1929
                                if _flash_attn_2_3_plus:
1930
                                    fa_optional_forward_kwargs["window_size"] = (-1, -1)
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
                                (
                                    _,
                                    _,
                                    _,
                                    _,
                                    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],
1944
1945
                                    cu_seqlens_q_per_step[i],
                                    cu_seqlens_kv_per_step[i],
1946
                                    max_seqlen_q // 2,
1947
                                    max_seqlen_kv,
1948
1949
1950
1951
1952
                                    dropout_p,
                                    softmax_scale,
                                    causal=False,
                                    return_softmax=False,
                                    **fa_optional_forward_kwargs,
1953
1954
                                )
                    else:
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
                        if pad_between_seqs_q:
                            cu_seqlens_q_per_step[i] = get_cu_seqlens_on_cp_rank(
                                cu_seqlens_q, cu_seqlens_q_padded, cp_size, rank, True, True
                            )
                        else:
                            cu_seqlens_q_per_step[i] = cu_seqlens_q // cp_size
                        if pad_between_seqs_kv:
                            cu_seqlens_kv_per_step[i] = get_cu_seqlens_on_cp_rank(
                                cu_seqlens_kv,
                                cu_seqlens_kv_padded,
                                cp_size,
                                (rank - i) % cp_size,
                                True,
                                True,
                            )
                        else:
                            cu_seqlens_kv_per_step[i] = cu_seqlens_kv // cp_size
1972
                        if use_fused_attention:
1973
1974
                            if attn_bias is not None:
                                idx = (rank - i) % cp_size
1975
1976
1977
1978
1979
1980
                                attn_bias_inputs[i % 2] = torch.cat(
                                    (
                                        attn_bias[..., idx, :],
                                        attn_bias[..., (2 * cp_size - idx - 1), :],
                                    ),
                                    dim=-1,
1981
                                ).contiguous()
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
                            out_per_step[i], aux_ctx_tensors = fused_attn_fwd(
                                is_training,
                                max_seqlen_q,
                                max_seqlen_kv,
                                cu_seqlens_q_per_step[i],
                                cu_seqlens_kv_per_step[i],
                                q,
                                (
                                    kv_inputs[i % 2][..., 0, :, :]
                                    if qkv_format in ["bshd", "sbhd"]
                                    else kv_inputs[i % 2][0]
                                ),
                                (
                                    kv_inputs[i % 2][..., 1, :, :]
                                    if qkv_format in ["bshd", "sbhd"]
                                    else kv_inputs[i % 2][1]
                                ),
                                fused_attn_qkv_dtype,
                                fused_attn_backend,
                                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],
                                cu_seqlens_q_padded=cu_seqlens_q_padded,
                                cu_seqlens_kv_padded=cu_seqlens_kv_padded,
                                **fp8_meta_kwargs,
2010
                            )
2011
2012
2013
2014
2015
                            if fp8:
                                softmax_lse_per_step[i], _, rng_states[i] = aux_ctx_tensors
                            else:
                                softmax_lse_per_step[i], rng_states[i], *rest = aux_ctx_tensors
                                attn_biases[i] = rest[0] if len(rest) > 0 else None
2016
                        else:
2017
                            # [b, sq, np, hn] -> [b*sq, np, hn]
2018
                            q_inputs[i % 2] = q.view(-1, *q.shape[-2:])
2019
                            # [2, b, sk, np, hn] -> [2, b*sk, np, hn]
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
                            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],
2034
2035
                                cu_seqlens_q_per_step[i],
                                cu_seqlens_kv_per_step[i],
2036
                                max_seqlen_q,
2037
                                max_seqlen_kv,
2038
2039
2040
2041
2042
                                dropout_p,
                                softmax_scale,
                                causal=False,
                                return_softmax=False,
                                **fa_optional_forward_kwargs,
2043
                            )
2044
2045
2046
2047

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

2050
2051
                if use_fused_attention:
                    # [b, np, sq, 1] -> [b, np, sq]
2052
                    softmax_lse_per_step[i - 1].squeeze_(-1)
2053

2054
                with torch.cuda.stream(flash_attn_streams[(i - 1) % 2]):
2055
2056
2057
2058
2059
2060
2061
2062
                    if fp8:
                        out_per_step[i - 1] = cast_from_fp8(
                            out_per_step[i - 1],
                            fp8_meta["scaling_fwd"],
                            META_O_CP,
                            fp8_dtype_forward,
                            TE_DType[torch.float32],
                        )
2063
                    if i == 1:
2064
                        out = torch.zeros_like(q if not fp8 else out_per_step[0]).view(q.shape)
2065
                        softmax_lse = torch.clone(softmax_lse_per_step[0]).to(torch.double)
2066
                        if causal and qkv_format != "thd":
2067
2068
                            # [b, np, sq] -> [b, np, 2, sq//2]
                            softmax_lse_ = softmax_lse.view(
2069
                                *softmax_lse.shape[:-1], 2, softmax_lse.shape[-1] // 2
2070
                            )
2071
2072
2073
2074
                    elif (i - 1) <= rank or not causal:
                        flash_attn_fwd_softmax_lse_correction(
                            softmax_lse, softmax_lse_per_step[i - 1]
                        )
2075
                    else:
2076
                        if qkv_format == "thd":
2077
                            tex.thd_second_half_lse_correction(
2078
2079
2080
2081
                                softmax_lse,
                                softmax_lse_per_step[i - 1],
                                cu_seqlens_q_padded,
                                max_seqlen_q,
2082
                            )
2083
                        else:
2084
2085
2086
                            flash_attn_fwd_softmax_lse_correction(
                                softmax_lse_[..., 1, :], softmax_lse_per_step[i - 1]
                            )
2087
2088

                if i < cp_size:
2089
                    flash_attn_streams[(i - 1) % 2].record_event(fwd_results_correction_done)
2090
2091
2092
2093
2094

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

        softmax_lse = softmax_lse.to(torch.float)
        for i in range(cp_size):
2095
2096
2097
2098
2099
2100
            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]
2101

2102
            if i <= rank or not causal:
2103
                if qkv_format in ["bshd", "sbhd"]:
2104
2105
2106
2107
2108
2109
2110
                    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],
                    )
2111
                elif qkv_format == "thd":
2112
2113
2114
2115
2116
                    tex.thd_out_correction(
                        out,
                        out_per_step[i],
                        softmax_lse,
                        softmax_lse_per_step[i],
2117
                        cu_seqlens_q_padded,
2118
2119
                        False,
                    )
2120
            else:
2121
                if qkv_format in ["bshd", "sbhd"]:
2122
2123
2124
2125
2126
2127
2128
                    flash_attn_fwd_out_correction(
                        out_,
                        out_per_step[i],
                        seq_dim,
                        softmax_lse_[..., 1, :],
                        softmax_lse_per_step[i],
                    )
2129
                elif qkv_format == "thd":
2130
2131
2132
2133
2134
                    tex.thd_out_correction(
                        out,
                        out_per_step[i],
                        softmax_lse,
                        softmax_lse_per_step[i],
2135
                        cu_seqlens_q_padded,
2136
2137
                        True,
                    )
2138
2139

        kv = p2p_comm_buffers[-1]
2140
        if use_fused_attention:
2141
2142
2143
2144
            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:])
2145
2146
        else:
            out = out.view(-1, *out.shape[-2:])
2147

2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
        if fp8 and use_fused_attention:
            amax_cp_fwd = amax_per_step.amax(dim=1)
            fp8_meta["scaling_fwd"].amax_history[0][META_S] = amax_cp_fwd[0]
            fp8_meta["scaling_fwd"].amax_history[0][META_O_CP] = amax_cp_fwd[1]

        out_f16 = out.to(q_fp8.dtype if fp8 and fp8_meta["recipe"].fp8_mha else q_f16.dtype)
        if fp8 and (fp8_meta["recipe"].fp8_mha or int(os.getenv("NVTE_FP8_DPA_BWD", "1"))):
            out_fp8 = cast_to_fp8(out_f16, fp8_meta["scaling_fwd"], META_O, fp8_dtype_forward)

        if fp8 and fp8_meta["recipe"].fp8_mha:
            out_ret = Float8Tensor(
                data=out_fp8,
                fp8_meta=fp8_meta,
                fp8_meta_forward=True,
                fp8_meta_index=META_O,
                fp8_dtype=fp8_dtype_forward,
                dtype=q_fp8.dtype,
            )
        else:
            out_ret = out_f16

        if fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
            q_save, kv_save, out_save = q, kv, out_fp8
            fp8_fwd_scales = fp8_meta["scaling_fwd"].scale.clone()
            fp8_fwd_scale_invs = fp8_meta["scaling_fwd"].scale_inv.clone()
        elif fp8 and fp8_meta["recipe"].fp8_mha:
            kv_fp8 = Float8Tensor(
                data=kv,
                fp8_meta=fp8_meta,
                fp8_meta_forward=True,
                fp8_meta_index=META_QKV,
                fp8_dtype=fp8_dtype_forward,
                dtype=k_fp8.dtype,
            )
            q_save, kv_save, out_save = q_fp8, kv_fp8, out_f16
            fp8_fwd_scales, fp8_fwd_scale_invs = None, None
        else:
            q_save, kv_save, out_save = q_f16, kv, out_f16
            fp8_fwd_scales, fp8_fwd_scale_invs = None, None

2188
        ctx.save_for_backward(
2189
2190
2191
            q_save,
            kv_save,
            out_save,
2192
            softmax_lse,
2193
2194
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
2195
2196
            fp8_fwd_scales,
            fp8_fwd_scale_invs,
2197
2198
            *cu_seqlens_q_per_step,
            *cu_seqlens_kv_per_step,
2199
2200
            *rng_states,
            *attn_biases,
2201
        )
2202
2203
2204
        ctx.cp_group = cp_group
        ctx.cp_global_ranks = cp_global_ranks
        ctx.dropout_p = dropout_p
2205
        ctx.total_tokens_kv = total_tokens_kv
2206
        ctx.max_seqlen_q = max_seqlen_q
2207
        ctx.max_seqlen_kv = max_seqlen_kv
2208
        ctx.softmax_scale = softmax_scale
2209
        ctx.qkv_format = qkv_format
2210
        ctx.attn_mask_type = attn_mask_type
2211
2212
        ctx.attn_bias_type = attn_bias_type
        ctx.attn_bias_shape = None if attn_bias is None else attn_bias.shape
2213
        ctx.deterministic = deterministic
2214
        ctx.use_fused_attention = use_fused_attention
2215
2216
2217
        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
        ctx.fp8_meta = fp8_meta
        return out_ret
2218
2219
2220
2221
2222

    @staticmethod
    def backward(ctx, dout):
        cp_size = get_distributed_world_size(ctx.cp_group)
        rank = get_distributed_rank(ctx.cp_group)
2223
        send_dst = ctx.cp_global_ranks[(rank - 1) % cp_size]
2224
2225
2226
        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)

2227
        (q, kv, out, softmax_lse, cu_seqlens_q_padded, cu_seqlens_kv_padded) = ctx.saved_tensors[:6]
2228
2229
2230
2231
2232
        (fp8_fwd_scales, fp8_fwd_scale_invs) = ctx.saved_tensors[6:8]
        cu_seqlens_q_per_step = ctx.saved_tensors[8 : 8 + cp_size]
        cu_seqlens_kv_per_step = ctx.saved_tensors[8 + cp_size : 8 + cp_size * 2]
        rng_states = ctx.saved_tensors[8 + cp_size * 2 : 8 + cp_size * 3]
        attn_biases = ctx.saved_tensors[8 + cp_size * 3 : 8 + cp_size * 4]
2233

2234
2235
        causal = "causal" in ctx.attn_mask_type
        padding = "padding" in ctx.attn_mask_type
2236
2237
2238
2239
        if ctx.qkv_format in ["bshd", "sbhd"]:
            qkv_layout = ctx.qkv_format + "_" + ctx.qkv_format[:-2] + "2" + ctx.qkv_format[-2:]
        else:
            qkv_layout = ctx.qkv_format + "_" + ctx.qkv_format + "_" + ctx.qkv_format
2240

2241
        if attn_biases[0] is not None:
2242
2243
            # [b, np, sq, 2*cp, sk//(2*cp)]
            attn_dbias = torch.zeros(
2244
                *ctx.attn_bias_shape, dtype=attn_biases[0].dtype, device=attn_biases[0].device
2245
2246
2247
            )
            # [b, np, sq, 2*cp, sk//(2*cp)] -> [b, np, 2, sq//2, 2*cp, sk//(2*cp)]
            attn_dbias_ = attn_dbias.view(
2248
                *attn_dbias.shape[:-3], 2, attn_dbias.shape[-3] // 2, *attn_dbias.shape[-2:]
2249
2250
2251
2252
            )
        else:
            attn_dbias = None

2253
        if causal:
2254
            if ctx.qkv_format == "thd":
2255
2256
2257
                softmax_lse_ = tex.thd_read_second_half_lse(
                    softmax_lse, cu_seqlens_q_padded, ctx.max_seqlen_q
                )
2258
2259
            else:
                # [b, np, sq] -> [b, np, 2, sq//2]
2260
2261
2262
                softmax_lse_ = softmax_lse.view(
                    *softmax_lse.shape[:-1], 2, softmax_lse.shape[-1] // 2
                )
2263
2264
2265
2266
                softmax_lse_ = softmax_lse_[..., 1, :].contiguous()
                if ctx.use_fused_attention:
                    # [b, np, sq//2] -> [b, np, sq//2, 1]
                    softmax_lse_.unsqueeze_(-1)
2267
2268
2269
        if ctx.use_fused_attention:
            # [b, np, sq] -> [b, np, sq, 1]
            softmax_lse.unsqueeze_(-1)
2270
2271
2272

        if ctx.fp8:
            if ctx.use_fused_attention:
2273
                fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
2274
                fp8_dtype_backward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=False)
2275
                fused_attn_qkv_dtype = fp8_dtype_forward
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
                fused_attn_dqkv_dtype = fp8_dtype_backward
                fused_attn_backend = FusedAttnBackend["FP8"]
                dq_fp8 = torch.empty((cp_size, *q.shape), dtype=q.dtype, device=q.device)
                dkv_fp8 = torch.empty((cp_size, *kv.shape), dtype=kv.dtype, device=kv.device)
                dkv_fp8_ = torch.empty_like(dkv_fp8)
                dout_dtype = dout.dtype
                if ctx.fp8_meta["recipe"].fp8_mha:
                    assert isinstance(dout, Float8Tensor), "dout must be Float8Tensors for FP8 MHA!"
                    ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = dout._scale_inv
                    dout = dout._data
                else:
                    dout = cast_to_fp8(
                        dout, ctx.fp8_meta["scaling_bwd"], META_DO, fp8_dtype_backward
                    )
                p2p_comm_buffers = [[kv, dkv_fp8], [torch.empty_like(kv), dkv_fp8_]]
                fp8_meta_kwargs = {}
                fp8_meta_kwargs["d_scale_qkv"] = fp8_fwd_scale_invs[META_QKV]
                fp8_meta_kwargs["d_scale_s"] = fp8_fwd_scale_invs[META_S]
                fp8_meta_kwargs["d_scale_o"] = fp8_fwd_scale_invs[META_O]
                fp8_meta_kwargs["d_scale_do"] = ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO]
                fp8_meta_kwargs["d_scale_dp"] = ctx.fp8_meta["scaling_bwd"].scale_inv[META_DP]
                fp8_meta_kwargs["q_scale_s"] = fp8_fwd_scales[META_S]
                fp8_meta_kwargs["q_scale_dp"] = ctx.fp8_meta["scaling_bwd"].scale[META_DP]
                fp8_meta_kwargs["q_scale_dqkv"] = ctx.fp8_meta["scaling_bwd"].scale[META_DQKV_CP]
                amax_per_step = torch.zeros((2, cp_size), dtype=torch.float32, device=q.device)
            else:
                assert False, "FP8 is only supported with Fused Attention!"
        else:
            if ctx.fp8_meta is not None and ctx.fp8_meta["recipe"].fp8_mha:
                q, kv, dout = [x.from_float8(x.dtype) for x in [q, kv, dout]]
            dq = torch.empty_like(q)
            if ctx.qkv_format == "thd" and causal:
                dq[cu_seqlens_q_padded[-1] :].fill_(0)
            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),
            ]
            p2p_comm_buffers[0][0].copy_(kv)
            if ctx.use_fused_attention:
                fp8_meta_kwargs = {}
                fused_attn_qkv_dtype = TE_DType[q.dtype]
2317
                fused_attn_dqkv_dtype = TE_DType[dout.dtype]
2318
2319
                fused_attn_backend = FusedAttnBackend["F16_arbitrary_seqlen"]

2320
2321
2322
2323
        out = out.view(*q.shape)
        dout = dout.view(*q.shape)
        send_recv_reqs = []

2324
2325
2326
2327
2328
2329
        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

2330
2331
2332
2333
2334
        for i in range(cp_size):
            # wait until KV is received
            for req in send_recv_reqs:
                req.wait()

2335
2336
            send_tensor = p2p_comm_buffers[i % 2]
            recv_tensor = p2p_comm_buffers[(i + 1) % 2]
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
            if ctx.fp8:
                if i < cp_size - 1:
                    send_recv_reqs = flash_attn_p2p_communicate(
                        rank,
                        send_tensor[0],
                        send_dst,
                        recv_tensor[0],
                        recv_src,
                        ctx.cp_group,
                        batch_p2p_comm,
                    )
                else:
                    dkv_a2a_req = torch.distributed.all_to_all_single(
                        dkv_fp8,
                        dkv_fp8_,
                        group=ctx.cp_group,
                        async_op=True,
                    )
                    send_recv_reqs = [dkv_a2a_req]
            else:
                if i == 0:
                    send_tensor = send_tensor[0]
                    recv_tensor = recv_tensor[0]
                if i == (cp_size - 1):
                    send_tensor = send_tensor[1]
                    recv_tensor = recv_tensor[1]
                send_recv_reqs = flash_attn_p2p_communicate(
                    rank, send_tensor, send_dst, recv_tensor, recv_src, ctx.cp_group, batch_p2p_comm
                )
2366

2367
            kv = p2p_comm_buffers[i % 2][0]
2368
2369
2370
            if ctx.fp8 and ctx.use_fused_attention:
                fp8_meta_kwargs["amax_dp"] = amax_per_step[0][i]
                fp8_meta_kwargs["amax_dqkv"] = amax_per_step[0][i]
2371
            # In reversed order of fwd
2372
            if causal:
2373
                if i == (cp_size - 1):
2374
                    if ctx.use_fused_attention:
2375
2376
2377
                        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:])
2378
2379
                            # [b, 2, sk//2, 2, np, hn] -> [b, sk, 2, np, hn]
                            kv_ = kv.view(kv.shape[0], -1, *kv.shape[-3:])
2380
2381
2382
2383
2384
2385
                            # [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:])
2386
2387
                            # [2, sk//2, b, 2, np, hn] -> [sk, b, 2, np, hn]
                            kv_ = kv.view(-1, *kv.shape[-4:])
2388
2389
2390
                            # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                            out_ = out.view(-1, *out.shape[-3:])
                            dout_ = dout.view(-1, *dout.shape[-3:])
2391
2392
                        elif ctx.qkv_format == "thd":
                            q_, kv_, out_, dout_ = q, kv, out, dout
2393
2394
2395
2396
2397
2398
2399
2400
                        if ctx.fp8:
                            aux_ctx_tensors = [
                                softmax_lse,
                                softmax_lse,
                                rng_states[cp_size - i - 1],
                            ]
                        else:
                            aux_ctx_tensors = [softmax_lse, rng_states[cp_size - i - 1]]
2401
                        if attn_dbias is not None:
2402
                            aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
2403
                        dq_, dk_, dv_, dbias_ = fused_attn_bwd(
2404
                            ctx.max_seqlen_q,
2405
2406
2407
                            ctx.max_seqlen_kv,
                            cu_seqlens_q_per_step[cp_size - i - 1],
                            cu_seqlens_kv_per_step[cp_size - i - 1],
2408
                            q_,
2409
2410
                            kv_[..., 0, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv_[0],
                            kv_[..., 1, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv_[1],
2411
2412
                            out_,
                            dout_,
2413
2414
                            fused_attn_qkv_dtype,
                            fused_attn_dqkv_dtype,
2415
                            aux_ctx_tensors,
2416
                            fused_attn_backend,
2417
2418
                            cu_seqlens_q_padded=cu_seqlens_q_padded,
                            cu_seqlens_kv_padded=cu_seqlens_kv_padded,
2419
2420
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
2421
                            qkv_layout=qkv_layout,
2422
                            attn_mask_type=ctx.attn_mask_type,
2423
                            attn_bias_type=ctx.attn_bias_type,
2424
2425
                            deterministic=ctx.deterministic,
                            **fp8_meta_kwargs,
2426
2427
2428
2429
                        )
                    else:
                        # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
                        q_ = q.view(-1, *q.shape[-2:])
2430
                        dq_ = torch.zeros_like(q_)
2431
2432
2433
2434
2435
2436
2437
                        # [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:
2438
                            fa_optional_backward_kwargs["window_size"] = (-1, 0)
2439
                        _flash_attn_backward(
2440
2441
2442
2443
2444
2445
2446
2447
2448
                            dout_,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            softmax_lse,
                            dq_,
                            dkv_[0],
                            dkv_[1],
2449
2450
                            cu_seqlens_q_per_step[cp_size - i - 1],
                            cu_seqlens_kv_per_step[cp_size - i - 1],
2451
                            ctx.max_seqlen_q,
2452
                            ctx.max_seqlen_kv,
2453
2454
2455
2456
2457
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            True,
                            rng_state=rng_states[cp_size - i - 1],
                            **fa_optional_backward_kwargs,
2458
                        )
2459
                elif i >= (cp_size - rank - 1):
2460
                    if ctx.use_fused_attention:
2461
2462
2463
                        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:])
2464
2465
                            # [b, 2, sk//2, 2, np, hn] -> [b, sk//2, 2, np, hn]
                            kv_ = kv[:, 0, ...].contiguous()
2466
2467
2468
2469
2470
2471
                            # [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:])
2472
2473
                            # [2, sk//2, b, 2, np, hn] -> [sk//2, b, 2, np, hn]
                            kv_ = kv[0].contiguous()
2474
2475
2476
                            # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
                            out_ = out.view(-1, *out.shape[-3:])
                            dout_ = dout.view(-1, *dout.shape[-3:])
2477
2478
2479
                        elif ctx.qkv_format == "thd":
                            q_, out_, dout_ = q, out, dout
                            # [2, t, np, hn] -> [2, t/2, np, hn]
2480
                            kv_ = tex.thd_read_half_tensor(kv, cu_seqlens_kv_padded, 0)
2481
2482
2483
2484
2485
2486
2487
2488
                        if ctx.fp8:
                            aux_ctx_tensors = [
                                softmax_lse,
                                softmax_lse,
                                rng_states[cp_size - i - 1],
                            ]
                        else:
                            aux_ctx_tensors = [softmax_lse, rng_states[cp_size - i - 1]]
2489
                        if attn_dbias is not None:
2490
                            aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
2491
                        dq_, dk_, dv_, dbias_ = fused_attn_bwd(
2492
                            ctx.max_seqlen_q,
2493
2494
2495
                            ctx.max_seqlen_kv // 2,
                            cu_seqlens_q_per_step[cp_size - i - 1],
                            cu_seqlens_kv_per_step[cp_size - i - 1],
2496
                            q_,
2497
2498
                            kv_[..., 0, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv_[0],
                            kv_[..., 1, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv_[1],
2499
2500
                            out_,
                            dout_,
2501
2502
                            fused_attn_qkv_dtype,
                            fused_attn_dqkv_dtype,
2503
                            aux_ctx_tensors,
2504
                            fused_attn_backend,
2505
2506
2507
2508
                            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
                            ),
2509
2510
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
2511
                            qkv_layout=qkv_layout,
2512
                            attn_mask_type="padding" if padding else "no_mask",
2513
                            attn_bias_type=ctx.attn_bias_type,
2514
2515
                            deterministic=ctx.deterministic,
                            **fp8_meta_kwargs,
2516
2517
2518
2519
                        )
                    else:
                        # [b, 2, sq//2, np, hn] -> [b*sq, np, hn]
                        q_ = q.view(-1, *q.shape[-2:])
2520
                        dq_ = torch.zeros_like(q_)
2521
2522
                        if ctx.qkv_format == "thd":
                            # [2, t, np, hn] -> [2, t/2, np, hn]
2523
                            kv_ = tex.thd_read_half_tensor(kv, cu_seqlens_kv_padded, 0)
2524
2525
2526
                        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:])
2527
2528
2529
2530
2531
                        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:
2532
                            fa_optional_backward_kwargs["window_size"] = (-1, -1)
2533
                        _flash_attn_backward(
2534
2535
2536
2537
2538
2539
2540
2541
2542
                            dout_,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            softmax_lse,
                            dq_,
                            dkv_[0],
                            dkv_[1],
2543
2544
                            cu_seqlens_q_per_step[cp_size - i - 1],
                            cu_seqlens_kv_per_step[cp_size - i - 1],
2545
                            ctx.max_seqlen_q,
2546
                            ctx.max_seqlen_kv // 2,
2547
2548
2549
2550
2551
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            False,
                            rng_state=rng_states[cp_size - i - 1],
                            **fa_optional_backward_kwargs,
2552
2553
2554
                        )
                else:
                    if ctx.use_fused_attention:
2555
2556
2557
                        if ctx.qkv_format == "bshd":
                            # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
                            q_ = q[:, 1, ...].contiguous()
2558
2559
                            # [b, 2, sk//2, 2, np, hn] -> [b, sk, 2, np, hn]
                            kv_ = kv.view(kv.shape[0], -1, *kv.shape[-3:])
2560
2561
2562
2563
2564
2565
                            # [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()
2566
2567
                            # [2, sk//2, b, 2, np, hn] -> [sk, b, 2, np, hn]
                            kv_ = kv.view(-1, *kv.shape[-4:])
2568
2569
2570
                            # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
                            out_ = out[1].contiguous()
                            dout_ = dout[1].contiguous()
2571
2572
                        elif ctx.qkv_format == "thd":
                            # [t, np, hn] -> [t/2, np, hn]
2573
2574
2575
                            q_ = tex.thd_read_half_tensor(q, cu_seqlens_q_padded, 1)
                            out_ = tex.thd_read_half_tensor(out, cu_seqlens_q_padded, 1)
                            dout_ = tex.thd_read_half_tensor(dout, cu_seqlens_q_padded, 1)
2576
                            kv_ = kv
2577
2578
2579
2580
2581
2582
2583
2584
                        if ctx.fp8:
                            aux_ctx_tensors = [
                                softmax_lse_,
                                softmax_lse_,
                                rng_states[cp_size - i - 1],
                            ]
                        else:
                            aux_ctx_tensors = [softmax_lse_, rng_states[cp_size - i - 1]]
2585
                        if attn_dbias is not None:
2586
                            aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
2587
                        dq_, dk_, dv_, dbias_ = fused_attn_bwd(
2588
                            ctx.max_seqlen_q // 2,
2589
2590
2591
                            ctx.max_seqlen_kv,
                            cu_seqlens_q_per_step[cp_size - i - 1],
                            cu_seqlens_kv_per_step[cp_size - i - 1],
2592
                            q_,
2593
2594
                            kv_[..., 0, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv_[0],
                            kv_[..., 1, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv_[1],
2595
2596
                            out_,
                            dout_,
2597
2598
                            fused_attn_qkv_dtype,
                            fused_attn_dqkv_dtype,
2599
                            aux_ctx_tensors,
2600
                            fused_attn_backend,
2601
2602
2603
2604
                            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,
2605
2606
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
2607
                            qkv_layout=qkv_layout,
2608
                            attn_mask_type="padding" if padding else "no_mask",
2609
                            attn_bias_type=ctx.attn_bias_type,
2610
2611
                            deterministic=ctx.deterministic,
                            **fp8_meta_kwargs,
2612
2613
                        )
                    else:
2614
2615
                        if ctx.qkv_format == "thd":
                            # [t, np, hn] -> [t/2, np, hn]
2616
                            q_ = tex.thd_read_half_tensor(q, cu_seqlens_q_padded, 1)
2617
2618
2619
                        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:])
2620
                        dq_ = torch.zeros_like(q_)
2621
2622
2623
                        # [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_)
2624
                        if ctx.qkv_format == "thd":
2625
2626
                            out_ = tex.thd_read_half_tensor(out, cu_seqlens_q_padded, 1)
                            dout_ = tex.thd_read_half_tensor(dout, cu_seqlens_q_padded, 1)
2627
2628
2629
2630
                        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:])
2631
                        if _flash_attn_2_3_plus:
2632
                            fa_optional_backward_kwargs["window_size"] = (-1, -1)
2633
                        _flash_attn_backward(
2634
2635
2636
2637
2638
2639
2640
2641
2642
                            dout_,
                            q_,
                            kv_[0],
                            kv_[1],
                            out_,
                            softmax_lse_,
                            dq_,
                            dkv_[0],
                            dkv_[1],
2643
2644
                            cu_seqlens_q_per_step[cp_size - i - 1],
                            cu_seqlens_kv_per_step[cp_size - i - 1],
2645
                            ctx.max_seqlen_q // 2,
2646
                            ctx.max_seqlen_kv,
2647
2648
2649
2650
2651
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            False,
                            rng_state=rng_states[cp_size - i - 1],
                            **fa_optional_backward_kwargs,
2652
2653
2654
                        )
            else:
                if ctx.use_fused_attention:
2655
2656
2657
2658
                    if ctx.fp8:
                        aux_ctx_tensors = [softmax_lse, softmax_lse, rng_states[cp_size - i - 1]]
                    else:
                        aux_ctx_tensors = [softmax_lse, rng_states[cp_size - i - 1]]
2659
                    if attn_dbias is not None:
2660
                        aux_ctx_tensors += [attn_biases[cp_size - i - 1]]
2661
                    dq_, dk_, dv_, dbias_ = fused_attn_bwd(
2662
                        ctx.max_seqlen_q,
2663
2664
2665
                        ctx.max_seqlen_kv,
                        cu_seqlens_q_per_step[cp_size - i - 1],
                        cu_seqlens_kv_per_step[cp_size - i - 1],
2666
                        q,
2667
2668
                        kv[..., 0, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv[0],
                        kv[..., 1, :, :] if ctx.qkv_format in ["bshd", "sbhd"] else kv[1],
2669
2670
                        out,
                        dout,
2671
2672
                        fused_attn_qkv_dtype,
                        fused_attn_dqkv_dtype,
2673
                        aux_ctx_tensors,
2674
                        fused_attn_backend,
2675
2676
                        cu_seqlens_q_padded=cu_seqlens_q_padded,
                        cu_seqlens_kv_padded=cu_seqlens_kv_padded,
2677
2678
                        attn_scale=ctx.softmax_scale,
                        dropout=ctx.dropout_p,
2679
                        qkv_layout=qkv_layout,
2680
                        attn_mask_type=ctx.attn_mask_type,
2681
                        attn_bias_type=ctx.attn_bias_type,
2682
2683
                        deterministic=ctx.deterministic,
                        **fp8_meta_kwargs,
2684
2685
2686
                    )
                else:
                    # [b, sq, np, hn] -> [b*sq, np, hn]
2687
                    q_ = q.view(-1, *q.shape[-2:])
2688
                    dq_ = torch.zeros_like(q_)
2689
                    # [2, b, sk, np, hn] -> [2, b*sk, np, hn]
2690
2691
                    kv_ = kv.view(2, -1, *kv.shape[-2:])
                    dkv_ = torch.empty_like(kv_)
2692
                    # [b, sq, np, hn] -> [b*sq, np, hn]
2693
2694
                    out_ = out.view(-1, *out.shape[-2:])
                    dout_ = dout.view(-1, *dout.shape[-2:])
2695
                    if _flash_attn_2_3_plus:
2696
                        fa_optional_backward_kwargs["window_size"] = (-1, -1)
2697
                    _flash_attn_backward(
2698
2699
2700
2701
2702
2703
2704
2705
2706
                        dout_,
                        q_,
                        kv_[0],
                        kv_[1],
                        out_,
                        softmax_lse,
                        dq_,
                        dkv_[0],
                        dkv_[1],
2707
2708
                        cu_seqlens_q_per_step[cp_size - i - 1],
                        cu_seqlens_kv_per_step[cp_size - i - 1],
2709
                        ctx.max_seqlen_q,
2710
                        ctx.max_seqlen_kv,
2711
2712
2713
                        ctx.dropout_p,
                        ctx.softmax_scale,
                        False,
2714
                        rng_state=rng_states[cp_size - i - 1],
2715
                        **fa_optional_backward_kwargs,
2716
2717
                    )

2718
2719
            if ctx.fp8:
                dq = dq_fp8[(rank + i + 1) % cp_size]
2720
            if i >= (cp_size - rank - 1) or not causal:
2721
2722
2723
2724
                # [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:
2725
2726
2727
2728
2729
2730
                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:])
2731

2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
            if ctx.fp8:
                if i >= (cp_size - rank - 1) or not causal:
                    dq.copy_(dq_)
                else:
                    if ctx.qkv_format == "bshd":
                        dq[:, 0, ...].fill_(0)
                        dq[:, 1, ...].copy_(dq_)
                    elif ctx.qkv_format == "sbhd":
                        dq[0].fill_(0)
                        dq[1].copy_(dq_)
            elif causal:
2743
                if i > (cp_size - rank - 1):
2744
                    dq.add_(dq_)
2745
2746
                elif i == (cp_size - rank - 1):
                    if rank == (cp_size - 1):
2747
2748
                        dq.copy_(dq_)
                    else:
2749
2750
2751
2752
2753
2754
                        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])
2755
                        elif ctx.qkv_format == "thd":
2756
                            tex.thd_grad_correction(dq, dq_, cu_seqlens_q_padded, "copy", "add")
2757
                elif i > 0:
2758
2759
2760
2761
                    if ctx.qkv_format == "bshd":
                        dq[:, 1, ...].add_(dq_)
                    elif ctx.qkv_format == "sbhd":
                        dq[1].add_(dq_)
2762
                    elif ctx.qkv_format == "thd":
2763
                        tex.thd_grad_correction(dq, dq_, cu_seqlens_q_padded, "none", "add")
2764
                else:
2765
2766
2767
2768
                    if ctx.qkv_format == "bshd":
                        dq[:, 1, ...].copy_(dq_)
                    elif ctx.qkv_format == "sbhd":
                        dq[1].copy_(dq_)
2769
                    elif ctx.qkv_format == "thd":
2770
                        tex.thd_grad_correction(dq, dq_, cu_seqlens_q_padded, "none", "copy")
2771
2772
2773
2774
2775
            else:
                if i == 0:
                    dq.copy_(dq_)
                else:
                    dq.add_(dq_)
2776

2777
            if attn_dbias is not None:
2778
                idx = (rank + i + 1) % cp_size
2779
                if i == (cp_size - 1) or not causal:
2780
                    # [b, np, sq, sk//cp] -> [b, np, sq, 2, sk//(2*cp)]
2781
                    dbias_ = dbias_.view(*dbias_.shape[:-1], 2, dbias_.shape[-1] // 2)
2782
                    attn_dbias[..., idx, :].copy_(dbias_[..., 0, :])
2783
2784
                    attn_dbias[..., (2 * cp_size - idx - 1), :].copy_(dbias_[..., 1, :])
                elif i >= (cp_size - rank - 1):
2785
2786
2787
2788
                    # [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)]
2789
                    dbias_ = dbias_.view(*dbias_.shape[:-1], 2, dbias_.shape[-1] // 2)
2790
                    attn_dbias_[..., 1, :, idx, :].copy_(dbias_[..., 0, :])
2791
                    attn_dbias_[..., 1, :, (2 * cp_size - idx - 1), :].copy_(dbias_[..., 1, :])
2792

2793
2794
2795
            # wait until dKV is received
            for req in send_recv_reqs:
                req.wait()
2796

2797
2798
2799
2800
2801
2802
2803
            if ctx.fp8:
                if i < cp_size - 1:
                    dkv = dkv_fp8_[(rank + i + 1) % cp_size]
                else:
                    dkv = dkv_fp8[(rank + i + 1) % cp_size]
            else:
                dkv = p2p_comm_buffers[(i + 1) % 2][1]
2804
2805
            if ctx.use_fused_attention:
                dkv_ = torch.cat((dk_.unsqueeze(0), dv_.unsqueeze(0)), dim=0)
2806
2807
2808
2809
                if ctx.qkv_format in ["bshd", "sbhd"]:
                    # [b, 2, sk//2, 2, np, hn] -> [2, b, 2, sk//2, np, hn] or
                    # [2, sk//2, b, 2, np, hn] -> [2, 2, sk//2, b, np, hn]
                    dkv = dkv.view(2, *dkv.shape[0:-3], *dkv.shape[-2:])
2810
            if causal and i >= (cp_size - rank - 1) and i != (cp_size - 1):
2811
2812
2813
2814
2815
2816
                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:])
2817
2818
2819
2820
            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)
2821

2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
            if ctx.fp8:
                if causal and i >= (cp_size - rank - 1) and i != (cp_size - 1):
                    if ctx.qkv_format == "bshd":
                        dkv[:, :, 0, ...].copy_(dkv_)
                        dkv[:, :, 1, ...].fill_(0)
                    elif ctx.qkv_format == "sbhd":
                        dkv[:, 0, ...].copy_(dkv_)
                        dkv[:, 1, ...].fill_(0)
                else:
                    dkv.copy_(dkv_)
            elif causal:
2833
                if i == (cp_size - 1):
2834
                    if rank == 0:
2835
2836
2837
2838
2839
2840
                        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, ...])
2841
                        elif ctx.qkv_format == "thd":
2842
                            tex.thd_grad_correction(dkv, dkv_, cu_seqlens_kv_padded, "add", "copy")
2843
2844
                    else:
                        dkv.add_(dkv_)
2845
2846
                elif i >= (cp_size - rank - 1):
                    if i == 0 and rank == (cp_size - 1):
2847
2848
2849
2850
                        if ctx.qkv_format == "bshd":
                            dkv[:, :, 0, ...].copy_(dkv_)
                        elif ctx.qkv_format == "sbhd":
                            dkv[:, 0, ...].copy_(dkv_)
2851
                        elif ctx.qkv_format == "thd":
2852
                            tex.thd_grad_correction(dkv, dkv_, cu_seqlens_kv_padded, "copy", "none")
2853
                    else:
2854
2855
2856
2857
                        if ctx.qkv_format == "bshd":
                            dkv[:, :, 0, ...].add_(dkv_)
                        elif ctx.qkv_format == "sbhd":
                            dkv[:, 0, ...].add_(dkv_)
2858
                        elif ctx.qkv_format == "thd":
2859
                            tex.thd_grad_correction(dkv, dkv_, cu_seqlens_kv_padded, "add", "none")
2860
2861
2862
2863
2864
                elif i > 0:
                    dkv.add_(dkv_)
                else:
                    dkv.copy_(dkv_)
            else:
2865
2866
2867
2868
2869
                if i == 0:
                    dkv.copy_(dkv_)
                else:
                    dkv.add_(dkv_)

2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
        if ctx.fp8 and ctx.use_fused_attention:
            amax_cp_bwd = amax_per_step.amax(dim=1)
            ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DP] = amax_cp_bwd[0]
            ctx.fp8_meta["scaling_bwd"].amax_history[0][META_DQKV_CP] = amax_cp_bwd[1]
            if ctx.qkv_format in ["bshd", "sbhd"]:
                # [cp, b, 2, sk//2, 2, np, hn] -> [cp, 2, b, 2, sk//2, np, hn] or
                # [cp, 2, sk//2, b, 2, np, hn] -> [cp, 2, 2, sk//2, b, np, hn]
                dkv_fp8 = dkv_fp8.view(cp_size, 2, *dkv_fp8.shape[1:-3], *dkv_fp8.shape[-2:])
            dq, dkv = [
                cast_from_fp8(
                    x,
                    ctx.fp8_meta["scaling_bwd"],
                    META_DQKV_CP,
                    fp8_dtype_backward,
                    TE_DType[torch.float32],
                )
                for x in [dq_fp8, dkv_fp8]
            ]
            dq, dkv = [x.sum(dim=0).to(dout_dtype) for x in [dq, dkv]]

2890
        if causal:
2891
2892
            if ctx.qkv_format == "bshd":
                # [b, 2, sq//2, np, hn] -> [b, sq, np, hn]
2893
                dq = dq.view(dq.shape[0], -1, *dq.shape[-2:])
2894
                # [2, b, 2, sk//2, np, hn] -> [2, b, sk, np, hn]
2895
                dkv = dkv.view(*dkv.shape[0:2], -1, *dkv.shape[-2:])
2896
2897
            elif ctx.qkv_format == "sbhd":
                # [2, sq//2, b, np, hn] -> [sq, b, np, hn]
2898
                dq = dq.view(-1, *dq.shape[-3:])
2899
                # [2, 2, sk//2, b, np, hn] -> [2, sk, b, np, hn]
2900
2901
2902
2903
2904
2905
2906
2907
2908
                dkv = dkv.view(dkv.shape[0], -1, *dkv.shape[-3:])

        if ctx.qkv_format == "thd":
            dkv_ = torch.empty(
                2, ctx.total_tokens_kv, *dkv.shape[-2:], dtype=dkv.dtype, device=dkv.device
            )
            dkv_[:, : cu_seqlens_kv_padded[-1]].copy_(dkv)
            dkv_[:, cu_seqlens_kv_padded[-1] :].fill_(0)
            dkv = dkv_
2909

2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
        if ctx.fp8 and ctx.fp8_meta["recipe"].fp8_mha:
            dq, dkv = [
                cast_to_fp8(x, ctx.fp8_meta["scaling_bwd"], META_DQKV, fp8_dtype_backward)
                for x in [dq, dkv]
            ]
            dq, dk, dv = [
                Float8Tensor(
                    data=x,
                    fp8_meta=ctx.fp8_meta,
                    fp8_meta_forward=False,
                    fp8_meta_index=META_DQKV,
                    fp8_dtype=fp8_dtype_backward,
                    dtype=dout_dtype,
                )
                for x in [dq, dkv[0], dkv[1]]
            ]
        else:
            dk, dv = dkv[0], dkv[1]

2929
2930
2931
2932
        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)

2933
2934
2935
        return (
            None,
            dq,
2936
2937
            dk,
            dv,
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            attn_dbias,
            None,
            None,
2955
2956
            None,
            None,
2957
        )
2958
2959


2960
@torch.compile
2961
def get_seq_chunk_ids_to_all_gathered_kv(
2962
    local_chunk_id, cp_size, max_seqlen_q, max_seqlen_kv, window_size_left, device
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
):
    """Compute sequence chunk ids to the all-gathered KV."""
    seq_end_idx = (local_chunk_id + 1) * max_seqlen_kv
    seq_start_idx = max(0, seq_end_idx - max_seqlen_q - window_size_left)
    seqlen = seq_end_idx - seq_start_idx
    num_chunks = (seqlen + max_seqlen_kv - 1) // max_seqlen_kv
    chunk_ids = torch.arange(
        local_chunk_id - num_chunks + 1,
        local_chunk_id + 1,
        dtype=torch.int32,
2973
        device=device,
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
    )
    chunk_ids_to_all_gathered_kv = torch.where(
        chunk_ids < cp_size, 2 * chunk_ids, 2 * (2 * cp_size - chunk_ids) - 1
    )
    return chunk_ids_to_all_gathered_kv


class AttnFuncWithCPAndKVAllGather(torch.autograd.Function):
    """
    Attention implementation with context parallelism.
    KV all-gather between CP ranks is exposed.
    """

    @staticmethod
    def forward(
        ctx,
        is_training,
        q,
        k,
        v,
        cu_seqlens_q,
        cu_seqlens_kv,
        max_seqlen_q,
        max_seqlen_kv,
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
        dropout_p,
        cp_group,
        cp_stream,
        softmax_scale,
        qkv_format,
        attn_mask_type,
        attn_bias_type,
        attn_bias,
        deterministic,
        use_fused_attention,
        window_size,
    ):
        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)

        causal = "causal" in attn_mask_type
        padding = "padding" in attn_mask_type
        assert causal and not padding, f"{attn_mask_type} mask type is not supported!"
        if use_fused_attention and causal and "bottom_right" not in attn_mask_type:
            attn_mask_type = attn_mask_type + "_bottom_right"

        assert attn_bias_type == "no_bias", f"{attn_bias_type} bias type is not supported!"
        assert q.shape[-1] % 8 == 0, "Hidden size per attention head should be multiple of 8!"
        assert (
            use_fused_attention or _flash_attn_2_3_plus
        ), "Sliding window attention only can work with FusedAttention or FlashAttention >= 2.3!"
        fa_optional_forward_kwargs = {}
        if _flash_attn_2_4_plus:
            fa_optional_forward_kwargs["alibi_slopes"] = None

        assert qkv_format != "thd", f"{qkv_format} format is not supported!"
        qkv_layout = qkv_format + "_" + qkv_format + "_" + qkv_format

        seq_dim = qkv_format.index("s")
        assert (
            q.shape[seq_dim] % 2 == 0 and k.shape[seq_dim] % 2 == 0
        ), "Sequence length per GPU needs to be divisible by 2!"

        max_seqlen_q = max_seqlen_q // (2 * cp_size)
        max_seqlen_kv = max_seqlen_kv // (2 * cp_size)
        cu_seqlens_q = cu_seqlens_q // (2 * cp_size)
        cu_seqlens_kv = cu_seqlens_kv // (2 * cp_size)
        cu_seqlens_q_padded = cu_seqlens_q_padded // (2 * cp_size)
        cu_seqlens_kv_padded = cu_seqlens_kv_padded // (2 * cp_size)

        if causal:
            if qkv_format == "bshd":
                # [b, s, np, hn] -> [b, 2, s//2, np, hn]
                q = q.view(q.shape[0], 2, q.shape[1] // 2, *q.shape[2:])
                # [b, s, np, hn] -> [s, b, np, hn]
                k, v = [x.transpose(0, 1).contiguous() for x in [k, v]]
            elif qkv_format == "sbhd":
                # [s, b, np, hn] -> [2, s//2, b, np, hn]
                q = q.view(2, q.shape[0] // 2, *q.shape[1:])

        # create two streams to resolve wave quantization issue of Flash Attn in each step
        flash_attn_streams = [torch.cuda.current_stream(), cp_stream]

        k_ag, _ = gather_along_first_dim(k, cp_group)
        v_ag, _ = gather_along_first_dim(v, cp_group)
        cp_stream.wait_stream(torch.cuda.current_stream())
        k_ag = k_ag.view(2 * cp_size, k.shape[0] // 2, *k.shape[1:])
        v_ag = v_ag.view(2 * cp_size, v.shape[0] // 2, *v.shape[1:])

        local_seq_chunk_ids = [rank, 2 * cp_size - rank - 1]
        chunk_ids_to_kv_ag_per_step = [None, None]
        out_per_step = [None, None]
        softmax_lse_per_step = [None, None]
        rng_states = [None, None]
        out = torch.empty_like(q)

        for i in range(len(local_seq_chunk_ids) + 1):
            if i < len(local_seq_chunk_ids):
                with torch.cuda.stream(flash_attn_streams[i]):
                    chunk_ids_to_kv_ag = get_seq_chunk_ids_to_all_gathered_kv(
                        local_seq_chunk_ids[i],
                        cp_size,
                        max_seqlen_q,
                        max_seqlen_kv,
                        (
                            max_seqlen_kv * cp_size * 2
                            if (window_size is None or window_size[0] == -1)
                            else window_size[0]
                        ),
3087
                        k.device,
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
                    )
                    chunk_ids_to_kv_ag_per_step[i] = chunk_ids_to_kv_ag
                    num_kv_chunks = chunk_ids_to_kv_ag.numel()
                    if qkv_format == "bshd":
                        # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
                        q_ = q[:, i].contiguous()
                        # [num_kv_chunks, sq//2, b, np, hn] -> [b, num_kv_chunks*sq//2, np, hn]
                        k_ = (
                            torch.index_select(k_ag, dim=0, index=chunk_ids_to_kv_ag)
                            .movedim(2, 0)
                            .contiguous()
                            .view(k.shape[1], -1, *k.shape[-2:])
                        )
                        v_ = (
                            torch.index_select(v_ag, dim=0, index=chunk_ids_to_kv_ag)
                            .movedim(2, 0)
                            .contiguous()
                            .view(v.shape[1], -1, *v.shape[-2:])
                        )
                    elif qkv_format == "sbhd":
                        # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
                        q_ = q[i].contiguous()
                        # [num_kv_chunks, sq//2, b, np, hn] -> [num_kv_chunks*sq//2, b, np, hn]
                        k_ = torch.index_select(k_ag, dim=0, index=chunk_ids_to_kv_ag).view(
                            -1, *k.shape[-3:]
                        )
                        v_ = torch.index_select(v_ag, dim=0, index=chunk_ids_to_kv_ag).view(
                            -1, *v.shape[-3:]
                        )
                    if use_fused_attention:
                        out_per_step[i], [softmax_lse_per_step[i], rng_states[i]] = fused_attn_fwd(
                            is_training,
                            max_seqlen_q,
                            max_seqlen_kv * num_kv_chunks,
                            cu_seqlens_q,
                            cu_seqlens_kv * num_kv_chunks,
                            q_,
                            k_,
                            v_,
                            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,
                            cu_seqlens_q_padded=cu_seqlens_q_padded,
                            cu_seqlens_kv_padded=cu_seqlens_kv_padded * num_kv_chunks,
                            window_size=window_size,
                        )
                    else:
                        q_, k_, v_ = [x.view(-1, *x.shape[-2:]) for x in [q_, k_, v_]]
                        _, _, _, _, out_per_step[i], softmax_lse_per_step[i], _, rng_states[i] = (
                            _flash_attn_forward(
                                q_,
                                k_,
                                v_,
                                cu_seqlens_q,
                                cu_seqlens_kv * num_kv_chunks,
                                max_seqlen_q,
                                max_seqlen_kv * num_kv_chunks,
                                dropout_p,
                                softmax_scale,
                                causal=True,
                                return_softmax=False,
                                window_size=window_size,
                                **fa_optional_forward_kwargs,
                            )
                        )

            if i > 0:
                with torch.cuda.stream(flash_attn_streams[i - 1]):
                    if qkv_format == "bshd":
                        out[:, i - 1].copy_(out_per_step[i - 1].view_as(out[:, i - 1]))
                    elif qkv_format == "sbhd":
                        out[i - 1].copy_(out_per_step[i - 1].view_as(out[i - 1]))

        torch.cuda.current_stream().wait_stream(cp_stream)

        if use_fused_attention:
            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:])
        else:
            out = out.view(-1, *out.shape[-2:])

        ctx.save_for_backward(
            q,
            k,
            v,
            cu_seqlens_q,
            cu_seqlens_kv,
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
            *chunk_ids_to_kv_ag_per_step,
            *out_per_step,
            *softmax_lse_per_step,
            *rng_states,
        )
        ctx.cp_group = cp_group
        ctx.cp_stream = cp_stream
        ctx.dropout_p = dropout_p
        ctx.max_seqlen_q = max_seqlen_q
        ctx.max_seqlen_kv = max_seqlen_kv
        ctx.softmax_scale = softmax_scale
        ctx.qkv_format = qkv_format
        ctx.attn_mask_type = attn_mask_type
        ctx.attn_bias_type = attn_bias_type
        ctx.deterministic = deterministic
        ctx.use_fused_attention = use_fused_attention
        ctx.window_size = window_size
        return out

    @staticmethod
    def backward(ctx, dout):
        cp_size = get_distributed_world_size(ctx.cp_group)
        rank = get_distributed_rank(ctx.cp_group)

        (q, k, v, cu_seqlens_q, cu_seqlens_kv, cu_seqlens_q_padded, cu_seqlens_kv_padded) = (
            ctx.saved_tensors[:7]
        )
        chunk_ids_to_kv_ag_per_step = ctx.saved_tensors[7:9]
        out_per_step = ctx.saved_tensors[9:11]
        softmax_lse_per_step = ctx.saved_tensors[11:13]
        rng_states = ctx.saved_tensors[13:15]

        qkv_layout = ctx.qkv_format + "_" + ctx.qkv_format + "_" + ctx.qkv_format

        dout = dout.view_as(q)
        dq = torch.empty_like(q)
        dk = torch.zeros(
            (2 * cp_size, k.shape[0] // 2, *k.shape[1:]), dtype=k.dtype, device=k.device
        )
        dv = torch.zeros_like(dk)
        dq_per_step = [None, None]
        dk_per_step = [None, None]
        dv_per_step = [None, None]

        # create two streams to resolve wave quantization issue of Flash Attn in each step
        flash_attn_streams = [torch.cuda.current_stream(), ctx.cp_stream]
        # synchronize dkv update across steps
        dkv_update_done = torch.cuda.Event()

        k_ag, _ = gather_along_first_dim(k, ctx.cp_group)
        v_ag, _ = gather_along_first_dim(v, ctx.cp_group)
        ctx.cp_stream.wait_stream(torch.cuda.current_stream())
        k_ag = k_ag.view(2 * cp_size, k.shape[0] // 2, *k.shape[1:])
        v_ag = v_ag.view(2 * cp_size, v.shape[0] // 2, *v.shape[1:])

        local_seq_chunk_ids = [rank, 2 * cp_size - rank - 1]

        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

        for i in range(len(local_seq_chunk_ids) + 1):
            if i < len(local_seq_chunk_ids):
                with torch.cuda.stream(flash_attn_streams[i]):
                    chunk_ids_to_kv_ag = chunk_ids_to_kv_ag_per_step[i]
                    num_kv_chunks = chunk_ids_to_kv_ag.numel()
                    out_ = out_per_step[i]
                    if ctx.qkv_format == "bshd":
                        # [b, 2, sq//2, np, hn] -> [b, sq//2, np, hn]
                        q_ = q[:, i].contiguous()
                        # [num_kv_chunks, sq//2, b, np, hn] -> [b, num_kv_chunks*sq//2, np, hn]
                        k_ = (
                            torch.index_select(k_ag, dim=0, index=chunk_ids_to_kv_ag)
                            .movedim(2, 0)
                            .contiguous()
                            .view(k.shape[1], -1, *k.shape[-2:])
                        )
                        v_ = (
                            torch.index_select(v_ag, dim=0, index=chunk_ids_to_kv_ag)
                            .movedim(2, 0)
                            .contiguous()
                            .view(v.shape[1], -1, *v.shape[-2:])
                        )
                        dout_ = dout[:, i].contiguous().view_as(out_)
                    elif ctx.qkv_format == "sbhd":
                        # [2, sq//2, b, np, hn] -> [sq//2, b, np, hn]
                        q_ = q[i].contiguous()
                        # [num_kv_chunks, sq//2, b, np, hn] -> [num_kv_chunks*sq//2, b, np, hn]
                        k_ = torch.index_select(k_ag, dim=0, index=chunk_ids_to_kv_ag).view(
                            -1, *k.shape[-3:]
                        )
                        v_ = torch.index_select(v_ag, dim=0, index=chunk_ids_to_kv_ag).view(
                            -1, *v.shape[-3:]
                        )
                        dout_ = dout[i].contiguous().view_as(out_)
                    if ctx.use_fused_attention:
                        dq_per_step[i], dk_per_step[i], dv_per_step[i] = [
                            torch.empty_like(x) for x in [q_, k_, v_]
                        ]
                        aux_ctx_tensors = [softmax_lse_per_step[i], rng_states[i]]
                        dq_per_step[i], dk_per_step[i], dv_per_step[i], _ = fused_attn_bwd(
                            ctx.max_seqlen_q,
                            ctx.max_seqlen_kv * num_kv_chunks,
                            cu_seqlens_q,
                            cu_seqlens_kv * num_kv_chunks,
                            q_,
                            k_,
                            v_,
                            out_,
                            dout_,
                            TE_DType[q.dtype],
                            TE_DType[k.dtype],
                            aux_ctx_tensors,
                            tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen,
                            cu_seqlens_q_padded=cu_seqlens_q_padded,
                            cu_seqlens_kv_padded=cu_seqlens_kv_padded * num_kv_chunks,
                            attn_scale=ctx.softmax_scale,
                            dropout=ctx.dropout_p,
                            qkv_layout=qkv_layout,
                            attn_mask_type=ctx.attn_mask_type,
                            attn_bias_type=ctx.attn_bias_type,
                            window_size=ctx.window_size,
                        )
                    else:
                        q_, k_, v_ = [x.view(-1, *x.shape[-2:]) for x in [q_, k_, v_]]
                        dq_per_step[i], dk_per_step[i], dv_per_step[i] = [
                            torch.empty_like(x) for x in [q_, k_, v_]
                        ]
                        _flash_attn_backward(
                            dout_,
                            q_,
                            k_,
                            v_,
                            out_,
                            softmax_lse_per_step[i],
                            dq_per_step[i],
                            dk_per_step[i],
                            dv_per_step[i],
                            cu_seqlens_q,
                            cu_seqlens_kv * num_kv_chunks,
                            ctx.max_seqlen_q,
                            ctx.max_seqlen_kv * num_kv_chunks,
                            ctx.dropout_p,
                            ctx.softmax_scale,
                            True,
                            window_size=ctx.window_size,
                            rng_state=rng_states[i],
                            **fa_optional_backward_kwargs,
                        )

            if i > 0:
                with torch.cuda.stream(flash_attn_streams[i - 1]):
                    chunk_ids_to_kv_ag = chunk_ids_to_kv_ag_per_step[i - 1]
                    num_kv_chunks = chunk_ids_to_kv_ag.numel()
                    if ctx.qkv_format == "bshd":
                        dq[:, i - 1].copy_(dq_per_step[i - 1].view_as(dq[:, i - 1]))
                        dk_per_step[i - 1] = (
                            dk_per_step[i - 1]
                            .view(k.shape[1], num_kv_chunks, -1, *k.shape[-2:])
                            .movedim(0, 2)
                            .contiguous()
                        )
                        dv_per_step[i - 1] = (
                            dv_per_step[i - 1]
                            .view(v.shape[1], num_kv_chunks, -1, *v.shape[-2:])
                            .movedim(0, 2)
                            .contiguous()
                        )
                    elif ctx.qkv_format == "sbhd":
                        dq[i - 1].copy_(dq_per_step[i - 1].view_as(dq[i - 1]))
                        dk_per_step[i - 1] = dk_per_step[i - 1].view(
                            num_kv_chunks, -1, *k.shape[-3:]
                        )
                        dv_per_step[i - 1] = dv_per_step[i - 1].view(
                            num_kv_chunks, -1, *v.shape[-3:]
                        )

                    # wait until dkv update of last step is done
                    if i > 1:
                        flash_attn_streams[i - 1].wait_event(dkv_update_done)
                    dk.index_add_(0, chunk_ids_to_kv_ag, dk_per_step[i - 1])
                    dv.index_add_(0, chunk_ids_to_kv_ag, dv_per_step[i - 1])
                    if i < len(local_seq_chunk_ids):
                        flash_attn_streams[i - 1].record_event(dkv_update_done)

        torch.cuda.current_stream().wait_stream(ctx.cp_stream)

        dk = dk.view(-1, *dk.shape[-3:])
        dv = dv.view(-1, *dv.shape[-3:])
        dk, _ = reduce_scatter_along_first_dim(dk, ctx.cp_group)
        dv, _ = reduce_scatter_along_first_dim(dv, ctx.cp_group)

        if ctx.qkv_format == "bshd":
            dq = dq.view(dq.shape[0], -1, *dq.shape[-2:])
            dk = dk.transpose(0, 1).contiguous()
            dv = dv.transpose(0, 1).contiguous()
        elif ctx.qkv_format == "sbhd":
            dq = dq.view(-1, *dq.shape[-3:])

        return (
            None,
            dq,
            dk,
            dv,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
        )


3410
def attn_forward_func_with_cp(
3411
3412
3413
3414
3415
    is_training,
    q,
    k,
    v,
    cu_seqlens_q,
3416
    cu_seqlens_kv,
3417
    max_seqlen_q,
3418
    max_seqlen_kv,
3419
3420
    cu_seqlens_q_padded,
    cu_seqlens_kv_padded,
3421
3422
3423
3424
    dropout_p,
    cp_group,
    cp_global_ranks,
    cp_stream,
3425
    cp_comm_type,
3426
3427
3428
3429
3430
3431
3432
    softmax_scale=None,
    qkv_format="bshd",
    attn_mask_type="causal",
    attn_bias_type="no_bias",
    attn_bias=None,
    deterministic=False,
    use_fused_attention=False,
3433
    window_size=None,
3434
3435
    fp8=False,
    fp8_meta=None,
3436
) -> torch.Tensor:
3437
3438
3439
3440
    """
    Attention implementation with context parallelism.
    """

3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
    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!"""
    )
3461
3462
3463
    assert (
        cu_seqlens_q_padded is not None and cu_seqlens_kv_padded is not None
    ), "cu_seqlens_q_padded and cu_seqlens_kv_padded cannot be None with context parallelism!"
3464
3465
3466

    sliding_window_attn = (
        window_size is not None and window_size != (-1, 0) and window_size != (-1, -1)
3467
    )
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515

    if sliding_window_attn or cp_comm_type == "all_gather":
        out = AttnFuncWithCPAndKVAllGather.apply(
            is_training,
            q,
            k,
            v,
            cu_seqlens_q,
            cu_seqlens_kv,
            max_seqlen_q,
            max_seqlen_kv,
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
            dropout_p,
            cp_group,
            cp_stream,
            softmax_scale,
            qkv_format,
            attn_mask_type,
            attn_bias_type,
            attn_bias,
            deterministic,
            use_fused_attention,
            window_size,
        )
    elif cp_comm_type == "p2p":
        out = AttnFuncWithCPAndKVP2P.apply(
            is_training,
            q,
            k,
            v,
            cu_seqlens_q,
            cu_seqlens_kv,
            max_seqlen_q,
            max_seqlen_kv,
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
            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,
3516
3517
            fp8,
            fp8_meta,
3518
3519
3520
3521
        )
    else:
        raise ValueError(f"Unsupported communication type: {cp_comm_type}!")

3522
3523
3524
    return out


3525
3526
3527
3528
class RotaryPositionEmbedding(torch.nn.Module):
    """
    Implements Rotary Position Embedding from https://arxiv.org/abs/2104.09864.
    """
3529

3530
3531
3532
    def __init__(
        self,
        dim: int,
3533
        rotary_percent: float = 1.0,
3534
3535
3536
3537
3538
3539
3540
3541
        seq_len_interpolation_factor: Optional[int] = None,
        pretrained_max_position_embeddings: Optional[int] = None,
    ):
        """
        Parameters
        ----------
        dim: int
            rotary embedding dimension
3542
3543
        rotary_percent: float
            Percent of rotary dimension to use for rotary position embeddings.
3544
3545
3546
3547
3548
3549
3550
        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__()
3551
3552
        if rotary_percent < 1.0:
            dim = int(dim * rotary_percent)
3553
        self.seq_len_interpolation_factor = seq_len_interpolation_factor
3554
3555
3556
3557
3558
3559
3560
        inv_freq = 1.0 / (
            10000
            ** (
                torch.arange(0, dim, 2, dtype=torch.float32, device=torch.cuda.current_device())
                / dim
            )
        )
3561
        self.register_buffer("inv_freq", inv_freq)
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
        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
        """
3575
3576
3577
3578
        seq = (
            torch.arange(max_seq_len, device=self.inv_freq.device, dtype=self.inv_freq.dtype)
            + offset
        )
3579

3580
3581
3582
3583
3584
3585
3586
3587
        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
            ):
3588
3589
3590
3591
3592
3593
                # 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

3594
        freqs = torch.einsum("i , j -> i j", seq, self.inv_freq)
3595
3596
3597
3598
3599
3600
        # 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))

3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618

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:
3619
3620
        if freqs.dtype != torch.float32:
            freqs = freqs.float()
3621
3622
3623
        if tensor_format == "sbhd":
            output = tex.fused_rope_forward(t, freqs, False)
        elif tensor_format == "bshd":
3624
            output = tex.fused_rope_forward(t.transpose(0, 1), freqs, True).transpose(0, 1)
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
        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
3635
    def backward(ctx, grad_output: torch.Tensor) -> Tuple[Union[torch.Tensor, None], ...]:
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
        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


3651
3652
3653
3654
3655
3656
3657
3658
3659
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)


3660
def apply_rotary_pos_emb(
3661
3662
3663
3664
3665
3666
    t: torch.Tensor,
    freqs: torch.Tensor,
    tensor_format: str = "sbhd",
    fused: bool = False,
    cu_seqlens: Union[torch.Tensor, None] = None,
) -> torch.Tensor:
3667
    """
3668
    Apply rotary positional embedding tensor to the input tensor.
3669

3670
3671
3672
    Parameters
    ----------
    t: torch.Tensor
3673
        Input tensor of shape `[s, b, h, d]`, `[b, s, h, d]` or `[t, h, d]`, on which
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
        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'.
3686
    """
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
    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}."
    )

3698
3699
3700
3701
3702
    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.
3703
3704
3705
    assert (
        cur_seq_len <= max_seq_len
    ), f"Rotary Embeddings only supported up to {max_seq_len} sequence length!"
3706
    freqs = freqs[:cur_seq_len]
3707
    if tensor_format == "bshd":
3708
3709
3710
3711
        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)
3712

3713
3714
3715
3716
3717
3718
    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
3719
    t = (t * cos_) + (_rotate_half(t) * sin_)
3720
3721
3722
    return torch.cat((t, t_pass), dim=-1)


cyanguwa's avatar
cyanguwa committed
3723
class _SplitAlongDim(torch.autograd.Function):
3724
3725
3726
    """"""

    @staticmethod
3727
3728
3729
3730
3731
    def forward(
        ctx,
        mixed_x_layer: torch.Tensor,
        split_dim: int,
        split_size_or_sections: Union[int, List[int], Tuple[int]],
3732
    ) -> Tuple[torch.Tensor, ...]:
cyanguwa's avatar
cyanguwa committed
3733
3734
        ctx.split_dim = split_dim
        ctx.split_size_or_sections = split_size_or_sections
3735
        if isinstance(mixed_x_layer, Float8Tensor):
3736
3737
3738
3739
3740
3741
            return tuple(
                Float8Tensor.make_like(
                    mixed_x_layer,
                    data=x,
                )
                for x in torch.split(
3742
3743
                    mixed_x_layer._data,
                    split_size_or_sections=split_size_or_sections,
3744
3745
3746
3747
                    dim=split_dim,
                )
            )
        return torch.split(mixed_x_layer, split_size_or_sections, dim=split_dim)
3748
3749

    @staticmethod
3750
    def backward(ctx, *grad_outputs):
3751
3752
        assert len(grad_outputs) > 0, "No gradients received for backprop!"

cyanguwa's avatar
cyanguwa committed
3753
3754
        if isinstance(ctx.split_size_or_sections, (list, tuple)):
            split_sizes = ctx.split_size_or_sections
3755
3756
3757
            assert len(grad_outputs) == len(
                split_sizes
            ), "Unequal number of gradients vs split sections for backprop!"
cyanguwa's avatar
cyanguwa committed
3758
3759
3760
3761
3762
        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

3763
3764
3765
3766
3767
3768
3769
3770
        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]
3771
3772
3773
3774
3775
3776
3777
                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
                ):
3778
3779
3780
                    noop_ok = False
                    break
            if noop_ok:
3781
3782
3783
                ret = torch.Tensor().to(
                    device=grad_outputs[0].device, dtype=grad_outputs[0]._data.dtype
                )
3784
3785
                new_shape = list(shape)
                new_shape[split_dim] = sum(split_sizes)
3786
3787
3788
3789
3790
                ret.set_(
                    grad_outputs[0]._data.untyped_storage(),
                    grad_outputs[0]._data.storage_offset(),
                    new_shape,
                    strides,
3791
3792
3793
3794
                )
                return Float8Tensor.make_like(grad_outputs[0], data=ret), None, None

            grad_outputs_data = [x._data for x in grad_outputs]
3795
3796
3797
3798
3799
3800
3801
            return (
                Float8Tensor.make_like(
                    grad_outputs[0], data=torch.cat(grad_outputs_data, dim=split_dim)
                ),
                None,
                None,
            )
3802
3803
        noop_ok = True
        strides = grad_outputs[0].stride()
3804
        data_ptr = grad_outputs[0].untyped_storage().data_ptr()
cyanguwa's avatar
cyanguwa committed
3805
        shape = list(grad_outputs[0].shape)
3806
        for i, tensor in enumerate(grad_outputs):
cyanguwa's avatar
cyanguwa committed
3807
3808
            shape_i = shape
            shape_i[split_dim] = split_sizes[i]
3809
3810
3811
3812
3813
3814
3815
            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
            ):
3816
3817
3818
                noop_ok = False
                break
        if noop_ok:
3819
            ret = torch.Tensor().to(device=grad_outputs[0].device, dtype=grad_outputs[0].dtype)
3820
            new_shape = list(shape)
cyanguwa's avatar
cyanguwa committed
3821
            new_shape[split_dim] = sum(split_sizes)
3822
3823
3824
3825
3826
            ret.set_(
                grad_outputs[0].untyped_storage(),
                grad_outputs[0].storage_offset(),
                new_shape,
                strides,
3827
            )
cyanguwa's avatar
cyanguwa committed
3828
            return ret, None, None
3829

3830
        return torch.cat(grad_outputs, dim=split_dim), None, None
3831
3832
3833
3834
3835
3836
3837
3838
3839


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

    def __init__(
        self,
3840
        softmax_scale: float,
3841
        attention_type: str = "self",
3842
3843
3844
3845
3846
3847
        attention_dropout: float = 0.0,
        attention_dropout_ctx: Optional[Callable] = nullcontext,
        layer_number: Optional[int] = None,
    ) -> None:
        super().__init__()

3848
        self.softmax_scale = softmax_scale
3849
        self.attention_type = attention_type
3850
3851
3852
        self.attention_dropout_ctx = attention_dropout_ctx
        self.layer_number = layer_number

3853
        self.scale_mask_softmax = FusedScaleMaskSoftmax(attention_mask_func)
3854
3855
3856
3857
3858
3859

        # 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)

3860
3861
        # An FP16 training trick required for certain GPT-like models.
        self.apply_qk_layer_scaling = (
3862
3863
            bool(int(os.getenv("NVTE_APPLY_QK_LAYER_SCALING", "0"))) and layer_number is not None
        )
3864

3865
3866
3867
3868
3869
    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
3870
        qkv_layout: str = "sbh3d",
3871
3872
        cu_seqlens_q: Optional[torch.Tensor] = None,  # pylint: disable=unused-argument
        cu_seqlens_kv: Optional[torch.Tensor] = None,  # pylint: disable=unused-argument
3873
        attn_mask_type: str = "causal",
3874
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
3875
3876
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
3877
        alibi_slopes: Optional[torch.Tensor] = None,
3878
    ) -> torch.Tensor:
3879
        """Unfused attention fprop"""
3880
3881
3882
3883
3884
        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":
3885
            # convert to sbhd and use sbhd implementation for now
3886
3887
3888
            query_layer, key_layer, value_layer = [
                x.transpose(0, 1) for x in [query_layer, key_layer, value_layer]
            ]
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
        batch_size, max_seqlen_q, max_seqlen_kv = (
            query_layer.shape[1],
            query_layer.shape[0],
            key_layer.shape[0],
        )
        if "padding" in attn_mask_type:
            if self.attention_type == "self":
                assert attention_mask.shape == (
                    batch_size,
                    1,
                    1,
                    max_seqlen_q,
                ), "attention_mask should be a single tensor with [b, 1, 1, sq] shape!"
                attention_mask = torch.logical_or(
                    attention_mask.squeeze(1).unsqueeze(3), attention_mask
                )
            else:
                assert (
                    len(attention_mask) == 2
                    and attention_mask[0].shape == (batch_size, 1, 1, max_seqlen_q)
                    and attention_mask[1].shape == (batch_size, 1, 1, max_seqlen_kv)
                ), (
                    "attention_mask should be a tuple of two tensors with shapes "
                    "[b, 1, 1, sq] and [b, 1, 1, skv]!"
                )
                attention_mask = torch.logical_or(
                    attention_mask[0].squeeze(1).unsqueeze(3), attention_mask[1]
                )
            mask = attention_mask.squeeze(1).logical_not()
            actual_seqlens_q = mask[:, :, 0].sum(dim=1)
            actual_seqlens_kv = mask[:, 0, :].sum(dim=1)
            mask = torch.arange(max_seqlen_q, dtype=torch.int32, device="cuda").view(
                1, 1, max_seqlen_q, 1
            ) - torch.arange(max_seqlen_kv, dtype=torch.int32, device="cuda").view(
                1, 1, 1, max_seqlen_kv
            )
            if attn_mask_type == "padding_causal":
                attention_mask = torch.logical_or(
                    torch.where(mask.view(1, 1, max_seqlen_q, max_seqlen_kv) < 0, 1, 0),
                    attention_mask,
                )
            if attn_mask_type == "padding_causal_bottom_right":
                attention_mask = torch.logical_or(
                    torch.where(
                        mask.expand(batch_size, 1, max_seqlen_q, max_seqlen_kv)
                        + (actual_seqlens_kv - actual_seqlens_q).view(batch_size, 1, 1, 1)
                        < 0,
                        1,
                        0,
                    ),
                    attention_mask,
                )
3941

3942
        batch_size, seqlen = query_layer.shape[1], query_layer.shape[0]
3943
        apply_qk_layer_scaling = self.apply_qk_layer_scaling and key_layer.dtype == torch.float16
3944
3945
3946
3947
3948
3949
3950
3951
3952

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

3953
        if key_layer.shape[2] != query_layer.shape[2]:
3954
3955
3956
            assert (
                query_layer.shape[2] % key_layer.shape[2] == 0
            ), "The number of attention heads must be divisible by the number of GQA groups!"
3957
            key_layer = key_layer.repeat_interleave(
3958
3959
                int(query_layer.shape[2] / key_layer.shape[2]), dim=2
            )
3960
            value_layer = value_layer.repeat_interleave(
3961
3962
                int(query_layer.shape[2] / value_layer.shape[2]), dim=2
            )
3963

3964
        # [sq, b, np, hn] -> [sq, b * np, hn]
3965
        query_layer = query_layer.reshape(output_size[2], output_size[0] * output_size[1], -1)
3966
3967
3968
3969
        # [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]
3970
3971
        # WAR to set dtype to FP32 as ONNX lacks BF16 support for ConstantOfShape operator
        is_bf16 = query_layer.dtype == torch.bfloat16
3972
3973
3974
3975
        matmul_result = torch.empty(
            output_size[0] * output_size[1],
            output_size[2],
            output_size[3],
3976
            dtype=torch.float32 if is_in_onnx_export_mode() and is_bf16 else query_layer.dtype,
3977
3978
3979
            device=torch.cuda.current_device(),
        )

3980
3981
3982
        if is_in_onnx_export_mode() and is_bf16:
            matmul_result = matmul_result.bfloat16()

3983
        scale = self.softmax_scale
3984
        if apply_qk_layer_scaling:
3985
            scale /= self.layer_number
3986
3987

        # Raw attention scores. [b * np, sq, sk]
3988
3989
3990
3991
3992
3993
        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,
3994
                alpha=scale,
3995
            ).view(*output_size)
3996
3997
3998
3999
4000
4001
4002

        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]
            )
4003
            matmul_result = matmul_result.view(*output_size) + core_attention_bias
4004
            matmul_result *= scale
4005

4006
4007
4008
4009
        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":
4010
                _, core_attention_bias = get_alibi(
4011
4012
4013
                    output_size[1],
                    output_size[2],
                    output_size[3],
4014
4015
                    actual_seqlens_q=actual_seqlens_q if "padding" in attn_mask_type else None,
                    actual_seqlens_kv=actual_seqlens_kv if "padding" in attn_mask_type else None,
4016
4017
                    alibi_slopes=alibi_slopes,
                    bottom_right_alignment=attn_mask_type not in ["causal", "padding_causal"],
4018
                )
4019
4020
4021
4022
4023
            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,
4024
                alpha=scale,
4025
            )
4026
4027
            matmul_result = (matmul_result.view(*output_size) + core_attention_bias).to(
                dtype=query_layer.dtype
4028
            )
4029
4030
4031

        # attention scores and attention mask [b, np, sq, sk]
        softmax_scale = self.layer_number if apply_qk_layer_scaling else None
4032
        attention_probs = self.scale_mask_softmax(
4033
            matmul_result, attention_mask, attn_mask_type, softmax_scale
4034
        )
4035

4036
4037
4038
4039
4040
        # mask out the pad positions in softmax results, mostly for the rows (pad tokens from q)
        # the columns (pad tokens from k) are already zeroed out during softmax
        if "padding" in attn_mask_type:
            attention_probs = attention_probs.masked_fill(attention_mask, 0)

4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
        # 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]
4056
        value_layer = value_layer.reshape(value_layer.size(0), output_size[0] * output_size[1], -1)
4057
4058

        # change view [b * np, sq, sk]
4059
        attention_probs = attention_probs.view(output_size[0] * output_size[1], output_size[2], -1)
4060
4061
4062
4063
4064
4065
4066

        # 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)

4067
        if qkv_format == "sbhd":
4068
4069
            # [b, np, sq, hn] --> [sq, b, np, hn]
            context_layer = context_layer.permute(2, 0, 1, 3).contiguous()
4070

4071
4072
4073
            # [sq, b, np, hn] --> [sq, b, hp]
            context_layer = context_layer.view(seqlen, batch_size, -1)

4074
        if qkv_format == "bshd":
4075
4076
4077
4078
4079
            # [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)
4080
4081
4082
4083
4084
4085

        return context_layer


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

    @staticmethod
4089
4090
4091
4092
    def forward(
        _ctx: torch.autograd.function.FunctionCtx,  # unused
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
4093
        value_layer: torch.Tensor,
4094
    ) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor]:
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
        # 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
4106
4107
4108
4109
    def backward(
        _ctx: torch.autograd.function.FunctionCtx,  # unused
        dq: torch.Tensor,
        dk: torch.Tensor,
4110
        dv: torch.Tensor,
4111
4112
4113
4114
4115
    ) -> 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

4116

4117
def get_qkv_layout(
4118
4119
4120
4121
4122
    q: torch.Tensor,
    k: torch.Tensor,
    v: torch.Tensor,
    qkv_format: str = "sbhd",
) -> str:
4123
    """Get qkv layout.
4124

4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
    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,
4136
        `d` head size, and `t` the total number of tokens in a batch, i.e.
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
        `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`}
    """
4153

4154
4155
    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!"
4156

4157
4158
4159
4160
4161
4162
4163
4164
    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])
4165
4166
        check_strides_kv = tuple(sk / k.shape[-1] for sk in k.stride()[:-1]) == tuple(
            sv / v.shape[-1] for sv in v.stride()[:-1]
4167
        )
4168
4169
4170
4171

        shape = q.shape
        check_shapes_qkv = all(shape == x.shape for x in [q, k, v])
        shape = k.shape
4172
        check_shapes_kv = shape[:-1] == v.shape[:-1]
4173
4174

        last_dim_size = q.shape[-1]
4175
4176
4177
        check_last_dim_offsets_qkv = all(
            i * last_dim_size == x.storage_offset() for i, x in enumerate([q, k, v])
        )
4178
        last_dim_size = k.shape[-1]
4179
4180
4181
        check_last_dim_offsets_kv = all(
            i * last_dim_size == x.storage_offset() for i, x in enumerate([k, v])
        )
4182
4183

        last_two_dims_size = q.shape[-1] * q.shape[-2]
4184
4185
4186
        check_last_two_dims_offsets_qkv = all(
            i * last_two_dims_size == x.storage_offset() for i, x in enumerate([q, k, v])
        )
4187
        last_two_dims_size = k.shape[-1] * k.shape[-2]
4188
4189
4190
        check_last_two_dims_offsets_kv = all(
            i * last_two_dims_size == x.storage_offset() for i, x in enumerate([k, v])
        )
4191

4192
4193
4194
4195
        if (
            check_ptrs_qkv
            and check_strides_qkv
            and check_shapes_qkv
4196
            and check_last_two_dims_offsets_qkv
4197
4198
            and not check_last_dim_offsets_qkv
        ):
4199
            # sb3hd, bs3hd, t3hd
4200
4201
4202
4203
            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
        ):
4204
            # sbh3d, bsh3d, th3d
4205
4206
4207
4208
4209
            qkv_layout = qkv_format[:-1] + "3" + qkv_format[-1:]
        elif (
            check_ptrs_kv
            and check_strides_kv
            and check_shapes_kv
4210
            and check_last_two_dims_offsets_kv
4211
4212
            and not check_last_dim_offsets_kv
        ):
4213
            # sbhd_sb2hd, bshd_bs2hd, thd_t2hd
4214
4215
            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:
4216
            # sbhd_sbh2d, bshd_bsh2d, thd_th2d
4217
            qkv_layout = qkv_format + "_" + qkv_format[:-1] + "2" + qkv_format[-1:]
4218
4219
        elif check_strides_kv and check_shapes_kv:
            # sbhd_sbhd_sbhd, bshd_bshd_bshd, thd_thd_thd
4220
            qkv_layout = "_".join(list([qkv_format]) * 3)
4221
        else:
4222
            qkv_layout = "not_supported"
4223
4224
4225
4226

        return qkv_layout

    qkv_layout = run_iteratively(q, k, v)
4227
    if qkv_layout == "not_supported":
4228
4229
4230
        # 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)
4231
    if qkv_layout == "not_supported":
4232
4233
        raise Exception("The provided qkv memory layout is not supported!")

4234
    return qkv_layout, q, k, v
4235

4236

4237
def check_set_window_size(
4238
4239
4240
    attn_mask_type: str,
    window_size: Tuple[int, int] = None,
):
4241
4242
4243
4244
4245
4246
4247
4248
    """Check if sliding window size is compliant with attention mask type.
    If not, set it to the appropriate size.

         attn_mask_type                              |   window_size
    -------------------------------------------------------------------------
    no_mask, padding, arbitrary                      | (-1, -1) or (>=0, >=0)
    causal, padding_causal                           | (-1,  0) or (>=0, 0)
    causal_bottom_right, padding_causal_bottom_right | (-1,  0) or (>=0, 0)
4249
    """
4250
    orig_window_size = window_size
4251
    if "causal" in attn_mask_type:
4252
        if orig_window_size is None:
4253
            window_size = (-1, 0)
4254
4255
4256
        elif orig_window_size == (-1, -1) or (
            orig_window_size[0] >= 0 and orig_window_size[1] != 0
        ):
4257
4258
4259
4260
            window_size = (orig_window_size[0], 0)
            warnings.warn(
                "window_size should be (-1, 0) or (>=0, 0) for attn_mask_type=" + attn_mask_type
            )
4261
        elif orig_window_size != (-1, 0) and (orig_window_size[0] < 0 or orig_window_size[1] != 0):
4262
4263
4264
4265
            assert False, (
                "window_size should be (-1, 0) or (>=0, 0) for attn_mask_type=" + attn_mask_type
            )
    elif attn_mask_type in ["no_mask", "padding", "arbitrary"]:
4266
4267
4268
        if orig_window_size is None:
            window_size = (-1, -1)
        elif orig_window_size == (-1, 0):
4269
            window_size = (-1, -1)
4270
4271
4272
            warnings.warn(
                "window_size should be (-1, -1) or (>=0, >=0) for attn_mask_type=" + attn_mask_type
            )
4273
        elif orig_window_size != (-1, -1) and (orig_window_size[0] < 0 or orig_window_size[1] < 0):
4274
4275
4276
4277
4278
            assert False, (
                "window_size should be (-1, -1) or (>=0, >=0) for attn_mask_type=" + attn_mask_type
            )
    else:
        assert False, "Invalid attn_mask_type: " + attn_mask_type
4279
    return window_size
4280

4281

4282
class FlashAttention(torch.nn.Module):
4283
    """Dot product attention, using HazyResearch flash-attn package:
4284
    https://github.com/Dao-AILab/flash-attention
4285
4286
4287
4288
    """

    def __init__(
        self,
4289
        softmax_scale: float,
4290
4291
        attention_dropout: float = 0.0,
        attention_dropout_ctx: Optional[Callable] = nullcontext,
4292
4293
        attention_type: str = "self",
        layer_number: Optional[int] = None,
4294
        deterministic: bool = False,
4295
4296
4297
4298
4299
4300
    ) -> None:
        super().__init__()

        assert (
            _flash_attn_version >= _flash_attn_version_required
        ), f"FlashAttention minimum version {_flash_attn_version_required} is required."
4301
4302
4303
        assert (
            _flash_attn_version <= _flash_attn_max_version
        ), f"FlashAttention maximum version {_flash_attn_max_version} is supported."
4304

4305
        self.softmax_scale = softmax_scale
4306
4307
        self.attention_dropout_ctx = attention_dropout_ctx
        self.attention_dropout = attention_dropout
4308
4309
        self.attention_type = attention_type
        self.layer_number = 1 if layer_number is None else layer_number
4310
        self.deterministic = deterministic
4311
4312
4313
4314
4315
4316

    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
4317
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
4318
4319
4320
        qkv_layout: str = "sbh3d",
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
4321
4322
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
4323
        attn_mask_type: str = "causal",
4324
        window_size: Optional[Tuple[int, int]] = None,
4325
        alibi_slopes: Optional[torch.Tensor] = None,
4326
        cp_group: Optional[dist_group_type] = None,
4327
        cp_global_ranks: List[int] = None,
4328
        cp_stream: torch.cuda.Stream = None,
4329
        cp_comm_type: str = "p2p",
4330
4331
        fp8: bool = False,
        fp8_meta: Optional[Dict[str, Any]] = None,
4332
4333
4334
    ) -> torch.Tensor:
        """flash-attn fprop"""

4335
4336
4337
4338
        assert all(
            x.dtype in [torch.float16, torch.bfloat16] or isinstance(x, Float8Tensor)
            for x in [query_layer, key_layer, value_layer]
        ), "FlashAttention only supports FP16 and BF16 data types, or Float8Tensors."
4339
4340
        assert (
            query_layer.is_cuda and key_layer.is_cuda and value_layer.is_cuda
4341
        ), "FlashAttention currently only supports CUDA tensors."
4342
4343
        assert (
            qkv_layout in QKVLayouts
4344
        ), f"FlashAttention does not support qkv_layout = {qkv_layout}!"
4345

4346
4347
        cp_size = 1 if cp_group is None else get_distributed_world_size(cp_group)
        context_parallel = cp_size > 1
4348

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

4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
        if all(not isinstance(x, Float8Tensor) for x in [query_layer, key_layer, value_layer]):
            if qkv_format == "sbhd":
                # For now just 128, will make it more general in the future
                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
                    )
                else:
                    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"]:
4368
                query_layer, key_layer, value_layer = [
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
                    x.contiguous() for x in (query_layer, key_layer, value_layer)
                ]
        else:
            if qkv_format == "sbhd":
                query_layer._data, key_layer._data, value_layer._data = [
                    x.transpose(0, 1).contiguous()
                    for x in (query_layer._data, key_layer._data, value_layer._data)
                ]
            elif qkv_format in ["bshd", "thd"]:
                query_layer._data, key_layer._data, value_layer._data = [
                    x.contiguous() for x in (query_layer._data, key_layer._data, value_layer._data)
4380
                ]
4381

4382
        batch_size = query_layer.shape[0]
4383

4384
        if qkv_format in ["sbhd", "bshd"]:
4385
            max_seqlen_q, max_seqlen_kv = query_layer.shape[1], key_layer.shape[1]
4386
4387
            max_seqlen_q *= cp_size
            max_seqlen_kv *= cp_size
4388
4389
4390

            if "padding" in attn_mask_type:
                assert not context_parallel, "Padding mask not supported with context parallelism!"
4391
4392
                # [b * s, h, d]
                query_layer, key_layer, value_layer = [
4393
                    x.reshape(x.shape[0] * x.shape[1], *x.shape[2:])
4394
4395
4396
4397
4398
4399
4400
                    for x in [query_layer, key_layer, value_layer]
                ]

                if self.attention_type == "self":
                    assert (
                        max_seqlen_q == max_seqlen_kv
                    ), "Maximum sequence length for Q and KV should be the same."
4401
                    if cu_seqlens_q is None:
4402
4403
4404
                        assert (
                            attention_mask is not None
                        ), "Please provide attention_mask for padding!"
4405
4406
4407
4408
4409
4410
                        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
4411
4412
                    )
                else:
4413
                    if cu_seqlens_q is None or cu_seqlens_kv is None:
4414
4415
4416
4417
4418
                        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])
4419
4420
4421
4422
                    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)
4423
                    key_layer, value_layer = PackTensors.apply(indices_kv, key_layer, value_layer)
4424
            else:
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
                # 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,
                    )
4438
4439
4440
4441
        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!"
4442
4443
4444
4445
4446
4447
            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()
4448

4449
4450
4451
        if context_parallel and all(
            not isinstance(x, Float8Tensor) for x in [query_layer, key_layer, value_layer]
        ):
4452
4453
4454
            assert (
                alibi_slopes is None
            ), "Alibi slope bias addition is not supported with context parallelism."
4455
            with self.attention_dropout_ctx():
4456
                output = attn_forward_func_with_cp(
4457
4458
4459
4460
4461
4462
4463
4464
                    self.training,
                    query_layer,
                    key_layer,
                    value_layer,
                    cu_seqlens_q,
                    cu_seqlens_kv,
                    max_seqlen_q,
                    max_seqlen_kv,
4465
4466
                    cu_seqlens_q,
                    cu_seqlens_kv,
4467
                    self.attention_dropout if self.training else 0.0,
4468
4469
4470
                    cp_group,
                    cp_global_ranks,
                    cp_stream,
4471
                    cp_comm_type,
4472
                    softmax_scale=self.softmax_scale,
4473
                    qkv_format="bshd" if qkv_format == "sbhd" else qkv_format,
4474
                    attn_mask_type=attn_mask_type,
4475
                    deterministic=self.deterministic,
4476
                    window_size=window_size,
4477
4478
                )
        else:
4479
4480

            from .cpu_offload import CPUOffloadEnabled
4481

4482
4483
4484
4485
4486
4487
            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

4488
            with self.attention_dropout_ctx():
4489
                fa_optional_forward_kwargs = {}
4490
4491
                if _flash_attn_2_3_plus:
                    fa_optional_forward_kwargs["window_size"] = window_size
4492
4493
4494
4495
                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
4496
4497
                if _flash_attn_2_5_7_plus:
                    fa_optional_forward_kwargs["block_table"] = None
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
                fa_optional_forward_args_thd = []
                if qkv_format in ["bshd", "sbhd"] and "padding" not in attn_mask_type:
                    func = flash_attn_func if not _use_flash_attn_3 else flash_attn_func_v3
                else:
                    func = (
                        flash_attn_varlen_func
                        if not _use_flash_attn_3
                        else flash_attn_varlen_func_v3
                    )
                    fa_optional_forward_args_thd.append(cu_seqlens_q)
                    fa_optional_forward_args_thd.append(cu_seqlens_kv)
                    fa_optional_forward_args_thd.append(max_seqlen_q)
                    fa_optional_forward_args_thd.append(max_seqlen_kv)
                if _use_flash_attn_3:
                    if fp8:
                        fp8_dtype_forward = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
                        activation_dtype = query_layer.dtype
                        torch_dtype = get_fp8_torch_dtype(fp8_meta["recipe"], fprop_tensor=True)
                        if fp8_meta["recipe"].fp8_mha:
                            assert all(
                                isinstance(x, Float8Tensor)
                                for x in [query_layer, key_layer, value_layer]
                            ), "q/k/v must be Float8Tensors for FP8 MHA."
                            fp8_meta["scaling_fwd"].scale_inv[META_QKV] = query_layer._scale_inv
                            query_layer, key_layer, value_layer = (
                                x.to(activation_dtype).to(torch_dtype)
                                for x in [query_layer, key_layer, value_layer]
                            )
                        else:
                            query_layer, key_layer, value_layer = (
                                x.to(torch_dtype) for x in [query_layer, key_layer, value_layer]
                            )
                    output, _ = func(
                        query_layer,
                        key_layer,
                        value_layer,
                        *fa_optional_forward_args_thd,
                        softmax_scale=self.softmax_scale,
                        causal="causal" in attn_mask_type,
                        deterministic=self.deterministic,
                    )
                    if fp8 and fp8_meta["recipe"].fp8_mha:
                        output = cast_to_fp8(
                            output,
                            fp8_meta["scaling_fwd"],
                            META_O,
                            fp8_dtype_forward,
                        )
                        output = Float8Tensor(
                            data=output,
                            fp8_meta=fp8_meta,
                            fp8_meta_forward=True,
                            fp8_meta_index=META_O,
                            fp8_dtype=fp8_dtype_forward,
                            dtype=activation_dtype,
                        )
                else:
                    output = func(
                        query_layer,
                        key_layer,
                        value_layer,
                        *fa_optional_forward_args_thd,
                        self.attention_dropout if self.training else 0.0,
                        softmax_scale=self.softmax_scale,
                        causal="causal" in attn_mask_type,
                        **fa_optional_forward_kwargs,
                    )
4565

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

4569
        if qkv_format == "sbhd":
4570
            # (bs)hd -> bs(hd) -> sb(hd)
4571
4572
4573
4574
4575
4576
4577
4578
4579
            if fp8 and fp8_meta["recipe"].fp8_mha:
                output.reshape(batch_size * max_seqlen_q // cp_size, -1).transpose_2d()
                output = output.reshape(batch_size, max_seqlen_q // cp_size, -1)
            else:
                output = (
                    output.view(batch_size, max_seqlen_q // cp_size, -1)
                    .transpose(0, 1)
                    .contiguous()
                )
4580
        elif qkv_format == "bshd":
4581
            # (bs)hd -> bs(hd)
4582
            output = output.reshape(batch_size, max_seqlen_q // cp_size, -1)
4583
        elif qkv_format == "thd":
4584
            # thd -> t(hd)
4585
            output = output.reshape(output.shape[0], -1)
4586
4587

        return output
4588

4589

4590
def _combine_tensors(
4591
4592
4593
    tensors: List[torch.Tensor],
    dim: int,
) -> torch.Tensor:
4594
4595
4596
4597
4598
4599
    """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())
4600
    new_stride.insert(dim, int(new_stride[dim - 1] / num_tensors))
4601
    if isinstance(tensors[0], Float8Tensor):
4602
        combined_tensor = torch.Tensor().to(device=tensors[0].device, dtype=tensors[0]._data.dtype)
4603
4604
4605
        combined_tensor.set_(
            tensors[0]._data.untyped_storage(),
            tensors[0]._data.storage_offset(),
4606
4607
4608
4609
            new_shape,
            new_stride,
        )
        combined_tensor = Float8Tensor.make_like(tensors[0], data=combined_tensor)
4610
    else:
4611
        combined_tensor = torch.Tensor().to(device=tensors[0].device, dtype=tensors[0].dtype)
4612
        combined_tensor.set_(
4613
4614
            tensors[0].untyped_storage(), tensors[0].storage_offset(), new_shape, new_stride
        )
4615
4616

    return combined_tensor
4617

4618

4619
4620
4621
4622
class FusedAttnFunc_qkvpacked(torch.autograd.Function):
    """Function for FusedAttention with packed QKV input"""

    @staticmethod
4623
4624
4625
4626
4627
    def forward(
        ctx,
        is_training,
        max_seqlen,
        cu_seqlens,
4628
        cu_seqlens_padded,
4629
4630
4631
4632
4633
4634
4635
4636
4637
        qkv,
        qkv_dtype,
        attn_bias,
        attn_scale,
        dropout_p,
        fast_zero_fill,
        qkv_layout,
        attn_bias_type,
        attn_mask_type,
4638
        window_size,
4639
4640
4641
4642
4643
        rng_gen,
        fused_attention_backend,
        use_FAv2_bwd,
        fp8,
        fp8_meta,
4644
        deterministic,
4645
    ):
4646
4647
        is_input_fp8 = False
        is_output_fp8 = fp8_meta["recipe"].fp8_mha
4648
        if fp8:
4649
4650
            is_input_fp8 = isinstance(qkv, Float8Tensor)
            if is_input_fp8:
4651
4652
4653
4654
                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
4655
            qkv_group = len(qkv_layout.split("_"))
4656
4657
4658
4659
            assert (
                qkv_group == 1
            ), f"qkv layout should conform to 3hd or h3d, e.g. sb3hd, but found {qkv_layout}."
            if is_input_fp8:
4660
4661
4662
                qkv_fp8 = qkv._data
            else:
                qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
4663
4664
4665
                qkv_fp8 = cast_to_fp8(
                    qkv_c, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                ).view(qkv.shape)
4666
            out_fp8, aux_ctx_tensors = fused_attn_fwd_qkvpacked(
4667
4668
4669
4670
4671
4672
4673
                is_training,
                max_seqlen,
                cu_seqlens,
                qkv_fp8,
                fp8_dtype_forward,
                fused_attention_backend,
                attn_bias,
4674
                cu_seqlens_padded,
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
                fp8_meta["scaling_fwd"].scale_inv,  # d_scale_qkv
                META_QKV,  # d_scale_qkv_offset
                fp8_meta["scaling_fwd"].scale_inv,  # d_scale_s
                META_S,  # d_scale_s_offset
                fp8_meta["scaling_fwd"].scale,  # q_scale_s
                META_S,  # q_scale_s_offset
                fp8_meta["scaling_fwd"].scale,  # q_scale_o
                META_O,  # q_scale_o_offset
                fp8_meta["scaling_fwd"].amax_history,  # amax_s
                META_S,  # amax_s_offset
                fp8_meta["scaling_fwd"].amax_history,  # amax_o
                META_O,  # amax_o_offset
4687
4688
4689
4690
4691
4692
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
4693
                window_size,
4694
4695
                rng_gen,
            )
4696
            if is_output_fp8:
4697
4698
                out_ret = Float8Tensor(
                    data=out_fp8,
4699
4700
4701
4702
4703
4704
4705
4706
4707
                    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]),
4708
4709
4710
4711
4712
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
4713
            out_save = out_ret
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
            if not int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
                if is_input_fp8:
                    qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
                    qkv = cast_from_fp8(
                        qkv_c._data,
                        fp8_meta["scaling_fwd"],
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[qkv.dtype],
                    ).view(qkv.shape)
                if is_output_fp8:
                    out_save = cast_from_fp8(
                        out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
                        fp8_meta["scaling_fwd"],
                        META_O,
                        fp8_dtype_forward,
                        qkv_dtype,
                    ).view(out_fp8.shape)
4732
4733
4734
            fp8_tensors = (
                qkv_fp8,
                out_fp8,
4735
                fp8_meta["scaling_fwd"].scale.clone(),
4736
4737
                fp8_meta["scaling_fwd"].scale_inv.clone(),
            )
4738
4739
        else:
            out_ret, aux_ctx_tensors = fused_attn_fwd_qkvpacked(
4740
4741
4742
4743
4744
4745
4746
                is_training,
                max_seqlen,
                cu_seqlens,
                qkv,
                qkv_dtype,
                fused_attention_backend,
                attn_bias,
4747
                cu_seqlens_padded,
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
                None,  # d_scale_qkv
                0,  # d_scale_qkv_offset
                None,  # d_scale_s
                0,  # d_scale_s_offset
                None,  # q_scale_s
                0,  # q_scale_s_offset
                None,  # q_scale_o
                0,  # q_scale_o_offset
                None,  # amax_s
                0,  # amax_s_offset
                None,  # amax_o
                0,  # amax_o_offset
4760
4761
4762
4763
4764
4765
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
4766
                window_size,
4767
4768
                rng_gen,
            )
4769
4770
4771
4772
            fp8_tensors = (None, None, None, None)
            out_save = out_ret

        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
4773
4774
        ctx.is_input_fp8 = is_input_fp8
        ctx.is_output_fp8 = is_output_fp8
4775
        qkvo_tensors = (qkv, out_save) if not ctx.fp8 else (None, None)
4776
        ctx.save_for_backward(
4777
            *qkvo_tensors, cu_seqlens, cu_seqlens_padded, *fp8_tensors, *aux_ctx_tensors
4778
        )
4779
        ctx.fp8_meta = fp8_meta
4780
4781
4782
4783
4784
4785
4786
4787
        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
4788
        ctx.window_size = window_size
4789
        ctx.fused_attention_backend = (
4790
            fused_attention_backend if ctx.fp8 else FusedAttnBackend["F16_arbitrary_seqlen"]
4791
        )
4792
        ctx.use_FAv2_bwd = use_FAv2_bwd
4793
        ctx.deterministic = deterministic
4794

4795
        return out_ret
4796
4797
4798

    @staticmethod
    def backward(ctx, d_out):
4799
        if ctx.is_output_fp8:
4800
4801
4802
            assert isinstance(
                d_out, Float8Tensor
            ), "Gradient of the DPA output must be in Float8Tensor type for FP8 MHA."
4803
4804
4805
            d_out_f8tensor = d_out
            d_out = d_out._data

4806
        d_out = d_out.contiguous()
4807
4808
4809
4810
        (
            qkv,
            out,
            cu_seqlens,
4811
            cu_seqlens_padded,
4812
4813
4814
4815
4816
4817
            qkv_fp8,
            out_fp8,
            fwd_scales,
            fwd_scale_invs,
            *aux_ctx_tensors,
        ) = ctx.saved_tensors
4818
4819
        if not aux_ctx_tensors[0].is_contiguous():
            aux_ctx_tensors[0] = aux_ctx_tensors[0].contiguous()
4820
        if ctx.use_FAv2_bwd:
4821
            softmax_lse, rng_state = aux_ctx_tensors
4822
4823
            dqkv = torch.empty_like(qkv)
            maybe_contiguous = lambda x: x.contiguous() if x.stride(-1) != 1 else x
4824
4825
4826
            d_out, q, k, v, out = [
                maybe_contiguous(x) for x in (d_out, qkv[:, 0], qkv[:, 1], qkv[:, 2], out)
            ]
4827
            flash_attn_cuda_bwd(
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
                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,
4847
            )
4848
            dqkv = dqkv[..., : d_out.shape[-1]]
4849
        else:
4850
4851
            with torch.cuda.nvtx.range("_FusedAttn_qkvpacked"):
                if ctx.fp8:
4852
                    fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
4853
                    fp8_dtype_backward = get_fp8_te_dtype(
4854
4855
                        ctx.fp8_meta["recipe"], fprop_tensor=False
                    )
4856
                    if ctx.is_output_fp8:
4857
                        d_out_fp8 = d_out
4858
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = d_out_f8tensor._scale_inv
4859
4860
4861
                    else:
                        d_out_fp8 = cast_to_fp8(
                            d_out.view(-1, d_out.shape[-2] * d_out.shape[-1]),
4862
4863
4864
4865
                            ctx.fp8_meta["scaling_bwd"],
                            META_DO,
                            fp8_dtype_backward,
                        ).view(d_out.shape)
4866
                    dqkv_fp8, *rest = fused_attn_bwd_qkvpacked(
4867
4868
4869
4870
4871
4872
4873
4874
                        ctx.max_seqlen,
                        cu_seqlens,
                        qkv_fp8,
                        out_fp8,
                        d_out_fp8,
                        fp8_dtype_forward,
                        fp8_dtype_backward,
                        aux_ctx_tensors,
4875
                        ctx.fused_attention_backend,
4876
                        cu_seqlens_padded,
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
                        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,
4893
4894
                        ctx.window_size,
                        ctx.deterministic,
4895
                    )
4896
                    if ctx.is_input_fp8:
4897
4898
                        dqkv = Float8Tensor(
                            data=dqkv_fp8,
4899
4900
4901
4902
4903
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
4904
                        )
4905
                    else:
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
                        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)
4916
4917
4918
4919
                else:
                    if d_out.dtype == torch.uint8:
                        d_out = d_out_f8tensor.from_float8(qkv.dtype)
                    dqkv, *rest = fused_attn_bwd_qkvpacked(
4920
4921
4922
4923
4924
4925
4926
4927
                        ctx.max_seqlen,
                        cu_seqlens,
                        qkv,
                        out,
                        d_out,
                        ctx.qkv_dtype,
                        ctx.qkv_dtype,
                        aux_ctx_tensors,
4928
                        ctx.fused_attention_backend,
4929
                        cu_seqlens_padded,
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
                        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,
4946
4947
                        ctx.window_size,
                        ctx.deterministic,
4948
                    )
4949

4950
4951
        # if no_bias or alibi, return dqkv
        if ctx.attn_bias_type in ["no_bias", "alibi"]:
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
            return (
                None,
                None,
                None,
                None,
                dqkv,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
                None,
4973
4974
                None,
                None,
4975
            )
4976
        # else, return (dqkv, dbias)
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
        return (
            None,
            None,
            None,
            None,
            dqkv,
            None,
            rest[0],
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
4998
4999
            None,
            None,
5000
        )
5001

5002

5003
5004
5005
5006
class FusedAttnFunc_kvpacked(torch.autograd.Function):
    """Function for FusedAttention with packed KV input"""

    @staticmethod
5007
5008
5009
5010
5011
5012
5013
    def forward(
        ctx,
        is_training,
        max_seqlen_q,
        max_seqlen_kv,
        cu_seqlens_q,
        cu_seqlens_kv,
5014
5015
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
        q,
        kv,
        qkv_dtype,
        attn_bias,
        attn_scale,
        dropout_p,
        fast_zero_fill,
        qkv_layout,
        attn_bias_type,
        attn_mask_type,
5026
        window_size,
5027
5028
5029
5030
5031
        rng_gen,
        fused_attention_backend,
        use_FAv2_bwd,
        fp8,
        fp8_meta,
5032
        deterministic,
5033
    ):
5034
5035
        is_input_fp8 = False
        is_output_fp8 = fp8_meta["recipe"].fp8_mha
5036
        if fp8:
5037
5038
5039
            assert isinstance(kv, q.__class__), "q and kv must have the same type."
            is_input_fp8 = isinstance(q, Float8Tensor)
            if is_input_fp8:
5040
5041
5042
                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)
5043
            if is_input_fp8:
5044
5045
5046
                q_fp8, kv_fp8 = q._data, kv._data
            else:
                # 1: qkv packed, 2: kv packed, 3: qkv separate
5047
5048
                qkv_group = len(qkv_layout.split("_"))
                assert qkv_group == 2, (
5049
5050
                    "qkv layout should conform to hd_2hd or hd_h2d, e.g. sbhd_sb2hd, "
                    f"but found {qkv_layout}."
5051
5052
5053
5054
                )
                q_fp8 = cast_to_fp8(q, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward).view(
                    q.shape
                )
5055
                kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
5056
5057
5058
                kv_fp8 = cast_to_fp8(
                    kv_c, fp8_meta["scaling_fwd"], META_QKV, fp8_dtype_forward
                ).view(kv.shape)
5059
            out_fp8, aux_ctx_tensors = fused_attn_fwd_kvpacked(
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
                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,
5070
5071
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
                fp8_meta["scaling_fwd"].scale_inv,  # d_scale_qkv
                META_QKV,  # d_scale_qkv_offset
                fp8_meta["scaling_fwd"].scale_inv,  # d_scale_s
                META_S,  # d_scale_s_offset
                fp8_meta["scaling_fwd"].scale,  # q_scale_s
                META_S,  # q_scale_s_offset
                fp8_meta["scaling_fwd"].scale,  # q_scale_o
                META_O,  # q_scale_o_offset
                fp8_meta["scaling_fwd"].amax_history,  # amax_s
                META_S,  # amax_s_offset
                fp8_meta["scaling_fwd"].amax_history,  # amax_o
                META_O,  # amax_o_offset
5084
5085
5086
5087
5088
5089
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
5090
                window_size,
5091
5092
                rng_gen,
            )
5093
            if is_output_fp8:
5094
5095
                out_ret = Float8Tensor(
                    data=out_fp8,
5096
5097
5098
5099
5100
5101
5102
5103
5104
                    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]),
5105
5106
5107
5108
5109
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
5110
            out_save = out_ret
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
            if not int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
                if is_input_fp8:
                    q = cast_from_fp8(
                        q._data,
                        fp8_meta["scaling_fwd"],
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[q.dtype],
                    ).view(q.shape)
                    kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
                    kv = cast_from_fp8(
                        kv_c._data,
                        fp8_meta["scaling_fwd"],
                        META_QKV,
                        fp8_dtype_forward,
                        TE_DType[kv.dtype],
                    ).view(kv.shape)
                if is_output_fp8:
                    out_save = cast_from_fp8(
                        out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
                        fp8_meta["scaling_fwd"],
                        META_O,
                        fp8_dtype_forward,
                        qkv_dtype,
                    ).view(out_fp8.shape)
5136
5137
5138
5139
            fp8_tensors = (
                q_fp8,
                kv_fp8,
                out_fp8,
5140
                fp8_meta["scaling_fwd"].scale.clone(),
5141
5142
                fp8_meta["scaling_fwd"].scale_inv.clone(),
            )
5143
5144
        else:
            out_ret, aux_ctx_tensors = fused_attn_fwd_kvpacked(
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
                is_training,
                max_seqlen_q,
                max_seqlen_kv,
                cu_seqlens_q,
                cu_seqlens_kv,
                q,
                kv,
                qkv_dtype,
                fused_attention_backend,
                attn_bias,
5155
5156
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
                None,  # d_scale_qkv
                0,  # d_scale_qkv_offset
                None,  # d_scale_s
                0,  # d_scale_s_offset
                None,  # q_scale_s
                0,  # q_scale_s_offset
                None,  # q_scale_o
                0,  # q_scale_o_offset
                None,  # amax_s
                0,  # amax_s_offset
                None,  # amax_o
                0,  # amax_o_offset
5169
5170
5171
5172
5173
5174
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
5175
                window_size,
5176
5177
                rng_gen,
            )
5178
5179
5180
5181
            out_save = out_ret
            fp8_tensors = (None, None, None, None, None)

        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))
5182
5183
        ctx.is_input_fp8 = is_input_fp8
        ctx.is_output_fp8 = is_output_fp8
5184
        qkvo_tensors = (q, kv, out_save) if not ctx.fp8 else (None, None, None)
5185
5186
5187
5188
        ctx.save_for_backward(
            *qkvo_tensors,
            cu_seqlens_q,
            cu_seqlens_kv,
5189
5190
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
5191
5192
5193
            *fp8_tensors,
            *aux_ctx_tensors,
        )
5194
        ctx.fp8_meta = fp8_meta
5195
5196
5197
5198
5199
5200
5201
5202
5203
        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
5204
        ctx.window_size = window_size
5205
        ctx.fused_attention_backend = (
5206
            fused_attention_backend if ctx.fp8 else FusedAttnBackend["F16_arbitrary_seqlen"]
5207
        )
5208
        ctx.use_FAv2_bwd = use_FAv2_bwd
5209
        ctx.deterministic = deterministic
5210

5211
        return out_ret
5212
5213
5214

    @staticmethod
    def backward(ctx, d_out):
5215
        if ctx.is_output_fp8:
5216
5217
5218
            assert isinstance(
                d_out, Float8Tensor
            ), "Gradient of the DPA output must be in Float8Tensor type for FP8 MHA."
5219
5220
5221
            d_out_f8tensor = d_out
            d_out = d_out._data

5222
        d_out = d_out.contiguous()
5223
5224
5225
5226
5227
5228
        (
            q,
            kv,
            out,
            cu_seqlens_q,
            cu_seqlens_kv,
5229
5230
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
5231
5232
5233
5234
5235
5236
5237
            q_fp8,
            kv_fp8,
            out_fp8,
            fwd_scales,
            fwd_scale_invs,
            *aux_ctx_tensors,
        ) = ctx.saved_tensors
5238
5239
        if not aux_ctx_tensors[0].is_contiguous():
            aux_ctx_tensors[0] = aux_ctx_tensors[0].contiguous()
5240
        if ctx.use_FAv2_bwd:
5241
            softmax_lse, rng_state = aux_ctx_tensors
5242
5243
5244
            dq = torch.empty_like(q)
            dkv = torch.empty_like(kv)
            maybe_contiguous = lambda x: x.contiguous() if x.stride(-1) != 1 else x
5245
            d_out, q, k, v, out = [maybe_contiguous(x) for x in (d_out, q, kv[:, 0], kv[:, 1], out)]
5246
            flash_attn_cuda_bwd(
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
                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,
5266
            )
5267
5268
            dq = dq[..., : d_out.shape[-1]]
            dkv = dkv[..., : d_out.shape[-1]]
5269
        else:
5270
5271
            with torch.cuda.nvtx.range("_FusedAttn_kvpacked"):
                if ctx.fp8:
5272
                    fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
5273
                    fp8_dtype_backward = get_fp8_te_dtype(
5274
5275
                        ctx.fp8_meta["recipe"], fprop_tensor=False
                    )
5276
                    if ctx.is_output_fp8:
5277
                        d_out_fp8 = d_out
5278
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = d_out_f8tensor._scale_inv
5279
5280
5281
                    else:
                        d_out_fp8 = cast_to_fp8(
                            d_out.view(-1, d_out.shape[-2] * d_out.shape[-1]),
5282
5283
5284
5285
                            ctx.fp8_meta["scaling_bwd"],
                            META_DO,
                            fp8_dtype_backward,
                        ).view(d_out.shape)
5286
                    dq_fp8, dkv_fp8, *rest = fused_attn_bwd_kvpacked(
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
                        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,
5298
                        ctx.fused_attention_backend,
5299
5300
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
                        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,
5317
5318
                        ctx.window_size,
                        ctx.deterministic,
5319
                    )
5320
                    if ctx.is_input_fp8:
5321
5322
                        dq = Float8Tensor(
                            data=dq_fp8,
5323
5324
5325
5326
5327
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
5328
5329
5330
                        )
                        dkv = Float8Tensor(
                            data=dkv_fp8,
5331
5332
5333
5334
5335
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
5336
                        )
5337
5338
5339
                    else:
                        dq = cast_from_fp8(
                            dq_fp8.view(-1, dq_fp8.shape[-2] * dq_fp8.shape[-1]),
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
                            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)
5355
5356
5357
5358
                else:
                    if d_out.dtype == torch.uint8:
                        d_out = d_out_f8tensor.from_float8(q.dtype)
                    dq, dkv, *rest = fused_attn_bwd_kvpacked(
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
                        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,
5370
                        ctx.fused_attention_backend,
5371
5372
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
                        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,
5389
5390
                        ctx.window_size,
                        ctx.deterministic,
5391
                    )
5392

5393
5394
        # if no_bias or alibi, return dqkv
        if ctx.attn_bias_type in ["no_bias", "alibi"]:
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
            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,
5420
5421
                None,
                None,
5422
            )
5423
        # else, return (dqkv, dbias)
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
        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,
5449
5450
            None,
            None,
5451
5452
        )

5453

5454
5455
5456
5457
class FusedAttnFunc(torch.autograd.Function):
    """Function for FusedAttention with separate Q, K, V tensors"""

    @staticmethod
5458
5459
5460
5461
5462
5463
5464
    def forward(
        ctx,
        is_training,
        max_seqlen_q,
        max_seqlen_kv,
        cu_seqlens_q,
        cu_seqlens_kv,
5465
5466
        cu_seqlens_q_padded,
        cu_seqlens_kv_padded,
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
        q,
        k,
        v,
        qkv_dtype,
        attn_bias,
        attn_scale,
        dropout_p,
        fast_zero_fill,
        qkv_layout,
        attn_bias_type,
        attn_mask_type,
5478
        window_size,
5479
5480
5481
5482
5483
        rng_gen,
        fused_attention_backend,
        use_FAv2_bwd,
        fp8,
        fp8_meta,
5484
        deterministic,
5485
    ):
5486
5487
        is_input_fp8 = False
        is_output_fp8 = fp8_meta["recipe"].fp8_mha
5488
5489
5490
        if fp8:
            fused_attention_backend = FusedAttnBackend["FP8"]
            fp8_dtype_forward = get_fp8_te_dtype(fp8_meta["recipe"], fprop_tensor=True)
5491
5492
5493
5494
5495
            assert isinstance(k, q.__class__) and isinstance(
                v, q.__class__
            ), "q, k, and v must have the same type."
            is_input_fp8 = isinstance(q, Float8Tensor)
            if is_input_fp8:
5496
5497
5498
5499
                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
5500
                qkv_group = len(qkv_layout.split("_"))
5501
                if qkv_group == 1:
5502
5503
                    dim = qkv_layout.find("3")
                    qkv = _combine_tensors([q, k, v], dim)
5504
                    qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
5505
5506
5507
5508
                    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])
5509
5510
                    q_fp8, k_fp8, v_fp8 = [x.squeeze(dim) for x in [q_fp8, k_fp8, v_fp8]]
                if qkv_group == 2:
5511
5512
5513
5514
5515
                    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)
5516
                    kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
5517
5518
5519
5520
                    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])
5521
5522
                    k_fp8, v_fp8 = [x.squeeze(dim) for x in [k_fp8, v_fp8]]
                if qkv_group == 3:
5523
5524
5525
5526
5527
5528
5529
5530
5531
                    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)
5532
            out_fp8, aux_ctx_tensors = fused_attn_fwd(
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
                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,
5544
5545
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
                fp8_meta["scaling_fwd"].scale_inv,  # d_scale_qkv
                META_QKV,  # d_scale_qkv_offset
                fp8_meta["scaling_fwd"].scale_inv,  # d_scale_s
                META_S,  # d_scale_s_offset
                fp8_meta["scaling_fwd"].scale,  # q_scale_s
                META_S,  # q_scale_s_offset
                fp8_meta["scaling_fwd"].scale,  # q_scale_o
                META_O,  # q_scale_o_offset
                fp8_meta["scaling_fwd"].amax_history,  # amax_s
                META_S,  # amax_s_offset
                fp8_meta["scaling_fwd"].amax_history,  # amax_o
                META_O,  # amax_o_offset
5558
5559
5560
5561
5562
5563
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
5564
                window_size,
5565
5566
                rng_gen,
            )
5567
            if is_output_fp8:
5568
5569
                out_ret = Float8Tensor(
                    data=out_fp8,
5570
5571
5572
5573
5574
5575
5576
5577
5578
                    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]),
5579
5580
5581
5582
5583
                    fp8_meta["scaling_fwd"],
                    META_O,
                    fp8_dtype_forward,
                    qkv_dtype,
                ).view(out_fp8.shape)
5584
5585
            out_save = out_ret

5586
            if not int(os.getenv("NVTE_FP8_DPA_BWD", "1")):
5587
                # 1: qkv packed, 2: kv packed, 3: qkv separate
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
                if is_input_fp8:
                    qkv_group = len(qkv_layout.split("_"))
                    if qkv_group == 1:
                        dim = qkv_layout.find("3")
                        qkv = _combine_tensors([q, k, v], dim)
                        qkv_c = qkv.view(-1, qkv.shape[-3] * qkv.shape[-2] * qkv.shape[-1])
                        qkv_no_fp8 = cast_from_fp8(
                            qkv_c._data,
                            fp8_meta["scaling_fwd"],
                            META_QKV,
                            fp8_dtype_forward,
                            TE_DType[qkv.dtype],
                        ).view(qkv.shape)
                        q, k, v = _SplitAlongDim.apply(qkv_no_fp8, dim, [1, 1, 1])
                        q, k, v = [x.squeeze(dim) for x in [q, k, v]]
                    if qkv_group == 2:
                        q = cast_from_fp8(
                            q._data,
                            fp8_meta["scaling_fwd"],
                            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)
                        kv_c = kv.view(-1, kv.shape[-3] * kv.shape[-2] * kv.shape[-1])
                        kv_no_fp8 = cast_from_fp8(
                            kv_c._data,
                            fp8_meta["scaling_fwd"],
                            META_QKV,
                            fp8_dtype_forward,
                            TE_DType[kv.dtype],
                        ).view(kv.shape)
                        k, v = _SplitAlongDim.apply(kv_no_fp8, dim, [1, 1])
                        k, v = [x.squeeze(dim) for x in [k, v]]
                    if qkv_group == 3:
                        q = cast_from_fp8(
                            q._data,
                            fp8_meta["scaling_fwd"],
                            META_QKV,
                            fp8_dtype_forward,
                            TE_DType[q.dtype],
                        ).view(q.shape)
                        k = cast_from_fp8(
                            k._data,
                            fp8_meta["scaling_fwd"],
                            META_QKV,
                            fp8_dtype_forward,
                            TE_DType[k.dtype],
                        ).view(k.shape)
                        v = cast_from_fp8(
                            v._data,
                            fp8_meta["scaling_fwd"],
                            META_QKV,
                            fp8_dtype_forward,
                            TE_DType[v.dtype],
                        ).view(v.shape)
                if is_output_fp8:
                    out_save = cast_from_fp8(
                        out_fp8.view(-1, out_fp8.shape[-2] * out_fp8.shape[-1]),
5648
                        fp8_meta["scaling_fwd"],
5649
                        META_O,
5650
                        fp8_dtype_forward,
5651
5652
                        qkv_dtype,
                    ).view(out_fp8.shape)
5653
5654
5655
5656
5657
5658

            fp8_tensors = (
                q_fp8,
                k_fp8,
                v_fp8,
                out_fp8,
5659
                fp8_meta["scaling_fwd"].scale.clone(),
5660
5661
                fp8_meta["scaling_fwd"].scale_inv.clone(),
            )
5662
5663
        else:
            out_ret, aux_ctx_tensors = fused_attn_fwd(
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
                is_training,
                max_seqlen_q,
                max_seqlen_kv,
                cu_seqlens_q,
                cu_seqlens_kv,
                q,
                k,
                v,
                qkv_dtype,
                fused_attention_backend,
                attn_bias,
5675
5676
                cu_seqlens_q_padded,
                cu_seqlens_kv_padded,
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
                None,  # d_scale_qkv
                0,  # d_scale_qkv_offset
                None,  # d_scale_s
                0,  # d_scale_s_offset
                None,  # q_scale_s
                0,  # q_scale_s_offset
                None,  # q_scale_o
                0,  # q_scale_o_offset
                None,  # amax_s
                0,  # amax_s_offset
                None,  # amax_o
                0,  # amax_o_offset
5689
5690
5691
5692
5693
5694
                attn_scale,
                dropout_p,
                fast_zero_fill,
                qkv_layout,
                attn_bias_type,
                attn_mask_type,
5695
                window_size,
5696
5697
                rng_gen,
            )
5698
5699
            out_save = out_ret
            fp8_tensors = (None, None, None, None, None, None)
5700

5701
5702
        ctx.fp8 = fp8 and int(os.getenv("NVTE_FP8_DPA_BWD", "1"))

5703
        from .cpu_offload import CPUOffloadEnabled
5704

5705
        if CPUOffloadEnabled:
5706
5707
5708
5709
5710
5711
5712
            if ctx.fp8:
                tensor_list = fp8_tensors
            else:
                tensor_list = [q, k, v, out_save]

            tensor_list.extend(aux_ctx_tensors)

5713
            qkv_layout = "sbhd_sbhd_sbhd"
5714
5715
5716
5717
            for tensor in tensor_list:
                if tensor is not None:
                    tensor.activation_offloading = True

5718
5719
        ctx.is_input_fp8 = is_input_fp8
        ctx.is_output_fp8 = is_output_fp8
5720
        qkvo_tensors = (q, k, v, out_save) if not ctx.fp8 else (None, None, None, None)
5721
5722
5723
5724
        ctx.save_for_backward(
            *qkvo_tensors,
            cu_seqlens_q,
            cu_seqlens_kv,
5725
5726
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
5727
5728
5729
            *fp8_tensors,
            *aux_ctx_tensors,
        )
5730
        ctx.fp8_meta = fp8_meta
5731
5732
5733
5734
5735
5736
5737
5738
5739
        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
5740
        ctx.window_size = window_size
5741
        ctx.fused_attention_backend = (
5742
            fused_attention_backend if ctx.fp8 else FusedAttnBackend["F16_arbitrary_seqlen"]
5743
        )
5744
        ctx.use_FAv2_bwd = use_FAv2_bwd
5745
        ctx.deterministic = deterministic
5746

5747
        return out_ret
5748
5749
5750

    @staticmethod
    def backward(ctx, d_out):
5751
        if ctx.is_output_fp8:
5752
5753
5754
            assert isinstance(
                d_out, Float8Tensor
            ), "Gradient of the DPA output must be in Float8Tensor type for FP8 MHA."
5755
5756
5757
            d_out_f8tensor = d_out
            d_out = d_out._data

5758
        d_out = d_out.contiguous()
5759
5760
5761
5762
5763
5764
5765
        (
            q,
            k,
            v,
            out,
            cu_seqlens_q,
            cu_seqlens_kv,
5766
5767
            cu_seqlens_q_padded,
            cu_seqlens_kv_padded,
5768
5769
5770
5771
5772
5773
5774
5775
            q_fp8,
            k_fp8,
            v_fp8,
            out_fp8,
            fwd_scales,
            fwd_scale_invs,
            *aux_ctx_tensors,
        ) = ctx.saved_tensors
5776
5777
        if not aux_ctx_tensors[0].is_contiguous():
            aux_ctx_tensors[0] = aux_ctx_tensors[0].contiguous()
5778
        if ctx.use_FAv2_bwd:
5779
            softmax_lse, rng_state = aux_ctx_tensors
5780
5781
5782
5783
            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
5784
            d_out, q, k, v, out = [maybe_contiguous(x) for x in (d_out, q, k, v, out)]
5785
            flash_attn_cuda_bwd(
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
                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,
5805
            )
5806
5807
5808
            dq = dq[..., : d_out.shape[-1]]
            dk = dk[..., : d_out.shape[-1]]
            dv = dv[..., : d_out.shape[-1]]
5809
        else:
5810
5811
5812
5813
            with torch.cuda.nvtx.range("_FusedAttn"):
                if ctx.fp8:
                    fp8_dtype_forward = get_fp8_te_dtype(ctx.fp8_meta["recipe"], fprop_tensor=True)
                    fp8_dtype_backward = get_fp8_te_dtype(
5814
5815
                        ctx.fp8_meta["recipe"], fprop_tensor=False
                    )
5816
                    if ctx.is_output_fp8:
5817
                        d_out_fp8 = d_out
5818
                        ctx.fp8_meta["scaling_bwd"].scale_inv[META_DO] = d_out_f8tensor._scale_inv
5819
5820
5821
                    else:
                        d_out_fp8 = cast_to_fp8(
                            d_out.view(-1, d_out.shape[-2] * d_out.shape[-1]),
5822
5823
5824
5825
                            ctx.fp8_meta["scaling_bwd"],
                            META_DO,
                            fp8_dtype_backward,
                        ).view(d_out.shape)
5826
                    dq_fp8, dk_fp8, dv_fp8, *rest = fused_attn_bwd(
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
                        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,
5839
                        ctx.fused_attention_backend,
5840
5841
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
                        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,
5858
5859
                        ctx.window_size,
                        ctx.deterministic,
5860
                    )
5861

5862
                    if ctx.is_input_fp8:
5863
5864
                        dq = Float8Tensor(
                            data=dq_fp8,
5865
5866
5867
5868
5869
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
5870
5871
5872
                        )
                        dk = Float8Tensor(
                            data=dk_fp8,
5873
5874
5875
5876
5877
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
5878
5879
5880
                        )
                        dv = Float8Tensor(
                            data=dv_fp8,
5881
5882
5883
5884
5885
                            fp8_meta=ctx.fp8_meta,
                            fp8_meta_forward=False,
                            fp8_meta_index=META_DQKV,
                            fp8_dtype=fp8_dtype_backward,
                            dtype=d_out_f8tensor.dtype,
5886
                        )
5887
                    else:
5888
                        qkv_group = len(ctx.qkv_layout.split("_"))
5889
                        if qkv_group == 1:
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
                            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])
5903
5904
5905
5906
                            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]),
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
                                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])
5925
5926
5927
5928
                            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]),
5929
5930
5931
5932
5933
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dq_fp8.shape)
5934
5935
                            dk = cast_from_fp8(
                                dk_fp8.view(-1, dk_fp8.shape[-2] * dk_fp8.shape[-1]),
5936
5937
5938
5939
5940
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dk_fp8.shape)
5941
5942
                            dv = cast_from_fp8(
                                dv_fp8.view(-1, dv_fp8.shape[-2] * dv_fp8.shape[-1]),
5943
5944
5945
5946
5947
                                ctx.fp8_meta["scaling_bwd"],
                                META_DQKV,
                                fp8_dtype_backward,
                                ctx.qkv_dtype,
                            ).view(dv_fp8.shape)
5948
5949
5950
5951
                else:
                    if d_out.dtype == torch.uint8:
                        d_out = d_out_f8tensor.from_float8(q.dtype)
                    dq, dk, dv, *rest = fused_attn_bwd(
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
                        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,
5964
                        ctx.fused_attention_backend,
5965
5966
                        cu_seqlens_q_padded,
                        cu_seqlens_kv_padded,
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
                        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,
5983
5984
                        ctx.window_size,
                        ctx.deterministic,
5985
                    )
5986

5987
5988
        # if no_bias or alibi, return dqkv
        if ctx.attn_bias_type in ["no_bias", "alibi"]:
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
            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,
6015
6016
                None,
                None,
6017
            )
6018
        # else, return (dqkv, dbias)
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
        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,
6045
6046
            None,
            None,
6047
        )
6048

6049

6050
class FusedAttention(torch.nn.Module):
6051
6052
6053
6054
6055
6056
6057
6058
6059
    """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:

6060
6061
6062
6063
    | backend       | 1                       | 2                              |
    | flash based   | no                      | yes                            |
    | cuDNN based   | yes                     | yes                            |
    | qkv dtype     | fp16/bf16               | fp16/bf16                      |
6064
    | attn_type     | self/cross              | self/cross                     |
6065
    | qkv_layout    |                         |                                |
6066
    |  - (q,k,v)    | sb3hd, bs3hd            | sb3hd, bs3hd, sbh3d, bsh3d     |
6067
    |               | sbhd_sb2hd, bshd_bs2hd  | sbhd_sb2hd, bshd_bs2hd         |
6068
6069
    |               | bshd_bshd_bshd          | sbhd_sbh2d, bshd_bsh2d         |
    |               |                         | sbhd_sbhd_sbhd, bshd_bshd_bshd |
6070
6071
    | mask_type     | causal/padding/no_mask  | causal/padding/no_mask         |
    | bias_type     | post_scale_bias/no_bias | post_scale_bias/alibi/no_bias  |
6072
    | dropout       | yes                     | yes                            |
6073
6074
    | max_seqlen    | <=512, multiple of 64   | any, multiple of 64            |
    | head_dim      | 64                      | <=128, multiple of 8           |
6075
    | output dtype  | fp16/bf16               | fp16/bf16                      |
6076
6077
6078
6079
    """

    def __init__(
        self,
6080
        softmax_scale: float,
6081
6082
6083
        attention_dropout: float = 0.0,
        attention_dropout_ctx: Optional[Callable] = nullcontext,
        attention_type: str = "self",
6084
6085
        layer_number: Optional[int] = None,
        deterministic: bool = False,
6086
6087
6088
    ) -> None:
        super().__init__()

6089
        self.softmax_scale = softmax_scale
6090
6091
6092
        self.attention_dropout = attention_dropout
        self.attention_dropout_ctx = attention_dropout_ctx
        self.attention_type = attention_type
6093
6094
6095
        self.use_FAv2_bwd = os.getenv(
            "NVTE_FUSED_ATTN_USE_FAv2_BWD", "0"
        ) == "1" and get_device_compute_capability() == (9, 0)
6096
        self.layer_number = 1 if layer_number is None else layer_number
6097
        self.deterministic = deterministic
6098

6099
        def remove_extra_states_check(self, incompatible_keys):  # pylint: disable=unused-argument
6100
6101
            """
            Temporarily remove fused_attention._extra_state as a missing key
6102
6103
6104
6105
            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.
6106
6107
            """
            for key in incompatible_keys.missing_keys:
6108
                if "fused_attention._extra_state" in key:
6109
                    incompatible_keys.missing_keys.remove(key)
6110
6111
6112
6113
6114
6115
6116
            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."
                    )
6117

6118
6119
        self.register_load_state_dict_post_hook(remove_extra_states_check)

6120
    @no_torch_dynamo()
6121
6122
6123
6124
6125
    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
6126
6127
6128
        qkv_layout: str = "sbh3d",
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
6129
6130
        cu_seqlens_q_padded: Optional[torch.Tensor] = None,
        cu_seqlens_kv_padded: Optional[torch.Tensor] = None,
6131
6132
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
6133
        attn_mask_type: str = "causal",
6134
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
6135
        window_size: Optional[Tuple[int, int]] = None,
6136
        fused_attention_backend: tex.NVTE_Fused_Attn_Backend = tex.NVTE_Fused_Attn_Backend.NVTE_No_Backend,
6137
6138
6139
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
        fast_zero_fill: bool = True,
6140
6141
6142
        cp_group: Optional[dist_group_type] = None,
        cp_global_ranks: List[int] = None,
        cp_stream: torch.cuda.Stream = None,
6143
        cp_comm_type: str = "p2p",
6144
6145
        fp8: bool = False,
        fp8_meta: Optional[Dict[str, Any]] = None,
6146
6147
    ) -> torch.Tensor:
        """fused attention fprop"""
6148
6149
6150
        assert (
            fused_attention_backend != tex.NVTE_Fused_Attn_Backend.NVTE_No_Backend
        ), "No fused attention backend supports this input combination!"
6151
6152
6153
6154
        assert all(
            x.dtype in [torch.float16, torch.bfloat16] or isinstance(x, Float8Tensor)
            for x in [query_layer, key_layer, value_layer]
        ), "FusedAttention only supports FP16 and BF16 data types, or Float8Tensors."
6155
6156
        assert (
            query_layer.is_cuda and key_layer.is_cuda and value_layer.is_cuda
6157
        ), "FusedAttention only supports CUDA tensors."
6158
6159
        assert (
            qkv_layout in QKVLayouts
6160
        ), f"FusedAttention does not support qkv_layout = {qkv_layout}!"
6161

6162
6163
        cp_size = 1 if cp_group is None else get_distributed_world_size(cp_group)
        context_parallel = cp_size > 1
6164

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

6167
6168
        if qkv_format in ["sbhd", "bshd"]:
            if qkv_format == "sbhd":
6169
                batch_size, max_seqlen_q, max_seqlen_kv = (
6170
6171
6172
6173
6174
                    query_layer.shape[1],
                    query_layer.shape[0],
                    key_layer.shape[0],
                )
            if qkv_format == "bshd":
6175
                batch_size, max_seqlen_q, max_seqlen_kv = (
6176
6177
6178
6179
                    query_layer.shape[0],
                    query_layer.shape[1],
                    key_layer.shape[1],
                )
6180
6181
            max_seqlen_q *= cp_size
            max_seqlen_kv *= cp_size
6182
            if "padding" in attn_mask_type:
6183
6184
                assert not context_parallel, "Padding mask not supported with context parallelism!"

6185
6186
6187
6188
6189
                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!"
                        )
6190
                    if self.attention_type == "self":
6191
6192
                        cu_seqlens_q = get_cu_seqlens(attention_mask)
                        cu_seqlens_kv = cu_seqlens_q
6193
                    else:
6194
6195
                        cu_seqlens_q = get_cu_seqlens(attention_mask[0])
                        cu_seqlens_kv = get_cu_seqlens(attention_mask[1])
6196
            else:
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
                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,
                    )
6209
6210
6211
        if qkv_format == "thd":
            assert (
                max_seqlen_q is not None
6212
6213
6214
                and max_seqlen_kv is not None
                and cu_seqlens_q is not None
                and cu_seqlens_kv is not None
6215
            ), "max_seqlen_q/kv and cu_seqlens_q/kv can not be None when qkv_format is thd!"
6216
6217
6218
6219

        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
6220
6221
6222

        qkv_dtype = TE_DType[query_layer.dtype]

6223
6224
6225
6226
6227
        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)
        )
6228

6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
        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!"
            )
            assert fp8_meta is not None, "FP8 metadata fp8_meta is required for FP8 attention!"
            assert not context_parallel or fp8_meta["recipe"].reduce_amax, (
                "Amax reduction across TP+CP group is necessary when using context parallelism with"
                " FP8!"
            )

6240
        if context_parallel:
6241
            assert (
6242
6243
                fp8
                or fused_attention_backend == tex.NVTE_Fused_Attn_Backend.NVTE_F16_arbitrary_seqlen
6244
6245
6246
6247
6248
6249
6250
            ), 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)
            ]
6251
6252
6253
            with self.attention_dropout_ctx():
                output = attn_forward_func_with_cp(
                    self.training,
6254
6255
6256
6257
6258
6259
6260
                    query_layer,
                    key_layer,
                    value_layer,
                    cu_seqlens_q,
                    cu_seqlens_kv,
                    max_seqlen_q,
                    max_seqlen_kv,
6261
6262
                    cu_seqlens_q_padded,
                    cu_seqlens_kv_padded,
6263
                    self.attention_dropout if self.training else 0.0,
6264
6265
6266
                    cp_group,
                    cp_global_ranks,
                    cp_stream,
6267
                    cp_comm_type,
6268
                    softmax_scale=self.softmax_scale,
6269
                    qkv_format=qkv_format,
6270
                    attn_mask_type=attn_mask_type,
6271
6272
                    attn_bias_type=core_attention_bias_type,
                    attn_bias=core_attention_bias,
6273
                    deterministic=self.deterministic,
6274
                    use_fused_attention=True,
6275
                    window_size=window_size,
6276
6277
                    fp8=fp8,
                    fp8_meta=fp8_meta,
6278
6279
                )
        else:
6280
6281
6282
6283
6284
6285
6286
            with self.attention_dropout_ctx():
                output = FusedAttnFunc.apply(
                    self.training,
                    max_seqlen_q,
                    max_seqlen_kv,
                    cu_seqlens_q,
                    cu_seqlens_kv,
6287
6288
                    cu_seqlens_q_padded,
                    cu_seqlens_kv_padded,
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
                    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,
6300
                    window_size,
6301
6302
6303
6304
6305
                    None,  # rng_gen
                    fused_attention_backend,
                    use_FAv2_bwd,
                    fp8,
                    fp8_meta,
6306
                    self.deterministic,
6307
                )
6308

6309
6310
        # ...hd -> ...(hd)
        return output.view(*output.shape[:-2], -1)
6311
6312


6313
class DotProductAttention(TransformerEngineBaseModule):
6314
6315
6316
6317
6318
6319
    """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::

6320
        Argument :attr:`attention_mask` in the `forward` call is only used when
6321
        :attr:`attn_mask_type` includes '"padding"' or `"arbitrary"`.
6322
6323
6324

    .. warning::

6325
        FlashAttention uses a non-deterministic algorithm for optimal performance. To observe
6326
        deterministic behavior at the cost of performance, use FlashAttention version >= `2.4.1`
6327
6328
        and set the environment variable :attr:`NVTE_ALLOW_NONDETERMINISTIC_ALGO=0`. In order
        to disable`flash-attn` entirely, set :attr:`NVTE_FLASH_ATTN=0`.
6329
6330
6331
6332
6333

    Parameters
    ----------
    num_attention_heads : int
                         number of attention heads in the transformer layer.
6334
6335
6336
    kv_channels : Union[int, Tuple[int, int]]
                the head size in key and value tensors. If the same, :attr:`kv_channels` can be
                an integer; if not, :attr:`kv_channels` should be a tuple of two integers.
6337
6338
6339
6340
6341
6342
6343
6344
    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`.
6345
6346
    attention_dropout: float, default = 0.0
                      dropout probability for the dropout op during multi-head attention.
6347
    attn_mask_type: str, default = `causal`
6348
                   type of attention mask passed into softmax operation, options are "`no_mask`",
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
                   "`padding`", "`causal`", "`padding,causal`", "`causal,padding`",
                   "`padding_causal`", "`causal_bottom_right`", "`padding_causal_bottom_right`", and
                   "`arbitrary`", where "`padding,causal`", "`causal,padding`" and "`padding_causal`"
                   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.
                   1. For "`no_mask`", no attention mask is applied.
                   2. For "`causal`", "`causal_bottom_right`", or the causal mask in
                   "`padding_causal`" and "`padding_causal_bottom_right`", TransformerEngine
                   calculates and applies an upper triangular mask to the softmax input.
                   No user input is needed. Causal masks without the "`bottom_right`" appendix align
                   the diagonal line to the top left corner of the softmax matrix. With
                   "`bottom_right`", the causal mask is aligned to the bottom right corner, which is
                   often used in inference/KV caching.
                   3. For "`padding`", or the padding mask in "`padding_causal`" and
                   "`padding_causal_bottom_right`", users need to provide the locations of padded
                   tokens, either via :attr:`cu_seqlens_q` and :attr:`cu_seqlens_kv` (both in shape
                   [batch_size + 1]), or via :attr:`attention_mask` (one tensor for self-attention
                   in shape [batch_size, 1, 1, max_seqlen_q], or two tensors in a tuple for
                   cross-attention in shapes [batch_size, 1, 1, max_seqlen_q] and
                   [batch_size, 1, 1, max_seqlen_kv]).
                   4. For "`arbitrary`", users need to provide a mask that is broadcastable to
                   the shape of softmax input [batch_size, num_heads, max_seqlen_q, max_seqlen_kv].
6373
6374
6375
6376
    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
6377
6378
6379
                window and causal mask specifically. Both `causal` and `causal_bottom_right` masks
                map to `window_size = (-1, 0)` and Transformer Engine distinguishes them based on
                `attn_mask_type`. Similar to :attr:`attn_mask_type`, `window_size` can
6380
                be overridden by :attr:`window_size` in `forward` as well.
6381
6382
    attention_type: str, default = `self`
                   type of attention, either "`self`" and "`cross`".
6383
6384
6385
    layer_number: int, default = `None`
                 layer number of the current `DotProductAttention` when multiple such modules
                 are concatenated, for instance in consecutive transformer blocks.
6386
6387
6388
    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,
6389
               `h` the number of heads, `d` head size, and `t` the total number of tokens
6390
6391
6392
6393
6394
               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.
6395
               For that, please use `get_qkv_layout` to gain the layout information.
6396
6397
    softmax_scale: Optional[float], default = `None`
                softmax scale for the attention scores. If `None`, defaults to
6398
                `1.0/math.sqrt(kv_channels if isinstance(kv_channels, int) else kv_channels[0])`.
6399
6400
6401
6402
6403
6404
6405
6406
6407

    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.
6408
6409
6410
6411
6412
6413
6414
6415
6416
    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.
6417
6418
6419
    cp_comm_type : str
                  inter-gpu communication type for context parallelism.
                  Can be "p2p" or "all_gather".
6420
6421
6422
6423
6424
    """

    def __init__(
        self,
        num_attention_heads: int,
6425
        kv_channels: Union[int, Tuple[int, int]],
6426
        num_gqa_groups: Optional[int] = None,
6427
        attention_dropout: float = 0.0,
6428
        qkv_format: str = "sbhd",
6429
        attn_mask_type: str = "causal",
6430
        window_size: Optional[Tuple[int, int]] = None,
6431
6432
6433
6434
6435
        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,
6436
        attention_type: str = "self",
6437
        cp_group: Optional[dist_group_type] = None,
6438
        cp_global_ranks: List[int] = None,
6439
        cp_stream: torch.cuda.Stream = None,
6440
        cp_comm_type: str = "p2p",
6441
        softmax_scale: Optional[float] = None,
6442
6443
6444
    ) -> None:
        super().__init__()

6445
        self.logger = logging.getLogger("DotProductAttention")
6446
6447
6448
        self.logger.setLevel(_log_level)
        if not self.logger.hasHandlers():
            self.logger.addHandler(_stream_handler)
6449
        self.qkv_format = qkv_format
6450
        attn_mask_type = attn_mask_type.replace(",", "_")
6451
6452
        if attn_mask_type == "causal_padding":
            attn_mask_type = "padding_causal"
6453
        self.attn_mask_type = attn_mask_type
6454
        self.window_size = check_set_window_size(attn_mask_type, window_size)
6455
6456
6457
6458
6459
6460
6461
        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)
6462
        self.get_rng_state_tracker = get_rng_state_tracker
6463
        self.num_attention_heads = num_attention_heads
6464
        self.layer_number = 1 if layer_number is None else layer_number
6465
6466
6467
        self.cp_group = cp_group
        self.cp_global_ranks = cp_global_ranks
        self.cp_stream = cp_stream
6468
        self.cp_comm_type = cp_comm_type
6469

6470
6471
6472
6473
6474
6475
        self.hidden_size_per_attention_head_k = (
            kv_channels if isinstance(kv_channels, int) else kv_channels[0]
        )
        self.hidden_size_per_attention_head_v = (
            kv_channels if isinstance(kv_channels, int) else kv_channels[1]
        )
6476

6477
        self.num_gqa_groups = num_attention_heads if num_gqa_groups is None else num_gqa_groups
6478
        self.num_gqa_groups_per_partition = int(self.num_gqa_groups // self.tp_size)
6479

6480
6481
6482
        assert (
            num_attention_heads % self.num_gqa_groups == 0
        ), "The number of attention heads must be divisible by the number of GQA groups!"
6483

6484
        self.rng_states_tracker = None
6485
6486
6487
        if sequence_parallel or get_rng_state_tracker is None:
            attention_dropout_ctx = nullcontext
        else:
6488
6489
6490
            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
6491

6492
        if softmax_scale is None:
6493
6494
6495
            softmax_scale = 1.0 / math.sqrt(
                kv_channels if isinstance(kv_channels, int) else kv_channels[0]
            )
6496

6497
6498
6499
        self.deterministic = (
            not bool(int(os.getenv("NVTE_ALLOW_NONDETERMINISTIC_ALGO", "1")))
            or torch.are_deterministic_algorithms_enabled()
6500
        )
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
        # To use the workspace optimization path for determinism, please
        # set NVTE_FUSED_ATTN_FORCE_WORKSPACE_OPT=1 for cuDNN >=8.9.5 and <9.0.0,
        # and set NVTE_ALLOW_NONDETERMINISTIC_ALGO=0 for cuDNN >=9.0.0.
        cudnn_version = get_cudnn_version()
        if (8, 9, 5) <= cudnn_version < (9, 0, 0):
            if self.deterministic:
                os.environ["NVTE_FUSED_ATTN_FORCE_WORKSPACE_OPT"] = "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"
6520

6521
        assert attention_type in AttnTypes, f"attention_type {attention_type} not supported"
6522
6523
6524
6525

        self.attention_type = attention_type
        self.attention_dropout = attention_dropout

6526
6527
6528
6529
6530
        attn_kwargs = {
            "attention_dropout": attention_dropout,
            "attention_dropout_ctx": attention_dropout_ctx,
        }

6531
6532
6533
6534
6535
6536
6537
        self.flash_attention = FlashAttention(
            softmax_scale,
            attention_type=attention_type,
            layer_number=layer_number,
            deterministic=self.deterministic,
            **attn_kwargs,
        )
6538

6539
        # Instantiating three types since use of flash-attn and FusedAttention
6540
        # might be ruled out due to forward inputs.
6541
6542
6543
6544
6545
6546
6547
        self.fused_attention = FusedAttention(
            softmax_scale,
            attention_type=attention_type,
            layer_number=layer_number,
            deterministic=self.deterministic,
            **attn_kwargs,
        )
6548

6549
        self.unfused_attention = UnfusedDotProductAttention(
6550
6551
6552
6553
            softmax_scale,
            attention_type=attention_type,
            **attn_kwargs,
            layer_number=layer_number,
6554
        )
6555

6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
        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)

6568
6569
6570
6571
    def _checkpointed_attention_forward(
        self,
        attention_func: Callable,
        *forward_args: Tuple[torch.Tensor, ...],
6572
        **forward_kwargs: Dict[str, Any],
6573
6574
6575
    ) -> torch.Tensor:
        """Forward method with activation checkpointing."""

6576
6577
        def custom_forward(*input_args, **input_kwargs):
            return attention_func(*input_args, **input_kwargs)
6578
6579
6580

        hidden_states = checkpoint(
            custom_forward,
6581
6582
6583
            distribute_saved_activations=False,
            get_rng_state_tracker=self.get_rng_state_tracker,
            tp_group=self.tp_group,
6584
            *forward_args,
6585
            **forward_kwargs,
6586
6587
6588
6589
        )

        return hidden_states

6590
6591
6592
6593
6594
    def set_context_parallel_group(
        self,
        cp_group: Union[dist_group_type, None],
        cp_global_ranks: List[int],
        cp_stream: torch.cuda.Stream,
6595
        cp_comm_type: str = "p2p",
6596
    ) -> None:
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
        """
        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.
6609
6610
6611
        cp_comm_type : str
                      inter-gpu communication type for context parallelism.
                      Can be "p2p" or "all_gather".
6612
        """
6613
6614
6615
        self.cp_group = cp_group
        self.cp_global_ranks = cp_global_ranks
        self.cp_stream = cp_stream
6616
        self.cp_comm_type = cp_comm_type
6617

6618
    @no_torch_dynamo(recursive=False)
6619
6620
6621
6622
6623
    def forward(
        self,
        query_layer: torch.Tensor,
        key_layer: torch.Tensor,
        value_layer: torch.Tensor,
6624
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
6625
6626
6627
        qkv_format: Optional[str] = None,
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
6628
6629
        cu_seqlens_q_padded: Optional[torch.Tensor] = None,
        cu_seqlens_kv_padded: Optional[torch.Tensor] = None,
6630
6631
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
6632
        attn_mask_type: Optional[str] = None,
6633
        window_size: Optional[Tuple[int, int]] = None,
6634
        checkpoint_core_attention: bool = False,
6635
6636
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
6637
        alibi_slopes: Optional[torch.Tensor] = None,
6638
        fast_zero_fill: bool = True,
6639
        inference_params: Optional[InferenceParams] = None,
6640
        is_first_microbatch: Optional[bool] = None,
6641
6642
6643
6644
6645
6646
    ) -> torch.Tensor:
        """
        Dot Product Attention Layer.

        .. note::

6647
6648
            Argument :attr:`attention_mask` is only used when :attr:`attn_mask_type`
            includes '"padding"' or `"arbitrary"`.
6649

6650
6651
        .. note::

6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
            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
6670
6671
6672
6673
6674
            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.
6675

6676
6677
6678
6679
6680
6681
6682
6683
        Parameters
        ----------
        query_layer : torch.Tensor
                     Query tensor.
        key_layer : torch.Tensor
                   Key tensor.
        value_layer : torch.Tensor
                     Value tensor.
6684
6685
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]],
             default = `None`. Boolean tensor(s) used to mask out attention softmax input.
6686
             It should be `None` for causal masks and "`no_mask`". For padding masks, it should be
6687
6688
             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]
6689
6690
6691
6692
             for cross-attention. For "`arbitrary`" mask, it should be in a shape 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.
6693
6694
6695
        qkv_format: str, default = `None`
                   If provided, overrides :attr:`qkv_format` from initialization.
        cu_seqlens_q: Optional[torch.Tensor], default = `None`
6696
                   Cumulative sum of sequence lengths (without offset) in a batch for `query_layer`,
6697
6698
                   with shape [batch_size + 1] and dtype torch.int32.
        cu_seqlens_kv: Optional[torch.Tensor], default = `None`
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
                   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`.
6711
6712
6713
6714
6715
6716
        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.
6717
6718
6719
6720
6721
6722
6723
        attn_mask_type: {'no_mask', 'padding', 'causal', 'padding,causal', 'causal,padding',
                       'padding_causal', 'causal_bottom_right', 'padding_causal_bottom_right',
                       'arbitrary'}, default = `None`. Type of attention mask passed into
                       softmax operation. 'padding,causal', 'causal,padding' and 'padding_causal'
                       are equivalent. By default, causal masks are aligned to the top left corner
                       of the softmax matrix. When "`bottom_right`" is specified in the mask type,
                       causal masks are aligned to the bottom right corner.
6724
        window_size: Optional[Tuple[int, int]], default = `None`
6725
                    Sliding window size for local attention.
6726
6727
6728
6729
6730
        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.
6731
        core_attention_bias_type: str, default = `no_bias`
6732
                    Bias type, {`no_bias`, `pre_scale_bias`, `post_scale_bias`, `alibi`}
6733
        core_attention_bias: Optional[torch.Tensor], default = `None`
6734
6735
                    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.
6736
6737
6738
6739
        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.
6740
        fast_zero_fill: bool, default = `True`
6741
                    Whether to use the fast path to set output tensors to 0 or not.
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
        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.
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
        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)
6765
        """
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
        with self.prepare_forward(
            query_layer,
            is_first_microbatch,
            num_gemms=3,
            allow_non_contiguous=True,
        ) as query_layer:

            if self.fp8:
                if self.fp8_meta["recipe"].fp8_mha:
                    if not self.fp8_meta["recipe"].fp8_dpa:
                        self.fp8_meta["recipe"].fp8_dpa = True
6777
                        self.logger.warning(
6778
6779
6780
                            """Forcing fp8_meta["recipe"].fp8_dpa=True due to """
                            """fp8_meta["recipe"].fp8_mha=True"""
                        )
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791

            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."""
6792

6793
6794
6795
            assert (
                query_layer.is_cuda and key_layer.is_cuda and value_layer.is_cuda
            ), "DotProductAttention only supports CUDA tensors."
6796
6797
6798
            assert (
                query_layer.dtype == key_layer.dtype and query_layer.dtype == value_layer.dtype
            ), "Queries, keys and values must have the same data type!"
6799
6800
6801
            assert (
                key_layer.shape[:-1] == value_layer.shape[:-1]
            ), "Keys and values must have the same batch size, sequence length and number of heads!"
6802
6803
6804
6805
6806
6807
6808
6809
            assert (
                key_layer.shape[-1] == self.hidden_size_per_attention_head_k
            ), f"Keys have head_dim = {key_layer.shape[-1]}, "
            "but expected head_dim = {self.hidden_size_per_attention_head_k}!"
            assert (
                value_layer.shape[-1] == self.hidden_size_per_attention_head_v
            ), f"Values have head_dim = {value_layer.shape[-1]}, "
            "but expected head_dim = {self.hidden_size_per_attention_head_v}!"
6810

6811
6812
6813
6814
6815
6816
            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"
6817
            assert (
6818
6819
6820
6821
6822
6823
                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!"
6824

6825
6826
6827
6828
            if window_size is None:
                window_size = self.window_size
            window_size = check_set_window_size(attn_mask_type, window_size)

6829
6830
6831
6832
6833
6834
6835
            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."
6836

6837
6838
            if qkv_format is None:
                qkv_format = self.qkv_format
6839

6840
6841
            if inference_params is not None:
                assert self.layer_number is not None, "Layer number must be set!"
6842

6843
6844
6845
6846
6847
                # convert causal to causal_bottom_right in inference when KV-caching is in use
                # so users can run with the same attn_mask_type for training and inference
                if attn_mask_type in ["causal", "padding_causal"]:
                    attn_mask_type = attn_mask_type + "_bottom_right"

6848
6849
6850
                if qkv_format == "bshd":
                    key_layer = key_layer.transpose(0, 1)
                    value_layer = value_layer.transpose(0, 1)
6851

6852
6853
6854
6855
                (
                    inference_key_memory,
                    inference_value_memory,
                ) = inference_params.key_value_memory_dict[self.layer_number]
6856

6857
6858
6859
                batch_start = inference_params.batch_size_offset
                batch_end = batch_start + key_layer.size(1)
                assert batch_end <= inference_key_memory.size(1)
6860

6861
6862
6863
                sequence_start = inference_params.sequence_len_offset
                sequence_end = sequence_start + key_layer.size(0)
                assert sequence_end <= inference_key_memory.size(0)
6864

6865
6866
6867
6868
6869
6870
6871
6872
6873
                # 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, ...]
6874

6875
6876
6877
                if qkv_format == "bshd":
                    key_layer = key_layer.transpose(0, 1)
                    value_layer = value_layer.transpose(0, 1)
6878

6879
6880
                key_layer = key_layer.contiguous()
                value_layer = value_layer.contiguous()
6881
6882

            assert (
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
                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":
6893
                assert all(
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
                    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:
6908
6909
6910
6911
                    if cu_seqlens_q_padded is not None:
                        seqlens_q = cu_seqlens_q_padded[1:] - cu_seqlens_q_padded[:-1]
                    else:
                        seqlens_q = cu_seqlens_q[1:] - cu_seqlens_q[:-1]
6912
                    max_seqlen_q = int((seqlens_q.max().item() + 63) // 64 * 64)
6913
                if max_seqlen_kv is None:
6914
6915
6916
6917
                    if cu_seqlens_kv_padded is not None:
                        seqlens_kv = cu_seqlens_kv_padded[1:] - cu_seqlens_kv_padded[:-1]
                    else:
                        seqlens_kv = cu_seqlens_kv[1:] - cu_seqlens_kv[:-1]
6918
                    max_seqlen_kv = int((seqlens_kv.max().item() + 63) // 64 * 64)
6919
                batch_size = len(cu_seqlens_q) - 1
6920

6921
6922
6923
            cp_size = 1 if self.cp_group is None else get_distributed_world_size(self.cp_group)
            context_parallel = cp_size > 1

6924
            if qkv_format in ["sbhd", "bshd"]:
6925
                assert all(
6926
6927
6928
6929
                    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])
6930
                    batch_size = query_layer.shape[1]
6931
6932
                if qkv_format == "bshd":
                    max_seqlen_q, max_seqlen_kv = (query_layer.shape[1], key_layer.shape[1])
6933
                    batch_size = query_layer.shape[0]
6934
6935
                max_seqlen_q *= cp_size
                max_seqlen_kv *= cp_size
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
                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'!"""
6948
6949
6950
6951
6952
                if cu_seqlens_q is None or cu_seqlens_kv is None:
                    if "padding" in attn_mask_type:
                        assert (
                            attention_mask is not None
                        ), "Please provide attention_mask for padding!"
6953
                        if self.attention_type == "self":
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
                            cu_seqlens_q = get_cu_seqlens(attention_mask)
                            cu_seqlens_kv = cu_seqlens_q
                        else:
                            cu_seqlens_q = get_cu_seqlens(attention_mask[0])
                            cu_seqlens_kv = get_cu_seqlens(attention_mask[1])
                    else:
                        cu_seqlens_q = _get_full_cu_seqlens(
                            batch_size,
                            max_seqlen_q,
                            query_layer.device,
                        )
                        cu_seqlens_kv = _get_full_cu_seqlens(
                            batch_size,
                            max_seqlen_kv,
                            key_layer.device,
                        )
6970

6971
6972
6973
6974
6975
            if (
                isinstance(query_layer, Float8Tensor)
                and isinstance(key_layer, Float8Tensor)
                and isinstance(value_layer, Float8Tensor)
            ):
6976
                qkv_layout, query_layer._data, key_layer._data, value_layer._data = get_qkv_layout(
6977
6978
6979
                    query_layer._data, key_layer._data, value_layer._data, qkv_format=qkv_format
                )
            else:
6980
                qkv_layout, query_layer, key_layer, value_layer = get_qkv_layout(
6981
6982
                    query_layer, key_layer, value_layer, qkv_format=qkv_format
                )
6983

6984
6985
6986
6987
6988
6989
6990
6991
            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
6992
            bottom_right_alignment = (attn_mask_type not in ["causal", "padding_causal"],)
6993
6994
6995
6996
6997
6998
6999
7000
            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
7001
                    or _alibi_cache["_bottom_right_alignment"] != bottom_right_alignment
7002
7003
7004
7005
7006
                    or _alibi_cache["_alibi_slopes"] is None
                ):
                    _alibi_cache["_alibi_slopes_require_update"] = True
                    _alibi_cache["_alibi_bias_require_update"] = True

7007
7008
            core_attention_bias_shape = None
            if core_attention_bias is not None:
7009
                if (
7010
7011
                    core_attention_bias.shape[0] == batch_size
                    and core_attention_bias.shape[1] == query_layer.shape[-2]
7012
                ):
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
                    core_attention_bias_shape = "bhss"
                elif (
                    core_attention_bias.shape[0] == 1
                    and core_attention_bias.shape[1] == query_layer.shape[-2]
                ):
                    core_attention_bias_shape = "1hss"
                elif (
                    core_attention_bias.shape[0] == batch_size and core_attention_bias.shape[1] == 1
                ):
                    core_attention_bias_shape = "b1ss"
                elif core_attention_bias.shape[0] == 1 and core_attention_bias.shape[1] == 1:
                    core_attention_bias_shape = "11ss"
                else:
                    assert (
                        False
                    ), "core_attention_bias must be in one of {bhss, 1hss, b1ss, 11ss} shapes"

            pad_between_seqs = (
                cu_seqlens_q_padded is not None
                and not torch.equal(cu_seqlens_q_padded, cu_seqlens_q)
            ) or (
                cu_seqlens_kv_padded is not None
                and not torch.equal(cu_seqlens_kv_padded, cu_seqlens_kv)
            )
7037

7038
            attention_params = AttentionParams(
7039
7040
7041
7042
7043
7044
7045
7046
                qkv_type=type(query_layer),
                qkv_dtype=query_layer.dtype,
                qkv_layout=qkv_layout,
                batch_size=batch_size,
                num_heads=query_layer.shape[-2],
                num_gqa_groups=key_layer.shape[-2],
                max_seqlen_q=max_seqlen_q,
                max_seqlen_kv=max_seqlen_kv,
7047
7048
                head_dim_qk=query_layer.shape[-1],
                head_dim_v=value_layer.shape[-1],
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
                attn_mask_type=attn_mask_type,
                window_size=window_size,
                alibi_slopes_shape=alibi_slopes.shape if alibi_slopes is not None else None,
                core_attention_bias_type=core_attention_bias_type,
                core_attention_bias_shape=core_attention_bias_shape,
                core_attention_bias_requires_grad=(
                    core_attention_bias.requires_grad if core_attention_bias is not None else False
                ),
                pad_between_seqs=pad_between_seqs,
                attention_dropout=self.attention_dropout,
                context_parallel=context_parallel,
7060
7061
                deterministic=self.deterministic,
                is_training=self.training,
7062
7063
7064
                fp8=self.fp8,
                fp8_meta=self.fp8_meta,
            )
7065
            global _attention_backends, _flash_attn_3_plus, _use_flash_attn_3
7066
7067
7068
7069
7070
7071
7072
            if (
                _attention_backends["attention_params"] is None
                or attention_params != _attention_backends["attention_params"]
            ):
                _attention_backends["attention_params"] = attention_params
                _attention_backends["backend_selection_requires_update"] = True
            if _attention_backends["backend_selection_requires_update"]:
7073
                _use_flash_attn_3 = _flash_attn_3_plus
7074
7075
7076
7077
7078
7079
7080
7081
                (
                    use_flash_attention,
                    use_fused_attention,
                    fused_attention_backend,
                    use_unfused_attention,
                    _,
                ) = get_attention_backend(attention_params)
                if use_flash_attention:
7082
7083
7084
7085
                    self.logger.info(
                        "Running with FlashAttention backend (version %s)",
                        _flash_attn_version if not _use_flash_attn_3 else _flash_attn_v3_version,
                    )
7086
7087
7088
7089
                elif use_fused_attention:
                    self.logger.info(
                        "Running with FusedAttention backend (sub-backend %s)",
                        int(fused_attention_backend),
7090
                    )
7091
7092
7093
7094
7095
7096
7097
                elif use_unfused_attention:
                    self.logger.info("Running with UnfusedDotProductAttention backend")
            else:
                use_flash_attention = _attention_backends["use_flash_attention"]
                use_fused_attention = _attention_backends["use_fused_attention"]
                fused_attention_backend = _attention_backends["fused_attention_backend"]
                use_unfused_attention = _attention_backends["use_unfused_attention"]
7098

7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
            if use_flash_attention:
                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,
7121
                    cp_comm_type=self.cp_comm_type,
7122
7123
                    max_seqlen_q=max_seqlen_q,
                    max_seqlen_kv=max_seqlen_kv,
7124
7125
                    fp8=self.fp8 and self.fp8_meta["recipe"].fp8_dpa,
                    fp8_meta=self.fp8_meta,
7126
                )
7127

7128
            if use_fused_attention:
7129
7130
                fu_core_attention_bias_type = core_attention_bias_type
                fu_core_attention_bias = core_attention_bias
7131
7132
7133
                if core_attention_bias_type == "alibi" and (
                    alibi_slopes is not None or max_seqlen_q != max_seqlen_kv
                ):
7134
7135
7136
7137
7138
7139
7140
                    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,
7141
                        bottom_right_alignment=attn_mask_type not in ["causal", "padding_causal"],
7142
                    )
7143
7144
7145
7146
7147
7148
7149
7150
7151
                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,
7152
7153
                        cu_seqlens_q_padded=cu_seqlens_q_padded,
                        cu_seqlens_kv_padded=cu_seqlens_kv_padded,
7154
7155
7156
7157
                        max_seqlen_q=max_seqlen_q,
                        max_seqlen_kv=max_seqlen_kv,
                        attn_mask_type=attn_mask_type,
                        attention_mask=attention_mask,
7158
                        window_size=window_size,
7159
7160
7161
7162
7163
7164
7165
                        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,
7166
                        cp_comm_type=self.cp_comm_type,
7167
7168
7169
7170
                        fp8=self.fp8 and self.fp8_meta["recipe"].fp8_dpa,
                        fp8_meta=self.fp8_meta,
                    )
                return self.fused_attention(
7171
7172
7173
7174
7175
7176
                    query_layer,
                    key_layer,
                    value_layer,
                    qkv_layout=qkv_layout,
                    cu_seqlens_q=cu_seqlens_q,
                    cu_seqlens_kv=cu_seqlens_kv,
7177
7178
                    cu_seqlens_q_padded=cu_seqlens_q_padded,
                    cu_seqlens_kv_padded=cu_seqlens_kv_padded,
7179
7180
                    max_seqlen_q=max_seqlen_q,
                    max_seqlen_kv=max_seqlen_kv,
7181
7182
                    attn_mask_type=attn_mask_type,
                    attention_mask=attention_mask,
7183
                    window_size=window_size,
7184
                    fused_attention_backend=fused_attention_backend,
7185
7186
                    core_attention_bias_type=fu_core_attention_bias_type,
                    core_attention_bias=fu_core_attention_bias,
7187
7188
7189
7190
                    fast_zero_fill=fast_zero_fill,
                    cp_group=self.cp_group,
                    cp_global_ranks=self.cp_global_ranks,
                    cp_stream=self.cp_stream,
7191
                    cp_comm_type=self.cp_comm_type,
7192
7193
                    fp8=self.fp8 and self.fp8_meta["recipe"].fp8_dpa,
                    fp8_meta=self.fp8_meta,
7194
                )
7195

7196
            from .cpu_offload import CPUOffloadEnabled
7197

7198
7199
7200
7201
7202
            if CPUOffloadEnabled:
                warnings.warn(
                    "Attention activation Offloading is only implemented"
                    "with Flash Attention and Fused Attention!"
                )
7203

7204
            if use_unfused_attention:
7205
7206
7207
7208
7209
7210
                if window_size is not None and (
                    window_size[0] != -1 or window_size[1] not in [-1, 0]
                ):
                    attn_mask_type, attention_mask = get_swa_mask(
                        window_size, max_seqlen_q, max_seqlen_kv, attn_mask_type, attention_mask
                    )
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
                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(
7227
7228
7229
                    query_layer,
                    key_layer,
                    value_layer,
7230
7231
7232
7233
7234
7235
7236
7237
7238
                    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,
                )
7239

7240
            raise Exception("No dot product attention support for the provided inputs!")
7241
7242


7243
7244
7245
7246
7247
7248
7249
class MultiheadAttention(torch.nn.Module):
    r"""
    Multi-head Attention (MHA), including Query,
    Key, Value and Output projection.

    .. note::

7250
7251
        Argument :attr:`attention_mask` in the `forward` call is only used when
        :attr:`attn_mask_type` includes '"padding"' or `"arbitrary"`.
7252

7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
    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.
7278
7279
    attn_mask_type: {'no_mask', 'padding', 'causal', 'padding_causal', 'causal_bottom_right',
                   'padding_causal_bottom_right','arbitrary'},
7280
                   default = `causal`
7281
7282
7283
7284
7285
                   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.
7286
7287
7288
7289
    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
7290
7291
7292
                window and causal mask specifically. Both `causal` and `causal_bottom_right` masks
                map to `window_size = (-1, 0)` and Transformer Engine distinguishes them based on
                `attn_mask_type`. Similar to :attr:`attn_mask_type`, `window_size` can
7293
                be overridden by :attr:`window_size` in `forward` as well.
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
    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.
7307
7308
    input_layernorm: bool, default = `False`
                     if set to `True`, layer normalization to the input is applied.
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
    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.
7332
7333
7334
7335
7336
7337
7338
    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.
7339
            For that, please use `get_qkv_layout` to gain the layout information.
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379

    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`.
7380
7381
7382
7383
7384
7385
    """

    def __init__(
        self,
        hidden_size: int,
        num_attention_heads: int,
7386
7387
7388
7389
7390
        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,
7391
        layer_number: Optional[int] = None,
7392
        attn_mask_type: str = "causal",
7393
        window_size: Optional[Tuple[int, int]] = None,
7394
7395
        tp_group: Optional[dist_group_type] = None,
        tp_size: int = 1,
7396
        num_gqa_groups: Optional[int] = None,
7397
7398
7399
        fuse_wgrad_accumulation: bool = False,
        get_rng_state_tracker: Optional[Callable] = None,
        sequence_parallel: bool = False,
7400
        params_dtype: Optional[torch.dtype] = None,
7401
        return_bias: bool = False,
7402
7403
7404
7405
7406
7407
7408
7409
7410
        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
7411
        ub_overlap_rs_dgrad: bool = False,
7412
7413
        ub_overlap_rs: bool = False,
        ub_overlap_ag: bool = False,
7414
        bias: bool = True,
7415
        normalization: str = "LayerNorm",
7416
        device: Union[torch.device, str] = "cuda",
7417
        qkv_format: str = "sbhd",
7418
7419
    ) -> None:
        super().__init__()
7420

7421
        self.qkv_format = qkv_format
7422
        self.attn_mask_type = attn_mask_type
7423
        self.window_size = check_set_window_size(attn_mask_type, window_size)
7424
        self.layer_number = layer_number
7425
7426
7427
7428
7429
        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
7430
        self.params_dtype = torch.get_default_dtype() if params_dtype is None else params_dtype
7431
        self.num_attention_heads = num_attention_heads
7432
7433
7434
7435
7436
7437
7438
7439
        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()
7440
7441
7442
7443
7444

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

7445
7446
7447
        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"
7448
7449
7450
7451
7452
7453

        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)
7454
7455
7456
7457
7458
7459
7460
        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!"
7461
        self.num_gqa_groups_per_partition = int(self.num_gqa_groups // tp_size)
7462
7463
7464
7465

        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
7466
7467
7468
7469
7470
7471
7472

        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,
7473
            "params_dtype": self.params_dtype,
7474
            "device": device,
7475
7476
7477
7478
        }

        qkv_parallel_mode = "column" if set_parallel_mode else None

cyanguwa's avatar
cyanguwa committed
7479
        if self.attention_type == "self":
7480
7481
            parameters_split = None
            if not fuse_qkv_params:
7482
7483
7484
7485
7486
7487
7488
                parameters_split = collections.OrderedDict(
                    [
                        ("query", self.hidden_size_q),
                        ("key", self.hidden_size_kv),
                        ("value", self.hidden_size_kv),
                    ]
                )
7489
7490
7491
            if self.input_layernorm:
                self.layernorm_qkv = LayerNormLinear(
                    hidden_size,
7492
                    self.hidden_size_q + 2 * self.hidden_size_kv,
7493
7494
7495
7496
7497
7498
                    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
7499
                    parameters_split=parameters_split,
7500
7501
7502
                    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
7503
                    ub_overlap_rs_dgrad=ub_overlap_rs_dgrad,
7504
                    ub_overlap_ag=ub_overlap_ag,
7505
                    normalization=normalization,
Przemyslaw Tredak's avatar
Przemyslaw Tredak committed
7506
                    ub_name="qkv",
7507
7508
7509
7510
7511
                    **common_gemm_kwargs,
                )
            else:
                self.qkv = Linear(
                    hidden_size,
7512
                    self.hidden_size_q + 2 * self.hidden_size_kv,
7513
7514
7515
7516
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
cyanguwa's avatar
cyanguwa committed
7517
                    parameters_split=parameters_split,
7518
7519
                    **common_gemm_kwargs,
                )
cyanguwa's avatar
cyanguwa committed
7520
        elif self.attention_type == "cross":
7521
7522
7523
            if self.input_layernorm:
                self.layernorm_query = LayerNormLinear(
                    hidden_size,
7524
                    self.hidden_size_q,
7525
7526
7527
7528
7529
                    eps=layernorm_epsilon,
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
7530
                    parameters_split=("query",) if not fuse_qkv_params else None,
7531
7532
7533
7534
                    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
7535
                    ub_overlap_rs_dgrad=ub_overlap_rs_dgrad,
7536
                    ub_overlap_ag=ub_overlap_ag,
7537
                    normalization=normalization,
Przemyslaw Tredak's avatar
Przemyslaw Tredak committed
7538
                    ub_name="qkv",
7539
7540
7541
7542
7543
                    **common_gemm_kwargs,
                )
            else:
                self.query_layer = Linear(
                    hidden_size,
7544
                    self.hidden_size_q,
7545
7546
7547
7548
7549
7550
7551
7552
                    init_method=init_method,
                    bias=bias,
                    return_bias=False,
                    parallel_mode=qkv_parallel_mode,
                    **common_gemm_kwargs,
                )
            self.key_value = Linear(
                hidden_size,
7553
                2 * self.hidden_size_kv,
7554
7555
7556
7557
                init_method=init_method,
                bias=bias,
                return_bias=False,
                parallel_mode=qkv_parallel_mode,
7558
                parameters_split=("key", "value") if not fuse_qkv_params else None,
7559
7560
7561
7562
7563
7564
                **common_gemm_kwargs,
            )

        # Attention.
        self.core_attention = DotProductAttention(
            num_attention_heads,
7565
            self.hidden_size_per_attention_head,
7566
7567
            num_gqa_groups=self.num_gqa_groups,
            attention_dropout=attention_dropout,
7568
            qkv_format=self.qkv_format,
7569
7570
7571
7572
            tp_size=tp_size,
            get_rng_state_tracker=get_rng_state_tracker,
            sequence_parallel=sequence_parallel,
            tp_group=tp_group,
7573
            layer_number=self.layer_number,
7574
            attention_type=self.attention_type,
7575
7576
7577
7578
        )

        # Linear
        self.proj = Linear(
7579
            self.hidden_size_q,
7580
7581
7582
            hidden_size,
            init_method=output_layer_init_method,
            bias=bias,
7583
            return_bias=return_bias,
7584
            parallel_mode="row" if set_parallel_mode else None,
7585
7586
            ub_overlap_rs=ub_overlap_rs,
            ub_overlap_ag=ub_overlap_ag,
Przemyslaw Tredak's avatar
Przemyslaw Tredak committed
7587
            ub_name="proj",
7588
7589
7590
7591
            **common_gemm_kwargs,
        )

    def _allocate_memory(
7592
        self, inference_max_sequence_len: int, batch_size: int, dtype: torch.dtype
7593
7594
7595
7596
    ) -> torch.Tensor:
        return torch.empty(
            inference_max_sequence_len,
            batch_size,
7597
            self.num_gqa_groups_per_partition,
7598
            self.hidden_size_per_attention_head,
7599
            dtype=dtype,
7600
7601
7602
7603
            device=torch.cuda.current_device(),
        )

    def set_tensor_parallel_group(self, tp_group: Union[dist_group_type, None]) -> None:
7604
7605
7606
7607
7608
7609
7610
7611
7612
        """
        Set the tensor parallel group for the given
        module before executing the forward pass.

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

7615
    def set_context_parallel_group(
7616
7617
        self,
        cp_group: Union[dist_group_type, None],
7618
        cp_global_ranks: List[int],
7619
        cp_stream: torch.cuda.Stream,
7620
        cp_comm_type: str = "p2p",
7621
    ) -> None:
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
        """
        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.
7634
7635
7636
        cp_comm_type : str
                      inter-gpu communication type for context parallelism.
                      Can be "p2p" or "all_gather".
7637
        """
7638
7639
7640
7641
7642
        # 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"):
7643
                child.set_context_parallel_group(cp_group, cp_global_ranks, cp_stream, cp_comm_type)
7644

7645
7646
7647
    def forward(
        self,
        hidden_states: torch.Tensor,
7648
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
7649
        encoder_output: Optional[torch.Tensor] = None,
7650
        attn_mask_type: Optional[str] = None,
7651
        window_size: Optional[Tuple[int, int]] = None,
7652
7653
        is_first_microbatch: Optional[bool] = None,
        checkpoint_core_attention: bool = False,
7654
        inference_params: Optional[InferenceParams] = None,
7655
        rotary_pos_emb: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]] = None,
7656
7657
        core_attention_bias_type: str = "no_bias",
        core_attention_bias: Optional[torch.Tensor] = None,
7658
        alibi_slopes: Optional[torch.Tensor] = None,
7659
7660
7661
7662
        cu_seqlens_q: Optional[torch.Tensor] = None,
        cu_seqlens_kv: Optional[torch.Tensor] = None,
        max_seqlen_q: Optional[int] = None,
        max_seqlen_kv: Optional[int] = None,
7663
        fast_zero_fill: bool = True,
7664
    ) -> Tuple[Union[torch.Tensor, None], ...]:
7665
7666
7667
7668
7669
        """
        Forward propagation for MultiheadAttention layer.

        .. note::

7670
7671
            Argument :attr:`attention_mask` is only used when :attr:`attn_mask_type`
            includes `"padding"` or `"arbitrary"`.
7672
7673
7674
7675
7676

        Parameters
        ----------
        hidden_states : torch.Tensor
             Input tensor.
7677
7678
        attention_mask: Optional[Union[torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]],
             default = `None`. Boolean tensor(s) used to mask out attention softmax input.
7679
             It should be `None` for causal masks and "`no_mask`". For padding masks, it should be
7680
7681
             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]
7682
7683
7684
7685
7686
7687
             for cross-attention. For "`arbitrary`" mask, it should be in a shape 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.
        attn_mask_type: {'no_mask', 'padding', 'causal', 'padding_causal', 'causal_bottom_right',
                       'padding_causal_bottom_right','arbitrary'},
7688
                       default = `None`
7689
7690
7691
7692
                       type of attention mask passed into softmax operation. By default,
                       causal masks are aligned to the top left corner of the softmax matrix.
                       When "`bottom_right`" is specified in the mask type, causal masks are
                       aligned to the bottom right corner.
7693
7694
        window_size: Optional[Tuple[int, int]], default = `None`
                    sliding window size for local attention.
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
        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`
7720
                    Bias type, {`no_bias`, `pre_scale_bias`, 'post_scale_bias`, `alibi`}
7721
        core_attention_bias: Optional[torch.Tensor], default = `None`
7722
7723
                    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.
7724
7725
7726
7727
        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.
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
        cu_seqlens_q: Optional[torch.Tensor], default = `None`
                   Cumulative sum of sequence lengths (without offset) in a batch for `query_layer`,
                   with shape [batch_size + 1] and dtype torch.int32.
        cu_seqlens_kv: Optional[torch.Tensor], default = `None`
                   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.
        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.
7740
7741
7742
        fast_zero_fill: bool, default = `True`
                    Whether to set output tensors to 0 or not before use.
        """
7743
7744
        # hidden_states: [sq, b, h]

7745
        if attn_mask_type is None:
7746
            attn_mask_type = self.attn_mask_type
7747
7748
        if window_size is None:
            window_size = self.window_size
7749
        window_size = check_set_window_size(attn_mask_type, window_size)
7750

7751
        if "padding" in attn_mask_type and attention_mask is not None:
7752
            for i, _ in enumerate(attention_mask):
7753
7754
7755
                assert (
                    attention_mask[i].dtype == torch.bool
                ), "Attention mask must be in boolean type!"
7756

7757
7758
7759
        assert (
            core_attention_bias_type in AttnBiasTypes
        ), f"core_attention_bias_type {core_attention_bias_type} is not supported!"
7760

7761
        # =================================================
7762
        # Pre-allocate memory for key-values for inference
7763
7764
7765
        # =================================================

        if inference_params and self.layer_number is not None:
7766
7767
7768
            assert (
                self.qkv_format != "thd"
            ), "qkv_format == thd is not supported for an inference with KV-cache!"
7769
            if self.layer_number not in inference_params.key_value_memory_dict:
7770
                inf_max_seq_len = inference_params.max_sequence_length
7771
7772
                inf_max_batch_size = inference_params.max_batch_size
                inference_key_memory = self._allocate_memory(
7773
                    inf_max_seq_len, inf_max_batch_size, hidden_states.dtype
7774
7775
                )
                inference_value_memory = self._allocate_memory(
7776
                    inf_max_seq_len, inf_max_batch_size, hidden_states.dtype
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
                )
                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]

7788
        # ======================
7789
        # Query, Key, and Value
7790
        # ======================
7791

7792
7793
7794
7795
7796
        fp8_mha = (
            FP8GlobalStateManager.is_fp8_enabled()
            and FP8GlobalStateManager.get_fp8_recipe().fp8_mha
        )

cyanguwa's avatar
cyanguwa committed
7797
7798
        if self.attention_type == "self":
            # Attention heads [sq, b, h] --> [sq, b, ng * (np/ng + 2) * hn]
7799
7800
7801
7802
            if self.input_layernorm:
                layernorm_qkv_outputs = self.layernorm_qkv(
                    hidden_states,
                    is_first_microbatch=is_first_microbatch,
7803
                    fp8_output=fp8_mha and rotary_pos_emb is None,
7804
7805
7806
7807
7808
7809
7810
7811
7812
                )
                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,
7813
                    fp8_output=fp8_mha and rotary_pos_emb is None,
7814
7815
                )

7816
7817
7818
            num_queries_per_key_value = (
                self.num_attention_heads_per_partition // self.num_gqa_groups_per_partition
            )
7819
            if self.qkv_weight_interleaved:
cyanguwa's avatar
cyanguwa committed
7820
                # [sq, b, ng * (np/ng + 2) * hn] --> [sq, b, ng, (np/ng + 2), hn]
7821
                new_tensor_shape = mixed_x_layer.size()[:-1] + (
cyanguwa's avatar
cyanguwa committed
7822
7823
                    self.num_gqa_groups_per_partition,
                    (num_queries_per_key_value + 2),
7824
7825
7826
7827
                    self.hidden_size_per_attention_head,
                )
                # split along second last dimension
                split_dim = -2
cyanguwa's avatar
cyanguwa committed
7828
7829
7830
7831
7832
            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,
7833
                    self.hidden_size_per_attention_head,
cyanguwa's avatar
cyanguwa committed
7834
7835
7836
                )
                # split along third last dimension
                split_dim = -3
7837
7838
7839

            mixed_x_layer = mixed_x_layer.view(*new_tensor_shape)

cyanguwa's avatar
cyanguwa committed
7840
7841
7842
7843
7844
7845
7846
7847
7848
            # 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)
7849
                )
7850
            else:
cyanguwa's avatar
cyanguwa committed
7851
                query_layer, key_layer, value_layer = torch.split(
7852
7853
7854
7855
                    mixed_x_layer,
                    (num_queries_per_key_value, 1, 1),
                    dim=split_dim,
                )
cyanguwa's avatar
cyanguwa committed
7856

7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
            if self.qkv_format == "thd":
                query_layer, key_layer, value_layer = (
                    x.reshape(x.size(0), -1, self.hidden_size_per_attention_head)
                    for x in (query_layer, key_layer, value_layer)
                )
            else:
                # query: -> [sq, b, np, hn]
                # key, value: -> [sq, b, ng, hn]
                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
7869
7870
        elif self.attention_type == "cross":
            # Attention heads [sk, b, h] --> [sk, b, (ng * 2 * hn)]
7871
            mixed_kv_layer = self.key_value(
cyanguwa's avatar
cyanguwa committed
7872
                encoder_output,
7873
                is_first_microbatch=is_first_microbatch,
7874
                fp8_output=fp8_mha and rotary_pos_emb is None,
7875
7876
7877
            )

            if self.qkv_weight_interleaved:
cyanguwa's avatar
cyanguwa committed
7878
                # [sq, b, (ng * 2 * hn)] --> [sq, b, ng, 2 * hn]
7879
                new_tensor_shape = mixed_kv_layer.size()[:-1] + (
7880
                    self.num_gqa_groups_per_partition,
7881
7882
7883
7884
7885
                    2 * self.hidden_size_per_attention_head,
                )
                # split along last dimension
                split_dim = -1
            else:
cyanguwa's avatar
cyanguwa committed
7886
                # [sq, b, (ng * 2 * hn)] --> [sq, b, 2 * ng, hn]
7887
                new_tensor_shape = mixed_kv_layer.size()[:-1] + (
7888
                    2 * self.num_gqa_groups_per_partition,
7889
7890
7891
7892
7893
7894
7895
                    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
7896
7897
7898
            # mixed_kv_layer --> 2 [sk, b, ng, hn]
            if not is_in_onnx_export_mode():
                key_layer, value_layer = _SplitAlongDim.apply(
7899
7900
7901
                    mixed_kv_layer,
                    split_dim,
                    mixed_kv_layer.shape[split_dim] // 2,
cyanguwa's avatar
cyanguwa committed
7902
                )
7903
            else:
cyanguwa's avatar
cyanguwa committed
7904
                key_layer, value_layer = torch.split(
7905
7906
7907
                    mixed_kv_layer,
                    mixed_kv_layer.shape[split_dim] // 2,
                    dim=split_dim,
cyanguwa's avatar
cyanguwa committed
7908
                )
7909
7910
7911
7912
7913
7914
7915
7916
7917
            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)
            )
7918
7919
7920
7921
7922
7923

            # 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,
7924
                    fp8_output=fp8_mha and rotary_pos_emb is None,
7925
7926
7927
7928
7929
7930
7931
7932
7933
                )
                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,
7934
                    fp8_output=fp8_mha and rotary_pos_emb is None,
7935
7936
7937
7938
7939
7940
7941
7942
7943
                )

            # [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)

7944
7945
7946
        # ======================================================
        # Apply relative positional encoding (rotary embedding)
        # ======================================================
7947

7948
        if rotary_pos_emb is not None:
7949
7950
7951
            assert not isinstance(query_layer, Float8Tensor) and not isinstance(
                key_layer, Float8Tensor
            ), "RoPE is not supported for Float8Tensors!"
7952
            # duplicate the pos_emb for self attention
7953
            if not isinstance(rotary_pos_emb, tuple):
7954
                rotary_pos_emb = (rotary_pos_emb,) * 2
7955
7956

            q_pos_emb, k_pos_emb = rotary_pos_emb
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970

            # 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, ...]

7971
7972
            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)
7973

7974
7975
7976
7977
        # ===========================
        # Core attention computation
        # ===========================

7978
7979
7980
7981
        context_layer = self.core_attention(
            query_layer,
            key_layer,
            value_layer,
7982
            qkv_format=self.qkv_format,
7983
7984
7985
7986
            cu_seqlens_q=cu_seqlens_q,
            cu_seqlens_kv=cu_seqlens_kv,
            max_seqlen_q=max_seqlen_q,
            max_seqlen_kv=max_seqlen_kv,
7987
7988
            attention_mask=attention_mask,
            attn_mask_type=attn_mask_type,
7989
            window_size=window_size,
7990
7991
7992
            checkpoint_core_attention=checkpoint_core_attention,
            core_attention_bias_type=core_attention_bias_type,
            core_attention_bias=core_attention_bias,
7993
            alibi_slopes=alibi_slopes,
7994
            fast_zero_fill=fast_zero_fill,
7995
            inference_params=inference_params,
7996
7997
        )

7998
        # ===================
7999
        # Output. [sq, b, h]
8000
        # ===================
8001

8002
        projection_output = self.proj(
8003
8004
            context_layer,
            is_first_microbatch=is_first_microbatch,
8005
8006
        )

8007
8008
8009
8010
8011
8012
8013
8014
        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,)
8015
        if self.input_layernorm and self.return_layernorm_output:
8016
8017
            outputs += (layernorm_output,)
        return outputs if len(outputs) > 1 else outputs[0]