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 #define GENERIC_LMM_ACTION(action) action->generic_lmm_action
34 #define GENERIC_ACTION(action) GENERIC_LMM_ACTION(action).generic_action
36 typedef struct surf_storage {
37 s_surf_resource_t generic_resource;
39 const char* content; /*should be a dict */
40 } s_surf_storage_t, *surf_storage_t;
42 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size);
43 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state);
44 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type);
46 static surf_action_t storage_action_stat(void *storage, surf_file_t stream)
48 surf_action_t action = storage_action_execute(storage,0, STAT);
49 action->file = stream;
50 action->stat = stream->content->stat;
54 static surf_action_t storage_action_open(void *storage, const char* mount, const char* path, const char* mode)
56 XBT_DEBUG("\tOpen file '%s'",path);
57 char *storage_type_id = xbt_lib_get_or_null(
59 ((storage_t)storage)->generic_resource.name,
60 ROUTING_STORAGE_LEVEL);
61 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, storage_type_id,ROUTING_STORAGE_TYPE_LEVEL);
62 xbt_dict_t content_dict = ((storage_t)storage)->content;
63 surf_stat_t content = xbt_dict_get(content_dict,path);
65 surf_file_t file = xbt_new0(s_surf_file_t,1);
66 file->name = xbt_strdup(path);
67 file->content = content;
68 file->storage = mount;
70 surf_action_t action = storage_action_execute(storage,0, OPEN);
71 action->file = (void *)file;
75 static surf_action_t storage_action_close(void *storage, surf_file_t fp)
77 char *filename = fp->name;
81 surf_action_t action = storage_action_execute(storage,0, CLOSE);
82 XBT_DEBUG("\tClose file '%s'",filename);
86 static surf_action_t storage_action_read(void *storage, 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("\tRead file '%s' size '%zu/%zu'",filename,size,content->stat.size);
91 if(size > content->stat.size)
92 size = content->stat.size;
93 surf_action_t action = storage_action_execute(storage,size,READ);
97 static surf_action_t storage_action_write(void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream)
99 char *filename = stream->name;
100 surf_stat_t content = stream->content;
101 XBT_DEBUG("\tWrite file '%s' size '%zu/%zu'",filename,size,content->stat.size);
104 content->stat.size += size;
106 ((storage_t)storage)->used_size =+ size;
108 surf_action_t action = storage_action_execute(storage,size,WRITE);
109 // if(used_size==size) {
110 // storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
115 static surf_action_t storage_action_execute (void *storage, size_t size, e_surf_action_storage_type_t type)
117 surf_action_storage_t action = NULL;
118 storage_t STORAGE = storage;
120 XBT_IN("(%s,%zu)", surf_resource_name(STORAGE), size);
122 surf_action_new(sizeof(s_surf_action_storage_t), size, surf_storage_model,
123 STORAGE->state_current != SURF_RESOURCE_ON);
125 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
126 calloc but it seems to help valgrind... */
128 GENERIC_LMM_ACTION(action).variable =
129 lmm_variable_new(storage_maxmin_system, action, 1.0, -1.0 , 3);
131 // Must be less than the max bandwidth for all actions
132 lmm_expand(storage_maxmin_system, STORAGE->constraint,
133 GENERIC_LMM_ACTION(action).variable, 1.0);
141 lmm_expand(storage_maxmin_system, STORAGE->constraint_read,
142 GENERIC_LMM_ACTION(action).variable, 1.0);
145 lmm_expand(storage_maxmin_system, STORAGE->constraint_write,
146 GENERIC_LMM_ACTION(action).variable, 1.0);
151 return (surf_action_t) action;
154 static void* storage_create_resource(const char* id, const char* model,const char* type_id,const char* content_name)
156 storage_t storage = NULL;
158 xbt_assert(!surf_storage_resource_by_name(id),
159 "Storage '%s' declared several times in the platform file",
161 storage = (storage_t) surf_resource_new(sizeof(s_storage_t),
162 surf_storage_model, id,NULL);
164 storage->state_current = SURF_RESOURCE_ON;
165 storage->used_size = 0;
168 storage_type_t storage_type = xbt_lib_get_or_null(storage_type_lib, type_id,ROUTING_STORAGE_TYPE_LEVEL);
169 double Bread = atof(xbt_dict_get(storage_type->properties,"Bread"));
170 double Bwrite = atof(xbt_dict_get(storage_type->properties,"Bwrite"));
171 double Bconnection = atof(xbt_dict_get(storage_type->properties,"Bconnection"));
172 XBT_DEBUG("Create resource with Bconnection '%f' Bread '%f' Bwrite '%f' and Size '%ld'",Bconnection,Bread,Bwrite,storage_type->size);
173 storage->constraint = lmm_constraint_new(storage_maxmin_system, storage, Bconnection);
174 storage->constraint_read = lmm_constraint_new(storage_maxmin_system, storage, Bread);
175 storage->constraint_write = lmm_constraint_new(storage_maxmin_system, storage, Bwrite);
176 storage->content = parse_storage_content((char*)content_name,&(storage->used_size));
177 storage->size = storage_type->size;
179 xbt_lib_set(storage_lib, id, SURF_STORAGE_LEVEL, storage);
181 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",
185 storage_type->properties,
191 static void storage_finalize(void)
193 lmm_system_free(storage_maxmin_system);
194 storage_maxmin_system = NULL;
196 surf_model_exit(surf_storage_model);
197 surf_storage_model = NULL;
200 (storage_running_action_set_that_does_not_need_being_checked);
201 storage_running_action_set_that_does_not_need_being_checked = NULL;
204 static void storage_update_actions_state(double now, double delta)
206 surf_action_storage_t action = NULL;
207 surf_action_storage_t next_action = NULL;
208 xbt_swag_t running_actions = surf_storage_model->states.running_action_set;
210 // Update the disk usage
213 // foreach write_action in disk {
214 // rate += value(variable(action))
216 // used_size += delta * rate
218 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);
221 if (GENERIC_LMM_ACTION(action).generic_action.max_duration != NO_MAX_DURATION)
222 double_update(&(GENERIC_ACTION(action).max_duration), delta);
223 // if(remains>0 and weight(variable(action))>0 && used_size == size) {
224 // GENERIC_ACTION(action).finish = surf_get_clock();
225 // storage_action_state_set((surf_action_t) action, SURF_ACTION_FAILED);
227 if ((GENERIC_ACTION(action).remains <= 0) &&
228 (lmm_get_variable_weight(GENERIC_LMM_ACTION(action).variable) > 0)) {
229 GENERIC_ACTION(action).finish = surf_get_clock();
230 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
231 } else if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION) &&
232 (GENERIC_ACTION(action).max_duration <= 0)) {
233 GENERIC_ACTION(action).finish = surf_get_clock();
234 storage_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
241 static double storage_share_resources(double NOW)
243 XBT_DEBUG("storage_share_resources %f",NOW);
244 s_surf_action_storage_t action;
245 double min_completion = generic_maxmin_share_resources(surf_storage_model->states.running_action_set,
246 xbt_swag_offset(action, generic_lmm_action.variable),
247 storage_maxmin_system, lmm_solve);
251 foreach write_action in disk {
252 rate += value(variable(action));
255 min_completion = MIN(min_completion, (size-used_size)/rate);
259 return min_completion;
262 static int storage_resource_used(void *resource_id)
268 static void storage_resources_state(void *id, tmgr_trace_event_t event_type,
269 double value, double time)
274 static int storage_action_unref(surf_action_t action)
277 if (!action->refcount) {
278 xbt_swag_remove(action, action->state_set);
279 if (((surf_action_lmm_t) action)->variable)
280 lmm_variable_free(storage_maxmin_system,
281 ((surf_action_lmm_t) action)->variable);
283 xbt_free(action->category);
285 surf_action_free(&action);
291 static void storage_action_cancel(surf_action_t action)
293 surf_action_state_set(action, SURF_ACTION_FAILED);
297 static void storage_action_state_set(surf_action_t action, e_surf_action_state_t state)
299 surf_action_state_set(action, state);
303 static void storage_action_suspend(surf_action_t action)
305 XBT_IN("(%p)", action);
306 if (((surf_action_lmm_t) action)->suspended != 2) {
307 lmm_update_variable_weight(storage_maxmin_system,
308 ((surf_action_lmm_t) action)->variable,
310 ((surf_action_lmm_t) action)->suspended = 1;
315 static void storage_action_resume(surf_action_t action)
320 static int storage_action_is_suspended(surf_action_t action)
322 return (((surf_action_lmm_t) action)->suspended == 1);
325 static void storage_action_set_max_duration(surf_action_t action, double duration)
330 static void storage_action_set_priority(surf_action_t action, double priority)
335 static void parse_storage_init(sg_platf_storage_cbarg_t storage)
337 void* stype = xbt_lib_get_or_null(storage_type_lib,
339 ROUTING_STORAGE_TYPE_LEVEL);
340 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
342 // if storage content is not specified use the content of storage_type if exist
343 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
344 storage->content = ((storage_type_t) stype)->content;
345 XBT_DEBUG("For disk '%s' content is empty, use the content of storage type '%s'",storage->id,((storage_type_t) stype)->type_id);
348 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",
350 ((storage_type_t) stype)->model,
351 ((storage_type_t) stype)->type_id,
353 ((storage_type_t) stype)->properties);
355 storage_create_resource(storage->id,
356 ((storage_type_t) stype)->model,
357 ((storage_type_t) stype)->type_id,
361 static void parse_mstorage_init(sg_platf_mstorage_cbarg_t mstorage)
363 XBT_DEBUG("parse_mstorage_init");
366 static void parse_storage_type_init(sg_platf_storage_type_cbarg_t storagetype_)
368 XBT_DEBUG("parse_storage_type_init");
371 static void parse_mount_init(sg_platf_mount_cbarg_t mount)
373 XBT_DEBUG("parse_mount_init");
376 static void storage_define_callbacks()
378 sg_platf_storage_add_cb(parse_storage_init);
379 sg_platf_storage_type_add_cb(parse_storage_type_init);
380 sg_platf_mstorage_add_cb(parse_mstorage_init);
381 sg_platf_mount_add_cb(parse_mount_init);
384 static void surf_storage_model_init_internal(void)
386 s_surf_action_t action;
388 XBT_DEBUG("surf_storage_model_init_internal");
389 surf_storage_model = surf_model_init();
391 storage_running_action_set_that_does_not_need_being_checked =
392 xbt_swag_new(xbt_swag_offset(action, state_hookup));
394 surf_storage_model->name = "Storage";
395 surf_storage_model->action_unref = storage_action_unref;
396 surf_storage_model->action_cancel = storage_action_cancel;
397 surf_storage_model->action_state_set = storage_action_state_set;
399 surf_storage_model->model_private->finalize = storage_finalize;
400 surf_storage_model->model_private->update_actions_state = storage_update_actions_state;
401 surf_storage_model->model_private->share_resources = storage_share_resources;
402 surf_storage_model->model_private->resource_used = storage_resource_used;
403 surf_storage_model->model_private->update_resource_state = storage_resources_state;
405 surf_storage_model->suspend = storage_action_suspend;
406 surf_storage_model->resume = storage_action_resume;
407 surf_storage_model->is_suspended = storage_action_is_suspended;
408 surf_storage_model->set_max_duration = storage_action_set_max_duration;
409 surf_storage_model->set_priority = storage_action_set_priority;
411 surf_storage_model->extension.storage.open = storage_action_open;
412 surf_storage_model->extension.storage.close = storage_action_close;
413 surf_storage_model->extension.storage.read = storage_action_read;
414 surf_storage_model->extension.storage.write = storage_action_write;
415 surf_storage_model->extension.storage.stat = storage_action_stat;
416 surf_storage_model->extension.storage.create_resource = storage_create_resource;
418 if (!storage_maxmin_system) {
419 storage_maxmin_system = lmm_system_new(storage_selective_update);
424 void surf_storage_model_init_default(void)
426 surf_storage_model_init_internal();
427 storage_define_callbacks();
429 xbt_dynar_push(model_list, &surf_storage_model);
432 static void storage_parse_storage(sg_platf_storage_cbarg_t storage)
434 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
435 "Reading a storage, processing unit \"%s\" already exists", storage->id);
437 // Verification of an existing type_id
439 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
441 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
443 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
448 xbt_lib_set(storage_lib,
450 ROUTING_STORAGE_LEVEL,
451 (void *) xbt_strdup(storage->type_id));
454 static void free_storage_content(void *p)
456 surf_stat_t content = p;
457 free(content->stat.date);
458 free(content->stat.group);
459 free(content->stat.time);
460 free(content->stat.user);
461 free(content->stat.user_rights);
465 static xbt_dict_t parse_storage_content(char *filename, unsigned long *used_size)
468 if ((!filename) || (strcmp(filename, "") == 0))
471 xbt_dict_t parse_content = xbt_dict_new_homogeneous(free_storage_content);
474 file = surf_fopen(filename, "r");
475 xbt_assert(file != NULL, "Cannot open file '%s' (path=%s)", filename,
476 xbt_str_join(surf_path, ":"));
481 char user_rights[12];
492 while ((read = getline(&line, &len, file)) != -1) {
493 content = xbt_new0(s_surf_stat_t,1);
494 if(sscanf(line,"%s %d %s %s %ld %s %s %s",user_rights,&nb,user,group,&size,date,time,path)==8) {
495 content->stat.date = xbt_strdup(date);
496 content->stat.group = xbt_strdup(group);
497 content->stat.size = size;
498 content->stat.time = xbt_strdup(time);
499 content->stat.user = xbt_strdup(user);
500 content->stat.user_rights = xbt_strdup(user_rights);
501 *used_size += content->stat.size;
502 xbt_dict_set(parse_content,path,content,NULL);
504 xbt_die("Be sure of passing a good format for content file.\n");
505 // You can generate this kind of file with command line:
506 // find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
512 return parse_content;
515 static void storage_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
517 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
518 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
520 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
521 stype->model = xbt_strdup(storage_type->model);
522 stype->properties = storage_type->properties;
523 stype->content = xbt_strdup(storage_type->content);
524 stype->type_id = xbt_strdup(storage_type->id);
525 stype->size = storage_type->size * 1000000000; /* storage_type->size is in Gbytes and stype->sizeis in bytes */
527 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s'",
530 storage_type->content);
532 xbt_lib_set(storage_type_lib,
534 ROUTING_STORAGE_TYPE_LEVEL,
537 static void storage_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
540 // mount_t mnt = xbt_new0(s_mount_t, 1);
541 // mnt->id = xbt_strdup(mstorage->type_id);
542 // mnt->name = xbt_strdup(mstorage->name);
545 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
546 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
548 // xbt_dynar_push(mount_list,(void *) mnt);
552 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
555 static void mount_free(void *p)
561 static void storage_parse_mount(sg_platf_mount_cbarg_t mount)
563 // Verification of an existing storage
565 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
567 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
569 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
572 mnt.id = surf_storage_resource_by_name(mount->id);
573 mnt.name = xbt_strdup(mount->name);
576 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
577 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
579 xbt_dynar_push(mount_list,&mnt);
582 static XBT_INLINE void routing_storage_type_free(void *r)
584 storage_type_t stype = r;
586 free(stype->type_id);
587 free(stype->content);
588 xbt_dict_free(&(stype->properties));
592 static XBT_INLINE void surf_storage_resource_free(void *r)
594 // specific to storage
595 storage_t storage = r;
596 xbt_dict_free(&storage->content);
598 surf_resource_free(r);
601 static XBT_INLINE void routing_storage_host_free(void *r)
604 xbt_dynar_free(&dyn);
607 void storage_register_callbacks() {
609 ROUTING_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,xbt_free);
610 ROUTING_STORAGE_HOST_LEVEL = xbt_lib_add_level(storage_lib,routing_storage_host_free);
611 ROUTING_STORAGE_TYPE_LEVEL = xbt_lib_add_level(storage_type_lib,routing_storage_type_free);
612 SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_resource_free);
614 sg_platf_storage_add_cb(storage_parse_storage);
615 sg_platf_mstorage_add_cb(storage_parse_mstorage);
616 sg_platf_storage_type_add_cb(storage_parse_storage_type);
617 sg_platf_mount_add_cb(storage_parse_mount);