ruby-vpi 12.1.0 → 13.0.0

data/doc/history.rb

@@ -7,7 +7,7 @@ require 'yaml'
 def format_history_entry aEntry
   output = "h1(##{aEntry['Version']}). Version #{aEntry['Version']} (#{aEntry['Date']})\n\n"
 
-  %w[Summary Acknowledgment Notice Detail].each do |key|
+  %w[Summary Acknowledgment Notice Details].each do |key|
     if content = aEntry[key]
       output << "h2. #{key}\n\n#{content}\n\n"
     end

data/doc/history.yml

@@ -1,3 +1,31 @@
+-
+  Version: 13.0.0
+
+  Date: 2006-12-27
+
+  Summary: |
+    This release fixes a _major_ instability bug, simplifies generated Verilog benches, and purifies the API reference documentation.
+
+  Notice: |
+    * The @$ruby_init@ and @$ruby_relay@ system task/functions have been removed. Generated Verilog benches no longer use them.
+    ** To pass your own command-line options to Ruby, set the @RUBYOPT@ environment variable before running a test.
+
+    h3. New features
+
+    * You can now choose when @Vpi::relay_verilog@ is triggered: upon positive/negative edge of the clock signal, or any other criteria. This is done by passing a block to the @RubyVpi::init_bench@ method (see "the API reference documentation":../ref/ruby/classes/RubyVpi.html for details).
+
+  Details: |
+    * Fixed a major instability bug that was randomly causing segmentation faults and pthread assertion failures.
+
+      The problem was that the @$ruby_init@ system task/function was mischeviously unlocking a pthread mutex. From then onward, all code assumed that the mutex was still locked -- but in reality, the mutex was already unlocked.
+
+    * Replaced the @$ruby_init@ and @$ruby_relay@ system task/functions with callbacks.
+
+    * Excluded internal stuff from the API reference documentation for Ruby.
+
+    * Removed system-dependent path <tt>/usr/bin/ruby</tt> from the tools.
+
+
 -
   Version: 12.1.0
 
@@ -7,16 +35,19 @@
     This release adds interactive debugging support, adds new sections to the user manual, and cleanses some internals.
 
   Notice: |
-    * The <tt>lib/ruby-vpi/rspec.rb</tt> and <tt>lib/ruby-vpi/xx.rb</tt> files has been removed because they are no longer necessary.
+    * The <tt>lib/ruby-vpi/rspec.rb</tt> and <tt>lib/ruby-vpi/xx.rb</tt> files have been removed because they are no longer necessary.
 
-    * rSpec 0.7.0 or newer is now required because the sample tests utilize the @should ==@ syntax -- which was introduced in rSpec 0.7.0.
+    * rSpec 0.7.0 or newer is now required because the sample tests utilize the @should ==@ syntax.
+
+    h3. New features
 
-  Detail: |
     * Test runners now support the @DEBUG@ environment variable, which enables the interactive debugger (ruby-debug) in "post-mortem debugging mode":http://www.datanoise.com/articles/2006/12/20/post-mortem-debugging.
-    ** The @debugger@ can now be used when @DEBUG@ environment variable is not activated.
-    ** ruby-debug is now a gem dependency for Ruby-VPI.
+    ** The @debugger@ command can also be used when the @DEBUG@ environment variable is not activated.
+
+    * Status messages, which are shown during initialization of a Ruby bench, now appear in your simulator's log files.
 
-    * Status messages, which are shown during initialization of a Ruby bench, now appear in simulators' log files.
+  Details: |
+    * ruby-debug is now a gem dependency for Ruby-VPI.
 
     * Added documentation about "test runners":manual.html#usage.test-runner and the "interactive debugger":manual.html#usage.debugger in the user manual.
 
@@ -45,10 +76,10 @@
   Acknowledgment: |
     Thanks to Mauricio Fernandez for helping me solve the problem.
 
-  Detail: |
+  Details: |
     Previously, code coverage reports were not providing any useful information because they were being generated _before_ the test had a chance to run. This problem has been fixed -- code coverage reports are now generated _after_ the test has finished running.
 
-    This problem was wholly due to programmer error (i.e. my mistake @;-)@) because I had forgotten that @Kernel.at_exit@ invokes the blocks passed to it in _reverse_ order. So, the coverage report was being generated before Test::Unit had a chance to run (it also uses @Kernel.at_exit@).
+    This problem occurred because I had forgotten that @Kernel.at_exit@ invokes the blocks passed to it in _reverse_ order. So, the coverage report was being generated before Test::Unit had a chance to run (it also uses @Kernel.at_exit@).
 
 
 -
@@ -75,7 +106,7 @@
     ** now supplies a third argument to the @MERGER@ command.
     ** no longer replaces existing files with newly generated content during the *update* action. Instead, it now writes the newly generated output to a <tt>.new</tt> file and then invokes the @MERGER@ command.
 
-  Detail: |
+  Details: |
     * The @Vpi::Handle@ class has two new methods: @x!@ and @z!@, which set the handle's logic value to _unknown_ and _high impedance_ respectively.
 
     * The tests for the simple up-counter example were randomly failing because the specifications were not asserting the design's @reset@ signal long enough. So the design was getting into weird states and behaving in a non-deterministic way. This problem has been fixed.
@@ -114,7 +145,7 @@
   Notice: |
     * The user manual is now available _only_ in HTML format. If you still wish to have a plain-text version, you can use a text-based browser, such as "lynx":http://lynx.browser.org/, to perform the necessary conversion.
 
-  Detail: |
+  Details: |
     * The automated test generator no longer crashes when parsing a Verilog module declaration that contains multiple module parameters.
 
     * The user manual and the website are now written using a custom documentation system based on RedCloth and ERB instead of DocBook-XML. This makes it easier to edit the user manual and reuse its content in other areas of the website.
@@ -134,7 +165,7 @@
   Notice: |
     * A bug in generated Verilog and Ruby benches, which caused the <pre>ruby: no such file to load -- ruby-vpi (LoadError)</pre> error, has been fixed. Please regenerate your tests to apply this bug fix to your tests.
 
-  Detail: |
+  Details: |
     * The class @SWIG::TYPE_p_unsigned_int@ has been aliased as @Vpi::Handle@ for easier access.
 
     * @Vpi::Handle.to_s@ and @Vpi::Handle.inspect@ now produce more informative output. For example, what used to appear as <pre>#<SWIG::TYPE_p_unsigned_int:0x2aaab6574fa0></pre> now appears as <pre>#<Vpi::Handle vpiModule fullName=counter_rspec_bench, size=-1, file=counter_rspec_bench.v, lineNo=2></pre> in this release.
@@ -170,7 +201,7 @@
 
     * The source code is no longer distributed as a *zip* package, because it seems to be quite underutilized in comparison to the *tgz* and *gem* packages.
 
-  Detail: |
+  Details: |
     * Generated Ruby benches have been shortened to just _one_ line of code!
 
     * The less confusing notation of <code>def some_object.a_singleton_method
@@ -205,7 +236,7 @@
     * *generate_test.rb* no longer accepts the <pre>-s</pre> and <pre>-u</pre> options. Use their longer counterparts <pre>--rspec</pre> and <pre>--xunit</pre> instead.
 
 
-  Detail: |
+  Details: |
     h3. Automated test generator
 
     * Generated Verilog benches no longer divert compilation errors from Verilog design files. That is, if the Verilog simulator finds compilation errors in a Verilog design file, it will report that the Verilog design file is at fault (instead of reporting that the generated Verilog bench is at fault).
@@ -240,7 +271,7 @@
   Notice: |
     * The command-line options for *generate_test.rb* have changed. Run the command <pre>generate_test.rb --help</pre> for details.
 
-  Detail: |
+  Details: |
     * Test runners now attempt to resolve paths in @SIMULATOR_SOURCES@ by searching for them within the directories specified in @SIMULATOR_INCLUDES@.
 
     * Synopsys VCS is now used in a better way (via the <pre>-load</pre> option).
@@ -275,7 +306,7 @@
   Notice: |
     * Generated runners now have a @SIMULATOR_INCLUDES@ array, whose entries specify places where Verilog source files, needed by the Verilog design, reside.
 
-  Detail: |
+  Details: |
     * Generated Verilog benches now inherit all @`include@ and @`define@ directives from the Verilog design in a simpler manner.
     * A generated test no longer requires its Verilog design to reside in the same directory.
     * The sample tests have been updated accordingly.
@@ -292,7 +323,7 @@
   Notice: |
     * The *vpi_util* library has been renamed to *vpi*. This change should not affect your code unless you explicitly imported this library via @require 'ruby-vpi/vpi_util'@. In which case, you should update your code to use @require 'ruby-vpi/vpi'@ accordingly.
 
-  Detail: |
+  Details: |
     * An integer library has been added to simplify common tasks related to hardware and the binary number system. You can import this library for use via @require 'ruby-vpi/integer'@.
 
 
@@ -310,7 +341,7 @@
     * The @PROTO@ environment variable has been renamed to @PROTOTYPE@.
     ** In addition to using *unset*, you can now disable simulation of the prototype by assigning an empty value to this variable.
 
-  Detail: |
+  Details: |
     * We now use "Darcs":http://darcs.net for revision control, instead of Subversion. The source repository can now be accessed at "http://ruby-vpi.rubyforge.org/src/ruby-vpi":http://ruby-vpi.rubyforge.org/src/ruby-vpi.
 
     * The source code is now distributed in tar.gz and zip form, in addition to gem.
@@ -336,7 +367,7 @@
     ** @handle.x?@ checks if the logic value is "don't care"
     ** @handle.z?@ checks if the logic value is high impedance
 
-  Detail: |
+  Details: |
     * Module instantiation code in generated Verilog benches has been fixed. Whitespace between the module type and instance variable was missing.
 
     * The test generator tool now provides parsed Verilog constants and include-directives in generated Verilog benches; and parsed Verilog constants in generated Ruby designs.
@@ -356,7 +387,7 @@
   Acknowledgment: |
     Thanks to Mauricio Fernandez for helping me use rcov without its runner.
 
-  Detail: |
+  Details: |
     * Added initial support (full capabilites of the rcov library, such as its various analysis modes, are not yet utilized) for code coverage analysis, which can be enabled by setting the @COVERAGE@ environment variable to a non-empty value before running a test.
     ** For example, you can run a test with the GPL Cver simulator while enabling the generation of code coverage reports as follows: <pre>export COVERAGE=1; rake cver</pre>
 
@@ -371,7 +402,7 @@
   Summary: |
     This release simplifies running of multiple tests, restores compatibility with Synopsys VCS, and better integrates with RubyGems.
 
-  Detail: |
+  Details: |
     * Added <tt>lib/ruby-vpi/runner_proxy.rb</tt> library which, when embedded into a Rakefile, runs all generated tests in the working directory with any specified arguments. For example, have a look at the <tt>samp/counter/Rakefile</tt> file.
 
     * Fixed a bug that prevented one from running tests with Synopsys VCS.
@@ -402,7 +433,7 @@
 
     * The <tt>src/</tt> directory has been renamed to <tt>ext/</tt> to follow RubyGems convention.
 
-  Detail: |
+  Details: |
     * Ruby-VPI is now distributed only as a "source gem":http://www.rubygems.org. You can decompress the gem without installing it onto your system by running the command <pre>gem install -i output_directory ruby-vpi-7.0.0.gem</pre>. In addition, you can still obtain the source code directly from the Subversion repository.
 
     * The tools in <tt>bin/</tt> become available in your system's <tt>bin/</tt> directory when the gem is installed.
@@ -427,7 +458,7 @@
     * Ruby-VPI now only needs to be built once.
     ** You can run tests with different Verilog simulators without having to re-compile Ruby-VPI.
 
-  Detail: |
+  Details: |
     * The GPL Cver simulator is now supported.
 
     * Release packages are now available in both source and binary form.
@@ -463,7 +494,7 @@
 
     * @put_value()@ now verifies that the value it puts was written correctly. This helps to find bugs regarding invalid assumptions about the number of bits supported by a signal.
 
-  Detail: |
+  Details: |
     * The test generator now uses ERB templates which ensures nice indentation of generated output.
 
     * The test generator now decouples Ruby-VPI paths from Verilog benches via the RUBYLIB environment variable.
@@ -481,7 +512,7 @@
   Summary: |
     This release simplifies generated tests and fixes a bug.
 
-  Detail: |
+  Details: |
     * The test generator now produces simpler Ruby benches and specifications.
     ** A template used by generated specifications has been added.
     ** The counter example and tutorial have also been simplified accordingly.
@@ -505,7 +536,7 @@
 
     * All template files have been moved into the <tt>tpl</tt> directory.
 
-  Detail: |
+  Details: |
     * Support for prototyping designs in Ruby, before they are implemented in Verilog, has been added.
     ** The _same_ specification can be used to verify both prototype _and_ design! :-)
     ** The tutorial in the user manual has been updated to discuss prototyping.
@@ -525,7 +556,7 @@
   Acknowledgment: |
     * Thanks to Todd Nagengast and Matt Fischler for notifying me about unreadable text in the user manual.
 
-  Detail: |
+  Details: |
     * Source code comments in the user manual are now readable.
 
     * The <tt>README</tt> and <tt>HISTORY</tt> files have been converted to "textile":http://www.textism.com/tools/textile/ format.
@@ -542,7 +573,7 @@
   Acknowledgment: |
     * Thanks to Phil Tomson for correcting the URL of the RHDL website, in the user manual.
 
-  Detail: |
+  Details: |
     h3. User manual
 
     * A tutorial, based on the counter example, has been added to the user manual.
@@ -582,7 +613,7 @@
 
     * The @handle.value@ and @handle.value=@ methods have been removed.
 
-  Detail: |
+  Details: |
     * The VPI utility layer provides access to VPI properties of handles in a "simpler, more powerful way":manual.html#background.org.vpi.
 
     ** All VPI properties, except delay values, are now accessible from a handle.
@@ -610,7 +641,7 @@
 
     * The test generation tool now generates multiple files (runner, bench, design, spec) and makes backups of existing files. See its help information for details.
 
-  Detail: |
+  Details: |
     * A comprehensive user manual, written in DocBook-XML, has been added.
 
     * Support for RSpec 0.5.4 has been added.
@@ -632,7 +663,7 @@
   Acknowledgment: |
     * Thanks to Scott L Holmes for helping me "use the RSpec library without its runner":http://article.gmane.org/gmane.comp.lang.ruby.general/150087 program.
 
-  Detail: |
+  Details: |
     * A tool, which generates most of a Ruby-VPI test bench from a Verilog 2001 module declaration, has been added.
 
     * Ability to use RSpec in a test bench has been added.
@@ -655,7 +686,7 @@
   Notice: |
     * The *msim* Makefile target for Mentor Modelsim has been renamed back to *vsim*.
 
-  Detail: |
+  Details: |
     * Simple, consistent ways of reading and writing values to handles have been added to the VPI utility layer. These ways are described in the @SWIG::TYPE_p_unsigned_int@ class' documentation.
 
     * The makefiles now use the *rbconfig* library to determine the default compiler and linker flags for Ruby.
@@ -685,7 +716,7 @@
   Notice: |
     * The *vsim* Makefile target for Mentor Modelsim has been renamed to *msim*.
 
-  Detail: |
+  Details: |
     * The Ruby interface to VPI is now generated by "SWIG":http://www.swig.org.
     ** The main @VPI@ module has been renamed to @Vpi@.
     ** The @VPI::Handle@ class has been removed.
@@ -718,7 +749,7 @@
   Notice: |
     * Removed @$ruby_task@ callback and ability to dynamically register system tasks from Ruby because inter-process communication is complicated at present.
 
-  Detail: |
+  Details: |
     * The "cross-thread violation on rb_gc()" error has been fixed.
     ** The "stack level too deep (SystemStackError)" error has been fixed.
     ** The test/unit library can be used in Ruby test bench.
@@ -748,7 +779,7 @@
 
     * Thanks to Ross Bamford, Eric Hodel, and Yukihiro Matsumoto for "helping me discover":http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/180662 why the @SystemStackError@ was happening.
 
-  Detail: |
+  Details: |
     * Implemented some Verilog VPI functionality:
     ** @VPI::handle_by_name(string, VPI::Handle)@ &rarr; @VPI::Handle@
     ** @VPI::handle_by_name(string)@ &rarr; @VPI::Handle@
@@ -782,7 +813,7 @@
   Summary: |
     This is Kazuhiro HIWADA's initial testing release of Ruby-VPI. See its "original announcement":http://www.ruby-talk.org/cgi-bin/scat.rb/ruby/ruby-list/18193 and "source code":http://easter.kuee.kyoto-u.ac.jp/~hiwada/ruby/memo/src/ruby-vpi-test.tgz.
 
-  Detail: |
+  Details: |
     * Added ability to relay control from Verilog test bench to Ruby (using @$ruby_callback@) and vice versa (using @PLI::relay_Verilog@).
 
     * Tested and developed using Ruby 1.4 and Verilog-XL from Cadence systems, on a SPARC machine running Solaris 2.6.

data/doc/manual.html

@@ -219,7 +219,7 @@
 	<p>Suraj N. Kurapati</p>
 
 
-	<p>Fri Dec 22 21:43:06 <span class="caps">PST 2006</span></p>
+	<p>Wed Dec 27 22:29:49 <span class="caps">PST 2006</span></p>
 
 
 </div>
@@ -1539,9 +1539,9 @@ context <span style="background-color:#fff0f0"><span style="color:#710">&quot;</
 
 <span style="color:#888"># This method resets the design under test.</span>
 <span style="color:#080; font-weight:bold">def</span> <span style="color:#036; font-weight:bold">Counter</span>.reset!
-  <span style="color:#888"># assert the reset signal for five clock cycles</span>
+  <span style="color:#888"># assert the reset signal for two clock cycles</span>
   reset.intVal = <span style="color:#00D; font-weight:bold">1</span>
-  <span style="color:#00D; font-weight:bold">5</span>.times {relay_verilog}
+  <span style="color:#00D; font-weight:bold">2</span>.times {relay_verilog}
   reset.intVal = <span style="color:#00D; font-weight:bold">0</span>
 <span style="color:#080; font-weight:bold">end</span>
 </pre></li>

data/doc/memo.doc

@@ -1,5 +1,7 @@
 h1. Pending tasks
 
+* add support for VPI callbacks which execute Ruby blocks
+
 * add support for reading & writing VPI delay values
 
 * GHDL simulator supports VPI

data/doc/memo.html

@@ -26,6 +26,11 @@
       <h1 id="anchor1">Pending tasks</h1>
 
 
+	<ul>
+	<li>add support for <span class="caps">VPI</span> callbacks which execute Ruby blocks</li>
+	</ul>
+
+
 	<ul>
 	<li>add support for reading &#38; writing <span class="caps">VPI</span> delay values</li>
 	</ul>

data/doc/readme.doc

@@ -10,24 +10,32 @@
 * "Reference":../ref/
   - API documentation for Ruby libraries and C extension.
 
-* "History":history.html
-  - record of all release notes.
-
-* "Memo":memo.html
-  - pending tasks for future releases.
 
 * "Facilities":http://rubyforge.org/projects/ruby-vpi
-  - issue tracker, file downloads, support requests, discussion forums, and more.
+** "Downloads":http://rubyforge.org/frs/?group_id=1339
+** "Bugs":http://rubyforge.org/tracker/?group_id=1339
+** "Patches":http://rubyforge.org/tracker/?group_id=1339
+** "Requests":http://rubyforge.org/tracker/?group_id=1339
+** "Forums":http://rubyforge.org/forum/?group_id=1339
 
 * "Sources":http://ruby-vpi.rubyforge.org/src/ruby-vpi
   - browse or access the "Darcs":http://abridgegame.org/darcs/ source code repository.
 
-* "Talks":http://ruby-vpi.rubyforge.org/talks
-  - slides from public presentations about Ruby-VPI.
 
 * "News":http://ruby-vpi.rubyforge.org/news
   - see what's cooking for the next release.
 
+* "Talks":http://ruby-vpi.rubyforge.org/talks
+  - slides from public presentations about Ruby-VPI.
+
+
+* "Memo":memo.html
+  - pending tasks for future releases.
+
+* "History":history.html
+  - record of all release notes.
+
+
 </div>
 
 

data/doc/readme.html

@@ -28,44 +28,50 @@
 
 
 	<ul>
-	<li><a href="history.html">History</a>
-  &#8211; record of all release notes.</li>
+	<li><a href="http://rubyforge.org/projects/ruby-vpi">Facilities</a>
+	<ul>
+	<li><a href="http://rubyforge.org/frs/?group_id=1339">Downloads</a></li>
+		<li><a href="http://rubyforge.org/tracker/?group_id=1339">Bugs</a></li>
+		<li><a href="http://rubyforge.org/tracker/?group_id=1339">Patches</a></li>
+		<li><a href="http://rubyforge.org/tracker/?group_id=1339">Requests</a></li>
+		<li><a href="http://rubyforge.org/forum/?group_id=1339">Forums</a></li>
+	</ul></li>
 	</ul>
 
 
 	<ul>
-	<li><a href="memo.html">Memo</a>
-  &#8211; pending tasks for future releases.</li>
+	<li><a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi">Sources</a>
+  &#8211; browse or access the <a href="http://abridgegame.org/darcs/">Darcs</a> source code repository.</li>
 	</ul>
 
 
 	<ul>
-	<li><a href="http://rubyforge.org/projects/ruby-vpi">Facilities</a>
-  &#8211; issue tracker, file downloads, support requests, discussion forums, and more.</li>
+	<li><a href="http://ruby-vpi.rubyforge.org/news">News</a>
+  &#8211; see what&#8217;s cooking for the next release.</li>
 	</ul>
 
 
 	<ul>
-	<li><a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi">Sources</a>
-  &#8211; browse or access the <a href="http://abridgegame.org/darcs/">Darcs</a> source code repository.</li>
+	<li><a href="http://ruby-vpi.rubyforge.org/talks">Talks</a>
+  &#8211; slides from public presentations about Ruby-VPI.</li>
 	</ul>
 
 
 	<ul>
-	<li><a href="http://ruby-vpi.rubyforge.org/talks">Talks</a>
-  &#8211; slides from public presentations about Ruby-VPI.</li>
+	<li><a href="memo.html">Memo</a>
+  &#8211; pending tasks for future releases.</li>
 	</ul>
 
 
 	<ul>
-	<li><a href="http://ruby-vpi.rubyforge.org/news">News</a>
-  &#8211; see what&#8217;s cooking for the next release.</li>
+	<li><a href="history.html">History</a>
+  &#8211; record of all release notes.</li>
 	</ul>
 
 
 </div>
 
-	<h1 id="anchor108">Welcome to Ruby-VPI
+	<h1 id="anchor113">Welcome to Ruby-VPI
 <a type="application/rss+xml" href="http://ruby-vpi.rubyforge.org/doc/rss.xml"><img src="images/feed-icon.png" title="RSS feed for this project." alt="RSS feed for this project." /></a></h1>
 
 

data/doc/rss.xml

@@ -4,6 +4,13 @@
   <title>Ruby-VPI</title>
   <link>http://ruby-vpi.rubyforge.org</link>
   <description>Ruby-VPI is a Ruby interface to IEEE 1364-2005 Verilog VPI. It lets you create complex Verilog test benches easily and wholly in Ruby.</description>
+  <item>
+    <title>Version 13.0.0 released</title>
+    <link>http://ruby-vpi.rubyforge.org/doc/history.html#13.0.0</link>
+    <guid>http://ruby-vpi.rubyforge.org/doc/history.html#13.0.0</guid>
+    <description>&lt;p&gt;This release fixes a &lt;em&gt;major&lt;/em&gt; instability bug, simplifies generated Verilog benches, and purifies the &lt;span class=&quot;caps&quot;&gt;API&lt;/span&gt; reference documentation.&lt;/p&gt;</description>
+    <pubDate>Wed, 27 Dec 2006 00:00:00 PST</pubDate>
+  </item>
   <item>
     <title>Version 12.1.0 released</title>
     <link>http://ruby-vpi.rubyforge.org/doc/history.html#12.1.0</link>

data/ext/common.h

@@ -24,6 +24,7 @@
 #ifndef COMMON_H
 #define	COMMON_H
 
+  #include <stddef.h>
   #include "verilog.h"
 
 

data/ext/{swig.c → main.c}

@@ -19,18 +19,44 @@
   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
 
-#include "swig.h"
-
+#include "main.h"
 #include "relay.h"
+#include <stdlib.h>
+#include <stdio.h>
+
+
+// load the SWIG-generated Ruby interface to VPI
 #include "swig_wrap.cin"
 
 
-void swig_init() {
-  Init_vpi();
-  rb_define_module_function(mVpi, "relay_verilog", swig_rb_relay_verilog, 0);
+void main_init() {
+  ruby_init();
+  ruby_init_loadpath();
+
+  // load the VPI interface for Ruby
+    Init_vpi();
+    rb_define_module_function(mVpi, "relay_verilog", main_relay_verilog, 0);
+
+  // initialize the Ruby bench
+    char* benchFile = getenv("RUBY_VPI__RUBY_BENCH_FILE");
+
+    if (benchFile != NULL) {
+      rb_load_file(benchFile);
+    }
+    else {
+      common_printf("error: environment variable RUBY_VPI__RUBY_BENCH_FILE is not set.");
+      exit(EXIT_FAILURE);
+    }
+
+    ruby_script(benchFile);
+
+  // run the test bench
+    ruby_run();
+
+  ruby_finalize();
 }
 
-VALUE swig_rb_relay_verilog(VALUE arSelf) {
+VALUE main_relay_verilog(VALUE arSelf) {
   relay_verilog();
   return arSelf;
 }

data/ext/{swig.h → main.h}

@@ -18,22 +18,23 @@
   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
 /**\file
-  C interface to the SWIG-generated VPI interface.
+  The C extension for Ruby-VPI.
 */
 
-#ifndef SWIG_H
-#define SWIG_H
+#ifndef MAIN_H
+#define MAIN_H
 
+  #include "common.h"
   #include <ruby.h>
 
   /**
-    Registers the SWIG-generated VPI interface with Ruby, so that Ruby code can access it.
+    Runs the test bench.
   */
-  void swig_init();
+  void main_init();
 
   /**
-    Transfers control from Ruby code to Verilog code.
+    Transfers control from Ruby to Verilog.
   */
-  VALUE swig_rb_relay_verilog(VALUE arSelf);
+  VALUE main_relay_verilog(VALUE arSelf);
 
 #endif