cmd/compile: go1.21rc2: relocation R_X86_64_PC32 out of range error due to inliner changes #61218
Comments
gopherbot
added
the
compiler/runtime
ianlancetaylor
changed the title
bcmills
added
the
NeedsInvestigation
|
Thanks for the report. The specific CL that your bisection points to does increase the amount of inlining, so it is not too surprising that the code generated by the Go compiler is getting bigger, especially if you make heavy use of closures. One thing that would be helpful here I think is if we had some understanding about just how much bigger your code is getting. If you could link your program with some special flags (as below) and then capture the size of the intermediates (both with the old Go version and with 1.21rc2, that would be great. Here is an example on how to gather the data (this uses a build of "himom.go", but hopefully you can do something along these lines for your program): The "go.o" file is the output from the Go linker, prior to the point where it gets passed to the external linker. |
thanm
added
the
WaitingForInfo
|
Hey @thanm, thank you for taking a look. I'm having a bit of trouble generating an archive or object file that's readable with the 'size' command. I first tried wrangling with our Bazel setup, but then moved on to a simpler go program and was still unsuccessful. I created a simple go program $ cd project/other However I tried searching the docs in the go toolchain and the the closest thing I found was that |
|
The size program will work on an executable built from a main package. It won't work on the object file created by compiling a non-main package. If you follow @thanm 's script above you will get an object file in a temporary directory that |
|
Thank you for the help! With go1.20.5 With go1.21rc3 A small note for anyone in the future who may encounter something similar with Bazel. I added the -tmpdir option to gc_linkopts attr of the go_binary rule. |
thanm
removed
the
WaitingForInfo
|
Thanks for that. Looks like your text size is up considerably, 15% or so,but more importantly you are working with a binary that it is already enormous and very close to being in the "danger zone" with respect to relocations (from text to data) not reaching. I would suggest that you try to attack the problem from the angle of reducing the size of your generated code overall. In particular, in your generated code where you have functions that contain closures or return closures, e.g. I would suggest changing your code generator to prefix these sorts of functions with "//go:noinline". This should (at least from what I can tell without being able to look at the complete source code) help restore the previous inliner behavior. Hope this helps. |
|
Thanks @thanm, Understood, we just wanted to report this issue in the case there was an increase in size out of the bounds the Go team was expecting. |
|
Circling back on this bug: we don't have any plans to revert CL 492017, hence I think it makes sense to try to approach this problem via changes to your generated code. Closing this bug out, please reopen if needed. Thanks. |
What version of Go are you using (
go version)?Does this issue reproduce with the latest release?
Builds successfully on go version go1.20.4 linux/amd64 and go1.19.x Fails on go1.21rc2
What operating system and processor architecture are you using (
go env)?go envOutputWhat did you do?
In testing our code against go1.21rc2 we found that a large go_binary target (we use Bazel) fails to build only on go1.21rc2. git bisect points to this commit as the cause. The build time for this target also regresses significantly before the build exits compared to go1.20.4. Investigation details are posted in the last section of this ticket.
What did you expect to see?
Build pass. Program successfully builds.
What did you see instead?
We're not able to post a reproducible program here since the code is internal but we have investigation notes that we hope the Go team will find helpful.
To narrow down what code patterns might cause issues in go1.21rc2, we searched for build artifacts that got significantly larger between go1.20 vs go1.21rc2 and found some.
The generated packages are enormous but are built with generated code that follows a particular pattern that we believe does not interact well with go1.21rc2
The generated code makes extensive use of generics and anonymous function closures. Internally, we were able to rewrite the code generator to drop the use of generics and anonymous function closures and build the application successfully with go1.21rc2.
Unfortunately, we can’t share the exact code of the application but we can share the output of the code generator on a toy input before and after changes that allow the application to build on go1.21rc2.
Current go1.21rc2 failing toy generator output// generated generic function to be called in HandleFoo func _cffFlowmagic_38_9[ t1 any, t2 any, t3 any, t4 any, t5 any, t6 any, t7 any, t8 any, ]( ctx context.Context, mmagic39_3 func() t1, mmagic40_3 func() *t2, mmagic41_3 func() int, mmagic42_3 func() cff.Emitter, mmagic43_3 func() cff.Emitter, mmagic44_3 func() string, mmagic46_3 func() func(t1) (t3, t4), mmagic54_3 func() (func(context.Context, t3) (t5, error), time.Duration), mmagic57_3 func() func(t6) (t7, error), mmagic58_3 func() func(t7) t2, mmagic67_3 func() (func(t4) (t8, error), func(t3) bool, t8, string), mmagic75_3 func() (func(t5, t8) t6, func(t3) bool, string), mmagic88_3 func() (func(t6) error, bool), ) (err error) { mmagic39_14 := mmagic39_3() _ = mmagic39_14 // possibly unused. mmagic40_15 := mmagic40_3() // leaving out the rest of the implementation … }// HandleFoo calls the generated generic function above with instantiated types.
func (h *fooHandler) HandleFoo(ctx context.Context, req *Request) (*Response, error) {
var res *ResponseV2
err := _cffFlowmagic_38_9(ctx,
_cffParamsmagic_39_3(req),
_cffResultsmagic_40_3(&res),
_cffConcurrencymagic_2515107422(8),
_cffWithEmittermagic_3224879298(cffemit.Metrics(h.scope)),
_cffWithEmittermagic_3224879298(cffemit.Logs(h.logger)),
_cffInstrumentFlowmagic_398550328("HandleFoo"),
_cffTaskmagic_13613616[func(req *RequestV2) (*GetManagerRequestV2, *ListUsersRequestV2)](
func(req *RequestV2) (*GetManagerRequestV2, *ListUsersRequestV2) {
return &GetManagerRequestV2{
LDAPGroup: req.LDAPGroup,
}, &ListUsersRequestV2{
LDAPGroup: req.LDAPGroup,
}
}),
// leaving out the rest HandleFoo ...
}
// the other _cff generated functions follow this form.
func _cffParamsmagic_39_3[t1 any](mmagic39_14 t1) func() t1 {
return func() t1 { return mmagic39_14 }
}
func _cffResultsmagic_40_3[t9 any](mmagic40_15 t9) func() t9 {
return func() t9 { return mmagic40_15 }
}
Updated go1.21rc2 passing toy generator output// This HandleFoo generated code is much simpler as it drops the use of generics and function closures to “pass through” values // in the scope of HandlerFoo to generated implementation functions defined at the bottom of the file. // For context, the more complicated code generation scheme was created to avoid shifting line positions between source code // and generated code to help with ends like Bazel-based code coverage and debugging in generated code. func (h *fooHandler) HandleFoo(ctx context.Context, req *Request) (*Response, error) { var res *Response err := func() (err error) { /*line magic.go:37:18*/ _37_18 := ctx /*line magic.go:38:14*/ _38_14 := req /*line magic.go:39:15*/ _39_15 := &res /*line magic.go:40:19*/ _40_19 := 8 /*line magic.go:41:19*/ _41_19 := cffemit.Metrics(h.scope) /*line magic.go:42:19*/ _42_19 := cffemit.Logs(h.logger) /*line magic.go:43:22*/ _43_22 := "HandleFoo" /*line magic.go:46:4*/ _46_4 := func(req *Request) (*GetManagerRequest, *ListUsersRequest) { return &GetManagerRequest{ LDAPGroup: req.LDAPGroup, }, &ListUsersRequest{ LDAPGroup: req.LDAPGroup, } } // leaving out the rest of the implementation … }For the notable packages in the application, the symbol table dump is larger in go1.21c2 than in go1.20.
Trying to understand what new symbols might be generated in go1.21rc2, we picked a specific function name (e.g. _cffFallbackWithcff_100088_4) and searched for all instances in the symbol table of the archive in go1.20 and go1.21rc2.
The text was updated successfully, but these errors were encountered: