nova/nova/utils.py

# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# Copyright 2011 Justin Santa Barbara
# 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.

"""Utilities and helper functions."""
import contextlib
import datetime
import functools
import hashlib
import inspect
import multiprocessing
import os
import random
import re
import shutil
import tempfile
import time

from eventlet import tpool
import futurist
from keystoneauth1 import loading as ks_loading
import netaddr
from openstack import connection
from openstack import exceptions as sdk_exc
import os_resource_classes as orc
from os_service_types import service_types
from oslo_concurrency import lockutils
from oslo_concurrency import processutils
from oslo_context import context as common_context
from oslo_log import log as logging
from oslo_utils import encodeutils
from oslo_utils import importutils
from oslo_utils import strutils
from oslo_utils import timeutils

import nova.conf
from nova import exception
from nova.i18n import _
from nova import safe_utils

profiler = importutils.try_import('osprofiler.profiler')


CONF = nova.conf.CONF

LOG = logging.getLogger(__name__)

synchronized = lockutils.synchronized_with_prefix('nova-')
NOVA_FAIR_LOCKS = lockutils.FairLocks()

SM_IMAGE_PROP_PREFIX = "image_"
SM_INHERITABLE_KEYS = (
    'min_ram', 'min_disk', 'disk_format', 'container_format',
)
# Keys which hold large structured data that won't fit in the
# size constraints of the system_metadata table, so we avoid
# storing and/or loading them.
SM_SKIP_KEYS = (
    # Legacy names
    'mappings', 'block_device_mapping',
    # Modern names
    'img_mappings', 'img_block_device_mapping',
)

_FILE_CACHE = {}

_SERVICE_TYPES = service_types.ServiceTypes()

DEFAULT_EXECUTOR = None


def cooperative_yield():
    # TODO(ksambor) Remove all cooperative_yield calls after dropping Eventlet
    #  support.
    if not concurrency_mode_threading():
        time.sleep(0)  # noqa: N374


def destroy_default_executor():
    """Closes the executor and resets the global to None to allow forked worker
    processes to properly init it.
    """
    global DEFAULT_EXECUTOR
    if DEFAULT_EXECUTOR:
        LOG.info(
            "The default thread pool %s is shutting down",
            DEFAULT_EXECUTOR.name)
        DEFAULT_EXECUTOR.shutdown()
        LOG.info(
            "The default thread pool %s is closed", DEFAULT_EXECUTOR.name)

    DEFAULT_EXECUTOR = None


def create_executor(max_workers):
    if concurrency_mode_threading():
        executor = futurist.ThreadPoolExecutor(max_workers)
    else:
        executor = futurist.GreenThreadPoolExecutor(max_workers)
    return executor


def _get_default_executor():
    global DEFAULT_EXECUTOR

    if not DEFAULT_EXECUTOR:
        max_workers = (
            CONF.default_thread_pool_size if concurrency_mode_threading()
            else CONF.default_green_pool_size
            )
        DEFAULT_EXECUTOR = create_executor(max_workers)
        pname = multiprocessing.current_process().name
        executor_name = f"{pname}.default"
        DEFAULT_EXECUTOR.name = executor_name

        LOG.info("The default thread pool %s is initialized", executor_name)

    return DEFAULT_EXECUTOR


# NOTE(mikal): this seems to have to stay for now to handle os-brick
# requirements. This makes me a sad panda.
def get_root_helper():
    if CONF.workarounds.disable_rootwrap:
        cmd = 'sudo'
    else:
        cmd = 'sudo nova-rootwrap %s' % CONF.rootwrap_config
    return cmd


def ssh_execute(dest, *cmd, **kwargs):
    """Convenience wrapper to execute ssh command."""
    ssh_cmd = ['ssh', '-o', 'BatchMode=yes']
    ssh_cmd.append(dest)
    ssh_cmd.extend(cmd)
    return processutils.execute(*ssh_cmd, **kwargs)


def generate_uid(topic, size=8):
    random_string = generate_random_string(size)
    return '%s-%s' % (topic, random_string)


def generate_random_string(size=8):
    characters = '01234567890abcdefghijklmnopqrstuvwxyz'
    return ''.join([random.choice(characters) for _x in range(size)])


# Default symbols to use for passwords. Avoids visually confusing characters.
# ~6 bits per symbol
DEFAULT_PASSWORD_SYMBOLS = ('23456789',  # Removed: 0,1
                            'ABCDEFGHJKLMNPQRSTUVWXYZ',   # Removed: I, O
                            'abcdefghijkmnopqrstuvwxyz')  # Removed: l


def last_completed_audit_period(unit=None, before=None):
    """This method gives you the most recently *completed* audit period.

    arguments:
            units: string, one of 'hour', 'day', 'month', 'year'
                    Periods normally begin at the beginning (UTC) of the
                    period unit (So a 'day' period begins at midnight UTC,
                    a 'month' unit on the 1st, a 'year' on Jan, 1)
                    unit string may be appended with an optional offset
                    like so:  'day@18'  This will begin the period at 18:00
                    UTC.  'month@15' starts a monthly period on the 15th,
                    and year@3 begins a yearly one on March 1st.
            before: Give the audit period most recently completed before
                    <timestamp>. Defaults to now.


    returns:  2 tuple of datetimes (begin, end)
              The begin timestamp of this audit period is the same as the
              end of the previous.
    """
    if not unit:
        unit = CONF.instance_usage_audit_period

    offset = 0
    if '@' in unit:
        unit, offset = unit.split("@", 1)
        offset = int(offset)

    if before is not None:
        rightnow = before
    else:
        rightnow = timeutils.utcnow()
    if unit == 'month':
        if offset == 0:
            offset = 1
        end = datetime.datetime(day=offset,
                                month=rightnow.month,
                                year=rightnow.year)
        if end >= rightnow:
            year = rightnow.year
            if 1 >= rightnow.month:
                year -= 1
                month = 12 + (rightnow.month - 1)
            else:
                month = rightnow.month - 1
            end = datetime.datetime(day=offset,
                                    month=month,
                                    year=year)
        year = end.year
        if 1 >= end.month:
            year -= 1
            month = 12 + (end.month - 1)
        else:
            month = end.month - 1
        begin = datetime.datetime(day=offset, month=month, year=year)

    elif unit == 'year':
        if offset == 0:
            offset = 1
        end = datetime.datetime(day=1, month=offset, year=rightnow.year)
        if end >= rightnow:
            end = datetime.datetime(day=1,
                                    month=offset,
                                    year=rightnow.year - 1)
            begin = datetime.datetime(day=1,
                                      month=offset,
                                      year=rightnow.year - 2)
        else:
            begin = datetime.datetime(day=1,
                                      month=offset,
                                      year=rightnow.year - 1)

    elif unit == 'day':
        end = datetime.datetime(hour=offset,
                               day=rightnow.day,
                               month=rightnow.month,
                               year=rightnow.year)
        if end >= rightnow:
            end = end - datetime.timedelta(days=1)
        begin = end - datetime.timedelta(days=1)

    else:  # unit == 'hour'
        end = rightnow.replace(minute=offset, second=0, microsecond=0)
        if end >= rightnow:
            end = end - datetime.timedelta(hours=1)
        begin = end - datetime.timedelta(hours=1)

    return (begin, end)


def generate_password(length=None, symbolgroups=DEFAULT_PASSWORD_SYMBOLS):
    """Generate a random password from the supplied symbol groups.

    At least one symbol from each group will be included. Unpredictable
    results if length is less than the number of symbol groups.

    Believed to be reasonably secure (with a reasonable password length!)

    """
    if length is None:
        length = CONF.password_length

    r = random.SystemRandom()

    # NOTE(jerdfelt): Some password policies require at least one character
    # from each group of symbols, so start off with one random character
    # from each symbol group
    password = [r.choice(s) for s in symbolgroups]
    # If length < len(symbolgroups), the leading characters will only
    # be from the first length groups. Try our best to not be predictable
    # by shuffling and then truncating.
    r.shuffle(password)
    password = password[:length]
    length -= len(password)

    # then fill with random characters from all symbol groups
    symbols = ''.join(symbolgroups)
    password.extend([r.choice(symbols) for _i in range(length)])

    # finally shuffle to ensure first x characters aren't from a
    # predictable group
    r.shuffle(password)

    return ''.join(password)


def parse_server_string(server_str):
    """Parses the given server_string and returns a tuple of host and port.
    If it's not a combination of host part and port, the port element
    is an empty string. If the input is invalid expression, return a tuple of
    two empty strings.
    """
    try:
        # First of all, exclude pure IPv6 address (w/o port).
        if netaddr.valid_ipv6(server_str):
            return (server_str, '')

        # Next, check if this is IPv6 address with a port number combination.
        if server_str.find("]:") != -1:
            (address, port) = server_str.replace('[', '', 1).split(']:')
            return (address, port)

        # Third, check if this is a combination of an address and a port
        if server_str.find(':') == -1:
            return (server_str, '')

        # This must be a combination of an address and a port
        (address, port) = server_str.split(':')
        return (address, port)

    except (ValueError, netaddr.AddrFormatError):
        LOG.error('Invalid server_string: %s', server_str)
        return ('', '')


def get_shortened_ipv6(address):
    addr = netaddr.IPAddress(address, version=6)
    return str(addr.ipv6())


def get_shortened_ipv6_cidr(address):
    net = netaddr.IPNetwork(address, version=6)
    return str(net.cidr)


def safe_ip_format(ip):
    """Transform ip string to "safe" format.

    Will return ipv4 addresses unchanged, but will nest ipv6 addresses
    inside square brackets.
    """
    try:
        if netaddr.IPAddress(ip).version == 6:
            return '[%s]' % ip
    except (TypeError, netaddr.AddrFormatError):  # hostname
        pass
    # it's IPv4 or hostname
    return ip


def format_remote_path(host, path):
    """Returns remote path in format acceptable for scp/rsync.

    If host is IPv6 address literal, return '[host]:path', otherwise
    'host:path' is returned.

    If host is None, only path is returned.
    """
    if host is None:
        return path

    return "%s:%s" % (safe_ip_format(host), path)


def sanitize_hostname(hostname, default_name=None):
    """Sanitize a given hostname.

    Return a hostname which conforms to RFC-952 and RFC-1123 specs except the
    length of hostname. Window, Linux, and dnsmasq has different limitation:

    - Windows: 255 (net_bios limits to 15, but window will truncate it)
    - Linux: 64
    - dnsmasq: 63

    We choose the lowest of these (so 63).
    """

    def truncate_hostname(name):
        if len(name) > 63:
            LOG.warning("Hostname %(hostname)s is longer than 63, "
                        "truncate it to %(truncated_name)s",
                        {'hostname': name, 'truncated_name': name[:63]})
        return name[:63]

    if isinstance(hostname, str):
        # Remove characters outside the Unicode range U+0000-U+00FF
        hostname = hostname.encode('latin-1', 'ignore').decode('latin-1')

    hostname = truncate_hostname(hostname)
    hostname = re.sub(r'[ _\.]', '-', hostname)
    hostname = re.sub(r'[^\w.-]+', '', hostname)
    hostname = hostname.lower()
    hostname = hostname.strip('.-')
    # NOTE(eliqiao): set hostname to default_display_name to avoid
    # empty hostname
    if hostname == "" and default_name is not None:
        return truncate_hostname(default_name)
    return hostname


@contextlib.contextmanager
def temporary_mutation(obj, **kwargs):
    """Temporarily set the attr on a particular object to a given value then
    revert when finished.

    One use of this is to temporarily set the read_deleted flag on a context
    object:

        with temporary_mutation(context, read_deleted="yes"):
            do_something_that_needed_deleted_objects()
    """
    def is_dict_like(thing):
        return hasattr(thing, 'has_key') or isinstance(thing, dict)

    def get(thing, attr, default):
        if is_dict_like(thing):
            return thing.get(attr, default)
        else:
            return getattr(thing, attr, default)

    def set_value(thing, attr, val):
        if is_dict_like(thing):
            thing[attr] = val
        else:
            setattr(thing, attr, val)

    def delete(thing, attr):
        if is_dict_like(thing):
            del thing[attr]
        else:
            delattr(thing, attr)

    NOT_PRESENT = object()

    old_values = {}
    for attr, new_value in kwargs.items():
        old_values[attr] = get(obj, attr, NOT_PRESENT)
        set_value(obj, attr, new_value)

    try:
        yield
    finally:
        for attr, old_value in old_values.items():
            if old_value is NOT_PRESENT:
                delete(obj, attr)
            else:
                set_value(obj, attr, old_value)


@contextlib.contextmanager
def tempdir(**kwargs):
    argdict = kwargs.copy()
    if 'dir' not in argdict:
        argdict['dir'] = CONF.tempdir
    tmpdir = tempfile.mkdtemp(**argdict)
    try:
        yield tmpdir
    finally:
        try:
            shutil.rmtree(tmpdir)
        except OSError as e:
            LOG.error('Could not remove tmpdir: %s', e)


def metadata_to_dict(metadata, include_deleted=False):
    result = {}
    for item in metadata:
        if not include_deleted and item.get('deleted'):
            continue
        result[item['key']] = item['value']
    return result


def dict_to_metadata(metadata):
    result = []
    for key, value in metadata.items():
        result.append(dict(key=key, value=value))
    return result


def instance_meta(instance):
    if isinstance(instance['metadata'], dict):
        return instance['metadata']
    else:
        return metadata_to_dict(instance['metadata'])


# TODO(stephenfin): Instance.system_metadata is always a dict now (thanks,
# o.vo) so this check (and the function as a whole) can be removed
def instance_sys_meta(instance):
    if not instance.get('system_metadata'):
        return {}
    if isinstance(instance['system_metadata'], dict):
        return instance['system_metadata']
    else:
        return metadata_to_dict(instance['system_metadata'],
                                include_deleted=True)


def expects_func_args(*args):
    def _decorator_checker(dec):
        @functools.wraps(dec)
        def _decorator(f):
            base_f = safe_utils.get_wrapped_function(f)
            argspec = inspect.getfullargspec(base_f)
            if argspec[1] or argspec[2] or set(args) <= set(argspec[0]):
                # NOTE (ndipanov): We can't really tell if correct stuff will
                # be passed if it's a function with *args or **kwargs so
                # we still carry on and hope for the best
                return dec(f)
            else:
                raise TypeError("Decorated function %(f_name)s does not "
                                "have the arguments expected by the "
                                "decorator %(d_name)s" %
                                {'f_name': base_f.__name__,
                                 'd_name': dec.__name__})
        return _decorator
    return _decorator_checker


def check_string_length(value, name=None, min_length=0, max_length=None):
    """Check the length of specified string
    :param value: the value of the string
    :param name: the name of the string
    :param min_length: the min_length of the string
    :param max_length: the max_length of the string
    """
    try:
        strutils.check_string_length(value, name=name,
                                     min_length=min_length,
                                     max_length=max_length)
    except (ValueError, TypeError) as exc:
        raise exception.InvalidInput(message=exc.args[0])


def validate_integer(value, name, min_value=None, max_value=None):
    """Make sure that value is a valid integer, potentially within range.

    :param value: value of the integer
    :param name: name of the integer
    :param min_value: min_value of the integer
    :param max_value: max_value of the integer
    :returns: integer
    :raise: InvalidInput If value is not a valid integer
    """
    try:
        return strutils.validate_integer(value, name, min_value, max_value)
    except ValueError as e:
        raise exception.InvalidInput(reason=str(e))


def _serialize_profile_info():
    if not profiler:
        return None
    prof = profiler.get()
    trace_info = None
    if prof:
        # FIXME(DinaBelova): we'll add profiler.get_info() method
        # to extract this info -> we'll need to update these lines
        trace_info = {
            "hmac_key": prof.hmac_key,
            "base_id": prof.get_base_id(),
            "parent_id": prof.get_id()
        }
    return trace_info


def _pass_context(runner, func, *args, **kwargs):
    """Generalised passthrough method
    It will grab the context from the threadlocal store and add it to
    the store on the runner.  This allows for continuity in logging the
    context when using this method to spawn a new thread through the
    runner function
    """

    _context = common_context.get_current()
    profiler_info = _serialize_profile_info()

    @functools.wraps(func)
    def context_wrapper(*args, **kwargs):
        # NOTE: If update_store is not called after spawning a thread, it won't
        # be available for the logger to pull from threadlocal storage.
        if _context is not None:
            _context.update_store()
        if profiler_info and profiler:
            profiler.init(**profiler_info)
        return func(*args, **kwargs)

    return runner(context_wrapper, *args, **kwargs)


def spawn(func, *args, **kwargs) -> futurist.Future:
    """Passthrough method for eventlet.spawn.

    This utility exists so that it can be stubbed for testing without
    interfering with the service spawns.

    It will also grab the context from the threadlocal store and add it to
    the store on the new thread.  This allows for continuity in logging the
    context when using this method to spawn a new thread.
    """

    return spawn_on(_get_default_executor(), func, *args, **kwargs)


def _executor_is_full(executor):
    if concurrency_mode_threading():
        # TODO(gibi): Move this whole logic to futurist ThreadPoolExecutor
        # so that we can avoid accessing the internals of the executor
        with executor._shutdown_lock:
            idle_workers = len([w for w in executor._workers if w.idle]) > 0
            queued_tasks = executor._work_queue.qsize() > 0
            return queued_tasks and not idle_workers

    return False


def spawn_on(executor, func, *args, **kwargs) -> futurist.Future:
    """Passthrough method to run func on a thread in a given executor.

    It will also grab the context from the threadlocal store and add it to
    the store on the new thread.  This allows for continuity in logging the
    context when using this method to spawn a new thread.
    """
    _log_executor_stats(executor)
    if _executor_is_full(executor):
        LOG.warning(
            "The %s pool does not have free threads so the task %s will be "
            "queued. If this happens repeatedly then the size of the pool is "
            "too small for the load or there are stuck threads filling the "
            "pool.", executor.name, func)
    return _pass_context(executor.submit, func, *args, **kwargs)


def tpool_execute(func, *args, **kwargs):
    """Run func in a native thread"""
    return _pass_context(tpool.execute, func, *args, **kwargs)


def is_none_string(val):
    """Check if a string represents a None value.
    """
    if not isinstance(val, str):
        return False

    return val.lower() == 'none'


def is_auto_disk_config_disabled(auto_disk_config_raw):
    auto_disk_config_disabled = False
    if auto_disk_config_raw is not None:
        adc_lowered = auto_disk_config_raw.strip().lower()
        if adc_lowered == "disabled":
            auto_disk_config_disabled = True
    return auto_disk_config_disabled


def get_auto_disk_config_from_instance(instance=None, sys_meta=None):
    if sys_meta is None:
        sys_meta = instance_sys_meta(instance)
    return sys_meta.get("image_auto_disk_config")


def get_auto_disk_config_from_image_props(image_properties):
    return image_properties.get("auto_disk_config")


def get_system_metadata_from_image(image_meta, flavor=None):
    system_meta = {}
    prefix_format = SM_IMAGE_PROP_PREFIX + '%s'

    for key, value in image_meta.get('properties', {}).items():
        if key in SM_SKIP_KEYS:
            continue

        new_value = safe_truncate(str(value), 255)
        system_meta[prefix_format % key] = new_value

    for key in SM_INHERITABLE_KEYS:
        value = image_meta.get(key)

        if key == 'min_disk' and flavor:
            if image_meta.get('disk_format') == 'vhd':
                value = flavor['root_gb']
            else:
                value = max(value or 0, flavor['root_gb'])

        if value is None:
            continue

        system_meta[prefix_format % key] = value

    return system_meta


def get_image_from_system_metadata(system_meta):
    image_meta = {}
    properties = {}

    if not isinstance(system_meta, dict):
        system_meta = metadata_to_dict(system_meta, include_deleted=True)

    for key, value in system_meta.items():
        if value is None:
            continue

        # NOTE(xqueralt): Not sure this has to inherit all the properties or
        # just the ones we need. Leaving it for now to keep the old behaviour.
        if key.startswith(SM_IMAGE_PROP_PREFIX):
            key = key[len(SM_IMAGE_PROP_PREFIX):]

        if key in SM_SKIP_KEYS:
            continue

        if key in SM_INHERITABLE_KEYS:
            image_meta[key] = value
        else:
            properties[key] = value

    image_meta['properties'] = properties

    return image_meta


def get_hash_str(base_str):
    """Returns string that represents MD5 hash of base_str (in hex format).

    If base_str is a Unicode string, encode it to UTF-8.
    """
    if isinstance(base_str, str):
        base_str = base_str.encode('utf-8')
    return hashlib.md5(base_str, usedforsecurity=False).hexdigest()


def get_sha256_str(base_str):
    """Returns string that represents sha256 hash of base_str (in hex format).

    sha1 and md5 are known to be breakable, so sha256 is a better option
    when the hash is being used for security purposes. If hashing passwords
    or anything else that needs to be retained for a long period a salted
    hash is better.
    """
    if isinstance(base_str, str):
        base_str = base_str.encode('utf-8')
    return hashlib.sha256(base_str).hexdigest()


def get_obj_repr_unicode(obj):
    """Returns a string representation of an object converted to unicode.

    In the case of python 3, this just returns the repr() of the object,
    else it converts the repr() to unicode.
    """
    obj_repr = repr(obj)
    return obj_repr


def safe_truncate(value, length):
    """Safely truncates unicode strings such that their encoded length is
    no greater than the length provided.
    """
    b_value = encodeutils.safe_encode(value)[:length]

    # NOTE(chaochin) UTF-8 character byte size varies from 1 to 6. If
    # truncating a long byte string to 255, the last character may be
    # cut in the middle, so that UnicodeDecodeError will occur when
    # converting it back to unicode.
    decode_ok = False
    while not decode_ok:
        try:
            u_value = encodeutils.safe_decode(b_value)
            decode_ok = True
        except UnicodeDecodeError:
            b_value = b_value[:-1]
    return u_value


def read_cached_file(filename, force_reload=False):
    """Read from a file if it has been modified.

    :param force_reload: Whether to reload the file.
    :returns: A tuple with a boolean specifying if the data is fresh
              or not.
    """
    global _FILE_CACHE

    if force_reload:
        delete_cached_file(filename)

    reloaded = False
    mtime = os.path.getmtime(filename)
    cache_info = _FILE_CACHE.setdefault(filename, {})

    if not cache_info or mtime > cache_info.get('mtime', 0):
        LOG.debug("Reloading cached file %s", filename)
        with open(filename) as fap:
            cache_info['data'] = fap.read()
        cache_info['mtime'] = mtime
        reloaded = True
    return (reloaded, cache_info['data'])


def delete_cached_file(filename):
    """Delete cached file if present.

    :param filename: filename to delete
    """
    global _FILE_CACHE

    if filename in _FILE_CACHE:
        del _FILE_CACHE[filename]


def isotime(at=None):
    """Current time as ISO string,
    as timeutils.isotime() is deprecated

    :returns: Current time in ISO format
    """
    if not at:
        at = timeutils.utcnow()
    date_string = at.strftime("%Y-%m-%dT%H:%M:%S")
    tz = at.tzinfo.tzname(None) if at.tzinfo else 'UTC'
    date_string += ('Z' if tz in ['UTC', 'UTC+00:00'] else tz)
    return date_string


def strtime(at):
    return at.strftime("%Y-%m-%dT%H:%M:%S.%f")


def _get_conf_group(service_type):
    # Get the conf group corresponding to the service type.
    confgrp = _SERVICE_TYPES.get_project_name(service_type)
    if not confgrp or not hasattr(CONF, confgrp):
        # Try the service type as the conf group.  This is necessary for e.g.
        # placement, while it's still part of the nova project.
        # Note that this might become the first thing we try if/as we move to
        # using service types for conf group names in general.
        confgrp = service_type
        if not confgrp or not hasattr(CONF, confgrp):
            raise exception.ConfGroupForServiceTypeNotFound(stype=service_type)
    return confgrp


def _get_auth_and_session(confgrp, ksa_auth=None, ksa_session=None):
    # Ensure we have an auth.
    # NOTE(efried): This could be None, and that could be okay - e.g. if the
    # result is being used for get_endpoint() and the conf only contains
    # endpoint_override.
    if not ksa_auth:
        if ksa_session and ksa_session.auth:
            ksa_auth = ksa_session.auth
        else:
            ksa_auth = ks_loading.load_auth_from_conf_options(CONF, confgrp)

    if not ksa_session:
        ksa_session = ks_loading.load_session_from_conf_options(
            CONF, confgrp, auth=ksa_auth)

    return ksa_auth, ksa_session


def get_ksa_adapter(service_type, ksa_auth=None, ksa_session=None,
                    min_version=None, max_version=None):
    """Construct a keystoneauth1 Adapter for a given service type.

    We expect to find a conf group whose name corresponds to the service_type's
    project according to the service-types-authority.  That conf group must
    provide at least ksa adapter options.  Depending how the result is to be
    used, ksa auth and/or session options may also be required, or the relevant
    parameter supplied.

    A raise_exc=False adapter is returned, meaning responses >=400 return the
    Response object rather than raising an exception.  This behavior can be
    overridden on a per-request basis by setting raise_exc=True.

    :param service_type: String name of the service type for which the Adapter
                         is to be constructed.
    :param ksa_auth: A keystoneauth1 auth plugin. If not specified, we attempt
                     to find one in ksa_session.  Failing that, we attempt to
                     load one from the conf.
    :param ksa_session: A keystoneauth1 Session.  If not specified, we attempt
                        to load one from the conf.
    :param min_version: The minimum major version of the adapter's endpoint,
                        intended to be used as the lower bound of a range with
                        max_version.
                        If min_version is given with no max_version it is as
                        if max version is 'latest'.
    :param max_version: The maximum major version of the adapter's endpoint,
                        intended to be used as the upper bound of a range with
                        min_version.
    :return: A keystoneauth1 Adapter object for the specified service_type.
    :raise: ConfGroupForServiceTypeNotFound If no conf group name could be
            found for the specified service_type.
    """
    confgrp = _get_conf_group(service_type)

    ksa_auth, ksa_session = _get_auth_and_session(
        confgrp, ksa_auth, ksa_session)

    return ks_loading.load_adapter_from_conf_options(
        CONF, confgrp, session=ksa_session, auth=ksa_auth,
        min_version=min_version, max_version=max_version, raise_exc=False)


def get_sdk_adapter(
    service_type, admin, check_service=False, conf_group=None,
    context=None, **kwargs
):
    """Construct an openstacksdk-brokered Adapter for a given service type.

    We expect to find a conf group whose name corresponds to the service_type's
    project according to the service-types-authority.  That conf group must
    provide ksa auth, session, and adapter options.

    :param service_type: String name of the service type for which the Adapter
                         is to be constructed.
    :param admin: If set to true, the service will use Nova's service user
                  and password; otherwise, it will use the user's token.
    :param check_service: If True, we will query the endpoint to make sure the
            service is alive, raising ServiceUnavailable if it is not.
    :param conf_group: String name of the conf group to use, otherwise the name
            of the service_type will be used.
    :param context: Use to get user's token, if admin is set to False.
    :param kwargs: Additional arguments to pass to the Adapter constructor.
                   Mainly used to pass microversion to a specific service,
                   e.g. shared_file_system_api_version="2.82".
    :return: An openstack.proxy.Proxy object for the specified service_type.
    :raise: ConfGroupForServiceTypeNotFound If no conf group name could be
            found for the specified service_type.
    :raise: ServiceUnavailable if check_service is True and the service is down
    """
    confgrp = conf_group or _get_conf_group(service_type)

    try:
        if admin is False:
            if context is None:
                raise ValueError(
                    "If admin is set to False then context cannot be None.")

            # NOTE(gibi): this is only needed to make sure
            # CONF.service_user.auth_url config is registered
            ks_loading.load_auth_from_conf_options(
                CONF, nova.conf.service_token.service_user.name)

            # Create a connection using the user's token instead of nova's
            # service user/pass.
            conn = connection.Connection(
                token=context.auth_token,
                auth_type="v3token",
                project_id=context.project_id,
                project_domain_id=context.project_domain_id,
                auth_url=CONF.service_user.auth_url,
                service_types={service_type},
                strict_proxies=check_service,
                **kwargs,
            )
        else:
            # Create a connection based on nova's service user/pass
            sess = _get_auth_and_session(confgrp)[1]
            conn = connection.Connection(
                session=sess, oslo_conf=CONF, service_types={service_type},
                strict_proxies=check_service, **kwargs)

    except sdk_exc.ServiceDiscoveryException as e:
        raise exception.ServiceUnavailable(
            _("The %(service_type)s service is unavailable: %(error)s") %
            {'service_type': service_type, 'error': str(e)})
    # The replace('-', '_') below is to handle service names that use
    # hyphens and SDK attributes that use underscores.
    # e.g. service name --> sdk attribute
    #      'shared-file-system' --> 'shared_file_system'
    return getattr(conn, service_type.replace('-', '_'))


def get_endpoint(ksa_adapter):
    """Get the endpoint URL represented by a keystoneauth1 Adapter.

    This method is equivalent to what

        ksa_adapter.get_endpoint()

    should do, if it weren't for a panoply of bugs.

    :param ksa_adapter: keystoneauth1.adapter.Adapter, appropriately set up
                        with an endpoint_override; or service_type, interface
                        (list) and auth/service_catalog.
    :return: String endpoint URL.
    :raise EndpointNotFound: If endpoint discovery fails.
    """
    # TODO(efried): This will be unnecessary once bug #1707993 is fixed.
    # (At least for the non-image case, until 1707995 is fixed.)
    if ksa_adapter.endpoint_override:
        return ksa_adapter.endpoint_override
    # TODO(efried): Remove this once bug #1707995 is fixed.
    if ksa_adapter.service_type == 'image':
        try:
            return ksa_adapter.get_endpoint_data().catalog_url
        except AttributeError:
            # ksa_adapter.auth is a _ContextAuthPlugin, which doesn't have
            # get_endpoint_data.  Fall through to using get_endpoint().
            pass
    return ksa_adapter.get_endpoint()


def generate_hostid(host, project_id):
    """Generate an obfuscated host id representing the host.

    This is a hashed value so will not actually look like a hostname, and is
    hashed with data from the project_id.

    :param host: The name of the compute host.
    :param project_id: The UUID of the project.
    :return: An obfuscated hashed host id string, return "" if host is empty
    """
    if host:
        data = (project_id + host).encode('utf-8')
        sha_hash = hashlib.sha224(data)
        return sha_hash.hexdigest()
    return ""


@contextlib.contextmanager
def nested_contexts(*contexts):
    with contextlib.ExitStack() as stack:
        yield [stack.enter_context(c) for c in contexts]


def normalize_rc_name(rc_name):
    """Normalize a resource class name to standard form."""
    if rc_name is None:
        return None
    # Replace non-alphanumeric characters with underscores
    norm_name = re.sub('[^0-9A-Za-z]+', '_', rc_name)
    # Bug #1762789: Do .upper after replacing non alphanumerics.
    norm_name = norm_name.upper()
    norm_name = orc.CUSTOM_NAMESPACE + norm_name
    return norm_name


def raise_if_old_compute():
    # to avoid circular imports
    from nova import context as nova_context
    from nova.objects import service

    ctxt = nova_context.get_admin_context()

    if CONF.api_database.connection is not None:
        scope = 'system'
        try:
            current_service_version = service.get_minimum_version_all_cells(
                ctxt, ['nova-compute'])
        except exception.DBNotAllowed:
            # This most likely means we are in a nova-compute service
            # configured which is configured with a connection to the API
            # database. We should not be attempting to "get out" of our cell to
            # look at the minimum versions of nova-compute services in other
            # cells, so DBNotAllowed was raised. Leave a warning message
            # and fall back to only querying computes in our cell.
            LOG.warning(
                'This service is configured for access to the API database '
                'but is not allowed to directly access the database. You '
                'should run this service without the '
                '[api_database]/connection config option. The service version '
                'check will only query the local cell.')
            scope = 'cell'
            current_service_version = service.Service.get_minimum_version(
                ctxt, 'nova-compute')
    else:
        scope = 'cell'
        # We in a cell so target our query to the current cell only
        current_service_version = service.Service.get_minimum_version(
            ctxt, 'nova-compute')

    if current_service_version == 0:
        # 0 means no compute in the system,
        # probably a fresh install before the computes are registered
        return

    oldest_supported_service_level = service.SERVICE_VERSION_ALIASES[
            service.OLDEST_SUPPORTED_SERVICE_VERSION]

    if current_service_version < oldest_supported_service_level:
        raise exception.TooOldComputeService(
            oldest_supported_version=service.OLDEST_SUPPORTED_SERVICE_VERSION,
            scope=scope,
            min_service_level=current_service_version,
            oldest_supported_service=oldest_supported_service_level)


def run_once(message, logger, cleanup=None):
    """This is a utility function decorator to ensure a function
    is run once and only once in an interpreter instance.

    Note: this is copied from the placement repo (placement/util.py)

    The decorated function object can be reset by calling its
    reset function. All exceptions raised by the wrapped function,
    logger and cleanup function will be propagated to the caller.
    """
    def outer_wrapper(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            if not wrapper.called:
                # Note(sean-k-mooney): the called state is always
                # updated even if the wrapped function completes
                # by raising an exception. If the caller catches
                # the exception it is their responsibility to call
                # reset if they want to re-execute the wrapped function.
                try:
                    return func(*args, **kwargs)
                finally:
                    wrapper.called = True
            else:
                logger(message)

        wrapper.called = False

        def reset(wrapper, *args, **kwargs):
            # Note(sean-k-mooney): we conditionally call the
            # cleanup function if one is provided only when the
            # wrapped function has been called previously. We catch
            # and reraise any exception that may be raised and update
            # the called state in a finally block to ensure its
            # always updated if reset is called.
            try:
                if cleanup and wrapper.called:
                    return cleanup(*args, **kwargs)
            finally:
                wrapper.called = False

        wrapper.reset = functools.partial(reset, wrapper)
        return wrapper
    return outer_wrapper


class _SentinelException(Exception):
    """This type exists to act as a placeholder and will never be raised"""


def latch_error_on_raise(retryable=(_SentinelException,)):
    """This is a utility decorator to ensure if a function ever raises
    it will always raise the same exception going forward.

    The only exception we know is safe to ignore is an oslo db connection
    error as the db may be temporarily unavailable and we should allow
    mod_wsgi to retry
    """

    def outer_wrapper(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            if wrapper.error:
                raise wrapper.error
            try:
                return func(*args, **kwargs)
            except retryable:
                # reraise any retryable exception to allow them to be handled
                # by the caller.
                raise
            except Exception as e:
                wrapper.error = e
                LOG.exception(e)
                raise

        wrapper.error = None

        def reset(wrapper):
            wrapper.error = None

        wrapper.reset = functools.partial(reset, wrapper)
        return wrapper
    return outer_wrapper


class FairLockGuard:
    """A lock guard context manager

    This class support acquiring multiple locks safely by name
    and releasing them via the context manager protocol
    i.e. with FairLockGuard([list of lock names]):

    The intended usage model for this context manager is to
    mediate access to a set of locks by name, not by pre-creating
    the locks and passing them in. Lock creation and management
    is handled entirely internally.

    If you are using this between threads, Thread-A and Thread-B
    should both create there own context manager instead of sharing
    a single context manager between treads.

    Nesting is supported by creating a new context manager instance
    for each nested context with the same or different lock names
    as the outer context. Attempting to nest the same context manager
    instance should raise a TypeError.

    Example Valid Usage:
    ```
    with FairLockGuard(['lock1', 'lock2']) as lock_guard:
        with FairLockGuard(['lock1', 'lock2']) as lock_guard2:
            pass
    ```

    Example Invalid Usage:
    ```
    with FairLockGuard(['lock1', 'lock2']) as lock_guard:
        with lock_guard:
            pass
    ```
    This will raise a TypeError because the same context manager instance
    is being nested.

    In general you should avoid naming the context manager instance
    and only construct it in the with statement to avoid incorrect usage.
    """

    def __init__(self, names):
        # we need to sort the lock to ensure we acquire
        # them in the same order. This ensures we do not
        # fall afoul of the Dining philosophers problem
        # https://en.wikipedia.org/wiki/Dining_philosophers_problem
        # by implementing the simplest Ordered solution
        # https://howardhinnant.github.io/dining_philosophers.html
        self.names = sorted(names)
        self.locks = []
        # NOTE(sean-k-mooney): this is technically not required
        # but it protect the internal state of self.locks list
        # from incorrect usage where a context manager instance is
        # shared between threads. We use a reader-writer lock to
        # allow concurrent reads in is_locked() while ensuring
        # exclusive access for state modifications.
        self.locks_lock = lockutils.ReaderWriterLock()
        self._active = False

    def __enter__(self):
        with self.locks_lock.write_lock():
            if self._active:
                raise TypeError(
                    "Cannot enter FairLockGuard while it is already active. "
                    "Create a new instance for nested usage or wait for the "
                    "current context to exit.")
            for name in self.names:
                named_lock = NOVA_FAIR_LOCKS.get(name)
                self.locks.append(named_lock)
                # we ensure we add it to the list
                # before we acquire the lock to make sure
                # we release it if there is an exception
                named_lock.acquire_write_lock()
            self._active = True

    def __exit__(self, exc_type, exc_value, traceback):
        with self.locks_lock.write_lock():
            for lock in self.locks:
                # This should always be true but since
                # we add the lock to the list before we
                # acquire it check anyway.
                if lock.is_writer():
                    lock.release_write_lock()
            self.locks = []
            self._active = False

    def is_locked(self):
        # NOTE(sean-k-mooney): LockGuards exist in several programming
        # languages such as c++, in general a LockGuard can support a
        # single lock or many but by convention a LockGuard is only
        # considered locked if all locks are acquired. FairLocks in
        # oslo are implemented as ReaderWriter inter-process locks.
        # that means that we hold the lock if we are hold the writer
        # lock aka if the lock is the writer. We use a read lock here
        # to allow concurrent reads while state modifications use write
        # locks.
        with self.locks_lock.read_lock():
            return (
                self.locks and all(lock.is_writer() for lock in self.locks))


def concurrency_mode_threading():
    """Returns true if the service is running in threading mode, false if
    running in Eventlet mode
    """
    from nova import monkey_patch
    return not monkey_patch.is_patched()


SCATTER_GATHER_EXECUTOR = None


def get_scatter_gather_executor():
    """Returns the executor used for scatter/gather operations."""
    global SCATTER_GATHER_EXECUTOR

    if not SCATTER_GATHER_EXECUTOR:
        max_workers = (
            CONF.cell_worker_thread_pool_size
            if concurrency_mode_threading() else 1000
            )
        SCATTER_GATHER_EXECUTOR = create_executor(max_workers)

        pname = multiprocessing.current_process().name
        executor_name = f"{pname}.cell_worker"
        SCATTER_GATHER_EXECUTOR.name = executor_name

        LOG.info("The cell worker thread pool %s is initialized",
                 executor_name)

    return SCATTER_GATHER_EXECUTOR


def destroy_scatter_gather_executor():
    """Closes the executor and resets the global to None to allow forked worker
    processes to properly init it.
    """
    global SCATTER_GATHER_EXECUTOR
    if SCATTER_GATHER_EXECUTOR:
        LOG.info(
            "The cell worker thread pool %s is shutting down",
            SCATTER_GATHER_EXECUTOR.name)
        SCATTER_GATHER_EXECUTOR.shutdown()
        LOG.info(
            "The cell worker thread pool %s is closed",
            SCATTER_GATHER_EXECUTOR.name)

    SCATTER_GATHER_EXECUTOR = None


CACHE_IMAGES_EXECUTOR = None


def get_cache_images_executor():
    """Returns the executor used for cache images operations."""
    global CACHE_IMAGES_EXECUTOR

    if not CACHE_IMAGES_EXECUTOR:
        max_workers = CONF.image_cache.precache_concurrency
        CACHE_IMAGES_EXECUTOR = create_executor(max_workers)

        pname = multiprocessing.current_process().name
        executor_name = f"{pname}.cache_images"
        CACHE_IMAGES_EXECUTOR.name = executor_name

        LOG.info("The cache images executor %s is initialized", executor_name)

    return CACHE_IMAGES_EXECUTOR


def destroy_cache_images_executor():
    """Closes the executor and resets the global to None to allow forked worker
    processes to properly init it.
    """
    global CACHE_IMAGES_EXECUTOR
    if CACHE_IMAGES_EXECUTOR:
        LOG.info(
            "The cache images thread pool %s is shutting down",
            CACHE_IMAGES_EXECUTOR.name)
        CACHE_IMAGES_EXECUTOR.shutdown()
        LOG.info(
            "The cache images thread pool %s is closed",
            CACHE_IMAGES_EXECUTOR.name)

    CACHE_IMAGES_EXECUTOR = None


def _log_executor_stats(executor):
    if CONF.thread_pool_statistic_period < 0:
        return

    last_stats = getattr(executor, "last_stats", None)
    name = getattr(executor, "name", "unknown")

    allowed_stat_age = time.monotonic() - CONF.thread_pool_statistic_period
    if last_stats and last_stats > allowed_stat_age:
        return

    executor.last_stats = time.monotonic()

    stats: futurist.ExecutorStatistics = executor.statistics

    if isinstance(executor, futurist.ThreadPoolExecutor):
        LOG.debug(
            "State of %s ThreadPoolExecutor when submitting a new task: "
            "max_workers: %d, workers: %d, idle workers: %d, queued work: %d, "
            "stats: %s",
            name,
            executor._max_workers, len(executor._workers),
            len([w for w in executor._workers if w.idle]),
            executor._work_queue.qsize(), stats)
    elif isinstance(executor, futurist.GreenThreadPoolExecutor):
        LOG.debug(
            "State of %s GreenThreadPoolExecutor when submitting a new task: "
            "workers: %d, max_workers: %d, work queued length: %d, stats: %s",
            name,
            len(executor._pool.coroutines_running), executor._pool.size,
            executor._delayed_work.unfinished_tasks, stats)