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 // Find more information in the "CodingReadme" file.
  37
  38
  39 #ifndef YOSYS_H
  40 #define YOSYS_H
  41
  42 #include <map>
  43 #include <set>
  44 #include <vector>
  45 #include <string>
  46 #include <algorithm>
  47 #include <functional>
  48 #include <initializer_list>
  49
  50 #include <sstream>
  51 #include <fstream>
  52 #include <istream>
  53 #include <ostream>
  54 #include <iostream>
  55
  56 #include <stdarg.h>
  57 #include <stdlib.h>
  58 #include <string.h>
  59 #include <stdio.h>
  60
  61 #ifdef YOSYS_ENABLE_TCL
  62 #  include <tcl.h>
  63 #endif
  64
  65 #define PRIVATE_NAMESPACE_BEGIN  namespace {
  66 #define PRIVATE_NAMESPACE_END    }
  67 #define YOSYS_NAMESPACE_BEGIN    namespace Yosys {
  68 #define YOSYS_NAMESPACE_END      }
  69 #define YOSYS_NAMESPACE_PREFIX   Yosys::
  70 #define USING_YOSYS_NAMESPACE    using namespace Yosys;
  71
  72 #if __cplusplus >= 201103L
  73 #  define OVERRIDE override
  74 #  define FINAL final
  75 #else
  76 #  define OVERRIDE
  77 #  define FINAL
  78 #endif
  79
  80 YOSYS_NAMESPACE_BEGIN
  81
  82 namespace RTLIL {
  83         struct IdString;
  84         struct SigSpec;
  85         struct Wire;
  86         struct Cell;
  87 }
  88
  89 std::string stringf(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
  90 std::string vstringf(const char *fmt, va_list ap);
  91 std::string next_token(std::string &text, const char *sep);
  92 bool patmatch(const char *pattern, const char *string);
  93 int readsome(std::istream &f, char *s, int n);
  94 int run_command(const std::string &command, std::function<void(const std::string&)> process_line = std::function<void(const std::string&)>());
  95 std::string make_temp_file(std::string template_str = "/tmp/yosys_XXXXXX");
  96 std::string make_temp_dir(std::string template_str = "/tmp/yosys_XXXXXX");
  97 void remove_directory(std::string dirname);
  98
  99 template<typename T> int GetSize(const T &obj) { return obj.size(); }
 100 int GetSize(RTLIL::Wire *wire);
 101
 102 YOSYS_NAMESPACE_END
 103
 104 #include "kernel/log.h"
 105 #include "kernel/rtlil.h"
 106 #include "kernel/register.h"
 107
 108 YOSYS_NAMESPACE_BEGIN
 109
 110 void yosys_setup();
 111 void yosys_shutdown();
 112
 113 #ifdef YOSYS_ENABLE_TCL
 114 Tcl_Interp *yosys_get_tcl_interp();
 115 #endif
 116
 117 extern int autoidx;
 118 extern RTLIL::Design *yosys_design;
 119
 120 RTLIL::IdString new_id(std::string file, int line, std::string func);
 121
 122 #define NEW_ID \
 123         YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
 124
 125 #define ID(_str) \
 126         ([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()
 127
 128 RTLIL::Design *yosys_get_design();
 129 std::string proc_self_dirname();
 130 std::string proc_share_dirname();
 131 const char *create_prompt(RTLIL::Design *design, int recursion_counter);
 132
 133 void run_frontend(std::string filename, std::string command, RTLIL::Design *design, std::string *backend_command, std::string *from_to_label);
 134 void run_pass(std::string command, RTLIL::Design *design);
 135 void run_backend(std::string filename, std::string command, RTLIL::Design *design);
 136 void shell(RTLIL::Design *design);
 137
 138 // from kernel/version_*.o (cc source generated from Makefile)
 139 extern const char *yosys_version_str;
 140
 141 // from passes/cmds/design.cc
 142 extern std::map<std::string, RTLIL::Design*> saved_designs;
 143 extern std::vector<RTLIL::Design*> pushed_designs;
 144
 145 // from passes/cmds/pluginc.cc
 146 extern std::map<std::string, void*> loaded_plugins;
 147 extern std::map<std::string, std::string> loaded_plugin_aliases;
 148 void load_plugin(std::string filename, std::vector<std::string> aliases);
 149
 150 YOSYS_NAMESPACE_END
 151
 152 #endif