mca/prteinstalldirs/prteinstalldirs.h

0001 /* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
0002 /*
0003  * Copyright (c) 2006-2015 Los Alamos National Security, LLC.  All rights
0004  *                         reserved.
0005  * Copyright (c) 2019-2020 Intel, Inc.  All rights reserved.
0006  * Copyright (c) 2020      Cisco Systems, Inc.  All rights reserved
0007  * Copyright (c) 2021-2026 Nanook Consulting  All rights reserved.
0008  * $COPYRIGHT$
0009  *
0010  * Additional copyrights may follow
0011  *
0012  * $HEADER$
0013  */
0014
0015 #ifndef PRTE_MCA_INSTALLDIRS_INSTALLDIRS_H
0016 #define PRTE_MCA_INSTALLDIRS_INSTALLDIRS_H
0017
0018 #include "prte_config.h"
0019
0020 #include "src/pmix/pmix-internal.h"
0021 #include "src/mca/base/pmix_base.h"
0022 #include "src/mca/pinstalldirs/pinstalldirs_types.h"
0023 #include "src/mca/mca.h"
0024
0025 BEGIN_C_DECLS
0026
0027 /* Install directories.  Only available after prte_init() */
0028 PRTE_EXPORT extern pmix_pinstall_dirs_t prte_install_dirs;
0029
0030 /**
0031  * Expand out path variables (such as ${prefix}) in the input string
0032  * using the current prte_install_dirs structure */
0033 PRTE_EXPORT char *prte_install_dirs_expand(const char *input);
0034
0035 /**
0036  * Structure for prteinstalldirs components.
0037  */
0038 struct prte_prteinstalldirs_base_component_2_0_0_t {
0039     /** MCA base component */
0040     pmix_mca_base_component_t component;
0041     /** install directories provided by the given component */
0042     pmix_pinstall_dirs_t install_dirs_data;
0043 };
0044 /**
0045  * Convenience typedef
0046  */
0047 typedef struct prte_prteinstalldirs_base_component_2_0_0_t prte_prteinstalldirs_base_component_t;
0048
0049 /*
0050  * Macro for use in components that are of type prteinstalldirs
0051  */
0052 #define PRTE_INSTALLDIRS_BASE_VERSION_2_0_0 PRTE_MCA_BASE_VERSION_3_0_0("prteinstalldirs", 2, 0, 0)
0053
0054 END_C_DECLS
0055
0056 #endif /* PRTE_MCA_INSTALLDIRS_INSTALLDIRS_H */