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