CHANGELOG revision 244e8c6f
12020-07-30
2    - 2.19.2
3    - [BUGFIX] Do not reduce PLPMTU size by network overhead.
4    - [BUGFIX] Windows build.
5
62020-07-29
7    - 2.19.1
8    - [FEATURE] DPLPMTUD support.  IETF connections now search for the
9      maximum packet size, improving throughput.
10    - [DEBUG] Record event in stream history when on_close() is called
11      in dtor.
12
132020-07-22
14    - 2.18.2
15    - [BUGFIX] Send prediction: lone path challenges do not get squeezed out
16    - Fix crash in http_client: now -K and -B can be used simultaneously
17
182020-07-14
19    - 2.18.1
20    - [FEATURE] Implement the "QUIC bit grease" extension.
21    - [BUGFIX] Selecting CID used for logging on client.
22    - [BUGFIX] Header protection assertion.
23    - [BUGFIX] Server: enable SSL key logging when cert lookup callback
24      is not set.
25    - Remove some dead code.
26
272020-07-06
28    - 2.18.0
29    - [API] Rename "0-RTT" to "session resumption." In IETF QUIC, "0-RTT"
30      always refers to early data, meaning a request that the server can
31      reply to in the very first return flight.  A more appropriate name
32      for what we support on the client site is "session resumption," which
33      is standard TLS terminology.  Later, when we add support for 0-RTT
34      (early data), we can use the 0-RTT terminology again, this time in
35      proper context.
36    - [BUGFIX] Do not set certificate callback if ea_lookup_cert is NULL.
37    - [BUGFIX] Make connection tickable when it's marked as closed.
38    - [BUGFIX] Fail certificate lookup if SNI is not present in HTTP mode.
39    - Several documentation fixes and improvements.
40    - Minor code cleanup.
41
422020-06-24
43    - 2.17.2
44    - [BUGFIX] Infinite loop in stream: advance read offset when discarding
45      data.
46    - [OPTIMIZATION] Header protection: only initialize cipher once.
47    - [OPTIMIZATION] Batch header protection application.
48
492020-06-18
50    - 2.17.1
51    - [FEATURE] QUIC and HTTP/3 Internet Draft 29 support.
52    - [BUGFIX] Check that scheduled packets are also sendable when
53      calculating a connection's "tickable" property.
54    - [BUGFIX] Don't count scheduled packets as in-flight when pacer is
55      checked on tick.
56    - gQUIC: delay calling on_new for pushed stream until headers are
57      available.
58    - Allow nested calls to lsquic_engine_connect().
59
602020-06-15
61    - 2.16.3
62    - [OPTIMIZATION] Stash up to two reordered packets in IETF mini conn
63      instead of dropping them.
64    - [BUGFIX] Crash: check decrypt context before using it.  This regression
65      was introduced in 2.16.2.
66
672020-06-12
68    - 2.16.2
69    - [BUGFIX] ID-28: do not use TLS middlebox compatibility mode in
70      ClientHello.  This change requires using a newer version of BoringSSL.
71    - [BUGFIX] Free connections in Advisory Tick Time Queue in engine dtor.
72    - [BUGFIX] IETF QUIC client: narrow migration check to a single path.
73    - [BUGFIX] NULL dereference: set function pointers for alarm for path
74      challenges 2 and 3.
75    - [BUGFIX] HTTP/3 headers may be followed immediately by trailers.
76    - [BUGFIX] Log messages when SCID changes.
77
782020-06-09
79    - 2.16.1
80    - [FEATURE] Use "no-progress timeout" after which connection is closed.
81    - [BUGFIX] Select new SCID when current SCID is retired.
82    - [BUGFIX] Don't warn about dropped Initial packet sequence gaps during
83      mini/full handoff.
84    - [BUGFIX] Send correct conn error when HTTP/3 frame is truncated.
85    - [BUGFIX] Mini conn: consider amplification when deciding to return
86      TICK_SEND.
87    - [BUGFIX] Don't double-count tag length in amplification logic.
88    - [BUGFIX] Don't squeeze out lone path challenges.
89    - [BUGFIX] Log messages dealing with scheduled packet queue squeezing.
90    - [BUGFIX] don't wipe current path if no path challenge responses
91      come back.
92    - [BUGFIX] When path is reset, don't lose path_id which is used for
93      logging.
94    - Downgrade flow control violations to info log level from warnings.
95    - Fix connection cap extra check, avoid checks in nested calls.
96    - Fix some unit tests when extra checks are enabled.
97    - Use ls-hpack 2.2.1.
98    - Turn off unconditional extra checks for IETF clients.
99    - Extra checks: don't verify sent size of hello packets.  Client
100      changes DCID length and this check will fail.
101
1022020-06-03
103    - 2.16.0
104    - [API] Use lsxpack_header v206.
105    - [FEATURE] Windows supported.
106    - [BUGFIX] Fix uninitialized variable use in client (regression in
107      2.15.0).
108    - Use ls-hpack 2.2.0.
109    - Use ls-qpack 2.2.0.
110    - Sample programs: fix the way maximum number of packets is
111      calculated.
112    - Remove some dead code.
113
1142020-05-27
115    - 2.15.0
116    - [FEATURE] QUIC and HTTP/3 Internet Draft 28 support.
117    - [BUGFIX] Ignore Retry packets after other packets are decrypted
118      successfully.
119    - [BUGFIX] Transport parameter decoding: CID no longer has 4-byte
120      length minimum.
121    - http_client: fix and optimize lsxpack_header allocator.
122    - Drop support for Internet Draft 25.
123
1242020-05-19
125    - 2.14.8
126    - Support Android.
127    - Rerrange tree: move command-line examples into bin/ and unit
128      tests into tests/ from test/unittests/.
129
1302020-05-12
131    - 2.14.7
132    - [BUGFIX] ALPN-to-version mapping: do not skip h3-Q050.
133    - [BUGFIX] Frame reader: skip headers if target stream is closed.
134
1352020-05-06
136    - 2.14.6
137    - [BUGFIX] Fix amplification mitigation in 0-RTT case.
138    - [BUGFIX] IETF mini connection should not tickable if cannot send
139      a packet due to amplification.
140    - [BUGFIX] Fail if active_connection_id_limit TP is smaller than 2.
141    - [BUGFIX] Qlog server certificates for IETF QUIC connections.
142    - [BUGFIX] Uninitialized struct padding usage in tokgen (benign).
143    - [BUGFIX] Incorrect argument to shi_lookup() (benign).
144
1452020-04-29
146    - 2.14.5
147    - [BUGFIX] In coalesced datagram, ignore packets whose CID does not match.
148    - [BUGFIX] Frame reader: skip headers if target stream is not found.
149    - [BUGFIX] Log message in QPACK decoder handler.
150
1512020-04-24
152    - 2.14.4
153    - [BUGFIX] Heed es_rw_once for pushed HTTP/3 streams.
154    - [BUGFIX] IETF client: set correct flags on bidirectional streams.
155    - [BUGFIX] Generate Cancel Stream QPACK instructions for abandoned
156      streams.
157    - [BUGFIX] Do not call header callbacks after stream is closed.
158    - Use ls-qpack 2.1.1
159
1602020-04-15
161    - 2.14.3
162    - [BUGFIX] gQUIC: pass correct stream to hsi_create_header_set() callback.
163    - [BUGFIX] Use ls-hpack 2.1.1
164    - Improve stream code readability.
165    - Use ls-qpack 2.0.5
166
1672020-04-08
168    - 2.14.2
169    - [BUGFIX] Use ls-qpack 2.0.4
170    - [BUGFIX] Honor max packet size on the client and when path changes.
171    - http_server: fix prepare_decode() function.
172
1732020-04-07
174    - 2.14.1
175    - [BUGFIX] Place connections on tickable queue when sending is reenabled.
176    - [BUGFIX] A connection is tickable if it has unsent packets.
177    - [BUGFIX] Heed peer's max_packet_size transport parameter.
178
1792020-03-30
180    - 2.14.0
181    - [API] Use lsxpack_header structure to send HTTP headers.
182    - [OPTIMIZATION] nocopy's readable_bytes() function.
183    - http_server: fix typo in error message
184    - Use ls-hpack 2.1.0.
185    - Use ls-qpack 2.0.0.
186
1872020-03-23
188    - 2.13.3
189    - [BUGFIX] ACK ping-pong: TIMESTAMP frame is not to be acked.
190
1912020-03-13
192    - 2.13.2
193    - [BUGFIX] Use of new lsxpack_header API's hsi_prepare_decode().
194
1952020-03-12
196    - 2.13.1
197    - [API] Use lsxpack_header structure to process incoming headers.
198    - [BUGFIX] Fix assertion when zero-padding Initial packet.
199    - [BUGFIX] Use idle timeout before we learn of peer's value.
200    - Use ls-hpack 2.0.1 -- has lsxpack_header changes.
201    - Use ls-qpack 0.14.0 -- new, common with ls-hpack, XXH seed (not
202      used yet).
203    - Code cleanup: prefix exported functions with "lsquic_".
204
2052020-03-02
206    - 2.12.0
207    - [FEATURE] QUIC timestamps extension.
208    - [API] New: ea_alpn that is used when not in HTTP mode.
209    - [BUGFIX] SNI is mandatory only for HTTP/3 and gQUIC.
210    - [BUGFIX] Benign double-free -- issue #110.
211    - [BUGFIX] Printing of transport parameters.
212
2132020-02-24
214    - 2.11.1
215    - [FEATURE] QUIC and HTTP/3 Internet Draft 27 support.
216    - [FEATURE] Add experimental delayed ACKs extension.
217    - Drop support for Internet Draft 24.
218    - Code cleanup.
219
2202020-02-14
221    - 2.10.6
222    - [BUGFIX] HTTP/3 framing: don't misinterpret rare occurence as error.
223    - [BUGFIX] Send gap warning due to missing poisoned packet.
224    - Stream unit test for scenario in issue #106.
225
2262020-02-13
227    - 2.10.5
228    - [BUGFIX] BBR: call cci_sent() with correct arguments and at correct
229      time.
230    - Refactor transport parameters module.
231    - Minor code cleanup.
232
2332020-02-11
234    - 2.10.4
235    - [BUGFIX] Send HANDSHAKE_DONE only after Finished is received.
236    - [BUGFIX] Don't treat garbage UDP padding as library error; ignore
237      it instead.
238    - [BUGFIX] Fix compilation on FreeBSD (missing header).
239    - Code cleanup: remove unnecessary #includes.
240
2412020-01-31
242    - 2.10.3
243    - [BUGFIX] Cancel path responses and challenges on old path when
244      switching to new path
245    - Logging network path information.
246
2472020-01-30
248    - 2.10.2
249    - [BUGFIX] Do not delay ACKs for Initial and Handshake packets.
250    - [BUGFIX] Send PATH_CHALLENGE if path changed before mini conn
251      promotion.
252    - Logging improvements.
253    - http_client: discard data faster.
254
2552020-01-29
256    - 2.10.1
257    - [BUGFIX] Coalesced packets could get longer than normal packet
258      size.
259    - Add spin bit configuration option es_spin (-o spin=[01]).
260    - Disable spin bit in 1/16 of connections.
261    - Improve logging a bit.
262
2632020-01-28
264    - 2.10.0
265    - [FEATURE] QUIC and HTTP/3 Internet Draft 25 support.
266    - [API] Drop support for ID-23.
267    - [BUGFIX] Set key phase bit on outgoing packets correctly.
268    - Code cleanup.
269
2702020-01-20
271    - 2.9.0
272    - [API] Drop support for Q039.
273    - Improve ACK-queuing logic.  Send an ACK once in a while if
274      peer keeps on sending non-ack-eliciting packets.
275    - Improve Alt-Svc string: Q050 and later are not included in
276      the old-style "quic" string.
277    - Send stateless resets if connection could not be promoted.
278    - Schedule MAX_DATA if needed when DATA_BLOCKED is received.
279    - Use ls-qpack 0.11.2 -- needed for server push optimization.
280    - Code cleanup: handle some error cases, improve logging.
281
2822020-01-16
283    - 2.8.9
284    - [BUGFIX] Use ls-qpack 0.11.1
285    - [OPTIMIZATION] Generate random bytes in batches.
286    - Change loss_bits transport parameter ID to 0x1057 following
287      latest draft.
288    - Randomize period with which PINGs are sent to elicit ACKs.
289    - Some refactoring and code cleanup.
290
2912020-01-14
292    - 2.8.8
293    - [BUGFIX] Invalid read when parsing IETF transport parameters
294      (this was benign).
295    - [OPTIMIZATION] Frame bundling when using buffered packets in
296      IETF QUIC: a) flush QPACK decoder stream and b) include ACKs
297      in opportunistic fashion.
298    - Fix HTTP/3 framing unit test.
299    - Code cleanup.
300
3012020-01-09
302    - 2.8.7
303    - [BUGFIX] Initial packet size check for IETF mini conn applies to
304      UDP payload, not QUIC packet.
305    - Support old and new school loss_bits transport parameter.
306    - Use Q run length of 64 as suggested in the loss bits Draft.
307    - Undo square wave count when packet is delayed.
308    - Code cleanup; minor fixes.
309
3102020-01-06
311    - 2.8.5
312    - [HTTP3] Verify number of bytes in incoming DATA frames against
313      content-length.
314    - [HTTP3] Stop issuing streams credits if peer stops opening QPACK
315      decoder window.  This addresses a potential attack whereby client
316      can cause the server to keep allocating memory.  See Security
317      Considerations in the QPACK draft.
318    - [BUGFIX] Mini conn: don't shorten max packet size for Q050 and later.
319    - [BUGFIX] Init IETF connection flow controller using correct setting.
320    - [BUGFIX] Fix unintended sign extension when removing header protection.
321    - Code cleanup and minor fixes.
322
3232019-12-30
324    - 2.8.1
325    - [FEATURE] Use occasional packet number gaps to detect optimistic
326      ACK attacks.
327    - [BUGFIX] Q050 client: all packet numbers are in the App PNS.
328    - [OPTIMIZATION] Merge multi-range ACK frames, not just single-range
329      ACK frames.
330    - IETF QUIC: use RTT estimate in ack timeout calculation.
331    - IETF handshake: abort conn when unexpected errors occur.
332    - Use PING rather than MAX_DATA frames to elicit ACKs from peer.
333    - Server: enforce 1200 byte Initial minimum packet size.
334    - [CLEANUP] Remove code to disable gQUIC crypto.
335    - [CLEANUP] Remove n_timestamps from ACK info struct.
336    - Optimize driver: reuse previous ancillary message when possible.
337
3382019-12-23
339    - 2.8.0
340    - [FEATURE] Add support for Q050.
341    - [OPTIMIZATION] Reduce mallocs in gQUIC handshake.
342    - [BUGFIX] Disable redo of failed STREAM frame insertion with debug
343      logging.
344
3452019-12-18
346    - 2.7.3
347    - [DEBUG] Further dedup next advisory tick messages when reason is
348      the same.
349    - [BUGFIX] Update size of `a` array in TP struct.  Fixes (benign)
350      GitHub bug #94.
351    - Use Cubic by default again instead of BBR, as it delivers more
352      consistent performance.
353
3542019-12-11
355    - 2.7.2
356    - [BUGFIX] Send controller: update scheduled bytes when DCID length
357      changes (IETF client).
358    - [BUGFIX] Drop alarm check from sanity test.  It no longer works now
359      that we use loss chains.
360    - [PORTABILITY] Fix build on Alpine Linux.
361    - [PORTABILITY] Fix build using XCode.
362    - Client initial DCID length: use RAND_bytes() instead of rand(3).
363    - Add unit tests for connection min heap.
364    - [DEBUG] Log CID in gQUIC handshake module
365    - [DEBUG] Turn on extra checks for IETF client send controller.
366    - [DEBUG] Dedup next advisory tick messages when reason is IDLE timer.
367    - [DEBUG] QPACK decoder handler: log header error code.
368
3692019-12-05
370    - 2.7.1
371    - [BUGFIX] client: don't call ignore_init() in middle of batch send.
372      ignore_init() makes an assumption that the send controller has access
373      to all outgoing packets.  This change wraps a few IETF full connection
374      methods to delay calling ignore_init() until the engine returns all
375      outgoing packets that were batched.
376    - [BUGFIX] set errno to EAGAIN if sendmmsg() can't send all of them.
377      This needs to be done because the value of errno may be lost on
378      some platforms.
379    - [BUGFIX] Typo that set all bits in sm_qflags lead to crashes.
380    - [BUGFIX] Do not cancel header block processing after failure, as
381      QPACK releases the reference in that case.
382    - [CLEANUP] IETF encrypt: replace assert(0) with a warning.
383    - Several small improvements to the test server.
384
3852019-11-27
386    - 2.7.0
387    - [API, FEATURE] Close connection immediately when ea_packets_out()
388      fails with errno != EAGAIN.  The API change is that errno is now
389      examined.  Make sure to set it if using something other than
390      sendmsg() to send packets.
391    - [CLEANUP] Immediate close logic in IETF full conn.
392    - [CLEANUP] Fix bogus warning about uninitialized `pair' variable.
393
3942019-11-22
395    - 2.6.7
396    - [FEATURE] Implement the QL extension (offered by default).
397    - [BUGFIX] Abort when encountering unexpected HTTP/3 frames.
398    - [BUGFIX] Acknowledge (QPACK) HTTP/3 trailers correctly.
399    - [DEBUG] Turn on debug message for next advisory tick.
400
4012019-11-20
402    - 2.6.6
403    - [BUGFIX] Using HTTP/3 to HTTP/1.x converter.
404    - [BUGFIX] Truncate log messages instead of throwing them away.
405
4062019-11-15
407    - 2.6.5
408    - [BUGFIX] High priority buffered packet queue length.
409    - [BUGFIX] Rain time calculation: max_ack_delay is in milliseconds.
410
4112019-11-12
412    - 2.6.3
413    - [BUGFIX] Close DATA frames with empty payload correctly.
414
4152019-11-11
416    - 2.6.2
417    - [BUGFIX] SCID!=ODCID rule applies to Retry packets, not regular
418      packets.
419    - [BUGFIX] Zero-RTT: BoringSSL no longer flips read/write secrets.
420    - [BUGFIX] Truncate ACK frame rather instead of aborting IETF
421      connection.
422    - [BUGFIX] Client: don't send duplicate reset tokens.
423    - [BUGFIX] Remove invalid assertion in H3 framing code.
424    - Silence a warning in send ctl by restructuring switch() statement.
425
4262019-11-08
427    - 2.6.1
428    - [BUGFIX] set retry token on all resubmitted packets.
429    - Event log: log sent packet flags.  In particular, this allows one
430      to see whether token was sent.
431    - Don't migrate client if es_allow_migration is false.
432
4332019-11-07
434    - 2.6.0
435    - [FEATURE] QUIC and HTTP/3 Internet Draft 24 support
436
4372019-11-07
438    - 2.5.2
439    - [BUGFIX] argument order to gQUIC client constructor.  Regression
440      introduced in 2.5.0.
441    - [BUGFIX] split buffered packet error recovery: destroy the correct
442      packet.
443
4442019-11-04
445    - 2.5.1
446    - [BUGFIX] Fix double-free when emptying a packet number space.
447    - [BUGFIX] http_server: fix md5sum handler: handle EOF correctly.
448    - [BUGFIX] Use random values in bits 4 and 5 of the first byte of
449      verneg packets (regression introduced in 2.5.0).
450    - [OPTIMIZATION] Don't compile in expensive attq checks by default.
451    - [OPTIMIZATION] http_server: compile regexes only once.
452
4532019-10-31
454    - 2.5.0
455    - [API] lsquic_engine_connect() can now be passed QUIC version to use.
456    - [OPTIMIZATION] Queue opportunistic ACKs if there is data to be sent.
457    - [BUGFIX] Don't evict streams from priority iterator if there is
458      only one queue.
459    - [OPTIMIZATION, BUGFIX] Several other optimizations and bug fixes.
460    - Use ls-qpack v0.10.7.
461
4622019-10-24
463    - 2.4.10
464    - [BUGFIX] IETF QUIC server: fix uninitialized variable use.
465    - [BUGFIX] make sure TLSv1.3 is not disabled in SSL object.
466    - [BUGFIX] Use issuer name and serial number to cache certs (SKID
467      values are not unique).
468    - [BUGFIX] Always set the idle alarm in IETF connection so that it
469      can time out.
470    - Use ls-qpack v0.10.6, as it silences some warnings.
471
4722019-10-21
473    - 2.4.8
474    - [OPTIMIZATION, BUGFIX] Use ls-qpack v0.10.5.
475
4762019-10-15
477    - 2.4.7
478    - Add echo client and server to the distibution.
479    - Add MD5 client and server to the distibution.
480    - Fix http_client: check command-line arguments better, prevent crash.
481    - Fix IETF conn: can_write_ack() should only care about APP PNS.
482    - Client: delay stream creation until handshake succeds.
483    - Reset HTTP stream whose write end is closed prematurely.
484    - Fix tickable(): mirror behavior of tick() wrt buffered packets.
485    - Log reason why engine is tickable.
486
4872019-10-11
488    - 2.4.6
489    - Minor code cleanup and logging improvements.
490    - Server and client programs: include library version (e.g. 2.4.6)
491      into `server' and `user-agent' headers.
492
4932019-10-08
494    - 2.4.5
495    - [OPTIMIZATION]: flush encoder stream only when necessary.
496    - [BUGFIX] Use ls-qpack v0.10.2 for new API -- and for a bug fix.
497    - [BUGFIX] Typo in IETF conn SETTINGS writer.
498    - Use latest BoringSSL.
499
5002019-10-08
501    - 2.4.4
502    - [API] Add lsquic_alpn2ver() to aid parsing Alt-Svc header.
503    - [BUGFIX] NULL dereference when H3 frame header would be split.
504    - [BUGFIX] Do not close fixed-size H3 frame prematurely.
505    - [BUGFIX] Allow PING frames in IETF mini conn.
506    - [BUGFIX] Mini conns: don't send any packets after receiving
507      CONNECTION_CLOSE.
508    - [BUGFIX] Client migration: reserve slot for DCID from transport params.
509    - [BUGFIX] Allow max_early_data_size=0 -- early_data might not be there.
510    - [BUGFIX] Use an invalid stream number to reset BPT cache (zero is now a
511      valid stream number).
512    - [SPEC] Use FINAL_SIZE_ERROR when FIN mismatch is detected.
513    - [OPTIMIZATION] Closed connection only gets one chance to send packets.
514    - [OPTIMIZATION] Flush headers stream before packetizing stream data.
515    - [OPTIMIZATION] process QPACK encoder STREAM frames immediately.
516    - Update ls-qpack to v0.10.1.
517
5182019-09-30
519    - 2.4.3
520    - Add GQUIC versions to the list of h3 ALPNs for Alt-Svc header.
521      For example, h3-Q043.  Chrome will switch to using this format at
522      some point in the future.
523    - [BUGFIX] Send correct value in max_streams_uni transport param
524    - [SPEC] Abort IETF QUIC connection if max_early_data_size is not set
525      to 0xFFFFFFFF
526
5272019-09-23
528    - 2.4.2
529    - [BUGFIX] H3 framing: fix zero-byte write when space is available
530    - [BUGFIX] Don't send STREAM frame when incoming unidirectgional stream
531      is closed
532    - [BUGFIX] Cancel all pending writes by stream reset by a GOAWAY
533    - [BUGFIX] Fix use-after-free in IETF full conn
534    - [OPTIMIZATION] Wait for session tickets for two seconds and then drop
535      SSL object and crypto streams.
536
5372019-09-18
538    - 2.4.0
539    - [FEATURE] QUIC and HTTP/3 Internet Draft 23 support
540
5412019-09-13
542    - 2.3.1
543    - [BUGFIX] Fix memory leaks
544    - [BUGFIX] Fix unit tests
545
5462019-09-12
547    - 2.3.0
548    - [FEATURE] BBR congestion control is on by default
549    - [BUGFIX] BBR app-limited logic
550    - [BUGFIX] Fix uninitialized warnings in IETF
551    - [BUGFIX] Update ls-qpack to v0.9.14
552    - [CLEANUP] Code cleanup
553
5542019-09-11
555    - 2.2.0
556    - [FEATURE] Server code is included in the library
557    - [FEATURE] IETF QUIC and HTTP/3 Support (ID-22)
558
5592019-05-13
560    - 1.21.2
561    - [OPTIMIZATION] HPACK: use history to improve compression performance
562
5632019-05-06
564    - 1.21.1
565    - [BUGFIX] If FIN or RST not received, don't delay stream destruction.
566    - [OPTIMIZATION] Speed up HPACK encoder by using same hash value to
567      search static and dynamic tables.
568
5692019-04-12
570    - 1.21.0
571    - [FEATURE] Add qlog log module.
572
5732019-04-01
574    - 1.20.0
575    - [FEATURE] Add support for Q046.
576
5772019-03-19
578    - 1.19.6
579    - [BUGFIX] Ensure that Largest Observed does not decrease in ACKs we
580      send.  ACK frames placed in packets in buffered queues (optimization
581      introduced in 1.17.15) can be preceded by an ACK frame generated later.
582      In this case, the older ACK frame should not be sent out, as Chromium-
583      based servers flags decrease in the ACK frame's Largest Observed value
584      as an error.
585
5862019-03-05
587    - 1.19.5
588    - [BUGFIX] Use correct public key from PUBS based on KEXS index.
589    - [BUGFIX] Check flags before dispatching writes, avoiding assert.
590    - [BUGFIX] Set :scheme to "https" (instead of "HTTP").
591
5922019-02-25
593    - 1.19.4
594    - [BUGFIX] Check buffer bounds when looking up version in 0-RTT blob.
595    - [BUGFIX] http_client: don't fetch 0-rtt info if handshake failed.
596    - Log number of pacer calls at DEBUG, rather than NOTICE, level.
597
5982019-02-18
599    - 1.19.3
600    - [BUGFIX] Q044: don't encode packet number in 6 bytes.  Six-byte
601      packet number encoding does not exist in Q044.  This fixes a
602      regression introduced in '[BUGFIX] Buffered packets can contain
603      ACK frames' -- we need to keep QUIC version in mind when selecting
604      the longest possible packet number encoding used for the buffered
605      packet that carries the ACK.
606    - [BUGFIX] Do not increase CWND when timeout occurs.
607    - http_client: support setting handshake timeout on command line.
608      Use -o handshake_to=timeout.
609    - http_client: use -k to connect UDP socket to pick up ICMP errors.
610    - http_client: allow pathless mode, when only handshake is performed
611      without issuing any requests.  This can be done by simply not
612      specifying a -p flag on the command line.
613
6142019-02-11
615    - 1.19.2
616    - [BUGFIX] Begin negotiation with version provided in 0-RTT info.
617    - [BUGFIX] Version checking in zero_rtt deserialize function.
618
6192019-02-04
620    - 1.19.1
621    - [BUGFIX] Fix Windows build.
622
6232019-02-04
624    - 1.19.0
625    - [FEATURE, API Change] 0-RTT support.  Add function to export 0-RTT
626      information; it can be supplied to a subsequent connect() call.
627    - [FEATURE] Add -0 flag to http_client to exercise 0-RTT support.
628    - [BUGFIX] Resuscitate the Windows build.
629    - [BUGFIX] Send HTTP settings (max header list size) if necessary.
630    - [BUGFIX] Buffered packets can contain ACK frames.
631    - [BUGFIX] Make packet writeable once all STREAM frames are elided.
632    - [BUGFIX] Fix potential null dereference when realloc fails.
633    - cmake: simplify build configuration.
634
6352019-01-28
636    - 1.18.0
637    - [API Change] Can specify clock granularity in engine settings.
638    - [BUGFIX] Pacer uses fixed clock granularity.  Since the change on
639      2018-04-09, it is not necessary to try to approximate the next tick
640      time in the pacer: it can use fix clock granularity specified by
641      the user.
642    - [BUGFIX] Do not tick constantly before handshake is done.
643    - [BUGFIX] Do not exit tick prematurely: reuse packet with ACK.  Even
644      if we cannot allocate *more* packets, we could still be able to write
645      to one already allocated.
646    - [BUGFIX] Do not schedule pacer if there are no lost packets.
647
6482019-01-17
649    - 1.17.15
650    - [BUGFIX] http_client: make sure only one read per on_read() callback
651      is performed in the header conversion bypass (-B) mode.
652    - http_client: with -E, assign random priority when stream is created.
653    - [OPTIMIZATION] On immediate write, place an ACK frame into the first
654      buffered packet if an ACK is queued.  This reduces the number of
655      standalone ACK packets.
656    - [OPTIMIZATION] Allow placing more than one STREAM frame from the same
657      stream into an outgoing packet.  This change minimizes the number of
658      buffered packets required to store several small HTTP messages by
659      virtue of allowing more than one STREAM frame from HEADERS stream in
660      the same packet.
661    - [OPTIMIZATION] Flush headers when writing to buffered packets.  This
662      causes the headers to be written to the same buffered packet queue,
663      thereby improving packet utilization, especially for small HTTP
664      messages.
665
6662019-01-16
667    - 1.17.14
668    - [FEATURE] http_client can now collect stats: time to connect, TTFB,
669      time to download, requests per seconds, and bandwidth.  See -t flag.
670    - [BUGFIX] http_client: -B, -K, and -r can be used at the same time.
671    - [BUGFIX] http_client: do not display cert chain before each request.
672      Now this is only done once per connection, if the handshake is
673      successful and -a option is given.
674    - [BUGFIX] Do not wait to dispatch on_close() after reading.  If a
675      stream is scheduled to be closed after on_read() callback returns,
676      close it immediately instead of waiting until the end of the tick.
677      If client creates new request from on_close() event, they will be
678      processed in the same tick instead of waiting for the next one.
679    - [BUGFIX] HEADERS stream is critical: always treat it with highest
680      priority.
681
6822019-01-10
683    - 1.17.12
684    - [FEATURE] http_client can now issue parallel requests in the context
685      of a single connection.  See -w option.
686
6872019-01-03
688    - 1.17.11
689    - Fix strict aliasing warning in optimized compilation.
690
6912018-12-27
692    - 1.17.10
693    - Fix the example program to be able to use parallel connections
694      again.  (See the -n argument.)
695
6962018-12-18
697    - 1.17.9
698    - [BUGFIX] Engine: reduce minimum batch size from 256 to 4
699
7002018-12-10
701    - 1.17.8
702    - [BUGFIX] Fix compilation on FreeBSD and 32-bit Linux
703
7042018-12-03
705    - 1.17.7
706    - [BUGFIX] Do not unset PING alarm before ringing expired alarms.
707      This prevented PING from ever being sent.
708
7092018-11-29
710    - 1.17.6
711    - Add failsafe: resume sending packets after some time
712
713      The change puts a 1-second limit on the amount of time the engine
714      will not send packets after some packets are delayed.  This makes
715      the library robust in case the user does not unblock the engine
716      explicitly using lsquic_engine_send_unsent_packets() call.
717
718    - [BUGFIX] Handle corner cases in send controller when packets are
719      a) delayed or b) dropped during repackaging.
720    - [BUGFIX] Memory leak: destroy buffered packets during controller
721      cleanup.
722
7232018-11-16
724    - 1.17.3
725    - [BUGFIX] Do not send STOP_WAITING frames when using Q044
726
7272018-10-19
728    - 1.17.2
729    - [BUGFIX] Memory leak in test_frame_rw unit test.
730    - [BUGFIX] Parsing packets with short IETF header: do not overwrite
731      flags.  (Only a problem in unit tests -- benign otherwise.)
732
7332018-10-16
734    - 1.17.0
735    - [API Change] Packet out Memory Interface (PMI) update:
736      - Split PMI pool return into pmi_release and pmi_return
737      - PMI callbacks take peer_ctx and is_ipv6 arguments
738    - [BUGFIX] Fix use-after-free when certificate is updated
739    - Silence gcc warning in optimized mode by performing useless
740      initialization
741    - cmake: use the standard variable CMAKE_BUILD_TYPE instead of
742      DEVEL_MODE
743
7442018-10-03
745    - 1.16.0
746    - [API Change] Add lsquic_conn_n_avail_streams()
747    - [BUGFIX] only dispatch crypto stream read events if WANT_READ is on
748
7492018-09-27
750    - 1.15.0
751    - [API Change] Add LSCONN_ST_PEER_GOING_AWAY to the list of conn statuses
752    - [BUGFIX] free uncompressed headers correctly when error occurs
753
7542018-09-12
755    - 1.14.3
756    - [BUGFIX] Do not abort conn on STREAM frame for a reset stream
757    - [BUGFIX] Drop packets that would become empty due to repackaging.
758      Packets on the scheduled queue may be marked for repackaging.
759      Frames such as ACK frame that are never resent are removed from
760      repackaged packets.  We must check that the newly repackaged packet
761      would not be empty.  If it would be, it is destroyed instead and
762      the next packet on the scheduled queue is used.  Note that this
763      change only affects the logic to return the next packet to be sent.
764      Lost packets that are being rescheduled are already processed in
765      this fashion.
766    - Byteswap CID before logging it - this makes it match Chrome CIDs.
767      (Except Q035, which is the last little-endian GQUIC version we
768      support.)
769
7702018-09-06
771    - 1.14.0
772    - [API Change] Disable packet sending if full batch cannot be sent
773      If lsquic_packets_out_f() cannot send the whole batch, disable
774      packet sending until lsquic_engine_send_unsent_packets() is called.
775    - [BUGFIX] Handle case when STREAM frame does not fit.
776    - [BUGFIX] Always allow incoming STREAM frames to overlap.  Peers
777      may send overlapping STREAM frames even if using versions older
778      than Q043.
779    - Custom header set fixes:
780      - set "FIN reached" flag when custom header with FIN flag is
781        claimed;
782      - do not return custom header set for a reset stream.
783
7842018-08-27
785
786    - 1.13.0
787    - [FEATURE, API Change] Add ability to create custom header set
788      objects via callbacks.  This avoids reading and re-parsing
789      headers from the stream.
790
7912018-08-27
792
793    - 1.12.4
794    - Fix memory leak when engine is destroyed
795    - Fix memory leak in http_client
796    - Fix gcc warning in unit tests
797
7982018-08-22
799
800    - 1.12.3
801    - [BUGFIX] Fix duplicate STREAM frame detection
802
8032018-08-20
804
805    - 1.12.2
806    - [BUGFIX] Update count of scheduled bytes when adjusting size of
807      an already-scheduled packet.
808    - Emit info instead of warning messages when stream is used in
809      unexpected ways.
810
8112018-08-17
812
813    - 1.12.0
814    - [FEATURE, API Change] Add support for certificate verification
815
8162018-08-16
817
818    - 1.11.1
819    - [BUGFIX] Fix STOP_WAITING frame processing in the new Q044 code
820
8212018-08-15
822
823    - 1.11.0
824    - [FEATURE] Add support for Q044.
825
8262018-08-09
827
828    - 1.10.2
829    - [BUGFIX] Don't go over limit when creating delayed streams
830
8312018-07-10
832
833    - 1.10.1
834    - [BUGFIX]  process connections after each batch of packets is read
835      This avoids a problem of accumulating a very large list of packets
836      (possible when speeds are high and socket's receive buffer is large)
837      and processing it all at once.
838    - If glibc is older than 2.17, link with rt.  This is necessary for
839      clock_getres(2).
840    - Add version macros to lsquic.h; remove unnecessary includes.
841
8422018-06-13
843
844    - [BUGFIX] allow multiple parallel connections by default
845
846      Use the original method of tracking connections by CIDs by default.
847      If zero-sized CID support is turned on, connections are tracked by
848      the address.  A new connection is not created if another connection
849      is using the same network address
850
8512018-05-30
852
853    - [FEATURE, API CHANGE] Support zero-sized CIDs in received packets
854
8552018-05-24
856
857    - Close connection properly when packet encryption fails
858
8592018-05-23
860
861    - [BUGFIX] Do not produce packet sequence gaps due to delayed packets
862
8632018-05-21
864
865    - [API Change] Add optional callback to call when handshake is done
866    - [API Change, BUGFIX] After send failure, wait until transport available
867
8682018-05-18
869
870    - [API] Expose useful lsquic_ver2str[] in lsquic.h
871    - [BUGFIX] Do not produce packet sequence gaps due to STREAM frame elision
872    - Improve checks of number of incoming streams limit and associated
873      error reporting.
874    - [BUGFIX] Command-line option `-6` now works correctly.
875
8762018-05-16
877
878    - [FEATURE] DNS resolution
879    - [BUGFIX] Frame insertion mis-ID as overlap instead of dup
880    - http_client: fix priority range generated by -E flag
881
8822018-05-09
883
884    - [FEATURE] Add support for Q043.
885    - Support for versions Q037, Q038, Q041, and Q042 has been removed.
886    - Fix typo in debug message.
887    - Fix code indentation.
888    - Add /* fallthru */ comment to stop newer gcc from complaining.
889    - Logger: fix compilation of optimized Windows build.
890
8912018-05-04
892
893    - [FEATURE] Add support for Q042.
894    - Remove comment: MSPC is obsolete (no code changes)
895    - Prog: use lsquic_str2ver() when processing -o version flag
896    - Remove unused CTIM and SRBF transport parameters
897    - Disable QUIC versions Q037 and Q038 by default
898    - Fix Windows compilation by including compat header file in
899      lshpack.c
900    - Address warnings produced by newer versions of gcc
901    - Future-proof: turn off -Werror
902
9032018-05-02
904
905    - [BUGFIX] Make lsquic_conn_quic_version() available
906    - Switch to using ls-hpack 1.1
907    - [BUGFIX] Do not ignore stream resets after receiving FIN
908
9092018-04-27
910
911    - HPACK: do not allow header block to end with table size update.
912
9132018-04-25
914
915    - [BUGFIX] Do not create gap in sent packnos when squeezing delayed
916      packets.
917    - [BUGFIX] sendctl checks for all unacked bytes, not just retx bytes.
918    - [BUGFIX] connections with blocked scheduled packets are not tickable
919      for sending.
920    - [BUGFIX] Conn is tickable if it wants to send a connection-level
921      frame.
922
9232018-04-23
924
925    - Fix busy loop: tickable must make progress.  When connection is
926      self-reporting as tickable, it must make progress when ticked.  There
927      are two issues:
928        1. If there are buffered packets, the connection is only tickable if
929           they can be sent out.
930        2. A connection is tickable if there are streams on the servicing
931           queue.  When the tick occurs, we must service the stream
932           independent of whether any packets are sent.
933    - Fix assertion in pacer which can be incorrect under some
934      conditions.
935    - cmake: do not turn on address sanitizer if in Travis.
936
9372018-04-20
938
939    - [BUGFIX] Fix bug in lsquic_engine_connect() exposed by yesterday's
940      changes.
941
9422018-04-19
943
944    - [BUGFIX] Add connection to Tickable Queue on stream write
945    - cmake: use MSVC variable instead of trying to detect
946    - engine: improve connection incref/decref logging
947    - stream: don't ignore errors that may occur on triggered flush
948    - connection: remove obsolete method
949    - engine: indicate connection as tickable if previous call went
950      over threshold
951
9522018-04-09
953
954    [API Change, OPTIMIZATION] Only process conns that need to be processed
955
956    The API is simplified: do not expose the user code to several
957    queues.  A "connection queue" is now an internal concept.
958    The user processes connections using the single function
959    lsquic_engine_process_conns().  When this function is called,
960    only those connections are processed that need to be processed.
961    A connection needs to be processed when:
962
963        1. New incoming packets have been fed to the connection.
964        2. User wants to read from a stream that is readable.
965        3. User wants to write to a stream that is writeable.
966        4. There are buffered packets that can be sent out.  (This
967           means that the user wrote to a stream outside of the
968           lsquic library callback.)
969        5. A control frame (such as BLOCKED) needs to be sent out.
970        6. A stream needs to be serviced or delayed stream needs to
971           be created.
972        7. An alarm rings.
973        8. Pacer timer expires.
974
975    To achieve this, the library places the connections into two
976    priority queues (min heaps):
977
978        1. Tickable Queue; and
979        2. Advisory Tick Time queue (ATTQ).
980
981    Each time lsquic_engine_process_conns() is called, the Tickable
982    Queue is emptied.  After the connections have been ticked, they are
983    queried again: if a connection is not being closed, it is placed
984    either in the Tickable Queue if it is ready to be ticked again or
985    it is placed in the Advisory Tick Time Queue.  It is assumed that
986    a connection always has at least one timer set (the idle alarm).
987
988    The connections in the Tickable Queue are arranged in the least
989    recently ticked order.  This lets connections that have been quiet
990    longer to get their packets scheduled first.
991
992    This change means that the library no longer needs to be ticked
993    periodically.  The user code can query the library when is the
994    next tick event and schedule it exactly.  When connections are
995    processed, only the tickable connections are processed, not *all*
996    the connections.  When there are no tick events, it means that no
997    timer event is necessary -- only the file descriptor READ event
998    is active.
999
1000    The following are improvements and simplifications that have
1001    been triggered:
1002
1003        - Queue of connections with incoming packets is gone.
1004        - "Pending Read/Write Events" Queue is gone (along with its
1005          history and progress checks).  This queue has become the
1006          Tickable Queue.
1007        - The connection hash no longer needs to track the connection
1008          insertion order.
1009
10102018-04-02
1011
1012    - [FEATURE] Windows support
1013
1014    - Reduce stack use -- outgoing packet batch is now allocated on the heap.
1015
10162018-03-09
1017
1018    - [OPTIMIZATION] Merge series of ACKs if possible
1019
1020      Parsed single-range ACK frames (that is the majority of frames) are
1021      saved in the connection and their processing is deferred until the
1022      connection is ticked.  If several ACKs come in a series between
1023      adjacent ticks, we check whether the latest ACK is a strict superset
1024      of the saved ACK.  If it is, the older ACK is not processed.
1025
1026      If ACK frames can be merged, they are merged and only one of them is
1027      either processed or saved.
1028
1029    - [OPTIMIZATION] Speed up ACK verification by simplifying send history.
1030
1031      Never generate a gap in the sent packet number sequence.  This reduces
1032      the send history to a single number instead of potentially a series of
1033      packet ranges and thereby speeds up ACK verification.
1034
1035      By default, detecting a gap in the send history is not fatal: only a
1036      single warning is generated per connection.  The connection can continue
1037      to operate even if the ACK verification code is not able to detect some
1038      inconsistencies.
1039
1040    - [OPTIMIZATION] Rearrange the lsquic_send_ctl struct
1041
1042      The first part of struct lsquic_send_ctl now consists of members that
1043      are used in lsquic_send_ctl_got_ack() (in the absense of packet loss,
1044      which is the normal case).  To speed up reads and writes, we no longer
1045      try to save space by using 8- and 16-bit integers.  Use regular integer
1046      width for everything.
1047
1048    - [OPTIMIZATION] Cache size of sent packet.
1049
1050    - [OPTIMIZATION] Keep track of the largest ACKed in packet_out
1051
1052      Instead of parsing our own ACK frames when packet has been acked,
1053      use the value saved in the packet_out structure when the ACK frame
1054      was generated.
1055
1056    - [OPTIMIZATION] Take RTT sampling conditional out of ACK loop
1057
1058    - [OPTIMIZATION] ACK processing: only call clock_gettime() if needed
1059
1060    - [OPTIMIZATION] Several code-level optimizations to ACK processing.
1061
1062    - Fix: http_client: fix -I flag; switch assert() to abort()
1063
10642018-02-26
1065    - [API Change] lsquic_engine_connect() returns pointer to the connection
1066      object.
1067    - [API Change] Add lsquic_conn_get_engine() to get engine object from
1068      connection object.
1069    - [API Change] Add lsquic_conn_status() to query connection status.
1070    - [API Change] Add add lsquic_conn_set_ctx().
1071    - [API Change] Add new timestamp format, e.g. 2017-03-21 13:43:46.671345
1072    - [OPTIMIZATION] Process handshake STREAM frames as soon as packet
1073      arrives.
1074    - [OPTIMIZATION] Do not compile expensive send controller sanity check
1075      by default.
1076    - [OPTIMIZATION] Add fast path to gquic_be_gen_reg_pkt_header.
1077    - [OPTIMIZATION] Only make squeeze function call if necessary.
1078    - [OPTIMIZATION] Speed up Q039 ACK frame parsing.
1079    - [OPTIMIZATION] Fit most used elements of packet_out into first 64 bytes.
1080    - [OPTIMIZATION] Keep track of scheduled bytes instead of calculating.
1081    - [OPTIMIZATION] Prefetch next unacked packet when processing ACK.
1082    - [OPTIMIZATION] Leverage fact that ACK ranges and unacked list are.
1083      ordered.
1084    - [OPTIMIZATION] Reduce function pointer use for STREAM frame generation
1085    - Fix: reset incoming streams that arrive after we send GOAWAY.
1086    - Fix: delay client on_new_conn() call until connection is fully set up.
1087    - Fixes to buffered packets logic: splitting, STREAM frame elision.
1088    - Fix: do not dispatch on_write callback if no packets are available.
1089    - Fix WINDOW_UPDATE send and resend logic.
1090    - Fix STREAM frame extension code.
1091    - Fix: Drop unflushed data when stream is reset.
1092    - Switch to tracking CWND using bytes rather than packets.
1093    - Fix TCP friendly adjustment in cubic.
1094    - Fix: do not generate invalid STOP_WAITING frames during high packet
1095      loss.
1096    - Pacer fixes.
1097
10982017-12-18
1099
1100    - Fix: better follow cubic curve after idle period
1101    - Fix: add missing parts to outgoing packet splitting code
1102    - Fix: compilation using gcc 4.8.4
1103
11042017-10-31
1105
1106    - Add APIs.txt -- describes LSQUIC APIs
1107
11082017-10-31
1109
1110    - [API Change] Sendfile-like functionality is gone.  The stream no
1111      longer opens files and deals with file descriptors.  (Among other
1112      things, this makes the code more portable.)  Three writing functions
1113      are provided:
1114
1115        lsquic_stream_write
1116        lsquic_stream_writev
1117        lsquic_stream_writef    (NEW)
1118
1119      lsquic_stream_writef() is given an abstract reader that has function
1120      pointers for size() and read() functions which the user can implement.
1121      This is the most flexible way.  lsquic_stream_write() and
1122      lsquic_stream_writev() are now both implemented as wrappers around
1123      lsquic_stream_writef().
1124
1125    - [OPTIMIZATION] When writing to stream, be it within or without the
1126      on_write() callback, place data directly into packet buffer,
1127      bypassing auxiliary data structures.  This reduces amount of memory
1128      required, for the amount of data that can be written is limited
1129      by the congestion window.
1130
1131      To support writes outside the on_write() callback, we keep N
1132      outgoing packet buffers per connection which can be written to
1133      by any stream.  One half of these are reserved for the highest
1134      priority stream(s), the other half for all other streams.  This way,
1135      low-priority streams cannot write instead of high-priority streams
1136      and, on the other hand, low-priority streams get a chance to send
1137      their packets out.
1138
1139      The algorithm is as follows:
1140
1141      - When user writes to stream outside of the callback:
1142        - If this is the highest priority stream, place it onto the
1143          reserved N/2 queue or fail.
1144            (The actual size of this queue is dynamic -- MAX(N/2, CWND) --
1145             rather than N/2, allowing high-priority streams to write as
1146             much as can be sent.)
1147        - If the stream is not the highest priority, try to place the
1148          data onto the reserved N/2 queue or fail.
1149      - When tick occurs *and* more packets can be scheduled:
1150        - Transfer packets from the high N/2 queue to the scheduled
1151          queue.
1152        - If more scheduling is allowed:
1153          - Call on_write callbacks for highest-priority streams,
1154            placing resulting packets directly onto the scheduled queue.
1155        - If more scheduling is allowed:
1156          - Transfer packets from the low N/2 queue to the scheduled
1157            queue.
1158        - If more scheduling is allowed:
1159          - Call on_write callbacks for non-highest-priority streams,
1160            placing resulting packets directly onto the scheduled queue
1161
1162      The number N is currently 20, but it could be varied based on
1163      resource usage.
1164
1165    - If stream is created due to incoming headers, make headers readable
1166      from on_new.
1167
1168    - Outgoing packets are no longer marked non-writeable to prevent placing
1169      more than one STREAM frame from the same stream into a single packet.
1170      This property is maintained via code flow and an explicit check.
1171      Packets for stream data are allocated using a special function.
1172
1173    - STREAM frame elision is cheaper, as we only perform it if a reset
1174      stream has outgoing packets referencing it.
1175
1176    - lsquic_packet_out_t is smaller, as stream_rec elements are now
1177      inside a union.
1178
11792017-10-12
1180
1181    - Do not send RST_STREAM when stream is closed for reading
1182    - Raise maximum header size from 4K to 64K
1183    - Check header name and value lengths against maximum imposed by HPACK
1184    - Fix NULL dereference in stream flow controller
1185
11862017-10-09
1187
1188    - Hide handshake implementation behind a set of function pointers
1189    - Use monotonically increasing clock
1190    - Make sure that retx delay is not larger than the max of 60 seconds
1191
11922017-09-29
1193
1194    - A few fixes to code and README
1195
11962017-09-28
1197
1198    - Add support for Q041; drop support for Q040
1199
12002017-09-27
1201
1202    - Fix CMakeLists.txt: BoringSSL include and lib was mixed up
1203
12042017-09-26
1205
1206    - Add support for Mac OS
1207    - Add support for Raspberry Pi
1208    - Fix BoringSSL compilation: include <openssl/hmac.h> explicitly
1209
12102017-09-22
1211
1212    - Initial release
1213