blob: 575e598ba54ee7cdc6b40f3c0b14416f0edeb948 [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;
319 HalManifest& halToAdd = it->object;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800320
321 if (halToAdd.level() != Level::UNSPECIFIED) {
322 if (halManifest->level() == Level::UNSPECIFIED) {
323 halManifest->mLevel = halToAdd.level();
324 } else if (halManifest->level() != halToAdd.level()) {
325 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
328 << " File '" << path << "' has level " << halToAdd.level()
329 << std::endl;
330 return false;
331 }
332 }
333
Yifan Hongea25dd42017-12-18 17:03:24 -0800334 if (!halManifest->addAllHals(&halToAdd, &error)) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800335 std::cerr << "File \"" << path << "\" cannot be added: conflict on HAL \"" << error
336 << "\" with an existing HAL. See <hal> with the same name "
337 << "in previously parsed files or previously declared in this file."
338 << std::endl;
339 return false;
340 }
341 }
Yifan Hong9aa63702017-05-16 16:37:50 -0700342
343 if (halManifest->mType == SchemaType::DEVICE) {
344 if (!getFlag("BOARD_SEPOLICY_VERS", &halManifest->device.mSepolicyVersion)) {
345 return false;
346 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800347 if (!setDeviceFcmVersion(halManifest)) {
348 return false;
349 }
Yifan Hong9aa63702017-05-16 16:37:50 -0700350 }
351
Yifan Hongfeb454e2018-01-09 16:16:40 -0800352 if (halManifest->mType == SchemaType::FRAMEWORK) {
Yifan Honga28729e2018-01-17 13:40:35 -0800353 for (auto&& v : getEnvList("PROVIDED_VNDK_VERSIONS")) {
354 halManifest->framework.mVendorNdks.emplace_back(std::move(v));
355 }
356
Yifan Hong8b8492b2018-01-22 14:08:40 -0800357 for (auto&& v : getEnvList("PLATFORM_SYSTEMSDK_VERSIONS")) {
Yifan Honga28729e2018-01-17 13:40:35 -0800358 halManifest->framework.mSystemSdk.mVersions.emplace(std::move(v));
Yifan Hongfeb454e2018-01-09 16:16:40 -0800359 }
360 }
361
Steven Moreland5875afc2018-04-05 13:14:08 -0700362 outputInputs(*halManifests);
363
Yifan Hong9aa63702017-05-16 16:37:50 -0700364 if (mOutputMatrix) {
365 CompatibilityMatrix generatedMatrix = halManifest->generateCompatibleMatrix();
366 if (!halManifest->checkCompatibility(generatedMatrix, &error)) {
367 std::cerr << "FATAL ERROR: cannot generate a compatible matrix: " << error
368 << std::endl;
369 }
370 out() << "<!-- \n"
371 " Autogenerated skeleton compatibility matrix. \n"
372 " Use with caution. Modify it to suit your needs.\n"
373 " All HALs are set to optional.\n"
374 " Many entries other than HALs are zero-filled and\n"
375 " require human attention. \n"
376 "-->\n"
Yifan Honga2635c42017-12-12 13:20:33 -0800377 << gCompatibilityMatrixConverter(generatedMatrix, mSerializeFlags);
Yifan Hong9aa63702017-05-16 16:37:50 -0700378 } else {
Yifan Honga2635c42017-12-12 13:20:33 -0800379 out() << gHalManifestConverter(*halManifest, mSerializeFlags);
Yifan Hong9aa63702017-05-16 16:37:50 -0700380 }
381 out().flush();
382
Yifan Hong8302cea2017-12-18 20:17:05 -0800383 if (mCheckFile != nullptr) {
Yifan Hong9aa63702017-05-16 16:37:50 -0700384 CompatibilityMatrix checkMatrix;
Yifan Hong94757062018-02-09 16:36:31 -0800385 if (!gCompatibilityMatrixConverter(&checkMatrix, read(*mCheckFile), &error)) {
386 std::cerr << "Cannot parse check file as a compatibility matrix: " << error
387 << std::endl;
Yifan Hong9aa63702017-05-16 16:37:50 -0700388 return false;
389 }
Yifan Hong1044fd12018-02-27 14:51:54 -0800390 if (!checkDualFile(*halManifest, checkMatrix)) {
Yifan Hong9aa63702017-05-16 16:37:50 -0700391 return false;
392 }
393 }
394
395 return true;
396 }
397
Yifan Honge88e1672017-08-24 14:42:54 -0700398 bool assembleFrameworkCompatibilityMatrixKernels(CompatibilityMatrix* matrix) {
Yifan Hong8302cea2017-12-18 20:17:05 -0800399 for (auto& pair : mKernels) {
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700400 std::vector<ConditionedConfig> conditionedConfigs;
Yifan Hong8302cea2017-12-18 20:17:05 -0800401 if (!parseFilesForKernelConfigs(&pair.second, &conditionedConfigs)) {
Yifan Honge88e1672017-08-24 14:42:54 -0700402 return false;
403 }
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700404 for (ConditionedConfig& conditionedConfig : conditionedConfigs) {
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800405 MatrixKernel kernel(KernelVersion{pair.first}, std::move(conditionedConfig.second));
Yifan Hong079ec242017-08-25 18:53:38 -0700406 if (conditionedConfig.first != nullptr)
407 kernel.mConditions.push_back(std::move(*conditionedConfig.first));
408 matrix->framework.mKernels.push_back(std::move(kernel));
Yifan Hong9a8b1a72017-08-25 17:55:33 -0700409 }
Yifan Honge88e1672017-08-24 14:42:54 -0700410 }
411 return true;
412 }
413
Yifan Hongdbe9db32017-12-11 19:06:11 -0800414 bool setDeviceFcmVersion(HalManifest* manifest) {
Yifan Hong1e6e34c2018-03-22 16:38:09 -0700415 // Not needed for generating empty manifest for DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE.
Yifan Hong2eee1982018-03-29 10:55:30 -0700416 if (getBooleanFlag("VINTF_IGNORE_TARGET_FCM_VERSION")) {
Yifan Hong1e6e34c2018-03-22 16:38:09 -0700417 return true;
418 }
419
Yifan Hongdbe9db32017-12-11 19:06:11 -0800420 size_t shippingApiLevel = getIntegerFlag("PRODUCT_SHIPPING_API_LEVEL");
Yifan Hong9aa63702017-05-16 16:37:50 -0700421
Yifan Hongdbe9db32017-12-11 19:06:11 -0800422 if (manifest->level() != Level::UNSPECIFIED) {
423 return true;
424 }
425 if (!getBooleanFlag("PRODUCT_ENFORCE_VINTF_MANIFEST")) {
426 manifest->mLevel = Level::LEGACY;
427 return true;
428 }
429 // TODO(b/70628538): Do not infer from Shipping API level.
430 if (shippingApiLevel) {
431 std::cerr << "Warning: Shipping FCM Version is inferred from Shipping API level. "
432 << "Declare Shipping FCM Version in device manifest directly." << std::endl;
Yifan Hongafae1982018-01-11 18:15:24 -0800433 manifest->mLevel = details::convertFromApiLevel(shippingApiLevel);
Yifan Hongdbe9db32017-12-11 19:06:11 -0800434 if (manifest->mLevel == Level::UNSPECIFIED) {
435 std::cerr << "Error: Shipping FCM Version cannot be inferred from Shipping API "
436 << "level " << shippingApiLevel << "."
437 << "Declare Shipping FCM Version in device manifest directly."
438 << std::endl;
439 return false;
440 }
441 return true;
442 }
443 // TODO(b/69638851): should be an error if Shipping API level is not defined.
444 // For now, just leave it empty; when framework compatibility matrix is built,
445 // lowest FCM Version is assumed.
446 std::cerr << "Warning: Shipping FCM Version cannot be inferred, because:" << std::endl
447 << " (1) It is not explicitly declared in device manifest;" << std::endl
448 << " (2) PRODUCT_ENFORCE_VINTF_MANIFEST is set to true;" << std::endl
449 << " (3) PRODUCT_SHIPPING_API_LEVEL is undefined." << std::endl
450 << "Assuming 'unspecified' Shipping FCM Version. " << std::endl
451 << "To remove this warning, define 'level' attribute in device manifest."
452 << std::endl;
453 return true;
454 }
455
456 Level getLowestFcmVersion(const CompatibilityMatrices& matrices) {
457 Level ret = Level::UNSPECIFIED;
458 for (const auto& e : matrices) {
Yifan Hongffcaf992018-01-09 17:08:51 -0800459 if (ret == Level::UNSPECIFIED || ret > e.object.level()) {
460 ret = e.object.level();
Yifan Hongdbe9db32017-12-11 19:06:11 -0800461 }
462 }
463 return ret;
464 }
465
466 bool assembleCompatibilityMatrix(CompatibilityMatrices* matrices) {
467 std::string error;
468 CompatibilityMatrix* matrix = nullptr;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800469 std::unique_ptr<HalManifest> checkManifest;
Yifan Hongffcaf992018-01-09 17:08:51 -0800470 if (matrices->front().object.mType == SchemaType::DEVICE) {
471 matrix = &matrices->front().object;
Yifan Hongfeb454e2018-01-09 16:16:40 -0800472
473 auto vndkVersion = base::Trim(getEnv("REQUIRED_VNDK_VERSION"));
474 if (!vndkVersion.empty()) {
475 auto& valueInMatrix = matrix->device.mVendorNdk;
476 if (!valueInMatrix.version().empty() && valueInMatrix.version() != vndkVersion) {
477 std::cerr << "Hard-coded <vendor-ndk> version in device compatibility matrix ("
478 << matrices->front().name << "), '" << valueInMatrix.version()
479 << "', does not match value inferred "
480 << "from BOARD_VNDK_VERSION '" << vndkVersion << "'" << std::endl;
481 return false;
482 }
483 valueInMatrix = VendorNdk{std::move(vndkVersion)};
484 }
Yifan Honga28729e2018-01-17 13:40:35 -0800485
486 for (auto&& v : getEnvList("BOARD_SYSTEMSDK_VERSIONS")) {
487 matrix->device.mSystemSdk.mVersions.emplace(std::move(v));
488 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800489 }
490
Yifan Hongffcaf992018-01-09 17:08:51 -0800491 if (matrices->front().object.mType == SchemaType::FRAMEWORK) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800492 Level deviceLevel = Level::UNSPECIFIED;
Yifan Hong8302cea2017-12-18 20:17:05 -0800493 if (mCheckFile != nullptr) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800494 checkManifest = std::make_unique<HalManifest>();
Yifan Hong94757062018-02-09 16:36:31 -0800495 if (!gHalManifestConverter(checkManifest.get(), read(*mCheckFile), &error)) {
496 std::cerr << "Cannot parse check file as a HAL manifest: " << error
497 << std::endl;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800498 return false;
499 }
500 deviceLevel = checkManifest->level();
501 }
502
503 if (deviceLevel == Level::UNSPECIFIED) {
504 // For GSI build, legacy devices that do not have a HAL manifest,
505 // and devices in development, merge all compatibility matrices.
506 deviceLevel = getLowestFcmVersion(*matrices);
507 }
508
Yifan Hong1e6e34c2018-03-22 16:38:09 -0700509 matrix = CompatibilityMatrix::combine(deviceLevel, matrices, &error);
510 if (matrix == nullptr) {
511 std::cerr << error << std::endl;
512 return false;
Yifan Hongdbe9db32017-12-11 19:06:11 -0800513 }
514
Yifan Honge88e1672017-08-24 14:42:54 -0700515 if (!assembleFrameworkCompatibilityMatrixKernels(matrix)) {
516 return false;
Yifan Hong79efa8a2017-07-06 14:10:28 -0700517 }
Yifan Honge88e1672017-08-24 14:42:54 -0700518
Yifan Hong321ee222018-02-02 12:46:52 -0800519 // Add PLATFORM_SEPOLICY_* to sepolicy.sepolicy-version. Remove dupes.
520 std::set<Version> sepolicyVersions;
521 auto sepolicyVersionStrings = getEnvList("PLATFORM_SEPOLICY_COMPAT_VERSIONS");
522 auto currentSepolicyVersionString = getEnv("PLATFORM_SEPOLICY_VERSION");
523 if (!currentSepolicyVersionString.empty()) {
524 sepolicyVersionStrings.push_back(currentSepolicyVersionString);
525 }
526 for (auto&& s : sepolicyVersionStrings) {
527 Version v;
528 if (!parse(s, &v)) {
529 std::cerr << "Error: unknown sepolicy version '" << s << "' specified by "
530 << (s == currentSepolicyVersionString
531 ? "PLATFORM_SEPOLICY_VERSION"
532 : "PLATFORM_SEPOLICY_COMPAT_VERSIONS")
533 << ".";
534 return false;
535 }
536 sepolicyVersions.insert(v);
537 }
538 for (auto&& v : sepolicyVersions) {
539 matrix->framework.mSepolicy.mSepolicyVersionRanges.emplace_back(v.majorVer,
540 v.minorVer);
Yifan Hong7f6c00c2017-07-06 19:50:29 +0000541 }
Yifan Hongf4135012017-12-18 17:27:19 -0800542
Yifan Hongf7e8b1b2018-01-23 15:30:35 -0800543 getFlagIfUnset("POLICYVERS", &matrix->framework.mSepolicy.mKernelSepolicyVersion,
544 deviceLevel == Level::UNSPECIFIED /* log */);
545 getFlagIfUnset("FRAMEWORK_VBMETA_VERSION", &matrix->framework.mAvbMetaVersion,
546 deviceLevel == Level::UNSPECIFIED /* log */);
Yifan Hong9aa63702017-05-16 16:37:50 -0700547 }
Steven Moreland5875afc2018-04-05 13:14:08 -0700548 outputInputs(*matrices);
Yifan Honga2635c42017-12-12 13:20:33 -0800549 out() << gCompatibilityMatrixConverter(*matrix, mSerializeFlags);
Yifan Hong9aa63702017-05-16 16:37:50 -0700550 out().flush();
551
Yifan Hong1044fd12018-02-27 14:51:54 -0800552 if (checkManifest != nullptr && !checkDualFile(*checkManifest, *matrix)) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800553 return false;
Yifan Hong9aa63702017-05-16 16:37:50 -0700554 }
555
556 return true;
557 }
558
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700559 enum AssembleStatus { SUCCESS, FAIL_AND_EXIT, TRY_NEXT };
560 template <typename Schema, typename AssembleFunc>
561 AssembleStatus tryAssemble(const XmlConverter<Schema>& converter, const std::string& schemaName,
Yifan Hong94757062018-02-09 16:36:31 -0800562 AssembleFunc assemble, std::string* error) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800563 Schemas<Schema> schemas;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700564 Schema schema;
Yifan Hong94757062018-02-09 16:36:31 -0800565 if (!converter(&schema, read(mInFiles.front().stream()), error)) {
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700566 return TRY_NEXT;
567 }
568 auto firstType = schema.type();
Yifan Hongaa219f52017-12-18 18:51:59 -0800569 schemas.emplace_back(mInFiles.front().name(), std::move(schema));
Yifan Hongdbe9db32017-12-11 19:06:11 -0800570
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700571 for (auto it = mInFiles.begin() + 1; it != mInFiles.end(); ++it) {
572 Schema additionalSchema;
Yifan Hongaa219f52017-12-18 18:51:59 -0800573 const std::string& fileName = it->name();
Yifan Hong94757062018-02-09 16:36:31 -0800574 if (!converter(&additionalSchema, read(it->stream()), error)) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800575 std::cerr << "File \"" << fileName << "\" is not a valid " << firstType << " "
576 << schemaName << " (but the first file is a valid " << firstType << " "
Yifan Hong94757062018-02-09 16:36:31 -0800577 << schemaName << "). Error: " << *error << std::endl;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700578 return FAIL_AND_EXIT;
579 }
580 if (additionalSchema.type() != firstType) {
Yifan Hongdbe9db32017-12-11 19:06:11 -0800581 std::cerr << "File \"" << fileName << "\" is a " << additionalSchema.type() << " "
582 << schemaName << " (but a " << firstType << " " << schemaName
583 << " is expected)." << std::endl;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700584 return FAIL_AND_EXIT;
585 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800586
587 schemas.emplace_back(fileName, std::move(additionalSchema));
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700588 }
Yifan Hongdbe9db32017-12-11 19:06:11 -0800589 return assemble(&schemas) ? SUCCESS : FAIL_AND_EXIT;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700590 }
591
Yifan Hong8302cea2017-12-18 20:17:05 -0800592 bool assemble() override {
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700593 using std::placeholders::_1;
594 if (mInFiles.empty()) {
Yifan Hong9aa63702017-05-16 16:37:50 -0700595 std::cerr << "Missing input file." << std::endl;
596 return false;
597 }
598
Yifan Hong94757062018-02-09 16:36:31 -0800599 std::string manifestError;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700600 auto status = tryAssemble(gHalManifestConverter, "manifest",
Yifan Hong94757062018-02-09 16:36:31 -0800601 std::bind(&AssembleVintfImpl::assembleHalManifest, this, _1),
602 &manifestError);
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700603 if (status == SUCCESS) return true;
604 if (status == FAIL_AND_EXIT) return false;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000605
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700606 resetInFiles();
Yifan Honga59d2562017-04-18 18:01:16 -0700607
Yifan Hong94757062018-02-09 16:36:31 -0800608 std::string matrixError;
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700609 status = tryAssemble(gCompatibilityMatrixConverter, "compatibility matrix",
Yifan Hong94757062018-02-09 16:36:31 -0800610 std::bind(&AssembleVintfImpl::assembleCompatibilityMatrix, this, _1),
611 &matrixError);
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700612 if (status == SUCCESS) return true;
613 if (status == FAIL_AND_EXIT) return false;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000614
Yifan Hong959ee1b2017-04-28 14:37:56 -0700615 std::cerr << "Input file has unknown format." << std::endl
Yifan Hong94757062018-02-09 16:36:31 -0800616 << "Error when attempting to convert to manifest: " << manifestError << std::endl
617 << "Error when attempting to convert to compatibility matrix: " << matrixError
618 << std::endl;
Yifan Hong959ee1b2017-04-28 14:37:56 -0700619 return false;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000620 }
Yifan Hong9aa63702017-05-16 16:37:50 -0700621
Yifan Hong8302cea2017-12-18 20:17:05 -0800622 std::ostream& setOutputStream(Ostream&& out) override {
623 mOutRef = std::move(out);
624 return *mOutRef;
Yifan Hong9aa63702017-05-16 16:37:50 -0700625 }
626
Yifan Hong8302cea2017-12-18 20:17:05 -0800627 std::istream& addInputStream(const std::string& name, Istream&& in) override {
628 auto it = mInFiles.emplace(mInFiles.end(), name, std::move(in));
629 return it->stream();
Yifan Hong9aa63702017-05-16 16:37:50 -0700630 }
631
Yifan Hong8302cea2017-12-18 20:17:05 -0800632 std::istream& setCheckInputStream(Istream&& in) override {
633 mCheckFile = std::move(in);
634 return *mCheckFile;
635 }
636
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800637 bool hasKernelVersion(const KernelVersion& kernelVer) const override {
Yifan Hong8302cea2017-12-18 20:17:05 -0800638 return mKernels.find(kernelVer) != mKernels.end();
639 }
640
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800641 std::istream& addKernelConfigInputStream(const KernelVersion& kernelVer,
642 const std::string& name, Istream&& in) override {
Yifan Hong8302cea2017-12-18 20:17:05 -0800643 auto&& kernel = mKernels[kernelVer];
644 auto it = kernel.emplace(kernel.end(), name, std::move(in));
645 return it->stream();
Yifan Hong9aa63702017-05-16 16:37:50 -0700646 }
647
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700648 void resetInFiles() {
649 for (auto& inFile : mInFiles) {
Yifan Hongaa219f52017-12-18 18:51:59 -0800650 inFile.stream().clear();
651 inFile.stream().seekg(0);
Yifan Hongbfb3c1d2017-05-24 14:38:48 -0700652 }
653 }
654
Yifan Hong8302cea2017-12-18 20:17:05 -0800655 void setOutputMatrix() override { mOutputMatrix = true; }
Yifan Hong9aa63702017-05-16 16:37:50 -0700656
Yifan Hong8302cea2017-12-18 20:17:05 -0800657 bool setHalsOnly() override {
Yifan Honga2635c42017-12-12 13:20:33 -0800658 if (mSerializeFlags) return false;
659 mSerializeFlags |= SerializeFlag::HALS_ONLY;
660 return true;
661 }
662
Yifan Hong8302cea2017-12-18 20:17:05 -0800663 bool setNoHals() override {
Yifan Honga2635c42017-12-12 13:20:33 -0800664 if (mSerializeFlags) return false;
665 mSerializeFlags |= SerializeFlag::NO_HALS;
666 return true;
667 }
668
Yifan Hong9aa63702017-05-16 16:37:50 -0700669 private:
Yifan Hongaa219f52017-12-18 18:51:59 -0800670 std::vector<NamedIstream> mInFiles;
Yifan Hong8302cea2017-12-18 20:17:05 -0800671 Ostream mOutRef;
672 Istream mCheckFile;
Yifan Hong9aa63702017-05-16 16:37:50 -0700673 bool mOutputMatrix = false;
Yifan Honga2635c42017-12-12 13:20:33 -0800674 SerializeFlags mSerializeFlags = SerializeFlag::EVERYTHING;
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800675 std::map<KernelVersion, std::vector<NamedIstream>> mKernels;
Yifan Hong8302cea2017-12-18 20:17:05 -0800676 std::map<std::string, std::string> mFakeEnv;
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000677};
678
Yifan Hong8302cea2017-12-18 20:17:05 -0800679bool AssembleVintf::openOutFile(const std::string& path) {
680 return static_cast<std::ofstream&>(setOutputStream(std::make_unique<std::ofstream>(path)))
681 .is_open();
682}
683
684bool AssembleVintf::openInFile(const std::string& path) {
685 return static_cast<std::ifstream&>(addInputStream(path, std::make_unique<std::ifstream>(path)))
686 .is_open();
687}
688
689bool AssembleVintf::openCheckFile(const std::string& path) {
690 return static_cast<std::ifstream&>(setCheckInputStream(std::make_unique<std::ifstream>(path)))
691 .is_open();
692}
693
694bool AssembleVintf::addKernel(const std::string& kernelArg) {
Yifan Hongb83e56b2018-01-09 14:36:30 -0800695 auto tokens = base::Split(kernelArg, ":");
Yifan Hong8302cea2017-12-18 20:17:05 -0800696 if (tokens.size() <= 1) {
697 std::cerr << "Unrecognized --kernel option '" << kernelArg << "'" << std::endl;
698 return false;
699 }
Yifan Hongfb9e8b62018-01-23 15:47:23 -0800700 KernelVersion kernelVer;
Yifan Hong8302cea2017-12-18 20:17:05 -0800701 if (!parse(tokens.front(), &kernelVer)) {
702 std::cerr << "Unrecognized kernel version '" << tokens.front() << "'" << std::endl;
703 return false;
704 }
705 if (hasKernelVersion(kernelVer)) {
706 std::cerr << "Multiple --kernel for " << kernelVer << " is specified." << std::endl;
707 return false;
708 }
709 for (auto it = tokens.begin() + 1; it != tokens.end(); ++it) {
710 bool opened =
711 static_cast<std::ifstream&>(
712 addKernelConfigInputStream(kernelVer, *it, std::make_unique<std::ifstream>(*it)))
713 .is_open();
714 if (!opened) {
715 std::cerr << "Cannot open file '" << *it << "'." << std::endl;
716 return false;
717 }
718 }
719 return true;
720}
721
722std::unique_ptr<AssembleVintf> AssembleVintf::newInstance() {
723 return std::make_unique<AssembleVintfImpl>();
724}
725
Yifan Hong4d18bcc2017-04-07 21:47:16 +0000726} // namespace vintf
727} // namespace android