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