rvvm 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 382560e4ccb96972c0588cb6e5bcfd1bc70e6270349ef8db3e156a86ae247507
+  data.tar.gz: 9a29c17cdf2496336b01767c9e9de74c451094fd4c8af361fc3f2d1c1a1c17a6
+SHA512:
+  metadata.gz: 380692384df76a75b6099f1d395721162a10c30070fc2f678b07684379debe8e9f15d503ff2a0ff2a64fe116f395808378796313a2bebb806d6c6992d6dcf4f7
+  data.tar.gz: d15065c6eedba2aaf550d93f31f42e5717691a47355a0820b4366cfeb81034386641b771ca7e30a64e2c931843516d22ff2f8df25e628ecab82ce377d172c7c8

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-16
+
+- Initial release
+
+## [0.8.0] - 2024-09-16
+
+### Added:
+
+1. Template file generation api
+2. RVM project template generation
+3. Argument parsing
+4. RVvM project config loading and parsing
+5. Project SV source compilation
+6. Project elaboration
+7. UVM test simulation
+
+### TBI:
+1. Test list parsing and batch simulation
+2. Module/itf/pkg/generic sv template generation
+3. Pure SV/Vlog simulation
+4. Waveform inspection using Vivado GUI
+5. Functional coverage report generation
+6. Unit tests
+7. CLI log graphic
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Viktor Toth aka mrbya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# RVvM - Ruby Vivado Manager
+
+RVvM is a Ruby based meta tool to manage, compile, elaborate and simulate SystemVerilog and UVM based projects using Xilinx Vivado xvlog, xelab, xrun and xsc tools.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rvvm
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rvvm
+```
+
+## Usage
+
+TBA
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/such-hdl-much-wow/rvvm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/such-hdl-much-wow/rvm/-/blob/master/CODE_OF_CONDUCT.md?ref_type=heads).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rvm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/such-hdl-much-wow/rvm/-/blob/master/CODE_OF_CONDUCT.md?ref_type=heads).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+# require "rubocop/rake_task"
+#
+# RuboCop::RakeTask.new
+#
+# task default: %i[test rubocop]

data/lib/rvvm/templates.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module Templates
+  @templates = {}
+
+  @templates[:rvvmconf] = {
+    file: {
+      path: "./rvvm",
+      name: "rvvmconf.json"
+    },
+    conf: {
+      prjname: "RVvM",
+      prjpath: "~/rvvm/RVvM"
+    },
+    content: %({
+  "project": {
+    "name": "${prjname}",
+    "path": "${prjpath}",
+    "rvvmDir": "rvvm",
+    "logDir": "logs",
+    "company": " "
+  },
+
+  "compilation": {
+    "list": "${prjname}_compile_list.f",
+    "logDir": "comp",
+    "log": "comp.log",
+    "args": "-L uvm"
+  },
+
+  "dpi": {
+    "dpilib": 0,
+    "list": "dpi_compile_list.f",
+    "args": " "
+  },
+
+  "elaboration": {
+    "tbTop": "${prjname}_tb_top",
+    "tb": "${prjname}_tb",
+    "timescale": "1ns/1ps",
+    "logDir": "elab",
+    "log": "elab.log",
+    "args": " "
+  },
+
+  "simulation": {
+    "logDir": "sim",
+    "log": "${testname}.log",
+    "verbosity": "LOW",
+    "defTest": " ",
+    "batch": 0,
+    "testList": " ",
+    "args": " "
+  }
+})
+  }
+
+  @templates[:compilelist] = {
+    file: {
+      path: "./rvvm",
+      name: "RVvM_compile_list.f"
+    },
+    conf: {
+      prjname: "RVvM"
+    },
+    content: %(-i ../design
+-i ../design/src
+-i ../verif/env
+-i ../verif/env/agents
+-i ../verif/env/top
+-i ../verif/tb/src
+-i ../verif/test
+-i ../verif/test/seq
+-i ../verif/test/src
+../verif/tb/src/${prjname}_tb_top.sv
+
+)
+  }
+
+  @templates[:wfcfg] = {
+    file: {
+      path: "./rvvm",
+      name: "wfcfg.tcl"
+    },
+    conf: {},
+    content: %(log_wave -recursive *
+run all
+exit
+
+)
+  }
+
+  @templates[:dpilist] = {
+    file: {
+      path: "./rvvm",
+      name: "dpi_compile_list.f"
+    },
+    conf: {},
+    content: %(#list of DPI-C sources
+)
+  }
+
+  @templates[:tbtop] = {
+    file: {
+      path: "./verif/tb/src",
+      name: "RVvM_tb_top.sv"
+    },
+    conf: {
+      prjname: "RVvM",
+      PRJNAME: "RVvM"
+    },
+    content: %(`ifndef ${PRJNAME}_TB_TOP
+`define ${PRJNAME}_TB_TOP
+
+`include "uvm_macros.svh"
+
+import uvm_pkg::*;
+
+module ${prjname}_tb_top;
+
+    //testbench implementation
+
+endmodule: ${prjname}_tb_top
+
+`endif//${PRJNAME}_TB_TOP
+
+)
+  }
+
+  @templates[:module] = {
+    file: {
+      path: "design/src"
+    },
+    conf: {
+      type: "module",
+      module: "best_rtl_module_ever",
+      date: "01/01/2024 00:00",
+      prjname: "RVvM",
+      company: " ",
+      username: "me"
+    },
+    content: %(//////////////////////////////////////////////////////////////////////////////////
+// Company:         ${company}
+// Engineer:        ${username}
+// 
+// Create Date:     ${date}
+// Project Name:    ${prjname}
+// Module Name:     ${module}
+// Target Devices:  
+// Tool Versions:   
+// Description:     
+// 
+// Dependencies:    
+// 
+// Revision:        
+// Revision 0.01 - File Created
+// Additional Comments:
+// 
+//////////////////////////////////////////////////////////////////////////////////
+
+${type} ${module}(
+
+);
+
+end${type}
+)
+  }
+
+  @templates[:package] = {
+    file: {
+      path: "design/pkg"
+    },
+    conf: {
+      package: "best_rtl_pkg",
+      PACKAGE: "BEST_RTL_PACKAGE",
+      date: "01/01/2024 00:00",
+      prjname: "RVvM",
+      company: " ",
+      username: "me"
+    },
+    content: %(//////////////////////////////////////////////////////////////////////////////////
+// Company:         ${company}
+// Engineer:        ${username}
+// 
+// Create Date:     ${date}
+// Project Name:    ${prjname}
+// Package Name:    ${package}
+// Target Devices:  
+// Tool Versions:   
+// Description:     
+// 
+// Dependencies:    
+// 
+// Revision:        
+// Revision 0.01 - File Created
+// Additional Comments:
+// 
+//////////////////////////////////////////////////////////////////////////////////
+`ifndef ${PACKAGE}
+`define ${PACKAGE}
+
+package ${package};
+
+endpackage
+
+`endif//${PACKAGE}
+)
+  }
+
+  @templates[:svfile] = {
+    file: {
+      path: "design/src"
+    },
+    conf: {
+      NAME: "BEST_RTL_FILE",
+      date: "01/01/2024 00:00",
+      prjname: "RVvM",
+      company: " ",
+      username: "me"
+    },
+    content: %(//////////////////////////////////////////////////////////////////////////////////
+// Company:         ${company}
+// Engineer:        ${username}
+// 
+// Create Date:     ${date}
+// Project Name:    ${prjname}
+// Package Name:    ${package}
+// Target Devices:  
+// Tool Versions:   
+// Description:     
+// 
+// Dependencies:    
+// 
+// Revision:        
+// Revision 0.01 - File Created
+// Additional Comments:
+// 
+//////////////////////////////////////////////////////////////////////////////////
+`ifndef ${NAME}
+`define ${NAME}
+
+
+
+`endif//${NAME}
+)
+  }
+
+  def self.load
+    @templates
+  end
+end

data/lib/rvvm/utils.rb

@@ -0,0 +1,62 @@
+# # frozen_string_literal: true
+
+module Utils
+  def self.interpret(string, hash)
+    string.gsub(/\$\{([^}]+)\}/) do |match|
+      hash[Regexp.last_match(1).to_sym] || match
+    end
+  end
+
+  def self.gen_file(path, content)
+    File.open(path, "w") do |file|
+      file.write(content)
+    end
+  rescue StandardError => e
+    puts "\nFailed to create a file!\nError #{e.message}"
+  end
+
+  def self.gen_template(template, name = nil, config = nil, path = nil)
+    temp_config = config || template[:config]
+    content = interpret(template[:content], temp_config)
+    filename = name || template[:file][:name]
+    filepath = path || template[:file][:path]
+
+    puts "Generating: #{filepath}/#{filename}"
+    gen_file("#{filepath}/#{filename}", content)
+  end
+
+  def self.find_file_dir(filename, path)
+    Dir.foreach(path) do |file|
+      next if file == "."
+      next if file == ".."
+
+      full_path = File.join(path, file)
+
+      if File.directory?(full_path)
+        found = find_file_dir(filename, full_path)
+        return found if found
+      elsif file == filename
+        return path
+      end
+    end
+    nil
+  end
+
+  def self.git_userame
+    username = nil
+    IO.popen("git config --get user.name") do |handle|
+      username = handle.read
+    end
+
+    username.strip!
+    username
+  end
+
+  def self.all_nil?(hash, array)
+    array.each do |key|
+      return false if hash[key]
+    end
+
+    true
+  end
+end

data/lib/rvvm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rvvm
+  VERSION = "0.8.0"
+end

data/lib/rvvm.rb

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+
+require_relative "rvvm/version"
+require_relative "rvvm/utils"
+require_relative "rvvm/templates"
+
+require "optparse"
+require "fileutils"
+require "json"
+
+module Rvvm
+  class Error < StandardError; end
+
+  @templates = Templates.load
+  @config_path = nil
+  @config = nil
+
+  @args = {}
+  @required_args = %i[
+    new
+    module
+    pkg
+    itf
+    svfile
+    comp
+    elab
+    run
+    all
+    runsv
+    dpi
+    gui
+    gencov
+    covreport
+  ]
+
+  OptionParser.new do |args|
+    args.on("-h", "--help", "Shows this help") do
+      puts "\nRVvM - Ruby Vivado Manager\n\n"
+      puts "\tRVvM is a Ruby based tool to manage, compile, elaborate and simulate SystemVerilog and UVM based projects"
+      puts "\tusing Xilinx Vivado xvlog, xelab, xrun and xsc.\n\n"
+      puts args
+      # puts "\nRequired args (at least one):"
+      # @required_args.each do |arg|
+      #   puts "\t--#{arg}"
+      # end
+      exit
+    end
+    args.on("-v", "--version", "Displays RVvM gem version") do
+      puts "RVvM version: #{VERSION}"
+    end
+
+    args.on("-n", "--new NAME", "Creates a new project wit the prowided name under pwd")
+    args.on("--module NAME", "Creates a SystemVerilog module template (default path: <prj dir>/design/src)")
+    args.on("--pkg NAME", "Creates a SystemVerilog package template (default path: <prj dir>/design/pkg)")
+    args.on("--itf NAME", "Creates a SystemVerilog interface template (default path: <prj dir>/design/itf)")
+    args.on("--svfile NAME", "Creates a generic SystemVerilog file template (default path: <prj dir>/design/src)")
+    args.on("--here", "Speciies pwd as a path when creating a file template")
+    args.on("--path PATH", "Specifies a path relative to <prj dir> when creating a file template")
+    args.on("-c", "--comp", "Compile SystemVerilog sources")
+    args.on("-e", "--elab", "Elaborates project")
+    args.on("-r", "--run", "Runs UVM simulation")
+    args.on("-a", "--all", "Runs --comp, (--dpi), --elab, --run")
+    args.on("--runsv", "Runs pure SystemVerilog/Verilog simulation (Ignores UVM related arguments and config options)")
+    args.on("-d", "--dpi", "Compiles C/C++ sources to a shared lib to link into an elaborated snaphost using DPI-C")
+    args.on("-u", "--gui", "Opens a dumped waveform in Xilinx Vivado GUI")
+    args.on("-g", "--gencov", "Generates a functional coverage report")
+    args.on("-p", "--covreport", "Opens the latest generated functional coverage report in Xilinx coverage dashboard")
+    args.on("--complog LOGNAME", "Specifies compilation log filename (overrides config)")
+    args.on("--complist LISTFILE", "Specifies compile list for compilation (overrides config)")
+    args.on("--elablog LOGNAME", "Specifies elaboration log filename (overrides config)")
+    args.on("--timescale TIMESCALE", "Specifies timescale for testbench snapshot to be elaborated (overrides config)")
+    args.on("--tbtop TOPMODULE", "Specifie testbench top module (overwrites config)")
+    args.on("--tb TBNAME", "Specifies tesbench snapshot to be elaborated (overwrites config)")
+    args.on("--simlog LOGNAME", "Specifies simulation log name (overwrites config)")
+    args.on("--test TESTNAME", "Specifies UVM test to be run by --run (overwrites config)")
+    args.on("-b", "--batch", "Run a batch of UVM tests from a test list (overwrites config)")
+    args.on("--testlist TESTLIST", "Specifies test list for a batch of test run (overwrites config)")
+    args.on("--verb VERBOSITY", "Specifies UVM verbosity <LOW, MEDIUM, HIGH, FULL, DEBUG> (overwrites config)")
+    args.on("--simtb TBNAME", "Specifies testbench snapshot for simulation (overwrites config)")
+    args.on("--dpilist LISTFILE", "Specifies source file list for DPI-C compilation (overwrites config)")
+    args.on("-w", "--wave", "Activates waveform trace dump for elaboration and simulation (overwrites config)")
+    args.on("--wavefile WAVEFILE", "Specifies waveform dump file to be openned in Vivado GUI")
+    args.on("--prjconf CONFIG", "Specifies RVvM project config file if not using the one provided in the project")
+    args.on("-l", "--dpilib", "Specifies a DPI-C shared library to be linked with a snapshot during elaboration")
+    args.on("--debug", "Script debug")
+  end.parse!(into: @args)
+
+  def self.pass_config(config)
+    @config = config
+  end
+
+  def self.check_args
+    if @args[:all]
+      @args[:comp] = 1
+      @args[:elab] = 1
+      @args[:run] = 1
+    end
+    if Utils.all_nil?(@args, @required_args)
+      puts "\nNo required options provided!\nFor more info use -h or --help\n"
+      exit
+    end
+  end
+
+  def self.handle_args
+    @args[:dpi] = 1 if @args[:all] && @config[:dpi][:dpilib] == 1
+
+    if @args[:batch] || @config[:simulation][:batch] == 1
+      if @args[:test]
+        puts "UVM test provided even though running in batch mode - option will be ignored..."
+        @args[:test] = nil
+      end
+    elsif @args[:testList]
+      puts "UVM test list provided without running in batch mode - option will be ignored..."
+      @args[:testlist] = nil
+    end
+  end
+
+  def self.execute(command)
+    if @args[:debug]
+      puts command
+    else
+      system(command)
+    end
+  end
+
+  def self.create_new_project(name)
+    puts "\nRVvM: Generating new project: #{name} ...\n"
+
+    FileUtils.mkdir(name)
+    Dir.chdir(name)
+
+    FileUtils.mkdir("rvvm")
+    FileUtils.chdir("rvvm")
+    FileUtils.mkdir("logs")
+    Dir.chdir("logs")
+    FileUtils.mkdir("comp")
+    FileUtils.mkdir("elab")
+    FileUtils.mkdir("sim")
+    FileUtils.mkdir("dpi")
+    Dir.chdir("../..")
+
+    temp_conf = @templates[:rvvmconf][:conf]
+    temp_conf[:prjname] = name
+    temp_conf[:prjpath] = Dir.pwd
+    Utils.gen_template(@templates[:rvvmconf], nil, temp_conf)
+
+    temp_conf = @templates[:compilelist][:conf]
+    temp_conf[:prjname] = name
+    Utils.gen_template(@templates[:compilelist], "#{name}_compile_list.f", temp_conf)
+
+    Utils.gen_template(@templates[:wfcfg])
+    Utils.gen_template(@templates[:dpilist])
+
+    FileUtils.mkdir("design")
+    Dir.chdir("design")
+    FileUtils.mkdir("pkg")
+    FileUtils.mkdir("itf")
+    FileUtils.mkdir("src")
+    Dir.chdir("..")
+
+    FileUtils.mkdir("verif")
+    Dir.chdir("verif")
+    FileUtils.mkdir("env")
+    FileUtils.mkdir("env/agents")
+    FileUtils.mkdir("env/top")
+    FileUtils.mkdir("tb")
+    FileUtils.mkdir("tb/src")
+    FileUtils.mkdir("test")
+    FileUtils.mkdir("test/seq")
+    FileUtils.mkdir("test/src")
+    Dir.chdir("..")
+
+    temp_conf = @templates[:tbtop][:conf]
+    temp_conf[:prjname] = name
+    temp_conf[:PRJNAME] = name.upcase
+    Utils.gen_template(@templates[:tbtop], "#{name}_tb_top.sv", temp_conf)
+
+    system("git init")
+    system("git add .")
+    system('git commit -am "Initial commit"')
+
+    puts "\nRVvM: New project generated. ^^"
+
+    exit(0)
+  end
+
+  def self.load_config
+    puts "\nRVvM: Loading RVvM project config..."
+
+    @config_path = Utils.find_file_dir("rvvmconf.json", ".")
+    json_file = File.read("#{@config_path}/rvvmconf.json") if @config_path
+
+    unless json_file
+      puts "     Failed to load config file!\n"
+      puts "     Make sure you are inside an RVvM project.\n\n"
+      exit(1)
+    end
+
+    @config = JSON.parse(json_file) if json_file
+    @config = @config.transform_values do |v|
+      v.transform_keys(&:to_sym)
+    end.transform_keys(&:to_sym)
+  end
+
+  def self.prj_top
+    Dir.chdir(@config_path)
+  end
+
+  def self.compile
+    cmd_args = @config[:compilation][:args]
+    logname = File.join(@config[:compilation][:logDir], @args[:complog] || @config[:compilation][:log])
+    complist = @args[:compilelist] || @config[:compilation][:list]
+
+    puts "\nRVvM: Compiling HDL sources..\n"
+
+    cmd = "xvlog -sv -f #{complist} -log #{logname} #{cmd_args}"
+    execute(cmd)
+  end
+
+  def self.dpi_c
+    cmd_args = @config[:dpi][:args]
+    dpilist = @args[:dpilist] || @config[:dpi][:list]
+
+    puts "\nRVvM: Building DPI-C library...\n"
+
+    cmd = "sxc -f #{dpilist} #{cmd_args}"
+    execute(cmd)
+  end
+
+  def self.elaborate
+    cmd_args = @config[:elaboration][:args]
+    cmd_args << " -sv_lib dpi" if @args[:dpi] || @args[:dpilib] || @config[:dpi][:dpilib] == 1
+    cmd_args << " -debug wave" if @args[:wave]
+    logname = File.join(@config[:elaboration][:logDir], @args[:elablog] || @config[:elaboration][:log])
+    tb_top = @args[:tbtop] || @config[:elaboration][:tbTop]
+    tb = @args[:tb] || @config[:elaboration][:tb]
+    timescale = @args[:timescale] || @config[:elaboration][:timescale]
+
+    puts "\nRVvM: Elaborating testbench:"
+    puts "     TB TOP: \t#{tb_top}"
+    puts "     SNAPSHOT:\t#{tb}\n"
+
+    cmd = "xelab #{tb_top} -relax -s #{tb} -timescale #{timescale} -log #{logname} #{cmd_args}"
+    execute(cmd)
+  end
+
+  def self.run_sim
+    cmd_args = @config[:simulation][:args]
+    if @args[:wave]
+      cmd_args << " --tclbatch wfcfg.tcl"
+    else
+      cmd_args << "-R"
+    end
+
+    test = @args[:test] || @config[:simulation][:defTest]
+    # TODO: parse test list
+    testlist = [test]
+
+    tb = @args[:simtb] || @args[:tb] || @config[:elaboration][:tb]
+
+    puts ""
+
+    testlist.each_with_index do |simtest, i|
+      puts "RVvM: Running test #{i + 1}/#{testlist.size}: #{simtest}"
+
+      logname = File.join(@config[:simulation][:logDir], @config[:simulation][:log])
+      logname = Utils.interpret(logname, { testname: simtest })
+
+      verb = "UVM_#{@args[:verb] || @config[:simulation][:verbosity]}"
+
+      cmd = "xsim #{tb} -log #{logname} -testplusarg \"UVM_VERBOSITY=#{verb}\" -testplusarg \"UVM_TESTNAME=#{simtest}\" #{cmd_args}"
+      execute(cmd)
+    end
+  end
+
+  def self.run
+    create_new_project(@args[:new]) if @args[:new]
+
+    check_args
+    load_config
+    handle_args
+
+    prj_top
+
+    compile     if @args[:comp]
+    dpi_c       if @args[:dpi]
+    elaborate   if @args[:elab]
+    run_sim     if @args[:run]
+  end
+end
+

data/sig/rvvm.rbs

@@ -0,0 +1,4 @@
+module Rvvm
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rvvm
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- mrbya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-15 00:00:00.000000000 Z
+dependencies: []
+description: RVvM is a Ruby based meta tool to manage/compile/elaborate and run simulations
+  on SystemVerilog and UVM based projects using Xilinx Vivado xvlog, xelab, xrun,
+  xsc tools
+email:
+- v.toth.svk2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rvvm.rb
+- lib/rvvm/templates.rb
+- lib/rvvm/utils.rb
+- lib/rvvm/version.rb
+- sig/rvvm.rbs
+homepage: https://gitlab.com/such-hdl-much-wow/rvvm.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/such-hdl-much-wow/rvvm.git
+  source_code_uri: https://gitlab.com/such-hdl-much-wow/rvvm.git
+  changelog_uri: https://gitlab.com/such-hdl-much-wow/rvvm/-/blob/master/CHANGELOG.md?ref_type=heads
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: RVvM - Ruby Vivado Manager
+test_files: []