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