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 #endif
  33
  34 // from kernel/version_*.o (cc source generated from Makefile)
  35 extern const char *yosys_version_str;
  36
  37 // implemented in driver.cc
  38 extern RTLIL::Design *yosys_get_design();
  39 std::string rewrite_yosys_exe(std::string exe);
  40 std::string get_share_file_name(std::string file);
  41
  42 struct Pass
  43 {
  44         std::string pass_name, short_help;
  45         Pass(std::string name, std::string short_help = "** document me **");
  46         virtual void run_register();
  47         virtual ~Pass();
  48         virtual void help();
  49         virtual void execute(std::vector<std::string> args, RTLIL::Design *design) = 0;
  50
  51         void cmd_log_args(const std::vector<std::string> &args);
  52         void cmd_error(const std::vector<std::string> &args, size_t argidx, std::string msg);
  53         void extra_args(std::vector<std::string> args, size_t argidx, RTLIL::Design *design, bool select = true);
  54
  55         static void call(RTLIL::Design *design, std::string command);
  56         static void call(RTLIL::Design *design, std::vector<std::string> args);
  57
  58         static void init_register();
  59         static void done_register();
  60 };
  61
  62 struct Frontend : Pass
  63 {
  64         std::string frontend_name;
  65         Frontend(std::string name, std::string short_help = "** document me **");
  66         virtual void run_register();
  67         virtual ~Frontend();
  68         virtual void execute(std::vector<std::string> args, RTLIL::Design *design);
  69         virtual void execute(FILE *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) = 0;
  70
  71         static std::vector<std::string> next_args;
  72         void extra_args(FILE *&f, std::string &filename, std::vector<std::string> args, size_t argidx);
  73
  74         static void frontend_call(RTLIL::Design *design, FILE *f, std::string filename, std::string command);
  75         static void frontend_call(RTLIL::Design *design, FILE *f, std::string filename, std::vector<std::string> args);
  76 };
  77
  78 struct Backend : Pass
  79 {
  80         std::string backend_name;
  81         Backend(std::string name, std::string short_help = "** document me **");
  82         virtual void run_register();
  83         virtual ~Backend();
  84         virtual void execute(std::vector<std::string> args, RTLIL::Design *design);
  85         virtual void execute(FILE *&f, std::string filename,  std::vector<std::string> args, RTLIL::Design *design) = 0;
  86
  87         void extra_args(FILE *&f, std::string &filename, std::vector<std::string> args, size_t argidx);
  88
  89         static void backend_call(RTLIL::Design *design, FILE *f, std::string filename, std::string command);
  90         static void backend_call(RTLIL::Design *design, FILE *f, std::string filename, std::vector<std::string> args);
  91 };
  92
  93 // implemented in passes/cmds/select.cc
  94 extern void handle_extra_select_args(Pass *pass, std::vector<std::string> args, size_t argidx, size_t args_size, RTLIL::Design *design);
  95
  96 namespace REGISTER_INTERN {
  97         extern int raw_register_count;
  98         extern bool raw_register_done;
  99         extern Pass *raw_register_array[];
 100         extern std::map<std::string, Pass*> pass_register;
 101         extern std::map<std::string, Frontend*> frontend_register;
 102         extern std::map<std::string, Backend*> backend_register;
 103 }
 104
 105 #endif