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