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