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