backends/metadata/metadata.cc

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2012  Aki "lethalbit" Van Ness <aki@yosyshq.com> <aki@lethalbit.net>
   5  *
   6  *  Permission to use, copy, modify, and/or distribute this software for any
   7  *  purpose with or without fee is hereby granted, provided that the above
   8  *  copyright notice and this permission notice appear in all copies.
   9  *
  10  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  *
  18  */
  19
  20 // MYAU - Metadata for Yosys-Assisted Utilities
  21
  22 #include "kernel/rtlil.h"
  23 #include "kernel/register.h"
  24 #include "kernel/sigtools.h"
  25 #include "kernel/celltypes.h"
  26 #include "kernel/cellaigs.h"
  27 #include "kernel/log.h"
  28 #include <string>
  29 #include <unordered_map>
  30 #include <vector>
  31
  32 USING_YOSYS_NAMESPACE
  33 PRIVATE_NAMESPACE_BEGIN
  34
  35
  36 struct MetadataWriter
  37 {
  38     private:
  39         std::ostream &f;
  40         bool _use_selection;
  41         std::unordered_map<std::string, std::vector<Cell*>> _cells{};
  42
  43         // XXX(aki): this was pulled from the json backend, needs to be pulled
  44         // out possibly into some sort of utilities file, or integrated into rtlil.h
  45         // directly
  46         string get_string(string str)
  47         {
  48             string newstr = "\"";
  49             for (char c : str) {
  50                 if (c == '\\')
  51                     newstr += c;
  52                 newstr += c;
  53             }
  54             return newstr + "\"";
  55         }
  56
  57         // XXX(aki): I know this is far from ideal but i'm out of spoons and cant focus so
  58         // it'll have to do for now,
  59         void coalesce_cells(Module* mod)
  60         {
  61             for (auto cell : mod->cells()) {
  62                 const auto cell_type = get_string(RTLIL::unescape_id(cell->type));
  63
  64                 if (_cells.find(cell_type) == _cells.end())
  65                     _cells.emplace(cell_type, std::vector<Cell*>());
  66
  67                 _cells.at(cell_type).push_back(cell);
  68             }
  69         }
  70
  71     public:
  72     MetadataWriter(std::ostream &f, bool use_selection) noexcept: f{f}, _use_selection{use_selection} { }
  73
  74     void write_metadata(Design *design)
  75     {
  76         log_assert(design != nullptr);
  77
  78         design->sort();
  79
  80         f << stringf("{\n");
  81         f << stringf("  \"generator\": %s,\n", get_string(yosys_version_str).c_str());
  82         // XXX(aki): Replace this with a proper version info eventually:tm:
  83         f << stringf("  \"version\": \"0.0.0\",\n");
  84         f << stringf("  \"modules\": [\n");
  85
  86         bool first{true};
  87         for (auto mod : _use_selection ? design->selected_modules() : design->modules()) {
  88             if (!first)
  89                 f << stringf(",\n");
  90             write_module(mod);
  91
  92             f << stringf("\n");
  93
  94             first = false;
  95         }
  96
  97         f << stringf("  ]\n");
  98         f << stringf("}\n");
  99     }
 100
 101     void write_module(Module* mod)
 102     {
 103         log_assert(mod != nullptr);
 104
 105         coalesce_cells(mod);
 106
 107         f << stringf("    {\n");
 108         f << stringf("      \"name\": %s,\n", get_string(RTLIL::unescape_id(mod->name)).c_str());
 109         f << stringf("      \"cell_sorts\": [\n");
 110
 111         bool first_sort{true};
 112         for (auto& sort : _cells) {
 113             if (!first_sort)
 114                 f << stringf(",\n");
 115
 116             write_cell_sort(sort);
 117
 118             first_sort = false;
 119         }
 120
 121         f << stringf("      ],\n");
 122         f << stringf("      \"connections\": [\n");
 123
 124         f << stringf("      ]\n");
 125         f << stringf("    }");
 126     }
 127
 128
 129     void write_cell_sort(std::pair<const std::string, std::vector<Cell*>>& sort)
 130     {
 131         const auto port_cell = sort.second.front();
 132
 133         f << stringf("        {\n");
 134         f << stringf("          \"type\": %s,\n", sort.first.c_str());
 135         f << stringf("          \"ports\": [\n");
 136
 137         bool first_port{true};
 138         for (auto con : port_cell->connections()) {
 139             if (!first_port)
 140                 f << stringf(",\n");
 141
 142             f << stringf("          {\n");
 143             f << stringf("            \"name\": %s,\n", get_string(RTLIL::unescape_id(con.first)).c_str());
 144             f << stringf("            \"direction\": \"");
 145             if (port_cell->input(con.first))
 146                 f << stringf("i");
 147             if (port_cell->input(con.first))
 148                 f << stringf("o");
 149             f << stringf("\",\n");
 150             if (con.second.size() == 1)
 151                 f << stringf("            \"range\": [0, 0]\n");
 152             else
 153                 f << stringf("            \"range\": [%d, %d]\n", con.second.size(), 0);
 154             f << stringf("          }");
 155
 156             first_port = false;
 157         }
 158
 159         f << stringf("          ],\n          \"cells\": [\n");
 160         bool first_cell{true};
 161         for (auto& cell : sort.second) {
 162             if (!first_cell)
 163                 f << stringf(",\n");
 164
 165             write_cell(cell);
 166
 167             first_cell = false;
 168         }
 169         f << stringf("          ]\n");
 170         f << stringf("        }");
 171     }
 172
 173     void write_cell(Cell* cell)
 174     {
 175         log_assert(cell != nullptr);
 176
 177         f << stringf("          {\n");
 178         f << stringf("            \"name\": %s,\n", get_string(RTLIL::unescape_id(cell->name)).c_str());
 179         f << stringf("            \"attributes\": {\n");
 180         f << stringf("            },\n");
 181         f << stringf("            \"parameters\": {\n");
 182         f << stringf("            },\n");
 183         f << stringf("          }");
 184     }
 185 };
 186
 187 struct MetadataBackend : public Backend {
 188     MetadataBackend() : Backend("metadata", "generate design metadata") { }
 189     void help() override
 190     {
 191         //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
 192         log("\n");
 193         log("    metadata [options] [selection]\n");
 194         log("\n");
 195         log("Write a JSON metadata for the current design\n");
 196         log("\n");
 197         log("\n");
 198     }
 199
 200     void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) override
 201     {
 202         size_t argidx{1};
 203         extra_args(f, filename, args, argidx);
 204
 205         log_header(design, "Executing metadata backend.\n");
 206
 207         MetadataWriter metadata_writier(*f, false);
 208         metadata_writier.write_metadata(design);
 209     }
 210
 211 } MetadataBackend;
 212
 213
 214 struct MetadataPass : public Pass {
 215     MetadataPass() : Pass("metadata", "write design metadata") { }
 216
 217     void help() override
 218     {
 219         //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
 220         log("\n");
 221         log("    metadata [options] [selection]\n");
 222         log("\n");
 223         log("Write a JSON metadata for the current design\n");
 224         log("\n");
 225         log("    -o <filename>\n");
 226         log("        write to the specified file.\n");
 227         log("\n");
 228         log("See 'help write_metadata' for a description of the JSON format used.\n");
 229         log("\n");
 230     }
 231     void execute(std::vector<std::string> args, RTLIL::Design *design) override
 232     {
 233         std::string filename{};
 234
 235         size_t argidx;
 236         for (argidx = 1; argidx < args.size(); argidx++)
 237         {
 238             if (args[argidx] == "-o" && argidx+1 < args.size()) {
 239                 filename = args[++argidx];
 240                 continue;
 241             }
 242             break;
 243         }
 244         extra_args(args, argidx, design);
 245
 246         std::ostream *f;
 247         std::stringstream buf;
 248
 249         if (!filename.empty()) {
 250             rewrite_filename(filename);
 251             std::ofstream *ff = new std::ofstream;
 252             ff->open(filename.c_str(), std::ofstream::trunc);
 253             if (ff->fail()) {
 254                 delete ff;
 255                 log_error("Can't open file `%s' for writing: %s\n", filename.c_str(), strerror(errno));
 256             }
 257             f = ff;
 258         } else {
 259             f = &buf;
 260         }
 261
 262
 263         MetadataWriter metadata_writier(*f, false);
 264         metadata_writier.write_metadata(design);
 265
 266         if (!filename.empty()) {
 267             delete f;
 268         } else {
 269             log("%s", buf.str().c_str());
 270         }
 271     }
 272
 273 } MetadataPass;
 274
 275 PRIVATE_NAMESPACE_END