go/analysis: fix more printf pointer bugs
The first issue is that %b and %o can print pointers, but printVerbs
didn't reflect that:
The %b, %d, %o, %x and %X verbs also work with pointers,
formatting the value exactly as if it were an integer.
The second issue is that arrays can never be printed as pointers. This
was previously reported as part of #27672.
The third issue is that only %p can print all slices, maps, and
functions as if they were pointers. This differs from verbs like %b or
%o, which can't print these types as pointers.
Fix all of the issues above, and add extensive test cases covering all
the combinations. Verified all of them with an executed program. The
amount of test cases is perhaps overkill, but this is not the first time
we've gotten the printf pointer logic wrong.
Updates #27672.
Fixes #28858.
Change-Id: I62eb79d505fd1e250a16b90bda3c68b702f35a29
Reviewed-on: https://go-review.googlesource.com/c/149979
Run-TryBot: Daniel Martí <mvdan@mvdan.cc>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Alan Donovan <adonovan@google.com>
diff --git a/go/analysis/passes/printf/printf.go b/go/analysis/passes/printf/printf.go
index 9fa0a1c..c0265aa 100644
--- a/go/analysis/passes/printf/printf.go
+++ b/go/analysis/passes/printf/printf.go
@@ -714,7 +714,7 @@
// '#' is alternate format for several verbs.
// ' ' is spacer for numbers
{'%', noFlag, 0},
- {'b', numFlag, argInt | argFloat | argComplex},
+ {'b', numFlag, argInt | argFloat | argComplex | argPointer},
{'c', "-", argRune | argInt},
{'d', numFlag, argInt | argPointer},
{'e', sharpNumFlag, argFloat | argComplex},
@@ -723,7 +723,7 @@
{'F', sharpNumFlag, argFloat | argComplex},
{'g', sharpNumFlag, argFloat | argComplex},
{'G', sharpNumFlag, argFloat | argComplex},
- {'o', sharpNumFlag, argInt},
+ {'o', sharpNumFlag, argInt | argPointer},
{'p', "-#", argPointer},
{'q', " -+.0#", argRune | argInt | argString},
{'s', " -+.0", argString},
diff --git a/go/analysis/passes/printf/testdata/src/a/a.go b/go/analysis/passes/printf/testdata/src/a/a.go
index 970b512..417ca91 100644
--- a/go/analysis/passes/printf/testdata/src/a/a.go
+++ b/go/analysis/passes/printf/testdata/src/a/a.go
@@ -708,3 +708,70 @@
b.NoWrap("%s", 1)
b.Wrapf2("%s", 1) // want "Wrapf2 format %s has arg 1 of wrong type int"
}
+
+func PointerVerbs() {
+ // Use booleans, so that we don't just format the elements like in
+ // PointersToCompoundTypes. Bools can only be formatted with verbs like
+ // %t and %v, and none of the ones below.
+ ptr := new(bool)
+ slice := []bool{}
+ array := [3]bool{}
+ map_ := map[bool]bool{}
+ chan_ := make(chan bool)
+ func_ := func(bool) {}
+
+ // %p, %b, %d, %o, %x, and %X all support pointers.
+ fmt.Printf("%p", ptr)
+ fmt.Printf("%b", ptr)
+ fmt.Printf("%d", ptr)
+ fmt.Printf("%o", ptr)
+ fmt.Printf("%x", ptr)
+ fmt.Printf("%X", ptr)
+
+ // %p, %b, %d, %o, %x, and %X all support channels.
+ fmt.Printf("%p", chan_)
+ fmt.Printf("%b", chan_)
+ fmt.Printf("%d", chan_)
+ fmt.Printf("%o", chan_)
+ fmt.Printf("%x", chan_)
+ fmt.Printf("%X", chan_)
+
+ // %p is the only one that supports funcs.
+ fmt.Printf("%p", func_)
+ fmt.Printf("%b", func_) // want `Printf format %b arg func_ is a func value, not called`
+ fmt.Printf("%d", func_) // want `Printf format %d arg func_ is a func value, not called`
+ fmt.Printf("%o", func_) // want `Printf format %o arg func_ is a func value, not called`
+ fmt.Printf("%x", func_) // want `Printf format %x arg func_ is a func value, not called`
+ fmt.Printf("%X", func_) // want `Printf format %X arg func_ is a func value, not called`
+
+ // %p is the only one that supports all slices, by printing the address
+ // of the 0th element.
+ fmt.Printf("%p", slice) // supported; address of 0th element
+ fmt.Printf("%b", slice) // want `Printf format %b has arg slice of wrong type \[\]bool`
+
+ fmt.Printf("%d", slice) // want `Printf format %d has arg slice of wrong type \[\]bool`
+
+ fmt.Printf("%o", slice) // want `Printf format %o has arg slice of wrong type \[\]bool`
+
+ fmt.Printf("%x", slice) // want `Printf format %x has arg slice of wrong type \[\]bool`
+ fmt.Printf("%X", slice) // want `Printf format %X has arg slice of wrong type \[\]bool`
+
+ // None support arrays.
+ fmt.Printf("%p", array) // want `Printf format %p has arg array of wrong type \[3\]bool`
+ fmt.Printf("%b", array) // want `Printf format %b has arg array of wrong type \[3\]bool`
+ fmt.Printf("%d", array) // want `Printf format %d has arg array of wrong type \[3\]bool`
+ fmt.Printf("%o", array) // want `Printf format %o has arg array of wrong type \[3\]bool`
+ fmt.Printf("%x", array) // want `Printf format %x has arg array of wrong type \[3\]bool`
+ fmt.Printf("%X", array) // want `Printf format %X has arg array of wrong type \[3\]bool`
+
+ // %p is the only one that supports all maps.
+ fmt.Printf("%p", map_) // supported; address of 0th element
+ fmt.Printf("%b", map_) // want `Printf format %b has arg map_ of wrong type map\[bool\]bool`
+
+ fmt.Printf("%d", map_) // want `Printf format %d has arg map_ of wrong type map\[bool\]bool`
+
+ fmt.Printf("%o", map_) // want `Printf format %o has arg map_ of wrong type map\[bool\]bool`
+
+ fmt.Printf("%x", map_) // want `Printf format %x has arg map_ of wrong type map\[bool\]bool`
+ fmt.Printf("%X", map_) // want `Printf format %X has arg map_ of wrong type map\[bool\]bool`
+}
diff --git a/go/analysis/passes/printf/types.go b/go/analysis/passes/printf/types.go
index 0ebc810..e881046 100644
--- a/go/analysis/passes/printf/types.go
+++ b/go/analysis/passes/printf/types.go
@@ -56,11 +56,11 @@
switch typ := typ.(type) {
case *types.Signature:
- return t&argPointer != 0
+ return t == argPointer
case *types.Map:
- // Recur: map[int]int matches %d.
- return t&argPointer != 0 ||
+ return t == argPointer ||
+ // Recur: map[int]int matches %d.
(matchArgTypeInternal(pass, t, typ.Key(), arg, inProgress) && matchArgTypeInternal(pass, t, typ.Elem(), arg, inProgress))
case *types.Chan:
@@ -72,17 +72,20 @@
return true // %s matches []byte
}
// Recur: []int matches %d.
- return t&argPointer != 0 || matchArgTypeInternal(pass, t, typ.Elem(), arg, inProgress)
+ return matchArgTypeInternal(pass, t, typ.Elem(), arg, inProgress)
case *types.Slice:
// Same as array.
if types.Identical(typ.Elem().Underlying(), types.Typ[types.Byte]) && t&argString != 0 {
return true // %s matches []byte
}
+ if t == argPointer {
+ return true // %p prints a slice's 0th element
+ }
// Recur: []int matches %d. But watch out for
// type T []T
// If the element is a pointer type (type T[]*T), it's handled fine by the Pointer case below.
- return t&argPointer != 0 || matchArgTypeInternal(pass, t, typ.Elem(), arg, inProgress)
+ return matchArgTypeInternal(pass, t, typ.Elem(), arg, inProgress)
case *types.Pointer:
// Ugly, but dealing with an edge case: a known pointer to an invalid type,
