third_party/ot-br-posix/repo/src/utils/steering_data.hpp

   1 /*
   2  *  Copyright (c) 2017-2018, The OpenThread Authors.
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions are met:
   7  *  1. Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  *  2. Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *  3. Neither the name of the copyright holder nor the
  13  *     names of its contributors may be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  *  POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /**
  30  * @file
  31  *   This file provides commissioner steering data calculations
  32  */
  33
  34 #ifndef OTBR_UTILS_STEERING_DATA_HPP_
  35 #define OTBR_UTILS_STEERING_DATA_HPP_
  36
  37 #include "openthread-br/config.h"
  38
  39 #include <stdint.h>
  40 #include <string.h>
  41
  42 namespace otbr {
  43
  44 /**
  45  * This class represents Steering Data
  46  *
  47  */
  48 class SteeringData
  49 {
  50 public:
  51     enum
  52     {
  53         kMaxSizeOfBloomFilter = 16, ///< Max length of bloom filter in bytes.
  54         kSizeJoinerId         = 8,  ///< Size of Extended Joiner ID.
  55     };
  56
  57     /**
  58      * This method initializes the bloom filter.
  59      *
  60      * @param[in]   aLength         Length of the bloom filter in bytes.
  61      *
  62      */
  63     void Init(uint8_t aLength);
  64
  65     /**
  66      * This method sets all bits in the bloom filter to zero.
  67      *
  68      */
  69     void Clear(void) { memset(mBloomFilter, 0, sizeof(mBloomFilter)); }
  70
  71     /**
  72      * Ths method sets all bits in the bloom filter to one.
  73      *
  74      */
  75     void Set(void) { memset(mBloomFilter, 0xff, sizeof(mBloomFilter)); }
  76
  77     /**
  78      * This method sets bit @p aBit.
  79      *
  80      * @param[in]  aBit  The bit offset.
  81      *
  82      */
  83     void SetBit(uint8_t aBit) { mBloomFilter[mLength - 1 - (aBit / 8)] |= 1 << (aBit % 8); }
  84
  85     /**
  86      * This method computes the Bloom Filter.
  87      *
  88      * @param[in]  aJoinerId  Extended address
  89      *
  90      */
  91     void ComputeBloomFilter(const uint8_t *aJoinerId);
  92
  93     /**
  94      * This method computes joiner id from EUI64.
  95      *
  96      * @param[in]   aEui64      A pointer to EUI64.
  97      * @param[out]  aJoinerId   A pointer to receive joiner id. This pointer can be the same as @p aEui64.
  98      *
  99      */
 100     static void ComputeJoinerId(const uint8_t *aEui64, uint8_t *aJoinerId);
 101
 102     /**
 103      * This method returns a pointer to the bloom filter.
 104      *
 105      * @returns A pointer to the computed bloom filter.
 106      *
 107      */
 108     const uint8_t *GetBloomFilter(void) const { return mBloomFilter; }
 109
 110     /**
 111      * This method returns the length of the bloom filter.
 112      *
 113      */
 114     uint8_t GetLength(void) const { return mLength; }
 115
 116 private:
 117     uint8_t mBloomFilter[kMaxSizeOfBloomFilter];
 118     uint8_t mLength;
 119 };
 120
 121 } /* namespace otbr */
 122
 123 #endif // OTBR_UTILS_STEERING_DATA_HPP_