minmax_heap.h

Go to the documentation of this file.

#pragma once
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/** Structures and prototypes for binary min-max heaps
 *
 * @file src/lib/util/minmax_heap.h
 *
 * @copyright 2021 Network RADIUS SAS (legal@networkradius.com)
 */
RCSIDH(minmax_heap_h, "$Id: 5f56f2cfd090f76a733e70a59ade81f84ba75c4b $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/build.h>
#include <freeradius-devel/missing.h>
#include <freeradius-devel/util/misc.h>
#include <freeradius-devel/util/talloc.h>
 
#include <stdint.h>
#include <sys/types.h>
 
typedef unsigned int fr_minmax_heap_index_t;
typedef unsigned int fr_minmax_heap_iter_t;
 
/** How many talloc headers need to be pre-allocated for a minmax heap
 */
#define FR_MINMAX_HEAP_TALLOC_HEADERS 2
 
/** Comparator to order elements
 *
 *  Return CMP_LT if 'a' precedes 'b'.
 *  Return CMP_EQ if the ordering of 'a' and 'b' doesn't matter.
 *  Return CMP_GT if 'b' precedes 'a'.
 *  Return CMP_ERR if the comparison itself failed.
 */
typedef fr_cmp_ret_t (*fr_minmax_heap_cmp_t)(void const *a, void const *b);
 
/** The main minmax heap structure
 * Note that fr_minmax_heap_t is a pointer to fr_minmax_heap_s. This added level of indirection
 * lets one allocate/reallocate the heap structure and the array of pointers to items in the
 * minmax heap as a unit without affecting the caller.
 */
typedef struct fr_minmax_heap_s * fr_minmax_heap_t;
 
size_t fr_minmax_heap_pre_alloc_size(unsigned int count);
 
/** Creates a minmax heap that can be used with non-talloced elements
 *
 * @param[in] _ctx              Talloc ctx to allocate heap in.
 * @param[in] _cmp              Comparator used to compare elements.
 * @param[in] _type             Of elements.
 * @param[in] _field            to store heap indexes in.
 * @param[in] _init             the initial number of elements to allocate.
 *                              Pass 0 to use the default.
 */
#define fr_minmax_heap_alloc(_ctx, _cmp, _type, _field, _init) \
        _fr_minmax_heap_alloc(_ctx, _cmp, NULL, (size_t)offsetof(_type, _field), _init)
 
/** Creates a minmax heap that verifies elements are of a specific talloc type
 *
 * @param[in] _ctx              Talloc ctx to allocate heap in.
 * @param[in] _cmp              Comparator used to compare elements.
 * @param[in] _talloc_type      of elements.
 * @param[in] _field            to store heap indexes in.
 * @param[in] _init             the initial number of elements to allocate.
 *                              Pass 0 to use the default.
 * @return
 *      - A new minmax heap.
 *      - NULL on error.
 */
#define fr_minmax_heap_talloc_alloc(_ctx, _cmp, _talloc_type, _field, _init) \
        _fr_minmax_heap_alloc(_ctx, _cmp, #_talloc_type, (size_t)offsetof(_talloc_type, _field), _init)
 
fr_minmax_heap_t        *_fr_minmax_heap_alloc(TALLOC_CTX *ctx, fr_minmax_heap_cmp_t cmp, char const *talloc_type, size_t offset, unsigned int init) CC_HINT(nonnull(2));
 
/** Check if an entry is inserted into a heap
 *
 */
static inline bool fr_minmax_heap_entry_inserted(fr_minmax_heap_index_t heap_idx)
{
        return (heap_idx > 0);
}
 
int             fr_minmax_heap_insert(fr_minmax_heap_t *hp, void *data) CC_HINT(nonnull);
int             fr_minmax_heap_extract(fr_minmax_heap_t *hp, void *data) CC_HINT(nonnull);
int             fr_minmax_heap_min_pop(void **out, fr_minmax_heap_t *hp) CC_HINT(nonnull);
void            *fr_minmax_heap_min_peek(fr_minmax_heap_t *hp) CC_HINT(nonnull);
int             fr_minmax_heap_max_pop(void **out, fr_minmax_heap_t *hp) CC_HINT(nonnull);
int             fr_minmax_heap_max_peek(void **out, fr_minmax_heap_t *hp) CC_HINT(nonnull);
 
uint32_t        fr_minmax_heap_num_elements(fr_minmax_heap_t *hp) CC_HINT(nonnull);
 
void            *fr_minmax_heap_iter_init(fr_minmax_heap_t *hp, fr_minmax_heap_iter_t *iter) CC_HINT(nonnull);
void            *fr_minmax_heap_iter_next(fr_minmax_heap_t *hp, fr_minmax_heap_iter_t *iter) CC_HINT(nonnull);
 
/** Iterate over the contents of a minmax_heap
 *
 * @note The initializer section of a for loop can't declare variables with distinct
 *       base types, so we require a containing block, and can't follow the standard
 *       do {...} while(0) dodge. The code to be run for each item in the heap should
 *       therefore start with 1 open braces and end with 2 close braces, and shouldn't
 *       be followed with a semicolon.
 *       This may fake out code formatting programs, including editors.
 *
 * @param[in] _hp               to iterate over.
 * @param[in] _type             of item the heap contains.
 * @param[in] _data             Name of variable holding a pointer to the heap element.
 *                              Will be declared in the scope of the loop.
 */
#define fr_minmax_heap_foreach(_hp, _type, _data) \
{ \
        fr_minmax_heap_iter_t _iter; \
        for (_type *_data = fr_minmax_heap_iter_init(_hp, &_iter); _data; _data = fr_minmax_heap_iter_next(_hp, &_iter))
 
#ifndef TALLOC_GET_TYPE_ABORT_NOOP
CC_HINT(nonnull(1)) void fr_minmax_heap_verify(char const *file, int line, fr_minmax_heap_t const *hp);
#  define FR_MINMAX_HEAP_VERIFY(_hp) fr_minmax_heap_verify(__FILE__, __LINE__, _hp)
#elif !defined(NDEBUG)
#  define FR_MINMAX_HEAP_VERIFY(_hp) fr_assert(_hp)
#else
#  define FR_MINMAX_HEAP_VERIFY(_hp)
#endif
 
 
#ifdef __cplusplus
}
#endif