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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package ssa
// Note: Tests use unexported method _Instances.
import (
"bytes"
"fmt"
"go/types"
"reflect"
"sort"
"strings"
"testing"
"golang.org/x/tools/go/loader"
)
// loadProgram creates loader.Program out of p.
func loadProgram(p string) (*loader.Program, error) {
// Parse
var conf loader.Config
f, err := conf.ParseFile("<input>", p)
if err != nil {
return nil, fmt.Errorf("parse: %v", err)
}
conf.CreateFromFiles("p", f)
// Load
lprog, err := conf.Load()
if err != nil {
return nil, fmt.Errorf("Load: %v", err)
}
return lprog, nil
}
// buildPackage builds and returns ssa representation of package pkg of lprog.
func buildPackage(lprog *loader.Program, pkg string, mode BuilderMode) *Package {
prog := NewProgram(lprog.Fset, mode)
for _, info := range lprog.AllPackages {
prog.CreatePackage(info.Pkg, info.Files, &info.Info, info.Importable)
}
p := prog.Package(lprog.Package(pkg).Pkg)
p.Build()
return p
}
// TestNeedsInstance ensures that new method instances can be created via needsInstance,
// that TypeArgs are as expected, and can be accessed via _Instances.
func TestNeedsInstance(t *testing.T) {
const input = `
package p
import "unsafe"
type Pointer[T any] struct {
v unsafe.Pointer
}
func (x *Pointer[T]) Load() *T {
return (*T)(LoadPointer(&x.v))
}
func LoadPointer(addr *unsafe.Pointer) (val unsafe.Pointer)
`
// The SSA members for this package should look something like this:
// func LoadPointer func(addr *unsafe.Pointer) (val unsafe.Pointer)
// type Pointer struct{v unsafe.Pointer}
// method (*Pointer[T any]) Load() *T
// func init func()
// var init$guard bool
lprog, err := loadProgram(input)
if err != err {
t.Fatal(err)
}
for _, mode := range []BuilderMode{BuilderMode(0), InstantiateGenerics} {
// Create and build SSA
p := buildPackage(lprog, "p", mode)
prog := p.Prog
ptr := p.Type("Pointer").Type().(*types.Named)
if ptr.NumMethods() != 1 {
t.Fatalf("Expected Pointer to have 1 method. got %d", ptr.NumMethods())
}
obj := ptr.Method(0)
if obj.Name() != "Load" {
t.Errorf("Expected Pointer to have method named 'Load'. got %q", obj.Name())
}
meth := prog.FuncValue(obj)
b := &builder{}
intSliceTyp := types.NewSlice(types.Typ[types.Int])
instance := meth.instance([]types.Type{intSliceTyp}, b)
if len(b.fns) != 1 {
t.Errorf("Expected first instance to create a function. got %d created functions", len(b.fns))
}
if instance.Origin() != meth {
t.Errorf("Expected Origin of %s to be %s. got %s", instance, meth, instance.Origin())
}
if len(instance.TypeArgs()) != 1 || !types.Identical(instance.TypeArgs()[0], intSliceTyp) {
t.Errorf("Expected TypeArgs of %s to be %v. got %v", instance, []types.Type{intSliceTyp}, instance.typeargs)
}
instances := allInstances(meth)
if want := []*Function{instance}; !reflect.DeepEqual(instances, want) {
t.Errorf("Expected instances of %s to be %v. got %v", meth, want, instances)
}
// A second request with an identical type returns the same Function.
second := meth.instance([]types.Type{types.NewSlice(types.Typ[types.Int])}, b)
if second != instance || len(b.fns) != 1 {
t.Error("Expected second identical instantiation to not create a function")
}
// Add a second instance.
inst2 := meth.instance([]types.Type{types.NewSlice(types.Typ[types.Uint])}, b)
instances = allInstances(meth)
// Note: instance.Name() < inst2.Name()
sort.Slice(instances, func(i, j int) bool {
return instances[i].Name() < instances[j].Name()
})
if want := []*Function{instance, inst2}; !reflect.DeepEqual(instances, want) {
t.Errorf("Expected instances of %s to be %v. got %v", meth, want, instances)
}
// TODO(adonovan): tests should not rely on unexported functions.
// build and sanity check manually created instance.
b.buildFunction(instance)
var buf bytes.Buffer
if !sanityCheck(instance, &buf) {
t.Errorf("sanityCheck of %s failed with: %s", instance, buf.String())
}
}
}
// TestCallsToInstances checks that calles of calls to generic functions,
// without monomorphization, are wrappers around the origin generic function.
func TestCallsToInstances(t *testing.T) {
const input = `
package p
type I interface {
Foo()
}
type A int
func (a A) Foo() {}
type J[T any] interface{ Bar() T }
type K[T any] struct{ J[T] }
func Id[T any] (t T) T {
return t
}
func Lambda[T I]() func() func(T) {
return func() func(T) {
return T.Foo
}
}
func NoOp[T any]() {}
func Bar[T interface { Foo(); ~int | ~string }, U any] (t T, u U) {
Id[U](u)
Id[T](t)
}
func Make[T any]() interface{} {
NoOp[K[T]]()
return nil
}
func entry(i int, a A) int {
Lambda[A]()()(a)
x := Make[int]()
if j, ok := x.(interface{ Bar() int }); ok {
print(j)
}
Bar[A, int](a, i)
return Id[int](i)
}
`
lprog, err := loadProgram(input)
if err != err {
t.Fatal(err)
}
p := buildPackage(lprog, "p", SanityCheckFunctions)
prog := p.Prog
for _, ti := range []struct {
orig string
instance string
tparams string
targs string
chTypeInstrs int // number of ChangeType instructions in f's body
}{
{"Id", "Id[int]", "[T]", "[int]", 2},
{"Lambda", "Lambda[p.A]", "[T]", "[p.A]", 1},
{"Make", "Make[int]", "[T]", "[int]", 0},
{"NoOp", "NoOp[p.K[T]]", "[T]", "[p.K[T]]", 0},
} {
test := ti
t.Run(test.instance, func(t *testing.T) {
f := p.Members[test.orig].(*Function)
if f == nil {
t.Fatalf("origin function not found")
}
i := instanceOf(f, test.instance, prog)
if i == nil {
t.Fatalf("instance not found")
}
// for logging on failures
var body strings.Builder
i.WriteTo(&body)
t.Log(body.String())
if len(i.Blocks) != 1 {
t.Fatalf("body has more than 1 block")
}
if instrs := changeTypeInstrs(i.Blocks[0]); instrs != test.chTypeInstrs {
t.Errorf("want %v instructions; got %v", test.chTypeInstrs, instrs)
}
if test.tparams != tparams(i) {
t.Errorf("want %v type params; got %v", test.tparams, tparams(i))
}
if test.targs != targs(i) {
t.Errorf("want %v type arguments; got %v", test.targs, targs(i))
}
})
}
}
func instanceOf(f *Function, name string, prog *Program) *Function {
for _, i := range allInstances(f) {
if i.Name() == name {
return i
}
}
return nil
}
func tparams(f *Function) string {
tplist := f.TypeParams()
var tps []string
for i := 0; i < tplist.Len(); i++ {
tps = append(tps, tplist.At(i).String())
}
return fmt.Sprint(tps)
}
func targs(f *Function) string {
var tas []string
for _, ta := range f.TypeArgs() {
tas = append(tas, ta.String())
}
return fmt.Sprint(tas)
}
func changeTypeInstrs(b *BasicBlock) int {
cnt := 0
for _, i := range b.Instrs {
if _, ok := i.(*ChangeType); ok {
cnt++
}
}
return cnt
}
func TestInstanceUniqueness(t *testing.T) {
const input = `
package p
func H[T any](t T) {
print(t)
}
func F[T any](t T) {
H[T](t)
H[T](t)
H[T](t)
}
func G[T any](t T) {
H[T](t)
H[T](t)
}
func Foo[T any, S any](t T, s S) {
Foo[S, T](s, t)
Foo[T, S](t, s)
}
`
lprog, err := loadProgram(input)
if err != err {
t.Fatal(err)
}
p := buildPackage(lprog, "p", SanityCheckFunctions)
for _, test := range []struct {
orig string
instances string
}{
{"H", "[p.H[T] p.H[T]]"},
{"Foo", "[p.Foo[S T] p.Foo[T S]]"},
} {
t.Run(test.orig, func(t *testing.T) {
f := p.Members[test.orig].(*Function)
if f == nil {
t.Fatalf("origin function not found")
}
instances := allInstances(f)
sort.Slice(instances, func(i, j int) bool { return instances[i].Name() < instances[j].Name() })
if got := fmt.Sprintf("%v", instances); !reflect.DeepEqual(got, test.instances) {
t.Errorf("got %v instances, want %v", got, test.instances)
}
})
}
}
// allInstances returns a new unordered array of all instances of the
// specified function, if generic, or nil otherwise.
//
// Thread-safe.
//
// TODO(adonovan): delete this. The tests should be intensional (e.g.
// "what instances of f are reachable?") not representational (e.g.
// "what is the history of calls to Function.instance?").
//
// Acquires fn.generic.instancesMu.
func allInstances(fn *Function) []*Function {
if fn.generic == nil {
return nil
}
fn.generic.instancesMu.Lock()
defer fn.generic.instancesMu.Unlock()
return mapValues(fn.generic.instances)
}
|