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_unlink(void *storage, surf_file_t stream)
52 surf_action_t action = storage_action_execute(storage,0, UNLINK);
54 // Add memory to storage
55 ((storage_t)storage)->used_size -= stream->content->stat.size;
57 // Remove the file from storage
58 xbt_dict_t content_dict = ((storage_t)storage)->content;
59 xbt_dict_remove(content_dict,stream->name);
62 stream->content = NULL;
68 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
70 XBT_DEBUG("\tOpen file '%s'",path);
71 xbt_dict_t content_dict = ((storage_t)storage)->content;
72 surf_stat_t content = xbt_dict_get_or_null(content_dict,path);
74 // if file does not exist create an empty file
76 content = xbt_new0(s_surf_stat_t,1);
77 content->stat.date = xbt_strdup("");
78 content->stat.group = xbt_strdup("");
79 content->stat.size = 0;
80 content->stat.time = xbt_strdup("");
81 content->stat.user = xbt_strdup("");
82 content->stat.user_rights = xbt_strdup("");
83 xbt_dict_set(content_dict,path,content,NULL);
84 XBT_DEBUG("File '%s' was not found, file created.",path);
86 surf_file_t file = xbt_new0(s_surf_file_t,1);
87 file->name = xbt_strdup(path);
88 file->content = content;
89 file->storage = mount;
91 surf_action_t action = storage_action_execute(storage,0, OPEN);
92 action->file = (void *)file;
96 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
98 char *filename = fp->name;
99 XBT_DEBUG("\tClose file '%s' size '%f'",filename,fp->content->stat.size);
103 surf_action_t action = storage_action_execute(storage,0, CLOSE);
107 static surf_action_t storage_action_read(void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream)
109 surf_stat_t content = stream->content;
110 if(size > content->stat.size)
111 size = content->stat.size;
112 surf_action_t action = storage_action_execute(storage,size,READ);
116 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
118 char *filename = stream->name;
119 surf_stat_t content = stream->content;
120 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
122 surf_action_t action = storage_action_execute(storage,size,WRITE);
123 action->file = stream;
125 // If the storage is full
126 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
127 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
132 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
134 surf_action_storage_t action = NULL;
135 storage_t STORAGE = storage;
137 XBT_IN("(%s,%f)", surf_resource_name(STORAGE), size);
139 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
140 STORAGE->state_current != SURF_RESOURCE_ON);
142 // Save the storage on action
143 action->storage = storage;
144 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
145 calloc but it seems to help valgrind... */
147 GENERIC_LMM_ACTION(action).variable =
148 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
150 // Must be less than the max bandwidth for all actions
151 lmm_expand(storage_maxmin_system, STORAGE->constraint,
152 GENERIC_LMM_ACTION(action).variable, 1.0);
161 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
162 GENERIC_LMM_ACTION(action).variable, 1.0);
165 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
166 GENERIC_LMM_ACTION(action).variable, 1.0);
167 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
172 return (surf_action_t) action;
175 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
177 storage_t storage = NULL;
179 xbt_assert(!surf_storage_resource_by_name(id),
180 "Storage '%s' declared several times in the platform file",
182 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
183 surf_storage_model, id,NULL);
185 storage->state_current = SURF_RESOURCE_ON;
186 storage->used_size = 0;
188 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
190 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
191 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
192 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
193 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
194 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
195 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
196 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
197 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
198 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
199 storage->size = storage_type->size;
201 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
203 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",
207 storage_type->properties,
210 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),NULL);
211 xbt_dynar_push(storage_list,&storage);
216 static void storage_finalize(void)
218 lmm_system_free(storage_maxmin_system);
219 storage_maxmin_system = NULL;
221 surf_model_exit(surf_storage_model);
222 surf_storage_model = NULL;
225 xbt_dynar_free(&storage_list);
228 (storage_running_action_set_that_does_not_need_being_checked);
229 storage_running_action_set_that_does_not_need_being_checked = NULL;
232 static void storage_update_actions_state(double now, double delta)
234 surf_action_storage_t action = NULL;
235 surf_action_storage_t next_action = NULL;
236 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
238 // Update the disk usage
239 // Update the file size
240 // Foreach action of type write
241 xbt_swag_foreach_safe(action, next_action, running_actions) {
242 if(action->type == WRITE)
244 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
245 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
246 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
250 xbt_swag_foreach_safe(action, next_action, running_actions) {
252 double_update(&(GENERIC_ACTION(action).remains),
253 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
255 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
256 double_update(&(GENERIC_ACTION(action).max_duration), delta);
258 if(GENERIC_ACTION(action).remains > 0 &&
259 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
260 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
262 GENERIC_ACTION(action).finish = surf_get_clock();
263 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
264 } else if ((GENERIC_ACTION(action).remains <= 0) &&
265 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
267 GENERIC_ACTION(action).finish = surf_get_clock();
268 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
269 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
270 (GENERIC_ACTION(action).max_duration <= 0))
272 GENERIC_ACTION(action).finish = surf_get_clock();
273 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
280 static double storage_share_resources(double NOW)
282 XBT_DEBUG("storage_share_resources %f",NOW);
283 s_surf_action_storage_t action;
286 surf_action_storage_t write_action;
288 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
289 xbt_swag_offset(action, generic_lmm_action.variable),
290 storage_maxmin_system, lmm_solve);
294 xbt_dynar_foreach(storage_list,i,storage)
297 // Foreach write action on disk
298 xbt_dynar_foreach(storage->write_actions,j,write_action)
300 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
303 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
306 return min_completion;
309 static int storage_resource_used(void *resource_id)
315 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
316 double value, double time)
321 static int storage_action_unref(surf_action_t action)
324 if (!action->refcount) {
325 xbt_swag_remove(action, action->state_set);
326 if (((surf_action_lmm_t) action)->variable)
327 lmm_variable_free(storage_maxmin_system,
328 ((surf_action_lmm_t) action)->variable);
330 xbt_free(action->category);
332 surf_action_free(&action);
338 static void storage_action_cancel(surf_action_t action)
340 surf_action_state_set(action, SURF_ACTION_FAILED);
344 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
346 surf_action_state_set(action, state);
350 static void storage_action_suspend(surf_action_t action)
352 XBT_IN("(%p)", action);
353 if (((surf_action_lmm_t) action)->suspended != 2) {
354 lmm_update_variable_weight(storage_maxmin_system,
355 ((surf_action_lmm_t) action)->variable,
357 ((surf_action_lmm_t) action)->suspended = 1;
362 static void storage_action_resume(surf_action_t action)
367 static int storage_action_is_suspended(surf_action_t action)
369 return (((surf_action_lmm_t) action)->suspended == 1);
372 static void storage_action_set_max_duration(surf_action_t action, double duration)
377 static void storage_action_set_priority(surf_action_t action, double priority)
382 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
384 void* stype = xbt_lib_get_or_null(storage_type_lib,
386 ROUTING_STORAGE_TYPE_LEVEL);
387 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
389 // if storage content is not specified use the content of storage_type if exist
390 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
391 storage->content = ((storage_type_t) stype)->content;
392 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
395 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",
397 ((storage_type_t) stype)->model,
398 ((storage_type_t) stype)->type_id,
400 ((storage_type_t) stype)->properties);
402 storage_create_resource(storage->id,
403 ((storage_type_t) stype)->model,
404 ((storage_type_t) stype)->type_id,
408 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
410 XBT_DEBUG("parse_mstorage_init");
413 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
415 XBT_DEBUG("parse_storage_type_init");
418 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
420 XBT_DEBUG("parse_mount_init");
423 static void storage_define_callbacks()
425 sg_platf_storage_add_cb(parse_storage_init);
426 sg_platf_storage_type_add_cb(parse_storage_type_init);
427 sg_platf_mstorage_add_cb(parse_mstorage_init);
428 sg_platf_mount_add_cb(parse_mount_init);
431 static void surf_storage_model_init_internal(void)
433 s_surf_action_t action;
435 XBT_DEBUG("surf_storage_model_init_internal");
436 surf_storage_model = surf_model_init();
438 storage_running_action_set_that_does_not_need_being_checked =
439 xbt_swag_new(xbt_swag_offset(action, state_hookup));
441 surf_storage_model->name = "Storage";
442 surf_storage_model->action_unref = storage_action_unref;
443 surf_storage_model->action_cancel = storage_action_cancel;
444 surf_storage_model->action_state_set = storage_action_state_set;
446 surf_storage_model->model_private->finalize = storage_finalize;
447 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
448 surf_storage_model->model_private->share_resources = storage_share_resources;
449 surf_storage_model->model_private->resource_used = storage_resource_used;
450 surf_storage_model->model_private->update_resource_state = storage_resources_state;
452 surf_storage_model->suspend = storage_action_suspend;
453 surf_storage_model->resume = storage_action_resume;
454 surf_storage_model->is_suspended = storage_action_is_suspended;
455 surf_storage_model->set_max_duration = storage_action_set_max_duration;
456 surf_storage_model->set_priority = storage_action_set_priority;
458 surf_storage_model->extension.storage.open = storage_action_open;
459 surf_storage_model->extension.storage.close = storage_action_close;
460 surf_storage_model->extension.storage.read = storage_action_read;
461 surf_storage_model->extension.storage.write = storage_action_write;
462 surf_storage_model->extension.storage.stat = storage_action_stat;
463 surf_storage_model->extension.storage.unlink = storage_action_unlink;
464 surf_storage_model->extension.storage.create_resource = storage_create_resource;
466 if (!storage_maxmin_system) {
467 storage_maxmin_system = lmm_system_new(storage_selective_update);
472 void surf_storage_model_init_default(void)
474 surf_storage_model_init_internal();
475 storage_define_callbacks();
477 xbt_dynar_push(model_list, &surf_storage_model);
480 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
482 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
483 "Reading a storage, processing unit \"%s\" already exists", storage->id);
485 // Verification of an existing type_id
487 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
489 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
491 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
496 xbt_lib_set(storage_lib,
498 ROUTING_STORAGE_LEVEL,
499 (void *) xbt_strdup(storage->type_id));
502 static void free_storage_content(void *p)
504 surf_stat_t content = p;
505 free(content->stat.date);
506 free(content->stat.group);
507 free(content->stat.time);
508 free(content->stat.user);
509 free(content->stat.user_rights);
513 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
516 if ((!filename) || (strcmp(filename, "") == 0))
519 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
522 file = surf_fopen(filename, "r");
523 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
524 xbt_str_join(surf_path, ":"));
529 char user_rights[12];
540 while ((read = getline(&line, &len, file)) != -1) {
541 content = xbt_new0(s_surf_stat_t,1);
542 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
543 content->stat.date = xbt_strdup(date);
544 content->stat.group = xbt_strdup(group);
545 content->stat.size = size;
546 content->stat.time = xbt_strdup(time);
547 content->stat.user = xbt_strdup(user);
548 content->stat.user_rights = xbt_strdup(user_rights);
549 *used_size += content->stat.size;
550 xbt_dict_set(parse_content,path,content,NULL);
552 xbt_die("Be sure of passing a good format for content file.\n");
553 // You can generate this kind of file with command line:
554 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
560 return parse_content;
563 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
565 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
566 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
568 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
569 stype->model = xbt_strdup(storage_type->model);
570 stype->properties = storage_type->properties;
571 stype->content = xbt_strdup(storage_type->content);
572 stype->type_id = xbt_strdup(storage_type->id);
573 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
575 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
578 storage_type->content);
580 xbt_lib_set(storage_type_lib,
582 ROUTING_STORAGE_TYPE_LEVEL,
585 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
588 // mount_t mnt = xbt_new0(s_mount_t, 1);
589 // mnt->id = xbt_strdup(mstorage->type_id);
590 // mnt->name = xbt_strdup(mstorage->name);
593 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
594 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
596 // xbt_dynar_push(mount_list,(void *) mnt);
600 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
603 static void mount_free(void *p)
609 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
611 // Verification of an existing storage
613 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
615 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
617 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
620 mnt.id = surf_storage_resource_by_name(mount->id);
621 mnt.name = xbt_strdup(mount->name);
624 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
625 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
627 xbt_dynar_push(mount_list,&mnt);
630 static XBT_INLINE void routing_storage_type_free(void *r)
632 storage_type_t stype = r;
634 free(stype->type_id);
635 free(stype->content);
636 xbt_dict_free(&(stype->properties));
640 static XBT_INLINE void surf_storage_resource_free(void *r)
642 // specific to storage
643 storage_t storage = r;
644 xbt_dict_free(&storage->content);
645 xbt_dynar_free(&storage->write_actions);
647 surf_resource_free(r);
650 static XBT_INLINE void routing_storage_host_free(void *r)
653 xbt_dynar_free(&dyn);
656 void storage_register_callbacks() {
658 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
659 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
660 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
661 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
663 sg_platf_storage_add_cb(storage_parse_storage);
664 sg_platf_mstorage_add_cb(storage_parse_mstorage);
665 sg_platf_storage_type_add_cb(storage_parse_storage_type);
666 sg_platf_mount_add_cb(storage_parse_mount);