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_, lmm_solve);
 118
 119   double rate;
 120   // Foreach disk
 121   for(auto storage: p_storageList) {
 122     rate = 0;
 123     // Foreach write action on disk
 124     for (auto write_action: storage->writeActions_) {
 125       rate += lmm_variable_getvalue(write_action->getVariable());
 126     }
 127     if(rate > 0)
 128       min_completion = MIN(min_completion, (storage->size_-storage->usedSize_)/rate);
 129   }
 130
 131   return min_completion;
 132 }
 133
 134 void StorageN11Model::updateActionsState(double /*now*/, double delta)
 135 {
 136   StorageAction *action = nullptr;
 137
 138   ActionList *actionSet = getRunningActionSet();
 139   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 140       ; it != itend ; it=itNext) {
 141     ++itNext;
 142     action = static_cast<StorageAction*>(&*it);
 143
 144     if(action->m_type == WRITE){
 145       // Update the disk usage
 146       // Update the file size
 147       // For each action of type write
 148       double current_progress =
 149           delta * lmm_variable_getvalue(action->getVariable());
 150       long int incr = current_progress;
 151
 152       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
 153           action->p_file->name,
 154           action->progress,  current_progress, incr,
 155           lrint(action->progress + current_progress),
 156           lrint(action->progress)+ incr);
 157
 158       /* take care of rounding error accumulation */
 159       if (lrint(action->progress + current_progress) > lrint(action->progress)+ incr)
 160         incr++;
 161
 162       action->progress +=current_progress;
 163
 164       action->p_storage->usedSize_ += incr; // disk usage
 165       action->p_file->current_position+= incr; // current_position
 166       //  which becomes the new file size
 167       action->p_file->size = action->p_file->current_position ;
 168
 169       sg_size_t *psize = xbt_new(sg_size_t,1);
 170       *psize = action->p_file->size;
 171       xbt_dict_t content_dict = action->p_storage->content_;
 172       xbt_dict_set(content_dict, action->p_file->name, psize, nullptr);
 173     }
 174
 175     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 176
 177     if (action->getMaxDuration() > NO_MAX_DURATION)
 178       action->updateMaxDuration(delta);
 179
 180     if(action->getRemainsNoUpdate() > 0 && lmm_get_variable_weight(action->getVariable()) > 0 &&
 181         action->p_storage->usedSize_ == action->p_storage->size_) {
 182       action->finish();
 183       action->setState(Action::State::failed);
 184     } else if (((action->getRemainsNoUpdate() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
 185                ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
 186       action->finish();
 187       action->setState(Action::State::done);
 188     }
 189   }
 190   return;
 191 }
 192
 193 /************
 194  * Resource *
 195  ************/
 196
 197 StorageN11::StorageN11(StorageModel *model, const char* name,
 198     xbt_dict_t properties, lmm_system_t maxminSystem, double bread,
 199     double bwrite, double bconnection, const char* type_id, char *content_name,
 200     const char *content_type, sg_size_t size, char *attach)
 201 : Storage(model, name, properties,
 202     maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach) {
 203   XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%llu'", bconnection, bread, bwrite, size);
 204 }
 205
 206 StorageAction *StorageN11::open(const char* mount, const char* path)
 207 {
 208   XBT_DEBUG("\tOpen file '%s'",path);
 209
 210   sg_size_t size, *psize;
 211   psize = (sg_size_t*) xbt_dict_get_or_null(content_, path);
 212   // if file does not exist create an empty file
 213   if(psize)
 214     size = *psize;
 215   else {
 216     psize = xbt_new(sg_size_t,1);
 217     size = 0;
 218     *psize = size;
 219     xbt_dict_set(content_, path, psize, nullptr);
 220     XBT_DEBUG("File '%s' was not found, file created.",path);
 221   }
 222   surf_file_t file = xbt_new0(s_surf_file_t,1);
 223   file->name = xbt_strdup(path);
 224   file->size = size;
 225   file->mount = xbt_strdup(mount);
 226   file->current_position = 0;
 227
 228   StorageAction *action = new StorageN11Action(getModel(), 0, isOff(), this, OPEN);
 229   action->p_file = file;
 230
 231   return action;
 232 }
 233
 234 StorageAction *StorageN11::close(surf_file_t fd)
 235 {
 236   XBT_DEBUG("\tClose file '%s' size '%llu'", fd->name, fd->size);
 237   // unref write actions from storage
 238   for (std::vector<StorageAction*>::iterator it = writeActions_.begin(); it != writeActions_.end();) {
 239     StorageAction *write_action = *it;
 240     if ((write_action->p_file) == fd) {
 241       write_action->unref();
 242       it = writeActions_.erase(it);
 243     } else {
 244       ++it;
 245     }
 246   }
 247   free(fd->name);
 248   free(fd->mount);
 249   xbt_free(fd);
 250   StorageAction *action = new StorageN11Action(getModel(), 0, isOff(), this, CLOSE);
 251   return action;
 252 }
 253
 254 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
 255 {
 256   if(fd->current_position + size > fd->size){
 257     if (fd->current_position > fd->size){
 258       size = 0;
 259     } else {
 260       size = fd->size - fd->current_position;
 261     }
 262     fd->current_position = fd->size;
 263   }
 264   else
 265     fd->current_position += size;
 266
 267   StorageAction *action = new StorageN11Action(getModel(), size, isOff(), this, READ);
 268   return action;
 269 }
 270
 271 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
 272 {
 273   char *filename = fd->name;
 274   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
 275
 276   StorageAction *action = new StorageN11Action(getModel(), size, isOff(), this, WRITE);
 277   action->p_file = fd;
 278   /* Substract the part of the file that might disappear from the used sized on the storage element */
 279   usedSize_ -= (fd->size - fd->current_position);
 280   // If the storage is full before even starting to write
 281   if(usedSize_==size_) {
 282     action->setState(Action::State::failed);
 283   }
 284   return action;
 285 }
 286
 287 /**********
 288  * Action *
 289  **********/
 290
 291 StorageN11Action::StorageN11Action(Model *model, double cost, bool failed, Storage *storage, e_surf_action_storage_type_t type)
 292 : StorageAction(model, cost, failed,
 293     lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0 , 3),
 294     storage, type) {
 295   XBT_IN("(%s,%g", storage->getName(), cost);
 296
 297   // Must be less than the max bandwidth for all actions
 298   lmm_expand(model->getMaxminSystem(), storage->getConstraint(), getVariable(), 1.0);
 299   switch(type) {
 300   case OPEN:
 301   case CLOSE:
 302   case STAT:
 303     break;
 304   case READ:
 305     lmm_expand(model->getMaxminSystem(), storage->constraintRead_, getVariable(), 1.0);
 306     break;
 307   case WRITE:
 308     lmm_expand(model->getMaxminSystem(), storage->constraintWrite_, getVariable(), 1.0);
 309
 310     //TODO there is something annoying with what's below. Have to sort it out...
 311     //    Action *action = this;
 312     //    storage->p_writeActions->push_back(action);
 313     //    ref();
 314     break;
 315   }
 316   XBT_OUT();
 317 }
 318
 319 int StorageN11Action::unref()
 320 {
 321   refcount_--;
 322   if (!refcount_) {
 323     if (action_hook.is_linked())
 324       stateSet_->erase(stateSet_->iterator_to(*this));
 325     if (getVariable())
 326       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 327     xbt_free(getCategory());
 328     delete this;
 329     return 1;
 330   }
 331   return 0;
 332 }
 333
 334 void StorageN11Action::cancel()
 335 {
 336   setState(Action::State::failed);
 337   return;
 338 }
 339
 340 void StorageN11Action::suspend()
 341 {
 342   XBT_IN("(%p)", this);
 343   if (suspended_ != 2) {
 344     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 345     suspended_ = 1;
 346   }
 347   XBT_OUT();
 348 }
 349
 350 void StorageN11Action::resume()
 351 {
 352   THROW_UNIMPLEMENTED;
 353 }
 354
 355 bool StorageN11Action::isSuspended()
 356 {
 357   return suspended_ == 1;
 358 }
 359
 360 void StorageN11Action::setMaxDuration(double /*duration*/)
 361 {
 362   THROW_UNIMPLEMENTED;
 363 }
 364
 365 void StorageN11Action::setPriority(double /*priority*/)
 366 {
 367   THROW_UNIMPLEMENTED;
 368 }
 369
 370 }
 371 }