bitmap.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_LIB_BITMAP_H__
#define __MOTR_LIB_BITMAP_H__

#include "lib/types.h"
#include "lib/assert.h"
#include "xcode/xcode_attr.h"

struct m0_bitmap {
        size_t    b_nr;
        uint64_t *b_words;
};

struct m0_bitmap_onwire {
        size_t    bo_size;
        uint64_t *bo_words;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(conf|rpc);

M0_INTERNAL int m0_bitmap_init(struct m0_bitmap *map, size_t nr);

M0_INTERNAL void m0_bitmap_fini(struct m0_bitmap *map);

M0_INTERNAL bool m0_bitmap_get(const struct m0_bitmap *map, size_t idx);

M0_INTERNAL int m0_bitmap_ffs(const struct m0_bitmap *map);

M0_INTERNAL int m0_bitmap_ffz(const struct m0_bitmap *map);

M0_INTERNAL void m0_bitmap_set(struct m0_bitmap *map, size_t idx, bool val);

M0_INTERNAL void m0_bitmap_reset(struct m0_bitmap *map);

M0_INTERNAL void m0_bitmap_copy(struct m0_bitmap *dst,
                                const struct m0_bitmap *src);

M0_INTERNAL size_t m0_bitmap_set_nr(const struct m0_bitmap *map);

M0_INTERNAL int m0_bitmap_onwire_init(struct m0_bitmap_onwire *ow_map,
                                      size_t nr);
M0_INTERNAL void m0_bitmap_onwire_fini(struct m0_bitmap_onwire *ow_map);

M0_INTERNAL void m0_bitmap_store(const struct m0_bitmap *im_map,
                                 struct m0_bitmap_onwire *ow_map);

M0_INTERNAL void m0_bitmap_load(const struct m0_bitmap_onwire *ow_map,
                                struct m0_bitmap *im_map);

M0_BASSERT(8 == sizeof ((struct m0_bitmap *)0)->b_words[0]);

#endif /* __MOTR_LIB_BITMAP_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */