verilog_frontend.h File Reference

#include "kernel/yosys.h"
#include "frontends/ast/ast.h"
#include <stdio.h>
#include <stdint.h>
#include <list>

Include dependency graph for verilog_frontend.h:

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

Go to the source code of this file.

Namespaces
	VERILOG_FRONTEND

Functions
AST::AstNode *	VERILOG_FRONTEND::const2ast (std::string code, char case_type=0, bool warn_z=false)
std::string	frontend_verilog_preproc (std::istream &f, std::string filename, const std::map< std::string, std::string > pre_defines_map, const std::list< std::string > include_dirs)
int	frontend_verilog_yylex (void)
void	frontend_verilog_yyerror (char const *fmt,...)
void	frontend_verilog_yyrestart (FILE *f)
int	frontend_verilog_yyparse (void)
int	frontend_verilog_yylex_destroy (void)
int	frontend_verilog_yyget_lineno (void)
void	frontend_verilog_yyset_lineno (int)

Variables
struct AST::AstNode *	VERILOG_FRONTEND::current_ast
bool	VERILOG_FRONTEND::default_nettype_wire
bool	VERILOG_FRONTEND::sv_mode
std::istream *	VERILOG_FRONTEND::lexin
YOSYS_NAMESPACE_END int	frontend_verilog_yydebug

Function Documentation

std::string frontend_verilog_preproc	(	std::istream &	f,
		std::string	filename,
		const std::map< std::string, std::string >	pre_defines_map,
		const std::list< std::string >	include_dirs
	)

Definition at line 212 of file preproc.cc.

{
    std::set<std::string> defines_with_args;
    std::map<std::string, std::string> defines_map(pre_defines_map);
    int ifdef_fail_level = 0;
    bool in_elseif = false;

    output_code.clear();
    input_buffer.clear();
    input_buffer_charp = 0;

    input_file(f, filename);
    defines_map["__YOSYS__"] = "1";

    while (!input_buffer.empty())
    {
        std::string tok = next_token();
        // printf("token: >>%s<<\n", tok != "\n" ? tok.c_str() : "NEWLINE");

        if (tok == "`endif") {
            if (ifdef_fail_level > 0)
                ifdef_fail_level--;
            if (ifdef_fail_level == 0)
                in_elseif = false;
            continue;
        }

        if (tok == "`else") {
            if (ifdef_fail_level == 0)
                ifdef_fail_level = 1;
            else if (ifdef_fail_level == 1 && !in_elseif)
                ifdef_fail_level = 0;
            continue;
        }

        if (tok == "`elsif") {
            skip_spaces();
            std::string name = next_token(true);
            if (ifdef_fail_level == 0)
                ifdef_fail_level = 1, in_elseif = true;
            else if (ifdef_fail_level == 1 && defines_map.count(name) != 0)
                ifdef_fail_level = 0, in_elseif = true;
            continue;
        }

        if (tok == "`ifdef") {
            skip_spaces();
            std::string name = next_token(true);
            if (ifdef_fail_level > 0 || defines_map.count(name) == 0)
                ifdef_fail_level++;
            continue;
        }

        if (tok == "`ifndef") {
            skip_spaces();
            std::string name = next_token(true);
            if (ifdef_fail_level > 0 || defines_map.count(name) != 0)
                ifdef_fail_level++;
            continue;
        }

        if (ifdef_fail_level > 0) {
            if (tok == "\n")
                output_code.push_back(tok);
            continue;
        }

        if (tok == "`include") {
            skip_spaces();
            std::string fn = next_token(true);
            while (1) {
                size_t pos = fn.find('"');
                if (pos == std::string::npos)
                    break;
                if (pos == 0)
                    fn = fn.substr(1);
                else
                    fn = fn.substr(0, pos) + fn.substr(pos+1);
            }
            std::ifstream ff;
            ff.clear();
            ff.open(fn.c_str());
            if (ff.fail() && fn.size() > 0 && fn[0] != '/' && filename.find('/') != std::string::npos) {
                // if the include file was not found, it is not given with an absolute path, and the
                // currently read file is given with a path, then try again relative to its directory
                ff.clear();
                ff.open(filename.substr(0, filename.rfind('/')+1) + fn);
            }
            if (ff.fail() && fn.size() > 0 && fn[0] != '/') {
                // if the include file was not found and it is not given with an absolute path, then
                // search it in the include path
                for (auto incdir : include_dirs) {
                    ff.clear();
                    ff.open(incdir + '/' + fn);
                    if (!ff.fail()) break;
                }
            }
            if (ff.fail())
                output_code.push_back("`file_notfound " + fn);
            else
                input_file(ff, fn);
            continue;
        }

        if (tok == "`define") {
            std::string name, value;
            std::map<std::string, int> args;
            skip_spaces();
            name = next_token(true);
            bool here_doc_mode = false;
            int newline_count = 0;
            int state = 0;
            if (skip_spaces() != "")
                state = 3;
            while (!tok.empty()) {
                tok = next_token();
                if (tok == "\"\"\"") {
                    here_doc_mode = !here_doc_mode;
                    continue;
                }
                if (state == 0 && tok == "(") {
                    state = 1;
                    skip_spaces();
                } else
                if (state == 1) {
                    if (tok == ")")
                        state = 2;
                    else if (tok != ",") {
                        int arg_idx = args.size()+1;
                        args[tok] = arg_idx;
                    }
                    skip_spaces();
                } else {
                    if (state != 2)
                        state = 3;
                    if (tok == "\n") {
                        if (here_doc_mode) {
                            value += " ";
                            newline_count++;
                        } else {
                            return_char('\n');
                            break;
                        }
                    } else
                    if (tok == "\\") {
                        char ch = next_char();
                        if (ch == '\n') {
                            value += " ";
                            newline_count++;
                        } else {
                            value += std::string("\\");
                            return_char(ch);
                        }
                    } else
                    if (args.count(tok) > 0)
                        value += stringf("`macro_%s_arg%d", name.c_str(), args.at(tok));
                    else
                        value += tok;
                }
            }
            while (newline_count-- > 0)
                return_char('\n');
            // printf("define: >>%s<< -> >>%s<<\n", name.c_str(), value.c_str());
            defines_map[name] = value;
            if (state == 2)
                defines_with_args.insert(name);
            else
                defines_with_args.erase(name);
            continue;
        }

        if (tok == "`undef") {
            std::string name;
            skip_spaces();
            name = next_token(true);
            // printf("undef: >>%s<<\n", name.c_str());
            defines_map.erase(name);
            defines_with_args.erase(name);
            continue;
        }

        if (tok == "`timescale") {
            skip_spaces();
            while (!tok.empty() && tok != "\n")
                tok = next_token(true);
            if (tok == "\n")
                return_char('\n');
            continue;
        }

        if (tok.size() > 1 && tok[0] == '`' && defines_map.count(tok.substr(1)) > 0) {
            std::string name = tok.substr(1);
            // printf("expand: >>%s<< -> >>%s<<\n", name.c_str(), defines_map[name].c_str());
            std::string skipped_spaces = skip_spaces();
            tok = next_token(false);
            if (tok == "(" && defines_with_args.count(name) > 0) {
                int level = 1;
                std::vector<std::string> args;
                args.push_back(std::string());
                while (1)
                {
                    tok = next_token(true);
                    if (tok == ")" || tok == "}" || tok == "]")
                        level--;
                    if (level == 0)
                        break;
                    if (level == 1 && tok == ",")
                        args.push_back(std::string());
                    else
                        args.back() += tok;
                    if (tok == "(" || tok == "{" || tok == "[")
                        level++;
                }
                for (int i = 0; i < GetSize(args); i++)
                    defines_map[stringf("macro_%s_arg%d", name.c_str(), i+1)] = args[i];
            } else {
                insert_input(tok);
                insert_input(skipped_spaces);
            }
            insert_input(defines_map[name]);
            continue;
        }

        output_code.push_back(tok);
    }

    std::string output;
    for (auto &str : output_code)
        output += str;

    output_code.clear();
    input_buffer.clear();
    input_buffer_charp = 0;

    return output;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void frontend_verilog_yyerror	(	char const *	fmt,
			...
	)

Definition at line 364 of file verilog_frontend.cc.

{
    va_list ap;
    char buffer[1024];
    char *p = buffer;
    p += snprintf(p, buffer + sizeof(buffer) - p, "Parser error in line %s:%d: ",
            YOSYS_NAMESPACE_PREFIX AST::current_filename.c_str(), frontend_verilog_yyget_lineno());
    va_start(ap, fmt);
    p += vsnprintf(p, buffer + sizeof(buffer) - p, fmt, ap);
    va_end(ap);
    p += snprintf(p, buffer + sizeof(buffer) - p, "\n");
    YOSYS_NAMESPACE_PREFIX log_error("%s", buffer);
    exit(1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int frontend_verilog_yyget_lineno

(

void

)

Get the current line number.

Definition at line 2805 of file verilog_lexer.cc.

{
        
    return frontend_verilog_yylineno;
}

Here is the caller graph for this function:

int frontend_verilog_yylex

(

void

)

int frontend_verilog_yylex_destroy

(

void

)

Definition at line 2912 of file verilog_lexer.cc.

{
    
    /* Pop the buffer stack, destroying each element. */
    while(YY_CURRENT_BUFFER){
        frontend_verilog_yy_delete_buffer(YY_CURRENT_BUFFER  );
        YY_CURRENT_BUFFER_LVALUE = NULL;
        frontend_verilog_yypop_buffer_state();
    }

    /* Destroy the stack itself. */
    frontend_verilog_yyfree((yy_buffer_stack) );
    (yy_buffer_stack) = NULL;

    /* Reset the globals. This is important in a non-reentrant scanner so the next time
     * frontend_verilog_yylex() is called, initialization will occur. */
    yy_init_globals( );

    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int frontend_verilog_yyparse

(

void

)

Here is the caller graph for this function:

void frontend_verilog_yyrestart

(

FILE *

input_file

)

Immediately switch to a different input stream.

Parameters

input_file

A readable stream.

Note

This function does not reset the start condition to INITIAL .

Definition at line 2425 of file verilog_lexer.cc.

{
    
    if ( ! YY_CURRENT_BUFFER ){
        frontend_verilog_yyensure_buffer_stack ();
        YY_CURRENT_BUFFER_LVALUE =
            frontend_verilog_yy_create_buffer(frontend_verilog_yyin,YY_BUF_SIZE );
    }

    frontend_verilog_yy_init_buffer(YY_CURRENT_BUFFER,input_file );
    frontend_verilog_yy_load_buffer_state( );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void frontend_verilog_yyset_lineno

(

int

line_number

)

Set the current line number.

Parameters

line_number

Definition at line 2848 of file verilog_lexer.cc.

{
    
    frontend_verilog_yylineno = line_number;
}

Here is the caller graph for this function:

Variable Documentation

YOSYS_NAMESPACE_END int frontend_verilog_yydebug