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 char *filename = stream->name;
80 surf_stat_t content = stream->content;
81 XBT_INFO("\tRead file '%s' size '%f/%f'",filename,content->stat.size,size);
82 if(size > content->stat.size)
83 size = content->stat.size;
84 XBT_INFO("Really read file '%s' for %f",filename,size);
85 surf_action_t action = storage_action_execute(storage,size,READ);
89 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
91 char *filename = stream->name;
92 surf_stat_t content = stream->content;
93 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
95 surf_action_t action = storage_action_execute(storage,size,WRITE);
96 action->file = stream;
98 // If the storage is full
99 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
100 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
105 static surf_action_t storage_action_execute (void *storage, double size, e_surf_action_storage_type_t type)
107 surf_action_storage_t action = NULL;
108 storage_t STORAGE = storage;
110 XBT_IN("(%s,%f)", surf_resource_name(STORAGE), size);
112 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
113 STORAGE->state_current != SURF_RESOURCE_ON);
115 // Save the storage on action
116 action->storage = storage;
117 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
118 calloc but it seems to help valgrind... */
120 GENERIC_LMM_ACTION(action).variable =
121 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
123 // Must be less than the max bandwidth for all actions
124 lmm_expand(storage_maxmin_system, STORAGE->constraint,
125 GENERIC_LMM_ACTION(action).variable, 1.0);
133 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
134 GENERIC_LMM_ACTION(action).variable, 1.0);
137 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
138 GENERIC_LMM_ACTION(action).variable, 1.0);
139 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
145 return (surf_action_t) action;
148 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
150 storage_t storage = NULL;
152 xbt_assert(!surf_storage_resource_by_name(id),
153 "Storage '%s' declared several times in the platform file",
155 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
156 surf_storage_model, id,NULL);
158 storage->state_current = SURF_RESOURCE_ON;
159 storage->used_size = 0;
161 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
163 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
164 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
165 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
166 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
167 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
168 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
169 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
170 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
171 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
172 storage->size = storage_type->size;
174 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
176 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",
180 storage_type->properties,
183 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),free);
184 xbt_dynar_push(storage_list,&storage);
189 static void storage_finalize(void)
191 lmm_system_free(storage_maxmin_system);
192 storage_maxmin_system = NULL;
194 surf_model_exit(surf_storage_model);
195 surf_storage_model = NULL;
198 (storage_running_action_set_that_does_not_need_being_checked);
199 storage_running_action_set_that_does_not_need_being_checked = NULL;
202 static void storage_update_actions_state(double now, double delta)
204 surf_action_storage_t action = NULL;
205 surf_action_storage_t next_action = NULL;
206 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
208 // Update the disk usage
209 // Update the file size
210 // Foreach action of type write
211 xbt_swag_foreach_safe(action, next_action, running_actions) {
212 if(action->type == WRITE)
214 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
215 XBT_INFO("Update %f + %f = %f",((surf_action_t)action)->file->content->stat.size,delta * rate,((surf_action_t)action)->file->content->stat.size+delta * rate);
216 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
217 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
218 XBT_INFO("Have updating to %f",((surf_action_t)action)->file->content->stat.size);
222 xbt_swag_foreach_safe(action, next_action, running_actions) {
224 double_update(&(GENERIC_ACTION(action).remains),
225 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
227 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
228 double_update(&(GENERIC_ACTION(action).max_duration), delta);
230 if(GENERIC_ACTION(action).remains > 0 &&
231 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
232 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
234 GENERIC_ACTION(action).finish = surf_get_clock();
235 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
236 } else if ((GENERIC_ACTION(action).remains <= 0) &&
237 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
239 GENERIC_ACTION(action).finish = surf_get_clock();
240 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
241 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
242 (GENERIC_ACTION(action).max_duration <= 0))
244 GENERIC_ACTION(action).finish = surf_get_clock();
245 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
252 static double storage_share_resources(double NOW)
254 XBT_DEBUG("storage_share_resources %f",NOW);
255 s_surf_action_storage_t action;
258 surf_action_storage_t write_action;
260 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
261 xbt_swag_offset(action, generic_lmm_action.variable),
262 storage_maxmin_system, lmm_solve);
266 xbt_dynar_foreach(storage_list,i,storage)
269 // Foreach write action on disk
270 xbt_dynar_foreach(storage->write_actions,j,write_action)
272 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
275 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
278 return min_completion;
281 static int storage_resource_used(void *resource_id)
287 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
288 double value, double time)
293 static int storage_action_unref(surf_action_t action)
296 if (!action->refcount) {
297 xbt_swag_remove(action, action->state_set);
298 if (((surf_action_lmm_t) action)->variable)
299 lmm_variable_free(storage_maxmin_system,
300 ((surf_action_lmm_t) action)->variable);
302 xbt_free(action->category);
304 surf_action_free(&action);
310 static void storage_action_cancel(surf_action_t action)
312 surf_action_state_set(action, SURF_ACTION_FAILED);
316 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
318 surf_action_state_set(action, state);
322 static void storage_action_suspend(surf_action_t action)
324 XBT_IN("(%p)", action);
325 if (((surf_action_lmm_t) action)->suspended != 2) {
326 lmm_update_variable_weight(storage_maxmin_system,
327 ((surf_action_lmm_t) action)->variable,
329 ((surf_action_lmm_t) action)->suspended = 1;
334 static void storage_action_resume(surf_action_t action)
339 static int storage_action_is_suspended(surf_action_t action)
341 return (((surf_action_lmm_t) action)->suspended == 1);
344 static void storage_action_set_max_duration(surf_action_t action, double duration)
349 static void storage_action_set_priority(surf_action_t action, double priority)
354 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
356 void* stype = xbt_lib_get_or_null(storage_type_lib,
358 ROUTING_STORAGE_TYPE_LEVEL);
359 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
361 // if storage content is not specified use the content of storage_type if exist
362 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
363 storage->content = ((storage_type_t) stype)->content;
364 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
367 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",
369 ((storage_type_t) stype)->model,
370 ((storage_type_t) stype)->type_id,
372 ((storage_type_t) stype)->properties);
374 storage_create_resource(storage->id,
375 ((storage_type_t) stype)->model,
376 ((storage_type_t) stype)->type_id,
380 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
382 XBT_DEBUG("parse_mstorage_init");
385 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
387 XBT_DEBUG("parse_storage_type_init");
390 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
392 XBT_DEBUG("parse_mount_init");
395 static void storage_define_callbacks()
397 sg_platf_storage_add_cb(parse_storage_init);
398 sg_platf_storage_type_add_cb(parse_storage_type_init);
399 sg_platf_mstorage_add_cb(parse_mstorage_init);
400 sg_platf_mount_add_cb(parse_mount_init);
403 static void surf_storage_model_init_internal(void)
405 s_surf_action_t action;
407 XBT_DEBUG("surf_storage_model_init_internal");
408 surf_storage_model = surf_model_init();
410 storage_running_action_set_that_does_not_need_being_checked =
411 xbt_swag_new(xbt_swag_offset(action, state_hookup));
413 surf_storage_model->name = "Storage";
414 surf_storage_model->action_unref = storage_action_unref;
415 surf_storage_model->action_cancel = storage_action_cancel;
416 surf_storage_model->action_state_set = storage_action_state_set;
418 surf_storage_model->model_private->finalize = storage_finalize;
419 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
420 surf_storage_model->model_private->share_resources = storage_share_resources;
421 surf_storage_model->model_private->resource_used = storage_resource_used;
422 surf_storage_model->model_private->update_resource_state = storage_resources_state;
424 surf_storage_model->suspend = storage_action_suspend;
425 surf_storage_model->resume = storage_action_resume;
426 surf_storage_model->is_suspended = storage_action_is_suspended;
427 surf_storage_model->set_max_duration = storage_action_set_max_duration;
428 surf_storage_model->set_priority = storage_action_set_priority;
430 surf_storage_model->extension.storage.open = storage_action_open;
431 surf_storage_model->extension.storage.close = storage_action_close;
432 surf_storage_model->extension.storage.read = storage_action_read;
433 surf_storage_model->extension.storage.write = storage_action_write;
434 surf_storage_model->extension.storage.stat = storage_action_stat;
435 surf_storage_model->extension.storage.create_resource = storage_create_resource;
437 if (!storage_maxmin_system) {
438 storage_maxmin_system = lmm_system_new(storage_selective_update);
443 void surf_storage_model_init_default(void)
445 surf_storage_model_init_internal();
446 storage_define_callbacks();
448 xbt_dynar_push(model_list, &surf_storage_model);
451 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
453 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
454 "Reading a storage, processing unit \"%s\" already exists", storage->id);
456 // Verification of an existing type_id
458 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
460 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
462 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
467 xbt_lib_set(storage_lib,
469 ROUTING_STORAGE_LEVEL,
470 (void *) xbt_strdup(storage->type_id));
473 static void free_storage_content(void *p)
475 surf_stat_t content = p;
476 free(content->stat.date);
477 free(content->stat.group);
478 free(content->stat.time);
479 free(content->stat.user);
480 free(content->stat.user_rights);
484 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
487 if ((!filename) || (strcmp(filename, "") == 0))
490 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
493 file = surf_fopen(filename, "r");
494 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
495 xbt_str_join(surf_path, ":"));
500 char user_rights[12];
511 while ((read = getline(&line, &len, file)) != -1) {
512 content = xbt_new0(s_surf_stat_t,1);
513 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
514 content->stat.date = xbt_strdup(date);
515 content->stat.group = xbt_strdup(group);
516 content->stat.size = size;
517 content->stat.time = xbt_strdup(time);
518 content->stat.user = xbt_strdup(user);
519 content->stat.user_rights = xbt_strdup(user_rights);
520 *used_size += content->stat.size;
521 xbt_dict_set(parse_content,path,content,NULL);
523 xbt_die("Be sure of passing a good format for content file.\n");
524 // You can generate this kind of file with command line:
525 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
531 return parse_content;
534 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
536 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
537 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
539 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
540 stype->model = xbt_strdup(storage_type->model);
541 stype->properties = storage_type->properties;
542 stype->content = xbt_strdup(storage_type->content);
543 stype->type_id = xbt_strdup(storage_type->id);
544 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
546 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
549 storage_type->content);
551 xbt_lib_set(storage_type_lib,
553 ROUTING_STORAGE_TYPE_LEVEL,
556 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
559 // mount_t mnt = xbt_new0(s_mount_t, 1);
560 // mnt->id = xbt_strdup(mstorage->type_id);
561 // mnt->name = xbt_strdup(mstorage->name);
564 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
565 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
567 // xbt_dynar_push(mount_list,(void *) mnt);
571 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
574 static void mount_free(void *p)
580 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
582 // Verification of an existing storage
584 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
586 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
588 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
591 mnt.id = surf_storage_resource_by_name(mount->id);
592 mnt.name = xbt_strdup(mount->name);
595 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
596 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
598 xbt_dynar_push(mount_list,&mnt);
601 static XBT_INLINE void routing_storage_type_free(void *r)
603 storage_type_t stype = r;
605 free(stype->type_id);
606 free(stype->content);
607 xbt_dict_free(&(stype->properties));
611 static XBT_INLINE void surf_storage_resource_free(void *r)
613 // specific to storage
614 storage_t storage = r;
615 xbt_dict_free(&storage->content);
617 surf_resource_free(r);
620 static XBT_INLINE void routing_storage_host_free(void *r)
623 xbt_dynar_free(&dyn);
626 void storage_register_callbacks() {
628 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
629 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
630 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
631 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
633 sg_platf_storage_add_cb(storage_parse_storage);
634 sg_platf_mstorage_add_cb(storage_parse_mstorage);
635 sg_platf_storage_type_add_cb(storage_parse_storage_type);
636 sg_platf_mount_add_cb(storage_parse_mount);