Settings.pm 29.7 KB
Newer Older
Christian Fibich's avatar
Christian Fibich committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#-------------------------------------------------------------------------------
#  University of Applied Sciences Technikum Wien
#
#  Department of Embedded Systems
#  http://embsys.technikum-wien.at
#
#  Josef Ressel Center for Verification of Embedded Computing Systems
#  http://vecs.technikum-wien.at
#
#-------------------------------------------------------------------------------
#  File:              Settings.pm
#  Created on:        16.02.2015
#  $LastChangedBy$
#  $LastChangedDate$
#
#  Description:
#
# Contains helper functions to deal with FIJI Settings files.
#-------------------------------------------------------------------------------

Christian Fibich's avatar
Christian Fibich committed
21
22
## @file Settings.pm
# @brief Contains class \ref FIJI::Settings
23

24
## @class FIJI::Settings
25
#
Christian Fibich's avatar
Christian Fibich committed
26
# @brief Contains helper functions to deal with FIJI Settings files.
27
28
package FIJI::Settings;

29
30
31
use strict;
use warnings;

32
use Scalar::Util 'blessed';
33
34
35
use Log::Log4perl qw(get_logger);
use Scalar::Util "looks_like_number";
use Config::Simple;
36
37
38
use Data::Dumper;
use POSIX qw(ceil);
use List::Util qw(max);
39

40
41
use FIJI qw(:all);

Christian Fibich's avatar
Christian Fibich committed
42
## @var @base_resources stores the resource count for default config
Christian Fibich's avatar
Christian Fibich committed
43
44
my @base_resources;

45
## @function public new ($phase, $fiji_ini_file, $existing_settings)
Stefan Tauner's avatar
Stefan Tauner committed
46
47
# Create a new settings instance.
#
Christian Fibich's avatar
Christian Fibich committed
48
49
50
# \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) A reference to reuse and return
51
#        with values read from file. Any contained data will be cleared.
52
53
# \returns The new settings instance or a string describing the reason
#          why it could not be created.
54
sub new ($;$$) {
55
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
56
    my ($class, $phase, $fiji_ini_file, $existing_settings) = @_;
57
58
59
60

    my $fiji_settings_ref;

    # if there is no existing settings instance yet, create one
Christian Fibich's avatar
Christian Fibich committed
61
    if (!defined($existing_settings)) {
62
        $fiji_settings_ref = {};
Christian Fibich's avatar
Christian Fibich committed
63
        $fiji_settings_ref = bless($fiji_settings_ref, $class);
64
    } else {
65
66
        $fiji_settings_ref = $existing_settings;
    }
Christian Fibich's avatar
Christian Fibich committed
67
    if (!blessed($fiji_settings_ref) || !$fiji_settings_ref->isa("FIJI::Settings")) {
68
        my $msg;
Christian Fibich's avatar
Christian Fibich committed
69
        if (!defined($existing_settings)) {
70
71
72
73
74
75
76
77
78
            $msg = "Could not create FIJI::Settings instance.";
        } else {
            $msg = "Given settings are not of type FIJI::Settings.";
        }
        $logger->error($msg);
        return $msg;
    }

    # If there is a file given, try to read it. Else just create a default instance.
Christian Fibich's avatar
Christian Fibich committed
79
80
81
    if (defined($fiji_ini_file)) {
        $fiji_settings_ref = read_settingsfile($phase, $fiji_ini_file, $fiji_settings_ref);
        if (!ref($fiji_settings_ref)) {
82
83
84
85
            return $fiji_settings_ref;    # actually an error message
        }
    } else {
        $fiji_settings_ref->{'design'} = {};
Christian Fibich's avatar
Christian Fibich committed
86
        _set_defaults(DESIGNMAP, $fiji_settings_ref->{'design'}, $phase);
87
88
        $fiji_settings_ref->{'fius'} = [];
    }
Stefan Tauner's avatar
Stefan Tauner committed
89

Christian Fibich's avatar
Christian Fibich committed
90
    @base_resources = _est_resources(DESIGNMAP->{'FREQUENCY'}->{'default'}, DESIGNMAP->{'BAUDRATE'}->{'default'}, DESIGNMAP->{'TIMER_WIDTH'}->{'default'}, DESIGNMAP->{'RESET_DUT_IN_DURATION'}->{'default'}, DESIGNMAP->{'LFSR_WIDTH'}->{'default'}, 0, "logarithmic");
91
92
93

    return $fiji_settings_ref;
}
Stefan Tauner's avatar
Stefan Tauner committed
94
95

sub _export_value {
96
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
97
    my ($map_ref, $k, $v_ref) = @_;
98

Christian Fibich's avatar
Christian Fibich committed
99
    if (defined($map_ref->{$k}->{'type'})) {
100
        my $orig = ${$v_ref};
Christian Fibich's avatar
Christian Fibich committed
101
102
        if ($map_ref->{$k}->{'type'} eq 'hexadecimal') {
            ${$v_ref} = sprintf("0x%x", $orig);
103
104
105

            # } elsif ($map_ref->{$k}->{'type'} eq 'natural') {
            # } elsif ($map_ref->{$k}->{'type'} eq 'boolean') {
Christian Fibich's avatar
Christian Fibich committed
106
            $logger->trace("Converted value of $k (\"$orig\") to \"${$v_ref}\".") if ($orig ne ${$v_ref});
107
108
109
110
        }

        # } elsif (defined($map_ref->{$k}->{'values'})) {
    }
111
112
}

113
## @method public save ($fiji_ini_file)
114
115
# @brief Store contained FIJI Settings to file.
#
Christian Fibich's avatar
Christian Fibich committed
116
# @attention Will happily overwrite existing files!
117
#
118
# @param fiji_ini_file The file name to write the FIJI Settings to.
Stefan Tauner's avatar
Stefan Tauner committed
119
sub save ($) {
120
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
121
    my ($self, $fiji_ini_file) = @_;
122
123
    return "No file name given" if !defined($fiji_ini_file);

Christian Fibich's avatar
Christian Fibich committed
124
    my $fiji_ini = new Config::Simple(syntax => 'ini');
125
126
    my $design_ref;
    my $fiu_cnt = 0;
Christian Fibich's avatar
Christian Fibich committed
127
    foreach my $key (keys %{$self}) {
128
        my $val = $self->{$key};
Christian Fibich's avatar
Christian Fibich committed
129
130
131
        if (ref(\$val) eq "REF") {
            if (ref($val) eq "HASH") {
                if ($key eq "design") {
132
133
134
                    $design_ref = $val;
                    next;
                }
Christian Fibich's avatar
Christian Fibich committed
135
136
137
            } elsif (ref($val) eq "ARRAY") {
                if ($key eq "fius") {
                    foreach my $fiu (@{$val}) {
138
139
                        my $ini_fiu;

Christian Fibich's avatar
Christian Fibich committed
140
                        foreach my $k (keys(%{$fiu})) {
141
                            my $ini_name = FIUMAP->{$k}->{'ini_name'};
Christian Fibich's avatar
Christian Fibich committed
142
                            if (!defined($fiu->{$k})) {
143
144
145
146
147
148
149
150
                                $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
Christian Fibich's avatar
Christian Fibich committed
151
152
                            _export_value(FIUMAP, $k, \$ini_fiu->{$ini_name});
                            $logger->trace(sprintf("Exporting FIU%d setting %s -> %s (%s -> %s).", $fiu_cnt, $k, $ini_name, defined($fiu->{$k}) ? $fiu->{$k} : "undef", defined($ini_fiu->{$ini_name}) ? $ini_fiu->{$ini_name} : "undef"),);
153
                        }
Christian Fibich's avatar
Christian Fibich committed
154
                        $fiji_ini->set_block("FIU" . $fiu_cnt++, $ini_fiu);
155
156
157
                    }
                    next;
                }
158
159
            }
        }
160
161
162
163
164
165
        my $err = "Unknown element found in FIJI Settings: \"$val\"";
        $logger->error($err);
        return $err;
    }
    $design_ref->{'FIU_NUM'} = $fiu_cnt;
    my $ini_design;
Christian Fibich's avatar
Christian Fibich committed
166
    foreach my $k (keys(%{$design_ref})) {
167
        my $ini_name = DESIGNMAP->{$k}->{'ini_name'};
Christian Fibich's avatar
Christian Fibich committed
168
        if (!defined($design_ref->{$k})) {
169
170
171
172
173
174
            $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};
175

176
        # Convert value to external representation
Christian Fibich's avatar
Christian Fibich committed
177
178
        _export_value(DESIGNMAP, $k, \$ini_design->{$ini_name});
        $logger->trace(sprintf("Exporting Design setting %s -> %s (%s -> %s).", $k, $ini_name, defined($design_ref->{$k}) ? $design_ref->{$k} : "undef", defined($ini_design->{$ini_name}) ? $ini_design->{$ini_name} : "undef"),);
179
    }
Christian Fibich's avatar
Christian Fibich committed
180
    $fiji_ini->set_block("CONSTS", $ini_design);
181

Christian Fibich's avatar
Christian Fibich committed
182
    if (!defined($fiji_ini->write($fiji_ini_file))) {
183
184
185
186
187
188
        my $err = Config::Simple->error();
        $logger->error($err);
        return $err;
    }
    return undef;
}
189

190
## @function public read_settingsfile ($phase, $fiji_ini_file)
191
# @brief Load the FIJI Settings file containing design and FIU constants.
192
#
193
# @param phase  Tool flow phase the settings stored in the given file
Stefan Tauner's avatar
Stefan Tauner committed
194
#               need to be compatible with.
195
# @param fiji_ini_file The name of an .ini file with FIJI Settings:
196
#         - a 'consts' block containing the constants specified by
Stefan Tauner's avatar
Stefan Tauner committed
197
#           \ref _sanitize_design.
198
199
200
#         - 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
201
#
202
# @returns a reference to the hash containing the read constants.
203
sub read_settingsfile ($$$) {
204
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
205
    my ($phase, $fiji_ini_file, $existing_settings) = @_;
206
207
    my $fiji_ini;
    eval { $fiji_ini = new Config::Simple($fiji_ini_file) };    # pesky library tries to die on syntax errors
Christian Fibich's avatar
Christian Fibich committed
208
    if (!defined($fiji_ini)) {
209
        my $submsg = defined($@) ? $@ : Config::Simple->error();
Christian Fibich's avatar
Christian Fibich committed
210
        if (length($submsg) == 0) {
211
212
213
214
215
216
217
218
            $submsg = "Empty file?";
        }
        my $msg = "Could not read config file \"$fiji_ini_file\": $submsg";
        $logger->error($msg);
        return $msg;
    }

    my $design_ref = $fiji_ini->get_block("CONSTS");
Christian Fibich's avatar
Christian Fibich committed
219
    if (!(%$design_ref)) {
220
221
222
223
        my $msg = "Could not fetch CONSTS block from config file \"$fiji_ini_file\"";
        $logger->error($msg);
        return $msg;
    }
Christian Fibich's avatar
Christian Fibich committed
224
    _set_defaults(DESIGNMAP, $design_ref, $phase);
225

Christian Fibich's avatar
Christian Fibich committed
226
227
    $design_ref = _rename_import(DESIGNMAP, $design_ref);
    if (!defined($design_ref)) {
228
229
230
231
232
233
234
        my $msg = "Design constants do not match the FIJI Settings naming scheme.";
        $logger->error($msg);
        return $msg;
    }

    # Create a new instance or reuse the shallow hull of the existing one
    my $fiji_settings_ref;
Christian Fibich's avatar
Christian Fibich committed
235
    if (!defined($existing_settings)) {
236
        $fiji_settings_ref = {};
Christian Fibich's avatar
Christian Fibich committed
237
        bless($fiji_settings_ref, "FIJI::Settings");
Stefan Tauner's avatar
Stefan Tauner committed
238
    } else {
239
240
241
        $fiji_settings_ref = $existing_settings;

        # Clear the hash
Christian Fibich's avatar
Christian Fibich committed
242
        for (keys %$fiji_settings_ref) {
243
244
245
            delete $fiji_settings_ref->{$_};
        }
    }
Christian Fibich's avatar
Christian Fibich committed
246
    if (!blessed($fiji_settings_ref) || !$fiji_settings_ref->isa("FIJI::Settings")) {
247
        my $msg;
Christian Fibich's avatar
Christian Fibich committed
248
        if (!defined($existing_settings)) {
249
250
251
252
253
254
255
256
257
258
259
            $msg = "Could not create FIJI::Settings instance.";
        } else {
            $msg = "Given settings are not of type FIJI::Settings.";
        }
        $logger->error($msg);
        return $msg;
    }
    $fiji_settings_ref->{'design'} = $design_ref;
    $fiji_settings_ref->{'fius'}   = [];

    # sanitize and validate read design constants
Christian Fibich's avatar
Christian Fibich committed
260
261
    $design_ref = _sanitize_design($design_ref, $phase);
    if (!ref($design_ref)) {
262
263
264
265
266
267
268
269
270
271
        $logger->error($design_ref);
        return $design_ref;
    }

    my $fiu_num = 0;

    # loop over all read fius
    while (1) {
        my $fiu_name = "FIU" . $fiu_num;
        my $fiu_ref  = $fiji_ini->get_block($fiu_name);
Christian Fibich's avatar
Christian Fibich committed
272
        if (!(%$fiu_ref)) {
273
274
            last;
        }
Christian Fibich's avatar
Christian Fibich committed
275
276
        $fiu_ref = _rename_import(FIUMAP, $fiu_ref);
        if (!defined($design_ref)) {
277
278
279
280
281
282
            my $msg = "FIU constants of $fiu_name do not match the FIJI Settings naming scheme.";
            $logger->error($msg);
            return $msg;
        }

        my $tmp_fiu = {};
Christian Fibich's avatar
Christian Fibich committed
283
        _set_defaults(FIUMAP, $tmp_fiu, $phase);
284
285

        # overwrite default entries
Christian Fibich's avatar
Christian Fibich committed
286
        foreach my $k (keys(%{$fiu_ref})) {
287
288
289
290
            $tmp_fiu->{$k} = $fiu_ref->{$k};
        }
        $fiu_ref = $tmp_fiu;

Christian Fibich's avatar
Christian Fibich committed
291
292
        $fiu_ref = _sanitize_fiu($fiu_ref, $phase);
        if (!ref($fiu_ref)) {
293
294
295
296
297
298
299
300
301
            my $msg = "(Some) constants for $fiu_name in FIJI Settings are invalid.";
            $logger->error($msg);
            return $msg;
        }
        $fiji_settings_ref->{'fius'}->[$fiu_num] = $fiu_ref;
        $fiu_num++;
        $logger->trace("Read in $fiu_name from FIJI Settings file successfully.");
    }

Christian Fibich's avatar
Christian Fibich committed
302
    if ($fiu_num == 0) {
303
304
305
306
307
        $logger->debug("Could not fetch any FIU blocks from config file \"$fiji_ini_file\"");
    }

    # FIU_NUM is optional in the Settings file... if it was set check that
    # it corresponds to the number of FIU<number> blocks.
Christian Fibich's avatar
Christian Fibich committed
308
    if (defined($design_ref->{'FIU_NUM'}) && $design_ref->{'FIU_NUM'} != $fiu_num) {
309
310
311
312
313
314
315
        my $msg = FIU_NUM->{'ini_name'} . " does not match the numbers of FIU blocks found.";
        $logger->error($msg);
        return $msg;
    } else {
        $design_ref->{'FIU_NUM'} = $fiu_num;    # assume the best if FIU_NUM constant is not given
    }

Christian Fibich's avatar
Christian Fibich committed
316
    splice(@{$fiji_settings_ref->{'fius'}}, $fiu_num);
317
318
    $logger->info("Successfully read in design constants and $fiu_num FIU definitions from FIJI Settings file \"$fiji_ini_file\".");
    return $fiji_settings_ref;
319
320
}

321
## @method public set_fiu_defaults (%$fiu_ref)
322
323
324
# @brief Overwrite existing fields (if defined) with defaults defined in FIJI.pm.
#
sub set_fiu_defaults ($) {
Christian Fibich's avatar
Christian Fibich committed
325
326
    my ($self, $consts_ref) = @_;
    return _set_defaults(FIUMAP, $consts_ref);
Stefan Tauner's avatar
Stefan Tauner committed
327
328
329
330
331
}

## @function _set_defaults (%$map_ref, %$consts_ref)
# @brief Set defaults according to FIJI.pm.
sub _set_defaults {
332
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
333
334
335
    my ($map_ref, $consts_ref, $phase) = @_;
    foreach my $k (keys(%{$map_ref})) {
        if (exists($map_ref->{$k}->{'default'})) {
336

337
            # Set default only if it is not mandatory in the given phase.
Christian Fibich's avatar
Christian Fibich committed
338
            if (defined($phase) && scalar(grep { $_ eq $phase } @{$map_ref->{$k}->{'phases_opt'}}) == 0) {
339
340
341
342
                next;
            }

            # Also, do not overwrite existing values
Christian Fibich's avatar
Christian Fibich committed
343
            if (defined($consts_ref->{$k})) {
344
345
346
                next;
            }
            $consts_ref->{$k} = $map_ref->{$k}->{default};
Christian Fibich's avatar
Christian Fibich committed
347
            $logger->trace(sprintf("Adding default constant: %s (%s) = %s.", $k, $map_ref->{$k}->{'ini_name'}, $map_ref->{$k}->{default}));
348
349
350
        }
    }
}
351

Stefan Tauner's avatar
Stefan Tauner committed
352
sub validate_design_value {
Christian Fibich's avatar
Christian Fibich committed
353
354
    my ($k, $v_ref) = @_;
    return validate_value(DESIGNMAP, $k, $v_ref);
Stefan Tauner's avatar
Stefan Tauner committed
355
356
357
}

sub validate_fiu_value {
Christian Fibich's avatar
Christian Fibich committed
358
359
    my ($k, $v_ref) = @_;
    return validate_value(FIUMAP, $k, $v_ref);
Stefan Tauner's avatar
Stefan Tauner committed
360
361
}

362
363
364
365
366
367
368
369
370
371
## @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 ($$$;$$) {
372
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
373
    my ($map_ref, $k, $v_ref, $old, $log_func) = @_;
374
    $log_func = \&Log::Log4perl::Logger::trace if !defined($log_func);
Christian Fibich's avatar
Christian Fibich committed
375
    if (defined($map_ref->{$k}->{'type'})) {
376
377
        my $orig = ${$v_ref};

Christian Fibich's avatar
Christian Fibich committed
378
        # @FIXME: check if the constant is depending on another constant, that needs to be enabled.
379
380
381
382
        # my $dependency = @{$map_ref->{$k}->{'depends_on'}};
        # if (defined($dependency) && defined(@{$map_ref->{$dependency}->{'value'}}
        # }

Christian Fibich's avatar
Christian Fibich committed
383
        if ($map_ref->{$k}->{'type'} eq 'net') {
384

Christian Fibich's avatar
Christian Fibich committed
385
            # @TODO: check syntax? there is nothing more to do in here unless we supply allowed nets...
386
            # which is actually possible because the input netlist is stored in the settings as well
Christian Fibich's avatar
Christian Fibich committed
387
388
389
        } 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.");
390
391
392
393
394
                return 0;
            }
            ${$v_ref} = hex($orig);

            # Check for natural value range. Should never trigger due to the regex above.
Christian Fibich's avatar
Christian Fibich committed
395
396
            if (${$v_ref} < 0) {
                $log_func->($logger, "$k: $orig is negative.");
397
398
                return 0;
            }
Christian Fibich's avatar
Christian Fibich committed
399
        } elsif ($map_ref->{$k}->{'type'} eq 'natural') {
400
401

            # Match hexadecimal, binary, octal and decimal numbers (the latter also in scientific notation)
Christian Fibich's avatar
Christian Fibich committed
402
403
            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.");
404
405
406
407
408
                return 0;
            }

            # convert non-decimal (hexadecimal, binary, octal) values to decimal
            ${$v_ref} = oct($orig) if $orig =~ /^0/;
Christian Fibich's avatar
Christian Fibich committed
409
410
            if (!looks_like_number(${$v_ref})) {
                $log_func->($logger, "$k: $orig does not look like a number.");
411
412
                return 0;
            }
Stefan Tauner's avatar
Stefan Tauner committed
413

414
            # Check for natural value range. Should never trigger due to the regex above.
Christian Fibich's avatar
Christian Fibich committed
415
416
            if (${$v_ref} < 0) {
                $log_func->($logger, "$k: $orig is negative.");
417
418
                return 0;
            }
Christian Fibich's avatar
Christian Fibich committed
419
        } elsif ($map_ref->{$k}->{'type'} eq 'boolean') {
420
421

            # convert strings to binary if need be
Christian Fibich's avatar
Christian Fibich committed
422
423
            if (!defined($orig)) {
                $log_func->($logger, "$k: \"undef\" is not a boolean value.");
424
                return 0;
Christian Fibich's avatar
Christian Fibich committed
425
            } elsif (lc($orig) eq 'true') {
426
                $orig = 1;
Christian Fibich's avatar
Christian Fibich committed
427
            } elsif (lc($orig) eq 'false') {
428
429
                $orig = 0;
            }
Christian Fibich's avatar
Christian Fibich committed
430
431
            if (($orig ne '0') && ($orig ne '1')) {
                $log_func->($logger, "$k: \"$orig\" does not look like a boolean value.");
432
433
434
435
                return 0;
            }

            # ensure proper boolean value, i.e. 0 or 1
Christian Fibich's avatar
Christian Fibich committed
436
            ${$v_ref} = (!!$orig) ? 1 : 0;
437
        }
Christian Fibich's avatar
Christian Fibich committed
438
        $logger->trace("Converted value of $k (\"$orig\") to \"${$v_ref}\".") if (defined($orig) && $orig ne ${$v_ref});
439
440
    }

Christian Fibich's avatar
Christian Fibich committed
441
    if (defined($map_ref->{$k}->{'values'})) {
442
        my $values_ref = $map_ref->{$k}->{'values'};
Christian Fibich's avatar
Christian Fibich committed
443
        if (ref($values_ref) eq 'ARRAY') {
444
445

            # Look for given value in allowed values
Christian Fibich's avatar
Christian Fibich committed
446
447
            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'}}));
448
449
                return 0;
            }
Christian Fibich's avatar
Christian Fibich committed
450
451
452
        } elsif (ref($values_ref) eq 'CODE') {
            if (!$values_ref->(${$v_ref}, $old)) {
                $log_func->($logger, "$k: ${$v_ref} is not allowed.");
453
454
455
456
457
458
                return 0;
            }
        }
    }
    return 1;
}
Stefan Tauner's avatar
Stefan Tauner committed
459
460
461
462
463
464
465
466
467
468
469

# @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 {
470
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
471
472
    my ($map_ref, $consts_ref) = @_;
    if (ref($consts_ref) ne 'HASH') {
473
474
475
        $logger->error("Parameter is not a reference to a hash (containing design constants).");
        return undef;
    }
476

477
478
    # Iterating over respective hash from FIJI.pm and rename the entries
    # to match our internal naming scheme.
Christian Fibich's avatar
Christian Fibich committed
479
    foreach my $k (keys(%{$map_ref})) {
480
        my $ini_name = $map_ref->{$k}->{'ini_name'};
Christian Fibich's avatar
Christian Fibich committed
481
        if (exists($consts_ref->{$ini_name}) && $ini_name ne $k) {
482
            $consts_ref->{$k} = $consts_ref->{$ini_name};
Christian Fibich's avatar
Christian Fibich committed
483
            $logger->trace(sprintf("Renaming Design setting %s -> %s (=%s).", $ini_name, $k, defined($consts_ref->{$ini_name}) ? $consts_ref->{$ini_name} : "undef"),);
484
485
486
            delete $consts_ref->{$ini_name};
        }
    }
Christian Fibich's avatar
Christian Fibich committed
487
488
489
    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});
490
491
492
493
494
495
            delete $consts_ref->{$entry_key};
        }
    }

    return $consts_ref;
}
Stefan Tauner's avatar
Stefan Tauner committed
496

497
## @function _sanitize_fiu (%$fiu_ref, $phase)
498
499
# @brief Convert and sanity check FIJI Settings.
#
500
501
# \param fiu_ref a reference to a hash containing FIJI Settings for a
#                single FIU.
Christian Fibich's avatar
Christian Fibich committed
502
# \param phase   the current design phase
503
504
505
#
# \returns A new hash with all constants required in the FIU settings
#          in sanitized form, or undef on errors.
506
sub _sanitize_fiu {
507
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
508
509
    my ($fiu_ref, $phase) = @_;
    if (ref($fiu_ref) ne 'HASH') {
510
511
512
513
        my $msg = "Parameter is not a reference to a hash (containing FIU constants).";
        $logger->error($msg);
        return $msg;
    }
514

Christian Fibich's avatar
Christian Fibich committed
515
516
    $fiu_ref = _validate_hashmap(FIUMAP, $fiu_ref, $phase);
    if (!ref($fiu_ref)) {
517
518
519
        $logger->error("Could not validate Design Constants.");
        return $fiu_ref;
    }
Stefan Tauner's avatar
Stefan Tauner committed
520

521
    return $fiu_ref;
522
523
}

524
sub _disabled_via_dependency {
Christian Fibich's avatar
Christian Fibich committed
525
    my ($map_ref, $consts_ref, $k) = @_;
526
527
528
    my $dependency = $map_ref->{$k}->{'depends_on'};
    return defined($dependency) && !$consts_ref->{$dependency};
}
529

Christian Fibich's avatar
Christian Fibich committed
530
sub _validate_hashmap {
531
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
532
533
534
    my ($map_ref, $consts_ref, $phase) = @_;
    my @map_keys = keys(%{$map_ref});
    foreach my $entry_key (keys(%{$consts_ref})) {
535
536
537
        my $forbidden_by = $map_ref->{$entry_key}->{'forbidden_by'};
        my $ini_name     = $map_ref->{$entry_key}->{'ini_name'};

Christian Fibich's avatar
Christian Fibich committed
538
539
        if (!exists($map_ref->{$entry_key})) {
            $logger->debug("Deleting unknown setting %s = %s.", $entry_key, $consts_ref->{$entry_key});
540
541
            next;
        }
Stefan Tauner's avatar
Stefan Tauner committed
542

543
        @map_keys = grep { $_ ne $entry_key } @map_keys;    # mark constant key as done
Christian Fibich's avatar
Christian Fibich committed
544
545
546
547
        if (_disabled_via_dependency($map_ref, $consts_ref, $entry_key)) {
            $logger->debug(sprintf("Key %s is disabled via %s. Skipping validation.", $entry_key, $map_ref->{$entry_key}->{'depends_on'}));
        } elsif (!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});
548
549
550
551
            $logger->error($msg);
            return $msg;
        }

Christian Fibich's avatar
Christian Fibich committed
552
        if (defined($forbidden_by) && $consts_ref->{$entry_key} && $consts_ref->{$forbidden_by}) {
553
554
555
556
            my $msg = "$entry_key is forbidden when $forbidden_by is enabled";
            $logger->error($msg);
            return $msg;
        }
Stefan Tauner's avatar
Stefan Tauner committed
557
    }
558

Christian Fibich's avatar
Christian Fibich committed
559
    if (!defined($phase)) {
560

561
562
563
564
565
        # 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;
    }
566

567
568
569
570
571
    # Iterate over the constants defined in FIJI.pm that apparently are
    # not contained in $consts_ref.
    foreach my $k (@map_keys) {
        my $dependency = $map_ref->{$k}->{'depends_on'};
        if (
Christian Fibich's avatar
Christian Fibich committed
572
573
574
            scalar(grep { $_ eq $phase } @{$map_ref->{$k}->{'phases_opt'}}) == 0 &&    # mandatory in current phase
            !_disabled_via_dependency($map_ref, $consts_ref, $k)                       # no dependency or dependency is enabled
           )
575
576
577
578
579
580
581
        {
            my $msg = "$k is mandatory in phase $phase.";
            $logger->error($msg);
            return $msg;
        }

    }
Stefan Tauner's avatar
Stefan Tauner committed
582

Christian Fibich's avatar
Christian Fibich committed
583
    # @TODO: implement the same mechanism with forbidden_by
584
585
586

    return $consts_ref;
}
Stefan Tauner's avatar
Stefan Tauner committed
587

588
## @function _sanitize_design (%$consts_ref, $phase)
Stefan Tauner's avatar
Stefan Tauner committed
589
# @brief Sanity check FIJI Design Settings.
590
#
Stefan Tauner's avatar
Stefan Tauner committed
591
# The function deals with sanity checks for the values
592
# themselves. It checks for the following conditions:
593
594
595
#
#   - FIU_NUM: > 0
#   - FIU_CFG_BITS: > 0
596
#   - TIMER_WIDTH: > 0, <= 16
597
598
599
#   - ID: > 0, < 2^15-1
#   - BAUDRATE: > 0
#
600
# \param consts_ref a reference to a hash containing some design settings
Stefan Tauner's avatar
Stefan Tauner committed
601
# \param phase the tool flow phase that defines the rules to check against
602
#
Stefan Tauner's avatar
Stefan Tauner committed
603
# \returns The given hash with all constants required in the design
604
#          settings in sanitized form, or an error message.
Stefan Tauner's avatar
Stefan Tauner committed
605
sub _sanitize_design {
606
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
607
608
    my ($consts_ref, $phase) = @_;
    if (ref($consts_ref) ne 'HASH') {
609
610
611
612
613
614
        my $msg = "Parameter is not a reference to a hash (containing design constants).";
        $logger->error($msg);
        return $msg;
    }

    # check for sane values
Christian Fibich's avatar
Christian Fibich committed
615
616
    $consts_ref = _validate_hashmap(DESIGNMAP, $consts_ref, $phase);
    if (!ref($consts_ref)) {
617
618
619
620
621
        my $msg = "Could not validate Design Constants.";
        $logger->error($msg);
        return "$msg $consts_ref";
    }

Christian Fibich's avatar
Christian Fibich committed
622
    if (($consts_ref->{'FIU_CFG_BITS'} <= 0)) {
623
624
625
626
        my $msg = "FIU_CFG_BITS is <= 0.";
        $logger->error($msg);
        return $msg;
    }
Christian Fibich's avatar
Christian Fibich committed
627
    if (($consts_ref->{'TIMER_WIDTH'} <= 0) || ($consts_ref->{'TIMER_WIDTH'} > 16)) {
628
629
630
631
        my $msg = "TIMER_WIDTH is invalid ($consts_ref->{'TIMER_WIDTH'}).";
        $logger->error($msg);
        return $msg;
    }
Christian Fibich's avatar
Christian Fibich committed
632
    if (defined($consts_ref->{'ID'}) && ($consts_ref->{ID} < 0 || $consts_ref->{ID} > (2**16 - 1))) {
633
634
635
636
        my $msg = "ID is invalid ($consts_ref->{ID}).";
        $logger->error($msg);
        return $msg;
    }
Christian Fibich's avatar
Christian Fibich committed
637
    if (($consts_ref->{'BAUDRATE'} <= 0)) {
638
639
640
641
642
643
        my $msg = "BAUDRATE missing is <= 0.";
        $logger->error($msg);
        return $msg;
    }

    return $consts_ref;
644
645
}

646
647
sub _log2 {
    my $val = shift;
Christian Fibich's avatar
Christian Fibich committed
648
    return ($val > 0) ? (log($val) / log(2)) : 0;
649
650
}

651
652
## @function private _est_resources ($FREQUENCY, $BAUD, $TIMER_WIDTH, $RESET_CYCLES, $LFSR_WIDTH, $FIU_NUM, $algo)
# @brief estimates the number of Registers and LUTs to implement FIJI logic with the given settings
Christian Fibich's avatar
Christian Fibich committed
653
#
654
655
656
657
658
# The function ant its parameters were determined by experiment & fitted by scipy.optimize.curve_fit
#
# @param FREQUENCY      the clock frequency the FIJI logic will run at in Hz
# @param BAUD           the baud rate for DUT <-> FIJI communication
# @param TIMER_WIDTH    the width of the injection timer (durations) in Bytes
Christian Fibich's avatar
Christian Fibich committed
659
# @param RESET_CYCLES   the number of cycles to apply a FIJI-to-DUT reset
660
# @param LFSR_WIDTH     width of the LFSR used for stuck-open emulation
Christian Fibich's avatar
Christian Fibich committed
661
# @param FIU_NUM        the number of FIUs in the configuration
662
663
664
665
# @param algo           the algorithm to use, can be eiterh "logarithmic" or "polynomial"
#
# @returns ($registers, $lutsum)

Christian Fibich's avatar
Christian Fibich committed
666
sub _est_resources {
667
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
668
    my ($FREQUENCY, $BAUD, $TIMER_WIDTH, $RESET_CYCLES, $LFSR_WIDTH, $FIU_NUM, $algo) = @_;
Christian Fibich's avatar
Christian Fibich committed
669

Christian Fibich's avatar
Christian Fibich committed
670
    # @FIXME where do we put these values? they are likely to change if the VHDL
671
672
    # source is changed...

Christian Fibich's avatar
Christian Fibich committed
673
    $algo = "logarithmic" if (!defined $algo);
Christian Fibich's avatar
Christian Fibich committed
674
675
676
677
678
679

    my $registers;
    my $lutsum;
    my $lut6;
    my $comb;

Christian Fibich's avatar
Christian Fibich committed
680
681
682
683
684
685
    $logger->debug("FREQUENCY $FREQUENCY out of range (1000000 - 500000000)") if ($FREQUENCY < 1000000 || $FREQUENCY > 500000000);
    $logger->debug("BAUD $BAUD out of range (9600 - 3000000)")                if ($BAUD < 9600         || $BAUD > 3000000);
    $logger->debug("TIMER_WIDTH $TIMER_WIDTH out of range (1 - 8)")           if ($TIMER_WIDTH < 1     || $TIMER_WIDTH > 8);
    $logger->debug("RESET_CYCLES $RESET_CYCLES out of range (1 - 16)")        if ($RESET_CYCLES < 1    || $RESET_CYCLES > 16);
    $logger->debug("LFSR_WIDTH $LFSR_WIDTH out of range (16 - 64)")           if ($LFSR_WIDTH < 16     || $LFSR_WIDTH > 64);
    $logger->debug("FIU_NUM $FIU_NUM out of range (1 - 64)")                  if ($FIU_NUM < 1         || $FIU_NUM > 64);
686

Christian Fibich's avatar
Christian Fibich committed
687
    if ($algo eq "logarithmic") {
688
        $registers = 105.90215234;
Christian Fibich's avatar
Christian Fibich committed
689
690
691
692
693
694
        $registers += (-8.78501935753e-10) * ($FREQUENCY) +    (2.02400278472) *   (_log2($FREQUENCY));
        $registers += (-1.92362445319e-08) * ($BAUD) +         (-1.99903895447) *  (_log2($BAUD));
        $registers += (25.294652022) *       ($TIMER_WIDTH) +  (-3.6942823707) *   (_log2($TIMER_WIDTH));
        $registers += (-0.0388887762348) *   ($RESET_CYCLES) + (1.12647034117) *   (_log2($RESET_CYCLES));
        $registers += (1.0012871074) *       ($LFSR_WIDTH) +   (-0.035302419887) * (_log2($LFSR_WIDTH));
        $registers += (13.0019033469) *      ($FIU_NUM) +      (-1.06808285072) *  (_log2($FIU_NUM));
695
696

        $lutsum = 141.184641269;
Christian Fibich's avatar
Christian Fibich committed
697
698
699
700
701
702
        $lutsum += (5.14383788335e-09) * ($FREQUENCY) +    (4.44319121639) *   (_log2($FREQUENCY));
        $lutsum += (8.15160754702e-07) * ($BAUD) +         (-4.96956691254) *  (_log2($BAUD));
        $lutsum += (21.280632646) *      ($TIMER_WIDTH) +  (-7.40399315196) *  (_log2($TIMER_WIDTH));
        $lutsum += (0.0181923149046) *   ($RESET_CYCLES) + (1.33545547133) *   (_log2($RESET_CYCLES));
        $lutsum += (0.0264092868862) *   ($LFSR_WIDTH) +   (-0.817645982805) * (_log2($LFSR_WIDTH));
        $lutsum += (3.88874581602) *     ($FIU_NUM) +      (0.262418360097) *  (_log2($FIU_NUM));
703

Christian Fibich's avatar
Christian Fibich committed
704
    } elsif ($algo eq "polynomial") {
Christian Fibich's avatar
Christian Fibich committed
705
706

        $registers = -2010875.59555;
Christian Fibich's avatar
Christian Fibich committed
707
708
709
710
711
712
        $registers += (2.76229402251e-07) * ($FREQUENCY) +    (-1.99515157117e-15) * ($FREQUENCY**2) +    (3.00590523596e-24) *  ($FREQUENCY**3);
        $registers += (-4.12206137854) *    ($BAUD) +         (3.43014697591e-05) *  ($BAUD**2) +         (-1.09771659281e-11) * ($BAUD**3);
        $registers += (19.1505478618) *     ($TIMER_WIDTH) +  (0.968580877998) *     ($TIMER_WIDTH**2) +  (-0.0572727376031) *   ($TIMER_WIDTH**3);
        $registers += (2639374.42117) *     ($RESET_CYCLES) + (-659843.417883) *     ($RESET_CYCLES**2) + (31421.1133492) *      ($RESET_CYCLES**3);
        $registers += (3990.13449895) *     ($LFSR_WIDTH) +   (-124.660493304) *     ($LFSR_WIDTH**2) +   (1.11304032394) *      ($LFSR_WIDTH**3);
        $registers += (11.9791223372) *     ($FIU_NUM) +      (0.0532451990358) *    ($FIU_NUM**2) +      (-0.000610665213464) * ($FIU_NUM**3);
Christian Fibich's avatar
Christian Fibich committed
713
714

        $lutsum = 94081.448429;
Christian Fibich's avatar
Christian Fibich committed
715
716
717
718
719
720
        $lutsum += (6.84901011695e-07) * ($FREQUENCY) +    (-5.31630997207e-15) * ($FREQUENCY**2) +    (8.18999405393e-24) *  ($FREQUENCY**3);
        $lutsum += (2.76529833194) *     ($BAUD) +         (-2.30130317053e-05) * ($BAUD**2) +         (7.36465871249e-12) *  ($BAUD**3);
        $lutsum += (-1.31145039083) *    ($TIMER_WIDTH) +  (4.78626536988) *      ($TIMER_WIDTH**2) +  (-0.330321432416) *    ($TIMER_WIDTH**3);
        $lutsum += (-122105.518664) *    ($RESET_CYCLES) + (30526.6179134) *      ($RESET_CYCLES**2) + (-1453.65059187) *     ($RESET_CYCLES**3);
        $lutsum += (-2766.64987134) *    ($LFSR_WIDTH) +   (86.4567706424) *      ($LFSR_WIDTH**2) +   (-0.771930699286) *    ($LFSR_WIDTH**3);
        $lutsum += (3.54441195947) *     ($FIU_NUM) +      (0.031558519242) *     ($FIU_NUM**2) +      (-0.000405853019244) * ($FIU_NUM**3);
721
722
723

    }

Christian Fibich's avatar
Christian Fibich committed
724
    return ($registers, $lutsum);
Christian Fibich's avatar
Christian Fibich committed
725
726
}

727
728
## @function public estimate_resources ($settings_ref)
# @brief estimates the resources needed to implement the given settings
Christian Fibich's avatar
Christian Fibich committed
729
#
730
731
# @returns a hash with the members 'regs' and 'lut_calc'
#
732
sub estimate_resources {
733
    my $logger         = get_logger("");
734
    my ($settings_ref) = @_;
735
736
737
    my $consts_ref     = $settings_ref->{'design'};
    my $fiu_ref        = $settings_ref->{'fius'};
    my $fiu_num        = @{$fiu_ref};
Christian Fibich's avatar
Christian Fibich committed
738

Christian Fibich's avatar
Christian Fibich committed
739
    my @calcrv = _est_resources($consts_ref->{'FREQUENCY'}, $consts_ref->{'BAUDRATE'}, $consts_ref->{'TIMER_WIDTH'}, $consts_ref->{'RESET_DUT_IN_DURATION'}, $consts_ref->{'LFSR_WIDTH'}, $fiu_num, "logarithmic");
Christian Fibich's avatar
Christian Fibich committed
740

741
    my $rv = {
Christian Fibich's avatar
Christian Fibich committed
742
743
        regs     => sprintf("%.2f", $calcrv[0] / $base_resources[0]),
        lut_calc => sprintf("%.2f", $calcrv[1] / $base_resources[1]),
744
    };
Christian Fibich's avatar
Christian Fibich committed
745

746
    $logger->debug("ESTIMATE: current config will need Base*$rv->{'regs'} registers and Base*$rv->{'lut_calc'} combinational resources");
747
748
749
    return $rv;
}

750
1;