CHANGELOG revision eea99896
12021-03-31
2    - 2.29.6
3    - Documentation: describe lsquic internals ("guts").
4    - Two more fixes to compliance issues found by h3spec.
5    - Truncate, don't abort, SCIDs larger than 16 bytes (PR #244).
6    - Several small internal improvements and space optimizations.
7
82021-03-17
9    - 2.29.5
10    - Fix a few issues detected by h3spec for better compliance with HTTP/3
11      standard.
12
132021-03-08
14    - 2.29.4
15    - [BUGFIX] Infinite loop in stream: returned HQ frame can be at any
16      point on the list.
17    - [BUGFIX] Fail push promise immediately if STREAM_NOPUSH is set.
18
192021-03-03
20    - 2.29.3
21    - [BUGFIX] Do not send RESET_STREAM if writing to stream is already
22      finished.
23    - perf_client: wait for all ACKs before exiting.
24    - Improve how generated RESET_STREAM is logged.
25    - Fix compilation in different combos of adv_tick/conn_stats flags.
26    - Move qpack warning disablement into src/liblsquic/CMakeLists.txt.
27
282021-02-23
29    - 2.29.2
30    - Fix regression in gQUIC server: bug #234.
31
322021-02-18
33    - 2.29.1
34    - Make it possible to build the library and unit tests without
35      libevent.
36    - Build all command-line utilities in bin/
37    - Add perf_client and perf_server command-line utilities to test
38      performance according to the "perf" protocol.
39
402021-02-10
41    - 2.29.0
42    - [FEATURE] QUIC and HTTP/3 Internet Draft 34 support and v1 support.
43      The latter is turned off by default.
44    - Drop support for ID-28 and ID-32.
45    - [BUGFIX] IETF QUIC mini conn receive history (trechist): allow
46      unlimited inserts by dropping smallest elements.
47    - [BUGFIX] gQUIC: set STTL to correct value, issue #226.
48    - [BUGFIX] Account for poison packet gap when MTU probe was too large.
49
502021-02-03
51    - 2.28.0
52    - [API] lsquic_ssl_sess_to_resume_info() is the new way to get
53      session info.
54    - [API] Add user pointer to ea_generate_scid callback.
55    - [API] Add lsquic_dcid_from_packet() -- a fast function to parse
56      out DCID.
57    - [API] Add es_max_batch_size to control outgoing packet batch size.
58    - [BUGFIX] Disallow sending of header while promise is being written.
59    - [BUGFIX] Flush stream when buffered bytes exhaust stream cap.
60    - [BUGFIX] Deactivate HQ frame if writing push promise fails.
61    - Perform sanity check on peer transport parameters and fail the
62      handshake if some flow control limits are too low.  This can be
63      turned off, see es_check_tp_sanity.
64    - http_server: fix how requests are read in "hq" mode.
65
662021-01-27
67    - 2.27.6
68    - [BUGFIX] Replace dispatch read/write events assertion with a check.
69    - [BUGFIX] gQUIC connection close: there is no HEADERS stream without
70      HTTP flag, see issue #220.
71    - http_client, http_server: add hq protocol support and other flags
72      for use with QUIC Interop Runner.
73    - Fix: use IP_PMTUDISC_PROBE (not IP_PMTUDISC_DO) on Linux to set
74      Don't-Fragment flag on outgoing packets.
75    - Fix send_packets_one_by_one on Windows platform when sending
76      multiple iovs, see issue #218.
77    - Exit echo_client on Windows immediately, see issue #219.
78
792021-01-18
80    - 2.27.5
81    - [BUGFIX] Assertion in send controller when path validation fails.
82    - [BUGFIX] Assertion in BBR when sending out-of-order packets is
83      detected.
84    - [BUGFIX] Drop overflow receive history ranges when cloning.
85    - Log correct size of the incoming packet.
86    - Fix internal stream function.
87
882021-01-13
89    - 2.27.4
90    - [API] Add lsquic_conn_get_sni(), fixes issue #203.
91
922021-01-08
93    - 2.27.3
94    - [BUGFIX] gQUIC: do not destroy critical streams when connection is
95      closed.  See issue #201.
96    - [BUGFIX] Drop #if LSQUIC_CONN_STATS from lsquic.h.  See issue #211.
97    - [BUGFIX] Challenge cancellation when path validation fails.
98    - [BUGFIX] Do not send FIN if RST is scheduled to be sent on a stream.
99    - [BUGFIX] gQUIC's is_tickable() when connection is closing.
100    - [BUGFIX] Q050 processing of GOAWAY frames.
101
1022021-01-06
103    - 2.27.2
104    - [BUGFIX] Memory corruption in receive history copy-ranges function.
105
1062021-01-06
107    - 2.27.1
108    - [API] New knob to set outgoing packet batch size.
109    - Aborted connection now become tickable immediately.
110    - Abort connection when HTTP/3 frame cannot be opened (can only happen
111      when malloc fails).
112
1132020-12-31
114    - 2.27.0
115    - [API] Remove keylog callbacks.  See issue #188.
116    - Add a bit more ALPN logging.
117
1182020-12-23
119    - 2.26.2
120    - [BUGFIX] Do not drop incoming data when STOP_SENDING is received.
121    - [BUGFIX] Receipt of STOP_SENDING should not cause read-reset.
122    - [BUGFIX] Allow stream writes after receiving RESET.
123    - [BUGFIX] Typo in stream: ANDing enum with wrong flag.
124    - [BUGFIX] Reset elision: do not use zero as special stream ID value,
125      for zero is a valid stream ID in IETF QUIC.
126    - [API] Add optional on_conncloseframe_received() callback.
127    - Use zero error code in RESET stream sent in response to STOP_SENDING.
128
1292020-12-17
130    - 2.26.1
131    - [BUGFIX] Migration corner cases: drop or pad over path challenge
132      and response frames when necessary.
133    - Fix stream unit test.
134
1352020-12-09
136    - 2.26.0
137    - [OPTIMIZATION] Adjust packet reordering threshold when spurious losses
138      are detected.
139    - [API] Pass pointer to local sockaddr to ea_get_ssl_ctx() callback.
140
1412020-12-04
142    - 2.25.0
143    - [API, FEATURE] Add es_delay_onclose option to delay on_close until all
144      data is ACKed.  Use new function lsquic_stream_has_unacked_data() to
145      learn whether peer acknowledged all data written to stream.
146    - [API] Add optional on_reset() stream callback to get notifications
147      when RESET or STOP_SENDING frames are received.
148    - [BUGFIX] On STOP_SENDING, make conn tickable is _writeable_, not
149      readable.
150
1512020-11-24
152    - 2.24.5
153    - [FEATURE] Improve Delayed ACKs extension and turn it on by default.
154    - Limit receive history to a finite amount of memory.
155
1562020-11-18
157    - 2.24.4
158    - [BUGFIX] Check whether ECN counts are set in ACK struct before using
159      them.
160    - [BUGFIX] Calculate TLP timer correctly when only one packet is in
161      flight.
162    - [BUGFIX] Min RTO delay is 200 milliseconds, not 1 second.
163    - [BUGFIX] Memory leak in QPACK decoder handler: discard hset when
164      necessary.
165    - Allow retired and drained CIDs to be reused after a timeout.
166
1672020-11-11
168    - 2.24.3
169    - [BUGFIX] Get rough RTT estimate on receipt of Handshake packet.
170      This prevents BBR on the client from miscalculating pacing rate,
171      slowing down sending of ACK packets.
172    - [BUGFIX] Packets sent during handshake are app-limited.
173    - [BUGFIX] Bandwidth sampler starts in app-limited mode.
174    - [BUGFIX] Memory leak: free QPACK handler context in stream dtor.
175    - Logging improvements.
176
1772020-11-05
178    - 2.24.2
179    - [BUGFIX] Allow peer to migrate when its SCID is zero-length.
180    - [BUGFIX] PADDING size calculation: only one Short packet can be
181      coalesced.  (This should have been part of the fix in 2.24.1).
182    - Abort connect if received NEW_CONNECTION_ID but current DCID is
183      zero-length.
184    - Improve log messages
185
1862020-11-04
187    - 2.24.1
188    - [API] Allow use of ea_get_ssl_ctx() on the client (optional).  PR #186.
189    - [BUGFIX] Expand datagram with ack-eliciting Initial to 1200 bytes
190      after connection promotion.
191    - [BUGFIX] Discard CRYPTO frames from lower encryption levels after
192      connection promotion.
193    - [BUGFIX] Cancel path response if path could not be initialized.
194
1952020-10-28
196    - 2.24.0
197    - [FEATURE] QUIC and HTTP/3 Internet Draft 31 support.  Drop ID-30
198      and ID-31 support.
199    - [BUGFIX] Divide-by-zero in newly enabled conn stats code when no
200      packets were sent.
201    - [BUGFIX] Memory leak in gQUIC client when server hello cannot be
202      parsed.
203    - [BUGFIX] Server Initial packet size calculation.
204    - Log user-agent and CONN_CLOSE reason when peer reports error.
205    - Example programs: Specify ALPN for echo and md5 clients and servers
206      (issue #184).
207    - Example programs: Don't add "QUIC_" prefix to lines in keylog file
208      (issue #185).
209    - http_server: Fix fd leak in preadv mode; fix preadv() usage when
210      reading from disk.
211
2122020-10-22
213    - 2.23.3
214    - [BUGFIX] Update packetization threshold when writing to stream
215      after packet size is reduced following an RTO.
216
2172020-10-21
218    - 2.23.2
219    - Add QPACK stats collection and experimentation mode, see the new
220      es_qpack_experiment setting.
221    - Log busy connection stats every second using the new "conn-stats"
222      log module.
223    - Log about skipping only once.
224    - Update HTTP/3 greased frame type formula.
225    - Use ls-qpack v2.2.1.
226
2272020-10-13
228    - 2.23.1
229    - [FEATURE] IETF Client 0-RTT support.
230    - [BUGFIX] Do not schedule MTU probe on first tick.
231    - [BUGFIX] Parsing DATAGRAM frame.
232    - [BUGFIX] If push promise fails, do not invoke hset destructor.
233    - [BUGFIX] Client: When connections are IDed by port number, check DCID.
234      Fixes issue #176.
235    - [BUGFIX] Regression introduced in 2.22.0: use correct number of
236      PNSs for IETF mini conn during promotion.
237    - Revert the 2.22.1 lsquic_is_valid_hs_packet change.  All that was
238      necessary is a change to the way we call it in lsquic_engine.  No
239      change to the function itself is required.
240
2412020-10-08
242    - 2.22.1
243    - [BUGFIX] Function that checks validity of handshake packets.
244
2452020-10-07
246    - 2.22.0
247    - [FEATURE] Extensible HTTP Priorities (HTTP/3 only).
248    - [FEATURE] Add conn context to packet-out memory interface (PR #175).
249    - [BUGFIX] gQUIC proof generation: allocate buffer big enough for
250      signature (issue #173).
251    - [BUGFIX] Make library thread-safe: drop use of global variables
252      (issue #133, issue #167).
253    - [BUGFIX] Deactivate only *recent* HQ frame, not any HQ frame.
254    - [BUGFIX] gQUIC server: associate compressed cert with SSL_CTX,
255      instead of keeping them in a separate hash, potentially leading
256      to mismatches.
257    - [BUGFIX] Stream data discard infinite loop: break on FIN.
258    - cmake: add install target via -DCMAKE_INSTALL_PREFIX (PR #171).
259    - Support randomized packet number to begin a connection.
260    - Mini and full IETF connection size optimization.
261    - http_client: specify HTTP priorities based on stream conditions.
262
2632020-09-29
264    - 2.21.0
265    - [FEATURE] QUIC and HTTP/3 Internet Draft 31 support.
266    - [API] Let user generate Souce Connection IDs.
267    - [FEATURE] Allow building lsquic as shared library.
268    - [OPTIMIZATION] Receive history: use a single contiguous memory
269      block for everything.
270    - Deprecate QUIC versions ID-27 and ID-30.
271
2722020-09-25
273    - 2.20.2
274    - [BUGFIX] Memory leak: free pushed promise when refcnt is zero.
275    - [BUGFIX] Memory leak in IETF full conn dtor: cleanup closed IDs sets.
276
2772020-09-23
278    - 2.20.1
279    - [BUGFIX] Typo in new "validate peer addr by DCID" code.  It is
280      a benign bug (works either way), but better to fix it.
281    - Simplify Stream Priority Iterator (SPI).
282    - Minor documentation updates.
283
2842020-09-15
285    - 2.20.0
286    - [FEATURE] QUIC and HTTP/3 Internet Draft 30 support.
287    - [FEATURE] Unreliable Datagram Extension support.
288    - [FEATURE] Adaptive congestion controller.
289    - [BUGFIX] Do not send MAX_STREAM_DATA frames on crypto streams.
290    - [BUGFIX] Fail with CRYPTO_BUFFER_EXCEEDED when too much CRYPTO
291      data comes in.
292    - [BUGFIX] Spin bit is now strictly per path; value is reset on
293      DCID change.
294    - [BUGFIX] Check that max value of max_streams_uni and
295      max_streams_bidi TPs is 2^60.
296    - [BUGFIX] Close IETF mini conn immediately if crypto session
297      cannot be initialized.
298    - Deprecate ID-28 (no browser uses it): it's no longer in the
299      default versions list.
300    - New programs duck_server and duck_client that implement the
301      experimental siduck-00 protocol.  They quack!
302    - IETF crypto streams: don't limit ourselves from sending.
303    - Command-line programs: turn off QL loss bits if -G is used, as
304      Wireshark cannot decrypt QUIC packets when this extension is used.
305    - Turn all h3 framing unit tests back on.
306    - Fix malo initialization when compiled in no-pool mode.
307
3082020-09-08
309    - 2.19.10
310    - [FEATURE] Add lsquic_stream_pwritev().  This function allows one to
311      reduce the number of system calls required to read a file from disk
312      by using lsquic_stream_pwritev() together with preadv(2).
313    - [BUGFIX] When stream is reset, it is writeable -- let user collect
314      the error.
315    - [BUGFIX] Calculate correct conn flow control if reading ends early.
316    - [BUGFIX] Remove stream from read and write queues on internal
317      shutdown.  This is a regression introduced in 2.19.7.
318    - [BUGFIX] Swapped arguments in IETF RESET_FRAME generation.
319    - Turn off mini conn history when compiling with Visual Studio; this
320      allows the project to compile on Windows again.
321    - http_client: Add -3 flag to stop reading from streams early; code
322      cleanup.
323    - Don't use -Werror.
324
3252020-09-02
326    - 2.19.8
327    - [FEATURE] Update the timestamp extension to latest version.
328    - [FEATURE] Cope with appearance of ECN blackholes.
329    - [OPTIMIZATION] return packno offset and size when header is generated.
330    - [BUGFIX] ignore old ACK frames in mini conns.
331    - [BUGFIX] Mark initial server path as initialized.
332    - [BUGFIX] Do not merge ACK if ECN counts do not match.
333    - Turn incoming packet number history in mini conn back on.
334    - Record mini conn event history again when compiled in debug mode.
335    - IETF mini conn: log when ACK is queued.
336    - Clean up and refactor code in several places.
337
3382020-08-26
339    - 2.19.7
340    - Handle ECT-CE event: issue a loss event.
341    - Log the fact that we ignore SETTINGS_MAX_HEADER_LIST_SIZE.
342    - Use Max Push ID in GOAWAY frame to cancel promises.
343    - Add support for HTTP/3 CANCEL_PUSH frame.
344    - lsquic_stream_is_pushed: streams without headers are never pushed.
345    - [BUGFIX] Regression in lsquic_stream_shutdown_internal: now it shuts down.
346    - Improve logic whether to generate CONNECTION_CLOSE.
347
3482020-08-20
349    - 2.19.6
350    - Don't process incoming ECN marks if ECN is not enabled.
351    - Schedule ACK when incoming packet is marked with CE.
352
3532020-08-11
354    - 2.19.5
355    - [BUGFIX] Generate frame record when moving an ACK from one buffered
356      packet to another.
357
3582020-08-06
359    - 2.19.4
360    - [BUGFIX] Do not return an oversize MTU probe to connection twice.
361    - [FEATURE] Delayed Acks updated to latest draft.  Still experimental.
362    - Minor code cleanup in IETF full connection.
363
3642020-08-04
365    - 2.19.3
366    - [BUGFIX] Regression in 2.19.1 that breaks Q050
367
3682020-07-30
369    - 2.19.2
370    - [BUGFIX] Do not reduce PLPMTU size by network overhead.
371    - [BUGFIX] Windows build.
372
3732020-07-29
374    - 2.19.1
375    - [FEATURE] DPLPMTUD support.  IETF connections now search for the
376      maximum packet size, improving throughput.
377    - [DEBUG] Record event in stream history when on_close() is called
378      in dtor.
379
3802020-07-22
381    - 2.18.2
382    - [BUGFIX] Send prediction: lone path challenges do not get squeezed out
383    - Fix crash in http_client: now -K and -B can be used simultaneously
384
3852020-07-14
386    - 2.18.1
387    - [FEATURE] Implement the "QUIC bit grease" extension.
388    - [BUGFIX] Selecting CID used for logging on client.
389    - [BUGFIX] Header protection assertion.
390    - [BUGFIX] Server: enable SSL key logging when cert lookup callback
391      is not set.
392    - Remove some dead code.
393
3942020-07-06
395    - 2.18.0
396    - [API] Rename "0-RTT" to "session resumption." In IETF QUIC, "0-RTT"
397      always refers to early data, meaning a request that the server can
398      reply to in the very first return flight.  A more appropriate name
399      for what we support on the client site is "session resumption," which
400      is standard TLS terminology.  Later, when we add support for 0-RTT
401      (early data), we can use the 0-RTT terminology again, this time in
402      proper context.
403    - [BUGFIX] Do not set certificate callback if ea_lookup_cert is NULL.
404    - [BUGFIX] Make connection tickable when it's marked as closed.
405    - [BUGFIX] Fail certificate lookup if SNI is not present in HTTP mode.
406    - Several documentation fixes and improvements.
407    - Minor code cleanup.
408
4092020-06-24
410    - 2.17.2
411    - [BUGFIX] Infinite loop in stream: advance read offset when discarding
412      data.
413    - [OPTIMIZATION] Header protection: only initialize cipher once.
414    - [OPTIMIZATION] Batch header protection application.
415
4162020-06-18
417    - 2.17.1
418    - [FEATURE] QUIC and HTTP/3 Internet Draft 29 support.
419    - [BUGFIX] Check that scheduled packets are also sendable when
420      calculating a connection's "tickable" property.
421    - [BUGFIX] Don't count scheduled packets as in-flight when pacer is
422      checked on tick.
423    - gQUIC: delay calling on_new for pushed stream until headers are
424      available.
425    - Allow nested calls to lsquic_engine_connect().
426
4272020-06-15
428    - 2.16.3
429    - [OPTIMIZATION] Stash up to two reordered packets in IETF mini conn
430      instead of dropping them.
431    - [BUGFIX] Crash: check decrypt context before using it.  This regression
432      was introduced in 2.16.2.
433
4342020-06-12
435    - 2.16.2
436    - [BUGFIX] ID-28: do not use TLS middlebox compatibility mode in
437      ClientHello.  This change requires using a newer version of BoringSSL.
438    - [BUGFIX] Free connections in Advisory Tick Time Queue in engine dtor.
439    - [BUGFIX] IETF QUIC client: narrow migration check to a single path.
440    - [BUGFIX] NULL dereference: set function pointers for alarm for path
441      challenges 2 and 3.
442    - [BUGFIX] HTTP/3 headers may be followed immediately by trailers.
443    - [BUGFIX] Log messages when SCID changes.
444
4452020-06-09
446    - 2.16.1
447    - [FEATURE] Use "no-progress timeout" after which connection is closed.
448    - [BUGFIX] Select new SCID when current SCID is retired.
449    - [BUGFIX] Don't warn about dropped Initial packet sequence gaps during
450      mini/full handoff.
451    - [BUGFIX] Send correct conn error when HTTP/3 frame is truncated.
452    - [BUGFIX] Mini conn: consider amplification when deciding to return
453      TICK_SEND.
454    - [BUGFIX] Don't double-count tag length in amplification logic.
455    - [BUGFIX] Don't squeeze out lone path challenges.
456    - [BUGFIX] Log messages dealing with scheduled packet queue squeezing.
457    - [BUGFIX] don't wipe current path if no path challenge responses
458      come back.
459    - [BUGFIX] When path is reset, don't lose path_id which is used for
460      logging.
461    - Downgrade flow control violations to info log level from warnings.
462    - Fix connection cap extra check, avoid checks in nested calls.
463    - Fix some unit tests when extra checks are enabled.
464    - Use ls-hpack 2.2.1.
465    - Turn off unconditional extra checks for IETF clients.
466    - Extra checks: don't verify sent size of hello packets.  Client
467      changes DCID length and this check will fail.
468
4692020-06-03
470    - 2.16.0
471    - [API] Use lsxpack_header v206.
472    - [FEATURE] Windows supported.
473    - [BUGFIX] Fix uninitialized variable use in client (regression in
474      2.15.0).
475    - Use ls-hpack 2.2.0.
476    - Use ls-qpack 2.2.0.
477    - Sample programs: fix the way maximum number of packets is
478      calculated.
479    - Remove some dead code.
480
4812020-05-27
482    - 2.15.0
483    - [FEATURE] QUIC and HTTP/3 Internet Draft 28 support.
484    - [BUGFIX] Ignore Retry packets after other packets are decrypted
485      successfully.
486    - [BUGFIX] Transport parameter decoding: CID no longer has 4-byte
487      length minimum.
488    - http_client: fix and optimize lsxpack_header allocator.
489    - Drop support for Internet Draft 25.
490
4912020-05-19
492    - 2.14.8
493    - Support Android.
494    - Rerrange tree: move command-line examples into bin/ and unit
495      tests into tests/ from test/unittests/.
496
4972020-05-12
498    - 2.14.7
499    - [BUGFIX] ALPN-to-version mapping: do not skip h3-Q050.
500    - [BUGFIX] Frame reader: skip headers if target stream is closed.
501
5022020-05-06
503    - 2.14.6
504    - [BUGFIX] Fix amplification mitigation in 0-RTT case.
505    - [BUGFIX] IETF mini connection should not tickable if cannot send
506      a packet due to amplification.
507    - [BUGFIX] Fail if active_connection_id_limit TP is smaller than 2.
508    - [BUGFIX] Qlog server certificates for IETF QUIC connections.
509    - [BUGFIX] Uninitialized struct padding usage in tokgen (benign).
510    - [BUGFIX] Incorrect argument to shi_lookup() (benign).
511
5122020-04-29
513    - 2.14.5
514    - [BUGFIX] In coalesced datagram, ignore packets whose CID does not match.
515    - [BUGFIX] Frame reader: skip headers if target stream is not found.
516    - [BUGFIX] Log message in QPACK decoder handler.
517
5182020-04-24
519    - 2.14.4
520    - [BUGFIX] Heed es_rw_once for pushed HTTP/3 streams.
521    - [BUGFIX] IETF client: set correct flags on bidirectional streams.
522    - [BUGFIX] Generate Cancel Stream QPACK instructions for abandoned
523      streams.
524    - [BUGFIX] Do not call header callbacks after stream is closed.
525    - Use ls-qpack 2.1.1
526
5272020-04-15
528    - 2.14.3
529    - [BUGFIX] gQUIC: pass correct stream to hsi_create_header_set() callback.
530    - [BUGFIX] Use ls-hpack 2.1.1
531    - Improve stream code readability.
532    - Use ls-qpack 2.0.5
533
5342020-04-08
535    - 2.14.2
536    - [BUGFIX] Use ls-qpack 2.0.4
537    - [BUGFIX] Honor max packet size on the client and when path changes.
538    - http_server: fix prepare_decode() function.
539
5402020-04-07
541    - 2.14.1
542    - [BUGFIX] Place connections on tickable queue when sending is reenabled.
543    - [BUGFIX] A connection is tickable if it has unsent packets.
544    - [BUGFIX] Heed peer's max_packet_size transport parameter.
545
5462020-03-30
547    - 2.14.0
548    - [API] Use lsxpack_header structure to send HTTP headers.
549    - [OPTIMIZATION] nocopy's readable_bytes() function.
550    - http_server: fix typo in error message
551    - Use ls-hpack 2.1.0.
552    - Use ls-qpack 2.0.0.
553
5542020-03-23
555    - 2.13.3
556    - [BUGFIX] ACK ping-pong: TIMESTAMP frame is not to be acked.
557
5582020-03-13
559    - 2.13.2
560    - [BUGFIX] Use of new lsxpack_header API's hsi_prepare_decode().
561
5622020-03-12
563    - 2.13.1
564    - [API] Use lsxpack_header structure to process incoming headers.
565    - [BUGFIX] Fix assertion when zero-padding Initial packet.
566    - [BUGFIX] Use idle timeout before we learn of peer's value.
567    - Use ls-hpack 2.0.1 -- has lsxpack_header changes.
568    - Use ls-qpack 0.14.0 -- new, common with ls-hpack, XXH seed (not
569      used yet).
570    - Code cleanup: prefix exported functions with "lsquic_".
571
5722020-03-02
573    - 2.12.0
574    - [FEATURE] QUIC timestamps extension.
575    - [API] New: ea_alpn that is used when not in HTTP mode.
576    - [BUGFIX] SNI is mandatory only for HTTP/3 and gQUIC.
577    - [BUGFIX] Benign double-free -- issue #110.
578    - [BUGFIX] Printing of transport parameters.
579
5802020-02-24
581    - 2.11.1
582    - [FEATURE] QUIC and HTTP/3 Internet Draft 27 support.
583    - [FEATURE] Add experimental delayed ACKs extension.
584    - Drop support for Internet Draft 24.
585    - Code cleanup.
586
5872020-02-14
588    - 2.10.6
589    - [BUGFIX] HTTP/3 framing: don't misinterpret rare occurence as error.
590    - [BUGFIX] Send gap warning due to missing poisoned packet.
591    - Stream unit test for scenario in issue #106.
592
5932020-02-13
594    - 2.10.5
595    - [BUGFIX] BBR: call cci_sent() with correct arguments and at correct
596      time.
597    - Refactor transport parameters module.
598    - Minor code cleanup.
599
6002020-02-11
601    - 2.10.4
602    - [BUGFIX] Send HANDSHAKE_DONE only after Finished is received.
603    - [BUGFIX] Don't treat garbage UDP padding as library error; ignore
604      it instead.
605    - [BUGFIX] Fix compilation on FreeBSD (missing header).
606    - Code cleanup: remove unnecessary #includes.
607
6082020-01-31
609    - 2.10.3
610    - [BUGFIX] Cancel path responses and challenges on old path when
611      switching to new path
612    - Logging network path information.
613
6142020-01-30
615    - 2.10.2
616    - [BUGFIX] Do not delay ACKs for Initial and Handshake packets.
617    - [BUGFIX] Send PATH_CHALLENGE if path changed before mini conn
618      promotion.
619    - Logging improvements.
620    - http_client: discard data faster.
621
6222020-01-29
623    - 2.10.1
624    - [BUGFIX] Coalesced packets could get longer than normal packet
625      size.
626    - Add spin bit configuration option es_spin (-o spin=[01]).
627    - Disable spin bit in 1/16 of connections.
628    - Improve logging a bit.
629
6302020-01-28
631    - 2.10.0
632    - [FEATURE] QUIC and HTTP/3 Internet Draft 25 support.
633    - [API] Drop support for ID-23.
634    - [BUGFIX] Set key phase bit on outgoing packets correctly.
635    - Code cleanup.
636
6372020-01-20
638    - 2.9.0
639    - [API] Drop support for Q039.
640    - Improve ACK-queuing logic.  Send an ACK once in a while if
641      peer keeps on sending non-ack-eliciting packets.
642    - Improve Alt-Svc string: Q050 and later are not included in
643      the old-style "quic" string.
644    - Send stateless resets if connection could not be promoted.
645    - Schedule MAX_DATA if needed when DATA_BLOCKED is received.
646    - Use ls-qpack 0.11.2 -- needed for server push optimization.
647    - Code cleanup: handle some error cases, improve logging.
648
6492020-01-16
650    - 2.8.9
651    - [BUGFIX] Use ls-qpack 0.11.1
652    - [OPTIMIZATION] Generate random bytes in batches.
653    - Change loss_bits transport parameter ID to 0x1057 following
654      latest draft.
655    - Randomize period with which PINGs are sent to elicit ACKs.
656    - Some refactoring and code cleanup.
657
6582020-01-14
659    - 2.8.8
660    - [BUGFIX] Invalid read when parsing IETF transport parameters
661      (this was benign).
662    - [OPTIMIZATION] Frame bundling when using buffered packets in
663      IETF QUIC: a) flush QPACK decoder stream and b) include ACKs
664      in opportunistic fashion.
665    - Fix HTTP/3 framing unit test.
666    - Code cleanup.
667
6682020-01-09
669    - 2.8.7
670    - [BUGFIX] Initial packet size check for IETF mini conn applies to
671      UDP payload, not QUIC packet.
672    - Support old and new school loss_bits transport parameter.
673    - Use Q run length of 64 as suggested in the loss bits Draft.
674    - Undo square wave count when packet is delayed.
675    - Code cleanup; minor fixes.
676
6772020-01-06
678    - 2.8.5
679    - [HTTP3] Verify number of bytes in incoming DATA frames against
680      content-length.
681    - [HTTP3] Stop issuing streams credits if peer stops opening QPACK
682      decoder window.  This addresses a potential attack whereby client
683      can cause the server to keep allocating memory.  See Security
684      Considerations in the QPACK draft.
685    - [BUGFIX] Mini conn: don't shorten max packet size for Q050 and later.
686    - [BUGFIX] Init IETF connection flow controller using correct setting.
687    - [BUGFIX] Fix unintended sign extension when removing header protection.
688    - Code cleanup and minor fixes.
689
6902019-12-30
691    - 2.8.1
692    - [FEATURE] Use occasional packet number gaps to detect optimistic
693      ACK attacks.
694    - [BUGFIX] Q050 client: all packet numbers are in the App PNS.
695    - [OPTIMIZATION] Merge multi-range ACK frames, not just single-range
696      ACK frames.
697    - IETF QUIC: use RTT estimate in ack timeout calculation.
698    - IETF handshake: abort conn when unexpected errors occur.
699    - Use PING rather than MAX_DATA frames to elicit ACKs from peer.
700    - Server: enforce 1200 byte Initial minimum packet size.
701    - [CLEANUP] Remove code to disable gQUIC crypto.
702    - [CLEANUP] Remove n_timestamps from ACK info struct.
703    - Optimize driver: reuse previous ancillary message when possible.
704
7052019-12-23
706    - 2.8.0
707    - [FEATURE] Add support for Q050.
708    - [OPTIMIZATION] Reduce mallocs in gQUIC handshake.
709    - [BUGFIX] Disable redo of failed STREAM frame insertion with debug
710      logging.
711
7122019-12-18
713    - 2.7.3
714    - [DEBUG] Further dedup next advisory tick messages when reason is
715      the same.
716    - [BUGFIX] Update size of `a` array in TP struct.  Fixes (benign)
717      GitHub bug #94.
718    - Use Cubic by default again instead of BBR, as it delivers more
719      consistent performance.
720
7212019-12-11
722    - 2.7.2
723    - [BUGFIX] Send controller: update scheduled bytes when DCID length
724      changes (IETF client).
725    - [BUGFIX] Drop alarm check from sanity test.  It no longer works now
726      that we use loss chains.
727    - [PORTABILITY] Fix build on Alpine Linux.
728    - [PORTABILITY] Fix build using XCode.
729    - Client initial DCID length: use RAND_bytes() instead of rand(3).
730    - Add unit tests for connection min heap.
731    - [DEBUG] Log CID in gQUIC handshake module
732    - [DEBUG] Turn on extra checks for IETF client send controller.
733    - [DEBUG] Dedup next advisory tick messages when reason is IDLE timer.
734    - [DEBUG] QPACK decoder handler: log header error code.
735
7362019-12-05
737    - 2.7.1
738    - [BUGFIX] client: don't call ignore_init() in middle of batch send.
739      ignore_init() makes an assumption that the send controller has access
740      to all outgoing packets.  This change wraps a few IETF full connection
741      methods to delay calling ignore_init() until the engine returns all
742      outgoing packets that were batched.
743    - [BUGFIX] set errno to EAGAIN if sendmmsg() can't send all of them.
744      This needs to be done because the value of errno may be lost on
745      some platforms.
746    - [BUGFIX] Typo that set all bits in sm_qflags lead to crashes.
747    - [BUGFIX] Do not cancel header block processing after failure, as
748      QPACK releases the reference in that case.
749    - [CLEANUP] IETF encrypt: replace assert(0) with a warning.
750    - Several small improvements to the test server.
751
7522019-11-27
753    - 2.7.0
754    - [API, FEATURE] Close connection immediately when ea_packets_out()
755      fails with errno != EAGAIN.  The API change is that errno is now
756      examined.  Make sure to set it if using something other than
757      sendmsg() to send packets.
758    - [CLEANUP] Immediate close logic in IETF full conn.
759    - [CLEANUP] Fix bogus warning about uninitialized `pair' variable.
760
7612019-11-22
762    - 2.6.7
763    - [FEATURE] Implement the QL extension (offered by default).
764    - [BUGFIX] Abort when encountering unexpected HTTP/3 frames.
765    - [BUGFIX] Acknowledge (QPACK) HTTP/3 trailers correctly.
766    - [DEBUG] Turn on debug message for next advisory tick.
767
7682019-11-20
769    - 2.6.6
770    - [BUGFIX] Using HTTP/3 to HTTP/1.x converter.
771    - [BUGFIX] Truncate log messages instead of throwing them away.
772
7732019-11-15
774    - 2.6.5
775    - [BUGFIX] High priority buffered packet queue length.
776    - [BUGFIX] Rain time calculation: max_ack_delay is in milliseconds.
777
7782019-11-12
779    - 2.6.3
780    - [BUGFIX] Close DATA frames with empty payload correctly.
781
7822019-11-11
783    - 2.6.2
784    - [BUGFIX] SCID!=ODCID rule applies to Retry packets, not regular
785      packets.
786    - [BUGFIX] Zero-RTT: BoringSSL no longer flips read/write secrets.
787    - [BUGFIX] Truncate ACK frame rather instead of aborting IETF
788      connection.
789    - [BUGFIX] Client: don't send duplicate reset tokens.
790    - [BUGFIX] Remove invalid assertion in H3 framing code.
791    - Silence a warning in send ctl by restructuring switch() statement.
792
7932019-11-08
794    - 2.6.1
795    - [BUGFIX] set retry token on all resubmitted packets.
796    - Event log: log sent packet flags.  In particular, this allows one
797      to see whether token was sent.
798    - Don't migrate client if es_allow_migration is false.
799
8002019-11-07
801    - 2.6.0
802    - [FEATURE] QUIC and HTTP/3 Internet Draft 24 support
803
8042019-11-07
805    - 2.5.2
806    - [BUGFIX] argument order to gQUIC client constructor.  Regression
807      introduced in 2.5.0.
808    - [BUGFIX] split buffered packet error recovery: destroy the correct
809      packet.
810
8112019-11-04
812    - 2.5.1
813    - [BUGFIX] Fix double-free when emptying a packet number space.
814    - [BUGFIX] http_server: fix md5sum handler: handle EOF correctly.
815    - [BUGFIX] Use random values in bits 4 and 5 of the first byte of
816      verneg packets (regression introduced in 2.5.0).
817    - [OPTIMIZATION] Don't compile in expensive attq checks by default.
818    - [OPTIMIZATION] http_server: compile regexes only once.
819
8202019-10-31
821    - 2.5.0
822    - [API] lsquic_engine_connect() can now be passed QUIC version to use.
823    - [OPTIMIZATION] Queue opportunistic ACKs if there is data to be sent.
824    - [BUGFIX] Don't evict streams from priority iterator if there is
825      only one queue.
826    - [OPTIMIZATION, BUGFIX] Several other optimizations and bug fixes.
827    - Use ls-qpack v0.10.7.
828
8292019-10-24
830    - 2.4.10
831    - [BUGFIX] IETF QUIC server: fix uninitialized variable use.
832    - [BUGFIX] make sure TLSv1.3 is not disabled in SSL object.
833    - [BUGFIX] Use issuer name and serial number to cache certs (SKID
834      values are not unique).
835    - [BUGFIX] Always set the idle alarm in IETF connection so that it
836      can time out.
837    - Use ls-qpack v0.10.6, as it silences some warnings.
838
8392019-10-21
840    - 2.4.8
841    - [OPTIMIZATION, BUGFIX] Use ls-qpack v0.10.5.
842
8432019-10-15
844    - 2.4.7
845    - Add echo client and server to the distibution.
846    - Add MD5 client and server to the distibution.
847    - Fix http_client: check command-line arguments better, prevent crash.
848    - Fix IETF conn: can_write_ack() should only care about APP PNS.
849    - Client: delay stream creation until handshake succeds.
850    - Reset HTTP stream whose write end is closed prematurely.
851    - Fix tickable(): mirror behavior of tick() wrt buffered packets.
852    - Log reason why engine is tickable.
853
8542019-10-11
855    - 2.4.6
856    - Minor code cleanup and logging improvements.
857    - Server and client programs: include library version (e.g. 2.4.6)
858      into `server' and `user-agent' headers.
859
8602019-10-08
861    - 2.4.5
862    - [OPTIMIZATION]: flush encoder stream only when necessary.
863    - [BUGFIX] Use ls-qpack v0.10.2 for new API -- and for a bug fix.
864    - [BUGFIX] Typo in IETF conn SETTINGS writer.
865    - Use latest BoringSSL.
866
8672019-10-08
868    - 2.4.4
869    - [API] Add lsquic_alpn2ver() to aid parsing Alt-Svc header.
870    - [BUGFIX] NULL dereference when H3 frame header would be split.
871    - [BUGFIX] Do not close fixed-size H3 frame prematurely.
872    - [BUGFIX] Allow PING frames in IETF mini conn.
873    - [BUGFIX] Mini conns: don't send any packets after receiving
874      CONNECTION_CLOSE.
875    - [BUGFIX] Client migration: reserve slot for DCID from transport params.
876    - [BUGFIX] Allow max_early_data_size=0 -- early_data might not be there.
877    - [BUGFIX] Use an invalid stream number to reset BPT cache (zero is now a
878      valid stream number).
879    - [SPEC] Use FINAL_SIZE_ERROR when FIN mismatch is detected.
880    - [OPTIMIZATION] Closed connection only gets one chance to send packets.
881    - [OPTIMIZATION] Flush headers stream before packetizing stream data.
882    - [OPTIMIZATION] process QPACK encoder STREAM frames immediately.
883    - Update ls-qpack to v0.10.1.
884
8852019-09-30
886    - 2.4.3
887    - Add GQUIC versions to the list of h3 ALPNs for Alt-Svc header.
888      For example, h3-Q043.  Chrome will switch to using this format at
889      some point in the future.
890    - [BUGFIX] Send correct value in max_streams_uni transport param
891    - [SPEC] Abort IETF QUIC connection if max_early_data_size is not set
892      to 0xFFFFFFFF
893
8942019-09-23
895    - 2.4.2
896    - [BUGFIX] H3 framing: fix zero-byte write when space is available
897    - [BUGFIX] Don't send STREAM frame when incoming unidirectgional stream
898      is closed
899    - [BUGFIX] Cancel all pending writes by stream reset by a GOAWAY
900    - [BUGFIX] Fix use-after-free in IETF full conn
901    - [OPTIMIZATION] Wait for session tickets for two seconds and then drop
902      SSL object and crypto streams.
903
9042019-09-18
905    - 2.4.0
906    - [FEATURE] QUIC and HTTP/3 Internet Draft 23 support
907
9082019-09-13
909    - 2.3.1
910    - [BUGFIX] Fix memory leaks
911    - [BUGFIX] Fix unit tests
912
9132019-09-12
914    - 2.3.0
915    - [FEATURE] BBR congestion control is on by default
916    - [BUGFIX] BBR app-limited logic
917    - [BUGFIX] Fix uninitialized warnings in IETF
918    - [BUGFIX] Update ls-qpack to v0.9.14
919    - [CLEANUP] Code cleanup
920
9212019-09-11
922    - 2.2.0
923    - [FEATURE] Server code is included in the library
924    - [FEATURE] IETF QUIC and HTTP/3 Support (ID-22)
925
9262019-05-13
927    - 1.21.2
928    - [OPTIMIZATION] HPACK: use history to improve compression performance
929
9302019-05-06
931    - 1.21.1
932    - [BUGFIX] If FIN or RST not received, don't delay stream destruction.
933    - [OPTIMIZATION] Speed up HPACK encoder by using same hash value to
934      search static and dynamic tables.
935
9362019-04-12
937    - 1.21.0
938    - [FEATURE] Add qlog log module.
939
9402019-04-01
941    - 1.20.0
942    - [FEATURE] Add support for Q046.
943
9442019-03-19
945    - 1.19.6
946    - [BUGFIX] Ensure that Largest Observed does not decrease in ACKs we
947      send.  ACK frames placed in packets in buffered queues (optimization
948      introduced in 1.17.15) can be preceded by an ACK frame generated later.
949      In this case, the older ACK frame should not be sent out, as Chromium-
950      based servers flags decrease in the ACK frame's Largest Observed value
951      as an error.
952
9532019-03-05
954    - 1.19.5
955    - [BUGFIX] Use correct public key from PUBS based on KEXS index.
956    - [BUGFIX] Check flags before dispatching writes, avoiding assert.
957    - [BUGFIX] Set :scheme to "https" (instead of "HTTP").
958
9592019-02-25
960    - 1.19.4
961    - [BUGFIX] Check buffer bounds when looking up version in 0-RTT blob.
962    - [BUGFIX] http_client: don't fetch 0-rtt info if handshake failed.
963    - Log number of pacer calls at DEBUG, rather than NOTICE, level.
964
9652019-02-18
966    - 1.19.3
967    - [BUGFIX] Q044: don't encode packet number in 6 bytes.  Six-byte
968      packet number encoding does not exist in Q044.  This fixes a
969      regression introduced in '[BUGFIX] Buffered packets can contain
970      ACK frames' -- we need to keep QUIC version in mind when selecting
971      the longest possible packet number encoding used for the buffered
972      packet that carries the ACK.
973    - [BUGFIX] Do not increase CWND when timeout occurs.
974    - http_client: support setting handshake timeout on command line.
975      Use -o handshake_to=timeout.
976    - http_client: use -k to connect UDP socket to pick up ICMP errors.
977    - http_client: allow pathless mode, when only handshake is performed
978      without issuing any requests.  This can be done by simply not
979      specifying a -p flag on the command line.
980
9812019-02-11
982    - 1.19.2
983    - [BUGFIX] Begin negotiation with version provided in 0-RTT info.
984    - [BUGFIX] Version checking in zero_rtt deserialize function.
985
9862019-02-04
987    - 1.19.1
988    - [BUGFIX] Fix Windows build.
989
9902019-02-04
991    - 1.19.0
992    - [FEATURE, API Change] 0-RTT support.  Add function to export 0-RTT
993      information; it can be supplied to a subsequent connect() call.
994    - [FEATURE] Add -0 flag to http_client to exercise 0-RTT support.
995    - [BUGFIX] Resuscitate the Windows build.
996    - [BUGFIX] Send HTTP settings (max header list size) if necessary.
997    - [BUGFIX] Buffered packets can contain ACK frames.
998    - [BUGFIX] Make packet writeable once all STREAM frames are elided.
999    - [BUGFIX] Fix potential null dereference when realloc fails.
1000    - cmake: simplify build configuration.
1001
10022019-01-28
1003    - 1.18.0
1004    - [API Change] Can specify clock granularity in engine settings.
1005    - [BUGFIX] Pacer uses fixed clock granularity.  Since the change on
1006      2018-04-09, it is not necessary to try to approximate the next tick
1007      time in the pacer: it can use fix clock granularity specified by
1008      the user.
1009    - [BUGFIX] Do not tick constantly before handshake is done.
1010    - [BUGFIX] Do not exit tick prematurely: reuse packet with ACK.  Even
1011      if we cannot allocate *more* packets, we could still be able to write
1012      to one already allocated.
1013    - [BUGFIX] Do not schedule pacer if there are no lost packets.
1014
10152019-01-17
1016    - 1.17.15
1017    - [BUGFIX] http_client: make sure only one read per on_read() callback
1018      is performed in the header conversion bypass (-B) mode.
1019    - http_client: with -E, assign random priority when stream is created.
1020    - [OPTIMIZATION] On immediate write, place an ACK frame into the first
1021      buffered packet if an ACK is queued.  This reduces the number of
1022      standalone ACK packets.
1023    - [OPTIMIZATION] Allow placing more than one STREAM frame from the same
1024      stream into an outgoing packet.  This change minimizes the number of
1025      buffered packets required to store several small HTTP messages by
1026      virtue of allowing more than one STREAM frame from HEADERS stream in
1027      the same packet.
1028    - [OPTIMIZATION] Flush headers when writing to buffered packets.  This
1029      causes the headers to be written to the same buffered packet queue,
1030      thereby improving packet utilization, especially for small HTTP
1031      messages.
1032
10332019-01-16
1034    - 1.17.14
1035    - [FEATURE] http_client can now collect stats: time to connect, TTFB,
1036      time to download, requests per seconds, and bandwidth.  See -t flag.
1037    - [BUGFIX] http_client: -B, -K, and -r can be used at the same time.
1038    - [BUGFIX] http_client: do not display cert chain before each request.
1039      Now this is only done once per connection, if the handshake is
1040      successful and -a option is given.
1041    - [BUGFIX] Do not wait to dispatch on_close() after reading.  If a
1042      stream is scheduled to be closed after on_read() callback returns,
1043      close it immediately instead of waiting until the end of the tick.
1044      If client creates new request from on_close() event, they will be
1045      processed in the same tick instead of waiting for the next one.
1046    - [BUGFIX] HEADERS stream is critical: always treat it with highest
1047      priority.
1048
10492019-01-10
1050    - 1.17.12
1051    - [FEATURE] http_client can now issue parallel requests in the context
1052      of a single connection.  See -w option.
1053
10542019-01-03
1055    - 1.17.11
1056    - Fix strict aliasing warning in optimized compilation.
1057
10582018-12-27
1059    - 1.17.10
1060    - Fix the example program to be able to use parallel connections
1061      again.  (See the -n argument.)
1062
10632018-12-18
1064    - 1.17.9
1065    - [BUGFIX] Engine: reduce minimum batch size from 256 to 4
1066
10672018-12-10
1068    - 1.17.8
1069    - [BUGFIX] Fix compilation on FreeBSD and 32-bit Linux
1070
10712018-12-03
1072    - 1.17.7
1073    - [BUGFIX] Do not unset PING alarm before ringing expired alarms.
1074      This prevented PING from ever being sent.
1075
10762018-11-29
1077    - 1.17.6
1078    - Add failsafe: resume sending packets after some time
1079
1080      The change puts a 1-second limit on the amount of time the engine
1081      will not send packets after some packets are delayed.  This makes
1082      the library robust in case the user does not unblock the engine
1083      explicitly using lsquic_engine_send_unsent_packets() call.
1084
1085    - [BUGFIX] Handle corner cases in send controller when packets are
1086      a) delayed or b) dropped during repackaging.
1087    - [BUGFIX] Memory leak: destroy buffered packets during controller
1088      cleanup.
1089
10902018-11-16
1091    - 1.17.3
1092    - [BUGFIX] Do not send STOP_WAITING frames when using Q044
1093
10942018-10-19
1095    - 1.17.2
1096    - [BUGFIX] Memory leak in test_frame_rw unit test.
1097    - [BUGFIX] Parsing packets with short IETF header: do not overwrite
1098      flags.  (Only a problem in unit tests -- benign otherwise.)
1099
11002018-10-16
1101    - 1.17.0
1102    - [API Change] Packet out Memory Interface (PMI) update:
1103      - Split PMI pool return into pmi_release and pmi_return
1104      - PMI callbacks take peer_ctx and is_ipv6 arguments
1105    - [BUGFIX] Fix use-after-free when certificate is updated
1106    - Silence gcc warning in optimized mode by performing useless
1107      initialization
1108    - cmake: use the standard variable CMAKE_BUILD_TYPE instead of
1109      DEVEL_MODE
1110
11112018-10-03
1112    - 1.16.0
1113    - [API Change] Add lsquic_conn_n_avail_streams()
1114    - [BUGFIX] only dispatch crypto stream read events if WANT_READ is on
1115
11162018-09-27
1117    - 1.15.0
1118    - [API Change] Add LSCONN_ST_PEER_GOING_AWAY to the list of conn statuses
1119    - [BUGFIX] free uncompressed headers correctly when error occurs
1120
11212018-09-12
1122    - 1.14.3
1123    - [BUGFIX] Do not abort conn on STREAM frame for a reset stream
1124    - [BUGFIX] Drop packets that would become empty due to repackaging.
1125      Packets on the scheduled queue may be marked for repackaging.
1126      Frames such as ACK frame that are never resent are removed from
1127      repackaged packets.  We must check that the newly repackaged packet
1128      would not be empty.  If it would be, it is destroyed instead and
1129      the next packet on the scheduled queue is used.  Note that this
1130      change only affects the logic to return the next packet to be sent.
1131      Lost packets that are being rescheduled are already processed in
1132      this fashion.
1133    - Byteswap CID before logging it - this makes it match Chrome CIDs.
1134      (Except Q035, which is the last little-endian GQUIC version we
1135      support.)
1136
11372018-09-06
1138    - 1.14.0
1139    - [API Change] Disable packet sending if full batch cannot be sent
1140      If lsquic_packets_out_f() cannot send the whole batch, disable
1141      packet sending until lsquic_engine_send_unsent_packets() is called.
1142    - [BUGFIX] Handle case when STREAM frame does not fit.
1143    - [BUGFIX] Always allow incoming STREAM frames to overlap.  Peers
1144      may send overlapping STREAM frames even if using versions older
1145      than Q043.
1146    - Custom header set fixes:
1147      - set "FIN reached" flag when custom header with FIN flag is
1148        claimed;
1149      - do not return custom header set for a reset stream.
1150
11512018-08-27
1152
1153    - 1.13.0
1154    - [FEATURE, API Change] Add ability to create custom header set
1155      objects via callbacks.  This avoids reading and re-parsing
1156      headers from the stream.
1157
11582018-08-27
1159
1160    - 1.12.4
1161    - Fix memory leak when engine is destroyed
1162    - Fix memory leak in http_client
1163    - Fix gcc warning in unit tests
1164
11652018-08-22
1166
1167    - 1.12.3
1168    - [BUGFIX] Fix duplicate STREAM frame detection
1169
11702018-08-20
1171
1172    - 1.12.2
1173    - [BUGFIX] Update count of scheduled bytes when adjusting size of
1174      an already-scheduled packet.
1175    - Emit info instead of warning messages when stream is used in
1176      unexpected ways.
1177
11782018-08-17
1179
1180    - 1.12.0
1181    - [FEATURE, API Change] Add support for certificate verification
1182
11832018-08-16
1184
1185    - 1.11.1
1186    - [BUGFIX] Fix STOP_WAITING frame processing in the new Q044 code
1187
11882018-08-15
1189
1190    - 1.11.0
1191    - [FEATURE] Add support for Q044.
1192
11932018-08-09
1194
1195    - 1.10.2
1196    - [BUGFIX] Don't go over limit when creating delayed streams
1197
11982018-07-10
1199
1200    - 1.10.1
1201    - [BUGFIX]  process connections after each batch of packets is read
1202      This avoids a problem of accumulating a very large list of packets
1203      (possible when speeds are high and socket's receive buffer is large)
1204      and processing it all at once.
1205    - If glibc is older than 2.17, link with rt.  This is necessary for
1206      clock_getres(2).
1207    - Add version macros to lsquic.h; remove unnecessary includes.
1208
12092018-06-13
1210
1211    - [BUGFIX] allow multiple parallel connections by default
1212
1213      Use the original method of tracking connections by CIDs by default.
1214      If zero-sized CID support is turned on, connections are tracked by
1215      the address.  A new connection is not created if another connection
1216      is using the same network address
1217
12182018-05-30
1219
1220    - [FEATURE, API CHANGE] Support zero-sized CIDs in received packets
1221
12222018-05-24
1223
1224    - Close connection properly when packet encryption fails
1225
12262018-05-23
1227
1228    - [BUGFIX] Do not produce packet sequence gaps due to delayed packets
1229
12302018-05-21
1231
1232    - [API Change] Add optional callback to call when handshake is done
1233    - [API Change, BUGFIX] After send failure, wait until transport available
1234
12352018-05-18
1236
1237    - [API] Expose useful lsquic_ver2str[] in lsquic.h
1238    - [BUGFIX] Do not produce packet sequence gaps due to STREAM frame elision
1239    - Improve checks of number of incoming streams limit and associated
1240      error reporting.
1241    - [BUGFIX] Command-line option `-6` now works correctly.
1242
12432018-05-16
1244
1245    - [FEATURE] DNS resolution
1246    - [BUGFIX] Frame insertion mis-ID as overlap instead of dup
1247    - http_client: fix priority range generated by -E flag
1248
12492018-05-09
1250
1251    - [FEATURE] Add support for Q043.
1252    - Support for versions Q037, Q038, Q041, and Q042 has been removed.
1253    - Fix typo in debug message.
1254    - Fix code indentation.
1255    - Add /* fallthru */ comment to stop newer gcc from complaining.
1256    - Logger: fix compilation of optimized Windows build.
1257
12582018-05-04
1259
1260    - [FEATURE] Add support for Q042.
1261    - Remove comment: MSPC is obsolete (no code changes)
1262    - Prog: use lsquic_str2ver() when processing -o version flag
1263    - Remove unused CTIM and SRBF transport parameters
1264    - Disable QUIC versions Q037 and Q038 by default
1265    - Fix Windows compilation by including compat header file in
1266      lshpack.c
1267    - Address warnings produced by newer versions of gcc
1268    - Future-proof: turn off -Werror
1269
12702018-05-02
1271
1272    - [BUGFIX] Make lsquic_conn_quic_version() available
1273    - Switch to using ls-hpack 1.1
1274    - [BUGFIX] Do not ignore stream resets after receiving FIN
1275
12762018-04-27
1277
1278    - HPACK: do not allow header block to end with table size update.
1279
12802018-04-25
1281
1282    - [BUGFIX] Do not create gap in sent packnos when squeezing delayed
1283      packets.
1284    - [BUGFIX] sendctl checks for all unacked bytes, not just retx bytes.
1285    - [BUGFIX] connections with blocked scheduled packets are not tickable
1286      for sending.
1287    - [BUGFIX] Conn is tickable if it wants to send a connection-level
1288      frame.
1289
12902018-04-23
1291
1292    - Fix busy loop: tickable must make progress.  When connection is
1293      self-reporting as tickable, it must make progress when ticked.  There
1294      are two issues:
1295        1. If there are buffered packets, the connection is only tickable if
1296           they can be sent out.
1297        2. A connection is tickable if there are streams on the servicing
1298           queue.  When the tick occurs, we must service the stream
1299           independent of whether any packets are sent.
1300    - Fix assertion in pacer which can be incorrect under some
1301      conditions.
1302    - cmake: do not turn on address sanitizer if in Travis.
1303
13042018-04-20
1305
1306    - [BUGFIX] Fix bug in lsquic_engine_connect() exposed by yesterday's
1307      changes.
1308
13092018-04-19
1310
1311    - [BUGFIX] Add connection to Tickable Queue on stream write
1312    - cmake: use MSVC variable instead of trying to detect
1313    - engine: improve connection incref/decref logging
1314    - stream: don't ignore errors that may occur on triggered flush
1315    - connection: remove obsolete method
1316    - engine: indicate connection as tickable if previous call went
1317      over threshold
1318
13192018-04-09
1320
1321    [API Change, OPTIMIZATION] Only process conns that need to be processed
1322
1323    The API is simplified: do not expose the user code to several
1324    queues.  A "connection queue" is now an internal concept.
1325    The user processes connections using the single function
1326    lsquic_engine_process_conns().  When this function is called,
1327    only those connections are processed that need to be processed.
1328    A connection needs to be processed when:
1329
1330        1. New incoming packets have been fed to the connection.
1331        2. User wants to read from a stream that is readable.
1332        3. User wants to write to a stream that is writeable.
1333        4. There are buffered packets that can be sent out.  (This
1334           means that the user wrote to a stream outside of the
1335           lsquic library callback.)
1336        5. A control frame (such as BLOCKED) needs to be sent out.
1337        6. A stream needs to be serviced or delayed stream needs to
1338           be created.
1339        7. An alarm rings.
1340        8. Pacer timer expires.
1341
1342    To achieve this, the library places the connections into two
1343    priority queues (min heaps):
1344
1345        1. Tickable Queue; and
1346        2. Advisory Tick Time queue (ATTQ).
1347
1348    Each time lsquic_engine_process_conns() is called, the Tickable
1349    Queue is emptied.  After the connections have been ticked, they are
1350    queried again: if a connection is not being closed, it is placed
1351    either in the Tickable Queue if it is ready to be ticked again or
1352    it is placed in the Advisory Tick Time Queue.  It is assumed that
1353    a connection always has at least one timer set (the idle alarm).
1354
1355    The connections in the Tickable Queue are arranged in the least
1356    recently ticked order.  This lets connections that have been quiet
1357    longer to get their packets scheduled first.
1358
1359    This change means that the library no longer needs to be ticked
1360    periodically.  The user code can query the library when is the
1361    next tick event and schedule it exactly.  When connections are
1362    processed, only the tickable connections are processed, not *all*
1363    the connections.  When there are no tick events, it means that no
1364    timer event is necessary -- only the file descriptor READ event
1365    is active.
1366
1367    The following are improvements and simplifications that have
1368    been triggered:
1369
1370        - Queue of connections with incoming packets is gone.
1371        - "Pending Read/Write Events" Queue is gone (along with its
1372          history and progress checks).  This queue has become the
1373          Tickable Queue.
1374        - The connection hash no longer needs to track the connection
1375          insertion order.
1376
13772018-04-02
1378
1379    - [FEATURE] Windows support
1380
1381    - Reduce stack use -- outgoing packet batch is now allocated on the heap.
1382
13832018-03-09
1384
1385    - [OPTIMIZATION] Merge series of ACKs if possible
1386
1387      Parsed single-range ACK frames (that is the majority of frames) are
1388      saved in the connection and their processing is deferred until the
1389      connection is ticked.  If several ACKs come in a series between
1390      adjacent ticks, we check whether the latest ACK is a strict superset
1391      of the saved ACK.  If it is, the older ACK is not processed.
1392
1393      If ACK frames can be merged, they are merged and only one of them is
1394      either processed or saved.
1395
1396    - [OPTIMIZATION] Speed up ACK verification by simplifying send history.
1397
1398      Never generate a gap in the sent packet number sequence.  This reduces
1399      the send history to a single number instead of potentially a series of
1400      packet ranges and thereby speeds up ACK verification.
1401
1402      By default, detecting a gap in the send history is not fatal: only a
1403      single warning is generated per connection.  The connection can continue
1404      to operate even if the ACK verification code is not able to detect some
1405      inconsistencies.
1406
1407    - [OPTIMIZATION] Rearrange the lsquic_send_ctl struct
1408
1409      The first part of struct lsquic_send_ctl now consists of members that
1410      are used in lsquic_send_ctl_got_ack() (in the absense of packet loss,
1411      which is the normal case).  To speed up reads and writes, we no longer
1412      try to save space by using 8- and 16-bit integers.  Use regular integer
1413      width for everything.
1414
1415    - [OPTIMIZATION] Cache size of sent packet.
1416
1417    - [OPTIMIZATION] Keep track of the largest ACKed in packet_out
1418
1419      Instead of parsing our own ACK frames when packet has been acked,
1420      use the value saved in the packet_out structure when the ACK frame
1421      was generated.
1422
1423    - [OPTIMIZATION] Take RTT sampling conditional out of ACK loop
1424
1425    - [OPTIMIZATION] ACK processing: only call clock_gettime() if needed
1426
1427    - [OPTIMIZATION] Several code-level optimizations to ACK processing.
1428
1429    - Fix: http_client: fix -I flag; switch assert() to abort()
1430
14312018-02-26
1432    - [API Change] lsquic_engine_connect() returns pointer to the connection
1433      object.
1434    - [API Change] Add lsquic_conn_get_engine() to get engine object from
1435      connection object.
1436    - [API Change] Add lsquic_conn_status() to query connection status.
1437    - [API Change] Add add lsquic_conn_set_ctx().
1438    - [API Change] Add new timestamp format, e.g. 2017-03-21 13:43:46.671345
1439    - [OPTIMIZATION] Process handshake STREAM frames as soon as packet
1440      arrives.
1441    - [OPTIMIZATION] Do not compile expensive send controller sanity check
1442      by default.
1443    - [OPTIMIZATION] Add fast path to gquic_be_gen_reg_pkt_header.
1444    - [OPTIMIZATION] Only make squeeze function call if necessary.
1445    - [OPTIMIZATION] Speed up Q039 ACK frame parsing.
1446    - [OPTIMIZATION] Fit most used elements of packet_out into first 64 bytes.
1447    - [OPTIMIZATION] Keep track of scheduled bytes instead of calculating.
1448    - [OPTIMIZATION] Prefetch next unacked packet when processing ACK.
1449    - [OPTIMIZATION] Leverage fact that ACK ranges and unacked list are.
1450      ordered.
1451    - [OPTIMIZATION] Reduce function pointer use for STREAM frame generation
1452    - Fix: reset incoming streams that arrive after we send GOAWAY.
1453    - Fix: delay client on_new_conn() call until connection is fully set up.
1454    - Fixes to buffered packets logic: splitting, STREAM frame elision.
1455    - Fix: do not dispatch on_write callback if no packets are available.
1456    - Fix WINDOW_UPDATE send and resend logic.
1457    - Fix STREAM frame extension code.
1458    - Fix: Drop unflushed data when stream is reset.
1459    - Switch to tracking CWND using bytes rather than packets.
1460    - Fix TCP friendly adjustment in cubic.
1461    - Fix: do not generate invalid STOP_WAITING frames during high packet
1462      loss.
1463    - Pacer fixes.
1464
14652017-12-18
1466
1467    - Fix: better follow cubic curve after idle period
1468    - Fix: add missing parts to outgoing packet splitting code
1469    - Fix: compilation using gcc 4.8.4
1470
14712017-10-31
1472
1473    - Add APIs.txt -- describes LSQUIC APIs
1474
14752017-10-31
1476
1477    - [API Change] Sendfile-like functionality is gone.  The stream no
1478      longer opens files and deals with file descriptors.  (Among other
1479      things, this makes the code more portable.)  Three writing functions
1480      are provided:
1481
1482        lsquic_stream_write
1483        lsquic_stream_writev
1484        lsquic_stream_writef    (NEW)
1485
1486      lsquic_stream_writef() is given an abstract reader that has function
1487      pointers for size() and read() functions which the user can implement.
1488      This is the most flexible way.  lsquic_stream_write() and
1489      lsquic_stream_writev() are now both implemented as wrappers around
1490      lsquic_stream_writef().
1491
1492    - [OPTIMIZATION] When writing to stream, be it within or without the
1493      on_write() callback, place data directly into packet buffer,
1494      bypassing auxiliary data structures.  This reduces amount of memory
1495      required, for the amount of data that can be written is limited
1496      by the congestion window.
1497
1498      To support writes outside the on_write() callback, we keep N
1499      outgoing packet buffers per connection which can be written to
1500      by any stream.  One half of these are reserved for the highest
1501      priority stream(s), the other half for all other streams.  This way,
1502      low-priority streams cannot write instead of high-priority streams
1503      and, on the other hand, low-priority streams get a chance to send
1504      their packets out.
1505
1506      The algorithm is as follows:
1507
1508      - When user writes to stream outside of the callback:
1509        - If this is the highest priority stream, place it onto the
1510          reserved N/2 queue or fail.
1511            (The actual size of this queue is dynamic -- MAX(N/2, CWND) --
1512             rather than N/2, allowing high-priority streams to write as
1513             much as can be sent.)
1514        - If the stream is not the highest priority, try to place the
1515          data onto the reserved N/2 queue or fail.
1516      - When tick occurs *and* more packets can be scheduled:
1517        - Transfer packets from the high N/2 queue to the scheduled
1518          queue.
1519        - If more scheduling is allowed:
1520          - Call on_write callbacks for highest-priority streams,
1521            placing resulting packets directly onto the scheduled queue.
1522        - If more scheduling is allowed:
1523          - Transfer packets from the low N/2 queue to the scheduled
1524            queue.
1525        - If more scheduling is allowed:
1526          - Call on_write callbacks for non-highest-priority streams,
1527            placing resulting packets directly onto the scheduled queue
1528
1529      The number N is currently 20, but it could be varied based on
1530      resource usage.
1531
1532    - If stream is created due to incoming headers, make headers readable
1533      from on_new.
1534
1535    - Outgoing packets are no longer marked non-writeable to prevent placing
1536      more than one STREAM frame from the same stream into a single packet.
1537      This property is maintained via code flow and an explicit check.
1538      Packets for stream data are allocated using a special function.
1539
1540    - STREAM frame elision is cheaper, as we only perform it if a reset
1541      stream has outgoing packets referencing it.
1542
1543    - lsquic_packet_out_t is smaller, as stream_rec elements are now
1544      inside a union.
1545
15462017-10-12
1547
1548    - Do not send RST_STREAM when stream is closed for reading
1549    - Raise maximum header size from 4K to 64K
1550    - Check header name and value lengths against maximum imposed by HPACK
1551    - Fix NULL dereference in stream flow controller
1552
15532017-10-09
1554
1555    - Hide handshake implementation behind a set of function pointers
1556    - Use monotonically increasing clock
1557    - Make sure that retx delay is not larger than the max of 60 seconds
1558
15592017-09-29
1560
1561    - A few fixes to code and README
1562
15632017-09-28
1564
1565    - Add support for Q041; drop support for Q040
1566
15672017-09-27
1568
1569    - Fix CMakeLists.txt: BoringSSL include and lib was mixed up
1570
15712017-09-26
1572
1573    - Add support for Mac OS
1574    - Add support for Raspberry Pi
1575    - Fix BoringSSL compilation: include <openssl/hmac.h> explicitly
1576
15772017-09-22
1578
1579    - Initial release
1580