test_cutlass.py

"""Tests for cutlass kernels

Run `pytest tests/kernels/test_cutlass.py`.
"""
from typing import Optional, Type

import pytest
import torch

from vllm import _custom_ops as ops
from vllm.platforms import current_platform
from .utils import torch_version

CUDA_DEVICES = [
    f"cuda:{i}" for i in range(1 if torch.cuda.device_count() == 1 else 2)
]

capability = current_platform.get_device_capability()
capability = capability[0] * 10 + capability[1]


def to_fp8(tensor: torch.Tensor):
    finfo = torch.finfo(torch.float8_e4m3fn)
    return torch.round(tensor.clamp(
        min=finfo.min, max=finfo.max)).to(dtype=torch.float8_e4m3fn)


def to_int8(tensor: torch.Tensor):
    return torch.round(tensor.clamp(min=-128, max=127)).to(dtype=torch.int8)


def rand_int8(shape: tuple, device: str = "cuda"):
    return to_int8(torch.rand(shape, device=device) * 255 - 128)


def baseline_scaled_mm(a: torch.Tensor,
                       b: torch.Tensor,
                       scale_a: torch.Tensor,
                       scale_b: torch.Tensor,
                       out_dtype: Type[torch.dtype],
                       bias: Optional[torch.Tensor] = None) -> torch.Tensor:
    output = (scale_a * (scale_b.T * (torch.mm(
        a.to(dtype=torch.float32), b.to(dtype=torch.float32))))).to(out_dtype)
    if bias is not None:
        output = output + bias

    return output


def cutlass_fp8_gemm_helper(m: int,
                            n: int,
                            k: int,
                            per_token_act_quant: bool,
                            per_out_channel_weight_quant: bool,
                            use_bias: bool,
                            out_dtype: Type[torch.dtype] = torch.bfloat16,
                            device: str = "cuda"):
    # Test for a cutlass kernel with per-token activation quantization
    # and per-output channel weight quantization.
    a = to_fp8(torch.randn((m, k), device=device))
    b = to_fp8(torch.randn((n, k), device=device).t())

    m_a_scales = m if per_token_act_quant else 1
    n_b_scales = n if per_out_channel_weight_quant else 1

    scale_a = (torch.randn((m_a_scales, 1), device=device,
                           dtype=torch.float32))
    scale_b = (torch.randn((1, n_b_scales), device=device,
                           dtype=torch.float32))
    if use_bias:
        bias = torch.rand((n, ), device=device, dtype=out_dtype) * 10
    else:
        bias = None

    out = ops.cutlass_scaled_mm(a, b, scale_a, scale_b, out_dtype, bias)
    baseline = baseline_scaled_mm(a, b, scale_a, scale_b, out_dtype, bias)

    if torch_version.startswith("2.3"):
        assert torch.allclose(out, baseline, rtol=1e-2, atol=1e-1)
    elif torch_version.startswith("2.4"):
        from tests.kernels.utils import opcheck   
        torch.testing.assert_close(out, baseline, rtol=1e-2, atol=5e-2)

        opcheck(torch.ops._C.cutlass_scaled_mm,
                (out, a, b, scale_a, scale_b, bias))
    else:
        print(f"PyTorch version {torch_version} is not specifically handled.")


def cutlass_int8_gemm_helper(m: int,
                             n: int,
                             k: int,
                             per_token_act_quant: bool,
                             per_out_channel_weight_quant: bool,
                             use_bias: bool,
                             out_dtype: Type[torch.dtype] = torch.bfloat16,
                             device: str = "cuda"):
    # Test for a cutlass kernel with per-token activation quantization
    # and per-output channel weight quantization.
    a = to_int8(torch.randn((m, k), device=device) * 5)
    b = to_int8(torch.randn((n, k), device=device).t() * 5)

    m_a_scales = m if per_token_act_quant else 1
    n_b_scales = n if per_out_channel_weight_quant else 1

    scale_a = (torch.randn((m_a_scales, 1), device=device,
                           dtype=torch.float32))
    scale_b = (torch.randn((n_b_scales,1), device=device,
                           dtype=torch.float32))

    if use_bias:
        bias = torch.rand((n, ), device=device, dtype=out_dtype) * 10
    else:
        bias = None

    b=b.contiguous().reshape(k,-1)
    # print("a.shape:",a.shape)
    # print("b.shape:",b.shape)
    
    out = ops.cutlass_scaled_mm(a, b, scale_a, scale_b, out_dtype, bias)
    baseline = baseline_scaled_mm(a, b, scale_a, scale_b, out_dtype, bias)

    # print("out:",out[0:5][0:5])
    # print("baseline:",baseline[0:5][0:5])
    
    if torch_version.startswith("2.3"):
        assert torch.allclose(out, baseline, rtol=1e-1, atol=1e0)
    elif torch_version.startswith("2.4"):
        from tests.kernels.utils import opcheck   
        torch.testing.assert_close(out, baseline, rtol=1e-1, atol=1e0)
        # opcheck(torch.ops._C.cutlass_scaled_mm,
        #         (out, a, b, scale_a, scale_b, bias))
    else:
        print(f"PyTorch version {torch_version} is not specifically handled.")


# @pytest.mark.parametrize("m", [1, 16, 32, 64, 128, 256, 512, 222, 100, 33])
# @pytest.mark.parametrize("n", [2048, 4096, 8192, 16384, 24576, 256, 1024])
# @pytest.mark.parametrize("k", [128, 496, 1024])
# @pytest.mark.parametrize("per_act_token", [True, False])
# @pytest.mark.parametrize("per_out_ch", [True, False])
# @pytest.mark.parametrize("use_bias", [True, False])
# @pytest.mark.skipif(not current_platform.has_device_capability(89),
#                     reason="FP8 is not supported on this GPU type.")
# def test_cutlass_fp8_gemm(m: int, n: int, k: int, per_act_token: bool,
#                           per_out_ch: bool, use_bias: bool):
#     cutlass_fp8_gemm_helper(m, n, k, per_act_token, per_out_ch, use_bias)


@pytest.mark.parametrize("m", [1, 16, 32, 64, 128, 256, 512, 222, 33, 1])
@pytest.mark.parametrize("n", [2048, 8192, 16384, 256, 1024])
@pytest.mark.parametrize("k", [128, 496, 1024])
@pytest.mark.parametrize("per_act_token", [True])
@pytest.mark.parametrize("per_out_ch", [True])
@pytest.mark.parametrize("use_bias", [True, False])
def test_cutlass_int8_gemm(m: int, n: int, k: int, per_act_token: bool,
                           per_out_ch: bool, use_bias: bool):
    cutlass_int8_gemm_helper(m, n, k, per_act_token, per_out_ch, use_bias)


@pytest.mark.parametrize("per_act_token", [True])
@pytest.mark.parametrize("per_out_ch", [True])
@pytest.mark.parametrize("out_dtype", [ torch.float16]) #torch.bfloat16,
@pytest.mark.parametrize("use_bias", [True, False])
def test_cutlass_int8_gemm_output_dtype(per_act_token: bool, per_out_ch: bool,
                                        out_dtype: Type[torch.dtype],
                                        use_bias: bool):
    cutlass_int8_gemm_helper(512,
                             512,
                             512,
                             per_act_token,
                             per_out_ch,
                             use_bias,
                             out_dtype=out_dtype)


# @pytest.mark.parametrize("per_act_token", [True, False])
# @pytest.mark.parametrize("per_out_ch", [True, False])
# @pytest.mark.parametrize("out_dtype", [torch.bfloat16, torch.float16])
# @pytest.mark.parametrize("use_bias", [True, False])
# @pytest.mark.skipif(not current_platform.has_device_capability(89),
#                     reason="FP8 is not supported on this GPU type.")
# def test_cutlass_fp8_gemm_output_dtype(per_act_token: bool, per_out_ch: bool,
#                                        out_dtype: Type[torch.dtype],
#                                        use_bias: bool):
#     cutlass_fp8_gemm_helper(512,
#                             512,
#                             512,
#                             per_act_token,
#                             per_out_ch,
#                             use_bias,
#                             out_dtype=out_dtype)


# @pytest.mark.parametrize("per_act_token", [True, False])
# @pytest.mark.parametrize("per_out_ch", [True, False])
# @pytest.mark.parametrize("use_bias", [True, False])
# @pytest.mark.parametrize("device", CUDA_DEVICES)
# @pytest.mark.skipif(not current_platform.has_device_capability(89),
#                     reason="FP8 is not supported on this GPU type.")
# def test_cutlass_fp8_gemm_devices(per_act_token: bool, per_out_ch: bool,
#                                   use_bias: bool, device: str):
#     cutlass_fp8_gemm_helper(512, 512, 512, per_act_token, per_out_ch, use_bias,
#                             torch.bfloat16, device)


# @pytest.mark.parametrize("per_act_token", [True, False])
# @pytest.mark.parametrize("per_out_ch", [True, False])
# @pytest.mark.parametrize("use_bias", [True, False])
# @pytest.mark.parametrize("device", CUDA_DEVICES)
# def test_cutlass_int8_gemm_devices(per_act_token: bool, per_out_ch: bool,
#                                    use_bias: bool, device: str):
#     cutlass_int8_gemm_helper(512,
#                              512,
#                              512,
#                              per_act_token,
#                              per_out_ch,
#                              use_bias,
#                              out_dtype=torch.bfloat16,
#                              device=device)


# For the following two tests:
# N and K correspond to the size of the weight matrix and likely to be multiples
# of a large power of two. In any case, the kernel will have a naive fallback
# when N and K are not divisible by 16. But M is the number of tokens and the
# kernel must handle any M thrown at it.
# @pytest.mark.parametrize("per_act_token", [True, False])
# @pytest.mark.parametrize("per_out_ch", [True, False])
# @pytest.mark.parametrize("use_bias", [True, False])
# @pytest.mark.skipif(not current_platform.has_device_capability(89),
#                     reason="FP8 is not supported on this GPU type.")
# def test_cutlass_fp8_gemm_m_sweep(per_act_token: bool, per_out_ch: bool,
#                                   use_bias: bool):
#     for nk in range(32, 128, 32):
#         for m in range(1, 128):
#             cutlass_fp8_gemm_helper(m, nk, nk, per_act_token, per_out_ch,
#                                     use_bias)


# @pytest.mark.parametrize("per_act_token", [True, False])
# @pytest.mark.parametrize("per_out_ch", [True, False])
# @pytest.mark.parametrize("use_bias", [True, False])
# def test_cutlass_int8_gemm_m_sweep(per_act_token: bool, per_out_ch: bool,
#                                    use_bias: bool):
#     for nk in range(32, 128, 32):
#         for m in range(1, 128):
#             cutlass_int8_gemm_helper(m, nk, nk, per_act_token, per_out_ch,
#                                      use_bias)


# @pytest.mark.parametrize("m", [32, 64, 128])
# @pytest.mark.parametrize("n", [16, 32, 64])
# @pytest.mark.parametrize("k", [64, 128, 256])
# @pytest.mark.parametrize("out_dtype", [torch.bfloat16, torch.float16])
# @pytest.mark.skip
# def test_cutlass_int8_azp_bias_fold(m: int, n: int, k: int,
#                                     out_dtype: torch.dtype):
#     # Currently, the test is failing because folding azp into
#     # 16-bit bias loses too much precision
#     scale_a = torch.randn((1, 1), device="cuda", dtype=torch.float32) / 10
#     scale_b = torch.randn((1, n), device="cuda", dtype=torch.float32) / 10

#     aq_i8 = rand_int8((m, k))
#     bq_i8 = rand_int8((n, k)).t()

#     aq_i32 = aq_i8.to(dtype=torch.int32)
#     bq_i32 = bq_i8.to(dtype=torch.int32)

#     aq_f32 = aq_i8.to(dtype=torch.float32)
#     bq_f32 = bq_i8.to(dtype=torch.float32)

#     b_dq = scale_b * bq_f32

#     azp_a = torch.rand((1, ), device="cuda", dtype=torch.float32) * 10 + 1.5
#     azp_aq_i8 = (azp_a / scale_a).to(dtype=torch.int8)
#     azp_a = azp_aq_i8.to(dtype=torch.float32) * scale_a  # correct for rounding

#     a_dq = scale_a * (aq_i32 + azp_aq_i8).to(dtype=torch.float32)
#     torch.testing.assert_close(a_dq, scale_a * aq_f32 + azp_a)

#     baseline_dq = torch.mm(a_dq, b_dq).to(out_dtype)

#     J = torch.ones((1, k), device="cuda", dtype=torch.float32)
#     azp_bias = (azp_a * scale_b * (J @ bq_f32)).to(out_dtype)
#     assert azp_bias.shape == (1, n)
#     assert azp_bias[0, :].shape == (n, )

#     baseline_q = (scale_a.to(device='cpu') * scale_b.to(device='cpu') * (
#         (aq_i32 + azp_aq_i8).to(device='cpu') @ bq_i32.to(device='cpu'))).to(
#             dtype=out_dtype, device='cuda')

#     out = ops.cutlass_scaled_mm(aq_i8,
#                                 bq_i8,
#                                 scale_a,
#                                 scale_b,
#                                 out_dtype=out_dtype,
#                                 bias=azp_bias[0, :])
#     torch.testing.assert_close(out, baseline_dq, rtol=1e-2, atol=1e0)
#     torch.testing.assert_close(out, baseline_q, rtol=1e-2, atol=1e0)


# @pytest.mark.parametrize("m", [32, 64, 128])
# @pytest.mark.parametrize("n", [16, 32, 64])
# @pytest.mark.parametrize("k", [64, 128, 256])
# @pytest.mark.parametrize("out_dtype", [torch.bfloat16, torch.float16])
# @pytest.mark.parametrize("use_bias", [True, False])
# @pytest.mark.parametrize("azp_per_token", [True, False])
# def test_cutlass_int8_azp(m: int, n: int, k: int, out_dtype: torch.dtype,
#                           use_bias: bool, azp_per_token: bool):
#     m_azp = m if azp_per_token else 1
#     scale_a = torch.randn((m_azp, 1), device="cuda", dtype=torch.float32) / 10
#     scale_b = torch.randn((1, n), device="cuda", dtype=torch.float32) / 10

#     aq_i8 = rand_int8((m, k))
#     aq_i32 = aq_i8.to(dtype=torch.int32)
#     aq_f32 = aq_i8.to(dtype=torch.float32)

#     bq_i8 = rand_int8((n, k)).t()
#     bq_i32 = bq_i8.to(dtype=torch.int32)
#     bq_f32 = bq_i8.to(dtype=torch.float32)
#     b_dq = scale_b * bq_f32

#     azp_a = torch.rand(
#         (m_azp, 1), device="cuda", dtype=torch.float32) * 10 + 1.5
#     azp_aq_i8 = (azp_a / scale_a).to(dtype=torch.int8)
#     azp_a = azp_aq_i8.to(dtype=torch.float32) * scale_a  # correct for rounding

#     a_dq = scale_a * (aq_i32 - azp_aq_i8).to(dtype=torch.float32)
#     torch.testing.assert_close(a_dq,
#                                scale_a * aq_f32 - azp_a,
#                                rtol=1e-4,
#                                atol=1e-3)

#     if use_bias:
#         bias = torch.rand((1, n), device="cuda", dtype=out_dtype) * 10 + 2.5
#     else:
#         bias = torch.zeros((1, n), device="cuda", dtype=out_dtype)

#     baseline_dq = (torch.mm(a_dq, b_dq) + bias).to(out_dtype)

#     # int32 mm not supported on CUDA
#     a_noazp_i32_cpu = (aq_i32 - azp_aq_i8).to(device='cpu')
#     cq = (a_noazp_i32_cpu @ bq_i32.to(device='cpu')).to(device='cuda')
#     baseline_q = (scale_a * scale_b * cq + bias).to(dtype=out_dtype)

#     # Hadamard is just the sum of the cols
#     azp_adj_i32 = bq_i32.sum(dim=0, keepdim=True, dtype=torch.int32)
#     azp_i32 = azp_aq_i8.to(dtype=torch.int32)
#     func_bias = bias if use_bias else None

#     if azp_per_token:
#         out = ops.cutlass_scaled_mm_azp(aq_i8, bq_i8, scale_a, scale_b,
#                                         out_dtype, azp_adj_i32, azp_i32,
#                                         func_bias)
#     else:
#         azp_with_adj_i32 = azp_i32 * azp_adj_i32
#         out = ops.cutlass_scaled_mm_azp(aq_i8, bq_i8, scale_a, scale_b,
#                                         out_dtype, azp_with_adj_i32, None,
#                                         func_bias)

#     # bfloat16 precision is 7-bit mantissa -> 2^-8 ~ 0.4%
#     # float16 precision is 10-bit mantissa -> 2^-11 ~ 0.05%
#     rtol = 1e-2 if out_dtype == torch.bfloat16 else 1e-3
    # atol = 1e-3
    # if torch_version.startswith("2.3"):
    #     assert torch.allclose(out, baseline_dq, rtol=rtol, atol=atol)
    #     assert torch.allclose(out, baseline_q, rtol=rtol, atol=atol)
    # elif torch_version.startswith("2.4"):
    #     from tests.kernels.utils import opcheck
    #     torch.testing.assert_close(out, baseline_dq, rtol=rtol, atol=atol)
    #     torch.testing.assert_close(out, baseline_q, rtol=rtol, atol=atol)

    #     if azp_per_token:
    #         opcheck(torch.ops._C.cutlass_scaled_mm_azp,
    #                 (out, aq_i8, bq_i8, scale_a, scale_b, azp_adj_i32, azp_i32,
    #                 func_bias))
    #     else:
    #         opcheck(torch.ops._C.cutlass_scaled_mm_azp,
    #                 (out, aq_i8, bq_i8, scale_a, scale_b, azp_with_adj_i32, None,
    #                 func_bias))
    # else:
    #     print(f"PyTorch version {torch_version} is not specifically handled.")


# Test working with a subset of A and B
def test_cutlass_subset():
    big_m, big_n, big_k = 1024, 1024, 1024
    m, n, k = 512, 512, 512

    whole_a = to_int8(torch.randn((big_m, big_k), device="cuda") * 5)
    whole_b = to_int8(torch.randn((big_n, big_k), device="cuda").t() * 5)
    a = whole_a[0:m, 0:k]
    b = whole_b[0:k, 0:n]
    
    #变成连续内存，矩阵子模块目前不支持计算，需要重新计算lda
    a=a.contiguous().reshape(m,-1)
    b=b.contiguous().reshape(k,-1)
    
    scale_a = torch.randn((1, 1), device="cuda", dtype=torch.float32) / 10
    scale_b = torch.randn((1, 1), device="cuda", dtype=torch.float32) / 10

    out = ops.cutlass_scaled_mm(a,
                                b,
                                scale_a,
                                scale_b,
                                out_dtype=torch.bfloat16)
    baseline = baseline_scaled_mm(a,
                                  b,
                                  scale_a,
                                  scale_b,
                                  out_dtype=torch.bfloat16)

    torch.testing.assert_close(out, baseline, rtol=1e-1, atol=1e0)


# Test to make sure cuda graphs work
class CutlassLayer(torch.nn.Module):

    def __init__(self, b, scale_a, scale_b, out_dtype):
        super().__init__()
        self.b = b
        self.scale_a = scale_a
        self.scale_b = scale_b
        self.out_dtype = out_dtype

    def forward(self, a):
        return ops.cutlass_scaled_mm(a, self.b, self.scale_a, self.scale_b,
                                     self.out_dtype)

#目前只支持per-act-token+per-out-ch(fp16)
@pytest.mark.parametrize("per_act_token", [True])
@pytest.mark.parametrize("per_out_ch", [True])
def test_cutlass_cuda_graph(per_act_token: bool, per_out_ch: bool):
    m, n, k = 512, 512, 512

    a = to_int8(torch.randn((m, k), device="cuda"))
    b = to_int8(torch.randn((n, k), device="cuda").t())
    b=b.contiguous().reshape(k,-1)
    
    m_a_scales = m if per_act_token else 1
    n_b_scales = n if per_out_ch else 1

    scale_a = (torch.randn(
        (m_a_scales, 1), device="cuda", dtype=torch.float32) / 10)
    scale_b = (torch.randn(
        (n_b_scales,1), device="cuda", dtype=torch.float32) / 10)

    # Construct a trivial model with a single layer that calls a CUTLASS kernel
    model = CutlassLayer(b, scale_a, scale_b, torch.float16)

    # Run the model with a cuda graph
    stream = torch.cuda.Stream()
    with torch.cuda.stream(stream):
        g = torch.cuda.CUDAGraph()
        with torch.cuda.graph(g):
            out = model(a)
    out.zero_()
    g.replay()

    baseline = torch.mm(scale_a * a.to(dtype=torch.float32),
                        scale_b.T * b.to(dtype=torch.float32)).to(torch.float16)
    #print("baseline:",baseline)
    out=ops.cutlass_scaled_mm(a, b, scale_a, scale_b,
                                     torch.float16)
    #print("out:",out)
    torch.testing.assert_close(out, baseline, rtol=1e-1, atol=1e0)