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 "simgrid/s4u/engine.hpp"
   9 #include "src/kernel/routing/NetPoint.hpp"
  10 #include "surf_private.h"
  11 #include <math.h> /*ceil*/
  12
  13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_storage);
  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 void check_disk_attachment()
  32 {
  33   xbt_lib_cursor_t cursor;
  34   char* key;
  35   void** data;
  36   xbt_lib_foreach(storage_lib, cursor, key, data) {
  37     if (xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL) != nullptr) {
  38       simgrid::surf::Storage* storage =
  39           static_cast<simgrid::surf::Storage*>(xbt_lib_get_or_null(storage_lib, key, SURF_STORAGE_LEVEL));
  40       simgrid::kernel::routing::NetPoint* host_elm = sg_netpoint_by_name_or_null(storage->attach_);
  41       if (!host_elm)
  42         surf_parse_error("Unable to attach storage %s: host %s does not exist.", storage->cname(), storage->attach_);
  43     }
  44   }
  45 }
  46
  47 void storage_register_callbacks()
  48 {
  49   simgrid::s4u::onPlatformCreated.connect(check_disk_attachment);
  50   instr_routing_define_callbacks();
  51
  52   ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, xbt_free_f);
  53   ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib, routing_storage_type_free);
  54   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, [](void *self) {
  55     delete static_cast<simgrid::surf::Storage*>(self);
  56   });
  57 }
  58
  59 /*********
  60  * Model *
  61  *********/
  62
  63 void surf_storage_model_init_default()
  64 {
  65   surf_storage_model = new simgrid::surf::StorageN11Model();
  66   all_existing_models->push_back(surf_storage_model);
  67 }
  68
  69 namespace simgrid {
  70 namespace surf {
  71
  72 Storage* StorageN11Model::createStorage(const char* id, const char* type_id, const char* content_name,
  73                                         const char* content_type, const char* attach)
  74 {
  75
  76   xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
  77       "Storage '%s' declared several times in the platform file", id);
  78
  79   storage_type_t storage_type = (storage_type_t) xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
  80
  81   double Bread  = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bread"),
  82       "property Bread, storage",type_id);
  83   double Bwrite = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bwrite"),
  84       "property Bwrite, storage",type_id);
  85   double Bconnection   = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bconnection"),
  86       "property Bconnection, storage",type_id);
  87
  88   Storage* storage = new StorageN11(this, id, maxminSystem_, Bread, Bwrite, Bconnection, type_id, (char*)content_name,
  89                                     content_type, storage_type->size, (char*)attach);
  90   storageCreatedCallbacks(storage);
  91   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
  92
  93   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tBread '%f'\n", id, type_id, 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->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->file_->name, action->progress_, current_progress, incr,
 136                 lrint(action->progress_ + current_progress), lrint(action->progress_) + incr);
 137
 138       /* take care of rounding error accumulation */
 139       if (lrint(action->progress_ + current_progress) > lrint(action->progress_) + incr)
 140         incr++;
 141
 142       action->progress_ += current_progress;
 143
 144       action->storage_->usedSize_ += incr;     // disk usage
 145       action->file_->current_position += incr; // current_position
 146       //  which becomes the new file size
 147       action->file_->size = action->file_->current_position;
 148
 149       sg_size_t* psize = new sg_size_t;
 150       *psize           = action->file_->size;
 151       std::map<std::string, sg_size_t*>* content_dict = action->storage_->content_;
 152       auto entry = content_dict->find(action->file_->name);
 153       delete entry->second;
 154       entry->second = psize;
 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->storage_->usedSize_ == action->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, lmm_system_t maxminSystem, double bread, double bwrite,
 179                        double bconnection, const char* type_id, char* content_name, const char* content_type,
 180                        sg_size_t size, char* attach)
 181     : Storage(model, name, maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach)
 182 {
 183   XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%llu'", bconnection, bread, bwrite, size);
 184 }
 185
 186 StorageAction *StorageN11::open(const char* mount, const char* path)
 187 {
 188   XBT_DEBUG("\tOpen file '%s'",path);
 189
 190   sg_size_t size;
 191   sg_size_t* psize = nullptr;
 192   // if file does not exist create an empty file
 193   if (content_->find(path) != content_->end())
 194     size = *(content_->at(path));
 195   else {
 196     psize  = new sg_size_t;
 197     size   = 0;
 198     *psize = size;
 199     content_->insert({path, psize});
 200     XBT_DEBUG("File '%s' was not found, file created.",path);
 201   }
 202   surf_file_t file = xbt_new0(s_surf_file_t,1);
 203   file->name = xbt_strdup(path);
 204   file->size = size;
 205   file->mount = xbt_strdup(mount);
 206   file->current_position = 0;
 207
 208   StorageAction* action = new StorageN11Action(model(), 0, isOff(), this, OPEN);
 209   action->file_         = file;
 210
 211   return action;
 212 }
 213
 214 StorageAction *StorageN11::close(surf_file_t fd)
 215 {
 216   XBT_DEBUG("\tClose file '%s' size '%llu'", fd->name, fd->size);
 217   // unref write actions from storage
 218   for (std::vector<StorageAction*>::iterator it = writeActions_.begin(); it != writeActions_.end();) {
 219     StorageAction *write_action = *it;
 220     if ((write_action->file_) == fd) {
 221       write_action->unref();
 222       it = writeActions_.erase(it);
 223     } else {
 224       ++it;
 225     }
 226   }
 227   free(fd->name);
 228   free(fd->mount);
 229   xbt_free(fd);
 230   StorageAction* action = new StorageN11Action(model(), 0, isOff(), this, CLOSE);
 231   return action;
 232 }
 233
 234 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
 235 {
 236   if(fd->current_position + size > fd->size){
 237     if (fd->current_position > fd->size){
 238       size = 0;
 239     } else {
 240       size = fd->size - fd->current_position;
 241     }
 242     fd->current_position = fd->size;
 243   }
 244   else
 245     fd->current_position += size;
 246
 247   StorageAction* action = new StorageN11Action(model(), size, isOff(), this, READ);
 248   return action;
 249 }
 250
 251 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
 252 {
 253   char *filename = fd->name;
 254   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
 255
 256   StorageAction* action = new StorageN11Action(model(), size, isOff(), this, WRITE);
 257   action->file_         = fd;
 258   /* Substract the part of the file that might disappear from the used sized on the storage element */
 259   usedSize_ -= (fd->size - fd->current_position);
 260   // If the storage is full before even starting to write
 261   if(usedSize_==size_) {
 262     action->setState(Action::State::failed);
 263   }
 264   return action;
 265 }
 266
 267 /**********
 268  * Action *
 269  **********/
 270
 271 StorageN11Action::StorageN11Action(Model *model, double cost, bool failed, Storage *storage, e_surf_action_storage_type_t type)
 272 : StorageAction(model, cost, failed,
 273     lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0 , 3),
 274     storage, type) {
 275   XBT_IN("(%s,%g", storage->cname(), cost);
 276
 277   // Must be less than the max bandwidth for all actions
 278   lmm_expand(model->getMaxminSystem(), storage->constraint(), getVariable(), 1.0);
 279   switch(type) {
 280   case OPEN:
 281   case CLOSE:
 282   case STAT:
 283     break;
 284   case READ:
 285     lmm_expand(model->getMaxminSystem(), storage->constraintRead_, getVariable(), 1.0);
 286     break;
 287   case WRITE:
 288     lmm_expand(model->getMaxminSystem(), storage->constraintWrite_, getVariable(), 1.0);
 289
 290     //TODO there is something annoying with what's below. Have to sort it out...
 291     //    Action *action = this;
 292     //    storage->p_writeActions->push_back(action);
 293     //    ref();
 294     break;
 295   default:
 296     THROW_UNIMPLEMENTED;
 297   }
 298   XBT_OUT();
 299 }
 300
 301 int StorageN11Action::unref()
 302 {
 303   refcount_--;
 304   if (!refcount_) {
 305     if (action_hook.is_linked())
 306       stateSet_->erase(stateSet_->iterator_to(*this));
 307     if (getVariable())
 308       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 309     xbt_free(getCategory());
 310     delete this;
 311     return 1;
 312   }
 313   return 0;
 314 }
 315
 316 void StorageN11Action::cancel()
 317 {
 318   setState(Action::State::failed);
 319 }
 320
 321 void StorageN11Action::suspend()
 322 {
 323   XBT_IN("(%p)", this);
 324   if (suspended_ != 2) {
 325     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 326     suspended_ = 1;
 327   }
 328   XBT_OUT();
 329 }
 330
 331 void StorageN11Action::resume()
 332 {
 333   THROW_UNIMPLEMENTED;
 334 }
 335
 336 bool StorageN11Action::isSuspended()
 337 {
 338   return suspended_ == 1;
 339 }
 340
 341 void StorageN11Action::setMaxDuration(double /*duration*/)
 342 {
 343   THROW_UNIMPLEMENTED;
 344 }
 345
 346 void StorageN11Action::setPriority(double /*priority*/)
 347 {
 348   THROW_UNIMPLEMENTED;
 349 }
 350
 351 }
 352 }