2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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.
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.
21 // *** NOTE TO THE READER ***
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! ;)
26 // If you want to know how the design is represented by Yosys in the memory,
27 // you should read "kernel/rtlil.h".
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".
33 // This header is very boring. It just defines some general things that
34 // belong nowhere else and includes the interesting headers.
36 // Find more information in the "CodingReadme" file.
48 #include <unordered_map>
49 #include <unordered_set>
50 #include <initializer_list>
66 # error It looks like you are trying to build Yosys without the config defines set. \
67 When building Yosys with a custom make system, make sure you set all the \
68 defines the Yosys Makefile would set for your build configuration.
71 #ifdef YOSYS_ENABLE_TCL
78 # undef YY_NO_UNISTD_H
79 # define YY_NO_UNISTD_H 1
85 # define strtok_r strtok_s
86 # define strdup _strdup
87 # define snprintf _snprintf
88 # define getcwd _getcwd
91 # define pclose _pclose
92 # define PATH_MAX MAX_PATH
95 # define isatty _isatty
96 # define fileno _fileno
100 #define PRIVATE_NAMESPACE_BEGIN namespace {
101 #define PRIVATE_NAMESPACE_END }
102 #define YOSYS_NAMESPACE_BEGIN namespace Yosys {
103 #define YOSYS_NAMESPACE_END }
104 #define YOSYS_NAMESPACE_PREFIX Yosys::
105 #define USING_YOSYS_NAMESPACE using namespace Yosys;
107 #if __cplusplus >= 201103L
108 # define YS_OVERRIDE override
109 # define YS_FINAL final
115 #if defined(__GNUC__) || defined(__clang__)
116 # define YS_ATTRIBUTE(...) __attribute__((__VA_ARGS__))
118 #elif defined(_MSC_VER)
119 # define YS_ATTRIBUTE(...)
120 # define YS_NORETURN __declspec(noreturn)
122 # define YS_ATTRIBUTE(...)
126 YOSYS_NAMESPACE_BEGIN
128 // Note: All headers included in hashlib.h must be included
129 // outside of YOSYS_NAMESPACE before this or bad things will happen.
132 # include "kernel/hashlib.h"
134 # include "kernel/hashlib.h"
140 using hashlib::mkhash
;
141 using hashlib::mkhash_add
;
142 using hashlib::mkhash_xorshift
;
143 using hashlib::hash_ops
;
144 using hashlib::hash_cstr_ops
;
145 using hashlib::hash_ptr_ops
;
146 using hashlib::hash_obj_ops
;
166 using RTLIL::IdString
;
169 using RTLIL::SigSpec
;
176 template<> struct hash_ops
<RTLIL::Wire
*> : hash_obj_ops
{};
177 template<> struct hash_ops
<RTLIL::Cell
*> : hash_obj_ops
{};
178 template<> struct hash_ops
<RTLIL::Module
*> : hash_obj_ops
{};
179 template<> struct hash_ops
<RTLIL::Design
*> : hash_obj_ops
{};
180 template<> struct hash_ops
<RTLIL::Monitor
*> : hash_obj_ops
{};
181 template<> struct hash_ops
<AST::AstNode
*> : hash_obj_ops
{};
183 template<> struct hash_ops
<const RTLIL::Wire
*> : hash_obj_ops
{};
184 template<> struct hash_ops
<const RTLIL::Cell
*> : hash_obj_ops
{};
185 template<> struct hash_ops
<const RTLIL::Module
*> : hash_obj_ops
{};
186 template<> struct hash_ops
<const RTLIL::Design
*> : hash_obj_ops
{};
187 template<> struct hash_ops
<const RTLIL::Monitor
*> : hash_obj_ops
{};
188 template<> struct hash_ops
<const AST::AstNode
*> : hash_obj_ops
{};
192 void memhasher_off();
195 extern bool memhasher_active
;
196 inline void memhasher() { if (memhasher_active
) memhasher_do(); }
198 std::string
stringf(const char *fmt
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
199 std::string
vstringf(const char *fmt
, va_list ap
);
200 int readsome(std::istream
&f
, char *s
, int n
);
201 std::string
next_token(std::string
&text
, const char *sep
);
202 bool patmatch(const char *pattern
, const char *string
);
203 int run_command(const std::string
&command
, std::function
<void(const std::string
&)> process_line
= std::function
<void(const std::string
&)>());
204 std::string
make_temp_file(std::string template_str
= "/tmp/yosys_XXXXXX");
205 std::string
make_temp_dir(std::string template_str
= "/tmp/yosys_XXXXXX");
206 bool check_file_exists(std::string filename
, bool is_exec
= false);
207 void remove_directory(std::string dirname
);
209 template<typename T
> int GetSize(const T
&obj
) { return obj
.size(); }
210 int GetSize(RTLIL::Wire
*wire
);
213 extern int yosys_xtrace
;
217 #include "kernel/log.h"
218 #include "kernel/rtlil.h"
219 #include "kernel/register.h"
221 YOSYS_NAMESPACE_BEGIN
224 void yosys_shutdown();
226 #ifdef YOSYS_ENABLE_TCL
227 Tcl_Interp
*yosys_get_tcl_interp();
230 extern RTLIL::Design
*yosys_design
;
232 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
);
235 YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
238 ([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()
240 RTLIL::Design
*yosys_get_design();
241 std::string
proc_self_dirname();
242 std::string
proc_share_dirname();
243 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
);
245 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
, std::string
*backend_command
, std::string
*from_to_label
);
246 void run_pass(std::string command
, RTLIL::Design
*design
);
247 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
);
248 void shell(RTLIL::Design
*design
);
250 // from kernel/version_*.o (cc source generated from Makefile)
251 extern const char *yosys_version_str
;
253 // from passes/cmds/design.cc
254 extern std::map
<std::string
, RTLIL::Design
*> saved_designs
;
255 extern std::vector
<RTLIL::Design
*> pushed_designs
;
257 // from passes/cmds/pluginc.cc
258 extern std::map
<std::string
, void*> loaded_plugins
;
259 extern std::map
<std::string
, std::string
> loaded_plugin_aliases
;
260 void load_plugin(std::string filename
, std::vector
<std::string
> aliases
);