* that is being declared is random. This function has no effect
* if a category with the same name has been already declared.
*
- * See \ref tracing_tracing for details on how to trace
+ * See \ref tracing for details on how to trace
* the (categorized) resource utilization.
*
* \param category The name of the new tracing category to be created.
* can be specified using "0.7 0.7 0.7" as color. This function has
* no effect if a category with the same name has been already declared.
*
- * See \ref tracing_tracing for details on how to trace
+ * See \ref tracing for details on how to trace
* the (categorized) resource utilization.
*
* \param category The name of the new tracing category to be created.
- * \param color The color of the category (see \ref tracing_tracing to
+ * \param color The color of the category (see \ref tracing to
* know how to correctly specify the color)
*
* \see MSG_task_set_category, SD_task_set_category
* This function should be used to get categories that were already
* declared with #TRACE_category or with #TRACE_category_with_color.
*
- * See \ref tracing_tracing for details on how to trace
+ * See \ref tracing for details on how to trace
* the (categorized) resource utilization.
*
* \return A dynar with the declared categories, must be freed with xbt_dynar_free.
/* 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());
+ PJ_type_event_new(mark_type, PJ_type_get_root());
+ xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), NULL);
+}
+
+/** \ingroup TRACE_mark
+ * \brief Declare a new colored value for a previously declared mark type.
+ *
+ * This function declares a new colored 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. 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.
+ * If a NULL color is provided, the color used will be white ("1 1 1").
+ *
+ * \param mark_type The name of the new type.
+ * \param mark_value The name of the new value for this type.
+ * \param mark_color The color of the new value for this type.
+ *
+ * \see TRACE_mark
+ */
+void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color)
+{
+ /* 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);
+ }
+
+ char white[INSTR_DEFAULT_STR_SIZE] = "1.0 1.0 1.0";
+ if (!mark_color) mark_color = white;
+
+ XBT_DEBUG("MARK,declare_value %s %s %s", mark_type, mark_value, mark_color);
+ PJ_value_new (mark_value, mark_color, type);
+}
+
+/** \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. Calling this function is the same
+ * as calling \ref TRACE_declare_mark_value_with_color with a NULL color.
+ *
+ * \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)
+{
+ TRACE_declare_mark_value_with_color (mark_type, mark_value, NULL);
}
/**
/* 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);
}
{
container_t container = PJ_container_get(host);
type_t type = PJ_type_get (state, container->type);
- val_t val = PJ_value_get (value, type);
- if (val == NULL){
- //if user didn't declare a value with a color, user a NULL color
- PJ_value_new (value, NULL, 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);
}
{
container_t container = PJ_container_get(host);
type_t type = PJ_type_get (state, container->type);
- val_t val = PJ_value_get (value, type);
- if (val == NULL){
- //if user didn't declare a value with a color, user a NULL color
- PJ_value_new (value, NULL, 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);
}
return instr_dict_to_dynar (trivaEdgeTypes);
}
+/** \ingroup TRACE_API
+ * \brief Pauses all tracing activities.
+ * \see TRACE_resume
+ */
+void TRACE_pause (void)
+{
+ if (!TRACE_is_enabled()){
+ XBT_DEBUG ("Tracing is already paused, therefore do nothing.");
+ }else{
+ XBT_DEBUG ("Tracing is being paused.");
+ instr_pause_tracing();
+ }
+}
+
+/** \ingroup TRACE_API
+ * \brief Resumes all tracing activities.
+ * \see TRACE_pause
+ */
+void TRACE_resume (void)
+{
+ if (TRACE_is_enabled()){
+ XBT_DEBUG ("Tracing is already running while trying to resume, therefore do nothing.");
+ }else{
+ XBT_DEBUG ("Tracing is being resumed.");
+ instr_resume_tracing();
+ }
+}
+
#endif /* HAVE_TRACING */
