src/surf/storage_n11.cpp

   1 /* Copyright (c) 2013-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "storage_n11.hpp"
   8 #include "surf_private.h"
   9 #include <math.h> /*ceil*/
  10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_storage);
  11
  12 static int storage_selective_update = 0;
  13 static xbt_swag_t storage_running_action_set_that_does_not_need_being_checked = NULL;
  14
  15 /*************
  16  * CallBacks *
  17  *************/
  18
  19 static XBT_INLINE void routing_storage_type_free(void *r)
  20 {
  21   storage_type_t stype = (storage_type_t) r;
  22   free(stype->model);
  23   free(stype->type_id);
  24   free(stype->content);
  25   free(stype->content_type);
  26   xbt_dict_free(&(stype->properties));
  27   xbt_dict_free(&(stype->model_properties));
  28   free(stype);
  29 }
  30
  31 static XBT_INLINE void surf_storage_resource_free(void *r)
  32 {
  33   // specific to storage
  34   simgrid::surf::Storage *storage = static_cast<simgrid::surf::Storage*>(r);
  35   // generic resource
  36   delete storage;
  37 }
  38
  39 static XBT_INLINE void routing_storage_host_free(void *r)
  40 {
  41   xbt_dynar_t dyn = (xbt_dynar_t) r;
  42   xbt_dynar_free(&dyn);
  43 }
  44
  45 void storage_register_callbacks()
  46 {
  47   ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, xbt_free_f);
  48   ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib, routing_storage_host_free);
  49   ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib, routing_storage_type_free);
  50   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, surf_storage_resource_free);
  51 }
  52
  53 /*********
  54  * Model *
  55  *********/
  56
  57 void surf_storage_model_init_default(void)
  58 {
  59   surf_storage_model = new simgrid::surf::StorageN11Model();
  60   xbt_dynar_push(all_existing_models, &surf_storage_model);
  61 }
  62
  63 namespace simgrid {
  64 namespace surf {
  65
  66 StorageN11Model::StorageN11Model() : StorageModel() {
  67   Action *action = NULL;
  68
  69   XBT_DEBUG("surf_storage_model_init_internal");
  70
  71   storage_running_action_set_that_does_not_need_being_checked =
  72       xbt_swag_new(xbt_swag_offset(*action, p_stateHookup));
  73   if (!p_maxminSystem) {
  74     p_maxminSystem = lmm_system_new(storage_selective_update);
  75   }
  76 }
  77
  78 StorageN11Model::~StorageN11Model(){
  79   xbt_swag_free(storage_running_action_set_that_does_not_need_being_checked);
  80   storage_running_action_set_that_does_not_need_being_checked = NULL;
  81 }
  82
  83 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
  84 Storage *StorageN11Model::createStorage(const char* id, const char* type_id,
  85     const char* content_name, const char* content_type, xbt_dict_t properties,
  86     const char* attach)
  87 {
  88
  89   xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
  90       "Storage '%s' declared several times in the platform file",
  91       id);
  92
  93   storage_type_t storage_type = (storage_type_t) xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
  94
  95   double Bread  = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bread"),
  96       "property Bread, storage",type_id);
  97   double Bwrite = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bwrite"),
  98       "property Bwrite, storage",type_id);
  99   double Bconnection   = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bconnection"),
 100       "property Bconnection, storage",type_id);
 101
 102   Storage *storage = new StorageN11(this, id, properties, p_maxminSystem,
 103       Bread, Bwrite, Bconnection, type_id, (char *)content_name,
 104       xbt_strdup(content_type), storage_type->size, (char *) attach);
 105   storageCreatedCallbacks(storage);
 106   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
 107
 108   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tproperties '%p'\n\t\tBread '%f'\n",
 109       id,
 110       type_id,
 111       properties,
 112       Bread);
 113
 114   if(!p_storageList)
 115     p_storageList = xbt_dynar_new(sizeof(char *),NULL);
 116   xbt_dynar_push(p_storageList, &storage);
 117
 118   return storage;
 119 }
 120
 121 double StorageN11Model::next_occuring_event(double /*now*/)
 122 {
 123   XBT_DEBUG("storage_share_resources");
 124   unsigned int i, j;
 125   Storage *storage;
 126   void *_write_action;
 127   StorageAction *write_action;
 128
 129   double min_completion = shareResourcesMaxMin(getRunningActionSet(),
 130       p_maxminSystem, lmm_solve);
 131
 132   double rate;
 133   // Foreach disk
 134   xbt_dynar_foreach(p_storageList,i,storage)
 135   {
 136     rate = 0;
 137     // Foreach write action on disk
 138     xbt_dynar_foreach(storage->p_writeActions, j, _write_action)
 139     {
 140       write_action = static_cast<StorageAction*>(_write_action);
 141       rate += lmm_variable_getvalue(write_action->getVariable());
 142     }
 143     if(rate > 0)
 144       min_completion = MIN(min_completion, (storage->m_size-storage->m_usedSize)/rate);
 145   }
 146
 147   return min_completion;
 148 }
 149
 150 void StorageN11Model::updateActionsState(double /*now*/, double delta)
 151 {
 152   StorageAction *action = NULL;
 153
 154   ActionList *actionSet = getRunningActionSet();
 155   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 156       ; it != itend ; it=itNext) {
 157     ++itNext;
 158     action = static_cast<StorageAction*>(&*it);
 159
 160     if(action->m_type == WRITE)
 161     {
 162       // Update the disk usage
 163       // Update the file size
 164       // For each action of type write
 165       volatile double current_progress =
 166           delta * lmm_variable_getvalue(action->getVariable());
 167       long int incr = current_progress;
 168
 169       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, "
 170           "incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
 171           action->p_file->name,
 172           action->progress,  current_progress, incr,
 173           lrint(action->progress + current_progress),
 174           lrint(action->progress)+ incr);
 175
 176       /* take care of rounding error accumulation */
 177       if (lrint(action->progress + current_progress) >
 178       lrint(action->progress)+ incr)
 179         incr++;
 180
 181       action->progress +=current_progress;
 182
 183       action->p_storage->m_usedSize += incr; // disk usage
 184       action->p_file->current_position+= incr; // current_position
 185       //  which becomes the new file size
 186       action->p_file->size = action->p_file->current_position ;
 187
 188       sg_size_t *psize = xbt_new(sg_size_t,1);
 189       *psize = action->p_file->size;
 190       xbt_dict_t content_dict = action->p_storage->p_content;
 191       xbt_dict_set(content_dict, action->p_file->name, psize, NULL);
 192     }
 193
 194     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 195
 196     if (action->getMaxDuration() != NO_MAX_DURATION)
 197       action->updateMaxDuration(delta);
 198
 199     if(action->getRemainsNoUpdate() > 0 &&
 200         lmm_get_variable_weight(action->getVariable()) > 0 &&
 201         action->p_storage->m_usedSize == action->p_storage->m_size)
 202     {
 203       action->finish();
 204       action->setState(SURF_ACTION_FAILED);
 205     } else if ((action->getRemainsNoUpdate() <= 0) &&
 206         (lmm_get_variable_weight(action->getVariable()) > 0))
 207     {
 208       action->finish();
 209       action->setState(SURF_ACTION_DONE);
 210     } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
 211         (action->getMaxDuration() <= 0))
 212     {
 213       action->finish();
 214       action->setState(SURF_ACTION_DONE);
 215     }
 216   }
 217   return;
 218 }
 219
 220 /************
 221  * Resource *
 222  ************/
 223
 224 StorageN11::StorageN11(StorageModel *model, const char* name,
 225     xbt_dict_t properties, lmm_system_t maxminSystem, double bread,
 226     double bwrite, double bconnection, const char* type_id, char *content_name,
 227     char *content_type, sg_size_t size, char *attach)
 228 : Storage(model, name, properties,
 229     maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach) {
 230   XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%llu'", bconnection, bread, bwrite, size);
 231 }
 232
 233 StorageAction *StorageN11::open(const char* mount, const char* path)
 234 {
 235   XBT_DEBUG("\tOpen file '%s'",path);
 236
 237   sg_size_t size, *psize;
 238   psize = (sg_size_t*) xbt_dict_get_or_null(p_content, path);
 239   // if file does not exist create an empty file
 240   if(psize)
 241     size = *psize;
 242   else {
 243     psize = xbt_new(sg_size_t,1);
 244     size = 0;
 245     *psize = size;
 246     xbt_dict_set(p_content, path, psize, NULL);
 247     XBT_DEBUG("File '%s' was not found, file created.",path);
 248   }
 249   surf_file_t file = xbt_new0(s_surf_file_t,1);
 250   file->name = xbt_strdup(path);
 251   file->size = size;
 252   file->mount = xbt_strdup(mount);
 253   file->current_position = 0;
 254
 255   StorageAction *action = new StorageN11Action(getModel(), 0, isOff(), this, OPEN);
 256   action->p_file = file;
 257
 258   return action;
 259 }
 260
 261 StorageAction *StorageN11::close(surf_file_t fd)
 262 {
 263   char *filename = fd->name;
 264   XBT_DEBUG("\tClose file '%s' size '%llu'", filename, fd->size);
 265   // unref write actions from storage
 266   void *_write_action;
 267   StorageAction *write_action;
 268   unsigned int i;
 269   xbt_dynar_foreach(p_writeActions, i, _write_action) {
 270     write_action = static_cast<StorageAction*>(_write_action);
 271     if ((write_action->p_file) == fd) {
 272       xbt_dynar_cursor_rm(p_writeActions, &i);
 273       write_action->unref();
 274     }
 275   }
 276   free(fd->name);
 277   free(fd->mount);
 278   xbt_free(fd);
 279   StorageAction *action = new StorageN11Action(getModel(), 0, isOff(), this, CLOSE);
 280   return action;
 281 }
 282
 283 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
 284 {
 285   if(fd->current_position + size > fd->size){
 286     if (fd->current_position > fd->size){
 287       size = 0;
 288     } else {
 289       size = fd->size - fd->current_position;
 290     }
 291     fd->current_position = fd->size;
 292   }
 293   else
 294     fd->current_position += size;
 295
 296   StorageAction *action = new StorageN11Action(getModel(), size, isOff(), this, READ);
 297   return action;
 298 }
 299
 300 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
 301 {
 302   char *filename = fd->name;
 303   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
 304
 305   StorageAction *action = new StorageN11Action(getModel(), size, isOff(), this, WRITE);
 306   action->p_file = fd;
 307   /* Substract the part of the file that might disappear from the used sized on
 308    * the storage element */
 309   m_usedSize -= (fd->size - fd->current_position);
 310   // If the storage is full before even starting to write
 311   if(m_usedSize==m_size) {
 312     action->setState(SURF_ACTION_FAILED);
 313   }
 314   return action;
 315 }
 316
 317 /**********
 318  * Action *
 319  **********/
 320
 321 StorageN11Action::StorageN11Action(Model *model, double cost, bool failed, Storage *storage, e_surf_action_storage_type_t type)
 322 : StorageAction(model, cost, failed,
 323     lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0 , 3),
 324     storage, type) {
 325   XBT_IN("(%s,%g", storage->getName(), cost);
 326
 327   // Must be less than the max bandwidth for all actions
 328   lmm_expand(model->getMaxminSystem(), storage->getConstraint(), getVariable(), 1.0);
 329   switch(type) {
 330   case OPEN:
 331   case CLOSE:
 332   case STAT:
 333     break;
 334   case READ:
 335     lmm_expand(model->getMaxminSystem(), storage->p_constraintRead,
 336         getVariable(), 1.0);
 337     break;
 338   case WRITE:
 339     lmm_expand(model->getMaxminSystem(), storage->p_constraintWrite,
 340         getVariable(), 1.0);
 341
 342     //TODO there is something annoying with what's below. Have to sort it out...
 343     //    Action *action = this;
 344     //    xbt_dynar_push(storage->p_writeActions, &action);
 345     //    ref();
 346     break;
 347   }
 348   XBT_OUT();
 349 }
 350
 351 int StorageN11Action::unref()
 352 {
 353   m_refcount--;
 354   if (!m_refcount) {
 355     if (action_hook.is_linked())
 356       p_stateSet->erase(p_stateSet->iterator_to(*this));
 357     if (getVariable())
 358       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 359     xbt_free(getCategory());
 360     delete this;
 361     return 1;
 362   }
 363   return 0;
 364 }
 365
 366 void StorageN11Action::cancel()
 367 {
 368   setState(SURF_ACTION_FAILED);
 369   return;
 370 }
 371
 372 void StorageN11Action::suspend()
 373 {
 374   XBT_IN("(%p)", this);
 375   if (m_suspended != 2) {
 376     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 377     m_suspended = 1;
 378   }
 379   XBT_OUT();
 380 }
 381
 382 void StorageN11Action::resume()
 383 {
 384   THROW_UNIMPLEMENTED;
 385 }
 386
 387 bool StorageN11Action::isSuspended()
 388 {
 389   return m_suspended == 1;
 390 }
 391
 392 void StorageN11Action::setMaxDuration(double /*duration*/)
 393 {
 394   THROW_UNIMPLEMENTED;
 395 }
 396
 397 void StorageN11Action::setPriority(double /*priority*/)
 398 {
 399   THROW_UNIMPLEMENTED;
 400 }
 401
 402 }
 403 }