Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Currently, there isn't a reliable way to build #20

Draft
wants to merge 1 commit into
base: release-0.46
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions go/tools/builders/compilepkg.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"os/exec"
"path"
"path/filepath"
"slices"
"sort"
"strings"
)
Expand Down Expand Up @@ -343,6 +344,17 @@ func compileArchive(
cgoSrcs[i-len(goSrcs)] = coverSrc
}
}
if strings.Contains(outLinkObj, "external/") && slices.Contains(gcFlags, "-d=libfuzzer") {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rickystewart I couldn't find a cleaner way to determine whether we're compiling an external dependency, but this seems to work. Maybe you have a better idea?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably how I would do it.

// Remove -d=libfuzzer from gcFlags when compiling external packages. We don't really want to instrument them,
// and they may not link without libfuzzer_shim.go.
gcFlags = slices.DeleteFunc(gcFlags, func(s string) bool {
return s == "-d=libfuzzer"
})
}
// Log instrumented objs for ease of tracking/debugging.
if slices.Contains(gcFlags, "-d=libfuzzer") {
fmt.Printf("%s -- gcFlags=%s\n", outLinkObj, gcFlags)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want this checked in.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I'll remove; couldn't find a standard way of logging debug messages, which would get suppressed by default.

}

// If we have cgo, generate separate C and go files, and compile the
// C files.
Expand Down
7 changes: 7 additions & 0 deletions go/tools/builders/stdlib.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"path/filepath"
"regexp"
"strings"
"slices"
)

// stdlib builds the standard library in the appropriate mode into a new goroot.
Expand Down Expand Up @@ -154,6 +155,12 @@ You may need to use the flags --cpu=x64_windows --compiler=mingw-gcc.`)
break
}
}
// Remove -d=libfuzzer from gcflags when compiling stdlib. We only want our code to be instrumented.
// N.B. allowing this flag to pass may cause issues when linking external tools, e.g., protoc-bin, owing
// to unresolved symbols, i.e., libfuzzer_shim.go isn't included.
gcflags = slices.DeleteFunc(gcflags, func(s string) bool {
return s == "-d=libfuzzer"
})
installArgs = append(installArgs, "-gcflags="+allSlug+strings.Join(gcflags, " "))
installArgs = append(installArgs, "-ldflags="+allSlug+strings.Join(ldflags, " "))
installArgs = append(installArgs, "-asmflags="+allSlug+strings.Join(asmflags, " "))
Expand Down
41 changes: 41 additions & 0 deletions go/tools/bzltestutil/libfuzzer_shim.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Copyright 2021 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.

// N.B. This source is lifted verbatim from trace.go, added in
// https://github.com/golang/go/commit/74f49f3366826f95a464cc15838a0668c92e3357
//
// It's essentially a shim to allow linking a Go test binary without libfuzzer.
// We chose the 'bzltestutil' package because it's a bazel dependency for all Go test binaries.

//go:build !libfuzzer

package bzltestutil

import _ "unsafe" // for go:linkname

//go:linkname libfuzzerTraceCmp1 runtime.libfuzzerTraceCmp1
//go:linkname libfuzzerTraceCmp2 runtime.libfuzzerTraceCmp2
//go:linkname libfuzzerTraceCmp4 runtime.libfuzzerTraceCmp4
//go:linkname libfuzzerTraceCmp8 runtime.libfuzzerTraceCmp8

//go:linkname libfuzzerTraceConstCmp1 runtime.libfuzzerTraceConstCmp1
//go:linkname libfuzzerTraceConstCmp2 runtime.libfuzzerTraceConstCmp2
//go:linkname libfuzzerTraceConstCmp4 runtime.libfuzzerTraceConstCmp4
//go:linkname libfuzzerTraceConstCmp8 runtime.libfuzzerTraceConstCmp8

//go:linkname libfuzzerHookStrCmp runtime.libfuzzerHookStrCmp
//go:linkname libfuzzerHookEqualFold runtime.libfuzzerHookEqualFold

func libfuzzerTraceCmp1(arg0, arg1 uint8, fakePC int) {}
func libfuzzerTraceCmp2(arg0, arg1 uint16, fakePC int) {}
func libfuzzerTraceCmp4(arg0, arg1 uint32, fakePC int) {}
func libfuzzerTraceCmp8(arg0, arg1 uint64, fakePC int) {}

func libfuzzerTraceConstCmp1(arg0, arg1 uint8, fakePC int) {}
func libfuzzerTraceConstCmp2(arg0, arg1 uint16, fakePC int) {}
func libfuzzerTraceConstCmp4(arg0, arg1 uint32, fakePC int) {}
func libfuzzerTraceConstCmp8(arg0, arg1 uint64, fakePC int) {}

func libfuzzerHookStrCmp(arg0, arg1 string, fakePC int) {}
func libfuzzerHookEqualFold(arg0, arg1 string, fakePC int) {}