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