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 #ifdef HAVE_TRACING
 202   TRACE_paje_dump_buffer (0);
 203 #endif
 204
 205   return surf_min;
 206 }
 207
 208 void routing_get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
 209                               xbt_dynar_t * route, double *latency){
 210   routing_platf->getRouteAndLatency(src, dst, route, latency);
 211 }
 212
 213 /*********
 214  * MODEL *
 215  *********/
 216
 217 surf_model_t surf_resource_model(const void *host, int level) {
 218   /* If level is SURF_WKS_LEVEL, ws is a workstation_CLM03 object. It has
 219    * surf_resource at the generic_resource field. */
 220   ResourcePtr ws = static_cast<ResourcePtr>(xbt_lib_get_level((xbt_dictelm_t) host, level));
 221   return ws->getModel();
 222 }
 223
 224 void *surf_as_cluster_get_backbone(AS_t as){
 225   return static_cast<AsClusterPtr>(as)->p_backbone;
 226 }
 227
 228 void surf_as_cluster_set_backbone(AS_t as, void* backbone){
 229   static_cast<AsClusterPtr>(as)->p_backbone = static_cast<NetworkLinkPtr>(backbone);
 230 }
 231
 232 const char *surf_model_name(surf_model_t model){
 233   return model->getName();
 234 }
 235
 236 surf_action_t surf_model_extract_done_action_set(surf_model_t model){
 237   if (model->getDoneActionSet()->empty())
 238         return NULL;
 239   surf_action_t res = &model->getDoneActionSet()->front();
 240   model->getDoneActionSet()->pop_front();
 241   return res;
 242 }
 243
 244 surf_action_t surf_model_extract_failed_action_set(surf_model_t model){
 245   if (model->getFailedActionSet()->empty())
 246         return NULL;
 247   surf_action_t res = &model->getFailedActionSet()->front();
 248   model->getFailedActionSet()->pop_front();
 249   return res;
 250 }
 251
 252 surf_action_t surf_model_extract_ready_action_set(surf_model_t model){
 253   if (model->getReadyActionSet()->empty())
 254         return NULL;
 255   surf_action_t res = &model->getReadyActionSet()->front();
 256   model->getReadyActionSet()->pop_front();
 257   return res;
 258 }
 259
 260 surf_action_t surf_model_extract_running_action_set(surf_model_t model){
 261   if (model->getRunningActionSet()->empty())
 262         return NULL;
 263   surf_action_t res = &model->getRunningActionSet()->front();
 264   model->getRunningActionSet()->pop_front();
 265   return res;
 266 }
 267
 268 int surf_model_running_action_set_size(surf_model_t model){
 269   return model->getRunningActionSet()->size();
 270 }
 271
 272 surf_action_t surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
 273                                                     int workstation_nb,
 274                                             void **workstation_list,
 275                                             double *computation_amount,
 276                                             double *communication_amount,
 277                                             double rate){
 278   return static_cast<ActionPtr>(model->executeParallelTask(workstation_nb, workstation_list, computation_amount, communication_amount, rate));
 279 }
 280
 281 surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate){
 282   return model->communicate(get_casted_workstation(src), get_casted_workstation(dst), size, rate);
 283 }
 284
 285 xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t /*model*/,
 286                                              surf_resource_t src, surf_resource_t dst){
 287   xbt_dynar_t route = NULL;
 288   routing_platf->getRouteAndLatency(get_casted_workstation(src)->p_netElm,
 289                                             get_casted_workstation(dst)->p_netElm, &route, NULL);
 290   return route;
 291 }
 292
 293 void surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host){
 294   surf_vm_workstation_model->createWorkstationVM(name, ind_phys_host);
 295 }
 296
 297 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){
 298   return model->communicate(src, dst, size, rate);
 299 }
 300
 301 const char *surf_resource_name(surf_cpp_resource_t resource){
 302   return resource->getName();
 303 }
 304
 305 xbt_dict_t surf_resource_get_properties(surf_cpp_resource_t resource){
 306   return resource->getProperties();
 307 }
 308
 309 e_surf_resource_state_t surf_resource_get_state(surf_cpp_resource_t resource){
 310   return resource->getState();
 311 }
 312
 313 void surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state){
 314   resource->setState(state);
 315 }
 316
 317 surf_action_t surf_workstation_sleep(surf_resource_t resource, double duration){
 318   return get_casted_workstation(resource)->sleep(duration);
 319 }
 320
 321 double surf_workstation_get_speed(surf_resource_t resource, double load){
 322   return get_casted_workstation(resource)->getSpeed(load);
 323 }
 324
 325 double surf_workstation_get_available_speed(surf_resource_t resource){
 326   return get_casted_workstation(resource)->getAvailableSpeed();
 327 }
 328
 329 int surf_workstation_get_core(surf_resource_t resource){
 330   return get_casted_workstation(resource)->getCore();
 331 }
 332
 333 surf_action_t surf_workstation_execute(surf_resource_t resource, double size){
 334   return get_casted_workstation(resource)->execute(size);
 335 }
 336
 337 double surf_workstation_get_current_power_peak(surf_resource_t resource){
 338   return get_casted_workstation(resource)->getCurrentPowerPeak();
 339 }
 340
 341 double surf_workstation_get_power_peak_at(surf_resource_t resource, int pstate_index){
 342   return get_casted_workstation(resource)->getPowerPeakAt(pstate_index);
 343 }
 344
 345 int surf_workstation_get_nb_pstates(surf_resource_t resource){
 346   return get_casted_workstation(resource)->getNbPstates();
 347 }
 348
 349 void surf_workstation_set_power_peak_at(surf_resource_t resource, int pstate_index){
 350   return get_casted_workstation(resource)->setPowerPeakAt(pstate_index);
 351 }
 352
 353 double surf_workstation_get_consumed_energy(surf_resource_t resource){
 354   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active.");
 355   std::map<CpuPtr, CpuEnergyPtr>::iterator cpuIt = surf_energy->find(get_casted_workstation(resource)->p_cpu);
 356   return cpuIt->second->getConsumedEnergy();
 357 }
 358
 359 xbt_dict_t surf_workstation_get_mounted_storage_list(surf_resource_t workstation){
 360   return get_casted_workstation(workstation)->getMountedStorageList();
 361 }
 362
 363 xbt_dynar_t surf_workstation_get_attached_storage_list(surf_resource_t workstation){
 364   return get_casted_workstation(workstation)->getAttachedStorageList();
 365 }
 366
 367 surf_action_t surf_workstation_open(surf_resource_t workstation, const char* fullpath){
 368   return get_casted_workstation(workstation)->open(fullpath);
 369 }
 370
 371 surf_action_t surf_workstation_close(surf_resource_t workstation, surf_file_t fd){
 372   return get_casted_workstation(workstation)->close(fd);
 373 }
 374
 375 int surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd){
 376   return get_casted_workstation(workstation)->unlink(fd);
 377 }
 378
 379 size_t surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd){
 380   return get_casted_workstation(workstation)->getSize(fd);
 381 }
 382
 383 surf_action_t surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size){
 384   return get_casted_workstation(resource)->read(fd, size);
 385 }
 386
 387 surf_action_t surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size){
 388   return get_casted_workstation(resource)->write(fd, size);
 389 }
 390
 391 xbt_dynar_t surf_workstation_get_info(surf_resource_t resource, surf_file_t fd){
 392   return get_casted_workstation(resource)->getInfo(fd);
 393 }
 394
 395 size_t surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd){
 396   return get_casted_workstation(workstation)->fileTell(fd);
 397 }
 398
 399 int surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd,
 400                                sg_offset_t offset, int origin){
 401   return get_casted_workstation(workstation)->fileSeek(fd, offset, origin);
 402 }
 403
 404 int surf_workstation_file_move(surf_resource_t workstation, surf_file_t fd, const char* fullpath){
 405   return get_casted_workstation(workstation)->fileMove(fd, fullpath);
 406 }
 407
 408 xbt_dynar_t surf_workstation_get_vms(surf_resource_t resource){
 409   xbt_dynar_t vms = get_casted_workstation(resource)->getVms();
 410   xbt_dynar_t vms_ = xbt_dynar_new(sizeof(smx_host_t), NULL);
 411   unsigned int cpt;
 412   WorkstationVMPtr vm;
 413   xbt_dynar_foreach(vms, cpt, vm) {
 414     smx_host_t vm_ = xbt_lib_get_elm_or_null(host_lib, vm->getName());
 415     xbt_dynar_push(vms_, &vm_);
 416   }
 417   xbt_dynar_free(&vms);
 418   return vms_;
 419 }
 420
 421 void surf_workstation_get_params(surf_resource_t resource, ws_params_t params){
 422   get_casted_workstation(resource)->getParams(params);
 423 }
 424
 425 void surf_workstation_set_params(surf_resource_t resource, ws_params_t params){
 426   get_casted_workstation(resource)->setParams(params);
 427 }
 428
 429 void surf_vm_workstation_destroy(surf_resource_t resource){
 430   /* ind_phys_workstation equals to smx_host_t */
 431   //surf_resource_t ind_vm_workstation = xbt_lib_get_elm_or_null(host_lib, getName());
 432
 433   /* Before clearing the entries in host_lib, we have to pick up resources. */
 434   CpuPtr cpu = get_casted_cpu(resource);
 435   WorkstationVMPtr vm = get_casted_vm_workstation(resource);
 436   RoutingEdgePtr routing = get_casted_routing(resource);
 437   char* name = xbt_dict_get_elm_key(resource);
 438   /* We deregister objects from host_lib, without invoking the freeing callback
 439    * of each level.
 440    *
 441    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
 442    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
 443    */
 444   xbt_lib_unset(host_lib, name, SURF_CPU_LEVEL, 0);
 445   xbt_lib_unset(host_lib, name, ROUTING_HOST_LEVEL, 0);
 446   xbt_lib_unset(host_lib, name, SURF_WKS_LEVEL, 0);
 447
 448   /* TODO: comment out when VM storage is implemented. */
 449   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
 450
 451   delete cpu;
 452   delete vm;
 453   delete routing;
 454 }
 455
 456 void surf_vm_workstation_suspend(surf_resource_t resource){
 457   get_casted_vm_workstation(resource)->suspend();
 458 }
 459
 460 void surf_vm_workstation_resume(surf_resource_t resource){
 461   get_casted_vm_workstation(resource)->resume();
 462 }
 463
 464 void surf_vm_workstation_save(surf_resource_t resource){
 465   get_casted_vm_workstation(resource)->save();
 466 }
 467
 468 void surf_vm_workstation_restore(surf_resource_t resource){
 469   get_casted_vm_workstation(resource)->restore();
 470 }
 471
 472 void surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest){
 473   get_casted_vm_workstation(resource)->migrate(ind_vm_ws_dest);
 474 }
 475
 476 surf_resource_t surf_vm_workstation_get_pm(surf_resource_t resource){
 477   return get_casted_vm_workstation(resource)->getPm();
 478 }
 479
 480 void surf_vm_workstation_set_bound(surf_resource_t resource, double bound){
 481   return get_casted_vm_workstation(resource)->setBound(bound);
 482 }
 483
 484 void surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask){
 485   return get_casted_vm_workstation(resource)->setAffinity(get_casted_cpu(cpu), mask);
 486 }
 487
 488 int surf_network_link_is_shared(surf_cpp_resource_t link){
 489   return static_cast<NetworkLinkPtr>(link)->isShared();
 490 }
 491
 492 double surf_network_link_get_bandwidth(surf_cpp_resource_t link){
 493   return static_cast<NetworkLinkPtr>(link)->getBandwidth();
 494 }
 495
 496 double surf_network_link_get_latency(surf_cpp_resource_t link){
 497   return static_cast<NetworkLinkPtr>(link)->getLatency();
 498 }
 499
 500 xbt_dict_t surf_storage_get_content(surf_resource_t resource){
 501   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getContent();
 502 }
 503
 504 sg_size_t surf_storage_get_size(surf_resource_t resource){
 505   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getSize();
 506 }
 507
 508 sg_size_t surf_storage_get_free_size(surf_resource_t resource){
 509   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getFreeSize();
 510 }
 511
 512 sg_size_t surf_storage_get_used_size(surf_resource_t resource){
 513   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->getUsedSize();
 514 }
 515
 516 const char* surf_storage_get_host(surf_resource_t resource){
 517   return static_cast<StoragePtr>(surf_storage_resource_priv(resource))->p_attach;
 518 }
 519
 520 surf_action_t surf_cpu_execute(surf_resource_t cpu, double size){
 521   return get_casted_cpu(cpu)->execute(size);
 522 }
 523
 524 surf_action_t surf_cpu_sleep(surf_resource_t cpu, double duration){
 525   return get_casted_cpu(cpu)->sleep(duration);
 526 }
 527
 528 double surf_action_get_start_time(surf_action_t action){
 529   return action->getStartTime();
 530 }
 531
 532 double surf_action_get_finish_time(surf_action_t action){
 533   return action->getFinishTime();
 534 }
 535
 536 double surf_action_get_remains(surf_action_t action){
 537   return action->getRemains();
 538 }
 539
 540 void surf_action_unref(surf_action_t action){
 541   action->unref();
 542 }
 543
 544 void surf_action_suspend(surf_action_t action){
 545   action->suspend();
 546 }
 547
 548 void surf_action_resume(surf_action_t action){
 549   action->resume();
 550 }
 551
 552 void surf_action_cancel(surf_action_t action){
 553   action->cancel();
 554 }
 555
 556 void surf_action_set_priority(surf_action_t action, double priority){
 557   action->setPriority(priority);
 558 }
 559
 560 #ifdef HAVE_TRACING
 561 void surf_action_set_category(surf_action_t action, const char *category){
 562   action->setCategory(category);
 563 }
 564 #endif
 565
 566 void *surf_action_get_data(surf_action_t action){
 567   return action->getData();
 568 }
 569
 570 void surf_action_set_data(surf_action_t action, void *data){
 571   action->setData(data);
 572 }
 573
 574 e_surf_action_state_t surf_action_get_state(surf_action_t action){
 575   return action->getState();
 576 }
 577
 578 double surf_action_get_cost(surf_action_t action){
 579   return action->getCost();
 580 }
 581
 582 void surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask) {
 583   static_cast<CpuActionPtr>(action)->setAffinity(get_casted_cpu(cpu), mask);
 584 }
 585
 586 void surf_cpu_action_set_bound(surf_action_t action, double bound) {
 587   static_cast<CpuActionPtr>(action)->setBound(bound);
 588 }
 589
 590 #ifdef HAVE_LATENCY_BOUND_TRACKING
 591 double surf_network_action_get_latency_limited(surf_action_t action) {
 592   return static_cast<NetworkActionPtr>(action)->getLatencyLimited();
 593 }
 594 #endif
 595
 596 surf_file_t surf_storage_action_get_file(surf_action_t action){
 597   return static_cast<StorageActionPtr>(action)->p_file;
 598 }