src/surf/surf_c_bindings.cpp

   1 /* Copyright (c) 2013-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 "surf_interface.hpp"
   8 #include "workstation_interface.hpp"
   9 #include "vm_workstation_interface.hpp"
  10 #include "network_interface.hpp"
  11 #include "surf_routing_cluster.hpp"
  12 #include "instr/instr_private.h"
  13 #include "plugins/energy.hpp"
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_kernel);
  16
  17 /*********
  18  * TOOLS *
  19  *********/
  20
  21 static CpuPtr get_casted_cpu(surf_resource_t resource){
  22   return static_cast<CpuPtr>(surf_cpu_resource_priv(resource));
  23 }
  24
  25 static WorkstationPtr get_casted_workstation(surf_resource_t resource){
  26   return static_cast<WorkstationPtr>(surf_workstation_resource_priv(resource));
  27 }
  28
  29 static RoutingEdgePtr get_casted_routing(surf_resource_t resource){
  30   return static_cast<RoutingEdgePtr>(surf_routing_resource_priv(resource));
  31 }
  32
  33 static WorkstationVMPtr get_casted_vm_workstation(surf_resource_t resource){
  34   return static_cast<WorkstationVMPtr>(surf_workstation_resource_priv(resource));
  35 }
  36
  37 char *surf_routing_edge_name(sg_routing_edge_t edge){
  38   return edge->getName();
  39 }
  40
  41 #ifdef CONTEXT_THREADS
  42 //FIXME:keeporremove static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
  43 #endif
  44
  45 extern double NOW;
  46 extern double *surf_mins; /* return value of share_resources for each model */
  47 extern int surf_min_index;       /* current index in surf_mins */
  48 extern double surf_min;               /* duration determined by surf_solve */
  49
  50 void surf_presolve(void)
  51 {
  52   double next_event_date = -1.0;
  53   tmgr_trace_event_t event = NULL;
  54   double value = -1.0;
  55   ResourcePtr resource = NULL;
  56   ModelPtr model = NULL;
  57   unsigned int iter;
  58
  59   XBT_DEBUG
  60       ("First Run! Let's \"purge\" events and put models in the right state");
  61   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
  62     if (next_event_date > NOW)
  63       break;
  64     while ((event =
  65             tmgr_history_get_next_event_leq(history, next_event_date,
  66                                             &value,
  67                                             (void **) &resource))) {
  68       if (value >= 0){
  69         resource->updateState(event, value, NOW);
  70       }
  71     }
  72   }
  73   xbt_dynar_foreach(model_list, iter, model)
  74       model->updateActionsState(NOW, 0.0);
  75 }
  76
  77 static void surf_share_resources(surf_model_t model)
  78 {
  79   double next_action_end = -1.0;
  80   int i = __sync_fetch_and_add(&surf_min_index, 1);
  81   if (strcmp(model->getName(), "network NS3")) {
  82     XBT_DEBUG("Running for Resource [%s]", model->getName());
  83     next_action_end = model->shareResources(NOW);
  84     XBT_DEBUG("Resource [%s] : next action end = %f",
  85         model->getName(), next_action_end);
  86   }
  87   surf_mins[i] = next_action_end;
  88 }
  89
  90 static void surf_update_actions_state(surf_model_t model)
  91 {
  92   model->updateActionsState(NOW, surf_min);
  93 }
  94
  95 double surf_solve(double max_date)
  96 {
  97   surf_min = -1.0; /* duration */
  98   double next_event_date = -1.0;
  99   double model_next_action_end = -1.0;
 100   double value = -1.0;
 101   ResourcePtr resource = NULL;
 102   ModelPtr model = NULL;
 103   tmgr_trace_event_t event = NULL;
 104   unsigned int iter;
 105
 106   if(!host_that_restart)
 107     host_that_restart = xbt_dynar_new(sizeof(char*), NULL);
 108
 109   if (max_date != -1.0 && max_date != NOW) {
 110     surf_min = max_date - NOW;
 111   }
 112
 113   XBT_DEBUG("Looking for next action end for all models except NS3");
 114
 115   if (surf_mins == NULL) {
 116     surf_mins = xbt_new(double, xbt_dynar_length(model_list_invoke));
 117   }
 118   surf_min_index = 0;
 119
 120   /* sequential version */
 121   xbt_dynar_foreach(model_list_invoke, iter, model) {
 122     surf_share_resources(static_cast<ModelPtr>(model));
 123   }
 124
 125   unsigned i;
 126   for (i = 0; i < xbt_dynar_length(model_list_invoke); i++) {
 127     if ((surf_min < 0.0 || surf_mins[i] < surf_min)
 128         && surf_mins[i] >= 0.0) {
 129       surf_min = surf_mins[i];
 130     }
 131   }
 132
 133   XBT_DEBUG("Min for resources (remember that NS3 don't update that value) : %f", surf_min);
 134
 135   XBT_DEBUG("Looking for next trace event");
 136
 137   do {
 138     XBT_DEBUG("Next TRACE event : %f", next_event_date);
 139
 140     next_event_date = tmgr_history_next_date(history);
 141
 142     if(!strcmp(surf_network_model->getName(), "network NS3")){
 143       if(next_event_date!=-1.0 && surf_min!=-1.0) {
 144         surf_min = MIN(next_event_date - NOW, surf_min);
 145       } else{
 146         surf_min = MAX(next_event_date - NOW, surf_min);
 147       }
 148
 149       XBT_DEBUG("Run for network at most %f", surf_min);
 150       // run until min or next flow
 151       model_next_action_end = surf_network_model->shareResources(surf_min);
 152
 153       XBT_DEBUG("Min for network : %f", model_next_action_end);
 154       if(model_next_action_end>=0.0)
 155         surf_min = model_next_action_end;
 156     }
 157
 158     if (next_event_date < 0.0) {
 159       XBT_DEBUG("no next TRACE event. Stop searching for it");
 160       break;
 161     }
 162
 163     if ((surf_min == -1.0) || (next_event_date > NOW + surf_min)) break;
 164
 165     XBT_DEBUG("Updating models (min = %g, NOW = %g, next_event_date = %g)", surf_min, NOW, next_event_date);
 166     while ((event =
 167             tmgr_history_get_next_event_leq(history, next_event_date,
 168                                             &value,
 169                                             (void **) &resource))) {
 170       if (resource->isUsed() || xbt_dict_get_or_null(watched_hosts_lib, resource->getName())) {
 171         surf_min = next_event_date - NOW;
 172         XBT_DEBUG
 173             ("This event will modify model state. Next event set to %f",
 174              surf_min);
 175       }
 176       /* update state of model_obj according to new value. Does not touch lmm.
 177          It will be modified if needed when updating actions */
 178       XBT_DEBUG("Calling update_resource_state for resource %s with min %f",
 179              resource->getName(), surf_min);
 180       resource->updateState(event, value, next_event_date);
 181     }
 182   } while (1);
 183
 184   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
 185    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
 186    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
 187   if (surf_min == -1.0) {
 188   XBT_DEBUG("No next event at all. Bail out now.");
 189     return -1.0;
 190   }
 191
 192   XBT_DEBUG("Duration set to %f", surf_min);
 193
 194   NOW = NOW + surf_min;
 195   /* FIXME: model_list or model_list_invoke? revisit here later */
 196   /* sequential version */
 197   xbt_dynar_foreach(model_list, iter, model) {
 198     surf_update_actions_state(model);
 199   }
 200
 201   TRACE_paje_dump_buffer (0);
 202
 203   return surf_min;
 204 }
 205
 206 void routing_get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
 207                               xbt_dynar_t * route, double *latency){
 208   routing_platf->getRouteAndLatency(src, dst, route, latency);
 209 }
 210
 211 /*********
 212  * MODEL *
 213  *********/
 214
 215 surf_model_t surf_resource_model(const void *host, int level) {
 216   /* If level is SURF_WKS_LEVEL, ws is a workstation_CLM03 object. It has
 217    * surf_resource at the generic_resource field. */
 218   ResourcePtr ws = static_cast<ResourcePtr>(xbt_lib_get_level((xbt_dictelm_t) host, level));
 219   return ws->getModel();
 220 }
 221
 222 void *surf_as_cluster_get_backbone(AS_t as){
 223   return static_cast<AsClusterPtr>(as)->p_backbone;
 224 }
 225
 226 void surf_as_cluster_set_backbone(AS_t as, void* backbone){
 227   static_cast<AsClusterPtr>(as)->p_backbone = static_cast<NetworkLinkPtr>(backbone);
 228 }
 229
 230 const char *surf_model_name(surf_model_t model){
 231   return model->getName();
 232 }
 233
 234 surf_action_t surf_model_extract_done_action_set(surf_model_t model){
 235   if (model->getDoneActionSet()->empty())
 236         return NULL;
 237   surf_action_t res = &model->getDoneActionSet()->front();
 238   model->getDoneActionSet()->pop_front();
 239   return res;
 240 }
 241
 242 surf_action_t surf_model_extract_failed_action_set(surf_model_t model){
 243   if (model->getFailedActionSet()->empty())
 244         return NULL;
 245   surf_action_t res = &model->getFailedActionSet()->front();
 246   model->getFailedActionSet()->pop_front();
 247   return res;
 248 }
 249
 250 surf_action_t surf_model_extract_ready_action_set(surf_model_t model){
 251   if (model->getReadyActionSet()->empty())
 252         return NULL;
 253   surf_action_t res = &model->getReadyActionSet()->front();
 254   model->getReadyActionSet()->pop_front();
 255   return res;
 256 }
 257
 258 surf_action_t surf_model_extract_running_action_set(surf_model_t model){
 259   if (model->getRunningActionSet()->empty())
 260         return NULL;
 261   surf_action_t res = &model->getRunningActionSet()->front();
 262   model->getRunningActionSet()->pop_front();
 263   return res;
 264 }
 265
 266 int surf_model_running_action_set_size(surf_model_t model){
 267   return model->getRunningActionSet()->size();
 268 }
 269
 270 surf_action_t surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
 271                                                     int workstation_nb,
 272                                             void **workstation_list,
 273                                             double *flops_amount,
 274                                             double *bytes_amount,
 275                                             double rate){
 276   return static_cast<ActionPtr>(model->executeParallelTask(workstation_nb, workstation_list, flops_amount, bytes_amount, rate));
 277 }
 278
 279 surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate){
 280   return model->communicate(get_casted_workstation(src), get_casted_workstation(dst), size, rate);
 281 }
 282
 283 xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t /*model*/,
 284                                              surf_resource_t src, surf_resource_t dst){
 285   xbt_dynar_t route = NULL;
 286   routing_platf->getRouteAndLatency(get_casted_workstation(src)->p_netElm,
 287                                             get_casted_workstation(dst)->p_netElm, &route, NULL);
 288   return route;
 289 }
 290
 291 void surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host){
 292   surf_vm_workstation_model->createWorkstationVM(name, ind_phys_host);
 293 }
 294
 295 surf_action_t surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate){
 296   return model->communicate(src, dst, size, rate);
 297 }
 298
 299 const char *surf_resource_name(surf_cpp_resource_t resource){
 300   return resource->getName();
 301 }
 302
 303 xbt_dict_t surf_resource_get_properties(surf_cpp_resource_t resource){
 304   return resource->getProperties();
 305 }
 306
 307 e_surf_resource_state_t surf_resource_get_state(surf_cpp_resource_t resource){
 308   return resource->getState();
 309 }
 310
 311 void surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state){
 312   resource->setState(state);
 313 }
 314
 315 surf_action_t surf_workstation_sleep(surf_resource_t resource, double duration){
 316   return get_casted_workstation(resource)->sleep(duration);
 317 }
 318
 319 double surf_workstation_get_speed(surf_resource_t resource, double load){
 320   return get_casted_workstation(resource)->getSpeed(load);
 321 }
 322
 323 double surf_workstation_get_available_speed(surf_resource_t resource){
 324   return get_casted_workstation(resource)->getAvailableSpeed();
 325 }
 326
 327 int surf_workstation_get_core(surf_resource_t resource){
 328   return get_casted_workstation(resource)->getCore();
 329 }
 330
 331 surf_action_t surf_workstation_execute(surf_resource_t resource, double size){
 332   return get_casted_workstation(resource)->execute(size);
 333 }
 334
 335 double surf_workstation_get_current_power_peak(surf_resource_t resource){
 336   return get_casted_workstation(resource)->getCurrentPowerPeak();
 337 }
 338
 339 double surf_workstation_get_power_peak_at(surf_resource_t resource, int pstate_index){
 340   return get_casted_workstation(resource)->getPowerPeakAt(pstate_index);
 341 }
 342
 343 int surf_workstation_get_nb_pstates(surf_resource_t resource){
 344   return get_casted_workstation(resource)->getNbPstates();
 345 }
 346
 347 void surf_workstation_set_power_peak_at(surf_resource_t resource, int pstate_index){
 348   return get_casted_workstation(resource)->setPowerPeakAt(pstate_index);
 349 }
 350
 351 double surf_workstation_get_consumed_energy(surf_resource_t resource){
 352   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active.");
 353   std::map<CpuPtr, CpuEnergyPtr>::iterator cpuIt = surf_energy->find(get_casted_workstation(resource)->p_cpu);
 354   return cpuIt->second->getConsumedEnergy();
 355 }
 356
 357 xbt_dict_t surf_workstation_get_mounted_storage_list(surf_resource_t workstation){
 358   return get_casted_workstation(workstation)->getMountedStorageList();
 359 }
 360
 361 xbt_dynar_t surf_workstation_get_attached_storage_list(surf_resource_t workstation){
 362   return get_casted_workstation(workstation)->getAttachedStorageList();
 363 }
 364
 365 surf_action_t surf_workstation_open(surf_resource_t workstation, const char* fullpath){
 366   return get_casted_workstation(workstation)->open(fullpath);
 367 }
 368
 369 surf_action_t surf_workstation_close(surf_resource_t workstation, surf_file_t fd){
 370   return get_casted_workstation(workstation)->close(fd);
 371 }
 372
 373 int surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd){
 374   return get_casted_workstation(workstation)->unlink(fd);
 375 }
 376
 377 size_t surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd){
 378   return get_casted_workstation(workstation)->getSize(fd);
 379 }
 380
 381 surf_action_t surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size){
 382   return get_casted_workstation(resource)->read(fd, size);
 383 }
 384
 385 surf_action_t surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size){
 386   return get_casted_workstation(resource)->write(fd, size);
 387 }
 388
 389 xbt_dynar_t surf_workstation_get_info(surf_resource_t resource, surf_file_t fd){
 390   return get_casted_workstation(resource)->getInfo(fd);
 391 }
 392
 393 size_t surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd){
 394   return get_casted_workstation(workstation)->fileTell(fd);
 395 }
 396
 397 int surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd,
 398                                sg_offset_t offset, int origin){
 399   return get_casted_workstation(workstation)->fileSeek(fd, offset, origin);
 400 }
 401
 402 int surf_workstation_file_move(surf_resource_t workstation, surf_file_t fd, const char* fullpath){
 403   return get_casted_workstation(workstation)->fileMove(fd, fullpath);
 404 }
 405
 406 xbt_dynar_t surf_workstation_get_vms(surf_resource_t resource){
 407   xbt_dynar_t vms = get_casted_workstation(resource)->getVms();
 408   xbt_dynar_t vms_ = xbt_dynar_new(sizeof(smx_host_t), NULL);
 409   unsigned int cpt;
 410   WorkstationVMPtr vm;
 411   xbt_dynar_foreach(vms, cpt, vm) {
 412     smx_host_t vm_ = xbt_lib_get_elm_or_null(host_lib, vm->getName());
 413     xbt_dynar_push(vms_, &vm_);
 414   }
 415   xbt_dynar_free(&vms);
 416   return vms_;
 417 }
 418
 419 void surf_workstation_get_params(surf_resource_t resource, ws_params_t params){
 420   get_casted_workstation(resource)->getParams(params);
 421 }
 422
 423 void surf_workstation_set_params(surf_resource_t resource, ws_params_t params){
 424   get_casted_workstation(resource)->setParams(params);
 425 }
 426
 427 void surf_vm_workstation_destroy(surf_resource_t resource){
 428   /* ind_phys_workstation equals to smx_host_t */
 429   //surf_resource_t ind_vm_workstation = xbt_lib_get_elm_or_null(host_lib, getName());
 430
 431   /* Before clearing the entries in host_lib, we have to pick up resources. */
 432   CpuPtr cpu = get_casted_cpu(resource);
 433   WorkstationVMPtr vm = get_casted_vm_workstation(resource);
 434   RoutingEdgePtr routing = get_casted_routing(resource);
 435   char* name = xbt_dict_get_elm_key(resource);
 436   /* We deregister objects from host_lib, without invoking the freeing callback
 437    * of each level.
 438    *
 439    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
 440    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
 441    */
 442   xbt_lib_unset(host_lib, name, SURF_CPU_LEVEL, 0);
 443   xbt_lib_unset(host_lib, name, ROUTING_HOST_LEVEL, 0);
 444   xbt_lib_unset(host_lib, name, SURF_WKS_LEVEL, 0);
 445
 446   /* TODO: comment out when VM storage is implemented. */
 447   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
 448
 449   delete cpu;
 450   delete vm;
 451   delete routing;
 452 }
 453
 454 void surf_vm_workstation_suspend(surf_resource_t resource){
 455   get_casted_vm_workstation(resource)->suspend();
 456 }
 457
 458 void surf_vm_workstation_resume(surf_resource_t resource){
 459   get_casted_vm_workstation(resource)->resume();
 460 }
 461
 462 void surf_vm_workstation_save(surf_resource_t resource){
 463   get_casted_vm_workstation(resource)->save();
 464 }
 465
 466 void surf_vm_workstation_restore(surf_resource_t resource){
 467   get_casted_vm_workstation(resource)->restore();
 468 }
 469
 470 void surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest){
 471   get_casted_vm_workstation(resource)->migrate(ind_vm_ws_dest);
 472 }
 473
 474 surf_resource_t surf_vm_workstation_get_pm(surf_resource_t resource){
 475   return get_casted_vm_workstation(resource)->getPm();
 476 }
 477
 478 void surf_vm_workstation_set_bound(surf_resource_t resource, double bound){
 479   return get_casted_vm_workstation(resource)->setBound(bound);
 480 }
 481
 482 void surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask){
 483   return get_casted_vm_workstation(resource)->setAffinity(get_casted_cpu(cpu), mask);
 484 }
 485
 486 int surf_network_link_is_shared(surf_cpp_resource_t link){
 487   return static_cast<NetworkLinkPtr>(link)->isShared();
 488 }
 489
 490 double surf_network_link_get_bandwidth(surf_cpp_resource_t link){
 491   return static_cast<NetworkLinkPtr>(link)->getBandwidth();
 492 }
 493
 494 double surf_network_link_get_latency(surf_cpp_resource_t link){
 495   return static_cast<NetworkLinkPtr>(link)->getLatency();
 496 }
 497
 498 xbt_dict_t surf_storage_get_content(surf_resource_t resource){
 499   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getContent();
 500 }
 501
 502 sg_size_t surf_storage_get_size(surf_resource_t resource){
 503   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getSize();
 504 }
 505
 506 sg_size_t surf_storage_get_free_size(surf_resource_t resource){
 507   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getFreeSize();
 508 }
 509
 510 sg_size_t surf_storage_get_used_size(surf_resource_t resource){
 511   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getUsedSize();
 512 }
 513
 514 const char* surf_storage_get_host(surf_resource_t resource){
 515   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->p_attach;
 516 }
 517
 518 surf_action_t surf_cpu_execute(surf_resource_t cpu, double size){
 519   return get_casted_cpu(cpu)->execute(size);
 520 }
 521
 522 surf_action_t surf_cpu_sleep(surf_resource_t cpu, double duration){
 523   return get_casted_cpu(cpu)->sleep(duration);
 524 }
 525
 526 double surf_action_get_start_time(surf_action_t action){
 527   return action->getStartTime();
 528 }
 529
 530 double surf_action_get_finish_time(surf_action_t action){
 531   return action->getFinishTime();
 532 }
 533
 534 double surf_action_get_remains(surf_action_t action){
 535   return action->getRemains();
 536 }
 537
 538 void surf_action_unref(surf_action_t action){
 539   action->unref();
 540 }
 541
 542 void surf_action_suspend(surf_action_t action){
 543   action->suspend();
 544 }
 545
 546 void surf_action_resume(surf_action_t action){
 547   action->resume();
 548 }
 549
 550 void surf_action_cancel(surf_action_t action){
 551   action->cancel();
 552 }
 553
 554 void surf_action_set_priority(surf_action_t action, double priority){
 555   action->setPriority(priority);
 556 }
 557
 558 void surf_action_set_category(surf_action_t action, const char *category){
 559   action->setCategory(category);
 560 }
 561
 562 void *surf_action_get_data(surf_action_t action){
 563   return action->getData();
 564 }
 565
 566 void surf_action_set_data(surf_action_t action, void *data){
 567   action->setData(data);
 568 }
 569
 570 e_surf_action_state_t surf_action_get_state(surf_action_t action){
 571   return action->getState();
 572 }
 573
 574 double surf_action_get_cost(surf_action_t action){
 575   return action->getCost();
 576 }
 577
 578 void surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask) {
 579   static_cast<CpuActionPtr>(action)->setAffinity(get_casted_cpu(cpu), mask);
 580 }
 581
 582 void surf_cpu_action_set_bound(surf_action_t action, double bound) {
 583   static_cast<CpuActionPtr>(action)->setBound(bound);
 584 }
 585
 586 #ifdef HAVE_LATENCY_BOUND_TRACKING
 587 double surf_network_action_get_latency_limited(surf_action_t action) {
 588   return static_cast<NetworkActionPtr>(action)->getLatencyLimited();
 589 }
 590 #endif
 591
 592 surf_file_t surf_storage_action_get_file(surf_action_t action){
 593   return static_cast<StorageActionPtr>(action)->p_file;
 594 }