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, size_t 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, size_t size, size_t nmemb, surf_file_t stream)
79 char *filename = stream->name;
80 surf_stat_t content = stream->content;
81 XBT_DEBUG("\tRead file '%s' size '%f/%zu'",filename,content->stat.size,size);
82 if(size > content->stat.size)
83 size = content->stat.size;
84 surf_action_t action = storage_action_execute(storage,size,READ);
88 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
90 char *filename = stream->name;
91 surf_stat_t content = stream->content;
92 XBT_DEBUG("\tWrite file '%s' size '%zu/%f'",filename,size,content->stat.size);
94 surf_action_t action = storage_action_execute(storage,size,WRITE);
95 action->file = stream;
97 // If the storage is full
98 if(((storage_t)storage)->used_size==((storage_t)storage)->size) {
99 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
104 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type)
106 surf_action_storage_t action = NULL;
107 storage_t STORAGE = storage;
109 XBT_IN("(%s,%zu)", surf_resource_name(STORAGE), size);
111 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
112 STORAGE->state_current != SURF_RESOURCE_ON);
114 // Save the storage on action
115 action->storage = storage;
116 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
117 calloc but it seems to help valgrind... */
119 GENERIC_LMM_ACTION(action).variable =
120 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
122 // Must be less than the max bandwidth for all actions
123 lmm_expand(storage_maxmin_system, STORAGE->constraint,
124 GENERIC_LMM_ACTION(action).variable, 1.0);
132 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
133 GENERIC_LMM_ACTION(action).variable, 1.0);
136 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
137 GENERIC_LMM_ACTION(action).variable, 1.0);
138 xbt_dynar_push(((storage_t)storage)->write_actions,&action);
144 return (surf_action_t) action;
147 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
149 storage_t storage = NULL;
151 xbt_assert(!surf_storage_resource_by_name(id),
152 "Storage '%s' declared several times in the platform file",
154 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
155 surf_storage_model, id,NULL);
157 storage->state_current = SURF_RESOURCE_ON;
158 storage->used_size = 0;
160 storage->write_actions = xbt_dynar_new(sizeof(char *),NULL);
162 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
163 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
164 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
165 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
166 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
167 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
168 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
169 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
170 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
171 storage->size = storage_type->size;
173 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
175 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",
179 storage_type->properties,
182 if(!storage_list) storage_list=xbt_dynar_new(sizeof(char *),free);
183 xbt_dynar_push(storage_list,&storage);
188 static void storage_finalize(void)
190 lmm_system_free(storage_maxmin_system);
191 storage_maxmin_system = NULL;
193 surf_model_exit(surf_storage_model);
194 surf_storage_model = NULL;
197 (storage_running_action_set_that_does_not_need_being_checked);
198 storage_running_action_set_that_does_not_need_being_checked = NULL;
201 static void storage_update_actions_state(double now, double delta)
203 surf_action_storage_t action = NULL;
204 surf_action_storage_t next_action = NULL;
205 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
207 // Update the disk usage
208 // Update the file size
209 // Foreach action of type write
210 xbt_swag_foreach_safe(action, next_action, running_actions) {
211 if(action->type == WRITE)
213 double rate = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
214 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);
215 ((storage_t)(action->storage))->used_size += delta * rate; // disk usage
216 ((surf_action_t)action)->file->content->stat.size += delta * rate; // file size
220 xbt_swag_foreach_safe(action, next_action, running_actions) {
222 double_update(&(GENERIC_ACTION(action).remains),
223 lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable) * delta);
225 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
226 double_update(&(GENERIC_ACTION(action).max_duration), delta);
228 if(GENERIC_ACTION(action).remains > 0 &&
229 lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0 &&
230 ((storage_t)action->storage)->used_size == ((storage_t)action->storage)->size)
232 GENERIC_ACTION(action).finish = surf_get_clock();
233 storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
234 } else if ((GENERIC_ACTION(action).remains <= 0) &&
235 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0))
237 GENERIC_ACTION(action).finish = surf_get_clock();
238 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
239 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
240 (GENERIC_ACTION(action).max_duration <= 0))
242 GENERIC_ACTION(action).finish = surf_get_clock();
243 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
250 static double storage_share_resources(double NOW)
252 XBT_DEBUG("storage_share_resources %f",NOW);
253 s_surf_action_storage_t action;
256 surf_action_storage_t write_action;
258 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
259 xbt_swag_offset(action, generic_lmm_action.variable),
260 storage_maxmin_system, lmm_solve);
264 xbt_dynar_foreach(storage_list,i,storage)
267 // Foreach write action on disk
268 xbt_dynar_foreach(storage->write_actions,j,write_action)
270 rate += lmm_variable_getvalue(write_action->generic_lmm_action.variable);
273 min_completion = MIN(min_completion, (storage->size-storage->used_size)/rate);
276 return min_completion;
279 static int storage_resource_used(void *resource_id)
285 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
286 double value, double time)
291 static int storage_action_unref(surf_action_t action)
294 if (!action->refcount) {
295 xbt_swag_remove(action, action->state_set);
296 if (((surf_action_lmm_t) action)->variable)
297 lmm_variable_free(storage_maxmin_system,
298 ((surf_action_lmm_t) action)->variable);
300 xbt_free(action->category);
302 surf_action_free(&action);
308 static void storage_action_cancel(surf_action_t action)
310 surf_action_state_set(action, SURF_ACTION_FAILED);
314 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
316 surf_action_state_set(action, state);
320 static void storage_action_suspend(surf_action_t action)
322 XBT_IN("(%p)", action);
323 if (((surf_action_lmm_t) action)->suspended != 2) {
324 lmm_update_variable_weight(storage_maxmin_system,
325 ((surf_action_lmm_t) action)->variable,
327 ((surf_action_lmm_t) action)->suspended = 1;
332 static void storage_action_resume(surf_action_t action)
337 static int storage_action_is_suspended(surf_action_t action)
339 return (((surf_action_lmm_t) action)->suspended == 1);
342 static void storage_action_set_max_duration(surf_action_t action, double duration)
347 static void storage_action_set_priority(surf_action_t action, double priority)
352 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
354 void* stype = xbt_lib_get_or_null(storage_type_lib,
356 ROUTING_STORAGE_TYPE_LEVEL);
357 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
359 // if storage content is not specified use the content of storage_type if exist
360 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
361 storage->content = ((storage_type_t) stype)->content;
362 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
365 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",
367 ((storage_type_t) stype)->model,
368 ((storage_type_t) stype)->type_id,
370 ((storage_type_t) stype)->properties);
372 storage_create_resource(storage->id,
373 ((storage_type_t) stype)->model,
374 ((storage_type_t) stype)->type_id,
378 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
380 XBT_DEBUG("parse_mstorage_init");
383 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
385 XBT_DEBUG("parse_storage_type_init");
388 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
390 XBT_DEBUG("parse_mount_init");
393 static void storage_define_callbacks()
395 sg_platf_storage_add_cb(parse_storage_init);
396 sg_platf_storage_type_add_cb(parse_storage_type_init);
397 sg_platf_mstorage_add_cb(parse_mstorage_init);
398 sg_platf_mount_add_cb(parse_mount_init);
401 static void surf_storage_model_init_internal(void)
403 s_surf_action_t action;
405 XBT_DEBUG("surf_storage_model_init_internal");
406 surf_storage_model = surf_model_init();
408 storage_running_action_set_that_does_not_need_being_checked =
409 xbt_swag_new(xbt_swag_offset(action, state_hookup));
411 surf_storage_model->name = "Storage";
412 surf_storage_model->action_unref = storage_action_unref;
413 surf_storage_model->action_cancel = storage_action_cancel;
414 surf_storage_model->action_state_set = storage_action_state_set;
416 surf_storage_model->model_private->finalize = storage_finalize;
417 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
418 surf_storage_model->model_private->share_resources = storage_share_resources;
419 surf_storage_model->model_private->resource_used = storage_resource_used;
420 surf_storage_model->model_private->update_resource_state = storage_resources_state;
422 surf_storage_model->suspend = storage_action_suspend;
423 surf_storage_model->resume = storage_action_resume;
424 surf_storage_model->is_suspended = storage_action_is_suspended;
425 surf_storage_model->set_max_duration = storage_action_set_max_duration;
426 surf_storage_model->set_priority = storage_action_set_priority;
428 surf_storage_model->extension.storage.open = storage_action_open;
429 surf_storage_model->extension.storage.close = storage_action_close;
430 surf_storage_model->extension.storage.read = storage_action_read;
431 surf_storage_model->extension.storage.write = storage_action_write;
432 surf_storage_model->extension.storage.stat = storage_action_stat;
433 surf_storage_model->extension.storage.create_resource = storage_create_resource;
435 if (!storage_maxmin_system) {
436 storage_maxmin_system = lmm_system_new(storage_selective_update);
441 void surf_storage_model_init_default(void)
443 surf_storage_model_init_internal();
444 storage_define_callbacks();
446 xbt_dynar_push(model_list, &surf_storage_model);
449 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
451 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
452 "Reading a storage, processing unit \"%s\" already exists", storage->id);
454 // Verification of an existing type_id
456 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
458 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
460 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
465 xbt_lib_set(storage_lib,
467 ROUTING_STORAGE_LEVEL,
468 (void *) xbt_strdup(storage->type_id));
471 static void free_storage_content(void *p)
473 surf_stat_t content = p;
474 free(content->stat.date);
475 free(content->stat.group);
476 free(content->stat.time);
477 free(content->stat.user);
478 free(content->stat.user_rights);
482 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
485 if ((!filename) || (strcmp(filename, "") == 0))
488 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
491 file = surf_fopen(filename, "r");
492 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
493 xbt_str_join(surf_path, ":"));
498 char user_rights[12];
509 while ((read = getline(&line, &len, file)) != -1) {
510 content = xbt_new0(s_surf_stat_t,1);
511 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
512 content->stat.date = xbt_strdup(date);
513 content->stat.group = xbt_strdup(group);
514 content->stat.size = size;
515 content->stat.time = xbt_strdup(time);
516 content->stat.user = xbt_strdup(user);
517 content->stat.user_rights = xbt_strdup(user_rights);
518 *used_size += content->stat.size;
519 xbt_dict_set(parse_content,path,content,NULL);
521 xbt_die("Be sure of passing a good format for content file.\n");
522 // You can generate this kind of file with command line:
523 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
529 return parse_content;
532 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
534 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
535 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
537 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
538 stype->model = xbt_strdup(storage_type->model);
539 stype->properties = storage_type->properties;
540 stype->content = xbt_strdup(storage_type->content);
541 stype->type_id = xbt_strdup(storage_type->id);
542 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
544 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
547 storage_type->content);
549 xbt_lib_set(storage_type_lib,
551 ROUTING_STORAGE_TYPE_LEVEL,
554 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
557 // mount_t mnt = xbt_new0(s_mount_t, 1);
558 // mnt->id = xbt_strdup(mstorage->type_id);
559 // mnt->name = xbt_strdup(mstorage->name);
562 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
563 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
565 // xbt_dynar_push(mount_list,(void *) mnt);
569 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
572 static void mount_free(void *p)
578 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
580 // Verification of an existing storage
582 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
584 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
586 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
589 mnt.id = surf_storage_resource_by_name(mount->id);
590 mnt.name = xbt_strdup(mount->name);
593 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
594 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
596 xbt_dynar_push(mount_list,&mnt);
599 static XBT_INLINE void routing_storage_type_free(void *r)
601 storage_type_t stype = r;
603 free(stype->type_id);
604 free(stype->content);
605 xbt_dict_free(&(stype->properties));
609 static XBT_INLINE void surf_storage_resource_free(void *r)
611 // specific to storage
612 storage_t storage = r;
613 xbt_dict_free(&storage->content);
615 surf_resource_free(r);
618 static XBT_INLINE void routing_storage_host_free(void *r)
621 xbt_dynar_free(&dyn);
624 void storage_register_callbacks() {
626 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
627 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
628 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
629 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
631 sg_platf_storage_add_cb(storage_parse_storage);
632 sg_platf_mstorage_add_cb(storage_parse_mstorage);
633 sg_platf_storage_type_add_cb(storage_parse_storage_type);
634 sg_platf_mount_add_cb(storage_parse_mount);