Class: OrigenSim::Simulator

Inherits:
Object
  • Object
show all
Includes:
Origen::PersistentCallbacks
Defined in:
lib/origen_sim/simulator.rb

Overview

Responsible for managing and communicating with the simulator process, a single instance of this class is instantiated as OrigenSim.simulator

Constant Summary collapse

VENDORS = 
[:icarus, :cadence, :synopsys, :generic]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Simulator

Returns a new instance of Simulator.



17
18
19
 
# File 'lib/origen_sim/simulator.rb', line 17

def initialize
  @socket_ids = {}
end

Instance Attribute Details

#configuration ⇒ Object (readonly) Also known as: config

Returns the value of attribute configuration.



12
13
14
 
# File 'lib/origen_sim/simulator.rb', line 12

def configuration
  @configuration
end

#failed ⇒ Object (readonly)

Returns the value of attribute failed.



12
13
14
 
# File 'lib/origen_sim/simulator.rb', line 12

def failed
  @failed
end

#heartbeat ⇒ Object (readonly)

Returns the value of attribute heartbeat.



12
13
14
 
# File 'lib/origen_sim/simulator.rb', line 12

def heartbeat
  @heartbeat
end

#pid ⇒ Object (readonly)

Returns the PID of the simulator process



15
16
17
 
# File 'lib/origen_sim/simulator.rb', line 15

def pid
  @pid
end

#socket ⇒ Object (readonly)

Returns the value of attribute socket.



12
13
14
 
# File 'lib/origen_sim/simulator.rb', line 12

def socket
  @socket
end

#stderr ⇒ Object (readonly)

Returns the value of attribute stderr.



12
13
14
 
# File 'lib/origen_sim/simulator.rb', line 12

def stderr
  @stderr
end

#stdout ⇒ Object (readonly)

Returns the value of attribute stdout.



12
13
14
 
# File 'lib/origen_sim/simulator.rb', line 12

def stdout
  @stdout
end

Instance Method Details

#before_pattern(name) ⇒ Object

Called before every pattern is generated, but we only use it the first time it is called to kick off the simulator process if the current tester is an OrigenSim::Tester



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/origen_sim/simulator.rb', line 492

def before_pattern(name)
  @simulation_completed_cleanly = false
  if simulation_tester?
    unless @enabled
      # When running pattern back-to-back, only want to launch the simulator the
      # first time
      unless socket
        start
      end
    end
    # Set the current pattern name in the simulation
    put("a^#{name.sub(/\..*/, '')}")
    @pattern_count ||= 0
    if @pattern_count > 0
      c = error_count
      if c > 0
        Origen.log.error "The simulation currently has #{c} error(s)!"
      else
        Origen.log.success 'There are no simulation errors yet!'
      end
    end
    @pattern_count += 1
  end
end

#commit_simulation_objects(options = {}) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/origen_sim/simulator.rb', line 87

def commit_simulation_objects(options = {})
  sid = options[:id] || id
  ldir = "#{Origen.root}/simulation/#{sid}"
  tmp_dir = "#{Origen.root}/tmp/origen_sim/tmp"
  unless File.exist?(ldir)
    fail "The simulation directory to check in does not exist: #{ldir}"
  end
  Dir.chdir "#{Origen.root}/simulation/" do
    system "tar -cvzf #{sid}.tar.gz #{sid}"
  end

  FileUtils.rm_rf(tmp_dir) if File.exist?(tmp_dir)
  FileUtils.mkdir_p(tmp_dir)
  FileUtils.cp "#{ldir}.tar.gz", tmp_dir

  rc = Origen::RevisionControl.new remote: config[:rc_dir_url], local: tmp_dir
  rc.checkin "#{sid}.tar.gz", unmanaged: true, force: true, comment: 'Checked in via sim:rc command'
ensure
  FileUtils.rm_f "#{ldir}.tar.gz" if File.exist?("#{ldir}.tar.gz")
  FileUtils.rm_rf tmp_dir if File.exist?(tmp_dir)
end

#compiled_dir ⇒ Object

Returns the directory where the compiled simulation object lives, this should be checked into your Origen app’s repository



135
136
137
138
139
140
141
 
# File 'lib/origen_sim/simulator.rb', line 135

def compiled_dir
  @compiled_dir ||= begin
    d = "#{Origen.root}/simulation/#{id}/#{config[:vendor]}"
    FileUtils.mkdir_p(d)
    d
  end
end

#config_changed? ⇒ Boolean

Returns true if the config has been changed since the last time we called save_config_signature

Returns:

  • (Boolean) 


824
825
826
 
# File 'lib/origen_sim/simulator.rb', line 824

def config_changed?
  Origen.app.session.origen_sim["#{id}_config"] != config
end

#configure(options, &block) ⇒ Object 



109
110
111
112
113
114
115
116
 
# File 'lib/origen_sim/simulator.rb', line 109

def configure(options, &block)
  fail 'A vendor must be supplied, e.g. OrigenSim::Tester.new(vendor: :icarus)' unless options[:vendor]
  unless VENDORS.include?(options[:vendor])
    fail "Unknown vendor #{options[:vendor]}, valid values are: #{VENDORS.map { |v| ':' + v.to_s }.join(', ')}"
  end
  @configuration = options
  @tmp_dir = nil
end

#cycle(number_of_cycles) ⇒ Object 



591
592
593
594
 
# File 'lib/origen_sim/simulator.rb', line 591

def cycle(number_of_cycles)
  put("3^#{number_of_cycles}")
  read_sim_output
end

#define_pins ⇒ Object

Tells the simulator about the pins in the current device so that it can set up internal handles to efficiently access them



547
548
549
550
551
552
553
554
555
 
# File 'lib/origen_sim/simulator.rb', line 547

def define_pins
  dut.rtl_pins.each_with_index do |(name, pin), i|
    pin.simulation_index = i
    put("0^#{pin.rtl_name}^#{i}^#{pin.drive_wave.index}^#{pin.compare_wave.index}")
  end
  dut.rtl_pins.each do |name, pin|
    pin.apply_force
  end
end

#define_waves ⇒ Object 



573
574
575
576
577
578
579
580
 
# File 'lib/origen_sim/simulator.rb', line 573

def define_waves
  dut.timeset.drive_waves.each_with_index do |wave, i|
    put("6^#{i}^0^#{wave_to_str(wave)}")
  end
  dut.timeset.compare_waves.each_with_index do |wave, i|
    put("6^#{i}^1^#{wave_to_str(wave)}")
  end
end

#dut_version ⇒ Object

Returns the version of Origen Sim that the current DUT object was compiled with



835
836
837
838
839
840
 
# File 'lib/origen_sim/simulator.rb', line 835

def dut_version
  @dut_version ||= begin
    put('i^')
    Origen::VersionString.new(get.strip)
  end
end

#end_simulation ⇒ Object 



582
583
584
 
# File 'lib/origen_sim/simulator.rb', line 582

def end_simulation
  put('8^')
end

#error_count ⇒ Object

Returns the current simulation error count



638
639
640
 
# File 'lib/origen_sim/simulator.rb', line 638

def error_count
  peek("#{testbench_top}.debug.errors").to_i
end

#fetch_simulation_objects(options = {}) ⇒ Object 



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
 
# File 'lib/origen_sim/simulator.rb', line 48

def fetch_simulation_objects(options = {})
  sid = options[:id] || id
  ldir = "#{Origen.root}/simulation/#{sid}"
  tmp_dir = "#{Origen.root}/tmp/origen_sim/tmp"
  if config[:rc_dir_url]
    unless config[:rc_version]
      puts "You must supply an :rc_version option when using :rc_dir_url (you can set this to something like 'Trunk' or 'master' if you want)"
      exit 1
    end
    if !File.exist?(compiled_dir) ||
       (File.exist?(compiled_dir) && Dir.entries(compiled_dir).size <= 2) ||
       (Origen.app.session.origen_sim[sid] != config[:rc_version]) ||
       options[:force]
      Origen.log.info "Fetching the simulation object for #{sid}..."
      Origen.app.session.origen_sim[sid] = nil # Clear this up front, if the checkout fails we won't know what we have
      FileUtils.rm_rf(tmp_dir) if File.exist?(tmp_dir)
      FileUtils.mkdir_p(tmp_dir)
      FileUtils.mkdir_p("#{Origen.root}/simulation")
      rc = Origen::RevisionControl.new remote: config[:rc_dir_url], local: tmp_dir
      rc.checkout "#{sid}.tar.gz", force: true, version: config[:rc_version]
      FileUtils.mv "#{tmp_dir}/#{sid}.tar.gz", "#{Origen.root}/simulation"
      FileUtils.rm_rf(ldir) if File.exist?(ldir)
      Dir.chdir "#{Origen.root}/simulation/" do
        system "tar -xvf #{sid}.tar.gz"
      end
      Origen.app.session.origen_sim[sid] = config[:rc_version]
    end
  else
    if !File.exist?(compiled_dir) ||
       (File.exist?(compiled_dir) && Dir.entries(compiled_dir).size <= 2)
      puts "There is no previously compiled simulation object in: #{compiled_dir}"
      exit 1
    end
  end
ensure
  FileUtils.rm_f "#{ldir}.tar.gz" if File.exist?("#{ldir}.tar.gz")
  FileUtils.rm_rf tmp_dir if File.exist?(tmp_dir)
end

#generic_run_cmd ⇒ Object 



40
41
42
 
# File 'lib/origen_sim/simulator.rb', line 40

def generic_run_cmd
  config[:generic_run_cmd]
end

#get ⇒ Object

Get a message from the simulator, will block until one is received



477
478
479
 
# File 'lib/origen_sim/simulator.rb', line 477

def get
  socket.readline
end

#id ⇒ Object

The ID assigned to the current simulation target, falls back to to the Origen target name if an :id option is not supplied when instantiating the tester



121
122
123
 
# File 'lib/origen_sim/simulator.rb', line 121

def id
  config[:id] || Origen.target.name
end

#interactive_shutdown ⇒ Object 



729
730
731
 
# File 'lib/origen_sim/simulator.rb', line 729

def interactive_shutdown
  @interactive_mode = true
end

#log_messages=(val) ⇒ Object

When set to true the simulator will log all messages it receives, note that this must be run in conjunction with -d supplied to the Origen command to actually see the messages



24
25
26
27
28
29
30
 
# File 'lib/origen_sim/simulator.rb', line 24

def log_messages=(val)
  if val
    put('d^1')
  else
    put('d^0')
  end
end

#on_origen_shutdown ⇒ Object 



750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/origen_sim/simulator.rb', line 750

def on_origen_shutdown
  if @enabled
    unless @interactive_mode
      Origen.log.debug 'Shutting down simulator...'
      unless @failed_to_start
        c = error_count
        if c > 0 || @simulator_logged_errors || @stderr_logged_errors
          @failed = true
          Origen.log.error "The simulation failed with #{c} errors!" if c > 0
          Origen.log.error 'The simulation log reported errors!' if @simulator_logged_errors
          Origen.log.error 'The simulation stderr reported errors!' if @stderr_logged_errors
        elsif !@simulation_completed_cleanly
          @failed = true
          Origen.log.error 'The simulation exited early!'
        end
      end
    end
    stop
    unless @interactive_mode
      if failed
        Origen.app.stats.report_fail
      else
        Origen.app.stats.report_pass
      end
    end
    if view_wave_command
      puts
      puts 'To view the simulation run the following command:'
      puts
      puts "  #{view_wave_command}"
      puts
    end
  end
end

#on_timeset_changed ⇒ Object

This will be called automatically whenever tester.set_timeset has been called



534
535
536
537
538
539
540
541
542
543
 
# File 'lib/origen_sim/simulator.rb', line 534

def on_timeset_changed
  # Important that this is done first, since it is used to clear the pin
  # and wave definitions in the bridge
  set_period(dut.current_timeset_period)
  # Clear pins and waves
  define_pins
  define_waves
  # Apply the pin reset values / re-apply the existing states
  put_all_pin_states
end

#pattern_generated(path) ⇒ Object

This will be called at the end of every pattern, make sure the simulator is not running behind before potentially moving onto another pattern



484
485
486
487
 
# File 'lib/origen_sim/simulator.rb', line 484

def pattern_generated(path)
  sync_up if simulation_tester?
  @simulation_completed_cleanly = true
end

#peek(net) ⇒ Object

Returns the current value of the given net, or nil if the given path does not resolve to a valid node

The value is returned as an instance of Origen::Value



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/origen_sim/simulator.rb', line 646

def peek(net)
  # The Verilog spec does not specify that underlying VPI put method should
  # handle a part select, so some simulators do not handle it. Therefore we
  # deal with it here to ensure cross simulator compatibility.

  # http://rubular.com/r/eTVGzrYmXQ
  if net =~ /(.*)\[(\d+):?(\.\.)?(\d*)\]$/
    net = Regexp.last_match(1)
    msb = Regexp.last_match(2).to_i
    lsb = Regexp.last_match(4)
    lsb = lsb.empty? ? nil : lsb.to_i
  end

  sync_up
  put("9^#{clean(net)}")
  m = get.strip

  if m == 'FAIL'
    return nil
  else
    if msb
      # Setting a range of bits
      if lsb
        Origen::Value.new('b' + m[(m.size - 1 - msb)..(m.size - 1 - lsb)])
      else
        Origen::Value.new('b' + m[m.size - 1 - msb])
      end
    else
      Origen::Value.new('b' + m)
    end
  end
end

#poke(net, value) ⇒ Object

Forces the given value to the given net. Note that no error checking is done and no error will be communicated if an illegal net is supplied. The user should follow up with a peek if they want to verify that the poke was applied.



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/origen_sim/simulator.rb', line 683

def poke(net, value)
  # The Verilog spec does not specify that underlying VPI put method should
  # handle a part select, so some simulators do not handle it. Therefore we
  # deal with it here to ensure cross simulator compatibility.

  # http://rubular.com/r/eTVGzrYmXQ
  if !config[:vendor] == :synopsys && net =~ /(.*)\[(\d+):?(\.\.)?(\d*)\]$/
    path = Regexp.last_match(1)
    msb = Regexp.last_match(2).to_i
    lsb = Regexp.last_match(4)
    lsb = lsb.empty? ? nil : lsb.to_i

    v = peek(path)
    return nil unless v
    # Setting a range of bits
    if lsb
      upper = v >> (msb + 1)
      # Make sure value does not overflow
      value = value[(msb - lsb)..0]
      if lsb == 0
        value = (upper << (msb + 1)) | value
      else
        lower = v[(lsb - 1)..0]
        value = (upper << (msb + 1)) |
                (value << lsb) | lower
      end

    # Setting a single bit
    else
      if msb == 0
        upper = v >> 1
        value = (upper << 1) | value[0]
      else
        lower = v[(msb - 1)..0]
        upper = v >> (msb + 1)
        value = (upper << (msb + 1)) |
                (value[0] << msb) | lower
      end
    end
    net = path
  end

  sync_up
  put("b^#{clean(net)}^#{value}")
end

#post_process_run_cmd ⇒ Object 



44
45
46
 
# File 'lib/origen_sim/simulator.rb', line 44

def post_process_run_cmd
  config[:post_process_run_cmd]
end

#put(msg) ⇒ Object

Send the given message string to the simulator



471
472
473
 
# File 'lib/origen_sim/simulator.rb', line 471

def put(msg)
  socket.write(msg + "\n") if socket
end

#put_all_pin_states ⇒ Object

Applies the current state of all pins to the simulation



525
526
527
528
529
530
 
# File 'lib/origen_sim/simulator.rb', line 525

def put_all_pin_states
  dut.rtl_pins.each do |name, pin|
    pin.reset_simulator_state
    pin.update_simulation
  end
end

#read_sim_output ⇒ Object 



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/origen_sim/simulator.rb', line 607

def read_sim_output
  while stdout.ready?
    line = stdout.gets.chomp
    if OrigenSim.error_strings.any? { |s| line =~ /#{s}/ } &&
       !OrigenSim.error_string_exceptions.any? { |s| line =~ /#{s}/ }
      @simulator_logged_errors = true
      Origen.log.error "(STDOUT): #{line}"
    else
      if OrigenSim.verbose? ||
         OrigenSim.log_strings.any? { |s| line =~ /#{s}/ }
        Origen.log.info line
      else
        Origen.log.debug line
      end
    end
  end
  while stderr.ready?
    line = stderr.gets.chomp
    if OrigenSim.fail_on_stderr && !OrigenSim.stderr_string_exceptions.any? { |s| line =~ /#{s}/ }
      # We're failing on stderr, so print its results and log as errors if its not an exception.
      @stderr_logged_errors = true
      Origen.log.error "(STDERR): #{line}"
    elsif OrigenSim.verbose?
      # We're not failing on stderr, or the string in stderr is an exception.
      # Print the string as regular output if verbose is set, otherwise just ignore.
      Origen.log.info line
    end
  end
end

#rtl_top ⇒ Object 



36
37
38
 
# File 'lib/origen_sim/simulator.rb', line 36

def rtl_top
  config[:rtl_top] || 'dut'
end

#run_cmd ⇒ Object 



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
 
# File 'lib/origen_sim/simulator.rb', line 194

def run_cmd
  case config[:vendor]
  when :icarus
    cmd = configuration[:vvp] || 'vvp'
    cmd += " -M#{compiled_dir} -morigen #{compiled_dir}/origen.vvp +socket+#{socket_id}"

  when :cadence
    input_file = "#{tmp_dir}/#{id}.tcl"
    if !File.exist?(input_file) || config_changed?
      Origen.app.runner.launch action:            :compile,
                               files:             "#{Origen.root!}/templates/probe.tcl.erb",
                               output:            tmp_dir,
                               check_for_changes: false,
                               quiet:             true,
                               options:           { dir: wave_dir, force: config[:force], setup: config[:setup], depth: :all },
                               output_file_name:  "#{id}.tcl"
    end
    input_file_fast = "#{tmp_dir}/#{id}_fast.tcl"
    if !File.exist?(input_file_fast) || config_changed?
      fast_probe_depth = config[:fast_probe_depth] || 1
      Origen.app.runner.launch action:            :compile,
                               files:             "#{Origen.root!}/templates/probe.tcl.erb",
                               output:            tmp_dir,
                               check_for_changes: false,
                               quiet:             true,
                               options:           { dir: wave_dir, force: config[:force], setup: config[:setup], depth: fast_probe_depth },
                               output_file_name:  "#{id}_fast.tcl"
    end
    save_config_signature
    wave_dir  # Ensure this exists since it won't be referenced above if the input file is already generated

    cmd = configuration[:irun] || 'irun'
    cmd += " -r origen -snapshot origen +socket+#{socket_id}"
    cmd += $use_fast_probe_depth ? " -input #{input_file_fast}" : " -input #{input_file}"
    cmd += " -nclibdirpath #{compiled_dir}"

  when :synopsys
    cmd = "#{compiled_dir}/simv +socket+#{socket_id} -vpd_file origen.vpd"

  when :generic
    # Generic tester requires that a generic_run_command option/block be provided.
    # This should either be a string, an array (which will be joined here), or a block that needs to return either
    # a string or array. In the event of a block, the block will be given the simulator.
    if generic_run_cmd
      cmd = generic_run_cmd
      if cmd.is_a?(Proc)
        cmd = cmd.call(self)
      end

      if cmd.is_a?(Array)
        # We'll join this together with the '; ' string. This means that each array element will be run
        # sequentially.
        cmd = cmd.join(' && ')
      elsif !cmd.is_a?(String)
        # If its Proc, it was already run, and if its a Array if would have gone into the other case.
        # So, this is either another proc, not an array and not a string, so not sure what to do with this.
        # Complain about the cmd.
        fail "OrigenSim :generic_run_cmd is of class #{generic_run_cmd.class}. It must be either an Array, String, or a Proc that returns an Array or String."
      end
    else
      fail 'OrigenSim Generic Toolchain/Vendor requires a :generic_run_cmd option/block to be provided. No options/block provided!'
    end

  else
    fail "Run cmd not defined yet for simulator #{config[:vendor]}"

  end

  # Allow the user to post-process the command. This should be a block which will be given two parameters:
  # 1. the command, and 2. the simulation object (self).
  # In the event of a generic tester, this *could* replace the launch command, but that's not the real intention,
  # since a simulator could be made that inherits from a generic simulator setup and still post process the command.
  cmd = post_process_run_cmd.call(cmd, self) if post_process_run_cmd
  fail "OrigenSim: :post_process_run_cmd returned object of class #{cmd.class}. Must return a String." unless cmd.is_a?(String)

  cmd
end

#run_dir ⇒ Object 



321
322
323
324
325
326
327
328
 
# File 'lib/origen_sim/simulator.rb', line 321

def run_dir
  case config[:vendor]
  when :icarus, :synopsys
    wave_dir
  else
    tmp_dir
  end
end

#running? ⇒ Boolean

Returns true if the simulator process is running

Returns:

  • (Boolean) 


460
461
462
463
464
465
466
467
468
 
# File 'lib/origen_sim/simulator.rb', line 460

def running?
  return false unless pid
  begin
    Process.getpgid(pid)
    true
  rescue Errno::ESRCH
    false
  end
end

#save_config_signature ⇒ Object

Locally saves a signature for the current config, this will cause config_changed? to return false until its contents change



830
831
832
 
# File 'lib/origen_sim/simulator.rb', line 830

def save_config_signature
  Origen.app.session.origen_sim["#{id}_config"] = config
end

#set_period(period_in_ns) ⇒ Object 



586
587
588
589
 
# File 'lib/origen_sim/simulator.rb', line 586

def set_period(period_in_ns)
  period_in_ps = period_in_ns * time_conversion_factor * (config[:time_factor] || 1)
  put("1^#{period_in_ps}")
end

#simulation_tester? ⇒ Boolean

Returns:

  • (Boolean) 


793
794
795
 
# File 'lib/origen_sim/simulator.rb', line 793

def simulation_tester?
  (tester && tester.is_a?(OrigenSim::Tester))
end

#socket_id(type = nil) ⇒ Object 



785
786
787
 
# File 'lib/origen_sim/simulator.rb', line 785

def socket_id(type = nil)
  @socket_ids[type] ||= "/tmp/#{socket_number}#{type}.sock"
end

#socket_number ⇒ Object 



789
790
791
 
# File 'lib/origen_sim/simulator.rb', line 789

def socket_number
  @socket_number ||= (Process.pid.to_s + Time.now.to_f.to_s).sub('.', '')
end

#start ⇒ Object

Starts up the simulator process



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
 
# File 'lib/origen_sim/simulator.rb', line 331

def start
  fetch_simulation_objects

  # Socket used for Origen -> Verilog commands
  server = UNIXServer.new(socket_id)
  # Socket used to capture stdout from the simulator
  stdout_socket_id = socket_id(:stdout)
  # Socket used to capture stderr from the simulator
  stderr_socket_id = socket_id(:stderr)
  # Socket used to provide a heartbeat to let the Ruby process in charge of the simulator
  # know that the mast Origen process is still alive. If the Origen process crashes and leaves
  # the simulator running, the child process will automatically reap it after a couple of missed
  # heartbeats
  heartbeat_socket_id = socket_id(:heartbeat)
  server_stdout = UNIXServer.new(stdout_socket_id)
  server_stderr = UNIXServer.new(stderr_socket_id)
  server_heartbeat = UNIXServer.new(heartbeat_socket_id)
  cmd = run_cmd + ' & echo \$!'

  launch_simulator = %(
    require 'open3'
    require 'socket'
    require 'io/wait'
    require 'origen'

    pid = nil

    stdout_socket = UNIXSocket.new('#{stdout_socket_id}')
    stderr_socket = UNIXSocket.new('#{stderr_socket_id}')
    heartbeat = UNIXSocket.new('#{heartbeat_socket_id}')

    begin

      Dir.chdir '#{run_dir}' do
        Open3.popen3('#{cmd}') do |stdin, stdout, stderr, thread|
          pid = stdout.gets.strip.to_i
          heartbeat.puts(pid.to_s)

          # Listen for a heartbeat from the main Origen process every 5 seconds, kill the
          # simulator after two missed heartbeats
          Thread.new do
            missed_heartbeats = 0
            loop do
              sleep 5
              if heartbeat.ready?
                while heartbeat.ready? do
                  heartbeat.gets
                end
                missed_heartbeats = 0
              else
                missed_heartbeats += 1
              end
              if missed_heartbeats > 1
                Process.kill('KILL', pid)
                exit!(1)
              end
            end
          end

          threads = []
          threads << Thread.new do
            until (line = stdout.gets).nil?
              stdout_socket.puts line
            end
          end
          threads << Thread.new do
            until (line = stderr.gets).nil?
              stderr_socket.puts line
            end
          end
          threads.each(&:join)
        end
      end

    ensure
      # Make sure this process never finishes and leaves the simulator running
      begin
        # If the process already finished, then we will see an Errno exception.
        # It does not harm anything, but looks ugly, so catch it here and ignore.
        Process.kill('KILL', pid) if pid
        0
      rescue Errno::ESRCH => e
        0
      end
    end
  )

  simulator_parent_process = spawn("ruby -e \"#{launch_simulator}\"")
  Process.detach(simulator_parent_process)

  timeout_connection(config[:startup_timeout] || 60) do
    @heartbeat = server_heartbeat.accept
    @pid = heartbeat.gets.chomp.to_i

    # Send a heartbeat to the child process running the simulator every 5 seconds
    Thread.new do
      loop do
        heartbeat.write("OK\n")
        sleep 5
      end
    end

    @stdout = server_stdout.accept
    @stderr = server_stderr.accept
    @socket = server.accept
    @connection_established = true
    if @connection_timed_out
      @failed_to_start = true
      Origen.log.error 'Simulator failed to respond'
      @failed = true
      exit
    end
  end
  data = get
  unless data.strip == 'READY!'
    @failed_to_start = true
    fail "The simulator didn't start properly!"
  end
  @enabled = true
  # Tick the simulation on, this seems to be required since any VPI puts operations before
  # the simulation has started are not applied.
  # Note that this is not setting a tester timeset, so the application will still have to
  # do that before generating any vectors.
  set_period(100)
  cycle(1)
  Origen.listeners_for(:simulation_startup).each(&:simulation_startup)
end

#stop ⇒ Object

Stop the simulator



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/origen_sim/simulator.rb', line 734

def stop
  Origen.listeners_for(:simulation_shutdown).each(&:simulation_shutdown)
  ended = Time.now
  end_simulation
  # Give the simulator time to shut down
  sleep 0.1 while running?
  socket.close if socket
  stderr.close if stderr
  stdout.close if stdout
  heartbeat.close if heartbeat
  File.unlink(socket_id) if File.exist?(socket_id)
  File.unlink(socket_id(:stderr)) if File.exist?(socket_id(:stderr))
  File.unlink(socket_id(:stdout)) if File.exist?(socket_id(:stdout))
  File.unlink(socket_id(:heartbeat)) if File.exist?(socket_id(:heartbeat))
end

#sync ⇒ Object 



811
812
813
814
815
816
817
 
# File 'lib/origen_sim/simulator.rb', line 811

def sync
  put('f')
  @sync_active = true
  yield
  put('g')
  @sync_active = false
end

#sync_active? ⇒ Boolean

Returns:

  • (Boolean) 


819
820
821
 
# File 'lib/origen_sim/simulator.rb', line 819

def sync_active?
  @sync_active
end

#sync_up ⇒ Object

Blocks the Origen process until the simulator indicates that it has processed all operations up to this point



598
599
600
601
602
603
604
605
 
# File 'lib/origen_sim/simulator.rb', line 598

def sync_up
  put('7^')
  data = get
  unless data.strip == 'OK!'
    fail 'Origen and the simulator are out of sync!'
  end
  read_sim_output
end

#testbench_top ⇒ Object 



32
33
34
 
# File 'lib/origen_sim/simulator.rb', line 32

def testbench_top
  config[:testbench_top] || 'origen'
end

#timeout_connection(wait_in_s) ⇒ Object 



797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/origen_sim/simulator.rb', line 797

def timeout_connection(wait_in_s)
  @connection_timed_out = false
  t = Thread.new do
    sleep wait_in_s
    # If the Verilog process has not established a connection yet, then make one to
    # release our process and then exit
    unless @connection_established
      @connection_timed_out = true
      UNIXSocket.new(socket_id).puts("Time out\n")
    end
  end
  yield
end

#tmp_dir ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/origen_sim/simulator.rb', line 125

def tmp_dir
  @tmp_dir ||= begin
    d = "#{Origen.root}/tmp/origen_sim/#{id}/#{config[:vendor]}"
    FileUtils.mkdir_p(d)
    d
  end
end

#view_wave_command ⇒ Object 



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
 
# File 'lib/origen_sim/simulator.rb', line 272

def view_wave_command
  cmd = nil
  case config[:vendor]
  when :icarus
    edir = Pathname.new(wave_config_dir).relative_path_from(Pathname.pwd)
    cmd = "cd #{edir} && "
    cmd += configuration[:gtkwave] || 'gtkwave'
    dir = Pathname.new(wave_dir).relative_path_from(edir.expand_path)
    cmd += " #{dir}/origen.vcd "
    f = Pathname.new(wave_config_file).relative_path_from(edir.expand_path)
    cmd += " --save #{f} &"

  when :cadence
    edir = Pathname.new(wave_config_dir).relative_path_from(Pathname.pwd)
    cmd = "cd #{edir} && "
    cmd += configuration[:simvision] || 'simvision'
    dir = Pathname.new(wave_dir).relative_path_from(edir.expand_path)
    cmd += " #{dir}/#{id}.dsn #{dir}/#{id}.trn"
    f = Pathname.new(wave_config_file).relative_path_from(edir.expand_path)
    cmd += " -input #{f} &"

  when :synopsys
    edir = Pathname.new(wave_config_dir).relative_path_from(Pathname.pwd)
    cmd = "cd #{edir} && "
    cmd += configuration[:dve] || 'dve'
    dir = Pathname.new(wave_dir).relative_path_from(edir.expand_path)
    cmd += " -vpd #{dir}/origen.vpd"
    f = Pathname.new(wave_config_file).relative_path_from(edir.expand_path)
    cmd += " -session #{f}"
    cmd += ' &'

  when :generic
    # Since this could be anything, the simulator will need to set this up. But, once it is, we can print it here.
    if config[:view_waveform_cmd]
      cmd = config[:view_waveform_cmd]
    else
      Origen.log.warn 'OrigenSim cannot provide a view-waveform command for a :generic vendor.'
      Origen.log.warn 'Please supply a view-waveform command though the :view_waveform_cmd option during the OrigenSim::Generic instantiation.'
    end

  else
    # Print a warning stating an unknown vendor was reached here.
    # This shouldn't happen, but just in case.
    Origen.log.warn "OrigenSim does not know the command to view waveforms for vendor :#{config[:vendor]}!"

  end
  cmd
end

#wave_config_dir ⇒ Object 



151
152
153
154
155
156
157
 
# File 'lib/origen_sim/simulator.rb', line 151

def wave_config_dir
  @wave_config_dir ||= begin
    d = "#{Origen.root}/config/waves/#{id}"
    FileUtils.mkdir_p(d)
    d
  end
end

#wave_config_ext ⇒ Object 



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/origen_sim/simulator.rb', line 183

def wave_config_ext
  case config[:vendor]
  when :icarus
    'gtkw'
  when :cadence
    'svcf'
  when :synopsys
    'tcl'
  end
end

#wave_config_file ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/origen_sim/simulator.rb', line 159

def wave_config_file
  @wave_config_file ||= begin
    f = "#{wave_config_dir}/#{User.current.id}.#{wave_config_ext}"
    unless File.exist?(f)
      # Take a default wave if one has been set up
      d = "#{wave_config_dir}/default.#{wave_config_ext}"
      if File.exist?(d)
        FileUtils.cp(d, f)
      else
        # Otherwise seed it with the latest existing setup by someone else
        d = Dir.glob("#{wave_config_dir}/*.#{wave_config_ext}").max { |a, b| File.ctime(a) <=> File.ctime(b) }
        if d
          FileUtils.cp(d, f)
        else
          # We tried our best, start from scratch
          d = "#{Origen.root!}/templates/empty.#{wave_config_ext}"
          FileUtils.cp(d, f) if File.exist?(d)
        end
      end
    end
    f
  end
end

#wave_dir ⇒ Object 



143
144
145
146
147
148
149
 
# File 'lib/origen_sim/simulator.rb', line 143

def wave_dir
  @wave_dir ||= begin
    d = "#{Origen.root}/waves/#{id}"
    FileUtils.mkdir_p(d)
    d
  end
end

#wave_to_str(wave) ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/origen_sim/simulator.rb', line 557

def wave_to_str(wave)
  wave.evaluated_events.map do |time, data|
    time = time * time_conversion_factor * (config[:time_factor] || 1)
    if data == :x
      data = 'X'
    elsif data == :data
      data = wave.drive? ? 'D' : 'C'
    end
    if data == 'C'
      "#{time}_#{data}_#{time + (time_conversion_factor * (config[:time_factor] || 1))}_X"
    else
      "#{time}_#{data}"
    end
  end.join('_')
end

#write_comment(comment) ⇒ Object 



517
518
519
520
521
522
 
# File 'lib/origen_sim/simulator.rb', line 517

def write_comment(comment)
  # Not sure what the limiting factor here is, the comment memory in the test bench should
  # be able to handle 1024 / 8 length strings, but any bigger than this hangs the simulation
  comment = comment[0..96]
  put("c^#{comment}")
end