Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
eb269f97fabed0e8f6b49492ae46adf9d525d31a
[simgrid.git] / src / simix / smx_process_private.h
1 /* Copyright (c) 2007-2010, 2012-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 #ifndef _SIMIX_PROCESS_PRIVATE_H
8 #define _SIMIX_PROCESS_PRIVATE_H
9
10 #include "simgrid/simix.h"
11 #include "smx_smurf_private.h"
12
13 typedef struct s_smx_process_exit_fun {
14   int_f_pvoid_t fun;
15   void *arg;
16 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
17
18 typedef struct s_smx_process_arg {
19   char *name;
20   xbt_main_func_t code;
21   void *data;
22   const char *hostname;
23   int argc;
24   char **argv;
25   double kill_time;
26   xbt_dict_t properties;
27   unsigned auto_restart:1;
28 } s_smx_process_arg_t, *smx_process_arg_t;
29
30
31 /** @brief Process datatype */
32 typedef struct s_smx_process {
33   s_xbt_swag_hookup_t process_hookup;
34   s_xbt_swag_hookup_t synchro_hookup;   /* process_to_run or mutex->sleeping and co */
35   s_xbt_swag_hookup_t host_proc_hookup;
36   s_xbt_swag_hookup_t destroy_hookup;
37
38   unsigned long pid;
39   unsigned long ppid;
40   char *name;                   /**< @brief process name if any */
41   smx_host_t smx_host;          /* the host on which the process is running */
42   smx_context_t context;        /* the context (uctx/raw/thread) that executes the user function */
43   xbt_running_ctx_t *running_ctx;
44   unsigned doexception:1;
45   unsigned blocked:1;
46   unsigned suspended:1;
47   unsigned auto_restart:1;
48
49   smx_host_t new_host;          /* if not null, the host on which the process must migrate to */
50   smx_action_t waiting_action;  /* the current blocking action if any */
51   xbt_fifo_t comms;       /* the current non-blocking communication actions */
52   xbt_dict_t properties;
53   s_smx_simcall_t simcall;
54   void *data;                   /* kept for compatibility, it should be replaced with moddata */
55   xbt_dynar_t on_exit;     /* list of functions executed when the process dies */
56
57   xbt_main_func_t code;
58   int argc;
59   char **argv;
60   double kill_time;
61
62 } s_smx_process_t;
63
64
65 void SIMIX_process_create(smx_process_t *process,
66                           const char *name,
67                           xbt_main_func_t code,
68                           void *data,
69                           const char *hostname,
70                           double kill_time,
71                           int argc, char **argv,
72                           xbt_dict_t properties,
73                           int auto_restart,
74                           smx_process_t parent_process);
75 void SIMIX_process_runall(void);
76 void SIMIX_process_kill(smx_process_t process, smx_process_t issuer);
77 void SIMIX_process_killall(smx_process_t issuer, int reset_pid);
78 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args);
79 void SIMIX_create_maestro_process(void);
80 void SIMIX_process_stop(smx_process_t arg);
81 void SIMIX_process_cleanup(smx_process_t arg);
82 void SIMIX_process_empty_trash(void);
83 void SIMIX_process_yield(smx_process_t self);
84 xbt_running_ctx_t *SIMIX_process_get_running_context(void);
85 void SIMIX_process_exception_terminate(xbt_ex_t * e);
86 void SIMIX_pre_process_change_host(smx_simcall_t, smx_process_t process,
87            smx_host_t dest);
88 void SIMIX_process_change_host(smx_process_t process,
89              smx_host_t dest);
90 void SIMIX_pre_process_suspend(smx_simcall_t simcall, smx_process_t process);
91 smx_action_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer);
92 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer);
93 int SIMIX_process_get_PID(smx_process_t self);
94 int SIMIX_process_get_PPID(smx_process_t self);
95 void* SIMIX_process_get_data(smx_process_t process);
96 void SIMIX_process_set_data(smx_process_t process, void *data);
97 smx_host_t SIMIX_process_get_host(smx_process_t process);
98 const char* SIMIX_process_get_name(smx_process_t process);
99 smx_process_t SIMIX_process_get_by_name(const char* name);
100 int SIMIX_process_is_suspended(smx_process_t process);
101 xbt_dict_t SIMIX_process_get_properties(smx_process_t process);
102 void SIMIX_pre_process_sleep(smx_simcall_t simcall, double duration);
103 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration);
104 void SIMIX_post_process_sleep(smx_action_t action);
105
106 void SIMIX_process_sleep_suspend(smx_action_t action);
107 void SIMIX_process_sleep_resume(smx_action_t action);
108 void SIMIX_process_sleep_destroy(smx_action_t action);
109 void SIMIX_process_auto_restart_set(smx_process_t process, int auto_restart);
110 smx_process_t SIMIX_process_restart(smx_process_t process, smx_process_t issuer);
111
112 // pre prototypes
113 void SIMIX_pre_process_create(smx_simcall_t simcall, smx_process_t *process,
114                               const char *name, xbt_main_func_t code, void *data,
115                               const char *hostname, double kill_time, int argc,
116                               char **argv, xbt_dict_t properties, int auto_restart);
117 void SIMIX_pre_process_kill(smx_simcall_t simcall, smx_process_t process);
118 void SIMIX_pre_process_killall(smx_simcall_t simcall, int reset_pid);
119 void SIMIX_pre_process_cleanup(smx_simcall_t simcall, smx_process_t process);
120 void SIMIX_pre_process_resume(smx_simcall_t simcall, smx_process_t process);
121 int SIMIX_pre_process_count(smx_simcall_t simcall);
122 void* SIMIX_pre_process_self_get_data(smx_simcall_t simcall, smx_process_t process);
123 int SIMIX_pre_process_get_PID(smx_simcall_t simcall, smx_process_t self);
124 int SIMIX_pre_process_get_PPID(smx_simcall_t simcall, smx_process_t self);
125 void* SIMIX_pre_process_get_data(smx_simcall_t simcall, smx_process_t process);
126 void SIMIX_pre_process_set_data(smx_simcall_t simcall, smx_process_t process,
127                                 void *data);
128 smx_host_t SIMIX_pre_process_get_host(smx_simcall_t simcall, smx_process_t process);
129 const char* SIMIX_pre_process_get_name(smx_simcall_t simcall, smx_process_t process);
130 int SIMIX_pre_process_is_suspended(smx_simcall_t simcall, smx_process_t process);
131 xbt_dict_t SIMIX_pre_process_get_properties(smx_simcall_t simcall, smx_process_t process);
132 void SIMIX_pre_process_on_exit(smx_simcall_t simcall, smx_process_t process,
133                                int_f_pvoid_t fun, void *data);
134 void SIMIX_pre_process_auto_restart_set(smx_simcall_t simcall, smx_process_t process,
135                                         int auto_restart);
136 smx_process_t SIMIX_pre_process_restart(smx_simcall_t simcall, smx_process_t process);
137 #endif