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/NetCard.hpp"
   9 #include "surf_private.h"
  10 #include <math.h> /*ceil*/
  11 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_storage);
  12
  13 /*************
  14  * CallBacks *
  15  *************/
  16
  17 static inline void routing_storage_type_free(void *r)
  18 {
  19   storage_type_t stype = (storage_type_t) r;
  20   free(stype->model);
  21   free(stype->type_id);
  22   free(stype->content);
  23   free(stype->content_type);
  24   xbt_dict_free(&(stype->properties));
  25   xbt_dict_free(&(stype->model_properties));
  26   free(stype);
  27 }
  28
  29 static inline void surf_storage_resource_free(void *r)
  30 {
  31   // specific to storage
  32   simgrid::surf::Storage *storage = static_cast<simgrid::surf::Storage*>(r);
  33   // generic resource
  34   delete storage;
  35 }
  36
  37 static inline void routing_storage_host_free(void *r)
  38 {
  39   xbt_dynar_t dyn = (xbt_dynar_t) r;
  40   xbt_dynar_free(&dyn);
  41 }
  42
  43 static void check_disk_attachment()
  44 {
  45   xbt_lib_cursor_t cursor;
  46   char* key;
  47   void** data;
  48   xbt_lib_foreach(storage_lib, cursor, key, data)
  49   {
  50     if (xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL) != nullptr) {
  51       simgrid::surf::Storage* storage =
  52           static_cast<simgrid::surf::Storage*>(xbt_lib_get_or_null(storage_lib, key, SURF_STORAGE_LEVEL));
  53       simgrid::kernel::routing::NetCard* host_elm = sg_netcard_by_name_or_null(storage->attach_);
  54       if (!host_elm)
  55         surf_parse_error("Unable to attach storage %s: host %s doesn't exist.", storage->getName(), storage->attach_);
  56     }
  57   }
  58 }
  59
  60 void storage_register_callbacks()
  61 {
  62   simgrid::surf::on_postparse.connect(check_disk_attachment);
  63   instr_routing_define_callbacks();
  64
  65   ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, xbt_free_f);
  66   ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib, routing_storage_host_free);
  67   ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib, routing_storage_type_free);
  68   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, surf_storage_resource_free);
  69 }
  70
  71 /*********
  72  * Model *
  73  *********/
  74
  75 void surf_storage_model_init_default()
  76 {
  77   surf_storage_model = new simgrid::surf::StorageN11Model();
  78   all_existing_models->push_back(surf_storage_model);
  79 }
  80
  81 namespace simgrid {
  82 namespace surf {
  83
  84 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
  85 Storage* StorageN11Model::createStorage(const char* id, const char* type_id, const char* content_name,
  86                                         const char* content_type, const char* attach)
  87 {
  88
  89   xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
  90       "Storage '%s' declared several times in the platform file", id);
  91
  92   storage_type_t storage_type = (storage_type_t) xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
  93
  94   double Bread  = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bread"),
  95       "property Bread, storage",type_id);
  96   double Bwrite = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bwrite"),
  97       "property Bwrite, storage",type_id);
  98   double Bconnection   = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bconnection"),
  99       "property Bconnection, storage",type_id);
 100
 101   Storage* storage = new StorageN11(this, id, maxminSystem_, Bread, Bwrite, Bconnection, type_id, (char*)content_name,
 102                                     content_type, storage_type->size, (char*)attach);
 103   storageCreatedCallbacks(storage);
 104   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
 105
 106   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tBread '%f'\n", id, type_id, Bread);
 107
 108   p_storageList.push_back(storage);
 109
 110   return storage;
 111 }
 112
 113 double StorageN11Model::nextOccuringEvent(double now)
 114 {
 115   double min_completion = StorageModel::nextOccuringEventFull(now);
 116
 117   for(auto storage: p_storageList) {
 118     double rate = 0;
 119     // Foreach write action on that disk
 120     for (auto write_action: storage->writeActions_) {
 121       rate += lmm_variable_getvalue(write_action->getVariable());
 122     }
 123     if(rate > 0)
 124       min_completion = MIN(min_completion, (storage->size_-storage->usedSize_)/rate);
 125   }
 126
 127   return min_completion;
 128 }
 129
 130 void StorageN11Model::updateActionsState(double /*now*/, double delta)
 131 {
 132
 133   ActionList *actionSet = getRunningActionSet();
 134   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 135       ; it != itend ; it=itNext) {
 136     ++itNext;
 137
 138     StorageAction *action = static_cast<StorageAction*>(&*it);
 139
 140     if (action->type_ == WRITE) {
 141       // Update the disk usage
 142       // Update the file size
 143       // For each action of type write
 144       double current_progress = delta * lmm_variable_getvalue(action->getVariable());
 145       long int incr = current_progress;
 146
 147       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
 148                 action->file_->name, action->progress_, current_progress, incr,
 149                 lrint(action->progress_ + current_progress), lrint(action->progress_) + incr);
 150
 151       /* take care of rounding error accumulation */
 152       if (lrint(action->progress_ + current_progress) > lrint(action->progress_) + incr)
 153         incr++;
 154
 155       action->progress_ += current_progress;
 156
 157       action->storage_->usedSize_ += incr;     // disk usage
 158       action->file_->current_position += incr; // current_position
 159       //  which becomes the new file size
 160       action->file_->size = action->file_->current_position;
 161
 162       sg_size_t *psize = xbt_new(sg_size_t,1);
 163       *psize                  = action->file_->size;
 164       xbt_dict_t content_dict = action->storage_->content_;
 165       xbt_dict_set(content_dict, action->file_->name, psize, nullptr);
 166     }
 167
 168     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 169
 170     if (action->getMaxDuration() > NO_MAX_DURATION)
 171       action->updateMaxDuration(delta);
 172
 173     if (action->getRemainsNoUpdate() > 0 && lmm_get_variable_weight(action->getVariable()) > 0 &&
 174         action->storage_->usedSize_ == action->storage_->size_) {
 175       action->finish();
 176       action->setState(Action::State::failed);
 177     } else if (((action->getRemainsNoUpdate() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
 178                ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
 179       action->finish();
 180       action->setState(Action::State::done);
 181     }
 182   }
 183 }
 184
 185 /************
 186  * Resource *
 187  ************/
 188
 189 StorageN11::StorageN11(StorageModel* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite,
 190                        double bconnection, const char* type_id, char* content_name, const char* content_type,
 191                        sg_size_t size, char* attach)
 192     : Storage(model, name, maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach)
 193 {
 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->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->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->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 }