Tuner.MaxWindowSizeParam | Javadocs [I2P+]

java.lang.Object

net.i2p.router.Tuner.BaseParam

net.i2p.router.Tuner.MaxWindowSizeParam

All Implemented Interfaces:: Tuner.TunableParam

Enclosing class:: Tuner

private class Tuner.MaxWindowSizeParamextends Tuner.BaseParam

Tunes the streaming maximum congestion window, scaled to available memory.

Field Summary
Fields
Modifier and Type
Field
Description
private double
_lastLossStamp
Close time of the loss window this decision was last taken on.
private int
_riseClimb
Consecutive windows in the climb direction.
private int
_riseShrink
Consecutive windows in the shrink direction.
Fields inherited from class Tuner.BaseParam
_autotune, _autoTuning, _cpuDriven, _ctx, _defaultMax, _defaultMin, _defaultStep, _defaultValue, _description, _effMax, _factoryDefault, _firstTick, _health, _historyCount, _initialValue, _log, _max, _min, _name, _override, _propPrefix, _statHistory, _statName, _step, _subsystem, _valueHistory, sharedAutotune
Modifier and Type
Field
Description
protected final Tuner.AutotuneConfig
_autotune
Autotune profile for this tunable parameter.
protected boolean
_autoTuning
Whether autotuning is active for this parameter.
protected boolean
_cpuDriven
Whether this param's value is being driven by CPU load rather than its own stat.
protected final RouterContext
_ctx
Router context.
protected final int
_defaultMax
Default maximum value from code or config.
protected final int
_defaultMin
Default minimum value from code or config.
protected final int
_defaultStep
Default step/increment size for adjustments.
protected int
_defaultValue
Factory default: value before any tuning.
protected final String
_description
Human-readable label for display in the Tuner UI.
protected int
_effMax
Effective ceiling = min(_max, memory-derived bound); never exceeds _max.
protected final int
_factoryDefault
Code-level default captured at construction time.
protected boolean
_firstTick
True until first Tuner.BaseParam.update() call — applies persisted value from autotune.config.
protected Tuner.SystemHealth
_health
Health score and subsystem for autotune decisions.
protected int
_historyCount
Number of valid entries in _valueHistory / _statHistory.
protected final int
_initialValue
Last known value (from persistence or runtime default).
protected final Log
_log
Class logger.
protected int
_max
Current maximum value (may differ from default after tuning).
protected int
_min
Current minimum value (may differ from default after tuning).
protected final String
_name
Internal config property key (e.g.
protected int
_override
User-set override value, or Integer.MIN_VALUE if unset.
protected final String
_propPrefix
Config key prefix for property lookups.
protected final double[]
_statHistory
Rolling window of recent stat values for trend analysis.
protected final String
_statName
Router stat name for observed value feedback.
protected int
_step
Current step/increment size (may differ from default).
protected final String
_subsystem
Subsystem identifier this parameter belongs to.
protected final int[]
_valueHistory
Rolling window of recent tunable values for trend analysis.
(package private) static Tuner.AutotuneConfig
sharedAutotune
Shared instance — set once in Tuner constructor, used by all BaseParams.
Constructor Summary
Constructors
Constructor
Description
MaxWindowSizeParam()
Creates the parameter that tunes the streaming max window size.
Method Summary
Private Methods
Modifier and Type
Method
Description
protected void
applyValue(int value)
Apply the tunable value to the router configuration.
private double
averageDuplicateMessageSize()
Mean size in bytes of a retransmitted message, or NaN when unread.
protected int
computeTarget(double observed)
Target tunable value computed from the observed stat.
protected String
decisionReason()
Name the gate that decided the ceiling's direction.
protected double
getObservedStat(RouterContext ctx)
Observed stat value used for autotuning.
protected int
getRuntimeValue()
Current runtime value read from the router configuration.
private double
trueByteWeightedLossRate()
The true byte-weighted retransmission rate: total bytes resent divided by total bytes sent over the window.
Methods inherited from class Tuner.BaseParam
clamp, getAdditionalEventCount, getAdditionalEventCountHourly, getAdditionalStat, getAdditionalStat5Min, getAdditionalStatHourly, getAdditionalStatLong, getBuildSuccessRate, getCoDelDropEventCount, getCurrentValue, getDefaultMax, getDefaultMin, getDefaultStep, getDefaultValue, getDescription, getHeavyTransitThreshold, getMax, getMessageReceiverUtilization, getMin, getName, getObservedRTT, getPacketHandlerUtilization, getPumperUtilization, getReaderUtilization, getSendFinisherUtilization, getShareBps, getStatHistory, getStatPeriodStamp, getStep, getStreamingLossRate, getSubsystem, getSustainedHeavyTransitThreshold, getValueHistory, getWriterUtilization, isAutoTuning, persistValue, reclaimIfIdle, recordHistory, refreshDefault, refreshRanges, setHealth, setOverride, signalIsFresh, snapshot, update
Modifier and Type
Method
Description
protected static int
clamp(int current, int target, int step)
Move from current toward target, but at most one step per cycle.
protected double
getAdditionalEventCount(RouterContext ctx, String statName)
Fetch the event count for an additional stat using the 60s period.
protected double
getAdditionalEventCountHourly(RouterContext ctx, String statName)
Fetch the event count for an additional stat using the 1-hour period.
protected double
getAdditionalStat(RouterContext ctx, String statName)
Fetch an additional stat value for cross-reference decisions.
protected double
getAdditionalStat5Min(RouterContext ctx, String statName)
Fetch an additional stat value using the 5-minute average.
protected double
getAdditionalStatHourly(RouterContext ctx, String statName)
Fetch an additional stat value using the 1-hour average.
protected double
getAdditionalStatLong(RouterContext ctx, String statName)
Fetch an additional stat value using the 10-minute average.
protected double
getBuildSuccessRate(RouterContext ctx)
Compute actual tunnel build success rate from event counts.
protected double
getCoDelDropEventCount(RouterContext ctx, String prefix)
Fetch the total CoDel drop event count across all priority levels.
int
getCurrentValue()
The value in effect right now.
protected int
getDefaultMax(RouterContext ctx)
Effective default max — override for bandwidth-scaled params.
protected int
getDefaultMin(RouterContext ctx)
Effective default min — override for bandwidth-scaled params.
protected int
getDefaultStep(RouterContext ctx)
Effective default step — override for bandwidth-scaled params.
int
getDefaultValue()
Default value.
String
getDescription()
Param description.
protected static int
getHeavyTransitThreshold(RouterContext ctx)
Transit bandwidth threshold for "heavy" — 80% of configured share bandwidth.
int
getMax()
Maximum value.
protected double
getMessageReceiverUtilization(RouterContext ctx)
UDP message receiver pool utilization (0.0-1.0).
int
getMin()
Minimum value.
String
getName()
Param name.
protected double
getObservedRTT(RouterContext ctx, String primaryStat)
Fetch observed RTT, falling back to udp.sendConfirmTime when the primary stat has no events (lightly loaded router).
protected double
getPacketHandlerUtilization(RouterContext ctx)
UDP packet handler pool utilization (0.0-1.0).
protected double
getPumperUtilization(RouterContext ctx)
Tunnel pumper pool utilization (0.0-1.0).
protected double
getReaderUtilization(RouterContext ctx)
NTCP reader pool utilization (0.0-1.0).
protected double
getSendFinisherUtilization(RouterContext ctx)
NTCP send finisher pool utilization (0.0-1.0).
protected static int
getShareBps(RouterContext ctx)
Current share bandwidth in bytes per second.
double[]
getStatHistory()
Rolling window of recent stat values.
protected double
getStatPeriodStamp(RouterContext ctx, String statName)
When the window behind a stat's event count last completed, in ms, or NaN when it cannot be determined.
int
getStep()
Step size.
protected double
getStreamingLossRate(RouterContext ctx)
Recent streaming retransmission rate for this tuning cycle.
String
getSubsystem()
Subsystem name.
protected static int
getSustainedHeavyTransitThreshold(RouterContext ctx)
Transit bandwidth threshold for "sustained heavy" — 50% of configured share.
int[]
getValueHistory()
Rolling window of recent tunable values.
protected double
getWriterUtilization(RouterContext ctx)
NTCP writer pool utilization (0.0-1.0).
boolean
isAutoTuning()
Whether auto-tuning is enabled.
protected void
persistValue(RouterContext ctx, int value)
Persist a tuned value to autotune.config.
protected static int
reclaimIfIdle(double utilization, int current, int min, double idleThreshold)
Reclaim parked threads from a thread pool that is massively under-utilized.
protected void
recordHistory(double observed)
Record history.
void
refreshDefault(RouterContext ctx)
Re-read the default value from autotune.config for live updates.
void
refreshRanges(RouterContext ctx)
Re-read min/max/step from autotune.config — live update, no restart.
(package private) void
setHealth(Tuner.SystemHealth health)
The current system health score for this update cycle.
void
setOverride(int value)
A manual override value.
(package private) static boolean
signalIsFresh(double periodStamp, double lastStamp)
Whether a signal reading is from a window that closed since the stored stamp.
Tuner.ParamSnapshot
snapshot()
Capture snapshot of current tunable state for display.
void
update()
Main tuning loop for this param.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _lastLossStamp
  private double _lastLossStamp
  Close time of the loss window this decision was last taken on.
- _riseShrink
  private int _riseShrink
  Consecutive windows in the shrink direction.
- _riseClimb
  private int _riseClimb
  Consecutive windows in the climb direction.
Constructor Details
- MaxWindowSizeParam
  MaxWindowSizeParam()
  Creates the parameter that tunes the streaming max window size.
Method Details
- applyValue
  protected void applyValue(int value)
  Description copied from class: Tuner.BaseParam
  Apply the tunable value to the router configuration.
  Specified by:
  applyValue in class Tuner.BaseParam
  Parameters:
  value - the tunable value to apply to router configuration
- getRuntimeValue
  protected int getRuntimeValue()
  Description copied from class: Tuner.BaseParam
  Current runtime value read from the router configuration.
  Specified by:
  getRuntimeValue in class Tuner.BaseParam
  Returns:
  current runtime value read from router config
- getObservedStat
  protected double getObservedStat(RouterContext ctx)
  Description copied from class: Tuner.BaseParam
  Observed stat value used for autotuning.
  ctx is always this param's own context: Tuner takes a single RouterContext, hands the same instance to every BaseParam constructor, and both call sites pass Tuner.BaseParam._ctx. It was previously passed as null, which silently broke any implementation that used the argument instead of the field — a param reading a cross-reference stat then threw on every tuning cycle, was caught by the cycle handler, and never tuned at all, with nothing but a repeated WARN to show for it. Implementations may use either ctx or Tuner.BaseParam._ctx; both are the same object.
  Specified by:
  getObservedStat in class Tuner.BaseParam
  Parameters:
  ctx - router context, never null
  Returns:
  observed stat value for autotuning
- computeTarget
  protected int computeTarget(double observed)
  Description copied from class: Tuner.BaseParam
  Target tunable value computed from the observed stat.
  Specified by:
  computeTarget in class Tuner.BaseParam
  Parameters:
  observed - current stat value
  Returns:
  target tunable value
- decisionReason
  protected String decisionReason()
  Name the gate that decided the ceiling's direction.
  Reads the same three signals computeTarget(double) decides from. Asked only on a cycle that moves the value, so the extra reads cost nothing.
  Overrides:
  decisionReason in class Tuner.BaseParam
  Returns:
  the reason, or null when the param has nothing to report
- averageDuplicateMessageSize
  private double averageDuplicateMessageSize()
  Mean size in bytes of a retransmitted message, or NaN when unread.
  The discriminator the two loss ratios cannot supply. The event-count ratio counts every resend alike and the byte ratio weights by bytes, so their divergence says the two disagree but not whether the resends are small control-plane messages that a byte-in-flight window can ignore or real payload that it cannot. This is the size of an average resend.
  Both inputs are recorded at the same stream-close event over the same 5-minute window, so the two window means divide into the size. The byte figure cannot be recovered from stream.rtxRatioBytes: that stat records 1000*dupBytes/bytesSent per close, so its mean is a mean of per-stream ratios and dividing it into anything to get a size is invalid.
  Bounded by the streams that closed inside the window, so it is a closure-biased lifetime figure rather than a true traffic-rate one: one long stream closing in the window contributes its whole lifetime.
  Returns:
  bytes per retransmitted message, or NaN when either input is absent
- trueByteWeightedLossRate
  private double trueByteWeightedLossRate()
  The true byte-weighted retransmission rate: total bytes resent divided by total bytes sent over the window.
  Unlike stream.rtxRatioBytes this is not a mean of per-connection ratios. That stat records 1000*dupBytes/bytesSent once per closed connection, so its window mean is a mean of ratios: a three-message connection that resent everything counts the same as a three-thousand-message connection that resent one record, and on this router it reads 3.47 % while the byte-weighted figure reads 39-58 %. This method divides the window's total resent bytes by its total sent bytes, so a connection that carried most of the bytes in the window carries most of the weight — the quantity a byte-in-flight ceiling actually needs.
  Both inputs are recorded at the same stream-close event over the same 5-minute window, so the two window means divide into a rate.
  Bounded by the streams that closed inside the window, so it is a closure-biased lifetime figure rather than a true traffic-rate one: one long stream closing in the window contributes its whole lifetime.
  Returns:
  the byte-weighted rate 0.0-1.0, or NaN when either input is absent

Field Summary

Fields inherited from class Tuner.BaseParam

Constructor Summary

Method Summary

Methods inherited from class Tuner.BaseParam

Methods inherited from class Object

Field Details

_lastLossStamp

_riseShrink

_riseClimb

Constructor Details

MaxWindowSizeParam

Method Details

applyValue

getRuntimeValue

getObservedStat

computeTarget

decisionReason

averageDuplicateMessageSize

trueByteWeightedLossRate