Files
cutlass/python/CuTeDSL/cutlass/base_dsl/ast_preprocessor.py
2025-11-27 09:49:30 -05:00

2145 lines
78 KiB
Python

# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: LicenseRef-NvidiaProprietary
#
# Use of this software is governed by the terms and conditions of the
# NVIDIA End User License Agreement (EULA), available at:
# https://docs.nvidia.com/cutlass/media/docs/pythonDSL/license.html
#
# Any use, reproduction, disclosure, or distribution of this software
# and related documentation outside the scope permitted by the EULA
# is strictly prohibited.
"""
This module defines the `DSLPreprocessor` class, which acts as a Python preprocessor.
It uses Python's AST and rewrites specific Python statements such as `for` and `if-else`.
The preprocessor operates on the following constructs:
- `for` loops:
- Rewrites `for` loops with the `@loop_selector` decorator.
- Supports `range`, `range_dynamic` for loop iteration.
- `if-elif-else` statements:
- Rewrites conditional statements with the `@if_selector` decorator.
- Supports `dynamic_expr` and `const_expr` in the condition expressions.
Additionally, both `for` loops and `if-else` statements require `yield`
operation generation. The preprocessor handles this by:
- Using a `ScopeManager` to track symbols across different scopes during AST traversal.
- Identifying read-only, read-write, and active variables for DSL constructs.
- Generating `yield` operations for symbols that are classified as read-write or write.
It is designed to be generic and can handle `for` and `if` constructs from other dialects.
In such cases, the user's DSL should implement `@loop_selector` and `@if_selector`
to generate dialect-specific operations for `for` and `if` statements.
"""
import ast
import contextlib
import importlib
import inspect
import os
import sys
import textwrap
import warnings
from dataclasses import dataclass
from typing import List, Set, Dict, Any, Callable, Optional
from types import ModuleType
from collections import OrderedDict
from copy import deepcopy
from .common import *
from .utils.logger import log
class OrderedSet:
"""
A deterministic set implementation for ordered operations.
"""
def __init__(self, iterable=None):
self._dict = dict.fromkeys(iterable or [])
def add(self, item):
self._dict[item] = None
def __iter__(self):
return iter(self._dict)
def __and__(self, other):
return OrderedSet(key for key in self._dict if key in other)
def __or__(self, other):
new_dict = self._dict.copy()
new_dict.update(dict.fromkeys(other))
return OrderedSet(new_dict)
def __sub__(self, other):
return OrderedSet(key for key in self._dict if key not in other)
def __bool__(self):
return bool(self._dict)
def intersections(self, others):
"""Compute the intersection of this set with multiple other sets.
:param others: A list of sets to compute intersections with
:type others: List[Set[str]]
:return: A new ordered set containing elements that appear in this set
and at least one of the other sets
"""
result = OrderedSet()
for key in self._dict:
for other in reversed(others):
if key in other:
result.add(key)
break
return result
@dataclass
class ImportInfo:
"""
Information about an import expression.
"""
module_path: str
attr_name: Optional[str]
alias_name: str
@dataclass
class TryImportInfo:
"""
Represents information about a try-import block in the AST.
This dataclass is used to capture and organize the import statements that appear
within the different clauses of a try-except-else-finally block. Each field holds
a list of import statements (or related nodes) that are encountered in the corresponding
clause of the try block.
Attributes:
try_imports (list): Import statements found in the 'try' clause.
except_imports (list): Import statements found in any 'except' clauses.
else_imports (list): Import statements found in the 'else' clause, if present.
finally_imports (list): Import statements found in the 'finally' clause, if present.
This structure allows the preprocessor to track and process imports that are conditionally
executed depending on exception handling logic.
"""
try_imports: list
except_imports: list
else_imports: list
finally_imports: list
@dataclass
class ScopeManager:
"""
Manages symbol scopes during AST traversal.
Manage nested scopes during transformations.
"""
scopes: List[Set[str]]
@classmethod
def create(cls) -> "ScopeManager":
return cls([])
def add_to_scope(self, name: str) -> None:
if name == "_":
return
self.scopes[-1].add(name)
def get_active_symbols(self) -> List[Set[str]]:
return self.scopes.copy()
def __enter__(self) -> "ScopeManager":
self.scopes.append(set())
return self
def __exit__(self, exc_type, exc_value, traceback) -> None:
self.scopes.pop()
class DSLPreprocessor(ast.NodeTransformer):
"""
A preprocessor for transforming Python ASTs. It supports:
- Rewriting `for` loops with the `@loop_selector` decorator.
- Rewriting `if-elif-else` statements with the `@if_selector` decorator.
- Generating `yield` operations for read-write or write symbols.
"""
DECORATOR_FOR_STATEMENT = "loop_selector"
DECORATOR_IF_STATEMENT = "if_selector"
DECORATOR_WHILE_STATEMENT = "while_selector"
IF_EXECUTOR = "if_executor"
WHILE_EXECUTOR = "while_executor"
ASSERT_EXECUTOR = "assert_executor"
BOOL_CAST = "bool_cast"
IMPLICIT_DOWNCAST_NUMERIC_TYPE = "implicitDowncastNumericType"
SUPPORTED_FOR_RANGE_STATEMENTS = {"range", "range_dynamic", "range_constexpr"}
COMPARE_EXECUTOR = "compare_executor"
ANY_EXECUTOR = "any_executor"
ALL_EXECUTOR = "all_executor"
def __init__(self, client_module_name):
super().__init__()
self.counter = 0 # Unique function names for multiple loops
self.scope_manager = ScopeManager.create()
self.processed_functions = set()
self.function_counter = 0
self.function_name = "<unknown function>"
self.class_name = None
self.file_name = "<unknown filename>"
self.function_depth = 0
self.local_closures = set()
self.function_globals = None
self.client_module_name = client_module_name
self.import_top_module = False
def _create_module_attribute(
self,
func_name,
*,
top_module_name="_dsl_",
submodule_name="ast_helpers",
lineno=None,
col_offset=None,
):
# If we simply copy location from origin node, it contains a way to wide range, which cause location in traceback to be wrong.
def set_location(node, lineno, col_offset):
if lineno and col_offset:
node.lineno = lineno
node.end_lineno = lineno
node.col_offset = col_offset
node.end_col_offset = col_offset
base = ast.Name(id=top_module_name, ctx=ast.Load())
set_location(base, lineno, col_offset)
if submodule_name:
base = ast.Attribute(value=base, attr=submodule_name, ctx=ast.Load())
set_location(base, lineno, col_offset)
node = ast.Attribute(value=base, attr=func_name, ctx=ast.Load())
set_location(node, lineno, col_offset)
return node
def _get_imports_from_ast(self, node, module):
"""
Recursively extracts all import statements from the given AST node.
This method traverses the AST of a Python module and collects information about all
import statements, including standard imports, from-imports (with support for relative imports),
and imports that appear within try/except/finally blocks. For try blocks, it also handles
imports that may be conditionally executed in except, else, or finally clauses, specifically
looking for handlers that catch ImportError, ModuleNotFoundError, or Exception.
Args:
node: The AST node (typically an ast.Module) to search for import statements.
module: The Python module object corresponding to the AST, used for resolving relative imports.
Returns:
A list of ImportInfo and TryImportInfo objects representing all discovered imports in the AST.
"""
imports = []
alias = lambda n: n.asname if n.asname else n.name
for child_node in ast.iter_child_nodes(node):
if isinstance(child_node, ast.Import):
for name in child_node.names:
imports.append(
ImportInfo(
module_path=name.name,
attr_name=None,
alias_name=alias(name),
)
)
elif isinstance(child_node, ast.ImportFrom):
module_name = child_node.module
if child_node.level > 0:
# Handle relative imports.
if module.__package__:
package_name = module.__package__.rsplit(
".", child_node.level - 1
)[0]
module_name = f"{package_name}.{module_name}"
else:
# Handle typically some local import like:
# from .common_dense_gemm import DenseGemmKernel
# where there is no __package__, either None
# when in __main__ or '' otherwise.
module_name = f"{module_name}"
for name in child_node.names:
imports.append(
ImportInfo(
module_path=module_name,
attr_name=name.name,
alias_name=alias(name),
)
)
# ast.TryStar is introduced in Python 3.11. Can't use directly in Python 3.10 and lower.
elif isinstance(child_node, (ast.Try, getattr(ast, "TryStar", ast.Try))):
# Handle try-catch
try_imports = self._get_imports_from_ast(
ast.Module(body=child_node.body), module
)
# search handler for ImportError or ModuleNotFoundError
except_imports = []
for handler in child_node.handlers:
if handler.type == None or handler.type.id in [
"ImportError",
"ModuleNotFoundError",
"Exception",
]:
except_imports = self._get_imports_from_ast(
ast.Module(body=handler.body), module
)
break
else_imports = self._get_imports_from_ast(
ast.Module(body=child_node.orelse), module
)
finally_imports = self._get_imports_from_ast(
ast.Module(body=child_node.finalbody), module
)
imports.append(
TryImportInfo(
try_imports, except_imports, else_imports, finally_imports
)
)
return imports
def _get_module_imports(self, decorated_func):
"""Extract imports from the module containing the decorated function"""
imports = []
# Get the module containing the decorated function
if module := inspect.getmodule(decorated_func):
try:
# Get the module source code
source = inspect.getsource(module)
module_ast = ast.parse(source)
imports = self._get_imports_from_ast(module_ast, module)
except (IOError, TypeError):
pass
return imports
def try_import_first_and_then_local_import(self, module_path):
@contextlib.contextmanager
def local_import(module_path):
# Directory where some local import might happen:
local_dir = os.path.dirname(self.file_name)
# Momentarily insert the directory where the local import
# used to happen, so the import can find the module.
sys.path.insert(0, local_dir)
try:
yield importlib.import_module(module_path)
finally:
# Clean up even in the case of an exception.
sys.path.pop(0)
try:
# Try the normal import first.
return importlib.import_module(module_path)
except (ImportError, AttributeError):
# If the normal import failed, tried a local import because we might
# have lost track of sys.path changes.
with local_import(module_path) as module:
return module
def exec_import(self, import_info, exec_globals):
module_path, attr_name, alias_name = (
import_info.module_path,
import_info.attr_name,
import_info.alias_name,
)
module = self.try_import_first_and_then_local_import(module_path)
if attr_name:
if attr_name == "*":
if hasattr(module, "__all__"):
attrs = module.__all__
else:
attrs = [name for name in dir(module) if not name.startswith("_")]
else:
attrs = [attr_name]
for attr in attrs:
alias = attr if attr_name == "*" else alias_name
exec_globals[alias] = getattr(module, attr)
else:
exec_globals[alias_name] = module
def exec_imports(self, import_infos, exec_globals):
for import_info in import_infos:
if isinstance(import_info, ImportInfo):
try:
self.exec_import(import_info, exec_globals)
except (ImportError, AttributeError) as e:
raise ImportError(
f"Failed to import {import_info.module_path}: {str(e)}"
)
elif isinstance(import_info, TryImportInfo):
try:
self.exec_imports(import_info.try_imports, exec_globals)
except (ImportError, AttributeError):
self.exec_imports(import_info.except_imports, exec_globals)
else:
self.exec_imports(import_info.else_imports, exec_globals)
finally:
self.exec_imports(import_info.finally_imports, exec_globals)
def exec(self, function_name, original_function, code_object, exec_globals):
# Get imports from the original module
module_imports = self._get_module_imports(original_function)
# Import all required modules
self.exec_imports(module_imports, exec_globals)
# Execute the transformed code
log().info(
"ASTPreprocessor Executing transformed code for function [%s]",
function_name,
)
exec(code_object, exec_globals)
return exec_globals.get(function_name)
@staticmethod
def print_ast(transformed_tree=None):
print("#", "-" * 40, "Transformed AST", "-" * 40)
unparsed_code = ast.unparse(transformed_tree)
print(unparsed_code)
print("#", "-" * 40, "End Transformed AST", "-" * 40)
def make_func_param_name(self, base_name, used_names):
"""Generate a unique parameter name that doesn't collide with existing names."""
if base_name not in used_names:
return base_name
i = 0
while f"{base_name}_{i}" in used_names:
i += 1
return f"{base_name}_{i}"
def transform_function(self, func_name, function_pointer):
"""
Transforms a function.
"""
# Skip if the function has already been processed
if function_pointer in self.processed_functions:
log().info(
"ASTPreprocessor Skipping already processed function [%s]", func_name
)
return []
# Step 1. Parse the given function
try:
file_name = inspect.getsourcefile(function_pointer)
lines, start_line = inspect.getsourcelines(function_pointer)
dedented_source = textwrap.dedent("".join(lines))
tree = ast.parse(dedented_source, filename=file_name)
# Bump the line numbers so they match the real source file
ast.increment_lineno(tree, start_line - 1)
except Exception:
# Under REPL mode, there is no way to get source of a function object, error out
raise DSLRuntimeError(
f"Failed to parse function {func_name}",
suggestion="DSL does not support REPL mode, save the function to a file instead.",
)
# Step 1.2 Check the decorator
if not self.check_decorator(tree.body[0]):
log().info(
"[%s] - Skipping function due to missing decorator",
func_name,
)
return []
self.processed_functions.add(function_pointer)
log().info("ASTPreprocessor Transforming function [%s]", func_name)
# Step 2. Transform the function
transformed_tree = self.visit(tree)
# Step 3. Import cutlass and base_dsl
top_module_name = ".".join(self.client_module_name)
import_stmts = []
if self.import_top_module:
import_stmts.append(ast.Import(names=[ast.alias(name=top_module_name)]))
import_stmts.append(
ast.Import(
names=[ast.alias(name=f"{top_module_name}.base_dsl", asname="_dsl_")]
)
)
transformed_tree.body = import_stmts + transformed_tree.body
# Step 4. Import cutlass and base_dsl
ast.fix_missing_locations(transformed_tree)
combined_body = transformed_tree.body
# Step 5. Return the transformed tree
return combined_body
def check_early_exit(self, tree, kind):
"""
Checks if a given region or scope in the provided Python code has early exits.
"""
class EarlyExitChecker(ast.NodeVisitor):
def __init__(self, kind):
self.has_early_exit = False
self.early_exit_node = None
self.early_exit_type = None
self.kind = kind
self.loop_nest_level = 0
# Early exit is not allowed in any level of dynamic control flow
def visit_Return(self, node):
self.has_early_exit = True
self.early_exit_node = node
self.early_exit_type = "return"
def visit_Raise(self, node):
self.has_early_exit = True
self.early_exit_node = node
self.early_exit_type = "raise"
def visit_Break(self, node):
# For break/continue in inner loops, we don't consider it as early exit
if self.loop_nest_level == 0 and self.kind != "if":
self.has_early_exit = True
self.early_exit_node = node
self.early_exit_type = "break"
def visit_Continue(self, node):
if self.loop_nest_level == 0 and self.kind != "if":
self.has_early_exit = True
self.early_exit_node = node
self.early_exit_type = "continue"
def visit_For(self, node):
self.loop_nest_level += 1
self.generic_visit(node)
self.loop_nest_level -= 1
def visit_While(self, node):
self.loop_nest_level += 1
self.generic_visit(node)
self.loop_nest_level -= 1
def visit_FunctionDef(self, node):
# Stop at nested function def
return
checker = EarlyExitChecker(kind)
checker.generic_visit(tree)
if not checker.has_early_exit:
return
raise DSLAstPreprocessorError(
message=f"Early exit ({checker.early_exit_type}) is not allowed in `{self.function_name}`"
+ (f" in `{self.class_name}`" if self.class_name else ""),
filename=self.file_name,
snippet=ast.unparse(tree),
suggestion=(
"If predicates are constant expression, write like "
"`if const_expr(...)` or `for ... in range_constexpr(...)`. "
"In that case, early exit will be executed by Python "
"interpreter, so it's supported."
),
)
def is_node_constexpr(self, node) -> bool:
"""
Determines if the node is a constexpr.
Supported nodes are if, while statements.
"""
if isinstance(node, ast.If) or isinstance(node, ast.While):
if isinstance(node.test, ast.Call):
func = node.test.func
if isinstance(func, ast.Attribute) and func.attr == "const_expr":
return True
elif isinstance(func, ast.Name) and func.id == "const_expr":
return True
return False
def _get_range_kind(self, iter_node):
"""
Return "range", "range_dynamic", "range_constexpr" or None for the iterable
"""
if isinstance(iter_node, ast.Call):
func = iter_node.func
if (
isinstance(func, ast.Name)
and func.id in self.SUPPORTED_FOR_RANGE_STATEMENTS
):
return func.id, True, len(iter_node.keywords) != 0
if (
isinstance(func, ast.Attribute)
and func.attr in self.SUPPORTED_FOR_RANGE_STATEMENTS
):
return func.attr, False, len(iter_node.keywords) != 0
return None, None, None
def transform(self, original_function, exec_globals):
"""
Transforms the provided function using the preprocessor.
"""
self.file_name = inspect.getsourcefile(original_function)
self.function_globals = exec_globals
transformed_tree = self.transform_function(
original_function.__name__, original_function
)
self.function_globals = None
unified_tree = ast.Module(body=transformed_tree, type_ignores=[])
unified_tree = ast.fix_missing_locations(unified_tree)
return unified_tree
def analyze_region_variables(
self, node: Union[ast.For, ast.If], active_symbols: List[Set[str]]
):
"""
Analyze variables in different code regions to identify read-only, write-only,
and active variables for DSL constructs.
"""
# we need orderedset to keep the insertion order the same. otherwise generated IR is different each time
write_args = OrderedSet()
invoked_args = OrderedSet()
local_closure = self.local_closures
file_name = self.file_name
region_node = node
called_closures = OrderedSet()
class RegionAnalyzer(ast.NodeVisitor):
force_store = False
def visit_Name(self, node):
"""
Mark every store as write.
"""
if isinstance(node.ctx, ast.Store) or self.force_store:
write_args.add(node.id)
def visit_Subscript(self, node):
# When subscript occurs on the lhs of an assignment, the `Name` is still a load, but `Subscript` is marked as `Store`.
# We need to force the store for the `Name` to be marked as write.
if isinstance(node.ctx, ast.Store):
self.force_store = True
self.visit(node.value)
self.force_store = False
self.visit(node.slice)
else:
self.generic_visit(node)
def visit_Assign(self, node):
self.force_store = True
[self.visit(target) for target in node.targets]
self.force_store = False
self.visit(node.value)
def visit_AugAssign(self, node):
self.force_store = True
self.visit(node.target)
self.force_store = False
self.visit(node.value)
@staticmethod
def get_call_base(func_node):
if isinstance(func_node, ast.Attribute):
# If the .value is another Attribute, keep digging
if isinstance(func_node.value, ast.Attribute):
return RegionAnalyzer.get_call_base(func_node.value)
# If the .value is a Name, that's our base
elif isinstance(func_node.value, ast.Name):
return func_node.value.id
else:
# Could be something else (lambda, call, etc.)
return None
elif isinstance(func_node, ast.Name):
return None
return None
@staticmethod
def get_function_name(func_node: ast.Call):
if isinstance(func_node.func, ast.Name):
function_name = func_node.func.id
# Check if it's a method or attribute call
elif isinstance(func_node.func, ast.Attribute):
function_name = func_node.func.attr
else:
function_name = None
return function_name
def visit_Call(self, node):
base_name = RegionAnalyzer.get_call_base(node.func)
if isinstance(node.func, ast.Name):
func_name = node.func.id
if func_name in local_closure:
called_closures.add(func_name)
# Classes are mutable by default. Mark them as write. If they are
# dataclass(frozen=True), treat them as read in runtime.
if base_name is not None and base_name not in ("self"):
invoked_args.add(base_name)
self.generic_visit(node)
analyzer = RegionAnalyzer()
analyzer.visit(ast.Module(body=node))
# If arg is both write and invoke, remove from invoked_args
invoked_args = invoked_args - write_args
write_args = list(write_args.intersections(active_symbols))
invoked_args = list(invoked_args.intersections(active_symbols))
return write_args + invoked_args, len(write_args), called_closures
def extract_range_args(self, iter_node):
args = iter_node.args
if len(args) == 1:
return (
self.visit(ast.Constant(value=0)),
self.visit(args[0]),
self.visit(ast.Constant(value=1)),
False,
)
elif len(args) == 2:
return (
self.visit(args[0]),
self.visit(args[1]),
self.visit(ast.Constant(value=1)),
False,
)
elif len(args) == 3:
return self.visit(args[0]), self.visit(args[1]), self.visit(args[2]), True
else:
raise DSLAstPreprocessorError(
"Unsupported number of arguments in range", filename=self.file_name
)
def extract_unroll_args(self, iter_node):
keywords = {kw.arg: kw.value for kw in iter_node.keywords}
return (
keywords.get("unroll", ast.Constant(value=-1)),
keywords.get("unroll_full", ast.Constant(value=False)),
)
def issue_deprecation_warning(self, *, message, category, filename, lineno):
warnings.simplefilter("always", category) # turn off filter
warnings.warn_explicit(
message, category=category, filename=filename, lineno=lineno
)
warnings.simplefilter("default", category) # reset filter
def extract_prefetch_stages_args(self, iter_node):
keywords = {kw.arg: kw.value for kw in iter_node.keywords}
if "pipelining" in keywords:
self.issue_deprecation_warning(
message="pipelining is deprecated, use prefetch_stages instead",
category=DeprecationWarning,
filename=self.file_name,
lineno=iter_node.lineno,
)
return keywords.get("pipelining", ast.Constant(value=None))
return keywords.get("prefetch_stages", ast.Constant(value=None))
def create_loop_function(
self,
func_name,
node,
start,
stop,
step,
unroll,
unroll_full,
prefetch_stages,
write_args,
full_write_args_count,
):
"""
Creates a loop body function with the `loop_selector` decorator.
"""
func_args = [ast.arg(arg=node.target.id, annotation=None)]
func_args += [ast.arg(arg=var, annotation=None) for var in write_args]
# Create the loop body
transformed_body = []
for stmt in node.body:
transformed_stmt = self.visit(stmt) # Recursively visit inner statements
if isinstance(transformed_stmt, list):
transformed_body.extend(transformed_stmt)
else:
transformed_body.append(transformed_stmt)
# Handle the return for a single iterated argument correctly
if len(write_args) == 0:
transformed_body.append(ast.Return())
else:
transformed_body.append(
ast.Return(
value=ast.List(
elts=[ast.Name(id=var, ctx=ast.Load()) for var in write_args],
ctx=ast.Load(),
)
)
)
# Define the decorator with parameters
decorator = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.DECORATOR_FOR_STATEMENT,
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[start, stop, step],
keywords=[
ast.keyword(arg="unroll", value=unroll),
ast.keyword(arg="unroll_full", value=unroll_full),
ast.keyword(arg="prefetch_stages", value=prefetch_stages),
ast.keyword(
arg="write_args",
value=self.generate_get_locals_or_none_call(write_args),
),
ast.keyword(
arg="full_write_args_count",
value=ast.Constant(value=full_write_args_count),
),
ast.keyword(
arg="write_args_names",
value=ast.List(
elts=[ast.Constant(value=arg) for arg in write_args],
ctx=ast.Load(),
),
),
],
),
node,
)
return ast.copy_location(
ast.FunctionDef(
name=func_name,
args=ast.arguments(
posonlyargs=[],
args=func_args,
kwonlyargs=[],
kw_defaults=[],
defaults=[],
),
body=transformed_body,
decorator_list=[decorator],
),
node,
)
def visit_BoolOp(self, node):
# Visit child nodes first
self.generic_visit(node)
# It is necessary to expand short circuit evaluation explicit here
# Although we do not support inline if-else for IR generation, this is actually evaluated in Python
# So it's fine here
# Transform "and" to "and_"
if isinstance(node.op, ast.And):
# Create an if-else statement in AST form
# if type(lhs) == bool and lhs == False:
# return lhs
# else
# return and_(lhs, rhs)
short_circuit_value = ast.Constant(value=False)
helper_func = self._create_module_attribute(
"and_",
top_module_name="cutlass",
submodule_name=None,
lineno=node.lineno,
col_offset=node.col_offset,
)
self.import_top_module = True
# Transform "or" to "or_"
elif isinstance(node.op, ast.Or):
# Create an if-else statement in AST form
# if type(lhs) == bool and lhs == True:
# return lhs
# else
# return or_(lhs, rhs)
short_circuit_value = ast.Constant(value=True)
helper_func = self._create_module_attribute(
"or_",
top_module_name="cutlass",
submodule_name=None,
lineno=node.lineno,
col_offset=node.col_offset,
)
self.import_top_module = True
else:
# BoolOp should be either And or Or
raise DSLAstPreprocessorError(
f"Unsupported boolean operation: {node.op}",
filename=self.file_name,
snippet=ast.unparse(node),
)
def short_circuit_eval(value, short_circuit_value):
return ast.BoolOp(
op=ast.And(),
values=[
ast.Compare(
left=ast.Call(
func=ast.Name(id="type", ctx=ast.Load()),
args=[value],
keywords=[],
),
ops=[ast.Eq()],
comparators=[ast.Name(id="bool", ctx=ast.Load())],
),
ast.Compare(
left=value,
ops=[ast.Eq()],
comparators=[short_circuit_value],
),
],
)
lhs = node.values[0]
for i in range(1, len(node.values)):
test = short_circuit_eval(lhs, short_circuit_value)
lhs = ast.IfExp(
test=test,
body=lhs,
orelse=ast.Call(
func=helper_func,
args=[lhs, node.values[i]],
keywords=[],
),
)
return ast.copy_location(lhs, node)
def visit_UnaryOp(self, node):
# Visit child nodes first
self.generic_visit(node)
# Transform "not" to "~" as we overload __invert__
if isinstance(node.op, ast.Not):
func_name = self._create_module_attribute(
"not_",
top_module_name="cutlass",
submodule_name=None,
lineno=node.lineno,
col_offset=node.col_offset,
)
self.import_top_module = True
return ast.copy_location(
ast.Call(func=func_name, args=[node.operand], keywords=[]), node
)
return node
def _insert_range_value_check(self, node):
"""
Insert a check for range arguments
"""
range_inputs = node.iter.args
check_call = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
"range_value_check", lineno=node.lineno, col_offset=node.col_offset
),
args=range_inputs,
keywords=[],
),
node.iter,
)
node.iter = ast.copy_location(
ast.Call(
func=ast.Name(id="range", ctx=ast.Load()),
args=[ast.Starred(value=check_call, ctx=ast.Load())],
keywords=[],
),
node.iter,
)
def _insert_cf_symbol_check(self, func):
"""
Insert a check for range symbol
"""
check_call = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
"cf_symbol_check", lineno=func.lineno, col_offset=func.col_offset
),
args=[deepcopy(func)],
keywords=[],
),
func,
)
return ast.Expr(check_call)
def visit_For(self, node):
# For static for loop (for with range_constexpr or not range based for), preprocessor keeps the loop.
range_kind, is_builtin_range, has_keyword = self._get_range_kind(node.iter)
if range_kind == "range_constexpr" or range_kind == None:
self.generic_visit(node)
if range_kind == "range_constexpr":
check_call = self._insert_cf_symbol_check(node.iter.func)
# Rewrite range_constexpr to range
node.iter.func = ast.Name(id="range", ctx=ast.Load())
self._insert_range_value_check(node)
return [check_call, node]
return node
active_symbols = self.scope_manager.get_active_symbols()
with self.scope_manager:
if isinstance(node.target, ast.Name):
self.scope_manager.add_to_scope(node.target.id)
if range_kind == "range_dynamic":
# Generate a warning
self.issue_deprecation_warning(
message="range_dynamic is deprecated and will be removed in the future, please remove it.",
category=DeprecationWarning,
filename=self.file_name,
lineno=node.iter.lineno,
)
is_prefixed_range = range_kind == "range" and not is_builtin_range
check_call = None
if range_kind == "range_dynamic" or is_prefixed_range:
# Insert a check for range symbol
if not is_prefixed_range:
check_call = self._insert_cf_symbol_check(node.iter.func)
else:
# Get toplevel module
check_call = self._insert_cf_symbol_check(node.iter.func.value)
new_for_node = self.transform_for_loop(node, active_symbols)
if check_call is not None:
new_for_node = [check_call] + new_for_node
return new_for_node
@staticmethod
def _hoist_expr_to_assignments(expr, name):
return ast.copy_location(
ast.Assign(targets=[ast.Name(id=name, ctx=ast.Store())], value=expr), expr
)
def _build_select_and_assign(self, *, name, test, body, orelse, location):
node = ast.copy_location(
ast.Assign(
targets=[ast.Name(id=name, ctx=ast.Store())],
value=ast.IfExp(
test=test,
body=body,
orelse=orelse,
),
),
location,
)
self.generic_visit(node)
return node
def _handle_negative_step(self, node, start_expr, stop_expr, step_expr):
# hoist start, stop, step to assignments
start_ori_name = f"start_ori_{self.counter}"
start = self._hoist_expr_to_assignments(start_expr, start_ori_name)
stop_ori_name = f"stop_ori_{self.counter}"
stop = self._hoist_expr_to_assignments(stop_expr, stop_ori_name)
step_ori_name = f"step_ori_{self.counter}"
step = self._hoist_expr_to_assignments(step_expr, step_ori_name)
extra_exprs = [start, stop, step]
# Handle possible negative step, generates the following code in Python:
# isNegative = step < 0
isNegative_name = f"isNegative_{self.counter}"
isNegative = ast.copy_location(
ast.Assign(
targets=[ast.Name(id=isNegative_name, ctx=ast.Store())],
value=ast.Compare(
left=ast.Name(id=step_ori_name, ctx=ast.Load()),
ops=[ast.Lt()],
comparators=[ast.Constant(value=0)],
),
),
step,
)
# start = stop if isNegative else start
start_name = f"start_{self.counter}"
start = self._build_select_and_assign(
name=start_name,
test=ast.Name(id=isNegative_name, ctx=ast.Load()),
body=ast.Name(id=stop_ori_name, ctx=ast.Load()),
orelse=ast.Name(id=start_ori_name, ctx=ast.Load()),
location=start,
)
# stop = start if isNegative else stop
stop_name = f"stop_{self.counter}"
stop = self._build_select_and_assign(
name=stop_name,
test=ast.Name(id=isNegative_name, ctx=ast.Load()),
body=ast.Name(id=start_ori_name, ctx=ast.Load()),
orelse=ast.Name(id=stop_ori_name, ctx=ast.Load()),
location=stop,
)
# step = -step if isNegative else step
step_name = f"step_{self.counter}"
step = self._build_select_and_assign(
name=step_name,
test=ast.Name(id=isNegative_name, ctx=ast.Load()),
body=ast.UnaryOp(
op=ast.USub(), operand=ast.Name(id=step_ori_name, ctx=ast.Load())
),
orelse=ast.Name(id=step_ori_name, ctx=ast.Load()),
location=step,
)
# offset = start + stop if isNegative else 0
offset_name = f"offset_{self.counter}"
offset = self._build_select_and_assign(
name=offset_name,
test=ast.Name(id=isNegative_name, ctx=ast.Load()),
body=ast.BinOp(
op=ast.Add(),
left=ast.Name(id=start_name, ctx=ast.Load()),
right=ast.Name(id=stop_name, ctx=ast.Load()),
),
orelse=ast.Constant(value=0),
location=node,
)
extra_exprs.append(isNegative)
extra_exprs.append(start)
extra_exprs.append(stop)
extra_exprs.append(step)
extra_exprs.append(offset)
# Add this to begining of loop body
# for i in range(start, stop, step):
# i = offset - i if isNegative else i
assert isinstance(node.target, ast.Name)
target_name = node.target.id
target = self._build_select_and_assign(
name=target_name,
test=ast.Name(id=isNegative_name, ctx=ast.Load()),
body=ast.BinOp(
op=ast.Sub(),
left=ast.Name(id=offset_name, ctx=ast.Load()),
right=ast.Name(id=target_name, ctx=ast.Load()),
),
orelse=ast.Name(id=target_name, ctx=ast.Load()),
location=node.target,
)
node.body.insert(0, target)
return (
ast.Name(id=start_name, ctx=ast.Load()),
ast.Name(id=stop_name, ctx=ast.Load()),
ast.Name(id=step_name, ctx=ast.Load()),
extra_exprs,
)
def _create_closure_check_call(self, called_closures, node):
return ast.Expr(
ast.Call(
func=self._create_module_attribute(
"closure_check",
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[
ast.List(
elts=[ast.Name(id=c, ctx=ast.Load()) for c in called_closures],
ctx=ast.Load(),
)
],
keywords=[],
)
)
def transform_for_loop(self, node, active_symbols):
# Check for early exit and raise exception
self.check_early_exit(node, "for")
if node.orelse:
raise DSLAstPreprocessorError(
"dynamic for loop with else is not supported",
filename=self.file_name,
snippet=ast.unparse(node),
)
# Get loop target variable name
target_var_name = None
target_var_is_active_before_loop = False
if isinstance(node.target, ast.Name):
target_var_name = node.target.id
for active_symbol in active_symbols:
if target_var_name in active_symbol:
target_var_is_active_before_loop = True
active_symbols.remove(active_symbol)
break
# Add necessary exprs to handle this
if target_var_is_active_before_loop:
# Initialize an extra loop carried variable
loop_carried_var_name = f"loop_carried_var_{self.counter}"
pre_loop_expr = ast.copy_location(
ast.Assign(
targets=[ast.Name(id=loop_carried_var_name, ctx=ast.Store())],
value=ast.Name(id=target_var_name, ctx=ast.Load()),
),
node,
)
# append an extra assignment to the loop carried variable
node.body.append(
ast.copy_location(
ast.Assign(
targets=[ast.Name(id=loop_carried_var_name, ctx=ast.Store())],
value=ast.Name(id=target_var_name, ctx=ast.Load()),
),
node,
)
)
active_symbols.append({loop_carried_var_name})
start_expr, stop_expr, step_expr, has_step = self.extract_range_args(node.iter)
unroll, unroll_full = self.extract_unroll_args(node.iter)
prefetch_stages = self.extract_prefetch_stages_args(node.iter)
write_args, full_write_args_count, called_closures = (
self.analyze_region_variables(node, active_symbols)
)
if has_step and self.client_module_name[0] == "cutlass":
start, stop, step, exprs = self._handle_negative_step(
node, start_expr, stop_expr, step_expr
)
else:
start, stop, step, exprs = start_expr, stop_expr, step_expr, []
if target_var_is_active_before_loop:
exprs.append(pre_loop_expr)
if called_closures:
exprs.append(self._create_closure_check_call(called_closures, node))
func_name = f"loop_body_{self.counter}"
self.counter += 1
func_def = self.create_loop_function(
func_name,
node,
start,
stop,
step,
unroll,
unroll_full,
prefetch_stages,
write_args,
full_write_args_count,
)
assign = self.create_cf_call(func_name, write_args, node)
# This should work fine as it modifies the AST structure
exprs = exprs + [func_def] + assign
if target_var_is_active_before_loop:
# Create a new assignment to the target variable
exprs.append(
ast.copy_location(
ast.Assign(
targets=[ast.Name(id=target_var_name, ctx=ast.Store())],
value=ast.Name(id=loop_carried_var_name, ctx=ast.Load()),
),
node,
)
)
return exprs
def visit_Assert(self, node):
test = self.visit(node.test)
args = [ast.keyword(arg="test", value=test)]
if node.msg:
msg = self.visit(node.msg)
args.append(ast.keyword(arg="msg", value=msg))
# Rewrite to assert_executor(test, msg)
new_node = ast.Expr(
ast.Call(
func=self._create_module_attribute(
self.ASSERT_EXECUTOR, lineno=node.lineno, col_offset=node.col_offset
),
args=[],
keywords=args,
)
)
# Propagate line number from original node to new node
ast.copy_location(new_node, node)
return new_node
def visit_Call(self, node):
func = node.func
# Visit args and kwargs
node.args = [self.visit(arg) for arg in node.args]
node.keywords = [self.visit(kwarg) for kwarg in node.keywords]
# Rewrite call to some built-in functions
if isinstance(func, ast.Name):
# Check if the function is 'bool'
if func.id == "bool":
return ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.BOOL_CAST,
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[node.args[0]],
keywords=[],
),
node,
)
elif func.id in ["any", "all"]:
helper_func = (
self.ANY_EXECUTOR if func.id == "any" else self.ALL_EXECUTOR
)
return ast.copy_location(
ast.Call(
func=self._create_module_attribute(
helper_func, lineno=node.lineno, col_offset=node.col_offset
),
args=[node.args[0]],
keywords=[],
),
node,
)
elif func.id in ["min", "max"]:
self.import_top_module = True
return ast.copy_location(
ast.Call(
func=self._create_module_attribute(
func.id,
top_module_name="cutlass",
submodule_name=None,
lineno=node.lineno,
col_offset=node.col_offset,
),
args=node.args,
keywords=[],
),
node,
)
elif func.id == "super" and node.args == [] and node.keywords == []:
# If it's a Python3 argument free super(), rewrite to old style super with args
# So if this call is under dynamic control flow, it still works.
return ast.copy_location(
ast.Call(
func=func,
args=node.args
+ [
ast.Attribute(
value=ast.Name(id="self", ctx=ast.Load()),
attr="__class__",
ctx=ast.Load(),
),
ast.Name(id="self", ctx=ast.Load()),
],
keywords=node.keywords,
),
node,
)
elif isinstance(func, ast.Attribute) and isinstance(func.value, ast.Name):
def create_downcast_call(arg):
return ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.IMPLICIT_DOWNCAST_NUMERIC_TYPE,
submodule_name="typing",
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[arg],
keywords=[],
),
arg,
)
module = self.function_globals.get(func.value.id)
if isinstance(module, ModuleType) and module.__package__.endswith(
"._mlir.dialects"
):
# Check if argument is Numeric, if so, call ir_value()
args = []
for arg in node.args:
args.append(create_downcast_call(arg))
kwargs = []
for kwarg in node.keywords:
kwargs.append(
ast.copy_location(
ast.keyword(
arg=kwarg.arg,
value=create_downcast_call(kwarg.value),
),
kwarg,
)
)
return ast.copy_location(
ast.Call(func=func, args=args, keywords=kwargs), node
)
else:
node.func = self.visit(node.func)
return node
def visit_ClassDef(self, node):
self.class_name = node.name
self.generic_visit(node)
self.class_name = None
return node
def _visit_target(self, target):
if isinstance(target, ast.Name):
self.scope_manager.add_to_scope(target.id)
elif isinstance(target, ast.Tuple):
for t in target.elts:
if isinstance(t, ast.Name):
self.scope_manager.add_to_scope(t.id)
def visit_Assign(self, node):
for target in node.targets:
self._visit_target(target)
self.generic_visit(node)
return node
def visit_AugAssign(self, node):
self._visit_target(node.target)
self.generic_visit(node)
return node
def visit_Name(self, node):
isLoad = isinstance(node.ctx, ast.Load)
if node.id in ["max", "min", "any", "all"] and isLoad:
return ast.copy_location(
ast.Call(
func=self._create_module_attribute(
"redirect_builtin_function",
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[node],
keywords=[],
),
node,
)
elif node.id == "_" and isLoad:
raise DSLAstPreprocessorError("Read '_' is not allowed")
else:
self.generic_visit(node)
return node
def check_decorator(self, node: ast.AST) -> bool:
"""
Check if the function has the correct decorator for preprocessing.
"""
if not isinstance(node, ast.FunctionDef):
return False
decorator_list = node.decorator_list
if len(decorator_list) == 0:
return False
for d in decorator_list:
if isinstance(d, ast.Call):
if isinstance(d.func, ast.Attribute):
if d.func.attr in ["jit", "kernel"]:
if d.keywords == []:
return True
for keyword in d.keywords:
if keyword.arg == "preprocess":
try:
if isinstance(keyword.value, ast.Constant):
return keyword.value.value
else:
return ast.literal_eval(keyword.value)
except:
pass
elif isinstance(d, ast.Attribute):
if d.attr in ["jit", "kernel"]:
return True
return False
def remove_dsl_decorator(self, decorator_list):
"""
Remove .jit and .kernel decorators
The decorator can be in two forms:
- @jit(...)
- @jit
"""
new_decorator_list = []
decorator_names = ["jit", "kernel"]
for d in decorator_list:
is_jit_or_kernel = False
if isinstance(d, ast.Call):
if isinstance(d.func, ast.Attribute):
if d.func.attr in decorator_names:
is_jit_or_kernel = True
elif isinstance(d, ast.Attribute):
if d.attr in decorator_names:
is_jit_or_kernel = True
if not is_jit_or_kernel:
new_decorator_list.append(d)
return new_decorator_list
def visit_FunctionDef(self, node):
with self.scope_manager:
self.function_counter += 1
self.function_name = node.name
if self.function_depth > 0:
self.local_closures.add(node.name)
self.function_depth += 1
# Add function name and arguments
self.scope_manager.add_to_scope(node.name)
for arg in node.args.args:
self.scope_manager.add_to_scope(arg.arg)
self.generic_visit(node)
self.function_depth -= 1
# Remove .jit and .kernel decorators
node.decorator_list = self.remove_dsl_decorator(node.decorator_list)
return node
def visit_With(self, node):
with self.scope_manager:
for item in node.items:
if isinstance(item.optional_vars, ast.Name):
self.scope_manager.add_to_scope(item.optional_vars.id)
self.generic_visit(node)
return node
def visit_While(self, node):
# Constexpr doesn't get preprocessed
if self.is_node_constexpr(node):
self.generic_visit(node)
check = self._insert_cf_symbol_check(node.test.func)
return [check, node]
active_symbols = self.scope_manager.get_active_symbols()
with self.scope_manager:
# Check for early exit and raise exception
self.check_early_exit(node, "while")
write_args, full_write_args_count, called_closures = (
self.analyze_region_variables(node, active_symbols)
)
exprs = []
if called_closures:
exprs.append(self._create_closure_check_call(called_closures, node))
func_name = f"while_region_{self.counter}"
self.counter += 1
func_def = self.create_while_function(
func_name, node, write_args, full_write_args_count
)
assign = self.create_cf_call(func_name, write_args, node)
return exprs + [func_def] + assign
def visit_Try(self, node):
with self.scope_manager:
self.generic_visit(node)
return node
def visit_ExceptHandler(self, node):
with self.scope_manager:
if node.name: # Exception variable
self.scope_manager.add_to_scope(node.name)
self.generic_visit(node)
return node
def create_cf_call(self, func_name, yield_args, node):
"""Creates the assignment statement for the if function call"""
if not yield_args:
return [
ast.copy_location(
ast.Expr(value=ast.Name(id=func_name, ctx=ast.Load())), node
)
]
has_self = False
for i, arg in enumerate(yield_args):
if arg == "self":
has_self = True
yield_args[i] = "yield_self"
break
if len(yield_args) == 1:
assign = ast.Assign(
targets=[ast.Name(id=yield_args[0], ctx=ast.Store())],
value=ast.Name(id=func_name, ctx=ast.Load()),
)
else:
assign = ast.Assign(
targets=[
ast.Tuple(
elts=[ast.Name(id=var, ctx=ast.Store()) for var in yield_args],
ctx=ast.Store(),
)
],
value=ast.Name(id=func_name, ctx=ast.Load()),
)
if has_self:
fix_self = ast.Expr(
value=ast.Call(
func=self._create_module_attribute(
"copy_members", lineno=node.lineno, col_offset=node.col_offset
),
args=[
ast.Name(id="self", ctx=ast.Load()),
ast.Name(id="yield_self", ctx=ast.Load()),
],
keywords=[],
)
)
return [ast.copy_location(assign, node), ast.copy_location(fix_self, node)]
else:
return [ast.copy_location(assign, node)]
def visit_IfExp(self, node):
"""
Visits an inline if-else expression (ternary operator).
This is the Python equivalent of `x if condition else y`.
"""
self.generic_visit(node)
# Emit
# node if type(pred) == bool else select_(pred, body, orelse)
# so if pred is a python bool, use python to short-circuit and avoid emit arith.select
self.import_top_module = True
return ast.copy_location(
ast.IfExp(
test=ast.Compare(
left=ast.Call(
func=ast.Name(id="type", ctx=ast.Load()),
args=[node.test],
keywords=[],
),
ops=[ast.Eq()],
comparators=[ast.Name(id="bool", ctx=ast.Load())],
),
body=node, # Original ternary expression
orelse=ast.Call(
func=self._create_module_attribute(
"select_", top_module_name="cutlass", submodule_name=None
),
args=[
node.test,
node.body,
node.orelse,
],
keywords=[],
),
),
node,
)
cmpops = {
"Eq": "==",
"NotEq": "!=",
"Lt": "<",
"LtE": "<=",
"Gt": ">",
"GtE": ">=",
"Is": "is",
"IsNot": "is not",
"In": "in",
"NotIn": "not in",
}
def compare_ops_to_str(self, node):
names = [
ast.Constant(value=self.cmpops[op.__class__.__name__]) for op in node.ops
]
return ast.List(elts=names, ctx=ast.Load())
def visit_Compare(self, node):
self.generic_visit(node)
comparator_strs = self.compare_ops_to_str(node)
keywords = [
ast.keyword(arg="left", value=node.left),
ast.keyword(
arg="comparators", value=ast.List(elts=node.comparators, ctx=ast.Load())
),
ast.keyword(arg="ops", value=comparator_strs),
]
call = ast.copy_location(
ast.Call(
func=self._create_module_attribute(self.COMPARE_EXECUTOR),
args=[],
keywords=keywords,
),
node,
)
return call
def visit_If(self, node):
# const_expr doesn't get preprocessed
if self.is_node_constexpr(node):
self.generic_visit(node)
check = self._insert_cf_symbol_check(node.test.func)
return [check, node]
active_symbols = self.scope_manager.get_active_symbols()
with self.scope_manager:
# Check for early exit and raise exception
self.check_early_exit(node, "if")
yield_args, full_write_args_count, called_closures = (
self.analyze_region_variables(node, active_symbols)
)
exprs = []
if called_closures:
exprs.append(self._create_closure_check_call(called_closures, node))
func_name = f"if_region_{self.counter}"
self.counter += 1
func_def = self.create_if_function(
func_name, node, yield_args, full_write_args_count
)
assign = self.create_cf_call(func_name, yield_args, node)
return exprs + [func_def] + assign
def generate_get_locals_or_none_call(self, write_args):
return ast.Call(
func=self._create_module_attribute("get_locals_or_none"),
args=[
ast.Call(
func=ast.Name(id="locals", ctx=ast.Load()), args=[], keywords=[]
),
ast.List(
elts=[ast.Constant(value=arg) for arg in write_args],
ctx=ast.Load(),
),
],
keywords=[],
)
def create_if_function(self, func_name, node, write_args, full_write_args_count):
test_expr = self.visit(node.test)
pred_name = self.make_func_param_name("pred", write_args)
func_args = [ast.arg(arg=pred_name, annotation=None)]
func_args += [ast.arg(arg=var, annotation=None) for var in write_args]
func_args_then_else = [ast.arg(arg=var, annotation=None) for var in write_args]
then_body = []
for stmt in node.body:
transformed_stmt = self.visit(stmt) # Recursively visit inner statements
if isinstance(transformed_stmt, list):
then_body.extend(transformed_stmt)
else:
then_body.append(transformed_stmt)
# Create common return list for all blocks
return_list = ast.List(
elts=[ast.Name(id=var, ctx=ast.Load()) for var in write_args],
ctx=ast.Load(),
)
# Create common function arguments
func_decorator_arguments = ast.arguments(
posonlyargs=[], args=func_args, kwonlyargs=[], kw_defaults=[], defaults=[]
)
func_then_else_arguments = ast.arguments(
posonlyargs=[],
args=func_args_then_else,
kwonlyargs=[],
kw_defaults=[],
defaults=[],
)
then_block_name = f"then_block_{self.counter}"
else_block_name = f"else_block_{self.counter}"
elif_region_name = f"elif_region_{self.counter}"
self.counter += 1
# Create then block
then_block = ast.copy_location(
ast.FunctionDef(
name=then_block_name,
args=func_then_else_arguments,
body=then_body + [ast.Return(value=return_list)],
decorator_list=[],
),
node,
)
# Decorator keywords
decorator_keywords = [
ast.keyword(
arg="pred", value=test_expr
), # ast.Name(id="pred", ctx=ast.Load())
ast.keyword(
arg="write_args",
value=self.generate_get_locals_or_none_call(write_args),
),
]
# Create decorator
decorator = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.DECORATOR_IF_STATEMENT,
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[],
keywords=decorator_keywords,
),
node,
)
# Executor keywords
execute_keywords = [
ast.keyword(arg="pred", value=ast.Name(id=pred_name, ctx=ast.Load())),
ast.keyword(
arg="write_args",
value=ast.List(
elts=[ast.Name(id=arg, ctx=ast.Load()) for arg in write_args],
ctx=ast.Load(),
),
),
ast.keyword(
arg="full_write_args_count",
value=ast.Constant(value=full_write_args_count),
),
ast.keyword(
arg="write_args_names",
value=ast.List(
elts=[ast.Constant(value=arg) for arg in write_args],
ctx=ast.Load(),
),
),
ast.keyword(
arg="then_block", value=ast.Name(id=then_block_name, ctx=ast.Load())
),
]
# Handle different cases
if not write_args and node.orelse == []:
# No write_args case - only then_block needed
execute_call = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.IF_EXECUTOR, lineno=node.lineno, col_offset=node.col_offset
),
args=[],
keywords=execute_keywords,
),
node,
)
func_body = [then_block, ast.Return(value=execute_call)]
else:
# Create else block based on node.orelse
if node.orelse:
if len(node.orelse) == 1 and isinstance(node.orelse[0], ast.If):
# Handle elif case
elif_node = node.orelse[0]
nested_if_name = elif_region_name
# AST cannot distinguish between the following two cases:
# elif pred:
# and
# else:
# if pred:
# And under both cases, the `pred` can be a const_expr, so we need to handle it here.
if self.is_node_constexpr(elif_node):
self.generic_visit(elif_node)
check = self._insert_cf_symbol_check(elif_node.test.func)
else_block = ast.FunctionDef(
name=else_block_name,
args=func_then_else_arguments,
body=[
check,
elif_node,
ast.Return(value=return_list),
],
decorator_list=[],
)
else:
# Recursion for nested elif
nested_if = self.create_if_function(
nested_if_name, elif_node, write_args, full_write_args_count
)
else_block = ast.FunctionDef(
name=else_block_name,
args=func_then_else_arguments,
body=[
nested_if,
ast.Return(
value=ast.Name(id=nested_if_name, ctx=ast.Load())
),
],
decorator_list=[],
)
else:
else_body = []
for stmt in node.orelse:
transformed_stmt = self.visit(
stmt
) # Recursively visit inner statements
if isinstance(transformed_stmt, list):
else_body.extend(transformed_stmt)
else:
else_body.append(transformed_stmt)
# Regular else block
else_block = ast.FunctionDef(
name=else_block_name,
args=func_then_else_arguments,
body=else_body + [ast.Return(value=return_list)],
decorator_list=[],
)
else:
# Default else block
else_block = ast.FunctionDef(
name=else_block_name,
args=func_then_else_arguments,
body=[ast.Return(value=return_list)],
decorator_list=[],
)
# Add else_block to execute keywords
execute_keywords.append(
ast.keyword(
arg="else_block", value=ast.Name(id=else_block_name, ctx=ast.Load())
)
)
execute_call = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.IF_EXECUTOR, lineno=node.lineno, col_offset=node.col_offset
),
args=[],
keywords=execute_keywords,
),
node,
)
func_body = [
then_block,
ast.copy_location(else_block, node),
ast.Return(value=execute_call),
]
return ast.copy_location(
ast.FunctionDef(
name=func_name,
args=func_decorator_arguments,
body=func_body,
decorator_list=[decorator],
),
node,
)
def create_while_function(self, func_name, node, write_args, full_write_args_count):
"""Create a while function that looks like:
@while_selector(pred, write_args=[])
def while_region(pred, write_args):
def while_before_block(*write_args):
# Note that during eval of pred can possibly alter yield_args
return *pred, write_args
def while_after_block(*write_args):
...loop_body_transformed...
return write_args
return self.while_executor(pred, write_args,
while_before_block, while_after_block, constexpr)
write_args = while_region(pred, write_args)
Which will later be executed as psuedo-code:
# Dynamic mode:
scf.WhileOp(types(write_args), write_args)
with InsertionPoint(before_block):
cond, write_args = while_before_block(*write_args)
scf.ConditionOp(cond, write_args)
with InsertionPoint(after_block):
write_args = while_after_block(write_args)
scf.YieldOp(write_args)
return while_op.results_
# Const mode:
cond, write_args = while_before_block(write_args)
while pred:
write_args = body_block(write_args)
cond, write_args = while_before_block(write_args)
return write_args
"""
test_expr = self.visit(node.test)
pred_name = self.make_func_param_name("pred", write_args)
# Section: decorator construction
decorator_keywords = [
ast.keyword(arg="pred", value=test_expr),
ast.keyword(
arg="write_args",
value=self.generate_get_locals_or_none_call(write_args),
),
]
decorator = ast.copy_location(
ast.Call(
func=self._create_module_attribute(
self.DECORATOR_WHILE_STATEMENT,
lineno=node.lineno,
col_offset=node.col_offset,
),
args=[],
keywords=decorator_keywords,
),
node,
)
# Section: Shared initialization for before and after blocks
while_before_block_name = f"while_before_block_{self.counter}"
while_after_block_name = f"while_after_block_{self.counter}"
self.counter += 1
block_args_args = [ast.arg(arg=var, annotation=None) for var in write_args]
block_args = ast.arguments(
posonlyargs=[],
args=block_args_args,
kwonlyargs=[],
kw_defaults=[],
defaults=[],
)
yield_args_ast_name_list = ast.List(
elts=[ast.Name(id=var, ctx=ast.Load()) for var in write_args],
ctx=ast.Load(),
)
# Section: while_before_block FunctionDef, which contains condition
while_before_return_list = ast.List(
elts=[test_expr, yield_args_ast_name_list],
ctx=ast.Load(),
)
while_before_stmts = [ast.Return(value=while_before_return_list)]
while_before_block = ast.copy_location(
ast.FunctionDef(
name=while_before_block_name,
args=block_args,
body=while_before_stmts,
decorator_list=[],
),
test_expr,
)
# Section: while_after_block FunctionDef, which contains loop body
while_after_stmts = []
for stmt in node.body:
transformed_stmt = self.visit(stmt) # Recursively visit inner statements
if isinstance(transformed_stmt, list):
while_after_stmts.extend(transformed_stmt)
else:
while_after_stmts.append(transformed_stmt)
while_after_stmts.append(ast.Return(value=yield_args_ast_name_list))
while_after_block = ast.copy_location(
ast.FunctionDef(
name=while_after_block_name,
args=block_args,
body=while_after_stmts,
decorator_list=[],
),
node,
)
# Section: Execute via executor
execute_keywords = [
ast.keyword(arg="pred", value=ast.Name(id=pred_name, ctx=ast.Load())),
ast.keyword(
arg="write_args",
value=ast.List(
elts=[ast.Name(id=arg, ctx=ast.Load()) for arg in write_args],
ctx=ast.Load(),
),
),
ast.keyword(
arg="full_write_args_count",
value=ast.Constant(value=full_write_args_count),
),
ast.keyword(
arg="while_before_block",
value=ast.Name(id=while_before_block_name, ctx=ast.Load()),
),
ast.keyword(
arg="while_after_block",
value=ast.Name(id=while_after_block_name, ctx=ast.Load()),
),
ast.keyword(
arg="write_args_names",
value=ast.List(
elts=[ast.Constant(value=arg) for arg in write_args],
ctx=ast.Load(),
),
),
]
execute_call = ast.Call(
func=self._create_module_attribute(
self.WHILE_EXECUTOR, lineno=node.lineno, col_offset=node.col_offset
),
args=[],
keywords=execute_keywords,
)
# Putting everything together, FunctionDef for while_region
func_args_args = [ast.arg(arg=pred_name, annotation=None)]
func_args_args += [ast.arg(arg=var, annotation=None) for var in write_args]
func_args = ast.arguments(
posonlyargs=[],
args=func_args_args,
kwonlyargs=[],
kw_defaults=[],
defaults=[],
)
return ast.copy_location(
ast.FunctionDef(
name=func_name,
args=func_args,
body=[
while_before_block,
while_after_block,
ast.Return(value=execute_call),
],
decorator_list=[decorator],
),
node,
)