Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' into mc
[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 "popping_private.h"
12
13 SG_BEGIN_DECL()
14
15 typedef struct s_smx_process_exit_fun {
16   int_f_pvoid_pvoid_t fun;
17   void *arg;
18 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
19
20 typedef struct s_smx_process_arg {
21   char *name;
22   xbt_main_func_t code;
23   void *data;
24   const char *hostname;
25   int argc;
26   char **argv;
27   double kill_time;
28   xbt_dict_t properties;
29   unsigned auto_restart:1;
30 } s_smx_process_arg_t, *smx_process_arg_t;
31
32 /** @brief Process datatype */
33 typedef struct s_smx_process {
34   s_xbt_swag_hookup_t process_hookup;
35   s_xbt_swag_hookup_t synchro_hookup;   /* process_to_run or mutex->sleeping and co */
36   s_xbt_swag_hookup_t host_proc_hookup;
37   s_xbt_swag_hookup_t destroy_hookup;
38
39   unsigned long pid;
40   unsigned long ppid;
41   char *name;                   /**< @brief process name if any */
42   smx_host_t smx_host;          /* the host on which the process is running */
43   smx_context_t context;        /* the context (uctx/raw/thread) that executes the user function */
44   xbt_running_ctx_t *running_ctx;
45   unsigned doexception:1;
46   unsigned blocked:1;
47   unsigned suspended:1;
48   unsigned auto_restart:1;
49
50   smx_host_t new_host;          /* if not null, the host on which the process must migrate to */
51   smx_synchro_t waiting_synchro;  /* the current blocking synchro if any */
52   xbt_fifo_t comms;       /* the current non-blocking communication synchros */
53   xbt_dict_t properties;
54   s_smx_simcall_t simcall;
55   void *data;                   /* kept for compatibility, it should be replaced with moddata */
56   xbt_dynar_t on_exit;     /* list of functions executed when the process dies */
57
58   xbt_main_func_t code;
59   int argc;
60   char **argv;
61   smx_timer_t kill_timer;
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_process_change_host(smx_process_t process,
87              smx_host_t dest);
88 smx_synchro_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer);
89 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer);
90 int SIMIX_process_get_PID(smx_process_t self);
91 int SIMIX_process_get_PPID(smx_process_t self);
92 void* SIMIX_process_get_data(smx_process_t process);
93 void SIMIX_process_set_data(smx_process_t process, void *data);
94 smx_host_t SIMIX_process_get_host(smx_process_t process);
95 const char* SIMIX_process_get_name(smx_process_t process);
96 smx_process_t SIMIX_process_get_by_name(const char* name);
97 int SIMIX_process_is_suspended(smx_process_t process);
98 xbt_dict_t SIMIX_process_get_properties(smx_process_t process);
99 smx_synchro_t SIMIX_process_join(smx_process_t issuer, smx_process_t process, double timeout);
100 smx_synchro_t SIMIX_process_sleep(smx_process_t process, double duration);
101 void SIMIX_post_process_sleep(smx_synchro_t synchro);
102
103 void SIMIX_process_sleep_suspend(smx_synchro_t synchro);
104 void SIMIX_process_sleep_resume(smx_synchro_t synchro);
105 void SIMIX_process_sleep_destroy(smx_synchro_t synchro);
106 void SIMIX_process_auto_restart_set(smx_process_t process, int auto_restart);
107 smx_process_t SIMIX_process_restart(smx_process_t process, smx_process_t issuer);
108
109 SG_END_DECL()
110
111 #endif