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