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);
41 static void free_storage_content(void *p);
43 static surf_action_t storage_action_stat(void *storage, surf_file_t stream)
45 surf_action_t action = storage_action_execute(storage,0, STAT);
46 action->file = stream;
47 action->stat = stream->content->stat;
51 static surf_action_t storage_action_ls(void *storage, const char* path)
53 surf_action_t action = storage_action_execute(storage,0, LS);
54 action->ls_dict = NULL;
55 xbt_dict_t ls_dict = xbt_dict_new();
58 surf_stat_t data = NULL;
59 xbt_dict_cursor_t cursor = NULL;
61 xbt_dynar_t dyn = NULL;
64 // foreach file int the storage
65 xbt_dict_foreach(((storage_t)storage)->content,cursor,key,data){
66 // Search if file start with the prefix 'path'
67 if(xbt_str_start_with(key,path)){
68 file = &key[strlen(path)];
70 // Split file with '/'
71 dyn = xbt_str_split(file,"/");
72 file = xbt_dynar_get_as(dyn,0,char*);
75 if(xbt_dynar_length(dyn) == 1){
76 xbt_dict_set(ls_dict,file,&(data->stat),NULL);
81 // if directory does not exist yet in dict
82 if(!xbt_dict_get_or_null(ls_dict,file));
83 xbt_dict_set(ls_dict,file,NULL,NULL);
89 action->ls_dict = ls_dict;
93 static surf_action_t storage_action_unlink(void *storage, surf_file_t stream)
95 surf_action_t action = storage_action_execute(storage,0, UNLINK);
97 // Add memory to storage
98 ((storage_t)storage)->used_size -= stream->content->stat.size;
100 // Remove the file from storage
101 xbt_dict_t content_dict = ((storage_t)storage)->content;
102 xbt_dict_remove(content_dict,stream->name);
105 stream->content = NULL;
111 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
113 XBT_DEBUG("\tOpen file '%s'",path);
114 xbt_dict_t content_dict = ((storage_t)storage)->content;
115 surf_stat_t content = xbt_dict_get_or_null(content_dict,path);
117 // if file does not exist create an empty file
119 content = xbt_new0(s_surf_stat_t,1);
120 content->stat.date = xbt_strdup("");
121 content->stat.group = xbt_strdup("");
122 content->stat.size = 0;
123 content->stat.time = xbt_strdup("");
124 content->stat.user = xbt_strdup("");
125 content->stat.user_rights = xbt_strdup("");
126 xbt_dict_set(content_dict,path,content,NULL);
127 XBT_DEBUG("File '%s' was not found, file created.",path);
129 surf_file_t file = xbt_new0(s_surf_file_t,1);
130 file->name = xbt_strdup(path);
131 file->content = content;
132 file->storage = mount;
134 surf_action_t action = storage_action_execute(storage,0, OPEN);
135 action->file = (void *)file;
139 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
141 char *filename = fp->name;
142 XBT_DEBUG("\tClose file '%s' size '%f'",filename,fp->content->stat.size);
146 surf_action_t action = storage_action_execute(storage,0, CLOSE);
150 static surf_action_t storage_action_read(void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream)
152 surf_stat_t content = stream->content;
153 if(size > content->stat.size)
154 size = content->stat.size;
155 surf_action_t action = storage_action_execute(storage,size,READ);
159 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
161 char *filename = stream->name;
162 surf_stat_t content = stream->content;
163 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
165 surf_action_t action = storage_action_execute(storage,size,WRITE);
166 action->file = stream;
168 // If the storage is full
169 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
170 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
175 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
177 surf_action_storage_t action = NULL;
178 storage_t STORAGE = storage;
180 XBT_IN("(%s,%f)", surf_resource_name(STORAGE), size);
182 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
183 STORAGE->state_current != SURF_RESOURCE_ON);
185 // Save the storage on action
186 action->storage = storage;
187 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
188 calloc but it seems to help valgrind... */
190 GENERIC_LMM_ACTION(action).variable =
191 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
193 // Must be less than the max bandwidth for all actions
194 lmm_expand(storage_maxmin_system, STORAGE->constraint,
195 GENERIC_LMM_ACTION(action).variable, 1.0);
205 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
206 GENERIC_LMM_ACTION(action).variable, 1.0);
209 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
210 GENERIC_LMM_ACTION(action).variable, 1.0);
211 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
216 return (surf_action_t) action;
219 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
221 storage_t storage = NULL;
223 xbt_assert(!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,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);
235 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
236 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
237 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
238 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
239 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
240 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
241 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
242 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
243 storage->size = storage_type->size;
245 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
247 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",
251 storage_type->properties,
254 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),NULL);
255 xbt_dynar_push(storage_list,&storage);
260 static void storage_finalize(void)
262 lmm_system_free(storage_maxmin_system);
263 storage_maxmin_system = NULL;
265 surf_model_exit(surf_storage_model);
266 surf_storage_model = NULL;
269 xbt_dynar_free(&storage_list);
272 (storage_running_action_set_that_does_not_need_being_checked);
273 storage_running_action_set_that_does_not_need_being_checked = NULL;
276 static void storage_update_actions_state(double now, double delta)
278 surf_action_storage_t action = NULL;
279 surf_action_storage_t next_action = NULL;
280 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
282 // Update the disk usage
283 // Update the file size
284 // Foreach action of type write
285 xbt_swag_foreach_safe(action, next_action, running_actions) {
286 if(action->type == WRITE)
288 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
289 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
290 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
294 xbt_swag_foreach_safe(action, next_action, running_actions) {
296 double_update(&(GENERIC_ACTION(action).remains),
297 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
299 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
300 double_update(&(GENERIC_ACTION(action).max_duration), delta);
302 if(GENERIC_ACTION(action).remains > 0 &&
303 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
304 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
306 GENERIC_ACTION(action).finish = surf_get_clock();
307 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
308 } else if ((GENERIC_ACTION(action).remains <= 0) &&
309 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
311 GENERIC_ACTION(action).finish = surf_get_clock();
312 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
313 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
314 (GENERIC_ACTION(action).max_duration <= 0))
316 GENERIC_ACTION(action).finish = surf_get_clock();
317 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
324 static double storage_share_resources(double NOW)
326 XBT_DEBUG("storage_share_resources %f",NOW);
327 s_surf_action_storage_t action;
330 surf_action_storage_t write_action;
332 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
333 xbt_swag_offset(action, generic_lmm_action.variable),
334 storage_maxmin_system, lmm_solve);
338 xbt_dynar_foreach(storage_list,i,storage)
341 // Foreach write action on disk
342 xbt_dynar_foreach(storage->write_actions,j,write_action)
344 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
347 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
350 return min_completion;
353 static int storage_resource_used(void *resource_id)
359 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
360 double value, double time)
365 static int storage_action_unref(surf_action_t action)
368 if (!action->refcount) {
369 xbt_swag_remove(action, action->state_set);
370 if (((surf_action_lmm_t) action)->variable)
371 lmm_variable_free(storage_maxmin_system,
372 ((surf_action_lmm_t) action)->variable);
374 xbt_free(action->category);
376 surf_action_free(&action);
382 static void storage_action_cancel(surf_action_t action)
384 surf_action_state_set(action, SURF_ACTION_FAILED);
388 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
390 surf_action_state_set(action, state);
394 static void storage_action_suspend(surf_action_t action)
396 XBT_IN("(%p)", action);
397 if (((surf_action_lmm_t) action)->suspended != 2) {
398 lmm_update_variable_weight(storage_maxmin_system,
399 ((surf_action_lmm_t) action)->variable,
401 ((surf_action_lmm_t) action)->suspended = 1;
406 static void storage_action_resume(surf_action_t action)
411 static int storage_action_is_suspended(surf_action_t action)
413 return (((surf_action_lmm_t) action)->suspended == 1);
416 static void storage_action_set_max_duration(surf_action_t action, double duration)
421 static void storage_action_set_priority(surf_action_t action, double priority)
426 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
428 void* stype = xbt_lib_get_or_null(storage_type_lib,
430 ROUTING_STORAGE_TYPE_LEVEL);
431 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
433 // if storage content is not specified use the content of storage_type if exist
434 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
435 storage->content = ((storage_type_t) stype)->content;
436 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
439 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",
441 ((storage_type_t) stype)->model,
442 ((storage_type_t) stype)->type_id,
444 ((storage_type_t) stype)->properties);
446 storage_create_resource(storage->id,
447 ((storage_type_t) stype)->model,
448 ((storage_type_t) stype)->type_id,
452 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
454 XBT_DEBUG("parse_mstorage_init");
457 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
459 XBT_DEBUG("parse_storage_type_init");
462 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
464 XBT_DEBUG("parse_mount_init");
467 static void storage_define_callbacks()
469 sg_platf_storage_add_cb(parse_storage_init);
470 sg_platf_storage_type_add_cb(parse_storage_type_init);
471 sg_platf_mstorage_add_cb(parse_mstorage_init);
472 sg_platf_mount_add_cb(parse_mount_init);
475 static void surf_storage_model_init_internal(void)
477 s_surf_action_t action;
479 XBT_DEBUG("surf_storage_model_init_internal");
480 surf_storage_model = surf_model_init();
482 storage_running_action_set_that_does_not_need_being_checked =
483 xbt_swag_new(xbt_swag_offset(action, state_hookup));
485 surf_storage_model->name = "Storage";
486 surf_storage_model->action_unref = storage_action_unref;
487 surf_storage_model->action_cancel = storage_action_cancel;
488 surf_storage_model->action_state_set = storage_action_state_set;
490 surf_storage_model->model_private->finalize = storage_finalize;
491 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
492 surf_storage_model->model_private->share_resources = storage_share_resources;
493 surf_storage_model->model_private->resource_used = storage_resource_used;
494 surf_storage_model->model_private->update_resource_state = storage_resources_state;
496 surf_storage_model->suspend = storage_action_suspend;
497 surf_storage_model->resume = storage_action_resume;
498 surf_storage_model->is_suspended = storage_action_is_suspended;
499 surf_storage_model->set_max_duration = storage_action_set_max_duration;
500 surf_storage_model->set_priority = storage_action_set_priority;
502 surf_storage_model->extension.storage.open = storage_action_open;
503 surf_storage_model->extension.storage.close = storage_action_close;
504 surf_storage_model->extension.storage.read = storage_action_read;
505 surf_storage_model->extension.storage.write = storage_action_write;
506 surf_storage_model->extension.storage.stat = storage_action_stat;
507 surf_storage_model->extension.storage.unlink = storage_action_unlink;
508 surf_storage_model->extension.storage.ls = storage_action_ls;
509 surf_storage_model->extension.storage.create_resource = storage_create_resource;
511 if (!storage_maxmin_system) {
512 storage_maxmin_system = lmm_system_new(storage_selective_update);
517 void surf_storage_model_init_default(void)
519 surf_storage_model_init_internal();
520 storage_define_callbacks();
522 xbt_dynar_push(model_list, &surf_storage_model);
525 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
527 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
528 "Reading a storage, processing unit \"%s\" already exists", storage->id);
530 // Verification of an existing type_id
532 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
534 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
536 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
541 xbt_lib_set(storage_lib,
543 ROUTING_STORAGE_LEVEL,
544 (void *) xbt_strdup(storage->type_id));
547 static void free_storage_content(void *p)
549 surf_stat_t content = p;
550 free(content->stat.date);
551 free(content->stat.group);
552 free(content->stat.time);
553 free(content->stat.user);
554 free(content->stat.user_rights);
558 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
561 if ((!filename) || (strcmp(filename, "") == 0))
564 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
567 file = surf_fopen(filename, "r");
568 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
569 xbt_str_join(surf_path, ":"));
574 char user_rights[12];
585 while ((read = getline(&line, &len, file)) != -1) {
586 content = xbt_new0(s_surf_stat_t,1);
587 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
588 content->stat.date = xbt_strdup(date);
589 content->stat.group = xbt_strdup(group);
590 content->stat.size = size;
591 content->stat.time = xbt_strdup(time);
592 content->stat.user = xbt_strdup(user);
593 content->stat.user_rights = xbt_strdup(user_rights);
594 *used_size += content->stat.size;
595 xbt_dict_set(parse_content,path,content,NULL);
597 xbt_die("Be sure of passing a good format for content file.\n");
598 // You can generate this kind of file with command line:
599 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
605 return parse_content;
608 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
610 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
611 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
613 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
614 stype->model = xbt_strdup(storage_type->model);
615 stype->properties = storage_type->properties;
616 stype->content = xbt_strdup(storage_type->content);
617 stype->type_id = xbt_strdup(storage_type->id);
618 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
620 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
623 storage_type->content);
625 xbt_lib_set(storage_type_lib,
627 ROUTING_STORAGE_TYPE_LEVEL,
630 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
633 // mount_t mnt = xbt_new0(s_mount_t, 1);
634 // mnt->id = xbt_strdup(mstorage->type_id);
635 // mnt->name = xbt_strdup(mstorage->name);
638 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
639 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
641 // xbt_dynar_push(mount_list,(void *) mnt);
645 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
648 static void mount_free(void *p)
654 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
656 // Verification of an existing storage
658 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
660 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
662 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
665 mnt.id = surf_storage_resource_by_name(mount->id);
666 mnt.name = xbt_strdup(mount->name);
669 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
670 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
672 xbt_dynar_push(mount_list,&mnt);
675 static XBT_INLINE void routing_storage_type_free(void *r)
677 storage_type_t stype = r;
679 free(stype->type_id);
680 free(stype->content);
681 xbt_dict_free(&(stype->properties));
685 static XBT_INLINE void surf_storage_resource_free(void *r)
687 // specific to storage
688 storage_t storage = r;
689 xbt_dict_free(&storage->content);
690 xbt_dynar_free(&storage->write_actions);
692 surf_resource_free(r);
695 static XBT_INLINE void routing_storage_host_free(void *r)
698 xbt_dynar_free(&dyn);
701 void storage_register_callbacks() {
703 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
704 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
705 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
706 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
708 sg_platf_storage_add_cb(storage_parse_storage);
709 sg_platf_mstorage_add_cb(storage_parse_mstorage);
710 sg_platf_storage_type_add_cb(storage_parse_storage_type);
711 sg_platf_mount_add_cb(storage_parse_mount);