summaryrefslogtreecommitdiff
path: root/src/ats/ats2.h
blob: 883ac7c382fae0e1a9dc0bc359dd249f29412434 (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
/*
     This file is part of GNUnet.
     Copyright (C) 2010-2015 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/>.
*/
/**
 * @file ats/ats.h
 * @brief automatic transport selection messages
 * @author Christian Grothoff
 * @author Matthias Wachs
 */
#ifndef ATS_H
#define ATS_H

#include "gnunet_util_lib.h"
#include "gnunet_ats_transport_service.h"


GNUNET_NETWORK_STRUCT_BEGIN


/**
 * ATS performance characteristics for an address.
 */
struct PropertiesNBO
{

  /**
   * Delay.  Time between when the time packet is sent and the packet
   * arrives.  FOREVER if we did not (successfully) measure yet.
   */
  struct GNUNET_TIME_RelativeNBO delay;

  /**
   * Confirmed successful payload on this connection from this peer to
   * the other peer. In NBO.
   *
   * Unit: [bytes/second]
   */
  uint32_t goodput_out;

  /**
   * Confirmed useful payload on this connection to this peer from
   * the other peer. In NBO.
   *
   * Unit: [bytes/second]
   */
  uint32_t goodput_in;

  /**
   * Actual traffic on this connection from this peer to the other peer.
   * Includes transport overhead. In NBO.
   *
   * Unit: [bytes/second]
   */
  uint32_t utilization_out;

  /**
   * Actual traffic on this connection from the other peer to this peer.
   * Includes transport overhead. In NBO.
   *
   * Unit: [bytes/second]
   */
  uint32_t utilization_in;

  /**
   * Distance on network layer (required for distance-vector routing)
   * in hops.  Zero for direct connections (i.e. plain TCP/UDP). In NBO.
   */
  uint32_t distance;

  /**
   * MTU of the network layer, UINT32_MAX for no MTU (stream).
   *
   * Unit: [bytes]. In NBO.
   */
  uint32_t mtu;

  /**
   * Which network scope does the respective address belong to?
   * A `enum GNUNET_NetworkType nt` in NBO.
   */
  uint32_t nt;

  /**
   * What characteristics does this communicator have?
   * A `enum GNUNET_TRANSPORT_CommunicatorCharacteristics` in NBO.
   */
  uint32_t cc;

};


/**
 * Application client to ATS service: we would like to have
 * address suggestions for this peer.
 */
struct ExpressPreferenceMessage
{
  /**
   * Type is #GNUNET_MESSAGE_TYPE_ATS_SUGGEST or
   * #GNUNET_MESSAGE_TYPE_ATS_SUGGEST_CANCEL to stop
   * suggestions.
   */
  struct GNUNET_MessageHeader header;

  /**
   * What type of performance preference does the client have?
   */
  uint32_t pk GNUNET_PACKED;

  /**
   * Peer to get address suggestions for.
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * How much bandwidth in bytes/second does the application expect?
   */
  struct GNUNET_BANDWIDTH_Value32NBO bw;

};


/**
 * Transport client to ATS service: here is another session you can use.
 */
struct SessionAddMessage
{
  /**
   * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_ADD or
   * #GNUNET_MESSAGE_TYPE_ATS_SESSION_ADD_INBOUND_ONLY
   */
  struct GNUNET_MessageHeader header;

  /**
   * Internal number this client will henceforth use to
   * refer to this session.
   */
  uint32_t session_id GNUNET_PACKED;

  /**
   * Identity of the peer that this session is for.
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * Performance properties of the session.
   */
  struct PropertiesNBO properties;

  /* followed by:
   * - char * address (including '\0'-termination).
   */

};


/**
 * Message used to notify ATS that the performance
 * characteristics for an session have changed.
 */
struct SessionUpdateMessage
{
  /**
   * Message of type #GNUNET_MESSAGE_TYPE_ATS_SESSION_UPDATE.
   */
  struct GNUNET_MessageHeader header;

  /**
   * Internal number this client uses to refer to this session.
   */
  uint32_t session_id GNUNET_PACKED;

  /**
   * Which peer is this about? (Technically redundant, as the
   * @e session_id should be sufficient, but enables ATS service
   * to find the session faster).
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * Performance properties of the session.
   */
  struct PropertiesNBO properties;

};


/**
 * Message sent by ATS client to ATS service when an session
 * was destroyed and must thus henceforth no longer be considered
 * for scheduling.
 */
struct SessionDelMessage
{
  /**
   * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_DEL.
   */
  struct GNUNET_MessageHeader header;

  /**
   * Internal number this client uses to refer to this session.
   */
  uint32_t session_id GNUNET_PACKED;

  /**
   * Which peer is this about? (Technically redundant, as the
   * @e session_id should be sufficient, but enables ATS service
   * to find the session faster).
   */
  struct GNUNET_PeerIdentity peer;

};


/**
 * ATS Service allocates resources to an session
 * identified by the given @e session_id for the given @e peer with
 * the given @e bandwidth_in and @e bandwidth_out limits from now on.
 */
struct SessionAllocationMessage
{
  /**
   * A message of type #GNUNET_MESSAGE_TYPE_ATS_SESSION_ALLOCATION.
   */
  struct GNUNET_MessageHeader header;

  /**
   * Internal number this client uses to refer to the session this
   * suggestion is about.
   */
  uint32_t session_id GNUNET_PACKED;

  /**
   * Which peer is this about? (Technically redundant, as the
   * @e session_id should be sufficient, but may enable client
   * to find the session faster and/or check consistency).
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * How much bandwidth we are allowed for sending.
   */
  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;

  /**
   * How much bandwidth we are allowed for receiving.
   */
  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;

};


/**
 * ATS Service suggests to the transport service to try the address
 * for the given @e peer.
 */
struct AddressSuggestionMessage
{
  /**
   * A message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION.
   */
  struct GNUNET_MessageHeader header;

  /**
   * Zero.
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Which peer is this about? (Technically redundant, as the
   * @e session_id should be sufficient, but may enable client
   * to find the session faster and/or check consistency).
   */
  struct GNUNET_PeerIdentity peer;

  /* Followed by 0-terminated address */
};


GNUNET_NETWORK_STRUCT_END



#endif