buf.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * 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.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_LIB_BUF_H__
#define __MOTR_LIB_BUF_H__

#include "lib/types.h"
#include "xcode/xcode_attr.h"

struct m0_buf {
        m0_bcount_t b_nob;
        void       *b_addr;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(conf|rpc);

struct m0_bufs {
        uint32_t       ab_count;
        struct m0_buf *ab_elems;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(conf|rpc);

#define M0_BUF_INIT(size, data) \
        ((struct m0_buf){ .b_nob = (size), .b_addr = (data) })
#define M0_BUF_INIT_CONST(size, data) \
        (const struct m0_buf) { .b_nob = (size), .b_addr = (void *)(data) }

#define M0_BUF_INIT_PTR(p) M0_BUF_INIT(sizeof *(p), (p))
#define M0_BUF_INITS(str)  M0_BUF_INIT(strlen(str), (str))
#define M0_BUF_INIT0       M0_BUF_INIT(0, NULL)

#define M0_BUF_INIT_PTR_CONST(p) M0_BUF_INIT_CONST(sizeof *(p), (p))

#define BUF_F    "[%p,%llu]"
#define BUF_P(p) (p)->b_addr, (unsigned long long)(p)->b_nob

M0_INTERNAL void m0_buf_init(struct m0_buf *buf, void *data, uint32_t nob);

M0_INTERNAL int m0_buf_alloc(struct m0_buf *buf, size_t size);

M0_INTERNAL void m0_buf_free(struct m0_buf *buf);

M0_INTERNAL int m0_buf_cmp(const struct m0_buf *x, const struct m0_buf *y);

M0_INTERNAL bool m0_buf_eq(const struct m0_buf *x, const struct m0_buf *y);

M0_INTERNAL void m0_buf_memcpy(struct m0_buf *dst, const struct m0_buf *src);

M0_INTERNAL int m0_buf_copy(struct m0_buf *dest, const struct m0_buf *src);

M0_INTERNAL int m0_buf_new_aligned(struct m0_buf *buf,
                                   const void *data, uint32_t nob,
                                   unsigned shift);

M0_INTERNAL int m0_buf_copy_aligned(struct m0_buf *dst,
                                    const struct m0_buf *src,
                                    unsigned shift);

M0_INTERNAL bool m0_buf_is_set(const struct m0_buf *buf);

M0_INTERNAL bool m0_buf_streq(const struct m0_buf *buf, const char *str);

M0_INTERNAL char *m0_buf_strdup(const struct m0_buf *buf);

M0_INTERNAL int m0_bufs_from_strings(struct m0_bufs *dest, const char **src);

M0_INTERNAL int m0_bufs_to_strings(const char ***dest,
                                   const struct m0_bufs *src);

M0_INTERNAL bool m0_bufs_streq(const struct m0_bufs *bufs, const char **strs);

M0_INTERNAL void m0_bufs_free(struct m0_bufs *bufs);

#endif /* __MOTR_LIB_BUF_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */