collectives.h

Go to the documentation of this file.

 
/*
 *   Copyright 2021 Huawei Technologies Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _H_LPF_COLLECTIVES
#define _H_LPF_COLLECTIVES
 
#include <lpf/core.h>
#include <stdbool.h>
 
 
#ifdef __cplusplus
#define restrict __restrict__
extern "C" {
#endif
 
#define _LPF_COLLECTIVES_VERSION 201500L
 
typedef struct lpf_coll {
        lpf_t ctx;
 
        lpf_pid_t * inv_translate;
 
        lpf_pid_t * translate;
 
        void * buffer;
 
        lpf_memslot_t slot;
 
        lpf_pid_t P;
 
        lpf_pid_t s;
} lpf_coll_t;
 
typedef void (*lpf_reducer_t) (size_t n, const void * array, void * value);
 
typedef void (*lpf_combiner_t) (size_t n, const void * combine, void * into );
 
extern _LPFLIB_API const lpf_coll_t LPF_INVALID_COLL;
 
extern _LPFLIB_API
lpf_err_t lpf_collectives_init(
        lpf_t ctx,
        lpf_pid_t s,
        lpf_pid_t p,
        size_t max_calls,
        size_t max_elem_size,
        size_t max_byte_size,
        lpf_coll_t * coll
);
 
extern _LPFLIB_API
lpf_t lpf_collectives_get_context( lpf_coll_t coll );
 
extern _LPFLIB_API
lpf_err_t lpf_collectives_init_strided(
        lpf_t ctx,
        lpf_pid_t s,
        lpf_pid_t p,
        lpf_pid_t lo,
        lpf_pid_t hi,
        lpf_pid_t str,
        size_t max_calls,
        size_t max_elem_size,
        size_t max_byte_size,
        lpf_coll_t * coll
);
 
extern _LPFLIB_API
lpf_err_t lpf_collectives_destroy( lpf_coll_t coll );
 
extern _LPFLIB_API
lpf_err_t lpf_broadcast(
        lpf_coll_t coll,
        lpf_memslot_t src,
        lpf_memslot_t dst,
        size_t size,
        lpf_pid_t root
);
 
extern _LPFLIB_API
lpf_err_t lpf_gather(
        lpf_coll_t coll,
        lpf_memslot_t src,
        lpf_memslot_t dst,
        size_t size,
        lpf_pid_t root
);
 
extern _LPFLIB_API
lpf_err_t lpf_scatter(
        lpf_coll_t coll,
        lpf_memslot_t src,
        lpf_memslot_t dst,
        size_t size,
        lpf_pid_t root
);
 
extern _LPFLIB_API
lpf_err_t lpf_allgather(
        lpf_coll_t coll,
        lpf_memslot_t src,
        lpf_memslot_t dst,
        size_t size,
        bool exclude_myself
);
 
extern _LPFLIB_API
lpf_err_t lpf_alltoall(
        lpf_coll_t coll,
        lpf_memslot_t src,
        lpf_memslot_t dst,
        size_t size
);
 
extern _LPFLIB_API
lpf_err_t lpf_reduce(
        lpf_coll_t coll,
        void * restrict element,
        lpf_memslot_t element_slot,
        size_t size,
        lpf_reducer_t reducer,
        lpf_pid_t root
);
 
extern _LPFLIB_API
lpf_err_t lpf_allreduce(
        lpf_coll_t coll,
        void * restrict element,
        lpf_memslot_t element_slot,
        size_t size,
        lpf_reducer_t reducer
);
 
extern _LPFLIB_API
lpf_err_t lpf_combine(
        lpf_coll_t coll,
        void * restrict array,
        lpf_memslot_t slot,
        size_t num,
        size_t size,
        lpf_combiner_t combiner,
        lpf_pid_t root
);
 
extern _LPFLIB_API
lpf_err_t lpf_allcombine(
        lpf_coll_t coll,
        void * restrict array,
        lpf_memslot_t slot,
        size_t num,
        size_t size,
        lpf_combiner_t combiner
);
 
#ifdef __cplusplus
} //end ``extern "C"''
#undef restrict
#endif
 
#endif //end ``_H_LPF_COLLECTIVES''