552c9ca5a0
WHAT: Open our low-level communication infrastructure by moving all necessary components (btl/rcache/allocator/mpool) down in OPAL All the components required for inter-process communications are currently deeply integrated in the OMPI layer. Several groups/institutions have express interest in having a more generic communication infrastructure, without all the OMPI layer dependencies. This communication layer should be made available at a different software level, available to all layers in the Open MPI software stack. As an example, our ORTE layer could replace the current OOB and instead use the BTL directly, gaining access to more reactive network interfaces than TCP. Similarly, external software libraries could take advantage of our highly optimized AM (active message) communication layer for their own purpose. UTK with support from Sandia, developped a version of Open MPI where the entire communication infrastucture has been moved down to OPAL (btl/rcache/allocator/mpool). Most of the moved components have been updated to match the new schema, with few exceptions (mainly BTLs where I have no way of compiling/testing them). Thus, the completion of this RFC is tied to being able to completing this move for all BTLs. For this we need help from the rest of the Open MPI community, especially those supporting some of the BTLs. A non-exhaustive list of BTLs that qualify here is: mx, portals4, scif, udapl, ugni, usnic. This commit was SVN r32317.
259 строки
7.8 KiB
C
259 строки
7.8 KiB
C
/* -*- Mode: C; c-basic-offset:4 ; -*- */
|
|
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
|
|
* University Research and Technology
|
|
* Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2014 The University of Tennessee and The University
|
|
* of Tennessee Research Foundation. All rights
|
|
* reserved.
|
|
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
|
|
* University of Stuttgart. All rights reserved.
|
|
* Copyright (c) 2004-2005 The Regents of the University of California.
|
|
* All rights reserved.
|
|
* Copyright (c) 2007 Cisco Systems, Inc. All rights reserved.
|
|
* Copyright (c) 2010-2012 Oak Ridge National Labs. All rights reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*
|
|
*/
|
|
|
|
/** @file
|
|
*
|
|
* 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.
|
|
*
|
|
* To allow these bitmaps to track fortran handles (which MPI defines
|
|
* to be Fortran INTEGER), we offer a opal_bitmap_set_max_size, so that
|
|
* the upper layer can ask to never have more than
|
|
* OMPI_FORTRAN_HANDLE_MAX, which is min(INT_MAX, fortran INTEGER max).
|
|
*/
|
|
|
|
#ifndef OPAL_BITMAP_H
|
|
#define OPAL_BITMAP_H
|
|
|
|
#include "opal_config.h"
|
|
|
|
#include <string.h>
|
|
|
|
#include "opal/class/opal_object.h"
|
|
|
|
BEGIN_C_DECLS
|
|
|
|
struct opal_bitmap_t {
|
|
opal_object_t super; /**< Subclass of opal_object_t */
|
|
uint64_t *bitmap; /**< The actual bitmap array of characters */
|
|
int array_size; /**< The actual array size that maintains the bitmap */
|
|
int max_size; /**< The maximum size that this bitmap may grow (optional) */
|
|
};
|
|
|
|
typedef struct opal_bitmap_t opal_bitmap_t;
|
|
|
|
OPAL_DECLSPEC OBJ_CLASS_DECLARATION(opal_bitmap_t);
|
|
|
|
/**
|
|
* Set the maximum size of the bitmap.
|
|
* May be reset any time, but HAS TO BE SET BEFORE opal_bitmap_init!
|
|
*
|
|
* @param bitmap The input bitmap (IN)
|
|
* @param max_size The maximum size of the bitmap in terms of bits (IN)
|
|
* @return OPAL error code or success
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_set_max_size (opal_bitmap_t *bm, int max_size);
|
|
|
|
|
|
/**
|
|
* 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)
|
|
* @return OPAL error code or success
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_init (opal_bitmap_t *bm, int size);
|
|
|
|
|
|
/**
|
|
* 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)
|
|
* @return OPAL error code or success
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_set_bit(opal_bitmap_t *bm, int bit);
|
|
|
|
|
|
/**
|
|
* 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)
|
|
* @return OPAL error code if the bit is out of range, else success
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_clear_bit(opal_bitmap_t *bm, int bit);
|
|
|
|
|
|
/**
|
|
* 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)
|
|
* @return true if the bit is set
|
|
* false if the bit is not set OR the index
|
|
* is outside the bounds of the provided
|
|
* bitmap
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC bool opal_bitmap_is_set_bit(opal_bitmap_t *bm, int bit);
|
|
|
|
|
|
/**
|
|
* Find the first clear bit in the bitmap and set it
|
|
*
|
|
* @param bitmap The input bitmap (IN)
|
|
* @param position Position of the first clear bit (OUT)
|
|
|
|
* @return err OPAL_SUCCESS on success
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_find_and_set_first_unset_bit(opal_bitmap_t *bm,
|
|
int *position);
|
|
|
|
|
|
/**
|
|
* Clear all bits in the bitmap
|
|
*
|
|
* @param bitmap The input bitmap (IN)
|
|
* @return OPAL error code if bm is NULL
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_clear_all_bits(opal_bitmap_t *bm);
|
|
|
|
|
|
/**
|
|
* Set all bits in the bitmap
|
|
* @param bitmap The input bitmap (IN)
|
|
* @return OPAL error code if bm is NULL
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_set_all_bits(opal_bitmap_t *bm);
|
|
|
|
|
|
/**
|
|
* Gives the current size (number of bits) in the bitmap. This is the
|
|
* legal (accessible) number of bits
|
|
*
|
|
* @param bitmap The input bitmap (IN)
|
|
* @return OPAL error code if bm is NULL
|
|
*
|
|
*/
|
|
static inline int opal_bitmap_size(opal_bitmap_t *bm)
|
|
{
|
|
return (NULL == bm) ? 0 : (bm->array_size * ((int) (sizeof(*bm->bitmap) * 8)));
|
|
}
|
|
|
|
|
|
/**
|
|
* Copy a bitmap
|
|
*
|
|
* @param dest Pointer to the destination bitmap
|
|
* @param src Pointer to the source bitmap
|
|
* @ return OPAL error code if something goes wrong
|
|
*/
|
|
static inline void opal_bitmap_copy(opal_bitmap_t *dest, opal_bitmap_t *src)
|
|
{
|
|
if( dest->array_size < src->array_size ) {
|
|
if( NULL != dest->bitmap) free(dest->bitmap);
|
|
dest->max_size = src->max_size;
|
|
dest->bitmap = (uint64_t*)malloc(src->array_size*sizeof(uint64_t));
|
|
}
|
|
memcpy(dest->bitmap, src->bitmap, src->array_size * sizeof(uint64_t));
|
|
dest->array_size = src->array_size;
|
|
}
|
|
|
|
/**
|
|
* Bitwise AND operator (inplace)
|
|
*
|
|
* @param dest Pointer to the bitmap that should be modified
|
|
* @param right Point to the other bitmap in the operation
|
|
* @return OPAL error code if the length of the two bitmaps is not equal or one is NULL.
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_bitwise_and_inplace(opal_bitmap_t *dest, opal_bitmap_t *right);
|
|
|
|
/**
|
|
* Bitwise OR operator (inplace)
|
|
*
|
|
* @param dest Pointer to the bitmap that should be modified
|
|
* @param right Point to the other bitmap in the operation
|
|
* @return OPAL error code if the length of the two bitmaps is not equal or one is NULL.
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_bitwise_or_inplace(opal_bitmap_t *dest, opal_bitmap_t *right);
|
|
|
|
/**
|
|
* Bitwise XOR operator (inplace)
|
|
*
|
|
* @param dest Pointer to the bitmap that should be modified
|
|
* @param right Point to the other bitmap in the operation
|
|
* @return OPAL error code if the length of the two bitmaps is not equal or one is NULL.
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_bitwise_xor_inplace(opal_bitmap_t *dest, opal_bitmap_t *right);
|
|
|
|
/**
|
|
* If the bitmaps are different
|
|
*
|
|
* @param left Pointer to a bitmap
|
|
* @param right Pointer to another bitmap
|
|
* @return true if different, false if the same
|
|
*/
|
|
OPAL_DECLSPEC bool opal_bitmap_are_different(opal_bitmap_t *left, opal_bitmap_t *right);
|
|
|
|
/**
|
|
* Get a string representation of the bitmap.
|
|
* Useful for debugging.
|
|
*
|
|
* @param bitmap Point to the bitmap to represent
|
|
* @return Pointer to the string (caller must free if not NULL)
|
|
*/
|
|
OPAL_DECLSPEC char * opal_bitmap_get_string(opal_bitmap_t *bitmap);
|
|
|
|
/**
|
|
* Return the number of 'unset' bits, upto the specified length
|
|
*
|
|
* @param bitmap Pointer to the bitmap
|
|
* @param len Number of bits to check
|
|
* @return Integer
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_num_unset_bits(opal_bitmap_t *bm, int len);
|
|
|
|
/**
|
|
* Return the number of 'set' bits, upto the specified length
|
|
*
|
|
* @param bitmap Pointer to the bitmap
|
|
* @param len Number of bits to check
|
|
* @return Integer
|
|
*/
|
|
OPAL_DECLSPEC int opal_bitmap_num_set_bits(opal_bitmap_t *bm, int len);
|
|
|
|
/**
|
|
* Check a bitmap to see if any bit is set
|
|
*/
|
|
OPAL_DECLSPEC bool opal_bitmap_is_clear(opal_bitmap_t *bm);
|
|
|
|
END_C_DECLS
|
|
|
|
#endif
|