# pylint:disable=abstract-method
from typing import Iterable, Tuple, Dict, Any, Optional

import claripy

from ...state_plugins.plugin import SimStatePlugin
from ...errors import SimMemoryError


class MemoryMixin(SimStatePlugin):
    SUPPORTS_CONCRETE_LOAD = False

    def __init__(self, memory_id=None, endness="Iend_BE"):
        super().__init__()
        self.id = memory_id
        self.endness = endness

    def copy(self, memo):
        o = type(self).__new__(type(self))
        o.id = self.id
        o.endness = self.endness
        return o

    @property
    def category(self):
        """
        Return the category of this SimMemory instance. It can be one of the three following categories: reg, mem,
        or file.
        """

        if self.id in ("reg", "mem"):
            return self.id

        elif self.id.startswith("file"):
            return "file"

        elif "_" in self.id:
            return self.id.split("_")[0]

        else:
            raise SimMemoryError('Unknown SimMemory category for memory_id "%s"' % self.id)

    @property
    def variable_key_prefix(self):
        s = self.category
        if s == "file":
            return (s, self.id)
        return (s,)

    def find(self, addr, data, max_search, **kwargs):
        pass

    def _add_constraints(self, c, add_constraints=True, condition=None, **kwargs):
        if add_constraints:
            if condition is not None:
                to_add = (c & condition) | ~condition
            else:
                to_add = c
            self.state.add_constraints(to_add)

    def load(self, addr, **kwargs):
        pass

    def store(self, addr, data, **kwargs):
        pass

    def merge(self, others, merge_conditions, common_ancestor=None) -> bool:
        pass

    def widen(self, others):
        pass

    def permissions(self, addr, permissions=None, **kwargs):
        pass

    def map_region(self, addr, length, permissions, init_zero=False, **kwargs):
        pass

    def unmap_region(self, addr, length, **kwargs):
        pass

    # Optional interface:
    def concrete_load(self, addr, size, writing=False, **kwargs) -> memoryview:
        """
        Set SUPPORTS_CONCRETE_LOAD to True and implement concrete_load if reading concrete bytes is faster in this
        memory model.

        :param addr:    The address to load from.
        :param size:    Size of the memory read.
        :param writing:
        :return:        A memoryview into the loaded bytes.
        """
        raise NotImplementedError()

    def erase(self, addr, size=None, **kwargs) -> None:
        """
        Set [addr:addr+size) to uninitialized. In many cases this will be faster than overwriting those locations with
        new values. This is commonly used during static data flow analysis.

        :param addr:    The address to start erasing.
        :param size:    The number of bytes for erasing.
        :return:        None
        """
        raise NotImplementedError()

    def _default_value(self, addr, size, name=None, inspect=True, events=True, key=None, **kwargs):
        """
        Override this method to provide default values for a variety of edge cases and base cases.

        :param addr:    If this value is being filled to provide a default memory value, this will be its address.
                        Otherwise, None.
        :param size:    The size in bytes of the value to return
        :param name:    A descriptive identifier for the value, for if a symbol is created.

        The ``inspect``, ``events``, and ``key`` parameters are for ``state.solver.Unconstrained``, if it is used.
        """
        pass

    def _merge_values(self, values: Iterable[Tuple[Any, Any]], merged_size: int, **kwargs) -> Optional[Any]:
        """
        Override this method to provide value merging support.

        :param values:          A collection of values with their merge conditions.
        :param merged_size:     The size (in bytes) of the merged value.
        :return:                The merged value, or None to skip merging of the current value.
        """
        raise NotImplementedError()

    def _merge_labels(self, labels: Iterable[Dict], **kwargs) -> Optional[Dict]:
        """
        Override this method to provide label merging support.

        :param labels:          A collection of labels.
        :return:                The merged label, or None to skip merging of the current label.
        """
        raise NotImplementedError()

    def replace_all(self, old: claripy.ast.BV, new: claripy.ast.BV):
        raise NotImplementedError()

    def _replace_all(self, addrs: Iterable[int], old: claripy.ast.BV, new: claripy.ast.BV):
        raise NotImplementedError()

    def copy_contents(self, dst, src, size, condition=None, **kwargs):
        """
        Override this method to provide faster copying of large chunks of data.

        :param dst:     The destination of copying.
        :param src:     The source of copying.
        :param size:    The size of copying.
        :param condition:   The storing condition.
        :param kwargs:      Other parameters.
        :return:        None
        """
        raise NotImplementedError()


from .actions_mixin import ActionsMixinHigh, ActionsMixinLow
from .address_concretization_mixin import AddressConcretizationMixin
from .bvv_conversion_mixin import DataNormalizationMixin
from .clouseau_mixin import InspectMixinHigh
from .conditional_store_mixin import ConditionalMixin
from .convenient_mappings_mixin import ConvenientMappingsMixin
from .default_filler_mixin import DefaultFillerMixin, SpecialFillerMixin, ExplicitFillerMixin
from .dirty_addrs_mixin import DirtyAddrsMixin
from .hex_dumper_mixin import HexDumperMixin
from .label_merger_mixin import LabelMergerMixin
from .multi_value_merger_mixin import MultiValueMergerMixin
from .name_resolution_mixin import NameResolutionMixin
from .simplification_mixin import SimplificationMixin
from .simple_interface_mixin import SimpleInterfaceMixin
from .size_resolution_mixin import SizeNormalizationMixin, SizeConcretizationMixin
from .smart_find_mixin import SmartFindMixin
from .symbolic_merger_mixin import SymbolicMergerMixin
from .top_merger_mixin import TopMergerMixin
from .underconstrained_mixin import UnderconstrainedMixin
from .unwrapper_mixin import UnwrapperMixin

from .paged_memory.page_backer_mixins import ClemoryBackerMixin, ConcreteBackerMixin, DictBackerMixin
from .paged_memory.paged_memory_mixin import (
    PagedMemoryMixin,
    ListPagesMixin,
    UltraPagesMixin,
    ListPagesWithLabelsMixin,
    MVListPagesMixin,
    MVListPagesWithLabelsMixin,
)
from .paged_memory.privileged_mixin import PrivilegedPagingMixin
from .paged_memory.stack_allocation_mixin import StackAllocationMixin
from .paged_memory.pages import *

from .slotted_memory import SlottedMemoryMixin
from .regioned_memory import (
    RegionedMemoryMixin,
    RegionCategoryMixin,
    StaticFindMixin,
    AbstractMergerMixin,
    MemoryRegionMetaMixin,
    RegionedAddressConcretizationMixin,
)
from .keyvalue_memory import KeyValueMemoryMixin
from .javavm_memory import JavaVmMemoryMixin


class DefaultMemory(
    HexDumperMixin,
    SmartFindMixin,
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    InspectMixinHigh,
    ActionsMixinHigh,
    UnderconstrainedMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    AddressConcretizationMixin,
    # InspectMixinLow,
    ActionsMixinLow,
    ConditionalMixin,
    ConvenientMappingsMixin,
    DirtyAddrsMixin,
    # -----
    StackAllocationMixin,
    ConcreteBackerMixin,
    ClemoryBackerMixin,
    DictBackerMixin,
    PrivilegedPagingMixin,
    UltraPagesMixin,
    DefaultFillerMixin,
    SymbolicMergerMixin,
    PagedMemoryMixin,
):
    pass


class DefaultListPagesMemory(
    HexDumperMixin,
    SmartFindMixin,
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    ActionsMixinHigh,
    UnderconstrainedMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    InspectMixinHigh,
    AddressConcretizationMixin,
    # InspectMixinLow,
    ActionsMixinLow,
    ConditionalMixin,
    ConvenientMappingsMixin,
    DirtyAddrsMixin,
    # -----
    StackAllocationMixin,
    ClemoryBackerMixin,
    DictBackerMixin,
    PrivilegedPagingMixin,
    ListPagesMixin,
    DefaultFillerMixin,
    SymbolicMergerMixin,
    PagedMemoryMixin,
):
    pass


class FastMemory(
    NameResolutionMixin,
    SimpleInterfaceMixin,
    SimplificationMixin,
    InspectMixinHigh,
    ConditionalMixin,
    ExplicitFillerMixin,
    DefaultFillerMixin,
    SlottedMemoryMixin,
):
    pass


class AbstractMemory(
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    InspectMixinHigh,
    ActionsMixinHigh,
    UnderconstrainedMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    # InspectMixinLow,
    ActionsMixinLow,
    ConditionalMixin,
    RegionedAddressConcretizationMixin,
    # -----
    RegionedMemoryMixin,
):
    pass


class RegionedMemory(
    RegionCategoryMixin,
    MemoryRegionMetaMixin,
    StaticFindMixin,
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    AddressConcretizationMixin,
    ConvenientMappingsMixin,
    DirtyAddrsMixin,
    # -----
    ClemoryBackerMixin,
    DictBackerMixin,
    UltraPagesMixin,
    DefaultFillerMixin,
    AbstractMergerMixin,
    PagedMemoryMixin,
):
    pass


class LabeledMemory(
    SizeNormalizationMixin,
    ListPagesWithLabelsMixin,
    DefaultFillerMixin,
    TopMergerMixin,
    LabelMergerMixin,
    PagedMemoryMixin,
):
    """
    LabeledMemory is used in static analysis. It allows storing values with labels, such as `Definition`.
    """

    def _default_value(self, addr, size, **kwargs):
        # TODO: Make _default_value() a separate Mixin

        if kwargs.get("name", "").startswith("merge_uc_"):
            # this is a hack. when this condition is satisfied, _default_value() is called inside Listpage.merge() to
            # create temporary values. we simply return a TOP value here.
            return self.state.top(size * self.state.arch.byte_width)

        # we never fill default values for non-existent loads
        kwargs["fill_missing"] = False
        return super()._default_value(addr, size, **kwargs)


class MultiValuedMemory(
    SizeNormalizationMixin,
    MVListPagesMixin,
    DefaultFillerMixin,
    MultiValueMergerMixin,
    PagedMemoryMixin,
):
    def _default_value(self, addr, size, **kwargs):
        # TODO: Make _default_value() a separate Mixin

        if kwargs.get("name", "").startswith("merge_uc_"):
            # this is a hack. when this condition is satisfied, _default_value() is called inside Listpage.merge() to
            # create temporary values. we simply return a TOP value here.
            return self.state.top(size * self.state.arch.byte_width)

        # we never fill default values for non-existent loads
        kwargs["fill_missing"] = False
        return super()._default_value(addr, size, **kwargs)


class KeyValueMemory(
    KeyValueMemoryMixin,
):
    pass


class JavaVmMemory(
    JavaVmMemoryMixin,
):
    pass


from angr.sim_state import SimState

SimState.register_default("sym_memory", DefaultMemory)
SimState.register_default("fast_memory", FastMemory)
SimState.register_default("abs_memory", AbstractMemory)
SimState.register_default("keyvalue_memory", KeyValueMemory)
SimState.register_default("javavm_memory", JavaVmMemory)

d563b87be8cd318e7d2022dec72a65fbf01dcb50
<mask token>


class MemoryMixin(SimStatePlugin):
    <mask token>
    <mask token>

    def copy(self, memo):
        o = type(self).__new__(type(self))
        o.id = self.id
        o.endness = self.endness
        return o
    <mask token>
    <mask token>
    <mask token>
    <mask token>

    def load(self, addr, **kwargs):
        pass
    <mask token>
    <mask token>

    def widen(self, others):
        pass

    def permissions(self, addr, permissions=None, **kwargs):
        pass

    def map_region(self, addr, length, permissions, init_zero=False, **kwargs):
        pass

    def unmap_region(self, addr, length, **kwargs):
        pass

    def concrete_load(self, addr, size, writing=False, **kwargs) ->memoryview:
        """
        Set SUPPORTS_CONCRETE_LOAD to True and implement concrete_load if reading concrete bytes is faster in this
        memory model.

        :param addr:    The address to load from.
        :param size:    Size of the memory read.
        :param writing:
        :return:        A memoryview into the loaded bytes.
        """
        raise NotImplementedError()
    <mask token>
    <mask token>
    <mask token>
    <mask token>
    <mask token>

    def _replace_all(self, addrs: Iterable[int], old: claripy.ast.BV, new:
        claripy.ast.BV):
        raise NotImplementedError()
    <mask token>


<mask token>


class DefaultMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    InspectMixinHigh, ActionsMixinHigh, UnderconstrainedMixin,
    SizeConcretizationMixin, SizeNormalizationMixin,
    AddressConcretizationMixin, ActionsMixinLow, ConditionalMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, StackAllocationMixin,
    ConcreteBackerMixin, ClemoryBackerMixin, DictBackerMixin,
    PrivilegedPagingMixin, UltraPagesMixin, DefaultFillerMixin,
    SymbolicMergerMixin, PagedMemoryMixin):
    pass


class DefaultListPagesMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, InspectMixinHigh, AddressConcretizationMixin,
    ActionsMixinLow, ConditionalMixin, ConvenientMappingsMixin,
    DirtyAddrsMixin, StackAllocationMixin, ClemoryBackerMixin,
    DictBackerMixin, PrivilegedPagingMixin, ListPagesMixin,
    DefaultFillerMixin, SymbolicMergerMixin, PagedMemoryMixin):
    pass


class FastMemory(NameResolutionMixin, SimpleInterfaceMixin,
    SimplificationMixin, InspectMixinHigh, ConditionalMixin,
    ExplicitFillerMixin, DefaultFillerMixin, SlottedMemoryMixin):
    pass


class AbstractMemory(UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, InspectMixinHigh,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, ActionsMixinLow, ConditionalMixin,
    RegionedAddressConcretizationMixin, RegionedMemoryMixin):
    pass


class RegionedMemory(RegionCategoryMixin, MemoryRegionMetaMixin,
    StaticFindMixin, UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, AddressConcretizationMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, ClemoryBackerMixin,
    DictBackerMixin, UltraPagesMixin, DefaultFillerMixin,
    AbstractMergerMixin, PagedMemoryMixin):
    pass


class LabeledMemory(SizeNormalizationMixin, ListPagesWithLabelsMixin,
    DefaultFillerMixin, TopMergerMixin, LabelMergerMixin, PagedMemoryMixin):
    """
    LabeledMemory is used in static analysis. It allows storing values with labels, such as `Definition`.
    """

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class MultiValuedMemory(SizeNormalizationMixin, MVListPagesMixin,
    DefaultFillerMixin, MultiValueMergerMixin, PagedMemoryMixin):

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class KeyValueMemory(KeyValueMemoryMixin):
    pass


class JavaVmMemory(JavaVmMemoryMixin):
    pass


<mask token>

<mask token>


class MemoryMixin(SimStatePlugin):
    <mask token>
    <mask token>

    def copy(self, memo):
        o = type(self).__new__(type(self))
        o.id = self.id
        o.endness = self.endness
        return o

    @property
    def category(self):
        """
        Return the category of this SimMemory instance. It can be one of the three following categories: reg, mem,
        or file.
        """
        if self.id in ('reg', 'mem'):
            return self.id
        elif self.id.startswith('file'):
            return 'file'
        elif '_' in self.id:
            return self.id.split('_')[0]
        else:
            raise SimMemoryError(
                'Unknown SimMemory category for memory_id "%s"' % self.id)
    <mask token>
    <mask token>
    <mask token>

    def load(self, addr, **kwargs):
        pass
    <mask token>
    <mask token>

    def widen(self, others):
        pass

    def permissions(self, addr, permissions=None, **kwargs):
        pass

    def map_region(self, addr, length, permissions, init_zero=False, **kwargs):
        pass

    def unmap_region(self, addr, length, **kwargs):
        pass

    def concrete_load(self, addr, size, writing=False, **kwargs) ->memoryview:
        """
        Set SUPPORTS_CONCRETE_LOAD to True and implement concrete_load if reading concrete bytes is faster in this
        memory model.

        :param addr:    The address to load from.
        :param size:    Size of the memory read.
        :param writing:
        :return:        A memoryview into the loaded bytes.
        """
        raise NotImplementedError()
    <mask token>
    <mask token>
    <mask token>
    <mask token>
    <mask token>

    def _replace_all(self, addrs: Iterable[int], old: claripy.ast.BV, new:
        claripy.ast.BV):
        raise NotImplementedError()
    <mask token>


<mask token>


class DefaultMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    InspectMixinHigh, ActionsMixinHigh, UnderconstrainedMixin,
    SizeConcretizationMixin, SizeNormalizationMixin,
    AddressConcretizationMixin, ActionsMixinLow, ConditionalMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, StackAllocationMixin,
    ConcreteBackerMixin, ClemoryBackerMixin, DictBackerMixin,
    PrivilegedPagingMixin, UltraPagesMixin, DefaultFillerMixin,
    SymbolicMergerMixin, PagedMemoryMixin):
    pass


class DefaultListPagesMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, InspectMixinHigh, AddressConcretizationMixin,
    ActionsMixinLow, ConditionalMixin, ConvenientMappingsMixin,
    DirtyAddrsMixin, StackAllocationMixin, ClemoryBackerMixin,
    DictBackerMixin, PrivilegedPagingMixin, ListPagesMixin,
    DefaultFillerMixin, SymbolicMergerMixin, PagedMemoryMixin):
    pass


class FastMemory(NameResolutionMixin, SimpleInterfaceMixin,
    SimplificationMixin, InspectMixinHigh, ConditionalMixin,
    ExplicitFillerMixin, DefaultFillerMixin, SlottedMemoryMixin):
    pass


class AbstractMemory(UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, InspectMixinHigh,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, ActionsMixinLow, ConditionalMixin,
    RegionedAddressConcretizationMixin, RegionedMemoryMixin):
    pass


class RegionedMemory(RegionCategoryMixin, MemoryRegionMetaMixin,
    StaticFindMixin, UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, AddressConcretizationMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, ClemoryBackerMixin,
    DictBackerMixin, UltraPagesMixin, DefaultFillerMixin,
    AbstractMergerMixin, PagedMemoryMixin):
    pass


class LabeledMemory(SizeNormalizationMixin, ListPagesWithLabelsMixin,
    DefaultFillerMixin, TopMergerMixin, LabelMergerMixin, PagedMemoryMixin):
    """
    LabeledMemory is used in static analysis. It allows storing values with labels, such as `Definition`.
    """

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class MultiValuedMemory(SizeNormalizationMixin, MVListPagesMixin,
    DefaultFillerMixin, MultiValueMergerMixin, PagedMemoryMixin):

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class KeyValueMemory(KeyValueMemoryMixin):
    pass


class JavaVmMemory(JavaVmMemoryMixin):
    pass


<mask token>

<mask token>


class MemoryMixin(SimStatePlugin):
    <mask token>

    def __init__(self, memory_id=None, endness='Iend_BE'):
        super().__init__()
        self.id = memory_id
        self.endness = endness

    def copy(self, memo):
        o = type(self).__new__(type(self))
        o.id = self.id
        o.endness = self.endness
        return o

    @property
    def category(self):
        """
        Return the category of this SimMemory instance. It can be one of the three following categories: reg, mem,
        or file.
        """
        if self.id in ('reg', 'mem'):
            return self.id
        elif self.id.startswith('file'):
            return 'file'
        elif '_' in self.id:
            return self.id.split('_')[0]
        else:
            raise SimMemoryError(
                'Unknown SimMemory category for memory_id "%s"' % self.id)

    @property
    def variable_key_prefix(self):
        s = self.category
        if s == 'file':
            return s, self.id
        return s,

    def find(self, addr, data, max_search, **kwargs):
        pass
    <mask token>

    def load(self, addr, **kwargs):
        pass

    def store(self, addr, data, **kwargs):
        pass

    def merge(self, others, merge_conditions, common_ancestor=None) ->bool:
        pass

    def widen(self, others):
        pass

    def permissions(self, addr, permissions=None, **kwargs):
        pass

    def map_region(self, addr, length, permissions, init_zero=False, **kwargs):
        pass

    def unmap_region(self, addr, length, **kwargs):
        pass

    def concrete_load(self, addr, size, writing=False, **kwargs) ->memoryview:
        """
        Set SUPPORTS_CONCRETE_LOAD to True and implement concrete_load if reading concrete bytes is faster in this
        memory model.

        :param addr:    The address to load from.
        :param size:    Size of the memory read.
        :param writing:
        :return:        A memoryview into the loaded bytes.
        """
        raise NotImplementedError()

    def erase(self, addr, size=None, **kwargs) ->None:
        """
        Set [addr:addr+size) to uninitialized. In many cases this will be faster than overwriting those locations with
        new values. This is commonly used during static data flow analysis.

        :param addr:    The address to start erasing.
        :param size:    The number of bytes for erasing.
        :return:        None
        """
        raise NotImplementedError()

    def _default_value(self, addr, size, name=None, inspect=True, events=
        True, key=None, **kwargs):
        """
        Override this method to provide default values for a variety of edge cases and base cases.

        :param addr:    If this value is being filled to provide a default memory value, this will be its address.
                        Otherwise, None.
        :param size:    The size in bytes of the value to return
        :param name:    A descriptive identifier for the value, for if a symbol is created.

        The ``inspect``, ``events``, and ``key`` parameters are for ``state.solver.Unconstrained``, if it is used.
        """
        pass

    def _merge_values(self, values: Iterable[Tuple[Any, Any]], merged_size:
        int, **kwargs) ->Optional[Any]:
        """
        Override this method to provide value merging support.

        :param values:          A collection of values with their merge conditions.
        :param merged_size:     The size (in bytes) of the merged value.
        :return:                The merged value, or None to skip merging of the current value.
        """
        raise NotImplementedError()
    <mask token>
    <mask token>

    def _replace_all(self, addrs: Iterable[int], old: claripy.ast.BV, new:
        claripy.ast.BV):
        raise NotImplementedError()

    def copy_contents(self, dst, src, size, condition=None, **kwargs):
        """
        Override this method to provide faster copying of large chunks of data.

        :param dst:     The destination of copying.
        :param src:     The source of copying.
        :param size:    The size of copying.
        :param condition:   The storing condition.
        :param kwargs:      Other parameters.
        :return:        None
        """
        raise NotImplementedError()


<mask token>


class DefaultMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    InspectMixinHigh, ActionsMixinHigh, UnderconstrainedMixin,
    SizeConcretizationMixin, SizeNormalizationMixin,
    AddressConcretizationMixin, ActionsMixinLow, ConditionalMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, StackAllocationMixin,
    ConcreteBackerMixin, ClemoryBackerMixin, DictBackerMixin,
    PrivilegedPagingMixin, UltraPagesMixin, DefaultFillerMixin,
    SymbolicMergerMixin, PagedMemoryMixin):
    pass


class DefaultListPagesMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, InspectMixinHigh, AddressConcretizationMixin,
    ActionsMixinLow, ConditionalMixin, ConvenientMappingsMixin,
    DirtyAddrsMixin, StackAllocationMixin, ClemoryBackerMixin,
    DictBackerMixin, PrivilegedPagingMixin, ListPagesMixin,
    DefaultFillerMixin, SymbolicMergerMixin, PagedMemoryMixin):
    pass


class FastMemory(NameResolutionMixin, SimpleInterfaceMixin,
    SimplificationMixin, InspectMixinHigh, ConditionalMixin,
    ExplicitFillerMixin, DefaultFillerMixin, SlottedMemoryMixin):
    pass


class AbstractMemory(UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, InspectMixinHigh,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, ActionsMixinLow, ConditionalMixin,
    RegionedAddressConcretizationMixin, RegionedMemoryMixin):
    pass


class RegionedMemory(RegionCategoryMixin, MemoryRegionMetaMixin,
    StaticFindMixin, UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, AddressConcretizationMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, ClemoryBackerMixin,
    DictBackerMixin, UltraPagesMixin, DefaultFillerMixin,
    AbstractMergerMixin, PagedMemoryMixin):
    pass


class LabeledMemory(SizeNormalizationMixin, ListPagesWithLabelsMixin,
    DefaultFillerMixin, TopMergerMixin, LabelMergerMixin, PagedMemoryMixin):
    """
    LabeledMemory is used in static analysis. It allows storing values with labels, such as `Definition`.
    """

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class MultiValuedMemory(SizeNormalizationMixin, MVListPagesMixin,
    DefaultFillerMixin, MultiValueMergerMixin, PagedMemoryMixin):

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class KeyValueMemory(KeyValueMemoryMixin):
    pass


class JavaVmMemory(JavaVmMemoryMixin):
    pass


<mask token>

<mask token>


class MemoryMixin(SimStatePlugin):
    SUPPORTS_CONCRETE_LOAD = False

    def __init__(self, memory_id=None, endness='Iend_BE'):
        super().__init__()
        self.id = memory_id
        self.endness = endness

    def copy(self, memo):
        o = type(self).__new__(type(self))
        o.id = self.id
        o.endness = self.endness
        return o

    @property
    def category(self):
        """
        Return the category of this SimMemory instance. It can be one of the three following categories: reg, mem,
        or file.
        """
        if self.id in ('reg', 'mem'):
            return self.id
        elif self.id.startswith('file'):
            return 'file'
        elif '_' in self.id:
            return self.id.split('_')[0]
        else:
            raise SimMemoryError(
                'Unknown SimMemory category for memory_id "%s"' % self.id)

    @property
    def variable_key_prefix(self):
        s = self.category
        if s == 'file':
            return s, self.id
        return s,

    def find(self, addr, data, max_search, **kwargs):
        pass

    def _add_constraints(self, c, add_constraints=True, condition=None, **
        kwargs):
        if add_constraints:
            if condition is not None:
                to_add = c & condition | ~condition
            else:
                to_add = c
            self.state.add_constraints(to_add)

    def load(self, addr, **kwargs):
        pass

    def store(self, addr, data, **kwargs):
        pass

    def merge(self, others, merge_conditions, common_ancestor=None) ->bool:
        pass

    def widen(self, others):
        pass

    def permissions(self, addr, permissions=None, **kwargs):
        pass

    def map_region(self, addr, length, permissions, init_zero=False, **kwargs):
        pass

    def unmap_region(self, addr, length, **kwargs):
        pass

    def concrete_load(self, addr, size, writing=False, **kwargs) ->memoryview:
        """
        Set SUPPORTS_CONCRETE_LOAD to True and implement concrete_load if reading concrete bytes is faster in this
        memory model.

        :param addr:    The address to load from.
        :param size:    Size of the memory read.
        :param writing:
        :return:        A memoryview into the loaded bytes.
        """
        raise NotImplementedError()

    def erase(self, addr, size=None, **kwargs) ->None:
        """
        Set [addr:addr+size) to uninitialized. In many cases this will be faster than overwriting those locations with
        new values. This is commonly used during static data flow analysis.

        :param addr:    The address to start erasing.
        :param size:    The number of bytes for erasing.
        :return:        None
        """
        raise NotImplementedError()

    def _default_value(self, addr, size, name=None, inspect=True, events=
        True, key=None, **kwargs):
        """
        Override this method to provide default values for a variety of edge cases and base cases.

        :param addr:    If this value is being filled to provide a default memory value, this will be its address.
                        Otherwise, None.
        :param size:    The size in bytes of the value to return
        :param name:    A descriptive identifier for the value, for if a symbol is created.

        The ``inspect``, ``events``, and ``key`` parameters are for ``state.solver.Unconstrained``, if it is used.
        """
        pass

    def _merge_values(self, values: Iterable[Tuple[Any, Any]], merged_size:
        int, **kwargs) ->Optional[Any]:
        """
        Override this method to provide value merging support.

        :param values:          A collection of values with their merge conditions.
        :param merged_size:     The size (in bytes) of the merged value.
        :return:                The merged value, or None to skip merging of the current value.
        """
        raise NotImplementedError()

    def _merge_labels(self, labels: Iterable[Dict], **kwargs) ->Optional[Dict]:
        """
        Override this method to provide label merging support.

        :param labels:          A collection of labels.
        :return:                The merged label, or None to skip merging of the current label.
        """
        raise NotImplementedError()

    def replace_all(self, old: claripy.ast.BV, new: claripy.ast.BV):
        raise NotImplementedError()

    def _replace_all(self, addrs: Iterable[int], old: claripy.ast.BV, new:
        claripy.ast.BV):
        raise NotImplementedError()

    def copy_contents(self, dst, src, size, condition=None, **kwargs):
        """
        Override this method to provide faster copying of large chunks of data.

        :param dst:     The destination of copying.
        :param src:     The source of copying.
        :param size:    The size of copying.
        :param condition:   The storing condition.
        :param kwargs:      Other parameters.
        :return:        None
        """
        raise NotImplementedError()


<mask token>


class DefaultMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    InspectMixinHigh, ActionsMixinHigh, UnderconstrainedMixin,
    SizeConcretizationMixin, SizeNormalizationMixin,
    AddressConcretizationMixin, ActionsMixinLow, ConditionalMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, StackAllocationMixin,
    ConcreteBackerMixin, ClemoryBackerMixin, DictBackerMixin,
    PrivilegedPagingMixin, UltraPagesMixin, DefaultFillerMixin,
    SymbolicMergerMixin, PagedMemoryMixin):
    pass


class DefaultListPagesMemory(HexDumperMixin, SmartFindMixin, UnwrapperMixin,
    NameResolutionMixin, DataNormalizationMixin, SimplificationMixin,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, InspectMixinHigh, AddressConcretizationMixin,
    ActionsMixinLow, ConditionalMixin, ConvenientMappingsMixin,
    DirtyAddrsMixin, StackAllocationMixin, ClemoryBackerMixin,
    DictBackerMixin, PrivilegedPagingMixin, ListPagesMixin,
    DefaultFillerMixin, SymbolicMergerMixin, PagedMemoryMixin):
    pass


class FastMemory(NameResolutionMixin, SimpleInterfaceMixin,
    SimplificationMixin, InspectMixinHigh, ConditionalMixin,
    ExplicitFillerMixin, DefaultFillerMixin, SlottedMemoryMixin):
    pass


class AbstractMemory(UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, InspectMixinHigh,
    ActionsMixinHigh, UnderconstrainedMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, ActionsMixinLow, ConditionalMixin,
    RegionedAddressConcretizationMixin, RegionedMemoryMixin):
    pass


class RegionedMemory(RegionCategoryMixin, MemoryRegionMetaMixin,
    StaticFindMixin, UnwrapperMixin, NameResolutionMixin,
    DataNormalizationMixin, SimplificationMixin, SizeConcretizationMixin,
    SizeNormalizationMixin, AddressConcretizationMixin,
    ConvenientMappingsMixin, DirtyAddrsMixin, ClemoryBackerMixin,
    DictBackerMixin, UltraPagesMixin, DefaultFillerMixin,
    AbstractMergerMixin, PagedMemoryMixin):
    pass


class LabeledMemory(SizeNormalizationMixin, ListPagesWithLabelsMixin,
    DefaultFillerMixin, TopMergerMixin, LabelMergerMixin, PagedMemoryMixin):
    """
    LabeledMemory is used in static analysis. It allows storing values with labels, such as `Definition`.
    """

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class MultiValuedMemory(SizeNormalizationMixin, MVListPagesMixin,
    DefaultFillerMixin, MultiValueMergerMixin, PagedMemoryMixin):

    def _default_value(self, addr, size, **kwargs):
        if kwargs.get('name', '').startswith('merge_uc_'):
            return self.state.top(size * self.state.arch.byte_width)
        kwargs['fill_missing'] = False
        return super()._default_value(addr, size, **kwargs)


class KeyValueMemory(KeyValueMemoryMixin):
    pass


class JavaVmMemory(JavaVmMemoryMixin):
    pass


<mask token>
SimState.register_default('sym_memory', DefaultMemory)
SimState.register_default('fast_memory', FastMemory)
SimState.register_default('abs_memory', AbstractMemory)
SimState.register_default('keyvalue_memory', KeyValueMemory)
SimState.register_default('javavm_memory', JavaVmMemory)

# pylint:disable=abstract-method
from typing import Iterable, Tuple, Dict, Any, Optional

import claripy

from ...state_plugins.plugin import SimStatePlugin
from ...errors import SimMemoryError


class MemoryMixin(SimStatePlugin):
    SUPPORTS_CONCRETE_LOAD = False

    def __init__(self, memory_id=None, endness="Iend_BE"):
        super().__init__()
        self.id = memory_id
        self.endness = endness

    def copy(self, memo):
        o = type(self).__new__(type(self))
        o.id = self.id
        o.endness = self.endness
        return o

    @property
    def category(self):
        """
        Return the category of this SimMemory instance. It can be one of the three following categories: reg, mem,
        or file.
        """

        if self.id in ("reg", "mem"):
            return self.id

        elif self.id.startswith("file"):
            return "file"

        elif "_" in self.id:
            return self.id.split("_")[0]

        else:
            raise SimMemoryError('Unknown SimMemory category for memory_id "%s"' % self.id)

    @property
    def variable_key_prefix(self):
        s = self.category
        if s == "file":
            return (s, self.id)
        return (s,)

    def find(self, addr, data, max_search, **kwargs):
        pass

    def _add_constraints(self, c, add_constraints=True, condition=None, **kwargs):
        if add_constraints:
            if condition is not None:
                to_add = (c & condition) | ~condition
            else:
                to_add = c
            self.state.add_constraints(to_add)

    def load(self, addr, **kwargs):
        pass

    def store(self, addr, data, **kwargs):
        pass

    def merge(self, others, merge_conditions, common_ancestor=None) -> bool:
        pass

    def widen(self, others):
        pass

    def permissions(self, addr, permissions=None, **kwargs):
        pass

    def map_region(self, addr, length, permissions, init_zero=False, **kwargs):
        pass

    def unmap_region(self, addr, length, **kwargs):
        pass

    # Optional interface:
    def concrete_load(self, addr, size, writing=False, **kwargs) -> memoryview:
        """
        Set SUPPORTS_CONCRETE_LOAD to True and implement concrete_load if reading concrete bytes is faster in this
        memory model.

        :param addr:    The address to load from.
        :param size:    Size of the memory read.
        :param writing:
        :return:        A memoryview into the loaded bytes.
        """
        raise NotImplementedError()

    def erase(self, addr, size=None, **kwargs) -> None:
        """
        Set [addr:addr+size) to uninitialized. In many cases this will be faster than overwriting those locations with
        new values. This is commonly used during static data flow analysis.

        :param addr:    The address to start erasing.
        :param size:    The number of bytes for erasing.
        :return:        None
        """
        raise NotImplementedError()

    def _default_value(self, addr, size, name=None, inspect=True, events=True, key=None, **kwargs):
        """
        Override this method to provide default values for a variety of edge cases and base cases.

        :param addr:    If this value is being filled to provide a default memory value, this will be its address.
                        Otherwise, None.
        :param size:    The size in bytes of the value to return
        :param name:    A descriptive identifier for the value, for if a symbol is created.

        The ``inspect``, ``events``, and ``key`` parameters are for ``state.solver.Unconstrained``, if it is used.
        """
        pass

    def _merge_values(self, values: Iterable[Tuple[Any, Any]], merged_size: int, **kwargs) -> Optional[Any]:
        """
        Override this method to provide value merging support.

        :param values:          A collection of values with their merge conditions.
        :param merged_size:     The size (in bytes) of the merged value.
        :return:                The merged value, or None to skip merging of the current value.
        """
        raise NotImplementedError()

    def _merge_labels(self, labels: Iterable[Dict], **kwargs) -> Optional[Dict]:
        """
        Override this method to provide label merging support.

        :param labels:          A collection of labels.
        :return:                The merged label, or None to skip merging of the current label.
        """
        raise NotImplementedError()

    def replace_all(self, old: claripy.ast.BV, new: claripy.ast.BV):
        raise NotImplementedError()

    def _replace_all(self, addrs: Iterable[int], old: claripy.ast.BV, new: claripy.ast.BV):
        raise NotImplementedError()

    def copy_contents(self, dst, src, size, condition=None, **kwargs):
        """
        Override this method to provide faster copying of large chunks of data.

        :param dst:     The destination of copying.
        :param src:     The source of copying.
        :param size:    The size of copying.
        :param condition:   The storing condition.
        :param kwargs:      Other parameters.
        :return:        None
        """
        raise NotImplementedError()


from .actions_mixin import ActionsMixinHigh, ActionsMixinLow
from .address_concretization_mixin import AddressConcretizationMixin
from .bvv_conversion_mixin import DataNormalizationMixin
from .clouseau_mixin import InspectMixinHigh
from .conditional_store_mixin import ConditionalMixin
from .convenient_mappings_mixin import ConvenientMappingsMixin
from .default_filler_mixin import DefaultFillerMixin, SpecialFillerMixin, ExplicitFillerMixin
from .dirty_addrs_mixin import DirtyAddrsMixin
from .hex_dumper_mixin import HexDumperMixin
from .label_merger_mixin import LabelMergerMixin
from .multi_value_merger_mixin import MultiValueMergerMixin
from .name_resolution_mixin import NameResolutionMixin
from .simplification_mixin import SimplificationMixin
from .simple_interface_mixin import SimpleInterfaceMixin
from .size_resolution_mixin import SizeNormalizationMixin, SizeConcretizationMixin
from .smart_find_mixin import SmartFindMixin
from .symbolic_merger_mixin import SymbolicMergerMixin
from .top_merger_mixin import TopMergerMixin
from .underconstrained_mixin import UnderconstrainedMixin
from .unwrapper_mixin import UnwrapperMixin

from .paged_memory.page_backer_mixins import ClemoryBackerMixin, ConcreteBackerMixin, DictBackerMixin
from .paged_memory.paged_memory_mixin import (
    PagedMemoryMixin,
    ListPagesMixin,
    UltraPagesMixin,
    ListPagesWithLabelsMixin,
    MVListPagesMixin,
    MVListPagesWithLabelsMixin,
)
from .paged_memory.privileged_mixin import PrivilegedPagingMixin
from .paged_memory.stack_allocation_mixin import StackAllocationMixin
from .paged_memory.pages import *

from .slotted_memory import SlottedMemoryMixin
from .regioned_memory import (
    RegionedMemoryMixin,
    RegionCategoryMixin,
    StaticFindMixin,
    AbstractMergerMixin,
    MemoryRegionMetaMixin,
    RegionedAddressConcretizationMixin,
)
from .keyvalue_memory import KeyValueMemoryMixin
from .javavm_memory import JavaVmMemoryMixin


class DefaultMemory(
    HexDumperMixin,
    SmartFindMixin,
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    InspectMixinHigh,
    ActionsMixinHigh,
    UnderconstrainedMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    AddressConcretizationMixin,
    # InspectMixinLow,
    ActionsMixinLow,
    ConditionalMixin,
    ConvenientMappingsMixin,
    DirtyAddrsMixin,
    # -----
    StackAllocationMixin,
    ConcreteBackerMixin,
    ClemoryBackerMixin,
    DictBackerMixin,
    PrivilegedPagingMixin,
    UltraPagesMixin,
    DefaultFillerMixin,
    SymbolicMergerMixin,
    PagedMemoryMixin,
):
    pass


class DefaultListPagesMemory(
    HexDumperMixin,
    SmartFindMixin,
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    ActionsMixinHigh,
    UnderconstrainedMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    InspectMixinHigh,
    AddressConcretizationMixin,
    # InspectMixinLow,
    ActionsMixinLow,
    ConditionalMixin,
    ConvenientMappingsMixin,
    DirtyAddrsMixin,
    # -----
    StackAllocationMixin,
    ClemoryBackerMixin,
    DictBackerMixin,
    PrivilegedPagingMixin,
    ListPagesMixin,
    DefaultFillerMixin,
    SymbolicMergerMixin,
    PagedMemoryMixin,
):
    pass


class FastMemory(
    NameResolutionMixin,
    SimpleInterfaceMixin,
    SimplificationMixin,
    InspectMixinHigh,
    ConditionalMixin,
    ExplicitFillerMixin,
    DefaultFillerMixin,
    SlottedMemoryMixin,
):
    pass


class AbstractMemory(
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    InspectMixinHigh,
    ActionsMixinHigh,
    UnderconstrainedMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    # InspectMixinLow,
    ActionsMixinLow,
    ConditionalMixin,
    RegionedAddressConcretizationMixin,
    # -----
    RegionedMemoryMixin,
):
    pass


class RegionedMemory(
    RegionCategoryMixin,
    MemoryRegionMetaMixin,
    StaticFindMixin,
    UnwrapperMixin,
    NameResolutionMixin,
    DataNormalizationMixin,
    SimplificationMixin,
    SizeConcretizationMixin,
    SizeNormalizationMixin,
    AddressConcretizationMixin,
    ConvenientMappingsMixin,
    DirtyAddrsMixin,
    # -----
    ClemoryBackerMixin,
    DictBackerMixin,
    UltraPagesMixin,
    DefaultFillerMixin,
    AbstractMergerMixin,
    PagedMemoryMixin,
):
    pass


class LabeledMemory(
    SizeNormalizationMixin,
    ListPagesWithLabelsMixin,
    DefaultFillerMixin,
    TopMergerMixin,
    LabelMergerMixin,
    PagedMemoryMixin,
):
    """
    LabeledMemory is used in static analysis. It allows storing values with labels, such as `Definition`.
    """

    def _default_value(self, addr, size, **kwargs):
        # TODO: Make _default_value() a separate Mixin

        if kwargs.get("name", "").startswith("merge_uc_"):
            # this is a hack. when this condition is satisfied, _default_value() is called inside Listpage.merge() to
            # create temporary values. we simply return a TOP value here.
            return self.state.top(size * self.state.arch.byte_width)

        # we never fill default values for non-existent loads
        kwargs["fill_missing"] = False
        return super()._default_value(addr, size, **kwargs)


class MultiValuedMemory(
    SizeNormalizationMixin,
    MVListPagesMixin,
    DefaultFillerMixin,
    MultiValueMergerMixin,
    PagedMemoryMixin,
):
    def _default_value(self, addr, size, **kwargs):
        # TODO: Make _default_value() a separate Mixin

        if kwargs.get("name", "").startswith("merge_uc_"):
            # this is a hack. when this condition is satisfied, _default_value() is called inside Listpage.merge() to
            # create temporary values. we simply return a TOP value here.
            return self.state.top(size * self.state.arch.byte_width)

        # we never fill default values for non-existent loads
        kwargs["fill_missing"] = False
        return super()._default_value(addr, size, **kwargs)


class KeyValueMemory(
    KeyValueMemoryMixin,
):
    pass


class JavaVmMemory(
    JavaVmMemoryMixin,
):
    pass


from angr.sim_state import SimState

SimState.register_default("sym_memory", DefaultMemory)
SimState.register_default("fast_memory", FastMemory)
SimState.register_default("abs_memory", AbstractMemory)
SimState.register_default("keyvalue_memory", KeyValueMemory)
SimState.register_default("javavm_memory", JavaVmMemory)
