buffer_pool.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_BUFFER_POOL_H__
#define __MOTR_BUFFER_POOL_H__

#include "lib/types.h" /* uint64_t */
#include "lib/mutex.h"
#include "net/net.h"   /* m0_net_buffer, m0_net_domain */
#include "lib/tlist.h"

enum {
        M0_BUFFER_ANY_COLOUR         = ~0,
        M0_NET_BUFFER_POOL_THRESHOLD = 2,
};

struct m0_net_buffer_pool;

struct m0_net_buffer_pool_ops {
        void (*nbpo_not_empty)(struct m0_net_buffer_pool *);
        void (*nbpo_below_threshold)(struct m0_net_buffer_pool *);
};

M0_INTERNAL bool m0_net_buffer_pool_invariant(const struct m0_net_buffer_pool
                                              *pool);

M0_INTERNAL int m0_net_buffer_pool_init(struct m0_net_buffer_pool *pool,
                                        struct m0_net_domain *ndom,
                                        uint32_t threshold, uint32_t seg_nr,
                                        m0_bcount_t seg_size, uint32_t colours,
                                        unsigned shift, bool dont_dump);

M0_INTERNAL int m0_net_buffer_pool_provision(struct m0_net_buffer_pool *pool,
                                             uint32_t buf_nr);
M0_INTERNAL void m0_net_buffer_pool_fini(struct m0_net_buffer_pool *pool);

M0_INTERNAL void m0_net_buffer_pool_lock(struct m0_net_buffer_pool *pool);

M0_INTERNAL bool m0_net_buffer_pool_is_locked(const struct m0_net_buffer_pool
                                              *pool);

M0_INTERNAL bool m0_net_buffer_pool_is_not_locked(const struct
                                                  m0_net_buffer_pool *pool);

M0_INTERNAL void m0_net_buffer_pool_unlock(struct m0_net_buffer_pool *pool);

M0_INTERNAL struct m0_net_buffer *
m0_net_buffer_pool_get(struct m0_net_buffer_pool *pool, uint32_t colour);

M0_INTERNAL void m0_net_buffer_pool_put(struct m0_net_buffer_pool *pool,
                                        struct m0_net_buffer *buf,
                                        uint32_t colour);

M0_INTERNAL bool m0_net_buffer_pool_prune(struct m0_net_buffer_pool *pool);

struct m0_net_buffer_pool {
        uint32_t                             nbp_free;
        uint32_t                             nbp_threshold;
        uint32_t                             nbp_seg_nr;
        uint32_t                             nbp_buf_nr;
        m0_bcount_t                          nbp_seg_size;
        struct m0_mutex                      nbp_mutex;
        struct m0_net_domain                *nbp_ndom;
        const struct m0_net_buffer_pool_ops *nbp_ops;
        uint32_t                             nbp_colours_nr;
        struct m0_tl                        *nbp_colours;
        unsigned                             nbp_align;
        bool                                 nbp_dont_dump;
        struct m0_tl                         nbp_lru;
};
 /* end of net_buffer_pool */
#endif

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