[#72] Support soft memory limit setting

Signed-off-by: Roman Loginov <r.loginov@yadro.com>

app.go

@@ -6,6 +6,7 @@ import (
 	"net/http"
 	"os"
 	"os/signal"
+	"runtime/debug"
 	"sync"
 	"syscall"
 	"time"
@@ -128,6 +129,8 @@ func newApp(ctx context.Context, opt ...Option) App {
 	user.IDFromKey(&owner, a.key.PrivateKey.PublicKey)
 	a.owner = &owner
 
+	a.setRuntimeParameters()
+
 	a.initAppSettings()
 	a.initResolver()
 	a.initMetrics()
@@ -407,6 +410,8 @@ func (a *app) configReload(ctx context.Context) {
 		a.log.Warn(logs.FailedToReloadServerParameters, zap.Error(err))
 	}
 
+	a.setRuntimeParameters()
+
 	a.stopServices()
 	a.startServices()
 
@@ -596,3 +601,19 @@ func (a *app) initTracing(ctx context.Context) {
 		a.log.Info(logs.TracingConfigUpdated)
 	}
 }
+
+func (a *app) setRuntimeParameters() {
+	if len(os.Getenv("GOMEMLIMIT")) != 0 {
+		// default limit < yaml limit < app env limit < GOMEMLIMIT
+		a.log.Warn(logs.RuntimeSoftMemoryDefinedWithGOMEMLIMIT)
+		return
+	}
+
+	softMemoryLimit := fetchSoftMemoryLimit(a.cfg)
+	previous := debug.SetMemoryLimit(softMemoryLimit)
+	if softMemoryLimit != previous {
+		a.log.Info(logs.RuntimeSoftMemoryLimitUpdated,
+			zap.Int64("new_value", softMemoryLimit),
+			zap.Int64("old_value", previous))
+	}
+}

config/config.env

@@ -96,3 +96,5 @@ HTTP_GW_ZIP_COMPRESSION=false
 HTTP_GW_TRACING_ENABLED=true
 HTTP_GW_TRACING_ENDPOINT="localhost:4317"
 HTTP_GW_TRACING_EXPORTER="otlp_grpc"
+
+HTTP_GW_RUNTIME_SOFT_MEMORY_LIMIT=1073741824

config/config.yaml

@@ -101,3 +101,6 @@ pool_error_threshold: 100 # The number of errors on connection after which node
 
 zip:
   compression: false # Enable zip compression to download files by common prefix.
+
+runtime:
+  soft_memory_limit: 1gb

docs/gate-configuration.md

@@ -53,6 +53,7 @@ $ cat http.log
 | `pprof`         | [Pprof configuration](#pprof-section)                 |
 | `prometheus`    | [Prometheus configuration](#prometheus-section)       |
 | `tracing`       | [Tracing configuration](#tracing-section)             |
+| `runtime`       | [Runtime configuration](#runtime-section)             |
 
 
 # General section
@@ -256,3 +257,15 @@ tracing:
 | `enabled`  | `bool`   | yes           | `false`          | Flag to enable the tracing.                                   |
 | `exporter` | `string` | yes           |                  | Trace collector type (`stdout` or `otlp_grpc` are supported). |
 | `endpoint` | `string` | yes           |                  | Address of collector endpoint for OTLP exporters.             |
+
+# `runtime` section
+Contains runtime parameters.
+
+```yaml
+runtime:
+  soft_memory_limit: 1gb
+```
+
+| Parameter           | Type   | SIGHUP reload | Default value | Description                                                                                                                                                                  |
+|---------------------|--------|---------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `soft_memory_limit` | `size` | yes           | maxint64      | Soft memory limit for the runtime. Zero or no value stands for no limit. If `GOMEMLIMIT` environment variable is set, the value from the configuration file will be ignored. |

internal/logs/logs.go

@@ -59,6 +59,8 @@ const (
 	FailedToInitializeTracing                                             = "failed to initialize tracing"                                                           // Warn in ../../app.go
 	TracingConfigUpdated                                                  = "tracing config updated"                                                                 // Info in ../../app.go
 	ResolverNNSWontBeUsedSinceRPCEndpointIsntProvided                     = "resolver nns won't be used since rpc_endpoint isn't provided"                           // Warn in ../../app.go
+	RuntimeSoftMemoryDefinedWithGOMEMLIMIT                                = "soft runtime memory defined with GOMEMLIMIT environment variable, config value skipped" // Warn in ../../app.go
+	RuntimeSoftMemoryLimitUpdated                                         = "soft runtime memory limit value updated"                                                // Info in ../../app.go
 	CouldNotLoadFrostFSPrivateKey                                         = "could not load FrostFS private key"                                                     // Fatal in ../../settings.go
 	UsingCredentials                                                      = "using credentials"                                                                      // Info in ../../settings.go
 	FailedToCreateConnectionPool                                          = "failed to create connection pool"                                                       // Fatal in ../../settings.go

settings.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/hex"
 	"fmt"
+	"math"
 	"os"
 	"path"
 	"runtime"
@@ -36,6 +37,8 @@ const (
 
 	defaultPoolErrorThreshold uint32 = 100
 
+	defaultSoftMemoryLimit = math.MaxInt64
+
 	cfgServer      = "server"
 	cfgTLSEnabled  = "tls.enabled"
 	cfgTLSCertFile = "tls.cert_file"
@@ -90,6 +93,9 @@ const (
 	// Zip compression.
 	cfgZipCompression = "zip.compression"
 
+	// Runtime.
+	cfgSoftMemoryLimit = "runtime.soft_memory_limit"
+
 	// Command line args.
 	cmdHelp          = "help"
 	cmdVersion       = "version"
@@ -516,3 +522,12 @@ func fetchPeers(l *zap.Logger, v *viper.Viper) []pool.NodeParam {
 
 	return nodes
 }
+
+func fetchSoftMemoryLimit(cfg *viper.Viper) int64 {
+	softMemoryLimit := cfg.GetSizeInBytes(cfgSoftMemoryLimit)
+	if softMemoryLimit <= 0 {
+		softMemoryLimit = defaultSoftMemoryLimit
+	}
+
+	return int64(softMemoryLimit)
+}