cmd/compile: possible oversight with internal/gc.disableExport

[odeke-em]

I was just studying closure.go and noticed that we invoke disableExport(sym) for closures created.
The signature for disableExport says

go/src/cmd/compile/internal/gc/dcl.go

Lines 1005 to 1006 in 0ec302c

	// disableExport prevents sym from being included in package export
	// data. To be effectual, it must be called before declare.

However, in the body of disableExport we see that we invoke sym.SetOnExportList(true)
which toggles the symbol to be exported as per

go/src/cmd/compile/internal/types/sym.go

Line 55 in 0ec302c

func (sym *Sym) SetOnExportList(b bool) { sym.flags.set(symOnExportList, b) }

This change is from CL 108216

I believe it should be sym.SetOnExportList(false)
The bug only doesn't show because when creating object files we explicitly check that names are exported as per

go/src/cmd/compile/internal/gc/export.go

Lines 56 to 58 in 0ec302c

	if types.IsExported(n.Sym.Name) || initname(n.Sym.Name) {
	exportsym(n)
	}

otherwise if you add debugs you'll see that we encounter closure symbols such as "".bar.func1

Kindly paging @mdempsky @griesemer

[mdempsky]

Thanks @odeke-em , but I believe it's correct as-is. The OnExportList flag is used by exportsym to avoid adding a symbol to exportlist if it's already been added:

go/src/cmd/compile/internal/gc/export.go

Lines 27 to 32 in 0ec302c

	// exportsym marks n for export (or reexport).
	func exportsym(n *Node) {
	if n.Sym.OnExportList() {
	return
	}
	n.Sym.SetOnExportList(true)

The way disableExport works is that it sets OnExportList before exportsym is called, so that exportsym thinks the symbol has already been added to exportlist and avoids adding it again.

[odeke-em]

Thanks for the reply @mdempsky!
Yes, I saw that before but I now understand the purpose of it and context of usage after your reply, thanks!

Perhaps let's rename that helper function to hideFromExportSym instead of disableExporting? disableExporting to me seems like we are requesting that regardless of its case, prevent it from being exported.

Perhaps let's think of a different marking naming, because (*types.Sym).OnExportList for closures within functions (especially those that have names such as "".bar.func1) is a little confusing, just from reading through the source code.

[josharian]

@odeke-em feel free to leave renaming suggestions over at #27167

[odeke-em]

Cool, thanks @josharian I've made the suggestion at #27167 (comment)

and with that I'll close this issue. Thank you @mdempsky for the response too.