From 3bb9a7df01a03a31be87da719e0ee4bd4c38d5fd Mon Sep 17 00:00:00 2001 From: Miodrag Milanovic Date: Sun, 5 Aug 2018 16:13:34 +0200 Subject: Added command parser and common implementation --- ice40/main.cc | 466 ++++++++++++++-------------------------------------------- 1 file changed, 111 insertions(+), 355 deletions(-) (limited to 'ice40') diff --git a/ice40/main.cc b/ice40/main.cc index 358bf3c5..a98ca07e 100644 --- a/ice40/main.cc +++ b/ice40/main.cc @@ -2,6 +2,7 @@ * nextpnr -- Next Generation Place and Route * * Copyright (C) 2018 Clifford Wolf + * Copyright (C) 2018 Miodrag Milanovic * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -19,390 +20,145 @@ #ifdef MAIN_EXECUTABLE -#ifndef NO_GUI -#include -#include "application.h" -#include "mainwindow.h" -#endif -#ifndef NO_PYTHON -#include "pybindings.h" -#endif - -#include -#include -#include -#include #include -#include #include "bitstream.h" +#include "command.h" #include "design_utils.h" #include "jsonparse.h" #include "log.h" -#include "nextpnr.h" #include "pcf.h" #include "timing.h" -#include "version.h" USING_NEXTPNR_NAMESPACE -void conflicting_options(const boost::program_options::variables_map &vm, const char *opt1, const char *opt2) +class Ice40CommandHandler : public CommandHandler { - if (vm.count(opt1) && !vm[opt1].defaulted() && vm.count(opt2) && !vm[opt2].defaulted()) { - std::string msg = "Conflicting options '" + std::string(opt1) + "' and '" + std::string(opt1) + "'."; - log_error("%s\n", msg.c_str()); - } -} - -int main(int argc, char *argv[]) + public: + Ice40CommandHandler(int argc, char **argv); + virtual ~Ice40CommandHandler(){}; + std::unique_ptr createContext() override; + void setupArchContext(Context *ctx) override; + void validate() override; + void customAfterLoad(Context *ctx) override; + void customBitstream(Context *ctx) override; + + protected: + po::options_description getArchOptions(); +}; + +Ice40CommandHandler::Ice40CommandHandler(int argc, char **argv) : CommandHandler(argc, argv) {} + +po::options_description Ice40CommandHandler::getArchOptions() { - try { - namespace po = boost::program_options; - namespace pt = boost::property_tree; - int rc = 0; - std::string str; - - log_files.push_back(stdout); - - po::options_description options("Allowed options"); - options.add_options()("help,h", "show help"); - options.add_options()("verbose,v", "verbose output"); - options.add_options()("debug", "debug output"); - options.add_options()("force,f", "keep running after errors"); -#ifndef NO_GUI - options.add_options()("gui", "start gui"); -#endif - options.add_options()("pack-only", "pack design only without placement or routing"); - - po::positional_options_description pos; -#ifndef NO_PYTHON - options.add_options()("run", po::value>(), "python file to execute"); - pos.add("run", -1); -#endif - options.add_options()("json", po::value(), "JSON design file to ingest"); - options.add_options()("pcf", po::value(), "PCF constraints file to ingest"); - options.add_options()("asc", po::value(), "asc bitstream file to write"); - options.add_options()("read", po::value(), "asc bitstream file to read"); - options.add_options()("seed", po::value(), "seed value for random number generator"); - options.add_options()("slack_redist_iter", po::value(), - "number of iterations between slack redistribution"); - options.add_options()("cstrweight", po::value(), - "placer weighting for relative constraint satisfaction"); - - options.add_options()("version,V", "show version"); - options.add_options()("tmfuzz", "run path delay estimate fuzzer"); - options.add_options()("test", "check architecture database integrity"); + po::options_description specific("Architecture specific options"); #ifdef ICE40_HX1K_ONLY - options.add_options()("hx1k", "set device type to iCE40HX1K"); + specific.add_options()("hx1k", "set device type to iCE40HX1K"); #else - options.add_options()("lp384", "set device type to iCE40LP384"); - options.add_options()("lp1k", "set device type to iCE40LP1K"); - options.add_options()("lp8k", "set device type to iCE40LP8K"); - options.add_options()("hx1k", "set device type to iCE40HX1K"); - options.add_options()("hx8k", "set device type to iCE40HX8K"); - options.add_options()("up5k", "set device type to iCE40UP5K"); + specific.add_options()("lp384", "set device type to iCE40LP384"); + specific.add_options()("lp1k", "set device type to iCE40LP1K"); + specific.add_options()("lp8k", "set device type to iCE40LP8K"); + specific.add_options()("hx1k", "set device type to iCE40HX1K"); + specific.add_options()("hx8k", "set device type to iCE40HX8K"); + specific.add_options()("up5k", "set device type to iCE40UP5K"); #endif - options.add_options()("freq", po::value(), "set target frequency for design in MHz"); - options.add_options()("no-tmdriv", "disable timing-driven placement"); - options.add_options()("package", po::value(), "set device package"); - options.add_options()("save", po::value(), "project file to write"); - options.add_options()("load", po::value(), "project file to read"); - - po::variables_map vm; - try { - po::parsed_options parsed = po::command_line_parser(argc, argv).options(options).positional(pos).run(); - - po::store(parsed, vm); - - po::notify(vm); - } catch (std::exception &e) { - std::cout << e.what() << "\n"; - return 1; - } - - conflicting_options(vm, "read", "json"); -#ifndef ICE40_HX1K_ONLY - if ((vm.count("lp384") + vm.count("lp1k") + vm.count("lp8k") + vm.count("hx1k") + vm.count("hx8k") + - vm.count("up5k")) > 1) - log_error("Only one device type can be set\n"); -#endif - if (vm.count("help") || argc == 1) { - help: - std::cout << boost::filesystem::basename(argv[0]) - << " -- Next Generation Place and Route (git " - "sha1 " GIT_COMMIT_HASH_STR ")\n"; - std::cout << "\n"; - std::cout << options << "\n"; - return argc != 1; - } - - if (vm.count("version")) { - std::cout << boost::filesystem::basename(argv[0]) - << " -- Next Generation Place and Route (git " - "sha1 " GIT_COMMIT_HASH_STR ")\n"; - return 1; - } - - if (vm.count("load")) { - try { - pt::ptree root; - std::string filename = vm["load"].as(); - pt::read_json(filename, root); - log_info("Loading project %s...\n", filename.c_str()); - log_break(); - - bool isLoadingGui = vm.count("gui") > 0; - std::string ascOutput; - if (vm.count("asc")) - ascOutput = vm["asc"].as(); - vm.clear(); - - int version = root.get("project.version"); - if (version != 1) - log_error("Wrong project format version.\n"); - - std::string arch_name = root.get("project.arch.name"); - if (arch_name != "ice40") - log_error("Unsuported project architecture.\n"); - - std::string arch_type = root.get("project.arch.type"); - vm.insert(std::make_pair(arch_type, po::variable_value())); - - std::string arch_package = root.get("project.arch.package"); - vm.insert(std::make_pair("package", po::variable_value(arch_package, false))); + specific.add_options()("package", po::value(), "set device package"); + specific.add_options()("pcf", po::value(), "PCF constraints file to ingest"); + specific.add_options()("asc", po::value(), "asc bitstream file to write"); + specific.add_options()("read", po::value(), "asc bitstream file to read"); + specific.add_options()("tmfuzz", "run path delay estimate fuzzer"); + specific.add_options()("pack-only", "pack design only without placement or routing"); + return specific; +} +void Ice40CommandHandler::validate() +{ + conflicting_options(vm, "read", "json"); + if ((vm.count("lp384") + vm.count("lp1k") + vm.count("lp8k") + vm.count("hx1k") + vm.count("hx8k") + + vm.count("up5k")) > 1) + log_error("Only one device type can be set\n"); +} - auto project = root.get_child("project"); - if (project.count("input")) { - auto input = project.get_child("input"); - if (input.count("json")) - vm.insert(std::make_pair("json", po::variable_value(input.get("json"), false))); - if (input.count("pcf")) - vm.insert(std::make_pair("pcf", po::variable_value(input.get("pcf"), false))); - } - if (project.count("params")) { - auto params = project.get_child("params"); - if (params.count("freq")) - vm.insert(std::make_pair("freq", po::variable_value(params.get("freq"), false))); - if (params.count("seed")) - vm.insert(std::make_pair("seed", po::variable_value(params.get("seed"), false))); - } - if (!ascOutput.empty()) - vm.insert(std::make_pair("asc", po::variable_value(ascOutput, false))); - if (isLoadingGui) - vm.insert(std::make_pair("gui", po::variable_value())); - po::notify(vm); - } catch (...) { - log_error("Error loading project file.\n"); - } - } +void Ice40CommandHandler::customAfterLoad(Context *ctx) +{ + if (vm.count("pcf")) { + std::ifstream pcf(vm["pcf"].as()); + if (!apply_pcf(ctx, pcf)) + log_error("Loading PCF failed.\n"); + } +} +void Ice40CommandHandler::customBitstream(Context *ctx) +{ + if (vm.count("asc")) { + std::string filename = vm["asc"].as(); + std::ofstream f(filename); + write_asc(ctx, f); + } +} - ArchArgs chipArgs; +void Ice40CommandHandler::setupArchContext(Context *ctx) +{ + if (vm.count("tmfuzz")) + ice40DelayFuzzerMain(ctx); + + if (vm.count("read")) { + std::string filename = vm["read"].as(); + std::ifstream f(filename); + if (!read_asc(ctx, f)) + log_error("Loading ASC failed.\n"); + } +} - if (vm.count("lp384")) { - if (chipArgs.type != ArchArgs::NONE) - goto help; - chipArgs.type = ArchArgs::LP384; - chipArgs.package = "qn32"; - } +std::unique_ptr Ice40CommandHandler::createContext() +{ + if (vm.count("lp384")) { + chipArgs.type = ArchArgs::LP384; + chipArgs.package = "qn32"; + } - if (vm.count("lp1k")) { - if (chipArgs.type != ArchArgs::NONE) - goto help; - chipArgs.type = ArchArgs::LP1K; - chipArgs.package = "tq144"; - } + if (vm.count("lp1k")) { + chipArgs.type = ArchArgs::LP1K; + chipArgs.package = "tq144"; + } - if (vm.count("lp8k")) { - if (chipArgs.type != ArchArgs::NONE) - goto help; - chipArgs.type = ArchArgs::LP8K; - chipArgs.package = "ct256"; - } + if (vm.count("lp8k")) { + chipArgs.type = ArchArgs::LP8K; + chipArgs.package = "ct256"; + } - if (vm.count("hx1k")) { - if (chipArgs.type != ArchArgs::NONE) - goto help; - chipArgs.type = ArchArgs::HX1K; - chipArgs.package = "tq144"; - } + if (vm.count("hx1k")) { + chipArgs.type = ArchArgs::HX1K; + chipArgs.package = "tq144"; + } - if (vm.count("hx8k")) { - if (chipArgs.type != ArchArgs::NONE) - goto help; - chipArgs.type = ArchArgs::HX8K; - chipArgs.package = "ct256"; - } + if (vm.count("hx8k")) { + chipArgs.type = ArchArgs::HX8K; + chipArgs.package = "ct256"; + } - if (vm.count("up5k")) { - if (chipArgs.type != ArchArgs::NONE) - goto help; - chipArgs.type = ArchArgs::UP5K; - chipArgs.package = "sg48"; - } + if (vm.count("up5k")) { + chipArgs.type = ArchArgs::UP5K; + chipArgs.package = "sg48"; + } - if (chipArgs.type == ArchArgs::NONE) { - chipArgs.type = ArchArgs::HX1K; - chipArgs.package = "tq144"; - } + if (chipArgs.type == ArchArgs::NONE) { + chipArgs.type = ArchArgs::HX1K; + chipArgs.package = "tq144"; + } #ifdef ICE40_HX1K_ONLY - if (chipArgs.type != ArchArgs::HX1K) { - std::cout << "This version of nextpnr-ice40 is built with " - "HX1K-support " - "only.\n"; - return 1; - } -#endif - - if (vm.count("package")) - chipArgs.package = vm["package"].as(); - - if (vm.count("save")) { - Context ctx(chipArgs); - std::string filename = vm["save"].as(); - std::ofstream f(filename); - pt::ptree root; - root.put("project.version", 1); - root.put("project.name", boost::filesystem::basename(filename)); - root.put("project.arch.name", ctx.archId().c_str(&ctx)); - root.put("project.arch.type", ctx.archArgsToId(chipArgs).c_str(&ctx)); - root.put("project.arch.package", chipArgs.package); - if (vm.count("json")) - root.put("project.input.json", vm["json"].as()); - if (vm.count("pcf")) - root.put("project.input.pcf", vm["pcf"].as()); - if (vm.count("freq")) - root.put("project.params.freq", vm["freq"].as()); - if (vm.count("seed")) - root.put("project.params.seed", vm["seed"].as()); - pt::write_json(f, root); - return 1; - } - - std::unique_ptr ctx = std::unique_ptr(new Context(chipArgs)); - - if (vm.count("verbose")) { - ctx->verbose = true; - } - - if (vm.count("debug")) { - ctx->verbose = true; - ctx->debug = true; - } - - if (vm.count("force")) { - ctx->force = true; - } - - if (vm.count("seed")) { - ctx->rngseed(vm["seed"].as()); - } - - if (vm.count("slack_redist_iter")) { - ctx->slack_redist_iter = vm["slack_redist_iter"].as(); - if (vm.count("freq") && vm["freq"].as() == 0) { - ctx->auto_freq = true; -#ifndef NO_GUI - if (!vm.count("gui")) -#endif - log_warning("Target frequency not specified. Will optimise for max frequency.\n"); - } - } - - if (vm.count("cstrweight")) { - ctx->placer_constraintWeight = vm["cstrweight"].as(); - } - - if (vm.count("test")) - ctx->archcheck(); - - if (vm.count("tmfuzz")) - ice40DelayFuzzerMain(ctx.get()); - - if (vm.count("freq")) { - auto freq = vm["freq"].as(); - if (freq > 0) - ctx->target_freq = freq * 1e6; - } - - ctx->timing_driven = true; - if (vm.count("no-tmdriv")) - ctx->timing_driven = false; - - if (vm.count("read")) { - std::string filename = vm["read"].as(); - std::ifstream f(filename); - if (!read_asc(ctx.get(), f)) - log_error("Loading ASC failed.\n"); - } - -#ifndef NO_GUI - if (vm.count("gui")) { - Application a(argc, argv); - MainWindow w(std::move(ctx), chipArgs); - if (vm.count("json")) { - std::string filename = vm["json"].as(); - std::string pcf = ""; - w.load_json(filename); - if (vm.count("pcf")) { - pcf = vm["pcf"].as(); - w.load_pcf(pcf); - } - } - w.show(); - - return a.exec(); - } + if (chipArgs.type != ArchArgs::HX1K) { + log_error("This version of nextpnr-ice40 is built with HX1K-support only.\n"); + } #endif - if (vm.count("json")) { - std::string filename = vm["json"].as(); - std::ifstream f(filename); - if (!parse_json_file(f, filename, ctx.get())) - log_error("Loading design failed.\n"); - - if (vm.count("pcf")) { - std::ifstream pcf(vm["pcf"].as()); - if (!apply_pcf(ctx.get(), pcf)) - log_error("Loading PCF failed.\n"); - } - if (!ctx->pack() && !ctx->force) - log_error("Packing design failed.\n"); - ctx->check(); - print_utilisation(ctx.get()); - if (!vm.count("pack-only")) { - if (!ctx->place() && !ctx->force) - log_error("Placing design failed.\n"); - ctx->check(); - if (!ctx->route() && !ctx->force) - log_error("Routing design failed.\n"); - } - } + if (vm.count("package")) + chipArgs.package = vm["package"].as(); - if (vm.count("asc")) { - std::string filename = vm["asc"].as(); - std::ofstream f(filename); - write_asc(ctx.get(), f); - } - -#ifndef NO_PYTHON - if (vm.count("run")) { - init_python(argv[0], true); - python_export_global("ctx", *ctx.get()); - - std::vector files = vm["run"].as>(); - for (auto filename : files) - execute_python_file(filename.c_str()); + return std::unique_ptr(new Context(chipArgs)); +} - deinit_python(); - } -#endif - return rc; - } catch (log_execution_error_exception) { -#if defined(_MSC_VER) - _exit(EXIT_FAILURE); -#else - _Exit(EXIT_FAILURE); -#endif - } +int main(int argc, char *argv[]) +{ + Ice40CommandHandler handler(argc, argv); + return handler.exec(); } #endif -- cgit v1.2.3