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