bsmp.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_BSMP
#define _H_LPF_BSMP
 
#include <lpf/core.h>
 
#define _LPF_BMSP_VERSION 201500L
 
#ifdef __cplusplus
#define restrict __restrict__
extern "C" {
#endif
 
enum lpf_bsmp_mode {
 
        READ,
 
        WRITE
};
 
struct lpf_bsmp_buffer {
 
        size_t buffer_size;
 
        size_t tag_size;
 
        size_t queued;
 
        size_t * restrict remote_pos;
 
        size_t * restrict local_pos;
 
        size_t * restrict headers;
 
        char * restrict message_queue;
 
        lpf_memslot_t in_slot;
 
        lpf_memslot_t out_slot;
 
        lpf_memslot_t rpos_slot;
 
        lpf_memslot_t lpos_slot;
 
        lpf_pid_t s;
 
        lpf_pid_t p;
 
        lpf_pid_t pid_pos;
 
        enum lpf_bsmp_mode mode;
 
        lpf_t ctx;
};
 
#ifdef DOXYGEN
typedef ... lpf_bsmp_t;
#else
typedef struct lpf_bsmp_buffer * lpf_bsmp_t;
#endif
 
extern _LPFLIB_API const lpf_bsmp_t LPF_INVALID_BSMP;
 
extern _LPFLIB_API const lpf_err_t LPF_ERR_BSMP_FULL;
 
extern _LPFLIB_API const lpf_err_t LPF_ERR_BSMP_INVAL;
 
extern _LPFLIB_API const size_t LPF_INVALID_SIZE;
 
extern _LPFLIB_API const lpf_memslot_t LPF_INVALID_MEMSLOT;
 
extern _LPFLIB_API
lpf_err_t lpf_bsmp_create(
    const lpf_t ctx,
    const lpf_pid_t s,
    const lpf_pid_t p,
    const size_t buffer_size,
    const size_t tag_size,
    const size_t max_messages,
    lpf_bsmp_t * const bsmp
);
 
extern _LPFLIB_API
lpf_err_t lpf_bsmp_destroy( lpf_bsmp_t * const bsmp );
 
extern _LPFLIB_API
lpf_err_t lpf_send(
        const lpf_bsmp_t bsmp,
        const lpf_pid_t pid,
        const lpf_memslot_t tag,
        const size_t tag_offset,
        const lpf_memslot_t payload,
        const size_t payload_offset,
        const size_t payload_size
);
 
extern _LPFLIB_API
lpf_err_t lpf_bsmp_sync( lpf_bsmp_t bsmp, lpf_sync_attr_t hint );
 
extern _LPFLIB_API
lpf_err_t lpf_bsmp_syncall( lpf_bsmp_t * const bsmp, const size_t num_objects, lpf_sync_attr_t hint );
 
extern _LPFLIB_API
lpf_err_t lpf_move( lpf_bsmp_t bsmp, void * * const tag_p, void * * const payload_p, size_t * const size );
 
#ifdef __cplusplus
} //end ``extern "C"''
#undef restrict
#endif
 
#endif //end ``_H_LPF_BSMP''