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