github.com/mvdan/u-root-coreutils@v0.0.0-20230122170626-c2eef2898555/pkg/boot/bzimage/kver.go

// Copyright 2021 the u-root Authors. All rights reserved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//
// SPDX-License-Identifier: BSD-3-Clause
//

package bzimage

import (
	"bytes"
	"encoding/binary"
	"errors"
	"fmt"
	"io"
	"strconv"
	"strings"
	"time"
)

/*
values from kernel documentation and libmagic src

off val
510 0xAA55
514 HdrS
526	(4 bytes) != 0x0000
526 (2 bytes, little endian) + 0x200 -> start of null-terminated version string
*/

const kverMax = 1024 // arbitrary

var (
	// ErrBootSig is returned when the boot sig is missing.
	ErrBootSig = errors.New("missing 0x55AA boot sig")
	// ErrBadSig is returned when the kernel header sig is missing.
	ErrBadSig = errors.New("missing kernel header sig")
	// ErrBadOff is returned if the version string offset is null.
	ErrBadOff = errors.New("null version string offset")
	// ErrParse is returned on a parse error.
	ErrParse = errors.New("parse error")
)

// KVer reads the kernel version string. See also: (*BZImage)Kver()
func KVer(k io.ReadSeeker) (string, error) {
	buf := make([]byte, kverMax)
	_, err := k.Seek(0, io.SeekStart)
	if err != nil {
		return "", err
	}
	_, err = k.Read(buf[:530])
	if err != nil {
		return "", err
	}
	if !bytes.Equal(buf[510:512], []byte{0x55, 0xaa}) {
		return "", ErrBootSig
	}
	if string(buf[514:518]) != "HdrS" {
		return "", ErrBadSig
	}
	if bytes.Equal(buf[526:530], []byte{0, 0, 0, 0}) {
		return "", ErrBadOff
	}
	off := int64(binary.LittleEndian.Uint16(buf[526:528])) + 0x200
	_, err = k.Seek(off, io.SeekStart)
	if err != nil {
		return "", err
	}
	if _, err := k.Read(buf[:]); err != nil {
		return "", err
	}
	return nullterm(buf), nil
}

// KVer reads the kernel version string. See also: KVer() above.
func (bz *BzImage) KVer() (string, error) {
	if bz.Header.Kveraddr == 0 {
		return "", ErrParse
	}
	start := uint64(bz.Header.Kveraddr + 0x200)
	bclen := uint64(len(bz.BootCode))
	hdrlen := uint64(bz.KernelOffset) - bclen
	bcoffs := start - hdrlen
	if bcoffs >= bclen {
		return "", ErrParse
	}
	end := bcoffs + kverMax
	if end > bclen {
		end = bclen
	}
	return nullterm(bz.BootCode[bcoffs:end]), nil
}

// read c string from buffer
func nullterm(buf []byte) string {
	var i int
	var b byte
	for i, b = range buf {
		if b == 0 {
			break
		}
	}
	return string(buf[:i])
}

// KInfo struct holds info extracted from the kernel's embedded version string
//
// 2.6.24.111 (bluebat@linux-vm-os64.site) #606 Mon Apr 14 00:06:11 CEST 2014
// 4.19.16-norm_boot (user@host) #300 SMP Fri Jan 25 16:32:19 UTC 2019
//
//	release             (builder)         version
//
// maj.min.patch-localver                #buildnum SMP buildtime
type KInfo struct {
	Release, Version string // uname -r, uname -v respectfully
	Builder          string // user@hostname in parenthesis, shown by `file` but not `uname`

	// the following are extracted from Release and Version

	BuildNum        uint64    //#nnn in Version, 300 in example above
	BuildTime       time.Time // from Version
	Maj, Min, Patch uint64    // from Release
	LocalVer        string    // from Release
}

// Equal compares two KInfo structs and returns
// true if the content is identical.
func (l KInfo) Equal(r KInfo) bool {
	return l.Release == r.Release &&
		l.Builder == r.Builder &&
		l.Version == r.Version &&
		l.BuildNum == r.BuildNum &&
		l.BuildTime.Equal(r.BuildTime) &&
		l.Maj == r.Maj &&
		l.Min == r.Min &&
		l.Patch == r.Patch &&
		l.LocalVer == r.LocalVer
}

const layout = "Mon Jan 2 15:04:05 MST 2006"

// ParseDesc parses the output of KVer() or
// BzImage.KVer(), returning a KInfo struct.
func ParseDesc(desc string) (KInfo, error) {
	var ki KInfo

	// first split at #
	split := strings.Split(desc, "#")
	if len(split) != 2 {
		return KInfo{}, fmt.Errorf("%w: %s: wrong number of '#' chars", ErrParse, desc)
	}
	ki.Version = "#" + split[1]

	// now split first part into release and builder
	elements := strings.SplitN(split[0], " ", 2)
	if len(elements) > 2 {
		return KInfo{}, fmt.Errorf("%w: %s: wrong number of spaces in release/builder", ErrParse, desc)
	}
	ki.Release = elements[0]
	if len(elements) == 2 {
		// not sure if this is _always_ present
		ki.Builder = strings.Trim(elements[1], " ()")
	}
	// split build number off version
	elements = strings.SplitN(split[1], " ", 2)
	if len(elements) != 2 {
		return KInfo{}, fmt.Errorf("%w: %s: wrong number of spaces in build/version", ErrParse, desc)
	}
	i, err := strconv.ParseUint(elements[0], 10, 64)
	if err != nil {
		return KInfo{}, fmt.Errorf("%s: bad uint %s: %w", desc, elements[0], err)
	}
	ki.BuildNum = i
	// remove SMP if present
	t := strings.TrimSpace(strings.TrimPrefix(elements[1], "SMP"))
	// parse remainder as time, using reference time
	ki.BuildTime, err = time.Parse(layout, t)
	if err != nil {
		return KInfo{}, fmt.Errorf("%s: bad time %s: %w", desc, t, err)
	}
	elements = strings.Split(ki.Release, ".")
	if len(elements) < 3 {
		return KInfo{}, fmt.Errorf("%w: %s: wrong number of dots in release %s", ErrParse, desc, ki.Release)
	}
	ki.Maj, err = strconv.ParseUint(elements[0], 10, 64)
	if err != nil {
		return KInfo{}, fmt.Errorf("%s: bad uint %s: %w", desc, elements[0], err)
	}
	ki.Min, err = strconv.ParseUint(elements[1], 10, 64)
	if err != nil {
		return KInfo{}, fmt.Errorf("%s: bad uint %s: %w", desc, elements[1], err)
	}
	elem := strings.SplitN(elements[2], "-", 2)
	ki.Patch, err = strconv.ParseUint(elem[0], 10, 64)
	if err != nil {
		return KInfo{}, fmt.Errorf("%s: bad uint %s: %w", desc, elem[0], err)
	}

	elements = strings.SplitN(elements[len(elements)-1], "-", 2)
	if len(elements) > 1 {
		ki.LocalVer = elements[1]
	}
	return ki, nil
}