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 = NULL;
  14
  15 /*************
  16  * CallBacks *
  17  *************/
  18
  19 static XBT_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 XBT_INLINE void surf_storage_resource_free(void *r)
  32 {
  33   // specific to storage
  34   Storage *storage = static_cast<Storage*>(r);
  35   // generic resource
  36   delete storage;
  37 }
  38
  39 static XBT_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(void)
  58 {
  59   surf_storage_model = new StorageN11Model();
  60   xbt_dynar_push(all_existing_models, &surf_storage_model);
  61 }
  62
  63 StorageN11Model::StorageN11Model() : StorageModel() {
  64   Action *action = NULL;
  65
  66   XBT_DEBUG("surf_storage_model_init_internal");
  67
  68   storage_running_action_set_that_does_not_need_being_checked =
  69       xbt_swag_new(xbt_swag_offset(*action, p_stateHookup));
  70   if (!p_maxminSystem) {
  71     p_maxminSystem = lmm_system_new(storage_selective_update);
  72   }
  73 }
  74
  75 StorageN11Model::~StorageN11Model(){
  76   xbt_swag_free(storage_running_action_set_that_does_not_need_being_checked);
  77   storage_running_action_set_that_does_not_need_being_checked = NULL;
  78 }
  79
  80 Storage *StorageN11Model::createStorage(const char* id, const char* type_id,
  81     const char* content_name, const char* content_type, xbt_dict_t properties,
  82     const char* attach)
  83 {
  84
  85   xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
  86               "Storage '%s' declared several times in the platform file",
  87               id);
  88
  89   storage_type_t storage_type = (storage_type_t) xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
  90
  91   double Bread  = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bread"));
  92   double Bwrite = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bwrite"));
  93   double Bconnection   = surf_parse_get_bandwidth((char*)xbt_dict_get(storage_type->model_properties, "Bconnection"));
  94
  95   Storage *storage = new StorageN11(this, id, properties, p_maxminSystem,
  96       Bread, Bwrite, Bconnection, type_id, (char *)content_name,
  97       xbt_strdup(content_type), storage_type->size, (char *) attach);
  98   surf_callback_emit(storageCreatedCallbacks, storage);
  99   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
 100
 101   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tproperties '%p'\n\t\tBread '%f'\n",
 102       id,
 103       type_id,
 104       properties,
 105       Bread);
 106
 107   if(!p_storageList)
 108     p_storageList = xbt_dynar_new(sizeof(char *),NULL);
 109   xbt_dynar_push(p_storageList, &storage);
 110
 111   return storage;
 112 }
 113
 114 double StorageN11Model::shareResources(double now)
 115 {
 116   XBT_DEBUG("storage_share_resources %f", now);
 117   unsigned int i, j;
 118   Storage *storage;
 119   void *_write_action;
 120   StorageAction *write_action;
 121
 122   double min_completion = shareResourcesMaxMin(getRunningActionSet(),
 123       p_maxminSystem, lmm_solve);
 124
 125   double rate;
 126   // Foreach disk
 127   xbt_dynar_foreach(p_storageList,i,storage)
 128   {
 129     rate = 0;
 130     // Foreach write action on disk
 131     xbt_dynar_foreach(storage->p_writeActions, j, _write_action)
 132     {
 133       write_action = static_cast<StorageAction*>(_write_action);
 134       rate += lmm_variable_getvalue(write_action->getVariable());
 135     }
 136     if(rate > 0)
 137       min_completion = MIN(min_completion, (storage->m_size-storage->m_usedSize)/rate);
 138   }
 139
 140   return min_completion;
 141 }
 142
 143 void StorageN11Model::updateActionsState(double /*now*/, double delta)
 144 {
 145   StorageAction *action = NULL;
 146
 147   ActionList *actionSet = getRunningActionSet();
 148   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
 149      ; it != itend ; it=itNext) {
 150     ++itNext;
 151     action = static_cast<StorageAction*>(&*it);
 152
 153     if(action->m_type == WRITE)
 154     {
 155       // Update the disk usage
 156       // Update the file size
 157       // For each action of type write
 158       volatile double current_progress =
 159           delta * lmm_variable_getvalue(action->getVariable());
 160       long int incr = current_progress;
 161
 162       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, "
 163                 "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) >
 171           lrint(action->progress)+ incr)
 172         incr++;
 173
 174       action->progress +=current_progress;
 175
 176       action->p_storage->m_usedSize += incr; // disk usage
 177       action->p_file->current_position+= incr; // current_position
 178       //  which becomes the new file size
 179       action->p_file->size = action->p_file->current_position ;
 180
 181       sg_size_t *psize = xbt_new(sg_size_t,1);
 182       *psize = action->p_file->size;
 183       xbt_dict_t content_dict = action->p_storage->p_content;
 184       xbt_dict_set(content_dict, action->p_file->name, psize, NULL);
 185     }
 186
 187     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 188
 189     if (action->getMaxDuration() != NO_MAX_DURATION)
 190       action->updateMaxDuration(delta);
 191
 192     if(action->getRemainsNoUpdate() > 0 &&
 193         lmm_get_variable_weight(action->getVariable()) > 0 &&
 194         action->p_storage->m_usedSize == action->p_storage->m_size)
 195     {
 196       action->finish();
 197       action->setState(SURF_ACTION_FAILED);
 198     } else if ((action->getRemainsNoUpdate() <= 0) &&
 199         (lmm_get_variable_weight(action->getVariable()) > 0))
 200     {
 201       action->finish();
 202       action->setState(SURF_ACTION_DONE);
 203     } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
 204                (action->getMaxDuration() <= 0))
 205     {
 206       action->finish();
 207       action->setState(SURF_ACTION_DONE);
 208     }
 209   }
 210   return;
 211 }
 212
 213 /************
 214  * Resource *
 215  ************/
 216
 217 StorageN11::StorageN11(StorageModel *model, const char* name,
 218     xbt_dict_t properties, lmm_system_t maxminSystem, double bread,
 219     double bwrite, double bconnection, const char* type_id, char *content_name,
 220     char *content_type, sg_size_t size, char *attach)
 221  : Storage(model, name, properties,
 222            maxminSystem, bread, bwrite, bconnection, type_id, content_name, content_type, size, attach) {
 223   XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%llu'", bconnection, bread, bwrite, size);
 224 }
 225
 226 StorageAction *StorageN11::open(const char* mount, const char* path)
 227 {
 228   XBT_DEBUG("\tOpen file '%s'",path);
 229
 230   sg_size_t size, *psize;
 231   psize = (sg_size_t*) xbt_dict_get_or_null(p_content, path);
 232   // if file does not exist create an empty file
 233   if(psize)
 234     size = *psize;
 235   else {
 236     psize = xbt_new(sg_size_t,1);
 237     size = 0;
 238     *psize = size;
 239     xbt_dict_set(p_content, path, psize, NULL);
 240     XBT_DEBUG("File '%s' was not found, file created.",path);
 241   }
 242   surf_file_t file = xbt_new0(s_surf_file_t,1);
 243   file->name = xbt_strdup(path);
 244   file->size = size;
 245   file->mount = xbt_strdup(mount);
 246   file->current_position = 0;
 247
 248   StorageAction *action = new StorageN11Action(getModel(), 0, getState() != SURF_RESOURCE_ON, this, OPEN);
 249   action->p_file = file;
 250
 251   return action;
 252 }
 253
 254 StorageAction *StorageN11::close(surf_file_t fd)
 255 {
 256   char *filename = fd->name;
 257   XBT_DEBUG("\tClose file '%s' size '%llu'", filename, fd->size);
 258   // unref write actions from storage
 259   void *_write_action;
 260   StorageAction *write_action;
 261   unsigned int i;
 262   xbt_dynar_foreach(p_writeActions, i, _write_action) {
 263         write_action = static_cast<StorageAction*>(_write_action);
 264     if ((write_action->p_file) == fd) {
 265       xbt_dynar_cursor_rm(p_writeActions, &i);
 266       write_action->unref();
 267     }
 268   }
 269   free(fd->name);
 270   free(fd->mount);
 271   xbt_free(fd);
 272   StorageAction *action = new StorageN11Action(getModel(), 0, getState() != SURF_RESOURCE_ON, this, CLOSE);
 273   return action;
 274 }
 275
 276 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
 277 {
 278   if(fd->current_position + size > fd->size){
 279     if (fd->current_position > fd->size){
 280       size = 0;
 281     } else {
 282       size = fd->size - fd->current_position;
 283     }
 284     fd->current_position = fd->size;
 285   }
 286   else
 287     fd->current_position += size;
 288
 289   StorageAction *action = new StorageN11Action(getModel(), size, getState() != SURF_RESOURCE_ON, this, READ);
 290   return action;
 291 }
 292
 293 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
 294 {
 295   char *filename = fd->name;
 296   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
 297
 298   StorageAction *action = new StorageN11Action(getModel(), size, getState() != SURF_RESOURCE_ON, this, WRITE);
 299   action->p_file = fd;
 300   /* Substract the part of the file that might disappear from the used sized on
 301    * the storage element */
 302   m_usedSize -= (fd->size - fd->current_position);
 303   // If the storage is full before even starting to write
 304   if(m_usedSize==m_size) {
 305     action->setState(SURF_ACTION_FAILED);
 306   }
 307   return action;
 308 }
 309
 310 /**********
 311  * Action *
 312  **********/
 313
 314 StorageN11Action::StorageN11Action(Model *model, double cost, bool failed, Storage *storage, e_surf_action_storage_type_t type)
 315   : StorageAction(model, cost, failed,
 316                       lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0 , 3),
 317                       storage, type) {
 318   XBT_IN("(%s,%g", storage->getName(), cost);
 319
 320   // Must be less than the max bandwidth for all actions
 321   lmm_expand(model->getMaxminSystem(), storage->getConstraint(), getVariable(), 1.0);
 322   switch(type) {
 323   case OPEN:
 324   case CLOSE:
 325   case STAT:
 326     break;
 327   case READ:
 328     lmm_expand(model->getMaxminSystem(), storage->p_constraintRead,
 329                getVariable(), 1.0);
 330     break;
 331   case WRITE:
 332     lmm_expand(model->getMaxminSystem(), storage->p_constraintWrite,
 333                getVariable(), 1.0);
 334
 335 //TODO there is something annoying with what's below. Have to sort it out...
 336 //    Action *action = this;
 337 //    xbt_dynar_push(storage->p_writeActions, &action);
 338 //    ref();
 339     break;
 340   }
 341   XBT_OUT();
 342 }
 343
 344 int StorageN11Action::unref()
 345 {
 346   m_refcount--;
 347   if (!m_refcount) {
 348         if (action_hook.is_linked())
 349           p_stateSet->erase(p_stateSet->iterator_to(*this));
 350     if (getVariable())
 351       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 352     xbt_free(getCategory());
 353     delete this;
 354     return 1;
 355   }
 356   return 0;
 357 }
 358
 359 void StorageN11Action::cancel()
 360 {
 361   setState(SURF_ACTION_FAILED);
 362   return;
 363 }
 364
 365 void StorageN11Action::suspend()
 366 {
 367   XBT_IN("(%p)", this);
 368   if (m_suspended != 2) {
 369     lmm_update_variable_weight(getModel()->getMaxminSystem(),
 370                                getVariable(),
 371                                0.0);
 372     m_suspended = 1;
 373   }
 374   XBT_OUT();
 375 }
 376
 377 void StorageN11Action::resume()
 378 {
 379   THROW_UNIMPLEMENTED;
 380 }
 381
 382 bool StorageN11Action::isSuspended()
 383 {
 384   return m_suspended == 1;
 385 }
 386
 387 void StorageN11Action::setMaxDuration(double /*duration*/)
 388 {
 389   THROW_UNIMPLEMENTED;
 390 }
 391
 392 void StorageN11Action::setPriority(double /*priority*/)
 393 {
 394   THROW_UNIMPLEMENTED;
 395 }
 396