tx_credit.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_TX_CREDIT_H__
#define __MOTR_BE_TX_CREDIT_H__

#include "lib/types.h"  /* m0_bcount_t */

#ifdef __KERNEL__
#define M0_DEBUG_BE_CREDITS (0)
#else
#define M0_DEBUG_BE_CREDITS (1)
#endif

enum m0_be_credit_users {
        M0_BE_CU_BTREE_INSERT,
        M0_BE_CU_BTREE_DELETE,
        M0_BE_CU_BTREE_UPDATE,
        M0_BE_CU_EMAP_SPLIT,
        M0_BE_CU_EMAP_PASTE,
        M0_BE_CU_NR
};

struct m0_be_tx_credit {
        m0_bcount_t tc_reg_nr;
        m0_bcount_t tc_reg_size;
        unsigned    tc_balance[M0_BE_CU_NR];
};

/* invalid m0_be_tx_credit value */
extern const struct m0_be_tx_credit m0_be_tx_credit_invalid;

#define M0_BE_TX_CREDIT(nr, size) \
        (struct m0_be_tx_credit){ .tc_reg_nr = (nr), .tc_reg_size = (size) }

#define M0_BE_TX_CREDIT_TYPE(type) M0_BE_TX_CREDIT(1, sizeof(type))
#define M0_BE_TX_CREDIT_PTR(ptr)   M0_BE_TX_CREDIT(1, sizeof *(ptr))
#define M0_BE_TX_CREDIT_BUF(buf)   M0_BE_TX_CREDIT(1, (buf)->b_nob)

#define BETXCR_F "(%lu,%lu)"

#define BETXCR_P(c) (unsigned long)(c)->tc_reg_nr, \
                    (unsigned long)(c)->tc_reg_size


M0_INTERNAL void m0_be_tx_credit_add(struct m0_be_tx_credit *c0,
                                     const struct m0_be_tx_credit *c1);

M0_INTERNAL void m0_be_tx_credit_sub(struct m0_be_tx_credit *c0,
                                     const struct m0_be_tx_credit *c1);

M0_INTERNAL void m0_be_tx_credit_mul(struct m0_be_tx_credit *c, m0_bcount_t k);

M0_INTERNAL void m0_be_tx_credit_mul_bp(struct m0_be_tx_credit *c, unsigned bp);

M0_INTERNAL void m0_be_tx_credit_mac(struct m0_be_tx_credit *c,
                                     const struct m0_be_tx_credit *c1,
                                     m0_bcount_t k);

M0_INTERNAL void m0_be_tx_credit_max(struct m0_be_tx_credit       *c,
                                     const struct m0_be_tx_credit *c0,
                                     const struct m0_be_tx_credit *c1);

/* c += m0_be_tx_credit_max(c, c0, c1) */
M0_INTERNAL void m0_be_tx_credit_add_max(struct m0_be_tx_credit       *c,
                                         const struct m0_be_tx_credit *c0,
                                         const struct m0_be_tx_credit *c1);

/* c0 <= c1 */
M0_INTERNAL bool m0_be_tx_credit_le(const struct m0_be_tx_credit *c0,
                                    const struct m0_be_tx_credit *c1);

/* c0 == c1 */
M0_INTERNAL bool m0_be_tx_credit_eq(const struct m0_be_tx_credit *c0,
                                    const struct m0_be_tx_credit *c1);

#endif /* __MOTR_BE_TX_CREDIT_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
 */