Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add SIMIX_process_set_name()
[simgrid.git] / src / include / simix / simix.h
index ebb2c8e..60620ae 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id$     */
+/*     $Id: simix.h 5610 2008-06-12 09:38:58Z alegrand $        */
 
 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
    All rights reserved.                                          */
@@ -11,6 +11,8 @@
 
 #include "xbt/misc.h"
 #include "xbt/fifo.h"
+#include "xbt/dict.h"
+#include "xbt/function_types.h"
 #include "simix/datatypes.h"
 #include "surf/surf.h"
 
@@ -21,12 +23,14 @@ SG_BEGIN_DECL()
 XBT_PUBLIC(void) SIMIX_config(const char *name, va_list pa);
 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
 XBT_PUBLIC(void) SIMIX_clean(void);
-XBT_PUBLIC(void) SIMIX_function_register(const char *name, smx_process_code_t code);
-XBT_PUBLIC(smx_process_code_t) SIMIX_get_registered_function(const char *name);
+XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
+XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
+XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
 
 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
 
 XBT_PUBLIC(double) SIMIX_get_clock(void);
+XBT_PUBLIC(void) SIMIX_init(void);
 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
 
 /* Timer functions */
@@ -38,14 +42,22 @@ XBT_PUBLIC(void) __SIMIX_main(void);
 
 /* User create and kill process, the function must accept the folling parameters:
  * const char *name: a name for the object. It is for user-level information and can be NULL
- * smx_process_code_t code: is a function describing the behavior of the agent
+ * xbt_main_func_t code: is a function describing the behavior of the agent
  * void *data: data a pointer to any data one may want to attach to the new object.
  * smx_host_t host: the location where the new agent is executed
  * int argc, char **argv: parameters passed to code
  *
  * */
-XBT_PUBLIC(void) SIMIX_function_register_process_create(void * function);
-XBT_PUBLIC(void) SIMIX_function_register_process_kill(void * function);
+typedef void *(*smx_creation_func_t)(/*name*/     const char *,
+                                    /*code*/     xbt_main_func_t, 
+                                    /*userdata*/ void *,
+                                    /*hostname*/ char *, 
+                                    /* argc */   int,
+                                    /* argv */   char **,
+                                     /* props */ xbt_dict_t);
+XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
+XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t function);
+XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_f_pvoid_t function);
 
 /************************** Host handling ***********************************/
 
@@ -53,32 +65,38 @@ XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
 
 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
+XBT_PUBLIC(void) SIMIX_process_set_name(smx_process_t process, char *name);
 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
 
 XBT_PUBLIC(int) SIMIX_host_get_number(void);
-XBT_PUBLIC(smx_host_t *)SIMIX_host_get_table(void);
+XBT_PUBLIC(smx_host_t *) SIMIX_host_get_table(void);
+XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(void);
 
 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
 
+XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_properties(smx_host_t host);
+
 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
 
 /************************** Process handling *********************************/
 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
-                                             smx_process_code_t code, void *data,
-                                             const char * hostname, int argc, char **argv, void * clean_process_function);
+                                              xbt_main_func_t code, void *data,
+                                              const char * hostname, int argc, char **argv, xbt_dict_t properties);
 
-XBT_PUBLIC(smx_process_t) SIMIX_jprocess_create(const char *name, 
-                                               smx_host_t host,
-                                               void *data,
-                                               void *jprocess, void *jenv);
+XBT_PUBLIC(void) SIMIX_jprocess_create(const char *name, 
+                                      smx_host_t host,
+                                      void *data,
+                                      void *jprocess, void *jenv,
+                                      smx_process_t* res);
 
 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
 XBT_PUBLIC(void) SIMIX_process_killall(void);
+XBT_PUBLIC(void) SIMIX_process_change_host(smx_process_t process, char *source, char *dest);
 
 //above layer
 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
@@ -92,6 +110,8 @@ XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
 
+/*property handlers*/
+XBT_PUBLIC(xbt_dict_t) SIMIX_process_get_properties(smx_process_t host);
 
 /************************** Synchro handling **********************************/
 
@@ -109,41 +129,32 @@ XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
-XBT_PUBLIC(void) SIMIX_register_condition_to_action(smx_action_t action, smx_cond_t cond);
 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
-
+XBT_PUBLIC(void) SIMIX_cond_display_info(smx_cond_t cond);
 
 /************************** Action handling ************************************/
-XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, char *name,
+XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, const char *name,
                                                                                                                                                                                                        double size, double rate);
-XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,char *name, double amount);
+XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host, const char *name, double amount);
 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
+XBT_PUBLIC(void) SIMIX_unregister_action_to_condition(smx_action_t action, smx_cond_t cond);
 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
 
 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
 
-/*Not implemented yet */
 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char * name, 
-                                                      int workstation_nb,      
-                                                      void **workstation_list,
+                                                      int host_nb,      
+                                                      smx_host_t *host_list,
                                                       double *computation_amount,
                                                       double *communication_amount,
                                                       double amount,
                                                       double rate);
 
-/* Helper functions for jMSG: manipulate the context data without breaking the module separation */
-void  SIMIX_process_set_jprocess(smx_process_t process, void *jp);
-void* SIMIX_process_get_jprocess(smx_process_t process);
-void  SIMIX_process_set_jmutex(smx_process_t process, void *jm);
-void* SIMIX_process_get_jmutex(smx_process_t process);
-void  SIMIX_process_set_jcond(smx_process_t process, void *jc);
-void* SIMIX_process_get_jcond(smx_process_t process);
-void  SIMIX_process_set_jenv(smx_process_t process, void *je);
-void* SIMIX_process_get_jenv(smx_process_t process);
+void SIMIX_display_process_status(void);
 
 
 SG_END_DECL()