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