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