0ad/source/lib/res/file/file_stats.cpp

#include "precompiled.h"

#include <set>

#include "lib/timer.h"
#include "file_internal.h"


typedef std::set<const char*> AtomFnSet;
typedef std::pair<AtomFnSet::iterator, bool> PairIB;

// convenience functions for measuring elapsed time in an interval.
// by exposing start/finish calls, we avoid callers from querying
// timestamps when stats are disabled.
static double start_time;
static void timer_start(double* start_time_storage = &start_time)
{
	// make sure no measurement is currently active
	// (since start_time is shared static storage)
	debug_assert(*start_time_storage == 0.0);
	*start_time_storage = get_time();
}
static double timer_reset(double* start_time_storage = &start_time)
{
	double elapsed = get_time() - *start_time_storage;
	*start_time_storage = 0.0;
	return elapsed;
}

// vfs
static uint vfs_files;
static size_t vfs_size_total;
static double vfs_init_elapsed_time;

// file
static uint unique_names;
static size_t unique_name_len_total;
static uint open_files_cur, open_files_max;	// total = opened_files.size()
static double opened_file_size_total;
static AtomFnSet opened_files;

// file_buf
static uint extant_bufs_cur, extant_bufs_max, extant_bufs_total;
static double buf_user_size_total, buf_padded_size_total;

// file_io
static uint user_ios;
static double user_io_size_total;
static double io_actual_size_total[FI_MAX_IDX][2];
static double io_elapsed_time[FI_MAX_IDX][2];
static double io_process_time_total;
static BlockId io_disk_pos_cur;
static uint io_seeks;

// file_cache
static uint cache_count[2];
static u64 cache_size_total[2];
static AtomFnSet ever_cached_files;
static uint conflict_misses;
static u64 conflict_miss_size_total;
static uint block_cache_count[2];


//
// vfs
//

void stats_vfs_file_add(size_t file_size)
{
	vfs_files++;
	vfs_size_total += file_size;
}

void stats_vfs_file_remove(size_t file_size)
{
	vfs_files--;
	vfs_size_total -= file_size;
}


void stats_vfs_init_start()
{
	timer_start();
}

void stats_vfs_init_finish()
{
	vfs_init_elapsed_time += timer_reset();
}


//
// file
//

void stats_unique_name(size_t name_len)
{
	unique_names++;
	unique_name_len_total += name_len;
}


void stats_open(const char* atom_fn, size_t file_size)
{
	open_files_cur++;
	open_files_max = MAX(open_files_max, open_files_cur);

	PairIB ret = opened_files.insert(atom_fn);
	// hadn't been opened yet
	if(ret.second)
		opened_file_size_total += file_size;
}

void stats_close()
{
	debug_assert(open_files_cur > 0);
	open_files_cur--;
}


//
// file_buf
//

void stats_buf_alloc(size_t user_size, size_t padded_size)
{
	extant_bufs_cur++;
	extant_bufs_max = MAX(extant_bufs_max, extant_bufs_cur);
	extant_bufs_total++;

	buf_user_size_total += user_size;
	buf_padded_size_total += padded_size;
}

void stats_buf_free()
{
	debug_assert(extant_bufs_cur > 0);
	extant_bufs_cur--;
}


//
// file_io
//

void stats_user_io(size_t user_size)
{
	user_ios++;
	user_io_size_total += user_size;
}

void stats_io_start(FileIOImplentation fi, FileOp fo, size_t actual_size,
	BlockId disk_pos, double* start_time_storage)
{
	debug_assert(fi < FI_MAX_IDX);
	debug_assert(fo == FO_READ || FO_WRITE);

	io_actual_size_total[fi][fo] += actual_size;

	if(disk_pos.atom_fn != io_disk_pos_cur.atom_fn ||
	   disk_pos.block_num != io_disk_pos_cur.block_num+1)
		io_seeks++;
	io_disk_pos_cur = disk_pos;

	timer_start(start_time_storage);
}

void stats_io_finish(FileIOImplentation fi, FileOp fo, double* start_time_storage)
{
	debug_assert(fi < FI_MAX_IDX);
	debug_assert(fo == FO_READ || FO_WRITE);

	io_elapsed_time[fi][fo] += timer_reset(start_time_storage);
}

void stats_cb_start()
{
	timer_start();
}

void stats_cb_finish()
{
	io_process_time_total += timer_reset();
}


//
// file_cache
//

void stats_cache(CacheRet cr, size_t size, const char* atom_fn)
{
	debug_assert(cr == CR_HIT || cr == CR_MISS);

	if(cr == CR_MISS)
	{
		PairIB ret = ever_cached_files.insert(atom_fn);
		if(!ret.second)	// was already cached once
		{
			conflict_miss_size_total += size;
			conflict_misses++;
		}
	}

	cache_count[cr]++;
	cache_size_total[cr] += size;
}

void stats_block_cache(CacheRet cr)
{
	debug_assert(cr == CR_HIT || cr == CR_MISS);
	block_cache_count[cr]++;
}


void stats_dump()
{
/*
	// note: writes count toward io_actual_size_total but not cache.
//	debug_assert(io_actual_size_total >= cache_size_total[CR_MISS]);

	// not necessarily true, since not all IO clients use the cache.		
	//		debug_assert(io_count >= cache_count[CR_MISS]);

	const size_t unique_files_accessed = opened_files.size();

	// guesstimate miss rate due to cache capacity
	// (indicates effectiveness of caching algorithm)
	const u64 working_set_est = opened_file_size_total * ((double)unique_files_accessed/
		unique_names);
	const uint cache_capacity_miss_rate_est = (cache_size_total[CR_MISS]-working_set_est)/
		(double)(cache_size_total[CR_HIT]+cache_size_total[CR_MISS]);

	const double KB = 1000.0; const double MB = 1000000.0;
	// note: needs to be split up into several calls due to
	// debug_printf's fixed-size buffer.
	debug_printf(
		"File statistics\n"
		"--------------------------------------------------------------------------------\n"
		"Total files seen: %u; total files accessed: %u.\n"
		"  unused files: %d%%.\n"
		"Max. open files: %u; leaked files: %u.\n"
		"Total buffers (re)used: %u; max. extant buffers: %u; leaked buffers: %u.\n"
		,
		unique_names, unique_files_accessed,
		100-(int)(((float)unique_files_accessed)/unique_names),
		open_files_max, open_files_cur,
		extant_bufs_total, extant_bufs_max, extant_bufs_cur);

	debug_printf(
		"Total # user IOs: %u; cumulative size: %.3g MB; average size: %.2g KB.\n"
		"  unused data: %d%%.\n"
		"IO thoughput [MB/s; 0=never happened]:\n"
		"  lowio: R=%.3g, W=%.3g\n"
		"    aio: R=%.3g, W=%.3g\n"
		"File cache totals: hits: %.3g MB; misses: %.3g MB.\n"
		"  ratio: %d%%; capacity miss rate: ~%d%%.\n"
		"--------------------------------------------------------------------------------\n"
		,
		io_count, io_user_size_total/MB, ((double)io_user_size_total)/io_count/KB,
		100-(int)(((float)io_user_size_total)/opened_file_size_total),
		read_throughput_avg[FI_LOWIO]/MB, write_throughput_avg[FI_LOWIO]/MB,
		read_throughput_avg[FI_AIO  ]/MB, write_throughput_avg[FI_AIO  ]/MB,
		cache_size_total[CR_HIT]/MB, cache_size_total[CR_MISS]/MB,
		(int)(((float)cache_size_total[CR_HIT])/(cache_size_total[CR_HIT]+cache_size_total[CR_MISS])), cache_capacity_miss_rate_est
		);
*/
}