Skip to content

Verilog: add attributes into parse tree #644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Verilog: add attributes into parse tree #644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/hw_cbmc_irep_ids.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ IREP_ID_ONE(pullup)
IREP_ID_ONE(inst_builtin)
IREP_ID_ONE(pulldown)
IREP_ID_ONE(verilog_attribute)
IREP_ID_ONE(verilog_attributes)
IREP_ID_ONE(task)
IREP_ID_ONE(trior)
IREP_ID_ONE(wor)
Expand Down
122 changes: 89 additions & 33 deletions src/verilog/parser.y
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,25 @@ static void add_as_subtype(typet &dest, typet &what)

/*******************************************************************\

Function: add_attributes

Inputs:

Outputs:

Purpose:

\*******************************************************************/

static void add_attributes(YYSTYPE &dest, YYSTYPE &attributes)
{
PRECONDITION(stack_expr(attributes).id() == ID_verilog_attributes);
if(!stack_expr(attributes).get_sub().empty())
addswap(dest, ID_verilog_attributes, attributes);
Comment on lines +172 to +174
Copy link
Collaborator

@tautschnig tautschnig Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it perhaps be better to use ID_C_verilog_attributes? They seem to be ignored during type checking at this point, so I am guessing they don't affect the semantics?

Copy link
Collaborator Author

@kroening kroening Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe anything with attributes ever gets compared for equality, so it wouldn't make any difference.

The attributes seem to be entirely tool-specific, so there may well be some that have/alter semantics.

I am planning to use them to configure reasoning engines per assertion, but it's not obvious that this is the best mechanism.

}

/*******************************************************************\

Function: yyverilogerror

Inputs:
Expand Down Expand Up @@ -596,7 +615,8 @@ description:
| program_declaration
| package_declaration
| attribute_instance_brace package_item
{ PARSER.parse_tree.create_package_item(stack_expr($2)); }
{ add_attributes($2, $1);
PARSER.parse_tree.create_package_item(stack_expr($2)); }
| attribute_instance_brace bind_directive
| config_declaration
;
Expand Down Expand Up @@ -769,9 +789,12 @@ ansi_port_declaration_brace:
;

port_declaration:
attribute_instance_brace inout_declaration { $$=$2; }
| attribute_instance_brace input_declaration { $$=$2; }
| attribute_instance_brace output_declaration { $$=$2; }
attribute_instance_brace inout_declaration
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace input_declaration
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace output_declaration
{ add_attributes($2, $1); $$=$2; }
;

ansi_port_initializer_opt:
Expand Down Expand Up @@ -858,13 +881,22 @@ module_item_brace:
;

module_or_generate_item:
attribute_instance_brace parameter_override { $$=$2; }
| attribute_instance_brace gate_instantiation { $$=$2; }
// | attribute_instance_brace udp_instantiation { $$=$2; }
| attribute_instance_brace module_instantiation { $$=$2; }
| attribute_instance_brace smv_using { $$ = $2; }
| attribute_instance_brace smv_assume { $$ = $2; }
| attribute_instance_brace module_common_item { $$=$2; }
attribute_instance_brace parameter_override
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace gate_instantiation
{ add_attributes($2, $1); $$=$2; }
// UDP instances have the same syntax
// as module instances; they only differ in the identifier.
// | attribute_instance_brace udp_instantiation
// { add_attributes($2, $1); $$=$2; }
Comment on lines +890 to +891
Copy link
Collaborator

@tautschnig tautschnig Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this always commented out (and still is)?

Copy link
Collaborator Author

@kroening kroening Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The syntax is indistinguishable from the instantiation of normal modules unless a separate token type is used for the identifiers of UDP modules.

Copy link
Collaborator

@tautschnig tautschnig Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps you can document this in source via a comment?

Copy link
Collaborator Author

@kroening kroening Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

| attribute_instance_brace module_instantiation
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace smv_using
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace smv_assume
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace module_common_item
{ add_attributes($2, $1); $$=$2; }
;

module_or_generate_item_declaration:
Expand All @@ -873,16 +905,21 @@ module_or_generate_item_declaration:
;

non_port_module_item:
attribute_instance_brace generate_region { $$=$2; }
attribute_instance_brace generate_region
{ add_attributes($2, $1); $$=$2; }
| module_or_generate_item
| attribute_instance_brace specparam_declaration {$$=$2; }
| attribute_instance_brace specify_block { $$=$2;}
| attribute_instance_brace specparam_declaration
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace specify_block
{ add_attributes($2, $1); $$=$2; }
;

/*
module_or_generate_item
| attribute_instance_brace parameter_declaration { $$=$2; }
// | attribute_instance_brace local_parameter_declaration { $$=$2; }
| attribute_instance_brace parameter_declaration
// { add_attributes($2, $1); $$=$2; }
// | attribute_instance_brace local_parameter_declaration
// { add_attributes($2, $1); $$=$2; }
;
*/
Comment on lines 917 to 924
Copy link
Collaborator

@tautschnig tautschnig Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was/is this commented out?

Copy link
Collaborator Author

@kroening kroening Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not in the 1800-2017 grammar -- will clean out.


Expand All @@ -905,12 +942,18 @@ class_item_brace:
| class_item_brace class_item
;

// classes are yet to be implemented
class_item:
// attribute_instance_brace class_property
// { add_attributes($2, $1); $$=$2; }
// | attribute_instance_brace class_method
// { add_attributes($2, $1); $$=$2; }
// | attribute_instance_brace class_constraint
// { add_attributes($2, $1); $$=$2; }
Comment on lines 947 to +952
Copy link
Collaborator

@tautschnig tautschnig Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was/is this commented out?

Copy link
Collaborator Author

@kroening kroening Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Classes are simply not done yet.

Copy link
Collaborator

@tautschnig tautschnig Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this should be documented?

Copy link
Collaborator Author

@kroening kroening Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

attribute_instance_brace class_declaration
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace covergroup_declaration
{ add_attributes($2, $1); $$=$2; }
| local_parameter_declaration ';'
| parameter_declaration ';'
| ';'
Expand Down Expand Up @@ -1351,7 +1394,10 @@ struct_union_member:
random_qualifier_opt
data_type_or_void
list_of_variable_decl_assignments ';'
{ $$=$4; stack_expr($$).id(ID_decl); addswap($$, ID_type, $3); }
{ $$=$4;
stack_expr($$).id(ID_decl);
addswap($$, ID_type, $3);
add_attributes($$, $1); }
;

enum_base_type_opt:
Expand Down Expand Up @@ -1867,9 +1913,12 @@ tf_item_declaration_brace:

tf_item_declaration:
block_item_declaration
| attribute_instance_brace input_declaration ';' { $$ = $2; }
| attribute_instance_brace output_declaration ';' { $$ = $2; }
| attribute_instance_brace inout_declaration ';' { $$ = $2; }
| attribute_instance_brace input_declaration ';'
{ add_attributes($2, $1); $$ = $2; }
| attribute_instance_brace output_declaration ';'
{ add_attributes($2, $1); $$ = $2; }
| attribute_instance_brace inout_declaration ';'
{ add_attributes($2, $1); $$ = $2; }
;

function_prototype: TOK_FUNCTION data_type_or_void function_identifier
Expand Down Expand Up @@ -1936,6 +1985,7 @@ tf_port_item:
port_identifier
variable_dimension_brace
{ init($$, ID_decl);
add_attributes($$, $1);
addswap($$, ID_class, $2);
addswap($$, ID_type, $3);
stack_expr($4).id(ID_declarator);
Expand All @@ -1953,10 +2003,14 @@ tf_port_direction_opt:
// A.2.8 Block item declarations

block_item_declaration:
attribute_instance_brace data_declaration { $$=$2; }
| attribute_instance_brace local_parameter_declaration ';' { $$=$2; }
| attribute_instance_brace parameter_declaration ';' { $$=$2; }
| attribute_instance_brace let_declaration { $$=$2; }
attribute_instance_brace data_declaration
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace local_parameter_declaration ';'
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace parameter_declaration ';'
{ add_attributes($2, $1); $$=$2; }
| attribute_instance_brace let_declaration
{ add_attributes($2, $1); $$=$2; }
;

// System Verilog standard 1800-2017
Expand Down Expand Up @@ -2933,7 +2987,9 @@ block_item_declaration_or_statement_or_null:

statement_or_null:
statement
| attribute_instance_brace ';' { init($$, ID_skip); }
| attribute_instance_brace ';'
{ init($$, ID_skip);
add_attributes($$, $1); }
;

statement_or_null_brace:
Expand Down Expand Up @@ -3431,13 +3487,13 @@ event_trigger: TOK_MINUSGREATER hierarchical_event_identifier ';'

inc_or_dec_expression:
TOK_PLUSPLUS attribute_instance_brace variable_lvalue
{ init($$, ID_preincrement); mto($$, $3); }
{ init($$, ID_preincrement); mto($$, $3); add_attributes($$, $2); }
| TOK_MINUSMINUS attribute_instance_brace variable_lvalue
{ init($$, ID_predecrement); mto($$, $3); }
{ init($$, ID_predecrement); mto($$, $3); add_attributes($$, $2); }
| variable_lvalue attribute_instance_brace TOK_PLUSPLUS
{ init($$, ID_postincrement); mto($$, $1); }
{ init($$, ID_postincrement); mto($$, $1); add_attributes($$, $2); }
| variable_lvalue attribute_instance_brace TOK_MINUSMINUS
{ init($$, ID_postdecrement); mto($$, $1); }
{ init($$, ID_postdecrement); mto($$, $1); add_attributes($$, $2); }
;

constant_param_expression:
Expand Down Expand Up @@ -3475,7 +3531,7 @@ expression_brace:
expression:
primary
| unary_operator attribute_instance_brace primary
{ $$=$1; mto($$, $3); }
{ $$=$1; mto($$, $3); add_attributes($$, $2); }
| inc_or_dec_expression
| expression "->" expression
{ init($$, ID_implies); mto($$, $1); mto($$, $3); }
Expand Down Expand Up @@ -3670,7 +3726,7 @@ number: unsigned_number

attribute_instance_brace:
/* Optional */
{ init($$, ID_verilog_attribute); }
{ init($$, ID_verilog_attributes); }
| attribute_instance_brace attribute_instance
{ $$=$1;
for(auto &attr : stack_expr($2).get_sub())
Expand All @@ -3690,12 +3746,12 @@ attr_spec_list:
;

attr_spec: attr_name '=' constant_expression
{ init($$, "attribute");
{ init($$, ID_verilog_attribute);
stack_expr($$).add(ID_name).swap(stack_expr($1));
stack_expr($$).add(ID_value).swap(stack_expr($3));
}
| attr_name
{ init($$, "attribute"); stack_expr($$).add(ID_name).swap(stack_expr($1)); }
{ init($$, ID_verilog_attribute); stack_expr($$).add(ID_name).swap(stack_expr($1)); }
;

attr_name: identifier
Expand Down