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