src/surf/storage_n11.cpp

   1 /* Copyright (c) 2013-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "storage_n11.hpp"
   7 #include "simgrid/s4u/Engine.hpp"
   8 #include "src/kernel/routing/NetPoint.hpp"
   9 #include <math.h> /*ceil*/
  10
  11 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_storage);
  12
  13 /*************
  14  * CallBacks *
  15  *************/
  16 extern std::map<std::string, storage_type_t> storage_types;
  17
  18 static void check_disk_attachment()
  19 {
  20   xbt_lib_cursor_t cursor;
  21   char* key;
  22   void** data;
  23   xbt_lib_foreach(storage_lib, cursor, key, data) {
  24     if (xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL) != nullptr) {
  25       simgrid::surf::StorageImpl* storage =
  26           static_cast<simgrid::surf::StorageImpl*>(xbt_lib_get_or_null(storage_lib, key, SURF_STORAGE_LEVEL));
  27       simgrid::kernel::routing::NetPoint* host_elm = sg_netpoint_by_name_or_null(storage->attach_);
  28       if (not host_elm)
  29         surf_parse_error("Unable to attach storage %s: host %s does not exist.", storage->cname(), storage->attach_);
  30     }
  31   }
  32 }
  33
  34 void storage_register_callbacks()
  35 {
  36   simgrid::s4u::onPlatformCreated.connect(check_disk_attachment);
  37   instr_routing_define_callbacks();
  38
  39   SURF_STORAGE_LEVEL =
  40       xbt_lib_add_level(storage_lib, [](void* self) { delete static_cast<simgrid::surf::StorageImpl*>(self); });
  41 }
  42
  43 /*********
  44  * Model *
  45  *********/
  46
  47 void surf_storage_model_init_default()
  48 {
  49   surf_storage_model = new simgrid::surf::StorageN11Model();
  50   all_existing_models->push_back(surf_storage_model);
  51 }
  52
  53 namespace simgrid {
  54 namespace surf {
  55
  56 StorageImpl* StorageN11Model::createStorage(const char* id, const char* type_id, const char* content_name,
  57                                             const char* attach)
  58 {
  59   storage_type_t storage_type = storage_types.at(type_id);
  60
  61   double Bread =
  62       surf_parse_get_bandwidth(storage_type->model_properties->at("Bread").c_str(), "property Bread, storage", type_id);
  63   double Bwrite = surf_parse_get_bandwidth(storage_type->model_properties->at("Bwrite").c_str(),
  64                                            "property Bwrite, storage", type_id);
  65
  66   StorageImpl* storage = new StorageN11(this, id, maxminSystem_, Bread, Bwrite, type_id, (char*)content_name,
  67                                         storage_type->size, (char*)attach);
  68   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
  69   storageCreatedCallbacks(storage);
  70
  71   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tBread '%f'\n", id, type_id, Bread);
  72
  73   p_storageList.push_back(storage);
  74
  75   return storage;
  76 }
  77
  78 double StorageN11Model::nextOccuringEvent(double now)
  79 {
  80   double min_completion = StorageModel::nextOccuringEventFull(now);
  81
  82   for(auto storage: p_storageList) {
  83     double rate = 0;
  84     // Foreach write action on that disk
  85     for (auto write_action: storage->writeActions_) {
  86       rate += lmm_variable_getvalue(write_action->getVariable());
  87     }
  88     if(rate > 0)
  89       min_completion = MIN(min_completion, (storage->size_-storage->usedSize_)/rate);
  90   }
  91
  92   return min_completion;
  93 }
  94
  95 void StorageN11Model::updateActionsState(double /*now*/, double delta)
  96 {
  97
  98   ActionList *actionSet = getRunningActionSet();
  99   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 100       ; it != itend ; it=itNext) {
 101     ++itNext;
 102
 103     StorageAction *action = static_cast<StorageAction*>(&*it);
 104
 105     if (action->type_ == WRITE) {
 106       // Update the disk usage
 107       // Update the file size
 108       // For each action of type write
 109       double current_progress = delta * lmm_variable_getvalue(action->getVariable());
 110       long int incr = current_progress;
 111
 112       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
 113                 action->file_->name, action->progress_, current_progress, incr,
 114                 lrint(action->progress_ + current_progress), lrint(action->progress_) + incr);
 115
 116       /* take care of rounding error accumulation */
 117       if (lrint(action->progress_ + current_progress) > lrint(action->progress_) + incr)
 118         incr++;
 119
 120       action->progress_ += current_progress;
 121
 122       action->storage_->usedSize_ += incr;     // disk usage
 123       action->file_->current_position += incr; // current_position
 124       //  which becomes the new file size
 125       action->file_->size = action->file_->current_position;
 126
 127       sg_size_t* psize = new sg_size_t;
 128       *psize           = action->file_->size;
 129       std::map<std::string, sg_size_t*>* content_dict = action->storage_->content_;
 130       auto entry = content_dict->find(action->file_->name);
 131       delete entry->second;
 132       entry->second = psize;
 133     }
 134
 135     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 136
 137     if (action->getMaxDuration() > NO_MAX_DURATION)
 138       action->updateMaxDuration(delta);
 139
 140     if (action->getRemainsNoUpdate() > 0 && lmm_get_variable_weight(action->getVariable()) > 0 &&
 141         action->storage_->usedSize_ == action->storage_->size_) {
 142       action->finish();
 143       action->setState(Action::State::failed);
 144     } else if (((action->getRemainsNoUpdate() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
 145                ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
 146       action->finish();
 147       action->setState(Action::State::done);
 148     }
 149   }
 150 }
 151
 152 /************
 153  * Resource *
 154  ************/
 155
 156 StorageN11::StorageN11(StorageModel* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite,
 157                        const char* type_id, char* content_name, sg_size_t size, char* attach)
 158     : StorageImpl(model, name, maxminSystem, bread, bwrite, type_id, content_name, size, attach)
 159 {
 160   XBT_DEBUG("Create resource with Bread '%f' Bwrite '%f' and Size '%llu'", bread, bwrite, size);
 161   simgrid::s4u::Storage::onCreation(this->piface_);
 162 }
 163
 164 StorageAction *StorageN11::open(const char* mount, const char* path)
 165 {
 166   XBT_DEBUG("\tOpen file '%s'",path);
 167
 168   sg_size_t size;
 169   sg_size_t* psize = nullptr;
 170   // if file does not exist create an empty file
 171   if (content_->find(path) != content_->end())
 172     size = *(content_->at(path));
 173   else {
 174     psize  = new sg_size_t;
 175     size   = 0;
 176     *psize = size;
 177     content_->insert({path, psize});
 178     XBT_DEBUG("File '%s' was not found, file created.",path);
 179   }
 180   surf_file_t file = xbt_new0(s_surf_file_t,1);
 181   file->name = xbt_strdup(path);
 182   file->size = size;
 183   file->mount = xbt_strdup(mount);
 184   file->current_position = 0;
 185
 186   StorageAction* action = new StorageN11Action(model(), 0, isOff(), this, OPEN);
 187   action->file_         = file;
 188
 189   return action;
 190 }
 191
 192 StorageAction *StorageN11::close(surf_file_t fd)
 193 {
 194   XBT_DEBUG("\tClose file '%s' size '%llu'", fd->name, fd->size);
 195   // unref write actions from storage
 196   for (std::vector<StorageAction*>::iterator it = writeActions_.begin(); it != writeActions_.end();) {
 197     StorageAction *write_action = *it;
 198     if ((write_action->file_) == fd) {
 199       write_action->unref();
 200       it = writeActions_.erase(it);
 201     } else {
 202       ++it;
 203     }
 204   }
 205   free(fd->name);
 206   free(fd->mount);
 207   xbt_free(fd);
 208   StorageAction* action = new StorageN11Action(model(), 0, isOff(), this, CLOSE);
 209   return action;
 210 }
 211
 212 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
 213 {
 214   if(fd->current_position + size > fd->size){
 215     if (fd->current_position > fd->size){
 216       size = 0;
 217     } else {
 218       size = fd->size - fd->current_position;
 219     }
 220     fd->current_position = fd->size;
 221   }
 222   else
 223     fd->current_position += size;
 224
 225   StorageAction* action = new StorageN11Action(model(), size, isOff(), this, READ);
 226   return action;
 227 }
 228
 229 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
 230 {
 231   char *filename = fd->name;
 232   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
 233
 234   StorageAction* action = new StorageN11Action(model(), size, isOff(), this, WRITE);
 235   action->file_         = fd;
 236   /* Substract the part of the file that might disappear from the used sized on the storage element */
 237   usedSize_ -= (fd->size - fd->current_position);
 238   // If the storage is full before even starting to write
 239   if(usedSize_==size_) {
 240     action->setState(Action::State::failed);
 241   }
 242   return action;
 243 }
 244
 245 /**********
 246  * Action *
 247  **********/
 248
 249 StorageN11Action::StorageN11Action(Model* model, double cost, bool failed, StorageImpl* storage,
 250                                    e_surf_action_storage_type_t type)
 251     : StorageAction(model, cost, failed, lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0, 3), storage, type)
 252 {
 253   XBT_IN("(%s,%g", storage->cname(), cost);
 254
 255   // Must be less than the max bandwidth for all actions
 256   lmm_expand(model->getMaxminSystem(), storage->constraint(), getVariable(), 1.0);
 257   switch(type) {
 258   case OPEN:
 259   case CLOSE:
 260   case STAT:
 261     break;
 262   case READ:
 263     lmm_expand(model->getMaxminSystem(), storage->constraintRead_, getVariable(), 1.0);
 264     break;
 265   case WRITE:
 266     lmm_expand(model->getMaxminSystem(), storage->constraintWrite_, getVariable(), 1.0);
 267
 268     //TODO there is something annoying with what's below. Have to sort it out...
 269     //    Action *action = this;
 270     //    storage->p_writeActions->push_back(action);
 271     //    ref();
 272     break;
 273   default:
 274     THROW_UNIMPLEMENTED;
 275   }
 276   XBT_OUT();
 277 }
 278
 279 int StorageN11Action::unref()
 280 {
 281   refcount_--;
 282   if (not refcount_) {
 283     if (action_hook.is_linked())
 284       stateSet_->erase(stateSet_->iterator_to(*this));
 285     if (getVariable())
 286       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 287     xbt_free(getCategory());
 288     delete this;
 289     return 1;
 290   }
 291   return 0;
 292 }
 293
 294 void StorageN11Action::cancel()
 295 {
 296   setState(Action::State::failed);
 297 }
 298
 299 void StorageN11Action::suspend()
 300 {
 301   XBT_IN("(%p)", this);
 302   if (suspended_ != 2) {
 303     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 304     suspended_ = 1;
 305   }
 306   XBT_OUT();
 307 }
 308
 309 void StorageN11Action::resume()
 310 {
 311   THROW_UNIMPLEMENTED;
 312 }
 313
 314 bool StorageN11Action::isSuspended()
 315 {
 316   return suspended_ == 1;
 317 }
 318
 319 void StorageN11Action::setMaxDuration(double /*duration*/)
 320 {
 321   THROW_UNIMPLEMENTED;
 322 }
 323
 324 void StorageN11Action::setPriority(double /*priority*/)
 325 {
 326   THROW_UNIMPLEMENTED;
 327 }
 328
 329 }
 330 }