Skip to content

Verilog: multiple top-level modules #1807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kroening wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Verilog: multiple top-level modules #1807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 73 additions & 41 deletions src/verilog/verilog_ebmc_language.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ void verilog_ebmc_languaget::typecheck_module(

transition_systemt verilog_ebmc_languaget::typecheck(
const parse_treest &parse_trees,
irep_idt top_level_module,
const std::vector<irep_idt> top_level_modules,
symbol_tablet &&symbol_table)
{
std::map<irep_idt, modulet> module_map;
Expand All @@ -198,13 +198,17 @@ transition_systemt verilog_ebmc_languaget::typecheck(
}
}

// now type check the top-level module
auto m_it = module_map.find(verilog_module_symbol(top_level_module));
CHECK_RETURN(m_it != module_map.end());

// now type check the given top-level modules
transition_systemt transition_system;
transition_system.symbol_table = std::move(symbol_table);
typecheck_module(m_it->second, transition_system.symbol_table);

for(auto top_level_module : top_level_modules)
{
auto m_it = module_map.find(verilog_module_symbol(top_level_module));
CHECK_RETURN(m_it != module_map.end());

typecheck_module(m_it->second, transition_system.symbol_table);
}

return transition_system;
}
Expand Down Expand Up @@ -244,8 +248,10 @@ static void module_dependencies(
module_dependencies_rec(item, action);
}

irep_idt
verilog_ebmc_languaget::top_level_module(const parse_treest &parse_trees) const
/// Determine the set of top-level modules following 1800 2017 23.3.1,
/// given via their base names. Sorted alphabetically.
std::vector<irep_idt>
verilog_ebmc_languaget::top_level_modules(const parse_treest &parse_trees) const
{
// start with a set of all modules, from all the files
std::set<irep_idt> all_modules;
Expand All @@ -260,29 +266,47 @@ verilog_ebmc_languaget::top_level_module(const parse_treest &parse_trees) const
}
}

// Did the user specify one?
irep_idt given_module;
// Did the user specify a set of top level modules?
std::vector<irep_idt> given_modules;

if(cmdline.isset("module"))
given_module = cmdline.get_value("module");
{
for(auto &value : cmdline.get_values("module"))
given_modules.push_back(value);
}
else if(cmdline.isset("top"))
given_module = cmdline.get_value("top");
{
for(auto &value : cmdline.get_values("top"))
given_modules.push_back(value);
}

if(given_module != irep_idt{})
if(!given_modules.empty())
{
if(all_modules.find(given_module) == all_modules.end())
// first check that all the given modules exist
for(const auto &given_module : given_modules)
{
messaget log{message_handler};
log.error() << "module '" << given_module << "' not found"
<< messaget::eom;
throw ebmc_errort{}.with_exit_code(2);
if(all_modules.find(given_module) == all_modules.end())
{
messaget log{message_handler};
log.error() << "module '" << given_module << "' not found"
<< messaget::eom;
throw ebmc_errort{}.with_exit_code(2);
}
}
else
return given_module; // done

// now sort alphabetically
std::sort(
given_modules.begin(),
given_modules.end(),
[](const irep_idt &a, const irep_idt &b)
{ return id2string(a) < id2string(b); });

return given_modules; // done
}

// start with all modules, and then erase the ones that are
// used as a dependency
// No modules given. Find all modules that are not used
// as a submodule. Start with all modules, and then erase
// the ones that are used as a submodule.
std::set<irep_idt> top_level_modules = all_modules;

for(auto &parse_tree : parse_trees)
Expand All @@ -304,33 +328,41 @@ verilog_ebmc_languaget::top_level_module(const parse_treest &parse_trees) const
log.error() << "no module found" << messaget::eom;
throw ebmc_errort{}.with_exit_code(1);
}
else if(top_level_modules.size() >= 2)
{
// sorted alphabetically
std::set<std::string> modules;

for(const auto &base_name : top_level_modules)
modules.insert(id2string(base_name));
// sort alphabetically into a vector
std::vector<irep_idt> result;

for(auto &module : top_level_modules)
result.push_back(module);

std::sort(
result.begin(),
result.end(),
[](const irep_idt &a, const irep_idt &b)
{ return id2string(a) < id2string(b); });

return result; // done
}

static bool get_main(
const std::vector<irep_idt> top_level_modules,
message_handlert &message_handler,
transition_systemt &transition_system)
{
if(top_level_modules.size() >= 2)
{
messaget log{message_handler};
log.error() << "multiple modules found, please select one:\n";

for(const auto &module : modules)
for(const auto &module : top_level_modules)
log.error() << " " << module << '\n';

log.error() << messaget::eom;
throw ebmc_errort{}.with_exit_code(1);
}

// we have exactly one top-level module
return *top_level_modules.begin();
}
auto top_level_module = top_level_modules.front();

static bool get_main(
irep_idt top_level_module,
message_handlert &message_handler,
transition_systemt &transition_system)
{
try
{
auto identifier = verilog_module_symbol(top_level_module);
Expand Down Expand Up @@ -448,9 +480,9 @@ std::optional<transition_systemt> verilog_ebmc_languaget::transition_system()
symbol_tablet symbol_table = elaborate_compilation_units(parse_trees);

//
// determine the top-level module
// determine the top-level modules
//
auto top_level_module = this->top_level_module(parse_trees);
auto top_level_modules = this->top_level_modules(parse_trees);

//
// type checking
Expand All @@ -459,15 +491,15 @@ std::optional<transition_systemt> verilog_ebmc_languaget::transition_system()
message.status() << "Converting" << messaget::eom;

auto transition_system =
typecheck(parse_trees, top_level_module, std::move(symbol_table));
typecheck(parse_trees, top_level_modules, std::move(symbol_table));

if(cmdline.isset("show-symbol-table"))
{
std::cout << transition_system.symbol_table;
return {};
}

if(get_main(top_level_module, message_handler, transition_system))
if(get_main(top_level_modules, message_handler, transition_system))
throw ebmc_errort{}.with_exit_code(1);

if(cmdline.isset("show-module-hierarchy"))
Expand Down
10 changes: 6 additions & 4 deletions src/verilog/verilog_ebmc_language.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ class verilog_ebmc_languaget : public ebmc_languaget

void copy_parse_tree(const parse_treet &, symbol_tablet &);

// base_name of the top-level module
irep_idt top_level_module(const parse_treest &) const;
// base_names of the top-level modules, alphabetical order
std::vector<irep_idt> top_level_modules(const parse_treest &) const;

class modulet
{
Expand All @@ -66,8 +66,10 @@ class verilog_ebmc_languaget : public ebmc_languaget
};

symbol_tablet elaborate_compilation_units(const parse_treest &);
transition_systemt
typecheck(const parse_treest &, irep_idt top_level_module, symbol_tablet &&);
transition_systemt typecheck(
const parse_treest &,
const std::vector<irep_idt> top_level_modules,
symbol_tablet &&);
void typecheck_module(modulet &, symbol_tablet &);
};

Expand Down
Loading