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