kernel/yosys.h

   1 /* -*- c++ -*-
   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 <tuple>
  45 #include <vector>
  46 #include <string>
  47 #include <algorithm>
  48 #include <functional>
  49 #include <unordered_map>
  50 #include <unordered_set>
  51 #include <initializer_list>
  52 #include <stdexcept>
  53 #include <memory>
  54 #include <cmath>
  55
  56 #include <sstream>
  57 #include <fstream>
  58 #include <istream>
  59 #include <ostream>
  60 #include <iostream>
  61
  62 #include <stdarg.h>
  63 #include <stdlib.h>
  64 #include <string.h>
  65 #include <stdint.h>
  66 #include <stdio.h>
  67 #include <limits.h>
  68
  69 #ifdef WITH_PYTHON
  70 #include <Python.h>
  71 #endif
  72
  73 #ifndef _YOSYS_
  74 #  error It looks like you are trying to build Yosys without the config defines set. \
  75          When building Yosys with a custom make system, make sure you set all the \
  76          defines the Yosys Makefile would set for your build configuration.
  77 #endif
  78
  79 #ifdef YOSYS_ENABLE_TCL
  80 #  include <tcl.h>
  81 #  ifdef YOSYS_MXE_HACKS
  82 extern Tcl_Command Tcl_CreateCommand(Tcl_Interp *interp, const char *cmdName, Tcl_CmdProc *proc, ClientData clientData, Tcl_CmdDeleteProc *deleteProc);
  83 extern Tcl_Interp *Tcl_CreateInterp(void);
  84 extern void Tcl_DeleteInterp(Tcl_Interp *interp);
  85 extern int Tcl_Eval(Tcl_Interp *interp, const char *script);
  86 extern int Tcl_EvalFile(Tcl_Interp *interp, const char *fileName);
  87 extern void Tcl_Finalize(void);
  88 extern int Tcl_GetCommandInfo(Tcl_Interp *interp, const char *cmdName, Tcl_CmdInfo *infoPtr);
  89 extern const char *Tcl_GetStringResult(Tcl_Interp *interp);
  90 #  endif
  91 #endif
  92
  93 #ifdef _WIN32
  94 #  undef NOMINMAX
  95 #  define NOMINMAX 1
  96 #  undef YY_NO_UNISTD_H
  97 #  define YY_NO_UNISTD_H 1
  98
  99 #  include <windows.h>
 100 #  include <io.h>
 101 #  include <direct.h>
 102
 103 #  define strtok_r strtok_s
 104 #  define strdup _strdup
 105 #  define snprintf _snprintf
 106 #  define getcwd _getcwd
 107 #  define mkdir _mkdir
 108 #  define popen _popen
 109 #  define pclose _pclose
 110
 111 #  ifndef __MINGW32__
 112 #    define PATH_MAX MAX_PATH
 113 #    define isatty _isatty
 114 #    define fileno _fileno
 115 #  endif
 116 #endif
 117
 118 #ifndef PATH_MAX
 119 #  define PATH_MAX 4096
 120 #endif
 121
 122 #define YOSYS_NAMESPACE          Yosys
 123 #define PRIVATE_NAMESPACE_BEGIN  namespace {
 124 #define PRIVATE_NAMESPACE_END    }
 125 #define YOSYS_NAMESPACE_BEGIN    namespace Yosys {
 126 #define YOSYS_NAMESPACE_END      }
 127 #define YOSYS_NAMESPACE_PREFIX   Yosys::
 128 #define USING_YOSYS_NAMESPACE    using namespace Yosys;
 129
 130 #if __cplusplus >= 201103L
 131 #  define YS_OVERRIDE override
 132 #  define YS_FINAL final
 133 #else
 134 #  define YS_OVERRIDE
 135 #  define YS_FINAL
 136 #endif
 137
 138 #if defined(__GNUC__) || defined(__clang__)
 139 #  define YS_ATTRIBUTE(...) __attribute__((__VA_ARGS__))
 140 #  define YS_NORETURN
 141 #elif defined(_MSC_VER)
 142 #  define YS_ATTRIBUTE(...)
 143 #  define YS_NORETURN __declspec(noreturn)
 144 #else
 145 #  define YS_ATTRIBUTE(...)
 146 #  define YS_NORETURN
 147 #endif
 148
 149 YOSYS_NAMESPACE_BEGIN
 150
 151 // Note: All headers included in hashlib.h must be included
 152 // outside of YOSYS_NAMESPACE before this or bad things will happen.
 153 #ifdef HASHLIB_H
 154 #  undef HASHLIB_H
 155 #  include "kernel/hashlib.h"
 156 #else
 157 #  include "kernel/hashlib.h"
 158 #  undef HASHLIB_H
 159 #endif
 160
 161 using std::vector;
 162 using std::string;
 163 using std::tuple;
 164 using std::pair;
 165
 166 using std::make_tuple;
 167 using std::make_pair;
 168 using std::get;
 169 using std::min;
 170 using std::max;
 171
 172 // A primitive shared string implementation that does not
 173 // move its .c_str() when the object is copied or moved.
 174 struct shared_str {
 175         std::shared_ptr<string> content;
 176         shared_str() { }
 177         shared_str(string s) { content = std::shared_ptr<string>(new string(s)); }
 178         shared_str(const char *s) { content = std::shared_ptr<string>(new string(s)); }
 179         const char *c_str() const { return content->c_str(); }
 180         const string &str() const { return *content; }
 181         bool operator==(const shared_str &other) const { return *content == *other.content; }
 182         unsigned int hash() const { return hashlib::hash_ops<std::string>::hash(*content); }
 183 };
 184
 185 using hashlib::mkhash;
 186 using hashlib::mkhash_init;
 187 using hashlib::mkhash_add;
 188 using hashlib::mkhash_xorshift;
 189 using hashlib::hash_ops;
 190 using hashlib::hash_cstr_ops;
 191 using hashlib::hash_ptr_ops;
 192 using hashlib::hash_obj_ops;
 193 using hashlib::dict;
 194 using hashlib::idict;
 195 using hashlib::pool;
 196 using hashlib::mfp;
 197
 198 namespace RTLIL {
 199         struct IdString;
 200         struct Const;
 201         struct SigBit;
 202         struct SigSpec;
 203         struct Wire;
 204         struct Cell;
 205         struct Module;
 206         struct Design;
 207         struct Monitor;
 208 }
 209
 210 namespace AST {
 211         struct AstNode;
 212 }
 213
 214 using RTLIL::IdString;
 215 using RTLIL::Const;
 216 using RTLIL::SigBit;
 217 using RTLIL::SigSpec;
 218 using RTLIL::Wire;
 219 using RTLIL::Cell;
 220 using RTLIL::Module;
 221 using RTLIL::Design;
 222
 223 namespace hashlib {
 224         template<> struct hash_ops<RTLIL::Wire*> : hash_obj_ops {};
 225         template<> struct hash_ops<RTLIL::Cell*> : hash_obj_ops {};
 226         template<> struct hash_ops<RTLIL::Module*> : hash_obj_ops {};
 227         template<> struct hash_ops<RTLIL::Design*> : hash_obj_ops {};
 228         template<> struct hash_ops<RTLIL::Monitor*> : hash_obj_ops {};
 229         template<> struct hash_ops<AST::AstNode*> : hash_obj_ops {};
 230
 231         template<> struct hash_ops<const RTLIL::Wire*> : hash_obj_ops {};
 232         template<> struct hash_ops<const RTLIL::Cell*> : hash_obj_ops {};
 233         template<> struct hash_ops<const RTLIL::Module*> : hash_obj_ops {};
 234         template<> struct hash_ops<const RTLIL::Design*> : hash_obj_ops {};
 235         template<> struct hash_ops<const RTLIL::Monitor*> : hash_obj_ops {};
 236         template<> struct hash_ops<const AST::AstNode*> : hash_obj_ops {};
 237 }
 238
 239 void memhasher_on();
 240 void memhasher_off();
 241 void memhasher_do();
 242
 243 extern bool memhasher_active;
 244 inline void memhasher() { if (memhasher_active) memhasher_do(); }
 245
 246 void yosys_banner();
 247 int ceil_log2(int x) YS_ATTRIBUTE(const);
 248 std::string stringf(const char *fmt, ...) YS_ATTRIBUTE(format(printf, 1, 2));
 249 std::string vstringf(const char *fmt, va_list ap);
 250 int readsome(std::istream &f, char *s, int n);
 251 std::string next_token(std::string &text, const char *sep = " \t\r\n", bool long_strings = false);
 252 std::vector<std::string> split_tokens(const std::string &text, const char *sep = " \t\r\n");
 253 bool patmatch(const char *pattern, const char *string);
 254 int run_command(const std::string &command, std::function<void(const std::string&)> process_line = std::function<void(const std::string&)>());
 255 std::string make_temp_file(std::string template_str = "/tmp/yosys_XXXXXX");
 256 std::string make_temp_dir(std::string template_str = "/tmp/yosys_XXXXXX");
 257 bool check_file_exists(std::string filename, bool is_exec = false);
 258 bool is_absolute_path(std::string filename);
 259 void remove_directory(std::string dirname);
 260 std::string escape_filename_spaces(const std::string& filename);
 261
 262 template<typename T> int GetSize(const T &obj) { return obj.size(); }
 263 int GetSize(RTLIL::Wire *wire);
 264
 265 extern int autoidx;
 266 extern int yosys_xtrace;
 267
 268 YOSYS_NAMESPACE_END
 269
 270 #include "kernel/log.h"
 271 #include "kernel/rtlil.h"
 272 #include "kernel/register.h"
 273
 274 YOSYS_NAMESPACE_BEGIN
 275
 276 using RTLIL::State;
 277 using RTLIL::SigChunk;
 278 using RTLIL::SigSig;
 279
 280 namespace hashlib {
 281         template<> struct hash_ops<RTLIL::State> : hash_ops<int> {};
 282 }
 283
 284 void yosys_setup();
 285
 286 #ifdef WITH_PYTHON
 287 bool yosys_already_setup();
 288 #endif
 289
 290 void yosys_shutdown();
 291
 292 #ifdef YOSYS_ENABLE_TCL
 293 Tcl_Interp *yosys_get_tcl_interp();
 294 #endif
 295
 296 extern RTLIL::Design *yosys_design;
 297
 298 RTLIL::IdString new_id(std::string file, int line, std::string func);
 299
 300 #define NEW_ID \
 301         YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
 302
 303 #define ID(_str) \
 304         ([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()
 305
 306 RTLIL::Design *yosys_get_design();
 307 std::string proc_self_dirname();
 308 std::string proc_share_dirname();
 309 const char *create_prompt(RTLIL::Design *design, int recursion_counter);
 310 std::vector<std::string> glob_filename(const std::string &filename_pattern);
 311 void rewrite_filename(std::string &filename);
 312
 313 void run_pass(std::string command, RTLIL::Design *design = nullptr);
 314 void run_frontend(std::string filename, std::string command, std::string *backend_command, std::string *from_to_label = nullptr, RTLIL::Design *design = nullptr);
 315 void run_frontend(std::string filename, std::string command, RTLIL::Design *design = nullptr);
 316 void run_backend(std::string filename, std::string command, RTLIL::Design *design = nullptr);
 317 void shell(RTLIL::Design *design);
 318
 319 // journal of all input and output files read (for "yosys -E")
 320 extern std::set<std::string> yosys_input_files, yosys_output_files;
 321
 322 // from kernel/version_*.o (cc source generated from Makefile)
 323 extern const char *yosys_version_str;
 324
 325 // from passes/cmds/design.cc
 326 extern std::map<std::string, RTLIL::Design*> saved_designs;
 327 extern std::vector<RTLIL::Design*> pushed_designs;
 328
 329 // from passes/cmds/pluginc.cc
 330 extern std::map<std::string, void*> loaded_plugins;
 331 #ifdef WITH_PYTHON
 332 extern std::map<std::string, void*> loaded_python_plugins;
 333 #endif
 334 extern std::map<std::string, std::string> loaded_plugin_aliases;
 335 void load_plugin(std::string filename, std::vector<std::string> aliases);
 336
 337 YOSYS_NAMESPACE_END
 338
 339 #endif