yosys.h File Reference

#include <map>
#include <set>
#include <vector>
#include <string>
#include <algorithm>
#include <functional>
#include <initializer_list>
#include <sstream>
#include <fstream>
#include <istream>
#include <ostream>
#include <iostream>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>
#include <stdio.h>
#include "kernel/log.h"
#include "kernel/rtlil.h"
#include "kernel/register.h"

Include dependency graph for yosys.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	RTLIL

Macros
#define	PRIVATE_NAMESPACE_BEGIN   namespace {
#define	PRIVATE_NAMESPACE_END   }
#define	YOSYS_NAMESPACE_BEGIN   namespace Yosys {
#define	YOSYS_NAMESPACE_END   }
#define	YOSYS_NAMESPACE_PREFIX   Yosys::
#define	USING_YOSYS_NAMESPACE   using namespace Yosys;
#define	YS_OVERRIDE
#define	YS_FINAL
#define	YS_ATTRIBUTE(...)
#define	YS_NORETURN
#define	NEW_ID   YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
#define	ID(_str)   ([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()

Functions
std::string	stringf (const char *fmt,...) YS_ATTRIBUTE(format(printf
std::string std::string	vstringf (const char *fmt, va_list ap)
int	readsome (std::istream &f, char *s, int n)
std::string	next_token (std::string &text, const char *sep)
bool	patmatch (const char *pattern, const char *string)
int	run_command (const std::string &command, std::function< void(const std::string &)> process_line=std::function< void(const std::string &)>())
std::string	make_temp_file (std::string template_str="/tmp/yosys_XXXXXX")
std::string	make_temp_dir (std::string template_str="/tmp/yosys_XXXXXX")
bool	check_file_exists (std::string filename, bool is_exec=false)
void	remove_directory (std::string dirname)
template<typename T >
int	GetSize (const T &obj)
int	GetSize (RTLIL::Wire *wire)
YOSYS_NAMESPACE_END YOSYS_NAMESPACE_BEGIN void	yosys_setup ()
void	yosys_shutdown ()
RTLIL::IdString	new_id (std::string file, int line, std::string func)
RTLIL::Design *	yosys_get_design ()
std::string	proc_self_dirname ()
std::string	proc_share_dirname ()
const char *	create_prompt (RTLIL::Design *design, int recursion_counter)
void	run_frontend (std::string filename, std::string command, RTLIL::Design *design, std::string *backend_command, std::string *from_to_label)
void	run_pass (std::string command, RTLIL::Design *design)
void	run_backend (std::string filename, std::string command, RTLIL::Design *design)
void	shell (RTLIL::Design *design)
void	load_plugin (std::string filename, std::vector< std::string > aliases)

Variables
int	autoidx
RTLIL::Design *	yosys_design
const char *	yosys_version_str
std::map< std::string, RTLIL::Design * >	saved_designs
std::vector< RTLIL::Design * >	pushed_designs
std::map< std::string, void * >	loaded_plugins
std::map< std::string, std::string >	loaded_plugin_aliases

Macro Definition Documentation

#define ID

(

_str

)

([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()

Definition at line 169 of file yosys.h.

#define NEW_ID   YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)

Definition at line 166 of file yosys.h.

#define PRIVATE_NAMESPACE_BEGIN   namespace {

Definition at line 97 of file yosys.h.

#define PRIVATE_NAMESPACE_END   }

Definition at line 98 of file yosys.h.

#define USING_YOSYS_NAMESPACE   using namespace Yosys;

Definition at line 102 of file yosys.h.

#define YOSYS_NAMESPACE_BEGIN   namespace Yosys {

Definition at line 99 of file yosys.h.

#define YOSYS_NAMESPACE_END   }

Definition at line 100 of file yosys.h.

#define YOSYS_NAMESPACE_PREFIX   Yosys::

Definition at line 101 of file yosys.h.

#define YS_ATTRIBUTE

(

...

)

Definition at line 119 of file yosys.h.

#define YS_FINAL

Definition at line 109 of file yosys.h.

#define YS_NORETURN

Definition at line 120 of file yosys.h.

#define YS_OVERRIDE

Definition at line 108 of file yosys.h.

Function Documentation

bool check_file_exists	(	std::string	filename,
		bool	is_exec = false
	)

Definition at line 302 of file yosys.cc.

{
    return access(filename.c_str(), is_exec ? X_OK : F_OK) == 0;
}

Here is the caller graph for this function:

const char* create_prompt	(	RTLIL::Design *	design,
		int	recursion_counter
	)

Definition at line 400 of file yosys.cc.

{
    static char buffer[100];
    std::string str = "\n";
    if (recursion_counter > 1)
        str += stringf("(%d) ", recursion_counter);
    str += "yosys";
    if (!design->selected_active_module.empty())
        str += stringf(" [%s]", RTLIL::unescape_id(design->selected_active_module).c_str());
    if (!design->selection_stack.empty() && !design->selection_stack.back().full_selection) {
        if (design->selected_active_module.empty())
            str += "*";
        else if (design->selection_stack.back().selected_modules.size() != 1 || design->selection_stack.back().selected_members.size() != 0 ||
                design->selection_stack.back().selected_modules.count(design->selected_active_module) == 0)
            str += "*";
    }
    snprintf(buffer, 100, "%s> ", str.c_str());
    return buffer;
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

int GetSize

(

const T &

obj

)

Definition at line 143 of file yosys.h.

{ return obj.size(); }

int GetSize

(

RTLIL::Wire *

wire

)

Definition at line 334 of file yosys.cc.

{
    return wire->width;
}

void load_plugin	(	std::string	filename,
		std::vector< std::string >	aliases
	)

Definition at line 49 of file plugin.cc.

{
    log_error("This version of yosys is built without plugin support.\n");
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string make_temp_dir

(

std::string

template_str = "/tmp/yosys_XXXXXX"

)

Definition at line 273 of file yosys.cc.

{
#ifdef _WIN32
    template_str = make_temp_file(template_str);
    mkdir(template_str.c_str());
    return template_str;
#else
    size_t pos = template_str.rfind("XXXXXX");
    log_assert(pos != std::string::npos);

    int suffixlen = GetSize(template_str) - pos - 6;
    log_assert(suffixlen == 0);

    char *p = strdup(template_str.c_str());
    p = mkdtemp(p);
    log_assert(p != NULL);
    template_str = p;
    free(p);

    return template_str;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string make_temp_file

(

std::string

template_str = "/tmp/yosys_XXXXXX"

)

Definition at line 224 of file yosys.cc.

{
#ifdef _WIN32
    if (template_str.rfind("/tmp/", 0) == 0) {
#  ifdef __MINGW32__
        char longpath[MAX_PATH + 1];
        char shortpath[MAX_PATH + 1];
#  else
        WCHAR longpath[MAX_PATH + 1];
        TCHAR shortpath[MAX_PATH + 1];
#  endif
        if (!GetTempPath(MAX_PATH+1, longpath))
            log_error("GetTempPath() failed.\n");
        if (!GetShortPathName(longpath, shortpath, MAX_PATH + 1))
            log_error("GetShortPathName() failed.\n");
        std::string path;
        for (int i = 0; shortpath[i]; i++)
            path += char(shortpath[i]);
        template_str = stringf("%s\\%s", path.c_str(), template_str.c_str() + 5);
    }

    size_t pos = template_str.rfind("XXXXXX");
    log_assert(pos != std::string::npos);

    while (1) {
        for (int i = 0; i < 6; i++) {
            static std::string y = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
            static uint32_t x = 314159265 ^ uint32_t(time(NULL));
            x ^= x << 13, x ^= x >> 17, x ^= x << 5;
            template_str[pos+i] = y[x % y.size()];
        }
        if (_access(template_str.c_str(), 0) != 0)
            break;
    }
#else
    size_t pos = template_str.rfind("XXXXXX");
    log_assert(pos != std::string::npos);

    int suffixlen = GetSize(template_str) - pos - 6;

    char *p = strdup(template_str.c_str());
    close(mkstemps(p, suffixlen));
    template_str = p;
    free(p);
#endif

    return template_str;
}

Here is the call graph for this function:

Here is the caller graph for this function:

RTLIL::IdString new_id	(	std::string	file,
		int	line,
		std::string	func
	)

Definition at line 378 of file yosys.cc.

{
#ifdef _WIN32
    size_t pos = file.find_last_of("/\\");
#else
    size_t pos = file.find_last_of('/');
#endif
    if (pos != std::string::npos)
        file = file.substr(pos+1);

    pos = func.find_last_of(':');
    if (pos != std::string::npos)
        func = func.substr(pos+1);

    return stringf("$auto$%s:%d:%s$%d", file.c_str(), line, func.c_str(), autoidx++);
}

Here is the call graph for this function:

std::string next_token	(	std::string &	text,
		const char *	sep
	)

Definition at line 116 of file yosys.cc.

{
    size_t pos_begin = text.find_first_not_of(sep);

    if (pos_begin == std::string::npos)
        pos_begin = text.size();

    size_t pos_end = text.find_first_of(sep, pos_begin);

    if (pos_end == std::string::npos)
        pos_end = text.size();

    std::string token = text.substr(pos_begin, pos_end-pos_begin);
    text = text.substr(pos_end);
    return token;
}

bool patmatch	(	const char *	pattern,
		const char *	string
	)

Definition at line 144 of file yosys.cc.

{
    if (*pattern == 0)
        return *string == 0;

    if (*pattern == '\\') {
        if (pattern[1] == string[0] && patmatch(pattern+2, string+1))
            return true;
    }

    if (*pattern == '?') {
        if (*string == 0)
            return false;
        return patmatch(pattern+1, string+1);
    }

    if (*pattern == '*') {
        while (*string) {
            if (patmatch(pattern+1, string++))
                return true;
        }
        return pattern[1] == 0;
    }

    if (*pattern == '[') {
        bool found_match = false;
        bool inverted_list = pattern[1] == '!';
        const char *p = pattern + (inverted_list ? 1 : 0);

        while (*++p) {
            if (*p == ']') {
                if (found_match != inverted_list && patmatch(p+1, string+1))
                    return true;
                break;
            }

            if (*p == '\\') {
                if (*++p == *string)
                    found_match = true;
            } else
            if (*p == *string)
                found_match = true;
        }
    }

    if (*pattern == *string)
        return patmatch(pattern+1, string+1);

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string proc_self_dirname

(

)

Here is the caller graph for this function:

std::string proc_share_dirname

(

)

Definition at line 543 of file yosys.cc.

{
    std::string proc_self_path = proc_self_dirname();
#ifdef _WIN32
    std::string proc_share_path = proc_self_path + "share\\";
    if (check_file_exists(proc_share_path, true))
        return proc_share_path;
    proc_share_path = proc_self_path + "..\\share\\";
    if (check_file_exists(proc_share_path, true))
        return proc_share_path;
#else
    std::string proc_share_path = proc_self_path + "share/";
    if (check_file_exists(proc_share_path, true))
        return proc_share_path;
    proc_share_path = proc_self_path + "../share/yosys/";
    if (check_file_exists(proc_share_path, true))
        return proc_share_path;
#endif
    log_error("proc_share_dirname: unable to determine share/ directory!\n");
}

Here is the call graph for this function:

Here is the caller graph for this function:

int readsome	(	std::istream &	f,
		char *	s,
		int	n
	)

Definition at line 100 of file yosys.cc.

{
    int rc = f.readsome(s, n);

    // f.readsome() sometimes returns 0 on a non-empty stream..
    if (rc == 0) {
        int c = f.get();
        if (c != EOF) {
            *s = c;
            rc = 1;
        }
    }

    return rc;
}

Here is the caller graph for this function:

void remove_directory

(

std::string

dirname

)

Definition at line 308 of file yosys.cc.

{
#ifdef _WIN32
    run_command(stringf("rmdir /s /q \"%s\"", dirname.c_str()));
#else
    struct stat stbuf;
    struct dirent **namelist;
    int n = scandir(dirname.c_str(), &namelist, nullptr, alphasort);
    log_assert(n >= 0);
    for (int i = 0; i < n; i++) {
        if (strcmp(namelist[i]->d_name, ".") && strcmp(namelist[i]->d_name, "..")) {
            std::string buffer = stringf("%s/%s", dirname.c_str(), namelist[i]->d_name);
            if (!stat(buffer.c_str(), &stbuf) && S_ISREG(stbuf.st_mode)) {
                log("Removing `%s'.\n", buffer.c_str());
                remove(buffer.c_str());
            } else
                remove_directory(buffer);
        }
        free(namelist[i]);
    }
    free(namelist);
    log("Removing `%s'.\n", dirname.c_str());
    rmdir(dirname.c_str());
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void run_backend	(	std::string	filename,
		std::string	command,
		RTLIL::Design *	design
	)

Definition at line 703 of file yosys.cc.

{
    if (command == "auto") {
        if (filename.size() > 2 && filename.substr(filename.size()-2) == ".v")
            command = "verilog";
        else if (filename.size() > 3 && filename.substr(filename.size()-3) == ".il")
            command = "ilang";
        else if (filename.size() > 5 && filename.substr(filename.size()-5) == ".blif")
            command = "blif";
        else if (filename == "-")
            command = "ilang";
        else if (filename.empty())
            return;
        else
            log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename.c_str());
    }

    if (filename.empty())
        filename = "-";

    if (filename == "-") {
        log("\n-- Writing to stdout using backend `%s' --\n", command.c_str());
    } else {
        log("\n-- Writing to `%s' using backend `%s' --\n", filename.c_str(), command.c_str());
    }

    Backend::backend_call(design, NULL, filename, command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int run_command	(	const std::string &	command,
		std::function< void(const std::string &)>	process_line = std::function< void(const std::string &)>()
	)

Definition at line 195 of file yosys.cc.

{
    if (!process_line)
        return system(command.c_str());

    FILE *f = popen(command.c_str(), "r");
    if (f == nullptr)
        return -1;

    std::string line;
    char logbuf[128];
    while (fgets(logbuf, 128, f) != NULL) {
        line += logbuf;
        if (!line.empty() && line.back() == '\n')
            process_line(line), line.clear();
    }
    if (!line.empty())
        process_line(line);

    int ret = pclose(f);
    if (ret < 0)
        return -1;
#ifdef _WIN32
    return ret;
#else
    return WEXITSTATUS(ret);
#endif
}

Here is the caller graph for this function:

void run_frontend	(	std::string	filename,
		std::string	command,
		RTLIL::Design *	design,
		std::string *	backend_command,
		std::string *	from_to_label
	)

Definition at line 603 of file yosys.cc.

{
    if (command == "auto") {
        if (filename.size() > 2 && filename.substr(filename.size()-2) == ".v")
            command = "verilog";
        else if (filename.size() > 2 && filename.substr(filename.size()-3) == ".sv")
            command = "verilog -sv";
        else if (filename.size() > 3 && filename.substr(filename.size()-3) == ".il")
            command = "ilang";
        else if (filename.size() > 3 && filename.substr(filename.size()-3) == ".ys")
            command = "script";
        else if (filename == "-")
            command = "script";
        else
            log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename.c_str());
    }

    if (command == "script")
    {
        std::string run_from, run_to;
        bool from_to_active = true;

        if (from_to_label != NULL) {
            size_t pos = from_to_label->find(':');
            if (pos == std::string::npos) {
                run_from = *from_to_label;
                run_to = *from_to_label;
            } else {
                run_from = from_to_label->substr(0, pos);
                run_to = from_to_label->substr(pos+1);
            }
            from_to_active = run_from.empty();
        }

        log("\n-- Executing script file `%s' --\n", filename.c_str());

        FILE *f = stdin;

        if (filename != "-")
            f = fopen(filename.c_str(), "r");

        if (f == NULL)
            log_error("Can't open script file `%s' for reading: %s\n", filename.c_str(), strerror(errno));

        FILE *backup_script_file = Frontend::current_script_file;
        Frontend::current_script_file = f;

        try {
            std::string command;
            while (fgetline(f, command)) {
                while (!command.empty() && command[command.size()-1] == '\\') {
                    std::string next_line;
                    if (!fgetline(f, next_line))
                        break;
                    command.resize(command.size()-1);
                    command += next_line;
                }
                handle_label(command, from_to_active, run_from, run_to);
                if (from_to_active)
                    Pass::call(design, command);
            }

            if (!command.empty()) {
                handle_label(command, from_to_active, run_from, run_to);
                if (from_to_active)
                    Pass::call(design, command);
            }
        }
        catch (log_cmd_error_exception) {
            Frontend::current_script_file = backup_script_file;
            throw log_cmd_error_exception();
        }

        Frontend::current_script_file = backup_script_file;

        if (filename != "-")
            fclose(f);

        if (backend_command != NULL && *backend_command == "auto")
            *backend_command = "";

        return;
    }

    if (filename == "-") {
        log("\n-- Parsing stdin using frontend `%s' --\n", command.c_str());
    } else {
        log("\n-- Parsing `%s' using frontend `%s' --\n", filename.c_str(), command.c_str());
    }

    Frontend::frontend_call(design, NULL, filename, command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void run_pass	(	std::string	command,
		RTLIL::Design *	design
	)

Definition at line 696 of file yosys.cc.

{
    log("\n-- Running pass `%s' --\n", command.c_str());

    Pass::call(design, command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void shell

(

RTLIL::Design *

design

)

Definition at line 812 of file yosys.cc.

{
    static int recursion_counter = 0;

    recursion_counter++;
    log_cmd_error_throw = true;

#ifdef YOSYS_ENABLE_READLINE
    rl_readline_name = "yosys";
    rl_attempted_completion_function = readline_completion;
    rl_basic_word_break_characters = " \t\n";
#endif

    char *command = NULL;
#ifdef YOSYS_ENABLE_READLINE
    while ((command = readline(create_prompt(design, recursion_counter))) != NULL)
    {
#else
    char command_buffer[4096];
    while (1)
    {
        fputs(create_prompt(design, recursion_counter), stdout);
        fflush(stdout);
        if ((command = fgets(command_buffer, 4096, stdin)) == NULL)
            break;
#endif
        if (command[strspn(command, " \t\r\n")] == 0)
            continue;
#ifdef YOSYS_ENABLE_READLINE
        add_history(command);
#endif

        char *p = command + strspn(command, " \t\r\n");
        if (!strncmp(p, "exit", 4)) {
            p += 4;
            p += strspn(p, " \t\r\n");
            if (*p == 0)
                break;
        }

        try {
            log_assert(design->selection_stack.size() == 1);
            Pass::call(design, command);
        } catch (log_cmd_error_exception) {
            while (design->selection_stack.size() > 1)
                design->selection_stack.pop_back();
            log_reset_stack();
        }
    }
    if (command == NULL)
        printf("exit\n");

    recursion_counter--;
    log_cmd_error_throw = false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string stringf	(	const char *	fmt,
			...
	)

std::string std::string vstringf	(	const char *	fmt,
		va_list	ap
	)

Definition at line 70 of file yosys.cc.

{
    std::string string;
    char *str = NULL;

#ifdef _WIN32
    int sz = 64, rc;
    while (1) {
        va_list apc;
        va_copy(apc, ap);
        str = (char*)realloc(str, sz);
        rc = vsnprintf(str, sz, fmt, apc);
        va_end(apc);
        if (rc >= 0 && rc < sz)
            break;
        sz *= 2;
    }
#else
    if (vasprintf(&str, fmt, ap) < 0)
        str = NULL;
#endif

    if (str != NULL) {
        string = str;
        free(str);
    }

    return string;
}

Here is the call graph for this function:

Here is the caller graph for this function:

RTLIL::Design* yosys_get_design

(

)

Definition at line 395 of file yosys.cc.

{
    return yosys_design;
}

YOSYS_NAMESPACE_END YOSYS_NAMESPACE_BEGIN void yosys_setup

(

)

Definition at line 339 of file yosys.cc.

{
    Pass::init_register();
    yosys_design = new RTLIL::Design;
    log_push();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void yosys_shutdown

(

)

Definition at line 346 of file yosys.cc.

{
    log_pop();

    delete yosys_design;
    yosys_design = NULL;

    for (auto f : log_files)
        if (f != stderr)
            fclose(f);
    log_errfile = NULL;
    log_files.clear();

    Pass::done_register();

#ifdef YOSYS_ENABLE_TCL
    if (yosys_tcl_interp != NULL) {
        Tcl_DeleteInterp(yosys_tcl_interp);
        Tcl_Finalize();
        yosys_tcl_interp = NULL;
    }
#endif

#ifdef YOSYS_ENABLE_PLUGINS
    for (auto &it : loaded_plugins)
        dlclose(it.second);

    loaded_plugins.clear();
    loaded_plugin_aliases.clear();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

int autoidx

Definition at line 51 of file yosys.cc.

std::map<std::string, std::string> loaded_plugin_aliases

Definition at line 29 of file plugin.cc.

std::map<std::string, void*> loaded_plugins

Definition at line 28 of file plugin.cc.

std::vector<RTLIL::Design*> pushed_designs

Definition at line 28 of file design.cc.

std::map<std::string, RTLIL::Design*> saved_designs

Definition at line 27 of file design.cc.

RTLIL::Design* yosys_design

Definition at line 52 of file yosys.cc.

const char* yosys_version_str