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