From f8cb6979d78c88925eb449178d41f4a8171e1e2b Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Wed, 2 Dec 2009 21:15:56 -0500 Subject: [PATCH] Add Makefile VM_GLOBAL_FAST, listing objects needed to link executables. Add additional commentary to makefiles and other output files. --- Changes | 2 + include/verilated.mk.in | 6 ++- src/V3EmitC.cpp | 55 +++++++++++++++++++++---- src/V3EmitMk.cpp | 84 +++++++++++++++++++++++++++++---------- test_regress/Makefile_obj | 4 +- test_regress/driver.pl | 10 ++--- 6 files changed, 124 insertions(+), 37 deletions(-) diff --git a/Changes b/Changes index 70a312934..1189552ec 100644 --- a/Changes +++ b/Changes @@ -26,6 +26,8 @@ indicates the contributor was also the author of the fix; Thanks! **** Support for loop i++, ++i, i--, --i, bug175. [by Byron Bradley] +**** Add Makefile VM_GLOBAL_FAST, listing objects needed to link executables. + **** Fix MinGW compilation, bug184. [by Shankar Giri] **** Fix `define argument mis-replacing system task of same name, bug191. diff --git a/include/verilated.mk.in b/include/verilated.mk.in index 8dd86a697..287a7a5e1 100644 --- a/include/verilated.mk.in +++ b/include/verilated.mk.in @@ -136,6 +136,8 @@ VK_SUPPORT_CPP = $(addsuffix .cpp, $(VM_SUPPORT)) VK_USER_OBJS = $(addsuffix .o, $(VM_USER_CLASSES)) +VK_GLOBAL_OBJS = $(addsuffix .o, $(VM_GLOBAL_FAST) $(VM_GLOBAL_SLOW)) + ifneq ($(VM_PARALLEL_BUILDS),1) # Fast building, all .cpp's in one fell swoop # This saves about 5 sec per module, but can be slower if only a little changes @@ -171,13 +173,15 @@ $(VM_PREFIX)__ALLcls.o: $(VM_PREFIX)__ALLcls.cpp ###################################################################### ### Debugging -debug:: +debug-make:: @echo @echo VM_PREFIX: $(VM_PREFIX) @echo VM_CLASSES_FAST: $(VM_CLASSES_FAST) @echo VM_CLASSES_SLOW: $(VM_CLASSES_SLOW) @echo VM_SUPPORT_FAST: $(VM_SUPPORT_FAST) @echo VM_SUPPORT_SLOW: $(VM_SUPPORT_SLOW) + @echo VM_GLOBAL_FAST: $(VM_GLOBAL_FAST) + @echo VM_GLOBAL_SLOW: $(VM_GLOBAL_SLOW) @echo ###################################################################### diff --git a/src/V3EmitC.cpp b/src/V3EmitC.cpp index 0b94174a0..960dcb493 100644 --- a/src/V3EmitC.cpp +++ b/src/V3EmitC.cpp @@ -685,7 +685,24 @@ class EmitCImp : EmitCStmts { newCFile(filename, slow, source); ofp = new V3OutCFile (filename); } + ofp->putsHeader(); + if (modp->isTop() && !source) { + ofp->puts("// DESCR" "IPTION: Verilator output: Primary design header\n"); + ofp->puts("//\n"); + ofp->puts("// This header should be included by all source files instantiating the design.\n"); + ofp->puts("// The class here is then constructed to instantiate the design.\n"); + ofp->puts("// See the Verilator manual for examples.\n"); + } else { + if (source) { + ofp->puts("// DESCR" "IPTION: Verilator output: Design implementation internals\n"); + } else { + ofp->puts("// DESCR" "IPTION: Verilator output: Design internal header\n"); + } + ofp->puts("// See "+v3Global.opt.prefix()+".h for the primary calling header\n"); + } + ofp->puts("\n"); + return ofp; } @@ -1596,6 +1613,8 @@ void EmitCImp::emitInt(AstNodeModule* modp) { puts("/*AUTOSUBCELLS*/\n\n"); } else { puts("// CELLS\n"); + if (modp->isTop()) puts("// Public to allow access to /*verilator_public*/ items;\n"); + if (modp->isTop()) puts("// otherwise the application code can consider these internals.\n"); for (AstNode* nodep=modp->stmtsp(); nodep; nodep = nodep->nextp()) { if (AstCell* cellp=nodep->castCell()) { ofp()->putsCellDecl(modClassName(cellp->modp()), cellp->name()); @@ -1604,15 +1623,20 @@ void EmitCImp::emitInt(AstNodeModule* modp) { } puts("\n// PORTS\n"); + if (modp->isTop()) puts("// The application code writes and reads these signals to\n"); + if (modp->isTop()) puts("// propagate new values into/out from the Verilated model.\n"); emitVarList(modp->stmtsp(), EVL_IO, ""); puts("\n// LOCAL SIGNALS\n"); + if (modp->isTop()) puts("// Internals; generally not touched by application code\n"); emitVarList(modp->stmtsp(), EVL_SIG, ""); puts("\n// LOCAL VARIABLES\n"); + if (modp->isTop()) puts("// Internals; generally not touched by application code\n"); emitVarList(modp->stmtsp(), EVL_TEMP, ""); puts("\n// INTERNAL VARIABLES\n"); + if (modp->isTop()) puts("// Internals; generally not touched by application code\n"); ofp()->putsPrivate(!modp->isTop()); // private: unless top ofp()->putAlign(V3OutFile::AL_AUTO, 8); puts(symClassName()+"*\t__VlSymsp;\t\t// Symbol table\n"); @@ -1628,6 +1652,7 @@ void EmitCImp::emitInt(AstNodeModule* modp) { ofp()->putAlign(V3OutFile::AL_AUTO, 8); puts("\n// PARAMETERS\n"); + if (modp->isTop()) puts("// Parameters marked /*verilator public*/ for use by application code\n"); ofp()->putsPrivate(false); // public: for (AstNode* nodep=modp->stmtsp(); nodep; nodep = nodep->nextp()) { if (AstVar* varp = nodep->castVar()) { @@ -1651,7 +1676,7 @@ void EmitCImp::emitInt(AstNodeModule* modp) { } } - puts("\n// METHODS\n"); + puts("\n// CONSTRUCTORS\n"); ofp()->resetPrivate(); // We don't need a private copy constructor, as VerilatedModule has one for us. ofp()->putsPrivate(true); @@ -1666,29 +1691,42 @@ void EmitCImp::emitInt(AstNodeModule* modp) { puts("VL_CTOR("+modClassName(modp)+");\n"); puts("~"+modClassName(modp)+"();\n"); } else { + if (modp->isTop()) puts("/// Construct the model; called by application code\n"); puts(modClassName(modp)+"(const char* name=\"TOP\");\n"); + if (modp->isTop()) puts("/// Destroy the model; called (often implicitly) by application code\n"); puts("~"+modClassName(modp)+"();\n"); } if (v3Global.opt.trace() && !optSystemPerl()) { - puts("void\ttrace (SpTraceVcdCFile* tfp, int levels, int options=0);\n"); + if (modp->isTop()) puts("/// Trace signals in the model; called by application code\n"); + puts("void trace (SpTraceVcdCFile* tfp, int levels, int options=0);\n"); } - puts("void\t__Vconfigure("+symClassName()+"* symsp, bool first);\n"); - if (optSystemPerl()) puts("/*AUTOMETHODS*/\n"); + puts("\n// USER METHODS\n"); + if (optSystemPerl()) puts("/*AUTOMETHODS*/\n"); emitTextSection(AstType::SCINT); - puts("\n// Sensitivity blocks\n"); + puts("\n// API METHODS\n"); if (modp->isTop()) { - puts("void\tfinal();\t///< Function to call when simulation completed\n"); if (optSystemC()) ofp()->putsPrivate(true); ///< eval() is invoked by our sensitive() calls. - puts("void\teval();\t///< Main function to call from calling app when inputs change\n"); + else puts("/// Evaluate the model. Application must call when inputs change.\n"); + puts("void eval();\n"); + ofp()->putsPrivate(false); // public: + if (!optSystemC()) puts("/// Simulation complete, run final blocks. Application must call on completion.\n"); + puts("void final();\n"); if (v3Global.opt.inhibitSim()) { - puts("void\tinhibitSim(bool flag) { __Vm_inhibitSim=flag; }\t///< Set true to disable evaluation of module\n"); + puts("void inhibitSim(bool flag) { __Vm_inhibitSim=flag; }\t///< Set true to disable evaluation of module\n"); } + } + + puts("\n// INTERNAL METHODS\n"); + if (modp->isTop()) { ofp()->putsPrivate(true); // private: puts("static void _eval_initial_loop("+EmitCBaseVisitor::symClassVar()+");\n"); } + ofp()->putsPrivate(false); // public: + puts("void __Vconfigure("+symClassName()+"* symsp, bool first);\n"); + emitIntFuncDecls(modp); if (!optSystemPerl() && v3Global.opt.trace()) { @@ -1845,6 +1883,7 @@ class EmitCTrace : EmitCStmts { if (m_ofp) v3fatalSrc("Previous file not closed"); m_ofp = new V3OutCFile (filename); m_ofp->putsHeader(); + m_ofp->puts("// DESCR" "IPTION: Verilator output: Tracing implementation internals\n"); emitTraceHeader(); } diff --git a/src/V3EmitMk.cpp b/src/V3EmitMk.cpp index f114b4a52..fe0e9c4d6 100644 --- a/src/V3EmitMk.cpp +++ b/src/V3EmitMk.cpp @@ -46,29 +46,58 @@ public: return level; } + void putMakeClassEntry(V3OutMkFile& of, const string& name) { + of.puts("\t"+V3Options::filenameNonDirExt(name)+" \\\n"); + } + void emitClassMake() { // Generate the makefile V3OutMkFile of (v3Global.opt.makeDir()+"/"+ v3Global.opt.prefix() + "_classes.mk"); of.putsHeader(); - of.puts("\n"); + of.puts("# DESCR" "IPTION: Verilator output: Make include file with class lists\n"); + of.puts("#\n"); + of.puts("# This file lists generated Verilated files, for including in higher level makefiles.\n"); + of.puts("# See "+v3Global.opt.prefix()+".mk"+" for the caller.\n"); + of.puts("\n### Switches...\n"); + of.puts("# Coverage output mode? 0/1 (from --coverage)\n"); of.puts("VM_COVERAGE = "); of.puts(v3Global.opt.coverage()?"1":"0"); of.puts("\n"); + of.puts("# Tracing output mode? 0/1 (from --trace)\n"); of.puts("VM_TRACE = "); of.puts(v3Global.opt.trace()?"1":"0"); of.puts("\n"); - of.puts("\n"); - for (int support=0; support<2; support++) { + of.puts("\n### Object file lists...\n"); + for (int support=0; support<3; support++) { for (int slow=0; slow<2; slow++) { - of.puts(support?"VM_SUPPORT":"VM_CLASSES"); + if (support==2) of.puts("# Global classes, need linked once per executable"); + else if (support) of.puts("# Generated support classes"); + else of.puts("# Generated module classes"); + if (slow) of.puts(", non-fast-path, compile with low/medium optimization\n"); + else of.puts(", fast-path, compile with highest optimization\n"); + of.puts(support==2?"VM_GLOBAL":support==1?"VM_SUPPORT":"VM_CLASSES"); of.puts(slow?"_SLOW":"_FAST"); of.puts(" += \\\n"); - for (AstCFile* nodep = v3Global.rootp()->filesp(); nodep; nodep=nodep->nextp()->castCFile()) { - if (nodep->source() && nodep->slow()==slow && nodep->support()==support) { - of.puts("\t"+V3Options::filenameNonDirExt(nodep->name())+" \\\n"); + if (support==2 && !slow) { + putMakeClassEntry(of, "verilated.cpp"); + if (v3Global.opt.systemPerl()) { + putMakeClassEntry(of, "Sp.cpp"); // Note Sp.cpp includes SpTraceVcdC + } + else if (v3Global.opt.trace()) { + putMakeClassEntry(of, "SpTraceVcdC.cpp"); + } + } + else if (support==2 && slow) { + } + else { + for (AstCFile* nodep = v3Global.rootp()->filesp(); nodep; nodep=nodep->nextp()->castCFile()) { + if (nodep->source() && nodep->slow()==slow && nodep->support()==support) { + putMakeClassEntry(of, nodep->name()); + } } } of.puts("\n"); } } + of.puts("\n"); of.putsHeader(); } @@ -77,6 +106,10 @@ public: // Generate the makefile V3OutMkFile of (v3Global.opt.makeDir()+"/"+ v3Global.opt.prefix() + ".mk"); of.putsHeader(); + of.puts("# DESCR" "IPTION: Verilator output: Makefile for building Verilated archive or executable\n"); + of.puts("#\n"); + of.puts("# Execute this makefile from the object directory:\n"); + of.puts("# make -f "+v3Global.opt.prefix()+".mk"+"\n"); of.puts("\n"); if (v3Global.opt.exe()) { @@ -84,33 +117,37 @@ public: } else { of.puts("default: "+v3Global.opt.prefix()+"__ALL.a\n"); } - of.puts("\n# Constants...\n"); + of.puts("\n### Constants...\n"); + of.puts("# Perl executable (from $PERL)\n"); of.puts("PERL = "+V3Options::getenvPERL()+"\n"); + of.puts("# Path to Verilator kit (from $VERILATOR_ROOT)\n"); of.puts("VERILATOR_ROOT = "+V3Options::getenvVERILATOR_ROOT()+"\n"); + of.puts("# Path to SystemPerl kit top (from $SYSTEMPERL)\n"); of.puts("SYSTEMPERL = "+V3Options::getenvSYSTEMPERL()+"\n"); + of.puts("# Path to SystemPerl kit includes (from $SYSTEMPERL_INCLUDE)\n"); of.puts("SYSTEMPERL_INCLUDE = "+V3Options::getenvSYSTEMPERL_INCLUDE()+"\n"); - of.puts("\n# Switches...\n"); + of.puts("\n### Switches...\n"); + of.puts("# SystemPerl output mode? 0/1 (from --sp)\n"); of.puts(string("VM_SP = ")+(v3Global.opt.systemPerl()?"1":"0")+"\n"); + of.puts("# SystemC output mode? 0/1 (from --sc)\n"); of.puts(string("VM_SC = ")+((v3Global.opt.systemC()&&!v3Global.opt.systemPerl())?"1":"0")+"\n"); + of.puts("# SystemPerl or SystemC output mode? 0/1 (from --sp/--sc)\n"); of.puts(string("VM_SP_OR_SC = ")+(v3Global.opt.systemC()?"1":"0")+"\n"); + of.puts("# Deprecated\n"); of.puts(string("VM_PCLI = ")+(v3Global.opt.systemC()?"0":"1")+"\n"); + of.puts("# SystemC architecture to find link library path (from $SYSTEMC_ARCH)\n"); of.puts(string("VM_SC_TARGET_ARCH = ")+V3Options::getenvSYSTEMC_ARCH()+"\n"); - of.puts("\n# Vars...\n"); + of.puts("\n### Vars...\n"); + of.puts("# Design prefix (from --prefix)\n"); of.puts(string("VM_PREFIX = ")+v3Global.opt.prefix()+"\n"); + of.puts("# Module prefix (from --prefix)\n"); of.puts(string("VM_MODPREFIX = ")+v3Global.opt.modPrefix()+"\n"); - // Imply generating verilated.o - if (v3Global.opt.exe()) { - v3Global.opt.addCppFile("verilated.cpp"); - if (v3Global.opt.trace()) { - v3Global.opt.addCppFile("SpTraceVcdC.cpp"); - } - } - V3StringSet dirs; + of.puts("# User .cpp files (from .cpp's on Verilator command line)\n"); of.puts("VM_USER_CLASSES = \\\n"); for (V3StringSet::iterator it = v3Global.opt.cppFiles().begin(); it != v3Global.opt.cppFiles().end(); ++it) { @@ -121,18 +158,21 @@ public: } of.puts("\n"); + of.puts("# User .cpp directories (from .cpp's on Verilator command line)\n"); of.puts("VM_USER_DIR = \\\n"); for (V3StringSet::iterator it = dirs.begin(); it!=dirs.end(); ++it) { of.puts("\t"+*it+" \\\n"); } of.puts("\n"); - of.puts("\n# Default rules...\n"); + of.puts("\n### Default rules...\n"); + of.puts("# Include list of all generated classes\n"); of.puts("include "+v3Global.opt.prefix()+"_classes.mk\n"); + of.puts("# Include global rules\n"); of.puts("include $(VERILATOR_ROOT)/include/verilated.mk\n"); - of.puts("\n# Local rules...\n"); if (v3Global.opt.exe()) { + of.puts("\n### Executable rules... (from --exe)\n"); of.puts("VPATH += $(VM_USER_DIR)\n"); of.puts("\n"); for (V3StringSet::iterator it = v3Global.opt.cppFiles().begin(); @@ -143,8 +183,8 @@ public: of.puts("\t$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(OPT_FAST) -c -o $@ $<\n"); } - of.puts("\n# Link rules...\n"); - of.puts(v3Global.opt.prefix()+": $(VK_USER_OBJS) $(SP_SRCS) $(VM_PREFIX)__ALL.a\n"); + of.puts("\n### Link rules... (from --exe)\n"); + of.puts(v3Global.opt.prefix()+": $(VK_USER_OBJS) $(VK_GLOBAL_OBJS) $(SP_SRCS) $(VM_PREFIX)__ALL.a\n"); of.puts("\t$(LINK) $(LDFLAGS) $^ $(LOADLIBES) $(LDLIBS) -o $@ $(LIBS) $(SC_LIBS) 2>&1 | c++filt\n"); of.puts("\n"); } diff --git a/test_regress/Makefile_obj b/test_regress/Makefile_obj index 4f91b52d8..18de0a740 100644 --- a/test_regress/Makefile_obj +++ b/test_regress/Makefile_obj @@ -16,11 +16,13 @@ default: $(VM_PREFIX) ifneq ($(MAKE_MAIN),0) # Add main to classes rather then SP_SRCS to save a compiler run - VM_CLASSES += ${VM_PREFIX}__main + VM_CLASSES += ${VM_PREFIX}__main $(VM_USER_CLASSES) $(VM_GLOBAL_FAST) $(VM_GLOBAL_SLOW) endif include $(VM_PREFIX).mk +VPATH += ../../$(VM_USER_DIR) + ####################################################################### ifeq ($(VERILATOR_AUTHOR_SITE),1) diff --git a/test_regress/driver.pl b/test_regress/driver.pl index 3c95786f7..2dfd62be5 100755 --- a/test_regress/driver.pl +++ b/test_regress/driver.pl @@ -134,7 +134,7 @@ sub one_test { } else { $test->oprint("FAILED: ","*"x60,"\n"); push @fails, "\t#".$test->soprint("%Error: $test->{errors}\n"); - my $j = ($opt_jobs>1?" -j $opt_jobs":""); + my $j = ($opt_jobs>1?" -j":""); push @fails, "\t\tmake$j && test_regress/" .$test->{pl_filename}." ".join(' ',@Orig_ARGV_Sw)."\n"; $failcnt++; @@ -720,12 +720,12 @@ sub _make_main { my $VM_PREFIX = $self->{VM_PREFIX}; print $fh "#include \"$VM_PREFIX.h\"\n"; - print $fh "// Compile in-place for speed\n"; - print $fh "#include \"verilated.cpp\"\n"; + print $fh "// General headers\n"; + print $fh "#include \"verilated.h\"\n"; print $fh "#include \"systemc.h\"\n" if $self->sc; print $fh "#include \"systemperl.h\"\n" if $self->sp; - print $fh "#include \"SpTraceVcdC.cpp\"\n" if $self->{trace} && !$self->sp; - print $fh "#include \"Sp.cpp\"\n" if $self->sp; + print $fh "#include \"SpTraceVcdC.h\"\n" if $self->{trace} && !$self->sp; + print $fh "#include \"SpTraceVcd.h\"\n" if $self->{trace} && $self->sp; print $fh "$VM_PREFIX * topp;\n"; if (!$self->sc_or_sp) {