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