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