CHANGELOG revision 9fc12041
12020-01-28
2    - 2.10.0
3    - [FEATURE] QUIC and HTTP/3 Internet Draft 25 support.
4    - [API] Drop support for ID-23.
5    - [BUGFIX] Set key phase bit on outgoing packets correctly.
6    - Code cleanup.
7
82020-01-20
9    - 2.9.0
10    - [API] Drop support for Q039.
11    - Improve ACK-queuing logic.  Send an ACK once in a while if
12      peer keeps on sending non-ack-eliciting packets.
13    - Improve Alt-Svc string: Q050 and later are not included in
14      the old-style "quic" string.
15    - Send stateless resets if connection could not be promoted.
16    - Schedule MAX_DATA if needed when DATA_BLOCKED is received.
17    - Use ls-qpack 0.11.2 -- needed for server push optimization.
18    - Code cleanup: handle some error cases, improve logging.
19
202020-01-16
21    - 2.8.9
22    - [BUGFIX] Use ls-qpack 0.11.1
23    - [OPTIMIZATION] Generate random bytes in batches.
24    - Change loss_bits transport parameter ID to 0x1057 following
25      latest draft.
26    - Randomize period with which PINGs are sent to elicit ACKs.
27    - Some refactoring and code cleanup.
28
292020-01-14
30    - 2.8.8
31    - [BUGFIX] Invalid read when parsing IETF transport parameters
32      (this was benign).
33    - [OPTIMIZATION] Frame bundling when using buffered packets in
34      IETF QUIC: a) flush QPACK decoder stream and b) include ACKs
35      in opportunistic fashion.
36    - Fix HTTP/3 framing unit test.
37    - Code cleanup.
38
392020-01-09
40    - 2.8.7
41    - [BUGFIX] Initial packet size check for IETF mini conn applies to
42      UDP payload, not QUIC packet.
43    - Support old and new school loss_bits transport parameter.
44    - Use Q run length of 64 as suggested in the loss bits Draft.
45    - Undo square wave count when packet is delayed.
46    - Code cleanup; minor fixes.
47
482020-01-06
49    - 2.8.5
50    - [HTTP3] Verify number of bytes in incoming DATA frames against
51      content-length.
52    - [HTTP3] Stop issuing streams credits if peer stops opening QPACK
53      decoder window.  This addresses a potential attack whereby client
54      can cause the server to keep allocating memory.  See Security
55      Considerations in the QPACK draft.
56    - [BUGFIX] Mini conn: don't shorten max packet size for Q050 and later.
57    - [BUGFIX] Init IETF connection flow controller using correct setting.
58    - [BUGFIX] Fix unintended sign extension when removing header protection.
59    - Code cleanup and minor fixes.
60
612019-12-30
62    - 2.8.1
63    - [FEATURE] Use occasional packet number gaps to detect optimistic
64      ACK attacks.
65    - [BUGFIX] Q050 client: all packet numbers are in the App PNS.
66    - [OPTIMIZATION] Merge multi-range ACK frames, not just single-range
67      ACK frames.
68    - IETF QUIC: use RTT estimate in ack timeout calculation.
69    - IETF handshake: abort conn when unexpected errors occur.
70    - Use PING rather than MAX_DATA frames to elicit ACKs from peer.
71    - Server: enforce 1200 byte Initial minimum packet size.
72    - [CLEANUP] Remove code to disable gQUIC crypto.
73    - [CLEANUP] Remove n_timestamps from ACK info struct.
74    - Optimize driver: reuse previous ancillary message when possible.
75
762019-12-23
77    - 2.8.0
78    - [FEATURE] Add support for Q050.
79    - [OPTIMIZATION] Reduce mallocs in gQUIC handshake.
80    - [BUGFIX] Disable redo of failed STREAM frame insertion with debug
81      logging.
82
832019-12-18
84    - 2.7.3
85    - [DEBUG] Further dedup next advisory tick messages when reason is
86      the same.
87    - [BUGFIX] Update size of `a` array in TP struct.  Fixes (benign)
88      GitHub bug #94.
89    - Use Cubic by default again instead of BBR, as it delivers more
90      consistent performance.
91
922019-12-11
93    - 2.7.2
94    - [BUGFIX] Send controller: update scheduled bytes when DCID length
95      changes (IETF client).
96    - [BUGFIX] Drop alarm check from sanity test.  It no longer works now
97      that we use loss chains.
98    - [PORTABILITY] Fix build on Alpine Linux.
99    - [PORTABILITY] Fix build using XCode.
100    - Client initial DCID length: use RAND_bytes() instead of rand(3).
101    - Add unit tests for connection min heap.
102    - [DEBUG] Log CID in gQUIC handshake module
103    - [DEBUG] Turn on extra checks for IETF client send controller.
104    - [DEBUG] Dedup next advisory tick messages when reason is IDLE timer.
105    - [DEBUG] QPACK decoder handler: log header error code.
106
1072019-12-05
108    - 2.7.1
109    - [BUGFIX] client: don't call ignore_init() in middle of batch send.
110      ignore_init() makes an assumption that the send controller has access
111      to all outgoing packets.  This change wraps a few IETF full connection
112      methods to delay calling ignore_init() until the engine returns all
113      outgoing packets that were batched.
114    - [BUGFIX] set errno to EAGAIN if sendmmsg() can't send all of them.
115      This needs to be done because the value of errno may be lost on
116      some platforms.
117    - [BUGFIX] Typo that set all bits in sm_qflags lead to crashes.
118    - [BUGFIX] Do not cancel header block processing after failure, as
119      QPACK releases the reference in that case.
120    - [CLEANUP] IETF encrypt: replace assert(0) with a warning.
121    - Several small improvements to the test server.
122
1232019-11-27
124    - 2.7.0
125    - [API, FEATURE] Close connection immediately when ea_packets_out()
126      fails with errno != EAGAIN.  The API change is that errno is now
127      examined.  Make sure to set it if using something other than
128      sendmsg() to send packets.
129    - [CLEANUP] Immediate close logic in IETF full conn.
130    - [CLEANUP] Fix bogus warning about uninitialized `pair' variable.
131
1322019-11-22
133    - 2.6.7
134    - [FEATURE] Implement the QL extension (offered by default).
135    - [BUGFIX] Abort when encountering unexpected HTTP/3 frames.
136    - [BUGFIX] Acknowledge (QPACK) HTTP/3 trailers correctly.
137    - [DEBUG] Turn on debug message for next advisory tick.
138
1392019-11-20
140    - 2.6.6
141    - [BUGFIX] Using HTTP/3 to HTTP/1.x converter.
142    - [BUGFIX] Truncate log messages instead of throwing them away.
143
1442019-11-15
145    - 2.6.5
146    - [BUGFIX] High priority buffered packet queue length.
147    - [BUGFIX] Rain time calculation: max_ack_delay is in milliseconds.
148
1492019-11-12
150    - 2.6.3
151    - [BUGFIX] Close DATA frames with empty payload correctly.
152
1532019-11-11
154    - 2.6.2
155    - [BUGFIX] SCID!=ODCID rule applies to Retry packets, not regular
156      packets.
157    - [BUGFIX] Zero-RTT: BoringSSL no longer flips read/write secrets.
158    - [BUGFIX] Truncate ACK frame rather instead of aborting IETF
159      connection.
160    - [BUGFIX] Client: don't send duplicate reset tokens.
161    - [BUGFIX] Remove invalid assertion in H3 framing code.
162    - Silence a warning in send ctl by restructuring switch() statement.
163
1642019-11-08
165    - 2.6.1
166    - [BUGFIX] set retry token on all resubmitted packets.
167    - Event log: log sent packet flags.  In particular, this allows one
168      to see whether token was sent.
169    - Don't migrate client if es_allow_migration is false.
170
1712019-11-07
172    - 2.6.0
173    - [FEATURE] QUIC and HTTP/3 Internet Draft 24 support
174
1752019-11-07
176    - 2.5.2
177    - [BUGFIX] argument order to gQUIC client constructor.  Regression
178      introduced in 2.5.0.
179    - [BUGFIX] split buffered packet error recovery: destroy the correct
180      packet.
181
1822019-11-04
183    - 2.5.1
184    - [BUGFIX] Fix double-free when emptying a packet number space.
185    - [BUGFIX] http_server: fix md5sum handler: handle EOF correctly.
186    - [BUGFIX] Use random values in bits 4 and 5 of the first byte of
187      verneg packets (regression introduced in 2.5.0).
188    - [OPTIMIZATION] Don't compile in expensive attq checks by default.
189    - [OPTIMIZATION] http_server: compile regexes only once.
190
1912019-10-31
192    - 2.5.0
193    - [API] lsquic_engine_connect() can now be passed QUIC version to use.
194    - [OPTIMIZATION] Queue opportunistic ACKs if there is data to be sent.
195    - [BUGFIX] Don't evict streams from priority iterator if there is
196      only one queue.
197    - [OPTIMIZATION, BUGFIX] Several other optimizations and bug fixes.
198    - Use ls-qpack v0.10.7.
199
2002019-10-24
201    - 2.4.10
202    - [BUGFIX] IETF QUIC server: fix uninitialized variable use.
203    - [BUGFIX] make sure TLSv1.3 is not disabled in SSL object.
204    - [BUGFIX] Use issuer name and serial number to cache certs (SKID
205      values are not unique).
206    - [BUGFIX] Always set the idle alarm in IETF connection so that it
207      can time out.
208    - Use ls-qpack v0.10.6, as it silences some warnings.
209
2102019-10-21
211    - 2.4.8
212    - [OPTIMIZATION, BUGFIX] Use ls-qpack v0.10.5.
213
2142019-10-15
215    - 2.4.7
216    - Add echo client and server to the distibution.
217    - Add MD5 client and server to the distibution.
218    - Fix http_client: check command-line arguments better, prevent crash.
219    - Fix IETF conn: can_write_ack() should only care about APP PNS.
220    - Client: delay stream creation until handshake succeds.
221    - Reset HTTP stream whose write end is closed prematurely.
222    - Fix tickable(): mirror behavior of tick() wrt buffered packets.
223    - Log reason why engine is tickable.
224
2252019-10-11
226    - 2.4.6
227    - Minor code cleanup and logging improvements.
228    - Server and client programs: include library version (e.g. 2.4.6)
229      into `server' and `user-agent' headers.
230
2312019-10-08
232    - 2.4.5
233    - [OPTIMIZATION]: flush encoder stream only when necessary.
234    - [BUGFIX] Use ls-qpack v0.10.2 for new API -- and for a bug fix.
235    - [BUGFIX] Typo in IETF conn SETTINGS writer.
236    - Use latest BoringSSL.
237
2382019-10-08
239    - 2.4.4
240    - [API] Add lsquic_alpn2ver() to aid parsing Alt-Svc header.
241    - [BUGFIX] NULL dereference when H3 frame header would be split.
242    - [BUGFIX] Do not close fixed-size H3 frame prematurely.
243    - [BUGFIX] Allow PING frames in IETF mini conn.
244    - [BUGFIX] Mini conns: don't send any packets after receiving
245      CONNECTION_CLOSE.
246    - [BUGFIX] Client migration: reserve slot for DCID from transport params.
247    - [BUGFIX] Allow max_early_data_size=0 -- early_data might not be there.
248    - [BUGFIX] Use an invalid stream number to reset BPT cache (zero is now a
249      valid stream number).
250    - [SPEC] Use FINAL_SIZE_ERROR when FIN mismatch is detected.
251    - [OPTIMIZATION] Closed connection only gets one chance to send packets.
252    - [OPTIMIZATION] Flush headers stream before packetizing stream data.
253    - [OPTIMIZATION] process QPACK encoder STREAM frames immediately.
254    - Update ls-qpack to v0.10.1.
255
2562019-09-30
257    - 2.4.3
258    - Add GQUIC versions to the list of h3 ALPNs for Alt-Svc header.
259      For example, h3-Q043.  Chrome will switch to using this format at
260      some point in the future.
261    - [BUGFIX] Send correct value in max_streams_uni transport param
262    - [SPEC] Abort IETF QUIC connection if max_early_data_size is not set
263      to 0xFFFFFFFF
264
2652019-09-23
266    - 2.4.2
267    - [BUGFIX] H3 framing: fix zero-byte write when space is available
268    - [BUGFIX] Don't send STREAM frame when incoming unidirectgional stream
269      is closed
270    - [BUGFIX] Cancel all pending writes by stream reset by a GOAWAY
271    - [BUGFIX] Fix use-after-free in IETF full conn
272    - [OPTIMIZATION] Wait for session tickets for two seconds and then drop
273      SSL object and crypto streams.
274
2752019-09-18
276    - 2.4.0
277    - [FEATURE] QUIC and HTTP/3 Internet Draft 23 support
278
2792019-09-13
280    - 2.3.1
281    - [BUGFIX] Fix memory leaks
282    - [BUGFIX] Fix unit tests
283
2842019-09-12
285    - 2.3.0
286    - [FEATURE] BBR congestion control is on by default
287    - [BUGFIX] BBR app-limited logic
288    - [BUGFIX] Fix uninitialized warnings in IETF
289    - [BUGFIX] Update ls-qpack to v0.9.14
290    - [CLEANUP] Code cleanup
291
2922019-09-11
293    - 2.2.0
294    - [FEATURE] Server code is included in the library
295    - [FEATURE] IETF QUIC and HTTP/3 Support (ID-22)
296
2972019-05-13
298    - 1.21.2
299    - [OPTIMIZATION] HPACK: use history to improve compression performance
300
3012019-05-06
302    - 1.21.1
303    - [BUGFIX] If FIN or RST not received, don't delay stream destruction.
304    - [OPTIMIZATION] Speed up HPACK encoder by using same hash value to
305      search static and dynamic tables.
306
3072019-04-12
308    - 1.21.0
309    - [FEATURE] Add qlog log module.
310
3112019-04-01
312    - 1.20.0
313    - [FEATURE] Add support for Q046.
314
3152019-03-19
316    - 1.19.6
317    - [BUGFIX] Ensure that Largest Observed does not decrease in ACKs we
318      send.  ACK frames placed in packets in buffered queues (optimization
319      introduced in 1.17.15) can be preceded by an ACK frame generated later.
320      In this case, the older ACK frame should not be sent out, as Chromium-
321      based servers flags decrease in the ACK frame's Largest Observed value
322      as an error.
323
3242019-03-05
325    - 1.19.5
326    - [BUGFIX] Use correct public key from PUBS based on KEXS index.
327    - [BUGFIX] Check flags before dispatching writes, avoiding assert.
328    - [BUGFIX] Set :scheme to "https" (instead of "HTTP").
329
3302019-02-25
331    - 1.19.4
332    - [BUGFIX] Check buffer bounds when looking up version in 0-RTT blob.
333    - [BUGFIX] http_client: don't fetch 0-rtt info if handshake failed.
334    - Log number of pacer calls at DEBUG, rather than NOTICE, level.
335
3362019-02-18
337    - 1.19.3
338    - [BUGFIX] Q044: don't encode packet number in 6 bytes.  Six-byte
339      packet number encoding does not exist in Q044.  This fixes a
340      regression introduced in '[BUGFIX] Buffered packets can contain
341      ACK frames' -- we need to keep QUIC version in mind when selecting
342      the longest possible packet number encoding used for the buffered
343      packet that carries the ACK.
344    - [BUGFIX] Do not increase CWND when timeout occurs.
345    - http_client: support setting handshake timeout on command line.
346      Use -o handshake_to=timeout.
347    - http_client: use -k to connect UDP socket to pick up ICMP errors.
348    - http_client: allow pathless mode, when only handshake is performed
349      without issuing any requests.  This can be done by simply not
350      specifying a -p flag on the command line.
351
3522019-02-11
353    - 1.19.2
354    - [BUGFIX] Begin negotiation with version provided in 0-RTT info.
355    - [BUGFIX] Version checking in zero_rtt deserialize function.
356
3572019-02-04
358    - 1.19.1
359    - [BUGFIX] Fix Windows build.
360
3612019-02-04
362    - 1.19.0
363    - [FEATURE, API Change] 0-RTT support.  Add function to export 0-RTT
364      information; it can be supplied to a subsequent connect() call.
365    - [FEATURE] Add -0 flag to http_client to exercise 0-RTT support.
366    - [BUGFIX] Resuscitate the Windows build.
367    - [BUGFIX] Send HTTP settings (max header list size) if necessary.
368    - [BUGFIX] Buffered packets can contain ACK frames.
369    - [BUGFIX] Make packet writeable once all STREAM frames are elided.
370    - [BUGFIX] Fix potential null dereference when realloc fails.
371    - cmake: simplify build configuration.
372
3732019-01-28
374    - 1.18.0
375    - [API Change] Can specify clock granularity in engine settings.
376    - [BUGFIX] Pacer uses fixed clock granularity.  Since the change on
377      2018-04-09, it is not necessary to try to approximate the next tick
378      time in the pacer: it can use fix clock granularity specified by
379      the user.
380    - [BUGFIX] Do not tick constantly before handshake is done.
381    - [BUGFIX] Do not exit tick prematurely: reuse packet with ACK.  Even
382      if we cannot allocate *more* packets, we could still be able to write
383      to one already allocated.
384    - [BUGFIX] Do not schedule pacer if there are no lost packets.
385
3862019-01-17
387    - 1.17.15
388    - [BUGFIX] http_client: make sure only one read per on_read() callback
389      is performed in the header conversion bypass (-B) mode.
390    - http_client: with -E, assign random priority when stream is created.
391    - [OPTIMIZATION] On immediate write, place an ACK frame into the first
392      buffered packet if an ACK is queued.  This reduces the number of
393      standalone ACK packets.
394    - [OPTIMIZATION] Allow placing more than one STREAM frame from the same
395      stream into an outgoing packet.  This change minimizes the number of
396      buffered packets required to store several small HTTP messages by
397      virtue of allowing more than one STREAM frame from HEADERS stream in
398      the same packet.
399    - [OPTIMIZATION] Flush headers when writing to buffered packets.  This
400      causes the headers to be written to the same buffered packet queue,
401      thereby improving packet utilization, especially for small HTTP
402      messages.
403
4042019-01-16
405    - 1.17.14
406    - [FEATURE] http_client can now collect stats: time to connect, TTFB,
407      time to download, requests per seconds, and bandwidth.  See -t flag.
408    - [BUGFIX] http_client: -B, -K, and -r can be used at the same time.
409    - [BUGFIX] http_client: do not display cert chain before each request.
410      Now this is only done once per connection, if the handshake is
411      successful and -a option is given.
412    - [BUGFIX] Do not wait to dispatch on_close() after reading.  If a
413      stream is scheduled to be closed after on_read() callback returns,
414      close it immediately instead of waiting until the end of the tick.
415      If client creates new request from on_close() event, they will be
416      processed in the same tick instead of waiting for the next one.
417    - [BUGFIX] HEADERS stream is critical: always treat it with highest
418      priority.
419
4202019-01-10
421    - 1.17.12
422    - [FEATURE] http_client can now issue parallel requests in the context
423      of a single connection.  See -w option.
424
4252019-01-03
426    - 1.17.11
427    - Fix strict aliasing warning in optimized compilation.
428
4292018-12-27
430    - 1.17.10
431    - Fix the example program to be able to use parallel connections
432      again.  (See the -n argument.)
433
4342018-12-18
435    - 1.17.9
436    - [BUGFIX] Engine: reduce minimum batch size from 256 to 4
437
4382018-12-10
439    - 1.17.8
440    - [BUGFIX] Fix compilation on FreeBSD and 32-bit Linux
441
4422018-12-03
443    - 1.17.7
444    - [BUGFIX] Do not unset PING alarm before ringing expired alarms.
445      This prevented PING from ever being sent.
446
4472018-11-29
448    - 1.17.6
449    - Add failsafe: resume sending packets after some time
450
451      The change puts a 1-second limit on the amount of time the engine
452      will not send packets after some packets are delayed.  This makes
453      the library robust in case the user does not unblock the engine
454      explicitly using lsquic_engine_send_unsent_packets() call.
455
456    - [BUGFIX] Handle corner cases in send controller when packets are
457      a) delayed or b) dropped during repackaging.
458    - [BUGFIX] Memory leak: destroy buffered packets during controller
459      cleanup.
460
4612018-11-16
462    - 1.17.3
463    - [BUGFIX] Do not send STOP_WAITING frames when using Q044
464
4652018-10-19
466    - 1.17.2
467    - [BUGFIX] Memory leak in test_frame_rw unit test.
468    - [BUGFIX] Parsing packets with short IETF header: do not overwrite
469      flags.  (Only a problem in unit tests -- benign otherwise.)
470
4712018-10-16
472    - 1.17.0
473    - [API Change] Packet out Memory Interface (PMI) update:
474      - Split PMI pool return into pmi_release and pmi_return
475      - PMI callbacks take peer_ctx and is_ipv6 arguments
476    - [BUGFIX] Fix use-after-free when certificate is updated
477    - Silence gcc warning in optimized mode by performing useless
478      initialization
479    - cmake: use the standard variable CMAKE_BUILD_TYPE instead of
480      DEVEL_MODE
481
4822018-10-03
483    - 1.16.0
484    - [API Change] Add lsquic_conn_n_avail_streams()
485    - [BUGFIX] only dispatch crypto stream read events if WANT_READ is on
486
4872018-09-27
488    - 1.15.0
489    - [API Change] Add LSCONN_ST_PEER_GOING_AWAY to the list of conn statuses
490    - [BUGFIX] free uncompressed headers correctly when error occurs
491
4922018-09-12
493    - 1.14.3
494    - [BUGFIX] Do not abort conn on STREAM frame for a reset stream
495    - [BUGFIX] Drop packets that would become empty due to repackaging.
496      Packets on the scheduled queue may be marked for repackaging.
497      Frames such as ACK frame that are never resent are removed from
498      repackaged packets.  We must check that the newly repackaged packet
499      would not be empty.  If it would be, it is destroyed instead and
500      the next packet on the scheduled queue is used.  Note that this
501      change only affects the logic to return the next packet to be sent.
502      Lost packets that are being rescheduled are already processed in
503      this fashion.
504    - Byteswap CID before logging it - this makes it match Chrome CIDs.
505      (Except Q035, which is the last little-endian GQUIC version we
506      support.)
507
5082018-09-06
509    - 1.14.0
510    - [API Change] Disable packet sending if full batch cannot be sent
511      If lsquic_packets_out_f() cannot send the whole batch, disable
512      packet sending until lsquic_engine_send_unsent_packets() is called.
513    - [BUGFIX] Handle case when STREAM frame does not fit.
514    - [BUGFIX] Always allow incoming STREAM frames to overlap.  Peers
515      may send overlapping STREAM frames even if using versions older
516      than Q043.
517    - Custom header set fixes:
518      - set "FIN reached" flag when custom header with FIN flag is
519        claimed;
520      - do not return custom header set for a reset stream.
521
5222018-08-27
523
524    - 1.13.0
525    - [FEATURE, API Change] Add ability to create custom header set
526      objects via callbacks.  This avoids reading and re-parsing
527      headers from the stream.
528
5292018-08-27
530
531    - 1.12.4
532    - Fix memory leak when engine is destroyed
533    - Fix memory leak in http_client
534    - Fix gcc warning in unit tests
535
5362018-08-22
537
538    - 1.12.3
539    - [BUGFIX] Fix duplicate STREAM frame detection
540
5412018-08-20
542
543    - 1.12.2
544    - [BUGFIX] Update count of scheduled bytes when adjusting size of
545      an already-scheduled packet.
546    - Emit info instead of warning messages when stream is used in
547      unexpected ways.
548
5492018-08-17
550
551    - 1.12.0
552    - [FEATURE, API Change] Add support for certificate verification
553
5542018-08-16
555
556    - 1.11.1
557    - [BUGFIX] Fix STOP_WAITING frame processing in the new Q044 code
558
5592018-08-15
560
561    - 1.11.0
562    - [FEATURE] Add support for Q044.
563
5642018-08-09
565
566    - 1.10.2
567    - [BUGFIX] Don't go over limit when creating delayed streams
568
5692018-07-10
570
571    - 1.10.1
572    - [BUGFIX]  process connections after each batch of packets is read
573      This avoids a problem of accumulating a very large list of packets
574      (possible when speeds are high and socket's receive buffer is large)
575      and processing it all at once.
576    - If glibc is older than 2.17, link with rt.  This is necessary for
577      clock_getres(2).
578    - Add version macros to lsquic.h; remove unnecessary includes.
579
5802018-06-13
581
582    - [BUGFIX] allow multiple parallel connections by default
583
584      Use the original method of tracking connections by CIDs by default.
585      If zero-sized CID support is turned on, connections are tracked by
586      the address.  A new connection is not created if another connection
587      is using the same network address
588
5892018-05-30
590
591    - [FEATURE, API CHANGE] Support zero-sized CIDs in received packets
592
5932018-05-24
594
595    - Close connection properly when packet encryption fails
596
5972018-05-23
598
599    - [BUGFIX] Do not produce packet sequence gaps due to delayed packets
600
6012018-05-21
602
603    - [API Change] Add optional callback to call when handshake is done
604    - [API Change, BUGFIX] After send failure, wait until transport available
605
6062018-05-18
607
608    - [API] Expose useful lsquic_ver2str[] in lsquic.h
609    - [BUGFIX] Do not produce packet sequence gaps due to STREAM frame elision
610    - Improve checks of number of incoming streams limit and associated
611      error reporting.
612    - [BUGFIX] Command-line option `-6` now works correctly.
613
6142018-05-16
615
616    - [FEATURE] DNS resolution
617    - [BUGFIX] Frame insertion mis-ID as overlap instead of dup
618    - http_client: fix priority range generated by -E flag
619
6202018-05-09
621
622    - [FEATURE] Add support for Q043.
623    - Support for versions Q037, Q038, Q041, and Q042 has been removed.
624    - Fix typo in debug message.
625    - Fix code indentation.
626    - Add /* fallthru */ comment to stop newer gcc from complaining.
627    - Logger: fix compilation of optimized Windows build.
628
6292018-05-04
630
631    - [FEATURE] Add support for Q042.
632    - Remove comment: MSPC is obsolete (no code changes)
633    - Prog: use lsquic_str2ver() when processing -o version flag
634    - Remove unused CTIM and SRBF transport parameters
635    - Disable QUIC versions Q037 and Q038 by default
636    - Fix Windows compilation by including compat header file in
637      lshpack.c
638    - Address warnings produced by newer versions of gcc
639    - Future-proof: turn off -Werror
640
6412018-05-02
642
643    - [BUGFIX] Make lsquic_conn_quic_version() available
644    - Switch to using ls-hpack 1.1
645    - [BUGFIX] Do not ignore stream resets after receiving FIN
646
6472018-04-27
648
649    - HPACK: do not allow header block to end with table size update.
650
6512018-04-25
652
653    - [BUGFIX] Do not create gap in sent packnos when squeezing delayed
654      packets.
655    - [BUGFIX] sendctl checks for all unacked bytes, not just retx bytes.
656    - [BUGFIX] connections with blocked scheduled packets are not tickable
657      for sending.
658    - [BUGFIX] Conn is tickable if it wants to send a connection-level
659      frame.
660
6612018-04-23
662
663    - Fix busy loop: tickable must make progress.  When connection is
664      self-reporting as tickable, it must make progress when ticked.  There
665      are two issues:
666        1. If there are buffered packets, the connection is only tickable if
667           they can be sent out.
668        2. A connection is tickable if there are streams on the servicing
669           queue.  When the tick occurs, we must service the stream
670           independent of whether any packets are sent.
671    - Fix assertion in pacer which can be incorrect under some
672      conditions.
673    - cmake: do not turn on address sanitizer if in Travis.
674
6752018-04-20
676
677    - [BUGFIX] Fix bug in lsquic_engine_connect() exposed by yesterday's
678      changes.
679
6802018-04-19
681
682    - [BUGFIX] Add connection to Tickable Queue on stream write
683    - cmake: use MSVC variable instead of trying to detect
684    - engine: improve connection incref/decref logging
685    - stream: don't ignore errors that may occur on triggered flush
686    - connection: remove obsolete method
687    - engine: indicate connection as tickable if previous call went
688      over threshold
689
6902018-04-09
691
692    [API Change, OPTIMIZATION] Only process conns that need to be processed
693
694    The API is simplified: do not expose the user code to several
695    queues.  A "connection queue" is now an internal concept.
696    The user processes connections using the single function
697    lsquic_engine_process_conns().  When this function is called,
698    only those connections are processed that need to be processed.
699    A connection needs to be processed when:
700
701        1. New incoming packets have been fed to the connection.
702        2. User wants to read from a stream that is readable.
703        3. User wants to write to a stream that is writeable.
704        4. There are buffered packets that can be sent out.  (This
705           means that the user wrote to a stream outside of the
706           lsquic library callback.)
707        5. A control frame (such as BLOCKED) needs to be sent out.
708        6. A stream needs to be serviced or delayed stream needs to
709           be created.
710        7. An alarm rings.
711        8. Pacer timer expires.
712
713    To achieve this, the library places the connections into two
714    priority queues (min heaps):
715
716        1. Tickable Queue; and
717        2. Advisory Tick Time queue (ATTQ).
718
719    Each time lsquic_engine_process_conns() is called, the Tickable
720    Queue is emptied.  After the connections have been ticked, they are
721    queried again: if a connection is not being closed, it is placed
722    either in the Tickable Queue if it is ready to be ticked again or
723    it is placed in the Advisory Tick Time Queue.  It is assumed that
724    a connection always has at least one timer set (the idle alarm).
725
726    The connections in the Tickable Queue are arranged in the least
727    recently ticked order.  This lets connections that have been quiet
728    longer to get their packets scheduled first.
729
730    This change means that the library no longer needs to be ticked
731    periodically.  The user code can query the library when is the
732    next tick event and schedule it exactly.  When connections are
733    processed, only the tickable connections are processed, not *all*
734    the connections.  When there are no tick events, it means that no
735    timer event is necessary -- only the file descriptor READ event
736    is active.
737
738    The following are improvements and simplifications that have
739    been triggered:
740
741        - Queue of connections with incoming packets is gone.
742        - "Pending Read/Write Events" Queue is gone (along with its
743          history and progress checks).  This queue has become the
744          Tickable Queue.
745        - The connection hash no longer needs to track the connection
746          insertion order.
747
7482018-04-02
749
750    - [FEATURE] Windows support
751
752    - Reduce stack use -- outgoing packet batch is now allocated on the heap.
753
7542018-03-09
755
756    - [OPTIMIZATION] Merge series of ACKs if possible
757
758      Parsed single-range ACK frames (that is the majority of frames) are
759      saved in the connection and their processing is deferred until the
760      connection is ticked.  If several ACKs come in a series between
761      adjacent ticks, we check whether the latest ACK is a strict superset
762      of the saved ACK.  If it is, the older ACK is not processed.
763
764      If ACK frames can be merged, they are merged and only one of them is
765      either processed or saved.
766
767    - [OPTIMIZATION] Speed up ACK verification by simplifying send history.
768
769      Never generate a gap in the sent packet number sequence.  This reduces
770      the send history to a single number instead of potentially a series of
771      packet ranges and thereby speeds up ACK verification.
772
773      By default, detecting a gap in the send history is not fatal: only a
774      single warning is generated per connection.  The connection can continue
775      to operate even if the ACK verification code is not able to detect some
776      inconsistencies.
777
778    - [OPTIMIZATION] Rearrange the lsquic_send_ctl struct
779
780      The first part of struct lsquic_send_ctl now consists of members that
781      are used in lsquic_send_ctl_got_ack() (in the absense of packet loss,
782      which is the normal case).  To speed up reads and writes, we no longer
783      try to save space by using 8- and 16-bit integers.  Use regular integer
784      width for everything.
785
786    - [OPTIMIZATION] Cache size of sent packet.
787
788    - [OPTIMIZATION] Keep track of the largest ACKed in packet_out
789
790      Instead of parsing our own ACK frames when packet has been acked,
791      use the value saved in the packet_out structure when the ACK frame
792      was generated.
793
794    - [OPTIMIZATION] Take RTT sampling conditional out of ACK loop
795
796    - [OPTIMIZATION] ACK processing: only call clock_gettime() if needed
797
798    - [OPTIMIZATION] Several code-level optimizations to ACK processing.
799
800    - Fix: http_client: fix -I flag; switch assert() to abort()
801
8022018-02-26
803    - [API Change] lsquic_engine_connect() returns pointer to the connection
804      object.
805    - [API Change] Add lsquic_conn_get_engine() to get engine object from
806      connection object.
807    - [API Change] Add lsquic_conn_status() to query connection status.
808    - [API Change] Add add lsquic_conn_set_ctx().
809    - [API Change] Add new timestamp format, e.g. 2017-03-21 13:43:46.671345
810    - [OPTIMIZATION] Process handshake STREAM frames as soon as packet
811      arrives.
812    - [OPTIMIZATION] Do not compile expensive send controller sanity check
813      by default.
814    - [OPTIMIZATION] Add fast path to gquic_be_gen_reg_pkt_header.
815    - [OPTIMIZATION] Only make squeeze function call if necessary.
816    - [OPTIMIZATION] Speed up Q039 ACK frame parsing.
817    - [OPTIMIZATION] Fit most used elements of packet_out into first 64 bytes.
818    - [OPTIMIZATION] Keep track of scheduled bytes instead of calculating.
819    - [OPTIMIZATION] Prefetch next unacked packet when processing ACK.
820    - [OPTIMIZATION] Leverage fact that ACK ranges and unacked list are.
821      ordered.
822    - [OPTIMIZATION] Reduce function pointer use for STREAM frame generation
823    - Fix: reset incoming streams that arrive after we send GOAWAY.
824    - Fix: delay client on_new_conn() call until connection is fully set up.
825    - Fixes to buffered packets logic: splitting, STREAM frame elision.
826    - Fix: do not dispatch on_write callback if no packets are available.
827    - Fix WINDOW_UPDATE send and resend logic.
828    - Fix STREAM frame extension code.
829    - Fix: Drop unflushed data when stream is reset.
830    - Switch to tracking CWND using bytes rather than packets.
831    - Fix TCP friendly adjustment in cubic.
832    - Fix: do not generate invalid STOP_WAITING frames during high packet
833      loss.
834    - Pacer fixes.
835
8362017-12-18
837
838    - Fix: better follow cubic curve after idle period
839    - Fix: add missing parts to outgoing packet splitting code
840    - Fix: compilation using gcc 4.8.4
841
8422017-10-31
843
844    - Add APIs.txt -- describes LSQUIC APIs
845
8462017-10-31
847
848    - [API Change] Sendfile-like functionality is gone.  The stream no
849      longer opens files and deals with file descriptors.  (Among other
850      things, this makes the code more portable.)  Three writing functions
851      are provided:
852
853        lsquic_stream_write
854        lsquic_stream_writev
855        lsquic_stream_writef    (NEW)
856
857      lsquic_stream_writef() is given an abstract reader that has function
858      pointers for size() and read() functions which the user can implement.
859      This is the most flexible way.  lsquic_stream_write() and
860      lsquic_stream_writev() are now both implemented as wrappers around
861      lsquic_stream_writef().
862
863    - [OPTIMIZATION] When writing to stream, be it within or without the
864      on_write() callback, place data directly into packet buffer,
865      bypassing auxiliary data structures.  This reduces amount of memory
866      required, for the amount of data that can be written is limited
867      by the congestion window.
868
869      To support writes outside the on_write() callback, we keep N
870      outgoing packet buffers per connection which can be written to
871      by any stream.  One half of these are reserved for the highest
872      priority stream(s), the other half for all other streams.  This way,
873      low-priority streams cannot write instead of high-priority streams
874      and, on the other hand, low-priority streams get a chance to send
875      their packets out.
876
877      The algorithm is as follows:
878
879      - When user writes to stream outside of the callback:
880        - If this is the highest priority stream, place it onto the
881          reserved N/2 queue or fail.
882            (The actual size of this queue is dynamic -- MAX(N/2, CWND) --
883             rather than N/2, allowing high-priority streams to write as
884             much as can be sent.)
885        - If the stream is not the highest priority, try to place the
886          data onto the reserved N/2 queue or fail.
887      - When tick occurs *and* more packets can be scheduled:
888        - Transfer packets from the high N/2 queue to the scheduled
889          queue.
890        - If more scheduling is allowed:
891          - Call on_write callbacks for highest-priority streams,
892            placing resulting packets directly onto the scheduled queue.
893        - If more scheduling is allowed:
894          - Transfer packets from the low N/2 queue to the scheduled
895            queue.
896        - If more scheduling is allowed:
897          - Call on_write callbacks for non-highest-priority streams,
898            placing resulting packets directly onto the scheduled queue
899
900      The number N is currently 20, but it could be varied based on
901      resource usage.
902
903    - If stream is created due to incoming headers, make headers readable
904      from on_new.
905
906    - Outgoing packets are no longer marked non-writeable to prevent placing
907      more than one STREAM frame from the same stream into a single packet.
908      This property is maintained via code flow and an explicit check.
909      Packets for stream data are allocated using a special function.
910
911    - STREAM frame elision is cheaper, as we only perform it if a reset
912      stream has outgoing packets referencing it.
913
914    - lsquic_packet_out_t is smaller, as stream_rec elements are now
915      inside a union.
916
9172017-10-12
918
919    - Do not send RST_STREAM when stream is closed for reading
920    - Raise maximum header size from 4K to 64K
921    - Check header name and value lengths against maximum imposed by HPACK
922    - Fix NULL dereference in stream flow controller
923
9242017-10-09
925
926    - Hide handshake implementation behind a set of function pointers
927    - Use monotonically increasing clock
928    - Make sure that retx delay is not larger than the max of 60 seconds
929
9302017-09-29
931
932    - A few fixes to code and README
933
9342017-09-28
935
936    - Add support for Q041; drop support for Q040
937
9382017-09-27
939
940    - Fix CMakeLists.txt: BoringSSL include and lib was mixed up
941
9422017-09-26
943
944    - Add support for Mac OS
945    - Add support for Raspberry Pi
946    - Fix BoringSSL compilation: include <openssl/hmac.h> explicitly
947
9482017-09-22
949
950    - Initial release
951