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