ruby-vpi 8.2.0 → 9.0.0

data/ext/extconf.rb

@@ -1,4 +1,7 @@
 require 'mkmf'
+require 'rbconfig'
 
-have_library 'pthread', 'pthread_create'
-create_makefile 'ruby-vpi'
+have_library('pthread', 'pthread_create') &&
+have_library(Config::CONFIG['RUBY_SO_NAME'] || 'ruby', 'ruby_init') &&
+
+create_makefile('ruby-vpi')

data/ext/relay.c

@@ -0,0 +1,138 @@
+/*
+  Copyright 1999 Kazuhiro HIWADA
+  Copyright 2006 Suraj N. Kurapati
+
+  This file is part of Ruby-VPI.
+
+  Ruby-VPI 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.
+
+  Ruby-VPI 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 Ruby-VPI; if not, write to the Free Software Foundation,
+  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+
+#include "relay.h"
+
+#include "swig.h"
+#include "common.h"
+#include <pthread.h>
+#include <ruby.h>
+#include <assert.h>
+
+
+pthread_t relay__rubyThread;
+pthread_mutex_t relay__rubyLock;
+pthread_mutex_t relay__verilogLock;
+
+void relay_init() {
+  pthread_mutex_init(&relay__rubyLock, NULL);
+  pthread_mutex_lock(&relay__rubyLock);
+  pthread_mutex_init(&relay__verilogLock, NULL);
+  pthread_mutex_lock(&relay__verilogLock);
+}
+
+void relay_ruby() {
+  pthread_mutex_unlock(&relay__rubyLock);
+  pthread_mutex_lock(&relay__verilogLock);
+}
+
+void relay_verilog() {
+  pthread_mutex_unlock(&relay__verilogLock);
+  pthread_mutex_lock(&relay__rubyLock);
+}
+
+typedef struct {
+  PLI_BYTE8** mArgs;	/// Array of command-line arguments.
+  unsigned int mCount;	/// Number of command-line arguments.
+} relay__RubyOptions__def;
+
+/**
+  @param	apRubyOptions	relay__RubyOptions__def structure which contains command-line options passsed to the Ruby interpreter.
+  @note	The structure will be freed *deeply* after use.
+*/
+void* ruby_run_handshake(void* apRubyOptions) {
+  // initialize Ruby interpreter
+  ruby_init();
+  ruby_init_loadpath();
+
+  swig_init();
+
+    // pass command-line arguments to the interpreter
+    relay__RubyOptions__def* pRubyOptions = (relay__RubyOptions__def*) apRubyOptions;
+
+    PLI_BYTE8** argv = pRubyOptions->mArgs;
+    unsigned int argc = pRubyOptions->mCount;
+
+    ruby_options(argc, argv);
+
+    // free the memory used by command-line options
+    unsigned int i;
+    for (i = 0; i < argc; i++) {
+      free(argv[i]);
+    }
+
+    free(argv);
+    free(pRubyOptions);
+
+
+  // start Ruby interpreter
+  ruby_run();
+
+
+  // Ruby interpreter is now finished, so clean it up before terminating this thread
+  ruby_finalize();
+  return NULL;
+}
+
+void relay_ruby_run() {
+  relay__RubyOptions__def* pRubyOptions = malloc(sizeof(relay__RubyOptions__def));
+
+  if (pRubyOptions) {
+    pRubyOptions->mArgs = NULL;
+    pRubyOptions->mCount = 0;
+
+    // transform the arguments passed to this function by Verilog into command-line arguments for Ruby interpeter
+    vpiHandle vCall = vpi_handle(vpiSysTfCall, NULL);
+
+    if (vCall) {
+      vpiHandle vCallArgs = vpi_iterate(vpiArgument, vCall);
+
+      if (vCallArgs) {
+        vpiHandle vArg;
+        s_vpi_value argVal;
+        argVal.format = vpiStringVal;
+
+        while ((vArg = vpi_scan(vCallArgs)) != NULL) {
+          vpi_get_value(vArg, &argVal);
+
+          pRubyOptions->mCount++;
+
+
+          if (pRubyOptions->mArgs == NULL)
+            pRubyOptions->mArgs = malloc(sizeof(PLI_BYTE8*) * pRubyOptions->mCount);
+          else
+            pRubyOptions->mArgs = realloc(pRubyOptions->mArgs, sizeof(PLI_BYTE8*) * pRubyOptions->mCount);
+
+          assert(pRubyOptions->mArgs != NULL);
+
+
+          pRubyOptions->mArgs[pRubyOptions->mCount-1] = strdup(argVal.value.str);
+        }
+      }
+    }
+
+    pthread_create(&relay__rubyThread, 0, ruby_run_handshake, pRubyOptions);
+    return;
+  }
+
+  common_printf("error: unable to allocate memory for Ruby's command-line arguments.");
+  exit(EXIT_FAILURE);
+}

data/ext/{relay.hin → relay.h}

@@ -1,6 +1,6 @@
 /*
-  Copyright 2006 Suraj N. Kurapati
   Copyright 1999 Kazuhiro HIWADA
+  Copyright 2006 Suraj N. Kurapati
 
   This file is part of Ruby-VPI.
 
@@ -22,27 +22,27 @@
   Logic for transferring control between Ruby and Verilog.
 */
 
-#ifndef RELAY_HIN
-#define RELAY_HIN
+#ifndef RELAY_H
+#define RELAY_H
 
   /**
     Initialize the relay mechanism, which enables Verilog code to transfer control to Ruby code and vice versa.
   */
-  static void relay_init();
+  void relay_init();
 
   /**
     Transfers control to Ruby code.
   */
-  static void relay_ruby();
+  void relay_ruby();
 
   /**
     Transfers control to Verilog code.
   */
-  static void relay_verilog();
+  void relay_verilog();
 
   /**
     Starts the Ruby interpreter.
   */
-  static inline void relay_ruby_run();
+  inline void relay_ruby_run();
 
 #endif

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

@@ -1,6 +1,6 @@
 /*
-  Copyright 2006 Suraj N. Kurapati
   Copyright 1999 Kazuhiro HIWADA
+  Copyright 2006 Suraj N. Kurapati
 
   This file is part of Ruby-VPI.
 
@@ -19,20 +19,18 @@
   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
 
-#include "swig.hin"
-#include "relay.hin"
-#include "common.h"
-
+#include "swig.h"
 
+#include "relay.h"
 #include "swig_wrap.cin"
 
 
-static void swig_init() {
+void swig_init() {
   Init_vpi();
   rb_define_module_function(mVpi, "relay_verilog", swig_rb_relay_verilog, 0);
 }
 
-static VALUE swig_rb_relay_verilog(VALUE arSelf) {
+VALUE swig_rb_relay_verilog(VALUE arSelf) {
   relay_verilog();
   return arSelf;
 }

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

@@ -21,19 +21,19 @@
   C interface to the SWIG-generated VPI interface.
 */
 
-#ifndef SWIG_HIN
-#define SWIG_HIN
+#ifndef SWIG_H
+#define SWIG_H
 
   #include <ruby.h>
 
   /**
     Registers the SWIG-generated VPI interface with Ruby, so that Ruby code can access it.
   */
-  static void swig_init();
+  void swig_init();
 
   /**
     Transfers control from Ruby code to Verilog code.
   */
-  static VALUE swig_rb_relay_verilog(VALUE arSelf);
+  VALUE swig_rb_relay_verilog(VALUE arSelf);
 
 #endif

data/ext/verilog.h

@@ -27,7 +27,6 @@
   // Use our verbatim copy of the official IEEE Std. 1364-2005 header file, which was obtained from this URL: <http://www.boydtechinc.com/ptf/archive/ptf_2005/0737.html>
   #include "vpi_user.h"
 
-
   // Adjust for the peculiarities of the Verilog simulator being used.
   #ifdef SYNOPSYS_VCS
     #define VERILOG_LENIENT
@@ -50,7 +49,7 @@
     #define verilog_tf_funcPtr verilog_tf_funcPtr_strict
 
     #define verilog_tf_funcSig(aFuncName)	\
-      static PLI_INT32 aFuncName(PLI_BYTE8* aDummy)
+      PLI_INT32 aFuncName(PLI_BYTE8* aDummy)
 
     #define verilog_tf_funcReturn(aReturnVal)	\
       return aReturnVal

data/ext/vlog.c

@@ -0,0 +1,86 @@
+/*
+  Copyright 1999 Kazuhiro HIWADA
+  Copyright 2006 Suraj N. Kurapati
+
+  This file is part of Ruby-VPI.
+
+  Ruby-VPI 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.
+
+  Ruby-VPI 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 Ruby-VPI; if not, write to the Free Software Foundation,
+  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+
+#include "vlog.h"
+
+#include "relay.h"
+#include <stdlib.h>
+
+
+verilog_tf_funcSig(vlog_ruby_relay) {
+  // transfer control to ruby
+  relay_ruby();
+
+
+  // transfer control to verilog
+  verilog_tf_funcReturn(0);
+}
+
+verilog_tf_funcSig(vlog_ruby_init) {
+  // setup control transfer mechanism
+  relay_init();
+
+
+  // start ruby interpreter and transfer control to it
+  relay_ruby_run();
+
+
+  // transfer control to verilog
+  verilog_tf_funcReturn(0);
+}
+
+void vlog_bind_task(PLI_BYTE8* apTaskName, verilog_tf_funcPtr(apTaskDef)) {
+  s_vpi_systf_data tf;
+
+  tf.type = vpiSysTask;
+  tf.sysfunctype = 0;
+  tf.tfname = apTaskName;
+  tf.calltf = (verilog_tf_funcPtr_strict())apTaskDef;
+  tf.compiletf = NULL;
+  tf.sizetf = NULL;
+  tf.user_data = NULL;
+
+  vpi_register_systf(&tf);
+}
+
+/**
+  Binds the default VPI tasks (provided by Ruby-VPI) before the Verilog simulator begins to simulate.
+*/
+void vlog_startup() {
+  vlog_bind_task("$ruby_init", vlog_ruby_init);
+  vlog_bind_task("$ruby_relay", vlog_ruby_relay);
+}
+
+void (*vlog_startup_routines[])() = { vlog_startup, 0 };
+
+#if defined(PRAGMATIC_CVER) || defined(SYNOPSYS_VCS)
+  /**
+    Invokes each routine specified in the vlog_startup_routines array.
+
+    This code is originally from GPL Cver 2.11a:
+    Copyright (c) 1991-2005 Pragmatic C Software Corp.
+  */
+  void vlog_startup_routines_bootstrap() {
+    unsigned int i;
+    for (i = 0; vlog_startup_routines[i] != NULL; i++)
+      vlog_startup_routines[i]();
+  }
+#endif

data/ext/{vlog.hin → vlog.h}

@@ -1,6 +1,5 @@
 /*
   Copyright 2006 Suraj N. Kurapati
-  Copyright 1999 Kazuhiro HIWADA
 
   This file is part of Ruby-VPI.
 
@@ -22,8 +21,8 @@
   Interface between C and Verilog code.
 */
 
-#ifndef VLOG_HIN
-#define VLOG_HIN
+#ifndef VLOG_H
+#define VLOG_H
 
   #include "verilog.h"
 
@@ -41,17 +40,15 @@
   */
   verilog_tf_funcSig(vlog_ruby_init);
 
-  #ifndef SYNOPSYS_VCS
-    /**
-      Binds a C function to a VPI task, so that Verilog code can invoke the C function by calling the VPI task.
+  /**
+    Binds a C function to a VPI task, so that Verilog code can invoke the C function by calling the VPI task.
 
-      For example, if we bound a VPI task named "$hello_world" to the C function hello_world(), then the hello_world() function would be invoked whenever Verilog code called the "$hello_world" VPI task.
+    For example, if we bound a VPI task named "$hello_world" to the C function hello_world(), then the hello_world() function would be invoked whenever Verilog code called the "$hello_world" VPI task.
 
-      @param	apTaskName	Name of the VPI task. For example, "$hello_world".
+    @param	apTaskName	Name of the VPI task. For example, "$hello_world".
 
-      @param	apTaskDef	The C function which you want to associate with the given VPI task. For example, hello_world().
-    */
-    static void vlog_bind_task(PLI_BYTE8* apTaskName, verilog_tf_funcPtr(apTaskDef));
-  #endif
+    @param	apTaskDef	The C function which you want to associate with the given VPI task. For example, hello_world().
+  */
+  void vlog_bind_task(PLI_BYTE8* apTaskName, verilog_tf_funcPtr(apTaskDef));
 
 #endif

data/header.html

@@ -2,37 +2,6 @@
   <link rel="stylesheet" type="text/css" href="style.css" />
 </head>
 
-	<h1 style="text-align: center;">Welcome to Ruby-VPI</h1>
-
-
-	<p>Ruby-VPI is a <a href="http://ruby-lang.org">Ruby interface</a> to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
-
-
-	<h2>Features</h2>
-
-
-	<ul>
-	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
-	</ul>
-
-
-	<ul>
-	<li>Utilize Ruby&#8217;s power and elegance. (<a href="http://www.ruby-doc.org/whyruby">Why choose Ruby?</a>)
-	<ul>
-	<li>Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, <em>ad infinium</em>!</li>
-		<li>Easy to use; doesn&#8217;t get in your way.</li>
-		<li>Makes programming <em>fun</em> again!</li>
-	</ul></li>
-	</ul>
-
-
-	<ul>
-	<li>Study, modify, or distribute this is free software, released under the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>, as you see fit.</li>
-	</ul>
-
-
 <div class="variablelist">
 <dl>
 

data/header.part.html

@@ -2,37 +2,6 @@
   <link rel="stylesheet" type="text/css" href="style.css" />
 </head>
 
-	<h1 style="text-align: center;">Welcome to Ruby-VPI</h1>
-
-
-	<p>Ruby-VPI is a <a href="http://ruby-lang.org">Ruby interface</a> to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
-
-
-	<h2>Features</h2>
-
-
-	<ul>
-	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
-	</ul>
-
-
-	<ul>
-	<li>Utilize Ruby&#8217;s power and elegance. (<a href="http://www.ruby-doc.org/whyruby">Why choose Ruby?</a>)
-	<ul>
-	<li>Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, <em>ad infinium</em>!</li>
-		<li>Easy to use; doesn&#8217;t get in your way.</li>
-		<li>Makes programming <em>fun</em> again!</li>
-	</ul></li>
-	</ul>
-
-
-	<ul>
-	<li>Study, modify, or distribute this is free software, released under the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>, as you see fit.</li>
-	</ul>
-
-
 <div class="variablelist">
 <dl>