Settings.pm

## @file

## @class FIJI::Settings
#
# Contains helper functions to deal with FIJI Settings files.
package FIJI::Settings;

use strict;
use warnings;

use Scalar::Util 'blessed';
use Log::Log4perl qw(get_logger);
use Scalar::Util "looks_like_number";
use Clone qw(clone);
use Config::Simple;

use FIJI qw(:all);

## @function new ($phase, $fiji_ini_file, $existing_settings)
# Create a new settings instance.
#
# \param $phase Tool flow phase the settings need to be compatible with.
# \param $fiji_ini_file (optional) Path to the configuration file to read.
# \param $existing_settings (optional) An instance to reuse and return
#        after overwriting existing values with defaults and any values
#        read from file. Existing values will not be validated.
#        Superfluous elements not present in the existing hash will be
#        removed, e.g. FIUs.
# \returns The new settings instance or a string describing the reason
#          why it could not be created.
sub new ($;$$) {
  my $logger = get_logger();
  my ($class, $phase, $fiji_ini_file, $existing_settings) = @_;

  my $fiji_settings_ref;
  # if there are no existing settings yet, create some with default values
  if (!defined($existing_settings)) {
    $fiji_settings_ref = {};
    $fiji_settings_ref->{'design'} = {};
    _set_defaults(DESIGNMAP, $fiji_settings_ref->{'design'}, $phase);
    $fiji_settings_ref = bless($fiji_settings_ref, $class);
    if (!ref($fiji_settings_ref) || !UNIVERSAL::can($fiji_settings_ref,'can')) {
      my $msg = "Could not bless FIJI::Settings class from \"$fiji_ini_file\".";
      $logger->error($msg);
      return $msg;
    }
  } else {
    $fiji_settings_ref = _clone($existing_settings);
  }

  if (defined($fiji_ini_file)) {
    $fiji_settings_ref = read_settingsfile($phase, $fiji_ini_file, $fiji_settings_ref);
    if (!ref($fiji_settings_ref)) {
      return $fiji_settings_ref; # actually an error message
    }
    if (defined($existing_settings)) {
      return $existing_settings;
    }
  } else {
    $fiji_settings_ref->{'FIUs'} = ();
  }
  return $fiji_settings_ref;
}


sub _export_value {
  my $logger = get_logger();
  my ($map_ref, $k, $v_ref) = @_;

  if (defined($map_ref->{$k}->{'type'})) {
    my $orig = ${$v_ref};
    if ($map_ref->{$k}->{'type'} eq 'hexadecimal') {
      ${$v_ref} = sprintf("0x%x", $orig);
    # } elsif ($map_ref->{$k}->{'type'} eq 'natural') {
    # } elsif ($map_ref->{$k}->{'type'} eq 'boolean') {
      $logger->trace("Converted value of $k (\"$orig\") to \"${$v_ref}\".") if ($orig ne ${$v_ref});
    }
  # } elsif (defined($map_ref->{$k}->{'values'})) {
  }
}

## @method save ($fiji_ini_file)
# @brief Store contained FIJI Settings to file.
#
# @ATTENTION Will happily overwrite existing files!
#
# \param fiji_ini_file The file name to write the FIJI Settings to.
sub save ($) {
  my $logger = get_logger();
  my ($self, $fiji_ini_file) = @_;
  return "No file name given" if !defined($fiji_ini_file);

  my $fiji_ini = new Config::Simple(syntax=>'ini');
  my $design_ref;
  my $fiu_cnt = 0;
  foreach my $key (keys %{$self}) {
    my $val = $self->{$key};
    $logger->debug(sprintf("Key: %s, type: %s, value: %s", $key, ref(\$val), $val));
    if (ref(\$val) eq "REF") {
      if (ref($val) eq "HASH") {
        if ($key eq "design") {
          $design_ref = $val;
          next;
        }
      } elsif (ref($val) eq "ARRAY") {
        if ($key eq "FIUs") {
          foreach my $fiu (@{$val}) {
            my $ini_fiu;
            
            foreach my $k (keys $fiu) {
              my $ini_name = FIUMAP->{$k}->{'ini_name'};
              if (!defined($fiu->{$k})) {
                $logger->debug("Skip saving undefined value of FIU constant with key $ini_name.");
                next;
              }
              # Copy value to new hash with external naming.
              $ini_fiu->{$ini_name} = $fiu->{$k};
              # Convert value to external representation
              _export_value(FIUMAP, $k, \$$fiu{$k});
              $logger->trace(sprintf("Renaming setting %s -> %s (=%s).", $k, $ini_name, defined($ini_fiu->{$ini_name}) ? $ini_fiu->{$ini_name} : "undef"));
            }
            $fiji_ini->set_block("FIU" . $fiu_cnt++, $ini_fiu);
          }
          next;
        }
      }
    }
    my $err = "Unknown element found in FIJI Settings: \"$val\"";
    $logger->error($err);
    return $err;
  }
  $design_ref->{'FIU_NUM'} = $fiu_cnt;
  my $ini_design;
  foreach my $k (keys $design_ref) {
    my $ini_name = DESIGNMAP->{$k}->{'ini_name'};
    if (!defined($design_ref->{$k})) {
      $logger->debug("Skip saving undefined value of design constant with key $ini_name.");
      next;
    }
    # Copy value to new hash with external naming.
    $ini_design->{$ini_name} = $design_ref->{$k};
    # Convert value to external representation
    _export_value(DESIGNMAP, $k, \$$design_ref{$k});
  }
  $fiji_ini->set_block("CONSTS", $ini_design);

  if (!defined($fiji_ini->write($fiji_ini_file))) {
    my $err = Config::Simple->error();
    $logger->error($err);
    return $err;
  }
  return undef;
}


## @function read_settingsfile ($phase, $fiji_ini_file)
# @brief Load the FIJI Settings file containing design and FIU constants.
#
# \param phase  Tool flow phase the settings stored in the given file
#               need to be compatible with.
# \param fiji_ini_file The name of an .ini file with FIJI Settings:
#         - a 'consts' block containing the constants specified by
#           \ref _sanitize_design.
#         - at least one FIU block named "FIU<number>" where "<number>"
#           is a strictly increasing integer starting with 0 containing
#           the constants for the respective FIU, see \ref _sanitize_fiu
#
# \returns a reference to the hash containing the read constants.
sub read_settingsfile {
  my $logger = get_logger();
  my ($phase, $fiji_ini_file, $existing_settings) = @_;
  my $fiji_ini;
  eval { $fiji_ini = new Config::Simple($fiji_ini_file) }; # pesky library tries to die on syntax errors
  if (!defined($fiji_ini)) {
    my $msg = "Could not read config file \"$fiji_ini_file\": " . (defined($@) ? $@ : Config::Simple->error());
    $logger->error($msg);
    return $msg;
  }

  my $fiji_design_cfg = $fiji_ini->get_block("CONSTS");
  if (!(%$fiji_design_cfg)) {
    my $msg = "Could not fetch CONSTS block from config file \"$fiji_ini_file\"";
    $logger->error($msg);
    return $msg;
  }

  my $fiji_design = _rename_import(DESIGNMAP, $fiji_design_cfg);
  if (!defined($fiji_design)) {
    my $msg = "Design constants do not match the FIJI Settings naming scheme.";
    $logger->error($msg);
    return $msg;
  }

  my $fiji_settings_ref;
  if (defined($existing_settings)) {
    if (!blessed($existing_settings) || !$existing_settings->isa("FIJI::Settings")) {
      my $msg ="Given settings are not of type FIJI::Settings.";
      $logger->error($msg);
      return $msg;
    }
    # overwrite existing Design Constants
    foreach my $k (keys($fiji_design)) {
      $existing_settings->{'design'}->{$k} = $fiji_design->{$k};
    }
    $fiji_design = $existing_settings->{'design'};
    if (defined($existing_settings->{'FIUs'})) {
      $fiji_settings_ref->{'FIUs'} = $existing_settings->{'FIUs'};
    } else {
      $fiji_settings_ref->{'FIUs'} = ();
    }
  } else {
    $fiji_settings_ref->{'FIUs'} = ();
  }

  # sanitize and validate read design constants
  $fiji_design = _sanitize_design($fiji_design, $phase);
  if (!ref($fiji_design)) {
    $logger->error($fiji_design);
    return $fiji_design;
  }
  $fiji_settings_ref->{'design'} = $fiji_design;

  my $fiu_num = 0;
  while (1) {
    my $fiu_name = "FIU" . $fiu_num;
    my $fiji_fiu_cfg = $fiji_ini->get_block($fiu_name);
    if (!(%$fiji_fiu_cfg)) {
      last;
    }
    my $fiji_fiu = _rename_import(FIUMAP, $fiji_fiu_cfg);
    if (!defined($fiji_design)) {
      my $msg = "FIU constants of $fiu_name do not match the FIJI Settings naming scheme.";
      $logger->error($msg);
      return $msg;
    }
    my $tmp_fiu = {};
    _set_defaults(FIUMAP, $tmp_fiu, $phase);

    if (defined($existing_settings)) {
      my $ex_fiu = @{$existing_settings->{'FIUs'}}[$fiu_num];
      if (defined($ex_fiu)) {
        # overwrite default entries
        foreach my $k (keys($ex_fiu)) {
          $tmp_fiu->{$k} = $ex_fiu->{$k};
        }
      }
      # overwrite existing FIU entries
      # $logger->trace("Overwriting values of $fiu_name.") if (defined($ex_fiu) && scalar(keys($ex_fiu)) > 0);
      foreach my $k (keys($fiji_fiu)) {
        $tmp_fiu->{$k} = $fiji_fiu->{$k};
      }
      $fiji_fiu = $tmp_fiu;
    }
    $fiji_fiu = _sanitize_fiu($fiji_fiu, $phase);
    if (!defined($fiji_fiu)) {
      my $msg = "Constants for $fiu_name in FIJI Settings are invalid";
      $logger->error($msg);
      return $msg;
    }
    @{$fiji_settings_ref->{'FIUs'}}[$fiu_num] = $fiji_fiu;
    $fiu_num++;
    $logger->trace("Read in $fiu_name from FIJI Settings file successfully.");
  }

  if ($fiu_num == 0) {
    $logger->debug("Could not fetch any FIU block from config file \"$fiji_ini_file\"");
    $fiji_settings_ref->{'FIUs'} = [];
  }

  # FIU_NUM is optional in the Settings file... if it was set check that
  # it corresponds to the number of FIU<number> blocks.
  if (defined($fiji_design->{'FIU_NUM'}) && $fiji_design->{'FIU_NUM'} != $fiu_num) {
      my $msg = FIU_NUM->{'ini_name'} . " does not match the numbers of FIU blocks found.";
      $logger->error($msg);
      return $msg;
  } else {
    $fiji_design->{'FIU_NUM'} = $fiu_num; # assume the best if FIU_NUM constant is not given
  }

  splice(@{$fiji_settings_ref->{'FIUs'}}, $fiu_num);
  $logger->info("Successfully read in design constants and $fiu_num FIU definitions from FIJI Settings file.");
  return $fiji_settings_ref;
}

## @method set_fiu_defaults (%$fiu_ref)
# @brief Overwrite existing fields (if defined) with defaults defined in FIJI.pm.
#
sub set_fiu_defaults ($) {
  my ($self, $consts_ref) = @_;
  return _set_defaults(FIUMAP, $consts_ref);
}

## @function _set_defaults (%$map_ref, %$consts_ref)
# @brief Set defaults according to FIJI.pm.
sub _set_defaults {
  my $logger = get_logger();
  my ($map_ref, $consts_ref, $phase) = @_;
  foreach my $k (keys($map_ref)) {
    if (exists($map_ref->{$k}->{'default'})) {
      # Set default only if it is not mandatory in the given phase.
      if (defined($phase) && scalar(grep {$_ eq $phase} @{$map_ref->{$k}->{'phases_opt'}}) == 0) {
        next;
      }

      $consts_ref->{$k} = $map_ref->{$k}->{default};
      $logger->trace(sprintf("Adding default constant: %s (%s) = %s.", $k, $map_ref->{$k}->{'ini_name'}, $map_ref->{$k}->{default}));
    }
  }
}


sub _clone ($) {
  my ($existing_settings_ref) = @_;
  my $new_settings_ref = \%{ Clone::clone ($existing_settings_ref) };
 return $new_settings_ref;
}


sub validate_design_value {
  my ($k, $v_ref) = @_;
  return validate_value(DESIGNMAP, $k, $v_ref);
}

sub validate_fiu_value {
  my ($k, $v_ref) = @_;
  return validate_value(FIUMAP, $k, $v_ref);
}

## @function validate_value (%$map_ref, $k, $$v_ref, $old, $log_func)
#   Do validation (and conversation from external->internal representation)
#
#   \param map_ref  reference to FIJI Settings mappings
#   \param k        key identifying the respective setting
#   \param v_ref    scalar reference to the proposed value (that may be modified)
#   \param old      (optional) previously valid value
#   \param log_func (optional) the (log4perl) log function to use
#                   (defaul is \&Log::Log4perl::Logger::trace)
sub validate_value ($$$;$$) {
  my $logger = get_logger();
  my ($map_ref, $k, $v_ref, $old, $log_func) = @_;
  $log_func = \&Log::Log4perl::Logger::trace if !defined($log_func);
  if (defined($map_ref->{$k}->{'type'})) {
    my $orig = ${$v_ref};
    # FIXME: check if the constant is depending on another constant, that needs to be enabled.
    # my $dependency = @{$map_ref->{$k}->{'depends_on'}};
    # if (defined($dependency) && defined(@{$map_ref->{$dependency}->{'value'}}
    # }

    if ($map_ref->{$k}->{'type'} eq 'net') {
      # TODO: check syntax? there is nothing more to do in here unless we supply allowed nets...
      # which is actually possible because the input netlist is stored in the settings as well
    } elsif ($map_ref->{$k}->{'type'} eq 'hexadecimal') {
      if ($orig !~ /^(0|(0[xX][[:xdigit:]]+))$/) {
        $log_func->($logger, "$k: $orig does not look like a natural hexadecimal number.");
        return 0;
      }
      ${$v_ref} = hex($orig);
      # Check for natural value range. Should never trigger due to the regex above.
      if (${$v_ref} < 0) {
        $log_func->($logger, "$k: $orig is negative.");
        return 0;
      }
    } elsif ($map_ref->{$k}->{'type'} eq 'natural') {
      # Match hexadecimal, binary, octal and decimal numbers (the latter also in scientific notation)
      if ($orig !~ /^(0|(0(x[0-9a-fA-F]+|[0-7]+))|(0b[01]+)|([1-9][0-9]*(e(-[0-9])?[0-9]+)?))$/) {
        $log_func->($logger, "$k: $orig does not look like a number.");
        return 0;
      }
      
      # convert non-decimal (hexadecimal, binary, octal) values to decimal
      ${$v_ref} = oct($orig) if $orig =~ /^0/;
      if (!looks_like_number(${$v_ref})) {
        $log_func->($logger, "$k: $orig does not look like a number.");
        return 0;
      }
      # Check for natural value range. Should never trigger due to the regex above.
      if (${$v_ref} < 0) {
        $log_func->($logger, "$k: $orig is negative.");
        return 0;
      }
    } elsif ($map_ref->{$k}->{'type'} eq 'boolean') {
      # convert strings to binary if need be
      if (!defined($orig)) {
        $log_func->($logger, "$k: \"undef\" is not a boolean value.");
        return 0;
      } elsif (lc($orig) eq 'true') {
        $orig = 1;
      } elsif (lc($orig) eq 'false') {
        $orig = 0;
      }
      if (($orig ne '0') && ($orig ne '1')) {
        $log_func->($logger, "$k: \"$orig\" does not look like a boolean value.");
        return 0;
      }
      # ensure proper boolean value, i.e. 0 or 1
      ${$v_ref} = (!!$orig) ? 1 : 0;
    }
    $logger->trace("Converted value of $k (\"$orig\") to \"${$v_ref}\".") if (defined($orig) && $orig ne ${$v_ref});
  }

  if (defined($map_ref->{$k}->{'values'})) {
    my $values_ref = $map_ref->{$k}->{'values'};
    if (ref($values_ref) eq 'ARRAY') {
      # Look for given value in allowed values
      if (scalar(grep {$_ eq ${$v_ref}} @{$values_ref}) == 0) {
        $log_func->($logger, "$k: ${$v_ref} is not allowed. Allowed values are: " . join(", ", @{$map_ref->{$k}->{'values'}}));
        return 0;
      }
    } elsif (ref($values_ref) eq 'CODE') {
      if (!$values_ref->(${$v_ref}, $old)) {
        $log_func->($logger, "$k: ${$v_ref} is not allowed.");
        return 0;
      }
    }
  }
  return 1;
}


# @function _rename_import (%$map_ref, %$consts_ref)
# Rename and convert entries in consts_ref according to map_ref.
#
# This function takes a hash of FIJI Settings and converts its contents
# to the respective internal representation. This allows to use different
# names and value representations in the external file than within the
# implementation.
#
# \returns $consts_ref, or undef on errors
sub _rename_import {
  my $logger = get_logger();
  my ($map_ref, $consts_ref) = @_;
  if (ref($consts_ref) ne 'HASH') {
    $logger->error("Parameter is not a reference to a hash (containing design constants).");
    return undef;
  }

  # Iterating over respective hash from FIJI.pm and rename the entries
  # to match our internal naming scheme.
  foreach my $k (keys($map_ref)) {
    my $ini_name = $map_ref->{$k}->{'ini_name'};
    if (exists($consts_ref->{$ini_name}) && $ini_name ne $k) {
      $consts_ref->{$k} = $consts_ref->{$ini_name};
      $logger->trace(sprintf("Renaming setting %s -> %s (=%s).", $ini_name, $k, defined($consts_ref->{$ini_name}) ? $consts_ref->{$ini_name} : "undef"));
      delete $consts_ref->{$ini_name};
    }
  }
  foreach my $entry_key (keys($consts_ref)) {
    if (!exists($map_ref->{$entry_key})) {
      $logger->debug("Deleting unknown setting %s = %s.", $entry_key, $consts_ref->{$entry_key});
      delete $consts_ref->{$entry_key};
    }
  }

  return $consts_ref;
}


## @function _sanitize_fiu (%$fiu_ref, $phase)
# @brief Convert and sanity check FIJI Settings.
#
# \param fiu_ref a reference to a hash containing FIJI Settings for a
#                single FIU.
#
# \returns A new hash with all constants required in the FIU settings
#          in sanitized form, or undef on errors.
sub _sanitize_fiu ($;$) {
  my $logger = get_logger();
  my ($fiu_ref, $phase) = @_;
  if (ref($fiu_ref) ne 'HASH') {
    my $msg = "Parameter is not a reference to a hash (containing FIU constants).";
    $logger->error($msg);
    return $msg;
  }

  $fiu_ref = _validate_hashmap(FIUMAP, $fiu_ref, $phase);
  if (!ref($fiu_ref)) {
      $logger->error("Could not validate Design Constants.");
      return $fiu_ref;
  }

  return $fiu_ref;
}


sub _validate_hashmap ($$;$) {
  my $logger = get_logger();
  my ($map_ref, $consts_ref, $phase) = @_;
  my @map_keys = keys($map_ref);
  foreach my $entry_key (keys($consts_ref)) {
    my $ini_name = $map_ref->{$entry_key}->{'ini_name'};
    
    if (!exists($map_ref->{$entry_key})) {
      $logger->debug("Deleting unknown setting %s = %s.", $entry_key, $consts_ref->{$entry_key});
      next;
    }

    # mark constant key as done
    @map_keys = grep {$_ ne $entry_key} @map_keys;
    if (!validate_value($map_ref, $entry_key, \$consts_ref->{$entry_key})) {
      my $msg = sprintf("%s = %s is invalid.", $entry_key, !defined($consts_ref->{$entry_key}) ? "<undef>" : $consts_ref->{$entry_key});
      $logger->error($msg);
      return $msg;
    }
  }

  if (!defined($phase)) {
    # If there is no phase we are creating an "empty" hash that has
    # all possible defaults set earlier already and the there is
    # nothing we can or should do here.
    return $consts_ref;
  }

  # Iterate over the constants defined in FIJI.pm that apparently are
  # not contained in $consts_ref.
  foreach my $k (@map_keys) {
    if (scalar(grep {$_ eq $phase} @{$map_ref->{$k}->{'phases_opt'}}) == 0) {
      my $msg = "$k is mandatory in phase $phase.";
      $logger->error($msg);
      return $msg;
    }
  }
  return $consts_ref
}


## @function _sanitize_design (%$consts_ref, $phase)
# @brief Sanity check FIJI Design Settings.
#
# The function deals with sanity checks for the values
# themselves. It checks for the following conditions:
#
#   - FIU_NUM: > 0
#   - FIU_CFG_BITS: > 0
#   - TIMER_WIDTH: > 0, multiple of 8
#   - ID: > 0, < 2^15-1
#   - BAUDRATE: > 0
#
# \param consts_ref a reference to a hash containing some design settings
# \param phase the tool flow phase that defines the rules to check against
#
# \returns The given hash with all constants required in the design
#          settings in sanitized form, or an error message.
sub _sanitize_design {
  my $logger = get_logger();
  my ($consts_ref, $phase) = @_;
  if (ref($consts_ref) ne 'HASH') {
    my $msg = "Parameter is not a reference to a hash (containing design constants).";
    $logger->error($msg);
    return $msg;
  }
  
  # check for sane values
  $consts_ref = _validate_hashmap(DESIGNMAP, $consts_ref, $phase);
  if (!ref($consts_ref)) {
      my $msg = "Could not validate Design Constants.";
      $logger->error($msg);
      return "$msg $consts_ref";
  }

  if (($consts_ref->{'FIU_CFG_BITS'} <= 0)) {
      my $msg = "FIU_CFG_BITS is <= 0.";
      $logger->error($msg);
      return $msg;
  }
  if (($consts_ref->{'TIMER_WIDTH'} <= 0) || ($consts_ref->{'TIMER_WIDTH'} % 8 != 0)) {
      my $msg = "TIMER_WIDTH is invalid ($consts_ref->{'TIMER_WIDTH'}).";
      $logger->error($msg);
      return $msg;
  }
  if (defined($consts_ref->{'ID'}) && ($consts_ref->{ID} < 0 || $consts_ref->{ID} > (2**15 - 1))) {
      my $msg = "ID is invalid ($consts_ref->{ID}).";
      $logger->error($msg);
      return $msg;
  }
  if (($consts_ref->{'BAUDRATE'} <= 0)) {
      my $msg = "BAUDRATE missing is <= 0.";
      $logger->error($msg);
      return $msg;
  }

  return $consts_ref;
}

1;