gnunet-service-set.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2013-2017 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_SERVICE_SET_H_PRIVATE
#define GNUNET_SERVICE_SET_H_PRIVATE
 
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_applications.h"
#include "gnunet_core_service.h"
#include "gnunet_cadet_service.h"
#include "gnunet_set_service.h"
#include "set.h"
 
 
struct SetState;
 
struct OperationState;
 
struct Set;
 
struct ElementEntry;
 
struct Operation;
 
 
typedef struct SetState *
(*SetCreateImpl) (void);
 
 
typedef void
(*SetAddRemoveImpl) (struct SetState *state,
                     struct ElementEntry *ee);
 
 
typedef struct SetState *
(*SetCopyStateImpl) (struct SetState *state);
 
 
typedef void
(*SetDestroyImpl) (struct SetState *state);
 
 
typedef struct OperationState *
(*OpAcceptImpl) (struct Operation *op);
 
 
typedef struct OperationState *
(*OpEvaluateImpl) (struct Operation *op,
                   const struct GNUNET_MessageHeader *opaque_context);
 
typedef void
(*OpCancelImpl) (struct Operation *op);
 
 
typedef void
(*OpChannelDeathImpl) (struct Operation *op);
 
 
struct SetVT
{
  SetCreateImpl create;
 
  SetAddRemoveImpl add;
 
  SetAddRemoveImpl remove;
 
  SetCopyStateImpl copy_state;
 
  SetDestroyImpl destroy_set;
 
  OpAcceptImpl accept;
 
  OpEvaluateImpl evaluate;
 
  OpCancelImpl cancel;
 
  OpChannelDeathImpl channel_death;
};
 
 
struct MutationEvent
{
  unsigned int generation;
 
  int added;
};
 
 
struct ElementEntry
{
  struct GNUNET_SET_Element element;
 
  struct GNUNET_HashCode element_hash;
 
  struct MutationEvent *mutations;
 
  unsigned int mutations_size;
 
  int remote;
};
 
 
struct Listener;
 
 
struct ClientState
{
  struct Set *set;
 
  struct Listener *listener;
 
  struct GNUNET_SERVICE_Client *client;
 
  struct GNUNET_MQ_Handle *mq;
};
 
 
struct Operation
{
  struct Operation *next;
 
  struct Operation *prev;
 
  struct GNUNET_CADET_Channel *channel;
 
  struct Listener *listener;
 
  struct GNUNET_MQ_Handle *mq;
 
  struct GNUNET_MessageHeader *context_msg;
 
  struct Set *set;
 
  struct OperationState *state;
 
  struct GNUNET_PeerIdentity peer;
 
  struct GNUNET_SCHEDULER_Task *timeout_task;
 
  uint32_t salt;
 
  uint32_t remote_element_count;
 
  uint32_t client_request_id;
 
  enum GNUNET_SET_ResultMode result_mode;
 
  int force_delta;
 
  int force_full;
 
  int byzantine;
 
  int byzantine_lower_bound;
 
  uint32_t suggest_id;
 
  unsigned int generation_created;
};
 
 
struct SetContent
{
  struct GNUNET_CONTAINER_MultiHashMap *elements;
 
  struct PendingMutation *pending_mutations_head;
 
  struct PendingMutation *pending_mutations_tail;
 
  unsigned int refcount;
 
  unsigned int latest_generation;
 
  int iterator_count;
};
 
 
struct GenerationRange
{
  unsigned int start;
 
  unsigned int end;
};
 
 
struct PendingMutation
{
  struct PendingMutation *prev;
 
  struct PendingMutation *next;
 
  struct Set *set;
 
  struct GNUNET_SET_ElementMessage *msg;
};
 
 
struct Set
{
  struct Set *next;
 
  struct Set *prev;
 
  struct ClientState *cs;
 
  struct SetContent *content;
 
  const struct SetVT *vt;
 
  struct SetState *state;
 
  struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
 
  struct Operation *ops_head;
 
  struct Operation *ops_tail;
 
  struct GenerationRange *excluded_generations;
 
  unsigned int current_generation;
 
  unsigned int excluded_generations_size;
 
  enum GNUNET_SET_OperationType operation;
 
  unsigned int iter_generation;
 
  uint16_t iteration_id;
};
 
 
extern struct GNUNET_STATISTICS_Handle *_GSS_statistics;
 
 
void
_GSS_operation_destroy (struct Operation *op,
                        int gc);
 
 
void
_GSS_operation_destroy2 (struct Operation *op);
 
 
const struct SetVT *
_GSS_union_vt (void);
 
 
const struct SetVT *
_GSS_intersection_vt (void);
 
 
int
_GSS_is_element_of_operation (struct ElementEntry *ee,
                              struct Operation *op);
 
 
#endif