1// Copyright 2016 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 17// This file contains utility functions to check for bad or illegal cflags 18// specified by a module 19 20import ( 21 "path/filepath" 22 "strings" 23 24 "android/soong/cc/config" 25) 26 27// Check for invalid c/conly/cpp/asflags and suggest alternatives. Only use this 28// for flags explicitly passed by the user, since these flags may be used internally. 29func CheckBadCompilerFlags(ctx BaseModuleContext, prop string, flags []string) { 30 for _, flag := range flags { 31 flag = strings.TrimSpace(flag) 32 33 if !strings.HasPrefix(flag, "-") { 34 ctx.PropertyErrorf(prop, "Flag `%s` must start with `-`", flag) 35 } else if strings.HasPrefix(flag, "-I") || strings.HasPrefix(flag, "-isystem") { 36 ctx.PropertyErrorf(prop, "Bad flag `%s`, use local_include_dirs or include_dirs instead", flag) 37 } else if inList(flag, config.IllegalFlags) { 38 ctx.PropertyErrorf(prop, "Illegal flag `%s`", flag) 39 } else if flag == "--coverage" { 40 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use native_coverage instead", flag) 41 } else if flag == "-fwhole-program-vtables" { 42 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use whole_program_vtables instead", flag) 43 } else if flag == "-Weverything" { 44 if !ctx.Config().IsEnvTrue("ANDROID_TEMPORARILY_ALLOW_WEVERYTHING") { 45 ctx.PropertyErrorf(prop, "-Weverything is not allowed in Android.bp files. "+ 46 "Build with `m ANDROID_TEMPORARILY_ALLOW_WEVERYTHING=true` to experiment locally with -Weverything.") 47 } 48 } else if strings.Contains(flag, " ") { 49 args := strings.Split(flag, " ") 50 if args[0] == "-include" { 51 if len(args) > 2 { 52 ctx.PropertyErrorf(prop, "`-include` only takes one argument: `%s`", flag) 53 } 54 path := filepath.Clean(args[1]) 55 if strings.HasPrefix("/", path) { 56 ctx.PropertyErrorf(prop, "Path must not be an absolute path: %s", flag) 57 } else if strings.HasPrefix("../", path) { 58 ctx.PropertyErrorf(prop, "Path must not start with `../`: `%s`. Use include_dirs to -include from a different directory", flag) 59 } 60 } else if args[0] == "-mllvm" { 61 if len(args) > 2 { 62 ctx.PropertyErrorf(prop, "`-mllvm` only takes one argument: `%s`", flag) 63 } 64 } else if strings.HasPrefix(flag, "-D") && strings.Contains(flag, "=") { 65 // Do nothing in this case. 66 // For now, we allow space characters in -DNAME=def form to allow use cases 67 // like -DNAME="value with string". Later, this check should be done more 68 // correctly to prevent multi flag cases like -DNAME=value -O2. 69 } else { 70 ctx.PropertyErrorf(prop, "Bad flag: `%s` is not an allowed multi-word flag. Should it be split into multiple flags?", flag) 71 } 72 } 73 } 74} 75 76// Check for bad ldflags and suggest alternatives. Only use this for flags 77// explicitly passed by the user, since these flags may be used internally. 78func CheckBadLinkerFlags(ctx BaseModuleContext, prop string, flags []string) { 79 for _, flag := range flags { 80 flag = strings.TrimSpace(flag) 81 82 if !strings.HasPrefix(flag, "-") { 83 ctx.PropertyErrorf(prop, "Flag `%s` must start with `-`", flag) 84 } else if strings.HasPrefix(flag, "-l") { 85 if ctx.Host() { 86 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use shared_libs or host_ldlibs instead", flag) 87 } else { 88 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use shared_libs instead", flag) 89 } 90 } else if strings.HasPrefix(flag, "-L") { 91 ctx.PropertyErrorf(prop, "Bad flag: `%s` is not allowed", flag) 92 } else if strings.HasPrefix(flag, "-Wl,--version-script") { 93 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use version_script instead", flag) 94 } else if flag == "-T" || strings.HasPrefix(flag, "--script") { 95 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use linker_scripts instead", flag) 96 } else if flag == "--coverage" { 97 ctx.PropertyErrorf(prop, "Bad flag: `%s`, use native_coverage instead", flag) 98 } else if strings.Contains(flag, " ") { 99 args := strings.Split(flag, " ") 100 if args[0] == "-z" { 101 if len(args) > 2 { 102 ctx.PropertyErrorf(prop, "`-z` only takes one argument: `%s`", flag) 103 } 104 } else { 105 ctx.PropertyErrorf(prop, "Bad flag: `%s` is not an allowed multi-word flag. Should it be split into multiple flags?", flag) 106 } 107 } 108 } 109} 110 111// Check for bad host_ldlibs 112func CheckBadHostLdlibs(ctx ModuleContext, prop string, flags []string) { 113 allowedLdlibs := ctx.toolchain().AvailableLibraries() 114 115 if !ctx.Host() { 116 panic("Invalid call to CheckBadHostLdlibs") 117 } 118 119 for _, flag := range flags { 120 flag = strings.TrimSpace(flag) 121 122 // TODO: Probably should just redo this property to prefix -l in Soong 123 if !strings.HasPrefix(flag, "-l") && !strings.HasPrefix(flag, "-framework") { 124 ctx.PropertyErrorf(prop, "Invalid flag: `%s`, must start with `-l` or `-framework`", flag) 125 } else if !inList(flag, allowedLdlibs) { 126 ctx.PropertyErrorf(prop, "Host library `%s` not available", flag) 127 } 128 } 129} 130 131// Check for bad clang tidy flags 132func CheckBadTidyFlags(ctx ModuleContext, prop string, flags []string) { 133 for _, flag := range flags { 134 flag = strings.TrimSpace(flag) 135 136 if !strings.HasPrefix(flag, "-") { 137 ctx.PropertyErrorf(prop, "Flag `%s` must start with `-`", flag) 138 } else if strings.HasPrefix(flag, "-fix") { 139 ctx.PropertyErrorf(prop, "Flag `%s` is not allowed, since it could cause multiple writes to the same source file", flag) 140 } else if strings.HasPrefix(flag, "-checks=") { 141 ctx.PropertyErrorf(prop, "Flag `%s` is not allowed, use `tidy_checks` property instead", flag) 142 } else if strings.Contains(flag, " ") { 143 ctx.PropertyErrorf(prop, "Bad flag: `%s` is not an allowed multi-word flag. Should it be split into multiple flags?", flag) 144 } 145 } 146} 147 148// Check for bad clang tidy checks 149func CheckBadTidyChecks(ctx ModuleContext, prop string, checks []string) { 150 for _, check := range checks { 151 if strings.Contains(check, " ") { 152 ctx.PropertyErrorf("tidy_checks", "Check `%s` invalid, cannot contain spaces", check) 153 } else if strings.Contains(check, ",") { 154 ctx.PropertyErrorf("tidy_checks", "Check `%s` invalid, cannot contain commas. Split each entry into it's own string instead", check) 155 } 156 } 157} 158