settings.py

# Copyright 2023 NVIDIA Corporation
#
# Licensed 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.
#
from __future__ import annotations

from legate.util.settings import PrioritizedSetting, Settings, convert_bool

__all__ = ("settings",)


class CunumericRuntimeSettings(Settings):
    test: PrioritizedSetting[bool] = PrioritizedSetting(
        "test",
        "CUNUMERIC_TEST",
        default=False,
        convert=convert_bool,
        help="""
        Enable test mode. In test mode, all cuNumeric ndarrays are managed by
        the distributed runtime and the NumPy fallback for small arrays is
        turned off.
        """,
    )

    preload_cudalibs: PrioritizedSetting[bool] = PrioritizedSetting(
        "preload_cudalibs",
        "CUNUMERIC_PRELOAD_CUDALIBS",
        default=False,
        convert=convert_bool,
        help="""
        Preload and initialize handles of all CUDA libraries (cuBLAS, cuSOLVER,
        etc.) used in cuNumeric
        """,
    )

    warn: PrioritizedSetting[bool] = PrioritizedSetting(
        "warn",
        "CUNUMERIC_WARN",
        default=False,
        convert=convert_bool,
        help="""
        Turn on warnings
        """,
    )

    attach_hack: PrioritizedSetting[bool] = PrioritizedSetting(
        "attach-hack",
        "CUNUMERIC_ATTACH_HACK",
        default=False,
        convert=convert_bool,
        help="""
        Enable the attach hack which avoids attaching in certain cases by doing
        direct writes. This may be needed for multi-node runs of some
        applications.
        """,
    )

    report_coverage: PrioritizedSetting[bool] = PrioritizedSetting(
        "report_coverage",
        "CUNUMERIC_REPORT_COVERAGE",
        default=False,
        convert=convert_bool,
        help="""
        Print an overall percentage of cunumeric coverage
        """,
    )

    report_dump_callstack: PrioritizedSetting[bool] = PrioritizedSetting(
        "report_dump_callstack",
        "CUNUMERIC_REPORT_DUMP_CALLSTACK",
        default=False,
        convert=convert_bool,
        help="""
        Print an overall percentage of cunumeric coverage with call stack info
        """,
    )

    report_dump_csv: PrioritizedSetting[str | None] = PrioritizedSetting(
        "report_dump_csv",
        "CUNUMERIC_REPORT_DUMP_CSV",
        default=None,
        help="""
        Save a coverage report to a specified CSV file
        """,
    )


settings = CunumericRuntimeSettings()