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