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