2004-03-17 02:19:10 +03:00
|
|
|
/*
|
2004-11-22 04:38:40 +03:00
|
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University.
|
|
|
|
* All rights reserved.
|
|
|
|
* Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
|
|
|
|
* All rights reserved.
|
2004-11-28 23:09:25 +03:00
|
|
|
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
|
|
|
|
* University of Stuttgart. All rights reserved.
|
2005-03-24 15:43:37 +03:00
|
|
|
* Copyright (c) 2004-2005 The Regents of the University of California.
|
|
|
|
* All rights reserved.
|
2004-11-22 04:38:40 +03:00
|
|
|
* $COPYRIGHT$
|
|
|
|
*
|
|
|
|
* Additional copyrights may follow
|
|
|
|
*
|
2004-03-17 02:19:10 +03:00
|
|
|
* $HEADER$
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** @file
|
|
|
|
*
|
2004-04-12 01:15:09 +04:00
|
|
|
* A bitmap implementation. The bits start off with 0, so this bitmap
|
|
|
|
* has bits numbered as bit 0, bit 1, bit 2 and so on. This bitmap
|
|
|
|
* has auto-expansion capabilities, that is once the size is set
|
|
|
|
* during init, it can be automatically expanded by setting the bit
|
|
|
|
* beyond the current size. But note, this is allowed just when the
|
|
|
|
* bit is set -- so the valid functions are set_bit and
|
|
|
|
* find_and_set_bit. Other functions like clear, if passed a bit
|
|
|
|
* outside the initialized range will result in an error.
|
2004-10-23 23:24:00 +04:00
|
|
|
*
|
|
|
|
* Since these bitmaps are only used to track fortran handles (which
|
|
|
|
* MPI defines to be int's), it is assumed that we can never have more
|
|
|
|
* than OMPI_FORTRAN_HANDLE_MAX (which is min(INT_MAX, fortran
|
|
|
|
* INTEGER max)).
|
2004-03-17 02:19:10 +03:00
|
|
|
*/
|
|
|
|
|
2004-06-07 19:33:53 +04:00
|
|
|
#ifndef OMPI_BITMAP_H
|
|
|
|
#define OMPI_BITMAP_H
|
2004-03-17 02:19:10 +03:00
|
|
|
|
2004-10-23 23:24:00 +04:00
|
|
|
#include "ompi_config.h"
|
|
|
|
|
2004-03-17 02:19:10 +03:00
|
|
|
#include <string.h>
|
|
|
|
|
2004-03-19 00:35:28 +03:00
|
|
|
#include "include/types.h"
|
2004-06-07 19:33:53 +04:00
|
|
|
#include "class/ompi_object.h"
|
2004-03-17 02:19:10 +03:00
|
|
|
|
2004-10-21 02:31:03 +04:00
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
2004-06-07 19:33:53 +04:00
|
|
|
struct ompi_bitmap_t {
|
|
|
|
ompi_object_t super; /**< Subclass of ompi_object_t */
|
2004-04-12 01:15:09 +04:00
|
|
|
unsigned char *bitmap; /**< The actual bitmap array of characters */
|
2004-10-23 23:24:00 +04:00
|
|
|
int array_size; /**< The actual array size that maintains the bitmap */
|
|
|
|
int legal_numbits; /**< The number of bits which are legal (the
|
2004-04-12 01:15:09 +04:00
|
|
|
actual bitmap may contain more bits, since
|
|
|
|
it needs to be rounded to the nearest
|
|
|
|
char */
|
2004-03-17 02:19:10 +03:00
|
|
|
};
|
|
|
|
|
2004-06-07 19:33:53 +04:00
|
|
|
typedef struct ompi_bitmap_t ompi_bitmap_t;
|
2004-03-17 02:19:10 +03:00
|
|
|
|
2004-10-22 20:06:05 +04:00
|
|
|
OMPI_DECLSPEC OBJ_CLASS_DECLARATION(ompi_bitmap_t);
|
2004-10-20 03:53:55 +04:00
|
|
|
|
2004-03-17 02:19:10 +03:00
|
|
|
/**
|
|
|
|
* Initializes the bitmap and sets its size. This must be called
|
|
|
|
* before the bitmap can be actually used
|
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
|
|
|
* @param size The initial size of the bitmap in terms of bits (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code or success
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
*/
|
2004-10-23 23:24:00 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_init (ompi_bitmap_t *bm, int size);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set a bit of the bitmap. If the bit asked for is beyond the current
|
|
|
|
* size of the bitmap, then the bitmap is extended to accomodate the
|
|
|
|
* bit
|
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
|
|
|
* @param bit The bit which is to be set (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code or success
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
*/
|
2004-10-23 23:24:00 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_set_bit(ompi_bitmap_t *bm, int bit);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Clear/unset a bit of the bitmap. If the bit is beyond the current
|
|
|
|
* size of the bitmap, an error is returned
|
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
|
|
|
* @param bit The bit which is to be cleared (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code if the bit is out of range, else success
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
*/
|
2004-10-23 23:24:00 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_clear_bit(ompi_bitmap_t *bm, int bit);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Find out if a bit is set in the bitmap
|
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
|
|
|
* @param bit The bit which is to be checked (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code if the bit is out of range
|
2004-03-17 02:19:10 +03:00
|
|
|
* 1 if the bit is set
|
|
|
|
* 0 if the bit is not set
|
|
|
|
*
|
|
|
|
*/
|
2004-10-23 23:24:00 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_is_set_bit(ompi_bitmap_t *bm, int bit);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Find the first clear bit in the bitmap and set it
|
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
2004-10-20 03:53:55 +04:00
|
|
|
* @param position Position of the first clear bit (OUT)
|
|
|
|
|
|
|
|
* @return err OMPI_SUCCESS on success
|
2004-03-17 02:19:10 +03:00
|
|
|
*/
|
2004-10-22 20:06:05 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_find_and_set_first_unset_bit(ompi_bitmap_t *bm,
|
2004-10-23 23:24:00 +04:00
|
|
|
int *position);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Clear all bits in the bitmap
|
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code if bm is NULL
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
*/
|
2004-10-22 20:06:05 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_clear_all_bits(ompi_bitmap_t *bm);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set all bits in the bitmap
|
|
|
|
* @param bitmap The input bitmap (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code if bm is NULL
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
*/
|
2004-10-22 20:06:05 +04:00
|
|
|
OMPI_DECLSPEC int ompi_bitmap_set_all_bits(ompi_bitmap_t *bm);
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
2004-04-12 01:15:09 +04:00
|
|
|
* Gives the current size (number of bits) in the bitmap. This is the
|
|
|
|
* legal (accessible) number of bits
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
* @param bitmap The input bitmap (IN)
|
2004-06-07 19:33:53 +04:00
|
|
|
* @return OMPI error code if bm is NULL
|
2004-03-17 02:19:10 +03:00
|
|
|
*
|
|
|
|
*/
|
2004-10-23 23:24:00 +04:00
|
|
|
static inline int ompi_bitmap_size(ompi_bitmap_t *bm)
|
2004-10-20 03:53:55 +04:00
|
|
|
{
|
|
|
|
return (NULL == bm) ? 0 : bm->legal_numbits;
|
|
|
|
}
|
2004-03-17 02:19:10 +03:00
|
|
|
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif
|