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