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