bitmap.h

Go to the documentation of this file.

/* BLURB gpl
 
                           Coda File System
                              Release 8
 
          Copyright (c) 1987-2025 Carnegie Mellon University
                  Additional copyrights listed below
 
This  code  is  distributed "AS IS" without warranty of any kind under
the terms of the GNU General Public Licence Version 2, as shown in the
file  LICENSE.  The  technical and financial  contributors to Coda are
listed in the file CREDITS.
 
                        Additional copyrights
                           none currently
 
#*/
 
#ifndef _BITMAP_H_
#define _BITMAP_H_ 1
/*
 * bitmap.h
 * Created Feb 13, 1992 -- Puneet Kumar
 * Declaration of a bitmap class
 */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#ifdef __cplusplus
}
#endif
 
#include <coda_tsa.h>
 
#define ALLOCMASK 255
#define HIGHBIT 128
/* Bitmap for keeping status of N elements of an array.
 * The class keeps an array of size = 1/8th N
 * Each elements status is stored in a bit
 *  1 --> that element is not free
 *  0 --> that element is free
 */
 
/* Values of bitmap::malloced; must be 8 bits so can't use enums */
#define BITMAP_NOTVIANEW 193 /* must be on stack */
#define BITMAP_VIANEW 221 /* on heap, via operator new */
 
class bitmap {
    //  friend ostream& operator<<(ostream& s, bitmap *b);
    uint8_t recoverable; /* is this bitmap recoverable */
    uint8_t malloced; /* was bitmap allocated via new? */
    int mapsize; /* 1/8 size of array of elements */
    char *map; /* bitmap showing status of the elements */
 
    void SetValue(int index, int value) TRANSACTION_OPTIONAL;
 
    void SetRangeValue(int start, int len, int value);
 
public:
    void *operator new(size_t size, int recable = 0) TRANSACTION_OPTIONAL;
 
    void operator delete(void *ptr) TRANSACTION_OPTIONAL;
 
    bitmap(int inputmapsize = 0, int recable = 0);
 
    ~bitmap();
 
    void Resize(int newsize) TRANSACTION_OPTIONAL;
 
    void Grow(int newsize);
 
    int GetFreeIndex() TRANSACTION_OPTIONAL;
 
    void FreeIndex(int index);
 
    void FreeRange(int start, int len);
 
    void SetIndex(int index) TRANSACTION_OPTIONAL;
 
    void SetRange(int start, int len);
 
    void CopyRange(int start, int len, bitmap &b);
 
    int Value(int index);
 
    int Count();
 
    int Size();
 
    void purge() TRANSACTION_OPTIONAL;
 
    void operator=(bitmap &b) TRANSACTION_OPTIONAL;
 
    int operator!=(bitmap &b); // test for inequality
 
    void print();
 
    void print(FILE *fp);
 
    void print(int fd);
};
 
#endif /* _BITMAP_H_ */