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