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