Class: OrigenSim::Simulation

Inherits:
Object
  • Object
show all
Defined in:
lib/origen_sim/simulation.rb

Overview

Responsible for managing each individual simulation that is run in an Origen thread e.g. If multiple patterns are run in separate simulations, then one instance of this class will exist for each one.

It is primarily responsible for all communications with the simulation and capturing log output and errors.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, view_wave_command) ⇒ Simulation

Returns a new instance of Simulation.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/origen_sim/simulation.rb', line 22

def initialize(id, view_wave_command)
  @id = id
  @view_wave_command = view_wave_command
  @completed_cleanly = false
  @failed_to_start = false
  @logged_errors = false
  @error_count = 0
  @socket_ids = {}

  @server = UNIXServer.new(socket_id) # Socket used to send Origen -> Verilog commands
  @server_stdout = UNIXServer.new(socket_id(:stdout))
  @server_stderr = UNIXServer.new(socket_id(:stderr))
  @server_heartbeat = UNIXServer.new(socket_id(:heartbeat))
end

Instance Attribute Details

#completed_cleanly ⇒ Object

Returns the value of attribute completed_cleanly.



16
17
18
 
# File 'lib/origen_sim/simulation.rb', line 16

def completed_cleanly
  @completed_cleanly
end

#error_count ⇒ Object

Returns the value of attribute error_count.



16
17
18
 
# File 'lib/origen_sim/simulation.rb', line 16

def error_count
  @error_count
end

#failed_to_start ⇒ Object

Returns the value of attribute failed_to_start.



16
17
18
 
# File 'lib/origen_sim/simulation.rb', line 16

def failed_to_start
  @failed_to_start
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



14
15
16
 
# File 'lib/origen_sim/simulation.rb', line 14

def id
  @id
end

#logged_errors ⇒ Object

Returns the value of attribute logged_errors.



16
17
18
 
# File 'lib/origen_sim/simulation.rb', line 16

def logged_errors
  @logged_errors
end

#pid ⇒ Object

Returns the value of attribute pid.



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

def pid
  @pid
end

#socket ⇒ Object (readonly)

Returns the communication socket used for sending commands to the Origen VPI running in the simulation process



20
21
22
 
# File 'lib/origen_sim/simulation.rb', line 20

def socket
  @socket
end

#view_wave_command ⇒ Object (readonly)

Returns the value of attribute view_wave_command.



14
15
16
 
# File 'lib/origen_sim/simulation.rb', line 14

def view_wave_command
  @view_wave_command
end

Instance Method Details

#close ⇒ Object

Close all communication channels with the simulator



103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/origen_sim/simulation.rb', line 103

def close
  return unless @opened
  stop_heartbeat
  @stdout_reader.stop
  @stderr_reader.stop
  @heartbeat.close
  @socket.close
  @stderr.close
  @stdout.close
  File.unlink(socket_id(:heartbeat)) if File.exist?(socket_id(: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))
end

#failed?(in_progress = false) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
42
43
44
 
# File 'lib/origen_sim/simulation.rb', line 37

def failed?(in_progress = false)
  failed = stderr_logged_errors || logged_errors || failed_to_start || error_count > 0
  if in_progress
    failed
  else
    failed || !completed_cleanly
  end
end

#log_results(in_progress = false) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/origen_sim/simulation.rb', line 54

def log_results(in_progress = false)
  if failed?(in_progress)
    if failed_to_start
      Origen.log.error 'The simulation failed to start!'
    else
      if in_progress
        Origen.log.error "The simulation has #{error_count} error#{error_count > 1 ? 's' : ''}!" if error_count > 0
      else
        Origen.log.error "The simulation failed with #{error_count} errors!" if error_count > 0
      end
      Origen.log.error 'The simulation log reported errors!' if logged_errors
      Origen.log.error 'The simulation stderr reported errors!' if stderr_logged_errors
      Origen.log.error 'The simulation exited early!' unless completed_cleanly || in_progress
    end
  else
    if in_progress
      Origen.log.success 'The simulation is passing!'
    else
      Origen.log.success 'The simulation passed!'
    end
  end
end

#open ⇒ Object

Open the communication channels with the simulator



92
93
94
95
96
97
98
99
100
 
# File 'lib/origen_sim/simulation.rb', line 92

def open
  start_heartbeat
  @stdout = @server_stdout.accept
  @stderr = @server_stderr.accept
  @socket = @server.accept
  @stdout_reader = StdoutReader.new(@stdout)
  @stderr_reader = StderrReader.new(@stderr)
  @opened = true
end

#running? ⇒ Boolean

Returns true if the simulation is running

Returns:

  • (Boolean) 


119
120
121
122
123
124
125
126
127
 
# File 'lib/origen_sim/simulation.rb', line 119

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

#socket_id(type = nil) ⇒ Object 



129
130
131
 
# File 'lib/origen_sim/simulation.rb', line 129

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

#start_heartbeat ⇒ Object

Provide a heartbeat to let the parallel Ruby process in charge of the simulator know that the master 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.



81
82
83
84
85
 
# File 'lib/origen_sim/simulation.rb', line 81

def start_heartbeat
  @heartbeat = @server_heartbeat.accept
  @pid = @heartbeat.gets.chomp.to_i
  @heartbeat_thread = Heartbeat.new(@heartbeat)
end

#stderr_logged_errors ⇒ Object 



50
51
52
 
# File 'lib/origen_sim/simulation.rb', line 50

def stderr_logged_errors
  @stderr_reader.logged_errors
end

#stop_heartbeat ⇒ Object 



87
88
89
 
# File 'lib/origen_sim/simulation.rb', line 87

def stop_heartbeat
  @heartbeat_thread.stop
end