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(surf_resource_t resource){
  22   return static_cast<simgrid::surf::Host*>(surf_host_resource_priv(resource));
  23 }
  24
  25 static simgrid::surf::VirtualMachine *get_casted_vm(surf_resource_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_model_t surf_resource_model(const void *host, int level) {
 172   /* If level is SURF_WKS_LEVEL, ws is a host_CLM03 object. It has
 173    * surf_resource at the generic_resource field. */
 174   simgrid::surf::Resource *ws = static_cast<simgrid::surf::Resource*>(
 175     xbt_lib_get_level((xbt_dictelm_t) host, level));
 176   return ws->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                                              surf_resource_t src, surf_resource_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, surf_resource_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 xbt_dict_t surf_resource_get_properties(surf_cpp_resource_t resource){
 247   return resource->getProperties();
 248 }
 249
 250 e_surf_resource_state_t surf_resource_get_state(surf_cpp_resource_t resource){
 251   return resource->getState();
 252 }
 253
 254 void surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state){
 255   resource->setState(state);
 256 }
 257
 258 surf_action_t surf_host_sleep(surf_resource_t host, double duration){
 259   return get_casted_host(host)->sleep(duration);
 260 }
 261
 262 double surf_host_get_speed(surf_resource_t host, double load){
 263   return sg_host_surfcpu(host)->getSpeed(load);
 264 }
 265
 266 double surf_host_get_available_speed(surf_resource_t host){
 267   return sg_host_surfcpu(host)->getAvailableSpeed();
 268 }
 269
 270 int surf_host_get_core(surf_resource_t host){
 271   return sg_host_surfcpu(host)->getCore();
 272 }
 273
 274 surf_action_t surf_host_execute(surf_resource_t host, double size){
 275   return get_casted_host(host)->execute(size);
 276 }
 277
 278 double surf_host_get_current_power_peak(surf_resource_t host){
 279   return sg_host_surfcpu(host)->getCurrentPowerPeak();
 280 }
 281
 282 double surf_host_get_power_peak_at(surf_resource_t host, int pstate_index){
 283   return sg_host_surfcpu(host)->getPowerPeakAt(pstate_index);
 284 }
 285
 286 int surf_host_get_nb_pstates(surf_resource_t host){
 287   return sg_host_surfcpu(host)->getNbPstates();
 288 }
 289
 290 void surf_host_set_pstate(surf_resource_t host, int pstate_index){
 291         sg_host_surfcpu(host)->setPstate(pstate_index);
 292 }
 293 int surf_host_get_pstate(surf_resource_t host){
 294   return sg_host_surfcpu(host)->getPstate();
 295 }
 296
 297 using simgrid::energy::HostEnergy;
 298 using simgrid::energy::surf_energy;
 299
 300 double surf_host_get_wattmin_at(surf_resource_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(surf_resource_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(surf_resource_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(surf_resource_t host){
 318   return get_casted_host(host)->getMountedStorageList();
 319 }
 320
 321 xbt_dynar_t surf_host_get_attached_storage_list(surf_resource_t host){
 322   return get_casted_host(host)->getAttachedStorageList();
 323 }
 324
 325 surf_action_t surf_host_open(surf_resource_t host, const char* fullpath){
 326   return get_casted_host(host)->open(fullpath);
 327 }
 328
 329 surf_action_t surf_host_close(surf_resource_t host, surf_file_t fd){
 330   return get_casted_host(host)->close(fd);
 331 }
 332
 333 int surf_host_unlink(surf_resource_t host, surf_file_t fd){
 334   return get_casted_host(host)->unlink(fd);
 335 }
 336
 337 size_t surf_host_get_size(surf_resource_t host, surf_file_t fd){
 338   return get_casted_host(host)->getSize(fd);
 339 }
 340
 341 surf_action_t surf_host_read(surf_resource_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(surf_resource_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(surf_resource_t host, surf_file_t fd){
 350   return get_casted_host(host)->getInfo(fd);
 351 }
 352
 353 size_t surf_host_file_tell(surf_resource_t host, surf_file_t fd){
 354   return get_casted_host(host)->fileTell(fd);
 355 }
 356
 357 int surf_host_file_seek(surf_resource_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(surf_resource_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(surf_resource_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     sg_host_t vm_ = xbt_lib_get_elm_or_null(host_lib, 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(surf_resource_t host, vm_params_t params){
 380   get_casted_host(host)->getParams(params);
 381 }
 382
 383 void surf_host_set_params(surf_resource_t host, vm_params_t params){
 384   get_casted_host(host)->setParams(params);
 385 }
 386
 387 void surf_vm_destroy(surf_resource_t resource){
 388   /* Before clearing the entries in host_lib, we have to pick up resources. */
 389   simgrid::surf::VirtualMachine *vm = get_casted_vm(resource);
 390   char* name = xbt_dict_get_elm_key(resource);
 391   /* We deregister objects from host_lib, without invoking the freeing callback
 392    * of each level.
 393    *
 394    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
 395    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
 396    */
 397   sg_host_surfcpu_destroy((sg_host_t)resource);
 398   sg_host_edge_destroy((sg_host_t)resource,1);
 399   xbt_lib_unset(host_lib, name, SURF_HOST_LEVEL, 0);
 400
 401   /* TODO: comment out when VM storage is implemented. */
 402   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
 403
 404   delete vm;
 405 }
 406
 407 void surf_vm_suspend(surf_resource_t vm){
 408   get_casted_vm(vm)->suspend();
 409 }
 410
 411 void surf_vm_resume(surf_resource_t vm){
 412   get_casted_vm(vm)->resume();
 413 }
 414
 415 void surf_vm_save(surf_resource_t vm){
 416   get_casted_vm(vm)->save();
 417 }
 418
 419 void surf_vm_restore(surf_resource_t vm){
 420   get_casted_vm(vm)->restore();
 421 }
 422
 423 void surf_vm_migrate(surf_resource_t vm, surf_resource_t ind_vm_ws_dest){
 424   get_casted_vm(vm)->migrate(ind_vm_ws_dest);
 425 }
 426
 427 surf_resource_t surf_vm_get_pm(surf_resource_t vm){
 428   return get_casted_vm(vm)->getPm();
 429 }
 430
 431 void surf_vm_set_bound(surf_resource_t vm, double bound){
 432   return get_casted_vm(vm)->setBound(bound);
 433 }
 434
 435 void surf_vm_set_affinity(surf_resource_t vm, surf_resource_t cpu, unsigned long mask){
 436   return get_casted_vm(vm)->setAffinity(sg_host_surfcpu(cpu), mask);
 437 }
 438
 439 xbt_dict_t surf_storage_get_content(surf_resource_t resource){
 440   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getContent();
 441 }
 442
 443 sg_size_t surf_storage_get_size(surf_resource_t resource){
 444   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getSize();
 445 }
 446
 447 sg_size_t surf_storage_get_free_size(surf_resource_t resource){
 448   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getFreeSize();
 449 }
 450
 451 sg_size_t surf_storage_get_used_size(surf_resource_t resource){
 452   return static_cast<simgrid::surf::Storage*>(surf_storage_resource_priv(resource))->getUsedSize();
 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(surf_resource_t cpu, double size){
 460   return sg_host_surfcpu(cpu)->execute(size);
 461 }
 462
 463 surf_action_t surf_cpu_sleep(surf_resource_t cpu, double duration){
 464   return sg_host_surfcpu(cpu)->sleep(duration);
 465 }
 466
 467 double surf_action_get_start_time(surf_action_t action){
 468   return action->getStartTime();
 469 }
 470
 471 double surf_action_get_finish_time(surf_action_t action){
 472   return action->getFinishTime();
 473 }
 474
 475 double surf_action_get_remains(surf_action_t action){
 476   return action->getRemains();
 477 }
 478
 479 void surf_action_unref(surf_action_t action){
 480   action->unref();
 481 }
 482
 483 void surf_action_suspend(surf_action_t action){
 484   action->suspend();
 485 }
 486
 487 void surf_action_resume(surf_action_t action){
 488   action->resume();
 489 }
 490
 491 void surf_action_cancel(surf_action_t action){
 492   action->cancel();
 493 }
 494
 495 void surf_action_set_priority(surf_action_t action, double priority){
 496   action->setPriority(priority);
 497 }
 498
 499 void surf_action_set_category(surf_action_t action, const char *category){
 500   action->setCategory(category);
 501 }
 502
 503 void *surf_action_get_data(surf_action_t action){
 504   return action->getData();
 505 }
 506
 507 void surf_action_set_data(surf_action_t action, void *data){
 508   action->setData(data);
 509 }
 510
 511 e_surf_action_state_t surf_action_get_state(surf_action_t action){
 512   return action->getState();
 513 }
 514
 515 double surf_action_get_cost(surf_action_t action){
 516   return action->getCost();
 517 }
 518
 519 void surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask) {
 520   static_cast<simgrid::surf::CpuAction*>(action)->setAffinity(sg_host_surfcpu(cpu), mask);
 521 }
 522
 523 void surf_cpu_action_set_bound(surf_action_t action, double bound) {
 524   static_cast<simgrid::surf::CpuAction*>(action)->setBound(bound);
 525 }
 526
 527 #ifdef HAVE_LATENCY_BOUND_TRACKING
 528 double surf_network_action_get_latency_limited(surf_action_t action) {
 529   return static_cast<NetworkActionPtr>(action)->getLatencyLimited();
 530 }
 531 #endif
 532
 533 surf_file_t surf_storage_action_get_file(surf_action_t action){
 534   return static_cast<simgrid::surf::StorageAction*>(action)->p_file;
 535 }