2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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.
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.
20 * This is the AST frontend library.
22 * The AST frontend library is not a frontend on it's own but provides a
23 * generic abstract syntax tree (AST) abstraction for HDL code and can be
24 * used by HDL frontends. See "ast.h" for an overview of the API and the
25 * Verilog frontend for an usage example.
32 #include "kernel/rtlil.h"
40 // all node types, type2str() must be extended
41 // whenever a new node type is added here
153 AST_INTERFACEPORTTYPE
,
162 struct AstSrcLocType
{
163 unsigned int first_line
, last_line
;
164 unsigned int first_column
, last_column
;
165 AstSrcLocType() : first_line(0), last_line(0), first_column(0), last_column(0) {}
166 AstSrcLocType(int _first_line
, int _first_column
, int _last_line
, int _last_column
) : first_line(_first_line
), last_line(_last_line
), first_column(_first_column
), last_column(_last_column
) {}
169 // convert an node type to a string (e.g. for debug output)
170 std::string
type2str(AstNodeType type
);
172 // The AST is built using instances of this struct
175 // for dict<> and pool<>
176 unsigned int hashidx_
;
177 unsigned int hash() const { return hashidx_
; }
182 // the list of child nodes for this node
183 std::vector
<AstNode
*> children
;
185 // the list of attributes assigned to this node
186 std::map
<RTLIL::IdString
, AstNode
*> attributes
;
187 bool get_bool_attribute(RTLIL::IdString id
);
189 // node content - most of it is unused in most node types
191 std::vector
<RTLIL::State
> bits
;
192 bool is_input
, is_output
, is_reg
, is_logic
, is_signed
, is_string
, is_wand
, is_wor
, range_valid
, range_swapped
, was_checked
, is_unsized
, is_custom_type
;
193 int port_id
, range_left
, range_right
;
196 // set for IDs typed to an enumeration, not used
199 // if this is a multirange memory then this vector contains offset and length of each dimension
200 std::vector
<int> multirange_dimensions
;
202 // this is set by simplify and used during RTLIL generation
205 // this is used by simplify to detect if basic analysis has been performed already on the node
208 // this is used for ID references in RHS expressions that should use the "new" value for non-blocking assignments
211 // this is the original sourcecode location that resulted in this AST node
212 // it is automatically set by the constructor using AST::current_filename and
213 // the AST::get_line_num() callback function.
214 std::string filename
;
215 AstSrcLocType location
;
217 // creating and deleting nodes
218 AstNode(AstNodeType type
= AST_NONE
, AstNode
*child1
= NULL
, AstNode
*child2
= NULL
, AstNode
*child3
= NULL
);
219 AstNode
*clone() const;
220 void cloneInto(AstNode
*other
) const;
221 void delete_children();
227 MEM2REG_FL_ALL
= 0x00000001,
228 MEM2REG_FL_ASYNC
= 0x00000002,
229 MEM2REG_FL_INIT
= 0x00000004,
231 /* candidate flags */
232 MEM2REG_FL_FORCED
= 0x00000100,
233 MEM2REG_FL_SET_INIT
= 0x00000200,
234 MEM2REG_FL_SET_ELSE
= 0x00000400,
235 MEM2REG_FL_SET_ASYNC
= 0x00000800,
236 MEM2REG_FL_EQ2
= 0x00001000,
237 MEM2REG_FL_CMPLX_LHS
= 0x00002000,
238 MEM2REG_FL_CONST_LHS
= 0x00004000,
239 MEM2REG_FL_VAR_LHS
= 0x00008000,
242 MEM2REG_FL_EQ1
= 0x01000000,
245 // simplify() creates a simpler AST by unrolling for-loops, expanding generate blocks, etc.
246 // it also sets the id2ast pointers so that identifier lookups are fast in genRTLIL()
247 bool simplify(bool const_fold
, bool at_zero
, bool in_lvalue
, int stage
, int width_hint
, bool sign_hint
, bool in_param
);
248 AstNode
*readmem(bool is_readmemh
, std::string mem_filename
, AstNode
*memory
, int start_addr
, int finish_addr
, bool unconditional_init
);
249 void expand_genblock(std::string index_var
, std::string prefix
, std::map
<std::string
, std::string
> &name_map
);
250 void replace_ids(const std::string
&prefix
, const std::map
<std::string
, std::string
> &rules
);
251 void mem2reg_as_needed_pass1(dict
<AstNode
*, pool
<std::string
>> &mem2reg_places
,
252 dict
<AstNode
*, uint32_t> &mem2reg_flags
, dict
<AstNode
*, uint32_t> &proc_flags
, uint32_t &status_flags
);
253 bool mem2reg_as_needed_pass2(pool
<AstNode
*> &mem2reg_set
, AstNode
*mod
, AstNode
*block
, AstNode
*&async_block
);
254 bool mem2reg_check(pool
<AstNode
*> &mem2reg_set
);
255 void mem2reg_remove(pool
<AstNode
*> &mem2reg_set
, vector
<AstNode
*> &delnodes
);
256 void meminfo(int &mem_width
, int &mem_size
, int &addr_bits
);
258 // additional functionality for evaluating constant functions
259 struct varinfo_t
{ RTLIL::Const val
; int offset
; bool is_signed
; };
260 bool has_const_only_constructs(bool &recommend_const_eval
);
261 void replace_variables(std::map
<std::string
, varinfo_t
> &variables
, AstNode
*fcall
);
262 AstNode
*eval_const_function(AstNode
*fcall
);
263 bool is_simple_const_expr();
264 std::string
process_format_str(const std::string
&sformat
, int next_arg
, int stage
, int width_hint
, bool sign_hint
);
266 // create a human-readable text representation of the AST (for debugging)
267 void dumpAst(FILE *f
, std::string indent
) const;
268 void dumpVlog(FILE *f
, std::string indent
) const;
270 // used by genRTLIL() for detecting expression width and sign
271 void detectSignWidthWorker(int &width_hint
, bool &sign_hint
, bool *found_real
= NULL
);
272 void detectSignWidth(int &width_hint
, bool &sign_hint
, bool *found_real
= NULL
);
274 // create RTLIL code for this AST node
275 // for expressions the resulting signal vector is returned
276 // all generated cell instances, etc. are written to the RTLIL::Module pointed to by AST_INTERNAL::current_module
277 RTLIL::SigSpec
genRTLIL(int width_hint
= -1, bool sign_hint
= false);
278 RTLIL::SigSpec
genWidthRTLIL(int width
, const dict
<RTLIL::SigBit
, RTLIL::SigBit
> *new_subst_ptr
= NULL
);
281 bool operator==(const AstNode
&other
) const;
282 bool operator!=(const AstNode
&other
) const;
283 bool contains(const AstNode
*other
) const;
285 // helper functions for creating AST nodes for constants
286 static AstNode
*mkconst_int(uint32_t v
, bool is_signed
, int width
= 32);
287 static AstNode
*mkconst_bits(const std::vector
<RTLIL::State
> &v
, bool is_signed
, bool is_unsized
);
288 static AstNode
*mkconst_bits(const std::vector
<RTLIL::State
> &v
, bool is_signed
);
289 static AstNode
*mkconst_str(const std::vector
<RTLIL::State
> &v
);
290 static AstNode
*mkconst_str(const std::string
&str
);
292 // helper function for creating sign-extended const objects
293 RTLIL::Const
bitsAsConst(int width
, bool is_signed
);
294 RTLIL::Const
bitsAsConst(int width
= -1);
295 RTLIL::Const
bitsAsUnsizedConst(int width
);
296 RTLIL::Const
asAttrConst();
297 RTLIL::Const
asParaConst();
298 uint64_t asInt(bool is_signed
);
299 bool bits_only_01() const;
302 // helper functions for real valued const eval
303 int isConst() const; // return '1' for AST_CONSTANT and '2' for AST_REALVALUE
304 double asReal(bool is_signed
);
305 RTLIL::Const
realAsConst(int width
);
308 void allocateDefaultEnumValues();
311 // process an AST tree (ast must point to an AST_DESIGN node) and generate RTLIL code
312 void process(RTLIL::Design
*design
, AstNode
*ast
, bool dump_ast1
, bool dump_ast2
, bool no_dump_ptr
, bool dump_vlog1
, bool dump_vlog2
, bool dump_rtlil
, bool nolatches
, bool nomeminit
,
313 bool nomem2reg
, bool mem2reg
, bool noblackbox
, bool lib
, bool nowb
, bool noopt
, bool icells
, bool pwires
, bool nooverwrite
, bool overwrite
, bool defer
, bool autowire
);
315 // parametric modules are supported directly by the AST library
316 // therefore we need our own derivate of RTLIL::Module with overloaded virtual functions
317 struct AstModule
: RTLIL::Module
{
319 bool nolatches
, nomeminit
, nomem2reg
, mem2reg
, noblackbox
, lib
, nowb
, noopt
, icells
, pwires
, autowire
;
320 ~AstModule() YS_OVERRIDE
;
321 RTLIL::IdString
derive(RTLIL::Design
*design
, const dict
<RTLIL::IdString
, RTLIL::Const
> ¶meters
, bool mayfail
) YS_OVERRIDE
;
322 RTLIL::IdString
derive(RTLIL::Design
*design
, const dict
<RTLIL::IdString
, RTLIL::Const
> ¶meters
, const dict
<RTLIL::IdString
, RTLIL::Module
*> &interfaces
, const dict
<RTLIL::IdString
, RTLIL::IdString
> &modports
, bool mayfail
) YS_OVERRIDE
;
323 std::string
derive_common(RTLIL::Design
*design
, const dict
<RTLIL::IdString
, RTLIL::Const
> ¶meters
, AstNode
**new_ast_out
, bool quiet
= false);
324 void reprocess_module(RTLIL::Design
*design
, const dict
<RTLIL::IdString
, RTLIL::Module
*> &local_interfaces
) YS_OVERRIDE
;
325 RTLIL::Module
*clone() const YS_OVERRIDE
;
326 void loadconfig() const;
329 // this must be set by the language frontend before parsing the sources
330 // the AstNode constructor then uses current_filename and get_line_num()
331 // to initialize the filename and linenum properties of new nodes
332 extern std::string current_filename
;
333 extern void (*set_line_num
)(int);
334 extern int (*get_line_num
)();
336 // set set_line_num and get_line_num to internal dummy functions (done by simplify() and AstModule::derive
337 // to control the filename and linenum properties of new nodes not generated by a frontend parser)
338 void use_internal_line_num();
340 // call a DPI function
341 AstNode
*dpi_call(const std::string
&rtype
, const std::string
&fname
, const std::vector
<std::string
> &argtypes
, const std::vector
<AstNode
*> &args
);
343 // Helper functions related to handling SystemVerilog interfaces
344 std::pair
<std::string
,std::string
> split_modport_from_type(std::string name_type
);
345 AstNode
* find_modport(AstNode
*intf
, std::string name
);
346 void explode_interface_port(AstNode
*module_ast
, RTLIL::Module
* intfmodule
, std::string intfname
, AstNode
*modport
);
349 namespace AST_INTERNAL
351 // internal state variables
352 extern bool flag_dump_ast1
, flag_dump_ast2
, flag_no_dump_ptr
, flag_dump_rtlil
, flag_nolatches
, flag_nomeminit
;
353 extern bool flag_nomem2reg
, flag_mem2reg
, flag_lib
, flag_noopt
, flag_icells
, flag_pwires
, flag_autowire
;
354 extern AST::AstNode
*current_ast
, *current_ast_mod
;
355 extern std::map
<std::string
, AST::AstNode
*> current_scope
;
356 extern const dict
<RTLIL::SigBit
, RTLIL::SigBit
> *genRTLIL_subst_ptr
;
357 extern RTLIL::SigSpec ignoreThisSignalsInInitial
;
358 extern AST::AstNode
*current_always
, *current_top_block
, *current_block
, *current_block_child
;
359 extern AST::AstModule
*current_module
;
360 extern bool current_always_clocked
;
361 struct LookaheadRewriter
;
362 struct ProcessGenerator
;