import os
import re
import subprocess
import logging
from multiprocessing import cpu_count

import riscof.utils as utils
from riscof.pluginTemplate import pluginTemplate

logger = logging.getLogger()

class rs5(pluginTemplate):
    __model__ = "RS5"
    __version__ = "XXX"

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        config = kwargs.get('config')

        # At minimum we need the paths to the ispec and pspec files
        if config is None:
            print("Please enter input file paths in configuration.")
            raise SystemExit(1)

        # Number of parallel jobs that can be spawned off by RISCOF
        self.num_jobs = str(cpu_count())

        # Path to the directory where this python file is located
        self.pluginpath=os.path.abspath(config['pluginpath'])

        # Collect the paths to the riscv-config absed ISA and platform yaml files
        self.isa_spec = os.path.abspath(config['ispec'])
        self.platform_spec = os.path.abspath(config['pspec'])

        self.triplet = os.environ["TRIPLET"]

        # If you are interested in just compiling the tests and not running
        if 'target_run' in config and config['target_run']=='0':
            self.target_run = False
        else:
            self.target_run = True

    def initialise(self, suite, work_dir, archtest_env):
        # capture the working directory
        self.work_dir = work_dir

        # capture the architectural test-suite directory.
        self.suite_dir = suite

        # Note the march is not hardwired here, because it will change for each test
        self.compile_cmd = self.triplet + '-gcc -march={0} \
            -static -mcmodel=medany -fvisibility=hidden -nostdlib -nostartfiles -g\
            -T '+self.pluginpath+'/env/link.ld\
            -I '+self.pluginpath+'/env/\
            -I ' + archtest_env + ' {2} -o {3} {4}'
        
        # set up the simulation command
        dut_dir = self.pluginpath + '/../../'
        self.verilatecmd = f'verilator --cc --exe --binary --timescale 1ns/1ns -j 0\
            -I{dut_dir}/RingBuffer/rtl/\
            -I{dut_dir}/rtl/\
            -I{dut_dir}/sim/\
            -I{dut_dir}/rtl/aes\
            {dut_dir}/riscof/riscof_tb.sv'

    def build(self, isa_yaml, platform_yaml):
        # load the isa yaml as a dictionary in python.
        ispec = utils.load_yaml(isa_yaml)['hart0']

        # capture the XLEN value by picking the max value in 'supported_xlen' field of isa yaml
        self.xlen = ('64' if 64 in ispec['supported_xlen'] else '32')

        # '--isa' argument
        self.isa = 'rv' + self.xlen
        if "I" not in ispec["ISA"]:
            print("ISA should contain I.")
            raise SystemExit(1)
        if "M" in ispec["ISA"]:
            self.verilatecmd += " -GMEnable=1\\'b1"
        if "A" in ispec["ISA"]:
            self.verilatecmd += " -GAEnable=1\\'b1"
        if "C" in ispec["ISA"]:
            self.verilatecmd += " -GCOMPRESSED=1\\'b1"
        if "U" not in ispec["ISA"]:
            print("ISA should contain U.")
            raise SystemExit(1)
        if "Zicond" in ispec["ISA"]:
            self.verilatecmd += " -GZICONDEnable=1\\'b1"
        if "Zicsr" not in ispec["ISA"]:
            print("ISA should contain Zicsr.")
            raise SystemExit(1)
        if "Zihpm" in ispec["ISA"]:
            self.verilatecmd += " -GHPMCOUNTEREnable=1\\'b1"
        if "Zkne" in ispec["ISA"]:
            self.verilatecmd += " -GZKNEEnable=1\\'b1"
        if "Zcb" in ispec["ISA"]:
            self.verilatecmd += " -GZCBEnable=1\\'b1"
        if "Zbkb" in ispec["ISA"]:
            self.verilatecmd += " -GZBKBEnable=1\\'b1"
        if "Zknh" in ispec["ISA"]:
            self.verilatecmd += " -GZKNHEnable=1\\'b1"

        self.verilatecmd += " -GBRANCHPRED=1\\'b" + os.environ["BRANCHPRED"]
        self.verilatecmd += " -GFORWARDING=1\\'b" + os.environ["FORWARDING"]
        self.verilatecmd += " -GDUALPORT_MEM=1\\'b" + os.environ["DUALPORT_MEM"]
        self.verilatecmd += " -GIQUEUE_SIZE=" + os.environ["IQUEUE_SIZE"]
        self.verilatecmd += " -GDELAY_CYCLES=" + os.environ["DELAY_CYCLES"]

        self.compile_cmd = self.compile_cmd+' -mabi='+('lp64 ' if 64 in ispec['supported_xlen'] else 'ilp32 ')

    def runTests(self, testList):
        # Delete Makefile if it already exists.
        if os.path.exists(self.work_dir+ "/Makefile." + self.name[:-1]):
            os.remove(self.work_dir+ "/Makefile." + self.name[:-1])
        
        # create an instance the makeUtil class that we will use to create targets.
        make = utils.makeUtil(makefilePath=os.path.join(self.work_dir, "Makefile." + self.name[:-1]))

        # set the make command that will be used
        make.makeCommand = 'make -k -j' + self.num_jobs

        # we will iterate over each entry in the testList
        for testname in testList:
            # for each testname we get all its fields (as described by the testList format)
            testentry = testList[testname]

            # we capture the path to the assembly file of this test
            test = testentry['test_path']

            # capture the directory where the artifacts of this test
            test_dir = testentry['work_dir']

            # name of the elf file after compilation of the test
            elf = os.path.join(test_dir,"my.elf")

            # name of the signature file
            sig_file = os.path.join(test_dir, self.name[:-1] + ".signature")

            # for each test there are specific compile macros that need to be enabled
            compile_macros= ' -D' + " -D".join(testentry['macros'])

            # substitute all variables in the compile command
            cmd = self.compile_cmd.format(testentry['isa'].lower(), self.xlen, test, elf, compile_macros)

            if self.target_run:
                subprocess.run(cmd.split())
                symbols = subprocess.check_output([self.triplet+"-readelf", elf, "-s"]).split(b'\n')[3:]

                tohost_addr = ""
                signature_start = ""
                signature_end = ""

                for line in symbols[:-1]: 
                    l = line.split()
                    addr = l[1]
                    sym = l[-1]

                    if sym == b'tohost':
                        tohost_addr = addr.decode('utf-8')
                    elif sym == b'begin_signature':
                        signature_start = addr.decode('utf-8')
                    elif sym == b'end_signature':
                        signature_end = addr.decode('utf-8')

                # generate .bin
                objcopycmd = f'{self.triplet}-objcopy {elf} test.bin -O binary' 

                verilatecmd = self.verilatecmd + f"\
                    -GSIG_START=32\\'h{signature_start}\
                    -GSIG_END=32\\'h{signature_end}\
                    -GTOHOST_ADDR=32\\'h{tohost_addr}\
                    -GSIG_PATH='\"{sig_file}\"'"

                simcmd = './obj_dir/Vriscof_tb'
            else:
                simcmd = 'echo "NO RUN"'
                verilatecmd = ''
                objcopycmd = ''

            # concatenate all commands that need to be executed within a make-target.
            execute = 'cd {}; {}; {}; {}; {};'.format(testentry['work_dir'], cmd, objcopycmd, verilatecmd, simcmd)

            # create a target
            make.add_target(execute)

        # run all the targets in parallel using the make command set above
        make.execute_all(self.work_dir)

        # if target runs are not required then we simply exit
        if not self.target_run:
            raise SystemExit(0)
