TABLE OF CONTENTS

1. source/util/tools/profiling
2. profiling/profile_initialize
3. profiling/profile_finalize
4. profiling/profile_start
5. profiling/profile_end
6. profiling/profile_define

source/util/tools/profiling

  profiling

  Stub profiling routines.  Override these routines to create 
  log files to be analysed with profiling software such 
  as jumpshot or vampir. 
  
  To add a new profiling library, the following hooks need 
  to be satisfied:

    profile_initialize() 

    profile_finalize()

    profile_define(module, i)

    profile_start(module, i)

    profile_end(module, i)

profiling/profile_initialize

  profile_initialize

  profile_initialize()

  Stub profiling routine:
  Initialize the profiling library.  This is not used for all
  the different profiling libraries.  This is called once, 
  through timer_init() in perfmon at the start of execution
  of FLASH

profiling/profile_finalize

  profile_finalize

  profile_finalize()

  Stub profiling routine:
  Close the profiling library.  This is called at the end of 
  execution of FLASH, via perfmon_end().  Not every profiling
  library will need to use this routine

profiling/profile_start

  profile_start

  profile_start(module, i)
  profile_start(character(:), integer)

  Stub profiling routine:
  Start profiling the routine specified by the module string.  This
  is called by timer_start, and is used to turn on the profiling
  library for the given module.

  module  module name
  i       integer

profiling/profile_end

  profile_end

  profile_end(module, i)
  profile_end(character(:), integer)

  Stub profiling routine:
  Stop profiling the routine specified by the module string.  This
  is called by timer_stop.

  module  module name
  i       integer

profiling/profile_define

  profile_define

  profile_define(module, i)
  profile_define(character(:), integer)

  Stub profiling routine:
  Define a new profile.  This is needed for certain profiling
  libraries to define a state.  This is called once, via 
  timer_create in the perfmon library.  module is a character
  string giving the name of the FLASH module being profiled.  i
  is a unique integer corresponding to the module name, and cane
  be used as a tag for the different modules in the profiliing
  library

  module  module name
  i       integer