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