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
#-------------------------------------------------------------------------------
#  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
#
#-------------------------------------------------------------------------------
#  Description:
#
# Contains helper functions to deal with FIJI Settings files.
#-------------------------------------------------------------------------------

Christian Fibich's avatar
Christian Fibich committed
16
17
## @file Settings.pm
# @brief Contains class \ref FIJI::Settings
18

19
## @class FIJI::Settings
20
#
Christian Fibich's avatar
Christian Fibich committed
21
# @brief Contains helper functions to deal with FIJI Settings files.
22
23
package FIJI::Settings;

24
25
26
use strict;
use warnings;

27
use Scalar::Util 'blessed';
28
29
use Log::Log4perl qw(get_logger);
use Scalar::Util "looks_like_number";
30
31
32
use Data::Dumper;
use POSIX qw(ceil);
use List::Util qw(max);
33
use File::Spec;
34

Christian Fibich's avatar
Christian Fibich committed
35
use FIJI::ConfigSorted;
36
37
use FIJI qw(:all);

Christian Fibich's avatar
Christian Fibich committed
38
## @var @base_resources stores the resource count for default config
Christian Fibich's avatar
Christian Fibich committed
39
40
my @base_resources;

41
## @function public new ($phase, $fiji_ini_file, $existing_settings)
Stefan Tauner's avatar
Stefan Tauner committed
42
43
# Create a new settings instance.
#
Christian Fibich's avatar
Christian Fibich committed
44
45
46
# \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
47
#        with values read from file. Any contained data will be cleared.
48
49
# \returns The new settings instance (or undef in the case of an error)
#          and a diagnostic string describing the reason why it could not be created (undef if successful)
50
sub new ($;$$) {
51
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
52
    my ($class, $phase, $fiji_ini_file, $existing_settings) = @_;
53
54
55
56

    my $fiji_settings_ref;

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

74
    my $warn;
75
    # If there is a file given, try to read it. Else just create a default instance.
Christian Fibich's avatar
Christian Fibich committed
76
    if (defined($fiji_ini_file)) {
77
78
79
        ($fiji_settings_ref, $warn) = read_settingsfile($phase, $fiji_ini_file, $fiji_settings_ref);
        if (!defined($fiji_settings_ref)) {
            return ($fiji_settings_ref, $warn);
80
        }
81
        $fiji_settings_ref->{'filename'} = $fiji_ini_file;
82
83
    } else {
        $fiji_settings_ref->{'design'} = {};
Christian Fibich's avatar
Christian Fibich committed
84
        _set_defaults(DESIGNMAP, $fiji_settings_ref->{'design'}, $phase);
85
        $fiji_settings_ref->{'fius'}     = [];
86
        $fiji_settings_ref->{'filename'} = File::Spec->curdir();
87
    }
Stefan Tauner's avatar
Stefan Tauner committed
88

89
    @base_resources = _est_resources(DESIGNMAP->{'FREQUENCY'}->{'default'}, DESIGNMAP->{'BAUDRATE'}->{'default'}, DESIGNMAP->{'TIMER_WIDTH'}->{'default'}, DESIGNMAP->{'RESET_DUT_IN_DURATION'}->{'default'}, DESIGNMAP->{'LFSR_WIDTH'}->{'default'}, 1, "logarithmic");
90

91
    return ($fiji_settings_ref, $warn);
92
}
Stefan Tauner's avatar
Stefan Tauner committed
93
94

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

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

            # } elsif ($map_ref->{$k}->{'type'} eq 'natural') {
            # } elsif ($map_ref->{$k}->{'type'} eq 'boolean') {
Christian Fibich's avatar
Christian Fibich committed
105
            $logger->trace("Converted value of $k (\"$orig\") to \"${$v_ref}\".") if ($orig ne ${$v_ref});
106
107
108
        } elsif ($map_ref->{$k}->{'type'} eq 'net') {
            # Due to an annoying behavior of Config::Simple we have to enclose
            # escaped identifiers with quotes. These are necessary to preserve spaces.
109
110
            # This also helps with concatenations... so simply quote all nets unconditionally.
            ${$v_ref} = "\"$orig\"";
111
112
        }
    }
113
114
}

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

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

Christian Fibich's avatar
Christian Fibich committed
142
                        foreach my $k (keys(%{$fiu})) {
143
                            my $ini_name = FIUMAP->{$k}->{'ini_name'};
Christian Fibich's avatar
Christian Fibich committed
144
                            if (!defined($fiu->{$k})) {
145
146
147
148
149
150
151
152
                                $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
153
154
                            _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"),);
155
                        }
Christian Fibich's avatar
Christian Fibich committed
156
                        $fiji_ini->set_block("FIU" . $fiu_cnt++, $ini_fiu);
157
158
159
                    }
                    next;
                }
160
            }
161
162
        } elsif ($key eq "filename") {
            next;
163
        }
164
165

        my $err = "Unknown element found in FIJI Settings: key: \"$key\" val: \"$val\"";
166
167
168
169
170
        $logger->error($err);
        return $err;
    }
    $design_ref->{'FIU_NUM'} = $fiu_cnt;
    my $ini_design;
Christian Fibich's avatar
Christian Fibich committed
171
    foreach my $k (keys(%{$design_ref})) {
172
        my $ini_name = DESIGNMAP->{$k}->{'ini_name'};
Christian Fibich's avatar
Christian Fibich committed
173
        if (!defined($design_ref->{$k})) {
174
175
176
177
178
179
            $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};
180

181
        # Convert value to external representation
Christian Fibich's avatar
Christian Fibich committed
182
183
        _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"),);
184
    }
Christian Fibich's avatar
Christian Fibich committed
185
    $fiji_ini->set_block("CONSTS", $ini_design);
186

Christian Fibich's avatar
Christian Fibich committed
187
    if (!defined($fiji_ini->write($fiji_ini_file))) {
Christian Fibich's avatar
Christian Fibich committed
188
        my $err = FIJI::ConfigSorted->error();
189
190
191
        $logger->error($err);
        return $err;
    }
192
    $self->{'filename'} = $fiji_ini_file;
193
194
    return undef;
}
195

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

    my $design_ref = $fiji_ini->get_block("CONSTS");
Christian Fibich's avatar
Christian Fibich committed
226
    if (!(%$design_ref)) {
227
228
        my $msg = "Could not fetch CONSTS block from config file \"$fiji_ini_file\"";
        $logger->error($msg);
229
        return (undef, $msg);
230
    }
Christian Fibich's avatar
Christian Fibich committed
231
    _set_defaults(DESIGNMAP, $design_ref, $phase);
232

Christian Fibich's avatar
Christian Fibich committed
233
234
    $design_ref = _rename_import(DESIGNMAP, $design_ref);
    if (!defined($design_ref)) {
235
236
        my $msg = "Design constants do not match the FIJI Settings naming scheme.";
        $logger->error($msg);
237
        return (undef, $msg);
238
239
240
241
    }

    # Create a new instance or reuse the shallow hull of the existing one
    my $fiji_settings_ref;
Christian Fibich's avatar
Christian Fibich committed
242
    if (!defined($existing_settings)) {
243
        $fiji_settings_ref = {};
Christian Fibich's avatar
Christian Fibich committed
244
        bless($fiji_settings_ref, "FIJI::Settings");
Stefan Tauner's avatar
Stefan Tauner committed
245
    } else {
246
247
248
        $fiji_settings_ref = $existing_settings;

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

    # sanitize and validate read design constants
Christian Fibich's avatar
Christian Fibich committed
267
268
    $design_ref = _sanitize_design($design_ref, $phase);
    if (!ref($design_ref)) {
269
        $logger->error($design_ref);
270
        return (undef, $design_ref);
271
272
273
    }

    my $fiu_num = 0;
274
275
    my $dup = {};
    my $warn;
276
277
    # loop over all read fius
    while (1) {
278

279
280
        my $fiu_name = "FIU" . $fiu_num;
        my $fiu_ref  = $fiji_ini->get_block($fiu_name);
Christian Fibich's avatar
Christian Fibich committed
281
        if (!(%$fiu_ref)) {
282
283
            last;
        }
Christian Fibich's avatar
Christian Fibich committed
284
285
        $fiu_ref = _rename_import(FIUMAP, $fiu_ref);
        if (!defined($design_ref)) {
286
287
            my $msg = "FIU constants of $fiu_name do not match the FIJI Settings naming scheme.";
            $logger->error($msg);
288
            return (undef, $msg);
289
290
291
        }

        my $tmp_fiu = {};
Christian Fibich's avatar
Christian Fibich committed
292
        _set_defaults(FIUMAP, $tmp_fiu, $phase);
293
294

        # overwrite default entries
Christian Fibich's avatar
Christian Fibich committed
295
        foreach my $k (keys(%{$fiu_ref})) {
296
297
298
299
            $tmp_fiu->{$k} = $fiu_ref->{$k};
        }
        $fiu_ref = $tmp_fiu;

Christian Fibich's avatar
Christian Fibich committed
300
301
        $fiu_ref = _sanitize_fiu($fiu_ref, $phase);
        if (!ref($fiu_ref)) {
302
303
            my $msg = "(Some) constants for $fiu_name in FIJI Settings are invalid.";
            $logger->error($msg);
304
            return (undef, $msg);
305
        }
306
307
308
309
310
311
312
313
314

        if (defined $dup->{$fiu_ref->{'FIU_NET_NAME'}}) {
            my $msg = "More than one FIU attached to ".$fiu_ref->{'FIU_NET_NAME'};
            $logger->error($msg);
            $warn .= $msg;
        } else {
            $dup->{$fiu_ref->{'FIU_NET_NAME'}} = 1;
        }

315
316
317
318
319
        $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
320
    if ($fiu_num == 0) {
321
322
323
324
325
        $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
326
    if (defined($design_ref->{'FIU_NUM'}) && $design_ref->{'FIU_NUM'} != $fiu_num) {
327
328
        my $msg = FIU_NUM->{'ini_name'} . " does not match the numbers of FIU blocks found.";
        $logger->error($msg);
329
        return (undef, $msg);
330
331
332
333
    } else {
        $design_ref->{'FIU_NUM'} = $fiu_num;    # assume the best if FIU_NUM constant is not given
    }

Christian Fibich's avatar
Christian Fibich committed
334
    splice(@{$fiji_settings_ref->{'fius'}}, $fiu_num);
335
    $logger->info("Successfully read in design constants and $fiu_num FIU definitions from FIJI Settings file \"$fiji_ini_file\".");
336
    return ($fiji_settings_ref, $warn);
337
338
}

339
## @method public set_fiu_defaults (%$fiu_ref)
340
341
342
# @brief Overwrite existing fields (if defined) with defaults defined in FIJI.pm.
#
sub set_fiu_defaults ($) {
Christian Fibich's avatar
Christian Fibich committed
343
344
    my ($self, $consts_ref) = @_;
    return _set_defaults(FIUMAP, $consts_ref);
Stefan Tauner's avatar
Stefan Tauner committed
345
346
347
348
349
}

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

355
            # Set default only if it is not mandatory in the given phase.
Christian Fibich's avatar
Christian Fibich committed
356
            if (defined($phase) && scalar(grep { $_ eq $phase } @{$map_ref->{$k}->{'phases_opt'}}) == 0) {
357
358
359
360
                next;
            }

            # Also, do not overwrite existing values
Christian Fibich's avatar
Christian Fibich committed
361
            if (defined($consts_ref->{$k})) {
362
363
364
                next;
            }
            $consts_ref->{$k} = $map_ref->{$k}->{default};
Christian Fibich's avatar
Christian Fibich committed
365
            $logger->trace(sprintf("Adding default constant: %s (%s) = %s.", $k, $map_ref->{$k}->{'ini_name'}, $map_ref->{$k}->{default}));
366
367
368
        }
    }
}
369

Stefan Tauner's avatar
Stefan Tauner committed
370
sub validate_design_value {
Christian Fibich's avatar
Christian Fibich committed
371
372
    my ($k, $v_ref) = @_;
    return validate_value(DESIGNMAP, $k, $v_ref);
Stefan Tauner's avatar
Stefan Tauner committed
373
374
375
}

sub validate_fiu_value {
Christian Fibich's avatar
Christian Fibich committed
376
377
    my ($k, $v_ref) = @_;
    return validate_value(FIUMAP, $k, $v_ref);
Stefan Tauner's avatar
Stefan Tauner committed
378
379
}

380
381
382
383
384
385
## @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)
386
#   \param dep_ref    scalar reference to a value the proposed value depends on
387
388
389
#   \param old      (optional) previously valid value
#   \param log_func (optional) the (log4perl) log function to use
#                   (defaul is \&Log::Log4perl::Logger::trace)
390
sub validate_value {
391
    my $logger = get_logger("");
392
    my ($map_ref, $k, $v_ref, $dep_ref, $old, $log_func) = @_;
393
    $log_func = \&Log::Log4perl::Logger::trace if !defined($log_func);
394
395
396
397
398
399
400
401
402
403
404

    if (!defined (${$v_ref})) {
        # if a key does not contain a value, e.g.
        # DRIVER_TYPE=
        # set the corresponding value to an empty string instead of undef
        # FIXME: OK or do we need the undef value later on?
        my $orig = ${$v_ref};
        $log_func->($logger, "$k is undef, setting to empty string.");
        ${$v_ref} = ""
    }

Christian Fibich's avatar
Christian Fibich committed
405
    if (defined($map_ref->{$k}->{'type'})) {
406
407
        my $orig = ${$v_ref};

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

Christian Fibich's avatar
Christian Fibich committed
413
414
        if ($map_ref->{$k}->{'type'} eq 'net') {
            # @TODO: check syntax? there is nothing more to do in here unless we supply allowed nets...
415
            # which is actually possible because the input netlist is stored in the settings as well
Christian Fibich's avatar
Christian Fibich committed
416
        } elsif ($map_ref->{$k}->{'type'} eq 'hexadecimal' || $map_ref->{$k}->{'type'} eq 'lfsrpoly') {
Christian Fibich's avatar
Christian Fibich committed
417
418
            if ($orig !~ /^(0|(0[xX][[:xdigit:]]+))$/) {
                $log_func->($logger, "$k: $orig does not look like a natural hexadecimal number.");
419
420
421
422
423
                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
424
425
            if (${$v_ref} < 0) {
                $log_func->($logger, "$k: $orig is negative.");
426
427
                return 0;
            }
Christian Fibich's avatar
Christian Fibich committed
428
        } elsif ($map_ref->{$k}->{'type'} eq 'natural') {
429
430

            # Match hexadecimal, binary, octal and decimal numbers (the latter also in scientific notation)
Christian Fibich's avatar
Christian Fibich committed
431
432
            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.");
433
434
435
436
437
                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
438
439
            if (!looks_like_number(${$v_ref})) {
                $log_func->($logger, "$k: $orig does not look like a number.");
440
441
                return 0;
            }
Stefan Tauner's avatar
Stefan Tauner committed
442

443
            # Check for natural value range. Should never trigger due to the regex above.
Christian Fibich's avatar
Christian Fibich committed
444
445
            if (${$v_ref} < 0) {
                $log_func->($logger, "$k: $orig is negative.");
446
447
                return 0;
            }
Christian Fibich's avatar
Christian Fibich committed
448
        } elsif ($map_ref->{$k}->{'type'} eq 'boolean') {
449
450

            # convert strings to binary if need be
Christian Fibich's avatar
Christian Fibich committed
451
452
            if (!defined($orig)) {
                $log_func->($logger, "$k: \"undef\" is not a boolean value.");
453
                return 0;
Christian Fibich's avatar
Christian Fibich committed
454
            } elsif (lc($orig) eq 'true') {
455
                $orig = 1;
Christian Fibich's avatar
Christian Fibich committed
456
            } elsif (lc($orig) eq 'false') {
457
458
                $orig = 0;
            }
Christian Fibich's avatar
Christian Fibich committed
459
460
            if (($orig ne '0') && ($orig ne '1')) {
                $log_func->($logger, "$k: \"$orig\" does not look like a boolean value.");
461
462
463
464
                return 0;
            }

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

Christian Fibich's avatar
Christian Fibich committed
470
    if (defined($map_ref->{$k}->{'values'})) {
471
        my $values_ref = $map_ref->{$k}->{'values'};
472
473
474
475
476
        my $dep_val;
        if (ref $dep_ref eq 'SCALAR') {
            $dep_val = $dep_ref;
        }

Christian Fibich's avatar
Christian Fibich committed
477
        if (ref($values_ref) eq 'ARRAY') {
478
479

            # Look for given value in allowed values
Christian Fibich's avatar
Christian Fibich committed
480
481
            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'}}));
482
483
                return 0;
            }
Christian Fibich's avatar
Christian Fibich committed
484
        } elsif (ref($values_ref) eq 'CODE') {
485
            if (!$values_ref->(${$v_ref}, $old, $$dep_val)) {
Christian Fibich's avatar
Christian Fibich committed
486
                $log_func->($logger, "$k: ${$v_ref} is not allowed.");
487
488
489
490
491
492
                return 0;
            }
        }
    }
    return 1;
}
Stefan Tauner's avatar
Stefan Tauner committed
493
494
495
496

# @function _rename_import (%$map_ref, %$consts_ref)
# Rename and convert entries in consts_ref according to map_ref.
#
497
498
499
500
# This function takes a hash of FIJI Settings and converts its keys
# to the respective internal representation. This allows us to use different
# name representations in the external file than within the implementation.
#
Stefan Tauner's avatar
Stefan Tauner committed
501
502
503
#
# \returns $consts_ref, or undef on errors
sub _rename_import {
504
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
505
506
    my ($map_ref, $consts_ref) = @_;
    if (ref($consts_ref) ne 'HASH') {
507
508
509
        $logger->error("Parameter is not a reference to a hash (containing design constants).");
        return undef;
    }
510

511
512
    # Iterating over respective hash from FIJI.pm and rename the entries
    # to match our internal naming scheme.
Christian Fibich's avatar
Christian Fibich committed
513
    foreach my $k (keys(%{$map_ref})) {
514
        my $ini_name = $map_ref->{$k}->{'ini_name'};
Christian Fibich's avatar
Christian Fibich committed
515
        if (exists($consts_ref->{$ini_name}) && $ini_name ne $k) {
516
            $consts_ref->{$k} = $consts_ref->{$ini_name};
Christian Fibich's avatar
Christian Fibich committed
517
            $logger->trace(sprintf("Renaming Design setting %s -> %s (=%s).", $ini_name, $k, defined($consts_ref->{$ini_name}) ? $consts_ref->{$ini_name} : "undef"),);
518
519
520
            delete $consts_ref->{$ini_name};
        }
    }
Christian Fibich's avatar
Christian Fibich committed
521
522
523
    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});
524
525
526
527
528
529
            delete $consts_ref->{$entry_key};
        }
    }

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

531
## @function _sanitize_fiu (%$fiu_ref, $phase)
532
533
# @brief Convert and sanity check FIJI Settings.
#
534
535
# \param fiu_ref a reference to a hash containing FIJI Settings for a
#                single FIU.
Christian Fibich's avatar
Christian Fibich committed
536
# \param phase   the current design phase
537
538
539
#
# \returns A new hash with all constants required in the FIU settings
#          in sanitized form, or undef on errors.
540
sub _sanitize_fiu {
541
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
542
543
    my ($fiu_ref, $phase) = @_;
    if (ref($fiu_ref) ne 'HASH') {
544
545
546
547
        my $msg = "Parameter is not a reference to a hash (containing FIU constants).";
        $logger->error($msg);
        return $msg;
    }
548

Christian Fibich's avatar
Christian Fibich committed
549
550
    $fiu_ref = _validate_hashmap(FIUMAP, $fiu_ref, $phase);
    if (!ref($fiu_ref)) {
551
552
553
        $logger->error("Could not validate Design Constants.");
        return $fiu_ref;
    }
Stefan Tauner's avatar
Stefan Tauner committed
554

555
    return $fiu_ref;
556
557
}

558
sub _disabled_via_dependency {
Christian Fibich's avatar
Christian Fibich committed
559
    my ($map_ref, $consts_ref, $k) = @_;
560
561
562
    my $dependency = $map_ref->{$k}->{'depends_on'};
    return defined($dependency) && !$consts_ref->{$dependency};
}
563

Christian Fibich's avatar
Christian Fibich committed
564
sub _validate_hashmap {
565
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
566
567
568
    my ($map_ref, $consts_ref, $phase) = @_;
    my @map_keys = keys(%{$map_ref});
    foreach my $entry_key (keys(%{$consts_ref})) {
569
570
571
        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
572
573
        if (!exists($map_ref->{$entry_key})) {
            $logger->debug("Deleting unknown setting %s = %s.", $entry_key, $consts_ref->{$entry_key});
574
575
            next;
        }
Stefan Tauner's avatar
Stefan Tauner committed
576

577
        @map_keys = grep { $_ ne $entry_key } @map_keys;    # mark constant key as done
Christian Fibich's avatar
Christian Fibich committed
578
579
580
581
        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});
582
583
584
585
            $logger->error($msg);
            return $msg;
        }

Christian Fibich's avatar
Christian Fibich committed
586
        if (defined($forbidden_by) && $consts_ref->{$entry_key} && $consts_ref->{$forbidden_by}) {
587
588
589
590
            my $msg = "$entry_key is forbidden when $forbidden_by is enabled";
            $logger->error($msg);
            return $msg;
        }
Stefan Tauner's avatar
Stefan Tauner committed
591
    }
592

Christian Fibich's avatar
Christian Fibich committed
593
    if (!defined($phase)) {
594

595
596
597
598
599
        # 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;
    }
600

601
602
603
604
605
    # 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
606
607
608
            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
           )
609
610
611
612
613
614
615
        {
            my $msg = "$k is mandatory in phase $phase.";
            $logger->error($msg);
            return $msg;
        }

    }
Stefan Tauner's avatar
Stefan Tauner committed
616

Christian Fibich's avatar
Christian Fibich committed
617
    # @TODO: implement the same mechanism with forbidden_by
618
619
620

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

622
## @function _sanitize_design (%$consts_ref, $phase)
Stefan Tauner's avatar
Stefan Tauner committed
623
# @brief Sanity check FIJI Design Settings.
624
#
Stefan Tauner's avatar
Stefan Tauner committed
625
# The function deals with sanity checks for the values
626
# themselves. It checks for the following conditions:
627
628
629
#
#   - FIU_NUM: > 0
#   - FIU_CFG_BITS: > 0
630
#   - TIMER_WIDTH: > 0, <= 16
631
632
633
#   - ID: > 0, < 2^15-1
#   - BAUDRATE: > 0
#
634
# \param consts_ref a reference to a hash containing some design settings
Stefan Tauner's avatar
Stefan Tauner committed
635
# \param phase the tool flow phase that defines the rules to check against
636
#
Stefan Tauner's avatar
Stefan Tauner committed
637
# \returns The given hash with all constants required in the design
638
#          settings in sanitized form, or an error message.
Stefan Tauner's avatar
Stefan Tauner committed
639
sub _sanitize_design {
640
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
641
642
    my ($consts_ref, $phase) = @_;
    if (ref($consts_ref) ne 'HASH') {
643
        return "Parameter is not a reference to a hash (containing design constants).";
644
645
646
    }

    # check for sane values
Christian Fibich's avatar
Christian Fibich committed
647
648
    $consts_ref = _validate_hashmap(DESIGNMAP, $consts_ref, $phase);
    if (!ref($consts_ref)) {
649
        return "Could not validate Design Constants." . (defined($consts_ref) ? " $consts_ref" : "");
650
651
    }

Christian Fibich's avatar
Christian Fibich committed
652
    if (($consts_ref->{'FIU_CFG_BITS'} <= 0)) {
653
        return "FIU_CFG_BITS is <= 0.";
654
    }
Christian Fibich's avatar
Christian Fibich committed
655
    if (($consts_ref->{'TIMER_WIDTH'} <= 0) || ($consts_ref->{'TIMER_WIDTH'} > 16)) {
656
        return "TIMER_WIDTH is invalid ($consts_ref->{'TIMER_WIDTH'}).";
657
    }
Christian Fibich's avatar
Christian Fibich committed
658
    if (defined($consts_ref->{'ID'}) && ($consts_ref->{ID} < 0 || $consts_ref->{ID} > (2**16 - 1))) {
659
        return sprintf("ID is invalid (0x%04X).", $consts_ref->{ID});
660
    }
Christian Fibich's avatar
Christian Fibich committed
661
    if (($consts_ref->{'BAUDRATE'} <= 0)) {
662
        return "BAUDRATE missing is <= 0.";
663
664
665
    }

    return $consts_ref;
666
667
}

668
669
sub _log2 {
    my $val = shift;
Christian Fibich's avatar
Christian Fibich committed
670
    return ($val > 0) ? (log($val) / log(2)) : 0;
671
672
}

673
674
## @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
675
#
676
677
678
679
680
# 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
681
# @param RESET_CYCLES   the number of cycles to apply a FIJI-to-DUT reset
682
# @param LFSR_WIDTH     width of the LFSR used for stuck-open emulation
Christian Fibich's avatar
Christian Fibich committed
683
# @param FIU_NUM        the number of FIUs in the configuration
684
685
686
#
# @returns ($registers, $lutsum)

Christian Fibich's avatar
Christian Fibich committed
687
sub _est_resources {
688
    my $logger = get_logger("");
689
    my ($FREQUENCY, $BAUD, $TIMER_WIDTH, $RESET_CYCLES, $LFSR_WIDTH, $FIU_NUM) = @_;
Christian Fibich's avatar
Christian Fibich committed
690

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

Christian Fibich's avatar
Christian Fibich committed
694
695
    my $registers;
    my $lut6;
696
    my $out_of_range = [];
Christian Fibich's avatar
Christian Fibich committed
697

698
699
700
701
    if ($FREQUENCY < 1000000 || $FREQUENCY > 500000000) {
        $logger->debug("FREQUENCY $FREQUENCY out of range for correct resource estimation (1000000 - 500000000)");
        push @{$out_of_range}, "FREQUENCY";
    }
Christian Fibich's avatar
Christian Fibich committed
702
    if ($BAUD < 9600 || $BAUD > 3000000) {
703
704
705
        $logger->debug("BAUD $BAUD out of range for correct resource estimation (9600 - 3000000)");
        push @{$out_of_range}, "BAUD";
    }
Christian Fibich's avatar
Christian Fibich committed
706
    if ($TIMER_WIDTH < 1 || $TIMER_WIDTH > 8) {
707
708
709
        $logger->debug("TIMER_WIDTH $TIMER_WIDTH out of range for correct resource estimation (1 - 8)");
        push @{$out_of_range}, "TIMER_WIDTH";
    }
Christian Fibich's avatar
Christian Fibich committed
710
    if ($RESET_CYCLES < 1 || $RESET_CYCLES > 16) {
711
712
713
        $logger->debug("RESET_CYCLES $RESET_CYCLES out of range for correct resource estimation (1 - 16)");
        push @{$out_of_range}, "RESET_CYCLES";
    }
Christian Fibich's avatar
Christian Fibich committed
714
    if ($LFSR_WIDTH < 16 || $LFSR_WIDTH > 64) {
715
716
717
        $logger->debug("LFSR_WIDTH $LFSR_WIDTH out of range for correct resource estimation (16 - 64)");
        push @{$out_of_range}, "RESET_CYCLES";
    }
Christian Fibich's avatar
Christian Fibich committed
718
    if ($FIU_NUM < 1 || $FIU_NUM > 64) {
719
720
721
        $logger->debug("FIU_NUM $FIU_NUM out of range for correct resource estimation (1 - 64)");
        push @{$out_of_range}, "FIU_NUM";
    }
722

723
    $registers = 8769408455.04;
Christian Fibich's avatar
Christian Fibich committed
724
725
726
727
728
729
    $registers += (3.16525787254e-08) * ($FREQUENCY) +    (-8063276676.79) * (2**(-1.60957863771e-17 * $FREQUENCY));
    $registers += (0.000329011902135) * ($BAUD) +         (-705457194.107) * (2**(7.38032560255e-13 * $BAUD));
    $registers += (86.8258719199) *     ($TIMER_WIDTH) +  (-424084.540754) * (2**(0.000218517717305 * $TIMER_WIDTH));
    $registers += (5.02154556118) *     ($RESET_CYCLES) + (51167.4447102) *  (2**(-0.000135580209031 * $RESET_CYCLES));
    $registers += (-5.30893252274) *    ($LFSR_WIDTH) +   (-301970.077109) * (2**(-2.99010866996e-05 * $LFSR_WIDTH));
    $registers += (13.746880792) *      ($FIU_NUM) +      (437.305954808) *  (2**(-0.00583539664462 * $FIU_NUM));
730
731

    $lut6 = -1591399138.51;
Christian Fibich's avatar
Christian Fibich committed
732
733
734
735
736
737
    $lut6 += (5.65349933334e-06) * ($FREQUENCY) +    (-245548261.879) * (2**(3.26830064347e-14 * $FREQUENCY));
    $lut6 += (-0.0602788840594) *  ($BAUD) +         (1868596655.23) *  (2**(4.65257746085e-11 * $BAUD));
    $lut6 += (9.04974779295) *     ($TIMER_WIDTH) +  (-123738.805411) * (2**(7.77721022021e-07 * $TIMER_WIDTH));
    $lut6 += (0.156780025973) *    ($RESET_CYCLES) + (-176988.018256) * (2**(1e-08 * $RESET_CYCLES));
    $lut6 += (-1.88257966999) *    ($LFSR_WIDTH) +   (-31351130.663) *  (2**(-8.63995764468e-08 * $LFSR_WIDTH));
    $lut6 += (3.95693187928) *     ($FIU_NUM) +      (2718.76465806) *  (2**(-0.000895867386597 * $FIU_NUM));
738

739
    return ($registers, $lut6, $out_of_range);
Christian Fibich's avatar
Christian Fibich committed
740
741
}

742
743
## @function public estimate_resources ($settings_ref)
# @brief estimates the resources needed to implement the given settings
Christian Fibich's avatar
Christian Fibich committed
744
#
745
746
# @returns a hash with the members 'regs' and 'lut_calc'
#
747
sub estimate_resources {
748
    my $logger         = get_logger("");
749
    my ($settings_ref) = @_;
750
751
752
    my $consts_ref     = $settings_ref->{'design'};
    my $fiu_ref        = $settings_ref->{'fius'};
    my $fiu_num        = @{$fiu_ref};
Christian Fibich's avatar
Christian Fibich committed
753

Christian Fibich's avatar
Christian Fibich committed
754
    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
755

756
    my $rv = {
Christian Fibich's avatar
Christian Fibich committed
757
758
        regs         => sprintf("%.2f", $calcrv[0] / $base_resources[0]),
        lut_calc     => sprintf("%.2f", $calcrv[1] / $base_resources[1]),
759
        out_of_range => $calcrv[2],
760
    };
Christian Fibich's avatar
Christian Fibich committed
761

762
    $logger->debug("ESTIMATE: current config will need Base*$rv->{'regs'} registers and Base*$rv->{'lut_calc'} combinational resources");
763
764
765
    return $rv;
}

766
1;