usermode/library/mtm/src/stats.h

Go to the documentation of this file.

/*
    Copyright (C) 2011 Computer Sciences Department, 
    University of Wisconsin -- Madison

    ----------------------------------------------------------------------

    This file is part of Mnemosyne: Lightweight Persistent Memory, 
    originally developed at the University of Wisconsin -- Madison.

    Mnemosyne was originally developed primarily by Haris Volos
    with contributions from Andres Jaan Tack.

    ----------------------------------------------------------------------

    Mnemosyne is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, version 2
    of the License.
 
    Mnemosyne 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, 
    Boston, MA  02110-1301, USA.

### END HEADER ###
*/

#ifndef _M_STATS_H
#define _M_STATS_H

#include "result.h"

/* 
 * TODO: Currently if statistics support is not built we get compilation errors
 * of undefined statistics when calling 'm_stats_statset_increment' family of
 * functions.  The currernt workaround is to wrap each call into _M_STATS_BUILD
 * but that's kind of ugly. 
 *
 * TODO: Make the statistics report output prettier by parsing the source location
 *
 * TODO: Currently if stats.[c|h] are used in multiple libraries we get symbol 
 * collision problems. Either make symbols hidden outside the library, or MACROFY 
 * them to add a per module extension, or make them static.
 */

#define FOREACH_STAT_XACT(ACTION)                                           \
  ACTION(aborts)                                                            \
  ACTION(writes)                                                            \
  ACTION(writes_distinct)                                                   \
  ACTION(nvwrites)                                                          \
  ACTION(nvwrites_distinct)                                                 \
  ACTION(vwrites)                                                           \
  ACTION(vwrites_distinct)                                                  \
  ACTION(wbflush)                                                            


#ifdef _M_STATS_BUILD

# define FOREACH_STAT(ACTION)                                                \
    FOREACH_STAT_XACT (ACTION)

# define FOREACH_STATPROBE(ACTION)                                           \
    ACTION(XACT)

# define FOREACH_VOIDSTATPROBE(ACTION)                                           


#else /* !_M_STATS_BUILD */

# define FOREACH_STAT(ACTION)          /* do nothing */
# define FOREACH_STATPROBE(ACTION)     /* do nothing */
# define FOREACH_VOIDSTATPROBE(ACTION) /* do nothing */

#endif /* !_M_STATS_BUILD */

typedef enum {
#define STATENTRY(name) m_stats_##name##_stat,
        FOREACH_STAT (STATENTRY)
#undef STATENTRY        
        m_stats_numofstats
} m_stats_statentry_t; 

typedef unsigned int m_stats_statcounter_t;
typedef struct m_stats_threadstat_s m_stats_threadstat_t;
typedef struct m_statsmgr_s m_statsmgr_t;
typedef struct m_stats_statset_s m_stats_statset_t;
typedef struct m_stats_stat_s m_stats_stat_t;


struct m_stats_stat_s
{
        m_stats_statcounter_t max;   
        m_stats_statcounter_t min;   
        m_stats_statcounter_t total; 
}; 


struct m_stats_statset_s {
        const char             *name;       
        m_stats_statcounter_t  count;       
        m_stats_stat_t         stats[m_stats_numofstats]; 
}; 


static inline
void
m_stats_statset_set_val(m_stats_statset_t *statset, 
                        m_stats_statentry_t entry,
                        m_stats_statcounter_t val)
{
        statset->stats[entry].total = val;      
}


static inline
m_stats_statcounter_t
m_stats_statset_get_val(m_stats_statset_t *statset, 
                        m_stats_statentry_t entry)
{
        return statset->stats[entry].total;
}


#define GENERATE_STATPROBES(stat_provider)                                     \
static inline                                                                  \
void                                                                           \
m_stats_statset_increment_##stat_provider(m_statsmgr_t *statsmgr,              \
                                          m_stats_statset_t *statset,          \
                                          m_stats_statentry_t entry,           \
                                          m_stats_statcounter_t val)           \
{                                                                              \
    if (statsmgr) {                                                            \
        m_stats_statset_set_val(statset,                                       \
                                entry,                                         \
                                m_stats_statset_get_val(statset, entry) + val);\
    }                                                                                                  \
}                                                                                                                      \
                                                                               \
static inline                                                                  \
void                                                                           \
m_stats_statset_decrement_##stat_provider(m_statsmgr_t *statsmgr,              \
                                          m_stats_statset_t *statset,          \
                                          m_stats_statentry_t entry,           \
                                          m_stats_statcounter_t val)           \
{                                                                              \
        if (statsmgr) {                                                            \
        m_stats_statset_set_val(statset,                                       \
                                entry,                                         \
                                m_stats_statset_get_val(statset, entry) - val);\
    }                                                                                                  \
}                                                                                                                      \


#define GENERATE_VOIDSTATPROBES(stat_provider)                               \
static inline                                                                \
void                                                                         \
m_stats_statset_increment_##stat_provider(m_statsmgr_t *statsmgr,            \
                                          m_stats_statset_t *statset,        \
                                          m_stats_statentry_t entry,         \
                                          m_stats_statcounter_t val)         \
{                                                                            \
        return ;                                                                 \
}                                                                                                                    \
                                                                             \
static inline                                                                \
void                                                                         \
m_stats_statset_decrement_##stat_provider(m_statsmgr_t *statsmgr,            \
                                          m_stats_statset_t *statset,        \
                                          m_stats_statentry_t entry,         \
                                          m_stats_statcounter_t val)         \
{                                                                            \
        return ;                                                                 \
}                                                                                                                    \


FOREACH_STATPROBE (GENERATE_STATPROBES)
FOREACH_VOIDSTATPROBE (GENERATE_VOIDSTATPROBES)


#define m_stats_statset_increment(statsmgr, statset, stat_provider, stat, val) \
  m_stats_statset_increment_##stat_provider(statsmgr,                          \
                                            statset,                           \
                                                                                        m_stats_##stat##_stat,             \
                                            val);

#define m_stats_statset_decrement(statsmgr, statset, stat_provider, stat, val) \
  m_stats_statset_decrement_##stat_provider(statsmgr,                          \
                                            statset,                           \
                                            m_stats_##stat##_stat,             \
                                            val);


m_result_t m_statsmgr_create(m_statsmgr_t **statsmgrp, char *output_file);
m_result_t m_statsmgr_destroy(m_statsmgr_t **statsmgrp);
m_result_t m_stats_threadstat_create(m_statsmgr_t *statsmgr, unsigned int tid, m_stats_threadstat_t **threadstatp);
m_result_t m_stats_statset_create(m_stats_statset_t **statsetp);
m_result_t m_stats_statset_destroy(m_stats_statset_t **statsetp);
m_result_t m_stats_statset_init(m_stats_statset_t *statset, const char *name);
void m_stats_threadstat_aggregate(m_stats_threadstat_t *threadstat, m_stats_statset_t *source_statset);
void m_stats_print(m_statsmgr_t *statsmgr);

#endif /* _M_STATS_H */

---