mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 18:37:45 +08:00
a688b7eeac
* fix: add MFS operation limit for --flush=false adds a global counter that tracks consecutive MFS operations performed with --flush=false and fails with clear error after limit is reached. this prevents unbounded memory growth while avoiding the data corruption risks of auto-flushing. - adds Internal.MFSNoFlushLimit config - operations fail with actionable error at limit - counter resets on successful flush or any --flush=true operation - operations with --flush=true reset and don't count this commit removes automatic flush from https://github.com/ipfs/kubo/pull/10971 and instead errors to encourage users of --flush=false to develop a habit of calling 'ipfs files flush' periodically. boxo will no longer auto-flush (https://github.com/ipfs/boxo/pull/1041) to avoid corruption issues, and kubo applies the limit to 'ipfs files' commands instead. closes #10842 * test: add tests for MFSNoFlushLimit tests verify the new Internal.MFSNoFlushLimit config option: - default limit of 256 operations - custom limit configuration - counter reset on flush=true - counter reset on explicit flush command - limit=0 disables the feature - multiple MFS command types count towards limit * docs: explain why MFS operations fail instead of auto-flushing addresses feedback from https://github.com/ipfs/kubo/pull/10985#pullrequestreview-3256250970 - clarify that automatic flushing at limit was considered but rejected - explain the data corruption risks of auto-flushing - guide users who want auto-flush to use --flush=true (default) - document benefits of explicit failure for batch operations
79 lines
4.0 KiB
Go
79 lines
4.0 KiB
Go
package config
|
|
|
|
const (
|
|
// DefaultMFSNoFlushLimit is the default limit for consecutive unflushed MFS operations
|
|
DefaultMFSNoFlushLimit = 256
|
|
)
|
|
|
|
type Internal struct {
|
|
// All marked as omitempty since we are expecting to make changes to all subcomponents of Internal
|
|
Bitswap *InternalBitswap `json:",omitempty"`
|
|
UnixFSShardingSizeThreshold *OptionalString `json:",omitempty"` // moved to Import.UnixFSHAMTDirectorySizeThreshold
|
|
Libp2pForceReachability *OptionalString `json:",omitempty"`
|
|
BackupBootstrapInterval *OptionalDuration `json:",omitempty"`
|
|
// MFSNoFlushLimit controls the maximum number of consecutive
|
|
// MFS operations allowed with --flush=false before requiring a manual flush.
|
|
// This prevents unbounded memory growth and ensures data consistency.
|
|
// Set to 0 to disable limiting (old behavior, may cause high memory usage)
|
|
// This is an EXPERIMENTAL feature and may change or be removed in future releases.
|
|
// See https://github.com/ipfs/kubo/issues/10842
|
|
MFSNoFlushLimit *OptionalInteger `json:",omitempty"`
|
|
}
|
|
|
|
type InternalBitswap struct {
|
|
TaskWorkerCount OptionalInteger
|
|
EngineBlockstoreWorkerCount OptionalInteger
|
|
EngineTaskWorkerCount OptionalInteger
|
|
MaxOutstandingBytesPerPeer OptionalInteger
|
|
ProviderSearchDelay OptionalDuration
|
|
ProviderSearchMaxResults OptionalInteger
|
|
WantHaveReplaceSize OptionalInteger
|
|
BroadcastControl *BitswapBroadcastControl
|
|
}
|
|
|
|
type BitswapBroadcastControl struct {
|
|
// EnableEnables or disables broadcast control functionality. Setting this
|
|
// to false disables broadcast control functionality and restores the
|
|
// previous broadcast behavior of sending broadcasts to all peers. When
|
|
// disabled, all other BroadcastControl configuration items are ignored.
|
|
// Default is [DefaultBroadcastControlEnable].
|
|
Enable Flag `json:",omitempty"`
|
|
// MaxPeers sets a hard limit on the number of peers to send broadcasts to.
|
|
// A value of 0 means no broadcasts are sent. A value of -1 means there is
|
|
// no limit. Default is [DefaultBroadcastControlMaxPeers].
|
|
MaxPeers OptionalInteger `json:",omitempty"`
|
|
// LocalPeers enables or disables broadcast control for peers on the local
|
|
// network. If false, than always broadcast to peers on the local network.
|
|
// If true, apply broadcast control to local peers. Default is
|
|
// [DefaultBroadcastControlLocalPeers].
|
|
LocalPeers Flag `json:",omitempty"`
|
|
// PeeredPeers enables or disables broadcast reduction for peers configured
|
|
// for peering. If false, than always broadcast to peers configured for
|
|
// peering. If true, apply broadcast reduction to peered peers. Default is
|
|
// [DefaultBroadcastControlPeeredPeers].
|
|
PeeredPeers Flag `json:",omitempty"`
|
|
// MaxRandomPeers is the number of peers to broadcast to anyway, even
|
|
// though broadcast reduction logic has determined that they are not
|
|
// broadcast targets. Setting this to a non-zero value ensures at least
|
|
// this number of random peers receives a broadcast. This may be helpful in
|
|
// cases where peers that are not receiving broadcasts my have wanted
|
|
// blocks. Default is [DefaultBroadcastControlMaxRandomPeers].
|
|
MaxRandomPeers OptionalInteger `json:",omitempty"`
|
|
// SendToPendingPeers enables or disables sending broadcasts to any peers
|
|
// to which there is a pending message to send. When enabled, this sends
|
|
// broadcasts to many more peers, but does so in a way that does not
|
|
// increase the number of separate broadcast messages. There is still the
|
|
// increased cost of the recipients having to process and respond to the
|
|
// broadcasts. Default is [DefaultBroadcastControlSendToPendingPeers].
|
|
SendToPendingPeers Flag `json:",omitempty"`
|
|
}
|
|
|
|
const (
|
|
DefaultBroadcastControlEnable = true // Enabled
|
|
DefaultBroadcastControlMaxPeers = -1 // Unlimited
|
|
DefaultBroadcastControlLocalPeers = false // No control of local
|
|
DefaultBroadcastControlPeeredPeers = false // No control of peered
|
|
DefaultBroadcastControlMaxRandomPeers = 0 // No randoms
|
|
DefaultBroadcastControlSendToPendingPeers = false // Disabled
|
|
)
|