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