package zfs import ( "bytes" "crypto/sha512" "encoding/hex" "fmt" "os/exec" ) const ( // For a placeholder filesystem to be a placeholder, the property source must be local, // i.e. not inherited. PlaceholderPropertyName string = "zrepl:placeholder" placeholderPropertyOn string = "on" placeholderPropertyOff string = "off" ) // computeLegacyPlaceholderPropertyValue is a legacy-compatibility function. // // In the 0.0.x series, the value stored in the PlaceholderPropertyName user property // was a hash value of the dataset path. // A simple `on|off` value could not be used at the time because `zfs list` was used to // list all filesystems and their placeholder state with a single command: due to property // inheritance, `zfs list` would print the placeholder state for all (non-placeholder) children // of a dataset, so the hash value was used to distinguish whether the property was local or // inherited. // // One of the drawbacks of the above approach is that `zfs rename` renders a placeholder filesystem // a non-placeholder filesystem if any of the parent path components change. // // We `zfs get` nowadays, which returns the property source, making the hash value no longer // necessary. However, we want to keep legacy compatibility. func computeLegacyHashBasedPlaceholderPropertyValue(p *DatasetPath) string { ps := []byte(p.ToString()) sum := sha512.Sum512_256(ps) return hex.EncodeToString(sum[:]) } // the caller asserts that placeholderPropertyValue is sourceLocal func isLocalPlaceholderPropertyValuePlaceholder(p *DatasetPath, placeholderPropertyValue string) (isPlaceholder bool) { legacy := computeLegacyHashBasedPlaceholderPropertyValue(p) switch placeholderPropertyValue { case legacy: return true case placeholderPropertyOn: return true default: return false } } type FilesystemPlaceholderState struct { FS string FSExists bool IsPlaceholder bool RawLocalPropertyValue string } // ZFSGetFilesystemPlaceholderState is the authoritative way to determine whether a filesystem // is a placeholder. Note that the property source must be `local` for the returned value to be valid. // // For nonexistent FS, err == nil and state.FSExists == false func ZFSGetFilesystemPlaceholderState(p *DatasetPath) (state *FilesystemPlaceholderState, err error) { state = &FilesystemPlaceholderState{FS: p.ToString()} state.FS = p.ToString() props, err := zfsGet(p.ToString(), []string{PlaceholderPropertyName}, sourceLocal) var _ error = (*DatasetDoesNotExist)(nil) // weak assertion on zfsGet's interface if _, ok := err.(*DatasetDoesNotExist); ok { return state, nil } else if err != nil { return state, err } state.FSExists = true state.RawLocalPropertyValue = props.Get(PlaceholderPropertyName) state.IsPlaceholder = isLocalPlaceholderPropertyValuePlaceholder(p, state.RawLocalPropertyValue) return state, nil } func ZFSCreatePlaceholderFilesystem(p *DatasetPath) (err error) { if p.Length() == 1 { return fmt.Errorf("cannot create %q: pools cannot be created with zfs create", p.ToString()) } cmd := exec.Command(ZFS_BINARY, "create", "-o", fmt.Sprintf("%s=%s", PlaceholderPropertyName, placeholderPropertyOn), "-o", "mountpoint=none", p.ToString()) stderr := bytes.NewBuffer(make([]byte, 0, 1024)) cmd.Stderr = stderr if err = cmd.Start(); err != nil { return err } if err = cmd.Wait(); err != nil { err = &ZFSError{ Stderr: stderr.Bytes(), WaitErr: err, } } return } func ZFSSetPlaceholder(p *DatasetPath, isPlaceholder bool) error { props := NewZFSProperties() prop := placeholderPropertyOff if isPlaceholder { prop = placeholderPropertyOn } props.Set(PlaceholderPropertyName, prop) return zfsSet(p.ToString(), props) } type MigrateHashBasedPlaceholderReport struct { OriginalState FilesystemPlaceholderState NeedsModification bool } // fs must exist, will panic otherwise func ZFSMigrateHashBasedPlaceholderToCurrent(fs *DatasetPath, dryRun bool) (*MigrateHashBasedPlaceholderReport, error) { st, err := ZFSGetFilesystemPlaceholderState(fs) if err != nil { return nil, fmt.Errorf("error getting placeholder state: %s", err) } if !st.FSExists { panic("inconsistent placeholder state returned: fs must exist") } report := MigrateHashBasedPlaceholderReport{ OriginalState: *st, } report.NeedsModification = st.IsPlaceholder && st.RawLocalPropertyValue != placeholderPropertyOn if dryRun || !report.NeedsModification { return &report, nil } err = ZFSSetPlaceholder(fs, st.IsPlaceholder) if err != nil { return nil, fmt.Errorf("error re-writing placeholder property: %s", err) } return &report, nil }