root/ompi/mca/pml/base/base.h

INCLUDED FROM

   1 /* -*- Mode: C; c-basic-offset:4 ; -*- */
   2 /*
   3  * Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
   4  *                         University Research and Technology
   5  *                         Corporation.  All rights reserved.
   6  * Copyright (c) 2004-2007 The University of Tennessee and The University
   7  *                         of Tennessee Research Foundation.  All rights
   8  *                         reserved.
   9  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
  10  *                         University of Stuttgart.  All rights reserved.
  11  * Copyright (c) 2004-2005 The Regents of the University of California.
  12  *                         All rights reserved.
  13  * Copyright (c) 2013      Los Alamos National Security, LLC.  All rights reserved.
  14  * $COPYRIGHT$
  15  *
  16  * Additional copyrights may follow
  17  *
  18  * $HEADER$
  19  */
  20 
  21 #ifndef MCA_PML_BASE_H
  22 #define MCA_PML_BASE_H
  23 
  24 #include "ompi_config.h"
  25 
  26 #include "ompi/mca/mca.h"
  27 #include "opal/mca/base/mca_base_framework.h"
  28 #include "opal/class/opal_list.h"
  29 #include "opal/class/opal_pointer_array.h"
  30 
  31 #include "ompi/mca/pml/pml.h"
  32 
  33 /*
  34  * Global functions for the PML
  35  */
  36 
  37 BEGIN_C_DECLS
  38 
  39 /*
  40  * This is the base priority for a PML wrapper component
  41  * If there exists more than one then it is undefined
  42  * which one is picked.
  43  */
  44 #define PML_SELECT_WRAPPER_PRIORITY -128
  45 
  46 /*
  47  * MCA framework
  48  */
  49 OMPI_DECLSPEC extern mca_base_framework_t ompi_pml_base_framework;
  50 /*
  51  * Select an available component.
  52  */
  53 OMPI_DECLSPEC  int mca_pml_base_select(bool enable_progress_threads,
  54                                        bool enable_mpi_threads);
  55 OMPI_DECLSPEC  int mca_pml_base_progress(void);
  56     /* share in modex the name of the selected component */
  57 OMPI_DECLSPEC int mca_pml_base_pml_selected(const char *name);
  58     /* verify that all new procs are using the currently selected component */
  59 OMPI_DECLSPEC int mca_pml_base_pml_check_selected(const char *my_pml,
  60                                                   struct ompi_proc_t **procs,
  61                                                   size_t nprocs);
  62 
  63 OMPI_DECLSPEC int mca_pml_base_finalize(void);
  64 
  65 OMPI_DECLSPEC int mca_pml_base_ft_event(int state);
  66 
  67 /*
  68  * Globals
  69  */
  70 OMPI_DECLSPEC extern mca_pml_base_component_t mca_pml_base_selected_component;
  71 OMPI_DECLSPEC extern mca_pml_base_module_t mca_pml;
  72 OMPI_DECLSPEC extern opal_pointer_array_t mca_pml_base_pml;
  73 
  74 END_C_DECLS
  75 
  76 #endif /* MCA_PML_BASE_H */