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