/* * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana * University Research and Technology * Corporation. All rights reserved. * Copyright (c) 2004-2011 The University of Tennessee and The University * of Tennessee Research Foundation. All rights * reserved. * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart, * University of Stuttgart. All rights reserved. * Copyright (c) 2004-2005 The Regents of the University of California. * All rights reserved. * Copyright (c) 2011-2012 Los Alamos National Security, LLC. * All rights reserved. * Copyright (c) 2013-2017 Intel, Inc. All rights reserved. * Copyright (c) 2017 Cisco Systems, Inc. All rights reserved * $COPYRIGHT$ * * Additional copyrights may follow * * $HEADER$ */ /** @file: * * Populates global structure with process-specific information. * * */ #ifndef _ORTE_PROC_INFO_H_ #define _ORTE_PROC_INFO_H_ #include "orte_config.h" #include #ifdef HAVE_SYS_TYPES_H #include #endif #include "orte/types.h" #include "opal/dss/dss_types.h" #include "opal/mca/hwloc/hwloc-internal.h" #include "opal/util/proc.h" BEGIN_C_DECLS typedef uint32_t orte_proc_type_t; #define ORTE_PROC_TYPE_NONE 0x0000 #define ORTE_PROC_SINGLETON 0x0001 #define ORTE_PROC_DAEMON 0x0002 #define ORTE_PROC_HNP 0x0004 #define ORTE_PROC_TOOL 0x0008 #define ORTE_PROC_NON_MPI 0x0010 #define ORTE_PROC_MPI 0x0020 #define ORTE_PROC_APP 0x0030 #define ORTE_PROC_DVM 0x0102 // DVM + daemon #define ORTE_PROC_IOF_ENDPT 0x1000 #define ORTE_PROC_MASTER_ACTUAL 0x4000 #define ORTE_PROC_MASTER (ORTE_PROC_MASTER_ACTUAL + ORTE_PROC_HNP) #define ORTE_PROC_IS_SINGLETON (ORTE_PROC_SINGLETON & orte_process_info.proc_type) #define ORTE_PROC_IS_DAEMON (ORTE_PROC_DAEMON & orte_process_info.proc_type) #define ORTE_PROC_IS_HNP (ORTE_PROC_HNP & orte_process_info.proc_type) #define ORTE_PROC_IS_TOOL (ORTE_PROC_TOOL & orte_process_info.proc_type) #define ORTE_PROC_IS_NON_MPI (ORTE_PROC_NON_MPI & orte_process_info.proc_type) #define ORTE_PROC_IS_MPI (ORTE_PROC_MPI & orte_process_info.proc_type) #define ORTE_PROC_IS_APP (ORTE_PROC_APP & orte_process_info.proc_type) #define ORTE_PROC_IS_DVM (ORTE_PROC_DVM & orte_process_info.proc_type) #define ORTE_PROC_IS_IOF_ENDPT (ORTE_PROC_IOF_ENDPT & orte_process_info.proc_type) #define ORTE_PROC_IS_MASTER (ORTE_PROC_MASTER_ACTUAL & orte_process_info.proc_type) /** * Process information structure * * The orte_proc_info() function fills the pid field and obtains the * process name, storing that information in the global structure. The * structure also holds path names to the universe, job, and process * session directories, and to the stdin, stdout, and stderr temp * files - however, these are all initialized elsewhere. */ struct orte_proc_info_t { opal_proc_t super; orte_process_name_t my_name; /**< My official process name */ orte_process_name_t my_daemon; /**< Name of my local daemon */ char *my_daemon_uri; /**< Contact info to local daemon */ orte_process_name_t my_hnp; /**< Name of my hnp */ char *my_hnp_uri; /**< Contact info for my hnp */ orte_process_name_t my_parent; /**< Name of my parent (or my HNP if no parent was specified) */ pid_t hnp_pid; /**< hnp pid - used if singleton */ orte_app_idx_t app_num; /**< our index into the app_context array */ orte_vpid_t num_procs; /**< number of processes in this job */ orte_vpid_t max_procs; /**< Maximum number of processes ever in the job */ orte_vpid_t num_daemons; /**< number of daemons in system */ int num_nodes; /**< number of nodes in the job */ char *nodename; /**< string name for this node */ char **aliases; /**< aliases for this node */ pid_t pid; /**< Local process ID for this process */ orte_proc_type_t proc_type; /**< Type of process */ uint16_t my_port; /**< TCP port for out-of-band comm */ int num_restarts; /**< number of times this proc has restarted */ orte_node_rank_t my_node_rank; /**< node rank */ orte_local_rank_t my_local_rank; /**< local rank */ int32_t num_local_peers; /**< number of procs from my job that share my node with me */ /* The session directory has the form * ///, where the prefix * can either be provided by the user via the * --tmpdir command-line flag, the use of one of several * environmental variables, or else a default location. */ char *tmpdir_base; /**< Base directory of the session dir tree */ char *top_session_dir; /**< Top-most directory of the session tree */ char *jobfam_session_dir; /**< Session directory for this family of jobs (i.e., share same mpirun) */ char *job_session_dir; /**< Session directory for job */ char *proc_session_dir; /**< Session directory for the process */ bool rm_session_dirs; /**< Session directories will be cleaned up by RM */ char *sock_stdin; /**< Path name to temp file for stdin. */ char *sock_stdout; /**< Path name to temp file for stdout. */ char *sock_stderr; /**< Path name to temp file for stderr. */ char *cpuset; /**< String-representation of bitmap where we are bound */ int app_rank; /**< rank within my app_context */ orte_vpid_t my_hostid; /** identifies the local host for a coprocessor */ }; typedef struct orte_proc_info_t orte_proc_info_t; /** * * Global process info descriptor. Initialized to almost no * meaningful information - data is provided by calling \c * orte_rte_init() (which calls \c orte_proc_info() to fill in the * structure). * * The exception to this rule is the \c orte_process_info.seed field, * which will be initialized to \c false, but should be set to \c true * before calling \c orte_rte_info() if the caller is a seed daemon. */ ORTE_DECLSPEC extern orte_proc_info_t orte_process_info; /** * \internal * * Global structure to store a wide range of information about the * process. orte_proc_info populates a global variable with * information about the process being executing. This function should * be called only once, from orte_rte_init(). * * @param None. * * @retval ORTE_SUCCESS Successfully initialized the various fields. * @retval OMPI_ERROR Failed to initialize one or more fields. */ ORTE_DECLSPEC int orte_proc_info(void); ORTE_DECLSPEC int orte_proc_info_finalize(void); ORTE_DECLSPEC bool orte_ifislocal(const char *name); END_C_DECLS #endif