1// Copyright 2017 Google Inc. All rights reserved. 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15package cc 16 17import ( 18 "fmt" 19 "path/filepath" 20 "strings" 21 22 "github.com/google/blueprint/proptools" 23 24 "android/soong/android" 25 "android/soong/cc/config" 26) 27 28var ( 29 // Add flags to ignore warnings that profiles are old or missing for 30 // some functions, and turn on the experimental new pass manager. 31 profileUseOtherFlags = []string{ 32 "-Wno-backend-plugin", 33 "-fexperimental-new-pass-manager", 34 } 35 36 globalPgoProfileProjects = []string{ 37 "toolchain/pgo-profiles", 38 "vendor/google_data/pgo-profiles", 39 } 40) 41 42var pgoProfileProjectsConfigKey = android.NewOnceKey("PgoProfileProjects") 43 44const profileInstrumentFlag = "-fprofile-generate=/data/local/tmp" 45const profileSamplingFlag = "-gline-tables-only" 46const profileUseInstrumentFormat = "-fprofile-use=%s" 47const profileUseSamplingFormat = "-fprofile-sample-use=%s" 48 49func getPgoProfileProjects(config android.DeviceConfig) []string { 50 return config.OnceStringSlice(pgoProfileProjectsConfigKey, func() []string { 51 return append(globalPgoProfileProjects, config.PgoAdditionalProfileDirs()...) 52 }) 53} 54 55func recordMissingProfileFile(ctx BaseModuleContext, missing string) { 56 getNamedMapForConfig(ctx.Config(), modulesMissingProfileFileKey).Store(missing, true) 57} 58 59type PgoProperties struct { 60 Pgo struct { 61 Instrumentation *bool 62 Sampling *bool 63 Profile_file *string `android:"arch_variant"` 64 Benchmarks []string 65 Enable_profile_use *bool `android:"arch_variant"` 66 // Additional compiler flags to use when building this module 67 // for profiling (either instrumentation or sampling). 68 Cflags []string `android:"arch_variant"` 69 } `android:"arch_variant"` 70 71 PgoPresent bool `blueprint:"mutated"` 72 ShouldProfileModule bool `blueprint:"mutated"` 73 PgoCompile bool `blueprint:"mutated"` 74} 75 76type pgo struct { 77 Properties PgoProperties 78} 79 80func (props *PgoProperties) isInstrumentation() bool { 81 return props.Pgo.Instrumentation != nil && *props.Pgo.Instrumentation == true 82} 83 84func (props *PgoProperties) isSampling() bool { 85 return props.Pgo.Sampling != nil && *props.Pgo.Sampling == true 86} 87 88func (pgo *pgo) props() []interface{} { 89 return []interface{}{&pgo.Properties} 90} 91 92func (props *PgoProperties) addProfileGatherFlags(ctx ModuleContext, flags Flags) Flags { 93 flags.CFlags = append(flags.CFlags, props.Pgo.Cflags...) 94 95 if props.isInstrumentation() { 96 flags.CFlags = append(flags.CFlags, profileInstrumentFlag) 97 // The profile runtime is added below in deps(). Add the below 98 // flag, which is the only other link-time action performed by 99 // the Clang driver during link. 100 flags.LdFlags = append(flags.LdFlags, "-u__llvm_profile_runtime") 101 } 102 if props.isSampling() { 103 flags.CFlags = append(flags.CFlags, profileSamplingFlag) 104 flags.LdFlags = append(flags.LdFlags, profileSamplingFlag) 105 } 106 return flags 107} 108 109func (props *PgoProperties) getPgoProfileFile(ctx BaseModuleContext) android.OptionalPath { 110 profile_file := *props.Pgo.Profile_file 111 112 // Test if the profile_file is present in any of the PGO profile projects 113 for _, profileProject := range getPgoProfileProjects(ctx.DeviceConfig()) { 114 // Bug: http://b/74395273 If the profile_file is unavailable, 115 // use a versioned file named 116 // <profile_file>.<arbitrary-version> when available. This 117 // works around an issue where ccache serves stale cache 118 // entries when the profile file has changed. 119 globPattern := filepath.Join(profileProject, profile_file+".*") 120 versioned_profiles, err := ctx.GlobWithDeps(globPattern, nil) 121 if err != nil { 122 ctx.ModuleErrorf("glob: %s", err.Error()) 123 } 124 125 path := android.ExistentPathForSource(ctx, profileProject, profile_file) 126 if path.Valid() { 127 if len(versioned_profiles) != 0 { 128 ctx.PropertyErrorf("pgo.profile_file", "Profile_file has multiple versions: "+filepath.Join(profileProject, profile_file)+", "+strings.Join(versioned_profiles, ", ")) 129 } 130 return path 131 } 132 133 if len(versioned_profiles) > 1 { 134 ctx.PropertyErrorf("pgo.profile_file", "Profile_file has multiple versions: "+strings.Join(versioned_profiles, ", ")) 135 } else if len(versioned_profiles) == 1 { 136 return android.OptionalPathForPath(android.PathForSource(ctx, versioned_profiles[0])) 137 } 138 } 139 140 // Record that this module's profile file is absent 141 missing := *props.Pgo.Profile_file + ":" + ctx.ModuleDir() + "/Android.bp:" + ctx.ModuleName() 142 recordMissingProfileFile(ctx, missing) 143 144 return android.OptionalPathForPath(nil) 145} 146 147func (props *PgoProperties) profileUseFlag(ctx ModuleContext, file string) string { 148 if props.isInstrumentation() { 149 return fmt.Sprintf(profileUseInstrumentFormat, file) 150 } 151 if props.isSampling() { 152 return fmt.Sprintf(profileUseSamplingFormat, file) 153 } 154 return "" 155} 156 157func (props *PgoProperties) profileUseFlags(ctx ModuleContext, file string) []string { 158 flags := []string{props.profileUseFlag(ctx, file)} 159 flags = append(flags, profileUseOtherFlags...) 160 return flags 161} 162 163func (props *PgoProperties) addProfileUseFlags(ctx ModuleContext, flags Flags) Flags { 164 // Return if 'pgo' property is not present in this module. 165 if !props.PgoPresent { 166 return flags 167 } 168 169 if props.PgoCompile { 170 profileFile := props.getPgoProfileFile(ctx) 171 profileFilePath := profileFile.Path() 172 profileUseFlags := props.profileUseFlags(ctx, profileFilePath.String()) 173 174 flags.CFlags = append(flags.CFlags, profileUseFlags...) 175 flags.LdFlags = append(flags.LdFlags, profileUseFlags...) 176 177 // Update CFlagsDeps and LdFlagsDeps so the module is rebuilt 178 // if profileFile gets updated 179 flags.CFlagsDeps = append(flags.CFlagsDeps, profileFilePath) 180 flags.LdFlagsDeps = append(flags.LdFlagsDeps, profileFilePath) 181 } 182 return flags 183} 184 185func (props *PgoProperties) isPGO(ctx BaseModuleContext) bool { 186 isInstrumentation := props.isInstrumentation() 187 isSampling := props.isSampling() 188 189 profileKindPresent := isInstrumentation || isSampling 190 filePresent := props.Pgo.Profile_file != nil 191 benchmarksPresent := len(props.Pgo.Benchmarks) > 0 192 193 // If all three properties are absent, PGO is OFF for this module 194 if !profileKindPresent && !filePresent && !benchmarksPresent { 195 return false 196 } 197 198 // If at least one property exists, validate that all properties exist 199 if !profileKindPresent || !filePresent || !benchmarksPresent { 200 var missing []string 201 if !profileKindPresent { 202 missing = append(missing, "profile kind (either \"instrumentation\" or \"sampling\" property)") 203 } 204 if !filePresent { 205 missing = append(missing, "profile_file property") 206 } 207 if !benchmarksPresent { 208 missing = append(missing, "non-empty benchmarks property") 209 } 210 missingProps := strings.Join(missing, ", ") 211 ctx.ModuleErrorf("PGO specification is missing properties: " + missingProps) 212 } 213 214 // Sampling not supported yet 215 if isSampling { 216 ctx.PropertyErrorf("pgo.sampling", "\"sampling\" is not supported yet)") 217 } 218 219 if isSampling && isInstrumentation { 220 ctx.PropertyErrorf("pgo", "Exactly one of \"instrumentation\" and \"sampling\" properties must be set") 221 } 222 223 return true 224} 225 226func (pgo *pgo) begin(ctx BaseModuleContext) { 227 // TODO Evaluate if we need to support PGO for host modules 228 if ctx.Host() { 229 return 230 } 231 232 // Check if PGO is needed for this module 233 pgo.Properties.PgoPresent = pgo.Properties.isPGO(ctx) 234 235 if !pgo.Properties.PgoPresent { 236 return 237 } 238 239 // This module should be instrumented if ANDROID_PGO_INSTRUMENT is set 240 // and includes 'all', 'ALL' or a benchmark listed for this module. 241 // 242 // TODO Validate that each benchmark instruments at least one module 243 pgo.Properties.ShouldProfileModule = false 244 pgoBenchmarks := ctx.Config().Getenv("ANDROID_PGO_INSTRUMENT") 245 pgoBenchmarksMap := make(map[string]bool) 246 for _, b := range strings.Split(pgoBenchmarks, ",") { 247 pgoBenchmarksMap[b] = true 248 } 249 250 if pgoBenchmarksMap["all"] == true || pgoBenchmarksMap["ALL"] == true { 251 pgo.Properties.ShouldProfileModule = true 252 } else { 253 for _, b := range pgo.Properties.Pgo.Benchmarks { 254 if pgoBenchmarksMap[b] == true { 255 pgo.Properties.ShouldProfileModule = true 256 break 257 } 258 } 259 } 260 261 if !ctx.Config().IsEnvTrue("ANDROID_PGO_NO_PROFILE_USE") && 262 proptools.BoolDefault(pgo.Properties.Pgo.Enable_profile_use, true) { 263 if profileFile := pgo.Properties.getPgoProfileFile(ctx); profileFile.Valid() { 264 pgo.Properties.PgoCompile = true 265 } 266 } 267} 268 269func (pgo *pgo) deps(ctx BaseModuleContext, deps Deps) Deps { 270 if pgo.Properties.ShouldProfileModule { 271 runtimeLibrary := config.ProfileRuntimeLibrary(ctx.toolchain()) 272 deps.LateStaticLibs = append(deps.LateStaticLibs, runtimeLibrary) 273 } 274 return deps 275} 276 277func (pgo *pgo) flags(ctx ModuleContext, flags Flags) Flags { 278 if ctx.Host() { 279 return flags 280 } 281 282 props := pgo.Properties 283 284 // Add flags to profile this module based on its profile_kind 285 if props.ShouldProfileModule { 286 return props.addProfileGatherFlags(ctx, flags) 287 } 288 289 if !ctx.Config().IsEnvTrue("ANDROID_PGO_NO_PROFILE_USE") { 290 return props.addProfileUseFlags(ctx, flags) 291 } 292 293 return flags 294} 295