ess/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-2006 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-2020 Cisco Systems, Inc.  All rights reserved
0013  * Copyright (c) 2012      Oak Ridge National Labs.  All rights reserved.
0014  * Copyright (c) 2013      Los Alamos National Security, LLC.  All rights reserved.
0015  * Copyright (c) 2013-2020 Intel, Inc.  All rights reserved.
0016  * Copyright (c) 2019      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_ESS_BASE_H
0029 #define MCA_ESS_BASE_H
0030
0031 #include "prte_config.h"
0032 #include "types.h"
0033
0034 #include "src/mca/base/pmix_mca_base_framework.h"
0035 #include "src/mca/mca.h"
0036 #include "src/pmix/pmix-internal.h"
0037
0038 #include "src/mca/ess/ess.h"
0039
0040 BEGIN_C_DECLS
0041
0042 /*
0043  * MCA Framework
0044  */
0045 PRTE_EXPORT extern pmix_mca_base_framework_t prte_ess_base_framework;
0046 /**
0047  * Select a ess module
0048  */
0049 PRTE_EXPORT int prte_ess_base_select(void);
0050
0051 /*
0052  * stdout/stderr buffering control parameter
0053  */
0054 PRTE_EXPORT extern int prte_ess_base_std_buffering;
0055
0056 PRTE_EXPORT extern int prte_ess_base_num_procs;
0057 PRTE_EXPORT extern char *prte_ess_base_nspace;
0058 PRTE_EXPORT extern char *prte_ess_base_vpid;
0059 PRTE_EXPORT extern pmix_list_t prte_ess_base_signals;
0060
0061 /*
0062  * Internal helper functions used by components
0063  */
0064 PRTE_EXPORT int prte_ess_env_get(void);
0065
0066 PRTE_EXPORT int prte_ess_base_std_prolog(void);
0067
0068 PRTE_EXPORT int prte_ess_base_prted_setup(void);
0069 PRTE_EXPORT int prte_ess_base_prted_finalize(void);
0070
0071 PRTE_EXPORT int prte_ess_base_setup_signals(char *signals);
0072
0073 /* Detect whether or not this proc is bound - if not,
0074  * see if it should bind itself
0075  */
0076 PRTE_EXPORT int prte_ess_base_proc_binding(void);
0077
0078 /*
0079  * Put functions
0080  */
0081 PRTE_EXPORT int prte_ess_env_put(int32_t num_procs, int32_t num_local_procs, char ***env);
0082
0083 /* read a bootstrap configuration file */
0084 PRTE_EXPORT int prte_ess_base_bootstrap(void);
0085
0086 typedef struct {
0087     pmix_list_item_t super;
0088     char *signame;
0089     int signal;
0090     bool can_forward;
0091 } prte_ess_base_signal_t;
0092 PMIX_CLASS_DECLARATION(prte_ess_base_signal_t);
0093
0094 END_C_DECLS
0095
0096 #endif