Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Pfff. These functions are actually not available from the high APIs
[simgrid.git] / src / simix / smx_process_private.h
1 /* Copyright (c) 2007-2010, 2012-2015. 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 <xbt/base.h>
11
12 #include "simgrid/simix.h"
13 #include "popping_private.h"
14
15 SG_BEGIN_DECL()
16
17 typedef struct s_smx_process_exit_fun {
18   int_f_pvoid_pvoid_t fun;
19   void *arg;
20 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
21
22 typedef struct s_smx_process_arg {
23   char *name;
24   xbt_main_func_t code;
25   void *data;
26   const char *hostname;
27   int argc;
28   char **argv;
29   double kill_time;
30   xbt_dict_t properties;
31   unsigned auto_restart:1;
32 } s_smx_process_arg_t, *smx_process_arg_t;
33
34 /** @brief Process datatype */
35 typedef struct s_smx_process {
36   s_xbt_swag_hookup_t process_hookup;   /* simix_global->process_list */
37   s_xbt_swag_hookup_t synchro_hookup;   /* {mutex,cond,sem}->sleeping */
38   s_xbt_swag_hookup_t host_proc_hookup; /* smx_host->process_lis */
39   s_xbt_swag_hookup_t destroy_hookup;   /* simix_global->process_to_destroy */
40
41   unsigned long pid;
42   unsigned long ppid;
43   char *name;                   /**< @brief process name if any */
44   sg_host_t host;          /* the host on which the process is running */
45   smx_context_t context;        /* the context (uctx/raw/thread) that executes the user function */
46   xbt_running_ctx_t *running_ctx;
47   unsigned doexception:1;
48   unsigned blocked:1;
49   unsigned suspended:1;
50   unsigned auto_restart:1;
51
52   sg_host_t new_host;          /* if not null, the host on which the process must migrate to */
53   smx_synchro_t waiting_synchro;  /* the current blocking synchro if any */
54   xbt_fifo_t comms;       /* the current non-blocking communication synchros */
55   xbt_dict_t properties;
56   s_smx_simcall_t simcall;
57   void *data;                   /* kept for compatibility, it should be replaced with moddata */
58   xbt_dynar_t on_exit;     /* list of functions executed when the process dies */
59
60   xbt_main_func_t code;
61   int argc;
62   char **argv;
63   smx_timer_t kill_timer;
64   int segment_index;    /*Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
65 } s_smx_process_t;
66
67
68 XBT_PRIVATE smx_process_t SIMIX_process_create(
69                           const char *name,
70                           xbt_main_func_t code,
71                           void *data,
72                           const char *hostname,
73                           double kill_time,
74                           int argc, char **argv,
75                           xbt_dict_t properties,
76                           int auto_restart,
77                           smx_process_t parent_process);
78
79 XBT_PRIVATE void SIMIX_process_runall(void);
80 XBT_PRIVATE void SIMIX_process_kill(smx_process_t process, smx_process_t issuer);
81 XBT_PRIVATE void SIMIX_process_killall(smx_process_t issuer, int reset_pid);
82 XBT_PRIVATE smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args);
83 XBT_PRIVATE void SIMIX_process_stop(smx_process_t arg);
84 XBT_PRIVATE void SIMIX_process_cleanup(smx_process_t arg);
85 XBT_PRIVATE void SIMIX_process_empty_trash(void);
86 XBT_PRIVATE void SIMIX_process_yield(smx_process_t self);
87 XBT_PRIVATE xbt_running_ctx_t *SIMIX_process_get_running_context(void);
88 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
89 XBT_PRIVATE void SIMIX_process_change_host(smx_process_t process,
90              sg_host_t dest);
91 XBT_PRIVATE smx_synchro_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer);
92 XBT_PRIVATE void SIMIX_process_resume(smx_process_t process, smx_process_t issuer);
93 XBT_PRIVATE int SIMIX_process_get_PID(smx_process_t self);
94 XBT_PRIVATE int SIMIX_process_get_PPID(smx_process_t self);
95 XBT_PRIVATE void* SIMIX_process_get_data(smx_process_t process);
96 XBT_PRIVATE void SIMIX_process_set_data(smx_process_t process, void *data);
97 XBT_PRIVATE sg_host_t SIMIX_process_get_host(smx_process_t process);
98 XBT_PRIVATE const char* SIMIX_process_get_name(smx_process_t process);
99 XBT_PRIVATE smx_process_t SIMIX_process_get_by_name(const char* name);
100 XBT_PRIVATE int SIMIX_process_is_suspended(smx_process_t process);
101 XBT_PRIVATE xbt_dict_t SIMIX_process_get_properties(smx_process_t process);
102 XBT_PRIVATE smx_synchro_t SIMIX_process_join(smx_process_t issuer, smx_process_t process, double timeout);
103 XBT_PRIVATE smx_synchro_t SIMIX_process_sleep(smx_process_t process, double duration);
104 XBT_PRIVATE void SIMIX_post_process_sleep(smx_synchro_t synchro);
105
106 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_synchro_t synchro);
107 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_process_t process, int auto_restart);
108 XBT_PRIVATE smx_process_t SIMIX_process_restart(smx_process_t process, smx_process_t issuer);
109
110 void SIMIX_segment_index_set(smx_process_t, int);
111 extern void (*SMPI_switch_data_segment)(int);
112
113 SG_END_DECL()
114
115 #endif