src/surf/sg_platf.c

   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
  14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_parse);
  15 xbt_dynar_t sg_platf_host_cb_list = NULL;   // of sg_platf_host_cb_t
  16 xbt_dynar_t sg_platf_host_link_cb_list = NULL;   // of sg_platf_host_link_cb_t
  17 xbt_dynar_t sg_platf_link_cb_list = NULL;   // of sg_platf_link_cb_t
  18 xbt_dynar_t sg_platf_router_cb_list = NULL; // of sg_platf_router_cb_t
  19 xbt_dynar_t sg_platf_peer_cb_list = NULL; // of sg_platf_peer_cb_t
  20 xbt_dynar_t sg_platf_cluster_cb_list = NULL; // of sg_platf_cluster_cb_t
  21 xbt_dynar_t sg_platf_cabinet_cb_list = NULL; // of sg_platf_cluster_cb_t
  22 xbt_dynar_t sg_platf_AS_begin_cb_list = NULL; //of sg_platf_AS_begin_cb_t
  23 xbt_dynar_t sg_platf_AS_end_cb_list = NULL; //of void_f_void_t
  24 xbt_dynar_t sg_platf_postparse_cb_list = NULL; // of void_f_void_t
  25 xbt_dynar_t sg_platf_prop_cb_list = NULL; // of sg_platf_prop_cb_t
  26
  27 xbt_dynar_t sg_platf_route_cb_list = NULL; // of sg_platf_route_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
  31
  32 xbt_dynar_t sg_platf_trace_cb_list = NULL;
  33 xbt_dynar_t sg_platf_trace_connect_cb_list = NULL;
  34
  35 xbt_dynar_t sg_platf_storage_cb_list = NULL; // of sg_platf_storage_cb_t
  36 xbt_dynar_t sg_platf_storage_type_cb_list = NULL; // of sg_platf_storage_cb_t
  37 xbt_dynar_t sg_platf_mstorage_cb_list = NULL; // of sg_platf_storage_cb_t
  38 xbt_dynar_t sg_platf_mount_cb_list = NULL; // of sg_platf_storage_cb_t
  39
  40 xbt_dynar_t sg_platf_process_cb_list = NULL;
  41
  42 /* ***************************************** */
  43 /* TUTORIAL: New TAG                         */
  44
  45 xbt_dynar_t sg_platf_gpu_cb_list = NULL;
  46 /* ***************************************** */
  47
  48
  49 static int surf_parse_models_setup_already_called;
  50
  51 /* one RngStream for the platform, to respect some statistic rules */
  52 static RngStream sg_platf_rng_stream = NULL;
  53
  54 /** Module management function: creates all internal data structures */
  55 void sg_platf_init(void) {
  56
  57   //FIXME : Ugly, but useful...
  58   if(sg_platf_host_cb_list)
  59     return; //Already initialized, so do nothing...
  60
  61   sg_platf_host_cb_list = xbt_dynar_new(sizeof(sg_platf_host_cb_t), NULL);
  62   sg_platf_host_link_cb_list = xbt_dynar_new(sizeof(sg_platf_host_link_cb_t), NULL);
  63   sg_platf_router_cb_list = xbt_dynar_new(sizeof(sg_platf_router_cb_t), NULL);
  64   sg_platf_link_cb_list = xbt_dynar_new(sizeof(sg_platf_link_cb_t), NULL);
  65   sg_platf_peer_cb_list = xbt_dynar_new(sizeof(sg_platf_peer_cb_t), NULL);
  66   sg_platf_cluster_cb_list = xbt_dynar_new(sizeof(sg_platf_cluster_cb_t), NULL);
  67   sg_platf_cabinet_cb_list = xbt_dynar_new(sizeof(sg_platf_cabinet_cb_t), NULL);
  68   sg_platf_postparse_cb_list = xbt_dynar_new(sizeof(sg_platf_link_cb_t),NULL);
  69   sg_platf_AS_begin_cb_list = xbt_dynar_new(sizeof(sg_platf_AS_cb_t),NULL);
  70   sg_platf_AS_end_cb_list = xbt_dynar_new(sizeof(sg_platf_AS_cb_t),NULL);
  71   sg_platf_prop_cb_list = xbt_dynar_new(sizeof(sg_platf_prop_cb_t),NULL);
  72
  73   sg_platf_route_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
  74   sg_platf_ASroute_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
  75   sg_platf_bypassRoute_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
  76   sg_platf_bypassASroute_cb_list = xbt_dynar_new(sizeof(sg_platf_route_cb_t), NULL);
  77
  78   sg_platf_trace_cb_list = xbt_dynar_new(sizeof(sg_platf_trace_cb_t), NULL);
  79   sg_platf_trace_connect_cb_list = xbt_dynar_new(sizeof(sg_platf_trace_connect_cb_t), NULL);
  80
  81   sg_platf_storage_cb_list = xbt_dynar_new(sizeof(sg_platf_storage_cb_t), NULL);
  82   sg_platf_storage_type_cb_list = xbt_dynar_new(sizeof(sg_platf_storage_cb_t), NULL);
  83   sg_platf_mstorage_cb_list = xbt_dynar_new(sizeof(sg_platf_storage_cb_t), NULL);
  84   sg_platf_mount_cb_list = xbt_dynar_new(sizeof(sg_platf_storage_cb_t), NULL);
  85
  86   sg_platf_process_cb_list = xbt_dynar_new(sizeof(sg_platf_process_cb_t), NULL);
  87
  88   /* ***************************************** */
  89   /* TUTORIAL: New TAG                         */
  90
  91   sg_platf_gpu_cb_list = xbt_dynar_new(sizeof(sg_platf_gpu_cb_t), NULL);
  92   /* ***************************************** */
  93 }
  94 /** Module management function: frees all internal data structures */
  95 void sg_platf_exit(void) {
  96   xbt_dynar_free(&sg_platf_host_cb_list);
  97   xbt_dynar_free(&sg_platf_host_link_cb_list);
  98   xbt_dynar_free(&sg_platf_router_cb_list);
  99   xbt_dynar_free(&sg_platf_link_cb_list);
 100   xbt_dynar_free(&sg_platf_postparse_cb_list);
 101   xbt_dynar_free(&sg_platf_peer_cb_list);
 102   xbt_dynar_free(&sg_platf_cluster_cb_list);
 103   xbt_dynar_free(&sg_platf_cabinet_cb_list);
 104   xbt_dynar_free(&sg_platf_AS_begin_cb_list);
 105   xbt_dynar_free(&sg_platf_AS_end_cb_list);
 106   xbt_dynar_free(&sg_platf_prop_cb_list);
 107
 108   xbt_dynar_free(&sg_platf_trace_cb_list);
 109   xbt_dynar_free(&sg_platf_trace_connect_cb_list);
 110
 111   xbt_dynar_free(&sg_platf_route_cb_list);
 112   xbt_dynar_free(&sg_platf_ASroute_cb_list);
 113   xbt_dynar_free(&sg_platf_bypassRoute_cb_list);
 114   xbt_dynar_free(&sg_platf_bypassASroute_cb_list);
 115
 116   xbt_dynar_free(&sg_platf_storage_cb_list);
 117   xbt_dynar_free(&sg_platf_storage_type_cb_list);
 118   xbt_dynar_free(&sg_platf_mstorage_cb_list);
 119   xbt_dynar_free(&sg_platf_mount_cb_list);
 120
 121   xbt_dynar_free(&sg_platf_process_cb_list);
 122
 123   /* ***************************************** */
 124   /* TUTORIAL: New TAG                         */
 125
 126   xbt_dynar_free(&sg_platf_gpu_cb_list);
 127
 128   /* ***************************************** */
 129
 130   /* make sure that we will reinit the models while loading the platf once reinited */
 131   surf_parse_models_setup_already_called = 0;
 132 }
 133
 134 void sg_platf_new_host(sg_platf_host_cbarg_t h){
 135   unsigned int iterator;
 136   sg_platf_host_cb_t fun;
 137   xbt_dynar_foreach(sg_platf_host_cb_list, iterator, fun) {
 138     fun(h);
 139   }
 140 }
 141 void sg_platf_new_host_link(sg_platf_host_link_cbarg_t h){
 142   unsigned int iterator;
 143   sg_platf_host_link_cb_t fun;
 144   xbt_dynar_foreach(sg_platf_host_link_cb_list, iterator, fun) {
 145     fun(h);
 146   }
 147 }
 148 void sg_platf_new_router(sg_platf_router_cbarg_t router) {
 149   unsigned int iterator;
 150   sg_platf_router_cb_t fun;
 151   xbt_dynar_foreach(sg_platf_router_cb_list, iterator, fun) {
 152     fun(router);
 153   }
 154 }
 155 void sg_platf_new_link(sg_platf_link_cbarg_t link){
 156   unsigned int iterator;
 157   sg_platf_link_cb_t fun;
 158   xbt_dynar_foreach(sg_platf_link_cb_list, iterator, fun) {
 159     fun(link);
 160   }
 161 }
 162
 163 void sg_platf_new_peer(sg_platf_peer_cbarg_t peer){
 164   unsigned int iterator;
 165   sg_platf_peer_cb_t fun;
 166   xbt_dynar_foreach(sg_platf_peer_cb_list, iterator, fun) {
 167     fun(peer);
 168   }
 169 }
 170 void sg_platf_new_cluster(sg_platf_cluster_cbarg_t cluster){
 171   unsigned int iterator;
 172   sg_platf_cluster_cb_t fun;
 173   xbt_dynar_foreach(sg_platf_cluster_cb_list, iterator, fun) {
 174     fun(cluster);
 175   }
 176 }
 177 void sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet){
 178   unsigned int iterator;
 179   sg_platf_cabinet_cb_t fun;
 180   xbt_dynar_foreach(sg_platf_cabinet_cb_list, iterator, fun) {
 181     fun(cabinet);
 182   }
 183 }
 184 void sg_platf_new_storage(sg_platf_storage_cbarg_t storage){
 185   unsigned int iterator;
 186   sg_platf_storage_cb_t fun;
 187   xbt_dynar_foreach(sg_platf_storage_cb_list, iterator, fun) {
 188     fun(storage);
 189   }
 190 }
 191 void sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type){
 192   unsigned int iterator;
 193   sg_platf_storage_type_cb_t fun;
 194   xbt_dynar_foreach(sg_platf_storage_type_cb_list, iterator, fun) {
 195     fun(storage_type);
 196   }
 197 }
 198 void sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage){
 199   unsigned int iterator;
 200   sg_platf_mstorage_cb_t fun;
 201   xbt_dynar_foreach(sg_platf_mstorage_cb_list, iterator, fun) {
 202     fun(mstorage);
 203   }
 204 }
 205 void sg_platf_new_mount(sg_platf_mount_cbarg_t mount){
 206   unsigned int iterator;
 207   sg_platf_mount_cb_t fun;
 208   xbt_dynar_foreach(sg_platf_mount_cb_list, iterator, fun) {
 209     fun(mount);
 210   }
 211 }
 212 void sg_platf_new_route(sg_platf_route_cbarg_t route) {
 213   unsigned int iterator;
 214   sg_platf_route_cb_t fun;
 215   xbt_dynar_foreach(sg_platf_route_cb_list, iterator, fun) {
 216     fun(route);
 217   }
 218 }
 219 void sg_platf_new_ASroute(sg_platf_route_cbarg_t ASroute) {
 220   unsigned int iterator;
 221   sg_platf_route_cb_t fun;
 222   xbt_dynar_foreach(sg_platf_ASroute_cb_list, iterator, fun) {
 223     fun(ASroute);
 224   }
 225 }
 226 void sg_platf_new_bypassRoute(sg_platf_route_cbarg_t bypassRoute) {
 227   unsigned int iterator;
 228   sg_platf_route_cb_t fun;
 229   xbt_dynar_foreach(sg_platf_bypassRoute_cb_list, iterator, fun) {
 230     fun(bypassRoute);
 231   }
 232 }
 233 void sg_platf_new_bypassASroute(sg_platf_route_cbarg_t bypassASroute) {
 234   unsigned int iterator;
 235   sg_platf_route_cb_t fun;
 236   xbt_dynar_foreach(sg_platf_bypassASroute_cb_list, iterator, fun) {
 237     fun(bypassASroute);
 238   }
 239 }
 240 void sg_platf_new_prop(sg_platf_prop_cbarg_t prop) {
 241   unsigned int iterator;
 242   sg_platf_prop_cb_t fun;
 243   xbt_dynar_foreach(sg_platf_prop_cb_list, iterator, fun) {
 244     fun(prop);
 245   }
 246 }
 247 void sg_platf_new_trace(sg_platf_trace_cbarg_t trace) {
 248   unsigned int iterator;
 249   sg_platf_trace_cb_t fun;
 250   xbt_dynar_foreach(sg_platf_trace_cb_list, iterator, fun) {
 251     fun(trace);
 252   }
 253 }
 254 void sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect) {
 255   unsigned int iterator;
 256   sg_platf_trace_connect_cb_t fun;
 257   xbt_dynar_foreach(sg_platf_trace_connect_cb_list, iterator, fun) {
 258     fun(trace_connect);
 259   }
 260 }
 261 void sg_platf_new_process(sg_platf_process_cbarg_t process){
 262   unsigned int iterator;
 263   sg_platf_process_cb_t fun;
 264   xbt_dynar_foreach(sg_platf_process_cb_list, iterator, fun) {
 265     fun(process);
 266   }
 267 }
 268
 269 void sg_platf_route_begin (sg_platf_route_cbarg_t route){
 270   route->link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
 271 }
 272 void sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute){
 273   ASroute->link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
 274 }
 275
 276 void sg_platf_route_end (sg_platf_route_cbarg_t route){
 277   sg_platf_new_route(route);
 278 }
 279 void sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute){
 280   sg_platf_new_ASroute(ASroute);
 281 }
 282
 283 void sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route){
 284   char *link_name = xbt_strdup(link_id);
 285   xbt_dynar_push(route->link_list, &link_name);
 286 }
 287 void sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute){
 288   char *link_name = xbt_strdup(link_id);
 289   xbt_dynar_push(ASroute->link_list, &link_name);
 290 }
 291
 292 void sg_platf_begin() { /* Do nothing: just for symmetry of user code */ }
 293
 294 void sg_platf_end() {
 295   unsigned int iterator;
 296   void_f_void_t fun;
 297   xbt_dynar_foreach(sg_platf_postparse_cb_list, iterator, fun) {
 298     fun();
 299   }
 300 }
 301
 302 static int surf_parse_models_setup_already_called = 0;
 303
 304 void sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS) {
 305   unsigned int iterator;
 306   sg_platf_AS_cb_t fun;
 307
 308   if (!surf_parse_models_setup_already_called && !xbt_dynar_is_empty(sg_platf_AS_begin_cb_list)) {
 309     /* Initialize the surf models. That must be done after we got all config, and before we need the models.
 310      * That is, after the last <config> tag, if any, and before the first of cluster|peer|AS|trace|trace_connect
 311      *
 312      * I'm not sure for <trace> and <trace_connect>, there may be a bug here
 313      * (FIXME: check it out by creating a file beginning with one of these tags)
 314      * but cluster and peer create ASes internally, so putting the code in there is ok.
 315      *
 316      * We are also guarding against xbt_dynar_length(sg_platf_AS_begin_cb_list) because we don't
 317      * want to initialize the models if we are parsing the file to get the deployment. That could happen if
 318      * the same file would be used for platf and deploy: it'd contain AS tags even during the deploy parsing.
 319      * Removing that guard would result of the models to get re-inited when parsing for deploy.
 320      */
 321     surf_parse_models_setup_already_called = 1;
 322     surf_config_models_setup();
 323   }
 324
 325   xbt_dynar_foreach(sg_platf_AS_begin_cb_list, iterator, fun) {
 326     fun(AS);
 327   }
 328 }
 329
 330 void sg_platf_new_AS_end() {
 331   unsigned int iterator;
 332   void_f_void_t fun;
 333   xbt_dynar_foreach(sg_platf_AS_end_cb_list, iterator, fun) {
 334     fun();
 335   }
 336 }
 337
 338 /* ***************************************** */
 339 /* TUTORIAL: New TAG                         */
 340
 341 void sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu) {
 342   unsigned int iterator;
 343   void_f_void_t fun;
 344   xbt_dynar_foreach(sg_platf_gpu_cb_list, iterator, fun) {
 345     fun();
 346   }
 347 }
 348
 349 void sg_platf_gpu_add_cb(sg_platf_gpu_cb_t fct) {
 350   xbt_dynar_push(sg_platf_gpu_cb_list, &fct);
 351 }
 352
 353 /* ***************************************** */
 354
 355
 356 void sg_platf_host_add_cb(sg_platf_host_cb_t fct) {
 357   xbt_dynar_push(sg_platf_host_cb_list, &fct);
 358 }
 359 void sg_platf_host_link_add_cb(sg_platf_host_link_cb_t fct) {
 360   xbt_dynar_push(sg_platf_host_link_cb_list, &fct);
 361 }
 362 void sg_platf_link_add_cb(sg_platf_link_cb_t fct) {
 363   xbt_dynar_push(sg_platf_link_cb_list, &fct);
 364 }
 365 void sg_platf_router_add_cb(sg_platf_router_cb_t fct) {
 366   xbt_dynar_push(sg_platf_router_cb_list, &fct);
 367 }
 368 void sg_platf_peer_add_cb(sg_platf_peer_cb_t fct) {
 369   xbt_dynar_push(sg_platf_peer_cb_list, &fct);
 370 }
 371 void sg_platf_cluster_add_cb(sg_platf_cluster_cb_t fct) {
 372   xbt_dynar_push(sg_platf_cluster_cb_list, &fct);
 373 }
 374 void sg_platf_cabinet_add_cb(sg_platf_cabinet_cb_t fct) {
 375   xbt_dynar_push(sg_platf_cabinet_cb_list, &fct);
 376 }
 377 void sg_platf_postparse_add_cb(void_f_void_t fct) {
 378   xbt_dynar_push(sg_platf_postparse_cb_list, &fct);
 379 }
 380 void sg_platf_AS_begin_add_cb(sg_platf_AS_cb_t fct) {
 381   xbt_dynar_push(sg_platf_AS_begin_cb_list, &fct);
 382 }
 383 void sg_platf_AS_end_add_cb(sg_platf_AS_cb_t fct) {
 384   xbt_dynar_push(sg_platf_AS_end_cb_list, &fct);
 385 }
 386 void sg_platf_storage_add_cb(sg_platf_storage_cb_t fct) {
 387   xbt_dynar_push(sg_platf_storage_cb_list, &fct);
 388 }
 389 void sg_platf_storage_type_add_cb(sg_platf_storage_type_cb_t fct) {
 390   xbt_dynar_push(sg_platf_storage_type_cb_list, &fct);
 391 }
 392 void sg_platf_mstorage_add_cb(sg_platf_mstorage_cb_t fct) {
 393   xbt_dynar_push(sg_platf_mstorage_cb_list, &fct);
 394 }
 395 void sg_platf_mount_add_cb(sg_platf_mount_cb_t fct) {
 396   xbt_dynar_push(sg_platf_mount_cb_list, &fct);
 397 }
 398 void sg_platf_route_add_cb(sg_platf_route_cb_t fct) {
 399   xbt_dynar_push(sg_platf_route_cb_list, &fct);
 400 }
 401 void sg_platf_ASroute_add_cb(sg_platf_route_cb_t fct) {
 402   xbt_dynar_push(sg_platf_ASroute_cb_list, &fct);
 403 }
 404 void sg_platf_bypassRoute_add_cb(sg_platf_route_cb_t fct) {
 405   xbt_dynar_push(sg_platf_bypassRoute_cb_list, &fct);
 406 }
 407 void sg_platf_bypassASroute_add_cb(sg_platf_route_cb_t fct) {
 408   xbt_dynar_push(sg_platf_bypassASroute_cb_list, &fct);
 409 }
 410 void sg_platf_prop_add_cb(sg_platf_prop_cb_t fct) {
 411   xbt_dynar_push(sg_platf_prop_cb_list, &fct);
 412 }
 413 void sg_platf_trace_add_cb(sg_platf_trace_cb_t fct) {
 414   xbt_dynar_push(sg_platf_trace_cb_list, &fct);
 415 }
 416 void sg_platf_trace_connect_add_cb(sg_platf_trace_connect_cb_t fct) {
 417   xbt_dynar_push(sg_platf_trace_connect_cb_list, &fct);
 418 }
 419 void sg_platf_rng_stream_init(unsigned long seed[6]) {
 420   RngStream_SetPackageSeed(seed);
 421   sg_platf_rng_stream = RngStream_CreateStream(NULL);
 422 }
 423 void sg_platf_process_add_cb(sg_platf_process_cb_t fct) {
 424   xbt_dynar_push(sg_platf_process_cb_list, &fct);
 425 }
 426
 427 RngStream sg_platf_rng_stream_get(const char* id) {
 428   RngStream stream = NULL;
 429   unsigned int id_hash;
 430
 431   stream = RngStream_CopyStream(sg_platf_rng_stream);
 432   id_hash = xbt_str_hash(id);
 433   RngStream_AdvanceState(stream, 0, (long)id_hash);
 434
 435   return stream;
 436 }