src/surf/storage.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012. 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 "xbt/ex.h"
   8 #include "xbt/dict.h"
   9 #include "xbt/file_stat.h"
  10 #include "portable.h"
  11 #include "surf_private.h"
  12 #include "storage_private.h"
  13 #include "surf/surf_resource.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_storage, surf,
  16                                 "Logging specific to the SURF storage module");
  17
  18 xbt_lib_t storage_lib;
  19 int ROUTING_STORAGE_LEVEL;      //Routing for storagelevel
  20 int ROUTING_STORAGE_HOST_LEVEL;
  21 int SURF_STORAGE_LEVEL;
  22 xbt_lib_t storage_type_lib;
  23 int ROUTING_STORAGE_TYPE_LEVEL; //Routing for storage_type level
  24
  25 xbt_dynar_t mount_list = NULL;  /* temporary store of current mount storage */
  26
  27 surf_model_t surf_storage_model = NULL;
  28 lmm_system_t storage_maxmin_system = NULL;
  29 static int storage_selective_update = 0;
  30 static xbt_swag_t
  31     storage_running_action_set_that_does_not_need_being_checked = NULL;
  32
  33 #define GENERIC_LMM_ACTION(action) action->generic_lmm_action
  34 #define GENERIC_ACTION(action) GENERIC_LMM_ACTION(action).generic_action
  35
  36 typedef struct surf_storage {
  37   s_surf_resource_t generic_resource;
  38   const char* type;
  39   const char* content; /*should be a dict */
  40 } s_surf_storage_t, *surf_storage_t;
  41
  42 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state);
  43 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type);
  44
  45 static surf_action_t storage_action_stat(void *storage, surf_file_t stream)
  46 {
  47   surf_action_t action = storage_action_execute(storage,0, STAT);
  48   action->file = stream;
  49   action->stat = stream->content->stat;
  50   return action;
  51 }
  52
  53 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
  54 {
  55   XBT_DEBUG("\tOpen file '%s'",path);
  56   char *storage_type_id = xbt_lib_get_or_null(
  57       storage_lib,
  58       ((storage_t)storage)->generic_resource.name,
  59       ROUTING_STORAGE_LEVEL);
  60   storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, storage_type_id,ROUTING_STORAGE_TYPE_LEVEL);
  61   xbt_dict_t content_dict = storage_type->content;
  62   surf_stat_t content = xbt_dict_get(content_dict,path);
  63
  64   surf_file_t file = xbt_new0(s_surf_file_t,1);
  65   file->name = xbt_strdup(path);
  66   file->content = content;
  67   file->storage = mount;
  68
  69   surf_action_t action = storage_action_execute(storage,0, OPEN);
  70   action->file = (void *)file;
  71   return action;
  72 }
  73
  74 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
  75 {
  76   char *filename = fp->name;
  77   free(fp->name);
  78   fp->content = NULL;
  79   xbt_free(fp);
  80   surf_action_t action = storage_action_execute(storage,0, CLOSE);
  81   XBT_DEBUG("\tClose file '%s'",filename);
  82   return action;
  83 }
  84
  85 static surf_action_t storage_action_read(void *storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream)
  86 {
  87   char *filename = stream->name;
  88   surf_stat_t content = stream->content;
  89   XBT_DEBUG("\tRead file '%s' size '%zu/%zu'",filename,size,content->stat.size);
  90   if(size > content->stat.size)
  91     size = content->stat.size;
  92   surf_action_t action = storage_action_execute(storage,size,READ);
  93   return action;
  94 }
  95
  96 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
  97 {
  98   char *filename = stream->name;
  99   surf_stat_t content = stream->content;
 100   XBT_DEBUG("\tWrite file '%s' size '%zu/%zu'",filename,size,content->stat.size);
 101
 102   surf_action_t action = storage_action_execute(storage,size,WRITE);
 103   content->stat.size += size;
 104   return action;
 105 }
 106
 107 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type)
 108 {
 109   surf_action_storage_t action = NULL;
 110   storage_t STORAGE = storage;
 111
 112   XBT_IN("(%s,%zu)", surf_resource_name(STORAGE), size);
 113   action =
 114       surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
 115           STORAGE->state_current != SURF_RESOURCE_ON);
 116
 117   GENERIC_LMM_ACTION(action).suspended = 0;     /* Should be useless because of the
 118                                                    calloc but it seems to help valgrind... */
 119
 120   GENERIC_LMM_ACTION(action).variable =
 121       lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
 122
 123   // Must be less than the max bandwidth for all actions
 124   lmm_expand(storage_maxmin_system, STORAGE->constraint,
 125              GENERIC_LMM_ACTION(action).variable, 1.0);
 126
 127   switch(type) {
 128   case OPEN:
 129   case CLOSE:
 130   case STAT:
 131     break;
 132   case READ:
 133     lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
 134                GENERIC_LMM_ACTION(action).variable, 1.0);
 135     break;
 136   case WRITE:
 137     lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
 138                GENERIC_LMM_ACTION(action).variable, 1.0);
 139     break;
 140   }
 141
 142   XBT_OUT();
 143   return (surf_action_t) action;
 144 }
 145
 146 static void* storage_create_resource(const char* id, const char* model,const char* type_id)
 147 {
 148   storage_t storage = NULL;
 149
 150   xbt_assert(!surf_storage_resource_by_name(id),
 151               "Storage '%s' declared several times in the platform file",
 152               id);
 153   storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
 154           surf_storage_model, id,NULL);
 155
 156   storage->state_current = SURF_RESOURCE_ON;
 157
 158   storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
 159   double Bread  = atof(xbt_dict_get(storage_type->properties,"Bread"));
 160   double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
 161   double Bconnection   = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
 162   XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
 163   storage->constraint       = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
 164   storage->constraint_read  = lmm_constraint_new(storage_maxmin_system, storage, Bread);
 165   storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
 166
 167   xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
 168
 169   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' \n\t\tmodel '%s' \n\t\tproperties '%p'\n\t\tBread '%f'\n",
 170       id,
 171       model,
 172       type_id,
 173       storage_type->properties,
 174       Bread);
 175
 176   return storage;
 177 }
 178
 179 static void storage_finalize(void)
 180 {
 181   lmm_system_free(storage_maxmin_system);
 182   storage_maxmin_system = NULL;
 183
 184   surf_model_exit(surf_storage_model);
 185   surf_storage_model = NULL;
 186
 187   xbt_swag_free
 188       (storage_running_action_set_that_does_not_need_being_checked);
 189   storage_running_action_set_that_does_not_need_being_checked = NULL;
 190 }
 191
 192 static void storage_update_actions_state(double now, double delta)
 193 {
 194   surf_action_storage_t action = NULL;
 195   surf_action_storage_t next_action = NULL;
 196   xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
 197
 198   xbt_swag_foreach_safe(action, next_action, running_actions) {
 199     double_update(&(GENERIC_ACTION(action).remains),
 200                   lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
 201     if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
 202       double_update(&(GENERIC_ACTION(action).max_duration), delta);
 203     if ((GENERIC_ACTION(action).remains <= 0) &&
 204         (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0)) {
 205       GENERIC_ACTION(action).finish = surf_get_clock();
 206       storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
 207     } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
 208                (GENERIC_ACTION(action).max_duration <= 0)) {
 209       GENERIC_ACTION(action).finish = surf_get_clock();
 210       storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
 211     }
 212   }
 213
 214   return;
 215 }
 216
 217 static double storage_share_resources(double NOW)
 218 {
 219   XBT_DEBUG("storage_share_resources %f",NOW);
 220   s_surf_action_storage_t action;
 221   return generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
 222       xbt_swag_offset(action, generic_lmm_action.variable),
 223       storage_maxmin_system, lmm_solve);
 224 }
 225
 226 static int storage_resource_used(void *resource_id)
 227 {
 228   THROW_UNIMPLEMENTED;
 229   return 0;
 230 }
 231
 232 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
 233                                  double value, double time)
 234 {
 235   THROW_UNIMPLEMENTED;
 236 }
 237
 238 static int storage_action_unref(surf_action_t action)
 239 {
 240   action->refcount--;
 241   if (!action->refcount) {
 242     xbt_swag_remove(action, action->state_set);
 243     if (((surf_action_lmm_t) action)->variable)
 244       lmm_variable_free(storage_maxmin_system,
 245                         ((surf_action_lmm_t) action)->variable);
 246 #ifdef HAVE_TRACING
 247     xbt_free(action->category);
 248 #endif
 249     surf_action_free(&action);
 250     return 1;
 251   }
 252   return 0;
 253 }
 254
 255 static void storage_action_cancel(surf_action_t action)
 256 {
 257   surf_action_state_set(action, SURF_ACTION_FAILED);
 258   return;
 259 }
 260
 261 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
 262 {
 263   surf_action_state_set(action, state);
 264   return;
 265 }
 266
 267 static void storage_action_suspend(surf_action_t action)
 268 {
 269   XBT_IN("(%p)", action);
 270   if (((surf_action_lmm_t) action)->suspended != 2) {
 271     lmm_update_variable_weight(storage_maxmin_system,
 272                                ((surf_action_lmm_t) action)->variable,
 273                                0.0);
 274     ((surf_action_lmm_t) action)->suspended = 1;
 275   }
 276   XBT_OUT();
 277 }
 278
 279 static void storage_action_resume(surf_action_t action)
 280 {
 281   THROW_UNIMPLEMENTED;
 282 }
 283
 284 static int storage_action_is_suspended(surf_action_t action)
 285 {
 286   return (((surf_action_lmm_t) action)->suspended == 1);
 287 }
 288
 289 static void storage_action_set_max_duration(surf_action_t action, double duration)
 290 {
 291   THROW_UNIMPLEMENTED;
 292 }
 293
 294 static void storage_action_set_priority(surf_action_t action, double priority)
 295 {
 296   THROW_UNIMPLEMENTED;
 297 }
 298
 299 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
 300 {
 301   void* stype = xbt_lib_get_or_null(storage_type_lib,
 302                                     storage->type_id,
 303                                     ROUTING_STORAGE_TYPE_LEVEL);
 304   if(!stype) xbt_die("No storage type '%s'",storage->type_id);
 305 //  XBT_INFO("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' \n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tproperties '%p'\n",
 306 //      storage->id,
 307 //      ((storage_type_t) stype)->model,
 308 //      ((storage_type_t) stype)->type_id,
 309 //      ((storage_type_t) stype)->content,
 310 //      ((storage_type_t) stype)->properties);
 311
 312  storage_create_resource(storage->id,
 313      ((storage_type_t) stype)->model,
 314      ((storage_type_t) stype)->type_id);
 315 }
 316
 317 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
 318 {
 319   XBT_DEBUG("parse_mstorage_init");
 320 }
 321
 322 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
 323 {
 324   XBT_DEBUG("parse_storage_type_init");
 325 }
 326
 327 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
 328 {
 329   XBT_DEBUG("parse_mount_init");
 330 }
 331
 332 static void storage_define_callbacks()
 333 {
 334   sg_platf_storage_add_cb(parse_storage_init);
 335   sg_platf_storage_type_add_cb(parse_storage_type_init);
 336   sg_platf_mstorage_add_cb(parse_mstorage_init);
 337   sg_platf_mount_add_cb(parse_mount_init);
 338 }
 339
 340 static void surf_storage_model_init_internal(void)
 341 {
 342   s_surf_action_t action;
 343
 344   XBT_DEBUG("surf_storage_model_init_internal");
 345   surf_storage_model = surf_model_init();
 346
 347   storage_running_action_set_that_does_not_need_being_checked =
 348       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 349
 350   surf_storage_model->name = "Storage";
 351   surf_storage_model->action_unref = storage_action_unref;
 352   surf_storage_model->action_cancel = storage_action_cancel;
 353   surf_storage_model->action_state_set = storage_action_state_set;
 354
 355   surf_storage_model->model_private->finalize = storage_finalize;
 356   surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
 357   surf_storage_model->model_private->share_resources = storage_share_resources;
 358   surf_storage_model->model_private->resource_used = storage_resource_used;
 359   surf_storage_model->model_private->update_resource_state = storage_resources_state;
 360
 361   surf_storage_model->suspend = storage_action_suspend;
 362   surf_storage_model->resume = storage_action_resume;
 363   surf_storage_model->is_suspended = storage_action_is_suspended;
 364   surf_storage_model->set_max_duration = storage_action_set_max_duration;
 365   surf_storage_model->set_priority = storage_action_set_priority;
 366
 367   surf_storage_model->extension.storage.open = storage_action_open;
 368   surf_storage_model->extension.storage.close = storage_action_close;
 369   surf_storage_model->extension.storage.read = storage_action_read;
 370   surf_storage_model->extension.storage.write = storage_action_write;
 371   surf_storage_model->extension.storage.stat = storage_action_stat;
 372   surf_storage_model->extension.storage.create_resource = storage_create_resource;
 373
 374   if (!storage_maxmin_system) {
 375     storage_maxmin_system = lmm_system_new(storage_selective_update);
 376   }
 377
 378 }
 379
 380 void surf_storage_model_init_default(void)
 381 {
 382   surf_storage_model_init_internal();
 383   storage_define_callbacks();
 384
 385   xbt_dynar_push(model_list, &surf_storage_model);
 386 }
 387
 388 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
 389 {
 390   xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
 391                "Reading a storage, processing unit \"%s\" already exists", storage->id);
 392
 393   // Verification of an existing type_id
 394 #ifndef NDEBUG
 395   void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
 396 #endif
 397   xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
 398
 399   XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s'",
 400       storage->id,
 401       storage->type_id);
 402
 403   xbt_lib_set(storage_lib,
 404       storage->id,
 405       ROUTING_STORAGE_LEVEL,
 406       (void *) xbt_strdup(storage->type_id));
 407 }
 408
 409 static void free_storage_content(void *p)
 410 {
 411   surf_stat_t content = p;
 412   free(content->stat.date);
 413   free(content->stat.group);
 414   free(content->stat.time);
 415   free(content->stat.user);
 416   free(content->stat.user_rights);
 417   free(content);
 418 }
 419
 420 static xbt_dict_t parse_storage_content(const char *filename, unsigned long *used_size)
 421 {
 422   *used_size = 0;
 423   if ((!filename) || (strcmp(filename, "") == 0))
 424     return NULL;
 425
 426   xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
 427   FILE *file = NULL;
 428
 429   file = surf_fopen(filename, "r");
 430   xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
 431               xbt_str_join(surf_path, ":"));
 432
 433   char *line = NULL;
 434   size_t len = 0;
 435   ssize_t read;
 436   char user_rights[12];
 437   char user[100];
 438   char group[100];
 439   char date[12];
 440   char time[12];
 441   char path[1024];
 442   int nb;
 443   long size;
 444
 445   surf_stat_t content;
 446
 447   while ((read = getline(&line, &len, file)) != -1) {
 448     content = xbt_new0(s_surf_stat_t,1);
 449     if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
 450       content->stat.date = xbt_strdup(date);
 451       content->stat.group = xbt_strdup(group);
 452       content->stat.size = size;
 453       content->stat.time = xbt_strdup(time);
 454       content->stat.user = xbt_strdup(user);
 455       content->stat.user_rights = xbt_strdup(user_rights);
 456       *used_size += content->stat.size;
 457       xbt_dict_set(parse_content,path,content,NULL);
 458     } else {
 459       xbt_die("Be sure of passing a good format for content file.\n");
 460       // You can generate this kind of file with command line:
 461       // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
 462     }
 463   }
 464   if (line)
 465       free(line);
 466   fclose(file);
 467   return parse_content;
 468 }
 469
 470 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
 471 {
 472   xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
 473                "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
 474
 475   storage_type_t stype = xbt_new0(s_storage_type_t, 1);
 476   stype->model = xbt_strdup(storage_type->model);
 477   stype->properties = storage_type->properties;
 478   stype->content = parse_storage_content(storage_type->content,&(stype->used_size));
 479   stype->type_id = xbt_strdup(storage_type->id);
 480   stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
 481
 482   XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
 483       stype->type_id,
 484       stype->model,
 485       storage_type->content);
 486
 487   xbt_lib_set(storage_type_lib,
 488       stype->type_id,
 489       ROUTING_STORAGE_TYPE_LEVEL,
 490       (void *) stype);
 491 }
 492 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
 493 {
 494   THROW_UNIMPLEMENTED;
 495 //  mount_t mnt = xbt_new0(s_mount_t, 1);
 496 //  mnt->id = xbt_strdup(mstorage->type_id);
 497 //  mnt->name = xbt_strdup(mstorage->name);
 498 //
 499 //  if(!mount_list){
 500 //    XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
 501 //    mount_list = xbt_dynar_new(sizeof(char *), NULL);
 502 //  }
 503 //  xbt_dynar_push(mount_list,(void *) mnt);
 504 //  free(mnt->id);
 505 //  free(mnt->name);
 506 //  xbt_free(mnt);
 507 //  XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
 508 }
 509
 510 static void mount_free(void *p)
 511 {
 512   mount_t mnt = p;
 513   xbt_free(mnt->name);
 514 }
 515
 516 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
 517 {
 518   // Verification of an existing storage
 519 #ifndef NDEBUG
 520   void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
 521 #endif
 522   xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
 523
 524   XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
 525
 526   s_mount_t mnt;
 527   mnt.id = surf_storage_resource_by_name(mount->id);
 528   mnt.name = xbt_strdup(mount->name);
 529
 530   if(!mount_list){
 531     XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
 532     mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
 533   }
 534   xbt_dynar_push(mount_list,&mnt);
 535 }
 536
 537 static XBT_INLINE void routing_storage_type_free(void *r)
 538 {
 539   storage_type_t stype = r;
 540   free(stype->model);
 541   free(stype->type_id);
 542   xbt_dict_free(&(stype->properties));
 543   xbt_dict_free(&(stype->content));
 544   free(stype);
 545 }
 546
 547 static XBT_INLINE void routing_storage_host_free(void *r)
 548 {
 549   xbt_dynar_t dyn = r;
 550   xbt_dynar_free(&dyn);
 551 }
 552
 553 void storage_register_callbacks() {
 554
 555   ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
 556   ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
 557   ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
 558   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_resource_free);
 559
 560   sg_platf_storage_add_cb(storage_parse_storage);
 561   sg_platf_mstorage_add_cb(storage_parse_mstorage);
 562   sg_platf_storage_type_add_cb(storage_parse_storage_type);
 563   sg_platf_mount_add_cb(storage_parse_mount);
 564 }