Constraints.pm

#-----------------------------------------------------------------------
# Fault InJection Instrumenter (FIJI)
# https://embsys.technikum-wien.at/projects/vecs/fiji
#
# The creation of this file has been supported by the publicly funded
# R&D project Josef Ressel Center for Verification of Embedded Computing
# Systems (VECS) managed by the Christian Doppler Gesellschaft (CDG).
#
# Authors:
# Christian Fibich <fibich@technikum-wien.at>
# Stefan Tauner <tauner@technikum-wien.at>
#
# This module is free software; you can redistribute it and/or modify
# it under the same terms as Perl itself.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# See the LICENSE file for more details.
#-----------------------------------------------------------------------

## @file Constraints.pm
# @brief Contains class \ref FIJI::Constraints

## @class FIJI::Constraints
# @brief Contains functions to generate Constraints for Synthesis/P&R Tools

package FIJI::Constraints;

use strict;
use warnings;

use Log::Log4perl qw(get_logger);

use FIJI qw(:fiji_version);

sub _quartus_partitions_logiclock {
    my $logger = get_logger("");
    my $cfg    = shift;

    my $DUT_TO  = $cfg->{'dut_module'} . ":" . $cfg->{'dut_inst'};
    my $FIJI_TO = $cfg->{'fiji_module'} . ":" . $cfg->{'fiji_inst'};

    my $DUT_PART_NAME  = "PARTITION_" . $cfg->{'dut_module'};
    my $FIJI_PART_NAME = "PARTITION_" . $cfg->{'fiji_module'};
    my $DUT_COLOR      = (sprintf("%d", 0xFF0000));
    my $FIJI_COLOR     = (sprintf("%d", 0x00FF00));

    my $time = localtime;
    my $fiji_version = FIJI_VERSION;
    my $design_id = sprintf("0x%04x", $cfg->{'id'});

    my $txt = <<"END_HDR";
# ------------------------------------------------------------------------------
# FIJI Physical Placement Constraints File for Quartus II
#
# Generated at $time
# by FIJI $fiji_version
# for Design ID $design_id
# ------------------------------------------------------------------------------
END_HDR
    my $fin = "# EOF";

    my $partitioning = <<"END_PARTITION";
set_global_assignment -name PARTITION_NETLIST_TYPE POST_SYNTH -section_id $DUT_PART_NAME
set_global_assignment -name PARTITION_COLOR $DUT_COLOR -section_id $DUT_PART_NAME
set_global_assignment -name PARTITION_NETLIST_TYPE POST_SYNTH -section_id $FIJI_PART_NAME
set_global_assignment -name PARTITION_COLOR $FIJI_COLOR -section_id $FIJI_PART_NAME
set_instance_assignment -name PARTITION_HIERARCHY root_partition -to | -section_id Top
set_instance_assignment -name PARTITION_HIERARCHY db/dut1 -to $DUT_TO -section_id $DUT_PART_NAME
set_instance_assignment -name PARTITION_HIERARCHY db/fiji1 -to $FIJI_TO -section_id $FIJI_PART_NAME

END_PARTITION

    my $area = <<"END_LOCK";
set_global_assignment -name LL_ENABLED ON -section_id $DUT_PART_NAME
set_global_assignment -name LL_AUTO_SIZE ON -section_id $DUT_PART_NAME
set_global_assignment -name LL_STATE FLOATING -section_id $DUT_PART_NAME
set_global_assignment -name LL_WIDTH 1 -section_id $DUT_PART_NAME
set_global_assignment -name LL_HEIGHT 1 -section_id $DUT_PART_NAME
set_global_assignment -name LL_ORIGIN X1_Y1 -section_id $DUT_PART_NAME
set_instance_assignment -name LL_MEMBER_OF $DUT_PART_NAME -to $DUT_TO -section_id $DUT_PART_NAME

set_global_assignment -name LL_ENABLED ON -section_id $FIJI_PART_NAME
set_global_assignment -name LL_AUTO_SIZE ON -section_id $FIJI_PART_NAME
set_global_assignment -name LL_STATE FLOATING -section_id $FIJI_PART_NAME
set_global_assignment -name LL_WIDTH 1 -section_id $FIJI_PART_NAME
set_global_assignment -name LL_HEIGHT 1 -section_id $FIJI_PART_NAME
set_global_assignment -name LL_ORIGIN X1_Y1 -section_id $FIJI_PART_NAME
set_instance_assignment -name LL_MEMBER_OF $FIJI_PART_NAME -to $FIJI_TO -section_id $FIJI_PART_NAME
END_LOCK

    if ($cfg->{'mode'} eq "OPT_OFF") {
        $txt .= $partitioning;
    } elsif ($cfg->{'mode'} eq "FIX_PLACEMENT") {
        $txt .= $partitioning . $area;
    } elsif ($cfg->{'mode'} ne "ALLOW") {
        $logger->error("Unknown SYNTHESIS_MODE " . $cfg->{'mode'});
        return undef;
    }
    return ($txt . $fin , 'quartus.qsf');
}

sub _synplify_optimizations {
    my $logger = get_logger("");
    my $cfg    = shift;

    my $DUT_NAME  = $cfg->{'dut_module'};
    my $FIJI_NAME = $cfg->{'fiji_module'};

    my $time = localtime;
    my $fiji_version = FIJI_VERSION;
    my $design_id = sprintf("0x%04x", $cfg->{'id'});

    my $txt = <<"END_HDR";
# ------------------------------------------------------------------------------
# FIJI Constraints File for Synplify
#
# Generated at $time
# by FIJI $fiji_version
# for Design ID $design_id
# ------------------------------------------------------------------------------
END_HDR
    my $fin = "# EOF";

    my $no_optimization = <<"END_OPTIMIZATION";
###==== BEGIN Attributes 
define_compile_point {v:work.$DUT_NAME} -type {locked}
define_compile_point {v:work.$FIJI_NAME} -type {locked}
define_attribute {v:work.$DUT_NAME}  syn_allow_retiming {0}
define_attribute {v:work.$DUT_NAME}  syn_sharing {0}
define_attribute {v:work.$DUT_NAME}  syn_pipeline {0}
define_attribute {v:work.$DUT_NAME}  syn_netlist_hierarchy {1}
###==== END Attributes 
END_OPTIMIZATION

    if ($cfg->{'mode'} eq "OPT_OFF" || $cfg->{'mode'} eq "FIX_PLACEMENT") {
        $txt .= $no_optimization;
    } elsif ($cfg->{'mode'} ne "ALLOW") {
        $logger->error("Unknown SYNTHESIS_MODE " . $cfg->{'mode'});
        return undef;
    }
    return ($txt . $fin, 'synplify.fdc');
}

sub _vivado_pblocks {
    my $logger = get_logger("");
    my $cfg    = shift;

    my $DUT_NAME    = $cfg->{'dut_inst'};
    my $FIJI_NAME   = $cfg->{'fiji_gen'}.'.'.$cfg->{'fiji_inst'};
    my $FIJI_PBLOCK = $cfg->{'fiji_gen'}.'_'.$cfg->{'fiji_inst'};


    my $time      = localtime;
    my $fiji_version = FIJI_VERSION;
    my $design_id = sprintf("0x%04x", $cfg->{'id'});
    my $txt = <<"END_HDR";
# ------------------------------------------------------------------------------
# FIJI Constraints File for Vivado
#
# Generated at $time
# by FIJI $fiji_version
# for Design ID $design_id
# ------------------------------------------------------------------------------
END_HDR
    my $fin = "# EOF";
    my $no_opt = <<"END_NO_OPT";
# Turn off cross-boundary optimizations

# do not even look at the original netlist
set_property dont_touch TRUE [get_cells -quiet [list $DUT_NAME]]

# do not optimize accross FIJI boundaries
set_property keep_hierarchy TRUE [get_cells -quiet [list $FIJI_NAME]]

END_NO_OPT

    my $area = <<"END_AREA";

# Create physical constraints for FIJI and DUI

create_pblock pblock_$DUT_NAME
create_pblock pblock_$FIJI_PBLOCK
add_cells_to_pblock [get_pblocks pblock_$DUT_NAME] [get_cells -quiet [list $DUT_NAME]]
add_cells_to_pblock [get_pblocks pblock_$FIJI_PBLOCK] [get_cells -quiet [list $FIJI_NAME]]

# Set size and location of the PBlocks. This default size will likely fail.
# You will likely need to resize them in the GUI.
resize_pblock [get_pblocks pblock_$DUT_NAME] -add {SLICE_X1Y1:SLICE_X10Y10}
resize_pblock [get_pblocks pblock_$FIJI_PBLOCK] -add {SLICE_X11Y1:SLICE_X15Y3}
END_AREA
    if ($cfg->{'mode'} eq "FIX_PLACEMENT") {
        $txt .= $no_opt;
        $txt .=  $area;
    } elsif ($cfg->{'mode'} eq "OPT_OFF") {
        $txt .= $no_opt;
    } elsif ($cfg->{'mode'} ne "ALLOW" && $cfg->{'mode'} ne "OPT_OFF") {
        $logger->error("Unknown SYNTHESIS_MODE " . $cfg->{'mode'});
        return undef;
    }
    return ($txt . $fin, 'vivado.xdc');
}

## @var %$toolhash stores which sub to execute for which tool
my $syn_toolhash = {
    SYNPLIFY_PRO => {
        ALTERA_QUARTUS => \&_synplify_optimizations,
        XILINX_VIVADO  => \&_synplify_optimizations,
    },
};

my $pr_toolhash = {
    ALTERA_QUARTUS => \&_quartus_partitions_logiclock,
    XILINX_VIVADO  => \&_vivado_pblocks,
};

sub generate_constraints {
    my $logger = get_logger("");
    my ($class, $synthesis_tool, $pr_tool, $cfg, $basename) = @_;

    my ($file,$txt,$postfix);

    my $synhash = $syn_toolhash->{$synthesis_tool};
    my $prhash  = $pr_toolhash->{$pr_tool};

    return "No entries for synthesis tool found" if (!defined $synhash);
    return "No entries for P&R tool found" if (!defined $prhash);

    my $sub = $synhash->{$pr_tool};

    return "No subentries for P&R tool in Synthesis toolhash found" if (!defined $sub);

    ($txt, $postfix) = &{$sub}($cfg);
    return "Could not generate constraints for $synthesis_tool/$pr_tool." if (!defined $txt);

    my $filename = $basename.'.'.$postfix;

    open($file, ">", $filename) or return "Cannot open file $filename: $!";
    print $file $txt;
    close($file) or return "Cannot close file $filename: $!";
    $logger->info("Successfully generated synthesis constraints for $synthesis_tool/$pr_tool.");

    ($txt, $postfix) = &{$prhash}($cfg);
    return "Could not generate P&R constraints for $pr_tool." if (!defined $txt);
    $filename = $basename.'.'.$postfix;

    open($file, ">", $filename) or return "Cannot open file $filename: $!";
    print $file $txt;
    close($file) or return "Cannot close file $filename: $!";
    $logger->info("Successfully generated P&R constraints for $pr_tool.");

    return undef;
}

1;