Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix build.
[simgrid.git] / include / simgrid / forward.h
1 /* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef SIMGRID_TYPES_H
7 #define SIMGRID_TYPES_H
8
9 #include <xbt/base.h>
10
11 #ifdef __cplusplus
12
13 #include <boost/intrusive_ptr.hpp>
14 #include <vector>
15
16 namespace simgrid {
17
18 namespace s4u {
19 class Activity;
20 /** Smart pointer to a simgrid::s4u::Actor */
21 using ActivityPtr = boost::intrusive_ptr<Activity>;
22 XBT_PUBLIC void intrusive_ptr_release(const Activity* actor);
23 XBT_PUBLIC void intrusive_ptr_add_ref(const Activity* actor);
24
25 class Actor;
26 /** Smart pointer to a simgrid::s4u::Actor */
27 using ActorPtr = boost::intrusive_ptr<Actor>;
28 XBT_PUBLIC void intrusive_ptr_release(const Actor* actor);
29 XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor);
30
31 class Barrier;
32 /** Smart pointer to a simgrid::s4u::Barrier */
33 using BarrierPtr = boost::intrusive_ptr<Barrier>;
34 XBT_PUBLIC void intrusive_ptr_release(Barrier* m);
35 XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* m);
36
37 class Comm;
38 /** Smart pointer to a simgrid::s4u::Comm */
39 using CommPtr = boost::intrusive_ptr<Comm>;
40 XBT_PUBLIC void intrusive_ptr_release(Comm* c);
41 XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
42
43 class ConditionVariable;
44 /** @beginrst
45  * Smart pointer to a :cpp:type:`simgrid::s4u::ConditionVariable`
46  * @endrst
47  */
48 using ConditionVariablePtr = boost::intrusive_ptr<ConditionVariable>;
49 XBT_PUBLIC void intrusive_ptr_release(const ConditionVariable* c);
50 XBT_PUBLIC void intrusive_ptr_add_ref(const ConditionVariable* c);
51
52 class Engine;
53
54 class Exec;
55 /** Smart pointer to a simgrid::s4u::Exec */
56 using ExecPtr = boost::intrusive_ptr<Exec>;
57 XBT_PUBLIC void intrusive_ptr_release(Exec* e);
58 XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
59
60 class Host;
61
62 class Io;
63 /** Smart pointer to a simgrid::s4u::Io */
64 using IoPtr = boost::intrusive_ptr<Io>;
65 XBT_PUBLIC void intrusive_ptr_release(Io* i);
66 XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
67
68 class Link;
69
70 class Mailbox;
71
72 class Mutex;
73 XBT_PUBLIC void intrusive_ptr_release(const Mutex* m);
74 XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* m);
75 /**
76  * @beginrst
77  * Smart pointer to a :cpp:type:`simgrid::s4u::Mutex`
78  * @endrst
79  */
80 using MutexPtr = boost::intrusive_ptr<Mutex>;
81
82 class NetZone;
83 class VirtualMachine;
84 class File;
85
86 class Semaphore;
87 /** Smart pointer to a simgrid::s4u::Semaphore */
88 using SemaphorePtr = boost::intrusive_ptr<Semaphore>;
89 XBT_PUBLIC void intrusive_ptr_release(Semaphore* m);
90 XBT_PUBLIC void intrusive_ptr_add_ref(Semaphore* m);
91
92 class Disk;
93 class Storage;
94 } // namespace s4u
95
96 namespace config {
97 template <class T> class Flag;
98 }
99
100 namespace kernel {
101 class EngineImpl;
102 namespace actor {
103 class ActorImpl;
104 typedef boost::intrusive_ptr<ActorImpl> ActorImplPtr;
105
106 // What's executed as an actor code:
107 typedef std::function<void()> ActorCode;
108 // Create an ActorCode from the parameters parsed in the XML file (or elsewhere)
109 typedef std::function<ActorCode(std::vector<std::string> args)> ActorCodeFactory;
110 } // namespace actor
111
112 namespace activity {
113   class ActivityImpl;
114   enum class State;
115   typedef boost::intrusive_ptr<ActivityImpl> ActivityImplPtr;
116   XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
117   XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
118
119   class ConditionVariableImpl;
120
121   class CommImpl;
122   typedef boost::intrusive_ptr<CommImpl> CommImplPtr;
123   class ExecImpl;
124   typedef boost::intrusive_ptr<ExecImpl> ExecImplPtr;
125   class IoImpl;
126   typedef boost::intrusive_ptr<IoImpl> IoImplPtr;
127   class MutexImpl;
128   typedef boost::intrusive_ptr<MutexImpl> MutexImplPtr;
129   class RawImpl;
130   typedef boost::intrusive_ptr<RawImpl> RawImplPtr;
131   class SemaphoreImpl;
132   typedef boost::intrusive_ptr<SemaphoreImpl> SemaphoreImplPtr;
133   class SleepImpl;
134   typedef boost::intrusive_ptr<SleepImpl> SleepImplPtr;
135
136   class MailboxImpl;
137 }
138 namespace context {
139 class Context;
140 class ContextFactory;
141 } // namespace context
142 namespace lmm {
143 class Element;
144 class Variable;
145 class Constraint;
146 class ConstraintLight;
147 class System;
148 }
149 namespace resource {
150 class Action;
151 class Cpu;
152 class Model;
153 class Resource;
154 class CpuModel;
155 class NetworkModel;
156 class LinkImpl;
157 class NetworkAction;
158 class DiskImpl;
159 class DiskModel;
160 class StorageImpl;
161 class StorageType;
162 class StorageModel;
163 }
164 namespace routing {
165 class ClusterCreationArgs;
166 class LinkCreationArgs;
167 class NetPoint;
168 class NetZoneImpl;
169 class RouteCreationArgs;
170 }
171 namespace profile {
172 class Event;
173 class FutureEvtSet;
174 class Profile;
175 } // namespace profile
176 } // namespace kernel
177 namespace simix {
178   class Host;
179   class Timer;
180 }
181 namespace surf {
182   class HostImpl;
183   class HostModel;
184 }
185 namespace mc {
186 class CommunicationDeterminismChecker;
187 class SimcallInspector;
188 }
189 namespace vm {
190 class VMModel;
191 class VirtualMachineImpl;
192 } // namespace vm
193 } // namespace simgrid
194
195 typedef simgrid::s4u::Actor s4u_Actor;
196 typedef simgrid::s4u::Barrier s4u_Barrier;
197 typedef simgrid::s4u::Comm s4u_Comm;
198 typedef simgrid::s4u::Exec s4u_Exec;
199 typedef simgrid::s4u::Host s4u_Host;
200 typedef simgrid::s4u::Link s4u_Link;
201 typedef simgrid::s4u::File s4u_File;
202 typedef simgrid::s4u::ConditionVariable s4u_ConditionVariable;
203 typedef simgrid::s4u::Mailbox s4u_Mailbox;
204 typedef simgrid::s4u::Mutex s4u_Mutex;
205 typedef simgrid::s4u::Semaphore s4u_Semaphore;
206 typedef simgrid::s4u::Disk s4u_Disk;
207 typedef simgrid::s4u::Storage s4u_Storage;
208 typedef simgrid::s4u::NetZone s4u_NetZone;
209 typedef simgrid::s4u::VirtualMachine s4u_VM;
210
211 typedef simgrid::simix::Timer* smx_timer_t;
212 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
213 typedef simgrid::kernel::activity::ActivityImpl* smx_activity_t;
214 typedef simgrid::kernel::activity::ConditionVariableImpl* smx_cond_t;
215 typedef simgrid::kernel::activity::MailboxImpl* smx_mailbox_t;
216 typedef simgrid::kernel::activity::MutexImpl* smx_mutex_t;
217 typedef simgrid::kernel::activity::SemaphoreImpl* smx_sem_t;
218 XBT_ATTRIB_DEPRECATED_v330("Please use kernel::activity::State") typedef simgrid::kernel::activity::State e_smx_state_t;
219 #else
220
221 typedef struct s4u_Actor s4u_Actor;
222 typedef struct s4u_Barrier s4u_Barrier;
223 typedef struct s4u_Comm s4u_Comm;
224 typedef struct s4u_Exec s4u_Exec;
225 typedef struct s4u_Host s4u_Host;
226 typedef struct s4u_Link s4u_Link;
227 typedef struct s4u_File s4u_File;
228 typedef struct s4u_ConditionVariable s4u_ConditionVariable;
229 typedef struct s4u_Mailbox s4u_Mailbox;
230 typedef struct s4u_Mutex s4u_Mutex;
231 typedef struct s4u_Semaphore s4u_Semaphore;
232 typedef struct s4u_Disk s4u_Disk;
233 typedef struct s4u_Storage s4u_Storage;
234 typedef struct s4u_NetZone s4u_NetZone;
235 typedef struct s4u_VM s4u_VM;
236 XBT_ATTRIB_DEPRECATED_v330("Please stop using this type alias") typedef enum kernel_activity_state e_smx_state_t;
237
238 typedef struct s_smx_timer* smx_timer_t;
239 typedef struct s_smx_actor* smx_actor_t;
240 typedef struct s_smx_activity* smx_activity_t;
241 typedef struct s_smx_cond_t* smx_cond_t;
242 typedef struct s_smx_mailbox* smx_mailbox_t;
243 typedef struct s_smx_mutex* smx_mutex_t;
244 typedef struct s_smx_sem* smx_sem_t;
245
246 #endif
247
248 /** Pointer to a SimGrid barrier object */
249 typedef s4u_Barrier* sg_bar_t;
250 /** Constant pointer to a SimGrid barrier object */
251 typedef const s4u_Barrier* const_sg_bar_t;
252 typedef s4u_Comm* sg_comm_t;
253 typedef const s4u_Comm* const_sg_comm_t;
254 typedef s4u_Exec* sg_exec_t;
255 typedef const s4u_Exec* const_sg_exec_t;
256 typedef s4u_ConditionVariable* sg_cond_t;
257 typedef const s4u_ConditionVariable* const_sg_cond_t;
258 typedef s4u_Mailbox* sg_mailbox_t;
259 typedef const s4u_Mailbox* const_sg_mailbox_t;
260 typedef s4u_Mutex* sg_mutex_t;
261 typedef const s4u_Mutex* const_sg_mutex_t;
262 typedef s4u_Semaphore* sg_sem_t;
263 typedef const s4u_Semaphore* const_sg_sem_t;
264 typedef s4u_NetZone* sg_netzone_t;
265 typedef const s4u_NetZone* const_sg_netzone_t;
266 typedef s4u_Host* sg_host_t;
267 typedef const s4u_Host* const_sg_host_t;
268 typedef s4u_Link* sg_link_t;
269 typedef const s4u_Link* const_sg_link_t;
270 typedef s4u_Disk* sg_disk_t;
271 typedef const s4u_Disk* const_sg_disk_t;
272 typedef s4u_Storage* sg_storage_t;
273 typedef const s4u_Storage* const_sg_storage_t;
274 typedef s4u_File* sg_file_t;
275 typedef const s4u_File* const_sg_file_t;
276 typedef s4u_VM* sg_vm_t;
277 typedef const s4u_VM* const_sg_vm_t;
278 typedef s4u_Actor* sg_actor_t;
279 typedef const s4u_Actor* const_sg_actor_t;
280
281 typedef struct s_smx_simcall* smx_simcall_t;
282
283 /** @ingroup m_datatypes_management_details
284  * @brief Type for any simgrid size
285  */
286 typedef unsigned long long sg_size_t;
287
288 /** @ingroup m_datatypes_management_details
289  * @brief Type for any simgrid offset
290  */
291 typedef long long sg_offset_t;
292
293 /** Actor's ID, just like the classical processes' have PID in UNIX */
294 typedef long aid_t;
295
296 #endif /* SIMGRID_TYPES_H */