+/* Copyright (c) 2006-2013. The SimGrid Team.
+ * All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
#include "private.h"
#include "simdag/simdag.h"
#include "xbt/dict.h"
+#include "xbt/lib.h"
#include "xbt/sysdep.h"
#include "surf/surf.h"
+#include "surf/surf_resource.h"
+
+
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
+ "Logging specific to SimDag (workstation)");
/* Creates a workstation and registers it in SD.
*/
-SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data) {
- CHECK_INIT_DONE();
- xbt_assert0(surf_workstation != NULL, "surf_workstation is NULL !");
+SD_workstation_t __SD_workstation_create(void *surf_workstation,
+ void *data)
+{
- SD_workstation_data_t sd_data = xbt_new0(s_SD_workstation_data_t, 1); /* workstation private data */
- sd_data->surf_workstation = surf_workstation;
-
- SD_workstation_t workstation = xbt_new0(s_SD_workstation_t, 1);
- workstation->data = data; /* user data */
- workstation->sd_data = sd_data; /* private data */
-
- const char *name = SD_workstation_get_name(workstation);
- xbt_dict_set(sd_global->workstations, name, workstation, __SD_workstation_destroy); /* add the workstation to the dictionary */
+ SD_workstation_priv_t workstation;
+ const char *name;
- /* TODO: route */
- return workstation;
+ workstation = xbt_new(s_SD_workstation_priv_t, 1);
+ workstation->data = data; /* user data */
+ workstation->access_mode = SD_WORKSTATION_SHARED_ACCESS; /* default mode is shared */
+ workstation->task_fifo = NULL;
+ workstation->current_task = NULL;
+
+ name = surf_resource_name(surf_workstation);
+ xbt_lib_set(host_lib,name,SD_HOST_LEVEL,workstation);
+ return xbt_lib_get_elm_or_null(host_lib,name);
}
-/* Returns a workstation given its name, or NULL if there is no such workstation.
+/* Creates a storage and registers it in SD.
*/
-SD_workstation_t SD_workstation_get_by_name(const char *name) {
- CHECK_INIT_DONE();
+SD_storage_t __SD_storage_create(void *surf_storage, void *data)
+{
+
+ SD_storage_priv_t storage;
+ const char *name;
- xbt_assert0(name != NULL, "Invalid parameter");
+ storage = xbt_new(s_SD_storage_priv_t, 1);
+ storage->data = data; /* user data */
- return xbt_dict_get_or_null(sd_global->workstations, name);
+ name = surf_resource_name(surf_storage);
+ xbt_lib_set(storage_lib,name, SD_STORAGE_LEVEL, storage);
+ return xbt_lib_get_elm_or_null(storage_lib, name);
}
-/* Returns a NULL-terminated array of existing workstations.
+/* Destroys a storage.
*/
-SD_workstation_t* SD_workstation_get_list(void) {
- CHECK_INIT_DONE();
+void __SD_storage_destroy(void *storage)
+{
+ SD_storage_priv_t s;
- SD_workstation_t* array = xbt_new0(SD_workstation_t, sd_global->workstation_count + 1);
-
- xbt_dict_cursor_t cursor;
+ s = (SD_storage_priv_t) storage;
+ xbt_free(s);
+}
+
+/**
+ * \brief Returns a workstation given its name
+ *
+ * If there is no such workstation, the function returns \c NULL.
+ *
+ * \param name workstation name
+ * \return the workstation, or \c NULL if there is no such workstation
+ */
+SD_workstation_t SD_workstation_get_by_name(const char *name)
+{
+ return xbt_lib_get_elm_or_null(host_lib, name);
+}
+
+/**
+ * \brief Returns the workstation list
+ *
+ * Use SD_workstation_get_number() to know the array size.
+ *
+ * \return an array of \ref SD_workstation_t containing all workstations
+ * \see SD_workstation_get_number()
+ */
+const SD_workstation_t *SD_workstation_get_list(void)
+{
+
+ xbt_lib_cursor_t cursor;
char *key;
- void *data;
- int i=0;
+ void **data;
+ int i;
+
+ xbt_assert(SD_workstation_get_number() > 0, "There is no workstation!");
- xbt_dict_foreach(sd_global->workstations,cursor,key,data) {
- array[i++] = (SD_workstation_t) data;
+ if (sd_global->workstation_list == NULL) { /* this is the first time the function is called */
+ sd_global->workstation_list =
+ xbt_new(SD_workstation_t, xbt_lib_length(host_lib));
+
+ i = 0;
+ xbt_lib_foreach(host_lib, cursor, key, data) {
+ if(data[SD_HOST_LEVEL])
+ sd_global->workstation_list[i++] = xbt_dict_cursor_get_elm(cursor);
+ }
}
- array[i] = NULL;
+ return sd_global->workstation_list;
+}
- return array;
+/**
+ * \brief Returns the number of workstations
+ *
+ * \return the number of existing workstations
+ * \see SD_workstation_get_list()
+ */
+int SD_workstation_get_number(void)
+{
+ return xbt_lib_length(host_lib);
}
-/* Returns the number or workstations.
+/**
+ * \brief Returns the user data of a workstation
+ *
+ * \param workstation a workstation
+ * \return the user data associated with this workstation (can be \c NULL)
+ * \see SD_workstation_set_data()
*/
-int SD_workstation_get_number(void) {
- CHECK_INIT_DONE();
- return sd_global->workstation_count;
+void *SD_workstation_get_data(SD_workstation_t workstation)
+{
+ return SD_workstation_priv(workstation)->data;
}
-/* Sets the data of a workstation. The new data can be NULL. The old data should have been freed first if it was not NULL.
+/**
+ * \brief Sets the user data of a workstation
+ *
+ * The new data can be \c NULL. The old data should have been freed first
+ * if it was not \c NULL.
+ *
+ * \param workstation a workstation
+ * \param data the new data you want to associate with this workstation
+ * \see SD_workstation_get_data()
*/
-void SD_workstation_set_data(SD_workstation_t workstation, void *data) {
- CHECK_INIT_DONE();
- xbt_assert0(workstation != NULL, "Invalid parameter");
- workstation->data = data;
+void SD_workstation_set_data(SD_workstation_t workstation, void *data)
+{
+ SD_workstation_priv(workstation)->data = data;
}
-/* Returns the data of a workstation. The user data can be NULL.
+/**
+ * \brief Returns the name of a workstation
+ *
+ * \param workstation a workstation
+ * \return the name of this workstation (cannot be \c NULL)
*/
-void* SD_workstation_get_data(SD_workstation_t workstation) {
- CHECK_INIT_DONE();
- xbt_assert0(workstation != NULL, "Invalid parameter");
- return workstation->data;
+const char *SD_workstation_get_name(SD_workstation_t workstation)
+{
+ return sg_host_name(workstation);
}
-/* Returns the name of a workstation.
+/**
+ * \brief Returns the value of a given workstation property
+ *
+ * \param ws a workstation
+ * \param name a property name
+ * \return value of a property (or NULL if property not set)
*/
-const char* SD_workstation_get_name(SD_workstation_t workstation) {
- CHECK_INIT_DONE();
- xbt_assert0(workstation != NULL, "Invalid parameter");
- return surf_workstation_resource->common_public->get_resource_name(workstation->sd_data->surf_workstation);
+const char *SD_workstation_get_property_value(SD_workstation_t ws,
+ const char *name)
+{
+ return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
}
-SD_link_t* SD_workstation_route_get_list(SD_workstation_t src, SD_workstation_t dst) {
- CHECK_INIT_DONE();
- /* TODO */
- return NULL;
+
+/**
+ * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
+ *
+ * \param workstation a workstation
+ * \return the dictionary containing the properties associated with the workstation
+ */
+xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
+{
+ return surf_workstation_model->extension.
+ workstation.get_properties(surf_workstation_resource_priv(workstation));
}
-int SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst) {
- CHECK_INIT_DONE();
- /* TODO */
- return 0;
+
+/** @brief Displays debugging informations about a workstation */
+void SD_workstation_dump(SD_workstation_t ws)
+{
+ xbt_dict_t props;
+ xbt_dict_cursor_t cursor=NULL;
+ char *key,*data;
+ SD_task_t task = NULL;
+
+ XBT_INFO("Displaying workstation %s", SD_workstation_get_name(ws));
+ XBT_INFO(" - power: %.0f", SD_workstation_get_power(ws));
+ XBT_INFO(" - available power: %.2f", SD_workstation_get_available_power(ws));
+ switch (SD_workstation_priv(ws)->access_mode){
+ case SD_WORKSTATION_SHARED_ACCESS:
+ XBT_INFO(" - access mode: Space shared");
+ break;
+ case SD_WORKSTATION_SEQUENTIAL_ACCESS:
+ XBT_INFO(" - access mode: Exclusive");
+ task = SD_workstation_get_current_task(ws);
+ if(task)
+ XBT_INFO(" current running task: %s",
+ SD_task_get_name(task));
+ else
+ XBT_INFO(" no task running");
+ break;
+ default: break;
+ }
+ props = SD_workstation_get_properties(ws);
+
+ if (!xbt_dict_is_empty(props)){
+ XBT_INFO(" - properties:");
+
+ xbt_dict_foreach(props,cursor,key,data) {
+ XBT_INFO(" %s->%s",key,data);
+ }
+ }
+}
+
+/**
+ * \brief Returns the route between two workstations
+ *
+ * Use SD_route_get_size() to know the array size.
+ *
+ * \param src a workstation
+ * \param dst another workstation
+ * \return a new array of \ref SD_link_t representating the route between these two workstations
+ * \see SD_route_get_size(), SD_link_t
+ */
+const SD_link_t *SD_route_get_list(SD_workstation_t src,
+ SD_workstation_t dst)
+{
+ void *surf_src;
+ void *surf_dst;
+ xbt_dynar_t surf_route;
+ const char *link_name;
+ void *surf_link;
+ unsigned int cpt;
+
+ if (sd_global->recyclable_route == NULL) {
+ /* first run */
+ sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
+ }
+
+ surf_src = src;
+ surf_dst = dst;
+ surf_route =
+ surf_workstation_model->extension.workstation.get_route(surf_src,
+ surf_dst);
+
+ xbt_dynar_foreach(surf_route, cpt, surf_link) {
+ link_name = surf_resource_name(surf_link);
+ sd_global->recyclable_route[cpt] =
+ xbt_lib_get_or_null(link_lib, link_name, SD_LINK_LEVEL);
+ }
+ return sd_global->recyclable_route;
+}
+
+/**
+ * \brief Returns the number of links on the route between two workstations
+ *
+ * \param src a workstation
+ * \param dst another workstation
+ * \return the number of links on the route between these two workstations
+ * \see SD_route_get_list()
+ */
+int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
+{
+ return xbt_dynar_length(surf_workstation_model->extension.
+ workstation.get_route(src, dst));
}
-/* Returns the total power of a workstation.
+/**
+ * \brief Returns the total power of a workstation
+ *
+ * \param workstation a workstation
+ * \return the total power of this workstation
+ * \see SD_workstation_get_available_power()
*/
-double SD_workstation_get_power(SD_workstation_t workstation) {
- CHECK_INIT_DONE();
- xbt_assert0(workstation != NULL, "Invalid parameter");
- return surf_workstation_resource->extension_public->get_speed(workstation->sd_data->surf_workstation, 1.0);
+double SD_workstation_get_power(SD_workstation_t workstation)
+{
+ return surf_workstation_model->extension.workstation.
+ get_speed(workstation, 1.0);
}
-/* Returns the proportion of available power in a workstation (normally a number between 0 and 1).
+/**
+ * \brief Returns the proportion of available power in a workstation
+ *
+ * \param workstation a workstation
+ * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
+ * \see SD_workstation_get_power()
*/
-double SD_workstation_get_available_power(SD_workstation_t workstation) {
- CHECK_INIT_DONE();
- xbt_assert0(workstation != NULL, "Invalid parameter");
- return surf_workstation_resource->extension_public->get_available_speed(workstation->sd_data->surf_workstation);
+double SD_workstation_get_available_power(SD_workstation_t workstation)
+{
+ return surf_workstation_model->extension.
+ workstation.get_available_speed(workstation);
}
-/* Destroys a workstation. The user data (if any) should have been destroyed first.
+/**
+ * \brief Returns an approximative estimated time for the given computation amount on a workstation
+ *
+ * \param workstation a workstation
+ * \param computation_amount the computation amount you want to evaluate (in flops)
+ * \return an approximative estimated computation time for the given computation amount on this workstation (in seconds)
*/
-void __SD_workstation_destroy(void *workstation) {
- CHECK_INIT_DONE();
- xbt_assert0(workstation != NULL, "Invalid parameter");
+double SD_workstation_get_computation_time(SD_workstation_t workstation,
+ double computation_amount)
+{
+ xbt_assert(computation_amount >= 0,
+ "computation_amount must be greater than or equal to zero");
+ return computation_amount / SD_workstation_get_power(workstation);
+}
+
+/**
+ * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
+ * between the workstations.
+ *
+ * \param src the first workstation
+ * \param dst the second workstation
+ * \return the latency of the route between the two workstations (in seconds)
+ * \see SD_route_get_current_bandwidth()
+ */
+double SD_route_get_current_latency(SD_workstation_t src,
+ SD_workstation_t dst)
+{
+
+ const SD_link_t *links;
+ int nb_links;
+ double latency;
+ int i;
- if (((SD_workstation_t) workstation)->sd_data != NULL) {
- xbt_free(((SD_workstation_t) workstation)->sd_data);
+ links = SD_route_get_list(src, dst);
+ nb_links = SD_route_get_size(src, dst);
+ latency = 0.0;
+
+ for (i = 0; i < nb_links; i++) {
+ latency += SD_link_get_current_latency(links[i]);
}
-
- /* TODO: route */
- xbt_free(workstation);
+ return latency;
+}
+
+/**
+ * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
+ * between the workstations.
+ *
+ * \param src the first workstation
+ * \param dst the second workstation
+ * \return the bandwidth of the route between the two workstations (in bytes/second)
+ * \see SD_route_get_current_latency()
+ */
+double SD_route_get_current_bandwidth(SD_workstation_t src,
+ SD_workstation_t dst)
+{
+
+ const SD_link_t *links;
+ int nb_links;
+ double bandwidth;
+ double min_bandwidth;
+ int i;
+
+ links = SD_route_get_list(src, dst);
+ nb_links = SD_route_get_size(src, dst);
+ bandwidth = min_bandwidth = -1.0;
+
+
+ for (i = 0; i < nb_links; i++) {
+ bandwidth = SD_link_get_current_bandwidth(links[i]);
+ if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
+ min_bandwidth = bandwidth;
+ }
+
+ return min_bandwidth;
+}
+
+/**
+ * \brief Returns an approximative estimated time for the given
+ * communication amount between two workstations
+ *
+ * \param src the first workstation
+ * \param dst the second workstation
+ * \param communication_amount the communication amount you want to evaluate (in bytes)
+ * \return an approximative estimated computation time for the given communication amount
+ * between the workstations (in seconds)
+ */
+double SD_route_get_communication_time(SD_workstation_t src,
+ SD_workstation_t dst,
+ double communication_amount)
+{
+
+
+ /* total time = latency + transmission time of the slowest link
+ transmission time of a link = communication amount / link bandwidth */
+
+ const SD_link_t *links;
+ int nb_links;
+ double bandwidth, min_bandwidth;
+ double latency;
+ int i;
+
+ xbt_assert(communication_amount >= 0,
+ "communication_amount must be greater than or equal to zero");
+
+
+
+ if (communication_amount == 0.0)
+ return 0.0;
+
+ links = SD_route_get_list(src, dst);
+ nb_links = SD_route_get_size(src, dst);
+ min_bandwidth = -1.0;
+ latency = 0;
+
+ for (i = 0; i < nb_links; i++) {
+ latency += SD_link_get_current_latency(links[i]);
+ bandwidth = SD_link_get_current_bandwidth(links[i]);
+ if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
+ min_bandwidth = bandwidth;
+ }
+
+ return latency + (communication_amount / min_bandwidth);
+}
+
+/**
+ * \brief Returns the access mode of this workstation.
+ *
+ * \param workstation a workstation
+ * \return the access mode for the tasks running on this workstation:
+ * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
+ *
+ * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
+ */
+e_SD_workstation_access_mode_t
+SD_workstation_get_access_mode(SD_workstation_t workstation)
+{
+ return SD_workstation_priv(workstation)->access_mode;
+}
+
+/**
+ * \brief Sets the access mode for the tasks that will be executed on a workstation
+ *
+ * By default, a workstation model is shared, i.e. several tasks
+ * can be executed at the same time on a workstation. The CPU power of
+ * the workstation is shared between the running tasks on the workstation.
+ * In sequential mode, only one task can use the workstation, and the other
+ * tasks wait in a FIFO.
+ *
+ * \param workstation a workstation
+ * \param access_mode the access mode you want to set to this workstation:
+ * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
+ *
+ * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
+ */
+void SD_workstation_set_access_mode(SD_workstation_t workstation,
+ e_SD_workstation_access_mode_t
+ access_mode)
+{
+ xbt_assert(access_mode != SD_WORKSTATION_SEQUENTIAL_ACCESS ||
+ access_mode != SD_WORKSTATION_SHARED_ACCESS,
+ "Trying to set an invalid access mode");
+
+ if (access_mode == SD_workstation_priv(workstation)->access_mode) {
+ return; // nothing is changed
+ }
+
+ SD_workstation_priv(workstation)->access_mode = access_mode;
+
+ if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
+ xbt_fifo_free(SD_workstation_priv(workstation)->task_fifo);
+ SD_workstation_priv(workstation)->task_fifo = NULL;
+ } else {
+ SD_workstation_priv(workstation)->task_fifo = xbt_fifo_new();
+ }
+}
+
+/**
+ * \brief Return the list of mounted storages on a workstation.
+ *
+ * \param workstation a workstation
+ * \return a dynar containing all mounted storages on the workstation
+ */
+xbt_dict_t SD_workstation_get_storage_list(SD_workstation_t workstation){
+ return surf_workstation_model->extension.workstation.get_storage_list(workstation);
+}
+
+/* Returns whether a task can start now on a workstation*/
+/*
+ int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
+ SD_CHECK_INIT_DONE();
+ xbt_assert(workstation != NULL && task != NULL, "Invalid parameter");
+
+ return !__SD_workstation_is_busy(workstation) &&
+ (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
+ }
+*/
+
+/* Returns whether a workstation is busy. A workstation is busy is it is
+ * in sequential mode and a task is running on it or the fifo is not empty.
+ */
+int __SD_workstation_is_busy(SD_workstation_t workstation)
+{
+ XBT_DEBUG
+ ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
+ SD_workstation_get_name(workstation),
+ (SD_workstation_priv(workstation)->access_mode ==
+ SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
+ (SD_workstation_priv(workstation)->current_task ?
+ SD_task_get_name(SD_workstation_priv(workstation)->current_task)
+ : "none"),
+ (SD_workstation_priv(workstation)->task_fifo ? xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) :
+ 0));
+
+ return SD_workstation_priv(workstation)->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
+ (SD_workstation_priv(workstation)->current_task != NULL
+ || xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) > 0);
+}
+
+/* Destroys a workstation.
+ */
+void __SD_workstation_destroy(void *workstation)
+{
+
+ SD_workstation_priv_t w;
+
+ /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
+
+ w = (SD_workstation_priv_t) workstation;
+
+ if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
+ xbt_fifo_free(w->task_fifo);
+ }
+ xbt_free(w);
+}
+
+/**
+ * \brief Returns the kind of the task currently running on a workstation
+ * Only call this with sequential access mode set
+ * \param workstation a workstation */
+SD_task_t SD_workstation_get_current_task(SD_workstation_t workstation)
+{
+ xbt_assert(SD_workstation_priv(workstation)->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS,
+ "Access mode must be set to SD_WORKSTATION_SEQUENTIAL_ACCESS"
+ " to use this function");
+
+ return (SD_workstation_priv(workstation)->current_task);
+}
+
+/**
+ * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
+ * or router
+ *
+ * \param AS, router name
+ * \return the xbt_dict_t properties of the AS
+ */
+xbt_dict_t SD_as_router_get_properties(const char *asr)
+{
+ return get_as_router_properties(asr);
+}
+/**
+ * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
+ * or router
+ *
+ * \param AS, router name
+ * \param The name of a properties
+ * \return value of the properties
+ */
+const char* SD_as_router_get_property_value(const char *asr, const char *name)
+{
+ xbt_dict_t dict = get_as_router_properties(asr);
+ if(!dict) return NULL;
+ return xbt_dict_get_or_null(dict,name);
}
