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