mca/odls/odls.h

0001 /* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
0002 /*
0003  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
0004  *                         University Research and Technology
0005  *                         Corporation.  All rights reserved.
0006  * Copyright (c) 2004-2005 The University of Tennessee and The University
0007  *                         of Tennessee Research Foundation.  All rights
0008  *                         reserved.
0009  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
0010  *                         University of Stuttgart.  All rights reserved.
0011  * Copyright (c) 2004-2005 The Regents of the University of California.
0012  *                         All rights reserved.
0013  * Copyright (c) 2011-2015 Los Alamos National Security, LLC. All rights
0014  *                         reserved.
0015  * Copyright (c) 2016-2020 Intel, Inc.  All rights reserved.
0016  * Copyright (c) 2020      Cisco Systems, Inc.  All rights reserved
0017  * Copyright (c) 2021-2022 Nanook Consulting.  All rights reserved.
0018  * $COPYRIGHT$
0019  *
0020  * Additional copyrights may follow
0021  *
0022  * $HEADER$
0023  */
0024 /**
0025  * @file
0026  *
0027  * The PRTE Daemon's Local Launch Subsystem
0028  *
0029  */
0030
0031 #ifndef PRTE_MCA_ODLS_H
0032 #define PRTE_MCA_ODLS_H
0033
0034 #include "prte_config.h"
0035 #include "types.h"
0036
0037 #include "src/class/pmix_pointer_array.h"
0038 #include "src/mca/mca.h"
0039 #include "src/pmix/pmix-internal.h"
0040 #include "src/rml/rml_types.h"
0041 #include "src/pmix/pmix-internal.h"
0042 #include "src/runtime/prte_globals.h"
0043
0044 #include "src/mca/odls/odls_types.h"
0045
0046 BEGIN_C_DECLS
0047
0048 /*
0049  * odls module functions
0050  */
0051
0052 /*
0053  * Construct a buffer for use in adding local processes
0054  * In order to reuse daemons, we need a way for the HNP to construct a buffer that
0055  * contains the data needed by the active ODLS component to launch a local process. Since the
0056  * only one that knows what a particular ODLS component needs is that component, we require an
0057  * entry point that the HNP can call to get the required buffer. This is constructed
0058  * for *all* nodes - the individual orteds then parse that data to find the specific launch info
0059  * for procs on their node
0060  */
0061 typedef int (*prte_odls_base_module_get_add_procs_data_fn_t)(pmix_data_buffer_t *data,
0062                                                              pmix_nspace_t job);
0063
0064 /**
0065  * Locally launch the provided processes
0066  */
0067 typedef int (*prte_odls_base_module_launch_local_processes_fn_t)(pmix_data_buffer_t *data);
0068
0069 /**
0070  * Kill the local processes on this node
0071  */
0072 typedef int (*prte_odls_base_module_kill_local_processes_fn_t)(pmix_pointer_array_t *procs);
0073
0074 /**
0075  * Signal local processes
0076  */
0077 typedef int (*prte_odls_base_module_signal_local_process_fn_t)(const pmix_proc_t *proc,
0078                                                                int32_t signal);
0079
0080 /**
0081  * Restart a local process
0082  */
0083 typedef int (*prte_odls_base_module_restart_proc_fn_t)(prte_proc_t *child);
0084
0085 /**
0086  * pls module version
0087  */
0088 struct prte_odls_base_module_1_3_0_t {
0089     prte_odls_base_module_get_add_procs_data_fn_t get_add_procs_data;
0090     prte_odls_base_module_launch_local_processes_fn_t launch_local_procs;
0091     prte_odls_base_module_kill_local_processes_fn_t kill_local_procs;
0092     prte_odls_base_module_signal_local_process_fn_t signal_local_procs;
0093     prte_odls_base_module_restart_proc_fn_t restart_proc;
0094 };
0095
0096 /** shprten prte_odls_base_module_1_3_0_t declaration */
0097 typedef struct prte_odls_base_module_1_3_0_t prte_odls_base_module_1_3_0_t;
0098 /** shprten prte_odls_base_module_t declaration */
0099 typedef struct prte_odls_base_module_1_3_0_t prte_odls_base_module_t;
0100
0101 /**
0102  * odls component
0103  */
0104 typedef pmix_mca_base_component_t prte_odls_base_component_t;
0105
0106 /**
0107  * Macro for use in modules that are of type odls
0108  */
0109 #define PRTE_ODLS_BASE_VERSION_2_0_0 PRTE_MCA_BASE_VERSION_3_0_0("odls", 2, 0, 0)
0110
0111 /* Global structure for accessing ODLS functions
0112  */
0113 PRTE_EXPORT extern prte_odls_base_module_t
0114     prte_odls; /* holds selected module's function pointers */
0115
0116 END_C_DECLS
0117
0118 #endif /* MCA_ODLS_H */