Netlist.pm 62.7 KB
Newer Older
1
2
#** @file Netlist.pm
# @verbatim
Christian Fibich's avatar
Christian Fibich committed
3
4
5
6
7
8
9
10
11
12
13
14
#-------------------------------------------------------------------------------
#  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:
#
15
#  FIJI Netlist class: Functions to instrument & export a Verilog::Netlist
Christian Fibich's avatar
Christian Fibich committed
16
#-------------------------------------------------------------------------------
17
18
# @endverbatim
#*
Christian Fibich's avatar
Christian Fibich committed
19

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

## @class FIJI::Netlist
# @brief Functions to instrument & export a Verilog::Netlist
25
26
27
28
29
package FIJI::Netlist;

use strict;
use warnings;

30
use List::Util qw[min max];
31
use Log::Log4perl qw(get_logger :easy);
32
use File::Basename qw(basename);
33

34
35
use Verilog::Netlist 99.427;
use Verilog::Language 99.427;
36
37

use FIJI::VHDL;
38
use FIJI qw(:fiji_logo);
39

40
use constant HIERSEP               => "/";
41
42
use constant EQUALSEP              => "=";
use constant FIJI_NAMESPACE_PREFIX => "fiji_";
Christian Fibich's avatar
Christian Fibich committed
43
44
use constant FIJI_PORT_IN_POSTFIX  => "_inj_i";
use constant FIJI_PORT_OUT_POSTFIX => "_ori_o";
45
use constant MAX_UNIQUE_TRIES      => 10;
46

47
48
## @function public new ()
# @brief creates a new FIJI::Netlist object
Christian Fibich's avatar
Christian Fibich committed
49
#
50
51
# @returns the newly created FIJI::Netlist object
sub new {
Christian Fibich's avatar
Christian Fibich committed
52

53
    my ($class) = @_;
Christian Fibich's avatar
Christian Fibich committed
54

55
56
    my $self = {};
    bless $self, $class;
Christian Fibich's avatar
Christian Fibich committed
57

58
    $self->{'nl'} = new Verilog::Netlist(
Christian Fibich's avatar
Christian Fibich committed
59

60
61
62
        # options => $opt,
        # keep_comments => 1, # include comments in netlist
        link_read_nonfatal => 1,    # do not fail if module description not found
63
        use_pinselects     => 1,
64
65
    );
    return $self;
66
67
}

68
69
70
71
72
73
74
75
## @method public read_file ($filename)
# @brief Tries to read a Verilog netlist from the given file
#
# @param filename    The Verilog file to read
#
# @returns 1   if an error occurred
# @returns 0   if successful
sub read_file {
76
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
77
    my ($self, $filename) = @_;
78

79
80
    ## Netlist synthesized from VHDL could contain SV keywords at this point.
    Verilog::Language::language_standard("1364-2001");
81

82
    $logger->info("Reading in netlist from file \"$filename\".");
83
    eval {
84
85
86
        # Stop croak and friends from printing stuff to stderr
        # FIXME: how to capture the messages?
        $SIG{__WARN__} = sub {};
Christian Fibich's avatar
Christian Fibich committed
87
88
        $self->{'nl'}->read_file(filename => $filename);    # read Verilog file
        $self->{'nl'}->link();                              # Read in any sub-modules
89
    };
90

Christian Fibich's avatar
Christian Fibich committed
91
92
    if ($self->{'nl'}->errors() != 0 || $@) {
        $logger->error("Could not parse $filename!", $@ ? "\n" . $@ : "");
93
94
        return 1;
    }
95

96
    $self->{'filename'} = $filename;
97

98
99
    $logger->info("Successfully read in netlist from file \"$filename\".");
    return 0;
100
101
}

102
103
104
105
106
## @method public get_toplevel_port_names ()
# @brief retrieves the port names of all toplevel modules
#
# @returns an array of Verilog::Port references
sub get_toplevel_port_names {
Christian Fibich's avatar
Christian Fibich committed
107
    my ($self, $dir) = @_;
108
    my $ports_ref = [];
Christian Fibich's avatar
Christian Fibich committed
109
    foreach my $mod ($self->{'nl'}->top_modules_sorted) {
110
        foreach my $port ($mod->ports) {
Christian Fibich's avatar
Christian Fibich committed
111
112
113
114
            if (   !defined($dir)
                || ($dir eq "o" && $port->direction eq "out")
                || ($dir eq "i" && $port->direction eq "in"))
            {
Christian Fibich's avatar
Christian Fibich committed
115
116
                push @{$ports_ref}, $port->name;
            }
117
118
119
        }
    }
    return $ports_ref;
120
121
}

Christian Fibich's avatar
Christian Fibich committed
122
123
124
125
126
127
## @method public get_toplevel_module ()
# @brief retrieves the port names of all toplevel modules
#
# @returns a Verilog::Module reference
sub get_toplevel_module {
    my ($self) = @_;
Christian Fibich's avatar
Christian Fibich committed
128
129
130
    my @m      = $self->{'nl'}->top_modules_sorted;
    my $n      = @m;
    return $m[0] if ($n == 1);
131
132
    return "More than one toplevel module present in netlist" if ($n > 1);
    return "No toplevel module found";
Christian Fibich's avatar
Christian Fibich committed
133
134
}

135
136
137
138
## @method public get_nets ()
# @brief retrieves all nets in the netlist
#
# @returns an array of hashes for all nets containing:
139
140
141
# 'name' the name of the net
# 'path' the hierarchical path of the net
# 'net'  the Verilog::Netlist::Net reference to the net
142
sub get_nets {
143
144
145
146
147
    my ($self) = @_;

    # my $nets_ref = {'metadata' => [], 'names' => [], 'nets' => []};
    my $nets_ref = [];
    my $hier     = "";
148
149
150
    my $top      = $self->get_toplevel_module();
    if ($top->isa("Verilog::Netlist::Module")) {
        $self->_get_subnets($nets_ref, $top, $hier);
151
152
    }
    return $nets_ref;
153
154
}

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
sub _extract_low_high {
    my ($in_low, $in_high) = @_;
    my ($out_low, $out_high);

    # msb might be lower than lsb if index range is "upto" -> swap
    if ($in_high < $in_low) {
        $out_low = $in_high;
        $out_high = $in_low;
    } else {
        $out_low = $in_low;
        $out_high = $in_high;
    }
    return ($out_low, $out_high);
}

170
171
172
173
174
175
176
177
178
#** @method private _get_subnets ($nets_ref,$mod,$hier)
# @brief retrieves all nets in the given module
#
# @param nets_ref    the central reference to push found nets (name,path,netref) to
# @param mod         the module to search
# @param hier        a string representing the current hierarchy level, separated
#                    be HIERSEP
sub _get_subnets {

179
    my $logger = get_logger("");
180
    my ($self, $nets_ref, $mod, $hier, $instname) = @_;
181

182
    my $thishier = $hier;
Christian Fibich's avatar
Christian Fibich committed
183
    $thishier .= HIERSEP if $thishier ne "";
184
185
186
187
188
    if (defined $instname) {
        $thishier .= $instname;
    } else {
        $thishier .= $mod->name;
    }
189

Christian Fibich's avatar
Christian Fibich committed
190
    foreach my $n ($mod->nets) {
191
        if (defined($n->msb) && defined($n->lsb)) {
192
            my ($low, $high) = _extract_low_high($n->lsb, $n->msb);
193
            for (my $sub = $low ; $sub <= $high ; $sub++) {
Christian Fibich's avatar
Christian Fibich committed
194
                my $thisnet_ref = {name => $n->name . "[$sub]", path => $thishier, net => $n, index => $sub};
195
196
197
198
199
200
201
                push(@{$nets_ref}, $thisnet_ref);
            }
        } else {
            my $thisnet_ref = {name => $n->name, path => $thishier, net => $n};
            push(@{$nets_ref}, $thisnet_ref);
        }

202
    }
203

204
    foreach my $cell ($mod->cells) {
Christian Fibich's avatar
Christian Fibich committed
205
        if (defined($cell->submod)) {
206
            $self->_get_subnets($nets_ref, $cell->submod, $thishier, $cell->name);
207
        }
208
209
210
    }
}

211
212
213
## @function private _check_name_in_hierarchy ($startmod,$name)
# @brief checks if a given name exists
# checks if the $name exists as port, net, or cell name in the instantiation tree.
214
#
215
216
# @param startmod    the module to start with
# @param name        the name to check against
217
sub _check_name_in_hierarchy {
218

219
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
220
    my ($startmod, $name) = @_;
221
222
    my $nl = $startmod->netlist;

223
    $logger->debug("Checking \"" . $startmod->name . "\" for name \"$name\"");
224
225

    # check if a net is named the same
226
    for my $net ($startmod->nets) {
Christian Fibich's avatar
Christian Fibich committed
227
        if ($net->name eq $name) {
228
            my $msg = "Name \"$name\" does already exist as net in " . $startmod->name;
229
            return $msg;
230
231
232
233
        }
    }

    # check if a port is named the same
234
    for my $port ($startmod->ports) {
Christian Fibich's avatar
Christian Fibich committed
235
        if ($port->name eq $name) {
236
            my $msg = "Name \"$name\" does already exist as port in " . $startmod->name;
237
            return $msg;
238
239
240
        }
    }

241
    for my $cell ($startmod->cells) {
Christian Fibich's avatar
Christian Fibich committed
242
        if ($cell->name eq $name) {
243
            my $msg = "Name \"$name\" does already exist as cell in " . $startmod->name;
244
            return $msg;
245
246
247
248
        }
    }

    # find any module instantiating the current start module
249
250
    foreach my $mod ($nl->modules) {
        foreach my $cell ($mod->cells) {
Christian Fibich's avatar
Christian Fibich committed
251
252
            if (defined $cell->submod && $cell->submod == $startmod) {
                my $msg = _check_name_in_hierarchy($mod, $name);
253
                return $msg if defined $msg;
254
255
256
            }
        }
    }
257

258
    return undef;
259
260
}

261
262
## @function private _add_port_to_hierarchy ($startmod,$name,$function,$index,$indent)
# @brief adds a port to all modules starting from a leaf node
263
#
264
265
266
267
268
269
270
271
# @param startmod    the module to start with
# @param name        the port name to be generated
# @param function    the function of this port in FIJI (FIJI::VHDL->FIJI_PORTTYPE_xxx)
# @param index       for ORIGINAL,MODIFIED and FAULT_DETECT: the index of this net
# @param indent      optional, needed just for formatting logging output
#
# @returns undef if the given port $name is already found
# @returns Verilog::Port reference to the new port if successful
Christian Fibich's avatar
Christian Fibich committed
272
sub _add_port_to_hierarchy {
273

274
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
275
    my ($startmod, $name, $function, $index, $indent) = @_;
276
    my $nl        = $startmod->netlist;
277
    my $direction = "undef";
Christian Fibich's avatar
Christian Fibich committed
278
    if (!defined $indent) {
279
280
281
282
283
        $indent = "";
    } else {
        $indent .= "  ";
    }

Christian Fibich's avatar
Christian Fibich committed
284
    return undef if ($startmod->find_port($name));
285

286
    $logger->debug($indent . "Adding port \"$name\" to module \"" . $startmod->name . "\"");
287
288

    # decide direction
289
    if (   $function == FIJI::VHDL->FIJI_PORTTYPE_MODIFIED
290
        || $function == FIJI::VHDL->FIJI_PORTTYPE_RST_TO_DUT)
291
    {
292
        $direction = "in";
293
    } else {
294
295
296
297
        $direction = "out";
    }

    # generate port
Christian Fibich's avatar
Christian Fibich committed
298
    my $np = $startmod->new_port(name => $name, direction => $direction);
299
300

    # set port type for wrapper generation
Christian Fibich's avatar
Christian Fibich committed
301
    $np->userdata(FIJI::VHDL->FIJI_USERDATA_PORTTYPE, $function);
302
303

    # set indices
304
    if (   $function == FIJI::VHDL->FIJI_PORTTYPE_MODIFIED
Christian Fibich's avatar
Christian Fibich committed
305
        || $function == FIJI::VHDL->FIJI_PORTTYPE_ORIGINAL)
306
    {
Christian Fibich's avatar
Christian Fibich committed
307
308
309
        $np->userdata(FIJI::VHDL->FIJI_USERDATA_FIU_INDEX, $index);
    } elsif ($function == FIJI::VHDL->FIJI_PORTTYPE_FAULT_DETECTION) {
        $np->userdata(FIJI::VHDL->FIJI_USERDATA_FD_INDEX, $index);
310
311
    }

Christian Fibich's avatar
Christian Fibich committed
312
313
    # let Verilog-Perl create a new net for the new port.
    $startmod->link;
314
315

    # find all modules instantiating the current module
Christian Fibich's avatar
Christian Fibich committed
316
    foreach my $mod ($nl->modules_sorted) {
317
        foreach my $cell ($mod->cells) {
Christian Fibich's avatar
Christian Fibich committed
318
            if (defined $cell->submod && $cell->submod == $startmod) {
319
320
                $logger->debug($indent . "Adding pin \"$name\" to cell \"" . $cell->name . "\"");
                $logger->debug($indent . "Connecting pin \"" . $cell->name . HIERSEP . $name . "\" to port \"" . $np->module->name . HIERSEP . $np->name . "\"");
321
322
323
                $cell->new_pin(
                    name     => $name,
                    portname => $np->name,
324
                    pinselects => [{'netname' => $np->net->name}],
325
326
                );

Christian Fibich's avatar
Christian Fibich committed
327
                # let verilog-perl find the net and port.
328
                $startmod->link;
Christian Fibich's avatar
Christian Fibich committed
329
                _add_port_to_hierarchy($mod, $name, $function, $index, $indent);
330
331
332
            }
        }
    }
333

334
335
336
    return $np;
}

337
338
339
## @method public net_add_function($net, $function, $port_name, $index)
# @brief Generate external access to a single net
#
Christian Fibich's avatar
Christian Fibich committed
340
341
342
343
344
345
# Performs the following steps:
#    1.  check if the default port name does not yet exist
#    1a. if it exists, generate a new net name
#    2.  add a port through the entire hierarchy
#    3.  assign the net to the port using a contassign statement
#
346
347
348
349
# @param net_descriptor  a hash containing the keys 'net' => Net Object, 'net_name' => Net name string, 'msb', 'lsb', 'mod' => The module containing the net
# @param function        the function out of FIJI::VHDL->FIJI_PORTTYPE_xxx
# @param port_name       how the port shall be named (will be prefixed with "fiji_")
# @param index           for some FIJI_PORTTYPEs, an index is needed (FIU and Fault Detect)
350
351
352
#
# @returns undef
sub net_add_function {
353
    my $logger = get_logger("");
354
    my ($self, $net_descriptor, $function, $port_name, $index) = @_;
355

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
    if (ref($net_descriptor) ne "HASH") {
        return $net_descriptor;
    }

    my $net = $net_descriptor->{'net'};
    my $net_name = $net_descriptor->{'net_name'};
    my $msb = $net_descriptor->{'msb'};
    my $lsb = $net_descriptor->{'lsb'};
    my $mod = $net_descriptor->{'mod'};
    my $idx = '';
    my $idx_postfix = '';

    # We need to produce names for the i/o ports that route the signals
    # to the FIC. To allow to instrument multiple indices of a single
    # signal we need to make these names unique thus we even include the
    # indices if used.
    if (defined $msb && defined $lsb) {
        if ($msb ne $lsb) {
            # We dont support the instrumentation of vectors (only sinlge indices of busses).
            return "The given net to instrument is a vector with multiple bits.\nThis is not supported.\nMaybe you want to instrument a single bit of said vector instead?";
            # $idx         = "[".$msb.":".$lsb."]";
            # $idx_postfix = "_".$msb."_".$lsb."_";
        } else {
            $idx         = "[".$msb."]";
            $idx_postfix = "_".$msb."_";
        }
    }


    $logger->debug("Adding function to \"" . $mod . "\", net \"" . $net_name . "\"");
386
387

    my $prefix = "fiji_";
388

389
    my $unique_name = _unique_name($mod,$prefix.$port_name);
390
391
392

    if (!defined $unique_name) {
        $logger->error("Could not find a unique name for prefix ".$prefix.$port_name)
393
394
    }

395
396
    $logger->debug("\"" . $unique_name . "\" can be used as fiji connector");
    my $op = _add_port_to_hierarchy($net->module, $unique_name, $function, $index);
397

398
    $logger->debug("Connecting Port \"" . $op->name . "\" to net \"" . $net_name.$idx . "\"");
399

Christian Fibich's avatar
Christian Fibich committed
400
    # connect the net to the newly created port
401
402
403
    $net->module->new_contassign(
        keyword => "assign",
        lhs     => $op->name,
404
        rhs     => $net_name.$idx,
405
406
407
        module  => $op->module,
        netlist => $op->module->netlist
    );
408

409
410
411
    return undef;
}

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
# tries to generate a unique but recognizable net name by appending a
# random hex number if necessary
sub _unique_name {
    my $logger = get_logger("");
    my ($mod,$requested_name) = @_;

    # check if requested name is OK
    my $msg = _check_name_in_hierarchy($mod, $requested_name);
    
    if (!defined $msg) {
        return $requested_name;
    }

    # else try up to 10 times to generate a unique name by appending
    # a 4-digit random hex number
    for (my $tries = 0; $tries < MAX_UNIQUE_TRIES; $tries++) {
        my $name = sprintf("%s_%04x", $requested_name, rand(0xffff));
        $msg = _check_name_in_hierarchy($mod, $name);
        return $name if (!defined $msg);
    }
    
    return undef
}

436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
# take a possible escaped identifier and make it a legal _and_ sane verilog identifier
sub _sanitize_identifier {
    my $insane = shift;

    # Verilog allows "non-alphanumeric" characters in identifiers if they start with a backslash and end with whitespace (escaped identifiers) but we don't want to.
    my $sane = ($insane =~ s/[^a-zA-Z0-9_]+/_/gr);
    # VHDL signals must not contain multiple subsequent underscores
    $sane =~ s/__+/_/g;
    return $sane
}

sub generate_contassign {
    my $logger = get_logger("");
    my ($module, $lhs, $rhs) = @_;
    $logger->trace("Setting \"$lhs = $rhs\"");
    $module->new_contassign(
        keyword => "assign",
        lhs     => $lhs,
        rhs     => $rhs,
        module  => $module,
        netlist => $module->netlist
    );
}

460
461
462
463
## @method public instrument_net($net,$fiu_idx, $driver, $driver_type)
# @brief instruments a single net for fault injection
#
# This method performs the following steps
464
465
466
#   1. determine the connected objects (driver as well as driven nets, pins etc)
#   2. generate external access output and input ports and intermediate nets
#   3. interconnect these ports to the matching driver and driven cells via the intermediate nets
Christian Fibich's avatar
Christian Fibich committed
467
#
468
# @param net_path        the Verilog::Net to instrument
469
# @param fiu_idx         the FIU number this external access shall be connected to
470
471
# @param driver_path     the path to the driver of this net (optional but depends on driver_type)
# @param driver_type     the type of the driver (can be PIN, PORT, ASSIGN) (optional but depends on driver_path)
472
473
474
475
#
# @returns STRING          if an error occurred
# @returns undef           if successful
sub instrument_net {
476

477
    my $logger = get_logger("");
478
    my ($self, $net_path, $fiu_idx, $driver_path, $driver_type) = @_;
479

480
    # split hierarchical net path
481
    my $net_descriptor = $self->get_netdescriptor_from_path($net_path);
482
483

    if (ref($net_descriptor) ne "HASH") {
484
        return $net_descriptor;
485
486
487
    }

    my $net = $net_descriptor->{'net'};
488
    my $net_name = $net_descriptor->{'net_name'};
489
490
    my $msb = $net_descriptor->{'msb'};
    my $lsb = $net_descriptor->{'lsb'};
491
    my $mod = $net_descriptor->{'mod'};
492
493
494
    my $idx = '';
    my $idx_postfix = '';

495
496
497
498
499
500
    # We need to produce names for the i/o ports that route the signals
    # to the FIC. To allow to instrument multiple indices of a single
    # signal we need to make these names unique thus we even include the
    # indices if used.
    if (defined $msb && defined $lsb) {
        if ($msb ne $lsb) {
501
            # We dont support the instrumentation of vectors (only sinlge indices of busses).
502
            return "The given net to instrument is a vector with multiple bits.\nThis is not supported.\nMaybe you want to instrument a single bit of said vector instead?";
503
504
            # $idx         = "[".$msb.":".$lsb."]";
            # $idx_postfix = "_".$msb."_".$lsb."_";
505
        } else {
506
507
            $idx         = "[".$msb."]";
            $idx_postfix = "_".$msb."_";
508
509
510
        }
    }

511
    $logger->info("Instrumenting \"" . $net->module->name . "\", net \"" . $net->name.$idx . "\"");
512

513
514
515
516
517
    # we want to perceive the connection state before any changes (at least w/o changes by this invocation)
    my %connections;
    my $rv = $self->_get_net_connections($net, \%connections, $msb, $driver_path, $driver_type);
    return $rv if (defined $rv);

518
519
520
521
    my $output_name = (FIJI_NAMESPACE_PREFIX . $net->name . $idx_postfix . FIJI_PORT_OUT_POSTFIX);
    $output_name = _sanitize_identifier($output_name);
    my $input_name  = (FIJI_NAMESPACE_PREFIX . $net->name . $idx_postfix . FIJI_PORT_IN_POSTFIX);
    $input_name = _sanitize_identifier($input_name);
522

523
    # generate unique name for output port, return with error message if that fails
524
    my $unique_output_name = _unique_name($mod, $output_name);
525
    return "Could not generate unique name for prefix $output_name" if (!defined $unique_output_name);
526

527
    $logger->debug("\"" . $unique_output_name . "\" will be used as fiji connector (output)");
528
    my $op = _add_port_to_hierarchy($mod, $unique_output_name, FIJI::VHDL->FIJI_PORTTYPE_ORIGINAL, $fiu_idx);
529

530
531
    # generate unique name for input port, return with error message if that fails
    my $unique_input_name = _unique_name($mod, $input_name);
532
    return "Could not generate unique name for prefix $input_name" if (!defined $unique_input_name);
533

534
    $logger->debug("\"" . $unique_input_name . "\" will be used as fiji connector (input)");
535
    my $ip = _add_port_to_hierarchy($mod, $unique_input_name, FIJI::VHDL->FIJI_PORTTYPE_MODIFIED, $fiu_idx);
536

Christian Fibich's avatar
Christian Fibich committed
537

538
539
540
    # Add an intermediate net to allow patching without rewriting connections everywhere
    #
    # We use the requested signal as sink/destination.
541
    # That way we only need to change the driver to drive our intermediate net.
542
    #
543
544
545
    # We first generate a suitable name for the intermediate net,
    # then change the driver accordingly and handle other aspects of
    # the intermediate net at the very bottom of this function.
546

547
    # Choose intermediate net name
548
    my $net_name_tmp = _sanitize_identifier(FIJI_NAMESPACE_PREFIX . $net_name . "_in_tmp");
549
    my $net_tmp = $mod->find_net($net_name_tmp);
550
    my $name_check = _check_name_in_hierarchy($mod, $net_name_tmp);
551

552
553
554
    # Switch the driver from the original signal to the intermediate net.
    my $driver_is_vector = 0;
    my $driver_is_port = 0;
555
    my $driver_bit = $msb;
556
    my $driver;
557
    foreach my $connection (@{$connections{'drivers'}}) {
Christian Fibich's avatar
Christian Fibich committed
558
        if (ref($connection) eq "Verilog::Netlist::Pin") {
559
560
            # If the driver is a pin of a (sub)cell, connect this pin to the intermediate net
            $logger->debug("Connecting (output) pin \"" . $connection->cell->name . HIERSEP . $connection->name . "\" to intermediate net \"$net_name_tmp\"");
561
562
            for my $pinselect ($connection->pinselects) {
                if ($pinselect->netname eq $net->name) {
563
                    $driver = $connection;
564
                    $pinselect->netname($net_name_tmp); # FIXME: do we need to force a re-link (by deleting $connection->nets)?
565
                    # The intermediate net is a vector if the underlying net is a bus and we do not just select a single bit
566
                    # This is the case if
567
568
569
570
                    #   - the underlying net is a vector and the driver covers all indices (implicitly by having no msb/lsb set)
                    #   - the underlying net is a vector and the driver covers some indices (by having two different indices set)
                    # Also, if we instrument a second bit of a vector we need to make sure this instrumentation is handled as if the
                    # the driver itself is a vector.
571
                    if (defined($net->msb) && (!defined($pinselect->msb) || ($pinselect->msb != $pinselect->lsb))) {
572
573
                        $driver_is_vector = 1;
                    } elsif (defined($net_tmp) && defined($net_tmp->userdata("first_instrumented_bit")))  {
574
                        $driver_is_vector = 1;
575
576
                    } else {
                        # Make sure we do not output the index unnecessarily (if the driver is a single bit of a vector)
577
578
                        $pinselect->msb(undef);
                        $pinselect->lsb(undef);
579
                    }
580
                }
581
            }
582
            # $connection->port(undef);    # resolved by link
Stefan Tauner's avatar
Stefan Tauner committed
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
        } elsif (ref($connection) eq "Verilog::Netlist::Port") {
            $driver_is_port = 1;
            $driver = $connection;
            # If we are changing the name of a port of the top module we need to inform the VHDL generator
            if ($mod->is_top) {
                    $connection->userdata(FIJI::VHDL->FIJI_USERDATA_PREV_PORTNAME, $connection->name);
            }
            # Change type of existing non-instrumented input to wire -
            # practically transforming it to an ordinary wire that can easily be intrumented.
            $logger->debug("Transforming previous port named \"". $connection->name . "\" into an ordinary wire");
            $connection->net->decl_type(undef);
            $connection->net->net_type("wire");
            my $data_type;
            # If instrumented net is a vector we will need an intermediate bus
            if (defined($net->msb)) {
                $driver_is_vector = 1;
                $data_type = "[".$net->msb.":".$net->lsb."]";
                $connection->data_type($data_type);
            }
            $connection->net->data_type($data_type);
            # Unsetting the port<->net inter-references forces their automatic re-setting at link time
            $connection->net->port(undef);
            $connection->net(undef);
            # Eventually connect this port to the intermediate net by changing its name
            $logger->debug("Connecting (input) port \"" . $connection->name . "\" to intermediate net \"$net_name_tmp\"");
            $connection->name($net_name_tmp); # NB: this will automatically change the cell's configuration on the next link() call.
        } elsif (ref($connection) eq "Verilog::Netlist::ContAssign") {
            # If the driver is an assignment, replace the LHS with the intermediate net
            # Retrieve net object of LHS of the assignment to determine if it is a bus and if the assignment is to the complete net or a single bit.
            my $lhs_elems = $self->_extract_netstring_elements($connection->lhs);
            my $lhs_net_name = $lhs_elems->{'net_name'};
            my $lhs_net_msb = $lhs_elems->{'msb'};
            my $lhs_net_lsb = $lhs_elems->{'lsb'};
            my $lhs_net = $mod->find_net($lhs_net_name);
            if (!defined($lhs_net)) {
                my $lhs_port = $mod->find_port($lhs_net_name);
                if (!defined($lhs_port)) {
                    return "Could not find net or port in module \"" . $mod->name . "\" matching LHS of assignment \"" . $connection->lhs . "\" = \"" . $connection->rhs . "\"";
621
                }
Stefan Tauner's avatar
Stefan Tauner committed
622
623
624
625
626
627
628
629
630
631
                # FIXME: so this is actually a port...
                my $msg = "Found port name in continuous assignment. This is not supported yet.";
                $logger->fatal($msg);
                return $msg;
            }
            $driver = $connection;
            if (defined($connection->userdata->{'fiji_driver_bit'})) {
                $driver_is_vector = 1;
                $driver_bit = $connection->userdata->{'fiji_driver_bit'};
            }
632

Stefan Tauner's avatar
Stefan Tauner committed
633
634
635
636
637
638
            my $indices = ($driver_is_vector && defined($lhs_net_msb)) ? "[$lhs_net_msb:$lhs_net_lsb]" : "";
            $logger->debug("Connecting to intermediate net \"$net_name_tmp$indices\" the continuous assignment of \"" . $connection->rhs . "\"");
            # need to remember what was originally connected to this assign
            # to instrument two nets driven by one assign
            $connection->userdata('former_assign' => {'lhs' => $connection->lhs, 'rhs' => $connection->rhs});
            $connection->lhs($net_name_tmp.$indices);
639

Stefan Tauner's avatar
Stefan Tauner committed
640
641
        } else {
            $logger->error("Driver instance is neither pin, port nor contassign?");
642
643
        }
    }
644

645
646
647
648
649
650
651
    # Below we create the intermediate net as needed.
    # A suitable name for the tmp net was already determined.
    # 1.) Generate the tmp net.
    # 2.) Assign injected signal from input pin to original signal.
    # 3.) If original signal is a bus forward orignal data from tmp net to untouched bits of original signal
    # 4.) Forward (injected bit of) intermediate net to FIC by assigning it to the output pin
    #
652
653
654
655
656
    # However, if the net is already instrumented we need to jump through some hoops:
    # In that case we either have an error, or we need to instrument another bit of a bus.
    # The latter complicates things a bit...
    if (defined($net_tmp) && defined($net_tmp->userdata("first_instrumented_bit"))) {
        # FIXME: maybe we should try harder to find out the reason why _check_name_in_hierarchy failed
657
658
659
660
661
        if (!defined($net->msb)) {
            my $err = "Tried to instrument non-vector signal (\"$net_name\") twice or we really have a naming conflict.";
            $logger->error($err);
            return $err;
        }
662
663
664
665
666
667
668
669
670
671
672

        if (!defined($net_tmp->msb)) {
            # If we instrument the second bit of a net (as wittnessed by the missing msb field)
            # then we need to make sure the intermediate net is or becomes a vector
            my $prev_bit = $net_tmp->userdata("first_instrumented_bit");
            my $prev_driver = $net_tmp->userdata("first_driver");
            $logger->debug("    widening \"" . $net_tmp->name . " to [" . $net->msb . ":" . $net->lsb . "]");
            $net_tmp->msb($net->msb);
            $net_tmp->lsb($net->lsb);
            $net_tmp->data_type("[".$net->msb.":".$net->lsb."]");

673
            # Additionally the previous exporting of the original signal needs to be adapted
674
675
676
677
678
679
680
681
682
683
            foreach my $statement ($mod->statements) {
                if ($statement->rhs =~ /^[ \t]*~?[ \t]*\Q$net_name_tmp\E$/) {
                    $statement->rhs($net_name_tmp."[".$prev_bit."]");
                    $logger->debug("    reassigning \"" . $statement->lhs . " = " . $statement->rhs . "\" --> \"".$net_name_tmp."[".$prev_bit."]\"");
                }
            }

            # We also need to fix the previous assignment of the respective bit...
            if (ref($prev_driver) eq "Verilog::Netlist::Pin") {
                $logger->debug("    reassigning pin \"" . $prev_driver->name . "\": $net_name_tmp --> $net_name_tmp\[$prev_bit\]");
684
685
686
687
                for my $pinselect ($prev_driver->pinselects) {
                    if ($pinselect->netname eq $net_name_tmp) {
                        $pinselect->msb($prev_bit);
                        $pinselect->lsb($prev_bit);
688
689
690
691
                        last;
                    }
                }
            } elsif (ref($prev_driver) eq "Verilog::Netlist::Port") {
692
693
694
                my $msg = "Allegedly we have instrumented another bit of port \"" . $prev_driver->name . "\" previously without creating a temporary vector. If true, this would be a bug.";
                $logger->fatal($msg);
                return $msg;
695
            } elsif (ref($prev_driver) eq "Verilog::Netlist::ContAssign") {
696
697
                $logger->debug("    reassigning ContAssign \"" . $prev_driver->lhs . " --> \"".$net_name_tmp."[".$prev_bit."]\" = ". $prev_driver->rhs . "\" ");
                $prev_driver->lhs($net_name_tmp."[".$prev_bit."]");
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
            }

            # And add the default assignments of the (possibly yet) uninstrumented bits
            my ($low, $high) = _extract_low_high($net->lsb, $net->msb);
            $logger->debug("    assigning \"" . $net_name."[".$low."-".$high."] = ...");
            for (my $i = $low ; $i <= $high ; $i++) {
                if ($i != $driver_bit && $i != $prev_bit) {
                    generate_contassign($mod, $net_name."[".$i."]", $net_name_tmp."[".$i."]");
                }
            }
        } else {
            # For all additional bits (starting with the third one)
            # the previous assignment of the respective bit needs to be undone
            foreach my $statement ($mod->statements) {
                if ($statement->rhs =~ /^[ \t]*~?[ \t]*\Q$net_name_tmp\E(\[(\Q$driver_bit\E)\])$/) {
                    $logger->debug("    unassigning \"" . $statement->lhs . " = " . $statement->rhs . "\"");
                    $statement->delete();
                }
716
717
718
            }
        }

719
        $logger->debug("    assigning to currently processed signal \"" . $net_name."[".$driver_bit."] = " . $ip->net->name . "\"");
720
        generate_contassign($mod, $net_name."[".$driver_bit."]", $ip->net->name);
721
        $driver_is_vector = 1;
722
723
    } else {
        # 2.) Generate intermediate (tmp) net for easier input and output routing
724
725
726
        # For ports we don't need to do that ourselves because Verilog::Perl will
        # generate a new apropriate net when linking the port.
        if ($driver_is_port) {
727
            $logger->debug("Intermediate port named \"" . $net_name_tmp . (defined($net->msb) ? "[" . $net->msb .":". $net->lsb . "]" : "") . "\" to patch \"$net_name\" will be generated automatically later");
728
        } else {
729
730
731
732
733
734
735
736
737
738
739
740
741
            # If the driver is a vector then we will generate a vectored intermediate net as well.
            # However, if the driver is a single-bit net or a single bit of a vector we generate
            # a simple intermediate net (and could get away with none at all actually).
            my @net_cfg = (name => $net_name_tmp);
            if ($driver_is_vector) {
                $logger->debug("Generating intermediate wire named \"" . $net_name_tmp . "[" . $net->msb .":". $net->lsb . "]\" to patch \"$net_name\"");
                push(@net_cfg,
                    msb => $net->msb,
                    lsb => $net->lsb,
                );
            } else {
                $logger->debug("Generating intermediate wire named \"" . $net_name_tmp . "\" to patch \"$net_name\"");
            }
742
743
744
745
746
747
748
            $net_tmp = $mod->new_net(@net_cfg);
            # If we possibly instrument other bits we need to remember some things
            if (defined($net->msb)) {
                $net_tmp->userdata("first_instrumented_bit", $driver_bit);
                $net_tmp->userdata("first_driver", $driver);
                $logger->debug("Remembering the first instrumented bit ($driver_bit) assigned to \"" . $net_name_tmp . "\" driven by \"" . $driver->name . "\"");
            }
749
750
751
752
753
754
755
756
757
758
        }

        # 3+4.) Assign injected (and uninjected bits of vectors) to previous signal.
        # Below we assign the altered signal from the FIC to the original signal.
        # For busses we need to connect all non-instrumented bits of the tmp net
        # additionally to preserve their unmodified values.

        if (!defined($net->msb)) {
            # If the instrumented net is not a vector we simply assign the injected signal
            generate_contassign($mod, $net_name, $ip->net->name);
759
        } elsif (!$driver_is_vector) {
760
761
            # If the net is a vector but the driver was driving only one bit
            # then we need to drive the originally driven bit only
762
            generate_contassign($mod, $net_name."[".$driver_bit."]", $ip->net->name);
763
764
765
        } else {
            # For drivers of complete busses we need to connect all non-instrumented bits of the tmp net
            # additionally to preserve their unmodified values.
766
            # In case of concatenations the index might be different to the one given.
767
            my ($low, $high) = _extract_low_high($net->lsb, $net->msb);
768
            for (my $i = $low ; $i <= $high ; $i++) {
769
                if ($i == $driver_bit) {
770
771
772
773
774
775
776
777
778
                    generate_contassign($mod, $net_name."[".$i."]", $ip->net->name);
                } else {
                    generate_contassign($mod, $net_name."[".$i."]", $net_name_tmp."[".$i."]");
                }
            }
        }
    }

    # 5.) Connect the tmp net to the output pin that forwards the signal to the FIC
779
780
    #     If the driver is not a vector a simple assignment is fine, else
    if (!$driver_is_vector) {
781
782
783
        $logger->debug("    assigning \"" . $op->net->name . " = " . $net_name_tmp . "\"");
        generate_contassign($mod, $op->net->name, $net_name_tmp);
    } else {
784
785
        $logger->debug("    assigning \"" . $op->net->name . " = " . $net_name_tmp ."[".$driver_bit."]\"");
        generate_contassign($mod, $op->net->name, $net_name_tmp."[".$driver_bit."]");
786
    }
787
    $mod->link;
788
789
790
791
792
793
    # Normally we set first_instrumented_bit way earlier but since we autogenerate
    # the port we don't have the respective net available before linking thus...
    if ($driver_is_vector && $driver_is_port && !defined($net_tmp)) {
        my $port_net = $mod->find_net($net_name_tmp);
        $port_net->userdata("first_instrumented_bit", $driver_bit);
    }
794
795
796
    return undef;
}

797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
## @method public validate_net($net_path)
# @brief Check if the given net path is valid (i.e., referring to an existing net)
#
# @param net_path        The hierarchical path of the net, separated by HIERSEP
#
# @returns STRING          if an error occurred
# @returns undef           if successful
sub validate_net {
    my ($self, $net_path,) = @_;

    if ($net_path eq "") {
        return "Net path is empty";
    }

    my $net_descriptor = $self->get_netdescriptor_from_path($net_path);
    if (ref($net_descriptor) ne "HASH") {
        return $net_descriptor;
    }

    return undef;
}

819
820
821
## @method public validate_driver($net_path, $driver_path, $driver_type)
# @brief Check if the given driver is valid for the given net
#
822
823
# Check if the driver specified by $driver_type and $driver_path
# is actually connected to the net specified by $net_path
824
#
825
# @param net_path        The hierarchical path of the net, separated by HIERSEP
826
827
828
829
# @param driver_path     The hierarchical path of the driver object, separated by HIERSEP
# @param driver_type     The type of the driver object, one of {PIN, PORT, ASSIGN}
#
# @returns STRING          if an error occurred
830
831
# @returns undef           if successful
sub validate_driver {
832
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
833
    my ($self, $net_path, $driver_path, $driver_type) = @_;
834

835
836
837
838
839
    return "Net path is empty" if (!defined($net_path) || ($net_path eq ""));
    return "Driver path is empty" if (!defined($driver_path) || ($driver_path eq ""));
    return "Driver type is empty" if (!defined($driver_type) || ($driver_type eq ""));


Christian Fibich's avatar
Christian Fibich committed
840
    my $connection_object = $self->get_connection_object($driver_path, $driver_type);
841
    return "Specified driver not found in netlist" if (!defined $connection_object);
842

843
844
845
    my $connections       = {};
    my $rv = $self->_get_net_connections_from_path($net_path, $connections);
    return $rv if defined($rv);
846

Christian Fibich's avatar
Christian Fibich committed
847
848
    my @in_drivers     = grep { $_ == $connection_object } @{$connections->{'drivers'}};
    my @in_connections = grep { $_ == $connection_object } @{$connections->{'connected'}};
849

850
    return "Driver \"$driver_path\" exists in netlist but is not connected to net \"$net_path\" at all" if (@in_drivers == 0 && @in_connections == 0);
851
852
853
    return undef;
}

854
855
856
857
858
859
860
861
862
## @function private _select_driver($connected,$net)
# @brief Prompt the user to select a driver for a net from a set of given cells/outputs
#
# @param connected       list reference containing connected Verilog::Perl instances
# @param net             the Verilog::Perl::Net instance to select the driver for
#
# @returns STRING          if an error occurred
# @returns Driver object   if successful
sub _select_driver {
Christian Fibich's avatar
Christian Fibich committed
863
    my ($connected, $net) = @_;
864

865
    print "Select driver for net " . $net->name . ": \n";
866
    my $di;
Christian Fibich's avatar
Christian Fibich committed
867
    for ($di = 0 ; $di < @{$connected} ; $di++) {
868
        printf("[%d] %s\n", $di, FIJI::Netlist->connection_tostr(@{$connected}[$di]));
869
    }
Christian Fibich's avatar
Christian Fibich committed
870
    printf("[x] none of the above.\n", $di);
871
    my $sel;
872
    while (1) {
873
        $sel = <STDIN>;
Christian Fibich's avatar
Christian Fibich committed
874
        if ($sel =~ m/[0-9]+/ && defined @{$connected}[$sel]) {
875
            last;
Christian Fibich's avatar
Christian Fibich committed
876
        } elsif ($sel =~ m/[xX]/) {
877
            my $msg = "No driver selected for net " . $net->name;
878
            return $msg;
879
880
        } else {
            print "Invalid driver.\n";
881
882
883
        }
    }
    return @{$connected}[$sel];
884
885
}

886
## @method connection_tostr ($connection,$conn_str_list_ref)
887
888
# @brief Stringifies a connection information
#
Christian Fibich's avatar
Christian Fibich committed
889
# The string is in the format \<TYPE\>: \<PATH|TO|Netname\>
890
# Where '|' can be any HIERSEP and TYPE is one of {PIN, PORT, ASSIGN}
891
# and optionally pushes a hash {path=>...,type=>...,} onto the list @$conn_str_list_ref
892
#
893
894
895
# @param connection          the connection to print
# @param conn_str_list_ref   optional list where a hash describing the connection is pushed
#
Christian Fibich's avatar
Christian Fibich committed
896
# @returns STRING  in the format \<TYPE\>: \<PATH|TO|Netname\>
897
sub connection_tostr {
Christian Fibich's avatar
Christian Fibich committed
898
    my ($self, $connection, $conn_str_list_ref) = @_;
899
900
    my $path;
    my $type;
901
    my $str;
902

Christian Fibich's avatar
Christian Fibich committed
903
    if (ref($connection) eq "Verilog::Netlist::Pin") {
904
        $path = $connection->cell->module->name . HIERSEP . $connection->cell->name . HIERSEP . $connection->name;
905
        $type = "PIN";
906
        $str = $type . ": " . $path
Christian Fibich's avatar
Christian Fibich committed
907
    } elsif (ref($connection) eq "Verilog::Netlist::Port") {
908
        $path = $connection->module->name . HIERSEP . $connection->name;
909
        $type = "PORT";
910
        $str = $type . ": " . $path
911
    } elsif (ref($connection) eq "Verilog::Netlist::ContAssign") {
912
        $path = $connection->module->name . HIERSEP . $connection->lhs . EQUALSEP . $connection->rhs;
913
        $type = "ASSIGN";
914
        $str = $type . ": " . $connection->lhs . EQUALSEP . $connection->rhs;
915
    }
916
917
918
919
920
921
922
923
    if (defined($connection->userdata->{'fiji_driver_bit'})) {
        $str .= "[" . $connection->userdata('fiji_driver_bit') . "]";
    }

    push @{$conn_str_list_ref}, {path => $path, type => $type, str => $str} if defined $conn_str_list_ref;
    return $str;
}

924
925
926
927
928
929
930
931
sub uniq_conn_str_list {
    my %seen;
    my ($self, $conn_str_list_ref) = @_;
    my @list = grep !$seen{$_->{str}}++, @{$conn_str_list_ref};
    return \@list;
}

sub sort_conn_str_list {
932
933
934
935
936
937
938
939
    my ($self, $conn_str_list_ref) = @_;
    my @list = sort {
        my $a_out = ($a->{str} =~ /[QOqo](\[[0-9]+\]){0,1}[ ]*$/);
        my $b_out = ($b->{str} =~ /[QOqo](\[[0-9]+\]){0,1}[ ]*$/);
        return $a->{str} cmp $b->{str}  if (!($a_out ^ $b_out));
        return -1 if ($a_out);
        return 1  if ($b_out);
    } @{$conn_str_list_ref};
940
941
942
943
944
945
    return \@list;
}

sub filter_conn_str_list {
    my ($self, $conn_str_list_ref, $regex) = @_;
    my @list = grep { $_->{'path'} =~ $regex } @{$conn_str_list_ref};
946
947

    return \@list;
948
949
}

950
951
952
## @method public get_connection_object ($connection_path,$connection_type)
# @brief Retrieves the connection object specified by path and type
#
953
# Retrieves a reference to the Verilog::Pin, Verilog::Port or Verilog::ContAssign
954
955
956
957
958
# Object specified by the parameters
#
# @param connection_path     the hierarchichal PATH|To|the|object
# @param connection_type     the type of the object {PIN,PORT,ASSIGN}
#
959
# @returns the Verilog::Pin, Verilog::Port or Verilog::ContAssign Object specified by the parameters
960
sub get_connection_object {
961
    my $logger = get_logger("");
Christian Fibich's avatar
Christian Fibich committed
962
    my ($self, $connection_path, $connection_type) = @_;
963

964
965
    my @path_elements = _split_path($connection_path);

966
    my $rv;
Christian Fibich's avatar
Christian Fibich committed
967
    if ($connection_type eq "PIN") {
968
969
970
        if (@path_elements == 3) {

            my ($module_name, $cell_name, $pin_name) = @path_elements;
971

972
            $logger->trace("Looking for pin named \"$pin_name\" in cell \"$cell_name\" of module \"$module_name\"...");
973

974
975