/* safe switch */
if (!TRACE_is_enabled()) return;
- if (!mark_type) return;
+ /* if platform is not traced, we don't allow marks */
+ if (!TRACE_needs_platform()) return;
+
+ if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
//check if mark_type is already declared
char *created = xbt_dict_get_or_null(declared_marks, mark_type);
- if (created) return;
- xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), NULL);
+ if (created) {
+ THROWF (tracing_error, 1, "mark_type with name (%s) is already declared", mark_type);
+ }
XBT_DEBUG("MARK,declare %s", mark_type);
PJ_type_event_new(mark_type, NULL, PJ_type_get_root());
+ xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), NULL);
+}
+
+
+/** \ingroup TRACE_mark
+ * \brief Declare a new value for a previously declared mark type.
+ *
+ * This function declares a new value for a Paje event
+ * type in the trace file that can be used by
+ * simulators to declare application-level
+ * marks. This function is independent of
+ * which API is used in SimGrid.
+ *
+ * \param mark_type The name of the new type.
+ * \param mark_value The name of the new value for this type.
+ *
+ * \see TRACE_mark
+ */
+void TRACE_declare_mark_value (const char *mark_type, const char *mark_value)
+{
+ /* safe switch */
+ if (!TRACE_is_enabled()) return;
+
+ /* if platform is not traced, we don't allow marks */
+ if (!TRACE_needs_platform()) return;
+
+ if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
+ if (!mark_value) THROWF (tracing_error, 1, "mark_value is NULL");
+
+ type_t type = PJ_type_get (mark_type, PJ_type_get_root());
+ if (!type){
+ THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
+ }
+
+ XBT_DEBUG("MARK,declare_value %s %s", mark_type, mark_value);
+ PJ_value_new (mark_value, NULL, type);
}
/**
/* safe switch */
if (!TRACE_is_enabled()) return;
- if (!mark_type || !mark_value) return;
+ /* if platform is not traced, we don't allow marks */
+ if (!TRACE_needs_platform()) return;
- //check if mark_type is already declared
- char *created = xbt_dict_get_or_null(declared_marks, mark_type);
- if (created) return;
+ if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
+ if (!mark_value) THROWF (tracing_error, 1, "mark_value is NULL");
- XBT_DEBUG("MARK %s %s", mark_type, mark_value);
+ //check if mark_type is already declared
type_t type = PJ_type_get (mark_type, PJ_type_get_root());
- if (type == NULL){
- THROWF (tracing_error, 1, "mark_type with name (%s) not declared before", mark_type);
+ if (!type){
+ THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
}
+
val_t value = PJ_value_get (mark_value, type);
- if (value == NULL){
- value = PJ_value_new (mark_value, NULL, type);
- }
+ XBT_DEBUG("MARK %s %s", mark_type, mark_value);
new_pajeNewEvent (MSG_get_clock(), PJ_container_get_root(), type, value);
}
return instr_dict_to_dynar (user_link_variables);
}
+/** \ingroup TRACE_user_variables
+ * \brief 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.
+ *
+ * \param state The name of the new state to be declared.
+ *
+ * \see TRACE_host_state_declare_value
+ */
+void TRACE_host_state_declare (const char *state)
+{
+ instr_new_user_state_type("HOST", state);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief 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.
+ *
+ * \param state The name of the new state to be declared.
+ * \param value The name of the value
+ * \param color The color of the value
+ *
+ * \see TRACE_host_state_declare
+ */
+void TRACE_host_state_declare_value (const char *state, const char *value, const char *color)
+{
+ instr_new_value_for_user_state_type (state, value, color);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Set the user state to the given value.
+ *
+ * Change a user state previously declared to the given value.
+ *
+ * \param host The name of the host to be considered.
+ * \param state The name of the state previously declared.
+ * \param value The new value of the state.
+ *
+ * \see TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state
+ */
+void TRACE_host_set_state (const char *host, const char *state, const char *value)
+{
+ container_t container = PJ_container_get(host);
+ type_t type = PJ_type_get (state, container->type);
+ val_t val = PJ_value_get_or_new (value, NULL, type); /* if user didn't declare a value with a color, user a NULL color */
+ new_pajeSetState(MSG_get_clock(), container, type, val);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief 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.
+ *
+ * \param host The name of the host to be considered.
+ * \param state The name of the state previously declared.
+ * \param value The value to be pushed.
+ *
+ * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state
+ */
+void TRACE_host_push_state (const char *host, const char *state, const char *value)
+{
+ container_t container = PJ_container_get(host);
+ type_t type = PJ_type_get (state, container->type);
+ val_t val = PJ_value_get_or_new (value, NULL, type); /* if user didn't declare a value with a color, user a NULL color */
+ new_pajePushState(MSG_get_clock(), container, type, val);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief 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.
+ *
+ * \param host The name of the host to be considered.
+ * \param state The name of the state to be popped.
+ *
+ * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state
+ */
+void TRACE_host_pop_state (const char *host, const char *state)
+{
+ container_t container = PJ_container_get(host);
+ type_t type = PJ_type_get (state, container->type);
+ new_pajePopState(MSG_get_clock(), container, type);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Reset the state of a given host.
+ *
+ * Clear all previous values of a user state.
+ *
+ * \param host The name of the host to be considered.
+ * \param state The name of the state to be cleared.
+ *
+ * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_pop_state
+ */
+void TRACE_host_reset_state (const char *host, const char *state)
+{
+ container_t container = PJ_container_get(host);
+ type_t type = PJ_type_get (state, container->type);
+ new_pajeResetState(MSG_get_clock(), container, type);
+}
+
/** \ingroup TRACE_API
* \brief Get Paje container types that can be mapped to the nodes of a graph.
*
