kernel/register.h

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
   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 #ifndef REGISTER_H
  21 #define REGISTER_H
  22
  23 #include "kernel/rtlil.h"
  24 #include <stdio.h>
  25 #include <string>
  26 #include <vector>
  27 #include <map>
  28
  29 #ifdef YOSYS_ENABLE_TCL
  30 #include <tcl.h>
  31 extern Tcl_Interp *yosys_get_tcl_interp();
  32 extern RTLIL::Design *yosys_get_tcl_design();
  33 #endif
  34
  35 struct Pass
  36 {
  37         std::string pass_name, short_help;
  38         Pass(std::string name, std::string short_help = "** document me **");
  39         virtual void run_register();
  40         virtual ~Pass();
  41         virtual void help();
  42         virtual void execute(std::vector<std::string> args, RTLIL::Design *design) = 0;
  43
  44         void cmd_log_args(const std::vector<std::string> &args);
  45         void cmd_error(const std::vector<std::string> &args, size_t argidx, std::string msg);
  46         void extra_args(std::vector<std::string> args, size_t argidx, RTLIL::Design *design, bool select = true);
  47
  48         static void call(RTLIL::Design *design, std::string command);
  49         static void call(RTLIL::Design *design, std::vector<std::string> args);
  50
  51         static void init_register();
  52         static void done_register();
  53 };
  54
  55 struct Frontend : Pass
  56 {
  57         std::string frontend_name;
  58         Frontend(std::string name, std::string short_help = "** document me **");
  59         virtual void run_register();
  60         virtual ~Frontend();
  61         virtual void execute(std::vector<std::string> args, RTLIL::Design *design);
  62         virtual void execute(FILE *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) = 0;
  63
  64         static std::vector<std::string> next_args;
  65         void extra_args(FILE *&f, std::string &filename, std::vector<std::string> args, size_t argidx);
  66
  67         static void frontend_call(RTLIL::Design *design, FILE *f, std::string filename, std::string command);
  68         static void frontend_call(RTLIL::Design *design, FILE *f, std::string filename, std::vector<std::string> args);
  69 };
  70
  71 struct Backend : Pass
  72 {
  73         std::string backend_name;
  74         Backend(std::string name, std::string short_help = "** document me **");
  75         virtual void run_register();
  76         virtual ~Backend();
  77         virtual void execute(std::vector<std::string> args, RTLIL::Design *design);
  78         virtual void execute(FILE *&f, std::string filename,  std::vector<std::string> args, RTLIL::Design *design) = 0;
  79
  80         void extra_args(FILE *&f, std::string &filename, std::vector<std::string> args, size_t argidx);
  81
  82         static void backend_call(RTLIL::Design *design, FILE *f, std::string filename, std::string command);
  83         static void backend_call(RTLIL::Design *design, FILE *f, std::string filename, std::vector<std::string> args);
  84 };
  85
  86 // implemented in kernel/select.cc
  87 extern void handle_extra_select_args(Pass *pass, std::vector<std::string> args, size_t argidx, size_t args_size, RTLIL::Design *design);
  88
  89 namespace REGISTER_INTERN {
  90         extern int raw_register_count;
  91         extern bool raw_register_done;
  92         extern Pass *raw_register_array[];
  93         extern std::map<std::string, Pass*> pass_register;
  94         extern std::map<std::string, Frontend*> frontend_register;
  95         extern std::map<std::string, Backend*> backend_register;
  96 }
  97
  98 #endif