Files
composable_kernel/dispatcher/codegen/generate_arch_specs.py
Ville Pietilä 78d657c4f7 [rocm-libraries] ROCm/rocm-libraries#7284 (commit e7d25b2)
[CK_TILE] Integrate CK Tile Dispatcher code generation into
 CK Tile Profiler (#7284)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Motivation

CK Tile is going to be delivered to hipDNN via CK Dispatcher. Currently
the CK Tile Profiler using CK Builder for generating the profiled
instances from the configuration files that identify the instances that
old CK exposes. We need to replace this instance generation with the CK
Tile Dispatcher codegen.

## Technical Details
The old CK Profiler config files are converted to JSON files that the CK
Tile Dispatcher can digest. The conversion script for configurations is
stored to source control in case we need to update the JSON
configurations later. The dispatcher generates instance libraries per
conv direction (fwd, bwd data, and bwd weight) that are linked to the CK
Profiler executable. I also implemented codegne for the stream-K and
depthwise conv instances. The proposed solution replaces the CK Builder
codegen with the CK Tile Dispatcher codegen.

There are two new methods that are exposed via the dispatcher backend

- `is_supported` - required to enabled the profiler workflow where we
check the applicability of the kernel instance before running it.
- `get_instance_string` - this mainly for verification. This provide the
CK Builder instance string for verifying that the old CK Builder based
profiler and the new CK Tile Dispatcher based profiler have the same
instances.

The rules that limit the generated instances are now collected to a
single location under the dispacther. The CK Builder codegen uses these,
which ensures that the two codegen pipelines are in sync. The next step
(different PR) is to remove the CK Builder codegen pipeline altogether.

## Test Plan

Verified that the old CK Builder based profiler and the new CK Tile
Dispatcher based profiler have the same instances, that is, the
Dispatcher based codgen can generate the same instances as the old CK
Builder.

## Submission Checklist

- [x] Look over the contributing guidelines at
https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests.
2026-05-28 21:03:37 +00:00

454 lines
14 KiB
Python

#!/usr/bin/env python3
# Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
# SPDX-License-Identifier: MIT
"""
Architecture Specs Generator
Generates both Python and C++ code from a single JSON source of truth.
This ensures consistency between Python codegen and C++ runtime filtering.
Usage:
python generate_arch_specs.py [--json arch_specs.json] [--output-dir .]
# Regenerate after editing arch_specs.json:
python generate_arch_specs.py
Output:
- arch_specs_generated.py (Python module with arch data)
- arch_specs_generated.hpp (C++ header with arch data)
"""
import json
import argparse
from pathlib import Path
from datetime import datetime
from typing import Dict, Any
SCRIPT_DIR = Path(__file__).parent
def load_arch_specs(json_path: Path) -> Dict[str, Any]:
"""Load architecture specifications from JSON file."""
with open(json_path) as f:
return json.load(f)
def generate_python_module(specs: Dict[str, Any], output_path: Path):
"""Generate Python module from arch specs."""
timestamp = datetime.now().isoformat()
# Extract data
archs = specs["architectures"]
element_sizes = specs["element_sizes"]
pipeline_limits = specs["pipeline_lds_limits"]
unsupported = specs["unsupported_trait_combos"]["combinations"]
# Build warp configs dict
warp_configs_str = "{\n"
for arch, data in archs.items():
warp_configs_str += f' "{arch}": {data["warp_configs"]},\n'
warp_configs_str += "}"
# Build warp tile combos dict
warp_tile_str = "{\n"
for arch, data in archs.items():
warp_tile_str += f' "{arch}": {{\n'
for dtype, combos in data["warp_tile_combos"].items():
warp_tile_str += f' "{dtype}": {combos},\n'
warp_tile_str += " },\n"
warp_tile_str += "}"
# Build arch family map
arch_family_str = "{\n"
for arch, data in archs.items():
arch_family_str += f' "{arch}": "{data["family"]}",\n'
arch_family_str += "}"
# Build unsupported combos set
unsupported_str = "{\n"
for combo in unsupported:
unsupported_str += f' ("{combo[0]}", "{combo[1]}", "{combo[2]}"),\n'
unsupported_str += "}"
# Pipeline LDS limits
pipeline_limits_clean = {
k: v for k, v in pipeline_limits.items() if not k.startswith("_")
}
# Build dtype combinations dict
dtype_combos = specs.get("dtype_combinations", {})
dtype_combos_str = "{\n"
for key, info in dtype_combos.items():
if not key.startswith("_"):
dtype_combos_str += f' "{key}": {{"acc": "{info["acc"]}", "notes": "{info["notes"]}"}},\n'
dtype_combos_str += "}"
# Build preshuffle warp tile combos dict (operator-specific)
preshuffle_combos = specs.get("preshuffle_warp_tile_combos", {})
preshuffle_warp_tile_str = "{\n"
for arch, dtype_combos_dict in preshuffle_combos.items():
if not arch.startswith("_"):
preshuffle_warp_tile_str += f' "{arch}": {{\n'
for dtype, combos in dtype_combos_dict.items():
preshuffle_warp_tile_str += f' "{dtype}": {combos},\n'
preshuffle_warp_tile_str += " },\n"
preshuffle_warp_tile_str += "}"
# Build preshuffle pipelines list
preshuffle_pipelines = specs.get("preshuffle_pipelines", {}).get(
"supported", ["preshufflev2"]
)
preshuffle_pipelines_str = str(preshuffle_pipelines)
content = f'''# SPDX-License-Identifier: MIT
"""
AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY!
Generated from: arch_specs.json
Generated at: {timestamp}
To update this file:
1. Edit arch_specs.json
2. Run: python generate_arch_specs.py
This module provides architecture-specific configurations for kernel filtering.
"""
from typing import Dict, List, Set, Tuple
# =============================================================================
# Architecture Data (Generated from arch_specs.json)
# =============================================================================
# GPU architecture to family mapping
ARCH_FAMILY_MAP: Dict[str, str] = {arch_family_str}
# Element size in bytes for each data type
ELEMENT_SIZE_MAP: Dict[str, float] = {element_sizes}
# Supported warp configurations per architecture [warp_m, warp_n, warp_k]
WARP_SUPPORTED_COMBINATIONS: Dict[str, List[List[int]]] = {warp_configs_str}
# Supported warp tile combinations: arch -> dtype_key -> [[warp_tile_m, n, k], ...]
WARP_TILE_SUPPORTED_COMBINATIONS: Dict[str, Dict[str, List[List[int]]]] = {warp_tile_str}
# Preshuffle-specific warp tile combinations (subset of standard GEMM)
PRESHUFFLE_WARP_TILE_SUPPORTED_COMBINATIONS: Dict[str, Dict[str, List[List[int]]]] = {preshuffle_warp_tile_str}
# Preshuffle-supported pipelines
PRESHUFFLE_PIPELINES: List[str] = {preshuffle_pipelines_str}
# LDS capacity limits per pipeline type (in bytes)
LDS_CAPACITY_LIMITS: Dict[str, int] = {pipeline_limits_clean}
# Unsupported trait combinations: (pipeline, epilogue, scheduler)
TRAIT_UNSUPPORTED_COMBINATIONS: Set[Tuple[str, str, str]] = {unsupported_str}
# Valid dtype combinations: (A_dtype, B_dtype) -> acc_dtype and notes
DTYPE_COMBINATIONS: Dict[str, Dict[str, str]] = {dtype_combos_str}
# =============================================================================
# Helper Functions
# =============================================================================
def get_supported_archs() -> List[str]:
"""Get list of all supported GPU architectures."""
return list(ARCH_FAMILY_MAP.keys())
def get_arch_family(gpu_arch: str) -> str:
"""Get the GPU family for an architecture."""
return ARCH_FAMILY_MAP.get(gpu_arch.lower(), "unknown")
def get_element_size(dtype: str) -> float:
"""Get element size in bytes for a data type."""
return ELEMENT_SIZE_MAP.get(dtype.lower(), 2.0)
def get_warp_configs(gpu_arch: str) -> List[List[int]]:
"""Get supported warp configurations for an architecture."""
return WARP_SUPPORTED_COMBINATIONS.get(gpu_arch.lower(), [])
def get_warp_tile_combos(gpu_arch: str, dtype_key: str) -> List[List[int]]:
"""Get supported warp tile combinations for arch and data types."""
gpu_combos = WARP_TILE_SUPPORTED_COMBINATIONS.get(gpu_arch.lower(), {{}})
return gpu_combos.get(dtype_key.lower(), [])
def get_lds_limit(pipeline: str) -> int:
"""Get LDS capacity limit for a pipeline type."""
return LDS_CAPACITY_LIMITS.get(pipeline.lower(), LDS_CAPACITY_LIMITS["default"])
def is_trait_combo_unsupported(pipeline: str, epilogue: str, scheduler: str) -> bool:
"""Check if a trait combination is unsupported."""
return (pipeline.lower(), epilogue.lower(), scheduler.lower()) in TRAIT_UNSUPPORTED_COMBINATIONS
def get_dtype_info(dtype_a: str, dtype_b: str) -> Dict[str, str]:
"""Get accumulator type and notes for a dtype combination."""
key = f"{{dtype_a.lower()}}_{{dtype_b.lower()}}"
return DTYPE_COMBINATIONS.get(key, {{"acc": "fp32", "notes": "unknown"}})
def is_dtype_combo_valid(dtype_a: str, dtype_b: str) -> bool:
"""Check if a dtype combination is valid."""
key = f"{{dtype_a.lower()}}_{{dtype_b.lower()}}"
return key in DTYPE_COMBINATIONS
def get_valid_dtype_combos() -> List[str]:
"""Get list of all valid dtype combinations."""
return list(DTYPE_COMBINATIONS.keys())
'''
output_path.write_text(content)
print(f"Generated: {output_path}")
def generate_cpp_header(specs: Dict[str, Any], output_path: Path):
"""Generate C++ header from arch specs."""
timestamp = datetime.now().isoformat()
# Extract data
archs = specs["architectures"]
element_sizes = specs["element_sizes"]
pipeline_limits = specs["pipeline_lds_limits"]
specs["unsupported_trait_combos"]["combinations"]
# Build arch enum and string functions
arch_enums = []
arch_to_string_cases = []
string_to_arch_cases = []
for arch, data in archs.items():
enum_name = arch.upper().replace("GFX", "GFX_")
arch_enums.append(f" {enum_name},")
arch_to_string_cases.append(
f' case GpuArch::{enum_name}: return "{arch}";'
)
string_to_arch_cases.append(
f' if (arch_str == "{arch}") return GpuArch::{enum_name};'
)
# Build warp configs switch
warp_config_cases = []
for arch, data in archs.items():
enum_name = arch.upper().replace("GFX", "GFX_")
configs = ", ".join(
[f"{{{c[0]}, {c[1]}, {c[2]}}}" for c in data["warp_configs"]]
)
warp_config_cases.append(
f" case GpuArch::{enum_name}: return {{{configs}}};"
)
# Build element size switch
# Include all data types defined in kernel_key.hpp DataType enum
elem_size_cases = []
dtype_enum_map = {
"fp16": "FP16",
"bf16": "BF16",
"fp32": "FP32",
"fp64": "FP64",
"fp8": "FP8",
"bf8": "BF8",
"int8": "INT8",
"int4": "INT4",
"int32": "INT32",
}
for dtype, size in element_sizes.items():
if dtype in dtype_enum_map:
elem_size_cases.append(
f" case DataType::{dtype_enum_map[dtype]}: return {float(size)}f;"
)
# Build LDS limits
lds_limit_cases = []
pipeline_enum_map = {
"mem": "Mem",
"compv1": "CompV1",
"compv2": "CompV2",
"compv3": "CompV3",
"compv4": "CompV4",
"compv5": "CompV5",
"compv6": "CompV6",
"preshufflev1": "PreShuffleV1",
"preshufflev2": "PreShuffleV2",
}
default_lds = pipeline_limits.get("default", 65536)
for pipeline, limit in pipeline_limits.items():
if pipeline in pipeline_enum_map:
lds_limit_cases.append(
f" if (pipeline == Pipeline::{pipeline_enum_map[pipeline]}) return {limit};"
)
content = f"""// Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
// SPDX-License-Identifier: MIT
/**
* AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY!
*
* Generated from: arch_specs.json
* Generated at: {timestamp}
*
* To update this file:
* 1. Edit arch_specs.json
* 2. Run: python generate_arch_specs.py
*/
#pragma once
#include "ck_tile/dispatcher/kernel_key.hpp"
#include <array>
#include <string>
#include <vector>
#include <cstdint>
namespace ck_tile {{
namespace dispatcher {{
namespace arch_specs {{
// =============================================================================
// GPU Architecture Enum (Generated)
// =============================================================================
enum class GpuArch : std::uint8_t {{
{chr(10).join(arch_enums)}
UNKNOWN
}};
// =============================================================================
// String Conversion Functions (Generated)
// =============================================================================
inline std::string arch_to_string(GpuArch arch) {{
switch (arch) {{
{chr(10).join(arch_to_string_cases)}
default: return "unknown";
}}
}}
inline GpuArch string_to_arch(const std::string& arch_str) {{
{chr(10).join(string_to_arch_cases)}
return GpuArch::UNKNOWN;
}}
// =============================================================================
// Element Size (Generated)
// =============================================================================
inline float element_size(DataType dtype) {{
switch (dtype) {{
{chr(10).join(elem_size_cases)}
default: return 2.0f;
}}
}}
// =============================================================================
// Warp Configurations (Generated)
// =============================================================================
using WarpConfig = std::array<int, 3>;
inline std::vector<WarpConfig> get_supported_warp_configs(GpuArch arch) {{
switch (arch) {{
{chr(10).join(warp_config_cases)}
default: return {{}};
}}
}}
// =============================================================================
// LDS Capacity Limits (Generated)
// =============================================================================
inline std::size_t get_lds_capacity(Pipeline pipeline) {{
{chr(10).join(lds_limit_cases)}
return {default_lds}; // Default
}}
// =============================================================================
// Unsupported Trait Combinations (Generated)
// =============================================================================
inline bool is_trait_unsupported(Pipeline pipeline, [[maybe_unused]] Epilogue epilogue, Scheduler scheduler) {{
// Generated from unsupported_trait_combos in arch_specs.json
if (scheduler == Scheduler::Interwave) {{
if (pipeline == Pipeline::CompV3 || pipeline == Pipeline::CompV4) {{
return true;
}}
}}
return false;
}}
}} // namespace arch_specs
}} // namespace dispatcher
}} // namespace ck_tile
"""
output_path.write_text(content)
print(f"Generated: {output_path}")
def main():
parser = argparse.ArgumentParser(
description="Generate Python and C++ code from arch_specs.json"
)
parser.add_argument(
"--json",
type=Path,
default=SCRIPT_DIR / "arch_specs.json",
help="Path to arch_specs.json",
)
parser.add_argument(
"--output-dir",
type=Path,
default=SCRIPT_DIR,
help="Output directory for generated files",
)
parser.add_argument(
"--cpp-output-dir",
type=Path,
default=None,
help="Output directory for C++ header (defaults to dispatcher/include/...)",
)
args = parser.parse_args()
# Load specs
print(f"Loading: {args.json}")
specs = load_arch_specs(args.json)
# Generate Python module
py_output = args.output_dir / "arch_specs_generated.py"
generate_python_module(specs, py_output)
# Generate C++ header
if args.cpp_output_dir:
cpp_output = args.cpp_output_dir / "arch_specs_generated.hpp"
else:
cpp_output = (
SCRIPT_DIR.parent
/ "include"
/ "ck_tile"
/ "dispatcher"
/ "arch_specs_generated.hpp"
)
cpp_output.parent.mkdir(parents=True, exist_ok=True)
generate_cpp_header(specs, cpp_output)
print("\nDone! To apply changes:")
print(" 1. Python code will automatically use arch_specs_generated.py")
print(" 2. C++ code includes arch_specs_generated.hpp")
if __name__ == "__main__":
main()