Files
visor/tools/go_hostlayout/hostlayoutgen_template.go
Etienne PerotandgVisor bot 056a85f39d Mark all ABI structs with structs.HostLayout; verify this remains true.
This change marks all ABI-related structs with `structs.HostLayout`, which was
introduced in Go 1.23: https://pkg.go.dev/[email protected]#HostLayout
This is intended to force the Go compiler to preserve the layout of the
struct, removing it from the liberty of reordering fields as it sees fit.

Adds a check automatically generated by our `go_library` rule wrapper which
verifies this recursively for all exported structs in a package.

Fixes issue #10693.

PiperOrigin-RevId: 860238103
2026-01-23 13:45:28 -08:00

63 lines
1.6 KiB
Go

// Copyright 2026 The gVisor Authors.
//
// 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.
//go:build !false
// +build !false
package main
import (
"fmt"
"path/filepath"
"strings"
)
const testTmpl = `// Autogenerated test for hostlayout check.
package {{.Package}}_hostlayout_test
import (
"reflect"
"testing"
"{{.ImportPath}}"
"gvisor.dev/gvisor/tools/go_hostlayout/hostlayoutcheck"
)
{{range .Structs}}
func TestHostLayout_{{.}}(t *testing.T) {
if err := hostlayoutcheck.Validate(reflect.TypeOf((*{{$.Package}}.{{.}})(nil)).Elem()); err != nil {
t.Errorf("Struct {{.}} failed hostlayout check: %v", err)
}
}
{{end}}
`
type templateData struct {
Package string
ImportPath string
Structs []string
}
func newTemplateData(pkg string, importPath string, structs []string) (*templateData, error) {
idx := strings.Index(importPath, "pkg/")
if idx == -1 {
return nil, fmt.Errorf("failed to find 'pkg/' in %q", importPath)
}
return &templateData{
Package: pkg,
ImportPath: filepath.Join("gvisor.dev", "gvisor", filepath.Dir(importPath[idx:])),
Structs: structs,
}, nil
}