Andreas Huber | 1aec397 | 2016-08-26 09:26:32 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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 | |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 17 | #ifndef COORDINATOR_H_ |
| 18 | |
| 19 | #define COORDINATOR_H_ |
| 20 | |
| 21 | #include <android-base/macros.h> |
Andreas Huber | e61e3f7 | 2016-08-03 10:22:03 -0700 | [diff] [blame] | 22 | #include <functional> |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 23 | #include <map> |
Andreas Huber | 39fa718 | 2016-08-19 14:27:33 -0700 | [diff] [blame] | 24 | #include <set> |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 25 | #include <string> |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 26 | #include <utils/Errors.h> |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 27 | #include <vector> |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 28 | |
| 29 | namespace android { |
| 30 | |
| 31 | struct AST; |
| 32 | struct FQName; |
Andreas Huber | fd4afab | 2016-08-03 13:02:57 -0700 | [diff] [blame] | 33 | struct Type; |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 34 | |
| 35 | struct Coordinator { |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 36 | Coordinator( |
| 37 | const std::vector<std::string> &packageRootPaths, |
| 38 | const std::vector<std::string> &packageRoots); |
| 39 | |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 40 | ~Coordinator(); |
| 41 | |
Andreas Huber | 39fa718 | 2016-08-19 14:27:33 -0700 | [diff] [blame] | 42 | // Attempts to parse the interface/types referred to by fqName. |
| 43 | // Parsing an interface also parses the associated package's types.hal |
| 44 | // file if it exists. |
| 45 | // If "parsedASTs" is non-NULL, successfully parsed ASTs are inserted |
| 46 | // into the set. |
| 47 | AST *parse(const FQName &fqName, std::set<AST *> *parsedASTs = nullptr); |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 48 | |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 49 | // Given package-root paths of ["hardware/interfaces", |
| 50 | // "vendor/<something>/interfaces"], package roots of |
| 51 | // ["android.hardware", "vendor.<something>.hardware"], and a |
| 52 | // FQName of "android.hardware.nfc@1.0::INfc, then getPackagePath() |
Yifan Hong | 97288ac | 2016-12-12 16:03:51 -0800 | [diff] [blame] | 53 | // will return "hardware/interfaces/nfc/1.0" (if sanitized = false) |
| 54 | // or "hardware/interfaces/nfc/V1_0" (if sanitized = true). |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 55 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 56 | std::string getPackagePath( |
Yifan Hong | 97288ac | 2016-12-12 16:03:51 -0800 | [diff] [blame] | 57 | const FQName &fqName, bool relative = false, |
| 58 | bool sanitized = false) const; |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 59 | |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 60 | // Given package roots of ["android.hardware", |
| 61 | // "vendor.<something>.hardware"] and a FQName of |
Iliyan Malchev | 5bb1402 | 2016-08-09 15:04:39 -0700 | [diff] [blame] | 62 | // "android.hardware.nfc@1.0::INfc, then getPackageRoot() will |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 63 | // return "android.hardware". |
| 64 | |
| 65 | std::string getPackageRoot(const FQName &fqName) const; |
| 66 | |
Iliyan Malchev | 5bb1402 | 2016-08-09 15:04:39 -0700 | [diff] [blame] | 67 | // Given package-root paths of ["hardware/interfaces", |
| 68 | // "vendor/<something>/interfaces"], package roots of |
| 69 | // ["android.hardware", "vendor.<something>.hardware"], and a |
| 70 | // FQName of "android.hardware.nfc@1.0::INfc, then getPackageRootPath() |
| 71 | // will return "hardware/interfaces". |
| 72 | |
| 73 | std::string getPackageRootPath(const FQName &fqName) const; |
| 74 | |
Yifan Hong | c893404 | 2016-11-17 17:10:52 -0800 | [diff] [blame] | 75 | // return getPackageRoot + ":" + getPackageRootPath |
| 76 | std::string getPackageRootOption(const FQName &fqName) const; |
| 77 | |
Andreas Huber | d2943e1 | 2016-08-05 11:59:31 -0700 | [diff] [blame] | 78 | // Given an FQName of "android.hardware.nfc@1.0::INfc", return |
| 79 | // "android/hardware/". |
| 80 | std::string convertPackageRootToPath(const FQName &fqName) const; |
| 81 | |
| 82 | status_t getPackageInterfaceFiles( |
| 83 | const FQName &package, |
| 84 | std::vector<std::string> *fileNames) const; |
| 85 | |
Steven Moreland | aa18683 | 2016-09-26 13:51:43 -0700 | [diff] [blame] | 86 | status_t appendPackageInterfacesToVector( |
Andreas Huber | d2943e1 | 2016-08-05 11:59:31 -0700 | [diff] [blame] | 87 | const FQName &package, |
| 88 | std::vector<FQName> *packageInterfaces) const; |
| 89 | |
Yifan Hong | 78b38d1 | 2017-02-13 18:14:46 +0000 | [diff] [blame] | 90 | // Enforce a set of restrictions on a set of packages. These include: |
| 91 | // - minor version upgrades |
| 92 | // "packages" contains names like "android.hardware.nfc@1.1". |
| 93 | status_t enforceRestrictionsOnPackage(const FQName &fqName); |
| 94 | |
Andreas Huber | d2943e1 | 2016-08-05 11:59:31 -0700 | [diff] [blame] | 95 | static bool MakeParentHierarchy(const std::string &path); |
Andreas Huber | e61e3f7 | 2016-08-03 10:22:03 -0700 | [diff] [blame] | 96 | |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 97 | private: |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 98 | // A list of top-level directories (mPackageRootPaths) |
| 99 | // corresponding to a list of package roots (mPackageRoots). For |
| 100 | // example, if mPackageRootPaths[0] == "hardware/interfaces" and |
| 101 | // mPackageRoots[0] == "android.hardware" this means that all |
| 102 | // packages starting with "android.hardware" will be looked up in |
| 103 | // "hardware/interfaces". |
| 104 | std::vector<std::string> mPackageRootPaths; |
| 105 | std::vector<std::string> mPackageRoots; |
Yifan Hong | 78b38d1 | 2017-02-13 18:14:46 +0000 | [diff] [blame] | 106 | |
| 107 | // cache to parse(). |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 108 | std::map<FQName, AST *> mCache; |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 109 | |
Yifan Hong | 78b38d1 | 2017-02-13 18:14:46 +0000 | [diff] [blame] | 110 | // cache to enforceRestrictionsOnPackage(). |
| 111 | std::set<FQName> mPackagesEnforced; |
| 112 | |
Andreas Huber | dca261f | 2016-08-04 13:47:51 -0700 | [diff] [blame] | 113 | std::vector<std::string>::const_iterator findPackageRoot( |
| 114 | const FQName &fqName) const; |
| 115 | |
Yifan Hong | 78b38d1 | 2017-02-13 18:14:46 +0000 | [diff] [blame] | 116 | // Rules of enforceRestrictionsOnPackage are listed below. |
| 117 | status_t enforceMinorVersionUprevs(const FQName &fqName); |
| 118 | |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 119 | DISALLOW_COPY_AND_ASSIGN(Coordinator); |
| 120 | }; |
| 121 | |
| 122 | } // namespace android |
| 123 | |
| 124 | #endif // COORDINATOR_H_ |