blob: 2e761dfa2f6abc56c0157f4c14abd0e890ddbbda [file] [log] [blame]
* Copyright (C) 2016 The Android Open Source Project
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <android-base/macros.h>
#include <functional>
#include <map>
#include <set>
#include <string>
#include <utils/Errors.h>
#include <vector>
namespace android {
struct AST;
struct FQName;
struct Type;
struct Coordinator {
const std::vector<std::string> &packageRootPaths,
const std::vector<std::string> &packageRoots,
const std::string &rootPath);
// adds path only if it doesn't exist
void addDefaultPackagePath(const std::string& root, const std::string& path);
enum class Enforce {
FULL, // default
NO_HASH, // only for use with -Lhash
NONE, // only for use during enforcement
// Attempts to parse the interface/types referred to by fqName.
// Parsing an interface also parses the associated package's types.hal
// file if it exists.
// If "parsedASTs" is non-NULL, successfully parsed ASTs are inserted
// into the set.
// If !enforce, enforceRestrictionsOnPackage won't be run.
AST* parse(const FQName& fqName, std::set<AST*>* parsedASTs = nullptr,
Enforce enforcement = Enforce::FULL) const;
// Given package-root paths of ["hardware/interfaces",
// "vendor/<something>/interfaces"], package roots of
// ["android.hardware", "vendor.<something>.hardware"], and a
// FQName of "android.hardware.nfc@1.0::INfc, then getPackagePath()
// will return "hardware/interfaces/nfc/1.0" (if sanitized = false)
// or "hardware/interfaces/nfc/V1_0" (if sanitized = true).
std::string getPackagePath(
const FQName &fqName, bool relative = false,
bool sanitized = false) const;
// Given package roots of ["android.hardware",
// "vendor.<something>.hardware"] and a FQName of
// "android.hardware.nfc@1.0::INfc, then getPackageRoot() will
// return "android.hardware".
std::string getPackageRoot(const FQName &fqName) const;
// Given package-root paths of ["hardware/interfaces",
// "vendor/<something>/interfaces"], package roots of
// ["android.hardware", "vendor.<something>.hardware"], and a
// FQName of "android.hardware.nfc@1.0::INfc, then getPackageRootPath()
// will return "hardware/interfaces".
std::string getPackageRootPath(const FQName &fqName) const;
// return getPackageRoot + ":" + getPackageRootPath
std::string getPackageRootOption(const FQName &fqName) const;
// Given an FQName of "android.hardware.nfc@1.0::INfc", return
// "android/hardware/".
std::string convertPackageRootToPath(const FQName &fqName) const;
status_t getPackageInterfaceFiles(
const FQName &package,
std::vector<std::string> *fileNames) const;
status_t appendPackageInterfacesToVector(
const FQName &package,
std::vector<FQName> *packageInterfaces) const;
// Enforce a set of restrictions on a set of packages. These include:
// - minor version upgrades
// "packages" contains names like "android.hardware.nfc@1.1".
// - hashing restrictions
status_t enforceRestrictionsOnPackage(const FQName& fqName,
Enforce enforcement = Enforce::FULL) const;
static bool MakeParentHierarchy(const std::string &path);
// A list of top-level directories (mPackageRootPaths)
// corresponding to a list of package roots (mPackageRoots). For
// example, if mPackageRootPaths[0] == "hardware/interfaces" and
// mPackageRoots[0] == "android.hardware" this means that all
// packages starting with "android.hardware" will be looked up in
// "hardware/interfaces".
std::vector<std::string> mPackageRootPaths;
std::vector<std::string> mPackageRoots;
std::string mRootPath;
// cache to parse().
mutable std::map<FQName, AST *> mCache;
// cache to enforceRestrictionsOnPackage().
mutable std::set<FQName> mPackagesEnforced;
std::vector<std::string>::const_iterator findPackageRoot(
const FQName &fqName) const;
// Returns abs package path by prepending the root path if a package
// path is non-absolute.
// If root is '/android/master' and getPackagePath returns 'h/i/nfc/V1_0'
// this will return '/android/master/h/i/nfc/V1_0'.
// If root is '/android/master' and getPackagePath returns '/abs/path/to/nfc/V1_0'
// this will return '/abs/path/to/nfc/V1_0'
std::string getAbsolutePackagePath(const FQName& fqName) const;
// Rules of enforceRestrictionsOnPackage are listed below.
status_t enforceMinorVersionUprevs(const FQName &fqName) const;
status_t enforceHashes(const FQName &fqName) const;
} // namespace android
#endif // COORDINATOR_H_