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