1 /** 2 * Copyright (c) 2021-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef PANDA_VERIFIER_DEBUG_CONTEXT_H_ 17 #define PANDA_VERIFIER_DEBUG_CONTEXT_H_ 18 19 #include "verification/config/config.h" 20 #include "verification/config/debug_breakpoint/breakpoint.h" 21 #include "verification/public.h" 22 #include "verification/util/callable.h" 23 #include "verification/util/synchronized.h" 24 25 #include "runtime/include/mem/panda_containers.h" 26 #include "runtime/include/mem/panda_string.h" 27 28 #include <array> 29 #include <cstdint> 30 #include <unordered_map> 31 #include <unordered_set> 32 #include <vector> 33 34 namespace ark::verifier::debug { 35 36 enum class WhitelistKind : uint8_t { METHOD, METHOD_CALL, CLASS, LAST }; 37 38 struct DebugConfig { 39 // NOLINTBEGIN(misc-non-private-member-variables-in-classes) 40 PandaUnorderedMap<PandaString, ark::verifier::callable<bool(Config *cfg, const config::Section &)>> sectionHandlers; 41 42 #ifndef NDEBUG 43 // note: this is assumed to be small so stored as a vector (not even sorted, so we use a linear search) 44 // if changed, a sorted vector or a PandaMap would likely be better than PandaUnorderedMap for faster comparison 45 PandaVector<std::pair<PandaString, Offsets>> managedBreakpoints; 46 void AddBreakpointConfig(const PandaString &methodName, Offset offset); 47 #else AddBreakpointConfigDebugConfig48 void AddBreakpointConfig([[maybe_unused]] const PandaString &methodName, [[maybe_unused]] Offset offset) {} 49 #endif 50 51 std::array<PandaVector<PandaString>, static_cast<size_t>(WhitelistKind::LAST)> whitelistNames; 52 bool whitelistNotEmpty = false; 53 // NOLINTEND(misc-non-private-member-variables-in-classes) 54 55 void AddWhitelistMethodConfig(WhitelistKind kind, const PandaString &name); 56 }; 57 58 struct DebugContext { 59 // NOLINTBEGIN(misc-non-private-member-variables-in-classes) 60 DebugConfig const *config = nullptr; 61 62 #ifndef NDEBUG 63 Synchronized<PandaUnorderedMap<Method::UniqId, PandaUnorderedSet<uint32_t>>> breakpoint; 64 #endif 65 66 struct { 67 // similar to ManagedBreakpoints.Config 68 std::array<PandaVector<PandaString>, static_cast<size_t>(WhitelistKind::LAST)> names; 69 std::array<Synchronized<PandaUnorderedSet<Method::UniqId>>, static_cast<size_t>(WhitelistKind::LAST)> id; 70 bool isNotEmpty = false; 71 } whitelist; 72 73 // NOLINTEND(misc-non-private-member-variables-in-classes) 74 75 public: SetConfigDebugContext76 void SetConfig(DebugConfig const *cfg) 77 { 78 config = cfg; 79 } 80 81 void AddMethod(const Method &method, bool isDebug); 82 SkipVerificationDebugContext83 bool SkipVerification(Method::UniqId id) const 84 { 85 return InWhitelist(WhitelistKind::METHOD, id) || InWhitelist(WhitelistKind::CLASS, id); 86 } 87 SkipVerificationOfCallDebugContext88 bool SkipVerificationOfCall(Method::UniqId id) const 89 { 90 return InWhitelist(WhitelistKind::METHOD_CALL, id) || InWhitelist(WhitelistKind::CLASS, id); 91 } 92 93 private: 94 #ifndef NDEBUG 95 void InsertBreakpoints(PandaString const &methodName, Method::UniqId id); 96 #else 97 void InsertBreakpoints([[maybe_unused]] PandaString const &methodName, [[maybe_unused]] Method::UniqId id) {} 98 #endif 99 100 void InsertIntoWhitelist(const PandaString &name, bool isClassName, Method::UniqId id); 101 bool InWhitelist(WhitelistKind kind, uint64_t id) const; 102 }; 103 } // namespace ark::verifier::debug 104 105 #endif // !PANDA_VERIFIER_DEBUG_CONTEXT_H_ 106