report.h File Reference

Contains functions for report command. More...

Go to the source code of this file.

Functions
void	command_report (int argc, int last_arg, const char **argv)
	Parses command-line for report command and performs report functionality.
void	report_gather_instance_stats (funit_inst *root)
	Recursively gathers instance statistics in each instance structure.
void	report_print_header (FILE *ofile)
	Prints header of report.
bool	report_parse_args (int argc, int last_arg, const char **argv)
	Parses arguments on report command command-line.
void	report_read_cdd_and_ready (const char *ifile)
	Reads the CDD and readies the design for reporting.
void	report_close_cdd ()
	Closes the currently loaded CDD.
void	report_save_cdd (const char *filename)
	Saves the currently loaded CDD as the specified filename.
void	report_output_exclusion_reason (FILE *ofile, int leading_spaces, const char *msg, bool header)
	Outputs the given exclusion reason to the given output stream.

---

Detailed Description

Contains functions for report command.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

11/29/2001

---

Function Documentation

void command_report	(	int	argc,
		int	last_arg,
		const char **	argv
	)

Parses command-line for report command and performs report functionality.

Performs report command functionality.

Parameters:

	argc	Number of arguments in report command-line
	last_arg	Index of last parsed argument from list
	argv	Arguments passed to report command to parse

References bind_perform(), Catch_anonymous, COVERED_HEADER, db_close(), db_read(), FALSE, FATAL, free_safe, HEADER, input_db, interp, malloc_safe, output_file, print_output(), PROFILE, PROFILE_END, READ_MODE_REPORT_MOD_MERGE, READ_MODE_REPORT_NO_MERGE, report_generate(), report_gui, report_instance, report_parse_args(), strdup_safe, Throw, TRUE, Try, user_msg, and USER_MSG_LENGTH.

Referenced by main().

  { PROFILE(COMMAND_REPORT);

  FILE*        ofile           = NULL;  /* Pointer to output stream */
#ifdef HAVE_TCLTK
  char*        covered_home    = NULL;  /* Pathname to Covered's home installation directory */
  char*        covered_browser = NULL;  /* Name of browser to use for GUI help pages */
  char*        covered_version = NULL;  /* String version of current Covered version */
  char*        main_file       = NULL;  /* Name of main TCL file to interpret */ 
  char*        user_home;               /* HOME environment variable */
#endif
  unsigned int rv;                      /* Return value from snprintf calls */
  bool         error           = FALSE;
  bool         help_found      = FALSE;

  /* Output header information */
  rv = snprintf( user_msg, USER_MSG_LENGTH, COVERED_HEADER );
  assert( rv < USER_MSG_LENGTH );
  print_output( user_msg, HEADER, __FILE__, __LINE__ );

  Try {

    /* Parse score command-line */
    if( !report_parse_args( argc, last_arg, argv ) ) {

      if( !report_gui ) {

        /* Open database file for reading */
        if( input_db == NULL ) {

          unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Database file not specified in command line" );
          assert( rv < USER_MSG_LENGTH );
          print_output( user_msg, FATAL, __FILE__, __LINE__ );
          Throw 0;

        } else {

          /* Read in CDD file */
          (void)db_read( input_db, (report_instance ? READ_MODE_REPORT_NO_MERGE : READ_MODE_REPORT_MOD_MERGE) );

          /* Perform binding */
          bind_perform( TRUE, 0 );

          Try {

            /* Open output stream */
            if( output_file != NULL ) {
              ofile = fopen( output_file, "w" );
              assert( ofile != NULL );  /* We should have already verified that the file is writable */
            } else {
              ofile = stdout;
            }

            /* Generate report */
            report_generate( ofile );

          } Catch_anonymous {
            if( ofile != stdout ) {
              rv = fclose( ofile );
              assert( rv == 0 );
            }
            Throw 0;
          }

          /* Close output file */
          if( ofile != stdout ) {
            rv = fclose( ofile );
            assert( rv == 0 );
          }

        }

#ifdef HAVE_TCLTK
      } else {

        unsigned int slen;

        Try {

          unsigned int rv;

          /* Initialize the Tcl/Tk interpreter */
          interp = Tcl_CreateInterp();
          assert( interp );

          if( Tcl_Init( interp ) == TCL_ERROR ) {
            printf( "ERROR: %s\n", interp->result );
            Throw 0;
          }

          if( Tk_SafeInit( interp ) == TCL_ERROR ) {
            printf( "ERROR: %s\n", interp->result );
            Throw 0;
          }

          /* Get the COVERED_HOME environment variable */
#ifndef INSTALL_DIR
          if( getenv( "COVERED_HOME" ) == NULL ) {
            print_output( "COVERED_HOME not initialized.  Exiting...", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
          covered_home = strdup_safe( getenv( "COVERED_HOME" ) );
#else
          covered_home = strdup_safe( INSTALL_DIR );
#endif

          /* Get the COVERED_BROWSER environment variable */
#ifndef COVERED_BROWSER
          covered_browser = strdup_safe( getenv( "COVERED_BROWSER" ) );
#else
          covered_browser = strdup_safe( COVERED_BROWSER );
#endif

          covered_version = strdup_safe( VERSION );
          user_home       = getenv( "HOME" );

          /* Initialize TCL */
          tcl_func_initialize( interp, argv[0], user_home, covered_home, covered_version, covered_browser, input_db );

          /* Call the top-level Tcl file */
          slen      = strlen( covered_home ) + 30;
          main_file = (char*)malloc_safe( slen );
          rv        = snprintf( main_file, slen, "%s/scripts/main_view.tcl", covered_home );
          assert( rv < slen );
          rv = Tcl_EvalFile( interp, main_file );
          if( rv != TCL_OK ) {
            rv = snprintf( user_msg, USER_MSG_LENGTH, "TCL/TK: %s\n", Tcl_ErrnoMsg( Tcl_GetErrno() ) );
            assert( rv < USER_MSG_LENGTH );
            print_output( user_msg, FATAL, __FILE__, __LINE__ );
            Throw 0;
          }

          /* Call the main-loop */
          Tk_MainLoop ();

        } Catch_anonymous {
          free_safe( covered_home,    (strlen( covered_home ) + 1) );
          free_safe( main_file,       slen );
          free_safe( covered_browser, (strlen( covered_browser ) + 1) );
          free_safe( covered_version, (strlen( covered_version ) + 1) );
          Throw 0;
        }

        /* Clean Up */
        free_safe( covered_home,    (strlen( covered_home ) + 1) );
        free_safe( main_file,       slen );
        free_safe( covered_browser, (strlen( covered_browser ) + 1) );
        free_safe( covered_version, (strlen( covered_version ) + 1) );
#endif

      }

    }

  } Catch_anonymous {
    error = TRUE;
  }

  free_safe( output_file, (strlen( output_file ) + 1) );
  free_safe( input_db, (strlen( input_db ) + 1) );

  /* Close the database */
  db_close();

  if( error ) {
    Throw 0;
  }

  PROFILE_END;

}

void report_close_cdd

(

)

Closes the currently loaded CDD.

Returns:

Returns TRUE if CDD file was closed properly; otherwise, returns FALSE.

Closes the currently loaded CDD file.

References db_close(), PROFILE, and PROFILE_END.

                        { PROFILE(REPORT_CLOSE_CDD);

  db_close();

  PROFILE_END;

}

void report_gather_instance_stats

(

funit_inst *

root

)

Recursively gathers instance statistics in each instance structure.

Recursively parses instance tree, creating statistic structures for each of the instances in the tree. Calculates summary coverage information for children nodes first and parent nodes after. In this way, the parent nodes will have the accumulated information from themselves and all of their children.

Parameters:

root

Pointer to root of instance tree to search

References statistic_s::arc_excluded, statistic_s::arc_hit, statistic_s::arc_total, statistic_s::assert_excluded, statistic_s::assert_hit, isuppl_u::assert_ovl, statistic_s::assert_total, assertion_get_stats(), funit_inst_s::child_head, statistic_s::comb_excluded, statistic_s::comb_hit, statistic_s::comb_total, combination_get_stats(), flag_suppress_empty_funits, fsm_get_stats(), func_unit_s::fsm_head, funit_inst_s::funit, statistic_s::line_excluded, line_get_stats(), statistic_s::line_hit, statistic_s::line_total, statistic_s::mem_ae_total, statistic_s::mem_cov_found, statistic_s::mem_excluded, statistic_s::mem_rd_hit, statistic_s::mem_tog01_hit, statistic_s::mem_tog10_hit, statistic_s::mem_tog_total, statistic_s::mem_wr_hit, memory_get_stats(), funit_inst_s::next, ovl_is_assertion_module(), isuppl_u::part, PROFILE, PROFILE_END, race_get_stats(), func_unit_s::race_head, statistic_s::race_total, report_assertion, report_combination, report_fsm, report_gather_instance_stats(), report_line, report_memory, report_race, report_toggle, statistic_s::rtype_total, statistic_s::show, func_unit_s::stat, funit_inst_s::stat, statistic_s::state_hit, statistic_s::state_total, statistic_create(), statistic_is_empty(), statistic_s::tog01_hit, statistic_s::tog10_hit, statistic_s::tog_cov_found, statistic_s::tog_excluded, statistic_s::tog_total, and toggle_get_stats().

Referenced by rank_read_cdd(), report_gather_instance_stats(), report_generate(), and report_read_cdd_and_ready().

  { PROFILE(REPORT_GATHER_INSTANCE_STATS);

  funit_inst* curr;        /* Pointer to current instance being evaluated */

  /* Create and initialize statistic structure */
  statistic_create( &(root->stat) );

  /* Get coverage results for all children first */
  curr = root->child_head;
  while( curr != NULL ) {
    report_gather_instance_stats( curr );
    curr = curr->next;
  }

  /* If this module is an OVL module or it isn't attached to a functional unit, don't get coverage statistics */
  if( (root->funit != NULL) && ((info_suppl.part.assert_ovl == 0) || !ovl_is_assertion_module( root->funit )) ) {

    /* Get coverage results for this instance */
    if( report_line ) {
      line_get_stats( root->funit,
                      &(root->stat->line_hit),
                      &(root->stat->line_excluded),
                      &(root->stat->line_total) );
    }

    if( report_toggle ) {
      toggle_get_stats( root->funit,
                        &(root->stat->tog01_hit), 
                        &(root->stat->tog10_hit),
                        &(root->stat->tog_excluded),
                        &(root->stat->tog_total), 
                        &(root->stat->tog_cov_found) );
    }

    if( report_combination ) {
      combination_get_stats( root->funit,
                             &(root->stat->comb_hit),
                             &(root->stat->comb_excluded),
                             &(root->stat->comb_total) );
    }

    if( report_fsm ) {
      fsm_get_stats( root->funit->fsm_head,
                     &(root->stat->state_hit),
                     &(root->stat->state_total),
                     &(root->stat->arc_hit),
                     &(root->stat->arc_total),
                     &(root->stat->arc_excluded) );
    }

    if( report_assertion ) {
      assertion_get_stats( root->funit,
                           &(root->stat->assert_hit),
                           &(root->stat->assert_excluded),
                           &(root->stat->assert_total) );
    }

    if( report_memory ) {
      memory_get_stats( root->funit,
                        &(root->stat->mem_wr_hit),
                        &(root->stat->mem_rd_hit),
                        &(root->stat->mem_ae_total),
                        &(root->stat->mem_tog01_hit),
                        &(root->stat->mem_tog10_hit),
                        &(root->stat->mem_tog_total),
                        &(root->stat->mem_excluded),
                        &(root->stat->mem_cov_found) );
    }

    /* Only get race condition statistics for this instance module if the module hasn't been gathered yet */
    if( report_race && (root->funit->stat == NULL) ) {
      statistic_create( &(root->funit->stat) );
      race_get_stats( root->funit->race_head,
                      &(root->funit->stat->race_total),
                      &(root->funit->stat->rtype_total) );
    }

  }

  /* Set show bit */
  if( flag_suppress_empty_funits ) {
    root->stat->show = !statistic_is_empty( root->stat );
  }

  PROFILE_END;

}

void report_output_exclusion_reason	(	FILE *	ofile,
		int	leading_spaces,
		const char *	msg,
		bool	header
	)

Outputs the given exclusion reason to the given output stream.

Outputs the given exclude report message to the specified output stream, handling the appropriate formatting.

Parameters:

	ofile	Output file stream
	leading_spaces	Number of leading spaces (for formatting purposes)
	msg	Message to display (no newlines and only one space between each word)
	header	If set to TRUE, display a header before outputting; otherwise, avoid the header

References free_safe, gen_char_string(), line_width, malloc_safe, PROFILE, PROFILE_END, and strdup_safe.

Referenced by combination_list_missed(), exclude_print_exclusion(), exclude_resolve_reason(), fsm_display_arc_verbose(), line_display_verbose(), memory_display_verbose(), ovl_display_verbose(), report_print_header(), and toggle_display_verbose().

  { PROFILE(REPORT_OUTPUT_EXCLUSION_REASON);

  char* msg_cpy;
  char* msg_tcpy;
  char* lead_sp;
  int   curr_width;
  char* word;

  /* Copy the message */
  msg_cpy  = strdup_safe( msg );
  msg_tcpy = msg_cpy;

  /* Allocate and populate the leading spaces string */
  lead_sp = (char*)malloc_safe( leading_spaces + 1 );
  gen_char_string( lead_sp, ' ', leading_spaces );

  /* Output message */
  if( header ) {
    fprintf( ofile, "\n%sReason:  ", lead_sp );
  } else {
    fprintf( ofile, "\n%s", lead_sp );
  }

  curr_width = leading_spaces + 9;
  word       = msg_cpy;
  while( *msg_cpy != '\0' ) {
    /* Get the next token */
    while( (*msg_cpy != '\0') && (*msg_cpy != ' ') ) msg_cpy++;
    if( *msg_cpy == ' ' ) {
      *msg_cpy = '\0';
      msg_cpy++;
    }
    if( (strlen( word ) + curr_width) > line_width ) {
      if( header ) {
        fprintf( ofile, "\n%s         ", lead_sp );
      } else {
        fprintf( ofile, "\n%s", lead_sp );
      }
      curr_width = leading_spaces + 9;
    }
    fprintf( ofile, "%s ", word );
    if( word[strlen(word)-1] == '.' ) {
      fprintf( ofile, " " );
    }
    curr_width += strlen( word ) + 1;
    word = msg_cpy;
  }
  fprintf( ofile, "\n\n" );

  /* Deallocate memory */
  free_safe( msg_tcpy, (strlen( msg ) + 1) );
  free_safe( lead_sp, (strlen( lead_sp ) + 1) );

  PROFILE_END;

}

bool report_parse_args	(	int	argc,
		int	last_arg,
		const char **	argv
	)

Parses arguments on report command command-line.

Returns:

Returns TRUE if the help option was parsed.

Exceptions:

anonymous

Throw Throw Throw Throw Throw Throw Throw Throw

Parses the argument list for options. If a legal option is found for the report command, the appropriate action is taken for that option. If an option is found that is not allowed, an error message is reported to the user and the program terminates immediately.

Parameters:

	argc	Number of arguments in argument list argv
	last_arg	Index of last parsed argument from list
	argv	Argument list passed to this program

References Catch_anonymous, check_option_value(), DEFAULT_LINE_WIDTH, FALSE, FATAL, file_exists(), flag_output_exclusion_ids, flag_suppress_empty_funits, flag_use_line_width, free_safe, input_db, is_legal_filename(), line_width, output_file, print_output(), PROFILE, PROFILE_END, read_command_file(), report_assertion, report_bitwise, report_comb_depth, report_covered, REPORT_DETAILED, report_exclusions, report_gui, report_instance, report_memory, report_parse_args(), report_parse_metrics(), REPORT_SUMMARY, report_usage(), REPORT_VERBOSE, strdup_safe, Throw, TRUE, Try, user_msg, USER_MSG_LENGTH, and WARNING.

Referenced by command_report(), and report_parse_args().

  { PROFILE(REPORT_PARSE_ARGS);

  int  i;  /* Loop iterator */
  bool help_found = FALSE;

  i = last_arg + 1;

  while( (i < argc) && !help_found ) {

    if( strncmp( "-h", argv[i], 2 ) == 0 ) {
 
      report_usage();
      help_found = TRUE;

    } else if( strncmp( "-m", argv[i], 2 ) == 0 ) {
    
      if( check_option_value( argc, argv, i ) ) {
        i++;
        report_parse_metrics( argv[i] );
      } else {
        Throw 0;
      }

    } else if( strncmp( "-view", argv[i], 5 ) == 0 ) {

#ifdef HAVE_TCLTK
      report_gui        = TRUE;
      report_comb_depth = REPORT_VERBOSE;
      report_assertion  = TRUE;
      report_memory     = TRUE;
#else
      print_output( "The -view option is not available with this build", FATAL, __FILE__, __LINE__ );
      Throw 0;
#endif

    } else if( strncmp( "-i", argv[i], 2 ) == 0 ) {

      report_instance = TRUE;

    } else if( strncmp( "-c", argv[i], 2 ) == 0 ) {

      report_covered = TRUE;

    } else if( strncmp( "-e", argv[i], 2 ) == 0 ) {

      report_exclusions = TRUE;

    } else if( strncmp( "-d", argv[i], 2 ) == 0 ) {

      if( check_option_value( argc, argv, i ) ) {
        i++;
        if( argv[i][0] == 's' ) {
          report_comb_depth = REPORT_SUMMARY;
        } else if( argv[i][0] == 'd' ) {
          report_comb_depth = REPORT_DETAILED;
        } else if( argv[i][0] == 'v' ) {
          report_comb_depth = REPORT_VERBOSE;
        } else {
          unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Unrecognized detail type: -d %s", argv[i] );
          assert( rv < USER_MSG_LENGTH );
          print_output( user_msg, FATAL, __FILE__, __LINE__ );
          Throw 0;
        }
      } else {
        Throw 0;
      }

    } else if( strncmp( "-o", argv[i], 2 ) == 0 ) {

      if( check_option_value( argc, argv, i ) ) {
        i++;
        if( output_file != NULL ) {
          print_output( "Only one -o option is allowed on the report command-line.  Using first value...", WARNING, __FILE__, __LINE__ );
        } else {
          if( is_legal_filename( argv[i] ) ) {
            output_file = strdup_safe( argv[i] );
          } else {
            unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Output file \"%s\" is unwritable", argv[i] );
            assert( rv < USER_MSG_LENGTH );
            print_output( user_msg, FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        }
      } else {
        Throw 0;
      }

    } else if( strncmp( "-w", argv[i], 2 ) == 0 ) {

      flag_use_line_width = TRUE;

      /* Check to see if user specified a line width value */
      if( ((i+1) < argc) && (sscanf( argv[i+1], "%d", &line_width ) == 1) ) {
        i++;
      } else {
        line_width = DEFAULT_LINE_WIDTH;
      }

    } else if( strncmp( "-s", argv[i], 2 ) == 0 ) {

      flag_suppress_empty_funits = TRUE;

    } else if( strncmp( "-b", argv[i], 2 ) == 0 ) {

      report_bitwise = TRUE;

    } else if( strncmp( "-f", argv[i], 2 ) == 0 ) {

      if( check_option_value( argc, argv, i ) ) {
        char**       arg_list = NULL;
        int          arg_num  = 0;
        unsigned int j;
        i++;
        Try {
          read_command_file( argv[i], &arg_list, &arg_num );
          help_found = report_parse_args( arg_num, -1, (const char**)arg_list );
        } Catch_anonymous {
          for( j=0; j<arg_num; j++ ) {
            free_safe( arg_list[j], (strlen( arg_list[j] ) + 1) );
          }
          free_safe( arg_list, (sizeof( char* ) * arg_num) );
          Throw 0;
        }
        for( j=0; j<arg_num; j++ ) {
          free_safe( arg_list[j], (strlen( arg_list[j] ) + 1) );
        }
        free_safe( arg_list, (sizeof( char* ) * arg_num) );
      } else {
        Throw 0;
      }

    } else if( strncmp( "-x", argv[i], 2 ) == 0 ) {

      flag_output_exclusion_ids = TRUE;
 
    } else if( (i + 1) == argc ) {

      if( file_exists( argv[i] ) ) {
     
        input_db = strdup_safe( argv[i] );
 
      } else {

        unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Cannot find %s database file for opening", argv[i] );
        assert( rv < USER_MSG_LENGTH );
        print_output( user_msg, FATAL, __FILE__, __LINE__ );
        Throw 0;

      }

    } else {

      unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Unknown report command option \"%s\".  See \"covered -h\" for more information.", argv[i] );
      assert( rv < USER_MSG_LENGTH );
      print_output( user_msg, FATAL, __FILE__, __LINE__ );
      Throw 0;

    }

    i++;

  }

  if( !help_found ) {

    /*
     If the user has specified the -x and -c (but not -e), we are not going to be outputting exclusion IDs
     because covered items cannot be excluded.  So... we will set flag_output_exclusion_ids to false and
     output a warning message.
    */
    if( flag_output_exclusion_ids && report_covered && !report_exclusions ) {
      flag_output_exclusion_ids = FALSE;
      print_output( "The -x and -c options were specified.  Covered items cannot be excluded so no exclusion IDs will be output.", WARNING, __FILE__, __LINE__ );
    }

  }

  PROFILE_END;

  return( help_found );

}

void report_print_header

(

FILE *

ofile

)

Prints header of report.

Generates generic report header for all reports.

Parameters:

ofile

Pointer to output stream to display report information to

References cdd_message, curr_db, isuppl_u::excl_always, isuppl_u::excl_assign, isuppl_u::excl_final, isuppl_u::excl_init, isuppl_u::excl_pragma, FALSE, flag_output_exclusion_ids, free_safe, get_relative_path(), input_db, str_link_s::next, isuppl_u::part, PROFILE, PROFILE_END, report_comb_depth, REPORT_DETAILED, report_instance, report_output_exclusion_reason(), REPORT_SUMMARY, REPORT_VERBOSE, and str_link_s::str.

Referenced by report_generate().

  { PROFILE(REPORT_PRINT_HEADER);

  int i;  /* Loop iterator */

  switch( report_comb_depth ) {
    case REPORT_SUMMARY  :
      fprintf( ofile, "                            :::::::::::::::::::::::::::::::::::::::::::::::::::::\n" );
      fprintf( ofile, "                            ::                                                 ::\n" );
      fprintf( ofile, "                            ::  Covered -- Verilog Coverage Summarized Report  ::\n" );
      fprintf( ofile, "                            ::                                                 ::\n" );
      fprintf( ofile, "                            :::::::::::::::::::::::::::::::::::::::::::::::::::::\n\n\n" );
      break;
    case REPORT_DETAILED :
      fprintf( ofile, "                             :::::::::::::::::::::::::::::::::::::::::::::::::::\n" );
      fprintf( ofile, "                             ::                                               ::\n" );
      fprintf( ofile, "                             ::  Covered -- Verilog Coverage Detailed Report  ::\n" );
      fprintf( ofile, "                             ::                                               ::\n" );
      fprintf( ofile, "                             :::::::::::::::::::::::::::::::::::::::::::::::::::\n\n\n" );
      break;
    case REPORT_VERBOSE  :
      fprintf( ofile, "                             ::::::::::::::::::::::::::::::::::::::::::::::::::\n" );
      fprintf( ofile, "                             ::                                              ::\n" );
      fprintf( ofile, "                             ::  Covered -- Verilog Coverage Verbose Report  ::\n" );
      fprintf( ofile, "                             ::                                              ::\n" );
      fprintf( ofile, "                             ::::::::::::::::::::::::::::::::::::::::::::::::::\n\n\n" );
      break;
    default              :  break;
  }

  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~   GENERAL INFORMATION   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );

  fprintf( ofile, "* Report generated from CDD file : %s\n\n", input_db );

  /* If the CDD contains a user-supplied message output it here, formatting it as needed. */
  if( cdd_message != NULL ) {
    fprintf( ofile, "* User-supplied CDD message      :\n" );
    report_output_exclusion_reason( ofile, 4, cdd_message, FALSE );
  }

  if( report_instance ) {
    fprintf( ofile, "* Reported by                    : Instance\n\n" );
  } else {
    fprintf( ofile, "* Reported by                    : Module\n\n" );
  }

  if( flag_output_exclusion_ids ) {
    fprintf( ofile, "* Report contains exclusion IDs (value within parenthesis preceding verbose output)\n\n" );
  }

  if( (info_suppl.part.excl_assign == 1) ||
      (info_suppl.part.excl_always == 1) ||
      (info_suppl.part.excl_init   == 1) ||
      (info_suppl.part.excl_final  == 1) ||
      (info_suppl.part.excl_pragma == 1) ) {
    fprintf( ofile, "* CDD file excludes the following block types:\n" );
    if( info_suppl.part.excl_assign == 1 ) {
      fprintf( ofile, "    assign - Continuous Assignments\n" );
    }
    if( info_suppl.part.excl_always == 1 ) {
      fprintf( ofile, "    always - Always Statements\n" );
    }
    if( info_suppl.part.excl_init == 1 ) {
      fprintf( ofile, "    initial - Initial Statements\n" );
    }
    if( info_suppl.part.excl_final == 1 ) {
      fprintf( ofile, "    final - Final Statements\n" );
    }
    if( info_suppl.part.excl_pragma == 1 ) {
      fprintf( ofile, "    pragma - Code surrounded by coverage off/on pragmas\n" );
    }
    fprintf( ofile, "\n" );
  }

  if( merge_in_head != NULL ) {

    if( merge_in_head == merge_in_tail ) {

      char* file;

      fprintf( ofile, "* Report generated from CDD file that was merged from the following files with the following leading hierarchies:\n" );
      fprintf( ofile, "    Filename                                           Leading Hierarchy\n" );
      fprintf( ofile, "    -----------------------------------------------------------------------------------------------------------------\n" );
      fprintf( ofile, "    %-49.49s  %-62.62s\n", input_db,           db_list[curr_db]->leading_hierarchies[0] );
      file = get_relative_path( merge_in_head->str );
      fprintf( ofile, "    %-49.49s  %-62.62s\n", file, db_list[curr_db]->leading_hierarchies[1] ); 
      free_safe( file, (strlen( file ) + 1) );

      if( report_instance && db_list[curr_db]->leading_hiers_differ ) {
        fprintf( ofile, "\n* Merged CDD files contain different leading hierarchies, will use value \"<NA>\" to represent leading hierarchy.\n\n" );
      }

    } else {

      str_link* strl = merge_in_head;

      fprintf( ofile, "* Report generated from CDD file that was merged from the following files:\n" );
      fprintf( ofile, "    Filename                                           Leading Hierarchy\n" );
      fprintf( ofile, "    -----------------------------------------------------------------------------------------------------------------\n" );

      i = 1;
      while( strl != NULL ) {
        char* file = get_relative_path( strl->str );
        fprintf( ofile, "    %-49.49s  %-62.62s\n", file, db_list[curr_db]->leading_hierarchies[i++] );
        free_safe( file, (strlen( file ) + 1) );
        strl = strl->next;
      }

      if( report_instance && db_list[curr_db]->leading_hiers_differ ) {
        fprintf( ofile, "\n* Merged CDD files contain different leading hierarchies, will use value \"<NA>\" to represent leading hierarchy.\n\n" );
      }

    }

    fprintf( ofile, "\n" );

  }

  PROFILE_END;

}

void report_read_cdd_and_ready

(

const char *

ifile

)

Reads the CDD and readies the design for reporting.

Returns:

Returns TRUE if CDD file was read properly; otherwise, returns FALSE.

Exceptions:

anonymous

db_read Throw bind_perform

Reads in specified CDD file and gathers functional unit statistics to get ready for GUI interaction with this CDD file.

Parameters:

ifile

Name of CDD file to read from

References bind_perform(), curr_db, db_read(), db_size, FATAL, funit_head, inst_link_s::inst, db_s::inst_head, inst_link_s::next, print_output(), PROFILE, PROFILE_END, READ_MODE_MERGE_INST_MERGE, READ_MODE_REPORT_MOD_MERGE, READ_MODE_REPORT_NO_MERGE, report_gather_funit_stats(), report_gather_instance_stats(), Throw, and TRUE.

  { PROFILE(REPORT_READ_CDD_AND_READY);

  /* Open database file for reading */
  if( (ifile == NULL) || (ifile[0] == '\0') ) {

    print_output( "CDD file name was not specified for reading", FATAL, __FILE__, __LINE__ );
    Throw 0;

  } else {

    inst_link* instl;
    bool       first = (db_size == 0);

    /* Read in database, performing instance merging */
    curr_db = 0;
    (void)db_read( ifile, (first ? READ_MODE_REPORT_NO_MERGE : READ_MODE_MERGE_INST_MERGE) );
    bind_perform( TRUE, 0 );

    /* Gather instance statistics */
    instl = db_list[0]->inst_head;
    while( instl != NULL ) {
      report_gather_instance_stats( instl->inst );
      instl = instl->next;
    }

    /* Read in database again, performing module merging */
    curr_db = 1;
    (void)db_read( ifile, READ_MODE_REPORT_MOD_MERGE );
    bind_perform( TRUE, 0 );

    /* Now merge functional units and gather module statistics */
    report_gather_funit_stats( db_list[1]->funit_head );

    /* Set the current database back to 0 */
    curr_db = 0;

  }

  PROFILE_END;

}

void report_save_cdd

(

const char *

filename

)

Saves the currently loaded CDD as the specified filename.

Exceptions:

anonymous

db_write

Saves the currently loaded CDD database to the given filename.

Parameters:

filename

Name to use for saving the currently loaded filename

References curr_db, db_write(), FALSE, PROFILE, and PROFILE_END.

  { PROFILE(REPORT_SAVE_CDD);

  /* Write the instance database */
  curr_db = 1;

  db_write( filename, FALSE, FALSE );

  /* Restore the database */
  curr_db = 0;

  PROFILE_END;

}