CHANGELOG revision f38b395a
12020-11-24
2    - 2.24.5
3    - [FEATURE] Improve Delayed ACKs extension and turn it on by default.
4    - Limit receive history to a finite amount of memory.
5
62020-11-18
7    - 2.24.4
8    - [BUGFIX] Check whether ECN counts are set in ACK struct before using
9      them.
10    - [BUGFIX] Calculate TLP timer correctly when only one packet is in
11      flight.
12    - [BUGFIX] Min RTO delay is 200 milliseconds, not 1 second.
13    - [BUGFIX] Memory leak in QPACK decoder handler: discard hset when
14      necessary.
15    - Allow retired and drained CIDs to be reused after a timeout.
16
172020-11-11
18    - 2.24.3
19    - [BUGFIX] Get rough RTT estimate on receipt of Handshake packet.
20      This prevents BBR on the client from miscalculating pacing rate,
21      slowing down sending of ACK packets.
22    - [BUGFIX] Packets sent during handshake are app-limited.
23    - [BUGFIX] Bandwidth sampler starts in app-limited mode.
24    - [BUGFIX] Memory leak: free QPACK handler context in stream dtor.
25    - Logging improvements.
26
272020-11-05
28    - 2.24.2
29    - [BUGFIX] Allow peer to migrate when its SCID is zero-length.
30    - [BUGFIX] PADDING size calculation: only one Short packet can be
31      coalesced.  (This should have been part of the fix in 2.24.1).
32    - Abort connect if received NEW_CONNECTION_ID but current DCID is
33      zero-length.
34    - Improve log messages
35
362020-11-04
37    - 2.24.1
38    - [API] Allow use of ea_get_ssl_ctx() on the client (optional).  PR #186.
39    - [BUGFIX] Expand datagram with ack-eliciting Initial to 1200 bytes
40      after connection promotion.
41    - [BUGFIX] Discard CRYPTO frames from lower encryption levels after
42      connection promotion.
43    - [BUGFIX] Cancel path response if path could not be initialized.
44
452020-10-28
46    - 2.24.0
47    - [FEATURE] QUIC and HTTP/3 Internet Draft 31 support.  Drop ID-30
48      and ID-31 support.
49    - [BUGFIX] Divide-by-zero in newly enabled conn stats code when no
50      packets were sent.
51    - [BUGFIX] Memory leak in gQUIC client when server hello cannot be
52      parsed.
53    - [BUGFIX] Server Initial packet size calculation.
54    - Log user-agent and CONN_CLOSE reason when peer reports error.
55    - Example programs: Specify ALPN for echo and md5 clients and servers
56      (issue #184).
57    - Example programs: Don't add "QUIC_" prefix to lines in keylog file
58      (issue #185).
59    - http_server: Fix fd leak in preadv mode; fix preadv() usage when
60      reading from disk.
61
622020-10-22
63    - 2.23.3
64    - [BUGFIX] Update packetization threshold when writing to stream
65      after packet size is reduced following an RTO.
66
672020-10-21
68    - 2.23.2
69    - Add QPACK stats collection and experimentation mode, see the new
70      es_qpack_experiment setting.
71    - Log busy connection stats every second using the new "conn-stats"
72      log module.
73    - Log about skipping only once.
74    - Update HTTP/3 greased frame type formula.
75    - Use ls-qpack v2.2.1.
76
772020-10-13
78    - 2.23.1
79    - [FEATURE] IETF Client 0-RTT support.
80    - [BUGFIX] Do not schedule MTU probe on first tick.
81    - [BUGFIX] Parsing DATAGRAM frame.
82    - [BUGFIX] If push promise fails, do not invoke hset destructor.
83    - [BUGFIX] Client: When connections are IDed by port number, check DCID.
84      Fixes issue #176.
85    - [BUGFIX] Regression introduced in 2.22.0: use correct number of
86      PNSs for IETF mini conn during promotion.
87    - Revert the 2.22.1 lsquic_is_valid_hs_packet change.  All that was
88      necessary is a change to the way we call it in lsquic_engine.  No
89      change to the function itself is required.
90
912020-10-08
92    - 2.22.1
93    - [BUGFIX] Function that checks validity of handshake packets.
94
952020-10-07
96    - 2.22.0
97    - [FEATURE] Extensible HTTP Priorities (HTTP/3 only).
98    - [FEATURE] Add conn context to packet-out memory interface (PR #175).
99    - [BUGFIX] gQUIC proof generation: allocate buffer big enough for
100      signature (issue #173).
101    - [BUGFIX] Make library thread-safe: drop use of global variables
102      (issue #133, issue #167).
103    - [BUGFIX] Deactivate only *recent* HQ frame, not any HQ frame.
104    - [BUGFIX] gQUIC server: associate compressed cert with SSL_CTX,
105      instead of keeping them in a separate hash, potentially leading
106      to mismatches.
107    - [BUGFIX] Stream data discard infinite loop: break on FIN.
108    - cmake: add install target via -DCMAKE_INSTALL_PREFIX (PR #171).
109    - Support randomized packet number to begin a connection.
110    - Mini and full IETF connection size optimization.
111    - http_client: specify HTTP priorities based on stream conditions.
112
1132020-09-29
114    - 2.21.0
115    - [FEATURE] QUIC and HTTP/3 Internet Draft 31 support.
116    - [API] Let user generate Souce Connection IDs.
117    - [FEATURE] Allow building lsquic as shared library.
118    - [OPTIMIZATION] Receive history: use a single contiguous memory
119      block for everything.
120    - Deprecate QUIC versions ID-27 and ID-30.
121
1222020-09-25
123    - 2.20.2
124    - [BUGFIX] Memory leak: free pushed promise when refcnt is zero.
125    - [BUGFIX] Memory leak in IETF full conn dtor: cleanup closed IDs sets.
126
1272020-09-23
128    - 2.20.1
129    - [BUGFIX] Typo in new "validate peer addr by DCID" code.  It is
130      a benign bug (works either way), but better to fix it.
131    - Simplify Stream Priority Iterator (SPI).
132    - Minor documentation updates.
133
1342020-09-15
135    - 2.20.0
136    - [FEATURE] QUIC and HTTP/3 Internet Draft 30 support.
137    - [FEATURE] Unreliable Datagram Extension support.
138    - [FEATURE] Adaptive congestion controller.
139    - [BUGFIX] Do not send MAX_STREAM_DATA frames on crypto streams.
140    - [BUGFIX] Fail with CRYPTO_BUFFER_EXCEEDED when too much CRYPTO
141      data comes in.
142    - [BUGFIX] Spin bit is now strictly per path; value is reset on
143      DCID change.
144    - [BUGFIX] Check that max value of max_streams_uni and
145      max_streams_bidi TPs is 2^60.
146    - [BUGFIX] Close IETF mini conn immediately if crypto session
147      cannot be initialized.
148    - Deprecate ID-28 (no browser uses it): it's no longer in the
149      default versions list.
150    - New programs duck_server and duck_client that implement the
151      experimental siduck-00 protocol.  They quack!
152    - IETF crypto streams: don't limit ourselves from sending.
153    - Command-line programs: turn off QL loss bits if -G is used, as
154      Wireshark cannot decrypt QUIC packets when this extension is used.
155    - Turn all h3 framing unit tests back on.
156    - Fix malo initialization when compiled in no-pool mode.
157
1582020-09-08
159    - 2.19.10
160    - [FEATURE] Add lsquic_stream_pwritev().  This function allows one to
161      reduce the number of system calls required to read a file from disk
162      by using lsquic_stream_pwritev() together with preadv(2).
163    - [BUGFIX] When stream is reset, it is writeable -- let user collect
164      the error.
165    - [BUGFIX] Calculate correct conn flow control if reading ends early.
166    - [BUGFIX] Remove stream from read and write queues on internal
167      shutdown.  This is a regression introduced in 2.19.7.
168    - [BUGFIX] Swapped arguments in IETF RESET_FRAME generation.
169    - Turn off mini conn history when compiling with Visual Studio; this
170      allows the project to compile on Windows again.
171    - http_client: Add -3 flag to stop reading from streams early; code
172      cleanup.
173    - Don't use -Werror.
174
1752020-09-02
176    - 2.19.8
177    - [FEATURE] Update the timestamp extension to latest version.
178    - [FEATURE] Cope with appearance of ECN blackholes.
179    - [OPTIMIZATION] return packno offset and size when header is generated.
180    - [BUGFIX] ignore old ACK frames in mini conns.
181    - [BUGFIX] Mark initial server path as initialized.
182    - [BUGFIX] Do not merge ACK if ECN counts do not match.
183    - Turn incoming packet number history in mini conn back on.
184    - Record mini conn event history again when compiled in debug mode.
185    - IETF mini conn: log when ACK is queued.
186    - Clean up and refactor code in several places.
187
1882020-08-26
189    - 2.19.7
190    - Handle ECT-CE event: issue a loss event.
191    - Log the fact that we ignore SETTINGS_MAX_HEADER_LIST_SIZE.
192    - Use Max Push ID in GOAWAY frame to cancel promises.
193    - Add support for HTTP/3 CANCEL_PUSH frame.
194    - lsquic_stream_is_pushed: streams without headers are never pushed.
195    - [BUGFIX] Regression in lsquic_stream_shutdown_internal: now it shuts down.
196    - Improve logic whether to generate CONNECTION_CLOSE.
197
1982020-08-20
199    - 2.19.6
200    - Don't process incoming ECN marks if ECN is not enabled.
201    - Schedule ACK when incoming packet is marked with CE.
202
2032020-08-11
204    - 2.19.5
205    - [BUGFIX] Generate frame record when moving an ACK from one buffered
206      packet to another.
207
2082020-08-06
209    - 2.19.4
210    - [BUGFIX] Do not return an oversize MTU probe to connection twice.
211    - [FEATURE] Delayed Acks updated to latest draft.  Still experimental.
212    - Minor code cleanup in IETF full connection.
213
2142020-08-04
215    - 2.19.3
216    - [BUGFIX] Regression in 2.19.1 that breaks Q050
217
2182020-07-30
219    - 2.19.2
220    - [BUGFIX] Do not reduce PLPMTU size by network overhead.
221    - [BUGFIX] Windows build.
222
2232020-07-29
224    - 2.19.1
225    - [FEATURE] DPLPMTUD support.  IETF connections now search for the
226      maximum packet size, improving throughput.
227    - [DEBUG] Record event in stream history when on_close() is called
228      in dtor.
229
2302020-07-22
231    - 2.18.2
232    - [BUGFIX] Send prediction: lone path challenges do not get squeezed out
233    - Fix crash in http_client: now -K and -B can be used simultaneously
234
2352020-07-14
236    - 2.18.1
237    - [FEATURE] Implement the "QUIC bit grease" extension.
238    - [BUGFIX] Selecting CID used for logging on client.
239    - [BUGFIX] Header protection assertion.
240    - [BUGFIX] Server: enable SSL key logging when cert lookup callback
241      is not set.
242    - Remove some dead code.
243
2442020-07-06
245    - 2.18.0
246    - [API] Rename "0-RTT" to "session resumption." In IETF QUIC, "0-RTT"
247      always refers to early data, meaning a request that the server can
248      reply to in the very first return flight.  A more appropriate name
249      for what we support on the client site is "session resumption," which
250      is standard TLS terminology.  Later, when we add support for 0-RTT
251      (early data), we can use the 0-RTT terminology again, this time in
252      proper context.
253    - [BUGFIX] Do not set certificate callback if ea_lookup_cert is NULL.
254    - [BUGFIX] Make connection tickable when it's marked as closed.
255    - [BUGFIX] Fail certificate lookup if SNI is not present in HTTP mode.
256    - Several documentation fixes and improvements.
257    - Minor code cleanup.
258
2592020-06-24
260    - 2.17.2
261    - [BUGFIX] Infinite loop in stream: advance read offset when discarding
262      data.
263    - [OPTIMIZATION] Header protection: only initialize cipher once.
264    - [OPTIMIZATION] Batch header protection application.
265
2662020-06-18
267    - 2.17.1
268    - [FEATURE] QUIC and HTTP/3 Internet Draft 29 support.
269    - [BUGFIX] Check that scheduled packets are also sendable when
270      calculating a connection's "tickable" property.
271    - [BUGFIX] Don't count scheduled packets as in-flight when pacer is
272      checked on tick.
273    - gQUIC: delay calling on_new for pushed stream until headers are
274      available.
275    - Allow nested calls to lsquic_engine_connect().
276
2772020-06-15
278    - 2.16.3
279    - [OPTIMIZATION] Stash up to two reordered packets in IETF mini conn
280      instead of dropping them.
281    - [BUGFIX] Crash: check decrypt context before using it.  This regression
282      was introduced in 2.16.2.
283
2842020-06-12
285    - 2.16.2
286    - [BUGFIX] ID-28: do not use TLS middlebox compatibility mode in
287      ClientHello.  This change requires using a newer version of BoringSSL.
288    - [BUGFIX] Free connections in Advisory Tick Time Queue in engine dtor.
289    - [BUGFIX] IETF QUIC client: narrow migration check to a single path.
290    - [BUGFIX] NULL dereference: set function pointers for alarm for path
291      challenges 2 and 3.
292    - [BUGFIX] HTTP/3 headers may be followed immediately by trailers.
293    - [BUGFIX] Log messages when SCID changes.
294
2952020-06-09
296    - 2.16.1
297    - [FEATURE] Use "no-progress timeout" after which connection is closed.
298    - [BUGFIX] Select new SCID when current SCID is retired.
299    - [BUGFIX] Don't warn about dropped Initial packet sequence gaps during
300      mini/full handoff.
301    - [BUGFIX] Send correct conn error when HTTP/3 frame is truncated.
302    - [BUGFIX] Mini conn: consider amplification when deciding to return
303      TICK_SEND.
304    - [BUGFIX] Don't double-count tag length in amplification logic.
305    - [BUGFIX] Don't squeeze out lone path challenges.
306    - [BUGFIX] Log messages dealing with scheduled packet queue squeezing.
307    - [BUGFIX] don't wipe current path if no path challenge responses
308      come back.
309    - [BUGFIX] When path is reset, don't lose path_id which is used for
310      logging.
311    - Downgrade flow control violations to info log level from warnings.
312    - Fix connection cap extra check, avoid checks in nested calls.
313    - Fix some unit tests when extra checks are enabled.
314    - Use ls-hpack 2.2.1.
315    - Turn off unconditional extra checks for IETF clients.
316    - Extra checks: don't verify sent size of hello packets.  Client
317      changes DCID length and this check will fail.
318
3192020-06-03
320    - 2.16.0
321    - [API] Use lsxpack_header v206.
322    - [FEATURE] Windows supported.
323    - [BUGFIX] Fix uninitialized variable use in client (regression in
324      2.15.0).
325    - Use ls-hpack 2.2.0.
326    - Use ls-qpack 2.2.0.
327    - Sample programs: fix the way maximum number of packets is
328      calculated.
329    - Remove some dead code.
330
3312020-05-27
332    - 2.15.0
333    - [FEATURE] QUIC and HTTP/3 Internet Draft 28 support.
334    - [BUGFIX] Ignore Retry packets after other packets are decrypted
335      successfully.
336    - [BUGFIX] Transport parameter decoding: CID no longer has 4-byte
337      length minimum.
338    - http_client: fix and optimize lsxpack_header allocator.
339    - Drop support for Internet Draft 25.
340
3412020-05-19
342    - 2.14.8
343    - Support Android.
344    - Rerrange tree: move command-line examples into bin/ and unit
345      tests into tests/ from test/unittests/.
346
3472020-05-12
348    - 2.14.7
349    - [BUGFIX] ALPN-to-version mapping: do not skip h3-Q050.
350    - [BUGFIX] Frame reader: skip headers if target stream is closed.
351
3522020-05-06
353    - 2.14.6
354    - [BUGFIX] Fix amplification mitigation in 0-RTT case.
355    - [BUGFIX] IETF mini connection should not tickable if cannot send
356      a packet due to amplification.
357    - [BUGFIX] Fail if active_connection_id_limit TP is smaller than 2.
358    - [BUGFIX] Qlog server certificates for IETF QUIC connections.
359    - [BUGFIX] Uninitialized struct padding usage in tokgen (benign).
360    - [BUGFIX] Incorrect argument to shi_lookup() (benign).
361
3622020-04-29
363    - 2.14.5
364    - [BUGFIX] In coalesced datagram, ignore packets whose CID does not match.
365    - [BUGFIX] Frame reader: skip headers if target stream is not found.
366    - [BUGFIX] Log message in QPACK decoder handler.
367
3682020-04-24
369    - 2.14.4
370    - [BUGFIX] Heed es_rw_once for pushed HTTP/3 streams.
371    - [BUGFIX] IETF client: set correct flags on bidirectional streams.
372    - [BUGFIX] Generate Cancel Stream QPACK instructions for abandoned
373      streams.
374    - [BUGFIX] Do not call header callbacks after stream is closed.
375    - Use ls-qpack 2.1.1
376
3772020-04-15
378    - 2.14.3
379    - [BUGFIX] gQUIC: pass correct stream to hsi_create_header_set() callback.
380    - [BUGFIX] Use ls-hpack 2.1.1
381    - Improve stream code readability.
382    - Use ls-qpack 2.0.5
383
3842020-04-08
385    - 2.14.2
386    - [BUGFIX] Use ls-qpack 2.0.4
387    - [BUGFIX] Honor max packet size on the client and when path changes.
388    - http_server: fix prepare_decode() function.
389
3902020-04-07
391    - 2.14.1
392    - [BUGFIX] Place connections on tickable queue when sending is reenabled.
393    - [BUGFIX] A connection is tickable if it has unsent packets.
394    - [BUGFIX] Heed peer's max_packet_size transport parameter.
395
3962020-03-30
397    - 2.14.0
398    - [API] Use lsxpack_header structure to send HTTP headers.
399    - [OPTIMIZATION] nocopy's readable_bytes() function.
400    - http_server: fix typo in error message
401    - Use ls-hpack 2.1.0.
402    - Use ls-qpack 2.0.0.
403
4042020-03-23
405    - 2.13.3
406    - [BUGFIX] ACK ping-pong: TIMESTAMP frame is not to be acked.
407
4082020-03-13
409    - 2.13.2
410    - [BUGFIX] Use of new lsxpack_header API's hsi_prepare_decode().
411
4122020-03-12
413    - 2.13.1
414    - [API] Use lsxpack_header structure to process incoming headers.
415    - [BUGFIX] Fix assertion when zero-padding Initial packet.
416    - [BUGFIX] Use idle timeout before we learn of peer's value.
417    - Use ls-hpack 2.0.1 -- has lsxpack_header changes.
418    - Use ls-qpack 0.14.0 -- new, common with ls-hpack, XXH seed (not
419      used yet).
420    - Code cleanup: prefix exported functions with "lsquic_".
421
4222020-03-02
423    - 2.12.0
424    - [FEATURE] QUIC timestamps extension.
425    - [API] New: ea_alpn that is used when not in HTTP mode.
426    - [BUGFIX] SNI is mandatory only for HTTP/3 and gQUIC.
427    - [BUGFIX] Benign double-free -- issue #110.
428    - [BUGFIX] Printing of transport parameters.
429
4302020-02-24
431    - 2.11.1
432    - [FEATURE] QUIC and HTTP/3 Internet Draft 27 support.
433    - [FEATURE] Add experimental delayed ACKs extension.
434    - Drop support for Internet Draft 24.
435    - Code cleanup.
436
4372020-02-14
438    - 2.10.6
439    - [BUGFIX] HTTP/3 framing: don't misinterpret rare occurence as error.
440    - [BUGFIX] Send gap warning due to missing poisoned packet.
441    - Stream unit test for scenario in issue #106.
442
4432020-02-13
444    - 2.10.5
445    - [BUGFIX] BBR: call cci_sent() with correct arguments and at correct
446      time.
447    - Refactor transport parameters module.
448    - Minor code cleanup.
449
4502020-02-11
451    - 2.10.4
452    - [BUGFIX] Send HANDSHAKE_DONE only after Finished is received.
453    - [BUGFIX] Don't treat garbage UDP padding as library error; ignore
454      it instead.
455    - [BUGFIX] Fix compilation on FreeBSD (missing header).
456    - Code cleanup: remove unnecessary #includes.
457
4582020-01-31
459    - 2.10.3
460    - [BUGFIX] Cancel path responses and challenges on old path when
461      switching to new path
462    - Logging network path information.
463
4642020-01-30
465    - 2.10.2
466    - [BUGFIX] Do not delay ACKs for Initial and Handshake packets.
467    - [BUGFIX] Send PATH_CHALLENGE if path changed before mini conn
468      promotion.
469    - Logging improvements.
470    - http_client: discard data faster.
471
4722020-01-29
473    - 2.10.1
474    - [BUGFIX] Coalesced packets could get longer than normal packet
475      size.
476    - Add spin bit configuration option es_spin (-o spin=[01]).
477    - Disable spin bit in 1/16 of connections.
478    - Improve logging a bit.
479
4802020-01-28
481    - 2.10.0
482    - [FEATURE] QUIC and HTTP/3 Internet Draft 25 support.
483    - [API] Drop support for ID-23.
484    - [BUGFIX] Set key phase bit on outgoing packets correctly.
485    - Code cleanup.
486
4872020-01-20
488    - 2.9.0
489    - [API] Drop support for Q039.
490    - Improve ACK-queuing logic.  Send an ACK once in a while if
491      peer keeps on sending non-ack-eliciting packets.
492    - Improve Alt-Svc string: Q050 and later are not included in
493      the old-style "quic" string.
494    - Send stateless resets if connection could not be promoted.
495    - Schedule MAX_DATA if needed when DATA_BLOCKED is received.
496    - Use ls-qpack 0.11.2 -- needed for server push optimization.
497    - Code cleanup: handle some error cases, improve logging.
498
4992020-01-16
500    - 2.8.9
501    - [BUGFIX] Use ls-qpack 0.11.1
502    - [OPTIMIZATION] Generate random bytes in batches.
503    - Change loss_bits transport parameter ID to 0x1057 following
504      latest draft.
505    - Randomize period with which PINGs are sent to elicit ACKs.
506    - Some refactoring and code cleanup.
507
5082020-01-14
509    - 2.8.8
510    - [BUGFIX] Invalid read when parsing IETF transport parameters
511      (this was benign).
512    - [OPTIMIZATION] Frame bundling when using buffered packets in
513      IETF QUIC: a) flush QPACK decoder stream and b) include ACKs
514      in opportunistic fashion.
515    - Fix HTTP/3 framing unit test.
516    - Code cleanup.
517
5182020-01-09
519    - 2.8.7
520    - [BUGFIX] Initial packet size check for IETF mini conn applies to
521      UDP payload, not QUIC packet.
522    - Support old and new school loss_bits transport parameter.
523    - Use Q run length of 64 as suggested in the loss bits Draft.
524    - Undo square wave count when packet is delayed.
525    - Code cleanup; minor fixes.
526
5272020-01-06
528    - 2.8.5
529    - [HTTP3] Verify number of bytes in incoming DATA frames against
530      content-length.
531    - [HTTP3] Stop issuing streams credits if peer stops opening QPACK
532      decoder window.  This addresses a potential attack whereby client
533      can cause the server to keep allocating memory.  See Security
534      Considerations in the QPACK draft.
535    - [BUGFIX] Mini conn: don't shorten max packet size for Q050 and later.
536    - [BUGFIX] Init IETF connection flow controller using correct setting.
537    - [BUGFIX] Fix unintended sign extension when removing header protection.
538    - Code cleanup and minor fixes.
539
5402019-12-30
541    - 2.8.1
542    - [FEATURE] Use occasional packet number gaps to detect optimistic
543      ACK attacks.
544    - [BUGFIX] Q050 client: all packet numbers are in the App PNS.
545    - [OPTIMIZATION] Merge multi-range ACK frames, not just single-range
546      ACK frames.
547    - IETF QUIC: use RTT estimate in ack timeout calculation.
548    - IETF handshake: abort conn when unexpected errors occur.
549    - Use PING rather than MAX_DATA frames to elicit ACKs from peer.
550    - Server: enforce 1200 byte Initial minimum packet size.
551    - [CLEANUP] Remove code to disable gQUIC crypto.
552    - [CLEANUP] Remove n_timestamps from ACK info struct.
553    - Optimize driver: reuse previous ancillary message when possible.
554
5552019-12-23
556    - 2.8.0
557    - [FEATURE] Add support for Q050.
558    - [OPTIMIZATION] Reduce mallocs in gQUIC handshake.
559    - [BUGFIX] Disable redo of failed STREAM frame insertion with debug
560      logging.
561
5622019-12-18
563    - 2.7.3
564    - [DEBUG] Further dedup next advisory tick messages when reason is
565      the same.
566    - [BUGFIX] Update size of `a` array in TP struct.  Fixes (benign)
567      GitHub bug #94.
568    - Use Cubic by default again instead of BBR, as it delivers more
569      consistent performance.
570
5712019-12-11
572    - 2.7.2
573    - [BUGFIX] Send controller: update scheduled bytes when DCID length
574      changes (IETF client).
575    - [BUGFIX] Drop alarm check from sanity test.  It no longer works now
576      that we use loss chains.
577    - [PORTABILITY] Fix build on Alpine Linux.
578    - [PORTABILITY] Fix build using XCode.
579    - Client initial DCID length: use RAND_bytes() instead of rand(3).
580    - Add unit tests for connection min heap.
581    - [DEBUG] Log CID in gQUIC handshake module
582    - [DEBUG] Turn on extra checks for IETF client send controller.
583    - [DEBUG] Dedup next advisory tick messages when reason is IDLE timer.
584    - [DEBUG] QPACK decoder handler: log header error code.
585
5862019-12-05
587    - 2.7.1
588    - [BUGFIX] client: don't call ignore_init() in middle of batch send.
589      ignore_init() makes an assumption that the send controller has access
590      to all outgoing packets.  This change wraps a few IETF full connection
591      methods to delay calling ignore_init() until the engine returns all
592      outgoing packets that were batched.
593    - [BUGFIX] set errno to EAGAIN if sendmmsg() can't send all of them.
594      This needs to be done because the value of errno may be lost on
595      some platforms.
596    - [BUGFIX] Typo that set all bits in sm_qflags lead to crashes.
597    - [BUGFIX] Do not cancel header block processing after failure, as
598      QPACK releases the reference in that case.
599    - [CLEANUP] IETF encrypt: replace assert(0) with a warning.
600    - Several small improvements to the test server.
601
6022019-11-27
603    - 2.7.0
604    - [API, FEATURE] Close connection immediately when ea_packets_out()
605      fails with errno != EAGAIN.  The API change is that errno is now
606      examined.  Make sure to set it if using something other than
607      sendmsg() to send packets.
608    - [CLEANUP] Immediate close logic in IETF full conn.
609    - [CLEANUP] Fix bogus warning about uninitialized `pair' variable.
610
6112019-11-22
612    - 2.6.7
613    - [FEATURE] Implement the QL extension (offered by default).
614    - [BUGFIX] Abort when encountering unexpected HTTP/3 frames.
615    - [BUGFIX] Acknowledge (QPACK) HTTP/3 trailers correctly.
616    - [DEBUG] Turn on debug message for next advisory tick.
617
6182019-11-20
619    - 2.6.6
620    - [BUGFIX] Using HTTP/3 to HTTP/1.x converter.
621    - [BUGFIX] Truncate log messages instead of throwing them away.
622
6232019-11-15
624    - 2.6.5
625    - [BUGFIX] High priority buffered packet queue length.
626    - [BUGFIX] Rain time calculation: max_ack_delay is in milliseconds.
627
6282019-11-12
629    - 2.6.3
630    - [BUGFIX] Close DATA frames with empty payload correctly.
631
6322019-11-11
633    - 2.6.2
634    - [BUGFIX] SCID!=ODCID rule applies to Retry packets, not regular
635      packets.
636    - [BUGFIX] Zero-RTT: BoringSSL no longer flips read/write secrets.
637    - [BUGFIX] Truncate ACK frame rather instead of aborting IETF
638      connection.
639    - [BUGFIX] Client: don't send duplicate reset tokens.
640    - [BUGFIX] Remove invalid assertion in H3 framing code.
641    - Silence a warning in send ctl by restructuring switch() statement.
642
6432019-11-08
644    - 2.6.1
645    - [BUGFIX] set retry token on all resubmitted packets.
646    - Event log: log sent packet flags.  In particular, this allows one
647      to see whether token was sent.
648    - Don't migrate client if es_allow_migration is false.
649
6502019-11-07
651    - 2.6.0
652    - [FEATURE] QUIC and HTTP/3 Internet Draft 24 support
653
6542019-11-07
655    - 2.5.2
656    - [BUGFIX] argument order to gQUIC client constructor.  Regression
657      introduced in 2.5.0.
658    - [BUGFIX] split buffered packet error recovery: destroy the correct
659      packet.
660
6612019-11-04
662    - 2.5.1
663    - [BUGFIX] Fix double-free when emptying a packet number space.
664    - [BUGFIX] http_server: fix md5sum handler: handle EOF correctly.
665    - [BUGFIX] Use random values in bits 4 and 5 of the first byte of
666      verneg packets (regression introduced in 2.5.0).
667    - [OPTIMIZATION] Don't compile in expensive attq checks by default.
668    - [OPTIMIZATION] http_server: compile regexes only once.
669
6702019-10-31
671    - 2.5.0
672    - [API] lsquic_engine_connect() can now be passed QUIC version to use.
673    - [OPTIMIZATION] Queue opportunistic ACKs if there is data to be sent.
674    - [BUGFIX] Don't evict streams from priority iterator if there is
675      only one queue.
676    - [OPTIMIZATION, BUGFIX] Several other optimizations and bug fixes.
677    - Use ls-qpack v0.10.7.
678
6792019-10-24
680    - 2.4.10
681    - [BUGFIX] IETF QUIC server: fix uninitialized variable use.
682    - [BUGFIX] make sure TLSv1.3 is not disabled in SSL object.
683    - [BUGFIX] Use issuer name and serial number to cache certs (SKID
684      values are not unique).
685    - [BUGFIX] Always set the idle alarm in IETF connection so that it
686      can time out.
687    - Use ls-qpack v0.10.6, as it silences some warnings.
688
6892019-10-21
690    - 2.4.8
691    - [OPTIMIZATION, BUGFIX] Use ls-qpack v0.10.5.
692
6932019-10-15
694    - 2.4.7
695    - Add echo client and server to the distibution.
696    - Add MD5 client and server to the distibution.
697    - Fix http_client: check command-line arguments better, prevent crash.
698    - Fix IETF conn: can_write_ack() should only care about APP PNS.
699    - Client: delay stream creation until handshake succeds.
700    - Reset HTTP stream whose write end is closed prematurely.
701    - Fix tickable(): mirror behavior of tick() wrt buffered packets.
702    - Log reason why engine is tickable.
703
7042019-10-11
705    - 2.4.6
706    - Minor code cleanup and logging improvements.
707    - Server and client programs: include library version (e.g. 2.4.6)
708      into `server' and `user-agent' headers.
709
7102019-10-08
711    - 2.4.5
712    - [OPTIMIZATION]: flush encoder stream only when necessary.
713    - [BUGFIX] Use ls-qpack v0.10.2 for new API -- and for a bug fix.
714    - [BUGFIX] Typo in IETF conn SETTINGS writer.
715    - Use latest BoringSSL.
716
7172019-10-08
718    - 2.4.4
719    - [API] Add lsquic_alpn2ver() to aid parsing Alt-Svc header.
720    - [BUGFIX] NULL dereference when H3 frame header would be split.
721    - [BUGFIX] Do not close fixed-size H3 frame prematurely.
722    - [BUGFIX] Allow PING frames in IETF mini conn.
723    - [BUGFIX] Mini conns: don't send any packets after receiving
724      CONNECTION_CLOSE.
725    - [BUGFIX] Client migration: reserve slot for DCID from transport params.
726    - [BUGFIX] Allow max_early_data_size=0 -- early_data might not be there.
727    - [BUGFIX] Use an invalid stream number to reset BPT cache (zero is now a
728      valid stream number).
729    - [SPEC] Use FINAL_SIZE_ERROR when FIN mismatch is detected.
730    - [OPTIMIZATION] Closed connection only gets one chance to send packets.
731    - [OPTIMIZATION] Flush headers stream before packetizing stream data.
732    - [OPTIMIZATION] process QPACK encoder STREAM frames immediately.
733    - Update ls-qpack to v0.10.1.
734
7352019-09-30
736    - 2.4.3
737    - Add GQUIC versions to the list of h3 ALPNs for Alt-Svc header.
738      For example, h3-Q043.  Chrome will switch to using this format at
739      some point in the future.
740    - [BUGFIX] Send correct value in max_streams_uni transport param
741    - [SPEC] Abort IETF QUIC connection if max_early_data_size is not set
742      to 0xFFFFFFFF
743
7442019-09-23
745    - 2.4.2
746    - [BUGFIX] H3 framing: fix zero-byte write when space is available
747    - [BUGFIX] Don't send STREAM frame when incoming unidirectgional stream
748      is closed
749    - [BUGFIX] Cancel all pending writes by stream reset by a GOAWAY
750    - [BUGFIX] Fix use-after-free in IETF full conn
751    - [OPTIMIZATION] Wait for session tickets for two seconds and then drop
752      SSL object and crypto streams.
753
7542019-09-18
755    - 2.4.0
756    - [FEATURE] QUIC and HTTP/3 Internet Draft 23 support
757
7582019-09-13
759    - 2.3.1
760    - [BUGFIX] Fix memory leaks
761    - [BUGFIX] Fix unit tests
762
7632019-09-12
764    - 2.3.0
765    - [FEATURE] BBR congestion control is on by default
766    - [BUGFIX] BBR app-limited logic
767    - [BUGFIX] Fix uninitialized warnings in IETF
768    - [BUGFIX] Update ls-qpack to v0.9.14
769    - [CLEANUP] Code cleanup
770
7712019-09-11
772    - 2.2.0
773    - [FEATURE] Server code is included in the library
774    - [FEATURE] IETF QUIC and HTTP/3 Support (ID-22)
775
7762019-05-13
777    - 1.21.2
778    - [OPTIMIZATION] HPACK: use history to improve compression performance
779
7802019-05-06
781    - 1.21.1
782    - [BUGFIX] If FIN or RST not received, don't delay stream destruction.
783    - [OPTIMIZATION] Speed up HPACK encoder by using same hash value to
784      search static and dynamic tables.
785
7862019-04-12
787    - 1.21.0
788    - [FEATURE] Add qlog log module.
789
7902019-04-01
791    - 1.20.0
792    - [FEATURE] Add support for Q046.
793
7942019-03-19
795    - 1.19.6
796    - [BUGFIX] Ensure that Largest Observed does not decrease in ACKs we
797      send.  ACK frames placed in packets in buffered queues (optimization
798      introduced in 1.17.15) can be preceded by an ACK frame generated later.
799      In this case, the older ACK frame should not be sent out, as Chromium-
800      based servers flags decrease in the ACK frame's Largest Observed value
801      as an error.
802
8032019-03-05
804    - 1.19.5
805    - [BUGFIX] Use correct public key from PUBS based on KEXS index.
806    - [BUGFIX] Check flags before dispatching writes, avoiding assert.
807    - [BUGFIX] Set :scheme to "https" (instead of "HTTP").
808
8092019-02-25
810    - 1.19.4
811    - [BUGFIX] Check buffer bounds when looking up version in 0-RTT blob.
812    - [BUGFIX] http_client: don't fetch 0-rtt info if handshake failed.
813    - Log number of pacer calls at DEBUG, rather than NOTICE, level.
814
8152019-02-18
816    - 1.19.3
817    - [BUGFIX] Q044: don't encode packet number in 6 bytes.  Six-byte
818      packet number encoding does not exist in Q044.  This fixes a
819      regression introduced in '[BUGFIX] Buffered packets can contain
820      ACK frames' -- we need to keep QUIC version in mind when selecting
821      the longest possible packet number encoding used for the buffered
822      packet that carries the ACK.
823    - [BUGFIX] Do not increase CWND when timeout occurs.
824    - http_client: support setting handshake timeout on command line.
825      Use -o handshake_to=timeout.
826    - http_client: use -k to connect UDP socket to pick up ICMP errors.
827    - http_client: allow pathless mode, when only handshake is performed
828      without issuing any requests.  This can be done by simply not
829      specifying a -p flag on the command line.
830
8312019-02-11
832    - 1.19.2
833    - [BUGFIX] Begin negotiation with version provided in 0-RTT info.
834    - [BUGFIX] Version checking in zero_rtt deserialize function.
835
8362019-02-04
837    - 1.19.1
838    - [BUGFIX] Fix Windows build.
839
8402019-02-04
841    - 1.19.0
842    - [FEATURE, API Change] 0-RTT support.  Add function to export 0-RTT
843      information; it can be supplied to a subsequent connect() call.
844    - [FEATURE] Add -0 flag to http_client to exercise 0-RTT support.
845    - [BUGFIX] Resuscitate the Windows build.
846    - [BUGFIX] Send HTTP settings (max header list size) if necessary.
847    - [BUGFIX] Buffered packets can contain ACK frames.
848    - [BUGFIX] Make packet writeable once all STREAM frames are elided.
849    - [BUGFIX] Fix potential null dereference when realloc fails.
850    - cmake: simplify build configuration.
851
8522019-01-28
853    - 1.18.0
854    - [API Change] Can specify clock granularity in engine settings.
855    - [BUGFIX] Pacer uses fixed clock granularity.  Since the change on
856      2018-04-09, it is not necessary to try to approximate the next tick
857      time in the pacer: it can use fix clock granularity specified by
858      the user.
859    - [BUGFIX] Do not tick constantly before handshake is done.
860    - [BUGFIX] Do not exit tick prematurely: reuse packet with ACK.  Even
861      if we cannot allocate *more* packets, we could still be able to write
862      to one already allocated.
863    - [BUGFIX] Do not schedule pacer if there are no lost packets.
864
8652019-01-17
866    - 1.17.15
867    - [BUGFIX] http_client: make sure only one read per on_read() callback
868      is performed in the header conversion bypass (-B) mode.
869    - http_client: with -E, assign random priority when stream is created.
870    - [OPTIMIZATION] On immediate write, place an ACK frame into the first
871      buffered packet if an ACK is queued.  This reduces the number of
872      standalone ACK packets.
873    - [OPTIMIZATION] Allow placing more than one STREAM frame from the same
874      stream into an outgoing packet.  This change minimizes the number of
875      buffered packets required to store several small HTTP messages by
876      virtue of allowing more than one STREAM frame from HEADERS stream in
877      the same packet.
878    - [OPTIMIZATION] Flush headers when writing to buffered packets.  This
879      causes the headers to be written to the same buffered packet queue,
880      thereby improving packet utilization, especially for small HTTP
881      messages.
882
8832019-01-16
884    - 1.17.14
885    - [FEATURE] http_client can now collect stats: time to connect, TTFB,
886      time to download, requests per seconds, and bandwidth.  See -t flag.
887    - [BUGFIX] http_client: -B, -K, and -r can be used at the same time.
888    - [BUGFIX] http_client: do not display cert chain before each request.
889      Now this is only done once per connection, if the handshake is
890      successful and -a option is given.
891    - [BUGFIX] Do not wait to dispatch on_close() after reading.  If a
892      stream is scheduled to be closed after on_read() callback returns,
893      close it immediately instead of waiting until the end of the tick.
894      If client creates new request from on_close() event, they will be
895      processed in the same tick instead of waiting for the next one.
896    - [BUGFIX] HEADERS stream is critical: always treat it with highest
897      priority.
898
8992019-01-10
900    - 1.17.12
901    - [FEATURE] http_client can now issue parallel requests in the context
902      of a single connection.  See -w option.
903
9042019-01-03
905    - 1.17.11
906    - Fix strict aliasing warning in optimized compilation.
907
9082018-12-27
909    - 1.17.10
910    - Fix the example program to be able to use parallel connections
911      again.  (See the -n argument.)
912
9132018-12-18
914    - 1.17.9
915    - [BUGFIX] Engine: reduce minimum batch size from 256 to 4
916
9172018-12-10
918    - 1.17.8
919    - [BUGFIX] Fix compilation on FreeBSD and 32-bit Linux
920
9212018-12-03
922    - 1.17.7
923    - [BUGFIX] Do not unset PING alarm before ringing expired alarms.
924      This prevented PING from ever being sent.
925
9262018-11-29
927    - 1.17.6
928    - Add failsafe: resume sending packets after some time
929
930      The change puts a 1-second limit on the amount of time the engine
931      will not send packets after some packets are delayed.  This makes
932      the library robust in case the user does not unblock the engine
933      explicitly using lsquic_engine_send_unsent_packets() call.
934
935    - [BUGFIX] Handle corner cases in send controller when packets are
936      a) delayed or b) dropped during repackaging.
937    - [BUGFIX] Memory leak: destroy buffered packets during controller
938      cleanup.
939
9402018-11-16
941    - 1.17.3
942    - [BUGFIX] Do not send STOP_WAITING frames when using Q044
943
9442018-10-19
945    - 1.17.2
946    - [BUGFIX] Memory leak in test_frame_rw unit test.
947    - [BUGFIX] Parsing packets with short IETF header: do not overwrite
948      flags.  (Only a problem in unit tests -- benign otherwise.)
949
9502018-10-16
951    - 1.17.0
952    - [API Change] Packet out Memory Interface (PMI) update:
953      - Split PMI pool return into pmi_release and pmi_return
954      - PMI callbacks take peer_ctx and is_ipv6 arguments
955    - [BUGFIX] Fix use-after-free when certificate is updated
956    - Silence gcc warning in optimized mode by performing useless
957      initialization
958    - cmake: use the standard variable CMAKE_BUILD_TYPE instead of
959      DEVEL_MODE
960
9612018-10-03
962    - 1.16.0
963    - [API Change] Add lsquic_conn_n_avail_streams()
964    - [BUGFIX] only dispatch crypto stream read events if WANT_READ is on
965
9662018-09-27
967    - 1.15.0
968    - [API Change] Add LSCONN_ST_PEER_GOING_AWAY to the list of conn statuses
969    - [BUGFIX] free uncompressed headers correctly when error occurs
970
9712018-09-12
972    - 1.14.3
973    - [BUGFIX] Do not abort conn on STREAM frame for a reset stream
974    - [BUGFIX] Drop packets that would become empty due to repackaging.
975      Packets on the scheduled queue may be marked for repackaging.
976      Frames such as ACK frame that are never resent are removed from
977      repackaged packets.  We must check that the newly repackaged packet
978      would not be empty.  If it would be, it is destroyed instead and
979      the next packet on the scheduled queue is used.  Note that this
980      change only affects the logic to return the next packet to be sent.
981      Lost packets that are being rescheduled are already processed in
982      this fashion.
983    - Byteswap CID before logging it - this makes it match Chrome CIDs.
984      (Except Q035, which is the last little-endian GQUIC version we
985      support.)
986
9872018-09-06
988    - 1.14.0
989    - [API Change] Disable packet sending if full batch cannot be sent
990      If lsquic_packets_out_f() cannot send the whole batch, disable
991      packet sending until lsquic_engine_send_unsent_packets() is called.
992    - [BUGFIX] Handle case when STREAM frame does not fit.
993    - [BUGFIX] Always allow incoming STREAM frames to overlap.  Peers
994      may send overlapping STREAM frames even if using versions older
995      than Q043.
996    - Custom header set fixes:
997      - set "FIN reached" flag when custom header with FIN flag is
998        claimed;
999      - do not return custom header set for a reset stream.
1000
10012018-08-27
1002
1003    - 1.13.0
1004    - [FEATURE, API Change] Add ability to create custom header set
1005      objects via callbacks.  This avoids reading and re-parsing
1006      headers from the stream.
1007
10082018-08-27
1009
1010    - 1.12.4
1011    - Fix memory leak when engine is destroyed
1012    - Fix memory leak in http_client
1013    - Fix gcc warning in unit tests
1014
10152018-08-22
1016
1017    - 1.12.3
1018    - [BUGFIX] Fix duplicate STREAM frame detection
1019
10202018-08-20
1021
1022    - 1.12.2
1023    - [BUGFIX] Update count of scheduled bytes when adjusting size of
1024      an already-scheduled packet.
1025    - Emit info instead of warning messages when stream is used in
1026      unexpected ways.
1027
10282018-08-17
1029
1030    - 1.12.0
1031    - [FEATURE, API Change] Add support for certificate verification
1032
10332018-08-16
1034
1035    - 1.11.1
1036    - [BUGFIX] Fix STOP_WAITING frame processing in the new Q044 code
1037
10382018-08-15
1039
1040    - 1.11.0
1041    - [FEATURE] Add support for Q044.
1042
10432018-08-09
1044
1045    - 1.10.2
1046    - [BUGFIX] Don't go over limit when creating delayed streams
1047
10482018-07-10
1049
1050    - 1.10.1
1051    - [BUGFIX]  process connections after each batch of packets is read
1052      This avoids a problem of accumulating a very large list of packets
1053      (possible when speeds are high and socket's receive buffer is large)
1054      and processing it all at once.
1055    - If glibc is older than 2.17, link with rt.  This is necessary for
1056      clock_getres(2).
1057    - Add version macros to lsquic.h; remove unnecessary includes.
1058
10592018-06-13
1060
1061    - [BUGFIX] allow multiple parallel connections by default
1062
1063      Use the original method of tracking connections by CIDs by default.
1064      If zero-sized CID support is turned on, connections are tracked by
1065      the address.  A new connection is not created if another connection
1066      is using the same network address
1067
10682018-05-30
1069
1070    - [FEATURE, API CHANGE] Support zero-sized CIDs in received packets
1071
10722018-05-24
1073
1074    - Close connection properly when packet encryption fails
1075
10762018-05-23
1077
1078    - [BUGFIX] Do not produce packet sequence gaps due to delayed packets
1079
10802018-05-21
1081
1082    - [API Change] Add optional callback to call when handshake is done
1083    - [API Change, BUGFIX] After send failure, wait until transport available
1084
10852018-05-18
1086
1087    - [API] Expose useful lsquic_ver2str[] in lsquic.h
1088    - [BUGFIX] Do not produce packet sequence gaps due to STREAM frame elision
1089    - Improve checks of number of incoming streams limit and associated
1090      error reporting.
1091    - [BUGFIX] Command-line option `-6` now works correctly.
1092
10932018-05-16
1094
1095    - [FEATURE] DNS resolution
1096    - [BUGFIX] Frame insertion mis-ID as overlap instead of dup
1097    - http_client: fix priority range generated by -E flag
1098
10992018-05-09
1100
1101    - [FEATURE] Add support for Q043.
1102    - Support for versions Q037, Q038, Q041, and Q042 has been removed.
1103    - Fix typo in debug message.
1104    - Fix code indentation.
1105    - Add /* fallthru */ comment to stop newer gcc from complaining.
1106    - Logger: fix compilation of optimized Windows build.
1107
11082018-05-04
1109
1110    - [FEATURE] Add support for Q042.
1111    - Remove comment: MSPC is obsolete (no code changes)
1112    - Prog: use lsquic_str2ver() when processing -o version flag
1113    - Remove unused CTIM and SRBF transport parameters
1114    - Disable QUIC versions Q037 and Q038 by default
1115    - Fix Windows compilation by including compat header file in
1116      lshpack.c
1117    - Address warnings produced by newer versions of gcc
1118    - Future-proof: turn off -Werror
1119
11202018-05-02
1121
1122    - [BUGFIX] Make lsquic_conn_quic_version() available
1123    - Switch to using ls-hpack 1.1
1124    - [BUGFIX] Do not ignore stream resets after receiving FIN
1125
11262018-04-27
1127
1128    - HPACK: do not allow header block to end with table size update.
1129
11302018-04-25
1131
1132    - [BUGFIX] Do not create gap in sent packnos when squeezing delayed
1133      packets.
1134    - [BUGFIX] sendctl checks for all unacked bytes, not just retx bytes.
1135    - [BUGFIX] connections with blocked scheduled packets are not tickable
1136      for sending.
1137    - [BUGFIX] Conn is tickable if it wants to send a connection-level
1138      frame.
1139
11402018-04-23
1141
1142    - Fix busy loop: tickable must make progress.  When connection is
1143      self-reporting as tickable, it must make progress when ticked.  There
1144      are two issues:
1145        1. If there are buffered packets, the connection is only tickable if
1146           they can be sent out.
1147        2. A connection is tickable if there are streams on the servicing
1148           queue.  When the tick occurs, we must service the stream
1149           independent of whether any packets are sent.
1150    - Fix assertion in pacer which can be incorrect under some
1151      conditions.
1152    - cmake: do not turn on address sanitizer if in Travis.
1153
11542018-04-20
1155
1156    - [BUGFIX] Fix bug in lsquic_engine_connect() exposed by yesterday's
1157      changes.
1158
11592018-04-19
1160
1161    - [BUGFIX] Add connection to Tickable Queue on stream write
1162    - cmake: use MSVC variable instead of trying to detect
1163    - engine: improve connection incref/decref logging
1164    - stream: don't ignore errors that may occur on triggered flush
1165    - connection: remove obsolete method
1166    - engine: indicate connection as tickable if previous call went
1167      over threshold
1168
11692018-04-09
1170
1171    [API Change, OPTIMIZATION] Only process conns that need to be processed
1172
1173    The API is simplified: do not expose the user code to several
1174    queues.  A "connection queue" is now an internal concept.
1175    The user processes connections using the single function
1176    lsquic_engine_process_conns().  When this function is called,
1177    only those connections are processed that need to be processed.
1178    A connection needs to be processed when:
1179
1180        1. New incoming packets have been fed to the connection.
1181        2. User wants to read from a stream that is readable.
1182        3. User wants to write to a stream that is writeable.
1183        4. There are buffered packets that can be sent out.  (This
1184           means that the user wrote to a stream outside of the
1185           lsquic library callback.)
1186        5. A control frame (such as BLOCKED) needs to be sent out.
1187        6. A stream needs to be serviced or delayed stream needs to
1188           be created.
1189        7. An alarm rings.
1190        8. Pacer timer expires.
1191
1192    To achieve this, the library places the connections into two
1193    priority queues (min heaps):
1194
1195        1. Tickable Queue; and
1196        2. Advisory Tick Time queue (ATTQ).
1197
1198    Each time lsquic_engine_process_conns() is called, the Tickable
1199    Queue is emptied.  After the connections have been ticked, they are
1200    queried again: if a connection is not being closed, it is placed
1201    either in the Tickable Queue if it is ready to be ticked again or
1202    it is placed in the Advisory Tick Time Queue.  It is assumed that
1203    a connection always has at least one timer set (the idle alarm).
1204
1205    The connections in the Tickable Queue are arranged in the least
1206    recently ticked order.  This lets connections that have been quiet
1207    longer to get their packets scheduled first.
1208
1209    This change means that the library no longer needs to be ticked
1210    periodically.  The user code can query the library when is the
1211    next tick event and schedule it exactly.  When connections are
1212    processed, only the tickable connections are processed, not *all*
1213    the connections.  When there are no tick events, it means that no
1214    timer event is necessary -- only the file descriptor READ event
1215    is active.
1216
1217    The following are improvements and simplifications that have
1218    been triggered:
1219
1220        - Queue of connections with incoming packets is gone.
1221        - "Pending Read/Write Events" Queue is gone (along with its
1222          history and progress checks).  This queue has become the
1223          Tickable Queue.
1224        - The connection hash no longer needs to track the connection
1225          insertion order.
1226
12272018-04-02
1228
1229    - [FEATURE] Windows support
1230
1231    - Reduce stack use -- outgoing packet batch is now allocated on the heap.
1232
12332018-03-09
1234
1235    - [OPTIMIZATION] Merge series of ACKs if possible
1236
1237      Parsed single-range ACK frames (that is the majority of frames) are
1238      saved in the connection and their processing is deferred until the
1239      connection is ticked.  If several ACKs come in a series between
1240      adjacent ticks, we check whether the latest ACK is a strict superset
1241      of the saved ACK.  If it is, the older ACK is not processed.
1242
1243      If ACK frames can be merged, they are merged and only one of them is
1244      either processed or saved.
1245
1246    - [OPTIMIZATION] Speed up ACK verification by simplifying send history.
1247
1248      Never generate a gap in the sent packet number sequence.  This reduces
1249      the send history to a single number instead of potentially a series of
1250      packet ranges and thereby speeds up ACK verification.
1251
1252      By default, detecting a gap in the send history is not fatal: only a
1253      single warning is generated per connection.  The connection can continue
1254      to operate even if the ACK verification code is not able to detect some
1255      inconsistencies.
1256
1257    - [OPTIMIZATION] Rearrange the lsquic_send_ctl struct
1258
1259      The first part of struct lsquic_send_ctl now consists of members that
1260      are used in lsquic_send_ctl_got_ack() (in the absense of packet loss,
1261      which is the normal case).  To speed up reads and writes, we no longer
1262      try to save space by using 8- and 16-bit integers.  Use regular integer
1263      width for everything.
1264
1265    - [OPTIMIZATION] Cache size of sent packet.
1266
1267    - [OPTIMIZATION] Keep track of the largest ACKed in packet_out
1268
1269      Instead of parsing our own ACK frames when packet has been acked,
1270      use the value saved in the packet_out structure when the ACK frame
1271      was generated.
1272
1273    - [OPTIMIZATION] Take RTT sampling conditional out of ACK loop
1274
1275    - [OPTIMIZATION] ACK processing: only call clock_gettime() if needed
1276
1277    - [OPTIMIZATION] Several code-level optimizations to ACK processing.
1278
1279    - Fix: http_client: fix -I flag; switch assert() to abort()
1280
12812018-02-26
1282    - [API Change] lsquic_engine_connect() returns pointer to the connection
1283      object.
1284    - [API Change] Add lsquic_conn_get_engine() to get engine object from
1285      connection object.
1286    - [API Change] Add lsquic_conn_status() to query connection status.
1287    - [API Change] Add add lsquic_conn_set_ctx().
1288    - [API Change] Add new timestamp format, e.g. 2017-03-21 13:43:46.671345
1289    - [OPTIMIZATION] Process handshake STREAM frames as soon as packet
1290      arrives.
1291    - [OPTIMIZATION] Do not compile expensive send controller sanity check
1292      by default.
1293    - [OPTIMIZATION] Add fast path to gquic_be_gen_reg_pkt_header.
1294    - [OPTIMIZATION] Only make squeeze function call if necessary.
1295    - [OPTIMIZATION] Speed up Q039 ACK frame parsing.
1296    - [OPTIMIZATION] Fit most used elements of packet_out into first 64 bytes.
1297    - [OPTIMIZATION] Keep track of scheduled bytes instead of calculating.
1298    - [OPTIMIZATION] Prefetch next unacked packet when processing ACK.
1299    - [OPTIMIZATION] Leverage fact that ACK ranges and unacked list are.
1300      ordered.
1301    - [OPTIMIZATION] Reduce function pointer use for STREAM frame generation
1302    - Fix: reset incoming streams that arrive after we send GOAWAY.
1303    - Fix: delay client on_new_conn() call until connection is fully set up.
1304    - Fixes to buffered packets logic: splitting, STREAM frame elision.
1305    - Fix: do not dispatch on_write callback if no packets are available.
1306    - Fix WINDOW_UPDATE send and resend logic.
1307    - Fix STREAM frame extension code.
1308    - Fix: Drop unflushed data when stream is reset.
1309    - Switch to tracking CWND using bytes rather than packets.
1310    - Fix TCP friendly adjustment in cubic.
1311    - Fix: do not generate invalid STOP_WAITING frames during high packet
1312      loss.
1313    - Pacer fixes.
1314
13152017-12-18
1316
1317    - Fix: better follow cubic curve after idle period
1318    - Fix: add missing parts to outgoing packet splitting code
1319    - Fix: compilation using gcc 4.8.4
1320
13212017-10-31
1322
1323    - Add APIs.txt -- describes LSQUIC APIs
1324
13252017-10-31
1326
1327    - [API Change] Sendfile-like functionality is gone.  The stream no
1328      longer opens files and deals with file descriptors.  (Among other
1329      things, this makes the code more portable.)  Three writing functions
1330      are provided:
1331
1332        lsquic_stream_write
1333        lsquic_stream_writev
1334        lsquic_stream_writef    (NEW)
1335
1336      lsquic_stream_writef() is given an abstract reader that has function
1337      pointers for size() and read() functions which the user can implement.
1338      This is the most flexible way.  lsquic_stream_write() and
1339      lsquic_stream_writev() are now both implemented as wrappers around
1340      lsquic_stream_writef().
1341
1342    - [OPTIMIZATION] When writing to stream, be it within or without the
1343      on_write() callback, place data directly into packet buffer,
1344      bypassing auxiliary data structures.  This reduces amount of memory
1345      required, for the amount of data that can be written is limited
1346      by the congestion window.
1347
1348      To support writes outside the on_write() callback, we keep N
1349      outgoing packet buffers per connection which can be written to
1350      by any stream.  One half of these are reserved for the highest
1351      priority stream(s), the other half for all other streams.  This way,
1352      low-priority streams cannot write instead of high-priority streams
1353      and, on the other hand, low-priority streams get a chance to send
1354      their packets out.
1355
1356      The algorithm is as follows:
1357
1358      - When user writes to stream outside of the callback:
1359        - If this is the highest priority stream, place it onto the
1360          reserved N/2 queue or fail.
1361            (The actual size of this queue is dynamic -- MAX(N/2, CWND) --
1362             rather than N/2, allowing high-priority streams to write as
1363             much as can be sent.)
1364        - If the stream is not the highest priority, try to place the
1365          data onto the reserved N/2 queue or fail.
1366      - When tick occurs *and* more packets can be scheduled:
1367        - Transfer packets from the high N/2 queue to the scheduled
1368          queue.
1369        - If more scheduling is allowed:
1370          - Call on_write callbacks for highest-priority streams,
1371            placing resulting packets directly onto the scheduled queue.
1372        - If more scheduling is allowed:
1373          - Transfer packets from the low N/2 queue to the scheduled
1374            queue.
1375        - If more scheduling is allowed:
1376          - Call on_write callbacks for non-highest-priority streams,
1377            placing resulting packets directly onto the scheduled queue
1378
1379      The number N is currently 20, but it could be varied based on
1380      resource usage.
1381
1382    - If stream is created due to incoming headers, make headers readable
1383      from on_new.
1384
1385    - Outgoing packets are no longer marked non-writeable to prevent placing
1386      more than one STREAM frame from the same stream into a single packet.
1387      This property is maintained via code flow and an explicit check.
1388      Packets for stream data are allocated using a special function.
1389
1390    - STREAM frame elision is cheaper, as we only perform it if a reset
1391      stream has outgoing packets referencing it.
1392
1393    - lsquic_packet_out_t is smaller, as stream_rec elements are now
1394      inside a union.
1395
13962017-10-12
1397
1398    - Do not send RST_STREAM when stream is closed for reading
1399    - Raise maximum header size from 4K to 64K
1400    - Check header name and value lengths against maximum imposed by HPACK
1401    - Fix NULL dereference in stream flow controller
1402
14032017-10-09
1404
1405    - Hide handshake implementation behind a set of function pointers
1406    - Use monotonically increasing clock
1407    - Make sure that retx delay is not larger than the max of 60 seconds
1408
14092017-09-29
1410
1411    - A few fixes to code and README
1412
14132017-09-28
1414
1415    - Add support for Q041; drop support for Q040
1416
14172017-09-27
1418
1419    - Fix CMakeLists.txt: BoringSSL include and lib was mixed up
1420
14212017-09-26
1422
1423    - Add support for Mac OS
1424    - Add support for Raspberry Pi
1425    - Fix BoringSSL compilation: include <openssl/hmac.h> explicitly
1426
14272017-09-22
1428
1429    - Initial release
1430