ibf.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2012 GNUnet e.V.
 
      GNUnet is free software: you can redistribute it and/or modify it
      under the terms of the GNU Affero General Public License as published
      by the Free Software Foundation, either version 3 of the License,
      or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Affero General Public License for more details.
 
      You should have received a copy of the GNU Affero General Public License
      along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_CONSENSUS_IBF_H
#define GNUNET_CONSENSUS_IBF_H
 
#include "platform.h"
#include "gnunet_util_lib.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
struct IBF_Key
{
  uint64_t key_val;
};
 
 
struct IBF_KeyHash
{
  uint32_t key_hash_val;
};
 
 
struct IBF_Count
{
  int64_t count_val;
};
 
 
#define IBF_BUCKET_SIZE (sizeof(struct IBF_Count) + sizeof(struct IBF_Key)   \
                         + sizeof(struct IBF_KeyHash))
 
 
struct InvertibleBloomFilter
{
  uint32_t size;
 
  uint8_t hash_num;
 
  int local_decoded_count;
 
  int remote_decoded_count;
 
  struct IBF_Key *key_sum;
 
  struct IBF_KeyHash *key_hash_sum;
 
  struct IBF_Count *count;
};
 
 
void
ibf_write_slice (const struct InvertibleBloomFilter *ibf,
                 uint32_t start,
                 uint64_t count,
                 void *buf,
                 uint8_t counter_max_length);
 
 
void
ibf_read_slice (const void *buf,
                uint32_t start,
                uint64_t count,
                struct InvertibleBloomFilter *ibf,
                uint8_t counter_max_length);
 
 
struct IBF_Key
ibf_key_from_hashcode (const struct GNUNET_HashCode *hash);
 
 
void
ibf_hashcode_from_key (struct IBF_Key key, struct GNUNET_HashCode *dst);
 
 
struct InvertibleBloomFilter *
ibf_create (uint32_t size, uint8_t hash_num);
 
 
void
ibf_insert (struct InvertibleBloomFilter *ibf, struct IBF_Key key);
 
 
void
ibf_remove (struct InvertibleBloomFilter *ibf, struct IBF_Key key);
 
 
void
ibf_subtract (struct InvertibleBloomFilter *ibf1,
              const struct InvertibleBloomFilter *ibf2);
 
 
int
ibf_decode (struct InvertibleBloomFilter *ibf,
            int *ret_side,
            struct IBF_Key *ret_id);
 
 
struct InvertibleBloomFilter *
ibf_dup (const struct InvertibleBloomFilter *ibf);
 
 
void
ibf_destroy (struct InvertibleBloomFilter *ibf);
 
uint8_t
ibf_get_max_counter (struct InvertibleBloomFilter *ibf);
 
 
void
pack_counter (const struct InvertibleBloomFilter *ibf,
              uint32_t start,
              uint64_t count,
              uint8_t *buf,
              uint8_t counter_max_length);
 
void
unpack_counter (const struct InvertibleBloomFilter *ibf,
                uint32_t start,
                uint64_t count,
                uint8_t *buf,
                uint8_t counter_max_length);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif