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