slog.h

MPICH是MPI的重要研究,提供了一系列的接口函数,为并行计算的实现提供了编程环境.

#if ! defined( _SLOG )
#define _SLOG

#ifdef HAVE_SLOG_WINCONFIG_H
#include "slog_winconfig.h"
#endif
#include <stdio.h>
#include "fbuf.h"

/* the high-level API for reading and writing SLOG files */

#define VERSION_MainID    0
#define VERSION_SubID     9

/*
     Define the basic data types used, SLOG_xxx,
     and their printing formats, fmt_xxx, used in fprintf().
*/
typedef  int                 SLOG_int32 ;
#define  fmt_i32             "%d"

typedef  unsigned char       SLOG_bit   ;
#define  fmt_bit             "%hu"
typedef  unsigned char       SLOG_uint8 ;
#define  fmt_ui8             "%hu"
typedef  unsigned short      SLOG_uint16;
#define  fmt_ui16            "%hu"
typedef  unsigned int        SLOG_uint32;
#define  fmt_ui32            "%u"
#if defined (HAVE_WINDOWS_H) && defined (HAVE_INT64)
typedef unsigned __int64 SLOG_uint64;
#else
typedef  unsigned long long  SLOG_uint64;
#endif
#define  fmt_ui64            "%llu"
typedef  double              SLOG_time  ;
#define  fmt_time            "%21.17f"
typedef  SLOG_uint64         SLOG_fptr  ;
#define  fmt_fptr            fmt_ui64
typedef  SLOG_uint32         SLOG_iaddr ;
#define  fmt_iaddr           "%x"
typedef  double              SLOG_statbintype;
#define  fmt_sbin            "%13.2f"

/*
     Define the components and their corresponding print format 
     in the __internal__ Interval Record
*/
typedef  SLOG_uint16         SLOG_bytesize_t;
#define  fmt_sz_t            fmt_ui16
typedef  SLOG_uint16         SLOG_rectype_t;
#define  fmt_rtype_t         fmt_ui16
typedef  SLOG_uint16         SLOG_intvltype_t;
#define  fmt_itype_t         fmt_ui16
typedef  SLOG_time           SLOG_starttime_t;
#define  fmt_stime_t         fmt_time
typedef  SLOG_time           SLOG_duration_t;
#define  fmt_dura_t          fmt_time
typedef  SLOG_bit            SLOG_bebit_t;
#define  fmt_bebit_t         fmt_bit
typedef  SLOG_bit            SLOG_bebits_t;
#define  fmt_bebits_t        fmt_bit
typedef  SLOG_uint16         SLOG_nodeID_t; 
#define  fmt_nodeID_t        fmt_ui16
typedef  SLOG_uint8          SLOG_cpuID_t; 
#define  fmt_cpuID_t         fmt_ui8
typedef  SLOG_uint32         SLOG_threadID_t;
#define  fmt_thID_t          fmt_ui32
typedef  SLOG_iaddr          SLOG_iaddr_t;
#define  fmt_iaddr_t         fmt_iaddr

typedef  SLOG_uint16         SLOG_N_assocs_t;
#define  fmt_Nassocs_t       fmt_ui16
typedef  SLOG_uint32         SLOG_assoc_t;
#define  fmt_assoc_t         fmt_ui32

typedef  SLOG_uint16         SLOG_N_vtrargs_t;
#define  fmt_Nvtrargs_t      fmt_ui16
typedef  SLOG_uint16         SLOG_N_args_t;
#define  fmt_Nargs_t         fmt_ui16
typedef  SLOG_uint32         SLOG_arg_t;
#define  fmt_arg_t           fmt_ui32

/*
     Define the components and their corresponding print format 
     in the __internal__ Thread Table
*/
typedef  SLOG_uint32         SLOG_OSprocessID_t;
#define  fmt_OSprocID_t      fmt_ui32
typedef  SLOG_uint32         SLOG_OSthreadID_t;
#define  fmt_OSthID_t        fmt_ui32
typedef  SLOG_uint32         SLOG_appID_t;
#define  fmt_appID_t         fmt_ui32

#define SLOG_fptr_NULL           0
#define SLOG_iaddr_NULL          0
#define SLOG_time_NULL           -1.0
#define SLOG_MAX_TYPES           40  /* Number of types in SLOG_typesz       */
#define SLOG_STRING_LEN          35
/* char  xxxx[ SLOG_STRING_LEN ] should be initialized with SLOG_STRING_INIT */
/*                               "12345678901234567890123456789012345"       */
#define SLOG_STRING_INIT         "                                   "

/*  default value for some internal data structures  */
#define SLOG_BUFFER_UNIT         256 /* byte size for frame buffer           */
#define SLOG_NDirEntry           128 /* Number of entries in Frame Directory */
#define SLOG_FRAME_RESERVED_SIZE 0   /* byte size for frame reserved         */
#define SLOG_PSTAT_STATSIZE      128 /* default size for Preview Statistics  */
#define SLOG_PSTAT_STATSIZE_MAX  512 /* Maximum size for Preview Statistics  */

/*  High level API and internal subroutine return error code  */
#define SLOG_SUCCESS       1
#define SLOG_FAIL          -1
#define SLOG_EOF           -2
#define SLOG_TRUE          1
#define SLOG_FALSE         0

/*  
    The defined RecType for various record types
    "DYNAMIC" means _variable_size_, determined _dynamically_at_runtime_
    "STATIC"  means _fixed_size_, determined _statically_by_record_def_table
    "DIAG"    means _Diagonal_in_TimeLines_Labels_space,
              i.e. Start TimeLine label === End TimeLine label
    "OFFDIAG" means _Off-Diagonal_in_TimeLines_Labels_space
              i.e. Start TimeLine label =/= End TimeLine label

    Assume Rectype is an 8 bit unsigned integer, 
      0 <= rtype <=  63 :     DIAG, DYNAMIC
     64 <= rtype <= 127 :     DIAG, STATIC
    128 <= rtype <= 191 : OFF-DIAG, DYNAMIC
    192 <= rtype <= 255 : OFF-DIAG, STATIC
*/
#define SLOG_RECTYPE_DYNAMIC_DIAG          0        /* variable size state */
#define SLOG_RECTYPE_STATIC_DIAG          64        /* fixed size state    */
#define SLOG_RECTYPE_DYNAMIC_OFFDIAG     128        /* variable size arrow */
#define SLOG_RECTYPE_STATIC_OFFDIAG      192        /* fixed size arrow    */

/*  Define User acroym for user convenience  */
#define  SLOG                     SLOG_STREAM *
#define  SLOG_Irec                SLOG_intvlrec_t *

/* ***  GLOBAL DATA TYPES  *** */

/* File descriptor for the output stream */
#define  outfile  stdout 
/* File descriptor for the error stream */
#define  errfile  stderr

enum SLOG_DataType { 
     bit, ui8, ui16, ui32, ui64, ts, fptr, sbin,
     sz_t, rtype_t, itype_t, stime_t, dura_t,
     bebit_t, bebits_t, nodeID_t, cpuID_t, thID_t, taskID_t, iaddr_t, 
     Nassocs_t, assoc_t, Nargs_t, arg_t,
     Header, Profile, Preview, ThreadTable, RecDefs,
     FrameDirHdr, FrameDirEntry, FrameHdr, min_IntvlRec
};

/*  Initialized in SLOG_InitGlobalData()  */
extern SLOG_uint32 SLOG_typesz[ SLOG_MAX_TYPES ];

/*   A global STATIC data structure   */
typedef struct {
    SLOG_rectype_t         MinRectype4VarDiagRec;
    SLOG_rectype_t         MaxRectype4VarDiagRec;
    SLOG_rectype_t         MinRectype4FixDiagRec;
    SLOG_rectype_t         MaxRectype4FixDiagRec;
    SLOG_rectype_t         MinRectype4VarOffdRec;
    SLOG_rectype_t         MaxRectype4VarOffdRec;
    SLOG_rectype_t         MinRectype4FixOffdRec;
    SLOG_rectype_t         MaxRectype4FixOffdRec;
} SLOG_global_t;



typedef struct {
    SLOG_fptr              file_loc;
    filebuf_t             *fbuf;
    SLOG_uint32            version[2];
    SLOG_uint32            frame_bytesize;
    SLOG_uint32            frame_reserved_size;
    SLOG_uint32            max_Ndirframe;
    SLOG_uint16            IsIncreasingStarttime;
    SLOG_uint16            IsIncreasingEndtime;
    SLOG_uint16            HasReserveSpaceBeenUsed;
    SLOG_fptr              fptr2statistics;
    SLOG_fptr              fptr2preview;
    SLOG_fptr              fptr2profile;
    SLOG_fptr              fptr2threadtable;
    SLOG_fptr              fptr2recdefs;
    SLOG_fptr              fptr2framedata;
} SLOG_hdr_t;

typedef struct {
    SLOG_uint32            Nchar;
    char                  *filename;
    SLOG_uint32            Nbytes;
    char                  *data;
} SLOG_pview_t;

typedef struct {
    SLOG_rectype_t         rectype;
    SLOG_intvltype_t       intvltype;
    char                   label[ SLOG_STRING_LEN ];
    SLOG_uint32            Nbin;
    SLOG_statbintype      *bins;                 /* bins[ Nbin ]  */
} SLOG_statset_t;

/*
    The starttime and endtime here are times collected right after the 1st pass
    So they may be different from those found in Frame Directory
*/
typedef struct {
    SLOG_time              starttime;            /* stime used in Write API  */
    SLOG_time              endtime;              /* etime used in Write API  */
    SLOG_time              bin_width_in_time;    /* width sued in Write API  */
    SLOG_uint32            Nset;
    SLOG_uint32            Nbin;
    SLOG_statset_t       **sets;                 /* sets[ Nset ]  */
    SLOG_int32            *seq_idx_vals;         /* seq_idx_vals[ Nset ]   */
} SLOG_pstat_t;

typedef struct {
    SLOG_uint32            Nstrs;
    char                 **strs;
} SLOG_strlist_t;
    
typedef struct {
    SLOG_intvltype_t       intvltype;
    SLOG_bebits_t          bebits[2];
    char                   classtype[ SLOG_STRING_LEN ];
    char                   label[ SLOG_STRING_LEN ];
    char                   color[ SLOG_STRING_LEN ];
    SLOG_strlist_t        *arg_labels;
    int                    used;                 /* Write API only */
} SLOG_intvlinfo_t;

typedef struct {
    SLOG_uint32            capacity;
    SLOG_uint32            increment;
    SLOG_uint32            Nentries;
    SLOG_intvlinfo_t      *entries;              /* entries[ Nentries ]  */
    SLOG_fptr              file_loc;             /* fptr to entries[ii]  */
} SLOG_prof_t;

/*   The def'n of thread table entry   */
typedef struct {
    SLOG_nodeID_t          node_id;
    SLOG_threadID_t        thread_id;
    SLOG_OSprocessID_t     OSprocess_id;
    SLOG_OSthreadID_t      OSthread_id;
    SLOG_appID_t           app_id;
} SLOG_threadinfo_t;

/*   The def'n of the thread table entry  */
typedef struct {
    SLOG_uint32            capacity;
    SLOG_uint32            increment;
    SLOG_uint32            Nentries;
    SLOG_threadinfo_t     *entries;              /* entries[ Nentries ]  */
} SLOG_threadinfo_table_t;

/*   The def'n of the Fixed Record definition  */
typedef struct {
    SLOG_intvltype_t       intvltype;
    SLOG_bebits_t          bebits[2];
    SLOG_N_assocs_t        Nassocs;
    SLOG_N_args_t          Nargs;
    int                    used;                 /* Write API only */
} SLOG_recdef_t;