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