Add --no-std-waiver and default reading of standard lint waivers file (verilator#5607).

Author: wsnyder

Changes

@@ -17,9 +17,10 @@ Verilator 5.031 devel
 * Support basic constrained random for multi-dimensional dynamic array and queue (#5591). [Yilou Wang]
 * Support vpiDefName (#3906) (#5572). [Krzysztof Starecki]
 * Support `pure constraint`.
-* Add `--no-std-package` as subset-alias of `--no-std`.
-* Add `--waiver-multiline` for context-sensitive `--waiver-output`.
-* Add `lint_off --contents` in configuration files. (#5606)
+* Add `--no-std-waiver` and default reading of standard lint waivers file (#5607).
+* Add `--no-std-package` as subset-alias of `--no-std` (#5607).
+* Add `lint_off --contents` in configuration files (#5606).
+* Add `--waiver-multiline` for context-sensitive `--waiver-output` (#5608).
 * Add error on illegal enum base type (#3010). [Iztok Jeras]
 * Add error on `wait` with missing `.triggered` (#4457).
 * Add error when improperly storing to parameter (#5147). [Gökçe Aydos]

bin/verilator

@@ -450,6 +450,7 @@ detailed descriptions of these arguments.
     --stats-vars                Provide statistics on variables
     --no-std                    Prevent loading standard files
     --no-std-package            Prevent parsing standard package
+    --no-std-waiver             Prevent parsing standard lint waivers
     --no-stop-fail              Do not call $stop when assertion fails
     --structs-packed            Convert all unpacked structures to packed structures
      -sv                        Enable SystemVerilog parsing

docs/guide/exe_verilator.rst

@@ -1364,13 +1364,17 @@ Summary:
 .. option:: --no-std
 
    Prevents parsing standard input files, alias for
-   :opt:`--no-std-package`.  This may be extended to prevent reading other
-   standardized files in future versions.
+   :opt:`--no-std-package`, :opt:`--no-std-waiver`.  This may be extended
+   to prevent reading other standardized files in future versions.
 
 .. option:: --no-std-package
 
    Prevents parsing standard `std::` package file.
 
+.. option:: --no-std-waiver
+
+   Prevents parsing standard lint waivers (`verilated_std_waiver.vlt`).
+
 .. option:: --no-stop-fail
 
    Don't call $stop when assertion fails. Simulation will continue.

include/verilated.v

@@ -12,11 +12,11 @@
 //
 // DESCRIPTION: Verilator: Include in verilog files to hide verilator defines
 
-`ifdef _VERILATED_V_ `else
+`ifndef _VERILATED_V_
  `define _VERILATED_V_ 1
 
  // Hide verilator pragmas from other tools
- `ifdef VERILATOR `else
+ `ifndef VERILATOR
   `define coverage_block_off
  `endif
 

include/verilated_std.sv

@@ -14,8 +14,8 @@
 /// \file
 /// \brief Verilated IEEE std:: header
 ///
-/// This file is included automatically by Verilator when a std::mailbox or
-/// std::semaphore is referenced.
+/// This file is included automatically by Verilator, unless '--no-std-package'
+/// is used.
 ///
 /// This file is not part of the Verilated public-facing API.
 /// It is only for internal use.

include/verilated_std_waiver.vlt

@@ -0,0 +1,64 @@
+// DESCRIPTION: Verilator: built-in standard lint waivers
+//
+// Code available from: https://verilator.org
+//
+//*************************************************************************
+//
+// Copyright 2022-2024 by Wilson Snyder. This program is free software; you can
+// redistribute it and/or modify it under the terms of either the GNU Lesser
+// General Public License Version 3 or the Perl Artistic License Version 2.0.
+// SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
+//
+//*************************************************************************
+///
+/// \file
+/// \brief Verilated built-in standard lint waivers
+///
+/// This file is included automatically by Verilator, unless '--no-std-waiver'
+/// is used.
+///
+/// To assist in building new rules, use:
+///      'verilator --waiver-multiline --waiver-output <filename>'
+///
+//*************************************************************************
+
+`ifndef _VERILATED_STD_WAIVER_VLT_
+`define _VERILATED_STD_WAIVER_VLT_
+
+`verilator_config
+
+//=========================================================================
+// UVM
+
+// Apply these rules to only UVM base files
+`define VLT_UVM_FILES -file "*/uvm_*.svh" -contents "*UVM_VERSION_STRING*"
+
+// Whole-package file waivers
+lint_off -rule DECLFILENAME `VLT_UVM_FILES
+lint_off -rule VARHIDDEN `VLT_UVM_FILES
+lint_off -rule WIDTHEXPAND `VLT_UVM_FILES
+lint_off -rule WIDTHTRUNC `VLT_UVM_FILES
+
+// Context-sensitive waivers
+lint_off -rule CASEINCOMPLETE `VLT_UVM_FILES -match "* case ({is_R, is_W})*"
+lint_off -rule CASEINCOMPLETE `VLT_UVM_FILES -match "* case(orig_severity)*"
+lint_off -rule CASTCONST `VLT_UVM_FILES -match "*class{}uvm_callback*"
+lint_off -rule CASTCONST `VLT_UVM_FILES -match "*class{}uvm_component*"
+lint_off -rule CASTCONST `VLT_UVM_FILES -match "*class{}uvm_event*"
+lint_off -rule CASTCONST `VLT_UVM_FILES -match "*class{}uvm_report_object*"
+lint_off -rule CASTCONST `VLT_UVM_FILES -match "*class{}uvm_sequence_item*"
+lint_off -rule MISINDENT `VLT_UVM_FILES -match "* foreach (abstractions[i])*"
+lint_off -rule MISINDENT `VLT_UVM_FILES -match "* foreach (lock_list[i])*"
+lint_off -rule MISINDENT `VLT_UVM_FILES -match "* rw_access.data=*"
+lint_off -rule MISINDENT `VLT_UVM_FILES -match "* uvm_cmdline_proc =*"
+lint_off -rule REALCVT `VLT_UVM_FILES -match "* m_time *"
+lint_off -rule REALCVT `VLT_UVM_FILES -match "*$realtime*"
+lint_off -rule SYMRSVDWORD `VLT_UVM_FILES -match "*'delete'*"
+lint_off -rule SYMRSVDWORD `VLT_UVM_FILES -match "*'list'*"
+lint_off -rule SYMRSVDWORD `VLT_UVM_FILES -match "*'map'*"
+lint_off -rule SYMRSVDWORD `VLT_UVM_FILES -match "*'override'*"
+lint_off -rule SYMRSVDWORD `VLT_UVM_FILES -match "*'volatile'*"
+
+//=========================================================================
+`undef VLT_UVM_FILES
+`endif  // Guard

src/V3FileLine.cpp

@@ -92,9 +92,13 @@ void FileLineSingleton::fileNameNumMapDumpJson(std::ostream& os) {
     std::string sep = "\n  ";
     os << "\"files\": {";
     for (const auto& itr : m_namemap) {
-        const std::string name
-            = itr.first == V3Options::getStdPackagePath() ? "<verilated_std>" : itr.first;
-        os << sep << '"' << filenameLetters(itr.second) << '"' << ": {\"filename\":\"" << name
+        std::string filename = itr.first;
+        if (filename == V3Options::getStdPackagePath()) {
+            filename = "<verilated_std>";
+        } else if (filename == V3Options::getStdWaiverPath()) {
+            filename = "<verilated_std_waiver>";
+        }
+        os << sep << '"' << filenameLetters(itr.second) << '"' << ": {\"filename\":\"" << filename
            << '"' << ", \"realpath\":\""
            << V3OutFormatter::quoteNameControls(V3Os::filenameRealPath(itr.first)) << '"'
            << ", \"language\":\"" << numberToLang(itr.second).ascii() << "\"}";

src/V3Global.cpp

@@ -58,6 +58,12 @@ void V3Global::readFiles() {
 
     V3Parse parser{v3Global.rootp(), &filter, &parseSyms};
 
+    // Parse the std waivers
+    if (v3Global.opt.stdWaiver()) {
+        parser.parseFile(
+            new FileLine{V3Options::getStdWaiverPath()}, V3Options::getStdWaiverPath(), false,
+            "Cannot find verilated_std_waiver.vlt containing built-in lint waivers: ");
+    }
     // Read .vlt files
     const V3StringSet& vltFiles = v3Global.opt.vltFiles();
     for (const string& filename : vltFiles) {

src/V3Options.cpp

@@ -568,7 +568,7 @@ string V3Options::filePath(FileLine* fl, const string& modname, const string& la
     // Return "" if not found.
     const string filename = V3Os::filenameCleanup(VName::dehash(modname));
     if (!V3Os::filenameIsRel(filename)) {
-        // filename is an absolute path, so can find getStdPackagePath()
+        // filename is an absolute path, so can find getStdPackagePath()/getStdWaiverPath()
         string exists = filePathCheckOneDir(filename, "");
         if (exists != "") return exists;
     }
@@ -631,7 +631,7 @@ void V3Options::filePathLookedMsg(FileLine* fl, const string& modname) {
 V3LangCode V3Options::fileLanguage(const string& filename) {
     string ext = V3Os::filenameNonDir(filename);
     string::size_type pos;
-    if (filename == V3Options::getStdPackagePath()) {
+    if (filename == V3Options::getStdPackagePath() || filename == V3Options::getStdWaiverPath()) {
         return V3LangCode::mostRecent();
     } else if ((pos = ext.rfind('.')) != string::npos) {
         ext.erase(0, pos + 1);
@@ -793,6 +793,9 @@ string V3Options::getenvVERILATOR_SOLVER() {
 string V3Options::getStdPackagePath() {
     return V3Os::filenameJoin(getenvVERILATOR_ROOT(), "include", "verilated_std.sv");
 }
+string V3Options::getStdWaiverPath() {
+    return V3Os::filenameJoin(getenvVERILATOR_ROOT(), "include", "verilated_std_waiver.vlt");
+}
 
 string V3Options::getSupported(const string& var) {
     // If update below, also update V3Options::showVersion()
@@ -1258,7 +1261,10 @@ void V3Options::parseOptsList(FileLine* fl, const string& optdir, int argc,
     DECL_OPTION("-json-edit-nums", OnOff, &m_jsonEditNums);
     DECL_OPTION("-json-ids", OnOff, &m_jsonIds);
     DECL_OPTION("-E", CbOnOff, [this](bool flag) {
-        if (flag) m_stdPackage = false;
+        if (flag) {
+            m_stdPackage = false;
+            m_stdWaiver = false;
+        }
         m_preprocOnly = flag;
     });
     DECL_OPTION("-emit-accessors", OnOff, &m_emitAccessors);
@@ -1512,8 +1518,12 @@ void V3Options::parseOptsList(FileLine* fl, const string& optdir, int argc,
         m_statsVars = flag;
         m_stats |= flag;
     });
-    DECL_OPTION("-std", CbOnOff, [this](bool flag) { m_stdPackage = flag; });
+    DECL_OPTION("-std", CbOnOff, [this](bool flag) {
+        m_stdPackage = flag;
+        m_stdWaiver = flag;
+    });
     DECL_OPTION("-std-package", OnOff, &m_stdPackage);
+    DECL_OPTION("-std-waiver", OnOff, &m_stdWaiver);
     DECL_OPTION("-stop-fail", OnOff, &m_stopFail);
     DECL_OPTION("-structs-packed", OnOff, &m_structsPacked);
     DECL_OPTION("-sv", CbCall, [this]() { m_defaultLanguage = V3LangCode::L1800_2023; });

src/V3Options.h

@@ -280,6 +280,7 @@ class V3Options final {
     bool m_reportUnoptflat = false;  // main switch: --report-unoptflat
     bool m_savable = false;         // main switch: --savable
     bool m_stdPackage = true;       // main switch: --std-package
+    bool m_stdWaiver = true;        // main switch: --std-waiver
     bool m_structsPacked = false;   // main switch: --structs-packed
     bool m_systemC = false;         // main switch: --sc: System C instead of simple C++
     bool m_stats = false;           // main switch: --stats
@@ -467,6 +468,7 @@ class V3Options final {
     bool stats() const { return m_stats; }
     bool statsVars() const { return m_statsVars; }
     bool stdPackage() const { return m_stdPackage; }
+    bool stdWaiver() const { return m_stdWaiver; }
     bool structsPacked() const { return m_structsPacked; }
     bool assertOn() const { return m_assert; }  // assertOn as __FILE__ may be defined
     bool assertCaseOn() const { return m_assertCase || m_assert; }
@@ -741,6 +743,7 @@ class V3Options final {
     static string getenvVERILATOR_ROOT();
     static string getenvVERILATOR_SOLVER();
     static string getStdPackagePath();
+    static string getStdWaiverPath();
     static string getSupported(const string& var);
     static bool systemCSystemWide();
     static bool systemCFound();  // SystemC installed, or environment points to it

src/V3ParseImp.cpp

@@ -332,7 +332,9 @@ void V3ParseImp::parseFile(FileLine* fileline, const string& modfilename, bool i
     }
 
     V3Stats::addStatSum(V3Stats::STAT_SOURCE_CHARS, m_ppBytes);
-    if (debug() && modfilename != V3Options::getStdPackagePath()) dumpInputsFile();
+    if (debug() && modfilename != V3Options::getStdPackagePath()
+        && modfilename != V3Options::getStdWaiverPath())
+        dumpInputsFile();
 
     // Parse it
     if (!v3Global.opt.preprocOnly()) {

src/V3Waiver.cpp

@@ -28,6 +28,7 @@
 void V3Waiver::addEntry(V3ErrorCode errorCode, const std::string& filename, const std::string& msg)
     VL_MT_SAFE_EXCLUDES(s_mutex) {
     if (filename == V3Options::getStdPackagePath()) return;
+    if (filename == V3Options::getStdWaiverPath()) return;
     const V3LockGuard lock{s_mutex};
 
     string trimmsg = msg;