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