1 /* Copyright (c) 2004-2013. The SimGrid Team.
2 * All rights reserved. */
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. */
10 #include "surf_private.h"
11 #include "storage_private.h"
12 #include "surf/surf_resource.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_storage, surf,
15 "Logging specific to the SURF storage module");
17 xbt_lib_t storage_lib;
18 int ROUTING_STORAGE_LEVEL; //Routing for storagelevel
19 int ROUTING_STORAGE_HOST_LEVEL;
20 int SURF_STORAGE_LEVEL;
21 xbt_lib_t storage_type_lib;
22 int ROUTING_STORAGE_TYPE_LEVEL; //Routing for storage_type level
24 xbt_dynar_t mount_list = NULL; /* temporary store of current mount storage */
26 surf_model_t surf_storage_model = NULL;
27 lmm_system_t storage_maxmin_system = NULL;
28 static int storage_selective_update = 0;
30 storage_running_action_set_that_does_not_need_being_checked = NULL;
32 static xbt_dynar_t storage_list;
34 #define GENERIC_LMM_ACTION(action) action->generic_lmm_action
35 #define GENERIC_ACTION(action) GENERIC_LMM_ACTION(action).generic_action
37 static xbt_dict_t parse_storage_content(char *filename, size_t *used_size);
38 static int storage_action_unref(surf_action_t action);
39 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state);
40 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type);
42 static surf_action_t storage_action_ls(void *storage, const char* path)
44 surf_action_t action = storage_action_execute(storage,0, LS);
45 action->ls_dict = NULL;
46 xbt_dict_t ls_dict = xbt_dict_new();
50 xbt_dict_cursor_t cursor = NULL;
52 xbt_dynar_t dyn = NULL;
55 // for each file in the storage content
56 xbt_dict_foreach(((storage_t)storage)->content,cursor,key,size){
57 // Search if file start with the prefix 'path'
58 if(xbt_str_start_with(key,path)){
59 file = &key[strlen(path)];
61 // Split file with '/'
62 dyn = xbt_str_split(file,"/");
63 file = xbt_dynar_get_as(dyn,0,char*);
66 if(xbt_dynar_length(dyn) == 1){
67 xbt_dict_set(ls_dict,file,&size,NULL);
72 // if directory does not exist yet in the dictionary
73 if(!xbt_dict_get_or_null(ls_dict,file))
74 xbt_dict_set(ls_dict,file,NULL,NULL);
80 action->ls_dict = ls_dict;
84 static surf_action_t storage_action_open(void *storage, const char* mount,
87 XBT_DEBUG("\tOpen file '%s'",path);
88 xbt_dict_t content_dict = ((storage_t)storage)->content;
89 size_t size = (size_t) xbt_dict_get_or_null(content_dict,path);
90 // if file does not exist create an empty file
92 xbt_dict_set(content_dict,path,&size,NULL);
93 XBT_DEBUG("File '%s' was not found, file created.",path);
95 surf_file_t file = xbt_new0(s_surf_file_t,1);
96 file->name = xbt_strdup(path);
98 file->mount = xbt_strdup(mount);
100 surf_action_t action = storage_action_execute(storage,0, OPEN);
101 action->file = (void *)file;
105 static surf_action_t storage_action_close(void *storage, surf_file_t fd)
107 char *filename = fd->name;
108 XBT_DEBUG("\tClose file '%s' size '%zu'",filename,fd->size);
109 // unref write actions from storage
110 surf_action_storage_t write_action;
112 xbt_dynar_foreach(((storage_t)storage)->write_actions,i,write_action) {
113 if ((write_action->generic_lmm_action.generic_action.file) == fd) {
114 xbt_dynar_cursor_rm(((storage_t)storage)->write_actions, &i);
115 storage_action_unref((surf_action_t) write_action);
122 surf_action_t action = storage_action_execute(storage,0, CLOSE);
126 static surf_action_t storage_action_read(void *storage, size_t size,
131 surf_action_t action = storage_action_execute(storage,size,READ);
135 static surf_action_t storage_action_write(void *storage, size_t size,
138 char *filename = fd->name;
139 XBT_DEBUG("\tWrite file '%s' size '%zu/%zu'",filename,size,fd->size);
141 surf_action_t action = storage_action_execute(storage,size,WRITE);
144 // If the storage is full
145 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
146 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
151 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type)
153 surf_action_storage_t action = NULL;
154 storage_t STORAGE = storage;
156 XBT_IN("(%s,%zu", surf_resource_name(STORAGE), size);
158 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
159 STORAGE->state_current != SURF_RESOURCE_ON);
161 // Save the storage on action
162 action->storage = storage;
163 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
164 calloc but it seems to help valgrind... */
166 GENERIC_LMM_ACTION(action).variable =
167 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
169 // Must be less than the max bandwidth for all actions
170 lmm_expand(storage_maxmin_system, STORAGE->constraint,
171 GENERIC_LMM_ACTION(action).variable, 1.0);
180 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
181 GENERIC_LMM_ACTION(action).variable, 1.0);
184 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
185 GENERIC_LMM_ACTION(action).variable, 1.0);
186 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
187 surf_action_ref((surf_action_t) action);
192 return (surf_action_t) action;
195 static xbt_dict_t storage_get_properties(const void *storage)
197 return surf_resource_properties(surf_storage_resource_priv(storage));
200 static xbt_dict_t storage_get_content(void *storage)
202 /* For the moment this action has no cost, but in the future we could take in account access latency of the disk */
203 /*surf_action_t action = storage_action_execute(storage,0, LS);*/
205 void *st = surf_storage_resource_priv(storage);
206 xbt_dict_t content_dict = xbt_dict_new();
207 xbt_dict_cursor_t cursor = NULL;
210 xbt_dict_foreach(((storage_t)st)->content, cursor, file, size){
211 xbt_dict_set(content_dict,file,(void*)size,NULL);
216 static void* storage_create_resource(const char* id, const char* model,
217 const char* type_id, const char* content_name, const char* content_type, xbt_dict_t properties){
218 storage_t storage = NULL;
220 xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
221 "Storage '%s' declared several times in the platform file",
223 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
224 surf_storage_model, id, properties, NULL);
226 storage->state_current = SURF_RESOURCE_ON;
227 storage->used_size = 0;
229 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
231 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
233 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,"Bread"));
235 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,"Bwrite"));
237 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,
239 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%lu'",Bconnection,Bread,Bwrite,(unsigned long)storage_type->size);
240 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
241 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
242 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
243 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
244 storage->content_type = xbt_strdup(content_type);
245 storage->size = storage_type->size;
246 storage->type_id = xbt_strdup(type_id);
248 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
250 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",
254 storage_type->properties,
258 storage_list = xbt_dynar_new(sizeof(char *),NULL);
259 xbt_dynar_push(storage_list,&storage);
264 static void storage_finalize(void)
266 lmm_system_free(storage_maxmin_system);
267 storage_maxmin_system = NULL;
269 surf_model_exit(surf_storage_model);
270 surf_storage_model = NULL;
272 xbt_dynar_free(&storage_list);
275 (storage_running_action_set_that_does_not_need_being_checked);
276 storage_running_action_set_that_does_not_need_being_checked = NULL;
279 static void storage_update_actions_state(double now, double delta)
281 surf_action_storage_t action = NULL;
282 surf_action_storage_t next_action = NULL;
283 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
285 // Update the disk usage
286 // Update the file size
287 // For each action of type write
288 xbt_swag_foreach_safe(action, next_action, running_actions) {
289 if(action->type == WRITE)
291 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
292 /* Hack to avoid rounding differences between x86 and x86_64
293 * (note that the next sizes are of type size_t). */
294 long incr = delta * rate + MAXMIN_PRECISION;
295 ((storage_t)(action->storage))->used_size += incr; // disk usage
296 ((surf_action_t)action)->file->size += incr; // file size
300 xbt_swag_foreach_safe(action, next_action, running_actions) {
302 double_update(&(GENERIC_ACTION(action).remains),
303 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
305 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
306 double_update(&(GENERIC_ACTION(action).max_duration), delta);
308 if(GENERIC_ACTION(action).remains > 0 &&
309 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
310 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
312 GENERIC_ACTION(action).finish = surf_get_clock();
313 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
314 } else if ((GENERIC_ACTION(action).remains <= 0) &&
315 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
317 GENERIC_ACTION(action).finish = surf_get_clock();
318 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
319 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
320 (GENERIC_ACTION(action).max_duration <= 0))
322 GENERIC_ACTION(action).finish = surf_get_clock();
323 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
330 static double storage_share_resources(double NOW)
332 XBT_DEBUG("storage_share_resources %f",NOW);
333 s_surf_action_storage_t action;
336 surf_action_storage_t write_action;
338 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
339 xbt_swag_offset(action, generic_lmm_action.variable),
340 storage_maxmin_system, lmm_solve);
344 xbt_dynar_foreach(storage_list,i,storage)
347 // Foreach write action on disk
348 xbt_dynar_foreach(storage->write_actions,j,write_action)
350 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
353 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
356 return min_completion;
359 static int storage_resource_used(void *resource_id)
365 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
366 double value, double time)
371 static int storage_action_unref(surf_action_t action)
374 if (!action->refcount) {
375 xbt_swag_remove(action, action->state_set);
376 if (((surf_action_lmm_t) action)->variable)
377 lmm_variable_free(storage_maxmin_system,
378 ((surf_action_lmm_t) action)->variable);
380 xbt_free(action->category);
382 surf_action_free(&action);
388 static void storage_action_cancel(surf_action_t action)
390 surf_action_state_set(action, SURF_ACTION_FAILED);
394 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
396 surf_action_state_set(action, state);
400 static void storage_action_suspend(surf_action_t action)
402 XBT_IN("(%p)", action);
403 if (((surf_action_lmm_t) action)->suspended != 2) {
404 lmm_update_variable_weight(storage_maxmin_system,
405 ((surf_action_lmm_t) action)->variable,
407 ((surf_action_lmm_t) action)->suspended = 1;
412 static void storage_action_resume(surf_action_t action)
417 static int storage_action_is_suspended(surf_action_t action)
419 return (((surf_action_lmm_t) action)->suspended == 1);
422 static void storage_action_set_max_duration(surf_action_t action, double duration)
427 static void storage_action_set_priority(surf_action_t action, double priority)
432 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
434 void* stype = xbt_lib_get_or_null(storage_type_lib,
436 ROUTING_STORAGE_TYPE_LEVEL);
437 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
439 // if storage content is not specified use the content of storage_type if exist
440 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
441 storage->content = ((storage_type_t) stype)->content;
442 storage->content_type = ((storage_type_t) stype)->content_type;
443 XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s) from storage type '%s' ",
444 storage->id,((storage_type_t) stype)->content_type,
445 ((storage_type_t) stype)->type_id);
448 XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
449 "\n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tcontent_type '%s' "
450 "\n\t\tproperties '%p'\n",
452 ((storage_type_t) stype)->model,
453 ((storage_type_t) stype)->type_id,
455 storage->content_type,
456 ((storage_type_t) stype)->properties);
458 storage_create_resource(storage->id,
459 ((storage_type_t) stype)->model,
460 ((storage_type_t) stype)->type_id,
462 storage->content_type,
463 storage->properties);
466 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
468 XBT_DEBUG("parse_mstorage_init");
471 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
473 XBT_DEBUG("parse_storage_type_init");
476 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
478 XBT_DEBUG("parse_mount_init");
481 static void storage_define_callbacks()
483 sg_platf_storage_add_cb(parse_storage_init);
484 sg_platf_storage_type_add_cb(parse_storage_type_init);
485 sg_platf_mstorage_add_cb(parse_mstorage_init);
486 sg_platf_mount_add_cb(parse_mount_init);
489 static void surf_storage_model_init_internal(void)
491 s_surf_action_t action;
493 XBT_DEBUG("surf_storage_model_init_internal");
494 surf_storage_model = surf_model_init();
496 storage_running_action_set_that_does_not_need_being_checked =
497 xbt_swag_new(xbt_swag_offset(action, state_hookup));
499 surf_storage_model->name = "Storage";
500 surf_storage_model->action_unref = storage_action_unref;
501 surf_storage_model->action_cancel = storage_action_cancel;
502 surf_storage_model->action_state_set = storage_action_state_set;
504 surf_storage_model->model_private->finalize = storage_finalize;
505 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
506 surf_storage_model->model_private->share_resources = storage_share_resources;
507 surf_storage_model->model_private->resource_used = storage_resource_used;
508 surf_storage_model->model_private->update_resource_state = storage_resources_state;
510 surf_storage_model->suspend = storage_action_suspend;
511 surf_storage_model->resume = storage_action_resume;
512 surf_storage_model->is_suspended = storage_action_is_suspended;
513 surf_storage_model->set_max_duration = storage_action_set_max_duration;
514 surf_storage_model->set_priority = storage_action_set_priority;
516 surf_storage_model->extension.storage.open = storage_action_open;
517 surf_storage_model->extension.storage.close = storage_action_close;
518 surf_storage_model->extension.storage.read = storage_action_read;
519 surf_storage_model->extension.storage.write = storage_action_write;
520 surf_storage_model->extension.storage.ls = storage_action_ls;
521 surf_storage_model->extension.storage.get_properties = storage_get_properties;
522 surf_storage_model->extension.storage.get_content = storage_get_content;
524 if (!storage_maxmin_system) {
525 storage_maxmin_system = lmm_system_new(storage_selective_update);
530 void surf_storage_model_init_default(void)
532 surf_storage_model_init_internal();
533 storage_define_callbacks();
535 xbt_dynar_push(model_list, &surf_storage_model);
538 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
540 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
541 "Reading a storage, processing unit \"%s\" already exists", storage->id);
543 // Verification of an existing type_id
545 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
547 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
549 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
554 xbt_lib_set(storage_lib,
556 ROUTING_STORAGE_LEVEL,
557 (void *) xbt_strdup(storage->type_id));
560 static xbt_dict_t parse_storage_content(char *filename, size_t *used_size)
563 if ((!filename) || (strcmp(filename, "") == 0))
566 xbt_dict_t parse_content = xbt_dict_new_homogeneous(NULL);
569 file = surf_fopen(filename, "r");
570 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
571 xbt_str_join(surf_path, ":"));
580 while ((read = xbt_getline(&line, &len, file)) != -1) {
582 if(sscanf(line,"%s %zu",path, &size)==2) {
584 xbt_dict_set(parse_content,path,(void*) size,NULL);
586 xbt_die("Be sure of passing a good format for content file.\n");
592 return parse_content;
595 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
597 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
598 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
600 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
601 stype->model = xbt_strdup(storage_type->model);
602 stype->properties = storage_type->properties;
603 stype->content = xbt_strdup(storage_type->content);
604 stype->content_type = xbt_strdup(storage_type->content_type);
605 stype->type_id = xbt_strdup(storage_type->id);
606 stype->size = storage_type->size;
608 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s', "
609 "content '%s', and content_type '%s'",
612 storage_type->content,
613 storage_type->content_type);
615 xbt_lib_set(storage_type_lib,
617 ROUTING_STORAGE_TYPE_LEVEL,
620 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
623 // mount_t mnt = xbt_new0(s_mount_t, 1);
624 // mnt->id = xbt_strdup(mstorage->type_id);
625 // mnt->name = xbt_strdup(mstorage->name);
628 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
629 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
631 // xbt_dynar_push(mount_list,(void *) mnt);
635 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
638 static void mount_free(void *p)
644 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
646 // Verification of an existing storage
648 void* storage = xbt_lib_get_or_null(storage_lib, mount->storageId,ROUTING_STORAGE_LEVEL);
650 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->storageId);
652 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->storageId, mount->name);
656 surf_storage_resource_priv(surf_storage_resource_by_name(mount->storageId));
657 mnt.name = xbt_strdup(mount->name);
660 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
661 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
663 xbt_dynar_push(mount_list,&mnt);
666 static XBT_INLINE void routing_storage_type_free(void *r)
668 storage_type_t stype = r;
670 free(stype->type_id);
671 free(stype->content);
672 free(stype->content_type);
673 xbt_dict_free(&(stype->properties));
677 static XBT_INLINE void surf_storage_resource_free(void *r)
679 // specific to storage
680 storage_t storage = r;
681 xbt_dict_free(&storage->content);
682 xbt_dynar_free(&storage->write_actions);
683 free(storage->type_id);
684 free(storage->content_type);
686 surf_resource_free(r);
689 static XBT_INLINE void routing_storage_host_free(void *r)
692 xbt_dynar_free(&dyn);
695 void storage_register_callbacks() {
697 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
698 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
699 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
700 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
702 sg_platf_storage_add_cb(storage_parse_storage);
703 sg_platf_mstorage_add_cb(storage_parse_mstorage);
704 sg_platf_storage_type_add_cb(storage_parse_storage_type);
705 sg_platf_mount_add_cb(storage_parse_mount);