2024-06-17 10:29:18 -04:00
|
|
|
// Copyright (c) 2015-2024 MinIO, Inc.
|
2021-04-18 15:41:13 -04:00
|
|
|
//
|
|
|
|
|
// This file is part of MinIO Object Storage stack
|
|
|
|
|
//
|
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
|
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
// (at your option) any later version.
|
|
|
|
|
//
|
|
|
|
|
// This program is distributed in the hope that it will be useful
|
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
// GNU Affero General Public License for more details.
|
|
|
|
|
//
|
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2018-10-04 20:44:06 -04:00
|
|
|
|
|
|
|
|
package cmd
|
|
|
|
|
|
perf: websocket grid connectivity for all internode communication (#18461)
This PR adds a WebSocket grid feature that allows servers to communicate via
a single two-way connection.
There are two request types:
* Single requests, which are `[]byte => ([]byte, error)`. This is for efficient small
roundtrips with small payloads.
* Streaming requests which are `[]byte, chan []byte => chan []byte (and error)`,
which allows for different combinations of full two-way streams with an initial payload.
Only a single stream is created between two machines - and there is, as such, no
server/client relation since both sides can initiate and handle requests. Which server
initiates the request is decided deterministically on the server names.
Requests are made through a mux client and server, which handles message
passing, congestion, cancelation, timeouts, etc.
If a connection is lost, all requests are canceled, and the calling server will try
to reconnect. Registered handlers can operate directly on byte
slices or use a higher-level generics abstraction.
There is no versioning of handlers/clients, and incompatible changes should
be handled by adding new handlers.
The request path can be changed to a new one for any protocol changes.
First, all servers create a "Manager." The manager must know its address
as well as all remote addresses. This will manage all connections.
To get a connection to any remote, ask the manager to provide it given
the remote address using.
```
func (m *Manager) Connection(host string) *Connection
```
All serverside handlers must also be registered on the manager. This will
make sure that all incoming requests are served. The number of in-flight
requests and responses must also be given for streaming requests.
The "Connection" returned manages the mux-clients. Requests issued
to the connection will be sent to the remote.
* `func (c *Connection) Request(ctx context.Context, h HandlerID, req []byte) ([]byte, error)`
performs a single request and returns the result. Any deadline provided on the request is
forwarded to the server, and canceling the context will make the function return at once.
* `func (c *Connection) NewStream(ctx context.Context, h HandlerID, payload []byte) (st *Stream, err error)`
will initiate a remote call and send the initial payload.
```Go
// A Stream is a two-way stream.
// All responses *must* be read by the caller.
// If the call is canceled through the context,
//The appropriate error will be returned.
type Stream struct {
// Responses from the remote server.
// Channel will be closed after an error or when the remote closes.
// All responses *must* be read by the caller until either an error is returned or the channel is closed.
// Canceling the context will cause the context cancellation error to be returned.
Responses <-chan Response
// Requests sent to the server.
// If the handler is defined with 0 incoming capacity this will be nil.
// Channel *must* be closed to signal the end of the stream.
// If the request context is canceled, the stream will no longer process requests.
Requests chan<- []byte
}
type Response struct {
Msg []byte
Err error
}
```
There are generic versions of the server/client handlers that allow the use of type
safe implementations for data types that support msgpack marshal/unmarshal.
2023-11-20 20:09:35 -05:00
|
|
|
//go:generate msgp -file $GOFILE -unexported
|
|
|
|
|
|
2019-10-01 16:12:15 -04:00
|
|
|
const (
|
2024-06-17 10:29:18 -04:00
|
|
|
storageRESTVersion = "v59" // Change ReadOptions inclFreeVersions
|
2019-12-12 09:02:37 -05:00
|
|
|
storageRESTVersionPrefix = SlashSeparator + storageRESTVersion
|
2019-11-04 12:30:59 -05:00
|
|
|
storageRESTPrefix = minioReservedBucketPath + "/storage"
|
2019-10-01 16:12:15 -04:00
|
|
|
)
|
2018-10-04 20:44:06 -04:00
|
|
|
|
|
|
|
|
const (
|
2024-01-17 23:41:23 -05:00
|
|
|
storageRESTMethodHealth = "/health"
|
2018-10-04 20:44:06 -04:00
|
|
|
|
2019-11-04 12:30:59 -05:00
|
|
|
storageRESTMethodAppendFile = "/appendfile"
|
|
|
|
|
storageRESTMethodCreateFile = "/createfile"
|
|
|
|
|
storageRESTMethodWriteAll = "/writeall"
|
2020-06-12 23:04:01 -04:00
|
|
|
storageRESTMethodReadVersion = "/readversion"
|
2022-04-20 15:49:05 -04:00
|
|
|
storageRESTMethodReadXL = "/readxl"
|
2019-11-04 12:30:59 -05:00
|
|
|
storageRESTMethodReadAll = "/readall"
|
|
|
|
|
storageRESTMethodReadFile = "/readfile"
|
|
|
|
|
storageRESTMethodReadFileStream = "/readfilestream"
|
|
|
|
|
storageRESTMethodListDir = "/listdir"
|
2020-06-12 23:04:01 -04:00
|
|
|
storageRESTMethodDeleteVersions = "/deleteverions"
|
2019-11-04 12:30:59 -05:00
|
|
|
storageRESTMethodRenameFile = "/renamefile"
|
|
|
|
|
storageRESTMethodVerifyFile = "/verifyfile"
|
2021-07-09 14:29:16 -04:00
|
|
|
storageRESTMethodStatInfoFile = "/statfile"
|
2022-07-19 11:35:29 -04:00
|
|
|
storageRESTMethodReadMultiple = "/readmultiple"
|
2022-11-28 13:20:55 -05:00
|
|
|
storageRESTMethodCleanAbandoned = "/cleanabandoned"
|
2018-10-04 20:44:06 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
const (
|
2024-06-17 10:29:18 -04:00
|
|
|
storageRESTVolume = "volume"
|
|
|
|
|
storageRESTVolumes = "volumes"
|
|
|
|
|
storageRESTDirPath = "dir-path"
|
|
|
|
|
storageRESTFilePath = "file-path"
|
|
|
|
|
storageRESTVersionID = "version-id"
|
|
|
|
|
storageRESTReadData = "read-data"
|
|
|
|
|
storageRESTHealing = "healing"
|
|
|
|
|
storageRESTTotalVersions = "total-versions"
|
|
|
|
|
storageRESTSrcVolume = "source-volume"
|
|
|
|
|
storageRESTSrcPath = "source-path"
|
|
|
|
|
storageRESTDstVolume = "destination-volume"
|
|
|
|
|
storageRESTDstPath = "destination-path"
|
|
|
|
|
storageRESTOffset = "offset"
|
|
|
|
|
storageRESTLength = "length"
|
|
|
|
|
storageRESTCount = "count"
|
|
|
|
|
storageRESTBitrotAlgo = "bitrot-algo"
|
|
|
|
|
storageRESTBitrotHash = "bitrot-hash"
|
|
|
|
|
storageRESTDiskID = "disk-id"
|
|
|
|
|
storageRESTForceDelete = "force-delete"
|
|
|
|
|
storageRESTGlob = "glob"
|
|
|
|
|
storageRESTMetrics = "metrics"
|
|
|
|
|
storageRESTDriveQuorum = "drive-quorum"
|
|
|
|
|
storageRESTOrigVolume = "orig-volume"
|
|
|
|
|
storageRESTInclFreeVersions = "incl-free-versions"
|
2018-10-04 20:44:06 -04:00
|
|
|
)
|
perf: websocket grid connectivity for all internode communication (#18461)
This PR adds a WebSocket grid feature that allows servers to communicate via
a single two-way connection.
There are two request types:
* Single requests, which are `[]byte => ([]byte, error)`. This is for efficient small
roundtrips with small payloads.
* Streaming requests which are `[]byte, chan []byte => chan []byte (and error)`,
which allows for different combinations of full two-way streams with an initial payload.
Only a single stream is created between two machines - and there is, as such, no
server/client relation since both sides can initiate and handle requests. Which server
initiates the request is decided deterministically on the server names.
Requests are made through a mux client and server, which handles message
passing, congestion, cancelation, timeouts, etc.
If a connection is lost, all requests are canceled, and the calling server will try
to reconnect. Registered handlers can operate directly on byte
slices or use a higher-level generics abstraction.
There is no versioning of handlers/clients, and incompatible changes should
be handled by adding new handlers.
The request path can be changed to a new one for any protocol changes.
First, all servers create a "Manager." The manager must know its address
as well as all remote addresses. This will manage all connections.
To get a connection to any remote, ask the manager to provide it given
the remote address using.
```
func (m *Manager) Connection(host string) *Connection
```
All serverside handlers must also be registered on the manager. This will
make sure that all incoming requests are served. The number of in-flight
requests and responses must also be given for streaming requests.
The "Connection" returned manages the mux-clients. Requests issued
to the connection will be sent to the remote.
* `func (c *Connection) Request(ctx context.Context, h HandlerID, req []byte) ([]byte, error)`
performs a single request and returns the result. Any deadline provided on the request is
forwarded to the server, and canceling the context will make the function return at once.
* `func (c *Connection) NewStream(ctx context.Context, h HandlerID, payload []byte) (st *Stream, err error)`
will initiate a remote call and send the initial payload.
```Go
// A Stream is a two-way stream.
// All responses *must* be read by the caller.
// If the call is canceled through the context,
//The appropriate error will be returned.
type Stream struct {
// Responses from the remote server.
// Channel will be closed after an error or when the remote closes.
// All responses *must* be read by the caller until either an error is returned or the channel is closed.
// Canceling the context will cause the context cancellation error to be returned.
Responses <-chan Response
// Requests sent to the server.
// If the handler is defined with 0 incoming capacity this will be nil.
// Channel *must* be closed to signal the end of the stream.
// If the request context is canceled, the stream will no longer process requests.
Requests chan<- []byte
}
type Response struct {
Msg []byte
Err error
}
```
There are generic versions of the server/client handlers that allow the use of type
safe implementations for data types that support msgpack marshal/unmarshal.
2023-11-20 20:09:35 -05:00
|
|
|
|
|
|
|
|
type nsScannerOptions struct {
|
|
|
|
|
DiskID string `msg:"id"`
|
|
|
|
|
ScanMode int `msg:"m"`
|
|
|
|
|
Cache *dataUsageCache `msg:"c"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type nsScannerResp struct {
|
|
|
|
|
Update *dataUsageEntry `msg:"u"`
|
|
|
|
|
Final *dataUsageCache `msg:"f"`
|
|
|
|
|
}
|
