openmpi/src/mca/pml/pml.h

/*
 * $HEADER$
 */

#ifndef MCA_PML_H
#define MCA_PML_H

#include "lam_config.h"
#include "lam.h"
#include "lfc/lam_list.h"
#include "communicator/communicator.h"
#include "datatype/datatype.h"
#include "request/request.h"
#include "mca/mca.h"
#include "mpi.h" /* needed for MPI_ANY_TAG */


/*
 * PML module types
 */

struct mca_ptl_t;
struct mca_ptl_addr_t;


typedef enum {
    MCA_PML_BASE_SEND_STANDARD,
    MCA_PML_BASE_SEND_BUFFERED,
    MCA_PML_BASE_SEND_SYNCHRONOUS,
    MCA_PML_BASE_SEND_READY
} mca_pml_base_send_mode_t;

/* renamed MPI constants */
#define LAM_ANY_TAG    MPI_ANY_TAG
#define LAM_ANY_SOURCE MPI_ANY_SOURCE
#define LAM_PROC_NULL  MPI_PROC_NULL

/**
 * MCA->PML Called by MCA framework to initialize the module.
 * 
 * @param priority (OUT) Relative priority or ranking used by MCA to
 * selected a module.
 *
 * @param allow_multi_user_threads (OUT) Whether this module can run
 * at MPI_THREAD_MULTIPLE or not.
 *
 * @param have_hidden_threads (OUT) Whether this module may use
 * hidden threads (e.g., progress threads) or not.
 */
typedef struct mca_pml_1_0_0_t * (*mca_pml_base_module_init_fn_t)(
    int *priority, 
    bool *allow_multi_user_threads,
    bool *have_hidden_threads);

typedef int (*mca_pml_base_module_finalize_fn_t)(void);

/**
 * PML module version and interface functions.
 */

struct mca_pml_base_module_1_0_0_t {
   mca_base_module_t pmlm_version;
   mca_base_module_data_1_0_0_t pmlm_data;
   mca_pml_base_module_init_fn_t pmlm_init;
   mca_pml_base_module_finalize_fn_t pmlm_finalize;
};
typedef struct mca_pml_base_module_1_0_0_t mca_pml_base_module_1_0_0_t;
typedef mca_pml_base_module_1_0_0_t mca_pml_base_module_t;


/*
 * PML instance interface functions and datatype
 */

typedef int (*mca_pml_base_add_comm_fn_t)(struct lam_communicator_t*);
typedef int (*mca_pml_base_del_comm_fn_t)(struct lam_communicator_t*);
typedef int (*mca_pml_base_add_procs_fn_t)(struct lam_proc_t **procs, size_t nprocs);
typedef int (*mca_pml_base_del_procs_fn_t)(struct lam_proc_t **procs, size_t nprocs);
typedef int (*mca_pml_base_add_ptls_fn_t)(lam_list_t *ptls);
typedef int (*mca_pml_base_progress_fn_t)(void);

typedef int (*mca_pml_base_irecv_init_fn_t)(
    void *buf,
    size_t size,
    struct lam_datatype_t *datatype,
    int src,
    int tag,
    struct lam_communicator_t* comm,
    struct lam_request_t **request
);

typedef int (*mca_pml_base_irecv_fn_t)(
    void *buf,
    size_t size,
    struct lam_datatype_t *datatype,
    int src,
    int tag,
    struct lam_communicator_t* comm,
    struct lam_request_t **request
);

typedef int (*mca_pml_base_recv_fn_t)(
    void *buf,
    size_t size,
    struct lam_datatype_t *datatype,
    int src,
    int tag,
    struct lam_communicator_t* comm,
    lam_status_public_t* status
);

typedef int (*mca_pml_base_isend_init_fn_t)(
    void *buf,
    size_t size,
    struct lam_datatype_t *datatype,
    int dst,
    int tag,
    mca_pml_base_send_mode_t mode,
    struct lam_communicator_t* comm,
    struct lam_request_t **request
);

typedef int (*mca_pml_base_isend_fn_t)(
    void *buf,
    size_t size,
    struct lam_datatype_t *datatype,
    int dst,
    int tag,
    mca_pml_base_send_mode_t mode,
    struct lam_communicator_t* comm,
    struct lam_request_t **request
);

typedef int (*mca_pml_base_send_fn_t)(
    void *buf,
    size_t size,
    struct lam_datatype_t *datatype,
    int dst,
    int tag,
    mca_pml_base_send_mode_t mode,
    struct lam_communicator_t* comm
);

typedef int (*mca_pml_base_start_fn_t)(
    lam_request_t** request
);

typedef int (*mca_pml_base_test_fn_t)(
    lam_request_t** request,
    int *completed,
    lam_status_public_t* status
);

typedef int (*mca_pml_base_wait_fn_t)(
    int count,
    lam_request_t** request,
    int *index,
    lam_status_public_t* status
);

typedef int (*mca_pml_base_wait_all_fn_t)(
    int count,                    /* size of request/status arrays */
    lam_request_t** request,      /* array of requests */
    lam_status_public_t *status   /* array of statuses */
);

typedef int (*mca_pml_base_free_fn_t)(
    lam_request_t** request
);

typedef int (*mca_pml_base_null_fn_t)(
    lam_request_t** request
);



/**
 *  PML instance interface functions.
 */

struct mca_pml_1_0_0_t {

    /* downcalls from MCA to PML */
    mca_pml_base_add_comm_fn_t     pml_add_comm;
    mca_pml_base_del_comm_fn_t     pml_del_comm;
    mca_pml_base_add_procs_fn_t    pml_add_procs;
    mca_pml_base_del_procs_fn_t    pml_del_procs;
    mca_pml_base_add_ptls_fn_t     pml_add_ptls;
    mca_pml_base_progress_fn_t     pml_progress;

    /* downcalls from MPI to PML */
    mca_pml_base_irecv_init_fn_t   pml_irecv_init;
    mca_pml_base_irecv_fn_t        pml_irecv;
    mca_pml_base_recv_fn_t         pml_recv;
    mca_pml_base_isend_init_fn_t   pml_isend_init;
    mca_pml_base_isend_fn_t        pml_isend;
    mca_pml_base_send_fn_t         pml_send;
    mca_pml_base_start_fn_t        pml_start;
    mca_pml_base_test_fn_t         pml_test;
    mca_pml_base_wait_fn_t         pml_wait;
    mca_pml_base_wait_all_fn_t     pml_wait_all;
    mca_pml_base_free_fn_t         pml_free;
    mca_pml_base_null_fn_t         pml_null;
};
typedef struct mca_pml_1_0_0_t mca_pml_1_0_0_t;
typedef mca_pml_1_0_0_t mca_pml_t;
extern mca_pml_t mca_pml;

/*
 * Macro for use in modules that are of type pml v1.0.0
 */
#define MCA_PML_BASE_VERSION_1_0_0 \
  /* pml v1.0 is chained to MCA v1.0 */ \
  MCA_BASE_VERSION_1_0_0, \
  /* pml v1.0 */ \
  "pml", 1, 0, 0

#endif /* MCA_PML_H */