TAPI to manage memtier_benchmark

Overview

// typedefs

typedef struct tapi_memtier_app tapi_memtier_app;
typedef struct tapi_memtier_op_stats tapi_memtier_op_stats;
typedef struct tapi_memtier_report tapi_memtier_report;
typedef enum tapi_memtier_proto tapi_memtier_proto;
typedef struct tapi_memtier_opt tapi_memtier_opt;

// enums

enum tapi_memtier_proto;

// structs

struct tapi_memtier_app;
struct tapi_memtier_op_stats;
struct tapi_memtier_opt;
struct tapi_memtier_report;

// global variables

const tapi_memtier_report tapi_memtier_default_report;
const tapi_memtier_opt tapi_memtier_default_opt;

// global functions

te_errno tapi_memtier_create(tapi_job_factory_t* factory, const tapi_memtier_opt* opt, tapi_memtier_app** app);
te_errno tapi_memtier_start(const tapi_memtier_app* app);
te_errno tapi_memtier_wait(const tapi_memtier_app* app, int timeout_ms);
te_errno tapi_memtier_stop(const tapi_memtier_app* app);
te_errno tapi_memtier_kill(const tapi_memtier_app* app, int signum);
te_errno tapi_memtier_destroy(tapi_memtier_app* app);
te_errno tapi_memtier_get_report(tapi_memtier_app* app, tapi_memtier_report* report);
te_errno tapi_memtier_report_mi_log(const tapi_memtier_report* report);
void tapi_memtier_destroy_report(tapi_memtier_report* report);

Detailed Documentation

Typedefs

typedef struct tapi_memtier_app tapi_memtier_app

memtier_benchmark tool information

typedef struct tapi_memtier_op_stats tapi_memtier_op_stats

Statistics for specific operation

typedef struct tapi_memtier_report tapi_memtier_report

memtier_benchmark information from stdout

typedef enum tapi_memtier_proto tapi_memtier_proto

Possible values for protocol option

typedef struct tapi_memtier_opt tapi_memtier_opt

memtier_benchmark command line options

Global Variables

const tapi_memtier_report tapi_memtier_default_report

Default report initializer

const tapi_memtier_opt tapi_memtier_default_opt

Default memtier_benchmark options initializer

Global Functions

te_errno tapi_memtier_create(tapi_job_factory_t* factory, const tapi_memtier_opt* opt, tapi_memtier_app** app)

Create memtier_benchmark app.

Parameters:

factory	Job factory.
opt	Application options.
app	Application handle.

Returns:

Status code.

te_errno tapi_memtier_start(const tapi_memtier_app* app)

Start memtier_benchmark app.

Parameters:

app	memtier_benchmark app handle.

Returns:

Status code.

te_errno tapi_memtier_wait(const tapi_memtier_app* app, int timeout_ms)

Wait for memtier_benchmark completion.

Parameters:

app	Application handle.
timeout_ms	Timeout in milliseconds.

Returns:

Status code.

te_errno tapi_memtier_stop(const tapi_memtier_app* app)

Stop memtier_benchmark. It can be started over with tapi_memtier_start().

Parameters:

app	Application handle.

Returns:

Status code.

te_errno tapi_memtier_kill(const tapi_memtier_app* app, int signum)

Send a signal to memtier_benchmark.

Parameters:

app	Application handle.
signum	Signal to send.

Returns:

Status code.

te_errno tapi_memtier_destroy(tapi_memtier_app* app)

Destroy memtier_benchmark.

Parameters:

app	Application handle.

Returns:

Status code.

te_errno tapi_memtier_get_report(tapi_memtier_app* app, tapi_memtier_report* report)

Get memtier_benchmark report.

Resources allocated for the report can be released with tapi_memtier_destroy_report().

Parameters:

app	Application handle.
report	Statistics report.

Returns:

Status code.

te_errno tapi_memtier_report_mi_log(const tapi_memtier_report* report)

Print MI log for memtier_benchmark report.

Parameters:

report

Report.

Returns:

Status code.

void tapi_memtier_destroy_report(tapi_memtier_report* report)

Release resources allocated for memtier_benchmark report.

Parameters:

report

Report