include/simgrid/forward.h

   1 /* Copyright (c) 2004-2022. 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::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);
  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 class SplitDuplexLink;
  70
  71 class Mailbox;
  72
  73 class Mutex;
  74 XBT_PUBLIC void intrusive_ptr_release(const Mutex* m);
  75 XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* m);
  76 /**
  77  * @beginrst
  78  * Smart pointer to a :cpp:type:`simgrid::s4u::Mutex`
  79  * @endrst
  80  */
  81 using MutexPtr = boost::intrusive_ptr<Mutex>;
  82
  83 class NetZone;
  84 class VirtualMachine;
  85 class File;
  86
  87 class Semaphore;
  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);
  92
  93 class Disk;
  94 /**
  95  * @brief Callback to dynamically change the resource's capacity
  96  *
  97  * Allows user to change resource's capacity depending on the number of concurrent activities
  98  * running on the resource at a given instant
  99  */
 100 using NonLinearResourceCb = std::function<double(double capacity, int n_activities)>;
 101 } // namespace s4u
 102
 103 namespace config {
 104 template <class T> class Flag;
 105 }
 106
 107 namespace kernel {
 108 class EngineImpl;
 109 namespace actor {
 110 class ActorImpl;
 111 using ActorImplPtr = boost::intrusive_ptr<ActorImpl>;
 112
 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)>;
 117
 118 class SimcallObserver;
 119 } // namespace actor
 120
 121 namespace activity {
 122   class ActivityImpl;
 123   enum class State;
 124   using ActivityImplPtr = boost::intrusive_ptr<ActivityImpl>;
 125   XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
 126   XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
 127
 128   class BarrierImpl;
 129   using BarrierImplPtr = boost::intrusive_ptr<BarrierImpl>;
 130   XBT_PUBLIC void intrusive_ptr_add_ref(BarrierImpl* cond);
 131   XBT_PUBLIC void intrusive_ptr_release(BarrierImpl* cond);
 132   class BarrierAcquisitionImpl;
 133   using BarrierAcquisitionImplPtr = boost::intrusive_ptr<BarrierAcquisitionImpl>;
 134
 135   class ConditionVariableImpl;
 136   using ConditionVariableImplPtr = boost::intrusive_ptr<ConditionVariableImpl>;
 137   XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariableImpl* cond);
 138   XBT_PUBLIC void intrusive_ptr_release(ConditionVariableImpl* cond);
 139
 140   class CommImpl;
 141   using CommImplPtr = boost::intrusive_ptr<CommImpl>;
 142   class ExecImpl;
 143   using ExecImplPtr = boost::intrusive_ptr<ExecImpl>;
 144   class IoImpl;
 145   using IoImplPtr = boost::intrusive_ptr<IoImpl>;
 146   class MutexImpl;
 147   using MutexImplPtr = boost::intrusive_ptr<MutexImpl>;
 148   class MutexAcquisitionImpl;
 149   using MutexAcquisitionImplPtr = boost::intrusive_ptr<MutexAcquisitionImpl>;
 150   XBT_PUBLIC void intrusive_ptr_add_ref(MutexImpl* mutex);
 151   XBT_PUBLIC void intrusive_ptr_release(MutexImpl* mutex);
 152   class SynchroImpl;
 153   using SynchroImplPtr = boost::intrusive_ptr<SynchroImpl>;
 154   class SemaphoreImpl;
 155   using SemaphoreImplPtr = boost::intrusive_ptr<SemaphoreImpl>;
 156   class SemAcquisitionImpl;
 157   using SemAcquisitionImplPtr = boost::intrusive_ptr<SemAcquisitionImpl>;
 158   XBT_PUBLIC void intrusive_ptr_add_ref(SemaphoreImpl* sem);
 159   XBT_PUBLIC void intrusive_ptr_release(SemaphoreImpl* sem);
 160   class SleepImpl;
 161   using SleepImplPtr = boost::intrusive_ptr<SleepImpl>;
 162
 163   class MailboxImpl;
 164 }
 165 namespace context {
 166 class Context;
 167 class ContextFactory;
 168 } // namespace context
 169 namespace lmm {
 170 class Element;
 171 class Variable;
 172 class Constraint;
 173 class ConstraintLight;
 174 class System;
 175 }
 176 namespace resource {
 177 class Action;
 178 class CpuImpl;
 179 class Model;
 180 class Resource;
 181 class CpuModel;
 182 class HostImpl;
 183 class HostModel;
 184 class NetworkModel;
 185 class NetworkModelIntf;
 186 class LinkImpl;
 187 class StandardLinkImpl;
 188 class SplitDuplexLinkImpl;
 189 class NetworkAction;
 190 class DiskImpl;
 191 class DiskModel;
 192 class VirtualMachineImpl;
 193 class VMModel;
 194 }
 195 namespace timer {
 196 class Timer;
 197 }
 198 namespace routing {
 199 class NetPoint;
 200 class NetZoneImpl;
 201 }
 202 namespace profile {
 203 class Event;
 204 class FutureEvtSet;
 205 class Profile;
 206 } // namespace profile
 207 } // namespace kernel
 208 namespace mc {
 209 class State;
 210 }
 211 } // namespace simgrid
 212
 213 using s4u_Actor             = simgrid::s4u::Actor;
 214 using s4u_Barrier           = simgrid::s4u::Barrier;
 215 using s4u_Comm              = simgrid::s4u::Comm;
 216 using s4u_Exec              = simgrid::s4u::Exec;
 217 using s4u_Host              = simgrid::s4u::Host;
 218 using s4u_Link              = simgrid::s4u::Link;
 219 using s4u_File              = simgrid::s4u::File;
 220 using s4u_ConditionVariable = simgrid::s4u::ConditionVariable;
 221 using s4u_Mailbox           = simgrid::s4u::Mailbox;
 222 using s4u_Mutex             = simgrid::s4u::Mutex;
 223 using s4u_Semaphore         = simgrid::s4u::Semaphore;
 224 using s4u_Disk              = simgrid::s4u::Disk;
 225 using s4u_NetZone           = simgrid::s4u::NetZone;
 226 using s4u_VM                = simgrid::s4u::VirtualMachine;
 227
 228 using smx_timer_t    = simgrid::kernel::timer::Timer*;
 229 using smx_actor_t    = simgrid::kernel::actor::ActorImpl*;
 230 using smx_activity_t = simgrid::kernel::activity::ActivityImpl*;
 231 using smx_cond_t     = simgrid::kernel::activity::ConditionVariableImpl*;
 232 using smx_mailbox_t  = simgrid::kernel::activity::MailboxImpl*;
 233 using smx_mutex_t    = simgrid::kernel::activity::MutexImpl*;
 234 using smx_sem_t      = simgrid::kernel::activity::SemaphoreImpl*;
 235 #else
 236
 237 typedef struct s4u_Actor s4u_Actor;
 238 typedef struct s4u_Barrier s4u_Barrier;
 239 typedef struct s4u_Comm s4u_Comm;
 240 typedef struct s4u_Exec s4u_Exec;
 241 typedef struct s4u_Host s4u_Host;
 242 typedef struct s4u_Link s4u_Link;
 243 typedef struct s4u_File s4u_File;
 244 typedef struct s4u_ConditionVariable s4u_ConditionVariable;
 245 typedef struct s4u_Mailbox s4u_Mailbox;
 246 typedef struct s4u_Mutex s4u_Mutex;
 247 typedef struct s4u_Semaphore s4u_Semaphore;
 248 typedef struct s4u_Disk s4u_Disk;
 249 typedef struct s4u_NetZone s4u_NetZone;
 250 typedef struct s4u_VM s4u_VM;
 251
 252 typedef struct s_smx_timer* smx_timer_t;
 253 typedef struct s_smx_actor* smx_actor_t;
 254 typedef struct s_smx_activity* smx_activity_t;
 255 typedef struct s_smx_cond_t* smx_cond_t;
 256 typedef struct s_smx_mailbox* smx_mailbox_t;
 257 typedef struct s_smx_mutex* smx_mutex_t;
 258 typedef struct s_smx_sem* smx_sem_t;
 259
 260 #endif
 261
 262 /** Pointer to a SimGrid barrier object */
 263 typedef s4u_Barrier* sg_bar_t;
 264 /** Constant pointer to a SimGrid barrier object */
 265 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef const s4u_Barrier* const_sg_bar_t;
 266 typedef s4u_Comm* sg_comm_t;
 267 XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef const s4u_Comm* const_sg_comm_t;
 268 typedef s4u_Exec* sg_exec_t;
 269 typedef const s4u_Exec* const_sg_exec_t;
 270 typedef s4u_ConditionVariable* sg_cond_t;
 271 typedef const s4u_ConditionVariable* const_sg_cond_t;
 272 typedef s4u_Mailbox* sg_mailbox_t;
 273 typedef const s4u_Mailbox* const_sg_mailbox_t;
 274 typedef s4u_Mutex* sg_mutex_t;
 275 typedef const s4u_Mutex* const_sg_mutex_t;
 276 typedef s4u_Semaphore* sg_sem_t;
 277 typedef const s4u_Semaphore* const_sg_sem_t;
 278 typedef s4u_NetZone* sg_netzone_t;
 279 typedef const s4u_NetZone* const_sg_netzone_t;
 280 typedef s4u_Host* sg_host_t;
 281 typedef const s4u_Host* const_sg_host_t;
 282 typedef s4u_Link* sg_link_t;
 283 typedef const s4u_Link* const_sg_link_t;
 284 typedef s4u_Disk* sg_disk_t;
 285 typedef const s4u_Disk* const_sg_disk_t;
 286 /** Pointer to a SimGrid file object @ingroup plugin_filesystem */
 287 typedef s4u_File* sg_file_t;
 288 /** Constant pointer to a SimGrid file object @ingroup plugin_filesystem */
 289 typedef const s4u_File* const_sg_file_t;
 290 typedef s4u_VM* sg_vm_t;
 291 typedef const s4u_VM* const_sg_vm_t;
 292 /** Pointer to an actor object */
 293 typedef s4u_Actor* sg_actor_t;
 294 /** Pointer to a constant actor object */
 295 typedef const s4u_Actor* const_sg_actor_t;
 296
 297 typedef struct s_smx_simcall* smx_simcall_t;
 298
 299 /** @ingroup m_datatypes_management_details
 300  * @brief Type for any simgrid size
 301  */
 302 typedef unsigned long long sg_size_t;
 303
 304 /** @ingroup m_datatypes_management_details
 305  * @brief Type for any simgrid offset
 306  */
 307 typedef long long sg_offset_t;
 308
 309 /** Actor's ID, just like the classical processes' have PID in UNIX */
 310 typedef long aid_t;
 311
 312 typedef enum {
 313   SG_OK,
 314   SG_ERROR_CANCELED,
 315   SG_ERROR_TIMEOUT,
 316   SG_ERROR_HOST,
 317   SG_ERROR_NETWORK,
 318   SG_ERROR_STORAGE,
 319   SG_ERROR_VM
 320 } sg_error_t;
 321
 322 #endif /* SIMGRID_TYPES_H */