src/simix/SynchroComm.hpp

   1 /* Copyright (c) 2007-2016. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef _SIMIX_SYNCHRO_COMM_HPP
   7 #define _SIMIX_SYNCHRO_COMM_HPP
   8
   9 #include "surf/surf.h"
  10 #include "src/simix/Synchro.h"
  11
  12 typedef enum {
  13   SIMIX_COMM_SEND,
  14   SIMIX_COMM_RECEIVE,
  15   SIMIX_COMM_READY,
  16   SIMIX_COMM_DONE
  17 } e_smx_comm_type_t;
  18
  19 namespace simgrid {
  20 namespace simix {
  21
  22   XBT_PUBLIC_CLASS Comm : public Synchro {
  23   public:
  24     void suspend();
  25     void resume();
  26
  27     e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
  28     smx_mailbox_t mbox;             /* Rendez-vous where the comm is queued */
  29
  30 #if HAVE_MC
  31     smx_mailbox_t mbox_cpy;         /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
  32                                        (comm.mbox set to NULL when the communication is removed from the mailbox
  33                                        (used as garbage collector)) */
  34 #endif
  35     int refcount;                   /* Number of processes involved in the cond */
  36     int detached;                   /* If detached or not */
  37
  38     void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
  39     int (*match_fun)(void*,void*,smx_synchro_t);  /* Filter function used by the other side. It is used when
  40                                        looking if a given communication matches my needs. For that, myself must match the
  41                                        expectations of the other side, too. See  */
  42     void (*copy_data_fun) (smx_synchro_t, void*, size_t);
  43
  44     /* Surf action data */
  45     surf_action_t surf_comm;        /* The Surf communication action encapsulated */
  46     surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
  47     surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
  48     smx_process_t src_proc;
  49     smx_process_t dst_proc;
  50     double rate;
  51     double task_size;
  52
  53     /* Data to be transfered */
  54     void *src_buff;
  55     void *dst_buff;
  56     size_t src_buff_size;
  57     size_t *dst_buff_size;
  58     unsigned copied:1;              /* whether the data were already copied */
  59
  60     void* src_data;                 /* User data associated to communication */
  61     void* dst_data;
  62   };
  63
  64 }} // namespace simgrid::simix
  65
  66 #endif