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