1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012. 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, unsigned long *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, double 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();
49 unsigned long size = 0;
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_get_size(void *storage, surf_file_t stream)
86 surf_action_t action = storage_action_execute(storage,0,GET_SIZE);
87 action->file = stream;
91 static surf_action_t storage_action_unlink(void *storage, surf_file_t stream)
93 surf_action_t action = storage_action_execute(storage,0, UNLINK);
95 // Add memory to storage
96 ((storage_t)storage)->used_size -= stream->size;
98 // Remove the file from storage
99 xbt_dict_t content_dict = ((storage_t)storage)->content;
100 xbt_dict_remove(content_dict,stream->name);
108 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
110 XBT_DEBUG("\tOpen file '%s'",path);
111 xbt_dict_t content_dict = ((storage_t)storage)->content;
112 size_t size = (size_t) xbt_dict_get_or_null(content_dict,path);
113 // if file does not exist create an empty file
115 xbt_dict_set(content_dict,path,&size,NULL);
116 XBT_DEBUG("File '%s' was not found, file created.",path);
118 surf_file_t file = xbt_new0(s_surf_file_t,1);
119 file->name = xbt_strdup(path);
121 file->storage = mount;
123 surf_action_t action = storage_action_execute(storage,0, OPEN);
124 action->file = (void *)file;
128 static surf_action_t storage_action_close(void *storage, surf_file_t fd)
130 char *filename = fd->name;
131 XBT_DEBUG("\tClose file '%s' size '%zu'",filename,fd->size);
132 // unref write actions from storage
133 surf_action_storage_t write_action;
135 xbt_dynar_foreach(((storage_t)storage)->write_actions,i,write_action) {
136 if ((write_action->generic_lmm_action.generic_action.file) == fd) {
137 xbt_dynar_cursor_rm(((storage_t)storage)->write_actions, &i);
138 storage_action_unref((surf_action_t) write_action);
144 surf_action_t action = storage_action_execute(storage,0, CLOSE);
148 static surf_action_t storage_action_read(void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream)
150 if(size > stream->size)
152 surf_action_t action = storage_action_execute(storage,size,READ);
156 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
158 char *filename = stream->name;
159 XBT_DEBUG("\tWrite file '%s' size '%zu/%zu'",filename,size,stream->size);
161 surf_action_t action = storage_action_execute(storage,size,WRITE);
162 action->file = stream;
164 // If the storage is full
165 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
166 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
171 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
173 surf_action_storage_t action = NULL;
174 storage_t STORAGE = storage;
176 XBT_IN("(%s,%f", surf_resource_name(STORAGE), size);
178 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
179 STORAGE->state_current != SURF_RESOURCE_ON);
181 // Save the storage on action
182 action->storage = storage;
183 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
184 calloc but it seems to help valgrind... */
186 GENERIC_LMM_ACTION(action).variable =
187 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
189 // Must be less than the max bandwidth for all actions
190 lmm_expand(storage_maxmin_system, STORAGE->constraint,
191 GENERIC_LMM_ACTION(action).variable, 1.0);
202 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
203 GENERIC_LMM_ACTION(action).variable, 1.0);
206 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
207 GENERIC_LMM_ACTION(action).variable, 1.0);
208 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
209 surf_action_ref((surf_action_t) action);
214 return (surf_action_t) action;
217 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
219 storage_t storage = NULL;
221 xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
222 "Storage '%s' declared several times in the platform file",
224 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
225 surf_storage_model, id,NULL);
227 storage->state_current = SURF_RESOURCE_ON;
228 storage->used_size = 0;
230 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
232 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
233 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
234 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
235 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
236 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
237 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
238 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
239 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
240 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
241 storage->size = storage_type->size;
243 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
245 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",
249 storage_type->properties,
252 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),NULL);
253 xbt_dynar_push(storage_list,&storage);
258 static void storage_finalize(void)
260 lmm_system_free(storage_maxmin_system);
261 storage_maxmin_system = NULL;
263 surf_model_exit(surf_storage_model);
264 surf_storage_model = NULL;
266 xbt_dynar_free(&storage_list);
269 (storage_running_action_set_that_does_not_need_being_checked);
270 storage_running_action_set_that_does_not_need_being_checked = NULL;
273 static void storage_update_actions_state(double now, double delta)
275 surf_action_storage_t action = NULL;
276 surf_action_storage_t next_action = NULL;
277 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
279 // Update the disk usage
280 // Update the file size
281 // For each action of type write
282 xbt_swag_foreach_safe(action, next_action, running_actions) {
283 if(action->type == WRITE)
285 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
286 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
287 ((surf_action_t)action)->file->size += delta * rate; // file size
291 xbt_swag_foreach_safe(action, next_action, running_actions) {
293 double_update(&(GENERIC_ACTION(action).remains),
294 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
296 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
297 double_update(&(GENERIC_ACTION(action).max_duration), delta);
299 if(GENERIC_ACTION(action).remains > 0 &&
300 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
301 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
303 GENERIC_ACTION(action).finish = surf_get_clock();
304 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
305 } else if ((GENERIC_ACTION(action).remains <= 0) &&
306 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
308 GENERIC_ACTION(action).finish = surf_get_clock();
309 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
310 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
311 (GENERIC_ACTION(action).max_duration <= 0))
313 GENERIC_ACTION(action).finish = surf_get_clock();
314 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
321 static double storage_share_resources(double NOW)
323 XBT_DEBUG("storage_share_resources %f",NOW);
324 s_surf_action_storage_t action;
327 surf_action_storage_t write_action;
329 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
330 xbt_swag_offset(action, generic_lmm_action.variable),
331 storage_maxmin_system, lmm_solve);
335 xbt_dynar_foreach(storage_list,i,storage)
338 // Foreach write action on disk
339 xbt_dynar_foreach(storage->write_actions,j,write_action)
341 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
344 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
347 return min_completion;
350 static int storage_resource_used(void *resource_id)
356 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
357 double value, double time)
362 static int storage_action_unref(surf_action_t action)
365 if (!action->refcount) {
366 xbt_swag_remove(action, action->state_set);
367 if (((surf_action_lmm_t) action)->variable)
368 lmm_variable_free(storage_maxmin_system,
369 ((surf_action_lmm_t) action)->variable);
371 xbt_free(action->category);
373 surf_action_free(&action);
379 static void storage_action_cancel(surf_action_t action)
381 surf_action_state_set(action, SURF_ACTION_FAILED);
385 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
387 surf_action_state_set(action, state);
391 static void storage_action_suspend(surf_action_t action)
393 XBT_IN("(%p)", action);
394 if (((surf_action_lmm_t) action)->suspended != 2) {
395 lmm_update_variable_weight(storage_maxmin_system,
396 ((surf_action_lmm_t) action)->variable,
398 ((surf_action_lmm_t) action)->suspended = 1;
403 static void storage_action_resume(surf_action_t action)
408 static int storage_action_is_suspended(surf_action_t action)
410 return (((surf_action_lmm_t) action)->suspended == 1);
413 static void storage_action_set_max_duration(surf_action_t action, double duration)
418 static void storage_action_set_priority(surf_action_t action, double priority)
423 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
425 void* stype = xbt_lib_get_or_null(storage_type_lib,
427 ROUTING_STORAGE_TYPE_LEVEL);
428 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
430 // if storage content is not specified use the content of storage_type if exist
431 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
432 storage->content = ((storage_type_t) stype)->content;
433 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
436 XBT_DEBUG("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",
438 ((storage_type_t) stype)->model,
439 ((storage_type_t) stype)->type_id,
441 ((storage_type_t) stype)->properties);
443 storage_create_resource(storage->id,
444 ((storage_type_t) stype)->model,
445 ((storage_type_t) stype)->type_id,
449 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
451 XBT_DEBUG("parse_mstorage_init");
454 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
456 XBT_DEBUG("parse_storage_type_init");
459 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
461 XBT_DEBUG("parse_mount_init");
464 static void storage_define_callbacks()
466 sg_platf_storage_add_cb(parse_storage_init);
467 sg_platf_storage_type_add_cb(parse_storage_type_init);
468 sg_platf_mstorage_add_cb(parse_mstorage_init);
469 sg_platf_mount_add_cb(parse_mount_init);
472 static void surf_storage_model_init_internal(void)
474 s_surf_action_t action;
476 XBT_DEBUG("surf_storage_model_init_internal");
477 surf_storage_model = surf_model_init();
479 storage_running_action_set_that_does_not_need_being_checked =
480 xbt_swag_new(xbt_swag_offset(action, state_hookup));
482 surf_storage_model->name = "Storage";
483 surf_storage_model->action_unref = storage_action_unref;
484 surf_storage_model->action_cancel = storage_action_cancel;
485 surf_storage_model->action_state_set = storage_action_state_set;
487 surf_storage_model->model_private->finalize = storage_finalize;
488 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
489 surf_storage_model->model_private->share_resources = storage_share_resources;
490 surf_storage_model->model_private->resource_used = storage_resource_used;
491 surf_storage_model->model_private->update_resource_state = storage_resources_state;
493 surf_storage_model->suspend = storage_action_suspend;
494 surf_storage_model->resume = storage_action_resume;
495 surf_storage_model->is_suspended = storage_action_is_suspended;
496 surf_storage_model->set_max_duration = storage_action_set_max_duration;
497 surf_storage_model->set_priority = storage_action_set_priority;
499 surf_storage_model->extension.storage.open = storage_action_open;
500 surf_storage_model->extension.storage.close = storage_action_close;
501 surf_storage_model->extension.storage.read = storage_action_read;
502 surf_storage_model->extension.storage.write = storage_action_write;
503 surf_storage_model->extension.storage.unlink = storage_action_unlink;
504 surf_storage_model->extension.storage.ls = storage_action_ls;
505 surf_storage_model->extension.storage.get_size = storage_action_get_size;
507 if (!storage_maxmin_system) {
508 storage_maxmin_system = lmm_system_new(storage_selective_update);
513 void surf_storage_model_init_default(void)
515 surf_storage_model_init_internal();
516 storage_define_callbacks();
518 xbt_dynar_push(model_list, &surf_storage_model);
521 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
523 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
524 "Reading a storage, processing unit \"%s\" already exists", storage->id);
526 // Verification of an existing type_id
528 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
530 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
532 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
537 xbt_lib_set(storage_lib,
539 ROUTING_STORAGE_LEVEL,
540 (void *) xbt_strdup(storage->type_id));
543 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
546 if ((!filename) || (strcmp(filename, "") == 0))
549 xbt_dict_t parse_content = xbt_dict_new_homogeneous(NULL);
552 file = surf_fopen(filename, "r");
553 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
554 xbt_str_join(surf_path, ":"));
563 while ((read = xbt_getline(&line, &len, file)) != -1) {
565 if(sscanf(line,"%s %ld",path, &size)==2) {
567 xbt_dict_set(parse_content,path,(void*) size,NULL);
569 xbt_die("Be sure of passing a good format for content file.\n");
575 return parse_content;
578 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
580 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
581 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
583 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
584 stype->model = xbt_strdup(storage_type->model);
585 stype->properties = storage_type->properties;
586 stype->content = xbt_strdup(storage_type->content);
587 stype->type_id = xbt_strdup(storage_type->id);
588 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
590 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
593 storage_type->content);
595 xbt_lib_set(storage_type_lib,
597 ROUTING_STORAGE_TYPE_LEVEL,
600 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
603 // mount_t mnt = xbt_new0(s_mount_t, 1);
604 // mnt->id = xbt_strdup(mstorage->type_id);
605 // mnt->name = xbt_strdup(mstorage->name);
608 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
609 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
611 // xbt_dynar_push(mount_list,(void *) mnt);
615 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
618 static void mount_free(void *p)
624 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
626 // Verification of an existing storage
628 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
630 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
632 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
635 mnt.id = surf_storage_resource_priv(surf_storage_resource_by_name(mount->id));
636 mnt.name = xbt_strdup(mount->name);
639 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
640 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
642 xbt_dynar_push(mount_list,&mnt);
645 static XBT_INLINE void routing_storage_type_free(void *r)
647 storage_type_t stype = r;
649 free(stype->type_id);
650 free(stype->content);
651 xbt_dict_free(&(stype->properties));
655 static XBT_INLINE void surf_storage_resource_free(void *r)
657 // specific to storage
658 storage_t storage = r;
659 xbt_dict_free(&storage->content);
660 xbt_dynar_free(&storage->write_actions);
662 surf_resource_free(r);
665 static XBT_INLINE void routing_storage_host_free(void *r)
668 xbt_dynar_free(&dyn);
671 void storage_register_callbacks() {
673 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
674 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
675 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
676 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
678 sg_platf_storage_add_cb(storage_parse_storage);
679 sg_platf_mstorage_add_cb(storage_parse_mstorage);
680 sg_platf_storage_type_add_cb(storage_parse_storage_type);
681 sg_platf_mount_add_cb(storage_parse_mount);