From ff6b1c8fa15d019dabd135592107ca08cdb2bd33 Mon Sep 17 00:00:00 2001 From: Leo Balduf Date: Fri, 9 Sep 2022 11:20:15 +0200 Subject: [PATCH] core/node: add configuration options for Bitswap via fx Fixes #9256 --- core/node/bitswap.go | 44 +++++++++++++++++++++++++++++++++++--------- core/node/groups.go | 3 ++- 2 files changed, 37 insertions(+), 10 deletions(-) diff --git a/core/node/bitswap.go b/core/node/bitswap.go index 1369243a301a..9b622484bec5 100644 --- a/core/node/bitswap.go +++ b/core/node/bitswap.go @@ -7,7 +7,7 @@ import ( "github.com/ipfs/go-bitswap/network" blockstore "github.com/ipfs/go-ipfs-blockstore" exchange "github.com/ipfs/go-ipfs-exchange-interface" - config "github.com/ipfs/kubo/config" + "github.com/ipfs/kubo/config" irouting "github.com/ipfs/kubo/routing" "github.com/libp2p/go-libp2p-core/host" "go.uber.org/fx" @@ -15,19 +15,24 @@ import ( "github.com/ipfs/kubo/core/node/helpers" ) +// Docs: https://github.com/ipfs/kubo/blob/master/docs/config.md#internalbitswap const ( - // Docs: https://github.com/ipfs/kubo/blob/master/docs/config.md#internalbitswap DefaultEngineBlockstoreWorkerCount = 128 DefaultTaskWorkerCount = 8 DefaultEngineTaskWorkerCount = 8 DefaultMaxOutstandingBytesPerPeer = 1 << 20 ) -// OnlineExchange creates new LibP2P backed block exchange (BitSwap) -func OnlineExchange(cfg *config.Config, provide bool) interface{} { - return func(mctx helpers.MetricsCtx, lc fx.Lifecycle, host host.Host, rt irouting.TieredRouter, bs blockstore.GCBlockstore) exchange.Interface { - bitswapNetwork := network.NewFromIpfsHost(host, rt) +type bitswapOptionsOut struct { + fx.Out + BitswapOpts []bitswap.Option `group:"bitswap-options,flatten"` +} + +// BitswapOptions creates configuration options for Bitswap from the config file +// and whether to provide data. +func BitswapOptions(cfg *config.Config, provide bool) fx.Option { + return fx.Provide(func() bitswapOptionsOut { var internalBsCfg config.InternalBitswap if cfg.Internal.Bitswap != nil { internalBsCfg = *cfg.Internal.Bitswap @@ -40,13 +45,34 @@ func OnlineExchange(cfg *config.Config, provide bool) interface{} { bitswap.EngineTaskWorkerCount(int(internalBsCfg.EngineTaskWorkerCount.WithDefault(DefaultEngineTaskWorkerCount))), bitswap.MaxOutstandingBytesPerPeer(int(internalBsCfg.MaxOutstandingBytesPerPeer.WithDefault(DefaultMaxOutstandingBytesPerPeer))), } - exch := bitswap.New(helpers.LifecycleCtx(mctx, lc), bitswapNetwork, bs, opts...) + + return bitswapOptionsOut{BitswapOpts: opts} + }) +} + +type onlineExchangeIn struct { + fx.In + + Mctx helpers.MetricsCtx + Host host.Host + Rt irouting.TieredRouter + Bs blockstore.GCBlockstore + BitswapOpts []bitswap.Option `group:"bitswap-options"` +} + +// OnlineExchange creates new LibP2P backed block exchange (BitSwap). +// Additional options to bitswap.New can be provided via the "bitswap-options" +// group. +func OnlineExchange() fx.Option { + return fx.Provide(func(in onlineExchangeIn, lc fx.Lifecycle) exchange.Interface { + bitswapNetwork := network.NewFromIpfsHost(in.Host, in.Rt) + + exch := bitswap.New(helpers.LifecycleCtx(in.Mctx, lc), bitswapNetwork, in.Bs, in.BitswapOpts...) lc.Append(fx.Hook{ OnStop: func(ctx context.Context) error { return exch.Close() }, }) return exch - - } + }) } diff --git a/core/node/groups.go b/core/node/groups.go index 9f1795e1fe86..35ab65623256 100644 --- a/core/node/groups.go +++ b/core/node/groups.go @@ -293,7 +293,8 @@ func Online(bcfg *BuildCfg, cfg *config.Config) fx.Option { shouldBitswapProvide := !cfg.Experimental.StrategicProviding return fx.Options( - fx.Provide(OnlineExchange(cfg, shouldBitswapProvide)), + BitswapOptions(cfg, shouldBitswapProvide), + OnlineExchange(), maybeProvide(Graphsync, cfg.Experimental.GraphsyncEnabled), fx.Provide(DNSResolver), fx.Provide(Namesys(ipnsCacheSize)),