ringbuf.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_NET_TEST_RINGBUF_H__
#define __MOTR_NET_TEST_RINGBUF_H__

#include "lib/types.h"  /* size_t */
#include "lib/atomic.h" /* m0_atomic64 */

struct m0_net_test_ringbuf {
        size_t              ntr_size;   
        size_t             *ntr_buf;    
        struct m0_atomic64  ntr_start;  
        struct m0_atomic64  ntr_end;    
};

int m0_net_test_ringbuf_init(struct m0_net_test_ringbuf *rb, size_t size);

void m0_net_test_ringbuf_fini(struct m0_net_test_ringbuf *rb);
bool m0_net_test_ringbuf_invariant(const struct m0_net_test_ringbuf *rb);

void m0_net_test_ringbuf_push(struct m0_net_test_ringbuf *rb, size_t value);

size_t m0_net_test_ringbuf_pop(struct m0_net_test_ringbuf *rb);

bool m0_net_test_ringbuf_is_empty(struct m0_net_test_ringbuf *rb);

size_t m0_net_test_ringbuf_nr(struct m0_net_test_ringbuf *rb);

#endif /*  __MOTR_NET_TEST_RINGBUF_H__ */

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