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