:orphan:

.. index:: pair: group; TAPI to manage memtier_benchmark
.. _doxid-group__tapi__memtier:

TAPI to manage memtier_benchmark
================================

.. toctree::
	:hidden:

	enum_tapi_memtier_proto.rst
	struct_tapi_memtier_app.rst
	struct_tapi_memtier_op_stats.rst
	struct_tapi_memtier_opt.rst
	struct_tapi_memtier_report.rst

Overview
~~~~~~~~




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

	
	// typedefs

	typedef struct :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>` :ref:`tapi_memtier_app<doxid-group__tapi__memtier_1ga5ddf7753c13c2256222ba7de44277359>`;
	typedef struct :ref:`tapi_memtier_op_stats<doxid-structtapi__memtier__op__stats>` :ref:`tapi_memtier_op_stats<doxid-group__tapi__memtier_1ga9a0d8098e39629aee0ded91a275f7102>`;
	typedef struct :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>` :ref:`tapi_memtier_report<doxid-group__tapi__memtier_1gabb2364649bc79db58e27c66693579391>`;
	typedef enum :ref:`tapi_memtier_proto<doxid-group__tapi__memtier_1ga02a65cee08bc139c73aab86b57a2f40b>` :ref:`tapi_memtier_proto<doxid-group__tapi__memtier_1gaeca8c36cef47b6dd0b37ec09ba8151a8>`;
	typedef struct :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>` :ref:`tapi_memtier_opt<doxid-group__tapi__memtier_1gaea4ae9b4a2c2dbdca02a65575a401ae3>`;

	// enums

	enum :ref:`tapi_memtier_proto<doxid-group__tapi__memtier_1ga02a65cee08bc139c73aab86b57a2f40b>`;

	// structs

	struct :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`;
	struct :ref:`tapi_memtier_op_stats<doxid-structtapi__memtier__op__stats>`;
	struct :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>`;
	struct :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`;

	// global variables

	const :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>` :ref:`tapi_memtier_default_report<doxid-group__tapi__memtier_1ga8f910f1dfb582f55338c94b67a0ca518>`;
	const :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>` :ref:`tapi_memtier_default_opt<doxid-group__tapi__memtier_1ga0c07745e97c2fd70b6f985efb77dde46>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_create<doxid-group__tapi__memtier_1gadd9e3fb9684121a1e275caa1178a1634>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>`* opt, :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_start<doxid-group__tapi__memtier_1gab68a37655d1ad5aaef578958015f4443>`(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_wait<doxid-group__tapi__memtier_1gafb4d30a129d2c7dc5e63126fe09d427c>`(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_stop<doxid-group__tapi__memtier_1ga4b5b00b4fd87ae74d082614460797163>`(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_kill<doxid-group__tapi__memtier_1ga62c6bdf258cda6f5c15c8c316371f6aa>`(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_destroy<doxid-group__tapi__memtier_1ga7561a1b1f03fa133148103e34d0ec64d>`(:ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_get_report<doxid-group__tapi__memtier_1gaad0086c0f21ab97ff8406fd7a3d33b9c>`(:ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app, :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`* report);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_memtier_report_mi_log<doxid-group__tapi__memtier_1gabc77d3ce6a70cba300499464f055f11e>`(const :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`* report);
	void :ref:`tapi_memtier_destroy_report<doxid-group__tapi__memtier_1gaebad52cd8dd0d64057395b81f74cc113>`(:ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`* report);

.. _details-group__tapi__memtier:

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



Typedefs
--------

.. index:: pair: typedef; tapi_memtier_app
.. _doxid-group__tapi__memtier_1ga5ddf7753c13c2256222ba7de44277359:

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

	typedef struct :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>` tapi_memtier_app

memtier_benchmark tool information

.. index:: pair: typedef; tapi_memtier_op_stats
.. _doxid-group__tapi__memtier_1ga9a0d8098e39629aee0ded91a275f7102:

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

	typedef struct :ref:`tapi_memtier_op_stats<doxid-structtapi__memtier__op__stats>` tapi_memtier_op_stats

Statistics for specific operation

.. index:: pair: typedef; tapi_memtier_report
.. _doxid-group__tapi__memtier_1gabb2364649bc79db58e27c66693579391:

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

	typedef struct :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>` tapi_memtier_report

memtier_benchmark information from stdout

.. index:: pair: typedef; tapi_memtier_proto
.. _doxid-group__tapi__memtier_1gaeca8c36cef47b6dd0b37ec09ba8151a8:

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

	typedef enum :ref:`tapi_memtier_proto<doxid-group__tapi__memtier_1ga02a65cee08bc139c73aab86b57a2f40b>` tapi_memtier_proto

Possible values for protocol option

.. index:: pair: typedef; tapi_memtier_opt
.. _doxid-group__tapi__memtier_1gaea4ae9b4a2c2dbdca02a65575a401ae3:

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

	typedef struct :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>` tapi_memtier_opt

memtier_benchmark command line options

Global Variables
----------------

.. index:: pair: variable; tapi_memtier_default_report
.. _doxid-group__tapi__memtier_1ga8f910f1dfb582f55338c94b67a0ca518:

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

	const :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>` tapi_memtier_default_report

Default report initializer

.. index:: pair: variable; tapi_memtier_default_opt
.. _doxid-group__tapi__memtier_1ga0c07745e97c2fd70b6f985efb77dde46:

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

	const :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>` tapi_memtier_default_opt

Default memtier_benchmark options initializer

Global Functions
----------------

.. index:: pair: function; tapi_memtier_create
.. _doxid-group__tapi__memtier_1gadd9e3fb9684121a1e275caa1178a1634:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_memtier_opt<doxid-structtapi__memtier__opt>`* opt, :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`** app)

Create memtier_benchmark app.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- factory

		- Job factory.

	*
		- opt

		- Application options.

	*
		- app

		- Application handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_start
.. _doxid-group__tapi__memtier_1gab68a37655d1ad5aaef578958015f4443:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_start(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app)

Start memtier_benchmark app.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- memtier_benchmark app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_wait
.. _doxid-group__tapi__memtier_1gafb4d30a129d2c7dc5e63126fe09d427c:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_wait(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app, int timeout_ms)

Wait for memtier_benchmark completion.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Application handle.

	*
		- timeout_ms

		- Timeout in milliseconds.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_stop
.. _doxid-group__tapi__memtier_1ga4b5b00b4fd87ae74d082614460797163:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_stop(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app)

Stop memtier_benchmark. It can be started over with :ref:`tapi_memtier_start() <doxid-group__tapi__memtier_1gab68a37655d1ad5aaef578958015f4443>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Application handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_kill
.. _doxid-group__tapi__memtier_1ga62c6bdf258cda6f5c15c8c316371f6aa:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_kill(const :ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app, int signum)

Send a signal to memtier_benchmark.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Application handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_destroy
.. _doxid-group__tapi__memtier_1ga7561a1b1f03fa133148103e34d0ec64d:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_destroy(:ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app)

Destroy memtier_benchmark.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Application handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_get_report
.. _doxid-group__tapi__memtier_1gaad0086c0f21ab97ff8406fd7a3d33b9c:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_get_report(:ref:`tapi_memtier_app<doxid-structtapi__memtier__app>`* app, :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`* report)

Get memtier_benchmark report.

Resources allocated for the report can be released with :ref:`tapi_memtier_destroy_report() <doxid-group__tapi__memtier_1gaebad52cd8dd0d64057395b81f74cc113>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Application handle.

	*
		- report

		- Statistics report.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_report_mi_log
.. _doxid-group__tapi__memtier_1gabc77d3ce6a70cba300499464f055f11e:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_memtier_report_mi_log(const :ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`* report)

Print MI log for memtier_benchmark report.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- report

		- Report.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_memtier_destroy_report
.. _doxid-group__tapi__memtier_1gaebad52cd8dd0d64057395b81f74cc113:

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

	void tapi_memtier_destroy_report(:ref:`tapi_memtier_report<doxid-structtapi__memtier__report>`* report)

Release resources allocated for memtier_benchmark report.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- report

		- Report