3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "xbt/error.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(global, msg,
12 "Logging specific to MSG (global)");
14 MSG_Global_t msg_global = NULL;
16 /* static void MarkAsFailed(m_task_t t, TBX_HashTable_t failedProcessList); */
17 /* static xbt_fifo_t MSG_buildFailedHostList(long double a, long double b); */
19 /** \defgroup msg_simulation MSG simulation Functions
20 * \brief This section describes the functions you need to know to
21 * set up a simulation. You should have a look at \ref MSG_examples
22 * to have an overview of their usage.
25 /********************************* MSG **************************************/
27 /** \ingroup msg_simulation
28 * \brief Initialize some MSG internal data.
30 void MSG_global_init(void)
35 CRITICAL0("Please stop using this function. Use MSG_global_init_args instead.");
37 MSG_global_init_args(&argc,argv);
40 /** \ingroup msg_simulation
41 * \brief Initialize some MSG internal data.
43 void MSG_global_init_args(int *argc, char **argv)
46 msg_global = xbt_new0(s_MSG_Global_t,1);
48 surf_init(argc, argv); /* Initialize some common structures */
50 msg_global->host = xbt_fifo_new();
51 msg_global->process_to_run = xbt_fifo_new();
52 msg_global->process_list = xbt_fifo_new();
53 msg_global->max_channel = 0;
54 msg_global->current_process = NULL;
55 msg_global->registered_functions = xbt_dict_new();
60 /** \ingroup msg_easier_life
61 * \brief Traces MSG events in the Paje format.
63 void MSG_paje_output(const char *filename)
66 const char *paje_preembule="%EventDef SetLimits 0\n"
70 "%EventDef PajeDefineContainerType 1\n"
72 "% ContainerType string\n"
75 "%EventDef PajeDefineEventType 2\n"
77 "% ContainerType string\n"
80 "%EventDef PajeDefineStateType 3\n"
82 "% ContainerType string\n"
85 "%EventDef PajeDefineVariableType 4\n"
87 "% ContainerType string\n"
90 "%EventDef PajeDefineLinkType 5\n"
92 "% ContainerType string\n"
93 "% SourceContainerType string\n"
94 "% DestContainerType string\n"
97 "%EventDef PajeDefineEntityValue 6\n"
99 "% EntityType string\n"
102 "%EventDef PajeCreateContainer 7\n"
104 "% NewContainer string\n"
105 "% NewContainerType string\n"
106 "% Container string\n"
109 "%EventDef PajeDestroyContainer 8\n"
114 "%EventDef PajeNewEvent 9\n"
116 "% EntityType string\n"
117 "% Container string\n"
120 "%EventDef PajeSetState 10\n"
122 "% EntityType string\n"
123 "% Container string\n"
126 "%EventDef PajeSetState 101\n"
128 "% EntityType string\n"
129 "% Container string\n"
131 "% FileName string\n"
134 "%EventDef PajePushState 111\n"
136 "% EntityType string\n"
137 "% Container string\n"
139 "% FileName string\n"
142 "%EventDef PajePushState 11\n"
144 "% EntityType string\n"
145 "% Container string\n"
148 "%EventDef PajePopState 12\n"
150 "% EntityType string\n"
151 "% Container string\n"
153 "%EventDef PajeSetVariable 13\n"
155 "% EntityType string\n"
156 "% Container string\n"
159 "%EventDef PajeAddVariable 14\n"
161 "% EntityType string\n"
162 "% Container string\n"
165 "%EventDef PajeSubVariable 15\n"
167 "% EntityType string\n"
168 "% Container string\n"
171 "%EventDef PajeStartLink 16\n"
173 "% EntityType string\n"
174 "% Container string\n"
176 "% SourceContainer string\n"
179 "%EventDef PajeEndLink 17\n"
181 "% EntityType string\n"
182 "% Container string\n"
184 "% DestContainer string\n"
188 const char *type_definitions = "1 Sim_t 0 Simulation_t\n"
189 "1 H_t Sim_t m_host_t\n"
190 "1 P_t H_t m_process_t\n"
191 "3 S_t P_t \"Process State\"\n"
192 "6 E S_t Executing\n"
194 "6 C S_t Communicating\n"
195 "5 Comm Sim_t P_t P_t Communication_t\n";
197 const char *ext = ".trace";
198 int ext_len = strlen(ext);
201 xbt_assert0(msg_global, "Initialize MSG first\n");
202 xbt_assert0(!msg_global->paje_output, "Paje output allready defined\n");
203 xbt_assert0(filename, "Need a real file name\n");
205 len = strlen(filename);
206 if((len<ext_len) || (strncmp(filename+len-ext_len,ext,ext_len))) {
207 CRITICAL2("%s does not end by \"%s\". It may cause troubles when using Paje\n",
211 xbt_assert0(filename, "Need a real file name\n");
213 msg_global->paje_output=fopen(filename,"w");
214 xbt_assert1(msg_global->paje_output, "Failed to open %s \n",filename);
216 fprintf(msg_global->paje_output,"%s",paje_preembule);
217 fprintf(msg_global->paje_output,"%s",type_definitions);
218 for(i=0; i<msg_global->max_channel; i++) {
219 fprintf(msg_global->paje_output, "6 COMM_%d Comm \"Channel %d\"\n" ,i,i);
221 fprintf(msg_global->paje_output,
222 "7 0.0 CUR Sim_t 0 \"MSG simulation\"\n");
226 /** \ingroup msg_simulation
227 * \brief Defines the verbosity of the simulation.
229 void MSG_set_verbosity(MSG_outputmode_t mode)
231 CRITICAL0("MSG_set_verbosity : Not implemented yet.");
234 /** \defgroup m_channel_management Understanding channels
235 * \brief This section briefly describes the channel notion of MSG
238 * For convenience, the simulator provides the notion of channel
239 * that is close to the tag notion in MPI. A channel is not a
240 * socket. It doesn't need to be opened neither closed. It rather
241 * corresponds to the ports opened on the different machines.
245 /** \ingroup m_channel_management
246 * \brief Set the number of channel in the simulation.
248 * This function has to be called to fix the number of channel in the
249 simulation before creating any host. Indeed, each channel is
250 represented by a different mailbox on each #m_host_t. This
251 function can then be called only once. This function takes only one
253 * \param number the number of channel in the simulation. It has to be >0
255 MSG_error_t MSG_set_channel_number(int number)
257 xbt_assert0((msg_global) && (msg_global->max_channel == 0), "Channel number already set!");
259 msg_global->max_channel = number;
264 /** \ingroup m_simulation
265 * \brief Set the sharing policy used for the links
267 * This function can be called to change the sharing policy used for the links
268 (see \ref paper_tcp). By default the store and forward mechanism is used
269 with a parameter equal to 0.1. This function has to be called before creating
271 * \param mode the sharing policy used for the links: can be either
272 MSG_STORE_AND_FORWARD or MSG_TCP.
273 * \param param a parameter for the sharing policy. It has to be >0. It is
274 currently used only for the MSG_STORE_AND_FORWARD flavor and represents the
275 granularity of the communications (i.e. the packet size).
277 MSG_error_t MSG_set_sharing_policy(MSG_sharing_t mode, long double param)
279 CRITICAL0("MSG_set_sharing_policy: this function is now deprecated and useless. Store and forward does not exist anymore. Please stop using it.");
284 /** \ingroup m_channel_management
285 * \brief Return the number of channel in the simulation.
287 * This function has to be called once the number of channel is fixed. I can't
288 figure out a reason why anyone would like to call this function but nevermind.
289 * \return the number of channel in the simulation.
291 int MSG_get_channel_number(void)
293 xbt_assert0((msg_global)&&(msg_global->max_channel != 0), "Channel number not set yet!");
295 return msg_global->max_channel;
298 /** \ingroup msg_simulation
299 * \brief Launch the MSG simulation
301 MSG_error_t MSG_main(void)
303 m_process_t process = NULL;
305 double elapsed_time = 0.0;
307 /* Clean IO before the run */
311 surf_solve(); /* Takes traces into account. Returns 0.0 */
312 /* xbt_fifo_size(msg_global->process_to_run) */
314 xbt_context_empty_trash();
315 while ((process = xbt_fifo_pop(msg_global->process_to_run))) {
316 /* fprintf(stderr,"-> %s (%d)\n",process->name, process->simdata->PID); */
317 DEBUG3("Scheduling %s(%d) on %s",
318 process->name,process->simdata->PID,
319 process->simdata->host->name);
320 msg_global->current_process = process;
321 xbt_context_schedule(process->simdata->context);
322 msg_global->current_process = NULL;
324 DEBUG1("%Lg : Calling surf_solve",MSG_getClock());
325 elapsed_time = surf_solve();
326 DEBUG1("Elapsed_time %lg",elapsed_time);
328 /* fprintf(stderr, "====== %Lg =====\n",Now); */
329 /* if (elapsed_time==0.0) { */
330 /* fprintf(stderr, "No change in time\n"); */
332 if (elapsed_time<0.0) {
333 /* fprintf(stderr, "We're done %lg\n",elapsed_time); */
338 surf_action_t action = NULL;
339 surf_resource_t resource = NULL;
340 m_task_t task = NULL;
342 xbt_dynar_foreach(resource_list, i, resource) {
344 xbt_swag_extract(resource->common_public->states.
345 failed_action_set))) {
349 DEBUG1("** %s failed **",task->name);
350 /* fprintf(stderr,"** %s **\n",task->name); */
351 xbt_dynar_foreach(task->simdata->sleeping,_cursor,process) {
352 DEBUG3("\t preparing to wake up %s(%d) on %s",
353 process->name,process->simdata->PID,
354 process->simdata->host->name);
355 xbt_fifo_unshift(msg_global->process_to_run, process);
361 xbt_swag_extract(resource->common_public->states.
366 DEBUG1("** %s done **",task->name);
367 /* fprintf(stderr,"** %s **\n",task->name); */
368 xbt_dynar_foreach(task->simdata->sleeping,_cursor,process) {
369 DEBUG3("\t preparing to wake up %s(%d) on %s",
370 process->name,process->simdata->PID,
371 process->simdata->host->name);
372 xbt_fifo_unshift(msg_global->process_to_run, process);
381 if ((nbprocess=xbt_fifo_size(msg_global->process_list)) == 0) {
383 "MSG: Congratulations ! Simulation terminated : all process are over\n");
386 xbt_fifo_item_t item = NULL;
387 fprintf(stderr,"MSG: Oops ! Deadlock or code not perfectly clean.\n");
388 fprintf(stderr,"MSG: %d processes are still running, waiting for something.\n",
390 /* List the process and their state */
391 fprintf(stderr,"MSG: <process>(<pid>) on <host>: <status>.\n");
392 xbt_fifo_foreach(msg_global->process_list,item,process,m_process_t) {
393 simdata_process_t p_simdata = (simdata_process_t) process->simdata;
394 simdata_host_t h_simdata=(simdata_host_t)p_simdata->host->simdata;
397 fprintf(stderr,"MSG: %s(%d) on %s: ",
398 process->name,p_simdata->PID,
399 p_simdata->host->name);
401 if (process->simdata->blocked)
402 fprintf(stderr,"[blocked] ");
403 if (process->simdata->suspended)
404 fprintf(stderr,"[suspended] ");
406 for (i=0; i<msg_global->max_channel; i++) {
407 if (h_simdata->sleeping[i] == process) {
408 fprintf(stderr,"Listening on channel %d.\n",i);
412 if (i==msg_global->max_channel) {
413 if(p_simdata->waiting_task) {
414 if(p_simdata->waiting_task->simdata->compute) {
415 if(p_simdata->put_host)
416 fprintf(stderr,"Trying to send a task on Host %s, channel %d.\n",
417 p_simdata->put_host->name, p_simdata->put_channel);
419 fprintf(stderr,"Waiting for %s to finish.\n",p_simdata->waiting_task->name);
420 } else if (p_simdata->waiting_task->simdata->comm)
421 fprintf(stderr,"Waiting for %s to be finished transfered.\n",
422 p_simdata->waiting_task->name);
424 fprintf(stderr,"UNKNOWN STATUS. Please report this bug.\n");
426 else { /* Must be trying to put a task somewhere */
427 fprintf(stderr,"UNKNOWN STATUS. Please report this bug.\n");
431 if(XBT_LOG_ISENABLED(msg, xbt_log_priority_debug) ||
432 XBT_LOG_ISENABLED(global, xbt_log_priority_debug)) {
441 /* static void MarkAsFailed(m_task_t t, TBX_HashTable_t failedProcessList) */
443 /* simdata_task_t simdata = NULL; */
444 /* xbt_fifo_item_t i = NULL; */
445 /* m_process_t p = NULL; */
447 /* xbt_assert0((t!=NULL),"Invalid task"); */
448 /* simdata = t->simdata; */
450 /* #define KILL(task) if(task) SG_failTask(task) */
451 /* KILL(simdata->compute); */
452 /* KILL(simdata->TCP_comm); */
453 /* KILL(simdata->s[0]); */
454 /* KILL(simdata->s[1]); */
455 /* KILL(simdata->s[2]); */
456 /* KILL(simdata->s[3]); */
457 /* KILL(simdata->sleep); */
459 /* /\* if(simdata->comm) SG_failEndToEndTransfer(simdata->comm); *\/ */
461 /* xbt_fifo_foreach(simdata->sleeping,i,p,m_process_t) { */
462 /* if(!TBX_HashTable_isInList(failedProcessList,p,TBX_basicHash)) */
463 /* TBX_HashTable_insert(failedProcessList,p,TBX_basicHash); */
468 /* static xbt_fifo_t MSG_buildFailedHostList(long double begin, long double end) */
470 /* xbt_fifo_t failedHostList = xbt_fifo_new(); */
471 /* m_host_t host = NULL; */
472 /* xbt_fifo_item_t i; */
474 /* xbt_fifo_foreach(msg_global->host,i,host,m_host_t) { */
475 /* SG_Resource r= ((simdata_host_t) (host->simdata))->host; */
477 /* if(SG_evaluateFailureTrace(r->failure_trace,begin,end)!=-1.0) */
478 /* xbt_fifo_insert(failedHostList,host); */
481 /* return failedHostList; */
484 /** \ingroup msg_simulation
485 * \brief Kill all running process
487 * \param reset_PIDs should we reset the PID numbers. A negative
488 * number means no reset and a positive number will be used to set the PID
489 * of the next newly created process.
491 int MSG_process_killall(int reset_PIDs)
493 xbt_fifo_item_t i = NULL;
494 m_process_t p = NULL;
496 while((p=xbt_fifo_shift(msg_global->process_list))) {
499 xbt_context_empty_trash();
501 msg_global->PID = reset_PIDs;
502 msg_global->session++;
505 return msg_global->PID;
508 /** \ingroup msg_simulation
509 * \brief Clean the MSG simulation
511 MSG_error_t MSG_clean(void)
513 xbt_fifo_item_t i = NULL;
515 m_process_t p = NULL;
518 while((p=xbt_fifo_shift(msg_global->process_list))) {
523 xbt_fifo_foreach(msg_global->host,i,h,m_host_t) {
524 __MSG_host_destroy(h);
526 xbt_fifo_free(msg_global->host);
527 xbt_fifo_free(msg_global->process_to_run);
528 xbt_fifo_free(msg_global->process_list);
529 xbt_dict_free(&(msg_global->registered_functions));
531 if(msg_global->paje_output) {
532 fclose(msg_global->paje_output);
533 msg_global->paje_output = NULL;
535 xbt_free(msg_global);
542 /** \ingroup msg_easier_life
543 * \brief A clock (in second).
545 long double MSG_getClock(void) {
546 return surf_get_clock();