profiler.c File Reference

#include <stdio.h>
#include <assert.h>
#include "profiler.h"

Functions
void	profiler_set_mode (bool value)
	Sets the current profiling mode to the given value.
void	profiler_set_filename (const char *fname)
	Sets the profiling output file to the given value.
void	profiler_enter (unsigned int index)
	Function to be called whenever a new function is entered.
void	profiler_exit (unsigned int index)
	Function to be called whenever a timed function is exited.
static void	profiler_dealloc ()
static void	profiler_sort_by_calls (FILE *ofile)
static void	profiler_sort_by_time (FILE *ofile)
static void	profiler_sort_by_avg_time (FILE *ofile)
void	profiler_report ()
	Output profiler report.
Variables
bool	profiling_mode = TRUE
static char *	profiling_output = NULL
static unsigned int	stack [4096]
static unsigned int	stack_size = 0
char	user_msg [USER_MSG_LENGTH]

---

Detailed Description

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

12/10/2007

---

Function Documentation

static void profiler_dealloc

(

)

[static]

Deallocates all allocated memory for profiler.

References free_safe, NUM_PROFILES, and profiling_output.

Referenced by profiler_report().

                               {

  int i;  /* Loop iterator */

  /* Deallocate profiling output name */
  free_safe( profiling_output, (strlen( profiling_output ) + 1) );

  /* Iterate through the profiler array and deallocate all timer structures */
  for( i=0; i<NUM_PROFILES; i++ ) {
    free_safe( profiles[i].time_in, sizeof( timer ) );
  }

}

void profiler_enter

(

unsigned int

index

)

Function to be called whenever a new function is entered.

Parameters:

index

Profiler index of current function.

Increases the current call count for the current function, stops the timer for the last running counter and starts the timer for the current function.

References stack, and stack_size.

                                          {

  /* Stop the last running timer if we are going to be timed */
  if( (stack_size > 0) && profiles[index].timed && profiles[stack[stack_size-1]].timed ) {
    timer_stop( &profiles[stack[stack_size-1]].time_in );
  }

  /* Increment the calls counter */
  profiles[index].calls++;

  /* Start the timer for this function, if needed */
  if( profiles[index].timed ) {
    timer_start( &profiles[index].time_in );
    stack[stack_size] = index;
    stack_size++;
  }

}

void profiler_exit

(

unsigned int

index

)

Function to be called whenever a timed function is exited.

Gets called when leaving a profiling function. Stops the current timer and pops the stack.

References stack, and stack_size.

                                         {

  /* Stop the current timer */
  timer_stop( &profiles[index].time_in );

  /* Pop the stack */
  stack_size--;

  /* Start the timer, if needed */
  if( (stack_size > 0) && profiles[stack[stack_size-1]].timed ) {
    timer_start( &profiles[stack[stack_size-1]].time_in );
  }

}

void profiler_report

(

)

Output profiler report.

Generates profiling report if the profiling mode is set to TRUE.

References FATAL, free_safe, print_output(), profiler_dealloc(), profiler_sort_by_avg_time(), profiler_sort_by_calls(), profiler_sort_by_time(), profiling_mode, profiling_output, user_msg, and USER_MSG_LENGTH.

Referenced by main().

                       {

  FILE* ofile;  /* File stream pointer to output file */

  if( profiling_mode ) {

    assert( profiling_output != NULL );

    if( (ofile = fopen( profiling_output, "w" )) != NULL ) {

      unsigned int rv;

      /* Stop the simulation timer and deallocate it */
      timer_stop( &sim_timer );

      /* Output profiling results */
      profiler_sort_by_time( ofile );
      profiler_sort_by_avg_time( ofile );
      profiler_sort_by_calls( ofile );

      /* Close the output file */
      rv = fclose( ofile );
      assert( rv == 0 );

    } else {

      unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Unable to open profiling output file \"%s\" for writing", profiling_output );
      assert( rv < USER_MSG_LENGTH );
      print_output( user_msg, FATAL, __FILE__, __LINE__ );

    }

  }

  /* Deallocate sim_timer */
  free_safe( sim_timer, sizeof( timer ) );

  /* Delete memory associated with the profiler */
  profiler_dealloc();

}

void profiler_set_filename

(

const char *

fname

)

Sets the profiling output file to the given value.

Parameters:

fname

Name of output profiling file.

Sets the profiling output file to the given value.

References free_safe, profiling_output, and strdup_safe.

Referenced by covered_sim_calltf(), and main().

                                                {

  /* Deallocate profiling output name, if one was already specified */
  free_safe( profiling_output, (strlen( profiling_output ) + 1) );

  profiling_output = strdup_safe( fname );

}

void profiler_set_mode

(

bool

value

)

Sets the current profiling mode to the given value.

Parameters:

value

New value to set profiling mode to

Sets the current profiling mode to the given value.

References profiling_mode.

Referenced by covered_sim_calltf(), and main().

                                     {

  profiling_mode = value;

#ifdef HAVE_SYS_TIME_H
  if( profiling_mode ) {
    timer_start( &sim_timer );
  }
#endif
    
}

static void profiler_sort_by_avg_time

(

FILE *

ofile

)

[static]

References NUM_PROFILES.

Referenced by profiler_report().

                                                     {

  int largest;             /* Index of largest calls profile */
  int i;                   /* Loop iterator */
  int j;                   /* Loop iterator */
  int list[NUM_PROFILES];  /* List of indices that can be used to sort */
  int tmp;                 /* Used for value swapping */

  /* Prepare a list of key/value pairs */
  for( i=0; i<NUM_PROFILES; i++ ) {
    list[i] = i;
  }

  /* Display header for this section */
  fprintf( ofile, "==============================================================================\n" );
  fprintf( ofile, "=                           Sort by avg. time Profile                        =\n" );
  fprintf( ofile, "==============================================================================\n" );
  fprintf( ofile, "\n" );
  fprintf( ofile, "Total simulation time: %ld\n", (long int)sim_timer->total );
  fprintf( ofile, "\n" );
  fprintf( ofile, "------------------------------------------------------------------------------------------------------\n" );
  fprintf( ofile, "Function Name                               calls       time        avg. time   mallocs     frees\n" );
  fprintf( ofile, "------------------------------------------------------------------------------------------------------\n" );

  /* Output them in order of most to least */
  for( i=(NUM_PROFILES-1); i>=0; i-- ) {
    largest = 0;
    for( j=0; j<i; j++ ) {
      if( (profiles[list[j]].time_in != NULL) &&
          ((profiles[list[largest]].time_in == NULL) ||
           ((profiles[list[j]].time_in->total / profiles[list[j]].calls) > (profiles[list[largest]].time_in->total / profiles[list[largest]].calls))) ) {
        largest = j;
      }
    }
    tmp           = list[j];
    list[j]       = list[largest];
    list[largest] = tmp;
    if( profiles[list[j]].calls > 0 ) {
      if( profiles[list[j]].time_in == NULL ) {
        fprintf( ofile, "  %-40.40s  %10d          NA          NA  %10d  %10d\n",
                 profiles[list[j]].func_name, profiles[list[j]].calls, profiles[list[j]].mallocs, profiles[list[j]].frees );
      } else {
        fprintf( ofile, "  %-40.40s  %10d  %10ld  %10.3f  %10d  %10d\n",
                 profiles[list[j]].func_name, profiles[list[j]].calls, (long int)profiles[list[j]].time_in->total,
                 (float)(profiles[list[j]].time_in->total / (profiles[list[j]].calls * 1.0)), profiles[list[j]].mallocs, profiles[list[j]].frees );
      }
    }
  } 

  fprintf( ofile, "\n\n\n" );
    
}   

static void profiler_sort_by_calls

(

FILE *

ofile

)

[static]

References NUM_PROFILES.

Referenced by profiler_report().

                                                  {

  int largest;             /* Index of largest calls profile */
  int i;                   /* Loop iterator */
  int j;                   /* Loop iterator */
  int list[NUM_PROFILES];  /* List of indices that can be used to sort */
  int tmp;                 /* Used for value swapping */

  /* Prepare a list of key/value pairs */
  for( i=0; i<NUM_PROFILES; i++ ) {
    list[i] = i;
  }

  /* Display header for this section */
  fprintf( ofile, "==============================================================================\n" );
  fprintf( ofile, "=                           Sort by calls Profile                            =\n" );
  fprintf( ofile, "==============================================================================\n" );
  fprintf( ofile, "\n" );
  fprintf( ofile, "Total simulation time: %ld\n", (long int)sim_timer->total );
  fprintf( ofile, "\n" );
  fprintf( ofile, "------------------------------------------------------------------------------------------------------\n" );
  fprintf( ofile, "Function Name                               calls       time        avg. time   mallocs     frees\n" );
  fprintf( ofile, "------------------------------------------------------------------------------------------------------\n" );

  /* Output them in order of most to least */
  for( i=(NUM_PROFILES-1); i>=0; i-- ) {
    largest = 0;
    for( j=0; j<i; j++ ) {
      if( profiles[list[j]].calls > profiles[list[largest]].calls ) {
        largest = j;
      }
    }
    tmp           = list[j];
    list[j]       = list[largest];
    list[largest] = tmp;
    if( profiles[list[j]].calls > 0 ) {
      if( profiles[list[j]].time_in == NULL ) {
        fprintf( ofile, "  %-40.40s  %10d          NA          NA  %10d  %10d\n",
                 profiles[list[j]].func_name, profiles[list[j]].calls, profiles[list[j]].mallocs, profiles[list[j]].frees );
      } else {
        fprintf( ofile, "  %-40.40s  %10d  %10ld  %10.3f  %10d  %10d\n",
                 profiles[list[j]].func_name, profiles[list[j]].calls, (long int)profiles[list[j]].time_in->total,
                 (float)(profiles[list[j]].time_in->total / (profiles[list[j]].calls * 1.0)), profiles[list[j]].mallocs, profiles[list[j]].frees );
      }
    }
  }

  fprintf( ofile, "\n\n\n" );
    
}

static void profiler_sort_by_time

(

FILE *

ofile

)

[static]

References NUM_PROFILES.

Referenced by profiler_report().

                                                 {

  int largest;             /* Index of largest calls profile */
  int i;                   /* Loop iterator */
  int j;                   /* Loop iterator */
  int list[NUM_PROFILES];  /* List of indices that can be used to sort */
  int tmp;                 /* Used for value swapping */

  /* Prepare a list of key/value pairs */
  for( i=0; i<NUM_PROFILES; i++ ) {
    list[i] = i;
  }

  /* Display header for this section */
  fprintf( ofile, "==============================================================================\n" );
  fprintf( ofile, "=                           Sort by time Profile                             =\n" );
  fprintf( ofile, "==============================================================================\n" );
  fprintf( ofile, "\n" );
  fprintf( ofile, "Total simulation time: %ld\n", (long int)sim_timer->total );
  fprintf( ofile, "\n" );
  fprintf( ofile, "------------------------------------------------------------------------------------------------------\n" );
  fprintf( ofile, "Function Name                               calls       time        avg. time   mallocs     frees\n" );
  fprintf( ofile, "------------------------------------------------------------------------------------------------------\n" );

  /* Output them in order of most to least */
  for( i=(NUM_PROFILES-1); i>=0; i-- ) {
    largest = 0;
    for( j=0; j<i; j++ ) {
      if( (profiles[list[j]].time_in != NULL) && ((profiles[list[largest]].time_in == NULL) || (profiles[list[j]].time_in->total > profiles[list[largest]].time_in->total)) ) {
        largest = j;
      }
    }
    tmp           = list[j];
    list[j]       = list[largest];
    list[largest] = tmp;
    if( profiles[list[j]].calls > 0 ) {
      if( profiles[list[j]].time_in == NULL ) {
        fprintf( ofile, "  %-40.40s  %10d          NA          NA  %10d  %10d\n",
                 profiles[list[j]].func_name, profiles[list[j]].calls, profiles[list[j]].mallocs, profiles[list[j]].frees );
      } else {
        fprintf( ofile, "  %-40.40s  %10d  %10ld  %10.3f  %10d  %10d\n",
                 profiles[list[j]].func_name, profiles[list[j]].calls, (long int)profiles[list[j]].time_in->total,
                 (float)(profiles[list[j]].time_in->total / (profiles[list[j]].calls * 1.0)), profiles[list[j]].mallocs, profiles[list[j]].frees );
      }
    }
  } 
    
  fprintf( ofile, "\n\n\n" );
    
}   

---

Variable Documentation

bool profiling_mode = TRUE

Current profiling mode value

Referenced by profiler_report(), and profiler_set_mode().

char* profiling_output = NULL [static]

Name of output profiling file

Referenced by profiler_dealloc(), profiler_report(), and profiler_set_filename().

unsigned int stack[4096] [static]

Stack of profiles that have been called

Referenced by profiler_enter(), and profiler_exit().

unsigned int stack_size = 0 [static]

Current size of the profile stack

Referenced by profiler_enter(), and profiler_exit().

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.