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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
|
package uenv
import (
"bufio"
"bytes"
"encoding/binary"
"fmt"
"hash/crc32"
"io"
"io/ioutil"
"os"
"sort"
"strings"
)
// FIXME: add config option for that so that the user can select if
// he/she wants env with or without flags
var headerSize = 5
// Env contains the data of the uboot environment
type Env struct {
fname string
size int
data map[string]string
}
// little endian helpers
func readUint32(data []byte) uint32 {
var ret uint32
buf := bytes.NewBuffer(data)
binary.Read(buf, binary.LittleEndian, &ret)
return ret
}
func writeUint32(u uint32) []byte {
buf := bytes.NewBuffer(nil)
binary.Write(buf, binary.LittleEndian, &u)
return buf.Bytes()
}
// Create a new empty uboot env file with the given size
func Create(fname string, size int) (*Env, error) {
f, err := os.Create(fname)
if err != nil {
return nil, err
}
defer f.Close()
env := &Env{
fname: fname,
size: size,
data: make(map[string]string),
}
return env, nil
}
// OpenFlags instructs open how to alter its behavior.
type OpenFlags int
const (
// OpenBestEffort instructs OpenWithFlags to skip malformed data without returning an error.
OpenBestEffort OpenFlags = 1 << iota
)
// Open opens a existing uboot env file
func Open(fname string) (*Env, error) {
return OpenWithFlags(fname, OpenFlags(0))
}
// OpenWithFlags opens a existing uboot env file, passing additional flags.
func OpenWithFlags(fname string, flags OpenFlags) (*Env, error) {
f, err := os.Open(fname)
if err != nil {
return nil, err
}
defer f.Close()
contentWithHeader, err := ioutil.ReadAll(f)
if err != nil {
return nil, err
}
crc := readUint32(contentWithHeader)
payload := contentWithHeader[headerSize:]
actualCRC := crc32.ChecksumIEEE(payload)
if crc != actualCRC {
return nil, fmt.Errorf("bad CRC: %v != %v", crc, actualCRC)
}
eof := bytes.Index(payload, []byte{0, 0})
data, err := parseData(payload[:eof], flags)
if err != nil {
return nil, err
}
env := &Env{
fname: fname,
size: len(contentWithHeader),
data: data,
}
return env, nil
}
func parseData(data []byte, flags OpenFlags) (map[string]string, error) {
out := make(map[string]string)
for _, envStr := range bytes.Split(data, []byte{0}) {
if len(envStr) == 0 || envStr[0] == 0 || envStr[0] == 255 {
continue
}
l := strings.SplitN(string(envStr), "=", 2)
if len(l) != 2 {
if flags&OpenBestEffort == OpenBestEffort {
continue
}
return nil, fmt.Errorf("cannot parse line %q as key=value pair", envStr)
}
key := l[0]
value := l[1]
out[key] = value
}
return out, nil
}
func (env *Env) String() string {
out := ""
env.iterEnv(func(key, value string) {
out += fmt.Sprintf("%s=%s\n", key, value)
})
return out
}
// Get the value of the environment variable
func (env *Env) Get(name string) string {
return env.data[name]
}
// Set an environment name to the given value, if the value is empty
// the variable will be removed from the environment
func (env *Env) Set(name, value string) {
if name == "" {
panic(fmt.Sprintf("Set() can not be called with empty key for value: %q", value))
}
if value == "" {
delete(env.data, name)
return
}
env.data[name] = value
}
// iterEnv calls the passed function f with key, value for environment
// vars. The order is guaranteed (unlike just iterating over the map)
func (env *Env) iterEnv(f func(key, value string)) {
keys := make([]string, 0, len(env.data))
for k := range env.data {
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
if k == "" {
panic("iterEnv iterating over a empty key")
}
f(k, env.data[k])
}
}
// Save will write out the environment data
func (env *Env) Save() error {
w := bytes.NewBuffer(nil)
// will panic if the buffer can't grow, all writes to
// the buffer will be ok because we sized it correctly
w.Grow(env.size - headerSize)
// write the payload
env.iterEnv(func(key, value string) {
w.Write([]byte(fmt.Sprintf("%s=%s", key, value)))
w.Write([]byte{0})
})
// write double \0 to mark the end of the env
w.Write([]byte{0})
// no keys, so no previous \0 was written so we write one here
if len(env.data) == 0 {
w.Write([]byte{0})
}
// write ff into the remaining parts
writtenSoFar := w.Len()
for i := 0; i < env.size-headerSize-writtenSoFar; i++ {
w.Write([]byte{0xff})
}
// checksum
crc := crc32.ChecksumIEEE(w.Bytes())
// Note that we overwrite the existing file and do not do
// the usual write-rename. The rationale is that we want to
// minimize the amount of writes happening on a potential
// FAT partition where the env is loaded from. The file will
// always be of a fixed size so we know the writes will not
// fail because of ENOSPC.
//
// The size of the env file never changes so we do not
// truncate it.
//
// We also do not O_TRUNC to avoid reallocations on the FS
// to minimize risk of fs corruption.
f, err := os.OpenFile(env.fname, os.O_WRONLY, 0666)
if err != nil {
return err
}
defer f.Close()
if _, err := f.Write(writeUint32(crc)); err != nil {
return err
}
// padding bytes (e.g. for redundant header)
pad := make([]byte, headerSize-binary.Size(crc))
if _, err := f.Write(pad); err != nil {
return err
}
if _, err := f.Write(w.Bytes()); err != nil {
return err
}
return f.Sync()
}
// Import is a helper that imports a given text file that contains
// "key=value" paris into the uboot env. Lines starting with ^# are
// ignored (like the input file on mkenvimage)
func (env *Env) Import(r io.Reader) error {
scanner := bufio.NewScanner(r)
for scanner.Scan() {
line := scanner.Text()
if strings.HasPrefix(line, "#") || len(line) == 0 {
continue
}
l := strings.SplitN(line, "=", 2)
if len(l) == 1 {
return fmt.Errorf("Invalid line: %q", line)
}
env.data[l[0]] = l[1]
}
return scanner.Err()
}
|