include/simgrid/simix.h

   1 /* Copyright (c) 2007-2022. 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 SG_BEGIN_DECL
  22
  23 /* parallelism */
  24 XBT_ATTRIB_DEPRECATED_v333("Please use kernel::context::is_parallel()") XBT_PUBLIC int SIMIX_context_is_parallel();
  25 XBT_ATTRIB_DEPRECATED_v333("Please use kernel::context::get_nthreads()") XBT_PUBLIC int SIMIX_context_get_nthreads();
  26 XBT_ATTRIB_DEPRECATED_v333("Please use kernel::context::set_nthreads()") XBT_PUBLIC
  27     void SIMIX_context_set_nthreads(int nb_threads);
  28 XBT_ATTRIB_DEPRECATED_v333("Please use kernel::context::get_parallel_mode()") XBT_PUBLIC e_xbt_parmap_mode_t
  29     SIMIX_context_get_parallel_mode();
  30 XBT_ATTRIB_DEPRECATED_v333("Please use kernel::context::set_parallel_mode()") XBT_PUBLIC
  31     void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
  32 XBT_ATTRIB_DEPRECATED_v333("Please use Actor::is_maestro()") XBT_PUBLIC int SIMIX_is_maestro();
  33
  34 /********************************** Global ************************************/
  35 /* Set some code to execute in the maestro (must be used before the engine creation)
  36  *
  37  * If no maestro code is registered (the default), the main thread
  38  * is assumed to be the maestro. */
  39 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid_set_maestro()") XBT_PUBLIC
  40     void SIMIX_set_maestro(void (*code)(void*), void* data);
  41
  42 /* Simulation execution */
  43 XBT_ATTRIB_DEPRECATED_v332("Please use EngineImpl:run()") XBT_PUBLIC void SIMIX_run();
  44 XBT_ATTRIB_DEPRECATED_v332("Please use simgrid_get_clock() or Engine::get_clock()") XBT_PUBLIC double SIMIX_get_clock();
  45
  46 SG_END_DECL
  47
  48 /********************************* Process ************************************/
  49 SG_BEGIN_DECL
  50 XBT_ATTRIB_DEPRECATED_v333("Please use kernel::actor::ActorImpl::self()") XBT_PUBLIC smx_actor_t SIMIX_process_self();
  51 XBT_ATTRIB_DEPRECATED_v333("Please use xbt_procname()") XBT_PUBLIC const char* SIMIX_process_self_get_name();
  52 SG_END_DECL
  53
  54 /****************************** Communication *********************************/
  55 #ifdef __cplusplus
  56 XBT_ATTRIB_DEPRECATED_v333("Please use Engine::set_default_comm_data_copy_callback()") XBT_PUBLIC
  57     void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*, size_t));
  58
  59 XBT_ATTRIB_DEPRECATED_v333("Please use Comm::copy_buffer_callback()") XBT_PUBLIC
  60     void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size);
  61 XBT_ATTRIB_DEPRECATED_v333("Please use Comm::copy_pointer_callback()") XBT_PUBLIC
  62     void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size);
  63 #endif
  64
  65 /******************************************************************************/
  66 /*                            SIMIX simcalls                                  */
  67 /******************************************************************************/
  68 /* These functions are a system call-like interface to the simulation kernel. */
  69 /* They can also be called from maestro's context, and they are thread safe.  */
  70 /******************************************************************************/
  71
  72 /************************** Communication simcalls ****************************/
  73
  74 #ifdef __cplusplus
  75 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  76                                   size_t src_buff_size,
  77                                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  78                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  79                                   void* data, double timeout);
  80
  81 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
  82 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  83                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  84                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  85                    void* data, bool detached);
  86
  87 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
  88                                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  89                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  90                                   void* data, double timeout, double rate);
  91
  92 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
  93 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
  94                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  95                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate);
  96
  97 XBT_ATTRIB_DEPRECATED_v335("Please use s4u::Comm::wait_any_for()") XBT_PUBLIC ssize_t
  98     simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout);
  99 XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout);
 100 XBT_ATTRIB_DEPRECATED_v335("Please use s4u::Comm::test()") XBT_PUBLIC
 101     bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm);
 102 XBT_ATTRIB_DEPRECATED_v335("Please use s4u::Comm::test_any()") XBT_PUBLIC ssize_t
 103     simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
 104
 105 #endif
 106 #endif