src/simix/smx_process_private.h

   1 /* Copyright (c) 2007, 2008, 2009, 2010. 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_t fun;
  15   void *arg;
  16 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
  17
  18 /** @brief Process datatype */
  19 typedef struct s_smx_process {
  20   s_xbt_swag_hookup_t process_hookup;
  21   s_xbt_swag_hookup_t synchro_hookup;   /* process_to_run or mutex->sleeping and co */
  22   s_xbt_swag_hookup_t host_proc_hookup;
  23   s_xbt_swag_hookup_t destroy_hookup;
  24
  25   unsigned long pid;
  26   char *name;                   /**< @brief process name if any */
  27   smx_host_t smx_host;          /* the host on which the process is running */
  28   smx_context_t context;        /* the context (uctx/raw/thread) that executes the user function */
  29   xbt_running_ctx_t *running_ctx;
  30   unsigned doexception:1;
  31   unsigned blocked:1;
  32   unsigned suspended:1;
  33   smx_host_t new_host;          /* if not null, the host on which the process must migrate to */
  34   smx_action_t waiting_action;  /* the current blocking action if any */
  35   xbt_fifo_t comms;       /* the current non-blocking communication actions */
  36   xbt_dict_t properties;
  37   s_smx_simcall_t simcall;
  38   void *data;                   /* kept for compatibility, it should be replaced with moddata */
  39   xbt_dynar_t on_exit_fun;     /* list of functions executed when the process dies */
  40   xbt_dynar_t on_exit_args;    /* arguments (void*) of the functions executed when the process dies */
  41 } s_smx_process_t;
  42
  43 typedef struct s_smx_process_arg {
  44   const char *name;
  45   xbt_main_func_t code;
  46   void *data;
  47   char *hostname;
  48   int argc;
  49   char **argv;
  50   double kill_time;
  51   xbt_dict_t properties;
  52 } s_smx_process_arg_t, *smx_process_arg_t;
  53
  54 void SIMIX_process_create(smx_process_t *process,
  55                           const char *name,
  56                           xbt_main_func_t code,
  57                           void *data,
  58                           const char *hostname,
  59                           double kill_time,
  60                           int argc, char **argv,
  61                           xbt_dict_t properties);
  62 void SIMIX_process_runall(void);
  63 void SIMIX_process_kill(smx_process_t process);
  64 void SIMIX_process_killall(smx_process_t issuer);
  65 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args);
  66 void SIMIX_create_maestro_process(void);
  67 void SIMIX_process_cleanup(smx_process_t arg);
  68 void SIMIX_process_empty_trash(void);
  69 void SIMIX_process_yield(smx_process_t self);
  70 xbt_running_ctx_t *SIMIX_process_get_running_context(void);
  71 void SIMIX_process_exception_terminate(xbt_ex_t * e);
  72 void SIMIX_pre_process_change_host(smx_process_t process,
  73            smx_host_t dest);
  74 void SIMIX_process_change_host(smx_process_t process,
  75              smx_host_t dest);
  76 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t host);
  77 void SIMIX_pre_process_suspend(smx_simcall_t simcall);
  78 smx_action_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer);
  79 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer);
  80 void* SIMIX_process_get_data(smx_process_t process);
  81 void SIMIX_process_set_data(smx_process_t process, void *data);
  82 smx_host_t SIMIX_process_get_host(smx_process_t process);
  83 const char* SIMIX_process_get_name(smx_process_t process);
  84 smx_process_t SIMIX_process_get_by_name(const char* name);
  85 int SIMIX_process_is_suspended(smx_process_t process);
  86 xbt_dict_t SIMIX_process_get_properties(smx_process_t process);
  87 void SIMIX_pre_process_sleep(smx_simcall_t simcall);
  88 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration);
  89 void SIMIX_post_process_sleep(smx_action_t action);
  90
  91 void SIMIX_process_sleep_suspend(smx_action_t action);
  92 void SIMIX_process_sleep_resume(smx_action_t action);
  93 void SIMIX_process_sleep_destroy(smx_action_t action);
  94
  95 void SIMIX_process_on_exit(smx_process_t process);
  96 void SIMIX_process_on_exit_add(int_f_pvoid_t fun, void *data);
  97 #endif