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"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_storage, surf,
16 "Logging specific to the SURF storage module");
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
25 xbt_dynar_t mount_list = NULL; /* temporary store of current mount storage */
27 surf_model_t surf_storage_model = NULL;
28 lmm_system_t storage_maxmin_system = NULL;
29 static int storage_selective_update = 0;
31 storage_running_action_set_that_does_not_need_being_checked = NULL;
33 static xbt_dynar_t storage_list;
35 #define GENERIC_LMM_ACTION(action) action->generic_lmm_action
36 #define GENERIC_ACTION(action) GENERIC_LMM_ACTION(action).generic_action
38 static xbt_dict_t parse_storage_content(char *filename, sg_storage_size_t *used_size);
39 static int storage_action_unref(surf_action_t action);
40 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state);
41 static surf_action_t storage_action_execute (void *storage, sg_storage_size_t size, e_surf_action_storage_type_t type);
43 static surf_action_t storage_action_ls(void *storage, const char* path)
45 surf_action_t action = storage_action_execute(storage,0, LS);
46 action->ls_dict = NULL;
47 xbt_dict_t ls_dict = xbt_dict_new_homogeneous(NULL);
50 sg_storage_size_t size = 0;
51 xbt_dict_cursor_t cursor = NULL;
53 xbt_dynar_t dyn = NULL;
56 // for each file in the storage content
57 xbt_dict_foreach(((storage_t)storage)->content,cursor,key,size){
58 // Search if file start with the prefix 'path'
59 if(xbt_str_start_with(key,path)){
60 file = &key[strlen(path)];
62 // Split file with '/'
63 dyn = xbt_str_split(file,"/");
64 file = xbt_dynar_get_as(dyn,0,char*);
67 if(xbt_dynar_length(dyn) == 1){
68 xbt_dict_set(ls_dict,file,&size,NULL);
73 // if directory does not exist yet in the dictionary
74 if(!xbt_dict_get_or_null(ls_dict,file))
75 xbt_dict_set(ls_dict,file,NULL,NULL);
81 action->ls_dict = ls_dict;
85 static surf_action_t storage_action_open(void *storage, const char* mount,
88 XBT_DEBUG("\tOpen file '%s'",path);
89 xbt_dict_t content_dict = ((storage_t)storage)->content;
90 sg_storage_size_t size = (sg_storage_size_t) xbt_dict_get_or_null(content_dict,path);
92 // if file does not exist create an empty file
95 xbt_dict_set(content_dict,path,&size,NULL);
96 XBT_DEBUG("File '%s' was not found, file created.",path);
98 surf_file_t file = xbt_new0(s_surf_file_t,1);
99 file->name = xbt_strdup(path);
101 file->mount = xbt_strdup(mount);
103 surf_action_t action = storage_action_execute(storage,0, OPEN);
104 action->file = (void *)file;
108 static surf_action_t storage_action_close(void *storage, surf_file_t fd)
110 char *filename = fd->name;
111 XBT_DEBUG("\tClose file '%s' size '%" PRIu64 "'", filename, fd->size);
112 // unref write actions from storage
113 surf_action_storage_t write_action;
115 xbt_dynar_foreach(((storage_t)storage)->write_actions,i,write_action) {
116 if ((write_action->generic_lmm_action.generic_action.file) == fd) {
117 xbt_dynar_cursor_rm(((storage_t)storage)->write_actions, &i);
118 storage_action_unref((surf_action_t) write_action);
124 surf_action_t action = storage_action_execute(storage,0, CLOSE);
128 static surf_action_t storage_action_read(void *storage, sg_storage_size_t size,
133 surf_action_t action = storage_action_execute(storage,size,READ);
137 static surf_action_t storage_action_write(void *storage, sg_storage_size_t size,
140 char *filename = fd->name;
141 XBT_DEBUG("\tWrite file '%s' size '%" PRIu64 "/%" PRIu64 "'",
142 filename, size, fd->size);
144 surf_action_t action = storage_action_execute(storage,size,WRITE);
147 // If the storage is full
148 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
149 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
154 static surf_action_t storage_action_execute (void *storage, sg_storage_size_t size, e_surf_action_storage_type_t type)
156 surf_action_storage_t action = NULL;
157 storage_t STORAGE = storage;
159 XBT_IN("(%s,%" PRIu64, surf_resource_name(STORAGE), size);
161 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
162 STORAGE->state_current != SURF_RESOURCE_ON);
164 // Save the storage on action
165 action->storage = storage;
166 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
167 calloc but it seems to help valgrind... */
169 GENERIC_LMM_ACTION(action).variable =
170 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
172 // Must be less than the max bandwidth for all actions
173 lmm_expand(storage_maxmin_system, STORAGE->constraint,
174 GENERIC_LMM_ACTION(action).variable, 1.0);
183 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
184 GENERIC_LMM_ACTION(action).variable, 1.0);
187 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
188 GENERIC_LMM_ACTION(action).variable, 1.0);
189 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
190 surf_action_ref((surf_action_t) action);
195 return (surf_action_t) action;
198 static xbt_dict_t storage_get_properties(const void *storage)
200 return surf_resource_properties(surf_storage_resource_priv(storage));
203 static xbt_dict_t storage_get_content(void *storage)
205 /* For the moment this action has no cost, but in the future we could take in account access latency of the disk */
206 /*surf_action_t action = storage_action_execute(storage,0, LS);*/
208 void *st = surf_storage_resource_priv(storage);
209 xbt_dict_t content_dict = xbt_dict_new_homogeneous(NULL);
210 xbt_dict_cursor_t cursor = NULL;
213 xbt_dict_foreach(((storage_t)st)->content, cursor, file, size){
214 xbt_dict_set(content_dict,file,(void*)size,NULL);
219 static void* storage_create_resource(const char* id, const char* model,
220 const char* type_id, const char* content_name, const char* content_type, xbt_dict_t properties){
221 storage_t storage = NULL;
223 xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
224 "Storage '%s' declared several times in the platform file",
226 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
227 surf_storage_model, id, properties, NULL);
229 storage->state_current = SURF_RESOURCE_ON;
230 storage->used_size = 0;
232 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
234 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
236 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,"Bread"));
238 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,"Bwrite"));
240 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,
242 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%lu'",Bconnection,Bread,Bwrite,(unsigned long)storage_type->size);
243 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
244 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
245 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
246 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
247 storage->content_type = xbt_strdup(content_type);
248 storage->size = storage_type->size;
249 storage->type_id = xbt_strdup(type_id);
251 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
253 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",
257 storage_type->properties,
261 storage_list = xbt_dynar_new(sizeof(char *),NULL);
262 xbt_dynar_push(storage_list,&storage);
267 static void storage_finalize(void)
269 lmm_system_free(storage_maxmin_system);
270 storage_maxmin_system = NULL;
272 surf_model_exit(surf_storage_model);
273 surf_storage_model = NULL;
275 xbt_dynar_free(&storage_list);
278 (storage_running_action_set_that_does_not_need_being_checked);
279 storage_running_action_set_that_does_not_need_being_checked = NULL;
282 static void storage_update_actions_state(double now, double delta)
284 surf_action_storage_t action = NULL;
285 surf_action_storage_t next_action = NULL;
286 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
289 xbt_swag_foreach_safe(action, next_action, running_actions) {
290 if(action->type == WRITE)
292 // Update the disk usage
293 // Update the file size
294 // Update the storage content (with file size)
295 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
296 /* Hack to avoid rounding differences between x86 and x86_64
297 * (note that the next sizes are of type sg_storage_size_t). */
298 long incr = delta * rate + MAXMIN_PRECISION;
299 ((storage_t)(action->storage))->used_size += incr; // disk usage
300 ((surf_action_t)action)->file->size += incr; // file size
302 xbt_dict_t content_dict = ((storage_t)(action->storage))->content;
303 xbt_dict_set(content_dict,((surf_action_t)action)->file->name,(void*)(((surf_action_t)action)->file->size),NULL);
306 double_update(&(GENERIC_ACTION(action).remains),
307 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
309 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
310 double_update(&(GENERIC_ACTION(action).max_duration), delta);
312 if(GENERIC_ACTION(action).remains > 0 &&
313 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
314 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
316 GENERIC_ACTION(action).finish = surf_get_clock();
317 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
318 } else if ((GENERIC_ACTION(action).remains <= 0) &&
319 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
321 GENERIC_ACTION(action).finish = surf_get_clock();
322 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
323 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
324 (GENERIC_ACTION(action).max_duration <= 0))
326 GENERIC_ACTION(action).finish = surf_get_clock();
327 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
334 static double storage_share_resources(double NOW)
336 XBT_DEBUG("storage_share_resources %f",NOW);
337 s_surf_action_storage_t action;
340 surf_action_storage_t write_action;
342 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
343 xbt_swag_offset(action, generic_lmm_action.variable),
344 storage_maxmin_system, lmm_solve);
348 xbt_dynar_foreach(storage_list,i,storage)
351 // Foreach write action on disk
352 xbt_dynar_foreach(storage->write_actions,j,write_action)
354 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
357 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
360 return min_completion;
363 static int storage_resource_used(void *resource_id)
369 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
370 double value, double time)
375 static int storage_action_unref(surf_action_t action)
378 if (!action->refcount) {
379 xbt_swag_remove(action, action->state_set);
380 if (((surf_action_lmm_t) action)->variable)
381 lmm_variable_free(storage_maxmin_system,
382 ((surf_action_lmm_t) action)->variable);
384 xbt_free(action->category);
386 surf_action_free(&action);
392 static void storage_action_cancel(surf_action_t action)
394 surf_action_state_set(action, SURF_ACTION_FAILED);
398 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
400 surf_action_state_set(action, state);
404 static void storage_action_suspend(surf_action_t action)
406 XBT_IN("(%p)", action);
407 if (((surf_action_lmm_t) action)->suspended != 2) {
408 lmm_update_variable_weight(storage_maxmin_system,
409 ((surf_action_lmm_t) action)->variable,
411 ((surf_action_lmm_t) action)->suspended = 1;
416 static void storage_action_resume(surf_action_t action)
421 static int storage_action_is_suspended(surf_action_t action)
423 return (((surf_action_lmm_t) action)->suspended == 1);
426 static void storage_action_set_max_duration(surf_action_t action, double duration)
431 static void storage_action_set_priority(surf_action_t action, double priority)
436 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
438 void* stype = xbt_lib_get_or_null(storage_type_lib,
440 ROUTING_STORAGE_TYPE_LEVEL);
441 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
443 // if storage content is not specified use the content of storage_type if exist
444 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
445 storage->content = ((storage_type_t) stype)->content;
446 storage->content_type = ((storage_type_t) stype)->content_type;
447 XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s) from storage type '%s' ",
448 storage->id,((storage_type_t) stype)->content_type,
449 ((storage_type_t) stype)->type_id);
452 XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
453 "\n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tcontent_type '%s' "
454 "\n\t\tproperties '%p'\n",
456 ((storage_type_t) stype)->model,
457 ((storage_type_t) stype)->type_id,
459 storage->content_type,
460 ((storage_type_t) stype)->properties);
462 storage_create_resource(storage->id,
463 ((storage_type_t) stype)->model,
464 ((storage_type_t) stype)->type_id,
466 storage->content_type,
467 storage->properties);
470 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
472 XBT_DEBUG("parse_mstorage_init");
475 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
477 XBT_DEBUG("parse_storage_type_init");
480 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
482 XBT_DEBUG("parse_mount_init");
485 static void storage_define_callbacks()
487 sg_platf_storage_add_cb(parse_storage_init);
488 sg_platf_storage_type_add_cb(parse_storage_type_init);
489 sg_platf_mstorage_add_cb(parse_mstorage_init);
490 sg_platf_mount_add_cb(parse_mount_init);
493 static void surf_storage_model_init_internal(void)
495 s_surf_action_t action;
497 XBT_DEBUG("surf_storage_model_init_internal");
498 surf_storage_model = surf_model_init();
500 storage_running_action_set_that_does_not_need_being_checked =
501 xbt_swag_new(xbt_swag_offset(action, state_hookup));
503 surf_storage_model->name = "Storage";
504 surf_storage_model->action_unref = storage_action_unref;
505 surf_storage_model->action_cancel = storage_action_cancel;
506 surf_storage_model->action_state_set = storage_action_state_set;
508 surf_storage_model->model_private->finalize = storage_finalize;
509 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
510 surf_storage_model->model_private->share_resources = storage_share_resources;
511 surf_storage_model->model_private->resource_used = storage_resource_used;
512 surf_storage_model->model_private->update_resource_state = storage_resources_state;
514 surf_storage_model->suspend = storage_action_suspend;
515 surf_storage_model->resume = storage_action_resume;
516 surf_storage_model->is_suspended = storage_action_is_suspended;
517 surf_storage_model->set_max_duration = storage_action_set_max_duration;
518 surf_storage_model->set_priority = storage_action_set_priority;
520 surf_storage_model->extension.storage.open = storage_action_open;
521 surf_storage_model->extension.storage.close = storage_action_close;
522 surf_storage_model->extension.storage.read = storage_action_read;
523 surf_storage_model->extension.storage.write = storage_action_write;
524 surf_storage_model->extension.storage.ls = storage_action_ls;
525 surf_storage_model->extension.storage.get_properties = storage_get_properties;
526 surf_storage_model->extension.storage.get_content = storage_get_content;
528 if (!storage_maxmin_system) {
529 storage_maxmin_system = lmm_system_new(storage_selective_update);
534 void surf_storage_model_init_default(void)
536 surf_storage_model_init_internal();
537 storage_define_callbacks();
539 xbt_dynar_push(model_list, &surf_storage_model);
542 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
544 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
545 "Reading a storage, processing unit \"%s\" already exists", storage->id);
547 // Verification of an existing type_id
549 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
551 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
553 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
558 xbt_lib_set(storage_lib,
560 ROUTING_STORAGE_LEVEL,
561 (void *) xbt_strdup(storage->type_id));
564 static xbt_dict_t parse_storage_content(char *filename, sg_storage_size_t *used_size)
567 if ((!filename) || (strcmp(filename, "") == 0))
570 xbt_dict_t parse_content = xbt_dict_new_homogeneous(NULL);
573 file = surf_fopen(filename, "r");
574 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
575 xbt_str_join(surf_path, ":"));
581 sg_storage_size_t size;
583 while ((read = xbt_getline(&line, &len, file)) != -1) {
585 if (sscanf(line,"%s %" SCNu64, path, &size) == 2) {
587 xbt_dict_set(parse_content,path,(void*) size,NULL);
589 xbt_die("Be sure of passing a good format for content file.\n");
595 return parse_content;
598 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
600 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
601 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
603 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
604 stype->model = xbt_strdup(storage_type->model);
605 stype->properties = storage_type->properties;
606 stype->content = xbt_strdup(storage_type->content);
607 stype->content_type = xbt_strdup(storage_type->content_type);
608 stype->type_id = xbt_strdup(storage_type->id);
609 stype->size = storage_type->size;
611 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s', "
612 "content '%s', and content_type '%s'",
615 storage_type->content,
616 storage_type->content_type);
618 xbt_lib_set(storage_type_lib,
620 ROUTING_STORAGE_TYPE_LEVEL,
623 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
626 // mount_t mnt = xbt_new0(s_mount_t, 1);
627 // mnt->id = xbt_strdup(mstorage->type_id);
628 // mnt->name = xbt_strdup(mstorage->name);
631 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
632 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
634 // xbt_dynar_push(mount_list,(void *) mnt);
638 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
641 static void mount_free(void *p)
647 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
649 // Verification of an existing storage
651 void* storage = xbt_lib_get_or_null(storage_lib, mount->storageId,ROUTING_STORAGE_LEVEL);
653 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->storageId);
655 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->storageId, mount->name);
659 surf_storage_resource_priv(surf_storage_resource_by_name(mount->storageId));
660 mnt.name = xbt_strdup(mount->name);
663 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
664 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
666 xbt_dynar_push(mount_list,&mnt);
669 static XBT_INLINE void routing_storage_type_free(void *r)
671 storage_type_t stype = r;
673 free(stype->type_id);
674 free(stype->content);
675 free(stype->content_type);
676 xbt_dict_free(&(stype->properties));
680 static XBT_INLINE void surf_storage_resource_free(void *r)
682 // specific to storage
683 storage_t storage = r;
684 xbt_dict_free(&storage->content);
685 xbt_dynar_free(&storage->write_actions);
686 free(storage->type_id);
687 free(storage->content_type);
689 surf_resource_free(r);
692 static XBT_INLINE void routing_storage_host_free(void *r)
695 xbt_dynar_free(&dyn);
698 void storage_register_callbacks() {
700 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
701 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
702 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
703 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
705 sg_platf_storage_add_cb(storage_parse_storage);
706 sg_platf_mstorage_add_cb(storage_parse_mstorage);
707 sg_platf_storage_type_add_cb(storage_parse_storage_type);
708 sg_platf_mount_add_cb(storage_parse_mount);