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