Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[simix] Use std::string for s_smx_process_arg
[simgrid.git] / src / simix / smx_host.cpp
1 /* Copyright (c) 2007-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 "smx_private.h"
8 #include "xbt/sysdep.h"
9 #include "mc/mc.h"
10 #include "src/mc/mc_replay.h"
11 #include "src/surf/virtual_machine.hpp"
12 #include "src/surf/HostImpl.hpp"
13
14 #include "src/simix/SynchroExec.hpp"
15 #include "src/simix/SynchroComm.hpp"
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix, "SIMIX hosts");
18
19 /**
20  * \brief Internal function to create a SIMIX host.
21  * \param name name of the host to create
22  */
23 void SIMIX_host_create(sg_host_t host) // FIXME: braindead prototype. Take sg_host as parameter
24 {
25   smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
26
27   /* Host structure */
28   simgrid::simix::Process proc;
29   smx_host->process_list = xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
30
31   /* Update global variables */
32   sg_host_simix_set(host, smx_host);
33 }
34
35 /**
36  * \brief Start the host if it is off
37  *
38  */
39 void SIMIX_host_on(sg_host_t h)
40 {
41   smx_host_priv_t host = sg_host_simix(h);
42
43   xbt_assert((host != NULL), "Invalid parameters");
44
45   if (h->isOff()) {
46     simgrid::surf::HostImpl* surf_host = h->extension<simgrid::surf::HostImpl>();
47     surf_host->turnOn();
48
49     unsigned int cpt;
50     smx_process_arg_t arg;
51     xbt_dynar_foreach(host->boot_processes,cpt,arg) {
52
53       char** argv = xbt_new(char*, arg->argc);
54       for (int i=0; i<arg->argc; i++)
55         argv[i] = xbt_strdup(arg->argv[i]);
56
57       XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
58       if (simix_global->create_process_function) {
59         simix_global->create_process_function(argv[0],
60                                               arg->code,
61                                               NULL,
62                                               arg->hostname,
63                                               arg->kill_time,
64                                               arg->argc,
65                                               argv,
66                                               arg->properties,
67                                               arg->auto_restart,
68                                               NULL);
69       } else {
70         simcall_process_create(arg->argv[0],
71                                arg->code,
72                                NULL,
73                                arg->hostname,
74                                arg->kill_time,
75                                arg->argc,
76                                argv,
77                                arg->properties,
78                                arg->auto_restart);
79       }
80     }
81   }
82 }
83
84 /**
85  * \brief Stop the host if it is on
86  *
87  */
88 void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
89 {
90   smx_host_priv_t host = sg_host_simix(h);
91
92   xbt_assert((host != NULL), "Invalid parameters");
93
94   if (h->isOn()) {
95     simgrid::surf::HostImpl* surf_host = h->extension<simgrid::surf::HostImpl>();
96     surf_host->turnOff();
97
98     /* Clean Simulator data */
99     if (xbt_swag_size(host->process_list) != 0) {
100       smx_process_t process = NULL;
101       xbt_swag_foreach(process, host->process_list) {
102         SIMIX_process_kill(process, issuer);
103         XBT_DEBUG("Killing %s on %s by %s", process->name,  sg_host_get_name(process->host), issuer->name);
104       }
105     }
106   } else {
107     XBT_INFO("Host %s is already off",h->name().c_str());
108   }
109 }
110
111 /**
112  * \brief Internal function to destroy a SIMIX host.
113  *
114  * \param h the host to destroy (a sg_host_t)
115  */
116 void SIMIX_host_destroy(void *h)
117 {
118   smx_host_priv_t host = (smx_host_priv_t) h;
119
120   xbt_assert((host != NULL), "Invalid parameters");
121
122   /* Clean Simulator data */
123   if (xbt_swag_size(host->process_list) != 0) {
124     char *msg = xbt_strdup("Shutting down host, but it's not empty:");
125     char *tmp;
126     smx_process_t process = NULL;
127
128     xbt_swag_foreach(process, host->process_list) {
129       tmp = bprintf("%s\n\t%s", msg, process->name);
130       free(msg);
131       msg = tmp;
132     }
133     SIMIX_display_process_status();
134     THROWF(arg_error, 0, "%s", msg);
135   }
136   xbt_dynar_free(&host->auto_restart_processes);
137   xbt_dynar_free(&host->boot_processes);
138   xbt_swag_free(host->process_list);
139
140   /* Clean host structure */
141   free(host);
142   return;
143 }
144
145 sg_host_t SIMIX_host_self(void)
146 {
147   smx_process_t process = SIMIX_process_self();
148   return (process == NULL) ? NULL : SIMIX_process_get_host(process);
149 }
150
151 /* needs to be public and without simcall because it is called
152    by exceptions and logging events */
153 const char* SIMIX_host_self_get_name(void)
154 {
155   sg_host_t host = SIMIX_host_self();
156   if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
157     return "";
158
159   return sg_host_get_name(host);
160 }
161
162 void _SIMIX_host_free_process_arg(void *data)
163 {
164   smx_process_arg_t arg = *(smx_process_arg_t*)data;
165   for (int i = 0; i < arg->argc; i++)
166     xbt_free(arg->argv[i]);
167   xbt_free(arg->argv);
168   delete arg;
169 }
170 /**
171  * \brief Add a process to the list of the processes that the host will restart when it comes back
172  * This function add a process to the list of the processes that will be restarted when the host comes
173  * back. It is expected that this function is called when the host is down.
174  * The processes will only be restarted once, meaning that you will have to register the process
175  * again to restart the process again.
176  */
177 void SIMIX_host_add_auto_restart_process(sg_host_t host,
178                                          const char *name,
179                                          xbt_main_func_t code,
180                                          void *data,
181                                          const char *hostname,
182                                          double kill_time,
183                                          int argc, char **argv,
184                                          xbt_dict_t properties,
185                                          int auto_restart)
186 {
187   if (!sg_host_simix(host)->auto_restart_processes) {
188     sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
189   }
190   smx_process_arg_t arg = new s_smx_process_arg_t();
191   arg->name = name;
192   arg->code = code;
193   arg->data = data;
194   arg->hostname = hostname;
195   arg->kill_time = kill_time;
196   arg->argc = argc;
197
198   arg->argv = xbt_new(char*,argc + 1);
199
200   for (int i = 0; i < argc; i++)
201     arg->argv[i] = xbt_strdup(argv[i]);
202   arg->argv[argc] = NULL;
203
204   arg->properties = properties;
205   arg->auto_restart = auto_restart;
206
207   if( host->isOff() && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
208     xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,NULL);
209     XBT_DEBUG("Push host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
210   }
211   xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
212 }
213 /**
214  * \brief Restart the list of processes that have been registered to the host
215  */
216 void SIMIX_host_autorestart(sg_host_t host)
217 {
218   unsigned int cpt;
219   smx_process_arg_t arg;
220   xbt_dynar_t process_list = sg_host_simix(host)->auto_restart_processes;
221   if (!process_list)
222     return;
223
224   xbt_dynar_foreach (process_list, cpt, arg) {
225
226     XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
227     if (simix_global->create_process_function) {
228       simix_global->create_process_function(arg->argv[0],
229                                             arg->code,
230                                             NULL,
231                                             arg->hostname,
232                                             arg->kill_time,
233                                             arg->argc,
234                                             arg->argv,
235                                             arg->properties,
236                                             arg->auto_restart,
237                                             NULL);
238     } else {
239       simcall_process_create(arg->argv[0],
240                              (xbt_main_func_t) arg->code,
241                              NULL,
242                              arg->hostname,
243                              arg->kill_time,
244                              arg->argc,
245                              arg->argv,
246                              arg->properties,
247                              arg->auto_restart);
248
249     }
250     /* arg->argv is used by the process created above.  Hide it to
251      * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
252      * below. */
253     arg->argc = 0;
254     arg->argv = NULL;
255   }
256   xbt_dynar_reset(process_list);
257 }
258
259 smx_synchro_t simcall_HANDLER_execution_start(smx_simcall_t simcall,
260     const char* name, double flops_amount, double priority, double bound, unsigned long affinity_mask) {
261   return SIMIX_execution_start(simcall->issuer, name,flops_amount,priority,bound,affinity_mask);
262 }
263 smx_synchro_t SIMIX_execution_start(smx_process_t issuer, const char *name,
264      double flops_amount, double priority, double bound, unsigned long affinity_mask){
265
266   /* alloc structures and initialize */
267   simgrid::simix::Exec *exec = new simgrid::simix::Exec();
268   exec->name = xbt_strdup(name);
269   exec->state = SIMIX_RUNNING;
270   exec->host = issuer->host;
271
272   /* set surf's action */
273   if (!MC_is_active() && !MC_record_replay_is_active()) {
274
275     exec->surf_exec = issuer->host->pimpl_cpu->execution_start(flops_amount);
276     exec->surf_exec->setData(exec);
277     exec->surf_exec->setPriority(priority);
278
279     if (bound != 0)
280       static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
281
282     if (affinity_mask != 0) {
283       /* just a double check to confirm that this host is the host where this task is running. */
284       xbt_assert(exec->host == issuer->host);
285       static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)
286         ->setAffinity(issuer->host->pimpl_cpu, affinity_mask);
287     }
288   }
289
290   XBT_DEBUG("Create execute synchro %p: %s", exec, exec->name);
291
292   return exec;
293 }
294
295 smx_synchro_t SIMIX_execution_parallel_start(const char *name,
296     int host_nb, sg_host_t *host_list,
297     double *flops_amount, double *bytes_amount,
298     double amount, double rate){
299
300   sg_host_t *host_list_cpy = NULL;
301   int i;
302
303   /* alloc structures and initialize */
304   simgrid::simix::Exec *exec = new simgrid::simix::Exec();
305   exec->name = xbt_strdup(name);
306   exec->state = SIMIX_RUNNING;
307   exec->host = nullptr; /* FIXME: do we need the list of hosts? */
308
309   /* set surf's synchro */
310   host_list_cpy = xbt_new0(sg_host_t, host_nb);
311   for (i = 0; i < host_nb; i++)
312     host_list_cpy[i] = host_list[i];
313
314   /* Check that we are not mixing VMs and PMs in the parallel task */
315   simgrid::surf::HostImpl *host = host_list[0]->extension<simgrid::surf::HostImpl>();
316   bool is_a_vm = (nullptr != dynamic_cast<simgrid::surf::VirtualMachine*>(host));
317   for (i = 1; i < host_nb; i++) {
318     bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::surf::VirtualMachine*>(host_list[i]->extension<simgrid::surf::HostImpl>()));
319     xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
320   }
321
322   /* set surf's synchro */
323   if (!MC_is_active() && !MC_record_replay_is_active()) {
324     exec->surf_exec = surf_host_model->executeParallelTask(host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
325     exec->surf_exec->setData(exec);
326   }
327   XBT_DEBUG("Create parallel execute synchro %p", exec);
328
329   return exec;
330 }
331
332 void SIMIX_execution_cancel(smx_synchro_t synchro)
333 {
334   XBT_DEBUG("Cancel synchro %p", synchro);
335   simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
336
337   if (exec->surf_exec)
338     exec->surf_exec->cancel();
339 }
340
341 void SIMIX_execution_set_priority(smx_synchro_t synchro, double priority)
342 {
343   simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
344   if(exec->surf_exec)
345     exec->surf_exec->setPriority(priority);
346 }
347
348 void SIMIX_execution_set_bound(smx_synchro_t synchro, double bound)
349 {
350   simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
351   if(exec->surf_exec)
352     static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
353 }
354
355 void SIMIX_execution_set_affinity(smx_synchro_t synchro, sg_host_t host, unsigned long mask)
356 {
357   simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
358   if(exec->surf_exec) {
359     /* just a double check to confirm that this host is the host where this task is running. */
360     xbt_assert(exec->host == host);
361     static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setAffinity(host->pimpl_cpu, mask);
362   }
363 }
364
365 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro)
366 {
367   simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
368   XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
369
370   /* Associate this simcall to the synchro */
371   xbt_fifo_push(synchro->simcalls, simcall);
372   simcall->issuer->waiting_synchro = synchro;
373
374   /* set surf's synchro */
375   if (MC_is_active() || MC_record_replay_is_active()) {
376     synchro->state = SIMIX_DONE;
377     SIMIX_execution_finish(exec);
378     return;
379   }
380
381   /* If the synchro is already finished then perform the error handling */
382   if (synchro->state != SIMIX_RUNNING)
383     SIMIX_execution_finish(exec);
384 }
385
386 void SIMIX_execution_finish(simgrid::simix::Exec *exec)
387 {
388   xbt_fifo_item_t item;
389   smx_simcall_t simcall;
390
391   xbt_fifo_foreach(exec->simcalls, item, simcall, smx_simcall_t) {
392
393     switch (exec->state) {
394
395       case SIMIX_DONE:
396         /* do nothing, synchro done */
397         XBT_DEBUG("SIMIX_execution_finished: execution successful");
398         break;
399
400       case SIMIX_FAILED:
401         XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_get_name(simcall->issuer->host));
402         simcall->issuer->context->iwannadie = 1;
403         SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
404         break;
405
406       case SIMIX_CANCELED:
407         XBT_DEBUG("SIMIX_execution_finished: execution canceled");
408         SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
409         break;
410
411       default:
412         xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
413             (int)exec->state);
414     }
415     /* Fail the process if the host is down */
416     if (simcall->issuer->host->isOff())
417       simcall->issuer->context->iwannadie = 1;
418
419     simcall->issuer->waiting_synchro = NULL;
420     simcall_execution_wait__set__result(simcall, exec->state);
421     SIMIX_simcall_answer(simcall);
422   }
423
424   /* We no longer need it */
425   exec->unref();
426 }
427
428 void SIMIX_set_category(smx_synchro_t synchro, const char *category)
429 {
430   if (synchro->state != SIMIX_RUNNING) return;
431
432   simgrid::simix::Exec *exec = dynamic_cast<simgrid::simix::Exec *>(synchro);
433   if (exec != nullptr) {
434     exec->surf_exec->setCategory(category);
435     return;
436   }
437
438   simgrid::simix::Comm *comm = dynamic_cast<simgrid::simix::Comm *>(synchro);
439   if (comm != nullptr) {
440     comm->surf_comm->setCategory(category);
441     return;
442   }
443 }