1 /* Copyright (c) 2006-2014. 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. */
11 #include "xbt/RngStream.h"
12 #include "simgrid/platf_interface.h"
13 #include "surf/surf_routing.h"
14 #include "surf/surf.h"
16 #include "src/simix/smx_private.h"
18 #include "cpu_interface.hpp"
19 #include "host_interface.hpp"
21 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_parse);
22 xbt_dynar_t sg_platf_link_cb_list = NULL; // of sg_platf_link_cb_t
23 xbt_dynar_t sg_platf_cluster_cb_list = NULL; // of sg_platf_cluster_cb_t
24 xbt_dynar_t sg_platf_cabinet_cb_list = NULL; // of sg_platf_cluster_cb_t
25 xbt_dynar_t sg_platf_postparse_cb_list = NULL; // of void_f_void_t
26 xbt_dynar_t sg_platf_prop_cb_list = NULL; // of sg_platf_prop_cb_t
28 xbt_dynar_t sg_platf_ASroute_cb_list = NULL; // of sg_platf_ASroute_cb_t
29 xbt_dynar_t sg_platf_bypassRoute_cb_list = NULL; // of sg_platf_bypassRoute_cb_t
30 xbt_dynar_t sg_platf_bypassASroute_cb_list = NULL; // of sg_platf_bypassASroute_cb_t
32 xbt_dynar_t sg_platf_trace_cb_list = NULL;
33 xbt_dynar_t sg_platf_trace_connect_cb_list = NULL;
35 /* ***************************************** */
36 /* TUTORIAL: New TAG */
38 xbt_dynar_t sg_platf_gpu_cb_list = NULL;
39 /* ***************************************** */
42 static int surf_parse_models_setup_already_called = 0;
44 /* one RngStream for the platform, to respect some statistic rules */
45 static RngStream sg_platf_rng_stream = NULL;
47 /** Module management function: creates all internal data structures */
48 void sg_platf_init(void) {
50 //FIXME : Ugly, but useful...
51 if (sg_platf_gpu_cb_list)
52 return; //Already initialized, so do nothing...
54 sg_platf_link_cb_list = xbt_dynar_new(sizeof(sg_platf_link_cb_t), NULL);
55 sg_platf_cluster_cb_list = xbt_dynar_new(sizeof(sg_platf_cluster_cb_t), NULL);
56 sg_platf_cabinet_cb_list = xbt_dynar_new(sizeof(sg_platf_cabinet_cb_t), NULL);
57 sg_platf_postparse_cb_list = xbt_dynar_new(sizeof(sg_platf_link_cb_t),NULL);
58 sg_platf_prop_cb_list = xbt_dynar_new(sizeof(sg_platf_prop_cb_t),NULL);
60 sg_platf_ASroute_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
61 sg_platf_bypassRoute_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
62 sg_platf_bypassASroute_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
64 sg_platf_trace_cb_list = xbt_dynar_new(sizeof(sg_platf_trace_cb_t), NULL);
65 sg_platf_trace_connect_cb_list = xbt_dynar_new(sizeof(sg_platf_trace_connect_cb_t), NULL);
67 /* ***************************************** */
68 /* TUTORIAL: New TAG */
70 sg_platf_gpu_cb_list = xbt_dynar_new(sizeof(sg_platf_gpu_cb_t), NULL);
71 /* ***************************************** */
73 /** Module management function: frees all internal data structures */
74 void sg_platf_exit(void) {
75 xbt_dynar_free(&sg_platf_link_cb_list);
76 xbt_dynar_free(&sg_platf_postparse_cb_list);
77 xbt_dynar_free(&sg_platf_cluster_cb_list);
78 xbt_dynar_free(&sg_platf_cabinet_cb_list);
79 xbt_dynar_free(&sg_platf_prop_cb_list);
81 xbt_dynar_free(&sg_platf_trace_cb_list);
82 xbt_dynar_free(&sg_platf_trace_connect_cb_list);
84 xbt_dynar_free(&sg_platf_ASroute_cb_list);
85 xbt_dynar_free(&sg_platf_bypassRoute_cb_list);
86 xbt_dynar_free(&sg_platf_bypassASroute_cb_list);
88 /* ***************************************** */
89 /* TUTORIAL: New TAG */
91 xbt_dynar_free(&sg_platf_gpu_cb_list);
93 /* ***************************************** */
95 /* make sure that we will reinit the models while loading the platf once reinited */
96 surf_parse_models_setup_already_called = 0;
99 void sg_platf_new_host(sg_platf_host_cbarg_t host)
101 xbt_assert(! sg_host_by_name(host->id),
102 "Refusing to create a second host named '%s'.", host->id);
104 RoutingEdge *net = NULL;
105 As* current_routing = routing_get_current();
107 net = routing_add_host(current_routing, host);
109 Cpu *cpu = surf_cpu_model_pm->createCpu(
119 surf_host_model->createHost(host->id, net, cpu);
121 if (TRACE_is_enabled() && TRACE_needs_platform())
122 sg_instr_new_host(host);
126 * \brief Add a "router" to the network element list
128 void sg_platf_new_router(sg_platf_router_cbarg_t router)
130 As* current_routing = routing_get_current();
132 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
133 current_routing->p_hierarchy = SURF_ROUTING_BASE;
134 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
135 "Reading a router, processing unit \"%s\" already exists",
138 RoutingEdge *info = new RoutingEdgeImpl(xbt_strdup(router->id),
140 SURF_NETWORK_ELEMENT_ROUTER,
142 info->setId(current_routing->parsePU(info));
143 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
144 XBT_DEBUG("Having set name '%s' id '%d'", router->id, info->getId());
145 routingEdgeCreatedCallbacks(info);
147 if (router->coord && strcmp(router->coord, "")) {
151 if (!COORD_ASR_LEVEL)
152 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
153 /* Pre-parse the host coordinates */
154 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
155 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
156 xbt_dynar_foreach(ctn_str,cursor, str) {
157 double val = atof(str);
158 xbt_dynar_push(ctn,&val);
160 xbt_dynar_shrink(ctn, 0);
161 xbt_dynar_free(&ctn_str);
162 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
163 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
166 if (TRACE_is_enabled())
167 sg_instr_new_router(router);
170 void sg_platf_new_link(sg_platf_link_cbarg_t link){
171 unsigned int iterator;
172 sg_platf_link_cb_t fun;
173 xbt_dynar_foreach(sg_platf_link_cb_list, iterator, fun) {
178 void sg_platf_new_cluster(sg_platf_cluster_cbarg_t cluster){
179 unsigned int iterator;
180 sg_platf_cluster_cb_t fun;
181 xbt_dynar_foreach(sg_platf_cluster_cb_list, iterator, fun) {
185 void sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet){
186 unsigned int iterator;
187 sg_platf_cabinet_cb_t fun;
188 xbt_dynar_foreach(sg_platf_cabinet_cb_list, iterator, fun) {
192 void sg_platf_new_storage(sg_platf_storage_cbarg_t storage)
194 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
195 "Reading a storage, processing unit \"%s\" already exists", storage->id);
197 // Verification of an existing type_id
199 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
201 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
203 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
208 xbt_lib_set(storage_lib,
210 ROUTING_STORAGE_LEVEL,
211 (void *) xbt_strdup(storage->type_id));
213 void* stype = xbt_lib_get_or_null(storage_type_lib,
215 ROUTING_STORAGE_TYPE_LEVEL);
216 if(!stype) xbt_die("No storage type '%s'",storage->type_id);
218 // if storage content is not specified use the content of storage_type if exist
219 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
220 storage->content = ((storage_type_t) stype)->content;
221 storage->content_type = ((storage_type_t) stype)->content_type;
222 XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s) from storage type '%s' ",
223 storage->id,((storage_type_t) stype)->content_type,
224 ((storage_type_t) stype)->type_id);
227 XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
228 "\n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tcontent_type '%s' "
229 "\n\t\tproperties '%p''\n",
231 ((storage_type_t) stype)->model,
232 ((storage_type_t) stype)->type_id,
234 storage->content_type,
235 storage->properties);
237 surf_storage_model->createStorage(storage->id,
238 ((storage_type_t) stype)->type_id,
240 storage->content_type,
244 void sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type){
246 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
247 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
249 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
250 stype->model = xbt_strdup(storage_type->model);
251 stype->properties = storage_type->properties;
252 stype->content = xbt_strdup(storage_type->content);
253 stype->content_type = xbt_strdup(storage_type->content_type);
254 stype->type_id = xbt_strdup(storage_type->id);
255 stype->size = storage_type->size;
256 stype->model_properties = storage_type->model_properties;
258 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s', "
259 "content '%s', and content_type '%s'",
262 storage_type->content,
263 storage_type->content_type);
265 xbt_lib_set(storage_type_lib,
267 ROUTING_STORAGE_TYPE_LEVEL,
270 void sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage)
273 // mount_t mnt = xbt_new0(s_mount_t, 1);
274 // mnt->id = xbt_strdup(mstorage->type_id);
275 // mnt->name = xbt_strdup(mstorage->name);
278 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
279 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
281 // xbt_dynar_push(mount_list,(void *) mnt);
285 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
288 static void mount_free(void *p)
290 mount_t mnt = (mount_t) p;
294 void sg_platf_new_mount(sg_platf_mount_cbarg_t mount){
295 // Verification of an existing storage
297 void* storage = xbt_lib_get_or_null(storage_lib, mount->storageId, ROUTING_STORAGE_LEVEL);
299 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->storageId);
301 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->storageId, mount->name);
304 mnt.storage = surf_storage_resource_priv(surf_storage_resource_by_name(mount->storageId));
305 mnt.name = xbt_strdup(mount->name);
308 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
309 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
311 xbt_dynar_push(mount_list, &mnt);
314 void sg_platf_new_route(sg_platf_route_cbarg_t route)
316 routing_get_current()->parseRoute(route);
319 void sg_platf_new_ASroute(sg_platf_route_cbarg_t ASroute) {
320 unsigned int iterator;
321 sg_platf_route_cb_t fun;
322 xbt_dynar_foreach(sg_platf_ASroute_cb_list, iterator, fun) {
326 void sg_platf_new_bypassRoute(sg_platf_route_cbarg_t bypassRoute) {
327 unsigned int iterator;
328 sg_platf_route_cb_t fun;
329 xbt_dynar_foreach(sg_platf_bypassRoute_cb_list, iterator, fun) {
333 void sg_platf_new_bypassASroute(sg_platf_route_cbarg_t bypassASroute) {
334 unsigned int iterator;
335 sg_platf_route_cb_t fun;
336 xbt_dynar_foreach(sg_platf_bypassASroute_cb_list, iterator, fun) {
340 void sg_platf_new_prop(sg_platf_prop_cbarg_t prop) {
341 unsigned int iterator;
342 sg_platf_prop_cb_t fun;
343 xbt_dynar_foreach(sg_platf_prop_cb_list, iterator, fun) {
347 void sg_platf_new_trace(sg_platf_trace_cbarg_t trace) {
348 unsigned int iterator;
349 sg_platf_trace_cb_t fun;
350 xbt_dynar_foreach(sg_platf_trace_cb_list, iterator, fun) {
354 void sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect) {
355 unsigned int iterator;
356 sg_platf_trace_connect_cb_t fun;
357 xbt_dynar_foreach(sg_platf_trace_connect_cb_list, iterator, fun) {
362 void sg_platf_new_process(sg_platf_process_cbarg_t process)
365 xbt_die("Cannot create process without SIMIX.");
367 sg_host_t host = sg_host_by_name(process->host);
369 THROWF(arg_error, 0, "Host '%s' unknown", process->host);
370 xbt_main_func_t parse_code = SIMIX_get_registered_function(process->function);
371 xbt_assert(parse_code, "Function '%s' unknown", process->function);
373 double start_time = process->start_time;
374 double kill_time = process->kill_time;
375 int auto_restart = process->on_failure == SURF_PROCESS_ON_FAILURE_DIE ? 0 : 1;
377 smx_process_arg_t arg = NULL;
378 smx_process_t process_created = NULL;
380 arg = xbt_new0(s_smx_process_arg_t, 1);
381 arg->code = parse_code;
383 arg->hostname = sg_host_get_name(host);
384 arg->argc = process->argc;
385 arg->argv = xbt_new(char *,process->argc);
387 for (i=0; i<process->argc; i++)
388 arg->argv[i] = xbt_strdup(process->argv[i]);
389 arg->name = xbt_strdup(arg->argv[0]);
390 arg->kill_time = kill_time;
391 arg->properties = current_property_set;
392 if (!sg_host_simix(host)->boot_processes) {
393 sg_host_simix(host)->boot_processes = xbt_dynar_new(sizeof(smx_process_arg_t), _SIMIX_host_free_process_arg);
395 xbt_dynar_push_as(sg_host_simix(host)->boot_processes,smx_process_arg_t,arg);
397 if (start_time > SIMIX_get_clock()) {
398 arg = xbt_new0(s_smx_process_arg_t, 1);
399 arg->name = (char*)(process->argv)[0];
400 arg->code = parse_code;
402 arg->hostname = sg_host_get_name(host);
403 arg->argc = process->argc;
404 arg->argv = (char**)(process->argv);
405 arg->kill_time = kill_time;
406 arg->properties = current_property_set;
408 XBT_DEBUG("Process %s(%s) will be started at time %f", arg->name,
409 arg->hostname, start_time);
410 SIMIX_timer_set(start_time, [](void* arg) {
411 SIMIX_process_create_from_wrapper((smx_process_arg_t) arg);
413 } else { // start_time <= SIMIX_get_clock()
414 XBT_DEBUG("Starting Process %s(%s) right now", process->argv[0], sg_host_get_name(host));
416 if (simix_global->create_process_function)
417 process_created = simix_global->create_process_function(
418 (char*)(process->argv)[0],
421 sg_host_get_name(host),
424 (char**)(process->argv),
425 current_property_set,
428 process_created = simcall_process_create((char*)(process->argv)[0], parse_code, NULL, sg_host_get_name(host), kill_time, process->argc,
429 (char**)process->argv, current_property_set,auto_restart);
431 /* verify if process has been created (won't be the case if the host is currently dead, but that's fine) */
432 if (!process_created) {
436 current_property_set = NULL;
439 void sg_platf_route_begin (sg_platf_route_cbarg_t route){
440 route->link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
442 void sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute){
443 ASroute->link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
446 void sg_platf_route_end (sg_platf_route_cbarg_t route){
447 sg_platf_new_route(route);
449 void sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute){
450 sg_platf_new_ASroute(ASroute);
453 void sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route){
454 char *link_name = xbt_strdup(link_id);
455 xbt_dynar_push(route->link_list, &link_name);
457 void sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute){
458 char *link_name = xbt_strdup(link_id);
459 xbt_dynar_push(ASroute->link_list, &link_name);
462 void sg_platf_begin() { /* Do nothing: just for symmetry of user code */ }
464 void sg_platf_end() {
465 unsigned int iterator;
467 xbt_dynar_foreach(sg_platf_postparse_cb_list, iterator, fun) {
472 void sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS)
474 if (!surf_parse_models_setup_already_called) {
475 /* Initialize the surf models. That must be done after we got all config, and before we need the models.
476 * That is, after the last <config> tag, if any, and before the first of cluster|peer|AS|trace|trace_connect
478 * I'm not sure for <trace> and <trace_connect>, there may be a bug here
479 * (FIXME: check it out by creating a file beginning with one of these tags)
480 * but cluster and peer create ASes internally, so putting the code in there is ok.
482 * TODO, There used to be a guard protecting here against
483 * xbt_dynar_length(sg_platf_AS_begin_cb_list) because we don't want to
484 * initialize the models if we are parsing the file to get the deployment.
485 * That could happen if the same file would be used for platf and deploy:
486 * it'd contain AS tags even during the deploy parsing. Removing that guard
487 * would result of the models to get re-inited when parsing for deploy.
488 * Currently using the same file for platform and deployment is broken
489 * however. This guard will have to ba adapted in order to make this feature
492 surf_parse_models_setup_already_called = 1;
493 surf_config_models_setup();
496 routing_AS_begin(AS);
497 if (TRACE_is_enabled())
498 sg_instr_AS_begin(AS);
501 void sg_platf_new_AS_end()
504 if (TRACE_is_enabled())
508 /* ***************************************** */
509 /* TUTORIAL: New TAG */
511 void sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu) {
512 unsigned int iterator;
514 xbt_dynar_foreach(sg_platf_gpu_cb_list, iterator, fun) {
519 void sg_platf_gpu_add_cb(sg_platf_gpu_cb_t fct) {
520 xbt_dynar_push(sg_platf_gpu_cb_list, &fct);
523 /* ***************************************** */
525 void sg_platf_link_add_cb(sg_platf_link_cb_t fct) {
526 xbt_dynar_push(sg_platf_link_cb_list, &fct);
528 void sg_platf_cluster_add_cb(sg_platf_cluster_cb_t fct) {
529 xbt_dynar_push(sg_platf_cluster_cb_list, &fct);
531 void sg_platf_cabinet_add_cb(sg_platf_cabinet_cb_t fct) {
532 xbt_dynar_push(sg_platf_cabinet_cb_list, &fct);
534 void sg_platf_postparse_add_cb(void_f_void_t fct) {
535 xbt_dynar_push(sg_platf_postparse_cb_list, &fct);
537 void sg_platf_ASroute_add_cb(sg_platf_route_cb_t fct) {
538 xbt_dynar_push(sg_platf_ASroute_cb_list, &fct);
540 void sg_platf_bypassRoute_add_cb(sg_platf_route_cb_t fct) {
541 xbt_dynar_push(sg_platf_bypassRoute_cb_list, &fct);
543 void sg_platf_bypassASroute_add_cb(sg_platf_route_cb_t fct) {
544 xbt_dynar_push(sg_platf_bypassASroute_cb_list, &fct);
546 void sg_platf_prop_add_cb(sg_platf_prop_cb_t fct) {
547 xbt_dynar_push(sg_platf_prop_cb_list, &fct);
549 void sg_platf_trace_add_cb(sg_platf_trace_cb_t fct) {
550 xbt_dynar_push(sg_platf_trace_cb_list, &fct);
552 void sg_platf_trace_connect_add_cb(sg_platf_trace_connect_cb_t fct) {
553 xbt_dynar_push(sg_platf_trace_connect_cb_list, &fct);
555 void sg_platf_rng_stream_init(unsigned long seed[6]) {
556 RngStream_SetPackageSeed(seed);
557 sg_platf_rng_stream = RngStream_CreateStream(NULL);
560 RngStream sg_platf_rng_stream_get(const char* id) {
561 RngStream stream = NULL;
562 unsigned int id_hash;
564 stream = RngStream_CopyStream(sg_platf_rng_stream);
565 id_hash = xbt_str_hash(id);
566 RngStream_AdvanceState(stream, 0, (long)id_hash);