src/simix/smx_process_private.h

   1 /* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef _SIMIX_PROCESS_PRIVATE_H
   8 #define _SIMIX_PROCESS_PRIVATE_H
   9
  10 #include <xbt/base.h>
  11
  12 #include "simgrid/simix.h"
  13 #include "popping_private.h"
  14
  15 typedef struct s_smx_process_exit_fun {
  16   int_f_pvoid_pvoid_t fun;
  17   void *arg;
  18 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
  19
  20 typedef struct s_smx_process_arg {
  21   char *name;
  22   xbt_main_func_t code;
  23   void *data;
  24   const char *hostname;
  25   int argc;
  26   char **argv;
  27   double kill_time;
  28   xbt_dict_t properties;
  29   unsigned auto_restart:1;
  30 } s_smx_process_arg_t, *smx_process_arg_t;
  31
  32 namespace simgrid {
  33 namespace simix {
  34
  35 class Process {
  36 public:
  37
  38   // TODO, replace with boost intrusive container hooks
  39   s_xbt_swag_hookup_t process_hookup = { nullptr, nullptr };   /* simix_global->process_list */
  40   s_xbt_swag_hookup_t synchro_hookup = { nullptr, nullptr };   /* {mutex,cond,sem}->sleeping */
  41   s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
  42   s_xbt_swag_hookup_t destroy_hookup = { nullptr, nullptr };   /* simix_global->process_to_destroy */
  43
  44   unsigned long pid = 0;
  45   unsigned long ppid = 0;
  46   char *name = nullptr;         /**< @brief process name if any */
  47   sg_host_t host = nullptr;     /* the host on which the process is running */
  48   smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
  49   xbt_running_ctx_t *running_ctx = nullptr;
  50
  51   // TODO, pack them
  52   bool doexception = false;
  53   bool blocked = false;
  54   bool suspended = false;
  55   bool auto_restart = false;
  56
  57   sg_host_t new_host = nullptr;     /* if not null, the host on which the process must migrate to */
  58   smx_synchro_t waiting_synchro = nullptr;  /* the current blocking synchro if any */
  59   xbt_fifo_t comms = nullptr;       /* the current non-blocking communication synchros */
  60   xbt_dict_t properties = nullptr;
  61   s_smx_simcall_t simcall;
  62   void *data = nullptr;    /* kept for compatibility, it should be replaced with moddata */
  63   xbt_dynar_t on_exit = nullptr; /* list of functions executed when the process dies */
  64
  65   xbt_main_func_t code = nullptr;
  66   int argc = 0;
  67   char **argv = nullptr;
  68   smx_timer_t kill_timer = nullptr;
  69   int segment_index = 0;    /*Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
  70 };
  71
  72 }
  73 }
  74
  75 typedef simgrid::simix::Process* smx_process_t;
  76
  77 SG_BEGIN_DECL()
  78
  79 XBT_PRIVATE smx_process_t SIMIX_process_create(
  80                           const char *name,
  81                           xbt_main_func_t code,
  82                           void *data,
  83                           const char *hostname,
  84                           double kill_time,
  85                           int argc, char **argv,
  86                           xbt_dict_t properties,
  87                           int auto_restart,
  88                           smx_process_t parent_process);
  89
  90 XBT_PRIVATE void SIMIX_process_runall(void);
  91 XBT_PRIVATE void SIMIX_process_kill(smx_process_t process, smx_process_t issuer);
  92 XBT_PRIVATE void SIMIX_process_killall(smx_process_t issuer, int reset_pid);
  93 XBT_PRIVATE smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args);
  94 XBT_PRIVATE void SIMIX_process_stop(smx_process_t arg);
  95 XBT_PRIVATE void SIMIX_process_cleanup(smx_process_t arg);
  96 XBT_PRIVATE void SIMIX_process_empty_trash(void);
  97 XBT_PRIVATE void SIMIX_process_yield(smx_process_t self);
  98 XBT_PRIVATE xbt_running_ctx_t *SIMIX_process_get_running_context(void);
  99 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
 100 XBT_PRIVATE void SIMIX_process_change_host(smx_process_t process,
 101              sg_host_t dest);
 102 XBT_PRIVATE smx_synchro_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer);
 103 XBT_PRIVATE void SIMIX_process_resume(smx_process_t process, smx_process_t issuer);
 104 XBT_PRIVATE int SIMIX_process_get_PID(smx_process_t self);
 105 XBT_PRIVATE int SIMIX_process_get_PPID(smx_process_t self);
 106 XBT_PRIVATE void* SIMIX_process_get_data(smx_process_t process);
 107 XBT_PRIVATE void SIMIX_process_set_data(smx_process_t process, void *data);
 108 XBT_PRIVATE sg_host_t SIMIX_process_get_host(smx_process_t process);
 109 XBT_PRIVATE const char* SIMIX_process_get_name(smx_process_t process);
 110 XBT_PRIVATE smx_process_t SIMIX_process_get_by_name(const char* name);
 111 XBT_PRIVATE int SIMIX_process_is_suspended(smx_process_t process);
 112 XBT_PRIVATE xbt_dict_t SIMIX_process_get_properties(smx_process_t process);
 113 XBT_PRIVATE smx_synchro_t SIMIX_process_join(smx_process_t issuer, smx_process_t process, double timeout);
 114 XBT_PRIVATE smx_synchro_t SIMIX_process_sleep(smx_process_t process, double duration);
 115
 116 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_synchro_t synchro);
 117 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_process_t process, int auto_restart);
 118 XBT_PRIVATE smx_process_t SIMIX_process_restart(smx_process_t process, smx_process_t issuer);
 119
 120 void SIMIX_segment_index_set(smx_process_t, int);
 121 extern void (*SMPI_switch_data_segment)(int);
 122
 123 SG_END_DECL()
 124
 125 #endif