include/simgrid/forward.h

   1 /* Copyright (c) 2004-2023. 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* act);
  23 XBT_PUBLIC void intrusive_ptr_add_ref(const Activity* act);
  24
  25 class ActivitySet;
  26 /** Smart pointer to a simgrid::s4u::Activity */
  27 using ActivitySetPtr = boost::intrusive_ptr<ActivitySet>;
  28 XBT_PUBLIC void intrusive_ptr_release(const ActivitySet* as);
  29 XBT_PUBLIC void intrusive_ptr_add_ref(const ActivitySet* as);
  30
  31 class Actor;
  32 /** Smart pointer to a simgrid::s4u::Actor */
  33 using ActorPtr = boost::intrusive_ptr<Actor>;
  34 XBT_PUBLIC void intrusive_ptr_release(const Actor* actor);
  35 XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor);
  36
  37 class Barrier;
  38 /** Smart pointer to a simgrid::s4u::Barrier */
  39 using BarrierPtr = boost::intrusive_ptr<Barrier>;
  40 XBT_PUBLIC void intrusive_ptr_release(Barrier* b);
  41 XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* b);
  42
  43 class Comm;
  44 /** Smart pointer to a simgrid::s4u::Comm */
  45 using CommPtr = boost::intrusive_ptr<Comm>;
  46 XBT_PUBLIC void intrusive_ptr_release(Comm* c);
  47 XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
  48
  49 class ConditionVariable;
  50 /** @beginrst
  51  * Smart pointer to a :cpp:type:`simgrid::s4u::ConditionVariable`
  52  * @endrst
  53  */
  54 using ConditionVariablePtr = boost::intrusive_ptr<ConditionVariable>;
  55 XBT_PUBLIC void intrusive_ptr_release(const ConditionVariable* c);
  56 XBT_PUBLIC void intrusive_ptr_add_ref(const ConditionVariable* c);
  57
  58 class Engine;
  59
  60 class Exec;
  61 /** Smart pointer to a simgrid::s4u::Exec */
  62 using ExecPtr = boost::intrusive_ptr<Exec>;
  63 XBT_PUBLIC void intrusive_ptr_release(Exec* e);
  64 XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
  65
  66 class Host;
  67
  68 class Io;
  69 /** Smart pointer to a simgrid::s4u::Io */
  70 using IoPtr = boost::intrusive_ptr<Io>;
  71 XBT_PUBLIC void intrusive_ptr_release(Io* i);
  72 XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
  73
  74 class Link;
  75 class SplitDuplexLink;
  76
  77 class Mailbox;
  78
  79 class Mess;
  80 /** Smart pointer to a simgrid::s4u::Mess */
  81 using MessPtr = boost::intrusive_ptr<Mess>;
  82 XBT_PUBLIC void intrusive_ptr_release(Mess* c);
  83 XBT_PUBLIC void intrusive_ptr_add_ref(Mess* c);
  84
  85 class MessageQueue;
  86
  87 class Mutex;
  88 XBT_PUBLIC void intrusive_ptr_release(const Mutex* m);
  89 XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* m);
  90 /**
  91  * @beginrst
  92  * Smart pointer to a :cpp:type:`simgrid::s4u::Mutex`
  93  * @endrst
  94  */
  95 using MutexPtr = boost::intrusive_ptr<Mutex>;
  96
  97 class NetZone;
  98 class VirtualMachine;
  99 class File;
 100
 101 class Semaphore;
 102 /** Smart pointer to a simgrid::s4u::Semaphore */
 103 using SemaphorePtr = boost::intrusive_ptr<Semaphore>;
 104 XBT_PUBLIC void intrusive_ptr_release(const Semaphore* m);
 105 XBT_PUBLIC void intrusive_ptr_add_ref(const Semaphore* m);
 106
 107 class Disk;
 108 /**
 109  * @brief Callback to dynamically change the resource's capacity
 110  *
 111  * Allows user to change resource's capacity depending on the number of concurrent activities
 112  * running on the resource at a given instant
 113  */
 114 using NonLinearResourceCb = std::function<double(double capacity, int n_activities)>;
 115 } // namespace s4u
 116
 117 namespace config {
 118 template <class T> class Flag;
 119 }
 120
 121 namespace kernel {
 122 class EngineImpl;
 123 namespace actor {
 124 class ActorImpl;
 125 using ActorImplPtr = boost::intrusive_ptr<ActorImpl>;
 126
 127 // What's executed as an actor code:
 128 using ActorCode = std::function<void()>;
 129 // Create an ActorCode from the parameters parsed in the XML file (or elsewhere)
 130 using ActorCodeFactory = std::function<ActorCode(std::vector<std::string> args)>;
 131
 132 class Simcall;
 133 class SimcallObserver;
 134 class ObjectAccessSimcallObserver;
 135 class ObjectAccessSimcallItem;
 136 } // namespace actor
 137
 138 namespace activity {
 139   class ActivityImpl;
 140   enum class State;
 141   using ActivityImplPtr = boost::intrusive_ptr<ActivityImpl>;
 142   XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
 143   XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
 144
 145   class BarrierImpl;
 146   using BarrierImplPtr = boost::intrusive_ptr<BarrierImpl>;
 147   XBT_PUBLIC void intrusive_ptr_add_ref(BarrierImpl* cond);
 148   XBT_PUBLIC void intrusive_ptr_release(BarrierImpl* cond);
 149   class BarrierAcquisitionImpl;
 150   using BarrierAcquisitionImplPtr = boost::intrusive_ptr<BarrierAcquisitionImpl>;
 151
 152   class ConditionVariableImpl;
 153   using ConditionVariableImplPtr = boost::intrusive_ptr<ConditionVariableImpl>;
 154   XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariableImpl* cond);
 155   XBT_PUBLIC void intrusive_ptr_release(ConditionVariableImpl* cond);
 156
 157   class CommImpl;
 158   using CommImplPtr = boost::intrusive_ptr<CommImpl>;
 159   class ExecImpl;
 160   using ExecImplPtr = boost::intrusive_ptr<ExecImpl>;
 161   class IoImpl;
 162   using IoImplPtr = boost::intrusive_ptr<IoImpl>;
 163   class MessImpl;
 164   using MessImplPtr = boost::intrusive_ptr<MessImpl>;
 165   class MutexImpl;
 166   using MutexImplPtr = boost::intrusive_ptr<MutexImpl>;
 167   class MutexAcquisitionImpl;
 168   using MutexAcquisitionImplPtr = boost::intrusive_ptr<MutexAcquisitionImpl>;
 169   XBT_PUBLIC void intrusive_ptr_add_ref(MutexImpl* mutex);
 170   XBT_PUBLIC void intrusive_ptr_release(MutexImpl* mutex);
 171   class SynchroImpl;
 172   using SynchroImplPtr = boost::intrusive_ptr<SynchroImpl>;
 173   class SemaphoreImpl;
 174   using SemaphoreImplPtr = boost::intrusive_ptr<SemaphoreImpl>;
 175   class SemAcquisitionImpl;
 176   using SemAcquisitionImplPtr = boost::intrusive_ptr<SemAcquisitionImpl>;
 177   XBT_PUBLIC void intrusive_ptr_add_ref(SemaphoreImpl* sem);
 178   XBT_PUBLIC void intrusive_ptr_release(SemaphoreImpl* sem);
 179   class SleepImpl;
 180   using SleepImplPtr = boost::intrusive_ptr<SleepImpl>;
 181
 182   class MailboxImpl;
 183   class MessageQueueImpl;
 184 }
 185 namespace context {
 186 class Context;
 187 class ContextFactory;
 188 } // namespace context
 189 namespace lmm {
 190 class Element;
 191 class Variable;
 192 class Constraint;
 193 class ConstraintLight;
 194 class System;
 195 }
 196 namespace resource {
 197 class Action;
 198 class CpuAction;
 199 class CpuImpl;
 200 class Model;
 201 class Resource;
 202 class CpuModel;
 203 class HostImpl;
 204 class HostModel;
 205 class NetworkModel;
 206 class LinkImpl;
 207 class StandardLinkImpl;
 208 class SplitDuplexLinkImpl;
 209 class NetworkAction;
 210 class DiskImpl;
 211 using DiskImplPtr = boost::intrusive_ptr<DiskImpl>;
 212 class DiskModel;
 213 class VirtualMachineImpl;
 214 class VMModel;
 215 }
 216 namespace timer {
 217 class Timer;
 218 }
 219 namespace routing {
 220 class NetPoint;
 221 class NetZoneImpl;
 222 }
 223 namespace profile {
 224 class Event;
 225 class FutureEvtSet;
 226 class Profile;
 227 } // namespace profile
 228 } // namespace kernel
 229 namespace mc {
 230 class State;
 231 class RemoteApp;
 232 }
 233 } // namespace simgrid
 234
 235 using s4u_Actor             = simgrid::s4u::Actor;
 236 using s4u_Activity          = simgrid::s4u::Activity;
 237 using s4u_ActivitySet       = simgrid::s4u::ActivitySet;
 238 using s4u_Barrier           = simgrid::s4u::Barrier;
 239 using s4u_Comm              = simgrid::s4u::Comm;
 240 using s4u_Exec              = simgrid::s4u::Exec;
 241 using s4u_Host              = simgrid::s4u::Host;
 242 using s4u_Link              = simgrid::s4u::Link;
 243 using s4u_File              = simgrid::s4u::File;
 244 using s4u_ConditionVariable = simgrid::s4u::ConditionVariable;
 245 using s4u_Mailbox           = simgrid::s4u::Mailbox;
 246 using s4u_MessageQueue      = simgrid::s4u::MessageQueue;
 247 using s4u_Mutex             = simgrid::s4u::Mutex;
 248 using s4u_Semaphore         = simgrid::s4u::Semaphore;
 249 using s4u_Disk              = simgrid::s4u::Disk;
 250 using s4u_NetZone           = simgrid::s4u::NetZone;
 251 using s4u_VM                = simgrid::s4u::VirtualMachine;
 252
 253 using smx_activity_t = simgrid::kernel::activity::ActivityImpl*;
 254 #else
 255
 256 typedef struct s4u_Actor s4u_Actor;
 257 typedef struct s4u_Activity s4u_Activity;
 258 typedef struct s4u_ActivitySet s4u_ActivitySet;
 259 typedef struct s4u_Barrier s4u_Barrier;
 260 typedef struct s4u_Comm s4u_Comm;
 261 typedef struct s4u_Exec s4u_Exec;
 262 typedef struct s4u_Host s4u_Host;
 263 typedef struct s4u_Link s4u_Link;
 264 typedef struct s4u_File s4u_File;
 265 typedef struct s4u_ConditionVariable s4u_ConditionVariable;
 266 typedef struct s4u_Mailbox s4u_Mailbox;
 267 typedef struct s4u_MessageQueue s4u_MessageQueue;
 268 typedef struct s4u_Mutex s4u_Mutex;
 269 typedef struct s4u_Semaphore s4u_Semaphore;
 270 typedef struct s4u_Disk s4u_Disk;
 271 typedef struct s4u_NetZone s4u_NetZone;
 272 typedef struct s4u_VM s4u_VM;
 273
 274 typedef struct s_smx_activity* smx_activity_t;
 275
 276 #endif
 277
 278 /** Pointer to a SimGrid barrier object */
 279 typedef s4u_Barrier* sg_bar_t;
 280 typedef s4u_Comm* sg_comm_t;
 281 typedef s4u_Exec* sg_exec_t;
 282 typedef const s4u_Exec* const_sg_exec_t;
 283 typedef s4u_ConditionVariable* sg_cond_t;
 284 typedef const s4u_ConditionVariable* const_sg_cond_t;
 285 typedef s4u_Mailbox* sg_mailbox_t;
 286 typedef const s4u_Mailbox* const_sg_mailbox_t;
 287 typedef s4u_MessageQueue* sg_messagequeue_t;
 288 typedef const s4u_MessageQueue* const_sg_messagequeue_t;
 289 typedef s4u_Mutex* sg_mutex_t;
 290 typedef const s4u_Mutex* const_sg_mutex_t;
 291 typedef s4u_Semaphore* sg_sem_t;
 292 typedef const s4u_Semaphore* const_sg_sem_t;
 293 typedef s4u_NetZone* sg_netzone_t;
 294 typedef const s4u_NetZone* const_sg_netzone_t;
 295 typedef s4u_Host* sg_host_t;
 296 typedef const s4u_Host* const_sg_host_t;
 297 typedef s4u_Link* sg_link_t;
 298 typedef const s4u_Link* const_sg_link_t;
 299 typedef s4u_Disk* sg_disk_t;
 300 typedef const s4u_Disk* const_sg_disk_t;
 301 /** Pointer to a SimGrid file object @ingroup plugin_filesystem */
 302 typedef s4u_File* sg_file_t;
 303 /** Constant pointer to a SimGrid file object @ingroup plugin_filesystem */
 304 typedef const s4u_File* const_sg_file_t;
 305 typedef s4u_VM* sg_vm_t;
 306 typedef const s4u_VM* const_sg_vm_t;
 307 /** Pointer to an actor object */
 308 typedef s4u_Actor* sg_actor_t;
 309 /** Pointer to a constant actor object */
 310 typedef const s4u_Actor* const_sg_actor_t;
 311
 312 /** Pointer to an activity object */
 313 typedef s4u_Activity* sg_activity_t;
 314 /** Pointer to a constant activity object */
 315 typedef const s4u_Activity* const_sg_activity_t;
 316
 317 /** Pointer to an activity set object */
 318 typedef s4u_ActivitySet* sg_activity_set_t;
 319 /** Pointer to a constant activity set object */
 320 typedef const s4u_ActivitySet* const_sg_activity_set_t;
 321
 322 /** @ingroup m_datatypes_management_details
 323  * @brief Type for any SimGrid size
 324  */
 325 typedef unsigned long long sg_size_t;
 326
 327 /** @ingroup m_datatypes_management_details
 328  * @brief Type for any SimGrid offset
 329  */
 330 typedef long long sg_offset_t;
 331
 332 /** Actor's ID, just like the classical processes' have PID in UNIX */
 333 typedef long aid_t;
 334
 335 typedef enum {
 336   SG_OK /** Code returned when no problem occured */,
 337   SG_ERROR_CANCELED /** Code returned when something got canceled before completion */,
 338   SG_ERROR_TIMEOUT /** Code returned when timeout elapsed */,
 339   SG_ERROR_HOST /** Code returned when a host fails */,
 340   SG_ERROR_NETWORK /** Code returned when a communication fails because of the network or because of the remote host */,
 341   SG_ERROR_STORAGE /** Code returned when a storage fails */,
 342   SG_ERROR_VM /** Code returned when a VM fails */
 343 } sg_error_t;
 344
 345 XBT_PUBLIC int SMPI_is_inited();
 346
 347 #endif /* SIMGRID_TYPES_H */