/*
 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2006 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart, 
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * $COPYRIGHT$
 * 
 * Additional copyrights may follow
 * 
 * $HEADER$
 */
/**
 * @file
 */
#ifndef MCA_PML_BASE_RECV_REQUEST_H
#define MCA_PML_BASE_RECV_REQUEST_H

#include "ompi/mca/pml/base/pml_base_request.h"
#include "ompi/datatype/convertor.h"
#include "ompi/peruse/peruse-internal.h"

#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif

/**
 * Base type for receive requests.
 */
struct mca_pml_base_recv_request_t {
   mca_pml_base_request_t req_base;  /**< base request */
   ompi_convertor_t req_convertor;   /**< convertor that describes this datatype */
   size_t req_bytes_packed;          /**< size of message being received */
};
typedef struct mca_pml_base_recv_request_t mca_pml_base_recv_request_t;

OMPI_DECLSPEC OBJ_CLASS_DECLARATION(mca_pml_base_recv_request_t);

/**
 * Initialize a receive request with call parameters.
 *
 * @param request (IN)       Receive request.
 * @param addr (IN)          User buffer.
 * @param count (IN)         Number of elements of indicated datatype.
 * @param datatype (IN)      User defined datatype.
 * @param src (IN)           Source rank w/in the communicator.
 * @param tag (IN)           User defined tag.
 * @param comm (IN)          Communicator.
 * @param persistent (IN)    Is this a ersistent request.
 */
#define MCA_PML_BASE_RECV_REQUEST_INIT(                                  \
    request,                                                             \
    addr,                                                                \
    count,                                                               \
    datatype,                                                            \
    src,                                                                 \
    tag,                                                                 \
    comm,                                                                \
    persistent)                                                          \
{                                                                        \
    /* increment reference count on communicator */                      \
    OBJ_RETAIN(comm);                                                    \
    OBJ_RETAIN(datatype);                                                \
                                                                         \
    OMPI_REQUEST_INIT(&(request)->req_base.req_ompi, persistent);        \
    (request)->req_bytes_packed = 0;                                     \
    (request)->req_base.req_sequence = 0;                                \
    (request)->req_base.req_addr = addr;                                 \
    (request)->req_base.req_count = count;                               \
    (request)->req_base.req_datatype = datatype;                         \
    (request)->req_base.req_peer = src;                                  \
    (request)->req_base.req_tag = tag;                                   \
    (request)->req_base.req_comm = comm;                                 \
    (request)->req_base.req_proc = NULL;                                 \
    (request)->req_base.req_pml_complete = OPAL_INT_TO_BOOL(persistent);  \
    (request)->req_base.req_free_called = false;                         \
                                                                         \
    PERUSE_TRACE_COMM_EVENT (PERUSE_COMM_REQ_ACTIVATE,                   \
                             &((request)->req_base),                     \
                             PERUSE_RECV);                               \
}
/**
 *
 *
 */
#define MCA_PML_BASE_RECV_START( request )                                      \
    do {                                                                        \
        (request)->req_pml_complete = false;                                    \
        (request)->req_ompi.req_complete = false;                               \
        (request)->req_ompi.req_state = OMPI_REQUEST_ACTIVE;                    \
                                                                                \
        /* always set the req_status.MPI_TAG to ANY_TAG before starting the     \
         * request. This field is used if cancelled to find out if the request  \
         * has been matched or not.                                             \
         */                                                                     \
        (request)->req_ompi.req_status.MPI_TAG = OMPI_ANY_TAG;                  \
        (request)->req_ompi.req_status.MPI_ERROR = OMPI_SUCCESS;                \
        (request)->req_ompi.req_status._cancelled = 0;                          \
    } while (0)

/** 
 *  Return a receive request. Handle the release of the communicator and the
 *  attached datatype.
 *
 *  @param request (IN)     Receive request.
 */
#define MCA_PML_BASE_RECV_REQUEST_FINI( request )              \
    do {                                                       \
        OMPI_REQUEST_FINI(&(request)->req_base.req_ompi);      \
        OBJ_RELEASE( (request)->req_base.req_comm);            \
        OBJ_RELEASE( (request)->req_base.req_datatype );       \
        ompi_convertor_cleanup( &((request)->req_convertor) ); \
    } while (0)

#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
#endif