# Copyright (c) 2012 ARM Limited
# All rights reserved.
#
# The license below extends only to copyright in the software and shall
# not be construed as granting a license to any other intellectual
# property including but not limited to intellectual property relating
# to a hardware implementation of the functionality of the software
# licensed hereunder.  You may use the software subject to the license
# terms below provided that you ensure that this notice is replicated
# unmodified and in its entirety in all distributions of the software,
# modified or unmodified, in source code or in binary form.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from abc import ABCMeta, abstractmethod
import m5
from m5.objects import *
from m5.proxy import *

m5.util.addToPath("../configs/")
from common.Benchmarks import SysConfig
from common import FSConfig, SysPaths
from common.Caches import *
from base_config import *


class LinuxX86SystemBuilder(object):
    """Mix-in that implements create_system.

    This mix-in is intended as a convenient way of adding an
    X86-specific create_system method to a class deriving from one of
    the generic base systems.
    """

    def __init__(self):
        pass

    def create_system(self):
        mdesc = SysConfig(disks=["linux-x86.img"])
        system = FSConfig.makeLinuxX86System(
            self.mem_mode, numCPUs=self.num_cpus, mdesc=mdesc
        )
        system.kernel = SysPaths.binary("x86_64-vmlinux-2.6.22.9")

        self.init_system(system)
        return system


class LinuxX86FSSystem(LinuxX86SystemBuilder, BaseFSSystem):
    """Basic X86 full system builder."""

    def __init__(self, **kwargs):
        """Initialize an X86 system that supports full system simulation.

        Note: Keyword arguments that are not listed below will be
        passed to the BaseFSSystem.

        Keyword Arguments:
          machine_type -- String describing the platform to simulate
        """
        BaseSystem.__init__(self, **kwargs)
        LinuxX86SystemBuilder.__init__(self)

    def create_caches_private(self, cpu):
        cpu.addPrivateSplitL1Caches(
            L1_ICache(size="32kB", assoc=1),
            L1_DCache(size="32kB", assoc=4),
            PageTableWalkerCache(),
            PageTableWalkerCache(),
        )


class LinuxX86FSSystemUniprocessor(
    LinuxX86SystemBuilder, BaseFSSystemUniprocessor
):
    """Basic X86 full system builder for uniprocessor systems.

    Note: This class is a specialization of the X86FSSystem and is
    only really needed to provide backwards compatibility for existing
    test cases.
    """

    def __init__(self, **kwargs):
        BaseFSSystemUniprocessor.__init__(self, **kwargs)
        LinuxX86SystemBuilder.__init__(self)

    def create_caches_private(self, cpu):
        cpu.addTwoLevelCacheHierarchy(
            L1_ICache(size="32kB", assoc=1),
            L1_DCache(size="32kB", assoc=4),
            L2Cache(size="4MB", assoc=8),
            PageTableWalkerCache(),
            PageTableWalkerCache(),
        )


class LinuxX86FSSwitcheroo(LinuxX86SystemBuilder, BaseFSSwitcheroo):
    """Uniprocessor X86 system prepared for CPU switching"""

    def __init__(self, **kwargs):
        BaseFSSwitcheroo.__init__(self, **kwargs)
        LinuxX86SystemBuilder.__init__(self)