src/surf/surf_c_bindings.cpp

   1 /* Copyright (c) 2013-2015. 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 "src/instr/instr_private.h"
  12 #include "plugins/energy.hpp"
  13 #include "virtual_machine.hpp"
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_kernel);
  16
  17 /*********
  18  * TOOLS *
  19  *********/
  20
  21 static simgrid::surf::Host *get_casted_host(sg_host_t resource){
  22   return static_cast<simgrid::surf::Host*>(surf_host_resource_priv(resource));
  23 }
  24
  25 static simgrid::surf::VirtualMachine *get_casted_vm(sg_host_t resource){
  26   return static_cast<simgrid::surf::VirtualMachine*>(surf_host_resource_priv(resource));
  27 }
  28
  29 extern double NOW;
  30
  31 void surf_presolve(void)
  32 {
  33   double next_event_date = -1.0;
  34   tmgr_trace_event_t event = NULL;
  35   double value = -1.0;
  36   simgrid::surf::Resource *resource = NULL;
  37   simgrid::surf::Model *model = NULL;
  38   unsigned int iter;
  39
  40   XBT_DEBUG ("First Run! Let's \"purge\" events and put models in the right state");
  41
  42   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
  43     if (next_event_date > NOW)
  44       break;
  45     while ((event =
  46             tmgr_history_get_next_event_leq(history, next_event_date,
  47                                             &value,
  48                                             (void **) &resource))) {
  49       if (value >= 0){
  50         resource->updateState(event, value, NOW);
  51       }
  52     }
  53   }
  54   xbt_dynar_foreach(all_existing_models, iter, model)
  55       model->updateActionsState(NOW, 0.0);
  56 }
  57
  58 double surf_solve(double max_date)
  59 {
  60   double surf_min = -1.0; /* duration */
  61   double next_event_date = -1.0;
  62   double model_next_action_end = -1.0;
  63   double value = -1.0;
  64   simgrid::surf::Resource *resource = NULL;
  65   simgrid::surf::Model *model = NULL;
  66   tmgr_trace_event_t event = NULL;
  67   unsigned int iter;
  68
  69   if(!host_that_restart)
  70     host_that_restart = xbt_dynar_new(sizeof(char*), NULL);
  71
  72   if (max_date != -1.0 && max_date != NOW) {
  73     surf_min = max_date - NOW;
  74   }
  75
  76   /* Physical models MUST be resolved first */
  77   XBT_DEBUG("Looking for next event in physical models");
  78   double next_event_phy = surf_host_model->shareResources(NOW);
  79   if ((surf_min < 0.0 || next_event_phy < surf_min) && next_event_phy >= 0.0) {
  80           surf_min = next_event_phy;
  81   }
  82   if (surf_vm_model != NULL) {
  83           XBT_DEBUG("Looking for next event in virtual models");
  84           double next_event_virt = surf_vm_model->shareResources(NOW);
  85           if ((surf_min < 0.0 || next_event_virt < surf_min) && next_event_virt >= 0.0)
  86                   surf_min = next_event_virt;
  87   }
  88
  89   XBT_DEBUG("Min for resources (remember that NS3 don't update that value) : %f", surf_min);
  90
  91   XBT_DEBUG("Looking for next trace event");
  92
  93   do {
  94     XBT_DEBUG("Next TRACE event : %f", next_event_date);
  95
  96     next_event_date = tmgr_history_next_date(history);
  97
  98     if(! surf_network_model->shareResourcesIsIdempotent()){ // NS3, I see you
  99       if(next_event_date!=-1.0 && surf_min!=-1.0) {
 100         surf_min = MIN(next_event_date - NOW, surf_min);
 101       } else{
 102         surf_min = MAX(next_event_date - NOW, surf_min);
 103       }
 104
 105       XBT_DEBUG("Run for network at most %f", surf_min);
 106       // run until min or next flow
 107       model_next_action_end = surf_network_model->shareResources(surf_min);
 108
 109       XBT_DEBUG("Min for network : %f", model_next_action_end);
 110       if(model_next_action_end>=0.0)
 111         surf_min = model_next_action_end;
 112     }
 113
 114     if (next_event_date < 0.0) {
 115       XBT_DEBUG("no next TRACE event. Stop searching for it");
 116       break;
 117     }
 118
 119     if ((surf_min == -1.0) || (next_event_date > NOW + surf_min)) break;
 120
 121     XBT_DEBUG("Updating models (min = %g, NOW = %g, next_event_date = %g)", surf_min, NOW, next_event_date);
 122     while ((event =
 123             tmgr_history_get_next_event_leq(history, next_event_date,
 124                                             &value,
 125                                             (void **) &resource))) {
 126       if (resource->isUsed() || xbt_dict_get_or_null(watched_hosts_lib, resource->getName())) {
 127         surf_min = next_event_date - NOW;
 128         XBT_DEBUG
 129             ("This event will modify model state. Next event set to %f",
 130              surf_min);
 131       }
 132       /* update state of model_obj according to new value. Does not touch lmm.
 133          It will be modified if needed when updating actions */
 134       XBT_DEBUG("Calling update_resource_state for resource %s with min %f",
 135              resource->getName(), surf_min);
 136       resource->updateState(event, value, next_event_date);
 137     }
 138   } while (1);
 139
 140   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
 141    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
 142    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
 143   if (surf_min == -1.0) {
 144   XBT_DEBUG("No next event at all. Bail out now.");
 145     return -1.0;
 146   }
 147
 148   XBT_DEBUG("Duration set to %f", surf_min);
 149
 150   NOW = NOW + surf_min;
 151   /* FIXME: model_list or model_list_invoke? revisit here later */
 152   /* sequential version */
 153   xbt_dynar_foreach(all_existing_models, iter, model) {
 154           model->updateActionsState(NOW, surf_min);
 155   }
 156
 157   TRACE_paje_dump_buffer (0);
 158
 159   return surf_min;
 160 }
 161
 162 void routing_get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
 163                               xbt_dynar_t * route, double *latency){
 164   routing_platf->getRouteAndLatency(src, dst, route, latency);
 165 }
 166
 167 /*********
 168  * MODEL *
 169  *********/
 170
 171 surf_host_model_t surf_host_get_model(sg_host_t host)
 172 {
 173   simgrid::surf::Host* surf_host =
 174     (simgrid::surf::Host*) host->facet(SURF_HOST_LEVEL);
 175   return (surf_host_model_t) surf_host->getModel();
 176 }
 177
 178 surf_action_t surf_model_extract_done_action_set(surf_model_t model){
 179   if (model->getDoneActionSet()->empty())
 180         return NULL;
 181   surf_action_t res = &model->getDoneActionSet()->front();
 182   model->getDoneActionSet()->pop_front();
 183   return res;
 184 }
 185
 186 surf_action_t surf_model_extract_failed_action_set(surf_model_t model){
 187   if (model->getFailedActionSet()->empty())
 188         return NULL;
 189   surf_action_t res = &model->getFailedActionSet()->front();
 190   model->getFailedActionSet()->pop_front();
 191   return res;
 192 }
 193
 194 surf_action_t surf_model_extract_ready_action_set(surf_model_t model){
 195   if (model->getReadyActionSet()->empty())
 196         return NULL;
 197   surf_action_t res = &model->getReadyActionSet()->front();
 198   model->getReadyActionSet()->pop_front();
 199   return res;
 200 }
 201
 202 surf_action_t surf_model_extract_running_action_set(surf_model_t model){
 203   if (model->getRunningActionSet()->empty())
 204         return NULL;
 205   surf_action_t res = &model->getRunningActionSet()->front();
 206   model->getRunningActionSet()->pop_front();
 207   return res;
 208 }
 209
 210 int surf_model_running_action_set_size(surf_model_t model){
 211   return model->getRunningActionSet()->size();
 212 }
 213
 214 surf_action_t surf_host_model_execute_parallel_task(surf_host_model_t model,
 215                                                     int host_nb,
 216                                             sg_host_t *host_list,
 217                                             double *flops_amount,
 218                                             double *bytes_amount,
 219                                             double rate){
 220   return static_cast<simgrid::surf::Action*>(
 221     model->executeParallelTask(host_nb, host_list, flops_amount, bytes_amount, rate));
 222 }
 223
 224 xbt_dynar_t surf_host_model_get_route(surf_host_model_t /*model*/,
 225                                              sg_host_t src, sg_host_t dst){
 226   xbt_dynar_t route = NULL;
 227   routing_platf->getRouteAndLatency(
 228     get_casted_host(src)->p_netElm,
 229                 get_casted_host(dst)->p_netElm, &route, NULL);
 230   return route;
 231 }
 232
 233 void surf_vm_model_create(const char *name, sg_host_t ind_phys_host){
 234   surf_vm_model->createVM(name, ind_phys_host);
 235 }
 236
 237 surf_action_t surf_network_model_communicate(surf_network_model_t model, sg_host_t src, sg_host_t dst, double size, double rate){
 238   return model->communicate(sg_host_edge(src), sg_host_edge(dst), size, rate);
 239 }
 240
 241 const char *surf_resource_name(surf_cpp_resource_t resource){
 242   return resource->getName();
 243 }
 244
 245 xbt_dict_t surf_resource_get_properties(surf_cpp_resource_t resource){
 246   return resource->getProperties();
 247 }
 248
 249 e_surf_resource_state_t surf_resource_get_state(surf_cpp_resource_t resource){
 250   return resource->getState();
 251 }
 252
 253 void surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state){
 254   resource->setState(state);
 255 }
 256
 257 surf_action_t surf_host_sleep(sg_host_t host, double duration){
 258   return get_casted_host(host)->sleep(duration);
 259 }
 260
 261 double surf_host_get_speed(sg_host_t host, double load){
 262   return sg_host_surfcpu(host)->getSpeed(load);
 263 }
 264
 265 double surf_host_get_available_speed(sg_host_t host){
 266   return sg_host_surfcpu(host)->getAvailableSpeed();
 267 }
 268
 269 int surf_host_get_core(sg_host_t host){
 270   return sg_host_surfcpu(host)->getCore();
 271 }
 272
 273 surf_action_t surf_host_execute(sg_host_t host, double size){
 274   return get_casted_host(host)->execute(size);
 275 }
 276
 277 double surf_host_get_current_power_peak(sg_host_t host){
 278   return sg_host_surfcpu(host)->getCurrentPowerPeak();
 279 }
 280
 281 double surf_host_get_power_peak_at(sg_host_t host, int pstate_index){
 282   return sg_host_surfcpu(host)->getPowerPeakAt(pstate_index);
 283 }
 284
 285 int surf_host_get_nb_pstates(sg_host_t host){
 286   return sg_host_surfcpu(host)->getNbPstates();
 287 }
 288
 289 void surf_host_set_pstate(sg_host_t host, int pstate_index){
 290         sg_host_surfcpu(host)->setPstate(pstate_index);
 291 }
 292 int surf_host_get_pstate(sg_host_t host){
 293   return sg_host_surfcpu(host)->getPstate();
 294 }
 295
 296 using simgrid::energy::HostEnergy;
 297 using simgrid::energy::surf_energy;
 298
 299 double surf_host_get_wattmin_at(sg_host_t resource, int pstate){
 300   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 301   std::map<simgrid::surf::Host*, HostEnergy*>::iterator hostIt = surf_energy->find(get_casted_host(resource));
 302   return hostIt->second->getWattMinAt(pstate);
 303 }
 304 double surf_host_get_wattmax_at(sg_host_t resource, int pstate){
 305   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 306   std::map<simgrid::surf::Host*, HostEnergy*>::iterator hostIt = surf_energy->find(get_casted_host(resource));
 307   return hostIt->second->getWattMaxAt(pstate);
 308 }
 309
 310 double surf_host_get_consumed_energy(sg_host_t resource){
 311   xbt_assert(surf_energy!=NULL, "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 312   std::map<simgrid::surf::Host*, HostEnergy*>::iterator hostIt = surf_energy->find(get_casted_host(resource));
 313   return hostIt->second->getConsumedEnergy();
 314 }
 315
 316 xbt_dict_t surf_host_get_mounted_storage_list(sg_host_t host){
 317   return get_casted_host(host)->getMountedStorageList();
 318 }
 319
 320 xbt_dynar_t surf_host_get_attached_storage_list(sg_host_t host){
 321   return get_casted_host(host)->getAttachedStorageList();
 322 }
 323
 324 surf_action_t surf_host_open(sg_host_t host, const char* fullpath){
 325   return get_casted_host(host)->open(fullpath);
 326 }
 327
 328 surf_action_t surf_host_close(sg_host_t host, surf_file_t fd){
 329   return get_casted_host(host)->close(fd);
 330 }
 331
 332 int surf_host_unlink(sg_host_t host, surf_file_t fd){
 333   return get_casted_host(host)->unlink(fd);
 334 }
 335
 336 size_t surf_host_get_size(sg_host_t host, surf_file_t fd){
 337   return get_casted_host(host)->getSize(fd);
 338 }
 339
 340 surf_action_t surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size){
 341   return get_casted_host(host)->read(fd, size);
 342 }
 343
 344 surf_action_t surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size){
 345   return get_casted_host(host)->write(fd, size);
 346 }
 347
 348 xbt_dynar_t surf_host_get_info(sg_host_t host, surf_file_t fd){
 349   return get_casted_host(host)->getInfo(fd);
 350 }
 351
 352 size_t surf_host_file_tell(sg_host_t host, surf_file_t fd){
 353   return get_casted_host(host)->fileTell(fd);
 354 }
 355
 356 int surf_host_file_seek(sg_host_t host, surf_file_t fd,
 357                                sg_offset_t offset, int origin){
 358   return get_casted_host(host)->fileSeek(fd, offset, origin);
 359 }
 360
 361 int surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath){
 362   return get_casted_host(host)->fileMove(fd, fullpath);
 363 }
 364
 365 xbt_dynar_t surf_host_get_vms(sg_host_t host){
 366   xbt_dynar_t vms = get_casted_host(host)->getVms();
 367   xbt_dynar_t vms_ = xbt_dynar_new(sizeof(sg_host_t), NULL);
 368   unsigned int cpt;
 369   simgrid::surf::VirtualMachine *vm;
 370   xbt_dynar_foreach(vms, cpt, vm) {
 371     // TODO, use a backlink from simgrid::surf::Host to simgrid::Host
 372     sg_host_t vm_ = (sg_host_t) xbt_dict_get_elm_or_null(host_list, vm->getName());
 373     xbt_dynar_push(vms_, &vm_);
 374   }
 375   xbt_dynar_free(&vms);
 376   return vms_;
 377 }
 378
 379 void surf_host_get_params(sg_host_t host, vm_params_t params){
 380   get_casted_host(host)->getParams(params);
 381 }
 382
 383 void surf_host_set_params(sg_host_t host, vm_params_t params){
 384   get_casted_host(host)->setParams(params);
 385 }
 386
 387 void surf_vm_destroy(sg_host_t resource){
 388   /* Before clearing the entries in host_lib, we have to pick up resources. */
 389   const char* name = resource->id().c_str();
 390   /* We deregister objects from host_lib, without invoking the freeing callback
 391    * of each level.
 392    *
 393    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
 394    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
 395    */
 396   sg_host_surfcpu_destroy(resource);
 397   sg_host_edge_destroy(resource,1);
 398   // TODO, use backlink from simgrid::surf::Host to simgrid::Host
 399   simgrid::Host::by_name_or_null(name)->set_facet(SURF_HOST_LEVEL, nullptr);
 400
 401   /* TODO: comment out when VM storage is implemented. */
 402   // host->set_facet(SURF_STORAGE_LEVEL, nullptr);
 403 }
 404
 405 void surf_vm_suspend(sg_host_t vm){
 406   get_casted_vm(vm)->suspend();
 407 }
 408
 409 void surf_vm_resume(sg_host_t vm){
 410   get_casted_vm(vm)->resume();
 411 }
 412
 413 void surf_vm_save(sg_host_t vm){
 414   get_casted_vm(vm)->save();
 415 }
 416
 417 void surf_vm_restore(sg_host_t vm){
 418   get_casted_vm(vm)->restore();
 419 }
 420
 421 void surf_vm_migrate(sg_host_t vm, sg_host_t ind_vm_ws_dest){
 422   get_casted_vm(vm)->migrate(ind_vm_ws_dest);
 423 }
 424
 425 sg_host_t surf_vm_get_pm(sg_host_t vm){
 426   return get_casted_vm(vm)->getPm();
 427 }
 428
 429 void surf_vm_set_bound(sg_host_t vm, double bound){
 430   return get_casted_vm(vm)->setBound(bound);
 431 }
 432
 433 void surf_vm_set_affinity(sg_host_t vm, sg_host_t cpu, unsigned long mask){
 434   return get_casted_vm(vm)->setAffinity(sg_host_surfcpu(cpu), mask);
 435 }
 436
 437 xbt_dict_t surf_storage_get_content(surf_resource_t resource){
 438   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getContent();
 439 }
 440
 441 sg_size_t surf_storage_get_size(surf_resource_t resource){
 442   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getSize();
 443 }
 444
 445 sg_size_t surf_storage_get_free_size(surf_resource_t resource){
 446   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getFreeSize();
 447 }
 448
 449 sg_size_t surf_storage_get_used_size(surf_resource_t resource){
 450   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getUsedSize();
 451 }
 452
 453 const char* surf_storage_get_host(surf_resource_t resource){
 454   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->p_attach;
 455 }
 456
 457 surf_action_t surf_cpu_execute(sg_host_t cpu, double size){
 458   return sg_host_surfcpu(cpu)->execute(size);
 459 }
 460
 461 surf_action_t surf_cpu_sleep(sg_host_t cpu, double duration){
 462   return sg_host_surfcpu(cpu)->sleep(duration);
 463 }
 464
 465 double surf_action_get_start_time(surf_action_t action){
 466   return action->getStartTime();
 467 }
 468
 469 double surf_action_get_finish_time(surf_action_t action){
 470   return action->getFinishTime();
 471 }
 472
 473 double surf_action_get_remains(surf_action_t action){
 474   return action->getRemains();
 475 }
 476
 477 void surf_action_unref(surf_action_t action){
 478   action->unref();
 479 }
 480
 481 void surf_action_suspend(surf_action_t action){
 482   action->suspend();
 483 }
 484
 485 void surf_action_resume(surf_action_t action){
 486   action->resume();
 487 }
 488
 489 void surf_action_cancel(surf_action_t action){
 490   action->cancel();
 491 }
 492
 493 void surf_action_set_priority(surf_action_t action, double priority){
 494   action->setPriority(priority);
 495 }
 496
 497 void surf_action_set_category(surf_action_t action, const char *category){
 498   action->setCategory(category);
 499 }
 500
 501 void *surf_action_get_data(surf_action_t action){
 502   return action->getData();
 503 }
 504
 505 void surf_action_set_data(surf_action_t action, void *data){
 506   action->setData(data);
 507 }
 508
 509 e_surf_action_state_t surf_action_get_state(surf_action_t action){
 510   return action->getState();
 511 }
 512
 513 double surf_action_get_cost(surf_action_t action){
 514   return action->getCost();
 515 }
 516
 517 void surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask) {
 518   static_cast<simgrid::surf::CpuAction*>(action)->setAffinity(sg_host_surfcpu(cpu), mask);
 519 }
 520
 521 void surf_cpu_action_set_bound(surf_action_t action, double bound) {
 522   static_cast<simgrid::surf::CpuAction*>(action)->setBound(bound);
 523 }
 524
 525 #ifdef HAVE_LATENCY_BOUND_TRACKING
 526 double surf_network_action_get_latency_limited(surf_action_t action) {
 527   return static_cast<NetworkActionPtr>(action)->getLatencyLimited();
 528 }
 529 #endif
 530
 531 surf_file_t surf_storage_action_get_file(surf_action_t action){
 532   return static_cast<simgrid::surf::StorageAction*>(action)->p_file;
 533 }