include/simgrid/simix.h

   1 /* Copyright (c) 2007-2021. 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_SIMIX_H
   7 #define SIMGRID_SIMIX_H
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/dynar.h>
  11 #include <xbt/ex.h>
  12 #include <xbt/parmap.h>
  13 #ifdef __cplusplus
  14 #include <functional>
  15 #include <string>
  16 #include <unordered_map>
  17 #include <vector>
  18 #endif
  19
  20 /******************************* Networking ***********************************/
  21 extern unsigned smx_context_stack_size;
  22 extern unsigned smx_context_guard_size;
  23
  24 SG_BEGIN_DECL
  25
  26 XBT_ATTRIB_DEPRECATED_v331("Please use sg_actor_by_pid() instead.") XBT_PUBLIC smx_actor_t
  27     SIMIX_process_from_PID(aid_t pid);
  28
  29 /* parallelism */
  30 XBT_PUBLIC int SIMIX_context_is_parallel();
  31 XBT_PUBLIC int SIMIX_context_get_nthreads();
  32 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
  33 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
  34 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
  35 XBT_PUBLIC int SIMIX_is_maestro();
  36
  37 /********************************** Global ************************************/
  38 /* Set some code to execute in the maestro (must be used before the engine creation)
  39  *
  40  * If no maestro code is registered (the default), the main thread
  41  * is assumed to be the maestro. */
  42 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
  43
  44 /* Simulation execution */
  45 XBT_ATTRIB_DEPRECATED_v332("Please use EngineImpl:run()") XBT_PUBLIC void SIMIX_run();
  46 XBT_ATTRIB_DEPRECATED_v332("Please use simgrid_get_clock() or Engine::get_clock()") XBT_PUBLIC double SIMIX_get_clock();
  47
  48 SG_END_DECL
  49
  50 /********************************* Process ************************************/
  51 SG_BEGIN_DECL
  52 XBT_PUBLIC smx_actor_t SIMIX_process_self();
  53 XBT_PUBLIC const char* SIMIX_process_self_get_name();
  54 SG_END_DECL
  55
  56 /****************************** Communication *********************************/
  57 #ifdef __cplusplus
  58 XBT_ATTRIB_DEPRECATED_v333("Please use Engine::set_default_comm_data_copy_callback()") XBT_PUBLIC
  59     void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*, size_t));
  60
  61 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
  62                                                  size_t buff_size);
  63 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
  64                                                 size_t buff_size);
  65 #endif
  66
  67 /******************************************************************************/
  68 /*                            SIMIX simcalls                                  */
  69 /******************************************************************************/
  70 /* These functions are a system call-like interface to the simulation kernel. */
  71 /* They can also be called from maestro's context, and they are thread safe.  */
  72 /******************************************************************************/
  73
  74 /******************************* Host simcalls ********************************/
  75 #ifdef __cplusplus
  76 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
  77     simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout);
  78 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
  79     simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution, double timeout);
  80 XBT_ATTRIB_DEPRECATED_v331("Please use s4u::Exec::wait_any_for()") XBT_PUBLIC
  81     unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
  82                                                double timeout);
  83 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
  84     bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution);
  85 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
  86     bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution);
  87
  88 #endif
  89
  90 /************************** Communication simcalls ****************************/
  91
  92 #ifdef __cplusplus
  93 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  94                                   size_t src_buff_size,
  95                                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  96                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  97                                   void* data, double timeout);
  98
  99 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
 100 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 101                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 102                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 103                    void* data, bool detached);
 104
 105 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 106                                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 107                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 108                                   void* data, double timeout, double rate);
 109
 110 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
 111 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 112                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 113                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate);
 114
 115 XBT_ATTRIB_DEPRECATED_v330("Please use Mailbox::iprobe()") XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
 116     simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 117                         bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
 118
 119 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
 120     unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count, double timeout);
 121 XBT_PUBLIC ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout);
 122 XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout);
 123 XBT_PUBLIC bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm);
 124 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
 125     int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count);
 126 XBT_PUBLIC ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
 127
 128 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline void simcall_comm_wait(
 129     const simgrid::kernel::activity::ActivityImplPtr& comm, double timeout)
 130 {
 131   simcall_comm_wait(comm.get(), timeout);
 132 }
 133 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline bool simcall_comm_test(
 134     const simgrid::kernel::activity::ActivityImplPtr& comm)
 135 {
 136   return simcall_comm_test(comm.get());
 137 }
 138 #endif
 139
 140 /************************** Synchro simcalls **********************************/
 141 SG_BEGIN_DECL
 142 XBT_ATTRIB_DEPRECATED_v330("Please use sg_mutex_init()") XBT_PUBLIC smx_mutex_t simcall_mutex_init();
 143 XBT_ATTRIB_DEPRECATED_v331("Please use sg_mutex_lock()") XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
 144 XBT_ATTRIB_DEPRECATED_v331("Please use sg_mutex_try_lock()") XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
 145 XBT_ATTRIB_DEPRECATED_v331("Please use sg_mutex_unlock()") XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
 146
 147 XBT_ATTRIB_DEPRECATED_v330("Please use sg_cond_init()") XBT_PUBLIC smx_cond_t simcall_cond_init();
 148 XBT_ATTRIB_DEPRECATED_v331("Please use sg_cond_wait()") XBT_PUBLIC
 149     void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 150 XBT_ATTRIB_DEPRECATED_v331("Please use sg_cond_wait_for()") XBT_PUBLIC
 151     int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
 152
 153 XBT_ATTRIB_DEPRECATED_v331("Please use sg_sem_acquire()") XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
 154 XBT_ATTRIB_DEPRECATED_v331("Please use sg_sem_acquire_timeout()") XBT_PUBLIC
 155     int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
 156 SG_END_DECL
 157
 158 /*****************************   Io   **************************************/
 159 #ifdef __cplusplus
 160 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
 161     simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout);
 162 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
 163     simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io, double timeout);
 164 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
 165     bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io);
 166 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
 167     bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io);
 168 #endif
 169 /************************** MC simcalls   **********************************/
 170 SG_BEGIN_DECL
 171 XBT_ATTRIB_DEPRECATED_v331("Please use MC_random()") XBT_PUBLIC int simcall_mc_random(int min, int max);
 172 SG_END_DECL
 173
 174 #endif