root/opal/mca/pstat/base/base.h

INCLUDED FROM

   1 /*
   2  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
   3  *                         University Research and Technology
   4  *                         Corporation.  All rights reserved.
   5  * Copyright (c) 2004-2006 The University of Tennessee and The University
   6  *                         of Tennessee Research Foundation.  All rights
   7  *                         reserved.
   8  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
   9  *                         University of Stuttgart.  All rights reserved.
  10  * Copyright (c) 2004-2005 The Regents of the University of California.
  11  *                         All rights reserved.
  12  * Copyright (c) 2007      Cisco Systems, Inc.  All rights reserved.
  13  * $COPYRIGHT$
  14  *
  15  * Additional copyrights may follow
  16  *
  17  * $HEADER$
  18  *
  19  */
  20 
  21 #ifndef OPAL_PSTAT_BASE_H
  22 #define OPAL_PSTAT_BASE_H
  23 
  24 #include "opal_config.h"
  25 #include "opal/mca/base/mca_base_framework.h"
  26 #include "opal/mca/pstat/pstat.h"
  27 
  28 /*
  29  * Global functions for MCA overall pstat open and close
  30  */
  31 
  32 BEGIN_C_DECLS
  33 
  34 /**
  35  * Framework structure declaration for this framework
  36  */
  37 OPAL_DECLSPEC extern mca_base_framework_t opal_pstat_base_framework;
  38 
  39 /**
  40  * Select an available component.
  41  *
  42  * @return OPAL_SUCCESS Upon success.
  43  * @return OPAL_NOT_FOUND If no component can be selected.
  44  * @return OPAL_ERROR Upon other failure.
  45  *
  46  * At the end of this process, we'll either have a single
  47  * component that is selected and initialized, or no component was
  48  * selected.  If no component was selected, subsequent invocation
  49  * of the pstat functions will return an error indicating no data
  50  * could be obtained
  51  */
  52 OPAL_DECLSPEC int opal_pstat_base_select(void);
  53 
  54 OPAL_DECLSPEC extern opal_pstat_base_component_t *opal_pstat_base_component;
  55 
  56 END_C_DECLS
  57 
  58 #endif /* OPAL_BASE_PSTAT_H */