info.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include "db.h"
#include "defines.h"
#include "info.h"
#include "link.h"
#include "score.h"
#include "util.h"

Functions
void	score_add_args (const char *arg1, const char *arg2)
	Adds the given argument(s) from the command-line to the score array such that no arguments are duplicated.
void	info_set_vector_elem_size ()
void	info_db_write (FILE *file)
	Writes info line to specified CDD file.
bool	info_db_read (char **line, int read_mode)
	Reads info line from specified line and stores information.
void	args_db_read (char **line)
	Reads score args line from specified line and stores information.
void	message_db_read (char **line)
	Reads user-specified message from specified line and stores information.
void	merged_cdd_db_read (char **line)
	Reads merged CDD information from specified line and stores information.
void	info_dealloc ()
	Deallocates all memory associated with the information section of a database file.
Variables
db **	db_list
unsigned int	curr_db
str_link *	merge_in_head
str_link *	merge_in_tail
int	merge_in_num
char *	merged_file
uint64	num_timesteps
char *	cdd_message
char	user_msg [USER_MSG_LENGTH]
isuppl	info_suppl = {0}
int	cdd_version = CDD_VERSION
char	score_run_path [4096]
str_link *	score_args_head = NULL
str_link *	score_args_tail = NULL

---

Detailed Description

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

2/12/2003

---

Function Documentation

void args_db_read

(

char **

line

)

Reads score args line from specified line and stores information.

Exceptions:

anonymous

Throw

Reads score command-line args line from specified string and stores its information.

Parameters:

line

Pointer to string containing information line to parse

References FATAL, print_output(), PROFILE, PROFILE_END, score_add_args(), score_run_path, and Throw.

Referenced by db_read().

  { PROFILE(ARGS_DB_READ);

  int  chars_read;  /* Number of characters scanned in from this line */
  char tmp1[4096];  /* Temporary string */
  char tmp2[4096];  /* Temporary string */
  int  arg_num;

  if( sscanf( *line, "%s%n", score_run_path, &chars_read ) == 1 ) {

    *line = *line + chars_read;

    /* Store score command-line arguments */
    while( sscanf( *line, "%d%n", &arg_num, &chars_read ) == 1 ) {
      *line = *line + chars_read;
      if( (arg_num == 1) && (sscanf( *line, "%s%n", tmp1, &chars_read ) == 1) ) {
        score_add_args( tmp1, NULL );
      } else if( (arg_num == 2) && (sscanf( *line, "%s (%[^)])%n", tmp1, tmp2, &chars_read ) == 2) ) {
        score_add_args( tmp1, tmp2 );
      }
      *line = *line + chars_read;
    }

  } else {

    print_output( "CDD file being read is incompatible with this version of Covered", FATAL, __FILE__, __LINE__ );
    Throw 0;

  }

  PROFILE_END;

}

bool info_db_read	(	char **	line,
		int	read_mode
	)

Reads info line from specified line and stores information.

Exceptions:

anonymous

Throw Throw Throw

Returns:

Returns TRUE if the CDD file read should continue; otherwise, stop reading in the current CDD.

Reads information line from specified string, stores its information, and creates a new database in the database list.

Parameters:

	line	Pointer to string containing information line to parse
	read_mode	Type of read being performed

References isuppl_u::all, CDD_VERSION, curr_db, db_create(), FALSE, FATAL, db_s::leading_hier_num, db_s::leading_hierarchies, db_s::leading_hiers_differ, merge_in_num, num_timesteps, isuppl_u::part, print_output(), PROFILE, PROFILE_END, READ_MODE_MERGE_NO_MERGE, realloc_safe, isuppl_u::scored, strdup_safe, Throw, and TRUE.

Referenced by db_read().

  { PROFILE(INFO_DB_READ);

  int          chars_read;  /* Number of characters scanned in from this line */
  unsigned int version;     /* Contains CDD version from file */
  char         tmp[4096];   /* Temporary string */
  isuppl       info   = info_suppl;
  bool         retval = TRUE;
  bool         scored;

  /* Save off original scored value */
  scored = info_suppl.part.scored;

  if( sscanf( *line, "%x%n", &version, &chars_read ) == 1 ) {

    *line = *line + chars_read;

    if( version != CDD_VERSION ) {
      print_output( "CDD file being read is incompatible with this version of Covered", FATAL, __FILE__, __LINE__ );
      Throw 0;
    }

    /*@-formattype -formatcode -duplicatequals@*/
    if( sscanf( *line, "%x %" FMT64 "u %s%n", &(info.all), &num_timesteps, tmp, &chars_read ) == 3 ) {
    /*@=formattype =formatcode =duplicatequals@*/

      *line = *line + chars_read;

      /* If this CDD contains useful information, continue on */
      if( (info.part.scored != 0) || (read_mode != READ_MODE_MERGE_NO_MERGE) ) {

        /* Create a new database element */
        (void)db_create();

        /* Set leading_hiers_differ to TRUE if this is not the first hierarchy and it differs from the first */
        if( (db_list[curr_db]->leading_hier_num > 0) && (strcmp( db_list[curr_db]->leading_hierarchies[0], tmp ) != 0) ) {
          db_list[curr_db]->leading_hiers_differ = TRUE;
        }

        /* Assign this hierarchy to the leading hierarchies array */
        db_list[curr_db]->leading_hierarchies = (char**)realloc_safe( db_list[curr_db]->leading_hierarchies, (sizeof( char* ) * db_list[curr_db]->leading_hier_num), (sizeof( char* ) * (db_list[curr_db]->leading_hier_num + 1)) );
        db_list[curr_db]->leading_hierarchies[db_list[curr_db]->leading_hier_num] = strdup_safe( tmp );
        db_list[curr_db]->leading_hier_num++;

        /* Save off the info supplemental information */
        info_suppl.all = info.all;

        /* Set scored flag to correct value */
        if( info.part.scored == 0 ) {
          info_suppl.part.scored = scored;
        }

      } else {

        merge_in_num--;
        retval = FALSE;

      }

    } else {

      print_output( "CDD file being read is incompatible with this version of Covered", FATAL, __FILE__, __LINE__ );
      Throw 0;

    }

  } else {

    print_output( "CDD file being read is incompatible with this version of Covered", FATAL, __FILE__, __LINE__ );
    Throw 0;

  }

  PROFILE_END;

  return( retval );

}

void info_db_write

(

FILE *

file

)

Writes info line to specified CDD file.

Writes information line to specified file.

Parameters:

file

Pointer to file to write information to

References isuppl_u::all, cdd_message, CDD_VERSION, curr_db, DB_TYPE_INFO, DB_TYPE_MERGED_CDD, DB_TYPE_MESSAGE, DB_TYPE_SCORE_ARGS, info_set_vector_elem_size(), db_s::leading_hierarchies, merge_in_num, merged_file, str_link_s::next, num_timesteps, PROFILE, PROFILE_END, score_run_path, str_link_s::str, str_link_s::str2, and str_link_s::suppl.

Referenced by db_write().

  { PROFILE(INFO_DB_WRITE);

  str_link* arg;

  assert( db_list[curr_db]->leading_hier_num > 0 );

  /* Calculate vector element size */
  info_set_vector_elem_size();

  /*@-formattype -formatcode -duplicatequals@*/
  fprintf( file, "%d %x %x %" FMT64 "u %s\n",
           DB_TYPE_INFO,
           CDD_VERSION,
           info_suppl.all,
           num_timesteps,
           db_list[curr_db]->leading_hierarchies[0] );
  /*@=formattype =formatcode =duplicatequals@*/

  /* Display score arguments */
  fprintf( file, "%d %s", DB_TYPE_SCORE_ARGS, score_run_path );

  arg = score_args_head;
  while( arg != NULL ) {
    if( arg->str2 != NULL ) {
      fprintf( file, " 2 %s (%s)", arg->str, arg->str2 );
    } else {
      fprintf( file, " 1 %s", arg->str );
    }
    arg = arg->next;
  }

  fprintf( file, "\n" );

  /* Display the CDD message, if there is one */
  if( cdd_message != NULL ) {
    fprintf( file, "%d %s\n", DB_TYPE_MESSAGE, cdd_message );
  }

  /* Display the merged CDD information, if there are any */
  if( db_list[curr_db]->leading_hier_num == merge_in_num ) {
    str_link*    strl = merge_in_head;
    unsigned int i    = 0;
    while( strl != NULL ) {
      if( strl->suppl < 2 ) {
        if( ((merged_file == NULL) || (strcmp( strl->str, merged_file ) != 0)) && (strl->suppl == 1) ) {
          fprintf( file, "%d %s %s\n", DB_TYPE_MERGED_CDD, strl->str, db_list[curr_db]->leading_hierarchies[i++] );
        } else {
          i++;
        }
      }
      strl = strl->next; 
    }
  } else { 
    str_link*    strl = merge_in_head;
    unsigned int i    = 1; 
    assert( (db_list[curr_db]->leading_hier_num - 1) == merge_in_num );
    while( strl != NULL ) {
      if( strl->suppl < 2 ) {
        if( ((merged_file == NULL) || (strcmp( strl->str, merged_file ) != 0)) && (strl->suppl == 1) ) {
          fprintf( file, "%d %s %s\n", DB_TYPE_MERGED_CDD, strl->str, db_list[curr_db]->leading_hierarchies[i++] );
        } else {
          i++;
        }
      }
      strl = strl->next;
    }
  }

  PROFILE_END;

}

void info_dealloc

(

)

Deallocates all memory associated with the information section of a database file.

Deallocates all memory associated with the database information section. Needs to be called when the database is closed.

References cdd_message, free_safe, merge_in_num, PROFILE, PROFILE_END, and str_link_delete_list().

Referenced by db_close().

                    { PROFILE(INFO_DEALLOC);

  str_link_delete_list( score_args_head );
  score_args_head = NULL;
  score_args_tail = NULL;

  /* Free merged arguments */
  str_link_delete_list( merge_in_head );
  merge_in_head = NULL;
  merge_in_tail = NULL;
  merge_in_num  = 0;

  /* Free user message */
  free_safe( cdd_message, (strlen( cdd_message ) + 1) );
  cdd_message = NULL;

  PROFILE_END;

}

void info_set_vector_elem_size

(

)

Sets the vector element size in the global info_suppl structure based on the current machine unsigned long byte size.

References FATAL, isuppl_u::part, print_output(), PROFILE, PROFILE_END, Throw, and isuppl_u::vec_ul_size.

Referenced by info_db_write().

                                 { PROFILE(INFO_SET_VECTOR_ELEM_SIZE);

  switch( sizeof( ulong ) ) {
    case 1 :  info_suppl.part.vec_ul_size = 0;  break;
    case 2 :  info_suppl.part.vec_ul_size = 1;  break;
    case 4 :  info_suppl.part.vec_ul_size = 2;  break;
    case 8 :  info_suppl.part.vec_ul_size = 3;  break;
    default:
      print_output( "Unsupported unsigned long size", FATAL, __FILE__, __LINE__ );
      Throw 0;
      /*@-unreachable@*/
      break;
      /*@=unreachable@*/
  }

  PROFILE_END;

}

void merged_cdd_db_read

(

char **

line

)

Reads merged CDD information from specified line and stores information.

Parses given line for merged CDD information and stores this information in the appropriate global variables.

Parameters:

line

Pointer to string containing merged CDD line to parse

References curr_db, FATAL, free_safe, get_relative_path(), db_s::leading_hier_num, db_s::leading_hierarchies, db_s::leading_hiers_differ, merge_in_num, print_output(), PROFILE, PROFILE_END, realloc_safe, str_link_add(), str_link_find(), strdup_safe, str_link_s::suppl, Throw, TRUE, user_msg, and USER_MSG_LENGTH.

Referenced by db_read().

  { PROFILE(MERGED_CDD_DB_READ);

  char tmp1[4096];  /* Temporary string */
  char tmp2[4096];  /* Temporary string */
  int  chars_read;  /* Number of characters read */

  if( sscanf( *line, "%s %s%n", tmp1, tmp2, &chars_read ) == 2 ) {

    *line = *line + chars_read;

    /* Add merged file */
    if( str_link_find( tmp1, merge_in_head) == NULL ) {

      str_link* strl = str_link_add( strdup_safe( tmp1 ), &merge_in_head, &merge_in_tail );
      strl->suppl = 1;
      merge_in_num++;

      /* Set leading_hiers_differ to TRUE if this is not the first hierarchy and it differs from the first */
      if( strcmp( db_list[curr_db]->leading_hierarchies[0], tmp2 ) != 0 ) {
        db_list[curr_db]->leading_hiers_differ = TRUE;
      }

      /* Add its hierarchy */
      db_list[curr_db]->leading_hierarchies = (char**)realloc_safe( db_list[curr_db]->leading_hierarchies, (sizeof( char* ) * db_list[curr_db]->leading_hier_num), (sizeof( char* ) * (db_list[curr_db]->leading_hier_num + 1)) );
      db_list[curr_db]->leading_hierarchies[db_list[curr_db]->leading_hier_num] = strdup_safe( tmp2 );
      db_list[curr_db]->leading_hier_num++;

    } else if( merge_in_num > 0 ) {

      char* file = get_relative_path( tmp1 );
      unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "File %s in CDD file has been specified on the command-line", file );
      assert( rv < USER_MSG_LENGTH );
      free_safe( file, (strlen( file ) + 1) );
      print_output( user_msg, FATAL, __FILE__, __LINE__ );
      Throw 0;

    }

  } else {

    print_output( "CDD file being read is incompatible with this version of Covered", FATAL, __FILE__, __LINE__ );
    Throw 0;

  }

  PROFILE_END;

}

void message_db_read

(

char **

line

)

Reads user-specified message from specified line and stores information.

Read user-specified message from specified string and stores its information.

Parameters:

line

Pointer to string containing information line to parse

References cdd_message, PROFILE, PROFILE_END, and strdup_safe.

Referenced by db_read().

  { PROFILE(MESSAGE_DB_READ);

  /* All we need to do is copy the message */
  if( (cdd_message == NULL) && (strlen( *line + 1 ) > 0) ) {
    cdd_message = strdup_safe( *line + 1 );
  }

  PROFILE_END;

}

void score_add_args	(	const char *	arg1,
		const char *	arg2
	)

Adds the given argument(s) from the command-line to the score array such that no arguments are duplicated.

Adds the specified argument to the list of score arguments that will be written to the CDD file.

Parameters:

	arg1	First argument from score command
	arg2	Second argument from score command

References FALSE, str_link_s::next, PROFILE, str_link_s::str, str_link_s::str2, str_link_add(), strdup_safe, and TRUE.

Referenced by args_db_read(), and score_parse_args().

  { PROFILE(SCORE_ADD_ARGS);

  str_link* arg    = score_args_head;
  bool      done   = FALSE;
  bool      nondup = ((strncmp( arg1, "-vpi", 4 ) == 0) ||
                      (strncmp( arg1, "-lxt", 4 ) == 0) ||
                      (strncmp( arg1, "-fst", 4 ) == 0) ||
                      (strncmp( arg1, "-vcd", 4 ) == 0) ||
                      (strncmp( arg1, "-t",   2 ) == 0) ||
                      (strncmp( arg1, "-i",   2 ) == 0) ||
                      (strncmp( arg1, "-o",   2 ) == 0));

  while( !done ) {

    /* Check to see if the specified arguments already exist */
    while( (arg != NULL) && (strcmp( arg->str, arg1 ) != 0) ) {
      arg = arg->next;
    }

    /* If the argument doesn't exist, just add it and be done */
    if( arg == NULL ) {
      arg = str_link_add( strdup_safe( arg1 ), &score_args_head, &score_args_tail );
      if( arg2 != NULL ) {
        arg->str2 = strdup_safe( arg2 );
      }
      done = TRUE;

    /* If the first option exists and its either a non-duplicatible option or it already exists, be done */
    } else if( nondup || ((arg2 != NULL) && (strcmp( arg2, arg->str2 ) == 0)) ) {
      done = TRUE;

    /* Otherwise, advance the arg pointer */
    } else {
      arg = arg->next;
    }

  }

}

---

Variable Documentation

char* cdd_message

User-supplied message to include in the CDD database

Referenced by info_db_write(), info_dealloc(), merge_parse_args(), message_db_read(), report_print_header(), and score_parse_args().

int cdd_version = CDD_VERSION

Contains the CDD version number of all CDD files that this version of Covered can write and read.

unsigned int curr_db

Index of current database in db_list array that is being handled.

db** db_list

Array of database pointers storing all currently loaded databases.

isuppl info_suppl = {0}

Informational line for the CDD file.

str_link* merge_in_head

Pointer to head of list containing names of the input CDD files.

int merge_in_num

Specifies the number of merged CDD files.

Referenced by info_db_read(), info_db_write(), info_dealloc(), merge_check(), and merged_cdd_db_read().

str_link* merge_in_tail

Pointer to tail of list containing names of the input CDD files.

char* merged_file

Specifies the output filename of the CDD file that contains the merged data.

Referenced by command_merge(), info_db_write(), merge_check(), and merge_parse_args().

uint64 num_timesteps

Specifies the number of timesteps that have transpired during this simulation.

str_link* score_args_head = NULL

Pointer to the head of the score arguments list.

str_link* score_args_tail = NULL

Pointer to the tail of the score arguments list.

char score_run_path[4096]

Specifes the pathname where the score command was originally run from.

Referenced by args_db_read(), info_db_write(), and score_parse_args().

char user_msg[USER_MSG_LENGTH]

Holds some output that will be displayed via the print_output command. This is created globally so that memory does not need to be reallocated for each function that wishes to use it.