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