comm_config.py

# Copyright (c) 2023, NVIDIA CORPORATION.  All rights reserved.
#
# 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 nvflare.fuel.f3.drivers.net_utils import MAX_PAYLOAD_SIZE
from nvflare.fuel.utils.config import Config
from nvflare.fuel.utils.config_service import ConfigService

_comm_config_files = ["comm_config.json", "comm_config.json.default"]


DEFAULT_MAX_MSG_SIZE = MAX_PAYLOAD_SIZE


class VarName:

    MAX_MESSAGE_SIZE = "max_message_size"
    ALLOW_ADHOC_CONNS = "allow_adhoc_conns"
    ADHOC_CONN_SCHEME = "adhoc_conn_scheme"
    INTERNAL_CONN_SCHEME = "internal_conn_scheme"
    BACKBONE_CONN_GEN = "backbone_conn_gen"
    SUBNET_HEARTBEAT_INTERVAL = "subnet_heartbeat_interval"
    SUBNET_TROUBLE_THRESHOLD = "subnet_trouble_threshold"
    COMM_DRIVER_PATH = "comm_driver_path"
    HEARTBEAT_INTERVAL = "heartbeat_interval"
    USE_AIO_GRPC_VAR_NAME = "use_aio_grpc"
    STREAMING_CHUNK_SIZE = "streaming_chunk_size"
    STREAMING_ACK_WAIT = "streaming_ack_wait"
    STREAMING_WINDOW_SIZE = "streaming_window_size"
    STREAMING_ACK_INTERVAL = "streaming_ack_interval"
    STREAMING_MAX_OUT_SEQ_CHUNKS = "streaming_max_out_seq_chunks"
    STREAMING_READ_TIMEOUT = "streaming_read_timeout"
    STREAMING_SEND_TIMEOUT = "streaming_send_timeout"
    STREAMING_ACK_PROGRESS_TIMEOUT = "streaming_ack_progress_timeout"
    STREAMING_ACK_PROGRESS_CHECK_INTERVAL = "streaming_ack_progress_check_interval"
    SFM_SEND_STALL_TIMEOUT = "sfm_send_stall_timeout"
    SFM_CLOSE_STALLED_CONNECTION = "sfm_close_stalled_connection"
    SFM_SEND_STALL_CONSECUTIVE_CHECKS = "sfm_send_stall_consecutive_checks"


class CommConfigurator:

    _config_loaded = False
    _configuration = None

    def __init__(self):
        # only load once!
        if not CommConfigurator._config_loaded:
            config: Config = ConfigService.load_configuration(file_basename=_comm_config_files[0])
            CommConfigurator._configuration = None if config is None else config.to_dict()
            CommConfigurator._config_loaded = True
        self.config = CommConfigurator._configuration

    @staticmethod
    def reset():
        """Reset the configurator to allow reloading config files.

        Returns:

        """
        CommConfigurator._config_loaded = False

    def get_config(self):
        return self.config

    def get_max_message_size(self):
        return ConfigService.get_int_var(VarName.MAX_MESSAGE_SIZE, self.config, default=DEFAULT_MAX_MSG_SIZE)

    def allow_adhoc_connections(self, default):
        return ConfigService.get_bool_var(VarName.ALLOW_ADHOC_CONNS, self.config, default=default)

    def get_adhoc_connection_scheme(self, default):
        return ConfigService.get_str_var(VarName.ADHOC_CONN_SCHEME, self.config, default=default)

    def get_internal_connection_scheme(self, default):
        return ConfigService.get_str_var(VarName.INTERNAL_CONN_SCHEME, self.config, default=default)

    def get_backbone_connection_generation(self, default):
        return ConfigService.get_int_var(VarName.BACKBONE_CONN_GEN, self.config, default=default)

    def get_subnet_heartbeat_interval(self, default):
        return ConfigService.get_int_var(VarName.SUBNET_HEARTBEAT_INTERVAL, self.config, default=default)

    def get_subnet_trouble_threshold(self, default):
        return ConfigService.get_int_var(VarName.SUBNET_TROUBLE_THRESHOLD, self.config, default=default)

    def get_comm_driver_path(self, default):
        return ConfigService.get_str_var(VarName.COMM_DRIVER_PATH, self.config, default=default)

    def get_heartbeat_interval(self, default):
        return ConfigService.get_int_var(VarName.HEARTBEAT_INTERVAL, self.config, default=default)

    def use_aio_grpc(self, default):
        return ConfigService.get_bool_var(VarName.USE_AIO_GRPC_VAR_NAME, self.config, default)

    def get_streaming_chunk_size(self, default):
        return ConfigService.get_int_var(VarName.STREAMING_CHUNK_SIZE, self.config, default=default)

    def get_streaming_ack_wait(self, default):
        return ConfigService.get_int_var(VarName.STREAMING_ACK_WAIT, self.config, default=default)

    def get_streaming_window_size(self, default):
        return ConfigService.get_int_var(VarName.STREAMING_WINDOW_SIZE, self.config, default=default)

    def get_streaming_ack_interval(self, default):
        return ConfigService.get_int_var(VarName.STREAMING_ACK_INTERVAL, self.config, default=default)

    def get_streaming_max_out_seq_chunks(self, default):
        return ConfigService.get_int_var(VarName.STREAMING_MAX_OUT_SEQ_CHUNKS, self.config, default=default)

    def get_streaming_read_timeout(self, default):
        return ConfigService.get_int_var(VarName.STREAMING_READ_TIMEOUT, self.config, default)

    def get_streaming_send_timeout(self, default):
        return ConfigService.get_float_var(VarName.STREAMING_SEND_TIMEOUT, self.config, default=default)

    def get_streaming_ack_progress_timeout(self, default):
        return ConfigService.get_float_var(VarName.STREAMING_ACK_PROGRESS_TIMEOUT, self.config, default=default)

    def get_streaming_ack_progress_check_interval(self, default):
        return ConfigService.get_float_var(VarName.STREAMING_ACK_PROGRESS_CHECK_INTERVAL, self.config, default=default)

    def get_sfm_send_stall_timeout(self, default):
        return ConfigService.get_float_var(VarName.SFM_SEND_STALL_TIMEOUT, self.config, default=default)

    def get_sfm_close_stalled_connection(self, default=False):
        return ConfigService.get_bool_var(VarName.SFM_CLOSE_STALLED_CONNECTION, self.config, default=default)

    def get_sfm_send_stall_consecutive_checks(self, default=3):
        return ConfigService.get_int_var(VarName.SFM_SEND_STALL_CONSECUTIVE_CHECKS, self.config, default=default)

    def get_int_var(self, name: str, default=None):
        return ConfigService.get_int_var(name, self.config, default=default)

    def get_float_var(self, name: str, default=None):
        return ConfigService.get_float_var(name, self.config, default=default)

    def get_bool_var(self, name: str, default=None):
        return ConfigService.get_bool_var(name, self.config, default=default)

    def get_str_var(self, name: str, default=None):
        return ConfigService.get_str_var(name, self.config, default=default)