fl.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2014-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_BE_FL_H__
#define __MOTR_BE_FL_H__

#include "be/list.h"    /* m0_be_list */
#include "be/list_xc.h"

struct be_alloc_chunk;

enum {
        M0_BE_FL_STEP = 8,      
        M0_BE_FL_NR = 128,      
        M0_BE_FL_PICK_SCAN_LIMIT = 0x10, 
};

M0_BASSERT(M0_BE_FL_STEP * M0_BE_FL_NR < M0_BCOUNT_MAX);

enum m0_be_fl_op {
        M0_BFL_CREATE,
        M0_BFL_DESTROY,
        M0_BFL_ADD,
        M0_BFL_DEL,
};

struct m0_be_fl_size {
        struct m0_be_list bfs_list;
} M0_XCA_RECORD M0_XCA_DOMAIN(be);

struct m0_be_fl {
        /*
         * If i is from range [0,  M0_BE_FL_NR) then i-th element of array
         * contains free list with chunk sizes in range
         * [i * M0_BE_FL_STEP, (i + 1) * M0_BE_FL_STEP).
         * M0_BE_FL_NR-th element contains list of chunks
         * with size >= (M0_BE_FL_NR * M0_BE_FL_STEP).
         * @see m0_be_fl_add(), m0_be_fl_pick().
         */
        struct m0_be_fl_size bfl_free[M0_BE_FL_NR + 1];
} M0_XCA_RECORD M0_XCA_DOMAIN(be);

M0_INTERNAL bool m0_be_fl__invariant(struct m0_be_fl *fl);

M0_INTERNAL void m0_be_fl_create(struct m0_be_fl  *fl,
                                 struct m0_be_tx  *tx,
                                 struct m0_be_seg *seg);
M0_INTERNAL void m0_be_fl_destroy(struct m0_be_fl *fl,
                                  struct m0_be_tx *tx);

M0_INTERNAL void m0_be_fl_add(struct m0_be_fl       *fl,
                              struct m0_be_tx       *tx,
                              struct be_alloc_chunk *chunk);
M0_INTERNAL void m0_be_fl_del(struct m0_be_fl       *fl,
                              struct m0_be_tx       *tx,
                              struct be_alloc_chunk *chunk);

M0_INTERNAL struct be_alloc_chunk *m0_be_fl_pick(struct m0_be_fl *fl,
                                                 m0_bcount_t      size);

M0_INTERNAL void m0_be_fl_credit(struct m0_be_fl        *fl,
                                 enum m0_be_fl_op        fl_op,
                                 struct m0_be_tx_credit *accum);

#endif /* __MOTR_BE_FL_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */