SimGrid
3.11
Versatile Simulation of Distributed Systems
|
Functions to declare and define user variables associated to resources. More...
Functions | |
void | TRACE_vm_variable_declare (const char *variable) |
Declare a new user variable associated to VMs. More... | |
void | TRACE_vm_variable_declare_with_color (const char *variable, const char *color) |
Declare a new user variable associated to VMs with a color. More... | |
void | TRACE_vm_variable_set (const char *vm, const char *variable, double value) |
Set the value of a variable of a host. More... | |
void | TRACE_vm_variable_add (const char *vm, const char *variable, double value) |
Add a value to a variable of a VM. More... | |
void | TRACE_vm_variable_sub (const char *vm, const char *variable, double value) |
Subtract a value from a variable of a VM. More... | |
void | TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value) |
Set the value of a variable of a VM at a given timestamp. More... | |
void | TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value) |
Add a value to a variable of a VM at a given timestamp. More... | |
void | TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value) |
Subtract a value from a variable of a VM at a given timestamp. More... | |
xbt_dynar_t | TRACE_get_vm_variables (void) |
Get declared user vm variables. More... | |
void | TRACE_host_variable_declare (const char *variable) |
Declare a new user variable associated to hosts. More... | |
void | TRACE_host_variable_declare_with_color (const char *variable, const char *color) |
Declare a new user variable associated to hosts with a color. More... | |
void | TRACE_host_variable_set (const char *host, const char *variable, double value) |
Set the value of a variable of a host. More... | |
void | TRACE_host_variable_add (const char *host, const char *variable, double value) |
Add a value to a variable of a host. More... | |
void | TRACE_host_variable_sub (const char *host, const char *variable, double value) |
Subtract a value from a variable of a host. More... | |
void | TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value) |
Set the value of a variable of a host at a given timestamp. More... | |
void | TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value) |
Add a value to a variable of a host at a given timestamp. More... | |
void | TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value) |
Subtract a value from a variable of a host at a given timestamp. More... | |
xbt_dynar_t | TRACE_get_host_variables (void) |
Get declared user host variables. More... | |
void | TRACE_link_variable_declare (const char *variable) |
Declare a new user variable associated to links. More... | |
void | TRACE_link_variable_declare_with_color (const char *variable, const char *color) |
Declare a new user variable associated to links with a color. More... | |
void | TRACE_link_variable_set (const char *link, const char *variable, double value) |
Set the value of a variable of a link. More... | |
void | TRACE_link_variable_add (const char *link, const char *variable, double value) |
Add a value to a variable of a link. More... | |
void | TRACE_link_variable_sub (const char *link, const char *variable, double value) |
Subtract a value from a variable of a link. More... | |
void | TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value) |
Set the value of a variable of a link at a given timestamp. More... | |
void | TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value) |
Add a value to a variable of a link at a given timestamp. More... | |
void | TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value) |
Subtract a value from a variable of a link at a given timestamp. More... | |
void | TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value) |
Set the value of the variable present in the links connecting source and destination. More... | |
void | TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value) |
Add a value to the variable present in the links connecting source and destination. More... | |
void | TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value) |
Subtract a value from the variable present in the links connecting source and destination. More... | |
void | TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value) |
Set the value of the variable present in the links connecting source and destination at a given timestamp. More... | |
void | TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value) |
Add a value to the variable present in the links connecting source and destination at a given timestamp. More... | |
void | TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value) |
Subtract a value from the variable present in the links connecting source and destination at a given timestamp. More... | |
xbt_dynar_t | TRACE_get_link_variables (void) |
Get declared user link variables. More... | |
void | TRACE_host_state_declare (const char *state) |
Declare a new user state associated to hosts. More... | |
void | TRACE_host_state_declare_value (const char *state, const char *value, const char *color) |
Declare a new value for a user state associated to hosts. More... | |
void | TRACE_host_set_state (const char *host, const char *state, const char *value) |
Set the user state to the given value. More... | |
void | TRACE_host_push_state (const char *host, const char *state, const char *value) |
Push a new value for a state of a given host. More... | |
void | TRACE_host_pop_state (const char *host, const char *state) |
Pop the last value of a state of a given host. More... | |
void | TRACE_host_reset_state (const char *host, const char *state) |
Reset the state of a given host. More... | |
Functions to declare and define user variables associated to resources.
void TRACE_vm_variable_declare | ( | const char * | variable | ) |
Declare a new user variable associated to VMs.
Declare a user variable that will be associated to VMs. A user vm variable can be used to trace user variables such as the number of tasks in a VM, the number of clients in an application (for VMs), and so on. The color associated to this new variable will be random.
variable | The name of the new variable to be declared. |
void TRACE_vm_variable_declare_with_color | ( | const char * | variable, |
const char * | color | ||
) |
Declare a new user variable associated to VMs with a color.
Same as TRACE_vm_variable_declare, but associated a color to the newly created user host variable. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.
variable | The name of the new variable to be declared. |
color | The color for the new variable. |
void TRACE_vm_variable_set | ( | const char * | vm, |
const char * | variable, | ||
double | value | ||
) |
Set the value of a variable of a host.
vm | The name of the VM to be considered. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_vm_variable_add | ( | const char * | vm, |
const char * | variable, | ||
double | value | ||
) |
Add a value to a variable of a VM.
vm | The name of the VM to be considered. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_vm_variable_sub | ( | const char * | vm, |
const char * | variable, | ||
double | value | ||
) |
Subtract a value from a variable of a VM.
vm | The name of the vm to be considered. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
void TRACE_vm_variable_set_with_time | ( | double | time, |
const char * | vm, | ||
const char * | variable, | ||
double | value | ||
) |
Set the value of a variable of a VM at a given timestamp.
Same as TRACE_vm_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
vm | The name of the VM to be considered. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_vm_variable_add_with_time | ( | double | time, |
const char * | vm, | ||
const char * | variable, | ||
double | value | ||
) |
Add a value to a variable of a VM at a given timestamp.
Same as TRACE_vm_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
vm | The name of the VM to be considered. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_vm_variable_sub_with_time | ( | double | time, |
const char * | vm, | ||
const char * | variable, | ||
double | value | ||
) |
Subtract a value from a variable of a VM at a given timestamp.
Same as TRACE_vm_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
vm | The name of the VM to be considered. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
xbt_dynar_t TRACE_get_vm_variables | ( | void | ) |
Get declared user vm variables.
This function should be used to get VM variables that were already declared with TRACE_vm_variable_declare or with TRACE_vm_variable_declare_with_color.
void TRACE_host_variable_declare | ( | const char * | variable | ) |
Declare a new user variable associated to hosts.
Declare a user variable that will be associated to hosts. A user host variable can be used to trace user variables such as the number of tasks in a server, the number of clients in an application (for hosts), and so on. The color associated to this new variable will be random.
variable | The name of the new variable to be declared. |
void TRACE_host_variable_declare_with_color | ( | const char * | variable, |
const char * | color | ||
) |
Declare a new user variable associated to hosts with a color.
Same as TRACE_host_variable_declare, but associated a color to the newly created user host variable. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.
variable | The name of the new variable to be declared. |
color | The color for the new variable. |
void TRACE_host_variable_set | ( | const char * | host, |
const char * | variable, | ||
double | value | ||
) |
Set the value of a variable of a host.
host | The name of the host to be considered. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_host_variable_add | ( | const char * | host, |
const char * | variable, | ||
double | value | ||
) |
Add a value to a variable of a host.
host | The name of the host to be considered. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_host_variable_sub | ( | const char * | host, |
const char * | variable, | ||
double | value | ||
) |
Subtract a value from a variable of a host.
host | The name of the host to be considered. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
void TRACE_host_variable_set_with_time | ( | double | time, |
const char * | host, | ||
const char * | variable, | ||
double | value | ||
) |
Set the value of a variable of a host at a given timestamp.
Same as TRACE_host_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
host | The name of the host to be considered. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_host_variable_add_with_time | ( | double | time, |
const char * | host, | ||
const char * | variable, | ||
double | value | ||
) |
Add a value to a variable of a host at a given timestamp.
Same as TRACE_host_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
host | The name of the host to be considered. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_host_variable_sub_with_time | ( | double | time, |
const char * | host, | ||
const char * | variable, | ||
double | value | ||
) |
Subtract a value from a variable of a host at a given timestamp.
Same as TRACE_host_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
host | The name of the host to be considered. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
xbt_dynar_t TRACE_get_host_variables | ( | void | ) |
Get declared user host variables.
This function should be used to get host variables that were already declared with TRACE_host_variable_declare or with TRACE_host_variable_declare_with_color.
void TRACE_link_variable_declare | ( | const char * | variable | ) |
Declare a new user variable associated to links.
Declare a user variable that will be associated to links. A user link variable can be used, for example, to trace user variables such as the number of messages being transferred through network links. The color associated to this new variable will be random.
variable | The name of the new variable to be declared. |
void TRACE_link_variable_declare_with_color | ( | const char * | variable, |
const char * | color | ||
) |
Declare a new user variable associated to links with a color.
Same as TRACE_link_variable_declare, but associated a color to the newly created user link variable. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.
variable | The name of the new variable to be declared. |
color | The color for the new variable. |
void TRACE_link_variable_set | ( | const char * | link, |
const char * | variable, | ||
double | value | ||
) |
Set the value of a variable of a link.
link | The name of the link to be considered. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_link_variable_add | ( | const char * | link, |
const char * | variable, | ||
double | value | ||
) |
Add a value to a variable of a link.
link | The name of the link to be considered. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_link_variable_sub | ( | const char * | link, |
const char * | variable, | ||
double | value | ||
) |
Subtract a value from a variable of a link.
link | The name of the link to be considered. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
void TRACE_link_variable_set_with_time | ( | double | time, |
const char * | link, | ||
const char * | variable, | ||
double | value | ||
) |
Set the value of a variable of a link at a given timestamp.
Same as TRACE_link_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
link | The name of the link to be considered. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_link_variable_add_with_time | ( | double | time, |
const char * | link, | ||
const char * | variable, | ||
double | value | ||
) |
Add a value to a variable of a link at a given timestamp.
Same as TRACE_link_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
link | The name of the link to be considered. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_link_variable_sub_with_time | ( | double | time, |
const char * | link, | ||
const char * | variable, | ||
double | value | ||
) |
Subtract a value from a variable of a link at a given timestamp.
Same as TRACE_link_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
link | The name of the link to be considered. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
void TRACE_link_srcdst_variable_set | ( | const char * | src, |
const char * | dst, | ||
const char * | variable, | ||
double | value | ||
) |
Set the value of the variable present in the links connecting source and destination.
Same as TRACE_link_variable_set, but instead of providing the name of link to be considered, provide the source and destination hosts. All links that are part of the route between source and destination will have the variable set to the provided value.
src | The name of the source host for get route. |
dst | The name of the destination host for get route. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_link_srcdst_variable_add | ( | const char * | src, |
const char * | dst, | ||
const char * | variable, | ||
double | value | ||
) |
Add a value to the variable present in the links connecting source and destination.
Same as TRACE_link_variable_add, but instead of providing the name of link to be considered, provide the source and destination hosts. All links that are part of the route between source and destination will have the value passed as parameter added to the current value of the variable name to be considered.
src | The name of the source host for get route. |
dst | The name of the destination host for get route. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_link_srcdst_variable_sub | ( | const char * | src, |
const char * | dst, | ||
const char * | variable, | ||
double | value | ||
) |
Subtract a value from the variable present in the links connecting source and destination.
Same as TRACE_link_variable_sub, but instead of providing the name of link to be considered, provide the source and destination hosts. All links that are part of the route between source and destination will have the value passed as parameter subtracted from the current value of the variable name to be considered.
src | The name of the source host for get route. |
dst | The name of the destination host for get route. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
void TRACE_link_srcdst_variable_set_with_time | ( | double | time, |
const char * | src, | ||
const char * | dst, | ||
const char * | variable, | ||
double | value | ||
) |
Set the value of the variable present in the links connecting source and destination at a given timestamp.
Same as TRACE_link_srcdst_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
src | The name of the source host for get route. |
dst | The name of the destination host for get route. |
variable | The name of the variable to be considered. |
value | The new value of the variable. |
void TRACE_link_srcdst_variable_add_with_time | ( | double | time, |
const char * | src, | ||
const char * | dst, | ||
const char * | variable, | ||
double | value | ||
) |
Add a value to the variable present in the links connecting source and destination at a given timestamp.
Same as TRACE_link_srcdst_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
src | The name of the source host for get route. |
dst | The name of the destination host for get route. |
variable | The name of the variable to be considered. |
value | The value to be added to the variable. |
void TRACE_link_srcdst_variable_sub_with_time | ( | double | time, |
const char * | src, | ||
const char * | dst, | ||
const char * | variable, | ||
double | value | ||
) |
Subtract a value from the variable present in the links connecting source and destination at a given timestamp.
Same as TRACE_link_srcdst_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.
time | The timestamp to be used to tag this change of value. |
src | The name of the source host for get route. |
dst | The name of the destination host for get route. |
variable | The name of the variable to be considered. |
value | The value to be subtracted from the variable. |
xbt_dynar_t TRACE_get_link_variables | ( | void | ) |
Get declared user link variables.
This function should be used to get link variables that were already declared with TRACE_link_variable_declare or with TRACE_link_variable_declare_with_color.
void TRACE_host_state_declare | ( | const char * | state | ) |
Declare a new user state associated to hosts.
Declare a user state that will be associated to hosts. A user host state can be used to trace application states.
state | The name of the new state to be declared. |
void TRACE_host_state_declare_value | ( | const char * | state, |
const char * | value, | ||
const char * | color | ||
) |
Declare a new value for a user state associated to hosts.
Declare a value for a state. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.
state | The name of the new state to be declared. |
value | The name of the value |
color | The color of the value |
void TRACE_host_set_state | ( | const char * | host, |
const char * | state, | ||
const char * | value | ||
) |
Set the user state to the given value.
Change a user state previously declared to the given value.
host | The name of the host to be considered. |
state | The name of the state previously declared. |
value | The new value of the state. |
void TRACE_host_push_state | ( | const char * | host, |
const char * | state, | ||
const char * | value | ||
) |
Push a new value for a state of a given host.
Change a user state previously declared by pushing the new value to the state.
host | The name of the host to be considered. |
state | The name of the state previously declared. |
value | The value to be pushed. |
void TRACE_host_pop_state | ( | const char * | host, |
const char * | state | ||
) |
Pop the last value of a state of a given host.
Change a user state previously declared by removing the last value of the state.
host | The name of the host to be considered. |
state | The name of the state to be popped. |
void TRACE_host_reset_state | ( | const char * | host, |
const char * | state | ||
) |
Reset the state of a given host.
Clear all previous values of a user state.
host | The name of the host to be considered. |
state | The name of the state to be cleared. |