File: partial.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (142 lines) | stat: -rw-r--r-- 4,109 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2023 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package gadget

import "fmt"

// ApplyInstallerVolumesToGadget takes the volume information returned
// by the installer and applies it to the gadget volumes for the
// device to install to and for properties partially defined,
// returning the result in a new Volume map. After that it checks that
// the gadget is now fully specified.
func ApplyInstallerVolumesToGadget(installerVols map[string]*Volume, gadgetVols map[string]*Volume) (map[string]*Volume, error) {
	newVols := map[string]*Volume{}
	for volName, gv := range gadgetVols {
		newV := gv.Copy()
		newVols[volName] = newV

		insVol := installerVols[volName]
		if insVol == nil {
			return nil, fmt.Errorf("installer did not provide information for volume %q", volName)
		}

		// First, retrieve device specified by installer
		for i := range newV.Structure {
			insStr, err := structureByName(insVol.Structure, newV.Structure[i].Name)
			if err != nil {
				return nil, err
			}
			newV.Structure[i].Device = insStr.Device
		}

		// Next changes are only for partial gadgets
		if len(newV.Partial) == 0 {
			continue
		}

		// TODO: partial structure, as it is not clear what will be possible when set

		if newV.HasPartial(PartialSchema) {
			if insVol.Schema == "" {
				return nil, fmt.Errorf("installer did not provide schema for volume %q", volName)
			}
			newV.Schema = insVol.Schema
		}

		if newV.HasPartial(PartialFilesystem) {
			if err := applyPartialFilesystem(insVol, newV, volName); err != nil {
				return nil, err
			}
		}

		if newV.HasPartial(PartialSize) {
			if err := applyPartialSize(insVol, newV, volName); err != nil {
				return nil, err
			}
		}

		// The only thing that can still be partial is the structure
		if newV.HasPartial(PartialStructure) {
			newV.Partial = []PartialProperty{PartialStructure}
		} else {
			newV.Partial = []PartialProperty{}
		}

		// Now validate finalized volume
		if err := validateVolume(newV); err != nil {
			return nil, fmt.Errorf("finalized volume %q is wrong: %v", newV.Name, err)
		}
	}

	return newVols, nil
}

func applyPartialFilesystem(insVol *Volume, gadgetVol *Volume, volName string) error {
	for sidx := range gadgetVol.Structure {
		vs := &gadgetVol.Structure[sidx]
		if vs.Filesystem != "" || !vs.HasFilesystem() {
			continue
		}

		insStr, err := structureByName(insVol.Structure, vs.Name)
		if err != nil {
			return err
		}
		if insStr.Filesystem == "" {
			return fmt.Errorf("installer did not provide filesystem for structure %q in volume %q", vs.Name, volName)
		}

		vs.Filesystem = insStr.Filesystem
	}
	return nil
}

func applyPartialSize(insVol *Volume, gadgetVol *Volume, volName string) error {
	for sidx := range gadgetVol.Structure {
		vs := &gadgetVol.Structure[sidx]
		if !vs.hasPartialSize() {
			continue
		}

		insStr, err := structureByName(insVol.Structure, vs.Name)
		if err != nil {
			return err
		}
		if insStr.Size == 0 {
			return fmt.Errorf("installer did not provide size for structure %q in volume %q", vs.Name, volName)
		}
		if insStr.Offset == nil {
			return fmt.Errorf("installer did not provide offset for structure %q in volume %q", vs.Name, volName)
		}

		vs.Size = insStr.Size
		vs.Offset = insStr.Offset
	}
	return nil
}

func structureByName(vss []VolumeStructure, name string) (*VolumeStructure, error) {
	for sidx := range vss {
		if vss[sidx].Name == name {
			return &vss[sidx], nil
		}
	}
	return nil, fmt.Errorf("cannot find structure %q", name)
}