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