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