sc_flops.h

/*
  This file is part of the SC Library.
  The SC Library provides support for parallel scientific applications.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
 
  The SC Library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  The SC Library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with the SC Library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/
 
#ifndef SC_FLOPS_H
#define SC_FLOPS_H
 
#include <sc.h>
 
SC_EXTERN_C_BEGIN;
 
typedef struct sc_flopinfo
{
  double              seconds;  /* current time from sc_MPI_Wtime */
 
  /* these variables measure onward from from sc_flops_start */
  double              cwtime;   /* cumulative wall time */
  float               crtime;   /* cumulative real time */
  float               cptime;   /* cumulative process time */
  long long           cflpops;  /* cumulative floating point operations */
 
  /* measure since sc_flops_start or the previous sc_flops_count */
  double              iwtime;   /* interval wall time */
  float               irtime;   /* interval real time */
  float               iptime;   /* interval process time */
  long long           iflpops;  /* interval floating point operations */
  float               mflops;   /* MFlop/s rate in this interval */
 
  /* without SC_PAPI only seconds, ?wtime and ?rtime are meaningful */
  int                 use_papi;
}
sc_flopinfo_t;
 
void                sc_flops_papi (float *rtime, float *ptime,
                                   long long *flpops, float *mflops);
 
void                sc_flops_start (sc_flopinfo_t * fi);
 
void                sc_flops_start_nopapi (sc_flopinfo_t * fi);
 
void                sc_flops_count (sc_flopinfo_t * fi);
 
void                sc_flops_snap (sc_flopinfo_t * fi,
                                   sc_flopinfo_t * snapshot);
 
void                sc_flops_shot (sc_flopinfo_t * fi,
                                   sc_flopinfo_t * snapshot);
 
void                sc_flops_shotv (sc_flopinfo_t * fi, ...);
 
#define SC_FUNC_SNAP(stat,flop,snap)              \
  do {                                            \
    if (!sc_statistics_has ((stat), __func__)) {  \
      sc_statistics_add_empty ((stat), __func__); \
    }                                             \
    sc_flops_snap ((flop), (snap));               \
  } while (0)
 
#define SC_FUNC_SHOT(stat,flop,snap)                             \
  do {                                                           \
    sc_flops_shot ((flop), (snap));                              \
    sc_statistics_accumulate ((stat), __func__, (snap)->iwtime); \
  } while (0)
 
SC_EXTERN_C_END;
 
#endif /* !SC_FLOPS_H */