histogram.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-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_ADDB2_HISTOGRAM_H__
#define __MOTR_ADDB2_HISTOGRAM_H__

#include "addb2/counter.h"
#include "addb2/internal.h"               /* VALUE_MAX_NR */
#include "lib/types.h"                    /* uint64_t */

enum {
        M0_ADDB2_HIST_BUCKETS = 2 * (VALUE_MAX_NR - M0_ADDB2_COUNTER_VALS - 2)
};

M0_BASSERT(M0_ADDB2_HIST_BUCKETS >= 2);

struct m0_addb2_hist_data {
        int64_t  hd_min;
        int64_t  hd_max;
        uint32_t hd_bucket[M0_ADDB2_HIST_BUCKETS];
};

struct m0_addb2_hist {
        struct m0_addb2_counter   hi_counter;
        int                       hi_skip;
        struct m0_addb2_hist_data hi_data;
};

void m0_addb2_hist_add(struct m0_addb2_hist *hist, int64_t min, int64_t max,
                       uint64_t label, int idx);
void m0_addb2_hist_add_auto(struct m0_addb2_hist *hist, int skip,
                            uint64_t label, int idx);
void m0_addb2_hist_del(struct m0_addb2_hist *hist);
void m0_addb2_hist_mod(struct m0_addb2_hist *hist, int64_t val);
void m0_addb2_hist_mod_with(struct m0_addb2_hist *hist,
                            int64_t val, uint64_t datum);
int m0_addb2_hist_bucket(const struct m0_addb2_hist *hist, int64_t val);

#define M0_ADDB2_HIST(id, hist, datum, ...)                             \
do {                                                                    \
        struct m0_addb2_hist *__hist = (hist);                          \
        M0_ADDB2_TIMED_0((id), (datum), __VA_ARGS__);                   \
        if (__hist != NULL)                                             \
                m0_addb2_hist_mod_with(__hist, __duration, __datum);    \
} while (0)

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