StarPU Handbook

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Enumerations | Enumerator
StarPU-Top Interface

## Data Structures
struct | starpu_top_data
struct | starpu_top_param

## Enumerations
enum | starpu_top_data_type { STARPU_TOP_DATA_BOOLEAN, STARPU_TOP_DATA_INTEGER, STARPU_TOP_DATA_FLOAT }
enum | starpu_top_param_type { STARPU_TOP_PARAM_BOOLEAN, STARPU_TOP_PARAM_INTEGER, STARPU_TOP_PARAM_FLOAT, STARPU_TOP_PARAM_ENUM }
enum | starpu_top_message_type { TOP_TYPE_GO, TOP_TYPE_SET, TOP_TYPE_CONTINUE, TOP_TYPE_ENABLE, TOP_TYPE_DISABLE, TOP_TYPE_DEBUG, TOP_TYPE_UNKNOW }

## Functions to call before the initialisation
struct starpu_top_data * | starpu_top_add_data_boolean (const char *data_name, int active)
struct starpu_top_data * | starpu_top_add_data_integer (const char *data_name, int minimum_value, int maximum_value, int active)
struct starpu_top_data * | starpu_top_add_data_float (const char *data_name, double minimum_value, double maximum_value, int active)
struct starpu_top_param * | starpu_top_register_parameter_boolean (const char *param_name, int *parameter_field, void(*callback)(struct starpu_top_param *))
struct starpu_top_param * | starpu_top_register_parameter_float (const char *param_name, double *parameter_field, double minimum_value, double maximum_value, void(*callback)(struct starpu_top_param *))
struct starpu_top_param * | starpu_top_register_parameter_integer (const char *param_name, int *parameter_field, int minimum_value, int maximum_value, void(*callback)(struct starpu_top_param *))
struct starpu_top_param * | starpu_top_register_parameter_enum (const char *param_name, int *parameter_field, char **values, int nb_values, void(*callback)(struct starpu_top_param *))

## Initialisation
void | starpu_top_init_and_wait (const char *server_name)

## To call after initialisation
void | starpu_top_update_parameter (const struct starpu_top_param *param)
void | starpu_top_update_data_boolean (const struct starpu_top_data *data, int value)
void | starpu_top_update_data_integer (const struct starpu_top_data *data, int value)
void | starpu_top_update_data_float (const struct starpu_top_data *data, double value)
void | starpu_top_task_prevision (struct starpu_task *task, int devid, unsigned long long start, unsigned long long end)
void | starpu_top_debug_log (const char *message)
void | starpu_top_debug_lock (const char *message)

## Detailed Description

## Data Structure Documentation

struct starpu_top_data

todo

Data Fields
unsigned int | id | todo
const char * | name | todo
int | int_min_value | todo
int | int_max_value | todo
double | double_min_value | todo
double | double_max_value | todo
int | active | todo
enum starpu_top_data_type | type | todo
struct starpu_top_data * | next | todo

struct starpu_top_param

todo

### Data Fields
unsigned int | id
const char * | name
enum starpu_top_param_type | type
void * | value
char ** | enum_values
int | nb_values
void(* | callback )(struct starpu_top_param *)
int | int_min_value
int | int_max_value
double | double_min_value
double | double_max_value
struct starpu_top_param * | next

#### Field Documentation

starpu_top_param::id

todo

starpu_top_param::name

todo

starpu_top_param::type

todo

starpu_top_param::value

todo

starpu_top_param::enum_values

only for enum type can be NULL

starpu_top_param::nb_values

todo

starpu_top_param::callback

todo

starpu_top_param::int_min_value

only for integer type

starpu_top_param::int_max_value

todo

starpu_top_param::double_min_value

only for double type

starpu_top_param::double_max_value

todo

starpu_top_param::next

todo

## Enumeration Type Documentation

enum starpu_top_data_type

StarPU-Top Data type

Enumerator
STARPU_TOP_DATA_BOOLEAN | todo
STARPU_TOP_DATA_INTEGER | todo
STARPU_TOP_DATA_FLOAT | todo

enum starpu_top_param_type

StarPU-Top Parameter type

Enumerator
STARPU_TOP_PARAM_BOOLEAN | todo
STARPU_TOP_PARAM_INTEGER | todo
STARPU_TOP_PARAM_FLOAT | todo
STARPU_TOP_PARAM_ENUM | todo

enum starpu_top_message_type

StarPU-Top Message type

Enumerator
TOP_TYPE_GO | todo
TOP_TYPE_SET | todo
TOP_TYPE_CONTINUE | todo
TOP_TYPE_ENABLE | todo
TOP_TYPE_DISABLE | todo
TOP_TYPE_DEBUG | todo
TOP_TYPE_UNKNOW | todo

## Function Documentation

struct starpu_top_data * starpu_top_add_data_boolean | ( | const char * | data_name,
|  | int | active
| ) |  |

This fonction register a data named data_name of type boolean. If `active=0`, the value will NOT be displayed to user by default. Any other value will make the value displayed by default.

struct starpu_top_data * starpu_top_add_data_integer | ( | const char * | data_name,
|  | int | minimum_value,
|  | int | maximum_value,
|  | int | active
| ) |  |

This fonction register a data named `data_name` of type integer. The minimum and maximum value will be usefull to define the scale in UI. If `active=0`, the value will NOT be displayed to user by default. Any other value will make the value displayed by default.

struct starpu_top_data * starpu_top_add_data_float | ( | const char * | data_name,
|  | double | minimum_value,
|  | double | maximum_value,
|  | int | active
| ) |  |

This fonction register a data named data_name of type float. The minimum and maximum value will be usefull to define the scale in UI. If `active=0`, the value will NOT be displayed to user by default. Any other value will make the value displayed by default.

struct starpu_top_param * starpu_top_register_parameter_boolean | ( | const char * | param_name,
|  | int * | parameter_field,
|  | void(*)(struct starpu_top_param *) | callback
| ) |  |

This fonction register a parameter named `parameter_name`, of type boolean. The `callback` fonction will be called when the parameter is modified by UI, and can be null.

struct starpu_top_param * starpu_top_register_parameter_float | ( | const char * | param_name,
|  | double * | parameter_field,
|  | double | minimum_value,
|  | double | maximum_value,
|  | void(*)(struct starpu_top_param *) | callback
| ) |  |

his fonction register a parameter named `param_name`, of type integer. Minimum and maximum value will be used to prevent user seting incorrect value. The `callback` fonction will be called when the parameter is modified by UI, and can be null.

struct starpu_top_param * starpu_top_register_parameter_integer | ( | const char * | param_name,
|  | int * | parameter_field,
|  | int | minimum_value,
|  | int | maximum_value,
|  | void(*)(struct starpu_top_param *) | callback
| ) |  |

This fonction register a parameter named `param_name`, of type float. Minimum and maximum value will be used to prevent user seting incorrect value. The `callback` fonction will be called when the parameter is modified by UI, and can be null.

struct starpu_top_param * starpu_top_register_parameter_enum | ( | const char * | param_name,
|  | int * | parameter_field,
|  | char ** | values,
|  | int | nb_values,
|  | void(*)(struct starpu_top_param *) | callback
| ) |  |

This fonction register a parameter named `param_name`, of type enum. Minimum and maximum value will be used to prevent user seting incorrect value. The `callback` fonction will be called when the parameter is modified by UI, and can be null.

void starpu_top_init_and_wait | ( | const char * | server_name | ) |

This function must be called when all parameters and data have been registered AND initialised (for parameters). This function will wait for a TOP to connect, send initialisation sentences, and wait for the GO message.

void starpu_top_update_parameter | ( | const struct starpu_top_param * | param | ) |

This function should be called after every modification of a parameter from something other than starpu_top. This fonction notice UI that the configuration changed.

void starpu_top_update_data_boolean | ( | const struct starpu_top_data * | data,
|  | int | value
| ) |  |

This function updates the value of the starpu_top_data on UI.

void starpu_top_update_data_integer | ( | const struct starpu_top_data * | data,
|  | int | value
| ) |  |

This function updates the value of the starpu_top_data on UI.

void starpu_top_update_data_float | ( | const struct starpu_top_data * | data,
|  | double | value
| ) |  |

This function updates the value of the starpu_top_data on UI.

void starpu_top_task_prevision | ( | struct starpu_task * | task,
|  | int | devid,
|  | unsigned long long | start,
|  | unsigned long long | end
| ) |  |

This function notifies UI than the task have been planed to run from start to end, on computation-core.

void starpu_top_debug_log | ( | const char * | message | ) |

This function is useful in debug mode. The starpu developper doesn't need to check if the debug mode is active. This is checked by starpu_top itsefl. It just send a message to display by UI.

void starpu_top_debug_lock | ( | const char * | message | ) |

This function is useful in debug mode. The starpu developper doesn't need to check if the debug mode is active. This is checked by starpu_top itsefl. It send a message and wait for a continue message from UI to return. The lock (wich create a stop-point) should be called only by the main thread. Calling it from more than one thread is not supported.