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