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