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