309 строки
9.8 KiB
C
309 строки
9.8 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
|
|
* University Research and Technology
|
|
* Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2006 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) 2007-2010 Cisco Systems, Inc. All rights reserved.
|
|
* Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
|
|
#ifndef OPAL_PAFFINITY_BASE_H
|
|
#define OPAL_PAFFINITY_BASE_H
|
|
|
|
#include "opal_config.h"
|
|
|
|
#include "opal/mca/paffinity/paffinity.h"
|
|
|
|
/*
|
|
* Global functions for MCA overall paffinity open and close
|
|
*/
|
|
|
|
BEGIN_C_DECLS
|
|
|
|
/**
|
|
* Register MCA params for the paffinity base.
|
|
*
|
|
* @retval OPAL_SUCCESS Upon success
|
|
*
|
|
* This function is invoked by opal_register_params(). It registers
|
|
* some paffinity-wide MCA parameters.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_register_params(void);
|
|
|
|
/**
|
|
* Initialize the paffinity MCA framework
|
|
*
|
|
* @retval OPAL_SUCCESS Upon success
|
|
* @retval OPAL_ERROR Upon failure
|
|
*
|
|
* This must be the first function invoked in the paffinity MCA
|
|
* framework. It initializes the paffinity MCA framework, finds
|
|
* and opens paffinity components, etc.
|
|
*
|
|
* This function is invoked during opal_init().
|
|
*
|
|
* This function fills in the internal global variable
|
|
* opal_paffinity_base_components_opened, which is a list of all
|
|
* paffinity components that were successfully opened. This
|
|
* variable should \em only be used by other paffinity base
|
|
* functions -- it is not considered a public interface member --
|
|
* and is only mentioned here for completeness.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_open(void);
|
|
|
|
/**
|
|
* Select an available component.
|
|
*
|
|
* @return OPAL_SUCCESS Upon success.
|
|
* @return OPAL_NOT_FOUND If no component can be selected.
|
|
* @return OPAL_ERROR Upon other failure.
|
|
*
|
|
* This function invokes the selection process for paffinity components,
|
|
* which works as follows:
|
|
*
|
|
* - If the \em paffinity MCA parameter is not specified, the
|
|
* selection set is all available paffinity components.
|
|
* - If the \em paffinity MCA parameter is specified, the
|
|
* selection set is just that component.
|
|
* - All components in the selection set are queried to see if
|
|
* they want to run. All components that want to run are ranked
|
|
* by their priority and the highest priority component is
|
|
* selected. All non-selected components have their "close"
|
|
* function invoked to let them know that they were not selected.
|
|
* - The selected component will have its "init" function invoked to
|
|
* let it know that it was selected.
|
|
*
|
|
* If we fall through this entire process and no component is
|
|
* selected, then return OPAL_NOT_FOUND (this is not a fatal
|
|
* error).
|
|
*
|
|
* At the end of this process, we'll either have a single
|
|
* component that is selected and initialized, or no component was
|
|
* selected. If no component was selected, subsequent invocation
|
|
* of the paffinity wrapper functions will return an error.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_select(void);
|
|
|
|
/**
|
|
* Set this process' affinity.
|
|
*
|
|
* @param cpumask PHYSICAL processor bitmask
|
|
*
|
|
* @retval OPAL_SUCCESS upon success
|
|
* @retval OPAL_NOT_FOUND if no paffinity components are available.
|
|
* @retval OPAL_ERROR upon other error.
|
|
*
|
|
* Set this process' affinity to the PHYSICAL CPU's specified in \em cpumask
|
|
*
|
|
* If no paffinity components were available, or if the
|
|
* opal_paffinity_base_select() was never invoked, OPAL_NOT_FOUND
|
|
* is returned.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_set(opal_paffinity_base_cpu_set_t cpumask);
|
|
|
|
/**
|
|
* Get this process' affinity.
|
|
*
|
|
* @param cpumask Pointer to PHYSICAL processor bitmask
|
|
*
|
|
* @retval OPAL_SUCCESS upon success
|
|
* @retval OPAL_NOT_FOUND if no paffinity components are available.
|
|
* @retval OPAL_ERROR upon other error.
|
|
*
|
|
* Get this process' CPU affinity PHYSICAL bitmask and assign
|
|
* it to \em cpumask.
|
|
*
|
|
* If no paffinity components were available, or if the
|
|
* opal_paffinity_base_select() was never invoked, OPAL_NOT_FOUND
|
|
* is returned and cpumask is zeroed out.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get(opal_paffinity_base_cpu_set_t *cpumask);
|
|
|
|
/**
|
|
* Shut down the paffinity MCA framework.
|
|
*
|
|
* @retval OPAL_SUCCESS Always
|
|
*
|
|
* This function shuts down everything in the paffinity MCA
|
|
* framework, and is called during opal_finalize().
|
|
*
|
|
* It must be the last function invoked on the paffinity MCA
|
|
* framework.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_close(void);
|
|
|
|
/**
|
|
* Returns mapping of PHYSICAL socket:core -> PHYSICAL processor id.
|
|
*
|
|
* @param physical_socket
|
|
* @param pyshical_core
|
|
* @param physical_processor_id
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_NOT_SUPPORTED if not
|
|
* supported
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_map_to_processor_id(int physical_socket, int physical_core, int *physical_processor_id);
|
|
|
|
/**
|
|
* Provides mapping of PHYSICAL processor id -> PHYSICAL socket:core.
|
|
*
|
|
* @param physical_processor_id
|
|
* @param physical_socket
|
|
* @param physical_core
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_NOT_SUPPORTED if not
|
|
* supported
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_map_to_socket_core(int physical_processor_id, int *physical_socket, int *physical_core);
|
|
|
|
/**
|
|
* Return the number of LOGICAL processors
|
|
*
|
|
* @param num_logical_processors
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_NOT_SUPPORTED if not
|
|
* supported
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_processor_info(int *num_logical_processors);
|
|
|
|
/**
|
|
* Return the number of LOGICAL sockets
|
|
*
|
|
* @param num_logical_sockets
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_NOT_SUPPORTED if not
|
|
* supported
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_socket_info(int *num_logical_sockets);
|
|
|
|
/**
|
|
* Return the number of LOGICAL cores for a given PHYSICAL socket
|
|
*
|
|
* @param physical_socket
|
|
* @param num_logical_cores
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_NOT_SUPPORTED if not
|
|
* supported
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_core_info(int physical_socket, int *num_logical_cores);
|
|
|
|
/**
|
|
* Return the PHYSICAL processor id that corresponds to the
|
|
* given LOGICAL processor id
|
|
*
|
|
* @param logical_processor_id
|
|
* @param physical_processor_id
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_*
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_physical_processor_id(int logical_processor_id, int *physical_processor_id);
|
|
|
|
/**
|
|
* Return the PHYSICAL socket ID that corresponds to the given
|
|
* LOGICAL socket ID.
|
|
*
|
|
* @param logical_socket_id
|
|
* @param physical_socket_id
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_*
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_physical_socket_id(int logical_socket_id, int *physical_socket_id);
|
|
|
|
/**
|
|
* Return the PHYSICAL core ID that corresponds to the given LOGICAL
|
|
* core id on the given PHYSICAL socket ID.
|
|
*
|
|
* @param physical_socket_id
|
|
* @param_logical_core_id
|
|
* @param physical_core_id
|
|
*
|
|
* @return int - OPAL_SUCCESS or OPAL_ERR_*
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_get_physical_core_id(int physical_socket_id, int logical_core_id, int *physical_core_id);
|
|
|
|
/* Print a char string representation of a cpu set */
|
|
OPAL_DECLSPEC char *opal_paffinity_base_print_binding(opal_paffinity_base_cpu_set_t cpumask);
|
|
|
|
/* Parse the binding string created by above function back into a cpu set */
|
|
OPAL_DECLSPEC int opal_paffinity_base_parse_binding(char *binding, opal_paffinity_base_cpu_set_t *cpumask);
|
|
|
|
/**
|
|
* Indication of whether a component was successfully selected or
|
|
* not
|
|
*/
|
|
OPAL_DECLSPEC extern bool opal_paffinity_base_selected;
|
|
|
|
/**
|
|
* Global component struct for the selected component
|
|
*/
|
|
OPAL_DECLSPEC extern const opal_paffinity_base_component_2_0_1_t
|
|
*opal_paffinity_base_component;
|
|
/**
|
|
* Global module struct for the selected module
|
|
*/
|
|
OPAL_DECLSPEC extern const opal_paffinity_base_module_1_1_0_t
|
|
*opal_paffinity_base_module;
|
|
/**
|
|
* Indicator as to whether the list of opened paffinity components
|
|
* is valid or not.
|
|
*/
|
|
OPAL_DECLSPEC extern bool opal_paffinity_base_components_opened_valid;
|
|
/**
|
|
* List of all opened components; created when the paffinity
|
|
* framework is initialized and destroyed when we reduce the list
|
|
* to all available paffinity components.
|
|
*/
|
|
OPAL_DECLSPEC extern opal_list_t opal_paffinity_base_components_opened;
|
|
/**
|
|
* Assigning slot_list to process
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_slot_list_set(long rank, char *slot_str,
|
|
opal_paffinity_base_cpu_set_t *cpumask);
|
|
|
|
/**
|
|
* Make a prettyprint string for a cset.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_cset2str(char *str, int len,
|
|
opal_paffinity_base_cpu_set_t *cset);
|
|
|
|
/**
|
|
* Make a prettyprint string for a cset with a map format.
|
|
*/
|
|
OPAL_DECLSPEC int opal_paffinity_base_cset2mapstr(char *str, int len,
|
|
opal_paffinity_base_cpu_set_t *cset);
|
|
|
|
/**
|
|
* Debugging output stream
|
|
*/
|
|
OPAL_DECLSPEC extern int opal_paffinity_base_output;
|
|
|
|
/**
|
|
* Flag indicating whether or not processor affinity is to be enabled
|
|
*/
|
|
OPAL_DECLSPEC extern bool opal_paffinity_alone;
|
|
|
|
OPAL_DECLSPEC extern char *opal_paffinity_base_slot_list;
|
|
|
|
/* Indicator that process affinity has been set for this process - i.e.,
|
|
* that OPAL set it either directly or when launched
|
|
*/
|
|
OPAL_DECLSPEC extern bool opal_paffinity_base_bound;
|
|
|
|
/* String passed down from launcher that contains applied binding */
|
|
OPAL_DECLSPEC extern char *opal_paffinity_base_applied_binding;
|
|
|
|
END_C_DECLS
|
|
|
|
#endif /* OPAL_BASE_PAFFINITY_H */
|