blob: a3049ababe3213b8356017542f97d1ffecb01c13 [file] [log] [blame]
Yifan Hong4d18bcc2017-04-07 21:47:16 +00001/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <stdlib.h>
18#include <unistd.h>
19
20#include <fstream>
21#include <iostream>
Yifan Hong4d18bcc2017-04-07 21:47:16 +000022#include <sstream>
23#include <string>
Yifan Hong8302cea2017-12-18 20:17:05 -080024#include <unordered_map>
Yifan Hong4d18bcc2017-04-07 21:47:16 +000025
Yifan Hong9a8b1a72017-08-25 17:55:33 -070026#include <android-base/file.h>
Yifan Hongdbe9db32017-12-11 19:06:11 -080027#include <android-base/parseint.h>
Yifan Hongb83e56b2018-01-09 14:36:30 -080028#include <android-base/strings.h>
Yifan Hong9a8b1a72017-08-25 17:55:33 -070029
Yifan Hong8302cea2017-12-18 20:17:05 -080030#include <vintf/AssembleVintf.h>
Yifan Hong79efa8a2017-07-06 14:10:28 -070031#include <vintf/KernelConfigParser.h>
Yifan Hong4d18bcc2017-04-07 21:47:16 +000032#include <vintf/parse_string.h>
33#include <vintf/parse_xml.h>
Yifan Hong8302cea2017-12-18 20:17:05 -080034#include "utils.h"
Yifan Hong4d18bcc2017-04-07 21:47:16 +000035
Yifan Hong79efa8a2017-07-06 14:10:28 -070036#define BUFFER_SIZE sysconf(_SC_PAGESIZE)
37
Yifan Hong4d18bcc2017-04-07 21:47:16 +000038namespace android {
39namespace vintf {
40
Yifan Hong9a8b1a72017-08-25 17:55:33 -070041static const std::string gConfigPrefix = "android-base-";
42static const std::string gConfigSuffix = ".cfg";
43static const std::string gBaseConfig = "android-base.cfg";
44
Yifan Hongaa219f52017-12-18 18:51:59 -080045// An input stream with a name.
46// The input stream may be an actual file, or a stringstream for testing.
47// It takes ownership on the istream.
48class NamedIstream {
49 public:
50 NamedIstream(const std::string& name, std::unique_ptr<std::istream>&& stream)
51 : mName(name), mStream(std::move(stream)) {}
52 const std::string& name() const { return mName; }
53 std::istream& stream() { return *mStream; }
54
55 private:
56 std::string mName;
57 std::unique_ptr<std::istream> mStream;
58};
59
Yifan Hong4d18bcc2017-04-07 21:47:16 +000060/**
61 * Slurps the device manifest file and add build time flag to it.
62 */
Yifan Hong8302cea2017-12-18 20:17:05 -080063class AssembleVintfImpl : public AssembleVintf {
Yifan Hong9a8b1a72017-08-25 17:55:33 -070064 using Condition = std::unique_ptr<KernelConfig>;
65 using ConditionedConfig = std::pair<Condition, std::vector<KernelConfig> /* configs */>;
66
67 public:
Yifan Hong8302cea2017-12-18 20:17:05 -080068 void setFakeEnv(const std::string& key, const std::string& value) { mFakeEnv[key] = value; }
69
70 std::string getEnv(const std::string& key) const {
71 auto it = mFakeEnv.find(key);
72 if (it != mFakeEnv.end()) {
73 return it->second;
74 }
75 const char* envValue = getenv(key.c_str());
76 return envValue != nullptr ? std::string(envValue) : std::string();
77 }
78
Yifan Honga28729e2018-01-17 13:40:35 -080079 // Get environment variable and split with space.
80 std::vector<std::string> getEnvList(const std::string& key) const {
81 std::vector<std::string> ret;
82 for (auto&& v : base::Split(getEnv(key), " ")) {
83 v = base::Trim(v);
84 if (!v.empty()) {
85 ret.push_back(v);
86 }
87 }
88 return ret;
89 }
90
Yifan Hong8302cea2017-12-18 20:17:05 -080091 template <typename T>
92 bool getFlag(const std::string& key, T* value) const {
93 std::string envValue = getEnv(key);
94 if (envValue.empty()) {
95 std::cerr << "Warning: " << key << " is missing, defaulted to " << (*value) << "."
Yifan Hong488e16a2017-07-11 13:50:41 -070096 << std::endl;
97 return true;
Yifan Hong4d18bcc2017-04-07 21:47:16 +000098 }
99
100 if (!parse(envValue, value)) {
101 std::cerr << "Cannot parse " << envValue << "." << std::endl;
102 return false;
103 }
104 return true;
105 }
106
Yifan Hongeff04662017-12-18 16:27:24 -0800107 /**
Yifan Hong0f7f7282018-02-02 13:05:43 -0800108 * Set *out to environment variable only if *out is a dummy value (i.e. default constructed).
109 * Return true if *out is set to environment variable, otherwise false.
Yifan Hongeff04662017-12-18 16:27:24 -0800110 */
111 template <typename T>
Yifan Hongf7e8b1b2018-01-23 15:30:35 -0800112 bool getFlagIfUnset(const std::string& envKey, T* out, bool log = true) const {
Yifan Hongeff04662017-12-18 16:27:24 -0800113 bool hasExistingValue = !(*out == T{});
114
115 bool hasEnvValue = false;
116 T envValue;
Yifan Hong8302cea2017-12-18 20:17:05 -0800117 std::string envStrValue = getEnv(envKey);
118 if (!envStrValue.empty()) {
119 if (!parse(envStrValue, &envValue)) {
Yifan Hongf7e8b1b2018-01-23 15:30:35 -0800120 if (log) {
121 std::cerr << "Cannot parse " << envValue << "." << std::endl;
122 }
Yifan Hongeff04662017-12-18 16:27:24 -0800123 return false;
124 }
125 hasEnvValue = true;
126 }
127
128 if (hasExistingValue) {
Yifan Hongf7e8b1b2018-01-23 15:30:35 -0800129 if (hasEnvValue && log) {
Yifan Hongeff04662017-12-18 16:27:24 -0800130 std::cerr << "Warning: cannot override existing value " << *out << " with "
131 << envKey << " (which is " << envValue << ")." << std::endl;
132 }
133 return false;
134 }
135 if (!hasEnvValue) {
Yifan Hongf7e8b1b2018-01-23 15:30:35 -0800136 if (log) {
137 std::cerr << "Warning: " << envKey << " is not specified. Default to " << T{} << "."
138 << std::endl;
139 }
Yifan Hongeff04662017-12-18 16:27:24 -0800140 return false;
141 }
142 *out = envValue;
143 return true;
144 }
145
Yifan Hong8302cea2017-12-18 20:17:05 -0800146 bool getBooleanFlag(const std::string& key) const { return getEnv(key) == std::string("true"); }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800147
Yifan Hong8302cea2017-12-18 20:17:05 -0800148 size_t getIntegerFlag(const std::string& key, size_t defaultValue = 0) const {
149 std::string envValue = getEnv(key);
Yifan Hongdbe9db32017-12-11 19:06:11 -0800150 if (envValue.empty()) {
151 return defaultValue;
152 }
153 size_t value;
154 if (!base::ParseUint(envValue, &value)) {
155 std::cerr << "Error: " << key << " must be a number." << std::endl;
156 return defaultValue;
157 }
158 return value;
159 }
160
Yifan Hong4650ad82017-05-01 17:28:02 -0700161 static std::string read(std::basic_istream<char>& is) {
162 std::stringstream ss;
163 ss << is.rdbuf();
164 return ss.str();
165 }
166
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700167 static bool isCommonConfig(const std::string& path) {
168 return ::android::base::Basename(path) == gBaseConfig;
169 }
170
Yifan Hong079ec242017-08-25 18:53:38 -0700171 // nullptr on any error, otherwise the condition.
172 static Condition generateCondition(const std::string& path) {
173 std::string fname = ::android::base::Basename(path);
174 if (fname.size() <= gConfigPrefix.size() + gConfigSuffix.size() ||
175 !std::equal(gConfigPrefix.begin(), gConfigPrefix.end(), fname.begin()) ||
176 !std::equal(gConfigSuffix.rbegin(), gConfigSuffix.rend(), fname.rbegin())) {
177 return nullptr;
178 }
179
180 std::string sub = fname.substr(gConfigPrefix.size(),
181 fname.size() - gConfigPrefix.size() - gConfigSuffix.size());
182 if (sub.empty()) {
183 return nullptr; // should not happen
184 }
185 for (size_t i = 0; i < sub.size(); ++i) {
186 if (sub[i] == '-') {
187 sub[i] = '_';
188 continue;
189 }
190 if (isalnum(sub[i])) {
191 sub[i] = toupper(sub[i]);
192 continue;
193 }
194 std::cerr << "'" << fname << "' (in " << path
195 << ") is not a valid kernel config file name. Must match regex: "
196 << "android-base(-[0-9a-zA-Z-]+)?\\.cfg" << std::endl;
197 return nullptr;
198 }
199 sub.insert(0, "CONFIG_");
200 return std::make_unique<KernelConfig>(std::move(sub), Tristate::YES);
201 }
202
Yifan Hong8302cea2017-12-18 20:17:05 -0800203 static bool parseFileForKernelConfigs(std::basic_istream<char>& stream,
204 std::vector<KernelConfig>* out) {
Yifan Hong02e94002017-07-10 15:41:56 -0700205 KernelConfigParser parser(true /* processComments */, true /* relaxedFormat */);
Yifan Hong8302cea2017-12-18 20:17:05 -0800206 std::string content = read(stream);
Yifan Hong79efa8a2017-07-06 14:10:28 -0700207 status_t err = parser.process(content.c_str(), content.size());
208 if (err != OK) {
Yifan Hongae53a0e2017-07-07 15:19:06 -0700209 std::cerr << parser.error();
Yifan Hong79efa8a2017-07-06 14:10:28 -0700210 return false;
211 }
212 err = parser.finish();
213 if (err != OK) {
Yifan Hongae53a0e2017-07-07 15:19:06 -0700214 std::cerr << parser.error();
Yifan Hong79efa8a2017-07-06 14:10:28 -0700215 return false;
216 }
217
218 for (auto& configPair : parser.configs()) {
219 out->push_back({});
220 KernelConfig& config = out->back();
221 config.first = std::move(configPair.first);
222 if (!parseKernelConfigTypedValue(configPair.second, &config.second)) {
223 std::cerr << "Unknown value type for key = '" << config.first << "', value = '"
224 << configPair.second << "'\n";
225 return false;
226 }
227 }
228 return true;
229 }
230
Yifan Hong8302cea2017-12-18 20:17:05 -0800231 static bool parseFilesForKernelConfigs(std::vector<NamedIstream>* streams,
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700232 std::vector<ConditionedConfig>* out) {
233 out->clear();
234 ConditionedConfig commonConfig;
235 bool foundCommonConfig = false;
Steve Muckle0bef8682017-07-31 15:47:15 -0700236 bool ret = true;
Yifan Hong8302cea2017-12-18 20:17:05 -0800237
238 for (auto& namedStream : *streams) {
239 if (isCommonConfig(namedStream.name())) {
240 ret &= parseFileForKernelConfigs(namedStream.stream(), &commonConfig.second);
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700241 foundCommonConfig = true;
242 } else {
Yifan Hong8302cea2017-12-18 20:17:05 -0800243 Condition condition = generateCondition(namedStream.name());
Yifan Hong079ec242017-08-25 18:53:38 -0700244 ret &= (condition != nullptr);
245
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700246 std::vector<KernelConfig> kernelConfigs;
Yifan Hong8302cea2017-12-18 20:17:05 -0800247 if ((ret &= parseFileForKernelConfigs(namedStream.stream(), &kernelConfigs)))
Yifan Hong079ec242017-08-25 18:53:38 -0700248 out->emplace_back(std::move(condition), std::move(kernelConfigs));
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700249 }
Steve Muckle0bef8682017-07-31 15:47:15 -0700250 }
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700251
252 if (!foundCommonConfig) {
Yifan Hong8302cea2017-12-18 20:17:05 -0800253 std::cerr << "No android-base.cfg is found in these paths:" << std::endl;
254 for (auto& namedStream : *streams) {
255 std::cerr << " " << namedStream.name() << std::endl;
256 }
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700257 }
258 ret &= foundCommonConfig;
259 // first element is always common configs (no conditions).
260 out->insert(out->begin(), std::move(commonConfig));
Steve Muckle0bef8682017-07-31 15:47:15 -0700261 return ret;
262 }
263
Yifan Hong8302cea2017-12-18 20:17:05 -0800264 std::basic_ostream<char>& out() const { return mOutRef == nullptr ? std::cout : *mOutRef; }
Yifan Hong9aa63702017-05-16 16:37:50 -0700265
Yifan Hong1044fd12018-02-27 14:51:54 -0800266 // If -c is provided, check it.
267 bool checkDualFile(const HalManifest& manifest, const CompatibilityMatrix& matrix) {
268 if (getBooleanFlag("PRODUCT_ENFORCE_VINTF_MANIFEST")) {
269 std::string error;
270 if (!manifest.checkCompatibility(matrix, &error)) {
271 std::cerr << "Not compatible: " << error << std::endl;
272 return false;
273 }
274 }
275
276 // Check HALs in device manifest that are not in framework matrix.
277 if (getBooleanFlag("VINTF_ENFORCE_NO_UNUSED_HALS")) {
278 auto unused = manifest.checkUnusedHals(matrix);
279 if (!unused.empty()) {
280 std::cerr << "Error: The following instances are in the device manifest but "
281 << "not specified in framework compatibility matrix: " << std::endl
282 << " " << android::base::Join(unused, "\n ") << std::endl
283 << "Suggested fix:" << std::endl
284 << "1. Check for any typos in device manifest or framework compatibility "
285 << "matrices with FCM version >= " << matrix.level() << "." << std::endl
286 << "2. Add them to any framework compatibility matrix with FCM "
287 << "version >= " << matrix.level() << " where applicable." << std::endl
288 << "3. Add them to DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE."
289 << std::endl;
290
291 return false;
292 }
293 }
294 return true;
295 }
296
Yifan Hongdbe9db32017-12-11 19:06:11 -0800297 template <typename S>
Yifan Hongffcaf992018-01-09 17:08:51 -0800298 using Schemas = std::vector<Named<S>>;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800299 using HalManifests = Schemas<HalManifest>;
300 using CompatibilityMatrices = Schemas<CompatibilityMatrix>;
301
Steven Moreland5875afc2018-04-05 13:14:08 -0700302 template <typename M>
303 void outputInputs(const Schemas<M>& inputs) {
304 out() << "<!--" << std::endl;
305 out() << " Input:" << std::endl;
306 for (const auto& e : inputs) {
307 if (!e.name.empty()) {
308 out() << " " << base::Basename(e.name) << std::endl;
309 }
310 }
311 out() << "-->" << std::endl;
312 }
313
Yifan Hongdbe9db32017-12-11 19:06:11 -0800314 bool assembleHalManifest(HalManifests* halManifests) {
Yifan Hong4650ad82017-05-01 17:28:02 -0700315 std::string error;
Yifan Hongffcaf992018-01-09 17:08:51 -0800316 HalManifest* halManifest = &halManifests->front().object;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800317 for (auto it = halManifests->begin() + 1; it != halManifests->end(); ++it) {
Yifan Hongffcaf992018-01-09 17:08:51 -0800318 const std::string& path = it->name;
Yifan Hong0a35ab12018-06-29 11:32:57 -0700319 HalManifest& manifestToAdd = it->object;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800320
Yifan Hong0a35ab12018-06-29 11:32:57 -0700321 if (manifestToAdd.level() != Level::UNSPECIFIED) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800322 if (halManifest->level() == Level::UNSPECIFIED) {
Yifan Hong0a35ab12018-06-29 11:32:57 -0700323 halManifest->mLevel = manifestToAdd.level();
324 } else if (halManifest->level() != manifestToAdd.level()) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800325 std::cerr << "Inconsistent FCM Version in HAL manifests:" << std::endl
Yifan Hongffcaf992018-01-09 17:08:51 -0800326 << " File '" << halManifests->front().name << "' has level "
Yifan Hongdbe9db32017-12-11 19:06:11 -0800327 << halManifest->level() << std::endl
Yifan Hong0a35ab12018-06-29 11:32:57 -0700328 << " File '" << path << "' has level " << manifestToAdd.level()
Yifan Hongdbe9db32017-12-11 19:06:11 -0800329 << std::endl;
330 return false;
331 }
332 }
333
Steven Morelandb1392772018-05-01 11:21:35 -0700334 // TODO(b/78943004): add everything
Yifan Hong0a35ab12018-06-29 11:32:57 -0700335 if (!halManifest->addAllHals(&manifestToAdd, &error)) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800336 std::cerr << "File \"" << path << "\" cannot be added: conflict on HAL \"" << error
337 << "\" with an existing HAL. See <hal> with the same name "
338 << "in previously parsed files or previously declared in this file."
339 << std::endl;
340 return false;
341 }
Yifan Hong0a35ab12018-06-29 11:32:57 -0700342
343 // Check that manifestToAdd is empty.
344 if (!manifestToAdd.empty()) {
345 std::cerr << "File \"" << path << "\" contains extraneous entries and attributes. "
346 << "This is currently unsupported (b/78943004); it can only contain "
347 << "<hal>s and attribute \"type\". Only the first input "
348 << "file to assemble_vintf can contain other things. "
349 << "Remaining entries and attributes are:" << std::endl
350 << gHalManifestConverter(manifestToAdd);
351 return false;
352 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800353 }
Yifan Hong9aa63702017-05-16 16:37:50 -0700354
355 if (halManifest->mType == SchemaType::DEVICE) {
Steven Morelandb1392772018-05-01 11:21:35 -0700356 (void)getFlagIfUnset("BOARD_SEPOLICY_VERS", &halManifest->device.mSepolicyVersion);
357
Yifan Hongdbe9db32017-12-11 19:06:11 -0800358 if (!setDeviceFcmVersion(halManifest)) {
359 return false;
360 }
Yifan Hong9aa63702017-05-16 16:37:50 -0700361 }
362
Yifan Hongfeb454e2018-01-09 16:16:40 -0800363 if (halManifest->mType == SchemaType::FRAMEWORK) {
Yifan Honga28729e2018-01-17 13:40:35 -0800364 for (auto&& v : getEnvList("PROVIDED_VNDK_VERSIONS")) {
365 halManifest->framework.mVendorNdks.emplace_back(std::move(v));
366 }
367
Yifan Hong8b8492b2018-01-22 14:08:40 -0800368 for (auto&& v : getEnvList("PLATFORM_SYSTEMSDK_VERSIONS")) {
Yifan Honga28729e2018-01-17 13:40:35 -0800369 halManifest->framework.mSystemSdk.mVersions.emplace(std::move(v));
Yifan Hongfeb454e2018-01-09 16:16:40 -0800370 }
371 }
372
Steven Moreland5875afc2018-04-05 13:14:08 -0700373 outputInputs(*halManifests);
374
Yifan Hong9aa63702017-05-16 16:37:50 -0700375 if (mOutputMatrix) {
376 CompatibilityMatrix generatedMatrix = halManifest->generateCompatibleMatrix();
377 if (!halManifest->checkCompatibility(generatedMatrix, &error)) {
378 std::cerr << "FATAL ERROR: cannot generate a compatible matrix: " << error
379 << std::endl;
380 }
381 out() << "<!-- \n"
382 " Autogenerated skeleton compatibility matrix. \n"
383 " Use with caution. Modify it to suit your needs.\n"
384 " All HALs are set to optional.\n"
385 " Many entries other than HALs are zero-filled and\n"
386 " require human attention. \n"
387 "-->\n"
Yifan Honga2635c42017-12-12 13:20:33 -0800388 << gCompatibilityMatrixConverter(generatedMatrix, mSerializeFlags);
Yifan Hong9aa63702017-05-16 16:37:50 -0700389 } else {
Yifan Honga2635c42017-12-12 13:20:33 -0800390 out() << gHalManifestConverter(*halManifest, mSerializeFlags);
Yifan Hong9aa63702017-05-16 16:37:50 -0700391 }
392 out().flush();
393
Yifan Hong8302cea2017-12-18 20:17:05 -0800394 if (mCheckFile != nullptr) {
Yifan Hong9aa63702017-05-16 16:37:50 -0700395 CompatibilityMatrix checkMatrix;
Yifan Hong94757062018-02-09 16:36:31 -0800396 if (!gCompatibilityMatrixConverter(&checkMatrix, read(*mCheckFile), &error)) {
397 std::cerr << "Cannot parse check file as a compatibility matrix: " << error
398 << std::endl;
Yifan Hong9aa63702017-05-16 16:37:50 -0700399 return false;
400 }
Yifan Hong1044fd12018-02-27 14:51:54 -0800401 if (!checkDualFile(*halManifest, checkMatrix)) {
Yifan Hong9aa63702017-05-16 16:37:50 -0700402 return false;
403 }
404 }
405
406 return true;
407 }
408
Yifan Honge88e1672017-08-24 14:42:54 -0700409 bool assembleFrameworkCompatibilityMatrixKernels(CompatibilityMatrix* matrix) {
Yifan Hong8302cea2017-12-18 20:17:05 -0800410 for (auto& pair : mKernels) {
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700411 std::vector<ConditionedConfig> conditionedConfigs;
Yifan Hong8302cea2017-12-18 20:17:05 -0800412 if (!parseFilesForKernelConfigs(&pair.second, &conditionedConfigs)) {
Yifan Honge88e1672017-08-24 14:42:54 -0700413 return false;
414 }
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700415 for (ConditionedConfig& conditionedConfig : conditionedConfigs) {
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800416 MatrixKernel kernel(KernelVersion{pair.first}, std::move(conditionedConfig.second));
Yifan Hong079ec242017-08-25 18:53:38 -0700417 if (conditionedConfig.first != nullptr)
418 kernel.mConditions.push_back(std::move(*conditionedConfig.first));
419 matrix->framework.mKernels.push_back(std::move(kernel));
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700420 }
Yifan Honge88e1672017-08-24 14:42:54 -0700421 }
422 return true;
423 }
424
Yifan Hongdbe9db32017-12-11 19:06:11 -0800425 bool setDeviceFcmVersion(HalManifest* manifest) {
Yifan Hong1e6e34c2018-03-22 16:38:09 -0700426 // Not needed for generating empty manifest for DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE.
Yifan Hong2eee1982018-03-29 10:55:30 -0700427 if (getBooleanFlag("VINTF_IGNORE_TARGET_FCM_VERSION")) {
Yifan Hong1e6e34c2018-03-22 16:38:09 -0700428 return true;
429 }
430
Yifan Hongdbe9db32017-12-11 19:06:11 -0800431 size_t shippingApiLevel = getIntegerFlag("PRODUCT_SHIPPING_API_LEVEL");
Yifan Hong9aa63702017-05-16 16:37:50 -0700432
Yifan Hongdbe9db32017-12-11 19:06:11 -0800433 if (manifest->level() != Level::UNSPECIFIED) {
434 return true;
435 }
436 if (!getBooleanFlag("PRODUCT_ENFORCE_VINTF_MANIFEST")) {
437 manifest->mLevel = Level::LEGACY;
438 return true;
439 }
440 // TODO(b/70628538): Do not infer from Shipping API level.
441 if (shippingApiLevel) {
442 std::cerr << "Warning: Shipping FCM Version is inferred from Shipping API level. "
443 << "Declare Shipping FCM Version in device manifest directly." << std::endl;
Yifan Hongafae1982018-01-11 18:15:24 -0800444 manifest->mLevel = details::convertFromApiLevel(shippingApiLevel);
Yifan Hongdbe9db32017-12-11 19:06:11 -0800445 if (manifest->mLevel == Level::UNSPECIFIED) {
446 std::cerr << "Error: Shipping FCM Version cannot be inferred from Shipping API "
447 << "level " << shippingApiLevel << "."
448 << "Declare Shipping FCM Version in device manifest directly."
449 << std::endl;
450 return false;
451 }
452 return true;
453 }
454 // TODO(b/69638851): should be an error if Shipping API level is not defined.
455 // For now, just leave it empty; when framework compatibility matrix is built,
456 // lowest FCM Version is assumed.
457 std::cerr << "Warning: Shipping FCM Version cannot be inferred, because:" << std::endl
458 << " (1) It is not explicitly declared in device manifest;" << std::endl
459 << " (2) PRODUCT_ENFORCE_VINTF_MANIFEST is set to true;" << std::endl
460 << " (3) PRODUCT_SHIPPING_API_LEVEL is undefined." << std::endl
461 << "Assuming 'unspecified' Shipping FCM Version. " << std::endl
462 << "To remove this warning, define 'level' attribute in device manifest."
463 << std::endl;
464 return true;
465 }
466
467 Level getLowestFcmVersion(const CompatibilityMatrices& matrices) {
468 Level ret = Level::UNSPECIFIED;
469 for (const auto& e : matrices) {
Yifan Hongffcaf992018-01-09 17:08:51 -0800470 if (ret == Level::UNSPECIFIED || ret > e.object.level()) {
471 ret = e.object.level();
Yifan Hongdbe9db32017-12-11 19:06:11 -0800472 }
473 }
474 return ret;
475 }
476
477 bool assembleCompatibilityMatrix(CompatibilityMatrices* matrices) {
478 std::string error;
479 CompatibilityMatrix* matrix = nullptr;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800480 std::unique_ptr<HalManifest> checkManifest;
Yifan Hongffcaf992018-01-09 17:08:51 -0800481 if (matrices->front().object.mType == SchemaType::DEVICE) {
482 matrix = &matrices->front().object;
Yifan Hongfeb454e2018-01-09 16:16:40 -0800483
484 auto vndkVersion = base::Trim(getEnv("REQUIRED_VNDK_VERSION"));
485 if (!vndkVersion.empty()) {
486 auto& valueInMatrix = matrix->device.mVendorNdk;
487 if (!valueInMatrix.version().empty() && valueInMatrix.version() != vndkVersion) {
488 std::cerr << "Hard-coded <vendor-ndk> version in device compatibility matrix ("
489 << matrices->front().name << "), '" << valueInMatrix.version()
490 << "', does not match value inferred "
491 << "from BOARD_VNDK_VERSION '" << vndkVersion << "'" << std::endl;
492 return false;
493 }
494 valueInMatrix = VendorNdk{std::move(vndkVersion)};
495 }
Yifan Honga28729e2018-01-17 13:40:35 -0800496
497 for (auto&& v : getEnvList("BOARD_SYSTEMSDK_VERSIONS")) {
498 matrix->device.mSystemSdk.mVersions.emplace(std::move(v));
499 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800500 }
501
Yifan Hongffcaf992018-01-09 17:08:51 -0800502 if (matrices->front().object.mType == SchemaType::FRAMEWORK) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800503 Level deviceLevel = Level::UNSPECIFIED;
Yifan Hong8302cea2017-12-18 20:17:05 -0800504 if (mCheckFile != nullptr) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800505 checkManifest = std::make_unique<HalManifest>();
Yifan Hong94757062018-02-09 16:36:31 -0800506 if (!gHalManifestConverter(checkManifest.get(), read(*mCheckFile), &error)) {
507 std::cerr << "Cannot parse check file as a HAL manifest: " << error
508 << std::endl;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800509 return false;
510 }
511 deviceLevel = checkManifest->level();
512 }
513
514 if (deviceLevel == Level::UNSPECIFIED) {
515 // For GSI build, legacy devices that do not have a HAL manifest,
516 // and devices in development, merge all compatibility matrices.
517 deviceLevel = getLowestFcmVersion(*matrices);
518 }
519
Yifan Hong1e6e34c2018-03-22 16:38:09 -0700520 matrix = CompatibilityMatrix::combine(deviceLevel, matrices, &error);
521 if (matrix == nullptr) {
522 std::cerr << error << std::endl;
523 return false;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800524 }
525
Yifan Honge88e1672017-08-24 14:42:54 -0700526 if (!assembleFrameworkCompatibilityMatrixKernels(matrix)) {
527 return false;
Yifan Hong79efa8a2017-07-06 14:10:28 -0700528 }
Yifan Honge88e1672017-08-24 14:42:54 -0700529
Yifan Hong321ee222018-02-02 12:46:52 -0800530 // Add PLATFORM_SEPOLICY_* to sepolicy.sepolicy-version. Remove dupes.
531 std::set<Version> sepolicyVersions;
532 auto sepolicyVersionStrings = getEnvList("PLATFORM_SEPOLICY_COMPAT_VERSIONS");
533 auto currentSepolicyVersionString = getEnv("PLATFORM_SEPOLICY_VERSION");
534 if (!currentSepolicyVersionString.empty()) {
535 sepolicyVersionStrings.push_back(currentSepolicyVersionString);
536 }
537 for (auto&& s : sepolicyVersionStrings) {
538 Version v;
539 if (!parse(s, &v)) {
540 std::cerr << "Error: unknown sepolicy version '" << s << "' specified by "
541 << (s == currentSepolicyVersionString
542 ? "PLATFORM_SEPOLICY_VERSION"
543 : "PLATFORM_SEPOLICY_COMPAT_VERSIONS")
544 << ".";
545 return false;
546 }
547 sepolicyVersions.insert(v);
548 }
549 for (auto&& v : sepolicyVersions) {
550 matrix->framework.mSepolicy.mSepolicyVersionRanges.emplace_back(v.majorVer,
551 v.minorVer);
Yifan Hong7f6c00c2017-07-06 19:50:29 +0000552 }
Yifan Hongf4135012017-12-18 17:27:19 -0800553
Yifan Hongf7e8b1b2018-01-23 15:30:35 -0800554 getFlagIfUnset("POLICYVERS", &matrix->framework.mSepolicy.mKernelSepolicyVersion,
555 deviceLevel == Level::UNSPECIFIED /* log */);
556 getFlagIfUnset("FRAMEWORK_VBMETA_VERSION", &matrix->framework.mAvbMetaVersion,
557 deviceLevel == Level::UNSPECIFIED /* log */);
Yifan Hong9aa63702017-05-16 16:37:50 -0700558 }
Steven Moreland5875afc2018-04-05 13:14:08 -0700559 outputInputs(*matrices);
Yifan Honga2635c42017-12-12 13:20:33 -0800560 out() << gCompatibilityMatrixConverter(*matrix, mSerializeFlags);
Yifan Hong9aa63702017-05-16 16:37:50 -0700561 out().flush();
562
Yifan Hong1044fd12018-02-27 14:51:54 -0800563 if (checkManifest != nullptr && !checkDualFile(*checkManifest, *matrix)) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800564 return false;
Yifan Hong9aa63702017-05-16 16:37:50 -0700565 }
566
567 return true;
568 }
569
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700570 enum AssembleStatus { SUCCESS, FAIL_AND_EXIT, TRY_NEXT };
571 template <typename Schema, typename AssembleFunc>
572 AssembleStatus tryAssemble(const XmlConverter<Schema>& converter, const std::string& schemaName,
Yifan Hong94757062018-02-09 16:36:31 -0800573 AssembleFunc assemble, std::string* error) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800574 Schemas<Schema> schemas;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700575 Schema schema;
Yifan Hong94757062018-02-09 16:36:31 -0800576 if (!converter(&schema, read(mInFiles.front().stream()), error)) {
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700577 return TRY_NEXT;
578 }
579 auto firstType = schema.type();
Yifan Hongaa219f52017-12-18 18:51:59 -0800580 schemas.emplace_back(mInFiles.front().name(), std::move(schema));
Yifan Hongdbe9db32017-12-11 19:06:11 -0800581
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700582 for (auto it = mInFiles.begin() + 1; it != mInFiles.end(); ++it) {
583 Schema additionalSchema;
Yifan Hongaa219f52017-12-18 18:51:59 -0800584 const std::string& fileName = it->name();
Yifan Hong94757062018-02-09 16:36:31 -0800585 if (!converter(&additionalSchema, read(it->stream()), error)) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800586 std::cerr << "File \"" << fileName << "\" is not a valid " << firstType << " "
587 << schemaName << " (but the first file is a valid " << firstType << " "
Yifan Hong94757062018-02-09 16:36:31 -0800588 << schemaName << "). Error: " << *error << std::endl;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700589 return FAIL_AND_EXIT;
590 }
591 if (additionalSchema.type() != firstType) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800592 std::cerr << "File \"" << fileName << "\" is a " << additionalSchema.type() << " "
593 << schemaName << " (but a " << firstType << " " << schemaName
594 << " is expected)." << std::endl;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700595 return FAIL_AND_EXIT;
596 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800597
598 schemas.emplace_back(fileName, std::move(additionalSchema));
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700599 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800600 return assemble(&schemas) ? SUCCESS : FAIL_AND_EXIT;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700601 }
602
Yifan Hong8302cea2017-12-18 20:17:05 -0800603 bool assemble() override {
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700604 using std::placeholders::_1;
605 if (mInFiles.empty()) {
Yifan Hong9aa63702017-05-16 16:37:50 -0700606 std::cerr << "Missing input file." << std::endl;
607 return false;
608 }
609
Yifan Hong94757062018-02-09 16:36:31 -0800610 std::string manifestError;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700611 auto status = tryAssemble(gHalManifestConverter, "manifest",
Yifan Hong94757062018-02-09 16:36:31 -0800612 std::bind(&AssembleVintfImpl::assembleHalManifest, this, _1),
613 &manifestError);
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700614 if (status == SUCCESS) return true;
615 if (status == FAIL_AND_EXIT) return false;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000616
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700617 resetInFiles();
Yifan Honga59d2562017-04-18 18:01:16 -0700618
Yifan Hong94757062018-02-09 16:36:31 -0800619 std::string matrixError;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700620 status = tryAssemble(gCompatibilityMatrixConverter, "compatibility matrix",
Yifan Hong94757062018-02-09 16:36:31 -0800621 std::bind(&AssembleVintfImpl::assembleCompatibilityMatrix, this, _1),
622 &matrixError);
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700623 if (status == SUCCESS) return true;
624 if (status == FAIL_AND_EXIT) return false;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000625
Yifan Hong959ee1b2017-04-28 14:37:56 -0700626 std::cerr << "Input file has unknown format." << std::endl
Yifan Hong94757062018-02-09 16:36:31 -0800627 << "Error when attempting to convert to manifest: " << manifestError << std::endl
628 << "Error when attempting to convert to compatibility matrix: " << matrixError
629 << std::endl;
Yifan Hong959ee1b2017-04-28 14:37:56 -0700630 return false;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000631 }
Yifan Hong9aa63702017-05-16 16:37:50 -0700632
Yifan Hong8302cea2017-12-18 20:17:05 -0800633 std::ostream& setOutputStream(Ostream&& out) override {
634 mOutRef = std::move(out);
635 return *mOutRef;
Yifan Hong9aa63702017-05-16 16:37:50 -0700636 }
637
Yifan Hong8302cea2017-12-18 20:17:05 -0800638 std::istream& addInputStream(const std::string& name, Istream&& in) override {
639 auto it = mInFiles.emplace(mInFiles.end(), name, std::move(in));
640 return it->stream();
Yifan Hong9aa63702017-05-16 16:37:50 -0700641 }
642
Yifan Hong8302cea2017-12-18 20:17:05 -0800643 std::istream& setCheckInputStream(Istream&& in) override {
644 mCheckFile = std::move(in);
645 return *mCheckFile;
646 }
647
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800648 bool hasKernelVersion(const KernelVersion& kernelVer) const override {
Yifan Hong8302cea2017-12-18 20:17:05 -0800649 return mKernels.find(kernelVer) != mKernels.end();
650 }
651
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800652 std::istream& addKernelConfigInputStream(const KernelVersion& kernelVer,
653 const std::string& name, Istream&& in) override {
Yifan Hong8302cea2017-12-18 20:17:05 -0800654 auto&& kernel = mKernels[kernelVer];
655 auto it = kernel.emplace(kernel.end(), name, std::move(in));
656 return it->stream();
Yifan Hong9aa63702017-05-16 16:37:50 -0700657 }
658
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700659 void resetInFiles() {
660 for (auto& inFile : mInFiles) {
Yifan Hongaa219f52017-12-18 18:51:59 -0800661 inFile.stream().clear();
662 inFile.stream().seekg(0);
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700663 }
664 }
665
Yifan Hong8302cea2017-12-18 20:17:05 -0800666 void setOutputMatrix() override { mOutputMatrix = true; }
Yifan Hong9aa63702017-05-16 16:37:50 -0700667
Yifan Hong8302cea2017-12-18 20:17:05 -0800668 bool setHalsOnly() override {
Yifan Honga2635c42017-12-12 13:20:33 -0800669 if (mSerializeFlags) return false;
670 mSerializeFlags |= SerializeFlag::HALS_ONLY;
671 return true;
672 }
673
Yifan Hong8302cea2017-12-18 20:17:05 -0800674 bool setNoHals() override {
Yifan Honga2635c42017-12-12 13:20:33 -0800675 if (mSerializeFlags) return false;
676 mSerializeFlags |= SerializeFlag::NO_HALS;
677 return true;
678 }
679
Yifan Hong9aa63702017-05-16 16:37:50 -0700680 private:
Yifan Hongaa219f52017-12-18 18:51:59 -0800681 std::vector<NamedIstream> mInFiles;
Yifan Hong8302cea2017-12-18 20:17:05 -0800682 Ostream mOutRef;
683 Istream mCheckFile;
Yifan Hong9aa63702017-05-16 16:37:50 -0700684 bool mOutputMatrix = false;
Yifan Honga2635c42017-12-12 13:20:33 -0800685 SerializeFlags mSerializeFlags = SerializeFlag::EVERYTHING;
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800686 std::map<KernelVersion, std::vector<NamedIstream>> mKernels;
Yifan Hong8302cea2017-12-18 20:17:05 -0800687 std::map<std::string, std::string> mFakeEnv;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000688};
689
Yifan Hong8302cea2017-12-18 20:17:05 -0800690bool AssembleVintf::openOutFile(const std::string& path) {
691 return static_cast<std::ofstream&>(setOutputStream(std::make_unique<std::ofstream>(path)))
692 .is_open();
693}
694
695bool AssembleVintf::openInFile(const std::string& path) {
696 return static_cast<std::ifstream&>(addInputStream(path, std::make_unique<std::ifstream>(path)))
697 .is_open();
698}
699
700bool AssembleVintf::openCheckFile(const std::string& path) {
701 return static_cast<std::ifstream&>(setCheckInputStream(std::make_unique<std::ifstream>(path)))
702 .is_open();
703}
704
705bool AssembleVintf::addKernel(const std::string& kernelArg) {
Yifan Hongb83e56b2018-01-09 14:36:30 -0800706 auto tokens = base::Split(kernelArg, ":");
Yifan Hong8302cea2017-12-18 20:17:05 -0800707 if (tokens.size() <= 1) {
708 std::cerr << "Unrecognized --kernel option '" << kernelArg << "'" << std::endl;
709 return false;
710 }
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800711 KernelVersion kernelVer;
Yifan Hong8302cea2017-12-18 20:17:05 -0800712 if (!parse(tokens.front(), &kernelVer)) {
713 std::cerr << "Unrecognized kernel version '" << tokens.front() << "'" << std::endl;
714 return false;
715 }
716 if (hasKernelVersion(kernelVer)) {
717 std::cerr << "Multiple --kernel for " << kernelVer << " is specified." << std::endl;
718 return false;
719 }
720 for (auto it = tokens.begin() + 1; it != tokens.end(); ++it) {
721 bool opened =
722 static_cast<std::ifstream&>(
723 addKernelConfigInputStream(kernelVer, *it, std::make_unique<std::ifstream>(*it)))
724 .is_open();
725 if (!opened) {
726 std::cerr << "Cannot open file '" << *it << "'." << std::endl;
727 return false;
728 }
729 }
730 return true;
731}
732
733std::unique_ptr<AssembleVintf> AssembleVintf::newInstance() {
734 return std::make_unique<AssembleVintfImpl>();
735}
736
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000737} // namespace vintf
738} // namespace android