Logo AND Algorithmique Numérique Distribuée

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