/* * Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana * University Research and Technology * Corporation. All rights reserved. * Copyright (c) 2004-2009 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_BTL_TEMPLATE_H #define MCA_BTL_TEMPLATE_H #include "opal_config.h" #include #include /* Open MPI includes */ #include "opal/mca/event/event.h" #include "opal/class/ompi_free_list.h" #include "opal/mca/btl/btl.h" #include "opal/mca/btl/base/base.h" #include "opal/mca/mpool/mpool.h" BEGIN_C_DECLS #define MCA_BTL_HAS_MPOOL 1 /** * Infiniband (TEMPLATE) BTL component. */ struct mca_btl_template_component_t { mca_btl_base_component_2_0_0_t super; /**< base BTL component */ uint32_t template_num_btls; /**< number of hcas available to the TEMPLATE component */ struct mca_btl_template_module_t *template_btls; /**< array of available BTL modules */ int template_free_list_num; /**< initial size of free lists */ int template_free_list_max; /**< maximum size of free lists */ int template_free_list_inc; /**< number of elements to alloc when growing free lists */ opal_list_t template_procs; /**< list of template proc structures */ opal_mutex_t template_lock; /**< lock for accessing module state */ char* template_mpool_name; /**< name of memory pool */ bool leave_pinned; /**< pin memory on first use and leave pinned */ }; typedef struct mca_btl_template_component_t mca_btl_template_component_t; OPAL_MODULE_DECLSPEC extern mca_btl_template_component_t mca_btl_template_component; /** * BTL Module Interface */ struct mca_btl_template_module_t { mca_btl_base_module_t super; /**< base BTL interface */ /* free list of fragment descriptors */ ompi_free_list_t template_frag_eager; ompi_free_list_t template_frag_max; ompi_free_list_t template_frag_user; /* lock for accessing module state */ opal_mutex_t template_lock; #if MCA_BTL_HAS_MPOOL struct mca_mpool_base_module_t* template_mpool; #endif }; typedef struct mca_btl_template_module_t mca_btl_template_module_t; extern mca_btl_template_module_t mca_btl_template_module; /** * TEMPLATE component initialization. * * @param num_btl_modules (OUT) Number of BTLs returned in BTL array. * @param allow_multi_user_threads (OUT) Flag indicating wether BTL supports user threads (TRUE) * @param have_hidden_threads (OUT) Flag indicating wether BTL uses threads (TRUE) */ extern mca_btl_base_module_t** mca_btl_template_component_init( int *num_btl_modules, bool allow_multi_user_threads, bool have_hidden_threads ); /** * TEMPLATE component progress. */ extern int mca_btl_template_component_progress(void); /** * Cleanup any resources held by the BTL. * * @param btl BTL instance. * @return OPAL_SUCCESS or error status on failure. */ extern int mca_btl_template_finalize( struct mca_btl_base_module_t* btl ); /** * PML->BTL notification of change in the process list. * * @param btl (IN) * @param nprocs (IN) Number of processes * @param procs (IN) Set of processes * @param peers (OUT) Set of (optional) peer addressing info. * @param peers (IN/OUT) Set of processes that are reachable via this BTL. * @return OPAL_SUCCESS or error status on failure. * */ extern int mca_btl_template_add_procs( struct mca_btl_base_module_t* btl, size_t nprocs, struct opal_proc_t **procs, struct mca_btl_base_endpoint_t** peers, opal_bitmap_t* reachable ); /** * PML->BTL notification of change in the process list. * * @param btl (IN) BTL instance * @param nproc (IN) Number of processes. * @param procs (IN) Set of processes. * @param peers (IN) Set of peer data structures. * @return Status indicating if cleanup was successful * */ extern int mca_btl_template_del_procs( struct mca_btl_base_module_t* btl, size_t nprocs, struct opal_proc_t **procs, struct mca_btl_base_endpoint_t** peers ); /** * Initiate an asynchronous send. * * @param btl (IN) BTL module * @param endpoint (IN) BTL addressing information * @param descriptor (IN) Description of the data to be transfered * @param tag (IN) The tag value used to notify the peer. */ extern int mca_btl_template_send( struct mca_btl_base_module_t* btl, struct mca_btl_base_endpoint_t* btl_peer, struct mca_btl_base_descriptor_t* descriptor, mca_btl_base_tag_t tag ); /** * Initiate an asynchronous put. * * @param btl (IN) BTL module * @param endpoint (IN) BTL addressing information * @param descriptor (IN) Description of the data to be transferred */ extern int mca_btl_template_put( struct mca_btl_base_module_t* btl, struct mca_btl_base_endpoint_t* btl_peer, struct mca_btl_base_descriptor_t* decriptor ); /** * Initiate an asynchronous get. * * @param btl (IN) BTL module * @param endpoint (IN) BTL addressing information * @param descriptor (IN) Description of the data to be transferred */ extern int mca_btl_template_get( struct mca_btl_base_module_t* btl, struct mca_btl_base_endpoint_t* btl_peer, struct mca_btl_base_descriptor_t* decriptor ); /** * Register a callback function that is called on receipt * of a fragment. * * @param btl (IN) BTL module * @return Status indicating if registration was successful * */ extern int mca_btl_template_register( struct mca_btl_base_module_t* btl, mca_btl_base_tag_t tag, mca_btl_base_module_recv_cb_fn_t cbfunc, void* cbdata); /** * Allocate a descriptor with a segment of the requested size. * Note that the BTL layer may choose to return a smaller size * if it cannot support the request. * * @param btl (IN) BTL module * @param size (IN) Request segment size. */ extern mca_btl_base_descriptor_t* mca_btl_template_alloc( struct mca_btl_base_module_t* btl, struct mca_btl_base_endpoint_t* endpoint, uint8_t order, size_t size, uint32_t flags); /** * Return a segment allocated by this BTL. * * @param btl (IN) BTL module * @param descriptor (IN) Allocated descriptor. */ extern int mca_btl_template_free( struct mca_btl_base_module_t* btl, mca_btl_base_descriptor_t* des); /** * Prepare a descriptor for send/rdma using the supplied * convertor. If the convertor references data that is contigous, * the descriptor may simply point to the user buffer. Otherwise, * this routine is responsible for allocating buffer space and * packing if required. * * @param btl (IN) BTL module * @param endpoint (IN) BTL peer addressing * @param convertor (IN) Data type convertor * @param reserve (IN) Additional bytes requested by upper layer to precede user data * @param size (IN/OUT) Number of bytes to prepare (IN), number of bytes actually prepared (OUT) */ mca_btl_base_descriptor_t* mca_btl_template_prepare_src( struct mca_btl_base_module_t* btl, struct mca_btl_base_endpoint_t* peer, struct mca_mpool_base_registration_t*, struct opal_convertor_t* convertor, uint8_t order, size_t reserve, size_t* size, uint32_t flags ); extern mca_btl_base_descriptor_t* mca_btl_template_prepare_dst( struct mca_btl_base_module_t* btl, struct mca_btl_base_endpoint_t* peer, struct mca_mpool_base_registration_t*, struct opal_convertor_t* convertor, uint8_t order, size_t reserve, size_t* size, uint32_t flags); /** * Fault Tolerance Event Notification Function * @param state Checkpoint Stae * @return OPAL_SUCCESS or failure status */ int mca_btl_template_ft_event(int state); END_C_DECLS #endif