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