Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s/__SIMIX_display_process_status/SIMIX_display_process_status/
[simgrid.git] / src / simix / smx_global.c
index 3a46a49..98aca67 100644 (file)
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
                                "Logging specific to SIMIX (kernel)");
 
-
 SIMIX_Global_t simix_global = NULL;
 
-
-/** \defgroup simix_simulation   SIMIX simulation Functions
- *  \brief This section describes the functions you need to know to
- *  set up a simulation. You should have a look at \ref SIMIX_examples 
- *  to have an overview of their usage.
- *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> \endhtmlonly
- */
-
 /********************************* SIMIX **************************************/
 
-/** \ingroup simix_simulation
- * \brief Initialize some SIMIX internal data.
- */
-void SIMIX_global_init_args(int *argc, char **argv)
-{
-  SIMIX_global_init(argc,argv);
-}
-
-/** \ingroup simix_simulation
+/**
  * \brief Initialize some SIMIX internal data.
+ *
+ * \param argc Argc
+ * \param argv Argv
  */
 void SIMIX_global_init(int *argc, char **argv)
 {
@@ -58,38 +44,43 @@ void SIMIX_global_init(int *argc, char **argv)
 }
 
 /* Debug purpose, incomplete */
-void __SIMIX_display_process_status(void)
+void SIMIX_display_process_status(void)
 {
    smx_process_t process = NULL;
    xbt_fifo_item_t item = NULL;
         smx_action_t act;
    int nbprocess=xbt_swag_size(simix_global->process_list);
    
-   INFO1("SIMIX: %d processes are still running, waiting for something.",
+   INFO1("%d processes are still running, waiting for something.",
         nbprocess);
    /*  List the process and their state */
-   INFO0("SIMIX: <process> on <host>: <status>.");
+   INFO0("Legend of the following listing: \"<process> on <host>: <status>.\"");
    xbt_swag_foreach(process, simix_global->process_list) {
       smx_simdata_process_t p_simdata = (smx_simdata_process_t) process->simdata;
      // simdata_host_t h_simdata=(simdata_host_t)p_simdata->host->simdata;
-      char *who;
+      char *who, *who2;
        
-      asprintf(&who,"SIMIX:  %s on %s: %s",
+      asprintf(&who,"%s on %s: %s",
               process->name,
-                               p_simdata->host->name,
+              p_simdata->s_host->name,
               (process->simdata->blocked)?"[BLOCKED] "
               :((process->simdata->suspended)?"[SUSPENDED] ":""));
-                       if (p_simdata->mutex) {
-                               DEBUG1("Block on a mutex: %s", who);                    
-                       }
-                       else if (p_simdata->cond) {
-                               DEBUG1("Block on a condition: %s", who);
-                               DEBUG0("Waiting actions:");
-                               xbt_fifo_foreach(p_simdata->cond->actions,item, act, smx_action_t) {
-                                       DEBUG1("\t %s", act->name);
-                               }
-                       }
-                       else DEBUG1("Unknown block status: %s", who);
+      
+      if (p_simdata->mutex) {
+        who2=bprintf("%s Blocked on mutex %p",who,p_simdata->mutex);
+        free(who); who=who2;
+      } else if (p_simdata->cond) {
+        who2=bprintf("%s Blocked on condition %p; Waiting for the following actions:",who,p_simdata->cond);
+        free(who); who=who2;
+        xbt_fifo_foreach(p_simdata->cond->actions,item, act, smx_action_t) {
+           who2=bprintf("%s '%s'",who,act->name);
+           free(who); who=who2;
+        }
+      } else {
+        who2=bprintf("%s Blocked in an unknown status (please report this bug)",who);
+        free(who); who=who2;
+      }
+      INFO1("%s.",who);
       free(who);
    }
 }
@@ -100,12 +91,12 @@ void __SIMIX_display_process_status(void)
 static void _XBT_CALL inthandler(int ignored)
 {
    INFO0("CTRL-C pressed. Displaying status and bailing out");
-   __SIMIX_display_process_status();
+   SIMIX_display_process_status();
    exit(1);
 }
 
-/** \ingroup msg_simulation
- * \brief Launch the SIMIX simulation
+/**
+ * \brief Launch the SIMIX simulation, debug purpose
  */
 void __SIMIX_main(void)
 {
@@ -135,7 +126,7 @@ void __SIMIX_main(void)
                        xbt_fifo_foreach(smx_action->cond_list,_cursor,cond,smx_cond_t) {
                                xbt_swag_foreach(process,cond->sleeping) {
                                        DEBUG2("\t preparing to wake up %s on %s",           
-                                                       process->name,  process->simdata->host->name);
+                                                       process->name,  process->simdata->s_host->name);
                                }
                                SIMIX_cond_broadcast(cond);
                                /* remove conditional from action */
@@ -150,7 +141,7 @@ void __SIMIX_main(void)
                        xbt_fifo_foreach(smx_action->cond_list,_cursor,cond,smx_cond_t) {
                                xbt_swag_foreach(process,cond->sleeping) {
                                        DEBUG2("\t preparing to wake up %s on %s",           
-                                                       process->name,  process->simdata->host->name);
+                                                       process->name,  process->simdata->s_host->name);
                                }
                                SIMIX_cond_broadcast(cond);
                                /* remove conditional from action */
@@ -161,12 +152,9 @@ void __SIMIX_main(void)
        return;
 }
 
-/** \ingroup msg_simulation
+/**
  * \brief Kill all running process
-
- * \param reset_PIDs should we reset the PID numbers. A negative
- *   number means no reset and a positive number will be used to set the PID
- *   of the next newly created process.
+ *
  */
 void SIMIX_process_killall()
 {
@@ -186,8 +174,10 @@ void SIMIX_process_killall()
   return;
 }
 
-/** \ingroup msg_simulation
+/** 
  * \brief Clean the SIMIX simulation
+ *
+ * This functions remove all memories needed to the SIMIX execution
  */
 void SIMIX_clean(void)
 {
@@ -195,7 +185,6 @@ void SIMIX_clean(void)
   smx_host_t h = NULL;
   smx_process_t p = NULL;
 
-
   while((p=xbt_swag_extract(simix_global->process_list))) {
     SIMIX_process_kill(p);
   }
@@ -215,14 +204,24 @@ void SIMIX_clean(void)
 }
 
 
-/** \ingroup msg_easier_life
+/**
  * \brief A clock (in second).
+ *
+ * \return Return the clock.
  */
 double SIMIX_get_clock(void)
 {
   return surf_get_clock();
 }
 
+/**
+ *     \brief Does a turn of the simulation
+ *
+ *     Executes a step in the surf simulation, adding to the two lists all the actions that finished on this turn. Schedules all processus in the process_to_run list.         
+ *     \param actions_done List of actions done
+ *     \param actions_failed List of actions failed
+ *     \return The time spent to execute the simulation or -1 if the simulation ended
+ */
 double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed) 
 {
 
@@ -243,7 +242,7 @@ double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
        while ((process = xbt_swag_extract(simix_global->process_to_run))) {
                DEBUG2("Scheduling %s on %s",        
                                process->name,
-                               process->simdata->host->name);
+                               process->simdata->s_host->name);
                simix_global->current_process = process;
                xbt_context_schedule(process->simdata->context);
                /*       fflush(NULL); */
@@ -273,10 +272,10 @@ double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
 
                while (surf_timer_resource->extension_public->get(&fun,(void*)&arg)) {
                        DEBUG2("got %p %p", fun, arg);
-                       if(fun==SIMIX_process_create_with_arguments) {
-                               process_arg_t args = arg;
+                       if(fun==SIMIX_process_create) {
+                               smx_process_arg_t args = arg;
                                DEBUG2("Launching %s on %s", args->name, args->hostname);
-                               process = SIMIX_process_create_with_arguments(args->name, args->code, 
+                               process = SIMIX_process_create(args->name, args->code, 
                                                args->data, args->hostname,
                                                args->argc,args->argv,NULL);
                                if(args->kill_time > SIMIX_get_clock()) {
@@ -289,7 +288,7 @@ double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
                        if(fun==SIMIX_process_kill) {
                                process = arg;
                                DEBUG2("Killing %s on %s", process->name, 
-                                               process->simdata->host->name);
+                                               process->simdata->s_host->name);
                                SIMIX_process_kill(process);
                        }
                }
@@ -314,10 +313,10 @@ double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
 
        if (elapsed_time == -1) {
                if (xbt_swag_size(simix_global->process_list) == 0) {
-                       INFO0("Congratulations ! Simulation terminated : all processes are over");
+/*                     INFO0("Congratulations ! Simulation terminated : all processes are over"); */
                } else {
                        INFO0("Oops ! Deadlock or code not perfectly clean.");
-                       __SIMIX_display_process_status();
+                       SIMIX_display_process_status();
                        if(XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
                                        XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
                                DEBUG0("Aborting!");
@@ -329,7 +328,15 @@ double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
        return elapsed_time;
 }
 
-
+/**
+ *     \brief Set the date to execute a function
+ *
+ * Set the date to execute the function on the surf.
+ *     \param date Date to execute function
+ *     \param function Function to be executed
+ *     \param arg Parameters of the function
+ *
+ */
 void SIMIX_timer_set (double date, void *function, void *arg)
 {
        surf_timer_resource->extension_public->set(date, function, arg);
@@ -340,7 +347,13 @@ int SIMIX_timer_get(void **function, void **arg)
        return surf_timer_resource->extension_public->get(function, arg);
 }
 
-
+/**
+ *     \brief Registers a function to create a process.
+ *
+ *     This function registers an user function to be called when a new process is created. The user function have to call the SIMIX_create_process function.
+ *     \param function Create process function
+ *
+ */
 void SIMIX_function_register_process_create(void * function)
 {
   xbt_assert0((simix_global->create_process_function == NULL), "Data already set");
@@ -350,6 +363,14 @@ void SIMIX_function_register_process_create(void * function)
 
   return ;
 }
+
+/**
+ *     \brief Registers a function to kill a process.
+ *
+ *     This function registers an user function to be called when a new process is killed. The user function have to call the SIMIX_kill_process function.
+ *     \param function Kill process function
+ *
+ */
 void SIMIX_function_register_process_kill(void * function)
 {
   xbt_assert0((simix_global->kill_process_function == NULL), "Data already set");