mirror of
https://github.com/zrepl/zrepl.git
synced 2024-11-28 19:34:58 +01:00
2d8c3692ec
Before this change, resuming from an unencrypted dataset with send.raw=true specified wouldn't work with zrepl due to overly restrictive resume token checking. An initial PR to fix this was made in https://github.com/zrepl/zrepl/pull/503 but it didn't address the core of the problem. The core of the problem was that zrepl assumed that if a resume token contained `rawok=true, compressok=true`, the resulting send would be encrypted. But if the sender dataset was unencrypted, such a resume would actually result in an unencrypted send. Which could be totally legitimate but zrepl failed to recognize that. BACKGROUND ========== The following snippets of OpenZFS code are insightful regarding how the various ${X}ok values in the resume token are handled: -6c3c5fcfbe/module/zfs/dmu_send.c (L1947-L2012)
-6c3c5fcfbe/module/zfs/dmu_recv.c (L877-L891)
- https://github.com/openzfs/zfs/blob/6c3c5fc/lib/libzfs/libzfs_sendrecv.c#L1663-L1672 Basically, some zfs send flags make the DMU send code set some DMU send stream featureflags, although it's not a pure mapping, i.e, which DMU send stream flags are used depends somewhat on the dataset (e.g., is it encrypted or not, or, does it use zstd or not). Then, the receiver looks at some (but not all) feature flags and maps them to ${X}ok dataset zap attributes. These are funnelled back to the sender 1:1 through the resume_token. And the sender turns them into lzc flags. As an example, let's look at zfs send --raw. if the sender requests a raw send on an unencrypted dataset, the send stream (and hence the resume token) will not have the raw stream featureflag set, and hence the resume token will not have the rawok field set. Instead, it will have compressok, embedok, and depending on whether large blocks are present in the dataset, largeblockok set. WHAT'S ZREPL'S ROLE IN THIS? ============================ zrepl provides a virtual encrypted sendflag that is like `raw`, but further ensures that we only send encrypted datasets. For any other resume token stuff, it shoudn't do any checking, because it's a futile effort to keep up with ZFS send/recv features that are orthogonal to encryption. CHANGES MADE IN THIS COMMIT =========================== - Rip out a bunch of needless checking that zrepl would do during planning. These checks were there to give better error messages, but actually, the error messages created by the endpoint.Sender.Send RPC upon send args validation failure are good enough. - Add platformtests to validate all combinations of (Unencrypted/Encrypted FS) x (send.encrypted = true | false) x (send.raw = true | false) for cases both non-resuming and resuming send. Additional manual testing done: 1. With zrepl 0.5, setup with unencrypted dataset, send.raw=true specified, no send.encrypted specified. 2. Observe that regular non-resuming send works, but resuming doesn't work. 3. Upgrade zrepl to this change. 4. Observe that both regular and resuming send works. closes https://github.com/zrepl/zrepl/pull/613
112 lines
3.5 KiB
Go
112 lines
3.5 KiB
Go
package logic
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/go-playground/validator"
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/zrepl/zrepl/config"
|
|
"github.com/zrepl/zrepl/replication/logic/pdu"
|
|
)
|
|
|
|
//go:generate enumer -type=InitialReplicationAutoResolution -trimprefix=InitialReplicationAutoResolution
|
|
type InitialReplicationAutoResolution uint32
|
|
|
|
const (
|
|
InitialReplicationAutoResolutionMostRecent InitialReplicationAutoResolution = 1 << iota
|
|
InitialReplicationAutoResolutionAll
|
|
InitialReplicationAutoResolutionFail
|
|
)
|
|
|
|
var initialReplicationAutoResolutionConfigMap = map[InitialReplicationAutoResolution]string{
|
|
InitialReplicationAutoResolutionMostRecent: "most_recent",
|
|
InitialReplicationAutoResolutionAll: "all",
|
|
InitialReplicationAutoResolutionFail: "fail",
|
|
}
|
|
|
|
func InitialReplicationAutoResolutionFromConfig(in string) (InitialReplicationAutoResolution, error) {
|
|
for v, s := range initialReplicationAutoResolutionConfigMap {
|
|
if s == in {
|
|
return v, nil
|
|
}
|
|
}
|
|
l := make([]string, 0, len(initialReplicationAutoResolutionConfigMap))
|
|
for _, v := range InitialReplicationAutoResolutionValues() {
|
|
l = append(l, initialReplicationAutoResolutionConfigMap[v])
|
|
}
|
|
return 0, fmt.Errorf("invalid value %q, must be one of %s", in, strings.Join(l, ", "))
|
|
}
|
|
|
|
type ConflictResolution struct {
|
|
InitialReplication InitialReplicationAutoResolution
|
|
}
|
|
|
|
func (c *ConflictResolution) Validate() error {
|
|
if !c.InitialReplication.IsAInitialReplicationAutoResolution() {
|
|
return errors.Errorf("must be one of %s", InitialReplicationAutoResolutionValues())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func ConflictResolutionFromConfig(in *config.ConflictResolution) (*ConflictResolution, error) {
|
|
|
|
initialReplication, err := InitialReplicationAutoResolutionFromConfig(in.InitialReplication)
|
|
if err != nil {
|
|
return nil, errors.Errorf("field `initial_replication` is invalid: %q is not one of %v", in.InitialReplication, InitialReplicationAutoResolutionValues())
|
|
}
|
|
|
|
return &ConflictResolution{
|
|
InitialReplication: initialReplication,
|
|
}, nil
|
|
}
|
|
|
|
type PlannerPolicy struct {
|
|
ConflictResolution *ConflictResolution `validate:"ne=nil"`
|
|
ReplicationConfig *pdu.ReplicationConfig `validate:"ne=nil"`
|
|
SizeEstimationConcurrency int `validate:"gte=1"`
|
|
}
|
|
|
|
var validate = validator.New()
|
|
|
|
func (p PlannerPolicy) Validate() error {
|
|
if err := validate.Struct(p); err != nil {
|
|
return err
|
|
}
|
|
if err := p.ConflictResolution.Validate(); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func ReplicationConfigFromConfig(in *config.Replication) (*pdu.ReplicationConfig, error) {
|
|
initial, err := pduReplicationGuaranteeKindFromConfig(in.Protection.Initial)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "field 'initial'")
|
|
}
|
|
incremental, err := pduReplicationGuaranteeKindFromConfig(in.Protection.Incremental)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "field 'incremental'")
|
|
}
|
|
return &pdu.ReplicationConfig{
|
|
Protection: &pdu.ReplicationConfigProtection{
|
|
Initial: initial,
|
|
Incremental: incremental,
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
func pduReplicationGuaranteeKindFromConfig(in string) (k pdu.ReplicationGuaranteeKind, _ error) {
|
|
switch in {
|
|
case "guarantee_nothing":
|
|
return pdu.ReplicationGuaranteeKind_GuaranteeNothing, nil
|
|
case "guarantee_incremental":
|
|
return pdu.ReplicationGuaranteeKind_GuaranteeIncrementalReplication, nil
|
|
case "guarantee_resumability":
|
|
return pdu.ReplicationGuaranteeKind_GuaranteeResumability, nil
|
|
default:
|
|
return k, errors.Errorf("%q is not in guarantee_{nothing,incremental,resumability}", in)
|
|
}
|
|
}
|