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 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, double size, e_surf_action_storage_type_t type);
42 static void free_storage_content(void *p);
44 static surf_action_t storage_action_stat(void *storage, surf_file_t stream)
46 surf_action_t action = storage_action_execute(storage,0, STAT);
47 action->file = stream;
48 action->stat = stream->content->stat;
52 static surf_action_t storage_action_ls(void *storage, const char* path)
54 surf_action_t action = storage_action_execute(storage,0, LS);
55 action->ls_dict = NULL;
56 xbt_dict_t ls_dict = xbt_dict_new();
59 surf_stat_t data = NULL;
60 xbt_dict_cursor_t cursor = NULL;
62 xbt_dynar_t dyn = NULL;
65 // foreach file int the storage
66 xbt_dict_foreach(((storage_t)storage)->content,cursor,key,data){
67 // Search if file start with the prefix 'path'
68 if(xbt_str_start_with(key,path)){
69 file = &key[strlen(path)];
71 // Split file with '/'
72 dyn = xbt_str_split(file,"/");
73 file = xbt_dynar_get_as(dyn,0,char*);
76 if(xbt_dynar_length(dyn) == 1){
77 xbt_dict_set(ls_dict,file,&(data->stat),NULL);
82 // if directory does not exist yet in dict
83 if(!xbt_dict_get_or_null(ls_dict,file))
84 xbt_dict_set(ls_dict,file,NULL,NULL);
90 action->ls_dict = ls_dict;
94 static surf_action_t storage_action_unlink(void *storage, surf_file_t stream)
96 surf_action_t action = storage_action_execute(storage,0, UNLINK);
98 // Add memory to storage
99 ((storage_t)storage)->used_size -= stream->content->stat.size;
101 // Remove the file from storage
102 xbt_dict_t content_dict = ((storage_t)storage)->content;
103 xbt_dict_remove(content_dict,stream->name);
106 stream->content = NULL;
112 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
114 XBT_DEBUG("\tOpen file '%s'",path);
115 xbt_dict_t content_dict = ((storage_t)storage)->content;
116 surf_stat_t content = xbt_dict_get_or_null(content_dict,path);
118 // if file does not exist create an empty file
120 content = xbt_new0(s_surf_stat_t,1);
121 content->stat.date = xbt_strdup("");
122 content->stat.group = xbt_strdup("");
123 content->stat.size = 0;
124 content->stat.time = xbt_strdup("");
125 content->stat.user = xbt_strdup("");
126 content->stat.user_rights = xbt_strdup("");
127 xbt_dict_set(content_dict,path,content,NULL);
128 XBT_DEBUG("File '%s' was not found, file created.",path);
130 surf_file_t file = xbt_new0(s_surf_file_t,1);
131 file->name = xbt_strdup(path);
132 file->content = content;
133 file->storage = mount;
135 surf_action_t action = storage_action_execute(storage,0, OPEN);
136 action->file = (void *)file;
140 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
142 char *filename = fp->name;
143 XBT_DEBUG("\tClose file '%s' size '%f'",filename,fp->content->stat.size);
144 // unref write actions from storage
145 surf_action_storage_t write_action;
147 xbt_dynar_foreach(((storage_t)storage)->write_actions,i,write_action) {
148 if ((write_action->generic_lmm_action.generic_action.file) == fp) {
149 xbt_dynar_cursor_rm(((storage_t)storage)->write_actions, &i);
150 storage_action_unref((surf_action_t) write_action);
157 surf_action_t action = storage_action_execute(storage,0, CLOSE);
161 static surf_action_t storage_action_read(void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream)
163 surf_stat_t content = stream->content;
164 if(size > content->stat.size)
165 size = content->stat.size;
166 surf_action_t action = storage_action_execute(storage,size,READ);
170 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
172 char *filename = stream->name;
173 surf_stat_t content = stream->content;
174 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
176 surf_action_t action = storage_action_execute(storage,size,WRITE);
177 action->file = stream;
179 // If the storage is full
180 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
181 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
186 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
188 surf_action_storage_t action = NULL;
189 storage_t STORAGE = storage;
191 XBT_IN("(%s,%f)", surf_resource_name(STORAGE), size);
193 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
194 STORAGE->state_current != SURF_RESOURCE_ON);
196 // Save the storage on action
197 action->storage = storage;
198 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
199 calloc but it seems to help valgrind... */
201 GENERIC_LMM_ACTION(action).variable =
202 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
204 // Must be less than the max bandwidth for all actions
205 lmm_expand(storage_maxmin_system, STORAGE->constraint,
206 GENERIC_LMM_ACTION(action).variable, 1.0);
216 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
217 GENERIC_LMM_ACTION(action).variable, 1.0);
220 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
221 GENERIC_LMM_ACTION(action).variable, 1.0);
222 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
223 surf_action_ref((surf_action_t) action);
228 return (surf_action_t) action;
231 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
233 storage_t storage = NULL;
235 xbt_assert(!surf_storage_resource_priv(surf_storage_resource_by_name(id)),
236 "Storage '%s' declared several times in the platform file",
238 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
239 surf_storage_model, id,NULL);
241 storage->state_current = SURF_RESOURCE_ON;
242 storage->used_size = 0;
244 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
246 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
247 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
248 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
249 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
250 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
251 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
252 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
253 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
254 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
255 storage->size = storage_type->size;
257 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
259 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",
263 storage_type->properties,
266 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),NULL);
267 xbt_dynar_push(storage_list,&storage);
272 static void storage_finalize(void)
274 lmm_system_free(storage_maxmin_system);
275 storage_maxmin_system = NULL;
277 surf_model_exit(surf_storage_model);
278 surf_storage_model = NULL;
281 xbt_dynar_free(&storage_list);
284 (storage_running_action_set_that_does_not_need_being_checked);
285 storage_running_action_set_that_does_not_need_being_checked = NULL;
288 static void storage_update_actions_state(double now, double delta)
290 surf_action_storage_t action = NULL;
291 surf_action_storage_t next_action = NULL;
292 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
294 // Update the disk usage
295 // Update the file size
296 // Foreach action of type write
297 xbt_swag_foreach_safe(action, next_action, running_actions) {
298 if(action->type == WRITE)
300 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
301 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
302 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
306 xbt_swag_foreach_safe(action, next_action, running_actions) {
308 double_update(&(GENERIC_ACTION(action).remains),
309 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
311 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
312 double_update(&(GENERIC_ACTION(action).max_duration), delta);
314 if(GENERIC_ACTION(action).remains > 0 &&
315 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
316 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
318 GENERIC_ACTION(action).finish = surf_get_clock();
319 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
320 } else if ((GENERIC_ACTION(action).remains <= 0) &&
321 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
323 GENERIC_ACTION(action).finish = surf_get_clock();
324 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
325 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
326 (GENERIC_ACTION(action).max_duration <= 0))
328 GENERIC_ACTION(action).finish = surf_get_clock();
329 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
336 static double storage_share_resources(double NOW)
338 XBT_DEBUG("storage_share_resources %f",NOW);
339 s_surf_action_storage_t action;
342 surf_action_storage_t write_action;
344 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
345 xbt_swag_offset(action, generic_lmm_action.variable),
346 storage_maxmin_system, lmm_solve);
350 xbt_dynar_foreach(storage_list,i,storage)
353 // Foreach write action on disk
354 xbt_dynar_foreach(storage->write_actions,j,write_action)
356 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
359 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
362 return min_completion;
365 static int storage_resource_used(void *resource_id)
371 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
372 double value, double time)
377 static int storage_action_unref(surf_action_t action)
380 if (!action->refcount) {
381 xbt_swag_remove(action, action->state_set);
382 if (((surf_action_lmm_t) action)->variable)
383 lmm_variable_free(storage_maxmin_system,
384 ((surf_action_lmm_t) action)->variable);
386 xbt_free(action->category);
388 surf_action_free(&action);
394 static void storage_action_cancel(surf_action_t action)
396 surf_action_state_set(action, SURF_ACTION_FAILED);
400 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
402 surf_action_state_set(action, state);
406 static void storage_action_suspend(surf_action_t action)
408 XBT_IN("(%p)", action);
409 if (((surf_action_lmm_t) action)->suspended != 2) {
410 lmm_update_variable_weight(storage_maxmin_system,
411 ((surf_action_lmm_t) action)->variable,
413 ((surf_action_lmm_t) action)->suspended = 1;
418 static void storage_action_resume(surf_action_t action)
423 static int storage_action_is_suspended(surf_action_t action)
425 return (((surf_action_lmm_t) action)->suspended == 1);
428 static void storage_action_set_max_duration(surf_action_t action, double duration)
433 static void storage_action_set_priority(surf_action_t action, double priority)
438 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
440 void* stype = xbt_lib_get_or_null(storage_type_lib,
442 ROUTING_STORAGE_TYPE_LEVEL);
443 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
445 // if storage content is not specified use the content of storage_type if exist
446 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
447 storage->content = ((storage_type_t) stype)->content;
448 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
451 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",
453 ((storage_type_t) stype)->model,
454 ((storage_type_t) stype)->type_id,
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,
464 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
466 XBT_DEBUG("parse_mstorage_init");
469 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
471 XBT_DEBUG("parse_storage_type_init");
474 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
476 XBT_DEBUG("parse_mount_init");
479 static void storage_define_callbacks()
481 sg_platf_storage_add_cb(parse_storage_init);
482 sg_platf_storage_type_add_cb(parse_storage_type_init);
483 sg_platf_mstorage_add_cb(parse_mstorage_init);
484 sg_platf_mount_add_cb(parse_mount_init);
487 static void surf_storage_model_init_internal(void)
489 s_surf_action_t action;
491 XBT_DEBUG("surf_storage_model_init_internal");
492 surf_storage_model = surf_model_init();
494 storage_running_action_set_that_does_not_need_being_checked =
495 xbt_swag_new(xbt_swag_offset(action, state_hookup));
497 surf_storage_model->name = "Storage";
498 surf_storage_model->action_unref = storage_action_unref;
499 surf_storage_model->action_cancel = storage_action_cancel;
500 surf_storage_model->action_state_set = storage_action_state_set;
502 surf_storage_model->model_private->finalize = storage_finalize;
503 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
504 surf_storage_model->model_private->share_resources = storage_share_resources;
505 surf_storage_model->model_private->resource_used = storage_resource_used;
506 surf_storage_model->model_private->update_resource_state = storage_resources_state;
508 surf_storage_model->suspend = storage_action_suspend;
509 surf_storage_model->resume = storage_action_resume;
510 surf_storage_model->is_suspended = storage_action_is_suspended;
511 surf_storage_model->set_max_duration = storage_action_set_max_duration;
512 surf_storage_model->set_priority = storage_action_set_priority;
514 surf_storage_model->extension.storage.open = storage_action_open;
515 surf_storage_model->extension.storage.close = storage_action_close;
516 surf_storage_model->extension.storage.read = storage_action_read;
517 surf_storage_model->extension.storage.write = storage_action_write;
518 surf_storage_model->extension.storage.stat = storage_action_stat;
519 surf_storage_model->extension.storage.unlink = storage_action_unlink;
520 surf_storage_model->extension.storage.ls = storage_action_ls;
522 if (!storage_maxmin_system) {
523 storage_maxmin_system = lmm_system_new(storage_selective_update);
528 void surf_storage_model_init_default(void)
530 surf_storage_model_init_internal();
531 storage_define_callbacks();
533 xbt_dynar_push(model_list, &surf_storage_model);
536 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
538 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
539 "Reading a storage, processing unit \"%s\" already exists", storage->id);
541 // Verification of an existing type_id
543 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
545 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
547 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
552 xbt_lib_set(storage_lib,
554 ROUTING_STORAGE_LEVEL,
555 (void *) xbt_strdup(storage->type_id));
558 static void free_storage_content(void *p)
560 surf_stat_t content = p;
561 free(content->stat.date);
562 free(content->stat.group);
563 free(content->stat.time);
564 free(content->stat.user);
565 free(content->stat.user_rights);
569 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
572 if ((!filename) || (strcmp(filename, "") == 0))
575 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
578 file = surf_fopen(filename, "r");
579 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
580 xbt_str_join(surf_path, ":"));
585 char user_rights[12];
596 while ((read = getline(&line, &len, file)) != -1) {
597 content = xbt_new0(s_surf_stat_t,1);
598 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
599 content->stat.date = xbt_strdup(date);
600 content->stat.group = xbt_strdup(group);
601 content->stat.size = size;
602 content->stat.time = xbt_strdup(time);
603 content->stat.user = xbt_strdup(user);
604 content->stat.user_rights = xbt_strdup(user_rights);
605 *used_size += content->stat.size;
606 xbt_dict_set(parse_content,path,content,NULL);
608 xbt_die("Be sure of passing a good format for content file.\n");
609 // You can generate this kind of file with command line:
610 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
616 return parse_content;
619 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
621 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
622 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
624 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
625 stype->model = xbt_strdup(storage_type->model);
626 stype->properties = storage_type->properties;
627 stype->content = xbt_strdup(storage_type->content);
628 stype->type_id = xbt_strdup(storage_type->id);
629 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
631 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
634 storage_type->content);
636 xbt_lib_set(storage_type_lib,
638 ROUTING_STORAGE_TYPE_LEVEL,
641 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
644 // mount_t mnt = xbt_new0(s_mount_t, 1);
645 // mnt->id = xbt_strdup(mstorage->type_id);
646 // mnt->name = xbt_strdup(mstorage->name);
649 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
650 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
652 // xbt_dynar_push(mount_list,(void *) mnt);
656 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
659 static void mount_free(void *p)
665 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
667 // Verification of an existing storage
669 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
671 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
673 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
676 mnt.id = surf_storage_resource_priv(surf_storage_resource_by_name(mount->id));
677 mnt.name = xbt_strdup(mount->name);
680 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
681 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
683 xbt_dynar_push(mount_list,&mnt);
686 static XBT_INLINE void routing_storage_type_free(void *r)
688 storage_type_t stype = r;
690 free(stype->type_id);
691 free(stype->content);
692 xbt_dict_free(&(stype->properties));
696 static XBT_INLINE void surf_storage_resource_free(void *r)
698 // specific to storage
699 storage_t storage = r;
700 xbt_dict_free(&storage->content);
701 xbt_dynar_free(&storage->write_actions);
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);