mca/pstat/pstat.h

0001 /* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
0002 /*
0003  * Copyright (c) 2004-2007 High Performance Computing Center Stuttgart,
0004  *                         University of Stuttgart.  All rights reserved.
0005  * Copyright (c) 2004-2008 The Trustees of Indiana University.
0006  *                         All rights reserved.
0007  * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
0008  *                         reserved.
0009  *
0010  * Copyright (c) 2019      Intel, Inc.  All rights reserved.
0011  * Copyright (c) 2020      Cisco Systems, Inc.  All rights reserved
0012  * Copyright (c) 2021-2025 Nanook Consulting  All rights reserved.
0013  * $COPYRIGHT$
0014  *
0015  * Additional copyrights may follow
0016  *
0017  * $HEADER$
0018  */
0019
0020 /**
0021  * @file
0022  *
0023  * pstat (process statistics) framework component interface.
0024  *
0025  * Intent
0026  *
0027  * To support the ompi-top utility.
0028  *
0029  */
0030
0031 #ifndef PMIX_MCA_PSTAT_H
0032 #define PMIX_MCA_PSTAT_H
0033
0034 #include "pmix_config.h"
0035 #include "pmix_common.h"
0036
0037 #include "src/mca/base/pmix_base.h"
0038 #include "src/mca/mca.h"
0039
0040 BEGIN_C_DECLS
0041
0042 /**
0043  * Module initialization function.  Should return PMIX_SUCCESS.
0044  */
0045 typedef pmix_status_t (*pmix_pstat_base_module_init_fn_t)(void);
0046
0047 typedef pmix_status_t (*pmix_pstat_base_module_query_fn_t)(pmix_proc_t *requestor,
0048                                                            const pmix_info_t *monitor, pmix_status_t error,
0049                                                            const pmix_info_t directives[], size_t ndirs,
0050                                                            pmix_info_t **results, size_t *nresults);
0051
0052 typedef pmix_status_t (*pmix_pstat_base_module_fini_fn_t)(void);
0053
0054 /**
0055  * Structure for pstat components.
0056  */
0057 typedef pmix_mca_base_component_t pmix_pstat_base_component_t;
0058
0059 /**
0060  * Structure for pstat modules
0061  */
0062 struct pmix_pstat_base_module_1_0_0_t {
0063     pmix_pstat_base_module_init_fn_t init;
0064     pmix_pstat_base_module_query_fn_t query;
0065     pmix_pstat_base_module_fini_fn_t finalize;
0066 };
0067
0068 /**
0069  * Convenience typedef
0070  */
0071 typedef struct pmix_pstat_base_module_1_0_0_t pmix_pstat_base_module_1_0_0_t;
0072 typedef struct pmix_pstat_base_module_1_0_0_t pmix_pstat_base_module_t;
0073
0074 /**
0075  * Macro for use in components that are of type pstat
0076  */
0077 #define PMIX_PSTAT_BASE_VERSION_1_0_0 PMIX_MCA_BASE_VERSION_1_0_0("pstat", 1, 0, 0)
0078
0079 /* Global structure for accessing pstat functions */
0080 PMIX_EXPORT extern pmix_pstat_base_module_t pmix_pstat;
0081
0082 END_C_DECLS
0083
0084 #endif /* PMIX_MCA_PSTAT_H */