/* * yosys -- Yosys Open SYnthesis Suite * * Copyright (C) 2012 Claire Xenia Wolf * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * */ #include "kernel/yosys.h" #include "kernel/sigtools.h" #include "kernel/celltypes.h" #include "kernel/mem.h" #include "kernel/fstdata.h" #include "kernel/ff.h" #include USING_YOSYS_NAMESPACE PRIVATE_NAMESPACE_BEGIN enum class SimulationMode { sim, cmp, gold, gate, }; static const std::map g_units = { { "", -9 }, // default is ns { "s", 0 }, { "ms", -3 }, { "us", -6 }, { "ns", -9 }, { "ps", -12 }, { "fs", -15 }, { "as", -18 }, { "zs", -21 }, }; static double stringToTime(std::string str) { if (str=="END") return -1; char *endptr; long value = strtol(str.c_str(), &endptr, 10); if (g_units.find(endptr)==g_units.end()) log_error("Cannot parse '%s', bad unit '%s'\n", str.c_str(), endptr); if (value < 0) log_error("Time value '%s' must be positive\n", str.c_str()); return value * pow(10.0, g_units.at(endptr)); } struct SimWorker; struct OutputWriter { OutputWriter(SimWorker *w) { worker = w;}; virtual ~OutputWriter() {}; virtual void write(std::map &use_signal) = 0; SimWorker *worker; }; struct SimShared { bool debug = false; bool hide_internal = true; bool writeback = false; bool zinit = false; int rstlen = 1; FstData *fst = nullptr; double start_time = 0; double stop_time = -1; SimulationMode sim_mode = SimulationMode::sim; bool cycles_set = false; std::vector> outputfiles; std::vector>> output_data; bool ignore_x = false; }; void zinit(State &v) { if (v != State::S1) v = State::S0; } void zinit(Const &v) { for (auto &bit : v.bits) zinit(bit); } struct SimInstance { SimShared *shared; std::string scope; Module *module; Cell *instance; SimInstance *parent; dict children; SigMap sigmap; dict state_nets; dict> upd_cells; dict> upd_outports; pool dirty_bits; pool dirty_cells; pool dirty_memories; pool dirty_children; struct ff_state_t { Const past_d; Const past_ad; State past_clk; State past_ce; State past_srst; FfData data; }; struct mem_state_t { Mem *mem; std::vector past_wr_clk; std::vector past_wr_en; std::vector past_wr_addr; std::vector past_wr_data; Const data; }; dict ff_database; dict mem_database; pool formal_database; dict mem_cells; std::vector memories; dict> signal_database; dict fst_handles; SimInstance(SimShared *shared, std::string scope, Module *module, Cell *instance = nullptr, SimInstance *parent = nullptr) : shared(shared), scope(scope), module(module), instance(instance), parent(parent), sigmap(module) { log_assert(module); if (parent) { log_assert(parent->children.count(instance) == 0); parent->children[instance] = this; } for (auto wire : module->wires()) { SigSpec sig = sigmap(wire); for (int i = 0; i < GetSize(sig); i++) { if (state_nets.count(sig[i]) == 0) state_nets[sig[i]] = State::Sx; if (wire->port_output) { upd_outports[sig[i]].insert(wire); dirty_bits.insert(sig[i]); } } if ((shared->fst) && !(shared->hide_internal && wire->name[0] == '$')) { fstHandle id = shared->fst->getHandle(scope + "." + RTLIL::unescape_id(wire->name)); if (id==0 && wire->name.isPublic()) log_warning("Unable to found wire %s in input file.\n", (scope + "." + RTLIL::unescape_id(wire->name)).c_str()); fst_handles[wire] = id; } if (wire->attributes.count(ID::init)) { Const initval = wire->attributes.at(ID::init); for (int i = 0; i < GetSize(sig) && i < GetSize(initval); i++) if (initval[i] == State::S0 || initval[i] == State::S1) { state_nets[sig[i]] = initval[i]; dirty_bits.insert(sig[i]); } } } memories = Mem::get_all_memories(module); for (auto &mem : memories) { auto &mdb = mem_database[mem.memid]; mdb.mem = &mem; for (auto &port : mem.wr_ports) { mdb.past_wr_clk.push_back(Const(State::Sx)); mdb.past_wr_en.push_back(Const(State::Sx, GetSize(port.en))); mdb.past_wr_addr.push_back(Const(State::Sx, GetSize(port.addr))); mdb.past_wr_data.push_back(Const(State::Sx, GetSize(port.data))); } mdb.data = mem.get_init_data(); } for (auto cell : module->cells()) { Module *mod = module->design->module(cell->type); if (mod != nullptr) { dirty_children.insert(new SimInstance(shared, scope + "." + RTLIL::unescape_id(cell->name), mod, cell, this)); } for (auto &port : cell->connections()) { if (cell->input(port.first)) for (auto bit : sigmap(port.second)) { upd_cells[bit].insert(cell); // Make sure cell inputs connected to constants are updated in the first cycle if (bit.wire == nullptr) dirty_bits.insert(bit); } } if (RTLIL::builtin_ff_cell_types().count(cell->type)) { FfData ff_data(nullptr, cell); ff_state_t ff; ff.past_d = Const(State::Sx, ff_data.width); ff.past_ad = Const(State::Sx, ff_data.width); ff.past_clk = State::Sx; ff.past_ce = State::Sx; ff.past_srst = State::Sx; ff.data = ff_data; ff_database[cell] = ff; } if (cell->is_mem_cell()) { mem_cells[cell] = cell->parameters.at(ID::MEMID).decode_string(); } if (cell->type.in(ID($assert), ID($cover), ID($assume))) { formal_database.insert(cell); } } if (shared->zinit) { for (auto &it : ff_database) { ff_state_t &ff = it.second; zinit(ff.past_d); SigSpec qsig = it.second.data.sig_q; Const qdata = get_state(qsig); zinit(qdata); set_state(qsig, qdata); } for (auto &it : mem_database) { mem_state_t &mem = it.second; for (auto &val : mem.past_wr_en) zinit(val); zinit(mem.data); } } } ~SimInstance() { for (auto child : children) delete child.second; } IdString name() const { if (instance != nullptr) return instance->name; return module->name; } std::string hiername() const { if (instance != nullptr) return parent->hiername() + "." + log_id(instance->name); return log_id(module->name); } Const get_state(SigSpec sig) { Const value; for (auto bit : sigmap(sig)) if (bit.wire == nullptr) value.bits.push_back(bit.data); else if (state_nets.count(bit)) value.bits.push_back(state_nets.at(bit)); else value.bits.push_back(State::Sz); if (shared->debug) log("[%s] get %s: %s\n", hiername().c_str(), log_signal(sig), log_signal(value)); return value; } bool set_state(SigSpec sig, Const value) { bool did_something = false; sig = sigmap(sig); log_assert(GetSize(sig) <= GetSize(value)); for (int i = 0; i < GetSize(sig); i++) if (state_nets.at(sig[i]) != value[i]) { state_nets.at(sig[i]) = value[i]; dirty_bits.insert(sig[i]); did_something = true; } if (shared->debug) log("[%s] set %s: %s\n", hiername().c_str(), log_signal(sig), log_signal(value)); return did_something; } void update_cell(Cell *cell) { if (ff_database.count(cell)) return; if (formal_database.count(cell)) return; if (mem_cells.count(cell)) { dirty_memories.insert(mem_cells[cell]); return; } if (children.count(cell)) { auto child = children.at(cell); for (auto &conn: cell->connections()) if (cell->input(conn.first) && GetSize(conn.second)) { Const value = get_state(conn.second); child->set_state(child->module->wire(conn.first), value); } dirty_children.insert(child); return; } if (yosys_celltypes.cell_evaluable(cell->type)) { RTLIL::SigSpec sig_a, sig_b, sig_c, sig_d, sig_s, sig_y; bool has_a, has_b, has_c, has_d, has_s, has_y; has_a = cell->hasPort(ID::A); has_b = cell->hasPort(ID::B); has_c = cell->hasPort(ID::C); has_d = cell->hasPort(ID::D); has_s = cell->hasPort(ID::S); has_y = cell->hasPort(ID::Y); if (has_a) sig_a = cell->getPort(ID::A); if (has_b) sig_b = cell->getPort(ID::B); if (has_c) sig_c = cell->getPort(ID::C); if (has_d) sig_d = cell->getPort(ID::D); if (has_s) sig_s = cell->getPort(ID::S); if (has_y) sig_y = cell->getPort(ID::Y); if (shared->debug) log("[%s] eval %s (%s)\n", hiername().c_str(), log_id(cell), log_id(cell->type)); // Simple (A -> Y) and (A,B -> Y) cells if (has_a && !has_c && !has_d && !has_s && has_y) { set_state(sig_y, CellTypes::eval(cell, get_state(sig_a), get_state(sig_b))); return; } // (A,B,C -> Y) cells if (has_a && has_b && has_c && !has_d && !has_s && has_y) { set_state(sig_y, CellTypes::eval(cell, get_state(sig_a), get_state(sig_b), get_state(sig_c))); return; } // (A,S -> Y) cells if (has_a && !has_b && !has_c && !has_d && has_s && has_y) { set_state(sig_y, CellTypes::eval(cell, get_state(sig_a), get_state(sig_s))); return; } // (A,B,S -> Y) cells if (has_a && has_b && !has_c && !has_d && has_s && has_y) { set_state(sig_y, CellTypes::eval(cell, get_state(sig_a), get_state(sig_b), get_state(sig_s))); return; } log_warning("Unsupported evaluable cell type: %s (%s.%s)\n", log_id(cell->type), log_id(module), log_id(cell)); return; } log_error("Unsupported cell type: %s (%s.%s)\n", log_id(cell->type), log_id(module), log_id(cell)); } void update_memory(IdString id) { auto &mdb = mem_database[id]; auto &mem = *mdb.mem; for (int port_idx = 0; port_idx < GetSize(mem.rd_ports); port_idx++) { auto &port = mem.rd_ports[port_idx]; Const addr = get_state(port.addr); Const data = Const(State::Sx, mem.width << port.wide_log2); if (port.clk_enable) log_error("Memory %s.%s has clocked read ports. Run 'memory' with -nordff.\n", log_id(module), log_id(mem.memid)); if (addr.is_fully_def()) { int index = addr.as_int() - mem.start_offset; if (index >= 0 && index < mem.size) data = mdb.data.extract(index*mem.width, mem.width << port.wide_log2); } set_state(port.data, data); } } void update_ph1() { pool queue_cells; pool queue_outports; queue_cells.swap(dirty_cells); while (1) { for (auto bit : dirty_bits) { if (upd_cells.count(bit)) for (auto cell : upd_cells.at(bit)) queue_cells.insert(cell); if (upd_outports.count(bit) && parent != nullptr) for (auto wire : upd_outports.at(bit)) queue_outports.insert(wire); } dirty_bits.clear(); if (!queue_cells.empty()) { for (auto cell : queue_cells) update_cell(cell); queue_cells.clear(); continue; } for (auto &memid : dirty_memories) update_memory(memid); dirty_memories.clear(); for (auto wire : queue_outports) if (instance->hasPort(wire->name)) { Const value = get_state(wire); parent->set_state(instance->getPort(wire->name), value); } queue_outports.clear(); for (auto child : dirty_children) child->update_ph1(); dirty_children.clear(); if (dirty_bits.empty()) break; } } bool update_ph2() { bool did_something = false; for (auto &it : ff_database) { ff_state_t &ff = it.second; FfData &ff_data = ff.data; Const current_q = get_state(ff.data.sig_q); if (ff_data.has_clk) { // flip-flops State current_clk = get_state(ff_data.sig_clk)[0]; if (ff_data.pol_clk ? (ff.past_clk == State::S0 && current_clk != State::S0) : (ff.past_clk == State::S1 && current_clk != State::S1)) { bool ce = ff.past_ce == (ff_data.pol_ce ? State::S1 : State::S0); // set if no ce, or ce is enabled if (!ff_data.has_ce || (ff_data.has_ce && ce)) { current_q = ff.past_d; } // override if sync reset if ((ff_data.has_srst) && (ff.past_srst == (ff_data.pol_srst ? State::S1 : State::S0)) && ((!ff_data.ce_over_srst) || (ff_data.ce_over_srst && ce))) { current_q = ff_data.val_srst; } } } // async load if (ff_data.has_aload) { State current_aload = get_state(ff_data.sig_aload)[0]; if (current_aload == (ff_data.pol_aload ? State::S1 : State::S0)) { current_q = ff_data.has_clk ? ff.past_ad : get_state(ff.data.sig_ad); } } // async reset if (ff_data.has_arst) { State current_arst = get_state(ff_data.sig_arst)[0]; if (current_arst == (ff_data.pol_arst ? State::S1 : State::S0)) { current_q = ff_data.val_arst; } } // handle set/reset if (ff.data.has_sr) { Const current_clr = get_state(ff.data.sig_clr); Const current_set = get_state(ff.data.sig_set); for(int i=0;i= 0 && index < mem.size) for (int i = 0; i < (mem.width << port.wide_log2); i++) if (enable[i] == State::S1 && mdb.data.bits.at(index*mem.width+i) != data[i]) { mdb.data.bits.at(index*mem.width+i) = data[i]; dirty_memories.insert(mem.memid); did_something = true; } } } } for (auto it : children) if (it.second->update_ph2()) { dirty_children.insert(it.second); did_something = true; } return did_something; } void update_ph3() { for (auto &it : ff_database) { ff_state_t &ff = it.second; if (ff.data.has_aload) ff.past_ad = get_state(ff.data.sig_ad); if (ff.data.has_clk || ff.data.has_gclk) ff.past_d = get_state(ff.data.sig_d); if (ff.data.has_clk) ff.past_clk = get_state(ff.data.sig_clk)[0]; if (ff.data.has_ce) ff.past_ce = get_state(ff.data.sig_ce)[0]; if (ff.data.has_srst) ff.past_srst = get_state(ff.data.sig_srst)[0]; } for (auto &it : mem_database) { mem_state_t &mem = it.second; for (int i = 0; i < GetSize(mem.mem->wr_ports); i++) { auto &port = mem.mem->wr_ports[i]; mem.past_wr_clk[i] = get_state(port.clk); mem.past_wr_en[i] = get_state(port.en); mem.past_wr_addr[i] = get_state(port.addr); mem.past_wr_data[i] = get_state(port.data); } } for (auto cell : formal_database) { string label = log_id(cell); if (cell->attributes.count(ID::src)) label = cell->attributes.at(ID::src).decode_string(); State a = get_state(cell->getPort(ID::A))[0]; State en = get_state(cell->getPort(ID::EN))[0]; if (cell->type == ID($cover) && en == State::S1 && a != State::S1) log("Cover %s.%s (%s) reached.\n", hiername().c_str(), log_id(cell), label.c_str()); if (cell->type == ID($assume) && en == State::S1 && a != State::S1) log("Assumption %s.%s (%s) failed.\n", hiername().c_str(), log_id(cell), label.c_str()); if (cell->type == ID($assert) && en == State::S1 && a != State::S1) log_warning("Assert %s.%s (%s) failed.\n", hiername().c_str(), log_id(cell), label.c_str()); } for (auto it : children) it.second->update_ph3(); } void writeback(pool &wbmods) { if (wbmods.count(module)) log_error("Instance %s of module %s is not unique: Writeback not possible. (Fix by running 'uniquify'.)\n", hiername().c_str(), log_id(module)); wbmods.insert(module); for (auto wire : module->wires()) wire->attributes.erase(ID::init); for (auto &it : ff_database) { SigSpec sig_q = it.second.data.sig_q; Const initval = get_state(sig_q); for (int i = 0; i < GetSize(sig_q); i++) { Wire *w = sig_q[i].wire; if (w->attributes.count(ID::init) == 0) w->attributes[ID::init] = Const(State::Sx, GetSize(w)); w->attributes[ID::init][sig_q[i].offset] = initval[i]; } } for (auto &it : mem_database) { mem_state_t &mem = it.second; mem.mem->clear_inits(); MemInit minit; minit.addr = mem.mem->start_offset; minit.data = mem.data; minit.en = Const(State::S1, mem.mem->width); mem.mem->inits.push_back(minit); mem.mem->emit(); } for (auto it : children) it.second->writeback(wbmods); } void register_signals(int &id) { for (auto wire : module->wires()) { if (shared->hide_internal && wire->name[0] == '$') continue; signal_database[wire] = make_pair(id, Const()); id++; } for (auto child : children) child.second->register_signals(id); } void write_output_header(std::function enter_scope, std::function exit_scope, std::function register_signal) { enter_scope(name()); for (auto signal : signal_database) { register_signal(signal.first, signal.second.first); } for (auto child : children) child.second->write_output_header(enter_scope, exit_scope, register_signal); exit_scope(); } void register_output_step_values(std::map *data) { for (auto &it : signal_database) { Wire *wire = it.first; Const value = get_state(wire); int id = it.second.first; if (it.second.second == value) continue; it.second.second = value; data->emplace(id, value); } for (auto child : children) child.second->register_output_step_values(data); } void setInitState() { for (auto &it : ff_database) { SigSpec qsig = it.second.data.sig_q; if (qsig.is_wire()) { IdString name = qsig.as_wire()->name; fstHandle id = shared->fst->getHandle(scope + "." + RTLIL::unescape_id(name)); if (id==0 && name.isPublic()) log_warning("Unable to found wire %s in input file.\n", (scope + "." + RTLIL::unescape_id(name)).c_str()); if (id!=0) { Const fst_val = Const::from_string(shared->fst->valueOf(id)); set_state(qsig, fst_val); } } } for (auto child : children) child.second->setInitState(); } void setState(dict> bits, std::string values) { for(auto bit : bits) { if (bit.first >= GetSize(values)) log_error("Too few input data bits in file.\n"); switch(values.at(bit.first)) { case '0': set_state(bit.second.first, bit.second.second ? State::S1 : State::S0); break; case '1': set_state(bit.second.first, bit.second.second ? State::S0 : State::S1); break; default: set_state(bit.second.first, State::Sx); break; } } } bool checkSignals() { bool retVal = false; for(auto &item : fst_handles) { if (item.second==0) continue; // Ignore signals not found Const fst_val = Const::from_string(shared->fst->valueOf(item.second)); Const sim_val = get_state(item.first); if (sim_val.size()!=fst_val.size()) log_error("Signal '%s' size is different in gold and gate.\n", log_id(item.first)); if (shared->sim_mode == SimulationMode::sim) { // No checks performed when using stimulus } else if (shared->sim_mode == SimulationMode::gate && !fst_val.is_fully_def()) { // FST data contains X for(int i=0;isim_mode == SimulationMode::gold && !sim_val.is_fully_def()) { // sim data contains X for(int i=0;icheckSignals(); return retVal; } }; struct SimWorker : SimShared { SimInstance *top = nullptr; pool clock, clockn, reset, resetn; std::string timescale; std::string sim_filename; std::string map_filename; std::string scope; ~SimWorker() { outputfiles.clear(); delete top; } void register_signals() { int id = 1; top->register_signals(id); } void register_output_step(int t) { std::map data; top->register_output_step_values(&data); output_data.emplace_back(t, data); } void write_output_files() { std::map use_signal; bool first = ignore_x; for(auto& d : output_data) { if (first) { for (auto &data : d.second) use_signal[data.first] = !data.second.is_fully_undef(); first = false; } else { for (auto &data : d.second) use_signal[data.first] = true; } if (!ignore_x) break; } for(auto& writer : outputfiles) writer->write(use_signal); } void update() { while (1) { if (debug) log("\n-- ph1 --\n"); top->update_ph1(); if (debug) log("\n-- ph2 --\n"); if (!top->update_ph2()) break; } if (debug) log("\n-- ph3 --\n"); top->update_ph3(); } void set_inports(pool ports, State value) { for (auto portname : ports) { Wire *w = top->module->wire(portname); if (w == nullptr) log_error("Can't find port %s on module %s.\n", log_id(portname), log_id(top->module)); top->set_state(w, value); } } void run(Module *topmod, int numcycles) { log_assert(top == nullptr); top = new SimInstance(this, scope, topmod); register_signals(); if (debug) log("\n===== 0 =====\n"); else log("Simulating cycle 0.\n"); set_inports(reset, State::S1); set_inports(resetn, State::S0); set_inports(clock, State::Sx); set_inports(clockn, State::Sx); update(); register_output_step(0); for (int cycle = 0; cycle < numcycles; cycle++) { if (debug) log("\n===== %d =====\n", 10*cycle + 5); else log("Simulating cycle %d.\n", (cycle*2)+1); set_inports(clock, State::S0); set_inports(clockn, State::S1); update(); register_output_step(10*cycle + 5); if (debug) log("\n===== %d =====\n", 10*cycle + 10); else log("Simulating cycle %d.\n", (cycle*2)+2); set_inports(clock, State::S1); set_inports(clockn, State::S0); if (cycle+1 == rstlen) { set_inports(reset, State::S0); set_inports(resetn, State::S1); } update(); register_output_step(10*cycle + 10); } register_output_step(10*numcycles + 2); write_output_files(); if (writeback) { pool wbmods; top->writeback(wbmods); } } void run_cosim_fst(Module *topmod, int numcycles) { log_assert(top == nullptr); fst = new FstData(sim_filename); if (scope.empty()) log_error("Scope must be defined for co-simulation.\n"); top = new SimInstance(this, scope, topmod); register_signals(); std::vector fst_clock; for (auto portname : clock) { Wire *w = topmod->wire(portname); if (!w) log_error("Can't find port %s on module %s.\n", log_id(portname), log_id(top->module)); if (!w->port_input) log_error("Clock port %s on module %s is not input.\n", log_id(portname), log_id(top->module)); fstHandle id = fst->getHandle(scope + "." + RTLIL::unescape_id(portname)); if (id==0) log_error("Can't find port %s.%s in FST.\n", scope.c_str(), log_id(portname)); fst_clock.push_back(id); } for (auto portname : clockn) { Wire *w = topmod->wire(portname); if (!w) log_error("Can't find port %s on module %s.\n", log_id(portname), log_id(top->module)); if (!w->port_input) log_error("Clock port %s on module %s is not input.\n", log_id(portname), log_id(top->module)); fstHandle id = fst->getHandle(scope + "." + RTLIL::unescape_id(portname)); if (id==0) log_error("Can't find port %s.%s in FST.\n", scope.c_str(), log_id(portname)); fst_clock.push_back(id); } SigMap sigmap(topmod); std::map inputs; for (auto wire : topmod->wires()) { if (wire->port_input) { fstHandle id = fst->getHandle(scope + "." + RTLIL::unescape_id(wire->name)); if (id==0) log_error("Unable to find required '%s' signal in file\n",(scope + "." + RTLIL::unescape_id(wire->name)).c_str()); inputs[wire] = id; } } uint64_t startCount = 0; uint64_t stopCount = 0; if (start_time==0) { if (start_time < fst->getStartTime()) log_warning("Start time is before simulation file start time\n"); startCount = fst->getStartTime(); } else if (start_time==-1) startCount = fst->getEndTime(); else { startCount = start_time / fst->getTimescale(); if (startCount > fst->getEndTime()) { startCount = fst->getEndTime(); log_warning("Start time is after simulation file end time\n"); } } if (stop_time==0) { if (stop_time < fst->getStartTime()) log_warning("Stop time is before simulation file start time\n"); stopCount = fst->getStartTime(); } else if (stop_time==-1) stopCount = fst->getEndTime(); else { stopCount = stop_time / fst->getTimescale(); if (stopCount > fst->getEndTime()) { stopCount = fst->getEndTime(); log_warning("Stop time is after simulation file end time\n"); } } if (stopCountgetTimescaleString(), (unsigned long)stopCount, fst->getTimescaleString()); if (cycles_set) log(" for %d clock cycle(s)",numcycles); log("\n"); bool all_samples = fst_clock.empty(); try { fst->reconstructAllAtTimes(fst_clock, startCount, stopCount, [&](uint64_t time) { log("Co-simulating %s %d [%lu%s].\n", (all_samples ? "sample" : "cycle"), cycle, (unsigned long)time, fst->getTimescaleString()); bool did_something = false; for(auto &item : inputs) { std::string v = fst->valueOf(item.second); did_something |= top->set_state(item.first, Const::from_string(v)); } if (initial) { top->setInitState(); initial = false; } if (did_something) update(); register_output_step(time); bool status = top->checkSignals(); if (status) log_error("Signal difference\n"); cycle++; // Limit to number of cycles if provided if (cycles_set && cycle > numcycles *2) throw fst_end_of_data_exception(); if (time==stopCount) throw fst_end_of_data_exception(); }); } catch(fst_end_of_data_exception) { // end of data detected } write_output_files(); if (writeback) { pool wbmods; top->writeback(wbmods); } delete fst; } void run_cosim_aiger_witness(Module *topmod) { log_assert(top == nullptr); std::ifstream mf(map_filename); std::string type, symbol; int variable, index; dict> inputs, inits, latches; if (mf.fail()) log_cmd_error("Not able to read AIGER witness map file.\n"); while (mf >> type >> variable >> index >> symbol) { RTLIL::IdString escaped_s = RTLIL::escape_id(symbol); Wire *w = topmod->wire(escaped_s); if (!w) log_error("Wire %s not present in module %s\n",log_signal(w),log_id(topmod)); if (index < w->start_offset || index > w->start_offset + w->width) log_error("Index %d for wire %s is out of range\n", index, log_signal(w)); if (type == "input") { inputs[variable] = {SigBit(w,index), false}; } else if (type == "init") { inits[variable] = {SigBit(w,index), false}; } else if (type == "latch") { latches[variable] = {SigBit(w,index), false}; } else if (type == "invlatch") { latches[variable] = {SigBit(w,index), true}; } } std::ifstream f; f.open(sim_filename.c_str()); if (f.fail() || GetSize(sim_filename) == 0) log_error("Can not open file `%s`\n", sim_filename.c_str()); int state = 0; std::string status; int cycle = 0; top = new SimInstance(this, scope, topmod); register_signals(); while (!f.eof()) { std::string line; std::getline(f, line); if (line.size()==0 || line[0]=='#') continue; if (line[0]=='.') break; if (state==0 && line.size()!=1) { // old format detected, latch data state = 2; } if (state==1 && line[0]!='b' && line[0]!='c') { // was old format but with 1 bit latch top->setState(latches, status); state = 3; } switch(state) { case 0: status = line; state = 1; break; case 1: state = 2; break; case 2: top->setState(latches, line); state = 3; break; default: log("Simulating cycle %d.\n", cycle); top->setState(inputs, line); if (cycle) { set_inports(clock, State::S1); set_inports(clockn, State::S0); } else { top->setState(inits, line); set_inports(clock, State::S0); set_inports(clockn, State::S1); } update(); register_output_step(10*cycle); if (cycle) { set_inports(clock, State::S0); set_inports(clockn, State::S1); update(); register_output_step(10*cycle + 5); } cycle++; break; } } register_output_step(10*cycle); write_output_files(); } std::vector split(std::string text, const char *delim) { std::vector list; char *p = strdup(text.c_str()); char *t = strtok(p, delim); while (t != NULL) { list.push_back(t); t = strtok(NULL, delim); } free(p); return list; } std::string signal_name(std::string const & name) { size_t pos = name.find_first_of("@"); if (pos==std::string::npos) { pos = name.find_first_of("#"); if (pos==std::string::npos) log_error("Line does not contain proper signal name `%s`\n", name.c_str()); } return name.substr(0, pos); } void run_cosim_btor2_witness(Module *topmod) { log_assert(top == nullptr); std::ifstream f; f.open(sim_filename.c_str()); if (f.fail() || GetSize(sim_filename) == 0) log_error("Can not open file `%s`\n", sim_filename.c_str()); int state = 0; int cycle = 0; top = new SimInstance(this, scope, topmod); register_signals(); int prev_cycle = 0; int curr_cycle = 0; std::vector parts; while (!f.eof()) { std::string line; std::getline(f, line); if (line.size()==0) continue; if (line[0]=='#' || line[0]=='@' || line[0]=='.') { if (line[0]!='.') curr_cycle = atoi(line.c_str()+1); else curr_cycle = -1; // force detect change if (curr_cycle != prev_cycle) { log("Simulating cycle %d.\n", cycle); set_inports(clock, State::S1); set_inports(clockn, State::S0); update(); register_output_step(10*cycle+0); set_inports(clock, State::S0); set_inports(clockn, State::S1); update(); register_output_step(10*cycle+5); cycle++; prev_cycle = curr_cycle; } if (line[0]=='.') break; continue; } switch(state) { case 0: if (line=="sat") state = 1; break; case 1: if (line[0]=='b' || line[0]=='j') state = 2; else log_error("Line does not contain property.\n"); break; default: // set state or inputs parts = split(line, " "); if (parts.size()!=3) log_error("Invalid set state line content.\n"); RTLIL::IdString escaped_s = RTLIL::escape_id(signal_name(parts[2])); Wire *w = topmod->wire(escaped_s); if (!w) log_error("Wire %s not present in module %s\n",log_id(escaped_s),log_id(topmod)); if ((int)parts[1].size() != w->width) log_error("Size of wire %s is different than provided data.\n", log_signal(w)); top->set_state(w, Const(parts[1])); break; } } register_output_step(10*cycle); write_output_files(); } }; struct VCDWriter : public OutputWriter { VCDWriter(SimWorker *worker, std::string filename) : OutputWriter(worker) { vcdfile.open(filename.c_str()); } void write(std::map &use_signal) override { if (!vcdfile.is_open()) return; vcdfile << stringf("$version %s $end\n", yosys_version_str); std::time_t t = std::time(nullptr); char mbstr[255]; if (std::strftime(mbstr, sizeof(mbstr), "%c", std::localtime(&t))) { vcdfile << stringf("$date ") << mbstr << stringf(" $end\n"); } if (!worker->timescale.empty()) vcdfile << stringf("$timescale %s $end\n", worker->timescale.c_str()); worker->top->write_output_header( [this](IdString name) { vcdfile << stringf("$scope module %s $end\n", log_id(name)); }, [this]() { vcdfile << stringf("$upscope $end\n");}, [this,use_signal](Wire *wire, int id) { if (use_signal.at(id)) vcdfile << stringf("$var wire %d n%d %s%s $end\n", GetSize(wire), id, wire->name[0] == '$' ? "\\" : "", log_id(wire)); } ); vcdfile << stringf("$enddefinitions $end\n"); for(auto& d : worker->output_data) { vcdfile << stringf("#%d\n", d.first); for (auto &data : d.second) { if (!use_signal.at(data.first)) continue; Const value = data.second; vcdfile << "b"; for (int i = GetSize(value)-1; i >= 0; i--) { switch (value[i]) { case State::S0: vcdfile << "0"; break; case State::S1: vcdfile << "1"; break; case State::Sx: vcdfile << "x"; break; default: vcdfile << "z"; } } vcdfile << stringf(" n%d\n", data.first); } } } std::ofstream vcdfile; }; struct FSTWriter : public OutputWriter { FSTWriter(SimWorker *worker, std::string filename) : OutputWriter(worker) { fstfile = (struct fstContext *)fstWriterCreate(filename.c_str(),1); } virtual ~FSTWriter() { fstWriterClose(fstfile); } void write(std::map &use_signal) override { if (!fstfile) return; std::time_t t = std::time(nullptr); fstWriterSetDate(fstfile, asctime(std::localtime(&t))); fstWriterSetVersion(fstfile, yosys_version_str); if (!worker->timescale.empty()) fstWriterSetTimescaleFromString(fstfile, worker->timescale.c_str()); fstWriterSetPackType(fstfile, FST_WR_PT_FASTLZ); fstWriterSetRepackOnClose(fstfile, 1); worker->top->write_output_header( [this](IdString name) { fstWriterSetScope(fstfile, FST_ST_VCD_MODULE, stringf("%s",log_id(name)).c_str(), nullptr); }, [this]() { fstWriterSetUpscope(fstfile); }, [this,use_signal](Wire *wire, int id) { if (!use_signal.at(id)) return; fstHandle fst_id = fstWriterCreateVar(fstfile, FST_VT_VCD_WIRE, FST_VD_IMPLICIT, GetSize(wire), stringf("%s%s", wire->name[0] == '$' ? "\\" : "", log_id(wire)).c_str(), 0); mapping.emplace(id, fst_id); } ); for(auto& d : worker->output_data) { fstWriterEmitTimeChange(fstfile, d.first); for (auto &data : d.second) { if (!use_signal.at(data.first)) continue; Const value = data.second; std::stringstream ss; for (int i = GetSize(value)-1; i >= 0; i--) { switch (value[i]) { case State::S0: ss << "0"; break; case State::S1: ss << "1"; break; case State::Sx: ss << "x"; break; default: ss << "z"; } } fstWriterEmitValueChange(fstfile, mapping[data.first], ss.str().c_str()); } } } struct fstContext *fstfile = nullptr; std::map mapping; }; struct AIWWriter : public OutputWriter { AIWWriter(SimWorker *worker, std::string filename) : OutputWriter(worker) { aiwfile.open(filename.c_str()); } virtual ~AIWWriter() { aiwfile << '.' << '\n'; } void write(std::map &) override { if (!aiwfile.is_open()) return; if (worker->map_filename.empty()) log_cmd_error("For AIGER witness file map parameter is mandatory.\n"); std::ifstream mf(worker->map_filename); std::string type, symbol; int variable, index; if (mf.fail()) log_cmd_error("Not able to read AIGER witness map file.\n"); while (mf >> type >> variable >> index >> symbol) { RTLIL::IdString escaped_s = RTLIL::escape_id(symbol); Wire *w = worker->top->module->wire(escaped_s); if (!w) log_error("Wire %s not present in module %s\n",log_id(escaped_s),log_id(worker->top->module)); if (index < w->start_offset || index > w->start_offset + w->width) log_error("Index %d for wire %s is out of range\n", index, log_signal(w)); if (type == "input") { aiw_inputs[variable] = SigBit(w,index); } else if (type == "init") { aiw_inits[variable] = SigBit(w,index); } else if (type == "latch") { aiw_latches[variable] = {SigBit(w,index), false}; } else if (type == "invlatch") { aiw_latches[variable] = {SigBit(w,index), true}; } } worker->top->write_output_header( [](IdString) {}, []() {}, [this](Wire *wire, int id) { mapping[wire] = id; } ); std::map current; bool first = true; for(auto& d : worker->output_data) { for (auto &data : d.second) { current[data.first] = data.second; } if (first) { for (int i = 0;; i++) { if (aiw_latches.count(i)) { SigBit bit = aiw_latches.at(i).first; auto v = current[mapping[bit.wire]].bits.at(bit.offset); if (v == State::S1) aiwfile << (aiw_latches.at(i).second ? '0' : '1'); else aiwfile << (aiw_latches.at(i).second ? '1' : '0'); continue; } aiwfile << '\n'; break; } first = false; } for (int i = 0;; i++) { if (aiw_inputs.count(i)) { SigBit bit = aiw_inputs.at(i); auto v = current[mapping[bit.wire]].bits.at(bit.offset); if (v == State::S1) aiwfile << '1'; else aiwfile << '0'; continue; } if (aiw_inits.count(i)) { SigBit bit = aiw_inits.at(i); auto v = current[mapping[bit.wire]].bits.at(bit.offset); if (v == State::S1) aiwfile << '1'; else aiwfile << '0'; continue; } aiwfile << '\n'; break; } } } std::ofstream aiwfile; dict> aiw_latches; dict aiw_inputs, aiw_inits; std::map mapping; }; struct SimPass : public Pass { SimPass() : Pass("sim", "simulate the circuit") { } void help() override { // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---| log("\n"); log(" sim [options] [top-level]\n"); log("\n"); log("This command simulates the circuit using the given top-level module.\n"); log("\n"); log(" -vcd \n"); log(" write the simulation results to the given VCD file\n"); log("\n"); log(" -fst \n"); log(" write the simulation results to the given FST file\n"); log("\n"); log(" -aiw \n"); log(" write the simulation results to an AIGER witness file\n"); log(" (requires a *.aim file via -map)\n"); log("\n"); log(" -x\n"); log(" ignore constant x outputs in simulation file.\n"); log("\n"); log(" -clock \n"); log(" name of top-level clock input\n"); log("\n"); log(" -clockn \n"); log(" name of top-level clock input (inverse polarity)\n"); log("\n"); log(" -reset \n"); log(" name of top-level reset input (active high)\n"); log("\n"); log(" -resetn \n"); log(" name of top-level inverted reset input (active low)\n"); log("\n"); log(" -rstlen \n"); log(" number of cycles reset should stay active (default: 1)\n"); log("\n"); log(" -zinit\n"); log(" zero-initialize all uninitialized regs and memories\n"); log("\n"); log(" -timescale \n"); log(" include the specified timescale declaration in the vcd\n"); log("\n"); log(" -n \n"); log(" number of clock cycles to simulate (default: 20)\n"); log("\n"); log(" -a\n"); log(" use all nets in VCD/FST operations, not just those with public names\n"); log("\n"); log(" -w\n"); log(" writeback mode: use final simulation state as new init state\n"); log("\n"); log(" -r\n"); log(" read simulation results file (file formats supported: FST)\n"); log("\n"); log(" -map \n"); log(" read file with port and latch symbols, needed for AIGER witness input\n"); log("\n"); log(" -scope\n"); log(" scope of simulation top model\n"); log("\n"); log(" -at