File: fsm.tcl

package info (click to toggle)
covered 0.7.10-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 8,916 kB
  • sloc: ansic: 48,807; yacc: 11,650; xml: 8,838; tcl: 7,698; sh: 3,925; lex: 2,240; makefile: 360; perl: 329
file content (461 lines) | stat: -rw-r--r-- 16,085 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
################################################################################################
# Copyright (c) 2006-2010 Trevor Williams                                                      #
#                                                                                              #
# This program is free software; you can redistribute it and/or modify                         #
# it under the terms of the GNU General Public License as published by the Free Software       #
# Foundation; either version 2 of the License, or (at your option) any later version.          #
#                                                                                              #
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;    #
# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    #
# See the GNU General Public License for more details.                                         #
#                                                                                              #
# You should have received a copy of the GNU General Public License along with this program;   #
# if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. #
################################################################################################

# Global variables
set fsm_states     [list 0000 0001 0010 0100 1000]
set fsm_hit_states [list 0000 0001 0010]
set fsm_arcs       [list [list 0000 0001] [list 0001 0000] [list 0000 0010] [list 0010 0100] [list 0100 0000]]
set fsm_hit_arcs   [list [list 0000 0001] [list 0001 0000] [list 0000 0010]]
set fsm_in_state   next_state
set fsm_out_state  state
set fsm_bheight    -1
set curr_fsm_ptr   ""
set fsm_geometry   ""
set fsm_gui_saved  0
set fsm_excluded   0
set fsm_reason     ""

proc fsm_find_arc_index {row col} {

  global fsm_arcs fsm_in_states fsm_out_states

  set out_state [lindex $fsm_out_states $col]
  set in_state  [lindex $fsm_in_states  $row]

  # Find the FSM state transition for this
  for {set i 0} {$i < [llength $fsm_arcs]} {incr i} {
    set arc [lindex $fsm_arcs $i]
    if {$in_state == [lindex $arc 0] && $out_state == [lindex $arc 1]} {
       break
    }
  }

  # Return found index value or -1 if not found
  if {$i < [llength $fsm_arcs]} {
    return $i
  } else {
    return -1
  }

}

proc fsm_arc_show_tooltip {w row col} {

  global fsm_arcs fsm_in_states fsm_out_states
  global cov_bgColor cov_fgColor

  # Get arc index
  set arc_index [fsm_find_arc_index $row [expr $col - 1]]

  # Display balloon
  if {$arc_index != -1} {
    set arc [lindex $fsm_arcs $arc_index]
    if {[lindex $arc 2] == 1} {
      if {[lindex $arc 3] != ""} {
        balloon::show $w "State transition: [lindex $arc 0]->[lindex $arc 1]\n\nExclude Reason: [lindex $arc 3]\n\nClick to include this state transition" $cov_bgColor $cov_fgColor
      } else {
        balloon::show $w "State transition: [lindex $arc 0]->[lindex $arc 1]\n\nClick to include this state transition"
      }
    } elseif {[$w cellcget $row,$col -text] != ""} {
      balloon::show $w "State transition: [lindex $arc 0]->[lindex $arc 1]\n\nClick to exclude this state transition"
    } else {
      balloon::show $w "State transition: [lindex $arc 0]->[lindex $arc 1]"
    }
  }

}

proc fsm_arc_hide_tooltip {w} {

  balloon::hide $w

}

proc fsm_tablelist_selected {} {

  global fsm_arcs fsm_reason fsm_exclude exclude_reasons_enabled
  global uncov_bgColor uncov_fgColor cov_bgColor cov_fgColor
  global curr_block curr_fsm_expr_id curr_fsm_ptr

  set selected_cell [split [.fsmwin.pw.t.tl curcellselection] ,]
  set arc_index     [fsm_find_arc_index [lindex $selected_cell 0] [expr [lindex $selected_cell 1] - 1]]

  # If the arc index exists, perform exclusion
  if {$arc_index != -1} {
    set arc [lindex $fsm_arcs $arc_index]
    if {[.fsmwin.pw.t.tl cellcget [.fsmwin.pw.t.tl curcellselection] -text] != ""} {
      fsm_arc_hide_tooltip .fsmwin.pw.t.tl
      set fsm_reason   ""
      set fsm_excluded [expr ! [lindex $arc 2]]
      if {$exclude_reasons_enabled == 1 && $fsm_excluded == 1} {
        set fsm_reason [get_exclude_reason .fsmwin]
      }
      set arc      [lreplace $arc 2 3 $fsm_excluded $fsm_reason]
      set fsm_arcs [lreplace $fsm_arcs $arc_index $arc_index $arc]
      tcl_func_set_fsm_exclude $curr_block $curr_fsm_expr_id [lindex $arc 0] [lindex $arc 1] $fsm_excluded $fsm_reason
      display_fsm_table
      fsm_arc_show_tooltip .fsmwin.pw.t.tl [lindex $selected_cell 0] [lindex $selected_cell 1]
      set text_x [.bot.right.txt xview]
      set text_y [.bot.right.txt yview]
      process_fsm_cov
      .bot.right.txt xview moveto [lindex $text_x 0]
      .bot.right.txt yview moveto [lindex $text_y 0]
      populate_listbox
      enable_cdd_save
      set_pointer curr_fsm_ptr $curr_fsm_ptr 
    }
  }

  # Clear out the selection
  .fsmwin.pw.t.tl selection clear [.fsmwin.pw.t.tl curselection]

}

proc create_fsm_window {expr_id} {

  global prev_fsm_index next_fsm_index HOME
  global fsm_geometry fsm_gui_saved

  if {[winfo exists .fsmwin] == 0} {

    set fsm_gui_saved 0

    # Create new window
    toplevel .fsmwin
    wm title .fsmwin "FSM State/State Transition Coverage - Verbose"

    # Create all frames for window
    ttk::panedwindow .fsmwin.pw    -width 500 -height 350 -orient vertical
    ttk::frame       .fsmwin.pw.io -relief raised -borderwidth 1
    ttk::frame       .fsmwin.pw.t  -relief raised -borderwidth 1

    # Add movable frames to panedwindow
    .fsmwin.pw add .fsmwin.pw.io
    .fsmwin.pw add .fsmwin.pw.t

    # Create input/output expression frame components
    ttk::label .fsmwin.pw.io.l -anchor w -text "FSM Input/Output State Expressions"
    text .fsmwin.pw.io.t -height 4 -width 60 -xscrollcommand ".fsmwin.pw.io.hb set" \
                        -yscrollcommand ".fsmwin.pw.io.vb set" -wrap none -state disabled
    ttk::scrollbar .fsmwin.pw.io.hb -orient horizontal -command ".fsmwin.pw.io.t xview"
    ttk::scrollbar .fsmwin.pw.io.vb -command ".fsmwin.pw.io.t yview"

    # Pack the input/output expression frame
    grid rowconfigure    .fsmwin.pw.io 1 -weight 1
    grid columnconfigure .fsmwin.pw.io 0 -weight 1
    grid .fsmwin.pw.io.l   -row 0 -column 0 -sticky news
    grid .fsmwin.pw.io.t   -row 1 -column 0 -sticky news
    grid .fsmwin.pw.io.vb  -row 1 -column 1 -sticky news
    grid .fsmwin.pw.io.hb  -row 2 -column 0 -sticky news

    # Create FSM tablelist frame
    ttk::label .fsmwin.pw.t.l -anchor w -text "FSM State and State Transition Table"
    tablelist::tablelist .fsmwin.pw.t.tl -titlecolumns 1 -xscrollcommand {.fsmwin.pw.t.hb set} -yscrollcommand {.fsmwin.pw.t.vb set} -showseparators 1 -resizablecolumns 0 -selecttype cell -stripebg #EDF3FE -bg white -tooltipaddcommand fsm_arc_show_tooltip -tooltipdelcommand fsm_arc_hide_tooltip
    ttk::scrollbar .fsmwin.pw.t.hb -command {.fsmwin.pw.t.tl xview} -orient horizontal
    ttk::scrollbar .fsmwin.pw.t.vb -command {.fsmwin.pw.t.tl yview} 

    bind .fsmwin.pw.t.tl <<TablelistSelect>> {fsm_tablelist_selected}

    # Pack the tablelist frame
    grid rowconfigure    .fsmwin.pw.t 1 -weight 1
    grid columnconfigure .fsmwin.pw.t 0 -weight 1
    grid .fsmwin.pw.t.l  -row 0 -column 0 -sticky news
    grid .fsmwin.pw.t.tl -row 1 -column 0 -sticky news
    grid .fsmwin.pw.t.vb -row 1 -column 1 -sticky ns
    grid .fsmwin.pw.t.hb -row 2 -column 0 -sticky ew

    # Create the button frame
    frame .fsmwin.bf -relief raised -borderwidth 1
    ttk::button .fsmwin.bf.prev -image [image create photo -file [file join $HOME scripts left_arrow.gif]] -state disabled -command {
      display_fsm $prev_fsm_index
    }
    set_balloon .fsmwin.bf.prev "Click to view the previous uncovered FSM in this window"
    ttk::button .fsmwin.bf.next -image [image create photo -file [file join $HOME scripts right_arrow.gif]] -state disabled -command {
      display_fsm $next_fsm_index
    }
    set_balloon .fsmwin.bf.prev "Click to view the next uncovered FSM in this window"
    ttk::button .fsmwin.bf.close -text "Close" -width 10 -command {
      destroy .fsmwin
    }
    help_button .fsmwin.bf.help chapter.gui.fsm

    # Pack the buttons into the button frame
    pack .fsmwin.bf.prev  -side left
    pack .fsmwin.bf.next  -side left
    pack .fsmwin.bf.help  -side right -padx 4 -pady 4
    pack .fsmwin.bf.close -side right -padx 4 -pady 4

    # Create general information window
    ttk::label .fsmwin.info -anchor w -relief raised -width 60

    # Pack frames into window
    pack .fsmwin.pw   -fill both -expand yes
    pack .fsmwin.info -fill both
    pack .fsmwin.bf   -fill x

    # Set window geometry, if specified
    if {$fsm_geometry != ""} {
      wm geometry .fsmwin $fsm_geometry
    }

    # Handle the destruction of this window
    wm protocol .fsmwin WM_DELETE_WINDOW {
      save_fsm_gui_elements 0
      destroy .fsmwin
    }
    bind .fsmwin <Destroy> {
      save_fsm_gui_elements 0
    }

  }

  # Display the current FSM table
  display_fsm_window $expr_id

  # Raise this window to the foreground
  raise .fsmwin

}

proc display_fsm_window {expr_id} {

  global curr_block
  global fsm_curr_info
  global fsm_in_states fsm_out_states fsm_in_hit_states fsm_out_hit_states
  global fsm_arcs fsm_hit_arcs
  global fsm_in_state fsm_out_state
  global curr_fsm_expr_id

  # Get information from design for this expression ID
  set fsm_in_states      ""
  set fsm_out_states     ""
  set fsm_in_hit_states  ""
  set fsm_out_hit_states ""
  set fsm_arcs           ""
  set fsm_hit_arcs       ""
  set fsm_in_state       ""
  set fsm_out_state      ""
  tcl_func_get_fsm_coverage $curr_block $expr_id

  # Display the state expressions
  display_fsm_state_exprs

  # Initialize current expression ID
  set curr_fsm_expr_id $expr_id

  # Display the state transition table
  display_fsm_table

  # Display the information in the information bar
  set fsm_curr_info "Filename: [tcl_func_get_filename $curr_block], module: [tcl_func_get_funit_name $curr_block]"
  .fsmwin.info configure -text $fsm_curr_info

}

proc display_fsm_table {} {

  global fsm_in_states fsm_in_hit_states fsm_out_states fsm_out_hit_states fsm_arcs fsm_hit_arcs
  global uncov_fgColor uncov_bgColor cov_fgColor cov_bgColor

  # Delete all columns if this tablelist has been previously populated
  .fsmwin.pw.t.tl delete 0 end
  if {[.fsmwin.pw.t.tl columncount] > 0} {
    for {set i 1} {$i < [.fsmwin.pw.t.tl columncount]} {incr i} {
      .fsmwin.pw.t.tl columnconfigure $i -labelbg $uncov_fgColor
    }
  }

  # Create the table
  set out_states {0 "IN \\ OUT"}
  foreach out_state $fsm_out_states {
    lappend out_states 0 [fsm_gen_vertical_text $out_state]
  }
  .fsmwin.pw.t.tl configure -columns $out_states

  # Add in the input FSM states
  foreach in_state $fsm_in_states {
    .fsmwin.pw.t.tl insert end [join $in_state [lrepeat [llength $fsm_out_states] {}]]
  }

  # Now add the total arcs
  foreach arc $fsm_arcs {
    set row [lsearch $fsm_in_states [lindex $arc 0]]
    set col [expr [lsearch $fsm_out_states [lindex $arc 1]] + 1]
    if {[lindex $arc 2] == 1} {
      .fsmwin.pw.t.tl cellconfigure $row,$col -bg $cov_bgColor -fg $cov_fgColor -text "E"
    } else {
      .fsmwin.pw.t.tl cellconfigure $row,$col -bg $uncov_bgColor -fg $uncov_fgColor -text "I"
    }
  }

  # Add the hit arcs
  foreach arc $fsm_hit_arcs {
    set row [lsearch $fsm_in_states [lindex $arc 0]]
    set col [expr [lsearch $fsm_out_states [lindex $arc 1]] + 1]
    .fsmwin.pw.t.tl cellconfigure $row,$col -bg $cov_bgColor -fg $cov_fgColor -text ""
  }

  # Finally, color the input/output states accordingly
  for {set col 1} {$col < [expr [llength $fsm_out_states] + 1]} {incr col} {
    for {set row 0} {$row < [llength $fsm_in_states]} {incr row} {
      if {[.fsmwin.pw.t.tl cellcget $row,$col -bg] == $cov_bgColor} {
        .fsmwin.pw.t.tl columnconfigure $col -labelbg $cov_bgColor -labelfg $cov_fgColor
        .fsmwin.pw.t.tl cellconfigure $row,0 -bg $cov_bgColor -fg $cov_fgColor -selectbackground $cov_bgColor -selectforeground $cov_fgColor
      } elseif {[.fsmwin.pw.t.tl cellcget $row,$col -bg] == $uncov_bgColor} {
        if {[.fsmwin.pw.t.tl columncget $col -labelbg] != $cov_bgColor} {
          .fsmwin.pw.t.tl columnconfigure $col -labelbg $uncov_bgColor -labelfg $uncov_fgColor
        }
        if {[.fsmwin.pw.t.tl cellcget $row,0 -bg] != $cov_bgColor} {
          .fsmwin.pw.t.tl cellconfigure $row,0 -bg $uncov_bgColor -fg $uncov_fgColor -selectbackground $uncov_bgColor -selectforeground $uncov_fgColor
        }
      } else {
        .fsmwin.pw.t.tl cellconfigure $row,$col -bg white -fg white
      }
    }
  }

}

proc display_fsm_state_exprs {} {

  global fsm_in_state fsm_out_state

  # Allow us to update the text widget
  .fsmwin.pw.io.t configure -state normal

  # Clear the textbox
  .fsmwin.pw.io.t delete 1.0 end

  # Populate the textbox
  .fsmwin.pw.io.t insert end "Input  state expression:  $fsm_in_state\n\n"
  .fsmwin.pw.io.t insert end "Output state expression:  $fsm_out_state\n"

  # Disable the textbox
  .fsmwin.pw.io.t configure -state disabled

}

proc fsm_gen_vertical_text {t} {

  set new_t ""

  for {set i 0} {$i<[string length $t]} {incr i} {
    if {$i == 0} {
      set new_t [string index $t $i]
    } else {
      set new_t "$new_t\n[string index $t $i]"
    }
  }

  return $new_t

}

# Main function to call that will create the FSM verbose viewer (if needed) and populate it
# with the currently selected uncovered FSM.
proc display_fsm {curr_index} {

  global prev_fsm_index next_fsm_index curr_fsm_ptr
  global uncovered_fsms start_line

  # Calculate expression ID
  set all_ranges [.bot.right.txt tag ranges uncov_button]
  set my_range   [.bot.right.txt tag prevrange uncov_button "$curr_index + 1 chars"]
  set index [expr [lsearch -exact $all_ranges [lindex $my_range 0]] / 2]
  set expr_id [lindex [lindex $uncovered_fsms $index] 2]

  # Get range of current signal
  set curr_range [.bot.right.txt tag prevrange uncov_button "$curr_index + 1 chars"]

  # Make sure that the selected signal is visible in the text box and is shown as selected
  set_pointer curr_fsm_ptr [lindex [split [lindex $my_range 0] .] 0]
  goto_uncov [lindex $my_range 0]

  # Get range of previous signal
  set prev_fsm_index [lindex [.bot.right.txt tag prevrange uncov_button [lindex $curr_index 0]] 0]

  # Get range of next signal
  set next_fsm_index [lindex [.bot.right.txt tag nextrange uncov_button [lindex $curr_range 1]] 0]

  # Now create the FSM window
  create_fsm_window $expr_id

}

# Updates the GUI elements of the FSM window when some type of event causes the
# current metric mode to change.
proc update_fsm {} {

  global cov_rb prev_fsm_index next_fsm_index curr_fsm_ptr

  # If the FSM window exists, update the GUI
  if {[winfo exists .fsmwin] == 1} {

    # If the current metric mode is not FSM, disable the prev/next buttons
    if {$cov_rb != "FSM"} {

      .fsmwin.bf.prev configure -state disabled
      .fsmwin.bf.next configure -state disabled

    } else {

      # Restore curr_pointer if it has been set
      set_pointer curr_fsm_ptr $curr_fsm_ptr

      # Restore previous/next button enables
      if {$prev_fsm_index != ""} {
        .fsmwin.bf.prev configure -state normal
      } else {
        .fsmwin.bf.prev configure -state disabled
      }
      if {$next_fsm_index != ""} {
        .fsmwin.bf.next configure -state normal
      } else {
        .fsmwin.bf.next configure -state disabled
      }

    }

  }

}

proc clear_fsm {} {

  global curr_fsm_ptr

  # Reset the variables
  set curr_fsm_ptr ""
  set fsm_bheight  -1

  # Destroy the window
  destroy .fsmwin

}

# Saves the GUI elements from the FSM window setup that should be saved
proc save_fsm_gui_elements {main_exit} {

  global fsm_geometry fsm_gui_saved

  if {$fsm_gui_saved == 0} {
    if {$main_exit == 0 || [winfo exists .fsmwin] == 1} {
      set fsm_gui_saved 1
      set fsm_geometry  [winfo geometry .fsmwin]
    }
  }

}