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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "hpacktable_p.h"
#include <QtCore/qdebug.h>
#include <QtCore/private/qnumeric_p.h>
#include <algorithm>
#include <cstddef>
#include <cstring>
#include <limits>
QT_BEGIN_NAMESPACE
namespace HPack
{
HeaderSize entry_size(const QByteArray &name, const QByteArray &value)
{
// 32 comes from HPACK:
// "4.1 Calculating Table Size
// Note: The additional 32 octets account for an estimated overhead associated
// with an entry. For example, an entry structure using two 64-bit pointers
// to reference the name and the value of the entry and two 64-bit integers
// for counting the number of references to the name and value would have
// 32 octets of overhead."
size_t sum;
if (add_overflow(size_t(name.size()), size_t(value.size()), &sum))
return HeaderSize();
if (sum > (std::numeric_limits<unsigned>::max() - 32))
return HeaderSize();
return HeaderSize(true, quint32(sum + 32));
}
namespace
{
int compare(const QByteArray &lhs, const QByteArray &rhs)
{
if (const int minLen = std::min(lhs.size(), rhs.size())) {
// We use memcmp, since strings in headers are allowed
// to contain '\0'.
const int cmp = std::memcmp(lhs.constData(), rhs.constData(), std::size_t(minLen));
if (cmp)
return cmp;
}
return lhs.size() - rhs.size();
}
} // unnamed namespace
FieldLookupTable::SearchEntry::SearchEntry()
: field(),
chunk(),
offset(),
table()
{
}
FieldLookupTable::SearchEntry::SearchEntry(const HeaderField *f,
const Chunk *c,
quint32 o,
const FieldLookupTable *t)
: field(f),
chunk(c),
offset(o),
table(t)
{
Q_ASSERT(field);
}
bool FieldLookupTable::SearchEntry::operator < (const SearchEntry &rhs)const
{
Q_ASSERT(field);
Q_ASSERT(rhs.field);
int cmp = compare(field->name, rhs.field->name);
if (cmp)
return cmp < 0;
cmp = compare(field->value, rhs.field->value);
if (cmp)
return cmp < 0;
if (!chunk) // 'this' is not in the searchIndex.
return rhs.chunk;
if (!rhs.chunk) // not in the searchIndex.
return false;
Q_ASSERT(table);
Q_ASSERT(rhs.table == table);
const quint32 leftChunkIndex = table->indexOfChunk(chunk);
const quint32 rightChunkIndex = rhs.table->indexOfChunk(rhs.chunk);
// Later added - smaller is chunk index (since we push_front).
if (leftChunkIndex != rightChunkIndex)
return leftChunkIndex > rightChunkIndex;
// Later added - smaller is offset.
return offset > rhs.offset;
}
FieldLookupTable::FieldLookupTable(quint32 maxSize, bool use)
: maxTableSize(maxSize),
tableCapacity(maxSize),
useIndex(use),
nDynamic(),
begin(),
end(),
dataSize()
{
}
bool FieldLookupTable::prependField(const QByteArray &name, const QByteArray &value)
{
const auto entrySize = entry_size(name, value);
if (!entrySize.first)
return false;
if (entrySize.second > tableCapacity) {
clearDynamicTable();
return true;
}
while (nDynamic && tableCapacity - dataSize < entrySize.second)
evictEntry();
if (!begin) {
// Either no more space or empty table ...
chunks.push_front(ChunkPtr(new Chunk(ChunkSize)));
end += ChunkSize;
begin = ChunkSize;
}
--begin;
dataSize += entrySize.second;
++nDynamic;
auto &newField = front();
newField.name = name;
newField.value = value;
if (useIndex) {
const auto result = searchIndex.insert(frontKey());
Q_UNUSED(result) Q_ASSERT(result.second);
}
return true;
}
void FieldLookupTable::evictEntry()
{
if (!nDynamic)
return;
Q_ASSERT(end != begin);
if (useIndex) {
const auto res = searchIndex.erase(backKey());
Q_UNUSED(res) Q_ASSERT(res == 1);
}
const HeaderField &field = back();
const auto entrySize = entry_size(field);
Q_ASSERT(entrySize.first);
Q_ASSERT(dataSize >= entrySize.second);
dataSize -= entrySize.second;
--nDynamic;
--end;
if (end == begin) {
Q_ASSERT(chunks.size() == 1);
end = ChunkSize;
begin = end;
} else if (!(end % ChunkSize)) {
chunks.pop_back();
}
}
quint32 FieldLookupTable::numberOfEntries() const
{
return quint32(staticPart().size()) + nDynamic;
}
quint32 FieldLookupTable::numberOfStaticEntries() const
{
return quint32(staticPart().size());
}
quint32 FieldLookupTable::numberOfDynamicEntries() const
{
return nDynamic;
}
quint32 FieldLookupTable::dynamicDataSize() const
{
return dataSize;
}
void FieldLookupTable::clearDynamicTable()
{
searchIndex.clear();
chunks.clear();
begin = 0;
end = 0;
nDynamic = 0;
dataSize = 0;
}
bool FieldLookupTable::indexIsValid(quint32 index) const
{
return index && index <= staticPart().size() + nDynamic;
}
quint32 FieldLookupTable::indexOf(const QByteArray &name, const QByteArray &value)const
{
// Start from the static part first:
const auto &table = staticPart();
const HeaderField field(name, value);
const auto staticPos = findInStaticPart(field, CompareMode::nameAndValue);
if (staticPos != table.end()) {
if (staticPos->name == name && staticPos->value == value)
return quint32(staticPos - table.begin() + 1);
}
// Now we have to lookup in our dynamic part ...
if (!useIndex) {
qCritical("lookup in dynamic table requires search index enabled");
return 0;
}
const SearchEntry key(&field, nullptr, 0, this);
const auto pos = searchIndex.lower_bound(key);
if (pos != searchIndex.end()) {
const HeaderField &found = *pos->field;
if (found.name == name && found.value == value)
return keyToIndex(*pos);
}
return 0;
}
quint32 FieldLookupTable::indexOf(const QByteArray &name) const
{
// Start from the static part first:
const auto &table = staticPart();
const HeaderField field(name, QByteArray());
const auto staticPos = findInStaticPart(field, CompareMode::nameOnly);
if (staticPos != table.end()) {
if (staticPos->name == name)
return quint32(staticPos - table.begin() + 1);
}
// Now we have to lookup in our dynamic part ...
if (!useIndex) {
qCritical("lookup in dynamic table requires search index enabled");
return 0;
}
const SearchEntry key(&field, nullptr, 0, this);
const auto pos = searchIndex.lower_bound(key);
if (pos != searchIndex.end()) {
const HeaderField &found = *pos->field;
if (found.name == name)
return keyToIndex(*pos);
}
return 0;
}
bool FieldLookupTable::field(quint32 index, QByteArray *name, QByteArray *value) const
{
Q_ASSERT(name);
Q_ASSERT(value);
if (!indexIsValid(index))
return false;
const auto &table = staticPart();
if (index - 1 < table.size()) {
*name = table[index - 1].name;
*value = table[index - 1].value;
return true;
}
index = index - 1 - quint32(table.size()) + begin;
const auto chunkIndex = index / ChunkSize;
Q_ASSERT(chunkIndex < chunks.size());
const auto offset = index % ChunkSize;
const HeaderField &found = (*chunks[chunkIndex])[offset];
*name = found.name;
*value = found.value;
return true;
}
bool FieldLookupTable::fieldName(quint32 index, QByteArray *dst) const
{
Q_ASSERT(dst);
return field(index, dst, &dummyDst);
}
bool FieldLookupTable::fieldValue(quint32 index, QByteArray *dst) const
{
Q_ASSERT(dst);
return field(index, &dummyDst, dst);
}
const HeaderField &FieldLookupTable::front() const
{
Q_ASSERT(nDynamic && begin != end && chunks.size());
return (*chunks[0])[begin];
}
HeaderField &FieldLookupTable::front()
{
Q_ASSERT(nDynamic && begin != end && chunks.size());
return (*chunks[0])[begin];
}
const HeaderField &FieldLookupTable::back() const
{
Q_ASSERT(nDynamic && end && end != begin);
const quint32 absIndex = end - 1;
const quint32 chunkIndex = absIndex / ChunkSize;
Q_ASSERT(chunkIndex < chunks.size());
const quint32 offset = absIndex % ChunkSize;
return (*chunks[chunkIndex])[offset];
}
quint32 FieldLookupTable::indexOfChunk(const Chunk *chunk) const
{
Q_ASSERT(chunk);
for (size_type i = 0; i < chunks.size(); ++i) {
if (chunks[i].get() == chunk)
return quint32(i);
}
Q_UNREACHABLE();
return 0;
}
quint32 FieldLookupTable::keyToIndex(const SearchEntry &key) const
{
Q_ASSERT(key.chunk);
const auto chunkIndex = indexOfChunk(key.chunk);
const auto offset = key.offset;
Q_ASSERT(offset < ChunkSize);
Q_ASSERT(chunkIndex || offset >= begin);
return quint32(offset + chunkIndex * ChunkSize - begin + 1 + staticPart().size());
}
FieldLookupTable::SearchEntry FieldLookupTable::frontKey() const
{
Q_ASSERT(chunks.size() && end != begin);
return SearchEntry(&front(), chunks.front().get(), begin, this);
}
FieldLookupTable::SearchEntry FieldLookupTable::backKey() const
{
Q_ASSERT(chunks.size() && end != begin);
const HeaderField &field = back();
const quint32 absIndex = end - 1;
const auto offset = absIndex % ChunkSize;
const auto chunk = chunks[absIndex / ChunkSize].get();
return SearchEntry(&field, chunk, offset, this);
}
bool FieldLookupTable::updateDynamicTableSize(quint32 size)
{
if (!size) {
clearDynamicTable();
return true;
}
if (size > maxTableSize)
return false;
tableCapacity = size;
while (nDynamic && dataSize > tableCapacity)
evictEntry();
return true;
}
void FieldLookupTable::setMaxDynamicTableSize(quint32 size)
{
// This is for an external user, for example, HTTP2 protocol
// layer that can receive SETTINGS frame from its peer.
// No validity checks here, up to this external user.
// We update max size and capacity (this can also result in
// items evicted or even dynamic table completely cleared).
maxTableSize = size;
updateDynamicTableSize(size);
}
// This data is from the HPACK's specs and it's quite conveniently sorted,
// except ... 'accept' is in the wrong position, see how we handle it below.
const std::vector<HeaderField> &FieldLookupTable::staticPart()
{
static std::vector<HeaderField> table = {
{":authority", ""},
{":method", "GET"},
{":method", "POST"},
{":path", "/"},
{":path", "/index.html"},
{":scheme", "http"},
{":scheme", "https"},
{":status", "200"},
{":status", "204"},
{":status", "206"},
{":status", "304"},
{":status", "400"},
{":status", "404"},
{":status", "500"},
{"accept-charset", ""},
{"accept-encoding", "gzip, deflate"},
{"accept-language", ""},
{"accept-ranges", ""},
{"accept", ""},
{"access-control-allow-origin", ""},
{"age", ""},
{"allow", ""},
{"authorization", ""},
{"cache-control", ""},
{"content-disposition", ""},
{"content-encoding", ""},
{"content-language", ""},
{"content-length", ""},
{"content-location", ""},
{"content-range", ""},
{"content-type", ""},
{"cookie", ""},
{"date", ""},
{"etag", ""},
{"expect", ""},
{"expires", ""},
{"from", ""},
{"host", ""},
{"if-match", ""},
{"if-modified-since", ""},
{"if-none-match", ""},
{"if-range", ""},
{"if-unmodified-since", ""},
{"last-modified", ""},
{"link", ""},
{"location", ""},
{"max-forwards", ""},
{"proxy-authenticate", ""},
{"proxy-authorization", ""},
{"range", ""},
{"referer", ""},
{"refresh", ""},
{"retry-after", ""},
{"server", ""},
{"set-cookie", ""},
{"strict-transport-security", ""},
{"transfer-encoding", ""},
{"user-agent", ""},
{"vary", ""},
{"via", ""},
{"www-authenticate", ""}
};
return table;
}
std::vector<HeaderField>::const_iterator FieldLookupTable::findInStaticPart(const HeaderField &field, CompareMode mode)
{
const auto &table = staticPart();
const auto acceptPos = table.begin() + 18;
if (field.name == "accept") {
if (mode == CompareMode::nameAndValue && field.value != "")
return table.end();
return acceptPos;
}
auto predicate = [mode](const HeaderField &lhs, const HeaderField &rhs) {
const int cmp = compare(lhs.name, rhs.name);
if (cmp)
return cmp < 0;
else if (mode == CompareMode::nameAndValue)
return compare(lhs.value, rhs.value) < 0;
return false;
};
const auto staticPos = std::lower_bound(table.begin(), acceptPos, field, predicate);
if (staticPos != acceptPos)
return staticPos;
return std::lower_bound(acceptPos + 1, table.end(), field, predicate);
}
}
QT_END_NAMESPACE
|