b68d66bb9b
This commit adds support for project_framework_component_* parameter matching. This is the first step in allowing the same framework name in multiple projects. This change also bumps the MCA component version to 2.1.0. All master frameworks have been updated to use the new component versioning macro. An mca.h has been added to each project to add a project specific versioning macro of the form PROJECT_MCA_VERSION_2_1_0. Signed-off-by: Nathan Hjelm <hjelmn@me.com>
143 строки
4.5 KiB
C
143 строки
4.5 KiB
C
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
|
|
/*
|
|
* Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
|
|
* University Research and Technology
|
|
* Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2005 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-2015 Los Alamos National Security, LLC. All rights
|
|
* reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
/** @file:
|
|
*
|
|
* The Open RTE Resource Allocation Subsystem (RAS)
|
|
*
|
|
* The resource allocation subsystem is responsible for determining
|
|
* what (if any) resources have been allocated to the specified job
|
|
* (via some prior action), and to obtain an allocation (if possible)
|
|
* if resources have NOT been previously allocated. It is anticipated
|
|
* that ORTE users will execute an "mpirun" or other command that
|
|
* invokes ORTE through one of two channels:
|
|
*
|
|
* 1. the user will login to the computing resource they intend
|
|
* to use, request a resource allocation from that system, and then
|
|
* execute the mpirun or other command. Thus, the allocation has
|
|
* already been obtained prior to ORTE's initialization. In most
|
|
* cases, systems pass allocation information via environmental
|
|
* parameters. Thus, the RAS components must know the correct
|
|
* environmental parameter to look for within the environment they
|
|
* seek to support (e.g., an LSF component should know that LSF passes
|
|
* allocation parameters as a specific LSF-named entity).
|
|
*
|
|
* 2. the user issues an mpirun command or an application that uses
|
|
* ORTE without obtaining an allocation in advance. Thus, the associated
|
|
* RAS component must know how to request an allocation from the
|
|
* designated resource. If it doesn't, or it cannot obtain the allocation,
|
|
* then it shall indicate this by setting the system to an appropriate
|
|
* state.
|
|
*/
|
|
|
|
#ifndef ORTE_MCA_RAS_H
|
|
#define ORTE_MCA_RAS_H
|
|
|
|
#include "orte_config.h"
|
|
#include "orte/constants.h"
|
|
#include "orte/types.h"
|
|
|
|
#include "orte/mca/mca.h"
|
|
#include "opal/mca/event/event.h"
|
|
#include "opal/class/opal_list.h"
|
|
|
|
#include "orte/runtime/orte_globals.h"
|
|
|
|
#include "ras_types.h"
|
|
|
|
BEGIN_C_DECLS
|
|
|
|
/* allocation event - the event one activates to schedule resource
|
|
* allocation for pending jobs
|
|
*/
|
|
ORTE_DECLSPEC extern opal_event_t orte_allocate_event;
|
|
|
|
/*
|
|
* ras module functions - these are not accessible to the outside world,
|
|
* but are defined here by convention
|
|
*/
|
|
|
|
/* init the module */
|
|
typedef int (*orte_ras_base_module_init_fn_t)(void);
|
|
|
|
/**
|
|
* Allocate resources to a job.
|
|
*/
|
|
typedef int (*orte_ras_base_module_allocate_fn_t)(orte_job_t *jdata,
|
|
opal_list_t *nodes);
|
|
|
|
/* deallocate resources */
|
|
typedef void (*orte_ras_base_module_dealloc_fn_t)(orte_job_t *jdata,
|
|
orte_app_context_t *app);
|
|
|
|
/**
|
|
* Cleanup module resources.
|
|
*/
|
|
typedef int (*orte_ras_base_module_finalize_fn_t)(void);
|
|
|
|
/**
|
|
* ras module
|
|
*/
|
|
struct orte_ras_base_module_2_0_0_t {
|
|
/** init */
|
|
orte_ras_base_module_init_fn_t init;
|
|
/** Allocation function pointer */
|
|
orte_ras_base_module_allocate_fn_t allocate;
|
|
orte_ras_base_module_dealloc_fn_t deallocate;
|
|
/** Finalization function pointer */
|
|
orte_ras_base_module_finalize_fn_t finalize;
|
|
};
|
|
/** Convenience typedef */
|
|
typedef struct orte_ras_base_module_2_0_0_t orte_ras_base_module_2_0_0_t;
|
|
/** Convenience typedef */
|
|
typedef orte_ras_base_module_2_0_0_t orte_ras_base_module_t;
|
|
|
|
/*
|
|
* ras component
|
|
*/
|
|
|
|
/**
|
|
* Component init / selection
|
|
* ras component
|
|
*/
|
|
struct orte_ras_base_component_2_0_0_t {
|
|
/** Base MCA structure */
|
|
mca_base_component_t base_version;
|
|
/** Base MCA data */
|
|
mca_base_component_data_t base_data;
|
|
};
|
|
/** Convenience typedef */
|
|
typedef struct orte_ras_base_component_2_0_0_t orte_ras_base_component_2_0_0_t;
|
|
/** Convenience typedef */
|
|
typedef orte_ras_base_component_2_0_0_t orte_ras_base_component_t;
|
|
|
|
|
|
/**
|
|
* Macro for use in components that are of type ras
|
|
*/
|
|
#define ORTE_RAS_BASE_VERSION_2_0_0 \
|
|
ORTE_MCA_BASE_VERSION_2_1_0("ras", 2, 0, 0)
|
|
|
|
|
|
END_C_DECLS
|
|
|
|
#endif
|
|
|