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