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(content_dict,path);
56 surf_file_t file = xbt_new0(s_surf_file_t,1);
57 file->name = xbt_strdup(path);
58 file->content = content;
59 file->storage = mount;
61 surf_action_t action = storage_action_execute(storage,0, OPEN);
62 action->file = (void *)file;
66 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
68 char *filename = fp->name;
69 XBT_DEBUG("\tClose file '%s' size '%f'",filename,fp->content->stat.size);
73 surf_action_t action = storage_action_execute(storage,0, CLOSE);
77 static surf_action_t storage_action_read(void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream)
79 surf_stat_t content = stream->content;
80 if(size > content->stat.size)
81 size = content->stat.size;
82 surf_action_t action = storage_action_execute(storage,size,READ);
86 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
88 char *filename = stream->name;
89 surf_stat_t content = stream->content;
90 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
92 surf_action_t action = storage_action_execute(storage,size,WRITE);
93 action->file = stream;
95 // If the storage is full
96 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
97 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
102 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
104 surf_action_storage_t action = NULL;
105 storage_t STORAGE = storage;
107 XBT_IN("(%s,%f)", surf_resource_name(STORAGE), size);
109 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
110 STORAGE->state_current != SURF_RESOURCE_ON);
112 // Save the storage on action
113 action->storage = storage;
114 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
115 calloc but it seems to help valgrind... */
117 GENERIC_LMM_ACTION(action).variable =
118 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
120 // Must be less than the max bandwidth for all actions
121 lmm_expand(storage_maxmin_system, STORAGE->constraint,
122 GENERIC_LMM_ACTION(action).variable, 1.0);
130 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
131 GENERIC_LMM_ACTION(action).variable, 1.0);
134 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
135 GENERIC_LMM_ACTION(action).variable, 1.0);
136 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
142 return (surf_action_t) action;
145 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
147 storage_t storage = NULL;
149 xbt_assert(!surf_storage_resource_by_name(id),
150 "Storage '%s' declared several times in the platform file",
152 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
153 surf_storage_model, id,NULL);
155 storage->state_current = SURF_RESOURCE_ON;
156 storage->used_size = 0;
158 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
160 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
161 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
162 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
163 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
164 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
165 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
166 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
167 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
168 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
169 storage->size = storage_type->size;
171 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
173 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",
177 storage_type->properties,
180 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),free);
181 xbt_dynar_push(storage_list,&storage);
186 static void storage_finalize(void)
188 lmm_system_free(storage_maxmin_system);
189 storage_maxmin_system = NULL;
191 surf_model_exit(surf_storage_model);
192 surf_storage_model = NULL;
195 (storage_running_action_set_that_does_not_need_being_checked);
196 storage_running_action_set_that_does_not_need_being_checked = NULL;
199 static void storage_update_actions_state(double now, double delta)
201 surf_action_storage_t action = NULL;
202 surf_action_storage_t next_action = NULL;
203 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
205 // Update the disk usage
206 // Update the file size
207 // Foreach action of type write
208 xbt_swag_foreach_safe(action, next_action, running_actions) {
209 if(action->type == WRITE)
211 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
212 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
213 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
217 xbt_swag_foreach_safe(action, next_action, running_actions) {
219 double_update(&(GENERIC_ACTION(action).remains),
220 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
222 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
223 double_update(&(GENERIC_ACTION(action).max_duration), delta);
225 if(GENERIC_ACTION(action).remains > 0 &&
226 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
227 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
229 GENERIC_ACTION(action).finish = surf_get_clock();
230 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
231 } else if ((GENERIC_ACTION(action).remains <= 0) &&
232 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
234 GENERIC_ACTION(action).finish = surf_get_clock();
235 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
236 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
237 (GENERIC_ACTION(action).max_duration <= 0))
239 GENERIC_ACTION(action).finish = surf_get_clock();
240 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
247 static double storage_share_resources(double NOW)
249 XBT_DEBUG("storage_share_resources %f",NOW);
250 s_surf_action_storage_t action;
253 surf_action_storage_t write_action;
255 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
256 xbt_swag_offset(action, generic_lmm_action.variable),
257 storage_maxmin_system, lmm_solve);
261 xbt_dynar_foreach(storage_list,i,storage)
264 // Foreach write action on disk
265 xbt_dynar_foreach(storage->write_actions,j,write_action)
267 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
270 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
273 return min_completion;
276 static int storage_resource_used(void *resource_id)
282 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
283 double value, double time)
288 static int storage_action_unref(surf_action_t action)
291 if (!action->refcount) {
292 xbt_swag_remove(action, action->state_set);
293 if (((surf_action_lmm_t) action)->variable)
294 lmm_variable_free(storage_maxmin_system,
295 ((surf_action_lmm_t) action)->variable);
297 xbt_free(action->category);
299 surf_action_free(&action);
305 static void storage_action_cancel(surf_action_t action)
307 surf_action_state_set(action, SURF_ACTION_FAILED);
311 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
313 surf_action_state_set(action, state);
317 static void storage_action_suspend(surf_action_t action)
319 XBT_IN("(%p)", action);
320 if (((surf_action_lmm_t) action)->suspended != 2) {
321 lmm_update_variable_weight(storage_maxmin_system,
322 ((surf_action_lmm_t) action)->variable,
324 ((surf_action_lmm_t) action)->suspended = 1;
329 static void storage_action_resume(surf_action_t action)
334 static int storage_action_is_suspended(surf_action_t action)
336 return (((surf_action_lmm_t) action)->suspended == 1);
339 static void storage_action_set_max_duration(surf_action_t action, double duration)
344 static void storage_action_set_priority(surf_action_t action, double priority)
349 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
351 void* stype = xbt_lib_get_or_null(storage_type_lib,
353 ROUTING_STORAGE_TYPE_LEVEL);
354 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
356 // if storage content is not specified use the content of storage_type if exist
357 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
358 storage->content = ((storage_type_t) stype)->content;
359 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
362 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",
364 ((storage_type_t) stype)->model,
365 ((storage_type_t) stype)->type_id,
367 ((storage_type_t) stype)->properties);
369 storage_create_resource(storage->id,
370 ((storage_type_t) stype)->model,
371 ((storage_type_t) stype)->type_id,
375 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
377 XBT_DEBUG("parse_mstorage_init");
380 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
382 XBT_DEBUG("parse_storage_type_init");
385 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
387 XBT_DEBUG("parse_mount_init");
390 static void storage_define_callbacks()
392 sg_platf_storage_add_cb(parse_storage_init);
393 sg_platf_storage_type_add_cb(parse_storage_type_init);
394 sg_platf_mstorage_add_cb(parse_mstorage_init);
395 sg_platf_mount_add_cb(parse_mount_init);
398 static void surf_storage_model_init_internal(void)
400 s_surf_action_t action;
402 XBT_DEBUG("surf_storage_model_init_internal");
403 surf_storage_model = surf_model_init();
405 storage_running_action_set_that_does_not_need_being_checked =
406 xbt_swag_new(xbt_swag_offset(action, state_hookup));
408 surf_storage_model->name = "Storage";
409 surf_storage_model->action_unref = storage_action_unref;
410 surf_storage_model->action_cancel = storage_action_cancel;
411 surf_storage_model->action_state_set = storage_action_state_set;
413 surf_storage_model->model_private->finalize = storage_finalize;
414 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
415 surf_storage_model->model_private->share_resources = storage_share_resources;
416 surf_storage_model->model_private->resource_used = storage_resource_used;
417 surf_storage_model->model_private->update_resource_state = storage_resources_state;
419 surf_storage_model->suspend = storage_action_suspend;
420 surf_storage_model->resume = storage_action_resume;
421 surf_storage_model->is_suspended = storage_action_is_suspended;
422 surf_storage_model->set_max_duration = storage_action_set_max_duration;
423 surf_storage_model->set_priority = storage_action_set_priority;
425 surf_storage_model->extension.storage.open = storage_action_open;
426 surf_storage_model->extension.storage.close = storage_action_close;
427 surf_storage_model->extension.storage.read = storage_action_read;
428 surf_storage_model->extension.storage.write = storage_action_write;
429 surf_storage_model->extension.storage.stat = storage_action_stat;
430 surf_storage_model->extension.storage.create_resource = storage_create_resource;
432 if (!storage_maxmin_system) {
433 storage_maxmin_system = lmm_system_new(storage_selective_update);
438 void surf_storage_model_init_default(void)
440 surf_storage_model_init_internal();
441 storage_define_callbacks();
443 xbt_dynar_push(model_list, &surf_storage_model);
446 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
448 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
449 "Reading a storage, processing unit \"%s\" already exists", storage->id);
451 // Verification of an existing type_id
453 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
455 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
457 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
462 xbt_lib_set(storage_lib,
464 ROUTING_STORAGE_LEVEL,
465 (void *) xbt_strdup(storage->type_id));
468 static void free_storage_content(void *p)
470 surf_stat_t content = p;
471 free(content->stat.date);
472 free(content->stat.group);
473 free(content->stat.time);
474 free(content->stat.user);
475 free(content->stat.user_rights);
479 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
482 if ((!filename) || (strcmp(filename, "") == 0))
485 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
488 file = surf_fopen(filename, "r");
489 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
490 xbt_str_join(surf_path, ":"));
495 char user_rights[12];
506 while ((read = getline(&line, &len, file)) != -1) {
507 content = xbt_new0(s_surf_stat_t,1);
508 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
509 content->stat.date = xbt_strdup(date);
510 content->stat.group = xbt_strdup(group);
511 content->stat.size = size;
512 content->stat.time = xbt_strdup(time);
513 content->stat.user = xbt_strdup(user);
514 content->stat.user_rights = xbt_strdup(user_rights);
515 *used_size += content->stat.size;
516 xbt_dict_set(parse_content,path,content,NULL);
518 xbt_die("Be sure of passing a good format for content file.\n");
519 // You can generate this kind of file with command line:
520 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
526 return parse_content;
529 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
531 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
532 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
534 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
535 stype->model = xbt_strdup(storage_type->model);
536 stype->properties = storage_type->properties;
537 stype->content = xbt_strdup(storage_type->content);
538 stype->type_id = xbt_strdup(storage_type->id);
539 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
541 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
544 storage_type->content);
546 xbt_lib_set(storage_type_lib,
548 ROUTING_STORAGE_TYPE_LEVEL,
551 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
554 // mount_t mnt = xbt_new0(s_mount_t, 1);
555 // mnt->id = xbt_strdup(mstorage->type_id);
556 // mnt->name = xbt_strdup(mstorage->name);
559 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
560 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
562 // xbt_dynar_push(mount_list,(void *) mnt);
566 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
569 static void mount_free(void *p)
575 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
577 // Verification of an existing storage
579 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
581 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
583 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
586 mnt.id = surf_storage_resource_by_name(mount->id);
587 mnt.name = xbt_strdup(mount->name);
590 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
591 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
593 xbt_dynar_push(mount_list,&mnt);
596 static XBT_INLINE void routing_storage_type_free(void *r)
598 storage_type_t stype = r;
600 free(stype->type_id);
601 free(stype->content);
602 xbt_dict_free(&(stype->properties));
606 static XBT_INLINE void surf_storage_resource_free(void *r)
608 // specific to storage
609 storage_t storage = r;
610 xbt_dict_free(&storage->content);
612 surf_resource_free(r);
615 static XBT_INLINE void routing_storage_host_free(void *r)
618 xbt_dynar_free(&dyn);
621 void storage_register_callbacks() {
623 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
624 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
625 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
626 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
628 sg_platf_storage_add_cb(storage_parse_storage);
629 sg_platf_mstorage_add_cb(storage_parse_mstorage);
630 sg_platf_storage_type_add_cb(storage_parse_storage_type);
631 sg_platf_mount_add_cb(storage_parse_mount);