X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f94165f07b3250944bb7174ca6ac8085b67d7963..1067edf07adcaa046abb976e7d92174d608b2d91:/include/simgrid/forward.h diff --git a/include/simgrid/forward.h b/include/simgrid/forward.h index ecab7aa6f9..3edfa803d1 100644 --- a/include/simgrid/forward.h +++ b/include/simgrid/forward.h @@ -1,318 +1,349 @@ -/* Copyright (c) 2004-2015. 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. */ -#ifndef SG_PLATF_TYPES_H -#define SG_PLATF_TYPES_H +#ifndef SIMGRID_TYPES_H +#define SIMGRID_TYPES_H -#include +#include #ifdef __cplusplus -namespace simgrid { - namespace s4u { - class Host; - } - namespace surf { - class Resource; - class Cpu; - class NetCard; - class As; - class Link; - } - namespace trace_mgr { - class future_evt_set; - } -} - -typedef simgrid::s4u::Host simgrid_Host; -typedef simgrid::surf::As surf_As; -typedef simgrid::surf::Cpu surf_Cpu; -typedef simgrid::surf::NetCard surf_NetCard; -typedef simgrid::surf::Link Link; -typedef simgrid::surf::Resource surf_Resource; -typedef simgrid::trace_mgr::future_evt_set sg_future_evt_set; - -#else +#include +#include -typedef struct simgrid_Host simgrid_Host; -typedef struct surf_As surf_As; -typedef struct surf_Cpu surf_Cpu; -typedef struct surf_NetCard surf_NetCard; -typedef struct surf_Resource surf_Resource; -typedef struct Link Link; -typedef struct future_evt_set sg_future_evt_set; -#endif +namespace simgrid { -typedef simgrid_Host* sg_host_t; -typedef surf_As *AS_t; -typedef surf_Cpu *surf_cpu_t; -typedef surf_NetCard *sg_netcard_t; -typedef surf_Resource *sg_resource_t; -typedef sg_future_evt_set *sg_future_evt_set_t; +namespace s4u { +class Activity; +/** Smart pointer to a simgrid::s4u::Activity */ +using ActivityPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(const Activity* act); +XBT_PUBLIC void intrusive_ptr_add_ref(const Activity* act); + +class ActivitySet; +/** Smart pointer to a simgrid::s4u::Activity */ +using ActivitySetPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(const ActivitySet* as); +XBT_PUBLIC void intrusive_ptr_add_ref(const ActivitySet* as); + +class Actor; +/** Smart pointer to a simgrid::s4u::Actor */ +using ActorPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(const Actor* actor); +XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor); + +class Barrier; +/** Smart pointer to a simgrid::s4u::Barrier */ +using BarrierPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(Barrier* b); +XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* b); + +class Comm; +/** Smart pointer to a simgrid::s4u::Comm */ +using CommPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(Comm* c); +XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c); + +class ConditionVariable; +/** @beginrst + * Smart pointer to a :cpp:type:`simgrid::s4u::ConditionVariable` + * @endrst + */ +using ConditionVariablePtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(const ConditionVariable* c); +XBT_PUBLIC void intrusive_ptr_add_ref(const ConditionVariable* c); + +class Engine; + +class Exec; +/** Smart pointer to a simgrid::s4u::Exec */ +using ExecPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(Exec* e); +XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e); + +class Host; + +class Io; +/** Smart pointer to a simgrid::s4u::Io */ +using IoPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(Io* i); +XBT_PUBLIC void intrusive_ptr_add_ref(Io* i); + +class Link; +class SplitDuplexLink; + +class Mailbox; + +class Mess; +/** Smart pointer to a simgrid::s4u::Mess */ +using MessPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(Mess* c); +XBT_PUBLIC void intrusive_ptr_add_ref(Mess* c); + +class MessageQueue; + +class Mutex; +XBT_PUBLIC void intrusive_ptr_release(const Mutex* m); +XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* m); +/** + * @beginrst + * Smart pointer to a :cpp:type:`simgrid::s4u::Mutex` + * @endrst + */ +using MutexPtr = boost::intrusive_ptr; -// Types which are in fact dictelmt: -typedef xbt_dictelm_t sg_storage_t; +class NetZone; +class VirtualMachine; +class File; -typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */ +class Semaphore; +/** Smart pointer to a simgrid::s4u::Semaphore */ +using SemaphorePtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(const Semaphore* m); +XBT_PUBLIC void intrusive_ptr_add_ref(const Semaphore* m); -typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/ +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; +} // namespace s4u -typedef enum { - SURF_LINK_FULLDUPLEX = 2, - SURF_LINK_SHARED = 1, - SURF_LINK_FATPIPE = 0 -} e_surf_link_sharing_policy_t; +namespace config { +template class Flag; +} -typedef enum { - SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4, - SURF_TRACE_CONNECT_KIND_POWER = 3, - SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2, - SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1, - SURF_TRACE_CONNECT_KIND_LATENCY = 0 -} e_surf_trace_connect_kind_t; +namespace kernel { +class EngineImpl; +namespace actor { +class ActorImpl; +using ActorImplPtr = boost::intrusive_ptr; + +// What's executed as an actor code: +using ActorCode = std::function; +// Create an ActorCode from the parameters parsed in the XML file (or elsewhere) +using ActorCodeFactory = std::function args)>; + +class Simcall; +class SimcallObserver; +class MutexObserver; +class ConditionVariableObserver; +class ObjectAccessSimcallObserver; +class ObjectAccessSimcallItem; +} // namespace actor + +namespace activity { + class ActivityImpl; + enum class State; + using ActivityImplPtr = boost::intrusive_ptr; + XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity); + XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity); + + class BarrierImpl; + using BarrierImplPtr = boost::intrusive_ptr; + XBT_PUBLIC void intrusive_ptr_add_ref(BarrierImpl* cond); + XBT_PUBLIC void intrusive_ptr_release(BarrierImpl* cond); + class BarrierAcquisitionImpl; + using BarrierAcquisitionImplPtr = boost::intrusive_ptr; + + class ConditionVariableImpl; + using ConditionVariableImplPtr = boost::intrusive_ptr; + XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariableImpl* cond); + XBT_PUBLIC void intrusive_ptr_release(ConditionVariableImpl* cond); + + class CommImpl; + using CommImplPtr = boost::intrusive_ptr; + class ExecImpl; + using ExecImplPtr = boost::intrusive_ptr; + class IoImpl; + using IoImplPtr = boost::intrusive_ptr; + class MessImpl; + using MessImplPtr = boost::intrusive_ptr; + class MutexImpl; + using MutexImplPtr = boost::intrusive_ptr; + class MutexAcquisitionImpl; + using MutexAcquisitionImplPtr = boost::intrusive_ptr; + XBT_PUBLIC void intrusive_ptr_add_ref(MutexImpl* mutex); + XBT_PUBLIC void intrusive_ptr_release(MutexImpl* mutex); + class SynchroImpl; + using SynchroImplPtr = boost::intrusive_ptr; + class SemaphoreImpl; + using SemaphoreImplPtr = boost::intrusive_ptr; + class SemAcquisitionImpl; + using SemAcquisitionImplPtr = boost::intrusive_ptr; + XBT_PUBLIC void intrusive_ptr_add_ref(SemaphoreImpl* sem); + XBT_PUBLIC void intrusive_ptr_release(SemaphoreImpl* sem); + class SleepImpl; + using SleepImplPtr = boost::intrusive_ptr; + + class MailboxImpl; + class MessageQueueImpl; +} +namespace context { +class Context; +class ContextFactory; +} // namespace context +namespace lmm { +class Element; +class Variable; +class Constraint; +class ConstraintLight; +class System; +} +namespace resource { +class Action; +class CpuAction; +class CpuImpl; +class Model; +class Resource; +class CpuModel; +class HostImpl; +class HostModel; +class NetworkModel; +class LinkImpl; +class StandardLinkImpl; +class SplitDuplexLinkImpl; +class NetworkAction; +class DiskImpl; +using DiskImplPtr = boost::intrusive_ptr; +class DiskModel; +class VirtualMachineImpl; +class VMModel; +} +namespace timer { +class Timer; +} +namespace routing { +class NetPoint; +class NetZoneImpl; +} +namespace profile { +class Event; +class FutureEvtSet; +class Profile; +} // namespace profile +} // namespace kernel +namespace mc { +class State; +class RemoteApp; +} +} // namespace simgrid + +using s4u_Actor = simgrid::s4u::Actor; +using s4u_Activity = simgrid::s4u::Activity; +using s4u_ActivitySet = simgrid::s4u::ActivitySet; +using s4u_Barrier = simgrid::s4u::Barrier; +using s4u_Comm = simgrid::s4u::Comm; +using s4u_Exec = simgrid::s4u::Exec; +using s4u_Host = simgrid::s4u::Host; +using s4u_Link = simgrid::s4u::Link; +using s4u_File = simgrid::s4u::File; +using s4u_ConditionVariable = simgrid::s4u::ConditionVariable; +using s4u_Mailbox = simgrid::s4u::Mailbox; +using s4u_MessageQueue = simgrid::s4u::MessageQueue; +using s4u_Mutex = simgrid::s4u::Mutex; +using s4u_Semaphore = simgrid::s4u::Semaphore; +using s4u_Disk = simgrid::s4u::Disk; +using s4u_NetZone = simgrid::s4u::NetZone; +using s4u_VM = simgrid::s4u::VirtualMachine; + +using smx_activity_t = simgrid::kernel::activity::ActivityImpl*; +#else -typedef enum { - SURF_PROCESS_ON_FAILURE_DIE = 1, - SURF_PROCESS_ON_FAILURE_RESTART = 0 -} e_surf_process_on_failure_t; +typedef struct s4u_Actor s4u_Actor; +typedef struct s4u_Activity s4u_Activity; +typedef struct s4u_ActivitySet s4u_ActivitySet; +typedef struct s4u_Barrier s4u_Barrier; +typedef struct s4u_Comm s4u_Comm; +typedef struct s4u_Exec s4u_Exec; +typedef struct s4u_Host s4u_Host; +typedef struct s4u_Link s4u_Link; +typedef struct s4u_File s4u_File; +typedef struct s4u_ConditionVariable s4u_ConditionVariable; +typedef struct s4u_Mailbox s4u_Mailbox; +typedef struct s4u_MessageQueue s4u_MessageQueue; +typedef struct s4u_Mutex s4u_Mutex; +typedef struct s4u_Semaphore s4u_Semaphore; +typedef struct s4u_Disk s4u_Disk; +typedef struct s4u_NetZone s4u_NetZone; +typedef struct s4u_VM s4u_VM; + +typedef struct s_smx_activity* smx_activity_t; -typedef enum { - SURF_CLUSTER_FAT_TREE=2, - SURF_CLUSTER_FLAT = 1, - SURF_CLUSTER_TORUS = 0 -} e_surf_cluster_topology_t; +#endif +/** Pointer to a SimGrid barrier object */ +typedef s4u_Barrier* sg_bar_t; +typedef s4u_Comm* sg_comm_t; +typedef s4u_Exec* sg_exec_t; +typedef const s4u_Exec* const_sg_exec_t; +typedef s4u_ConditionVariable* sg_cond_t; +typedef const s4u_ConditionVariable* const_sg_cond_t; +typedef s4u_Mailbox* sg_mailbox_t; +typedef const s4u_Mailbox* const_sg_mailbox_t; +typedef s4u_MessageQueue* sg_messagequeue_t; +typedef const s4u_MessageQueue* const_sg_messagequeue_t; +typedef s4u_Mutex* sg_mutex_t; +typedef const s4u_Mutex* const_sg_mutex_t; +typedef s4u_Semaphore* sg_sem_t; +typedef const s4u_Semaphore* const_sg_sem_t; +typedef s4u_NetZone* sg_netzone_t; +typedef const s4u_NetZone* const_sg_netzone_t; +typedef s4u_Host* sg_host_t; +typedef const s4u_Host* const_sg_host_t; +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 @ingroup plugin_filesystem */ +typedef s4u_File* sg_file_t; +/** 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; + +/** Pointer to an activity object */ +typedef s4u_Activity* sg_activity_t; +/** Pointer to a constant activity object */ +typedef const s4u_Activity* const_sg_activity_t; + +/** Pointer to an activity set object */ +typedef s4u_ActivitySet* sg_activity_set_t; +/** Pointer to a constant activity set object */ +typedef const s4u_ActivitySet* const_sg_activity_set_t; /** @ingroup m_datatypes_management_details - * @brief Type for any simgrid size + * @brief Type for any SimGrid size */ typedef unsigned long long sg_size_t; /** @ingroup m_datatypes_management_details - * @brief Type for any simgrid offset + * @brief Type for any SimGrid offset */ typedef long long sg_offset_t; -/* - * Platform creation functions. Instead of passing 123 arguments to the creation functions - * (one for each possible XML attribute), we pass structures containing them all. It removes the - * chances of switching arguments by error, and reduce the burden when we add a new attribute: - * old models can just continue to ignore it without having to update their headers. - * - * It shouldn't be too costly at runtime, provided that structures living on the stack are - * used, instead of malloced structures. - */ - -typedef struct { - const char* id; - xbt_dynar_t speed_peak; - int pstate; - int core_amount; - double speed_scale; - tmgr_trace_t speed_trace; - int initiallyOn; - tmgr_trace_t state_trace; - const char* coord; - xbt_dict_t properties; -} s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t; - -#define SG_PLATF_HOST_INITIALIZER { \ - NULL, 0, 1, 1, 1., NULL, 1/*ON*/, NULL, \ - NULL, NULL \ -} - -typedef struct { - const char* id; - const char* link_up; - const char* link_down; -} s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t; - -#define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL} - -typedef struct { - const char* id; - const char* coord; -} s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t; - -#define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL} - -typedef struct { - const char* id; - double bandwidth; - tmgr_trace_t bandwidth_trace; - double latency; - tmgr_trace_t latency_trace; - int initiallyOn; - tmgr_trace_t state_trace; - e_surf_link_sharing_policy_t policy; - xbt_dict_t properties; -} s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t; - -#define SG_PLATF_LINK_INITIALIZER {\ - NULL, 0., NULL, 0., NULL, 1/*ON*/, \ - NULL, SURF_LINK_SHARED, NULL \ -} - -typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t; -typedef struct s_sg_platf_peer_cbarg { - const char* id; - double speed; - double bw_in; - double bw_out; - double lat; - const char* coord; - tmgr_trace_t availability_trace; - tmgr_trace_t state_trace; -} s_sg_platf_peer_cbarg_t; - -#define SG_PLATF_PEER_INITIALIZER {NULL,0.0,0.0,0.0,0.0,NULL,NULL,NULL} - -typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t; -typedef struct s_sg_platf_route_cbarg { - int symmetrical; - const char *src; - const char *dst; - sg_netcard_t gw_src; - sg_netcard_t gw_dst; - xbt_dynar_t link_list; -} s_sg_platf_route_cbarg_t; - -#define SG_PLATF_ROUTE_INITIALIZER {1,NULL,NULL,NULL,NULL,NULL} - -typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t; -typedef struct s_sg_platf_cluster_cbarg { - const char* id; - const char* prefix; - const char* suffix; - const char* radical; - double speed; - int core_amount; - double bw; - double lat; - double bb_bw; - double bb_lat; - double loopback_bw; - double loopback_lat; - double limiter_link; - e_surf_cluster_topology_t topology; - const char* topo_parameters; - xbt_dict_t properties; - const char* router_id; - e_surf_link_sharing_policy_t sharing_policy; - e_surf_link_sharing_policy_t bb_sharing_policy; - const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed - const char* state_trace; -} s_sg_platf_cluster_cbarg_t; - -#define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,0.0,1 \ - ,1.,1.,0.,0.,0.,0.,0. \ - ,SURF_CLUSTER_FLAT,NULL,NULL,NULL, \ - SURF_LINK_SHARED,SURF_LINK_SHARED,NULL \ - ,NULL} - -typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t; -typedef struct s_sg_platf_cabinet_cbarg { - const char* id; - const char* prefix; - const char* suffix; - const char* radical; - double speed; - double bw; - double lat; -} s_sg_platf_cabinet_cbarg_t; - -#define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,0.0,0.0,0.0} - -typedef struct { - const char* id; - const char* type_id; - const char* content; - const char* content_type; - xbt_dict_t properties; - const char* attach; -} s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t; - -#define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL} - -typedef struct { - const char* id; - const char* model; - const char* content; - const char* content_type; - xbt_dict_t properties; - xbt_dict_t model_properties; - sg_size_t size; -} s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t; - -#define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL} - -typedef struct { - const char* type_id; - const char* name; -} s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t; - -#define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL} - -typedef struct { - const char* storageId; - const char* name; -} s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t; - -#define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL} - -typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t; -typedef struct s_sg_platf_prop_cbarg { - const char *id; - const char *value; -} s_sg_platf_prop_cbarg_t; - -#define SG_PLATF_PROP_INITIALIZER {NULL,NULL} - -typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t; -typedef struct s_sg_platf_trace_cbarg { - const char *id; - const char *file; - double periodicity; - const char *pc_data; -} s_sg_platf_trace_cbarg_t; - -#define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,0.0,NULL} - -typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t; -typedef struct s_sg_platf_trace_connect_cbarg { - e_surf_trace_connect_kind_t kind; - const char *trace; - const char *element; -} s_sg_platf_trace_connect_cbarg_t; - -#define SG_PLATF_TRACE_CONNECT_INITIALIZER {SURF_TRACE_CONNECT_KIND_LATENCY,NULL,NULL} - -typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t; -typedef struct s_sg_platf_process_cbarg { - const char **argv; - int argc; - xbt_dict_t properties; - const char *host; - const char *function; - double start_time; - double kill_time; - e_surf_process_on_failure_t on_failure; -} s_sg_platf_process_cbarg_t; - -#define SG_PLATF_PROCESS_INITIALIZER {NULL,0,NULL,NULL,NULL,-1.0,-1.0,SURF_PROCESS_ON_FAILURE_DIE} - -typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t; -typedef struct s_sg_platf_AS_cbarg { - const char *id; - int routing; -} s_sg_platf_AS_cbarg_t; - -#define SG_PLATF_AS_INITIALIZER {NULL,0} - -/** opaque structure defining a event generator for availability based on a probability distribution */ -typedef struct probabilist_event_generator *probabilist_event_generator_t; +/** Actor's ID, just like the classical processes' have PID in UNIX */ +typedef long aid_t; -#endif +typedef enum { + SG_OK /** Code returned when no problem occured */, + SG_ERROR_CANCELED /** Code returned when something got canceled before completion */, + SG_ERROR_TIMEOUT /** Code returned when timeout elapsed */, + SG_ERROR_HOST /** Code returned when a host fails */, + SG_ERROR_NETWORK /** Code returned when a communication fails because of the network or because of the remote host */, + SG_ERROR_STORAGE /** Code returned when a storage fails */, + SG_ERROR_VM /** Code returned when a VM fails */ +} sg_error_t; + +XBT_PUBLIC int SMPI_is_inited(); + +#endif /* SIMGRID_TYPES_H */