mpidpkt.h 35.9 KB
Newer Older
1
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
2 3 4 5 6 7 8
/*
 *  (C) 2001 by Argonne National Laboratory.
 *      See COPYRIGHT in top-level directory.
 */

#ifndef HAVE_MPIDPKT_H
#define HAVE_MPIDPKT_H
9

10 11
#include "oputil.h"

12 13 14 15 16 17 18
#ifdef HAVE_STDINT_H
#  include <stdint.h>
#endif
#ifdef HAVE_INTTYPES_H
#  include <inttypes.h>
#endif

19 20 21
/* Enable the use of data within the message packet for small messages */
#define USE_EAGER_SHORT
#define MPIDI_EAGER_SHORT_INTS 4
22
/* FIXME: This appears to assume that sizeof(int) == 4 (or at least >= 4) */
23 24
#define MPIDI_EAGER_SHORT_SIZE 16

25
/* This is the number of ints that can be carried within an RMA packet */
Xin Zhao's avatar
Xin Zhao committed
26
#define MPIDI_RMA_IMMED_BYTES 16
27

28 29 30
/* Union over all types (integer, logical, and multi-language types) that are
   allowed in a CAS operation.  This is used to allocate enough space in the
   packet header for immediate data.  */
31
typedef union {
32
#define MPIR_OP_TYPE_MACRO(mpi_type_, c_type_, type_name_) c_type_ cas_##type_name_;
33 34 35 36 37 38 39 40
    MPIR_OP_TYPE_GROUP(C_INTEGER)
    MPIR_OP_TYPE_GROUP(FORTRAN_INTEGER)
    MPIR_OP_TYPE_GROUP(LOGICAL)
    MPIR_OP_TYPE_GROUP(BYTE)
    MPIR_OP_TYPE_GROUP(C_INTEGER_EXTRA)
    MPIR_OP_TYPE_GROUP(FORTRAN_INTEGER_EXTRA)
    MPIR_OP_TYPE_GROUP(LOGICAL_EXTRA)
    MPIR_OP_TYPE_GROUP(BYTE_EXTRA)
41
#undef MPIR_OP_TYPE_MACRO
42 43
} MPIDI_CH3_CAS_Immed_u;

44 45 46 47
/* Union over all types (all predefined types) that are allowed in a
   Fetch-and-op operation.  This can be too large for the packet header, so we
   limit the immediate space in the header to FOP_IMMED_INTS. */

48 49 50
/* *INDENT-OFF* */
/* Indentation turned off because "indent" is getting confused with
 * the lack of a semi-colon in the fields below */
51
typedef union {
52
#define MPIR_OP_TYPE_MACRO(mpi_type_, c_type_, type_name_) c_type_ fop##type_name_;
53 54
    MPIR_OP_TYPE_GROUP_ALL_BASIC
    MPIR_OP_TYPE_GROUP_ALL_EXTRA
55
#undef MPIR_OP_TYPE_MACRO
56
} MPIDI_CH3_FOP_Immed_u;
57
/* *INDENT-ON* */
58

59
/*
60
 * Predefined packet types.  This simplifies some of the code.
61
 */
62 63
/* FIXME: Having predefined names makes it harder to add new message types,
   such as different RMA types. */
64
typedef enum {
Xin Zhao's avatar
Xin Zhao committed
65
    MPIDI_CH3_PKT_EAGER_SEND = 0,
66
#if defined(USE_EAGER_SHORT)
67
    MPIDI_CH3_PKT_EAGERSHORT_SEND,
68
#endif /* defined(USE_EAGER_SHORT) */
69
    MPIDI_CH3_PKT_EAGER_SYNC_SEND,      /* FIXME: no sync eager */
70 71 72 73
    MPIDI_CH3_PKT_EAGER_SYNC_ACK,
    MPIDI_CH3_PKT_READY_SEND,
    MPIDI_CH3_PKT_RNDV_REQ_TO_SEND,
    MPIDI_CH3_PKT_RNDV_CLR_TO_SEND,
74
    MPIDI_CH3_PKT_RNDV_SEND,    /* FIXME: should be stream put */
75 76
    MPIDI_CH3_PKT_CANCEL_SEND_REQ,
    MPIDI_CH3_PKT_CANCEL_SEND_RESP,
Xin Zhao's avatar
Xin Zhao committed
77 78
    /* RMA Packets begin here */
    MPIDI_CH3_PKT_PUT,
79 80
    MPIDI_CH3_PKT_GET,
    MPIDI_CH3_PKT_ACCUMULATE,
Xin Zhao's avatar
Xin Zhao committed
81 82 83 84 85 86 87
    MPIDI_CH3_PKT_GET_ACCUM,
    MPIDI_CH3_PKT_FOP,
    MPIDI_CH3_PKT_CAS,
    MPIDI_CH3_PKT_GET_RESP,
    MPIDI_CH3_PKT_GET_ACCUM_RESP,
    MPIDI_CH3_PKT_FOP_RESP,
    MPIDI_CH3_PKT_CAS_RESP,
88
    MPIDI_CH3_PKT_LOCK,
89
    MPIDI_CH3_PKT_UNLOCK,
90
    MPIDI_CH3_PKT_FLUSH,
91
    MPIDI_CH3_PKT_DECR_AT_COUNTER,
92
    MPIDI_CH3_PKT_LOCK_ACK,
93
    MPIDI_CH3_PKT_LOCK_OP_ACK,
94
    MPIDI_CH3_PKT_FLUSH_ACK,
95 96
    /* RMA Packets end here */
    MPIDI_CH3_PKT_FLOW_CNTL_UPDATE,     /* FIXME: Unused */
97
    MPIDI_CH3_PKT_CLOSE,
Wesley Bland's avatar
Wesley Bland committed
98
    MPIDI_CH3_PKT_REVOKE,
Pavan Balaji's avatar
Pavan Balaji committed
99
    MPIDI_CH3_PKT_END_CH3,
100
    /* The channel can define additional types by defining the value
101
     * MPIDI_CH3_PKT_ENUM */
102
# if defined(MPIDI_CH3_PKT_ENUM)
Pavan Balaji's avatar
Pavan Balaji committed
103
    MPIDI_CH3_PKT_ENUM,
104
# endif
Pavan Balaji's avatar
Pavan Balaji committed
105
    MPIDI_CH3_PKT_END_ALL,
106
    MPIDI_CH3_PKT_INVALID = -1  /* forces a signed enum to quash warnings */
Pavan Balaji's avatar
Pavan Balaji committed
107
} MPIDI_CH3_Pkt_type_t;
108

109
/* These flags can be "OR'ed" together */
110 111 112 113 114 115
typedef enum {
    MPIDI_CH3_PKT_FLAG_NONE = 0,
    MPIDI_CH3_PKT_FLAG_RMA_LOCK = 1,
    MPIDI_CH3_PKT_FLAG_RMA_UNLOCK = 2,
    MPIDI_CH3_PKT_FLAG_RMA_FLUSH = 4,
    MPIDI_CH3_PKT_FLAG_RMA_REQ_ACK = 8,
116
    MPIDI_CH3_PKT_FLAG_RMA_DECR_AT_COUNTER = 16,
117 118
    MPIDI_CH3_PKT_FLAG_RMA_NOCHECK = 32,
    MPIDI_CH3_PKT_FLAG_RMA_SHARED = 64,
119
    MPIDI_CH3_PKT_FLAG_RMA_EXCLUSIVE = 128,
120
    MPIDI_CH3_PKT_FLAG_RMA_FLUSH_ACK = 256,
121 122 123 124 125 126
    MPIDI_CH3_PKT_FLAG_RMA_LOCK_GRANTED = 512,
    MPIDI_CH3_PKT_FLAG_RMA_LOCK_QUEUED_DATA_QUEUED = 1024,
    MPIDI_CH3_PKT_FLAG_RMA_LOCK_QUEUED_DATA_DISCARDED = 2048,
    MPIDI_CH3_PKT_FLAG_RMA_LOCK_DISCARDED = 4096,
    MPIDI_CH3_PKT_FLAG_RMA_UNLOCK_NO_ACK = 8192,
    MPIDI_CH3_PKT_FLAG_RMA_IMMED_RESP = 16384
127
} MPIDI_CH3_Pkt_flags_t;
128

129
typedef struct MPIDI_CH3_Pkt_send {
130 131
    MPIDI_CH3_Pkt_type_t type;  /* XXX - uint8_t to conserve space ??? */
    MPIDI_Message_match match;
132
    MPI_Request sender_req_id;  /* needed for ssend and send cancel */
133 134 135
    MPIDI_msg_sz_t data_sz;
#if defined(MPID_USE_SEQUENCE_NUMBERS)
    MPID_Seqnum_t seqnum;
136 137
#endif
} MPIDI_CH3_Pkt_send_t;
138

139
/* NOTE: Normal and synchronous eager sends, as well as all ready-mode sends,
140 141 142 143
   use the same structure but have a different type value. */
typedef MPIDI_CH3_Pkt_send_t MPIDI_CH3_Pkt_eager_send_t;
typedef MPIDI_CH3_Pkt_send_t MPIDI_CH3_Pkt_eager_sync_send_t;
typedef MPIDI_CH3_Pkt_send_t MPIDI_CH3_Pkt_ready_send_t;
144 145

#if defined(USE_EAGER_SHORT)
146
typedef struct MPIDI_CH3_Pkt_eagershort_send {
147 148 149 150 151 152
    MPIDI_CH3_Pkt_type_t type;  /* XXX - uint8_t to conserve space ??? */
    MPIDI_Message_match match;
    MPIDI_msg_sz_t data_sz;
#if defined(MPID_USE_SEQUENCE_NUMBERS)
    MPID_Seqnum_t seqnum;
#endif
153 154
    int data[MPIDI_EAGER_SHORT_INTS];   /* FIXME: Experimental for now */
} MPIDI_CH3_Pkt_eagershort_send_t;
155
#endif /* defined(USE_EAGER_SHORT) */
156

157
typedef struct MPIDI_CH3_Pkt_eager_sync_ack {
158 159
    MPIDI_CH3_Pkt_type_t type;
    MPI_Request sender_req_id;
160
} MPIDI_CH3_Pkt_eager_sync_ack_t;
161 162 163

typedef MPIDI_CH3_Pkt_send_t MPIDI_CH3_Pkt_rndv_req_to_send_t;

164
typedef struct MPIDI_CH3_Pkt_rndv_clr_to_send {
165 166 167
    MPIDI_CH3_Pkt_type_t type;
    MPI_Request sender_req_id;
    MPI_Request receiver_req_id;
168
} MPIDI_CH3_Pkt_rndv_clr_to_send_t;
169

170
typedef struct MPIDI_CH3_Pkt_rndv_send {
171 172
    MPIDI_CH3_Pkt_type_t type;
    MPI_Request receiver_req_id;
173
} MPIDI_CH3_Pkt_rndv_send_t;
174

175
typedef struct MPIDI_CH3_Pkt_cancel_send_req {
176 177 178
    MPIDI_CH3_Pkt_type_t type;
    MPIDI_Message_match match;
    MPI_Request sender_req_id;
179
} MPIDI_CH3_Pkt_cancel_send_req_t;
180

181
typedef struct MPIDI_CH3_Pkt_cancel_send_resp {
182 183 184
    MPIDI_CH3_Pkt_type_t type;
    MPI_Request sender_req_id;
    int ack;
185
} MPIDI_CH3_Pkt_cancel_send_resp_t;
186

187 188 189
/* *INDENT-OFF* */
/* Indentation turned off because "indent" is getting confused with
 * the lack of a semi-colon in the field below */
190 191 192
#if defined(MPIDI_CH3_PKT_DEFS)
MPIDI_CH3_PKT_DEFS
#endif
193
/* *INDENT-ON* */
194

195 196 197
#define MPIDI_CH3_PKT_RMA_GET_TARGET_DATATYPE(pkt_, datatype_, err_)    \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
Xin Zhao's avatar
Xin Zhao committed
198
        switch((pkt_).type) {                                           \
199
        case (MPIDI_CH3_PKT_PUT):                                       \
Xin Zhao's avatar
Xin Zhao committed
200
            datatype_ = (pkt_).put.datatype;                            \
201 202
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
Xin Zhao's avatar
Xin Zhao committed
203
            datatype_ = (pkt_).get.datatype;                            \
204 205
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
Xin Zhao's avatar
Xin Zhao committed
206
            datatype_ = (pkt_).accum.datatype;                          \
207
            break;                                                      \
Xin Zhao's avatar
Xin Zhao committed
208
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
Xin Zhao's avatar
Xin Zhao committed
209
            datatype_ = (pkt_).get_accum.datatype;                      \
Xin Zhao's avatar
Xin Zhao committed
210
            break;                                                      \
211
        case (MPIDI_CH3_PKT_CAS):                                       \
Xin Zhao's avatar
Xin Zhao committed
212
            datatype_ = (pkt_).cas.datatype;                            \
213 214
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
Xin Zhao's avatar
Xin Zhao committed
215
            datatype_ = (pkt_).fop.datatype;                            \
216 217
            break;                                                      \
        default:                                                        \
Xin Zhao's avatar
Xin Zhao committed
218
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
219 220 221
        }                                                               \
    }

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
#define MPIDI_CH3_PKT_RMA_GET_TARGET_COUNT(pkt_, count_, err_)          \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            count_ = (pkt_).put.count;                                  \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            count_ = (pkt_).get.count;                                  \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            count_ = (pkt_).accum.count;                                \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            count_ = (pkt_).get_accum.count;                            \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
        case (MPIDI_CH3_PKT_FOP):                                       \
            count_ = 1;                                                 \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

#define MPIDI_CH3_PKT_RMA_GET_IMMED_LEN(pkt_, immed_len_, err_)         \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            immed_len_ = (pkt_).put.immed_len;                          \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            immed_len_ = (pkt_).accum.immed_len;                        \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            immed_len_ = (pkt_).get_accum.immed_len;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            immed_len_ = (pkt_).fop.immed_len;                          \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            /* FIXME: we should deal with CAS here */                   \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

#define MPIDI_CH3_PKT_RMA_GET_IMMED_DATA_PTR(pkt_, immed_data_, err_)   \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            immed_data_ = (pkt_).put.data;                              \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            immed_data_ = (pkt_).accum.data;                            \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            immed_data_ = (pkt_).get_accum.data;                        \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            immed_data_ = (pkt_).fop.data;                              \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            /* FIXME: we should deal with CAS here */                   \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

Xin Zhao's avatar
Xin Zhao committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
#define MPIDI_CH3_PKT_RMA_GET_LOCK_TYPE(pkt_, lock_type_, err_)         \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            lock_type_ = (pkt_).put.lock_type;                          \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            lock_type_ = (pkt_).get.lock_type;                          \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            lock_type_ = (pkt_).accum.lock_type;                        \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            lock_type_ = (pkt_).get_accum.lock_type;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            lock_type_ = (pkt_).cas.lock_type;                          \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            lock_type_ = (pkt_).fop.lock_type;                          \
            break;                                                      \
        case (MPIDI_CH3_PKT_LOCK):                                      \
            lock_type_ = (pkt_).lock.lock_type;                         \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

#define MPIDI_CH3_PKT_RMA_GET_ORIGIN_RANK(pkt_, origin_rank_, err_)     \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            origin_rank_ = (pkt_).put.origin_rank;                      \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            origin_rank_ = (pkt_).get.origin_rank;                      \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            origin_rank_ = (pkt_).accum.origin_rank;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            origin_rank_ = (pkt_).get_accum.origin_rank;                \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            origin_rank_ = (pkt_).cas.origin_rank;                      \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            origin_rank_ = (pkt_).fop.origin_rank;                      \
            break;                                                      \
        case (MPIDI_CH3_PKT_LOCK):                                      \
            origin_rank_ = (pkt_).lock.origin_rank;                     \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

#define MPIDI_CH3_PKT_RMA_GET_FLAGS(pkt_, flags_, err_)                 \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            flags_ = (pkt_).put.flags;                                  \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            flags_ = (pkt_).get.flags;                                  \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            flags_ = (pkt_).accum.flags;                                \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            flags_ = (pkt_).get_accum.flags;                            \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            flags_ = (pkt_).cas.flags;                                  \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            flags_ = (pkt_).fop.flags;                                  \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
#define MPIDI_CH3_PKT_RMA_ERASE_FLAGS(pkt_, err_)                       \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            (pkt_).put.flags = MPIDI_CH3_PKT_FLAG_NONE;                 \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            (pkt_).get.flags = MPIDI_CH3_PKT_FLAG_NONE;                 \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            (pkt_).accum.flags = MPIDI_CH3_PKT_FLAG_NONE;               \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            (pkt_).get_accum.flags = MPIDI_CH3_PKT_FLAG_NONE;           \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            (pkt_).cas.flags = MPIDI_CH3_PKT_FLAG_NONE;                 \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            (pkt_).fop.flags = MPIDI_CH3_PKT_FLAG_NONE;                 \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

#define MPIDI_CH3_PKT_RMA_GET_SOURCE_WIN_HANDLE(pkt_, win_hdl_, err_)   \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            win_hdl_ = (pkt_).put.source_win_handle;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            win_hdl_ = (pkt_).get.source_win_handle;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            win_hdl_ = (pkt_).accum.source_win_handle;                  \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            win_hdl_ = (pkt_).get_accum.source_win_handle;              \
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
            win_hdl_ = (pkt_).cas.source_win_handle;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
            win_hdl_ = (pkt_).fop.source_win_handle;                    \
            break;                                                      \
        case (MPIDI_CH3_PKT_LOCK):                                      \
            win_hdl_ = (pkt_).lock.source_win_handle;                   \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

439
#define MPIDI_CH3_PKT_RMA_GET_TARGET_WIN_HANDLE(pkt_, win_hdl_, err_)   \
Xin Zhao's avatar
Xin Zhao committed
440 441 442 443
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
444
            win_hdl_ = (pkt_).put.target_win_handle;                    \
Xin Zhao's avatar
Xin Zhao committed
445 446
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
447
            win_hdl_ = (pkt_).get.target_win_handle;                    \
Xin Zhao's avatar
Xin Zhao committed
448 449
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
450
            win_hdl_ = (pkt_).accum.target_win_handle;                  \
Xin Zhao's avatar
Xin Zhao committed
451 452
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
453
            win_hdl_ = (pkt_).get_accum.target_win_handle;              \
Xin Zhao's avatar
Xin Zhao committed
454 455
            break;                                                      \
        case (MPIDI_CH3_PKT_CAS):                                       \
456
            win_hdl_ = (pkt_).cas.target_win_handle;                    \
Xin Zhao's avatar
Xin Zhao committed
457 458
            break;                                                      \
        case (MPIDI_CH3_PKT_FOP):                                       \
459
            win_hdl_ = (pkt_).fop.target_win_handle;                    \
Xin Zhao's avatar
Xin Zhao committed
460
            break;                                                      \
461 462 463
        case (MPIDI_CH3_PKT_LOCK):                                      \
            win_hdl_ = (pkt_).lock.target_win_handle;                   \
            break;                                                      \
Xin Zhao's avatar
Xin Zhao committed
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

#define MPIDI_CH3_PKT_RMA_SET_DATALOOP_SIZE(pkt_, dataloop_size_, err_) \
    {                                                                   \
        err_ = MPI_SUCCESS;                                             \
        switch((pkt_).type) {                                           \
        case (MPIDI_CH3_PKT_PUT):                                       \
            (pkt_).put.dataloop_size = (dataloop_size_);                \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET):                                       \
            (pkt_).get.dataloop_size = (dataloop_size_);                \
            break;                                                      \
        case (MPIDI_CH3_PKT_ACCUMULATE):                                \
            (pkt_).accum.dataloop_size = (dataloop_size_);              \
            break;                                                      \
        case (MPIDI_CH3_PKT_GET_ACCUM):                                 \
            (pkt_).get_accum.dataloop_size = (dataloop_size_);          \
            break;                                                      \
        default:                                                        \
            MPIU_ERR_SETANDJUMP1(err_, MPI_ERR_OTHER, "**invalidpkt", "**invalidpkt %d", (pkt_).type); \
        }                                                               \
    }

490 491 492 493 494
/* RMA packets start here */

/********************************************************************************/
/* RMA packet (from origin to target, including PUT, GET, ACC, GACC, CAS, FOP)  */
/********************************************************************************/
Xin Zhao's avatar
Xin Zhao committed
495

496
typedef struct MPIDI_CH3_Pkt_put {
497
    MPIDI_CH3_Pkt_type_t type;
498
    MPIDI_CH3_Pkt_flags_t flags;
499 500 501
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
    /* Followings are to describe target data */
502 503 504
    void *addr;
    int count;
    MPI_Datatype datatype;
505 506 507 508 509
    int dataloop_size;
    /* Followings are to piggyback LOCK */
    int lock_type;
    int origin_rank;
    /* Followings are to piggyback IMMED data */
510
    int immed_len;
511
    char data[MPIDI_RMA_IMMED_BYTES];
512 513 514
} MPIDI_CH3_Pkt_put_t;

typedef struct MPIDI_CH3_Pkt_get {
515
    MPIDI_CH3_Pkt_type_t type;
516
    MPIDI_CH3_Pkt_flags_t flags;
517 518 519
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
    /* Followings are to describe target data */
520 521 522
    void *addr;
    int count;
    MPI_Datatype datatype;
523 524
    int dataloop_size;
    /* Following is to complete request at origin */
525
    MPI_Request request_handle;
526 527 528
    /* Followings are to piggyback LOCK */
    int lock_type;
    int origin_rank;
529 530 531
} MPIDI_CH3_Pkt_get_t;

typedef struct MPIDI_CH3_Pkt_accum {
532
    MPIDI_CH3_Pkt_type_t type;
533
    MPIDI_CH3_Pkt_flags_t flags;
534 535 536
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
    /* Followings are to describe target data */
537 538 539
    void *addr;
    int count;
    MPI_Datatype datatype;
540 541
    int dataloop_size;
    /* Following is to specify ACC op */
542
    MPI_Op op;
543 544 545 546
    /* Followings are to piggyback LOCK */
    int lock_type;
    int origin_rank;
    /* Followings are to piggyback IMMED data */
547
    int immed_len;
548
    char data[MPIDI_RMA_IMMED_BYTES];
549 550
} MPIDI_CH3_Pkt_accum_t;

Xin Zhao's avatar
Xin Zhao committed
551 552 553
typedef struct MPIDI_CH3_Pkt_get_accum {
    MPIDI_CH3_Pkt_type_t type;
    MPIDI_CH3_Pkt_flags_t flags;
554 555 556
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
    /* Followings are to describe target data */
Xin Zhao's avatar
Xin Zhao committed
557 558 559
    void *addr;
    int count;
    MPI_Datatype datatype;
560 561
    int dataloop_size;
    /* Following is to describe ACC op */
Xin Zhao's avatar
Xin Zhao committed
562
    MPI_Op op;
563 564 565 566 567 568
    /* Following is to complete request on origin */
    MPI_Request request_handle;
    /* Followings are to piggyback LOCK */
    int lock_type;
    int origin_rank;
    /* Followings are to piggback IMMED data */
569
    int immed_len;
570
    char data[MPIDI_RMA_IMMED_BYTES];
Xin Zhao's avatar
Xin Zhao committed
571 572
} MPIDI_CH3_Pkt_get_accum_t;

573
typedef struct MPIDI_CH3_Pkt_fop {
574
    MPIDI_CH3_Pkt_type_t type;
575
    MPIDI_CH3_Pkt_flags_t flags;
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
    MPI_Win source_win_handle;
    MPI_Win target_win_handle;
    /* Followings are to describe target data */
    void *addr;
    MPI_Datatype datatype;
    /* Following is to speicfy ACC op */
    MPI_Op op;
    /* Following is to complete request at origin */
    MPI_Request request_handle;
    /* Followings are to piggyback IMMED data */
    int lock_type;
    int origin_rank;
    /* Followings are to piggyback IMMED data */
    int immed_len;
    char data[MPIDI_RMA_IMMED_BYTES];
} MPIDI_CH3_Pkt_fop_t;
592

593
typedef struct MPIDI_CH3_Pkt_cas {
594
    MPIDI_CH3_Pkt_type_t type;
595
    MPIDI_CH3_Pkt_flags_t flags;
596 597 598
    MPI_Win source_win_handle;
    MPI_Win target_win_handle;
    /* Followings are to describe target data */
599
    void *addr;
600 601
    MPI_Datatype datatype;
    /* Following is to complete request on origin */
602
    MPI_Request request_handle;
603 604 605 606
    /* Followings are to piggyback LOCK */
    int lock_type;
    int origin_rank;
    /* Followings are to piggyback IMMED data */
607 608
    MPIDI_CH3_CAS_Immed_u origin_data;
    MPIDI_CH3_CAS_Immed_u compare_data;
609
} MPIDI_CH3_Pkt_cas_t;
610

611 612 613 614 615 616 617

/*********************************************************************************/
/* RMA response packet (from target to origin, including GET_RESP, GET_ACC_RESP, */
/* CAS_RESP, FOP_RESP)                                                           */
/*********************************************************************************/

typedef struct MPIDI_CH3_Pkt_get_resp {
618
    MPIDI_CH3_Pkt_type_t type;
619 620
    MPIDI_CH3_Pkt_flags_t flags;
    /* Following is to complete request at origin */
621
    MPI_Request request_handle;
622 623
    /* TODO: we should add IMMED data here */
    /* Followings are used to decrement ack_counter at origin */
624
    MPI_Win source_win_handle;
625
    int target_rank;
626
    /* Followings are to piggyback IMMED data */
627
    int immed_len;
628
    char data[MPIDI_RMA_IMMED_BYTES];
629
} MPIDI_CH3_Pkt_get_resp_t;
630

631
typedef struct MPIDI_CH3_Pkt_get_accum_resp {
632
    MPIDI_CH3_Pkt_type_t type;
633
    MPIDI_CH3_Pkt_flags_t flags;
634
    /* Following is to complete request at origin */
635
    MPI_Request request_handle;
636 637
    /* TODO: we should add IMMED data here */
    /* Followings are used to decrement ack_counter at origin */
638
    MPI_Win source_win_handle;
639
    int target_rank;
640
    /* Followings are to piggyback IMMED data */
641
    int immed_len;
642
    char data[MPIDI_RMA_IMMED_BYTES];
643
} MPIDI_CH3_Pkt_get_accum_resp_t;
644

645
typedef struct MPIDI_CH3_Pkt_fop_resp {
646
    MPIDI_CH3_Pkt_type_t type;
647 648
    MPIDI_CH3_Pkt_flags_t flags;
    /* Following is to complete request at origin */
649
    MPI_Request request_handle;
650
    /* Followings are used to decrement ack_counter at orign */
651
    MPI_Win source_win_handle;
652 653 654 655
    int target_rank;
    /* Followings are to piggyback IMMED data */
    int immed_len;
    char data[MPIDI_RMA_IMMED_BYTES];
656
} MPIDI_CH3_Pkt_fop_resp_t;
657

658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
typedef struct MPIDI_CH3_Pkt_cas_resp {
    MPIDI_CH3_Pkt_type_t type;
    MPIDI_CH3_Pkt_flags_t flags;
    /* Following is to complete request at origin */
    MPI_Request request_handle;
    /* Followings are used to decrement ack_counter at orign */
    MPI_Win source_win_handle;
    int target_rank;
    /* Following is to piggyback IMMED data */
    MPIDI_CH3_CAS_Immed_u data;
} MPIDI_CH3_Pkt_cas_resp_t;

/*********************************************************************************/
/* RMA control packet (from origin to target, including LOCK, UNLOCK, FLUSH)     */
/*********************************************************************************/

674
typedef struct MPIDI_CH3_Pkt_lock {
675 676 677
    MPIDI_CH3_Pkt_type_t type;
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
678
    int lock_type;
679
    int origin_rank;
680
} MPIDI_CH3_Pkt_lock_t;
681

Xin Zhao's avatar
Xin Zhao committed
682 683
typedef struct MPIDI_CH3_Pkt_unlock {
    MPIDI_CH3_Pkt_type_t type;
684
    MPIDI_CH3_Pkt_flags_t flags;
Xin Zhao's avatar
Xin Zhao committed
685 686 687 688 689 690 691 692 693 694
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
} MPIDI_CH3_Pkt_unlock_t;

typedef struct MPIDI_CH3_Pkt_flush {
    MPIDI_CH3_Pkt_type_t type;
    MPI_Win target_win_handle;
    MPI_Win source_win_handle;
} MPIDI_CH3_Pkt_flush_t;

695 696 697 698 699 700
typedef struct MPIDI_CH3_Pkt_decr_at_counter {
    MPIDI_CH3_Pkt_type_t type;
    MPI_Win target_win_handle;
} MPIDI_CH3_Pkt_decr_at_counter_t;

/*********************************************************************************/
701
/* RMA control response packet (from target to origin, including LOCK_ACK,       */
702
/* LOCK_OP_ACK, FLUSH_ACK)                                                       */
703 704
/*********************************************************************************/

705
typedef struct MPIDI_CH3_Pkt_lock_ack {
706
    MPIDI_CH3_Pkt_type_t type;
707
    MPIDI_CH3_Pkt_flags_t flags;
708
    MPI_Win source_win_handle;
709
    int target_rank;
710
} MPIDI_CH3_Pkt_lock_ack_t;
711

712 713 714 715 716 717 718
typedef struct MPIDI_CH3_Pkt_lock_op_ack {
    MPIDI_CH3_Pkt_type_t type;
    MPIDI_CH3_Pkt_flags_t flags;
    MPI_Win source_win_handle;
    int target_rank;
} MPIDI_CH3_Pkt_lock_op_ack_t;

Xin Zhao's avatar
Xin Zhao committed
719 720
typedef struct MPIDI_CH3_Pkt_flush_ack {
    MPIDI_CH3_Pkt_type_t type;
721 722
    MPI_Win source_win_handle;
    int target_rank;
Xin Zhao's avatar
Xin Zhao committed
723
} MPIDI_CH3_Pkt_flush_ack_t;
724

725
/* RMA packets end here */
726

727
typedef struct MPIDI_CH3_Pkt_close {
728 729
    MPIDI_CH3_Pkt_type_t type;
    int ack;
730
} MPIDI_CH3_Pkt_close_t;
731

732
typedef struct MPIDI_CH3_Pkt_revoke {
Wesley Bland's avatar
Wesley Bland committed
733 734
    MPIDI_CH3_Pkt_type_t type;
    MPIR_Context_id_t revoked_comm;
735
} MPIDI_CH3_Pkt_revoke_t;
Wesley Bland's avatar
Wesley Bland committed
736

737
typedef union MPIDI_CH3_Pkt {
738 739
    MPIDI_CH3_Pkt_type_t type;
    MPIDI_CH3_Pkt_eager_send_t eager_send;
740
#if defined(USE_EAGER_SHORT)
741
    MPIDI_CH3_Pkt_eagershort_send_t eagershort_send;
742
#endif                          /* defined(USE_EAGER_SHORT) */
743 744 745 746 747 748 749 750
    MPIDI_CH3_Pkt_eager_sync_send_t eager_sync_send;
    MPIDI_CH3_Pkt_eager_sync_ack_t eager_sync_ack;
    MPIDI_CH3_Pkt_eager_send_t ready_send;
    MPIDI_CH3_Pkt_rndv_req_to_send_t rndv_req_to_send;
    MPIDI_CH3_Pkt_rndv_clr_to_send_t rndv_clr_to_send;
    MPIDI_CH3_Pkt_rndv_send_t rndv_send;
    MPIDI_CH3_Pkt_cancel_send_req_t cancel_send_req;
    MPIDI_CH3_Pkt_cancel_send_resp_t cancel_send_resp;
751
    /* RMA packets start here */
752 753 754
    MPIDI_CH3_Pkt_put_t put;
    MPIDI_CH3_Pkt_get_t get;
    MPIDI_CH3_Pkt_accum_t accum;
Xin Zhao's avatar
Xin Zhao committed
755
    MPIDI_CH3_Pkt_get_accum_t get_accum;
756 757 758 759 760 761
    MPIDI_CH3_Pkt_fop_t fop;
    MPIDI_CH3_Pkt_cas_t cas;
    MPIDI_CH3_Pkt_get_resp_t get_resp;
    MPIDI_CH3_Pkt_get_accum_resp_t get_accum_resp;
    MPIDI_CH3_Pkt_fop_resp_t fop_resp;
    MPIDI_CH3_Pkt_cas_resp_t cas_resp;
762
    MPIDI_CH3_Pkt_lock_t lock;
763
    MPIDI_CH3_Pkt_unlock_t unlock;
764
    MPIDI_CH3_Pkt_flush_t flush;
765
    MPIDI_CH3_Pkt_decr_at_counter_t decr_at_cnt;
766
    MPIDI_CH3_Pkt_lock_ack_t lock_ack;
767
    MPIDI_CH3_Pkt_lock_op_ack_t lock_op_ack;
768 769
    MPIDI_CH3_Pkt_flush_ack_t flush_ack;
    /* RMA packets end here */
770
    MPIDI_CH3_Pkt_close_t close;
Wesley Bland's avatar
Wesley Bland committed
771
    MPIDI_CH3_Pkt_revoke_t revoke;
772
# if defined(MPIDI_CH3_PKT_DECL)
773
     MPIDI_CH3_PKT_DECL
774
# endif
775
} MPIDI_CH3_Pkt_t;
776 777

#if defined(MPID_USE_SEQUENCE_NUMBERS)
778
typedef struct MPIDI_CH3_Pkt_send_container {
779
    MPIDI_CH3_Pkt_send_t pkt;
780 781
    struct MPIDI_CH3_Pkt_send_container_s *next;
} MPIDI_CH3_Pkt_send_container_t;
782 783 784
#endif

#endif