grpcomm/base/base.h

0001 /*
0002  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
0003  *                         University Research and Technology
0004  *                         Corporation.  All rights reserved.
0005  * Copyright (c) 2004-2005 The University of Tennessee and The University
0006  *                         of Tennessee Research Foundation.  All rights
0007  *                         reserved.
0008  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
0009  *                         University of Stuttgart.  All rights reserved.
0010  * Copyright (c) 2004-2005 The Regents of the University of California.
0011  *                         All rights reserved.
0012  * Copyright (c) 2011-2013 Los Alamos National Security, LLC.
0013  *                         All rights reserved.
0014  * Copyright (c) 2013-2019 Intel, Inc.  All rights reserved.
0015  * Copyright (c) 2017-2020 Cisco Systems, Inc.  All rights reserved
0016  * Copyright (c) 2018      Research Organization for Information Science
0017  *                         and Technology (RIST).  All rights reserved.
0018  * Copyright (c) 2021-2023 Nanook Consulting  All rights reserved.
0019  * $COPYRIGHT$
0020  *
0021  * Additional copyrights may follow
0022  *
0023  * $HEADER$
0024  */
0025 /** @file:
0026  */
0027
0028 #ifndef MCA_GRPCOMM_BASE_H
0029 #define MCA_GRPCOMM_BASE_H
0030
0031 /*
0032  * includes
0033  */
0034 #include "prte_config.h"
0035
0036 #include "src/class/pmix_hash_table.h"
0037 #include "src/class/pmix_list.h"
0038 #include "src/hwloc/hwloc-internal.h"
0039 #include "src/mca/base/pmix_mca_base_framework.h"
0040 #include "src/mca/grpcomm/grpcomm.h"
0041 #include "src/mca/mca.h"
0042 #include "src/mca/odls/odls_types.h"
0043 #include "src/rml/rml_types.h"
0044 #include "src/pmix/pmix-internal.h"
0045
0046 /*
0047  * Global functions for MCA overall collective open and close
0048  */
0049 BEGIN_C_DECLS
0050
0051 /*
0052  * MCA framework
0053  */
0054 PRTE_EXPORT extern pmix_mca_base_framework_t prte_grpcomm_base_framework;
0055 /*
0056  * Select an available component.
0057  */
0058 PRTE_EXPORT int prte_grpcomm_base_select(void);
0059
0060 /*
0061  * globals that might be needed
0062  */
0063 typedef struct {
0064     pmix_list_item_t super;
0065     int pri;
0066     prte_grpcomm_base_module_t *module;
0067     pmix_mca_base_component_t *component;
0068 } prte_grpcomm_base_active_t;
0069 PMIX_CLASS_DECLARATION(prte_grpcomm_base_active_t);
0070
0071 typedef struct {
0072     pmix_list_t actives;
0073     pmix_list_t ongoing;
0074     pmix_hash_table_t sig_table;
0075     char *transports;
0076     uint32_t context_id;
0077 } prte_grpcomm_base_t;
0078
0079 PRTE_EXPORT extern prte_grpcomm_base_t prte_grpcomm_base;
0080
0081 /* Public API stubs */
0082 PRTE_EXPORT int prte_grpcomm_API_xcast(prte_grpcomm_signature_t *sig, prte_rml_tag_t tag,
0083                                        pmix_data_buffer_t *buf);
0084
0085 PRTE_EXPORT int prte_grpcomm_API_allgather(prte_pmix_mdx_caddy_t *cd);
0086
0087 PRTE_EXPORT prte_grpcomm_coll_t *prte_grpcomm_base_get_tracker(prte_grpcomm_signature_t *sig,
0088                                                                bool create);
0089
0090 PRTE_EXPORT int prte_pack_ctrl_options(pmix_byte_object_t *bo,
0091                                        const pmix_info_t *info, size_t ninfo);
0092
0093 END_C_DECLS
0094 #endif