btrecord.h

/*
 * Blktrace record utility - Convert binary trace data into bunches of IOs
 *
 * Copyright (C) 2007 Alan D. Brunelle <Alan.Brunelle@hp.com>
 *
 *  This program 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; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#if !defined(__BTRECORD_H__)
#define __BTRECORD_H__

#include <asm/types.h>

#define BT_MAX_PKTS	512

/*
 * Header for each bunch
 *
 * @nkts: 	Number of IO packets to process
 * @time_stamp:	Time stamp for this bunch of IOs
 */
struct io_bunch_hdr {
	__u64 npkts;
	__u64 time_stamp;
};

/*
 * IO specifer
 *
 * @sector:	Sector number of IO
 * @nbytes:	Number of bytes to process
 * @rw:		IO direction: 0 = write, 1 = read
 */
struct io_pkt {
	__u64 sector;
	__u64 nbytes;
	__u32 rw;
};

/*
 * Shorthand notion of a bunch of IOs
 *
 * @hdr: 	Header describing stall and how many IO packets follow
 * @pkts: 	Individual IOs are described here
 */
struct io_bunch {
	struct io_bunch_hdr hdr;
	struct io_pkt pkts[BT_MAX_PKTS];
};

/*
 * Header for each recorded file
 *
 * @version:	Version information
 * @genesis:	Time stamp for earliest bunch
 * @nbunches:	Number of bunches put into the file
 * @total_pkts:	Number of packets to be processed
 */
struct io_file_hdr {
	__u64 version;
	__u64 genesis;
	__u64 nbunches;
	__u64 total_pkts;
};

static inline __u64 mk_btversion(int mjr, int mnr, int sub)
{
	return ((mjr & 0xff) << 16) | ((mnr & 0xff) << 8) | (sub & 0xff);
}

static inline void get_btversion(__u64 version, int *mjr, int *mnr, int *sub)
{
	*mjr = (int)((version >> 16) & 0xff);
	*mnr = (int)((version >>  8) & 0xff);
	*sub = (int)((version >>  0) & 0xff);
}

static char my_btversion[] = "0.9.3";
static int btver_mjr = 0;
static int btver_mnr = 9;
static int btver_sub = 3;

/*
 * Per input file information
 *
 * @head: 	Used to link up on input_files
 * @devnm: 	Device name portion of this input file
 * @file_name: 	Fully qualified name for this input file
 * @cpu: 	CPU that this file was collected on
 * @ifd: 	Input file descriptor (when opened)
 * @tpkts: 	Total number of packets processed.
 */
struct ifile_info {
	struct list_head head;
	char *devnm, *file_name;
	int cpu, ifd;
	__u64 tpkts, genesis;
};

/*
 * Per output file information
 *
 * @ofp: 	Output file 
 * @vfp:	Verbose output file
 * @file_name: 	Fully qualified name for this file
 * @vfn:	Fully qualified name for this file
 * @cur: 	Current IO bunch being collected
 * @iip: 	Input file this is associated with
 * @start_time: Start time of th ecurrent bunch
 * @last_time: 	Time of last packet put in
 * @bunches: 	Number of bunches processed
 * @pkts: 	Number of packets stored in bunches
 */
struct io_stream {
	FILE *ofp, *vfp;
	char *file_name, *vfn;
	struct io_bunch *cur;
	struct ifile_info *iip;
	__u64 start_time, last_time, bunches, pkts;
};

/*
 * Per IO trace information
 *
 * @time: 	Time stamp when trace was emitted
 * @sector: 	IO sector identifier
 * @bytes: 	Number of bytes transferred
 * @rw: 	Read (1) or write (0) 
 */
struct io_spec {
	__u64 time;
	__u64 sector;
	__u32 bytes;
	int rw;
};

struct io_stream *stream_open(struct ifile_info *iip);
void stream_add_io(struct io_stream *stream, struct io_spec *spec);
void stream_close(struct io_stream *stream);

#endif