Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move two severly misnamed identifiers to make them static
[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 "simgrid/msg.h"
11
12 #include "src/kernel/activity/SynchroExec.hpp"
13 #include "src/kernel/activity/SynchroComm.hpp"
14
15 #include <xbt/Extendable.hpp>
16
17 SG_BEGIN_DECL()
18
19 /**************** datatypes **********************************/
20 /**************************** Host Extension *********************************/
21 namespace simgrid {
22 class MsgHostExt {
23 public:
24   static simgrid::xbt::Extension<s4u::Host, MsgHostExt> EXTENSION_ID;
25
26   ~MsgHostExt() {
27     delete file_descriptor_table;
28   }
29   std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
30 };
31 }
32 /********************************* Task **************************************/
33
34 typedef struct simdata_task {
35   ~simdata_task()
36   {
37     if (this->compute)
38       this->compute->unref();
39
40     /* parallel tasks only */
41     xbt_free(this->host_list);
42   }
43   void setUsed();
44   void setNotUsed()
45   {
46     this->isused = false;
47   }
48
49   simgrid::kernel::activity::Exec *compute = nullptr; /* SIMIX modeling of computation */
50   simgrid::kernel::activity::Comm *comm = nullptr;    /* SIMIX modeling of communication */
51   double bytes_amount = 0.0; /* Data size */
52   double flops_amount = 0.0; /* Computation size */
53   msg_process_t sender = nullptr;
54   msg_process_t receiver = nullptr;
55   msg_host_t source = nullptr;
56   double priority = 0.0;
57   double bound = 0.0; /* Capping for CPU resource */
58   double rate = 0.0;  /* Capping for network resource */
59
60   bool isused = false;  /* Indicates whether the task is used in SIMIX currently */
61   int host_nb = 0;      /* ==0 if sequential task; parallel task if not */
62   /*******  Parallel Tasks Only !!!! *******/
63   sg_host_t *host_list = nullptr;
64   double *flops_parallel_amount = nullptr;
65   double *bytes_parallel_amount = nullptr;
66
67 private:
68   void reportMultipleUse() const;
69 } s_simdata_task_t;
70
71 /********************************* File **************************************/
72 typedef struct simdata_file {
73   smx_file_t smx_file;
74 } s_simdata_file_t;
75
76 /******************************* Process *************************************/
77
78 typedef struct simdata_process {
79   msg_host_t m_host;              /* the host on which the process is running */
80   msg_host_t put_host;            /* used for debugging purposes */
81   smx_activity_t waiting_action;
82   msg_task_t waiting_task;
83   msg_error_t last_errno;       /* the last value returned by a MSG_function */
84
85   void* data;                   /* user data */
86 } s_simdata_process_t, *simdata_process_t;
87
88 typedef struct process_arg {
89   const char *name;
90   xbt_main_func_t code;
91   void *data;
92   msg_host_t m_host;
93   int argc;
94   char **argv;
95   double kill_time;
96 } s_process_arg_t, *process_arg_t;
97
98 typedef struct msg_comm {
99   smx_activity_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
100   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
101   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
102   msg_error_t status;           /* status of the communication once finished */
103 } s_msg_comm_t;
104
105 /************************** Global variables ********************************/
106 typedef struct MSG_Global {
107   int debug_multiple_use;       /* whether we want an error message when reusing the same Task for 2 things */
108   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
109   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
110   void_f_pvoid_t process_data_cleanup;
111 } s_MSG_Global_t, *MSG_Global_t;
112
113 /*extern MSG_Global_t msg_global;*/
114 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
115
116 /*************************************************************/
117 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
118 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
119 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
120 XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
121
122 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
123 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char *name,
124                                    std::function<void()> code, void *data,
125                                    sg_host_t host, double kill_time,
126                                    xbt_dict_t properties, int auto_restart,
127                                    smx_actor_t parent_process);
128 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
129
130 XBT_PRIVATE void MSG_post_create_environment();
131
132 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
133 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
134
135 /********** Tracing **********/
136 /* declaration of instrumentation functions from msg_task_instr.c */
137 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
138 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
139 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
140 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
141 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
142 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
143 XBT_PRIVATE void TRACE_msg_task_get_start();
144 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
145 XBT_PRIVATE void TRACE_msg_task_put_end();
146
147 /* declaration of instrumentation functions from msg_process_instr.c */
148 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
149 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
150 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
151 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
152 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
153 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
154 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
155 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
156 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
157 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
158
159 SG_END_DECL()
160
161 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(
162   const char *name, std::function<void()> code, void *data,
163   msg_host_t host, xbt_dict_t properties);
164
165 inline void simdata_task::setUsed()
166 {
167   if (this->isused)
168     this->reportMultipleUse();
169   if (msg_global->debug_multiple_use) {
170     // TODO, backtrace
171   }
172   this->isused = true;
173 }
174
175 #endif