Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
SIMIX_comm_cancel() -> simix::Comm->cancel()
[simgrid.git] / 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     void cancel();
27
28     e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
29     smx_mailbox_t mbox;             /* Rendez-vous where the comm is queued */
30
31 #if HAVE_MC
32     smx_mailbox_t mbox_cpy;         /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
33                                        (comm.mbox set to NULL when the communication is removed from the mailbox
34                                        (used as garbage collector)) */
35 #endif
36     int refcount;                   /* Number of processes involved in the cond */
37     int detached;                   /* If detached or not */
38
39     void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
40     int (*match_fun)(void*,void*,smx_synchro_t);  /* Filter function used by the other side. It is used when
41                                        looking if a given communication matches my needs. For that, myself must match the
42                                        expectations of the other side, too. See  */
43     void (*copy_data_fun) (smx_synchro_t, void*, size_t);
44
45     /* Surf action data */
46     surf_action_t surf_comm;        /* The Surf communication action encapsulated */
47     surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
48     surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
49     smx_process_t src_proc;
50     smx_process_t dst_proc;
51     double rate;
52     double task_size;
53
54     /* Data to be transfered */
55     void *src_buff;
56     void *dst_buff;
57     size_t src_buff_size;
58     size_t *dst_buff_size;
59     unsigned copied:1;              /* whether the data were already copied */
60
61     void* src_data;                 /* User data associated to communication */
62     void* dst_data;
63   };
64
65 }} // namespace simgrid::simix
66
67 #endif