disk.go

// Copyright 2016 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package types

import (
	"github.com/coreos/ignition/config/shared/errors"
	"github.com/coreos/ignition/config/validate/report"
)

func (n Disk) Validate() report.Report {
	return report.Report{}
}

func (n Disk) ValidateDevice() report.Report {
	if len(n.Device) == 0 {
		return report.ReportFromError(errors.ErrDiskDeviceRequired, report.EntryError)
	}
	if err := validatePath(string(n.Device)); err != nil {
		return report.ReportFromError(err, report.EntryError)
	}
	return report.Report{}
}

func (n Disk) ValidatePartitions() report.Report {
	r := report.Report{}
	if n.partitionNumbersCollide() {
		r.Add(report.Entry{
			Message: errors.ErrPartitionNumbersCollide.Error(),
			Kind:    report.EntryError,
		})
	}
	if n.partitionsOverlap() {
		r.Add(report.Entry{
			Message: errors.ErrPartitionsOverlap.Error(),
			Kind:    report.EntryError,
		})
	}
	if n.partitionsMisaligned() {
		r.Add(report.Entry{
			Message: errors.ErrPartitionsMisaligned.Error(),
			Kind:    report.EntryError,
		})
	}
	if n.partitionsMixZeroesAndNonexistence() {
		r.Add(report.Entry{
			Message: errors.ErrZeroesWithShouldNotExist.Error(),
			Kind:    report.EntryError,
		})
	}
	if n.partitionsUnitsMismatch() {
		r.Add(report.Entry{
			Message: errors.ErrPartitionsUnitsMismatch.Error(),
			Kind:    report.EntryError,
		})
	}
	// Disks which have no errors at this point will likely succeed in sgdisk
	return r
}

// partitionNumbersCollide returns true if partition numbers in n.Partitions are not unique.
func (n Disk) partitionNumbersCollide() bool {
	m := map[int][]Partition{}
	for _, p := range n.Partitions {
		if p.Number != 0 {
			// a number of 0 means next available number, multiple devices can specify this
			m[p.Number] = append(m[p.Number], p)
		}
	}
	for _, n := range m {
		if len(n) > 1 {
			// TODO(vc): return information describing the collision for logging
			return true
		}
	}
	return false
}

// end returns the last sector of a partition. Only used by partitionsOverlap. Requires non-nil Start and Size.
func (p Partition) end() int {
	if *p.Size == 0 {
		// a size of 0 means "fill available", just return the start as the end for those.
		return *p.Start
	}
	return *p.Start + *p.Size - 1
}

// partitionsOverlap returns true if any explicitly dimensioned partitions overlap
func (n Disk) partitionsOverlap() bool {
	for _, p := range n.Partitions {
		// Starts of 0 are placed by sgdisk into the "largest available block" at that time.
		// We aren't going to check those for overlap since we don't have the disk geometry.
		if p.Start == nil || p.Size == nil || *p.Start == 0 {
			continue
		}

		for _, o := range n.Partitions {
			if o.Start == nil || o.Size == nil || p == o || *o.Start == 0 {
				continue
			}

			// is p.Start within o?
			if *p.Start >= *o.Start && *p.Start <= o.end() {
				return true
			}

			// is p.end() within o?
			if p.end() >= *o.Start && p.end() <= o.end() {
				return true
			}

			// do p.Start and p.end() straddle o?
			if *p.Start < *o.Start && p.end() > o.end() {
				return true
			}
		}
	}
	return false
}

// partitionsMisaligned returns true if any of the partitions don't start on a 2048-sector (1MiB) boundary.
func (n Disk) partitionsMisaligned() bool {
	for _, p := range n.Partitions {
		if p.Start != nil && ((*p.Start & (2048 - 1)) != 0) {
			return true
		}
	}
	return false
}

func (n Disk) partitionsMixZeroesAndNonexistence() bool {
	hasZero := false
	hasShouldNotExist := false
	for _, p := range n.Partitions {
		hasShouldNotExist = hasShouldNotExist || (p.ShouldExist != nil && !*p.ShouldExist)
		hasZero = hasZero || (p.Number == 0)
	}
	return hasZero && hasShouldNotExist
}

func (n Disk) partitionsUnitsMismatch() bool {
	partsInMb := false
	partsNotInMb := false
	for _, p := range n.Partitions {
		if p.Size != nil || p.Start != nil {
			partsNotInMb = true
		}
		if p.SizeMiB != nil || p.StartMiB != nil {
			partsInMb = true
		}
	}
	return partsInMb && partsNotInMb
}