X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=fio.h;h=2d30324cb973df5dc9c21f520f46e9ce5faee08c;hp=c6fb6a11d70b8eb582b3f9ab0262bbe5829e6617;hb=7d44a745ced0cd50c31a68d680601c66db99b96b;hpb=61697c37566a211ad3fd70f46397d9b7675b0fc2

diff --git a/fio.h b/fio.h
index c6fb6a11..2d30324c 100644
--- a/fio.h
+++ b/fio.h
@@ -18,12 +18,17 @@
 #include "arch.h"
 #include "os.h"
 
+#include "syslet.h"
+
 enum fio_ddir {
 	DDIR_READ = 0,
 	DDIR_WRITE,
 	DDIR_SYNC,
 };
 
+/*
+ * Use for maintaining statistics
+ */
 struct io_stat {
 	unsigned long max_val;
 	unsigned long min_val;
@@ -33,26 +38,42 @@ struct io_stat {
 	double S;
 };
 
+/*
+ * A single data sample
+ */
 struct io_sample {
 	unsigned long time;
 	unsigned long val;
 	enum fio_ddir ddir;
 };
 
+/*
+ * Dynamically growing data sample log
+ */
 struct io_log {
 	unsigned long nr_samples;
 	unsigned long max_samples;
 	struct io_sample *log;
 };
 
+/*
+ * When logging io actions, this matches a single sent io_u
+ */
 struct io_piece {
 	struct list_head list;
 	struct fio_file *file;
 	unsigned long long offset;
-	unsigned int len;
+	unsigned long len;
 	enum fio_ddir ddir;
 };
 
+#ifdef FIO_HAVE_SYSLET
+struct syslet_req {
+	struct syslet_uatom atom;
+	long ret;
+};
+#endif
+
 /*
  * The io unit
  */
@@ -66,15 +87,28 @@ struct io_u {
 #endif
 #ifdef FIO_HAVE_SGIO
 		struct sg_io_hdr hdr;
+#endif
+#ifdef FIO_HAVE_SYSLET
+		struct syslet_req req;
 #endif
 	};
 	struct timeval start_time;
 	struct timeval issue_time;
 
+	/*
+	 * Allocated/set buffer and length
+	 */
 	void *buf;
-	unsigned int buflen;
+	unsigned long buflen;
 	unsigned long long offset;
 
+	/*
+	 * IO engine state, may be different from above when we get
+	 * partial transfers / residual data counts
+	 */
+	void *xfer_buf;
+	unsigned long xfer_buflen;
+
 	unsigned int resid;
 	unsigned int error;
 
@@ -96,11 +130,14 @@ struct io_u {
 #define FIO_HDR_MAGIC	0xf00baaef
 
 enum {
-	VERIFY_NONE = 0,
-	VERIFY_MD5,
-	VERIFY_CRC32,
+	VERIFY_NONE = 0,		/* no verification */
+	VERIFY_MD5,			/* md5 sum data blocks */
+	VERIFY_CRC32,			/* crc32 sum data blocks */
 };
 
+/*
+ * A header structure associated with each checksummed data block
+ */
 struct verify_header {
 	unsigned int fio_magic;
 	unsigned int len;
@@ -133,25 +170,31 @@ enum fio_memtype {
  * The type of object we are working on
  */
 enum fio_filetype {
-	FIO_TYPE_FILE = 1,
-	FIO_TYPE_BD,
-	FIO_TYPE_CHAR,
+	FIO_TYPE_FILE = 1,		/* plain file */
+	FIO_TYPE_BD,			/* block device */
+	FIO_TYPE_CHAR,			/* character device */
 };
 
 enum fio_ioengine_flags {
-	FIO_SYNCIO	= 1 << 0,
-	FIO_CPUIO	= 1 << 1,
-	FIO_MMAPIO	= 1 << 2,
-	FIO_RAWIO	= 1 << 3,
+	FIO_SYNCIO	= 1 << 0,	/* io engine has synchronous ->queue */
+	FIO_CPUIO	= 1 << 1,	/* cpu burner, doesn't do real io */
+	FIO_MMAPIO	= 1 << 2,	/* uses memory mapped io */
+	FIO_RAWIO	= 1 << 3,	/* some sort of direct/raw io */
+	FIO_NETIO	= 1 << 4,	/* networked io */
+	FIO_NULLIO	= 1 << 5,	/* no real data transfer (cpu/null) */
 };
 
+/*
+ * Each thread_data structure has a number of files associated with it,
+ * this structure holds state information for a single file.
+ */
 struct fio_file {
 	/*
 	 * A file may not be a file descriptor, let the io engine decide
 	 */
 	union {
 		unsigned long file_data;
-		int fd;
+		long fd;
 	};
 	char *file_name;
 	void *mmap;
@@ -161,8 +204,12 @@ struct fio_file {
 	unsigned long long last_pos;
 	unsigned long long last_completed_pos;
 
+	/*
+	 * block map for random io
+	 */
 	unsigned long *file_map;
 	unsigned int num_maps;
+	unsigned int last_free_lookup;
 
 	unsigned int unlink;
 };
@@ -402,6 +449,9 @@ static inline int should_fsync(struct thread_data *td)
 	return 0;
 }
 
+/*
+ * Disk utils as read in /sys/block/<dev>/stat
+ */
 struct disk_util_stat {
 	unsigned ios[2];
 	unsigned merges[2];
@@ -411,6 +461,9 @@ struct disk_util_stat {
 	unsigned time_in_queue;
 };
 
+/*
+ * Per-device disk util management
+ */
 struct disk_util {
 	struct list_head list;
 
@@ -425,6 +478,9 @@ struct disk_util {
 	struct timeval time;
 };
 
+/*
+ * Used for passing io_u completion data
+ */
 struct io_completion_data {
 	int nr;				/* input */
 
@@ -626,4 +682,14 @@ extern void close_ioengine(struct thread_data *);
 #define for_each_file(td, f, i)	\
 	for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
 
+#define fio_assert(td, cond)	do {	\
+	if (!(cond)) {			\
+		int *__foo = NULL;	\
+		fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);	\
+		(td)->runstate = TD_EXITED;	\
+		(td)->error = EFAULT;		\
+		*__foo = 0;			\
+	}	\
+} while (0)
+
 #endif