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