gstaichi 2.1.1rc3__cp310-cp310-macosx_11_0_arm64.whl

gstaichi/lang/snode.py

@@ -0,0 +1,489 @@
+# type: ignore
+
+import numbers
+
+from gstaichi._lib import core as _ti_core
+from gstaichi._lib.core.gstaichi_python import (
+    Axis,
+    SNodeCxx,
+)
+from gstaichi.lang import expr, impl, matrix
+from gstaichi.lang.exception import GsTaichiRuntimeError
+from gstaichi.lang.field import BitpackedFields, Field
+from gstaichi.lang.util import get_traceback
+
+
+class SNode:
+    """A Python-side SNode wrapper.
+
+    For more information on GsTaichi's SNode system, please check out
+    these references:
+
+    * https://docs.taichi-lang.org/docs/sparse
+    * https://yuanming.gstaichi.graphics/publication/2019-gstaichi/gstaichi-lang.pdf
+
+    Arg:
+        ptr (pointer): The C++ side SNode pointer.
+    """
+
+    def __init__(self, ptr: SNodeCxx) -> None:
+        self.ptr = ptr
+
+    def dense(self, axes: list[Axis], dimensions: list[int] | int) -> "SNode":
+        """Adds a dense SNode as a child component of `self`.
+
+        Args:
+            axes (List[Axis]): Axes to activate.
+            dimensions (Union[List[int], int]): Shape of each axis.
+
+        Returns:
+            The added :class:`~gstaichi.lang.SNode` instance.
+        """
+        if isinstance(dimensions, numbers.Number):
+            dimensions = [dimensions] * len(axes)
+        return SNode(self.ptr.dense(axes, dimensions, _ti_core.DebugInfo(get_traceback())))
+
+    def pointer(self, axes: list[Axis], dimensions: list[int] | int) -> "SNode":
+        """Adds a pointer SNode as a child component of `self`.
+
+        Args:
+            axes (List[Axis]): Axes to activate.
+            dimensions (Union[List[int], int]): Shape of each axis.
+
+        Returns:
+            The added :class:`~gstaichi.lang.SNode` instance.
+        """
+        if not _ti_core.is_extension_supported(impl.current_cfg().arch, _ti_core.Extension.sparse):
+            raise GsTaichiRuntimeError("Pointer SNode is not supported on this backend.")
+        if isinstance(dimensions, numbers.Number):
+            dimensions = [dimensions] * len(axes)
+        return SNode(self.ptr.pointer(axes, dimensions, _ti_core.DebugInfo(get_traceback())))
+
+    @staticmethod
+    def _hash(axes, dimensions):
+        # original code is #def hash(self,axes, dimensions) without #@staticmethod   before fix pylint R0201
+        """Not supported."""
+        raise RuntimeError("hash not yet supported")
+        # if isinstance(dimensions, int):
+        #     dimensions = [dimensions] * len(axes)
+        # return SNode(self.ptr.hash(axes, dimensions))
+
+    def dynamic(self, axis: list[Axis], dimension: int, chunk_size: int | None = None) -> "SNode":
+        """Adds a dynamic SNode as a child component of `self`.
+
+        Args:
+            axis (List[Axis]): Axis to activate, must be 1.
+            dimension (int): Shape of the axis.
+            chunk_size (int): Chunk size.
+
+        Returns:
+            The added :class:`~gstaichi.lang.SNode` instance.
+        """
+        if not _ti_core.is_extension_supported(impl.current_cfg().arch, _ti_core.Extension.sparse):
+            raise GsTaichiRuntimeError("Dynamic SNode is not supported on this backend.")
+        assert len(axis) == 1
+        if chunk_size is None:
+            chunk_size = dimension
+        return SNode(self.ptr.dynamic(axis[0], dimension, chunk_size, _ti_core.DebugInfo(get_traceback())))
+
+    def bitmasked(self, axes: list[Axis], dimensions: list[int] | int) -> "SNode":
+        """Adds a bitmasked SNode as a child component of `self`.
+
+        Args:
+            axes (List[Axis]): Axes to activate.
+            dimensions (Union[List[int], int]): Shape of each axis.
+
+        Returns:
+            The added :class:`~gstaichi.lang.SNode` instance.
+        """
+        if not _ti_core.is_extension_supported(impl.current_cfg().arch, _ti_core.Extension.sparse):
+            raise GsTaichiRuntimeError("Bitmasked SNode is not supported on this backend.")
+        if isinstance(dimensions, numbers.Number):
+            dimensions = [dimensions] * len(axes)
+        return SNode(self.ptr.bitmasked(axes, dimensions, _ti_core.DebugInfo(get_traceback())))
+
+    def quant_array(self, axes: list[Axis], dimensions: list[int] | int, max_num_bits: int) -> "SNode":
+        """Adds a quant_array SNode as a child component of `self`.
+
+        Args:
+            axes (List[Axis]): Axes to activate.
+            dimensions (Union[List[int], int]): Shape of each axis.
+            max_num_bits (int): Maximum number of bits it can hold.
+
+        Returns:
+            The added :class:`~gstaichi.lang.SNode` instance.
+        """
+        if isinstance(dimensions, numbers.Number):
+            dimensions = [dimensions] * len(axes)
+        return SNode(self.ptr.quant_array(axes, dimensions, max_num_bits, _ti_core.DebugInfo(get_traceback())))
+
+    def place(self, *args, offset: numbers.Number | tuple[numbers.Number] | None = None) -> "SNode":
+        """Places a list of GsTaichi fields under the `self` container.
+
+        Args:
+            *args (List[ti.field]): A list of GsTaichi fields to place.
+            offset (Union[Number, tuple[Number]]): Offset of the field domain.
+
+        Returns:
+            The `self` container.
+        """
+        if offset is None:
+            offset = ()
+        if isinstance(offset, numbers.Number):
+            offset = (offset,)
+
+        for arg in args:
+            if isinstance(arg, BitpackedFields):
+                bit_struct_type = arg.bit_struct_type_builder.build()
+                bit_struct_snode = self.ptr.bit_struct(bit_struct_type, _ti_core.DebugInfo(get_traceback()))
+                for field, id_in_bit_struct in arg.fields:
+                    bit_struct_snode.place(field, offset, id_in_bit_struct)
+            elif isinstance(arg, Field):
+                for var in arg._get_field_members():
+                    self.ptr.place(var.ptr, offset, -1)
+            elif isinstance(arg, list):
+                for x in arg:
+                    self.place(x, offset=offset)
+            else:
+                raise ValueError(f"{arg} cannot be placed")
+        return self
+
+    def lazy_grad(self):
+        """Automatically place the adjoint fields following the layout of their primal fields.
+
+        Users don't need to specify ``needs_grad`` when they define scalar/vector/matrix fields (primal fields) using autodiff.
+        When all the primal fields are defined, using ``gstaichi.root.lazy_grad()`` could automatically generate
+        their corresponding adjoint fields (gradient field).
+
+        To know more details about primal, adjoint fields and ``lazy_grad()``,
+        please see Page 4 and Page 13-14 of DiffGsTaichi Paper: https://arxiv.org/pdf/1910.00935.pdf
+        """
+        self.ptr.lazy_grad()
+
+    def lazy_dual(self):
+        """Automatically place the dual fields following the layout of their primal fields."""
+        self.ptr.lazy_dual()
+
+    def _allocate_adjoint_checkbit(self):
+        """Automatically place the adjoint flag fields following the layout of their primal fields for global data access rule checker"""
+        self.ptr.allocate_adjoint_checkbit()
+
+    def parent(self, n=1):
+        """Gets an ancestor of `self` in the SNode tree.
+
+        Args:
+            n (int): the number of levels going up from `self`.
+
+        Returns:
+            Union[None, _Root, SNode]: The n-th parent of `self`.
+        """
+        p = self.ptr
+        while p and n > 0:
+            p = p.parent
+            n -= 1
+        if p is None:
+            return None
+
+        if p.type == _ti_core.SNodeType.root:
+            return impl.root
+
+        return SNode(p)
+
+    def _path_from_root(self):
+        """Gets the path from root to `self` in the SNode tree.
+
+        Returns:
+            List[Union[_Root, SNode]]: The list of SNodes on the path from root to `self`.
+        """
+        p = self
+        res = [p]
+        while p != impl.root:
+            p = p.parent()
+            res.append(p)
+        res.reverse()
+        return res
+
+    @property
+    def _dtype(self):
+        """Gets the data type of `self`.
+
+        Returns:
+            DataType: The data type of `self`.
+        """
+        return self.ptr.data_type()
+
+    @property
+    def _id(self):
+        """Gets the id of `self`.
+
+        Returns:
+            int: The id of `self`.
+        """
+        return self.ptr.id
+
+    @property
+    def _snode_tree_id(self):
+        return self.ptr.get_snode_tree_id()
+
+    @property
+    def shape(self):
+        """Gets the number of elements from root in each axis of `self`.
+
+        Returns:
+            Tuple[int]: The number of elements from root in each axis of `self`.
+        """
+        dim = self.ptr.num_active_indices()
+        ret = tuple(self.ptr.get_shape_along_axis(i) for i in range(dim))
+
+        return ret
+
+    def _loop_range(self):
+        """Gets the gstaichi_python.SNode to serve as loop range.
+
+        Returns:
+            gstaichi_python.SNode: See above.
+        """
+        return self.ptr
+
+    @property
+    def _name(self):
+        """Gets the name of `self`.
+
+        Returns:
+            str: The name of `self`.
+        """
+        return self.ptr.name()
+
+    @property
+    def _snode(self):
+        """Gets `self`.
+        Returns:
+            SNode: `self`.
+        """
+        return self
+
+    def _get_children(self):
+        """Gets all children components of `self`.
+
+        Returns:
+            List[SNode]: All children components of `self`.
+        """
+        children = []
+        for i in range(self.ptr.get_num_ch()):
+            children.append(SNode(self.ptr.get_ch(i)))
+        return children
+
+    @property
+    def _num_dynamically_allocated(self):
+        runtime = impl.get_runtime()
+        runtime.materialize_root_fb(False)
+        return runtime.prog.get_snode_num_dynamically_allocated(self.ptr)
+
+    @property
+    def _cell_size_bytes(self):
+        impl.get_runtime().materialize_root_fb(False)
+        return self.ptr.cell_size_bytes
+
+    @property
+    def _offset_bytes_in_parent_cell(self):
+        impl.get_runtime().materialize_root_fb(False)
+        return self.ptr.offset_bytes_in_parent_cell
+
+    def deactivate_all(self):
+        """Recursively deactivate all children components of `self`."""
+        ch = self._get_children()
+        for c in ch:
+            c.deactivate_all()
+        SNodeType = _ti_core.SNodeType
+        if self.ptr.type == SNodeType.pointer or self.ptr.type == SNodeType.bitmasked:
+            from gstaichi._kernels import snode_deactivate  # pylint: disable=C0415
+
+            snode_deactivate(self)
+        if self.ptr.type == SNodeType.dynamic:
+            # Note that dynamic nodes are different from other sparse nodes:
+            # instead of deactivating each element, we only need to deactivate
+            # its parent, whose linked list of chunks of elements will be deleted.
+            from gstaichi._kernels import (  # pylint: disable=C0415
+                snode_deactivate_dynamic,
+            )
+
+            snode_deactivate_dynamic(self)
+
+    def __repr__(self):
+        type_ = str(self.ptr.type)[len("SNodeType.") :]
+        return f"<ti.SNode of type {type_}>"
+
+    def __str__(self):
+        # ti.root.dense(ti.i, 3).dense(ti.jk, (4, 5)).place(x)
+        # ti.root => dense [3] => dense [3, 4, 5] => place [3, 4, 5]
+        type_ = str(self.ptr.type)[len("SNodeType.") :]
+        shape = str(list(self.shape))
+        parent = str(self.parent())
+        return f"{parent} => {type_} {shape}"
+
+    def __eq__(self, other):
+        return self.ptr == other.ptr
+
+    def _physical_index_position(self):
+        """Gets mappings from virtual axes to physical axes.
+
+        Returns:
+            Dict[int, int]: Mappings from virtual axes to physical axes.
+        """
+        ret = {}
+        for virtual, physical in enumerate(self.ptr.get_physical_index_position()):
+            if physical != -1:
+                ret[virtual] = physical
+        return ret
+
+
+def rescale_index(a, b, I):
+    """Rescales the index 'I' of field (or SNode) 'a' to match the shape of SNode 'b'.
+
+    Args:
+
+        a, b (Union[:class:`~gstaichi.Field`, :class:`~gstaichi.MatrixField`): Input gstaichi fields or snodes.
+        I (Union[list, :class:`~gstaichi.Vector`]): grouped loop index.
+
+    Returns:
+        Ib (:class:`~gstaichi.Vector`): rescaled grouped loop index
+    """
+
+    assert isinstance(a, (Field, SNode)), "The first argument must be a field or an SNode"
+    assert isinstance(b, (Field, SNode)), "The second argument must be a field or an SNode"
+    if isinstance(I, list):
+        n = len(I)
+    else:
+        assert isinstance(
+            I, (expr.Expr, matrix.Matrix)
+        ), "The third argument must be an index (list, ti.Vector, or Expr with TensorType)"
+        n = I.n
+
+    from gstaichi.lang.kernel_impl import pyfunc  # pylint: disable=C0415
+
+    @pyfunc
+    def _rescale_index():
+        result = matrix.Vector([I[i] for i in range(n)])
+        for i in impl.static(range(min(n, min(len(a.shape), len(b.shape))))):
+            if a.shape[i] > b.shape[i]:
+                result[i] = I[i] // (a.shape[i] // b.shape[i])
+            if a.shape[i] < b.shape[i]:
+                result[i] = I[i] * (b.shape[i] // a.shape[i])
+        return result
+
+    return _rescale_index()
+
+
+def append(node, indices, val):
+    """Append a value `val` to a SNode `node` at index `indices`.
+
+    Args:
+        node (:class:`~gstaichi.SNode`): Input SNode.
+        indices (Union[int, :class:`~gstaichi.Vector`]): the indices to visit.
+        val (Union[:mod:`~gstaichi.types.primitive_types`, :mod:`~gstaichi.types.compound_types`]): the data to be appended.
+    """
+    ptrs = expr._get_flattened_ptrs(val)
+    append_expr = expr.Expr(
+        impl.get_runtime()
+        .compiling_callable.ast_builder()
+        .expr_snode_append(node._snode.ptr, expr.make_expr_group(indices), ptrs),
+        dbg_info=_ti_core.DebugInfo(impl.get_runtime().get_current_src_info()),
+    )
+    a = impl.expr_init(append_expr)
+    return a
+
+
+def is_active(node, indices):
+    """Explicitly query whether a cell in a SNode `node` at location
+    `indices` is active or not.
+
+    Args:
+        node (:class:`~gstaichi.SNode`): Must be a pointer, hash or bitmasked node.
+        indices (Union[int, list, :class:`~gstaichi.Vector`]): the indices to visit.
+
+    Returns:
+        bool: the cell `node[indices]` is active or not.
+    """
+    return expr.Expr(
+        impl.get_runtime()
+        .compiling_callable.ast_builder()
+        .expr_snode_is_active(node._snode.ptr, expr.make_expr_group(indices)),
+        dbg_info=_ti_core.DebugInfo(impl.get_runtime().get_current_src_info()),
+    )
+
+
+def activate(node, indices):
+    """Explicitly activate a cell of `node` at location `indices`.
+
+    Args:
+        node (:class:`~gstaichi.SNode`): Must be a pointer, hash or bitmasked node.
+        indices (Union[int, :class:`~gstaichi.Vector`]): the indices to activate.
+    """
+    impl.get_runtime().compiling_callable.ast_builder().insert_activate(
+        node._snode.ptr, expr.make_expr_group(indices), _ti_core.DebugInfo(impl.get_runtime().get_current_src_info())
+    )
+
+
+def deactivate(node, indices):
+    """Explicitly deactivate a cell of `node` at location `indices`.
+
+    After deactivation, the GsTaichi runtime automatically recycles and zero-fills
+    the memory of the deactivated cell.
+
+    Args:
+        node (:class:`~gstaichi.SNode`): Must be a pointer, hash or bitmasked node.
+        indices (Union[int, :class:`~gstaichi.Vector`]): the indices to deactivate.
+    """
+    impl.get_runtime().compiling_callable.ast_builder().insert_deactivate(
+        node._snode.ptr, expr.make_expr_group(indices), _ti_core.DebugInfo(impl.get_runtime().get_current_src_info())
+    )
+
+
+def length(node, indices):
+    """Return the length of the dynamic SNode `node` at index `indices`.
+
+    Args:
+        node (:class:`~gstaichi.SNode`): a dynamic SNode.
+        indices (Union[int, :class:`~gstaichi.Vector`]): the indices to query.
+
+    Returns:
+        int: the length of cell `node[indices]`.
+    """
+    return expr.Expr(
+        impl.get_runtime()
+        .compiling_callable.ast_builder()
+        .expr_snode_length(node._snode.ptr, expr.make_expr_group(indices)),
+        dbg_info=_ti_core.DebugInfo(impl.get_runtime().get_current_src_info()),
+    )
+
+
+def get_addr(f, indices):
+    """Query the memory address (on CUDA/x64) of field `f` at index `indices`.
+
+    Currently, this function can only be called inside a gstaichi kernel.
+
+    Args:
+        f (Union[:class:`~gstaichi.Field`, :class:`~gstaichi.MatrixField`]): Input gstaichi field for memory address query.
+        indices (Union[int, :class:`~gstaichi.Vector`]): The specified field indices of the query.
+
+    Returns:
+        ti.u64: The memory address of `f[indices]`.
+    """
+    return expr.Expr(
+        impl.get_runtime()
+        .compiling_callable.ast_builder()
+        .expr_snode_get_addr(f._snode.ptr, expr.make_expr_group(indices)),
+        dbg_info=_ti_core.DebugInfo(impl.get_runtime().get_current_src_info()),
+    )
+
+
+__all__ = [
+    "activate",
+    "append",
+    "deactivate",
+    "get_addr",
+    "is_active",
+    "length",
+    "rescale_index",
+    "SNode",
+]

gstaichi/lang/source_builder.py

@@ -0,0 +1,150 @@
+# type: ignore
+
+import atexit
+import ctypes
+import os
+import shutil
+import subprocess
+import tempfile
+
+from gstaichi._lib import core as _ti_core
+from gstaichi.lang import impl
+from gstaichi.lang.exception import GsTaichiSyntaxError
+from gstaichi.lang.expr import make_expr_group
+from gstaichi.lang.util import get_clangpp
+
+
+class SourceBuilder:
+    def __init__(self):
+        self.bc = None
+        self.so = None
+        self.mode = None
+        self.td = None
+
+        def cleanup():
+            if self.td is not None:
+                shutil.rmtree(self.td)
+
+        atexit.register(cleanup)
+
+    @classmethod
+    def from_file(cls, filename, compile_fn=None, _temp_dir=None):
+        self = cls()
+        self.td = _temp_dir
+        if self.td is None:
+            self.td = tempfile.mkdtemp()
+
+        if filename.endswith((".cpp", ".c", ".cc")):
+            if impl.current_cfg().arch not in [_ti_core.Arch.x64, _ti_core.Arch.cuda]:
+                raise GsTaichiSyntaxError("Unsupported arch for external function call")
+            if compile_fn is None:
+
+                def compile_fn_impl(filename):
+                    if impl.current_cfg().arch == _ti_core.Arch.x64:
+                        subprocess.call(
+                            get_clangpp() + " -flto -c " + filename + " -o " + os.path.join(self.td, "source.bc"),
+                            shell=True,
+                        )
+                    else:
+                        subprocess.call(
+                            get_clangpp()
+                            + " -flto -c "
+                            + filename
+                            + " -o "
+                            + os.path.join(self.td, "source.bc")
+                            + " -target nvptx64-nvidia-cuda",
+                            shell=True,
+                        )
+                    return os.path.join(self.td, "source.bc")
+
+                compile_fn = compile_fn_impl
+            self.bc = compile_fn(filename)
+            self.mode = "bc"
+        elif filename.endswith(".cu"):
+            if impl.current_cfg().arch not in [_ti_core.Arch.cuda]:
+                raise GsTaichiSyntaxError("Unsupported arch for external function call")
+            if compile_fn is None:
+                shutil.copy(filename, os.path.join(self.td, "source.cu"))
+
+                def compile_fn_impl(filename):
+                    # Cannot use -o to specify multiple output files
+                    subprocess.call(
+                        get_clangpp()
+                        + " "
+                        + os.path.join(self.td, "source.cu")
+                        + " -c -emit-llvm -std=c++17 --cuda-gpu-arch=sm_50 -nocudalib",
+                        cwd=self.td,
+                        shell=True,
+                    )
+                    return os.path.join(self.td, "source-cuda-nvptx64-nvidia-cuda-sm_50.bc")
+
+                compile_fn = compile_fn_impl
+            self.bc = compile_fn(filename)
+            self.mode = "bc"
+        elif filename.endswith((".so", ".dylib", ".dll")):
+            if impl.current_cfg().arch not in [_ti_core.Arch.x64]:
+                raise GsTaichiSyntaxError("Unsupported arch for external function call")
+            self.so = ctypes.CDLL(filename)
+            self.mode = "so"
+        elif filename.endswith(".ll"):
+            if impl.current_cfg().arch not in [_ti_core.Arch.x64, _ti_core.Arch.cuda]:
+                raise GsTaichiSyntaxError("Unsupported arch for external function call")
+            subprocess.call(
+                "llvm-as " + filename + " -o " + os.path.join(self.td, "source.bc"),
+                shell=True,
+            )
+            self.bc = os.path.join(self.td, "source.bc")
+            self.mode = "bc"
+        elif filename.endswith(".bc"):
+            if impl.current_cfg().arch not in [_ti_core.Arch.x64, _ti_core.Arch.cuda]:
+                raise GsTaichiSyntaxError("Unsupported arch for external function call")
+            self.bc = filename
+            self.mode = "bc"
+        else:
+            raise GsTaichiSyntaxError("Unsupported file type for external function call.")
+        return self
+
+    @classmethod
+    def from_source(cls, source_code, compile_fn=None):
+        if impl.current_cfg().arch not in [_ti_core.Arch.x64, _ti_core.Arch.cuda]:
+            raise GsTaichiSyntaxError("Unsupported arch for external function call")
+        _temp_dir = tempfile.mkdtemp()
+        _temp_source = os.path.join(_temp_dir, "_temp_source.cpp")
+        with open(_temp_source, "w") as f:
+            f.write(source_code)
+        return SourceBuilder.from_file(_temp_source, compile_fn, _temp_dir)
+
+    def __getattr__(self, item):
+        def bitcode_func_call_wrapper(*args):
+            impl.get_runtime().compiling_callable.ast_builder().insert_external_func_call(
+                0,
+                "",
+                self.bc,
+                item,
+                make_expr_group(args),
+                make_expr_group([]),
+                _ti_core.DebugInfo(impl.get_runtime().get_current_src_info()),
+            )
+
+        if self.mode == "bc":
+            return bitcode_func_call_wrapper
+
+        def external_func_call_wrapper(args=[], outputs=[]):
+            func_addr = ctypes.cast(self.so.__getattr__(item), ctypes.c_void_p).value
+            impl.get_runtime().compiling_callable.ast_builder().insert_external_func_call(
+                func_addr,
+                "",
+                "",
+                "",
+                make_expr_group(args),
+                make_expr_group(outputs),
+                _ti_core.DebugInfo(impl.get_runtime().get_current_src_info()),
+            )
+
+        if self.mode == "so":
+            return external_func_call_wrapper
+
+        raise GsTaichiSyntaxError("Error occurs when calling external function.")
+
+
+__all__ = []