Files
Tianqi Chen 1e1920bcbd [REFACTOR][IR] Unify PrimExpr type mechanism to PrimType instead of DataType (#19875)
In the past we have been using `DataType` in PrimExpr.dtype field to
check type information for PrimExpr while still having BaseExpr.ty for
richer type information. DataType is also used both in runtime and
compiler. This PR streamlines the boundary:

- PrimExpr.ty now carries PrimType that replaces original use of
`DataType`
- Runtime use will now favor DLPack DLDataType, removing one layer of
indirection.
- Constants attributes where values are usually runtime values, will use
`DLDataType`
- DataType will be phased out after this PR

We also brings up helper functions in PrimType, but also limits them to
a more concise set so the functions do not grow with the data type codes
in DLPack.

This is a major refactor that changes the IR primitive. It helps to
bring possible future benefits:
- Unified type mechanism through Expr.ty
- Possibility of carry future Type nodes 

Migration Guide:
- Use `PrimType` when code reasons about compiler expression types,
tensor element compiler types, or constructs a `PrimExpr`/compiler type.
- Use existing source types such as `expr.ty()`, `ExprOp.expr_ty()`, or
TE tensor element `dtype` where possible instead of rebuilding a type
from dtype text.
- Use raw `DLDataType` for runtime constants, ABI paths, dtype-valued
attrs, and storage/runtime helper logic.
- Prefer direct `PrimType` equality, `MatchesCode(...)`,
`MatchesElementType(...)`, and `WithCode(...)` over local wrappers or
string dtype checks.

Performance:

Using Object type instead of DLDataType would indeed bring some
performance impact to the IR. We have done the following performance
optimizations:
- Make sure most of the outputs reuse one of the PrimType from inputs
- Cache a thread local PrimType based on input so we don't repeatly
realloc

We did benchmarks show that rewrite simplify operation stays within
+-10% overhead of original one. Which merits the refactor given the
benefit the unfication brings
2026-06-24 21:31:47 -04:00

94 lines
3.9 KiB
Python

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# pylint: disable=invalid-name, unused-argument, redefined-argument-from-local
"""Dispatch sampling operators to platform dependent implementation."""
from tvm import relax
from tvm.ir import Op
from tvm.ir.module import IRModule
from tvm.ir.transform import PassContext, module_pass
from tvm.relax import expr_functor
from .utils import BackendDispatcher
@expr_functor.mutator
class SamplingDispatcher(BackendDispatcher):
"""Dispatcher to dispatch sampling op."""
def visit_call_(self, call: relax.Call) -> relax.Expr:
if not isinstance(call.op, Op):
return super().visit_call_(call)
if call.op.name == "relax.multinomial_from_uniform":
from tvm.relax.backend.gpu_generic import ( # pylint: disable=import-outside-toplevel
generic_get_sample_index,
gpu_multinomial_from_uniform,
)
prob, uniform_sample, sample_indices = call.args
tgt = self._get_target(call.ty)
dtype = call.attrs.dtype
_, prob_dtype = self.get_shape_dtype(prob)
sample_shape, sample_dtype = self.get_shape_dtype(uniform_sample)
sample_indices_shape, sample_indices_dtype = self.get_shape_dtype(sample_indices)
if len(sample_shape) != 2 or sample_shape[1] != 1:
raise ValueError("uniform_sample should be a 2D tensor with shape (N, 1)")
if len(sample_indices_shape) != 2 or sample_indices_shape[1] != 1:
raise ValueError("sample_indices should be a 2D tensor with shape (N, 1)")
if self.is_gpu_target(tgt):
gv = self.builder_.add_func(
gpu_multinomial_from_uniform(
prob_dtype, sample_dtype, sample_indices_dtype, dtype
),
"gpu_multinomial_from_uniform",
)
return relax.call_tir(
gv,
[prob, uniform_sample, sample_indices],
out_ty=call.ty,
)
else:
cumsum_prob = relax.op.cumsum(prob, axis=1, dtype=prob_dtype.dtype, exclusive=False)
gv = self.builder_.add_func(
generic_get_sample_index(prob_dtype, sample_dtype, sample_indices_dtype, dtype),
"get_sample_index",
)
return relax.call_tir(
gv,
[cumsum_prob, uniform_sample, sample_indices],
out_ty=call.ty,
)
return super().visit_call_(call)
@module_pass(opt_level=0, name="DispatchSampling")
class DispatchSampling:
"""Pass to dispatch scan and sort operators to platform dependent implementation."""
def transform_module(self, mod: IRModule, ctx: PassContext) -> IRModule:
sampling_dispatcher = SamplingDispatcher(mod)
for gv, func in mod.functions_items():
if isinstance(func, relax.Function):
func = sampling_dispatcher.visit_expr(func)
sampling_dispatcher.builder_.update_func(gv, func)
return sampling_dispatcher.builder_.finalize()