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