:orphan:

.. index:: pair: struct; tapi_fio_opts
.. _doxid-structtapi__fio__opts:

struct tapi_fio_opts
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

List of possible FIO test tool options. :ref:`More...<details-structtapi__fio__opts>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_fio.h>
	
	struct tapi_fio_opts {
		// fields
	
		const char* :ref:`name<doxid-structtapi__fio__opts_1a1f19bab6ac0e7ba279a0103f1ed6d3d6>`;
		const char* :ref:`filename<doxid-structtapi__fio__opts_1ad421ef64f3c57a5f626385bb56bf4290>`;
		unsigned int :ref:`blocksize<doxid-structtapi__fio__opts_1a63baa95a23ed4a0927f2d796995398ff>`;
		:ref:`tapi_fio_numjobs_t<doxid-structtapi__fio__numjobs__t>` :ref:`numjobs<doxid-structtapi__fio__opts_1a96888e207d1bb10a350c8331ecfe1303>`;
		unsigned int :ref:`iodepth<doxid-structtapi__fio__opts_1ab9a5287d46e6bde3ae2e0bbb8f98c889>`;
		int :ref:`runtime_sec<doxid-structtapi__fio__opts_1a58abbde22b053199d1b827fea89905f4>`;
		unsigned int :ref:`rwmixread<doxid-structtapi__fio__opts_1a201cc5007cdb7f5e244aa54726ebf396>`;
		:ref:`tapi_fio_rwtype<doxid-group__tapi__fio_1gab27253a36a0db2af13c0f2b31c2d1efa>` :ref:`rwtype<doxid-structtapi__fio__opts_1a7d1406fdde413347c0c6e6aa1847c451>`;
		:ref:`tapi_fio_ioengine<doxid-group__tapi__fio_1gabda7b905e97bf8a0df394d8b7a231eea>` :ref:`ioengine<doxid-structtapi__fio__opts_1ae3702d7dc5640d2ae23ce1c7e4c405a1>`;
		:ref:`te_string<doxid-structte__string>` :ref:`output_path<doxid-structtapi__fio__opts_1a214b0487eec684ae3cdf5f2e0cff1559>`;
		bool :ref:`direct<doxid-structtapi__fio__opts_1a7d2f2ed6a4594a6ede867faa690632bd>`;
		bool :ref:`exit_on_error<doxid-structtapi__fio__opts_1a53b58cf4e08e7566d4363fa0076b5ae8>`;
		const char* :ref:`rand_gen<doxid-structtapi__fio__opts_1a5b4b00c50e95ce09eaeb6b651d9c5e47>`;
		const char* :ref:`user<doxid-structtapi__fio__opts_1a76972940459dce914aadb9184ce356da>`;
		const char* :ref:`prefix<doxid-structtapi__fio__opts_1a6981cf27fae078b61eebe954cedc7de8>`;
		const char* :ref:`rbdname<doxid-structtapi__fio__opts_1abbe1ba72633fb10fce28a5765b9a50d8>`;
		const char* :ref:`pool<doxid-structtapi__fio__opts_1a6842508589cd389d6214f31fe18b871c>`;
		:ref:`tapi_job_opt_uintmax_t<doxid-group__tapi__job__opt_1ga2d12253362860180cd87ec371f8672df>` :ref:`size<doxid-structtapi__fio__opts_1a0c76cd2a09345635d124ce06842c8164>`;
	};
.. _details-structtapi__fio__opts:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

List of possible FIO test tool options.

Fields
------

.. index:: pair: variable; name
.. _doxid-structtapi__fio__opts_1a1f19bab6ac0e7ba279a0103f1ed6d3d6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* name

Test name

.. index:: pair: variable; filename
.. _doxid-structtapi__fio__opts_1ad421ef64f3c57a5f626385bb56bf4290:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* filename

Files to use for the workload

.. index:: pair: variable; blocksize
.. _doxid-structtapi__fio__opts_1a63baa95a23ed4a0927f2d796995398ff:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int blocksize

Block size unit

.. index:: pair: variable; numjobs
.. _doxid-structtapi__fio__opts_1a96888e207d1bb10a350c8331ecfe1303:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_fio_numjobs_t<doxid-structtapi__fio__numjobs__t>` numjobs

Duplicate this job many times

.. index:: pair: variable; iodepth
.. _doxid-structtapi__fio__opts_1ab9a5287d46e6bde3ae2e0bbb8f98c889:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int iodepth

Number of IO buffers to keep in flight

.. index:: pair: variable; runtime_sec
.. _doxid-structtapi__fio__opts_1a58abbde22b053199d1b827fea89905f4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int runtime_sec

Stop workload when the time expires

.. index:: pair: variable; rwmixread
.. _doxid-structtapi__fio__opts_1a201cc5007cdb7f5e244aa54726ebf396:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int rwmixread

Percentage of mixed workload that is reads

.. index:: pair: variable; rwtype
.. _doxid-structtapi__fio__opts_1a7d1406fdde413347c0c6e6aa1847c451:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_fio_rwtype<doxid-group__tapi__fio_1gab27253a36a0db2af13c0f2b31c2d1efa>` rwtype

Read or write type

.. index:: pair: variable; ioengine
.. _doxid-structtapi__fio__opts_1ae3702d7dc5640d2ae23ce1c7e4c405a1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_fio_ioengine<doxid-group__tapi__fio_1gabda7b905e97bf8a0df394d8b7a231eea>` ioengine

I/O Engine type

.. index:: pair: variable; output_path
.. _doxid-structtapi__fio__opts_1a214b0487eec684ae3cdf5f2e0cff1559:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_string<doxid-structte__string>` output_path

File name where store FIO result

.. index:: pair: variable; direct
.. _doxid-structtapi__fio__opts_1a7d2f2ed6a4594a6ede867faa690632bd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool direct

Use O_DIRECT I/O

.. index:: pair: variable; exit_on_error
.. _doxid-structtapi__fio__opts_1a53b58cf4e08e7566d4363fa0076b5ae8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool exit_on_error

Terminate all jobs when one exits in error

.. index:: pair: variable; rand_gen
.. _doxid-structtapi__fio__opts_1a5b4b00c50e95ce09eaeb6b651d9c5e47:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* rand_gen

Random generator type

.. index:: pair: variable; user
.. _doxid-structtapi__fio__opts_1a76972940459dce914aadb9184ce356da:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* user

Raw string passed to fio

.. index:: pair: variable; prefix
.. _doxid-structtapi__fio__opts_1a6981cf27fae078b61eebe954cedc7de8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* prefix

Raw string used as a prefix before fio

.. index:: pair: variable; rbdname
.. _doxid-structtapi__fio__opts_1abbe1ba72633fb10fce28a5765b9a50d8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* rbdname

Specifies the name of the RBD

.. index:: pair: variable; pool
.. _doxid-structtapi__fio__opts_1a6842508589cd389d6214f31fe18b871c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* pool

Specifies the name of the Ceph pool containing RBD or RADOS data.

.. index:: pair: variable; size
.. _doxid-structtapi__fio__opts_1a0c76cd2a09345635d124ce06842c8164:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uintmax_t<doxid-group__tapi__job__opt_1ga2d12253362860180cd87ec371f8672df>` size

The total size of file I/O for each thread of this job