espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-10 04:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[core] add BitVector template class (#5267)

Browse Source
This commit is contained in:
Simon Lin
2020-07-23 00:33:09 -07:00
committed by GitHub
parent 6640e7d865
commit d14a14a494
3 changed files with 144 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/Makefile.am
+1
View File
@@ -323,6 +323,7 @@ HEADERS_COMMON = \
coap/coap.hpp \
coap/coap_message.hpp \
coap/coap_secure.hpp \
common/bit_vector.hpp \
common/clearable.hpp \
common/code_utils.hpp \
common/crc16.hpp \
src/core/common/bit_vector.hpp
+141
View File
@@ -0,0 +1,141 @@
/*
* Copyright (c) 2020, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file includes definitions for a bit-vector.
*/
#ifndef BIT_VECTOR_HPP_
#define BIT_VECTOR_HPP_
#include "openthread-core-config.h"
#include "debug.hpp"
namespace ot {
/**
* @addtogroup core-bit-vector
*
* @brief
* This module includes definitions for bit-vector.
*
* @{
*
*/
/**
* This class represents a bit-vector.
*
* @tparam N Specifies the number of bits.
*
*/
template <uint16_t N> class BitVector : public Equatable<BitVector<N>>
{
public:
/**
* This method indicates whether a given index is included in the mask.
*
* @param[in] aIndex The index.
*
* @retval TRUE If the given index is set.
* @retval FALSE If the given index is clear.
*
*/
bool Get(uint16_t aIndex) const
{
OT_ASSERT(aIndex < N);
return (mMask[aIndex / 8] & (0x80 >> (aIndex % 8))) != 0;
}
/**
* This method sets the mask of a given index.
*
* @param[in] aIndex The index.
*
*/
void Set(uint16_t aIndex)
{
OT_ASSERT(aIndex < N);
mMask[aIndex / 8] |= 0x80 >> (aIndex % 8);
}
/**
* This method clears the mask of a given index.
*
* @param[in] aIndex The index.
*
*/
void Clear(uint16_t aIndex)
{
OT_ASSERT(aIndex < N);
mMask[aIndex / 8] &= ~(0x80 >> (aIndex % 8));
}
/**
* This method clears all indexes.
*
*/
void ClearAll(void) { memset(mMask, 0, sizeof(mMask)); }
/**
* This method returns if any mask is set.
*
* @retval TRUE If any index is set.
* @retval FALSE If all indexes are clear.
*
*/
bool HasAny(void) const
{
bool rval = false;
for (uint8_t b : mMask)
{
if (b != 0)
{
ExitNow(rval = true);
}
}
exit:
return rval;
}
private:
uint8_t mMask[BitVectorBytes(N)];
};
/**
* @}
*
*/
} // namespace ot
#endif // BIT_VECTOR_HPP_
src/core/thread/child_mask.hpp
+2 -78
View File
@@ -36,11 +36,7 @@
#include "openthread-core-config.h"
#include <openthread/error.h>
#include "common/code_utils.hpp"
#include "common/debug.hpp"
#include "common/encoding.hpp"
#include "common/bit_vector.hpp"
namespace ot {
@@ -58,79 +54,7 @@ namespace ot {
* This class represents a bit-vector of child mask.
*
*/
class ChildMask
{
public:
/**
* This method returns if a given Child index is masked.
*
* @param[in] aChildIndex The Child index.
*
* @retval TRUE If the given Child index is set.
* @retval FALSE If the given Child index is clear.
*
*/
bool Get(uint16_t aChildIndex) const
{
OT_ASSERT(aChildIndex < OPENTHREAD_CONFIG_MLE_MAX_CHILDREN);
return (mMask[aChildIndex / 8] & (0x80 >> (aChildIndex % 8))) != 0;
}
/**
* This method sets the mask of a given Child index.
*
* @param[in] aChildIndex The Child index.
*
*/
void Set(uint16_t aChildIndex)
{
OT_ASSERT(aChildIndex < OPENTHREAD_CONFIG_MLE_MAX_CHILDREN);
mMask[aChildIndex / 8] |= 0x80 >> (aChildIndex % 8);
}
/**
* This method clears the mask of a given Child index.
*
* @param[in] aChildIndex The Child index.
*
*/
void Clear(uint16_t aChildIndex)
{
OT_ASSERT(aChildIndex < OPENTHREAD_CONFIG_MLE_MAX_CHILDREN);
mMask[aChildIndex / 8] &= ~(0x80 >> (aChildIndex % 8));
}
/**
* This method returns if any Child mask is set.
*
* @retval TRUE If any Child index is set.
* @retval FALSE If all Child indexes are clear.
*
*/
bool HasAny(void) const
{
bool rval = false;
for (uint8_t b : mMask)
{
if (b != 0)
{
ExitNow(rval = true);
}
}
exit:
return rval;
}
private:
enum
{
kChildMaskBytes = BitVectorBytes(OPENTHREAD_CONFIG_MLE_MAX_CHILDREN)
};
uint8_t mMask[kChildMaskBytes];
};
typedef BitVector<OPENTHREAD_CONFIG_MLE_MAX_CHILDREN> ChildMask;
/**
* @}