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
|
/*
* ngtcp2
*
* Copyright (c) 2017 ngtcp2 contributors
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef NGTCP2_ROB_H
#define NGTCP2_ROB_H
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* HAVE_CONFIG_H */
#include <ngtcp2/ngtcp2.h>
#include "ngtcp2_mem.h"
#include "ngtcp2_range.h"
#include "ngtcp2_ksl.h"
/*
* ngtcp2_rob_gap represents the gap, which is the range of stream
* data that is not received yet.
*/
typedef struct ngtcp2_rob_gap {
/* range is the range of this gap. */
ngtcp2_range range;
} ngtcp2_rob_gap;
/*
* ngtcp2_rob_gap_new allocates new ngtcp2_rob_gap object, and assigns
* its pointer to |*pg|. The caller should call ngtcp2_rob_gap_del to
* delete it when it is no longer used. The range of the gap is
* [begin, end). |mem| is custom memory allocator to allocate memory.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGTCP2_ERR_NOMEM
* Out of memory.
*/
int ngtcp2_rob_gap_new(ngtcp2_rob_gap **pg, uint64_t begin, uint64_t end,
const ngtcp2_mem *mem);
/*
* ngtcp2_rob_gap_del deallocates |g|. It deallocates the memory
* pointed by |g| it self. |mem| is custom memory allocator to
* deallocate memory.
*/
void ngtcp2_rob_gap_del(ngtcp2_rob_gap *g, const ngtcp2_mem *mem);
/*
* ngtcp2_rob_data holds the buffered stream data.
*/
typedef struct ngtcp2_rob_data {
/* range is the range of this gap. */
ngtcp2_range range;
/* begin points to the buffer. */
uint8_t *begin;
/* end points to the one beyond of the last byte of the buffer */
uint8_t *end;
} ngtcp2_rob_data;
/*
* ngtcp2_rob_data_new allocates new ngtcp2_rob_data object, and
* assigns its pointer to |*pd|. The caller should call
* ngtcp2_rob_data_del to delete it when it is no longer used.
* |offset| is the stream offset of the first byte of this data.
* |chunk| is the size of the buffer. |offset| must be multiple of
* |chunk|. |mem| is custom memory allocator to allocate memory.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGTCP2_ERR_NOMEM
* Out of memory.
*/
int ngtcp2_rob_data_new(ngtcp2_rob_data **pd, uint64_t offset, size_t chunk,
const ngtcp2_mem *mem);
/*
* ngtcp2_rob_data_del deallocates |d|. It deallocates the memory
* pointed by |d| itself. |mem| is custom memory allocator to
* deallocate memory.
*/
void ngtcp2_rob_data_del(ngtcp2_rob_data *d, const ngtcp2_mem *mem);
/*
* ngtcp2_rob is the reorder buffer which reassembles stream data
* received in out of order.
*/
typedef struct ngtcp2_rob {
/* gapksl maintains the range of offset which is not received
yet. Initially, its range is [0, UINT64_MAX). */
ngtcp2_ksl gapksl;
/* dataksl maintains the list of buffers which store received data
ordered by stream offset. */
ngtcp2_ksl dataksl;
/* mem is custom memory allocator */
const ngtcp2_mem *mem;
/* chunk is the size of each buffer in data field */
size_t chunk;
} ngtcp2_rob;
/*
* ngtcp2_rob_init initializes |rob|. |chunk| is the size of buffer
* per chunk.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGTCP2_ERR_NOMEM
* Out of memory.
*/
int ngtcp2_rob_init(ngtcp2_rob *rob, size_t chunk, const ngtcp2_mem *mem);
/*
* ngtcp2_rob_free frees resources allocated for |rob|.
*/
void ngtcp2_rob_free(ngtcp2_rob *rob);
/*
* ngtcp2_rob_push adds new data of length |datalen| at the stream
* offset |offset|.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGTCP2_ERR_NOMEM
* Out of memory
*/
int ngtcp2_rob_push(ngtcp2_rob *rob, uint64_t offset, const uint8_t *data,
size_t datalen);
/*
* ngtcp2_rob_remove_prefix removes gap up to |offset|, exclusive. It
* also removes data buffer if it is completely included in |offset|.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGTCP2_ERR_NOMEM
* Out of memory
*/
int ngtcp2_rob_remove_prefix(ngtcp2_rob *rob, uint64_t offset);
/*
* ngtcp2_rob_data_at stores the pointer to the buffer of stream
* offset |offset| to |*pdest| if it is available, and returns the
* valid length of available data. If no data is available, it
* returns 0.
*/
size_t ngtcp2_rob_data_at(ngtcp2_rob *rob, const uint8_t **pdest,
uint64_t offset);
/*
* ngtcp2_rob_pop clears data at stream offset |offset| of length
* |len|.
*
* |offset| must be the offset given in ngtcp2_rob_data_at. |len|
* must be the return value of ngtcp2_rob_data_at when |offset| is
* passed.
*
* Caller should call this function from offset 0 in non-decreasing
* order.
*/
void ngtcp2_rob_pop(ngtcp2_rob *rob, uint64_t offset, size_t len);
/*
* ngtcp2_rob_first_gap_offset returns the offset to the first gap.
* If there is no gap, it returns UINT64_MAX.
*/
uint64_t ngtcp2_rob_first_gap_offset(ngtcp2_rob *rob);
/*
* ngtcp2_rob_data_buffered returns nonzero if any data is buffered.
*/
int ngtcp2_rob_data_buffered(ngtcp2_rob *rob);
#endif /* NGTCP2_ROB_H */
|
