Skip to content

Commit 76b9c68

Browse files
martenrichtermartenrichter
committed
http2: initial proposal for addtl http/2 settings
Currently, node.js http/2 is limited in sending SETTINGs, that are currently implemented by nghttp2. However, nghttp2 has the ability to send arbitary SETTINGs, that are not known beforehand. This patch adds this feature including a fall back mechanism, if a SETTING is implemented in a later nghttp2 or node version. Fixes: nodejs#1337
1 parent 78842cf commit 76b9c68

6 files changed

Lines changed: 96 additions & 4 deletions

File tree

‎lib/internal/errors.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,6 +1108,8 @@ E('ERR_HTTP2_INVALID_SETTING_VALUE',
11081108
}
11091109
return `Invalid value for setting "${name}": ${actual}`;
11101110
}, TypeError, RangeError);
1111+
E('ERR_HTTP2_TOO_MANY_CUSTOM_SETTINGS',
1112+
'Number of custom settings exceeds MAX_ADDITIONAL_SETTINGS', Error);
11111113
E('ERR_HTTP2_INVALID_STREAM', 'The stream has been destroyed', Error);
11121114
E('ERR_HTTP2_MAX_PENDING_SETTINGS_ACK',
11131115
'Maximum number of pending settings acknowledgements', Error);

‎lib/internal/http2/core.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -946,6 +946,9 @@ function pingCallback(cb) {
946946
// All settings are optional and may be left undefined
947947
const validateSettings = hideStackFrames((settings) => {
948948
if (settings === undefined) return;
949+
950+
assertIsObject(settings.customSettings, 'customSettings', 'Number');
951+
949952
assertWithinRange('headerTableSize',
950953
settings.headerTableSize,
951954
0, kMaxInt);
@@ -3384,6 +3387,10 @@ function getUnpackedSettings(buf, options = kEmptyObject) {
33843387
break;
33853388
case NGHTTP2_SETTINGS_ENABLE_CONNECT_PROTOCOL:
33863389
settings.enableConnectProtocol = value !== 0;
3390+
break;
3391+
default:
3392+
if (!settings.customSettings) settings.customSettings = {};
3393+
settings.customSettings[id] = value;
33873394
}
33883395
offset += 4;
33893396
}

‎lib/internal/http2/util.js‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ const {
2525
ERR_HTTP2_INVALID_CONNECTION_HEADERS,
2626
ERR_HTTP2_INVALID_PSEUDOHEADER,
2727
ERR_HTTP2_INVALID_SETTING_VALUE,
28+
ERR_HTTP2_TOO_MANY_CUSTOMSETTINGS,
2829
ERR_INVALID_ARG_TYPE,
2930
ERR_INVALID_HTTP_TOKEN,
3031
},
@@ -192,6 +193,9 @@ const IDX_SETTINGS_MAX_HEADER_LIST_SIZE = 5;
192193
const IDX_SETTINGS_ENABLE_CONNECT_PROTOCOL = 6;
193194
const IDX_SETTINGS_FLAGS = 7;
194195

196+
// Maximum number of allowed additional settings
197+
const MAX_ADDITIONAL_SETTINGS = 10;
198+
195199
const IDX_SESSION_STATE_EFFECTIVE_LOCAL_WINDOW_SIZE = 0;
196200
const IDX_SESSION_STATE_EFFECTIVE_RECV_DATA_LENGTH = 1;
197201
const IDX_SESSION_STATE_NEXT_STREAM_ID = 2;
@@ -350,6 +354,67 @@ function getSettings(session, remote) {
350354

351355
function updateSettingsBuffer(settings) {
352356
let flags = 0;
357+
let numCustomSettings = 0;
358+
359+
if (typeof settings.customSettings === 'object') {
360+
const customSettings = settings.customSettings;
361+
for (const setting in customSettings) {
362+
const val = customSettings[setting];
363+
if (typeof val === 'number') {
364+
let set = false;
365+
const nsetting = Number(setting);
366+
if (nsetting < IDX_SETTINGS_FLAGS) {
367+
set = true;
368+
switch (nsetting) {
369+
case IDX_SETTINGS_HEADER_TABLE_SIZE:
370+
flags |= (1 << IDX_SETTINGS_HEADER_TABLE_SIZE);
371+
settingsBuffer[IDX_SETTINGS_HEADER_TABLE_SIZE] =
372+
val;
373+
break;
374+
case IDX_SETTINGS_ENABLE_PUSH:
375+
flags |= (1 << IDX_SETTINGS_ENABLE_PUSH);
376+
settingsBuffer[IDX_SETTINGS_ENABLE_PUSH] = val;
377+
break;
378+
case IDX_SETTINGS_INITIAL_WINDOW_SIZE:
379+
flags |= (1 << IDX_SETTINGS_INITIAL_WINDOW_SIZE);
380+
settingsBuffer[IDX_SETTINGS_INITIAL_WINDOW_SIZE] =
381+
val;
382+
break;
383+
case IDX_SETTINGS_MAX_FRAME_SIZE:
384+
flags |= (1 << IDX_SETTINGS_MAX_FRAME_SIZE);
385+
settingsBuffer[IDX_SETTINGS_MAX_FRAME_SIZE] =
386+
val;
387+
break;
388+
case IDX_SETTINGS_MAX_CONCURRENT_STREAMS:
389+
flags |= (1 << IDX_SETTINGS_MAX_CONCURRENT_STREAMS);
390+
settingsBuffer[IDX_SETTINGS_MAX_CONCURRENT_STREAMS] = val;
391+
break;
392+
case IDX_SETTINGS_MAX_HEADER_LIST_SIZE:
393+
flags |= (1 << IDX_SETTINGS_MAX_HEADER_LIST_SIZE);
394+
settingsBuffer[IDX_SETTINGS_MAX_HEADER_LIST_SIZE] =
395+
val;
396+
break;
397+
case IDX_SETTINGS_ENABLE_CONNECT_PROTOCOL:
398+
flags |= (1 << IDX_SETTINGS_ENABLE_CONNECT_PROTOCOL);
399+
settingsBuffer[IDX_SETTINGS_ENABLE_CONNECT_PROTOCOL] = val;
400+
break;
401+
default:
402+
set = false;
403+
break;
404+
}
405+
}
406+
if (!set) { // not supported
407+
if (numCustomSettings === MAX_ADDITIONAL_SETTINGS)
408+
throw new ERR_HTTP2_TOO_MANY_CUSTOMSETTINGS();
409+
settingsBuffer[IDX_SETTINGS_FLAGS + 1 + 2 * numCustomSettings + 1] = nsetting;
410+
settingsBuffer[IDX_SETTINGS_FLAGS + 1 + 2 * numCustomSettings + 2] = val;
411+
numCustomSettings++;
412+
}
413+
}
414+
}
415+
}
416+
settingsBuffer[IDX_SETTINGS_FLAGS + 1] = numCustomSettings;
417+
353418
if (typeof settings.headerTableSize === 'number') {
354419
flags |= (1 << IDX_SETTINGS_HEADER_TABLE_SIZE);
355420
settingsBuffer[IDX_SETTINGS_HEADER_TABLE_SIZE] =

‎src/node_http2.cc‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,16 @@ size_t Http2Settings::Init(
228228
HTTP2_SETTINGS(V)
229229
#undef V
230230

231+
uint32_t numAddSettings = buffer[IDX_SETTINGS_COUNT + 1];
232+
if (numAddSettings > 0) {
233+
uint32_t offset = IDX_SETTINGS_COUNT + 1 + 1;
234+
for (uint32_t i = 0; i < numAddSettings; i++) {
235+
uint32_t key = buffer[offset + i * 2 + 0];
236+
uint32_t val = buffer[offset + i * 2 + 1];
237+
entries[count++] = nghttp2_settings_entry{(int32_t)key, val};
238+
}
239+
}
240+
231241
return count;
232242
}
233243
#undef GRABSETTING
@@ -262,7 +272,7 @@ Local<Value> Http2Settings::Pack() {
262272
}
263273

264274
Local<Value> Http2Settings::Pack(Http2State* state) {
265-
nghttp2_settings_entry entries[IDX_SETTINGS_COUNT];
275+
nghttp2_settings_entry entries[IDX_SETTINGS_COUNT + MAX_ADDITIONAL_SETTINGS];
266276
size_t count = Init(state, entries);
267277
return Pack(state->env(), count, entries);
268278
}
@@ -298,6 +308,8 @@ void Http2Settings::Update(Http2Session* session, get_setting fn) {
298308
fn(session->session(), NGHTTP2_SETTINGS_ ## name);
299309
HTTP2_SETTINGS(V)
300310
#undef V
311+
buffer[IDX_SETTINGS_COUNT + 1] =
312+
0; // no additional settings are coming, clear them
301313
}
302314

303315
// Initializes the shared TypedArray with the default settings values.
@@ -314,6 +326,7 @@ void Http2Settings::RefreshDefaults(Http2State* http2_state) {
314326
#undef V
315327

316328
buffer[IDX_SETTINGS_COUNT] = flags;
329+
buffer[IDX_SETTINGS_COUNT + 1] = 0; // no additional settings
317330
}
318331

319332

‎src/node_http2.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1035,7 +1035,7 @@ class Http2Settings : public AsyncWrap {
10351035
v8::Global<v8::Function> callback_;
10361036
uint64_t startTime_;
10371037
size_t count_ = 0;
1038-
nghttp2_settings_entry entries_[IDX_SETTINGS_COUNT];
1038+
nghttp2_settings_entry entries_[IDX_SETTINGS_COUNT + MAX_ADDITIONAL_SETTINGS];
10391039
};
10401040

10411041
class Origins {

‎src/node_http2_state.h‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ namespace http2 {
2121
IDX_SETTINGS_COUNT
2222
};
2323

24+
// number of max additional settings, thus settings not implemente by nghttp2
25+
const size_t MAX_ADDITIONAL_SETTINGS = 10;
26+
2427
enum Http2SessionStateIndex {
2528
IDX_SESSION_STATE_EFFECTIVE_LOCAL_WINDOW_SIZE,
2629
IDX_SESSION_STATE_EFFECTIVE_RECV_DATA_LENGTH,
@@ -110,7 +113,8 @@ class Http2State : public BaseObject {
110113
root_buffer),
111114
settings_buffer(realm->isolate(),
112115
offsetof(http2_state_internal, settings_buffer),
113-
IDX_SETTINGS_COUNT + 1,
116+
IDX_SETTINGS_COUNT + 1 + 1 +
117+
2 * MAX_ADDITIONAL_SETTINGS,
114118
root_buffer) {}
115119

116120
AliasedUint8Array root_buffer;
@@ -135,7 +139,8 @@ class Http2State : public BaseObject {
135139
double stream_stats_buffer[IDX_STREAM_STATS_COUNT];
136140
double session_stats_buffer[IDX_SESSION_STATS_COUNT];
137141
uint32_t options_buffer[IDX_OPTIONS_FLAGS + 1];
138-
uint32_t settings_buffer[IDX_SETTINGS_COUNT + 1];
142+
uint32_t settings_buffer[IDX_SETTINGS_COUNT + 1 + 1 +
143+
2 * MAX_ADDITIONAL_SETTINGS];
139144
};
140145
};
141146

0 commit comments

Comments
 (0)