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