1 /* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_TYPES_H
7 #define SIMGRID_TYPES_H
13 #include <boost/intrusive_ptr.hpp>
20 /** Smart pointer to a simgrid::s4u::Activity */
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);
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);
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);
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);
43 class ConditionVariable;
45 * Smart pointer to a :cpp:type:`simgrid::s4u::ConditionVariable`
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);
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);
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);
69 class SplitDuplexLink;
74 XBT_PUBLIC void intrusive_ptr_release(const Mutex* m);
75 XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* m);
78 * Smart pointer to a :cpp:type:`simgrid::s4u::Mutex`
81 using MutexPtr = boost::intrusive_ptr<Mutex>;
88 /** Smart pointer to a simgrid::s4u::Semaphore */
89 using SemaphorePtr = boost::intrusive_ptr<Semaphore>;
90 XBT_PUBLIC void intrusive_ptr_release(const Semaphore* m);
91 XBT_PUBLIC void intrusive_ptr_add_ref(const Semaphore* m);
95 * @brief Callback to dynamically change the resource's capacity
97 * Allows user to change resource's capacity depending on the number of concurrent activities
98 * running on the resource at a given instant
100 using NonLinearResourceCb = std::function<double(double capacity, int n_activities)>;
104 template <class T> class Flag;
111 using ActorImplPtr = boost::intrusive_ptr<ActorImpl>;
113 // What's executed as an actor code:
114 using ActorCode = std::function<void()>;
115 // Create an ActorCode from the parameters parsed in the XML file (or elsewhere)
116 using ActorCodeFactory = std::function<ActorCode(std::vector<std::string> args)>;
119 class SimcallObserver;
120 class ObjectAccessSimcallObserver;
121 class ObjectAccessSimcallItem;
127 using ActivityImplPtr = boost::intrusive_ptr<ActivityImpl>;
128 XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
129 XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
132 using BarrierImplPtr = boost::intrusive_ptr<BarrierImpl>;
133 XBT_PUBLIC void intrusive_ptr_add_ref(BarrierImpl* cond);
134 XBT_PUBLIC void intrusive_ptr_release(BarrierImpl* cond);
135 class BarrierAcquisitionImpl;
136 using BarrierAcquisitionImplPtr = boost::intrusive_ptr<BarrierAcquisitionImpl>;
138 class ConditionVariableImpl;
139 using ConditionVariableImplPtr = boost::intrusive_ptr<ConditionVariableImpl>;
140 XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariableImpl* cond);
141 XBT_PUBLIC void intrusive_ptr_release(ConditionVariableImpl* cond);
144 using CommImplPtr = boost::intrusive_ptr<CommImpl>;
146 using ExecImplPtr = boost::intrusive_ptr<ExecImpl>;
148 using IoImplPtr = boost::intrusive_ptr<IoImpl>;
150 using MutexImplPtr = boost::intrusive_ptr<MutexImpl>;
151 class MutexAcquisitionImpl;
152 using MutexAcquisitionImplPtr = boost::intrusive_ptr<MutexAcquisitionImpl>;
153 XBT_PUBLIC void intrusive_ptr_add_ref(MutexImpl* mutex);
154 XBT_PUBLIC void intrusive_ptr_release(MutexImpl* mutex);
156 using SynchroImplPtr = boost::intrusive_ptr<SynchroImpl>;
158 using SemaphoreImplPtr = boost::intrusive_ptr<SemaphoreImpl>;
159 class SemAcquisitionImpl;
160 using SemAcquisitionImplPtr = boost::intrusive_ptr<SemAcquisitionImpl>;
161 XBT_PUBLIC void intrusive_ptr_add_ref(SemaphoreImpl* sem);
162 XBT_PUBLIC void intrusive_ptr_release(SemaphoreImpl* sem);
164 using SleepImplPtr = boost::intrusive_ptr<SleepImpl>;
170 class ContextFactory;
171 } // namespace context
176 class ConstraintLight;
190 class StandardLinkImpl;
191 class SplitDuplexLinkImpl;
195 class VirtualMachineImpl;
209 } // namespace profile
210 } // namespace kernel
215 } // namespace simgrid
217 using s4u_Actor = simgrid::s4u::Actor;
218 using s4u_Barrier = simgrid::s4u::Barrier;
219 using s4u_Comm = simgrid::s4u::Comm;
220 using s4u_Exec = simgrid::s4u::Exec;
221 using s4u_Host = simgrid::s4u::Host;
222 using s4u_Link = simgrid::s4u::Link;
223 using s4u_File = simgrid::s4u::File;
224 using s4u_ConditionVariable = simgrid::s4u::ConditionVariable;
225 using s4u_Mailbox = simgrid::s4u::Mailbox;
226 using s4u_Mutex = simgrid::s4u::Mutex;
227 using s4u_Semaphore = simgrid::s4u::Semaphore;
228 using s4u_Disk = simgrid::s4u::Disk;
229 using s4u_NetZone = simgrid::s4u::NetZone;
230 using s4u_VM = simgrid::s4u::VirtualMachine;
233 XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::timer::Timer*") = simgrid::kernel::timer::Timer*;
235 XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::actor::ActorImpl*") = simgrid::kernel::actor::ActorImpl*;
236 using smx_activity_t = simgrid::kernel::activity::ActivityImpl*;
237 using smx_cond_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::ConditionVariableImpl*") =
238 simgrid::kernel::activity::ConditionVariableImpl*;
239 using smx_mailbox_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::MailboxImpl*") =
240 simgrid::kernel::activity::MailboxImpl*;
241 using smx_mutex_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::MutexImpl*") =
242 simgrid::kernel::activity::MutexImpl*;
243 using smx_sem_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::SemaphoreImpl*") =
244 simgrid::kernel::activity::SemaphoreImpl*;
247 typedef struct s4u_Actor s4u_Actor;
248 typedef struct s4u_Barrier s4u_Barrier;
249 typedef struct s4u_Comm s4u_Comm;
250 typedef struct s4u_Exec s4u_Exec;
251 typedef struct s4u_Host s4u_Host;
252 typedef struct s4u_Link s4u_Link;
253 typedef struct s4u_File s4u_File;
254 typedef struct s4u_ConditionVariable s4u_ConditionVariable;
255 typedef struct s4u_Mailbox s4u_Mailbox;
256 typedef struct s4u_Mutex s4u_Mutex;
257 typedef struct s4u_Semaphore s4u_Semaphore;
258 typedef struct s4u_Disk s4u_Disk;
259 typedef struct s4u_NetZone s4u_NetZone;
260 typedef struct s4u_VM s4u_VM;
262 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_timer* smx_timer_t;
263 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_actor* smx_actor_t;
264 typedef struct s_smx_activity* smx_activity_t;
265 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_cond_t* smx_cond_t;
266 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_mailbox* smx_mailbox_t;
267 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_mutex* smx_mutex_t;
268 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_sem* smx_sem_t;
272 /** Pointer to a SimGrid barrier object */
273 typedef s4u_Barrier* sg_bar_t;
274 /** Constant pointer to a SimGrid barrier object */
275 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef const s4u_Barrier* const_sg_bar_t;
276 typedef s4u_Comm* sg_comm_t;
277 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef const s4u_Comm* const_sg_comm_t;
278 typedef s4u_Exec* sg_exec_t;
279 typedef const s4u_Exec* const_sg_exec_t;
280 typedef s4u_ConditionVariable* sg_cond_t;
281 typedef const s4u_ConditionVariable* const_sg_cond_t;
282 typedef s4u_Mailbox* sg_mailbox_t;
283 typedef const s4u_Mailbox* const_sg_mailbox_t;
284 typedef s4u_Mutex* sg_mutex_t;
285 typedef const s4u_Mutex* const_sg_mutex_t;
286 typedef s4u_Semaphore* sg_sem_t;
287 typedef const s4u_Semaphore* const_sg_sem_t;
288 typedef s4u_NetZone* sg_netzone_t;
289 typedef const s4u_NetZone* const_sg_netzone_t;
290 typedef s4u_Host* sg_host_t;
291 typedef const s4u_Host* const_sg_host_t;
292 typedef s4u_Link* sg_link_t;
293 typedef const s4u_Link* const_sg_link_t;
294 typedef s4u_Disk* sg_disk_t;
295 typedef const s4u_Disk* const_sg_disk_t;
296 /** Pointer to a SimGrid file object @ingroup plugin_filesystem */
297 typedef s4u_File* sg_file_t;
298 /** Constant pointer to a SimGrid file object @ingroup plugin_filesystem */
299 typedef const s4u_File* const_sg_file_t;
300 typedef s4u_VM* sg_vm_t;
301 typedef const s4u_VM* const_sg_vm_t;
302 /** Pointer to an actor object */
303 typedef s4u_Actor* sg_actor_t;
304 /** Pointer to a constant actor object */
305 typedef const s4u_Actor* const_sg_actor_t;
307 /** @ingroup m_datatypes_management_details
308 * @brief Type for any simgrid size
310 typedef unsigned long long sg_size_t;
312 /** @ingroup m_datatypes_management_details
313 * @brief Type for any simgrid offset
315 typedef long long sg_offset_t;
317 /** Actor's ID, just like the classical processes' have PID in UNIX */
321 SG_OK /** Code returned when no problem occured */,
322 SG_ERROR_CANCELED /** Code returned when something got canceled before completion */,
323 SG_ERROR_TIMEOUT /** Code returned when timeout elapsed */,
324 SG_ERROR_HOST /** Code returned when a host fails */,
325 SG_ERROR_NETWORK /** Code returned when a communication fails because of the network or because of the remote host */,
326 SG_ERROR_STORAGE /** Code returned when a storage fails */,
327 SG_ERROR_VM /** Code returned when a VM fails */
330 XBT_PUBLIC int SMPI_is_inited();
332 #endif /* SIMGRID_TYPES_H */