Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't define variables in header file.!
[simgrid.git] / src / msg / msg_private.h
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 METASIMGRID_PRIVATE_H
8 #define METASIMGRID_PRIVATE_H
9
10 #include "msg/msg.h"
11 #include "simgrid/simix.h"
12 #include "surf/surf.h"
13 #include "xbt/fifo.h"
14 #include "xbt/dynar.h"
15 #include "xbt/swag.h"
16 #include "xbt/dict.h"
17 #include "xbt/config.h"
18 #include "instr/instr_private.h"
19 SG_BEGIN_DECL()
20
21 /**************** datatypes **********************************/
22
23 /********************************* Task **************************************/
24
25 typedef struct simdata_task {
26   smx_action_t compute;         /* SIMIX modeling of computation */
27   smx_action_t comm;            /* SIMIX modeling of communication */
28   double message_size;          /* Data size */
29   double computation_amount;    /* Computation size */
30   msg_process_t sender;
31   msg_process_t receiver;
32   msg_host_t source;
33   double priority;
34   double rate;
35   int isused;  /* Indicates whether the task is used in SIMIX currently */
36   int host_nb;                  /* ==0 if sequential task; parallel task if not */
37   /*******  Parallel Tasks Only !!!! *******/
38   smx_host_t *host_list;
39   double *comp_amount;
40   double *comm_amount;
41 } s_simdata_task_t;
42
43 /********************************* File **************************************/
44 typedef struct simdata_file {
45   smx_file_t smx_file;
46 } s_simdata_file_t;
47
48 /*************** Begin GPU ***************/
49 typedef struct simdata_gpu_task {
50   double computation_amount;    /* Computation size */
51   double dispatch_latency;
52   double collect_latency;
53   int isused;  /* Indicates whether the task is used in SIMIX currently */
54 } s_simdata_gpu_task_t;
55 /*************** End GPU ***************/
56
57 /******************************* Process *************************************/
58
59 typedef struct simdata_process {
60   msg_host_t m_host;              /* the host on which the process is running */
61   msg_host_t put_host;            /* used for debugging purposes */
62 #ifdef MSG_USE_DEPRECATED
63   m_channel_t put_channel;      /* used for debugging purposes */
64 #endif
65   smx_action_t waiting_action;
66   msg_task_t waiting_task;
67   char **argv;                  /* arguments table if any */
68   int argc;                     /* arguments number if any */
69   msg_error_t last_errno;       /* the last value returned by a MSG_function */
70
71   msg_vm_t vm;                 /* virtual machine the process is in */
72
73   void* data;                   /* user data */
74 } s_simdata_process_t, *simdata_process_t;
75
76 typedef struct process_arg {
77   const char *name;
78   xbt_main_func_t code;
79   void *data;
80   msg_host_t m_host;
81   int argc;
82   char **argv;
83   double kill_time;
84 } s_process_arg_t, *process_arg_t;
85
86 typedef struct msg_comm {
87   smx_action_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
88   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
89   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
90   msg_error_t status;           /* status of the communication once finished */
91 } s_msg_comm_t;
92 /*
93 typedef enum {
94   msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
95 } e_msg_vm_state_t;
96
97 typedef struct msg_vm {
98   const char *name;
99   s_xbt_swag_hookup_t all_vms_hookup;
100   s_xbt_swag_hookup_t host_vms_hookup;
101   xbt_dynar_t processes;
102   e_msg_vm_state_t state;
103   msg_host_t location;
104   int coreAmount;
105 } s_msg_vm_t;
106 */
107 /************************** Global variables ********************************/
108 typedef struct MSG_Global {
109   xbt_fifo_t host;
110 #ifdef MSG_USE_DEPRECATED
111   int max_channel;
112 #endif
113   int session;
114   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
115   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
116   void_f_pvoid_t process_data_cleanup;
117   xbt_swag_t vms;
118 } s_MSG_Global_t, *MSG_Global_t;
119
120 /*extern MSG_Global_t msg_global;*/
121 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
122
123
124 /*************************************************************/
125
126 #ifdef MSG_USE_DEPRECATED
127 #  define PROCESS_SET_ERRNO(val) \
128   (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno=val)
129 #  define PROCESS_GET_ERRNO() \
130   (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno)
131 #define MSG_RETURN(val) do {PROCESS_SET_ERRNO(val);return(val);} while(0)
132 /* #define CHECK_ERRNO()  ASSERT((PROCESS_GET_ERRNO()!=MSG_HOST_FAILURE),"Host failed, you cannot call this function.") */
133
134 #else
135 #  define MSG_RETURN(val) return(val)
136 #endif
137
138 msg_host_t __MSG_host_create(smx_host_t workstation);
139 void __MSG_host_destroy(msg_host_priv_t host);
140
141 void __MSG_display_process_status(void);
142
143 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc);
144 void MSG_process_create_from_SIMIX(smx_process_t *process, const char *name,
145                                    xbt_main_func_t code, void *data,
146                                    const char *hostname, double kill_time,  int argc,
147                                    char **argv, xbt_dict_t properties, int auto_restart);
148 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size);
149
150 void _MSG_action_init(void);
151 void _MSG_action_exit(void);
152
153 void MSG_post_create_environment(void);
154
155 /********** Tracing **********/
156 /* declaration of instrumentation functions from msg_task_instr.c */
157 void TRACE_msg_set_task_category(msg_task_t task, const char *category);
158 void TRACE_msg_task_create(msg_task_t task);
159 void TRACE_msg_task_execute_start(msg_task_t task);
160 void TRACE_msg_task_execute_end(msg_task_t task);
161 void TRACE_msg_task_destroy(msg_task_t task);
162 void TRACE_msg_task_get_start(void);
163 void TRACE_msg_task_get_end(double start_time, msg_task_t task);
164 int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
165 void TRACE_msg_task_put_end(void);
166
167 /* declaration of instrumentation functions from msg_process_instr.c */
168 char *instr_process_id (msg_process_t proc, char *str, int len);
169 char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
170 void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host,
171                                    msg_host_t new_host);
172 void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
173 void TRACE_msg_process_destroy (const char *process_name, int process_pid, msg_host_t host);
174 void TRACE_msg_process_kill(msg_process_t process);
175 void TRACE_msg_process_suspend(msg_process_t process);
176 void TRACE_msg_process_resume(msg_process_t process);
177 void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
178 void TRACE_msg_process_sleep_out(msg_process_t process);
179 void TRACE_msg_process_end(msg_process_t process);
180
181 /* declaration of instrumentation functions from instr_msg_vm.c */
182 char *instr_vm_id (msg_vm_t vm, char *str, int len);
183 char *instr_vm_id_2 (const char *vm_name, char *str, int len);
184 void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host,
185                                    msg_host_t new_host);
186 void TRACE_msg_vm_create (const char *vm_name, msg_host_t host);
187 void TRACE_msg_vm_kill(msg_vm_t process);
188 void TRACE_msg_vm_suspend(msg_vm_t vm);
189 void TRACE_msg_vm_resume(msg_vm_t vm);
190 void TRACE_msg_vm_sleep_in(msg_vm_t vm);
191 void TRACE_msg_vm_sleep_out(msg_vm_t vm);
192 void TRACE_msg_vm_end(msg_vm_t vm);
193
194 SG_END_DECL()
195 #endif