Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move the synchronization stuff to its own directory
[simgrid.git] / src / msg / msg_private.h
1 /* Copyright (c) 2004-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 METASIMGRID_PRIVATE_H
8 #define METASIMGRID_PRIVATE_H
9
10 #include <exception>
11 #include <functional>
12
13 #include "simgrid/msg.h"
14 #include "simgrid/simix.h"
15 #include "src/include/surf/surf.h"
16 #include "xbt/base.h"
17 #include "xbt/fifo.h"
18 #include "xbt/dynar.h"
19 #include "xbt/swag.h"
20 #include "xbt/dict.h"
21 #include "xbt/config.h"
22 #include "src/instr/instr_private.h"
23
24 #include "src/synchro/SynchroExec.hpp"
25 #include "src/synchro/SynchroComm.hpp"
26
27 SG_BEGIN_DECL()
28
29 /**************** datatypes **********************************/
30
31 /********************************* Task **************************************/
32
33 typedef struct simdata_task {
34   ~simdata_task()
35   {
36     if (this->compute)
37       this->compute->unref();
38
39     /* parallel tasks only */
40     xbt_free(this->host_list);
41
42     xbt_dict_free(&this->affinity_mask_db);
43   }
44   void setUsed();
45   void setNotUsed()
46   {
47     this->isused = false;
48   }
49
50   simgrid::simix::Exec *compute = nullptr; /* SIMIX modeling of computation */
51   simgrid::simix::Comm *comm = nullptr;    /* SIMIX modeling of communication */
52   double bytes_amount = 0.0; /* Data size */
53   double flops_amount = 0.0; /* Computation size */
54   msg_process_t sender = nullptr;
55   msg_process_t receiver = nullptr;
56   msg_host_t source = nullptr;
57   double priority = 0.0;
58   double bound = 0.0; /* Capping for CPU resource */
59   double rate = 0.0;  /* Capping for network resource */
60
61   /* CPU affinity database of this task */
62   xbt_dict_t affinity_mask_db = nullptr; /* smx_host_t host => unsigned long mask */
63
64   bool isused = false;  /* Indicates whether the task is used in SIMIX currently */
65   int host_nb = 0;      /* ==0 if sequential task; parallel task if not */
66   /*******  Parallel Tasks Only !!!! *******/
67   sg_host_t *host_list = nullptr;
68   double *flops_parallel_amount = nullptr;
69   double *bytes_parallel_amount = nullptr;
70
71 private:
72   void reportMultipleUse() const;
73 } s_simdata_task_t;
74
75 /********************************* File **************************************/
76 typedef struct simdata_file {
77   smx_file_t smx_file;
78 } s_simdata_file_t;
79
80 XBT_PRIVATE int __MSG_host_get_file_descriptor_id(msg_host_t host);
81 XBT_PRIVATE void __MSG_host_release_file_descriptor_id(msg_host_t host, int id);
82
83 /******************************* Process *************************************/
84
85 typedef struct simdata_process {
86   msg_host_t m_host;              /* the host on which the process is running */
87   msg_host_t put_host;            /* used for debugging purposes */
88   smx_synchro_t waiting_action;
89   msg_task_t waiting_task;
90   msg_error_t last_errno;       /* the last value returned by a MSG_function */
91
92   void* data;                   /* user data */
93 } s_simdata_process_t, *simdata_process_t;
94
95 typedef struct process_arg {
96   const char *name;
97   xbt_main_func_t code;
98   void *data;
99   msg_host_t m_host;
100   int argc;
101   char **argv;
102   double kill_time;
103 } s_process_arg_t, *process_arg_t;
104
105 typedef struct msg_comm {
106   smx_synchro_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
107   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
108   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
109   msg_error_t status;           /* status of the communication once finished */
110 } s_msg_comm_t;
111
112 /******************************* VM *************************************/
113 typedef struct dirty_page {
114   double prev_clock;
115   double prev_remaining;
116   msg_task_t task;
117 } s_dirty_page, *dirty_page_t;
118
119 XBT_PUBLIC_DATA(const char*) MSG_vm_get_property_value(msg_vm_t vm, const char *name);
120 XBT_PUBLIC_DATA(xbt_dict_t) MSG_vm_get_properties(msg_vm_t vm);
121 XBT_PUBLIC_DATA(void) MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn);
122 XBT_PUBLIC_DATA(msg_vm_t) MSG_vm_get_by_name(const char *name);
123 XBT_PUBLIC_DATA(const char*) MSG_vm_get_name(msg_vm_t vm);
124
125 /************************** Global variables ********************************/
126 typedef struct MSG_Global {
127   xbt_fifo_t host;
128   int session;
129   int debug_multiple_use;
130   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
131   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
132   void_f_pvoid_t process_data_cleanup;
133 } s_MSG_Global_t, *MSG_Global_t;
134
135 /*extern MSG_Global_t msg_global;*/
136 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
137
138 /*************************************************************/
139 // FIXME: KILLME
140 #  define MSG_RETURN(val) return(val)
141
142 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
143 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
144 XBT_PRIVATE void __MSG_host_priv_free(msg_host_priv_t priv);
145 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
146 XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
147
148 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc);
149 XBT_PRIVATE smx_process_t MSG_process_create_from_SIMIX(const char *name,
150                                    std::function<void()> code, void *data,
151                                    const char *hostname, double kill_time,
152                                    xbt_dict_t properties, int auto_restart,
153                                    smx_process_t parent_process);
154 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_synchro_t comm, void* buff, size_t buff_size);
155
156 XBT_PRIVATE void MSG_post_create_environment(void);
157
158 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
159 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
160
161 /********** Tracing **********/
162 /* declaration of instrumentation functions from msg_task_instr.c */
163 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
164 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
165 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
166 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
167 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
168 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
169 XBT_PRIVATE void TRACE_msg_task_get_start(void);
170 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
171 XBT_PRIVATE void TRACE_msg_task_put_end(void);
172
173 /* declaration of instrumentation functions from msg_process_instr.c */
174 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
175 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
176 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
177 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
178 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
179 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
180 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
181 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
182 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
183 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
184
185 /* declaration of instrumentation functions from instr_msg_vm.c */
186 XBT_PRIVATE char *instr_vm_id(msg_vm_t vm, char *str, int len);
187 XBT_PRIVATE char *instr_vm_id_2(const char *vm_name, char *str, int len);
188 XBT_PRIVATE void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host, msg_host_t new_host);
189 XBT_PRIVATE void TRACE_msg_vm_start(msg_vm_t vm);
190 XBT_PRIVATE void TRACE_msg_vm_create(const char *vm_name, msg_host_t host);
191 XBT_PRIVATE void TRACE_msg_vm_kill(msg_vm_t process);
192 XBT_PRIVATE void TRACE_msg_vm_suspend(msg_vm_t vm);
193 XBT_PRIVATE void TRACE_msg_vm_resume(msg_vm_t vm);
194 XBT_PRIVATE void TRACE_msg_vm_save(msg_vm_t vm);
195 XBT_PRIVATE void TRACE_msg_vm_restore(msg_vm_t vm);
196 XBT_PRIVATE void TRACE_msg_vm_end(msg_vm_t vm);
197
198 SG_END_DECL()
199
200 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(
201   const char *name, std::function<void()> code, void *data,
202   msg_host_t host, xbt_dict_t properties);
203
204 inline void simdata_task::setUsed()
205 {
206   if (this->isused)
207     this->reportMultipleUse();
208   if (msg_global->debug_multiple_use) {
209     // TODO, backtrace
210   }
211   this->isused = true;
212 }
213
214 #endif