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 | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 17 | #ifndef COMPOUND_TYPE_H_ |
| 18 | |
| 19 | #define COMPOUND_TYPE_H_ |
| 20 | |
Timur Iskhakov | 505316c | 2017-08-05 03:38:59 +0000 | [diff] [blame] | 21 | #include "Reference.h" |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 22 | #include "Scope.h" |
| 23 | |
Neel Mehta | 69920a6 | 2019-07-22 16:22:13 -0700 | [diff] [blame] | 24 | #include <string> |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 25 | #include <vector> |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 26 | |
| 27 | namespace android { |
| 28 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 29 | struct CompoundType : public Scope { |
| 30 | enum Style { |
| 31 | STYLE_STRUCT, |
| 32 | STYLE_UNION, |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 33 | STYLE_SAFE_UNION, |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 34 | }; |
| 35 | |
Neel Mehta | 69920a6 | 2019-07-22 16:22:13 -0700 | [diff] [blame] | 36 | CompoundType(Style style, const std::string& localName, const FQName& fullName, |
Timur Iskhakov | 565b013 | 2017-09-06 18:07:11 -0700 | [diff] [blame] | 37 | const Location& location, Scope* parent); |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 38 | |
Yifan Hong | 27e85db | 2016-11-09 15:45:52 -0800 | [diff] [blame] | 39 | Style style() const; |
| 40 | |
Neel Mehta | 7bfd90b | 2019-07-29 17:14:32 -0700 | [diff] [blame] | 41 | std::vector<const NamedReference<Type>*> getFields() const; |
Neel Mehta | dd9063f | 2019-08-16 19:37:11 -0700 | [diff] [blame] | 42 | void addField(NamedReference<Type>* field); |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 43 | |
Andreas Huber | f630bc8 | 2016-09-09 14:52:25 -0700 | [diff] [blame] | 44 | bool isCompoundType() const override; |
| 45 | |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 46 | bool deepCanCheckEquality(std::unordered_set<const Type*>* visited) const override; |
Yifan Hong | c6752dc | 2016-12-20 14:00:14 -0800 | [diff] [blame] | 47 | |
Steven Moreland | 0ecc7b8 | 2017-07-19 12:59:23 -0700 | [diff] [blame] | 48 | std::string typeName() const override; |
| 49 | |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 50 | std::vector<const Reference<Type>*> getReferences() const override; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 51 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 52 | status_t validate() const override; |
| 53 | status_t validateUniqueNames() const; |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 54 | status_t validateSubTypeNames() const; |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 55 | |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 56 | std::string getCppType(StorageMode mode, |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 57 | bool specifyNamespaces) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 58 | |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 59 | std::string getJavaType(bool forInitializer) const override; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 60 | |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 61 | std::string getVtsType() const override; |
| 62 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 63 | void emitReaderWriter( |
| 64 | Formatter &out, |
| 65 | const std::string &name, |
| 66 | const std::string &parcelObj, |
| 67 | bool parcelObjIsPointer, |
| 68 | bool isReader, |
| 69 | ErrorMode mode) const override; |
| 70 | |
| 71 | void emitReaderWriterEmbedded( |
| 72 | Formatter &out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 73 | size_t depth, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 74 | const std::string &name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 75 | const std::string &sanitizedName, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 76 | bool nameIsPointer, |
| 77 | const std::string &parcelObj, |
| 78 | bool parcelObjIsPointer, |
| 79 | bool isReader, |
| 80 | ErrorMode mode, |
| 81 | const std::string &parentName, |
| 82 | const std::string &offsetText) const override; |
| 83 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 84 | void emitJavaReaderWriter( |
| 85 | Formatter &out, |
| 86 | const std::string &parcelObj, |
| 87 | const std::string &argName, |
| 88 | bool isReader) const override; |
| 89 | |
| 90 | void emitJavaFieldInitializer( |
| 91 | Formatter &out, const std::string &fieldName) const override; |
| 92 | |
Nirav Atre | 66842a9 | 2018-06-28 18:14:13 -0700 | [diff] [blame] | 93 | void emitJavaFieldDefaultInitialValue( |
| 94 | Formatter &out, const std::string &declaredFieldName) const override; |
| 95 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 96 | void emitJavaFieldReaderWriter( |
| 97 | Formatter &out, |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 98 | size_t depth, |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 99 | const std::string &parcelName, |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 100 | const std::string &blobName, |
| 101 | const std::string &fieldName, |
| 102 | const std::string &offset, |
| 103 | bool isReader) const override; |
| 104 | |
Neel Mehta | 3b414a8 | 2019-07-02 15:47:48 -0700 | [diff] [blame] | 105 | void emitHidlDefinition(Formatter& out) const override; |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 106 | void emitTypeDeclarations(Formatter& out) const override; |
Timur Iskhakov | fd3f250 | 2017-09-05 16:25:02 -0700 | [diff] [blame] | 107 | void emitTypeForwardDeclaration(Formatter& out) const override; |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 108 | void emitPackageTypeDeclarations(Formatter& out) const override; |
Steven Moreland | 09c6ebe | 2018-10-09 10:15:48 -0700 | [diff] [blame] | 109 | void emitPackageTypeHeaderDefinitions(Formatter& out) const override; |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 110 | void emitPackageHwDeclarations(Formatter& out) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 111 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 112 | void emitTypeDefinitions(Formatter& out, const std::string& prefix) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 113 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 114 | void emitJavaTypeDeclarations(Formatter& out, bool atTopLevel) const override; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 115 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 116 | bool needsEmbeddedReadWrite() const override; |
| 117 | bool resultNeedsDeref() const override; |
| 118 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 119 | void emitVtsTypeDeclarations(Formatter& out) const override; |
| 120 | void emitVtsAttributeType(Formatter& out) const override; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 121 | |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 122 | bool deepIsJavaCompatible(std::unordered_set<const Type*>* visited) const override; |
| 123 | bool deepContainsPointer(std::unordered_set<const Type*>* visited) const override; |
Andreas Huber | 70a59e1 | 2016-08-16 12:57:01 -0700 | [diff] [blame] | 124 | |
Yi Kong | c8c053e | 2019-03-25 02:13:39 -0700 | [diff] [blame] | 125 | void getAlignmentAndSize(size_t *align, size_t *size) const override; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 126 | |
Howard Chen | ecfb451 | 2017-11-21 18:28:53 +0800 | [diff] [blame] | 127 | bool containsInterface() const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 128 | private: |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 129 | |
| 130 | struct Layout { |
| 131 | size_t offset; |
| 132 | size_t align; |
| 133 | size_t size; |
| 134 | |
| 135 | Layout() : offset(0), align(1), size(0) {} |
| 136 | static size_t getPad(size_t offset, size_t align); |
| 137 | }; |
| 138 | |
| 139 | struct CompoundLayout { |
Steven Moreland | 5e20b65 | 2019-04-22 18:42:38 -0700 | [diff] [blame] | 140 | // Layout of this entire object including metadata. |
| 141 | // For struct/union, this is the same as innerStruct. |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 142 | Layout overall; |
Steven Moreland | 5e20b65 | 2019-04-22 18:42:38 -0700 | [diff] [blame] | 143 | // Layout of user-specified data |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 144 | Layout innerStruct; |
Steven Moreland | 5e20b65 | 2019-04-22 18:42:38 -0700 | [diff] [blame] | 145 | // Layout of discriminator for safe union (otherwise zero) |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 146 | Layout discriminator; |
| 147 | }; |
| 148 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 149 | Style mStyle; |
Neel Mehta | dd9063f | 2019-08-16 19:37:11 -0700 | [diff] [blame] | 150 | std::vector<NamedReference<Type>*> mFields; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 151 | |
Neel Mehta | 6de3cf8 | 2019-08-06 16:49:33 -0700 | [diff] [blame] | 152 | // only emits the struct body. doesn't emit the last ";\n" from the definition |
| 153 | void emitInlineHidlDefinition(Formatter& out) const; |
Neel Mehta | 7cc7213 | 2019-08-09 15:48:09 -0700 | [diff] [blame] | 154 | // emits the hidl definition line for a field inside the struct. used by emitHidlDefinition |
| 155 | void emitFieldHidlDefinition(Formatter& out, const NamedReference<Type>& ref) const; |
Neel Mehta | 6de3cf8 | 2019-08-06 16:49:33 -0700 | [diff] [blame] | 156 | |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 157 | void emitLayoutAsserts(Formatter& out, const Layout& localLayout, |
| 158 | const std::string& localLayoutName) const; |
| 159 | |
| 160 | void emitInvalidSubTypeNamesError(const std::string& subTypeName, |
| 161 | const Location& location) const; |
| 162 | |
| 163 | void emitSafeUnionTypeDefinitions(Formatter& out) const; |
| 164 | void emitSafeUnionTypeConstructors(Formatter& out) const; |
| 165 | void emitSafeUnionTypeDeclarations(Formatter& out) const; |
| 166 | std::unique_ptr<ScalarType> getUnionDiscriminatorType() const; |
| 167 | |
Steven Moreland | 5add34d | 2018-11-08 16:31:30 -0800 | [diff] [blame] | 168 | void emitSafeUnionUnknownDiscriminatorError(Formatter& out, const std::string& value, |
| 169 | bool fatal) const; |
Nirav Atre | e3cae85 | 2018-07-16 12:19:16 -0700 | [diff] [blame] | 170 | |
Steven Moreland | 9f8aedb | 2021-03-25 22:58:57 +0000 | [diff] [blame] | 171 | void emitSafeUnionAssignDefinition(Formatter& out, const std::string& parameterName, |
| 172 | bool usesMoveSemantics) const; |
Nirav Atre | 64868d3 | 2018-07-15 19:15:18 -0700 | [diff] [blame] | 173 | |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 174 | CompoundLayout getCompoundAlignmentAndSize() const; |
Steven Moreland | 5e20b65 | 2019-04-22 18:42:38 -0700 | [diff] [blame] | 175 | void emitPaddingZero(Formatter& out, size_t offset, size_t size) const; |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 176 | |
Nirav Atre | ca7a502 | 2018-06-29 20:43:49 -0700 | [diff] [blame] | 177 | void emitSafeUnionReaderWriterForInterfaces( |
| 178 | Formatter &out, |
| 179 | const std::string &name, |
| 180 | const std::string &parcelObj, |
| 181 | bool parcelObjIsPointer, |
| 182 | bool isReader, |
| 183 | ErrorMode mode) const; |
| 184 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 185 | void emitStructReaderWriter( |
| 186 | Formatter &out, const std::string &prefix, bool isReader) const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 187 | |
| 188 | DISALLOW_COPY_AND_ASSIGN(CompoundType); |
| 189 | }; |
| 190 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 191 | } // namespace android |
| 192 | |
| 193 | #endif // COMPOUND_TYPE_H_ |
| 194 | |