/*
 * Copyright (c) 2004-2005 The Trustees of Indiana University.
 *                         All rights reserved.
 * Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
 *                         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 OMPI_PML_TEG_RECV_REQUEST_H
#define OMPI_PML_TEG_RECV_REQUEST_H

#include "pml_teg.h"
#include "pml_teg_proc.h"
#include "mca/ptl/base/ptl_base_recvreq.h"
#include "mca/ptl/base/ptl_base_recvfrag.h"

#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
typedef mca_ptl_base_recv_request_t mca_pml_teg_recv_request_t;

OBJ_CLASS_DECLARATION(mca_pml_teg_recv_request_t);


/**
 *  Allocate a recv request from the modules free list.
 *
 *  @param rc (OUT)  OMPI_SUCCESS or error status on failure.
 *  @return          Receive request.
 */
#define MCA_PML_TEG_RECV_REQUEST_ALLOC(recvreq, rc)                   \
    do {                                                              \
        opal_list_item_t* item;                                       \
        OMPI_FREE_LIST_GET(&mca_pml_teg.teg_recv_requests, item, rc); \
        recvreq = (mca_ptl_base_recv_request_t*)item;                 \
    } while(0)
        

/**
 *  Initialize a recv request.
 */
#define MCA_PML_TEG_RECV_REQUEST_INIT(                                \
    request,                                                          \
    addr,                                                             \
    count,                                                            \
    datatype,                                                         \
    src,                                                              \
    tag,                                                              \
    comm,                                                             \
    persistent)                                                       \
{                                                                     \
    MCA_PML_BASE_RECV_REQUEST_INIT(                                   \
        (&(request)->req_recv),                                       \
        addr,                                                         \
        count,                                                        \
        datatype,                                                     \
        src,                                                          \
        tag,                                                          \
        comm,                                                         \
        persistent                                                    \
    );                                                                \
}


/**
 *  Return a recv request to the modules free list.
 *
 *  @param request (IN)  Receive request.
 */
#define MCA_PML_TEG_RECV_REQUEST_RETURN(request)                                           \
    do {                                                                                   \
        MCA_PML_BASE_RECV_REQUEST_FINI( &request->req_recv );                              \
        OMPI_FREE_LIST_RETURN(&mca_pml_teg.teg_recv_requests, (opal_list_item_t*)request); \
    } while(0)

/**
 * Attempt to match the request against the unexpected fragment list
 * for all source ranks w/in the communicator.
 *
 * @param request (IN)   Request to match.
 */
void mca_pml_teg_recv_request_match_wild(mca_ptl_base_recv_request_t* request);
                                                                                                                                 
/**
 * Attempt to match the request against the unexpected fragment list
 * for a specific source rank.
 *
 * @param request (IN)   Request to match.
 */
void mca_pml_teg_recv_request_match_specific(mca_ptl_base_recv_request_t* request);
                                                                                                                                 
/**
 * Start an initialized request.
 *
 * @param request  Receive request.
 * @return         OMPI_SUCESS or error status on failure.
 */
static inline int mca_pml_teg_recv_request_start(mca_ptl_base_recv_request_t* request)
{
    /* init/re-init the request */
    request->req_bytes_received = 0;
    request->req_bytes_delivered = 0;
    request->req_recv.req_base.req_pml_complete = false;
    request->req_recv.req_base.req_ompi.req_complete = false;
    request->req_recv.req_base.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 on the cancel part in order to find out if the request has been matched or not.
     */
    request->req_recv.req_base.req_ompi.req_status.MPI_TAG = OMPI_ANY_TAG;
    request->req_recv.req_base.req_ompi.req_status.MPI_ERROR = OMPI_SUCCESS;
    request->req_recv.req_base.req_ompi.req_status._cancelled = 0;

    /* attempt to match posted recv */
    if(request->req_recv.req_base.req_peer == OMPI_ANY_SOURCE) {
        mca_pml_teg_recv_request_match_wild(request);
    } else {
        mca_pml_teg_recv_request_match_specific(request);
    }
    return OMPI_SUCCESS;
}

/**
 *  Update status of a recv request based on the completion status of 
 *  the receive fragment.
 *
 *  @param ptl (IN)              The PTL pointer.
 *  @param request (IN)          Receive request.
 *  @param bytes_received (IN)   Bytes received from peer.
 *  @param bytes_delivered (IN)  Bytes delivered to application.
 */
void mca_pml_teg_recv_request_progress(
    struct mca_ptl_base_module_t* ptl,
    mca_ptl_base_recv_request_t* request,
    size_t bytes_received,
    size_t bytes_delivered
);

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