attr.c File Reference

#include <stdio.h>
#include "assertion.h"
#include "attr.h"
#include "defines.h"
#include "expr.h"
#include "func_unit.h"
#include "profiler.h"
#include "util.h"

Functions
attr_param *	attribute_create (const char *name, expression *expr)
	Creates new attribute parameter based on specified values.
void	attribute_parse (attr_param *ap, int line, const func_unit *funit, bool exclude)
	Parses and handles specified attribute parameter list.
void	attribute_dealloc (attr_param *ap)
	Deallocates entire attribute parameter list.

---

Detailed Description

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

10/25/2003

What is an attribute?

An attribute is a Verilog-2001 syntatical feature that allows meta-comment-like information to be stored in a Verilog file which can be used by any tool that is capable of implementing its functionality. It uses the syntax (* ... *) which may be placed before just about any Verilog construct within a design. Covered is able to parse attributes, implementing its functionality for all Covered-defined attribute commands. Currently covered can parse the following attribute commands:

1. covered_fsm - Allows FSM-specific coverage information to be embedded within a design file
2. covered_assert - Allows assertion coverage information to be embedded within a design file

---

Function Documentation

attr_param* attribute_create	(	const char *	name,
		expression *	expr
	)

Creates new attribute parameter based on specified values.

Returns:

Returns a pointer to the newly allocated/initialized attribute parameter.

Allocates and initializes an attribute parameter entry.

Parameters:

	name	String identifier of this attribute parameter
	expr	Pointer to the expression assigned to the parameter identifier

References attr_param_s::expr, attr_param_s::index, malloc_safe, attr_param_s::name, attr_param_s::next, attr_param_s::prev, PROFILE, PROFILE_END, and strdup_safe.

Referenced by db_create_attr_param().

  { PROFILE(ATTRIBUTE_CREATE);

  attr_param* ap;  /* Pointer to newly allocated attribute parameter */

  ap        = (attr_param*)malloc_safe( sizeof( attr_param ) );
  ap->name  = strdup_safe( name );
  ap->expr  = expr;
  ap->index = 0;
  ap->next  = NULL;
  ap->prev  = NULL;

  PROFILE_END;

  return( ap );

}

void attribute_dealloc

(

attr_param *

ap

)

Deallocates entire attribute parameter list.

Deallocates all memory for the entire attribute parameter list.

Parameters:

ap

Pointer to the attribute parameter list to remove

References attribute_dealloc(), attr_param_s::expr, expression_dealloc(), FALSE, free_safe, attr_param_s::name, attr_param_s::next, PROFILE, and PROFILE_END.

Referenced by attribute_dealloc(), and db_parse_attribute().

  { PROFILE(ATTRIBUTE_DEALLOC);

  if( ap != NULL ) {

    /* Deallocate the next attribute */
    attribute_dealloc( ap->next );

    /* Deallocate the name string */
    free_safe( ap->name, (strlen( ap->name ) + 1) );

    /* Deallocate the expression tree */
    expression_dealloc( ap->expr, FALSE );

    /* Finally, deallocate myself */
    free_safe( ap, sizeof( attr_param ) );

  }

  PROFILE_END;

}

void attribute_parse	(	attr_param *	ap,
		int	line,
		const func_unit *	funit,
		bool	exclude
	)

Parses and handles specified attribute parameter list.

Exceptions:

anonymous

fsm_arg_parse_attr attribute_parse

Parses the attribute parameter list in a recursive fashion. First, we go for the last entry and see if it refers to an attribute that covered should parse. If this attribute is identified by Covered as one of its own, it calls the appropriate function to handle the entire attribute parameter list.

Parameters:

	ap	Pointer to current element of attribute parameter list to parse
	line	First line of attribute
	funit	Pointer to current functional unit containing this attribute
	exclude	If set to 1, sets the exclude bits (if they exist) in the structure created by the attribute

References assertion_parse_attr(), attribute_parse(), fsm_arg_parse_attr(), attr_param_s::name, attr_param_s::next, attr_param_s::prev, PROFILE, and PROFILE_END.

Referenced by attribute_parse(), and db_parse_attribute().

  { PROFILE(ATTRIBUTE_PARSE);

  if( ap != NULL ) {

    if( ap->next != NULL ) {
      attribute_parse( ap->next, line, funit, exclude );
    } else {
      if( strcmp( ap->name, "covered_fsm" ) == 0 ) {
        fsm_arg_parse_attr( ap->prev, line, funit, exclude );
      } else if( strcmp( ap->name, "covered_assert" ) == 0 ) {
        assertion_parse_attr( ap->prev, line, funit, exclude );
      }
    }

  }

  PROFILE_END;

}