Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / include / simgrid / forward.h
index a8f7cd3..9dafa1c 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -66,6 +66,7 @@ XBT_PUBLIC void intrusive_ptr_release(Io* i);
 XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
 
 class Link;
+class SplitDuplexLink;
 
 class Mailbox;
 
@@ -86,10 +87,17 @@ class File;
 class Semaphore;
 /** Smart pointer to a simgrid::s4u::Semaphore */
 using SemaphorePtr = boost::intrusive_ptr<Semaphore>;
-XBT_PUBLIC void intrusive_ptr_release(Semaphore* m);
-XBT_PUBLIC void intrusive_ptr_add_ref(Semaphore* m);
+XBT_PUBLIC void intrusive_ptr_release(const Semaphore* m);
+XBT_PUBLIC void intrusive_ptr_add_ref(const Semaphore* m);
 
 class Disk;
+/**
+ * @brief Callback to dynamically change the resource's capacity
+ *
+ * Allows user to change resource's capacity depending on the number of concurrent activities
+ * running on the resource at a given instant
+ */
+using NonLinearResourceCb = std::function<double(double capacity, int n_activities)>;
 } // namespace s4u
 
 namespace config {
@@ -106,6 +114,11 @@ using ActorImplPtr = boost::intrusive_ptr<ActorImpl>;
 using ActorCode = std::function<void()>;
 // Create an ActorCode from the parameters parsed in the XML file (or elsewhere)
 using ActorCodeFactory = std::function<ActorCode(std::vector<std::string> args)>;
+
+class Simcall;
+class SimcallObserver;
+class ObjectAccessSimcallObserver;
+class ObjectAccessSimcallItem;
 } // namespace actor
 
 namespace activity {
@@ -115,7 +128,17 @@ namespace activity {
   XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
   XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
 
+  class BarrierImpl;
+  using BarrierImplPtr = boost::intrusive_ptr<BarrierImpl>;
+  XBT_PUBLIC void intrusive_ptr_add_ref(BarrierImpl* cond);
+  XBT_PUBLIC void intrusive_ptr_release(BarrierImpl* cond);
+  class BarrierAcquisitionImpl;
+  using BarrierAcquisitionImplPtr = boost::intrusive_ptr<BarrierAcquisitionImpl>;
+
   class ConditionVariableImpl;
+  using ConditionVariableImplPtr = boost::intrusive_ptr<ConditionVariableImpl>;
+  XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariableImpl* cond);
+  XBT_PUBLIC void intrusive_ptr_release(ConditionVariableImpl* cond);
 
   class CommImpl;
   using CommImplPtr = boost::intrusive_ptr<CommImpl>;
@@ -125,10 +148,18 @@ namespace activity {
   using IoImplPtr = boost::intrusive_ptr<IoImpl>;
   class MutexImpl;
   using MutexImplPtr = boost::intrusive_ptr<MutexImpl>;
-  class RawImpl;
-  using RawImplPtr = boost::intrusive_ptr<RawImpl>;
+  class MutexAcquisitionImpl;
+  using MutexAcquisitionImplPtr = boost::intrusive_ptr<MutexAcquisitionImpl>;
+  XBT_PUBLIC void intrusive_ptr_add_ref(MutexImpl* mutex);
+  XBT_PUBLIC void intrusive_ptr_release(MutexImpl* mutex);
+  class SynchroImpl;
+  using SynchroImplPtr = boost::intrusive_ptr<SynchroImpl>;
   class SemaphoreImpl;
   using SemaphoreImplPtr = boost::intrusive_ptr<SemaphoreImpl>;
+  class SemAcquisitionImpl;
+  using SemAcquisitionImplPtr = boost::intrusive_ptr<SemAcquisitionImpl>;
+  XBT_PUBLIC void intrusive_ptr_add_ref(SemaphoreImpl* sem);
+  XBT_PUBLIC void intrusive_ptr_release(SemaphoreImpl* sem);
   class SleepImpl;
   using SleepImplPtr = boost::intrusive_ptr<SleepImpl>;
 
@@ -147,22 +178,28 @@ class System;
 }
 namespace resource {
 class Action;
-class Cpu;
+class CpuImpl;
 class Model;
 class Resource;
 class CpuModel;
+class HostImpl;
+class HostModel;
 class NetworkModel;
 class LinkImpl;
+class StandardLinkImpl;
+class SplitDuplexLinkImpl;
 class NetworkAction;
 class DiskImpl;
 class DiskModel;
+class VirtualMachineImpl;
+class VMModel;
+}
+namespace timer {
+class Timer;
 }
 namespace routing {
-class ClusterCreationArgs;
-class LinkCreationArgs;
 class NetPoint;
 class NetZoneImpl;
-class RouteCreationArgs;
 }
 namespace profile {
 class Event;
@@ -170,22 +207,9 @@ class FutureEvtSet;
 class Profile;
 } // namespace profile
 } // namespace kernel
-namespace simix {
-  class Host;
-  class Timer;
-}
-namespace surf {
-  class HostImpl;
-  class HostModel;
-}
 namespace mc {
-class CommunicationDeterminismChecker;
-class SimcallInspector;
+class State;
 }
-namespace vm {
-class VMModel;
-class VirtualMachineImpl;
-} // namespace vm
 } // namespace simgrid
 
 using s4u_Actor             = simgrid::s4u::Actor;
@@ -203,14 +227,19 @@ using s4u_Disk              = simgrid::s4u::Disk;
 using s4u_NetZone           = simgrid::s4u::NetZone;
 using s4u_VM                = simgrid::s4u::VirtualMachine;
 
-using smx_timer_t    = simgrid::simix::Timer*;
-using smx_actor_t    = simgrid::kernel::actor::ActorImpl*;
+using smx_timer_t
+    XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::timer::Timer*") = simgrid::kernel::timer::Timer*;
+using smx_actor_t
+    XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::actor::ActorImpl*") = simgrid::kernel::actor::ActorImpl*;
 using smx_activity_t = simgrid::kernel::activity::ActivityImpl*;
-using smx_cond_t     = simgrid::kernel::activity::ConditionVariableImpl*;
-using smx_mailbox_t  = simgrid::kernel::activity::MailboxImpl*;
-using smx_mutex_t    = simgrid::kernel::activity::MutexImpl*;
-using smx_sem_t      = simgrid::kernel::activity::SemaphoreImpl*;
-using e_smx_state_t XBT_ATTRIB_DEPRECATED_v330("Please use kernel::activity::State") = simgrid::kernel::activity::State;
+using smx_cond_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::ConditionVariableImpl*") =
+    simgrid::kernel::activity::ConditionVariableImpl*;
+using smx_mailbox_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::MailboxImpl*") =
+    simgrid::kernel::activity::MailboxImpl*;
+using smx_mutex_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::MutexImpl*") =
+    simgrid::kernel::activity::MutexImpl*;
+using smx_sem_t XBT_ATTRIB_DEPRECATED_v335("Please use simgrid::kernel::activity::SemaphoreImpl*") =
+    simgrid::kernel::activity::SemaphoreImpl*;
 #else
 
 typedef struct s4u_Actor s4u_Actor;
@@ -227,24 +256,23 @@ typedef struct s4u_Semaphore s4u_Semaphore;
 typedef struct s4u_Disk s4u_Disk;
 typedef struct s4u_NetZone s4u_NetZone;
 typedef struct s4u_VM s4u_VM;
-XBT_ATTRIB_DEPRECATED_v330("Please stop using this type alias") typedef enum kernel_activity_state e_smx_state_t;
 
-typedef struct s_smx_timer* smx_timer_t;
-typedef struct s_smx_actor* smx_actor_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_timer* smx_timer_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_actor* smx_actor_t;
 typedef struct s_smx_activity* smx_activity_t;
-typedef struct s_smx_cond_t* smx_cond_t;
-typedef struct s_smx_mailbox* smx_mailbox_t;
-typedef struct s_smx_mutex* smx_mutex_t;
-typedef struct s_smx_sem* smx_sem_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_cond_t* smx_cond_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_mailbox* smx_mailbox_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_mutex* smx_mutex_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef struct s_smx_sem* smx_sem_t;
 
 #endif
 
 /** Pointer to a SimGrid barrier object */
 typedef s4u_Barrier* sg_bar_t;
 /** Constant pointer to a SimGrid barrier object */
-typedef const s4u_Barrier* const_sg_bar_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef const s4u_Barrier* const_sg_bar_t;
 typedef s4u_Comm* sg_comm_t;
-typedef const s4u_Comm* const_sg_comm_t;
+XBT_ATTRIB_DEPRECATED_v335("Please stop using this type alias") typedef const s4u_Comm* const_sg_comm_t;
 typedef s4u_Exec* sg_exec_t;
 typedef const s4u_Exec* const_sg_exec_t;
 typedef s4u_ConditionVariable* sg_cond_t;
@@ -263,17 +291,17 @@ typedef s4u_Link* sg_link_t;
 typedef const s4u_Link* const_sg_link_t;
 typedef s4u_Disk* sg_disk_t;
 typedef const s4u_Disk* const_sg_disk_t;
-/** Pointer to a SimGrid file object */
+/** Pointer to a SimGrid file object @ingroup plugin_filesystem */
 typedef s4u_File* sg_file_t;
-/** Constant pointer to a SimGrid file object */
+/** Constant pointer to a SimGrid file object @ingroup plugin_filesystem */
 typedef const s4u_File* const_sg_file_t;
 typedef s4u_VM* sg_vm_t;
 typedef const s4u_VM* const_sg_vm_t;
+/** Pointer to an actor object */
 typedef s4u_Actor* sg_actor_t;
+/** Pointer to a constant actor object */
 typedef const s4u_Actor* const_sg_actor_t;
 
-typedef struct s_smx_simcall* smx_simcall_t;
-
 /** @ingroup m_datatypes_management_details
  * @brief Type for any simgrid size
  */
@@ -297,4 +325,6 @@ typedef enum {
   SG_ERROR_VM
 } sg_error_t;
 
+XBT_PUBLIC int SMPI_is_inited();
+
 #endif /* SIMGRID_TYPES_H */