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   delete 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 =
  80       (storage_type_t)xbt_lib_get_or_null(storage_type_lib, type_id, ROUTING_STORAGE_TYPE_LEVEL);
  81
  82   double Bread =
  83       surf_parse_get_bandwidth(storage_type->model_properties->at("Bread").c_str(), "property Bread, storage", type_id);
  84   double Bwrite = surf_parse_get_bandwidth(storage_type->model_properties->at("Bwrite").c_str(),
  85                                            "property Bwrite, storage", type_id);
  86   double Bconnection = surf_parse_get_bandwidth(storage_type->model_properties->at("Bconnection").c_str(),
  87                                                 "property Bconnection, storage", type_id);
  88
  89   Storage* storage = new StorageN11(this, id, maxminSystem_, Bread, Bwrite, Bconnection, type_id, (char*)content_name,
  90                                     content_type, storage_type->size, (char*)attach);
  91   storageCreatedCallbacks(storage);
  92   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
  93
  94   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tBread '%f'\n", id, type_id, Bread);
  95
  96   p_storageList.push_back(storage);
  97
  98   return storage;
  99 }
 100
 101 double StorageN11Model::nextOccuringEvent(double now)
 102 {
 103   double min_completion = StorageModel::nextOccuringEventFull(now);
 104
 105   for(auto storage: p_storageList) {
 106     double rate = 0;
 107     // Foreach write action on that disk
 108     for (auto write_action: storage->writeActions_) {
 109       rate += lmm_variable_getvalue(write_action->getVariable());
 110     }
 111     if(rate > 0)
 112       min_completion = MIN(min_completion, (storage->size_-storage->usedSize_)/rate);
 113   }
 114
 115   return min_completion;
 116 }
 117
 118 void StorageN11Model::updateActionsState(double /*now*/, double delta)
 119 {
 120
 121   ActionList *actionSet = getRunningActionSet();
 122   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 123       ; it != itend ; it=itNext) {
 124     ++itNext;
 125
 126     StorageAction *action = static_cast<StorageAction*>(&*it);
 127
 128     if (action->type_ == WRITE) {
 129       // Update the disk usage
 130       // Update the file size
 131       // For each action of type write
 132       double current_progress = delta * lmm_variable_getvalue(action->getVariable());
 133       long int incr = current_progress;
 134
 135       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
 136                 action->file_->name, action->progress_, current_progress, incr,
 137                 lrint(action->progress_ + current_progress), lrint(action->progress_) + incr);
 138
 139       /* take care of rounding error accumulation */
 140       if (lrint(action->progress_ + current_progress) > lrint(action->progress_) + incr)
 141         incr++;
 142
 143       action->progress_ += current_progress;
 144
 145       action->storage_->usedSize_ += incr;     // disk usage
 146       action->file_->current_position += incr; // current_position
 147       //  which becomes the new file size
 148       action->file_->size = action->file_->current_position;
 149
 150       sg_size_t* psize = new sg_size_t;
 151       *psize           = action->file_->size;
 152       std::map<std::string, sg_size_t*>* content_dict = action->storage_->content_;
 153       auto entry = content_dict->find(action->file_->name);
 154       delete entry->second;
 155       entry->second = psize;
 156     }
 157
 158     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 159
 160     if (action->getMaxDuration() > NO_MAX_DURATION)
 161       action->updateMaxDuration(delta);
 162
 163     if (action->getRemainsNoUpdate() > 0 && lmm_get_variable_weight(action->getVariable()) > 0 &&
 164         action->storage_->usedSize_ == action->storage_->size_) {
 165       action->finish();
 166       action->setState(Action::State::failed);
 167     } else if (((action->getRemainsNoUpdate() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
 168                ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
 169       action->finish();
 170       action->setState(Action::State::done);
 171     }
 172   }
 173 }
 174
 175 /************
 176  * Resource *
 177  ************/
 178
 179 StorageN11::StorageN11(StorageModel* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite,
 180                        double bconnection, const char* type_id, char* content_name, const char* content_type,
 181                        sg_size_t size, char* attach)
 182     : Storage(model, name, maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach)
 183 {
 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;
 192   sg_size_t* psize = nullptr;
 193   // if file does not exist create an empty file
 194   if (content_->find(path) != content_->end())
 195     size = *(content_->at(path));
 196   else {
 197     psize  = new sg_size_t;
 198     size   = 0;
 199     *psize = size;
 200     content_->insert({path, psize});
 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(model(), 0, isOff(), this, OPEN);
 210   action->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->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(model(), 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(model(), 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(model(), size, isOff(), this, WRITE);
 258   action->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->cname(), cost);
 277
 278   // Must be less than the max bandwidth for all actions
 279   lmm_expand(model->getMaxminSystem(), storage->constraint(), 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   default:
 297     THROW_UNIMPLEMENTED;
 298   }
 299   XBT_OUT();
 300 }
 301
 302 int StorageN11Action::unref()
 303 {
 304   refcount_--;
 305   if (!refcount_) {
 306     if (action_hook.is_linked())
 307       stateSet_->erase(stateSet_->iterator_to(*this));
 308     if (getVariable())
 309       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 310     xbt_free(getCategory());
 311     delete this;
 312     return 1;
 313   }
 314   return 0;
 315 }
 316
 317 void StorageN11Action::cancel()
 318 {
 319   setState(Action::State::failed);
 320 }
 321
 322 void StorageN11Action::suspend()
 323 {
 324   XBT_IN("(%p)", this);
 325   if (suspended_ != 2) {
 326     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 327     suspended_ = 1;
 328   }
 329   XBT_OUT();
 330 }
 331
 332 void StorageN11Action::resume()
 333 {
 334   THROW_UNIMPLEMENTED;
 335 }
 336
 337 bool StorageN11Action::isSuspended()
 338 {
 339   return suspended_ == 1;
 340 }
 341
 342 void StorageN11Action::setMaxDuration(double /*duration*/)
 343 {
 344   THROW_UNIMPLEMENTED;
 345 }
 346
 347 void StorageN11Action::setPriority(double /*priority*/)
 348 {
 349   THROW_UNIMPLEMENTED;
 350 }
 351
 352 }
 353 }