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(xbt_free);
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 sg_storage_size_t *psize = xbt_new(sg_storage_size_t,1);
70 xbt_dict_set(ls_dict,file,psize,NULL);
75 // if directory does not exist yet in the dictionary
76 if(!xbt_dict_get_or_null(ls_dict,file))
77 xbt_dict_set(ls_dict,file,NULL,NULL);
83 action->ls_dict = ls_dict;
87 static surf_action_t storage_action_open(void *storage, const char* mount,
90 XBT_DEBUG("\tOpen file '%s'",path);
91 xbt_dict_t content_dict = ((storage_t)storage)->content;
92 sg_storage_size_t size, *psize;
93 psize = (sg_storage_size_t*) xbt_dict_get_or_null(content_dict, path);
97 // if file does not exist create an empty file
98 psize = xbt_new(sg_storage_size_t,1);
101 xbt_dict_set(content_dict,path,psize,NULL);
102 XBT_DEBUG("File '%s' was not found, file created.",path);
104 surf_file_t file = xbt_new0(s_surf_file_t,1);
105 file->name = xbt_strdup(path);
107 file->mount = xbt_strdup(mount);
109 surf_action_t action = storage_action_execute(storage,0, OPEN);
110 action->file = (void *)file;
114 static surf_action_t storage_action_close(void *storage, surf_file_t fd)
116 char *filename = fd->name;
117 XBT_DEBUG("\tClose file '%s' size '%" PRIu64 "'", filename, fd->size);
118 // unref write actions from storage
119 surf_action_storage_t write_action;
121 xbt_dynar_foreach(((storage_t)storage)->write_actions,i,write_action) {
122 if ((write_action->generic_lmm_action.generic_action.file) == fd) {
123 xbt_dynar_cursor_rm(((storage_t)storage)->write_actions, &i);
124 storage_action_unref((surf_action_t) write_action);
130 surf_action_t action = storage_action_execute(storage,0, CLOSE);
134 static surf_action_t storage_action_read(void *storage, surf_file_t fd, sg_storage_size_t size)
138 surf_action_t action = storage_action_execute(storage,size,READ);
142 static surf_action_t storage_action_write(void *storage, surf_file_t fd, sg_storage_size_t size)
144 char *filename = fd->name;
145 XBT_DEBUG("\tWrite file '%s' size '%" PRIu64 "/%" PRIu64 "'",
146 filename, size, fd->size);
148 surf_action_t action = storage_action_execute(storage,size,WRITE);
151 // If the storage is full
152 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
153 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
158 static surf_action_t storage_action_execute (void *storage, sg_storage_size_t size, e_surf_action_storage_type_t type)
160 surf_action_storage_t action = NULL;
161 storage_t STORAGE = storage;
163 XBT_IN("(%s,%" PRIu64, surf_resource_name(STORAGE), size);
165 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
166 STORAGE->state_current != SURF_RESOURCE_ON);
168 // Save the storage on action
169 action->storage = storage;
170 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
171 calloc but it seems to help valgrind... */
173 GENERIC_LMM_ACTION(action).variable =
174 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
176 // Must be less than the max bandwidth for all actions
177 lmm_expand(storage_maxmin_system, STORAGE->constraint,
178 GENERIC_LMM_ACTION(action).variable, 1.0);
187 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
188 GENERIC_LMM_ACTION(action).variable, 1.0);
191 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
192 GENERIC_LMM_ACTION(action).variable, 1.0);
193 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
194 surf_action_ref((surf_action_t) action);
199 return (surf_action_t) action;
202 static xbt_dict_t storage_get_properties(const void *storage)
204 return surf_resource_properties(surf_storage_resource_priv(storage));
207 static xbt_dict_t storage_get_content(void *storage)
209 /* For the moment this action has no cost, but in the future we could take in account access latency of the disk */
210 /*surf_action_t action = storage_action_execute(storage,0, LS);*/
212 void *storage_resource = surf_storage_resource_priv(storage);
213 xbt_dict_t content_dict = xbt_dict_new_homogeneous(NULL);
214 xbt_dict_cursor_t cursor = NULL;
216 sg_storage_size_t *psize;
218 xbt_dict_foreach(((storage_t)storage_resource)->content, cursor, file, psize){
219 xbt_dict_set(content_dict,file,psize,NULL);
224 static sg_storage_size_t storage_get_size(void *storage){
225 void *storage_resource = surf_storage_resource_priv(storage);
226 return ((storage_t)storage_resource)->size;
229 static void* storage_create_resource(const char* id, const char* model,
230 const char* type_id, const char* content_name, const char* content_type, xbt_dict_t properties){
231 storage_t storage = NULL;
233 xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
234 "Storage '%s' declared several times in the platform file",
236 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
237 surf_storage_model, id, properties, NULL);
239 storage->state_current = SURF_RESOURCE_ON;
240 storage->used_size = 0;
242 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
244 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
246 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,"Bread"));
248 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,"Bwrite"));
250 surf_parse_get_bandwidth(xbt_dict_get(storage_type->properties,
252 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%lu'",Bconnection,Bread,Bwrite,(unsigned long)storage_type->size);
253 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
254 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
255 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
256 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
257 storage->content_type = xbt_strdup(content_type);
258 storage->size = storage_type->size;
259 storage->type_id = xbt_strdup(type_id);
261 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
263 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",
267 storage_type->properties,
271 storage_list = xbt_dynar_new(sizeof(char *),NULL);
272 xbt_dynar_push(storage_list,&storage);
277 static void storage_finalize(void)
279 lmm_system_free(storage_maxmin_system);
280 storage_maxmin_system = NULL;
282 surf_model_exit(surf_storage_model);
283 surf_storage_model = NULL;
285 xbt_dynar_free(&storage_list);
288 (storage_running_action_set_that_does_not_need_being_checked);
289 storage_running_action_set_that_does_not_need_being_checked = NULL;
292 static void storage_update_actions_state(double now, double delta)
294 surf_action_storage_t action = NULL;
295 surf_action_storage_t next_action = NULL;
296 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
299 xbt_swag_foreach_safe(action, next_action, running_actions) {
300 if(action->type == WRITE)
302 // Update the disk usage
303 // Update the file size
304 // Update the storage content (with file size)
305 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
306 /* Hack to avoid rounding differences between x86 and x86_64
307 * (note that the next sizes are of type sg_storage_size_t). */
308 long incr = delta * rate + MAXMIN_PRECISION;
309 ((storage_t)(action->storage))->used_size += incr; // disk usage
310 ((surf_action_t)action)->file->size += incr; // file size
312 sg_storage_size_t *psize = xbt_new(sg_storage_size_t,1);
313 *psize = ((surf_action_t)action)->file->size;
315 xbt_dict_t content_dict = ((storage_t)(action->storage))->content;
316 xbt_dict_set(content_dict,((surf_action_t)action)->file->name,psize,NULL);
319 double_update(&(GENERIC_ACTION(action).remains),
320 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
322 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
323 double_update(&(GENERIC_ACTION(action).max_duration), delta);
325 if(GENERIC_ACTION(action).remains > 0 &&
326 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
327 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
329 GENERIC_ACTION(action).finish = surf_get_clock();
330 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
331 } else if ((GENERIC_ACTION(action).remains <= 0) &&
332 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
334 GENERIC_ACTION(action).finish = surf_get_clock();
335 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
336 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
337 (GENERIC_ACTION(action).max_duration <= 0))
339 GENERIC_ACTION(action).finish = surf_get_clock();
340 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
347 static double storage_share_resources(double NOW)
349 XBT_DEBUG("storage_share_resources %f",NOW);
350 s_surf_action_storage_t action;
353 surf_action_storage_t write_action;
355 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
356 xbt_swag_offset(action, generic_lmm_action.variable),
357 storage_maxmin_system, lmm_solve);
361 xbt_dynar_foreach(storage_list,i,storage)
364 // Foreach write action on disk
365 xbt_dynar_foreach(storage->write_actions,j,write_action)
367 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
370 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
373 return min_completion;
376 static int storage_resource_used(void *resource_id)
382 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
383 double value, double time)
388 static int storage_action_unref(surf_action_t action)
391 if (!action->refcount) {
392 xbt_swag_remove(action, action->state_set);
393 if (((surf_action_lmm_t) action)->variable)
394 lmm_variable_free(storage_maxmin_system,
395 ((surf_action_lmm_t) action)->variable);
397 xbt_free(action->category);
399 surf_action_free(&action);
405 static void storage_action_cancel(surf_action_t action)
407 surf_action_state_set(action, SURF_ACTION_FAILED);
411 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
413 surf_action_state_set(action, state);
417 static void storage_action_suspend(surf_action_t action)
419 XBT_IN("(%p)", action);
420 if (((surf_action_lmm_t) action)->suspended != 2) {
421 lmm_update_variable_weight(storage_maxmin_system,
422 ((surf_action_lmm_t) action)->variable,
424 ((surf_action_lmm_t) action)->suspended = 1;
429 static void storage_action_resume(surf_action_t action)
434 static int storage_action_is_suspended(surf_action_t action)
436 return (((surf_action_lmm_t) action)->suspended == 1);
439 static void storage_action_set_max_duration(surf_action_t action, double duration)
444 static void storage_action_set_priority(surf_action_t action, double priority)
449 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
451 void* stype = xbt_lib_get_or_null(storage_type_lib,
453 ROUTING_STORAGE_TYPE_LEVEL);
454 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
456 // if storage content is not specified use the content of storage_type if exist
457 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
458 storage->content = ((storage_type_t) stype)->content;
459 storage->content_type = ((storage_type_t) stype)->content_type;
460 XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s) from storage type '%s' ",
461 storage->id,((storage_type_t) stype)->content_type,
462 ((storage_type_t) stype)->type_id);
465 XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
466 "\n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tcontent_type '%s' "
467 "\n\t\tproperties '%p'\n",
469 ((storage_type_t) stype)->model,
470 ((storage_type_t) stype)->type_id,
472 storage->content_type,
473 ((storage_type_t) stype)->properties);
475 storage_create_resource(storage->id,
476 ((storage_type_t) stype)->model,
477 ((storage_type_t) stype)->type_id,
479 storage->content_type,
480 storage->properties);
483 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
485 XBT_DEBUG("parse_mstorage_init");
488 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
490 XBT_DEBUG("parse_storage_type_init");
493 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
495 XBT_DEBUG("parse_mount_init");
498 static void storage_define_callbacks()
500 sg_platf_storage_add_cb(parse_storage_init);
501 sg_platf_storage_type_add_cb(parse_storage_type_init);
502 sg_platf_mstorage_add_cb(parse_mstorage_init);
503 sg_platf_mount_add_cb(parse_mount_init);
506 static void surf_storage_model_init_internal(void)
508 s_surf_action_t action;
510 XBT_DEBUG("surf_storage_model_init_internal");
511 surf_storage_model = surf_model_init();
513 storage_running_action_set_that_does_not_need_being_checked =
514 xbt_swag_new(xbt_swag_offset(action, state_hookup));
516 surf_storage_model->name = "Storage";
517 surf_storage_model->action_unref = storage_action_unref;
518 surf_storage_model->action_cancel = storage_action_cancel;
519 surf_storage_model->action_state_set = storage_action_state_set;
521 surf_storage_model->model_private->finalize = storage_finalize;
522 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
523 surf_storage_model->model_private->share_resources = storage_share_resources;
524 surf_storage_model->model_private->resource_used = storage_resource_used;
525 surf_storage_model->model_private->update_resource_state = storage_resources_state;
527 surf_storage_model->suspend = storage_action_suspend;
528 surf_storage_model->resume = storage_action_resume;
529 surf_storage_model->is_suspended = storage_action_is_suspended;
530 surf_storage_model->set_max_duration = storage_action_set_max_duration;
531 surf_storage_model->set_priority = storage_action_set_priority;
533 surf_storage_model->extension.storage.open = storage_action_open;
534 surf_storage_model->extension.storage.close = storage_action_close;
535 surf_storage_model->extension.storage.read = storage_action_read;
536 surf_storage_model->extension.storage.write = storage_action_write;
537 surf_storage_model->extension.storage.ls = storage_action_ls;
538 surf_storage_model->extension.storage.get_properties = storage_get_properties;
539 surf_storage_model->extension.storage.get_content = storage_get_content;
540 surf_storage_model->extension.storage.get_size = storage_get_size;
541 if (!storage_maxmin_system) {
542 storage_maxmin_system = lmm_system_new(storage_selective_update);
546 void surf_storage_model_init_default(void)
548 surf_storage_model_init_internal();
549 storage_define_callbacks();
551 xbt_dynar_push(model_list, &surf_storage_model);
554 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
556 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
557 "Reading a storage, processing unit \"%s\" already exists", storage->id);
559 // Verification of an existing type_id
561 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
563 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
565 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
570 xbt_lib_set(storage_lib,
572 ROUTING_STORAGE_LEVEL,
573 (void *) xbt_strdup(storage->type_id));
576 static xbt_dict_t parse_storage_content(char *filename, sg_storage_size_t *used_size)
579 if ((!filename) || (strcmp(filename, "") == 0))
582 xbt_dict_t parse_content = xbt_dict_new_homogeneous(xbt_free);
585 file = surf_fopen(filename, "r");
586 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
587 xbt_str_join(surf_path, ":"));
593 sg_storage_size_t size;
595 while ((read = xbt_getline(&line, &len, file)) != -1) {
597 if (sscanf(line,"%s %" SCNu64, path, &size) == 2) {
599 sg_storage_size_t *psize = xbt_new(sg_storage_size_t, 1);
601 xbt_dict_set(parse_content,path,psize,NULL);
603 xbt_die("Be sure of passing a good format for content file.\n");
609 return parse_content;
612 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
614 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
615 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
617 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
618 stype->model = xbt_strdup(storage_type->model);
619 stype->properties = storage_type->properties;
620 stype->content = xbt_strdup(storage_type->content);
621 stype->content_type = xbt_strdup(storage_type->content_type);
622 stype->type_id = xbt_strdup(storage_type->id);
623 stype->size = storage_type->size;
625 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s', "
626 "content '%s', and content_type '%s'",
629 storage_type->content,
630 storage_type->content_type);
632 xbt_lib_set(storage_type_lib,
634 ROUTING_STORAGE_TYPE_LEVEL,
637 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
640 // mount_t mnt = xbt_new0(s_mount_t, 1);
641 // mnt->id = xbt_strdup(mstorage->type_id);
642 // mnt->name = xbt_strdup(mstorage->name);
645 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
646 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
648 // xbt_dynar_push(mount_list,(void *) mnt);
652 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
655 static void mount_free(void *p)
661 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
663 // Verification of an existing storage
665 void* storage = xbt_lib_get_or_null(storage_lib, mount->storageId,ROUTING_STORAGE_LEVEL);
667 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->storageId);
669 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->storageId, mount->name);
673 surf_storage_resource_priv(surf_storage_resource_by_name(mount->storageId));
674 mnt.name = xbt_strdup(mount->name);
677 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
678 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
680 xbt_dynar_push(mount_list,&mnt);
683 static XBT_INLINE void routing_storage_type_free(void *r)
685 storage_type_t stype = r;
687 free(stype->type_id);
688 free(stype->content);
689 free(stype->content_type);
690 xbt_dict_free(&(stype->properties));
694 static XBT_INLINE void surf_storage_resource_free(void *r)
696 // specific to storage
697 storage_t storage = r;
698 xbt_dict_free(&storage->content);
699 xbt_dynar_free(&storage->write_actions);
700 free(storage->type_id);
701 free(storage->content_type);
703 surf_resource_free(r);
706 static XBT_INLINE void routing_storage_host_free(void *r)
709 xbt_dynar_free(&dyn);
712 void storage_register_callbacks() {
714 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
715 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
716 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
717 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
719 sg_platf_storage_add_cb(storage_parse_storage);
720 sg_platf_mstorage_add_cb(storage_parse_mstorage);
721 sg_platf_storage_type_add_cb(storage_parse_storage_type);
722 sg_platf_mount_add_cb(storage_parse_mount);