kernel/yosys.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
  21 // *** NOTE TO THE READER ***
  22 //
  23 // Maybe you have just opened this file in the hope to learn more about the
  24 // Yosys API. Let me congratulate you on this great decision!  ;)
  25 //
  26 // If you want to know how the design is represented by Yosys in the memory,
  27 // you should read "kernel/rtlil.h".
  28 //
  29 // If you want to know how to register a command with Yosys, you could read
  30 // "kernel/register.h", but it would be easier to just look at a simple
  31 // example instead. A simple one would be "passes/cmds/log.cc".
  32 //
  33 // This header is very boring. It just defines some general things that
  34 // belong nowhere else and includes the interesting headers.
  35
  36
  37 #ifndef YOSYS_H
  38 #define YOSYS_H
  39
  40 #include <map>
  41 #include <set>
  42 #include <vector>
  43 #include <string>
  44 #include <algorithm>
  45 #include <initializer_list>
  46 #include <stdarg.h>
  47
  48 #define PRIVATE_NAMESPACE_BEGIN  namespace {
  49 #define PRIVATE_NAMESPACE_END    }
  50
  51 #if 0
  52 #  define YOSYS_NAMESPACE_BEGIN  namespace Yosys {
  53 #  define YOSYS_NAMESPACE_END    }
  54 #  define YOSYS_NAMESPACE_PREFIX Yosys::
  55 #  define USING_YOSYS_NAMESPACE  using namespace Yosys;
  56 #else
  57 #  define YOSYS_NAMESPACE_BEGIN
  58 #  define YOSYS_NAMESPACE_END
  59 #  define YOSYS_NAMESPACE_PREFIX
  60 #  define USING_YOSYS_NAMESPACE
  61 #endif
  62
  63 YOSYS_NAMESPACE_BEGIN
  64
  65 namespace RTLIL {
  66         struct SigSpec;
  67         struct Wire;
  68         struct Cell;
  69 }
  70
  71 std::string stringf(const char *fmt, ...);
  72 std::string vstringf(const char *fmt, va_list ap);
  73 template<typename T> int SIZE(const T &obj) { return obj.size(); }
  74 int SIZE(RTLIL::Wire *wire);
  75
  76 YOSYS_NAMESPACE_END
  77
  78 #include "kernel/log.h"
  79 #include "kernel/rtlil.h"
  80 #include "kernel/register.h"
  81 #include "kernel/compatibility.h"
  82
  83 YOSYS_NAMESPACE_BEGIN
  84
  85 void yosys_setup();
  86 void yosys_shutdown();
  87
  88 #ifdef YOSYS_ENABLE_TCL
  89 #include <tcl.h>
  90 Tcl_Interp *yosys_get_tcl_interp();
  91 #endif
  92
  93 extern int autoidx;
  94 extern RTLIL::Design *yosys_design;
  95
  96 RTLIL::IdString new_id(std::string file, int line, std::string func);
  97
  98 #define NEW_ID \
  99         YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
 100
 101 RTLIL::Design *yosys_get_design();
 102 std::string proc_self_dirname();
 103 std::string proc_share_dirname();
 104 const char *create_prompt(RTLIL::Design *design, int recursion_counter);
 105
 106 void run_frontend(std::string filename, std::string command, RTLIL::Design *design, std::string *backend_command, std::string *from_to_label);
 107 void run_pass(std::string command, RTLIL::Design *design);
 108 void run_backend(std::string filename, std::string command, RTLIL::Design *design);
 109 void shell(RTLIL::Design *design);
 110
 111 // from kernel/version_*.o (cc source generated from Makefile)
 112 extern const char *yosys_version_str;
 113
 114 // from passes/cmds/design.cc
 115 extern std::map<std::string, RTLIL::Design*> saved_designs;
 116 extern std::vector<RTLIL::Design*> pushed_designs;
 117
 118 YOSYS_NAMESPACE_END
 119
 120 #endif