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