summaryrefslogtreecommitdiff
path: root/src/consensus/consensus_protocol.h
blob: f2933ed6f8cb32c1c6e211436e2a6373791774f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
      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 General Public License as published
      by the Free Software Foundation; either version 3, 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
      General Public License for more details.

      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
      Boston, MA 02110-1301, USA.
*/


/**
 * @file consensus/consensus_protocol.h
 * @brief p2p message definitions for consensus
 * @author Florian Dold
 */

#ifndef GNUNET_CONSENSUS_PROTOCOL_H
#define GNUNET_CONSENSUS_PROTOCOL_H

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_common.h"
#include "gnunet_protocols.h"


GNUNET_NETWORK_STRUCT_BEGIN

/**
 * Sent as context message for set reconciliation.
 *
 * Essentially contains all the fields
 * from 'struct TaskKey', but in NBO.
 */
struct GNUNET_CONSENSUS_RoundContextMessage
{
  /**
   * Type: #GNUNET_MESSAGE_TYPE_CONSENSUS_P2P_ROUND_CONTEXT
   */
  struct GNUNET_MessageHeader header;

  /**
   * A value from 'enum PhaseKind'.
   */
  uint16_t kind GNUNET_PACKED;

  /**
   * Number of the first peer
   * in canonical order.
   */
  int16_t peer1 GNUNET_PACKED;

  /**
   * Number of the second peer in canonical order.
   */
  int16_t peer2 GNUNET_PACKED;

  /**
   * Repetition of the gradecast phase.
   */
  int16_t repetition GNUNET_PACKED;

  /**
   * Leader in the gradecast phase.
   *
   * Can be different from both peer1 and peer2.
   */
  int16_t leader GNUNET_PACKED;

  /**
   * Non-zero if this set reconciliation
   * had elements removed because they were contested.
   *
   * Will be considered when grading broadcasts.
   *
   * Ignored for set operations that are not within gradecasts.
   */
  uint16_t is_contested GNUNET_PACKED;
};


enum {
  CONSENSUS_MARKER_CONTESTED = 1,
  CONSENSUS_MARKER_SIZE = 2,
};


/**
 * Consensus element, either marker or payload.
 */
struct ConsensusElement
{
  /**
   * Payload element_type, only valid
   * if this is not a marker element.
   */
  uint16_t payload_type GNUNET_PACKED;

  /**
   * Is this a marker element?
   */
  uint8_t marker;

  /* rest: element data */
};


struct ConsensusSizeElement
{
  struct ConsensusElement ce;

  uint64_t size GNUNET_PACKED;
  uint8_t sender_index;
};

struct ConsensusStuffedElement
{
  struct ConsensusElement ce;
  struct GNUNET_HashCode rand GNUNET_PACKED;
};


GNUNET_NETWORK_STRUCT_END

#endif