:orphan:

.. index:: pair: struct; tapi_memtier_opt
.. _doxid-structtapi__memtier__opt:

struct tapi_memtier_opt
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

memtier_benchmark command line options :ref:`More...<details-structtapi__memtier__opt>`


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

	#include <tapi_memtier.h>
	
	struct tapi_memtier_opt {
		// fields
	
		const struct sockaddr* :ref:`server<doxid-structtapi__memtier__opt_1a5d4f79df33102da26ddca57e5f7dc5c7>`;
		:ref:`tapi_memtier_proto<doxid-group__tapi__memtier_1ga02a65cee08bc139c73aab86b57a2f40b>` :ref:`protocol<doxid-structtapi__memtier__opt_1aab56522c8a1051d89b2c64edf94ed54c>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`run_count<doxid-structtapi__memtier__opt_1a07f360b905ec1523225d436f1b29de5c>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`requests<doxid-structtapi__memtier__opt_1a9525d11e26b93c6df5a8c52b9c80e623>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`clients<doxid-structtapi__memtier__opt_1a7c67f76a146c4e78746e43d4578af638>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`threads<doxid-structtapi__memtier__opt_1af3acd06264691db061f9d27d78e38e58>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`pipeline<doxid-structtapi__memtier__opt_1a883a7e9ae2a881f9425ef2fb1b31d0b2>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`test_time<doxid-structtapi__memtier__opt_1ae249e9bbaf0d98dd45ab6bd34c02843c>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`data_size<doxid-structtapi__memtier__opt_1a61588858219b78dfc6dae0125ff163d6>`;
		bool :ref:`random_data<doxid-structtapi__memtier__opt_1a558583e3f1fe7797cbb95b334a0eff53>`;
		const char* :ref:`ratio<doxid-structtapi__memtier__opt_1af47659d560c91e7bfd176c781cfb8695>`;
		const char* :ref:`key_prefix<doxid-structtapi__memtier__opt_1a9deddc71783eab216c91139a9e3b879f>`;
		const char* :ref:`key_pattern<doxid-structtapi__memtier__opt_1ad330d552d73c7e19ebcc28f6b6d84f8d>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`key_minimum<doxid-structtapi__memtier__opt_1ab883c46e4c04c3d6bd45c406645c83b4>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`key_maximum<doxid-structtapi__memtier__opt_1ac07865b7ec23852885bd752a7871dde0>`;
		bool :ref:`hide_histogram<doxid-structtapi__memtier__opt_1a393b6ed7adbb6ccf6600cdf38357a6f1>`;
		bool :ref:`debug<doxid-structtapi__memtier__opt_1af091a2507ee50516c8e3932033481534>`;
		const char* :ref:`memtier_path<doxid-structtapi__memtier__opt_1a8697816997fed43d637b5f752baf0606>`;
	};
.. _details-structtapi__memtier__opt:

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

memtier_benchmark command line options

Fields
------

.. index:: pair: variable; server
.. _doxid-structtapi__memtier__opt_1a5d4f79df33102da26ddca57e5f7dc5c7:

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

	const struct sockaddr* server

Tested server address and port

.. index:: pair: variable; protocol
.. _doxid-structtapi__memtier__opt_1aab56522c8a1051d89b2c64edf94ed54c:

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

	:ref:`tapi_memtier_proto<doxid-group__tapi__memtier_1ga02a65cee08bc139c73aab86b57a2f40b>` protocol

Protocol to use

.. index:: pair: variable; run_count
.. _doxid-structtapi__memtier__opt_1a07f360b905ec1523225d436f1b29de5c:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` run_count

Number of full-test iterations to perform

.. index:: pair: variable; requests
.. _doxid-structtapi__memtier__opt_1a9525d11e26b93c6df5a8c52b9c80e623:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` requests

Total requests per client

.. index:: pair: variable; clients
.. _doxid-structtapi__memtier__opt_1a7c67f76a146c4e78746e43d4578af638:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` clients

Clients per thread

.. index:: pair: variable; threads
.. _doxid-structtapi__memtier__opt_1af3acd06264691db061f9d27d78e38e58:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` threads

Number of threads

.. index:: pair: variable; pipeline
.. _doxid-structtapi__memtier__opt_1a883a7e9ae2a881f9425ef2fb1b31d0b2:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` pipeline

Number of concurrent pipelined requests

.. index:: pair: variable; test_time
.. _doxid-structtapi__memtier__opt_1ae249e9bbaf0d98dd45ab6bd34c02843c:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` test_time

Number of seconds to run the test

.. index:: pair: variable; data_size
.. _doxid-structtapi__memtier__opt_1a61588858219b78dfc6dae0125ff163d6:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` data_size

Object data size in bytes

.. index:: pair: variable; random_data
.. _doxid-structtapi__memtier__opt_1a558583e3f1fe7797cbb95b334a0eff53:

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

	bool random_data

Indicate that data should be randomized

.. index:: pair: variable; ratio
.. _doxid-structtapi__memtier__opt_1af47659d560c91e7bfd176c781cfb8695:

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

	const char* ratio

Set:Get ratio (for example, "1:10")

.. index:: pair: variable; key_prefix
.. _doxid-structtapi__memtier__opt_1a9deddc71783eab216c91139a9e3b879f:

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

	const char* key_prefix

Prefix for keys (default: "memtier-")

.. index:: pair: variable; key_pattern
.. _doxid-structtapi__memtier__opt_1ad330d552d73c7e19ebcc28f6b6d84f8d:

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

	const char* key_pattern

Set-Get key pattern. For example, "S:R" means that sets are sequential and gets are random. Supported options for sets and gets: G - Gaussian distribution R - uniform Random S - Sequential P - Parallel (sequential where every client has a subset of the key range)

.. index:: pair: variable; key_minimum
.. _doxid-structtapi__memtier__opt_1ab883c46e4c04c3d6bd45c406645c83b4:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` key_minimum

Minimum key ID

.. index:: pair: variable; key_maximum
.. _doxid-structtapi__memtier__opt_1ac07865b7ec23852885bd752a7871dde0:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` key_maximum

Maximum key ID

.. index:: pair: variable; hide_histogram
.. _doxid-structtapi__memtier__opt_1a393b6ed7adbb6ccf6600cdf38357a6f1:

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

	bool hide_histogram

Don't print detailed latency histogram

.. index:: pair: variable; debug
.. _doxid-structtapi__memtier__opt_1af091a2507ee50516c8e3932033481534:

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

	bool debug

Print debug output

.. index:: pair: variable; memtier_path
.. _doxid-structtapi__memtier__opt_1a8697816997fed43d637b5f752baf0606:

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

	const char* memtier_path

Path to memtier_benchmark executable