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