src/surf/sg_platf.cpp

   1 /* Copyright (c) 2006-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "xbt/misc.h"
   8 #include "xbt/log.h"
   9 #include "xbt/str.h"
  10 #include "xbt/dict.h"
  11 #include "xbt/RngStream.h"
  12 #include "simgrid/platf_interface.h"
  13 #include "surf/surf_routing.h"
  14 #include "surf/surf.h"
  15
  16 #include "src/simix/smx_private.h"
  17
  18 #include "cpu_interface.hpp"
  19 #include "host_interface.hpp"
  20
  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_postparse_cb_list = NULL; // of void_f_void_t
  25
  26 static int surf_parse_models_setup_already_called = 0;
  27
  28 /* one RngStream for the platform, to respect some statistic rules */
  29 static RngStream sg_platf_rng_stream = NULL;
  30
  31 /** Module management function: creates all internal data structures */
  32 void sg_platf_init(void) {
  33
  34   //FIXME : Ugly, but useful...
  35   if (sg_platf_postparse_cb_list)
  36     return; //Already initialized, so do nothing...
  37
  38   sg_platf_link_cb_list = xbt_dynar_new(sizeof(sg_platf_link_cb_t), NULL);
  39   sg_platf_cluster_cb_list = xbt_dynar_new(sizeof(sg_platf_cluster_cb_t), NULL);
  40   sg_platf_postparse_cb_list = xbt_dynar_new(sizeof(sg_platf_link_cb_t),NULL);
  41 }
  42
  43 /** Module management function: frees all internal data structures */
  44 void sg_platf_exit(void) {
  45   xbt_dynar_free(&sg_platf_link_cb_list);
  46   xbt_dynar_free(&sg_platf_postparse_cb_list);
  47   xbt_dynar_free(&sg_platf_cluster_cb_list);
  48
  49   /* make sure that we will reinit the models while loading the platf once reinited */
  50   surf_parse_models_setup_already_called = 0;
  51 }
  52
  53 void sg_platf_new_host(sg_platf_host_cbarg_t host)
  54 {
  55   xbt_assert(! sg_host_by_name(host->id),
  56                      "Refusing to create a second host named '%s'.", host->id);
  57
  58   simgrid::surf::RoutingEdge *net = NULL;
  59   simgrid::surf::As* current_routing = routing_get_current();
  60   if (current_routing)
  61     net = routing_add_host(current_routing, host);
  62
  63   sg_host_t h = simgrid::Host::by_name_or_create(host->id);
  64   simgrid::surf::Cpu *cpu = surf_cpu_model_pm->createCpu(
  65         host->id,
  66         host->speed_peak,
  67         host->pstate,
  68         host->speed_scale,
  69         host->speed_trace,
  70         host->core_amount,
  71         host->initial_state,
  72         host->state_trace);
  73   cpu->plug(h);
  74   surf_host_model->createHost(host->id, net, cpu, host->properties)->attach(h);
  75   if (TRACE_is_enabled() && TRACE_needs_platform())
  76     sg_instr_new_host(host);
  77 }
  78
  79 /**
  80  * \brief Add a "router" to the network element list
  81  */
  82 void sg_platf_new_router(sg_platf_router_cbarg_t router)
  83 {
  84   simgrid::surf::As* current_routing = routing_get_current();
  85
  86   if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
  87     current_routing->p_hierarchy = SURF_ROUTING_BASE;
  88   xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
  89              "Reading a router, processing unit \"%s\" already exists",
  90              router->id);
  91
  92   simgrid::surf::RoutingEdge *info = new simgrid::surf::RoutingEdgeImpl(
  93     xbt_strdup(router->id), -1, SURF_NETWORK_ELEMENT_ROUTER, current_routing);
  94   info->setId(current_routing->parsePU(info));
  95   xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
  96   XBT_DEBUG("Having set name '%s' id '%d'", router->id, info->getId());
  97   simgrid::surf::routingEdgeCreatedCallbacks(info);
  98
  99   if (router->coord && strcmp(router->coord, "")) {
 100     unsigned int cursor;
 101     char*str;
 102
 103     if (!COORD_ASR_LEVEL)
 104       xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
 105     /* Pre-parse the host coordinates */
 106     xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
 107     xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
 108     xbt_dynar_foreach(ctn_str,cursor, str) {
 109       double val = atof(str);
 110       xbt_dynar_push(ctn,&val);
 111     }
 112     xbt_dynar_shrink(ctn, 0);
 113     xbt_dynar_free(&ctn_str);
 114     xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
 115     XBT_DEBUG("Having set router coordinates for '%s'",router->id);
 116   }
 117
 118   if (TRACE_is_enabled())
 119     sg_instr_new_router(router);
 120 }
 121
 122 void sg_platf_new_link(sg_platf_link_cbarg_t link){
 123   unsigned int iterator;
 124   sg_platf_link_cb_t fun;
 125   xbt_dynar_foreach(sg_platf_link_cb_list, iterator, fun) {
 126     fun(link);
 127   }
 128 }
 129
 130 void sg_platf_new_cluster(sg_platf_cluster_cbarg_t cluster)
 131 {
 132   routing_new_cluster(cluster);
 133
 134   unsigned int iterator;
 135   sg_platf_cluster_cb_t fun;
 136   xbt_dynar_foreach(sg_platf_cluster_cb_list, iterator, fun) {
 137     fun(cluster);
 138   }
 139 }
 140
 141 void sg_platf_new_storage(sg_platf_storage_cbarg_t storage)
 142 {
 143   xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
 144                "Reading a storage, processing unit \"%s\" already exists", storage->id);
 145
 146   // Verification of an existing type_id
 147 #ifndef NDEBUG
 148   void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
 149 #endif
 150   xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
 151
 152   XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
 153       storage->id,
 154       storage->type_id,
 155       storage->content);
 156
 157   xbt_lib_set(storage_lib,
 158       storage->id,
 159       ROUTING_STORAGE_LEVEL,
 160       (void *) xbt_strdup(storage->type_id));
 161
 162   void* stype = xbt_lib_get_or_null(storage_type_lib,
 163                                     storage->type_id,
 164                                     ROUTING_STORAGE_TYPE_LEVEL);
 165   if(!stype) xbt_die("No storage type '%s'",storage->type_id);
 166
 167   // if storage content is not specified use the content of storage_type if exist
 168   if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
 169     storage->content = ((storage_type_t) stype)->content;
 170     storage->content_type = ((storage_type_t) stype)->content_type;
 171     XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s) from storage type '%s' ",
 172         storage->id,((storage_type_t) stype)->content_type,
 173         ((storage_type_t) stype)->type_id);
 174   }
 175
 176   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
 177       "\n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tcontent_type '%s' "
 178       "\n\t\tproperties '%p''\n",
 179       storage->id,
 180       ((storage_type_t) stype)->model,
 181       ((storage_type_t) stype)->type_id,
 182       storage->content,
 183       storage->content_type,
 184           storage->properties);
 185
 186   surf_storage_model->createStorage(storage->id,
 187                                      ((storage_type_t) stype)->type_id,
 188                                      storage->content,
 189                                      storage->content_type,
 190                                                                          storage->properties,
 191                                      storage->attach);
 192 }
 193 void sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type){
 194
 195   xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
 196                "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
 197
 198   storage_type_t stype = xbt_new0(s_storage_type_t, 1);
 199   stype->model = xbt_strdup(storage_type->model);
 200   stype->properties = storage_type->properties;
 201   stype->content = xbt_strdup(storage_type->content);
 202   stype->content_type = xbt_strdup(storage_type->content_type);
 203   stype->type_id = xbt_strdup(storage_type->id);
 204   stype->size = storage_type->size;
 205   stype->model_properties = storage_type->model_properties;
 206
 207   XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s', "
 208       "content '%s', and content_type '%s'",
 209       stype->type_id,
 210       stype->model,
 211       storage_type->content,
 212       storage_type->content_type);
 213
 214   xbt_lib_set(storage_type_lib,
 215       stype->type_id,
 216       ROUTING_STORAGE_TYPE_LEVEL,
 217       (void *) stype);
 218 }
 219 void sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage)
 220 {
 221   THROW_UNIMPLEMENTED;
 222 //  mount_t mnt = xbt_new0(s_mount_t, 1);
 223 //  mnt->id = xbt_strdup(mstorage->type_id);
 224 //  mnt->name = xbt_strdup(mstorage->name);
 225 //
 226 //  if(!mount_list){
 227 //    XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
 228 //    mount_list = xbt_dynar_new(sizeof(char *), NULL);
 229 //  }
 230 //  xbt_dynar_push(mount_list,(void *) mnt);
 231 //  free(mnt->id);
 232 //  free(mnt->name);
 233 //  xbt_free(mnt);
 234 //  XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
 235 }
 236
 237 static void mount_free(void *p)
 238 {
 239   mount_t mnt = (mount_t) p;
 240   xbt_free(mnt->name);
 241 }
 242
 243 void sg_platf_new_mount(sg_platf_mount_cbarg_t mount){
 244   // Verification of an existing storage
 245 #ifndef NDEBUG
 246   void* storage = xbt_lib_get_or_null(storage_lib, mount->storageId, ROUTING_STORAGE_LEVEL);
 247 #endif
 248   xbt_assert(storage,"Disk id \"%s\" does not exists", mount->storageId);
 249
 250   XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->storageId, mount->name);
 251
 252   s_mount_t mnt;
 253   mnt.storage = surf_storage_resource_priv(surf_storage_resource_by_name(mount->storageId));
 254   mnt.name = xbt_strdup(mount->name);
 255
 256   if(!mount_list){
 257     XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
 258     mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
 259   }
 260   xbt_dynar_push(mount_list, &mnt);
 261 }
 262
 263 void sg_platf_new_route(sg_platf_route_cbarg_t route)
 264 {
 265   routing_get_current()->parseRoute(route);
 266 }
 267
 268 void sg_platf_new_ASroute(sg_platf_route_cbarg_t ASroute)
 269 {
 270   routing_get_current()->parseASroute(ASroute);
 271 }
 272
 273 void sg_platf_new_bypassRoute(sg_platf_route_cbarg_t bypassRoute)
 274 {
 275   routing_get_current()->parseBypassroute(bypassRoute);
 276 }
 277
 278 void sg_platf_new_bypassASroute(sg_platf_route_cbarg_t bypassASroute)
 279 {
 280   routing_get_current()->parseBypassroute(bypassASroute);
 281 }
 282
 283 void sg_platf_new_process(sg_platf_process_cbarg_t process)
 284 {
 285   if (!simix_global)
 286     xbt_die("Cannot create process without SIMIX.");
 287
 288   sg_host_t host = sg_host_by_name(process->host);
 289   if (!host)
 290     THROWF(arg_error, 0, "Host '%s' unknown", process->host);
 291   xbt_main_func_t parse_code = SIMIX_get_registered_function(process->function);
 292   xbt_assert(parse_code, "Function '%s' unknown", process->function);
 293
 294   double start_time = process->start_time;
 295   double kill_time  = process->kill_time;
 296   int auto_restart = process->on_failure == SURF_PROCESS_ON_FAILURE_DIE ? 0 : 1;
 297
 298   smx_process_arg_t arg = NULL;
 299   smx_process_t process_created = NULL;
 300
 301   arg = xbt_new0(s_smx_process_arg_t, 1);
 302   arg->code = parse_code;
 303   arg->data = NULL;
 304   arg->hostname = sg_host_get_name(host);
 305   arg->argc = process->argc;
 306   arg->argv = xbt_new(char *,process->argc);
 307   int i;
 308   for (i=0; i<process->argc; i++)
 309     arg->argv[i] = xbt_strdup(process->argv[i]);
 310   arg->name = xbt_strdup(arg->argv[0]);
 311   arg->kill_time = kill_time;
 312   arg->properties = current_property_set;
 313   if (!sg_host_simix(host)->boot_processes) {
 314     sg_host_simix(host)->boot_processes = xbt_dynar_new(sizeof(smx_process_arg_t), _SIMIX_host_free_process_arg);
 315   }
 316   xbt_dynar_push_as(sg_host_simix(host)->boot_processes,smx_process_arg_t,arg);
 317
 318   if (start_time > SIMIX_get_clock()) {
 319     arg = xbt_new0(s_smx_process_arg_t, 1);
 320     arg->name = (char*)(process->argv)[0];
 321     arg->code = parse_code;
 322     arg->data = NULL;
 323     arg->hostname = sg_host_get_name(host);
 324     arg->argc = process->argc;
 325     arg->argv = (char**)(process->argv);
 326     arg->kill_time = kill_time;
 327     arg->properties = current_property_set;
 328
 329     XBT_DEBUG("Process %s(%s) will be started at time %f", arg->name,
 330            arg->hostname, start_time);
 331     SIMIX_timer_set(start_time, [](void* arg) {
 332       SIMIX_process_create_from_wrapper((smx_process_arg_t) arg);
 333     }, arg);
 334   } else {                      // start_time <= SIMIX_get_clock()
 335     XBT_DEBUG("Starting Process %s(%s) right now", process->argv[0], sg_host_get_name(host));
 336
 337     if (simix_global->create_process_function)
 338       process_created = simix_global->create_process_function(
 339                                             (char*)(process->argv)[0],
 340                                             parse_code,
 341                                             NULL,
 342                                             sg_host_get_name(host),
 343                                             kill_time,
 344                                             process->argc,
 345                                             (char**)(process->argv),
 346                                             current_property_set,
 347                                             auto_restart, NULL);
 348     else
 349       process_created = simcall_process_create((char*)(process->argv)[0], parse_code, NULL, sg_host_get_name(host), kill_time, process->argc,
 350           (char**)process->argv, current_property_set,auto_restart);
 351
 352     /* verify if process has been created (won't be the case if the host is currently dead, but that's fine) */
 353     if (!process_created) {
 354       return;
 355     }
 356   }
 357   current_property_set = NULL;
 358 }
 359
 360 void sg_platf_route_begin (sg_platf_route_cbarg_t route){
 361   route->link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
 362 }
 363 void sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute){
 364   ASroute->link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
 365 }
 366
 367 void sg_platf_route_end (sg_platf_route_cbarg_t route){
 368   sg_platf_new_route(route);
 369 }
 370 void sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute){
 371   sg_platf_new_ASroute(ASroute);
 372 }
 373
 374 void sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route){
 375   char *link_name = xbt_strdup(link_id);
 376   xbt_dynar_push(route->link_list, &link_name);
 377 }
 378 void sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute){
 379   char *link_name = xbt_strdup(link_id);
 380   xbt_dynar_push(ASroute->link_list, &link_name);
 381 }
 382
 383 void sg_platf_begin() { /* Do nothing: just for symmetry of user code */ }
 384
 385 void sg_platf_end() {
 386   unsigned int iterator;
 387   void_f_void_t fun;
 388   xbt_dynar_foreach(sg_platf_postparse_cb_list, iterator, fun) {
 389     fun();
 390   }
 391 }
 392
 393 void sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS)
 394 {
 395   if (!surf_parse_models_setup_already_called) {
 396     /* Initialize the surf models. That must be done after we got all config, and before we need the models.
 397      * That is, after the last <config> tag, if any, and before the first of cluster|peer|AS|trace|trace_connect
 398      *
 399      * I'm not sure for <trace> and <trace_connect>, there may be a bug here
 400      * (FIXME: check it out by creating a file beginning with one of these tags)
 401      * but cluster and peer create ASes internally, so putting the code in there is ok.
 402      *
 403      * TODO, There used to be a guard protecting here against
 404      * xbt_dynar_length(sg_platf_AS_begin_cb_list) because we don't want to
 405      * initialize the models if we are parsing the file to get the deployment.
 406      * That could happen if the same file would be used for platf and deploy:
 407      * it'd contain AS tags even during the deploy parsing. Removing that guard
 408      * would result of the models to get re-inited when parsing for deploy.
 409      * Currently using the same file for platform and deployment is broken
 410      * however. This guard will have to ba adapted in order to make this feature
 411      * work again.
 412      */
 413     surf_parse_models_setup_already_called = 1;
 414     surf_config_models_setup();
 415   }
 416
 417   routing_AS_begin(AS);
 418   if (TRACE_is_enabled())
 419     sg_instr_AS_begin(AS);
 420 }
 421
 422 void sg_platf_new_AS_end()
 423 {
 424   routing_AS_end();
 425   if (TRACE_is_enabled())
 426     sg_instr_AS_end();
 427 }
 428 /* ***************************************** */
 429
 430 void sg_platf_link_add_cb(sg_platf_link_cb_t fct) {
 431   xbt_dynar_push(sg_platf_link_cb_list, &fct);
 432 }
 433 void sg_platf_cluster_add_cb(sg_platf_cluster_cb_t fct) {
 434   xbt_dynar_push(sg_platf_cluster_cb_list, &fct);
 435 }
 436 void sg_platf_postparse_add_cb(void_f_void_t fct) {
 437   xbt_dynar_push(sg_platf_postparse_cb_list, &fct);
 438 }
 439
 440 void sg_platf_rng_stream_init(unsigned long seed[6]) {
 441   RngStream_SetPackageSeed(seed);
 442   sg_platf_rng_stream = RngStream_CreateStream(NULL);
 443 }
 444
 445 RngStream sg_platf_rng_stream_get(const char* id) {
 446   RngStream stream = NULL;
 447   unsigned int id_hash;
 448
 449   stream = RngStream_CopyStream(sg_platf_rng_stream);
 450   id_hash = xbt_str_hash(id);
 451   RngStream_AdvanceState(stream, 0, (long)id_hash);
 452
 453   return stream;
 454 }