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 Storage *StorageN11Model::createStorage(const char* id, const char* type_id,
  84     const char* content_name, const char* content_type, xbt_dict_t properties,
  85     const char* attach)
  86 {
  87
  88   xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
  89       "Storage '%s' declared several times in the platform file",
  90       id);
  91
  92   storage_type_t storage_type = (storage_type_t) xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
  93
  94   double Bread  = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bread"),
  95       "property Bread, storage",type_id);
  96   double Bwrite = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bwrite"),
  97       "property Bwrite, storage",type_id);
  98   double Bconnection   = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bconnection"),
  99       "property Bconnection, storage",type_id);
 100
 101   Storage *storage = new StorageN11(this, id, properties, p_maxminSystem,
 102       Bread, Bwrite, Bconnection, type_id, (char *)content_name,
 103       xbt_strdup(content_type), storage_type->size, (char *) attach);
 104   storageCreatedCallbacks(storage);
 105   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
 106
 107   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tproperties '%p'\n\t\tBread '%f'\n",
 108       id,
 109       type_id,
 110       properties,
 111       Bread);
 112
 113   if(!p_storageList)
 114     p_storageList = xbt_dynar_new(sizeof(char *),NULL);
 115   xbt_dynar_push(p_storageList, &storage);
 116
 117   return storage;
 118 }
 119
 120 double StorageN11Model::next_occuring_event(double /*now*/)
 121 {
 122   XBT_DEBUG("storage_share_resources");
 123   unsigned int i, j;
 124   Storage *storage;
 125   void *_write_action;
 126   StorageAction *write_action;
 127
 128   double min_completion = shareResourcesMaxMin(getRunningActionSet(),
 129       p_maxminSystem, lmm_solve);
 130
 131   double rate;
 132   // Foreach disk
 133   xbt_dynar_foreach(p_storageList,i,storage)
 134   {
 135     rate = 0;
 136     // Foreach write action on disk
 137     xbt_dynar_foreach(storage->p_writeActions, j, _write_action)
 138     {
 139       write_action = static_cast<StorageAction*>(_write_action);
 140       rate += lmm_variable_getvalue(write_action->getVariable());
 141     }
 142     if(rate > 0)
 143       min_completion = MIN(min_completion, (storage->m_size-storage->m_usedSize)/rate);
 144   }
 145
 146   return min_completion;
 147 }
 148
 149 void StorageN11Model::updateActionsState(double /*now*/, double delta)
 150 {
 151   StorageAction *action = NULL;
 152
 153   ActionList *actionSet = getRunningActionSet();
 154   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 155       ; it != itend ; it=itNext) {
 156     ++itNext;
 157     action = static_cast<StorageAction*>(&*it);
 158
 159     if(action->m_type == WRITE)
 160     {
 161       // Update the disk usage
 162       // Update the file size
 163       // For each action of type write
 164       volatile double current_progress =
 165           delta * lmm_variable_getvalue(action->getVariable());
 166       long int incr = current_progress;
 167
 168       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, "
 169           "incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
 170           action->p_file->name,
 171           action->progress,  current_progress, incr,
 172           lrint(action->progress + current_progress),
 173           lrint(action->progress)+ incr);
 174
 175       /* take care of rounding error accumulation */
 176       if (lrint(action->progress + current_progress) >
 177       lrint(action->progress)+ incr)
 178         incr++;
 179
 180       action->progress +=current_progress;
 181
 182       action->p_storage->m_usedSize += incr; // disk usage
 183       action->p_file->current_position+= incr; // current_position
 184       //  which becomes the new file size
 185       action->p_file->size = action->p_file->current_position ;
 186
 187       sg_size_t *psize = xbt_new(sg_size_t,1);
 188       *psize = action->p_file->size;
 189       xbt_dict_t content_dict = action->p_storage->p_content;
 190       xbt_dict_set(content_dict, action->p_file->name, psize, NULL);
 191     }
 192
 193     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 194
 195     if (action->getMaxDuration() != NO_MAX_DURATION)
 196       action->updateMaxDuration(delta);
 197
 198     if(action->getRemainsNoUpdate() > 0 &&
 199         lmm_get_variable_weight(action->getVariable()) > 0 &&
 200         action->p_storage->m_usedSize == action->p_storage->m_size)
 201     {
 202       action->finish();
 203       action->setState(SURF_ACTION_FAILED);
 204     } else if ((action->getRemainsNoUpdate() <= 0) &&
 205         (lmm_get_variable_weight(action->getVariable()) > 0))
 206     {
 207       action->finish();
 208       action->setState(SURF_ACTION_DONE);
 209     } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
 210         (action->getMaxDuration() <= 0))
 211     {
 212       action->finish();
 213       action->setState(SURF_ACTION_DONE);
 214     }
 215   }
 216   return;
 217 }
 218
 219 /************
 220  * Resource *
 221  ************/
 222
 223 StorageN11::StorageN11(StorageModel *model, const char* name,
 224     xbt_dict_t properties, lmm_system_t maxminSystem, double bread,
 225     double bwrite, double bconnection, const char* type_id, char *content_name,
 226     char *content_type, sg_size_t size, char *attach)
 227 : Storage(model, name, properties,
 228     maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach) {
 229   XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%llu'", bconnection, bread, bwrite, size);
 230 }
 231
 232 StorageAction *StorageN11::open(const char* mount, const char* path)
 233 {
 234   XBT_DEBUG("\tOpen file '%s'",path);
 235
 236   sg_size_t size, *psize;
 237   psize = (sg_size_t*) xbt_dict_get_or_null(p_content, path);
 238   // if file does not exist create an empty file
 239   if(psize)
 240     size = *psize;
 241   else {
 242     psize = xbt_new(sg_size_t,1);
 243     size = 0;
 244     *psize = size;
 245     xbt_dict_set(p_content, path, psize, NULL);
 246     XBT_DEBUG("File '%s' was not found, file created.",path);
 247   }
 248   surf_file_t file = xbt_new0(s_surf_file_t,1);
 249   file->name = xbt_strdup(path);
 250   file->size = size;
 251   file->mount = xbt_strdup(mount);
 252   file->current_position = 0;
 253
 254   StorageAction *action = new StorageN11Action(getModel(), 0, isOff(), this, OPEN);
 255   action->p_file = file;
 256
 257   return action;
 258 }
 259
 260 StorageAction *StorageN11::close(surf_file_t fd)
 261 {
 262   char *filename = fd->name;
 263   XBT_DEBUG("\tClose file '%s' size '%llu'", filename, fd->size);
 264   // unref write actions from storage
 265   void *_write_action;
 266   StorageAction *write_action;
 267   unsigned int i;
 268   xbt_dynar_foreach(p_writeActions, i, _write_action) {
 269     write_action = static_cast<StorageAction*>(_write_action);
 270     if ((write_action->p_file) == fd) {
 271       xbt_dynar_cursor_rm(p_writeActions, &i);
 272       write_action->unref();
 273     }
 274   }
 275   free(fd->name);
 276   free(fd->mount);
 277   xbt_free(fd);
 278   StorageAction *action = new StorageN11Action(getModel(), 0, isOff(), this, CLOSE);
 279   return action;
 280 }
 281
 282 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
 283 {
 284   if(fd->current_position + size > fd->size){
 285     if (fd->current_position > fd->size){
 286       size = 0;
 287     } else {
 288       size = fd->size - fd->current_position;
 289     }
 290     fd->current_position = fd->size;
 291   }
 292   else
 293     fd->current_position += size;
 294
 295   StorageAction *action = new StorageN11Action(getModel(), size, isOff(), this, READ);
 296   return action;
 297 }
 298
 299 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
 300 {
 301   char *filename = fd->name;
 302   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
 303
 304   StorageAction *action = new StorageN11Action(getModel(), size, isOff(), this, WRITE);
 305   action->p_file = fd;
 306   /* Substract the part of the file that might disappear from the used sized on
 307    * the storage element */
 308   m_usedSize -= (fd->size - fd->current_position);
 309   // If the storage is full before even starting to write
 310   if(m_usedSize==m_size) {
 311     action->setState(SURF_ACTION_FAILED);
 312   }
 313   return action;
 314 }
 315
 316 /**********
 317  * Action *
 318  **********/
 319
 320 StorageN11Action::StorageN11Action(Model *model, double cost, bool failed, Storage *storage, e_surf_action_storage_type_t type)
 321 : StorageAction(model, cost, failed,
 322     lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0 , 3),
 323     storage, type) {
 324   XBT_IN("(%s,%g", storage->getName(), cost);
 325
 326   // Must be less than the max bandwidth for all actions
 327   lmm_expand(model->getMaxminSystem(), storage->getConstraint(), getVariable(), 1.0);
 328   switch(type) {
 329   case OPEN:
 330   case CLOSE:
 331   case STAT:
 332     break;
 333   case READ:
 334     lmm_expand(model->getMaxminSystem(), storage->p_constraintRead,
 335         getVariable(), 1.0);
 336     break;
 337   case WRITE:
 338     lmm_expand(model->getMaxminSystem(), storage->p_constraintWrite,
 339         getVariable(), 1.0);
 340
 341     //TODO there is something annoying with what's below. Have to sort it out...
 342     //    Action *action = this;
 343     //    xbt_dynar_push(storage->p_writeActions, &action);
 344     //    ref();
 345     break;
 346   }
 347   XBT_OUT();
 348 }
 349
 350 int StorageN11Action::unref()
 351 {
 352   m_refcount--;
 353   if (!m_refcount) {
 354     if (action_hook.is_linked())
 355       p_stateSet->erase(p_stateSet->iterator_to(*this));
 356     if (getVariable())
 357       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 358     xbt_free(getCategory());
 359     delete this;
 360     return 1;
 361   }
 362   return 0;
 363 }
 364
 365 void StorageN11Action::cancel()
 366 {
 367   setState(SURF_ACTION_FAILED);
 368   return;
 369 }
 370
 371 void StorageN11Action::suspend()
 372 {
 373   XBT_IN("(%p)", this);
 374   if (m_suspended != 2) {
 375     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 376     m_suspended = 1;
 377   }
 378   XBT_OUT();
 379 }
 380
 381 void StorageN11Action::resume()
 382 {
 383   THROW_UNIMPLEMENTED;
 384 }
 385
 386 bool StorageN11Action::isSuspended()
 387 {
 388   return m_suspended == 1;
 389 }
 390
 391 void StorageN11Action::setMaxDuration(double /*duration*/)
 392 {
 393   THROW_UNIMPLEMENTED;
 394 }
 395
 396 void StorageN11Action::setPriority(double /*priority*/)
 397 {
 398   THROW_UNIMPLEMENTED;
 399 }
 400
 401 }
 402 }