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