Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetic to make the code easier to read
[simgrid.git] / include / simgrid / forward.h
1 /* Copyright (c) 2004-2019. 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
15 namespace simgrid {
16
17 namespace s4u {
18 class Activity;
19
20 class Actor;
21 /** Smart pointer to a simgrid::s4u::Actor */
22 typedef boost::intrusive_ptr<Actor> ActorPtr;
23 XBT_PUBLIC void intrusive_ptr_release(Actor* actor);
24 XBT_PUBLIC void intrusive_ptr_add_ref(Actor* actor);
25
26 class Barrier;
27 /** Smart pointer to a simgrid::s4u::Barrier */
28 typedef boost::intrusive_ptr<Barrier> BarrierPtr;
29 XBT_PUBLIC void intrusive_ptr_release(Barrier* m);
30 XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* m);
31
32 class Comm;
33 /** Smart pointer to a simgrid::s4u::Comm */
34 typedef boost::intrusive_ptr<Comm> CommPtr;
35 XBT_PUBLIC void intrusive_ptr_release(Comm* c);
36 XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
37
38 class ConditionVariable;
39 /** Smart pointer to a simgrid::s4u::ConditionVariable */
40 typedef boost::intrusive_ptr<ConditionVariable> ConditionVariablePtr;
41 XBT_PUBLIC void intrusive_ptr_release(ConditionVariable* c);
42 XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariable* c);
43
44 class Engine;
45
46 class Exec;
47 /** Smart pointer to a simgrid::s4u::Exec */
48 typedef boost::intrusive_ptr<Exec> ExecPtr;
49 XBT_PUBLIC void intrusive_ptr_release(Exec* e);
50 XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
51 class ExecSeq;
52 typedef boost::intrusive_ptr<ExecSeq> ExecSeqPtr;
53 class ExecPar;
54 typedef boost::intrusive_ptr<ExecPar> ExecParPtr;
55
56 class Host;
57
58 class Io;
59 /** Smart pointer to a simgrid::s4u::Io */
60 typedef boost::intrusive_ptr<Io> IoPtr;
61 XBT_PUBLIC void intrusive_ptr_release(Io* i);
62 XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
63
64 class Link;
65
66 class Mailbox;
67
68 class Mutex;
69 XBT_PUBLIC void intrusive_ptr_release(Mutex* m);
70 XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* m);
71 /** Smart pointer to a simgrid::s4u::Mutex */
72 typedef boost::intrusive_ptr<Mutex> MutexPtr;
73
74 class NetZone;
75 class VirtualMachine;
76 class File;
77
78 class Semaphore;
79 /** Smart pointer to a simgrid::s4u::Semaphore */
80 typedef boost::intrusive_ptr<Semaphore> SemaphorePtr;
81 XBT_PUBLIC void intrusive_ptr_release(Semaphore* m);
82 XBT_PUBLIC void intrusive_ptr_add_ref(Semaphore* m);
83
84 class Storage;
85 } // namespace s4u
86
87 namespace config {
88 template <class T> class Flag;
89 }
90
91 namespace kernel {
92 class EngineImpl;
93 namespace actor {
94 class ActorImpl;
95 typedef boost::intrusive_ptr<ActorImpl> ActorImplPtr;
96 } // namespace actor
97
98 namespace activity {
99   class ActivityImpl;
100   typedef boost::intrusive_ptr<ActivityImpl> ActivityImplPtr;
101   XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
102   XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
103
104   class ConditionVariableImpl;
105
106   class CommImpl;
107   typedef boost::intrusive_ptr<CommImpl> CommImplPtr;
108   class ExecImpl;
109   typedef boost::intrusive_ptr<ExecImpl> ExecImplPtr;
110   class IoImpl;
111   typedef boost::intrusive_ptr<IoImpl> IoImplPtr;
112   class MutexImpl;
113   typedef boost::intrusive_ptr<MutexImpl> MutexImplPtr;
114   class RawImpl;
115   typedef boost::intrusive_ptr<RawImpl> RawImplPtr;
116   class SemaphoreImpl;
117   typedef boost::intrusive_ptr<SemaphoreImpl> SemaphoreImplPtr;
118   class SleepImpl;
119   typedef boost::intrusive_ptr<SleepImpl> SleepImplPtr;
120
121   class MailboxImpl;
122 }
123 namespace context {
124 class Context;
125 class ContextFactory;
126 } // namespace context
127 namespace lmm {
128 class Element;
129 class Variable;
130 class Constraint;
131 class ConstraintLight;
132 class System;
133 }
134 namespace resource {
135 class Action;
136 class Cpu;
137 class Model;
138 class Resource;
139 class CpuModel;
140 class NetworkModel;
141 class LinkImpl;
142 class NetworkAction;
143 class StorageImpl;
144 class StorageType;
145 class StorageModel;
146 }
147 namespace routing {
148 class ClusterCreationArgs;
149 class LinkCreationArgs;
150 class NetPoint;
151 class NetZoneImpl;
152 class RouteCreationArgs;
153 }
154 namespace profile {
155 class Event;
156 class FutureEvtSet;
157 class Profile;
158 } // namespace profile
159 } // namespace kernel
160 namespace simix {
161   class Host;
162   class Timer;
163 }
164 namespace surf {
165   class HostImpl;
166   class HostModel;
167 }
168 namespace mc {
169 class CommunicationDeterminismChecker;
170 }
171 namespace vm {
172 class VMModel;
173 class VirtualMachineImpl;
174 } // namespace vm
175 } // namespace simgrid
176
177 typedef simgrid::s4u::Actor s4u_Actor;
178 typedef simgrid::s4u::Barrier s4u_Barrier;
179 typedef simgrid::s4u::Host s4u_Host;
180 typedef simgrid::s4u::Link s4u_Link;
181 typedef simgrid::s4u::File s4u_File;
182 typedef simgrid::s4u::ConditionVariable s4u_ConditionVariable;
183 typedef simgrid::s4u::Mutex s4u_Mutex;
184 typedef simgrid::s4u::Semaphore s4u_Semaphore;
185 typedef simgrid::s4u::Storage s4u_Storage;
186 typedef simgrid::s4u::NetZone s4u_NetZone;
187 typedef simgrid::s4u::VirtualMachine s4u_VM;
188 typedef boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> smx_activity_t;
189
190 typedef simgrid::simix::Timer* smx_timer_t;
191 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
192 typedef simgrid::kernel::activity::ConditionVariableImpl* smx_cond_t;
193 typedef simgrid::kernel::activity::MailboxImpl* smx_mailbox_t;
194 typedef simgrid::kernel::activity::MutexImpl* smx_mutex_t;
195 typedef simgrid::kernel::activity::SemaphoreImpl* smx_sem_t;
196
197 #else
198
199 typedef struct s4u_Actor s4u_Actor;
200 typedef struct s4u_Barrier s4u_Barrier;
201 typedef struct s4u_Host s4u_Host;
202 typedef struct s4u_Link s4u_Link;
203 typedef struct s4u_File s4u_File;
204 typedef struct s4u_ConditionVariable s4u_ConditionVariable;
205 typedef struct s4u_Mutex s4u_Mutex;
206 typedef struct s4u_Semaphore s4u_Semaphore;
207 typedef struct s4u_Storage s4u_Storage;
208 typedef struct s4u_NetZone s4u_NetZone;
209 typedef struct s4u_VM s4u_VM;
210 typedef struct kernel_Activity* smx_activity_t;
211
212 typedef struct s_smx_timer* smx_timer_t;
213 typedef struct s_smx_actor* smx_actor_t;
214 typedef struct s_smx_cond_t* smx_cond_t;
215 typedef struct s_smx_mailbox* smx_mailbox_t;
216 typedef struct s_smx_mutex* smx_mutex_t;
217 typedef struct s_smx_sem* smx_sem_t;
218
219 #endif
220
221 typedef s4u_Barrier* sg_bar_t;
222 typedef s4u_ConditionVariable* sg_cond_t;
223 typedef s4u_Mutex* sg_mutex_t;
224 typedef s4u_Semaphore* sg_sem_t;
225 typedef s4u_NetZone* sg_netzone_t;
226 typedef s4u_Host* sg_host_t;
227 typedef s4u_Link* sg_link_t;
228 typedef s4u_Storage* sg_storage_t;
229 typedef s4u_File* sg_file_t;
230 typedef s4u_VM* sg_vm_t;
231 typedef s4u_Actor* sg_actor_t;
232
233 typedef struct s_smx_simcall* smx_simcall_t;
234
235 /** @ingroup m_datatypes_management_details
236  * @brief Type for any simgrid size
237  */
238 typedef unsigned long long sg_size_t;
239
240 /** @ingroup m_datatypes_management_details
241  * @brief Type for any simgrid offset
242  */
243 typedef long long sg_offset_t;
244
245 /** Actor's ID, just like the classical processes' have PID in UNIX */
246 typedef long aid_t;
247
248 #endif /* SIMGRID_TYPES_H */