1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * tools/testing/selftests/kvm/include/sparsebit.h 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Copyright (C) 2018, Google LLC. 6*4882a593Smuzhiyun * 7*4882a593Smuzhiyun * Header file that describes API to the sparsebit library. 8*4882a593Smuzhiyun * This library provides a memory efficient means of storing 9*4882a593Smuzhiyun * the settings of bits indexed via a uint64_t. Memory usage 10*4882a593Smuzhiyun * is reasonable, significantly less than (2^64 / 8) bytes, as 11*4882a593Smuzhiyun * long as bits that are mostly set or mostly cleared are close 12*4882a593Smuzhiyun * to each other. This library is efficient in memory usage 13*4882a593Smuzhiyun * even in the case where most bits are set. 14*4882a593Smuzhiyun */ 15*4882a593Smuzhiyun 16*4882a593Smuzhiyun #ifndef SELFTEST_KVM_SPARSEBIT_H 17*4882a593Smuzhiyun #define SELFTEST_KVM_SPARSEBIT_H 18*4882a593Smuzhiyun 19*4882a593Smuzhiyun #include <stdbool.h> 20*4882a593Smuzhiyun #include <stdint.h> 21*4882a593Smuzhiyun #include <stdio.h> 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun #ifdef __cplusplus 24*4882a593Smuzhiyun extern "C" { 25*4882a593Smuzhiyun #endif 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun struct sparsebit; 28*4882a593Smuzhiyun typedef uint64_t sparsebit_idx_t; 29*4882a593Smuzhiyun typedef uint64_t sparsebit_num_t; 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun struct sparsebit *sparsebit_alloc(void); 32*4882a593Smuzhiyun void sparsebit_free(struct sparsebit **sbitp); 33*4882a593Smuzhiyun void sparsebit_copy(struct sparsebit *dstp, struct sparsebit *src); 34*4882a593Smuzhiyun 35*4882a593Smuzhiyun bool sparsebit_is_set(struct sparsebit *sbit, sparsebit_idx_t idx); 36*4882a593Smuzhiyun bool sparsebit_is_set_num(struct sparsebit *sbit, 37*4882a593Smuzhiyun sparsebit_idx_t idx, sparsebit_num_t num); 38*4882a593Smuzhiyun bool sparsebit_is_clear(struct sparsebit *sbit, sparsebit_idx_t idx); 39*4882a593Smuzhiyun bool sparsebit_is_clear_num(struct sparsebit *sbit, 40*4882a593Smuzhiyun sparsebit_idx_t idx, sparsebit_num_t num); 41*4882a593Smuzhiyun sparsebit_num_t sparsebit_num_set(struct sparsebit *sbit); 42*4882a593Smuzhiyun bool sparsebit_any_set(struct sparsebit *sbit); 43*4882a593Smuzhiyun bool sparsebit_any_clear(struct sparsebit *sbit); 44*4882a593Smuzhiyun bool sparsebit_all_set(struct sparsebit *sbit); 45*4882a593Smuzhiyun bool sparsebit_all_clear(struct sparsebit *sbit); 46*4882a593Smuzhiyun sparsebit_idx_t sparsebit_first_set(struct sparsebit *sbit); 47*4882a593Smuzhiyun sparsebit_idx_t sparsebit_first_clear(struct sparsebit *sbit); 48*4882a593Smuzhiyun sparsebit_idx_t sparsebit_next_set(struct sparsebit *sbit, sparsebit_idx_t prev); 49*4882a593Smuzhiyun sparsebit_idx_t sparsebit_next_clear(struct sparsebit *sbit, sparsebit_idx_t prev); 50*4882a593Smuzhiyun sparsebit_idx_t sparsebit_next_set_num(struct sparsebit *sbit, 51*4882a593Smuzhiyun sparsebit_idx_t start, sparsebit_num_t num); 52*4882a593Smuzhiyun sparsebit_idx_t sparsebit_next_clear_num(struct sparsebit *sbit, 53*4882a593Smuzhiyun sparsebit_idx_t start, sparsebit_num_t num); 54*4882a593Smuzhiyun 55*4882a593Smuzhiyun void sparsebit_set(struct sparsebit *sbitp, sparsebit_idx_t idx); 56*4882a593Smuzhiyun void sparsebit_set_num(struct sparsebit *sbitp, sparsebit_idx_t start, 57*4882a593Smuzhiyun sparsebit_num_t num); 58*4882a593Smuzhiyun void sparsebit_set_all(struct sparsebit *sbitp); 59*4882a593Smuzhiyun 60*4882a593Smuzhiyun void sparsebit_clear(struct sparsebit *sbitp, sparsebit_idx_t idx); 61*4882a593Smuzhiyun void sparsebit_clear_num(struct sparsebit *sbitp, 62*4882a593Smuzhiyun sparsebit_idx_t start, sparsebit_num_t num); 63*4882a593Smuzhiyun void sparsebit_clear_all(struct sparsebit *sbitp); 64*4882a593Smuzhiyun 65*4882a593Smuzhiyun void sparsebit_dump(FILE *stream, struct sparsebit *sbit, 66*4882a593Smuzhiyun unsigned int indent); 67*4882a593Smuzhiyun void sparsebit_validate_internal(struct sparsebit *sbit); 68*4882a593Smuzhiyun 69*4882a593Smuzhiyun #ifdef __cplusplus 70*4882a593Smuzhiyun } 71*4882a593Smuzhiyun #endif 72*4882a593Smuzhiyun 73*4882a593Smuzhiyun #endif /* SELFTEST_KVM_SPARSEBIT_H */ 74