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 #if !defined(__GNUC__) && !defined(__clang__)
  81 #  define __attribute__(...)
  82 #endif
  83
  84 YOSYS_NAMESPACE_BEGIN
  85
  86 namespace RTLIL {
  87         struct IdString;
  88         struct SigSpec;
  89         struct Wire;
  90         struct Cell;
  91 }
  92
  93 std::string stringf(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
  94 std::string vstringf(const char *fmt, va_list ap);
  95 std::string next_token(std::string &text, const char *sep);
  96 bool patmatch(const char *pattern, const char *string);
  97 int run_command(const std::string &command, std::function<void(const std::string&)> process_line = std::function<void(const std::string&)>());
  98 std::string make_temp_file(std::string template_str = "/tmp/yosys_XXXXXX");
  99 std::string make_temp_dir(std::string template_str = "/tmp/yosys_XXXXXX");
 100 void remove_directory(std::string dirname);
 101
 102 template<typename T> int GetSize(const T &obj) { return obj.size(); }
 103 int GetSize(RTLIL::Wire *wire);
 104
 105 YOSYS_NAMESPACE_END
 106
 107 #include "kernel/log.h"
 108 #include "kernel/rtlil.h"
 109 #include "kernel/register.h"
 110
 111 YOSYS_NAMESPACE_BEGIN
 112
 113 void yosys_setup();
 114 void yosys_shutdown();
 115
 116 #ifdef YOSYS_ENABLE_TCL
 117 Tcl_Interp *yosys_get_tcl_interp();
 118 #endif
 119
 120 extern int autoidx;
 121 extern RTLIL::Design *yosys_design;
 122
 123 RTLIL::IdString new_id(std::string file, int line, std::string func);
 124
 125 #define NEW_ID \
 126         YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
 127
 128 #define ID(_str) \
 129         ([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()
 130
 131 RTLIL::Design *yosys_get_design();
 132 std::string proc_self_dirname();
 133 std::string proc_share_dirname();
 134 const char *create_prompt(RTLIL::Design *design, int recursion_counter);
 135
 136 void run_frontend(std::string filename, std::string command, RTLIL::Design *design, std::string *backend_command, std::string *from_to_label);
 137 void run_pass(std::string command, RTLIL::Design *design);
 138 void run_backend(std::string filename, std::string command, RTLIL::Design *design);
 139 void shell(RTLIL::Design *design);
 140
 141 // from kernel/version_*.o (cc source generated from Makefile)
 142 extern const char *yosys_version_str;
 143
 144 // from passes/cmds/design.cc
 145 extern std::map<std::string, RTLIL::Design*> saved_designs;
 146 extern std::vector<RTLIL::Design*> pushed_designs;
 147
 148 // from passes/cmds/pluginc.cc
 149 extern std::map<std::string, void*> loaded_plugins;
 150 extern std::map<std::string, std::string> loaded_plugin_aliases;
 151 void load_plugin(std::string filename, std::vector<std::string> aliases);
 152
 153 YOSYS_NAMESPACE_END
 154
 155 #endif