#!/usr/bin/python3

# Symbiflow Stage Module

# ----------------------------------------------------------------------------- #

import os
from sf_common import *
from sf_module import *

# ----------------------------------------------------------------------------- #

def default_output_name(place_constraints):
    p = place_constraints
    m = re.match('(.*)\\.[^.]*$', place_constraints)
    if m:
        p = m.groups()[0] + '.place'
    else:
        p += '.place'
    return p

def place_constraints_file(ctx: ModuleContext):
    dummy =- False
    p = ctx.takes.place_constraints
    if not p:
        p = ctx.takes.io_place
    if not p:
        dummy = True
        p = file_noext(ctx.takes.eblif) + '.place'
    
    return p, dummy

class PlaceModule(Module):
    def map_io(self, ctx: ModuleContext):
        mapping = {}
        p, _ = place_constraints_file(ctx)
        
        mapping['place'] = default_output_name(p)
        return mapping
    
    def execute(self, ctx: ModuleContext):
        place_constraints, dummy = place_constraints_file(ctx)
        place_constraints = os.path.realpath(place_constraints)
        if dummy:
            with open(place_constraints, 'wb') as f:
                f.write(b'')
        
        build_dir = os.path.dirname(ctx.takes.eblif)

        vpr_options = ['--fix_clusters', place_constraints]
        
        yield 'Running VPR...'
        vprargs = VprArgs(ctx.share, ctx.takes.eblif, ctx.values,
                          sdc_file=ctx.takes.sdc, vpr_extra_opts=vpr_options)
        vpr('place', vprargs, cwd=build_dir)
        
        # VPR names output on its own. If user requested another name, the
        # output file should be moved.
        # TODO: This extends the set of names that would cause collisions.
        # As for now (22-07-2021), no collision detection is being done, but
        # when the problem gets tackled, we should keep in mind that VPR-based
        # modules may produce some temporary files with names that differ from
        # the ones in flow configuration.
        if ctx.is_output_explicit('place'):
            output_file = default_output_name(place_constraints)
            shutil.move(output_file, ctx.outputs.place)

        yield 'Saving log...'
        save_vpr_log('place.log', build_dir=build_dir)

    def __init__(self, _):
        self.name = 'place'
        self.no_of_phases = 2
        self.takes = [
            'eblif',
            'sdc?',
            'place_constraints?',
            'io_place?'
        ]
        self.produces = [ 'place' ]
        self.values = [
            'device',
            'vpr_options?'
        ] + vpr_specific_values()

ModuleClass = PlaceModule