Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MSG storage API improvements
[simgrid.git] / src / simdag / sd_workstation.c
index 00066e7..1936cb7 100644 (file)
@@ -1,34 +1,63 @@
+/* Copyright (c) 2006-2011. 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)
+SD_workstation_t __SD_workstation_create(void *surf_workstation,
+                                         void *data)
 {
 
-  SD_workstation_t workstation;
+  SD_workstation_priv_t workstation;
   const char *name;
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(surf_workstation != NULL, "surf_workstation is NULL !");
 
-  workstation = xbt_new(s_SD_workstation_t, 1);
-  workstation->surf_workstation = surf_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 = SD_workstation_get_name(workstation);
-  xbt_dict_set(sd_global->workstations, name, workstation, __SD_workstation_destroy);   /* add the workstation to the dictionary */
-  sd_global->workstation_count++;
+  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);
+}
+
+/* Creates a storage and registers it in SD.
+ */
+SD_storage_t __SD_storage_create(void *surf_storage, void *data)
+{
+
+  SD_storage_priv_t storage;
+  const char *name;
+
+  storage = xbt_new(s_SD_storage_priv_t, 1);
+  storage->data = data;     /* user data */
 
-  return workstation;
+  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);
+}
+
+/* Destroys a storage.
+ */
+void __SD_storage_destroy(void *storage)
+{
+  xbt_free(storage);
 }
 
 /**
@@ -41,11 +70,7 @@ SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data)
  */
 SD_workstation_t SD_workstation_get_by_name(const char *name)
 {
-  SD_CHECK_INIT_DONE();
-
-  xbt_assert0(name != NULL, "Invalid parameter");
-
-  return xbt_dict_get_or_null(sd_global->workstations, name);
+  return xbt_lib_get_elm_or_null(host_lib, name);
 }
 
 /**
@@ -59,23 +84,21 @@ SD_workstation_t SD_workstation_get_by_name(const char *name)
 const SD_workstation_t *SD_workstation_get_list(void)
 {
 
-  xbt_dict_cursor_t cursor;
+  xbt_lib_cursor_t cursor;
   char *key;
-  void *data;
+  void **data;
   int i;
 
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(SD_workstation_get_number() > 0, "There is no workstation!");
-
-
+  xbt_assert(SD_workstation_get_number() > 0, "There is no workstation!");
 
   if (sd_global->workstation_list == NULL) {    /* this is the first time the function is called */
     sd_global->workstation_list =
-      xbt_new(SD_workstation_t, sd_global->workstation_count);
+      xbt_new(SD_workstation_t, xbt_lib_length(host_lib));
 
     i = 0;
-    xbt_dict_foreach(sd_global->workstations, cursor, key, data) {
-      sd_global->workstation_list[i++] = (SD_workstation_t) data;
+    xbt_lib_foreach(host_lib, cursor, key, data) {
+      if(data[SD_HOST_LEVEL])
+        sd_global->workstation_list[i++] = xbt_dict_cursor_get_elm(cursor);
     }
   }
   return sd_global->workstation_list;
@@ -89,8 +112,7 @@ const SD_workstation_t *SD_workstation_get_list(void)
  */
 int SD_workstation_get_number(void)
 {
-  SD_CHECK_INIT_DONE();
-  return sd_global->workstation_count;
+  return xbt_lib_length(host_lib);
 }
 
 /**
@@ -102,9 +124,7 @@ int SD_workstation_get_number(void)
  */
 void *SD_workstation_get_data(SD_workstation_t workstation)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
-  return workstation->data;
+  return SD_workstation_priv(workstation)->data;
 }
 
 /**
@@ -119,9 +139,7 @@ void *SD_workstation_get_data(SD_workstation_t workstation)
  */
 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
-  workstation->data = data;
+  SD_workstation_priv(workstation)->data = data;
 }
 
 /**
@@ -132,10 +150,7 @@ void SD_workstation_set_data(SD_workstation_t workstation, void *data)
  */
 const char *SD_workstation_get_name(SD_workstation_t workstation)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
-  return surf_workstation_model->get_resource_name(workstation->
-                                                   surf_workstation);
+  return sg_host_name(workstation);
 }
 
 /**
@@ -160,14 +175,47 @@ const char *SD_workstation_get_property_value(SD_workstation_t ws,
  */
 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0((workstation != NULL), "Invalid parameters");
+  return surf_workstation_model->extension.
+      workstation.get_properties(surf_workstation_resource_priv(workstation));
+}
 
-  return (surf_workstation_model->get_properties
-          (workstation->surf_workstation));
 
-}
+/** @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
@@ -179,41 +227,32 @@ xbt_dict_t SD_workstation_get_properties(SD_workstation_t 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)
+const SD_link_t *SD_route_get_list(SD_workstation_t src,
+                                   SD_workstation_t dst)
 {
   void *surf_src;
   void *surf_dst;
-  const void **surf_route;
-  int route_size;
+  xbt_dynar_t surf_route;
   const char *link_name;
-  int i;
-
-  SD_CHECK_INIT_DONE();
+  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_workstation;
-  surf_dst = dst->surf_workstation;
-
+  surf_src = src;
+  surf_dst = dst;
   surf_route =
-    surf_workstation_model->extension.workstation.get_route(surf_src,
-                                                            surf_dst);
-  route_size =
-    surf_workstation_model->extension.workstation.get_route_size(surf_src,
-                                                                 surf_dst);
-
-
-  for (i = 0; i < route_size; i++) {
-    link_name =
-      surf_workstation_model->extension.workstation.
-      get_link_name(surf_route[i]);
-    sd_global->recyclable_route[i] =
-      xbt_dict_get(sd_global->links, link_name);
-  }
+      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;
 }
 
@@ -227,9 +266,8 @@ const SD_link_t *SD_route_get_list(SD_workstation_t src, SD_workstation_t dst)
  */
 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
 {
-  SD_CHECK_INIT_DONE();
-  return surf_workstation_model->extension.workstation.
-    get_route_size(src->surf_workstation, dst->surf_workstation);
+  return xbt_dynar_length(surf_workstation_model->extension.
+                          workstation.get_route(src, dst));
 }
 
 /**
@@ -241,10 +279,8 @@ int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
  */
 double SD_workstation_get_power(SD_workstation_t workstation)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
   return surf_workstation_model->extension.workstation.
-    get_speed(workstation->surf_workstation, 1.0);
+      get_speed(workstation, 1.0);
 }
 
 /**
@@ -256,10 +292,8 @@ double SD_workstation_get_power(SD_workstation_t workstation)
  */
 double SD_workstation_get_available_power(SD_workstation_t workstation)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
   return surf_workstation_model->extension.
-    workstation.get_available_speed(workstation->surf_workstation);
+      workstation.get_available_speed(workstation);
 }
 
 /**
@@ -272,15 +306,13 @@ double SD_workstation_get_available_power(SD_workstation_t workstation)
 double SD_workstation_get_computation_time(SD_workstation_t workstation,
                                            double computation_amount)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
-  xbt_assert0(computation_amount >= 0,
+  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
+ * \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
@@ -297,8 +329,6 @@ double SD_route_get_current_latency(SD_workstation_t src,
   double latency;
   int i;
 
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
   links = SD_route_get_list(src, dst);
   nb_links = SD_route_get_size(src, dst);
   latency = 0.0;
@@ -311,7 +341,7 @@ double SD_route_get_current_latency(SD_workstation_t src,
 }
 
 /**
- * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
+ * \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
@@ -329,9 +359,6 @@ double SD_route_get_current_bandwidth(SD_workstation_t src,
   double min_bandwidth;
   int i;
 
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
-
   links = SD_route_get_list(src, dst);
   nb_links = SD_route_get_size(src, dst);
   bandwidth = min_bandwidth = -1.0;
@@ -371,9 +398,7 @@ double SD_route_get_communication_time(SD_workstation_t src,
   double latency;
   int i;
 
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
-  xbt_assert0(communication_amount >= 0,
+  xbt_assert(communication_amount >= 0,
               "communication_amount must be greater than or equal to zero");
 
 
@@ -405,12 +430,10 @@ double SD_route_get_communication_time(SD_workstation_t src,
  *
  * \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)
+e_SD_workstation_access_mode_t
+SD_workstation_get_access_mode(SD_workstation_t workstation)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
-  return workstation->access_mode;
+  return SD_workstation_priv(workstation)->access_mode;
 }
 
 /**
@@ -432,54 +455,64 @@ void SD_workstation_set_access_mode(SD_workstation_t workstation,
                                     e_SD_workstation_access_mode_t
                                     access_mode)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
+  xbt_assert(access_mode != SD_WORKSTATION_SEQUENTIAL_ACCESS ||
+             access_mode != SD_WORKSTATION_SHARED_ACCESS,
+             "Trying to set an invalid access mode");
 
-  if (access_mode == workstation->access_mode) {
+  if (access_mode == SD_workstation_priv(workstation)->access_mode) {
     return;                     // nothing is changed
   }
 
-  workstation->access_mode = access_mode;
+  SD_workstation_priv(workstation)->access_mode = access_mode;
 
   if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
-    xbt_fifo_free(workstation->task_fifo);
-    workstation->task_fifo = NULL;
+    xbt_fifo_free(SD_workstation_priv(workstation)->task_fifo);
+    SD_workstation_priv(workstation)->task_fifo = NULL;
   } else {
-    workstation->task_fifo = xbt_fifo_new();
+    SD_workstation_priv(workstation)->task_fifo = xbt_fifo_new();
   }
 }
 
-/* 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_assert0(workstation != NULL && task != NULL, "Invalid parameter");
+/**
+ * \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_dynar_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);
-                                                                                                                                                                                                                                                                                                                                                                                                   }
-                                                                                                                                                                                                                                                                                                                                                                                                 */
+  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)
 {
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
-
-  DEBUG4
-    ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
-     SD_workstation_get_name(workstation),
-     (workstation->access_mode ==
-      SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
-     (workstation->current_task ? SD_task_get_name(workstation->current_task)
-      : "none"),
-     (workstation->task_fifo ? xbt_fifo_size(workstation->task_fifo) : 0));
-
-  return workstation->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
-    (workstation->current_task != NULL
-     || xbt_fifo_size(workstation->task_fifo) > 0);
+  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.
@@ -487,16 +520,53 @@ int __SD_workstation_is_busy(SD_workstation_t workstation)
 void __SD_workstation_destroy(void *workstation)
 {
 
-  SD_workstation_t w;
+  SD_workstation_priv_t w;
 
-  SD_CHECK_INIT_DONE();
-  xbt_assert0(workstation != NULL, "Invalid parameter");
   /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
 
-  w = (SD_workstation_t) workstation;
+  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);
+}