#pragma once
/*
 * Copyright (c) 2016 MariaDB Corporation Ab
 *
 * Use of this software is governed by the Business Source License included
 * in the LICENSE.TXT file and at www.mariadb.com/bsl.
 *
 * Change Date: 2019-07-01
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by version 2 or later of the General
 * Public License.
 */

/**
 * @file gwbitmask.h An implementation of an arbitrarily long bitmask
 *
 * @verbatim
 * Revision History
 *
 * Date         Who             Description
 * 28/06/13     Mark Riddoch    Initial implementation
 * 17/10/15     Martin Brampton Add bitmask_render_readable
 *
 * @endverbatim
 */

#include <maxscale/cdefs.h>
#include <maxscale/spinlock.h>
#include <maxscale/limits.h>

MXS_BEGIN_DECLS

/* This number MUST an be exact multiple of 8 */
#define MXS_BITMASK_LENGTH     (MXS_MAX_THREADS + 1)    /**< Number of bits in the bitmask */

#define MXS_BITMASK_SIZE       (MXS_BITMASK_LENGTH / 8) /**< Number of bytes in the bitmask */

/**
 * The bitmask structure used to store a fixed size bitmask
 */
typedef struct
{
    SPINLOCK lock;                        /**< Lock to protect the bitmask */
    unsigned char bits[MXS_BITMASK_SIZE]; /**< The bits themselves */
} GWBITMASK;

#define GWBITMASK_INIT {SPINLOCK_INIT}

extern void bitmask_init(GWBITMASK *);
extern void bitmask_free(GWBITMASK *);
extern int  bitmask_set(GWBITMASK *, int);
extern int  bitmask_clear(GWBITMASK *, int);
extern int  bitmask_clear_without_spinlock(GWBITMASK *, int);
extern int  bitmask_isset(GWBITMASK *, int);
extern int  bitmask_isallclear(GWBITMASK *);
extern void bitmask_copy(GWBITMASK *, GWBITMASK *);
extern char *bitmask_render_readable(GWBITMASK *);

MXS_END_DECLS