exp.go

     1  // Copyright 2021 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package buildcfg
     6  
     7  import (
     8  	"fmt"
     9  	"reflect"
    10  	"strings"
    11  
    12  	"internal/goexperiment"
    13  )
    14  
    15  // ExperimentFlags represents a set of GOEXPERIMENT flags relative to a baseline
    16  // (platform-default) experiment configuration.
    17  type ExperimentFlags struct {
    18  	goexperiment.Flags
    19  	baseline goexperiment.Flags
    20  }
    21  
    22  // Experiment contains the toolchain experiments enabled for the
    23  // current build.
    24  //
    25  // (This is not necessarily the set of experiments the compiler itself
    26  // was built with.)
    27  //
    28  // Experiment.baseline specifies the experiment flags that are enabled by
    29  // default in the current toolchain. This is, in effect, the "control"
    30  // configuration and any variation from this is an experiment.
    31  var Experiment ExperimentFlags = func() ExperimentFlags {
    32  	flags, err := ParseGOEXPERIMENT(GOOS, GOARCH, envOr("GOEXPERIMENT", defaultGOEXPERIMENT))
    33  	if err != nil {
    34  		Error = err
    35  		return ExperimentFlags{}
    36  	}
    37  	return *flags
    38  }()
    39  
    40  // DefaultGOEXPERIMENT is the embedded default GOEXPERIMENT string.
    41  // It is not guaranteed to be canonical.
    42  const DefaultGOEXPERIMENT = defaultGOEXPERIMENT
    43  
    44  // FramePointerEnabled enables the use of platform conventions for
    45  // saving frame pointers.
    46  //
    47  // This used to be an experiment, but now it's always enabled on
    48  // platforms that support it.
    49  //
    50  // Note: must agree with runtime.framepointer_enabled.
    51  var FramePointerEnabled = GOARCH == "amd64" || GOARCH == "arm64"
    52  
    53  // ParseGOEXPERIMENT parses a (GOOS, GOARCH, GOEXPERIMENT)
    54  // configuration tuple and returns the enabled and baseline experiment
    55  // flag sets.
    56  //
    57  // TODO(mdempsky): Move to [internal/goexperiment].
    58  func ParseGOEXPERIMENT(goos, goarch, goexp string) (*ExperimentFlags, error) {
    59  	// regabiSupported is set to true on platforms where register ABI is
    60  	// supported and enabled by default.
    61  	// regabiAlwaysOn is set to true on platforms where register ABI is
    62  	// always on.
    63  	var regabiSupported, regabiAlwaysOn bool
    64  	switch goarch {
    65  	case "amd64", "arm64", "loong64", "ppc64le", "ppc64", "riscv64":
    66  		regabiAlwaysOn = true
    67  		regabiSupported = true
    68  	}
    69  
    70  	// Older versions (anything before V16) of dsymutil don't handle
    71  	// the .debug_rnglists section in DWARF5. See
    72  	// https://github.com/golang/go/issues/26379#issuecomment-2677068742
    73  	// for more context. This disables all DWARF5 on mac, which is not
    74  	// ideal (would be better to disable just for cases where we know
    75  	// the build will use external linking). In the GOOS=aix case, the
    76  	// XCOFF format (as far as can be determined) doesn't seem to
    77  	// support the necessary section subtypes for DWARF-specific
    78  	// things like .debug_addr (needed for DWARF 5).
    79  	dwarf5Supported := (goos != "darwin" && goos != "ios" && goos != "aix")
    80  
    81  	baseline := goexperiment.Flags{
    82  		RegabiWrappers:        regabiSupported,
    83  		RegabiArgs:            regabiSupported,
    84  		Dwarf5:                dwarf5Supported,
    85  		RandomizedHeapBase64:  true,
    86  		RuntimeFree:           true,
    87  		SizeSpecializedMalloc: true,
    88  		GreenTeaGC:            true,
    89  	}
    90  
    91  	// Start with the statically enabled set of experiments.
    92  	flags := &ExperimentFlags{
    93  		Flags:    baseline,
    94  		baseline: baseline,
    95  	}
    96  
    97  	// Pick up any changes to the baseline configuration from the
    98  	// GOEXPERIMENT environment. This can be set at make.bash time
    99  	// and overridden at build time.
   100  	if goexp != "" {
   101  		// Create a map of known experiment names.
   102  		names := make(map[string]func(bool))
   103  		rv := reflect.ValueOf(&flags.Flags).Elem()
   104  		rt := rv.Type()
   105  		for i := 0; i < rt.NumField(); i++ {
   106  			field := rv.Field(i)
   107  			names[strings.ToLower(rt.Field(i).Name)] = field.SetBool
   108  		}
   109  
   110  		// "regabi" is an alias for all working regabi
   111  		// subexperiments, and not an experiment itself. Doing
   112  		// this as an alias make both "regabi" and "noregabi"
   113  		// do the right thing.
   114  		names["regabi"] = func(v bool) {
   115  			flags.RegabiWrappers = v
   116  			flags.RegabiArgs = v
   117  		}
   118  
   119  		// Parse names.
   120  		for f := range strings.SplitSeq(goexp, ",") {
   121  			if f == "" {
   122  				continue
   123  			}
   124  			if f == "none" {
   125  				// GOEXPERIMENT=none disables all experiment flags.
   126  				// This is used by cmd/dist, which doesn't know how
   127  				// to build with any experiment flags.
   128  				flags.Flags = goexperiment.Flags{}
   129  				continue
   130  			}
   131  			val := true
   132  			if strings.HasPrefix(f, "no") {
   133  				f, val = f[2:], false
   134  			}
   135  			set, ok := names[f]
   136  			if !ok {
   137  				return nil, fmt.Errorf("unknown GOEXPERIMENT %s", f)
   138  			}
   139  			set(val)
   140  		}
   141  	}
   142  
   143  	if regabiAlwaysOn {
   144  		flags.RegabiWrappers = true
   145  		flags.RegabiArgs = true
   146  	}
   147  	// regabi is only supported on amd64, arm64, loong64, riscv64, ppc64 and ppc64le.
   148  	if !regabiSupported {
   149  		flags.RegabiWrappers = false
   150  		flags.RegabiArgs = false
   151  	}
   152  	// Check regabi dependencies.
   153  	if flags.RegabiArgs && !flags.RegabiWrappers {
   154  		return nil, fmt.Errorf("GOEXPERIMENT regabiargs requires regabiwrappers")
   155  	}
   156  	return flags, nil
   157  }
   158  
   159  // String returns the canonical GOEXPERIMENT string to enable this experiment
   160  // configuration. (Experiments in the same state as in the baseline are elided.)
   161  func (exp *ExperimentFlags) String() string {
   162  	return strings.Join(expList(&exp.Flags, &exp.baseline, false), ",")
   163  }
   164  
   165  // expList returns the list of lower-cased experiment names for
   166  // experiments that differ from base. base may be nil to indicate no
   167  // experiments. If all is true, then include all experiment flags,
   168  // regardless of base.
   169  func expList(exp, base *goexperiment.Flags, all bool) []string {
   170  	var list []string
   171  	rv := reflect.ValueOf(exp).Elem()
   172  	var rBase reflect.Value
   173  	if base != nil {
   174  		rBase = reflect.ValueOf(base).Elem()
   175  	}
   176  	rt := rv.Type()
   177  	for i := 0; i < rt.NumField(); i++ {
   178  		name := strings.ToLower(rt.Field(i).Name)
   179  		val := rv.Field(i).Bool()
   180  		baseVal := false
   181  		if base != nil {
   182  			baseVal = rBase.Field(i).Bool()
   183  		}
   184  		if all || val != baseVal {
   185  			if val {
   186  				list = append(list, name)
   187  			} else {
   188  				list = append(list, "no"+name)
   189  			}
   190  		}
   191  	}
   192  	return list
   193  }
   194  
   195  // Enabled returns a list of enabled experiments, as
   196  // lower-cased experiment names.
   197  func (exp *ExperimentFlags) Enabled() []string {
   198  	return expList(&exp.Flags, nil, false)
   199  }
   200  
   201  // All returns a list of all experiment settings.
   202  // Disabled experiments appear in the list prefixed by "no".
   203  func (exp *ExperimentFlags) All() []string {
   204  	return expList(&exp.Flags, nil, true)
   205  }
   206
View as plain text