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