ruby-vpi 7.0.0

data/ext/Doxyfile

@@ -0,0 +1,272 @@
+# Doxyfile 1.4.4
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME           = Ruby-VPI
+PROJECT_NUMBER         = 
+OUTPUT_DIRECTORY       = 
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+USE_WINDOWS_ENCODING   = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       = "The $name class" \
+                         "The $name widget" \
+                         "The $name file" \
+                         is \
+                         provides \
+                         specifies \
+                         contains \
+                         represents \
+                         a \
+                         an \
+                         the
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        = 
+STRIP_FROM_INC_PATH    = 
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP         = NO
+INHERIT_DOCS           = YES
+DISTRIBUTE_GROUP_DOC   = NO
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 8
+ALIASES                = 
+OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_JAVA   = NO
+SUBGROUPING            = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+SORT_BRIEF_DOCS        = NO
+SORT_BY_SCOPE_NAME     = NO
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = YES
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       = 
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+SHOW_DIRECTORIES       = YES
+FILE_VERSION_FILTER    = 
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           = 
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = 
+FILE_PATTERNS          = *.c \
+                         *.cin \
+                         *.cc \
+                         *.cxx \
+                         *.cpp \
+                         *.c++ \
+                         *.d \
+                         *.java \
+                         *.ii \
+                         *.ixx \
+                         *.ipp \
+                         *.i++ \
+                         *.inl \
+                         *.h \
+                         *.hin \
+                         *.hh \
+                         *.hxx \
+                         *.hpp \
+                         *.h++ \
+                         *.idl \
+                         *.odl \
+                         *.cs \
+                         *.php \
+                         *.php3 \
+                         *.inc \
+                         *.m \
+                         *.mm \
+                         *.dox \
+                         *.C \
+                         *.CC \
+                         *.C++ \
+                         *.II \
+                         *.I++ \
+                         *.H \
+                         *.HH \
+                         *.H++ \
+                         *.CS \
+                         *.PHP \
+                         *.PHP3 \
+                         *.M \
+                         *.MM
+RECURSIVE              = YES
+EXCLUDE                = 
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       = 
+EXAMPLE_PATH           = 
+EXAMPLE_PATTERNS       = *
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             = 
+INPUT_FILTER           = 
+FILTER_PATTERNS        = 
+FILTER_SOURCE_FILES    = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = NO
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = NO
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          = 
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            = 
+HTML_FOOTER            = 
+HTML_STYLESHEET        = 
+HTML_ALIGN_MEMBERS     = YES
+GENERATE_HTMLHELP      = NO
+CHM_FILE               = 
+HHC_LOCATION           = 
+GENERATE_CHI           = NO
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+DISABLE_INDEX          = NO
+ENUM_VALUES_PER_LINE   = 4
+GENERATE_TREEVIEW      = NO
+TREEVIEW_WIDTH         = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4wide
+EXTRA_PACKAGES         = 
+LATEX_HEADER           = 
+PDF_HYPERLINKS         = NO
+USE_PDFLATEX           = NO
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    = 
+RTF_EXTENSIONS_FILE    = 
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_SCHEMA             = 
+XML_DTD                = 
+XML_PROGRAMLISTING     = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX = 
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor   
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = NO
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           = 
+INCLUDE_FILE_PATTERNS  = 
+PREDEFINED             = 
+EXPAND_AS_DEFINED      = 
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references   
+#---------------------------------------------------------------------------
+TAGFILES               = 
+GENERATE_TAGFILE       = 
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool   
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = YES
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = NO
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = NO
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+DOT_IMAGE_FORMAT       = png
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MAX_DOT_GRAPH_WIDTH    = 1024
+MAX_DOT_GRAPH_HEIGHT   = 1024
+MAX_DOT_GRAPH_DEPTH    = 1000
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = NO
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine   
+#---------------------------------------------------------------------------
+SEARCHENGINE           = NO

data/ext/README

@@ -0,0 +1,124 @@
+Class|Module Naming Convention
+------------------------------
+
+FooBar
+  C module named "FooBar".
+
+RFooBar
+  Ruby class or module named "FooBar".
+
+RFooBar_rb_do_stuff
+  Ruby function named "do_stuff" which is callable from Ruby like this: "FooBar.new.do_stuff" or "FooBar::do_stuff" or ...
+
+RFooBar_doStuff
+  Service function named "doStuff" which is callable from C only.
+
+RFooBar__someStuff
+  Something named "someStuff", which is neither a Ruby function nor a service function, that belongs to "FooBar". Think of the two underscores "__" as being two colons "::" in Ruby.
+
+
+Variable Naming Convention
+--------------------------
+
+fooBar
+  Ordinary variable named "fooBar".
+
+a?p?(r|v)?FooBar
+  Variable named "FooBar" which has additional properties denoted by the optional prefixes.
+
+aFooBar
+  Function argument named named "FooBar". For example: "int divide(int aDividend, aDivisor);".
+
+pFooBar
+  Pointer named "FooBar".
+
+rFooBar
+  Ruby object (instance of a Ruby class) named "FooBar".
+
+vFooBar
+  Verilog object named "FooBar".
+
+
+Code Formatting Convention
+--------------------------
+
+Indenting
+  Use a single tab character to indent by one level. If you feel that tab characters occupy too much space or indent too deeply, then configure your text editor to *visually* display tab characters using less space. This is similar to the output produced by the filter "expand -t 2" in UNIX.
+
+  level 1
+    level 2
+      level 3
+        ... and so on ...
+    level 2
+  level 1
+
+Line breaking
+  Do not break a long line into multiple lines. Let it be as long as it wants and configure your text editor to *visually* wrap long lines and indent them so they are easy to read. This is similar to the output produced by the filter "fmt -cs" in UNIX.
+
+  For example:
+
+  /**
+    Foo is a fantastic bar which can be seen from atop the majestic peaks of baz. However, let us not forget the beauty of sparkling rubies beneath its rugged, earthy exterior. Yes, this line is very long, and that is the point.
+  */
+
+Vertical spacing
+  Use 1 line comment before the start of a group of related statements if necessary.
+
+  Use 1 line within a group of related statements.
+
+  Use 2 lines to mark the boundary between groups of related statements.
+
+  Use 3 lines to mark the boundary of a completely disjoint block of code, which has its own groups of related statements.
+
+Braces alignment
+  Put an open brace on same line as the start of the block statement. For example:
+
+  if(foo) {
+    doFoo();
+
+    if(bar) {
+      doBar();
+    }
+  }
+  else {
+    doRuby();
+  }
+
+Delimiting operators
+  When there are many operators in a single statement, indent the first element beneath the block-starter and put the operator at the start of subsequent elements. For example:
+
+  static unsigned long int
+    foo
+    , bar
+    , baz
+  ;
+
+  doStuff(
+    foo
+    , bar
+    , baz
+  );
+
+  if(
+    foo
+    && bar
+    || baz
+  ) {
+    doStuff();
+  }
+
+
+Code Documenting Convention
+---------------------------
+
+Doxygen
+  Use Javadoc style (at "@" to start a documenting command) instead of LaTeX style (backslash "\" to start a documenting command) whenever possible. All public functions, variables, etc. must have such comments. For example:
+
+  /**
+    Writes out a foo and returns a bar.
+
+    @param	aFoo	The foo to write out.
+    @return	A bar.
+  */
+  bar doStuff(foo aFoo);
+

data/ext/Rakefile

@@ -0,0 +1,65 @@
+# Build file for the native C extension.
+#
+# = Environment variables
+# CFLAGS:: Arguments to the compiler.
+# LDFLAGS:: Arguments to the linker.
+
+=begin
+  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.
+=end
+
+require 'rake/clean'
+require 'rbconfig'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'ruby-vpi/rake'
+
+
+CFLAGS = [Config::CONFIG['CFLAGS'], ENV['CFLAGS'], '-g', '-DDEBUG']
+LDFLAGS = [Config::CONFIG['LDFLAGS'], ENV['LDFLAGS']]
+
+
+desc "Builds the extension."
+task :default => 'Makefile' do |t|
+  sh 'make', '-f', t.prerequisites[0]
+end
+
+file 'Makefile' => [:swig, 'extconf.rb'] do |t|
+  ruby t.prerequisites[1], "--with-cflags=#{CFLAGS.join(' ')}", "--with-ldflags=#{LDFLAGS.join(' ')}"
+end
+
+CLEAN.include 'Makefile', 'mkmf.log', '*.o', '*.so'
+
+
+desc 'Generate Ruby wrapper for VPI.'
+task :swig => 'swig_wrap.cin'
+
+file 'swig_wrap.cin' => 'swig_vpi.i' do |t|
+  sh %w{swig -ruby -o}, t.name, t.prerequisites[0]
+end
+
+file 'swig_vpi.i' => 'swig_vpi.h'
+
+file 'swig_vpi.h' => 'vpi_user.h' do |t|
+  # avoid problems with SWIG-generated wrapper for VPI vprintf functions which use va_list
+  ruby %{-pe 'gsub /\\bva_list\\b/, "int"' #{t.prerequisites[0]} > #{t.name}}
+end
+
+# NOTE: since SWIG is not a requirement for users, we should not clobber these generated files
+#CLOBBER.include 'swig_wrap.cin', 'swig_vpi.h'

data/ext/common.h

@@ -0,0 +1,56 @@
+/*
+  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.
+*/
+/**\file
+  Things common to all Ruby-VPI code.
+*/
+
+#ifndef COMMON_H
+#define	COMMON_H
+
+  #include "verilog.h"
+
+
+  /**
+    A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line.
+
+    @param	...	Arguments to vpi_printf()
+  */
+  #define common_printf(...)	vpi_printf("Ruby-VPI: "); vpi_printf(__VA_ARGS__); vpi_printf("\n");
+
+  /**
+    A wrapper for common_printf() which marks the given message as being debugging output.
+  */
+  #ifdef DEBUG
+    #define common_debug(...) vpi_printf("(%s:%d) ", __FILE__, __LINE__); common_printf(__VA_ARGS__);
+  #else
+    #define common_debug(...)
+  #endif
+
+  /**
+    A boolean variable with two possible values: true and false. Pass aroung this value instead of zero and non-zero integers.
+  */
+  typedef enum { false = 0, true = 1 } bool;
+
+  /**
+    Returns the string "true" if the given boolean expression is true. Otherwise returns the string "false".
+  */
+  #define common_boolToStr(aBoolExpr)	( (aBoolExpr) ? "true" : "false" )
+
+#endif

data/ext/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+
+have_library 'pthread', 'pthread_create'
+create_makefile 'ruby-vpi'

data/ext/relay.cin

@@ -0,0 +1,146 @@
+/*
+  Copyright 2006 Suraj N. Kurapati
+  Copyright 1999 Kazuhiro HIWADA
+
+  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.
+*/
+
+#ifndef RELAY_CIN
+#define RELAY_CIN
+
+  #include <stdlib.h>
+  #include <pthread.h>
+  #include <ruby.h>
+  #include <assert.h>
+
+  #include "verilog.h"
+  #include "common.h"
+
+  #include "relay.hin"
+  #include "swig.hin"
+
+
+  static pthread_t relay__rubyThread;
+  static pthread_mutex_t relay__rubyLock;
+  static pthread_mutex_t relay__verilogLock;
+
+  static 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);
+  }
+
+  static void relay_ruby() {
+    pthread_mutex_unlock(&relay__rubyLock);
+    pthread_mutex_lock(&relay__verilogLock);
+  }
+
+  static void relay_verilog() {
+    pthread_mutex_unlock(&relay__verilogLock);
+    pthread_mutex_lock(&relay__rubyLock);
+  }
+
+  typedef struct {
+    PLI_BYTE8** mArgs;	/// Array of command-line arguments.
+    uint 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.
+  */
+  static 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;
+      uint argc = pRubyOptions->mCount;
+
+      ruby_options(argc, argv);
+
+      // free the memory used by command-line options
+      uint 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;
+  }
+
+  static 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);
+  }
+
+#endif