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. */
9 #include "xbt/file_stat.h"
11 #include "surf_private.h"
12 #include "storage_private.h"
13 #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, unsigned long *used_size);
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_stat(void *storage, surf_file_t stream)
44 surf_action_t action = storage_action_execute(storage,0, STAT);
45 action->file = stream;
46 action->stat = stream->content->stat;
50 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
52 XBT_DEBUG("\tOpen file '%s'",path);
53 xbt_dict_t content_dict = ((storage_t)storage)->content;
54 surf_stat_t content = xbt_dict_get_or_null(content_dict,path);
56 // if file does not exist create an empty file
58 content = xbt_new0(s_surf_stat_t,1);
59 content->stat.date = xbt_strdup("");
60 content->stat.group = xbt_strdup("");
61 content->stat.size = 0;
62 content->stat.time = xbt_strdup("");
63 content->stat.user = xbt_strdup("");
64 content->stat.user_rights = xbt_strdup("");
65 xbt_dict_set(content_dict,path,content,NULL);
66 XBT_DEBUG("File '%s' was not found, file created.",path);
68 surf_file_t file = xbt_new0(s_surf_file_t,1);
69 file->name = xbt_strdup(path);
70 file->content = content;
71 file->storage = mount;
73 surf_action_t action = storage_action_execute(storage,0, OPEN);
74 action->file = (void *)file;
78 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
80 char *filename = fp->name;
81 XBT_DEBUG("\tClose file '%s' size '%f'",filename,fp->content->stat.size);
85 surf_action_t action = storage_action_execute(storage,0, CLOSE);
89 static surf_action_t storage_action_read(void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream)
91 surf_stat_t content = stream->content;
92 if(size > content->stat.size)
93 size = content->stat.size;
94 surf_action_t action = storage_action_execute(storage,size,READ);
98 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
100 char *filename = stream->name;
101 surf_stat_t content = stream->content;
102 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
104 surf_action_t action = storage_action_execute(storage,size,WRITE);
105 action->file = stream;
107 // If the storage is full
108 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
109 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
114 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
116 surf_action_storage_t action = NULL;
117 storage_t STORAGE = storage;
119 XBT_IN("(%s,%f)", surf_resource_name(STORAGE), size);
121 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
122 STORAGE->state_current != SURF_RESOURCE_ON);
124 // Save the storage on action
125 action->storage = storage;
126 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
127 calloc but it seems to help valgrind... */
129 GENERIC_LMM_ACTION(action).variable =
130 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
132 // Must be less than the max bandwidth for all actions
133 lmm_expand(storage_maxmin_system, STORAGE->constraint,
134 GENERIC_LMM_ACTION(action).variable, 1.0);
142 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
143 GENERIC_LMM_ACTION(action).variable, 1.0);
146 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
147 GENERIC_LMM_ACTION(action).variable, 1.0);
148 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
154 return (surf_action_t) action;
157 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
159 storage_t storage = NULL;
161 xbt_assert(!surf_storage_resource_by_name(id),
162 "Storage '%s' declared several times in the platform file",
164 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
165 surf_storage_model, id,NULL);
167 storage->state_current = SURF_RESOURCE_ON;
168 storage->used_size = 0;
170 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
172 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
173 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
174 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
175 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
176 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
177 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
178 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
179 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
180 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
181 storage->size = storage_type->size;
183 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
185 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",
189 storage_type->properties,
192 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),NULL);
193 xbt_dynar_push(storage_list,&storage);
198 static void storage_finalize(void)
200 lmm_system_free(storage_maxmin_system);
201 storage_maxmin_system = NULL;
203 surf_model_exit(surf_storage_model);
204 surf_storage_model = NULL;
207 xbt_dynar_free(&storage_list);
210 (storage_running_action_set_that_does_not_need_being_checked);
211 storage_running_action_set_that_does_not_need_being_checked = NULL;
214 static void storage_update_actions_state(double now, double delta)
216 surf_action_storage_t action = NULL;
217 surf_action_storage_t next_action = NULL;
218 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
220 // Update the disk usage
221 // Update the file size
222 // Foreach action of type write
223 xbt_swag_foreach_safe(action, next_action, running_actions) {
224 if(action->type == WRITE)
226 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
227 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
228 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
232 xbt_swag_foreach_safe(action, next_action, running_actions) {
234 double_update(&(GENERIC_ACTION(action).remains),
235 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
237 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
238 double_update(&(GENERIC_ACTION(action).max_duration), delta);
240 if(GENERIC_ACTION(action).remains > 0 &&
241 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
242 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
244 GENERIC_ACTION(action).finish = surf_get_clock();
245 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
246 } else if ((GENERIC_ACTION(action).remains <= 0) &&
247 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
249 GENERIC_ACTION(action).finish = surf_get_clock();
250 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
251 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
252 (GENERIC_ACTION(action).max_duration <= 0))
254 GENERIC_ACTION(action).finish = surf_get_clock();
255 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
262 static double storage_share_resources(double NOW)
264 XBT_DEBUG("storage_share_resources %f",NOW);
265 s_surf_action_storage_t action;
268 surf_action_storage_t write_action;
270 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
271 xbt_swag_offset(action, generic_lmm_action.variable),
272 storage_maxmin_system, lmm_solve);
276 xbt_dynar_foreach(storage_list,i,storage)
279 // Foreach write action on disk
280 xbt_dynar_foreach(storage->write_actions,j,write_action)
282 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
285 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
288 return min_completion;
291 static int storage_resource_used(void *resource_id)
297 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
298 double value, double time)
303 static int storage_action_unref(surf_action_t action)
306 if (!action->refcount) {
307 xbt_swag_remove(action, action->state_set);
308 if (((surf_action_lmm_t) action)->variable)
309 lmm_variable_free(storage_maxmin_system,
310 ((surf_action_lmm_t) action)->variable);
312 xbt_free(action->category);
314 surf_action_free(&action);
320 static void storage_action_cancel(surf_action_t action)
322 surf_action_state_set(action, SURF_ACTION_FAILED);
326 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
328 surf_action_state_set(action, state);
332 static void storage_action_suspend(surf_action_t action)
334 XBT_IN("(%p)", action);
335 if (((surf_action_lmm_t) action)->suspended != 2) {
336 lmm_update_variable_weight(storage_maxmin_system,
337 ((surf_action_lmm_t) action)->variable,
339 ((surf_action_lmm_t) action)->suspended = 1;
344 static void storage_action_resume(surf_action_t action)
349 static int storage_action_is_suspended(surf_action_t action)
351 return (((surf_action_lmm_t) action)->suspended == 1);
354 static void storage_action_set_max_duration(surf_action_t action, double duration)
359 static void storage_action_set_priority(surf_action_t action, double priority)
364 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
366 void* stype = xbt_lib_get_or_null(storage_type_lib,
368 ROUTING_STORAGE_TYPE_LEVEL);
369 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
371 // if storage content is not specified use the content of storage_type if exist
372 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
373 storage->content = ((storage_type_t) stype)->content;
374 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
377 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",
379 ((storage_type_t) stype)->model,
380 ((storage_type_t) stype)->type_id,
382 ((storage_type_t) stype)->properties);
384 storage_create_resource(storage->id,
385 ((storage_type_t) stype)->model,
386 ((storage_type_t) stype)->type_id,
390 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
392 XBT_DEBUG("parse_mstorage_init");
395 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
397 XBT_DEBUG("parse_storage_type_init");
400 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
402 XBT_DEBUG("parse_mount_init");
405 static void storage_define_callbacks()
407 sg_platf_storage_add_cb(parse_storage_init);
408 sg_platf_storage_type_add_cb(parse_storage_type_init);
409 sg_platf_mstorage_add_cb(parse_mstorage_init);
410 sg_platf_mount_add_cb(parse_mount_init);
413 static void surf_storage_model_init_internal(void)
415 s_surf_action_t action;
417 XBT_DEBUG("surf_storage_model_init_internal");
418 surf_storage_model = surf_model_init();
420 storage_running_action_set_that_does_not_need_being_checked =
421 xbt_swag_new(xbt_swag_offset(action, state_hookup));
423 surf_storage_model->name = "Storage";
424 surf_storage_model->action_unref = storage_action_unref;
425 surf_storage_model->action_cancel = storage_action_cancel;
426 surf_storage_model->action_state_set = storage_action_state_set;
428 surf_storage_model->model_private->finalize = storage_finalize;
429 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
430 surf_storage_model->model_private->share_resources = storage_share_resources;
431 surf_storage_model->model_private->resource_used = storage_resource_used;
432 surf_storage_model->model_private->update_resource_state = storage_resources_state;
434 surf_storage_model->suspend = storage_action_suspend;
435 surf_storage_model->resume = storage_action_resume;
436 surf_storage_model->is_suspended = storage_action_is_suspended;
437 surf_storage_model->set_max_duration = storage_action_set_max_duration;
438 surf_storage_model->set_priority = storage_action_set_priority;
440 surf_storage_model->extension.storage.open = storage_action_open;
441 surf_storage_model->extension.storage.close = storage_action_close;
442 surf_storage_model->extension.storage.read = storage_action_read;
443 surf_storage_model->extension.storage.write = storage_action_write;
444 surf_storage_model->extension.storage.stat = storage_action_stat;
445 surf_storage_model->extension.storage.create_resource = storage_create_resource;
447 if (!storage_maxmin_system) {
448 storage_maxmin_system = lmm_system_new(storage_selective_update);
453 void surf_storage_model_init_default(void)
455 surf_storage_model_init_internal();
456 storage_define_callbacks();
458 xbt_dynar_push(model_list, &surf_storage_model);
461 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
463 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
464 "Reading a storage, processing unit \"%s\" already exists", storage->id);
466 // Verification of an existing type_id
468 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
470 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
472 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
477 xbt_lib_set(storage_lib,
479 ROUTING_STORAGE_LEVEL,
480 (void *) xbt_strdup(storage->type_id));
483 static void free_storage_content(void *p)
485 surf_stat_t content = p;
486 free(content->stat.date);
487 free(content->stat.group);
488 free(content->stat.time);
489 free(content->stat.user);
490 free(content->stat.user_rights);
494 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
497 if ((!filename) || (strcmp(filename, "") == 0))
500 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
503 file = surf_fopen(filename, "r");
504 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
505 xbt_str_join(surf_path, ":"));
510 char user_rights[12];
521 while ((read = getline(&line, &len, file)) != -1) {
522 content = xbt_new0(s_surf_stat_t,1);
523 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
524 content->stat.date = xbt_strdup(date);
525 content->stat.group = xbt_strdup(group);
526 content->stat.size = size;
527 content->stat.time = xbt_strdup(time);
528 content->stat.user = xbt_strdup(user);
529 content->stat.user_rights = xbt_strdup(user_rights);
530 *used_size += content->stat.size;
531 xbt_dict_set(parse_content,path,content,NULL);
533 xbt_die("Be sure of passing a good format for content file.\n");
534 // You can generate this kind of file with command line:
535 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
541 return parse_content;
544 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
546 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
547 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
549 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
550 stype->model = xbt_strdup(storage_type->model);
551 stype->properties = storage_type->properties;
552 stype->content = xbt_strdup(storage_type->content);
553 stype->type_id = xbt_strdup(storage_type->id);
554 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
556 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
559 storage_type->content);
561 xbt_lib_set(storage_type_lib,
563 ROUTING_STORAGE_TYPE_LEVEL,
566 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
569 // mount_t mnt = xbt_new0(s_mount_t, 1);
570 // mnt->id = xbt_strdup(mstorage->type_id);
571 // mnt->name = xbt_strdup(mstorage->name);
574 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
575 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
577 // xbt_dynar_push(mount_list,(void *) mnt);
581 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
584 static void mount_free(void *p)
590 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
592 // Verification of an existing storage
594 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
596 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
598 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
601 mnt.id = surf_storage_resource_by_name(mount->id);
602 mnt.name = xbt_strdup(mount->name);
605 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
606 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
608 xbt_dynar_push(mount_list,&mnt);
611 static XBT_INLINE void routing_storage_type_free(void *r)
613 storage_type_t stype = r;
615 free(stype->type_id);
616 free(stype->content);
617 xbt_dict_free(&(stype->properties));
621 static XBT_INLINE void surf_storage_resource_free(void *r)
623 // specific to storage
624 storage_t storage = r;
625 xbt_dict_free(&storage->content);
626 xbt_dynar_free(&storage->write_actions);
628 surf_resource_free(r);
631 static XBT_INLINE void routing_storage_host_free(void *r)
634 xbt_dynar_free(&dyn);
637 void storage_register_callbacks() {
639 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
640 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
641 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
642 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
644 sg_platf_storage_add_cb(storage_parse_storage);
645 sg_platf_mstorage_add_cb(storage_parse_mstorage);
646 sg_platf_storage_type_add_cb(storage_parse_storage_type);
647 sg_platf_mount_add_cb(storage_parse_mount);