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