src/simix/smx_process_private.h

   1 /* Copyright (c) 2007-2010, 2012-2014. 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 "simgrid/simix.h"
  11 #include "smx_smurf_private.h"
  12
  13 SG_BEGIN_DECL()
  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 /** @brief Process datatype */
  33 typedef struct s_smx_process {
  34   s_xbt_swag_hookup_t process_hookup;
  35   s_xbt_swag_hookup_t synchro_hookup;   /* process_to_run or mutex->sleeping and co */
  36   s_xbt_swag_hookup_t host_proc_hookup;
  37   s_xbt_swag_hookup_t destroy_hookup;
  38
  39   unsigned long pid;
  40   unsigned long ppid;
  41   char *name;                   /**< @brief process name if any */
  42   smx_host_t smx_host;          /* the host on which the process is running */
  43   smx_context_t context;        /* the context (uctx/raw/thread) that executes the user function */
  44   xbt_running_ctx_t *running_ctx;
  45   unsigned doexception:1;
  46   unsigned blocked:1;
  47   unsigned suspended:1;
  48   unsigned auto_restart:1;
  49
  50   smx_host_t new_host;          /* if not null, the host on which the process must migrate to */
  51   smx_action_t waiting_action;  /* the current blocking action if any */
  52   xbt_fifo_t comms;       /* the current non-blocking communication actions */
  53   xbt_dict_t properties;
  54   s_smx_simcall_t simcall;
  55   void *data;                   /* kept for compatibility, it should be replaced with moddata */
  56   xbt_dynar_t on_exit;     /* list of functions executed when the process dies */
  57
  58   xbt_main_func_t code;
  59   int argc;
  60   char **argv;
  61   double kill_time;
  62
  63 } s_smx_process_t;
  64
  65
  66 void SIMIX_process_create(smx_process_t *process,
  67                           const char *name,
  68                           xbt_main_func_t code,
  69                           void *data,
  70                           const char *hostname,
  71                           double kill_time,
  72                           int argc, char **argv,
  73                           xbt_dict_t properties,
  74                           int auto_restart,
  75                           smx_process_t parent_process);
  76 void SIMIX_process_runall(void);
  77 void SIMIX_process_kill(smx_process_t process, smx_process_t issuer);
  78 void SIMIX_process_killall(smx_process_t issuer, int reset_pid);
  79 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args);
  80 void SIMIX_create_maestro_process(void);
  81 void SIMIX_process_stop(smx_process_t arg);
  82 void SIMIX_process_cleanup(smx_process_t arg);
  83 void SIMIX_process_empty_trash(void);
  84 void SIMIX_process_yield(smx_process_t self);
  85 xbt_running_ctx_t *SIMIX_process_get_running_context(void);
  86 void SIMIX_process_exception_terminate(xbt_ex_t * e);
  87 void SIMIX_pre_process_change_host(smx_simcall_t, smx_process_t process,
  88            smx_host_t dest);
  89 void SIMIX_process_change_host(smx_process_t process,
  90              smx_host_t dest);
  91 void SIMIX_pre_process_suspend(smx_simcall_t simcall, smx_process_t process);
  92 smx_action_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer);
  93 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer);
  94 int SIMIX_process_get_PID(smx_process_t self);
  95 int SIMIX_process_get_PPID(smx_process_t self);
  96 void* SIMIX_process_get_data(smx_process_t process);
  97 void SIMIX_process_set_data(smx_process_t process, void *data);
  98 smx_host_t SIMIX_process_get_host(smx_process_t process);
  99 const char* SIMIX_process_get_name(smx_process_t process);
 100 smx_process_t SIMIX_process_get_by_name(const char* name);
 101 int SIMIX_process_is_suspended(smx_process_t process);
 102 xbt_dict_t SIMIX_process_get_properties(smx_process_t process);
 103 void SIMIX_pre_process_join(smx_simcall_t simcall, smx_process_t process, double timeout);
 104 smx_action_t SIMIX_process_join(smx_process_t issuer, smx_process_t process, double timeout);
 105 void SIMIX_pre_process_sleep(smx_simcall_t simcall, double duration);
 106 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration);
 107 void SIMIX_post_process_sleep(smx_action_t action);
 108
 109 void SIMIX_process_sleep_suspend(smx_action_t action);
 110 void SIMIX_process_sleep_resume(smx_action_t action);
 111 void SIMIX_process_sleep_destroy(smx_action_t action);
 112 void SIMIX_process_auto_restart_set(smx_process_t process, int auto_restart);
 113 smx_process_t SIMIX_process_restart(smx_process_t process, smx_process_t issuer);
 114
 115 // pre prototypes
 116 void SIMIX_pre_process_create(smx_simcall_t simcall, smx_process_t *process,
 117                               const char *name, xbt_main_func_t code, void *data,
 118                               const char *hostname, double kill_time, int argc,
 119                               char **argv, xbt_dict_t properties, int auto_restart);
 120 void SIMIX_pre_process_kill(smx_simcall_t simcall, smx_process_t process);
 121 void SIMIX_pre_process_killall(smx_simcall_t simcall, int reset_pid);
 122 void SIMIX_pre_process_cleanup(smx_simcall_t simcall, smx_process_t process);
 123 void SIMIX_pre_process_resume(smx_simcall_t simcall, smx_process_t process);
 124 int SIMIX_pre_process_count(smx_simcall_t simcall);
 125 void* SIMIX_pre_process_self_get_data(smx_simcall_t simcall, smx_process_t process);
 126 int SIMIX_pre_process_get_PID(smx_simcall_t simcall, smx_process_t self);
 127 int SIMIX_pre_process_get_PPID(smx_simcall_t simcall, smx_process_t self);
 128 void* SIMIX_pre_process_get_data(smx_simcall_t simcall, smx_process_t process);
 129 void SIMIX_pre_process_set_data(smx_simcall_t simcall, smx_process_t process,
 130                                 void *data);
 131 smx_host_t SIMIX_pre_process_get_host(smx_simcall_t simcall, smx_process_t process);
 132 const char* SIMIX_pre_process_get_name(smx_simcall_t simcall, smx_process_t process);
 133 int SIMIX_pre_process_is_suspended(smx_simcall_t simcall, smx_process_t process);
 134 xbt_dict_t SIMIX_pre_process_get_properties(smx_simcall_t simcall, smx_process_t process);
 135 void SIMIX_pre_process_on_exit(smx_simcall_t simcall, smx_process_t process,
 136                                int_f_pvoid_pvoid_t fun, void *data);
 137 void SIMIX_pre_process_auto_restart_set(smx_simcall_t simcall, smx_process_t process,
 138                                         int auto_restart);
 139 smx_process_t SIMIX_pre_process_restart(smx_simcall_t simcall, smx_process_t process);
 140
 141 SG_END_DECL()
 142
 143 #endif