blob: 8a54b3b7ca955b1632749f6c8e3c219029519dfd [file] [log] [blame] [edit]
/****************************************************************************\
* slurm_pmi.h - definitions PMI support functions internal to SLURM
*****************************************************************************
* Copyright (C) 2005-2006 The Regents of the University of California.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
* Written by Morris Jette <jette1@llnl.gov>.
* CODE-OCEC-09-009. All rights reserved.
*
* This file is part of Slurm, a resource management program.
* For details, see <https://slurm.schedmd.com/>.
* Please also read the included file: DISCLAIMER.
*
* Slurm is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* In addition, as a special exception, the copyright holders give permission
* to link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two. You must obey the GNU
* General Public License in all respects for all of the code used other than
* OpenSSL. If you modify file(s) with this exception, you may extend this
* exception to your version of the file(s), but you are not obligated to do
* so. If you do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source files in
* the program, then also delete it here.
*
* Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along
* with Slurm; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
\*****************************************************************************/
#ifndef _SLURM_PMI_H
#define _SLURM_PMI_H
#include <inttypes.h>
#include "src/common/pack.h"
#include "src/common/slurm_protocol_defs.h"
#define PMI_MAX_ID_LEN 16 /* Maximim size of PMI process group ID */
#define PMI_MAX_KEY_LEN 256 /* Maximum size of a PMI key */
#define PMI_MAX_KVSNAME_LEN 256 /* Maximum size of KVS name */
#define PMI_MAX_VAL_LEN 1024 /* Maximum size of a PMI value */
/* Transmit PMI Keyval space data */
int slurm_send_kvs_comm_set(kvs_comm_set_t *kvs_set_ptr,
int pmi_rank, int pmi_size);
/* Wait for barrier and get full PMI Keyval space data */
int slurm_get_kvs_comm_set(kvs_comm_set_t **kvs_set_ptr,
int pmi_rank, int pmi_size);
/* Finalization processing */
void slurm_pmi_finalize(void);
#endif