src/plugins/mpi/pmix/pmixp_client.h

/*****************************************************************************\
 **  pmix_client.h - PMIx client communication code
 *****************************************************************************
 *  Copyright (C) 2014-2015 Artem Polyakov. All rights reserved.
 *  Copyright (C) 2015-2020 Mellanox Technologies. All rights reserved.
 *  Written by Artem Polyakov <artpol84@gmail.com, artemp@mellanox.com>.
 *
 *  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 PMIXP_CLIENT_H
#define PMIXP_CLIENT_H

#include "pmixp_common.h"

#ifdef PMIX_VALUE_LOAD
#define PMIXP_VALUE_LOAD PMIX_VALUE_LOAD
#else
#define PMIXP_VALUE_LOAD pmix_value_load
#endif

#define PMIXP_KVP_ALLOC(kvp, key_str)				\
{								\
	char *key = key_str;					\
	kvp = xmalloc(sizeof(pmix_info_t));			\
	(void)strlcpy(kvp->key, key, PMIX_MAX_KEYLEN);		\
}

#define PMIXP_KVP_CREATE(kvp, key_str, val, type)		\
{								\
	PMIXP_KVP_ALLOC(kvp, key_str);				\
	PMIX_INFO_LOAD(kvp, key_str, val, type);		\
}


#define PMIXP_KVP_LOAD(kvp, val, type)				\
{								\
	PMIX_INFO_LOAD(kvp, NULL, val, type);			\
}

#define PMIXP_KVP_ADD(kvp, key_str, val, type) {			\
	int key_num = 0;						\
	char *key = key_str;						\
	if (!kvp) {							\
		kvp = xmalloc(sizeof(pmix_info_t));			\
	} else {							\
		key_num = xsize(kvp) / sizeof(pmix_info_t);		\
		xrecalloc(kvp, (key_num + 1), sizeof(pmix_info_t));	\
	}								\
	(void)strlcpy(kvp[key_num].key, key, PMIX_MAX_KEYLEN);		\
	PMIXP_VALUE_LOAD(&kvp[key_num].value, val, type);		\
}

#define PMIXP_INFO_SIZE(kvp) (xsize(kvp) / sizeof(pmix_info_t))

#define PMIXP_FREE_KEY(kvp)	\
{				\
	xfree(kvp);		\
}

int pmixp_libpmix_init(void);
int pmixp_libpmix_finalize(void);
int pmixp_libpmix_job_set(void);
void pmix_libpmix_task_set(int rank, char ***env);
void pmix_client_new_conn(int fd);

int pmixp_lib_init(void);
int pmixp_lib_finalize(void);
int pmixp_lib_setup_fork(uint32_t rank, const char *nspace, char ***env);
int pmixp_lib_dmodex_request(pmix_proc_t *proc, void *dmdx_fn, void *caddy);
void pmixp_lib_modex_invoke(void *mdx_fn, int status, const char *data,
			    size_t ndata, void *cbdata, void *rel_fn,
			    void *rel_data);
void pmixp_lib_release_invoke(void *rel_fn, void *rel_data);
int pmixp_lib_is_wildcard(uint32_t rank);
int pmixp_lib_is_undef(uint32_t rank);
uint32_t pmixp_lib_get_wildcard(void);
uint32_t pmixp_lib_get_version(void);
int pmixp_lib_fence(const pmix_proc_t procs[], size_t nprocs,
		    bool collect, char *data, size_t ndata,
		    void *cbfunc, void *cbdata);
extern int pmixp_lib_abort(int status, void *cbfunc, void *cbdata);

#endif /* PMIXP_CLIENT_H */