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 "host_interface.hpp"
   8 #include "surf_interface.hpp"
   9 #include "network_interface.hpp"
  10 #include "surf_routing_cluster.hpp"
  11 #include "instr/instr_private.h"
  12 #include "plugins/energy.hpp"
  13 #include "vm_interface.hpp"
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_kernel);
  16
  17 /*********
  18  * TOOLS *
  19  *********/
  20
  21 static Host *get_casted_host(surf_resource_t resource){
  22   return static_cast<Host*>(surf_host_resource_priv(resource));
  23 }
  24
  25 static VM *get_casted_vm(surf_resource_t resource){
  26   return static_cast<VM*>(surf_host_resource_priv(resource));
  27 }
  28
  29 char *surf_routing_edge_name(sg_routing_edge_t edge){
  30   return edge->getName();
  31 }
  32
  33 extern double NOW;
  34 extern double *surf_mins; /* return value of share_resources for each model */
  35 extern int surf_min_index;       /* current index in surf_mins */
  36 extern double surf_min;               /* duration determined by surf_solve */
  37
  38 void surf_presolve(void)
  39 {
  40   double next_event_date = -1.0;
  41   tmgr_trace_event_t event = NULL;
  42   double value = -1.0;
  43   Resource *resource = NULL;
  44   Model *model = NULL;
  45   unsigned int iter;
  46
  47   XBT_DEBUG
  48       ("First Run! Let's \"purge\" events and put models in the right state");
  49   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
  50     if (next_event_date > NOW)
  51       break;
  52     while ((event =
  53             tmgr_history_get_next_event_leq(history, next_event_date,
  54                                             &value,
  55                                             (void **) &resource))) {
  56       if (value >= 0){
  57         resource->updateState(event, value, NOW);
  58       }
  59     }
  60   }
  61   xbt_dynar_foreach(model_list, iter, model)
  62       model->updateActionsState(NOW, 0.0);
  63 }
  64
  65 /**
  66  * Computes when the next action executed in a
  67  * specific model terminates; this is important,
  68  * because we can safely skip the amount of time
  69  * in which no model (read: not even a single one)
  70  * changes its state; so, if for instance network,
  71  * cpu, storage don't change (and if we assume they're
  72  * the only models we use... simple example here :) )
  73  * for 2s, 1s, 3s then we can skip 1s as after this
  74  * amount of time the new state needs to be considered.
  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   Resource *resource = NULL;
 102   Model *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<Model*>(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 host_CLM03 object. It has
 217    * surf_resource at the generic_resource field. */
 218   Resource *ws = static_cast<Resource*>(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<AsCluster*>(as)->p_backbone;
 224 }
 225
 226 void surf_as_cluster_set_backbone(AS_t as, void* backbone){
 227   static_cast<AsCluster*>(as)->p_backbone = static_cast<Link*>(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_host_model_execute_parallel_task(surf_host_model_t model,
 271                                                     int host_nb,
 272                                             void **host_list,
 273                                             double *flops_amount,
 274                                             double *bytes_amount,
 275                                             double rate){
 276   return static_cast<Action*>(model->executeParallelTask(host_nb, host_list, flops_amount, bytes_amount, rate));
 277 }
 278
 279 surf_action_t surf_host_model_communicate(surf_host_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate){
 280   return model->communicate(get_casted_host(src), get_casted_host(dst), size, rate);
 281 }
 282
 283 xbt_dynar_t surf_host_model_get_route(surf_host_model_t /*model*/,
 284                                              surf_resource_t src, surf_resource_t dst){
 285   xbt_dynar_t route = NULL;
 286   routing_platf->getRouteAndLatency(get_casted_host(src)->p_netElm,
 287                                             get_casted_host(dst)->p_netElm, &route, NULL);
 288   return route;
 289 }
 290
 291 void surf_vm_model_create(const char *name, surf_resource_t ind_phys_host){
 292   surf_vm_model->createVM(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_host_sleep(surf_resource_t resource, double duration){
 316   return get_casted_host(resource)->sleep(duration);
 317 }
 318
 319 double surf_host_get_speed(surf_resource_t resource, double load){
 320   return get_casted_host(resource)->getSpeed(load);
 321 }
 322
 323 double surf_host_get_available_speed(surf_resource_t resource){
 324   return get_casted_host(resource)->getAvailableSpeed();
 325 }
 326
 327 int surf_host_get_core(surf_resource_t resource){
 328   return get_casted_host(resource)->getCore();
 329 }
 330
 331 surf_action_t surf_host_execute(surf_resource_t resource, double size){
 332   return get_casted_host(resource)->execute(size);
 333 }
 334
 335 double surf_host_get_current_power_peak(surf_resource_t resource){
 336   return get_casted_host(resource)->getCurrentPowerPeak();
 337 }
 338
 339 double surf_host_get_power_peak_at(surf_resource_t resource, int pstate_index){
 340   return get_casted_host(resource)->getPowerPeakAt(pstate_index);
 341 }
 342
 343 int surf_host_get_nb_pstates(surf_resource_t resource){
 344   return get_casted_host(resource)->getNbPstates();
 345 }
 346
 347 void surf_host_set_pstate(surf_resource_t resource, int pstate_index){
 348   get_casted_host(resource)->setPstate(pstate_index);
 349 }
 350 int surf_host_get_pstate(surf_resource_t resource){
 351   return get_casted_host(resource)->getPstate();
 352 }
 353 double surf_host_get_wattmin_at(surf_resource_t resource, int pstate){
 354   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 355   std::map<Cpu*, CpuEnergy*>::iterator cpuIt = surf_energy->find(get_casted_host(resource)->p_cpu);
 356   return cpuIt->second->getWattMinAt(pstate);
 357 }
 358 double surf_host_get_wattmax_at(surf_resource_t resource, int pstate){
 359   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 360   std::map<Cpu*, CpuEnergy*>::iterator cpuIt = surf_energy->find(get_casted_host(resource)->p_cpu);
 361   return cpuIt->second->getWattMaxAt(pstate);
 362 }
 363
 364 double surf_host_get_consumed_energy(surf_resource_t resource){
 365   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 366   std::map<Cpu*, CpuEnergy*>::iterator cpuIt = surf_energy->find(get_casted_host(resource)->p_cpu);
 367   return cpuIt->second->getConsumedEnergy();
 368 }
 369
 370 xbt_dict_t surf_host_get_mounted_storage_list(surf_resource_t host){
 371   return get_casted_host(host)->getMountedStorageList();
 372 }
 373
 374 xbt_dynar_t surf_host_get_attached_storage_list(surf_resource_t host){
 375   return get_casted_host(host)->getAttachedStorageList();
 376 }
 377
 378 surf_action_t surf_host_open(surf_resource_t host, const char* fullpath){
 379   return get_casted_host(host)->open(fullpath);
 380 }
 381
 382 surf_action_t surf_host_close(surf_resource_t host, surf_file_t fd){
 383   return get_casted_host(host)->close(fd);
 384 }
 385
 386 int surf_host_unlink(surf_resource_t host, surf_file_t fd){
 387   return get_casted_host(host)->unlink(fd);
 388 }
 389
 390 size_t surf_host_get_size(surf_resource_t host, surf_file_t fd){
 391   return get_casted_host(host)->getSize(fd);
 392 }
 393
 394 surf_action_t surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size){
 395   return get_casted_host(host)->read(fd, size);
 396 }
 397
 398 surf_action_t surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size){
 399   return get_casted_host(host)->write(fd, size);
 400 }
 401
 402 xbt_dynar_t surf_host_get_info(surf_resource_t host, surf_file_t fd){
 403   return get_casted_host(host)->getInfo(fd);
 404 }
 405
 406 size_t surf_host_file_tell(surf_resource_t host, surf_file_t fd){
 407   return get_casted_host(host)->fileTell(fd);
 408 }
 409
 410 int surf_host_file_seek(surf_resource_t host, surf_file_t fd,
 411                                sg_offset_t offset, int origin){
 412   return get_casted_host(host)->fileSeek(fd, offset, origin);
 413 }
 414
 415 int surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath){
 416   return get_casted_host(host)->fileMove(fd, fullpath);
 417 }
 418
 419 xbt_dynar_t surf_host_get_vms(surf_resource_t host){
 420   xbt_dynar_t vms = get_casted_host(host)->getVms();
 421   xbt_dynar_t vms_ = xbt_dynar_new(sizeof(sg_host_t), NULL);
 422   unsigned int cpt;
 423   VM *vm;
 424   xbt_dynar_foreach(vms, cpt, vm) {
 425     sg_host_t vm_ = xbt_lib_get_elm_or_null(host_lib, vm->getName());
 426     xbt_dynar_push(vms_, &vm_);
 427   }
 428   xbt_dynar_free(&vms);
 429   return vms_;
 430 }
 431
 432 void surf_host_get_params(surf_resource_t host, ws_params_t params){
 433   get_casted_host(host)->getParams(params);
 434 }
 435
 436 void surf_host_set_params(surf_resource_t host, ws_params_t params){
 437   get_casted_host(host)->setParams(params);
 438 }
 439
 440 void surf_vm_destroy(surf_resource_t resource){
 441   /* Before clearing the entries in host_lib, we have to pick up resources. */
 442   VM *vm = get_casted_vm(resource);
 443   char* name = xbt_dict_get_elm_key(resource);
 444   /* We deregister objects from host_lib, without invoking the freeing callback
 445    * of each level.
 446    *
 447    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
 448    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
 449    */
 450   sg_host_surfcpu_destroy((sg_host_t)resource);
 451   sg_host_edge_destroy((sg_host_t)resource,1);
 452   xbt_lib_unset(host_lib, name, SURF_HOST_LEVEL, 0);
 453
 454   /* TODO: comment out when VM storage is implemented. */
 455   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
 456
 457   delete vm;
 458 }
 459
 460 void surf_vm_suspend(surf_resource_t vm){
 461   get_casted_vm(vm)->suspend();
 462 }
 463
 464 void surf_vm_resume(surf_resource_t vm){
 465   get_casted_vm(vm)->resume();
 466 }
 467
 468 void surf_vm_save(surf_resource_t vm){
 469   get_casted_vm(vm)->save();
 470 }
 471
 472 void surf_vm_restore(surf_resource_t vm){
 473   get_casted_vm(vm)->restore();
 474 }
 475
 476 void surf_vm_migrate(surf_resource_t vm, surf_resource_t ind_vm_ws_dest){
 477   get_casted_vm(vm)->migrate(ind_vm_ws_dest);
 478 }
 479
 480 surf_resource_t surf_vm_get_pm(surf_resource_t vm){
 481   return get_casted_vm(vm)->getPm();
 482 }
 483
 484 void surf_vm_set_bound(surf_resource_t vm, double bound){
 485   return get_casted_vm(vm)->setBound(bound);
 486 }
 487
 488 void surf_vm_set_affinity(surf_resource_t vm, surf_resource_t cpu, unsigned long mask){
 489   return get_casted_vm(vm)->setAffinity(sg_host_surfcpu(cpu), mask);
 490 }
 491
 492 xbt_dict_t surf_storage_get_content(surf_resource_t resource){
 493   return static_cast<Storage*>(surf_storage_resource_priv(resource))->getContent();
 494 }
 495
 496 sg_size_t surf_storage_get_size(surf_resource_t resource){
 497   return static_cast<Storage*>(surf_storage_resource_priv(resource))->getSize();
 498 }
 499
 500 sg_size_t surf_storage_get_free_size(surf_resource_t resource){
 501   return static_cast<Storage*>(surf_storage_resource_priv(resource))->getFreeSize();
 502 }
 503
 504 sg_size_t surf_storage_get_used_size(surf_resource_t resource){
 505   return static_cast<Storage*>(surf_storage_resource_priv(resource))->getUsedSize();
 506 }
 507
 508 const char* surf_storage_get_host(surf_resource_t resource){
 509   return static_cast<Storage*>(surf_storage_resource_priv(resource))->p_attach;
 510 }
 511
 512 surf_action_t surf_cpu_execute(surf_resource_t cpu, double size){
 513   return sg_host_surfcpu(cpu)->execute(size);
 514 }
 515
 516 surf_action_t surf_cpu_sleep(surf_resource_t cpu, double duration){
 517   return sg_host_surfcpu(cpu)->sleep(duration);
 518 }
 519
 520 double surf_action_get_start_time(surf_action_t action){
 521   return action->getStartTime();
 522 }
 523
 524 double surf_action_get_finish_time(surf_action_t action){
 525   return action->getFinishTime();
 526 }
 527
 528 double surf_action_get_remains(surf_action_t action){
 529   return action->getRemains();
 530 }
 531
 532 void surf_action_unref(surf_action_t action){
 533   action->unref();
 534 }
 535
 536 void surf_action_suspend(surf_action_t action){
 537   action->suspend();
 538 }
 539
 540 void surf_action_resume(surf_action_t action){
 541   action->resume();
 542 }
 543
 544 void surf_action_cancel(surf_action_t action){
 545   action->cancel();
 546 }
 547
 548 void surf_action_set_priority(surf_action_t action, double priority){
 549   action->setPriority(priority);
 550 }
 551
 552 void surf_action_set_category(surf_action_t action, const char *category){
 553   action->setCategory(category);
 554 }
 555
 556 void *surf_action_get_data(surf_action_t action){
 557   return action->getData();
 558 }
 559
 560 void surf_action_set_data(surf_action_t action, void *data){
 561   action->setData(data);
 562 }
 563
 564 e_surf_action_state_t surf_action_get_state(surf_action_t action){
 565   return action->getState();
 566 }
 567
 568 double surf_action_get_cost(surf_action_t action){
 569   return action->getCost();
 570 }
 571
 572 void surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask) {
 573   static_cast<CpuAction*>(action)->setAffinity(sg_host_surfcpu(cpu), mask);
 574 }
 575
 576 void surf_cpu_action_set_bound(surf_action_t action, double bound) {
 577   static_cast<CpuAction*>(action)->setBound(bound);
 578 }
 579
 580 #ifdef HAVE_LATENCY_BOUND_TRACKING
 581 double surf_network_action_get_latency_limited(surf_action_t action) {
 582   return static_cast<NetworkActionPtr>(action)->getLatencyLimited();
 583 }
 584 #endif
 585
 586 surf_file_t surf_storage_action_get_file(surf_action_t action){
 587   return static_cast<StorageAction*>(action)->p_file;
 588 }